diff options
47 files changed, 3129 insertions, 9198 deletions
diff --git a/.gbp.conf b/.gbp.conf new file mode 100644 index 00000000..7d818a88 --- /dev/null +++ b/.gbp.conf @@ -0,0 +1,6 @@ +[git-buildpackage] +# use a build area relative to the git repository +# export-dir = ../build-area + +[git-dch] +git-log = --no-merges diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..a11e756e --- /dev/null +++ b/.gitignore @@ -0,0 +1,59 @@ +*~ +*.[ao] +*.l[ao] +.deps +.libs +ChangeLog +INSTALL +Makefile +Makefile.in +aclocal.m4 +/autom4te.cache +bgpd/bgpd +config.guess +config.h +config.h.in +config.log +config.status +config.sub +configure +debian/build-stamp +debian/vyatta-quagga +debian/vyatta-quagga.substvars +debian/files +debian/vyatta-quagga.postinst.debhelper +debian/vyatta-quagga.postrm.debhelper +debian/vyatta-quagga.prerm.debhelper +depcomp +doc/defines.texi +doc/mdate-sh +doc/quagga.info* +doc/stamp-vti +doc/texinfo.tex +doc/version.texi +install-sh +isisd/isisd +lib/memtypes.h +lib/route_types.h +lib/version.h +libtool +ltmain.sh +redhat/quagga.spec +ripd/ripd +ripngd/ripngd +stamp-h1 +mkinstalldirs +missing +ospf6d/ospf6d +ospfclient/ospfclient +ospfd/ospfd +pkgsrc/*.sh +vtysh/extract.pl +vtysh/vtysh +vtysh/vtysh_cmd.c +watchlink/watchlink +watchquagga/watchquagga +zebra/testzebra +zebra/zebra + + diff --git a/ChangeLog b/ChangeLog deleted file mode 100644 index ae97cf37..00000000 --- a/ChangeLog +++ /dev/null @@ -1,1976 +0,0 @@ -2008-01-30 Peter Szilagyi <sp615@hszk.bme.hu> - - * lib/stream.h: Remove named 'new' parameter in prototype - for c++ header compatibility. - * ospfd/ospf_opaque.h: ditto - * ospfd/ospfd.h: Renamed struct export to _export for c++ - header compatibility. - * ospf6d/ospf6_area.h: ditto - -2008-01-11 Ingo Flaschberger <if@xip.at> - - * configure.ac: Improve HAVE_BSD_LINK_DETECT test. - -2008-01-10 Ingo Flaschberger <if@xip.at> - - * configure.ac: Define HAVE_BSD_LINK_DETECT if <net/if_media.h> is - present. - -2007-10-14 Paul Jakma <paul.jakma@sun.com> - - * NEWS: Note that MRT dumps are now version 2 - -2007-09-07 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Bump version to 0.99.9 - -2007-08-07 James Carlson <james.d.carlson@sun.com> - - * configure.ac: Added support for separate link-layer access - mechanisms in isisd. - -2007-07-27 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Bump version to 0.99.8 - -2007-06-25 Hasso Tepper <hasso@quagga.net> - - * configure.ac: Fix typo so it compiles again on BSD systems. - -2007-06-22 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: IRDP also depends on struct icmphdr, enabling - only on in_pktinfo breaks when an OS acquires pktinfo, as - Solaris NV has. Reported by Jim Carlson. - -2007-05-10 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Add back check for inet_aton, which got dropped - somehow in previous jumbo patch. - Use AC_GNU_SOURCE to define _GNU_SOURCE, rather than having - lib/zebra.h do it. - AC_FUNC_STRNLEN has side-effects with latest autoconf, use - AC_CHECK_FUNC on strnlen instead. - -2007-05-09 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: sys/conf.h depends on sys/param.h, at least on - FBSD 6.2. - (bug #363) Should check for in_pktinfo for IRDP - -2006-05-27 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: General cleanup of header and type checks, introducing - an internal define, QUAGGA_INCLUDES, to build up a list of - stuff to include so as to avoid 'present but cant be compiled' - warnings. - Misc additional checks of things missing according to autoscan. - Add LIBM, for bgpd's use of libm, so as to avoid burdening - LIBS, and all the binaries, with libm linkage. - Remove the bad practice of using m4 changequote(), just - quote the []'s in the case statements properly. - This should fix bugs 162, 303 and 178. - * */*.{c,h}: Update all HAVE_* to the standard autoconf namespaced - HAVE_* defines. I.e. HAVE_SA_LEN -> HAVE_STRUCT_SOCKADDR_SA_LEN, - * bgpd/Makefile.am: Add LIBM to bgpd's LDADD, for pow(). - -2007-04-30 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * configure.ac: Change gcc CFLAGS from '-std=c99' to '-std=gnu99' - to improve portability. - -2007-04-29 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Bump to 0.99.7 - -2007-04-16 David Young <dyoung@pobox.com> - - * connected.c (zebra): Only suppress adding a connected - route to the kernel if it is already marked "real" - (ZEBRA_IFC_REAL), i.e., "in kernel." According to Paul - Jakma, this probably fixes Quagga bug #202. - -2007-02-06 Greg Troxel <Greg Troxel <gdt@ir.bbn.com>> - - * configure.ac: Use generic sed test, since autoconf 2.59 lacks - AC_PROG_SED and while 2.59 is somewhat crufty, it isn't officially - crufty. - -2007-02-06 Greg Troxel <Greg Troxel <gdt@ir.bbn.com> - - * bootstrap.sh: use -i to install missing files - -2007-02-03 Greg Troxel <Greg Troxel <gdt@ir.bbn.com> - - * configure.ac: add AC_PROG_SED - -2007-02-02 Greg Troxel <Greg Troxel <gdt@ir.bbn.com> - - * README.NetBSD: use bootstrap.sh instead of autoreconf - - * bootstrap.sh: new file with just 'autoreconf' - - * update-autotools: print out tool name before invoking to aid debugging - -2006-12-08 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Bump to 0.99.6 - -2006-10-04 Oliver Hookins <ohookins@gmail.com> - - * bgpd/bgp_main.c: Add configuration check option, with - '-C' rather than '-c' for consistency between daemons. - * isisd/isis_main.c: ditto - * ospf6d/ospf6_main.c: ditto - * ospfd/ospf_main.c: ditto - * ripngd/ripng_main.c: ditto - * vtysh/vtysh_main.c: ditto - * ripd/rip_main.c: Change the config check option to - '-C' and tidy up the code. - * zebra/main.c: ditto - -2006-10-04 Stergiakis Alexandros <astergiakis@antcor.com> - - * ripd/rip_main.c: This trivial patch introduces a new - command-line option '-c', which instructs zebra/ripd - to check its configuration file for validity, print - any error message, and then exit. This is useful when - the configuration file is edited by hand or otherwise, - and you simply want to validate it without any other - effect. - * zebra/main.c: ditto - -2006-08-27 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Bump to 0.99.5 - -2006-06-15 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * redhat/quagga.spec.in: Get default distro automatically - by using rpm to query the fedora-release version. - And fix a typo (should be default_dist, not dist_default). - -2006-05-28 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Update SOS CFLAGS, Xt shouldn't be used and - enable debug options. - Add a check for GNU Make and warn the user if it does not appear - to be the make used. - Check for Sun libc printstack(), add a general HAVE_STACK_TRACE - define for lib/log.c, if any supported stack symbol dumping - function is found (glibc backtrace/sun libc printstack). - -2006-05-10 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Bump to 0.99.4 - -2006-03-30 Paul Jakma <paul.jakma@sun.com> - - * TODO: Add reminder for useful MED functionality we should - implement. - -2006-02-15 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Check for mallinfo, being careful to link test - so we can detect things like umem being used (which doesn't - provide a mallinfo). - -2006-01-31 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Cleanup the hideous {net,ucd}-snmp section - by removing ucd-snmp. Hence fixing detection where - net-snmp is installed in /usr/local (Boris Kovalenko reported - the problem). - -2006-01-19 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Bump to 0.99.3 - -2005-11-26 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Collect together CFLAGS based on compiler - detected a bit. Recognise and set default CFLAGS for SunPro / - SOS10. - -2005-11-14 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Tell gcc we like C99. - [bug #231] Check and test for stdint.h. - -2005-11-11 Paul Jakma <paul.jakma@sun.com> - - * NEWS: Update. - * configure.ac: Bump to 0.99.2 - -2005-11-10 Paul Jakma <paul.jakma@sun.com> - - * HACKING: Add recommendation to provide a single Subject - style description to the commit message. - Add some recommendations for ChangeLog. - -2005-09-29 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Add the test for Solaris least-privileges. Set - defines for whether capabilities are supported and whether of - the linux or solaris variety. - Add missing-prototypes, missing-declarations, char-subscripts - and cast-qual warnings to default cflags, cause Hasso enjoys warnings, - and we really should clean the remaining ones up. (ie isisd..). - * (*/*main.c) Update the zebra_capabilities_t arrays in the various - daemons to match the changes made in lib/privs.h. - -2005-09-19 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Test existance of strndup. - -2005-08-25 Paul Jakma <paul@jakma.org> - - * configure.ac: Add -fno-omit-frame-pointer after -Os in default - cflags, just to be sure. - Fedora's readline library does not itself link to termcap, hence - we must pass the result of termcap tests in via OTHER-LIBRARIES - argument, otherwise the test of main in readline will fail due to - missing termcap systems. On systems like Debian, -ltermcap - is not needed for the readline test, because libreadline already - links to it. - -2005-08-25 Hasso Tepper <hasso at quagga.net> - - * configure.ac, vtysh/Makefile.am: Only vtysh needs to be linked - against libreadline and friends. - -2005-08-13 Paul Jakma <paul@jakma.org> - - * Makefile.am: (EXTRA_DIST) Add the trailing slash back in which - greg left out - tools bits weren't being included in dist, - which broke rpm builds :). - -2005-08-10 Greg Troxel <gdt@fnord.ir.bbn.com> - - * Makefile.am (EXTRA_DIST): add INSTALL.quagga.txt, because people - that patch releases need to know about autoconf required versions. - -2005-06-30 Louis Lagendijk <louis.lagendijk@gmail.com> - - * configure.ac: Actually test whether libc has IPv6 support. - -2005-06-28 Paul Jakma <paul.jakma@sun.com> - - * INSTALL.quagga.txt: GNU make is required now, because of manual - automatic rules in solaris/Makefile.am. (If someone knows how - to do these in a better way..). - GNU AWK is required for CVS checkout builds. - -2005-06-01 Paul Jakma <paul.jakma@sun.com> - - * NEWS: bgpd work queues and ripd auth-mode change - -2005-05-07 Yar Tikhiy <yar@comp.chem.msu.su> - - * configure.ac: Check for OSes which support passing ifindex in - struct ip_mreq. - -2005-04-29 Paul Jakma <paul.jakma@sun.com> - - * NEWS: Added some more 0.99 news. - * configure.ac: bump to 0.99.1 (0.99.0 was never released except - via CVS snapshots) - -2005-04-25 Paul Jakma <paul.jakma@sun.com> - - * HACKING: Add some notes about build system changes, to - document common oversights (common for me anyway). - Seperate sections with two newlines, easier to read. - -2005-04-16 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * configure.ac: Added AC_ARG_ENABLE(time-check). By default, - warning messages will now be printed for threads or commands that take - longer than 5 seconds, but this configure argument can be used - to disable the checks or change the threshold. - -2005-04-16 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: check for gawk, needed to build memtypes.h - -2005-04-11 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * configure.ac: Move AC_CANONICAL_* stuff before AM_INIT_AUTOMAKE to - eliminate warning message about AC_ARG_PROGRAM being called - before AC_CANONICAL_TARGET. - -2005-04-11 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Call AC_CANONICAL_{BUILD,TARGET} macros. Target isnt - set otherwise, afaict. AC_SUBST enable_{user,group,vty_group} and - quagga_statedir - the Solaris package bits for one need this. - configure the solaris/ Makefile. - * Makefile.am: solaris is a subdir - unconditional or else it wont - be included in non-solaris made dists. - -2005-04-10 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Fix host string recognition for Solaris Nevada aka - solaris2.10.1, and hopefully future such strings. - -2005-04-07 Paul Jakma <paul.jakma@sun.com> - - * (global): Fix up list loops to match changes in lib/linklist, - and some basic auditing of usage. - * configure.ac: define QUAGGA_NO_DEPRECATED_INTERFACES - * HACKING: Add notes about deprecating interfaces and commands. - -2005-04-05 Paul Jakma <paul@dishone.st> - - * HACKING: remove the 'manually patch redhat/quagga.spec' bit - from RELEASE section. Let the rpm revision be CONFDATE, will work - fine. Expand on the importance of supplying good ChangeLog's in - the PATCH SUBMISSION section. - -2005-04-04 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Fix AC_LANG_SOURCE usage. It needs double square - brackets around source. Single ones broke square brackets in the - code (arrays). - -2005-04-03 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Use AC_RUN_IFELSE instead of obsolete AC_TRY_RUN macro - and define action for cross-compiling. - -2005-04-02 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Add --enable-isis-topology to enable isisd topology - generator code. - -2005-04-02 Paul Jakma <paul@dishone.st> - - * INSTALL.quagga.txt: Add note about additional CVS build - requirements, if one wishes to build ps/pdf docs. - -2005-04-02 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * configure.ac: Add strnlen to AC_CHECK_FUNCS. - -2005-03-28 Hasso Tepper <hasso at quagga.net> - - * configure.ac, */Makefile.am: Fix previous commit. SNMP includes - must be after lib/ includes in some systems. Introduce SNMP_INCLUDES - for that. - -2005-03-28 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Fix most of "Presents But Cannot Compiled" warnings - about various headers. CFLAGS is not correct place to specify - includes, INCLUDES is for that. - -2005-03-27 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Add Intel compiler (icc) support. Although Intel - tries really hard to make icc look like gcc, there are some - differences. It's very verbose with -Wall and it doesn't support - the individual -W options. We are going to ignore some of these - warnings. - -2005-03-26 Hasso Tepper <hasso at quagga.net> - - * doc/defines.texi.in, lib/version.h.in: Update copyright string to - include year 2005. - -2005-03-25 Jean-Mickael Guerin <jean-mickael.guerin@6wind.com> - * configure.ac: add struct nd_opt_interval and struct - nd_opt_homeagent_info detection. - -2005-03-14 Paul Jakma <paul.jakma@sun.com> - - * (global) update all c files to match the lib/vector.h rename of - (struct vector).active to max, and vector_max macro to - vector_active. - -2005-03-12 Paul Jakma <paul.jakma@sun.com> - - * configure.ac: Solaris 8 can use the newer lifreq based methods - too, allows IPv6. - -2005-02-19 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Fix Linux detection. Host types like i686-pc-linux - didn't match the pattern. - -2005-02-09 Paul Jakma <paul.jakma@sun.com> - - * (global) Update code to match stream.h changes. - stream_get_putp effectively replaced with stream_get_endp. - stream_forward renamed to stream_forward_getp. - stream_forward_endp introduced to replace some previous - setting/manual twiddling of putp by daemons. - -2005-01-24 Paul Jakma <paul@dishone.st> - - * configure.ac: Bump version to 0.99.0 - -2005-01-15 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * redhat/quagga.spec.in: Fix postun script to avoid misleading error - message saying the postun scriptlet failed when watchquagga - is not running. - -2005-01-12 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * configure.ac: Test for header file <ucontext.h> (for use in - signal processing). - -2005-01-12 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * configure.ac: If configure is invoked with --enable-snmp, but - the configure script is unable to find SNMP support on the platform, - then configure should give an error message and exit. - -2005-01-12 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * redhat/quagga.spec.in: Pass --enable-gcc-rdynamic to configure - to get gcc to link with -rdynamic for better backtraces. - When the rpm is upgraded, the restart logic now works as follows: - 1. stop watchquagga; 2. stop all routing daemons; 3. restart zebra - if it was running; 4. start all routing daemons that were running; - and 5. start watchquagga if it was running. - -2005-01-07 Paul Jakma <paul@dishone.st> - - * configure.ac: Bump version to 0.98.0 - -2005-01-05 Paul Jakma <paul@dishone.st> - - * configure.ac: Bump version to 0.97.5 - -2005-01-04 Greg Troxel <gdt@fnord.ir.bbn.com> - - * configure.ac: Use AC_MSG_CHECKING/AC_MSG_RESULT around - CMSG_FIRSTHDR check, so it shows up in the output of configure. - Tested on NetBSD, which doesn't define HAVE_BROKEN_CMSG_FIRSTHDR. - -2005-01-04 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * configure.ac: Added test for broken CMSG_FIRSTHDR macro - (relevant for Solaris 8 and unpatched Solaris 9, don't know - whether other platforms are affected). - -2005-01-04 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * NEWS: Note improved logging facilities. - -2004-12-29 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * configure.ac: Add new option --enable-gcc-rdynamic to link - with -rdynamic. - -2004-12-23 Paul Jakma <paul@dishone.st> - - configure.ac: Bump version to 0.97.4 - -2004-12-22 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * redhat/quagga.spec.in: daemonv6_list should contain only IPv6 daemons. - -2004-12-22 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * redhat/quagga.spec.in: Add watchquagga, and fix some other - logic to make sure that all daemons are restarted on upgrades - and stopped on package removal. - -2004-12-22 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * redhat/quagga.sysconfig: Define some variables to support watchquagga. - -2004-12-22 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * configure.ac: Add a define for DAEMON_VTY_DIR in config.h. - -2004-12-22 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * {configure.ac,Makefile.am}: Build watchquagga by default. - -2004-12-21 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * NEWS: Note addition of watchquagga. - * HACKING: Note that watchquagga is in testing phase. - -2004-12-21 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * watchquagga: New watchquagga daemon. - -2004-12-21 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * redhat/Makefile.am: Added watchquagga.init to EXTRA_DIST. - -2004-12-21 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * redhat/watchquagga.init: New file, init script for watchquagga. - -2004-12-03 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * HACKING: Indicate that header files should be consulted for - documentation, particularly logging levels in lib/log.h. - -2004-11-24 Paul Jakma <paul@dishone.st> - - * TODO: Add source routing, zebra filtering and lib/ documenting. - -2004-11-19 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * global: Replace strerror with safe_strerror. And vtysh/vtysh.c - needs to include "log.h" to pick up the declaration. - -2004-11-19 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Avoid regeneration of doc/quagga.info for now. - -2004-11-17 Paul Jakma <paul@dishone.st> - - * INSTALL.quagga.txt: texinfo version corrected, so section on - that 4.7-x being unknown is not needed. - -2004-11-12 Paul Jakma <paul@dishone.st> - - * configure.ac: Fix AC_CONFIG_FILES, the chmod seems to run for - every input file, should be only be for vtysh/extract.pl, so that - should be a seperate AC_CONFIG_FILES. - * INSTALL: update-autotools, autoreconf -i will install this, remove - the file so it always matches the autoconf which created - configure (ie the quagga snapshot producing host). - * INSTALL.quagga.txt: Some quagga specific INSTALL notes. - * README: s/GNU Zebra/Quagga/ and refer to IS-IS support. - -2004-11-10 Andrew J. Schorr <ajschorr@alumni.princeton.edu> - - * redhat/quagga.spec.in: add comments showing how to get gcc verbosity - -2004-11-08 Paul Jakma <paul@dishone.st> - - * configure.ac: bump version to 0.97.3, release imminent. - -2004-11-06 Paul Jakma <paul@dishone.st> - - * configure.ac: Arguments to AC_OUTPUT is deprecated, use - AC_CONFIG_FILES instead. Rearrange the order slightly to put the - Makefiles first (silly aesthetic thing, dont know why I had to do - this ;) ). Add doc/defines.texi to the list. - * NEWS: bgp route-server support added, refer to docs. - * update-autotools: call automake with --add-missing and --copy, - former is important for obvious reasons, latter for dist files, - and --gnu to enable whatever extra goodness checks. - * {depcomp, install-sh, missing}: removed, auto-generated files. - -2004-11-05 Paul Jakma <paul@dishone.st> - - * HACKING: Expand on ChangeLogs, eg current practice for certain - directories and certain other meta-data is not to maintain a - ChangeLog. Expand on the commit message, IMHO, commit message - should always be ChangeLog for files where ChangeLog is kept. - Solaris is supported on any platform (with, at moment, an - additional patch). - -2004-10-23 Paul Jakma <paul@dishone.st> - - * configure.ac: bump version to 0.97.2, release imminent. - -2004-10-22 Paul Jakma <paul@dishone.st> - - * configure.ac: fix up enable help alignment slightly - Add --enable-gcc-ultra-verbose to set various gcc warnings which - should one day be fixed but are not serious problems or which - could be false-positives. - -2004-10-19 Andrew J. Schorr <aschorr@telemetry-investments.com> - - * lib, zebra, ripd, ospfd, bgpd: Support NULL connected destination - pointers properly everywhere. Fix point-to-point logic to - support links where a dedicated subnet has been assigned. - PtP links with /31 subnets should now work where supported by O/S. - -2004-10-11 Paul Jakma <paul@dishone.st> - - * bump version to 0.97.1, release imminent. - -2004-10-07 Paul Jakma <paul@dishone.st> - - * bump version to 0.97.0, release imminent. - -2004-10-07 Greg Troxel <gdt@sunpal7.mit.edu> - - * configure.ac: remove -Wpacked; 2.95.3 doesn't support it. - -2004-10-05 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Removed -Wpadded. I don't have sooo much time that I - could care about padding ;). - -2004-09-30 Paul Jakma <paul@dishone.st> - - * Update default CFLAGS for gcc to keep Hasso busy. - -2004-09-27 Paul Jakma <paul@dishone.st> - - * update-autotools: libtoolize should copy files, rather than link. - the whole idea is that dist files should not need auto*, etc. - installed to be able to compile. - -2004-09-13 Hasso Tepper <hasso at quagga.net> - - * configure.ac: Disable isisd compiling by default. - -2004-09-13 Paul Jakma <paul@dishone.st> - - * configure.ac: capitalise the package name. autoconf lowercases - it for PACKAGE_TARNAME. - -2004-09-13 Jose Luis Rubio <jrubio@dit.upm.es> - (at Technical University of Madrid as part of Euro6ix Project) - - Enhanced Route Server functionality and Route-Maps: - - * bgpd/bgpd.h: Modified 'struct peer' and 'struct bgp_filter' to - support rs-clients. A 'struct bgp_table *rib' has been added to the - first (to mantain a separated RIB for each rs-client) and two new - route-maps have been added to the last (for import/export policies). - Added the following #defines: RMAP_{IN|OUT|IMPORT|EXPORT|MAX}, - PEER_RMAP_TYPE_{IMPORT|EXPORT} and BGP_CLEAR_SOFT_RSCLIENT. - - * bgpd/bgpd.c: Modified the functions that create/delete/etc peers in - order to consider the new fields included in 'struct peer' for - supporting rs-clients, i.e. the import/export route-maps and the - 'struct bgp_table'. - - * bgpd/bgp_route.{ch}: Modified several functions related with - receiving/sending announces in order to support the new Route Server - capabilities. - Function 'bgp_process' has been reorganized, creating an auxiliar - function for best path selection ('bgp_best_selection'). - Modified 'bgp_show' and 'bgp_show_route' for displaying information - about any RIB (and not only the main bgp RIB). - Added commands for displaying information about RS-clients RIBs: - 'show bgp rsclient (A.B.C.D|X:X::X:X)', 'show bgp rsclient - (A.B.C.D|X:X::X:X) X:X::X:X/M', etc - - * bgpd/bgp_table.{ch}: The structure 'struct bgp_table' now has two - new fields: type (which can take the values BGP_TABLE_{MAIN|RSCLIENT}) - and 'void *owner' which points to 'struct bgp' or 'struct peer' which - owns the table. - When creating a new bgp_table by default 'type=BGP_TABLE_MAIN' is set. - - * bgpd/bgp_vty.c: The commands 'neighbor ... route-server-client' and - 'no neighbor ... route-server-client' now not only set/unset the flag - PEER_FLAG_RSERVER_CLIENT, but they create/destroy the 'struct - bgp_table' of the peer. Special actions are taken for peer_groups. - Command 'neighbor ... route-map WORD (in|out)' now also supports two - new kinds of route-map: 'import' and 'export'. - Added commands 'clear bgp * rsclient', etc. These commands allow a new - kind of soft_reconfig which affects only the RIB of the specified - RS-client. - Added commands 'show bgp rsclient summary', etc which display a - summary of the rs-clients configured for the corresponding address - family. - - * bgpd/bgp_routemap.c: A new match statement is available, - 'match peer (A.B.C.D|X:X::X:X)'. This statement can only be used in - import/export route-maps, and it matches when the peer who announces - (when used in an import route-map) or is going to receive (when used - in an export route-map) the route is the same than the one specified - in the statement. - For peer-groups the statement matches if the specified peer is member - of the peer-group. - A special version of the command, 'match peer local', matches with - routes originated by the Route Server (defined with 'network ...', - redistributed routes and default-originate). - - * lib/routemap.{ch}: Added a new clause 'call NAME' for use in - route-maps. It jumps into the specified route-map and when it returns - the first route-map ends if the called RM returns DENY_MATCH, or - continues in other case. - -2004-08-31 Greg Troxel <gdt@poblano.ir.bbn.com> - - * Makefile.am: make m4 as subdir, rather the EXTRA_DISTing it - - * configure.ac: add m4/Makefile to output list - -2004-08-31 Greg Troxel <gdt@poblano.ir.bbn.com> - - * Makefile.am: Only put pkgsrc dir in SUBDIRS if we should install - rc.d files. (Note that pkgsrc is always in DIST_SUBDIRS.) - - * configure.ac (pkgsrcdir): add new --enable-pkgsrcrcdir to give a - directory into which www.pkgsrc.org-style rc.d files are - installed. - -2004-08-19 Paul Jakma <paul@dishone.st> - - * Makefile.am: add m4 directory to EXTRA_DIST, and define - ACLOCAL_AMFLAGS to have aclocal pull in m4/ - * configure.ac: AM_PROG_LIBTOOL should be AC_... - * update-autotools: print a warning that this script is deprecated - -2004-08-17 Greg Troxel <gdt@fnord.ir.bbn.com> - - * update-autotools: print tools versions to aid people in sending - bug reports. - -2004-07-23 Greg Troxel <gdt@poblano.ir.bbn.com> - - * */Makefile.am: Use ../dir/libfoo.la, rather than "-L../dir - -lfoo", to avoid linking against installed libraries from a - previous version. - - * {lib,ospfd,ospfclient}/Makefile.am: explicitly define the shared - library version number to be 0.0 - - * configure.ac: remove spurious , so extract.pl is chmod'd +x. - - * HACKING: explain shared library versioning rules - -2004-07-22 Paul Jakma <paul@dishone.st> - - * configure.ac: modify default CFLAGS to be compiler agnostic - build Makefile for tests/ subdir. - -2004-07-14 Greg Troxel <gdt@poblano.ir.bbn.com> - - * Makefile.am (EXTRA_DIST): Add missing \, so tools stuff is - really in distfile. - -2004-06-30 Greg Troxel <gdt@poblano.ir.bbn.com> - - * */Makefile.am: use -L../lib -lzebra, so we pick up the shlib - version of libzebra when available. - - * configure.ac, update-autotools: Add libtool. - -2004-06-30 Greg Troxel <gdt@poblano.ir.bbn.com> - - * Makefile.am: add files to EXTRA_DIST rather than copying, and - omit the kludgy cleaning steps, which were failing when the list - to clean was empty. - -2004-06-30 Greg Troxel <gdt@poblano.ir.bbn.com> - - * configure.ac: Look for perl, and substitute into vtysh/extract.pl. - Search for termcap functions more expansively (fixes vtysh compile - on NetBSD). Clean up --enable-vtysh definition. - -2004-06-30 Greg Troxel <gdt@poblano.ir.bbn.com> - - * update-autotools: Use -rf on autom4te.cache. - -2004-06-20 Hasso Tepper <hasso@estpak.ee> - - * lib/vty.c: Don't attempt to load configuration file from current - directory. - * Update vty_read_config() calls in bgpd/bgp_main.c, isisd/isis_main.c, - ospf6d/ospf6_main.c, ospfd/ospf_main.c, ripd/rip_main.c, - ripngd/ripng_main.c and zebra/main.c. - -2004-05-11 Paul Jakma <paul@dishone.st> - - * configure.ac: Add solaris support for the zebra/*_solaris - method's, based on Sowmini's patches. - -2004-04-08 Paul Jakma <paul@dishone.st> - - * ospf_spf.h: Add backlink field to struct vertex - * ospf_spf.h: (ospf_vertex_new) initialise backlink - (ospf_lsa_has_link) return index of link back to - vertex V from candidate vertex W, or -1 if no link exists. - (ospf_spf_next) save backlink index for candidate vertex - * ospf_interface.c: (ospf_vl_set_params) Use the backlink index - to determine correct address for virtual-link peers. Fall back - to older "pick first link" method if no backlink index exists. - -2004-04-06 Hasso Tepper <hasso@estpak.ee> - - * zebra/ipforward_proc.c: Fixed lowering privileges. - * zebra/zserv.c: Fixed "(no) ipv6 forwarding" command logic. - * configure.ac: Added --disable-capabilities switch to configure. - -2004-03-22 Hasso Tepper <hasso@estpak.ee> - - * Readded SIGTERM handling so daemons can clean up their stuff if they - are killed (not murdered). - -2004-03-20 Michael Bruening <mike@vailsys.com> - - * ospfd/ospf_vty.c: Completed array distribute_str of route types with - addition of "isis". This array must be indexed by - ZEBRA_ROUTE_(SYSTEM|KERNEL|...) defines in zebra.h, and should - be updated with every route type addition. This fix allows - commands redistributing routes from (bgp|isis), like "router ospf - redistribute bgp ...", to be written to terminal, memory, file, - which would otherwise result in a seg fault or, possibly, config - file corruption. Overlooked in import of isisd. - * Similar fixes to bgpd/bgp_vty.c ospf6d/ospf6_asbr.c ripd/rip_zebra.c - and ripngd/ripng_zebra.c. - -2004-03-17 Jean-Yves Simon <lethalwp@tiscali.be> - - * zebra/main.c, ripd/rip_main.c: Fix typos sigusr1 -> sigint, - bugzilla #82. - -2004-03-16 David Young <dyoung@pobox.com> - - * (many) reference <lib/version.h> rather than "version.h", - because version.h is a generated file and not present in the - source tree when using objdir builds. - -2004-03-03 PC Drew <pc@superiorcomm.net> - - * lib/keychain.c: typecast time_t function to long, fixes compile - warning. - * lib/debug.c: wrapped function with ifdef HAVE_GLIBC_BACKTRACE fixes - compile warning when backtrace doesn't exist for that system. - * zebra/rtadv.c: for OpenBSD, added include statement for - netinet/icmp6.h - * zebra/zserv.c: added default case to switch statements, fixes compile - warning about certain NEXTHOP_TYPE enumeration values not being - handled. - * zebra/rt_socket.c: set *mask = NULL by default, fixes compile - warning, about mask possibly being used uninitialized. - * bgpd/bgp_nexthop.c: added default case to switch statements, fixes - compile warning about certain NEXTHOP_TYPE enumeration values not - being handled. - * ospfd/ospf_spf.c: typecast time_t to long, fixes compile warning. - * ospfd/ospf_route.c: typecast route_node->prefix to prefix_ipv4, fixes - compile warning. - * ospfd/ospf_route.c: typecast prefix_ipv4 to prefix, fixes compile - warning. - * ospfd/ospf_abr.c: typecast prefix to prefix_ipv4 in two instances, - fixes compile warning. - * vtysh/vtysh.c: fixed null pointer sentinel value when doing execl and - friends, fixes compile warning. - * ospf6d/ospf6_damp.c: typecast time_t to long in 4 instances, fixes - compile warning. - * ospf6d/ospf6_main.c: use MAXPATHLEN (if set) instead of 64 for the - _cwd array, fixes compile warning. - -2004-01-19 Paul Jakma <paul@dishone.st> - - * tests/test-sig.c: New file, regression test for sigevents. - * lib/Makefile.am: add sigevent.{c,h} - * (isis|rip|ripng|ospf|ospf6|bgp)d/\1_main.c: modify for sigevents. - * zebra/main.c: ditto. - -2004-01-10 Paul Jakma <paul@dishone.st> - - * Makefile.am: redhat/ is a dist subdir too. - -2004-01-10 Vincent Jardin <jardin@6wind.com> - - * configure.ac: add the redhat/Makefile as a AC_OUTPUT() argument. - It fixes build on FreeBSD 5.1 and FreeBSD 4.7 - -2004-01-08 Paul Jakma <paul@dishone.st> - - * Makefile.am: as per gdt, specify the redhat dir as a DIST_SUBDIR, - remove the redhat/... dist targets - instead these now go in.. - redhat/Makefile.am: (new) proper place to describe redhat/ dist - files, as well as allow quagga.spec to be regenerated properly. - redhat/quagga.sysconfig: specify conf file location. - redhat/quagga.spec.in: Add 2 patches to RPM build. - -2003-12-30 Paul Jakma <paul@dishone.st> - - * redhat/isisd.init: new file, init script for isisd. - redhat/quagga.sysconfig: new file, sysconfig file for quagga - initscripts. - redhat/quagga.spec.in: various cleanups, including sysconfig patch - from RH, fixed UID/GID as per RH EL, shell changed to - /sbin/nologin, daemon vty's listen to 127.1 only per default and - isisd packaged. - redhat/*.init: sysconfig support and runlevels specified. - -2003-12-30 Paul Jakma <paul@dishone.st> - - * Makefile.am: put the redhat/ stuff into EXTRA_DIST rather than - copying via dist-hook. Remove ~ files backup cruft from dists. - isisd/Makefile.am: sysconf example should go via - dist_examples_DATA. The include-netbsd/ headers werent mentioned - as sources and werent being copied into dists. - -2003-12-23 Vincent Jardin <jardin@6wind.com> - - * isisd: Import isisd from Sampo Saaristo's source code. - -2003-12-22 Christian Hammers <ch@lathspell.de> - - * configure.ac (and everywhere a regular file is opened for - writing): use file permissions from configure rather than - compiled-in umask. - -2003-12-22 Hasso Tepper <hasso@estpak.ee> - - * lib/linklist.c: Revert microfix I commited while reverting - [quagga-dev 227]. Caused by misreading code. - -2003-12-21 Hasso Tepper <hasso@estpak.ee> - - * lib/linklist.c: Revert patch [quagga-dev 227]. listnode_add_sort() - function should not drop nodes in any case. But fix behavior where - nodes were added to the end of list when cmp returned 0. - * lib/if.c: Check for duplicates before calling listnode_add_sort(). - -2003-12-08 Greg Troxel <gdt@fnord.ir.bbn.com> - - * {lib,ospfd,ospfapi}/Makefile.am: Use pkginclude_HEADERS rather - than include_HEADERS to place includes in - ${prefix}/include/quaggainstead of polluting ${prefix}/include. - -2003-12-04 Greg Troxel <gdt@poblano.ir.bbn.com> - - * configure.ac: When setting exampledir to sysconfdir as a - default, don't quote ${sysconfdir}. (Bug reported by Vincent - Jardin.) - -2003-12-03 Greg Troxel <gdt@poblano.ir.bbn.com> - - * configure.ac: Compile in Router Advertisement support by - default. Note that this does not default to sending RAs; it just - makes 'ipv6 nd send-ra' and 'ipv6 nd prefix-advertisement' - available. While others may prefer other tools, no argument has - been made that router advertisement support is such bloat that it - should be compiled out by default (it 9556 bytes on NetBSD/i386 vs - 8 bytes with the support compiled out). This reversion of a - previous change was done in consultation with Paul. - -2003-12-03 Greg Troxel <gdt@poblano.ir.bbn.com> - - * configure.ac: Move tests for v6 header files to after the check - for v6 code version, and conditionalize on the right variable. - (Fixes problem where v6 header files are not included when v6 is - enabled implicitly.) - -2003-12-03 Greg Troxel <gdt@poblano.ir.bbn.com> - - * configure.ac: Add --enable-exampledir to specify where example - config files should go, defaulting to sysconfdir. - - * */Makefile.am: use exampledir instead of sysconfdif for examples - -2003-11-02 Paul Jakma <paul@dishone.st> - - * bgpd/bgp_routemap.c: Fix up 'set ip next-hop A.B.C.D|peer-address' - route map command so that vtysh can use it. Modified version of - Hasso Tepper's patch. Fixes bug #52. - * configure.ac: FreeBSD has net-snmp in /usr/local. - * redhat/quagga.spec.in: Install libzebra headers with -devel - package. - -2003-11-02 Krzysztof Oledzki <oleq@ans.pl> - - * zebra/zebra_rib.c: Revert patch (dating from zebra.org) which - caused zebra to read all routes in all tables, rather than just - the main table. See [quagga-dev 280]. - -2003-10-30 Paul Jakma <paul@dishone.st> - - * configure.ac: netinet/in_systm.h is yet another well-known - header file we really should be checking for - -2003-10-27 kamatchi soundaram <kamatchi@tdd.sj.nec.com> - - * ospfd/ospfd.c: Do not increment act_int for an area, as it is done - by ospf_ism.c::ism_change_state() - results in incorrect figure - for active interfaces in an area. - -2003-10-27 Paul Jakma <paul@dishone.st> - - * lib/if.{ch}: remove ifc_pointtopoint() - left over from the - reverted RFC3021 patch. - -2003-10-27 Simon <lists@routemeister.net> - - * ospfd/ospfd.c: if_is_pointopoint() takes (struct interface *), was - being called with struct connected. Change to co->ifp. - -2003-10-27 Gilad Arnold <gilad.arnold@terayon.com> - - * zebra/zebra_rib.c: (nexthop_active_update) Check for multipath - limit when setting changed flag to avoid spurious changes. - (static_install_ipv{4,6}) dont uninstall by default, might not be - required - avoid spurious uninstalls. - (static_uninstall_ipv{4,6}) only uninstall the route if its - actually FIB route. - -2003-10-24 sowmini.varadhan@sun.com - - * ospfd/ospf_network.c: (ospf_sock_init) Exit if socket can not be - created. - -2003-10-24 Jose Luis Rubio Guivernau <jrubio@dit.upm.es> - - * Better 'show bgp' support for views (eg ipv6), see [quagga-dev 238] - * bgpd/bgp_route.c: (bgp_show) Take a struct bgp argument instead of - view string. - (bgp_show_neighbor_route) Take a struct peer argument instead of - ip string. - (peer_adj_routes) ditto - (show_adj_routes) ditto - (peer_lookup_in_view) new function to return appropriate struct - peer for a given view string. - (misc) Fixup all calls to above to reflect new calling arguments, - and use peer_lookup_in_view as needed. Additional commands - installed to use expanded functionality above, existing commands - modified to suit as well. - * bgpd/bgp_vty.c: 2 new aliases. - -2003-10-24 Paul Jakma <paul@dishone.st> - - * configure.ac: Check for fcntl() - * {bgpd,ospf,ospf6d,ripd,ripngd}/Makefile.am: Install conf file via - regular automake means, not magic install incantations, see - bug #38. - * lib/Makefile.am: install the headers, needed to link libzebra.a - (and hence libospf.a, OSPF-API, etc.) - -2003-10-24 waldi@debian.org - - * vtysh/Makefile.am: vtysh_cmd.c rebuild was broken because it - depended against source files without specification, i.e. it - used ../zebra instead of $(top_srcdir)/zebra. - -2003-10-23 Paul Jakma <paul@dishone.st> - - * configure.ac: IRIX configure.ac support. Sort of works. - sysctl() crashes though (ipforward), there's some kind of odd - padding in the PF_ROUTE socket messages and setsockopt() on - SOCK_RAW does not work (so ospfd doesnt work). - -2003-10-22 Paul Jakma <paul@dishone.st> - - * vtysh/Makefile.am: do not include vtysh_cmd.c in dists, its - configure dependent. (still need to find a way to make building of - it dependent on configure options or include all commands.) - -2003-10-22 Paul Jakma <paul@dishone.st> - - * lib/zebra.h: include limits.h if its there, its a portable header - and useful and not just solaris specific. net/route.h is also - useful. - -2003-10-22 Paul Jakma <paul@dishone.st> - - * lib/regex.c: bzero -> memset - * zebra/ioctl.c: ditto. bzero is not portable. - -2003-10-22 Paul Jakma <paul@dishone.st> - - * zebra/kernel_socket.c: HAVE_IPV6 conditional for WRAPUP when - HAVE_SA_LEN is not defined. bcopy -> memcpy, bcopy is not - portable. - -2003-10-22 Paul Jakma <paul@dishone.st> - - * configure.ac: Split up header checks into non-net, net and ipv6 - related. Checking of IPv6 is conditional. Add some more output - text for the end of the configure run. - -2003-10-18 Lorenzo Colitti <lorenzo@ripe.net> - - * bgpd/bgp_attr.c: (bgp_dump_routes_attr) Dont dump IPv4 nexthop - for IP. Dump MP_NLRI attr with IPv6 next-hop for AF_INET6 address - family prefixes. Accept prefix as argument. - * bgpd/bgp_attr.c: modify bgp_dump_routes_attr declaration. - * bgpd/bgp_dump.c: (bgp_dump_routes_entry) Modify calls to - bgp_dump_routes_attr. - (bgp_dump_common) Go by the family of the peering socket, not - configured address family when dumping peering information. - Add HAVE_IPV6 conditionals, eg missing from previous bgp interval - patch. - -2003-10-18 Lorenzo Colitti <lorenzo@ripe.net> - - * bgpd/bgp_dump.{c,h}: (bgp_dump_interval_add) Dump at discrete - fixed intervals rather than fixed intervals from startup time. - (bgp_dump_interval_func) Dont return immediately if file cant be - openeded, but reschedule interval dumps, even - admin might - fix problem in meantime. Close the dump file in between intervals. - (bgp_dump_init) account for MSG header when initialising stream - size. - -2003-10-15 Paul Jakma <paul@dishone.st> - - * ospfd/ospf_interface: (ospf_if_lookup_table) new function to - lookup oi for a given prefix in a given interfaces table of oi's. - (ospf_if_new) use ospf_if_lookup_table to deal with zebra - reporting new interface multiple times. - NB: This patch is a complete plaster-band of a hack. First, why is - zebra reporting interface events multiple times? Second, why does - ospfd maintain so many damn lists and tables relating to oi's - - these should be reconciled into one or two tables. - -2003-10-15 sowmini.varadhan@sun.com - - * ripd/ripd.c: (rip_send_packet) use rip->sock for mcast sends, - instead of creating one socket per send. send source addr to - rip_update_interface. - (rip_update_process) should send an update on every connected - network for each interface. - (rip_request_send) should send a request on every connected - network for each interface. - * ripd/ripd.h: update prototype for rip_interface_multicast_set - * ripd/rip_interface.c: (rip_interface_multicast_set) reorganized - so that it can be called repeatedly for aliased interfaces (on - multiple networks). - -2003-10-15 Jay Fenlason <fenlason@redhat.com> - - * lib/vty.c: (vty_telnet_option) Remote DoS exists if a telnet - end-sub-negotation is sent when no sub-negotation data has been - sent. Return immediately if no sub-negotation is in progress. - (vty_read) do not attempt to process options if no sub-negotation - is in progress. - -2003-10-15 Paul Jakma <paul@dishone.st> - - * lib/vty.c: (vty_save_cwd) dont crash if getcwd fails. try fallback - to SYSCONFDIR. Allocate cwd from the stack rather than relying on - (non-portable) getcwd() allocation (which we didnt seem to be - freeing). - -2003-10-13 Jay Fenlason <fenlason@redhat.com> - - * lib/zebra.h: define UINT32_MAX for those systems which do not - provide it. - * bgp_attr.h: define BGP_MED_MAX. - * bgp_route.c: update defines/constants to BGP_MED_MAX. - * bgp_routemap.c: ditto. clean up route_match_metric_compile - slightly to avoid unneccesary XMALLOC. - -2003-10-13 sowmini.varadhan@sun.com - - * ospf_lsa.h: Add OSPF_LSA_PREMATURE_AGE flag. - * ospf_lsa.c: added better debug comments. check sequence number in - ospf_lsa_install. ospf_maxage_lsa_remover() checks for - OSPF_LSA_PREMATURE_AGE and re-originates the lsa after ls_acks are - received. - * ospf_flood.c: improve debug statement- print ls_seqnum. - -2003-10-13 Douglas Fraser <doug+quagga@idmf.net> - - * zebra/connected.c: PtP revert fixup. Zebra was not creating - connected route for PtP peer. - -2003-10-07 Tarhon-Onu Victor <mituc@iasi.rdsnet.ro> - - * zebra/ipforward_proc.c: (ipforward) Close the fd for - /proc/net/snmp. See [quagga-dev 284] - -2003-09-29 Gilad Arnold <gilad.arnold@terayon.com> - - * zebra/zebra_rib.c: Fix possible dangling reference to rib - route_nodes - unlock it the appropriate number of times. (twice, - because of the implicit lock). see [quagga-dev 251]. - -2003-09-29 Paul Jakma <paul@dishone.st> - - * zebra/connected.c: revert the 'generic PtP' patch as it causes - far too many problems. People who use FreeSWAN should investigate - native linux ipsec. - * zebra/rt_netlink.c: ditto - * lib/if.c: ditto - * ripd/ripd.h: ditto - * ripd/ripd.c: ditto - * ripd/rip_interface.c: ditto - * ospfd/ospfd.c: ditto - * ospfd/ospf_snmp.c: ditto - * bgpd/bgp_nexthop.c: ditto - * ospfd/ospf_packet.c: Add debug output for some of the previously - completely silent drops of 'bad' packets. - * configure.ac: bump version - -2003-08-27 Jay Fenlason <fenlason@redhat.com> - - * lib/Makefile.am: Do not use a lib (libcap) as a dependency - * zebra/Makefile.am: Link in libcap - * bgpd/bgp_routemap.c: attr->med is type u_in32_t, should be - compared with UINT32_MAX - * ospfd/ospfd.c: remove redundant assert - * zebra/rtadv.c: add missing include for zebra/rib.h - -2003-09-24 Paul Jakma <paul@dishone.st> - - * lib/version.h: moved to version.h.in - * lib/version.h.in: New file, from version.h. Change hardcoded - package name and version to use the autoconf defined substition - variables. - * configure.ac: Fix up AC/AM_INIT* to new style. Remove the sed'ing - through lib/version.h for VERSION. Add lib/version.h to the - AC_OUTPUT list. Update the text output of quagga version at end - of configure run to use PACKAGE_VERSION. - * doc/.cvsignore: ignore quagga.pdf - * doc/.cvsignore: ignore version.h, its now autogenerated. - -2003-09-24 sowmini.varadhan@sun.com - - * lib/if.c: (if_cmp_func) fix infinite loop if - ifp1->name == ifp2->name - * lib/linklist.c: (if_cmp_func) Fix handling of case where - list->cmp returns 0. - * rip_interface.c: (rip_interface_address_add) call - rip_enable_apply(), or the interface is never considered up. - see [quagga-dev 225]. - * zebra/kernel_socket.c: Fix up WRAPUP macro to deal with multiple - address families in the absence of sa_len element in struct - sockaddr. - (ifm_read): Handle solaris 9 if_msghdr_t. - Deal with interfaces which are incomplete, lookup on name rather - than the placeholder interface index of -1. - -2003-09-24 Thomas Giger TGC <thomas.giger@tgc.de> - - * ospf_packet.c (ospf_associate_packet_vl): pass NULL struct - interface to ospf_if_lookup_by_local_addr() rather than the - receiving interface ifp, packets for VL's could come in any - interface. See quagga-dev 250. - -2003-04-13 Paul Jakma <paul@dishone.st> - - * Amir: Opaque LSA bug fix for deletion of Type11's - * configure.ac: use --localstatedir for Unix sockets - * Hasso Tepper: When flushing as-ext LSAs flush associated NSSA - LSAs. - -2003-04-04 Paul Jakma <paul@dishone.st> - - * Sync to Zebra CVS - * Fix lib/thread.h leak - * Fix small Opaque LSA leak - * Do not configure OSPF interfaces for secondary addresses - * vtysh fixes from Hasso - * Dave Watson's missing ntohs fix - -2003-03-25 Paul Jakma <paul@dishone.st> - - * Sync to Zebra CVS - -2003-03-17 Amir Guindehi <amir@datacore.ch> - - * Extended SNMP checks in configure.ac so that net-snmp works - -2003-03-17 Amir Guindehi <amir@datacore.ch> - Ralph Keller <keller@tik.ee.ethz.ch> - * merge OSPF-API - -2003-02-07 Paul Jakma <paul@dishone.st> - - * Sync to zebra CVS - -2003-02-03 Paul Jakma <paul@dishone.st> - - * Sync to zebra CVS - -2003-01-19 Paul Jakma <paul@dishone.st> - - * Temporary fix for Generic PtP wrt to IPv6 - -2003-01-17 Paul Jakma <paul@dishone.st> - - * Sync up to latest zebra.org CVS - * [zebra 16823] Bugfix and new feature in Opaque-LSA handling - Masahiko Endo <endo@suri.co.jp> - * [zebra 16824] [PATCH] nsm_kill_neighbor - Masahiko Endo <endo@suri.co.jp> - * [zebra 17217] [PATCH] show thread CPU - Yon Uriarte <havanna_moon@gmx.net> - * [zebra 17218] Re: [PATCH] CLI extensions. - Yon Uriarte <havanna_moon@gmx.net> - -2002-12-13 Paul Jakma <paul@dishone.st> - - * added support for vtysh 'write file' command to - write either per-daamon and/or integrated file - * ospfd md5 buffer copying fix (Greg Troxel) - * ospfd md5 sequence number derived from time() - * RIPv1 fixes and improvements (John Hay) - * link state detection (linux) ([zebra 12269]) - * Generic PtP and RFC3021 interface addressing support - (Frank van Maarseveen) - * Michal Ludvig <michal@logix.cz>: - [zebra 16525] PATCH: Bugfixes for KAME systems - * Kevin C Miller <kevinm@andrew.cmu.edu> - [zebra 16681] OSPF NSSA Patches - * Yon Uriarte <havanna_moon@gmx.net> - [zebra 16671] [PATCH] CLI extensions - * Masahiko Endo: [zebra 15475] - MPLS-TE docs - -2002-07-07 Kunihiro Ishiguro <kunihiro@ipinfusion.com> - - * zebra-0.93 released. - -2002-06-28 Kunihiro Ishiguro <kunihiro@ipinfusion.com> - - * update-autotools: Change file name from update-auto-tools.sh. - -2002-06-21 Kunihiro Ishiguro <kunihiro@ipinfusion.com> - - * update-auto-tools.sh: Add a new script to clean up build - environment. - -2002-06-18 Kunihiro Ishiguro <kunihiro@ipinfusion.com> - - * Shift to the latest build environment autoconf-2.53 and - automake-1.6.2. - -2001-10-22 Kunihiro Ishiguro <kunihiro@ipinfusion.com> - - * Integrate Glen Turner <glen.turner@aarnet.edu.au>'s pid option. - -2001-08-19 Kunihiro Ishiguro <kunihiro@ipinfusion.com> - - * zebra-0.92a released. - -2001-08-19 "Peter Galbavy" <peter.galbavy@knowtion.net> - - * configure.in: SNMP library check problem fix when the library is - installed under /usr/local/lib. - -2001-08-15 Kunihiro Ishiguro <kunihiro@ipinfusion.com> - - * zebra-0.92 released. - -2001-04-22 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in (LIBPAM): Use ZEBRA_AC_C_BIGENDIAN to avoid a - warning. - (IF_METHOD): Use test -r instead of AC_CHECK_FILE to avoid - warnings. - - * config.guess: Update to 2000-11-10 version. - -2001-04-11 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Use AC_TRY_COMPILE instead of AC_EGREP_HEADER to - detect in_pktinfo structure. Suggested by: Vlad Lungu - <vlad@rls.roknet.ro>. - -2001-03-07 Michael Rozhavsky <mrozhavsky@opticalaccess.com> - - * configure.in: Add check for structure in_pktinfo. - -2001-02-07 "Bjoern A. Zeeb" <bzeeb+zebra@zabbadoz.net> - - * configure.in (USE_PAM): Fix PAM library detection code. - -2001-02-01 Kunihiro Ishiguro <kunihiro@zebra.org> - - * zebra-0.91 is released. - -2001-01-12 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Remove guile related definition. - -2001-01-11 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in (ac_cv_htonl_works): HAVE_REPAIRABLE_HTONL is - removed. htonl should work fine on any platform. - -2001-01-10 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Remove --enable-oldrib option. - - * acconfig.h: OLD_RIB definition is removed. - - * zebra-0.90 is released. - - * configure.in (LIBS): Add check for sun_len field in struct - sun_len. - -2001-01-09 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Makefile.am: Include init/redhat files to distribution. - -2001-01-07 Yasuhiro Ohara <yasu@sfc.wide.ad.jp> - - * configure.in: check libm.a for BGPd compile error. - AC_CHECK_LIB(m, main) was added. - -2000-12-29 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: --enable-unixdomain becomes default. Add - --enable-tcp-zebra for TCP/IP communication between protocol - daemon and zebra. - - * COPYING.LIB: Added for lib/getopt.c, lib/getopt.h, - lib/getopt1.c, lib/md5-gnu.h, lib/md5.c, lib/regex-gnu.h, - lib/regex.c. - - * Makefile.am (dist-hook): Include tools/*.cgi to distribution. - -2000-12-26 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in (MULTIPATH_NUM): --enable-multipath=ARG specify - multipath number. ARG must be digit. - -2000-12-11 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add --enable-newrib for test new RIB code. - -2000-11-25 Yasuhiro Ohara <yasu@sfc.wide.ad.jp> - - * configure.in, config.h.in: Add check for libutil.h and - setproctitle(). - -2000-10-26 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add --enable-nssa for OSPF NSSA option. - - * acconfig.h: Define HAVE_NSSA. - -2000-10-25 "Bjoern A. Zeeb" <bzeeb+zebra@zabbadoz.net> - - * configure.in: pam_misc is only linked when the platform is - GNU/Linux. - -2000-10-24 Arkadiusz Miskiewicz <misiek@pld.org.pl> - - * configure.in (LIBS): Add check for crypto library. test x`ls - ${ac_snmp}` is replaced with sipmle test -f. - -2000-10-23 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add --enable-unixdomain option. This will be - default behavior in zebra-0.90. - -2000-10-02 Kunihiro Ishiguro <kunihiro@zebra.org> - - * zebra-0.89 is released. - -2000-09-27 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add check for Intel CPU for Solaris on x86 check. - -2000-09-21 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add check for getifaddrs(). - Set AM_INIT_AUTOMAKE version to 0.89. - -2000-09-14 Kunihiro Ishiguro <kunihiro@zebra.org> - - * config.guess: Update to the latest version. - - * config.sub: Likewise - -2000-09-14 David Lipovkov <dlipovkov@OpticalAccess.com> - - * REPORTING-BUGS: New file is added. - -2000-08-27 itojun@iijlab.net - - * configure.in: Add ncurses library check when --enable-vtysh is - specified. - -2000-08-22 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add check for readline/history.h. - - * acconfig.h: Remove pthread related variables. - - * configure.in: Add --with-libpam option for vtysh PAM - authentication. Remove --disable-pthread because we don't support - pthread. - -2000-08-17 Kunihiro Ishiguro <kunihiro@zebra.org> - - * zebra-0.88 is released. - - * configure.in: Add Solaris -lcurses for vtysh. - -2000-08-02 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add check for ncurses for compiling on Solaris. - -2000-07-27 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add check for libreadline when --enable-vtysh is - specified. - -2000-07-23 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add AC_DEFINE(OPEN_BSD). When OS is OpenBSD - interface method is if_ioctl.o - -2000-07-09 Chris Dunlop <chris@onthe.net.au> - - * acconfig.h: Add HAVE_BROKEN_ALIASES. - - * configure.in: Add --enable-broken-aliases. - -2000-06-12 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to zebra-0.87. - -2000-06-05 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Remove --enable-mpls-vpn. Now MPLS-VPN support is - default. - - * Set version to zebra-0.87-pre - - * Makefile.am: Likewise. - -2000-04-27 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to 0.86. - -2000-03-21 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to 0.85b for ospfd test. - -2000-03-20 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to 0.85a for ospfd test. - -2000-03-08 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to 0.85. - -2000-01-26 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Makefile.in: Regenerated by patched automake for fixing "make - clean" problem on FreeBSD. - -1999-12-08 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to 0.83a. This is for *BSD static route lookup - problem. - -1999-12-06 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to 0.83. - -1999-11-29 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to 0.82. - -1999-11-23 Kunihiro Ishiguro <kunihiro@zebra.org> - - * aczebra.m4: New file added. - -1999-11-21 Michael Handler <handler@sub-rosa.com> - - * configure.in (LIBS): Add sa_len check of sockaddr. - - * acconfig.h: Add HAVE_SA_LEN. - -1999-11-12 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: Update version to zebra-0.81b for bgpd test. - -1999-11-09 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add --enable-mbgp. - -1999-11-05 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Makefile.am (EXTRA_DIST): Add TODO to the distribution. - -1999-11-04 Kunihiro Ishiguro <kunihiro@zebra.org> - - * TODO: New file is added. - -1999-11-03 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: Update version to zebra-0.81a for ospfd test. - -1999-10-28 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: New option --enable-snmp is added. - -1999-10-24 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: Update version to zebra-0.80. - -1999-10-21 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: Update version to zebra-0.80-pre3 - -1999-10-18 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in (LIBS): SNMP check is done by ucd-snmp/asn1.h. - -1999-10-10 Peter Galbavy <Peter.Galbavy@knowledge.com> - - * configure.in: Add support of OpenBSD. - -1999-10-04 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: Update version to zebra-0.80-pre2. - -1999-09-27 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: Update version to zebra-0.80-pre. From this version, - access-list and prefix-list's name space is divided into IPv4 and - IPv6. - -1999-09-17 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: For test recent fixes Set version to zebra-0.79a. - -1999-09-14 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: zebra-0.79 is out. - -1999-09-08 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: For ospfd's virtual link test. Set version to 0.78h. - -1999-09-07 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: For ospfd test. Set version to 0.78g. - -1999-09-05 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: For internal test of ospfd. Set version to 0.78f. - -1999-09-02 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: To test ospfd's fix, set version to 0.78e. - -1999-09-01 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: To test ospfd's area related bug fix, set version - to 0.78d. - -1999-09-01 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: To test ospfd, set version to 0.78c. - -1999-08-31 Janos Farkas <chexum@shadow.banki.hu> - - * Many misspelling correction. - -1999-08-31 Kunihiro Ishiguro <kunihiro@zebra.org> - - * version.h: To test ospfd, set version to 0.78b. - -1999-08-31 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in (LIBS): Add UCD-SNMP include path check. - -1999-08-31 Lars Fenneberg <lf@elemental.net> - - * configure.in: The logic which detects the UCD-SNMP library - should first check in the default system locations for the library - and then in /usr/local. - -1999-08-27 itojun@iijlab.net - - * configure.in (LIBS): Fix problem about libsnmp.a check. - -1999-08-26 kay <kay@v6.access.co.jp> - - * configure.in (CFLAGS): Add <sys/socket.h> to check socklen_t. - -1999-08-24 VOP <vop@unity.net> - - * filter.c: Include "sockunion.h". - plist.c: Likewise. - table.c: Likewise. - -1999-08-24 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add netinet6/in6.h check. - -1999-08-21 Masaki Minami <masaki@minami.org> - - * BSD/OS 4.0 porting. - -1999-08-15 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add --enable-netlink option to force to use Linux - netlink interface. - (CFLAGS): Add ucd-snmp library check. - - * acconfig.h: If socklen_t is not defined, typedef int to - socklen_t. - -1999-08-15 Arkadiusz Miskiewicz <misiek@misiek.eu.org> - - * configure.in: When --enable-ipv6 specified, then only kernel - version is checked. - -1999-08-14 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add GNU libc 2.1 check. - -1999-08-02 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Fix privious Linux IPv6 check changes. - -1999-08-02 Arkadiusz Miskiewicz <misiek@misiek.eu.org> - - * configure.in: Improve Linux IPv6 feature check. - -1999-07-29 Rick Payne <rickp@rossfell.co.uk> - - * Changed route-maps to behave in a more cisco-like fashion - -1999-07-27 Gerhard Poul <gpoul@gnu.org> - - * SERVICES: New file added. - -1999-07-12 itojun@iijlab.net - - * configure.in: Add check for getaddrinfo. Improve Kame related - library check. - -1999-07-07 Yasuhiro Ohara <yasu@sfc.wide.ad.jp> - - * configure.in, acconfig.h: Add check for FreeBSD 3.2. - -1999-07-07 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Delete check for netinet/ip6.h. - -1999-06-30 Gerhard Poul <gpoul@gnu.org> - - * README: remixed the old files and added some new parts. - moved some INSTALL stuff into INSTALL file. - moved some other stuff to doc/zebra.texi - -1999-06-29 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in (LIBS): Add libresolv check. - Change --enabe-all-in-one option to --enable-one-vty. - -1999-06-20 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add --enabe-all-in-one option. - -1999-06-16 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add socklen_t check. - -1999-06-16 Gerhard Poul <gpoul@gnu.org> - - * Many compile warnings fixed. - -1999-05-31 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Change message from Linux 2.2.X IPv6 to Linux IPv6. - OpenBSD (NRL) check is enabled. - -1999-05-30 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in (LIBS): Add crypt library check. - -1999-05-08 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add sin6_scope_id in struct sockaddr_in6 check. - -1999-04-30 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to 0.63 for first beta package. - -1999-04-15 Kunihiro Ishiguro <kunihiro@zebra.org> - - * guile.m4: Added from guile package. - -1999-04-14 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Set version to 0.60 for beta package preparation. - -1999-04-12 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Makefile.am: Add noninst_LIBRARIES each directory's Makefile.am. - This change is for linking these libraries to guile. - -1999-04-08 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in (LIBS): Add struct rt_addrinfo check. - -1999-04-07 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: AC_STDC_HEADERS added. - -1999-03-29 Kunihiro Ishiguro <kunihiro@zebra.org> - - * Add dependencies to each directory's Makefile.am. - -1999-03-02 Peter Galbavy <Peter.Galbavy@knowledge.com> - - * reworked include file structure, and configure so that all - source files get all system-dependent include files by including - <zebra.h> which is really lib/zebra.h. This means that the - different programs include files are now available as #include - "zebra/zebra.h" - note the use of quotes, not <> as delimiters. - - In practical terms, if I haven't really screwed up, the main file - that maintainers for other OSes have to change is lib/zebra.h for - all the conditional includes etc. - - * added --disable-pthread for those systems that seem to have - POSIX threads, but do not work. OpenBSD 2.4+ is like that just - now. Changed all occurance of #ifdef PTHREAD to use HAVE_PTHREAD - instead. - -1999-02-24 <kunihiro@zebra.org> - - * configure.in: update to AC_PREREQ(1.13). - Change message from Linux 2.1.x to Linux 2.2.x. - * Added ospf6d directory support. - -1999-02-22 Peter Galbavy <Peter.Galbavy@knowledge.com> - - * added a "log" element to the BGPd peer structure, enabling us to - start thinging about a log stream per peer. This is currently - ignored by the wrapper code, but developers should try to use the - "appropriate" ZLOG stream. Documentation will follow, when the - real routines start to exist. - - The current plan is to use a copy of the BSD syslog() routines and - replace the syslog library function with our own. I will need - feedback from users of other platforms as this work is done to see - if all is well elsewhere. - - * preliminary work on zlog() library. directly replaces syslog() - currently with zlog(ZLOG *, ...) where the new first argument - is a pointer to a ZLOG structure (defined in lib/log.h) and will - encapsulate all the information necessary to maintain multiple - logging streams. - -1999-02-19 Peter Galbavy <Peter.Galbavy@knowledge.com> - - * added vsnprintf() macro to lib/str.h if required and removed - #ifdef SUNOS_5 dependency on it - -1999-02-18 Peter Galbavy <Peter.Galbavy@knowledge.com> - - * syslog support added - -1999-02-18 Peter Galbavy <Peter.Galbavy@knowledge.com> - - * configure.in: Add daemon function check. - -1999-01-21 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Add --disable-ipv6, --disable-zebra, - --disable-bgpd, --disable-ripd, --disable-ripngd, --disable-ospfd - options to configure. - -1998-12-07 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Check /usr/inet6/lib/libinet6.a exists or not. - -1998-10-14 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Comment out FreeBSD's libc_r detect section. At - this moment it doesn't work correctly with zebra. - - Netlink interface is only enabled when Linux kernel version is - upper than 2.1.0. - -1998-09-15 HEO SeonMeyong <seirios@matrix.iri.co.jp> - - * Hydrangea is now called KAME, so change all defines. - -1998-08-16 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: ifaliasreq check added. - -1998-08-12 Katsuhiro Kondou <kondou@nec.co.jp> - - * Patch is applied for compile under EWS4800 - -1998-06-09 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: delete old mtu_method check. - - * doc/zebra.texi (Kernel interface): chapter `Kernel interface' added - -1998-06-08 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: add new netlink check for GNU/Linux - -1998-06-07 Kunihiro Ishiguro <kunihiro@zebra.org> - - * doc/zebra.texi: Update Linux netlink chapter. - -1998-05-18 Yamashita TAKAO <jargon@lares.dti.ne.jp> - - * config.h.in: define PTHREAD if work on Solaris 2.6 - why delete the definition? I miss? - -1998-05-08 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: add net/if.h header check. - -1998-05-02 SeonMeyong HEO <seirios@Matrix.iri.co.jp> - - * zebra.tex,archfig.tex,zebra.sty: Manual file is added. - * zebra.texi: Modify Introduction text. - * RIPngd.c: Patch Hydrangea code. - -1998-05-01 Kunihiro Ishiguro <kunihiro@zebra.org> - - * .cvsignore: added. - - * Makerule.in: is gone. - * Makefile.am: Now we use automake to generate Makefile.in - -1998-03-19 Yamashita TAKAO <jargon@lares.dti.ne.jp> - - * lib/vty.c: modified the definition of *master - * lib/sockunion.c (inet_aton): add, but don't work. uum... - - -1998-03-15 Yamashita TAKAO <jargon@lares.dti.ne.jp> - - * configure.in: define PTHREAD if work on Solaris 2.6 - * config.h.in: likewise - * lib/thread.c: likewise - * lib/vty.c: likewise - -1998-03-15 SeonMeyong HEO <seirios@Matrix.iri.co.jp> - - * config.h.in: define INET6 if defined HAVE_IPV6 & HYDRANGEA - * bgpd/: remove include <netinet6/in6.h> line. - * lib/: remove include <netinet6/in6.h> line. - * ripbgd/: remove include <netinet6/in6.h> line. - * zebra/: remove include <netinet6/in6.h> line. - * ripd/*.c: remove include <netinet6/in6.h> line. - undefine IPV6 difinitions because RIPd is not worked for - IPv6 protocol. - - -1998-01-30 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: Change routing socket check method from - AC_TRY_COMPILE to AC_TRY_RUN because GNU libc version 2 has - AF_ROUTE but over linux it's meenigless. - -1998-01-06 Kunihiro Ishiguro <kunihiro@zebra.org> - - * config.h.in: remove err_t define. - -1997-11-18 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in (canonical): add check of IF_METHOD - -1997-09-27 Kunihiro Ishiguro <kunihiro@note.digital-magic.co.jp> - - * configure.in: add INRIA check - -1997-09-25 Kunihiro Ishiguro <kunihiro@note.digital-magic.co.jp> - - * configure.in (canonical): change ipforward_snmp.o to ipforward_proc.o - -1997-09-12 Kunihiro Ishiguro <kunihiro@zebra.org> - - * configure.in: change IRDPD to NDPD - -1997-08-18 Kunihiro Ishiguro <kunihiro@zebra.org> - - * INSTALL: new file - -1997-08-14 Kunihiro Ishiguro <kunihiro@zebra.org> - - * config.h: add XCALLOC() - diff --git a/Makefile.am b/Makefile.am index 96da94fa..d0cf3771 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,11 +1,11 @@ ## Process this file with automake to produce Makefile.in. SUBDIRS = lib @ZEBRA@ @BGPD@ @RIPD@ @RIPNGD@ @OSPFD@ @OSPF6D@ \ - @ISISD@ @WATCHQUAGGA@ @VTYSH@ @OSPFCLIENT@ doc m4 @pkgsrcdir@ \ + @ISISD@ @WATCHQUAGGA@ @WATCHLINK@ @VTYSH@ @OSPFCLIENT@ doc m4 @pkgsrcdir@ \ redhat @SOLARIS@ DIST_SUBDIRS = lib zebra bgpd ripd ripngd ospfd ospf6d \ - isisd watchquagga vtysh ospfclient doc m4 pkgsrc redhat tests \ + isisd watchquagga watchlink vtysh ospfclient doc m4 pkgsrc redhat tests \ solaris EXTRA_DIST = aclocal.m4 SERVICES TODO REPORTING-BUGS INSTALL.quagga.txt \ diff --git a/bgpd/bgp_packet.c b/bgpd/bgp_packet.c index 8319a885..e8f77f10 100644 --- a/bgpd/bgp_packet.c +++ b/bgpd/bgp_packet.c @@ -1188,9 +1188,9 @@ bgp_open_receive (struct peer *peer, bgp_size_t size) /* Receive OPEN message log */ if (BGP_DEBUG (normal, NORMAL)) - zlog_debug ("%s rcv OPEN, version %d, remote-as (in open) %d," + zlog_debug ("%s rcv OPEN, version %d, remote-as (in open) %u," " holdtime %d, id %s", - peer->host, version, remote_as, holdtime, + peer->host, version, (unsigned)remote_as, holdtime, inet_ntoa (remote_id)); /* BEGIN to read the capability here, but dont do it yet */ diff --git a/bgpd/bgp_vty.c b/bgpd/bgp_vty.c index 927e99a1..1481c66d 100644 --- a/bgpd/bgp_vty.c +++ b/bgpd/bgp_vty.c @@ -331,12 +331,12 @@ DEFUN (router_bgp, VTY_NEWLINE); return CMD_WARNING; case BGP_ERR_AS_MISMATCH: - vty_out (vty, "BGP is already running; AS is %d%s", as, VTY_NEWLINE); + vty_out (vty, "BGP is already running; AS is %u%s", (unsigned)as, VTY_NEWLINE); return CMD_WARNING; case BGP_ERR_INSTANCE_MISMATCH: vty_out (vty, "BGP view name and AS number mismatch%s", VTY_NEWLINE); - vty_out (vty, "BGP instance is already running; AS is %d%s", - as, VTY_NEWLINE); + vty_out (vty, "BGP instance is already running; AS is %u%s", + (unsigned)as, VTY_NEWLINE); return CMD_WARNING; } @@ -1277,10 +1277,10 @@ peer_remote_as_vty (struct vty *vty, const char *peer_str, switch (ret) { case BGP_ERR_PEER_GROUP_MEMBER: - vty_out (vty, "%% Peer-group AS %d. Cannot configure remote-as for member%s", as, VTY_NEWLINE); + vty_out (vty, "%% Peer-group AS %u. Cannot configure remote-as for member%s", (unsigned)as, VTY_NEWLINE); return CMD_WARNING; case BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT: - vty_out (vty, "%% The AS# can not be changed from %d to %s, peer-group members must be all internal or all external%s", as, as_str, VTY_NEWLINE); + vty_out (vty, "%% The AS# can not be changed from %u to %s, peer-group members must be all internal or all external%s", (unsigned)as, as_str, VTY_NEWLINE); return CMD_WARNING; } return bgp_vty_return (vty, ret); @@ -1560,7 +1560,7 @@ DEFUN (neighbor_set_peer_group, if (ret == BGP_ERR_PEER_GROUP_PEER_TYPE_DIFFERENT) { - vty_out (vty, "%% Peer with AS %d cannot be in this peer-group, members must be all internal or all external%s", as, VTY_NEWLINE); + vty_out (vty, "%% Peer with AS %u cannot be in this peer-group, members must be all internal or all external%s", (unsigned)as, VTY_NEWLINE); return CMD_WARNING; } @@ -6628,8 +6628,8 @@ bgp_show_summary (struct vty *vty, struct bgp *bgp, int afi, int safi) /* Usage summary and header */ vty_out (vty, - "BGP router identifier %s, local AS number %d%s", - inet_ntoa (bgp->router_id), bgp->as, VTY_NEWLINE); + "BGP router identifier %s, local AS number %u%s", + inet_ntoa (bgp->router_id), (unsigned)bgp->as, VTY_NEWLINE); ents = bgp_table_count (bgp->rib[afi][safi]); vty_out (vty, "RIB entries %ld, using %s of memory%s", ents, @@ -6675,8 +6675,8 @@ bgp_show_summary (struct vty *vty, struct bgp *bgp, int afi, int safi) vty_out (vty, "4 "); - vty_out (vty, "%5d %7d %7d %8d %4d %4lu ", - peer->as, + vty_out (vty, "%5u %7d %7d %8d %4d %4lu ", + (unsigned)peer->as, peer->open_in + peer->update_in + peer->keepalive_in + peer->notify_in + peer->refresh_in + peer->dynamic_cap_in, peer->open_out + peer->update_out + peer->keepalive_out @@ -7185,9 +7185,9 @@ bgp_show_peer (struct vty *vty, struct peer *p) /* Configured IP address. */ vty_out (vty, "BGP neighbor is %s, ", p->host); - vty_out (vty, "remote AS %d, ", p->as); - vty_out (vty, "local AS %d%s, ", - p->change_local_as ? p->change_local_as : p->local_as, + vty_out (vty, "remote AS %u, ", (unsigned)p->as); + vty_out (vty, "local AS %u%s, ", + p->change_local_as ? (unsigned)p->change_local_as : (unsigned)p->local_as, CHECK_FLAG (p->flags, PEER_FLAG_LOCAL_AS_NO_PREPEND) ? " no-prepend" : ""); vty_out (vty, "%s link%s", @@ -7968,7 +7968,7 @@ bgp_show_rsclient_summary (struct vty *vty, struct bgp *bgp, "Route Server's BGP router identifier %s%s", inet_ntoa (bgp->router_id), VTY_NEWLINE); vty_out (vty, - "Route Server's local AS number %d%s", bgp->as, + "Route Server's local AS number %u%s", (unsigned)bgp->as, VTY_NEWLINE); vty_out (vty, "%s", VTY_NEWLINE); diff --git a/bgpd/bgpd.c b/bgpd/bgpd.c index 374c4c52..128bfef1 100644 --- a/bgpd/bgpd.c +++ b/bgpd/bgpd.c @@ -4384,13 +4384,13 @@ bgp_config_write_peer (struct vty *vty, struct bgp *bgp, vty_out (vty, " neighbor %s peer-group%s", addr, VTY_NEWLINE); if (peer->as) - vty_out (vty, " neighbor %s remote-as %d%s", addr, peer->as, + vty_out (vty, " neighbor %s remote-as %u%s", addr, (unsigned)peer->as, VTY_NEWLINE); } else { if (! g_peer->as) - vty_out (vty, " neighbor %s remote-as %d%s", addr, peer->as, + vty_out (vty, " neighbor %s remote-as %u%s", addr, (unsigned)peer->as, VTY_NEWLINE); if (peer->af_group[AFI_IP][SAFI_UNICAST]) vty_out (vty, " neighbor %s peer-group %s%s", addr, @@ -4781,7 +4781,7 @@ bgp_config_write (struct vty *vty) vty_out (vty, "!%s", VTY_NEWLINE); /* Router bgp ASN */ - vty_out (vty, "router bgp %d", bgp->as); + vty_out (vty, "router bgp %u", (unsigned)bgp->as); if (bgp_option_check (BGP_OPT_MULTIPLE_INSTANCE)) { diff --git a/configure.ac b/configure.ac index 5e1fc96e..bce20242 100755 --- a/configure.ac +++ b/configure.ac @@ -124,7 +124,12 @@ if test "x${cflags_specified}" = "x" ; then CFLAGS="${CFLAGS} -Wbad-function-cast -Wwrite-strings" CFLAGS="${CFLAGS} -Wmissing-prototypes -Wmissing-declarations" CFLAGS="${CFLAGS} -Wchar-subscripts -Wcast-qual" - # TODO: conditionally addd -Wpacked if handled + + CXXFLAGS="-Os -fno-omit-frame-pointer -g -Wall" + CXXFLAGS="${CFLAGS} -Wsign-compare -Wpointer-arith" + CXXFLAGS="${CFLAGS} -Wwrite-strings" + CXXFLAGS="${CFLAGS} -Wchar-subscripts -Wcast-qual" + # TODO: conditionally addd -Wpacked if handled AC_MSG_RESULT([gcc default]) ;; "SUNPRO") @@ -195,6 +200,8 @@ AC_ARG_ENABLE(ospf6d, [ --disable-ospf6d do not build ospf6d]) AC_ARG_ENABLE(watchquagga, [ --disable-watchquagga do not build watchquagga]) +AC_ARG_ENABLE(watchlink, +[ --disable-watchlink do not build watchlink]) AC_ARG_ENABLE(isisd, [ --enable-isisd build isisd]) AC_ARG_ENABLE(solaris, @@ -1148,6 +1155,12 @@ else WATCHQUAGGA="watchquagga" fi +if test "${enable_watchlink}" = "no";then + WATCHLINK="" +else + WATCHLINK="watchlink" +fi + OSPFCLIENT="" if test "${enable_opaque_lsa}" = "yes"; then if test "${enable_ospfapi}" != "no";then @@ -1196,6 +1209,7 @@ AC_SUBST(RIPNGD) AC_SUBST(OSPFD) AC_SUBST(OSPF6D) AC_SUBST(WATCHQUAGGA) +AC_SUBST(WATCHLINK) AC_SUBST(ISISD) AC_SUBST(SOLARIS) AC_SUBST(VTYSH) @@ -1411,6 +1425,7 @@ AC_DEFINE_UNQUOTED(PATH_OSPFD_PID, "$quagga_statedir/ospfd.pid",ospfd PID) AC_DEFINE_UNQUOTED(PATH_OSPF6D_PID, "$quagga_statedir/ospf6d.pid",ospf6d PID) AC_DEFINE_UNQUOTED(PATH_ISISD_PID, "$quagga_statedir/isisd.pid",isisd PID) AC_DEFINE_UNQUOTED(PATH_WATCHQUAGGA_PID, "$quagga_statedir/watchquagga.pid",watchquagga PID) +AC_DEFINE_UNQUOTED(PATH_WATCHLINK_PID, "$quagga_statedir/watchlink.pid",watchlink PID) AC_DEFINE_UNQUOTED(ZEBRA_SERV_PATH, "$quagga_statedir/zserv.api",zebra api socket) AC_DEFINE_UNQUOTED(ZEBRA_VTYSH_PATH, "$quagga_statedir/zebra.vty",zebra vty socket) AC_DEFINE_UNQUOTED(RIP_VTYSH_PATH, "$quagga_statedir/ripd.vty",rip vty socket) @@ -1444,6 +1459,7 @@ AC_CONFIG_FILES([Makefile lib/Makefile zebra/Makefile ripd/Makefile ripngd/Makefile bgpd/Makefile ospfd/Makefile watchquagga/Makefile ospf6d/Makefile isisd/Makefile vtysh/Makefile doc/Makefile ospfclient/Makefile tests/Makefile m4/Makefile redhat/Makefile + watchlink/Makefile pkgsrc/Makefile redhat/quagga.spec lib/version.h diff --git a/debian/README b/debian/README new file mode 100644 index 00000000..cd10e951 --- /dev/null +++ b/debian/README @@ -0,0 +1,26 @@ +The Debian Package vyatta-quagga +---------------------------- + +This package is the Vyatta build of the Quagga routing protocol +daemons. The source is maintained in the GIT repository: + http://suva.vyatta.com/quagga.git + +The upstream CVS repository is: + :pserver:anoncvs@anoncvs.quagga.net:/var/cvsroot quagga + +To clone the source for this package: + git clone http://suva.vyatta.com/quagga.git + +To build: + git-buildpackage -us -uc + +To build from the source package, first add the following to +/etc/apt/sources.list: + deb-src http://archive1.vyatta.com/vyatta community testing + +Then: + apt-get source vyatta-quagga + cd vyatta-quagga-VERSION + debuild -nc -b -uc -us + + -- Tom Grennan <tgrennan@vyatta.com> Wed, 19 DEC 2007 diff --git a/debian/autogen.sh b/debian/autogen.sh new file mode 100755 index 00000000..ff125d1d --- /dev/null +++ b/debian/autogen.sh @@ -0,0 +1,37 @@ +#!/bin/sh + + +if [ -d .git ] ; then +# generate GNU/Debian format ChangeLog from git log + + rm -f ChangeLog + + if which git2cl >/dev/null ; then + git-log --pretty --numstat --summary | git2cl >> ChangeLog + else + git-log --pretty=short >> ChangeLog + fi + +# append repository reference + + url=` git repo-config --get remote.origin.url` + test "x$url" = "x" && url=`pwd` + + branch=`git-branch --no-color | sed '/^\* /!d; s/^\* //'` + test "x$branch" = "x" && branch=master + + sha=`git log --pretty=oneline --no-color -n 1 | cut -c-8` + test "x$sha" = "x" && sha=00000000 + + echo "$url#$branch-$sha" >> ChangeLog + +fi + +rm -rf config +rm -f aclocal.m4 config.guess config.statusconfig.sub configure INSTALL + +autoreconf --force --install + +rm -f config.sub config.guess +ln -s /usr/share/misc/config.sub . +ln -s /usr/share/misc/config.guess . diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 00000000..a0dffeab --- /dev/null +++ b/debian/changelog @@ -0,0 +1,181 @@ +vyatta-quagga (0.99.9-4) unstable; urgency=low + + 3.0.2 + [ Mark O'Brien ] + + * 3.0.1 + + [ Michael Larson ] + * bumped up netlink recv buffer limits for zebra--should alleviate + netlink error msgs that occur under large routing tables when layer + * support 64bit + * added interface/address exclusion support to watchlink. The correct + format is: + * modified watchlink parser to support the following behaviors: + * add wildcard for interfaces. use an "*" in place of an interface + name--and the address provided will exclude all + + [ Stephen Hemminger ] + * Filter unwanted netlink messages + * fix build on on 64 bit platforms + * add locking to prevent file update problems + + [ rbalocca ] + * Remove unused lintian "ignore" option + + [ Mark O'Brien ] + + -- Mark O'Brien <mobrien@vyatta.com> Fri, 04 Apr 2008 18:01:16 -0700 + +vyatta-quagga (0.99.9-3) unstable; urgency=low + + VC4.0.1 + [ Mark O'Brien ] + + + [ Bob Gilligan ] + * Bugfix: 2845 + + [ Michael Larson ] + * revert behavior for watchlink to pulling/pushing address on + interface on IFF_RUNNING|IFF_UP event. + * And with the correct licensing headers. + + [ Mohit Mehta ] + * Fix Bug 2750 bgp: large ASN shown as negative + * Fix Bug 2750 bgp: large ASN shown as negative + + [ Stephen Hemminger ] + * Change license notice from VPL to GPLv2 + + [ Stig Thormodsrud ] + * Fix 2842: Protocol debug does not take affect until underlying log + level + + [ Mark O'Brien ] + + -- Mark O'Brien <mobrien@vyatta.com> Tue, 18 Mar 2008 19:05:11 -0700 + +vyatta-quagga (0.99.9-2) unstable; urgency=low + + vc4.0.0 + [ Mark O'Brien ] + + + [ An-Cheng Huang ] + * remove generated files from repo + + [ Justin Fletcher ] + * Log to syslog daemon + + [ Michael Larson ] + * fix for static interface and static nexthop routes for quagga. Now + respects cable pull (IFF_RUNNING) events and admin (IFF_UP) events. + * initial check-in of watchlink project. compiles, runs and manages + state. needs additional testing and updates + * removed unnecessary files. + * packaging and make rules for base vyatta-quagga project to build + watchlink + * Added quagga like features to watchlink pgm: standard pid file + creation and background option. Also + * hooks to start/stop watchlink daemon with quagga + * create directory for watchlink to store link status + * moved creation of linkstatus directory from postinst to preinst + where it should be. + * cleaned up source a bit. added syslog error messages. added legal- + eeze. + * added support for filtering of interfaces. filter or exclusion list + needs to be be written to exclude + * removed stderr message when unable to open exclusion file. Also + downgraded syslog entry to + * added empty exclude file creation to make watchlink happy + * fix bug introduced with ptp support--indexing of database and + initialization of terminating address. + * fix for bc addr and fix for parsing iface for show cmds and filter + * need to qualify test for non-ethernet type interfaces to + newlink/dellink messages only. + * moved some stderr messages to syslog. removed stderr message when + receiving ack from kernel on netlink msg. + * modified watchlink to manage connected routes in local and main + tables per interface rather than pulling interface address on cable + pull event. + * force so_recvbuf size to 223232 (double of 111616) for netlink in + zebra. will also need to modify + * fix for bug 2750. will also submit to quagga dvlprs. + + [ Stephen Hemminger ] + * avoid package conflict between iproute and vyatta-iproute + * Revert "avoid package conflict between iproute and vyatta-iproute" + + [ Tom Grennan ] + * ignore autoreconf generated files + * ignore emacs backups + * add script to import updates from anoncvs.quagga.net + * import into the "upstream" branch + * initial vyatta-quagga debian config + * finish vyatta debian config + * use default daemon config files rather than /dev/null + * fix log files path + * set default logging + * ignore debuild generated debian/vyatta-quagga.substvars + * donot modify existing conffiles + * separate init of vtysh.conf from other daemons + * use "log syslog LEVEL" not "log file syslog LEVEL" + * ignore watchlink binary + * donot add user "vyatta" to vtysh.conf in preinit, this is now done + during system config + + [ paul ] + * [bgpd] Fix typo, which prevented advertisement of MP (non-IPv4) + prefixes + * [privs/Solaris] Quagga should work in zones with IP instances + * [bgpd] Merge AS4 support + * [tests] Forgot to commit ecommunity_tests.c + * [news] Fix top-line version + * [snmp-smux] Fix problems if 'smux peer ...' is issued multiple times + * [ospf6d] Fix removal of defunct ASBR routes + * 2007-10-30 Nick Hilliard <nick@inex.ie> + * [bgpd] small fix for crash if 'listenon' argument is not given + * [bgpd] Fix typo in previous commit to bgp_main.c + + [ pilot ] + * * rt_socket.c: (kernel_rtm_ipv4) prefix_buf could be passed + * Switch from LOOKUP() to lookup() for rtm_type (see bug #401 for + details). + * + fixed bug #402: now the second zebra process doesn't destroy + routes + * + sayonara old_pid! + * + fix minor regression in OSPF sending buffer adjustment logic + * + fix missing arg to zlog_warn() + * + Minor bugfix: IPv6 prefixes were logged incorrectly in RIB + debugging calls. Fixed. + * + rib_process() speedup for multi-nexthop route nodes + * + pidfiles are now always created with 0644 perms instead if + LOGFILE_MASK (0600) + * + fix the bug reported by Milan Kocian (IPv6 route handling was + broken by the RIB debug changeset). + * + fixed bug #418 (changing address on an existing interface doesn't + cause existing static routes to be revalidated) + * + fixed no_set_aspath_prepend() to correctly match existing "set" + statement + + [ root ] + * added support for ifa_address field in rtm_newaddr message and in + links where the ifa_address != ifa_local then ifa_address is + populated in setaddr message. fix for bug 2650 + * fix for bug 2648--downgraded some syslog messages and removed some + from console. + * fix for bug 2570. increased buffer length from 4096 to 8192 + * fix for ppp--restrict watchlink to ethernet interface types only. + Filter by checking the ifi_type flag in ifinfomsg hdr from netlink. + + [ Mark O'Brien ] + + -- Mark O'Brien <mobrien@vyatta.com> Mon, 25 Feb 2008 17:39:54 -0800 + +vyatta-quagga (0.99.9-1) unstable; urgency=low + + * based on upstream/0.99.9 == d68aac0fbecabfb765a42b3c6e5693836dafda99 + + -- Tom Grennan <tgrennan@vyatta.com> Fri, 21 Dec 2007 19:29:50 +0000 + diff --git a/debian/compat b/debian/compat new file mode 100644 index 00000000..7ed6ff82 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +5 diff --git a/debian/control b/debian/control new file mode 100644 index 00000000..bfd9db1e --- /dev/null +++ b/debian/control @@ -0,0 +1,39 @@ +Source: vyatta-quagga +Section: contrib/net +Priority: extra +Maintainer: Tom Grennan <tgrennan@vyatta.com> +Build-Depends: debhelper (>= 5), + autotools-dev, + libncurses5-dev, + libreadline5-dev | libreadline-dev, + texinfo (>= 4.7), + libpam0g-dev | libpam-dev, + libcap1 | libcap-dev, + imagemagick, + ghostscript | gs-gpl, + groff, + po-debconf +Standards-Version: 3.7.2 +Vcs-Git: http://suva.vyatta.git/quagga.git + +Package: vyatta-quagga +Architecture: any +Depends: ${shlibs:Depends}, logrotate (>= 3.2-11), iproute, ${misc:Depends} +Pre-Depends: adduser +Conflicts: zebra, zebra-pj +Replaces: zebra, zebra-pj +Suggests: snmpd +Description: BGP/OSPF/RIP routing daemon + GNU Quagga is free software which manages TCP/IP based routing protocols. + It supports BGP4, BGP4+, OSPFv2, OSPFv3, IS-IS, RIPv1, RIPv2, and RIPng as + well as the IPv6 versions of these. + . + As the precessor Zebra has been considered orphaned, the Quagga project + has been formed by members of the zebra mailing list and the former + zebra-pj project to continue developing. + . + Quagga uses threading if the kernel supports it, but can also run on + kernels that do not support threading. Each protocol has its own daemon. + . + It is more than a routed replacement, it can be used as a Route Server and + a Route Reflector. diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 00000000..78f470e7 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,39 @@ +This package and repository was debianized for the git-buildpackage +tool by Tom Grennan <tgrennan@vyatta.com> on Dec 19, 2007. This was +derived from the debian package by Christian Hammers <ch@debian.org> +on 2003-07-01. + +The source is maintained in the GIT repository: + http://suva.vyatta.com/quagga.git + +The upstream CVS repository is: + :pserver:anoncvs@anoncvs.quagga.net:/var/cvsroot quagga + +Upstream Authors: + + Authors of the original Zebra are + Kunihiro Ishiguro <kunihiro@zebra.org> + Toshiaki Takada <takada@zebra.org> + Yasuhiro Ohara <yasu@sfc.wide.ad.jp> + + Main patch collector for quagga is + Paul Jakma <paul@jakma.org> + +Copyright: + + Copyright (c) 1996, 97, 98, 99, 2000 Kunihiro Ishiguro <kunihiro@zebra.org> + Portions Copyright (c) 2003 Paul Jakma <paul@dishone.st> + +License: + + The package libraries are subject to Library General Public License, + version 2. The remainder package contents are subject to GNU General + Pulic License, version 2. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + +On Debian systems, the complete text of these licenses can be found in +`/usr/share/common-licenses/{GPL-2,LGPL-2}'. diff --git a/debian/docs b/debian/docs new file mode 100644 index 00000000..6f83607c --- /dev/null +++ b/debian/docs @@ -0,0 +1,3 @@ +AUTHORS +NEWS +README diff --git a/debian/import b/debian/import new file mode 100755 index 00000000..ac03e249 --- /dev/null +++ b/debian/import @@ -0,0 +1,23 @@ +#!/bin/bash + +# Import updates from main CVS repo + +if ! git branch -l | grep -q upstream ; then + git branch upstream origin/upstream +fi + +# verbose args: -v -p-v +git-cvsimport -d :pserver:anoncvs@anoncvs.quagga.net:/var/cvsroot -k -u -i -m -o upstream quagga + +# Annotate tags + +git tag -l | +while read t ; do + if [ ! -r .git/refs/tags/$t ] ; then + r=$(git-show-ref -s $t) + git tag -d $t + git tag -a -m 'import cvs tag' $t $r + fi +done + +echo "Remember to: git push suva:/git/quagga.git upstream" diff --git a/debian/lintian b/debian/lintian new file mode 100644 index 00000000..8368204a --- /dev/null +++ b/debian/lintian @@ -0,0 +1,3 @@ +vyatta-quagga: binary-without-manpage usr/sbin/vyatta-ospfclient +vyatta-quagga: binary-without-manpage usr/sbin/vyatta-watchquagga +vyatta-quagga: binary-without-manpage usr/sbin/vyatta-watchlink diff --git a/debian/rules b/debian/rules new file mode 100755 index 00000000..7681bcb3 --- /dev/null +++ b/debian/rules @@ -0,0 +1,144 @@ +#!/usr/bin/make -f +# -*- makefile -*- +# Sample debian/rules that uses debhelper. +# This file was originally written by Joey Hess and Craig Small. +# As a special exception, when this file is copied by dh-make into a +# dh-make output file, you may use that output file without restriction. +# This special exception was added by Craig Small in version 0.37 of dh-make. + +# Uncomment this to turn on verbose mode. +#export DH_VERBOSE=1 + + +# These are used for cross-compiling and for saving the configure script +# from having to guess our platform (since we know it already) +DEB_HOST_GNU_TYPE ?= $(shell dpkg-architecture -qDEB_HOST_GNU_TYPE) +DEB_BUILD_GNU_TYPE ?= $(shell dpkg-architecture -qDEB_BUILD_GNU_TYPE) +PACKAGE=vyatta-quagga +PKGDIR=$(CURDIR)/debian/$(PACKAGE) +BUILD_STAMP=debian/build-stamp +CFLAGS = -Wall -g + +ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS))) + CFLAGS += -O0 +else + CFLAGS += -O2 +endif + +ifeq ($(WANT_SNMP),1) + xable_snmp = --enable-snmp +else + xable_snmp = --disable-snmp +endif + +configure = ./configure +configure += --host=$(DEB_HOST_GNU_TYPE) +configure += --build=$(DEB_BUILD_GNU_TYPE) +configure += --prefix=/usr +configure += --program-prefix=vyatta- +configure += --libdir=/usr/lib/$(PACKAGE) +configure += --localstatedir=/var/run/vyatta/quagga +configure += --sysconfdir=/etc/vyatta/quagga +configure += --mandir=/usr/share/man +configure += --includedir=/usr/include/vyatta +configure += --infodir=/usr/share/info/$(PACKAGE) +configure += --enable-exampledir=/usr/share/doc/$(PACKAGE)/examples +configure += --enable-vtysh +configure += --enable-ipv6 +configure += --enable-isisd +configure += --enable-watchquagga +configure += --enable-watchlink +configure += --enable-opaque-lsa +configure += --enable-ospfclient=yes +configure += --enable-ospfapi=yes +configure += --enable-ospf-te +configure += --enable-multipath=64 +configure += --enable-user=quagga +configure += --enable-group=quagga +configure += --enable-vty-group=quaggavty +configure += --enable-configfile-mask=0640 +configure += --enable-logfile-mask=0640 +configure += --enable-rtadv +configure += --enable-tcp-md5 +configure += --enable-gcc-rdynamic +configure += $(xable_snmp) +configure += --with-libpam +configure += CFLAGS="$(CFLAGS)" +# configure += LDFLAGS="-Wl,-z,defs" + +configure: configure.ac Makefile.am + chmod +x debian/autogen.sh + debian/autogen.sh + +config.status: configure + dh_testdir + rm -f config.cache + $(configure) + +build: $(BUILD_STAMP) + +$(BUILD_STAMP): config.status + dh_testdir + $(MAKE) + touch $@ + +clean: clean-patched + +# Clean everything up, including everything auto-generated +# at build time that needs not to be kept around in the Debian diff +clean-patched: + dh_testdir + dh_testroot + if test -f Makefile ; then $(MAKE) clean distclean ; fi + rm -f $(BUILD_STAMP) + rm -f config.status config.sub config.guess config.log + rm -f aclocal.m4 configure Makefile.in Makefile INSTALL + rm -f etc/default/vyatta + rm -rf config + dh_clean + +install: build + dh_testdir + dh_testroot + dh_clean -k + dh_installdirs + + $(MAKE) DESTDIR=$(PKGDIR) install + + install -D --mode=0644 debian/lintian $(PKGDIR)/usr/share/lintian/overrides/$(PACKAGE) + +ifeq ($(WANT_SNMP), 1) + install -D --mode=0644 zebra/GNOME-PRODUCT-ZEBRA-MIB $(PKGDIR)/usr/share/snmp/mibs +endif + + +# Build architecture-dependent files here. +binary-arch: build install + dh_testdir + dh_testroot + + dh_installdirs + dh_link + + dh_installchangelogs ChangeLog + dh_installdebconf + dh_installdocs + dh_installexamples + dh_installinit + dh_installpam + dh_installlogrotate + + dh_strip + dh_compress + dh_fixperms + dh_makeshlibs --noscripts + dh_installdeb +# dh_shlibdeps: removed "-L quagga" for Woody backport compatibility. + dh_shlibdeps + dh_gencontrol + dh_md5sums + dh_builddeb + +binary: binary-arch +.PHONY: build clean binary-arch binary install + diff --git a/debian/vyatta-quagga.dirs b/debian/vyatta-quagga.dirs new file mode 100644 index 00000000..8f5c59a8 --- /dev/null +++ b/debian/vyatta-quagga.dirs @@ -0,0 +1,4 @@ +etc/logrotate.d/ +etc/vyatta/ +var/log/vyatta/ +var/run/vyatta/ diff --git a/debian/vyatta-quagga.files b/debian/vyatta-quagga.files new file mode 100644 index 00000000..38b1ab33 --- /dev/null +++ b/debian/vyatta-quagga.files @@ -0,0 +1,14 @@ +etc/quagga/ +opt/vyatta/ +usr/lib/vyatta-quagga/ +usr/share/lintian/overrides/ +usr/share/man/man1/vtysh.1 +usr/share/man/man8 +usr/share/man/man8/bgpd.8 +usr/share/man/man8/ospf6d.8 +usr/share/man/man8/ospfd.8 +usr/share/man/man8/ripd.8 +usr/share/man/man8/ripngd.8 +usr/share/man/man8/zebra.8 +usr/share/man/man8/isisd.8 +usr/share/snmp/mibs/ diff --git a/debian/vyatta-quagga.init.d b/debian/vyatta-quagga.init.d new file mode 100644 index 00000000..0bf2eaab --- /dev/null +++ b/debian/vyatta-quagga.init.d @@ -0,0 +1,153 @@ +#!/bin/bash +# +### BEGIN INIT INFO +# Provides: vyatta-quagga +# Required-Start: $local_fs $network $remote_fs $syslog +# Required-Stop: $local_fs $network $remote_fs $syslog +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# Short-Description: start and stop the Quagga routing suite +# Description: Quagga is a routing suite for IP routing protocols like +# BGP, OSPF, RIP and others. This script contols the main +# daemon "quagga" as well as the individual protocol daemons. +# FIXME! this init script will be deprecated as daemon start/stop +# is integrated with vyatta-cfg-quagga +### END INIT INFO +# + +. /lib/lsb/init-functions + +declare progname=${0##*/} +declare action=$1; shift + +pid_dir=/var/run/vyatta/quagga +log_dir=/var/log/vyatta/quagga + +for dir in $pid_dir $log_dir ; do + if [ ! -d $dir ]; then + mkdir -p $dir + chown quagga:quagga $dir + chmod 755 $dir + fi +done + +declare -a common_args=( -d -P 0 ) +declare -a watchlink_args=( -s -d -i $pid_dir/watchlink.pid ) +declare -a zebra_args=( ${common_args[@]} -l -s 1048576 -i $pid_dir/zebra.pid ) +declare -a ripd_args=( ${common_args[@]} -i $pid_dir/ripd.pid ) +declare -a ripngd_args=( ${common_args[@]} -i $pid_dir/ripngd.pid ) +declare -a ospfd_args=( ${common_args[@]} -i $pid_dir/ospfd.pid ) +declare -a ospf6d_args=( ${common_args[@]} -i $pid_dir/ospf6d.pid ) +declare -a isisd_args=( ${common_args[@]} -i $pid_dir/isisd.pid ) +declare -a bgpd_args=( ${common_args[@]} -i $pid_dir/bgpd.pid ) + +vyatta_quagga_start () +{ + local -a daemons + if [ $# -gt 0 ] ; then + daemons=( $* ) + else + daemons+=( watchlink ) + daemons+=( zebra ) + daemons+=( ripd ) +# daemons+=( ripngd ) + daemons+=( ospfd ) +# daemons+=( ospf6d ) +# daemons+=( isisd ) + daemons+=( bgpd ) + fi + + log_action_begin_msg "Starting Quagga" + for daemon in ${daemons[@]} ; do + [ "$daemon" != zebra ] && \ + log_action_cont_msg "$daemon" + start-stop-daemon \ + --start \ + --quiet \ + --oknodo \ + --pidfile=$pid_dir/${daemon}.pid \ + --chdir $log_dir \ + --exec "/usr/sbin/vyatta-${daemon}" \ + -- `eval echo "$""{${daemon}_args[@]}"` || \ + ( log_action_end_msg 1 ; return 1 ) + done + log_action_end_msg 0 +} + +vyatta_quagga_stop () +{ + local -a daemons + + if [ $# -gt 0 ] ; then + daemons=( $* ) + else + daemons=( watchlink bgpd isisd ospf6d ospfd ripngd ripd zebra ) + fi + log_action_begin_msg "Stopping Quagga" + for daemon in ${daemons[@]} ; do + pidfile=$pid_dir/${daemon}.pid + if [ -r $pidfile ] ; then + pid=`cat $pidfile 2>/dev/null` + else + pid=`ps -o pid= -C vyatta-${daemon}` + fi + if [ -n "$pid" ] ; then + [ "$daemon" != zebra ] && \ + log_action_cont_msg "$daemon" + start-stop-daemon \ + --stop \ + --quiet \ + --oknodo \ + --exec /usr/sbin/vyatta-${daemon} +# +# Now we have to wait until $DAEMON has _really_ stopped. +# + for (( tries=0; tries<30; tries++ )) ; do + if [[ -d /proc/$pid ]] ; then + sleep 3 + kill -0 $pid 2>/dev/null + else + break + fi + done + rm -f $pidfile + fi + done + log_action_end_msg $? + if echo ${daemons[@]} | grep -q zebra ; then + log_begin_msg "Removing all Quagga Routes" + ip route flush proto zebra + log_end_msg $? + fi +} + +case "$action" in + start) + # Try to load this necessary (at least for 2.6) module. + if [ -d /lib/modules/`uname -r` ] ; then + log_begin_msg "Loading capability module if not yet done" + set +e; \ + LC_ALL=C \ + modprobe -a capability 2>&1 | \ + egrep -v "(not found|Can't locate)"; \ + set -e + log_end_msg 0 + fi + vyatta_quagga_start $* + ;; + + stop|0) + vyatta_quagga_stop $* + ;; + + restart|force-reload) + vyatta_quagga_stop $* + sleep 2 + vyatta_quagga_start $* + ;; + + *) + echo "Usage: $progname {start|stop|restart|force-reload} [daemon...]" + exit 1 + ;; +esac diff --git a/debian/vyatta-quagga.logrotate b/debian/vyatta-quagga.logrotate new file mode 100644 index 00000000..020eb83e --- /dev/null +++ b/debian/vyatta-quagga.logrotate @@ -0,0 +1,17 @@ +/var/log/vyatta/quagga/*.log { + daily + rotate 5 + sharedscripts + missingok + compress + create 640 quagga quaggavty + + postrotate + for daemon in zebra bgpd ripd ospfd ripngd ospf6d isisd; do + if [ -e /var/run/vyatta/quagga/$daemon.pid ] ; then + kill -USR1 `cat /var/run/vyatta/quagga/$daemon.pid` + fi + + done + endscript +} diff --git a/debian/vyatta-quagga.manpages b/debian/vyatta-quagga.manpages new file mode 100644 index 00000000..24556b2d --- /dev/null +++ b/debian/vyatta-quagga.manpages @@ -0,0 +1,8 @@ +doc/bgpd.8 +doc/ospf6d.8 +doc/ospfd.8 +doc/ripd.8 +doc/ripngd.8 +doc/vtysh.1 +doc/zebra.8 +doc/isisd.8 diff --git a/debian/vyatta-quagga.pam b/debian/vyatta-quagga.pam new file mode 100644 index 00000000..093e1729 --- /dev/null +++ b/debian/vyatta-quagga.pam @@ -0,0 +1,3 @@ +# Any user may call vtysh but only those belonging to the group quaggavty can +# actually connect to the socket and use the program. +auth sufficient pam_permit.so diff --git a/debian/vyatta-quagga.postinst b/debian/vyatta-quagga.postinst new file mode 100644 index 00000000..bed2fd3c --- /dev/null +++ b/debian/vyatta-quagga.postinst @@ -0,0 +1,17 @@ +#!/bin/bash -e + +if [ -n "$DEBIAN_SCRIPT_DEBUG" ]; then set -v -x; DEBIAN_SCRIPT_TRACE=1; fi +${DEBIAN_SCRIPT_TRACE:+ echo "#42#DEBUG# RUNNING $0 $*"} + +# This is most likely due to the answer "no" to the "really stop the server" +# question in the prerm script. +if [ "$1" = "abort-upgrade" ]; then + exit 0 +fi + +. /usr/share/debconf/confmodule + +db_stop + +#DEBHELPER# + diff --git a/debian/vyatta-quagga.postrm b/debian/vyatta-quagga.postrm new file mode 100644 index 00000000..dac97986 --- /dev/null +++ b/debian/vyatta-quagga.postrm @@ -0,0 +1,19 @@ +#!/bin/bash + +if [ -n "$DEBIAN_SCRIPT_DEBUG" ]; then set -v -x; DEBIAN_SCRIPT_TRACE=1; fi +${DEBIAN_SCRIPT_TRACE:+ echo "#42#DEBUG# RUNNING $0 $*"} +# set -e not because of userdel +# set -u not because of debhelper + +if [ "$1" = "purge" ]; then + for daemon in zebra bgpd ripd ospfd ripngd ospf6d isisd; do + rm -f /var/run/vyatta/${daemon}.pid + rm -f /var/log/vyatta/${daemon}* + done + [ -z "`ls /var/run/vyatta 2>/dev/null`" ] && rmdir /var/run/vyatta + [ -z "`ls /var/log/vyatta 2>/dev/null`" ] && rmdir /var/log/vyatta + rm -f /etc/vyatta/Quagga.conf /etc/vyatta/vtysh.conf + userdel quagga >/dev/null 2>&1 +fi + +#DEBHELPER# diff --git a/debian/vyatta-quagga.preinst b/debian/vyatta-quagga.preinst new file mode 100644 index 00000000..4222ef3b --- /dev/null +++ b/debian/vyatta-quagga.preinst @@ -0,0 +1,87 @@ +#!/bin/bash + +if [ -n "$DEBIAN_SCRIPT_DEBUG" ]; then set -v -x; DEBIAN_SCRIPT_TRACE=1; fi +${DEBIAN_SCRIPT_TRACE:+ echo "#42#DEBUG# RUNNING $0 $*"} +set -e +set -u + +LOG_DIR=/var/log/vyatta/quagga +LOG_PDIR=${LOG_DIR%/*} +RUN_DIR=/var/run/vyatta/quagga +RUN_PDIR=${RUN_DIR%/*} +ETC_DIR=/etc/vyatta/quagga +ETC_PDIR=${ETC_DIR%/*} +WATCHLINK_DIR=/var/linkstatus + +# creating quaggavty group if it isn't already there +if ! getent group quaggavty >/dev/null; then + addgroup --system quaggavty >/dev/null +fi + +# creating quagga group if it isn't already there +if ! getent group quagga >/dev/null; then + addgroup --system quagga >/dev/null +fi + +# creating quagga user if he isn't already there +if ! getent passwd quagga >/dev/null; then + adduser \ + --system \ + --ingroup quagga \ + --home /var/run/vyatta/ \ + --gecos "Vyatta Quagga routing suite" \ + --shell /bin/false \ + quagga >/dev/null +fi + +# Do not change permissions when upgrading as it would violate policy. +if [ "$1" = "install" ]; then + # Install linkstatus directory + mkdir -p $WATCHLINK_DIR + touch $WATCHLINK_DIR/exclude + + # Logfiles are group readable in case users were put into the quagga group. + mkdir -p $LOG_PDIR + chmod 0755 $LOG_PDIR + mkdir -p $LOG_DIR + chmod 0775 $LOG_DIR + chown quagga:quagga $LOG_DIR + + # Strict permissions for the sockets. + mkdir -p $RUN_PDIR + chmod 0755 $RUN_PDIR + mkdir -p $RUN_DIR + chmod 0755 $RUN_DIR + chown quagga:quagga $RUN_DIR + + # create empty config files + mkdir -p $ETC_PDIR + chmod 0755 $ETC_PDIR + mkdir -p $ETC_DIR + chmod 0775 $ETC_DIR + chown quagga:quaggavty $ETC_DIR + for daemon in zebra ripd ripngd ospfd ospf6d isisd bgpd ; do + if [ ! -e $ETC_DIR/${daemon}.conf ] ; then + touch $ETC_DIR/${daemon}.conf + chown quagga:quaggavty $ETC_DIR/${daemon}.conf + chmod 0640 $ETC_DIR/${daemon}.conf + cat <<-EOF > $ETC_DIR/${daemon}.conf + log syslog + log facility local7 + EOF + fi + done + if [ ! -e $ETC_DIR/vtysh.conf ] ; then + touch $ETC_DIR/vtysh.conf + chown quagga:quaggavty $ETC_DIR/vtysh.conf + chmod 0640 $ETC_DIR/vtysh.conf + cat <<-EOF >> $ETC_DIR/vtysh.conf + username root nopassword + EOF + fi + + # Disable debian/ubuntu package init + update-rc.d -f quagga remove +fi + +#DEBHELPER# diff --git a/doc/texinfo.tex b/doc/texinfo.tex deleted file mode 100644 index 58bea4dd..00000000 --- a/doc/texinfo.tex +++ /dev/null @@ -1,7086 +0,0 @@ -% texinfo.tex -- TeX macros to handle Texinfo files. -% -% Load plain if necessary, i.e., if running under initex. -\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi -% -\def\texinfoversion{2005-01-30.17} -% -% Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, -% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 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 2, 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 texinfo.tex file; see the file COPYING. If not, write -% to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, -% Boston, MA 02111-1307, USA. -% -% 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 has been our intent since Texinfo was invented.) -% -% Please try the latest version of texinfo.tex before submitting bug -% reports; you can get the latest version from: -% http://www.gnu.org/software/texinfo/ (the Texinfo home page), or -% ftp://tug.org/tex/texinfo.tex -% (and all CTAN mirrors, see http://www.ctan.org). -% 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} - -\message{Basics,} -\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\ptexrbrace=\} -\let\ptexslash=\/ -\let\ptexstar=\* -\let\ptext=\t - -% 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\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 - -% In some macros, we cannot use the `\? notation---the left quote is -% in some cases the escape char. -\chardef\colonChar = `\: -\chardef\commaChar = `\, -\chardef\dotChar = `\. -\chardef\exclamChar= `\! -\chardef\questChar = `\? -\chardef\semiChar = `\; -\chardef\underChar = `\_ - -\chardef\spaceChar = `\ % -\chardef\spacecat = 10 -\def\spaceisspace{\catcode\spaceChar=\spacecat} - -% 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} - -% @| 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). -% -\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 - }% - }% -} - -% 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\undefined\else % etex gives us more logging - \tracingscantokens1 - \tracingifs1 - \tracinggroups1 - \tracingnesting2 - \tracingassigns1 - \fi - \tracingcommands3 % 3 gives us more in etex - \errorcontextlines16 -}% - -% 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} - -% For @cropmarks command. -% 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 - -% 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). - \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% - \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. - % - \escapechar = `\\ % use backslash in output files. - \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. - \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 \oddfootingxxx.) - % The \baselineskip=24pt in plain's \makefootline has no effect. - \vskip 2\baselineskip - \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 \normalturnoffactive - \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 \unvbox#1 -\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\next{#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 occurence of `\^^M' or `<space>\^^M' is replaced by a single space. -% -% \argremovec might leave us with trailing space, e.g., -% @end itemize @c foo -% This space token undergoes the same procedure and is eventually removed -% by \finishparsearg. -% -\def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} -\def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} -\def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% - \def\temp{#3}% - \ifx\temp\empty - % We cannot use \next here, as it holds the macro to run; - % thus we 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 \next. -% (Similarily, 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\next\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 enviroments; they don't open a group. (The -% implementation of @end takes care not to call \endgroup in this -% special case.) - - -% At runtime, 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 -} - -% Evironment mismatch, #1 expected: -\def\badenverr{% - \errhelp = \EMsimple - \errmessage{This command can appear only \inenvironment\temp, - not \inenvironment\thisenv}% -} -\def\inenvironment#1{% - \ifx#1\empty - out 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, but... --kasal, 06nov03 - \expandafter\checkenv\csname#1\endcsname - \csname E#1\endcsname - \endgroup - \fi -} - -\newhelp\EMsimple{Press RETURN to continue.} - - -%% Simple single-character @ commands - -% @@ prints an @ -% Kludge this until the fonts are right (grr). -\def\@{{\tt\char64}} - -% This is turned off because it was never documented -% and you can use @w{...} around a quote to suppress ligatures. -%% Define @` and @' to be the same as ` and ' -%% but suppressing ligatures. -%\def\`{{`}} -%\def\'{{'}} - -% Used to generate quoted braces. -\def\mylbrace {{\tt\char123}} -\def\myrbrace {{\tt\char125}} -\let\{=\mylbrace -\let\}=\myrbrace -\begingroup - % Definitions to produce \{ and \} commands for indices, - % and @{ and @} for the aux file. - \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\, = \c -\let\dotaccent = \. -\def\ringaccent#1{{\accent23 #1}} -\let\tieaccent = \t -\let\ubaraccent = \b -\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 \ptexi - \else\ifx\temp\jmacro \j - \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{\selectfonts\lllsize A}\vss}}% - \kern-.15em - \TeX -} - -% 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\*{\hfil\break\hbox{}\ignorespaces} - -% @/ allows a line break. -\let\/=\allowbreak - -% @. is an end-of-sentence period. -\def\.{.\spacefactor=3000 } - -% @! is an end-of-sentence bang. -\def\!{!\spacefactor=3000 } - -% @? is an end-of-sentence query. -\def\?{?\spacefactor=3000 } - -% @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 - -% Old definition--didn't work. -%\parseargdef\need{\par % -%% This method tries to make TeX break the page naturally -%% if the depth of the box does not fit. -%{\baselineskip=0pt% -%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak -%\prevdepth=-1000pt -%}} - -\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'. -% -\newskip\inmarginspacing \inmarginspacing=1cm -\def\strutdepth{\dp\strutbox} -% -\def\doinmargin#1#2{\strut\vadjust{% - \nobreak - \kern-\strutdepth - \vtop to \strutdepth{% - \baselineskip=\strutdepth - \vss - % if you have multiple lines of stuff to put here, you'll need to - % make the vbox yourself of the appropriate size. - \ifx#1l% - \llap{\ignorespaces #2\hskip\inmarginspacing}% - \else - \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% - \fi - \null - }% -}} -\def\inleftmargin{\doinmargin l} -\def\inrightmargin{\doinmargin r} -% -% @inmargin{TEXT [, RIGHT-TEXT]} -% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; -% else use TEXT for both). -% -\def\inmargin#1{\parseinmargin #1,,\finish} -\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. - \setbox0 = \hbox{\ignorespaces #2}% - \ifdim\wd0 > 0pt - \def\lefttext{#1}% have both texts - \def\righttext{#2}% - \else - \def\lefttext{#1}% have only one text - \def\righttext{#1}% - \fi - % - \ifodd\pageno - \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin - \else - \def\temp{\inleftmargin\lefttext}% - \fi - \temp -} - -% @include file insert text of that file as input. -% -\def\include{\parseargusing\filenamecatcodes\includezzz} -\def\includezzz#1{% - \pushthisfilestack - \def\thisfile{#1}% - {% - \makevalueexpandable - \def\temp{\input #1 }% - \expandafter - }\temp - \popthisfilestack -} -\def\filenamecatcodes{% - \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\next\centerH - \else - \let\next\centerV - \fi - \next{\hfil \ignorespaces#1\unskip \hfil}% -} -\def\centerH#1{% - {% - \hfil\break - \advance\hsize by -\leftskip - \advance\hsize by -\rightskip - \line{#1}% - \break - }% -} -\def\centerV#1{\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 = {}% -} - - -% @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\underChar = \active - \gdef\mathunderscore{% - \catcode\underChar=\active - \def_{\ifnum\fam=\slfam \_\else\sb\fi}% - } -} -% Another complication: we want \\ (and @\) to output a \ character. -% FYI, plain.tex uses \\ as a temporary control sequence (why?), but -% this is not advertised and we don't care. Texinfo does not -% otherwise define @\. -% -% 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 - $\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 - \gdef\mathactive{% - \let^ = \ptexhat - \let< = \ptexless - \let> = \ptexgtr - \let+ = \ptexplus - } -} - -% @bullet and @minus need the same treatment as @math, just above. -\def\bullet{$\ptexbullet$} -\def\minus{$-$} - -% @dots{} outputs an ellipsis using the current font. -% We do .5em per period so that it has the same spacing in a typewriter -% font as three actual period characters. -% -\def\dots{% - \leavevmode - \hbox to 1.5em{% - \hskip 0pt plus 0.25fil - .\hfil.\hfil.% - \hskip 0pt plus 0.5fil - }% -} - -% @enddots{} is an end-of-sentence ellipsis. -% -\def\enddots{% - \dots - \spacefactor=3000 -} - -% @comma{} is so commas can be inserted into text without messing up -% Texinfo's parsing. -% -\let\comma = , - -% @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 \undefined, -% borrowed from ifpdf.sty. -\ifx\pdfoutput\undefined -\else - \ifx\pdfoutput\relax - \else - \ifcase\pdfoutput - \else - \pdftrue - \fi - \fi -\fi -% -\ifpdf - \input pdfcolor - \pdfcatalog{/PageMode /UseOutlines}% - \def\dopdfimage#1#2#3{% - \def\imagewidth{#2}% - \def\imageheight{#3}% - % without \immediate, 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 - \ifx\empty\imagewidth\else width \imagewidth \fi - \ifx\empty\imageheight\else height \imageheight \fi - \ifnum\pdftexversion<13 - #1.pdf% - \else - {#1.pdf}% - \fi - \ifnum\pdftexversion < 14 \else - \pdfrefximage \pdflastximage - \fi} - \def\pdfmkdest#1{{% - % We have to set dummies so commands such as @code in a section title - % aren't expanded. - \atdummies - \normalturnoffactive - \pdfdest name{#1} xyz% - }} - \def\pdfmkpgn#1{#1} - \let\linkcolor = \Blue % was Cyan, but that seems light? - \def\endlink{\Black\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. #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 worthwhile, since most documents are normally structured. - \def\pdfoutlinedest{#3}% - \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}\fi - % - \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{#1}% - } - % - \def\pdfmakeoutlines{% - \begingroup - % Thanh's hack / proper braces in bookmarks - \edef\mylbrace{\iftrue \string{\else}\fi}\let\{=\mylbrace - \edef\myrbrace{\iffalse{\else\string}\fi}\let\}=\myrbrace - % - % Read toc silently, to get counts of subentries for \pdfoutline. - \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}% - \input \jobname.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. - % - % xx to do this right, we have to translate 8-bit characters to - % their "best" equivalent, based on the @documentencoding. Right - % now, I guess we'll just let the pdf reader have its way. - \indexnofonts - \turnoffactive - \input \jobname.toc - \endgroup - } - % - \def\makelinks #1,{% - \def\params{#1}\def\E{END}% - \ifx\params\E - \let\nextmakelinks=\relax - \else - \let\nextmakelinks=\makelinks - \ifnum\lnkcount>0,\fi - \picknum{#1}% - \startlink attr{/Border [0 0 0]} - goto name{\pdfmkpgn{\the\pgn}}% - \linkcolor #1% - \advance\lnkcount by 1% - \endlink - \fi - \nextmakelinks - } - \def\picknum#1{\expandafter\pn#1} - \def\pn#1{% - \def\p{#1}% - \ifx\p\lbrace - \let\nextpn=\ppn - \else - \let\nextpn=\ppnn - \def\first{#1} - \fi - \nextpn - } - \def\ppn#1{\pgn=#1\gobble} - \def\ppnn{\pgn=\first} - \def\pdfmklnk#1{\lnkcount=0\makelinks #1,END,} - \def\skipspaces#1{\def\PP{#1}\def\D{|}% - \ifx\PP\D\let\nextsp\relax - \else\let\nextsp\skipspaces - \ifx\p\space\else\addtokens{\filename}{\PP}% - \advance\filenamelength by 1 - \fi - \fi - \nextsp} - \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} - \ifnum\pdftexversion < 14 - \let \startlink \pdfannotlink - \else - \let \startlink \pdfstartlink - \fi - \def\pdfurl#1{% - \begingroup - \normalturnoffactive\def\@{@}% - \makevalueexpandable - \leavevmode\Red - \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}} - \linkcolor #1\endlink} - \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} -\else - \let\pdfmkdest = \gobble - \let\pdfurl = \gobble - \let\endlink = \relax - \let\linkcolor = \relax - \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}} - -% 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}} - -% Default leading. -\newdimen\textleading \textleading = 13.2pt - -% 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} -% -\def\setleading#1{% - \normalbaselineskip = #1\relax - \normallineskip = \lineskipfactor\normalbaselineskip - \normalbaselines - \setbox\strutbox =\hbox{% - \vrule width0pt height\strutheightpercent\baselineskip - depth \strutdepthpercent \baselineskip - }% -} - -% Set the font macro #1 to the font named #2, adding on the -% specified font prefix (normally `cm'). -% #3 is the font's design size, #4 is a scale factor -\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} - -% Use cm as the default font prefix. -% To specify the font prefix, you must define \fontprefix -% before you read in texinfo.tex. -\ifx\fontprefix\undefined -\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} - -% Text fonts (11.2pt, magstep1). -\def\textnominalsize{11pt} -\edef\mainmagstep{\magstephalf} -\setfont\textrm\rmshape{10}{\mainmagstep} -\setfont\texttt\ttshape{10}{\mainmagstep} -\setfont\textbf\bfshape{10}{\mainmagstep} -\setfont\textit\itshape{10}{\mainmagstep} -\setfont\textsl\slshape{10}{\mainmagstep} -\setfont\textsf\sfshape{10}{\mainmagstep} -\setfont\textsc\scshape{10}{\mainmagstep} -\setfont\textttsl\ttslshape{10}{\mainmagstep} -\font\texti=cmmi10 scaled \mainmagstep -\font\textsy=cmsy10 scaled \mainmagstep - -% A few fonts for @defun names and args. -\setfont\defbf\bfshape{10}{\magstep1} -\setfont\deftt\ttshape{10}{\magstep1} -\setfont\defttsl\ttslshape{10}{\magstep1} -\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} -\setfont\smalltt\ttshape{9}{1000} -\setfont\smallbf\bfshape{10}{900} -\setfont\smallit\itshape{9}{1000} -\setfont\smallsl\slshape{9}{1000} -\setfont\smallsf\sfshape{9}{1000} -\setfont\smallsc\scshape{10}{900} -\setfont\smallttsl\ttslshape{10}{900} -\font\smalli=cmmi9 -\font\smallsy=cmsy9 - -% Fonts for small examples (8pt). -\def\smallernominalsize{8pt} -\setfont\smallerrm\rmshape{8}{1000} -\setfont\smallertt\ttshape{8}{1000} -\setfont\smallerbf\bfshape{10}{800} -\setfont\smallerit\itshape{8}{1000} -\setfont\smallersl\slshape{8}{1000} -\setfont\smallersf\sfshape{8}{1000} -\setfont\smallersc\scshape{10}{800} -\setfont\smallerttsl\ttslshape{10}{800} -\font\smalleri=cmmi8 -\font\smallersy=cmsy8 - -% Fonts for title page (20.4pt): -\def\titlenominalsize{20pt} -\setfont\titlerm\rmbshape{12}{\magstep3} -\setfont\titleit\itbshape{10}{\magstep4} -\setfont\titlesl\slbshape{10}{\magstep4} -\setfont\titlett\ttbshape{12}{\magstep3} -\setfont\titlettsl\ttslshape{10}{\magstep4} -\setfont\titlesf\sfbshape{17}{\magstep1} -\let\titlebf=\titlerm -\setfont\titlesc\scbshape{10}{\magstep4} -\font\titlei=cmmi12 scaled \magstep3 -\font\titlesy=cmsy10 scaled \magstep4 -\def\authorrm{\secrm} -\def\authortt{\sectt} - -% Chapter (and unnumbered) fonts (17.28pt). -\def\chapnominalsize{17pt} -\setfont\chaprm\rmbshape{12}{\magstep2} -\setfont\chapit\itbshape{10}{\magstep3} -\setfont\chapsl\slbshape{10}{\magstep3} -\setfont\chaptt\ttbshape{12}{\magstep2} -\setfont\chapttsl\ttslshape{10}{\magstep3} -\setfont\chapsf\sfbshape{17}{1000} -\let\chapbf=\chaprm -\setfont\chapsc\scbshape{10}{\magstep3} -\font\chapi=cmmi12 scaled \magstep2 -\font\chapsy=cmsy10 scaled \magstep3 - -% Section fonts (14.4pt). -\def\secnominalsize{14pt} -\setfont\secrm\rmbshape{12}{\magstep1} -\setfont\secit\itbshape{10}{\magstep2} -\setfont\secsl\slbshape{10}{\magstep2} -\setfont\sectt\ttbshape{12}{\magstep1} -\setfont\secttsl\ttslshape{10}{\magstep2} -\setfont\secsf\sfbshape{12}{\magstep1} -\let\secbf\secrm -\setfont\secsc\scbshape{10}{\magstep2} -\font\seci=cmmi12 scaled \magstep1 -\font\secsy=cmsy10 scaled \magstep2 - -% Subsection fonts (13.15pt). -\def\ssecnominalsize{13pt} -\setfont\ssecrm\rmbshape{12}{\magstephalf} -\setfont\ssecit\itbshape{10}{1315} -\setfont\ssecsl\slbshape{10}{1315} -\setfont\ssectt\ttbshape{12}{\magstephalf} -\setfont\ssecttsl\ttslshape{10}{1315} -\setfont\ssecsf\sfbshape{12}{\magstephalf} -\let\ssecbf\ssecrm -\setfont\ssecsc\scbshape{10}{1315} -\font\sseci=cmmi12 scaled \magstephalf -\font\ssecsy=cmsy10 scaled 1315 - -% Reduced fonts for @acro in text (10pt). -\def\reducednominalsize{10pt} -\setfont\reducedrm\rmshape{10}{1000} -\setfont\reducedtt\ttshape{10}{1000} -\setfont\reducedbf\bfshape{10}{1000} -\setfont\reducedit\itshape{10}{1000} -\setfont\reducedsl\slshape{10}{1000} -\setfont\reducedsf\sfshape{10}{1000} -\setfont\reducedsc\scshape{10}{1000} -\setfont\reducedttsl\ttslshape{10}{1000} -\font\reducedi=cmmi10 -\font\reducedsy=cmsy10 - -% 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{25pt}} -\def\titlefont#1{{\titlefonts\rm #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}} - -% 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 -% -% I wish the USA used A4 paper. -% --karl, 24jan03. - - -% Set up the default fonts, so we can use them for creating boxes. -% -\textfonts \rm - -% Define these so they can be easily changed for other fonts. -\def\angleleft{$\langle$} -\def\angleright{$\rangle$} - -% Count depth in font-changes, for error checks -\newcount\fontdepth \fontdepth=0 - -% Fonts for short table of contents. -\setfont\shortcontrm\rmshape{12}{1000} -\setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12 -\setfont\shortcontsl\slshape{12}{1000} -\setfont\shortconttt\ttshape{12}{1000} - -%% Add scribe-like font environments, plus @l for inline lisp (usually sans -%% serif) and @ii for TeX italic - -% \smartitalic{ARG} outputs arg in italics, followed by an italic correction -% unless the following character is such as not to need one. -\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else - \ptexslash\fi\fi\fi} -\def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx} -\def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx} - -% like \smartslanted except unconditionally uses \ttsl. -% @var is set to this for defun arguments. -\def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx} - -% like \smartslanted except unconditionally use \sl. We never want -% ttsl for book titles, do we? -\def\cite#1{{\sl #1}\futurelet\next\smartitalicx} - -\let\i=\smartitalic -\let\slanted=\smartslanted -\let\var=\smartslanted -\let\dfn=\smartslanted -\let\emph=\smartitalic - -% @b, explicit bold. -\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\frenchspacing{% - \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m - \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m - } -\catcode`@=\other - -\def\t#1{% - {\tt \rawbackslash \frenchspacing #1}% - \null -} -\def\samp#1{`\tclose{#1}'\null} -\setfont\keyrm\rmshape{8}{1000} -\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}}}} -% The old definition, with no lozenge: -%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} -\def\ctrl #1{{\tt \rawbackslash \hat}#1} - -% @file, @option are the same as @samp. -\let\file=\samp -\let\option=\samp - -% @code is a modification of @t, -% which makes spaces the same size as normal in the surrounding text. -\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 - \frenchspacing - #1% - }% - \null -} - -% 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 - % - \global\def\code{\begingroup - \catcode`\-=\active \let-\codedash - \catcode`\_=\active \let_\codeunder - \codex - } -} - -\def\realdash{-} -\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{}{}{}}% - {\_}% -} -\def\codex #1{\tclose{#1}\endgroup} - -% @kbd is like @code, except that if the argument is just one @key command, -% then @kbd has no effect. - -% @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\arg{#1}% - \ifx\arg\worddistinct - \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% - \else\ifx\arg\wordexample - \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% - \else\ifx\arg\wordcode - \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% - \else - \errhelp = \EMsimple - \errmessage{Unknown @kbdinputstyle option `\arg'}% - \fi\fi\fi -} -\def\worddistinct{distinct} -\def\wordexample{example} -\def\wordcode{code} - -% Default is `distinct.' -\kbdinputstyle distinct - -\def\xkey{\key} -\def\kbdfoo#1#2#3\par{\def\one{#1}\def\three{#3}\def\threex{??}% -\ifx\one\xkey\ifx\threex\three \key{#2}% -\else{\tclose{\kbdfont\look}}\fi -\else{\tclose{\kbdfont\look}}\fi} - -% For @indicateurl, @env, @command quotes seem unnecessary, so use \code. -\let\indicateurl=\code -\let\env=\code -\let\command=\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. Perhaps eventually put in -% a hypertex \special here. -% -\def\uref#1{\douref #1,,,\finish} -\def\douref#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} - -% @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 - -% 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 } - -% 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} - -\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} - -% @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} - -% 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 - -% @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 -} - -% @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{% - {\frenchspacing #1}% - \def\temp{#2}% - \ifx\temp\empty \else - \space ({\unsepspaces \ignorespaces \temp \unskip})% - \fi -} - -% @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 -} - -% @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}}% - }$% -} - -% 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\undefined -\def\Orb{\mathhexbox20D} -\fi - - -\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 -} - -%%% Macros to be used within @titlepage: - -\let\subtitlerm=\tenrm -\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} - -\def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines - \let\tt=\authortt} - -\parseargdef\title{% - \checkenv\titlepage - \leftline{\titlefonts\rm #1} - % 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 - {\authorfont \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 -\baselineskip - \global\advance\vsize by -\baselineskip -} - -\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} - - -% @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{% -\global\evenheadline={\hfil} \global\evenfootline={\hfil} -\global\oddheadline={\hfil} \global\oddfootline={\hfil}} -\HEADINGSoff -% 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\undefined -\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 - \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 - \def\itemcontents{#1}% - % @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 <number>. - % - \ifnum\lccode\expandafter`\thearg=0\relax - \numericenumerate % a number (we hope) - \else - % It's a letter. - \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax - \lowercaseenumerate % lowercase letter - \else - \uppercaseenumerate % uppercase letter - \fi - \fi - \else - % Multiple tokens in the argument. We hope it's a number. - \numericenumerate - \fi -} - -% An @enumerate whose labels are integers. The starting integer is -% given in \thearg. -% -\def\numericenumerate{% - \itemno = \thearg - \startenumeration{\the\itemno}% -} - -% The starting (lowercase) letter is in \thearg. -\def\lowercaseenumerate{% - \itemno = \expandafter`\thearg - \startenumeration{% - % Be sure we're not beyond the end of the alphabet. - \ifnum\itemno=0 - \errmessage{No more lowercase letters in @enumerate; get a bigger - alphabet}% - \fi - \char\lccode\itemno - }% -} - -% The starting (uppercase) letter is in \thearg. -\def\uppercaseenumerate{% - \itemno = \expandafter`\thearg - \startenumeration{% - % Be sure we're not beyond the end of the alphabet. - \ifnum\itemno=0 - \errmessage{No more uppercase letters in @enumerate; get a bigger - alphabet} - \fi - \char\uccode\itemno - }% -} - -% Call \doitemize, adding a period to the first argument and supplying the -% common last two arguments. Also subtract one from the initial value in -% \itemno, since @item increments \itemno. -% -\def\startenumeration#1{% - \advance\itemno by -1 - \doitemize{#1.}\flushcr -} - -% @alphaenumerate and @capsenumerate are abbreviations for giving an arg -% to @enumerate. -% -\def\alphaenumerate{\enumerate{a}} -\def\capsenumerate{\enumerate{A}} -\def\Ealphaenumerate{\Eenumerate} -\def\Ecapsenumerate{\Eenumerate} - - -% @multitable macros -% Amy Hendrickson, 8/18/94, 3/6/96 -% -% @multitable ... @end multitable will make as many columns as desired. -% Contents of each column will wrap at width given in preamble. Width -% can be specified either with sample text given in a template line, -% or in percent of \hsize, the current width of text on page. - -% Table can continue over pages but will only break between lines. - -% To make preamble: -% -% Either define widths of columns in terms of percent of \hsize: -% @multitable @columnfractions .25 .3 .45 -% @item ... -% -% Numbers following @columnfractions are the percent of the total -% current hsize to be used for each column. You may use as many -% columns as desired. - - -% Or use a template: -% @multitable {Column 1 template} {Column 2 template} {Column 3 template} -% @item ... -% using the widest term desired in each column. - -% Each new table line starts with @item, each subsequent new column -% starts with @tab. Empty columns may be produced by supplying @tab's -% with nothing between them for as many times as empty columns are needed, -% ie, @tab@tab@tab will produce two empty columns. - -% @item, @tab do not need to be on their own lines, but it will not hurt -% if they are. - -% Sample multitable: - -% @multitable {Column 1 template} {Column 2 template} {Column 3 template} -% @item first col stuff @tab second col stuff @tab third col -% @item -% first col stuff -% @tab -% second col stuff -% @tab -% third col -% @item first col stuff @tab second col stuff -% @tab Many paragraphs of text may be used in any column. -% -% They will wrap at the width determined by the template. -% @item@tab@tab This will be in third column. -% @end multitable - -% Default dimensions may be reset by user. -% @multitableparskip is vertical space between paragraphs in table. -% @multitableparindent is paragraph indent in table. -% @multitablecolmargin is horizontal space to be left between columns. -% @multitablelinespace is space to leave between table items, baseline -% to baseline. -% 0pt means it depends on current normal line spacing. -% -\newskip\multitableparskip -\newskip\multitableparindent -\newdimen\multitablecolspace -\newskip\multitablelinespace -\multitableparskip=0pt -\multitableparindent=6pt -\multitablecolspace=12pt -\multitablelinespace=0pt - -% Macros used to set up halign preamble: -% -\let\endsetuptable\relax -\def\xendsetuptable{\endsetuptable} -\let\columnfractions\relax -\def\xcolumnfractions{\columnfractions} -\newif\ifsetpercent - -% #1 is the @columnfraction, usually a decimal number like .5, but might -% be just 1. We just use it, whatever it is. -% -\def\pickupwholefraction#1 {% - \global\advance\colcount by 1 - \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}% - \setuptable -} - -\newcount\colcount -\def\setuptable#1{% - \def\firstarg{#1}% - \ifx\firstarg\xendsetuptable - \let\go = \relax - \else - \ifx\firstarg\xcolumnfractions - \global\setpercenttrue - \else - \ifsetpercent - \let\go\pickupwholefraction - \else - \global\advance\colcount by 1 - \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a - % separator; typically that is always in the input, anyway. - \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% - \fi - \fi - \ifx\go\pickupwholefraction - % Put the argument back for the \pickupwholefraction call, so - % we'll always have a period there to be parsed. - \def\go{\pickupwholefraction#1}% - \else - \let\go = \setuptable - \fi% - \fi - \go -} - -% multitable-only commands. -% -% @headitem starts a heading row, which we typeset in bold. -% Assignments have to be global since we are inside the implicit group -% of an alignment entry. Note that \everycr resets \everytab. -\def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}% -% -% 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 encounter the problem it was intended to solve again. -% --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: - \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', which must be on a line - % by itself. - \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. - \obeylines % - \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. -\def\enddoignore{\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-\realdash \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 ifclear reads 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}} - -% @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 \undefined - % 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{% - \def\@{@}% change to @@ when we switch to @ as escape char in index files. - \def\ {\realbackslash\space }% - % Need these in case \tex is in effect and \{ is a \delimiter again. - % But can't use \lbracecmd and \rbracecmd because texindex assumes - % braces and backslashes are used only as delimiters. - \let\{ = \mylbrace - \let\} = \myrbrace - % - % \definedummyword defines \#1 as \realbackslash #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{% - \expandafter\def\csname ##1\endcsname{\realbackslash ##1\space}% - }% - \def\definedummyletter##1{% - \expandafter\def\csname ##1\endcsname{\realbackslash ##1}% - }% - \let\definedummyaccent\definedummyletter - % - % Do the redefinitions. - \commondummies -} - -% For the aux file, @ is the escape character. So we want to redefine -% everything using @ instead of \realbackslash. When everything uses -% @, this will be simpler. -% -\def\atdummies{% - \def\@{@@}% - \def\ {@ }% - \let\{ = \lbraceatcmd - \let\} = \rbraceatcmd - % - % (See comments in \indexdummies.) - \def\definedummyword##1{% - \expandafter\def\csname ##1\endcsname{@##1\space}% - }% - \def\definedummyletter##1{% - \expandafter\def\csname ##1\endcsname{@##1}% - }% - \let\definedummyaccent\definedummyletter - % - % Do the redefinitions. - \commondummies -} - -% Called from \indexdummies and \atdummies. \definedummyword and -% \definedummyletter must be defined first. -% -\def\commondummies{% - % - \normalturnoffactive - % - \commondummiesnofonts - % - \definedummyletter{_}% - % - % Non-English letters. - \definedummyword{AA}% - \definedummyword{AE}% - \definedummyword{L}% - \definedummyword{OE}% - \definedummyword{O}% - \definedummyword{aa}% - \definedummyword{ae}% - \definedummyword{l}% - \definedummyword{oe}% - \definedummyword{o}% - \definedummyword{ss}% - \definedummyword{exclamdown}% - \definedummyword{questiondown}% - \definedummyword{ordf}% - \definedummyword{ordm}% - % - % 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{bullet}% - \definedummyword{comma}% - \definedummyword{copyright}% - \definedummyword{registeredsymbol}% - \definedummyword{dots}% - \definedummyword{enddots}% - \definedummyword{equiv}% - \definedummyword{error}% - \definedummyword{euro}% - \definedummyword{expansion}% - \definedummyword{minus}% - \definedummyword{pounds}% - \definedummyword{point}% - \definedummyword{print}% - \definedummyword{result}% - % - % Handle some cases of @value -- where it does not contain any - % (non-fully-expandable) commands. - \makevalueexpandable - % - % Normal spaces, not active ones. - \unsepspaces - % - % No macro expansion. - \turnoffmacros -} - -% \commondummiesnofonts: common to \commondummies and \indexnofonts. -% -% Better have this without active chars. -{ - \catcode`\~=\other - \gdef\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{ringaccent}% - \definedummyword{tieaccent}% - \definedummyword{ubaraccent}% - \definedummyword{udotaccent}% - \definedummyword{dotless}% - % - % Texinfo font commands. - \definedummyword{b}% - \definedummyword{i}% - \definedummyword{r}% - \definedummyword{sc}% - \definedummyword{t}% - % - % Commands that take arguments. - \definedummyword{acronym}% - \definedummyword{cite}% - \definedummyword{code}% - \definedummyword{command}% - \definedummyword{dfn}% - \definedummyword{emph}% - \definedummyword{env}% - \definedummyword{file}% - \definedummyword{kbd}% - \definedummyword{key}% - \definedummyword{math}% - \definedummyword{option}% - \definedummyword{samp}% - \definedummyword{strong}% - \definedummyword{tie}% - \definedummyword{uref}% - \definedummyword{url}% - \definedummyword{var}% - \definedummyword{verb}% - \definedummyword{w}% - } -} - -% \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{% - \expandafter\let\csname ##1\endcsname\asis - }% - % We can just ignore other control letters. - \def\definedummyletter##1{% - \expandafter\def\csname ##1\endcsname{}% - }% - % Hopefully, all control words can become @asis. - \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\@{@}% - % how to handle braces? - \def\_{\normalunderscore}% - % - % Non-English letters. - \def\AA{AA}% - \def\AE{AE}% - \def\L{L}% - \def\OE{OE}% - \def\O{O}% - \def\aa{aa}% - \def\ae{ae}% - \def\l{l}% - \def\oe{oe}% - \def\o{o}% - \def\ss{ss}% - \def\exclamdown{!}% - \def\questiondown{?}% - \def\ordf{a}% - \def\ordm{o}% - % - \def\LaTeX{LaTeX}% - \def\TeX{TeX}% - % - % Assorted special characters. - % (The following {} will end up in the sort string, but that's ok.) - \def\bullet{bullet}% - \def\comma{,}% - \def\copyright{copyright}% - \def\registeredsymbol{R}% - \def\dots{...}% - \def\enddots{...}% - \def\equiv{==}% - \def\error{error}% - \def\euro{euro}% - \def\expansion{==>}% - \def\minus{-}% - \def\pounds{pounds}% - \def\point{.}% - \def\print{-|}% - \def\result{=>}% - % - % Don't write macro names. - \emptyusermacros -} - -\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}% - % - \ifvmode - \dosubindsanitize - \else - \dosubindwrite - \fi - }% - \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 - \escapechar=`\\ - \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: -% -% 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 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} -% -% ..., ready, GO: -% -\def\dosubindsanitize{% - % \lastskip and \lastpenalty cannot both be nonzero simultaneously. - \skip0 = \lastskip - \edef\lastskipmacro{\the\lastskip}% - \count255 = \lastpenalty - % - % If \lastskip is nonzero, that means the last item was a - % skip. And since a skip is discardable, that means this - % -\skip0 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-\skip0 - \fi - % - \dosubindwrite - % - \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\count255>9999 \penalty\count255 \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\skip0 - \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 - \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 frozes 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 - % - % Swallow the left brace of the text (first parameter): - \afterassignment\doentry - \let\temp = -} -\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. - \def\tempa{{\rm }}% - \def\tempb{#1}% - \edef\tempc{\tempa}% - \edef\tempd{\tempb}% - \ifx\tempc\tempd - \ % - \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 \dotfill except takes at least 1 em. -\def\indexdotfill{\cleaders - \hbox{$\mathsurround=0pt \mkern1.5mu ${\it .}$ \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{% - \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. - -% \unnumberedno is an oxymoron, of course. 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 this as the name of the chapter. -% page headings and footings can use it. @section does likewise. -% However, they are not reliable, because we don't use marks. -\def\thischapter{} -\def\thissection{} - -\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 achive this, remember the "biggest" unnum. sec. we are currently in: -\chardef\unmlevel = \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 < \unmlevel - \chardef\unmlevel = \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 > \unmlevel - \def\headtype{U}% - \else - \chardef\unmlevel = 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 - % - \message{\putwordChapter\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 apphead0 calls appendixzzz -\def\appendixzzz#1{% - \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 - \global\advance\appendixno by 1 - \gdef\chaplevelprefix{\appendixletter.}% - \resetallfloatnos - % - \def\appendixnum{\putwordAppendix\space \appendixletter}% - \message{\appendixnum}% - % - \chapmacro{#1}{Yappendix}{\appendixletter}% - % - \global\let\section = \appendixsec - \global\let\subsection = \appendixsubsec - \global\let\subsubsection = \appendixsubsubsec -} - -\outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz -\def\unnumberedzzz#1{% - \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 - \global\advance\unnumberedno by 1 - % - % Since an unnumbered has no number, no prefix for figures. - \global\let\chaplevelprefix = \empty - \resetallfloatnos - % - % This used to be simply \message{#1}, but TeX fully expands the - % argument to \message. Therefore, if #1 contained @-commands, TeX - % expanded them. For example, in `@unnumbered The @cite{Book}', TeX - % expanded @cite (which turns out to cause errors because \cite is meant - % to be executed, not expanded). - % - % Anyway, we don't want the fully-expanded definition of @cite to appear - % as a result of the \message, we just want `@cite' itself. We use - % \the<toks register> to achieve this: TeX expands \the<toks> only once, - % simply yielding the contents of <toks register>. (We also do this for - % the toc entries.) - \toks0 = {#1}% - \message{(\the\toks0)}% - % - \chapmacro{#1}{Ynothing}{\the\unnumberedno}% - % - \global\let\section = \unnumberedsec - \global\let\subsection = \unnumberedsubsec - \global\let\subsubsection = \unnumberedsubsubsec -} - -% @centerchap is like @unnumbered, but the heading is centered. -\outer\parseargdef\centerchap{% - % 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}% -} - -\outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz -\def\appendixsectionzzz#1{% - \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 - \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% -} -\let\appendixsec\appendixsection - -\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz -\def\unnumberedseczzz#1{% - \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 - \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% -} - -% Subsections. -\outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz -\def\numberedsubseczzz#1{% - \global\subsubsecno=0 \global\advance\subsecno by 1 - \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% -} - -\outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz -\def\appendixsubseczzz#1{% - \global\subsubsecno=0 \global\advance\subsecno by 1 - \sectionheading{#1}{subsec}{Yappendix}% - {\appendixletter.\the\secno.\the\subsecno}% -} - -\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz -\def\unnumberedsubseczzz#1{% - \global\subsubsecno=0 \global\advance\subsecno by 1 - \sectionheading{#1}{subsec}{Ynothing}% - {\the\unnumberedno.\the\secno.\the\subsecno}% -} - -% Subsubsections. -\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz -\def\numberedsubsubseczzz#1{% - \global\advance\subsubsecno by 1 - \sectionheading{#1}{subsubsec}{Ynumbered}% - {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% -} - -\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz -\def\appendixsubsubseczzz#1{% - \global\advance\subsubsecno by 1 - \sectionheading{#1}{subsubsec}{Yappendix}% - {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% -} - -\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz -\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 - -% NOTE on use of \vbox for chapter headings, section headings, and such: -% 1) We use \vbox rather than the earlier \line to permit -% overlong headings to fold. -% 2) \hyphenpenalty is set to 10000 because hyphenation in a -% heading is obnoxious; this forbids it. -% 3) Likewise, headings look best if no \parindent is used, and -% if justification is not attempted. Hence \raggedright. - - -\def\majorheading{% - {\advance\chapheadingskip by 10pt \chapbreak }% - \parsearg\chapheadingzzz -} - -\def\chapheading{\chapbreak \parsearg\chapheadingzzz} -\def\chapheadingzzz#1{% - {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt\raggedright - \rm #1\hfill}}% - \bigskip \par\penalty 200\relax - \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} - -%%% Define plain chapter starts, and page on/off switching for it -% Parameter controlling skip before chapter headings (if needed) - -\newskip\chapheadingskip - -\def\chapbreak{\dobreak \chapheadingskip {-4000}} -\def\chappager{\par\vfill\supereject} -\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\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{% - \pchapsepmacro - {% - \chapfonts \rm - % - % Have to define \thissection 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\thissection{#1}% - \gdef\thischaptername{#1}% - % - % Only insert the separating space if we have a chapter/appendix - % number, and don't print the unnumbered ``number''. - \def\temptype{#2}% - \ifx\temptype\Ynothingkeyword - \setbox0 = \hbox{}% - \def\toctype{unnchap}% - \gdef\thischapter{#1}% - \else\ifx\temptype\Yomitfromtockeyword - \setbox0 = \hbox{}% contents like unnumbered, but no toc entry - \def\toctype{omit}% - \gdef\thischapter{}% - \else\ifx\temptype\Yappendixkeyword - \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% - \def\toctype{app}% - % We don't substitute the actual chapter name into \thischapter - % because we don't want its macros evaluated now. And we don't - % use \thissection because that changes with each section. - % - \xdef\thischapter{\putwordAppendix{} \appendixletter: - \noexpand\thischaptername}% - \else - \setbox0 = \hbox{#3\enspace}% - \def\toctype{numchap}% - \xdef\thischapter{\putwordChapter{} \the\chapno: - \noexpand\thischaptername}% - \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. - \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright - \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 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt\raggedright - \rm #1\hfill}}\bigskip \par\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 {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt - \hfill {\rm #1}\hfill}}\bigskip \par\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\sectionheading#1#2#3#4{% - {% - % Switch to the right set of fonts. - \csname #2fonts\endcsname \rm - % - % Insert space above the heading. - \csname #2headingbreak\endcsname - % - % Only insert the space after the number if we have a section number. - \def\sectionlevel{#2}% - \def\temptype{#3}% - % - \ifx\temptype\Ynothingkeyword - \setbox0 = \hbox{}% - \def\toctype{unn}% - \gdef\thissection{#1}% - \else\ifx\temptype\Yomitfromtockeyword - % for @headings -- no section number, don't include in toc, - % and don't redefine \thissection. - \setbox0 = \hbox{}% - \def\toctype{omit}% - \let\sectionlevel=\empty - \else\ifx\temptype\Yappendixkeyword - \setbox0 = \hbox{#4\enspace}% - \def\toctype{app}% - \gdef\thissection{#1}% - \else - \setbox0 = \hbox{#4\enspace}% - \def\toctype{num}% - \gdef\thissection{#1}% - \fi\fi\fi - % - % Write the toc entry (before \donoderef). See comments in \chfplain. - \writetocentry{\toctype\sectionlevel}{#1}{#4}% - % - % Write the node reference (= pdf destination for pdftex). - % Again, see comments in \chfplain. - \donoderef{#3}% - % - % Output the actual section heading. - \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright - \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.) - \vskip-\parskip - % - % This is purely so the last item on the list is a known \penalty > - % 10000. This is so \startdefun can avoid allowing breakpoints after - % section headings. Otherwise, it would insert a valid breakpoint between: - % - % @section sec-whatever - % @deffn def-whatever - \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 - \toks0 = {#2}% - \toks2 = \expandafter{\lastnode}% - \edef\temp{\write\tocfile{\realbackslash #1entry{\the\toks0}{#3}% - {\the\toks2}{\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 -} - -\newskip\contentsrightmargin \contentsrightmargin=1in -\newcount\savepageno -\newcount\lastnegativepageno \lastnegativepageno = -1 - -% Prepare to read what we've written to \tocfile. -% -\def\startcontents#1{% - % If @setchapternewpage on, and @headings double, the contents should - % start on an odd page, unlike chapters. Thus, we maintain - % \contentsalignmacro in parallel with \pagealignmacro. - % From: Torbjorn Granlund <tege@matematik.su.se> - \contentsalignmacro - \immediate\closeout\tocfile - % - % Don't need to put `Contents' or `Short Contents' in the headline. - % It is abundantly clear what they are. - \def\thischapter{}% - \chapmacro{#1}{Yomitfromtoc}{}% - % - \savepageno = \pageno - \begingroup % Set up to handle contents files properly. - \catcode`\\=0 \catcode`\{=1 \catcode`\}=2 \catcode`\@=11 - % We can't do this, because then an actual ^ in a section - % title fails, e.g., @chapter ^ -- exponentiation. --karl, 9jul97. - %\catcode`\^=7 % to see ^^e4 as \"a etc. juha@piuha.ydi.vtt.fi - \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 -} - - -% Normal (long) toc. -\def\contents{% - \startcontents{\putwordTOC}% - \openin 1 \jobname.toc - \ifeof 1 \else - \input \jobname.toc - \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\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 \jobname.toc - \ifeof 1 \else - \input \jobname.toc - \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, ... - -% 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. - -% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. -% -% Since these characters are used in examples, it should be an even number of -% \tt widths. Each \tt character is 1en, so two makes it 1em. -% -\def\point{$\star$} -\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} -\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} -\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} -\def\equiv{\leavevmode\lower.1ex\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 \tensf error\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} - -% @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 tex @ character. - -\envdef\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 - \escapechar=`\\ - % - \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 - % - \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. -\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=\comment - \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. -\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 - \parindent = 0pt - \emergencystretch = 0pt % don't try to avoid overfull boxes - % @cartouche defines \nonarrowing to inhibit narrowing - % at next level down. - \ifx\nonarrowing\relax - \advance \leftskip by \lispnarrowing - \exdentamount=\lispnarrowing - \fi - \let\exdent=\nofillexdent -} - -% 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 - \smallexamplefonts \rm - \fi -} -\def\setsmalldispenv{% - \ifx\SETdispenvsize\nosmallword - \else - \smallexamplefonts \rm - \fi -} - -% We often define two environments, @foo and @smallfoo. -% Let's do it by one command: -\def\makedispenv #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 synonyms: -\def\maketwodispenvs #1#2#3{ - \makedispenv{#1}{#3} - \makedispenv{#2}{#3} -} - -% @lisp: indented, narrowed, typewriter font; @example: same as @lisp. -% -% @smallexample and @smalllisp: use smaller fonts. -% Originally contributed by Pavel@xerox. -% -\maketwodispenvs {lisp}{example}{% - \nonfillstart - \tt - \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. - \gobble % eat return -} - -% @display/@smalldisplay: same as @lisp except keep current font. -% -\makedispenv {display}{% - \nonfillstart - \gobble -} - -% @format/@smallformat: same as @display except don't narrow margins. -% -\makedispenv{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 - \gobble -} -\let\Eflushright = \afterenvbreak - - -% @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. -% -\envdef\quotation{% - {\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 - \advance\rightskip by \lispnarrowing - \exdentamount = \lispnarrowing - \let\nonarrowing = \relax - \fi - \parsearg\quotationlabel -} - -% We have retained a nonzero parskip for the environment, since we're -% doing normal filling. -% -\def\Equotation{% - \par - \ifx\quotationauthor\undefined\else - % indent a bit. - \leftline{\kern 2\leftskip \sl ---\quotationauthor}% - \fi - {\parskip=0pt \afterenvbreak}% -} - -% 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 -} - - -% LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} -% If we want to allow any <char> as delimiter, -% we need the curly braces so that makeinfo sees the @verb command, eg: -% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org -% -% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. -% -% [Knuth] p.344; only we need to do the other characters Texinfo sets -% active too. Otherwise, they get lost as the first character on a -% verbatim line. -\def\dospecials{% - \do\ \do\\\do\{\do\}\do\$\do\&% - \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% - \do\<\do\>\do\|\do\@\do+\do\"% -} -% -% [Knuth] p. 380 -\def\uncatcodespecials{% - \def\do##1{\catcode`##1=\other}\dospecials} -% -% [Knuth] pp. 380,381,391 -% Disable Spanish ligatures ?` and !` of \tt font -\begingroup - \catcode`\`=\active\gdef`{\relax\lq} -\endgroup -% -% 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}% - \catcode`\`=\active - \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 -% -\def\starttabbox{\setbox0=\hbox\bgroup} -\begingroup - \catcode`\^^I=\active - \gdef\tabexpand{% - \catcode`\^^I=\active - \def^^I{\leavevmode\egroup - \dimen0=\wd0 % the width so far, or since the previous tab - \divide\dimen0 by\tabw - \multiply\dimen0 by\tabw % compute previous multiple of \tabw - \advance\dimen0 by\tabw % advance to next multiple of \tabw - \wd0=\dimen0 \box0 \starttabbox - }% - } -\endgroup -\def\setupverbatim{% - \nonfillstart - \advance\leftskip by -\defbodyindent - % Easiest (and conventionally used) font for verbatim - \tt - \def\par{\leavevmode\egroup\box0\endgraf}% - \catcode`\`=\active - \tabexpand - % Respect line breaks, - % print special symbols as themselves, and - % make each space count - % must do in this order: - \obeylines \uncatcodespecials \sepspaces - \everypar{\starttabbox}% -} - -% Do the @verb magic: verbatim text is quoted by unique -% delimiter characters. Before first delimiter expect a -% right brace, after last delimiter expect closing brace: -% -% \def\doverb'{'<char>#1<char>'}'{#1} -% -% [Knuth] p. 382; only eat outer {} -\begingroup - \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other - \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] -\endgroup -% -\def\verb{\begingroup\setupverb\doverb} -% -% -% Do the @verbatim magic: define the macro \doverbatim so that -% the (first) argument ends when '@end verbatim' is reached, ie: -% -% \def\doverbatim#1@end verbatim{#1} -% -% For Texinfo it's a lot easier than for LaTeX, -% because texinfo's \verbatim doesn't stop at '\end{verbatim}': -% we need not redefine '\', '{' and '}'. -% -% Inspired by LaTeX's verbatim command set [latex.ltx] -% -\begingroup - \catcode`\ =\active - \obeylines % - % ignore everything up to the first ^^M, that's the newline at the end - % of the @verbatim input line itself. Otherwise we get an extra blank - % line in the output. - \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}% - % We really want {...\end verbatim} in the body of the macro, but - % without the active space; thus we have to use \xdef and \gobble. -\endgroup -% -\envdef\verbatim{% - \setupverbatim\doverbatim -} -\let\Everbatim = \afterenvbreak - - -% @verbatiminclude FILE - insert text of file in verbatim environment. -% -\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude} -% -\def\doverbatiminclude#1{% - {% - \makevalueexpandable - \setupverbatim - \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 - -% Start the processing of @deffn: -\def\startdefun{% - \ifnum\lastpenalty<10000 - \medbreak - \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 \defargscommonending, 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. - % - \ifnum\lastpenalty=10002 \penalty2000 \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 \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 - \endgraf - \nobreak\vskip -\parskip - \penalty 10002 % 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 remainnig 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 - \parseargusing\activeparens{\printdefunline#3}% - }% - \def#2{\dodefunx#1}% - \def#3% -} - -%%% 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}% - \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 {} } - -%%% Type: -% @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{% - % Get the values of \leftskip and \rightskip as they were outside the @def... - \advance\leftskip by -\defbodyindent - % - % How we'll format the type 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. - % 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 - % The continuations: - \dimen2=\hsize \advance\dimen2 by -\defargsindent - % (plain.tex says that \dimen1 should be used only as global.) - \parshape 2 0in \dimen0 \defargsindent \dimen2 - % - % Put the type name to 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}% return value type - \ifx\temp\empty\else \tclose{\temp} \fi - #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. Let's try @var for that. - \let\var=\ttslanted - #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 -} -\def\badparencount{% - \errmessage{Unbalanced parentheses in @def}% - \global\parencount=0 -} -\def\badbrackcount{% - \errmessage{Unbalanced square braces 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\undefined - \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 \example - \spaceisspace - % - % Append \endinput to make sure that TeX does not see the ending newline. - % - % I've verified that it is necessary both for e-TeX and for ordinary TeX - % --kasal, 29nov03 - \scantokens{#1\endinput}% - \endgroup -} - -\def\scanexp#1{% - \edef\temp{\noexpand\scanmacro{#1}}% - \temp -} - -\newcount\paramno % Count of parameters -\newtoks\macname % Macro name -\newif\ifrecursive % Is it recursive? -\def\macrolist{} % List of all defined macros in the form - % \do\macro1\do\macro2... - -% 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 \. - -% 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{% - \catcode`\"=\other - \catcode`\+=\other - \catcode`\<=\other - \catcode`\>=\other - \catcode`\@=\other - \catcode`\^=\other - \catcode`\_=\other - \catcode`\|=\other - \catcode`\~=\other -} - -\def\scanargctxt{% - \scanctxt - \catcode`\\=\other - \catcode`\^^M=\other -} - -\def\macrobodyctxt{% - \scanctxt - \catcode`\{=\other - \catcode`\}=\other - \catcode`\^^M=\other - \usembodybackslash -} - -\def\macroargctxt{% - \scanctxt - \catcode`\\=\other -} - -% \mbodybackslash is the definition of \ in @macro bodies. -% It maps \foo\ => \csname macarg.foo\endcsname => #N -% where N is the macro parameter number. -% We define \csname macarg.\endcsname to be \realbackslash, so -% \\ in macro replacement text gets you a backslash. - -{\catcode`@=0 @catcode`@\=@active - @gdef@usembodybackslash{@let\=@mbodybackslash} - @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} -} -\expandafter\def\csname macarg.\endcsname{\realbackslash} - -\def\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% - \else - \expandafter\parsemargdef \argl;% - \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% - % Add the macroname to \macrolist - \toks0 = \expandafter{\macrolist\do}% - \xdef\macrolist{\the\toks0 - \expandafter\noexpand\csname\the\macname\endcsname}% - \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\do\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\do \noexpand #1% - \fi -} - -% This makes use of the obscure feature that if the last token of a -% <parameter list> is #, then the preceding argument is delimited by -% an opening brace, and that opening brace is not consumed. -\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}} - -% 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 be ##N where N is the position in that list. -% 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. - -\def\parsemargdef#1;{\paramno=0\def\paramlist{}% - \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,} -\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} - -% These two commands read recursive and nonrecursive macro bodies. -% (They're different since rec and nonrec macros end differently.) - -\long\def\parsemacbody#1@end macro% -{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% -\long\def\parsermacbody#1@end rmacro% -{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% - -% This defines the macro itself. There are six cases: recursive and -% nonrecursive macros of zero, one, 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 % many - \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}}% - \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 % many - \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}% - \fi - \fi} - -\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\next=#1\futurelet\nchar\braceorlinexxx} -\def\braceorlinexxx{% - \ifx\nchar\bgroup\else - \expandafter\parsearg - \fi \next} - -% We want to disable all macros during \shipout so that they are not -% expanded by \write. -\def\turnoffmacros{\begingroup \def\do##1{\let\noexpand##1=\relax}% - \edef\next{\macrolist}\expandafter\endgroup\next} - -% For \indexnofonts, 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. -% -\def\emptyusermacros{\begingroup - \def\do##1{\let\noexpand##1=\noexpand\asis}% - \edef\next{\macrolist}\expandafter\endgroup\next} - - -% @alias. -% We need some trickery to remove the optional spaces around the equal -% sign. Just 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 - \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 \thissection, -% 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 - \turnoffactive - \otherbackslash - \edef\writexrdef##1##2{% - \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef - ##1}{##2}}% these are parameters of \writexrdef - }% - \toks0 = \expandafter{\thissection}% - \immediate \writexrdef{title}{\the\toks0 }% - \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. - \writexrdef{pg}{\folio}% will be written later, during \shipout - }% - \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,,,,,,,]} -\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup - \unsepspaces - \def\printedmanual{\ignorespaces #5}% - \def\printedrefname{\ignorespaces #3}% - \setbox1=\hbox{\printedmanual\unskip}% - \setbox0=\hbox{\printedrefname\unskip}% - \ifdim \wd0 = 0pt - % No printed node name was explicitly given. - \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax - % Use the node name inside the square brackets. - \def\printedrefname{\ignorespaces #1}% - \else - % Use the actual chapter/section title appear inside - % the square brackets. Use the real section title if we have it. - \ifdim \wd1 > 0pt - % It is in another manual, so we don't have it. - \def\printedrefname{\ignorespaces #1}% - \else - \ifhavexrefs - % We 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 - \leavevmode - \getfilename{#4}% - {\turnoffactive \otherbackslash - \ifnum\filenamelength>0 - \startlink attr{/Border [0 0 0]}% - goto file{\the\filename.pdf} name{#1}% - \else - \startlink attr{/Border [0 0 0]}% - goto name{\pdfmkpgn{#1}}% - \fi - }% - \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 - \otherbackslash - \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\wd0 = 0pt - \refx{#1-snt}% - \else - \printedrefname - \fi - % - % if the user also gave the printed manual name (fifth arg), append - % "in MANUALNAME". - \ifdim \wd1 > 0pt - \space \putwordin{} \cite{\printedmanual}% - \fi - \else - % node/anchor (non-float) references. - % - % If we use \unhbox0 and \unhbox1 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 \wd1 > 0pt - \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}% - \else - % _ (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 \otherbackslash - % 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 a macro so it can be overridden. - \xrefprintnodename\printedrefname - % - % But we always want a comma and a space: - ,\space - % - % output the `page 3'. - \turnoffactive \otherbackslash \putwordpage\tie\refx{#1-pg}{}% - \fi - \fi - \endlink -\endgroup} - -% 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 - \message{\linenumber Undefined cross reference `#1'.}% - \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{% - \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value. - % - % Was that xref control sequence that we just defined for a float? - \expandafter\iffloat\csname XR#1\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{#1}}% - \fi -} - -% Read the last existing aux file, if any. No error if none exists. -% -\def\tryauxfile{% - \openin 1 \jobname.aux - \ifeof 1 \else - \readauxfile - \global\havexrefstrue - \fi - \closein 1 -} - -\def\readauxfile{\begingroup - \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. - {% - \count 1=128 - \def\loop{% - \catcode\count 1=\other - \advance\count 1 by 1 - \ifnum \count 1<256 \loop \fi - }% - }% - % - % @ is our escape character in .aux files, and we need braces. - \catcode`\{=1 - \catcode`\}=2 - \catcode`\@=0 - % - \input \jobname.aux -\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 - \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. -% Similarily, 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\undefined - \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 this 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 - \nobreak\bigskip - % 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 - \line\bgroup\hss - \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 \hss \egroup \bigbreak \fi % space after the image -\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 \thissection 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\thissection{\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 \turnoffactive \otherbackslash - % 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 float, 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 -% \thissection 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,} -% and i18n. - -% @documentlanguage is usually given very early, just after -% @setfilename. If done too late, it may not override everything -% properly. Single argument is the language abbreviation. -% It would be nice if we could set up a hyphenation file here. -% -\parseargdef\documentlanguage{% - \tex % read txi-??.tex file in plain TeX. - % Read the file if it exists. - \openin 1 txi-#1.tex - \ifeof 1 - \errhelp = \nolanghelp - \errmessage{Cannot read language file txi-#1.tex}% - \else - \input txi-#1.tex - \fi - \closein 1 - \endgroup -} -\newhelp\nolanghelp{The given language definition file cannot be found or -is empty. Maybe you need to install it? In the current directory -should work if nowhere else does.} - - -% @documentencoding should change something in TeX eventually, most -% likely, but for now just recognize it. -\let\documentencoding = \comment - - -% Page size parameters. -% -\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 so finicky about underfull hboxes, either. -\hbadness = 2000 - -% Following George Bush, just 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 - \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{46\baselineskip}{6in}% - {\voffset}{.25in}% - {\bindingoffset}{36pt}% - {11in}{8.5in}% -}} - -% Use @smallbook to reset parameters for 7x9.5 (or so) format. -\def\smallbook{{\globaldefs = 1 - \parskip = 2pt plus 1pt - \textleading = 12pt - % - \internalpagesizes{7.5in}{5in}% - {\voffset}{.25in}% - {\bindingoffset}{16pt}% - {9.25in}{7in}% - % - \lispnarrowing = 0.3in - \tolerance = 700 - \hfuzz = 1pt - \contentsrightmargin = 0pt - \defbodyindent = .5cm -}} - -% 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{51\baselineskip}{160mm} - {\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 - \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.} - -% Define macros to output various characters with catcode for normal text. -\catcode`\"=\other -\catcode`\~=\other -\catcode`\^=\other -\catcode`\_=\other -\catcode`\|=\other -\catcode`\<=\other -\catcode`\>=\other -\catcode`\+=\other -\catcode`\$=\other -\def\normaldoublequote{"} -\def\normaltilde{~} -\def\normalcaret{^} -\def\normalunderscore{_} -\def\normalverticalbar{|} -\def\normalless{<} -\def\normalgreater{>} -\def\normalplus{+} -\def\normaldollar{$}%$ font-lock fix - -% 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\_} -% 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} - -\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 - -% \rawbackslash defines an active \ to do \backslashcurfont. -% \otherbackslash defines an active \ to be a literal `\' character with -% catcode other. -{\catcode`\\=\active - @gdef@rawbackslash{@let\=@backslashcurfont} - @gdef@otherbackslash{@let\=@realbackslash} -} - -% \realbackslash is an actual character `\' with catcode other. -{\catcode`\\=\other @gdef@realbackslash{\}} - -% \normalbackslash outputs one backslash in fixed width font. -\def\normalbackslash{{\tt\backslashcurfont}} - -\catcode`\\=\active - -% Used sometimes to turn off (effectively) the active characters -% even after parsing them. -@def@turnoffactive{% - @let"=@normaldoublequote - @let\=@realbackslash - @let~=@normaltilde - @let^=@normalcaret - @let_=@normalunderscore - @let|=@normalverticalbar - @let<=@normalless - @let>=@normalgreater - @let+=@normalplus - @let$=@normaldollar %$ font-lock fix - @unsepspaces -} - -% Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of -% the literal character `\'. (Thus, \ is not expandable when this is in -% effect.) -% -@def@normalturnoffactive{@turnoffactive @let\=@normalbackslash} - -% 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 back turn 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 look ok in all fonts, so just make them not special. -@catcode`@& = @other -@catcode`@# = @other -@catcode`@% = @other - - -@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 diff --git a/lib/zebra.h b/lib/zebra.h index 150aa2c5..d4f68cf0 100644 --- a/lib/zebra.h +++ b/lib/zebra.h @@ -162,6 +162,7 @@ typedef int socklen_t; #ifdef HAVE_NETLINK #include <linux/netlink.h> #include <linux/rtnetlink.h> +#include <linux/filter.h> #else #define RT_TABLE_MAIN 0 #endif /* HAVE_NETLINK */ diff --git a/mkinstalldirs b/mkinstalldirs deleted file mode 100755 index 994d71ce..00000000 --- a/mkinstalldirs +++ /dev/null @@ -1,101 +0,0 @@ -#! /bin/sh -# mkinstalldirs --- make directory hierarchy -# Author: Noah Friedman <friedman@prep.ai.mit.edu> -# Created: 1993-05-16 -# Public domain - -# $Id$ - -errstatus=0 -dirmode="" - -usage="\ -Usage: mkinstalldirs [-h] [--help] [-m mode] dir ..." - -# process command line arguments -while test $# -gt 0 ; do - case "${1}" in - -h | --help | --h* ) # -h for help - echo "${usage}" 1>&2; exit 0 ;; - -m ) # -m PERM arg - shift - test $# -eq 0 && { echo "${usage}" 1>&2; exit 1; } - dirmode="${1}" - shift ;; - -- ) shift; break ;; # stop option processing - -* ) echo "${usage}" 1>&2; exit 1 ;; # unknown option - * ) break ;; # first non-opt arg - esac -done - -for file -do - if test -d "$file"; then - shift - else - break - fi -done - -case $# in -0) exit 0 ;; -esac - -case $dirmode in -'') - if mkdir -p -- . 2>/dev/null; then - echo "mkdir -p -- $*" - exec mkdir -p -- "$@" - fi ;; -*) - if mkdir -m "$dirmode" -p -- . 2>/dev/null; then - echo "mkdir -m $dirmode -p -- $*" - exec mkdir -m "$dirmode" -p -- "$@" - fi ;; -esac - -for file -do - set fnord `echo ":$file" | sed -ne 's/^:\//#/;s/^://;s/\// /g;s/^#/\//;p'` - shift - - pathcomp= - for d - do - pathcomp="$pathcomp$d" - case "$pathcomp" in - -* ) pathcomp=./$pathcomp ;; - esac - - if test ! -d "$pathcomp"; then - echo "mkdir $pathcomp" - - mkdir "$pathcomp" || lasterr=$? - - if test ! -d "$pathcomp"; then - errstatus=$lasterr - else - if test ! -z "$dirmode"; then - echo "chmod $dirmode $pathcomp" - - lasterr="" - chmod "$dirmode" "$pathcomp" || lasterr=$? - - if test ! -z "$lasterr"; then - errstatus=$lasterr - fi - fi - fi - fi - - pathcomp="$pathcomp/" - done -done - -exit $errstatus - -# Local Variables: -# mode: shell-script -# sh-indentation: 3 -# End: -# mkinstalldirs ends here diff --git a/watchlink/Makefile.am b/watchlink/Makefile.am new file mode 100644 index 00000000..798275e5 --- /dev/null +++ b/watchlink/Makefile.am @@ -0,0 +1,8 @@ +## Process this file with automake to produce Makefile.in. + +INCLUDES = @INCLUDES@ -I.. -I$(top_srcdir) -I$(top_srcdir)/lib +DEFS = @DEFS@ -DSYSCONFDIR=\"$(sysconfdir)/\" + +sbin_PROGRAMS = watchlink + +watchlink_SOURCES = watchlink.cc netlink_utils.cc netlink_send.cc netlink_listener.cc netlink_event.cc netlink_linkstatus.cc rl_str_proc.cc diff --git a/watchlink/netlink_event.cc b/watchlink/netlink_event.cc new file mode 100644 index 00000000..7bda70bb --- /dev/null +++ b/watchlink/netlink_event.cc @@ -0,0 +1,335 @@ +/* + * Module: netlink_event.cc + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#include <sys/types.h> +#include <sys/socket.h> +#include <linux/rtnetlink.h> +#include <net/if.h> + +#include <netinet/in.h> +#include <arpa/inet.h> + +#include <syslog.h> + +#include <iostream> +#include <string> +#include "netlink_event.hh" + +using namespace std; + +/** + * + * + **/ +NetlinkEvent::NetlinkEvent(int type, + std::string iface, + int mtu, + unsigned char *mac, + bool enabled, + bool running, + IPv4 local, + IPv4 addr, + IPv4 broadcast, + int mask_len, + int index) : + _type(type), + _iface(iface), + _vif(false), + _mtu(mtu), + _enabled(enabled), + _running(running), + _local(local), + _addr(addr), + _broadcast(broadcast), + _mask_len(mask_len), + _index(index) +{ + memcpy(_mac, mac, 6); + if (_iface.find(".") != string::npos) { + _vif = true; + } +} + +/** + * + * + **/ +NetlinkEvent::~NetlinkEvent() +{ +} + +/** + * + * + **/ +void +NetlinkEvent::log() +{ + syslog(LOG_USER | LOG_INFO, "NetlinkEvent::log(): type: %d, iface: %s, mtu: %d, local: %s, addr: %s, bc: %s, mask: %d, index: %d", _type, _iface.c_str(), _mtu, _local.str().c_str(), _addr.str().c_str(), _broadcast.str().c_str(), _mask_len, _index); +} + +/** + * + * + **/ +NetlinkEventManager::NetlinkEventManager(bool debug) : + _debug(debug) +{ + +} + +/** + * + * + * + **/ +NetlinkEventManager::~NetlinkEventManager() +{ +} + +/** + * + * + * + **/ +void +NetlinkEventManager::process(unsigned char* pkt, int size) +{ + if (size <= 0) { + return; + } + + size_t ps = size_t(size); + + const struct nlmsghdr* mh; + for (mh = reinterpret_cast<const struct nlmsghdr*>(pkt); + NLMSG_OK(mh, ps); + mh = NLMSG_NEXT(const_cast<struct nlmsghdr*>(mh), ps)) { + parse_msg(mh); + } +} + +/** + * + * + **/ +bool +NetlinkEventManager::pop(NetlinkEvent &e) +{ + char buf[20]; + sprintf(buf, "%d", _coll.size()); + + NLEventIter iter = _coll.begin(); + if (iter != _coll.end()) { + e = *iter; + _coll.erase(iter); + return true; + } + return false; +} + +/** + * + * + * + **/ +void +NetlinkEventManager::parse_msg(const struct nlmsghdr *nlHdr) +{ + bool enabled; + bool running; + string iface; + int mtu = -1; + int index = -1; + unsigned char mac[6]; + IPv4 addr, local, broadcast; + int mask_len = -1; + + bzero(mac, 6); + + struct ifinfomsg* ifInfo = (struct ifinfomsg *)NLMSG_DATA(nlHdr); + + //link state flag + enabled = ifInfo->ifi_flags & IFF_UP; + running = enabled && (ifInfo->ifi_flags & IFF_RUNNING); + index = ifInfo->ifi_index; + + struct rtattr* rtAttr = (struct rtattr *)IFLA_RTA(ifInfo); + int rtLen = IFLA_PAYLOAD(nlHdr); + + switch (nlHdr->nlmsg_type) { + case RTM_NEWLINK: + case RTM_DELLINK: + case RTM_NEWADDR: + case RTM_DELADDR: + for(;RTA_OK(rtAttr,rtLen);rtAttr = RTA_NEXT(rtAttr,rtLen)){ + if (nlHdr->nlmsg_type == RTM_NEWLINK || + nlHdr->nlmsg_type == RTM_DELLINK) { + switch(rtAttr->rta_type) { + case IFLA_IFNAME: + iface = string((char*)RTA_DATA(rtAttr)); + break; + case IFLA_ADDRESS: + memcpy(mac, RTA_DATA(rtAttr), 6); + break; + case IFLA_MTU: + mtu = *((unsigned int *)RTA_DATA(rtAttr)); + break; + default: + break; + } + } + else if (nlHdr->nlmsg_type == RTM_NEWADDR || + nlHdr->nlmsg_type == RTM_DELADDR) { + uint32_t address; + struct ifaddrmsg *ifAddrs; + ifAddrs = (struct ifaddrmsg *)NLMSG_DATA(nlHdr); + mask_len = ifAddrs->ifa_prefixlen; + + switch(rtAttr->rta_type) { + case IFA_LOCAL: + address = *(uint32_t *)RTA_DATA(rtAttr); + local = IPv4(address); + break; + case IFA_ADDRESS: + address = *(uint32_t *)RTA_DATA(rtAttr); + addr = IPv4(address); + break; + case IFA_LABEL: + iface = string((char*)RTA_DATA(rtAttr)); + break; + case IFA_BROADCAST: + address = *(uint32_t *)RTA_DATA(rtAttr); + broadcast = IPv4(address); + break; + default: + break; + } + } + } + { + NetlinkEvent e(nlHdr->nlmsg_type, + iface, + mtu, + mac, + enabled, + running, + local, + addr, + broadcast, + mask_len, + index); + + e.set_ifinfomsg(ifInfo); + + if (_debug) { + e.log(); + } + _coll.push_back(e); + } + break; + case NLMSG_ERROR: { + struct nlmsgerr *err = (struct nlmsgerr*) NLMSG_DATA(nlHdr); + //drop down to info as this can be caused on startup by downed interfaces that are requested for dump, or attempting to remove routes on downed interface after startup (if they have already been removed). + syslog(LOG_INFO,"netlink message of type ERROR received: %s",strerror(-err->error)); + // cerr << "netlink message of type ERROR received: " ; + // cerr << string(strerror(-err->error)) << endl; + } + break; + case NLMSG_DONE: + // if (_debug) { + // cout << "netlink message of type DONE received" << endl; + // } + break; + case NLMSG_NOOP: + syslog(LOG_INFO,"netlink message of type NOOP received"); + break; + default: + syslog(LOG_INFO,"unknown netlink message type received"); + break; + } +} + + +/** + * + * + * + **/ +typedef struct { + unsigned int iff_flag; + char *name; +} iff_flags_name; + + +string +NetlinkEvent::get_ifinfomsg() +{ + string ret; + char buf[40]; + + sprintf(buf, "%u", _ifinfo.ifi_family); + ret = "ifi_family: " + string(buf) + ", "; + sprintf(buf, "%u", _ifinfo.ifi_type); + ret += "ifi_type: " + string(buf) + ", "; + sprintf(buf, "%d", _ifinfo.ifi_index); + ret += "ifi_index: " + string(buf) + ", "; + sprintf(buf, "%u", _ifinfo.ifi_flags); + ret += "ifi_flags: " + string(buf) + ", "; + sprintf(buf, "%u", _ifinfo.ifi_change); + ret += "ifi_change: " + string(buf); + return ret; +} + +/* +string +NetlinkEvent::operator<<(const ostream &o) +{ + UNUSED(o); + return (""); +} +*/ +std::ostream & operator <<(std::ostream & Stream, const NetlinkEvent & instance) +{ + // Stream << ... fields from instance + const NetlinkEvent foo = instance; + return Stream; +} + + +/* from quagga prefix.c */ +/* Apply mask to IPv4 prefix. */ +/* Maskbit. */ +static u_char maskbit[] = {0x00, 0x80, 0xc0, 0xe0, 0xf0, + 0xf8, 0xfc, 0xfe, 0xff}; + + +uint32_t +apply_mask_ipv4 (const uint32_t p, const unsigned char m) +{ + uint32_t val(p); + u_char *pnt = (u_char *) &val; + int index; + int offset; + + index = m / 8; + if (index < 4) { + offset = m % 8; + + pnt[index] &= maskbit[offset]; + index++; + + while (index < 4) { + pnt[index++] = 0; + } + } + return val; +} + + + diff --git a/watchlink/netlink_event.hh b/watchlink/netlink_event.hh new file mode 100644 index 00000000..76ccefa6 --- /dev/null +++ b/watchlink/netlink_event.hh @@ -0,0 +1,274 @@ +/* + * Module: netlink_event.hh + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#ifndef __NETLINK_EVENT_HH__ +#define __NETLINK_EVENT_HH__ + +#include <sys/socket.h> +#include <netinet/in.h> +#include <arpa/inet.h> +#include <net/if.h> + +#include <string> +#include <vector> +#include <ostream> +#include <linux/rtnetlink.h> + +uint32_t +apply_mask_ipv4 (const uint32_t p, const unsigned char m); + + +class Mac +{ +public: + Mac() {} +private: + unsigned char _addr[6]; +}; + +class IPv4 +{ +public: + IPv4() : _addr(-1) {} + IPv4(uint32_t addr) : _addr(addr) {} + virtual ~IPv4() {} + + uint32_t + get() {return _addr;} + + virtual + std::string + str() + { + in_addr addr; + addr.s_addr = _addr; + char* buf = inet_ntoa(addr); + return std::string(buf); + } + +protected: + uint32_t _addr; +}; + + +class IPv4net : protected IPv4 +{ +public: + IPv4net() : IPv4(-1),_mask_length(32) {} + IPv4net(uint32_t addr, char mask_len) : IPv4(addr),_mask_length(mask_len) {} + IPv4net(std::string &net) { + int pos = net.find("/"); + if (pos == std::string::npos) { + pos = net.length(); + _mask_length = 32; + } + else { + uint32_t m_val = strtoul(net.substr(pos+1,net.length()-1).c_str(),NULL,10); + if (m_val > 32) { + m_val = 32; + } + _mask_length = m_val; + } + uint32_t a_val = inet_addr(net.substr(0,pos).c_str()); + if (a_val == INADDR_NONE) { + this->_addr = 0; + return; + } + this->_addr = apply_mask_ipv4(a_val,_mask_length); + } + + uint32_t + get_addr() {return get();} + + char + get_mask_length() {return _mask_length;} + + bool + contains(IPv4 &addr) { + //check if addr is within specified addr range + return (apply_mask_ipv4(addr.get(),_mask_length) == _addr); + } + + bool + contains(IPv4 addr) { + //check if addr is within specified addr range + return (apply_mask_ipv4(addr.get(),_mask_length) == _addr); + } + + std::string + str() + { + in_addr addr; + addr.s_addr = _addr; + char *buf = inet_ntoa(addr); + + std::string tmp(buf); + + char buf2[80]; + sprintf(buf2,"%d",_mask_length); + tmp += std::string("/") + buf2; + return tmp; + } + +private: + char _mask_length; +}; + + +/** + * + * + **/ +class NetlinkEvent +{ +public: + NetlinkEvent(int type, + std::string iface, + int mtu, + unsigned char *mac, + bool enabled, + bool running, + IPv4 local, + IPv4 addr, + IPv4 broadcast, + int mask_len, + int index); + + NetlinkEvent() : + _type(-1), + _mtu(-1), + _enabled(false), + _running(false), + _mask_len(-1), + _index(-1) {} + + ~NetlinkEvent(); + + + std::string + get_iface() const {return _iface;} + + int + get_mtu() const {return _mtu;} + + std::string + get_mac_str() const { + char buf[18]; + sprintf(buf, "%02X:%02X:%02X:%02X:%02X:%02X", + _mac[0], _mac[1], _mac[2], + _mac[3], _mac[4], _mac[5] + ); + return std::string(buf); + } + + int + get_type() const {return _type;} + /* + unsigned char* + get_mac() const { + return _mac; + } + */ + + int + get_ifi_type() const {return _ifinfo.ifi_type;} + + bool + get_enabled() const {return _enabled;} + + bool + get_running() const {return _running;} + + IPv4 + get_local_addr() const {return _local;} + + IPv4 + get_addr() const {return _addr;} + + IPv4 + get_broadcast() const {return _broadcast;} + + int + get_mask_len() const {return _mask_len;} + + bool + is_link_up() const {return _enabled;} + + int + get_index() const {return _index;} + + bool + is_vif() const {return _vif;} + + void + log(); + + void + set_ifinfomsg(ifinfomsg *ifinfo) {_ifinfo = *ifinfo;} + + std::string + get_ifinfomsg(); + +private: + int _type; + std::string _iface; + bool _vif; + int _mtu; + unsigned char _mac[6]; + bool _enabled; + bool _running; + IPv4 _local; + IPv4 _addr; + IPv4 _broadcast; + int _mask_len; + int _index; + + //debug + struct ifinfomsg _ifinfo; +}; + + + +/** + * + * + **/ +class NetlinkEventManager +{ +public: + typedef std::vector<NetlinkEvent> NLEventColl; + typedef std::vector<NetlinkEvent>::iterator NLEventIter; + +public: //methods + friend std::ostream & operator<< (std::ostream &, const NetlinkEvent &); + + NetlinkEventManager(bool debug); + + ~NetlinkEventManager(); + + void + process(unsigned char *pkt, int size); + + bool + pop(NetlinkEvent &e); + + + +private: //methods + void + parse_msg(const struct nlmsghdr*); + +private: //variables + NLEventColl _coll; + bool _debug; +}; + + + + +#endif // __NETLINK_EVENT_HH__ diff --git a/watchlink/netlink_linkstatus.cc b/watchlink/netlink_linkstatus.cc new file mode 100644 index 00000000..9dd26fbd --- /dev/null +++ b/watchlink/netlink_linkstatus.cc @@ -0,0 +1,318 @@ +/* + * Module: netlink_linkstatus.cc + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#include <stdio.h> +#include <sys/socket.h> +#include <sys/file.h> +#include <iostream> +#include <string> +#include <syslog.h> +#include <errno.h> + +#include "rl_str_proc.hh" +#include "netlink_send.hh" +#include "netlink_event.hh" +#include "netlink_utils.hh" +#include "netlink_linkstatus.hh" + + +using namespace std; + +/** + * + * + **/ +NetlinkLinkStatus::NetlinkLinkStatus(int send_sock, const string &link_dir, bool debug) : + _nl_send(debug), + _send_sock(send_sock), + _link_dir(link_dir), + _debug(debug) +{ + if (_send_sock < 0) { + syslog(LOG_ERR,"NetlinkListStatus::NetlinkLinkStatus(), send sock is bad value"); + cerr << "NetlinkListStatus::NetlinkLinkStatus(), send sock is bad value" << endl; + } + + if (_link_dir.empty()) { + syslog(LOG_ERR,"NetlinkListStatus::NetlinkLinkStatus(), no link status directory specified"); + cerr << "NetlinkListStatus::NetlinkLinkStatus(), no link status directory specified" << endl; + } +} + +/** + * + * + **/ +NetlinkLinkStatus::~NetlinkLinkStatus() +{ +} + +/** + * + * + **/ +void +NetlinkLinkStatus::process(const NetlinkEvent &event) +{ + bool state_event = false; + + IfaceStateIter iter = _iface_state_coll.find(event.get_index()); + if (iter == _iface_state_coll.end()) { + if (event.get_type() == RTM_NEWLINK || event.get_type() == RTM_DELLINK) { + //start maintaining state information here. + _iface_state_coll.insert(pair<int,bool>(event.get_index(),event.get_running())); + + //let's clean up directory here! + char buf[40]; + sprintf(buf,"%d",event.get_index()); + string file = _link_dir + "/" + buf; + unlink(file.c_str()); + } + return; + } + + bool running_old = iter->second; + bool running_new = event.get_running(); + + //capture link status on link messages only + if (event.get_type() == RTM_NEWLINK || + event.get_type() == RTM_DELLINK) { + // _iface_state_coll.insert(pair<int,bool>(event.get_index(),event.get_running())); + _iface_state_coll[event.get_index()] = event.get_running(); + if (running_old != running_new) { + state_event = true; + } + } + + //is this a transition from up->down, or down->up? + if (state_event) { + if (running_new) { + process_going_up(event); + } + else { + process_going_down(event); + } + } + else { + if (running_old) { + process_up(event); + } + else { + process_down(event); + } + } +} + +/** + * + * file is in the format of IFINDEX,IP,MASK + * + **/ +int +NetlinkLinkStatus::process_up(const NetlinkEvent &event) +{ + if (_debug) { + cout << "NetlinkLinkStatus::process_up(): " << event.get_iface() << endl; + } + //can't think of anything that needs to go here yet. + return 0; +} + +/** + * + * + **/ +int +NetlinkLinkStatus::process_going_up(const NetlinkEvent &event) +{ + if (_debug) { + cout << "NetlinkLinkStatus::process_going_up(): " << event.get_iface() << endl; + } + syslog(LOG_INFO,"Interface is now active: %s",event.get_iface().c_str()); + + //check for link status file, otherwise return + char buf[40]; + sprintf(buf,"%d",event.get_index()); + string file = _link_dir + "/" + buf; + FILE *fp = fopen(file.c_str(), "r"); + if (fp == NULL) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_going_up(), failed to open state file: %s", + strerror(errno)); + // cerr << "NetlinkLinkStatus::process_going_up(), failed to open state file" << endl; + return -1; //means we are still up, ignore... + } + + if (flock(fileno(fp), LOCK_SH)) { + syslog(LOG_INFO, "NetlinkLinkStatus::process_going_up() failed to acquire lock: %s", + strerror(errno)); + fclose(fp); + return -1; + } + + char str[1025]; + while (fgets(str, 1024, fp)) { + string line(str); + + StrProc tokens(line, ","); + if (tokens.size() != 4) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_up(), failure to parse link status file, exiting(): %s, size: %d", line.c_str(), tokens.size()); + // cerr << "NetlinkLinkStatus::process_up(), failure to parse link status file, exiting(): " << line << ", size: " << tokens.size() << endl; + fclose(fp); + return -1; + } + + int ifindex = strtoul(tokens.get(0).c_str(),NULL,10); + uint32_t local_addr = strtoul(tokens.get(1).c_str(),NULL,10); + uint32_t addr = strtoul(tokens.get(2).c_str(),NULL,10); + int mask_len = strtoul(tokens.get(3).c_str(),NULL,10); + + + bool err = _nl_send.send_set(_send_sock, ifindex, local_addr, addr, mask_len, RTM_NEWADDR); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_up(), failure in setting interface back to up"); + } + /* + bool err = _nl_send.send_set_route(_send_sock, ifindex, local_addr, local_addr, 32, RTM_NEWROUTE, RT_TABLE_LOCAL, RTN_LOCAL, RT_SCOPE_HOST); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_up(), failure in setting interface back to up"); + } + //COMPUTE FIRST ADDRESS + uint32_t first_addr = ipv4_first_addr(local_addr, mask_len); + err = _nl_send.send_set_route(_send_sock, ifindex, local_addr, first_addr, 32, RTM_NEWROUTE, RT_TABLE_LOCAL, RTN_BROADCAST, RT_SCOPE_LINK); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_up(), failure in setting interface back to up"); + } + //COMPUTE LAST ADDRESS + uint32_t last_addr = ipv4_broadcast_addr(local_addr, mask_len); + err = _nl_send.send_set_route(_send_sock, ifindex, local_addr, last_addr, 32, RTM_NEWROUTE, RT_TABLE_LOCAL, RTN_BROADCAST, RT_SCOPE_LINK); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_up(), failure in setting interface back to up"); + } + + //reinsert addresses to interface + err = _nl_send.send_set_route(_send_sock, ifindex, local_addr, first_addr, mask_len, RTM_NEWROUTE, RT_TABLE_MAIN, RTN_UNICAST, RT_SCOPE_LINK); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_up(), failure in setting interface back to up"); + } + */ + } + + fclose(fp); + + //remove file + unlink(file.c_str()); + + return 0; +} + +/** + * send an ip flush command and capture all the rtm_deladdr messages to the file... + * + **/ +int +NetlinkLinkStatus::process_down(const NetlinkEvent &event) +{ + if (_debug) { + cout << "NetlinkLinkStatus::process_down(): " << event.get_iface() << endl; + } + + if (event.get_type() != RTM_NEWADDR) { + return 0; + } + + if (event.get_index() < 0 || event.get_local_addr().get() == 0 || event.get_mask_len() < 1) { + return 0; + } + + if (_debug) { + cout << "netlinkLinkStatus::process_down(), processing valid request" << endl; + } + + //append to file... + char buf[40]; + sprintf(buf,"%d",event.get_index()); + string file = _link_dir + "/" + buf; + FILE *fp = fopen(file.c_str(), "a"); + if (fp == NULL) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_down(), failed to open state file"); + // cerr << "NetlinkLinkStatus::process_down(), failed to open state file" << endl; + return -1; + } + + if (flock(fileno(fp), LOCK_EX)) { + syslog(LOG_INFO, "NetlinkLinkStatus::process_down() failed to acquire lock: %s", + strerror(errno)); + fclose(fp); + return -1; + } + + int ifindex = event.get_index(); + uint32_t local_addr = event.get_local_addr().get(); + int mask_len = event.get_mask_len(); + + //create file on system + //CRAJ--NEED TO HAVE THIS BE FROM A COLLECTION??? DEPENDS ON FORMAT OF NETLINK MSG + sprintf(buf,"%d",ifindex); + string line = string(buf) + ","; + sprintf(buf,"%d",local_addr); + line += string(buf) + ","; + sprintf(buf,"%d",event.get_addr().get()); + line += string(buf) + ","; + sprintf(buf,"%d",mask_len); + line += string(buf) + "\n"; + + fputs(line.c_str(),fp); + + bool err = _nl_send.send_set(_send_sock, ifindex, event.get_local_addr().get(), event.get_addr().get(), mask_len, RTM_DELADDR); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_down(), failure in setting interface down"); + } + + /* + uint32_t first_addr = ipv4_first_addr(local_addr, mask_len); + //reinsert addresses to interface + bool err = _nl_send.send_set_route(_send_sock, ifindex, local_addr, first_addr, mask_len, RTM_DELROUTE, RT_TABLE_MAIN, -1,-1); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_down(), failure in setting interface down"); + } + + uint32_t last_addr = ipv4_broadcast_addr(local_addr, mask_len); + err = _nl_send.send_set_route(_send_sock, ifindex, local_addr, last_addr, 32, RTM_DELROUTE, RT_TABLE_LOCAL, -1,-1); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_down(), failure in setting interface down"); + } + + err = _nl_send.send_set_route(_send_sock, ifindex, first_addr, first_addr, 32, RTM_DELROUTE, RT_TABLE_LOCAL, -1,-1); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_down(), failure in setting interface down"); + } + + err = _nl_send.send_set_route(_send_sock, ifindex, local_addr, local_addr, 32, RTM_DELROUTE, RT_TABLE_LOCAL, -1,-1); + if (err) { + syslog(LOG_INFO,"NetlinkLinkStatus::process_down(), failure in setting interface down"); + } + */ + fclose(fp); + + return 0; +} + +int +NetlinkLinkStatus::process_going_down(const NetlinkEvent &event) +{ + if (_debug) { + cout << "NetlinkLinkStatus::process_going_down(): " << event.get_iface() << "(" << event.get_index() << ")" << endl; + } + syslog(LOG_INFO,"Interface is now inactive: %s",event.get_iface().c_str()); + + //pull interface addresses + if (_nl_send.send_get(_send_sock, RTM_GETADDR, event.get_index())) { + return -1; + } + return 0; +} diff --git a/watchlink/netlink_linkstatus.hh b/watchlink/netlink_linkstatus.hh new file mode 100644 index 00000000..b4eebbce --- /dev/null +++ b/watchlink/netlink_linkstatus.hh @@ -0,0 +1,56 @@ +/* + * Module: netlink_linkstatus.hh + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#ifndef __NETLINK_LINKSTATUS_HH__ +#define __NETLINK_LINKSTATUS_HH__ + +#include <string> +#include <map> +#include "netlink_event.hh" +#include "netlink_send.hh" + +class NetlinkLinkStatus +{ +public: + typedef std::map<int,bool> IfaceStateColl; + typedef std::map<int,bool>::iterator IfaceStateIter; + +public: + NetlinkLinkStatus(int send_sock, const std::string &link_dir, bool debug); + ~NetlinkLinkStatus(); + + void + process(const NetlinkEvent &event); + +private: + int + process_up(const NetlinkEvent &event); + + int + process_down(const NetlinkEvent &event); + + int + process_going_up(const NetlinkEvent &event); + + int + process_going_down(const NetlinkEvent &event); + + +private: + NetlinkSend _nl_send; + int _send_sock; + std::string _link_dir; + bool _debug; + + //keeps track of down messages where we've issued a + //request for addresses but haven't received msg yet. + IfaceStateColl _iface_state_coll; + +}; + +#endif //__NETLINK_LINKSTATUS_HH__ diff --git a/watchlink/netlink_listener.cc b/watchlink/netlink_listener.cc new file mode 100644 index 00000000..be17fc76 --- /dev/null +++ b/watchlink/netlink_listener.cc @@ -0,0 +1,271 @@ +/* + * Module: netlink_listener.cc + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#include <errno.h> +#include <sys/types.h> +#include <sys/types.h> +#include <sys/socket.h> +#include <linux/rtnetlink.h> +#include <syslog.h> + +#include <map> +#include <vector> +#include <string> +#include <iostream> + +#include "netlink_event.hh" +#include "netlink_listener.hh" + + +using namespace std; + + +#define SO_RCV_BUF_SIZE_MAX (256*1024) // Desired socket buffer size +#define SO_RCV_BUF_SIZE_MIN (48*1024) // Min. socket buffer size +#define NLSOCK_BYTES (8*1024) + +/** + * + * + **/ +NetlinkListener::NetlinkListener(bool debug) : + _fd(-1), + _is_multipart_message_read(false), + _nl_event_mgr(debug) +{ + +} + +/** + * + * + **/ +NetlinkListener::~NetlinkListener() +{ + close(_fd); +} + +/** + * + * + **/ +int +NetlinkListener::init() +{ + struct sockaddr_nl snl; + socklen_t snl_len; + + if (_fd >= 0) { + syslog(LOG_ERR,"socket cannot be initialized"); + cerr << "socket cannot be initialized" << endl; + return _fd; + } + + _fd = socket(AF_NETLINK, SOCK_RAW, NETLINK_ROUTE); + if (_fd < 0) { + syslog(LOG_ERR,"Could not open netlink socket: %s",strerror(errno)); + cerr << string("Could not open netlink socket: ") << strerror(errno) << endl; + return _fd; + } + + comm_sock_set_rcvbuf(_fd, SO_RCV_BUF_SIZE_MAX, SO_RCV_BUF_SIZE_MIN); + + memset(&snl, 0, sizeof(snl)); + snl.nl_family = AF_NETLINK; + snl.nl_pid = getpid(); // Let the kernel assign the pid to the socket + snl.nl_groups = RTMGRP_LINK | RTMGRP_IPV4_IFADDR;//_nl_groups; + if (bind(_fd, reinterpret_cast<struct sockaddr*>(&snl), sizeof(snl)) < 0) { + syslog(LOG_ERR,"bind(AF_NETLINK) failed: ",strerror(errno)); + cerr << string("bind(AF_NETLINK) failed: ") << strerror(errno) << endl; + close(_fd); + _fd = -1; + return _fd; + } + + snl_len = sizeof(snl); + if (getsockname(_fd, reinterpret_cast<struct sockaddr*>(&snl), &snl_len) < 0) { + syslog(LOG_ERR,"getsockname(AF_NETLINK) failed: ",strerror(errno)); + cerr << string("getsockname(AF_NETLINK) failed: ") << strerror(errno) << endl; + close(_fd); + _fd = -1; + return _fd; + } + if (snl_len != sizeof(snl)) { + syslog(LOG_ERR,"Wrong address length of AF_NETLINK socket: "); + cerr << string("Wrong address length of AF_NETLINK socket: ") << endl; + close(_fd); + _fd = -1; + return _fd; + } + if (snl.nl_family != AF_NETLINK) { + syslog(LOG_ERR,"wrong address family of AF_NETLINK socket: ");; + cerr << string("Wrong address family of AF_NETLINK socket: ") << endl; + close(_fd); + _fd = -1; + return _fd; + } + return _fd; +} + +/** + * + * + **/ +bool +NetlinkListener::process(NetlinkEvent &e, multimap<string,IPv4net> filter) +{ + bool state = process(e); + //is this a non-ethernet msg? + if ((e.get_type() == RTM_DELLINK || e.get_type() == RTM_NEWLINK) && e.get_ifi_type() != 1/*ARPHRD_ETHER*/) { + e = NetlinkEvent(); + state = false; + } + else { + multimap<string,IPv4net>::iterator iter = filter.begin(); + while (iter != filter.end()) { + if (iter->first == e.get_iface() || iter->first == "*") { //found interface exclusion + if (iter->second.contains(e.get_local_addr())) { + e = NetlinkEvent(); + state = false; + break; + } + } + ++iter; + } + } + + + return state; +} + +/** + * + * + **/ +bool +NetlinkListener::process(NetlinkEvent &e) +{ + if (_fd <= 0) { + return false; + } + + vector<uint8_t> message; + vector<uint8_t> buffer(NLSOCK_BYTES); + size_t last_mh_off = 0; + size_t off = 0; + ssize_t got = -1; + + char buf[20]; + + for ( ; ; ) { + //don't block on recv + do { + got = recv(_fd, &buffer[0], buffer.size(), MSG_DONTWAIT | MSG_PEEK); + if ((got < 0) && (errno == EINTR)) + continue; // XXX: the receive was interrupted by a signal + if ((got < 0) || (got < (ssize_t)buffer.size())) + break; // The buffer is big enough + buffer.resize(buffer.size() + NLSOCK_BYTES); + } while (true); + + got = recv(_fd, &buffer[0], buffer.size(), + MSG_DONTWAIT); + // got = read(_fd, &buffer[0], buffer.size()); + if (got < 0) { + if (errno == EINTR) + continue; + // cerr << "Netlink socket read error: " << endl; + break; + } + + message.resize(message.size() + got); + memcpy(&message[off], &buffer[0], got); + off += got; + + if ((off - last_mh_off) < (ssize_t)sizeof(struct nlmsghdr)) { + syslog(LOG_ERR,"Netlink socket recvfrom failed: message truncated: "); + cerr << string("Netlink socket recvfrom failed: message truncated: ") << endl; + break; + } + + // + // If this is a multipart message, it must be terminated by NLMSG_DONE + // + // NEED to revisit the MULTI part message--does not operate correctly right now. + // + + bool is_end_of_message = false; + size_t new_size = off - last_mh_off; + const struct nlmsghdr* mh; + for (mh = reinterpret_cast<const struct nlmsghdr*>(&buffer[last_mh_off]); + NLMSG_OK(mh, new_size); + mh = NLMSG_NEXT(const_cast<struct nlmsghdr*>(mh), new_size)) { + if ((mh->nlmsg_flags & NLM_F_MULTI) + || _is_multipart_message_read) { + sprintf(buf, "%d", mh->nlmsg_type); + is_end_of_message = false; + if (mh->nlmsg_type == NLMSG_DONE) { + is_end_of_message = true; + } + } + } + last_mh_off = reinterpret_cast<size_t>(mh) - reinterpret_cast<size_t>(&buffer[0]); + if (is_end_of_message) { + break; + } + } + + _nl_event_mgr.process(&message[0], off); + return _nl_event_mgr.pop(e); +} + +/** + * + * + **/ +int +NetlinkListener::comm_sock_set_rcvbuf(int sock, int desired_bufsize, int min_bufsize) +{ + int delta = desired_bufsize / 2; + + /* + * Set the socket buffer size. If we can't set it as large as we + * want, search around to try to find the highest acceptable + * value. The highest acceptable value being smaller than + * minsize is a fatal error. + */ + if (setsockopt(sock, SOL_SOCKET, SO_RCVBUF, + &desired_bufsize, + sizeof(desired_bufsize)) < 0) { + desired_bufsize -= delta; + while (1) { + if (delta > 1) + delta /= 2; + + if (setsockopt(sock, SOL_SOCKET, SO_RCVBUF, + &desired_bufsize, + sizeof(desired_bufsize)) < 0) { + desired_bufsize -= delta; + if (desired_bufsize <= 0) + break; + } else { + if (delta < 1024) + break; + desired_bufsize += delta; + } + } + if (desired_bufsize < min_bufsize) { + syslog(LOG_ERR,"Cannot set receiving buffer size of socket"); + cerr << "Cannot set receiving buffer size of socket" << endl; + return -1; + } + } + + return (desired_bufsize); +} + diff --git a/watchlink/netlink_listener.hh b/watchlink/netlink_listener.hh new file mode 100644 index 00000000..b74589a8 --- /dev/null +++ b/watchlink/netlink_listener.hh @@ -0,0 +1,50 @@ +/* + * Module: netlink_listener.hh + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#ifndef __NETLINK_LISTENER_HH__ +#define __NETLINK_LISTENER_HH__ + +#include "netlink_event.hh" +#include <map> +#include <string> + +class NetlinkListener +{ +public: //methods + NetlinkListener(bool debug); + ~NetlinkListener(); + + /* + * returns socket fd + */ + int + init(); + + bool + process(NetlinkEvent &e); + + bool + process(NetlinkEvent &e, std::multimap<std::string,IPv4net> filter); + + int + get_sock() {return _fd;} + + void + set_multipart(bool state) {_is_multipart_message_read = state;} + +private: //methods +int +comm_sock_set_rcvbuf(int sock, int desired_bufsize, int min_bufsize); + +private: //vraiables + int _fd; + bool _is_multipart_message_read; + NetlinkEventManager _nl_event_mgr; +}; + +#endif //__NETLINK_LISTENER_HH__ diff --git a/watchlink/netlink_send.cc b/watchlink/netlink_send.cc new file mode 100644 index 00000000..3824c2ef --- /dev/null +++ b/watchlink/netlink_send.cc @@ -0,0 +1,318 @@ +/* + * Module: netlink_send.cc + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#include <errno.h> +#include <arpa/inet.h> +#include <linux/types.h> +#include <sys/types.h> +#include <sys/socket.h> +#include <linux/netlink.h> +#include <linux/rtnetlink.h> +#include <syslog.h> + +#include <vector> +#include <string> +#include <iostream> + +#include "netlink_utils.hh" +#include "netlink_send.hh" + +using namespace std; + + +/** + * + * + **/ +NetlinkSend::NetlinkSend(bool debug) : _debug(debug) +{ +} + + +/** + * + * + **/ +NetlinkSend::~NetlinkSend() +{ +} + +/** + * + * + **/ +int +NetlinkSend::send_set(int sock, int ifindex, uint32_t local_addr, uint32_t addr, int mask_len, int type) +{ + int ret; + struct sockaddr_nl snl; + struct { + struct nlmsghdr n; + struct ifaddrmsg ifa; + char buf[256]; + } req; + + /* Check netlink socket. */ + if (sock < 0) { + syslog(LOG_ERR,"sock is not active, exiting"); + cerr << "sock is not active, exiting" << endl; + return -1; + } + + if (_debug) { + struct in_addr in; + in.s_addr = local_addr; + char *lbuf = inet_ntoa(in); + + in.s_addr = addr; + char *buf = inet_ntoa(in); + + char sbuf[1024]; + sprintf(sbuf, "NetlinkSend::send_set(): %d, %s/%d, to this address: %s, on interface: %d",type,buf,mask_len,lbuf,ifindex); + cout << sbuf << endl; + + syslog(LOG_INFO,sbuf); + } + + memset(&req, 0, sizeof(req)); + + req.n.nlmsg_len = NLMSG_LENGTH(sizeof(struct ifaddrmsg)); + req.n.nlmsg_flags = NLM_F_REQUEST; + req.n.nlmsg_pid = getpid(); + req.n.nlmsg_type = type; + req.n.nlmsg_seq = time(NULL); + req.ifa.ifa_family = AF_INET; + req.ifa.ifa_index = ifindex; + req.ifa.ifa_prefixlen = mask_len; + + // addr = htonl( addr ); + addattr_l(&req.n, sizeof(req), IFA_LOCAL, &local_addr, sizeof(local_addr) ); + + in_addr_t broadcast_addr = ipv4_broadcast_addr(local_addr,mask_len); + addattr_l(&req.n, sizeof(req), IFA_BROADCAST, &broadcast_addr, sizeof(broadcast_addr) ); + + if (addr != -1 && local_addr != addr) { + addattr_l(&req.n, sizeof(req), IFA_ADDRESS, &addr, sizeof(addr) ); + } + + memset(&snl, 0, sizeof(snl)); + snl.nl_family = AF_NETLINK; + + ret = sendto (sock, (void*) &req, sizeof req, 0, + (struct sockaddr*) &snl, sizeof snl); + if (ret < 0) { + syslog(LOG_ERR,"netlink_send failed on send: %d, %d",ret,errno); + cerr << "netlink_send failed on send: " << ret << ", " << errno << endl; + return -1; + } + return 0; +} + +/** + * + * + **/ +int +NetlinkSend::send_set_route(int sock, int ifindex, uint32_t local_addr, uint32_t dst_addr, int mask_len, int type, int table, int rtn_type, int rt_scope) +{ + int ret; + struct sockaddr_nl snl; + struct { + struct nlmsghdr n; + struct rtmsg rt_message; + char buf[8192]; + } req; + req.rt_message.rtm_table = 0; + req.rt_message.rtm_protocol = 0; + req.rt_message.rtm_scope = 0; + req.rt_message.rtm_type = 0; + req.rt_message.rtm_src_len = 0; + req.rt_message.rtm_dst_len = 0; + req.rt_message.rtm_tos = 0; + + memset(&snl, 0, sizeof(snl)); + snl.nl_family = AF_NETLINK; + + /* Check netlink socket. */ + if (sock < 0) { + syslog(LOG_ERR,"sock is not active, exiting"); + cerr << "sock is not active, exiting" << endl; + return -1; + } + + if (_debug) { + struct in_addr in; + in.s_addr = local_addr; + char *lbuf = inet_ntoa(in); + + in.s_addr = dst_addr; + char *buf = inet_ntoa(in); + + char sbuf[1024]; + sprintf(sbuf, "NetlinkSend::send_set_route(): %d, %s/%d, to this address: %s, on interface: %d, for this table: ",type,buf,mask_len,lbuf,ifindex,table); + cout << sbuf << endl; + + syslog(LOG_INFO,sbuf); + } + + memset(&req, 0, sizeof(req)); + + req.n.nlmsg_len = NLMSG_LENGTH(sizeof(struct rtmsg)); + if (type == RTM_NEWROUTE) { + req.n.nlmsg_flags = NLM_F_REQUEST|NLM_F_CREATE|NLM_F_EXCL; + } + else { + req.n.nlmsg_flags = NLM_F_REQUEST; + } + req.n.nlmsg_pid = getpid(); + req.n.nlmsg_type = type; + req.n.nlmsg_seq = time(NULL); + + req.rt_message.rtm_family = AF_INET; + req.rt_message.rtm_dst_len = mask_len; + req.rt_message.rtm_table = table; + if (type == RTM_NEWROUTE) { + req.rt_message.rtm_protocol = RTPROT_KERNEL; + if (rt_scope != -1) { + req.rt_message.rtm_scope = rt_scope;//RT_SCOPE_HOST; //will need to pass this in to get RT_SCOPE_HOST + } + if (rtn_type != -1) { + req.rt_message.rtm_type = rtn_type;//RTN_LOCAL; + } + } + else { + req.rt_message.rtm_scope = RT_SCOPE_NOWHERE; + req.rt_message.rtm_type = RTN_UNSPEC; + } + + addattr_l(&req.n, sizeof(req), RTA_PREFSRC, &local_addr, sizeof(local_addr)); + addattr_l(&req.n, sizeof(req), RTA_DST, &dst_addr, sizeof(dst_addr)); + addattr32(&req.n, sizeof(req), RTA_OIF, ifindex); + + if (_debug) { + cout << "NetlinkSend::send_set_route():" << endl; + cout << " interface: " << ifindex << endl; + cout << " type: " << string(req.n.nlmsg_type == RTM_NEWROUTE ? string("RTM_NEWROUTE") : string("RTM_DELROUTE")) << endl; + cout << " flags: " << req.n.nlmsg_flags << endl; + cout << " protocol: " << int(req.rt_message.rtm_protocol) << endl; + cout << " scope: " << int(req.rt_message.rtm_scope) << endl; + cout << " addr(s): " << local_addr << ", " << dst_addr << ", " << mask_len << ", " << int(req.rt_message.rtm_dst_len) << endl; + cout << endl; + } + + ret = sendto (sock, (void*) &req, sizeof req, 0, + (struct sockaddr*) &snl, sizeof snl); + if (ret < 0) { + syslog(LOG_ERR,"netlink_send_route failed on send: %d, %d",ret,errno); + cerr << "netlink_send_route failed on send: " << ret << ", " << errno << endl; + return -1; + } + return 0; +} + +/** + * + * + **/ +int +NetlinkSend::send_get(int sock, int type, int ifindex) +{ + int ret; + struct sockaddr_nl snl; + struct { + struct nlmsghdr n; + struct ifaddrmsg ifa; + char buf[256]; + } req; + + /* Check netlink socket. */ + if (sock < 0) { + syslog(LOG_ERR,"sock is not active, exiting"); + cerr << "sock is not active, exiting" << endl; + return -1; + } + + if (_debug) { + char sbuf[1024]; + sprintf(sbuf,"NetlinkSend::send_get(): type: %d, ifindex: %d",type,ifindex); + cout << sbuf << endl; + syslog(LOG_INFO,sbuf); + } + + memset(&req, 0, sizeof(req)); + + req.n.nlmsg_len = NLMSG_LENGTH(sizeof(struct ifaddrmsg)); + if (ifindex > -1) { + req.n.nlmsg_flags = NLM_F_REQUEST | NLM_F_MATCH; + } + else { + req.n.nlmsg_flags = NLM_F_REQUEST | NLM_F_DUMP; + } + req.n.nlmsg_pid = getpid(); + req.n.nlmsg_type = type; + req.n.nlmsg_seq = time(NULL); + req.ifa.ifa_family = AF_INET; + if (ifindex > -1) { + req.ifa.ifa_index = ifindex; + } + + /* + note bug right now in that all interfaces are provided back when a specific index is requested + */ + memset(&snl, 0, sizeof(snl)); + snl.nl_family = AF_NETLINK; + + ret = sendto (sock, (void*) &req, sizeof req, 0, + (struct sockaddr*) &snl, sizeof snl); + if (ret < 0) { + syslog(LOG_ERR,"netlink_send failed on send: %d, %d",ret,errno); + cerr << "netlink_send failed on send: " << ret << ", " << errno << endl; + return -1; + } + return 0; +} + +/** + * + * + **/ +int +NetlinkSend::addattr_l(struct nlmsghdr *n, int maxlen, int type, void *data, int alen) +{ + int len = RTA_LENGTH(alen); + struct rtattr *rta; + + if ((int)NLMSG_ALIGN(n->nlmsg_len) + len > maxlen) + return -1; + rta = (struct rtattr*)(((char*)n) + NLMSG_ALIGN(n->nlmsg_len)); + rta->rta_type = type; + rta->rta_len = len; + memcpy(RTA_DATA(rta), data, alen); + n->nlmsg_len = NLMSG_ALIGN(n->nlmsg_len) + len; + return 0; +} + +int +NetlinkSend::addattr32(struct nlmsghdr *n, int maxlen, int type, int data) +{ + int len; + struct rtattr *rta; + + len = RTA_LENGTH (4); + + if (NLMSG_ALIGN (n->nlmsg_len) + len > maxlen) + return -1; + + rta = (struct rtattr *) (((char *) n) + NLMSG_ALIGN (n->nlmsg_len)); + rta->rta_type = type; + rta->rta_len = len; + memcpy (RTA_DATA (rta), &data, 4); + n->nlmsg_len = NLMSG_ALIGN (n->nlmsg_len) + len; + + return 0; +} diff --git a/watchlink/netlink_send.hh b/watchlink/netlink_send.hh new file mode 100644 index 00000000..3e13e5c8 --- /dev/null +++ b/watchlink/netlink_send.hh @@ -0,0 +1,39 @@ +/* + * Module: netlink_send.hh + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#ifndef __NETLINK_SEND_HH__ +#define __NETLINK_SEND_HH__ + +class NetlinkSend +{ +public: + NetlinkSend(bool debug); + ~NetlinkSend(); + + int + send_get(int sock, int type, int ifindex = -1); + + int + send_set(int sock, int ifindex, uint32_t local_addr, uint32_t addr, int mask_len, int type); + + int + send_set_route(int sock, int ifindex, uint32_t local_addr, uint32_t dst_addr, int mask_len, int type, int table, int rtn_type, int rt_scope); + +private: + int + addattr_l(struct nlmsghdr *n, int maxlen, int type, void *data, int alen); + + int + addattr32(struct nlmsghdr *n, int maxlen, int type, int data); + +private: + bool _debug; + +}; + +#endif //__NETLINK_SEND_HH__ diff --git a/watchlink/netlink_utils.cc b/watchlink/netlink_utils.cc new file mode 100644 index 00000000..18a4b3ff --- /dev/null +++ b/watchlink/netlink_utils.cc @@ -0,0 +1,59 @@ +#include <errno.h> +#include <string.h> +#include <arpa/inet.h> +#include <linux/types.h> +#include <sys/types.h> +#include <sys/socket.h> +#include <linux/rtnetlink.h> +#include <syslog.h> + +#include "netlink_utils.hh" + + +/* Maskbit. */ +static u_char maskbit[] = {0x00, 0x80, 0xc0, 0xe0, 0xf0, + 0xf8, 0xfc, 0xfe, 0xff}; + +/* Convert masklen into IP address's netmask. */ +void +masklen2ip (int masklen, struct in_addr *netmask) +{ + u_char *pnt; + int bit; + int offset; + + memset (netmask, 0, sizeof (struct in_addr)); + pnt = (unsigned char *) netmask; + + offset = masklen / 8; + bit = masklen % 8; + + while (offset--) + *pnt++ = 0xff; + + if (bit) + *pnt = maskbit[bit]; +} + + +in_addr_t +ipv4_broadcast_addr (in_addr_t hostaddr, int masklen) +{ + struct in_addr mask; + + masklen2ip (masklen, &mask); + return (masklen != 32-1) ? + /* normal case */ + (hostaddr | ~mask.s_addr) : + /* special case for /31 */ + (hostaddr ^ ~mask.s_addr); +} + +in_addr_t +ipv4_first_addr (in_addr_t hostaddr, int masklen) +{ + struct in_addr mask; + masklen2ip (masklen, &mask); + return (hostaddr & mask.s_addr); +} + diff --git a/watchlink/netlink_utils.hh b/watchlink/netlink_utils.hh new file mode 100644 index 00000000..a1be920a --- /dev/null +++ b/watchlink/netlink_utils.hh @@ -0,0 +1,20 @@ +#ifndef __NETLINK_UTILS_HH__ +#define __NETLINK_UTILS_HH__ + +#include <arpa/inet.h> +#include <linux/types.h> +#include <sys/types.h> +#include <sys/socket.h> + + +in_addr_t +ipv4_broadcast_addr (in_addr_t hostaddr, int masklen); + +void +masklen2ip (int masklen, struct in_addr *netmask); + +in_addr_t +ipv4_first_addr (in_addr_t hostaddr, int masklen); + + +#endif //__NETLINK_UTILS_HH__ diff --git a/watchlink/rl_str_proc.cc b/watchlink/rl_str_proc.cc new file mode 100644 index 00000000..e3c67e82 --- /dev/null +++ b/watchlink/rl_str_proc.cc @@ -0,0 +1,90 @@ +/* + * Module: rl_str_proc.cc + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#include "rl_str_proc.hh" + +using namespace std; + +/** + * + **/ +StrProc::StrProc(const string &in_str, const string &token) +{ + string tmp = in_str; + + //convert tabs to spaces + uint32_t pos = 0; + string tabtospace = " "; + string::iterator iter = tmp.begin(); + while ((pos = tmp.find("\t", pos)) != string::npos) { + tmp.replace(pos, 1, tabtospace); + pos += tabtospace.length(); + } + + //remove the cr + pos = tmp.find("\n"); + if (pos != string::npos) { + tmp.replace(pos, 1, ""); + } + + //now handle the case of the multiple length token + //note that we are using the '~' as a token internally + uint32_t start = 0, end; + while ((start = tmp.find(token, start)) != string::npos) { + tmp.replace(start, token.length(), "~"); + } + + + while ((start = tmp.find_first_not_of("~")) != string::npos) { + tmp = tmp.substr(start, tmp.length() - start); + end = tmp.find_first_of("~"); + _str_coll.push_back(tmp.substr(0, end)); + tmp = tmp.substr(end+1, tmp.length() - end-1); + if (end == string::npos) { + break; + } + } +} + +/** + * + **/ +string +StrProc::get(int i) +{ + if (uint32_t(i) >= _str_coll.size()) { + return string(""); + } + return _str_coll[i]; +} + +/** + * + **/ +string +StrProc::get(int start, int end) +{ + if (uint32_t(start) >= _str_coll.size()) { + return string(""); + } + + string tmp; + for (int i = start; (i < end) && (uint32_t(i) < _str_coll.size()); ++i) { + tmp += _str_coll[i] + " "; + } + return tmp.substr(0,tmp.length()-1); +} + +/** + * + **/ +vector<string> +StrProc::get() +{ + return _str_coll; +} diff --git a/watchlink/rl_str_proc.hh b/watchlink/rl_str_proc.hh new file mode 100644 index 00000000..ad7d897f --- /dev/null +++ b/watchlink/rl_str_proc.hh @@ -0,0 +1,32 @@ +/* + * Module: rl_str_proc.hh + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#ifndef __RL_STR_PROC_HH__ +#define __RL_STR_PROC_HH__ + +#include <vector> +#include <string> + +class StrProc +{ +public: + StrProc(const std::string &in, const std::string &token); + + std::string get(int i); + + std::string get(int start, int end); + + std::vector<std::string> get(); + + int size() {return _str_coll.size();} + +private: + std::vector<std::string> _str_coll; +}; + +#endif //__RL_STR_PROC_HH__ diff --git a/watchlink/watchlink.cc b/watchlink/watchlink.cc new file mode 100644 index 00000000..0cc8f232 --- /dev/null +++ b/watchlink/watchlink.cc @@ -0,0 +1,293 @@ +/* + * Module: watchlink.cc + * + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published + * by the Free Software Foundation. + */ +#include <unistd.h> +#include <iostream> +#include <stdio.h> +#include <string> +#include <map> +#include <fcntl.h> +#include <syslog.h> +#include <errno.h> + +#include <linux/types.h> +#include <sys/socket.h> +#include <signal.h> +#include <linux/rtnetlink.h> +#include "rl_str_proc.hh" +#include "netlink_send.hh" +#include "netlink_listener.hh" +#include "netlink_linkstatus.hh" +#include "netlink_event.hh" + +using namespace std; + + +void print_netlink(NetlinkEvent &nl_event); +pid_t pid_output (const char *path); + +struct option longopts[] = +{ + { 0 } +}; + +multimap<string,IPv4net> g_exclude; +string g_link_dir = "/var/linkstatus"; + +/** + * + * + **/ +void +usage() +{ + fprintf(stdout, "-s start with sending netlink request\n"); + fprintf(stdout, "-l specify directory for link status. default /var/linkstatus\n"); + fprintf(stdout, "-i specify location of pid directory\n"); + fprintf(stdout, "-p print netlink messages\n"); + fprintf(stdout, "-d run as a daemon\n"); + fprintf(stdout, "-v debug to stdout\n"); + fprintf(stdout, "-h help message\n"); +} + +/** + * + * + **/ +multimap<string,IPv4net> +load_exclusion_file(const string &link_dir) +{ + multimap<string,IPv4net> coll; + + string file = link_dir + "/exclude"; + FILE *fp = fopen(file.c_str(), "r"); + if (fp == NULL) { + syslog(LOG_INFO,"load_exclusion_file(), failed to open state file"); + // cerr << "load_exclusion_file(), failed to open state file" << endl; + return coll; //means we are still up, ignore... + } + + char str[1025]; + while (fgets(str, 1024, fp)) { + string line(str); + + //strip out comments + int pos = line.find("#"); + line = line.substr(0,pos); + + StrProc tokens(line, " "); + if (tokens.size() == 1) { + string any("0/0"); + coll.insert(pair<string,IPv4net>(tokens.get(0),IPv4net(any))); + } + else if (tokens.size() == 2) { + string net(tokens.get(1)); + coll.insert(pair<string,IPv4net>(tokens.get(0),IPv4net(net))); + } + } + fclose(fp); + return coll; +} + +/** + * + * + **/ +static void +sig_user(int signo) +{ + //reload interface exclusion list + g_exclude = load_exclusion_file(g_link_dir); +} + + +/** + * + * + **/ +int +main(int argc, char* const argv[]) +{ + int ch; + bool send_request = false; + bool debug = false; + bool daemon = false; + string pid_path; + bool print_nl_msg = false; + + if (debug) { + cout << "starting..." << endl; + } + + while ((ch = getopt_long(argc, argv, "sl:i:dvhp",longopts,0)) != -1) { + switch (ch) { + case 's': + send_request = true; + break; + case 'l': + g_link_dir = optarg; + break; + case 'i': + pid_path = optarg; + break; + case 'd': + daemon = true; + break; + case 'v': + debug = true; + break; + case 'p': + print_nl_msg = true; + break; + case 'h': + usage(); + exit(0); + } + } + + NetlinkSend nl_send(debug); + NetlinkListener nl_listener(debug); + + //add check here to ensure only one watchlink process + + if (daemon) { + if (fork() != 0) { + exit(0); + } + } + + if (pid_path.empty() == false) { + pid_output(pid_path.c_str()); + } + + //load interface exclusion list + g_exclude = load_exclusion_file(g_link_dir); + + signal(SIGUSR1, sig_user); + + int sock = nl_listener.init(); + if (sock <= 0) { + syslog(LOG_ERR, "watchlink(), netlink listener failed in initialization. exiting.."); + cerr << "watchlink(), netlink listener failed in initialization. exiting.." << endl; + exit(1); + } + + if (send_request) { + if (debug) { + cout << "sending initial netlink request" << endl; + } + nl_listener.set_multipart(true); + if (nl_send.send_get(sock, RTM_GETLINK) != 0) { + syslog(LOG_ERR,"watchlink(), error sending, exiting.."); + cerr << "watchlink(), error sending. exiting.." << endl; + exit(1); + } + } + + NetlinkLinkStatus nl_ls(sock, g_link_dir, debug); + + while (true) { + NetlinkEvent nl_event; + if (nl_listener.process(nl_event, g_exclude) == true) { + if (send_request) { + if (nl_send.send_get(sock, RTM_GETADDR) != 0) { + syslog(LOG_ERR,"watchlink(), error sending. exiting.."); + cerr << "watchlink(), error sending. exiting.." << endl; + exit(1); + } + send_request = false; + } + else { + nl_listener.set_multipart(false); + } + + nl_ls.process(nl_event); + + if (debug) { + cout << " ifinfomsg: " << nl_event.get_ifinfomsg() << endl; + } + if (print_nl_msg) { + print_netlink(nl_event); + } + + } + else { + // cout << "didn't receive a message, sleeping for 1 second" << endl; + sleep(1); + } + } + + exit(0); +} + + +/** + * + * + **/ +void +print_netlink(NetlinkEvent &nl_event) +{ + char buf[20]; + sprintf(buf, "%d", nl_event.get_index()); + cout << "results for " << nl_event.get_iface() << "(" << string(buf) << ")" << endl; + cout << " running: " << string(nl_event.get_running() ? "yes" : "no") << endl; + cout << " enabled: " << string(nl_event.get_enabled() ? "yes" : "no") << endl; + if (nl_event.get_type() == RTM_DELLINK || + nl_event.get_type() == RTM_NEWLINK) { + cout << " type: " << string(nl_event.get_type()==RTM_DELLINK?"DELLINK":"NEWLINK") << endl; + cout << " state: " << string(nl_event.is_link_up()?"UP":"DOWN") << endl; + sprintf(buf, "%d", nl_event.get_mtu()); + cout << " mtu: " << string(buf) << endl; + cout << " mac: " << nl_event.get_mac_str() << endl; + cout << " alternate mac: " << nl_event.get_mac_str() << endl; + } + else if (nl_event.get_type() == RTM_DELADDR || + nl_event.get_type() == RTM_NEWADDR) { + cout << " type: " << string(nl_event.get_type()==RTM_DELADDR?"DELADDR":"NEWADDR") << endl; + cout << " local addr: " << nl_event.get_local_addr().str().c_str() << endl; + cout << " addr: " << nl_event.get_addr().str().c_str() << endl; + cout << " broadcast: " << nl_event.get_broadcast().str().c_str() << endl; + char buf[20]; + sprintf(buf, "%d", nl_event.get_mask_len()); + cout << " mask length: " << string(buf) << endl; + } + cout << endl; + +} + +/** + * + *below borrowed from quagga library. + **/ +#define PIDFILE_MASK 0644 +pid_t +pid_output (const char *path) +{ + FILE *fp; + pid_t pid; + mode_t oldumask; + + pid = getpid(); + + oldumask = umask(0777 & ~PIDFILE_MASK); + fp = fopen (path, "w"); + if (fp != NULL) + { + fprintf (fp, "%d\n", (int) pid); + fclose (fp); + umask(oldumask); + return pid; + } + /* XXX Why do we continue instead of exiting? This seems incompatible + with the behavior of the fcntl version below. */ + syslog(LOG_ERR,"Can't fopen pid lock file %s, continuing", + path); + umask(oldumask); + return -1; +} diff --git a/zebra/interface.c b/zebra/interface.c index 184b42a0..7dc1b68d 100644 --- a/zebra/interface.c +++ b/zebra/interface.c @@ -274,7 +274,7 @@ if_addr_wakeup (struct interface *ifp) /* Address check. */ if (p->family == AF_INET) { - if (! if_is_up (ifp)) + if (! if_is_operative (ifp)) { /* XXX: WTF is it trying to set flags here? * caller has just gotten a new interface, has been @@ -311,7 +311,7 @@ if_addr_wakeup (struct interface *ifp) #ifdef HAVE_IPV6 if (p->family == AF_INET6) { - if (! if_is_up (ifp)) + if (! if_is_operative (ifp)) { /* XXX: See long comment above */ if_set_flags (ifp, IFF_UP | IFF_RUNNING); @@ -379,7 +379,7 @@ if_delete_update (struct interface *ifp) zebra_if = ifp->info; - if (if_is_up(ifp)) + if (if_is_operative(ifp)) { zlog_err ("interface %s index %d is still up while being deleted.", ifp->name, ifp->ifindex); @@ -1205,7 +1205,7 @@ ip_address_install (struct vty *vty, struct interface *ifp, && CHECK_FLAG (ifp->status, ZEBRA_INTERFACE_ACTIVE)) { /* Some system need to up the interface to set IP address. */ - if (! if_is_up (ifp)) + if (! if_is_operative (ifp)) { if_set_flags (ifp, IFF_UP | IFF_RUNNING); if_refresh (ifp); @@ -1398,7 +1398,7 @@ ipv6_address_install (struct vty *vty, struct interface *ifp, && CHECK_FLAG (ifp->status, ZEBRA_INTERFACE_ACTIVE)) { /* Some system need to up the interface to set IP address. */ - if (! if_is_up (ifp)) + if (! if_is_operative (ifp)) { if_set_flags (ifp, IFF_UP | IFF_RUNNING); if_refresh (ifp); diff --git a/zebra/rt_netlink.c b/zebra/rt_netlink.c index 5b592f94..07e473bc 100644 --- a/zebra/rt_netlink.c +++ b/zebra/rt_netlink.c @@ -41,6 +41,7 @@ #include "zebra/redistribute.h" #include "zebra/interface.h" #include "zebra/debug.h" +#include <stddef.h> /* Socket interface to kernel */ struct nlsock @@ -103,7 +104,7 @@ set_ifindex(struct interface *ifp, unsigned int ifi_index) if (IS_ZEBRA_DEBUG_KERNEL) zlog_debug("interface index %d was renamed from %s to %s", ifi_index, oifp->name, ifp->name); - if (if_is_up(oifp)) + if (if_is_operative(oifp)) zlog_err("interface rename detected on up interface: index %d " "was renamed from %s to %s, results are uncertain!", ifi_index, oifp->name, ifp->name); @@ -328,7 +329,8 @@ netlink_parse_info (int (*filter) (struct sockaddr_nl *, struct nlmsghdr *), while (1) { - char buf[4096]; + //increased from 4096 to 32768 as recvmsg overrun error + char buf[32768]; struct iovec iov = { buf, sizeof buf }; struct sockaddr_nl snl; struct msghdr msg = { (void *) &snl, sizeof snl, &iov, 1, NULL, 0, 0 }; @@ -1048,7 +1050,7 @@ netlink_link_change (struct sockaddr_nl *snl, struct nlmsghdr *h) } else { - /* RTM_DELLINK. */ + // RTM_DELLINK. ifp = if_lookup_by_name (name); if (ifp == NULL) @@ -1060,7 +1062,6 @@ netlink_link_change (struct sockaddr_nl *snl, struct nlmsghdr *h) if_delete_update (ifp); } - return 0; } @@ -1938,6 +1939,33 @@ kernel_read (struct thread *thread) return 0; } +/* Filter out messages from self that occur on listener socket */ +static void netlink_install_filter (int sock) +{ + /* BPF code to exclude all RTM_NEWROUTE messages from ZEBRA */ + struct sock_filter filter[] = { + BPF_STMT(BPF_LD|BPF_ABS|BPF_H, offsetof(struct nlmsghdr, nlmsg_type)), + /* 0: ldh [4] */ + BPF_JUMP(BPF_JMP|BPF_JEQ|BPF_K, htons(RTM_NEWROUTE), 0, 3), + /* 1: jeq 0x18 jt 2 jf 5 */ + BPF_STMT(BPF_LD|BPF_ABS|BPF_B, + sizeof(struct nlmsghdr) + offsetof(struct rtmsg, rtm_protocol)), + /* 2: ldb [23] */ + BPF_JUMP(BPF_JMP+ BPF_B, RTPROT_ZEBRA, 2, 0), + /* 3: jeq 0xb jt 4 jf 5 */ + BPF_STMT(BPF_RET|BPF_K, 0), /* 4: ret 0 */ + BPF_STMT(BPF_RET|BPF_K, 0xffff), /* 5: ret 0xffff */ + }; + + struct sock_fprog prog = { + .len = sizeof(filter) / sizeof(filter[0]), + .filter = filter, + }; + + if (setsockopt(sock, SOL_SOCKET, SO_ATTACH_FILTER, &prog, sizeof(prog)) < 0) + zlog_warn ("Can't install socket filter: %s\n", safe_strerror(errno)); +} + /* Exported interface function. This function simply calls netlink_socket (). */ void @@ -1954,5 +1982,8 @@ kernel_init (void) /* Register kernel socket. */ if (netlink.sock > 0) - thread_add_read (zebrad.master, kernel_read, NULL, netlink.sock); + { + netlink_install_filter (netlink.sock); + thread_add_read (zebrad.master, kernel_read, NULL, netlink.sock); + } } diff --git a/zebra/zebra_rib.c b/zebra/zebra_rib.c index c6af3290..a4fa261b 100644 --- a/zebra/zebra_rib.c +++ b/zebra/zebra_rib.c @@ -795,7 +795,7 @@ nexthop_active_check (struct route_node *rn, struct rib *rib, { case NEXTHOP_TYPE_IFINDEX: ifp = if_lookup_by_index (nexthop->ifindex); - if (ifp && if_is_operative(ifp)) + if (ifp && if_is_operative (ifp)) SET_FLAG (nexthop->flags, NEXTHOP_FLAG_ACTIVE); else UNSET_FLAG (nexthop->flags, NEXTHOP_FLAG_ACTIVE); @@ -804,7 +804,7 @@ nexthop_active_check (struct route_node *rn, struct rib *rib, family = AFI_IP6; case NEXTHOP_TYPE_IFNAME: ifp = if_lookup_by_name (nexthop->ifname); - if (ifp && if_is_operative(ifp)) + if (ifp && if_is_operative (ifp)) { if (set) nexthop->ifindex = ifp->ifindex; @@ -838,7 +838,7 @@ nexthop_active_check (struct route_node *rn, struct rib *rib, if (IN6_IS_ADDR_LINKLOCAL (&nexthop->gate.ipv6)) { ifp = if_lookup_by_index (nexthop->ifindex); - if (ifp && if_is_operative(ifp)) + if (ifp && if_is_operative (ifp)) SET_FLAG (nexthop->flags, NEXTHOP_FLAG_ACTIVE); else UNSET_FLAG (nexthop->flags, NEXTHOP_FLAG_ACTIVE); |