aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpukkamustard <pukkamustard@posteo.net>2021-07-19 14:53:15 +0200
committerpukkamustard <pukkamustard@posteo.net>2021-07-19 14:53:15 +0200
commitdba6e53ae2a6d5fafc5ec88cc5d3e6abb138a00e (patch)
tree689942164c1fce42d3c80363ac612159f1f00767
parentd2905d6208a5c7acebcfd176adf690d811a2a3d9 (diff)
remove Guile implementation
Split specification and reference implementation into two separate repositories.
-rw-r--r--.gitlab-ci.yml9
-rw-r--r--AUTHORS3
-rw-r--r--ChangeLog1
-rw-r--r--LICENSES/GPL-3.0-or-later.txt625
-rw-r--r--Makefile.am101
-rw-r--r--NEWS14
l---------README1
-rw-r--r--README.md36
-rw-r--r--README.org170
-rw-r--r--ROADMAP21
-rwxr-xr-xbuild-aux/install-sh529
-rwxr-xr-xbuild-aux/mdate-sh228
-rwxr-xr-xbuild-aux/missing215
-rw-r--r--build-aux/test-driver.scm180
-rw-r--r--build-aux/texinfo.tex11614
-rw-r--r--configure.ac35
-rw-r--r--eris.scm114
-rw-r--r--eris/decode.scm66
-rw-r--r--eris/encode.scm220
-rw-r--r--eris/ipfs.scm163
-rw-r--r--eris/read-capability.scm92
-rw-r--r--eris/utils/base32.scm150
-rw-r--r--eris/utils/padding.scm78
-rw-r--r--eris/utils/rbytevector.scm24
-rw-r--r--eris/utils/test-vector.scm115
-rw-r--r--examples/dedup-fs/.gitignore3
-rw-r--r--examples/dedup-fs/Readme.org452
-rw-r--r--examples/dedup-fs/emacs-26.3-channels.scm9
-rw-r--r--examples/dedup-fs/guix.scm53
-rw-r--r--examples/ipfs.org519
-rw-r--r--guix.scm66
-rw-r--r--hall.scm54
-rw-r--r--pre-inst-env.in14
-rw-r--r--scripts/generate-test-vectors.scm135
-rw-r--r--tests/eris/large.scm89
-rw-r--r--tests/eris/pseudo-random.scm95
-rw-r--r--tests/eris/test-vectors.scm54
37 files changed, 45 insertions, 16302 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
deleted file mode 100644
index fb74524..0000000
--- a/.gitlab-ci.yml
+++ /dev/null
@@ -1,9 +0,0 @@
-pages:
- stage: deploy
- script:
- - touch public
- artifacts:
- paths:
- - public
- only:
- - main
diff --git a/AUTHORS b/AUTHORS
deleted file mode 100644
index bbd1ece..0000000
--- a/AUTHORS
+++ /dev/null
@@ -1,3 +0,0 @@
-Contributers to Guile Eris 0.2:
-
- pukkamustard <pukkamustard@posteo.net>
diff --git a/ChangeLog b/ChangeLog
deleted file mode 100644
index d877eed..0000000
--- a/ChangeLog
+++ /dev/null
@@ -1 +0,0 @@
-For a complete log, please see the Git commit log at <https://gitlab.com/openengiadina/eris/PATH/TO/LOG>.
diff --git a/LICENSES/GPL-3.0-or-later.txt b/LICENSES/GPL-3.0-or-later.txt
deleted file mode 100644
index e142a52..0000000
--- a/LICENSES/GPL-3.0-or-later.txt
+++ /dev/null
@@ -1,625 +0,0 @@
-GNU GENERAL PUBLIC LICENSE
-
-Version 3, 29 June 2007
-
-Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>
-
-Everyone is permitted to copy and distribute verbatim copies of this license
-document, but changing it is not allowed.
-
-Preamble
-
-The GNU General Public License is a free, copyleft license for software and
-other kinds of works.
-
-The licenses for most software and other practical works are designed to take
-away your freedom to share and change the works. By contrast, the GNU General
-Public License is intended to guarantee your freedom to share and change all
-versions of a program--to make sure it remains free software for all its users.
-We, the Free Software Foundation, use the GNU General Public License for most
-of our software; it applies also to any other work released this way by its
-authors. You can apply it to your programs, too.
-
-When we speak of free software, we are referring to freedom, not price. Our
-General Public Licenses are designed to make sure that you have the freedom
-to distribute copies of free software (and charge for them if you wish), that
-you receive source code or can get it if you want it, that you can change
-the software or use pieces of it in new free programs, and that you know you
-can do these things.
-
-To protect your rights, we need to prevent others from denying you these rights
-or asking you to surrender the rights. Therefore, you have certain responsibilities
-if you distribute copies of the software, or if you modify it: responsibilities
-to respect the freedom of others.
-
-For example, if you distribute copies of such a program, whether gratis or
-for a fee, you must pass on to the recipients the same freedoms that you received.
-You must make sure that they, too, receive or can get the source code. And
-you must show them these terms so they know their rights.
-
-Developers that use the GNU GPL protect your rights with two steps: (1) assert
-copyright on the software, and (2) offer you this License giving you legal
-permission to copy, distribute and/or modify it.
-
-For the developers' and authors' protection, the GPL clearly explains that
-there is no warranty for this free software. For both users' and authors'
-sake, the GPL requires that modified versions be marked as changed, so that
-their problems will not be attributed erroneously to authors of previous versions.
-
-Some devices are designed to deny users access to install or run modified
-versions of the software inside them, although the manufacturer can do so.
-This is fundamentally incompatible with the aim of protecting users' freedom
-to change the software. The systematic pattern of such abuse occurs in the
-area of products for individuals to use, which is precisely where it is most
-unacceptable. Therefore, we have designed this version of the GPL to prohibit
-the practice for those products. If such problems arise substantially in other
-domains, we stand ready to extend this provision to those domains in future
-versions of the GPL, as needed to protect the freedom of users.
-
-Finally, every program is threatened constantly by software patents. States
-should not allow patents to restrict development and use of software on general-purpose
-computers, but in those that do, we wish to avoid the special danger that
-patents applied to a free program could make it effectively proprietary. To
-prevent this, the GPL assures that patents cannot be used to render the program
-non-free.
-
-The precise terms and conditions for copying, distribution and modification
-follow.
-
-TERMS AND CONDITIONS
-
- 0. Definitions.
-
- "This License" refers to version 3 of the GNU General Public License.
-
-"Copyright" also means copyright-like laws that apply to other kinds of works,
-such as semiconductor masks.
-
-"The Program" refers to any copyrightable work licensed under this License.
-Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals
-or organizations.
-
-To "modify" a work means to copy from or adapt all or part of the work in
-a fashion requiring copyright permission, other than the making of an exact
-copy. The resulting work is called a "modified version" of the earlier work
-or a work "based on" the earlier work.
-
-A "covered work" means either the unmodified Program or a work based on the
-Program.
-
-To "propagate" a work means to do anything with it that, without permission,
-would make you directly or secondarily liable for infringement under applicable
-copyright law, except executing it on a computer or modifying a private copy.
-Propagation includes copying, distribution (with or without modification),
-making available to the public, and in some countries other activities as
-well.
-
-To "convey" a work means any kind of propagation that enables other parties
-to make or receive copies. Mere interaction with a user through a computer
-network, with no transfer of a copy, is not conveying.
-
-An interactive user interface displays "Appropriate Legal Notices" to the
-extent that it includes a convenient and prominently visible feature that
-(1) displays an appropriate copyright notice, and (2) tells the user that
-there is no warranty for the work (except to the extent that warranties are
-provided), that licensees may convey the work under this License, and how
-to view a copy of this License. If the interface presents a list of user commands
-or options, such as a menu, a prominent item in the list meets this criterion.
-
- 1. Source Code.
-
-The "source code" for a work means the preferred form of the work for making
-modifications to it. "Object code" means any non-source form of a work.
-
-A "Standard Interface" means an interface that either is an official standard
-defined by a recognized standards body, or, in the case of interfaces specified
-for a particular programming language, one that is widely used among developers
-working in that language.
-
-The "System Libraries" of an executable work include anything, other than
-the work as a whole, that (a) is included in the normal form of packaging
-a Major Component, but which is not part of that Major Component, and (b)
-serves only to enable use of the work with that Major Component, or to implement
-a Standard Interface for which an implementation is available to the public
-in source code form. A "Major Component", in this context, means a major essential
-component (kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to produce
-the work, or an object code interpreter used to run it.
-
-The "Corresponding Source" for a work in object code form means all the source
-code needed to generate, install, and (for an executable work) run the object
-code and to modify the work, including scripts to control those activities.
-However, it does not include the work's System Libraries, or general-purpose
-tools or generally available free programs which are used unmodified in performing
-those activities but which are not part of the work. For example, Corresponding
-Source includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically linked
-subprograms that the work is specifically designed to require, such as by
-intimate data communication or control flow between those subprograms and
-other parts of the work.
-
-The Corresponding Source need not include anything that users can regenerate
-automatically from other parts of the Corresponding Source.
-
- The Corresponding Source for a work in source code form is that same work.
-
- 2. Basic Permissions.
-
-All rights granted under this License are granted for the term of copyright
-on the Program, and are irrevocable provided the stated conditions are met.
-This License explicitly affirms your unlimited permission to run the unmodified
-Program. The output from running a covered work is covered by this License
-only if the output, given its content, constitutes a covered work. This License
-acknowledges your rights of fair use or other equivalent, as provided by copyright
-law.
-
-You may make, run and propagate covered works that you do not convey, without
-conditions so long as your license otherwise remains in force. You may convey
-covered works to others for the sole purpose of having them make modifications
-exclusively for you, or provide you with facilities for running those works,
-provided that you comply with the terms of this License in conveying all material
-for which you do not control copyright. Those thus making or running the covered
-works for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of your copyrighted
-material outside their relationship with you.
-
-Conveying under any other circumstances is permitted solely under the conditions
-stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
-
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-No covered work shall be deemed part of an effective technological measure
-under any applicable law fulfilling obligations under article 11 of the WIPO
-copyright treaty adopted on 20 December 1996, or similar laws prohibiting
-or restricting circumvention of such measures.
-
-When you convey a covered work, you waive any legal power to forbid circumvention
-of technological measures to the extent such circumvention is effected by
-exercising rights under this License with respect to the covered work, and
-you disclaim any intention to limit operation or modification of the work
-as a means of enforcing, against the work's users, your or third parties'
-legal rights to forbid circumvention of technological measures.
-
- 4. Conveying Verbatim Copies.
-
-You may convey verbatim copies of the Program's source code as you receive
-it, in any medium, provided that you conspicuously and appropriately publish
-on each copy an appropriate copyright notice; keep intact all notices stating
-that this License and any non-permissive terms added in accord with section
-7 apply to the code; keep intact all notices of the absence of any warranty;
-and give all recipients a copy of this License along with the Program.
-
-You may charge any price or no price for each copy that you convey, and you
-may offer support or warranty protection for a fee.
-
- 5. Conveying Modified Source Versions.
-
-You may convey a work based on the Program, or the modifications to produce
-it from the Program, in the form of source code under the terms of section
-4, provided that you also meet all of these conditions:
-
-a) The work must carry prominent notices stating that you modified it, and
-giving a relevant date.
-
-b) The work must carry prominent notices stating that it is released under
-this License and any conditions added under section 7. This requirement modifies
-the requirement in section 4 to "keep intact all notices".
-
-c) You must license the entire work, as a whole, under this License to anyone
-who comes into possession of a copy. This License will therefore apply, along
-with any applicable section 7 additional terms, to the whole of the work,
-and all its parts, regardless of how they are packaged. This License gives
-no permission to license the work in any other way, but it does not invalidate
-such permission if you have separately received it.
-
-d) If the work has interactive user interfaces, each must display Appropriate
-Legal Notices; however, if the Program has interactive interfaces that do
-not display Appropriate Legal Notices, your work need not make them do so.
-
-A compilation of a covered work with other separate and independent works,
-which are not by their nature extensions of the covered work, and which are
-not combined with it such as to form a larger program, in or on a volume of
-a storage or distribution medium, is called an "aggregate" if the compilation
-and its resulting copyright are not used to limit the access or legal rights
-of the compilation's users beyond what the individual works permit. Inclusion
-of a covered work in an aggregate does not cause this License to apply to
-the other parts of the aggregate.
-
- 6. Conveying Non-Source Forms.
-
-You may convey a covered work in object code form under the terms of sections
-4 and 5, provided that you also convey the machine-readable Corresponding
-Source under the terms of this License, in one of these ways:
-
-a) Convey the object code in, or embodied in, a physical product (including
-a physical distribution medium), accompanied by the Corresponding Source fixed
-on a durable physical medium customarily used for software interchange.
-
-b) Convey the object code in, or embodied in, a physical product (including
-a physical distribution medium), accompanied by a written offer, valid for
-at least three years and valid for as long as you offer spare parts or customer
-support for that product model, to give anyone who possesses the object code
-either (1) a copy of the Corresponding Source for all the software in the
-product that is covered by this License, on a durable physical medium customarily
-used for software interchange, for a price no more than your reasonable cost
-of physically performing this conveying of source, or (2) access to copy the
-Corresponding Source from a network server at no charge.
-
-c) Convey individual copies of the object code with a copy of the written
-offer to provide the Corresponding Source. This alternative is allowed only
-occasionally and noncommercially, and only if you received the object code
-with such an offer, in accord with subsection 6b.
-
-d) Convey the object code by offering access from a designated place (gratis
-or for a charge), and offer equivalent access to the Corresponding Source
-in the same way through the same place at no further charge. You need not
-require recipients to copy the Corresponding Source along with the object
-code. If the place to copy the object code is a network server, the Corresponding
-Source may be on a different server (operated by you or a third party) that
-supports equivalent copying facilities, provided you maintain clear directions
-next to the object code saying where to find the Corresponding Source. Regardless
-of what server hosts the Corresponding Source, you remain obligated to ensure
-that it is available for as long as needed to satisfy these requirements.
-
-e) Convey the object code using peer-to-peer transmission, provided you inform
-other peers where the object code and Corresponding Source of the work are
-being offered to the general public at no charge under subsection 6d.
-
-A separable portion of the object code, whose source code is excluded from
-the Corresponding Source as a System Library, need not be included in conveying
-the object code work.
-
-A "User Product" is either (1) a "consumer product", which means any tangible
-personal property which is normally used for personal, family, or household
-purposes, or (2) anything designed or sold for incorporation into a dwelling.
-In determining whether a product is a consumer product, doubtful cases shall
-be resolved in favor of coverage. For a particular product received by a particular
-user, "normally used" refers to a typical or common use of that class of product,
-regardless of the status of the particular user or of the way in which the
-particular user actually uses, or expects or is expected to use, the product.
-A product is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent the
-only significant mode of use of the product.
-
-"Installation Information" for a User Product means any methods, procedures,
-authorization keys, or other information required to install and execute modified
-versions of a covered work in that User Product from a modified version of
-its Corresponding Source. The information must suffice to ensure that the
-continued functioning of the modified object code is in no case prevented
-or interfered with solely because modification has been made.
-
-If you convey an object code work under this section in, or with, or specifically
-for use in, a User Product, and the conveying occurs as part of a transaction
-in which the right of possession and use of the User Product is transferred
-to the recipient in perpetuity or for a fixed term (regardless of how the
-transaction is characterized), the Corresponding Source conveyed under this
-section must be accompanied by the Installation Information. But this requirement
-does not apply if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has been installed
-in ROM).
-
-The requirement to provide Installation Information does not include a requirement
-to continue to provide support service, warranty, or updates for a work that
-has been modified or installed by the recipient, or for the User Product in
-which it has been modified or installed. Access to a network may be denied
-when the modification itself materially and adversely affects the operation
-of the network or violates the rules and protocols for communication across
-the network.
-
-Corresponding Source conveyed, and Installation Information provided, in accord
-with this section must be in a format that is publicly documented (and with
-an implementation available to the public in source code form), and must require
-no special password or key for unpacking, reading or copying.
-
- 7. Additional Terms.
-
-"Additional permissions" are terms that supplement the terms of this License
-by making exceptions from one or more of its conditions. Additional permissions
-that are applicable to the entire Program shall be treated as though they
-were included in this License, to the extent that they are valid under applicable
-law. If additional permissions apply only to part of the Program, that part
-may be used separately under those permissions, but the entire Program remains
-governed by this License without regard to the additional permissions.
-
-When you convey a copy of a covered work, you may at your option remove any
-additional permissions from that copy, or from any part of it. (Additional
-permissions may be written to require their own removal in certain cases when
-you modify the work.) You may place additional permissions on material, added
-by you to a covered work, for which you have or can give appropriate copyright
-permission.
-
-Notwithstanding any other provision of this License, for material you add
-to a covered work, you may (if authorized by the copyright holders of that
-material) supplement the terms of this License with terms:
-
-a) Disclaiming warranty or limiting liability differently from the terms of
-sections 15 and 16 of this License; or
-
-b) Requiring preservation of specified reasonable legal notices or author
-attributions in that material or in the Appropriate Legal Notices displayed
-by works containing it; or
-
-c) Prohibiting misrepresentation of the origin of that material, or requiring
-that modified versions of such material be marked in reasonable ways as different
-from the original version; or
-
-d) Limiting the use for publicity purposes of names of licensors or authors
-of the material; or
-
-e) Declining to grant rights under trademark law for use of some trade names,
-trademarks, or service marks; or
-
-f) Requiring indemnification of licensors and authors of that material by
-anyone who conveys the material (or modified versions of it) with contractual
-assumptions of liability to the recipient, for any liability that these contractual
-assumptions directly impose on those licensors and authors.
-
-All other non-permissive additional terms are considered "further restrictions"
-within the meaning of section 10. If the Program as you received it, or any
-part of it, contains a notice stating that it is governed by this License
-along with a term that is a further restriction, you may remove that term.
-If a license document contains a further restriction but permits relicensing
-or conveying under this License, you may add to a covered work material governed
-by the terms of that license document, provided that the further restriction
-does not survive such relicensing or conveying.
-
-If you add terms to a covered work in accord with this section, you must place,
-in the relevant source files, a statement of the additional terms that apply
-to those files, or a notice indicating where to find the applicable terms.
-
-Additional terms, permissive or non-permissive, may be stated in the form
-of a separately written license, or stated as exceptions; the above requirements
-apply either way.
-
- 8. Termination.
-
-You may not propagate or modify a covered work except as expressly provided
-under this License. Any attempt otherwise to propagate or modify it is void,
-and will automatically terminate your rights under this License (including
-any patent licenses granted under the third paragraph of section 11).
-
-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, you do
-not qualify to receive new licenses for the same material under section 10.
-
- 9. Acceptance Not Required for Having Copies.
-
-You are not required to accept this License in order to receive or run a copy
-of the Program. Ancillary propagation of a covered work occurring solely as
-a consequence of using peer-to-peer transmission to receive a copy likewise
-does not require acceptance. However, nothing other than this License grants
-you permission to propagate or modify any covered work. These actions infringe
-copyright if you do not accept this License. Therefore, by modifying or propagating
-a covered work, you indicate your acceptance of this License to do so.
-
- 10. Automatic Licensing of Downstream Recipients.
-
-Each time you convey a covered work, the recipient automatically receives
-a license from the original licensors, to run, modify and propagate that work,
-subject to this License. You are not responsible for enforcing compliance
-by third parties with this License.
-
-An "entity transaction" is a transaction transferring control of an organization,
-or substantially all assets of one, or subdividing an organization, or merging
-organizations. If propagation of a covered work results from an entity transaction,
-each party to that transaction who receives a copy of the work also receives
-whatever licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the Corresponding
-Source of the work from the predecessor in interest, if the predecessor has
-it or can get it with reasonable efforts.
-
-You may not impose any further restrictions on the exercise of the rights
-granted or affirmed under this License. For example, you may not impose a
-license fee, royalty, or other charge for exercise of rights granted under
-this License, and you may not initiate litigation (including a cross-claim
-or counterclaim in a lawsuit) alleging that any patent claim is infringed
-by making, using, selling, offering for sale, or importing the Program or
-any portion of it.
-
- 11. Patents.
-
-A "contributor" is a copyright holder who authorizes use under this License
-of the Program or a work on which the Program is based. The work thus licensed
-is called the contributor's "contributor version".
-
-A contributor's "essential patent claims" are all patent claims owned or controlled
-by the contributor, whether already acquired or hereafter acquired, that would
-be infringed by some manner, permitted by this License, of making, using,
-or selling its contributor version, but do not include claims that would be
-infringed only as a consequence of further modification of the contributor
-version. For purposes of this definition, "control" includes the right to
-grant patent sublicenses in a manner consistent with the requirements of this
-License.
-
-Each contributor grants you a non-exclusive, worldwide, royalty-free patent
-license under the contributor's essential patent claims, to make, use, sell,
-offer for sale, import and otherwise run, modify and propagate the contents
-of its contributor version.
-
-In the following three paragraphs, a "patent license" is any express agreement
-or commitment, however denominated, not to enforce a patent (such as an express
-permission to practice a patent or covenant not to sue for patent infringement).
-To "grant" such a patent license to a party means to make such an agreement
-or commitment not to enforce a patent against the party.
-
-If you convey a covered work, knowingly relying on a patent license, and the
-Corresponding Source of the work is not available for anyone to copy, free
-of charge and under the terms of this License, through a publicly available
-network server or other readily accessible means, then you must either (1)
-cause the Corresponding Source to be so available, or (2) arrange to deprive
-yourself of the benefit of the patent license for this particular work, or
-(3) arrange, in a manner consistent with the requirements of this License,
-to extend the patent license to downstream recipients. "Knowingly relying"
-means you have actual knowledge that, but for the patent license, your conveying
-the covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that country
-that you have reason to believe are valid.
-
-If, pursuant to or in connection with a single transaction or arrangement,
-you convey, or propagate by procuring conveyance of, a covered work, and grant
-a patent license to some of the parties receiving the covered work authorizing
-them to use, propagate, modify or convey a specific copy of the covered work,
-then the patent license you grant is automatically extended to all recipients
-of the covered work and works based on it.
-
-A patent license is "discriminatory" if it does not include within the scope
-of its coverage, prohibits the exercise of, or is conditioned on the non-exercise
-of one or more of the rights that are specifically granted under this License.
-You may not convey a covered work if you are a party to an arrangement with
-a third party that is in the business of distributing software, under which
-you make payment to the third party based on the extent of your activity of
-conveying the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory patent
-license (a) in connection with copies of the covered work conveyed by you
-(or copies made from those copies), or (b) primarily for and in connection
-with specific products or compilations that contain the covered work, unless
-you entered into that arrangement, or that patent license was granted, prior
-to 28 March 2007.
-
-Nothing in this License shall be construed as excluding or limiting any implied
-license or other defenses to infringement that may otherwise be available
-to you under applicable patent law.
-
- 12. No Surrender of Others' Freedom.
-
-If conditions are imposed on you (whether by court order, agreement or otherwise)
-that contradict the conditions of this License, they do not excuse you from
-the conditions of this License. If you cannot convey a covered work so as
-to satisfy simultaneously your obligations under this License and any other
-pertinent obligations, then as a consequence you may not convey it at all.
-For example, if you agree to terms that obligate you to collect a royalty
-for further conveying from those to whom you convey the Program, the only
-way you could satisfy both those terms and this License would be to refrain
-entirely from conveying the Program.
-
- 13. Use with the GNU Affero General Public License.
-
-Notwithstanding any other provision of this License, you have permission to
-link or combine any covered work with a work licensed under version 3 of the
-GNU Affero General Public License into a single combined work, and to convey
-the resulting work. The terms of this License will continue to apply to the
-part which is the covered work, but the special requirements of the GNU Affero
-General Public License, section 13, concerning interaction through a network
-will apply to the combination as such.
-
- 14. Revised Versions of this License.
-
-The Free Software Foundation may publish revised and/or new versions of the
-GNU General Public 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.
-
-Each version is given a distinguishing version number. If the Program specifies
-that a certain numbered version of the GNU General Public License "or any
-later version" applies to it, you have the option of following the terms and
-conditions either of that numbered version or of any later version published
-by the Free Software Foundation. If the Program does not specify a version
-number of the GNU General Public License, you may choose any version ever
-published by the Free Software Foundation.
-
-If the Program specifies that a proxy can decide which future versions of
-the GNU General Public License can be used, that proxy's public statement
-of acceptance of a version permanently authorizes you to choose that version
-for the Program.
-
-Later license versions may give you additional or different permissions. However,
-no additional obligations are imposed on any author or copyright holder as
-a result of your choosing to follow a later version.
-
- 15. Disclaimer of Warranty.
-
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
-LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
-EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
-PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
-CORRECTION.
-
- 16. Limitation of Liability.
-
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
-ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM
-AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
-INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO
-USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
-INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
-PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
-PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
-
- 17. Interpretation of Sections 15 and 16.
-
-If the disclaimer of warranty and limitation of liability provided above cannot
-be given local legal effect according to their terms, reviewing courts shall
-apply local law that most closely approximates an absolute waiver of all civil
-liability in connection with the Program, unless a warranty or assumption
-of liability accompanies a copy of the Program in return for a fee. END OF
-TERMS AND CONDITIONS
-
-How to Apply These Terms to Your New Programs
-
-If you develop a new program, and you want it to be of the greatest possible
-use to the public, the best way to achieve this is to make it free software
-which everyone can redistribute and change under these terms.
-
-To do so, attach the following notices to the program. It is safest to attach
-them to the start of each source file to most effectively state the exclusion
-of warranty; and each file should have at least the "copyright" line and a
-pointer to where the full notice is found.
-
-<one line to give the program's name and a brief idea of what it does.>
-
-Copyright (C) <year> <name of author>
-
-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 <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program does terminal interaction, make it output a short notice like
-this when it starts in an interactive mode:
-
-<program> Copyright (C) <year> <name of author>
-
-This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-
-This is free software, and you are welcome to redistribute it under certain
-conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, your program's commands might
-be different; for a GUI interface, you would use an "about box".
-
-You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary. For
-more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.
-
-The GNU General Public License does not permit incorporating your program
-into proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Lesser General Public
-License instead of this License. But first, please read <https://www.gnu.org/
-licenses /why-not-lgpl.html>.
diff --git a/Makefile.am b/Makefile.am
deleted file mode 100644
index 43be38e..0000000
--- a/Makefile.am
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-bin_SCRIPTS =
-
-# Handle substitution of fully-expanded Autoconf variables.
-do_subst = $(SED) \
- -e 's,[@]GUILE[@],$(GUILE),g' \
- -e 's,[@]guilemoduledir[@],$(guilemoduledir),g' \
- -e 's,[@]guileobjectdir[@],$(guileobjectdir),g' \
- -e 's,[@]localedir[@],$(localedir),g'
-
-nodist_noinst_SCRIPTS = pre-inst-env
-
-GOBJECTS = $(SOURCES:%.scm=%.go)
-
-moddir=$(prefix)/share/guile/site/$(GUILE_EFFECTIVE_VERSION)
-godir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache
-ccachedir=$(libdir)/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache
-
-nobase_mod_DATA = $(SOURCES) $(NOCOMP_SOURCES)
-nobase_go_DATA = $(GOBJECTS)
-
-# Make sure source files are installed first, so that the mtime of
-# installed compiled files is greater than that of installed source
-# files. See
-# <http://lists.gnu.org/archive/html/guile-devel/2010-07/msg00125.html>
-# for details.
-guile_install_go_files = install-nobase_goDATA
-$(guile_install_go_files): install-nobase_modDATA
-
-EXTRA_DIST = $(SOURCES) $(NOCOMP_SOURCES)
-GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat
-SUFFIXES = .scm .go
-.scm.go:
- $(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE_TOOLS) compile $(GUILE_WARNINGS) -o "$@" "$<"
-
-SOURCES = eris.scm \
- eris/encode.scm \
- eris/decode.scm \
- eris/read-capability.scm \
- eris/ipfs.scm \
- eris/utils/padding.scm \
- eris/utils/base32.scm \
- eris/utils/rbytevector.scm
-
-TESTS = tests/eris/test-vectors.scm \
- tests/eris/large.scm \
- tests/eris/pseudo-random.scm
-
-TEST_EXTENSIONS = .scm
-SCM_LOG_DRIVER = \
- $(top_builddir)/pre-inst-env \
- $(GUILE) --no-auto-compile -e main \
- $(top_srcdir)/build-aux/test-driver.scm
-
-# Tell 'build-aux/test-driver.scm' to display only source file names,
-# not indivdual test names.
-AM_SCM_LOG_DRIVER_FLAGS = --brief=yes
-
-AM_SCM_LOG_FLAGS = --no-auto-compile -L "$(top_srcdir)"
-
-AM_TESTS_ENVIRONMENT = abs_top_srcdir="$(abs_top_srcdir)"
-
-info_TEXINFOS = doc/eris.texi
-dvi: # Don't build dvi docs
-
-EXTRA_DIST += README.org \
- README \
- HACKING \
- NEWS \
- AUTHORS \
- ChangeLog \
- guix.scm \
- hall.scm \
- build-aux/test-driver.scm \
- configure.ac \
- Makefile.am \
- pre-inst-env.in \
- build-aux/test-driver.scm \
- $(TESTS)
-
-ACLOCAL_AMFLAGS = -I m4
-
-clean-go:
- -$(RM) $(GOBJECTS)
-.PHONY: clean-go
-
-CLEANFILES = \
- $(GOBJECTS) \
- $(TESTS:tests/%.scm=%.log)
-
-.PHONY: spec
-spec: public/index.html
-
-.PHONY: publish
-publish: spec
- rsync -rav -e ssh public/ qfwfq.inqlab.net:/srv/http/inqlab.net-projects/eris/ --delete
-
-public/index.html: doc/eris.adoc doc/diagrams.org
- mkdir -p public
- asciidoctor -o $@ -a webfonts! $<
diff --git a/NEWS b/NEWS
deleted file mode 100644
index c8994a0..0000000
--- a/NEWS
+++ /dev/null
@@ -1,14 +0,0 @@
--*- mode: org; coding: utf-8; -*-
-
-#+TITLE: Guile Eris NEWS – history of user-visible changes
-#+STARTUP: content hidestars
-
-Copyright © (2020) pukkamustard <pukkamustard@posteo.net>
-
- 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.
-
-Please send Guile Eris bug reports to pukkamustard@posteo.net.
-
-* Publication at 0.2
diff --git a/README b/README
deleted file mode 120000
index 314e17d..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-README.org \ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..71270e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Encoding for Robust Immutable Storage (ERIS)
+
+ERIS is an encoding for arbitrary content into uniformly sized encrypted blocks that can be reassembled only in possession of a short /read capability/.
+
+This repository contains the specification documents. The latest version is published here: http://purl.org/eris
+
+## Status
+
+ERIS is considered to be experimental. A stable version (1.0.0) is planned to be released in 2021. Comments and feedback are very welcome.
+
+See also the section "Changelog" in the specification document.
+
+## Implementations
+
+A list of known implementations of ERIS:
+
+- [guile-eris](http://inqlab.net/git/guile-eris.git): The reference implementation in Guile Scheme.
+- [elixir-eris](http://gitlab.com/openengiadina/elixir-eris): Elixir implementation.
+- [eris](https://github.com/cjslep/eris): Go implementation.
+- [eris](https://git.sr.ht/~ehmry/eris): Nim implementation.
+- [js-eris](https://inqlab.net/git/js-eris.git): Javascript implementation.
+
+See also the section "Implementations" of the specification document.
+
+## Acknowledgments
+
+ERIS was initially developed as part of the [openEngiadina](https://openengiadina.net) project and has been supported by the [NLNet Foundation](https:/nlnet) trough the [[NGI0 Discovery Fund](https://nlnet.nl/discovery/).
+
+## Contact
+
+<pukkamustard@posteo.net>
+
+## License
+
+- Specification: [CC-BY-SA-4.0](./LICENSES/CC-BY-SA-4.0.txt)
+- Test vectors: [CC0-1.0](./LICENSES/CC0-1.0.txt)
diff --git a/README.org b/README.org
deleted file mode 100644
index a9524ea..0000000
--- a/README.org
+++ /dev/null
@@ -1,170 +0,0 @@
-# SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-#
-# SPDX-License-Identifier: CC-BY-SA-4.0
-#+TITLE: Encoding for Robust Immutable Storage (ERIS)
-#+PROPERTY: header-args:scheme :session *eris-repl* :eval never-export
-
-ERIS is an encoding for arbitrary content into uniformly sized encrypted blocks that can be reassembled only in possession of a short /read capability/.
-
-This repository contains a [[./doc/eris.adoc][specification]] and a reference Guile implementation.
-
-ERIS is considered to be experimental. See the [[./ROADMAP][ROADMAP]] for a rough plan on where this is going.
-
-This work has been done as part of the [[https://openengiadina.net][openEngiadina]] project and has been supported by the [[https:/nlnet][NLNet Foundation]] trough the [[https://nlnet.nl/discovery/][NGI0 Discovery Fund]].
-
-* Demo
-
-ERIS describes a scheme for splitting up content into uniformly sized encrypted blocks. For reassembling (decoding) the content a special reference is required (the /read capability/).
-
-ERIS does not define storage and transport layer. It relies on a block storage that allows block to be stored and referenced via the hash code of the block itself (content-addressing).
-
-
-** Encoding
-
-To encode some content with ERIS we use ~eris-encode~:
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (eris))
-
-(eris-encode "Hello world!")
-#+END_SRC
-
-#+RESULTS:
-: #<<read-capability> block-size: 1024 level: 0 root-reference: #vu8(63 254 3 75 10 5 103 7 208 238 26 103 0 126 217 124 236 105 205 75 136 116 101 176 189 63 118 210 40 169 217 105) root-key: #vu8(19 230 50 100 252 2 228 177 6 63 67 102 128 217 107 51 19 246 52 165 17 175 247 177 68 0 59 165 100 99 44 219)>
-: ((#vu8(63 254 3 75 10 5 103 7 208 238 26 103 0 126 217 124 236 105 205 75 136 116 101 176 189 63 118 210 40 169 217 105) . #vu8(37 178 171 171 251 214 252 73 148 204 97 93 18 173 141 67 201 218 238 91 176 234 82 10 143 71 63 18 164 32 238 88 19 159 199 99 178 38 150 10 116 192 49 61 44 121 231 148 180 150 229 92 163 134 77 0 113 84 102 208 29 122 104 60 130 160 70 10 45 207 142 165 244 79 16 145 141 87 188 150 77 73 150 162 138 161 99 203 147 230 131 232 60 108 175 44 133 76 33 18 205 252 251 45 111 107 209 218 238 42 180 12 221 47 203 89 58 111 207 61 45 94 12 80 238 36 184 179 30 42 149 240 38 192 190 68 122 117 170 250 22 136 250 170 84 212 253 119 72 5 237 79 76 232 211 132 190 21 207 117 195 250 28 35 86 143 12 146 96 118 94 53 233 171 217 134 135 140 228 40 196 171 68 99 189 249 73 232 58 187 95 111 211 136 16 37 159 129 81 84 0 220 233 49 180 249 8 230 190 44 10 105 203 174 30 240 28 234 198 30 243 146 179 129 181 91 74 59 221 235 63 148 58 137 33 172 45 107 35 239 7 156 101 25 244 254 114 252 207 67 64 92 10 26 204 240 235 155 90 251 24 54 99 218 91 174 61 24 49 96 80 238 124 198 30 168 234 197 176 178 162 211 131 128 66 249 187 241 103 82 55 238 29 114 243 220 150 147 119 207 118 243 252 37 56 37 95 206 23 156 192 179 220 75 141 142 85 105 113 211 43 46 102 151 93 54 204 131 74 189 105 43 89 201 222 79 72 162 94 211 191 249 125 124 248 71 41 158 119 5 247 251 205 108 22 197 43 55 213 116 179 146 195 1 176 136 237 135 60 164 236 15 228 209 13 17 250 220 102 135 195 242 255 88 226 226 42 229 224 163 5 26 235 46 53 142 254 21 207 164 231 43 84 250 227 134 65 45 94 126 54 174 205 197 52 164 9 129 234 49 40 108 103 182 78 78 163 71 147 221 225 148 120 140 74 165 244 204 248 124 218 212 141 13 66 47 224 71 226 201 178 79 226 35 252 108 26 229 136 228 5 10 75 159 185 189 46 239 37 61 122 157 115 47 145 11 140 39 234 250 142 46 228 184 83 239 66 3 10 48 58 7 169 197 223 107 243 99 65 172 148 172 119 2 248 242 74 42 150 247 52 120 150 123 71 61 243 53 56 99 251 113 119 124 148 150 204 204 105 163 129 72 214 110 234 104 17 214 21 171 95 201 22 62 72 185 192 158 112 18 64 243 47 197 249 239 53 37 159 247 115 115 231 176 79 71 43 239 1 105 76 231 118 36 4 166 251 135 159 116 31 232 112 137 156 114 55 33 154 116 94 231 8 89 131 65 66 210 9 45 249 90 11 70 243 176 174 207 9 8 93 112 4 78 210 32 208 50 49 97 84 122 164 24 157 148 39 109 34 104 64 63 174 201 185 118 222 150 64 64 122 81 195 238 23 171 212 110 59 40 116 200 218 106 182 221 182 246 131 21 39 187 132 134 6 126 60 207 46 48 193 159 140 72 133 156 95 109 226 230 48 180 129 22 46 160 254 91 136 183 168 252 235 3 129 242 198 81 223 139 121 120 127 247 93 13 98 22 219 89 91 47 154 92 69 204 178 233 73 255 170 130 43 32 105 254 175 40 243 120 42 166 190 204 3 173 198 93 197 186 57 192 101 94 206 186 26 196 165 113 39 21 253 31 188 67 162 226 203 133 31 97 139 218 73 177 248 70 224 92 120 28 159 36 139 137 112 47 69 151 127 247 88 255 157 182 57 151 22 19 140 59 146 3 66 219 62 153 194 149 85 117 235 154 181 56 112 15 180 140 139 242 218 198 231 18 176 221 136 201 146 4 26 20 204 60 164 48 206 40 46 194 39 213 139 136 105 174 140 166 51 56 178 17 124 84 208 4 162 120 199 110 248 242 227 136 251 215 144 117 117 23 190 105 23 19 72 25 205 239 91 31 95 17 56 161 83 46 106 60 186 198 233 253 174 43 215 60 208 43 180 150 191 162 185 107 218 143 15 60 20 127 130 65 255 208 199 75 13 41 154 128 41 239 169 89 94 59 109 154 173 28 146 236 84 179 124 92 55 184 74 101 124 50 242 168 242 58 160 9 193 116 119 62 4 58 217 18 237 137 5 217 53 176 78 64 34 178 229 64 52 101 111 62 208 207 242 149 138 0 124 147 55 180 96 212 151 64 110 135 62 248 219 17 243 5 108 224 141 237 155 39 175 205 93 127 42 165 147 88 34 78 171 19 210 72 55 95 131 116 124 37 174 74 195 78 130 247 87 233 54 183 154 160)))
-
-This returns the read capability and the encoded blocks in an alist.
-
-The read capability can be encoded as an URN (string):
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (eris read-capability))
-
-(define read-capability
- (call-with-values (lambda () (eris-encode "Hello world!"))
- (lambda (read-capability _) read-capability)))
-
-(read-capability->string read-capability)
-#+END_SRC
-
-#+RESULTS:
-: urn:erisx2:AAAD77QDJMFAKZYH2DXBUZYAP3MXZ3DJZVFYQ5DFWC6T65WSFCU5S2IT4YZGJ7AC4SYQMP2DM2ANS2ZTCP3DJJIRV733CRAAHOSWIYZM3M
-
-This is very useful for verifying that some content was encoded properly and can be done directly with ~eris-encode->urn~:
-
-#+BEGIN_SRC scheme :exports both
-(eris-encode->urn "Hello world!")
-#+END_SRC
-
-#+RESULTS:
-: urn:erisx2:AAAD77QDJMFAKZYH2DXBUZYAP3MXZ3DJZVFYQ5DFWC6T65WSFCU5S2IT4YZGJ7AC4SYQMP2DM2ANS2ZTCP3DJJIRV733CRAAHOSWIYZM3M
-
-Note that ~eris-encode~ and ~eris-encode->urn~ can encode a string, a bytevector or the content in a port:
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (rnrs bytevectors))
-
-(eris-encode->urn (string->utf8 "Hello world!"))
-#+END_SRC
-
-#+RESULTS:
-: urn:erisx2:AAAD77QDJMFAKZYH2DXBUZYAP3MXZ3DJZVFYQ5DFWC6T65WSFCU5S2IT4YZGJ7AC4SYQMP2DM2ANS2ZTCP3DJJIRV733CRAAHOSWIYZM3M
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (rnrs io ports))
-
-(eris-encode->urn (open-bytevector-input-port (string->utf8 "Hello world!")))
-#+END_SRC
-
-#+RESULTS:
-: urn:erisx2:AAAD77QDJMFAKZYH2DXBUZYAP3MXZ3DJZVFYQ5DFWC6T65WSFCU5S2IT4YZGJ7AC4SYQMP2DM2ANS2ZTCP3DJJIRV733CRAAHOSWIYZM3M
-
-** Decoding
-
-Given a read capability and access to the blocks the content can be decoded into a bytevector with ~eris-decode->bytevector~:
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (ice-9 receive)
- (rnrs bytevectors))
-
-(define blocks
- (receive (read-capability blocks)
- (eris-encode "Hello world!")
- blocks))
-
-(utf8->string
- (eris-decode->bytevector
- "urn:erisx2:AAAD77QDJMFAKZYH2DXBUZYAP3MXZ3DJZVFYQ5DFWC6T65WSFCU5S2IT4YZGJ7AC4SYQMP2DM2ANS2ZTCP3DJJIRV733CRAAHOSWIYZM3M"
- (lambda (ref) (assoc-ref blocks ref))))
-#+END_SRC
-
-#+RESULTS:
-: Hello world!
-
-Note that we need to specify how the blocks can be de-referenced. This is because we want to be able to decode with blocks in arbitrary storage.
-
-** Storing blocks
-
-By default ~eris-encode~ returns an alist of references and blocks. Under the hood the SRFI-171 ~rcons~ reducer is used to collect blocks. Any reducer can be given to change what happens to the blocks. For example we can use ~rcount~ to count the number of blocks (but not store the blocks anywhere):
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (srfi srfi-171))
-
-(eris-encode "Hello world!"
- #:block-reducer rcount)
-#+END_SRC
-
-#+RESULTS:
-: #<<read-capability> block-size: 1024 level: 0 root-reference: #vu8(63 254 3 75 10 5 103 7 208 238 26 103 0 126 217 124 236 105 205 75 136 116 101 176 189 63 118 210 40 169 217 105) root-key: #vu8(19 230 50 100 252 2 228 177 6 63 67 102 128 217 107 51 19 246 52 165 17 175 247 177 68 0 59 165 100 99 44 219)>
-: 1
-
-The string "Hello world!" is encoded in a single block.
-
-*** IPFS
-
-IPFS can be used to store and transport block of ERIS encoded content. The ~(eris ipfs)~ module provides the necessary interface to the IPFS HTTP API.
-
-After starting the IPFS daemon (with ~ipfs daemon~), content can be encoded with ERIS and stored on IPFS:
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (eris)
- (eris ipfs))
-
-
-(eris-encode "Hello world!"
- #:block-reducer (ipfs-block-reducer))
-#+END_SRC
-
-#+RESULTS:
-: #<<read-capability> block-size: 1024 level: 0 root-reference: #vu8(63 254 3 75 10 5 103 7 208 238 26 103 0 126 217 124 236 105 205 75 136 116 101 176 189 63 118 210 40 169 217 105) root-key: #vu8(19 230 50 100 252 2 228 177 6 63 67 102 128 217 107 51 19 246 52 165 17 175 247 177 68 0 59 165 100 99 44 219)>
-: done
-
-#+BEGIN_SRC scheme :exports both
-(utf8->string
- (eris-decode->bytevector
- "urn:erisx2:AAAD77QDJMFAKZYH2DXBUZYAP3MXZ3DJZVFYQ5DFWC6T65WSFCU5S2IT4YZGJ7AC4SYQMP2DM2ANS2ZTCP3DJJIRV733CRAAHOSWIYZM3M"
- ipfs-block-ref))
-#+END_SRC
-
-#+RESULTS:
-: Hello world!
-
-See the [[./examples/ipfs.org][IPFS write-up]] for details on how IPFS can be used as storage and transport layer.
-
-** Block size and convergence secret
-
-By default content is encoded into blocks of size 1 KiB. Alternatively a block size of 32 KiB can be used. This is useful (and more efficient) for encoding large content.
-
-A convergence secret can also be specified. See the specification for more details.
-
-** Streaming with Transducers
-
-The functions in the module ~(eris)~ (~eris-encode~, ~eris-encode->urn~ and ~eris-decode->bytevector~) use a streaming interface to the encoding provided in ~(eris encode)~ and ~(eris decode)~.
-
-This lower level interface provides an SRFI-171 transducer for encoding content from any stream of data (e.g. a network socket).
-
-* License
-
-- [[./LICENSES/GPL-3.0-or-later.txt][GPL-3.0-or-later]] :: Guile Implementation
-- [[./LICENSES/CC-BY-SA-4.0.txt][CC-BY-SA-4.0]] :: Specification
-- [[./LICENSES/CC0-1.0.txt][CC0-1.0]] :: Test vectors
diff --git a/ROADMAP b/ROADMAP
deleted file mode 100644
index 73c7b88..0000000
--- a/ROADMAP
+++ /dev/null
@@ -1,21 +0,0 @@
--*- mode: org; coding: utf-8; -*-
-#+TITLE: ERIS Roadmap
-
-* DONE 0.2.0 (late 2020)
-
-- Second version of encoding and specification document for wider circulation and collecting feedback.
-- Guile implementation usable as library for experimentation
-
-* 0.3.0 (early 2021)
-
-- Incorporate feedback from 0.2.0 and prepare a third version for circulation and feedback.
-- Add CBOR tag for read capability for more efficient encoding of references in CBOR
-- Implement random-access decoder in Guile implementation
-- Document the Guile implementation
-
-* 1.0.0 (sometime in 2021)
-
-- Initial non-experimental version of encoding.
-- Change URN namespace identifier to "eris" (e.g. "urn:eris:AFDSFSDFLJSLKFDSF")
-- Maybe submit as IETF Internet-Draft
-- Guile implementation API stable and usable for applications
diff --git a/build-aux/install-sh b/build-aux/install-sh
deleted file mode 100755
index 20d8b2e..0000000
--- a/build-aux/install-sh
+++ /dev/null
@@ -1,529 +0,0 @@
-#!/bin/sh
-# install - install a program, script, or datafile
-
-scriptversion=2018-03-11.20; # UTC
-
-# This originates from X11R5 (mit/util/scripts/install.sh), which was
-# later released in X11R6 (xc/config/util/install.sh) with the
-# following copyright and license.
-#
-# Copyright (C) 1994 X Consortium
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to
-# deal in the Software without restriction, including without limitation the
-# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-# sell copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
-# AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNEC-
-# TION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#
-# Except as contained in this notice, the name of the X Consortium shall not
-# be used in advertising or otherwise to promote the sale, use or other deal-
-# ings in this Software without prior written authorization from the X Consor-
-# tium.
-#
-#
-# FSF changes to this file are in the public domain.
-#
-# Calling this script install-sh is preferred over install.sh, to prevent
-# 'make' implicit rules from creating a file called install from it
-# when there is no Makefile.
-#
-# This script is compatible with the BSD install script, but was written
-# from scratch.
-
-tab=' '
-nl='
-'
-IFS=" $tab$nl"
-
-# Set DOITPROG to "echo" to test this script.
-
-doit=${DOITPROG-}
-doit_exec=${doit:-exec}
-
-# Put in absolute file names if you don't have them in your path;
-# or use environment vars.
-
-chgrpprog=${CHGRPPROG-chgrp}
-chmodprog=${CHMODPROG-chmod}
-chownprog=${CHOWNPROG-chown}
-cmpprog=${CMPPROG-cmp}
-cpprog=${CPPROG-cp}
-mkdirprog=${MKDIRPROG-mkdir}
-mvprog=${MVPROG-mv}
-rmprog=${RMPROG-rm}
-stripprog=${STRIPPROG-strip}
-
-posix_mkdir=
-
-# Desired mode of installed file.
-mode=0755
-
-chgrpcmd=
-chmodcmd=$chmodprog
-chowncmd=
-mvcmd=$mvprog
-rmcmd="$rmprog -f"
-stripcmd=
-
-src=
-dst=
-dir_arg=
-dst_arg=
-
-copy_on_change=false
-is_target_a_directory=possibly
-
-usage="\
-Usage: $0 [OPTION]... [-T] SRCFILE DSTFILE
- or: $0 [OPTION]... SRCFILES... DIRECTORY
- or: $0 [OPTION]... -t DIRECTORY SRCFILES...
- or: $0 [OPTION]... -d DIRECTORIES...
-
-In the 1st form, copy SRCFILE to DSTFILE.
-In the 2nd and 3rd, copy all SRCFILES to DIRECTORY.
-In the 4th, create DIRECTORIES.
-
-Options:
- --help display this help and exit.
- --version display version info and exit.
-
- -c (ignored)
- -C install only if different (preserve the last data modification time)
- -d create directories instead of installing files.
- -g GROUP $chgrpprog installed files to GROUP.
- -m MODE $chmodprog installed files to MODE.
- -o USER $chownprog installed files to USER.
- -s $stripprog installed files.
- -t DIRECTORY install into DIRECTORY.
- -T report an error if DSTFILE is a directory.
-
-Environment variables override the default commands:
- CHGRPPROG CHMODPROG CHOWNPROG CMPPROG CPPROG MKDIRPROG MVPROG
- RMPROG STRIPPROG
-"
-
-while test $# -ne 0; do
- case $1 in
- -c) ;;
-
- -C) copy_on_change=true;;
-
- -d) dir_arg=true;;
-
- -g) chgrpcmd="$chgrpprog $2"
- shift;;
-
- --help) echo "$usage"; exit $?;;
-
- -m) mode=$2
- case $mode in
- *' '* | *"$tab"* | *"$nl"* | *'*'* | *'?'* | *'['*)
- echo "$0: invalid mode: $mode" >&2
- exit 1;;
- esac
- shift;;
-
- -o) chowncmd="$chownprog $2"
- shift;;
-
- -s) stripcmd=$stripprog;;
-
- -t)
- is_target_a_directory=always
- dst_arg=$2
- # Protect names problematic for 'test' and other utilities.
- case $dst_arg in
- -* | [=\(\)!]) dst_arg=./$dst_arg;;
- esac
- shift;;
-
- -T) is_target_a_directory=never;;
-
- --version) echo "$0 $scriptversion"; exit $?;;
-
- --) shift
- break;;
-
- -*) echo "$0: invalid option: $1" >&2
- exit 1;;
-
- *) break;;
- esac
- shift
-done
-
-# We allow the use of options -d and -T together, by making -d
-# take the precedence; this is for compatibility with GNU install.
-
-if test -n "$dir_arg"; then
- if test -n "$dst_arg"; then
- echo "$0: target directory not allowed when installing a directory." >&2
- exit 1
- fi
-fi
-
-if test $# -ne 0 && test -z "$dir_arg$dst_arg"; then
- # When -d is used, all remaining arguments are directories to create.
- # When -t is used, the destination is already specified.
- # Otherwise, the last argument is the destination. Remove it from $@.
- for arg
- do
- if test -n "$dst_arg"; then
- # $@ is not empty: it contains at least $arg.
- set fnord "$@" "$dst_arg"
- shift # fnord
- fi
- shift # arg
- dst_arg=$arg
- # Protect names problematic for 'test' and other utilities.
- case $dst_arg in
- -* | [=\(\)!]) dst_arg=./$dst_arg;;
- esac
- done
-fi
-
-if test $# -eq 0; then
- if test -z "$dir_arg"; then
- echo "$0: no input file specified." >&2
- exit 1
- fi
- # It's OK to call 'install-sh -d' without argument.
- # This can happen when creating conditional directories.
- exit 0
-fi
-
-if test -z "$dir_arg"; then
- if test $# -gt 1 || test "$is_target_a_directory" = always; then
- if test ! -d "$dst_arg"; then
- echo "$0: $dst_arg: Is not a directory." >&2
- exit 1
- fi
- fi
-fi
-
-if test -z "$dir_arg"; then
- do_exit='(exit $ret); exit $ret'
- trap "ret=129; $do_exit" 1
- trap "ret=130; $do_exit" 2
- trap "ret=141; $do_exit" 13
- trap "ret=143; $do_exit" 15
-
- # Set umask so as not to create temps with too-generous modes.
- # However, 'strip' requires both read and write access to temps.
- case $mode in
- # Optimize common cases.
- *644) cp_umask=133;;
- *755) cp_umask=22;;
-
- *[0-7])
- if test -z "$stripcmd"; then
- u_plus_rw=
- else
- u_plus_rw='% 200'
- fi
- cp_umask=`expr '(' 777 - $mode % 1000 ')' $u_plus_rw`;;
- *)
- if test -z "$stripcmd"; then
- u_plus_rw=
- else
- u_plus_rw=,u+rw
- fi
- cp_umask=$mode$u_plus_rw;;
- esac
-fi
-
-for src
-do
- # Protect names problematic for 'test' and other utilities.
- case $src in
- -* | [=\(\)!]) src=./$src;;
- esac
-
- if test -n "$dir_arg"; then
- dst=$src
- dstdir=$dst
- test -d "$dstdir"
- dstdir_status=$?
- else
-
- # Waiting for this to be detected by the "$cpprog $src $dsttmp" command
- # might cause directories to be created, which would be especially bad
- # if $src (and thus $dsttmp) contains '*'.
- if test ! -f "$src" && test ! -d "$src"; then
- echo "$0: $src does not exist." >&2
- exit 1
- fi
-
- if test -z "$dst_arg"; then
- echo "$0: no destination specified." >&2
- exit 1
- fi
- dst=$dst_arg
-
- # If destination is a directory, append the input filename.
- if test -d "$dst"; then
- if test "$is_target_a_directory" = never; then
- echo "$0: $dst_arg: Is a directory" >&2
- exit 1
- fi
- dstdir=$dst
- dstbase=`basename "$src"`
- case $dst in
- */) dst=$dst$dstbase;;
- *) dst=$dst/$dstbase;;
- esac
- dstdir_status=0
- else
- dstdir=`dirname "$dst"`
- test -d "$dstdir"
- dstdir_status=$?
- fi
- fi
-
- case $dstdir in
- */) dstdirslash=$dstdir;;
- *) dstdirslash=$dstdir/;;
- esac
-
- obsolete_mkdir_used=false
-
- if test $dstdir_status != 0; then
- case $posix_mkdir in
- '')
- # Create intermediate dirs using mode 755 as modified by the umask.
- # This is like FreeBSD 'install' as of 1997-10-28.
- umask=`umask`
- case $stripcmd.$umask in
- # Optimize common cases.
- *[2367][2367]) mkdir_umask=$umask;;
- .*0[02][02] | .[02][02] | .[02]) mkdir_umask=22;;
-
- *[0-7])
- mkdir_umask=`expr $umask + 22 \
- - $umask % 100 % 40 + $umask % 20 \
- - $umask % 10 % 4 + $umask % 2
- `;;
- *) mkdir_umask=$umask,go-w;;
- esac
-
- # With -d, create the new directory with the user-specified mode.
- # Otherwise, rely on $mkdir_umask.
- if test -n "$dir_arg"; then
- mkdir_mode=-m$mode
- else
- mkdir_mode=
- fi
-
- posix_mkdir=false
- case $umask in
- *[123567][0-7][0-7])
- # POSIX mkdir -p sets u+wx bits regardless of umask, which
- # is incompatible with FreeBSD 'install' when (umask & 300) != 0.
- ;;
- *)
- # Note that $RANDOM variable is not portable (e.g. dash); Use it
- # here however when possible just to lower collision chance.
- tmpdir=${TMPDIR-/tmp}/ins$RANDOM-$$
-
- trap 'ret=$?; rmdir "$tmpdir/a/b" "$tmpdir/a" "$tmpdir" 2>/dev/null; exit $ret' 0
-
- # Because "mkdir -p" follows existing symlinks and we likely work
- # directly in world-writeable /tmp, make sure that the '$tmpdir'
- # directory is successfully created first before we actually test
- # 'mkdir -p' feature.
- if (umask $mkdir_umask &&
- $mkdirprog $mkdir_mode "$tmpdir" &&
- exec $mkdirprog $mkdir_mode -p -- "$tmpdir/a/b") >/dev/null 2>&1
- then
- if test -z "$dir_arg" || {
- # Check for POSIX incompatibilities with -m.
- # HP-UX 11.23 and IRIX 6.5 mkdir -m -p sets group- or
- # other-writable bit of parent directory when it shouldn't.
- # FreeBSD 6.1 mkdir -m -p sets mode of existing directory.
- test_tmpdir="$tmpdir/a"
- ls_ld_tmpdir=`ls -ld "$test_tmpdir"`
- case $ls_ld_tmpdir in
- d????-?r-*) different_mode=700;;
- d????-?--*) different_mode=755;;
- *) false;;
- esac &&
- $mkdirprog -m$different_mode -p -- "$test_tmpdir" && {
- ls_ld_tmpdir_1=`ls -ld "$test_tmpdir"`
- test "$ls_ld_tmpdir" = "$ls_ld_tmpdir_1"
- }
- }
- then posix_mkdir=:
- fi
- rmdir "$tmpdir/a/b" "$tmpdir/a" "$tmpdir"
- else
- # Remove any dirs left behind by ancient mkdir implementations.
- rmdir ./$mkdir_mode ./-p ./-- "$tmpdir" 2>/dev/null
- fi
- trap '' 0;;
- esac;;
- esac
-
- if
- $posix_mkdir && (
- umask $mkdir_umask &&
- $doit_exec $mkdirprog $mkdir_mode -p -- "$dstdir"
- )
- then :
- else
-
- # The umask is ridiculous, or mkdir does not conform to POSIX,
- # or it failed possibly due to a race condition. Create the
- # directory the slow way, step by step, checking for races as we go.
-
- case $dstdir in
- /*) prefix='/';;
- [-=\(\)!]*) prefix='./';;
- *) prefix='';;
- esac
-
- oIFS=$IFS
- IFS=/
- set -f
- set fnord $dstdir
- shift
- set +f
- IFS=$oIFS
-
- prefixes=
-
- for d
- do
- test X"$d" = X && continue
-
- prefix=$prefix$d
- if test -d "$prefix"; then
- prefixes=
- else
- if $posix_mkdir; then
- (umask=$mkdir_umask &&
- $doit_exec $mkdirprog $mkdir_mode -p -- "$dstdir") && break
- # Don't fail if two instances are running concurrently.
- test -d "$prefix" || exit 1
- else
- case $prefix in
- *\'*) qprefix=`echo "$prefix" | sed "s/'/'\\\\\\\\''/g"`;;
- *) qprefix=$prefix;;
- esac
- prefixes="$prefixes '$qprefix'"
- fi
- fi
- prefix=$prefix/
- done
-
- if test -n "$prefixes"; then
- # Don't fail if two instances are running concurrently.
- (umask $mkdir_umask &&
- eval "\$doit_exec \$mkdirprog $prefixes") ||
- test -d "$dstdir" || exit 1
- obsolete_mkdir_used=true
- fi
- fi
- fi
-
- if test -n "$dir_arg"; then
- { test -z "$chowncmd" || $doit $chowncmd "$dst"; } &&
- { test -z "$chgrpcmd" || $doit $chgrpcmd "$dst"; } &&
- { test "$obsolete_mkdir_used$chowncmd$chgrpcmd" = false ||
- test -z "$chmodcmd" || $doit $chmodcmd $mode "$dst"; } || exit 1
- else
-
- # Make a couple of temp file names in the proper directory.
- dsttmp=${dstdirslash}_inst.$$_
- rmtmp=${dstdirslash}_rm.$$_
-
- # Trap to clean up those temp files at exit.
- trap 'ret=$?; rm -f "$dsttmp" "$rmtmp" && exit $ret' 0
-
- # Copy the file name to the temp name.
- (umask $cp_umask &&
- { test -z "$stripcmd" || {
- # Create $dsttmp read-write so that cp doesn't create it read-only,
- # which would cause strip to fail.
- if test -z "$doit"; then
- : >"$dsttmp" # No need to fork-exec 'touch'.
- else
- $doit touch "$dsttmp"
- fi
- }
- } &&
- $doit_exec $cpprog "$src" "$dsttmp") &&
-
- # and set any options; do chmod last to preserve setuid bits.
- #
- # If any of these fail, we abort the whole thing. If we want to
- # ignore errors from any of these, just make sure not to ignore
- # errors from the above "$doit $cpprog $src $dsttmp" command.
- #
- { test -z "$chowncmd" || $doit $chowncmd "$dsttmp"; } &&
- { test -z "$chgrpcmd" || $doit $chgrpcmd "$dsttmp"; } &&
- { test -z "$stripcmd" || $doit $stripcmd "$dsttmp"; } &&
- { test -z "$chmodcmd" || $doit $chmodcmd $mode "$dsttmp"; } &&
-
- # If -C, don't bother to copy if it wouldn't change the file.
- if $copy_on_change &&
- old=`LC_ALL=C ls -dlL "$dst" 2>/dev/null` &&
- new=`LC_ALL=C ls -dlL "$dsttmp" 2>/dev/null` &&
- set -f &&
- set X $old && old=:$2:$4:$5:$6 &&
- set X $new && new=:$2:$4:$5:$6 &&
- set +f &&
- test "$old" = "$new" &&
- $cmpprog "$dst" "$dsttmp" >/dev/null 2>&1
- then
- rm -f "$dsttmp"
- else
- # Rename the file to the real destination.
- $doit $mvcmd -f "$dsttmp" "$dst" 2>/dev/null ||
-
- # The rename failed, perhaps because mv can't rename something else
- # to itself, or perhaps because mv is so ancient that it does not
- # support -f.
- {
- # Now remove or move aside any old file at destination location.
- # We try this two ways since rm can't unlink itself on some
- # systems and the destination file might be busy for other
- # reasons. In this case, the final cleanup might fail but the new
- # file should still install successfully.
- {
- test ! -f "$dst" ||
- $doit $rmcmd -f "$dst" 2>/dev/null ||
- { $doit $mvcmd -f "$dst" "$rmtmp" 2>/dev/null &&
- { $doit $rmcmd -f "$rmtmp" 2>/dev/null; :; }
- } ||
- { echo "$0: cannot unlink or rename $dst" >&2
- (exit 1); exit 1
- }
- } &&
-
- # Now rename the file to the real destination.
- $doit $mvcmd "$dsttmp" "$dst"
- }
- fi || exit 1
-
- trap '' 0
- fi
-done
-
-# Local variables:
-# eval: (add-hook 'before-save-hook 'time-stamp)
-# time-stamp-start: "scriptversion="
-# time-stamp-format: "%:y-%02m-%02d.%02H"
-# time-stamp-time-zone: "UTC0"
-# time-stamp-end: "; # UTC"
-# End:
diff --git a/build-aux/mdate-sh b/build-aux/mdate-sh
deleted file mode 100755
index 6a6a4bc..0000000
--- a/build-aux/mdate-sh
+++ /dev/null
@@ -1,228 +0,0 @@
-#!/bin/sh
-# Get modification time of a file or directory and pretty-print it.
-
-scriptversion=2018-03-07.03; # UTC
-
-# Copyright (C) 1995-2020 Free Software Foundation, Inc.
-# written by Ulrich Drepper <drepper@gnu.ai.mit.edu>, June 1995
-#
-# 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 2, 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 <https://www.gnu.org/licenses/>.
-
-# As a special exception to the GNU General Public License, if you
-# distribute this file as part of a program that contains a
-# configuration script generated by Autoconf, you may include it under
-# the same distribution terms that you use for the rest of that program.
-
-# This file is maintained in Automake, please report
-# bugs to <bug-automake@gnu.org> or send patches to
-# <automake-patches@gnu.org>.
-
-if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then
- emulate sh
- NULLCMD=:
- # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which
- # is contrary to our usage. Disable this feature.
- alias -g '${1+"$@"}'='"$@"'
- setopt NO_GLOB_SUBST
-fi
-
-case $1 in
- '')
- echo "$0: No file. Try '$0 --help' for more information." 1>&2
- exit 1;
- ;;
- -h | --h*)
- cat <<\EOF
-Usage: mdate-sh [--help] [--version] FILE
-
-Pretty-print the modification day of FILE, in the format:
-1 January 1970
-
-Report bugs to <bug-automake@gnu.org>.
-EOF
- exit $?
- ;;
- -v | --v*)
- echo "mdate-sh $scriptversion"
- exit $?
- ;;
-esac
-
-error ()
-{
- echo "$0: $1" >&2
- exit 1
-}
-
-
-# Prevent date giving response in another language.
-LANG=C
-export LANG
-LC_ALL=C
-export LC_ALL
-LC_TIME=C
-export LC_TIME
-
-# Use UTC to get reproducible result.
-TZ=UTC0
-export TZ
-
-# GNU ls changes its time format in response to the TIME_STYLE
-# variable. Since we cannot assume 'unset' works, revert this
-# variable to its documented default.
-if test "${TIME_STYLE+set}" = set; then
- TIME_STYLE=posix-long-iso
- export TIME_STYLE
-fi
-
-save_arg1=$1
-
-# Find out how to get the extended ls output of a file or directory.
-if ls -L /dev/null 1>/dev/null 2>&1; then
- ls_command='ls -L -l -d'
-else
- ls_command='ls -l -d'
-fi
-# Avoid user/group names that might have spaces, when possible.
-if ls -n /dev/null 1>/dev/null 2>&1; then
- ls_command="$ls_command -n"
-fi
-
-# A 'ls -l' line looks as follows on OS/2.
-# drwxrwx--- 0 Aug 11 2001 foo
-# This differs from Unix, which adds ownership information.
-# drwxrwx--- 2 root root 4096 Aug 11 2001 foo
-#
-# To find the date, we split the line on spaces and iterate on words
-# until we find a month. This cannot work with files whose owner is a
-# user named "Jan", or "Feb", etc. However, it's unlikely that '/'
-# will be owned by a user whose name is a month. So we first look at
-# the extended ls output of the root directory to decide how many
-# words should be skipped to get the date.
-
-# On HPUX /bin/sh, "set" interprets "-rw-r--r--" as options, so the "x" below.
-set x`$ls_command /`
-
-# Find which argument is the month.
-month=
-command=
-until test $month
-do
- test $# -gt 0 || error "failed parsing '$ls_command /' output"
- shift
- # Add another shift to the command.
- command="$command shift;"
- case $1 in
- Jan) month=January; nummonth=1;;
- Feb) month=February; nummonth=2;;
- Mar) month=March; nummonth=3;;
- Apr) month=April; nummonth=4;;
- May) month=May; nummonth=5;;
- Jun) month=June; nummonth=6;;
- Jul) month=July; nummonth=7;;
- Aug) month=August; nummonth=8;;
- Sep) month=September; nummonth=9;;
- Oct) month=October; nummonth=10;;
- Nov) month=November; nummonth=11;;
- Dec) month=December; nummonth=12;;
- esac
-done
-
-test -n "$month" || error "failed parsing '$ls_command /' output"
-
-# Get the extended ls output of the file or directory.
-set dummy x`eval "$ls_command \"\\\$save_arg1\""`
-
-# Remove all preceding arguments
-eval $command
-
-# Because of the dummy argument above, month is in $2.
-#
-# On a POSIX system, we should have
-#
-# $# = 5
-# $1 = file size
-# $2 = month
-# $3 = day
-# $4 = year or time
-# $5 = filename
-#
-# On Darwin 7.7.0 and 7.6.0, we have
-#
-# $# = 4
-# $1 = day
-# $2 = month
-# $3 = year or time
-# $4 = filename
-
-# Get the month.
-case $2 in
- Jan) month=January; nummonth=1;;
- Feb) month=February; nummonth=2;;
- Mar) month=March; nummonth=3;;
- Apr) month=April; nummonth=4;;
- May) month=May; nummonth=5;;
- Jun) month=June; nummonth=6;;
- Jul) month=July; nummonth=7;;
- Aug) month=August; nummonth=8;;
- Sep) month=September; nummonth=9;;
- Oct) month=October; nummonth=10;;
- Nov) month=November; nummonth=11;;
- Dec) month=December; nummonth=12;;
-esac
-
-case $3 in
- ???*) day=$1;;
- *) day=$3; shift;;
-esac
-
-# Here we have to deal with the problem that the ls output gives either
-# the time of day or the year.
-case $3 in
- *:*) set `date`; eval year=\$$#
- case $2 in
- Jan) nummonthtod=1;;
- Feb) nummonthtod=2;;
- Mar) nummonthtod=3;;
- Apr) nummonthtod=4;;
- May) nummonthtod=5;;
- Jun) nummonthtod=6;;
- Jul) nummonthtod=7;;
- Aug) nummonthtod=8;;
- Sep) nummonthtod=9;;
- Oct) nummonthtod=10;;
- Nov) nummonthtod=11;;
- Dec) nummonthtod=12;;
- esac
- # For the first six month of the year the time notation can also
- # be used for files modified in the last year.
- if (expr $nummonth \> $nummonthtod) > /dev/null;
- then
- year=`expr $year - 1`
- fi;;
- *) year=$3;;
-esac
-
-# The result.
-echo $day $month $year
-
-# Local Variables:
-# mode: shell-script
-# sh-indentation: 2
-# eval: (add-hook 'before-save-hook 'time-stamp)
-# time-stamp-start: "scriptversion="
-# time-stamp-format: "%:y-%02m-%02d.%02H"
-# time-stamp-time-zone: "UTC0"
-# time-stamp-end: "; # UTC"
-# End:
diff --git a/build-aux/missing b/build-aux/missing
deleted file mode 100755
index 3d6cabf..0000000
--- a/build-aux/missing
+++ /dev/null
@@ -1,215 +0,0 @@
-#!/bin/sh
-# Common wrapper for a few potentially missing GNU programs.
-
-scriptversion=2018-03-07.03; # UTC
-
-# Copyright (C) 1996-2020 Free Software Foundation, Inc.
-# Originally written by Fran,cois Pinard <pinard@iro.umontreal.ca>, 1996.
-
-# 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 2, 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 <https://www.gnu.org/licenses/>.
-
-# As a special exception to the GNU General Public License, if you
-# distribute this file as part of a program that contains a
-# configuration script generated by Autoconf, you may include it under
-# the same distribution terms that you use for the rest of that program.
-
-if test $# -eq 0; then
- echo 1>&2 "Try '$0 --help' for more information"
- exit 1
-fi
-
-case $1 in
-
- --is-lightweight)
- # Used by our autoconf macros to check whether the available missing
- # script is modern enough.
- exit 0
- ;;
-
- --run)
- # Back-compat with the calling convention used by older automake.
- shift
- ;;
-
- -h|--h|--he|--hel|--help)
- echo "\
-$0 [OPTION]... PROGRAM [ARGUMENT]...
-
-Run 'PROGRAM [ARGUMENT]...', returning a proper advice when this fails due
-to PROGRAM being missing or too old.
-
-Options:
- -h, --help display this help and exit
- -v, --version output version information and exit
-
-Supported PROGRAM values:
- aclocal autoconf autoheader autom4te automake makeinfo
- bison yacc flex lex help2man
-
-Version suffixes to PROGRAM as well as the prefixes 'gnu-', 'gnu', and
-'g' are ignored when checking the name.
-
-Send bug reports to <bug-automake@gnu.org>."
- exit $?
- ;;
-
- -v|--v|--ve|--ver|--vers|--versi|--versio|--version)
- echo "missing $scriptversion (GNU Automake)"
- exit $?
- ;;
-
- -*)
- echo 1>&2 "$0: unknown '$1' option"
- echo 1>&2 "Try '$0 --help' for more information"
- exit 1
- ;;
-
-esac
-
-# Run the given program, remember its exit status.
-"$@"; st=$?
-
-# If it succeeded, we are done.
-test $st -eq 0 && exit 0
-
-# Also exit now if we it failed (or wasn't found), and '--version' was
-# passed; such an option is passed most likely to detect whether the
-# program is present and works.
-case $2 in --version|--help) exit $st;; esac
-
-# Exit code 63 means version mismatch. This often happens when the user
-# tries to use an ancient version of a tool on a file that requires a
-# minimum version.
-if test $st -eq 63; then
- msg="probably too old"
-elif test $st -eq 127; then
- # Program was missing.
- msg="missing on your system"
-else
- # Program was found and executed, but failed. Give up.
- exit $st
-fi
-
-perl_URL=https://www.perl.org/
-flex_URL=https://github.com/westes/flex
-gnu_software_URL=https://www.gnu.org/software
-
-program_details ()
-{
- case $1 in
- aclocal|automake)
- echo "The '$1' program is part of the GNU Automake package:"
- echo "<$gnu_software_URL/automake>"
- echo "It also requires GNU Autoconf, GNU m4 and Perl in order to run:"
- echo "<$gnu_software_URL/autoconf>"
- echo "<$gnu_software_URL/m4/>"
- echo "<$perl_URL>"
- ;;
- autoconf|autom4te|autoheader)
- echo "The '$1' program is part of the GNU Autoconf package:"
- echo "<$gnu_software_URL/autoconf/>"
- echo "It also requires GNU m4 and Perl in order to run:"
- echo "<$gnu_software_URL/m4/>"
- echo "<$perl_URL>"
- ;;
- esac
-}
-
-give_advice ()
-{
- # Normalize program name to check for.
- normalized_program=`echo "$1" | sed '
- s/^gnu-//; t
- s/^gnu//; t
- s/^g//; t'`
-
- printf '%s\n' "'$1' is $msg."
-
- configure_deps="'configure.ac' or m4 files included by 'configure.ac'"
- case $normalized_program in
- autoconf*)
- echo "You should only need it if you modified 'configure.ac',"
- echo "or m4 files included by it."
- program_details 'autoconf'
- ;;
- autoheader*)
- echo "You should only need it if you modified 'acconfig.h' or"
- echo "$configure_deps."
- program_details 'autoheader'
- ;;
- automake*)
- echo "You should only need it if you modified 'Makefile.am' or"
- echo "$configure_deps."
- program_details 'automake'
- ;;
- aclocal*)
- echo "You should only need it if you modified 'acinclude.m4' or"
- echo "$configure_deps."
- program_details 'aclocal'
- ;;
- autom4te*)
- echo "You might have modified some maintainer files that require"
- echo "the 'autom4te' program to be rebuilt."
- program_details 'autom4te'
- ;;
- bison*|yacc*)
- echo "You should only need it if you modified a '.y' file."
- echo "You may want to install the GNU Bison package:"
- echo "<$gnu_software_URL/bison/>"
- ;;
- lex*|flex*)
- echo "You should only need it if you modified a '.l' file."
- echo "You may want to install the Fast Lexical Analyzer package:"
- echo "<$flex_URL>"
- ;;
- help2man*)
- echo "You should only need it if you modified a dependency" \
- "of a man page."
- echo "You may want to install the GNU Help2man package:"
- echo "<$gnu_software_URL/help2man/>"
- ;;
- makeinfo*)
- echo "You should only need it if you modified a '.texi' file, or"
- echo "any other file indirectly affecting the aspect of the manual."
- echo "You might want to install the Texinfo package:"
- echo "<$gnu_software_URL/texinfo/>"
- echo "The spurious makeinfo call might also be the consequence of"
- echo "using a buggy 'make' (AIX, DU, IRIX), in which case you might"
- echo "want to install GNU make:"
- echo "<$gnu_software_URL/make/>"
- ;;
- *)
- echo "You might have modified some files without having the proper"
- echo "tools for further handling them. Check the 'README' file, it"
- echo "often tells you about the needed prerequisites for installing"
- echo "this package. You may also peek at any GNU archive site, in"
- echo "case some other package contains this missing '$1' program."
- ;;
- esac
-}
-
-give_advice "$1" | sed -e '1s/^/WARNING: /' \
- -e '2,$s/^/ /' >&2
-
-# Propagate the correct exit status (expected to be 127 for a program
-# not found, 63 for a program that failed due to version mismatch).
-exit $st
-
-# Local variables:
-# eval: (add-hook 'before-save-hook 'time-stamp)
-# time-stamp-start: "scriptversion="
-# time-stamp-format: "%:y-%02m-%02d.%02H"
-# time-stamp-time-zone: "UTC0"
-# time-stamp-end: "; # UTC"
-# End:
diff --git a/build-aux/test-driver.scm b/build-aux/test-driver.scm
deleted file mode 100644
index a818968..0000000
--- a/build-aux/test-driver.scm
+++ /dev/null
@@ -1,180 +0,0 @@
-
-;;;; test-driver.scm - Guile test driver for Automake testsuite harness
-
-(define script-version "2019-01-15.13") ;UTC
-
-;;; Copyright © 2015, 2016 Mathieu Lirzin <mthl@gnu.org>
-;;; Copyright © 2019 Alex Sassmannshausen <alex@pompo.co>
-;;;
-;;; 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 <http://www.gnu.org/licenses/>.
-
-;;;; Commentary:
-;;;
-;;; This script provides a Guile test driver using the SRFI-64 Scheme API for
-;;; test suites. SRFI-64 is distributed with Guile since version 2.0.9.
-;;;
-;;; This script is a lightly modified version of the orignal written by
-;;; Matthieu Lirzin. The changes make it suitable for use as part of the
-;;; guile-hall infrastructure.
-;;;
-;;;; Code:
-
-(use-modules (ice-9 getopt-long)
- (ice-9 pretty-print)
- (srfi srfi-26)
- (srfi srfi-64))
-
-(define (show-help)
- (display "Usage:
- test-driver --test-name=NAME --log-file=PATH --trs-file=PATH
- [--expect-failure={yes|no}] [--color-tests={yes|no}]
- [--enable-hard-errors={yes|no}] [--brief={yes|no}}] [--]
- TEST-SCRIPT [TEST-SCRIPT-ARGUMENTS]
-The '--test-name', '--log-file' and '--trs-file' options are mandatory.
-"))
-
-(define %options
- '((test-name (value #t))
- (log-file (value #t))
- (trs-file (value #t))
- (color-tests (value #t))
- (expect-failure (value #t)) ;XXX: not implemented yet
- (enable-hard-errors (value #t)) ;not implemented in SRFI-64
- (brief (value #t))
- (help (single-char #\h) (value #f))
- (version (single-char #\V) (value #f))))
-
-(define (option->boolean options key)
- "Return #t if the value associated with KEY in OPTIONS is 'yes'."
- (and=> (option-ref options key #f) (cut string=? <> "yes")))
-
-(define* (test-display field value #:optional (port (current-output-port))
- #:key pretty?)
- "Display 'FIELD: VALUE\n' on PORT."
- (if pretty?
- (begin
- (format port "~A:~%" field)
- (pretty-print value port #:per-line-prefix "+ "))
- (format port "~A: ~S~%" field value)))
-
-(define* (result->string symbol #:key colorize?)
- "Return SYMBOL as an upper case string. Use colors when COLORIZE is #t."
- (let ((result (string-upcase (symbol->string symbol))))
- (if colorize?
- (string-append (case symbol
- ((pass) "") ;green
- ((xfail) "") ;light green
- ((skip) "") ;blue
- ((fail xpass) "") ;red
- ((error) "")) ;magenta
- result
- "") ;no color
- result)))
-
-(define* (test-runner-gnu test-name #:key color? brief? out-port trs-port)
- "Return an custom SRFI-64 test runner. TEST-NAME is a string specifying the
-file name of the current the test. COLOR? specifies whether to use colors,
-and BRIEF?, well, you know. OUT-PORT and TRS-PORT must be output ports. The
-current output port is supposed to be redirected to a '.log' file."
-
- (define (test-on-test-begin-gnu runner)
- ;; Procedure called at the start of an individual test case, before the
- ;; test expression (and expected value) are evaluated.
- (let ((result (cute assq-ref (test-result-alist runner) <>)))
- (format #t "test-name: ~A~%" (result 'test-name))
- (format #t "location: ~A~%"
- (string-append (result 'source-file) ":"
- (number->string (result 'source-line))))
- (test-display "source" (result 'source-form) #:pretty? #t)))
-
- (define (test-on-test-end-gnu runner)
- ;; Procedure called at the end of an individual test case, when the result
- ;; of the test is available.
- (let* ((results (test-result-alist runner))
- (result? (cut assq <> results))
- (result (cut assq-ref results <>)))
- (unless brief?
- ;; Display the result of each test case on the console.
- (format out-port "~A: ~A - ~A~%"
- (result->string (test-result-kind runner) #:colorize? color?)
- test-name (test-runner-test-name runner)))
- (when (result? 'expected-value)
- (test-display "expected-value" (result 'expected-value)))
- (when (result? 'expected-error)
- (test-display "expected-error" (result 'expected-error) #:pretty? #t))
- (when (result? 'actual-value)
- (test-display "actual-value" (result 'actual-value)))
- (when (result? 'actual-error)
- (test-display "actual-error" (result 'actual-error) #:pretty? #t))
- (format #t "result: ~a~%" (result->string (result 'result-kind)))
- (newline)
- (format trs-port ":test-result: ~A ~A~%"
- (result->string (test-result-kind runner))
- (test-runner-test-name runner))))
-
- (define (test-on-group-end-gnu runner)
- ;; Procedure called by a 'test-end', including at the end of a test-group.
- (let ((fail (or (positive? (test-runner-fail-count runner))
- (positive? (test-runner-xpass-count runner))))
- (skip (or (positive? (test-runner-skip-count runner))
- (positive? (test-runner-xfail-count runner)))))
- ;; XXX: The global results need some refinements for XPASS.
- (format trs-port ":global-test-result: ~A~%"
- (if fail "FAIL" (if skip "SKIP" "PASS")))
- (format trs-port ":recheck: ~A~%"
- (if fail "yes" "no"))
- (format trs-port ":copy-in-global-log: ~A~%"
- (if (or fail skip) "yes" "no"))
- (when brief?
- ;; Display the global test group result on the console.
- (format out-port "~A: ~A~%"
- (result->string (if fail 'fail (if skip 'skip 'pass))
- #:colorize? color?)
- test-name))
- #f))
-
- (let ((runner (test-runner-null)))
- (test-runner-on-test-begin! runner test-on-test-begin-gnu)
- (test-runner-on-test-end! runner test-on-test-end-gnu)
- (test-runner-on-group-end! runner test-on-group-end-gnu)
- (test-runner-on-bad-end-name! runner test-on-bad-end-name-simple)
- runner))
-
-;;;
-;;; Entry point.
-;;;
-
-(define (main . args)
- (let* ((opts (getopt-long (command-line) %options))
- (option (cut option-ref opts <> <>)))
- (cond
- ((option 'help #f) (show-help))
- ((option 'version #f) (format #t "test-driver.scm ~A" script-version))
- (else
- (let ((log (open-file (option 'log-file "") "w0"))
- (trs (open-file (option 'trs-file "") "wl"))
- (out (duplicate-port (current-output-port) "wl")))
- (redirect-port log (current-output-port))
- (redirect-port log (current-warning-port))
- (redirect-port log (current-error-port))
- (test-with-runner
- (test-runner-gnu (option 'test-name #f)
- #:color? (option->boolean opts 'color-tests)
- #:brief? (option->boolean opts 'brief)
- #:out-port out #:trs-port trs)
- (load-from-path (option 'test-name #f)))
- (close-port log)
- (close-port trs)
- (close-port out))))
- (exit 0)))
diff --git a/build-aux/texinfo.tex b/build-aux/texinfo.tex
deleted file mode 100644
index deca599..0000000
--- a/build-aux/texinfo.tex
+++ /dev/null
@@ -1,11614 +0,0 @@
-% texinfo.tex -- TeX macros to handle Texinfo files.
-%
-% Load plain if necessary, i.e., if running under initex.
-\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
-%
-\def\texinfoversion{2020-02-11.09}
-%
-% Copyright 1985, 1986, 1988, 1990-2019 Free Software Foundation, Inc.
-%
-% This texinfo.tex file 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 texinfo.tex file 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 <https://www.gnu.org/licenses/>.
-%
-% As a special exception, when this file is read by TeX when processing
-% a Texinfo source document, you may use the result without
-% restriction. This Exception is an additional permission under section 7
-% of the GNU General Public License, version 3 ("GPLv3").
-%
-% Please try the latest version of texinfo.tex before submitting bug
-% reports; you can get the latest version from:
-% https://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or
-% https://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or
-% https://www.gnu.org/software/texinfo/ (the Texinfo home page)
-% The texinfo.tex in any given distribution could well be out
-% of date, so if that's what you're using, please check.
-%
-% Send bug reports to bug-texinfo@gnu.org. Please include including a
-% complete document in each bug report with which we can reproduce the
-% problem. Patches are, of course, greatly appreciated.
-%
-% To process a Texinfo manual with TeX, it's most reliable to use the
-% texi2dvi shell script that comes with the distribution. For a simple
-% manual foo.texi, however, you can get away with this:
-% tex foo.texi
-% texindex foo.??
-% tex foo.texi
-% tex foo.texi
-% dvips foo.dvi -o # or whatever; this makes foo.ps.
-% The extra TeX runs get the cross-reference information correct.
-% Sometimes one run after texindex suffices, and sometimes you need more
-% than two; texi2dvi does it as many times as necessary.
-%
-% It is possible to adapt texinfo.tex for other languages, to some
-% extent. You can get the existing language-specific files from the
-% full Texinfo distribution.
-%
-% The GNU Texinfo home page is https://www.gnu.org/software/texinfo.
-
-
-\message{Loading texinfo [version \texinfoversion]:}
-
-% If in a .fmt file, print the version number
-% and turn on active characters that we couldn't do earlier because
-% they might have appeared in the input file name.
-\everyjob{\message{[Texinfo version \texinfoversion]}%
- \catcode`+=\active \catcode`\_=\active}
-
-% LaTeX's \typeout. This ensures that the messages it is used for
-% are identical in format to the corresponding ones from latex/pdflatex.
-\def\typeout{\immediate\write17}%
-
-\chardef\other=12
-
-% We never want plain's \outer definition of \+ in Texinfo.
-% For @tex, we can use \tabalign.
-\let\+ = \relax
-
-% Save some plain tex macros whose names we will redefine.
-\let\ptexb=\b
-\let\ptexbullet=\bullet
-\let\ptexc=\c
-\let\ptexcomma=\,
-\let\ptexdot=\.
-\let\ptexdots=\dots
-\let\ptexend=\end
-\let\ptexequiv=\equiv
-\let\ptexexclam=\!
-\let\ptexfootnote=\footnote
-\let\ptexgtr=>
-\let\ptexhat=^
-\let\ptexi=\i
-\let\ptexindent=\indent
-\let\ptexinsert=\insert
-\let\ptexlbrace=\{
-\let\ptexless=<
-\let\ptexnewwrite\newwrite
-\let\ptexnoindent=\noindent
-\let\ptexplus=+
-\let\ptexraggedright=\raggedright
-\let\ptexrbrace=\}
-\let\ptexslash=\/
-\let\ptexsp=\sp
-\let\ptexstar=\*
-\let\ptexsup=\sup
-\let\ptext=\t
-\let\ptextop=\top
-{\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode
-
-% If this character appears in an error message or help string, it
-% starts a new line in the output.
-\newlinechar = `^^J
-
-% Use TeX 3.0's \inputlineno to get the line number, for better error
-% messages, but if we're using an old version of TeX, don't do anything.
-%
-\ifx\inputlineno\thisisundefined
- \let\linenumber = \empty % Pre-3.0.
-\else
- \def\linenumber{l.\the\inputlineno:\space}
-\fi
-
-% Set up fixed words for English if not already set.
-\ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi
-\ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi
-\ifx\putworderror\undefined \gdef\putworderror{error}\fi
-\ifx\putwordfile\undefined \gdef\putwordfile{file}\fi
-\ifx\putwordin\undefined \gdef\putwordin{in}\fi
-\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi
-\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi
-\ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi
-\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi
-\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi
-\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi
-\ifx\putwordof\undefined \gdef\putwordof{of}\fi
-\ifx\putwordon\undefined \gdef\putwordon{on}\fi
-\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi
-\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi
-\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi
-\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi
-\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi
-\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi
-\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi
-%
-\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi
-\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi
-\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi
-\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi
-\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi
-\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi
-\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi
-\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi
-\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi
-\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi
-\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi
-\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi
-%
-\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi
-\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi
-\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi
-\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi
-\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi
-
-% Give the space character the catcode for a space.
-\def\spaceisspace{\catcode`\ =10\relax}
-
-% Likewise for ^^M, the end of line character.
-\def\endlineisspace{\catcode13=10\relax}
-
-\chardef\dashChar = `\-
-\chardef\slashChar = `\/
-\chardef\underChar = `\_
-
-% Ignore a token.
-%
-\def\gobble#1{}
-
-% The following is used inside several \edef's.
-\def\makecsname#1{\expandafter\noexpand\csname#1\endcsname}
-
-% Hyphenation fixes.
-\hyphenation{
- Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script
- ap-pen-dix bit-map bit-maps
- data-base data-bases eshell fall-ing half-way long-est man-u-script
- man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm
- par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces
- spell-ing spell-ings
- stand-alone strong-est time-stamp time-stamps which-ever white-space
- wide-spread wrap-around
-}
-
-% Sometimes it is convenient to have everything in the transcript file
-% and nothing on the terminal. We don't just call \tracingall here,
-% since that produces some useless output on the terminal. We also make
-% some effort to order the tracing commands to reduce output in the log
-% file; cf. trace.sty in LaTeX.
-%
-\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}%
-\def\loggingall{%
- \tracingstats2
- \tracingpages1
- \tracinglostchars2 % 2 gives us more in etex
- \tracingparagraphs1
- \tracingoutput1
- \tracingmacros2
- \tracingrestores1
- \showboxbreadth\maxdimen \showboxdepth\maxdimen
- \ifx\eTeXversion\thisisundefined\else % etex gives us more logging
- \tracingscantokens1
- \tracingifs1
- \tracinggroups1
- \tracingnesting2
- \tracingassigns1
- \fi
- \tracingcommands3 % 3 gives us more in etex
- \errorcontextlines16
-}%
-
-% @errormsg{MSG}. Do the index-like expansions on MSG, but if things
-% aren't perfect, it's not the end of the world, being an error message,
-% after all.
-%
-\def\errormsg{\begingroup \indexnofonts \doerrormsg}
-\def\doerrormsg#1{\errmessage{#1}}
-
-% add check for \lastpenalty to plain's definitions. If the last thing
-% we did was a \nobreak, we don't want to insert more space.
-%
-\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount
- \removelastskip\penalty-50\smallskip\fi\fi}
-\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount
- \removelastskip\penalty-100\medskip\fi\fi}
-\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount
- \removelastskip\penalty-200\bigskip\fi\fi}
-
-% Output routine
-%
-
-% For a final copy, take out the rectangles
-% that mark overfull boxes (in case you have decided
-% that the text looks ok even though it passes the margin).
-%
-\def\finalout{\overfullrule=0pt }
-
-\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines
-\newdimen\topandbottommargin \topandbottommargin=.75in
-
-% Output a mark which sets \thischapter, \thissection and \thiscolor.
-% We dump everything together because we only have one kind of mark.
-% This works because we only use \botmark / \topmark, not \firstmark.
-%
-% A mark contains a subexpression of the \ifcase ... \fi construct.
-% \get*marks macros below extract the needed part using \ifcase.
-%
-% Another complication is to let the user choose whether \thischapter
-% (\thissection) refers to the chapter (section) in effect at the top
-% of a page, or that at the bottom of a page.
-
-% \domark is called twice inside \chapmacro, to add one
-% mark before the section break, and one after.
-% In the second call \prevchapterdefs is the same as \currentchapterdefs,
-% and \prevsectiondefs is the same as \currentsectiondefs.
-% Then if the page is not broken at the mark, some of the previous
-% section appears on the page, and we can get the name of this section
-% from \firstmark for @everyheadingmarks top.
-% @everyheadingmarks bottom uses \botmark.
-%
-% See page 260 of The TeXbook.
-\def\domark{%
- \toks0=\expandafter{\currentchapterdefs}%
- \toks2=\expandafter{\currentsectiondefs}%
- \toks4=\expandafter{\prevchapterdefs}%
- \toks6=\expandafter{\prevsectiondefs}%
- \toks8=\expandafter{\currentcolordefs}%
- \mark{%
- \the\toks0 \the\toks2 % 0: marks for @everyheadingmarks top
- \noexpand\or \the\toks4 \the\toks6 % 1: for @everyheadingmarks bottom
- \noexpand\else \the\toks8 % 2: color marks
- }%
-}
-
-% \gettopheadingmarks, \getbottomheadingmarks,
-% \getcolormarks - extract needed part of mark.
-%
-% \topmark doesn't work for the very first chapter (after the title
-% page or the contents), so we use \firstmark there -- this gets us
-% the mark with the chapter defs, unless the user sneaks in, e.g.,
-% @setcolor (or @url, or @link, etc.) between @contents and the very
-% first @chapter.
-\def\gettopheadingmarks{%
- \ifcase0\the\savedtopmark\fi
- \ifx\thischapter\empty \ifcase0\firstmark\fi \fi
-}
-\def\getbottomheadingmarks{\ifcase1\botmark\fi}
-\def\getcolormarks{\ifcase2\the\savedtopmark\fi}
-
-% Avoid "undefined control sequence" errors.
-\def\currentchapterdefs{}
-\def\currentsectiondefs{}
-\def\currentsection{}
-\def\prevchapterdefs{}
-\def\prevsectiondefs{}
-\def\currentcolordefs{}
-
-% Margin to add to right of even pages, to left of odd pages.
-\newdimen\bindingoffset
-\newdimen\normaloffset
-\newdimen\txipagewidth \newdimen\txipageheight
-
-% Main output routine.
-%
-\chardef\PAGE = 255
-\newtoks\defaultoutput
-\defaultoutput = {\savetopmark\onepageout{\pagecontents\PAGE}}
-\output=\expandafter{\the\defaultoutput}
-
-\newbox\headlinebox
-\newbox\footlinebox
-
-% When outputting the double column layout for indices, an output routine
-% is run several times, which hides the original value of \topmark. This
-% can lead to a page heading being output and duplicating the chapter heading
-% of the index. Hence, save the contents of \topmark at the beginning of
-% the output routine. The saved contents are valid until we actually
-% \shipout a page.
-%
-% (We used to run a short output routine to actually set \topmark and
-% \firstmark to the right values, but if this was called with an empty page
-% containing whatsits for writing index entries, the whatsits would be thrown
-% away and the index auxiliary file would remain empty.)
-%
-\newtoks\savedtopmark
-\newif\iftopmarksaved
-\topmarksavedtrue
-\def\savetopmark{%
- \iftopmarksaved\else
- \global\savedtopmark=\expandafter{\topmark}%
- \global\topmarksavedtrue
- \fi
-}
-
-% \onepageout takes a vbox as an argument.
-% \shipout a vbox for a single page, adding an optional header, footer
-% and footnote. This also causes index entries for this page to be written
-% to the auxiliary files.
-%
-\def\onepageout#1{%
- \hoffset=\normaloffset
- %
- \ifodd\pageno \advance\hoffset by \bindingoffset
- \else \advance\hoffset by -\bindingoffset\fi
- %
- % Retrieve the information for the headings from the marks in the page,
- % and call Plain TeX's \makeheadline and \makefootline, which use the
- % values in \headline and \footline.
- %
- % This is used to check if we are on the first page of a chapter.
- \ifcase1\the\savedtopmark\fi
- \let\prevchaptername\thischaptername
- \ifcase0\firstmark\fi
- \let\curchaptername\thischaptername
- %
- \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi
- %
- \ifx\curchaptername\prevchaptername
- \let\thischapterheading\thischapter
- \else
- % \thischapterheading is the same as \thischapter except it is blank
- % for the first page of a chapter. This is to prevent the chapter name
- % being shown twice.
- \def\thischapterheading{}%
- \fi
- %
- % Common context changes for both heading and footing.
- % Do this outside of the \shipout so @code etc. will be expanded in
- % the headline as they should be, not taken literally (outputting ''code).
- \def\commonheadfootline{\let\hsize=\txipagewidth \texinfochars}
- %
- \global\setbox\headlinebox = \vbox{\commonheadfootline \makeheadline}%
- %
- \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi
- \global\setbox\footlinebox = \vbox{\commonheadfootline \makefootline}%
- %
- {%
- % Set context for writing to auxiliary files like index files.
- % Have to do this stuff outside the \shipout because we want it to
- % take effect in \write's, yet the group defined by the \vbox ends
- % before the \shipout runs.
- %
- \atdummies % don't expand commands in the output.
- \turnoffactive
- \shipout\vbox{%
- % Do this early so pdf references go to the beginning of the page.
- \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi
- %
- \unvbox\headlinebox
- \pagebody{#1}%
- \ifdim\ht\footlinebox > 0pt
- % Only leave this space if the footline is nonempty.
- % (We lessened \vsize for it in \oddfootingyyy.)
- % The \baselineskip=24pt in plain's \makefootline has no effect.
- \vskip 24pt
- \unvbox\footlinebox
- \fi
- %
- }%
- }%
- \global\topmarksavedfalse
- \advancepageno
- \ifnum\outputpenalty>-20000 \else\dosupereject\fi
-}
-
-\newinsert\margin \dimen\margin=\maxdimen
-
-% Main part of page, including any footnotes
-\def\pagebody#1{\vbox to\txipageheight{\boxmaxdepth=\maxdepth #1}}
-{\catcode`\@ =11
-\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi
-% marginal hacks, juha@viisa.uucp (Juha Takala)
-\ifvoid\margin\else % marginal info is present
- \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi
-\dimen@=\dp#1\relax \unvbox#1\relax
-\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi
-\ifr@ggedbottom \kern-\dimen@ \vfil \fi}
-}
-
-
-% Argument parsing
-
-% Parse an argument, then pass it to #1. The argument is the rest of
-% the input line (except we remove a trailing comment). #1 should be a
-% macro which expects an ordinary undelimited TeX argument.
-% For example, \def\foo{\parsearg\fooxxx}.
-%
-\def\parsearg{\parseargusing{}}
-\def\parseargusing#1#2{%
- \def\argtorun{#2}%
- \begingroup
- \obeylines
- \spaceisspace
- #1%
- \parseargline\empty% Insert the \empty token, see \finishparsearg below.
-}
-
-{\obeylines %
- \gdef\parseargline#1^^M{%
- \endgroup % End of the group started in \parsearg.
- \argremovecomment #1\comment\ArgTerm%
- }%
-}
-
-% First remove any @comment, then any @c comment. Pass the result on to
-% \argcheckspaces.
-\def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm}
-\def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm}
-
-% Each occurrence of `\^^M' or `<space>\^^M' is replaced by a single space.
-%
-% \argremovec might leave us with trailing space, e.g.,
-% @end itemize @c foo
-% This space token undergoes the same procedure and is eventually removed
-% by \finishparsearg.
-%
-\def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M}
-\def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M}
-\def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{%
- \def\temp{#3}%
- \ifx\temp\empty
- % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp:
- \let\temp\finishparsearg
- \else
- \let\temp\argcheckspaces
- \fi
- % Put the space token in:
- \temp#1 #3\ArgTerm
-}
-
-% If a _delimited_ argument is enclosed in braces, they get stripped; so
-% to get _exactly_ the rest of the line, we had to prevent such situation.
-% We prepended an \empty token at the very beginning and we expand it now,
-% just before passing the control to \argtorun.
-% (Similarly, we have to think about #3 of \argcheckspacesY above: it is
-% either the null string, or it ends with \^^M---thus there is no danger
-% that a pair of braces would be stripped.
-%
-% But first, we have to remove the trailing space token.
-%
-\def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}}
-
-
-% \parseargdef - define a command taking an argument on the line
-%
-% \parseargdef\foo{...}
-% is roughly equivalent to
-% \def\foo{\parsearg\Xfoo}
-% \def\Xfoo#1{...}
-\def\parseargdef#1{%
- \expandafter \doparseargdef \csname\string#1\endcsname #1%
-}
-\def\doparseargdef#1#2{%
- \def#2{\parsearg#1}%
- \def#1##1%
-}
-
-% Several utility definitions with active space:
-{
- \obeyspaces
- \gdef\obeyedspace{ }
-
- % Make each space character in the input produce a normal interword
- % space in the output. Don't allow a line break at this space, as this
- % is used only in environments like @example, where each line of input
- % should produce a line of output anyway.
- %
- \gdef\sepspaces{\obeyspaces\let =\tie}
-
- % If an index command is used in an @example environment, any spaces
- % therein should become regular spaces in the raw index file, not the
- % expansion of \tie (\leavevmode \penalty \@M \ ).
- \gdef\unsepspaces{\let =\space}
-}
-
-
-\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next}
-
-% Define the framework for environments in texinfo.tex. It's used like this:
-%
-% \envdef\foo{...}
-% \def\Efoo{...}
-%
-% It's the responsibility of \envdef to insert \begingroup before the
-% actual body; @end closes the group after calling \Efoo. \envdef also
-% defines \thisenv, so the current environment is known; @end checks
-% whether the environment name matches. The \checkenv macro can also be
-% used to check whether the current environment is the one expected.
-%
-% Non-false conditionals (@iftex, @ifset) don't fit into this, so they
-% are not treated as environments; they don't open a group. (The
-% implementation of @end takes care not to call \endgroup in this
-% special case.)
-
-
-% At run-time, environments start with this:
-\def\startenvironment#1{\begingroup\def\thisenv{#1}}
-% initialize
-\let\thisenv\empty
-
-% ... but they get defined via ``\envdef\foo{...}'':
-\long\def\envdef#1#2{\def#1{\startenvironment#1#2}}
-\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}}
-
-% Check whether we're in the right environment:
-\def\checkenv#1{%
- \def\temp{#1}%
- \ifx\thisenv\temp
- \else
- \badenverr
- \fi
-}
-
-% Environment mismatch, #1 expected:
-\def\badenverr{%
- \errhelp = \EMsimple
- \errmessage{This command can appear only \inenvironment\temp,
- not \inenvironment\thisenv}%
-}
-\def\inenvironment#1{%
- \ifx#1\empty
- outside of any environment%
- \else
- in environment \expandafter\string#1%
- \fi
-}
-
-% @end foo executes the definition of \Efoo.
-% But first, it executes a specialized version of \checkenv
-%
-\parseargdef\end{%
- \if 1\csname iscond.#1\endcsname
- \else
- % The general wording of \badenverr may not be ideal.
- \expandafter\checkenv\csname#1\endcsname
- \csname E#1\endcsname
- \endgroup
- \fi
-}
-
-\newhelp\EMsimple{Press RETURN to continue.}
-
-
-% Be sure we're in horizontal mode when doing a tie, since we make space
-% equivalent to this in @example-like environments. Otherwise, a space
-% at the beginning of a line will start with \penalty -- and
-% since \penalty is valid in vertical mode, we'd end up putting the
-% penalty on the vertical list instead of in the new paragraph.
-{\catcode`@ = 11
- % Avoid using \@M directly, because that causes trouble
- % if the definition is written into an index file.
- \global\let\tiepenalty = \@M
- \gdef\tie{\leavevmode\penalty\tiepenalty\ }
-}
-
-% @: forces normal size whitespace following.
-\def\:{\spacefactor=1000 }
-
-% @* forces a line break.
-\def\*{\unskip\hfil\break\hbox{}\ignorespaces}
-
-% @/ allows a line break.
-\let\/=\allowbreak
-
-% @. is an end-of-sentence period.
-\def\.{.\spacefactor=\endofsentencespacefactor\space}
-
-% @! is an end-of-sentence bang.
-\def\!{!\spacefactor=\endofsentencespacefactor\space}
-
-% @? is an end-of-sentence query.
-\def\?{?\spacefactor=\endofsentencespacefactor\space}
-
-% @frenchspacing on|off says whether to put extra space after punctuation.
-%
-\def\onword{on}
-\def\offword{off}
-%
-\parseargdef\frenchspacing{%
- \def\temp{#1}%
- \ifx\temp\onword \plainfrenchspacing
- \else\ifx\temp\offword \plainnonfrenchspacing
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @frenchspacing option `\temp', must be on|off}%
- \fi\fi
-}
-
-% @w prevents a word break. Without the \leavevmode, @w at the
-% beginning of a paragraph, when TeX is still in vertical mode, would
-% produce a whole line of output instead of starting the paragraph.
-\def\w#1{\leavevmode\hbox{#1}}
-
-% @group ... @end group forces ... to be all on one page, by enclosing
-% it in a TeX vbox. We use \vtop instead of \vbox to construct the box
-% to keep its height that of a normal line. According to the rules for
-% \topskip (p.114 of the TeXbook), the glue inserted is
-% max (\topskip - \ht (first item), 0). If that height is large,
-% therefore, no glue is inserted, and the space between the headline and
-% the text is small, which looks bad.
-%
-% Another complication is that the group might be very large. This can
-% cause the glue on the previous page to be unduly stretched, because it
-% does not have much material. In this case, it's better to add an
-% explicit \vfill so that the extra space is at the bottom. The
-% threshold for doing this is if the group is more than \vfilllimit
-% percent of a page (\vfilllimit can be changed inside of @tex).
-%
-\newbox\groupbox
-\def\vfilllimit{0.7}
-%
-\envdef\group{%
- \ifnum\catcode`\^^M=\active \else
- \errhelp = \groupinvalidhelp
- \errmessage{@group invalid in context where filling is enabled}%
- \fi
- \startsavinginserts
- %
- \setbox\groupbox = \vtop\bgroup
- % Do @comment since we are called inside an environment such as
- % @example, where each end-of-line in the input causes an
- % end-of-line in the output. We don't want the end-of-line after
- % the `@group' to put extra space in the output. Since @group
- % should appear on a line by itself (according to the Texinfo
- % manual), we don't worry about eating any user text.
- \comment
-}
-%
-% The \vtop produces a box with normal height and large depth; thus, TeX puts
-% \baselineskip glue before it, and (when the next line of text is done)
-% \lineskip glue after it. Thus, space below is not quite equal to space
-% above. But it's pretty close.
-\def\Egroup{%
- % To get correct interline space between the last line of the group
- % and the first line afterwards, we have to propagate \prevdepth.
- \endgraf % Not \par, as it may have been set to \lisppar.
- \global\dimen1 = \prevdepth
- \egroup % End the \vtop.
- \addgroupbox
- \prevdepth = \dimen1
- \checkinserts
-}
-
-\def\addgroupbox{
- % \dimen0 is the vertical size of the group's box.
- \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox
- % \dimen2 is how much space is left on the page (more or less).
- \dimen2 = \txipageheight \advance\dimen2 by -\pagetotal
- % if the group doesn't fit on the current page, and it's a big big
- % group, force a page break.
- \ifdim \dimen0 > \dimen2
- \ifdim \pagetotal < \vfilllimit\txipageheight
- \page
- \fi
- \fi
- \box\groupbox
-}
-
-%
-% TeX puts in an \escapechar (i.e., `@') at the beginning of the help
-% message, so this ends up printing `@group can only ...'.
-%
-\newhelp\groupinvalidhelp{%
-group can only be used in environments such as @example,^^J%
-where each line of input produces a line of output.}
-
-% @need space-in-mils
-% forces a page break if there is not space-in-mils remaining.
-
-\newdimen\mil \mil=0.001in
-
-\parseargdef\need{%
- % Ensure vertical mode, so we don't make a big box in the middle of a
- % paragraph.
- \par
- %
- % If the @need value is less than one line space, it's useless.
- \dimen0 = #1\mil
- \dimen2 = \ht\strutbox
- \advance\dimen2 by \dp\strutbox
- \ifdim\dimen0 > \dimen2
- %
- % Do a \strut just to make the height of this box be normal, so the
- % normal leading is inserted relative to the preceding line.
- % And a page break here is fine.
- \vtop to #1\mil{\strut\vfil}%
- %
- % TeX does not even consider page breaks if a penalty added to the
- % main vertical list is 10000 or more. But in order to see if the
- % empty box we just added fits on the page, we must make it consider
- % page breaks. On the other hand, we don't want to actually break the
- % page after the empty box. So we use a penalty of 9999.
- %
- % There is an extremely small chance that TeX will actually break the
- % page at this \penalty, if there are no other feasible breakpoints in
- % sight. (If the user is using lots of big @group commands, which
- % almost-but-not-quite fill up a page, TeX will have a hard time doing
- % good page breaking, for example.) However, I could not construct an
- % example where a page broke at this \penalty; if it happens in a real
- % document, then we can reconsider our strategy.
- \penalty9999
- %
- % Back up by the size of the box, whether we did a page break or not.
- \kern -#1\mil
- %
- % Do not allow a page break right after this kern.
- \nobreak
- \fi
-}
-
-% @br forces paragraph break (and is undocumented).
-
-\let\br = \par
-
-% @page forces the start of a new page.
-%
-\def\page{\par\vfill\supereject}
-
-% @exdent text....
-% outputs text on separate line in roman font, starting at standard page margin
-
-% This records the amount of indent in the innermost environment.
-% That's how much \exdent should take out.
-\newskip\exdentamount
-
-% This defn is used inside fill environments such as @defun.
-\parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break}
-
-% This defn is used inside nofill environments such as @example.
-\parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount
- \leftline{\hskip\leftskip{\rm#1}}}}
-
-% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current
-% paragraph. For more general purposes, use the \margin insertion
-% class. WHICH is `l' or `r'. Not documented, written for gawk manual.
-%
-\newskip\inmarginspacing \inmarginspacing=1cm
-\def\strutdepth{\dp\strutbox}
-%
-\def\doinmargin#1#2{\strut\vadjust{%
- \nobreak
- \kern-\strutdepth
- \vtop to \strutdepth{%
- \baselineskip=\strutdepth
- \vss
- % if you have multiple lines of stuff to put here, you'll need to
- % make the vbox yourself of the appropriate size.
- \ifx#1l%
- \llap{\ignorespaces #2\hskip\inmarginspacing}%
- \else
- \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}%
- \fi
- \null
- }%
-}}
-\def\inleftmargin{\doinmargin l}
-\def\inrightmargin{\doinmargin r}
-%
-% @inmargin{TEXT [, RIGHT-TEXT]}
-% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right;
-% else use TEXT for both).
-%
-\def\inmargin#1{\parseinmargin #1,,\finish}
-\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing.
- \setbox0 = \hbox{\ignorespaces #2}%
- \ifdim\wd0 > 0pt
- \def\lefttext{#1}% have both texts
- \def\righttext{#2}%
- \else
- \def\lefttext{#1}% have only one text
- \def\righttext{#1}%
- \fi
- %
- \ifodd\pageno
- \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin
- \else
- \def\temp{\inleftmargin\lefttext}%
- \fi
- \temp
-}
-
-% @include FILE -- \input text of FILE.
-%
-\def\include{\parseargusing\filenamecatcodes\includezzz}
-\def\includezzz#1{%
- \pushthisfilestack
- \def\thisfile{#1}%
- {%
- \makevalueexpandable % we want to expand any @value in FILE.
- \turnoffactive % and allow special characters in the expansion
- \indexnofonts % Allow `@@' and other weird things in file names.
- \wlog{texinfo.tex: doing @include of #1^^J}%
- \edef\temp{\noexpand\input #1 }%
- %
- % This trickery is to read FILE outside of a group, in case it makes
- % definitions, etc.
- \expandafter
- }\temp
- \popthisfilestack
-}
-\def\filenamecatcodes{%
- \catcode`\\=\other
- \catcode`~=\other
- \catcode`^=\other
- \catcode`_=\other
- \catcode`|=\other
- \catcode`<=\other
- \catcode`>=\other
- \catcode`+=\other
- \catcode`-=\other
- \catcode`\`=\other
- \catcode`\'=\other
-}
-
-\def\pushthisfilestack{%
- \expandafter\pushthisfilestackX\popthisfilestack\StackTerm
-}
-\def\pushthisfilestackX{%
- \expandafter\pushthisfilestackY\thisfile\StackTerm
-}
-\def\pushthisfilestackY #1\StackTerm #2\StackTerm {%
- \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}%
-}
-
-\def\popthisfilestack{\errthisfilestackempty}
-\def\errthisfilestackempty{\errmessage{Internal error:
- the stack of filenames is empty.}}
-%
-\def\thisfile{}
-
-% @center line
-% outputs that line, centered.
-%
-\parseargdef\center{%
- \ifhmode
- \let\centersub\centerH
- \else
- \let\centersub\centerV
- \fi
- \centersub{\hfil \ignorespaces#1\unskip \hfil}%
- \let\centersub\relax % don't let the definition persist, just in case
-}
-\def\centerH#1{{%
- \hfil\break
- \advance\hsize by -\leftskip
- \advance\hsize by -\rightskip
- \line{#1}%
- \break
-}}
-%
-\newcount\centerpenalty
-\def\centerV#1{%
- % The idea here is the same as in \startdefun, \cartouche, etc.: if
- % @center is the first thing after a section heading, we need to wipe
- % out the negative parskip inserted by \sectionheading, but still
- % prevent a page break here.
- \centerpenalty = \lastpenalty
- \ifnum\centerpenalty>10000 \vskip\parskip \fi
- \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi
- \line{\kern\leftskip #1\kern\rightskip}%
-}
-
-% @sp n outputs n lines of vertical space
-%
-\parseargdef\sp{\vskip #1\baselineskip}
-
-% @comment ...line which is ignored...
-% @c is the same as @comment
-% @ignore ... @end ignore is another way to write a comment
-
-
-\def\c{\begingroup \catcode`\^^M=\active%
-\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other%
-\cxxx}
-{\catcode`\^^M=\active \gdef\cxxx#1^^M{\endgroup}}
-%
-\let\comment\c
-
-% @paragraphindent NCHARS
-% We'll use ems for NCHARS, close enough.
-% NCHARS can also be the word `asis' or `none'.
-% We cannot feasibly implement @paragraphindent asis, though.
-%
-\def\asisword{asis} % no translation, these are keywords
-\def\noneword{none}
-%
-\parseargdef\paragraphindent{%
- \def\temp{#1}%
- \ifx\temp\asisword
- \else
- \ifx\temp\noneword
- \defaultparindent = 0pt
- \else
- \defaultparindent = #1em
- \fi
- \fi
- \parindent = \defaultparindent
-}
-
-% @exampleindent NCHARS
-% We'll use ems for NCHARS like @paragraphindent.
-% It seems @exampleindent asis isn't necessary, but
-% I preserve it to make it similar to @paragraphindent.
-\parseargdef\exampleindent{%
- \def\temp{#1}%
- \ifx\temp\asisword
- \else
- \ifx\temp\noneword
- \lispnarrowing = 0pt
- \else
- \lispnarrowing = #1em
- \fi
- \fi
-}
-
-% @firstparagraphindent WORD
-% If WORD is `none', then suppress indentation of the first paragraph
-% after a section heading. If WORD is `insert', then do indent at such
-% paragraphs.
-%
-% The paragraph indentation is suppressed or not by calling
-% \suppressfirstparagraphindent, which the sectioning commands do.
-% We switch the definition of this back and forth according to WORD.
-% By default, we suppress indentation.
-%
-\def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent}
-\def\insertword{insert}
-%
-\parseargdef\firstparagraphindent{%
- \def\temp{#1}%
- \ifx\temp\noneword
- \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent
- \else\ifx\temp\insertword
- \let\suppressfirstparagraphindent = \relax
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @firstparagraphindent option `\temp'}%
- \fi\fi
-}
-
-% Here is how we actually suppress indentation. Redefine \everypar to
-% \kern backwards by \parindent, and then reset itself to empty.
-%
-% We also make \indent itself not actually do anything until the next
-% paragraph.
-%
-\gdef\dosuppressfirstparagraphindent{%
- \gdef\indent {\restorefirstparagraphindent \indent}%
- \gdef\noindent{\restorefirstparagraphindent \noindent}%
- \global\everypar = {\kern -\parindent \restorefirstparagraphindent}%
-}
-%
-\gdef\restorefirstparagraphindent{%
- \global\let\indent = \ptexindent
- \global\let\noindent = \ptexnoindent
- \global\everypar = {}%
-}
-
-
-% @refill is a no-op.
-\let\refill=\relax
-
-% @setfilename INFO-FILENAME - ignored
-\let\setfilename=\comment
-
-% @bye.
-\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend}
-
-
-\message{pdf,}
-% adobe `portable' document format
-\newcount\tempnum
-\newcount\lnkcount
-\newtoks\filename
-\newcount\filenamelength
-\newcount\pgn
-\newtoks\toksA
-\newtoks\toksB
-\newtoks\toksC
-\newtoks\toksD
-\newbox\boxA
-\newbox\boxB
-\newcount\countA
-\newif\ifpdf
-\newif\ifpdfmakepagedest
-
-%
-% For LuaTeX
-%
-
-\newif\iftxiuseunicodedestname
-\txiuseunicodedestnamefalse % For pdfTeX etc.
-
-\ifx\luatexversion\thisisundefined
-\else
- % Use Unicode destination names
- \txiuseunicodedestnametrue
- % Escape PDF strings with converting UTF-16 from UTF-8
- \begingroup
- \catcode`\%=12
- \directlua{
- function UTF16oct(str)
- tex.sprint(string.char(0x5c) .. '376' .. string.char(0x5c) .. '377')
- for c in string.utfvalues(str) do
- if c < 0x10000 then
- tex.sprint(
- string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
- string.char(0x5c) .. string.char(0x25) .. '03o',
- math.floor(c / 256), math.floor(c % 256)))
- else
- c = c - 0x10000
- local c_hi = c / 1024 + 0xd800
- local c_lo = c % 1024 + 0xdc00
- tex.sprint(
- string.format(string.char(0x5c) .. string.char(0x25) .. '03o' ..
- string.char(0x5c) .. string.char(0x25) .. '03o' ..
- string.char(0x5c) .. string.char(0x25) .. '03o' ..
- string.char(0x5c) .. string.char(0x25) .. '03o',
- math.floor(c_hi / 256), math.floor(c_hi % 256),
- math.floor(c_lo / 256), math.floor(c_lo % 256)))
- end
- end
- end
- }
- \endgroup
- \def\pdfescapestrutfsixteen#1{\directlua{UTF16oct('\luaescapestring{#1}')}}
- % Escape PDF strings without converting
- \begingroup
- \directlua{
- function PDFescstr(str)
- for c in string.bytes(str) do
- if c <= 0x20 or c >= 0x80 or c == 0x28 or c == 0x29 or c == 0x5c then
- tex.sprint(-2,
- string.format(string.char(0x5c) .. string.char(0x25) .. '03o',
- c))
- else
- tex.sprint(-2, string.char(c))
- end
- end
- end
- }
- % The -2 in the arguments here gives all the input to TeX catcode 12
- % (other) or 10 (space), preventing undefined control sequence errors. See
- % https://lists.gnu.org/archive/html/bug-texinfo/2019-08/msg00031.html
- %
- \endgroup
- \def\pdfescapestring#1{\directlua{PDFescstr('\luaescapestring{#1}')}}
- \ifnum\luatexversion>84
- % For LuaTeX >= 0.85
- \def\pdfdest{\pdfextension dest}
- \let\pdfoutput\outputmode
- \def\pdfliteral{\pdfextension literal}
- \def\pdfcatalog{\pdfextension catalog}
- \def\pdftexversion{\numexpr\pdffeedback version\relax}
- \let\pdfximage\saveimageresource
- \let\pdfrefximage\useimageresource
- \let\pdflastximage\lastsavedimageresourceindex
- \def\pdfendlink{\pdfextension endlink\relax}
- \def\pdfoutline{\pdfextension outline}
- \def\pdfstartlink{\pdfextension startlink}
- \def\pdffontattr{\pdfextension fontattr}
- \def\pdfobj{\pdfextension obj}
- \def\pdflastobj{\numexpr\pdffeedback lastobj\relax}
- \let\pdfpagewidth\pagewidth
- \let\pdfpageheight\pageheight
- \edef\pdfhorigin{\pdfvariable horigin}
- \edef\pdfvorigin{\pdfvariable vorigin}
- \fi
-\fi
-
-% when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1
-% can be set). So we test for \relax and 0 as well as being undefined.
-\ifx\pdfoutput\thisisundefined
-\else
- \ifx\pdfoutput\relax
- \else
- \ifcase\pdfoutput
- \else
- \pdftrue
- \fi
- \fi
-\fi
-
-\newif\ifpdforxetex
-\pdforxetexfalse
-\ifpdf
- \pdforxetextrue
-\fi
-\ifx\XeTeXrevision\thisisundefined\else
- \pdforxetextrue
-\fi
-
-
-% PDF uses PostScript string constants for the names of xref targets,
-% for display in the outlines, and in other places. Thus, we have to
-% double any backslashes. Otherwise, a name like "\node" will be
-% interpreted as a newline (\n), followed by o, d, e. Not good.
-%
-% See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and
-% related messages. The final outcome is that it is up to the TeX user
-% to double the backslashes and otherwise make the string valid, so
-% that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to
-% do this reliably, so we use it.
-
-% #1 is a control sequence in which to do the replacements,
-% which we \xdef.
-\def\txiescapepdf#1{%
- \ifx\pdfescapestring\thisisundefined
- % No primitive available; should we give a warning or log?
- % Many times it won't matter.
- \xdef#1{#1}%
- \else
- % The expandable \pdfescapestring primitive escapes parentheses,
- % backslashes, and other special chars.
- \xdef#1{\pdfescapestring{#1}}%
- \fi
-}
-\def\txiescapepdfutfsixteen#1{%
- \ifx\pdfescapestrutfsixteen\thisisundefined
- % No UTF-16 converting macro available.
- \txiescapepdf{#1}%
- \else
- \xdef#1{\pdfescapestrutfsixteen{#1}}%
- \fi
-}
-
-\newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images
-with PDF output, and none of those formats could be found. (.eps cannot
-be supported due to the design of the PDF format; use regular TeX (DVI
-output) for that.)}
-
-\ifpdf
- %
- % Color manipulation macros using ideas from pdfcolor.tex,
- % except using rgb instead of cmyk; the latter is said to render as a
- % very dark gray on-screen and a very dark halftone in print, instead
- % of actual black. The dark red here is dark enough to print on paper as
- % nearly black, but still distinguishable for online viewing. We use
- % black by default, though.
- \def\rgbDarkRed{0.50 0.09 0.12}
- \def\rgbBlack{0 0 0}
- %
- % rg sets the color for filling (usual text, etc.);
- % RG sets the color for stroking (thin rules, e.g., normal _'s).
- \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}}
- %
- % Set color, and create a mark which defines \thiscolor accordingly,
- % so that \makeheadline knows which color to restore.
- \def\setcolor#1{%
- \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
- \domark
- \pdfsetcolor{#1}%
- }
- %
- \def\maincolor{\rgbBlack}
- \pdfsetcolor{\maincolor}
- \edef\thiscolor{\maincolor}
- \def\currentcolordefs{}
- %
- \def\makefootline{%
- \baselineskip24pt
- \line{\pdfsetcolor{\maincolor}\the\footline}%
- }
- %
- \def\makeheadline{%
- \vbox to 0pt{%
- \vskip-22.5pt
- \line{%
- \vbox to8.5pt{}%
- % Extract \thiscolor definition from the marks.
- \getcolormarks
- % Typeset the headline with \maincolor, then restore the color.
- \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
- }%
- \vss
- }%
- \nointerlineskip
- }
- %
- %
- \pdfcatalog{/PageMode /UseOutlines}
- %
- % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
- \def\dopdfimage#1#2#3{%
- \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
- \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
- %
- % pdftex (and the PDF format) support .pdf, .png, .jpg (among
- % others). Let's try in that order, PDF first since if
- % someone has a scalable image, presumably better to use that than a
- % bitmap.
- \let\pdfimgext=\empty
- \begingroup
- \openin 1 #1.pdf \ifeof 1
- \openin 1 #1.PDF \ifeof 1
- \openin 1 #1.png \ifeof 1
- \openin 1 #1.jpg \ifeof 1
- \openin 1 #1.jpeg \ifeof 1
- \openin 1 #1.JPG \ifeof 1
- \errhelp = \nopdfimagehelp
- \errmessage{Could not find image file #1 for pdf}%
- \else \gdef\pdfimgext{JPG}%
- \fi
- \else \gdef\pdfimgext{jpeg}%
- \fi
- \else \gdef\pdfimgext{jpg}%
- \fi
- \else \gdef\pdfimgext{png}%
- \fi
- \else \gdef\pdfimgext{PDF}%
- \fi
- \else \gdef\pdfimgext{pdf}%
- \fi
- \closein 1
- \endgroup
- %
- % without \immediate, ancient pdftex seg faults when the same image is
- % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.)
- \ifnum\pdftexversion < 14
- \immediate\pdfimage
- \else
- \immediate\pdfximage
- \fi
- \ifdim \wd0 >0pt width \pdfimagewidth \fi
- \ifdim \wd2 >0pt height \pdfimageheight \fi
- \ifnum\pdftexversion<13
- #1.\pdfimgext
- \else
- {#1.\pdfimgext}%
- \fi
- \ifnum\pdftexversion < 14 \else
- \pdfrefximage \pdflastximage
- \fi}
- %
- \def\setpdfdestname#1{{%
- % We have to set dummies so commands such as @code, and characters
- % such as \, aren't expanded when present in a section title.
- \indexnofonts
- \makevalueexpandable
- \turnoffactive
- \iftxiuseunicodedestname
- \ifx \declaredencoding \latone
- % Pass through Latin-1 characters.
- % LuaTeX with byte wise I/O converts Latin-1 characters to Unicode.
- \else
- \ifx \declaredencoding \utfeight
- % Pass through Unicode characters.
- \else
- % Use ASCII approximations in destination names.
- \passthroughcharsfalse
- \fi
- \fi
- \else
- % Use ASCII approximations in destination names.
- \passthroughcharsfalse
- \fi
- \def\pdfdestname{#1}%
- \txiescapepdf\pdfdestname
- }}
- %
- \def\setpdfoutlinetext#1{{%
- \indexnofonts
- \makevalueexpandable
- \turnoffactive
- \ifx \declaredencoding \latone
- % The PDF format can use an extended form of Latin-1 in bookmark
- % strings. See Appendix D of the PDF Reference, Sixth Edition, for
- % the "PDFDocEncoding".
- \passthroughcharstrue
- % Pass through Latin-1 characters.
- % LuaTeX: Convert to Unicode
- % pdfTeX: Use Latin-1 as PDFDocEncoding
- \def\pdfoutlinetext{#1}%
- \else
- \ifx \declaredencoding \utfeight
- \ifx\luatexversion\thisisundefined
- % For pdfTeX with UTF-8.
- % TODO: the PDF format can use UTF-16 in bookmark strings,
- % but the code for this isn't done yet.
- % Use ASCII approximations.
- \passthroughcharsfalse
- \def\pdfoutlinetext{#1}%
- \else
- % For LuaTeX with UTF-8.
- % Pass through Unicode characters for title texts.
- \passthroughcharstrue
- \def\pdfoutlinetext{#1}%
- \fi
- \else
- % For non-Latin-1 or non-UTF-8 encodings.
- % Use ASCII approximations.
- \passthroughcharsfalse
- \def\pdfoutlinetext{#1}%
- \fi
- \fi
- % LuaTeX: Convert to UTF-16
- % pdfTeX: Use Latin-1 as PDFDocEncoding
- \txiescapepdfutfsixteen\pdfoutlinetext
- }}
- %
- \def\pdfmkdest#1{%
- \setpdfdestname{#1}%
- \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
- }
- %
- % used to mark target names; must be expandable.
- \def\pdfmkpgn#1{#1}
- %
- % by default, use black for everything.
- \def\urlcolor{\rgbBlack}
- \def\linkcolor{\rgbBlack}
- \def\endlink{\setcolor{\maincolor}\pdfendlink}
- %
- % Adding outlines to PDF; macros for calculating structure of outlines
- % come from Petr Olsak
- \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0%
- \else \csname#1\endcsname \fi}
- \def\advancenumber#1{\tempnum=\expnumber{#1}\relax
- \advance\tempnum by 1
- \expandafter\xdef\csname#1\endcsname{\the\tempnum}}
- %
- % #1 is the section text, which is what will be displayed in the
- % outline by the pdf viewer. #2 is the pdf expression for the number
- % of subentries (or empty, for subsubsections). #3 is the node text,
- % which might be empty if this toc entry had no corresponding node.
- % #4 is the page number
- %
- \def\dopdfoutline#1#2#3#4{%
- % Generate a link to the node text if that exists; else, use the
- % page number. We could generate a destination for the section
- % text in the case where a section has no node, but it doesn't
- % seem worth the trouble, since most documents are normally structured.
- \setpdfoutlinetext{#1}
- \setpdfdestname{#3}
- \ifx\pdfdestname\empty
- \def\pdfdestname{#4}%
- \fi
- %
- \pdfoutline goto name{\pdfmkpgn{\pdfdestname}}#2{\pdfoutlinetext}%
- }
- %
- \def\pdfmakeoutlines{%
- \begingroup
- % Read toc silently, to get counts of subentries for \pdfoutline.
- \def\partentry##1##2##3##4{}% ignore parts in the outlines
- \def\numchapentry##1##2##3##4{%
- \def\thischapnum{##2}%
- \def\thissecnum{0}%
- \def\thissubsecnum{0}%
- }%
- \def\numsecentry##1##2##3##4{%
- \advancenumber{chap\thischapnum}%
- \def\thissecnum{##2}%
- \def\thissubsecnum{0}%
- }%
- \def\numsubsecentry##1##2##3##4{%
- \advancenumber{sec\thissecnum}%
- \def\thissubsecnum{##2}%
- }%
- \def\numsubsubsecentry##1##2##3##4{%
- \advancenumber{subsec\thissubsecnum}%
- }%
- \def\thischapnum{0}%
- \def\thissecnum{0}%
- \def\thissubsecnum{0}%
- %
- % use \def rather than \let here because we redefine \chapentry et
- % al. a second time, below.
- \def\appentry{\numchapentry}%
- \def\appsecentry{\numsecentry}%
- \def\appsubsecentry{\numsubsecentry}%
- \def\appsubsubsecentry{\numsubsubsecentry}%
- \def\unnchapentry{\numchapentry}%
- \def\unnsecentry{\numsecentry}%
- \def\unnsubsecentry{\numsubsecentry}%
- \def\unnsubsubsecentry{\numsubsubsecentry}%
- \readdatafile{toc}%
- %
- % Read toc second time, this time actually producing the outlines.
- % The `-' means take the \expnumber as the absolute number of
- % subentries, which we calculated on our first read of the .toc above.
- %
- % We use the node names as the destinations.
- \def\numchapentry##1##2##3##4{%
- \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}%
- \def\numsecentry##1##2##3##4{%
- \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}%
- \def\numsubsecentry##1##2##3##4{%
- \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}%
- \def\numsubsubsecentry##1##2##3##4{% count is always zero
- \dopdfoutline{##1}{}{##3}{##4}}%
- %
- % PDF outlines are displayed using system fonts, instead of
- % document fonts. Therefore we cannot use special characters,
- % since the encoding is unknown. For example, the eogonek from
- % Latin 2 (0xea) gets translated to a | character. Info from
- % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100.
- %
- % TODO this right, we have to translate 8-bit characters to
- % their "best" equivalent, based on the @documentencoding. Too
- % much work for too little return. Just use the ASCII equivalents
- % we use for the index sort strings.
- %
- \indexnofonts
- \setupdatafile
- % We can have normal brace characters in the PDF outlines, unlike
- % Texinfo index files. So set that up.
- \def\{{\lbracecharliteral}%
- \def\}{\rbracecharliteral}%
- \catcode`\\=\active \otherbackslash
- \input \tocreadfilename
- \endgroup
- }
- {\catcode`[=1 \catcode`]=2
- \catcode`{=\other \catcode`}=\other
- \gdef\lbracecharliteral[{]%
- \gdef\rbracecharliteral[}]%
- ]
- %
- \def\skipspaces#1{\def\PP{#1}\def\D{|}%
- \ifx\PP\D\let\nextsp\relax
- \else\let\nextsp\skipspaces
- \addtokens{\filename}{\PP}%
- \advance\filenamelength by 1
- \fi
- \nextsp}
- \def\getfilename#1{%
- \filenamelength=0
- % If we don't expand the argument now, \skipspaces will get
- % snagged on things like "@value{foo}".
- \edef\temp{#1}%
- \expandafter\skipspaces\temp|\relax
- }
- \ifnum\pdftexversion < 14
- \let \startlink \pdfannotlink
- \else
- \let \startlink \pdfstartlink
- \fi
- % make a live url in pdf output.
- \def\pdfurl#1{%
- \begingroup
- % it seems we really need yet another set of dummies; have not
- % tried to figure out what each command should do in the context
- % of @url. for now, just make @/ a no-op, that's the only one
- % people have actually reported a problem with.
- %
- \normalturnoffactive
- \def\@{@}%
- \let\/=\empty
- \makevalueexpandable
- % do we want to go so far as to use \indexnofonts instead of just
- % special-casing \var here?
- \def\var##1{##1}%
- %
- \leavevmode\setcolor{\urlcolor}%
- \startlink attr{/Border [0 0 0]}%
- user{/Subtype /Link /A << /S /URI /URI (#1) >>}%
- \endgroup}
- % \pdfgettoks - Surround page numbers in #1 with @pdflink. #1 may
- % be a simple number, or a list of numbers in the case of an index
- % entry.
- \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
- \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
- \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
- \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
- \def\maketoks{%
- \expandafter\poptoks\the\toksA|ENDTOKS|\relax
- \ifx\first0\adn0
- \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
- \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
- \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
- \else
- \ifnum0=\countA\else\makelink\fi
- \ifx\first.\let\next=\done\else
- \let\next=\maketoks
- \addtokens{\toksB}{\the\toksD}
- \ifx\first,\addtokens{\toksB}{\space}\fi
- \fi
- \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
- \next}
- \def\makelink{\addtokens{\toksB}%
- {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
- \def\pdflink#1{%
- \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}}
- \setcolor{\linkcolor}#1\endlink}
- \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
-\else
- % non-pdf mode
- \let\pdfmkdest = \gobble
- \let\pdfurl = \gobble
- \let\endlink = \relax
- \let\setcolor = \gobble
- \let\pdfsetcolor = \gobble
- \let\pdfmakeoutlines = \relax
-\fi % \ifx\pdfoutput
-
-%
-% For XeTeX
-%
-\ifx\XeTeXrevision\thisisundefined
-\else
- %
- % XeTeX version check
- %
- \ifnum\strcmp{\the\XeTeXversion\XeTeXrevision}{0.99996}>-1
- % TeX Live 2016 contains XeTeX 0.99996 and xdvipdfmx 20160307.
- % It can use the `dvipdfmx:config' special (from TeX Live SVN r40941).
- % For avoiding PDF destination name replacement, we use this special
- % instead of xdvipdfmx's command line option `-C 0x0010'.
- \special{dvipdfmx:config C 0x0010}
- % XeTeX 0.99995+ comes with xdvipdfmx 20160307+.
- % It can handle Unicode destination names for PDF.
- \txiuseunicodedestnametrue
- \else
- % XeTeX < 0.99996 (TeX Live < 2016) cannot use the
- % `dvipdfmx:config' special.
- % So for avoiding PDF destination name replacement,
- % xdvipdfmx's command line option `-C 0x0010' is necessary.
- %
- % XeTeX < 0.99995 can not handle Unicode destination names for PDF
- % because xdvipdfmx 20150315 has a UTF-16 conversion issue.
- % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
- \txiuseunicodedestnamefalse
- \fi
- %
- % Color support
- %
- \def\rgbDarkRed{0.50 0.09 0.12}
- \def\rgbBlack{0 0 0}
- %
- \def\pdfsetcolor#1{\special{pdf:scolor [#1]}}
- %
- % Set color, and create a mark which defines \thiscolor accordingly,
- % so that \makeheadline knows which color to restore.
- \def\setcolor#1{%
- \xdef\currentcolordefs{\gdef\noexpand\thiscolor{#1}}%
- \domark
- \pdfsetcolor{#1}%
- }
- %
- \def\maincolor{\rgbBlack}
- \pdfsetcolor{\maincolor}
- \edef\thiscolor{\maincolor}
- \def\currentcolordefs{}
- %
- \def\makefootline{%
- \baselineskip24pt
- \line{\pdfsetcolor{\maincolor}\the\footline}%
- }
- %
- \def\makeheadline{%
- \vbox to 0pt{%
- \vskip-22.5pt
- \line{%
- \vbox to8.5pt{}%
- % Extract \thiscolor definition from the marks.
- \getcolormarks
- % Typeset the headline with \maincolor, then restore the color.
- \pdfsetcolor{\maincolor}\the\headline\pdfsetcolor{\thiscolor}%
- }%
- \vss
- }%
- \nointerlineskip
- }
- %
- % PDF outline support
- %
- % Emulate pdfTeX primitive
- \def\pdfdest name#1 xyz{%
- \special{pdf:dest (#1) [@thispage /XYZ @xpos @ypos null]}%
- }
- %
- \def\setpdfdestname#1{{%
- % We have to set dummies so commands such as @code, and characters
- % such as \, aren't expanded when present in a section title.
- \indexnofonts
- \makevalueexpandable
- \turnoffactive
- \iftxiuseunicodedestname
- % Pass through Unicode characters.
- \else
- % Use ASCII approximations in destination names.
- \passthroughcharsfalse
- \fi
- \def\pdfdestname{#1}%
- \txiescapepdf\pdfdestname
- }}
- %
- \def\setpdfoutlinetext#1{{%
- \turnoffactive
- % Always use Unicode characters in title texts.
- \def\pdfoutlinetext{#1}%
- % For XeTeX, xdvipdfmx converts to UTF-16.
- % So we do not convert.
- \txiescapepdf\pdfoutlinetext
- }}
- %
- \def\pdfmkdest#1{%
- \setpdfdestname{#1}%
- \safewhatsit{\pdfdest name{\pdfdestname} xyz}%
- }
- %
- % by default, use black for everything.
- \def\urlcolor{\rgbBlack}
- \def\linkcolor{\rgbBlack}
- \def\endlink{\setcolor{\maincolor}\pdfendlink}
- %
- \def\dopdfoutline#1#2#3#4{%
- \setpdfoutlinetext{#1}
- \setpdfdestname{#3}
- \ifx\pdfdestname\empty
- \def\pdfdestname{#4}%
- \fi
- %
- \special{pdf:out [-] #2 << /Title (\pdfoutlinetext) /A
- << /S /GoTo /D (\pdfdestname) >> >> }%
- }
- %
- \def\pdfmakeoutlines{%
- \begingroup
- %
- % For XeTeX, counts of subentries are not necessary.
- % Therefore, we read toc only once.
- %
- % We use node names as destinations.
- \def\partentry##1##2##3##4{}% ignore parts in the outlines
- \def\numchapentry##1##2##3##4{%
- \dopdfoutline{##1}{1}{##3}{##4}}%
- \def\numsecentry##1##2##3##4{%
- \dopdfoutline{##1}{2}{##3}{##4}}%
- \def\numsubsecentry##1##2##3##4{%
- \dopdfoutline{##1}{3}{##3}{##4}}%
- \def\numsubsubsecentry##1##2##3##4{%
- \dopdfoutline{##1}{4}{##3}{##4}}%
- %
- \let\appentry\numchapentry%
- \let\appsecentry\numsecentry%
- \let\appsubsecentry\numsubsecentry%
- \let\appsubsubsecentry\numsubsubsecentry%
- \let\unnchapentry\numchapentry%
- \let\unnsecentry\numsecentry%
- \let\unnsubsecentry\numsubsecentry%
- \let\unnsubsubsecentry\numsubsubsecentry%
- %
- % For XeTeX, xdvipdfmx converts strings to UTF-16.
- % Therefore, the encoding and the language may not be considered.
- %
- \indexnofonts
- \setupdatafile
- % We can have normal brace characters in the PDF outlines, unlike
- % Texinfo index files. So set that up.
- \def\{{\lbracecharliteral}%
- \def\}{\rbracecharliteral}%
- \catcode`\\=\active \otherbackslash
- \input \tocreadfilename
- \endgroup
- }
- {\catcode`[=1 \catcode`]=2
- \catcode`{=\other \catcode`}=\other
- \gdef\lbracecharliteral[{]%
- \gdef\rbracecharliteral[}]%
- ]
-
- \special{pdf:docview << /PageMode /UseOutlines >> }
- % ``\special{pdf:tounicode ...}'' is not necessary
- % because xdvipdfmx converts strings from UTF-8 to UTF-16 without it.
- % However, due to a UTF-16 conversion issue of xdvipdfmx 20150315,
- % ``\special{pdf:dest ...}'' cannot handle non-ASCII strings.
- % It is fixed by xdvipdfmx 20160106 (TeX Live SVN r39753).
-%
- \def\skipspaces#1{\def\PP{#1}\def\D{|}%
- \ifx\PP\D\let\nextsp\relax
- \else\let\nextsp\skipspaces
- \addtokens{\filename}{\PP}%
- \advance\filenamelength by 1
- \fi
- \nextsp}
- \def\getfilename#1{%
- \filenamelength=0
- % If we don't expand the argument now, \skipspaces will get
- % snagged on things like "@value{foo}".
- \edef\temp{#1}%
- \expandafter\skipspaces\temp|\relax
- }
- % make a live url in pdf output.
- \def\pdfurl#1{%
- \begingroup
- % it seems we really need yet another set of dummies; have not
- % tried to figure out what each command should do in the context
- % of @url. for now, just make @/ a no-op, that's the only one
- % people have actually reported a problem with.
- %
- \normalturnoffactive
- \def\@{@}%
- \let\/=\empty
- \makevalueexpandable
- % do we want to go so far as to use \indexnofonts instead of just
- % special-casing \var here?
- \def\var##1{##1}%
- %
- \leavevmode\setcolor{\urlcolor}%
- \special{pdf:bann << /Border [0 0 0]
- /Subtype /Link /A << /S /URI /URI (#1) >> >>}%
- \endgroup}
- \def\endlink{\setcolor{\maincolor}\special{pdf:eann}}
- \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}}
- \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks}
- \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks}
- \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}}
- \def\maketoks{%
- \expandafter\poptoks\the\toksA|ENDTOKS|\relax
- \ifx\first0\adn0
- \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3
- \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6
- \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9
- \else
- \ifnum0=\countA\else\makelink\fi
- \ifx\first.\let\next=\done\else
- \let\next=\maketoks
- \addtokens{\toksB}{\the\toksD}
- \ifx\first,\addtokens{\toksB}{\space}\fi
- \fi
- \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
- \next}
- \def\makelink{\addtokens{\toksB}%
- {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0}
- \def\pdflink#1{%
- \special{pdf:bann << /Border [0 0 0]
- /Type /Annot /Subtype /Link /A << /S /GoTo /D (#1) >> >>}%
- \setcolor{\linkcolor}#1\endlink}
- \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st}
-%
- %
- % @image support
- %
- % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto).
- \def\doxeteximage#1#2#3{%
- \def\xeteximagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}%
- \def\xeteximageheight{#3}\setbox2 = \hbox{\ignorespaces #3}%
- %
- % XeTeX (and the PDF format) supports .pdf, .png, .jpg (among
- % others). Let's try in that order, PDF first since if
- % someone has a scalable image, presumably better to use that than a
- % bitmap.
- \let\xeteximgext=\empty
- \begingroup
- \openin 1 #1.pdf \ifeof 1
- \openin 1 #1.PDF \ifeof 1
- \openin 1 #1.png \ifeof 1
- \openin 1 #1.jpg \ifeof 1
- \openin 1 #1.jpeg \ifeof 1
- \openin 1 #1.JPG \ifeof 1
- \errmessage{Could not find image file #1 for XeTeX}%
- \else \gdef\xeteximgext{JPG}%
- \fi
- \else \gdef\xeteximgext{jpeg}%
- \fi
- \else \gdef\xeteximgext{jpg}%
- \fi
- \else \gdef\xeteximgext{png}%
- \fi
- \else \gdef\xeteximgext{PDF}%
- \fi
- \else \gdef\xeteximgext{pdf}%
- \fi
- \closein 1
- \endgroup
- %
- \def\xetexpdfext{pdf}%
- \ifx\xeteximgext\xetexpdfext
- \XeTeXpdffile "#1".\xeteximgext ""
- \else
- \def\xetexpdfext{PDF}%
- \ifx\xeteximgext\xetexpdfext
- \XeTeXpdffile "#1".\xeteximgext ""
- \else
- \XeTeXpicfile "#1".\xeteximgext ""
- \fi
- \fi
- \ifdim \wd0 >0pt width \xeteximagewidth \fi
- \ifdim \wd2 >0pt height \xeteximageheight \fi \relax
- }
-\fi
-
-
-%
-\message{fonts,}
-
-% Set the baselineskip to #1, and the lineskip and strut size
-% correspondingly. There is no deep meaning behind these magic numbers
-% used as factors; they just match (closely enough) what Knuth defined.
-%
-\def\lineskipfactor{.08333}
-\def\strutheightpercent{.70833}
-\def\strutdepthpercent {.29167}
-%
-% can get a sort of poor man's double spacing by redefining this.
-\def\baselinefactor{1}
-%
-\newdimen\textleading
-\def\setleading#1{%
- \dimen0 = #1\relax
- \normalbaselineskip = \baselinefactor\dimen0
- \normallineskip = \lineskipfactor\normalbaselineskip
- \normalbaselines
- \setbox\strutbox =\hbox{%
- \vrule width0pt height\strutheightpercent\baselineskip
- depth \strutdepthpercent \baselineskip
- }%
-}
-
-% PDF CMaps. See also LaTeX's t1.cmap.
-%
-% do nothing with this by default.
-\expandafter\let\csname cmapOT1\endcsname\gobble
-\expandafter\let\csname cmapOT1IT\endcsname\gobble
-\expandafter\let\csname cmapOT1TT\endcsname\gobble
-
-% if we are producing pdf, and we have \pdffontattr, then define cmaps.
-% (\pdffontattr was introduced many years ago, but people still run
-% older pdftex's; it's easy to conditionalize, so we do.)
-\ifpdf \ifx\pdffontattr\thisisundefined \else
- \begingroup
- \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
- \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
-%%DocumentNeededResources: ProcSet (CIDInit)
-%%IncludeResource: ProcSet (CIDInit)
-%%BeginResource: CMap (TeX-OT1-0)
-%%Title: (TeX-OT1-0 TeX OT1 0)
-%%Version: 1.000
-%%EndComments
-/CIDInit /ProcSet findresource begin
-12 dict begin
-begincmap
-/CIDSystemInfo
-<< /Registry (TeX)
-/Ordering (OT1)
-/Supplement 0
->> def
-/CMapName /TeX-OT1-0 def
-/CMapType 2 def
-1 begincodespacerange
-<00> <7F>
-endcodespacerange
-8 beginbfrange
-<00> <01> <0393>
-<09> <0A> <03A8>
-<23> <26> <0023>
-<28> <3B> <0028>
-<3F> <5B> <003F>
-<5D> <5E> <005D>
-<61> <7A> <0061>
-<7B> <7C> <2013>
-endbfrange
-40 beginbfchar
-<02> <0398>
-<03> <039B>
-<04> <039E>
-<05> <03A0>
-<06> <03A3>
-<07> <03D2>
-<08> <03A6>
-<0B> <00660066>
-<0C> <00660069>
-<0D> <0066006C>
-<0E> <006600660069>
-<0F> <00660066006C>
-<10> <0131>
-<11> <0237>
-<12> <0060>
-<13> <00B4>
-<14> <02C7>
-<15> <02D8>
-<16> <00AF>
-<17> <02DA>
-<18> <00B8>
-<19> <00DF>
-<1A> <00E6>
-<1B> <0153>
-<1C> <00F8>
-<1D> <00C6>
-<1E> <0152>
-<1F> <00D8>
-<21> <0021>
-<22> <201D>
-<27> <2019>
-<3C> <00A1>
-<3D> <003D>
-<3E> <00BF>
-<5C> <201C>
-<5F> <02D9>
-<60> <2018>
-<7D> <02DD>
-<7E> <007E>
-<7F> <00A8>
-endbfchar
-endcmap
-CMapName currentdict /CMap defineresource pop
-end
-end
-%%EndResource
-%%EOF
- }\endgroup
- \expandafter\edef\csname cmapOT1\endcsname#1{%
- \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
- }%
-%
-% \cmapOT1IT
- \begingroup
- \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
- \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
-%%DocumentNeededResources: ProcSet (CIDInit)
-%%IncludeResource: ProcSet (CIDInit)
-%%BeginResource: CMap (TeX-OT1IT-0)
-%%Title: (TeX-OT1IT-0 TeX OT1IT 0)
-%%Version: 1.000
-%%EndComments
-/CIDInit /ProcSet findresource begin
-12 dict begin
-begincmap
-/CIDSystemInfo
-<< /Registry (TeX)
-/Ordering (OT1IT)
-/Supplement 0
->> def
-/CMapName /TeX-OT1IT-0 def
-/CMapType 2 def
-1 begincodespacerange
-<00> <7F>
-endcodespacerange
-8 beginbfrange
-<00> <01> <0393>
-<09> <0A> <03A8>
-<25> <26> <0025>
-<28> <3B> <0028>
-<3F> <5B> <003F>
-<5D> <5E> <005D>
-<61> <7A> <0061>
-<7B> <7C> <2013>
-endbfrange
-42 beginbfchar
-<02> <0398>
-<03> <039B>
-<04> <039E>
-<05> <03A0>
-<06> <03A3>
-<07> <03D2>
-<08> <03A6>
-<0B> <00660066>
-<0C> <00660069>
-<0D> <0066006C>
-<0E> <006600660069>
-<0F> <00660066006C>
-<10> <0131>
-<11> <0237>
-<12> <0060>
-<13> <00B4>
-<14> <02C7>
-<15> <02D8>
-<16> <00AF>
-<17> <02DA>
-<18> <00B8>
-<19> <00DF>
-<1A> <00E6>
-<1B> <0153>
-<1C> <00F8>
-<1D> <00C6>
-<1E> <0152>
-<1F> <00D8>
-<21> <0021>
-<22> <201D>
-<23> <0023>
-<24> <00A3>
-<27> <2019>
-<3C> <00A1>
-<3D> <003D>
-<3E> <00BF>
-<5C> <201C>
-<5F> <02D9>
-<60> <2018>
-<7D> <02DD>
-<7E> <007E>
-<7F> <00A8>
-endbfchar
-endcmap
-CMapName currentdict /CMap defineresource pop
-end
-end
-%%EndResource
-%%EOF
- }\endgroup
- \expandafter\edef\csname cmapOT1IT\endcsname#1{%
- \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
- }%
-%
-% \cmapOT1TT
- \begingroup
- \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char.
- \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap
-%%DocumentNeededResources: ProcSet (CIDInit)
-%%IncludeResource: ProcSet (CIDInit)
-%%BeginResource: CMap (TeX-OT1TT-0)
-%%Title: (TeX-OT1TT-0 TeX OT1TT 0)
-%%Version: 1.000
-%%EndComments
-/CIDInit /ProcSet findresource begin
-12 dict begin
-begincmap
-/CIDSystemInfo
-<< /Registry (TeX)
-/Ordering (OT1TT)
-/Supplement 0
->> def
-/CMapName /TeX-OT1TT-0 def
-/CMapType 2 def
-1 begincodespacerange
-<00> <7F>
-endcodespacerange
-5 beginbfrange
-<00> <01> <0393>
-<09> <0A> <03A8>
-<21> <26> <0021>
-<28> <5F> <0028>
-<61> <7E> <0061>
-endbfrange
-32 beginbfchar
-<02> <0398>
-<03> <039B>
-<04> <039E>
-<05> <03A0>
-<06> <03A3>
-<07> <03D2>
-<08> <03A6>
-<0B> <2191>
-<0C> <2193>
-<0D> <0027>
-<0E> <00A1>
-<0F> <00BF>
-<10> <0131>
-<11> <0237>
-<12> <0060>
-<13> <00B4>
-<14> <02C7>
-<15> <02D8>
-<16> <00AF>
-<17> <02DA>
-<18> <00B8>
-<19> <00DF>
-<1A> <00E6>
-<1B> <0153>
-<1C> <00F8>
-<1D> <00C6>
-<1E> <0152>
-<1F> <00D8>
-<20> <2423>
-<27> <2019>
-<60> <2018>
-<7F> <00A8>
-endbfchar
-endcmap
-CMapName currentdict /CMap defineresource pop
-end
-end
-%%EndResource
-%%EOF
- }\endgroup
- \expandafter\edef\csname cmapOT1TT\endcsname#1{%
- \pdffontattr#1{/ToUnicode \the\pdflastobj\space 0 R}%
- }%
-\fi\fi
-
-
-% Set the font macro #1 to the font named \fontprefix#2.
-% #3 is the font's design size, #4 is a scale factor, #5 is the CMap
-% encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit).
-% Example:
-% #1 = \textrm
-% #2 = \rmshape
-% #3 = 10
-% #4 = \mainmagstep
-% #5 = OT1
-%
-\def\setfont#1#2#3#4#5{%
- \font#1=\fontprefix#2#3 scaled #4
- \csname cmap#5\endcsname#1%
-}
-% This is what gets called when #5 of \setfont is empty.
-\let\cmap\gobble
-%
-% (end of cmaps)
-
-% Use cm as the default font prefix.
-% To specify the font prefix, you must define \fontprefix
-% before you read in texinfo.tex.
-\ifx\fontprefix\thisisundefined
-\def\fontprefix{cm}
-\fi
-% Support font families that don't use the same naming scheme as CM.
-\def\rmshape{r}
-\def\rmbshape{bx} % where the normal face is bold
-\def\bfshape{b}
-\def\bxshape{bx}
-\def\ttshape{tt}
-\def\ttbshape{tt}
-\def\ttslshape{sltt}
-\def\itshape{ti}
-\def\itbshape{bxti}
-\def\slshape{sl}
-\def\slbshape{bxsl}
-\def\sfshape{ss}
-\def\sfbshape{ss}
-\def\scshape{csc}
-\def\scbshape{csc}
-
-% Definitions for a main text size of 11pt. (The default in Texinfo.)
-%
-\def\definetextfontsizexi{%
-% Text fonts (11.2pt, magstep1).
-\def\textnominalsize{11pt}
-\edef\mainmagstep{\magstephalf}
-\setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
-\setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
-\setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
-\setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
-\setfont\textsl\slshape{10}{\mainmagstep}{OT1}
-\setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
-\setfont\textsc\scshape{10}{\mainmagstep}{OT1}
-\setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
-\font\texti=cmmi10 scaled \mainmagstep
-\font\textsy=cmsy10 scaled \mainmagstep
-\def\textecsize{1095}
-
-% A few fonts for @defun names and args.
-\setfont\defbf\bfshape{10}{\magstep1}{OT1}
-\setfont\deftt\ttshape{10}{\magstep1}{OT1TT}
-\setfont\defsl\slshape{10}{\magstep1}{OT1}
-\setfont\defttsl\ttslshape{10}{\magstep1}{OT1TT}
-\def\df{\let\ttfont=\deftt \let\bffont = \defbf
-\let\ttslfont=\defttsl \let\slfont=\defsl \bf}
-
-% Fonts for indices, footnotes, small examples (9pt).
-\def\smallnominalsize{9pt}
-\setfont\smallrm\rmshape{9}{1000}{OT1}
-\setfont\smalltt\ttshape{9}{1000}{OT1TT}
-\setfont\smallbf\bfshape{10}{900}{OT1}
-\setfont\smallit\itshape{9}{1000}{OT1IT}
-\setfont\smallsl\slshape{9}{1000}{OT1}
-\setfont\smallsf\sfshape{9}{1000}{OT1}
-\setfont\smallsc\scshape{10}{900}{OT1}
-\setfont\smallttsl\ttslshape{10}{900}{OT1TT}
-\font\smalli=cmmi9
-\font\smallsy=cmsy9
-\def\smallecsize{0900}
-
-% Fonts for small examples (8pt).
-\def\smallernominalsize{8pt}
-\setfont\smallerrm\rmshape{8}{1000}{OT1}
-\setfont\smallertt\ttshape{8}{1000}{OT1TT}
-\setfont\smallerbf\bfshape{10}{800}{OT1}
-\setfont\smallerit\itshape{8}{1000}{OT1IT}
-\setfont\smallersl\slshape{8}{1000}{OT1}
-\setfont\smallersf\sfshape{8}{1000}{OT1}
-\setfont\smallersc\scshape{10}{800}{OT1}
-\setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
-\font\smalleri=cmmi8
-\font\smallersy=cmsy8
-\def\smallerecsize{0800}
-
-% Fonts for math mode superscripts (7pt).
-\def\sevennominalsize{7pt}
-\setfont\sevenrm\rmshape{7}{1000}{OT1}
-\setfont\seventt\ttshape{10}{700}{OT1TT}
-\setfont\sevenbf\bfshape{10}{700}{OT1}
-\setfont\sevenit\itshape{7}{1000}{OT1IT}
-\setfont\sevensl\slshape{10}{700}{OT1}
-\setfont\sevensf\sfshape{10}{700}{OT1}
-\setfont\sevensc\scshape{10}{700}{OT1}
-\setfont\seventtsl\ttslshape{10}{700}{OT1TT}
-\font\seveni=cmmi7
-\font\sevensy=cmsy7
-\def\sevenecsize{0700}
-
-% Fonts for title page (20.4pt):
-\def\titlenominalsize{20pt}
-\setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
-\setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
-\setfont\titlesl\slbshape{10}{\magstep4}{OT1}
-\setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
-\setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
-\setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
-\let\titlebf=\titlerm
-\setfont\titlesc\scbshape{10}{\magstep4}{OT1}
-\font\titlei=cmmi12 scaled \magstep3
-\font\titlesy=cmsy10 scaled \magstep4
-\def\titleecsize{2074}
-
-% Chapter (and unnumbered) fonts (17.28pt).
-\def\chapnominalsize{17pt}
-\setfont\chaprm\rmbshape{12}{\magstep2}{OT1}
-\setfont\chapit\itbshape{10}{\magstep3}{OT1IT}
-\setfont\chapsl\slbshape{10}{\magstep3}{OT1}
-\setfont\chaptt\ttbshape{12}{\magstep2}{OT1TT}
-\setfont\chapttsl\ttslshape{10}{\magstep3}{OT1TT}
-\setfont\chapsf\sfbshape{17}{1000}{OT1}
-\let\chapbf=\chaprm
-\setfont\chapsc\scbshape{10}{\magstep3}{OT1}
-\font\chapi=cmmi12 scaled \magstep2
-\font\chapsy=cmsy10 scaled \magstep3
-\def\chapecsize{1728}
-
-% Section fonts (14.4pt).
-\def\secnominalsize{14pt}
-\setfont\secrm\rmbshape{12}{\magstep1}{OT1}
-\setfont\secrmnotbold\rmshape{12}{\magstep1}{OT1}
-\setfont\secit\itbshape{10}{\magstep2}{OT1IT}
-\setfont\secsl\slbshape{10}{\magstep2}{OT1}
-\setfont\sectt\ttbshape{12}{\magstep1}{OT1TT}
-\setfont\secttsl\ttslshape{10}{\magstep2}{OT1TT}
-\setfont\secsf\sfbshape{12}{\magstep1}{OT1}
-\let\secbf\secrm
-\setfont\secsc\scbshape{10}{\magstep2}{OT1}
-\font\seci=cmmi12 scaled \magstep1
-\font\secsy=cmsy10 scaled \magstep2
-\def\sececsize{1440}
-
-% Subsection fonts (13.15pt).
-\def\ssecnominalsize{13pt}
-\setfont\ssecrm\rmbshape{12}{\magstephalf}{OT1}
-\setfont\ssecit\itbshape{10}{1315}{OT1IT}
-\setfont\ssecsl\slbshape{10}{1315}{OT1}
-\setfont\ssectt\ttbshape{12}{\magstephalf}{OT1TT}
-\setfont\ssecttsl\ttslshape{10}{1315}{OT1TT}
-\setfont\ssecsf\sfbshape{12}{\magstephalf}{OT1}
-\let\ssecbf\ssecrm
-\setfont\ssecsc\scbshape{10}{1315}{OT1}
-\font\sseci=cmmi12 scaled \magstephalf
-\font\ssecsy=cmsy10 scaled 1315
-\def\ssececsize{1200}
-
-% Reduced fonts for @acronym in text (10pt).
-\def\reducednominalsize{10pt}
-\setfont\reducedrm\rmshape{10}{1000}{OT1}
-\setfont\reducedtt\ttshape{10}{1000}{OT1TT}
-\setfont\reducedbf\bfshape{10}{1000}{OT1}
-\setfont\reducedit\itshape{10}{1000}{OT1IT}
-\setfont\reducedsl\slshape{10}{1000}{OT1}
-\setfont\reducedsf\sfshape{10}{1000}{OT1}
-\setfont\reducedsc\scshape{10}{1000}{OT1}
-\setfont\reducedttsl\ttslshape{10}{1000}{OT1TT}
-\font\reducedi=cmmi10
-\font\reducedsy=cmsy10
-\def\reducedecsize{1000}
-
-\textleading = 13.2pt % line spacing for 11pt CM
-\textfonts % reset the current fonts
-\rm
-} % end of 11pt text font size definitions, \definetextfontsizexi
-
-
-% Definitions to make the main text be 10pt Computer Modern, with
-% section, chapter, etc., sizes following suit. This is for the GNU
-% Press printing of the Emacs 22 manual. Maybe other manuals in the
-% future. Used with @smallbook, which sets the leading to 12pt.
-%
-\def\definetextfontsizex{%
-% Text fonts (10pt).
-\def\textnominalsize{10pt}
-\edef\mainmagstep{1000}
-\setfont\textrm\rmshape{10}{\mainmagstep}{OT1}
-\setfont\texttt\ttshape{10}{\mainmagstep}{OT1TT}
-\setfont\textbf\bfshape{10}{\mainmagstep}{OT1}
-\setfont\textit\itshape{10}{\mainmagstep}{OT1IT}
-\setfont\textsl\slshape{10}{\mainmagstep}{OT1}
-\setfont\textsf\sfshape{10}{\mainmagstep}{OT1}
-\setfont\textsc\scshape{10}{\mainmagstep}{OT1}
-\setfont\textttsl\ttslshape{10}{\mainmagstep}{OT1TT}
-\font\texti=cmmi10 scaled \mainmagstep
-\font\textsy=cmsy10 scaled \mainmagstep
-\def\textecsize{1000}
-
-% A few fonts for @defun names and args.
-\setfont\defbf\bfshape{10}{\magstephalf}{OT1}
-\setfont\deftt\ttshape{10}{\magstephalf}{OT1TT}
-\setfont\defsl\slshape{10}{\magstephalf}{OT1}
-\setfont\defttsl\ttslshape{10}{\magstephalf}{OT1TT}
-\def\df{\let\ttfont=\deftt \let\bffont = \defbf
-\let\slfont=\defsl \let\ttslfont=\defttsl \bf}
-
-% Fonts for indices, footnotes, small examples (9pt).
-\def\smallnominalsize{9pt}
-\setfont\smallrm\rmshape{9}{1000}{OT1}
-\setfont\smalltt\ttshape{9}{1000}{OT1TT}
-\setfont\smallbf\bfshape{10}{900}{OT1}
-\setfont\smallit\itshape{9}{1000}{OT1IT}
-\setfont\smallsl\slshape{9}{1000}{OT1}
-\setfont\smallsf\sfshape{9}{1000}{OT1}
-\setfont\smallsc\scshape{10}{900}{OT1}
-\setfont\smallttsl\ttslshape{10}{900}{OT1TT}
-\font\smalli=cmmi9
-\font\smallsy=cmsy9
-\def\smallecsize{0900}
-
-% Fonts for small examples (8pt).
-\def\smallernominalsize{8pt}
-\setfont\smallerrm\rmshape{8}{1000}{OT1}
-\setfont\smallertt\ttshape{8}{1000}{OT1TT}
-\setfont\smallerbf\bfshape{10}{800}{OT1}
-\setfont\smallerit\itshape{8}{1000}{OT1IT}
-\setfont\smallersl\slshape{8}{1000}{OT1}
-\setfont\smallersf\sfshape{8}{1000}{OT1}
-\setfont\smallersc\scshape{10}{800}{OT1}
-\setfont\smallerttsl\ttslshape{10}{800}{OT1TT}
-\font\smalleri=cmmi8
-\font\smallersy=cmsy8
-\def\smallerecsize{0800}
-
-% Fonts for math mode superscripts (7pt).
-\def\sevennominalsize{7pt}
-\setfont\sevenrm\rmshape{7}{1000}{OT1}
-\setfont\seventt\ttshape{10}{700}{OT1TT}
-\setfont\sevenbf\bfshape{10}{700}{OT1}
-\setfont\sevenit\itshape{7}{1000}{OT1IT}
-\setfont\sevensl\slshape{10}{700}{OT1}
-\setfont\sevensf\sfshape{10}{700}{OT1}
-\setfont\sevensc\scshape{10}{700}{OT1}
-\setfont\seventtsl\ttslshape{10}{700}{OT1TT}
-\font\seveni=cmmi7
-\font\sevensy=cmsy7
-\def\sevenecsize{0700}
-
-% Fonts for title page (20.4pt):
-\def\titlenominalsize{20pt}
-\setfont\titlerm\rmbshape{12}{\magstep3}{OT1}
-\setfont\titleit\itbshape{10}{\magstep4}{OT1IT}
-\setfont\titlesl\slbshape{10}{\magstep4}{OT1}
-\setfont\titlett\ttbshape{12}{\magstep3}{OT1TT}
-\setfont\titlettsl\ttslshape{10}{\magstep4}{OT1TT}
-\setfont\titlesf\sfbshape{17}{\magstep1}{OT1}
-\let\titlebf=\titlerm
-\setfont\titlesc\scbshape{10}{\magstep4}{OT1}
-\font\titlei=cmmi12 scaled \magstep3
-\font\titlesy=cmsy10 scaled \magstep4
-\def\titleecsize{2074}
-
-% Chapter fonts (14.4pt).
-\def\chapnominalsize{14pt}
-\setfont\chaprm\rmbshape{12}{\magstep1}{OT1}
-\setfont\chapit\itbshape{10}{\magstep2}{OT1IT}
-\setfont\chapsl\slbshape{10}{\magstep2}{OT1}
-\setfont\chaptt\ttbshape{12}{\magstep1}{OT1TT}
-\setfont\chapttsl\ttslshape{10}{\magstep2}{OT1TT}
-\setfont\chapsf\sfbshape{12}{\magstep1}{OT1}
-\let\chapbf\chaprm
-\setfont\chapsc\scbshape{10}{\magstep2}{OT1}
-\font\chapi=cmmi12 scaled \magstep1
-\font\chapsy=cmsy10 scaled \magstep2
-\def\chapecsize{1440}
-
-% Section fonts (12pt).
-\def\secnominalsize{12pt}
-\setfont\secrm\rmbshape{12}{1000}{OT1}
-\setfont\secit\itbshape{10}{\magstep1}{OT1IT}
-\setfont\secsl\slbshape{10}{\magstep1}{OT1}
-\setfont\sectt\ttbshape{12}{1000}{OT1TT}
-\setfont\secttsl\ttslshape{10}{\magstep1}{OT1TT}
-\setfont\secsf\sfbshape{12}{1000}{OT1}
-\let\secbf\secrm
-\setfont\secsc\scbshape{10}{\magstep1}{OT1}
-\font\seci=cmmi12
-\font\secsy=cmsy10 scaled \magstep1
-\def\sececsize{1200}
-
-% Subsection fonts (10pt).
-\def\ssecnominalsize{10pt}
-\setfont\ssecrm\rmbshape{10}{1000}{OT1}
-\setfont\ssecit\itbshape{10}{1000}{OT1IT}
-\setfont\ssecsl\slbshape{10}{1000}{OT1}
-\setfont\ssectt\ttbshape{10}{1000}{OT1TT}
-\setfont\ssecttsl\ttslshape{10}{1000}{OT1TT}
-\setfont\ssecsf\sfbshape{10}{1000}{OT1}
-\let\ssecbf\ssecrm
-\setfont\ssecsc\scbshape{10}{1000}{OT1}
-\font\sseci=cmmi10
-\font\ssecsy=cmsy10
-\def\ssececsize{1000}
-
-% Reduced fonts for @acronym in text (9pt).
-\def\reducednominalsize{9pt}
-\setfont\reducedrm\rmshape{9}{1000}{OT1}
-\setfont\reducedtt\ttshape{9}{1000}{OT1TT}
-\setfont\reducedbf\bfshape{10}{900}{OT1}
-\setfont\reducedit\itshape{9}{1000}{OT1IT}
-\setfont\reducedsl\slshape{9}{1000}{OT1}
-\setfont\reducedsf\sfshape{9}{1000}{OT1}
-\setfont\reducedsc\scshape{10}{900}{OT1}
-\setfont\reducedttsl\ttslshape{10}{900}{OT1TT}
-\font\reducedi=cmmi9
-\font\reducedsy=cmsy9
-\def\reducedecsize{0900}
-
-\divide\parskip by 2 % reduce space between paragraphs
-\textleading = 12pt % line spacing for 10pt CM
-\textfonts % reset the current fonts
-\rm
-} % end of 10pt text font size definitions, \definetextfontsizex
-
-% Fonts for short table of contents.
-\setfont\shortcontrm\rmshape{12}{1000}{OT1}
-\setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12
-\setfont\shortcontsl\slshape{12}{1000}{OT1}
-\setfont\shortconttt\ttshape{12}{1000}{OT1TT}
-
-
-% We provide the user-level command
-% @fonttextsize 10
-% (or 11) to redefine the text font size. pt is assumed.
-%
-\def\xiword{11}
-\def\xword{10}
-\def\xwordpt{10pt}
-%
-\parseargdef\fonttextsize{%
- \def\textsizearg{#1}%
- %\wlog{doing @fonttextsize \textsizearg}%
- %
- % Set \globaldefs so that documents can use this inside @tex, since
- % makeinfo 4.8 does not support it, but we need it nonetheless.
- %
- \begingroup \globaldefs=1
- \ifx\textsizearg\xword \definetextfontsizex
- \else \ifx\textsizearg\xiword \definetextfontsizexi
- \else
- \errhelp=\EMsimple
- \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'}
- \fi\fi
- \endgroup
-}
-
-%
-% Change the current font style to #1, remembering it in \curfontstyle.
-% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in
-% italics, not bold italics.
-%
-\def\setfontstyle#1{%
- \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd.
- \csname #1font\endcsname % change the current font
-}
-
-\def\rm{\fam=0 \setfontstyle{rm}}
-\def\it{\fam=\itfam \setfontstyle{it}}
-\def\sl{\fam=\slfam \setfontstyle{sl}}
-\def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf}
-\def\tt{\fam=\ttfam \setfontstyle{tt}}
-
-% Texinfo sort of supports the sans serif font style, which plain TeX does not.
-% So we set up a \sf.
-\newfam\sffam
-\def\sf{\fam=\sffam \setfontstyle{sf}}
-
-% We don't need math for this font style.
-\def\ttsl{\setfontstyle{ttsl}}
-
-
-% In order for the font changes to affect most math symbols and letters,
-% we have to define the \textfont of the standard families.
-% We don't bother to reset \scriptscriptfont; awaiting user need.
-%
-\def\resetmathfonts{%
- \textfont0=\rmfont \textfont1=\ifont \textfont2=\syfont
- \textfont\itfam=\itfont \textfont\slfam=\slfont \textfont\bffam=\bffont
- \textfont\ttfam=\ttfont \textfont\sffam=\sffont
- %
- % Fonts for superscript. Note that the 7pt fonts are used regardless
- % of the current font size.
- \scriptfont0=\sevenrm \scriptfont1=\seveni \scriptfont2=\sevensy
- \scriptfont\itfam=\sevenit \scriptfont\slfam=\sevensl
- \scriptfont\bffam=\sevenbf \scriptfont\ttfam=\seventt
- \scriptfont\sffam=\sevensf
-}
-
-%
-
-% The font-changing commands (all called \...fonts) redefine the meanings
-% of \STYLEfont, instead of just \STYLE. We do this because \STYLE needs
-% to also set the current \fam for math mode. Our \STYLE (e.g., \rm)
-% commands hardwire \STYLEfont to set the current font.
-%
-% The fonts used for \ifont are for "math italics" (\itfont is for italics
-% in regular text). \syfont is also used in math mode only.
-%
-% Each font-changing command also sets the names \lsize (one size lower)
-% and \lllsize (three sizes lower). These relative commands are used
-% in, e.g., the LaTeX logo and acronyms.
-%
-% This all needs generalizing, badly.
-%
-
-\def\assignfonts#1{%
- \expandafter\let\expandafter\rmfont\csname #1rm\endcsname
- \expandafter\let\expandafter\itfont\csname #1it\endcsname
- \expandafter\let\expandafter\slfont\csname #1sl\endcsname
- \expandafter\let\expandafter\bffont\csname #1bf\endcsname
- \expandafter\let\expandafter\ttfont\csname #1tt\endcsname
- \expandafter\let\expandafter\smallcaps\csname #1sc\endcsname
- \expandafter\let\expandafter\sffont \csname #1sf\endcsname
- \expandafter\let\expandafter\ifont \csname #1i\endcsname
- \expandafter\let\expandafter\syfont \csname #1sy\endcsname
- \expandafter\let\expandafter\ttslfont\csname #1ttsl\endcsname
-}
-
-\newif\ifrmisbold
-
-% Select smaller font size with the current style. Used to change font size
-% in, e.g., the LaTeX logo and acronyms. If we are using bold fonts for
-% normal roman text, also use bold fonts for roman text in the smaller size.
-\def\switchtolllsize{%
- \expandafter\assignfonts\expandafter{\lllsize}%
- \ifrmisbold
- \let\rmfont\bffont
- \fi
- \csname\curfontstyle\endcsname
-}%
-
-\def\switchtolsize{%
- \expandafter\assignfonts\expandafter{\lsize}%
- \ifrmisbold
- \let\rmfont\bffont
- \fi
- \csname\curfontstyle\endcsname
-}%
-
-\def\definefontsetatsize#1#2#3#4#5{%
-\expandafter\def\csname #1fonts\endcsname{%
- \def\curfontsize{#1}%
- \def\lsize{#2}\def\lllsize{#3}%
- \csname rmisbold#5\endcsname
- \assignfonts{#1}%
- \resetmathfonts
- \setleading{#4}%
-}}
-
-\definefontsetatsize{text} {reduced}{smaller}{\textleading}{false}
-\definefontsetatsize{title} {chap} {subsec} {27pt} {true}
-\definefontsetatsize{chap} {sec} {text} {19pt} {true}
-\definefontsetatsize{sec} {subsec} {reduced}{17pt} {true}
-\definefontsetatsize{ssec} {text} {small} {15pt} {true}
-\definefontsetatsize{reduced}{small} {smaller}{10.5pt}{false}
-\definefontsetatsize{small} {smaller}{smaller}{10.5pt}{false}
-\definefontsetatsize{smaller}{smaller}{smaller}{9.5pt} {false}
-
-\def\titlefont#1{{\titlefonts\rm #1}}
-\let\subsecfonts = \ssecfonts
-\let\subsubsecfonts = \ssecfonts
-
-% Define these just so they can be easily changed for other fonts.
-\def\angleleft{$\langle$}
-\def\angleright{$\rangle$}
-
-% Set the fonts to use with the @small... environments.
-\let\smallexamplefonts = \smallfonts
-
-% About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample
-% can fit this many characters:
-% 8.5x11=86 smallbook=72 a4=90 a5=69
-% If we use \scriptfonts (8pt), then we can fit this many characters:
-% 8.5x11=90+ smallbook=80 a4=90+ a5=77
-% For me, subjectively, the few extra characters that fit aren't worth
-% the additional smallness of 8pt. So I'm making the default 9pt.
-%
-% By the way, for comparison, here's what fits with @example (10pt):
-% 8.5x11=71 smallbook=60 a4=75 a5=58
-% --karl, 24jan03.
-
-% Set up the default fonts, so we can use them for creating boxes.
-%
-\definetextfontsizexi
-
-
-\message{markup,}
-
-% Check if we are currently using a typewriter font. Since all the
-% Computer Modern typewriter fonts have zero interword stretch (and
-% shrink), and it is reasonable to expect all typewriter fonts to have
-% this property, we can check that font parameter.
-%
-\def\ifmonospace{\ifdim\fontdimen3\font=0pt }
-
-% Markup style infrastructure. \defmarkupstylesetup\INITMACRO will
-% define and register \INITMACRO to be called on markup style changes.
-% \INITMACRO can check \currentmarkupstyle for the innermost
-% style.
-
-\let\currentmarkupstyle\empty
-
-\def\setupmarkupstyle#1{%
- \def\currentmarkupstyle{#1}%
- \markupstylesetup
-}
-
-\let\markupstylesetup\empty
-
-\def\defmarkupstylesetup#1{%
- \expandafter\def\expandafter\markupstylesetup
- \expandafter{\markupstylesetup #1}%
- \def#1%
-}
-
-% Markup style setup for left and right quotes.
-\defmarkupstylesetup\markupsetuplq{%
- \expandafter\let\expandafter \temp
- \csname markupsetuplq\currentmarkupstyle\endcsname
- \ifx\temp\relax \markupsetuplqdefault \else \temp \fi
-}
-
-\defmarkupstylesetup\markupsetuprq{%
- \expandafter\let\expandafter \temp
- \csname markupsetuprq\currentmarkupstyle\endcsname
- \ifx\temp\relax \markupsetuprqdefault \else \temp \fi
-}
-
-{
-\catcode`\'=\active
-\catcode`\`=\active
-
-\gdef\markupsetuplqdefault{\let`\lq}
-\gdef\markupsetuprqdefault{\let'\rq}
-
-\gdef\markupsetcodequoteleft{\let`\codequoteleft}
-\gdef\markupsetcodequoteright{\let'\codequoteright}
-}
-
-\let\markupsetuplqcode \markupsetcodequoteleft
-\let\markupsetuprqcode \markupsetcodequoteright
-%
-\let\markupsetuplqexample \markupsetcodequoteleft
-\let\markupsetuprqexample \markupsetcodequoteright
-%
-\let\markupsetuplqkbd \markupsetcodequoteleft
-\let\markupsetuprqkbd \markupsetcodequoteright
-%
-\let\markupsetuplqsamp \markupsetcodequoteleft
-\let\markupsetuprqsamp \markupsetcodequoteright
-%
-\let\markupsetuplqverb \markupsetcodequoteleft
-\let\markupsetuprqverb \markupsetcodequoteright
-%
-\let\markupsetuplqverbatim \markupsetcodequoteleft
-\let\markupsetuprqverbatim \markupsetcodequoteright
-
-% Allow an option to not use regular directed right quote/apostrophe
-% (char 0x27), but instead the undirected quote from cmtt (char 0x0d).
-% The undirected quote is ugly, so don't make it the default, but it
-% works for pasting with more pdf viewers (at least evince), the
-% lilypond developers report. xpdf does work with the regular 0x27.
-%
-\def\codequoteright{%
- \ifmonospace
- \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax
- \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax
- '%
- \else \char'15 \fi
- \else \char'15 \fi
- \else
- '%
- \fi
-}
-%
-% and a similar option for the left quote char vs. a grave accent.
-% Modern fonts display ASCII 0x60 as a grave accent, so some people like
-% the code environments to do likewise.
-%
-\def\codequoteleft{%
- \ifmonospace
- \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax
- \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax
- % [Knuth] pp. 380,381,391
- % \relax disables Spanish ligatures ?` and !` of \tt font.
- \relax`%
- \else \char'22 \fi
- \else \char'22 \fi
- \else
- \relax`%
- \fi
-}
-
-% Commands to set the quote options.
-%
-\parseargdef\codequoteundirected{%
- \def\temp{#1}%
- \ifx\temp\onword
- \expandafter\let\csname SETtxicodequoteundirected\endcsname
- = t%
- \else\ifx\temp\offword
- \expandafter\let\csname SETtxicodequoteundirected\endcsname
- = \relax
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}%
- \fi\fi
-}
-%
-\parseargdef\codequotebacktick{%
- \def\temp{#1}%
- \ifx\temp\onword
- \expandafter\let\csname SETtxicodequotebacktick\endcsname
- = t%
- \else\ifx\temp\offword
- \expandafter\let\csname SETtxicodequotebacktick\endcsname
- = \relax
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}%
- \fi\fi
-}
-
-% [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font.
-\def\noligaturesquoteleft{\relax\lq}
-
-% Count depth in font-changes, for error checks
-\newcount\fontdepth \fontdepth=0
-
-% Font commands.
-
-% #1 is the font command (\sl or \it), #2 is the text to slant.
-% If we are in a monospaced environment, however, 1) always use \ttsl,
-% and 2) do not add an italic correction.
-\def\dosmartslant#1#2{%
- \ifusingtt
- {{\ttsl #2}\let\next=\relax}%
- {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}%
- \next
-}
-\def\smartslanted{\dosmartslant\sl}
-\def\smartitalic{\dosmartslant\it}
-
-% Output an italic correction unless \next (presumed to be the following
-% character) is such as not to need one.
-\def\smartitaliccorrection{%
- \ifx\next,%
- \else\ifx\next-%
- \else\ifx\next.%
- \else\ifx\next\.%
- \else\ifx\next\comma%
- \else\ptexslash
- \fi\fi\fi\fi\fi
- \aftersmartic
-}
-
-% Unconditional use \ttsl, and no ic. @var is set to this for defuns.
-\def\ttslanted#1{{\ttsl #1}}
-
-% @cite is like \smartslanted except unconditionally use \sl. We never want
-% ttsl for book titles, do we?
-\def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection}
-
-\def\aftersmartic{}
-\def\var#1{%
- \let\saveaftersmartic = \aftersmartic
- \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}%
- \smartslanted{#1}%
-}
-
-\let\i=\smartitalic
-\let\slanted=\smartslanted
-\let\dfn=\smartslanted
-\let\emph=\smartitalic
-
-% Explicit font changes: @r, @sc, undocumented @ii.
-\def\r#1{{\rm #1}} % roman font
-\def\sc#1{{\smallcaps#1}} % smallcaps font
-\def\ii#1{{\it #1}} % italic font
-
-% @b, explicit bold. Also @strong.
-\def\b#1{{\bf #1}}
-\let\strong=\b
-
-% @sansserif, explicit sans.
-\def\sansserif#1{{\sf #1}}
-
-% We can't just use \exhyphenpenalty, because that only has effect at
-% the end of a paragraph. Restore normal hyphenation at the end of the
-% group within which \nohyphenation is presumably called.
-%
-\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation}
-\def\restorehyphenation{\hyphenchar\font = `- }
-
-% Set sfcode to normal for the chars that usually have another value.
-% Can't use plain's \frenchspacing because it uses the `\x notation, and
-% sometimes \x has an active definition that messes things up.
-%
-\catcode`@=11
- \def\plainfrenchspacing{%
- \sfcode`\.=\@m \sfcode`\?=\@m \sfcode`\!=\@m
- \sfcode`\:=\@m \sfcode`\;=\@m \sfcode`\,=\@m
- \def\endofsentencespacefactor{1000}% for @. and friends
- }
- \def\plainnonfrenchspacing{%
- \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000
- \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250
- \def\endofsentencespacefactor{3000}% for @. and friends
- }
-\catcode`@=\other
-\def\endofsentencespacefactor{3000}% default
-
-% @t, explicit typewriter.
-\def\t#1{%
- {\tt \plainfrenchspacing #1}%
- \null
-}
-
-% @samp.
-\def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}}
-
-% @indicateurl is \samp, that is, with quotes.
-\let\indicateurl=\samp
-
-% @code (and similar) prints in typewriter, but with spaces the same
-% size as normal in the surrounding text, without hyphenation, etc.
-% This is a subroutine for that.
-\def\tclose#1{%
- {%
- % Change normal interword space to be same as for the current font.
- \spaceskip = \fontdimen2\font
- %
- % Switch to typewriter.
- \tt
- %
- % But `\ ' produces the large typewriter interword space.
- \def\ {{\spaceskip = 0pt{} }}%
- %
- % Turn off hyphenation.
- \nohyphenation
- %
- \plainfrenchspacing
- #1%
- }%
- \null % reset spacefactor to 1000
-}
-
-% We *must* turn on hyphenation at `-' and `_' in @code.
-% (But see \codedashfinish below.)
-% Otherwise, it is too hard to avoid overfull hboxes
-% in the Emacs manual, the Library manual, etc.
-%
-% Unfortunately, TeX uses one parameter (\hyphenchar) to control
-% both hyphenation at - and hyphenation within words.
-% We must therefore turn them both off (\tclose does that)
-% and arrange explicitly to hyphenate at a dash. -- rms.
-{
- \catcode`\-=\active \catcode`\_=\active
- \catcode`\'=\active \catcode`\`=\active
- \global\let'=\rq \global\let`=\lq % default definitions
- %
- \global\def\code{\begingroup
- \setupmarkupstyle{code}%
- % The following should really be moved into \setupmarkupstyle handlers.
- \catcode\dashChar=\active \catcode\underChar=\active
- \ifallowcodebreaks
- \let-\codedash
- \let_\codeunder
- \else
- \let-\normaldash
- \let_\realunder
- \fi
- % Given -foo (with a single dash), we do not want to allow a break
- % after the hyphen.
- \global\let\codedashprev=\codedash
- %
- \codex
- }
- %
- \gdef\codedash{\futurelet\next\codedashfinish}
- \gdef\codedashfinish{%
- \normaldash % always output the dash character itself.
- %
- % Now, output a discretionary to allow a line break, unless
- % (a) the next character is a -, or
- % (b) the preceding character is a -.
- % E.g., given --posix, we do not want to allow a break after either -.
- % Given --foo-bar, we do want to allow a break between the - and the b.
- \ifx\next\codedash \else
- \ifx\codedashprev\codedash
- \else \discretionary{}{}{}\fi
- \fi
- % we need the space after the = for the case when \next itself is a
- % space token; it would get swallowed otherwise. As in @code{- a}.
- \global\let\codedashprev= \next
- }
-}
-\def\normaldash{-}
-%
-\def\codex #1{\tclose{#1}\endgroup}
-
-\def\codeunder{%
- % this is all so @math{@code{var_name}+1} can work. In math mode, _
- % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.)
- % will therefore expand the active definition of _, which is us
- % (inside @code that is), therefore an endless loop.
- \ifusingtt{\ifmmode
- \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_.
- \else\normalunderscore \fi
- \discretionary{}{}{}}%
- {\_}%
-}
-
-% An additional complication: the above will allow breaks after, e.g.,
-% each of the four underscores in __typeof__. This is bad.
-% @allowcodebreaks provides a document-level way to turn breaking at -
-% and _ on and off.
-%
-\newif\ifallowcodebreaks \allowcodebreakstrue
-
-\def\keywordtrue{true}
-\def\keywordfalse{false}
-
-\parseargdef\allowcodebreaks{%
- \def\txiarg{#1}%
- \ifx\txiarg\keywordtrue
- \allowcodebreakstrue
- \else\ifx\txiarg\keywordfalse
- \allowcodebreaksfalse
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}%
- \fi\fi
-}
-
-% For @command, @env, @file, @option quotes seem unnecessary,
-% so use \code rather than \samp.
-\let\command=\code
-\let\env=\code
-\let\file=\code
-\let\option=\code
-
-% @uref (abbreviation for `urlref') aka @url takes an optional
-% (comma-separated) second argument specifying the text to display and
-% an optional third arg as text to display instead of (rather than in
-% addition to) the url itself. First (mandatory) arg is the url.
-
-% TeX-only option to allow changing PDF output to show only the second
-% arg (if given), and not the url (which is then just the link target).
-\newif\ifurefurlonlylink
-
-% The main macro is \urefbreak, which allows breaking at expected
-% places within the url. (There used to be another version, which
-% didn't support automatic breaking.)
-\def\urefbreak{\begingroup \urefcatcodes \dourefbreak}
-\let\uref=\urefbreak
-%
-\def\dourefbreak#1{\urefbreakfinish #1,,,\finish}
-\def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example
- \unsepspaces
- \pdfurl{#1}%
- \setbox0 = \hbox{\ignorespaces #3}%
- \ifdim\wd0 > 0pt
- \unhbox0 % third arg given, show only that
- \else
- \setbox0 = \hbox{\ignorespaces #2}% look for second arg
- \ifdim\wd0 > 0pt
- \ifpdf
- % For pdfTeX and LuaTeX
- \ifurefurlonlylink
- % PDF plus option to not display url, show just arg
- \unhbox0
- \else
- % PDF, normally display both arg and url for consistency,
- % visibility, if the pdf is eventually used to print, etc.
- \unhbox0\ (\urefcode{#1})%
- \fi
- \else
- \ifx\XeTeXrevision\thisisundefined
- \unhbox0\ (\urefcode{#1})% DVI, always show arg and url
- \else
- % For XeTeX
- \ifurefurlonlylink
- % PDF plus option to not display url, show just arg
- \unhbox0
- \else
- % PDF, normally display both arg and url for consistency,
- % visibility, if the pdf is eventually used to print, etc.
- \unhbox0\ (\urefcode{#1})%
- \fi
- \fi
- \fi
- \else
- \urefcode{#1}% only url given, so show it
- \fi
- \fi
- \endlink
-\endgroup}
-
-% Allow line breaks around only a few characters (only).
-\def\urefcatcodes{%
- \catcode`\&=\active \catcode`\.=\active
- \catcode`\#=\active \catcode`\?=\active
- \catcode`\/=\active
-}
-{
- \urefcatcodes
- %
- \global\def\urefcode{\begingroup
- \setupmarkupstyle{code}%
- \urefcatcodes
- \let&\urefcodeamp
- \let.\urefcodedot
- \let#\urefcodehash
- \let?\urefcodequest
- \let/\urefcodeslash
- \codex
- }
- %
- % By default, they are just regular characters.
- \global\def&{\normalamp}
- \global\def.{\normaldot}
- \global\def#{\normalhash}
- \global\def?{\normalquest}
- \global\def/{\normalslash}
-}
-
-\def\urefcodeamp{\urefprebreak \&\urefpostbreak}
-\def\urefcodedot{\urefprebreak .\urefpostbreak}
-\def\urefcodehash{\urefprebreak \#\urefpostbreak}
-\def\urefcodequest{\urefprebreak ?\urefpostbreak}
-\def\urefcodeslash{\futurelet\next\urefcodeslashfinish}
-{
- \catcode`\/=\active
- \global\def\urefcodeslashfinish{%
- \urefprebreak \slashChar
- % Allow line break only after the final / in a sequence of
- % slashes, to avoid line break between the slashes in http://.
- \ifx\next/\else \urefpostbreak \fi
- }
-}
-
-% By default we'll break after the special characters, but some people like to
-% break before the special chars, so allow that. Also allow no breaking at
-% all, for manual control.
-%
-\parseargdef\urefbreakstyle{%
- \def\txiarg{#1}%
- \ifx\txiarg\wordnone
- \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak}
- \else\ifx\txiarg\wordbefore
- \def\urefprebreak{\urefallowbreak}\def\urefpostbreak{\nobreak}
- \else\ifx\txiarg\wordafter
- \def\urefprebreak{\nobreak}\def\urefpostbreak{\urefallowbreak}
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @urefbreakstyle setting `\txiarg'}%
- \fi\fi\fi
-}
-\def\wordafter{after}
-\def\wordbefore{before}
-\def\wordnone{none}
-
-% Allow a ragged right output to aid breaking long URL's. There can
-% be a break at the \allowbreak with no extra glue (if the existing stretch in
-% the line is sufficent), a break at the \penalty100 with extra glue added
-% at the end of the line, or no break at all here.
-% Changing the value of the penalty and/or the amount of stretch affects how
-% preferrable one choice is over the other.
-\def\urefallowbreak{%
- \allowbreak
- \hskip 0pt plus 2 em\relax
- \penalty300
- \hskip 0pt plus -2 em\relax
-}
-
-\urefbreakstyle after
-
-% @url synonym for @uref, since that's how everyone uses it.
-%
-\let\url=\uref
-
-% rms does not like angle brackets --karl, 17may97.
-% So now @email is just like @uref, unless we are pdf.
-%
-%\def\email#1{\angleleft{\tt #1}\angleright}
-\ifpdforxetex
- \def\email#1{\doemail#1,,\finish}
- \def\doemail#1,#2,#3\finish{\begingroup
- \unsepspaces
- \pdfurl{mailto:#1}%
- \setbox0 = \hbox{\ignorespaces #2}%
- \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi
- \endlink
- \endgroup}
-\else
- \let\email=\uref
-\fi
-
-% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always),
-% `example' (@kbd uses ttsl only inside of @example and friends),
-% or `code' (@kbd uses normal tty font always).
-\parseargdef\kbdinputstyle{%
- \def\txiarg{#1}%
- \ifx\txiarg\worddistinct
- \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}%
- \else\ifx\txiarg\wordexample
- \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}%
- \else\ifx\txiarg\wordcode
- \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}%
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @kbdinputstyle setting `\txiarg'}%
- \fi\fi\fi
-}
-\def\worddistinct{distinct}
-\def\wordexample{example}
-\def\wordcode{code}
-
-% Default is `distinct'.
-\kbdinputstyle distinct
-
-% @kbd is like @code, except that if the argument is just one @key command,
-% then @kbd has no effect.
-\def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}}
-
-\def\xkey{\key}
-\def\kbdsub#1#2#3\par{%
- \def\one{#1}\def\three{#3}\def\threex{??}%
- \ifx\one\xkey\ifx\threex\three \key{#2}%
- \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
- \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi
-}
-
-% definition of @key that produces a lozenge. Doesn't adjust to text size.
-%\setfont\keyrm\rmshape{8}{1000}{OT1}
-%\font\keysy=cmsy9
-%\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{%
-% \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{%
-% \vbox{\hrule\kern-0.4pt
-% \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}%
-% \kern-0.4pt\hrule}%
-% \kern-.06em\raise0.4pt\hbox{\angleright}}}}
-
-% definition of @key with no lozenge. If the current font is already
-% monospace, don't change it; that way, we respect @kbdinputstyle. But
-% if it isn't monospace, then use \tt.
-%
-\def\key#1{{\setupmarkupstyle{key}%
- \nohyphenation
- \ifmonospace\else\tt\fi
- #1}\null}
-
-% @clicksequence{File @click{} Open ...}
-\def\clicksequence#1{\begingroup #1\endgroup}
-
-% @clickstyle @arrow (by default)
-\parseargdef\clickstyle{\def\click{#1}}
-\def\click{\arrow}
-
-% Typeset a dimension, e.g., `in' or `pt'. The only reason for the
-% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt.
-%
-\def\dmn#1{\thinspace #1}
-
-% @acronym for "FBI", "NATO", and the like.
-% We print this one point size smaller, since it's intended for
-% all-uppercase.
-%
-\def\acronym#1{\doacronym #1,,\finish}
-\def\doacronym#1,#2,#3\finish{%
- {\switchtolsize #1}%
- \def\temp{#2}%
- \ifx\temp\empty \else
- \space ({\unsepspaces \ignorespaces \temp \unskip})%
- \fi
- \null % reset \spacefactor=1000
-}
-
-% @abbr for "Comput. J." and the like.
-% No font change, but don't do end-of-sentence spacing.
-%
-\def\abbr#1{\doabbr #1,,\finish}
-\def\doabbr#1,#2,#3\finish{%
- {\plainfrenchspacing #1}%
- \def\temp{#2}%
- \ifx\temp\empty \else
- \space ({\unsepspaces \ignorespaces \temp \unskip})%
- \fi
- \null % reset \spacefactor=1000
-}
-
-% @asis just yields its argument. Used with @table, for example.
-%
-\def\asis#1{#1}
-
-% @math outputs its argument in math mode.
-%
-% One complication: _ usually means subscripts, but it could also mean
-% an actual _ character, as in @math{@var{some_variable} + 1}. So make
-% _ active, and distinguish by seeing if the current family is \slfam,
-% which is what @var uses.
-{
- \catcode`\_ = \active
- \gdef\mathunderscore{%
- \catcode`\_=\active
- \def_{\ifnum\fam=\slfam \_\else\sb\fi}%
- }
-}
-% Another complication: we want \\ (and @\) to output a math (or tt) \.
-% FYI, plain.tex uses \\ as a temporary control sequence (for no
-% particular reason), but this is not advertised and we don't care.
-%
-% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\.
-\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi}
-%
-\def\math{%
- \ifmmode\else % only go into math if not in math mode already
- \tex
- \mathunderscore
- \let\\ = \mathbackslash
- \mathactive
- % make the texinfo accent commands work in math mode
- \let\"=\ddot
- \let\'=\acute
- \let\==\bar
- \let\^=\hat
- \let\`=\grave
- \let\u=\breve
- \let\v=\check
- \let\~=\tilde
- \let\dotaccent=\dot
- % have to provide another name for sup operator
- \let\mathopsup=\sup
- $\expandafter\finishmath\fi
-}
-\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex.
-
-% Some active characters (such as <) are spaced differently in math.
-% We have to reset their definitions in case the @math was an argument
-% to a command which sets the catcodes (such as @item or @section).
-%
-{
- \catcode`^ = \active
- \catcode`< = \active
- \catcode`> = \active
- \catcode`+ = \active
- \catcode`' = \active
- \gdef\mathactive{%
- \let^ = \ptexhat
- \let< = \ptexless
- \let> = \ptexgtr
- \let+ = \ptexplus
- \let' = \ptexquoteright
- }
-}
-
-% for @sub and @sup, if in math mode, just do a normal sub/superscript.
-% If in text, use math to place as sub/superscript, but switch
-% into text mode, with smaller fonts. This is a different font than the
-% one used for real math sub/superscripts (8pt vs. 7pt), but let's not
-% fix it (significant additions to font machinery) until someone notices.
-%
-\def\sub{\ifmmode \expandafter\sb \else \expandafter\finishsub\fi}
-\def\finishsub#1{$\sb{\hbox{\switchtolllsize #1}}$}%
-%
-\def\sup{\ifmmode \expandafter\ptexsp \else \expandafter\finishsup\fi}
-\def\finishsup#1{$\ptexsp{\hbox{\switchtolllsize #1}}$}%
-
-% @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}.
-% Ignore unless FMTNAME == tex; then it is like @iftex and @tex,
-% except specified as a normal braced arg, so no newlines to worry about.
-%
-\def\outfmtnametex{tex}
-%
-\long\def\inlinefmt#1{\doinlinefmt #1,\finish}
-\long\def\doinlinefmt#1,#2,\finish{%
- \def\inlinefmtname{#1}%
- \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi
-}
-%
-% @inlinefmtifelse{FMTNAME,THEN-TEXT,ELSE-TEXT} expands THEN-TEXT if
-% FMTNAME is tex, else ELSE-TEXT.
-\long\def\inlinefmtifelse#1{\doinlinefmtifelse #1,,,\finish}
-\long\def\doinlinefmtifelse#1,#2,#3,#4,\finish{%
- \def\inlinefmtname{#1}%
- \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\else \ignorespaces #3\fi
-}
-%
-% For raw, must switch into @tex before parsing the argument, to avoid
-% setting catcodes prematurely. Doing it this way means that, for
-% example, @inlineraw{html, foo{bar} gets a parse error instead of being
-% ignored. But this isn't important because if people want a literal
-% *right* brace they would have to use a command anyway, so they may as
-% well use a command to get a left brace too. We could re-use the
-% delimiter character idea from \verb, but it seems like overkill.
-%
-\long\def\inlineraw{\tex \doinlineraw}
-\long\def\doinlineraw#1{\doinlinerawtwo #1,\finish}
-\def\doinlinerawtwo#1,#2,\finish{%
- \def\inlinerawname{#1}%
- \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi
- \endgroup % close group opened by \tex.
-}
-
-% @inlineifset{VAR, TEXT} expands TEXT if VAR is @set.
-%
-\long\def\inlineifset#1{\doinlineifset #1,\finish}
-\long\def\doinlineifset#1,#2,\finish{%
- \def\inlinevarname{#1}%
- \expandafter\ifx\csname SET\inlinevarname\endcsname\relax
- \else\ignorespaces#2\fi
-}
-
-% @inlineifclear{VAR, TEXT} expands TEXT if VAR is not @set.
-%
-\long\def\inlineifclear#1{\doinlineifclear #1,\finish}
-\long\def\doinlineifclear#1,#2,\finish{%
- \def\inlinevarname{#1}%
- \expandafter\ifx\csname SET\inlinevarname\endcsname\relax \ignorespaces#2\fi
-}
-
-
-\message{glyphs,}
-% and logos.
-
-% @@ prints an @, as does @atchar{}.
-\def\@{\char64 }
-\let\atchar=\@
-
-% @{ @} @lbracechar{} @rbracechar{} all generate brace characters.
-\def\lbracechar{{\ifmonospace\char123\else\ensuremath\lbrace\fi}}
-\def\rbracechar{{\ifmonospace\char125\else\ensuremath\rbrace\fi}}
-\let\{=\lbracechar
-\let\}=\rbracechar
-
-% @comma{} to avoid , parsing problems.
-\let\comma = ,
-
-% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent
-% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H.
-\let\, = \ptexc
-\let\dotaccent = \ptexdot
-\def\ringaccent#1{{\accent23 #1}}
-\let\tieaccent = \ptext
-\let\ubaraccent = \ptexb
-\let\udotaccent = \d
-
-% Other special characters: @questiondown @exclamdown @ordf @ordm
-% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss.
-\def\questiondown{?`}
-\def\exclamdown{!`}
-\def\ordf{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{a}}}
-\def\ordm{\leavevmode\raise1ex\hbox{\switchtolllsize \underbar{o}}}
-
-% Dotless i and dotless j, used for accents.
-\def\imacro{i}
-\def\jmacro{j}
-\def\dotless#1{%
- \def\temp{#1}%
- \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi
- \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi
- \else \errmessage{@dotless can be used only with i or j}%
- \fi\fi
-}
-
-% The \TeX{} logo, as in plain, but resetting the spacing so that a
-% period following counts as ending a sentence. (Idea found in latex.)
-%
-\edef\TeX{\TeX \spacefactor=1000 }
-
-% @LaTeX{} logo. Not quite the same results as the definition in
-% latex.ltx, since we use a different font for the raised A; it's most
-% convenient for us to use an explicitly smaller font, rather than using
-% the \scriptstyle font (since we don't reset \scriptstyle and
-% \scriptscriptstyle).
-%
-\def\LaTeX{%
- L\kern-.36em
- {\setbox0=\hbox{T}%
- \vbox to \ht0{\hbox{%
- \ifx\textnominalsize\xwordpt
- % for 10pt running text, lllsize (8pt) is too small for the A in LaTeX.
- % Revert to plain's \scriptsize, which is 7pt.
- \count255=\the\fam $\fam\count255 \scriptstyle A$%
- \else
- % For 11pt, we can use our lllsize.
- \switchtolllsize A%
- \fi
- }%
- \vss
- }}%
- \kern-.15em
- \TeX
-}
-
-% Some math mode symbols. Define \ensuremath to switch into math mode
-% unless we are already there. Expansion tricks may not be needed here,
-% but safer, and can't hurt.
-\def\ensuremath{\ifmmode \expandafter\asis \else\expandafter\ensuredmath \fi}
-\def\ensuredmath#1{$\relax#1$}
-%
-\def\bullet{\ensuremath\ptexbullet}
-\def\geq{\ensuremath\ge}
-\def\leq{\ensuremath\le}
-\def\minus{\ensuremath-}
-
-% @dots{} outputs an ellipsis using the current font.
-% We do .5em per period so that it has the same spacing in the cm
-% typewriter fonts as three actual period characters; on the other hand,
-% in other typewriter fonts three periods are wider than 1.5em. So do
-% whichever is larger.
-%
-\def\dots{%
- \leavevmode
- \setbox0=\hbox{...}% get width of three periods
- \ifdim\wd0 > 1.5em
- \dimen0 = \wd0
- \else
- \dimen0 = 1.5em
- \fi
- \hbox to \dimen0{%
- \hskip 0pt plus.25fil
- .\hskip 0pt plus1fil
- .\hskip 0pt plus1fil
- .\hskip 0pt plus.5fil
- }%
-}
-
-% @enddots{} is an end-of-sentence ellipsis.
-%
-\def\enddots{%
- \dots
- \spacefactor=\endofsentencespacefactor
-}
-
-% @point{}, @result{}, @expansion{}, @print{}, @equiv{}.
-%
-% Since these characters are used in examples, they should be an even number of
-% \tt widths. Each \tt character is 1en, so two makes it 1em.
-%
-\def\point{$\star$}
-\def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}}
-\def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}}
-\def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}}
-\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}}
-\def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}}
-
-% The @error{} command.
-% Adapted from the TeXbook's \boxit.
-%
-\newbox\errorbox
-%
-{\ttfont \global\dimen0 = 3em}% Width of the box.
-\dimen2 = .55pt % Thickness of rules
-% The text. (`r' is open on the right, `e' somewhat less so on the left.)
-\setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt}
-%
-\setbox\errorbox=\hbox to \dimen0{\hfil
- \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right.
- \advance\hsize by -2\dimen2 % Rules.
- \vbox{%
- \hrule height\dimen2
- \hbox{\vrule width\dimen2 \kern3pt % Space to left of text.
- \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below.
- \kern3pt\vrule width\dimen2}% Space to right.
- \hrule height\dimen2}
- \hfil}
-%
-\def\error{\leavevmode\lower.7ex\copy\errorbox}
-
-% @pounds{} is a sterling sign, which Knuth put in the CM italic font.
-%
-\def\pounds{{\it\$}}
-
-% @euro{} comes from a separate font, depending on the current style.
-% We use the free feym* fonts from the eurosym package by Henrik
-% Theiling, which support regular, slanted, bold and bold slanted (and
-% "outlined" (blackboard board, sort of) versions, which we don't need).
-% It is available from http://www.ctan.org/tex-archive/fonts/eurosym.
-%
-% Although only regular is the truly official Euro symbol, we ignore
-% that. The Euro is designed to be slightly taller than the regular
-% font height.
-%
-% feymr - regular
-% feymo - slanted
-% feybr - bold
-% feybo - bold slanted
-%
-% There is no good (free) typewriter version, to my knowledge.
-% A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide.
-% Hmm.
-%
-% Also doesn't work in math. Do we need to do math with euro symbols?
-% Hope not.
-%
-%
-\def\euro{{\eurofont e}}
-\def\eurofont{%
- % We set the font at each command, rather than predefining it in
- % \textfonts and the other font-switching commands, so that
- % installations which never need the symbol don't have to have the
- % font installed.
- %
- % There is only one designed size (nominal 10pt), so we always scale
- % that to the current nominal size.
- %
- % By the way, simply using "at 1em" works for cmr10 and the like, but
- % does not work for cmbx10 and other extended/shrunken fonts.
- %
- \def\eurosize{\csname\curfontsize nominalsize\endcsname}%
- %
- \ifx\curfontstyle\bfstylename
- % bold:
- \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize
- \else
- % regular:
- \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize
- \fi
- \thiseurofont
-}
-
-% Glyphs from the EC fonts. We don't use \let for the aliases, because
-% sometimes we redefine the original macro, and the alias should reflect
-% the redefinition.
-%
-% Use LaTeX names for the Icelandic letters.
-\def\DH{{\ecfont \char"D0}} % Eth
-\def\dh{{\ecfont \char"F0}} % eth
-\def\TH{{\ecfont \char"DE}} % Thorn
-\def\th{{\ecfont \char"FE}} % thorn
-%
-\def\guillemetleft{{\ecfont \char"13}}
-\def\guillemotleft{\guillemetleft}
-\def\guillemetright{{\ecfont \char"14}}
-\def\guillemotright{\guillemetright}
-\def\guilsinglleft{{\ecfont \char"0E}}
-\def\guilsinglright{{\ecfont \char"0F}}
-\def\quotedblbase{{\ecfont \char"12}}
-\def\quotesinglbase{{\ecfont \char"0D}}
-%
-% This positioning is not perfect (see the ogonek LaTeX package), but
-% we have the precomposed glyphs for the most common cases. We put the
-% tests to use those glyphs in the single \ogonek macro so we have fewer
-% dummy definitions to worry about for index entries, etc.
-%
-% ogonek is also used with other letters in Lithuanian (IOU), but using
-% the precomposed glyphs for those is not so easy since they aren't in
-% the same EC font.
-\def\ogonek#1{{%
- \def\temp{#1}%
- \ifx\temp\macrocharA\Aogonek
- \else\ifx\temp\macrochara\aogonek
- \else\ifx\temp\macrocharE\Eogonek
- \else\ifx\temp\macrochare\eogonek
- \else
- \ecfont \setbox0=\hbox{#1}%
- \ifdim\ht0=1ex\accent"0C #1%
- \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}%
- \fi
- \fi\fi\fi\fi
- }%
-}
-\def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A}
-\def\aogonek{{\ecfont \char"A1}}\def\macrochara{a}
-\def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E}
-\def\eogonek{{\ecfont \char"A6}}\def\macrochare{e}
-%
-% Use the European Computer Modern fonts (cm-super in outline format)
-% for non-CM glyphs. That is ec* for regular text and tc* for the text
-% companion symbols (LaTeX TS1 encoding). Both are part of the ec
-% package and follow the same conventions.
-%
-\def\ecfont{\etcfont{e}}
-\def\tcfont{\etcfont{t}}
-%
-\def\etcfont#1{%
- % We can't distinguish serif/sans and italic/slanted, but this
- % is used for crude hacks anyway (like adding French and German
- % quotes to documents typeset with CM, where we lose kerning), so
- % hopefully nobody will notice/care.
- \edef\ecsize{\csname\curfontsize ecsize\endcsname}%
- \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}%
- \ifmonospace
- % typewriter:
- \font\thisecfont = #1ctt\ecsize \space at \nominalsize
- \else
- \ifx\curfontstyle\bfstylename
- % bold:
- \font\thisecfont = #1cb\ifusingit{i}{x}\ecsize \space at \nominalsize
- \else
- % regular:
- \font\thisecfont = #1c\ifusingit{ti}{rm}\ecsize \space at \nominalsize
- \fi
- \fi
- \thisecfont
-}
-
-% @registeredsymbol - R in a circle. The font for the R should really
-% be smaller yet, but lllsize is the best we can do for now.
-% Adapted from the plain.tex definition of \copyright.
-%
-\def\registeredsymbol{%
- $^{{\ooalign{\hfil\raise.07ex\hbox{\switchtolllsize R}%
- \hfil\crcr\Orb}}%
- }$%
-}
-
-% @textdegree - the normal degrees sign.
-%
-\def\textdegree{$^\circ$}
-
-% Laurent Siebenmann reports \Orb undefined with:
-% Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38
-% so we'll define it if necessary.
-%
-\ifx\Orb\thisisundefined
-\def\Orb{\mathhexbox20D}
-\fi
-
-% Quotes.
-\chardef\quotedblleft="5C
-\chardef\quotedblright=`\"
-\chardef\quoteleft=`\`
-\chardef\quoteright=`\'
-
-
-\message{page headings,}
-
-\newskip\titlepagetopglue \titlepagetopglue = 1.5in
-\newskip\titlepagebottomglue \titlepagebottomglue = 2pc
-
-% First the title page. Must do @settitle before @titlepage.
-\newif\ifseenauthor
-\newif\iffinishedtitlepage
-
-% @setcontentsaftertitlepage used to do an implicit @contents or
-% @shortcontents after @end titlepage, but it is now obsolete.
-\def\setcontentsaftertitlepage{%
- \errmessage{@setcontentsaftertitlepage has been removed as a Texinfo
- command; move your @contents command if you want the contents
- after the title page.}}%
-\def\setshortcontentsaftertitlepage{%
- \errmessage{@setshortcontentsaftertitlepage has been removed as a Texinfo
- command; move your @shortcontents and @contents commands if you
- want the contents after the title page.}}%
-
-\parseargdef\shorttitlepage{%
- \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}%
- \endgroup\page\hbox{}\page}
-
-\envdef\titlepage{%
- % Open one extra group, as we want to close it in the middle of \Etitlepage.
- \begingroup
- \parindent=0pt \textfonts
- % Leave some space at the very top of the page.
- \vglue\titlepagetopglue
- % No rule at page bottom unless we print one at the top with @title.
- \finishedtitlepagetrue
- %
- % Most title ``pages'' are actually two pages long, with space
- % at the top of the second. We don't want the ragged left on the second.
- \let\oldpage = \page
- \def\page{%
- \iffinishedtitlepage\else
- \finishtitlepage
- \fi
- \let\page = \oldpage
- \page
- \null
- }%
-}
-
-\def\Etitlepage{%
- \iffinishedtitlepage\else
- \finishtitlepage
- \fi
- % It is important to do the page break before ending the group,
- % because the headline and footline are only empty inside the group.
- % If we use the new definition of \page, we always get a blank page
- % after the title page, which we certainly don't want.
- \oldpage
- \endgroup
- %
- % Need this before the \...aftertitlepage checks so that if they are
- % in effect the toc pages will come out with page numbers.
- \HEADINGSon
-}
-
-\def\finishtitlepage{%
- \vskip4pt \hrule height 2pt width \hsize
- \vskip\titlepagebottomglue
- \finishedtitlepagetrue
-}
-
-% Settings used for typesetting titles: no hyphenation, no indentation,
-% don't worry much about spacing, ragged right. This should be used
-% inside a \vbox, and fonts need to be set appropriately first. \par should
-% be specified before the end of the \vbox, since a vbox is a group.
-%
-\def\raggedtitlesettings{%
- \rm
- \hyphenpenalty=10000
- \parindent=0pt
- \tolerance=5000
- \ptexraggedright
-}
-
-% Macros to be used within @titlepage:
-
-\let\subtitlerm=\rmfont
-\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines}
-
-\parseargdef\title{%
- \checkenv\titlepage
- \vbox{\titlefonts \raggedtitlesettings #1\par}%
- % print a rule at the page bottom also.
- \finishedtitlepagefalse
- \vskip4pt \hrule height 4pt width \hsize \vskip4pt
-}
-
-\parseargdef\subtitle{%
- \checkenv\titlepage
- {\subtitlefont \rightline{#1}}%
-}
-
-% @author should come last, but may come many times.
-% It can also be used inside @quotation.
-%
-\parseargdef\author{%
- \def\temp{\quotation}%
- \ifx\thisenv\temp
- \def\quotationauthor{#1}% printed in \Equotation.
- \else
- \checkenv\titlepage
- \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi
- {\secfonts\rm \leftline{#1}}%
- \fi
-}
-
-
-% Set up page headings and footings.
-
-\let\thispage=\folio
-
-\newtoks\evenheadline % headline on even pages
-\newtoks\oddheadline % headline on odd pages
-\newtoks\evenfootline % footline on even pages
-\newtoks\oddfootline % footline on odd pages
-
-% Now make \makeheadline and \makefootline in Plain TeX use those variables
-\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline
- \else \the\evenheadline \fi}}
-\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline
- \else \the\evenfootline \fi}\HEADINGShook}
-\let\HEADINGShook=\relax
-
-% Commands to set those variables.
-% For example, this is what @headings on does
-% @evenheading @thistitle|@thispage|@thischapter
-% @oddheading @thischapter|@thispage|@thistitle
-% @evenfooting @thisfile||
-% @oddfooting ||@thisfile
-
-
-\def\evenheading{\parsearg\evenheadingxxx}
-\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish}
-\def\evenheadingyyy #1\|#2\|#3\|#4\finish{%
-\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
-
-\def\oddheading{\parsearg\oddheadingxxx}
-\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish}
-\def\oddheadingyyy #1\|#2\|#3\|#4\finish{%
-\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
-
-\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}%
-
-\def\evenfooting{\parsearg\evenfootingxxx}
-\def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish}
-\def\evenfootingyyy #1\|#2\|#3\|#4\finish{%
-\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}}
-
-\def\oddfooting{\parsearg\oddfootingxxx}
-\def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish}
-\def\oddfootingyyy #1\|#2\|#3\|#4\finish{%
- \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}%
- %
- % Leave some space for the footline. Hopefully ok to assume
- % @evenfooting will not be used by itself.
- \global\advance\txipageheight by -12pt
- \global\advance\vsize by -12pt
-}
-
-\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}}
-
-% @evenheadingmarks top \thischapter <- chapter at the top of a page
-% @evenheadingmarks bottom \thischapter <- chapter at the bottom of a page
-%
-% The same set of arguments for:
-%
-% @oddheadingmarks
-% @evenfootingmarks
-% @oddfootingmarks
-% @everyheadingmarks
-% @everyfootingmarks
-
-% These define \getoddheadingmarks, \getevenheadingmarks,
-% \getoddfootingmarks, and \getevenfootingmarks, each to one of
-% \gettopheadingmarks, \getbottomheadingmarks.
-%
-\def\evenheadingmarks{\headingmarks{even}{heading}}
-\def\oddheadingmarks{\headingmarks{odd}{heading}}
-\def\evenfootingmarks{\headingmarks{even}{footing}}
-\def\oddfootingmarks{\headingmarks{odd}{footing}}
-\parseargdef\everyheadingmarks{\headingmarks{even}{heading}{#1}
- \headingmarks{odd}{heading}{#1} }
-\parseargdef\everyfootingmarks{\headingmarks{even}{footing}{#1}
- \headingmarks{odd}{footing}{#1} }
-% #1 = even/odd, #2 = heading/footing, #3 = top/bottom.
-\def\headingmarks#1#2#3 {%
- \expandafter\let\expandafter\temp \csname get#3headingmarks\endcsname
- \global\expandafter\let\csname get#1#2marks\endcsname \temp
-}
-
-\everyheadingmarks bottom
-\everyfootingmarks bottom
-
-% @headings double turns headings on for double-sided printing.
-% @headings single turns headings on for single-sided printing.
-% @headings off turns them off.
-% @headings on same as @headings double, retained for compatibility.
-% @headings after turns on double-sided headings after this page.
-% @headings doubleafter turns on double-sided headings after this page.
-% @headings singleafter turns on single-sided headings after this page.
-% By default, they are off at the start of a document,
-% and turned `on' after @end titlepage.
-
-\parseargdef\headings{\csname HEADINGS#1\endcsname}
-
-\def\headingsoff{% non-global headings elimination
- \evenheadline={\hfil}\evenfootline={\hfil}%
- \oddheadline={\hfil}\oddfootline={\hfil}%
-}
-
-\def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting
-\HEADINGSoff % it's the default
-
-% When we turn headings on, set the page number to 1.
-% For double-sided printing, put current file name in lower left corner,
-% chapter name on inside top of right hand pages, document
-% title on inside top of left hand pages, and page numbers on outside top
-% edge of all pages.
-\def\HEADINGSdouble{%
-\global\pageno=1
-\global\evenfootline={\hfil}
-\global\oddfootline={\hfil}
-\global\evenheadline={\line{\folio\hfil\thistitle}}
-\global\oddheadline={\line{\thischapterheading\hfil\folio}}
-\global\let\contentsalignmacro = \chapoddpage
-}
-\let\contentsalignmacro = \chappager
-
-% For single-sided printing, chapter title goes across top left of page,
-% page number on top right.
-\def\HEADINGSsingle{%
-\global\pageno=1
-\global\evenfootline={\hfil}
-\global\oddfootline={\hfil}
-\global\evenheadline={\line{\thischapterheading\hfil\folio}}
-\global\oddheadline={\line{\thischapterheading\hfil\folio}}
-\global\let\contentsalignmacro = \chappager
-}
-\def\HEADINGSon{\HEADINGSdouble}
-
-\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex}
-\let\HEADINGSdoubleafter=\HEADINGSafter
-\def\HEADINGSdoublex{%
-\global\evenfootline={\hfil}
-\global\oddfootline={\hfil}
-\global\evenheadline={\line{\folio\hfil\thistitle}}
-\global\oddheadline={\line{\thischapterheading\hfil\folio}}
-\global\let\contentsalignmacro = \chapoddpage
-}
-
-\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex}
-\def\HEADINGSsinglex{%
-\global\evenfootline={\hfil}
-\global\oddfootline={\hfil}
-\global\evenheadline={\line{\thischapterheading\hfil\folio}}
-\global\oddheadline={\line{\thischapterheading\hfil\folio}}
-\global\let\contentsalignmacro = \chappager
-}
-
-% Subroutines used in generating headings
-% This produces Day Month Year style of output.
-% Only define if not already defined, in case a txi-??.tex file has set
-% up a different format (e.g., txi-cs.tex does this).
-\ifx\today\thisisundefined
-\def\today{%
- \number\day\space
- \ifcase\month
- \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr
- \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug
- \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec
- \fi
- \space\number\year}
-\fi
-
-% @settitle line... specifies the title of the document, for headings.
-% It generates no output of its own.
-\def\thistitle{\putwordNoTitle}
-\def\settitle{\parsearg{\gdef\thistitle}}
-
-
-\message{tables,}
-% Tables -- @table, @ftable, @vtable, @item(x).
-
-% default indentation of table text
-\newdimen\tableindent \tableindent=.8in
-% default indentation of @itemize and @enumerate text
-\newdimen\itemindent \itemindent=.3in
-% margin between end of table item and start of table text.
-\newdimen\itemmargin \itemmargin=.1in
-
-% used internally for \itemindent minus \itemmargin
-\newdimen\itemmax
-
-% Note @table, @ftable, and @vtable define @item, @itemx, etc., with
-% these defs.
-% They also define \itemindex
-% to index the item name in whatever manner is desired (perhaps none).
-
-\newif\ifitemxneedsnegativevskip
-
-\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi}
-
-\def\internalBitem{\smallbreak \parsearg\itemzzz}
-\def\internalBitemx{\itemxpar \parsearg\itemzzz}
-
-\def\itemzzz #1{\begingroup %
- \advance\hsize by -\rightskip
- \advance\hsize by -\tableindent
- \setbox0=\hbox{\itemindicate{#1}}%
- \itemindex{#1}%
- \nobreak % This prevents a break before @itemx.
- %
- % If the item text does not fit in the space we have, put it on a line
- % by itself, and do not allow a page break either before or after that
- % line. We do not start a paragraph here because then if the next
- % command is, e.g., @kindex, the whatsit would get put into the
- % horizontal list on a line by itself, resulting in extra blank space.
- \ifdim \wd0>\itemmax
- %
- % Make this a paragraph so we get the \parskip glue and wrapping,
- % but leave it ragged-right.
- \begingroup
- \advance\leftskip by-\tableindent
- \advance\hsize by\tableindent
- \advance\rightskip by0pt plus1fil\relax
- \leavevmode\unhbox0\par
- \endgroup
- %
- % We're going to be starting a paragraph, but we don't want the
- % \parskip glue -- logically it's part of the @item we just started.
- \nobreak \vskip-\parskip
- %
- % Stop a page break at the \parskip glue coming up. However, if
- % what follows is an environment such as @example, there will be no
- % \parskip glue; then the negative vskip we just inserted would
- % cause the example and the item to crash together. So we use this
- % bizarre value of 10001 as a signal to \aboveenvbreak to insert
- % \parskip glue after all. Section titles are handled this way also.
- %
- \penalty 10001
- \endgroup
- \itemxneedsnegativevskipfalse
- \else
- % The item text fits into the space. Start a paragraph, so that the
- % following text (if any) will end up on the same line.
- \noindent
- % Do this with kerns and \unhbox so that if there is a footnote in
- % the item text, it can migrate to the main vertical list and
- % eventually be printed.
- \nobreak\kern-\tableindent
- \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0
- \unhbox0
- \nobreak\kern\dimen0
- \endgroup
- \itemxneedsnegativevskiptrue
- \fi
-}
-
-\def\item{\errmessage{@item while not in a list environment}}
-\def\itemx{\errmessage{@itemx while not in a list environment}}
-
-% @table, @ftable, @vtable.
-\envdef\table{%
- \let\itemindex\gobble
- \tablecheck{table}%
-}
-\envdef\ftable{%
- \def\itemindex ##1{\doind {fn}{\code{##1}}}%
- \tablecheck{ftable}%
-}
-\envdef\vtable{%
- \def\itemindex ##1{\doind {vr}{\code{##1}}}%
- \tablecheck{vtable}%
-}
-\def\tablecheck#1{%
- \ifnum \the\catcode`\^^M=\active
- \endgroup
- \errmessage{This command won't work in this context; perhaps the problem is
- that we are \inenvironment\thisenv}%
- \def\next{\doignore{#1}}%
- \else
- \let\next\tablex
- \fi
- \next
-}
-\def\tablex#1{%
- \def\itemindicate{#1}%
- \parsearg\tabley
-}
-\def\tabley#1{%
- {%
- \makevalueexpandable
- \edef\temp{\noexpand\tablez #1\space\space\space}%
- \expandafter
- }\temp \endtablez
-}
-\def\tablez #1 #2 #3 #4\endtablez{%
- \aboveenvbreak
- \ifnum 0#1>0 \advance \leftskip by #1\mil \fi
- \ifnum 0#2>0 \tableindent=#2\mil \fi
- \ifnum 0#3>0 \advance \rightskip by #3\mil \fi
- \itemmax=\tableindent
- \advance \itemmax by -\itemmargin
- \advance \leftskip by \tableindent
- \exdentamount=\tableindent
- \parindent = 0pt
- \parskip = \smallskipamount
- \ifdim \parskip=0pt \parskip=2pt \fi
- \let\item = \internalBitem
- \let\itemx = \internalBitemx
-}
-\def\Etable{\endgraf\afterenvbreak}
-\let\Eftable\Etable
-\let\Evtable\Etable
-\let\Eitemize\Etable
-\let\Eenumerate\Etable
-
-% This is the counter used by @enumerate, which is really @itemize
-
-\newcount \itemno
-
-\envdef\itemize{\parsearg\doitemize}
-
-\def\doitemize#1{%
- \aboveenvbreak
- \itemmax=\itemindent
- \advance\itemmax by -\itemmargin
- \advance\leftskip by \itemindent
- \exdentamount=\itemindent
- \parindent=0pt
- \parskip=\smallskipamount
- \ifdim\parskip=0pt \parskip=2pt \fi
- %
- % Try typesetting the item mark so that if the document erroneously says
- % something like @itemize @samp (intending @table), there's an error
- % right away at the @itemize. It's not the best error message in the
- % world, but it's better than leaving it to the @item. This means if
- % the user wants an empty mark, they have to say @w{} not just @w.
- \def\itemcontents{#1}%
- \setbox0 = \hbox{\itemcontents}%
- %
- % @itemize with no arg is equivalent to @itemize @bullet.
- \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi
- %
- \let\item=\itemizeitem
-}
-
-% Definition of @item while inside @itemize and @enumerate.
-%
-\def\itemizeitem{%
- \advance\itemno by 1 % for enumerations
- {\let\par=\endgraf \smallbreak}% reasonable place to break
- {%
- % If the document has an @itemize directly after a section title, a
- % \nobreak will be last on the list, and \sectionheading will have
- % done a \vskip-\parskip. In that case, we don't want to zero
- % parskip, or the item text will crash with the heading. On the
- % other hand, when there is normal text preceding the item (as there
- % usually is), we do want to zero parskip, or there would be too much
- % space. In that case, we won't have a \nobreak before. At least
- % that's the theory.
- \ifnum\lastpenalty<10000 \parskip=0in \fi
- \noindent
- \hbox to 0pt{\hss \itemcontents \kern\itemmargin}%
- %
- \ifinner\else
- \vadjust{\penalty 1200}% not good to break after first line of item.
- \fi
- % We can be in inner vertical mode in a footnote, although an
- % @itemize looks awful there.
- }%
- \flushcr
-}
-
-% \splitoff TOKENS\endmark defines \first to be the first token in
-% TOKENS, and \rest to be the remainder.
-%
-\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}%
-
-% Allow an optional argument of an uppercase letter, lowercase letter,
-% or number, to specify the first label in the enumerated list. No
-% argument is the same as `1'.
-%
-\envparseargdef\enumerate{\enumeratey #1 \endenumeratey}
-\def\enumeratey #1 #2\endenumeratey{%
- % If we were given no argument, pretend we were given `1'.
- \def\thearg{#1}%
- \ifx\thearg\empty \def\thearg{1}\fi
- %
- % Detect if the argument is a single token. If so, it might be a
- % letter. Otherwise, the only valid thing it can be is a number.
- % (We will always have one token, because of the test we just made.
- % This is a good thing, since \splitoff doesn't work given nothing at
- % all -- the first parameter is undelimited.)
- \expandafter\splitoff\thearg\endmark
- \ifx\rest\empty
- % Only one token in the argument. It could still be anything.
- % A ``lowercase letter'' is one whose \lccode is nonzero.
- % An ``uppercase letter'' is one whose \lccode is both nonzero, and
- % not equal to itself.
- % Otherwise, we assume it's a number.
- %
- % We need the \relax at the end of the \ifnum lines to stop TeX from
- % continuing to look for a <number>.
- %
- \ifnum\lccode\expandafter`\thearg=0\relax
- \numericenumerate % a number (we hope)
- \else
- % It's a letter.
- \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax
- \lowercaseenumerate % lowercase letter
- \else
- \uppercaseenumerate % uppercase letter
- \fi
- \fi
- \else
- % Multiple tokens in the argument. We hope it's a number.
- \numericenumerate
- \fi
-}
-
-% An @enumerate whose labels are integers. The starting integer is
-% given in \thearg.
-%
-\def\numericenumerate{%
- \itemno = \thearg
- \startenumeration{\the\itemno}%
-}
-
-% The starting (lowercase) letter is in \thearg.
-\def\lowercaseenumerate{%
- \itemno = \expandafter`\thearg
- \startenumeration{%
- % Be sure we're not beyond the end of the alphabet.
- \ifnum\itemno=0
- \errmessage{No more lowercase letters in @enumerate; get a bigger
- alphabet}%
- \fi
- \char\lccode\itemno
- }%
-}
-
-% The starting (uppercase) letter is in \thearg.
-\def\uppercaseenumerate{%
- \itemno = \expandafter`\thearg
- \startenumeration{%
- % Be sure we're not beyond the end of the alphabet.
- \ifnum\itemno=0
- \errmessage{No more uppercase letters in @enumerate; get a bigger
- alphabet}
- \fi
- \char\uccode\itemno
- }%
-}
-
-% Call \doitemize, adding a period to the first argument and supplying the
-% common last two arguments. Also subtract one from the initial value in
-% \itemno, since @item increments \itemno.
-%
-\def\startenumeration#1{%
- \advance\itemno by -1
- \doitemize{#1.}\flushcr
-}
-
-% @alphaenumerate and @capsenumerate are abbreviations for giving an arg
-% to @enumerate.
-%
-\def\alphaenumerate{\enumerate{a}}
-\def\capsenumerate{\enumerate{A}}
-\def\Ealphaenumerate{\Eenumerate}
-\def\Ecapsenumerate{\Eenumerate}
-
-
-% @multitable macros
-% Amy Hendrickson, 8/18/94, 3/6/96
-%
-% @multitable ... @end multitable will make as many columns as desired.
-% Contents of each column will wrap at width given in preamble. Width
-% can be specified either with sample text given in a template line,
-% or in percent of \hsize, the current width of text on page.
-
-% Table can continue over pages but will only break between lines.
-
-% To make preamble:
-%
-% Either define widths of columns in terms of percent of \hsize:
-% @multitable @columnfractions .25 .3 .45
-% @item ...
-%
-% Numbers following @columnfractions are the percent of the total
-% current hsize to be used for each column. You may use as many
-% columns as desired.
-
-
-% Or use a template:
-% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
-% @item ...
-% using the widest term desired in each column.
-
-% Each new table line starts with @item, each subsequent new column
-% starts with @tab. Empty columns may be produced by supplying @tab's
-% with nothing between them for as many times as empty columns are needed,
-% ie, @tab@tab@tab will produce two empty columns.
-
-% @item, @tab do not need to be on their own lines, but it will not hurt
-% if they are.
-
-% Sample multitable:
-
-% @multitable {Column 1 template} {Column 2 template} {Column 3 template}
-% @item first col stuff @tab second col stuff @tab third col
-% @item
-% first col stuff
-% @tab
-% second col stuff
-% @tab
-% third col
-% @item first col stuff @tab second col stuff
-% @tab Many paragraphs of text may be used in any column.
-%
-% They will wrap at the width determined by the template.
-% @item@tab@tab This will be in third column.
-% @end multitable
-
-% Default dimensions may be reset by user.
-% @multitableparskip is vertical space between paragraphs in table.
-% @multitableparindent is paragraph indent in table.
-% @multitablecolmargin is horizontal space to be left between columns.
-% @multitablelinespace is space to leave between table items, baseline
-% to baseline.
-% 0pt means it depends on current normal line spacing.
-%
-\newskip\multitableparskip
-\newskip\multitableparindent
-\newdimen\multitablecolspace
-\newskip\multitablelinespace
-\multitableparskip=0pt
-\multitableparindent=6pt
-\multitablecolspace=12pt
-\multitablelinespace=0pt
-
-% Macros used to set up halign preamble:
-%
-\let\endsetuptable\relax
-\def\xendsetuptable{\endsetuptable}
-\let\columnfractions\relax
-\def\xcolumnfractions{\columnfractions}
-\newif\ifsetpercent
-
-% #1 is the @columnfraction, usually a decimal number like .5, but might
-% be just 1. We just use it, whatever it is.
-%
-\def\pickupwholefraction#1 {%
- \global\advance\colcount by 1
- \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}%
- \setuptable
-}
-
-\newcount\colcount
-\def\setuptable#1{%
- \def\firstarg{#1}%
- \ifx\firstarg\xendsetuptable
- \let\go = \relax
- \else
- \ifx\firstarg\xcolumnfractions
- \global\setpercenttrue
- \else
- \ifsetpercent
- \let\go\pickupwholefraction
- \else
- \global\advance\colcount by 1
- \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a
- % separator; typically that is always in the input, anyway.
- \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}%
- \fi
- \fi
- \ifx\go\pickupwholefraction
- % Put the argument back for the \pickupwholefraction call, so
- % we'll always have a period there to be parsed.
- \def\go{\pickupwholefraction#1}%
- \else
- \let\go = \setuptable
- \fi%
- \fi
- \go
-}
-
-% multitable-only commands.
-%
-% @headitem starts a heading row, which we typeset in bold. Assignments
-% have to be global since we are inside the implicit group of an
-% alignment entry. \everycr below resets \everytab so we don't have to
-% undo it ourselves.
-\def\headitemfont{\b}% for people to use in the template row; not changeable
-\def\headitem{%
- \checkenv\multitable
- \crcr
- \gdef\headitemcrhook{\nobreak}% attempt to avoid page break after headings
- \global\everytab={\bf}% can't use \headitemfont since the parsing differs
- \the\everytab % for the first item
-}%
-%
-% default for tables with no headings.
-\let\headitemcrhook=\relax
-%
-% A \tab used to include \hskip1sp. But then the space in a template
-% line is not enough. That is bad. So let's go back to just `&' until
-% we again encounter the problem the 1sp was intended to solve.
-% --karl, nathan@acm.org, 20apr99.
-\def\tab{\checkenv\multitable &\the\everytab}%
-
-% @multitable ... @end multitable definitions:
-%
-\newtoks\everytab % insert after every tab.
-%
-\envdef\multitable{%
- \vskip\parskip
- \startsavinginserts
- %
- % @item within a multitable starts a normal row.
- % We use \def instead of \let so that if one of the multitable entries
- % contains an @itemize, we don't choke on the \item (seen as \crcr aka
- % \endtemplate) expanding \doitemize.
- \def\item{\crcr}%
- %
- \tolerance=9500
- \hbadness=9500
- \setmultitablespacing
- \parskip=\multitableparskip
- \parindent=\multitableparindent
- \overfullrule=0pt
- \global\colcount=0
- %
- \everycr = {%
- \noalign{%
- \global\everytab={}% Reset from possible headitem.
- \global\colcount=0 % Reset the column counter.
- %
- % Check for saved footnotes, etc.:
- \checkinserts
- %
- % Perhaps a \nobreak, then reset:
- \headitemcrhook
- \global\let\headitemcrhook=\relax
- }%
- }%
- %
- \parsearg\domultitable
-}
-\def\domultitable#1{%
- % To parse everything between @multitable and @item:
- \setuptable#1 \endsetuptable
- %
- % This preamble sets up a generic column definition, which will
- % be used as many times as user calls for columns.
- % \vtop will set a single line and will also let text wrap and
- % continue for many paragraphs if desired.
- \halign\bgroup &%
- \global\advance\colcount by 1
- \multistrut
- \vtop{%
- % Use the current \colcount to find the correct column width:
- \hsize=\expandafter\csname col\the\colcount\endcsname
- %
- % In order to keep entries from bumping into each other
- % we will add a \leftskip of \multitablecolspace to all columns after
- % the first one.
- %
- % If a template has been used, we will add \multitablecolspace
- % to the width of each template entry.
- %
- % If the user has set preamble in terms of percent of \hsize we will
- % use that dimension as the width of the column, and the \leftskip
- % will keep entries from bumping into each other. Table will start at
- % left margin and final column will justify at right margin.
- %
- % Make sure we don't inherit \rightskip from the outer environment.
- \rightskip=0pt
- \ifnum\colcount=1
- % The first column will be indented with the surrounding text.
- \advance\hsize by\leftskip
- \else
- \ifsetpercent \else
- % If user has not set preamble in terms of percent of \hsize
- % we will advance \hsize by \multitablecolspace.
- \advance\hsize by \multitablecolspace
- \fi
- % In either case we will make \leftskip=\multitablecolspace:
- \leftskip=\multitablecolspace
- \fi
- % Ignoring space at the beginning and end avoids an occasional spurious
- % blank line, when TeX decides to break the line at the space before the
- % box from the multistrut, so the strut ends up on a line by itself.
- % For example:
- % @multitable @columnfractions .11 .89
- % @item @code{#}
- % @tab Legal holiday which is valid in major parts of the whole country.
- % Is automatically provided with highlighting sequences respectively
- % marking characters.
- \noindent\ignorespaces##\unskip\multistrut
- }\cr
-}
-\def\Emultitable{%
- \crcr
- \egroup % end the \halign
- \global\setpercentfalse
-}
-
-\def\setmultitablespacing{%
- \def\multistrut{\strut}% just use the standard line spacing
- %
- % Compute \multitablelinespace (if not defined by user) for use in
- % \multitableparskip calculation. We used define \multistrut based on
- % this, but (ironically) that caused the spacing to be off.
- % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100.
-\ifdim\multitablelinespace=0pt
-\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip
-\global\advance\multitablelinespace by-\ht0
-\fi
-% Test to see if parskip is larger than space between lines of
-% table. If not, do nothing.
-% If so, set to same dimension as multitablelinespace.
-\ifdim\multitableparskip>\multitablelinespace
-\global\multitableparskip=\multitablelinespace
-\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
- % than skip between lines in the table.
-\fi%
-\ifdim\multitableparskip=0pt
-\global\multitableparskip=\multitablelinespace
-\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller
- % than skip between lines in the table.
-\fi}
-
-
-\message{conditionals,}
-
-% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext,
-% @ifnotxml always succeed. They currently do nothing; we don't
-% attempt to check whether the conditionals are properly nested. But we
-% have to remember that they are conditionals, so that @end doesn't
-% attempt to close an environment group.
-%
-\def\makecond#1{%
- \expandafter\let\csname #1\endcsname = \relax
- \expandafter\let\csname iscond.#1\endcsname = 1
-}
-\makecond{iftex}
-\makecond{ifnotdocbook}
-\makecond{ifnothtml}
-\makecond{ifnotinfo}
-\makecond{ifnotplaintext}
-\makecond{ifnotxml}
-
-% Ignore @ignore, @ifhtml, @ifinfo, and the like.
-%
-\def\direntry{\doignore{direntry}}
-\def\documentdescription{\doignore{documentdescription}}
-\def\docbook{\doignore{docbook}}
-\def\html{\doignore{html}}
-\def\ifdocbook{\doignore{ifdocbook}}
-\def\ifhtml{\doignore{ifhtml}}
-\def\ifinfo{\doignore{ifinfo}}
-\def\ifnottex{\doignore{ifnottex}}
-\def\ifplaintext{\doignore{ifplaintext}}
-\def\ifxml{\doignore{ifxml}}
-\def\ignore{\doignore{ignore}}
-\def\menu{\doignore{menu}}
-\def\xml{\doignore{xml}}
-
-% Ignore text until a line `@end #1', keeping track of nested conditionals.
-%
-% A count to remember the depth of nesting.
-\newcount\doignorecount
-
-\def\doignore#1{\begingroup
- % Scan in ``verbatim'' mode:
- \obeylines
- \catcode`\@ = \other
- \catcode`\{ = \other
- \catcode`\} = \other
- %
- % Make sure that spaces turn into tokens that match what \doignoretext wants.
- \spaceisspace
- %
- % Count number of #1's that we've seen.
- \doignorecount = 0
- %
- % Swallow text until we reach the matching `@end #1'.
- \dodoignore{#1}%
-}
-
-{ \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source.
- \obeylines %
- %
- \gdef\dodoignore#1{%
- % #1 contains the command name as a string, e.g., `ifinfo'.
- %
- % Define a command to find the next `@end #1'.
- \long\def\doignoretext##1^^M@end #1{%
- \doignoretextyyy##1^^M@#1\_STOP_}%
- %
- % And this command to find another #1 command, at the beginning of a
- % line. (Otherwise, we would consider a line `@c @ifset', for
- % example, to count as an @ifset for nesting.)
- \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}%
- %
- % And now expand that command.
- \doignoretext ^^M%
- }%
-}
-
-\def\doignoreyyy#1{%
- \def\temp{#1}%
- \ifx\temp\empty % Nothing found.
- \let\next\doignoretextzzz
- \else % Found a nested condition, ...
- \advance\doignorecount by 1
- \let\next\doignoretextyyy % ..., look for another.
- % If we're here, #1 ends with ^^M\ifinfo (for example).
- \fi
- \next #1% the token \_STOP_ is present just after this macro.
-}
-
-% We have to swallow the remaining "\_STOP_".
-%
-\def\doignoretextzzz#1{%
- \ifnum\doignorecount = 0 % We have just found the outermost @end.
- \let\next\enddoignore
- \else % Still inside a nested condition.
- \advance\doignorecount by -1
- \let\next\doignoretext % Look for the next @end.
- \fi
- \next
-}
-
-% Finish off ignored text.
-{ \obeylines%
- % Ignore anything after the last `@end #1'; this matters in verbatim
- % environments, where otherwise the newline after an ignored conditional
- % would result in a blank line in the output.
- \gdef\enddoignore#1^^M{\endgroup\ignorespaces}%
-}
-
-
-% @set VAR sets the variable VAR to an empty value.
-% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE.
-%
-% Since we want to separate VAR from REST-OF-LINE (which might be
-% empty), we can't just use \parsearg; we have to insert a space of our
-% own to delimit the rest of the line, and then take it out again if we
-% didn't need it.
-% We rely on the fact that \parsearg sets \catcode`\ =10.
-%
-\parseargdef\set{\setyyy#1 \endsetyyy}
-\def\setyyy#1 #2\endsetyyy{%
- {%
- \makevalueexpandable
- \def\temp{#2}%
- \edef\next{\gdef\makecsname{SET#1}}%
- \ifx\temp\empty
- \next{}%
- \else
- \setzzz#2\endsetzzz
- \fi
- }%
-}
-% Remove the trailing space \setxxx inserted.
-\def\setzzz#1 \endsetzzz{\next{#1}}
-
-% @clear VAR clears (i.e., unsets) the variable VAR.
-%
-\parseargdef\clear{%
- {%
- \makevalueexpandable
- \global\expandafter\let\csname SET#1\endcsname=\relax
- }%
-}
-
-% @value{foo} gets the text saved in variable foo.
-\def\value{\begingroup\makevalueexpandable\valuexxx}
-\def\valuexxx#1{\expandablevalue{#1}\endgroup}
-{
- \catcode`\-=\active \catcode`\_=\active
- %
- \gdef\makevalueexpandable{%
- \let\value = \expandablevalue
- % We don't want these characters active, ...
- \catcode`\-=\other \catcode`\_=\other
- % ..., but we might end up with active ones in the argument if
- % we're called from @code, as @code{@value{foo-bar_}}, though.
- % So \let them to their normal equivalents.
- \let-\normaldash \let_\normalunderscore
- }
-}
-
-\def\expandablevalue#1{%
- \expandafter\ifx\csname SET#1\endcsname\relax
- {[No value for ``#1'']}%
- \message{Variable `#1', used in @value, is not set.}%
- \else
- \csname SET#1\endcsname
- \fi
-}
-
-% Like \expandablevalue, but completely expandable (the \message in the
-% definition above operates at the execution level of TeX). Used when
-% writing to auxiliary files, due to the expansion that \write does.
-% If flag is undefined, pass through an unexpanded @value command: maybe it
-% will be set by the time it is read back in.
-%
-% NB flag names containing - or _ may not work here.
-\def\dummyvalue#1{%
- \expandafter\ifx\csname SET#1\endcsname\relax
- \string\value{#1}%
- \else
- \csname SET#1\endcsname
- \fi
-}
-
-% Used for @value's in index entries to form the sort key: expand the @value
-% if possible, otherwise sort late.
-\def\indexnofontsvalue#1{%
- \expandafter\ifx\csname SET#1\endcsname\relax
- ZZZZZZZ%
- \else
- \csname SET#1\endcsname
- \fi
-}
-
-% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined
-% with @set.
-%
-% To get the special treatment we need for `@end ifset,' we call
-% \makecond and then redefine.
-%
-\makecond{ifset}
-\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}}
-\def\doifset#1#2{%
- {%
- \makevalueexpandable
- \let\next=\empty
- \expandafter\ifx\csname SET#2\endcsname\relax
- #1% If not set, redefine \next.
- \fi
- \expandafter
- }\next
-}
-\def\ifsetfail{\doignore{ifset}}
-
-% @ifclear VAR ... @end executes the `...' iff VAR has never been
-% defined with @set, or has been undefined with @clear.
-%
-% The `\else' inside the `\doifset' parameter is a trick to reuse the
-% above code: if the variable is not set, do nothing, if it is set,
-% then redefine \next to \ifclearfail.
-%
-\makecond{ifclear}
-\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}}
-\def\ifclearfail{\doignore{ifclear}}
-
-% @ifcommandisdefined CMD ... @end executes the `...' if CMD (written
-% without the @) is in fact defined. We can only feasibly check at the
-% TeX level, so something like `mathcode' is going to considered
-% defined even though it is not a Texinfo command.
-%
-\makecond{ifcommanddefined}
-\def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}}
-%
-\def\doifcmddefined#1#2{{%
- \makevalueexpandable
- \let\next=\empty
- \expandafter\ifx\csname #2\endcsname\relax
- #1% If not defined, \let\next as above.
- \fi
- \expandafter
- }\next
-}
-\def\ifcmddefinedfail{\doignore{ifcommanddefined}}
-
-% @ifcommandnotdefined CMD ... handled similar to @ifclear above.
-\makecond{ifcommandnotdefined}
-\def\ifcommandnotdefined{%
- \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}}
-\def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}}
-
-% Set the `txicommandconditionals' variable, so documents have a way to
-% test if the @ifcommand...defined conditionals are available.
-\set txicommandconditionals
-
-% @dircategory CATEGORY -- specify a category of the dir file
-% which this file should belong to. Ignore this in TeX.
-\let\dircategory=\comment
-
-% @defininfoenclose.
-\let\definfoenclose=\comment
-
-
-\message{indexing,}
-% Index generation facilities
-
-% Define \newwrite to be identical to plain tex's \newwrite
-% except not \outer, so it can be used within macros and \if's.
-\edef\newwrite{\makecsname{ptexnewwrite}}
-
-% \newindex {foo} defines an index named IX.
-% It automatically defines \IXindex such that
-% \IXindex ...rest of line... puts an entry in the index IX.
-% It also defines \IXindfile to be the number of the output channel for
-% the file that accumulates this index. The file's extension is IX.
-% The name of an index should be no more than 2 characters long
-% for the sake of vms.
-%
-\def\newindex#1{%
- \expandafter\chardef\csname#1indfile\endcsname=0
- \expandafter\xdef\csname#1index\endcsname{% % Define @#1index
- \noexpand\doindex{#1}}
-}
-
-% @defindex foo == \newindex{foo}
-%
-\def\defindex{\parsearg\newindex}
-
-% Define @defcodeindex, like @defindex except put all entries in @code.
-%
-\def\defcodeindex{\parsearg\newcodeindex}
-%
-\def\newcodeindex#1{%
- \expandafter\chardef\csname#1indfile\endcsname=0
- \expandafter\xdef\csname#1index\endcsname{%
- \noexpand\docodeindex{#1}}%
-}
-
-% The default indices:
-\newindex{cp}% concepts,
-\newcodeindex{fn}% functions,
-\newcodeindex{vr}% variables,
-\newcodeindex{tp}% types,
-\newcodeindex{ky}% keys
-\newcodeindex{pg}% and programs.
-
-
-% @synindex foo bar makes index foo feed into index bar.
-% Do this instead of @defindex foo if you don't want it as a separate index.
-%
-% @syncodeindex foo bar similar, but put all entries made for index foo
-% inside @code.
-%
-\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}}
-\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}}
-
-% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo),
-% #3 the target index (bar).
-\def\dosynindex#1#2#3{%
- \requireopenindexfile{#3}%
- % redefine \fooindfile:
- \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname
- \expandafter\let\csname#2indfile\endcsname=\temp
- % redefine \fooindex:
- \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}%
-}
-
-% Define \doindex, the driver for all index macros.
-% Argument #1 is generated by the calling \fooindex macro,
-% and it is the two-letter name of the index.
-
-\def\doindex#1{\edef\indexname{#1}\parsearg\doindexxxx}
-\def\doindexxxx #1{\doind{\indexname}{#1}}
-
-% like the previous two, but they put @code around the argument.
-\def\docodeindex#1{\edef\indexname{#1}\parsearg\docodeindexxxx}
-\def\docodeindexxxx #1{\doind{\indexname}{\code{#1}}}
-
-
-% Used for the aux, toc and index files to prevent expansion of Texinfo
-% commands.
-%
-\def\atdummies{%
- \definedummyletter\@%
- \definedummyletter\ %
- \definedummyletter\{%
- \definedummyletter\}%
- \definedummyletter\&%
- %
- % Do the redefinitions.
- \definedummies
- \otherbackslash
-}
-
-% \definedummyword defines \#1 as \string\#1\space, thus effectively
-% preventing its expansion. This is used only for control words,
-% not control letters, because the \space would be incorrect for
-% control characters, but is needed to separate the control word
-% from whatever follows.
-%
-% These can be used both for control words that take an argument and
-% those that do not. If it is followed by {arg} in the input, then
-% that will dutifully get written to the index (or wherever).
-%
-% For control letters, we have \definedummyletter, which omits the
-% space.
-%
-\def\definedummyword #1{\def#1{\string#1\space}}%
-\def\definedummyletter#1{\def#1{\string#1}}%
-\let\definedummyaccent\definedummyletter
-
-% Called from \atdummies to prevent the expansion of commands.
-%
-\def\definedummies{%
- %
- \let\commondummyword\definedummyword
- \let\commondummyletter\definedummyletter
- \let\commondummyaccent\definedummyaccent
- \commondummiesnofonts
- %
- \definedummyletter\_%
- \definedummyletter\-%
- %
- % Non-English letters.
- \definedummyword\AA
- \definedummyword\AE
- \definedummyword\DH
- \definedummyword\L
- \definedummyword\O
- \definedummyword\OE
- \definedummyword\TH
- \definedummyword\aa
- \definedummyword\ae
- \definedummyword\dh
- \definedummyword\exclamdown
- \definedummyword\l
- \definedummyword\o
- \definedummyword\oe
- \definedummyword\ordf
- \definedummyword\ordm
- \definedummyword\questiondown
- \definedummyword\ss
- \definedummyword\th
- %
- % Although these internal commands shouldn't show up, sometimes they do.
- \definedummyword\bf
- \definedummyword\gtr
- \definedummyword\hat
- \definedummyword\less
- \definedummyword\sf
- \definedummyword\sl
- \definedummyword\tclose
- \definedummyword\tt
- %
- \definedummyword\LaTeX
- \definedummyword\TeX
- %
- % Assorted special characters.
- \definedummyword\ampchar
- \definedummyword\atchar
- \definedummyword\arrow
- \definedummyword\backslashchar
- \definedummyword\bullet
- \definedummyword\comma
- \definedummyword\copyright
- \definedummyword\registeredsymbol
- \definedummyword\dots
- \definedummyword\enddots
- \definedummyword\entrybreak
- \definedummyword\equiv
- \definedummyword\error
- \definedummyword\euro
- \definedummyword\expansion
- \definedummyword\geq
- \definedummyword\guillemetleft
- \definedummyword\guillemetright
- \definedummyword\guilsinglleft
- \definedummyword\guilsinglright
- \definedummyword\lbracechar
- \definedummyword\leq
- \definedummyword\mathopsup
- \definedummyword\minus
- \definedummyword\ogonek
- \definedummyword\pounds
- \definedummyword\point
- \definedummyword\print
- \definedummyword\quotedblbase
- \definedummyword\quotedblleft
- \definedummyword\quotedblright
- \definedummyword\quoteleft
- \definedummyword\quoteright
- \definedummyword\quotesinglbase
- \definedummyword\rbracechar
- \definedummyword\result
- \definedummyword\sub
- \definedummyword\sup
- \definedummyword\textdegree
- %
- \definedummyword\subentry
- %
- % We want to disable all macros so that they are not expanded by \write.
- \macrolist
- \let\value\dummyvalue
- %
- \normalturnoffactive
-}
-
-% \commondummiesnofonts: common to \definedummies and \indexnofonts.
-% Define \commondummyletter, \commondummyaccent and \commondummyword before
-% using. Used for accents, font commands, and various control letters.
-%
-\def\commondummiesnofonts{%
- % Control letters and accents.
- \commondummyletter\!%
- \commondummyaccent\"%
- \commondummyaccent\'%
- \commondummyletter\*%
- \commondummyaccent\,%
- \commondummyletter\.%
- \commondummyletter\/%
- \commondummyletter\:%
- \commondummyaccent\=%
- \commondummyletter\?%
- \commondummyaccent\^%
- \commondummyaccent\`%
- \commondummyaccent\~%
- \commondummyword\u
- \commondummyword\v
- \commondummyword\H
- \commondummyword\dotaccent
- \commondummyword\ogonek
- \commondummyword\ringaccent
- \commondummyword\tieaccent
- \commondummyword\ubaraccent
- \commondummyword\udotaccent
- \commondummyword\dotless
- %
- % Texinfo font commands.
- \commondummyword\b
- \commondummyword\i
- \commondummyword\r
- \commondummyword\sansserif
- \commondummyword\sc
- \commondummyword\slanted
- \commondummyword\t
- %
- % Commands that take arguments.
- \commondummyword\abbr
- \commondummyword\acronym
- \commondummyword\anchor
- \commondummyword\cite
- \commondummyword\code
- \commondummyword\command
- \commondummyword\dfn
- \commondummyword\dmn
- \commondummyword\email
- \commondummyword\emph
- \commondummyword\env
- \commondummyword\file
- \commondummyword\image
- \commondummyword\indicateurl
- \commondummyword\inforef
- \commondummyword\kbd
- \commondummyword\key
- \commondummyword\math
- \commondummyword\option
- \commondummyword\pxref
- \commondummyword\ref
- \commondummyword\samp
- \commondummyword\strong
- \commondummyword\tie
- \commondummyword\U
- \commondummyword\uref
- \commondummyword\url
- \commondummyword\var
- \commondummyword\verb
- \commondummyword\w
- \commondummyword\xref
-}
-
-\let\indexlbrace\relax
-\let\indexrbrace\relax
-\let\indexatchar\relax
-\let\indexbackslash\relax
-
-{\catcode`\@=0
-\catcode`\\=13
- @gdef@backslashdisappear{@def\{}}
-}
-
-{
-\catcode`\<=13
-\catcode`\-=13
-\catcode`\`=13
- \gdef\indexnonalnumdisappear{%
- \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax\else
- % @set txiindexlquoteignore makes us ignore left quotes in the sort term.
- % (Introduced for FSFS 2nd ed.)
- \let`=\empty
- \fi
- %
- \expandafter\ifx\csname SETtxiindexbackslashignore\endcsname\relax\else
- \backslashdisappear
- \fi
- %
- \expandafter\ifx\csname SETtxiindexhyphenignore\endcsname\relax\else
- \def-{}%
- \fi
- \expandafter\ifx\csname SETtxiindexlessthanignore\endcsname\relax\else
- \def<{}%
- \fi
- \expandafter\ifx\csname SETtxiindexatsignignore\endcsname\relax\else
- \def\@{}%
- \fi
- }
-
- \gdef\indexnonalnumreappear{%
- \let-\normaldash
- \let<\normalless
- }
-}
-
-
-% \indexnofonts is used when outputting the strings to sort the index
-% by, and when constructing control sequence names. It eliminates all
-% control sequences and just writes whatever the best ASCII sort string
-% would be for a given command (usually its argument).
-%
-\def\indexnofonts{%
- % Accent commands should become @asis.
- \def\commondummyaccent##1{\let##1\asis}%
- % We can just ignore other control letters.
- \def\commondummyletter##1{\let##1\empty}%
- % All control words become @asis by default; overrides below.
- \let\commondummyword\commondummyaccent
- \commondummiesnofonts
- %
- % Don't no-op \tt, since it isn't a user-level command
- % and is used in the definitions of the active chars like <, >, |, etc.
- % Likewise with the other plain tex font commands.
- %\let\tt=\asis
- %
- \def\ { }%
- \def\@{@}%
- \def\_{\normalunderscore}%
- \def\-{}% @- shouldn't affect sorting
- %
- \uccode`\1=`\{ \uppercase{\def\{{1}}%
- \uccode`\1=`\} \uppercase{\def\}{1}}%
- \let\lbracechar\{%
- \let\rbracechar\}%
- %
- % Non-English letters.
- \def\AA{AA}%
- \def\AE{AE}%
- \def\DH{DZZ}%
- \def\L{L}%
- \def\OE{OE}%
- \def\O{O}%
- \def\TH{TH}%
- \def\aa{aa}%
- \def\ae{ae}%
- \def\dh{dzz}%
- \def\exclamdown{!}%
- \def\l{l}%
- \def\oe{oe}%
- \def\ordf{a}%
- \def\ordm{o}%
- \def\o{o}%
- \def\questiondown{?}%
- \def\ss{ss}%
- \def\th{th}%
- %
- \def\LaTeX{LaTeX}%
- \def\TeX{TeX}%
- %
- % Assorted special characters. \defglyph gives the control sequence a
- % definition that removes the {} that follows its use.
- \defglyph\atchar{@}%
- \defglyph\arrow{->}%
- \defglyph\bullet{bullet}%
- \defglyph\comma{,}%
- \defglyph\copyright{copyright}%
- \defglyph\dots{...}%
- \defglyph\enddots{...}%
- \defglyph\equiv{==}%
- \defglyph\error{error}%
- \defglyph\euro{euro}%
- \defglyph\expansion{==>}%
- \defglyph\geq{>=}%
- \defglyph\guillemetleft{<<}%
- \defglyph\guillemetright{>>}%
- \defglyph\guilsinglleft{<}%
- \defglyph\guilsinglright{>}%
- \defglyph\leq{<=}%
- \defglyph\lbracechar{\{}%
- \defglyph\minus{-}%
- \defglyph\point{.}%
- \defglyph\pounds{pounds}%
- \defglyph\print{-|}%
- \defglyph\quotedblbase{"}%
- \defglyph\quotedblleft{"}%
- \defglyph\quotedblright{"}%
- \defglyph\quoteleft{`}%
- \defglyph\quoteright{'}%
- \defglyph\quotesinglbase{,}%
- \defglyph\rbracechar{\}}%
- \defglyph\registeredsymbol{R}%
- \defglyph\result{=>}%
- \defglyph\textdegree{o}%
- %
- % We need to get rid of all macros, leaving only the arguments (if present).
- % Of course this is not nearly correct, but it is the best we can do for now.
- % makeinfo does not expand macros in the argument to @deffn, which ends up
- % writing an index entry, and texindex isn't prepared for an index sort entry
- % that starts with \.
- %
- % Since macro invocations are followed by braces, we can just redefine them
- % to take a single TeX argument. The case of a macro invocation that
- % goes to end-of-line is not handled.
- %
- \macrolist
- \let\value\indexnofontsvalue
-}
-\def\defglyph#1#2{\def#1##1{#2}} % see above
-
-
-
-
-% #1 is the index name, #2 is the entry text.
-\def\doind#1#2{%
- \iflinks
- {%
- %
- \requireopenindexfile{#1}%
- \edef\writeto{\csname#1indfile\endcsname}%
- %
- \def\indextext{#2}%
- \safewhatsit\doindwrite
- }%
- \fi
-}
-
-% Check if an index file has been opened, and if not, open it.
-\def\requireopenindexfile#1{%
-\ifnum\csname #1indfile\endcsname=0
- \expandafter\newwrite \csname#1indfile\endcsname
- \edef\suffix{#1}%
- % A .fls suffix would conflict with the file extension for the output
- % of -recorder, so use .f1s instead.
- \ifx\suffix\indexisfl\def\suffix{f1}\fi
- % Open the file
- \immediate\openout\csname#1indfile\endcsname \jobname.\suffix
- % Using \immediate above here prevents an object entering into the current
- % box, which could confound checks such as those in \safewhatsit for
- % preceding skips.
- \typeout{Writing index file \jobname.\suffix}%
-\fi}
-\def\indexisfl{fl}
-
-% Definition for writing index entry sort key.
-{
-\catcode`\-=13
-\gdef\indexwritesortas{%
- \begingroup
- \indexnonalnumreappear
- \indexwritesortasxxx}
-\gdef\indexwritesortasxxx#1{%
- \xdef\indexsortkey{#1}\endgroup}
-}
-
-\def\indexwriteseealso#1{
- \gdef\pagenumbertext{\string\seealso{#1}}%
-}
-\def\indexwriteseeentry#1{
- \gdef\pagenumbertext{\string\seeentry{#1}}%
-}
-
-% The default definitions
-\def\sortas#1{}%
-\def\seealso#1{\i{\putwordSeeAlso}\ #1}% for sorted index file only
-\def\putwordSeeAlso{See also}
-\def\seeentry#1{\i{\putwordSee}\ #1}% for sorted index file only
-
-
-% Given index entry text like "aaa @subentry bbb @sortas{ZZZ}":
-% * Set \bracedtext to "{aaa}{bbb}"
-% * Set \fullindexsortkey to "aaa @subentry ZZZ"
-% * If @seealso occurs, set \pagenumbertext
-%
-\def\splitindexentry#1{%
- \gdef\fullindexsortkey{}%
- \xdef\bracedtext{}%
- \def\sep{}%
- \def\seealso##1{}%
- \def\seeentry##1{}%
- \expandafter\doindexsegment#1\subentry\finish\subentry
-}
-
-% append the results from the next segment
-\def\doindexsegment#1\subentry{%
- \def\segment{#1}%
- \ifx\segment\isfinish
- \else
- %
- % Fully expand the segment, throwing away any @sortas directives, and
- % trim spaces.
- \edef\trimmed{\segment}%
- \edef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
- %
- \xdef\bracedtext{\bracedtext{\trimmed}}%
- %
- % Get the string to sort by. Process the segment with all
- % font commands turned off.
- \bgroup
- \let\sortas\indexwritesortas
- \let\seealso\indexwriteseealso
- \let\seeentry\indexwriteseeentry
- \indexnofonts
- % The braces around the commands are recognized by texindex.
- \def\lbracechar{{\string\indexlbrace}}%
- \def\rbracechar{{\string\indexrbrace}}%
- \let\{=\lbracechar
- \let\}=\rbracechar
- \def\@{{\string\indexatchar}}%
- \def\atchar##1{\@}%
- \def\backslashchar{{\string\indexbackslash}}%
- \uccode`\~=`\\ \uppercase{\let~\backslashchar}%
- %
- \let\indexsortkey\empty
- \global\let\pagenumbertext\empty
- % Execute the segment and throw away the typeset output. This executes
- % any @sortas or @seealso commands in this segment.
- \setbox\dummybox = \hbox{\segment}%
- \ifx\indexsortkey\empty{%
- \indexnonalnumdisappear
- \xdef\trimmed{\segment}%
- \xdef\trimmed{\expandafter\eatspaces\expandafter{\trimmed}}%
- \xdef\indexsortkey{\trimmed}%
- \ifx\indexsortkey\empty\xdef\indexsortkey{ }\fi
- }\fi
- %
- % Append to \fullindexsortkey.
- \edef\tmp{\gdef\noexpand\fullindexsortkey{%
- \fullindexsortkey\sep\indexsortkey}}%
- \tmp
- \egroup
- \def\sep{\subentry}%
- %
- \expandafter\doindexsegment
- \fi
-}
-\def\isfinish{\finish}%
-\newbox\dummybox % used above
-
-\let\subentry\relax
-
-% Use \ instead of @ in index files. To support old texi2dvi and texindex.
-% This works without changing the escape character used in the toc or aux
-% files because the index entries are fully expanded here, and \string uses
-% the current value of \escapechar.
-\def\escapeisbackslash{\escapechar=`\\}
-
-% Use \ in index files by default. texi2dvi didn't support @ as the escape
-% character (as it checked for "\entry" in the files, and not "@entry"). When
-% the new version of texi2dvi has had a chance to become more prevalent, then
-% the escape character can change back to @ again. This should be an easy
-% change to make now because both @ and \ are only used as escape characters in
-% index files, never standing for themselves.
-%
-\set txiindexescapeisbackslash
-
-% Write the entry in \indextext to the index file.
-%
-\def\doindwrite{%
- \maybemarginindex
- %
- \atdummies
- %
- \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax\else
- \escapeisbackslash
- \fi
- %
- % For texindex which always views { and } as separators.
- \def\{{\lbracechar{}}%
- \def\}{\rbracechar{}}%
- \uccode`\~=`\\ \uppercase{\def~{\backslashchar{}}}%
- %
- % Split the entry into primary entry and any subentries, and get the index
- % sort key.
- \splitindexentry\indextext
- %
- % Set up the complete index entry, with both the sort key and
- % the original text, including any font commands. We write
- % three arguments to \entry to the .?? file (four in the
- % subentry case), texindex reduces to two when writing the .??s
- % sorted result.
- %
- \edef\temp{%
- \write\writeto{%
- \string\entry{\fullindexsortkey}%
- {\ifx\pagenumbertext\empty\noexpand\folio\else\pagenumbertext\fi}%
- \bracedtext}%
- }%
- \temp
-}
-
-% Put the index entry in the margin if desired (undocumented).
-\def\maybemarginindex{%
- \ifx\SETmarginindex\relax\else
- \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \relax\indextext}}%
- \fi
-}
-\let\SETmarginindex=\relax
-
-
-% Take care of unwanted page breaks/skips around a whatsit:
-%
-% If a skip is the last thing on the list now, preserve it
-% by backing up by \lastskip, doing the \write, then inserting
-% the skip again. Otherwise, the whatsit generated by the
-% \write or \pdfdest will make \lastskip zero. The result is that
-% sequences like this:
-% @end defun
-% @tindex whatever
-% @defun ...
-% will have extra space inserted, because the \medbreak in the
-% start of the @defun won't see the skip inserted by the @end of
-% the previous defun.
-%
-% But don't do any of this if we're not in vertical mode. We
-% don't want to do a \vskip and prematurely end a paragraph.
-%
-% Avoid page breaks due to these extra skips, too.
-%
-% But wait, there is a catch there:
-% We'll have to check whether \lastskip is zero skip. \ifdim is not
-% sufficient for this purpose, as it ignores stretch and shrink parts
-% of the skip. The only way seems to be to check the textual
-% representation of the skip.
-%
-% The following is almost like \def\zeroskipmacro{0.0pt} except that
-% the ``p'' and ``t'' characters have catcode \other, not 11 (letter).
-%
-\edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname}
-%
-\newskip\whatsitskip
-\newcount\whatsitpenalty
-%
-% ..., ready, GO:
-%
-\def\safewhatsit#1{\ifhmode
- #1%
- \else
- % \lastskip and \lastpenalty cannot both be nonzero simultaneously.
- \whatsitskip = \lastskip
- \edef\lastskipmacro{\the\lastskip}%
- \whatsitpenalty = \lastpenalty
- %
- % If \lastskip is nonzero, that means the last item was a
- % skip. And since a skip is discardable, that means this
- % -\whatsitskip glue we're inserting is preceded by a
- % non-discardable item, therefore it is not a potential
- % breakpoint, therefore no \nobreak needed.
- \ifx\lastskipmacro\zeroskipmacro
- \else
- \vskip-\whatsitskip
- \fi
- %
- #1%
- %
- \ifx\lastskipmacro\zeroskipmacro
- % If \lastskip was zero, perhaps the last item was a penalty, and
- % perhaps it was >=10000, e.g., a \nobreak. In that case, we want
- % to re-insert the same penalty (values >10000 are used for various
- % signals); since we just inserted a non-discardable item, any
- % following glue (such as a \parskip) would be a breakpoint. For example:
- % @deffn deffn-whatever
- % @vindex index-whatever
- % Description.
- % would allow a break between the index-whatever whatsit
- % and the "Description." paragraph.
- \ifnum\whatsitpenalty>9999 \penalty\whatsitpenalty \fi
- \else
- % On the other hand, if we had a nonzero \lastskip,
- % this make-up glue would be preceded by a non-discardable item
- % (the whatsit from the \write), so we must insert a \nobreak.
- \nobreak\vskip\whatsitskip
- \fi
-\fi}
-
-% The index entry written in the file actually looks like
-% \entry {sortstring}{page}{topic}
-% or
-% \entry {sortstring}{page}{topic}{subtopic}
-% The texindex program reads in these files and writes files
-% containing these kinds of lines:
-% \initial {c}
-% before the first topic whose initial is c
-% \entry {topic}{pagelist}
-% for a topic that is used without subtopics
-% \primary {topic}
-% \entry {topic}{}
-% for the beginning of a topic that is used with subtopics
-% \secondary {subtopic}{pagelist}
-% for each subtopic.
-% \secondary {subtopic}{}
-% for a subtopic with sub-subtopics
-% \tertiary {subtopic}{subsubtopic}{pagelist}
-% for each sub-subtopic.
-
-% Define the user-accessible indexing commands
-% @findex, @vindex, @kindex, @cindex.
-
-\def\findex {\fnindex}
-\def\kindex {\kyindex}
-\def\cindex {\cpindex}
-\def\vindex {\vrindex}
-\def\tindex {\tpindex}
-\def\pindex {\pgindex}
-
-% Define the macros used in formatting output of the sorted index material.
-
-% @printindex causes a particular index (the ??s file) to get printed.
-% It does not print any chapter heading (usually an @unnumbered).
-%
-\parseargdef\printindex{\begingroup
- \dobreak \chapheadingskip{10000}%
- %
- \smallfonts \rm
- \tolerance = 9500
- \plainfrenchspacing
- \everypar = {}% don't want the \kern\-parindent from indentation suppression.
- %
- % See comment in \requireopenindexfile.
- \def\indexname{#1}\ifx\indexname\indexisfl\def\indexname{f1}\fi
- %
- % See if the index file exists and is nonempty.
- \openin 1 \jobname.\indexname s
- \ifeof 1
- % \enddoublecolumns gets confused if there is no text in the index,
- % and it loses the chapter title and the aux file entries for the
- % index. The easiest way to prevent this problem is to make sure
- % there is some text.
- \putwordIndexNonexistent
- \typeout{No file \jobname.\indexname s.}%
- \else
- % If the index file exists but is empty, then \openin leaves \ifeof
- % false. We have to make TeX try to read something from the file, so
- % it can discover if there is anything in it.
- \read 1 to \thisline
- \ifeof 1
- \putwordIndexIsEmpty
- \else
- \expandafter\printindexzz\thisline\relax\relax\finish%
- \fi
- \fi
- \closein 1
-\endgroup}
-
-% If the index file starts with a backslash, forgo reading the index
-% file altogether. If somebody upgrades texinfo.tex they may still have
-% old index files using \ as the escape character. Reading this would
-% at best lead to typesetting garbage, at worst a TeX syntax error.
-\def\printindexzz#1#2\finish{%
- \expandafter\ifx\csname SETtxiindexescapeisbackslash\endcsname\relax
- \uccode`\~=`\\ \uppercase{\if\noexpand~}\noexpand#1
- \expandafter\ifx\csname SETtxiskipindexfileswithbackslash\endcsname\relax
-\errmessage{%
-ERROR: A sorted index file in an obsolete format was skipped.
-To fix this problem, please upgrade your version of 'texi2dvi'
-or 'texi2pdf' to that at <https://ftp.gnu.org/gnu/texinfo>.
-If you are using an old version of 'texindex' (part of the Texinfo
-distribution), you may also need to upgrade to a newer version (at least 6.0).
-You may be able to typeset the index if you run
-'texindex \jobname.\indexname' yourself.
-You could also try setting the 'txiindexescapeisbackslash' flag by
-running a command like
-'texi2dvi -t "@set txiindexescapeisbackslash" \jobname.texi'. If you do
-this, Texinfo will try to use index files in the old format.
-If you continue to have problems, deleting the index files and starting again
-might help (with 'rm \jobname.?? \jobname.??s')%
-}%
- \else
- (Skipped sorted index file in obsolete format)
- \fi
- \else
- \begindoublecolumns
- \input \jobname.\indexname s
- \enddoublecolumns
- \fi
- \else
- \begindoublecolumns
- \catcode`\\=0\relax
- \catcode`\@=12\relax
- \input \jobname.\indexname s
- \enddoublecolumns
- \fi
-}
-
-% These macros are used by the sorted index file itself.
-% Change them to control the appearance of the index.
-
-{\catcode`\/=13 \catcode`\-=13 \catcode`\^=13 \catcode`\~=13 \catcode`\_=13
-\catcode`\|=13 \catcode`\<=13 \catcode`\>=13 \catcode`\+=13 \catcode`\"=13
-\catcode`\$=3
-\gdef\initialglyphs{%
- % special control sequences used in the index sort key
- \let\indexlbrace\{%
- \let\indexrbrace\}%
- \let\indexatchar\@%
- \def\indexbackslash{\math{\backslash}}%
- %
- % Some changes for non-alphabetic characters. Using the glyphs from the
- % math fonts looks more consistent than the typewriter font used elsewhere
- % for these characters.
- \uccode`\~=`\\ \uppercase{\def~{\math{\backslash}}}
- %
- % In case @\ is used for backslash
- \uppercase{\let\\=~}
- % Can't get bold backslash so don't use bold forward slash
- \catcode`\/=13
- \def/{{\secrmnotbold \normalslash}}%
- \def-{{\normaldash\normaldash}}% en dash `--'
- \def^{{\chapbf \normalcaret}}%
- \def~{{\chapbf \normaltilde}}%
- \def\_{%
- \leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }%
- \def|{$\vert$}%
- \def<{$\less$}%
- \def>{$\gtr$}%
- \def+{$\normalplus$}%
-}}
-
-\def\initial{%
- \bgroup
- \initialglyphs
- \initialx
-}
-
-\def\initialx#1{%
- % Remove any glue we may have, we'll be inserting our own.
- \removelastskip
- %
- % We like breaks before the index initials, so insert a bonus.
- % The glue before the bonus allows a little bit of space at the
- % bottom of a column to reduce an increase in inter-line spacing.
- \nobreak
- \vskip 0pt plus 5\baselineskip
- \penalty -300
- \vskip 0pt plus -5\baselineskip
- %
- % Typeset the initial. Making this add up to a whole number of
- % baselineskips increases the chance of the dots lining up from column
- % to column. It still won't often be perfect, because of the stretch
- % we need before each entry, but it's better.
- %
- % No shrink because it confuses \balancecolumns.
- \vskip 1.67\baselineskip plus 1\baselineskip
- \leftline{\secfonts \kern-0.05em \secbf #1}%
- % \secfonts is inside the argument of \leftline so that the change of
- % \baselineskip will not affect any glue inserted before the vbox that
- % \leftline creates.
- % Do our best not to break after the initial.
- \nobreak
- \vskip .33\baselineskip plus .1\baselineskip
- \egroup % \initialglyphs
-}
-
-\newdimen\entryrightmargin
-\entryrightmargin=0pt
-
-% \entry typesets a paragraph consisting of the text (#1), dot leaders, and
-% then page number (#2) flushed to the right margin. It is used for index
-% and table of contents entries. The paragraph is indented by \leftskip.
-%
-\def\entry{%
- \begingroup
- %
- % Start a new paragraph if necessary, so our assignments below can't
- % affect previous text.
- \par
- %
- % No extra space above this paragraph.
- \parskip = 0in
- %
- % When reading the text of entry, convert explicit line breaks
- % from @* into spaces. The user might give these in long section
- % titles, for instance.
- \def\*{\unskip\space\ignorespaces}%
- \def\entrybreak{\hfil\break}% An undocumented command
- %
- % Swallow the left brace of the text (first parameter):
- \afterassignment\doentry
- \let\temp =
-}
-\def\entrybreak{\unskip\space\ignorespaces}%
-\def\doentry{%
- % Save the text of the entry
- \global\setbox\boxA=\hbox\bgroup
- \bgroup % Instead of the swallowed brace.
- \noindent
- \aftergroup\finishentry
- % And now comes the text of the entry.
- % Not absorbing as a macro argument reduces the chance of problems
- % with catcodes occurring.
-}
-{\catcode`\@=11
-\gdef\finishentry#1{%
- \egroup % end box A
- \dimen@ = \wd\boxA % Length of text of entry
- \global\setbox\boxA=\hbox\bgroup
- \unhbox\boxA
- % #1 is the page number.
- %
- % Get the width of the page numbers, and only use
- % leaders if they are present.
- \global\setbox\boxB = \hbox{#1}%
- \ifdim\wd\boxB = 0pt
- \null\nobreak\hfill\ %
- \else
- %
- \null\nobreak\indexdotfill % Have leaders before the page number.
- %
- \ifpdforxetex
- \pdfgettoks#1.%
- \hskip\skip\thinshrinkable\the\toksA
- \else
- \hskip\skip\thinshrinkable #1%
- \fi
- \fi
- \egroup % end \boxA
- \ifdim\wd\boxB = 0pt
- \noindent\unhbox\boxA\par
- \nobreak
- \else\bgroup
- % We want the text of the entries to be aligned to the left, and the
- % page numbers to be aligned to the right.
- %
- \parindent = 0pt
- \advance\leftskip by 0pt plus 1fil
- \advance\leftskip by 0pt plus -1fill
- \rightskip = 0pt plus -1fil
- \advance\rightskip by 0pt plus 1fill
- % Cause last line, which could consist of page numbers on their own
- % if the list of page numbers is long, to be aligned to the right.
- \parfillskip=0pt plus -1fill
- %
- \advance\rightskip by \entryrightmargin
- % Determine how far we can stretch into the margin.
- % This allows, e.g., "Appendix H GNU Free Documentation License" to
- % fit on one line in @letterpaper format.
- \ifdim\entryrightmargin>2.1em
- \dimen@i=2.1em
- \else
- \dimen@i=0em
- \fi
- \advance \parfillskip by 0pt minus 1\dimen@i
- %
- \dimen@ii = \hsize
- \advance\dimen@ii by -1\leftskip
- \advance\dimen@ii by -1\entryrightmargin
- \advance\dimen@ii by 1\dimen@i
- \ifdim\wd\boxA > \dimen@ii % If the entry doesn't fit in one line
- \ifdim\dimen@ > 0.8\dimen@ii % due to long index text
- % Try to split the text roughly evenly. \dimen@ will be the length of
- % the first line.
- \dimen@ = 0.7\dimen@
- \dimen@ii = \hsize
- \ifnum\dimen@>\dimen@ii
- % If the entry is too long (for example, if it needs more than
- % two lines), use all the space in the first line.
- \dimen@ = \dimen@ii
- \fi
- \advance\leftskip by 0pt plus 1fill % ragged right
- \advance \dimen@ by 1\rightskip
- \parshape = 2 0pt \dimen@ 0em \dimen@ii
- % Ideally we'd add a finite glue at the end of the first line only,
- % instead of using \parshape with explicit line lengths, but TeX
- % doesn't seem to provide a way to do such a thing.
- %
- % Indent all lines but the first one.
- \advance\leftskip by 1em
- \advance\parindent by -1em
- \fi\fi
- \indent % start paragraph
- \unhbox\boxA
- %
- % Do not prefer a separate line ending with a hyphen to fewer lines.
- \finalhyphendemerits = 0
- %
- % Word spacing - no stretch
- \spaceskip=\fontdimen2\font minus \fontdimen4\font
- %
- \linepenalty=1000 % Discourage line breaks.
- \hyphenpenalty=5000 % Discourage hyphenation.
- %
- \par % format the paragraph
- \egroup % The \vbox
- \fi
- \endgroup
-}}
-
-\newskip\thinshrinkable
-\skip\thinshrinkable=.15em minus .15em
-
-% Like plain.tex's \dotfill, except uses up at least 1 em.
-% The filll stretch here overpowers both the fil and fill stretch to push
-% the page number to the right.
-\def\indexdotfill{\cleaders
- \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1filll}
-
-
-\def\primary #1{\line{#1\hfil}}
-
-\def\secondary{\indententry{0.5cm}}
-\def\tertiary{\indententry{1cm}}
-
-\def\indententry#1#2#3{%
- \bgroup
- \leftskip=#1
- \entry{#2}{#3}%
- \egroup
-}
-
-% Define two-column mode, which we use to typeset indexes.
-% Adapted from the TeXbook, page 416, which is to say,
-% the manmac.tex format used to print the TeXbook itself.
-\catcode`\@=11 % private names
-
-\newbox\partialpage
-\newdimen\doublecolumnhsize
-
-\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns
- % If not much space left on page, start a new page.
- \ifdim\pagetotal>0.8\vsize\vfill\eject\fi
- %
- % Grab any single-column material above us.
- \output = {%
- \savetopmark
- %
- \global\setbox\partialpage = \vbox{%
- % Unvbox the main output page.
- \unvbox\PAGE
- \kern-\topskip \kern\baselineskip
- }%
- }%
- \eject % run that output routine to set \partialpage
- %
- % Use the double-column output routine for subsequent pages.
- \output = {\doublecolumnout}%
- %
- % Change the page size parameters. We could do this once outside this
- % routine, in each of @smallbook, @afourpaper, and the default 8.5x11
- % format, but then we repeat the same computation. Repeating a couple
- % of assignments once per index is clearly meaningless for the
- % execution time, so we may as well do it in one place.
- %
- % First we halve the line length, less a little for the gutter between
- % the columns. We compute the gutter based on the line length, so it
- % changes automatically with the paper format. The magic constant
- % below is chosen so that the gutter has the same value (well, +-<1pt)
- % as it did when we hard-coded it.
- %
- % We put the result in a separate register, \doublecolumhsize, so we
- % can restore it in \pagesofar, after \hsize itself has (potentially)
- % been clobbered.
- %
- \doublecolumnhsize = \hsize
- \advance\doublecolumnhsize by -.04154\hsize
- \divide\doublecolumnhsize by 2
- \hsize = \doublecolumnhsize
- %
- % Get the available space for the double columns -- the normal
- % (undoubled) page height minus any material left over from the
- % previous page.
- \advance\vsize by -\ht\partialpage
- \vsize = 2\vsize
- %
- % For the benefit of balancing columns
- \advance\baselineskip by 0pt plus 0.5pt
-}
-
-% The double-column output routine for all double-column pages except
-% the last, which is done by \balancecolumns.
-%
-\def\doublecolumnout{%
- %
- \savetopmark
- \splittopskip=\topskip \splitmaxdepth=\maxdepth
- \dimen@ = \vsize
- \divide\dimen@ by 2
- %
- % box0 will be the left-hand column, box2 the right.
- \setbox0=\vsplit\PAGE to\dimen@ \setbox2=\vsplit\PAGE to\dimen@
- \global\advance\vsize by 2\ht\partialpage
- \onepageout\pagesofar % empty except for the first time we are called
- \unvbox\PAGE
- \penalty\outputpenalty
-}
-%
-% Re-output the contents of the output page -- any previous material,
-% followed by the two boxes we just split, in box0 and box2.
-\def\pagesofar{%
- \unvbox\partialpage
- %
- \hsize = \doublecolumnhsize
- \wd0=\hsize \wd2=\hsize
- \hbox to\txipagewidth{\box0\hfil\box2}%
-}
-
-
-% Finished with double columns.
-\def\enddoublecolumns{%
- % The following penalty ensures that the page builder is exercised
- % _before_ we change the output routine. This is necessary in the
- % following situation:
- %
- % The last section of the index consists only of a single entry.
- % Before this section, \pagetotal is less than \pagegoal, so no
- % break occurs before the last section starts. However, the last
- % section, consisting of \initial and the single \entry, does not
- % fit on the page and has to be broken off. Without the following
- % penalty the page builder will not be exercised until \eject
- % below, and by that time we'll already have changed the output
- % routine to the \balancecolumns version, so the next-to-last
- % double-column page will be processed with \balancecolumns, which
- % is wrong: The two columns will go to the main vertical list, with
- % the broken-off section in the recent contributions. As soon as
- % the output routine finishes, TeX starts reconsidering the page
- % break. The two columns and the broken-off section both fit on the
- % page, because the two columns now take up only half of the page
- % goal. When TeX sees \eject from below which follows the final
- % section, it invokes the new output routine that we've set after
- % \balancecolumns below; \onepageout will try to fit the two columns
- % and the final section into the vbox of \txipageheight (see
- % \pagebody), causing an overfull box.
- %
- % Note that glue won't work here, because glue does not exercise the
- % page builder, unlike penalties (see The TeXbook, pp. 280-281).
- \penalty0
- %
- \output = {%
- % Split the last of the double-column material.
- \savetopmark
- \balancecolumns
- }%
- \eject % call the \output just set
- \ifdim\pagetotal=0pt
- % Having called \balancecolumns once, we do not
- % want to call it again. Therefore, reset \output to its normal
- % definition right away.
- \global\output=\expandafter{\the\defaultoutput}
- %
- \endgroup % started in \begindoublecolumns
- % Leave the double-column material on the current page, no automatic
- % page break.
- \box\balancedcolumns
- %
- % \pagegoal was set to the doubled \vsize above, since we restarted
- % the current page. We're now back to normal single-column
- % typesetting, so reset \pagegoal to the normal \vsize.
- \global\vsize = \txipageheight %
- \pagegoal = \txipageheight %
- \else
- % We had some left-over material. This might happen when \doublecolumnout
- % is called in \balancecolumns. Try again.
- \expandafter\enddoublecolumns
- \fi
-}
-\newbox\balancedcolumns
-\setbox\balancedcolumns=\vbox{shouldnt see this}%
-%
-% Only called for the last of the double column material. \doublecolumnout
-% does the others.
-\def\balancecolumns{%
- \setbox0 = \vbox{\unvbox\PAGE}% like \box255 but more efficient, see p.120.
- \dimen@ = \ht0
- \ifdim\dimen@<7\baselineskip
- % Don't split a short final column in two.
- \setbox2=\vbox{}%
- \global\setbox\balancedcolumns=\vbox{\pagesofar}%
- \else
- % double the leading vertical space
- \advance\dimen@ by \topskip
- \advance\dimen@ by-\baselineskip
- \divide\dimen@ by 2 % target to split to
- \dimen@ii = \dimen@
- \splittopskip = \topskip
- % Loop until left column is at least as high as the right column.
- {%
- \vbadness = 10000
- \loop
- \global\setbox3 = \copy0
- \global\setbox1 = \vsplit3 to \dimen@
- \ifdim\ht1<\ht3
- \global\advance\dimen@ by 1pt
- \repeat
- }%
- % Now the left column is in box 1, and the right column in box 3.
- %
- % Check whether the left column has come out higher than the page itself.
- % (Note that we have doubled \vsize for the double columns, so
- % the actual height of the page is 0.5\vsize).
- \ifdim2\ht1>\vsize
- % It appears that we have been called upon to balance too much material.
- % Output some of it with \doublecolumnout, leaving the rest on the page.
- \setbox\PAGE=\box0
- \doublecolumnout
- \else
- % Compare the heights of the two columns.
- \ifdim4\ht1>5\ht3
- % Column heights are too different, so don't make their bottoms
- % flush with each other.
- \setbox2=\vbox to \ht1 {\unvbox3\vfill}%
- \setbox0=\vbox to \ht1 {\unvbox1\vfill}%
- \else
- % Make column bottoms flush with each other.
- \setbox2=\vbox to\ht1{\unvbox3\unskip}%
- \setbox0=\vbox to\ht1{\unvbox1\unskip}%
- \fi
- \global\setbox\balancedcolumns=\vbox{\pagesofar}%
- \fi
- \fi
- %
-}
-\catcode`\@ = \other
-
-
-\message{sectioning,}
-% Chapters, sections, etc.
-
-% Let's start with @part.
-\outer\parseargdef\part{\partzzz{#1}}
-\def\partzzz#1{%
- \chapoddpage
- \null
- \vskip.3\vsize % move it down on the page a bit
- \begingroup
- \noindent \titlefonts\rm #1\par % the text
- \let\lastnode=\empty % no node to associate with
- \writetocentry{part}{#1}{}% but put it in the toc
- \headingsoff % no headline or footline on the part page
- % This outputs a mark at the end of the page that clears \thischapter
- % and \thissection, as is done in \startcontents.
- \let\pchapsepmacro\relax
- \chapmacro{}{Yomitfromtoc}{}%
- \chapoddpage
- \endgroup
-}
-
-% \unnumberedno is an oxymoron. But we count the unnumbered
-% sections so that we can refer to them unambiguously in the pdf
-% outlines by their "section number". We avoid collisions with chapter
-% numbers by starting them at 10000. (If a document ever has 10000
-% chapters, we're in trouble anyway, I'm sure.)
-\newcount\unnumberedno \unnumberedno = 10000
-\newcount\chapno
-\newcount\secno \secno=0
-\newcount\subsecno \subsecno=0
-\newcount\subsubsecno \subsubsecno=0
-
-% This counter is funny since it counts through charcodes of letters A, B, ...
-\newcount\appendixno \appendixno = `\@
-%
-% \def\appendixletter{\char\the\appendixno}
-% We do the following ugly conditional instead of the above simple
-% construct for the sake of pdftex, which needs the actual
-% letter in the expansion, not just typeset.
-%
-\def\appendixletter{%
- \ifnum\appendixno=`A A%
- \else\ifnum\appendixno=`B B%
- \else\ifnum\appendixno=`C C%
- \else\ifnum\appendixno=`D D%
- \else\ifnum\appendixno=`E E%
- \else\ifnum\appendixno=`F F%
- \else\ifnum\appendixno=`G G%
- \else\ifnum\appendixno=`H H%
- \else\ifnum\appendixno=`I I%
- \else\ifnum\appendixno=`J J%
- \else\ifnum\appendixno=`K K%
- \else\ifnum\appendixno=`L L%
- \else\ifnum\appendixno=`M M%
- \else\ifnum\appendixno=`N N%
- \else\ifnum\appendixno=`O O%
- \else\ifnum\appendixno=`P P%
- \else\ifnum\appendixno=`Q Q%
- \else\ifnum\appendixno=`R R%
- \else\ifnum\appendixno=`S S%
- \else\ifnum\appendixno=`T T%
- \else\ifnum\appendixno=`U U%
- \else\ifnum\appendixno=`V V%
- \else\ifnum\appendixno=`W W%
- \else\ifnum\appendixno=`X X%
- \else\ifnum\appendixno=`Y Y%
- \else\ifnum\appendixno=`Z Z%
- % The \the is necessary, despite appearances, because \appendixletter is
- % expanded while writing the .toc file. \char\appendixno is not
- % expandable, thus it is written literally, thus all appendixes come out
- % with the same letter (or @) in the toc without it.
- \else\char\the\appendixno
- \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi
- \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi}
-
-% Each @chapter defines these (using marks) as the number+name, number
-% and name of the chapter. Page headings and footings can use
-% these. @section does likewise.
-\def\thischapter{}
-\def\thischapternum{}
-\def\thischaptername{}
-\def\thissection{}
-\def\thissectionnum{}
-\def\thissectionname{}
-
-\newcount\absseclevel % used to calculate proper heading level
-\newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count
-
-% @raisesections: treat @section as chapter, @subsection as section, etc.
-\def\raisesections{\global\advance\secbase by -1}
-
-% @lowersections: treat @chapter as section, @section as subsection, etc.
-\def\lowersections{\global\advance\secbase by 1}
-
-% we only have subsub.
-\chardef\maxseclevel = 3
-%
-% A numbered section within an unnumbered changes to unnumbered too.
-% To achieve this, remember the "biggest" unnum. sec. we are currently in:
-\chardef\unnlevel = \maxseclevel
-%
-% Trace whether the current chapter is an appendix or not:
-% \chapheadtype is "N" or "A", unnumbered chapters are ignored.
-\def\chapheadtype{N}
-
-% Choose a heading macro
-% #1 is heading type
-% #2 is heading level
-% #3 is text for heading
-\def\genhead#1#2#3{%
- % Compute the abs. sec. level:
- \absseclevel=#2
- \advance\absseclevel by \secbase
- % Make sure \absseclevel doesn't fall outside the range:
- \ifnum \absseclevel < 0
- \absseclevel = 0
- \else
- \ifnum \absseclevel > 3
- \absseclevel = 3
- \fi
- \fi
- % The heading type:
- \def\headtype{#1}%
- \if \headtype U%
- \ifnum \absseclevel < \unnlevel
- \chardef\unnlevel = \absseclevel
- \fi
- \else
- % Check for appendix sections:
- \ifnum \absseclevel = 0
- \edef\chapheadtype{\headtype}%
- \else
- \if \headtype A\if \chapheadtype N%
- \errmessage{@appendix... within a non-appendix chapter}%
- \fi\fi
- \fi
- % Check for numbered within unnumbered:
- \ifnum \absseclevel > \unnlevel
- \def\headtype{U}%
- \else
- \chardef\unnlevel = 3
- \fi
- \fi
- % Now print the heading:
- \if \headtype U%
- \ifcase\absseclevel
- \unnumberedzzz{#3}%
- \or \unnumberedseczzz{#3}%
- \or \unnumberedsubseczzz{#3}%
- \or \unnumberedsubsubseczzz{#3}%
- \fi
- \else
- \if \headtype A%
- \ifcase\absseclevel
- \appendixzzz{#3}%
- \or \appendixsectionzzz{#3}%
- \or \appendixsubseczzz{#3}%
- \or \appendixsubsubseczzz{#3}%
- \fi
- \else
- \ifcase\absseclevel
- \chapterzzz{#3}%
- \or \seczzz{#3}%
- \or \numberedsubseczzz{#3}%
- \or \numberedsubsubseczzz{#3}%
- \fi
- \fi
- \fi
- \suppressfirstparagraphindent
-}
-
-% an interface:
-\def\numhead{\genhead N}
-\def\apphead{\genhead A}
-\def\unnmhead{\genhead U}
-
-% @chapter, @appendix, @unnumbered. Increment top-level counter, reset
-% all lower-level sectioning counters to zero.
-%
-% Also set \chaplevelprefix, which we prepend to @float sequence numbers
-% (e.g., figures), q.v. By default (before any chapter), that is empty.
-\let\chaplevelprefix = \empty
-%
-\outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz
-\def\chapterzzz#1{%
- % section resetting is \global in case the chapter is in a group, such
- % as an @include file.
- \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
- \global\advance\chapno by 1
- %
- % Used for \float.
- \gdef\chaplevelprefix{\the\chapno.}%
- \resetallfloatnos
- %
- % \putwordChapter can contain complex things in translations.
- \toks0=\expandafter{\putwordChapter}%
- \message{\the\toks0 \space \the\chapno}%
- %
- % Write the actual heading.
- \chapmacro{#1}{Ynumbered}{\the\chapno}%
- %
- % So @section and the like are numbered underneath this chapter.
- \global\let\section = \numberedsec
- \global\let\subsection = \numberedsubsec
- \global\let\subsubsection = \numberedsubsubsec
-}
-
-\outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz
-%
-\def\appendixzzz#1{%
- \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
- \global\advance\appendixno by 1
- \gdef\chaplevelprefix{\appendixletter.}%
- \resetallfloatnos
- %
- % \putwordAppendix can contain complex things in translations.
- \toks0=\expandafter{\putwordAppendix}%
- \message{\the\toks0 \space \appendixletter}%
- %
- \chapmacro{#1}{Yappendix}{\appendixletter}%
- %
- \global\let\section = \appendixsec
- \global\let\subsection = \appendixsubsec
- \global\let\subsubsection = \appendixsubsubsec
-}
-
-% normally unnmhead0 calls unnumberedzzz:
-\outer\parseargdef\unnumbered{\unnmhead0{#1}}
-\def\unnumberedzzz#1{%
- \global\secno=0 \global\subsecno=0 \global\subsubsecno=0
- \global\advance\unnumberedno by 1
- %
- % Since an unnumbered has no number, no prefix for figures.
- \global\let\chaplevelprefix = \empty
- \resetallfloatnos
- %
- % This used to be simply \message{#1}, but TeX fully expands the
- % argument to \message. Therefore, if #1 contained @-commands, TeX
- % expanded them. For example, in `@unnumbered The @cite{Book}', TeX
- % expanded @cite (which turns out to cause errors because \cite is meant
- % to be executed, not expanded).
- %
- % Anyway, we don't want the fully-expanded definition of @cite to appear
- % as a result of the \message, we just want `@cite' itself. We use
- % \the<toks register> to achieve this: TeX expands \the<toks> only once,
- % simply yielding the contents of <toks register>. (We also do this for
- % the toc entries.)
- \toks0 = {#1}%
- \message{(\the\toks0)}%
- %
- \chapmacro{#1}{Ynothing}{\the\unnumberedno}%
- %
- \global\let\section = \unnumberedsec
- \global\let\subsection = \unnumberedsubsec
- \global\let\subsubsection = \unnumberedsubsubsec
-}
-
-% @centerchap is like @unnumbered, but the heading is centered.
-\outer\parseargdef\centerchap{%
- \let\centerparametersmaybe = \centerparameters
- \unnmhead0{#1}%
- \let\centerparametersmaybe = \relax
-}
-
-% @top is like @unnumbered.
-\let\top\unnumbered
-
-% Sections.
-%
-\outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz
-\def\seczzz#1{%
- \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
- \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}%
-}
-
-% normally calls appendixsectionzzz:
-\outer\parseargdef\appendixsection{\apphead1{#1}}
-\def\appendixsectionzzz#1{%
- \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
- \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}%
-}
-\let\appendixsec\appendixsection
-
-% normally calls unnumberedseczzz:
-\outer\parseargdef\unnumberedsec{\unnmhead1{#1}}
-\def\unnumberedseczzz#1{%
- \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1
- \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}%
-}
-
-% Subsections.
-%
-% normally calls numberedsubseczzz:
-\outer\parseargdef\numberedsubsec{\numhead2{#1}}
-\def\numberedsubseczzz#1{%
- \global\subsubsecno=0 \global\advance\subsecno by 1
- \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}%
-}
-
-% normally calls appendixsubseczzz:
-\outer\parseargdef\appendixsubsec{\apphead2{#1}}
-\def\appendixsubseczzz#1{%
- \global\subsubsecno=0 \global\advance\subsecno by 1
- \sectionheading{#1}{subsec}{Yappendix}%
- {\appendixletter.\the\secno.\the\subsecno}%
-}
-
-% normally calls unnumberedsubseczzz:
-\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}}
-\def\unnumberedsubseczzz#1{%
- \global\subsubsecno=0 \global\advance\subsecno by 1
- \sectionheading{#1}{subsec}{Ynothing}%
- {\the\unnumberedno.\the\secno.\the\subsecno}%
-}
-
-% Subsubsections.
-%
-% normally numberedsubsubseczzz:
-\outer\parseargdef\numberedsubsubsec{\numhead3{#1}}
-\def\numberedsubsubseczzz#1{%
- \global\advance\subsubsecno by 1
- \sectionheading{#1}{subsubsec}{Ynumbered}%
- {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}%
-}
-
-% normally appendixsubsubseczzz:
-\outer\parseargdef\appendixsubsubsec{\apphead3{#1}}
-\def\appendixsubsubseczzz#1{%
- \global\advance\subsubsecno by 1
- \sectionheading{#1}{subsubsec}{Yappendix}%
- {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}%
-}
-
-% normally unnumberedsubsubseczzz:
-\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}}
-\def\unnumberedsubsubseczzz#1{%
- \global\advance\subsubsecno by 1
- \sectionheading{#1}{subsubsec}{Ynothing}%
- {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}%
-}
-
-% These macros control what the section commands do, according
-% to what kind of chapter we are in (ordinary, appendix, or unnumbered).
-% Define them by default for a numbered chapter.
-\let\section = \numberedsec
-\let\subsection = \numberedsubsec
-\let\subsubsection = \numberedsubsubsec
-
-% Define @majorheading, @heading and @subheading
-
-\def\majorheading{%
- {\advance\chapheadingskip by 10pt \chapbreak }%
- \parsearg\chapheadingzzz
-}
-
-\def\chapheading{\chapbreak \parsearg\chapheadingzzz}
-\def\chapheadingzzz#1{%
- \vbox{\chapfonts \raggedtitlesettings #1\par}%
- \nobreak\bigskip \nobreak
- \suppressfirstparagraphindent
-}
-
-% @heading, @subheading, @subsubheading.
-\parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{}
- \suppressfirstparagraphindent}
-\parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{}
- \suppressfirstparagraphindent}
-\parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{}
- \suppressfirstparagraphindent}
-
-% These macros generate a chapter, section, etc. heading only
-% (including whitespace, linebreaking, etc. around it),
-% given all the information in convenient, parsed form.
-
-% Args are the skip and penalty (usually negative)
-\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi}
-
-% Parameter controlling skip before chapter headings (if needed)
-\newskip\chapheadingskip
-
-% Define plain chapter starts, and page on/off switching for it.
-\def\chapbreak{\dobreak \chapheadingskip {-4000}}
-
-% Start a new page
-\def\chappager{\par\vfill\supereject}
-
-% \chapoddpage - start on an odd page for a new chapter
-% Because \domark is called before \chapoddpage, the filler page will
-% get the headings for the next chapter, which is wrong. But we don't
-% care -- we just disable all headings on the filler page.
-\def\chapoddpage{%
- \chappager
- \ifodd\pageno \else
- \begingroup
- \headingsoff
- \null
- \chappager
- \endgroup
- \fi
-}
-
-\parseargdef\setchapternewpage{\csname CHAPPAG#1\endcsname}
-
-\def\CHAPPAGoff{%
-\global\let\contentsalignmacro = \chappager
-\global\let\pchapsepmacro=\chapbreak
-\global\let\pagealignmacro=\chappager}
-
-\def\CHAPPAGon{%
-\global\let\contentsalignmacro = \chappager
-\global\let\pchapsepmacro=\chappager
-\global\let\pagealignmacro=\chappager
-\global\def\HEADINGSon{\HEADINGSsingle}}
-
-\def\CHAPPAGodd{%
-\global\let\contentsalignmacro = \chapoddpage
-\global\let\pchapsepmacro=\chapoddpage
-\global\let\pagealignmacro=\chapoddpage
-\global\def\HEADINGSon{\HEADINGSdouble}}
-
-\CHAPPAGon
-
-% \chapmacro - Chapter opening.
-%
-% #1 is the text, #2 is the section type (Ynumbered, Ynothing,
-% Yappendix, Yomitfromtoc), #3 the chapter number.
-% Not used for @heading series.
-%
-% To test against our argument.
-\def\Ynothingkeyword{Ynothing}
-\def\Yappendixkeyword{Yappendix}
-\def\Yomitfromtockeyword{Yomitfromtoc}
-%
-\def\chapmacro#1#2#3{%
- \expandafter\ifx\thisenv\titlepage\else
- \checkenv{}% chapters, etc., should not start inside an environment.
- \fi
- % Insert the first mark before the heading break (see notes for \domark).
- \let\prevchapterdefs=\currentchapterdefs
- \let\prevsectiondefs=\currentsectiondefs
- \gdef\currentsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}%
- \gdef\thissection{}}%
- %
- \def\temptype{#2}%
- \ifx\temptype\Ynothingkeyword
- \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
- \gdef\thischapter{\thischaptername}}%
- \else\ifx\temptype\Yomitfromtockeyword
- \gdef\currentchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}%
- \gdef\thischapter{}}%
- \else\ifx\temptype\Yappendixkeyword
- \toks0={#1}%
- \xdef\currentchapterdefs{%
- \gdef\noexpand\thischaptername{\the\toks0}%
- \gdef\noexpand\thischapternum{\appendixletter}%
- % \noexpand\putwordAppendix avoids expanding indigestible
- % commands in some of the translations.
- \gdef\noexpand\thischapter{\noexpand\putwordAppendix{}
- \noexpand\thischapternum:
- \noexpand\thischaptername}%
- }%
- \else
- \toks0={#1}%
- \xdef\currentchapterdefs{%
- \gdef\noexpand\thischaptername{\the\toks0}%
- \gdef\noexpand\thischapternum{\the\chapno}%
- % \noexpand\putwordChapter avoids expanding indigestible
- % commands in some of the translations.
- \gdef\noexpand\thischapter{\noexpand\putwordChapter{}
- \noexpand\thischapternum:
- \noexpand\thischaptername}%
- }%
- \fi\fi\fi
- %
- % Output the mark. Pass it through \safewhatsit, to take care of
- % the preceding space.
- \safewhatsit\domark
- %
- % Insert the chapter heading break.
- \pchapsepmacro
- %
- % Now the second mark, after the heading break. No break points
- % between here and the heading.
- \let\prevchapterdefs=\currentchapterdefs
- \let\prevsectiondefs=\currentsectiondefs
- \domark
- %
- {%
- \chapfonts \rm
- \let\footnote=\errfootnoteheading % give better error message
- %
- % Have to define \currentsection before calling \donoderef, because the
- % xref code eventually uses it. On the other hand, it has to be called
- % after \pchapsepmacro, or the headline will change too soon.
- \gdef\currentsection{#1}%
- %
- % Only insert the separating space if we have a chapter/appendix
- % number, and don't print the unnumbered ``number''.
- \ifx\temptype\Ynothingkeyword
- \setbox0 = \hbox{}%
- \def\toctype{unnchap}%
- \else\ifx\temptype\Yomitfromtockeyword
- \setbox0 = \hbox{}% contents like unnumbered, but no toc entry
- \def\toctype{omit}%
- \else\ifx\temptype\Yappendixkeyword
- \setbox0 = \hbox{\putwordAppendix{} #3\enspace}%
- \def\toctype{app}%
- \else
- \setbox0 = \hbox{#3\enspace}%
- \def\toctype{numchap}%
- \fi\fi\fi
- %
- % Write the toc entry for this chapter. Must come before the
- % \donoderef, because we include the current node name in the toc
- % entry, and \donoderef resets it to empty.
- \writetocentry{\toctype}{#1}{#3}%
- %
- % For pdftex, we have to write out the node definition (aka, make
- % the pdfdest) after any page break, but before the actual text has
- % been typeset. If the destination for the pdf outline is after the
- % text, then jumping from the outline may wind up with the text not
- % being visible, for instance under high magnification.
- \donoderef{#2}%
- %
- % Typeset the actual heading.
- \nobreak % Avoid page breaks at the interline glue.
- \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe
- \unhbox0 #1\par}%
- }%
- \nobreak\bigskip % no page break after a chapter title
- \nobreak
-}
-
-% @centerchap -- centered and unnumbered.
-\let\centerparametersmaybe = \relax
-\def\centerparameters{%
- \advance\rightskip by 3\rightskip
- \leftskip = \rightskip
- \parfillskip = 0pt
-}
-
-
-% Section titles. These macros combine the section number parts and
-% call the generic \sectionheading to do the printing.
-%
-\newskip\secheadingskip
-\def\secheadingbreak{\dobreak \secheadingskip{-1000}}
-
-% Subsection titles.
-\newskip\subsecheadingskip
-\def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}}
-
-% Subsubsection titles.
-\def\subsubsecheadingskip{\subsecheadingskip}
-\def\subsubsecheadingbreak{\subsecheadingbreak}
-
-
-% Print any size, any type, section title.
-%
-% #1 is the text of the title,
-% #2 is the section level (sec/subsec/subsubsec),
-% #3 is the section type (Ynumbered, Ynothing, Yappendix, Yomitfromtoc),
-% #4 is the section number.
-%
-\def\seckeyword{sec}
-%
-\def\sectionheading#1#2#3#4{%
- {%
- \def\sectionlevel{#2}%
- \def\temptype{#3}%
- %
- % It is ok for the @heading series commands to appear inside an
- % environment (it's been historically allowed, though the logic is
- % dubious), but not the others.
- \ifx\temptype\Yomitfromtockeyword\else
- \checkenv{}% non-@*heading should not be in an environment.
- \fi
- \let\footnote=\errfootnoteheading
- %
- % Switch to the right set of fonts.
- \csname #2fonts\endcsname \rm
- %
- % Insert first mark before the heading break (see notes for \domark).
- \let\prevsectiondefs=\currentsectiondefs
- \ifx\temptype\Ynothingkeyword
- \ifx\sectionlevel\seckeyword
- \gdef\currentsectiondefs{\gdef\thissectionname{#1}\gdef\thissectionnum{}%
- \gdef\thissection{\thissectionname}}%
- \fi
- \else\ifx\temptype\Yomitfromtockeyword
- % Don't redefine \thissection.
- \else\ifx\temptype\Yappendixkeyword
- \ifx\sectionlevel\seckeyword
- \toks0={#1}%
- \xdef\currentsectiondefs{%
- \gdef\noexpand\thissectionname{\the\toks0}%
- \gdef\noexpand\thissectionnum{#4}%
- % \noexpand\putwordSection avoids expanding indigestible
- % commands in some of the translations.
- \gdef\noexpand\thissection{\noexpand\putwordSection{}
- \noexpand\thissectionnum:
- \noexpand\thissectionname}%
- }%
- \fi
- \else
- \ifx\sectionlevel\seckeyword
- \toks0={#1}%
- \xdef\currentsectiondefs{%
- \gdef\noexpand\thissectionname{\the\toks0}%
- \gdef\noexpand\thissectionnum{#4}%
- % \noexpand\putwordSection avoids expanding indigestible
- % commands in some of the translations.
- \gdef\noexpand\thissection{\noexpand\putwordSection{}
- \noexpand\thissectionnum:
- \noexpand\thissectionname}%
- }%
- \fi
- \fi\fi\fi
- %
- % Go into vertical mode. Usually we'll already be there, but we
- % don't want the following whatsit to end up in a preceding paragraph
- % if the document didn't happen to have a blank line.
- \par
- %
- % Output the mark. Pass it through \safewhatsit, to take care of
- % the preceding space.
- \safewhatsit\domark
- %
- % Insert space above the heading.
- \csname #2headingbreak\endcsname
- %
- % Now the second mark, after the heading break. No break points
- % between here and the heading.
- \global\let\prevsectiondefs=\currentsectiondefs
- \domark
- %
- % Only insert the space after the number if we have a section number.
- \ifx\temptype\Ynothingkeyword
- \setbox0 = \hbox{}%
- \def\toctype{unn}%
- \gdef\currentsection{#1}%
- \else\ifx\temptype\Yomitfromtockeyword
- % for @headings -- no section number, don't include in toc,
- % and don't redefine \currentsection.
- \setbox0 = \hbox{}%
- \def\toctype{omit}%
- \let\sectionlevel=\empty
- \else\ifx\temptype\Yappendixkeyword
- \setbox0 = \hbox{#4\enspace}%
- \def\toctype{app}%
- \gdef\currentsection{#1}%
- \else
- \setbox0 = \hbox{#4\enspace}%
- \def\toctype{num}%
- \gdef\currentsection{#1}%
- \fi\fi\fi
- %
- % Write the toc entry (before \donoderef). See comments in \chapmacro.
- \writetocentry{\toctype\sectionlevel}{#1}{#4}%
- %
- % Write the node reference (= pdf destination for pdftex).
- % Again, see comments in \chapmacro.
- \donoderef{#3}%
- %
- % Interline glue will be inserted when the vbox is completed.
- % That glue will be a valid breakpoint for the page, since it'll be
- % preceded by a whatsit (usually from the \donoderef, or from the
- % \writetocentry if there was no node). We don't want to allow that
- % break, since then the whatsits could end up on page n while the
- % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000.
- \nobreak
- %
- % Output the actual section heading.
- \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright
- \hangindent=\wd0 % zero if no section number
- \unhbox0 #1}%
- }%
- % Add extra space after the heading -- half of whatever came above it.
- % Don't allow stretch, though.
- \kern .5 \csname #2headingskip\endcsname
- %
- % Do not let the kern be a potential breakpoint, as it would be if it
- % was followed by glue.
- \nobreak
- %
- % We'll almost certainly start a paragraph next, so don't let that
- % glue accumulate. (Not a breakpoint because it's preceded by a
- % discardable item.) However, when a paragraph is not started next
- % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out
- % or the negative glue will cause weirdly wrong output, typically
- % obscuring the section heading with something else.
- \vskip-\parskip
- %
- % This is so the last item on the main vertical list is a known
- % \penalty > 10000, so \startdefun, etc., can recognize the situation
- % and do the needful.
- \penalty 10001
-}
-
-
-\message{toc,}
-% Table of contents.
-\newwrite\tocfile
-
-% Write an entry to the toc file, opening it if necessary.
-% Called from @chapter, etc.
-%
-% Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno}
-% We append the current node name (if any) and page number as additional
-% arguments for the \{chap,sec,...}entry macros which will eventually
-% read this. The node name is used in the pdf outlines as the
-% destination to jump to.
-%
-% We open the .toc file for writing here instead of at @setfilename (or
-% any other fixed time) so that @contents can be anywhere in the document.
-% But if #1 is `omit', then we don't do anything. This is used for the
-% table of contents chapter openings themselves.
-%
-\newif\iftocfileopened
-\def\omitkeyword{omit}%
-%
-\def\writetocentry#1#2#3{%
- \edef\writetoctype{#1}%
- \ifx\writetoctype\omitkeyword \else
- \iftocfileopened\else
- \immediate\openout\tocfile = \jobname.toc
- \global\tocfileopenedtrue
- \fi
- %
- \iflinks
- {\atdummies
- \edef\temp{%
- \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}%
- \temp
- }%
- \fi
- \fi
- %
- % Tell \shipout to create a pdf destination on each page, if we're
- % writing pdf. These are used in the table of contents. We can't
- % just write one on every page because the title pages are numbered
- % 1 and 2 (the page numbers aren't printed), and so are the first
- % two pages of the document. Thus, we'd have two destinations named
- % `1', and two named `2'.
- \ifpdforxetex
- \global\pdfmakepagedesttrue
- \fi
-}
-
-
-% These characters do not print properly in the Computer Modern roman
-% fonts, so we must take special care. This is more or less redundant
-% with the Texinfo input format setup at the end of this file.
-%
-\def\activecatcodes{%
- \catcode`\"=\active
- \catcode`\$=\active
- \catcode`\<=\active
- \catcode`\>=\active
- \catcode`\\=\active
- \catcode`\^=\active
- \catcode`\_=\active
- \catcode`\|=\active
- \catcode`\~=\active
-}
-
-
-% Read the toc file, which is essentially Texinfo input.
-\def\readtocfile{%
- \setupdatafile
- \activecatcodes
- \input \tocreadfilename
-}
-
-\newskip\contentsrightmargin \contentsrightmargin=1in
-\newcount\savepageno
-\newcount\lastnegativepageno \lastnegativepageno = -1
-
-% Prepare to read what we've written to \tocfile.
-%
-\def\startcontents#1{%
- % If @setchapternewpage on, and @headings double, the contents should
- % start on an odd page, unlike chapters. Thus, we maintain
- % \contentsalignmacro in parallel with \pagealignmacro.
- % From: Torbjorn Granlund <tege@matematik.su.se>
- \contentsalignmacro
- \immediate\closeout\tocfile
- %
- % Don't need to put `Contents' or `Short Contents' in the headline.
- % It is abundantly clear what they are.
- \chapmacro{#1}{Yomitfromtoc}{}%
- %
- \savepageno = \pageno
- \begingroup % Set up to handle contents files properly.
- \raggedbottom % Worry more about breakpoints than the bottom.
- \entryrightmargin=\contentsrightmargin % Don't use the full line length.
- %
- % Roman numerals for page numbers.
- \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi
-}
-
-% redefined for the two-volume lispref. We always output on
-% \jobname.toc even if this is redefined.
-%
-\def\tocreadfilename{\jobname.toc}
-
-% Normal (long) toc.
-%
-\def\contents{%
- \startcontents{\putwordTOC}%
- \openin 1 \tocreadfilename\space
- \ifeof 1 \else
- \readtocfile
- \fi
- \vfill \eject
- \contentsalignmacro % in case @setchapternewpage odd is in effect
- \ifeof 1 \else
- \pdfmakeoutlines
- \fi
- \closein 1
- \endgroup
- \lastnegativepageno = \pageno
- \global\pageno = \savepageno
-}
-
-% And just the chapters.
-\def\summarycontents{%
- \startcontents{\putwordShortTOC}%
- %
- \let\partentry = \shortpartentry
- \let\numchapentry = \shortchapentry
- \let\appentry = \shortchapentry
- \let\unnchapentry = \shortunnchapentry
- % We want a true roman here for the page numbers.
- \secfonts
- \let\rm=\shortcontrm \let\bf=\shortcontbf
- \let\sl=\shortcontsl \let\tt=\shortconttt
- \rm
- \hyphenpenalty = 10000
- \advance\baselineskip by 1pt % Open it up a little.
- \def\numsecentry##1##2##3##4{}
- \let\appsecentry = \numsecentry
- \let\unnsecentry = \numsecentry
- \let\numsubsecentry = \numsecentry
- \let\appsubsecentry = \numsecentry
- \let\unnsubsecentry = \numsecentry
- \let\numsubsubsecentry = \numsecentry
- \let\appsubsubsecentry = \numsecentry
- \let\unnsubsubsecentry = \numsecentry
- \openin 1 \tocreadfilename\space
- \ifeof 1 \else
- \readtocfile
- \fi
- \closein 1
- \vfill \eject
- \contentsalignmacro % in case @setchapternewpage odd is in effect
- \endgroup
- \lastnegativepageno = \pageno
- \global\pageno = \savepageno
-}
-\let\shortcontents = \summarycontents
-
-% Typeset the label for a chapter or appendix for the short contents.
-% The arg is, e.g., `A' for an appendix, or `3' for a chapter.
-%
-\def\shortchaplabel#1{%
- % This space should be enough, since a single number is .5em, and the
- % widest letter (M) is 1em, at least in the Computer Modern fonts.
- % But use \hss just in case.
- % (This space doesn't include the extra space that gets added after
- % the label; that gets put in by \shortchapentry above.)
- %
- % We'd like to right-justify chapter numbers, but that looks strange
- % with appendix letters. And right-justifying numbers and
- % left-justifying letters looks strange when there is less than 10
- % chapters. Have to read the whole toc once to know how many chapters
- % there are before deciding ...
- \hbox to 1em{#1\hss}%
-}
-
-% These macros generate individual entries in the table of contents.
-% The first argument is the chapter or section name.
-% The last argument is the page number.
-% The arguments in between are the chapter number, section number, ...
-
-% Parts, in the main contents. Replace the part number, which doesn't
-% exist, with an empty box. Let's hope all the numbers have the same width.
-% Also ignore the page number, which is conventionally not printed.
-\def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}}
-\def\partentry#1#2#3#4{%
- % Add stretch and a bonus for breaking the page before the part heading.
- % This reduces the chance of the page being broken immediately after the
- % part heading, before a following chapter heading.
- \vskip 0pt plus 5\baselineskip
- \penalty-300
- \vskip 0pt plus -5\baselineskip
- \dochapentry{\numeralbox\labelspace#1}{}%
-}
-%
-% Parts, in the short toc.
-\def\shortpartentry#1#2#3#4{%
- \penalty-300
- \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip
- \shortchapentry{{\bf #1}}{\numeralbox}{}{}%
-}
-
-% Chapters, in the main contents.
-\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}}
-
-% Chapters, in the short toc.
-% See comments in \dochapentry re vbox and related settings.
-\def\shortchapentry#1#2#3#4{%
- \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}%
-}
-
-% Appendices, in the main contents.
-% Need the word Appendix, and a fixed-size box.
-%
-\def\appendixbox#1{%
- % We use M since it's probably the widest letter.
- \setbox0 = \hbox{\putwordAppendix{} M}%
- \hbox to \wd0{\putwordAppendix{} #1\hss}}
-%
-\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\hskip.7em#1}{#4}}
-
-% Unnumbered chapters.
-\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}}
-\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}}
-
-% Sections.
-\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}}
-\let\appsecentry=\numsecentry
-\def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}}
-
-% Subsections.
-\def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}}
-\let\appsubsecentry=\numsubsecentry
-\def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}}
-
-% And subsubsections.
-\def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}}
-\let\appsubsubsecentry=\numsubsubsecentry
-\def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}}
-
-% This parameter controls the indentation of the various levels.
-% Same as \defaultparindent.
-\newdimen\tocindent \tocindent = 15pt
-
-% Now for the actual typesetting. In all these, #1 is the text and #2 is the
-% page number.
-%
-% If the toc has to be broken over pages, we want it to be at chapters
-% if at all possible; hence the \penalty.
-\def\dochapentry#1#2{%
- \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip
- \begingroup
- % Move the page numbers slightly to the right
- \advance\entryrightmargin by -0.05em
- \chapentryfonts
- \tocentry{#1}{\dopageno\bgroup#2\egroup}%
- \endgroup
- \nobreak\vskip .25\baselineskip plus.1\baselineskip
-}
-
-\def\dosecentry#1#2{\begingroup
- \secentryfonts \leftskip=\tocindent
- \tocentry{#1}{\dopageno\bgroup#2\egroup}%
-\endgroup}
-
-\def\dosubsecentry#1#2{\begingroup
- \subsecentryfonts \leftskip=2\tocindent
- \tocentry{#1}{\dopageno\bgroup#2\egroup}%
-\endgroup}
-
-\def\dosubsubsecentry#1#2{\begingroup
- \subsubsecentryfonts \leftskip=3\tocindent
- \tocentry{#1}{\dopageno\bgroup#2\egroup}%
-\endgroup}
-
-% We use the same \entry macro as for the index entries.
-\let\tocentry = \entry
-
-% Space between chapter (or whatever) number and the title.
-\def\labelspace{\hskip1em \relax}
-
-\def\dopageno#1{{\rm #1}}
-\def\doshortpageno#1{{\rm #1}}
-
-\def\chapentryfonts{\secfonts \rm}
-\def\secentryfonts{\textfonts}
-\def\subsecentryfonts{\textfonts}
-\def\subsubsecentryfonts{\textfonts}
-
-
-\message{environments,}
-% @foo ... @end foo.
-
-% @tex ... @end tex escapes into raw TeX temporarily.
-% One exception: @ is still an escape character, so that @end tex works.
-% But \@ or @@ will get a plain @ character.
-
-\envdef\tex{%
- \setupmarkupstyle{tex}%
- \catcode `\\=0 \catcode `\{=1 \catcode `\}=2
- \catcode `\$=3 \catcode `\&=4 \catcode `\#=6
- \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie
- \catcode `\%=14
- \catcode `\+=\other
- \catcode `\"=\other
- \catcode `\|=\other
- \catcode `\<=\other
- \catcode `\>=\other
- \catcode `\`=\other
- \catcode `\'=\other
- %
- % ' is active in math mode (mathcode"8000). So reset it, and all our
- % other math active characters (just in case), to plain's definitions.
- \mathactive
- %
- % Inverse of the list at the beginning of the file.
- \let\b=\ptexb
- \let\bullet=\ptexbullet
- \let\c=\ptexc
- \let\,=\ptexcomma
- \let\.=\ptexdot
- \let\dots=\ptexdots
- \let\equiv=\ptexequiv
- \let\!=\ptexexclam
- \let\i=\ptexi
- \let\indent=\ptexindent
- \let\noindent=\ptexnoindent
- \let\{=\ptexlbrace
- \let\+=\tabalign
- \let\}=\ptexrbrace
- \let\/=\ptexslash
- \let\sp=\ptexsp
- \let\*=\ptexstar
- %\let\sup=\ptexsup % do not redefine, we want @sup to work in math mode
- \let\t=\ptext
- \expandafter \let\csname top\endcsname=\ptextop % we've made it outer
- \let\frenchspacing=\plainfrenchspacing
- %
- \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}%
- \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}%
- \def\@{@}%
-}
-% There is no need to define \Etex.
-
-% Define @lisp ... @end lisp.
-% @lisp environment forms a group so it can rebind things,
-% including the definition of @end lisp (which normally is erroneous).
-
-% Amount to narrow the margins by for @lisp.
-\newskip\lispnarrowing \lispnarrowing=0.4in
-
-% This is the definition that ^^M gets inside @lisp, @example, and other
-% such environments. \null is better than a space, since it doesn't
-% have any width.
-\def\lisppar{\null\endgraf}
-
-% This space is always present above and below environments.
-\newskip\envskipamount \envskipamount = 0pt
-
-% Make spacing and below environment symmetrical. We use \parskip here
-% to help in doing that, since in @example-like environments \parskip
-% is reset to zero; thus the \afterenvbreak inserts no space -- but the
-% start of the next paragraph will insert \parskip.
-%
-\def\aboveenvbreak{{%
- % =10000 instead of <10000 because of a special case in \itemzzz and
- % \sectionheading, q.v.
- \ifnum \lastpenalty=10000 \else
- \advance\envskipamount by \parskip
- \endgraf
- \ifdim\lastskip<\envskipamount
- \removelastskip
- \ifnum\lastpenalty<10000
- % Penalize breaking before the environment, because preceding text
- % often leads into it.
- \penalty100
- \fi
- \vskip\envskipamount
- \fi
- \fi
-}}
-
-\def\afterenvbreak{{%
- % =10000 instead of <10000 because of a special case in \itemzzz and
- % \sectionheading, q.v.
- \ifnum \lastpenalty=10000 \else
- \advance\envskipamount by \parskip
- \endgraf
- \ifdim\lastskip<\envskipamount
- \removelastskip
- % it's not a good place to break if the last penalty was \nobreak
- % or better ...
- \ifnum\lastpenalty<10000 \penalty-50 \fi
- \vskip\envskipamount
- \fi
- \fi
-}}
-
-% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will
-% also clear it, so that its embedded environments do the narrowing again.
-\let\nonarrowing=\relax
-
-% @cartouche ... @end cartouche: draw rectangle w/rounded corners around
-% environment contents.
-
-%
-\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth
-\def\ctr{{\hskip 6pt\circle\char'010}}
-\def\cbl{{\circle\char'012\hskip -6pt}}
-\def\cbr{{\hskip 6pt\circle\char'011}}
-\def\carttop{\hbox to \cartouter{\hskip\lskip
- \ctl\leaders\hrule height\circthick\hfil\ctr
- \hskip\rskip}}
-\def\cartbot{\hbox to \cartouter{\hskip\lskip
- \cbl\leaders\hrule height\circthick\hfil\cbr
- \hskip\rskip}}
-%
-\newskip\lskip\newskip\rskip
-
-% only require the font if @cartouche is actually used
-\def\cartouchefontdefs{%
- \font\circle=lcircle10\relax
- \circthick=\fontdimen8\circle
-}
-\newdimen\circthick
-\newdimen\cartouter\newdimen\cartinner
-\newskip\normbskip\newskip\normpskip\newskip\normlskip
-
-
-\envdef\cartouche{%
- \cartouchefontdefs
- \ifhmode\par\fi % can't be in the midst of a paragraph.
- \startsavinginserts
- \lskip=\leftskip \rskip=\rightskip
- \leftskip=0pt\rightskip=0pt % we want these *outside*.
- \cartinner=\hsize \advance\cartinner by-\lskip
- \advance\cartinner by-\rskip
- \cartouter=\hsize
- \advance\cartouter by 18.4pt % allow for 3pt kerns on either
- % side, and for 6pt waste from
- % each corner char, and rule thickness
- \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip
- %
- % If this cartouche directly follows a sectioning command, we need the
- % \parskip glue (backspaced over by default) or the cartouche can
- % collide with the section heading.
- \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi
- %
- \setbox\groupbox=\vbox\bgroup
- \baselineskip=0pt\parskip=0pt\lineskip=0pt
- \carttop
- \hbox\bgroup
- \hskip\lskip
- \vrule\kern3pt
- \vbox\bgroup
- \kern3pt
- \hsize=\cartinner
- \baselineskip=\normbskip
- \lineskip=\normlskip
- \parskip=\normpskip
- \vskip -\parskip
- \comment % For explanation, see the end of def\group.
-}
-\def\Ecartouche{%
- \ifhmode\par\fi
- \kern3pt
- \egroup
- \kern3pt\vrule
- \hskip\rskip
- \egroup
- \cartbot
- \egroup
- \addgroupbox
- \checkinserts
-}
-
-
-% This macro is called at the beginning of all the @example variants,
-% inside a group.
-\newdimen\nonfillparindent
-\def\nonfillstart{%
- \aboveenvbreak
- \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy
- \sepspaces % Make spaces be word-separators rather than space tokens.
- \let\par = \lisppar % don't ignore blank lines
- \obeylines % each line of input is a line of output
- \parskip = 0pt
- % Turn off paragraph indentation but redefine \indent to emulate
- % the normal \indent.
- \nonfillparindent=\parindent
- \parindent = 0pt
- \let\indent\nonfillindent
- %
- \emergencystretch = 0pt % don't try to avoid overfull boxes
- \ifx\nonarrowing\relax
- \advance \leftskip by \lispnarrowing
- \exdentamount=\lispnarrowing
- \else
- \let\nonarrowing = \relax
- \fi
- \let\exdent=\nofillexdent
-}
-
-\begingroup
-\obeyspaces
-% We want to swallow spaces (but not other tokens) after the fake
-% @indent in our nonfill-environments, where spaces are normally
-% active and set to @tie, resulting in them not being ignored after
-% @indent.
-\gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}%
-\gdef\nonfillindentcheck{%
-\ifx\temp %
-\expandafter\nonfillindentgobble%
-\else%
-\leavevmode\nonfillindentbox%
-\fi%
-}%
-\endgroup
-\def\nonfillindentgobble#1{\nonfillindent}
-\def\nonfillindentbox{\hbox to \nonfillparindent{\hss}}
-
-% If you want all examples etc. small: @set dispenvsize small.
-% If you want even small examples the full size: @set dispenvsize nosmall.
-% This affects the following displayed environments:
-% @example, @display, @format, @lisp
-%
-\def\smallword{small}
-\def\nosmallword{nosmall}
-\let\SETdispenvsize\relax
-\def\setnormaldispenv{%
- \ifx\SETdispenvsize\smallword
- % end paragraph for sake of leading, in case document has no blank
- % line. This is redundant with what happens in \aboveenvbreak, but
- % we need to do it before changing the fonts, and it's inconvenient
- % to change the fonts afterward.
- \ifnum \lastpenalty=10000 \else \endgraf \fi
- \smallexamplefonts \rm
- \fi
-}
-\def\setsmalldispenv{%
- \ifx\SETdispenvsize\nosmallword
- \else
- \ifnum \lastpenalty=10000 \else \endgraf \fi
- \smallexamplefonts \rm
- \fi
-}
-
-% We often define two environments, @foo and @smallfoo.
-% Let's do it in one command. #1 is the env name, #2 the definition.
-\def\makedispenvdef#1#2{%
- \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}%
- \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}%
- \expandafter\let\csname E#1\endcsname \afterenvbreak
- \expandafter\let\csname Esmall#1\endcsname \afterenvbreak
-}
-
-% Define two environment synonyms (#1 and #2) for an environment.
-\def\maketwodispenvdef#1#2#3{%
- \makedispenvdef{#1}{#3}%
- \makedispenvdef{#2}{#3}%
-}
-%
-% @lisp: indented, narrowed, typewriter font;
-% @example: same as @lisp.
-%
-% @smallexample and @smalllisp: use smaller fonts.
-% Originally contributed by Pavel@xerox.
-%
-\maketwodispenvdef{lisp}{example}{%
- \nonfillstart
- \tt\setupmarkupstyle{example}%
- \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special.
- \gobble % eat return
-}
-% @display/@smalldisplay: same as @lisp except keep current font.
-%
-\makedispenvdef{display}{%
- \nonfillstart
- \gobble
-}
-
-% @format/@smallformat: same as @display except don't narrow margins.
-%
-\makedispenvdef{format}{%
- \let\nonarrowing = t%
- \nonfillstart
- \gobble
-}
-
-% @flushleft: same as @format, but doesn't obey \SETdispenvsize.
-\envdef\flushleft{%
- \let\nonarrowing = t%
- \nonfillstart
- \gobble
-}
-\let\Eflushleft = \afterenvbreak
-
-% @flushright.
-%
-\envdef\flushright{%
- \let\nonarrowing = t%
- \nonfillstart
- \advance\leftskip by 0pt plus 1fill\relax
- \gobble
-}
-\let\Eflushright = \afterenvbreak
-
-
-% @raggedright does more-or-less normal line breaking but no right
-% justification. From plain.tex.
-\envdef\raggedright{%
- \rightskip0pt plus2.4em \spaceskip.3333em \xspaceskip.5em\relax
-}
-\let\Eraggedright\par
-
-\envdef\raggedleft{%
- \parindent=0pt \leftskip0pt plus2em
- \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
- \hbadness=10000 % Last line will usually be underfull, so turn off
- % badness reporting.
-}
-\let\Eraggedleft\par
-
-\envdef\raggedcenter{%
- \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em
- \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt
- \hbadness=10000 % Last line will usually be underfull, so turn off
- % badness reporting.
-}
-\let\Eraggedcenter\par
-
-
-% @quotation does normal linebreaking (hence we can't use \nonfillstart)
-% and narrows the margins. We keep \parskip nonzero in general, since
-% we're doing normal filling. So, when using \aboveenvbreak and
-% \afterenvbreak, temporarily make \parskip 0.
-%
-\makedispenvdef{quotation}{\quotationstart}
-%
-\def\quotationstart{%
- \indentedblockstart % same as \indentedblock, but increase right margin too.
- \ifx\nonarrowing\relax
- \advance\rightskip by \lispnarrowing
- \fi
- \parsearg\quotationlabel
-}
-
-% We have retained a nonzero parskip for the environment, since we're
-% doing normal filling.
-%
-\def\Equotation{%
- \par
- \ifx\quotationauthor\thisisundefined\else
- % indent a bit.
- \leftline{\kern 2\leftskip \sl ---\quotationauthor}%
- \fi
- {\parskip=0pt \afterenvbreak}%
-}
-\def\Esmallquotation{\Equotation}
-
-% If we're given an argument, typeset it in bold with a colon after.
-\def\quotationlabel#1{%
- \def\temp{#1}%
- \ifx\temp\empty \else
- {\bf #1: }%
- \fi
-}
-
-% @indentedblock is like @quotation, but indents only on the left and
-% has no optional argument.
-%
-\makedispenvdef{indentedblock}{\indentedblockstart}
-%
-\def\indentedblockstart{%
- {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip
- \parindent=0pt
- %
- % @cartouche defines \nonarrowing to inhibit narrowing at next level down.
- \ifx\nonarrowing\relax
- \advance\leftskip by \lispnarrowing
- \exdentamount = \lispnarrowing
- \else
- \let\nonarrowing = \relax
- \fi
-}
-
-% Keep a nonzero parskip for the environment, since we're doing normal filling.
-%
-\def\Eindentedblock{%
- \par
- {\parskip=0pt \afterenvbreak}%
-}
-\def\Esmallindentedblock{\Eindentedblock}
-
-
-% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>}
-% If we want to allow any <char> as delimiter,
-% we need the curly braces so that makeinfo sees the @verb command, eg:
-% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org
-%
-% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook.
-%
-% [Knuth] p.344; only we need to do the other characters Texinfo sets
-% active too. Otherwise, they get lost as the first character on a
-% verbatim line.
-\def\dospecials{%
- \do\ \do\\\do\{\do\}\do\$\do\&%
- \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~%
- \do\<\do\>\do\|\do\@\do+\do\"%
- % Don't do the quotes -- if we do, @set txicodequoteundirected and
- % @set txicodequotebacktick will not have effect on @verb and
- % @verbatim, and ?` and !` ligatures won't get disabled.
- %\do\`\do\'%
-}
-%
-% [Knuth] p. 380
-\def\uncatcodespecials{%
- \def\do##1{\catcode`##1=\other}\dospecials}
-%
-% Setup for the @verb command.
-%
-% Eight spaces for a tab
-\begingroup
- \catcode`\^^I=\active
- \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }}
-\endgroup
-%
-\def\setupverb{%
- \tt % easiest (and conventionally used) font for verbatim
- \def\par{\leavevmode\endgraf}%
- \setupmarkupstyle{verb}%
- \tabeightspaces
- % Respect line breaks,
- % print special symbols as themselves, and
- % make each space count
- % must do in this order:
- \obeylines \uncatcodespecials \sepspaces
-}
-
-% Setup for the @verbatim environment
-%
-% Real tab expansion.
-\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount
-%
-% We typeset each line of the verbatim in an \hbox, so we can handle
-% tabs. The \global is in case the verbatim line starts with an accent,
-% or some other command that starts with a begin-group. Otherwise, the
-% entire \verbbox would disappear at the corresponding end-group, before
-% it is typeset. Meanwhile, we can't have nested verbatim commands
-% (can we?), so the \global won't be overwriting itself.
-\newbox\verbbox
-\def\starttabbox{\global\setbox\verbbox=\hbox\bgroup}
-%
-\begingroup
- \catcode`\^^I=\active
- \gdef\tabexpand{%
- \catcode`\^^I=\active
- \def^^I{\leavevmode\egroup
- \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab
- \divide\dimen\verbbox by\tabw
- \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw
- \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw
- \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox
- }%
- }
-\endgroup
-
-% start the verbatim environment.
-\def\setupverbatim{%
- \let\nonarrowing = t%
- \nonfillstart
- \tt % easiest (and conventionally used) font for verbatim
- % The \leavevmode here is for blank lines. Otherwise, we would
- % never \starttabbox and the \egroup would end verbatim mode.
- \def\par{\leavevmode\egroup\box\verbbox\endgraf}%
- \tabexpand
- \setupmarkupstyle{verbatim}%
- % Respect line breaks,
- % print special symbols as themselves, and
- % make each space count.
- % Must do in this order:
- \obeylines \uncatcodespecials \sepspaces
- \everypar{\starttabbox}%
-}
-
-% Do the @verb magic: verbatim text is quoted by unique
-% delimiter characters. Before first delimiter expect a
-% right brace, after last delimiter expect closing brace:
-%
-% \def\doverb'{'<char>#1<char>'}'{#1}
-%
-% [Knuth] p. 382; only eat outer {}
-\begingroup
- \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other
- \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next]
-\endgroup
-%
-\def\verb{\begingroup\setupverb\doverb}
-%
-%
-% Do the @verbatim magic: define the macro \doverbatim so that
-% the (first) argument ends when '@end verbatim' is reached, ie:
-%
-% \def\doverbatim#1@end verbatim{#1}
-%
-% For Texinfo it's a lot easier than for LaTeX,
-% because texinfo's \verbatim doesn't stop at '\end{verbatim}':
-% we need not redefine '\', '{' and '}'.
-%
-% Inspired by LaTeX's verbatim command set [latex.ltx]
-%
-\begingroup
- \catcode`\ =\active
- \obeylines %
- % ignore everything up to the first ^^M, that's the newline at the end
- % of the @verbatim input line itself. Otherwise we get an extra blank
- % line in the output.
- \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}%
- % We really want {...\end verbatim} in the body of the macro, but
- % without the active space; thus we have to use \xdef and \gobble.
-\endgroup
-%
-\envdef\verbatim{%
- \setupverbatim\doverbatim
-}
-\let\Everbatim = \afterenvbreak
-
-
-% @verbatiminclude FILE - insert text of file in verbatim environment.
-%
-\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude}
-%
-\def\doverbatiminclude#1{%
- {%
- \makevalueexpandable
- \setupverbatim
- {%
- \indexnofonts % Allow `@@' and other weird things in file names.
- \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}%
- \edef\tmp{\noexpand\input #1 }
- \expandafter
- }\tmp
- \afterenvbreak
- }%
-}
-
-% @copying ... @end copying.
-% Save the text away for @insertcopying later.
-%
-% We save the uninterpreted tokens, rather than creating a box.
-% Saving the text in a box would be much easier, but then all the
-% typesetting commands (@smallbook, font changes, etc.) have to be done
-% beforehand -- and a) we want @copying to be done first in the source
-% file; b) letting users define the frontmatter in as flexible order as
-% possible is desirable.
-%
-\def\copying{\checkenv{}\begingroup\scanargctxt\docopying}
-\def\docopying#1@end copying{\endgroup\def\copyingtext{#1}}
-%
-\def\insertcopying{%
- \begingroup
- \parindent = 0pt % paragraph indentation looks wrong on title page
- \scanexp\copyingtext
- \endgroup
-}
-
-
-\message{defuns,}
-% @defun etc.
-
-\newskip\defbodyindent \defbodyindent=.4in
-\newskip\defargsindent \defargsindent=50pt
-\newskip\deflastargmargin \deflastargmargin=18pt
-\newcount\defunpenalty
-
-% Start the processing of @deffn:
-\def\startdefun{%
- \ifnum\lastpenalty<10000
- \medbreak
- \defunpenalty=10003 % Will keep this @deffn together with the
- % following @def command, see below.
- \else
- % If there are two @def commands in a row, we'll have a \nobreak,
- % which is there to keep the function description together with its
- % header. But if there's nothing but headers, we need to allow a
- % break somewhere. Check specifically for penalty 10002, inserted
- % by \printdefunline, instead of 10000, since the sectioning
- % commands also insert a nobreak penalty, and we don't want to allow
- % a break between a section heading and a defun.
- %
- % As a further refinement, we avoid "club" headers by signalling
- % with penalty of 10003 after the very first @deffn in the
- % sequence (see above), and penalty of 10002 after any following
- % @def command.
- \ifnum\lastpenalty=10002 \penalty2000 \else \defunpenalty=10002 \fi
- %
- % Similarly, after a section heading, do not allow a break.
- % But do insert the glue.
- \medskip % preceded by discardable penalty, so not a breakpoint
- \fi
- %
- \parindent=0in
- \advance\leftskip by \defbodyindent
- \exdentamount=\defbodyindent
-}
-
-\def\dodefunx#1{%
- % First, check whether we are in the right environment:
- \checkenv#1%
- %
- % As above, allow line break if we have multiple x headers in a row.
- % It's not a great place, though.
- \ifnum\lastpenalty=10002 \penalty3000 \else \defunpenalty=10002 \fi
- %
- % And now, it's time to reuse the body of the original defun:
- \expandafter\gobbledefun#1%
-}
-\def\gobbledefun#1\startdefun{}
-
-% \printdefunline \deffnheader{text}
-%
-\def\printdefunline#1#2{%
- \begingroup
- % call \deffnheader:
- #1#2 \endheader
- % common ending:
- \interlinepenalty = 10000
- \advance\rightskip by 0pt plus 1fil\relax
- \endgraf
- \nobreak\vskip -\parskip
- \penalty\defunpenalty % signal to \startdefun and \dodefunx
- % Some of the @defun-type tags do not enable magic parentheses,
- % rendering the following check redundant. But we don't optimize.
- \checkparencounts
- \endgroup
-}
-
-\def\Edefun{\endgraf\medbreak}
-
-% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn;
-% the only thing remaining is to define \deffnheader.
-%
-\def\makedefun#1{%
- \expandafter\let\csname E#1\endcsname = \Edefun
- \edef\temp{\noexpand\domakedefun
- \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}%
- \temp
-}
-
-% \domakedefun \deffn \deffnx \deffnheader { (defn. of \deffnheader) }
-%
-% Define \deffn and \deffnx, without parameters.
-% \deffnheader has to be defined explicitly.
-%
-\def\domakedefun#1#2#3{%
- \envdef#1{%
- \startdefun
- \doingtypefnfalse % distinguish typed functions from all else
- \parseargusing\activeparens{\printdefunline#3}%
- }%
- \def#2{\dodefunx#1}%
- \def#3%
-}
-
-\newif\ifdoingtypefn % doing typed function?
-\newif\ifrettypeownline % typeset return type on its own line?
-
-% @deftypefnnewline on|off says whether the return type of typed functions
-% are printed on their own line. This affects @deftypefn, @deftypefun,
-% @deftypeop, and @deftypemethod.
-%
-\parseargdef\deftypefnnewline{%
- \def\temp{#1}%
- \ifx\temp\onword
- \expandafter\let\csname SETtxideftypefnnl\endcsname
- = \empty
- \else\ifx\temp\offword
- \expandafter\let\csname SETtxideftypefnnl\endcsname
- = \relax
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @txideftypefnnl value `\temp',
- must be on|off}%
- \fi\fi
-}
-
-% \dosubind {index}{topic}{subtopic}
-%
-% If SUBTOPIC is present, precede it with a space, and call \doind.
-% (At some time during the 20th century, this made a two-level entry in an
-% index such as the operation index. Nobody seemed to notice the change in
-% behaviour though.)
-\def\dosubind#1#2#3{%
- \def\thirdarg{#3}%
- \ifx\thirdarg\empty
- \doind{#1}{#2}%
- \else
- \doind{#1}{#2\space#3}%
- \fi
-}
-
-% Untyped functions:
-
-% @deffn category name args
-\makedefun{deffn}{\deffngeneral{}}
-
-% @deffn category class name args
-\makedefun{defop}#1 {\defopon{#1\ \putwordon}}
-
-% \defopon {category on}class name args
-\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
-
-% \deffngeneral {subind}category name args
-%
-\def\deffngeneral#1#2 #3 #4\endheader{%
- \dosubind{fn}{\code{#3}}{#1}%
- \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}%
-}
-
-% Typed functions:
-
-% @deftypefn category type name args
-\makedefun{deftypefn}{\deftypefngeneral{}}
-
-% @deftypeop category class type name args
-\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}}
-
-% \deftypeopon {category on}class type name args
-\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} }
-
-% \deftypefngeneral {subind}category type name args
-%
-\def\deftypefngeneral#1#2 #3 #4 #5\endheader{%
- \dosubind{fn}{\code{#4}}{#1}%
- \doingtypefntrue
- \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
-}
-
-% Typed variables:
-
-% @deftypevr category type var args
-\makedefun{deftypevr}{\deftypecvgeneral{}}
-
-% @deftypecv category class type var args
-\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}}
-
-% \deftypecvof {category of}class type var args
-\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} }
-
-% \deftypecvgeneral {subind}category type var args
-%
-\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{%
- \dosubind{vr}{\code{#4}}{#1}%
- \defname{#2}{#3}{#4}\defunargs{#5\unskip}%
-}
-
-% Untyped variables:
-
-% @defvr category var args
-\makedefun{defvr}#1 {\deftypevrheader{#1} {} }
-
-% @defcv category class var args
-\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}}
-
-% \defcvof {category of}class var args
-\def\defcvof#1#2 {\deftypecvof{#1}#2 {} }
-
-% Types:
-
-% @deftp category name args
-\makedefun{deftp}#1 #2 #3\endheader{%
- \doind{tp}{\code{#2}}%
- \defname{#1}{}{#2}\defunargs{#3\unskip}%
-}
-
-% Remaining @defun-like shortcuts:
-\makedefun{defun}{\deffnheader{\putwordDeffunc} }
-\makedefun{defmac}{\deffnheader{\putwordDefmac} }
-\makedefun{defspec}{\deffnheader{\putwordDefspec} }
-\makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} }
-\makedefun{defvar}{\defvrheader{\putwordDefvar} }
-\makedefun{defopt}{\defvrheader{\putwordDefopt} }
-\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} }
-\makedefun{defmethod}{\defopon\putwordMethodon}
-\makedefun{deftypemethod}{\deftypeopon\putwordMethodon}
-\makedefun{defivar}{\defcvof\putwordInstanceVariableof}
-\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof}
-
-% \defname, which formats the name of the @def (not the args).
-% #1 is the category, such as "Function".
-% #2 is the return type, if any.
-% #3 is the function name.
-%
-% We are followed by (but not passed) the arguments, if any.
-%
-\def\defname#1#2#3{%
- \par
- % Get the values of \leftskip and \rightskip as they were outside the @def...
- \advance\leftskip by -\defbodyindent
- %
- % Determine if we are typesetting the return type of a typed function
- % on a line by itself.
- \rettypeownlinefalse
- \ifdoingtypefn % doing a typed function specifically?
- % then check user option for putting return type on its own line:
- \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else
- \rettypeownlinetrue
- \fi
- \fi
- %
- % How we'll format the category name. Putting it in brackets helps
- % distinguish it from the body text that may end up on the next line
- % just below it.
- \def\temp{#1}%
- \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi}
- %
- % Figure out line sizes for the paragraph shape. We'll always have at
- % least two.
- \tempnum = 2
- %
- % The first line needs space for \box0; but if \rightskip is nonzero,
- % we need only space for the part of \box0 which exceeds it:
- \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip
- %
- % If doing a return type on its own line, we'll have another line.
- \ifrettypeownline
- \advance\tempnum by 1
- \def\maybeshapeline{0in \hsize}%
- \else
- \def\maybeshapeline{}%
- \fi
- %
- % The continuations:
- \dimen2=\hsize \advance\dimen2 by -\defargsindent
- %
- % The final paragraph shape:
- \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2
- %
- % Put the category name at the right margin.
- \noindent
- \hbox to 0pt{%
- \hfil\box0 \kern-\hsize
- % \hsize has to be shortened this way:
- \kern\leftskip
- % Intentionally do not respect \rightskip, since we need the space.
- }%
- %
- % Allow all lines to be underfull without complaint:
- \tolerance=10000 \hbadness=10000
- \exdentamount=\defbodyindent
- {%
- % defun fonts. We use typewriter by default (used to be bold) because:
- % . we're printing identifiers, they should be in tt in principle.
- % . in languages with many accents, such as Czech or French, it's
- % common to leave accents off identifiers. The result looks ok in
- % tt, but exceedingly strange in rm.
- % . we don't want -- and --- to be treated as ligatures.
- % . this still does not fix the ?` and !` ligatures, but so far no
- % one has made identifiers using them :).
- \df \tt
- \def\temp{#2}% text of the return type
- \ifx\temp\empty\else
- \tclose{\temp}% typeset the return type
- \ifrettypeownline
- % put return type on its own line; prohibit line break following:
- \hfil\vadjust{\nobreak}\break
- \else
- \space % type on same line, so just followed by a space
- \fi
- \fi % no return type
- #3% output function name
- }%
- {\rm\enskip}% hskip 0.5 em of \rmfont
- %
- \boldbrax
- % arguments will be output next, if any.
-}
-
-% Print arguments in slanted roman (not ttsl), inconsistently with using
-% tt for the name. This is because literal text is sometimes needed in
-% the argument list (groff manual), and ttsl and tt are not very
-% distinguishable. Prevent hyphenation at `-' chars.
-%
-\def\defunargs#1{%
- % use sl by default (not ttsl),
- % tt for the names.
- \df \sl \hyphenchar\font=0
- %
- % On the other hand, if an argument has two dashes (for instance), we
- % want a way to get ttsl. We used to recommend @var for that, so
- % leave the code in, but it's strange for @var to lead to typewriter.
- % Nowadays we recommend @code, since the difference between a ttsl hyphen
- % and a tt hyphen is pretty tiny. @code also disables ?` !`.
- \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}%
- #1%
- \sl\hyphenchar\font=45
-}
-
-% We want ()&[] to print specially on the defun line.
-%
-\def\activeparens{%
- \catcode`\(=\active \catcode`\)=\active
- \catcode`\[=\active \catcode`\]=\active
- \catcode`\&=\active
-}
-
-% Make control sequences which act like normal parenthesis chars.
-\let\lparen = ( \let\rparen = )
-
-% Be sure that we always have a definition for `(', etc. For example,
-% if the fn name has parens in it, \boldbrax will not be in effect yet,
-% so TeX would otherwise complain about undefined control sequence.
-{
- \activeparens
- \global\let(=\lparen \global\let)=\rparen
- \global\let[=\lbrack \global\let]=\rbrack
- \global\let& = \&
-
- \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb}
- \gdef\magicamp{\let&=\amprm}
-}
-\let\ampchar\&
-
-\newcount\parencount
-
-% If we encounter &foo, then turn on ()-hacking afterwards
-\newif\ifampseen
-\def\amprm#1 {\ampseentrue{\bf\&#1 }}
-
-\def\parenfont{%
- \ifampseen
- % At the first level, print parens in roman,
- % otherwise use the default font.
- \ifnum \parencount=1 \rm \fi
- \else
- % The \sf parens (in \boldbrax) actually are a little bolder than
- % the contained text. This is especially needed for [ and ] .
- \sf
- \fi
-}
-\def\infirstlevel#1{%
- \ifampseen
- \ifnum\parencount=1
- #1%
- \fi
- \fi
-}
-\def\bfafterword#1 {#1 \bf}
-
-\def\opnr{%
- \global\advance\parencount by 1
- {\parenfont(}%
- \infirstlevel \bfafterword
-}
-\def\clnr{%
- {\parenfont)}%
- \infirstlevel \sl
- \global\advance\parencount by -1
-}
-
-\newcount\brackcount
-\def\lbrb{%
- \global\advance\brackcount by 1
- {\bf[}%
-}
-\def\rbrb{%
- {\bf]}%
- \global\advance\brackcount by -1
-}
-
-\def\checkparencounts{%
- \ifnum\parencount=0 \else \badparencount \fi
- \ifnum\brackcount=0 \else \badbrackcount \fi
-}
-% these should not use \errmessage; the glibc manual, at least, actually
-% has such constructs (when documenting function pointers).
-\def\badparencount{%
- \message{Warning: unbalanced parentheses in @def...}%
- \global\parencount=0
-}
-\def\badbrackcount{%
- \message{Warning: unbalanced square brackets in @def...}%
- \global\brackcount=0
-}
-
-
-\message{macros,}
-% @macro.
-
-% To do this right we need a feature of e-TeX, \scantokens,
-% which we arrange to emulate with a temporary file in ordinary TeX.
-\ifx\eTeXversion\thisisundefined
- \newwrite\macscribble
- \def\scantokens#1{%
- \toks0={#1}%
- \immediate\openout\macscribble=\jobname.tmp
- \immediate\write\macscribble{\the\toks0}%
- \immediate\closeout\macscribble
- \input \jobname.tmp
- }
-\fi
-
-% Used at the time of macro expansion.
-% Argument is macro body with arguments substituted
-\def\scanmacro#1{%
- \newlinechar`\^^M
- \def\xeatspaces{\eatspaces}%
- %
- % Process the macro body under the current catcode regime.
- \scantokens{#1@comment}%
- %
- % The \comment is to remove the \newlinechar added by \scantokens, and
- % can be noticed by \parsearg. Note \c isn't used because this means cedilla
- % in math mode.
-}
-
-% Used for copying and captions
-\def\scanexp#1{%
- \expandafter\scanmacro\expandafter{#1}%
-}
-
-\newcount\paramno % Count of parameters
-\newtoks\macname % Macro name
-\newif\ifrecursive % Is it recursive?
-
-% List of all defined macros in the form
-% \commondummyword\macro1\commondummyword\macro2...
-% Currently is also contains all @aliases; the list can be split
-% if there is a need.
-\def\macrolist{}
-
-% Add the macro to \macrolist
-\def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname}
-\def\addtomacrolistxxx#1{%
- \toks0 = \expandafter{\macrolist\commondummyword#1}%
- \xdef\macrolist{\the\toks0}%
-}
-
-% Utility routines.
-% This does \let #1 = #2, with \csnames; that is,
-% \let \csname#1\endcsname = \csname#2\endcsname
-% (except of course we have to play expansion games).
-%
-\def\cslet#1#2{%
- \expandafter\let
- \csname#1\expandafter\endcsname
- \csname#2\endcsname
-}
-
-% Trim leading and trailing spaces off a string.
-% Concepts from aro-bend problem 15 (see CTAN).
-{\catcode`\@=11
-\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }}
-\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@}
-\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @}
-\def\unbrace#1{#1}
-\unbrace{\gdef\trim@@@ #1 } #2@{#1}
-}
-
-% Trim a single trailing ^^M off a string.
-{\catcode`\^^M=\other \catcode`\Q=3%
-\gdef\eatcr #1{\eatcra #1Q^^MQ}%
-\gdef\eatcra#1^^MQ{\eatcrb#1Q}%
-\gdef\eatcrb#1Q#2Q{#1}%
-}
-
-% Macro bodies are absorbed as an argument in a context where
-% all characters are catcode 10, 11 or 12, except \ which is active
-% (as in normal texinfo). It is necessary to change the definition of \
-% to recognize macro arguments; this is the job of \mbodybackslash.
-%
-% Non-ASCII encodings make 8-bit characters active, so un-activate
-% them to avoid their expansion. Must do this non-globally, to
-% confine the change to the current group.
-%
-% It's necessary to have hard CRs when the macro is executed. This is
-% done by making ^^M (\endlinechar) catcode 12 when reading the macro
-% body, and then making it the \newlinechar in \scanmacro.
-%
-\def\scanctxt{% used as subroutine
- \catcode`\"=\other
- \catcode`\+=\other
- \catcode`\<=\other
- \catcode`\>=\other
- \catcode`\^=\other
- \catcode`\_=\other
- \catcode`\|=\other
- \catcode`\~=\other
- \passthroughcharstrue
-}
-
-\def\scanargctxt{% used for copying and captions, not macros.
- \scanctxt
- \catcode`\@=\other
- \catcode`\\=\other
- \catcode`\^^M=\other
-}
-
-\def\macrobodyctxt{% used for @macro definitions
- \scanctxt
- \catcode`\ =\other
- \catcode`\@=\other
- \catcode`\{=\other
- \catcode`\}=\other
- \catcode`\^^M=\other
- \usembodybackslash
-}
-
-% Used when scanning braced macro arguments. Note, however, that catcode
-% changes here are ineffectual if the macro invocation was nested inside
-% an argument to another Texinfo command.
-\def\macroargctxt{%
- \scanctxt
- \catcode`\ =\active
- \catcode`\@=\other
- \catcode`\^^M=\other
- \catcode`\\=\active
-}
-
-\def\macrolineargctxt{% used for whole-line arguments without braces
- \scanctxt
- \catcode`\@=\other
- \catcode`\{=\other
- \catcode`\}=\other
-}
-
-% \mbodybackslash is the definition of \ in @macro bodies.
-% It maps \foo\ => \csname macarg.foo\endcsname => #N
-% where N is the macro parameter number.
-% We define \csname macarg.\endcsname to be \realbackslash, so
-% \\ in macro replacement text gets you a backslash.
-%
-{\catcode`@=0 @catcode`@\=@active
- @gdef@usembodybackslash{@let\=@mbodybackslash}
- @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname}
-}
-\expandafter\def\csname macarg.\endcsname{\realbackslash}
-
-\def\margbackslash#1{\char`\#1 }
-
-\def\macro{\recursivefalse\parsearg\macroxxx}
-\def\rmacro{\recursivetrue\parsearg\macroxxx}
-
-\def\macroxxx#1{%
- \getargs{#1}% now \macname is the macname and \argl the arglist
- \ifx\argl\empty % no arguments
- \paramno=0\relax
- \else
- \expandafter\parsemargdef \argl;%
- \if\paramno>256\relax
- \ifx\eTeXversion\thisisundefined
- \errhelp = \EMsimple
- \errmessage{You need eTeX to compile a file with macros with more than 256 arguments}
- \fi
- \fi
- \fi
- \if1\csname ismacro.\the\macname\endcsname
- \message{Warning: redefining \the\macname}%
- \else
- \expandafter\ifx\csname \the\macname\endcsname \relax
- \else \errmessage{Macro name \the\macname\space already defined}\fi
- \global\cslet{macsave.\the\macname}{\the\macname}%
- \global\expandafter\let\csname ismacro.\the\macname\endcsname=1%
- \addtomacrolist{\the\macname}%
- \fi
- \begingroup \macrobodyctxt
- \ifrecursive \expandafter\parsermacbody
- \else \expandafter\parsemacbody
- \fi}
-
-\parseargdef\unmacro{%
- \if1\csname ismacro.#1\endcsname
- \global\cslet{#1}{macsave.#1}%
- \global\expandafter\let \csname ismacro.#1\endcsname=0%
- % Remove the macro name from \macrolist:
- \begingroup
- \expandafter\let\csname#1\endcsname \relax
- \let\commondummyword\unmacrodo
- \xdef\macrolist{\macrolist}%
- \endgroup
- \else
- \errmessage{Macro #1 not defined}%
- \fi
-}
-
-% Called by \do from \dounmacro on each macro. The idea is to omit any
-% macro definitions that have been changed to \relax.
-%
-\def\unmacrodo#1{%
- \ifx #1\relax
- % remove this
- \else
- \noexpand\commondummyword \noexpand#1%
- \fi
-}
-
-% \getargs -- Parse the arguments to a @macro line. Set \macname to
-% the name of the macro, and \argl to the braced argument list.
-\def\getargs#1{\getargsxxx#1{}}
-\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs}
-\def\getmacname#1 #2\relax{\macname={#1}}
-\def\getmacargs#1{\def\argl{#1}}
-% This made use of the feature that if the last token of a
-% <parameter list> is #, then the preceding argument is delimited by
-% an opening brace, and that opening brace is not consumed.
-
-% Parse the optional {params} list to @macro or @rmacro.
-% Set \paramno to the number of arguments,
-% and \paramlist to a parameter text for the macro (e.g. #1,#2,#3 for a
-% three-param macro.) Define \macarg.BLAH for each BLAH in the params
-% list to some hook where the argument is to be expanded. If there are
-% less than 10 arguments that hook is to be replaced by ##N where N
-% is the position in that list, that is to say the macro arguments are to be
-% defined `a la TeX in the macro body.
-%
-% That gets used by \mbodybackslash (above).
-%
-% If there are 10 or more arguments, a different technique is used: see
-% \parsemmanyargdef.
-%
-\def\parsemargdef#1;{%
- \paramno=0\def\paramlist{}%
- \let\hash\relax
- % \hash is redefined to `#' later to get it into definitions
- \let\xeatspaces\relax
- \parsemargdefxxx#1,;,%
- \ifnum\paramno<10\relax\else
- \paramno0\relax
- \parsemmanyargdef@@#1,;,% 10 or more arguments
- \fi
-}
-\def\parsemargdefxxx#1,{%
- \if#1;\let\next=\relax
- \else \let\next=\parsemargdefxxx
- \advance\paramno by 1
- \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname
- {\xeatspaces{\hash\the\paramno}}%
- \edef\paramlist{\paramlist\hash\the\paramno,}%
- \fi\next}
-
-% \parsemacbody, \parsermacbody
-%
-% Read recursive and nonrecursive macro bodies. (They're different since
-% rec and nonrec macros end differently.)
-%
-% We are in \macrobodyctxt, and the \xdef causes backslashshes in the macro
-% body to be transformed.
-% Set \macrobody to the body of the macro, and call \defmacro.
-%
-{\catcode`\ =\other\long\gdef\parsemacbody#1@end macro{%
-\xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
-{\catcode`\ =\other\long\gdef\parsermacbody#1@end rmacro{%
-\xdef\macrobody{\eatcr{#1}}\endgroup\defmacro}}%
-
-% Make @ a letter, so that we can make private-to-Texinfo macro names.
-\edef\texiatcatcode{\the\catcode`\@}
-\catcode `@=11\relax
-
-%%%%%%%%%%%%%% Code for > 10 arguments only %%%%%%%%%%%%%%%%%%
-
-% If there are 10 or more arguments, a different technique is used, where the
-% hook remains in the body, and when macro is to be expanded the body is
-% processed again to replace the arguments.
-%
-% In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the
-% argument N value and then \edef the body (nothing else will expand because of
-% the catcode regime under which the body was input).
-%
-% If you compile with TeX (not eTeX), and you have macros with 10 or more
-% arguments, no macro can have more than 256 arguments (else error).
-%
-% In case that there are 10 or more arguments we parse again the arguments
-% list to set new definitions for the \macarg.BLAH macros corresponding to
-% each BLAH argument. It was anyhow needed to parse already once this list
-% in order to count the arguments, and as macros with at most 9 arguments
-% are by far more frequent than macro with 10 or more arguments, defining
-% twice the \macarg.BLAH macros does not cost too much processing power.
-\def\parsemmanyargdef@@#1,{%
- \if#1;\let\next=\relax
- \else
- \let\next=\parsemmanyargdef@@
- \edef\tempb{\eatspaces{#1}}%
- \expandafter\def\expandafter\tempa
- \expandafter{\csname macarg.\tempb\endcsname}%
- % Note that we need some extra \noexpand\noexpand, this is because we
- % don't want \the to be expanded in the \parsermacbody as it uses an
- % \xdef .
- \expandafter\edef\tempa
- {\noexpand\noexpand\noexpand\the\toks\the\paramno}%
- \advance\paramno by 1\relax
- \fi\next}
-
-
-\let\endargs@\relax
-\let\nil@\relax
-\def\nilm@{\nil@}%
-\long\def\nillm@{\nil@}%
-
-% This macro is expanded during the Texinfo macro expansion, not during its
-% definition. It gets all the arguments' values and assigns them to macros
-% macarg.ARGNAME
-%
-% #1 is the macro name
-% #2 is the list of argument names
-% #3 is the list of argument values
-\def\getargvals@#1#2#3{%
- \def\macargdeflist@{}%
- \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion.
- \def\paramlist{#2,\nil@}%
- \def\macroname{#1}%
- \begingroup
- \macroargctxt
- \def\argvaluelist{#3,\nil@}%
- \def\@tempa{#3}%
- \ifx\@tempa\empty
- \setemptyargvalues@
- \else
- \getargvals@@
- \fi
-}
-\def\getargvals@@{%
- \ifx\paramlist\nilm@
- % Some sanity check needed here that \argvaluelist is also empty.
- \ifx\argvaluelist\nillm@
- \else
- \errhelp = \EMsimple
- \errmessage{Too many arguments in macro `\macroname'!}%
- \fi
- \let\next\macargexpandinbody@
- \else
- \ifx\argvaluelist\nillm@
- % No more arguments values passed to macro. Set remaining named-arg
- % macros to empty.
- \let\next\setemptyargvalues@
- \else
- % pop current arg name into \@tempb
- \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}%
- \expandafter\@tempa\expandafter{\paramlist}%
- % pop current argument value into \@tempc
- \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}%
- \expandafter\@tempa\expandafter{\argvaluelist}%
- % Here \@tempb is the current arg name and \@tempc is the current arg value.
- % First place the new argument macro definition into \@tempd
- \expandafter\macname\expandafter{\@tempc}%
- \expandafter\let\csname macarg.\@tempb\endcsname\relax
- \expandafter\def\expandafter\@tempe\expandafter{%
- \csname macarg.\@tempb\endcsname}%
- \edef\@tempd{\long\def\@tempe{\the\macname}}%
- \push@\@tempd\macargdeflist@
- \let\next\getargvals@@
- \fi
- \fi
- \next
-}
-
-\def\push@#1#2{%
- \expandafter\expandafter\expandafter\def
- \expandafter\expandafter\expandafter#2%
- \expandafter\expandafter\expandafter{%
- \expandafter#1#2}%
-}
-
-% Replace arguments by their values in the macro body, and place the result
-% in macro \@tempa.
-%
-\def\macvalstoargs@{%
- % To do this we use the property that token registers that are \the'ed
- % within an \edef expand only once. So we are going to place all argument
- % values into respective token registers.
- %
- % First we save the token context, and initialize argument numbering.
- \begingroup
- \paramno0\relax
- % Then, for each argument number #N, we place the corresponding argument
- % value into a new token list register \toks#N
- \expandafter\putargsintokens@\saveparamlist@,;,%
- % Then, we expand the body so that argument are replaced by their
- % values. The trick for values not to be expanded themselves is that they
- % are within tokens and that tokens expand only once in an \edef .
- \edef\@tempc{\csname mac.\macroname .body\endcsname}%
- % Now we restore the token stack pointer to free the token list registers
- % which we have used, but we make sure that expanded body is saved after
- % group.
- \expandafter
- \endgroup
- \expandafter\def\expandafter\@tempa\expandafter{\@tempc}%
- }
-
-% Define the named-macro outside of this group and then close this group.
-%
-\def\macargexpandinbody@{%
- \expandafter
- \endgroup
- \macargdeflist@
- % First the replace in body the macro arguments by their values, the result
- % is in \@tempa .
- \macvalstoargs@
- % Then we point at the \norecurse or \gobble (for recursive) macro value
- % with \@tempb .
- \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname
- % Depending on whether it is recursive or not, we need some tailing
- % \egroup .
- \ifx\@tempb\gobble
- \let\@tempc\relax
- \else
- \let\@tempc\egroup
- \fi
- % And now we do the real job:
- \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}%
- \@tempd
-}
-
-\def\putargsintokens@#1,{%
- \if#1;\let\next\relax
- \else
- \let\next\putargsintokens@
- % First we allocate the new token list register, and give it a temporary
- % alias \@tempb .
- \toksdef\@tempb\the\paramno
- % Then we place the argument value into that token list register.
- \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname
- \expandafter\@tempb\expandafter{\@tempa}%
- \advance\paramno by 1\relax
- \fi
- \next
-}
-
-% Trailing missing arguments are set to empty.
-%
-\def\setemptyargvalues@{%
- \ifx\paramlist\nilm@
- \let\next\macargexpandinbody@
- \else
- \expandafter\setemptyargvaluesparser@\paramlist\endargs@
- \let\next\setemptyargvalues@
- \fi
- \next
-}
-
-\def\setemptyargvaluesparser@#1,#2\endargs@{%
- \expandafter\def\expandafter\@tempa\expandafter{%
- \expandafter\def\csname macarg.#1\endcsname{}}%
- \push@\@tempa\macargdeflist@
- \def\paramlist{#2}%
-}
-
-% #1 is the element target macro
-% #2 is the list macro
-% #3,#4\endargs@ is the list value
-\def\pop@#1#2#3,#4\endargs@{%
- \def#1{#3}%
- \def#2{#4}%
-}
-\long\def\longpop@#1#2#3,#4\endargs@{%
- \long\def#1{#3}%
- \long\def#2{#4}%
-}
-
-
-%%%%%%%%%%%%%% End of code for > 10 arguments %%%%%%%%%%%%%%%%%%
-
-
-% This defines a Texinfo @macro or @rmacro, called by \parsemacbody.
-% \macrobody has the body of the macro in it, with placeholders for
-% its parameters, looking like "\xeatspaces{\hash 1}".
-% \paramno is the number of parameters
-% \paramlist is a TeX parameter text, e.g. "#1,#2,#3,"
-% There are four cases: macros of zero, one, up to nine, and many arguments.
-% \xdef is used so that macro definitions will survive the file
-% they're defined in: @include reads the file inside a group.
-%
-\def\defmacro{%
- \let\hash=##% convert placeholders to macro parameter chars
- \ifnum\paramno=1
- \def\xeatspaces##1{##1}%
- % This removes the pair of braces around the argument. We don't
- % use \eatspaces, because this can cause ends of lines to be lost
- % when the argument to \eatspaces is read, leading to line-based
- % commands like "@itemize" not being read correctly.
- \else
- \let\xeatspaces\relax % suppress expansion
- \fi
- \ifcase\paramno
- % 0
- \expandafter\xdef\csname\the\macname\endcsname{%
- \bgroup
- \noexpand\spaceisspace
- \noexpand\endlineisspace
- \noexpand\expandafter % skip any whitespace after the macro name.
- \expandafter\noexpand\csname\the\macname @@@\endcsname}%
- \expandafter\xdef\csname\the\macname @@@\endcsname{%
- \egroup
- \noexpand\scanmacro{\macrobody}}%
- \or % 1
- \expandafter\xdef\csname\the\macname\endcsname{%
- \bgroup
- \noexpand\braceorline
- \expandafter\noexpand\csname\the\macname @@@\endcsname}%
- \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
- \egroup
- \noexpand\scanmacro{\macrobody}%
- }%
- \else % at most 9
- \ifnum\paramno<10\relax
- % @MACNAME sets the context for reading the macro argument
- % @MACNAME@@ gets the argument, processes backslashes and appends a
- % comma.
- % @MACNAME@@@ removes braces surrounding the argument list.
- % @MACNAME@@@@ scans the macro body with arguments substituted.
- \expandafter\xdef\csname\the\macname\endcsname{%
- \bgroup
- \noexpand\expandafter % This \expandafter skip any spaces after the
- \noexpand\macroargctxt % macro before we change the catcode of space.
- \noexpand\expandafter
- \expandafter\noexpand\csname\the\macname @@\endcsname}%
- \expandafter\xdef\csname\the\macname @@\endcsname##1{%
- \noexpand\passargtomacro
- \expandafter\noexpand\csname\the\macname @@@\endcsname{##1,}}%
- \expandafter\xdef\csname\the\macname @@@\endcsname##1{%
- \expandafter\noexpand\csname\the\macname @@@@\endcsname ##1}%
- \expandafter\expandafter
- \expandafter\xdef
- \expandafter\expandafter
- \csname\the\macname @@@@\endcsname\paramlist{%
- \egroup\noexpand\scanmacro{\macrobody}}%
- \else % 10 or more:
- \expandafter\xdef\csname\the\macname\endcsname{%
- \noexpand\getargvals@{\the\macname}{\argl}%
- }%
- \global\expandafter\let\csname mac.\the\macname .body\endcsname\macrobody
- \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble
- \fi
- \fi}
-
-\catcode `\@\texiatcatcode\relax % end private-to-Texinfo catcodes
-
-\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}}
-
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%
-{\catcode`\@=0 \catcode`\\=13 % We need to manipulate \ so use @ as escape
-@catcode`@_=11 % private names
-@catcode`@!=11 % used as argument separator
-
-% \passargtomacro#1#2 -
-% Call #1 with a list of tokens #2, with any doubled backslashes in #2
-% compressed to one.
-%
-% This implementation works by expansion, and not execution (so we cannot use
-% \def or similar). This reduces the risk of this failing in contexts where
-% complete expansion is done with no execution (for example, in writing out to
-% an auxiliary file for an index entry).
-%
-% State is kept in the input stream: the argument passed to
-% @look_ahead, @gobble_and_check_finish and @add_segment is
-%
-% THE_MACRO ARG_RESULT ! {PENDING_BS} NEXT_TOKEN (... rest of input)
-%
-% where:
-% THE_MACRO - name of the macro we want to call
-% ARG_RESULT - argument list we build to pass to that macro
-% PENDING_BS - either a backslash or nothing
-% NEXT_TOKEN - used to look ahead in the input stream to see what's coming next
-
-@gdef@passargtomacro#1#2{%
- @add_segment #1!{}@relax#2\@_finish\%
-}
-@gdef@_finish{@_finishx} @global@let@_finishx@relax
-
-% #1 - THE_MACRO ARG_RESULT
-% #2 - PENDING_BS
-% #3 - NEXT_TOKEN
-% #4 used to look ahead
-%
-% If the next token is not a backslash, process the rest of the argument;
-% otherwise, remove the next token.
-@gdef@look_ahead#1!#2#3#4{%
- @ifx#4\%
- @expandafter@gobble_and_check_finish
- @else
- @expandafter@add_segment
- @fi#1!{#2}#4#4%
-}
-
-% #1 - THE_MACRO ARG_RESULT
-% #2 - PENDING_BS
-% #3 - NEXT_TOKEN
-% #4 should be a backslash, which is gobbled.
-% #5 looks ahead
-%
-% Double backslash found. Add a single backslash, and look ahead.
-@gdef@gobble_and_check_finish#1!#2#3#4#5{%
- @add_segment#1\!{}#5#5%
-}
-
-@gdef@is_fi{@fi}
-
-% #1 - THE_MACRO ARG_RESULT
-% #2 - PENDING_BS
-% #3 - NEXT_TOKEN
-% #4 is input stream until next backslash
-%
-% Input stream is either at the start of the argument, or just after a
-% backslash sequence, either a lone backslash, or a doubled backslash.
-% NEXT_TOKEN contains the first token in the input stream: if it is \finish,
-% finish; otherwise, append to ARG_RESULT the segment of the argument up until
-% the next backslash. PENDING_BACKSLASH contains a backslash to represent
-% a backslash just before the start of the input stream that has not been
-% added to ARG_RESULT.
-@gdef@add_segment#1!#2#3#4\{%
-@ifx#3@_finish
- @call_the_macro#1!%
-@else
- % append the pending backslash to the result, followed by the next segment
- @expandafter@is_fi@look_ahead#1#2#4!{\}@fi
- % this @fi is discarded by @look_ahead.
- % we can't get rid of it with \expandafter because we don't know how
- % long #4 is.
-}
-
-% #1 - THE_MACRO
-% #2 - ARG_RESULT
-% #3 discards the res of the conditional in @add_segment, and @is_fi ends the
-% conditional.
-@gdef@call_the_macro#1#2!#3@fi{@is_fi #1{#2}}
-
-}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-% \braceorline MAC is used for a one-argument macro MAC. It checks
-% whether the next non-whitespace character is a {. It sets the context
-% for reading the argument (slightly different in the two cases). Then,
-% to read the argument, in the whole-line case, it then calls the regular
-% \parsearg MAC; in the lbrace case, it calls \passargtomacro MAC.
-%
-\def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx}
-\def\braceorlinexxx{%
- \ifx\nchar\bgroup
- \macroargctxt
- \expandafter\passargtomacro
- \else
- \macrolineargctxt\expandafter\parsearg
- \fi \macnamexxx}
-
-
-% @alias.
-% We need some trickery to remove the optional spaces around the equal
-% sign. Make them active and then expand them all to nothing.
-%
-\def\alias{\parseargusing\obeyspaces\aliasxxx}
-\def\aliasxxx #1{\aliasyyy#1\relax}
-\def\aliasyyy #1=#2\relax{%
- {%
- \expandafter\let\obeyedspace=\empty
- \addtomacrolist{#1}%
- \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}%
- }%
- \next
-}
-
-
-\message{cross references,}
-
-\newwrite\auxfile
-\newif\ifhavexrefs % True if xref values are known.
-\newif\ifwarnedxrefs % True if we warned once that they aren't known.
-
-% @inforef is relatively simple.
-\def\inforef #1{\inforefzzz #1,,,,**}
-\def\inforefzzz #1,#2,#3,#4**{%
- \putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}},
- node \samp{\ignorespaces#1{}}}
-
-% @node's only job in TeX is to define \lastnode, which is used in
-% cross-references. The @node line might or might not have commas, and
-% might or might not have spaces before the first comma, like:
-% @node foo , bar , ...
-% We don't want such trailing spaces in the node name.
-%
-\parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse}
-%
-% also remove a trailing comma, in case of something like this:
-% @node Help-Cross, , , Cross-refs
-\def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse}
-\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}\omittopnode}
-
-% Used so that the @top node doesn't have to be wrapped in an @ifnottex
-% conditional.
-% \doignore goes to more effort to skip nested conditionals but we don't need
-% that here.
-\def\omittopnode{%
- \ifx\lastnode\wordTop
- \expandafter\ignorenode\fi
-}
-\def\wordTop{Top}
-
-% Until the next @node or @bye command, divert output to a box that is not
-% output.
-\def\ignorenode{\setbox\dummybox\vbox\bgroup\def\node{\egroup\node}%
-\ignorenodebye
-}
-
-{\let\bye\relax
-\gdef\ignorenodebye{\let\bye\ignorenodebyedef}
-\gdef\ignorenodebyedef{\egroup(`Top' node ignored)\bye}}
-% The redefinition of \bye here is because it is declared \outer
-
-\let\lastnode=\empty
-
-% Write a cross-reference definition for the current node. #1 is the
-% type (Ynumbered, Yappendix, Ynothing).
-%
-\def\donoderef#1{%
- \ifx\lastnode\empty\else
- \setref{\lastnode}{#1}%
- \global\let\lastnode=\empty
- \fi
-}
-
-% @anchor{NAME} -- define xref target at arbitrary point.
-%
-\newcount\savesfregister
-%
-\def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi}
-\def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi}
-\def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces}
-
-% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an
-% anchor), which consists of three parts:
-% 1) NAME-title - the current sectioning name taken from \currentsection,
-% or the anchor name.
-% 2) NAME-snt - section number and type, passed as the SNT arg, or
-% empty for anchors.
-% 3) NAME-pg - the page number.
-%
-% This is called from \donoderef, \anchor, and \dofloat. In the case of
-% floats, there is an additional part, which is not written here:
-% 4) NAME-lof - the text as it should appear in a @listoffloats.
-%
-\def\setref#1#2{%
- \pdfmkdest{#1}%
- \iflinks
- {%
- \requireauxfile
- \atdummies % preserve commands, but don't expand them
- % match definition in \xrdef, \refx, \xrefX.
- \def\value##1{##1}%
- \edef\writexrdef##1##2{%
- \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef
- ##1}{##2}}% these are parameters of \writexrdef
- }%
- \toks0 = \expandafter{\currentsection}%
- \immediate \writexrdef{title}{\the\toks0 }%
- \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc.
- \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout
- }%
- \fi
-}
-
-% @xrefautosectiontitle on|off says whether @section(ing) names are used
-% automatically in xrefs, if the third arg is not explicitly specified.
-% This was provided as a "secret" @set xref-automatic-section-title
-% variable, now it's official.
-%
-\parseargdef\xrefautomaticsectiontitle{%
- \def\temp{#1}%
- \ifx\temp\onword
- \expandafter\let\csname SETxref-automatic-section-title\endcsname
- = \empty
- \else\ifx\temp\offword
- \expandafter\let\csname SETxref-automatic-section-title\endcsname
- = \relax
- \else
- \errhelp = \EMsimple
- \errmessage{Unknown @xrefautomaticsectiontitle value `\temp',
- must be on|off}%
- \fi\fi
-}
-
-%
-% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is
-% the node name, #2 the name of the Info cross-reference, #3 the printed
-% node name, #4 the name of the Info file, #5 the name of the printed
-% manual. All but the node name can be omitted.
-%
-\def\pxref{\putwordsee{} \xrefXX}
-\def\xref{\putwordSee{} \xrefXX}
-\def\ref{\xrefXX}
-
-\def\xrefXX#1{\def\xrefXXarg{#1}\futurelet\tokenafterxref\xrefXXX}
-\def\xrefXXX{\expandafter\xrefX\expandafter[\xrefXXarg,,,,,,,]}
-%
-\newbox\toprefbox
-\newbox\printedrefnamebox
-\newbox\infofilenamebox
-\newbox\printedmanualbox
-%
-\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup
- \unsepspaces
- %
- % Get args without leading/trailing spaces.
- \def\printedrefname{\ignorespaces #3}%
- \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}%
- %
- \def\infofilename{\ignorespaces #4}%
- \setbox\infofilenamebox = \hbox{\infofilename\unskip}%
- %
- \def\printedmanual{\ignorespaces #5}%
- \setbox\printedmanualbox = \hbox{\printedmanual\unskip}%
- %
- % If the printed reference name (arg #3) was not explicitly given in
- % the @xref, figure out what we want to use.
- \ifdim \wd\printedrefnamebox = 0pt
- % No printed node name was explicitly given.
- \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax
- % Not auto section-title: use node name inside the square brackets.
- \def\printedrefname{\ignorespaces #1}%
- \else
- % Auto section-title: use chapter/section title inside
- % the square brackets if we have it.
- \ifdim \wd\printedmanualbox > 0pt
- % It is in another manual, so we don't have it; use node name.
- \def\printedrefname{\ignorespaces #1}%
- \else
- \ifhavexrefs
- % We (should) know the real title if we have the xref values.
- \def\printedrefname{\refx{#1-title}{}}%
- \else
- % Otherwise just copy the Info node name.
- \def\printedrefname{\ignorespaces #1}%
- \fi%
- \fi
- \fi
- \fi
- %
- % Make link in pdf output.
- \ifpdf
- % For pdfTeX and LuaTeX
- {\indexnofonts
- \makevalueexpandable
- \turnoffactive
- % This expands tokens, so do it after making catcode changes, so _
- % etc. don't get their TeX definitions. This ignores all spaces in
- % #4, including (wrongly) those in the middle of the filename.
- \getfilename{#4}%
- %
- % This (wrongly) does not take account of leading or trailing
- % spaces in #1, which should be ignored.
- \setpdfdestname{#1}%
- %
- \ifx\pdfdestname\empty
- \def\pdfdestname{Top}% no empty targets
- \fi
- %
- \leavevmode
- \startlink attr{/Border [0 0 0]}%
- \ifnum\filenamelength>0
- goto file{\the\filename.pdf} name{\pdfdestname}%
- \else
- goto name{\pdfmkpgn{\pdfdestname}}%
- \fi
- }%
- \setcolor{\linkcolor}%
- \else
- \ifx\XeTeXrevision\thisisundefined
- \else
- % For XeTeX
- {\indexnofonts
- \makevalueexpandable
- \turnoffactive
- % This expands tokens, so do it after making catcode changes, so _
- % etc. don't get their TeX definitions. This ignores all spaces in
- % #4, including (wrongly) those in the middle of the filename.
- \getfilename{#4}%
- %
- % This (wrongly) does not take account of leading or trailing
- % spaces in #1, which should be ignored.
- \setpdfdestname{#1}%
- %
- \ifx\pdfdestname\empty
- \def\pdfdestname{Top}% no empty targets
- \fi
- %
- \leavevmode
- \ifnum\filenamelength>0
- % With default settings,
- % XeTeX (xdvipdfmx) replaces link destination names with integers.
- % In this case, the replaced destination names of
- % remote PDFs are no longer known. In order to avoid a replacement,
- % you can use xdvipdfmx's command line option `-C 0x0010'.
- % If you use XeTeX 0.99996+ (TeX Live 2016+),
- % this command line option is no longer necessary
- % because we can use the `dvipdfmx:config' special.
- \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
- << /S /GoToR /F (\the\filename.pdf) /D (\pdfdestname) >> >>}%
- \else
- \special{pdf:bann << /Border [0 0 0] /Type /Annot /Subtype /Link /A
- << /S /GoTo /D (\pdfdestname) >> >>}%
- \fi
- }%
- \setcolor{\linkcolor}%
- \fi
- \fi
- {%
- % Have to otherify everything special to allow the \csname to
- % include an _ in the xref name, etc.
- \indexnofonts
- \turnoffactive
- \def\value##1{##1}%
- \expandafter\global\expandafter\let\expandafter\Xthisreftitle
- \csname XR#1-title\endcsname
- }%
- %
- % Float references are printed completely differently: "Figure 1.2"
- % instead of "[somenode], p.3". \iffloat distinguishes them by
- % \Xthisreftitle being set to a magic string.
- \iffloat\Xthisreftitle
- % If the user specified the print name (third arg) to the ref,
- % print it instead of our usual "Figure 1.2".
- \ifdim\wd\printedrefnamebox = 0pt
- \refx{#1-snt}{}%
- \else
- \printedrefname
- \fi
- %
- % If the user also gave the printed manual name (fifth arg), append
- % "in MANUALNAME".
- \ifdim \wd\printedmanualbox > 0pt
- \space \putwordin{} \cite{\printedmanual}%
- \fi
- \else
- % node/anchor (non-float) references.
- %
- % If we use \unhbox to print the node names, TeX does not insert
- % empty discretionaries after hyphens, which means that it will not
- % find a line break at a hyphen in a node names. Since some manuals
- % are best written with fairly long node names, containing hyphens,
- % this is a loss. Therefore, we give the text of the node name
- % again, so it is as if TeX is seeing it for the first time.
- %
- \ifdim \wd\printedmanualbox > 0pt
- % Cross-manual reference with a printed manual name.
- %
- \crossmanualxref{\cite{\printedmanual\unskip}}%
- %
- \else\ifdim \wd\infofilenamebox > 0pt
- % Cross-manual reference with only an info filename (arg 4), no
- % printed manual name (arg 5). This is essentially the same as
- % the case above; we output the filename, since we have nothing else.
- %
- \crossmanualxref{\code{\infofilename\unskip}}%
- %
- \else
- % Reference within this manual.
- %
- % Only output a following space if the -snt ref is nonempty; for
- % @unnumbered and @anchor, it won't be.
- \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}%
- \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi
- %
- % output the `[mynode]' via the macro below so it can be overridden.
- \xrefprintnodename\printedrefname
- %
- % But we always want a comma and a space:
- ,\space
- %
- % output the `page 3'.
- \turnoffactive \putwordpage\tie\refx{#1-pg}{}%
- % Add a , if xref followed by a space
- \if\space\noexpand\tokenafterxref ,%
- \else\ifx\ \tokenafterxref ,% @TAB
- \else\ifx\*\tokenafterxref ,% @*
- \else\ifx\ \tokenafterxref ,% @SPACE
- \else\ifx\
- \tokenafterxref ,% @NL
- \else\ifx\tie\tokenafterxref ,% @tie
- \fi\fi\fi\fi\fi\fi
- \fi\fi
- \fi
- \endlink
-\endgroup}
-
-% Output a cross-manual xref to #1. Used just above (twice).
-%
-% Only include the text "Section ``foo'' in" if the foo is neither
-% missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply
-% "see The Foo Manual", the idea being to refer to the whole manual.
-%
-% But, this being TeX, we can't easily compare our node name against the
-% string "Top" while ignoring the possible spaces before and after in
-% the input. By adding the arbitrary 7sp below, we make it much less
-% likely that a real node name would have the same width as "Top" (e.g.,
-% in a monospaced font). Hopefully it will never happen in practice.
-%
-% For the same basic reason, we retypeset the "Top" at every
-% reference, since the current font is indeterminate.
-%
-\def\crossmanualxref#1{%
- \setbox\toprefbox = \hbox{Top\kern7sp}%
- \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}%
- \ifdim \wd2 > 7sp % nonempty?
- \ifdim \wd2 = \wd\toprefbox \else % same as Top?
- \putwordSection{} ``\printedrefname'' \putwordin{}\space
- \fi
- \fi
- #1%
-}
-
-% This macro is called from \xrefX for the `[nodename]' part of xref
-% output. It's a separate macro only so it can be changed more easily,
-% since square brackets don't work well in some documents. Particularly
-% one that Bob is working on :).
-%
-\def\xrefprintnodename#1{[#1]}
-
-% Things referred to by \setref.
-%
-\def\Ynothing{}
-\def\Yomitfromtoc{}
-\def\Ynumbered{%
- \ifnum\secno=0
- \putwordChapter@tie \the\chapno
- \else \ifnum\subsecno=0
- \putwordSection@tie \the\chapno.\the\secno
- \else \ifnum\subsubsecno=0
- \putwordSection@tie \the\chapno.\the\secno.\the\subsecno
- \else
- \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno
- \fi\fi\fi
-}
-\def\Yappendix{%
- \ifnum\secno=0
- \putwordAppendix@tie @char\the\appendixno{}%
- \else \ifnum\subsecno=0
- \putwordSection@tie @char\the\appendixno.\the\secno
- \else \ifnum\subsubsecno=0
- \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno
- \else
- \putwordSection@tie
- @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno
- \fi\fi\fi
-}
-
-% \refx{NAME}{SUFFIX} - reference a cross-reference string named NAME. SUFFIX
-% is output afterwards if non-empty.
-\def\refx#1#2{%
- \requireauxfile
- {%
- \indexnofonts
- \turnoffactive
- \def\value##1{##1}%
- \expandafter\global\expandafter\let\expandafter\thisrefX
- \csname XR#1\endcsname
- }%
- \ifx\thisrefX\relax
- % If not defined, say something at least.
- \angleleft un\-de\-fined\angleright
- \iflinks
- \ifhavexrefs
- {\toks0 = {#1}% avoid expansion of possibly-complex value
- \message{\linenumber Undefined cross reference `\the\toks0'.}}%
- \else
- \ifwarnedxrefs\else
- \global\warnedxrefstrue
- \message{Cross reference values unknown; you must run TeX again.}%
- \fi
- \fi
- \fi
- \else
- % It's defined, so just use it.
- \thisrefX
- \fi
- #2% Output the suffix in any case.
-}
-
-% This is the macro invoked by entries in the aux file. Define a control
-% sequence for a cross-reference target (we prepend XR to the control sequence
-% name to avoid collisions). The value is the page number. If this is a float
-% type, we have more work to do.
-%
-\def\xrdef#1#2{%
- {% Expand the node or anchor name to remove control sequences.
- % \turnoffactive stops 8-bit characters being changed to commands
- % like @'e. \refx does the same to retrieve the value in the definition.
- \indexnofonts
- \turnoffactive
- \def\value##1{##1}%
- \xdef\safexrefname{#1}%
- }%
- %
- \bgroup
- \expandafter\gdef\csname XR\safexrefname\endcsname{#2}%
- \egroup
- % We put the \gdef inside a group to avoid the definitions building up on
- % TeX's save stack, which can cause it to run out of space for aux files with
- % thousands of lines. \gdef doesn't use the save stack, but \csname does
- % when it defines an unknown control sequence as \relax.
- %
- % Was that xref control sequence that we just defined for a float?
- \expandafter\iffloat\csname XR\safexrefname\endcsname
- % it was a float, and we have the (safe) float type in \iffloattype.
- \expandafter\let\expandafter\floatlist
- \csname floatlist\iffloattype\endcsname
- %
- % Is this the first time we've seen this float type?
- \expandafter\ifx\floatlist\relax
- \toks0 = {\do}% yes, so just \do
- \else
- % had it before, so preserve previous elements in list.
- \toks0 = \expandafter{\floatlist\do}%
- \fi
- %
- % Remember this xref in the control sequence \floatlistFLOATTYPE,
- % for later use in \listoffloats.
- \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0
- {\safexrefname}}%
- \fi
-}
-
-% If working on a large document in chapters, it is convenient to
-% be able to disable indexing, cross-referencing, and contents, for test runs.
-% This is done with @novalidate at the beginning of the file.
-%
-\newif\iflinks \linkstrue % by default we want the aux files.
-\let\novalidate = \linksfalse
-
-% Used when writing to the aux file, or when using data from it.
-\def\requireauxfile{%
- \iflinks
- \tryauxfile
- % Open the new aux file. TeX will close it automatically at exit.
- \immediate\openout\auxfile=\jobname.aux
- \fi
- \global\let\requireauxfile=\relax % Only do this once.
-}
-
-% Read the last existing aux file, if any. No error if none exists.
-%
-\def\tryauxfile{%
- \openin 1 \jobname.aux
- \ifeof 1 \else
- \readdatafile{aux}%
- \global\havexrefstrue
- \fi
- \closein 1
-}
-
-\def\setupdatafile{%
- \catcode`\^^@=\other
- \catcode`\^^A=\other
- \catcode`\^^B=\other
- \catcode`\^^C=\other
- \catcode`\^^D=\other
- \catcode`\^^E=\other
- \catcode`\^^F=\other
- \catcode`\^^G=\other
- \catcode`\^^H=\other
- \catcode`\^^K=\other
- \catcode`\^^L=\other
- \catcode`\^^N=\other
- \catcode`\^^P=\other
- \catcode`\^^Q=\other
- \catcode`\^^R=\other
- \catcode`\^^S=\other
- \catcode`\^^T=\other
- \catcode`\^^U=\other
- \catcode`\^^V=\other
- \catcode`\^^W=\other
- \catcode`\^^X=\other
- \catcode`\^^Z=\other
- \catcode`\^^[=\other
- \catcode`\^^\=\other
- \catcode`\^^]=\other
- \catcode`\^^^=\other
- \catcode`\^^_=\other
- \catcode`\^=\other
- %
- % Special characters. Should be turned off anyway, but...
- \catcode`\~=\other
- \catcode`\[=\other
- \catcode`\]=\other
- \catcode`\"=\other
- \catcode`\_=\other
- \catcode`\|=\other
- \catcode`\<=\other
- \catcode`\>=\other
- \catcode`\$=\other
- \catcode`\#=\other
- \catcode`\&=\other
- \catcode`\%=\other
- \catcode`+=\other % avoid \+ for paranoia even though we've turned it off
- %
- \catcode`\\=\active
- %
- % @ is our escape character in .aux files, and we need braces.
- \catcode`\{=1
- \catcode`\}=2
- \catcode`\@=0
-}
-
-\def\readdatafile#1{%
-\begingroup
- \setupdatafile
- \input\jobname.#1
-\endgroup}
-
-
-\message{insertions,}
-% including footnotes.
-
-\newcount \footnoteno
-
-% The trailing space in the following definition for supereject is
-% vital for proper filling; pages come out unaligned when you do a
-% pagealignmacro call if that space before the closing brace is
-% removed. (Generally, numeric constants should always be followed by a
-% space to prevent strange expansion errors.)
-\def\supereject{\par\penalty -20000\footnoteno =0 }
-
-% @footnotestyle is meaningful for Info output only.
-\let\footnotestyle=\comment
-
-{\catcode `\@=11
-%
-% Auto-number footnotes. Otherwise like plain.
-\gdef\footnote{%
- \global\advance\footnoteno by \@ne
- \edef\thisfootno{$^{\the\footnoteno}$}%
- %
- % In case the footnote comes at the end of a sentence, preserve the
- % extra spacing after we do the footnote number.
- \let\@sf\empty
- \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi
- %
- % Remove inadvertent blank space before typesetting the footnote number.
- \unskip
- \thisfootno\@sf
- \dofootnote
-}%
-
-% Don't bother with the trickery in plain.tex to not require the
-% footnote text as a parameter. Our footnotes don't need to be so general.
-%
-% Oh yes, they do; otherwise, @ifset (and anything else that uses
-% \parseargline) fails inside footnotes because the tokens are fixed when
-% the footnote is read. --karl, 16nov96.
-%
-\gdef\dofootnote{%
- \insert\footins\bgroup
- %
- % Nested footnotes are not supported in TeX, that would take a lot
- % more work. (\startsavinginserts does not suffice.)
- \let\footnote=\errfootnotenest
- %
- % We want to typeset this text as a normal paragraph, even if the
- % footnote reference occurs in (for example) a display environment.
- % So reset some parameters.
- \hsize=\txipagewidth
- \interlinepenalty\interfootnotelinepenalty
- \splittopskip\ht\strutbox % top baseline for broken footnotes
- \splitmaxdepth\dp\strutbox
- \floatingpenalty\@MM
- \leftskip\z@skip
- \rightskip\z@skip
- \spaceskip\z@skip
- \xspaceskip\z@skip
- \parindent\defaultparindent
- %
- \smallfonts \rm
- %
- % Because we use hanging indentation in footnotes, a @noindent appears
- % to exdent this text, so make it be a no-op. makeinfo does not use
- % hanging indentation so @noindent can still be needed within footnote
- % text after an @example or the like (not that this is good style).
- \let\noindent = \relax
- %
- % Hang the footnote text off the number. Use \everypar in case the
- % footnote extends for more than one paragraph.
- \everypar = {\hang}%
- \textindent{\thisfootno}%
- %
- % Don't crash into the line above the footnote text. Since this
- % expands into a box, it must come within the paragraph, lest it
- % provide a place where TeX can split the footnote.
- \footstrut
- %
- % Invoke rest of plain TeX footnote routine.
- \futurelet\next\fo@t
-}
-}%end \catcode `\@=11
-
-\def\errfootnotenest{%
- \errhelp=\EMsimple
- \errmessage{Nested footnotes not supported in texinfo.tex,
- even though they work in makeinfo; sorry}
-}
-
-\def\errfootnoteheading{%
- \errhelp=\EMsimple
- \errmessage{Footnotes in chapters, sections, etc., are not supported}
-}
-
-% In case a @footnote appears in a vbox, save the footnote text and create
-% the real \insert just after the vbox finished. Otherwise, the insertion
-% would be lost.
-% Similarly, if a @footnote appears inside an alignment, save the footnote
-% text to a box and make the \insert when a row of the table is finished.
-% And the same can be done for other insert classes. --kasal, 16nov03.
-%
-% Replace the \insert primitive by a cheating macro.
-% Deeper inside, just make sure that the saved insertions are not spilled
-% out prematurely.
-%
-\def\startsavinginserts{%
- \ifx \insert\ptexinsert
- \let\insert\saveinsert
- \else
- \let\checkinserts\relax
- \fi
-}
-
-% This \insert replacement works for both \insert\footins{foo} and
-% \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}.
-%
-\def\saveinsert#1{%
- \edef\next{\noexpand\savetobox \makeSAVEname#1}%
- \afterassignment\next
- % swallow the left brace
- \let\temp =
-}
-\def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}}
-\def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1}
-
-\def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi}
-
-\def\placesaveins#1{%
- \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname
- {\box#1}%
-}
-
-% eat @SAVE -- beware, all of them have catcode \other:
-{
- \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-)
- \gdef\gobblesave @SAVE{}
-}
-
-% initialization:
-\def\newsaveins #1{%
- \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}%
- \next
-}
-\def\newsaveinsX #1{%
- \csname newbox\endcsname #1%
- \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts
- \checksaveins #1}%
-}
-
-% initialize:
-\let\checkinserts\empty
-\newsaveins\footins
-\newsaveins\margin
-
-
-% @image. We use the macros from epsf.tex to support this.
-% If epsf.tex is not installed and @image is used, we complain.
-%
-% Check for and read epsf.tex up front. If we read it only at @image
-% time, we might be inside a group, and then its definitions would get
-% undone and the next image would fail.
-\openin 1 = epsf.tex
-\ifeof 1 \else
- % Do not bother showing banner with epsf.tex v2.7k (available in
- % doc/epsf.tex and on ctan).
- \def\epsfannounce{\toks0 = }%
- \input epsf.tex
-\fi
-\closein 1
-%
-% We will only complain once about lack of epsf.tex.
-\newif\ifwarnednoepsf
-\newhelp\noepsfhelp{epsf.tex must be installed for images to
- work. It is also included in the Texinfo distribution, or you can get
- it from https://ctan.org/texarchive/macros/texinfo/texinfo/doc/epsf.tex.}
-%
-\def\image#1{%
- \ifx\epsfbox\thisisundefined
- \ifwarnednoepsf \else
- \errhelp = \noepsfhelp
- \errmessage{epsf.tex not found, images will be ignored}%
- \global\warnednoepsftrue
- \fi
- \else
- \imagexxx #1,,,,,\finish
- \fi
-}
-%
-% Arguments to @image:
-% #1 is (mandatory) image filename; we tack on .eps extension.
-% #2 is (optional) width, #3 is (optional) height.
-% #4 is (ignored optional) html alt text.
-% #5 is (ignored optional) extension.
-% #6 is just the usual extra ignored arg for parsing stuff.
-\newif\ifimagevmode
-\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup
- \catcode`\^^M = 5 % in case we're inside an example
- \normalturnoffactive % allow _ et al. in names
- \def\xprocessmacroarg{\eatspaces}% in case we are being used via a macro
- % If the image is by itself, center it.
- \ifvmode
- \imagevmodetrue
- \else \ifx\centersub\centerV
- % for @center @image, we need a vbox so we can have our vertical space
- \imagevmodetrue
- \vbox\bgroup % vbox has better behavior than vtop herev
- \fi\fi
- %
- \ifimagevmode
- \nobreak\medskip
- % Usually we'll have text after the image which will insert
- % \parskip glue, so insert it here too to equalize the space
- % above and below.
- \nobreak\vskip\parskip
- \nobreak
- \fi
- %
- % Leave vertical mode so that indentation from an enclosing
- % environment such as @quotation is respected.
- % However, if we're at the top level, we don't want the
- % normal paragraph indentation.
- % On the other hand, if we are in the case of @center @image, we don't
- % want to start a paragraph, which will create a hsize-width box and
- % eradicate the centering.
- \ifx\centersub\centerV\else \noindent \fi
- %
- % Output the image.
- \ifpdf
- % For pdfTeX and LuaTeX <= 0.80
- \dopdfimage{#1}{#2}{#3}%
- \else
- \ifx\XeTeXrevision\thisisundefined
- % For epsf.tex
- % \epsfbox itself resets \epsf?size at each figure.
- \setbox0 = \hbox{\ignorespaces #2}%
- \ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi
- \setbox0 = \hbox{\ignorespaces #3}%
- \ifdim\wd0 > 0pt \epsfysize=#3\relax \fi
- \epsfbox{#1.eps}%
- \else
- % For XeTeX
- \doxeteximage{#1}{#2}{#3}%
- \fi
- \fi
- %
- \ifimagevmode
- \medskip % space after a standalone image
- \fi
- \ifx\centersub\centerV \egroup \fi
-\endgroup}
-
-
-% @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables,
-% etc. We don't actually implement floating yet, we always include the
-% float "here". But it seemed the best name for the future.
-%
-\envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish}
-
-% There may be a space before second and/or third parameter; delete it.
-\def\eatcommaspace#1, {#1,}
-
-% #1 is the optional FLOATTYPE, the text label for this float, typically
-% "Figure", "Table", "Example", etc. Can't contain commas. If omitted,
-% this float will not be numbered and cannot be referred to.
-%
-% #2 is the optional xref label. Also must be present for the float to
-% be referable.
-%
-% #3 is the optional positioning argument; for now, it is ignored. It
-% will somehow specify the positions allowed to float to (here, top, bottom).
-%
-% We keep a separate counter for each FLOATTYPE, which we reset at each
-% chapter-level command.
-\let\resetallfloatnos=\empty
-%
-\def\dofloat#1,#2,#3,#4\finish{%
- \let\thiscaption=\empty
- \let\thisshortcaption=\empty
- %
- % don't lose footnotes inside @float.
- %
- % BEWARE: when the floats start float, we have to issue warning whenever an
- % insert appears inside a float which could possibly float. --kasal, 26may04
- %
- \startsavinginserts
- %
- % We can't be used inside a paragraph.
- \par
- %
- \vtop\bgroup
- \def\floattype{#1}%
- \def\floatlabel{#2}%
- \def\floatloc{#3}% we do nothing with this yet.
- %
- \ifx\floattype\empty
- \let\safefloattype=\empty
- \else
- {%
- % the floattype might have accents or other special characters,
- % but we need to use it in a control sequence name.
- \indexnofonts
- \turnoffactive
- \xdef\safefloattype{\floattype}%
- }%
- \fi
- %
- % If label is given but no type, we handle that as the empty type.
- \ifx\floatlabel\empty \else
- % We want each FLOATTYPE to be numbered separately (Figure 1,
- % Table 1, Figure 2, ...). (And if no label, no number.)
- %
- \expandafter\getfloatno\csname\safefloattype floatno\endcsname
- \global\advance\floatno by 1
- %
- {%
- % This magic value for \currentsection is output by \setref as the
- % XREFLABEL-title value. \xrefX uses it to distinguish float
- % labels (which have a completely different output format) from
- % node and anchor labels. And \xrdef uses it to construct the
- % lists of floats.
- %
- \edef\currentsection{\floatmagic=\safefloattype}%
- \setref{\floatlabel}{Yfloat}%
- }%
- \fi
- %
- % start with \parskip glue, I guess.
- \vskip\parskip
- %
- % Don't suppress indentation if a float happens to start a section.
- \restorefirstparagraphindent
-}
-
-% we have these possibilities:
-% @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap
-% @float Foo,lbl & no caption: Foo 1.1
-% @float Foo & @caption{Cap}: Foo: Cap
-% @float Foo & no caption: Foo
-% @float ,lbl & Caption{Cap}: 1.1: Cap
-% @float ,lbl & no caption: 1.1
-% @float & @caption{Cap}: Cap
-% @float & no caption:
-%
-\def\Efloat{%
- \let\floatident = \empty
- %
- % In all cases, if we have a float type, it comes first.
- \ifx\floattype\empty \else \def\floatident{\floattype}\fi
- %
- % If we have an xref label, the number comes next.
- \ifx\floatlabel\empty \else
- \ifx\floattype\empty \else % if also had float type, need tie first.
- \appendtomacro\floatident{\tie}%
- \fi
- % the number.
- \appendtomacro\floatident{\chaplevelprefix\the\floatno}%
- \fi
- %
- % Start the printed caption with what we've constructed in
- % \floatident, but keep it separate; we need \floatident again.
- \let\captionline = \floatident
- %
- \ifx\thiscaption\empty \else
- \ifx\floatident\empty \else
- \appendtomacro\captionline{: }% had ident, so need a colon between
- \fi
- %
- % caption text.
- \appendtomacro\captionline{\scanexp\thiscaption}%
- \fi
- %
- % If we have anything to print, print it, with space before.
- % Eventually this needs to become an \insert.
- \ifx\captionline\empty \else
- \vskip.5\parskip
- \captionline
- %
- % Space below caption.
- \vskip\parskip
- \fi
- %
- % If have an xref label, write the list of floats info. Do this
- % after the caption, to avoid chance of it being a breakpoint.
- \ifx\floatlabel\empty \else
- % Write the text that goes in the lof to the aux file as
- % \floatlabel-lof. Besides \floatident, we include the short
- % caption if specified, else the full caption if specified, else nothing.
- {%
- \requireauxfile
- \atdummies
- %
- \ifx\thisshortcaption\empty
- \def\gtemp{\thiscaption}%
- \else
- \def\gtemp{\thisshortcaption}%
- \fi
- \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident
- \ifx\gtemp\empty \else : \gtemp \fi}}%
- }%
- \fi
- \egroup % end of \vtop
- %
- \checkinserts
-}
-
-% Append the tokens #2 to the definition of macro #1, not expanding either.
-%
-\def\appendtomacro#1#2{%
- \expandafter\def\expandafter#1\expandafter{#1#2}%
-}
-
-% @caption, @shortcaption
-%
-\def\caption{\docaption\thiscaption}
-\def\shortcaption{\docaption\thisshortcaption}
-\def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption}
-\def\defcaption#1#2{\egroup \def#1{#2}}
-
-% The parameter is the control sequence identifying the counter we are
-% going to use. Create it if it doesn't exist and assign it to \floatno.
-\def\getfloatno#1{%
- \ifx#1\relax
- % Haven't seen this figure type before.
- \csname newcount\endcsname #1%
- %
- % Remember to reset this floatno at the next chap.
- \expandafter\gdef\expandafter\resetallfloatnos
- \expandafter{\resetallfloatnos #1=0 }%
- \fi
- \let\floatno#1%
-}
-
-% \setref calls this to get the XREFLABEL-snt value. We want an @xref
-% to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we
-% first read the @float command.
-%
-\def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}%
-
-% Magic string used for the XREFLABEL-title value, so \xrefX can
-% distinguish floats from other xref types.
-\def\floatmagic{!!float!!}
-
-% #1 is the control sequence we are passed; we expand into a conditional
-% which is true if #1 represents a float ref. That is, the magic
-% \currentsection value which we \setref above.
-%
-\def\iffloat#1{\expandafter\doiffloat#1==\finish}
-%
-% #1 is (maybe) the \floatmagic string. If so, #2 will be the
-% (safe) float type for this float. We set \iffloattype to #2.
-%
-\def\doiffloat#1=#2=#3\finish{%
- \def\temp{#1}%
- \def\iffloattype{#2}%
- \ifx\temp\floatmagic
-}
-
-% @listoffloats FLOATTYPE - print a list of floats like a table of contents.
-%
-\parseargdef\listoffloats{%
- \def\floattype{#1}% floattype
- {%
- % the floattype might have accents or other special characters,
- % but we need to use it in a control sequence name.
- \indexnofonts
- \turnoffactive
- \xdef\safefloattype{\floattype}%
- }%
- %
- % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE.
- \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax
- \ifhavexrefs
- % if the user said @listoffloats foo but never @float foo.
- \message{\linenumber No `\safefloattype' floats to list.}%
- \fi
- \else
- \begingroup
- \leftskip=\tocindent % indent these entries like a toc
- \let\do=\listoffloatsdo
- \csname floatlist\safefloattype\endcsname
- \endgroup
- \fi
-}
-
-% This is called on each entry in a list of floats. We're passed the
-% xref label, in the form LABEL-title, which is how we save it in the
-% aux file. We strip off the -title and look up \XRLABEL-lof, which
-% has the text we're supposed to typeset here.
-%
-% Figures without xref labels will not be included in the list (since
-% they won't appear in the aux file).
-%
-\def\listoffloatsdo#1{\listoffloatsdoentry#1\finish}
-\def\listoffloatsdoentry#1-title\finish{{%
- % Can't fully expand XR#1-lof because it can contain anything. Just
- % pass the control sequence. On the other hand, XR#1-pg is just the
- % page number, and we want to fully expand that so we can get a link
- % in pdf output.
- \toksA = \expandafter{\csname XR#1-lof\endcsname}%
- %
- % use the same \entry macro we use to generate the TOC and index.
- \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}%
- \writeentry
-}}
-
-
-\message{localization,}
-
-% For single-language documents, @documentlanguage is usually given very
-% early, just after @documentencoding. Single argument is the language
-% (de) or locale (de_DE) abbreviation.
-%
-{
- \catcode`\_ = \active
- \globaldefs=1
-\parseargdef\documentlanguage{%
- \tex % read txi-??.tex file in plain TeX.
- % Read the file by the name they passed if it exists.
- \let_ = \normalunderscore % normal _ character for filename test
- \openin 1 txi-#1.tex
- \ifeof 1
- \documentlanguagetrywithoutunderscore #1_\finish
- \else
- \globaldefs = 1 % everything in the txi-LL files needs to persist
- \input txi-#1.tex
- \fi
- \closein 1
- \endgroup % end raw TeX
-}
-%
-% If they passed de_DE, and txi-de_DE.tex doesn't exist,
-% try txi-de.tex.
-%
-\gdef\documentlanguagetrywithoutunderscore#1_#2\finish{%
- \openin 1 txi-#1.tex
- \ifeof 1
- \errhelp = \nolanghelp
- \errmessage{Cannot read language file txi-#1.tex}%
- \else
- \globaldefs = 1 % everything in the txi-LL files needs to persist
- \input txi-#1.tex
- \fi
- \closein 1
-}
-}% end of special _ catcode
-%
-\newhelp\nolanghelp{The given language definition file cannot be found or
-is empty. Maybe you need to install it? Putting it in the current
-directory should work if nowhere else does.}
-
-% This macro is called from txi-??.tex files; the first argument is the
-% \language name to set (without the "\lang@" prefix), the second and
-% third args are \{left,right}hyphenmin.
-%
-% The language names to pass are determined when the format is built.
-% See the etex.log file created at that time, e.g.,
-% /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log.
-%
-% With TeX Live 2008, etex now includes hyphenation patterns for all
-% available languages. This means we can support hyphenation in
-% Texinfo, at least to some extent. (This still doesn't solve the
-% accented characters problem.)
-%
-\catcode`@=11
-\def\txisetlanguage#1#2#3{%
- % do not set the language if the name is undefined in the current TeX.
- \expandafter\ifx\csname lang@#1\endcsname \relax
- \message{no patterns for #1}%
- \else
- \global\language = \csname lang@#1\endcsname
- \fi
- % but there is no harm in adjusting the hyphenmin values regardless.
- \global\lefthyphenmin = #2\relax
- \global\righthyphenmin = #3\relax
-}
-
-% XeTeX and LuaTeX can handle Unicode natively.
-% Their default I/O uses UTF-8 sequences instead of a byte-wise operation.
-% Other TeX engines' I/O (pdfTeX, etc.) is byte-wise.
-%
-\newif\iftxinativeunicodecapable
-\newif\iftxiusebytewiseio
-
-\ifx\XeTeXrevision\thisisundefined
- \ifx\luatexversion\thisisundefined
- \txinativeunicodecapablefalse
- \txiusebytewiseiotrue
- \else
- \txinativeunicodecapabletrue
- \txiusebytewiseiofalse
- \fi
-\else
- \txinativeunicodecapabletrue
- \txiusebytewiseiofalse
-\fi
-
-% Set I/O by bytes instead of UTF-8 sequence for XeTeX and LuaTex
-% for non-UTF-8 (byte-wise) encodings.
-%
-\def\setbytewiseio{%
- \ifx\XeTeXrevision\thisisundefined
- \else
- \XeTeXdefaultencoding "bytes" % For subsequent files to be read
- \XeTeXinputencoding "bytes" % For document root file
- % Unfortunately, there seems to be no corresponding XeTeX command for
- % output encoding. This is a problem for auxiliary index and TOC files.
- % The only solution would be perhaps to write out @U{...} sequences in
- % place of non-ASCII characters.
- \fi
-
- \ifx\luatexversion\thisisundefined
- \else
- \directlua{
- local utf8_char, byte, gsub = unicode.utf8.char, string.byte, string.gsub
- local function convert_char (char)
- return utf8_char(byte(char))
- end
-
- local function convert_line (line)
- return gsub(line, ".", convert_char)
- end
-
- callback.register("process_input_buffer", convert_line)
-
- local function convert_line_out (line)
- local line_out = ""
- for c in string.utfvalues(line) do
- line_out = line_out .. string.char(c)
- end
- return line_out
- end
-
- callback.register("process_output_buffer", convert_line_out)
- }
- \fi
-
- \txiusebytewiseiotrue
-}
-
-
-% Helpers for encodings.
-% Set the catcode of characters 128 through 255 to the specified number.
-%
-\def\setnonasciicharscatcode#1{%
- \count255=128
- \loop\ifnum\count255<256
- \global\catcode\count255=#1\relax
- \advance\count255 by 1
- \repeat
-}
-
-\def\setnonasciicharscatcodenonglobal#1{%
- \count255=128
- \loop\ifnum\count255<256
- \catcode\count255=#1\relax
- \advance\count255 by 1
- \repeat
-}
-
-% @documentencoding sets the definition of non-ASCII characters
-% according to the specified encoding.
-%
-\def\documentencoding{\parseargusing\filenamecatcodes\documentencodingzzz}
-\def\documentencodingzzz#1{%
- %
- % Encoding being declared for the document.
- \def\declaredencoding{\csname #1.enc\endcsname}%
- %
- % Supported encodings: names converted to tokens in order to be able
- % to compare them with \ifx.
- \def\ascii{\csname US-ASCII.enc\endcsname}%
- \def\latnine{\csname ISO-8859-15.enc\endcsname}%
- \def\latone{\csname ISO-8859-1.enc\endcsname}%
- \def\lattwo{\csname ISO-8859-2.enc\endcsname}%
- \def\utfeight{\csname UTF-8.enc\endcsname}%
- %
- \ifx \declaredencoding \ascii
- \asciichardefs
- %
- \else \ifx \declaredencoding \lattwo
- \iftxinativeunicodecapable
- \setbytewiseio
- \fi
- \setnonasciicharscatcode\active
- \lattwochardefs
- %
- \else \ifx \declaredencoding \latone
- \iftxinativeunicodecapable
- \setbytewiseio
- \fi
- \setnonasciicharscatcode\active
- \latonechardefs
- %
- \else \ifx \declaredencoding \latnine
- \iftxinativeunicodecapable
- \setbytewiseio
- \fi
- \setnonasciicharscatcode\active
- \latninechardefs
- %
- \else \ifx \declaredencoding \utfeight
- \iftxinativeunicodecapable
- % For native Unicode handling (XeTeX and LuaTeX)
- \nativeunicodechardefs
- \else
- % For treating UTF-8 as byte sequences (TeX, eTeX and pdfTeX)
- \setnonasciicharscatcode\active
- % since we already invoked \utfeightchardefs at the top level
- % (below), do not re-invoke it, otherwise our check for duplicated
- % definitions gets triggered. Making non-ascii chars active is
- % sufficient.
- \fi
- %
- \else
- \message{Ignoring unknown document encoding: #1.}%
- %
- \fi % utfeight
- \fi % latnine
- \fi % latone
- \fi % lattwo
- \fi % ascii
- %
- \ifx\XeTeXrevision\thisisundefined
- \else
- \ifx \declaredencoding \utfeight
- \else
- \ifx \declaredencoding \ascii
- \else
- \message{Warning: XeTeX with non-UTF-8 encodings cannot handle %
- non-ASCII characters in auxiliary files.}%
- \fi
- \fi
- \fi
-}
-
-% emacs-page
-% A message to be logged when using a character that isn't available
-% the default font encoding (OT1).
-%
-\def\missingcharmsg#1{\message{Character missing, sorry: #1.}}
-
-% Take account of \c (plain) vs. \, (Texinfo) difference.
-\def\cedilla#1{\ifx\c\ptexc\c{#1}\else\,{#1}\fi}
-
-% First, make active non-ASCII characters in order for them to be
-% correctly categorized when TeX reads the replacement text of
-% macros containing the character definitions.
-\setnonasciicharscatcode\active
-%
-
-\def\gdefchar#1#2{%
-\gdef#1{%
- \ifpassthroughchars
- \string#1%
- \else
- #2%
- \fi
-}}
-
-% Latin1 (ISO-8859-1) character definitions.
-\def\latonechardefs{%
- \gdefchar^^a0{\tie}
- \gdefchar^^a1{\exclamdown}
- \gdefchar^^a2{{\tcfont \char162}} % cent
- \gdefchar^^a3{\pounds{}}
- \gdefchar^^a4{{\tcfont \char164}} % currency
- \gdefchar^^a5{{\tcfont \char165}} % yen
- \gdefchar^^a6{{\tcfont \char166}} % broken bar
- \gdefchar^^a7{\S}
- \gdefchar^^a8{\"{}}
- \gdefchar^^a9{\copyright{}}
- \gdefchar^^aa{\ordf}
- \gdefchar^^ab{\guillemetleft{}}
- \gdefchar^^ac{\ensuremath\lnot}
- \gdefchar^^ad{\-}
- \gdefchar^^ae{\registeredsymbol{}}
- \gdefchar^^af{\={}}
- %
- \gdefchar^^b0{\textdegree}
- \gdefchar^^b1{$\pm$}
- \gdefchar^^b2{$^2$}
- \gdefchar^^b3{$^3$}
- \gdefchar^^b4{\'{}}
- \gdefchar^^b5{$\mu$}
- \gdefchar^^b6{\P}
- \gdefchar^^b7{\ensuremath\cdot}
- \gdefchar^^b8{\cedilla\ }
- \gdefchar^^b9{$^1$}
- \gdefchar^^ba{\ordm}
- \gdefchar^^bb{\guillemetright{}}
- \gdefchar^^bc{$1\over4$}
- \gdefchar^^bd{$1\over2$}
- \gdefchar^^be{$3\over4$}
- \gdefchar^^bf{\questiondown}
- %
- \gdefchar^^c0{\`A}
- \gdefchar^^c1{\'A}
- \gdefchar^^c2{\^A}
- \gdefchar^^c3{\~A}
- \gdefchar^^c4{\"A}
- \gdefchar^^c5{\ringaccent A}
- \gdefchar^^c6{\AE}
- \gdefchar^^c7{\cedilla C}
- \gdefchar^^c8{\`E}
- \gdefchar^^c9{\'E}
- \gdefchar^^ca{\^E}
- \gdefchar^^cb{\"E}
- \gdefchar^^cc{\`I}
- \gdefchar^^cd{\'I}
- \gdefchar^^ce{\^I}
- \gdefchar^^cf{\"I}
- %
- \gdefchar^^d0{\DH}
- \gdefchar^^d1{\~N}
- \gdefchar^^d2{\`O}
- \gdefchar^^d3{\'O}
- \gdefchar^^d4{\^O}
- \gdefchar^^d5{\~O}
- \gdefchar^^d6{\"O}
- \gdefchar^^d7{$\times$}
- \gdefchar^^d8{\O}
- \gdefchar^^d9{\`U}
- \gdefchar^^da{\'U}
- \gdefchar^^db{\^U}
- \gdefchar^^dc{\"U}
- \gdefchar^^dd{\'Y}
- \gdefchar^^de{\TH}
- \gdefchar^^df{\ss}
- %
- \gdefchar^^e0{\`a}
- \gdefchar^^e1{\'a}
- \gdefchar^^e2{\^a}
- \gdefchar^^e3{\~a}
- \gdefchar^^e4{\"a}
- \gdefchar^^e5{\ringaccent a}
- \gdefchar^^e6{\ae}
- \gdefchar^^e7{\cedilla c}
- \gdefchar^^e8{\`e}
- \gdefchar^^e9{\'e}
- \gdefchar^^ea{\^e}
- \gdefchar^^eb{\"e}
- \gdefchar^^ec{\`{\dotless i}}
- \gdefchar^^ed{\'{\dotless i}}
- \gdefchar^^ee{\^{\dotless i}}
- \gdefchar^^ef{\"{\dotless i}}
- %
- \gdefchar^^f0{\dh}
- \gdefchar^^f1{\~n}
- \gdefchar^^f2{\`o}
- \gdefchar^^f3{\'o}
- \gdefchar^^f4{\^o}
- \gdefchar^^f5{\~o}
- \gdefchar^^f6{\"o}
- \gdefchar^^f7{$\div$}
- \gdefchar^^f8{\o}
- \gdefchar^^f9{\`u}
- \gdefchar^^fa{\'u}
- \gdefchar^^fb{\^u}
- \gdefchar^^fc{\"u}
- \gdefchar^^fd{\'y}
- \gdefchar^^fe{\th}
- \gdefchar^^ff{\"y}
-}
-
-% Latin9 (ISO-8859-15) encoding character definitions.
-\def\latninechardefs{%
- % Encoding is almost identical to Latin1.
- \latonechardefs
- %
- \gdefchar^^a4{\euro{}}
- \gdefchar^^a6{\v S}
- \gdefchar^^a8{\v s}
- \gdefchar^^b4{\v Z}
- \gdefchar^^b8{\v z}
- \gdefchar^^bc{\OE}
- \gdefchar^^bd{\oe}
- \gdefchar^^be{\"Y}
-}
-
-% Latin2 (ISO-8859-2) character definitions.
-\def\lattwochardefs{%
- \gdefchar^^a0{\tie}
- \gdefchar^^a1{\ogonek{A}}
- \gdefchar^^a2{\u{}}
- \gdefchar^^a3{\L}
- \gdefchar^^a4{\missingcharmsg{CURRENCY SIGN}}
- \gdefchar^^a5{\v L}
- \gdefchar^^a6{\'S}
- \gdefchar^^a7{\S}
- \gdefchar^^a8{\"{}}
- \gdefchar^^a9{\v S}
- \gdefchar^^aa{\cedilla S}
- \gdefchar^^ab{\v T}
- \gdefchar^^ac{\'Z}
- \gdefchar^^ad{\-}
- \gdefchar^^ae{\v Z}
- \gdefchar^^af{\dotaccent Z}
- %
- \gdefchar^^b0{\textdegree{}}
- \gdefchar^^b1{\ogonek{a}}
- \gdefchar^^b2{\ogonek{ }}
- \gdefchar^^b3{\l}
- \gdefchar^^b4{\'{}}
- \gdefchar^^b5{\v l}
- \gdefchar^^b6{\'s}
- \gdefchar^^b7{\v{}}
- \gdefchar^^b8{\cedilla\ }
- \gdefchar^^b9{\v s}
- \gdefchar^^ba{\cedilla s}
- \gdefchar^^bb{\v t}
- \gdefchar^^bc{\'z}
- \gdefchar^^bd{\H{}}
- \gdefchar^^be{\v z}
- \gdefchar^^bf{\dotaccent z}
- %
- \gdefchar^^c0{\'R}
- \gdefchar^^c1{\'A}
- \gdefchar^^c2{\^A}
- \gdefchar^^c3{\u A}
- \gdefchar^^c4{\"A}
- \gdefchar^^c5{\'L}
- \gdefchar^^c6{\'C}
- \gdefchar^^c7{\cedilla C}
- \gdefchar^^c8{\v C}
- \gdefchar^^c9{\'E}
- \gdefchar^^ca{\ogonek{E}}
- \gdefchar^^cb{\"E}
- \gdefchar^^cc{\v E}
- \gdefchar^^cd{\'I}
- \gdefchar^^ce{\^I}
- \gdefchar^^cf{\v D}
- %
- \gdefchar^^d0{\DH}
- \gdefchar^^d1{\'N}
- \gdefchar^^d2{\v N}
- \gdefchar^^d3{\'O}
- \gdefchar^^d4{\^O}
- \gdefchar^^d5{\H O}
- \gdefchar^^d6{\"O}
- \gdefchar^^d7{$\times$}
- \gdefchar^^d8{\v R}
- \gdefchar^^d9{\ringaccent U}
- \gdefchar^^da{\'U}
- \gdefchar^^db{\H U}
- \gdefchar^^dc{\"U}
- \gdefchar^^dd{\'Y}
- \gdefchar^^de{\cedilla T}
- \gdefchar^^df{\ss}
- %
- \gdefchar^^e0{\'r}
- \gdefchar^^e1{\'a}
- \gdefchar^^e2{\^a}
- \gdefchar^^e3{\u a}
- \gdefchar^^e4{\"a}
- \gdefchar^^e5{\'l}
- \gdefchar^^e6{\'c}
- \gdefchar^^e7{\cedilla c}
- \gdefchar^^e8{\v c}
- \gdefchar^^e9{\'e}
- \gdefchar^^ea{\ogonek{e}}
- \gdefchar^^eb{\"e}
- \gdefchar^^ec{\v e}
- \gdefchar^^ed{\'{\dotless{i}}}
- \gdefchar^^ee{\^{\dotless{i}}}
- \gdefchar^^ef{\v d}
- %
- \gdefchar^^f0{\dh}
- \gdefchar^^f1{\'n}
- \gdefchar^^f2{\v n}
- \gdefchar^^f3{\'o}
- \gdefchar^^f4{\^o}
- \gdefchar^^f5{\H o}
- \gdefchar^^f6{\"o}
- \gdefchar^^f7{$\div$}
- \gdefchar^^f8{\v r}
- \gdefchar^^f9{\ringaccent u}
- \gdefchar^^fa{\'u}
- \gdefchar^^fb{\H u}
- \gdefchar^^fc{\"u}
- \gdefchar^^fd{\'y}
- \gdefchar^^fe{\cedilla t}
- \gdefchar^^ff{\dotaccent{}}
-}
-
-% UTF-8 character definitions.
-%
-% This code to support UTF-8 is based on LaTeX's utf8.def, with some
-% changes for Texinfo conventions. It is included here under the GPL by
-% permission from Frank Mittelbach and the LaTeX team.
-%
-\newcount\countUTFx
-\newcount\countUTFy
-\newcount\countUTFz
-
-\gdef\UTFviiiTwoOctets#1#2{\expandafter
- \UTFviiiDefined\csname u8:#1\string #2\endcsname}
-%
-\gdef\UTFviiiThreeOctets#1#2#3{\expandafter
- \UTFviiiDefined\csname u8:#1\string #2\string #3\endcsname}
-%
-\gdef\UTFviiiFourOctets#1#2#3#4{\expandafter
- \UTFviiiDefined\csname u8:#1\string #2\string #3\string #4\endcsname}
-
-\gdef\UTFviiiDefined#1{%
- \ifx #1\relax
- \message{\linenumber Unicode char \string #1 not defined for Texinfo}%
- \else
- \expandafter #1%
- \fi
-}
-
-% Give non-ASCII bytes the active definitions for processing UTF-8 sequences
-\begingroup
- \catcode`\~13
- \catcode`\$12
- \catcode`\"12
-
- % Loop from \countUTFx to \countUTFy, performing \UTFviiiTmp
- % substituting ~ and $ with a character token of that value.
- \def\UTFviiiLoop{%
- \global\catcode\countUTFx\active
- \uccode`\~\countUTFx
- \uccode`\$\countUTFx
- \uppercase\expandafter{\UTFviiiTmp}%
- \advance\countUTFx by 1
- \ifnum\countUTFx < \countUTFy
- \expandafter\UTFviiiLoop
- \fi}
-
- % For bytes other than the first in a UTF-8 sequence. Not expected to
- % be expanded except when writing to auxiliary files.
- \countUTFx = "80
- \countUTFy = "C2
- \def\UTFviiiTmp{%
- \gdef~{%
- \ifpassthroughchars $\fi}}%
- \UTFviiiLoop
-
- \countUTFx = "C2
- \countUTFy = "E0
- \def\UTFviiiTmp{%
- \gdef~{%
- \ifpassthroughchars $%
- \else\expandafter\UTFviiiTwoOctets\expandafter$\fi}}%
- \UTFviiiLoop
-
- \countUTFx = "E0
- \countUTFy = "F0
- \def\UTFviiiTmp{%
- \gdef~{%
- \ifpassthroughchars $%
- \else\expandafter\UTFviiiThreeOctets\expandafter$\fi}}%
- \UTFviiiLoop
-
- \countUTFx = "F0
- \countUTFy = "F4
- \def\UTFviiiTmp{%
- \gdef~{%
- \ifpassthroughchars $%
- \else\expandafter\UTFviiiFourOctets\expandafter$\fi
- }}%
- \UTFviiiLoop
-\endgroup
-
-\def\globallet{\global\let} % save some \expandafter's below
-
-% @U{xxxx} to produce U+xxxx, if we support it.
-\def\U#1{%
- \expandafter\ifx\csname uni:#1\endcsname \relax
- \iftxinativeunicodecapable
- % All Unicode characters can be used if native Unicode handling is
- % active. However, if the font does not have the glyph,
- % letters are missing.
- \begingroup
- \uccode`\.="#1\relax
- \uppercase{.}
- \endgroup
- \else
- \errhelp = \EMsimple
- \errmessage{Unicode character U+#1 not supported, sorry}%
- \fi
- \else
- \csname uni:#1\endcsname
- \fi
-}
-
-% These macros are used here to construct the name of a control
-% sequence to be defined.
-\def\UTFviiiTwoOctetsName#1#2{%
- \csname u8:#1\string #2\endcsname}%
-\def\UTFviiiThreeOctetsName#1#2#3{%
- \csname u8:#1\string #2\string #3\endcsname}%
-\def\UTFviiiFourOctetsName#1#2#3#4{%
- \csname u8:#1\string #2\string #3\string #4\endcsname}%
-
-% For UTF-8 byte sequences (TeX, e-TeX and pdfTeX),
-% provide a definition macro to replace a Unicode character;
-% this gets used by the @U command
-%
-\begingroup
- \catcode`\"=12
- \catcode`\<=12
- \catcode`\.=12
- \catcode`\,=12
- \catcode`\;=12
- \catcode`\!=12
- \catcode`\~=13
- \gdef\DeclareUnicodeCharacterUTFviii#1#2{%
- \countUTFz = "#1\relax
- \begingroup
- \parseXMLCharref
-
- % Give \u8:... its definition. The sequence of seven \expandafter's
- % expands after the \gdef three times, e.g.
- %
- % 1. \UTFviiTwoOctetsName B1 B2
- % 2. \csname u8:B1 \string B2 \endcsname
- % 3. \u8: B1 B2 (a single control sequence token)
- %
- \expandafter\expandafter
- \expandafter\expandafter
- \expandafter\expandafter
- \expandafter\gdef \UTFviiiTmp{#2}%
- %
- \expandafter\ifx\csname uni:#1\endcsname \relax \else
- \message{Internal error, already defined: #1}%
- \fi
- %
- % define an additional control sequence for this code point.
- \expandafter\globallet\csname uni:#1\endcsname \UTFviiiTmp
- \endgroup}
- %
- % Given the value in \countUTFz as a Unicode code point, set \UTFviiiTmp
- % to the corresponding UTF-8 sequence.
- \gdef\parseXMLCharref{%
- \ifnum\countUTFz < "A0\relax
- \errhelp = \EMsimple
- \errmessage{Cannot define Unicode char value < 00A0}%
- \else\ifnum\countUTFz < "800\relax
- \parseUTFviiiA,%
- \parseUTFviiiB C\UTFviiiTwoOctetsName.,%
- \else\ifnum\countUTFz < "10000\relax
- \parseUTFviiiA;%
- \parseUTFviiiA,%
- \parseUTFviiiB E\UTFviiiThreeOctetsName.{,;}%
- \else
- \parseUTFviiiA;%
- \parseUTFviiiA,%
- \parseUTFviiiA!%
- \parseUTFviiiB F\UTFviiiFourOctetsName.{!,;}%
- \fi\fi\fi
- }
-
- % Extract a byte from the end of the UTF-8 representation of \countUTFx.
- % It must be a non-initial byte in the sequence.
- % Change \uccode of #1 for it to be used in \parseUTFviiiB as one
- % of the bytes.
- \gdef\parseUTFviiiA#1{%
- \countUTFx = \countUTFz
- \divide\countUTFz by 64
- \countUTFy = \countUTFz % Save to be the future value of \countUTFz.
- \multiply\countUTFz by 64
-
- % \countUTFz is now \countUTFx with the last 5 bits cleared. Subtract
- % in order to get the last five bits.
- \advance\countUTFx by -\countUTFz
-
- % Convert this to the byte in the UTF-8 sequence.
- \advance\countUTFx by 128
- \uccode `#1\countUTFx
- \countUTFz = \countUTFy}
-
- % Used to put a UTF-8 byte sequence into \UTFviiiTmp
- % #1 is the increment for \countUTFz to yield a the first byte of the UTF-8
- % sequence.
- % #2 is one of the \UTFviii*OctetsName macros.
- % #3 is always a full stop (.)
- % #4 is a template for the other bytes in the sequence. The values for these
- % bytes is substituted in here with \uppercase using the \uccode's.
- \gdef\parseUTFviiiB#1#2#3#4{%
- \advance\countUTFz by "#10\relax
- \uccode `#3\countUTFz
- \uppercase{\gdef\UTFviiiTmp{#2#3#4}}}
-\endgroup
-
-% For native Unicode handling (XeTeX and LuaTeX),
-% provide a definition macro that sets a catcode to `other' non-globally
-%
-\def\DeclareUnicodeCharacterNativeOther#1#2{%
- \catcode"#1=\other
-}
-
-% https://en.wikipedia.org/wiki/Plane_(Unicode)#Basic_M
-% U+0000..U+007F = https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)
-% U+0080..U+00FF = https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)
-% U+0100..U+017F = https://en.wikipedia.org/wiki/Latin_Extended-A
-% U+0180..U+024F = https://en.wikipedia.org/wiki/Latin_Extended-B
-%
-% Many of our renditions are less than wonderful, and all the missing
-% characters are available somewhere. Loading the necessary fonts
-% awaits user request. We can't truly support Unicode without
-% reimplementing everything that's been done in LaTeX for many years,
-% plus probably using luatex or xetex, and who knows what else.
-% We won't be doing that here in this simple file. But we can try to at
-% least make most of the characters not bomb out.
-%
-\def\unicodechardefs{%
- \DeclareUnicodeCharacter{00A0}{\tie}%
- \DeclareUnicodeCharacter{00A1}{\exclamdown}%
- \DeclareUnicodeCharacter{00A2}{{\tcfont \char162}}% 0242=cent
- \DeclareUnicodeCharacter{00A3}{\pounds{}}%
- \DeclareUnicodeCharacter{00A4}{{\tcfont \char164}}% 0244=currency
- \DeclareUnicodeCharacter{00A5}{{\tcfont \char165}}% 0245=yen
- \DeclareUnicodeCharacter{00A6}{{\tcfont \char166}}% 0246=brokenbar
- \DeclareUnicodeCharacter{00A7}{\S}%
- \DeclareUnicodeCharacter{00A8}{\"{ }}%
- \DeclareUnicodeCharacter{00A9}{\copyright{}}%
- \DeclareUnicodeCharacter{00AA}{\ordf}%
- \DeclareUnicodeCharacter{00AB}{\guillemetleft{}}%
- \DeclareUnicodeCharacter{00AC}{\ensuremath\lnot}%
- \DeclareUnicodeCharacter{00AD}{\-}%
- \DeclareUnicodeCharacter{00AE}{\registeredsymbol{}}%
- \DeclareUnicodeCharacter{00AF}{\={ }}%
- %
- \DeclareUnicodeCharacter{00B0}{\ringaccent{ }}%
- \DeclareUnicodeCharacter{00B1}{\ensuremath\pm}%
- \DeclareUnicodeCharacter{00B2}{$^2$}%
- \DeclareUnicodeCharacter{00B3}{$^3$}%
- \DeclareUnicodeCharacter{00B4}{\'{ }}%
- \DeclareUnicodeCharacter{00B5}{$\mu$}%
- \DeclareUnicodeCharacter{00B6}{\P}%
- \DeclareUnicodeCharacter{00B7}{\ensuremath\cdot}%
- \DeclareUnicodeCharacter{00B8}{\cedilla{ }}%
- \DeclareUnicodeCharacter{00B9}{$^1$}%
- \DeclareUnicodeCharacter{00BA}{\ordm}%
- \DeclareUnicodeCharacter{00BB}{\guillemetright{}}%
- \DeclareUnicodeCharacter{00BC}{$1\over4$}%
- \DeclareUnicodeCharacter{00BD}{$1\over2$}%
- \DeclareUnicodeCharacter{00BE}{$3\over4$}%
- \DeclareUnicodeCharacter{00BF}{\questiondown}%
- %
- \DeclareUnicodeCharacter{00C0}{\`A}%
- \DeclareUnicodeCharacter{00C1}{\'A}%
- \DeclareUnicodeCharacter{00C2}{\^A}%
- \DeclareUnicodeCharacter{00C3}{\~A}%
- \DeclareUnicodeCharacter{00C4}{\"A}%
- \DeclareUnicodeCharacter{00C5}{\AA}%
- \DeclareUnicodeCharacter{00C6}{\AE}%
- \DeclareUnicodeCharacter{00C7}{\cedilla{C}}%
- \DeclareUnicodeCharacter{00C8}{\`E}%
- \DeclareUnicodeCharacter{00C9}{\'E}%
- \DeclareUnicodeCharacter{00CA}{\^E}%
- \DeclareUnicodeCharacter{00CB}{\"E}%
- \DeclareUnicodeCharacter{00CC}{\`I}%
- \DeclareUnicodeCharacter{00CD}{\'I}%
- \DeclareUnicodeCharacter{00CE}{\^I}%
- \DeclareUnicodeCharacter{00CF}{\"I}%
- %
- \DeclareUnicodeCharacter{00D0}{\DH}%
- \DeclareUnicodeCharacter{00D1}{\~N}%
- \DeclareUnicodeCharacter{00D2}{\`O}%
- \DeclareUnicodeCharacter{00D3}{\'O}%
- \DeclareUnicodeCharacter{00D4}{\^O}%
- \DeclareUnicodeCharacter{00D5}{\~O}%
- \DeclareUnicodeCharacter{00D6}{\"O}%
- \DeclareUnicodeCharacter{00D7}{\ensuremath\times}%
- \DeclareUnicodeCharacter{00D8}{\O}%
- \DeclareUnicodeCharacter{00D9}{\`U}%
- \DeclareUnicodeCharacter{00DA}{\'U}%
- \DeclareUnicodeCharacter{00DB}{\^U}%
- \DeclareUnicodeCharacter{00DC}{\"U}%
- \DeclareUnicodeCharacter{00DD}{\'Y}%
- \DeclareUnicodeCharacter{00DE}{\TH}%
- \DeclareUnicodeCharacter{00DF}{\ss}%
- %
- \DeclareUnicodeCharacter{00E0}{\`a}%
- \DeclareUnicodeCharacter{00E1}{\'a}%
- \DeclareUnicodeCharacter{00E2}{\^a}%
- \DeclareUnicodeCharacter{00E3}{\~a}%
- \DeclareUnicodeCharacter{00E4}{\"a}%
- \DeclareUnicodeCharacter{00E5}{\aa}%
- \DeclareUnicodeCharacter{00E6}{\ae}%
- \DeclareUnicodeCharacter{00E7}{\cedilla{c}}%
- \DeclareUnicodeCharacter{00E8}{\`e}%
- \DeclareUnicodeCharacter{00E9}{\'e}%
- \DeclareUnicodeCharacter{00EA}{\^e}%
- \DeclareUnicodeCharacter{00EB}{\"e}%
- \DeclareUnicodeCharacter{00EC}{\`{\dotless{i}}}%
- \DeclareUnicodeCharacter{00ED}{\'{\dotless{i}}}%
- \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}}%
- \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}}%
- %
- \DeclareUnicodeCharacter{00F0}{\dh}%
- \DeclareUnicodeCharacter{00F1}{\~n}%
- \DeclareUnicodeCharacter{00F2}{\`o}%
- \DeclareUnicodeCharacter{00F3}{\'o}%
- \DeclareUnicodeCharacter{00F4}{\^o}%
- \DeclareUnicodeCharacter{00F5}{\~o}%
- \DeclareUnicodeCharacter{00F6}{\"o}%
- \DeclareUnicodeCharacter{00F7}{\ensuremath\div}%
- \DeclareUnicodeCharacter{00F8}{\o}%
- \DeclareUnicodeCharacter{00F9}{\`u}%
- \DeclareUnicodeCharacter{00FA}{\'u}%
- \DeclareUnicodeCharacter{00FB}{\^u}%
- \DeclareUnicodeCharacter{00FC}{\"u}%
- \DeclareUnicodeCharacter{00FD}{\'y}%
- \DeclareUnicodeCharacter{00FE}{\th}%
- \DeclareUnicodeCharacter{00FF}{\"y}%
- %
- \DeclareUnicodeCharacter{0100}{\=A}%
- \DeclareUnicodeCharacter{0101}{\=a}%
- \DeclareUnicodeCharacter{0102}{\u{A}}%
- \DeclareUnicodeCharacter{0103}{\u{a}}%
- \DeclareUnicodeCharacter{0104}{\ogonek{A}}%
- \DeclareUnicodeCharacter{0105}{\ogonek{a}}%
- \DeclareUnicodeCharacter{0106}{\'C}%
- \DeclareUnicodeCharacter{0107}{\'c}%
- \DeclareUnicodeCharacter{0108}{\^C}%
- \DeclareUnicodeCharacter{0109}{\^c}%
- \DeclareUnicodeCharacter{010A}{\dotaccent{C}}%
- \DeclareUnicodeCharacter{010B}{\dotaccent{c}}%
- \DeclareUnicodeCharacter{010C}{\v{C}}%
- \DeclareUnicodeCharacter{010D}{\v{c}}%
- \DeclareUnicodeCharacter{010E}{\v{D}}%
- \DeclareUnicodeCharacter{010F}{d'}%
- %
- \DeclareUnicodeCharacter{0110}{\DH}%
- \DeclareUnicodeCharacter{0111}{\dh}%
- \DeclareUnicodeCharacter{0112}{\=E}%
- \DeclareUnicodeCharacter{0113}{\=e}%
- \DeclareUnicodeCharacter{0114}{\u{E}}%
- \DeclareUnicodeCharacter{0115}{\u{e}}%
- \DeclareUnicodeCharacter{0116}{\dotaccent{E}}%
- \DeclareUnicodeCharacter{0117}{\dotaccent{e}}%
- \DeclareUnicodeCharacter{0118}{\ogonek{E}}%
- \DeclareUnicodeCharacter{0119}{\ogonek{e}}%
- \DeclareUnicodeCharacter{011A}{\v{E}}%
- \DeclareUnicodeCharacter{011B}{\v{e}}%
- \DeclareUnicodeCharacter{011C}{\^G}%
- \DeclareUnicodeCharacter{011D}{\^g}%
- \DeclareUnicodeCharacter{011E}{\u{G}}%
- \DeclareUnicodeCharacter{011F}{\u{g}}%
- %
- \DeclareUnicodeCharacter{0120}{\dotaccent{G}}%
- \DeclareUnicodeCharacter{0121}{\dotaccent{g}}%
- \DeclareUnicodeCharacter{0122}{\cedilla{G}}%
- \DeclareUnicodeCharacter{0123}{\cedilla{g}}%
- \DeclareUnicodeCharacter{0124}{\^H}%
- \DeclareUnicodeCharacter{0125}{\^h}%
- \DeclareUnicodeCharacter{0126}{\missingcharmsg{H WITH STROKE}}%
- \DeclareUnicodeCharacter{0127}{\missingcharmsg{h WITH STROKE}}%
- \DeclareUnicodeCharacter{0128}{\~I}%
- \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}}%
- \DeclareUnicodeCharacter{012A}{\=I}%
- \DeclareUnicodeCharacter{012B}{\={\dotless{i}}}%
- \DeclareUnicodeCharacter{012C}{\u{I}}%
- \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}}%
- \DeclareUnicodeCharacter{012E}{\ogonek{I}}%
- \DeclareUnicodeCharacter{012F}{\ogonek{i}}%
- %
- \DeclareUnicodeCharacter{0130}{\dotaccent{I}}%
- \DeclareUnicodeCharacter{0131}{\dotless{i}}%
- \DeclareUnicodeCharacter{0132}{IJ}%
- \DeclareUnicodeCharacter{0133}{ij}%
- \DeclareUnicodeCharacter{0134}{\^J}%
- \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}}%
- \DeclareUnicodeCharacter{0136}{\cedilla{K}}%
- \DeclareUnicodeCharacter{0137}{\cedilla{k}}%
- \DeclareUnicodeCharacter{0138}{\ensuremath\kappa}%
- \DeclareUnicodeCharacter{0139}{\'L}%
- \DeclareUnicodeCharacter{013A}{\'l}%
- \DeclareUnicodeCharacter{013B}{\cedilla{L}}%
- \DeclareUnicodeCharacter{013C}{\cedilla{l}}%
- \DeclareUnicodeCharacter{013D}{L'}% should kern
- \DeclareUnicodeCharacter{013E}{l'}% should kern
- \DeclareUnicodeCharacter{013F}{L\U{00B7}}%
- %
- \DeclareUnicodeCharacter{0140}{l\U{00B7}}%
- \DeclareUnicodeCharacter{0141}{\L}%
- \DeclareUnicodeCharacter{0142}{\l}%
- \DeclareUnicodeCharacter{0143}{\'N}%
- \DeclareUnicodeCharacter{0144}{\'n}%
- \DeclareUnicodeCharacter{0145}{\cedilla{N}}%
- \DeclareUnicodeCharacter{0146}{\cedilla{n}}%
- \DeclareUnicodeCharacter{0147}{\v{N}}%
- \DeclareUnicodeCharacter{0148}{\v{n}}%
- \DeclareUnicodeCharacter{0149}{'n}%
- \DeclareUnicodeCharacter{014A}{\missingcharmsg{ENG}}%
- \DeclareUnicodeCharacter{014B}{\missingcharmsg{eng}}%
- \DeclareUnicodeCharacter{014C}{\=O}%
- \DeclareUnicodeCharacter{014D}{\=o}%
- \DeclareUnicodeCharacter{014E}{\u{O}}%
- \DeclareUnicodeCharacter{014F}{\u{o}}%
- %
- \DeclareUnicodeCharacter{0150}{\H{O}}%
- \DeclareUnicodeCharacter{0151}{\H{o}}%
- \DeclareUnicodeCharacter{0152}{\OE}%
- \DeclareUnicodeCharacter{0153}{\oe}%
- \DeclareUnicodeCharacter{0154}{\'R}%
- \DeclareUnicodeCharacter{0155}{\'r}%
- \DeclareUnicodeCharacter{0156}{\cedilla{R}}%
- \DeclareUnicodeCharacter{0157}{\cedilla{r}}%
- \DeclareUnicodeCharacter{0158}{\v{R}}%
- \DeclareUnicodeCharacter{0159}{\v{r}}%
- \DeclareUnicodeCharacter{015A}{\'S}%
- \DeclareUnicodeCharacter{015B}{\'s}%
- \DeclareUnicodeCharacter{015C}{\^S}%
- \DeclareUnicodeCharacter{015D}{\^s}%
- \DeclareUnicodeCharacter{015E}{\cedilla{S}}%
- \DeclareUnicodeCharacter{015F}{\cedilla{s}}%
- %
- \DeclareUnicodeCharacter{0160}{\v{S}}%
- \DeclareUnicodeCharacter{0161}{\v{s}}%
- \DeclareUnicodeCharacter{0162}{\cedilla{T}}%
- \DeclareUnicodeCharacter{0163}{\cedilla{t}}%
- \DeclareUnicodeCharacter{0164}{\v{T}}%
- \DeclareUnicodeCharacter{0165}{\v{t}}%
- \DeclareUnicodeCharacter{0166}{\missingcharmsg{H WITH STROKE}}%
- \DeclareUnicodeCharacter{0167}{\missingcharmsg{h WITH STROKE}}%
- \DeclareUnicodeCharacter{0168}{\~U}%
- \DeclareUnicodeCharacter{0169}{\~u}%
- \DeclareUnicodeCharacter{016A}{\=U}%
- \DeclareUnicodeCharacter{016B}{\=u}%
- \DeclareUnicodeCharacter{016C}{\u{U}}%
- \DeclareUnicodeCharacter{016D}{\u{u}}%
- \DeclareUnicodeCharacter{016E}{\ringaccent{U}}%
- \DeclareUnicodeCharacter{016F}{\ringaccent{u}}%
- %
- \DeclareUnicodeCharacter{0170}{\H{U}}%
- \DeclareUnicodeCharacter{0171}{\H{u}}%
- \DeclareUnicodeCharacter{0172}{\ogonek{U}}%
- \DeclareUnicodeCharacter{0173}{\ogonek{u}}%
- \DeclareUnicodeCharacter{0174}{\^W}%
- \DeclareUnicodeCharacter{0175}{\^w}%
- \DeclareUnicodeCharacter{0176}{\^Y}%
- \DeclareUnicodeCharacter{0177}{\^y}%
- \DeclareUnicodeCharacter{0178}{\"Y}%
- \DeclareUnicodeCharacter{0179}{\'Z}%
- \DeclareUnicodeCharacter{017A}{\'z}%
- \DeclareUnicodeCharacter{017B}{\dotaccent{Z}}%
- \DeclareUnicodeCharacter{017C}{\dotaccent{z}}%
- \DeclareUnicodeCharacter{017D}{\v{Z}}%
- \DeclareUnicodeCharacter{017E}{\v{z}}%
- \DeclareUnicodeCharacter{017F}{\missingcharmsg{LONG S}}%
- %
- \DeclareUnicodeCharacter{01C4}{D\v{Z}}%
- \DeclareUnicodeCharacter{01C5}{D\v{z}}%
- \DeclareUnicodeCharacter{01C6}{d\v{z}}%
- \DeclareUnicodeCharacter{01C7}{LJ}%
- \DeclareUnicodeCharacter{01C8}{Lj}%
- \DeclareUnicodeCharacter{01C9}{lj}%
- \DeclareUnicodeCharacter{01CA}{NJ}%
- \DeclareUnicodeCharacter{01CB}{Nj}%
- \DeclareUnicodeCharacter{01CC}{nj}%
- \DeclareUnicodeCharacter{01CD}{\v{A}}%
- \DeclareUnicodeCharacter{01CE}{\v{a}}%
- \DeclareUnicodeCharacter{01CF}{\v{I}}%
- %
- \DeclareUnicodeCharacter{01D0}{\v{\dotless{i}}}%
- \DeclareUnicodeCharacter{01D1}{\v{O}}%
- \DeclareUnicodeCharacter{01D2}{\v{o}}%
- \DeclareUnicodeCharacter{01D3}{\v{U}}%
- \DeclareUnicodeCharacter{01D4}{\v{u}}%
- %
- \DeclareUnicodeCharacter{01E2}{\={\AE}}%
- \DeclareUnicodeCharacter{01E3}{\={\ae}}%
- \DeclareUnicodeCharacter{01E6}{\v{G}}%
- \DeclareUnicodeCharacter{01E7}{\v{g}}%
- \DeclareUnicodeCharacter{01E8}{\v{K}}%
- \DeclareUnicodeCharacter{01E9}{\v{k}}%
- %
- \DeclareUnicodeCharacter{01F0}{\v{\dotless{j}}}%
- \DeclareUnicodeCharacter{01F1}{DZ}%
- \DeclareUnicodeCharacter{01F2}{Dz}%
- \DeclareUnicodeCharacter{01F3}{dz}%
- \DeclareUnicodeCharacter{01F4}{\'G}%
- \DeclareUnicodeCharacter{01F5}{\'g}%
- \DeclareUnicodeCharacter{01F8}{\`N}%
- \DeclareUnicodeCharacter{01F9}{\`n}%
- \DeclareUnicodeCharacter{01FC}{\'{\AE}}%
- \DeclareUnicodeCharacter{01FD}{\'{\ae}}%
- \DeclareUnicodeCharacter{01FE}{\'{\O}}%
- \DeclareUnicodeCharacter{01FF}{\'{\o}}%
- %
- \DeclareUnicodeCharacter{021E}{\v{H}}%
- \DeclareUnicodeCharacter{021F}{\v{h}}%
- %
- \DeclareUnicodeCharacter{0226}{\dotaccent{A}}%
- \DeclareUnicodeCharacter{0227}{\dotaccent{a}}%
- \DeclareUnicodeCharacter{0228}{\cedilla{E}}%
- \DeclareUnicodeCharacter{0229}{\cedilla{e}}%
- \DeclareUnicodeCharacter{022E}{\dotaccent{O}}%
- \DeclareUnicodeCharacter{022F}{\dotaccent{o}}%
- %
- \DeclareUnicodeCharacter{0232}{\=Y}%
- \DeclareUnicodeCharacter{0233}{\=y}%
- \DeclareUnicodeCharacter{0237}{\dotless{j}}%
- %
- \DeclareUnicodeCharacter{02DB}{\ogonek{ }}%
- %
- % Greek letters upper case
- \DeclareUnicodeCharacter{0391}{{\it A}}%
- \DeclareUnicodeCharacter{0392}{{\it B}}%
- \DeclareUnicodeCharacter{0393}{\ensuremath{\mit\Gamma}}%
- \DeclareUnicodeCharacter{0394}{\ensuremath{\mit\Delta}}%
- \DeclareUnicodeCharacter{0395}{{\it E}}%
- \DeclareUnicodeCharacter{0396}{{\it Z}}%
- \DeclareUnicodeCharacter{0397}{{\it H}}%
- \DeclareUnicodeCharacter{0398}{\ensuremath{\mit\Theta}}%
- \DeclareUnicodeCharacter{0399}{{\it I}}%
- \DeclareUnicodeCharacter{039A}{{\it K}}%
- \DeclareUnicodeCharacter{039B}{\ensuremath{\mit\Lambda}}%
- \DeclareUnicodeCharacter{039C}{{\it M}}%
- \DeclareUnicodeCharacter{039D}{{\it N}}%
- \DeclareUnicodeCharacter{039E}{\ensuremath{\mit\Xi}}%
- \DeclareUnicodeCharacter{039F}{{\it O}}%
- \DeclareUnicodeCharacter{03A0}{\ensuremath{\mit\Pi}}%
- \DeclareUnicodeCharacter{03A1}{{\it P}}%
- %\DeclareUnicodeCharacter{03A2}{} % none - corresponds to final sigma
- \DeclareUnicodeCharacter{03A3}{\ensuremath{\mit\Sigma}}%
- \DeclareUnicodeCharacter{03A4}{{\it T}}%
- \DeclareUnicodeCharacter{03A5}{\ensuremath{\mit\Upsilon}}%
- \DeclareUnicodeCharacter{03A6}{\ensuremath{\mit\Phi}}%
- \DeclareUnicodeCharacter{03A7}{{\it X}}%
- \DeclareUnicodeCharacter{03A8}{\ensuremath{\mit\Psi}}%
- \DeclareUnicodeCharacter{03A9}{\ensuremath{\mit\Omega}}%
- %
- % Vowels with accents
- \DeclareUnicodeCharacter{0390}{\ensuremath{\ddot{\acute\iota}}}%
- \DeclareUnicodeCharacter{03AC}{\ensuremath{\acute\alpha}}%
- \DeclareUnicodeCharacter{03AD}{\ensuremath{\acute\epsilon}}%
- \DeclareUnicodeCharacter{03AE}{\ensuremath{\acute\eta}}%
- \DeclareUnicodeCharacter{03AF}{\ensuremath{\acute\iota}}%
- \DeclareUnicodeCharacter{03B0}{\ensuremath{\acute{\ddot\upsilon}}}%
- %
- % Standalone accent
- \DeclareUnicodeCharacter{0384}{\ensuremath{\acute{\ }}}%
- %
- % Greek letters lower case
- \DeclareUnicodeCharacter{03B1}{\ensuremath\alpha}%
- \DeclareUnicodeCharacter{03B2}{\ensuremath\beta}%
- \DeclareUnicodeCharacter{03B3}{\ensuremath\gamma}%
- \DeclareUnicodeCharacter{03B4}{\ensuremath\delta}%
- \DeclareUnicodeCharacter{03B5}{\ensuremath\epsilon}%
- \DeclareUnicodeCharacter{03B6}{\ensuremath\zeta}%
- \DeclareUnicodeCharacter{03B7}{\ensuremath\eta}%
- \DeclareUnicodeCharacter{03B8}{\ensuremath\theta}%
- \DeclareUnicodeCharacter{03B9}{\ensuremath\iota}%
- \DeclareUnicodeCharacter{03BA}{\ensuremath\kappa}%
- \DeclareUnicodeCharacter{03BB}{\ensuremath\lambda}%
- \DeclareUnicodeCharacter{03BC}{\ensuremath\mu}%
- \DeclareUnicodeCharacter{03BD}{\ensuremath\nu}%
- \DeclareUnicodeCharacter{03BE}{\ensuremath\xi}%
- \DeclareUnicodeCharacter{03BF}{{\it o}}% omicron
- \DeclareUnicodeCharacter{03C0}{\ensuremath\pi}%
- \DeclareUnicodeCharacter{03C1}{\ensuremath\rho}%
- \DeclareUnicodeCharacter{03C2}{\ensuremath\varsigma}%
- \DeclareUnicodeCharacter{03C3}{\ensuremath\sigma}%
- \DeclareUnicodeCharacter{03C4}{\ensuremath\tau}%
- \DeclareUnicodeCharacter{03C5}{\ensuremath\upsilon}%
- \DeclareUnicodeCharacter{03C6}{\ensuremath\phi}%
- \DeclareUnicodeCharacter{03C7}{\ensuremath\chi}%
- \DeclareUnicodeCharacter{03C8}{\ensuremath\psi}%
- \DeclareUnicodeCharacter{03C9}{\ensuremath\omega}%
- %
- % More Greek vowels with accents
- \DeclareUnicodeCharacter{03CA}{\ensuremath{\ddot\iota}}%
- \DeclareUnicodeCharacter{03CB}{\ensuremath{\ddot\upsilon}}%
- \DeclareUnicodeCharacter{03CC}{\ensuremath{\acute o}}%
- \DeclareUnicodeCharacter{03CD}{\ensuremath{\acute\upsilon}}%
- \DeclareUnicodeCharacter{03CE}{\ensuremath{\acute\omega}}%
- %
- % Variant Greek letters
- \DeclareUnicodeCharacter{03D1}{\ensuremath\vartheta}%
- \DeclareUnicodeCharacter{03D6}{\ensuremath\varpi}%
- \DeclareUnicodeCharacter{03F1}{\ensuremath\varrho}%
- %
- \DeclareUnicodeCharacter{1E02}{\dotaccent{B}}%
- \DeclareUnicodeCharacter{1E03}{\dotaccent{b}}%
- \DeclareUnicodeCharacter{1E04}{\udotaccent{B}}%
- \DeclareUnicodeCharacter{1E05}{\udotaccent{b}}%
- \DeclareUnicodeCharacter{1E06}{\ubaraccent{B}}%
- \DeclareUnicodeCharacter{1E07}{\ubaraccent{b}}%
- \DeclareUnicodeCharacter{1E0A}{\dotaccent{D}}%
- \DeclareUnicodeCharacter{1E0B}{\dotaccent{d}}%
- \DeclareUnicodeCharacter{1E0C}{\udotaccent{D}}%
- \DeclareUnicodeCharacter{1E0D}{\udotaccent{d}}%
- \DeclareUnicodeCharacter{1E0E}{\ubaraccent{D}}%
- \DeclareUnicodeCharacter{1E0F}{\ubaraccent{d}}%
- %
- \DeclareUnicodeCharacter{1E1E}{\dotaccent{F}}%
- \DeclareUnicodeCharacter{1E1F}{\dotaccent{f}}%
- %
- \DeclareUnicodeCharacter{1E20}{\=G}%
- \DeclareUnicodeCharacter{1E21}{\=g}%
- \DeclareUnicodeCharacter{1E22}{\dotaccent{H}}%
- \DeclareUnicodeCharacter{1E23}{\dotaccent{h}}%
- \DeclareUnicodeCharacter{1E24}{\udotaccent{H}}%
- \DeclareUnicodeCharacter{1E25}{\udotaccent{h}}%
- \DeclareUnicodeCharacter{1E26}{\"H}%
- \DeclareUnicodeCharacter{1E27}{\"h}%
- %
- \DeclareUnicodeCharacter{1E30}{\'K}%
- \DeclareUnicodeCharacter{1E31}{\'k}%
- \DeclareUnicodeCharacter{1E32}{\udotaccent{K}}%
- \DeclareUnicodeCharacter{1E33}{\udotaccent{k}}%
- \DeclareUnicodeCharacter{1E34}{\ubaraccent{K}}%
- \DeclareUnicodeCharacter{1E35}{\ubaraccent{k}}%
- \DeclareUnicodeCharacter{1E36}{\udotaccent{L}}%
- \DeclareUnicodeCharacter{1E37}{\udotaccent{l}}%
- \DeclareUnicodeCharacter{1E3A}{\ubaraccent{L}}%
- \DeclareUnicodeCharacter{1E3B}{\ubaraccent{l}}%
- \DeclareUnicodeCharacter{1E3E}{\'M}%
- \DeclareUnicodeCharacter{1E3F}{\'m}%
- %
- \DeclareUnicodeCharacter{1E40}{\dotaccent{M}}%
- \DeclareUnicodeCharacter{1E41}{\dotaccent{m}}%
- \DeclareUnicodeCharacter{1E42}{\udotaccent{M}}%
- \DeclareUnicodeCharacter{1E43}{\udotaccent{m}}%
- \DeclareUnicodeCharacter{1E44}{\dotaccent{N}}%
- \DeclareUnicodeCharacter{1E45}{\dotaccent{n}}%
- \DeclareUnicodeCharacter{1E46}{\udotaccent{N}}%
- \DeclareUnicodeCharacter{1E47}{\udotaccent{n}}%
- \DeclareUnicodeCharacter{1E48}{\ubaraccent{N}}%
- \DeclareUnicodeCharacter{1E49}{\ubaraccent{n}}%
- %
- \DeclareUnicodeCharacter{1E54}{\'P}%
- \DeclareUnicodeCharacter{1E55}{\'p}%
- \DeclareUnicodeCharacter{1E56}{\dotaccent{P}}%
- \DeclareUnicodeCharacter{1E57}{\dotaccent{p}}%
- \DeclareUnicodeCharacter{1E58}{\dotaccent{R}}%
- \DeclareUnicodeCharacter{1E59}{\dotaccent{r}}%
- \DeclareUnicodeCharacter{1E5A}{\udotaccent{R}}%
- \DeclareUnicodeCharacter{1E5B}{\udotaccent{r}}%
- \DeclareUnicodeCharacter{1E5E}{\ubaraccent{R}}%
- \DeclareUnicodeCharacter{1E5F}{\ubaraccent{r}}%
- %
- \DeclareUnicodeCharacter{1E60}{\dotaccent{S}}%
- \DeclareUnicodeCharacter{1E61}{\dotaccent{s}}%
- \DeclareUnicodeCharacter{1E62}{\udotaccent{S}}%
- \DeclareUnicodeCharacter{1E63}{\udotaccent{s}}%
- \DeclareUnicodeCharacter{1E6A}{\dotaccent{T}}%
- \DeclareUnicodeCharacter{1E6B}{\dotaccent{t}}%
- \DeclareUnicodeCharacter{1E6C}{\udotaccent{T}}%
- \DeclareUnicodeCharacter{1E6D}{\udotaccent{t}}%
- \DeclareUnicodeCharacter{1E6E}{\ubaraccent{T}}%
- \DeclareUnicodeCharacter{1E6F}{\ubaraccent{t}}%
- %
- \DeclareUnicodeCharacter{1E7C}{\~V}%
- \DeclareUnicodeCharacter{1E7D}{\~v}%
- \DeclareUnicodeCharacter{1E7E}{\udotaccent{V}}%
- \DeclareUnicodeCharacter{1E7F}{\udotaccent{v}}%
- %
- \DeclareUnicodeCharacter{1E80}{\`W}%
- \DeclareUnicodeCharacter{1E81}{\`w}%
- \DeclareUnicodeCharacter{1E82}{\'W}%
- \DeclareUnicodeCharacter{1E83}{\'w}%
- \DeclareUnicodeCharacter{1E84}{\"W}%
- \DeclareUnicodeCharacter{1E85}{\"w}%
- \DeclareUnicodeCharacter{1E86}{\dotaccent{W}}%
- \DeclareUnicodeCharacter{1E87}{\dotaccent{w}}%
- \DeclareUnicodeCharacter{1E88}{\udotaccent{W}}%
- \DeclareUnicodeCharacter{1E89}{\udotaccent{w}}%
- \DeclareUnicodeCharacter{1E8A}{\dotaccent{X}}%
- \DeclareUnicodeCharacter{1E8B}{\dotaccent{x}}%
- \DeclareUnicodeCharacter{1E8C}{\"X}%
- \DeclareUnicodeCharacter{1E8D}{\"x}%
- \DeclareUnicodeCharacter{1E8E}{\dotaccent{Y}}%
- \DeclareUnicodeCharacter{1E8F}{\dotaccent{y}}%
- %
- \DeclareUnicodeCharacter{1E90}{\^Z}%
- \DeclareUnicodeCharacter{1E91}{\^z}%
- \DeclareUnicodeCharacter{1E92}{\udotaccent{Z}}%
- \DeclareUnicodeCharacter{1E93}{\udotaccent{z}}%
- \DeclareUnicodeCharacter{1E94}{\ubaraccent{Z}}%
- \DeclareUnicodeCharacter{1E95}{\ubaraccent{z}}%
- \DeclareUnicodeCharacter{1E96}{\ubaraccent{h}}%
- \DeclareUnicodeCharacter{1E97}{\"t}%
- \DeclareUnicodeCharacter{1E98}{\ringaccent{w}}%
- \DeclareUnicodeCharacter{1E99}{\ringaccent{y}}%
- %
- \DeclareUnicodeCharacter{1EA0}{\udotaccent{A}}%
- \DeclareUnicodeCharacter{1EA1}{\udotaccent{a}}%
- %
- \DeclareUnicodeCharacter{1EB8}{\udotaccent{E}}%
- \DeclareUnicodeCharacter{1EB9}{\udotaccent{e}}%
- \DeclareUnicodeCharacter{1EBC}{\~E}%
- \DeclareUnicodeCharacter{1EBD}{\~e}%
- %
- \DeclareUnicodeCharacter{1ECA}{\udotaccent{I}}%
- \DeclareUnicodeCharacter{1ECB}{\udotaccent{i}}%
- \DeclareUnicodeCharacter{1ECC}{\udotaccent{O}}%
- \DeclareUnicodeCharacter{1ECD}{\udotaccent{o}}%
- %
- \DeclareUnicodeCharacter{1EE4}{\udotaccent{U}}%
- \DeclareUnicodeCharacter{1EE5}{\udotaccent{u}}%
- %
- \DeclareUnicodeCharacter{1EF2}{\`Y}%
- \DeclareUnicodeCharacter{1EF3}{\`y}%
- \DeclareUnicodeCharacter{1EF4}{\udotaccent{Y}}%
- %
- \DeclareUnicodeCharacter{1EF8}{\~Y}%
- \DeclareUnicodeCharacter{1EF9}{\~y}%
- %
- % Punctuation
- \DeclareUnicodeCharacter{2013}{--}%
- \DeclareUnicodeCharacter{2014}{---}%
- \DeclareUnicodeCharacter{2018}{\quoteleft{}}%
- \DeclareUnicodeCharacter{2019}{\quoteright{}}%
- \DeclareUnicodeCharacter{201A}{\quotesinglbase{}}%
- \DeclareUnicodeCharacter{201C}{\quotedblleft{}}%
- \DeclareUnicodeCharacter{201D}{\quotedblright{}}%
- \DeclareUnicodeCharacter{201E}{\quotedblbase{}}%
- \DeclareUnicodeCharacter{2020}{\ensuremath\dagger}%
- \DeclareUnicodeCharacter{2021}{\ensuremath\ddagger}%
- \DeclareUnicodeCharacter{2022}{\bullet{}}%
- \DeclareUnicodeCharacter{202F}{\thinspace}%
- \DeclareUnicodeCharacter{2026}{\dots{}}%
- \DeclareUnicodeCharacter{2039}{\guilsinglleft{}}%
- \DeclareUnicodeCharacter{203A}{\guilsinglright{}}%
- %
- \DeclareUnicodeCharacter{20AC}{\euro{}}%
- %
- \DeclareUnicodeCharacter{2192}{\expansion{}}%
- \DeclareUnicodeCharacter{21D2}{\result{}}%
- %
- % Mathematical symbols
- \DeclareUnicodeCharacter{2200}{\ensuremath\forall}%
- \DeclareUnicodeCharacter{2203}{\ensuremath\exists}%
- \DeclareUnicodeCharacter{2208}{\ensuremath\in}%
- \DeclareUnicodeCharacter{2212}{\minus{}}%
- \DeclareUnicodeCharacter{2217}{\ast}%
- \DeclareUnicodeCharacter{221E}{\ensuremath\infty}%
- \DeclareUnicodeCharacter{2225}{\ensuremath\parallel}%
- \DeclareUnicodeCharacter{2227}{\ensuremath\wedge}%
- \DeclareUnicodeCharacter{2229}{\ensuremath\cap}%
- \DeclareUnicodeCharacter{2261}{\equiv{}}%
- \DeclareUnicodeCharacter{2264}{\ensuremath\leq}%
- \DeclareUnicodeCharacter{2265}{\ensuremath\geq}%
- \DeclareUnicodeCharacter{2282}{\ensuremath\subset}%
- \DeclareUnicodeCharacter{2287}{\ensuremath\supseteq}%
- %
- \DeclareUnicodeCharacter{2016}{\ensuremath\Vert}%
- \DeclareUnicodeCharacter{2032}{\ensuremath\prime}%
- \DeclareUnicodeCharacter{210F}{\ensuremath\hbar}%
- \DeclareUnicodeCharacter{2111}{\ensuremath\Im}%
- \DeclareUnicodeCharacter{2113}{\ensuremath\ell}%
- \DeclareUnicodeCharacter{2118}{\ensuremath\wp}%
- \DeclareUnicodeCharacter{211C}{\ensuremath\Re}%
- \DeclareUnicodeCharacter{2135}{\ensuremath\aleph}%
- \DeclareUnicodeCharacter{2190}{\ensuremath\leftarrow}%
- \DeclareUnicodeCharacter{2191}{\ensuremath\uparrow}%
- \DeclareUnicodeCharacter{2193}{\ensuremath\downarrow}%
- \DeclareUnicodeCharacter{2194}{\ensuremath\leftrightarrow}%
- \DeclareUnicodeCharacter{2195}{\ensuremath\updownarrow}%
- \DeclareUnicodeCharacter{2196}{\ensuremath\nwarrow}%
- \DeclareUnicodeCharacter{2197}{\ensuremath\nearrow}%
- \DeclareUnicodeCharacter{2198}{\ensuremath\searrow}%
- \DeclareUnicodeCharacter{2199}{\ensuremath\swarrow}%
- \DeclareUnicodeCharacter{21A6}{\ensuremath\mapsto}%
- \DeclareUnicodeCharacter{21A9}{\ensuremath\hookleftarrow}%
- \DeclareUnicodeCharacter{21AA}{\ensuremath\hookrightarrow}%
- \DeclareUnicodeCharacter{21BC}{\ensuremath\leftharpoonup}%
- \DeclareUnicodeCharacter{21BD}{\ensuremath\leftharpoondown}%
- \DeclareUnicodeCharacter{21C0}{\ensuremath\rightharpoonup}%
- \DeclareUnicodeCharacter{21C1}{\ensuremath\rightharpoondown}%
- \DeclareUnicodeCharacter{21CC}{\ensuremath\rightleftharpoons}%
- \DeclareUnicodeCharacter{21D0}{\ensuremath\Leftarrow}%
- \DeclareUnicodeCharacter{21D1}{\ensuremath\Uparrow}%
- \DeclareUnicodeCharacter{21D3}{\ensuremath\Downarrow}%
- \DeclareUnicodeCharacter{21D4}{\ensuremath\Leftrightarrow}%
- \DeclareUnicodeCharacter{21D5}{\ensuremath\Updownarrow}%
- \DeclareUnicodeCharacter{2202}{\ensuremath\partial}%
- \DeclareUnicodeCharacter{2205}{\ensuremath\emptyset}%
- \DeclareUnicodeCharacter{2207}{\ensuremath\nabla}%
- \DeclareUnicodeCharacter{2209}{\ensuremath\notin}%
- \DeclareUnicodeCharacter{220B}{\ensuremath\owns}%
- \DeclareUnicodeCharacter{220F}{\ensuremath\prod}%
- \DeclareUnicodeCharacter{2210}{\ensuremath\coprod}%
- \DeclareUnicodeCharacter{2211}{\ensuremath\sum}%
- \DeclareUnicodeCharacter{2213}{\ensuremath\mp}%
- \DeclareUnicodeCharacter{2218}{\ensuremath\circ}%
- \DeclareUnicodeCharacter{221A}{\ensuremath\surd}%
- \DeclareUnicodeCharacter{221D}{\ensuremath\propto}%
- \DeclareUnicodeCharacter{2220}{\ensuremath\angle}%
- \DeclareUnicodeCharacter{2223}{\ensuremath\mid}%
- \DeclareUnicodeCharacter{2228}{\ensuremath\vee}%
- \DeclareUnicodeCharacter{222A}{\ensuremath\cup}%
- \DeclareUnicodeCharacter{222B}{\ensuremath\smallint}%
- \DeclareUnicodeCharacter{222E}{\ensuremath\oint}%
- \DeclareUnicodeCharacter{223C}{\ensuremath\sim}%
- \DeclareUnicodeCharacter{2240}{\ensuremath\wr}%
- \DeclareUnicodeCharacter{2243}{\ensuremath\simeq}%
- \DeclareUnicodeCharacter{2245}{\ensuremath\cong}%
- \DeclareUnicodeCharacter{2248}{\ensuremath\approx}%
- \DeclareUnicodeCharacter{224D}{\ensuremath\asymp}%
- \DeclareUnicodeCharacter{2250}{\ensuremath\doteq}%
- \DeclareUnicodeCharacter{2260}{\ensuremath\neq}%
- \DeclareUnicodeCharacter{226A}{\ensuremath\ll}%
- \DeclareUnicodeCharacter{226B}{\ensuremath\gg}%
- \DeclareUnicodeCharacter{227A}{\ensuremath\prec}%
- \DeclareUnicodeCharacter{227B}{\ensuremath\succ}%
- \DeclareUnicodeCharacter{2283}{\ensuremath\supset}%
- \DeclareUnicodeCharacter{2286}{\ensuremath\subseteq}%
- \DeclareUnicodeCharacter{228E}{\ensuremath\uplus}%
- \DeclareUnicodeCharacter{2291}{\ensuremath\sqsubseteq}%
- \DeclareUnicodeCharacter{2292}{\ensuremath\sqsupseteq}%
- \DeclareUnicodeCharacter{2293}{\ensuremath\sqcap}%
- \DeclareUnicodeCharacter{2294}{\ensuremath\sqcup}%
- \DeclareUnicodeCharacter{2295}{\ensuremath\oplus}%
- \DeclareUnicodeCharacter{2296}{\ensuremath\ominus}%
- \DeclareUnicodeCharacter{2297}{\ensuremath\otimes}%
- \DeclareUnicodeCharacter{2298}{\ensuremath\oslash}%
- \DeclareUnicodeCharacter{2299}{\ensuremath\odot}%
- \DeclareUnicodeCharacter{22A2}{\ensuremath\vdash}%
- \DeclareUnicodeCharacter{22A3}{\ensuremath\dashv}%
- \DeclareUnicodeCharacter{22A4}{\ensuremath\ptextop}%
- \DeclareUnicodeCharacter{22A5}{\ensuremath\bot}%
- \DeclareUnicodeCharacter{22A8}{\ensuremath\models}%
- \DeclareUnicodeCharacter{22C0}{\ensuremath\bigwedge}%
- \DeclareUnicodeCharacter{22C1}{\ensuremath\bigvee}%
- \DeclareUnicodeCharacter{22C2}{\ensuremath\bigcap}%
- \DeclareUnicodeCharacter{22C3}{\ensuremath\bigcup}%
- \DeclareUnicodeCharacter{22C4}{\ensuremath\diamond}%
- \DeclareUnicodeCharacter{22C5}{\ensuremath\cdot}%
- \DeclareUnicodeCharacter{22C6}{\ensuremath\star}%
- \DeclareUnicodeCharacter{22C8}{\ensuremath\bowtie}%
- \DeclareUnicodeCharacter{2308}{\ensuremath\lceil}%
- \DeclareUnicodeCharacter{2309}{\ensuremath\rceil}%
- \DeclareUnicodeCharacter{230A}{\ensuremath\lfloor}%
- \DeclareUnicodeCharacter{230B}{\ensuremath\rfloor}%
- \DeclareUnicodeCharacter{2322}{\ensuremath\frown}%
- \DeclareUnicodeCharacter{2323}{\ensuremath\smile}%
- %
- \DeclareUnicodeCharacter{25B3}{\ensuremath\triangle}%
- \DeclareUnicodeCharacter{25B7}{\ensuremath\triangleright}%
- \DeclareUnicodeCharacter{25BD}{\ensuremath\bigtriangledown}%
- \DeclareUnicodeCharacter{25C1}{\ensuremath\triangleleft}%
- \DeclareUnicodeCharacter{25C7}{\ensuremath\diamond}%
- \DeclareUnicodeCharacter{2660}{\ensuremath\spadesuit}%
- \DeclareUnicodeCharacter{2661}{\ensuremath\heartsuit}%
- \DeclareUnicodeCharacter{2662}{\ensuremath\diamondsuit}%
- \DeclareUnicodeCharacter{2663}{\ensuremath\clubsuit}%
- \DeclareUnicodeCharacter{266D}{\ensuremath\flat}%
- \DeclareUnicodeCharacter{266E}{\ensuremath\natural}%
- \DeclareUnicodeCharacter{266F}{\ensuremath\sharp}%
- \DeclareUnicodeCharacter{26AA}{\ensuremath\bigcirc}%
- \DeclareUnicodeCharacter{27B9}{\ensuremath\rangle}%
- \DeclareUnicodeCharacter{27C2}{\ensuremath\perp}%
- \DeclareUnicodeCharacter{27E8}{\ensuremath\langle}%
- \DeclareUnicodeCharacter{27F5}{\ensuremath\longleftarrow}%
- \DeclareUnicodeCharacter{27F6}{\ensuremath\longrightarrow}%
- \DeclareUnicodeCharacter{27F7}{\ensuremath\longleftrightarrow}%
- \DeclareUnicodeCharacter{27FC}{\ensuremath\longmapsto}%
- \DeclareUnicodeCharacter{29F5}{\ensuremath\setminus}%
- \DeclareUnicodeCharacter{2A00}{\ensuremath\bigodot}%
- \DeclareUnicodeCharacter{2A01}{\ensuremath\bigoplus}%
- \DeclareUnicodeCharacter{2A02}{\ensuremath\bigotimes}%
- \DeclareUnicodeCharacter{2A04}{\ensuremath\biguplus}%
- \DeclareUnicodeCharacter{2A06}{\ensuremath\bigsqcup}%
- \DeclareUnicodeCharacter{2A3F}{\ensuremath\amalg}%
- \DeclareUnicodeCharacter{2AAF}{\ensuremath\preceq}%
- \DeclareUnicodeCharacter{2AB0}{\ensuremath\succeq}%
- %
- \global\mathchardef\checkmark="1370% actually the square root sign
- \DeclareUnicodeCharacter{2713}{\ensuremath\checkmark}%
-}% end of \unicodechardefs
-
-% UTF-8 byte sequence (pdfTeX) definitions (replacing and @U command)
-% It makes the setting that replace UTF-8 byte sequence.
-\def\utfeightchardefs{%
- \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterUTFviii
- \unicodechardefs
-}
-
-% Whether the active definitions of non-ASCII characters expand to
-% non-active tokens with the same character code. This is used to
-% write characters literally, instead of using active definitions for
-% printing the correct glyphs.
-\newif\ifpassthroughchars
-\passthroughcharsfalse
-
-% For native Unicode handling (XeTeX and LuaTeX),
-% provide a definition macro to replace/pass-through a Unicode character
-%
-\def\DeclareUnicodeCharacterNative#1#2{%
- \catcode"#1=\active
- \def\dodeclareunicodecharacternative##1##2##3{%
- \begingroup
- \uccode`\~="##2\relax
- \uppercase{\gdef~}{%
- \ifpassthroughchars
- ##1%
- \else
- ##3%
- \fi
- }
- \endgroup
- }
- \begingroup
- \uccode`\.="#1\relax
- \uppercase{\def\UTFNativeTmp{.}}%
- \expandafter\dodeclareunicodecharacternative\UTFNativeTmp{#1}{#2}%
- \endgroup
-}
-
-% Native Unicode handling (XeTeX and LuaTeX) character replacing definition.
-% It activates the setting that replaces Unicode characters.
-\def\nativeunicodechardefs{%
- \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNative
- \unicodechardefs
-}
-
-% For native Unicode handling (XeTeX and LuaTeX),
-% make the character token expand
-% to the sequences given in \unicodechardefs for printing.
-\def\DeclareUnicodeCharacterNativeAtU#1#2{%
- \def\UTFAtUTmp{#2}
- \expandafter\globallet\csname uni:#1\endcsname \UTFAtUTmp
-}
-
-% @U command definitions for native Unicode handling (XeTeX and LuaTeX).
-\def\nativeunicodechardefsatu{%
- \let\DeclareUnicodeCharacter\DeclareUnicodeCharacterNativeAtU
- \unicodechardefs
-}
-
-% US-ASCII character definitions.
-\def\asciichardefs{% nothing need be done
- \relax
-}
-
-% Define all Unicode characters we know about. This makes UTF-8 the default
-% input encoding and allows @U to work.
-\iftxinativeunicodecapable
- \nativeunicodechardefsatu
-\else
- \utfeightchardefs
-\fi
-
-\message{formatting,}
-
-\newdimen\defaultparindent \defaultparindent = 15pt
-
-\chapheadingskip = 15pt plus 4pt minus 2pt
-\secheadingskip = 12pt plus 3pt minus 2pt
-\subsecheadingskip = 9pt plus 2pt minus 2pt
-
-% Prevent underfull vbox error messages.
-\vbadness = 10000
-
-% Don't be very finicky about underfull hboxes, either.
-\hbadness = 6666
-
-% Following George Bush, get rid of widows and orphans.
-\widowpenalty=10000
-\clubpenalty=10000
-
-% Use TeX 3.0's \emergencystretch to help line breaking, but if we're
-% using an old version of TeX, don't do anything. We want the amount of
-% stretch added to depend on the line length, hence the dependence on
-% \hsize. We call this whenever the paper size is set.
-%
-\def\setemergencystretch{%
- \ifx\emergencystretch\thisisundefined
- % Allow us to assign to \emergencystretch anyway.
- \def\emergencystretch{\dimen0}%
- \else
- \emergencystretch = .15\hsize
- \fi
-}
-
-% Parameters in order: 1) textheight; 2) textwidth;
-% 3) voffset; 4) hoffset; 5) binding offset; 6) topskip;
-% 7) physical page height; 8) physical page width.
-%
-% We also call \setleading{\textleading}, so the caller should define
-% \textleading. The caller should also set \parskip.
-%
-\def\internalpagesizes#1#2#3#4#5#6#7#8{%
- \voffset = #3\relax
- \topskip = #6\relax
- \splittopskip = \topskip
- %
- \vsize = #1\relax
- \advance\vsize by \topskip
- \outervsize = \vsize
- \advance\outervsize by 2\topandbottommargin
- \txipageheight = \vsize
- %
- \hsize = #2\relax
- \outerhsize = \hsize
- \advance\outerhsize by 0.5in
- \txipagewidth = \hsize
- %
- \normaloffset = #4\relax
- \bindingoffset = #5\relax
- %
- \ifpdf
- \pdfpageheight #7\relax
- \pdfpagewidth #8\relax
- % if we don't reset these, they will remain at "1 true in" of
- % whatever layout pdftex was dumped with.
- \pdfhorigin = 1 true in
- \pdfvorigin = 1 true in
- \else
- \ifx\XeTeXrevision\thisisundefined
- \special{papersize=#8,#7}%
- \else
- \pdfpageheight #7\relax
- \pdfpagewidth #8\relax
- % XeTeX does not have \pdfhorigin and \pdfvorigin.
- \fi
- \fi
- %
- \setleading{\textleading}
- %
- \parindent = \defaultparindent
- \setemergencystretch
-}
-
-% @letterpaper (the default).
-\def\letterpaper{{\globaldefs = 1
- \parskip = 3pt plus 2pt minus 1pt
- \textleading = 13.2pt
- %
- % If page is nothing but text, make it come out even.
- \internalpagesizes{607.2pt}{6in}% that's 46 lines
- {\voffset}{.25in}%
- {\bindingoffset}{36pt}%
- {11in}{8.5in}%
-}}
-
-% Use @smallbook to reset parameters for 7x9.25 trim size.
-\def\smallbook{{\globaldefs = 1
- \parskip = 2pt plus 1pt
- \textleading = 12pt
- %
- \internalpagesizes{7.5in}{5in}%
- {-.2in}{0in}%
- {\bindingoffset}{16pt}%
- {9.25in}{7in}%
- %
- \lispnarrowing = 0.3in
- \tolerance = 700
- \contentsrightmargin = 0pt
- \defbodyindent = .5cm
-}}
-
-% Use @smallerbook to reset parameters for 6x9 trim size.
-% (Just testing, parameters still in flux.)
-\def\smallerbook{{\globaldefs = 1
- \parskip = 1.5pt plus 1pt
- \textleading = 12pt
- %
- \internalpagesizes{7.4in}{4.8in}%
- {-.2in}{-.4in}%
- {0pt}{14pt}%
- {9in}{6in}%
- %
- \lispnarrowing = 0.25in
- \tolerance = 700
- \contentsrightmargin = 0pt
- \defbodyindent = .4cm
-}}
-
-% Use @afourpaper to print on European A4 paper.
-\def\afourpaper{{\globaldefs = 1
- \parskip = 3pt plus 2pt minus 1pt
- \textleading = 13.2pt
- %
- % Double-side printing via postscript on Laserjet 4050
- % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm.
- % To change the settings for a different printer or situation, adjust
- % \normaloffset until the front-side and back-side texts align. Then
- % do the same for \bindingoffset. You can set these for testing in
- % your texinfo source file like this:
- % @tex
- % \global\normaloffset = -6mm
- % \global\bindingoffset = 10mm
- % @end tex
- \internalpagesizes{673.2pt}{160mm}% that's 51 lines
- {\voffset}{\hoffset}%
- {\bindingoffset}{44pt}%
- {297mm}{210mm}%
- %
- \tolerance = 700
- \contentsrightmargin = 0pt
- \defbodyindent = 5mm
-}}
-
-% Use @afivepaper to print on European A5 paper.
-% From romildo@urano.iceb.ufop.br, 2 July 2000.
-% He also recommends making @example and @lisp be small.
-\def\afivepaper{{\globaldefs = 1
- \parskip = 2pt plus 1pt minus 0.1pt
- \textleading = 12.5pt
- %
- \internalpagesizes{160mm}{120mm}%
- {\voffset}{\hoffset}%
- {\bindingoffset}{8pt}%
- {210mm}{148mm}%
- %
- \lispnarrowing = 0.2in
- \tolerance = 800
- \contentsrightmargin = 0pt
- \defbodyindent = 2mm
- \tableindent = 12mm
-}}
-
-% A specific text layout, 24x15cm overall, intended for A4 paper.
-\def\afourlatex{{\globaldefs = 1
- \afourpaper
- \internalpagesizes{237mm}{150mm}%
- {\voffset}{4.6mm}%
- {\bindingoffset}{7mm}%
- {297mm}{210mm}%
- %
- % Must explicitly reset to 0 because we call \afourpaper.
- \globaldefs = 0
-}}
-
-% Use @afourwide to print on A4 paper in landscape format.
-\def\afourwide{{\globaldefs = 1
- \afourpaper
- \internalpagesizes{241mm}{165mm}%
- {\voffset}{-2.95mm}%
- {\bindingoffset}{7mm}%
- {297mm}{210mm}%
- \globaldefs = 0
-}}
-
-% @pagesizes TEXTHEIGHT[,TEXTWIDTH]
-% Perhaps we should allow setting the margins, \topskip, \parskip,
-% and/or leading, also. Or perhaps we should compute them somehow.
-%
-\parseargdef\pagesizes{\pagesizesyyy #1,,\finish}
-\def\pagesizesyyy#1,#2,#3\finish{{%
- \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi
- \globaldefs = 1
- %
- \parskip = 3pt plus 2pt minus 1pt
- \setleading{\textleading}%
- %
- \dimen0 = #1\relax
- \advance\dimen0 by \voffset
- \advance\dimen0 by 1in % reference point for DVI is 1 inch from top of page
- %
- \dimen2 = \hsize
- \advance\dimen2 by \normaloffset
- \advance\dimen2 by 1in % reference point is 1 inch from left edge of page
- %
- \internalpagesizes{#1}{\hsize}%
- {\voffset}{\normaloffset}%
- {\bindingoffset}{44pt}%
- {\dimen0}{\dimen2}%
-}}
-
-% Set default to letter.
-%
-\letterpaper
-
-% Default value of \hfuzz, for suppressing warnings about overfull hboxes.
-\hfuzz = 1pt
-
-
-\message{and turning on texinfo input format.}
-
-\def^^L{\par} % remove \outer, so ^L can appear in an @comment
-
-% DEL is a comment character, in case @c does not suffice.
-\catcode`\^^? = 14
-
-% Define macros to output various characters with catcode for normal text.
-\catcode`\"=\other \def\normaldoublequote{"}
-\catcode`\$=\other \def\normaldollar{$}%$ font-lock fix
-\catcode`\+=\other \def\normalplus{+}
-\catcode`\<=\other \def\normalless{<}
-\catcode`\>=\other \def\normalgreater{>}
-\catcode`\^=\other \def\normalcaret{^}
-\catcode`\_=\other \def\normalunderscore{_}
-\catcode`\|=\other \def\normalverticalbar{|}
-\catcode`\~=\other \def\normaltilde{~}
-
-% This macro is used to make a character print one way in \tt
-% (where it can probably be output as-is), and another way in other fonts,
-% where something hairier probably needs to be done.
-%
-% #1 is what to print if we are indeed using \tt; #2 is what to print
-% otherwise. Since all the Computer Modern typewriter fonts have zero
-% interword stretch (and shrink), and it is reasonable to expect all
-% typewriter fonts to have this, we can check that font parameter.
-%
-\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi}
-
-% Same as above, but check for italic font. Actually this also catches
-% non-italic slanted fonts since it is impossible to distinguish them from
-% italic fonts. But since this is only used by $ and it uses \sl anyway
-% this is not a problem.
-\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi}
-
-% Set catcodes for Texinfo file
-
-% Active characters for printing the wanted glyph.
-% Most of these we simply print from the \tt font, but for some, we can
-% use math or other variants that look better in normal text.
-%
-\catcode`\"=\active
-\def\activedoublequote{{\tt\char34}}
-\let"=\activedoublequote
-\catcode`\~=\active \def\activetilde{{\tt\char126}} \let~ = \activetilde
-\chardef\hatchar=`\^
-\catcode`\^=\active \def\activehat{{\tt \hatchar}} \let^ = \activehat
-
-\catcode`\_=\active
-\def_{\ifusingtt\normalunderscore\_}
-\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em }
-\let\realunder=_
-
-\catcode`\|=\active \def|{{\tt\char124}}
-
-\chardef \less=`\<
-\catcode`\<=\active \def\activeless{{\tt \less}}\let< = \activeless
-\chardef \gtr=`\>
-\catcode`\>=\active \def\activegtr{{\tt \gtr}}\let> = \activegtr
-\catcode`\+=\active \def+{{\tt \char 43}}
-\catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix
-\catcode`\-=\active \let-=\normaldash
-
-
-% used for headline/footline in the output routine, in case the page
-% breaks in the middle of an @tex block.
-\def\texinfochars{%
- \let< = \activeless
- \let> = \activegtr
- \let~ = \activetilde
- \let^ = \activehat
- \markupsetuplqdefault \markupsetuprqdefault
- \let\b = \strong
- \let\i = \smartitalic
- % in principle, all other definitions in \tex have to be undone too.
-}
-
-% Used sometimes to turn off (effectively) the active characters even after
-% parsing them.
-\def\turnoffactive{%
- \normalturnoffactive
- \otherbackslash
-}
-
-\catcode`\@=0
-
-% \backslashcurfont outputs one backslash character in current font,
-% as in \char`\\.
-\global\chardef\backslashcurfont=`\\
-
-% \realbackslash is an actual character `\' with catcode other.
-{\catcode`\\=\other @gdef@realbackslash{\}}
-
-% In Texinfo, backslash is an active character; it prints the backslash
-% in fixed width font.
-\catcode`\\=\active % @ for escape char from now on.
-
-% Print a typewriter backslash. For math mode, we can't simply use
-% \backslashcurfont: the story here is that in math mode, the \char
-% of \backslashcurfont ends up printing the roman \ from the math symbol
-% font (because \char in math mode uses the \mathcode, and plain.tex
-% sets \mathcode`\\="026E). Hence we use an explicit \mathchar,
-% which is the decimal equivalent of "715c (class 7, e.g., use \fam;
-% ignored family value; char position "5C). We can't use " for the
-% usual hex value because it has already been made active.
-
-@def@ttbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}}
-@let@backslashchar = @ttbackslash % @backslashchar{} is for user documents.
-
-% \otherbackslash defines an active \ to be a literal `\' character with
-% catcode other.
-@gdef@otherbackslash{@let\=@realbackslash}
-
-% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of
-% the literal character `\'.
-%
-{@catcode`- = @active
- @gdef@normalturnoffactive{%
- @passthroughcharstrue
- @let-=@normaldash
- @let"=@normaldoublequote
- @let$=@normaldollar %$ font-lock fix
- @let+=@normalplus
- @let<=@normalless
- @let>=@normalgreater
- @let^=@normalcaret
- @let_=@normalunderscore
- @let|=@normalverticalbar
- @let~=@normaltilde
- @let\=@ttbackslash
- @markupsetuplqdefault
- @markupsetuprqdefault
- @unsepspaces
- }
-}
-
-% If a .fmt file is being used, characters that might appear in a file
-% name cannot be active until we have parsed the command line.
-% So turn them off again, and have @fixbackslash turn them back on.
-@catcode`+=@other @catcode`@_=@other
-
-% \enablebackslashhack - allow file to begin `\input texinfo'
-%
-% If a .fmt file is being used, we don't want the `\input texinfo' to show up.
-% That is what \eatinput is for; after that, the `\' should revert to printing
-% a backslash.
-% If the file did not have a `\input texinfo', then it is turned off after
-% the first line; otherwise the first `\' in the file would cause an error.
-% This is used on the very last line of this file, texinfo.tex.
-% We also use @c to call @fixbackslash, in case ends of lines are hidden.
-{
-@catcode`@^=7
-@catcode`@^^M=13@gdef@enablebackslashhack{%
- @global@let\ = @eatinput%
- @catcode`@^^M=13%
- @def@c{@fixbackslash@c}%
- % Definition for the newline at the end of this file.
- @def ^^M{@let^^M@secondlinenl}%
- % Definition for a newline in the main Texinfo file.
- @gdef @secondlinenl{@fixbackslash}%
- % In case the first line has a whole-line command on it
- @let@originalparsearg@parsearg
- @def@parsearg{@fixbackslash@originalparsearg}
-}}
-
-{@catcode`@^=7 @catcode`@^^M=13%
-@gdef@eatinput input texinfo#1^^M{@fixbackslash}}
-
-% Emergency active definition of newline, in case an active newline token
-% appears by mistake.
-{@catcode`@^=7 @catcode13=13%
-@gdef@enableemergencynewline{%
- @gdef^^M{%
- @par%
- %<warning: active newline>@par%
-}}}
-
-
-@gdef@fixbackslash{%
- @ifx\@eatinput @let\ = @ttbackslash @fi
- @catcode13=5 % regular end of line
- @enableemergencynewline
- @let@c=@comment
- @let@parsearg@originalparsearg
- % Also turn back on active characters that might appear in the input
- % file name, in case not using a pre-dumped format.
- @catcode`+=@active
- @catcode`@_=@active
- %
- % If texinfo.cnf is present on the system, read it.
- % Useful for site-wide @afourpaper, etc. This macro, @fixbackslash, gets
- % called at the beginning of every Texinfo file. Not opening texinfo.cnf
- % directly in this file, texinfo.tex, makes it possible to make a format
- % file for Texinfo.
- %
- @openin 1 texinfo.cnf
- @ifeof 1 @else @input texinfo.cnf @fi
- @closein 1
-}
-
-
-% Say @foo, not \foo, in error messages.
-@escapechar = `@@
-
-% These (along with & and #) are made active for url-breaking, so need
-% active definitions as the normal characters.
-@def@normaldot{.}
-@def@normalquest{?}
-@def@normalslash{/}
-
-% These look ok in all fonts, so just make them not special.
-% @hashchar{} gets its own user-level command, because of #line.
-@catcode`@& = @other @def@normalamp{&}
-@catcode`@# = @other @def@normalhash{#}
-@catcode`@% = @other @def@normalpercent{%}
-
-@let @hashchar = @normalhash
-
-@c Finally, make ` and ' active, so that txicodequoteundirected and
-@c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we
-@c don't make ` and ' active, @code will not get them as active chars.
-@c Do this last of all since we use ` in the previous @catcode assignments.
-@catcode`@'=@active
-@catcode`@`=@active
-@markupsetuplqdefault
-@markupsetuprqdefault
-
-@c Local variables:
-@c eval: (add-hook 'before-save-hook 'time-stamp)
-@c page-delimiter: "^\\\\message\\|emacs-page"
-@c time-stamp-start: "def\\\\texinfoversion{"
-@c time-stamp-format: "%:y-%02m-%02d.%02H"
-@c time-stamp-end: "}"
-@c End:
-
-@c vim:sw=2:
-
-@enablebackslashhack
diff --git a/configure.ac b/configure.ac
deleted file mode 100644
index 2bab5cc..0000000
--- a/configure.ac
+++ /dev/null
@@ -1,35 +0,0 @@
-
-dnl -*- Autoconf -*-
-
-AC_INIT(guile-eris, 0.2.0)
-AC_SUBST(HVERSION, "\"0.2.0\"")
-AC_SUBST(AUTHOR, "\"pukkamustard\"")
-AC_SUBST(COPYRIGHT, "'(2020)")
-AC_SUBST(LICENSE, gpl3+)
-AC_CONFIG_SRCDIR(eris.scm)
-AC_CONFIG_AUX_DIR([build-aux])
-AM_INIT_AUTOMAKE([1.12 gnu silent-rules subdir-objects color-tests parallel-tests -Woverride -Wno-portability])
-AM_SILENT_RULES([yes])
-
-AC_CONFIG_FILES([Makefile])
-AC_CONFIG_FILES([pre-inst-env], [chmod +x pre-inst-env])
-
-dnl Search for 'guile' and 'guild'. This macro defines
-dnl 'GUILE_EFFECTIVE_VERSION'.
-GUILE_PKG([3.0 2.2 2.0])
-GUILE_PROGS
-GUILE_SITE_DIR
-if test "x$GUILD" = "x"; then
- AC_MSG_ERROR(['guild' binary not found; please check your guile-2.x installation.])
-fi
-
-dnl Hall auto-generated guile-module dependencies
-
-
-dnl Installation directories for .scm and .go files.
-guilemoduledir="${datarootdir}/guile/site/$GUILE_EFFECTIVE_VERSION"
-guileobjectdir="${libdir}/guile/$GUILE_EFFECTIVE_VERSION/site-ccache"
-AC_SUBST([guilemoduledir])
-AC_SUBST([guileobjectdir])
-
-AC_OUTPUT
diff --git a/eris.scm b/eris.scm
deleted file mode 100644
index 49e8d0c..0000000
--- a/eris.scm
+++ /dev/null
@@ -1,114 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (eris)
- #:use-module (eris read-capability)
- #:use-module (eris encode)
- #:use-module (eris decode)
- #:use-module (eris utils rbytevector)
-
- #:use-module (srfi srfi-11)
- #:use-module (srfi srfi-171)
- #:use-module (rnrs bytevectors)
- #:use-module (rnrs io ports)
-
- #:export (eris-block-size-small
- eris-block-size-large
-
- eris-encode
- eris-encode->urn
-
- eris-decode->bytevector))
-
-(define eris-block-size-small 1024)
-(define eris-block-size-large 32768)
-
-(define null-convergence-secret (make-bytevector 32 0))
-
-(define (tstore-blocks block-reducer)
- "Returns a transducer that reduces blocks into @code{block-reducer} and emits a
-single pair consisting of the reduced blocks and the read capability"
- (lambda (reducer)
- (let ((read-capability #f)
- (blocks (block-reducer)))
- (case-lambda
-
- ;; identity
- (() (reducer))
-
- ;; completion - cons the blocks and read-capability
- ((result)
- (reducer (reducer result (cons read-capability
- ;; call the completion arity on the block reducer
- (block-reducer blocks)))))
-
- ;; on input
- ((result input)
- (cond
-
- ;; input is a block
- ((pair? input)
- ;; reduce block with block reducer
- (set! blocks (block-reducer blocks input))
- result)
-
- ;; input is the read-capability
- ((read-capability? input)
- (set! read-capability input)
- result)))))))
-
-(define* (rlast #:key (default #f))
- "Returns a reducer that returns the last reduced value or the default value if no values are reduced."
- (case-lambda
- (() default)
- ((result) result)
- ((result input) input)))
-
-(define (->port readable)
- "Helper to read content as port"
- (cond
- ((port? readable) readable)
- ((bytevector? readable) (open-bytevector-input-port readable))
- ((string? readable) (->port (string->utf8 readable)))))
-
-;; Higher-level interfaces for encoding
-
-(define* (eris-encode readable #:key
- (block-reducer rcons)
- (convergence-secret null-convergence-secret)
- (block-size eris-block-size-small))
- "Encode content from a port and reduce blocks into @code{bock-reducer}. Returns the read capability and reduced blocks."
- (let ((read-capability-blocks
- (port-transduce
- (compose (eris-encode-transducer #:convergence-secret convergence-secret
- #:block-size block-size)
- (tstore-blocks block-reducer))
- (rlast)
- (lambda (port) (get-bytevector-n port block-size))
- (->port readable))))
- (values (car read-capability-blocks)
- (cdr read-capability-blocks))))
-
-(define* (eris-encode->urn readable #:key
- (convergence-secret null-convergence-secret)
- (block-size eris-block-size-small))
- "Encode content, discard blocks and return the read capability as URN. This is useful for verifying that content is properly encoded."
- (let-values (((read-capability block-count)
- (eris-encode readable #:convergence-secret convergence-secret
- #:block-size block-size
- #:block-reducer rcount)))
- (read-capability->string read-capability)))
-
-(let-values
- (((read-capability blocks) (eris-encode (open-bytevector-input-port (string->utf8 "Hello world!")))))
- (eris-decode->bytevector (read-capability->string read-capability)
- (lambda (ref) (assoc-ref blocks ref))))
-
-(define (eris-decode->bytevector read-capability block-ref)
- "Decode ERIS encoded content into a bytevector."
- (eris-transduce
- (tmap identity)
- (rbytevector)
- #:block-ref block-ref
- #:read-capability (->read-capability read-capability)))
diff --git a/eris/decode.scm b/eris/decode.scm
deleted file mode 100644
index 0f8ddaf..0000000
--- a/eris/decode.scm
+++ /dev/null
@@ -1,66 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (eris decode)
- #:use-module (eris read-capability)
- #:use-module (eris utils padding)
-
- #:use-module (sodium stream)
-
- #:use-module (rnrs bytevectors)
- #:use-module (rnrs io ports)
-
- #:use-module (srfi srfi-9)
- #:use-module (srfi srfi-11)
- #:use-module (srfi srfi-171)
- #:use-module (srfi srfi-171 meta)
- #:export (eris-transduce))
-
-
-(define null-nonce (make-bytevector 12 0))
-
-(define null-ref
- (make-bytevector 32 0))
-
-(define (null-ref? bv)
- (bytevector=? bv null-ref))
-
-(define (tree-reduce reducer init ref key level block-ref)
- (let
- ;; get block and decrypt
- ((block (crypto-stream-chacha20-ietf-xor #:message (block-ref ref) #:nonce null-nonce #:key key)))
-
- (if (= 0 level)
- ;; if ref-key is at level 0 then the block is a data block, reduce
- (reducer init block)
-
- ;; recursively transduce over the reference key pairs in node
- (port-reduce
- ;; reducer passed to port-reduce is the recursive call to tree-reduce
- (lambda (result ref-key) (tree-reduce reducer result (car ref-key) (cdr ref-key) (1- level) block-ref))
- init
- ;; read reference-key pairs
- (lambda (port)
- (let ((ref (get-bytevector-n port 32))
- (key (get-bytevector-n port 32)))
- (if (or (eof-object? ref) (eof-object? key) (null-ref? ref))
- (eof-object)
- (cons ref key))))
- ;; open the block as a port for reading
- (open-bytevector-input-port block)))))
-
-(define (tree-transduce xform f init read-capability block-ref)
- (let* ((xf (xform f))
- (result (tree-reduce xf init
- (read-capability-root-reference read-capability)
- (read-capability-root-key read-capability)
- (read-capability-level read-capability)
- block-ref)))
- (xf result)))
-
-(define* (eris-transduce xform f #:key block-ref read-capability)
- (tree-transduce
- (compose (tunpad (read-capability-block-size read-capability)) xform)
- f (f)
- read-capability block-ref))
diff --git a/eris/encode.scm b/eris/encode.scm
deleted file mode 100644
index 87ed957..0000000
--- a/eris/encode.scm
+++ /dev/null
@@ -1,220 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (eris encode)
- #:use-module (rnrs bytevectors)
- #:use-module (rnrs io ports)
-
- #:use-module (eris read-capability)
-
- #:use-module (eris utils rbytevector)
- #:use-module (eris utils padding)
-
- #:use-module (sodium generichash)
- #:use-module (sodium padding)
- #:use-module (sodium stream)
-
- #:use-module (srfi srfi-1)
- #:use-module (srfi srfi-9)
- #:use-module (srfi srfi-11)
- #:use-module (srfi srfi-171)
-
- #:export (eris-encode-transducer))
-
-;; ERIS-x2 Encoding
-
-;; Encrypting blocks
-;;
-;; This is all the required cryptography.
-
-(define null-nonce (make-bytevector 12 0))
-
-(define (unencrypted-block->brk unencrypted-block convergence-secret)
- "Takes an unencrypted block and returns the encrypted *B*lock, *R*eference to the encrypted content and the encryption *K*ey (hash of unencrypted content)."
- (let* ( ;; key is the hash of the block with convergence-secret
- (key (crypto-generichash unencrypted-block #:key convergence-secret #:out-len 32))
- ;; encrypt the content (using the null-nonce)
- (block (crypto-stream-chacha20-ietf-xor #:message unencrypted-block #:nonce null-nonce #:key key))
- ;; hash to reference the encrypted block. Note that this does not use
- ;; the convergence secret.
- (ref (crypto-generichash block #:out-len 32)))
- (values block ref key)))
-
-
-;; Encoder state and helpers
-
-(define-record-type <encoder-state>
- (%make-encoder-state levels arity convergence-secret)
- encoder-state?
- (levels encoder-state-levels)
- (arity encoder-state-arity)
- (convergence-secret encoder-state-convergence-secret))
-
-(define (encoder-init-state arity convergence-secret)
- "Initialize the encoder state"
- (%make-encoder-state
- (make-hash-table)
- arity convergence-secret))
-
-(define (encoder-get-level state level)
- "Returns all the ref-key pairs at level. Note that the order is reversed."
- (hash-ref (encoder-state-levels state) level '()))
-
-(define (encoder-get-top-level state)
- "Returns the maximum level number containing a reference-key pair"
- (hash-fold (lambda (key value acc)
- (max acc key))
- 0
- (encoder-state-levels state)))
-
-(define (encoder-clear-level! state level)
- "Clears the reference-key pairs in a level."
- (hash-remove! (encoder-state-levels state) level))
-
-(define (encoder-add-rk-to-level state level rk)
- "Add a ref-key pair to level"
- (hash-set! (encoder-state-levels state)
- level (cons rk (encoder-get-level state level))))
-
-(define (encoder-make-tree-node rks arity)
- "Pack a list of ref-key pairs into a Merkle Tree node"
- ;; this might be a bit too much SRFI-171...
- (list-transduce tflatten
- (rbytevector)
- (append
- ;; rks is a list of pairs, but we need a list of lists...
- (map (lambda (rk) (list (car rk) (cdr rk))) rks)
- ;; add null padding to reach block-size (which is (* 32 2 arity))
- (list (make-bytevector (* 64 (- arity (length rks))) 0)))))
-
-;; * Encoding Algorithm
-;;
-;; The encoding builds up a tree of reference-key pairs by maintaining a
-;; hash-table from level to list of reference-key pairs.
-;;
-;; There are three stages in the Encoding Algorithm:
-;;
-;; ** Handling new data block
-;;
-;; When a new data block is received it is encrypted using `unencrypted-block->brk` into:
-;;
-;; - the encrypted block (simply called `block`)
-;; - a reference to the encrypted block (`reference`)
-;; - the key to decrypt the encrypted block (`key`)
-;;
-;; The encrypted block is immediately emitted.
-;;
-;; The reference and key is stored at level 0 (as reference-key pair).
-;;
-;; ** Collect
-;;
-;; After adding a reference-key pair for the new data-block the
-;; recursive `encoder-collect` process is run starting at level 0.
-;;
-;; At the given level the `encoder-collect` process checks if the number of
-;; reference-key pairs has reached the arity of the tree.
-;;
-;; If the arity is reached, then all reference-key pairs are collected into a
-;; new node and encrypted using `unencrypted-block->brk` (see `encoder-force-collect`).
-;; The encrypted block is immediately emmited and the reference-key pair is
-;; stored at the level above (+1 level). The level is cleared, meaning all
-;; reference-key pairs that are now collected in a node in the level above are
-;; forgotten.
-;;
-;; The `encoder-collect` process is run recursively on the level above.
-;;
-;; ** Finalize
-;;
-;; The `encoder-finalize` process is run after all data blocks have been
-;; processed in order to get a single root reference-key pair.
-;;
-
-(define (encoder-force-collect state level)
- "Force the combination of all rk pairs at level to a node at level above"
- (let-values (((block reference key) (unencrypted-block->brk
- (encoder-make-tree-node
- ;; get the ref-key pairs for level. Order needs to be reversed.
- (reverse (encoder-get-level state level))
- (encoder-state-arity state))
- (encoder-state-convergence-secret state))))
-
- ;; clear the level
- (encoder-clear-level! state level)
-
- ;; add the ref-key pair to the next level
- (encoder-add-rk-to-level state (1+ level) (cons reference key))
-
- ;; return the block-reference-key triple
- (values block reference)))
-
-(define (encoder-collect state level reducer result)
- "Recursively collect all ref-key pairs at a level to a node at the level above if the arity is reached. Returns a list of reference-block pairs of newly created blocks."
- (if (<= (encoder-state-arity state) (length (encoder-get-level state level)))
- ;; level is full, collect all reference-key pairs to a node in the level above
- (let-values (((block reference) (encoder-force-collect state level)))
- ;; recursively collect at the next level
- (encoder-collect state (1+ level)
- reducer
- ;; add the newly created block (node in level (1+ level)) to the list of block created in this collect phase
- (reducer result (cons reference block))))
-
- ;; nothing to do, return the collected output
- result))
-
-(define (encoder-finalize state level reducer result)
- "Recursively collects all ref-key pairs to a single root reference"
- (cond
- ;; current level is top level and has exactly one node - our root reference
- ((and (= level (encoder-get-top-level state))
- (= (length (encoder-get-level state level)) 1))
- (let ((root-ref-key (car (encoder-get-level state level))))
- (reducer result (make-read-capability
- (* (encoder-state-arity state) 64)
- level
- (car root-ref-key)
- (cdr root-ref-key)))))
-
- ;; level is not empty
- ((< 0 (length (encoder-get-level state level)))
- ;; collect all ref-key pairs at level
- (let-values (((block reference) (encoder-force-collect state level)))
- ;; continue finalizing at level above
- (encoder-finalize state (1+ level) reducer
- (reducer result (cons reference block)))))
-
- ;; level is empty
- ((null? (encoder-get-level state level))
- ;; continue finalizing at level above
- (encoder-finalize state (1+ level) reducer result))))
-
-(define (tbuild-tree arity convergence-secret)
- "Returns a transducer that builds the ERIS-x2 Merkle Tree. Stateful."
- (lambda (reducer)
- (let ((state (encoder-init-state arity convergence-secret)))
- (case-lambda
-
- ;; identity
- (() (reducer))
-
- ;; completion - finalize the tree by collecting all levels to a single root
- ((result)
- (reducer (encoder-finalize state 0 reducer result)))
-
- ;; handle a data-block
- ((result data-block)
- ;; encrypt data-block
- (let-values (((block reference key) (unencrypted-block->brk data-block convergence-secret)))
- ;; add reference to encrypted data block to level 0 of the tree
- (encoder-add-rk-to-level state 0 (cons reference key))
- ;; reduce newly created reference-block pairs
- (encoder-collect state 0 reducer
- ;; reduce the new block
- (reducer result (cons reference block)))))))))
-
-(define* (eris-encode-transducer #:key convergence-secret block-size)
- "Returns a transducer that takes bytevectors of size block-size (last bytevector may be smaller and will be padded) and encodes the content using ERISx2."
- (let ((arity (/ block-size 64)))
- (compose (tpad block-size)
- (tbuild-tree arity convergence-secret))))
-
diff --git a/eris/ipfs.scm b/eris/ipfs.scm
deleted file mode 100644
index 498dc89..0000000
--- a/eris/ipfs.scm
+++ /dev/null
@@ -1,163 +0,0 @@
-; SPDX-FileCopyrightText: 2021 pukkamustard <pukkamustard@posteo.net>
-; Copyright © 2018 Ludovic Courtès <ludo@gnu.org>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-;; This module provides an interface to the IPFS daemons HTTP API for storing
-;; and retrieving blocks. This can be used to store blocks of ERIS encoded content.
-;;
-;; See also the IPFS API documentation:
-;; https://docs.ipfs.io/reference/http/api/#api-v0-block-put
-;;
-;; Parts are taken from guix/ipfs.scm in the wip-ipfs-substitutes branch of the
-;; GNU Guix repository.
-
-(define-module (eris ipfs)
-
- #:use-module (eris utils base32)
-
- #:use-module (sodium generichash)
-
- #:use-module (json)
-
- #:use-module (web uri)
- #:use-module (web client)
- #:use-module (web response)
-
- #:use-module (srfi srfi-71)
-
- #:use-module (rnrs io ports)
- #:use-module (rnrs bytevectors)
-
- #:export (ipfs-block-reducer
- ipfs-block-ref))
-
-
-;; CID encoding
-
-;; Multicodec codes (https://github.com/multiformats/multicodec/blob/master/table.csv)
-(define multicodec-raw-code #x55)
-(define multicodec-blake2b-256-code #xb220)
-
-(define (blake2b-256->binary-cid hash)
- "Encode a Blake2b-256 hash as binary CID"
- (call-with-values
- (lambda () (open-bytevector-output-port))
- (lambda (port get-bytevector)
- ;; CID version
- (put-u8 port 1)
- ;; multicoded content-type
- (put-u8 port multicodec-raw-code)
- ;; set multihash to blake2b-256. This is the manually encoded varint of 0xb220
- (put-u8 port 160) (put-u8 port 228) (put-u8 port 2)
- ;; set hash lenght
- (put-u8 port 32)
- ;; and finally the hash itself
- (put-bytevector port hash)
-
- ;; finalize and get the bytevector
- (get-bytevector))))
-
-(define (binary-cid->cid bcid)
- "Encode a binary CID as Base32 encoded CID"
- ;; 'b' is the multibsae code for base32
- (string-append "b"
- ;; the IPFS daemon uses lower-case, so to be consistent we also.
- (string-downcase
- ;; base32 encode the binary cid
- (base32-encode bcid))))
-
-(define blake2b-256->cid
- (compose binary-cid->cid blake2b-256->binary-cid))
-
-
-;; IPFS API
-
-(define %default-ipfs-base-url
- ;; URL of the IPFS gateway.
- "http://localhost:5001")
-
-(define* (call url decode #:optional (method http-post)
- #:key body (false-if-404? #t) (headers '()))
- "Invoke the endpoint at URL using METHOD. Decode the resulting JSON body
-using DECODE, a one-argument procedure that takes an input port; when DECODE
-is false, return the input port. When FALSE-IF-404? is true, return #f upon
-404 responses."
- (let* ((response port
- (method url #:streaming? #t
- #:body body
-
- ;; Always pass "Connection: close".
- #:keep-alive? #f
- #:headers `((connection close)
- ,@headers))))
- (cond ((= 200 (response-code response))
- (if decode
- (let ((result (decode port)))
- (close-port port)
- result)
- port))
- ((and false-if-404?
- (= 404 (response-code response)))
- (close-port port)
- #f)
- (else
- (close-port port)
- (throw 'ipfs-error url response)))))
-
-(define %multipart-boundary
- ;; XXX: We might want to find a more reliable boundary.
- (string-append (make-string 24 #\-) "2698127afd7425a6"))
-
-(define (bytevector->form-data bv port)
- "Write to PORT a 'multipart/form-data' representation of BV."
- (display (string-append "--" %multipart-boundary "\r\n"
- "Content-Disposition: form-data\r\n"
- "Content-Type: application/octet-stream\r\n\r\n")
- port)
- (put-bytevector port bv)
- (display (string-append "\r\n--" %multipart-boundary "--\r\n")
- port))
-
-(define* (ipfs-block-put bv #:key (ipfs-base-url %default-ipfs-base-url))
- "Store a block on IPFS and return the CID of the block"
- (call (string-append ipfs-base-url
- "/api/v0/block/put"
- "?format=raw&mhtype=blake2b-256")
- (lambda (port) (assoc-ref (json->scm port) "Key"))
- #:headers `((content-type
- . (multipart/form-data
- (boundary . ,%multipart-boundary))))
- #:body (call-with-bytevector-output-port
- (lambda (port) (bytevector->form-data bv port)))))
-
-(define* (ipfs-block-get cid #:key (ipfs-base-url %default-ipfs-base-url))
- "Get a block from IPFS via the HTTP API"
- (call (string-append ipfs-base-url
- "/api/v0/block/get"
- "?arg=" cid)
- get-bytevector-all))
-
-;; ERIS block reducer
-
-(define* (ipfs-block-reducer #:key (ipfs-base-url %default-ipfs-base-url))
- "Returns a block reducer that stores block on IPFS"
- (case-lambda
- ;; initialization. Nothing to do here. In an improved implementation we
- ;; might create a single HTTP connection and reuse it for all blocks.
- (() '())
-
- ;; Completion. Again, nothing to do.
- ((_) 'done)
-
- ;; store a block
- ((_ ref-block)
- ;; ref-block is a pair consisting of the reference to the block and the block itself.
- (ipfs-block-put (cdr ref-block)
- #:ipfs-base-url ipfs-base-url))))
-
-(define* (ipfs-block-ref ref #:key (ipfs-base-url %default-ipfs-base-url))
- "Dereference a block from IPFS"
- (ipfs-block-get (blake2b-256->cid ref)
- #:ipfs-base-url ipfs-base-url))
-
diff --git a/eris/read-capability.scm b/eris/read-capability.scm
deleted file mode 100644
index 7a2199c..0000000
--- a/eris/read-capability.scm
+++ /dev/null
@@ -1,92 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (eris read-capability)
-
- #:use-module (eris utils rbytevector)
-
- #:use-module (rnrs bytevectors)
- #:use-module (rnrs io ports)
-
-
- #:use-module (eris utils base32)
-
- #:use-module (srfi srfi-9)
- #:use-module (srfi srfi-171)
-
- #:export (make-read-capability
- read-capability?
- read-capability-block-size
- read-capability-level
- read-capability-root-reference
- read-capability-root-key
-
- read-capability->bytevector
- bytevector->read-capability
-
- read-capability->string
- string->read-capability
-
- ->read-capability))
-
-(define-record-type <read-capability>
- (make-read-capability block-size level root-reference root-key)
- read-capability?
- (block-size read-capability-block-size)
- (level read-capability-level)
- (root-reference read-capability-root-reference)
- (root-key read-capability-root-key))
-
-(define (read-capability->bytevector read-capability)
- (list-transduce (tmap identity)
- (rbytevector)
- (list
- ;; version
- (if (= 1024 (read-capability-block-size read-capability))
- (make-bytevector 1 0)
- (make-bytevector 1 1))
-
- ;; level
- (make-bytevector 1 (read-capability-level read-capability))
-
- ;; root reference
- (read-capability-root-reference read-capability)
-
- ;; root key
- (read-capability-root-key read-capability))))
-
-(define (bytevector->read-capability bv)
- (let* ((port (open-bytevector-input-port bv))
- (block-size (get-u8 port))
- (level (get-u8 port))
- (reference (get-bytevector-n port 32))
- (key (get-bytevector-n port 32)))
- (cond
-
- ((= block-size 0)
- (make-read-capability 1024 level reference key))
-
- ((= block-size 1)
- (make-read-capability (* 32 1024) level reference key)))))
-
-(define (read-capability->string read-capability)
- (string-append "urn:erisx2:"
- (base32-encode (read-capability->bytevector read-capability))))
-
-;; (read-capability->string
-;; (make-read-capability 1024 0
-;; (make-bytevector 32 0)
-;; (make-bytevector 32 1)))
-
-(define (string->read-capability urn)
- (when (equal? (string-take urn 11) "urn:erisx2:")
- (bytevector->read-capability
- (base32-decode (string-drop urn 11)))))
-
-(define (->read-capability encoded)
- "Attempt to decode read capability from string or bytevector."
- (cond
- ((read-capability? encoded) encoded)
- ((string? encoded) (string->read-capability encoded))
- ((bytevector? encoded) (bytevector->read-capability encoded))))
diff --git a/eris/utils/base32.scm b/eris/utils/base32.scm
deleted file mode 100644
index 98f86fa..0000000
--- a/eris/utils/base32.scm
+++ /dev/null
@@ -1,150 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (eris utils base32)
- #:use-module (rnrs bytevectors)
- #:use-module (ice-9 binary-ports)
- #:use-module (ice-9 vlist)
- #:use-module (srfi srfi-1)
- #:use-module (srfi srfi-11)
- #:use-module (srfi srfi-26)
- #:use-module (srfi srfi-60)
- #:use-module (srfi srfi-171)
- #:export (base32-encode
- base32-decode
-
- base32-alphabet-rfc4648))
-
-;; The Base32 Data Encoding (RFC4648)
-
-;; TODO padding
-
-(define base32-alphabet-rfc4648
- "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567")
-
-(define (make-encode-alphabet str)
- (alist->vhash
- (map
- cons
- (iota 32)
- (string->list str))))
-
-(define (make-decode-alphabet str)
- (alist->vhash
- (map
- cons
- (string->list str)
- (iota 32))))
-
-(define (quintet->alphabet-character q alphabet)
- (cdr
- (vhash-assv q alphabet)))
-
-(define (alphabet-character->quintet char alphabet)
- (cdr (vhash-assv char alphabet)))
-
-(define (pad-right lst n padding)
- (append
- lst
- (make-list (max 0 (- n (length lst))) padding)))
-
-(define* (base32-tencode #:key (alphabet base32-alphabet-rfc4648))
- "Returns a transducer that returns the Base32 encoding of the concatenation of all bytevectors passed."
- (let ((alphabet* (make-encode-alphabet alphabet)))
- (compose
- ;; tranform group (40bit) into list of integers
- (tmap (lambda (bv) (bytevector->uint-list bv (endianness little) 1)))
-
- ;; flatten so that values are individual integers
- tflatten
-
- ;; get binary representation of integers
- (tmap (lambda (int) (integer->list int 8)))
-
- ;; take groups of 5bits
- tflatten (tsegment 5)
-
- ;; pad with zeroes if less than 5 bits available
- (tmap (lambda (group) (pad-right group 5 #f)))
-
- ;; encode 5bit group to an alphabet
- (tmap (lambda (quintet) (quintet->alphabet-character
- (list->integer quintet)
- alphabet*))))))
-
-(define* (base32-encode bv #:key (alphabet base32-alphabet-rfc4648))
- "Encode bytevector to Base32 encoding."
- (list->string
- (port-transduce
-
- ;; create a Base32 transcoder
- (base32-tencode #:alphabet alphabet)
-
- ;; reduce into a list
- rcons
-
- ;; read 40bits at a time (5 bytes). Note that the amount of bytes doesn't
- ;; really matter for correctness, the transducer takes care of everything.
- ;; Maybe there is some performanc benefit...
- (lambda (port) (get-bytevector-n port 5))
-
- ;; open bytevector for reading
- (open-bytevector-input-port bv))))
-
-;; See the Test vectors in the RFC (https://tools.ietf.org/html/rfc4648#section-10)
-;; TODO put this in a unit test
-;; (base32-encode (string->utf8 "f")) ; MY
-;; (base32-encode (string->utf8 "fo")) ; MZXQ
-;; (base32-encode (string->utf8 "foo")) ; MZXW6
-;; (base32-encode (string->utf8 "foob")) ; MZXW6YQ
-;; (base32-encode (string->utf8 "fooba")) ; MZXW6YTB
-;; (base32-encode (string->utf8 "foobar")) ; MZXW6YTBOI
-
-(define (rbytevector)
- "Returns a reducer that accumulates integers into a bytevector"
- (let-values (((port get-bytevector) (open-bytevector-output-port)))
- (case-lambda
- ;; identity
- (() port)
-
- ;; completion
- ((port) (get-bytevector))
-
- ;; put bv on port and return the port
- ((port int) (begin (put-u8 port int) port)))))
-
-
-(define* (base32-tdecode #:key (alphabet base32-alphabet-rfc4648))
- "Returns a transducer that decodes a Base32 encoded serie of characters and yields bytes as uints."
- (let ((alphabet* (make-decode-alphabet base32-alphabet-rfc4648)))
- (compose
- ;; decode alphabet-character
- (tmap (cut alphabet-character->quintet <> alphabet*))
-
- ;; expand to bit representation
- (tmap (cut integer->list <> 5))
-
- ;; flatten list of bits
- tflatten
-
- ;; group 8bits together
- (tsegment 8)
-
- ;; filter out groups with less than 8 bits
- (tfilter (lambda (group) (eqv? 8 (length group))))
-
- ;; tranform to integer
- (tmap list->integer))))
-
-(define* (base32-decode str #:key (alphabet base32-alphabet-rfc4648))
- (list-transduce
- ;; create a transducer to decode the Base32 stream of characters
- (base32-tdecode #:alphabet alphabet)
-
- ;; create a new bytevector reducer
- (rbytevector)
-
- (string->list str)))
-
-;; (utf8->string (base32-decode "MZXW6YTBOI")) ; "foobar"
diff --git a/eris/utils/padding.scm b/eris/utils/padding.scm
deleted file mode 100644
index 672784c..0000000
--- a/eris/utils/padding.scm
+++ /dev/null
@@ -1,78 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (eris utils padding)
- #:use-module (rnrs bytevectors)
- #:use-module (rnrs io ports)
-
- #:use-module (sodium padding)
-
- #:export (tpad
- tunpad))
-
-(define (tpad block-size)
- "Returns a transducer that pads the last block to block-size. Will always return at least one block. Stateful."
- (lambda (reducer)
- (let ((prev #nil))
- (case-lambda
- ;; identity
- (() (reducer))
-
- ;; completion
- ((result)
- (if (nil? prev)
- ;; no previous block - reduce a padded empty bytevector
- (reducer (reducer result (sodium-pad (make-bytevector 0) #:block-size block-size)))
-
- ;; pad the prev block
- (let ((padded (sodium-pad prev #:block-size block-size)))
- ;; padding may result in a bytevector of size 2*block-size
- (if (equal? (bytevector-length padded) block-size)
- ;; no extra block was created
- (reducer (reducer result padded))
-
- ;; last block plus padding fits into two blocks
- (let* ((port (open-bytevector-input-port padded))
- ;; the second-last block
- (block-n-1 (get-bytevector-n port block-size))
- ;; the last block
- (block-n (get-bytevector-n port block-size)))
- (reducer (reducer (reducer result block-n-1) block-n)))))))
-
- ;; handle new input (a block)
- ((result block)
- (if (nil? prev)
- ;; no previous block, don't reduce anything
- (begin (set! prev block) result)
- ;; reduce previous block and store current input block in prev
- (let ((not-the-last-block prev))
- (set! prev block) (reducer result not-the-last-block))))))))
-
-(define (tunpad block-size)
- "Returns a transducer that unpads the last block"
- (lambda (reducer)
- (let ((prev #nil))
- (case-lambda
- ;; identity
- (() (reducer))
-
- ;; completion
- ((result)
- (if (nil? prev)
- ;; no previous block
- (reducer result)
-
- ;; unpad the last block (prev) and reduce
- (reducer (reducer result (sodium-unpad prev #:block-size block-size)))))
-
- ;; handle input
- ((result block)
- (if (nil? prev)
- ;; no previous block, don't reduce anything
- (begin (set! prev block) result)
-
- ;; reduce previous block and store current input block in prev
- (let ((not-the-last-block prev))
- (set! prev block)
- (reducer result not-the-last-block))))))))
diff --git a/eris/utils/rbytevector.scm b/eris/utils/rbytevector.scm
deleted file mode 100644
index 727e618..0000000
--- a/eris/utils/rbytevector.scm
+++ /dev/null
@@ -1,24 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (eris utils rbytevector)
- #:use-module (rnrs bytevectors)
- #:use-module (rnrs io ports)
-
- #:use-module (srfi srfi-11)
-
- #:export (rbytevector))
-
-(define (rbytevector)
- "Returns a reducer that accumulates bytevectors"
- (let-values (((port get-bytevector) (open-bytevector-output-port)))
- (case-lambda
- ;; identity
- (() port)
-
- ;; completion
- ((port) (get-bytevector))
-
- ;; put bv on port and return the port
- ((port bv) (begin (put-bytevector port bv) port)))))
diff --git a/eris/utils/test-vector.scm b/eris/utils/test-vector.scm
deleted file mode 100644
index 91a64f8..0000000
--- a/eris/utils/test-vector.scm
+++ /dev/null
@@ -1,115 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (eris utils test-vector)
- #:use-module (eris)
- #:use-module (eris encode)
- #:use-module (eris utils base32)
- #:use-module (eris read-capability)
-
- #:use-module (oop goops)
-
- #:use-module (rnrs bytevectors)
- #:use-module (rnrs io ports)
-
- #:use-module (srfi srfi-9)
- #:use-module (srfi srfi-11)
- #:use-module (srfi srfi-69)
- #:use-module (srfi srfi-171)
-
- #:export (<test-vector>
- make-test-vector
-
- test-vector-id
- test-vector-name
- test-vector-description
- test-vector-content
- test-vector-convergence-secret
- test-vector-block-size
- test-vector-read-capability
- test-vector-urn
- test-vector-blocks
-
- test-vector->obj
- obj->test-vector))
-
-;; Helpers to generate and serialize test vectors
-
-(define-record-type <test-vector>
- (&make-test-vector id
- name
- description
- content
- convergence-secret
- block-size
- read-capability
- urn
- blocks)
- test-vector?
- (id test-vector-id)
- (name test-vector-name)
- (description test-vector-description)
- (content test-vector-content)
- (convergence-secret test-vector-convergence-secret)
- (block-size test-vector-block-size)
- (read-capability test-vector-read-capability)
- (urn test-vector-urn)
- (blocks test-vector-blocks))
-
-;; Reduces blocks into an alist of base32 encoded values so that the blocks can be directly exported to JSON
-(define rtest-vector-blocks
- (case-lambda
- (() '())
- ((result) result)
- ((result ref-block)
- (cons
- (cons (string->symbol (base32-encode (car ref-block)))
- (base32-encode (cdr ref-block)))
- result))))
-
-(define (make-test-vector id name description content convergence-secret block-size)
- (let-values (((read-capability blocks) (eris-encode (open-bytevector-input-port content)
- #:block-reducer rtest-vector-blocks
- #:block-size block-size
- #:convergence-secret convergence-secret)))
- (&make-test-vector id name description content convergence-secret block-size
- read-capability
- (read-capability->string read-capability)
- blocks)))
-
-(define (read-capability->obj read-capability)
- `((block-size . ,(read-capability-block-size read-capability))
- (level . ,(read-capability-level read-capability))
- (root-reference . ,(base32-encode (read-capability-root-reference read-capability)))
- (root-key . ,(base32-encode (read-capability-root-key read-capability)))))
-
-(define (obj->read-capability obj)
- (make-read-capability
- (assq-ref obj 'block-size)
- (assq-ref obj 'level)
- (base32-decode (assq-ref obj 'root-reference))
- (base32-decode (assq-ref obj 'root-key))))
-
-(define (test-vector->obj test-vector)
- `((id . ,(test-vector-id test-vector))
- (name . ,(test-vector-name test-vector))
- (description . ,(test-vector-description test-vector))
- (content . ,(base32-encode (test-vector-content test-vector)))
- (convergence-secret . ,(base32-encode (test-vector-convergence-secret test-vector)))
- (block-size . ,(test-vector-block-size test-vector))
- (read-capability . ,(read-capability->obj (test-vector-read-capability test-vector)))
- (urn . ,(test-vector-urn test-vector))
- (blocks . ,(test-vector-blocks test-vector))))
-
-(define (obj->test-vector obj)
- (&make-test-vector
- (assq-ref obj 'id)
- (assq-ref obj 'name)
- (assq-ref obj 'description)
- (base32-decode (assq-ref obj 'content))
- (base32-decode (assq-ref obj 'convergence-secret))
- (assq-ref obj 'block-size)
- (obj->read-capability (assq-ref obj 'read-capability))
- (assq-ref obj 'urn)
- (assq-ref obj 'blocks)))
diff --git a/examples/dedup-fs/.gitignore b/examples/dedup-fs/.gitignore
deleted file mode 100644
index 21c5b7e..0000000
--- a/examples/dedup-fs/.gitignore
+++ /dev/null
@@ -1,3 +0,0 @@
-*.img
-*.tar
-*.tar.zst
diff --git a/examples/dedup-fs/Readme.org b/examples/dedup-fs/Readme.org
deleted file mode 100644
index c480efc..0000000
--- a/examples/dedup-fs/Readme.org
+++ /dev/null
@@ -1,452 +0,0 @@
-#+TITLE: De-duplicated File-Systems with ERIS
-#+PROPERTY: header-args:scheme :session *eris-repl* :eval never-export
-
-#+BEGIN_ABSTRACT
-This is an experiment to investigate how ERIS can be used to encode file-systems so that the same content appearing in two file-systems is de-duplicated.
-#+END_ABSTRACT
-
-* ERIS for De-duplication
-
-ERIS (Encoding for Robust Immutable Storage) defines how any content can be encoded into a set of uniformly sized, encrypted blocks. The original content can be decoded from the blocks only with a special key - a read capability, which can be encoded as an URN.
-
-For example the ERIS URN of the string ~"Hello World!"~ is:
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (eris)
- (eris read-capability)
- (ice-9 receive))
-
-(receive (read-capability blocks)
- (eris-encode "Hello World!")
- (read-capability->string read-capability))
-#+END_SRC
-
-#+RESULTS:
-: urn:erisx2:AAAASDIKPSHNFCH7TZKPNTTSA4AXEPOMMRB4LCA6VC6YXL2YPATZGTBBUWKF7SN555Y7MLVVIPQPFUHUKPE7Y4GVPCETLN5ZMXJME45TKA
-
-Without this URN the blocks are just uniformly sized pieces of gibberish (1KiB or 32KiB).
-
-In order to decode the content we need to be able to de-reference individual blocks by their hash (content-addressing). A simple key-value store suffices, but one can also use systems such as IPFS, GNUNet, Named Data Networking (I think!) or a simple HTTP service to store and transport blocks. ERIS de-couples content from underlying storage and transport networks.
-
-ERIS encodes content by reading fixed-size blocks of content, encrypting them and collecting them together in a tree (see the [[http://purl.org/eris][spec]] for more information).
-
-If the same content is read twice it is encoded into the same block.
-
-We will attempt to encode different formats of archives and images of Guix packages to see how well ERIS de-duplicates shared content.
-
-** Intermezzo: Storing blocks in VHashes
-
-By default the Guile ERIS implementation stores blocks in an alist. We can tell the encoder to store the blocks elsewhere by providing an SRFI-171 reducer that takes care of the blocks.
-
-In this example we will store blocks in a VHash (with blocks as values and the references to the blocks - the Blake2b hash of the block - as keys). This will allow us to do more simpler merging and counting of blocks (merging a VHash is easier than merging an alist).
-
-#+BEGIN_SRC scheme
-(use-modules (ice-9 vlist)
- (rnrs bytevectors))
-
-;; special care must be given to use a appropriate hash function...
-(define (ref-hash key size)
- (modulo
- (bytevector-uint-ref key 0 (endianness big) 32)
- size))
-
-(define (vhash-block-ref blocks ref)
- (cond
- ((vhash-assoc ref blocks bytevector=? ref-hash) => cdr)
- (else #f)))
-
-(define (vhash-block-cons ref block blocks)
- (if (vhash-block-ref blocks ref)
- blocks
- (vhash-cons ref block blocks ref-hash)))
-
-(define vhash-block-reducer
- (case-lambda
-
- ;; initialize empty VHash
- (() vlist-null)
-
- ;; return blocks without post-processing
- ((blocks) blocks)
-
- ;; add a new block
- ((blocks ref-block)
- (vhash-block-cons (car ref-block) (cdr ref-block) blocks))))
-
-(define (vhash-block-merge vh1 vh2)
- (vhash-fold vhash-block-cons vh1 vh2))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-** Measuring de-duplication
-
-Some helpers to count de-duplicated blocks:
-
-#+BEGIN_SRC scheme
-(use-modules (eris)
- (ice-9 receive)
- (ice-9 format))
-
-
-(define (eris-encode->vhash-blocks file block-size)
- "Encode file and return the blocks in a VHash"
- (receive (_ blocks)
- (call-with-input-file file
- (lambda (port) (eris-encode port
- #:block-size block-size
- #:block-reducer vhash-block-reducer))
- #:binary #t)
- blocks))
-
-(define* (measure-eris-de-duplicaiton file-1 file-2 #:key (block-size eris-block-size-large))
- (let* ((blocks-1 (eris-encode->vhash-blocks file-1 block-size))
- (blocks-2 (eris-encode->vhash-blocks file-2 block-size))
- (block-count-1 (vlist-length blocks-1))
- (block-count-2 (vlist-length blocks-2))
- (block-count-total (vlist-length (vhash-block-merge blocks-1 blocks-2)))
- (de-duped (- (+ block-count-1 block-count-2)
- block-count-total))
- (de-duped-fraction (/ de-duped (min block-count-1 block-count-2))))
- (format #f "De-duplicated ~d blocks (~,2f%), block counts: ~d/~d, block-size: ~d" de-duped (* 100 de-duped-fraction) block-count-1 block-count-2 block-size)))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-We can use this to measure how much ERIS can de-duplicate.
-
-A simple example:
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton "Readme.org" "Readme.org")
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 1 blocks (100.00%), block counts: 1/1, block-size: 32768
-
-ERIS can de-duplicate the same file by 100%.
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton "Readme.org" "../ipfs.org")
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 0 blocks (0.00%), block counts: 1/1, block-size: 32768
-
-But nothing between this file and the [[../ipfs.org][IPFS demo]].
-
-* A Tale of Two Guix Packages
-
-Recently Ludovic Courtès has investigated the similarity between subsequent package revisions (see [[https://lists.gnu.org/archive/html/guix-devel/2020-12/msg00258.html][post to guix-devel mailing-list]]) and shown that this can be quite high. For subsequent revisions of the Emacs package ~85% of the total size is the same!
-
-Downloading packages can be made much more efficient if this similarity is used and only differences need to be downloaded.
-
-As example we will use two revisions of the Guix Emacs package.
-
-The current version (emacs-27.1):
-
-#+BEGIN_SRC shell :exports both
-guix build emacs --no-offload
-#+END_SRC
-
-#+RESULTS:
-: /gnu/store/lhw3zwhzra0w5l8a4jw8fvm58i75xyl8-emacs-27.1
-
-And an older version (emacs-26.3):
-
-#+BEGIN_SRC shell :exports both
-guix time-machine -C emacs-26.3-channels.scm --no-offload -- build emacs --no-offload
-#+END_SRC
-
-#+RESULTS:
-: /gnu/store/wsv3m2q0r8sbyyzn1wr7vv2fi51mpfkx-emacs-26.3
-
-The similarity between these two packages is ~85%. This is our theoretical upper-limit.
-
-* Archives, Images and Block Alignment
-
-Currently pre-built Guix packages (substitutes) are provided as archives (in a format similar to tar).
-
-We will test de-duplication with ERIS with EROFS, SquashFS, uncompressed tar and a zstd compressed tar.
-
-** EROFS - Enhanced Read-Only File-System
-
-EROFS is a fairly new read-only, compressed file-system developed at Huawei for Android smartphones. It is in mainline Linux Kernel since v5.4.
-
-EROFS was developed as response to performance issues with SquashFS. SquashFS does not align content in any way. When the SquashFS image is stored on a (physical) block device this results in "I/O amplification" as many blocks are retrieved when only small parts of them are used. EROFS improves by aligning content to a block size of 4KiB (see also the [[https://www.usenix.org/system/files/atc19-gao.pdf][EROFS paper]]).
-
-This alignment will help de-duplication, as ERIS reads content in fixed-sized blocks.
-
-*** Creating Images
-
-We can create EROFS images using the ~mkfs.erofs~ tool from erofs-utils.
-
-Note that we fix the file-system UUID and set all time-stamps to Unix 0 so that images are reproducible.
-
-#+BEGIN_SRC shell :exports both
-mkfs.erofs -U c1b9d5a2-f162-11cf-9ece-0020afc76f16 -T 0 -x -1 \
- emacs-27.1.erofs-uncompressed.img \
- /gnu/store/lhw3zwhzra0w5l8a4jw8fvm58i75xyl8-emacs-27.1
-
-mkfs.erofs -U c1b9d5a2-f162-11cf-9ece-0020afc76f16 -T 0 -zlz4hc \
- emacs-27.1.erofs-lz4hc.img \
- /gnu/store/lhw3zwhzra0w5l8a4jw8fvm58i75xyl8-emacs-27.1
-
-mkfs.erofs -U c1b9d5a2-f162-11cf-9ece-0020afc76f16 -T 0 -x -1 \
- emacs-26.3.erofs-uncompressed.img \
- /gnu/store/wsv3m2q0r8sbyyzn1wr7vv2fi51mpfkx-emacs-26.3
-
-mkfs.erofs -U c1b9d5a2-f162-11cf-9ece-0020afc76f16 -T 0 -zlz4hc \
- emacs-26.3.erofs-lz4hc.img \
- /gnu/store/wsv3m2q0r8sbyyzn1wr7vv2fi51mpfkx-emacs-26.3
-
-ls -lh emacs-*.erofs-*.img
-#+END_SRC
-
-#+RESULTS:
-| -rw-r--r-- | 1 | pm | users | 63M | Dec | 29 | 11:28 | emacs-26.3.erofs-lz4hc.img |
-| -rw-r--r-- | 1 | pm | users | 128M | Dec | 29 | 11:28 | emacs-26.3.erofs-uncompressed.img |
-| -rw-r--r-- | 1 | pm | users | 63M | Dec | 29 | 11:28 | emacs-27.1.erofs-lz4hc.img |
-| -rw-r--r-- | 1 | pm | users | 106M | Dec | 29 | 11:27 | emacs-27.1.erofs-uncompressed.img |
-
-*** De-duping
-
-Let's try and de-duplicate with ERIS:
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.erofs-uncompressed.img"
- "emacs-27.1.erofs-uncompressed.img")
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 67 blocks (2.04%), block counts: 3364/3290, block-size: 32768
-
-Not so good. We used a block size of 32KiB. ERIS also supports a block-size of 1KiB:
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.erofs-uncompressed.img"
- "emacs-27.1.erofs-uncompressed.img"
- #:block-size eris-block-size-small)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 19707 blocks (17.75%), block counts: 113746/111016, block-size: 1024
-
-Much better! These are the two block-sizes that are allowed by the ERIS specification. The Guile implementation has some tricks up it's sleeves and can allows any block size that is a power of two. Let's try with 4KiB which is also the block size used by EROFS:
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.erofs-uncompressed.img"
- "emacs-27.1.erofs-uncompressed.img"
- #:block-size 4096)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 4212 blocks (15.85%), block counts: 27167/26571, block-size: 4096
-
-Slightly worse...probably the alignment along the 4KiB blocks is not perfect and by using a even smaller block size (1KiB) we can de-duplicate more.
-
-Let's try with the LZ4 compressed versions:
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.erofs-lz4hc.img"
- "emacs-27.1.erofs-lz4hc.img")
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 5 blocks (0.25%), block counts: 2002/1999, block-size: 32768
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.erofs-lz4hc.img"
- "emacs-27.1.erofs-lz4hc.img"
- #:block-size eris-block-size-small)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 9215 blocks (13.88%), block counts: 66465/66411, block-size: 1024
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.erofs-lz4hc.img"
- "emacs-27.1.erofs-lz4hc.img"
- #:block-size 4096)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 1944 blocks (12.04%), block counts: 16155/16143, block-size: 4096
-
-Again for small block size we have higher levels of de-duplication.
-
-A quick check if we use an ERIS block size larger than the EROFS block size. We would expect the de-duplication level to decrease sharply:
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.erofs-lz4hc.img"
- "emacs-27.1.erofs-lz4hc.img"
- #:block-size (* 8 1024))
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 558 blocks (6.94%), block counts: 8045/8038, block-size: 8192
-
-Almost halved...
-
-** SquashFS
-
-#+BEGIN_SRC shell :exports both
-mksquashfs /gnu/store/lhw3zwhzra0w5l8a4jw8fvm58i75xyl8-emacs-27.1 emacs-27.1.squashfs.img
-mksquashfs /gnu/store/wsv3m2q0r8sbyyzn1wr7vv2fi51mpfkx-emacs-26.3 emacs-26.3.squashfs.img
-ls -lh emacs-*.squashfs.img
-#+END_SRC
-
-#+RESULTS:
-| -rw-r--r-- | 1 | pm | users | 47M | Dec | 29 | 18:41 | emacs-26.3.squashfs.img |
-| -rw-r--r-- | 1 | pm | users | 45M | Dec | 29 | 18:41 | emacs-27.1.squashfs.img |
-
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.squashfs.img"
- "emacs-27.1.squashfs.img"
- #:block-size eris-block-size-large)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 0 blocks (0.00%), block counts: 1482/1440, block-size: 32768
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.squashfs.img"
- "emacs-27.1.squashfs.img"
- #:block-size eris-block-size-small)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 2 blocks (0.00%), block counts: 50434/48995, block-size: 1024
-
-ERIS can not de-duplicate anything as SquashFS does not align content.
-
-** Tar
-
-#+BEGIN_SRC shell :exports both
-tar cf emacs-27.1.tar /gnu/store/lhw3zwhzra0w5l8a4jw8fvm58i75xyl8-emacs-27.1
-tar cf emacs-26.3.tar /gnu/store/wsv3m2q0r8sbyyzn1wr7vv2fi51mpfkx-emacs-26.3
-
-ls -lh emacs-*.tar
-#+END_SRC
-
-#+RESULTS:
-| -rw-r--r-- | 1 | pm | users | 131M | Dec | 29 | 18:43 | emacs-26.3.tar |
-| -rw-r--r-- | 1 | pm | users | 109M | Dec | 29 | 18:43 | emacs-27.1.tar |
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.tar"
- "emacs-27.1.tar"
- #:block-size eris-block-size-large)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 1 blocks (0.03%), block counts: 3470/3395, block-size: 32768
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.tar"
- "emacs-27.1.tar"
- #:block-size eris-block-size-small)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 11932 blocks (10.41%), block counts: 117368/114634, block-size: 1024
-
-Not so bad. When using a small block-size of 1KiB ERIS can decode 10%. But the archive is pretty large. All this savings are meaningless as just sending a compressed archive would probably be cheaper.
-
-** Tar.Zstd
-
-#+BEGIN_SRC shell :exports both
-zstd emacs-27.1.tar
-zstd emacs-26.3.tar
-
-ls -lh emacs-*.tar.zst
-#+END_SRC
-
-#+RESULTS:
-| -rw-r--r-- | 1 | pm | users | 46M | Dec | 29 | 17:21 | emacs-26.3.tar.zst |
-| -rw-r--r-- | 1 | pm | users | 45M | Dec | 29 | 17:11 | emacs-27.1.tar.zst |
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.tar.zst"
- "emacs-27.1.tar.zst"
- #:block-size eris-block-size-large)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 0 blocks (0.00%), block counts: 1455/1443, block-size: 32768
-
-#+BEGIN_SRC scheme :exports both
-(measure-eris-de-duplicaiton
- "emacs-26.3.tar.zst"
- "emacs-27.1.tar.zst"
- #:block-size eris-block-size-small)
-#+END_SRC
-
-#+RESULTS:
-: De-duplicated 0 blocks (0.00%), block counts: 49499/49100, block-size: 1024
-
-Nada de-duplication...
-
-* Conclusion
-
-By using EROFS we were able to de-duplicate ~12% of the content between two very similar revisions of Emacs packages. There is still much room to improve towards the ~85% similarity shown by Ludovic.
-
-Still, maybe nice to see what can be achieved with "off-the-shelve" technology. EROFS is in mainline Linux and you can simply mount an image with ~mount -t erofs -o loop emacs-26.1.erofs-lz4hc.img /mnt/emacs~.
-
-For Guix this experiment is at the intersection of three topics that I find very interesting:
-
-- Peer-to-peer distribution of substitutes
-- Minimizing network usage
-- Mounting packages instead of unpacking (a la [[https://distr1.org/][distri]])
-
-The approach might be interesting for things other than Guix. For example a file-sharing application in GNUNet has very similar requirements.
-
-Some technical questions that remain:
-
-- Does it make sense to hand-roll a EROFS/Squashfs like file-system that is optimized for de-duplication?
-- ERIS currently allows block-size of 1KiB and 32KiB maybe for de-duplicaiton something in-between is better?
-
-Happy hacking!
-
--pukkamustard
-
-* See also
-
-Further reading and watching.
-
-** [[https://www.usenix.org/system/files/atc19-gao.pdf][EROFS: A Compression-friendly Readonly File System for Resource-scarce Devices]]
-
-The EROFS paper presented at USENIX 2019 that illustrates the motivations behind EROFS and compares performance to other filesystems (including Squashfs).
-
-** [[https://media.ccc.de/v/arch-conf-online-2020-6387-distri-researching-fast-linux-package-management][distri: researching fast Linux package management]]
-
-Talk about the distri package manager at Arch Conf 2020.
-
-Distri does not distribute packages as archives but as Squashfs images. Packages can just be mounted instead of unarchived.
-
-See also the toot and discussion on the Fediverse: https://toot.aquilenet.fr/@civodul/105304162332789048
-
-** [[https://lists.gnu.org/archive/html/guix-devel/2020-12/msg00177.html][When substitute download + decompression is CPU-bound]]
-
-Post on the guix-devel mailing-list on how installing a Guix package can be CPU-bound (due to decompression).
-
-This can be solved by not decompressing packages, but just mounting them (like distri).
-
-** [[https://lists.gnu.org/archive/html/guix-devel/2020-12/msg00258.html][Identical files across subsequent package revisions]]
-
-Post on the guix-devel mailing-list showing how similar different versions of package can be.
diff --git a/examples/dedup-fs/emacs-26.3-channels.scm b/examples/dedup-fs/emacs-26.3-channels.scm
deleted file mode 100644
index 8ae6a83..0000000
--- a/examples/dedup-fs/emacs-26.3-channels.scm
+++ /dev/null
@@ -1,9 +0,0 @@
-(list (channel
- (name 'guix)
- (url "https://git.savannah.gnu.org/git/guix.git")
- (commit "c05d2cfcbedaae5424149b8060a61bacdf81a119")
- (introduction
- (make-channel-introduction
- "9edb3f66fd807b096b48283debdcddccfea34bad"
- (openpgp-fingerprint
- "BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA")))))
diff --git a/examples/dedup-fs/guix.scm b/examples/dedup-fs/guix.scm
deleted file mode 100644
index d965725..0000000
--- a/examples/dedup-fs/guix.scm
+++ /dev/null
@@ -1,53 +0,0 @@
-(use-modules
- (guix packages)
- (guix download)
- (guix git-download)
- (guix build-system gnu)
- ((guix licenses) #:prefix license:)
- (gnu packages autotools)
- (gnu packages compression)
- (gnu packages linux)
- (gnu packages pkg-config))
-
-(define-public erofs-utils
- (package
- (name "erofs-utils")
- (version "1.2")
- (source
- (origin
- (method git-fetch)
- (uri (git-reference
- (url "git://git.kernel.org/pub/scm/linux/kernel/git/xiang/erofs-utils.git")
- (commit (string-append "v" version))))
- (file-name (git-file-name name version))
- (sha256
- (base32 "07hvijq2hsn3gg1kb8abrfk23n83j57yx8kyv4wqgwhhvd30myjc"))))
- (build-system gnu-build-system)
- (inputs
- `(("lz4" ,lz4)
- ("util-linux" ,util-linux "lib")))
- (native-inputs
- `(("autoconf" ,autoconf)
- ("automake" ,automake)
- ("libtool" ,libtool)
- ("pkg-config" ,pkg-config)))
- (home-page "https://git.kernel.org/pub/scm/linux/kernel/git/xiang/erofs-utils.git/")
- (synopsis "User-space tools for EROFS filesystem")
- (description "EROFS (Enhanced Read-Only File System) is a compressed,
-read-only filesystem optimized for resource-scarce devices. This package
-provides user-space tools for creating EROFS filesystems.")
- (license license:gpl2+)))
-
-(package
- (name "eris-dedup-fs-example")
- (version "0")
- (source #f)
- (build-system gnu-build-system)
- (native-inputs
- `(("zstd" ,zstd)
- ("squashfs-tools" ,squashfs-tools)
- ("erofs-utils" ,erofs-utils)))
- (home-page #f)
- (synopsis #f)
- (description #f)
- (license license:gpl3+))
diff --git a/examples/ipfs.org b/examples/ipfs.org
deleted file mode 100644
index fcc4bd0..0000000
--- a/examples/ipfs.org
+++ /dev/null
@@ -1,519 +0,0 @@
-#+TITLE: IPFS as Storage and Transport Layer
-#+PROPERTY: header-args:scheme :session *eris-repl* :eval never-export
-
-This is a short demo on how IPFS can be used as Storage and Transport Layer for ERIS encoded content.
-
-* Overview
-
-We will use the [[https://docs.ipfs.io/reference/http/api/][IPFS HTTP API]] to store blocks of ERIS encoded content.
-
-Usually when adding a file or directory to IPFS it is encoded into uniformly sized blocks (with additional metadata) using the [[https://docs.ipfs.io/concepts/file-systems/#unix-file-system-unixfs][IPFS UnixFS]] encoding. The individual blocks are then stored on the IPFS storage and made available via peer-to-peer networking.
-
-Access to the individual blocks is possible with the two API endpoints [[https://docs.ipfs.io/reference/http/api/#api-v0-block-put][/api/v0/block/put]] and [[https://docs.ipfs.io/reference/http/api/#api-v0-block-get][/api/v0/block/get]]. These endpoints give access to /raw/ content-addressed blocks without any metadata. This is where we will plug in and store blocks of ERIS encoded content.
-
-** Babel
-
-This is demo can be re-run using Emacs [[https://orgmode.org/worg/org-contrib/babel/intro.html][org-mode babel]]. You should start the IPFS daemon with ~ipfs daemon~.
-
-* IPFS ceremony
-
-A little bit of ceremony is required to interact with IPFS (dealing with CIDs and the HTTP API).
-
-** CID
-
-[[https://github.com/multiformats/cid][CID]] is the IPFS format for references to content. CIDs are self-describing and encode the hash used. This has the disadvantage that a single piece of content has multiple (many!) identifiers. But we use it to our advantage: Blake2b-256 as required for ERIS is also supported.
-
-
-We need to be able to encode and decode raw Blake2b-256 hashes to CIDs.
-
-We use the [[https://github.com/multiformats/multicodec/blob/master/table.csv][multicodec content-type]] 0x55 for raw data:
-
-#+BEGIN_SRC scheme
-(define multicodec-raw-code #x55)
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-The multicodec code for Blake2b-256 is 0xb220:
-
-#+BEGIN_SRC scheme
-(define multicodec-blake2b-256-code #xb220)
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-
-*** Encoding
-
-See [[https://github.com/multiformats/cid#how-does-it-work][the CID specification]].
-
-First we encode a binary cid:
-
-#+BEGIN_SRC scheme
-(use-modules (rnrs io ports)
- (rnrs bytevectors))
-
-(define (blake2b-256->binary-cid hash)
- (call-with-values
- (lambda () (open-bytevector-output-port))
- (lambda (port get-bytevector)
- ;; CID version
- (put-u8 port 1)
- ;; multicoded content-type
- (put-u8 port multicodec-raw-code)
- ;; set multihash to blake2b-256. This is the manually encoded varint of 0xb220
- (put-u8 port 160) (put-u8 port 228) (put-u8 port 2)
- ;; set hash lenght
- (put-u8 port 32)
- ;; and finally the hash itself
- (put-bytevector port hash)
-
- ;; finalize and get the bytevector
- (get-bytevector))))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-We use base32 for encoding the binary cid as string:
-
-#+BEGIN_SRC scheme
-(use-modules (eris utils base32))
-
-(define (binary-cid->cid bcid)
- ;; 'b' is the multibsae code for base32
- (string-append "b"
- ;; the IPFS daemon uses lower-case, so to be consistent we also.
- (string-downcase
- ;; base32 encode the binary cid
- (base32-encode bcid))))
-
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-And to make it quick, a little shortcut:
-
-#+BEGIN_SRC scheme
-(define blake2b-256->cid
- (compose binary-cid->cid blake2b-256->binary-cid))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-Let's try encoding a simple hash:
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (sodium generichash))
-
-(blake2b-256->cid
- (crypto-generichash (string->utf8 "Hello world!")))
-#+END_SRC
-
-#+RESULTS:
-: bafk2bzacea73ycjnxe2qov7cvnhx52lzfp6nf5jcblnfus6gqreh6ygganbws
-
-We can check this with the [[https://cid.ipfs.io/#bafk2bzacea73ycjnxe2qov7cvnhx52lzfp6nf5jcblnfus6gqreh6ygganbws][CID inspector tool]]. Looks good!
-
-*** Decoding
-
-Decoding is a bit trickier as we need to decode [[https://github.com/multiformats/unsigned-varint][unsigned-varint]]. Fortunately, for storing blocks on IPFS we don't need to do this. This section is completely unnecessary. Feel free to skip to the next section.
-
-#+BEGIN_SRC scheme
-;; SRFI-60 Integers as Bits
-(use-modules (srfi srfi-60))
-
-(define (get-varint port)
- "Get a unsigned varint from the port (see https://github.com/multiformats/unsigned-varint)."
- (let loop ((byte (get-u8 port))
- (i 0)
- (var 0))
- (let ((new-var (bitwise-ior
- var
- (arithmetic-shift (bit-field byte 0 7)
- (* 7 i)))))
- (if (bit-set? 7 byte)
- (loop (get-u8 port) (1+ i) new-var)
- new-var))))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-To extract the blake2b-256 hash from a binary CID:
-
-#+BEGIN_SRC scheme
-(define (binary-cid->blake2b-256 cid)
- "Extract blake2b-256 hash code from a CIDv1"
- (let ((cid-port (open-bytevector-input-port cid)))
- ;; require CIDv1
- (when (eqv? (get-varint cid-port) 1)
- ;; require multicodec to be raw
- (when (eqv? (get-varint cid-port) multicodec-raw-code)
- ;; require multihash to be blake2b-256
- (when (eqv? (get-varint cid-port) multicodec-blake2b-256-code)
- ;; require the digest-lenght to be 32
- (when (eqv? (get-varint cid-port) 32)
- (get-bytevector-n cid-port 32)))))))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-Note that this is a hacky thing that only decodes CIDs of blake2b-256 hash codes. A more general CID decoder would be nicer.
-
-One more little step to decode a string CID to a binary CID:
-
-#+BEGIN_SRC scheme
-(define (cid->binary-cid cid)
- (when (equal? (string-take cid 1) "b")
- (base32-decode
- (string-upcase
- (string-drop cid 1)))))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-And a little shortcut:
-
-#+BEGIN_SRC scheme
-(define cid->blake2b-256
- (compose binary-cid->blake2b-256 cid->binary-cid))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-A quick check:
-
-#+BEGIN_SRC scheme :exports both
-(bytevector=?
- (cid->blake2b-256
- (blake2b-256->cid
- (crypto-generichash (string->utf8 "Hello world!"))))
- (crypto-generichash (string->utf8 "Hello world!")))
-#+END_SRC
-
-#+RESULTS:
-: #t
-
-Woo-hoo! Wasn't that some fun procrastination? But now, back to storing block on IPFS.
-
-** Storing blocks
-
-A bit of HTTP magic to encode a multipart body:
-
-#+BEGIN_SRC scheme
-(define %multipart-boundary
- "woobledubledooodidubabidubdipubspoop")
-
-(define (encode-multipart-body bv)
- (call-with-values
- (lambda () (open-bytevector-output-port))
- (lambda (port get-bytevector)
- (put-string port
- (string-append
- "--" %multipart-boundary "\n"))
- (put-string port
- "Content-Type: text/plain\nContent-Disposition: form-data; name=data\n\n")
- (put-bytevector port bv)
- (put-string port
- (string-append "\n--" %multipart-boundary "--\n"))
- (get-bytevector))))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-Using this we can create a function that makes a request to the IPFS daemon to store a block:
-
-#+BEGIN_SRC scheme
-(use-modules (ice-9 receive)
- (web client)
- (web response)
- (json))
-
-(define (ipfs-block-put bv)
- "Store a block on IPFS and return the CID of the block"
- (receive (response body)
- (http-post
- (string-append "http://localhost:5001/api/v0/block/put"
- "?format=raw&mhtype=blake2b-256")
- #:headers `((Content-Type . ,(string-append
- "multipart/form-data; boundary=\""
- %multipart-boundary "\"")))
-
- #:decode-body? #f
- #:streaming? #t
- #:body (encode-multipart-body bv))
- (when (eqv? (response-code response) 200)
- (assoc-ref (json->scm body) "Key"))))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-Let's try it out:
-
-#+BEGIN_SRC scheme :exports both
-(ipfs-block-put (string->utf8 "Hello world!"))
-#+END_SRC
-
-#+RESULTS:
-: bafk2bzacea73ycjnxe2qov7cvnhx52lzfp6nf5jcblnfus6gqreh6ygganbws
-
-Looks good! Note that this is the same CID as we computed above with ~blake2b-256->cid~.
-
-** Getting blocks
-
-To get a block from IPFS we use the ~/api/v0/block/get~ endpoint:
-
-#+BEGIN_SRC scheme
-(define (ipfs-block-get cid)
- "Get a block from IPFS via the HTTP API"
- (receive (response body)
- (http-post
- (string-append "http://localhost:5001/api/v0/block/get"
- "?arg=" cid)
- #:decode-body? #f)
- body))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-#+BEGIN_SRC scheme :exports both
-(utf8->string
- (ipfs-block-get "bafk2bzacea73ycjnxe2qov7cvnhx52lzfp6nf5jcblnfus6gqreh6ygganbws"))
-#+END_SRC
-
-#+RESULTS:
-: Hello world!
-
-We are ready to hook up the ERIS encoding to the IPFS machinery.
-
-* ERIS over IPFS
-
-Before we encode and decode, a quick dive into how the ~guile-eris~ API can be linked with IPFS.
-
-** Reducer
-
-To store the blocks we need a reducer. A reducer is the same thing one supplies to ~fold~ when processing a list. For example a simple reducer that computes the sum of elements in a list:
-
-#+BEGIN_SRC scheme :exports both
-(define (sum-reducer element total)
- (+ element total))
-
-(use-modules (srfi srfi-1))
-
-(fold sum-reducer 0 '(1 2 3))
-#+END_SRC
-
-#+RESULTS:
-: 6
-
-We need a special kind of reducer, a SRFI-171 reducer. The only thing that changes is that the reducer is a 3-ary procedure which produces the identity when called with 0 arguments (for ~fold~ we manually supplied the identity - ~0~), can do some post-processing to the reduced value when called with one argument and reduces an input to the result so far when called with two arguments.
-
-The additional arities are useful for setting up a reducer and cleaning up after finishing. For example when called with zero arguments the reducer might open up a connection to a database and return a connection handle. When storing elements the reducer is called with the connection handle and the element to store. After all elements are reduced, the reducer is called with just the connection handle. The reducer can then close the database connection gracefully.
-
-Our IPFS block reducer is simpler in the sense that it does not do any connection setup. More efficient implementations would probably set up a single HTTP connection to the IPFS daemon that can be reused.
-
-THE IPFS block reducer looks like this:
-
-#+BEGIN_SRC scheme
-(define ipfs-block-reducer
- (case-lambda
-
- ;; initialization. Nothing to do here. In an improved implementation we
- ;; might create a single HTTP connection and reuse it for all blocks.
- (() '())
-
- ;; Completion. Again, nothing to do.
- ((_) 'done)
-
- ;; store a block
- ((_ ref-block)
- ;; ref-block is a pair consisting of the reference to the block and the block itself.
- (ipfs-block-put (cdr ref-block)))))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-The ERIS encoder will use the reducer to store blocks as soon as they are ready - before the complete encoding process is finished. This allows content that is larger than the available memory to be encoded (see the section on [[http://purl.org/eris#_streaming][Streaming]] in the specification).
-
-** Encoding
-
-We can tell ~eris-encode~ to use this reducer with the ~#:block-reducer~ keyword argument:
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (eris))
-
-(define read-capability
- (receive (read-capability blocks)
- (eris-encode "Hello world!" #:block-reducer ipfs-block-reducer)
- read-capability))
-
-read-capability
-#+END_SRC
-
-#+RESULTS:
-: #<<read-capability> block-size: 1024 level: 0 root-reference: #vu8(63 254 3 75 10 5 103 7 208 238 26 103 0 126 217 124 236 105 205 75 136 116 101 176 189 63 118 210 40 169 217 105) root-key: #vu8(19 230 50 100 252 2 228 177 6 63 67 102 128 217 107 51 19 246 52 165 17 175 247 177 68 0 59 165 100 99 44 219)>
-
-This returns the raw /read capability/ which is required to decode the content.
-
-The read capability can also be encoded as an URN:
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (eris read-capability))
-
-(read-capability->string read-capability)
-#+END_SRC
-
-#+RESULTS:
-: urn:erisx2:AAAD77QDJMFAKZYH2DXBUZYAP3MXZ3DJZVFYQ5DFWC6T65WSFCU5S2IT4YZGJ7AC4SYQMP2DM2ANS2ZTCP3DJJIRV733CRAAHOSWIYZM3M
-
-Note that we do not care about the second returned value (~blocks~) as the ~ipfs-block-reducer~ does not return anything interesting.
-
-** Decoding
-
-To decode using IPFS as block storage we need to specify a function that can dereference blocks from the Blake2b-256 hash code. As IPFS speaks CID we need to translate from raw hash code to CID:
-
-#+BEGIN_SRC scheme
-(define (ipfs-block-ref ref)
- (ipfs-block-get (blake2b-256->cid ref)))
-#+END_SRC
-
-#+RESULTS:
-: #<unspecified>
-
-#+BEGIN_SRC scheme :exports both
-(utf8->string
- (eris-decode->bytevector
- "urn:erisx2:AAAD77QDJMFAKZYH2DXBUZYAP3MXZ3DJZVFYQ5DFWC6T65WSFCU5S2IT4YZGJ7AC4SYQMP2DM2ANS2ZTCP3DJJIRV733CRAAHOSWIYZM3M"
- ipfs-block-ref))
-
-#+END_SRC
-
-#+RESULTS:
-: Hello world!
-
-Hello indeed!
-
-Note that this snippet can be run on any machine running an IPFS daemon and it should be able to decode the content (if the block is still made available by some reachable IPFS node in the network). IPFS takes care of transporting the blocks over network.
-
-** Inspecting blocks
-
-The short string encoded above is encoded in a single block (see the [[http://purl.org/eris][specification]] for details on the encoding).
-
-We can directly get this block from IPFS:
-
-#+BEGIN_SRC scheme :exports both
-(define block
- (ipfs-block-get
- (blake2b-256->cid (read-capability-root-reference read-capability))))
-
-(bytevector-length block)
-#+END_SRC
-
-#+RESULTS:
-: 1024
-
-By default ~eris-encode~ encodes content using block size 1 KiB (1024 bytes). ERIS can also use a block size of 32 KiB, which is more efficient when encoding large pieces of content.
-
-The content of the block is encrypted using a key that is encoded in the read-capability. We can manually decode the content as follows:
-
-#+BEGIN_SRC scheme :exports both
-(use-modules (sodium stream)
- (sodium padding))
-
-(utf8->string
- (sodium-unpad
- (crypto-stream-chacha20-ietf-xor #:message block
- ;; the nonce which is just 12 bytes of zeros
- #:nonce (make-bytevector 12 0)
- ;; the key is encoded in the read-capability
- #:key (read-capability-root-key read-capability))
- #:block-size 1024))
-#+END_SRC
-
-#+RESULTS:
-: Hello world!
-
-For content that does not fit into a single block (larger than 1 KiB) the block referenced in the read capability contains references to further blocks and respective keys to decode the blocks - content is encoded using a tree.
-
-** Larger content
-
-Much larger content can be encoded with ERIS and stored/transported using IPFS.
-
-For example we can encode the first 1 MiB of the ChaCha20 stream:
-
-#+BEGIN_SRC scheme :exports both
-(define larger-content
- (crypto-stream-chacha20-ietf
- ;; 1 MiB
- (* 1024 1024)
- ;; using a null nonce
- (make-bytevector 12 0)
- ;; and a nul key
- (make-bytevector 32 0)))
-
-(bytevector-length larger-content)
-#+END_SRC
-
-
-#+RESULTS:
-: 1048576
-
-We encode this 1 MiB chunk of data using a block size of 32KiB:
-
-#+BEGIN_SRC scheme :exports both
-(define larger-content-read-capability
- (receive (read-capability blocks)
- (eris-encode larger-content
- #:block-reducer ipfs-block-reducer
- #:block-size eris-block-size-large)
- read-capability))
-
-(read-capability->string larger-content-read-capability)
-#+END_SRC
-
-#+RESULTS:
-: urn:erisx2:AEA4LRWEEW73XFM27JFU6NG5FB6OV3TCXCOYMYEHAGYVCDXKI5QJFWINJJD6UMEGXQ4ZX6VQIQDQM2JVDG7FISMECDHVNV6NQKRQ4Y4AHE
-
-This is almost the limit of what are current IPFS bindings can do. For every block we store we open a new HTTP connection (and don't properly close it). The ~large-content~ is encoded with 34 blocks. There is much room to improve the IPFS bindings (e.g. use one single HTTP/2 connection).
-
-Let's verify that we can decode the content as well:
-
-#+BEGIN_SRC scheme :exports both
-(bytevector=?
- larger-content
- (eris-decode->bytevector
- "urn:erisx2:AEA4LRWEEW73XFM27JFU6NG5FB6OV3TCXCOYMYEHAGYVCDXKI5QJFWINJJD6UMEGXQ4ZX6VQIQDQM2JVDG7FISMECDHVNV6NQKRQ4Y4AHE"
- ipfs-block-ref))
-#+END_SRC
-
-#+RESULTS:
-: #t
-
-Woo-hoo!
-
-* Conclusion
-
-We have seen how the IPFS can be used to store and transport ERIS encoded content by using the IPFS Blocks API from the ~guile-eris~ encoding API
-
-I hope this may serve as a demo of the ~guile-eris~ API and spark your interest in experimenting with ERIS.
-
-Some ideas:
-
-- Use a key-value store as storage layer (e.g. LMDB).
-- Use the [[https://github.com/named-data/NFD][Named Data Networking Forwarding Daemon]] for storage and transport.
-- Encode an archive using ERIS (see [[https://git.ngyro.com/disarchive/][disarchive]])
-- Distribute Guix substitutes using ERIS and IPFS (see [[https://issues.guix.gnu.org/33899][Distributing substitutes over IPFS]])
-
-Happy hacking!
diff --git a/guix.scm b/guix.scm
index 9b54b9d..494a526 100644
--- a/guix.scm
+++ b/guix.scm
@@ -9,69 +9,21 @@
(guix git-download)
(guix build-system gnu)
(gnu packages)
- (gnu packages databases)
(gnu packages license)
- (gnu packages crypto)
- (gnu packages autotools)
- (gnu packages guile)
(gnu packages guile-xyz)
- (gnu packages pkg-config)
- (gnu packages ruby)
- (gnu packages texinfo))
-
-(define-public guile-sodium
- (package
- (name "guile-sodium")
- (version "0.1.0")
- (source
- (origin
- (method git-fetch)
- (uri (git-reference
- (url "https://inqlab.net/git/guile-sodium.git")
- (commit (string-append "v" version))))
- (file-name (git-file-name name version))
- (sha256 (base32 "189jsj87hycs57a54x0b9lifwvhr63nypb9vfxdrq7rwrpcvi5f8"))))
- (build-system gnu-build-system)
- (arguments `())
- (native-inputs
- `(("autoconf" ,autoconf)
- ("automake" ,automake)
- ("pkg-config" ,pkg-config)
- ("texinfo" ,texinfo)))
- (inputs `(("guile" ,guile-3.0)))
- (propagated-inputs `(("libsodium" ,libsodium)))
- (synopsis "Guile bindings to the libsodium cryptographic library.")
- (description
- "This package provides Guile bindings to the libsodium cryptographic library
-which provides core cryptographic primitives needed to build higher-level
-tools.")
- (home-page "https://inqlab.net/git/guile-sodium.git")
- (license license:gpl3+)))
+ (gnu packages ruby))
(package
- (name "guile-eris")
+ (name "eris")
(version "0.1")
- (source "./guile-eris-0.1.tar.gz")
+ (source #f)
(build-system gnu-build-system)
(arguments '())
(native-inputs
- `(("autoconf" ,autoconf)
- ("automake" ,automake)
- ("pkg-config" ,pkg-config)
- ("texinfo" ,texinfo)
- ("guile-hall" ,guile-hall)
- ("reuse" ,reuse)
- ("guile-srfi-180" ,guile-srfi-180) ;only for testing
- ("asciidoctor" ,ruby-asciidoctor)))
- (inputs `(("guile" ,guile-3.0)))
- (propagated-inputs
- `(("guile-sodium" ,guile-sodium)
- ("guile-json" ,guile-json)))
- (synopsis
- "Guile implementation of Encoding for Robust Immutable Storage (ERIS)")
- (description
- "guile-eris is the reference implementation of Encoding for Robust Immutable Storage (ERIS). ERIS allows arbirtary content to be encoded into uniformly sized, encrypted blocks that can be reassembled using a short read-capability.")
- (home-page
- "https://gitlab.com/openengiadina/eris")
+ `(("reuse" ,reuse)
+ ("asciidoctor" ,ruby-asciidoctor)
+ ("guile-eris" ,guile-eris)))
+ (synopsis "Specification of Encoding for Robust Immutable Storage (ERIS)")
+ (description #f)
+ (home-page "https://inqlab.net/git/eris.git")
(license license:gpl3+))
-
diff --git a/hall.scm b/hall.scm
deleted file mode 100644
index ec911f1..0000000
--- a/hall.scm
+++ /dev/null
@@ -1,54 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(hall-description
- (name "eris")
- (prefix "guile")
- (version "0.2.0")
- (author "pukkamustard")
- (copyright (2020))
- (synopsis
- "Guile implementation of Encoding for Robust Immutable Storage (ERIS)")
- (description
- "guile-eris is the reference implementation of Encoding for Robust Immutable Storage (ERIS). ERIS allows arbirtary content to be encoded into uniformly sized, encrypted blocks that can be reassembled using a short read-capability.")
- (home-page
- "https://gitlab.com/openengiadina/eris")
- (license gpl3+)
- (dependencies `(("guile-sodium" ,guile-sodium)
- ("guile-srfi-180" ,guile-srfi-180)))
- (files (libraries
- ((scheme-file "eris")
- (directory "eris" ((scheme-file "encode")
- (scheme-file "decode")
- (scheme-file "read-capability")
- (scheme-file "ipfs")
- (directory
- "utils"
- ((scheme-file "padding")
- (scheme-file "base32")
- (scheme-file "rbytevector")))))))
- (tests ((directory
- "tests"
- ((directory "eris"
- ((scheme-file "test-vectors")
- (scheme-file "large")
- (scheme-file "pseudo-random")))))))
- (programs ())
- (documentation
- ((org-file "README")
- (symlink "README" "README.org")
- (text-file "HACKING")
- (directory "doc" ((texi-file "eris")))
- (text-file "NEWS")
- (text-file "AUTHORS")
- (text-file "ChangeLog")))
- (infrastructure
- ((scheme-file "guix")
- (scheme-file "hall")
- (directory
- "build-aux"
- ((scheme-file "test-driver")))
- (autoconf-file "configure")
- (automake-file "Makefile")
- (in-file "pre-inst-env")))))
diff --git a/pre-inst-env.in b/pre-inst-env.in
deleted file mode 100644
index 1556fcd..0000000
--- a/pre-inst-env.in
+++ /dev/null
@@ -1,14 +0,0 @@
-
-#!/bin/sh
-
-abs_top_srcdir="`cd "@abs_top_srcdir@" > /dev/null; pwd`"
-abs_top_builddir="`cd "@abs_top_builddir@" > /dev/null; pwd`"
-
-GUILE_LOAD_COMPILED_PATH="$abs_top_builddir${GUILE_LOAD_COMPILED_PATH:+:}$GUILE_LOAD_COMPILED_PATH"
-GUILE_LOAD_PATH="$abs_top_builddir:$abs_top_srcdir${GUILE_LOAD_PATH:+:}:$GUILE_LOAD_PATH"
-export GUILE_LOAD_COMPILED_PATH GUILE_LOAD_PATH
-
-PATH="$abs_top_builddir/scripts:$PATH"
-export PATH
-
-exec "$@"
diff --git a/scripts/generate-test-vectors.scm b/scripts/generate-test-vectors.scm
deleted file mode 100644
index 3f91926..0000000
--- a/scripts/generate-test-vectors.scm
+++ /dev/null
@@ -1,135 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(use-modules (eris utils test-vector)
-
- (sodium stream)
- (sodium generichash)
-
- (ice-9 format)
-
- (rnrs bytevectors)
- (srfi srfi-180))
-
-(define null-convergence-secret (make-bytevector 32 0))
-(define block-size-small 1024)
-(define block-size-large (* 32 1024))
-(define null-nonce (make-bytevector 12 0))
-
-(define* (pseudo-random-bytevector length #:key (seed "Hell world!"))
- "Generate pseudo random bytevectors with ChaCha20"
- (crypto-stream-chacha20-ietf length
- null-nonce
- (crypto-generichash (string->utf8 seed) #:out-len 32)))
-
-(define (test-vector-write-json-file test-vector)
- (call-with-output-file (string-append "test-vectors/eris-test-vector-"
- (format #f "~2,'0d" (test-vector-id test-vector))
- ".json")
- (lambda (port) (json-write (test-vector->obj test-vector) port))))
-
-(test-vector-write-json-file
- (make-test-vector 0
- "short string (block size 1KiB)"
- "Encode the UTF-8 encoding of the string \"Hello world!\" with block-size 1KiB and null convergence-secret."
- (string->utf8 "Hello world!")
- null-convergence-secret
- block-size-small))
-
-(test-vector-write-json-file
- (make-test-vector 1
- "short string (block size 32KiB)"
- "Encode the UTF-8 encoding of the string \"Hello world!\" with block-size 32KiB and null convergence-secret."
- (string->utf8 "Hello world!")
- null-convergence-secret
- block-size-large))
-
-(test-vector-write-json-file
- (make-test-vector 2
- "1023 byte null string (block size 1KiB)"
- "Encode 1023 bytes of zeroes using block-size 1KiB. This results in a single block."
- (make-bytevector 1023 0)
- null-convergence-secret
- block-size-small))
-
-(test-vector-write-json-file
- (make-test-vector 3
- "1024 byte null string (block size 1KiB)"
- "Encode exactly 1KiB of zeroes using block-size 1KiB. Padding will cause an additional content block to be created."
- (make-bytevector 1024 0)
- null-convergence-secret
- block-size-small))
-
-(test-vector-write-json-file
- (make-test-vector 4
- "16383 byte null string (block size 1KiB)"
- "Encode 16383 bytes of random content using block-size 1KiB."
- (pseudo-random-bytevector 16383)
- null-convergence-secret
- block-size-small))
-
-(test-vector-write-json-file
- (make-test-vector 5
- "16384 byte null string (block size 1KiB)"
- "Encode 16384 bytes of random content using block-size 1KiB. This is the cutoff where 2 levels of nodes are necessary."
- (pseudo-random-bytevector 16384)
- null-convergence-secret
- block-size-small))
-
-
-(test-vector-write-json-file
- (make-test-vector 6
- "4096 byte null string (block size 1KiB)"
- "Encode 4096 bytes of zeroes using block-size 1KiB. This results in only 3 distinct blocks as 4 content blocks have identical content and are de-duplicated."
- (make-bytevector 4096 0)
- null-convergence-secret
- block-size-small))
-
-(test-vector-write-json-file
- (make-test-vector 7
- "32767 byte null string (block size 32KiB)"
- "Encode 32767 bytes of zeroes using block-size 32KiB. This results in a single block."
- (make-bytevector 32767 0)
- null-convergence-secret
- block-size-large))
-
-(test-vector-write-json-file
- (make-test-vector 8
- "32KiB null string (block size 32KiB)"
- "Encode exactly 32KiB of zeroes using block-size 32KiB. Padding will cause an additional block to be created."
- (make-bytevector 32768 0)
- null-convergence-secret
- block-size-large))
-
-(test-vector-write-json-file
- (make-test-vector 9
- "short string (block size 1KiB, non-null convergence-secret)"
- "Encode the UTF-8 encoding of the string \"Hello world!\" with block-size 1KiB and non-null convergence-secret."
- (string->utf8 "Hello world!")
- (pseudo-random-bytevector 32)
- block-size-small))
-
-(test-vector-write-json-file
- (make-test-vector 10
- "short string (block size 32KiB, non-null convergence-secret)"
- "Encode the UTF-8 encoding of the string \"Hello world!\" with block-size 32KiB and non-null convergence-secret."
- (string->utf8 "Hello world!")
- (pseudo-random-bytevector 32)
- block-size-large))
-
-(test-vector-write-json-file
- (make-test-vector 11
- "1Mb of content (block size 1KiB)"
- "Encode 1Mb of non-zero content using block-size 1KiB and null convergence-secret."
- (pseudo-random-bytevector (* 1024 1024))
- null-convergence-secret
- block-size-small))
-
-(test-vector-write-json-file
- (make-test-vector 12
- "1Mb of content (block size 32KiB)"
- "Encode 1Mb of non-zero content using block-size 32KiB and null convergence-secret."
- (pseudo-random-bytevector (* 1024 1024))
- null-convergence-secret
- block-size-large))
diff --git a/tests/eris/large.scm b/tests/eris/large.scm
deleted file mode 100644
index 9c2e535..0000000
--- a/tests/eris/large.scm
+++ /dev/null
@@ -1,89 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (tests eris large)
- #:use-module (eris encode)
- #:use-module (eris read-capability)
-
- #:use-module (sodium stream)
- #:use-module (sodium generichash)
-
- #:use-module (rnrs bytevectors)
-
- #:use-module (srfi srfi-64)
- #:use-module (srfi srfi-171))
-
-
-(define* (crypto-stream-chacha20-ietf-generator #:key block-size nonce key (ic 0))
- "Returns a generator that emits the ChaCha20 stream"
- (let ( ;; XOR with null byte sequence to get the ChaCha20 stream
- (message (make-bytevector block-size 0))
- ;; Internal block size of ChaCha20 is 64 bytes, increment by ic-increment every invocation
- (ic-increment (/ block-size 64)))
- (lambda ()
- (let ((c (crypto-stream-chacha20-ietf-xor-ic #:message message #:nonce nonce #:ic ic #:key key)))
- (set! ic (+ ic ic-increment))
- c))))
-
-(define null-nonce (make-bytevector 12 0))
-(define null-convergence-secret (make-bytevector 32 0))
-
-(define* (size->block-count size #:key (block-size 32768))
- (/ size block-size))
-
-(test-begin "eris (large)")
-
-(test-equal "100MiB (block size 1KiB)"
- "urn:erisx2:AACXPZNDNXFLO4IOMF6VIV2ZETGUJEUU7GN4AHPWNKEN6KJMCNP6YNUMVW2SCGZUJ4L3FHIXVECRZQ3QSBOTYPGXHN2WRBMB27NXDTAP24"
- (read-capability->string
- (car
- (generator-transduce
- (compose (ttake (size->block-count (* 1024 1024 100) #:block-size 1024))
- (eris-encode-transducer #:convergence-secret null-convergence-secret
- #:block-size 1024)
- (tfilter read-capability?))
- rcons
- ;; Generate a stream of random blocks using the ChaCha20 stream
- (crypto-stream-chacha20-ietf-generator
- #:block-size 1024
- #:nonce null-nonce
- #:key (crypto-generichash (string->utf8 "100MiB (block size 1KiB)"))
- #:ic 0)))))
-
-(test-equal "1GiB (block size 32KiB)"
- "urn:erisx2:AEBFG37LU5BM5N3LXNPNMGAOQPZ5QTJAV22XEMX3EMSAMTP7EWOSD2I7AGEEQCTEKDQX7WCKGM6KQ5ALY5XJC4LMOYQPB2ZAFTBNDB6FAA"
- (read-capability->string
- (car
- (generator-transduce
- (compose (ttake (size->block-count (* 1024 1024 1024)))
- (eris-encode-transducer #:convergence-secret null-convergence-secret
- #:block-size 32768)
- (tfilter read-capability?))
- rcons
- ;; Generate a stream of random blocks using the ChaCha20 stream
- (crypto-stream-chacha20-ietf-generator
- #:block-size 32768
- #:nonce null-nonce
- #:key (crypto-generichash (string->utf8 "1GiB (block size 32KiB)"))
- #:ic 0)))))
-
-;; This test takes almost 20 minutes on my machine. Nice to run once in a while, not always.
-;; (test-equal "256GiB (block size 32KiB)"
-;; "urn:erisx2:AEBZHI55XJYINGLXWKJKZHBIXN6RSNDU233CY3ELFSTQNSVITBSVXGVGBKBCS4P4M5VSAUOZSMVAEC2VDFQTI5SEYVX4DN53FTJENWX4KU"
-;; (read-capability->string
-;; (car
-;; (generator-transduce
-;; (compose (ttake (size->block-count (* 1024 1024 1024 256)))
-;; (eris-encode-transducer #:convergence-secret null-convergence-secret
-;; #:block-size 32768)
-;; (tfilter read-capability?))
-;; rcons
-;; ;; Generate a stream of random blocks using the ChaCha20 stream
-;; (crypto-stream-chacha20-ietf-generator
-;; #:block-size 32768
-;; #:nonce null-nonce
-;; #:key (crypto-generichash (string->utf8 "256GiB (block size 32KiB)"))
-;; #:ic 0)))))
-
-(test-end "eris (large)")
diff --git a/tests/eris/pseudo-random.scm b/tests/eris/pseudo-random.scm
deleted file mode 100644
index 6b6205f..0000000
--- a/tests/eris/pseudo-random.scm
+++ /dev/null
@@ -1,95 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (tests eris pseudo-random)
- #:use-module (eris)
- #:use-module (eris read-capability)
-
- #:use-module (sodium stream)
- #:use-module (sodium generichash)
-
- #:use-module (rnrs bytevectors)
- #:use-module (rnrs io ports)
-
- #:use-module (srfi srfi-11)
- #:use-module (srfi srfi-64)
- #:use-module (srfi srfi-171))
-
-(define null-nonce (make-bytevector 12 0))
-(define null-convergence-secret (make-bytevector 32 0))
-
-(define* (pseudo-random-bytevector length #:key (seed "Encoding for Robust Immutable Storage"))
- (crypto-stream-chacha20-ietf #:clen length
- #:nonce null-nonce
- #:key (crypto-generichash (string->utf8 seed) #:out-len 32)))
-(define content-sizes-small
- (list 0
- 1
- 8
- 32
- 1023
- 1024
- (* 10 1024)
- (* 32 1024)
- (* 1024 1024)))
-
-(test-begin "eris (pseudo-random, 1KiB block-size)")
-
-(for-each
- (lambda (l)
-
- (let ((bv (pseudo-random-bytevector l)))
-
- (let-values (((urn blocks) (eris-encode bv
- #:block-reducer rcons
- #:convergence-secret null-convergence-secret
- #:block-size eris-block-size-small)))
-
- (test-assert "decoded bytevector is same as initial bytevector"
- (bytevector=?
- bv
- (eris-decode->bytevector
- (read-capability->string urn)
- (lambda (ref) (assoc-ref blocks ref))))))))
-
- content-sizes-small)
-
-(test-end "eris (pseudo-random, 1KiB block-size)")
-
-(define content-sizes-large
- (list 0
- 1
- 8
- 32
- 1023
- 1024
- 424242
- 31230924
- (* 10 1024)
- (* 32 1024)
- (* 1024 1024)
- (* 1024 1024 32)
- (* 1024 1024 100)))
-(test-begin "eris (pseudo-random, 32KiB block-size)")
-
-(for-each
- (lambda (l)
-
- (let ((bv (pseudo-random-bytevector l)))
-
- (let-values (((urn blocks) (eris-encode bv
- #:block-reducer rcons
- #:convergence-secret null-convergence-secret
- #:block-size eris-block-size-large)))
-
- (test-assert "decoded bytevector is same as initial bytevector"
- (bytevector=?
- bv
- (eris-decode->bytevector
- (read-capability->string urn)
- (lambda (ref) (assoc-ref blocks ref))))))))
-
- content-sizes-large)
-
-(test-end "eris (pseudo-random, 32KiB block-size)")
diff --git a/tests/eris/test-vectors.scm b/tests/eris/test-vectors.scm
deleted file mode 100644
index 0d2d8f4..0000000
--- a/tests/eris/test-vectors.scm
+++ /dev/null
@@ -1,54 +0,0 @@
-; SPDX-FileCopyrightText: 2020 pukkamustard <pukkamustard@posteo.net>
-;
-; SPDX-License-Identifier: GPL-3.0-or-later
-
-(define-module (tests eris test-vectors)
- #:use-module (eris)
- #:use-module (eris utils test-vector)
- #:use-module (eris utils base32)
-
- #:use-module (ice-9 ftw)
-
- #:use-module (rnrs bytevectors)
- #:use-module (rnrs io ports)
-
- #:use-module (srfi srfi-64)
- #:use-module (srfi srfi-180))
-
-(define test-vector-directory "./test-vectors/")
-
-(define test-vector-file-names (filter
- (lambda (filename)
- (and (string-prefix? "eris-test-vector-" filename)
- (equal? (string-take-right filename 5)
- ".json")))
- (scandir test-vector-directory)))
-
-(define (read-test-vector filename)
- (call-with-input-file (string-append test-vector-directory filename)
- (lambda (port) (obj->test-vector (json-read port)))))
-
-(test-begin "eris (test-vectors)")
-
-(for-each
- (lambda (test-vector-file-name)
- (let ((test-vector (read-test-vector test-vector-file-name)))
-
- (display test-vector-file-name)
-
- (test-equal "content encodes to specified URN"
- (test-vector-urn test-vector)
- (eris-encode->urn (test-vector-content test-vector)
- #:convergence-secret (test-vector-convergence-secret test-vector)
- #:block-size (test-vector-block-size test-vector)))
-
- (test-assert "content can be decoded from blocks and URN"
- (bytevector=? (test-vector-content test-vector)
- (eris-decode->bytevector (test-vector-urn test-vector)
- (lambda (ref)
- (base32-decode (assoc-ref (test-vector-blocks test-vector)
- (string->symbol (base32-encode ref))))))))))
-
- test-vector-file-names)
-
-(test-end "eris (test-vectors)")