pax_global_header00006660000000000000000000000064127704654340014526gustar00rootroot0000000000000052 comment=e499f898c9cd904380a59a2d980f42f8bf11269b adasockets-1.10.1/000077500000000000000000000000001277046543400137275ustar00rootroot00000000000000adasockets-1.10.1/.gitignore000066400000000000000000000032241277046543400157200ustar00rootroot00000000000000*~ Makefile.in Makefile aclocal.m4 autom4te.cache/ configure src/config.h.in support/config.guess support/config.sub support/install-sh support/libtool.m4 support/ltmain.sh support/ltoptions.m4 support/ltsugar.m4 support/ltversion.m4 support/lt~obsolete.m4 support/mdate-sh support/missing support/compile Makefile Makefile.in aclocal.m4 autom4te.cache/output.0 autom4te.cache/output.1 autom4te.cache/output.2 autom4te.cache/requests autom4te.cache/traces.0 autom4te.cache/traces.1 autom4te.cache/traces.2 config.log config.status doc/Makefile doc/Makefile.in examples/Makefile examples/Makefile.in libtool man/Makefile man/Makefile.in src/Makefile src/Makefile.in src/config.h src/config.h.in src/sockets-link.ads src/sockets-types.ads src/stamp-h1 support/config.guess support/config.sub support/install-sh support/libtool.m4 support/ltmain.sh support/ltoptions.m4 support/ltsugar.m4 support/ltversion.m4 support/lt~obsolete.m4 support/mdate-sh support/missing support/test-driver b~*.* *.o *.lo *.ali *.la .*.swp doc/adasockets.aux doc/adasockets.cp doc/adasockets.cps doc/adasockets.ct doc/adasockets.dvi doc/adasockets.ex doc/adasockets.fn doc/adasockets.info doc/adasockets.ky doc/adasockets.log doc/adasockets.pdf doc/adasockets.pg doc/adasockets.toc doc/adasockets.tp doc/adasockets.vr doc/sockets-multicast.texi doc/sockets-naming.texi doc/sockets.texi doc/stamp-vti doc/version.texi examples/listener examples/multi examples/stream_listener examples/stream_sender examples/tcprelay src/constants_nodef src/sockets-constants.ads src/sockets-thin.ads src/split src/.libs ChangeLog adasockets-*.tar.gz src/adasockets.pc tests/multicast_test tests/value tests/*.log tests/*.trs adasockets-1.10.1/.travis.yml000066400000000000000000000002001277046543400160300ustar00rootroot00000000000000language: c sudo: false addons: apt: packages: - gnat - texinfo - texlive script: support/test-build.sh adasockets-1.10.1/AUTHORS.md000066400000000000000000000002031277046543400153710ustar00rootroot00000000000000AdaSockets has been written by Samuel Tardieu with the contribution of many users. WWW: http://www.rfc1149.net/ adasockets-1.10.1/COPYING000066400000000000000000000431271277046543400147710ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) 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 this service 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. 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. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the 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 a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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. 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 convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy 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 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, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19yy name of author Gnomovision 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, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This 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 Library General Public License instead of this License. adasockets-1.10.1/GMGPL000066400000000000000000000020341277046543400145170ustar00rootroot00000000000000AdaSockets is free software; you can redistribute it and/or modify it under terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. AdaSockets 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 distributed with AdaSockets; see file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. As a special exception, if other files instantiate generics from this unit, or you link this unit with other files to produce an executable, this unit does not by itself cause the resulting executable to be covered by the GNU General Public License. This exception does not however invalidate any other reasons why the executable file might be covered by the GNU Public License. adasockets-1.10.1/INSTALL.md000066400000000000000000000021251277046543400153570ustar00rootroot00000000000000# Installing AdaSockets ## Building on Unix or Cygwin/Windows ``` % ./configure --prefix= % make install ``` This will build and install this software under **`/lib/adasockets`. The `adasockets-config` program and its associated man page will be installed respectively under **`/bin` and **`/man/`. In the examples subdirectory, you will find an example called `tcprelay` which illustrates how this package can be used. GNU make is not strictly necessary but is recommended. It is needed if you want to rebuild the documentation. You need to install the autogen software if you want to rebuild the documentation. You also need the autotools if you plan on modifying the AdaSockets build structure. ## Building on OpenVMS ``` % make ``` GNU make must be available as well as the DEC C compiler. If no C compiler is available on your system, the file `sockets-constants.ads` in the `contrib/vms` directory must be copied into the `vms` one. This file is given as is and has not been tested on other host than the one used to port AdaSockets. adasockets-1.10.1/Makefile.VMS000066400000000000000000000006171277046543400160370ustar00rootroot00000000000000# Main Makefile.VMS # # $Revision$ # # # This file is part of adasockets port on OpenVMS # .PHONY: all clean distclean .DEFAULT: all all: make "-C" [.vms] all make "-C" [.src] all make "-C" [.examples] all clean: make "-C" [.vms] clean make "-C" [.src] clean make "-C" [.examples] clean distclean: make "-C" [.vms] distclean make "-C" [.src] distclean make "-C" [.examples] distclean adasockets-1.10.1/Makefile.am000066400000000000000000000020041277046543400157570ustar00rootroot00000000000000AUTOMAKE_OPTIONS = foreign no-dependencies ACLOCAL_AMFLAGS = -I support AUTOHEADER_AMFLAGS = -l support SUBDIRS = src man tests $(SUBDIRS_DOC) $(SUBDIRS_EXAMPLES) if BUILD_DOC SUBDIRS_DOC = doc else SUBDIRS_DOC = endif if BUILD_EXAMPLES SUBDIRS_EXAMPLES = examples else SUBDIRS_EXAMPLES = endif EXTRA_DIST = AUTHORS.md COPYING GMGPL INSTALL.md README.md README-RTEMS.md \ rtems/ChangeLog rtems/create_constants_c.sh rtems/Makefile.RTEMS \ rtems/README rtems/rtems_main.c rtems/sockets-constants-rtems.ads \ ChangeLog Makefile.VMS \ contrib/vms/README contrib/vms/sockets-constants.ads \ contrib/win32/adasockets/build.bat contrib/win32/adasockets/clean.bat \ contrib/win32/adasockets/Readme.txt contrib/win32/distr \ contrib/win32/Readme.txt \ support/adacompiler \ vms/constants.c_pre vms/constants.list vms/create_constants_ads.com \ vms/create_constants_c.com vms/Makefile.VMS CLEANFILES = ChangeLog ChangeLog: never (cd ${srcdir} && support/git2cl) > ChangeLog never:: version: @echo $(PACKAGE)-$(VERSION) adasockets-1.10.1/README-RTEMS.md000066400000000000000000000043211277046543400160760ustar00rootroot00000000000000# Building AdaSockets to target RTEMS. Prerequisites ============= Build and install a working GNAT/RTEMS toolset and a BSP. Make sure networking and POSIX are enabled. Detailed instructions are available online in the RTEMS Wiki at: http://www.rtems.org/wiki/index.php/RTEMSAda Run at least one sample from the RTEMS build (e.g. `hello.exe` or `sample.exe`) to confirm that RTEMS itself was properly built. Build and run the RTEMS `hello_world_ada` from the `ada-examples` package using your GNAT/RTEMS development environment. If everything is working at this point, then you are ready to build AdaSockets. Generate `sockets-constants.ads` ================================ Subdirectory: `rtems` We will use the RTEMS you installed to build and run a program called `constants.exe`. The output of this program needs to be saved as `sockets-constants.ads`. To compile this program use the `Makefile.RTEMS`. ``` % RTEMS_MAKEFILE_PATH=install_path_of_BSP make -f Makefile.RTEMS ``` Then run the program `o-optimize/constants.exe` on the target hardware. Your saved target board output may end up with DOS style CR/LF's. Run `dos2unix` on the file to get it back to Unix style. There is a version of this file generated using `psim` using a pre-4.8 CVS snapshot of RTEMS which should work on any target. You can use this but you would be safer to generate your own. Consider it an example of how it should look when it works. Building AdaSockets =================== Subdirectory: `src` Now that you have a `sockets-constants.ads`, we can build the AdaSockets library. `Makefile.adasockets` is provided for this step: ``` % RTEMS_MAKEFILE_PATH=install_patch_of_BSP make -f Makefile.RTEMS ``` After the library is compiled, it may be installed using the following: ``` % RTEMS_MAKEFILE_PATH=install_patch_of_BSP make -f Makefile.RTEMS install ``` Building examples ================= Subdirectory: `examples` After building the sockets package, build the examples the same way ``` % RTEMS_MAKEFILE_PATH=install_patch_of_BSP make -f Makefile.RTEMS ``` BUGS: - stream_listener core dumps if the endian of the `stream_sender` is not the same as the listener. - multicast does not yet work. This is probably an RTEMS issue. adasockets-1.10.1/README.md000066400000000000000000000036171277046543400152150ustar00rootroot00000000000000README file for adasockets. AdaSockets is a medium binding (it is not a thin binding because it uses Ada types and not a thick binding because you have the same subprogram names as in C) for using BSD-style sockets in Ada. Since the original release, I have been adding multicast and fixed some bugs. However, it is likely that others remain. To use AdaSockets with gnatmake once installed, type: % gnatmake `adasockets-config` ... The `adasockets-config` part will add the correct options to gnatmake command line. AdaSockets is free software; you can redistribute it and/or modify it under terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. AdaSockets 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 distributed with AdaSockets; see file COPYING. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. As a special exception, if other files instantiate generics from this unit, or you link this unit with other files to produce an executable, this unit does not by itself cause the resulting executable to be covered by the GNU General Public License. This exception does not however invalidate any other reasons why the executable file might be covered by the GNU Public License. The main repository for this software is located at: http://www.rfc1149.net/devel/adasockets Please report any issues or address any question to the issues tracker on GitHub, located at: https://github.com/samueltardieu/adasockets/issues The author, Samuel Tardieu adasockets-1.10.1/configure.ac000066400000000000000000000063771277046543400162320ustar00rootroot00000000000000AC_INIT([adasockets], [1.10.1]) AC_CONFIG_SRCDIR([src/sockets.ads]) AC_CONFIG_AUX_DIR([support]) AC_CONFIG_MACRO_DIR([support]) AM_INIT_AUTOMAKE AM_CONFIG_HEADER(src/config.h) # # Package description # LIBVERSIONINFO=1:0:0 AC_SUBST(LIBVERSIONINFO) AM_PROG_LIBTOOL # AC_CHECK_PROGS(AWK, [gnuawk gawk awk]) # # Check for maintainer mode # AC_ARG_VAR(ADAFLAGS,[Ada compiler flags]) AC_ARG_ENABLE(maintainer-mode, AS_HELP_STRING(--enable-maintainer-mode,turn on debugging options), [ADAFLAGS="-g -O2 -Wall -Werror -gnatag -gnatwa -gnatwe $ADAFLAGS"], [ADAFLAGS="-O2 -gnatpng $ADAFLAGS"]) # # Check for documentation build and installation # AC_ARG_ENABLE(doc, AS_HELP_STRING(--disable-doc,do not build and install documentation), [case "${enableval}" in yes) doc=true ;; no) doc=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-doc) ;; esac],[doc=true]) AM_CONDITIONAL(BUILD_DOC, test x$doc = xtrue) # # Check for examples build and installation # AC_ARG_ENABLE(examples, AS_HELP_STRING(--disable-examples,do not build and install examples), [case "${enableval}" in yes) examples=true ;; no) examples=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-examples) ;; esac],[examples=true]) AM_CONDITIONAL(BUILD_EXAMPLES, test x$examples = xtrue) # # Check for documentation software # AC_CHECK_PROG(GETDEFS, getdefs, getdefs) AC_CHECK_PROG(MAKEINFO, makeinfo, makeinfo) AC_CHECK_PROG(TEXI2DVI, texi2dvi, texi2dvi) # # Look for the C compiler # AC_PROG_CC # # Look for the Ada compiler # AC_CHECK_PROG([GNATMAKE], [gnatmake], [gnatmake]) if test -z "$GNATMAKE"; then AC_MSG_ERROR([unable to find gnatmake]) fi # # Libtool checks # AC_PROG_LIBTOOL # # Test for -lnsl, -lsocket and -lresolv # AC_CHECK_FUNC(gethostbyname,NSLNEEDED="-- ", AC_CHECK_LIB(nsl,gethostbyname,,NSLNEEDED="-- ")) AC_SUBST(NSLNEEDED) AC_CHECK_FUNC(connect,SOCKETNEEDED="-- ", AC_CHECK_LIB(socket,connect,,SOCKETNEEDED="-- ")) AC_SUBST(SOCKETNEEDED) AC_CHECK_FUNC(inet_aton,RESOLVNEEDED="-- ", AC_CHECK_LIB(resolv,inet_aton,,RESOLVNEEDED="-- ")) AC_SUBST(RESOLVNEEDED) # # Extra libraries # AC_ARG_WITH(extra-libs, [ --with-extra-libs=libs Add extra libraries when building a program], [EXTRA_LIBS="${withval}"]) AC_SUBST(EXTRA_LIBS) # # Header files # AC_CHECK_HEADERS([stdio.h sys/types.h sys/socket.h errno.h netdb.h stdlib.h]) AC_CHECK_HEADERS([netinet/in.h signal.h fcntl.h termio.h termios.h sys/file.h]) AC_CHECK_HEADERS([sys/ioctl.h netinet/tcp.h sys/systeminfo.h poll.h stropts.h]) AC_CHECK_HEADERS([sys/conf.h sys/param.h time.h windows.h string.h linux/sockios.h]) AC_CHECK_HEADERS(windows.h, [usewin32=true useunix=false], [usewin32=false useunix=true]) # # sa_len field ? # AC_CHECK_MEMBER(struct sockaddr.sa_len,[SA_LEN="" NO_SA_LEN="-- "],[SA_LEN="-- " NO_SA_LEN=""],[#include AC_SUBST(SA_LEN) AC_SUBST(NO_SA_LEN) #include ]) # # Conditional import for Win32 and substitution # AM_CONDITIONAL(WIN32, $usewin32) if $useunix; then WINNEEDED="-- " fi AC_SUBST(WINNEEDED) # # Output # AC_CONFIG_FILES([Makefile src/Makefile src/sockets-link.ads src/sockets-types.ads src/adasockets.pc man/Makefile examples/Makefile doc/Makefile tests/Makefile]) AC_OUTPUT adasockets-1.10.1/contrib/000077500000000000000000000000001277046543400153675ustar00rootroot00000000000000adasockets-1.10.1/contrib/vms/000077500000000000000000000000001277046543400161745ustar00rootroot00000000000000adasockets-1.10.1/contrib/vms/README000066400000000000000000000003631277046543400170560ustar00rootroot00000000000000The file sockets-constants.ads is usually produced by compiling a small C program that dumps several network and system constants. However, as I assumed every body doesn't have a C compiler installed, I put here the file generated on my host. adasockets-1.10.1/contrib/vms/sockets-constants.ads000066400000000000000000000071251277046543400223570ustar00rootroot00000000000000-- This file has been generated automatically by -- CREATE_CONSTANTS_ADS.COM. -- -- This file is part of adasockets port to OpenVMS -- package sockets.constants is Tcp_Nodelay : constant := 16#0001#; Af_Inet : constant := 16#0002#; Af_Unix : constant := 16#0001#; Sock_Stream : constant := 16#0001#; Sock_Dgram : constant := 16#0002#; Eintr : constant := 16#0004#; Eagain : constant := 16#000B#; Ewouldblock : constant := 16#0023#; Einprogress : constant := 16#0024#; Ealready : constant := 16#0025#; Eisconn : constant := 16#0038#; Econnrefused : constant := 16#003D#; Fndelay : constant := -1; Fasync : constant := -1; Fioasync : constant := -2147195267; F_Getfl : constant := -1; F_Setfl : constant := -1; F_Setown : constant := -1; Fiossaioown : constant := -1; So_Rcvbuf : constant := 16#1002#; So_Reuseaddr : constant := 16#0004#; So_Reuseport : constant := 16#0200#; Sol_Socket : constant := 16#FFFF#; Sigterm : constant := 16#000F#; Sigkill : constant := 16#0009#; O_Rdonly : constant := -1; O_Wronly : constant := -1; O_Rdwr : constant := 16#0002#; Host_Not_Found : constant := 16#0001#; Try_Again : constant := 16#0002#; No_Recovery : constant := 16#0003#; No_Data : constant := 16#0004#; No_Address : constant := 16#0004#; Pollin : constant := 16#00C7#; Pollpri : constant := 16#0008#; Pollout : constant := 16#0300#; Pollerr : constant := -1; Pollhup : constant := 16#0010#; Pollnval : constant := -1; I_Setsig : constant := -1; S_Rdnorm : constant := -1; S_Wrnorm : constant := -1; Ipproto_Ip : constant := 16#0000#; Ip_Add_Membership : constant := 16#000C#; Ip_Multicast_Loop : constant := 16#000B#; Ip_Multicast_Ttl : constant := 16#000A#; Ip_Drop_Membership : constant := 16#000D#; O_Nonblock : constant := 16#20000#; Msg_Peek : constant := 16#0002#; Fionbio : constant := -2147195266; Fionread : constant := 16#4004667F#; So_Sndbuf : constant := 16#1001#; Af_Inet6 : constant := -1; Ai_Addrconfig : constant := -1; Ai_All : constant := -1; Ai_Canonname : constant := -1; Ai_Default : constant := -1; Ai_Mask : constant := -1; Ai_Numerichost : constant := -1; Ai_Passive : constant := -1; Ai_V4mapped : constant := -1; Ai_V4mapped_Cfg : constant := -1; Ni_Dgram : constant := -1; Ni_Maxhost : constant := -1; Ni_Maxserv : constant := -1; Ni_Namereqd : constant := -1; Ni_Nofqdn : constant := -1; Ni_Numerichost : constant := -1; Ni_Numericserv : constant := -1; Ni_Withscopeid : constant := -1; Ipproto_Ipv6 : constant := -1; Ipv6_Unicast_Hops : constant := -1; Ipv6_Multicast_If : constant := -1; Ipv6_Multicast_Hops : constant := -1; Ipv6_Multicast_Loop : constant := -1; Ipv6_Join_Group : constant := -1; Ipv6_Leave_Group : constant := -1; end sockets.constants; adasockets-1.10.1/contrib/win32/000077500000000000000000000000001277046543400163315ustar00rootroot00000000000000adasockets-1.10.1/contrib/win32/Readme.txt000066400000000000000000000012421277046543400202660ustar00rootroot00000000000000This directory containts files to create a simple installation only for win32 platform. The users of the installation would not have to have any unix command tool for Windows to build the library. The shell script ./distr achives the subset of win32 sources with batch file for compilation to the adasockets.tgz archive. You should call it from the current directory. AdaSockets should be already maked under the Win32 platform as a regular process under the any unix command tools. For example cygwin http://cygwin.com/ ATTENTION: For the cygwin unit command tools. gcc should be used from GNAT installation, but make utility should be used from the cygwin installation.adasockets-1.10.1/contrib/win32/adasockets/000077500000000000000000000000001277046543400204525ustar00rootroot00000000000000adasockets-1.10.1/contrib/win32/adasockets/Readme.txt000066400000000000000000000002711277046543400224100ustar00rootroot00000000000000It is subset and spetial files of AdaSockets library for Win32 platforms. call the build.bat to build the library and examples. call the clean.bat to remove files created in build.adasockets-1.10.1/contrib/win32/adasockets/build.bat000066400000000000000000000010471277046543400222430ustar00rootroot00000000000000echo with > tmp_make.adb echo sockets, >> tmp_make.adb echo sockets.multicast, >> tmp_make.adb echo sockets.stream_io, >> tmp_make.adb echo sockets.naming; >> tmp_make.adb echo procedure Tmp_Make is >> tmp_make.adb echo begin >> tmp_make.adb echo null; >> tmp_make.adb echo end; >> tmp_make.adb set ADA_OBJECTS_PATH= set ADA_INCLUDE_PATH= gnatmake -c -O2 tmp_make del tmp_make.* attrib +r *.ali cd examples gnatmake -I../ multi gnatmake -I../ stream_sender gnatmake -I../ stream_listener gnatmake -I../ tcprelay gnatmake -I../ listener adasockets-1.10.1/contrib/win32/adasockets/clean.bat000066400000000000000000000000751277046543400222260ustar00rootroot00000000000000attrib -r *.ali del /S *.ali del /S *.o del examples\*.exeadasockets-1.10.1/contrib/win32/distr000066400000000000000000000003151277046543400174000ustar00rootroot00000000000000#! /bin/sh cp ../../src/sockets*.ad? adasockets (if ! [ -e adasockets/examples ]; then mkdir adasockets/examples; fi) cp ../../examples/*.adb adasockets/examples/ tar czf adasockets.tgz adasockets/* adasockets-1.10.1/doc/000077500000000000000000000000001277046543400144745ustar00rootroot00000000000000adasockets-1.10.1/doc/Makefile.am000066400000000000000000000030241277046543400165270ustar00rootroot00000000000000info_TEXINFOS = adasockets.texi adasockets_TEXINFOS = sockets.texi sockets-multicast.texi sockets-naming.texi ADADOC_ARGS = --subblock=arg=argname,argmode,argtype,argdefault,argdesc \ --subblock=ret=rettype,retdesc \ --subblock=exc=excname,excdesc \ --template=${srcdir}/adadoc DISTCLEANFILES = *.defs ${adasockets_TEXINFOS} stamp-vti version.texi CLEANFILES = adasockets.aux adasockets.cp adasockets.cps adasockets.fn adasockets.fns adasockets.info adasockets.log adasockets.toc EXTRA_DIST = adasockets.pdf \ ${info_TEXINFOS} ${adasockets_TEXINFOS} \ adadoc.tpl sockets.desc sockets-multicast.desc \ sockets-naming.desc docdir = ${prefix}/share/doc/adasockets doc_DATA = adasockets.pdf adasockets.info: ${srcdir}/adasockets.texi ${MAKEINFO} --force --no-validate -I ${srcdir} \ ${srcdir}/adasockets.texi sockets.texi: ${srcdir}/sockets.desc ${srcdir}/adadoc.tpl ${GETDEFS} ${ADADOC_ARGS} \ --input="${srcdir}/sockets.desc" --base-name=sockets sockets-multicast.texi: ${srcdir}/sockets-multicast.desc ${srcdir}/adadoc.tpl ${GETDEFS} ${ADADOC_ARGS} \ --input="${srcdir}/sockets-multicast.desc" \ --base-name=sockets-multicast sockets-naming.texi: ${srcdir}/sockets-naming.desc ${srcdir}/adadoc.tpl ${GETDEFS} ${ADADOC_ARGS} \ --input="${srcdir}/sockets-naming.desc" --base-name=sockets-naming adasockets.pdf: ${srcdir}/adasockets.texi ${adasockets_TEXINFOS} -${TEXI2DVI} --pdf ${srcdir}/adasockets.texi adasockets.dvi: ${srcdir}/adasockets.texi ${adasockets_TEXINFOS} -${TEXI2DVI} --dvi ${srcdir}/adasockets.texi adasockets-1.10.1/doc/adadoc.tpl000066400000000000000000000050421277046543400164310ustar00rootroot00000000000000[+ autogen5 template texi +][+ (define *args* #f) (define (end-args kind return) (let ((args *args*)) (set! *args* #f) (if (string=? kind "procedure") (if args ");" ";") (sprintf "%s@*@w{return %s;}" (if args ")" "") return)))) (define (format-arg name mode type default) (let ((prefix (if *args* "; " " (")) (mode-mark (if (string-ci=? "IN" mode) "" (sprintf " %s" mode))) (default-expr (if (string=? default "") "" (sprintf " := %s" default)))) (set! *args* #t) (sprintf "%s@w{@var{%s} :%s %s%s}" prefix name mode-mark type default-expr))) +][+ CASE (suffix) +][+ == texi +] [+ intro +] [+ FOR type +] @deftypefn [+ package +].[+ name +] type [+ name +] [+ IF discr +]([+ discr +]) [+ ENDIF +]is [+ def +]; [+ doc +] [+ IF (exist? "see") +]See also: [+ FOR see "," +]@ref{[+ see +]}[+ ENDFOR +]. [+ ENDIF +] @end deftypefn [+ ENDFOR +] @menu [+ FOR subprogram +]* [+ (let ((w (get "what")) (n (string-append (get "name") " (" (get "kind") ")"))) (sprintf (if (> (string-length n) 19) "%s\n %s" "%-21s %s") (string-append n "::") w)) +] [+ ENDFOR +]@end menu [+ FOR subprogram +] @node [+ name +] ([+ kind +]) @unnumberedsubsec [+ name +] ([+ kind +]) [+ FOR concept +]@cindex [+ concept +] [+ ENDFOR +] @table @sc @item Purpose [+ what +] @item Prototype @deftypefn [+ package +].[+ name +] [+ kind +] [+ name +][+ IF (exist? "arg") +][+ FOR arg +][+ (format-arg (get "argname") (get "argmode") (get "argtype") (get "argdefault")) +][+ ENDFOR +][+ (end-args (get "kind") (get "ret.rettype")) +][+ ENDIF +] @end deftypefn @fnindex [+ package +].[+ name +] [+ IF (exist? "arg") +] @item Parameters @multitable {XXXXXXXX} {in out X} {XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX} [+ FOR arg +]@item @var{[+ argname +]} @tab [+ argmode +] @tab [+ argdesc +] [+ ENDFOR +]@end multitable [+ ENDIF +][+ IF (exist? "ret") +] @item Return value [+ ret.retdesc +][+ ENDIF +] [+ IF doc +] @item Description [+ doc +] [+ ENDIF +] [+ IF (exist? "exc") +] @item Exceptions @multitable {XXXXXXXXXXXXXXXX} {XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX} [+ FOR exc +]@item @code{[+ excname +]} @tab [+ excdesc +]@exindex [+ excname +] [+ ENDFOR +]@end multitable [+ FOR exc +] [+ ENDFOR +] [+ ENDIF +] [+ IF example +] @item Example @example [+ (out-push-new ".example") +][+ example +][+ (out-pop) +][+ `sed 's/^\\$ //' .example; rm -f .example` +] @end example [+ ENDIF +] [+ IF see +] @item See also [+ FOR see ",@*" +]@ref{[+ see +]}[+ ENDFOR +]. [+ ENDIF +] @end table [+ ENDFOR +] [+ ESAC +] adasockets-1.10.1/doc/adasockets.texi000066400000000000000000000312671277046543400175210ustar00rootroot00000000000000\input texinfo @c -*-texinfo-*- @setfilename adasockets.info @settitle AdaSockets reference manual @setchapternewpage odd @include version.texi @ifinfo @dircategory Libraries @direntry * adasockets: (adasockets). AdaSockets reference manual @end direntry @end ifinfo @ifinfo Copyright @copyright{} 2002-2015 Samuel Tardieu Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. @ignore Permission is granted to process this file through TeX and print the results, provided the printed document carries a copying permission notice identical to this one except for the removal of this paragraph (this paragraph not being relevant to the printed manual). @end ignore Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions. @end ifinfo @titlepage @finalout @title AdaSockets reference manual @subtitle for AdaSockets version @value{VERSION} @subtitle @value{UPDATED} @author Samuel Tardieu @page @vskip 0pt plus 1filll Copyright @copyright{} 2002-2015 Samuel Tardieu Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions. @end titlepage @c New indices: constants (ct) and exceptions (ex) @defindex ct @defindex ex @syncodeindex ex cp @syncodeindex ct cp @syncodeindex vr cp @syncodeindex fn cp @syncodeindex tp cp @contents @c --------------------------------------------------------------- @node Top, What is AdaSockets?, (dir), (dir) @menu * What is AdaSockets?:: * Installing AdaSockets:: * Using AdaSockets:: * Sockets package:: * Sockets.Multicast package:: * Sockets.Naming package:: * Contributors:: * Resources on the Internet:: * Index:: @detailmenu --- The Detailed Node Listing --- Using AdaSockets * Compiling an Ada application:: * Setting up unicast sockets:: * Setting up multicast sockets:: * Sending and receiving data:: Sending and receiving data * Raw data manipulation:: * String-oriented exchanges:: @end detailmenu @end menu @node What is AdaSockets?, Installing AdaSockets, Top, Top @chapter What is AdaSockets? @cindex AdaSockets presentation @cindex Comparaison with @code{GNAT.Sockets} AdaSockets is a set of free software Ada packages allowing Ada programmers to use the so-called BSD sockets from their favourite programming language. AdaSockets has been designed and tested with the GNAT free software Ada compiler, but should be portable to other compilers quite easily. Starting from release 3.14, the GNAT compiler started to integrate a @code{GNAT.Sockets} package. However, this package is GNAT specific and contains at this time less features than AdaSockets. At some point, AdaSockets may use @code{GNAT.Sockets} as its underlying sockets structure. AdaSockets philosophy is to help the Ada programmer by providing easy-to-use objects. Special care has been taken to ensure that performances do however remain good. @node Installing AdaSockets, Using AdaSockets, What is AdaSockets?, Top @chapter Installing AdaSockets @cindex Installing AdaSockets Installing AdaSockets on a Unix or OpenVMS machine is as simple as typing a few commands. Once you got the latest version of AdaSockets (@pxref{Resources on the Internet}), uncompress and untar it and go to the top-level directory of the distribution. You must configure the AdaSockets distribution by using the @command{configure} command, such as in: @example ./configure --prefix=/users/sam/adasockets @end example If you want to install AdaSockets under the @file{/usr/local} hierarchy, you do not need to specify the @option{--prefix} option. Make sure you have write permission on the target directories. Once AdaSockets is configured, you can compile and install it by using the @command{make} command: @example make install @end example The GNU make program is recommended but not mandatory. On your system, it may be installed under the @command{gmake} name. @node Using AdaSockets, Sockets package, Installing AdaSockets, Top @chapter Using AdaSockets @menu * Compiling an Ada application:: * Setting up unicast sockets:: * Setting up multicast sockets:: * Sending and receiving data:: @end menu @node Compiling an Ada application, Setting up unicast sockets, Using AdaSockets, Using AdaSockets @section Compiling an Ada application AdaSockets comes with an @code{adasockets-config} application that can be used to retrieve installation parameters while using @code{gnatmake} to compile your Ada application. The @code{--cflags} parameters tells @code{adasockets-config} to output the path to the Ada packages sources, while @code{--libs} asks for the path to the Ada library. @example gnatmake `adasockets-config --cflags` mainprog -largs `adasockets-config --libs` @end example @node Setting up unicast sockets, Setting up multicast sockets, Compiling an Ada application, Using AdaSockets @section Setting up unicast sockets @cindex Unicast sockets @cindex Creating a unicast socket @cindex Creating a TCP socket @cindex Creating a UDP socket @cindex TCP socket @cindex UDP socket @cindex Creating a socket @tindex Socket_FD @findex Sockets.Socket @findex Socket Unicast sockets are used everywhere on the Internet, for surfing the web, sending electronic mails or accessing remote files. They come in two flavours: @table @asis @item TCP TCP is a connected mode, in which packets are sent in a reliable and ordered way. Everything sent at one end will eventually arrive in the same order at the other end, the underlying operating system takes care of retransmitting missing packets and reordering out-of-order ones. @item UDP UDP is a non-connected mode. A packet sent on a UDP socket may or may not arrive at the other end. This is a much lighter protocol when reliability is not needed as the operating system does not have to use large buffers to reorder packets. Also, this generates less traffic as no acknowledgments need to be sent by the kernels. @end table The package @code{Sockets} defines a @code{Socket_FD} tagged type. An instance of this type (or of any of its descendants) represents an incoming or outgoing socket. Two different kinds of sockets can be created: unicast (one-to-one) and multicast (many-to-many). @node Setting up multicast sockets, Sending and receiving data, Setting up unicast sockets, Using AdaSockets @section Setting up multicast sockets @cindex Multicast sockets @cindex Creating a multicast socket @cindex Mbone @cindex Group communication Multicast sockets are used for group communication over the Internet. To use multicast sockets, you must be connected to a multicast network and use a multicast-enabled operating system (such as most Unices, Linux or even recent Windows versions). Unless you are connected to the mbone (multicast backbone) or have setup a private multicast network, you will only be able to use multicast on your local network. A multicast socket is somewhat similar to a UDP socket; in particular, packets may be lost or misordered. @findex Create_Multicast_Socket @findex Sockets.Multicast.Create_Multicast_Socket @tindex Multicast_Socket_FD You can create a multicast socket using the function @code{Create_Multicast_Socket} in the package @code{Sockets.Multicast}. This function returns a @code{Multicast_Socket_FD} object, which derives from @code{Socket_FD}. @code{Create_Multicast_Socket} takes care of the whole setup of your multicast socket. You do not need to call any additionnal subprogram before using it. In particular, @code{Create_Multicast_Socket} will take care of registering the multicast socket to the operating system, so that the latter can tell the connected routers to propagate the subscription to the mbone as needed. @node Sending and receiving data, , Setting up multicast sockets, Using AdaSockets @section Sending and receiving data @cindex Sending data @cindex Receiving data In AdaSockets, data can be sent and received in three different ways: raw, string-oriented and stream-oriented. @menu * Raw data manipulation:: * String-oriented exchanges:: @end menu @node Raw data manipulation, String-oriented exchanges, Sending and receiving data, Sending and receiving data @subsection Raw data manipulation @cindex Raw data manipulation @tindex Ada.Streams.Stream_Element_Array @tindex Stream_Element_Array Raw data is manipulated using the predefined @code{Ada.Streams.Stream_Element_Array} Ada type. This corresponds to an array of bytes, or an @code{unsigned char *} in the C programming language. @node String-oriented exchanges, , Raw data manipulation, Sending and receiving data @subsection String-oriented exchanges String-oriented exchanges provides the programmer with @code{Ada.Text_IO} like subprograms. Most Internet protocols are line-oriented and those subprograms are perfectly suited to implement those. When sending data, the classical @code{CR + LF} sequence will be sent at the end of each line. When receiving data, @code{CR} characters are discarded and @code{LF} is used as the end-of-line marker. The @code{Get} function is tied to the size of the operating system buffer. It is better to use @code{Get_Line} to get a full line. The line can be as long as the length of the Ada buffer. The Ada buffer can be adjusted by using the @code{Set_Buffer} and @code{Unset_Buffer} procedures. When using string-oriented exchanges with datagram protocols such as UDP, setting a buffer using @code{Set_Buffer} for the receiving socket is mandatory. If you don't, the receiving socket will loose data and will be unable to reconstitute the string. @node Sockets package, Sockets.Multicast package, Using AdaSockets, Top @chapter Sockets package @include sockets.texi @node Sockets.Multicast package, Sockets.Naming package, Sockets package, Top @chapter Sockets.Multicast package @include sockets-multicast.texi @node Sockets.Naming package, Contributors, Sockets.Multicast package, Top @chapter Sockets.Naming package @include sockets-naming.texi @node Contributors, Resources on the Internet, Sockets.Naming package, Top @appendix Contributors @cindex Contributing AdaSockets has been originally developped by Samuel Tardieu who still maintains it. However, the following people have made crucial contributions to AdaSockets, be they new code, bug fixes or porting to new operating systems: @itemize @bullet @item Dmitriy Anisimkov (@email{anisimkov@@yahoo.com}) @item Alan Barnes (@email{barnesa@@aston.ac.uk}) @item Juanma Barranquero (@email{lektu@@terra.es}) @item Bobby D. Bryant (@email{bdbryant@@mail.utexas.edu}) @item Sander Cox (@email{sander.cox@@philips.com}) @item Sune Falk (@email{sune.falck@@telia.com}) @item Guillaume Foliard (@email{guifo@@wanadoo.fr}) @item Laurent Guerby (@email{guerby@@club-internet.fr}) @item David J. Kristola (@email{David95037@@aol.com}) @item Dominik Madon (@email{dominik@@acm.org}) @item Pascal Obry (@email{p.obry@@wanadoo.fr}) @item Nicolas Ollinger (@email{Nicolas.Ollinger@@ens-lyon.fr}) @item Stéphane Patureau (@email{spaturea@@meletu.univ-valenciennes.fr}) @item Thomas Quinot (@email{thomas@@cuivre.fr.eu.org}) @item Preben Randhol (@email{randhol@@pvv.org}) @item Maxim Reznik (@email{max1@@mbank.com.ua}) @item Joel Sherrill (@email{joel.sherrill@@oarcorp.com}) @item Samuel Tardieu (@email{sam@@rfc1149.net}) @end itemize If you feel that you have been forgotten, please send me a mail so that I can fix it in the next version. @xref{Resources on the Internet}, for how to contribute. @node Resources on the Internet, Index, Contributors, Top @appendix Resources on the Internet @cindex Sending patches @cindex Reporting a bug @cindex Suggesting a feature @cindex Finding AdaSockets on the Internet @cindex Contributing The latest version of AdaSockets can always be found at: @center @url{http://www.rfc1149.net/devel/adasockets} You can report issues or submit questions on GitHub's issue tracker at: @center @url{https://github.com/samueltardieu/adasockets/issues} @node Index, , Resources on the Internet, Top @unnumbered Index @printindex cp @bye adasockets-1.10.1/doc/sockets-multicast.desc000066400000000000000000000067641277046543400210270ustar00rootroot00000000000000/*=* Global settings. * * package: Sockets.Multicast * intro: * The @code{Sockets.Multicast} allows the creation of IP multicast * sockets. =*/ /*=type Multicast_Socket_FD * * what: IP multicast socket object * def: new Socket_FD with private * doc: * The @code{Multicast_Socket_FD} tagged type derives from the * @code{Socket_FD} type. It gets initialized by calling * @ref{Create_Multicast_Socket (function)}. An uninitialized * @code{Multicast_Socket_FD} can be succesfully compared to * @code{Null_Multicast_Socket_FD}. =*/ /*=subprogram Create_Multicast_Socket * * what: Create an IP multicast socket * kind: function * arg: Group, in, String,, IP address of the multicast group to join * arg: Port, in, Natural,, Port of the multicast group to join * arg: TTL, in, Positive, 16, Time-to-live of sent packets * arg: * Self_Loop, in, Boolean, True, Should the socket receive the packets * sent from the local host? * arg: Local_If, in, String, "0.0.0.0", Address of the local interface * to use, or "0.0.0.0" to designate any possible interface * ret: Multicast_Socket_FD, The new initialized multicast socket * doc: * This function creates an IP multicast socket attached to a given * group, identified by its class E IP address and port. * * Be careful when choosing the TTL parameter of your IP multicast * socket. Most IP multicast routers do implement threshold-based * filtering and will not let IP multicast packets leave your * organization if the TTL on the last router is smaller than 16. * * If 0 is given for the Port, a local one will be chosen. It can * then later be retrieved using Get_Sock_Port. * concept: Creating a socket * concept: Creating a multicast socket * example: * $ declare * $ Sock : Multicast_Socket_FD; * $ begin * $ -- Create a multicast socket on group 224.1.2.3 port 8763 * $ Sock := Create_Multicast_Socket ("224.1.2.3", 8763); * $ -- Perform some operations on socket * $ [...] * $ -- Shutdown the socket in both directions * $ Shutdown (Sock, Both); * $ end; * see: Send (procedure) * see: Shutdown (procedure) =*/ /*=subprogram Create_Multicast_Socket * * what: Create an IP multicast socket * kind: function * arg: Group, in, String,, IP address of the multicast group to join * arg: Port, in, Positive,, Port of the multicast group to join * arg: Local_Port, in, Natural,, Local port number to use * arg: TTL, in, Positive, 16, Time-to-live of sent packets * arg: Local_If, in, String, "0.0.0.0", Address of the local interface * to use, or "0.0.0.0" to designate any possible interface * ret: Multicast_Socket_FD, The new initialized multicast socket * doc: * This function creates an IP multicast socket attached to a given * group, identified by its class E IP address and port. If * Local_Port is 0, a free port will automatically be chosen by * your operating system. * * This function should be used when you want to send packets * to a multicast group without receiving any packet yourself. * concept: Creating a socket * concept: Creating a multicast socket * example: * $ declare * $ Sock : Multicast_Socket_FD; * $ begin * $ -- Create a multicast socket on group 224.1.2.3 port 8763 * $ Sock := Create_Multicast_Socket ("224.1.2.3", 8763); * $ -- Perform some operations on socket * $ [...] * $ -- Shutdown the socket in both directions * $ Shutdown (Sock, Both); * $ end; * see: Send (procedure) * see: Shutdown (procedure) =*/ adasockets-1.10.1/doc/sockets-naming.desc000066400000000000000000000111161277046543400202560ustar00rootroot00000000000000/*=* Global settings. * * package: Sockets.Naming * intro: * The @code{Sockets.Naming} package contains types and helper functions * needed to manipulate Internet host names and addresses. =*/ /*=type String_Access * * what: Access on string * def: access String * doc: * Helper type =*/ /*=type String_Array * * what: Array of strings * def: array (Positive range <>) of String_Access * doc: * Helper type =*/ /*=type Address_Component * * what: IPv4 address component (subtype) * def: Natural range 0 .. 255 * doc: * Helper type =*/ /*=type Address * * what: IPv4 address (subtype) * def: record@*@w{ }H1, H2, H3, H4 : Address_Component;@*end record * doc: * This type represents an IPv4 address with @code{H1} being the first * octet and @code{H4} the last one. For example, 137.194.161.2 is * represented by @code{H1=137, H2=194, H3=161, H4=2}. =*/ /*=type Address_Array * * what: array of IPv4 addresses * def: array (Positive range <>) of Address * doc: * Helper type =*/ /*=type Host_Entry * * discr: N_Aliases, N_Addresses : Natural * def: new Ada.Finalization.Controlled with record@*@w{ } Name : String_Access;@*@w{ } Aliases : String_Array (1 .. N_Aliases);@*@w{ } Addresses : Address_Array (1 .. N_Addresses);@* end record * doc: * The @code{Host_Entry} type holds a set of names and IP addresses * associated with a host. Each host can have several IP address * as well as several aliases. =*/ /*=subprogram Image * * what: Make a string from an address * kind: function * arg: Add, in, Address,, IP address * ret: String, String representation of the IP address * concept: Representing IP addresses * see: Value (function) =*/ /*=subprogram Value * * what: Transform a string into an address * kind: function * arg: Add, in, String,, Textual representation of an IP address * ret: Address, Corresponding Address * concept: Representing IP addresses * see: Image (function) =*/ /*=subprogram Is_IP_Address * * what: Check if given string is a valid IP address * kind: function * arg: Something, in, String,, String to check * ret: Boolean, @samp{True} if @var{Something} is an IP address =*/ /*=subprogram Info_Of_Name_Or_IP * * what: Get addresses and names of a host * kind: function * arg: Something, in, String,, Host name or IP address * ret: Host_Entry, Corresponding host entry * exc: Naming_Error, No information available for this name or address * doc: * This function extracts all the names and addresses from the * naming service. =*/ /*=subprogram Address_Of * * what: Get the IP address of a host * kind: function * arg: Something, in, String,, Host name or IP address * ret: Address, IPv4 address * exc: Naming_Error, No information available for this name or address * see: Name_Of (function) =*/ /*=subprogram Host_Name * * what: Get the name of the current host * kind: function * ret: String, Name of the current host * doc: * This function returns the name of the current host. Depending on * the local configuration, it may or may not be a fully qualified * domain name (FQDN). =*/ /*=subprogram Name_Of * * what: Official name of the host * kind: function * arg: Something, in, String,, Host name or IP address * ret: String, Name of the host * exc: Naming_Error, No information available for this name or address * see: Address_Of (function) =*/ /*=subprogram Any_Address * * what: Special address representing any address on the local host * kind: function * ret: Address, Equivalent to @code{INADDR_ANY} in the C programming language =*/ /*=subprogram Get_Peer_Addr * * what: Retrieve IP address of remote host * kind: function * arg: Socket, in, Socket_FD,, Connected socket object * ret: Address, Peer address * see: Get_Peer_Port (function) * see: Get_Sock_Addr (function) =*/ /*=subprogram Get_Peer_Port * * what: Retrieve port used by remote host * kind: function * arg: Socket, in, Socket_FD,, Connected socket object * ret: Positive, Port used on the remote host * see: Get_Sock_Port (function) * see: Get_Peer_Addr (function) =*/ /*=subprogram Get_Sock_Addr * * what: Retrieve IP address of local host * kind: function * arg: Socket, in, Socket_FD,, Connected socket object * ret: Address, Address of local interface used * see: Get_Sock_Port (function) * see: Get_Peer_Addr (function) =*/ /*=subprogram Get_Sock_Port * * what: Retrieve port used by local host * kind: function * arg: Socket, in, Socket_FD,, Connected socket object * ret: Positive, Port used on the local host * see: Get_Peer_Port (function) * see: Get_Sock_Addr (function) =*/ adasockets-1.10.1/doc/sockets.desc000066400000000000000000000506301277046543400170130ustar00rootroot00000000000000/*=* Global settings. * * package: Sockets * intro: * The @code{Sockets} package contains all the definitions and * subprograms needed to build a simple unicast client or server. =*/ /*=type Socket_FD * * what: Socket object * def: tagged private * doc: * The @code{Socket_FD} tagged type is the root type of all * sockets. It gets initialized by calling @ref{Socket (procedure)}. * An uninitialized @code{Socket_FD} can be succesfully compared to * @code{Null_Socket_FD}. =*/ /*=subprogram Socket * * what: Create a socket of the given mode * kind: procedure * arg: Socket, out, Socket_FD,, Socket object to initialize * arg: Domain, in, Socket_Domain, PF_INET, Protocol family * arg: Typ, in, Socket_Type, SOCK_STREAM, Kind of sockets * doc: * @ctindex PF_INET * @ctindex AF_INET * @ctindex SOCK_STREAM * @ctindex SOCK_DGRAM * This procedure initializes a new socket object by reserving a file * descriptor to the operating system. For backward compatibility with * older versions of this library, @code{AF_INET} is still accepted as * a value but should be replaced as soon as possible with the proper * @code{PF_INET}. Using @code{SOCK_STREAM} for the @var{Typ} * argument will create a TCP socket while a @code{SOCK_DGRAM} will * create a UDP one. * concept: Creating a socket * example: * $ declare * $ Sock : Socket_FD; * $ begin * $ -- Create a TCP socket * $ Socket (Sock, PF_INET, SOCK_STREAM); * $ -- Perform some operations on socket * $ [...] * $ -- Shutdown the socket in both directions * $ Shutdown (Sock, Both); * $ end; * see: Shutdown (procedure) =*/ /*=subprogram Connect * * what: Connect a socket on a given host/port * kind: procedure * arg: Socket, in, Socket_FD,, Initialized socket object * arg: Host, in, String,, Host to connect to * arg: Port, in, Positive,, Port to connect to * exc: Connection_Refused, The connection has been refused by the server * exc: Socket_Error, Another error occurred during the connection * doc: * This procedure connects an initialized socket to a given host on * a given port. In the case of a TCP socket, a real connection is * attempted. In the case of a UDP socket, no connection takes place * but the endpoint coordinates are recorded. * concept: Connecting a socket * example: * $ declare * $ Sock : Socket_FD; * $ begin * $ -- Create a TCP socket * $ Socket (Sock, PF_INET, SOCK_STREAM); * $ -- Connect it to rfc1149.net's mail server * $ Connect (Sock, "mail.rfc1149.net", 25); * $ -- Do a mail transaction then close the socket * $ [...] * $ end; * see: Socket (procedure) =*/ /*=subprogram Bind * * what: Associate a local port to a socket * kind: procedure * arg: Socket, in, Socket_FD,, Initialized socket object * arg: Port, in, Natural,, Local port to bind to * arg: Host, in, String, @w{}"", Local interface to bind to * exc: Socket_Error, Requested port or interface not available * doc: * This procedure requests a local port from the operating * system. If 0 is given in @var{Port}, the system will assign a * free port whose number can later be retrieved using * @ref{Get_Sock_Port (function)}. Also, most operating systems require * special privileges if you want to bind to ports below 1024. * * If @var{Host} is not the empty string, it must contain the * IP address of a local interface to bind to, or a name which * resolves into such an address. If an empty string is given (the * default), the socket will be bound to all the available * interfaces. * concept: Binding a socket * concept: Assigning a local port * concept: Creating a server * see: Listen (procedure) * see: Socket (procedure) =*/ /*=subprogram Listen * * what: Establish a listen queue * kind: procedure * arg: Socket, in, Socket_FD,, Initialized and bound socket object * arg: Queue_Size, in, Positive, 5, Requested slots in the listen queue * doc: * This procedure establishes a listen queue after a TCP socket as been * initialized and bound. Each slot in the queue can hold one * incoming connection that has not been accepted yet. Note that * most operating systems ignore queue sizes larger than five. * concept: Establishing a listen queue * concept: Listen queue * see: Accept_Socket (procedure) * see: Bind (procedure) * see: Socket (procedure) =*/ /*=subprogram Getsockopt * * what: Retrieve a socket option * kind: procedure * arg: Socket, in, Socket_FD,, Initialized and bound socket object * arg: Level, in, Socket_Level, SOL_SOCKET, Protocol level * arg: Optname, in, Socket_Option,, Option name * arg: Optval, out, Integer,, Option value * doc: * @ctindex Sockets.SOL_SOCKET * @ctindex Sockets.IPPROTO_IP * @ctindex Sockets.SO_REUSEADDR * @ctindex Sockets.SO_REUSEPORT * @ctindex Sockets.IP_MULTICAST_TTL * @ctindex Sockets.IP_ADD_MEMBERSHIP * @ctindex Sockets.IP_DROP_MEMBERSHIP * @ctindex Sockets.IP_MULTICAST_LOOP * @ctindex Sockets.SO_SNDBUF * @ctindex Sockets.SO_RCVBUF * @ctindex SOL_SOCKET * @ctindex IPPROTO_IP * @ctindex SO_REUSEADDR * @ctindex SO_REUSEPORT * @ctindex IP_MULTICAST_TTL * @ctindex IP_ADD_MEMBERSHIP * @ctindex IP_DROP_MEMBERSHIP * @ctindex IP_MULTICAST_LOOP * @ctindex SO_SNDBUF * @ctindex SO_RCVBUF * This procedure retrieves options applicable to a socket. Please * see your operating system manual for usable levels and options. * * Two levels are defined: @code{SOL_SOCKET} (the default) and * @code{IPPROTO_IP}. The options are @code{SO_REUSEADDR}, * @code{SO_REUSEPORT}, @code{IP_MULTICAST_TTL}, * @code{IP_ADD_MEMBERSHIP}, @code{IP_DROP_MEMBERSHIP}, * @code{IP_MULTICAST_LOOP}, @code{SO_SNDBUF} and * @code{IP_RCVBUF}. * * Note that unlike their C language counterpart, @code{Getsockopt} * and @code{Setsockopt} do not require an extra parameter * representing the length in bytes of the option value. AdaSockets * nows the right size for every option. * concept: Manipulating socket options * concept: Retrieving socket options * see: Setsockopt (procedure) =*/ /*=subprogram Setsockopt * * what: Set a socket option * kind: procedure * arg: Socket, in, Socket_FD,, Initialized and bound socket object * arg: Level, in, Socket_Level, SOL_SOCKET, Protocol level * arg: Optname, in, Socket_Option,, Option name * arg: Optval, in, Integer,, Option value * doc: * @ctindex Sockets.SOL_SOCKET * @ctindex Sockets.IPPROTO_IP * @ctindex Sockets.SO_REUSEADDR * @ctindex Sockets.SO_REUSEPORT * @ctindex Sockets.IP_MULTICAST_TTL * @ctindex Sockets.IP_ADD_MEMBERSHIP * @ctindex Sockets.IP_DROP_MEMBERSHIP * @ctindex Sockets.IP_MULTICAST_LOOP * @ctindex Sockets.SO_SNDBUF * @ctindex Sockets.SO_RCVBUF * @ctindex SOL_SOCKET * @ctindex IPPROTO_IP * @ctindex SO_REUSEADDR * @ctindex SO_REUSEPORT * @ctindex IP_MULTICAST_TTL * @ctindex IP_ADD_MEMBERSHIP * @ctindex IP_DROP_MEMBERSHIP * @ctindex IP_MULTICAST_LOOP * @ctindex SO_SNDBUF * @ctindex SO_RCVBUF * This procedure sets options applicable to a socket. Please * see your operating system manual for usable levels and options. * * Two levels are defined: @code{SOL_SOCKET} (the default) and * @code{IPPROTO_IP}. The options are @code{SO_REUSEADDR}, * @code{SO_REUSEPORT}, @code{IP_MULTICAST_TTL}, * @code{IP_ADD_MEMBERSHIP}, @code{IP_DROP_MEMBERSHIP}, * @code{IP_MULTICAST_LOOP}, @code{SO_SNDBUF} and * @code{IP_RCVBUF}. * * Note that unlike their C language counterpart, @code{Getsockopt} * and @code{Setsockopt} do not require an extra parameter * representing the length in bytes of the option value. AdaSockets * nows the right size for every option. * concept: Manipulating socket options * concept: Setting socket options * see: Getsockopt (procedure) =*/ /*=subprogram Accept_Socket * * what: Accept an incoming connection * kind: procedure * arg: Socket, in, Socket_FD,, Initialized, bound and listening socket object * arg: New_Socket, out, Socket_FD,, Incoming socket object * doc: * This procedure creates a new socket corresponding to an incoming * connection on TCP socket @var{Socket}. All the communications * with the peer will take place on @var{New_Socket}, while the * program can accept another connection on @var{Socket}. * * @var{New_Socket} must not be initialized before calling this * procedure, or must have been cleaned up by calling * @code{Shutdown}, in order to avoid a file descriptors leak. * * @code{Accept_Socket} will block until an incoming connection is * ready to be accepted. * concept: Accepting a new connection * concept: Handling a new connection * example: * $ declare * $ Sock : Socket_FD; * $ Incoming : Socket_FD; * $ begin * $ -- Create a TCP socket listening on local port 4161 * $ Socket (Sock, PF_INET, SOCK_STREAM); * $ Bind (Sock, 4161); * $ Listen (Sock, 3); * $ -- One-connection-at-a-time server (3 may be pending) * $ loop * $ -- Wait for a new connection and accept it * $ Accept_Socket (Sock, Incoming); * $ -- Do some dialog with the remote host * $ Do_Some_Dialog (Incoming); * $ -- Close incoming socket and wait for next connection * $ Shutdown (Incoming); * $ end loop; * $ end; * see: Bind (procedure) * see: Listen (procedure) * see: Shutdown (procedure) * see: Socket (procedure) =*/ /*=subprogram Send * * what: Send raw data over a socket * kind: procedure * arg: Socket, in, Socket_FD,, Initialized and connected socket object * arg: Data, out, Ada.Streams.Stream_Element_Array,, Data to be sent * doc: * @tindex Ada.Streams.Stream_Element_Array * @tindex Stream_Element_Array * This procedure sends data over a connected outgoing socket or * over an incoming socket. * concept: Sending data * exc: Connection_Closed, Peer has prematurely closed the connection * see: Put (procedure) * see: Put_Line (procedure) =*/ /*=subprogram Receive * * what: Receive raw data over a socket * kind: function * arg: * Socket, in, Socket_FD,, Initialized and bound or connected socket object * arg: Max, in, Ada.Streams.Stream_Element_Count, 4096, Maximum data length * ret: Ada.Streams.Stream_Element_Array, Received raw data * doc: * @tindex Ada.Streams.Stream_Element_Count * @tindex Ada.Streams.Stream_Element_Array * @tindex Stream_Element_Count * @tindex Stream_Element_Array * This procedure receives data from a bound UDP socket or a connected * TCP socket. Only one system call will be performed; this * function will return whatever data has arrived. Note that in * GNAT the secondary stack may be used to store the data and may * result in stack storage exhaustion. * concept: Receiving data * exc: * Connection_Closed, Peer has closed the connection before sending any data * see: Receive (procedure) * see: Receive_Some (procedure) * see: Get_Line (function) * see: Get_Line (procedure) =*/ /*=subprogram Receive * * what: Receive raw data over a socket * kind: procedure * arg: * Socket, in, Socket_FD'Class,, * Initialized and bound or connected socket object * arg: Data, out, Ada.Streams.Stream_Element_Array,, Incoming data buffer * doc: * @tindex Ada.Streams.Stream_Element_Array * @tindex Stream_Element_Array * This procedure receives data from a bound UDP socket or a connected * TCP socket. It will block until the @var{Data} reception buffer * has been totally filled. * concept: Receiving data * exc: * Connection_Closed, * Peer has closed the connection before @code{Data'Length} bytes@* * were received * see: Get_Line (function) * see: Get_Line (procedure) * see: Receive (function) * see: Receive_Some (procedure) =*/ /*=subprogram Receive_Some * * what: Receive raw data over a socket * kind: procedure * arg: * Socket, in, Socket_FD'Class,, * Initialized and bound or connected socket object * arg: Data, out, Ada.Streams.Stream_Element_Array,, Incoming data buffer * arg: * Last, out, Ada.Streams.Stream_Element_Offset,, * Index of last element placed into @var{Data} * doc: * @tindex Ada.Streams.Stream_Element_Array * @tindex Stream_Element_Array * @tindex Ada.Streams.Stream_Element_Count * @tindex Stream_Element_Count * This procedure receives data from a bound UDP socket or a connected * TCP socket. As soon as at least one byte has been read, it returns * with @var{Last} set to the index of the latest written element * of @var{Data}. * concept: Receiving data * exc: * Connection_Closed, * Peer has closed the connection before sending any data * see: Get_Line (function) * see: Get_Line (procedure) * see: Receive (function) * see: Receive (procedure) =*/ /*=subprogram Shutdown * * what: Shutdown a socket * kind: procedure * arg: Socket, in out, Socket_FD,, Socket object to shutdown * arg: How, in, Shutdown_Type, Both, Direction to shutdown * doc: * @ctindex Send * @ctindex Receive * @ctindex Both * This procedure shutdowns either direction of the socket. @var{How} * can take the value @samp{Send}, @samp{Receive} or @samp{Both}. * concept: Closing a socket * concept: Socket shutdown * see: Socket (procedure) =*/ /*=subprogram Put * * what: Send a string to a remote host * kind: procedure * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * arg: Str, in, String,, String to send * doc: * This procedure sends the content of @var{Str} over an outgoing * or incoming socket. * concept: Sending data * exc: Connection_Closed, Peer has prematurely closed the connection * see: New_Line (procedure) * see: Put_Line (procedure) * see: Send (procedure) =*/ /*=subprogram New_Line * * what: Send a CR/LF to a remote host * kind: procedure * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * arg: Count, in, Natural, 1, Number of CR/LF sequences to send * doc: * @ctindex CR * @ctindex LF * This procedure sends one or more CR/LF combinations to the peer. * concept: Sending data * exc: Connection_Closed, Peer has prematurely closed the connection * see: Put (procedure) * see: Put_Line (procedure) =*/ /*=subprogram Put_Line * * what: Send a CR/LF terminated string to a remote host * kind: procedure * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * arg: Str, in, String,, String to send * doc: * This procedure sends the content of @var{Str} plus a CR/LF combination * over an outgoing or incoming socket. * concept: Sending data * exc: Connection_Closed, Peer has prematurely closed the connection * see: New_Line (procedure) * see: Put (procedure) * see: Send (procedure) =*/ /*=subprogram Get * * what: Get a string from a remote host * kind: function * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * ret: String, Some characters that have been received * doc: * This function receives some characters from a remote host. * As soon that at least one character is available, the current * reception buffer is returned. * * There is usually little gain in using this function whose behaviour is * comparable to the one of @ref{Receive (function)}. Other * functions such as @ref{Get_Char (function)}, or * @ref{Get_Line (function)}, allow more structured programming. * * However, this function may be used to avoid loosing characters * when calling @ref{Unset_Buffer (procedure)}, if, for some reason, * the remote host may have sent some. * concept: Receiving data * exc: * Connection_Closed, * Peer has closed the connection before sending any data =*/ /*=subprogram Get_Char * * what: Get a character from a remote host * kind: function * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * ret: Character, One character sent by the remote host * doc: * This function receives exactly one character from the remote host. * concept: Receiving data * exc: * Connection_Closed, * Peer has closed the connection before sending the character * see: Get (function) * see: Get_Line (function) * see: Get_Line (procedure) * see: Receive (procedure) * see: Set_Buffer (procedure) =*/ /*=subprogram Get_Line * * what: Get a whole line from a remote host * kind: function * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * arg: Max_Length, in, Positive, 2048, Maximum returned line length * ret: String, A line without the CR and LF separators * doc: * @ctindex CR * @ctindex LF * This function receives one line from the remote host. A line * consists into zero or more characters followed by an optional CR * and by a LF. Those terminators are stripped before the line is * returned. * * This function blocks until one full line has been received. The line * length is limited with the value of the Max_Length argument, to avoid * exhaustion of the secondary stack. * concept: Receiving data * exc: * Connection_Closed, * Peer has closed the connection before sending a whole line * see: Get (function) * see: Get_Char (function) * see: Get_Line (procedure) * see: Receive (procedure) * see: Set_Buffer (procedure) =*/ /*=subprogram Get_Line * * what: Get a whole line from a remote host * kind: procedure * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * arg: Str, in out, String,, String to fill * arg: Last, out, Natural,, Last index used in the string * doc: * @ctindex CR * @ctindex LF * This procedure receives one line from the remote host. A line * consists into zero or more characters followed by an optional CR * and by a LF. Those terminators are stripped before the line is * returned. * * This procedure blocks until one full line has been received. * concept: Receiving data * exc: * Connection_Closed, * Peer has closed the connection before sending a whole line * see: Get (function) * see: Get_Char (function) * see: Get_Line (function) * see: Receive (procedure) * see: Set_Buffer (procedure) =*/ /*=subprogram Set_Buffer * * what: Install a line-oriented buffer of the socket object * kind: procedure * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * arg: Length, in, Positive, 1500, Size in bytes of the newly installed buffer * doc: * This procedure puts the socket object in buffered mode. If the * socket was already buffered, the content of the previous buffer * will be lost. The buffered mode only affects character- and * line-oriented read operation such as @ref{Get (function)}, * @ref{Get_Char (function)}, and @ref{Get_Line (function)}. Other * reception subprograms will not function properly if buffered mode * is used at the same time. * * The size of the buffer has to be greater than the biggest * possible packet sent by the remote host, otherwise data loss may * occur. * concept: Receiving data * see: Unset_Buffer (procedure) =*/ /*=subprogram Unset_Buffer * * what: Deinstall the line-oriented buffer of the socket object * kind: procedure * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * doc: * This procedure deinstalls the buffer previously installed by * @ref{Set_Buffer (procedure)}. If any data is still present in * the buffer, it will be lost. To avoid this situation, the buffer * can be flushed by calling @ref{Get (function)}. * concept: Receiving data =*/ /*=subprogram Get_Send_Queue_Size * * what: Return the size of the unsent data in the output queue * kind: function * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * ret: Integer, The non-negative size in bytes of the output queue, or a negative value in case of error * doc: * This function is only available on Linux platforms. On other operating * systems, it will return -2 to indicate that the necessary mechanisms to * retrieve the information are not available. * concept: Sending data * see: Send (procedure) =*/ /*=subprogram Get_Receive_Queue_Size * * what: Return the size of the unread data in the input queue * kind: function * arg: Socket, in, Socket_FD'Class,, Initialized and connected socket object * ret: Integer, The non-negative size in bytes of the input queue, or a negative value in case of error * doc: * This function is only available on Linux platforms. On other operating * systems, it will return -2 to indicate that the necessary mechanisms to * retrieve the information are not available. * concept: Receiving data * see: Receive (procedure) =*/ adasockets-1.10.1/examples/000077500000000000000000000000001277046543400155455ustar00rootroot00000000000000adasockets-1.10.1/examples/Makefile.RTEMS000066400000000000000000000037141277046543400201030ustar00rootroot00000000000000# # Makefile for Ada sockets example # # Directly produces an executable for a BSP which directly runs # the format (usually ELF) produced by just linking an application. # The executables produced by this Makefile should run on at least the # following BSPs: # arm/edb7312 # mips/jmr3904 # powerpc/psim # powerpc/score603e # sparc/erc32 # sparc/sis # # Some BSPs require extra manipulation of the ELF file before it can # be run on the target hardware. # EXAMPLES=stream_listener stream_sender listener multi tcprelay include $(RTEMS_MAKEFILE_PATH)/Makefile.inc include $(RTEMS_CUSTOM) include $(PROJECT_ROOT)/make/leaf.cfg # GEN5200 Specific Information ifeq ($(RTEMS_BSP_FAMILY),gen5200) LINKARGS+=-qnolinkcmds -T$(RTEMS_LINKCMDS) endif # PC386 Specific Information ifeq ($(RTEMS_BSP_FAMILY),pc386) HEADERADDR=0x00097E00 START16FILE=$(RTEMS_MAKEFILE_PATH)/lib/start16.bin START16ADDR=0x00097C00 RELOCADDR=0x00100000 LINKARGS+= -Wl,-Ttext,$(RELOCADDR) endif # Tool helpers GNATMAKE=$(AS:as=gnatmake) CARGS =-B${RTEMS_MAKEFILE_PATH}/lib/ -specs bsp_specs -qrtems $(CPU_CFLAGS) CARGS+=-DGNAT_MAIN_STACKSPACE=100 all: $(EXAMPLES) stream_listener stream_sender listener multi tcprelay: rtems_init.o *.adb $(GNATMAKE) -v -O -gnata -gnatE -gnato $(@) -g \ -I../src \ -bargs -Mgnat_main \ -largs $(CARGS) $(LINKARGS) rtems_init.o $(SIZE) $(@) ifeq ($(RTEMS_BSP_FAMILY),pc386) mv $(@) $(@).obj $(OBJCOPY) -O elf32-i386 \ --remove-section=.rodata \ --remove-section=.comment \ --remove-section=.note \ --strip-unneeded $(@).obj $(@) $(OBJCOPY) -O binary $(@).obj $(@).bin $(RTEMS_MAKEFILE_PATH)/build-tools/bin2boot -v $(@).bt $(HEADERADDR) \ $(START16FILE) $(START16ADDR) 0 $(@).bin $(RELOCADDR) 0 else endif rtems_init.o: rtems_init.c $(CC) $(CFLAGS) $(CPU_CFLAGS) -c rtems_init.c clean: rm -f b~*.* *.o *.ali $(EXAMPLES) rm -f *.num *.exe *.obj *.bin *.bt adasockets-1.10.1/examples/Makefile.VMS000066400000000000000000000006341277046543400176540ustar00rootroot00000000000000# Makefile for OpenVMS (GNU Make) # # $Revision$ # # # This file is part of adasockets port to OpenVMS # .PHONY: all distclean clean .DEFAULT: all FILES= stream_listener.adb\ stream_sender.adb\ listener.adb\ multi.adb\ tcprelay.adb all: $(FILES:.adb=.exe) %.exe: %.adb gnat make /search=([-.src]) $< distclean: del/noconf/log *.ali;*, *.obj;*, *.exe;* clean: del/noconf/log *.ali;*, *.obj;* adasockets-1.10.1/examples/Makefile.am000066400000000000000000000017011277046543400176000ustar00rootroot00000000000000all-local: tcprelay listener multi stream_listener stream_sender tcprelay: never $(GNATMAKE) -m -A../src -A$(top_srcdir)/src -I$(srcdir) tcprelay -cargs $(ADAFLAGS) -largs $(LDFLAGS) listener: never $(GNATMAKE) -m -A../src -A$(top_srcdir)/src -I$(srcdir) listener -cargs $(ADAFLAGS) -largs $(LDFLAGS) multi: never $(GNATMAKE) -m -A../src -A$(top_srcdir)/src -I$(srcdir) multi -cargs $(ADAFLAGS) -largs $(LDFLAGS) stream_listener: never $(GNATMAKE) -m -A../src -A$(top_srcdir)/src -I$(srcdir) stream_listener -cargs $(ADAFLAGS) -largs $(LDFLAGS) stream_sender: never $(GNATMAKE) -m -A../src -A$(top_srcdir)/src -I$(srcdir) stream_sender -cargs $(ADAFLAGS) -largs $(LDFLAGS) DISTCLEANFILES = tcprelay listener multi stream_listener stream_sender CLEANFILES = *.o *.ali b_*.c b~*.ad[bs] EXTRA_DIST = Makefile.RTEMS Makefile.VMS \ multi.adb rtems_init.c rtems_networkconfig.h stream_listener.adb \ listener.adb stream_sender.adb tcprelay.adb never:: adasockets-1.10.1/examples/header.txt000066400000000000000000000051421277046543400175400ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- XXXXX -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 ENST http://www.enst.fr/ -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets -- -- -- -- If you have any question, please send a mail to the AdaSockets list -- -- adasockets@lists.rfc1149.net -- -- -- ----------------------------------------------------------------------------- adasockets-1.10.1/examples/listener.adb000066400000000000000000000115341277046543400200460ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- L I S T E N E R -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 ENST http://www.enst.fr/ -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets -- -- -- -- If you have any question, please send a mail to the AdaSockets list -- -- adasockets@lists.rfc1149.net -- -- -- ----------------------------------------------------------------------------- with Ada.Command_Line; use Ada.Command_Line; with Ada.Exceptions; use Ada.Exceptions; with Ada.Text_IO; use Ada.Text_IO; with Sockets; use Sockets; procedure Listener is -- Usage: listener port -- Example: listener 5000 -- then telnet localhost 5000 task type Echo is entry Start (FD : Socket_FD); end Echo; function Rev (S : String) return String; -- Reverse a string ---------- -- Echo -- ---------- task body Echo is Sock : Socket_FD; begin select accept Start (FD : Socket_FD) do Sock := FD; end Start; or terminate; end select; loop Put_Line (Sock, Rev (Get_Line (Sock))); end loop; exception when Connection_Closed => Put_Line ("Connection closed"); Shutdown (Sock, Both); end Echo; Accepting_Socket : Socket_FD; Incoming_Socket : Socket_FD; type Echo_Access is access Echo; Dummy : Echo_Access; --------- -- Rev -- --------- function Rev (S : String) return String is Result : String (1 .. S'Length); Index : Natural := 0; begin for I in reverse S'Range loop Index := Index + 1; Result (Index) := S (I); end loop; return Result; end Rev; begin if Argument_Count /= 1 then Raise_Exception (Constraint_Error'Identity, "Usage: " & Command_Name & " port"); end if; Socket (Accepting_Socket, PF_INET, SOCK_STREAM); Setsockopt (Accepting_Socket, SOL_SOCKET, SO_REUSEADDR, 1); Bind (Accepting_Socket, Positive'Value (Argument (1))); Listen (Accepting_Socket); loop Put_Line ("Waiting for new connection"); Accept_Socket (Accepting_Socket, Incoming_Socket); Put_Line ("New connection acknowledged"); -- This step is optional, especially for TCP sockets Set_Buffer (Incoming_Socket, 4096); Put_Line ("New socket buffered"); Dummy := new Echo; Dummy.Start (Incoming_Socket); end loop; end Listener; adasockets-1.10.1/examples/multi.adb000066400000000000000000000076141277046543400173570ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- M U L T I -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 ENST http://www.enst.fr/ -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets -- -- -- -- If you have any question, please send a mail to the AdaSockets list -- -- adasockets@lists.rfc1149.net -- -- -- ----------------------------------------------------------------------------- with Ada.Command_Line; use Ada.Command_Line; with Ada.Exceptions; use Ada.Exceptions; with Ada.Text_IO; use Ada.Text_IO; with Sockets.Multicast; use Sockets, Sockets.Multicast; procedure Multi is Sock : constant Multicast_Socket_FD := Create_Multicast_Socket ("224.13.194.161", 0); task Send_Packets; task body Send_Packets is Message : constant String := Argument (1); begin for I in 1 .. 30 loop delay 2.0; Put_Line ("Emitting """ & Message & """"); Put (Sock, Message); end loop; exception when E : others => Put_Line ("Exception raised in Send_Packets task:" & Exception_Information (E)); end Send_Packets; begin loop Put_Line ("Waiting for input"); Put_Line ("Received """ & Get (Sock) & """"); end loop; exception when E : others => Put_Line ("Exception raised in main task:" & Exception_Information (E)); if Argument_Count < 1 then Put_Line ("Btw, usage is: multi ""string to send"""); end if; end Multi; adasockets-1.10.1/examples/rtems_init.c000066400000000000000000000120261277046543400200670ustar00rootroot00000000000000/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be found in * the file LICENSE in this distribution or at * http://www.rtems.com/license/LICENSE. * * $Id: rtems_init.c,v 1.2 2007/09/17 20:46:23 joel Exp $ */ #define MAIN_USE_NETWORKING #define MAIN_USE_REQUIRES_COMMAND_LINE #include #include #include #include #include #include "rtems_networkconfig.h" extern rtems_configuration_table BSP_Configuration; /* * Using GNAT's Distributed Systems Annex support requires * each node in the system to have different pid's. In a * single CPU RTEMS system, it is always one. This lets the * user override the RTEMS default. */ #ifdef GNAT_PID #include pid_t getpid() { return GNAT_PID; } #endif static int argc = 1; static char arg0[20] = "rtems"; static char *argv[20] = { arg0 }; #if defined(MAIN_USE_REQUIRES_COMMAND_LINE) #define COMMAND_LINE_MAXIMUM 200 #include #include void parse_arguments( char *buffer, size_t maximum_length ) { char *cp; char *linebuf = buffer; size_t length; for (;;) { /* * Set up first argument */ #if 0 argc = 1; strcpy (arg0, "rtems"); argv[0] = arg0; #endif #if (defined (MAIN_COMMAND_LINE)) strncpy (linebuf, MAIN_COMMAND_LINE, maximum_length); #else /* * Read a line */ printf (">>> %s ", argv[0]); fflush (stdout); fgets (linebuf, maximum_length, stdin); length = strnlen( linebuf, maximum_length ); if ( linebuf[length - 1] == '\n' || linebuf[length - 1] == '\r' ) { linebuf[length - 1] = '\0'; } #endif /* * Break line into arguments */ cp = linebuf; for (;;) { while (isspace (*cp)) *cp++ = '\0'; if (*cp == '\0') break; if (argc >= ((sizeof argv / sizeof argv[0]) - 1)) { printf ("Too many arguments.\n"); argc = 0; break; } argv[argc++] = cp; while (!isspace (*cp)) { if (*cp == '\0') break; cp++; } } if (argc > 1) { argv[argc] = NULL; break; } printf ("You must give some arguments!\n"); } #if 0 { int i; for (i=0; i adasockets-1.10.1/examples/rtems_networkconfig.h000066400000000000000000000073611277046543400220160ustar00rootroot00000000000000/* * Network configuration for an IceCube in RTEMS Lab * ************************************************************ * EDIT THIS FILE TO REFLECT YOUR NETWORK CONFIGURATION * * BEFORE RUNNING ANY RTEMS PROGRAMS WHICH USE THE NETWORK! * ************************************************************ * * $Id: rtems_networkconfig.h,v 1.1 2007/09/17 20:46:23 joel Exp $ */ #ifndef _RTEMS_NETWORKCONFIG_H_ #define _RTEMS_NETWORKCONFIG_H_ /* * The following will normally be set by the BSP if it supports * a single network device driver. In the event, it supports * multiple network device drivers, then the user's default * network device driver will have to be selected by a BSP * specific mechanism. */ #ifndef RTEMS_BSP_NETWORK_DRIVER_NAME #warning "RTEMS_BSP_NETWORK_DRIVER_NAME is not defined" #define RTEMS_BSP_NETWORK_DRIVER_NAME "no_network1" #endif #ifndef RTEMS_BSP_NETWORK_DRIVER_ATTACH #warning "RTEMS_BSP_NETWORK_DRIVER_ATTACH is not defined" #define RTEMS_BSP_NETWORK_DRIVER_ATTACH 0 #endif /* #define RTEMS_USE_BOOTP */ #include /* * Define RTEMS_SET_ETHERNET_ADDRESS if you want to specify the * Ethernet address here. If RTEMS_SET_ETHERNET_ADDRESS is not * defined the driver will choose an address. */ #define RTEMS_SET_ETHERNET_ADDRESS #if (defined (RTEMS_SET_ETHERNET_ADDRESS)) static char ethernet_address[6] = { 0x00, 0x11, 0x22, 0x33, 0x44, 0x55 }; #endif #ifdef RTEMS_USE_LOOPBACK /* * Loopback interface */ extern void rtems_bsdnet_loopattach(); static struct rtems_bsdnet_ifconfig loopback_config = { "lo0", /* name */ rtems_bsdnet_loopattach, /* attach function */ NULL, /* link to next interface */ "127.0.0.1", /* IP address */ "255.0.0.0", /* IP net mask */ }; #endif /* * Default network interface */ static struct rtems_bsdnet_ifconfig netdriver_config = { RTEMS_BSP_NETWORK_DRIVER_NAME, /* name */ RTEMS_BSP_NETWORK_DRIVER_ATTACH, /* attach function */ #ifdef RTEMS_USE_LOOPBACK &loopback_config, /* link to next interface */ #else NULL, /* No more interfaces */ #endif #if (defined (RTEMS_USE_BOOTP)) NULL, /* BOOTP supplies IP address */ NULL, /* BOOTP supplies IP net mask */ #else "192.168.1.244", /* IP address */ "255.255.255.0", /* IP net mask */ #endif /* !RTEMS_USE_BOOTP */ #if (defined (RTEMS_SET_ETHERNET_ADDRESS)) ethernet_address, /* Ethernet hardware address */ #else NULL, /* Driver supplies hardware address */ #endif 0, /* Use default driver parameters */ 0, /* mtu */ 0, /* rbuf_count */ 0, /* xbuf_count */ 0, /* port */ 0 /* irq */ }; /* * Network configuration */ struct rtems_bsdnet_config rtems_bsdnet_config = { &netdriver_config, #if (defined (RTEMS_USE_BOOTP)) rtems_bsdnet_do_bootp, #else NULL, #endif 0, /* Default network task priority */ 256 * 1024, /* Default mbuf capacity */ 256 * 1024, /* Default mbuf cluster capacity */ #if (!defined (RTEMS_USE_BOOTP)) "rtems", /* Host name */ "nodomain.com", /* Domain name */ "192.168.1.14", /* Gateway */ "192.168.1.1", /* Log host */ {"192.168.1.1" }, /* Name server(s) */ {"192.168.1.1" }, /* NTP server(s) */ #endif /* !RTEMS_USE_BOOTP */ }; /* * For TFTP test application */ #if (defined (RTEMS_USE_BOOTP)) #define RTEMS_TFTP_TEST_HOST_NAME "BOOTP_HOST" #define RTEMS_TFTP_TEST_FILE_NAME "BOOTP_FILE" #else #define RTEMS_TFTP_TEST_HOST_NAME "XXX.YYY.ZZZ.XYZ" #define RTEMS_TFTP_TEST_FILE_NAME "tftptest" #endif /* * For NFS test application * * NFS server/path to mount and a directory to ls once mounted */ #define RTEMS_NFS_SERVER "192.168.1.210" #define RTEMS_NFS_SERVER_PATH "/home" #define RTEMS_NFS_LS_PATH "/mnt/nfstest" #endif /* _RTEMS_NETWORKCONFIG_H_ */ adasockets-1.10.1/examples/stream_listener.adb000066400000000000000000000107571277046543400214270ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S T R E A M _ L I S T E N E R -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 ENST http://www.enst.fr/ -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets -- -- -- -- If you have any question, please send a mail to the AdaSockets list -- -- adasockets@lists.rfc1149.net -- -- -- ----------------------------------------------------------------------------- with Ada.Command_Line; use Ada.Command_Line; with Ada.Exceptions; use Ada.Exceptions; with Ada.Text_IO; use Ada.Text_IO; with Sockets.Stream_IO; use Sockets, Sockets.Stream_IO; procedure Stream_Listener is -- Usage: stream_listener port -- Example: stream_listener 5000 -- then stream_sender localhost 5000 task type Echo is entry Start (FD : Socket_FD); end Echo; ---------- -- Echo -- ---------- task body Echo is Sock : Socket_FD; Stream : aliased Socket_Stream_Type; begin select accept Start (FD : Socket_FD) do Sock := FD; Initialize (Stream, Sock); end Start; or terminate; end select; loop Put_Line ("I received: " & String'Input (Stream'Access)); end loop; exception when Connection_Closed => Put_Line ("Connection closed"); Shutdown (Sock, Both); end Echo; Accepting_Socket : Socket_FD; Incoming_Socket : Socket_FD; type Echo_Access is access Echo; Dummy : Echo_Access; begin if Argument_Count /= 1 then Raise_Exception (Constraint_Error'Identity, "Usage: " & Command_Name & " port"); end if; Socket (Accepting_Socket, PF_INET, SOCK_STREAM); Setsockopt (Accepting_Socket, SOL_SOCKET, SO_REUSEADDR, 1); Bind (Accepting_Socket, Positive'Value (Argument (1))); Listen (Accepting_Socket); loop Put_Line ("Waiting for new connection"); Accept_Socket (Accepting_Socket, Incoming_Socket); Put_Line ("New connection acknowledged"); Dummy := new Echo; Dummy.Start (Incoming_Socket); end loop; end Stream_Listener; adasockets-1.10.1/examples/stream_sender.adb000066400000000000000000000075001277046543400210520ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S T R E A M _ S E N D E R -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 ENST http://www.enst.fr/ -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets -- -- -- -- If you have any question, please send a mail to the AdaSockets list -- -- adasockets@lists.rfc1149.net -- -- -- ----------------------------------------------------------------------------- with Ada.Command_Line; use Ada.Command_Line; with Ada.Exceptions; use Ada.Exceptions; with Ada.Text_IO; use Ada.Text_IO; with Sockets.Stream_IO; use Sockets, Sockets.Stream_IO; procedure Stream_Sender is -- Usage: stream_sender remotehost remoteport -- Example: stream_sender localhost 5000 Outgoing_Socket : Socket_FD; Stream : aliased Socket_Stream_Type; Line : String (1 .. 200); Last : Natural; begin if Argument_Count /= 2 then Raise_Exception (Constraint_Error'Identity, "Usage: " & Command_Name & " remotehost remoteport"); end if; Socket (Outgoing_Socket, PF_INET, SOCK_STREAM); Connect (Outgoing_Socket, Argument (1), Positive'Value (Argument (2))); Initialize (Stream, Outgoing_Socket); loop Put ("Type a string> "); Flush; Get_Line (Line, Last); String'Output (Stream'Access, Line (Line'First .. Last)); end loop; exception when End_Error => null; end Stream_Sender; adasockets-1.10.1/examples/tcprelay.adb000066400000000000000000000114671277046543400200510ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- T C P R E L A Y -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 ENST http://www.enst.fr/ -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets -- -- -- -- If you have any question, please send a mail to the AdaSockets list -- -- adasockets@lists.rfc1149.net -- -- -- ----------------------------------------------------------------------------- with Ada.Command_Line; use Ada.Command_Line; with Ada.Exceptions; use Ada.Exceptions; with Ada.Text_IO; use Ada.Text_IO; with Sockets; use Sockets; procedure TCPRelay is -- Usage: tcprelay localport remotehost remoteport -- Example: tcprelay 5000 localhost 25, -- then telnet localhost 5000 task type Relay is entry Start (From, To : Socket_FD); end Relay; ----------- -- Relay -- ----------- task body Relay is From_FD, To_FD : Socket_FD; begin select accept Start (From, To : Socket_FD) do From_FD := From; To_FD := To; end Start; or terminate; end select; loop Send (To_FD, Receive (From_FD)); end loop; exception when Connection_Closed => Put_Line ("Connection closed"); Shutdown (From_FD, Receive); Shutdown (To_FD, Send); end Relay; Accepting_Socket, Incoming_Socket, Outgoing_Socket : Socket_FD; type Relay_Access is access Relay; Dummy : Relay_Access; begin if Argument_Count /= 3 then Raise_Exception (Constraint_Error'Identity, "Usage: " & Command_Name & " localport remotehost remoteport"); end if; Socket (Accepting_Socket, PF_INET, SOCK_STREAM); Setsockopt (Accepting_Socket, SOL_SOCKET, SO_REUSEADDR, 1); Bind (Accepting_Socket, Positive'Value (Argument (1))); Listen (Accepting_Socket); loop Put_Line ("Waiting for new connection"); Accept_Socket (Accepting_Socket, Incoming_Socket); Put_Line ("New connection acknowledged"); Socket (Outgoing_Socket, PF_INET, SOCK_STREAM); Put_Line ("Connecting to remote host"); Connect (Outgoing_Socket, Argument (2), Positive'Value (Argument (3))); Put_Line ("Connection established"); Dummy := new Relay; Dummy.Start (Incoming_Socket, Outgoing_Socket); Dummy := new Relay; Dummy.Start (Outgoing_Socket, Incoming_Socket); end loop; end TCPRelay; adasockets-1.10.1/man/000077500000000000000000000000001277046543400145025ustar00rootroot00000000000000adasockets-1.10.1/man/Makefile.am000066400000000000000000000000701277046543400165330ustar00rootroot00000000000000man_MANS = adasockets-config.1 EXTRA_DIST = ${man_MANS} adasockets-1.10.1/man/adasockets-config.1000066400000000000000000000006511277046543400201520ustar00rootroot00000000000000'\" t .TH adasockets-config 1 "18 March 2010" .SH NAME adasockets-config \- script to get information about the installed AdaSockets library .SH SYNOPSIS .B adasockets-config [\-\-version] [\-\-libs] [\-\-cflags] .SH DESCRIPTION .B adasockets-config will echo a line on standard output with appropriate flags for .B gnatmake . .SH "SEE ALSO" .BR gnatmake (1), .BR pkg-config (1) .SH AUTHORS Samuel Tardieu adasockets-1.10.1/rtems/000077500000000000000000000000001277046543400150615ustar00rootroot00000000000000adasockets-1.10.1/rtems/ChangeLog000066400000000000000000000010051277046543400166270ustar00rootroot000000000000002007-09-11 Joel Sherrill * .cvsignore: Add more to ignore. 2007-09-11 Joel Sherrill * README: Move instructions to top level README.RTEMS. * Makefile.RTEMS: New file. * Makefile.constants: Removed. 2007-09-11 Joel Sherrill * .cvsignore: New file. 2007-09-11 Joel Sherrill * ChangeLog, Makefile.constants, README, create_constants_c.sh, rtems_main.c, sockets-constants-rtems.ads: New files. adasockets-1.10.1/rtems/Makefile.RTEMS000066400000000000000000000016051277046543400174140ustar00rootroot00000000000000# # Makefile.constants # # Build the constants.exe program that MUST be run on an RTEMS target. # It should be able to be ANY target including a simulator since the # constants in question should be the same across all architectures # and BSPs # # $Id: Makefile.RTEMS,v 1.1 2007/09/11 15:12:56 joel Exp $ # # # RTEMS_MAKEFILE_PATH is typically set in an environment variable # or make is invoked like "RTEMS_MAKEFILE_PATH=XXX make" # # optional managers required MANAGERS=all # C source names COBJS = ${ARCH}/rtems_main.o ${ARCH}/constants.o include $(RTEMS_MAKEFILE_PATH)/Makefile.inc include $(RTEMS_CUSTOM) include $(PROJECT_ROOT)/make/leaf.cfg CLEAN_ADDITIONS += constants.c OBJS= $(COBJS) all: $(ARCH)/constants.exe $(ARCH)/constants.exe: $(ARCH) $(OBJS) $(make-exe) constants.c: create_constants_c.sh ../vms/constants.list sh ./create_constants_c.sh ../vms/constants.list $@ adasockets-1.10.1/rtems/README000066400000000000000000000037061277046543400157470ustar00rootroot00000000000000# # $Id: README,v 1.2 2007/09/11 15:12:57 joel Exp $ # This directory contains the support files for building the sockets-constants.ads file for RTEMS. See the README.RTEMS in the top level directory for complete build instructions. Prerequisites ============= Build and install a working GNAT/RTEMS toolset and a BSP. Make sure networking and POSIX are enabled. Detailed instructions are available online in the RTEMS Wiki at: http://www.rtems.org/wiki/index.php/RTEMSAda Run at least one sample from the RTEMS build (e.g. hello.exe or sample.exe) to confirm that RTEMS itself was properly built. Build and run the RTEMS hello_world_ada from the ada-examples package using your GNAT/RTEMS development environment. If everything is working at this point, then you are ready to build Ada Sockets. Generate sockets-constants-ads ============================== We will use the RTEMS you installed to build and run a program called "constants.exe". The output of this program needs to be saved as sockets-constants.ads. To compile this program use the Makefile.constants. RTEMS_MAKEFILE_PATH=install_patch_of_BSP \ make -f Makefile.constants Then run the program o-optimize/constants.exe on the target hardware. Your saved target board output may end up with DOS style CR/LF's. Run "dos2unix" on the file to get it back to Unix style. There is a version of this file generated using psim using a pre-4.8 CVS snapshot of RTEMS which should work on any target. You can use this but you would be safer to generate your own. Consider it an example of how it should look when it works. Building Ada Sockets ==================== Now that you have a sockets-constants.ads, we can build the Ada Sockets library. Makefile.adasockets is provided for this step: RTEMS_MAKEFILE_PATH=install_patch_of_BSP \ make -f Makefile.lib After the library is compiled, it may be installed using the following: RTEMS_MAKEFILE_PATH=install_patch_of_BSP \ make -f Makefile.lib install adasockets-1.10.1/rtems/create_constants_c.sh000066400000000000000000000042141277046543400212570ustar00rootroot00000000000000#! /bin/sh # # # This script completes the constants.c_pre file with the # the list of defines needed to build the adasockets constant # package. # # This file is part of Adasockets for RTEMS. # if [ $# -ne 2 ] ; then echo $0: constantsFile outputFile exit 1 fi constantListFile=$1 outputFile=$2 cat >${outputFile} < #include #include #include #include #include #include #include #include #include #include #include #include #include static char * capitalize (char *name) { int beginning = 1; char *result = (char *) malloc (strlen (name) + 1); char *ptr; for (ptr = result; *name; ptr++, name++) { *ptr = *name; if (beginning) { beginning = 0; } else if (*ptr == '_') { beginning = 1; } else if (isupper(*ptr)) { *ptr = tolower(*ptr); } } *ptr = '\0'; return result; } static void output (char *name, int value) { char *capitalized = capitalize (name); if (value != -1) { printf (" %-20s : constant := 16#%04X#;\n", capitalized, value); } else { printf (" %-20s : constant := %d;\n", capitalized, value); } } void print_body(void); void print_socket_constants_ads( void ) { printf( "-- This file has been generated automatically by\n" "-- the constants.c file generated by create_constants_c.sh.\n" "--\n" "-- This file is part of adasockets port to RTEMS.\n" "--\n" "\n" "package sockets.constants is\n" ); print_body(); printf( "end sockets.constants;\n"); } void print_body() { EOF # # Now generate the body of the function that acr # while read line do echo "#ifdef ${line}" echo " output( \"${line}\", ${line});" echo "#else" echo " output( \"${line}\", -1);" echo "#endif" done < ${constantListFile} >>${outputFile} echo "}" >>${outputFile} exit 0 adasockets-1.10.1/rtems/rtems_main.c000066400000000000000000000010041277046543400173560ustar00rootroot00000000000000/* * Simple test program -- simplified version of sample test hello. */ #include #include #include rtems_task Init( rtems_task_argument ignored ) { extern void print_socket_constants_ads( void ); print_socket_constants_ads(); exit( 0 ); } /* configuration information */ #define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER #define CONFIGURE_RTEMS_INIT_TASKS_TABLE #define CONFIGURE_MAXIMUM_TASKS 1 #define CONFIGURE_INIT #include /* end of file */ adasockets-1.10.1/rtems/sockets-constants-rtems.ads000066400000000000000000000073421277046543400223750ustar00rootroot00000000000000-- This file has been generated automatically by -- the constants.c file generated by create_constants_c.sh. -- -- This file is part of adasockets port to RTEMS. -- package sockets.constants is Tcp_Nodelay : constant := 16#0001#; Af_Inet : constant := 16#0002#; Af_Unix : constant := 16#0001#; Sock_Stream : constant := 16#0001#; Sock_Dgram : constant := 16#0002#; Eintr : constant := 16#0004#; Eagain : constant := 16#000B#; Ewouldblock : constant := 16#000B#; Einprogress : constant := 16#0077#; Ealready : constant := 16#0078#; Eisconn : constant := 16#007F#; Econnrefused : constant := 16#006F#; Fndelay : constant := 16#4000#; Fasync : constant := 16#0040#; Fioasync : constant := 16#8004667D#; F_Getfl : constant := 16#0003#; F_Setfl : constant := 16#0004#; F_Setown : constant := 16#0006#; Fiossaioown : constant := -1; So_Rcvbuf : constant := 16#1002#; So_Reuseaddr : constant := 16#0004#; So_Reuseport : constant := -1; Sol_Socket : constant := 16#FFFF#; Sigterm : constant := 16#000F#; Sigkill : constant := 16#0009#; O_Rdonly : constant := 16#0000#; O_Wronly : constant := 16#0001#; O_Rdwr : constant := 16#0002#; Host_Not_Found : constant := 16#0001#; Try_Again : constant := 16#0002#; No_Recovery : constant := 16#0003#; No_Data : constant := 16#0004#; No_Address : constant := 16#0004#; Pollin : constant := -1; Pollpri : constant := -1; Pollout : constant := -1; Pollerr : constant := -1; Pollhup : constant := -1; Pollnval : constant := -1; I_Setsig : constant := -1; S_Rdnorm : constant := -1; S_Wrnorm : constant := -1; Ipproto_Ip : constant := 16#0000#; Ip_Add_Membership : constant := 16#000C#; Ip_Multicast_Loop : constant := 16#000B#; Ip_Multicast_Ttl : constant := 16#000A#; Ip_Drop_Membership : constant := 16#000D#; O_Nonblock : constant := 16#4000#; Msg_Peek : constant := 16#0002#; Fionbio : constant := 16#8004667E#; Fionread : constant := 16#4004667F#; So_Sndbuf : constant := 16#1001#; Af_Inet6 : constant := 16#001C#; Ai_Addrconfig : constant := -1; Ai_All : constant := -1; Ai_Canonname : constant := -1; Ai_Default : constant := -1; Ai_Mask : constant := -1; Ai_Numerichost : constant := -1; Ai_Passive : constant := -1; Ai_V4mapped : constant := -1; Ai_V4mapped_Cfg : constant := -1; Ni_Dgram : constant := -1; Ni_Maxhost : constant := -1; Ni_Maxserv : constant := -1; Ni_Namereqd : constant := -1; Ni_Nofqdn : constant := -1; Ni_Numerichost : constant := -1; Ni_Numericserv : constant := -1; Ni_Withscopeid : constant := -1; Ipproto_Ipv6 : constant := 16#0029#; Ipv6_Unicast_Hops : constant := -1; Ipv6_Multicast_If : constant := -1; Ipv6_Multicast_Hops : constant := -1; Ipv6_Multicast_Loop : constant := -1; Ipv6_Join_Group : constant := -1; Ipv6_Leave_Group : constant := -1; end sockets.constants; adasockets-1.10.1/src/000077500000000000000000000000001277046543400145165ustar00rootroot00000000000000adasockets-1.10.1/src/Makefile.RTEMS000066400000000000000000000034241277046543400170520ustar00rootroot00000000000000# # Makefile.RTEMS # # Build the Ada Sockets packages for a SPECIFIC RTEMS BSP. # This Makefile should work for any RTEMS BSP as long as # it is installed and you set RTEMS_MAKEFILE_PATCH appropriately. # # RTEMS_MAKEFILE_PATH is typically set in an environment variable # or make is invoked like "RTEMS_MAKEFILE_PATH=XXX make" # # $Id: Makefile.RTEMS,v 1.1 2007/09/11 22:38:24 joel Exp $ # # # .PHONY: all distclean clean .DEFAULT: all include $(RTEMS_MAKEFILE_PATH)/Makefile.inc include $(RTEMS_CUSTOM) include $(PROJECT_ROOT)/make/leaf.cfg # RTEMS specific files that are generated by copy or sed RTEMS_FILES=\ sockets-types.ads\ sockets-thin.ads\ sockets-link.ads\ sockets-constants.ads FILES= sockets-multicast.adb\ sockets-naming.adb\ sockets-stream_io.adb\ sockets-utils.adb\ sockets.adb\ $(RTEMS_FILES) ADS_OBJ=$(patsubst %.ads, %.o, $(filter %.ads, $(FILES))) ADB_OBJ=$(patsubst %.adb, %.o, $(filter %.adb, $(FILES))) # These get removed by RTEMS clean and distclean rules CLEAN_ADDITIONS+= *.ali *.o b$*.* $(RTEMS_FILES) all: $(FILES) $(ADB_OBJ) $(ADS_OBJ) sockets-types.ads: sockets-types.ads.in Makefile.RTEMS sed -e 's/^@SA_LEN@//' \ -e '/@NO_SA_LEN@/d' <$< >$@ sockets-link.ads: sockets-link.ads.in Makefile.RTEMS sed -e '/@WINNEEDED@/d' \ -e '/@NSLNEEDED@/d' \ -e '/@SOCKETNEEDED@/d' \ -e '/@RESOLVNEEDED@/d' $< >$@ sockets-thin.ads: sockets-thin.ads.unix cp -p $< $@ sockets-constants.ads: ../rtems/sockets-constants.ads cp -p $< $@ $(ADB_OBJ): %.o: %.adb $(CC) $(CPU_CFLAGS) $(CFLAGS)-c $< $(ADS_OBJ): %.o: %.ads $(CC) $(CPU_CFLAGS) $(CFLAGS)-c $< # Install this with the BSP the user has specified with RTEMS_MAKEFILE_PATH install: $(INSTALL_VARIANT) $(FILES) $(ADS_OBJ) $(ADB_OBJ) $(PROJECT_RELEASE)/lib/include/adainclude adasockets-1.10.1/src/Makefile.VMS000066400000000000000000000022571277046543400166300ustar00rootroot00000000000000# Makefile for OpenVMS (GNU Make) # # $Revision$ # # # This file is part of adasockets port to OpenVMS # .PHONY: all distclean clean .DEFAULT: all FILES= sockets-thin.adb\ sockets-multicast.adb\ sockets-naming.adb\ sockets-stream_io.adb\ sockets-utils.adb\ sockets.adb\ sockets-constants.ads\ sockets-vms_link.ads\ sockets-link.ads VMS_FILES=\ sockets-thin.adb\ sockets-thin.ads\ sockets-link.ads\ sockets-constants.ads ADS_OBJ=$(patsubst %.ads, %.obj, $(filter %.ads, $(FILES))) ADB_OBJ=$(patsubst %.adb, %.obj, $(filter %.adb, $(FILES))) all: $(VMS_FILES) $(FILES) $(ADB_OBJ) $(ADS_OBJ) sockets-thin.adb: copy/log sockets-thin.adb_vms sockets-thin.adb sockets-thin.ads: copy/log sockets-thin.ads_vms sockets-thin.ads sockets-link.ads: copy/log sockets-link.ads_vms sockets-link.ads sockets-constants.ads: make "-C" [-.vms] -f Makefile.VMS all copy/log [-.vms]sockets-constants.ads [-.src]*.* $(ADB_OBJ): %.obj: %.adb gnat comp /debug $< $(ADS_OBJ): %.obj: %.ads gnat comp /debug $< distclean: del/noconf/log *.ali;*, *.obj;*, b$*.*;*, sockets-link.ads;* del/noconf/log sockets-thin.ads;*, sockets-thin.adb;* del/noconf/log sockets-constants.ads;* clean: adasockets-1.10.1/src/Makefile.am000066400000000000000000000076731277046543400165670ustar00rootroot00000000000000CCLD = $(CC) privatelibdir = $(libdir)/adasockets bin_SCRIPTS = adasockets-config lib_LTLIBRARIES = libadasockets.la dist_libadasockets_la_SOURCES = \ sockets-multicast.ads \ sockets-multicast.adb \ sockets-naming.ads \ sockets-naming.adb \ sockets-stream_io.ads \ sockets-stream_io.adb \ sockets-utils.ads \ sockets-utils.adb \ sockets.ads \ sockets.adb nodist_libadasockets_la_SOURCES = \ sockets-thin.ads \ sockets-constants.ads \ sockets-link.ads \ sockets-types.ads libadasockets_la_LDFLAGS = -version-info $(LIBVERSIONINFO) EXTRA_DIST = Makefile.RTEMS Makefile.VMS sockets-vms_link.ads \ sockets-windows_link.ads sockets-windows_link.adb \ sockets-link.ads.vms \ sockets-thin.adb.vms sockets-thin.adb.win32 \ sockets-thin.ads.unix sockets-thin.ads.vms sockets-thin.ads.win32 \ constants.c constants.sh \ split.adb adasockets-config ADA_OBJECTS = \ sockets-constants.o \ sockets-link.o \ sockets-multicast.o \ sockets-naming.o \ sockets-stream_io.o \ sockets-thin.o \ sockets-types.o \ sockets-utils.o \ sockets.o ALIS = $(ADA_OBJECTS:.o=.ali) ADACOMPILER = $(top_srcdir)/support/adacompiler ADAFLAGS = @ADAFLAGS@ -I. -I$(srcdir) CLEANFILES = *.o *.ali b~* DISTCLEANFILES = b_split.c split constants_nodef \ sockets-thin.ads sockets-thin.adb \ sockets-constants.ads constants_nodef: constants.c config.h $(CC) -I. -o constants_nodef $(srcdir)/constants.c $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) sockets-constants.ads: $(srcdir)/constants.sh split constants_nodef $(SHELL) $(srcdir)/constants.sh Sockets.Constants $(srcdir) \ sockets-constants.ads "$(CC)" split: $(srcdir)/split.adb $(GNATMAKE) $(srcdir)/split.adb -cargs $(ADAFLAGS) -largs $(LDFLAGS) pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = adasockets.pc if WIN32 nodist_libadasockets_la_SOURCES += \ sockets-windows_link.ads sockets-windows_link.adb \ sockets-thin.adb ADA_OBJECTS += sockets-windows_link.o sockets-thin.ads: $(srcdir)/sockets-thin.ads.win32 cp -p $(srcdir)/sockets-thin.ads.win32 sockets-thin.ads cp -p $(srcdir)/sockets-thin.adb.win32 sockets-thin.adb else sockets-thin.ads: $(srcdir)/sockets-thin.ads.unix cp -p -f $(srcdir)/sockets-thin.ads.unix sockets-thin.ads endif SUFFIXES = .ads .lo .ali .ads.lo: if [ -f `echo $< | sed -e 's/s$$/b/'` ]; then \ $(LIBTOOL) --tag=CC --mode=compile \ $(ADACOMPILER) $(GNATMAKE) -cargs $(ADAFLAGS) -largs $(LDFLAGS) -margs \ `echo $< | sed -e 's/s$$/b/'`; \ else \ $(LIBTOOL) --tag=CC --mode=compile \ $(ADACOMPILER) $(GNATMAKE) -cargs $(ADAFLAGS) -largs $(LDFLAGS) -margs $<; \ fi .lo.ali: install-data-local: all rm -rf $(DESTDIR)$(privatelibdir) $(mkinstalldirs) $(DESTDIR)$(privatelibdir) $(INSTALL) -m 444 $(ALIS) $(DESTDIR)$(privatelibdir) for i in $(dist_libadasockets_la_SOURCES) $(nodist_libadasockets_la_SOURCES); do \ if test -f $$i; then \ $(INSTALL) -m 644 $$i $(DESTDIR)$(privatelibdir); \ else \ $(INSTALL) -m 644 $(srcdir)/$$i $(DESTDIR)$(privatelibdir); \ fi \ done uninstall-local: rm -rf $(DESTDIR)$(privatelibdir) ### DO NOT REMOVE THIS LINE, IT IS USED BY MAKEDEPEND ### sockets-multicast.lo : sockets.ads sockets.adb sockets-constants.ads \ sockets-link.ads sockets-multicast.ads sockets-multicast.adb \ sockets-naming.ads sockets-thin.ads sockets-types.ads sockets-utils.ads sockets.lo : sockets.ads sockets.adb sockets-constants.ads sockets-link.ads \ sockets-naming.ads sockets-thin.ads sockets-types.ads sockets-utils.ads sockets-constants.lo : sockets.ads sockets-constants.ads sockets-naming.lo : sockets.ads sockets-constants.ads sockets-naming.ads \ sockets-naming.adb sockets-thin.ads sockets-types.ads sockets-utils.ads sockets-thin.lo : sockets.ads sockets-thin.ads sockets-types.ads sockets-types.lo : sockets.ads sockets-types.ads sockets-utils.lo : sockets.ads sockets-thin.ads sockets-types.ads \ sockets-utils.ads sockets-utils.adb sockets-link.lo : sockets.ads sockets-link.ads sockets-stream_io.lo : sockets.ads sockets-stream_io.ads sockets-stream_io.adb adasockets-1.10.1/src/adasockets-config000066400000000000000000000002301277046543400200200ustar00rootroot00000000000000#! /bin/sh # if [ "x$1" = "x--version" ]; then set -- --modversion elif [ "x$1" = "x" ]; then set -- --cflags --libs fi pkg-config adasockets "$@" adasockets-1.10.1/src/adasockets.pc.in000066400000000000000000000003661277046543400175750ustar00rootroot00000000000000prefix=@prefix@ exec_prefix=@exec_prefix@ libdir=@libdir@ includedir=@includedir@ Name: @PACKAGE@ Description: BSD sockets in Ada. Requires: Version: @VERSION@ Libs: -L${libdir} -ladasockets Cflags: -I${libdir}/adasockets -L${libdir}/adasockets adasockets-1.10.1/src/constants.c000066400000000000000000000054641277046543400167070ustar00rootroot00000000000000/* * This program must be called with the constant name as the CONSTANT_NAME * define. If this is not the case, then a generic version which takes a * symbol to undefine as the first argument will be built. */ #include #ifdef HAVE_SYS_CONF_H # ifdef HAVE_SYS_PARAM_H # include # endif # ifdef HAVE_TIME_H # include # endif #include #endif #ifdef HAVE_SYS_FILE_H #include #endif #ifdef HAVE_SYS_IOCTL_H #include #endif #ifdef HAVE_SYS_SOCKET_H #include #endif #ifdef HAVE_SYS_SYSTEMINFO_H #include #endif #ifdef HAVE_SYS_TYPES_H #include #endif #ifdef HAVE_ERRNO_H #include #endif #ifdef HAVE_FCNTL_H #include #endif #ifdef HAVE_NETDB_H #include #endif #ifdef HAVE_NETINET_IN_H #include #endif #ifdef HAVE_NETINET_TCP_H #include #endif #ifdef HAVE_POLL_H #include #endif #ifdef HAVE_SIGNAL_H #include #endif #ifdef HAVE_STDIO_H #include #endif #ifdef HAVE_STDLIB_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_STROPTS_H #include #endif #ifdef HAVE_TERMIO_H #include #endif #ifdef HAVE_TERMIOS_H #include #endif #ifdef HAVE_LINUX_SOCKIOS_H #include #endif #ifdef HAVE_WINDOWS_H #define Win32_Winsock #include /* This directive is checked only for mingw32 2.8.1 */ #if (_WIN32_WINNT >= 0x0400) #include #endif /* Absent declarations */ #define POLLIN 1 #define POLLPRI 2 #define POLLOUT 4 /* Undefine cygwin specific declarations to replace them */ #undef EINTR #undef EWOULDBLOCK #undef EINPROGRESS #undef EALREADY #undef EISCONN #undef ECONNREFUSED /* Replace with Windows sockets declaration */ #define EINTR WSAEINTR #define EWOULDBLOCK WSAEWOULDBLOCK #define EINPROGRESS WSAEINPROGRESS #define EALREADY WSAEALREADY #define EISCONN WSAEISCONN #define ECONNREFUSED WSAECONNREFUSED #endif #include static char * capitalize (char *name) { int beginning = 1; char *result = (char *) malloc (strlen (name) + 1); char *ptr; for (ptr = result; *name; ptr++, name++) { *ptr = *name; if (beginning) { beginning = 0; } else if (*ptr == '_') { beginning = 1; } else if (isupper(*ptr)) { *ptr = tolower(*ptr); } } *ptr = '\0'; return result; } static void output (char *name, int value) { char *capitalized = capitalize (name); if (value >= 0) { printf (" %-20s : constant := 16#%04X#;\n", capitalized, value); } else { printf (" %-20s : constant := %d;\n", capitalized, value); } } int main (int argc, char *argv[]) { #ifdef CONSTANT_NAME output (argv[1], CONSTANT_NAME); #else output (argv[1], -1); #endif exit (0); } adasockets-1.10.1/src/constants.sh000066400000000000000000000060451277046543400170730ustar00rootroot00000000000000#!/bin/sh # # This file generates any necessary constant for a given platform. # # Name of package name=$1 srcdir=$2 fname=$3 CC="$4" # List of constants we need to know constants="TCP_NODELAY AF_INET AF_UNIX SOCK_STREAM SOCK_DGRAM EINTR EAGAIN" constants="${constants} EWOULDBLOCK EINPROGRESS EALREADY EISCONN" constants="${constants} ECONNREFUSED FNDELAY FASYNC-FIOASYNC F_GETFL F_SETFL" constants="${constants} F_SETOWN-FIOSSAIOOWN SO_RCVBUF SO_REUSEADDR" constants="${constants} SO_REUSEPORT" constants="${constants} SOL_SOCKET SIGTERM SIGKILL O_RDONLY O_WRONLY" constants="${constants} O_RDWR HOST_NOT_FOUND TRY_AGAIN NO_RECOVERY" constants="${constants} NO_DATA NO_ADDRESS POLLIN POLLPRI POLLOUT POLLERR" constants="${constants} POLLHUP POLLNVAL I_SETSIG S_RDNORM S_WRNORM" constants="${constants} IPPROTO_IP IP_ADD_MEMBERSHIP IP_MULTICAST_LOOP" constants="${constants} IP_MULTICAST_TTL IP_DROP_MEMBERSHIP" constants="${constants} O_NONBLOCK MSG_PEEK FIONBIO FIONREAD SO_SNDBUF" constants="${constants} SOL_TCP SO_KEEPALIVE TCP_KEEPCNT TCP_KEEPIDLE TCP_KEEPINTVL" constants="${constants} SO_NOSIGPIPE MSG_NOSIGNAL" # ipv6 constants="${constants} AF_INET6" # Constants for protocol independent nodename-address translations constants="${constants} AI_ADDRCONFIG AI_ALL AI_CANONNAME" constants="${constants} AI_DEFAULT AI_MASK AI_NUMERICHOST" constants="${constants} AI_PASSIVE AI_V4MAPPED AI_V4MAPPED_CFG" constants="${constants} NI_DGRAM NI_MAXHOST NI_MAXSERV" constants="${constants} NI_NAMEREQD NI_NOFQDN NI_NUMERICHOST" constants="${constants} NI_NUMERICSERV NI_WITHSCOPEID" # setsockopt constants="${constants} IPPROTO_IPV6" constants="${constants} IPV6_UNICAST_HOPS IPV6_MULTICAST_IF" constants="${constants} IPV6_MULTICAST_HOPS IPV6_MULTICAST_LOOP" constants="${constants} IPV6_JOIN_GROUP IPV6_LEAVE_GROUP" # ioctl constants="${constants} SIOCINQ SIOCOUTQ" # Debug debug=$1 # Look for any header file found tmpe=./tmpe$$ trap "rm -f ${tmpe}" 0 1 2 3 15 # Header of generated file cat > ${fname} << EOF -- This package has been generated automatically. -- Any change you make here is likely to be lost ! package ${name} is EOF # For each constant, try to output its value or -1 if undefined for c in ${constants}; do case ${c} in *-*) OIFS=${IFS}; IFS="-"; set ${c}; IFS=${OIFS}; \ echo "Checking value of $1 (or $2 as a substitute)"; \ (${CC} -DCONSTANT_NAME=$1 -I. -o ${tmpe} ${srcdir}/constants.c \ 2>/dev/null && ${tmpe} $1 >> ${fname}) || (${CC} -DCONSTANT_NAME=$2 -I. -o ${tmpe} ${srcdir}/constants.c \ 2>/dev/null && ${tmpe} $1 >> ${fname}) || ./constants_nodef $1 >> ${fname} ;; *) echo "Checking value of $c"; \ (${CC} -DCONSTANT_NAME=${c} -I. -o ${tmpe} ${srcdir}/constants.c \ 2>/dev/null && \ ${tmpe} ${c} >> ${fname}) || \ ./constants_nodef ${c} >> ${fname} ;; esac done # Trailer of generated file cat >> ${fname} << EOF end ${name}; EOF adasockets-1.10.1/src/header.txt000066400000000000000000000051441277046543400165130ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- XXXXX -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- adasockets-1.10.1/src/sockets-link.ads.in000066400000000000000000000061611277046543400202260ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . L I N K -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- @WINNEEDED@with Sockets.Windows_Link; @WINNEEDED@pragma Elaborate (Sockets.Windows_Link); private package Sockets.Link is @NSLNEEDED@pragma Linker_Options ("-lnsl"); @SOCKETNEEDED@pragma Linker_Options ("-lsocket"); @RESOLVNEEDED@pragma Linker_Options ("-lresolv"); end Sockets.Link; adasockets-1.10.1/src/sockets-link.ads.vms000066400000000000000000000056241277046543400204300ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . L I N K -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Sockets.VMS_Link; private package Sockets.Link is end Sockets.Link; adasockets-1.10.1/src/sockets-multicast.adb000066400000000000000000000173561277046543400206600ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . M U L T I C A S T -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Ada.Exceptions; use Ada.Exceptions; with Interfaces.C; use Interfaces.C; with Sockets; pragma Elaborate_All (Sockets); with Sockets.Constants; use Sockets.Constants; with Sockets.Naming; use Sockets.Naming; with Sockets.Thin; use Sockets.Thin; with Sockets.Types; use Sockets.Types; with Sockets.Utils; use Sockets.Utils; package body Sockets.Multicast is use Ada.Streams; procedure Setsockopt_Add_Membership is new Customized_Setsockopt (IPPROTO_IP, IP_ADD_MEMBERSHIP, Ip_Mreq); function Create_Multicast_Socket (Group : String; Port : Natural; Local_Port : Natural; TTL : Positive := 16; Self_Loop : Boolean := True; Local_If : String := "0.0.0.0") return Multicast_Socket_FD; ----------------------------- -- Create_Multicast_Socket -- ----------------------------- function Create_Multicast_Socket (Group : String; Port : Natural; Local_Port : Natural; TTL : Positive := 16; Self_Loop : Boolean := True; Local_If : String := "0.0.0.0") return Multicast_Socket_FD is Result : Multicast_Socket_FD; Mreq : aliased Ip_Mreq; C_Self_Loop : Integer; begin Socket (Socket_FD (Result), PF_INET, SOCK_DGRAM); if Self_Loop then C_Self_Loop := 1; else C_Self_Loop := 0; end if; Setsockopt (Result, SOL_SOCKET, SO_REUSEADDR, 1); pragma Warnings (Off); -- Statically determined if Constants.So_Reuseport /= -1 then Setsockopt (Result, SOL_SOCKET, SO_REUSEPORT, 1); end if; pragma Warnings (On); Bind (Result, Local_Port, Host => Local_If); Mreq.Imr_Multiaddr := To_In_Addr (Address_Of (Group)); Mreq.Imr_Interface := To_In_Addr (Address_Of ("0.0.0.0")); Setsockopt_Add_Membership (Result, Mreq); Setsockopt (Result, IPPROTO_IP, IP_MULTICAST_TTL, TTL); Setsockopt (Result, IPPROTO_IP, IP_MULTICAST_LOOP, C_Self_Loop); Result.Target.Sin_Family := Constants.Af_Inet; if Port /= 0 then Result.Target.Sin_Port := Port_To_Network (unsigned_short (Port)); else Result.Target.Sin_Port := Port_To_Network (unsigned_short (Get_Sock_Port (Socket_FD (Result)))); end if; Result.Target.Sin_Addr := To_In_Addr (Address_Of (Group)); return Result; end Create_Multicast_Socket; ----------------------------- -- Create_Multicast_Socket -- ----------------------------- function Create_Multicast_Socket (Group : String; Port : Natural; TTL : Positive := 16; Self_Loop : Boolean := True; Local_If : String := "0.0.0.0") return Multicast_Socket_FD is begin return Create_Multicast_Socket (Group => Group, Port => Port, Local_Port => Port, TTL => TTL, Self_Loop => Self_Loop, Local_If => Local_If); end Create_Multicast_Socket; ----------------------------- -- Create_Multicast_Socket -- ----------------------------- function Create_Multicast_Socket (Group : String; Port : Positive; Local_Port : Natural; TTL : Positive := 16; Local_If : String := "0.0.0.0") return Multicast_Socket_FD is begin return Create_Multicast_Socket (Group => Group, Port => Port, Local_Port => Local_Port, TTL => TTL, Self_Loop => False, Local_If => Local_If); end Create_Multicast_Socket; ---------- -- Send -- ---------- procedure Send (Socket : Multicast_Socket_FD; Data : Stream_Element_Array) is Sin : aliased Sockaddr_In := Socket.Target; Index : Stream_Element_Offset := Data'First; Rest : Stream_Element_Count := Data'Length; Count : int; begin while Rest > 0 loop Count := C_Sendto (Socket.FD, Data (Index) 'Address, int (Rest), 0, Sin'Address, Sin'Size / 8); if Count < 0 then Raise_With_Message ("Send failed"); elsif Count = 0 then raise Connection_Closed; end if; Index := Index + Stream_Element_Count (Count); Rest := Rest - Stream_Element_Count (Count); end loop; end Send; ------------ -- Socket -- ------------ procedure Socket (Sock : out Multicast_Socket_FD; Domain : Socket_Domain := PF_INET; Typ : Socket_Type := SOCK_STREAM) is begin Raise_Exception (Program_Error'Identity, "Use Create_Multicast_Socket instead"); end Socket; end Sockets.Multicast; adasockets-1.10.1/src/sockets-multicast.ads000066400000000000000000000107411277046543400206700ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . M U L T I C A S T -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Sockets.Types; package Sockets.Multicast is pragma Elaborate_Body; -- This package aims at helping the creation of multicast sockets type Multicast_Socket_FD is new Socket_FD with private; Null_Multicast_Socket_FD : constant Multicast_Socket_FD; function Create_Multicast_Socket (Group : String; Port : Natural; TTL : Positive := 16; Self_Loop : Boolean := True; Local_If : String := "0.0.0.0") return Multicast_Socket_FD; -- Create a multicast socket. If Port is 0, this will be a local -- socket with a system-chosen port. function Create_Multicast_Socket (Group : String; Port : Positive; Local_Port : Natural; TTL : Positive := 16; Local_If : String := "0.0.0.0") return Multicast_Socket_FD; -- Create a multicast socket that can only send data and is bound -- to the local port Local_Port. Use 0 if you do not care about -- the local port. procedure Send (Socket : Multicast_Socket_FD; Data : Ada.Streams.Stream_Element_Array); -- Send data over a multicast socket private procedure Socket (Sock : out Multicast_Socket_FD; Domain : Socket_Domain := PF_INET; Typ : Socket_Type := SOCK_STREAM); pragma No_Return (Socket); -- Do not call this one, it will raise Program_Error type Multicast_Socket_FD is new Socket_FD with record Target : Sockets.Types.Sockaddr_In; end record; Null_Multicast_Socket_FD : constant Multicast_Socket_FD := (Sockets.Null_Socket_FD with Target => Sockets.Types.Null_Sockaddr_In); end Sockets.Multicast; adasockets-1.10.1/src/sockets-naming.adb000066400000000000000000000360721277046543400201200ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . N A M I N G -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Ada.Exceptions; with Ada.Unchecked_Conversion; with Ada.Unchecked_Deallocation; with Interfaces.C; use Interfaces.C; with Interfaces.C.Strings; use Interfaces.C.Strings; with Sockets.Constants; use Sockets.Constants; with Sockets.Thin; use Sockets.Thin; with Sockets.Types; use Sockets.Types; with Sockets.Utils; use Sockets.Utils; package body Sockets.Naming is function Is_IP_Address (Something : String) return Boolean renames Sockets.Utils.Is_IP_Address; Default_Buffer_Size : constant := 16384; procedure Free is new Ada.Unchecked_Deallocation (String, String_Access); procedure Free is new Ada.Unchecked_Deallocation (char_array, char_array_access); function Allocate (Size : Positive := Default_Buffer_Size) return char_array_access; -- Allocate a buffer function Parse_Entry (Host : Hostent) return Host_Entry; -- Parse an entry procedure Raise_Naming_Error (Errno : Integer; Message : String); -- Raise the exception Naming_Error with an appropriate error message protected Naming_Lock is entry Lock; procedure Unlock; private Locked : Boolean := False; end Naming_Lock; -- A locking object function Get_Peer (Socket : Socket_FD) return Sockaddr_In; function Get_Sock (Socket : Socket_FD) return Sockaddr_In; ---------------- -- Address_Of -- ---------------- function Address_Of (Something : String) return Address is begin if Is_IP_Address (Something) then return Value (Something); else return Info_Of (Something) .Addresses (1); end if; end Address_Of; ------------ -- Adjust -- ------------ procedure Adjust (Object : in out Host_Entry) is Aliases : String_Array renames Object.Aliases; begin Object.Name := new String'(Object.Name.all); for I in Aliases'Range loop Aliases (I) := new String'(Aliases (I) .all); end loop; end Adjust; -------------- -- Allocate -- -------------- function Allocate (Size : Positive := Default_Buffer_Size) return char_array_access is begin return new char_array (1 .. size_t (Size)); end Allocate; ----------------- -- Any_Address -- ----------------- function Any_Address return Address is begin return To_Address (Inaddr_Any); end Any_Address; -------------- -- Finalize -- -------------- procedure Finalize (Object : in out Host_Entry) is Aliases : String_Array renames Object.Aliases; begin Free (Object.Name); for I in Aliases'Range loop Free (Aliases (I)); end loop; end Finalize; -------------- -- Get_Peer -- -------------- function Get_Peer (Socket : Socket_FD) return Sockaddr_In is Name : aliased Sockaddr_In; Len : aliased int := Name'Size / 8; begin if C_Getpeername (Socket.FD, Name'Address, Len'Access) = Failure then Raise_Naming_Error (Errno, ""); end if; return Name; end Get_Peer; ------------------- -- Get_Peer_Addr -- ------------------- function Get_Peer_Addr (Socket : Socket_FD) return Types.In_Addr is begin return Get_Peer (Socket) .Sin_Addr; end Get_Peer_Addr; ------------------- -- Get_Peer_Addr -- ------------------- function Get_Peer_Addr (Socket : Socket_FD) return Address is begin return To_Address (Get_Peer_Addr (Socket)); end Get_Peer_Addr; ------------------- -- Get_Peer_Port -- ------------------- function Get_Peer_Port (Socket : Socket_FD) return Positive is begin return Positive (Network_To_Port (Get_Peer (Socket) .Sin_Port)); end Get_Peer_Port; -------------- -- Get_Sock -- -------------- function Get_Sock (Socket : Socket_FD) return Sockaddr_In is Name : aliased Sockaddr_In; Len : aliased int := Name'Size / 8; begin if C_Getsockname (Socket.FD, Name'Address, Len'Access) = Failure then Raise_Naming_Error (Errno, ""); end if; return Name; end Get_Sock; ------------------- -- Get_Sock_Addr -- ------------------- function Get_Sock_Addr (Socket : Socket_FD) return In_Addr is begin return Get_Sock (Socket) .Sin_Addr; end Get_Sock_Addr; ------------------- -- Get_Sock_Addr -- ------------------- function Get_Sock_Addr (Socket : Socket_FD) return Address is begin return To_Address (Get_Sock_Addr (Socket)); end Get_Sock_Addr; ------------------- -- Get_Sock_Port -- ------------------- function Get_Sock_Port (Socket : Socket_FD) return Positive is begin return Positive (Network_To_Port (Get_Sock (Socket) .Sin_Port)); end Get_Sock_Port; --------------- -- Host_Name -- --------------- function Host_Name return String is Buff : char_array_access := Allocate; Buffer : constant chars_ptr := To_Chars_Ptr (Buff); Res : constant int := C_Gethostname (Buffer, Buff'Length); begin if Res = Failure then Free (Buff); Raise_Naming_Error (Errno, ""); end if; declare Result : constant String := Value (Buffer); begin Free (Buff); return Result; end; end Host_Name; ----------- -- Image -- ----------- function Image (Add : Address) return String is function Image (A : Address_Component) return String; -- Return the string corresponding to its argument without -- the leading space. ----------- -- Image -- ----------- function Image (A : Address_Component) return String is Im : constant String := Address_Component'Image (A); begin return Im (Im'First + 1 .. Im'Last); end Image; begin return Image (Add.H1) & "." & Image (Add.H2) & "." & Image (Add.H3) & "." & Image (Add.H4); end Image; ----------- -- Image -- ----------- function Image (Add : Types.In_Addr) return String is begin return Image (To_Address (Add)); end Image; ------------- -- Info_Of -- ------------- function Info_Of (Name : String) return Host_Entry is Res : Hostent_Access; C_Name : chars_ptr := New_String (Name); begin Naming_Lock.Lock; Res := C_Gethostbyname (C_Name); Free (C_Name); if Res = null then Naming_Lock.Unlock; Raise_Naming_Error (Errno, Name); end if; declare Result : constant Host_Entry := Parse_Entry (Res.all); begin Naming_Lock.Unlock; return Result; end; end Info_Of; ------------- -- Info_Of -- ------------- function Info_Of (Addr : Address) return Host_Entry is function Convert is new Ada.Unchecked_Conversion (Source => In_Addr_Access, Target => chars_ptr); Temp : aliased In_Addr := To_In_Addr (Addr); C_Addr : constant chars_ptr := Convert (Temp'Unchecked_Access); Res : Hostent_Access; begin Naming_Lock.Lock; Res := C_Gethostbyaddr (C_Addr, int (Temp'Size / CHAR_BIT), Constants.Af_Inet); if Res = null then Naming_Lock.Unlock; Raise_Naming_Error (Errno, Image (Addr)); end if; declare Result : constant Host_Entry := Parse_Entry (Res.all); begin Naming_Lock.Unlock; return Result; end; end Info_Of; ------------------------ -- Info_Of_Name_Or_IP -- ------------------------ function Info_Of_Name_Or_IP (Something : String) return Host_Entry is begin if Is_IP_Address (Something) then return Info_Of (Value (Something)); else return Info_Of (Something); end if; end Info_Of_Name_Or_IP; ------------- -- Name_Of -- ------------- function Name_Of (Something : String) return String is Hostent : constant Host_Entry := Info_Of_Name_Or_IP (Something); begin if Hostent.Name = null then Ada.Exceptions.Raise_Exception (Naming_Error'Identity, "No name for " & Something); end if; return Hostent.Name.all; end Name_Of; ----------------- -- Naming_Lock -- ----------------- protected body Naming_Lock is ---------- -- Lock -- ---------- entry Lock when not Locked is begin Locked := True; end Lock; ------------ -- Unlock -- ------------ procedure Unlock is begin Locked := False; end Unlock; end Naming_Lock; ----------------- -- Parse_Entry -- ----------------- function Parse_Entry (Host : Hostent) return Host_Entry is C_Aliases : constant Thin.Chars_Ptr_Array := Chars_Ptr_Pointers.Value (Host.H_Aliases); C_Addr : constant In_Addr_Access_Array := In_Addr_Access_Pointers.Value (Host.H_Addr_List); Result : Host_Entry (N_Aliases => C_Aliases'Length - 1, N_Addresses => C_Addr'Length - 1); begin Result.Name := new String'(Value (Host.H_Name)); for I in 1 .. Result.Aliases'Last loop declare Index : constant Natural := I - 1 + Natural (C_Aliases'First); Current : chars_ptr renames C_Aliases (size_t (Index)); begin Result.Aliases (I) := new String'(Value (Current)); end; end loop; for I in Result.Addresses'Range loop declare Index : constant Natural := I - 1 + Natural (C_Addr'First); Current : In_Addr_Access renames C_Addr (Index); begin Result.Addresses (I) := To_Address (Current.all); end; end loop; return Result; end Parse_Entry; ------------------------ -- Raise_Naming_Error -- ------------------------ procedure Raise_Naming_Error (Errno : Integer; Message : String) is function Error_Message return String; -- Return the message according to Errno. ------------------- -- Error_Message -- ------------------- function Error_Message return String is begin case Errno is when Host_Not_Found => return "Host not found"; when Try_Again => return "Try again"; when No_Recovery => return "No recovery"; when No_Address => return "No address"; when others => return "Unknown error" & Integer'Image (Errno); end case; end Error_Message; begin Ada.Exceptions.Raise_Exception (Naming_Error'Identity, Error_Message & ": " & Message); end Raise_Naming_Error; ---------------- -- To_Address -- ---------------- function To_Address (Addr : In_Addr) return Address is begin return (H1 => Address_Component (Addr.S_B1), H2 => Address_Component (Addr.S_B2), H3 => Address_Component (Addr.S_B3), H4 => Address_Component (Addr.S_B4)); end To_Address; ---------------- -- To_In_Addr -- ---------------- function To_In_Addr (Addr : Address) return In_Addr is begin return (S_B1 => unsigned_char (Addr.H1), S_B2 => unsigned_char (Addr.H2), S_B3 => unsigned_char (Addr.H3), S_B4 => unsigned_char (Addr.H4)); end To_In_Addr; ----------- -- Value -- ----------- function Value (Add : String) return Address is C_Add : chars_ptr := New_String (Add); Converted : aliased In_Addr; begin if C_Inet_Aton (C_Add, Converted'Unchecked_Access) = 0 then Ada.Exceptions.Raise_Exception (Naming_Error'Identity, Add & " is not an IP address"); end if; Free (C_Add); return (H1 => Address_Component (Converted.S_B1), H2 => Address_Component (Converted.S_B2), H3 => Address_Component (Converted.S_B3), H4 => Address_Component (Converted.S_B4)); end Value; end Sockets.Naming; adasockets-1.10.1/src/sockets-naming.ads000066400000000000000000000134541277046543400201400ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . N A M I N G -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Ada.Finalization; with Sockets.Types; package Sockets.Naming is type String_Access is access String; type String_Array is array (Positive range <>) of String_Access; subtype Address_Component is Natural range 0 .. 255; type Address is record H1, H2, H3, H4 : Address_Component; end record; -- An IPv4 address such as 137.194.160.12 type Address_Array is array (Positive range <>) of Address; type Host_Entry (N_Aliases, N_Addresses : Natural) is new Ada.Finalization.Controlled with record Name : String_Access; Aliases : String_Array (1 .. N_Aliases); Addresses : Address_Array (1 .. N_Addresses); end record; -- A complete host structure. A host may have several IP addresses as -- well as several aliases. procedure Adjust (Object : in out Host_Entry); procedure Finalize (Object : in out Host_Entry); Naming_Error : exception; -- This exception is raised when a name cannot be resolved function Image (Add : Address) return String; -- The dotted form corresponding to an IP address function Image (Add : Types.In_Addr) return String; -- The dotted form corresponding to the packed form of an IP address function Value (Add : String) return Address; -- The IP address corresponding to a dotted form function Info_Of (Name : String) return Host_Entry; -- Host entry of an IP name function Info_Of (Addr : Address) return Host_Entry; -- Host entry of an IP address function Is_IP_Address (Something : String) return Boolean; -- Return True if the name looks like an IP address, False otherwise function Info_Of_Name_Or_IP (Something : String) return Host_Entry; -- Host entry of an IP name or a dotted form function Address_Of (Something : String) return Address; -- Address of an IP name or a dotted form function Host_Name return String; -- Return the name of the current host function Name_Of (Something : String) return String; -- Return the official name of an IP name or a dotted form function To_In_Addr (Addr : Address) return Types.In_Addr; -- Convert an IP address to a In_Addr structure function To_Address (Addr : Types.In_Addr) return Address; -- Convert a In_Addr structure to an IP address function Any_Address return Address; -- Return the value of inaddr_any function Get_Peer_Addr (Socket : Socket_FD) return Types.In_Addr; -- Return the address of the peer in a dotted form function Get_Peer_Addr (Socket : Socket_FD) return Address; -- Ditto function Get_Peer_Port (Socket : Socket_FD) return Positive; -- Return the port of the peer function Get_Sock_Addr (Socket : Socket_FD) return Types.In_Addr; -- Return the local address of a bound socket function Get_Sock_Addr (Socket : Socket_FD) return Address; -- Ditto function Get_Sock_Port (Socket : Socket_FD) return Positive; -- Return the local port of a bound socket end Sockets.Naming; adasockets-1.10.1/src/sockets-stream_io.adb000066400000000000000000000071271277046543400206300ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . S T R E A M _ I O -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- package body Sockets.Stream_IO is ---------------- -- Initialize -- ---------------- procedure Initialize (Stream : in out Socket_Stream_Type; FD : Socket_FD) is begin Stream.FD := FD; end Initialize; ---------- -- Read -- ---------- procedure Read (Stream : in out Socket_Stream_Type; Item : out Ada.Streams.Stream_Element_Array; Last : out Ada.Streams.Stream_Element_Offset) is begin Receive (Stream.FD, Item); Last := Item'Last; end Read; ----------- -- Write -- ----------- procedure Write (Stream : in out Socket_Stream_Type; Item : Ada.Streams.Stream_Element_Array) is begin Send (Stream.FD, Item); end Write; end Sockets.Stream_IO; adasockets-1.10.1/src/sockets-stream_io.ads000066400000000000000000000070721277046543400206500ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . S T R E A M _ I O -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Ada.Streams; package Sockets.Stream_IO is type Socket_Stream_Type is new Ada.Streams.Root_Stream_Type with private; procedure Initialize (Stream : in out Socket_Stream_Type; FD : Socket_FD); -- Initialize must be called with an opened socket as parameter before -- being used as a stream. procedure Read (Stream : in out Socket_Stream_Type; Item : out Ada.Streams.Stream_Element_Array; Last : out Ada.Streams.Stream_Element_Offset); procedure Write (Stream : in out Socket_Stream_Type; Item : Ada.Streams.Stream_Element_Array); private type Socket_Stream_Type is new Ada.Streams.Root_Stream_Type with record FD : Socket_FD; end record; end Sockets.Stream_IO; adasockets-1.10.1/src/sockets-thin.adb.vms000066400000000000000000000134561277046543400204160ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . T H I N -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- -- Platform specific file for OpenVMS -- -- -- -- Based on Windows specific file written -- -- by Maxim Reznik -- ----------------------------------------------------------------------------- with Sockets.Constants; with System.Address_To_Access_Conversions; package body Sockets.Thin is use type System.Address; package Int_Conversion is new System.Address_To_Access_Conversions (C.int); ------------------ -- C_Socketpair -- ------------------ function C_Socketpair (Domain : C.int; Typ : C.int; Protocol : C.int; Filedes : System.Address) return C.int is use System.Storage_Elements; use type C.char_array; INVALID_SOCKET : constant := Failure; Listen_Socket : C.int; Sin : aliased Sockaddr_In; Sin_Len : aliased C.int := Sin'Size / 8; fd : Two_Int; fd_ptr : Int_Conversion.Object_Pointer; Result : C.int; begin if Domain /= Constants.Af_Inet or Typ /= Constants.Sock_Stream or Filedes = System.Null_Address then return Failure; end if; Listen_Socket := C_Socket (Domain, Typ, Protocol); if Listen_Socket = INVALID_SOCKET then return Failure; end if; Sin.Sin_Family := Constants.Af_Inet; Sin.Sin_Addr := Inaddr_Any; Sin.Sin_Port := 0; if C_Bind (Listen_Socket, Sin'Address, Sin'Size / 8) = Failure then Result := C_Close (Listen_Socket); return Failure; end if; if C_Listen (Listen_Socket, 1) = Failure then Result := C_Close (Listen_Socket); return Failure; end if; if C_Getsockname (Listen_Socket, Sin'Address, Sin_Len'Access) = Failure then Result := C_Close (Listen_Socket); return Failure; end if; Sin.Sin_Addr := (127, 0, 0, 1); fd (1) := C_Socket (Domain, Typ, Protocol); if fd (1) = INVALID_SOCKET then Result := C_Close (Listen_Socket); return Failure; end if; if C_Connect (fd (1), Sin'Address, Sin'Size / 8) = Failure then Result := C_Close (fd (1)); Result := C_Close (Listen_Socket); return Failure; end if; fd (0) := C_Accept (Listen_Socket, Sin'Address, Sin_Len'Access); if fd (0) = INVALID_SOCKET then Result := C_Close (fd (1)); Result := C_Close (Listen_Socket); return Failure; end if; fd_ptr := Int_Conversion.To_Pointer (Filedes); fd_ptr.all := fd (0); fd_ptr := Int_Conversion.To_Pointer (Filedes + (C.int'Size / 8)); fd_ptr.all := fd (1); return Success; end C_Socketpair; end Sockets.Thin; adasockets-1.10.1/src/sockets-thin.adb.win32000066400000000000000000000330041277046543400205420ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . T H I N -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- -- Platform specific file for MS Windows -- -- Unix Net/IO functions absent in Win32 platform -- -- -- -- Written by Maxim Reznik -- ----------------------------------------------------------------------------- with Sockets.Constants; with System.Address_To_Access_Conversions; package body Sockets.Thin is use type System.Address; package Int_Conversion is new System.Address_To_Access_Conversions (C.int); package Conversion is new System.Address_To_Access_Conversions (Iovec); FD_SETSIZE : constant := 64; type fds is array (C.int range 1 .. FD_SETSIZE) of C.int; pragma Convention (C, fds); type fd_set_type is record fd_count : C.int; fd_array : fds; end record; pragma Convention (C, fd_set_type); type Timeval is record tv_sec : C.long; -- Seconds tv_usec : C.long; -- Microseconds end record; pragma Convention (C, Timeval); procedure FD_ZERO (set : in out fd_set_type); procedure FD_SET (fd : C.int; set : in out fd_set_type); function FD_ISSET (fd : C.int; set : System.Address) return C.int; pragma Import (Stdcall, FD_ISSET, "__WSAFDIsSet"); function C_Select (Nfds : C.int; readfds : System.Address; writefds : System.Address; exceptfds : System.Address; timeout : System.Address) return C.int; pragma Import (Stdcall, C_Select, "select"); function C_WSAGetLastError return C.int; pragma Import (Stdcall, C_WSAGetLastError, "WSAGetLastError"); ------------ -- C_Poll -- ------------ function C_Poll (Fds : System.Address; Nfds : C.unsigned_long; Timeout : C.int) return C.int is use System.Storage_Elements; use type C.short; use type C.long; package Conversion is new System.Address_To_Access_Conversions (Pollfd); type Poll_Event is mod 2**16; for Poll_Event'Size use 16; fd_addr : System.Address := Fds; fd_ptr : Conversion.Object_Pointer; fd_events : Poll_Event; timeout_v : aliased Timeval; rfds : aliased fd_set_type; wfds : aliased fd_set_type; efds : aliased fd_set_type; rs : C.int; Good : Boolean; begin if Fds = System.Null_Address then return Failure; end if; timeout_v.tv_sec := C.long (Timeout) / 1000; timeout_v.tv_usec := C.long (Timeout) mod 1000; FD_ZERO (rfds); FD_ZERO (wfds); FD_ZERO (efds); for i in 1 .. Nfds loop fd_ptr := Conversion.To_Pointer (fd_addr); fd_events := Poll_Event (fd_ptr.Events); if (fd_events and Constants.Pollin) /= 0 then FD_SET (fd_ptr.Fd, rfds); elsif (fd_events and Constants.Pollout) /= 0 then FD_SET (fd_ptr.Fd, wfds); elsif (fd_events and Constants.Pollpri) /= 0 then FD_SET (fd_ptr.Fd, efds); end if; fd_addr := fd_addr + Pollfd'Size / 8; end loop; if Timeout < 0 then rs := C_Select (0, rfds'Address, wfds'Address, efds'Address, System.Null_Address); else rs := C_Select (0, rfds'Address, wfds'Address, efds'Address, timeout_v'Address); end if; if rs > 0 then rs := 0; fd_addr := Fds; for i in 1 .. Nfds loop fd_ptr := Conversion.To_Pointer (fd_addr); Good := False; fd_ptr.Revents := 0; if FD_ISSET (fd_ptr.Fd, rfds'Address) /= 0 then Good := True; fd_ptr.Revents := fd_ptr.Revents + Constants.Pollin; end if; if FD_ISSET (fd_ptr.Fd, wfds'Address) /= 0 then Good := True; fd_ptr.Revents := fd_ptr.Revents + Constants.Pollout; end if; if FD_ISSET (fd_ptr.Fd, efds'Address) /= 0 then Good := True; fd_ptr.Revents := fd_ptr.Revents + Constants.Pollpri; end if; if Good then rs := rs + 1; end if; fd_addr := fd_addr + Pollfd'Size / 8; end loop; end if; return rs; end C_Poll; ------------ -- C_Read -- ------------ function C_Read (Fildes : C.int; Buf : System.Address; Nbyte : C.int) return C.int is begin return C_Recv (Fildes, Buf, Nbyte, 0); end C_Read; ------------- -- C_Readv -- ------------- function C_Readv (Fildes : C.int; Iov : System.Address; Iovcnt : C.int) return C.int is use System.Storage_Elements; Total : C.int := 0; Processed : Storage_Offset; Result : C.int; Ptr : System.Address := Iov; Iovec_Ptr : Conversion.Object_Pointer; begin if Iov = System.Null_Address then return Failure; end if; for i in 1 .. Iovcnt loop Iovec_Ptr := Conversion.To_Pointer (Ptr); Processed := 0; while Processed < Iovec_Ptr.Iov_Len loop Result := C_Recv (Fildes, Buf => Iovec_Ptr.Iov_Base + Processed, Len => C.int (Iovec_Ptr.Iov_Len - Processed), Flags => 0); if Result < 0 then if Total = 0 then return -1; -- Return error code else return Total; -- Return total bytes processed end if; end if; Processed := Processed + Storage_Offset (Result); Total := Total + Result; end loop; Ptr := Ptr + Iovec'Size / 8; end loop; return Total; end C_Readv; ------------------ -- C_Socketpair -- ------------------ function C_Socketpair (Domain : C.int; Typ : C.int; Protocol : C.int; Filedes : System.Address) return C.int is use System.Storage_Elements; use type C.char_array; INVALID_SOCKET : constant := Failure; Listen_Socket : C.int; Sin : aliased Sockaddr_In; Sin_Len : aliased C.int := Sin'Size / 8; fd : Two_Int; fd_ptr : Int_Conversion.Object_Pointer; Result : C.int; begin if Domain /= Constants.Af_Inet or Typ /= Constants.Sock_Stream or Filedes = System.Null_Address then return Failure; end if; Listen_Socket := C_Socket (Domain, Typ, Protocol); if Listen_Socket = INVALID_SOCKET then return Failure; end if; Sin.Sin_Family := Constants.Af_Inet; Sin.Sin_Addr := Inaddr_Any; Sin.Sin_Port := 0; if C_Bind (Listen_Socket, Sin'Address, Sin'Size / 8) = Failure then Result := C_Close (Listen_Socket); return Failure; end if; if C_Listen (Listen_Socket, 1) = Failure then Result := C_Close (Listen_Socket); return Failure; end if; if C_Getsockname (Listen_Socket, Sin'Address, Sin_Len'Access) = Failure then Result := C_Close (Listen_Socket); return Failure; end if; Sin.Sin_Addr := (127, 0, 0, 1); fd (1) := C_Socket (Domain, Typ, Protocol); if fd (1) = INVALID_SOCKET then Result := C_Close (Listen_Socket); return Failure; end if; if C_Connect (fd (1), Sin'Address, Sin'Size / 8) = Failure then Result := C_Close (fd (1)); Result := C_Close (Listen_Socket); return Failure; end if; fd (0) := C_Accept (Listen_Socket, Sin'Address, Sin_Len'Access); if fd (0) = INVALID_SOCKET then Result := C_Close (fd (1)); Result := C_Close (Listen_Socket); return Failure; end if; fd_ptr := Int_Conversion.To_Pointer (Filedes); fd_ptr.all := fd (0); fd_ptr := Int_Conversion.To_Pointer (Filedes + (C.int'Size / 8)); fd_ptr.all := fd (1); return Success; end C_Socketpair; ------------- -- C_Write -- ------------- function C_Write (Fildes : C.int; Buf : System.Address; Nbyte : C.int) return C.int is begin return C_Send (Fildes, Buf, Nbyte, 0); end C_Write; -------------- -- C_Writev -- -------------- function C_Writev (Fildes : C.int; Iov : System.Address; Iovcnt : C.int) return C.int is use System.Storage_Elements; Total : C.int := 0; Processed : Storage_Offset; Result : C.int; Ptr : System.Address := Iov; Iovec_Ptr : Conversion.Object_Pointer; begin if Iov = System.Null_Address then return Failure; end if; for i in 1 .. Iovcnt loop Iovec_Ptr := Conversion.To_Pointer (Ptr); Processed := 0; while Processed < Iovec_Ptr.Iov_Len loop Result := C_Send (Fildes, Msg => Iovec_Ptr.Iov_Base + Processed, Len => C.int (Iovec_Ptr.Iov_Len - Processed), Flags => 0); if Result < 0 then if Total = 0 then return -1; -- Return error code else return Total; -- Return total bytes processed end if; end if; Processed := Processed + Storage_Offset (Result); Total := Total + Result; end loop; Ptr := Ptr + Iovec'Size / 8; end loop; return Total; end C_Writev; ----------- -- Errno -- ----------- function Errno return Integer is begin return Integer (C_WSAGetLastError); end Errno; ------------ -- FD_SET -- ------------ procedure FD_SET (fd : C.int; set : in out fd_set_type) is begin if set.fd_count < FD_SETSIZE then set.fd_count := set.fd_count + 1; set.fd_array (set.fd_count) := fd; end if; end FD_SET; ------------- -- FD_ZERO -- ------------- procedure FD_ZERO (set : in out fd_set_type) is begin set.fd_count := 0; end FD_ZERO; end Sockets.Thin; adasockets-1.10.1/src/sockets-thin.ads.unix000066400000000000000000000321401277046543400206040ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . T H I N -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with GNAT.OS_Lib; with Interfaces.C.Pointers; with Interfaces.C.Strings; with Sockets.Types; use Sockets.Types; with System.Storage_Elements; package Sockets.Thin is package C renames Interfaces.C; package Strings renames C.Strings; generic package Pointers renames C.Pointers; use type C.int; -- This is an ugly hack to be able to declare the Failure constant -- below. Success : constant C.int := 0; Failure : constant C.int := -1; type Int_Access is access all C.int; pragma Convention (C, Int_Access); -- Access to C integers type pid_t is new C.int; pragma Convention (C, pid_t); type mode_t is new C.int; pragma Convention (C, mode_t); type key_t is new C.int; pragma Convention (C, key_t); type Chars_Ptr_Array is array (C.size_t range <>) of aliased Strings.chars_ptr; package Chars_Ptr_Pointers is new Pointers (C.size_t, Strings.chars_ptr, Chars_Ptr_Array, Strings.Null_Ptr); -- Arrays of C (char *) type In_Addr_Access_Array is array (Positive range <>) of aliased In_Addr_Access; pragma Convention (C, In_Addr_Access_Array); package In_Addr_Access_Pointers is new Pointers (Positive, In_Addr_Access, In_Addr_Access_Array, null); -- Array of internet addresses type Sockaddr_Access is access all Sockaddr; pragma Convention (C, Sockaddr_Access); -- Access to socket address type Sockaddr_In_Access is access all Sockaddr_In; pragma Convention (C, Sockaddr_In_Access); -- Access to internet socket address type Ip_Mreq is record Imr_Multiaddr : In_Addr; Imr_Interface : In_Addr := Inaddr_Any; end record; pragma Convention (C, Ip_Mreq); -- Multicast structure type Hostent is record H_Name : Strings.chars_ptr; H_Aliases : Chars_Ptr_Pointers.Pointer; H_Addrtype : C.int; H_Length : C.int; H_Addr_List : In_Addr_Access_Pointers.Pointer; end record; pragma Convention (C, Hostent); -- Host entry type Hostent_Access is access all Hostent; pragma Convention (C, Hostent_Access); -- Access to host entry type Iovec is record Iov_Base : System.Address; Iov_Len : System.Storage_Elements.Storage_Offset; end record; pragma Convention (C, Iovec); -- Iovec C type type Msghdr is record Msg_Name : System.Address; Msg_Namelen : C.int; Msg_Iov : System.Address; Msg_Iovlen : C.int; Msg_Accrights : System.Address; Msg_Accrightslen : C.int; end record; pragma Convention (C, Msghdr); -- Message header type Msghdr_Access is access all Msghdr; pragma Convention (C, Msghdr_Access); -- Access to message header. type Two_Int is array (0 .. 1) of C.int; pragma Convention (C, Two_Int); -- Used with socketpair() type Pollfd is record Fd : C.int; Events : C.short; Revents : C.short; end record; pragma Convention (C, Pollfd); type Pollfd_Array is array (Positive range <>) of Pollfd; pragma Convention (C, Pollfd_Array); function C_Accept (S : C.int; Addr : System.Address; Addrlen : access C.int) return C.int; function C_Bind (S : C.int; Name : System.Address; Namelen : C.int) return C.int; function C_Close (Fildes : C.int) return C.int; function C_Connect (S : C.int; Name : System.Address; Namelen : C.int) return C.int; function C_Dup2 (Fildes, Fildes2 : C.int) return C.int; function C_Fcntl (Fildes : C.int; Cmd : C.int; Arg : C.int := 0) return C.int; function C_Getenv (Name : Strings.chars_ptr) return Strings.chars_ptr; function C_Gethostbyaddr (Addr : Strings.chars_ptr; Length : C.int; Typ : C.int) return Hostent_Access; function C_Gethostbyname (Name : Strings.chars_ptr) return Hostent_Access; function C_Gethostname (Name : Strings.chars_ptr; Namelen : C.int) return C.int; function C_Gethostname (Name : System.Address; Namelen : C.int) return C.int; function C_Getpeername (S : C.int; Name : System.Address; Namelen : access C.int) return C.int; function C_Getpid return pid_t; function C_Getsockname (S : C.int; Name : Sockaddr_Access; Namelen : access C.int) return C.int; function C_Getsockname (S : C.int; Name : System.Address; Namelen : access C.int) return C.int; function C_Getsockopt (S : C.int; Level : C.int; Optname : C.int; Optval : Strings.chars_ptr; Optlen : access C.int) return C.int; function C_Getsockopt (S : C.int; Level : C.int; Optname : C.int; Optval : System.Address; Optlen : access C.int) return C.int; function C_Inet_Addr (Cp : Strings.chars_ptr) return Types.In_Addr; function C_Inet_Network (Cp : Strings.chars_ptr) return Interfaces.Unsigned_32; function C_Inet_Makeaddr (Net : C.int; Lna : C.int) return In_Addr; function C_Inet_Lnaof (I : In_Addr) return C.int; function C_Inet_Netof (I : In_Addr) return C.int; function C_Inet_Ntoa (I : In_Addr) return Strings.chars_ptr; function C_Inet_Aton (Cp : Strings.chars_ptr; I : In_Addr_Access) return C.int; function C_Kill (Pid : pid_t; Sig : C.int) return C.int; function C_Listen (S, Backlog : C.int) return C.int; function C_Msgget (Key : key_t; Msgflg : C.int) return C.int; function C_Msgrcv (Msqid : C.int; Msgp : Strings.chars_ptr; Msgsz : C.int; Msgtyp : C.long; Msgflg : C.int) return C.int; function C_Msgsnd (Msqid : C.int; Msgp : Strings.chars_ptr; Msgsz : C.int; Msgflg : C.int) return C.int; function C_Open (Path : Strings.chars_ptr; Oflag : C.int; Mode : mode_t := 0) return C.int; function C_Socketpair (Domain : C.int; Typ : C.int; Protocol : C.int; Filedes : System.Address) return C.int; function C_Poll (Fds : System.Address; Nfds : C.unsigned_long; Timeout : C.int) return C.int; function C_Read (Fildes : C.int; Buf : System.Address; Nbyte : C.int) return C.int; function C_Readv (Fildes : C.int; Iov : System.Address; Iovcnt : C.int) return C.int; function C_Recv (S : C.int; Buf : System.Address; Len, Flags : C.int) return C.int; function C_Recvfrom (S : C.int; Buf : System.Address; Len : C.int; Flags : C.int; From : System.Address; Fromlen : access C.int) return C.int; function C_Recvmsg (S : C.int; Msg : Msghdr_Access; Flags : C.int) return C.int; function C_Send (S : C.int; Msg : System.Address; Len : C.int; Flags : C.int) return C.int; function C_Sendmsg (S : C.int; Msg : Msghdr_Access; Flags : C.int) return C.int; function C_Sendto (S : C.int; Msg : System.Address; Len : C.int; Flags : C.int; To : System.Address; Tolen : C.int) return C.int; function C_Setsid return pid_t; function C_Setsockopt (S : C.int; Level : C.int; Optname : C.int; Optval : System.Address; Optlen : C.int) return C.int; procedure C_Shutdown (S : C.int; How : C.int); function C_Socket (Domain, Typ, Protocol : C.int) return C.int; function C_Strerror (Errnum : C.int) return Strings.chars_ptr; function C_Write (Fildes : C.int; Buf : System.Address; Nbyte : C.int) return C.int; function C_Writev (Fildes : C.int; Iov : System.Address; Iovcnt : C.int) return C.int; function C_Ioctl (S : C.int; Req : C.int; Arg : access C.int) return C.int; function Errno return Integer; private pragma Import (C, C_Accept, "accept"); pragma Import (C, C_Bind, "bind"); pragma Import (C, C_Close, "close"); pragma Import (C, C_Connect, "connect"); pragma Import (C, C_Dup2, "dup2"); pragma Import (C, C_Fcntl, "fcntl"); pragma Import (C, C_Getenv, "getenv"); pragma Import (C, C_Gethostbyaddr, "gethostbyaddr"); pragma Import (C, C_Gethostbyname, "gethostbyname"); pragma Import (C, C_Gethostname, "gethostname"); pragma Import (C, C_Getpeername, "getpeername"); pragma Import (C, C_Getpid, "getpid"); pragma Import (C, C_Getsockname, "getsockname"); pragma Import (C, C_Getsockopt, "getsockopt"); pragma Import (C, C_Inet_Addr, "inet_addr"); pragma Import (C, C_Inet_Network, "inet_network"); pragma Import (C, C_Inet_Makeaddr, "inet_makeaddr"); pragma Import (C, C_Inet_Lnaof, "inet_lnaof"); pragma Import (C, C_Inet_Netof, "inet_netof"); pragma Import (C, C_Inet_Ntoa, "inet_ntoa"); pragma Import (C, C_Inet_Aton, "inet_aton"); pragma Import (C, C_Kill, "kill"); pragma Import (C, C_Listen, "listen"); pragma Import (C, C_Msgget, "msgget"); pragma Import (C, C_Msgrcv, "msgrcv"); pragma Import (C, C_Msgsnd, "msgsnd"); pragma Import (C, C_Open, "open"); pragma Import (C, C_Socketpair, "socketpair"); pragma Import (C, C_Poll, "poll"); pragma Import (C, C_Read, "read"); pragma Import (C, C_Readv, "readv"); pragma Import (C, C_Recv, "recv"); pragma Import (C, C_Recvfrom, "recvfrom"); pragma Import (C, C_Recvmsg, "recvmsg"); pragma Import (C, C_Send, "send"); pragma Import (C, C_Sendmsg, "sendmsg"); pragma Import (C, C_Sendto, "sendto"); pragma Import (C, C_Setsid, "setsid"); pragma Import (C, C_Setsockopt, "setsockopt"); pragma Import (C, C_Shutdown, "shutdown"); pragma Import (C, C_Socket, "socket"); pragma Import (C, C_Strerror, "strerror"); pragma Import (C, C_Write, "write"); pragma Import (C, C_Writev, "writev"); pragma Import (C, C_Ioctl, "ioctl"); function Errno return Integer renames GNAT.OS_Lib.Errno; end Sockets.Thin; adasockets-1.10.1/src/sockets-thin.ads.vms000066400000000000000000000316261277046543400204360ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . T H I N -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with GNAT.OS_Lib; with Interfaces.C.Pointers; with Interfaces.C.Strings; with Sockets.Types; use Sockets.Types; with System.Storage_Elements; package Sockets.Thin is package C renames Interfaces.C; package Strings renames C.Strings; generic package Pointers renames C.Pointers; use type C.int; -- This is an ugly hack to be able to declare the Failure constant -- below. Success : constant C.int := 0; Failure : constant C.int := -1; type Int_Access is access all C.int; pragma Convention (C, Int_Access); -- Access to C integers type pid_t is new C.int; pragma Convention (C, pid_t); type mode_t is new C.int; pragma Convention (C, mode_t); type key_t is new C.int; pragma Convention (C, key_t); type Chars_Ptr_Array is array (C.size_t range <>) of aliased Strings.chars_ptr; package Chars_Ptr_Pointers is new Pointers (C.size_t, Strings.chars_ptr, Chars_Ptr_Array, Strings.Null_Ptr); -- Arrays of C (char *) type In_Addr_Access_Array is array (Positive range <>) of aliased In_Addr_Access; pragma Convention (C, In_Addr_Access_Array); package In_Addr_Access_Pointers is new Pointers (Positive, In_Addr_Access, In_Addr_Access_Array, null); -- Array of internet addresses type Sockaddr_Access is access all Sockaddr; pragma Convention (C, Sockaddr_Access); -- Access to socket address type Sockaddr_In_Access is access all Sockaddr_In; pragma Convention (C, Sockaddr_In_Access); -- Access to internet socket address type Ip_Mreq is record Imr_Multiaddr : In_Addr; Imr_Interface : In_Addr := Inaddr_Any; end record; pragma Convention (C, Ip_Mreq); -- Multicast structure type Hostent is record H_Name : Strings.chars_ptr; H_Aliases : Chars_Ptr_Pointers.Pointer; H_Addrtype : C.int; H_Length : C.int; H_Addr_List : In_Addr_Access_Pointers.Pointer; end record; pragma Convention (C, Hostent); -- Host entry type Hostent_Access is access all Hostent; pragma Convention (C, Hostent_Access); -- Access to host entry type Iovec is record Iov_Base : System.Address; Iov_Len : System.Storage_Elements.Storage_Offset; end record; pragma Convention (C, Iovec); -- Iovec C type type Msghdr is record Msg_Name : System.Address; Msg_Namelen : C.int; Msg_Iov : System.Address; Msg_Iovlen : C.int; Msg_Accrights : System.Address; Msg_Accrightslen : C.int; end record; pragma Convention (C, Msghdr); -- Message header type Msghdr_Access is access all Msghdr; pragma Convention (C, Msghdr_Access); -- Access to message header. type Two_Int is array (0 .. 1) of C.int; pragma Convention (C, Two_Int); -- Used with socketpair() type Pollfd is record Fd : C.int; Events : C.short; Revents : C.short; end record; pragma Convention (C, Pollfd); type Pollfd_Array is array (Positive range <>) of Pollfd; pragma Convention (C, Pollfd_Array); function C_Accept (S : C.int; Addr : System.Address; Addrlen : access C.int) return C.int; function C_Bind (S : C.int; Name : System.Address; Namelen : C.int) return C.int; function C_Close (Fildes : C.int) return C.int; function C_Connect (S : C.int; Name : System.Address; Namelen : C.int) return C.int; function C_Dup2 (Fildes, Fildes2 : C.int) return C.int; function C_Fcntl (Fildes : C.int; Cmd : C.int; Arg : C.int := 0) return C.int; function C_Getenv (Name : Strings.chars_ptr) return Strings.chars_ptr; function C_Gethostbyaddr (Addr : Strings.chars_ptr; Length : C.int; Typ : C.int) return Hostent_Access; function C_Gethostbyname (Name : Strings.chars_ptr) return Hostent_Access; function C_Gethostname (Name : Strings.chars_ptr; Namelen : C.int) return C.int; function C_Gethostname (Name : System.Address; Namelen : C.int) return C.int; function C_Getpeername (S : C.int; Name : System.Address; Namelen : access C.int) return C.int; function C_Getpid return pid_t; function C_Getsockname (S : C.int; Name : Sockaddr_Access; Namelen : access C.int) return C.int; function C_Getsockname (S : C.int; Name : System.Address; Namelen : access C.int) return C.int; function C_Getsockopt (S : C.int; Level : C.int; Optname : C.int; Optval : Strings.chars_ptr; Optlen : access C.int) return C.int; function C_Getsockopt (S : C.int; Level : C.int; Optname : C.int; Optval : System.Address; Optlen : access C.int) return C.int; function C_Inet_Addr (Cp : Strings.chars_ptr) return Types.In_Addr; function C_Inet_Network (Cp : Strings.chars_ptr) return Interfaces.Unsigned_32; function C_Inet_Makeaddr (Net : C.int; Lna : C.int) return In_Addr; function C_Inet_Lnaof (I : In_Addr) return C.int; function C_Inet_Netof (I : In_Addr) return C.int; function C_Inet_Ntoa (I : In_Addr) return Strings.chars_ptr; function C_Kill (Pid : pid_t; Sig : C.int) return C.int; function C_Listen (S, Backlog : C.int) return C.int; function C_Msgget (Key : key_t; Msgflg : C.int) return C.int; function C_Msgrcv (Msqid : C.int; Msgp : Strings.chars_ptr; Msgsz : C.int; Msgtyp : C.long; Msgflg : C.int) return C.int; function C_Msgsnd (Msqid : C.int; Msgp : Strings.chars_ptr; Msgsz : C.int; Msgflg : C.int) return C.int; function C_Open (Path : Strings.chars_ptr; Oflag : C.int; Mode : mode_t := 0) return C.int; function C_Socketpair (Domain : C.int; Typ : C.int; Protocol : C.int; Filedes : System.Address) return C.int; function C_Poll (Fds : System.Address; Nfds : C.unsigned_long; Timeout : C.int) return C.int; function C_Read (Fildes : C.int; Buf : System.Address; Nbyte : C.int) return C.int; function C_Readv (Fildes : C.int; Iov : System.Address; Iovcnt : C.int) return C.int; function C_Recv (S : C.int; Buf : System.Address; Len, Flags : C.int) return C.int; function C_Recvfrom (S : C.int; Buf : System.Address; Len : C.int; Flags : C.int; From : System.Address; Fromlen : access C.int) return C.int; function C_Recvmsg (S : C.int; Msg : Msghdr_Access; Flags : C.int) return C.int; function C_Send (S : C.int; Msg : System.Address; Len : C.int; Flags : C.int) return C.int; function C_Sendmsg (S : C.int; Msg : Msghdr_Access; Flags : C.int) return C.int; function C_Sendto (S : C.int; Msg : System.Address; Len : C.int; Flags : C.int; To : System.Address; Tolen : C.int) return C.int; function C_Setsid return pid_t; function C_Setsockopt (S : C.int; Level : C.int; Optname : C.int; Optval : System.Address; Optlen : C.int) return C.int; procedure C_Shutdown (S : C.int; How : C.int); function C_Socket (Domain, Typ, Protocol : C.int) return C.int; function C_Strerror (Errnum : C.int) return Strings.chars_ptr; function C_Write (Fildes : C.int; Buf : System.Address; Nbyte : C.int) return C.int; function C_Writev (Fildes : C.int; Iov : System.Address; Iovcnt : C.int) return C.int; function C_Ioctl (S : C.int; Req : C.int; Arg : access C.int) return C.int; function Errno return Integer; private pragma Import (C, C_Accept, "accept"); pragma Import (C, C_Bind, "bind"); pragma Import (C, C_Close, "close"); pragma Import (C, C_Connect, "connect"); pragma Import (C, C_Dup2, "dup2"); pragma Import (C, C_Fcntl, "fcntl"); pragma Import (C, C_Getenv, "getenv"); pragma Import (C, C_Gethostbyaddr, "gethostbyaddr"); pragma Import (C, C_Gethostbyname, "gethostbyname"); pragma Import (C, C_Gethostname, "gethostname"); pragma Import (C, C_Getpeername, "getpeername"); pragma Import (C, C_Getpid, "getpid"); pragma Import (C, C_Getsockname, "getsockname"); pragma Import (C, C_Getsockopt, "getsockopt"); pragma Import (C, C_Inet_Addr, "inet_addr"); pragma Import (C, C_Inet_Network, "inet_network"); pragma Import (C, C_Inet_Makeaddr, "inet_makeaddr"); pragma Import (C, C_Inet_Lnaof, "inet_lnaof"); pragma Import (C, C_Inet_Netof, "inet_netof"); pragma Import (C, C_Inet_Ntoa, "inet_ntoa"); pragma Import (C, C_Kill, "kill"); pragma Import (C, C_Listen, "listen"); pragma Import (C, C_Msgget, "msgget"); pragma Import (C, C_Msgrcv, "msgrcv"); pragma Import (C, C_Msgsnd, "msgsnd"); pragma Import (C, C_Open, "open"); pragma Import (C, C_Poll, "poll"); pragma Import (C, C_Read, "read"); pragma Import (C, C_Readv, "readv"); pragma Import (C, C_Recv, "recv"); pragma Import (C, C_Recvfrom, "recvfrom"); pragma Import (C, C_Recvmsg, "recvmsg"); pragma Import (C, C_Send, "send"); pragma Import (C, C_Sendmsg, "sendmsg"); pragma Import (C, C_Sendto, "sendto"); pragma Import (C, C_Setsid, "setsid"); pragma Import (C, C_Setsockopt, "setsockopt"); pragma Import (C, C_Shutdown, "shutdown"); pragma Import (C, C_Socket, "socket"); pragma Import (C, C_Strerror, "strerror"); pragma Import (C, C_Write, "write"); pragma Import (C, C_Writev, "writev"); pragma Import (C, C_Ioctl, "ioctl"); function Errno return Integer renames GNAT.OS_Lib.Errno; end Sockets.Thin; adasockets-1.10.1/src/sockets-thin.ads.win32000066400000000000000000000315651277046543400205750ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . T H I N -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Interfaces.C.Pointers; with Interfaces.C.Strings; with Sockets.Types; use Sockets.Types; with System.Storage_Elements; package Sockets.Thin is package C renames Interfaces.C; package Strings renames C.Strings; generic package Pointers renames C.Pointers; use type C.int; -- This is an ugly hack to be able to declare the Failure constant -- below. Success : constant C.int := 0; Failure : constant C.int := -1; type Int_Access is access all C.int; pragma Convention (C, Int_Access); -- Access to C integers type pid_t is new C.int; pragma Convention (C, pid_t); type mode_t is new C.int; pragma Convention (C, mode_t); type key_t is new C.int; pragma Convention (C, key_t); type Chars_Ptr_Array is array (C.size_t range <>) of aliased Strings.chars_ptr; package Chars_Ptr_Pointers is new Pointers (C.size_t, Strings.chars_ptr, Chars_Ptr_Array, Strings.Null_Ptr); -- Arrays of C (char *) type In_Addr_Access_Array is array (Positive range <>) of aliased In_Addr_Access; pragma Convention (C, In_Addr_Access_Array); package In_Addr_Access_Pointers is new Pointers (Positive, In_Addr_Access, In_Addr_Access_Array, null); -- Array of internet addresses type Sockaddr_Access is access all Sockaddr; pragma Convention (C, Sockaddr_Access); -- Access to socket address type Sockaddr_In_Access is access all Sockaddr_In; pragma Convention (C, Sockaddr_In_Access); -- Access to internet socket address type Ip_Mreq is record Imr_Multiaddr : In_Addr; Imr_Interface : In_Addr := Inaddr_Any; end record; pragma Convention (C, Ip_Mreq); -- Multicast structure type Hostent is record H_Name : Strings.chars_ptr; H_Aliases : Chars_Ptr_Pointers.Pointer; H_Addrtype : C.short; H_Length : C.short; H_Addr_List : In_Addr_Access_Pointers.Pointer; end record; pragma Convention (C, Hostent); -- Host entry type Hostent_Access is access all Hostent; pragma Convention (C, Hostent_Access); -- Access to host entry type Iovec is record Iov_Base : System.Address; Iov_Len : System.Storage_Elements.Storage_Offset; end record; pragma Convention (C, Iovec); -- Iovec C type type Msghdr is record Msg_Name : System.Address; Msg_Namelen : C.int; Msg_Iov : System.Address; Msg_Iovlen : C.int; Msg_Accrights : System.Address; Msg_Accrightslen : C.int; end record; pragma Convention (C, Msghdr); -- Message header type Msghdr_Access is access all Msghdr; pragma Convention (C, Msghdr_Access); -- Access to message header. type Two_Int is array (0 .. 1) of C.int; pragma Convention (C, Two_Int); -- Used with socketpair() type Pollfd is record Fd : C.int; Events : C.short; Revents : C.short; end record; pragma Convention (C, Pollfd); type Pollfd_Array is array (Positive range <>) of Pollfd; pragma Convention (C, Pollfd_Array); function C_Accept (S : C.int; Addr : System.Address; Addrlen : access C.int) return C.int; function C_Bind (S : C.int; Name : System.Address; Namelen : C.int) return C.int; function C_Close (Fildes : C.int) return C.int; function C_Connect (S : C.int; Name : System.Address; Namelen : C.int) return C.int; function C_Dup2 (Fildes, Fildes2 : C.int) return C.int; function C_Fcntl (Fildes : C.int; Cmd : C.int; Arg : C.int := 0) return C.int; function C_Getenv (Name : Strings.chars_ptr) return Strings.chars_ptr; function C_Gethostbyaddr (Addr : Strings.chars_ptr; Length : C.int; Typ : C.int) return Hostent_Access; function C_Gethostbyname (Name : Strings.chars_ptr) return Hostent_Access; function C_Gethostname (Name : Strings.chars_ptr; Namelen : C.int) return C.int; function C_Gethostname (Name : System.Address; Namelen : C.int) return C.int; function C_Getpeername (S : C.int; Name : System.Address; Namelen : access C.int) return C.int; function C_Getpid return pid_t; function C_Getsockname (S : C.int; Name : Sockaddr_Access; Namelen : access C.int) return C.int; function C_Getsockname (S : C.int; Name : System.Address; Namelen : access C.int) return C.int; function C_Getsockopt (S : C.int; Level : C.int; Optname : C.int; Optval : Strings.chars_ptr; Optlen : access C.int) return C.int; function C_Getsockopt (S : C.int; Level : C.int; Optname : C.int; Optval : System.Address; Optlen : access C.int) return C.int; function C_Inet_Addr (Cp : Strings.chars_ptr) return Types.In_Addr; function C_Inet_Network (Cp : Strings.chars_ptr) return Interfaces.Unsigned_32; function C_Inet_Makeaddr (Net : C.int; Lna : C.int) return In_Addr; function C_Inet_Lnaof (I : In_Addr) return C.int; function C_Inet_Netof (I : In_Addr) return C.int; function C_Inet_Ntoa (I : In_Addr) return Strings.chars_ptr; function C_Kill (Pid : pid_t; Sig : C.int) return C.int; function C_Listen (S, Backlog : C.int) return C.int; function C_Msgget (Key : key_t; Msgflg : C.int) return C.int; function C_Msgrcv (Msqid : C.int; Msgp : Strings.chars_ptr; Msgsz : C.int; Msgtyp : C.long; Msgflg : C.int) return C.int; function C_Msgsnd (Msqid : C.int; Msgp : Strings.chars_ptr; Msgsz : C.int; Msgflg : C.int) return C.int; function C_Open (Path : Strings.chars_ptr; Oflag : C.int; Mode : mode_t := 0) return C.int; function C_Socketpair (Domain : C.int; Typ : C.int; Protocol : C.int; Filedes : System.Address) return C.int; function C_Poll (Fds : System.Address; Nfds : C.unsigned_long; Timeout : C.int) return C.int; function C_Read (Fildes : C.int; Buf : System.Address; Nbyte : C.int) return C.int; function C_Readv (Fildes : C.int; Iov : System.Address; Iovcnt : C.int) return C.int; function C_Recv (S : C.int; Buf : System.Address; Len, Flags : C.int) return C.int; function C_Recvfrom (S : C.int; Buf : System.Address; Len : C.int; Flags : C.int; From : System.Address; Fromlen : access C.int) return C.int; function C_Recvmsg (S : C.int; Msg : Msghdr_Access; Flags : C.int) return C.int; function C_Send (S : C.int; Msg : System.Address; Len : C.int; Flags : C.int) return C.int; function C_Sendmsg (S : C.int; Msg : Msghdr_Access; Flags : C.int) return C.int; function C_Sendto (S : C.int; Msg : System.Address; Len : C.int; Flags : C.int; To : System.Address; Tolen : C.int) return C.int; function C_Setsid return pid_t; function C_Setsockopt (S : C.int; Level : C.int; Optname : C.int; Optval : System.Address; Optlen : C.int) return C.int; procedure C_Shutdown (S : C.int; How : C.int); function C_Socket (Domain, Typ, Protocol : C.int) return C.int; function C_Strerror (Errnum : C.int) return Strings.chars_ptr; function C_Write (Fildes : C.int; Buf : System.Address; Nbyte : C.int) return C.int; function C_Writev (Fildes : C.int; Iov : System.Address; Iovcnt : C.int) return C.int; function C_Ioctl (S : C.int; Req : C.int; Arg : access C.int) return C.int; function Errno return Integer; private pragma Import (Stdcall, C_Accept, "accept"); pragma Import (Stdcall, C_Bind, "bind"); pragma Import (Stdcall, C_Close, "closesocket"); pragma Import (Stdcall, C_Connect, "connect"); pragma Import (Stdcall, C_Dup2, "dup2"); pragma Import (Stdcall, C_Fcntl, "fcntl"); pragma Import (Stdcall, C_Getenv, "getenv"); pragma Import (Stdcall, C_Gethostbyaddr, "gethostbyaddr"); pragma Import (Stdcall, C_Gethostbyname, "gethostbyname"); pragma Import (Stdcall, C_Gethostname, "gethostname"); pragma Import (Stdcall, C_Getpeername, "getpeername"); pragma Import (Stdcall, C_Getpid, "getpid"); pragma Import (Stdcall, C_Getsockname, "getsockname"); pragma Import (Stdcall, C_Getsockopt, "getsockopt"); pragma Import (Stdcall, C_Inet_Addr, "inet_addr"); pragma Import (Stdcall, C_Inet_Network, "inet_network"); pragma Import (Stdcall, C_Inet_Makeaddr, "inet_makeaddr"); pragma Import (Stdcall, C_Inet_Lnaof, "inet_lnaof"); pragma Import (Stdcall, C_Inet_Netof, "inet_netof"); pragma Import (Stdcall, C_Inet_Ntoa, "inet_ntoa"); pragma Import (Stdcall, C_Kill, "kill"); pragma Import (Stdcall, C_Listen, "listen"); pragma Import (Stdcall, C_Msgget, "msgget"); pragma Import (Stdcall, C_Msgrcv, "msgrcv"); pragma Import (Stdcall, C_Msgsnd, "msgsnd"); pragma Import (Stdcall, C_Open, "open"); pragma Import (Stdcall, C_Recv, "recv"); pragma Import (Stdcall, C_Recvfrom, "recvfrom"); pragma Import (Stdcall, C_Recvmsg, "recvmsg"); pragma Import (Stdcall, C_Send, "send"); pragma Import (Stdcall, C_Sendmsg, "sendmsg"); pragma Import (Stdcall, C_Sendto, "sendto"); pragma Import (Stdcall, C_Setsid, "setsid"); pragma Import (Stdcall, C_Setsockopt, "setsockopt"); pragma Import (Stdcall, C_Shutdown, "shutdown"); pragma Import (Stdcall, C_Socket, "socket"); pragma Import (Stdcall, C_Strerror, "strerror"); pragma Import (Stdcall, C_Ioctl, "ioctlsocket"); end Sockets.Thin; adasockets-1.10.1/src/sockets-types.ads.in000066400000000000000000000107321277046543400204340ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . T Y P E S -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Interfaces.C; package Sockets.Types is package C renames Interfaces.C; type In_Addr is record S_B1, S_B2, S_B3, S_B4 : C.unsigned_char; end record; pragma Convention (C, In_Addr); -- Internet address type In_Addr_Access is access all In_Addr; pragma Convention (C, In_Addr_Access); -- Access to internet address Inaddr_Any : aliased constant In_Addr := (others => 0); -- Any internet address (all the interfaces) type Sockaddr is record @SA_LEN@ Sa_Len : C.unsigned_char := 18; @SA_LEN@ Sa_Family : C.unsigned_char; @NO_SA_LEN@ Sa_Family : C.unsigned_short; Sa_Data : C.char_array (1 .. 14); end record; pragma Convention (C, Sockaddr); -- Socket address type Sockaddr_Access is access all Sockaddr; pragma Convention (C, Sockaddr_Access); -- Access to socket address type Sockaddr_In is record @SA_LEN@ Sin_Len : C.unsigned_char := 18; @SA_LEN@ Sin_Family : C.unsigned_char := 0; @NO_SA_LEN@ Sin_Family : C.unsigned_short := 0; Sin_Port : C.unsigned_short := 0; Sin_Addr : In_Addr := Inaddr_Any; Sin_Zero : C.char_array (1 .. 8) := (others => C.char'Val (0)); end record; pragma Convention (C, Sockaddr_In); -- Internet socket address Null_Sockaddr_In : constant Sockaddr_In := ( @SA_LEN@ Sin_Len => 18, Sin_Family => 0, Sin_Port => 0, Sin_Addr => Inaddr_Any, Sin_Zero => (others => C.char'Val (0))); type Sockaddr_In_Access is access all Sockaddr_In; pragma Convention (C, Sockaddr_In_Access); -- Access to internet socket address end Sockets.Types; adasockets-1.10.1/src/sockets-utils.adb000066400000000000000000000126551277046543400200100ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . U T I L S -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Ada.Exceptions; use Ada.Exceptions; with Sockets.Thin; use Sockets.Thin; with System; use System; package body Sockets.Utils is use Interfaces.C; --------- -- "*" -- --------- function "*" (Left : String; Right : Natural) return String is Result : String (1 .. Left'Length * Right); First : Positive := 1; Last : Natural := First + Left'Length - 1; begin for I in 1 .. Right loop Result (First .. Last) := Left; First := First + Left'Length; Last := Last + Left'Length; end loop; return Result; end "*"; ------------------- -- Is_Ip_Address -- ------------------- function Is_IP_Address (Something : String) return Boolean is begin for Index in Something'Range loop declare Current : Character renames Something (Index); begin if (Current < '0' or else Current > '9') and then Current /= '.' then return False; end if; end; end loop; return True; end Is_IP_Address; --------------------- -- Port_To_Network -- --------------------- function Port_To_Network (Port : unsigned_short) return unsigned_short is begin pragma Warnings (Off); -- Test is statically always True or False if Default_Bit_Order = High_Order_First then return Port; else return (Port / 256) + (Port mod 256) * 256; end if; pragma Warnings (On); end Port_To_Network; ------------------------ -- Raise_With_Message -- ------------------------ procedure Raise_With_Message (Message : String; With_Errno : Boolean := True) is Current_Errno : constant Integer := Errno; begin if With_Errno then declare -- Using a local block avoids implicit memory allocation, -- which would erase the Errno value on Win32. Message_Text : constant String := Message & " (errno is" & Integer'Image (Current_Errno) & ")"; begin Raise_Exception (Socket_Error'Identity, Message_Text); end; else Raise_Exception (Socket_Error'Identity, Message); end if; -- The following line works around a bug in GNAT that does not -- recognize Ada.Exceptions.Raise_Exception as raising an exception, -- even if it can compute statically that the occurrence cannot -- be Null_Occurrence ??? raise Program_Error; end Raise_With_Message; end Sockets.Utils; adasockets-1.10.1/src/sockets-utils.ads000066400000000000000000000072661277046543400200330ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . U T I L S -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Interfaces.C; private package Sockets.Utils is pragma Elaborate_Body; procedure Raise_With_Message (Message : String; With_Errno : Boolean := True); pragma No_Return (Raise_With_Message); -- Raise Socket_Error with an associated error message function Port_To_Network (Port : Interfaces.C.unsigned_short) return Interfaces.C.unsigned_short; pragma Inline (Port_To_Network); function Network_To_Port (Port : Interfaces.C.unsigned_short) return Interfaces.C.unsigned_short renames Port_To_Network; function "*" (Left : String; Right : Natural) return String; pragma Inline ("*"); -- Return Left string repeated Right times function Is_IP_Address (Something : String) return Boolean; -- Return True if the name looks like an IP address, False otherwise end Sockets.Utils; adasockets-1.10.1/src/sockets-vms_link.ads000066400000000000000000000061151277046543400205050ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . V M S _ L I N K -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- -- Dominik Madon changes only for OpenVMS platform -- ----------------------------------------------------------------------------- private package Sockets.VMS_Link is -- pragma Linker_Options ("-lwsock32"); end Sockets.VMS_Link; adasockets-1.10.1/src/sockets-windows_link.adb000066400000000000000000000102531277046543400213470ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . W I N D O W S _ L I N K -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- -- Dmitiry Anisimkov changes only for Win32 platform -- ----------------------------------------------------------------------------- with Interfaces.C.Strings; package body Sockets.Windows_Link is use Interfaces, Interfaces.C, Interfaces.C.Strings; Function_Unsupported_On_Win32 : exception; WSAVERNOTSUPPORTED : exception; type WSADATA is record wVersion : Unsigned_16; wHighVersion : Unsigned_16; szDescription : char_array (1 .. 129); szSystemStatus : char_array (1 .. 257); iMaxSockets : Unsigned_16; iMaxUdpDg : Unsigned_16; lpVendorInfo : chars_ptr; end record; pragma Convention (C, WSADATA); WSAInfo : aliased WSADATA; type LPWSADATA is access all WSADATA; pragma Convention (C, LPWSADATA); function WSAStartup (VersionRequested : Short_Integer; WSAData : LPWSADATA) return Integer; pragma Import (StdCall, WSAStartup, "WSAStartup"); ----------------- -- Unsupported -- ----------------- procedure Unsupported is begin raise Function_Unsupported_On_Win32; end Unsupported; Version : constant Short_Integer := 16#0101#; begin if WSAStartup (Version, WSAInfo'Access) /= 0 then raise WSAVERNOTSUPPORTED; end if; end Sockets.Windows_Link; adasockets-1.10.1/src/sockets-windows_link.ads000066400000000000000000000062501277046543400213720ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S . W I N D O W S _ L I N K -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- -- Dmitriy Anisimkov changes only for Win32 platform -- ----------------------------------------------------------------------------- private package Sockets.Windows_Link is pragma Linker_Options ("-lwsock32"); private procedure Unsupported; pragma Export (C, Unsupported, "socketpair"); end Sockets.Windows_Link; adasockets-1.10.1/src/sockets.adb000066400000000000000000000554041277046543400166510ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Ada.Characters.Latin_1; use Ada.Characters.Latin_1; with Ada.Unchecked_Deallocation; with Sockets.Constants; use Sockets.Constants; with Sockets.Link; pragma Warnings (Off, Sockets.Link); with Sockets.Naming; use Sockets.Naming; with Sockets.Thin; use Sockets.Thin; with Sockets.Types; use Sockets.Types; with Sockets.Utils; use Sockets.Utils; package body Sockets is use Ada.Streams, Interfaces.C; Socket_Domain_Match : constant array (Socket_Domain) of int := (PF_INET => Constants.Af_Inet, AF_INET => Constants.Af_Inet); -- They hold the same value Socket_Type_Match : constant array (Socket_Type) of int := (SOCK_STREAM => Constants.Sock_Stream, SOCK_DGRAM => Constants.Sock_Dgram); Shutdown_Type_Match : constant array (Shutdown_Type) of int := (Receive => 0, Send => 1, Both => 2); Socket_Level_Match : constant array (Socket_Level) of int := (SOL_SOCKET => Constants.Sol_Socket, IPPROTO_IP => Constants.Ipproto_Ip, SOL_TCP => Constants.Sol_Tcp); Socket_Option_Match : constant array (Socket_Option) of int := (SO_REUSEADDR => Constants.So_Reuseaddr, SO_REUSEPORT => Constants.So_Reuseport, IP_MULTICAST_TTL => Constants.Ip_Multicast_Ttl, IP_ADD_MEMBERSHIP => Constants.Ip_Add_Membership, IP_DROP_MEMBERSHIP => Constants.Ip_Drop_Membership, IP_MULTICAST_LOOP => Constants.Ip_Multicast_Loop, SO_SNDBUF => Constants.So_Sndbuf, SO_RCVBUF => Constants.So_Rcvbuf, SO_KEEPALIVE => Constants.So_Keepalive, SO_NOSIGPIPE => Constants.So_Nosigpipe, TCP_KEEPCNT => Constants.Tcp_Keepcnt, TCP_KEEPIDLE => Constants.Tcp_Keepidle, TCP_KEEPINTVL => Constants.Tcp_Keepintvl, TCP_NODELAY => Constants.Tcp_Nodelay); Socket_Option_Size : constant array (Socket_Option) of Natural := (SO_REUSEADDR => 4, SO_REUSEPORT => 4, IP_MULTICAST_TTL => 1, IP_ADD_MEMBERSHIP => 8, IP_DROP_MEMBERSHIP => 8, IP_MULTICAST_LOOP => 1, SO_SNDBUF => 4, SO_RCVBUF => 4, SO_KEEPALIVE => 4, SO_NOSIGPIPE => 4, TCP_KEEPCNT => 4, TCP_KEEPIDLE => 4, TCP_KEEPINTVL => 4, TCP_NODELAY => 4); CRLF : constant String := CR & LF; procedure Refill (Socket : Socket_FD'Class); -- Refill the socket when in buffered mode by receiving one packet -- and putting it in the buffer. function To_String (S : Stream_Element_Array) return String; function Empty_Buffer (Socket : Socket_FD'Class) return Boolean; -- Return True if buffered socket has an empty buffer ------------------- -- Accept_Socket -- ------------------- procedure Accept_Socket (Socket : Socket_FD; New_Socket : out Socket_FD) is Sin : aliased Sockaddr_In; Size : aliased int := Sin'Size / 8; Code : int; begin Code := C_Accept (Socket.FD, Sin'Address, Size'Access); if Code = Failure then Raise_With_Message ("Accept system call failed"); else New_Socket := (FD => Code, Shutdown => (others => False), Buffer => null); end if; end Accept_Socket; ---------- -- Bind -- ---------- procedure Bind (Socket : Socket_FD; Port : Natural; Host : String := "") is Sin : aliased Sockaddr_In; begin Sin.Sin_Family := Constants.Af_Inet; if Host /= "" then Sin.Sin_Addr := To_In_Addr (Address_Of (Host)); end if; Sin.Sin_Port := Port_To_Network (unsigned_short (Port)); if C_Bind (Socket.FD, Sin'Address, Sin'Size / 8) = Failure then Raise_With_Message ("Bind failed"); end if; end Bind; ------------- -- Connect -- ------------- procedure Connect (Socket : Socket_FD; Host : String; Port : Positive) is Sin : aliased Sockaddr_In; Current_Errno : Integer; begin Sin.Sin_Family := Constants.Af_Inet; Sin.Sin_Addr := To_In_Addr (Address_Of (Host)); Sin.Sin_Port := Port_To_Network (unsigned_short (Port)); if C_Connect (Socket.FD, Sin'Address, Sin'Size / 8) = Failure then Current_Errno := Thin.Errno; if Current_Errno = Constants.Econnrefused then raise Connection_Refused; else Raise_With_Message ("Connection failed (errno was" & Integer'Image (Current_Errno) & ')', False); end if; end if; end Connect; --------------------------- -- Customized_Setsockopt -- --------------------------- procedure Customized_Setsockopt (Socket : Socket_FD'Class; Optval : Opt_Type) is begin pragma Assert (Optval'Size / 8 = Socket_Option_Size (Optname)); if C_Setsockopt (Socket.FD, Socket_Level_Match (Level), Socket_Option_Match (Optname), Optval'Address, Optval'Size / 8) = Failure then Raise_With_Message ("Setsockopt failed"); end if; end Customized_Setsockopt; ------------------ -- Empty_Buffer -- ------------------ function Empty_Buffer (Socket : Socket_FD'Class) return Boolean is begin return Socket.Buffer.First > Socket.Buffer.Last; end Empty_Buffer; --------- -- Get -- --------- function Get (Socket : Socket_FD'Class) return String is begin if Socket.Buffer /= null and then not Empty_Buffer (Socket) then declare S : constant String := To_String (Socket.Buffer.Content (Socket.Buffer.First .. Socket.Buffer.Last)); begin Socket.Buffer.First := Socket.Buffer.Last + 1; return S; end; else return To_String (Receive (Socket)); end if; end Get; -------------- -- Get_Char -- -------------- function Get_Char (Socket : Socket_FD'Class) return Character is C : Stream_Element_Array (0 .. 0); begin if Socket.Buffer = null then -- Unbuffered mode Receive (Socket, C); else -- Buffered mode if Empty_Buffer (Socket) then Refill (Socket); end if; C (0) := Socket.Buffer.Content (Socket.Buffer.First); Socket.Buffer.First := Socket.Buffer.First + 1; end if; return Character'Val (C (0)); end Get_Char; ------------ -- Get FD -- ------------ function Get_FD (Socket : Socket_FD) return Interfaces.C.int is begin return Socket.FD; end Get_FD; -------------- -- Get_Line -- -------------- procedure Get_Line (Socket : Socket_FD'Class; Str : out String; Last : out Natural) is Index : Positive := Str'First; Char : Character; begin loop Char := Get_Char (Socket); if Char = LF then Last := Index - 1; return; elsif Char /= CR then Str (Index) := Char; Index := Index + 1; if Index > Str'Last then Last := Str'Last; return; end if; end if; end loop; end Get_Line; -------------- -- Get_Line -- -------------- function Get_Line (Socket : Socket_FD'Class; Max_Length : Positive := 2048) return String is Result : String (1 .. Max_Length); Last : Natural; begin Get_Line (Socket, Result, Last); return Result (1 .. Last); end Get_Line; ---------------------------- -- Get_Receive_Queue_Size -- ---------------------------- function Get_Receive_Queue_Size (Socket : Socket_FD) return Integer is Error : Interfaces.C.int; Size : aliased Interfaces.C.int := 0; begin -- The check always evaluates statically pragma Warnings (Off, "condition is always *"); if Siocinq = -1 then return -2; end if; pragma Warnings (On, "condition is always *"); Error := C_Ioctl (Socket.FD, Siocinq, Size'Access); if Error < 0 then return Integer (Error); else return Integer (Size); end if; end Get_Receive_Queue_Size; ------------------------- -- Get_Send_Queue_Size -- ------------------------- function Get_Send_Queue_Size (Socket : Socket_FD) return Integer is Error : Interfaces.C.int; Size : aliased Interfaces.C.int := 0; begin -- The check always evaluates statically pragma Warnings (Off, "condition is always *"); if Siocoutq = -1 then return -2; end if; pragma Warnings (On, "condition is always *"); Error := C_Ioctl (Socket.FD, Siocoutq, Size'Access); if Error < 0 then return Integer (Error); else return Integer (Size); end if; end Get_Send_Queue_Size; ---------------- -- Getsockopt -- ---------------- procedure Getsockopt (Socket : Socket_FD'Class; Level : Socket_Level := SOL_SOCKET; Optname : Socket_Option; Optval : out Integer) is Len : aliased int; begin case Socket_Option_Size (Optname) is when 1 => declare C_Char_Optval : aliased char; begin pragma Assert (C_Char_Optval'Size = 8); Len := 1; if C_Getsockopt (Socket.FD, Socket_Level_Match (Level), Socket_Option_Match (Optname), C_Char_Optval'Address, Len'Access) = Failure then Raise_With_Message ("Getsockopt failed"); end if; Optval := char'Pos (C_Char_Optval); end; when 4 => declare C_Int_Optval : aliased int; begin pragma Assert (C_Int_Optval'Size = 32); Len := 4; if C_Getsockopt (Socket.FD, Socket_Level_Match (Level), Socket_Option_Match (Optname), C_Int_Optval'Address, Len'Access) = Failure then Raise_With_Message ("Getsockopt failed"); end if; Optval := Integer (C_Int_Optval); end; when others => Raise_With_Message ("Getsockopt called with wrong arguments", False); end case; end Getsockopt; ------------ -- Listen -- ------------ procedure Listen (Socket : Socket_FD; Queue_Size : Positive := 5) is begin if C_Listen (Socket.FD, int (Queue_Size)) = Failure then Raise_With_Message ("Listen failed"); end if; end Listen; -------------- -- New_Line -- -------------- procedure New_Line (Socket : Socket_FD'Class; Count : Natural := 1) is begin Put (Socket, CRLF * Count); end New_Line; --------- -- Put -- --------- procedure Put (Socket : Socket_FD'Class; Str : String) is Stream : Stream_Element_Array (Stream_Element_Offset (Str'First) .. Stream_Element_Offset (Str'Last)); begin for I in Str'Range loop Stream (Stream_Element_Offset (I)) := Stream_Element'Val (Character'Pos (Str (I))); end loop; Send (Socket, Stream); end Put; -------------- -- Put_Line -- -------------- procedure Put_Line (Socket : Socket_FD'Class; Str : String) is begin Put (Socket, Str & CRLF); end Put_Line; ------------- -- Receive -- ------------- function Receive (Socket : Socket_FD; Max : Stream_Element_Count := 4096) return Stream_Element_Array is Buffer : Stream_Element_Array (1 .. Max); Addr : aliased Sockaddr_In; Addrlen : aliased int := Addr'Size / 8; Count : int; begin if Socket.Shutdown (Receive) then raise Connection_Closed; end if; Count := C_Recvfrom (Socket.FD, Buffer'Address, Buffer'Length, 0, Addr'Address, Addrlen'Access); if Count < 0 then Raise_With_Message ("Receive error"); elsif Count = 0 then raise Connection_Closed; end if; return Buffer (1 .. Stream_Element_Offset (Count)); end Receive; ------------- -- Receive -- ------------- procedure Receive (Socket : Socket_FD'Class; Data : out Stream_Element_Array) is Index : Stream_Element_Offset := Data'First; Rest : Stream_Element_Count := Data'Length; Addr : aliased Sockaddr_In; Addrlen : aliased int := Addr'Size / 8; Count : int; begin while Rest > 0 loop Count := C_Recvfrom (Socket.FD, Data (Index) 'Address, int (Rest), 0, Addr'Address, Addrlen'Access); if Count < 0 then Raise_With_Message ("Receive error"); elsif Count = 0 then raise Connection_Closed; end if; Index := Index + Stream_Element_Count (Count); Rest := Rest - Stream_Element_Count (Count); end loop; end Receive; ------------------ -- Receive_Some -- ------------------ procedure Receive_Some (Socket : Socket_FD'Class; Data : out Stream_Element_Array; Last : out Stream_Element_Offset) is Addr : aliased Sockaddr_In; Addrlen : aliased int := Addr'Size / 8; Count : int; begin Count := C_Recvfrom (Socket.FD, Data (Data'First) 'Address, int (Data'Length), 0, Addr'Address, Addrlen'Access); if Count < 0 then Raise_With_Message ("Receive error"); elsif Count = 0 then raise Connection_Closed; end if; Last := Data'First + Stream_Element_Count (Count) - 1; end Receive_Some; ------------ -- Refill -- ------------ procedure Refill (Socket : Socket_FD'Class) is begin pragma Assert (Socket.Buffer /= null); Receive_Some (Socket, Socket.Buffer.Content, Socket.Buffer.Last); Socket.Buffer.First := 0; end Refill; ---------- -- Send -- ---------- procedure Send (Socket : Socket_FD; Data : Stream_Element_Array) is Index : Stream_Element_Offset := Data'First; Rest : Stream_Element_Count := Data'Length; Count : int; Flags : int := 0; begin if Socket.Shutdown (Send) then raise Connection_Closed; end if; pragma Warnings (Off, "condition is always *"); if Constants.So_Nosigpipe = -1 and Constants.Msg_Nosignal /= -1 then Flags := Constants.Msg_Nosignal; end if; pragma Warnings (On, "condition is always *"); while Rest > 0 loop Count := C_Send (Socket.FD, Data (Index) 'Address, int (Rest), Flags); if Count <= 0 then -- Count could be zero if the socket was in non-blocking mode -- and the output buffers were full. Since we do not support -- non-blocking mode, this is an error. raise Connection_Closed; end if; Index := Index + Stream_Element_Count (Count); Rest := Rest - Stream_Element_Count (Count); end loop; end Send; ---------------- -- Set_Buffer -- ---------------- procedure Set_Buffer (Socket : in out Socket_FD'Class; Length : Positive := 1500) is begin Unset_Buffer (Socket); Socket.Buffer := new Buffer_Type (Stream_Element_Count (Length)); end Set_Buffer; ---------------- -- Setsockopt -- ---------------- procedure Setsockopt (Socket : Socket_FD'Class; Level : Socket_Level := SOL_SOCKET; Optname : Socket_Option; Optval : Integer) is begin case Socket_Option_Size (Optname) is when 1 => declare C_Char_Optval : aliased char := char'Val (Optval); begin pragma Assert (C_Char_Optval'Size = 8); if C_Setsockopt (Socket.FD, Socket_Level_Match (Level), Socket_Option_Match (Optname), C_Char_Optval'Address, 1) = Failure then Raise_With_Message ("Setsockopt failed"); end if; end; when 4 => declare C_Int_Optval : aliased int := int (Optval); begin pragma Assert (C_Int_Optval'Size = 32); if C_Setsockopt (Socket.FD, Socket_Level_Match (Level), Socket_Option_Match (Optname), C_Int_Optval'Address, 4) = Failure then Raise_With_Message ("Setsockopt failed"); end if; end; when others => Raise_With_Message ("Setsockopt called with wrong arguments", False); end case; end Setsockopt; -------------- -- Shutdown -- -------------- procedure Shutdown (Socket : in out Socket_FD; How : Shutdown_Type := Both) is begin if How /= Both then Socket.Shutdown (How) := True; else Socket.Shutdown := (others => True); end if; C_Shutdown (Socket.FD, Shutdown_Type_Match (How)); if Socket.Shutdown (Receive) and then Socket.Shutdown (Send) then declare Result : constant int := C_Close (Socket.FD); pragma Unreferenced (Result); begin Unset_Buffer (Socket); end; end if; end Shutdown; ------------ -- Socket -- ------------ procedure Socket (Sock : out Socket_FD; Domain : Socket_Domain := PF_INET; Typ : Socket_Type := SOCK_STREAM) is Result : constant int := C_Socket (Socket_Domain_Match (Domain), Socket_Type_Match (Typ), 0); begin if Result = Failure then Raise_With_Message ("Unable to create socket"); end if; Sock := (FD => Result, Shutdown => (others => False), Buffer => null); pragma Warnings (Off, "condition is always *"); if Constants.So_Nosigpipe /= -1 then Setsockopt (Sock, SOL_SOCKET, SO_NOSIGPIPE, 1); end if; pragma Warnings (On, "condition is always *"); end Socket; ---------------- -- Socketpair -- ---------------- procedure Socketpair (Read_End : out Socket_FD; Write_End : out Socket_FD; Domain : Socket_Domain := PF_INET; Typ : Socket_Type := SOCK_STREAM) is Filedes : aliased Two_Int; Result : constant int := C_Socketpair (Socket_Domain_Match (Domain), Socket_Type_Match (Typ), 0, Filedes'Address); begin if Result = Failure then Raise_With_Message ("Unable to create socket"); end if; Read_End := (FD => Filedes (0), Shutdown => (others => False), Buffer => null); Write_End := (FD => Filedes (1), Shutdown => (others => False), Buffer => null); end Socketpair; --------------- -- To_String -- --------------- function To_String (S : Stream_Element_Array) return String is Result : String (1 .. S'Length); begin for I in Result'Range loop Result (I) := Character'Val (Stream_Element'Pos (S (Stream_Element_Offset (I) + S'First - 1))); end loop; return Result; end To_String; ------------------ -- Unset_Buffer -- ------------------ procedure Unset_Buffer (Socket : in out Socket_FD'Class) is procedure Free is new Ada.Unchecked_Deallocation (Buffer_Type, Buffer_Access); begin Free (Socket.Buffer); end Unset_Buffer; end Sockets; adasockets-1.10.1/src/sockets.ads000066400000000000000000000245461277046543400166750ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S O C K E T S -- -- -- -- S p e c -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Ada.Streams; with Interfaces.C; package Sockets is type Socket_FD is tagged private; -- A socket Null_Socket_FD : constant Socket_FD; -- An empty socket type Socket_Domain is (PF_INET, AF_INET); -- PF_INET: Internet sockets -- AF_INET: This entry is bogus and should never be used, but it is -- kept here for some time for compatibility reasons. type Socket_Type is (SOCK_STREAM, SOCK_DGRAM); -- SOCK_STREAM: Stream mode (TCP) -- SOCK_DGRAM: Datagram mode (UDP, Multicast) procedure Socket (Sock : out Socket_FD; Domain : Socket_Domain := PF_INET; Typ : Socket_Type := SOCK_STREAM); -- Create a socket of the given mode Connection_Refused : exception; Socket_Error : exception; procedure Connect (Socket : Socket_FD; Host : String; Port : Positive); -- Connect a socket on a given host/port. Raise Connection_Refused if -- the connection has not been accepted by the other end, or -- Socket_Error (with a more precise exception message) for another error. procedure Bind (Socket : Socket_FD; Port : Natural; Host : String := ""); -- Bind a socket on a given port. Using 0 for the port will tell the -- OS to allocate a non-privileged free port. The port can be later -- retrieved using Get_Sock_Port on the bound socket. -- If Host is not the empty string, it is used to designate the interface -- to bind on. -- Socket_Error can be raised if the system refuses to bind the port. procedure Listen (Socket : Socket_FD; Queue_Size : Positive := 5); -- Create a socket's listen queue type Socket_Level is (SOL_SOCKET, IPPROTO_IP, SOL_TCP); type Socket_Option is (SO_REUSEADDR, SO_REUSEPORT, IP_MULTICAST_TTL, IP_ADD_MEMBERSHIP, IP_DROP_MEMBERSHIP, IP_MULTICAST_LOOP, SO_SNDBUF, SO_RCVBUF, SO_KEEPALIVE, SO_NOSIGPIPE, TCP_KEEPCNT, TCP_KEEPIDLE, TCP_KEEPINTVL, TCP_NODELAY); procedure Getsockopt (Socket : Socket_FD'Class; Level : Socket_Level := SOL_SOCKET; Optname : Socket_Option; Optval : out Integer); -- Get a socket option procedure Setsockopt (Socket : Socket_FD'Class; Level : Socket_Level := SOL_SOCKET; Optname : Socket_Option; Optval : Integer); -- Set a socket option generic Level : Socket_Level; Optname : Socket_Option; type Opt_Type is private; procedure Customized_Setsockopt (Socket : Socket_FD'Class; Optval : Opt_Type); -- Low level control on setsockopt procedure Accept_Socket (Socket : Socket_FD; New_Socket : out Socket_FD); -- Accept a connection on a socket Connection_Closed : exception; procedure Send (Socket : Socket_FD; Data : Ada.Streams.Stream_Element_Array); -- Send data on a socket. Raise Connection_Closed if the socket -- has been closed. function Receive (Socket : Socket_FD; Max : Ada.Streams.Stream_Element_Count := 4096) return Ada.Streams.Stream_Element_Array; -- Receive data from a socket. May raise Connection_Closed procedure Receive (Socket : Socket_FD'Class; Data : out Ada.Streams.Stream_Element_Array); -- Get data from a socket. Raise Connection_Closed if the socket has -- been closed before the end of the array. procedure Receive_Some (Socket : Socket_FD'Class; Data : out Ada.Streams.Stream_Element_Array; Last : out Ada.Streams.Stream_Element_Offset); -- Get some data from a socket. The index of the last element will -- be placed in Last. type Shutdown_Type is (Receive, Send, Both); procedure Shutdown (Socket : in out Socket_FD; How : Shutdown_Type := Both); -- Close a previously opened socket procedure Socketpair (Read_End : out Socket_FD; Write_End : out Socket_FD; Domain : Socket_Domain := PF_INET; Typ : Socket_Type := SOCK_STREAM); -- Create a socketpair. function Get_FD (Socket : Socket_FD) return Interfaces.C.int; pragma Inline (Get_FD); -- Get a socket's FD field --------------------------------- -- String-oriented subprograms -- --------------------------------- procedure Put (Socket : Socket_FD'Class; Str : String); -- Send a string on the socket procedure New_Line (Socket : Socket_FD'Class; Count : Natural := 1); -- Send CR/LF sequences on the socket procedure Put_Line (Socket : Socket_FD'Class; Str : String); -- Send a string + CR/LF on the socket function Get (Socket : Socket_FD'Class) return String; -- Get a string from the socket function Get_Char (Socket : Socket_FD'Class) return Character; -- Get one character from the socket procedure Get_Line (Socket : Socket_FD'Class; Str : out String; Last : out Natural); -- Get a full line from the socket. CR is ignored and LF is considered -- as an end-of-line marker. function Get_Line (Socket : Socket_FD'Class; Max_Length : Positive := 2048) return String; -- Function form for the former procedure procedure Set_Buffer (Socket : in out Socket_FD'Class; Length : Positive := 1500); -- Put socket in buffered mode. If the socket is already buffered, -- the content of the previous buffer will be lost. The buffered mode -- only affects read operation, through Get, Get_Char and Get_Line. Other -- reception subprograms will not function properly if buffered mode -- is used at the same time. The size of the buffer has to be greater -- than the biggest possible packet, otherwise data loss may occur. procedure Unset_Buffer (Socket : in out Socket_FD'Class); -- Put socket in unbuffered mode. If the socket was unbuffered already, -- no error will be raised. If it was buffered and the buffer was not -- empty, its content will be lost. function Get_Send_Queue_Size (Socket : Socket_FD) return Integer; -- Return size of unsent data in socket output buffer. -- Return a value less than 0 in case of error. -2 means that the -- information is not available (Linux only). function Get_Receive_Queue_Size (Socket : Socket_FD) return Integer; -- Return size of unread data in socket input buffer. -- Return a value less than 0 in case of error. -2 means that the -- information is not available (Linux only). private use type Ada.Streams.Stream_Element_Count; type Buffer_Type (Length : Ada.Streams.Stream_Element_Count) is record Content : Ada.Streams.Stream_Element_Array (0 .. Length); -- One byte will stay unused, but this does not have any consequence First : Ada.Streams.Stream_Element_Offset := Ada.Streams.Stream_Element_Offset'Last; Last : Ada.Streams.Stream_Element_Offset := 0; end record; type Buffer_Access is access Buffer_Type; type Shutdown_Array is array (Receive .. Send) of Boolean; type Socket_FD is tagged record FD : Interfaces.C.int := Interfaces.C."-" (1); Shutdown : Shutdown_Array := (others => True); Buffer : Buffer_Access; end record; Null_Socket_FD : constant Socket_FD := (FD => Interfaces.C."-" (1), Shutdown => (others => True), Buffer => null); end Sockets; adasockets-1.10.1/src/split.adb000066400000000000000000000103411277046543400163200ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- S P L I T -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 Télécom ParisTech -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets.html -- -- -- -- If you have any question, please use the issues tracker at: -- -- https://github.com/samueltardieu/adasockets/issues -- -- -- ----------------------------------------------------------------------------- with Ada.Command_Line; use Ada.Command_Line; with Ada.Text_IO; use Ada.Text_IO; procedure Split is Column : Natural := 0; Max_Column : constant := 65; Hard_Max_Column : constant := 78; Was_Space : Boolean := False; procedure Print_Space_Maybe; procedure Print_Space_Maybe is begin if Was_Space and then Column /= 0 then Put (' '); Column := Column + 1; Was_Space := False; end if; end Print_Space_Maybe; begin if Argument_Count /= 1 then Put_Line ("Error, usage: split ""text"""); Set_Exit_Status (1); else for I in 1 .. Argument (1) 'Length loop if Argument (1) (I) = ' ' and then Column >= Max_Column then New_Line; Column := 0; elsif Argument (1) (I) = ' ' and then Column = 0 then null; elsif Column >= Hard_Max_Column then New_Line; Put ("-- " & Argument (1) (I)); Column := 5; elsif Argument (1) (I) = ' ' then Was_Space := True; else if Column = 0 then Put ("-- "); Column := 4; else Print_Space_Maybe; end if; Put (Argument (1) (I)); Column := Column + 1; end if; end loop; if Column > 0 then New_Line; end if; end if; end Split; adasockets-1.10.1/support/000077500000000000000000000000001277046543400154435ustar00rootroot00000000000000adasockets-1.10.1/support/adacompiler000077500000000000000000000006121277046543400176500ustar00rootroot00000000000000#! /bin/sh # # Extract the directory name from "-o .libs/foobar.lo" and do the move # after the compilation. # GNATMAKE=$1 shift cline="$@" fname=`echo $cline | sed -e 's/^.* -o \([^ ]*\)$/\1/'` rname=`basename $fname | sed -e 's/lo$/o/'` cline=`echo $cline | sed -e "s, -o \([^ ]*\)\$,,"` $GNATMAKE -f -u $cline if [ "$rname" != "$fname" ]; then echo mv $rname $fname mv $rname $fname fi adasockets-1.10.1/support/git2cl000077500000000000000000000262651277046543400165700ustar00rootroot00000000000000#!/usr/bin/perl # Copyright (C) 2007, 2008 Simon Josefsson # Copyright (C) 2007 Luis Mondesi # * calls git directly. To use it just: # cd ~/Project/my_git_repo; git2cl > ChangeLog # * implements strptime() # * fixes bugs in $comment parsing # - copy input before we remove leading spaces # - skip "merge branch" statements as they don't # have information about files (i.e. we never # go into $state 2) # - behaves like a pipe/filter if input is given from the CLI # else it calls git log by itself # # The functions mywrap, last_line_len, wrap_log_entry are derived from # the cvs2cl tool, see : # Copyright (C) 2001,2002,2003,2004 Martyn J. Pearce # Copyright (C) 1999 Karl Fogel # # git2cl 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. # # git2cl 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 git2cl; see the file COPYING. If not, write to the Free # Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA # 02110-1301 USA. =head1 NAME git2cl - tool to convert git logs to GNU ChangeLog =head1 SYNOPSIS git2cl > ChangeLog If you don't want git2cl to invoke git log internally, you can use it as a pipe. It needs a git log generated with --pretty --numstat and --summary. You can use it as follows: git log --pretty --numstat --summary | git2cl > ChangeLog =head1 DESCRIPTION This is a quick'n'dirty tool to convert git logs to GNU ChangeLog format. The tool invokes `git log` internally unless you pipe a log to it. Thus, typically you would use it as follows: =head1 SEE ALSO Output format specification: =head1 AUTHORS git2cl is developed by Simon Josefsson and Luis Mondesi =cut use strict; use POSIX qw(strftime); use Text::Wrap qw(wrap); use FileHandle; use constant EMPTY_LOG_MESSAGE => '*** empty log message ***'; # this is a helper hash for stptime. # Assumes you are calling 'git log ...' with LC_ALL=C my %month = ( 'Jan'=>0, 'Feb'=>1, 'Mar'=>2, 'Apr'=>3, 'May'=>4, 'Jun'=>5, 'Jul'=>6, 'Aug'=>7, 'Sep'=>8, 'Oct'=>9, 'Nov'=>10, 'Dec'=>11, ); my $fh = new FileHandle; sub key_ready { my ($rin, $nfd); vec($rin, fileno(STDIN), 1) = 1; return $nfd = select($rin, undef, undef, 0); } sub strptime { my $str = shift; return undef if not defined $str; # we are parsing this format # Fri Oct 26 00:42:56 2007 -0400 # to these fields # sec, min, hour, mday, mon, year, wday = -1, yday = -1, isdst = -1 # Luis Mondesi my @date; if ($str =~ /([[:alpha:]]{3})\s+([[:alpha:]]{3})\s+([[:digit:]]{1,2})\s+([[:digit:]]{1,2}):([[:digit:]]{1,2}):([[:digit:]]{1,2})\s+([[:digit:]]{4})/){ push(@date,$6,$5,$4,$3,$month{$2},($7 - 1900),-1,-1,-1); } else { die ("Cannot parse date '$str'\n'"); } return @date; } sub mywrap { my ($indent1, $indent2, @text) = @_; # If incoming text looks preformatted, don't get clever my $text = Text::Wrap::wrap($indent1, $indent2, @text); if ( grep /^\s+/m, @text ) { return $text; } my @lines = split /\n/, $text; $indent2 =~ s!^((?: {8})+)!"\t" x (length($1)/8)!e; $lines[0] =~ s/^$indent1\s+/$indent1/; s/^$indent2\s+/$indent2/ for @lines[1..$#lines]; my $newtext = join "\n", @lines; $newtext .= "\n" if substr($text, -1) eq "\n"; return $newtext; } sub last_line_len { my $files_list = shift; my @lines = split (/\n/, $files_list); my $last_line = pop (@lines); return length ($last_line); } # A custom wrap function, sensitive to some common constructs used in # log entries. sub wrap_log_entry { my $text = shift; # The text to wrap. my $left_pad_str = shift; # String to pad with on the left. # These do NOT take left_pad_str into account: my $length_remaining = shift; # Amount left on current line. my $max_line_length = shift; # Amount left for a blank line. my $wrapped_text = ''; # The accumulating wrapped entry. my $user_indent = ''; # Inherited user_indent from prev line. my $first_time = 1; # First iteration of the loop? my $suppress_line_start_match = 0; # Set to disable line start checks. my @lines = split (/\n/, $text); while (@lines) # Don't use `foreach' here, it won't work. { my $this_line = shift (@lines); chomp $this_line; if ($this_line =~ /^(\s+)/) { $user_indent = $1; } else { $user_indent = ''; } # If it matches any of the line-start regexps, print a newline now... if ($suppress_line_start_match) { $suppress_line_start_match = 0; } elsif (($this_line =~ /^(\s*)\*\s+[a-zA-Z0-9]/) || ($this_line =~ /^(\s*)\* [a-zA-Z0-9_\.\/\+-]+/) || ($this_line =~ /^(\s*)\([a-zA-Z0-9_\.\/\+-]+(\)|,\s*)/) || ($this_line =~ /^(\s+)(\S+)/) || ($this_line =~ /^(\s*)- +/) || ($this_line =~ /^()\s*$/) || ($this_line =~ /^(\s*)\*\) +/) || ($this_line =~ /^(\s*)[a-zA-Z0-9](\)|\.|\:) +/)) { $length_remaining = $max_line_length - (length ($user_indent)); } # Now that any user_indent has been preserved, strip off leading # whitespace, so up-folding has no ugly side-effects. $this_line =~ s/^\s*//; # Accumulate the line, and adjust parameters for next line. my $this_len = length ($this_line); if ($this_len == 0) { # Blank lines should cancel any user_indent level. $user_indent = ''; $length_remaining = $max_line_length; } elsif ($this_len >= $length_remaining) # Line too long, try breaking it. { # Walk backwards from the end. At first acceptable spot, break # a new line. my $idx = $length_remaining - 1; if ($idx < 0) { $idx = 0 }; while ($idx > 0) { if (substr ($this_line, $idx, 1) =~ /\s/) { my $line_now = substr ($this_line, 0, $idx); my $next_line = substr ($this_line, $idx); $this_line = $line_now; # Clean whitespace off the end. chomp $this_line; # The current line is ready to be printed. $this_line .= "\n${left_pad_str}"; # Make sure the next line is allowed full room. $length_remaining = $max_line_length - (length ($user_indent)); # Strip next_line, but then preserve any user_indent. $next_line =~ s/^\s*//; # Sneak a peek at the user_indent of the upcoming line, so # $next_line (which will now precede it) can inherit that # indent level. Otherwise, use whatever user_indent level # we currently have, which might be none. my $next_next_line = shift (@lines); if ((defined ($next_next_line)) && ($next_next_line =~ /^(\s+)/)) { $next_line = $1 . $next_line if (defined ($1)); # $length_remaining = $max_line_length - (length ($1)); $next_next_line =~ s/^\s*//; } else { $next_line = $user_indent . $next_line; } if (defined ($next_next_line)) { unshift (@lines, $next_next_line); } unshift (@lines, $next_line); # Our new next line might, coincidentally, begin with one of # the line-start regexps, so we temporarily turn off # sensitivity to that until we're past the line. $suppress_line_start_match = 1; last; } else { $idx--; } } if ($idx == 0) { # We bottomed out because the line is longer than the # available space. But that could be because the space is # small, or because the line is longer than even the maximum # possible space. Handle both cases below. if ($length_remaining == ($max_line_length - (length ($user_indent)))) { # The line is simply too long -- there is no hope of ever # breaking it nicely, so just insert it verbatim, with # appropriate padding. $this_line = "\n${left_pad_str}${this_line}"; } else { # Can't break it here, but may be able to on the next round... unshift (@lines, $this_line); $length_remaining = $max_line_length - (length ($user_indent)); $this_line = "\n${left_pad_str}"; } } } else # $this_len < $length_remaining, so tack on what we can. { # Leave a note for the next iteration. $length_remaining = $length_remaining - $this_len; if ($this_line =~ /\.$/) { $this_line .= " "; $length_remaining -= 2; } else # not a sentence end { $this_line .= " "; $length_remaining -= 1; } } # Unconditionally indicate that loop has run at least once. $first_time = 0; $wrapped_text .= "${user_indent}${this_line}"; } # One last bit of padding. $wrapped_text .= "\n"; return $wrapped_text; } # main my @date; my $author; my @files; my $comment; my $state; # 0-header 1-comment 2-files my $done = 0; $state = 0; # if reading from STDIN, we assume that we are # getting git log as input if (key_ready()) { #my $dummyfh; # don't care about writing #($fh,$dummyfh) = FileHandle::pipe; $fh->fdopen(*STDIN, 'r'); } else { $fh->open("LC_ALL=C git log --pretty --numstat --summary|") or die("Cannot execute git log...$!\n"); } while (my $_l = <$fh>) { #print STDERR "debug ($state, " . (@date ? (strftime "%Y-%m-%d", @date) : "") . "): `$_'\n"; if ($state == 0) { if ($_l =~ m,^Author: (.*),) { $author = $1; } if ($_l =~ m,^Date: (.*),) { @date = strptime($1); } $state = 1 if ($_l =~ m,^$, and $author and (@date+0>0)); } elsif ($state == 1) { # * modifying our input text is a bad choice # let's make a copy of it first, then we remove spaces # * if we meet a "merge branch" statement, we need to start # over and find a real entry # Luis Mondesi my $_s = $_l; $_s =~ s/^ //g; if ($_s =~ m/^Merge branch/) { $state=0; next; } $comment = $comment . $_s; $state = 2 if ($_l =~ m,^$,); } elsif ($state == 2) { if ($_l =~ m,^([0-9]+)\t([0-9]+)\t(.*)$,) { push @files, $3; } $done = 1 if ($_l =~ m,^$,); } if ($done) { print (strftime "%Y-%m-%d $author\n\n", @date); my $files = join (", ", @files); $files = mywrap ("\t", "\t", "* $files"), ": "; if (index($comment, EMPTY_LOG_MESSAGE) > -1 ) { $comment = "[no log message]\n"; } my $files_last_line_len = 0; $files_last_line_len = last_line_len($files) + 1; my $msg = wrap_log_entry($comment, "\t", 69-$files_last_line_len, 69); $msg =~ s/[ \t]+\n/\n/g; print "$files: $msg\n"; @date = (); $author = ""; @files = (); $comment = ""; $state = 0; $done = 0; } } if (@date + 0) { print (strftime "%Y-%m-%d $author\n\n", @date); my $msg = wrap_log_entry($comment, "\t", 69, 69); $msg =~ s/[ \t]+\n/\n/g; print "\t* $msg\n"; } adasockets-1.10.1/support/test-build.sh000077500000000000000000000003011277046543400200500ustar00rootroot00000000000000#! /bin/sh -e autoreconf -fvi rm -rf *.tar.gz ./configure make dist rm -rf _build mkdir _build cd _build tar zxvf ../*.tar.gz cd adasockets* mkdir _build cd _build ../configure make make check adasockets-1.10.1/support/texinfo.tex000066400000000000000000011670361277046543400176570ustar00rootroot00000000000000% 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{2013-02-01.11} % % Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, % 2007, 2008, 2009, 2010, 2011, 2012, 2013 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 . % % 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: % http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or % http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or % http://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 http://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} \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\ptexstar=\* \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 % Since the category of space is not known, we have to be careful. \chardef\spacecat = 10 \def\spaceisspace{\catcode`\ =\spacecat} % sometimes characters are active, so we need control sequences. \chardef\ampChar = `\& \chardef\colonChar = `\: \chardef\commaChar = `\, \chardef\dashChar = `\- \chardef\dotChar = `\. \chardef\exclamChar= `\! \chardef\hashChar = `\# \chardef\lquoteChar= `\` \chardef\questChar = `\? \chardef\rquoteChar= `\' \chardef\semiChar = `\; \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 } % Margin to add to right of even pages, to left of odd pages. \newdimen\bindingoffset \newdimen\normaloffset \newdimen\pagewidth \newdimen\pageheight % 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 } % 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} % Do @cropmarks to get crop marks. % \newif\ifcropmarks \let\cropmarks = \cropmarkstrue % % Dimensions to add cropmarks at corners. % Added by P. A. MacKay, 12 Nov. 1986 % \newdimen\outerhsize \newdimen\outervsize % set by the paper size routines \newdimen\cornerlong \cornerlong=1pc \newdimen\cornerthick \cornerthick=.3pt \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. The solution is % described on page 260 of The TeXbook. It involves outputting two % marks for the sectioning macros, one before the section break, and % one after. I won't pretend I can describe this better than DEK... \def\domark{% \toks0=\expandafter{\lastchapterdefs}% \toks2=\expandafter{\lastsectiondefs}% \toks4=\expandafter{\prevchapterdefs}% \toks6=\expandafter{\prevsectiondefs}% \toks8=\expandafter{\lastcolordefs}% \mark{% \the\toks0 \the\toks2 \noexpand\or \the\toks4 \the\toks6 \noexpand\else \the\toks8 }% } % \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\topmark\fi \ifx\thischapter\empty \ifcase0\firstmark\fi \fi } \def\getbottomheadingmarks{\ifcase1\botmark\fi} \def\getcolormarks{\ifcase2\topmark\fi} % Avoid "undefined control sequence" errors. \def\lastchapterdefs{} \def\lastsectiondefs{} \def\prevchapterdefs{} \def\prevsectiondefs{} \def\lastcolordefs{} % Main output routine. \chardef\PAGE = 255 \output = {\onepageout{\pagecontents\PAGE}} \newbox\headlinebox \newbox\footlinebox % \onepageout takes a vbox as an argument. Note that \pagecontents % does insertions, but you have to call it yourself. \def\onepageout#1{% \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi % \ifodd\pageno \advance\hoffset by \bindingoffset \else \advance\hoffset by -\bindingoffset\fi % % Do this outside of the \shipout so @code etc. will be expanded in % the headline as they should be, not taken literally (outputting ''code). \ifodd\pageno \getoddheadingmarks \else \getevenheadingmarks \fi \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% \ifodd\pageno \getoddfootingmarks \else \getevenfootingmarks \fi \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% % {% % 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. % \indexdummies % don't expand commands in the output. \normalturnoffactive % \ in index entries must not stay \, e.g., if % the page break happens to be in the middle of an example. % We don't want .vr (or whatever) entries like this: % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}} % "\acronym" won't work when it's read back in; % it needs to be % {\code {{\tt \backslashcurfont }acronym} \shipout\vbox{% % Do this early so pdf references go to the beginning of the page. \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi % \ifcropmarks \vbox to \outervsize\bgroup \hsize = \outerhsize \vskip-\topandbottommargin \vtop to0pt{% \line{\ewtop\hfil\ewtop}% \nointerlineskip \line{% \vbox{\moveleft\cornerthick\nstop}% \hfill \vbox{\moveright\cornerthick\nstop}% }% \vss}% \vskip\topandbottommargin \line\bgroup \hfil % center the page within the outer (page) hsize. \ifodd\pageno\hskip\bindingoffset\fi \vbox\bgroup \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 % \ifcropmarks \egroup % end of \vbox\bgroup \hfil\egroup % end of (centering) \line\bgroup \vskip\topandbottommargin plus1fill minus1fill \boxmaxdepth = \cornerthick \vbox to0pt{\vss \line{% \vbox{\moveleft\cornerthick\nsbot}% \hfill \vbox{\moveright\cornerthick\nsbot}% }% \nointerlineskip \line{\ewbot\hfil\ewbot}% }% \egroup % \vbox from first cropmarks clause \fi }% end of \shipout\vbox }% end of group with \indexdummies \advancepageno \ifnum\outputpenalty>-20000 \else\dosupereject\fi } \newinsert\margin \dimen\margin=\maxdimen \def\pagebody#1{\vbox to\pageheight{\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} } % Here are the rules for the cropmarks. Note that they are % offset so that the space between them is truly \outerhsize or \outervsize % (P. A. MacKay, 12 November, 1986) % \def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} \def\nstop{\vbox {\hrule height\cornerthick depth\cornerlong width\cornerthick}} \def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} \def\nsbot{\vbox {\hrule height\cornerlong depth\cornerthick width\cornerthick}} % 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. % \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. \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 `\^^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\foo{...} % is roughly equivalent to % \def\foo{\parsearg\Xfoo} % \def\Xfoo#1{...} % % Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my % favourite TeX trick. --kasal, 16nov03 \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. % \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 = \pageheight \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\pageheight \page \fi \fi \box\groupbox \prevdepth = \dimen1 \checkinserts } % % 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 } % @| inserts a changebar to the left of the current line. It should % surround any changed text. This approach does *not* work if the % change spans more than two lines of output. To handle that, we would % have adopt a much more difficult approach (putting marks into the main % vertical list for the beginning and end of each change). This command % is not documented, not supported, and doesn't work. % \def\|{% % \vadjust can only be used in horizontal mode. \leavevmode % % Append this vertical mode material after the current line in the output. \vadjust{% % We want to insert a rule with the height and depth of the current % leading; that is exactly what \strutbox is supposed to record. \vskip-\baselineskip % % \vadjust-items are inserted at the left edge of the type. So % the \llap here moves out into the left-hand margin. \llap{% % % For a thicker or thinner bar, change the `1pt'. \vrule height\baselineskip width1pt % % This is the space between the bar and the text. \hskip 12pt }% }% } % @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\comment{\begingroup \catcode`\^^M=\other% \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% \commentxxx} {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} % \let\c=\comment % @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 % 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 (before @setfilename). % \newif\iflinks \linkstrue % by default we want the aux files. \let\novalidate = \linksfalse % @setfilename is done at the beginning of every texinfo file. % So open here the files we need to have open while reading the input. % This makes it possible to make a .fmt file for texinfo. \def\setfilename{% \fixbackslash % Turn off hack to swallow `\input texinfo'. \iflinks \tryauxfile % Open the new aux file. TeX will close it automatically at exit. \immediate\openout\auxfile=\jobname.aux \fi % \openindices needs to do some work in any case. \openindices \let\setfilename=\comment % Ignore extra @setfilename cmds. % % If texinfo.cnf is present on the system, read it. % Useful for site-wide @afourpaper, etc. \openin 1 texinfo.cnf \ifeof 1 \else \input texinfo.cnf \fi \closein 1 % \comment % Ignore the actual filename. } % Called from \setfilename. % \def\openindices{% \newindex{cp}% \newcodeindex{fn}% \newcodeindex{vr}% \newcodeindex{tp}% \newcodeindex{ky}% \newcodeindex{pg}% } % @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 \newcount\countA \newif\ifpdf \newif\ifpdfmakepagedest % 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 % 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. \else % The expandable \pdfescapestring primitive escapes parentheses, % backslashes, and other special chars. \xdef#1{\pdfescapestring{#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 based on 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. \def\rgbDarkRed{0.50 0.09 0.12} \def\rgbBlack{0 0 0} % % k sets the color for filling (usual text, etc.); % K 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\lastcolordefs{\gdef\noexpand\thiscolor{#1}}% \domark \pdfsetcolor{#1}% } % \def\maincolor{\rgbBlack} \pdfsetcolor{\maincolor} \edef\thiscolor{\maincolor} \def\lastcolordefs{} % \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\pdfmkdest#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 \turnoffactive \makevalueexpandable \def\pdfdestname{#1}% \txiescapepdf\pdfdestname \safewhatsit{\pdfdest name{\pdfdestname} xyz}% }} % % used to mark target names; must be expandable. \def\pdfmkpgn#1{#1} % % by default, use a color that is dark enough to print on paper as % nearly black, but still distinguishable for online viewing. \def\urlcolor{\rgbDarkRed} \def\linkcolor{\rgbDarkRed} \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. \edef\pdfoutlinedest{#3}% \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}% \else \txiescapepdf\pdfoutlinedest \fi % % Also escape PDF chars in the display string. \edef\pdfoutlinetext{#1}% \txiescapepdf\pdfoutlinetext % \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#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} \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 \message{fonts,} % 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 ten#1\endcsname % change the current font } % Select #1 fonts with the current style. % \def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname} \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}} % Unfortunately, we have to override this for titles and the like, since % in those cases "rm" is bold. Sigh. \def\rmisbold{\rm\def\curfontstyle{bf}} % 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}} \let\li = \sf % Sometimes we call it \li, not \sf. % We don't need math for this font style. \def\ttsl{\setfontstyle{ttsl}} % 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\defttsl\ttslshape{10}{\magstep1}{OT1TT} \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\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 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\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 @acro 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\defttsl\ttslshape{10}{\magstephalf}{OT1TT} \def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\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 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 @acro 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 % 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 } % In order for the font changes to affect most math symbols and letters, % we have to define the \textfont of the standard families. Since % texinfo doesn't allow for producing subscripts and superscripts except % in the main text, we don't bother to reset \scriptfont and % \scriptscriptfont (which would also require loading a lot more fonts). % \def\resetmathfonts{% \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf \textfont\ttfam=\tentt \textfont\sffam=\tensf } % The font-changing commands redefine the meanings of \tenSTYLE, 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 % \tenSTYLE to set the current font. % % Each font-changing command also sets the names \lsize (one size lower) % and \lllsize (three sizes lower). These relative commands are used in % the LaTeX logo and acronyms. % % This all needs generalizing, badly. % \def\textfonts{% \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy \let\tenttsl=\textttsl \def\curfontsize{text}% \def\lsize{reduced}\def\lllsize{smaller}% \resetmathfonts \setleading{\textleading}} \def\titlefonts{% \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy \let\tenttsl=\titlettsl \def\curfontsize{title}% \def\lsize{chap}\def\lllsize{subsec}% \resetmathfonts \setleading{27pt}} \def\titlefont#1{{\titlefonts\rmisbold #1}} \def\chapfonts{% \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy \let\tenttsl=\chapttsl \def\curfontsize{chap}% \def\lsize{sec}\def\lllsize{text}% \resetmathfonts \setleading{19pt}} \def\secfonts{% \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy \let\tenttsl=\secttsl \def\curfontsize{sec}% \def\lsize{subsec}\def\lllsize{reduced}% \resetmathfonts \setleading{16pt}} \def\subsecfonts{% \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy \let\tenttsl=\ssecttsl \def\curfontsize{ssec}% \def\lsize{text}\def\lllsize{small}% \resetmathfonts \setleading{15pt}} \let\subsubsecfonts = \subsecfonts \def\reducedfonts{% \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy \let\tenttsl=\reducedttsl \def\curfontsize{reduced}% \def\lsize{small}\def\lllsize{smaller}% \resetmathfonts \setleading{10.5pt}} \def\smallfonts{% \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy \let\tenttsl=\smallttsl \def\curfontsize{small}% \def\lsize{smaller}\def\lllsize{smaller}% \resetmathfonts \setleading{10.5pt}} \def\smallerfonts{% \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy \let\tenttsl=\smallerttsl \def\curfontsize{smaller}% \def\lsize{smaller}\def\lllsize{smaller}% \resetmathfonts \setleading{9.5pt}} % 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} % 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 and the set of \ifmarkupSTYLE switches for all styles % currently in effect. \newif\ifmarkupvar \newif\ifmarkupsamp \newif\ifmarkupkey %\newif\ifmarkupfile % @file == @samp. %\newif\ifmarkupoption % @option == @samp. \newif\ifmarkupcode \newif\ifmarkupkbd %\newif\ifmarkupenv % @env == @code. %\newif\ifmarkupcommand % @command == @code. \newif\ifmarkuptex % @tex (and part of @math, for now). \newif\ifmarkupexample \newif\ifmarkupverb \newif\ifmarkupverbatim \let\currentmarkupstyle\empty \def\setupmarkupstyle#1{% \csname markup#1true\endcsname \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{% \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax '% \else \char'15 \fi \else \char'15 \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{% \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 } % 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\ptexslash \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\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@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 \rawbackslash \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 % \rawbackslash \plainfrenchspacing #1% }% \null % reset spacefactor to 1000 } % We *must* turn on hyphenation at `-' and `_' in @code. % 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 \codex } } \def\codex #1{\tclose{#1}\endgroup} \def\normaldash{-} \def\codedash{-\discretionary{}{}{}} \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') 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. % (This \urefnobreak definition isn't used now, leaving it for a while % for comparison.) \def\urefnobreak#1{\dourefnobreak #1,,,\finish} \def\dourefnobreak#1,#2,#3,#4\finish{\begingroup \unsepspaces \pdfurl{#1}% \setbox0 = \hbox{\ignorespaces #3}% \ifdim\wd0 > 0pt \unhbox0 % third arg given, show only that \else \setbox0 = \hbox{\ignorespaces #2}% \ifdim\wd0 > 0pt \ifpdf \unhbox0 % PDF: 2nd arg given, show only it \else \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url \fi \else \code{#1}% only url given, so show it \fi \fi \endlink \endgroup} % This \urefbreak definition is the active one. \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}% \ifdim\wd0 > 0pt \ifpdf \unhbox0 % PDF: 2nd arg given, show only it \else \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url \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\ampChar=\active \catcode\dotChar=\active \catcode\hashChar=\active \catcode\questChar=\active \catcode\slashChar=\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} } % we put a little stretch before and after the breakable chars, to help % line breaking of long url's. The unequal skips make look better in % cmtt at least, especially for dots. \def\urefprestretch{\urefprebreak \hskip0pt plus.13em } \def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em } % \def\urefcodeamp{\urefprestretch \&\urefpoststretch} \def\urefcodedot{\urefprestretch .\urefpoststretch} \def\urefcodehash{\urefprestretch \#\urefpoststretch} \def\urefcodequest{\urefprestretch ?\urefpoststretch} \def\urefcodeslash{\futurelet\next\urefcodeslashfinish} { \catcode`\/=\active \global\def\urefcodeslashfinish{% \urefprestretch \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 \urefpoststretch \fi } } % One more complication: 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{\allowbreak}\def\urefpostbreak{\nobreak} \else\ifx\txiarg\wordafter \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak} \else \errhelp = \EMsimple \errmessage{Unknown @urefbreakstyle setting `\txiarg'}% \fi\fi\fi } \def\wordafter{after} \def\wordbefore{before} \def\wordnone{none} \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} \ifpdf \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} % @l was never documented to mean ``switch to the Lisp font'', % and it is not used as such in any manual I can find. We need it for % Polish suppressed-l. --karl, 22sep96. %\def\l#1{{\li #1}\null} % @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{% {\selectfonts\lsize #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{% \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 $\finishmath } \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 } } % ctrl is no longer a Texinfo command, but leave this definition for fun. \def\ctrl #1{{\tt \rawbackslash \hat}#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 } % 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. } \message{glyphs,} % and logos. % @@ prints an @, as does @atchar{}. \def\@{\char64 } \let\atchar=\@ % @{ @} @lbracechar{} @rbracechar{} all generate brace characters. % Unless we're in typewriter, use \ecfont because the CM text fonts do % not have braces, and we don't want to switch into math. \def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}} \def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}} \let\{=\mylbrace \let\lbracechar=\{ \let\}=\myrbrace \let\rbracechar=\} \begingroup % Definitions to produce \{ and \} commands for indices, % and @{ and @} for the aux/toc files. \catcode`\{ = \other \catcode`\} = \other \catcode`\[ = 1 \catcode`\] = 2 \catcode`\! = 0 \catcode`\\ = \other !gdef!lbracecmd[\{]% !gdef!rbracecmd[\}]% !gdef!lbraceatcmd[@{]% !gdef!rbraceatcmd[@}]% !endgroup % @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{\selectfonts\lllsize \underbar{a}}} \def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \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. \selectfonts\lllsize A% \fi }% \vss }}% \kern-.15em \TeX } % Some math mode symbols. \def\bullet{$\ptexbullet$} \def\geq{\ifmmode \ge\else $\ge$\fi} \def\leq{\ifmmode \le\else $\le$\fi} \def\minus{\ifmmode -\else $-$\fi} % @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 % {\tentt \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 ec* fonts (cm-super in outline format) for non-CM glyphs. \def\ecfont{% % 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 = ectt\ecsize \space at \nominalsize \else \ifx\curfontstyle\bfstylename % bold: \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize \else % regular: \font\thisecfont = ec\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{\selectfonts\lllsize 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 % Do an implicit @contents or @shortcontents after @end titlepage if the % user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. % \newif\ifsetcontentsaftertitlepage \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue \newif\ifsetshortcontentsaftertitlepage \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue \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 % % If they want short, they certainly want long too. \ifsetshortcontentsaftertitlepage \shortcontents \contents \global\let\shortcontents = \relax \global\let\contents = \relax \fi % \ifsetcontentsaftertitlepage \contents \global\let\contents = \relax \global\let\shortcontents = \relax \fi } \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. Because % it is always used for titles, nothing else, we call \rmisbold. \par % should be specified before the end of the \vbox, since a vbox is a group. % \def\raggedtitlesettings{% \rmisbold \hyphenpenalty=10000 \parindent=0pt \tolerance=5000 \ptexraggedright } % Macros to be used within @titlepage: \let\subtitlerm=\tenrm \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\rmisbold \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 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\pageheight 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 \def\evenheadingmarks{\headingmarks{even}{heading}} \def\oddheadingmarks{\headingmarks{odd}{heading}} \def\evenfootingmarks{\headingmarks{even}{footing}} \def\oddfootingmarks{\headingmarks{odd}{footing}} \def\everyheadingmarks#1 {\headingmarks{even}{heading}{#1} \headingmarks{odd}{heading}{#1} } \def\everyfootingmarks#1 {\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. \def\headings #1 {\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{\thischapter\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{\thischapter\hfil\folio}} \global\oddheadline={\line{\thischapter\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{\thischapter\hfil\folio}} \global\let\contentsalignmacro = \chapoddpage } \def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} \def\HEADINGSsinglex{% \global\evenfootline={\hfil} \global\oddfootline={\hfil} \global\evenheadline={\line{\thischapter\hfil\folio}} \global\oddheadline={\line{\thischapter\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 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}% % \vadjust{\penalty 1200}}% not good to break after first line of item. \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 . % \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 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 \global\everytab={\bf}% can't use \headitemfont since the parsing differs \the\everytab % for the first item }% % % 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={}% \global\colcount=0 % Reset the column counter. % Check for saved footnotes, etc. \checkinserts % Keeps underfull box messages off when table breaks over pages. %\filbreak % Maybe so, but it also creates really weird page breaks when the % table breaks over pages. Wouldn't \vfil be better? Wait until the % problem manifests itself, so it can be fixed for real --karl. }% }% % \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 } } % We have this subroutine so that we can handle at least some @value's % properly in indexes (we call \makevalueexpandable in \indexdummies). % The command has to be fully expandable (if the variable is set), since % the result winds up in the index file. This means that if the % variable's value contains other Texinfo commands, it's almost certain % it will fail (although perhaps we could fix that with sufficient work % to do a one-level expansion on the result, instead of complete). % \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 } % @ifset VAR ... @end ifset reads the `...' iff VAR has been defined % with @set. % % To get special treatment of `@end ifset,' call \makeond and the 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 foo. % It automatically defines \fooindex such that % \fooindex ...rest of line... puts an entry in the index foo. % It also defines \fooindfile to be the number of the output channel for % the file that accumulates this index. The file's extension is foo. % The name of an index should be no more than 2 characters long % for the sake of vms. % \def\newindex#1{% \iflinks \expandafter\newwrite \csname#1indfile\endcsname \openout \csname#1indfile\endcsname \jobname.#1 % Open the file \fi \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{% \iflinks \expandafter\newwrite \csname#1indfile\endcsname \openout \csname#1indfile\endcsname \jobname.#1 \fi \expandafter\xdef\csname#1index\endcsname{% \noexpand\docodeindex{#1}}% } % @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{% % Only do \closeout if we haven't already done it, else we'll end up % closing the target index. \expandafter \ifx\csname donesynindex#2\endcsname \relax % The \closeout helps reduce unnecessary open files; the limit on the % Acorn RISC OS is a mere 16 files. \expandafter\closeout\csname#2indfile\endcsname \expandafter\let\csname donesynindex#2\endcsname = 1 \fi % 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 \fooindex macros. % Argument #1 is generated by the calling \fooindex macro, % and it is "foo", the name of the index. % \doindex just uses \parsearg; it calls \doind for the actual work. % This is because \doind is more useful to call from other macros. % There is also \dosubind {index}{topic}{subtopic} % which makes an entry in a two-level index such as the operation index. \def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} \def\singleindexer #1{\doind{\indexname}{#1}} % like the previous two, but they put @code around the argument. \def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} \def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} % Take care of Texinfo commands that can appear in an index entry. % Since there are some commands we want to expand, and others we don't, % we have to laboriously prevent expansion for those that we don't. % \def\indexdummies{% \escapechar = `\\ % use backslash in output files. \def\@{@}% change to @@ when we switch to @ as escape char in index files. \def\ {\realbackslash\space }% % % Need these unexpandable (because we define \tt as a dummy) % definitions when @{ or @} appear in index entry text. Also, more % complicated, when \tex is in effect and \{ is a \delimiter again. % We can't use \lbracecmd and \rbracecmd because texindex assumes % braces and backslashes are used only as delimiters. Perhaps we % should define @lbrace and @rbrace commands a la @comma. \def\{{{\tt\char123}}% \def\}{{\tt\char125}}% % % I don't entirely understand this, but when an index entry is % generated from a macro call, the \endinput which \scanmacro inserts % causes processing to be prematurely terminated. This is, % apparently, because \indexsorttmp is fully expanded, and \endinput % is an expandable command. The redefinition below makes \endinput % disappear altogether for that purpose -- although logging shows that % processing continues to some further point. On the other hand, it % seems \endinput does not hurt in the printed index arg, since that % is still getting written without apparent harm. % % Sample source (mac-idx3.tex, reported by Graham Percival to % help-texinfo, 22may06): % @macro funindex {WORD} % @findex xyz % @end macro % ... % @funindex commtest % % The above is not enough to reproduce the bug, but it gives the flavor. % % Sample whatsit resulting: % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}} % % So: \let\endinput = \empty % % Do the redefinitions. \commondummies } % For the aux and toc files, @ is the escape character. So we want to % redefine everything using @ as the escape character (instead of % \realbackslash, still used for index files). When everything uses @, % this will be simpler. % \def\atdummies{% \def\@{@@}% \def\ {@ }% \let\{ = \lbraceatcmd \let\} = \rbraceatcmd % % Do the redefinitions. \commondummies \otherbackslash } % Called from \indexdummies and \atdummies. % \def\commondummies{% % % \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. % % For control letters, we have \definedummyletter, which omits the % space. % % 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). % \def\definedummyword ##1{\def##1{\string##1\space}}% \def\definedummyletter##1{\def##1{\string##1}}% \let\definedummyaccent\definedummyletter % \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\arrow \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\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\textdegree % % We want to disable all macros so that they are not expanded by \write. \macrolist % \normalturnoffactive % % Handle some cases of @value -- where it does not contain any % (non-fully-expandable) commands. \makevalueexpandable } % \commondummiesnofonts: common to \commondummies and \indexnofonts. % \def\commondummiesnofonts{% % Control letters and accents. \definedummyletter\!% \definedummyaccent\"% \definedummyaccent\'% \definedummyletter\*% \definedummyaccent\,% \definedummyletter\.% \definedummyletter\/% \definedummyletter\:% \definedummyaccent\=% \definedummyletter\?% \definedummyaccent\^% \definedummyaccent\`% \definedummyaccent\~% \definedummyword\u \definedummyword\v \definedummyword\H \definedummyword\dotaccent \definedummyword\ogonek \definedummyword\ringaccent \definedummyword\tieaccent \definedummyword\ubaraccent \definedummyword\udotaccent \definedummyword\dotless % % Texinfo font commands. \definedummyword\b \definedummyword\i \definedummyword\r \definedummyword\sansserif \definedummyword\sc \definedummyword\slanted \definedummyword\t % % Commands that take arguments. \definedummyword\abbr \definedummyword\acronym \definedummyword\anchor \definedummyword\cite \definedummyword\code \definedummyword\command \definedummyword\dfn \definedummyword\dmn \definedummyword\email \definedummyword\emph \definedummyword\env \definedummyword\file \definedummyword\image \definedummyword\indicateurl \definedummyword\inforef \definedummyword\kbd \definedummyword\key \definedummyword\math \definedummyword\option \definedummyword\pxref \definedummyword\ref \definedummyword\samp \definedummyword\strong \definedummyword\tie \definedummyword\uref \definedummyword\url \definedummyword\var \definedummyword\verb \definedummyword\w \definedummyword\xref } % \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\definedummyaccent##1{\let##1\asis}% % We can just ignore other control letters. \def\definedummyletter##1{\let##1\empty}% % All control words become @asis by default; overrides below. \let\definedummyword\definedummyaccent % \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 % % Unfortunately, texindex is not prepared to handle braces in the % content at all. So for index sorting, we map @{ and @} to strings % starting with |, since that ASCII character is between ASCII { and }. \def\{{|a}% \def\lbracechar{|a}% % \def\}{|b}% \def\rbracechar{|b}% % % Non-English letters. \def\AA{AA}% \def\AE{AE}% \def\DH{DZZ}% \def\L{L}% \def\OE{OE}% \def\O{O}% \def\TH{ZZZ}% \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{zzz}% % \def\LaTeX{LaTeX}% \def\TeX{TeX}% % % Assorted special characters. % (The following {} will end up in the sort string, but that's ok.) \def\arrow{->}% \def\bullet{bullet}% \def\comma{,}% \def\copyright{copyright}% \def\dots{...}% \def\enddots{...}% \def\equiv{==}% \def\error{error}% \def\euro{euro}% \def\expansion{==>}% \def\geq{>=}% \def\guillemetleft{<<}% \def\guillemetright{>>}% \def\guilsinglleft{<}% \def\guilsinglright{>}% \def\leq{<=}% \def\minus{-}% \def\point{.}% \def\pounds{pounds}% \def\print{-|}% \def\quotedblbase{"}% \def\quotedblleft{"}% \def\quotedblright{"}% \def\quoteleft{`}% \def\quoteright{'}% \def\quotesinglbase{,}% \def\registeredsymbol{R}% \def\result{=>}% \def\textdegree{o}% % \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax \else \indexlquoteignore \fi % % 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 } % Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us % ignore left quotes in the sort term. {\catcode`\`=\active \gdef\indexlquoteignore{\let`=\empty}} \let\indexbackslash=0 %overridden during \printindex. \let\SETmarginindex=\relax % put index entries in margin (undocumented)? % Most index entries go through here, but \dosubind is the general case. % #1 is the index name, #2 is the entry text. \def\doind#1#2{\dosubind{#1}{#2}{}} % Workhorse for all \fooindexes. % #1 is name of index, #2 is stuff to put there, #3 is subentry -- % empty if called from \doind, as we usually are (the main exception % is with most defuns, which call us directly). % \def\dosubind#1#2#3{% \iflinks {% % Store the main index entry text (including the third arg). \toks0 = {#2}% % If third arg is present, precede it with a space. \def\thirdarg{#3}% \ifx\thirdarg\empty \else \toks0 = \expandafter{\the\toks0 \space #3}% \fi % \edef\writeto{\csname#1indfile\endcsname}% % \safewhatsit\dosubindwrite }% \fi } % Write the entry in \toks0 to the index file: % \def\dosubindwrite{% % Put the index entry in the margin if desired. \ifx\SETmarginindex\relax\else \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}% \fi % % Remember, we are within a group. \indexdummies % Must do this here, since \bf, etc expand at this stage \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now % so it will be output as is; and it will print as backslash. % % Process the index entry with all font commands turned off, to % get the string to sort by. {\indexnofonts \edef\temp{\the\toks0}% need full expansion \xdef\indexsorttmp{\temp}% }% % % 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{\indexsorttmp}{\noexpand\folio}{\the\toks0}}% }% \temp } % 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} % for the beginning of a topic that is used with subtopics % \secondary {subtopic}{pagelist} % for each 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} \def\cindexsub {\begingroup\obeylines\cindexsub} {\obeylines % \gdef\cindexsub "#1" #2^^M{\endgroup % \dosubind{cp}{#2}{#1}}} % 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 if the index file exists and is nonempty. % Change catcode of @ here so that if the index file contains % \initial {@} % as its first line, TeX doesn't complain about mismatched braces % (because it thinks @} is a control sequence). \catcode`\@ = 11 \openin 1 \jobname.#1s \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 \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 \temp \ifeof 1 \putwordIndexIsEmpty \else % Index files are almost Texinfo source, but we use \ as the escape % character. It would be better to use @, but that's too big a change % to make right now. \def\indexbackslash{\backslashcurfont}% \catcode`\\ = 0 \escapechar = `\\ \begindoublecolumns \input \jobname.#1s \enddoublecolumns \fi \fi \closein 1 \endgroup} % These macros are used by the sorted index file itself. % Change them to control the appearance of the index. \def\initial#1{{% % Some minor font changes for the special characters. \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt % % Remove any glue we may have, we'll be inserting our own. \removelastskip % % We like breaks before the index initials, so insert a bonus. \nobreak \vskip 0pt plus 3\baselineskip \penalty 0 \vskip 0pt plus -3\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 .5\baselineskip \leftline{\secbf #1}% % Do our best not to break after the initial. \nobreak \vskip .33\baselineskip plus .1\baselineskip }} % \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. % % A straightforward implementation would start like this: % \def\entry#1#2{... % But this freezes the catcodes in the argument, and can cause problems to % @code, which sets - active. This problem was fixed by a kludge--- % ``-'' was active throughout whole index, but this isn't really right. % The right solution is to prevent \entry from swallowing the whole text. % --kasal, 21nov03 \def\entry{% \begingroup % % Start a new paragraph if necessary, so our assignments below can't % affect previous text. \par % % Do not fill out the last line with white space. \parfillskip = 0in % % No extra space above this paragraph. \parskip = 0in % % Do not prefer a separate line ending with a hyphen to fewer lines. \finalhyphendemerits = 0 % % \hangindent is only relevant when the entry text and page number % don't both fit on one line. In that case, bob suggests starting the % dots pretty far over on the line. Unfortunately, a large % indentation looks wrong when the entry text itself is broken across % lines. So we use a small indentation and put up with long leaders. % % \hangafter is reset to 1 (which is the value we want) at the start % of each paragraph, so we need not do anything with that. \hangindent = 2em % % When the entry text needs to be broken, just fill out the first line % with blank space. \rightskip = 0pt plus1fil % % A bit of stretch before each entry for the benefit of balancing % columns. \vskip 0pt plus1pt % % 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}% % % Swallow the left brace of the text (first parameter): \afterassignment\doentry \let\temp = } \def\entrybreak{\unskip\space\ignorespaces}% \def\doentry{% \bgroup % Instead of the swallowed brace. \noindent \aftergroup\finishentry % And now comes the text of the entry. } \def\finishentry#1{% % #1 is the page number. % % The following is kludged to not output a line of dots in the index if % there are no page numbers. The next person who breaks this will be % cursed by a Unix daemon. \setbox\boxA = \hbox{#1}% \ifdim\wd\boxA = 0pt \ % \else % % If we must, put the page number on a line of its own, and fill out % this line with blank space. (The \hfil is overwhelmed with the % fill leaders glue in \indexdotfill if the page number does fit.) \hfil\penalty50 \null\nobreak\indexdotfill % Have leaders before the page number. % % The `\ ' here is removed by the implicit \unskip that TeX does as % part of (the primitive) \par. Without it, a spurious underfull % \hbox ensues. \ifpdf \pdfgettoks#1.% \ \the\toksA \else \ #1% \fi \fi \par \endgroup } % Like plain.tex's \dotfill, except uses up at least 1 em. \def\indexdotfill{\cleaders \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill} \def\primary #1{\line{#1\hfil}} \newskip\secondaryindent \secondaryindent=0.5cm \def\secondary#1#2{{% \parfillskip=0in \parskip=0in \hangindent=1in \hangafter=1 \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill \ifpdf \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. \else #2 \fi \par }} % 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 \newbox\partialpage \newdimen\doublecolumnhsize \def\begindoublecolumns{\begingroup % ended by \enddoublecolumns % Grab any single-column material above us. \output = {% % % Here is a possibility not foreseen in manmac: if we accumulate a % whole lot of material, we might end up calling this \output % routine twice in a row (see the doublecol-lose test, which is % essentially a couple of indexes with @setchapternewpage off). In % that case we just ship out what is in \partialpage with the normal % output routine. Generally, \partialpage will be empty when this % runs and this will be a no-op. See the indexspread.tex test case. \ifvoid\partialpage \else \onepageout{\pagecontents\partialpage}% \fi % \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 % % Double the \vsize as well. (We don't need a separate register here, % since nobody clobbers \vsize.) \vsize = 2\vsize } % The double-column output routine for all double-column pages except % the last. % \def\doublecolumnout{% \splittopskip=\topskip \splitmaxdepth=\maxdepth % Get the available space for the double columns -- the normal % (undoubled) page height minus any material left over from the % previous page. \dimen@ = \vsize \divide\dimen@ by 2 \advance\dimen@ by -\ht\partialpage % % box0 will be the left-hand column, box2 the right. \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ \onepageout\pagesofar \unvbox255 \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\pagewidth{\box0\hfil\box2}% } % % All done 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 \pageheight (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. Leave it on the % current page, no automatic page break. \balancecolumns % % If we end up splitting too much material for the current page, % though, there will be another page break right after this \output % invocation ends. Having called \balancecolumns once, we do not % want to call it again. Therefore, reset \output to its normal % definition right away. (We hope \balancecolumns will never be % called on to balance too much material, but if it is, this makes % the output somewhat more palatable.) \global\output = {\onepageout{\pagecontents\PAGE}}% }% \eject \endgroup % started in \begindoublecolumns % % \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 (after the % \endgroup where \vsize got restored). \pagegoal = \vsize } % % Called at the end of the double column material. \def\balancecolumns{% \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. \dimen@ = \ht0 \advance\dimen@ by \topskip \advance\dimen@ by-\baselineskip \divide\dimen@ by 2 % target to split to %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% \splittopskip = \topskip % Loop until we get a decent breakpoint. {% \vbadness = 10000 \loop \global\setbox3 = \copy0 \global\setbox1 = \vsplit3 to \dimen@ \ifdim\ht3>\dimen@ \global\advance\dimen@ by 1pt \repeat }% %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% \setbox0=\vbox to\dimen@{\unvbox1}% \setbox2=\vbox to\dimen@{\unvbox3}% % \pagesofar } \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\rmisbold #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 \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} \let\up=\raisesections % original BFox name % @lowersections: treat @chapter as section, @section as subsection, etc. \def\lowersections{\global\advance\secbase by 1} \let\down=\lowersections % original BFox name % 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 to achieve this: TeX expands \the only once, % simply yielding the contents of . (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{% % Well, we could do the following in a group, but that would break % an assumption that \chapmacro is called at the outermost level. % Thus we are safer this way: --kasal, 24feb04 \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}} \def\chappager{\par\vfill\supereject} % 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 } \def\setchapternewpage #1 {\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 % Chapter opening. % % #1 is the text, #2 is the section type (Ynumbered, Ynothing, % Yappendix, Yomitfromtoc), #3 the chapter number. % % To test against our argument. \def\Ynothingkeyword{Ynothing} \def\Yomitfromtockeyword{Yomitfromtoc} \def\Yappendixkeyword{Yappendix} % \def\chapmacro#1#2#3{% % Insert the first mark before the heading break (see notes for \domark). \let\prevchapterdefs=\lastchapterdefs \let\prevsectiondefs=\lastsectiondefs \gdef\lastsectiondefs{\gdef\thissectionname{}\gdef\thissectionnum{}% \gdef\thissection{}}% % \def\temptype{#2}% \ifx\temptype\Ynothingkeyword \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}% \gdef\thischapter{\thischaptername}}% \else\ifx\temptype\Yomitfromtockeyword \gdef\lastchapterdefs{\gdef\thischaptername{#1}\gdef\thischapternum{}% \gdef\thischapter{}}% \else\ifx\temptype\Yappendixkeyword \toks0={#1}% \xdef\lastchapterdefs{% \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\lastchapterdefs{% \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=\lastchapterdefs \let\prevsectiondefs=\lastsectiondefs \domark % {% \chapfonts \rmisbold % % Have to define \lastsection 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\lastsection{#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 } % I don't think this chapter style is supported any more, so I'm not % updating it with the new noderef stuff. We'll see. --karl, 11aug03. % \def\setchapterstyle #1 {\csname CHAPF#1\endcsname} % \def\unnchfopen #1{% \chapoddpage \vbox{\chapfonts \raggedtitlesettings #1\par}% \nobreak\bigskip\nobreak } \def\chfopen #1#2{\chapoddpage {\chapfonts \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% \par\penalty 5000 % } \def\centerchfopen #1{% \chapoddpage \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}% \nobreak\bigskip \nobreak } \def\CHAPFopen{% \global\let\chapmacro=\chfopen \global\let\centerchapmacro=\centerchfopen} % 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, #2 is the section level (sec/subsec/subsubsec), #3 is % the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the % section number. % \def\seckeyword{sec} % \def\sectionheading#1#2#3#4{% {% \checkenv{}% should not be in an environment. % % Switch to the right set of fonts. \csname #2fonts\endcsname \rmisbold % \def\sectionlevel{#2}% \def\temptype{#3}% % % Insert first mark before the heading break (see notes for \domark). \let\prevsectiondefs=\lastsectiondefs \ifx\temptype\Ynothingkeyword \ifx\sectionlevel\seckeyword \gdef\lastsectiondefs{\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\lastsectiondefs{% \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\lastsectiondefs{% \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. \let\prevsectiondefs=\lastsectiondefs \domark % % Only insert the space after the number if we have a section number. \ifx\temptype\Ynothingkeyword \setbox0 = \hbox{}% \def\toctype{unn}% \gdef\lastsection{#1}% \else\ifx\temptype\Yomitfromtockeyword % for @headings -- no section number, don't include in toc, % and don't redefine \lastsection. \setbox0 = \hbox{}% \def\toctype{omit}% \let\sectionlevel=\empty \else\ifx\temptype\Yappendixkeyword \setbox0 = \hbox{#4\enspace}% \def\toctype{app}% \gdef\lastsection{#1}% \else \setbox0 = \hbox{#4\enspace}% \def\toctype{num}% \gdef\lastsection{#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'. \ifpdf \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 \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. \advance\hsize by -\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{\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}\labelspace#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 \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 \escapechar=`\\ % % ' 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 % \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\*=\ptexstar \let\t=\ptext \expandafter \let\csname top\endcsname=\ptextop % 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 % 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 }} \let\afterenvbreak = \aboveenvbreak % \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. \font\circle=lcircle10 \newdimen\circthick \newdimen\cartouter\newdimen\cartinner \newskip\normbskip\newskip\normpskip\newskip\normlskip \circthick=\fontdimen8\circle % \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 \envdef\cartouche{% \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 % Flag to tell @lisp, etc., not to narrow margin. \let\nonarrowing = t% % % 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 % \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 \checkinserts } % This macro is called at the beginning of all the @example variants, % inside a group. \newdimen\nonfillparindent \def\nonfillstart{% \aboveenvbreak \hfuzz = 12pt % 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 plus2em \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{...} % If we want to allow any 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 \starttabox 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'{'#1'}'{#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}% \input #1 \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 very 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 % % 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 } % 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{% % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}. \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 \tenrm % \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} } \newcount\parencount % If we encounter &foo, then turn on ()-hacking afterwards \newif\ifampseen \def\amprm#1 {\ampseentrue{\bf\ }} \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 \def\scanmacro#1{\begingroup \newlinechar`\^^M \let\xeatspaces\eatspaces % % Undo catcode changes of \startcontents and \doprintindex % When called from @insertcopying or (short)caption, we need active % backslash to get it printed correctly. Previously, we had % \catcode`\\=\other instead. We'll see whether a problem appears % with macro expansion. --kasal, 19aug04 \catcode`\@=0 \catcode`\\=\active \escapechar=`\@ % % ... and for \example: \spaceisspace % % The \empty here causes a following catcode 5 newline to be eaten as % part of reading whitespace after a control sequence. It does not % eat a catcode 13 newline. There's no good way to handle the two % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX % would then have different behavior). See the Macro Details node in % the manual for the workaround we recommend for macros and % line-oriented commands. % \scantokens{#1\empty}% \endgroup} \def\scanexp#1{% \edef\temp{\noexpand\scanmacro{#1}}% \temp } \newcount\paramno % Count of parameters \newtoks\macname % Macro name \newif\ifrecursive % Is it recursive? % List of all defined macros in the form % \definedummyword\macro1\definedummyword\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\definedummyword#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 \catcode`\~=\other \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi } \def\scanargctxt{% used for copying and captions, not macros. \scanctxt \catcode`\\=\other \catcode`\^^M=\other } \def\macrobodyctxt{% used for @macro definitions \scanctxt \catcode`\{=\other \catcode`\}=\other \catcode`\^^M=\other \usembodybackslash } \def\macroargctxt{% used when scanning invocations \scanctxt \catcode`\\=0 } % why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes" % for the single characters \ { }. Thus, we end up with the "commands" % that would be written @\ @{ @} in a Texinfo document. % % We already have @{ and @}. For @\, we define it here, and only for % this purpose, to produce a typewriter backslash (so, the @\ that we % define for @math can't be used with @macro calls): % \def\\{\normalbackslash}% % % We would like to do this for \, too, since that is what makeinfo does. % But it is not possible, because Texinfo already has a command @, for a % cedilla accent. Documents must use @comma{} instead. % % \anythingelse will almost certainly be an error of some kind. % \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\definedummyword\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\definedummyword \noexpand#1% \fi } % This makes use of the obscure feature that if the last token of a % is #, then the preceding argument is delimited by % an opening brace, and that opening brace is not consumed. \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}} % For macro processing make @ a letter so that we can make Texinfo private macro names. \edef\texiatcatcode{\the\catcode`\@} \catcode `@=11\relax % Parse the optional {params} list. Set up \paramno and \paramlist % so \defmacro knows what to do. Define \macarg.BLAH for each BLAH % in the params list to some hook where the argument si 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). % % We need to get `macro parameter char #' into several definitions. % The technique used is stolen from LaTeX: let \hash be something % unexpandable, insert that wherever you need a #, and then redefine % it to # just before using the token list produced. % % The same technique is used to protect \eatspaces till just before % the macro is used. % % 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 underwhich the body was input). % % If you compile with TeX (not eTeX), and you have macros with 10 or more % arguments, you need that no macro has more than 256 arguments, otherwise an % error is produced. \def\parsemargdef#1;{% \paramno=0\def\paramlist{}% \let\hash\relax \let\xeatspaces\relax \parsemargdefxxx#1,;,% % 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. \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} \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} % These two commands read recursive and nonrecursive macro bodies. % (They're different since rec and nonrec macros end differently.) % \catcode `\@\texiatcatcode \long\def\parsemacbody#1@end macro% {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% \long\def\parsermacbody#1@end rmacro% {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% \catcode `\@=11\relax \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}% } \def\macargexpandinbody@{% %% Define the named-macro outside of this group and then close this group. \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 } % Save the token stack pointer into macro #1 \def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}} % Restore the token stack pointer from number in macro #1 \def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax} % newtoks that can be used non \outer . \def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi} % Tailing 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}% } % This defines a Texinfo @macro. There are eight cases: recursive and % nonrecursive macros of zero, one, up to nine, and many arguments. % Much magic with \expandafter here. % \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 \ifrecursive \ifcase\paramno % 0 \expandafter\xdef\csname\the\macname\endcsname{% \noexpand\scanmacro{\temp}}% \or % 1 \expandafter\xdef\csname\the\macname\endcsname{% \bgroup\noexpand\macroargctxt \noexpand\braceorline \expandafter\noexpand\csname\the\macname xxx\endcsname}% \expandafter\xdef\csname\the\macname xxx\endcsname##1{% \egroup\noexpand\scanmacro{\temp}}% \else \ifnum\paramno<10\relax % at most 9 \expandafter\xdef\csname\the\macname\endcsname{% \bgroup\noexpand\macroargctxt \noexpand\csname\the\macname xx\endcsname}% \expandafter\xdef\csname\the\macname xx\endcsname##1{% \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% \expandafter\expandafter \expandafter\xdef \expandafter\expandafter \csname\the\macname xxx\endcsname \paramlist{\egroup\noexpand\scanmacro{\temp}}% \else % 10 or more \expandafter\xdef\csname\the\macname\endcsname{% \noexpand\getargvals@{\the\macname}{\argl}% }% \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble \fi \fi \else \ifcase\paramno % 0 \expandafter\xdef\csname\the\macname\endcsname{% \noexpand\norecurse{\the\macname}% \noexpand\scanmacro{\temp}\egroup}% \or % 1 \expandafter\xdef\csname\the\macname\endcsname{% \bgroup\noexpand\macroargctxt \noexpand\braceorline \expandafter\noexpand\csname\the\macname xxx\endcsname}% \expandafter\xdef\csname\the\macname xxx\endcsname##1{% \egroup \noexpand\norecurse{\the\macname}% \noexpand\scanmacro{\temp}\egroup}% \else % at most 9 \ifnum\paramno<10\relax \expandafter\xdef\csname\the\macname\endcsname{% \bgroup\noexpand\macroargctxt \expandafter\noexpand\csname\the\macname xx\endcsname}% \expandafter\xdef\csname\the\macname xx\endcsname##1{% \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% \expandafter\expandafter \expandafter\xdef \expandafter\expandafter \csname\the\macname xxx\endcsname \paramlist{% \egroup \noexpand\norecurse{\the\macname}% \noexpand\scanmacro{\temp}\egroup}% \else % 10 or more: \expandafter\xdef\csname\the\macname\endcsname{% \noexpand\getargvals@{\the\macname}{\argl}% }% \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse \fi \fi \fi} \catcode `\@\texiatcatcode\relax \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} % \braceorline decides whether the next nonwhitespace character is a % {. If so it reads up to the closing }, if not, it reads the whole % line. Whatever was read is then fed to the next control sequence % as an argument (by \parsebrace or \parsearg). % \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx} \def\braceorlinexxx{% \ifx\nchar\bgroup\else \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}} \let\nwnode=\node \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 \lastsection, % 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 {% \atdummies % preserve commands, but don't expand them \edef\writexrdef##1##2{% \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef ##1}{##2}}% these are parameters of \writexrdef }% \toks0 = \expandafter{\lastsection}% \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#1{\putwordsee{} \xrefX[#1,,,,,,,]} \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} \def\ref#1{\xrefX[#1,,,,,,,]} % \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 {\indexnofonts \turnoffactive \makevalueexpandable % 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. \edef\pdfxrefdest{#1}% \ifx\pdfxrefdest\empty \def\pdfxrefdest{Top}% no empty targets \else \txiescapepdf\pdfxrefdest % escape PDF special chars \fi % \leavevmode \startlink attr{/Border [0 0 0]}% \ifnum\filenamelength>0 goto file{\the\filename.pdf} name{\pdfxrefdest}% \else goto name{\pdfmkpgn{\pdfxrefdest}}% \fi }% \setcolor{\linkcolor}% \fi % % Float references are printed completely differently: "Figure 1.2" % instead of "[somenode], p.3". We distinguish them by the % LABEL-title being set to a magic string. {% % Have to otherify everything special to allow the \csname to % include an _ in the xref name, etc. \indexnofonts \turnoffactive \expandafter\global\expandafter\let\expandafter\Xthisreftitle \csname XR#1-title\endcsname }% \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. % % _ (for example) has to be the character _ for the purposes of the % control sequence corresponding to the node, but it has to expand % into the usual \leavevmode...\vrule stuff for purposes of % printing. So we \turnoffactive for the \refx-snt, back on for the % printing, back off for the \refx-pg. {\turnoffactive % 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}{}% \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 } % Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. % If its value is nonempty, SUFFIX is output afterward. % \def\refx#1#2{% {% \indexnofonts \otherbackslash \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. Usually it's % just a \def (we prepend XR to the control sequence name to avoid % collisions). But if this is a float type, we have more work to do. % \def\xrdef#1#2{% {% The node name might contain 8-bit characters, which in our current % implementation are changed to commands like @'e. Don't let these % mess up the control sequence name. \indexnofonts \turnoffactive \xdef\safexrefname{#1}% }% % \expandafter\gdef\csname XR\safexrefname\endcsname{#2}% remember this xref % % 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 } % 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 % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc. % in xref tags, i.e., node names. But since ^^e4 notation isn't % supported in the main text, it doesn't seem desirable. Furthermore, % that is not enough: for node names that actually contain a ^ % character, we would end up writing a line like this: 'xrdef {'hat % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first % argument, and \hat is not an expandable control sequence. It could % all be worked out, but why? Either we support ^^ or we don't. % % The other change necessary for this was to define \auxhat: % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter % and then to call \auxhat in \setq. % \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 % % This is to support \ in node names and titles, since the \ % characters end up in a \csname. It's easier than % leaving it active and making its active definition an actual \ % character. What I don't understand is why it works in the *value* % of the xrdef. Seems like it should be a catcode12 \, and that % should not typeset properly. But it works, so I'm moving on for % now. --karl, 15jan04. \catcode`\\=\other % % Make the characters 128-255 be printing characters. {% \count1=128 \def\loop{% \catcode\count1=\other \advance\count1 by 1 \ifnum \count1<256 \loop \fi }% }% % % @ 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{% \let\indent=\ptexindent \let\noindent=\ptexnoindent \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 % 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=\pagewidth \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 % 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 ftp://tug.org/tex/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 % 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 \dopdfimage{#1}{#2}{#3}% \else % \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}% \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 \lastsection 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\lastsection{\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. {% \atdummies % % since we read the caption text in the macro world, where ^^M % is turned into a normal character, we have to scan it back, so % we don't write the literal three characters "^^M" into the aux file. \scanexp{% \xdef\noexpand\gtemp{% \ifx\thisshortcaption\empty \thiscaption \else \thisshortcaption \fi }% }% \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident \ifx\gtemp\empty \else : \gtemp \fi}}% }% \fi \egroup % end of \vtop % % place the captured inserts % % BEWARE: when the floats start floating, we have to issue warning % whenever an insert appears inside a float which could possibly % float. --kasal, 26may04 % \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 % \lastsection 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{\begingroup \let_=\normalunderscore % normal _ character for filenames \tex % read txi-??.tex file in plain TeX. % Read the file by the name they passed if it exists. \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 \endgroup} % % 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 } % 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. % \parseargdef\documentencoding{% % 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 \setnonasciicharscatcode\active \lattwochardefs % \else \ifx \declaredencoding \latone \setnonasciicharscatcode\active \latonechardefs % \else \ifx \declaredencoding \latnine \setnonasciicharscatcode\active \latninechardefs % \else \ifx \declaredencoding \utfeight \setnonasciicharscatcode\active \utfeightchardefs % \else \message{Unknown document encoding #1, ignoring.}% % \fi % utfeight \fi % latnine \fi % latone \fi % lattwo \fi % ascii } % A message to be logged when using a character that isn't available % the default font encoding (OT1). % \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #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 % % Latin1 (ISO-8859-1) character definitions. \def\latonechardefs{% \gdef^^a0{\tie} \gdef^^a1{\exclamdown} \gdef^^a2{\missingcharmsg{CENT SIGN}} \gdef^^a3{{\pounds}} \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} \gdef^^a5{\missingcharmsg{YEN SIGN}} \gdef^^a6{\missingcharmsg{BROKEN BAR}} \gdef^^a7{\S} \gdef^^a8{\"{}} \gdef^^a9{\copyright} \gdef^^aa{\ordf} \gdef^^ab{\guillemetleft} \gdef^^ac{$\lnot$} \gdef^^ad{\-} \gdef^^ae{\registeredsymbol} \gdef^^af{\={}} % \gdef^^b0{\textdegree} \gdef^^b1{$\pm$} \gdef^^b2{$^2$} \gdef^^b3{$^3$} \gdef^^b4{\'{}} \gdef^^b5{$\mu$} \gdef^^b6{\P} % \gdef^^b7{$^.$} \gdef^^b8{\cedilla\ } \gdef^^b9{$^1$} \gdef^^ba{\ordm} % \gdef^^bb{\guillemetright} \gdef^^bc{$1\over4$} \gdef^^bd{$1\over2$} \gdef^^be{$3\over4$} \gdef^^bf{\questiondown} % \gdef^^c0{\`A} \gdef^^c1{\'A} \gdef^^c2{\^A} \gdef^^c3{\~A} \gdef^^c4{\"A} \gdef^^c5{\ringaccent A} \gdef^^c6{\AE} \gdef^^c7{\cedilla C} \gdef^^c8{\`E} \gdef^^c9{\'E} \gdef^^ca{\^E} \gdef^^cb{\"E} \gdef^^cc{\`I} \gdef^^cd{\'I} \gdef^^ce{\^I} \gdef^^cf{\"I} % \gdef^^d0{\DH} \gdef^^d1{\~N} \gdef^^d2{\`O} \gdef^^d3{\'O} \gdef^^d4{\^O} \gdef^^d5{\~O} \gdef^^d6{\"O} \gdef^^d7{$\times$} \gdef^^d8{\O} \gdef^^d9{\`U} \gdef^^da{\'U} \gdef^^db{\^U} \gdef^^dc{\"U} \gdef^^dd{\'Y} \gdef^^de{\TH} \gdef^^df{\ss} % \gdef^^e0{\`a} \gdef^^e1{\'a} \gdef^^e2{\^a} \gdef^^e3{\~a} \gdef^^e4{\"a} \gdef^^e5{\ringaccent a} \gdef^^e6{\ae} \gdef^^e7{\cedilla c} \gdef^^e8{\`e} \gdef^^e9{\'e} \gdef^^ea{\^e} \gdef^^eb{\"e} \gdef^^ec{\`{\dotless i}} \gdef^^ed{\'{\dotless i}} \gdef^^ee{\^{\dotless i}} \gdef^^ef{\"{\dotless i}} % \gdef^^f0{\dh} \gdef^^f1{\~n} \gdef^^f2{\`o} \gdef^^f3{\'o} \gdef^^f4{\^o} \gdef^^f5{\~o} \gdef^^f6{\"o} \gdef^^f7{$\div$} \gdef^^f8{\o} \gdef^^f9{\`u} \gdef^^fa{\'u} \gdef^^fb{\^u} \gdef^^fc{\"u} \gdef^^fd{\'y} \gdef^^fe{\th} \gdef^^ff{\"y} } % Latin9 (ISO-8859-15) encoding character definitions. \def\latninechardefs{% % Encoding is almost identical to Latin1. \latonechardefs % \gdef^^a4{\euro} \gdef^^a6{\v S} \gdef^^a8{\v s} \gdef^^b4{\v Z} \gdef^^b8{\v z} \gdef^^bc{\OE} \gdef^^bd{\oe} \gdef^^be{\"Y} } % Latin2 (ISO-8859-2) character definitions. \def\lattwochardefs{% \gdef^^a0{\tie} \gdef^^a1{\ogonek{A}} \gdef^^a2{\u{}} \gdef^^a3{\L} \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} \gdef^^a5{\v L} \gdef^^a6{\'S} \gdef^^a7{\S} \gdef^^a8{\"{}} \gdef^^a9{\v S} \gdef^^aa{\cedilla S} \gdef^^ab{\v T} \gdef^^ac{\'Z} \gdef^^ad{\-} \gdef^^ae{\v Z} \gdef^^af{\dotaccent Z} % \gdef^^b0{\textdegree} \gdef^^b1{\ogonek{a}} \gdef^^b2{\ogonek{ }} \gdef^^b3{\l} \gdef^^b4{\'{}} \gdef^^b5{\v l} \gdef^^b6{\'s} \gdef^^b7{\v{}} \gdef^^b8{\cedilla\ } \gdef^^b9{\v s} \gdef^^ba{\cedilla s} \gdef^^bb{\v t} \gdef^^bc{\'z} \gdef^^bd{\H{}} \gdef^^be{\v z} \gdef^^bf{\dotaccent z} % \gdef^^c0{\'R} \gdef^^c1{\'A} \gdef^^c2{\^A} \gdef^^c3{\u A} \gdef^^c4{\"A} \gdef^^c5{\'L} \gdef^^c6{\'C} \gdef^^c7{\cedilla C} \gdef^^c8{\v C} \gdef^^c9{\'E} \gdef^^ca{\ogonek{E}} \gdef^^cb{\"E} \gdef^^cc{\v E} \gdef^^cd{\'I} \gdef^^ce{\^I} \gdef^^cf{\v D} % \gdef^^d0{\DH} \gdef^^d1{\'N} \gdef^^d2{\v N} \gdef^^d3{\'O} \gdef^^d4{\^O} \gdef^^d5{\H O} \gdef^^d6{\"O} \gdef^^d7{$\times$} \gdef^^d8{\v R} \gdef^^d9{\ringaccent U} \gdef^^da{\'U} \gdef^^db{\H U} \gdef^^dc{\"U} \gdef^^dd{\'Y} \gdef^^de{\cedilla T} \gdef^^df{\ss} % \gdef^^e0{\'r} \gdef^^e1{\'a} \gdef^^e2{\^a} \gdef^^e3{\u a} \gdef^^e4{\"a} \gdef^^e5{\'l} \gdef^^e6{\'c} \gdef^^e7{\cedilla c} \gdef^^e8{\v c} \gdef^^e9{\'e} \gdef^^ea{\ogonek{e}} \gdef^^eb{\"e} \gdef^^ec{\v e} \gdef^^ed{\'{\dotless{i}}} \gdef^^ee{\^{\dotless{i}}} \gdef^^ef{\v d} % \gdef^^f0{\dh} \gdef^^f1{\'n} \gdef^^f2{\v n} \gdef^^f3{\'o} \gdef^^f4{\^o} \gdef^^f5{\H o} \gdef^^f6{\"o} \gdef^^f7{$\div$} \gdef^^f8{\v r} \gdef^^f9{\ringaccent u} \gdef^^fa{\'u} \gdef^^fb{\H u} \gdef^^fc{\"u} \gdef^^fd{\'y} \gdef^^fe{\cedilla t} \gdef^^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 } \begingroup \catcode`\~13 \catcode`\"12 \def\UTFviiiLoop{% \global\catcode\countUTFx\active \uccode`\~\countUTFx \uppercase\expandafter{\UTFviiiTmp}% \advance\countUTFx by 1 \ifnum\countUTFx < \countUTFy \expandafter\UTFviiiLoop \fi} \countUTFx = "C2 \countUTFy = "E0 \def\UTFviiiTmp{% \xdef~{\noexpand\UTFviiiTwoOctets\string~}} \UTFviiiLoop \countUTFx = "E0 \countUTFy = "F0 \def\UTFviiiTmp{% \xdef~{\noexpand\UTFviiiThreeOctets\string~}} \UTFviiiLoop \countUTFx = "F0 \countUTFy = "F4 \def\UTFviiiTmp{% \xdef~{\noexpand\UTFviiiFourOctets\string~}} \UTFviiiLoop \endgroup \begingroup \catcode`\"=12 \catcode`\<=12 \catcode`\.=12 \catcode`\,=12 \catcode`\;=12 \catcode`\!=12 \catcode`\~=13 \gdef\DeclareUnicodeCharacter#1#2{% \countUTFz = "#1\relax %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}% \begingroup \parseXMLCharref \def\UTFviiiTwoOctets##1##2{% \csname u8:##1\string ##2\endcsname}% \def\UTFviiiThreeOctets##1##2##3{% \csname u8:##1\string ##2\string ##3\endcsname}% \def\UTFviiiFourOctets##1##2##3##4{% \csname u8:##1\string ##2\string ##3\string ##4\endcsname}% \expandafter\expandafter\expandafter\expandafter \expandafter\expandafter\expandafter \gdef\UTFviiiTmp{#2}% \endgroup} \gdef\parseXMLCharref{% \ifnum\countUTFz < "A0\relax \errhelp = \EMsimple \errmessage{Cannot define Unicode char value < 00A0}% \else\ifnum\countUTFz < "800\relax \parseUTFviiiA,% \parseUTFviiiB C\UTFviiiTwoOctets.,% \else\ifnum\countUTFz < "10000\relax \parseUTFviiiA;% \parseUTFviiiA,% \parseUTFviiiB E\UTFviiiThreeOctets.{,;}% \else \parseUTFviiiA;% \parseUTFviiiA,% \parseUTFviiiA!% \parseUTFviiiB F\UTFviiiFourOctets.{!,;}% \fi\fi\fi } \gdef\parseUTFviiiA#1{% \countUTFx = \countUTFz \divide\countUTFz by 64 \countUTFy = \countUTFz \multiply\countUTFz by 64 \advance\countUTFx by -\countUTFz \advance\countUTFx by 128 \uccode `#1\countUTFx \countUTFz = \countUTFy} \gdef\parseUTFviiiB#1#2#3#4{% \advance\countUTFz by "#10\relax \uccode `#3\countUTFz \uppercase{\gdef\UTFviiiTmp{#2#3#4}}} \endgroup \def\utfeightchardefs{% \DeclareUnicodeCharacter{00A0}{\tie} \DeclareUnicodeCharacter{00A1}{\exclamdown} \DeclareUnicodeCharacter{00A3}{\pounds} \DeclareUnicodeCharacter{00A8}{\"{ }} \DeclareUnicodeCharacter{00A9}{\copyright} \DeclareUnicodeCharacter{00AA}{\ordf} \DeclareUnicodeCharacter{00AB}{\guillemetleft} \DeclareUnicodeCharacter{00AD}{\-} \DeclareUnicodeCharacter{00AE}{\registeredsymbol} \DeclareUnicodeCharacter{00AF}{\={ }} \DeclareUnicodeCharacter{00B0}{\ringaccent{ }} \DeclareUnicodeCharacter{00B4}{\'{ }} \DeclareUnicodeCharacter{00B8}{\cedilla{ }} \DeclareUnicodeCharacter{00BA}{\ordm} \DeclareUnicodeCharacter{00BB}{\guillemetright} \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{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{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{0118}{\ogonek{E}} \DeclareUnicodeCharacter{0119}{\ogonek{e}} \DeclareUnicodeCharacter{010A}{\dotaccent{C}} \DeclareUnicodeCharacter{010B}{\dotaccent{c}} \DeclareUnicodeCharacter{010C}{\v{C}} \DeclareUnicodeCharacter{010D}{\v{c}} \DeclareUnicodeCharacter{010E}{\v{D}} \DeclareUnicodeCharacter{0112}{\=E} \DeclareUnicodeCharacter{0113}{\=e} \DeclareUnicodeCharacter{0114}{\u{E}} \DeclareUnicodeCharacter{0115}{\u{e}} \DeclareUnicodeCharacter{0116}{\dotaccent{E}} \DeclareUnicodeCharacter{0117}{\dotaccent{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{0124}{\^H} \DeclareUnicodeCharacter{0125}{\^h} \DeclareUnicodeCharacter{0128}{\~I} \DeclareUnicodeCharacter{0129}{\~{\dotless{i}}} \DeclareUnicodeCharacter{012A}{\=I} \DeclareUnicodeCharacter{012B}{\={\dotless{i}}} \DeclareUnicodeCharacter{012C}{\u{I}} \DeclareUnicodeCharacter{012D}{\u{\dotless{i}}} \DeclareUnicodeCharacter{0130}{\dotaccent{I}} \DeclareUnicodeCharacter{0131}{\dotless{i}} \DeclareUnicodeCharacter{0132}{IJ} \DeclareUnicodeCharacter{0133}{ij} \DeclareUnicodeCharacter{0134}{\^J} \DeclareUnicodeCharacter{0135}{\^{\dotless{j}}} \DeclareUnicodeCharacter{0139}{\'L} \DeclareUnicodeCharacter{013A}{\'l} \DeclareUnicodeCharacter{0141}{\L} \DeclareUnicodeCharacter{0142}{\l} \DeclareUnicodeCharacter{0143}{\'N} \DeclareUnicodeCharacter{0144}{\'n} \DeclareUnicodeCharacter{0147}{\v{N}} \DeclareUnicodeCharacter{0148}{\v{n}} \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{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{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{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{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{ }} \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} \DeclareUnicodeCharacter{2013}{--} \DeclareUnicodeCharacter{2014}{---} \DeclareUnicodeCharacter{2018}{\quoteleft} \DeclareUnicodeCharacter{2019}{\quoteright} \DeclareUnicodeCharacter{201A}{\quotesinglbase} \DeclareUnicodeCharacter{201C}{\quotedblleft} \DeclareUnicodeCharacter{201D}{\quotedblright} \DeclareUnicodeCharacter{201E}{\quotedblbase} \DeclareUnicodeCharacter{2022}{\bullet} \DeclareUnicodeCharacter{2026}{\dots} \DeclareUnicodeCharacter{2039}{\guilsinglleft} \DeclareUnicodeCharacter{203A}{\guilsinglright} \DeclareUnicodeCharacter{20AC}{\euro} \DeclareUnicodeCharacter{2192}{\expansion} \DeclareUnicodeCharacter{21D2}{\result} \DeclareUnicodeCharacter{2212}{\minus} \DeclareUnicodeCharacter{2217}{\point} \DeclareUnicodeCharacter{2261}{\equiv} }% end of \utfeightchardefs % US-ASCII character definitions. \def\asciichardefs{% nothing need be done \relax } % Make non-ASCII characters printable again for compatibility with % existing Texinfo documents that may use them, even without declaring a % document encoding. % \setnonasciicharscatcode \other \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 \pageheight = \vsize % \hsize = #2\relax \outerhsize = \hsize \advance\outerhsize by 0.5in \pagewidth = \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 \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 \hfuzz = 1pt \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 \hfuzz = 1pt \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 \hfuzz = 1pt \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 \hfuzz = 1.2pt \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 % \dimen2 = \hsize \advance\dimen2 by \normaloffset % \internalpagesizes{#1}{\hsize}% {\voffset}{\normaloffset}% {\bindingoffset}{44pt}% {\dimen0}{\dimen2}% }} % Set default to letter. % \letterpaper \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} % Turn off all special characters except @ % (and those which the user can use as if they were ordinary). % 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~{{\tt\char126}} \chardef\hat=`\^ \catcode`\^=\active \def^{{\tt \hat}} \catcode`\_=\active \def_{\ifusingtt\normalunderscore\_} \let\realunder=_ % Subroutine for the previous macro. \def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } \catcode`\|=\active \def|{{\tt\char124}} \chardef \less=`\< \catcode`\<=\active \def<{{\tt \less}} \chardef \gtr=`\> \catcode`\>=\active \def>{{\tt \gtr}} \catcode`\+=\active \def+{{\tt \char 43}} \catcode`\$=\active \def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix % 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 \everyjob (or @setfilename) turn them on. % \otherifyactive is called near the end of this file. \def\otherifyactive{\catcode`+=\other \catcode`\_=\other} % 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=`\\ \global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work % \realbackslash is an actual character `\' with catcode other, and % \doublebackslash is two of them (for the pdf outlines). {\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}} % In texinfo, backslash is an active character; it prints the backslash % in fixed width font. \catcode`\\=\active % @ for escape char from now on. % 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). It seems better for @backslashchar{} to always % print a typewriter backslash, 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@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}} @let@backslashchar = @normalbackslash % @backslashchar{} is for user documents. % On startup, @fixbackslash assigns: % @let \ = @normalbackslash % \rawbackslash defines an active \ to do \backslashcurfont. % \otherbackslash defines an active \ to be a literal `\' character with % catcode other. We switch back and forth between these. @gdef@rawbackslash{@let\=@backslashcurfont} @gdef@otherbackslash{@let\=@realbackslash} % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of % the literal character `\'. Also revert - to its normal character, in % case the active - from code has slipped in. % {@catcode`- = @active @gdef@normalturnoffactive{% @let-=@normaldash @let"=@normaldoublequote @let$=@normaldollar %$ font-lock fix @let+=@normalplus @let<=@normalless @let>=@normalgreater @let\=@normalbackslash @let^=@normalcaret @let_=@normalunderscore @let|=@normalverticalbar @let~=@normaltilde @markupsetuplqdefault @markupsetuprqdefault @unsepspaces } } % Make _ and + \other characters, temporarily. % This is canceled by @fixbackslash. @otherifyactive % 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. % @gdef@eatinput input texinfo{@fixbackslash} @global@let\ = @eatinput % On the other hand, perhaps the file did not have a `\input texinfo'. Then % the first `\' in the file would cause an error. This macro tries to fix % that, assuming it is called before the first `\' could plausibly occur. % Also turn back on active characters that might appear in the input % file name, in case not using a pre-dumped format. % @gdef@fixbackslash{% @ifx\@eatinput @let\ = @normalbackslash @fi @catcode`+=@active @catcode`@_=@active } % 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 'write-file-hooks 'time-stamp) @c page-delimiter: "^\\\\message" @c time-stamp-start: "def\\\\texinfoversion{" @c time-stamp-format: "%:y-%02m-%02d.%02H" @c time-stamp-end: "}" @c End: @c vim:sw=2: @ignore arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115 @end ignore adasockets-1.10.1/tests/000077500000000000000000000000001277046543400150715ustar00rootroot00000000000000adasockets-1.10.1/tests/Makefile.am000066400000000000000000000010601277046543400171220ustar00rootroot00000000000000TESTS = value-localhost.test value-invalid.test \ value-regular.test value-compressed.test \ multicast_test XFAIL_TESTS = value-invalid.test all-local: multicast_test value multicast_test: never $(GNATMAKE) -m -A../src -A$(top_srcdir)/src -I$(srcdir) multicast_test -cargs $(ADAFLAGS) -largs $(LDFLAGS) value: never $(GNATMAKE) -m -A../src -A$(top_srcdir)/src -I$(srcdir) value -cargs $(ADAFLAGS) -largs $(LDFLAGS) CLEANFILES = *.o *.ali b_*.c b~*.ad[bs] DISTCLEANFILES = multicast_test value EXTRA_DIST = *.test multicast_test.adb value.adb never:: adasockets-1.10.1/tests/multicast_test.adb000066400000000000000000000100511277046543400206020ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- M U L T I C A S T - T E S T -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 ENST http://www.enst.fr/ -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets -- -- -- -- If you have any question, please send a mail to the AdaSockets list -- -- adasockets@lists.rfc1149.net -- -- -- ----------------------------------------------------------------------------- with Ada.Command_Line; use Ada.Command_Line; with Ada.Exceptions; use Ada.Exceptions; with Ada.Text_IO; use Ada.Text_IO; with Sockets.Multicast; use Sockets, Sockets.Multicast; procedure Multicast_Test is Sock : constant Multicast_Socket_FD := Create_Multicast_Socket ("224.13.194.161", 0); task Send_Packets; task body Send_Packets is begin for I in 1 .. 30 loop delay 0.01; Put_Line ("Emitting ""foo"""); Put (Sock, "foo"); end loop; exception when E : others => Put_Line ("Exception raised in Send_Packets task:" & Exception_Information (E)); end Send_Packets; begin Set_Exit_Status (1); select delay 1.0; then abort Put_Line ("Waiting for input"); if Get (Sock) = "foo" then Put_Line ("Got ""foo"""); Set_Exit_Status (0); abort Send_Packets; else Put_Line ("Got something else"); end if; end select; exception when E : others => Put_Line ("Exception raised in main task:" & Exception_Information (E)); if Argument_Count < 1 then Put_Line ("Btw, usage is: multi ""string to send"""); end if; end Multicast_Test; adasockets-1.10.1/tests/value-compressed.test000077500000000000000000000000701277046543400212500ustar00rootroot00000000000000#! /bin/sh # [ $(./value 2311233794) = 137.194.161.2 ] adasockets-1.10.1/tests/value-invalid.test000077500000000000000000000000441277046543400205330ustar00rootroot00000000000000#! /bin/sh # ./value 137.194.257.1 adasockets-1.10.1/tests/value-localhost.test000077500000000000000000000000571277046543400211010ustar00rootroot00000000000000#! /bin/sh # [ $(./value 127.1) = 127.0.0.1 ] adasockets-1.10.1/tests/value-regular.test000077500000000000000000000000731277046543400205500ustar00rootroot00000000000000#! /bin/sh # [ $(./value 137.194.161.2) = 137.194.161.2 ] adasockets-1.10.1/tests/value.adb000066400000000000000000000064371277046543400166670ustar00rootroot00000000000000----------------------------------------------------------------------------- -- -- -- ADASOCKETS COMPONENTS -- -- -- -- V A L U E -- -- -- -- B o d y -- -- -- -- Copyright (C) 1998-2015 Samuel Tardieu -- -- Copyright (C) 1999-2003 ENST http://www.enst.fr/ -- -- -- -- AdaSockets is free software; you can redistribute it and/or modify -- -- it under terms of the GNU General Public License as published by -- -- the Free Software Foundation; either version 2, or (at your option) -- -- any later version. AdaSockets 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 distributed -- -- with AdaSockets; see file COPYING. If not, write to the Free -- -- Software Foundation, 59 Temple Place - Suite 330, Boston, MA -- -- 02111-1307, USA. -- -- -- -- As a special exception, if other files instantiate generics from -- -- this unit, or you link this unit with other files to produce an -- -- executable, this unit does not by itself cause the resulting -- -- executable to be covered by the GNU General Public License. This -- -- exception does not however invalidate any other reasons why the -- -- executable file might be covered by the GNU Public License. -- -- -- -- The main repository for this software is located at: -- -- http://www.rfc1149.net/devel/adasockets -- -- -- -- If you have any question, please send a mail to the AdaSockets list -- -- adasockets@lists.rfc1149.net -- -- -- ----------------------------------------------------------------------------- with Ada.Command_Line; use Ada.Command_Line; with Ada.Exceptions; use Ada.Exceptions; with Ada.Text_IO; use Ada.Text_IO; with Sockets.Naming; use Sockets, Sockets.Naming; procedure Value is -- Usage: value IP -- Example: value 137.194.161.2 begin if Argument_Count /= 1 then Raise_Exception (Constraint_Error'Identity, "Usage: " & Command_Name & " IP"); end if; Put_Line (Image (Value (Argument (1)))); end Value; adasockets-1.10.1/utils/000077500000000000000000000000001277046543400150675ustar00rootroot00000000000000adasockets-1.10.1/utils/update-headers.el000066400000000000000000000053431277046543400203110ustar00rootroot00000000000000;;; ;;; This file contains the update-header command which can be used to ;;; update headers depending on the header.txt file in the current directory. ;;; ;;; It should be used as: ;;; emacs -batch -l ../utils/update-headers.el -f update-headers ;;; ;;; XXXXX will be replaced by context-dependent information. ;;; (defun update-header () "Update headers according to header.txt." (interactive) (let (name spec) (goto-char (point-min)) (if (re-search-forward "^-- $Id" nil t) (progn (next-line 2) (beginning-of-line) (delete-region (point-min) (point)))) (goto-char (point-min)) (next-line 1) (if (re-search-forward "^----------" nil t) (progn (next-line 1) (beginning-of-line) (delete-region (point-min) (point)))) (goto-char (point-min)) (if (re-search-forward "package body \\(.+\\) is" nil t) (setq name (buffer-substring (match-beginning 1) (match-end 1))) (goto-char (point-min)) (if (re-search-forward "package \\(.+\\) is" nil t) (setq name (buffer-substring (match-beginning 1) (match-end 1)) spec t) (goto-char (point-min)) (if (re-search-forward "^procedure \\([^ ;]+\\)" nil t) (setq name (buffer-substring (match-beginning 1) (match-end 1)) spec (string-match "ads" (buffer-name))) (goto-char (point-min)) (if (re-search-forward "^function \\([^ ;]+\\)" nil t) (setq name (buffer-substring (match-beginning 1) (match-end 1)) spec (string-match "ads" (buffer-name))))))) (goto-char (point-min)) (insert-file "header.txt") (goto-char (point-min)) (re-search-forward "^XXXXX" nil) (beginning-of-line) (let ((beg (point))) (next-line 1) (delete-region beg (point))) (insert (center-ada (upcase (expand-ada-name name)))) (insert (center-ada "")) (insert (center-ada (if spec "S p e c" "B o d y"))) (re-search-forward "----------") (next-line 1) (let ((beg (point))) (end-of-line) (if (not (equal (buffer-substring beg (point)) "")) (progn (beginning-of-line) (insert "\n")))))) (defun expand-ada-name (n) (if (<= (length n) 1) n (concat (substring n 0 1) " " (expand-ada-name (substring n 1))))) (defun center-ada (l) (let* ((tt 70) (n (length l)) (s (/ (- tt n) 2))) (concat "-- " (spaces-ada s) l (spaces-ada (- tt (+ s n))) " --\n"))) (defun spaces-ada (n) (if (<= n 0) "" (concat " " (spaces-ada (- n 1))))) (defun update-headers () "Update headers of files given on the command line" (interactive) (let ((l (directory-files "." nil "\\.ad[bs]" nil))) (while l (let ((current (car l))) (message "Updating %s..." current) (find-file current) (update-header) (write-file current) (message "Updating %s... done" current) (setq l (cdr l)))))) adasockets-1.10.1/vms/000077500000000000000000000000001277046543400145345ustar00rootroot00000000000000adasockets-1.10.1/vms/Makefile.VMS000066400000000000000000000007541277046543400166460ustar00rootroot00000000000000# # VMS specific Makefile to build the # sockets-constants.ads file. # # $Revision$ # # This file is part of adasockets port to OpenVMS .PHONY: all distclean clean .DEFAULT: all all: sockets-constants.ads sockets-constants.ads: constants.exe \@create_constants_ads.com constants.exe: constants.c cc constants link constants constants.c: constants.list \@create_constants_c.com distclean: del *.exe;*, *.obj;*, *.c;*, sockets-constants.ads;* clean: del *.exe;*, *.obj;*, *.c;* adasockets-1.10.1/vms/constants.c_pre000066400000000000000000000021761277046543400175700ustar00rootroot00000000000000/* * This is an incomplete C program preamble aimed to extract * constants' values. The complete source is generated by * CREATE_CONSTANTS_C.COM. * * NOTE: THIS CODE IS SPECIFIC TO OPENVMS 7.2 OR ABOVE PLATFORMS * */ #include #include #include #include #include #include #include #include #include #include #include #include static char * capitalize (char *name) { int beginning = 1; char *result = (char *) malloc (strlen (name) + 1); char *ptr; for (ptr = result; *name; ptr++, name++) { *ptr = *name; if (beginning) { beginning = 0; } else if (*ptr == '_') { beginning = 1; } else if (isupper(*ptr)) { *ptr = tolower(*ptr); } } *ptr = '\0'; return result; } static void output (char *name, int value) { char *capitalized = capitalize (name); if (value >= 0) { printf (" %-20s : constant := 16#%04X#;\n", capitalized, value); } else { printf (" %-20s : constant := %d;\n", capitalized, value); } } int main (int argc, char *argv[]) { adasockets-1.10.1/vms/constants.list000066400000000000000000000015401277046543400174450ustar00rootroot00000000000000TCP_NODELAY AF_INET AF_UNIX SOCK_STREAM SOCK_DGRAM EINTR EAGAIN EWOULDBLOCK EINPROGRESS EALREADY EISCONN ECONNREFUSED FNDELAY FASYNC FIOASYNC F_GETFL F_SETFL F_SETOWN FIOSSAIOOWN SO_RCVBUF SO_REUSEADDR SO_REUSEPORT SOL_SOCKET SIGTERM SIGKILL O_RDONLY O_WRONLY O_RDWR HOST_NOT_FOUND TRY_AGAIN NO_RECOVERY NO_DATA NO_ADDRESS POLLIN POLLPRI POLLOUT POLLERR POLLHUP POLLNVAL I_SETSIG S_RDNORM S_WRNORM IPPROTO_IP IP_ADD_MEMBERSHIP IP_MULTICAST_LOOP IP_MULTICAST_TTL IP_DROP_MEMBERSHIP O_NONBLOCK MSG_PEEK FIONBIO FIONREAD SO_SNDBUF AF_INET6 AI_ADDRCONFIG AI_ALL AI_CANONNAME AI_DEFAULT AI_MASK AI_NUMERICHOST AI_PASSIVE AI_V4MAPPED AI_V4MAPPED_CFG NI_DGRAM NI_MAXHOST NI_MAXSERV NI_NAMEREQD NI_NOFQDN NI_NUMERICHOST NI_NUMERICSERV NI_WITHSCOPEID IPPROTO_IPV6 IPV6_UNICAST_HOPS IPV6_MULTICAST_IF IPV6_MULTICAST_HOPS IPV6_MULTICAST_LOOP IPV6_JOIN_GROUP IPV6_LEAVE_GROUP adasockets-1.10.1/vms/create_constants_ads.com000066400000000000000000000017451277046543400214310ustar00rootroot00000000000000$! $! This script produces a sockets-constants.ads file $! for adasockets on OpenVMS platform. $! $! This file is part of adasockets port to OpenVMS $! $! $! Let's write the header $! $ OPEN/WRITE OUT SOCKETS-CONSTANTS.ADS $ WRITE OUT "-- This file has been generated automatically by" $ WRITE OUT "-- CREATE_CONSTANTS_ADS.COM." $ WRITE OUT "--" $ WRITE OUT "-- This file is part of adasockets port to OpenVMS" $ WRITE OUT "--" $ WRITE OUT "package sockets.constants is" $! $! Now Include the contents. $! Make a line copy to get rid of the file attribut $! compatibility between TMP.OUT and SOCKETS-CONSTANTS.ADS $! $ PIPE RUN CONSTANTS.EXE | TYPE/OUT=TMP.OUT SYS$INPUT $ loop_label: $ OPEN IN TMP.OUT $ READ/END_OF_FILE=end_label IN LINE $ WRITE OUT LINE $ GOTO loop_label $ end_label: $ CLOSE IN $ DEL/NOCONF/LOG TMP.OUT;* $! $! Then close the specification file $! $ WRITE OUT "end sockets.constants;" $ CLOSE OUT $ EXIT adasockets-1.10.1/vms/create_constants_c.com000066400000000000000000000012101277046543400210670ustar00rootroot00000000000000$! $! $Revision$ $! $! $! This script completes the constants.c_pre file with the $! the list of defines needed to build the adasockets constant $! package. $! $! This file is part of Adasockets for OpenVMS. $! $ OPEN/READ in CONSTANTS.LIST $ COPY CONSTANTS.C_PRE CONSTANTS.C $ OPEN/APPEND out CONSTANTS.C $! $ Loop: $ READ/END_OF_FILE=End_Loop in line $ WRITE out "#ifdef ''line'" $ WRITE out " output (""''line'"", ''line');" $ WRITE out "#else" $ WRITE out " output (""''line'"", -1);" $ WRITE out "#endif" $ GOTO Loop $! $ End_Loop: $ WRITE out "}" $ CLOSE in $ CLOSE out $ EXIT