From 119d9763a4aeee30b574a655677ce5d424602721 Mon Sep 17 00:00:00 2001 From: CismonX Date: Sun, 11 Oct 2020 03:31:31 +0800 Subject: [PATCH] cleaning up --- .codecov.yml | 10 +- .gitattributes | 8 + .gitignore | 12 +- .travis.yml | 11 +- INSTALL | 37 ++++ Makefile.am | 8 + README.md | 33 +-- configure.ac | 25 +-- man/LICENSE | 451 --------------------------------------- man/Makefile.am | 8 + man/u6a.1 | 61 ++++-- man/u6ac.1 | 73 +++++-- src/runtime.c | 1 - src/u6a.c | 1 - src/u6ac.c | 1 + src/vm_defs.h | 2 +- src/vm_stack.h | 2 +- tests/default/cat.exp | 25 +-- tests/default/dump.exp | 25 +-- tests/default/quines.exp | 25 +-- tests/default/square.exp | 25 +-- tests/init.exp | 31 +-- tests/u6a_run | 26 +-- 23 files changed, 263 insertions(+), 638 deletions(-) create mode 100644 INSTALL delete mode 100644 man/LICENSE diff --git a/.codecov.yml b/.codecov.yml index a498bb7..83eac7f 100644 --- a/.codecov.yml +++ b/.codecov.yml @@ -1,7 +1,15 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + ignore: - "src/logging.c" - "src/mnemonic.c" coverage: - range: 55..95 + range: 50..90 round: down precision: 2 diff --git a/.gitattributes b/.gitattributes index 496368f..9c3ac15 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,10 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + # Attributes for GitHub Linguist *.h linguist-language=c diff --git a/.gitignore b/.gitignore index 9c07130..2322581 100644 --- a/.gitignore +++ b/.gitignore @@ -1,12 +1,22 @@ -# IDE +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + +# IDE & plugins .idea/ .vscode/ +.ccls* # Autotools *.cache/ .deps/ config.* configure +configure.scan Makefile.in Makefile depcomp diff --git a/.travis.yml b/.travis.yml index c50c373..405b0a8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,3 +1,11 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + language: c os: @@ -12,6 +20,7 @@ compiler: addons: apt: + update: true packages: - dejagnu homebrew: @@ -29,7 +38,7 @@ before_script: script: - autoreconf --install - - ./configure CFLAGS='-O0 -g -coverage' + - ./configure CFLAGS='-O0 -g -Wall -Wextra -Wpedantic -coverage' - make - make check - $GCOV_BIN src/*.c diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..acb830b --- /dev/null +++ b/INSTALL @@ -0,0 +1,37 @@ +============================================================================ +Copyright (C) 2020 CismonX + +Copying and distribution of this file, with or without modification, are +permitted in any medium without royalty, provided the copyright notice and +this notice are preserved. This file is offered as-is, without any warranty. +============================================================================ + +U6A INSTALLATION GUIDELINES: + +1. (If not already) Install the required build tools. + + sudo apt install build-essential automake + +2. (If you want to run tests) Install DejaGnu. + + sudo apt install dejagnu + +3. Generate configuration script. + + autoreconf --install + +4. Execute configuration script with desired options. + + ./configure --prefix=$HOME + +5. Compile source code and generate executables. + + make + +6. (Optional) Run tests. + + make check + +7. Install executables and man pages. + + make install diff --git a/Makefile.am b/Makefile.am index 9f0d419..4912f17 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1 +1,9 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + SUBDIRS = src man diff --git a/README.md b/README.md index 82789d7..777ede9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,16 @@ + + # u6a [![Travis CI](https://travis-ci.com/esolangs/u6a.svg)](https://travis-ci.com/esolangs/u6a) [![Codecov](https://codecov.io/gh/esolangs/u6a/branch/master/graphs/badge.svg)](https://codecov.io/gh/esolangs/u6a) -[![LICENSE](https://img.shields.io/badge/licence-GPLv3-blue.svg)](LICENSE) +[![LICENSE](https://img.shields.io/badge/licence-GPL--3.0--or--later-blue.svg)](LICENSE) Implementation of Unlambda, an esoteric programming language. @@ -14,26 +22,9 @@ Ideas behind this implementation can be found [here](https://github.com/esolangs ## Getting Started -Building: +To install u6a from source, see [INSTALL](INSTALL). -```bash -# (If not already) Install the required build tools. -sudo apt install build-essential automake -# (If you want to run tests) Install DejaGnu. -sudo apt install dejagnu -# Generate configuration script. -autoreconf --install -# Execute configuration script with desired options. -./configure --prefix=$HOME -# Compile source code and generate executables. -make -# (Optional) Run tests. -make check -# (Optional) Install executables and man pages. -make install -``` - -Usage: +Usage (See [**u6ac**(1)](man/u6ac.1) and [**u6a**(1)](man/u6a.1) man pages for details): ```bash # Compile an Unlambda source file into bytecode. @@ -42,8 +33,6 @@ u6ac -o foo.unl.bc foo.unl u6a foo.unl.bc ``` -See [**u6ac**(1)](man/u6ac.1) and [**u6a**(1)](man/u6a.1) man pages for details. - ## Future Plans * Interactive debugger: `u6adb` diff --git a/configure.ac b/configure.ac index 250d56c..d683b31 100644 --- a/configure.ac +++ b/configure.ac @@ -1,3 +1,11 @@ +dnl +dnl Copyright (C) 2020 CismonX +dnl +dnl Copying and distribution of this file, with or without modification, are +dnl permitted in any medium without royalty, provided the copyright notice and +dnl this notice are preserved. This file is offered as-is, without any warranty. +dnl + AC_PREREQ([2.69]) AC_INIT([u6a], [0.01], [bug-report@cismon.net]) AM_INIT_AUTOMAKE([foreign]) @@ -5,35 +13,28 @@ AC_CONFIG_SRCDIR([src/u6a.c]) AC_CONFIG_HEADERS([config.h]) AC_CONFIG_FILES([Makefile src/Makefile man/Makefile]) -dnl Check for operating system +# Check for operating system AC_CANONICAL_HOST case "${host_os}" in linux*) - AC_SUBST([MANPATH_CONF], [/etc/manpath.config]) - AC_SUBST([REBUILD_MANDB], [mandb]) AC_SUBST([BASE64_ENCODE], [-w0]) AC_SUBST([BASE64_DECODE], [-d]) ;; darwin*) - AC_SUBST([MANPATH_CONF], [/private/etc/man.conf]) - AC_SUBST([REBUILD_MANDB], [/usr/libexec/makewhatis]) AC_SUBST([BASE64_ENCODE], [-b0]) AC_SUBST([BASE64_DECODE], [-D]) ;; - *) - AC_MSG_ERROR(["Unsupported OS: ${host_os}"]) - ;; esac -dnl Checks for programs. +# Checks for programs. AC_PROG_CC_STDC -dnl Checks for header files. +# Checks for header files. AC_CHECK_HEADERS([arpa/inet.h inttypes.h stddef.h stdint.h stdlib.h string.h unistd.h], [], [AC_MSG_ERROR(["required header(s) not found"])]) -dnl Checks for typedefs, structures, and compiler characteristics. +# Checks for typedefs, structures, and compiler characteristics. AC_CHECK_HEADER_STDBOOL AC_C_INLINE AC_C_RESTRICT @@ -42,7 +43,7 @@ AC_TYPE_UINT32_T AC_TYPE_UINT8_T AC_TYPE_SIZE_T -dnl Checks for library functions. +# Checks for library functions. AC_FUNC_MALLOC AC_FUNC_REALLOC AC_CHECK_FUNCS([getopt_long strtoul]) diff --git a/man/LICENSE b/man/LICENSE deleted file mode 100644 index bf128be..0000000 --- a/man/LICENSE +++ /dev/null @@ -1,451 +0,0 @@ - - GNU Free Documentation License - Version 1.3, 3 November 2008 - - - Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. - - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -0. PREAMBLE - -The purpose of this License is to make a manual, textbook, or other -functional and useful document "free" in the sense of freedom: to -assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. -Secondarily, this License preserves for the author and publisher a way -to get credit for their work, while not being considered responsible -for modifications made by others. - -This License is a kind of "copyleft", which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft -license designed for free software. - -We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. - - -1. APPLICABILITY AND DEFINITIONS - -This License applies to any manual or other work, in any medium, that -contains a notice placed by the copyright holder saying it can be -distributed under the terms of this License. Such a notice grants a -world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The "Document", below, -refers to any such manual or work. Any member of the public is a -licensee, and is addressed as "you". You accept the license if you -copy, modify or distribute the work in a way requiring permission -under copyright law. - -A "Modified Version" of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A "Secondary Section" is a named appendix or a front-matter section of -the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall -subject (or to related matters) and contains nothing that could fall -directly within that overall subject. (Thus, if the Document is in -part a textbook of mathematics, a Secondary Section may not explain -any mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. - -The "Invariant Sections" are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. If a -section does not fit the above definition of Secondary then it is not -allowed to be designated as Invariant. The Document may contain zero -Invariant Sections. If the Document does not identify any Invariant -Sections then there are none. - -The "Cover Texts" are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. A Front-Cover Text may -be at most 5 words, and a Back-Cover Text may be at most 25 words. - -A "Transparent" copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the -general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. -An image format is not Transparent if used for any substantial amount -of text. A copy that is not "Transparent" is called "Opaque". - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input format, SGML -or XML using a publicly available DTD, and standard-conforming simple -HTML, PostScript or PDF designed for human modification. Examples of -transparent image formats include PNG, XCF and JPG. Opaque formats -include proprietary formats that can be read and edited only by -proprietary word processors, SGML or XML for which the DTD and/or -processing tools are not generally available, and the -machine-generated HTML, PostScript or PDF produced by some word -processors for output purposes only. - -The "Title Page" means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, "Title Page" means -the text near the most prominent appearance of the work's title, -preceding the beginning of the body of the text. - -The "publisher" means any person or entity that distributes copies of -the Document to the public. - -A section "Entitled XYZ" means a named subunit of the Document whose -title either is precisely XYZ or contains XYZ in parentheses following -text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as "Acknowledgements", -"Dedications", "Endorsements", or "History".) To "Preserve the Title" -of such a section when you modify the Document means that it remains a -section "Entitled XYZ" according to this definition. - -The Document may include Warranty Disclaimers next to the notice which -states that this License applies to the Document. These Warranty -Disclaimers are considered to be included by reference in this -License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and has -no effect on the meaning of this License. - -2. VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no -other conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. - -You may also lend copies, under the same conditions stated above, and -you may publicly display copies. - - -3. COPYING IN QUANTITY - -If you publish printed copies (or copies in media that commonly have -printed covers) of the Document, numbering more than 100, and the -Document's license notice requires Cover Texts, you must enclose the -copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. - -If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a computer-network location from which the general network-using -public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. -If you use the latter option, you must take reasonably prudent steps, -when you begin distribution of Opaque copies in quantity, to ensure -that this Transparent copy will remain thus accessible at the stated -location until at least one year after the last time you distribute an -Opaque copy (directly or through your agents or retailers) of that -edition to the public. - -It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to -give them a chance to provide you with an updated version of the -Document. - - -4. MODIFICATIONS - -You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: - -A. Use in the Title Page (and on the covers, if any) a title distinct - from that of the Document, and from those of previous versions - (which should, if there were any, be listed in the History section - of the Document). You may use the same title as a previous version - if the original publisher of that version gives permission. -B. List on the Title Page, as authors, one or more persons or entities - responsible for authorship of the modifications in the Modified - Version, together with at least five of the principal authors of the - Document (all of its principal authors, if it has fewer than five), - unless they release you from this requirement. -C. State on the Title page the name of the publisher of the - Modified Version, as the publisher. -D. Preserve all the copyright notices of the Document. -E. Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. -F. Include, immediately after the copyright notices, a license notice - giving the public permission to use the Modified Version under the - terms of this License, in the form shown in the Addendum below. -G. Preserve in that license notice the full lists of Invariant Sections - and required Cover Texts given in the Document's license notice. -H. Include an unaltered copy of this License. -I. Preserve the section Entitled "History", Preserve its Title, and add - to it an item stating at least the title, year, new authors, and - publisher of the Modified Version as given on the Title Page. If - there is no section Entitled "History" in the Document, create one - stating the title, year, authors, and publisher of the Document as - given on its Title Page, then add an item describing the Modified - Version as stated in the previous sentence. -J. Preserve the network location, if any, given in the Document for - public access to a Transparent copy of the Document, and likewise - the network locations given in the Document for previous versions - it was based on. These may be placed in the "History" section. - You may omit a network location for a work that was published at - least four years before the Document itself, or if the original - publisher of the version it refers to gives permission. -K. For any section Entitled "Acknowledgements" or "Dedications", - Preserve the Title of the section, and preserve in the section all - the substance and tone of each of the contributor acknowledgements - and/or dedications given therein. -L. Preserve all the Invariant Sections of the Document, - unaltered in their text and in their titles. Section numbers - or the equivalent are not considered part of the section titles. -M. Delete any section Entitled "Endorsements". Such a section - may not be included in the Modified Version. -N. Do not retitle any existing section to be Entitled "Endorsements" - or to conflict in title with any Invariant Section. -O. Preserve any Warranty Disclaimers. - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all -of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section Entitled "Endorsements", provided it contains -nothing but endorsements of your Modified Version by various -parties--for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document already -includes a cover text for the same cover, previously added by you or -by arrangement made by the same entity you are acting on behalf of, -you may not add another; but you may replace the old one, on explicit -permission from the previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - - -5. COMBINING DOCUMENTS - -You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice, and that you preserve all their Warranty Disclaimers. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. - -In the combination, you must combine any sections Entitled "History" -in the various original documents, forming one section Entitled -"History"; likewise combine any sections Entitled "Acknowledgements", -and any sections Entitled "Dedications". You must delete all sections -Entitled "Endorsements". - - -6. COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other -documents released under this License, and replace the individual -copies of this License in the various documents with a single copy -that is included in the collection, provided that you follow the rules -of this License for verbatim copying of each of the documents in all -other respects. - -You may extract a single document from such a collection, and -distribute it individually under this License, provided you insert a -copy of this License into the extracted document, and follow this -License in all other respects regarding verbatim copying of that -document. - - -7. AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, is called an "aggregate" if the copyright -resulting from the compilation is not used to limit the legal rights -of the compilation's users beyond what the individual works permit. -When the Document is included in an aggregate, this License does not -apply to the other works in the aggregate which are not themselves -derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document's Cover Texts may be placed on -covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. -Otherwise they must appear on printed covers that bracket the whole -aggregate. - - -8. TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License, and all the license notices in the -Document, and any Warranty Disclaimers, provided that you also include -the original English version of this License and the original versions -of those notices and disclaimers. In case of a disagreement between -the translation and the original version of this License or a notice -or disclaimer, the original version will prevail. - -If a section in the Document is Entitled "Acknowledgements", -"Dedications", or "History", the requirement (section 4) to Preserve -its Title (section 1) will typically require changing the actual -title. - - -9. TERMINATION - -You may not copy, modify, sublicense, or distribute the Document -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense, or distribute it is void, and -will automatically terminate your rights under this License. - -However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, receipt of a copy of some or all of the same material does -not give you any rights to use it. - - -10. FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation may publish new, revised versions of the -GNU Free Documentation License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in -detail to address new problems or concerns. See -https://www.gnu.org/licenses/. - -Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License "or any later version" applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. If the Document -specifies that a proxy can decide which future versions of this -License can be used, that proxy's public statement of acceptance of a -version permanently authorizes you to choose that version for the -Document. - -11. RELICENSING - -"Massive Multiauthor Collaboration Site" (or "MMC Site") means any -World Wide Web server that publishes copyrightable works and also -provides prominent facilities for anybody to edit those works. A -public wiki that anybody can edit is an example of such a server. A -"Massive Multiauthor Collaboration" (or "MMC") contained in the site -means any set of copyrightable works thus published on the MMC site. - -"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 -license published by Creative Commons Corporation, a not-for-profit -corporation with a principal place of business in San Francisco, -California, as well as future copyleft versions of that license -published by that same organization. - -"Incorporate" means to publish or republish a Document, in whole or in -part, as part of another Document. - -An MMC is "eligible for relicensing" if it is licensed under this -License, and if all works that were first published under this License -somewhere other than this MMC, and subsequently incorporated in whole or -in part into the MMC, (1) had no cover texts or invariant sections, and -(2) were thus incorporated prior to November 1, 2008. - -The operator of an MMC Site may republish an MMC contained in the site -under CC-BY-SA on the same site at any time before August 1, 2009, -provided the MMC is eligible for relicensing. - - -ADDENDUM: How to use this License for your documents - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and -license notices just after the title page: - - Copyright (c) YEAR YOUR NAME. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.3 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. - A copy of the license is included in the section entitled "GNU - Free Documentation License". - -If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the "with...Texts." line with this: - - with the Invariant Sections being LIST THEIR TITLES, with the - Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. - -If you have Invariant Sections without Cover Texts, or some other -combination of the three, merge those two alternatives to suit the -situation. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software. diff --git a/man/Makefile.am b/man/Makefile.am index 2b51249..e3f8975 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1 +1,9 @@ +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# + notrans_dist_man1_MANS = u6a.1 u6ac.1 diff --git a/man/u6a.1 b/man/u6a.1 index 528aac7..7f4ca45 100644 --- a/man/u6a.1 +++ b/man/u6a.1 @@ -1,27 +1,42 @@ .TH "U6A" "1" "Jan 30, 2020" "0.1.0" "U6A User Manual" . .SH NAME -u6a \- Runtime for the Unlambda programming language +u6a - Runtime for the Unlambda programming language . .SH SYNOPSIS -\fBu6a\fR [\fIoptions\fR] \fIbytecode\-file\fR +.B u6a +.RI [ options ] +.I bytecode-file . .SH DESCRIPTION -Load and execute Unlambda bytecode from the given \fIbytecode\-file\fR, or \fBSTDIN\fR if "-" is given. +Load and execute Unlambda bytecode from the given +.IR bytecode-file , +or +.B STDIN +if "-" is given. . .SH OPTIONS .TP -\fB\-s\fR, \fB\-\-stack\-segment\-size\=\fIelem\-count\fR -Specify size of each stack segment of Unlambda VM to \fIelem\-count\fR. Default: 256. +\fB\-s\fR, \fB\-\-stack\-segment\-size\=\fIelem-count\fR +Specify size of each stack segment of Unlambda VM to +.IR elem-count . +Default: 256. .TP -\fB\-p\fR, \fB\-\-pool\-size\fR=\fIelem\-count\fR -Specify size of object pool of Unlambda VM to \fIelem\-count\fR. Deafult: 1048576. +\fB\-p\fR, \fB\-\-pool\-size\fR=\fIelem-count\fR +Specify size of object pool of Unlambda VM to +.IR elem-count . +Deafult: 1048576. .TP \fB\-i\fR, \fB\-\-info\fR -Print info (version, segment size, etc.) corresponding to the \fIbytecode\-file\fR, then exit. +Print info (version, segment size, etc.) corresponding to the +.IR bytecode-file , +then exit. .TP \fB\-f\fR, \fB\-\-force\fR -Attempt to execute even when the \fIbytecode\-file\fR version is not compatible. Meanwhile, ignore unrecognizable instructions and data during execution. +Attempt to execute even when the +.I bytecode-file +version is not compatible. +Meanwhile, ignore unrecognizable instructions and data during execution. .TP \fB\-H\fR, \fB\-\-help\fR Prints help message, then exit. @@ -33,17 +48,29 @@ Prints version number, then exit. .SS Bytecode Files .TP Version compatiblility: -Definition of Unlambda bytecode may differ across multiple versions of u6a. Execution result is guaranteed to be consistent when both MAJOR and MINOR versions of bytecode file and the interpreter matches. Otherwise, the code may not work as expected and the interpreter will refuse to execute unless \fB-f\fR option is provided. +Definition of Unlambda bytecode may differ across multiple versions of u6a. +Execution result is guaranteed to be consistent when both major and minor versions of bytecode file and the interpreter matches. +Otherwise, the code may not work as expected and the interpreter will refuse to execute unless +.B -f +option is provided. .TP Redundant data: -While reading data from \fIbytecode\-file\fR, any bytes before the first occurrence of magic number \fI0xDC\fR is ignored. The same is true for bytes after \fI.rodata\fR segment, however, if read from \fBSTDIN\fR, they could be read by the current Unlambda program. +While reading data from +.IR bytecode-file , +any bytes before the first occurrence of magic number +.I 0xDC +is ignored. +The same is true for bytes after +.I .rodata +segment, however, if read from +.BR STDIN , +they could be read by the current Unlambda program. . .SH SEE ALSO -\fBu6ac\fR(1) +.BR u6ac (1) . .SH COPYRIGHT -Copyright (C) 2020 CismonX . -.br -Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. -.br -A copy of the license is included in \fIman/LICENSE\fR. +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty. diff --git a/man/u6ac.1 b/man/u6ac.1 index f456a0c..7c4fa8c 100644 --- a/man/u6ac.1 +++ b/man/u6ac.1 @@ -1,24 +1,49 @@ .TH "U6A" "1" "Jan 30, 2020" "0.1.0" "U6A User Manual" . .SH NAME -u6ac \- Bytecode compiler for the Unlambda programming language +u6ac - Bytecode compiler for the Unlambda programming language . .SH SYNOPSIS -\fBu6ac\fR [\fIoptions\fR] \fIsource\-file\fR +.B u6ac +.RI [ options ] +.I source-file . .SH DESCRIPTION -Read and compile Unlambda code from the given \fIsource\-file\fR, or \fBSTDIN\fR if "-" is given. Compilation result is saved in a special bytecode format, which can be executed with \fBu6a\fR(1). +Read and compile Unlambda code from the given +.IR source-file , +or +.B STDIN +if "-" is given. +Compilation result is saved in a special bytecode format, which can be executed with +.BR u6a (1). . .SH OPTIONS .TP -\fB\-o\fR, \fB\-\-output\fR=\fIout\-file\fR -Save compiled bytecode to \fIout\-file\fR, defaults to \fIsource\-file\fR name with ".bc" (".bc.dump" if \fB\-S\fR option is enabled) suffix, or \fBSTDOUT\fR if the source file is read from \fBSTDIN\fR. +\fB\-o\fR, \fB\-\-output\fR=\fIout-file\fR +Save compiled bytecode to +.IR out-file , +defaults to +.I source-file +name with ".bc" (".bc.dump" if +.B \-S +option is enabled) suffix, or +.B STDOUT +if the source file is read from +.BR STDIN . .TP -\fB\-\-add\-prefix\fR[=\fIprefix\-string\fR] -Add \fIprefix\-string\fR to the beginning of \fIout\-file\fR. Defaults to "#!/usr/bin/env u6a\\n". +\fB\-\-add\-prefix\fR[=\fIprefix-string\fR] +Add +.I prefix-string +to the beginning of +.IR out-file . +Defaults to "#!/usr/bin/env u6a\\n". .TP -\fB\-O[\fIoptimization\-level\fR] -Compile-time optimization level. \fB\-O0\fR: Turn off optimization. \fB\-O1\fR(default): Turn on basic optimizations, including constant folding & propagation, dead code elimination, etc. +\fB\-O[\fIoptimization-level\fR] +Compile-time optimization level. +.BR \-O0 : +Turn off optimization. +.BR \-O1 (default): +Turn on basic optimizations, including constant folding & propagation, dead code elimination, etc. .TP \fB\-\-syntax\-only\fR Only check for lexical and syntactic correctness of the source file, and skips bytecode generation. @@ -27,7 +52,12 @@ Only check for lexical and syntactic correctness of the source file, and skips b Produce mnemonic pseudo-instructions instead of bytecode. .TP \fB\-v\fR, \fB\-\-verbose\fR -Print extra debug messages to \fBSTDOUT\fR. When this option is enabled, \fIout\-file\fR should not be \fBSTDOUT\fR. +Print extra debug messages to +.BR STDOUT . +When this option is enabled, +.I out-file +should not be +.BR STDOUT . .TP \fB\-H\fR, \fB\-\-help\fR Prints help message, then exit. @@ -45,16 +75,23 @@ Comments: Text in line comments is not restricted to ASCII only. UTF-8 format is also supported. .TP Function names: -Charactor X in functions \fB.X\fR and \fB?X\fR must be printable ASCII or "\\n" (beware if you are using Windows-style newlines), and are case-sensitive. Other builtin function names are case-insensitive. +Charactor X in functions +.B .X +and +.B ?X +must be printable ASCII or "\\n" (beware if you are using Windows-style newlines), and are case-sensitive. +Other builtin function names are case-insensitive. .SS Code Size -Unlambda code size should not be larger than 4MiB (not counting comments and whitespaces). You may change this limit in \fIdefs.h\fR and rebuild u6a for larger code to compile. +Unlambda code size should not be larger than 4MiB (not counting comments and whitespaces). +You may change this limit in +.B defs.h +and rebuild u6a for larger code to compile. . .SH SEE ALSO -\fBu6a\fR(1) +.BR u6a (1) . .SH COPYRIGHT -Copyright (C) 2020 CismonX . -.br -Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. -.br -A copy of the license is included in \fIman/LICENSE\fR. +Copyright (c) 2020 CismonX +.PP +Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved. +This file is offered as-is, without any warranty. diff --git a/src/runtime.c b/src/runtime.c index 6319e1b..8cf3c7c 100644 --- a/src/runtime.c +++ b/src/runtime.c @@ -48,7 +48,6 @@ static const struct u6a_vm_ins text_subst[] = { static const uint32_t text_subst_len = sizeof(text_subst) / sizeof(struct u6a_vm_ins); static const char* err_runtime = "runtime error"; -static const char* info_runtime = "runtime"; #define CHECK_BC_HEADER_VER(file_header) \ ( (file_header).ver_major == U6A_VER_MAJOR && (file_header).ver_minor == U6A_VER_MINOR ) diff --git a/src/u6a.c b/src/u6a.c index cfd4735..ecfebaa 100644 --- a/src/u6a.c +++ b/src/u6a.c @@ -49,7 +49,6 @@ struct arg_options { }; static const char* err_toplevel = "error"; -static const char* info_toplevel = "info"; static void arg_options_destroy(struct arg_options* options) { diff --git a/src/u6ac.c b/src/u6ac.c index 78f9c32..8782a13 100644 --- a/src/u6ac.c +++ b/src/u6ac.c @@ -86,6 +86,7 @@ process_options(struct arg_options* options, int argc, char** argv) { break; case 'O': optimize_level = optarg ? optarg[0] : '1'; + break; case 'p': if (UNLIKELY(options->output_file_prefix)) { break; diff --git a/src/vm_defs.h b/src/vm_defs.h index 047e3d4..16963d6 100644 --- a/src/vm_defs.h +++ b/src/vm_defs.h @@ -90,7 +90,7 @@ struct u6a_vm_var_fn { #define U6A_VM_VAR_FN_REF(fn_, ref_) (struct u6a_vm_var_fn) { .token.fn = (fn_), .ref = (ref_) } #define U6A_VM_VAR_FN_EMPTY (struct u6a_vm_var_fn) { 0 } -#define U6A_VM_VAR_FN_IS_EMPTY(fn_) ( ((union u6a_vm_var)(fn_)).ptr == NULL ) +#define U6A_VM_VAR_FN_IS_EMPTY(fn_) ( fn_.token.fn == 0 ) union u6a_vm_var { struct u6a_vm_var_fn fn; diff --git a/src/vm_stack.h b/src/vm_stack.h index 9da2c63..2b2b602 100644 --- a/src/vm_stack.h +++ b/src/vm_stack.h @@ -99,7 +99,7 @@ u6a_vm_stack_push3(struct u6a_vm_stack_ctx* ctx, struct u6a_vm_var_fn v0, struct vs->elems[++vs->top] = v1; vs->elems[++vs->top] = v2; } else { - return u6a_vm_stack_push3_split_(ctx, v0, v1, v2); + u6a_vm_stack_push3_split_(ctx, v0, v1, v2); } } diff --git a/tests/default/cat.exp b/tests/default/cat.exp index ae1f982..0c83e9e 100644 --- a/tests/default/cat.exp +++ b/tests/default/cat.exp @@ -1,21 +1,10 @@ -## - # cat.exp - Test whether a "cat" program works on this u6a build - # - # Copyright (C) 2020 CismonX - # - # This program is free software: you can redistribute it and/or modify - # it under the terms of the GNU General Public License as published by - # the Free Software Foundation, either version 3 of the License, or - # (at your option) any later version. - # - # This program is distributed in the hope that it will be useful, - # but WITHOUT ANY WARRANTY; without even the implied warranty of - # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - # GNU General Public License for more details. - # - # You should have received a copy of the GNU General Public License - # along with this program. If not, see . - # +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# set tool "default" set timeout 5 diff --git a/tests/default/dump.exp b/tests/default/dump.exp index 723cdae..01a23fb 100644 --- a/tests/default/dump.exp +++ b/tests/default/dump.exp @@ -1,21 +1,10 @@ -## - # dump.exp - Test whether mnemonic dumping works on this u6a build - # - # Copyright (C) 2020 CismonX - # - # This program is free software: you can redistribute it and/or modify - # it under the terms of the GNU General Public License as published by - # the Free Software Foundation, either version 3 of the License, or - # (at your option) any later version. - # - # This program is distributed in the hope that it will be useful, - # but WITHOUT ANY WARRANTY; without even the implied warranty of - # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - # GNU General Public License for more details. - # - # You should have received a copy of the GNU General Public License - # along with this program. If not, see . - # +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# set tool "default" set timeout 1 diff --git a/tests/default/quines.exp b/tests/default/quines.exp index 6061950..a8aec6e 100644 --- a/tests/default/quines.exp +++ b/tests/default/quines.exp @@ -1,21 +1,10 @@ -## - # quines.exp - Test whether quines programs from CUAN works on this u6a build - # - # Copyright (C) 2020 CismonX - # - # This program is free software: you can redistribute it and/or modify - # it under the terms of the GNU General Public License as published by - # the Free Software Foundation, either version 3 of the License, or - # (at your option) any later version. - # - # This program is distributed in the hope that it will be useful, - # but WITHOUT ANY WARRANTY; without even the implied warranty of - # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - # GNU General Public License for more details. - # - # You should have received a copy of the GNU General Public License - # along with this program. If not, see . - # +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# set tool "default" set timeout 20 diff --git a/tests/default/square.exp b/tests/default/square.exp index a0541d6..eab2433 100644 --- a/tests/default/square.exp +++ b/tests/default/square.exp @@ -1,21 +1,10 @@ -## - # square.exp - Test whether a "square" program works on this u6a build - # - # Copyright (C) 2020 CismonX - # - # This program is free software: you can redistribute it and/or modify - # it under the terms of the GNU General Public License as published by - # the Free Software Foundation, either version 3 of the License, or - # (at your option) any later version. - # - # This program is distributed in the hope that it will be useful, - # but WITHOUT ANY WARRANTY; without even the implied warranty of - # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - # GNU General Public License for more details. - # - # You should have received a copy of the GNU General Public License - # along with this program. If not, see . - # +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# set tool "default" set timeout 5 diff --git a/tests/init.exp b/tests/init.exp index 26278bf..9797231 100644 --- a/tests/init.exp +++ b/tests/init.exp @@ -1,21 +1,10 @@ -## - # init.exp - u6a test init script - # - # Copyright (C) 2020 CismonX - # - # This program is free software: you can redistribute it and/or modify - # it under the terms of the GNU General Public License as published by - # the Free Software Foundation, either version 3 of the License, or - # (at your option) any later version. - # - # This program is distributed in the hope that it will be useful, - # but WITHOUT ANY WARRANTY; without even the implied warranty of - # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - # GNU General Public License for more details. - # - # You should have received a copy of the GNU General Public License - # along with this program. If not, see . - # +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# proc u6a_dump_mnemonics { src_code } { global U6AC_BIN @@ -31,7 +20,7 @@ proc u6a_run { src_code u6ac_opts u6a_opts has_input } { set u6ac "$U6AC_BIN $u6ac_opts" set u6a "$U6A_BIN $u6a_opts" set run_cmd [ list $U6A_RUN $u6ac $u6a $B64_ENCODE $B64_DECODE $src_code ] - if $has_input { + if { $has_input } { lappend run_cmd - set stty_init -echo } else { @@ -43,12 +32,12 @@ proc u6a_run { src_code u6ac_opts u6a_opts has_input } { proc u6a_stop { send_eof } { global spawn_id - if $send_eof { + if { $send_eof } { send \x04 expect eof } catch wait result - if [ set exit_code [ lindex $result 3 ] ] { + if { [ set exit_code [ lindex $result 3 ] ] } { fail "program exited with code $exit_code" } } diff --git a/tests/u6a_run b/tests/u6a_run index d0aee12..240f00f 100755 --- a/tests/u6a_run +++ b/tests/u6a_run @@ -1,22 +1,12 @@ #!/usr/bin/env bash -## - # u6a_run - helper script for running tests for u6a - # - # Copyright (C) 2020 CismonX - # - # This program is free software: you can redistribute it and/or modify - # it under the terms of the GNU General Public License as published by - # the Free Software Foundation, either version 3 of the License, or - # (at your option) any later version. - # - # This program is distributed in the hope that it will be useful, - # but WITHOUT ANY WARRANTY; without even the implied warranty of - # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - # GNU General Public License for more details. - # - # You should have received a copy of the GNU General Public License - # along with this program. If not, see . - # + +# +# Copyright (C) 2020 CismonX +# +# Copying and distribution of this file, with or without modification, are +# permitted in any medium without royalty, provided the copyright notice and +# this notice are preserved. This file is offered as-is, without any warranty. +# CMD=`[[ "$5" == "/"* ]] && echo 'cat' || echo 'echo'` U6A_BYTECODE=`$CMD $5 | $1 - | base64 $3`