Mercurial > hg > xemacs-beta
changeset 5747:52b9fe8f44c0
Merge.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Wed, 10 Jul 2013 14:32:02 +0100 |
| parents | b8c2808b33d4 (diff) f9e4d44504a4 (current diff) |
| children | 3ccb4aaf91c7 |
| files | lisp/ChangeLog src/ChangeLog |
| diffstat | 28 files changed, 3407 insertions(+), 1555 deletions(-) [+] |
line wrap: on
line diff
--- a/ChangeLog Wed Jul 10 14:14:30 2013 +0100 +++ b/ChangeLog Wed Jul 10 14:32:02 2013 +0100 @@ -1,3 +1,13 @@ +2013-06-25 Jerry James <james@xemacs.org> + + * INSTALL: Update required makeinfo version. + * Makefile.in.in: Check for usable makeinfo before invoking submake. + * configure.ac: Try to find makeinfo >= 4.12. + +2013-06-17 Jerry James <james@xemacs.org> + + * configure.ac: Support bignums with MPIR. + 2013-06-17 Jerry James <james@xemacs.org> * configure.ac: Add check for mp_set_memory_functions.
--- a/INSTALL Wed Jul 10 14:14:30 2013 +0100 +++ b/INSTALL Wed Jul 10 14:32:02 2013 +0100 @@ -37,9 +37,8 @@ miscellaneous data files, and on-line documentation. XEmacs requires an ANSI C compiler, such as GCC. If you wish to build the -documentation yourself, you will need at least version 1.68 of makeinfo (GNU -texinfo-3.11). GNU Texinfo 4.2 is strongly recommended; it is necessary for -building Lisp packages, and we may move to it for the core. +documentation yourself, you will need at least version 4.12 of makeinfo (GNU +texinfo-4.12). BASIC INSTALLATION ==================
--- a/Makefile.in.in Wed Jul 10 14:14:30 2013 +0100 +++ b/Makefile.in.in Wed Jul 10 14:32:02 2013 +0100 @@ -77,6 +77,7 @@ CFLAGS=@CFLAGS@ CPPFLAGS=@CPPFLAGS@ LDFLAGS=@LDFLAGS@ +MAKEINFO=@MAKEINFO@ ## These help us choose version- and architecture-specific directories ## to install files in. @@ -738,7 +739,7 @@ xargs etags -a -l none -r "/^(def\\(var\\|un\\|alias\\|const\\|macro\\|subst\\|struct\\|face\\|group\\|custom\\|ine-\\(function\\|compiler-macro\\|[a-z-]+alias\\)\\)[ ]+'?\\([^ ]+\\)/\\3/" info: FRC.info - cd ${srcdir}/man && $(MAKE) $(RECURSIVE_MAKE_ARGS) $@ + if test -n "$(MAKEINFO)"; then cd ${srcdir}/man && $(MAKE) $(RECURSIVE_MAKE_ARGS) $@; fi dvi: cd ${srcdir}/man && $(MAKE) $(RECURSIVE_MAKE_ARGS) $@
--- a/configure Wed Jul 10 14:14:30 2013 +0100 +++ b/configure Wed Jul 10 14:32:02 2013 +0100 @@ -674,6 +674,7 @@ sound_cflags native_sound_lib RECURSIVE_MAKE_ARGS +MAKEINFO ld_libs_all ld_libs_window_system ld_libs_general @@ -1968,7 +1969,8 @@ loaded libraries (Dynamic Shared Objects). --with-bignum=TYPE Compile in support for bignums, ratios, or bigfloats using library support. TYPE must be one of "gmp" - (for GNU MP), "mp" (for BSD MP), or "no" (disabled). + (for GNU MP), "mpir" (for MPIR), "mp" (for BSD MP), + or "no" (disabled). Platform Specific options ------------------------- @@ -5178,14 +5180,14 @@ enableval="$with_bignum" withval="$with_bignum" _bignum_bogus=yes - for x in no gmp mp ; do + for x in no gmp mpir mp ; do if test $x = $with_bignum ; then _bignum_bogus=no fi done if test "$_bignum_bogus" = "yes" ; then (echo "$progname: Usage error:" -echo " " "The --with-bignum option must have one of these values: \`no',\`gmp',\`mp'." +echo " " "The --with-bignum option must have one of these values: \`no',\`gmp',\`mpir',\`mp'." echo " Use \`$progname --help' to show usage.") >&2 && exit 1 fi unset _bignum_bogus @@ -10558,6 +10560,31 @@ test -n "$YACC" || YACC="yacc" +{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for makeinfo >= 4.12" >&5 +$as_echo_n "checking for makeinfo >= 4.12... " >&6; } +MAKEINFO= +for prog in `which -a makeinfo`; do + mi_verstr=`$prog --version | sed -rn '1s/.*+[[:blank:]]([^[:blank:]]+)$/\1/p'` + mi_major=`echo $mi_verstr | cut -d. -f1` + mi_minor=`echo $mi_verstr | cut -d. -f2` + if test $mi_major -gt 4 || ( test $mi_major -eq 4 && test $mi_minor -gt 11 ); + then + MAKEINFO=$prog + break + fi +done +if test -z $MAKEINFO; then + { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 +$as_echo "no" >&6; } + { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: Makeinfo 4.12 or later required to build info files." >&5 +$as_echo "$as_me: WARNING: Makeinfo 4.12 or later required to build info files." >&2;} +else + { $as_echo "$as_me:${as_lineno-$LINENO}: result: yes" >&5 +$as_echo "yes" >&6; } +fi +ac_config_files="$ac_config_files man/Makefile" + + for ac_header in a.out.h elf.h cygwin/version.h fcntl.h libgen.h locale.h wchar.h mach/mach.h sys/param.h sys/pstat.h sys/resource.h sys/time.h sys/timeb.h sys/times.h sys/un.h sys/vlimit.h ulimit.h do : as_ac_Header=`$as_echo "ac_cv_header_$ac_header" | $as_tr_sh` @@ -20779,6 +20806,62 @@ else { echo "Error:" "Required GMP numeric support cannot be provided." >&2; exit 1; } fi +elif test "$with_bignum" = "mpir"; then + ac_fn_c_check_header_mongrel "$LINENO" "mpir.h" "ac_cv_header_mpir_h" "$ac_includes_default" +if test "x$ac_cv_header_mpir_h" = xyes; then : + + { $as_echo "$as_me:${as_lineno-$LINENO}: checking for __gmpz_init in -lmpir" >&5 +$as_echo_n "checking for __gmpz_init in -lmpir... " >&6; } +if ${ac_cv_lib_mpir___gmpz_init+:} false; then : + $as_echo_n "(cached) " >&6 +else + ac_check_lib_save_LIBS=$LIBS +LIBS="-lmpir $LIBS" +cat confdefs.h - <<_ACEOF >conftest.$ac_ext +/* end confdefs.h. */ + +/* Override any GCC internal prototype to avoid an error. + Use char because int might match the return type of a GCC + builtin and then its argument prototype would still apply. */ +#ifdef __cplusplus +extern "C" +#endif +char __gmpz_init (); +int +main () +{ +return __gmpz_init (); + ; + return 0; +} +_ACEOF +if ac_fn_c_try_link "$LINENO"; then : + ac_cv_lib_mpir___gmpz_init=yes +else + ac_cv_lib_mpir___gmpz_init=no +fi +rm -f core conftest.err conftest.$ac_objext \ + conftest$ac_exeext conftest.$ac_ext +LIBS=$ac_check_lib_save_LIBS +fi +{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_lib_mpir___gmpz_init" >&5 +$as_echo "$ac_cv_lib_mpir___gmpz_init" >&6; } +if test "x$ac_cv_lib_mpir___gmpz_init" = xyes; then : + have_mpz_init=yes +fi + +fi + + + if test "$have_mpz_init" = "yes"; then + $as_echo "#define WITH_NUMBER_TYPES 1" >>confdefs.h + + $as_echo "#define WITH_MPIR 1" >>confdefs.h + + LIBS="-lmpir $LIBS" && if test "$verbose" = "yes"; then echo " Prepending \"-lmpir\" to \$LIBS"; fi + else + { echo "Error:" "Required MPIR numeric support cannot be provided." >&2; exit 1; } + fi elif test "$with_bignum" = "mp"; then for library in "" "-lcrypto"; do ac_fn_c_check_header_mongrel "$LINENO" "mp.h" "ac_cv_header_mp_h" "$ac_includes_default" @@ -21306,7 +21389,8 @@ -RECURSIVE_MAKE_ARGS="\$(MFLAGS) CC='\$(CC)' CFLAGS='\$(CFLAGS)' LDFLAGS='\$(LDFLAGS)' CPPFLAGS='\$(CPPFLAGS)'" + +RECURSIVE_MAKE_ARGS="\$(MFLAGS) CC='\$(CC)' CFLAGS='\$(CFLAGS)' LDFLAGS='\$(LDFLAGS)' CPPFLAGS='\$(CPPFLAGS)' MAKEINFO='\$(MAKEINFO)'" native_sound_lib=$with_native_sound_lib @@ -21728,6 +21812,7 @@ test "$with_dnet" = yes && echo " Compiling in support for DNET." test "$with_modules" = "yes" && echo " Compiling in support for dynamic shared object modules." test "$with_bignum" = "gmp" && echo " Compiling in support for more number types using the GNU MP library." +test "$with_bignum" = "mpir" && echo " Compiling in support for more number types using the MPIR library." test "$with_bignum" = "mp" && echo " Compiling in support for more number types using the BSD MP library." if test "$with_union_type" = yes ; then echo " Using the union type for Lisp_Objects." @@ -22521,6 +22606,7 @@ for ac_config_target in $ac_config_targets do case $ac_config_target in + "man/Makefile") CONFIG_FILES="$CONFIG_FILES man/Makefile" ;; "src/config.h") CONFIG_HEADERS="$CONFIG_HEADERS src/config.h" ;; "lwlib/config.h") CONFIG_HEADERS="$CONFIG_HEADERS lwlib/config.h" ;; "$file") CONFIG_FILES="$CONFIG_FILES $file" ;;
--- a/configure.ac Wed Jul 10 14:14:30 2013 +0100 +++ b/configure.ac Wed Jul 10 14:32:02 2013 +0100 @@ -964,8 +964,9 @@ XE_KEYWORD_ARG([bignum], AS_HELP_STRING([--with-bignum=TYPE],[Compile in support for bignums, ratios, or bigfloats using library support. TYPE must be one of "gmp" - (for GNU MP), "mp" (for BSD MP), or "no" (disabled).]), - [], [with_bignum="no"],[no,gmp,mp]) + (for GNU MP), "mpir" (for MPIR), "mp" (for BSD MP), + or "no" (disabled).]), + [], [with_bignum="no"],[no,gmp,mpir,mp]) dnl XE_HELP_SUBSECTION([Platform Specific options]) XE_MERGED_ARG([workshop], @@ -2585,6 +2586,27 @@ AC_PROG_INSTALL AC_PROG_YACC +dnl We need a recent version of makeinfo +AC_MSG_CHECKING([for makeinfo >= 4.12]) +MAKEINFO= +for prog in `which -a makeinfo`; do + mi_verstr=[`$prog --version | sed -rn '1s/.*+[[:blank:]]([^[:blank:]]+)$/\1/p'`] + mi_major=`echo $mi_verstr | cut -d. -f1` + mi_minor=`echo $mi_verstr | cut -d. -f2` + if test $mi_major -gt 4 || ( test $mi_major -eq 4 && test $mi_minor -gt 11 ); + then + MAKEINFO=$prog + break + fi +done +if test -z $MAKEINFO; then + AC_MSG_RESULT([no]) + AC_MSG_WARN([Makeinfo 4.12 or later required to build info files.]) +else + AC_MSG_RESULT([yes]) +fi +AC_CONFIG_FILES([man/Makefile]) + dnl checks for header files AC_CHECK_HEADERS(dnl a.out.h dnl @@ -5264,6 +5286,16 @@ else XE_DIE("Required GMP numeric support cannot be provided.") fi +elif test "$with_bignum" = "mpir"; then + AC_CHECK_HEADER(mpir.h, [ + AC_CHECK_LIB(mpir, __gmpz_init, have_mpz_init=yes)]) + if test "$have_mpz_init" = "yes"; then + AC_DEFINE(WITH_NUMBER_TYPES) + AC_DEFINE(WITH_MPIR) + XE_PREPEND(-lmpir, LIBS) + else + XE_DIE("Required MPIR numeric support cannot be provided.") + fi elif test "$with_bignum" = "mp"; then for library in "" "-lcrypto"; do AC_CHECK_HEADER(mp.h, [ @@ -5547,7 +5579,8 @@ AC_SUBST(CFLAGS) AC_SUBST(CPPFLAGS) AC_SUBST(LDFLAGS) -RECURSIVE_MAKE_ARGS="\$(MFLAGS) CC='\$(CC)' CFLAGS='\$(CFLAGS)' LDFLAGS='\$(LDFLAGS)' CPPFLAGS='\$(CPPFLAGS)'" +AC_SUBST(MAKEINFO) +RECURSIVE_MAKE_ARGS="\$(MFLAGS) CC='\$(CC)' CFLAGS='\$(CFLAGS)' LDFLAGS='\$(LDFLAGS)' CPPFLAGS='\$(CPPFLAGS)' MAKEINFO='\$(MAKEINFO)'" AC_SUBST(RECURSIVE_MAKE_ARGS) AC_SUBST(native_sound_lib,$with_native_sound_lib) @@ -5932,6 +5965,7 @@ test "$with_dnet" = yes && echo " Compiling in support for DNET." test "$with_modules" = "yes" && echo " Compiling in support for dynamic shared object modules." test "$with_bignum" = "gmp" && echo " Compiling in support for more number types using the GNU MP library." +test "$with_bignum" = "mpir" && echo " Compiling in support for more number types using the MPIR library." test "$with_bignum" = "mp" && echo " Compiling in support for more number types using the BSD MP library." if test "$with_union_type" = yes ; then echo " Using the union type for Lisp_Objects."
--- a/lisp/ChangeLog Wed Jul 10 14:14:30 2013 +0100 +++ b/lisp/ChangeLog Wed Jul 10 14:32:02 2013 +0100 @@ -1,3 +1,15 @@ +2013-06-22 Stephen J. Turnbull <stephen@xemacs.org> + + * paragraphs.el (sentence-end-base): + Fix stupid omission of cast to string. + +2013-06-21 Stephen J. Turnbull <stephen@xemacs.org> + + Fix no-Mule build. + + * paragraphs.el (sentence-end): Use octal, not Unicode, escapes. + * (sentence-end-base): Use non-ASCII only in Mule. + 2013-07-10 Aidan Kehoe <kehoea@parhasard.net> * minibuf.el (get-user-response):
--- a/lisp/paragraphs.el Wed Jul 10 14:14:30 2013 +0100 +++ b/lisp/paragraphs.el Wed Jul 10 14:32:02 2013 +0100 @@ -180,7 +180,10 @@ :type '(choice regexp (const :tag "Use default value" nil))) (put 'sentence-end 'safe-local-variable 'string-or-null-p) -(defcustom sentence-end-base "[.?!][]\"'”)}]*" +(defcustom sentence-end-base + (concat "[.?!][]\"'" + (if (featurep 'mule) (string (unicode-to-char #x201D)) "") + ")}]*") "Regexp matching the basic end of a sentence, not including following space." :group 'paragraphs :type 'string @@ -201,14 +204,14 @@ in between. See Info node `(elisp)Standard Regexps'." (or sentence-end ;; We accept non-break space along with space. - (concat (if sentence-end-without-period "\\w[ \u00a0][ \u00a0]\\|") + (concat (if sentence-end-without-period "\\w[ \240][ \240]\\|") "\\(" sentence-end-base (if sentence-end-double-space - "\\($\\|[ \u00a0]$\\|\t\\|[ \u00a0][ \u00a0]\\)" "\\($\\|[\t \u00a0]\\)") + "\\($\\|[ \240]$\\|\t\\|[ \240][ \240]\\)" "\\($\\|[\t \240]\\)") "\\|[" sentence-end-without-space "]+" "\\)" - "[ \u00a0\t\n]*"))) + "[ \240\t\n]*"))) (defcustom page-delimiter "^\014" "*Regexp describing line-beginnings that separate pages."
--- a/man/ChangeLog Wed Jul 10 14:14:30 2013 +0100 +++ b/man/ChangeLog Wed Jul 10 14:32:02 2013 +0100 @@ -1,3 +1,45 @@ +2013-06-25 Jerry James <james@xemacs.org> + + * Makefile.in: New file, so we can replace @MAKEINFO@. + * Makefile: Removed. + * lispref/packaging.texi: Update required version of makeinfo. + * xemacs/packages.texi: Ditto. + +2013-06-19 Jerry James <james@xemacs.org> + + * beta.texi: Move "@end info" to its own line. + * lispref/edebug-inc.texi (Instrumenting Macro Calls): "@table + @bullet" is not supported by texinfo 5.x; use "@table @asis" + instead, since each table entry has a label already. + * lispref/packaging.texi (Makefile Targets): Use @section instead + of @subsection inside a @chapter. + * texinfo.tex: Update to new version that is known to work with + texinfo 5.x. + * texinfo/texinfo.texi (documentencoding): @itemx must always + follow an @item. + * widget.texi: Sync with the Emacs 24.3 version. Change all + @section to @chapter, and all @subsection to @section. + * xemacs-faq.texi (11.0: The XEmacs repositories): Add + @unnumberedsec entry to contain the @unnumberedsubsec for each + question. + (11.1: Working with CVS): Ditto. + (11.2: Working with Mercurial): Ditto. + +2013-06-17 Jerry James <james@xemacs.org> + + * internals/internals.texi (Numeric Types): New chapter describing + the implementation of bignums, ratios, and bigfloats. + * lispref/numbers.texi (The Bignum Extension): Update description + to include MPIR, fix broken URLs, and note that BSD MP support is + now more complete. + (Bignum Basics): Note MPIR support. + (Ratio Basics): Add a missing comma. + (Bigfloat Basics): Fix an incomplete sentence and add examples. + * xemacs-faq.texi (Q7.2.1): Update description to include MPIR, + note that BSD MP support is now more complete, and remove the + paragraph where I promise to write internals documentation. + (Q7.2.3): Update ancient section that mentions the Pentium III. + 2013-01-22 Jerry James <james@xemacs.org> * lispref/glyphs.texi (Image Instantiators): Add :visible to the
--- a/man/Makefile Wed Jul 10 14:14:30 2013 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,393 +0,0 @@ -# Makefile for man subdirectory in XEmacs -# Copyright (C) 1995 Board of Trustees, University of Illinois -# Copyright (C) 1994, 1995 Sun Microsystems. -# Copyright (C) 2005, 2010 Ben Wing. - -# This file is part of XEmacs. - -# XEmacs 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. - -# XEmacs 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 XEmacs; see the file COPYING. If not, write to -# the Free Software Foundation, Inc., 59 Temple Place - Suite 330, -# Boston, MA 02111-1307, USA. - -DESTDIR= - -SHELL = /bin/sh -MAKEINFO = makeinfo -TEXI2DVI = texi2dvi -TEXI2HTML = texi2html -TEXI2HTML_NOSPLIT = $(TEXI2HTML) -verbose -subdir $(HTMLDIR) -TEXI2HTML_SPLIT = $(TEXI2HTML) -verbose -subdir $(HTMLDIR) -split chapter - -RM = rm -f -CP = cp - -.SUFFIXES: -.SUFFIXES: .html .info .texi .dvi .pdf - -RECURSIVE_MAKE_ARGS = $(MFLAGS) MAKEINFO='$(MAKEINFO)' TEXI2DVI='$(TEXI2DVI)' - -all : info - -# Ughhh! The things we do to have portable makefiles... - -INFODIR = ../info -HTMLDIR = ../html -PHOTODIR = ../etc/photos - -src_files1 = \ - $(DIR)beta.texi \ - $(DIR)cl.texi \ - $(DIR)emodules.texi \ - $(DIR)external-widget.texi \ - $(DIR)info.texi \ - $(DIR)internals.texi \ - $(DIR)lispref.texi \ - $(DIR)new-users-guide.texi \ - $(DIR)standards.texi \ - $(DIR)termcap.texi \ - $(DIR)texinfo.texi \ - $(DIR)widget.texi \ - $(DIR)xemacs.texi \ - $(DIR)xemacs-faq.texi - -DIR:= -src_files := $(src_files1) - -DIR := $(INFODIR)/ -info_files := $(src_files1:.texi=.info) - -DIR := $(HTMLDIR)/ -html_files := $(src_files1:.texi=.html) - -dvi_files := $(src_files:.texi=.dvi) - -pdf_files := $(src_files:.texi=.pdf) - - -xemacs-srcs = \ - xemacs/abbrevs.texi \ - xemacs/basic.texi \ - xemacs/buffers.texi \ - xemacs/building.texi \ - xemacs/calendar.texi \ - xemacs/cmdargs.texi \ - xemacs/custom.texi \ - xemacs/display.texi \ - xemacs/entering.texi \ - xemacs/files.texi \ - xemacs/fixit.texi \ - xemacs/frame.texi \ - xemacs/glossary.texi \ - xemacs/gnu.texi \ - xemacs/help.texi \ - xemacs/indent.texi \ - xemacs/keystrokes.texi \ - xemacs/killing.texi \ - xemacs/m-x.texi \ - xemacs/major.texi \ - xemacs/mark.texi \ - xemacs/menus.texi \ - xemacs/mini.texi \ - xemacs/misc.texi \ - xemacs/mouse.texi \ - xemacs/mule.texi \ - xemacs/new.texi \ - xemacs/packages.texi \ - xemacs/picture.texi \ - xemacs/programs.texi \ - xemacs/reading.texi \ - xemacs/regs.texi \ - xemacs/search.texi \ - xemacs/sending.texi \ - xemacs/startup.texi \ - xemacs/text.texi \ - xemacs/trouble.texi \ - xemacs/undo.texi \ - xemacs/windows.texi \ - xemacs/xemacs.texi - -lispref-srcs = \ - lispref/abbrevs.texi \ - lispref/annotations.texi \ - lispref/back.texi \ - lispref/backups.texi \ - lispref/buffers.texi \ - lispref/building.texi \ - lispref/commands.texi \ - lispref/compile.texi \ - lispref/consoles-devices.texi \ - lispref/control.texi \ - lispref/customize.texi \ - lispref/databases.texi \ - lispref/debugging.texi \ - lispref/dialog.texi \ - lispref/display.texi \ - lispref/dragndrop.texi \ - lispref/edebug-inc.texi \ - lispref/edebug.texi \ - lispref/errors.texi \ - lispref/eval.texi \ - lispref/extents.texi \ - lispref/faces.texi \ - lispref/files.texi \ - lispref/frames.texi \ - lispref/functions.texi \ - lispref/glyphs.texi \ - lispref/hash-tables.texi \ - lispref/help.texi \ - lispref/hooks.texi \ - lispref/index.texi \ - lispref/internationalization.texi \ - lispref/intro.texi \ - lispref/keymaps.texi \ - lispref/ldap.texi \ - lispref/lispref.texi \ - lispref/lists.texi \ - lispref/loading.texi \ - lispref/locals.texi \ - lispref/macros.texi \ - lispref/maps.texi \ - lispref/markers.texi \ - lispref/menus.texi \ - lispref/minibuf.texi \ - lispref/modes.texi \ - lispref/mouse.texi \ - lispref/mule.texi \ - lispref/numbers.texi \ - lispref/objects.texi \ - lispref/os.texi \ - lispref/packaging.texi \ - lispref/positions.texi \ - lispref/processes.texi \ - lispref/range-tables.texi \ - lispref/scrollbars.texi \ - lispref/searching.texi \ - lispref/sequences.texi \ - lispref/specifiers.texi \ - lispref/streams.texi \ - lispref/strings.texi \ - lispref/symbols.texi \ - lispref/syntax.texi \ - lispref/text.texi \ - lispref/tips.texi \ - lispref/toolbar.texi \ - lispref/tooltalk.texi \ - lispref/variables.texi \ - lispref/windows.texi \ - lispref/x-windows.texi - -internals-srcs = \ - internals/internals.texi - -new-users-guide-srcs = \ - new-users-guide/custom1.texi \ - new-users-guide/custom2.texi \ - new-users-guide/edit.texi \ - new-users-guide/enter.texi \ - new-users-guide/files.texi \ - new-users-guide/help.texi \ - new-users-guide/modes.texi \ - new-users-guide/new-users-guide.texi \ - new-users-guide/region.texi \ - new-users-guide/search.texi \ - new-users-guide/xmenu.texi - -texinfo-srcs = \ - texinfo/fdl.texi \ - texinfo/texinfo.texi \ - texinfo/version.texi - -$(INFODIR)/beta.info : beta.texi - $(MAKEINFO) -o $(INFODIR)/beta.info beta.texi - -$(INFODIR)/cl.info : cl.texi - $(MAKEINFO) -o $(INFODIR)/cl.info cl.texi - -$(INFODIR)/custom.info : custom.texi - $(MAKEINFO) -o $(INFODIR)/custom.info custom.texi - -$(INFODIR)/emodules.info : emodules.texi - $(MAKEINFO) -o $(INFODIR)/emodules.info emodules.texi - -$(INFODIR)/external-widget.info : external-widget.texi - $(MAKEINFO) -o $(INFODIR)/external-widget.info external-widget.texi - -$(INFODIR)/info.info : info.texi - $(MAKEINFO) -o $(INFODIR)/info.info info.texi - -$(INFODIR)/standards.info : standards.texi - $(MAKEINFO) -o $(INFODIR)/standards.info standards.texi - -$(INFODIR)/term.info : term.texi - $(MAKEINFO) -o $(INFODIR)/term.info term.texi - -$(INFODIR)/termcap.info : termcap.texi - $(MAKEINFO) -o $(INFODIR)/termcap.info termcap.texi - -$(INFODIR)/widget.info : widget.texi doclicense.texi - $(MAKEINFO) -o $(INFODIR)/widget.info widget.texi - -$(INFODIR)/xemacs-faq.info : xemacs-faq.texi - $(MAKEINFO) -o $(INFODIR)/xemacs-faq.info xemacs-faq.texi - -# Manuals with their own subdirectory -$(INFODIR)/xemacs.info : $(xemacs-srcs) - $(MAKEINFO) -P xemacs -o $(INFODIR)/xemacs.info xemacs/xemacs.texi - -$(INFODIR)/lispref.info : $(lispref-srcs) - $(MAKEINFO) -P lispref -o $(INFODIR)/lispref.info lispref/lispref.texi - -$(INFODIR)/internals.info : $(internals-srcs) - $(MAKEINFO) -P internals -o $(INFODIR)/internals.info internals/internals.texi - -$(INFODIR)/new-users-guide.info : $(new-users-guide-srcs) - $(MAKEINFO) -P new-users-guide -o $(INFODIR)/new-users-guide.info new-users-guide/new-users-guide.texi - -$(INFODIR)/texinfo.info : $(texinfo-srcs) - $(MAKEINFO) -P texinfo -o $(INFODIR)/texinfo.info texinfo/texinfo.texi - -xemacs : $(INFODIR)/xemacs.info -lispref : $(INFODIR)/lispref.info -internals : $(INFODIR)/internals.info -new-users-guide.info : $(INFODIR)/new-users-guide.info -texinfo : $(INFODIR)/texinfo.info - -.PHONY : xemacs lispref internals new-users-guide texinfo info dvi pdf - -info : $(info_files) -html : $(html_files) - -.texi.dvi: - -$(TEXI2DVI) $< - -.texi.pdf: - -$(TEXI2DVI) --pdf $< - -xemacs.dvi : $(xemacs-srcs) - $(TEXI2DVI) -I xemacs xemacs/xemacs.texi - -lispref.dvi : $(lispref-srcs) - $(TEXI2DVI) -I lispref lispref/lispref.texi - -internals.dvi : $(internals-srcs) - $(TEXI2DVI) -I internals internals/internals.texi - -new-users-guide.dvi : $(new-users-guide-srcs) - $(TEXI2DVI) -I new-users-guide new-users-guide/new-users-guide.texi - -texinfo.dvi : $(texinfo-srcs) - $(TEXI2DVI) -I texinfo texinfo/texinfo.texi - -dvi : $(dvi_files) - -xemacs.pdf: $(xemacs-srcs) - $(TEXI2DVI) --pdf -I xemacs xemacs/xemacs.texi - -lispref.pdf: $(lispref-srcs) - $(TEXI2DVI) --pdf -I lispref lispref/lispref.texi - -internals.pdf: $(internals-srcs) - $(TEXI2DVI) --pdf -I internals internals/internals.texi - -new-users-guide.pdf: $(new-users-guide-srcs) - $(TEXI2DVI) --pdf -I new-users-guide new-users-guide/new-users-guide.texi - -texinfo.pdf: $(texinfo-srcs) - $(TEXI2DVI) --pdf -I texinfo texinfo/texinfo.texi - -pdf: $(pdf_files) - -.PHONY: mostlyclean clean distclean realclean extraclean -.PHONY: distclean-noconfig realclean-noconfig extraclean-noconfig -mostlyclean: - $(RM) *.toc *.aux *.log *.op *.cp *.cps *.fn *.fns - $(RM) *.ky *.kys *.pg *.pgs *.tp *.tps *.vr *.vrs -clean: mostlyclean - $(RM) core *.dvi *.pdf -distclean-noconfig: clean -distclean: distclean-noconfig -realclean-noconfig: distclean-noconfig -realclean: distclean -extraclean-noconfig: realclean-noconfig - $(RM) *~ \#* */*~ */\#* -extraclean: realclean - $(RM) *~ \#* */*~ */\#* - -############################################################################ - -$(HTMLDIR)/beta.html : beta.texi - $(TEXI2HTML_NOSPLIT) beta.texi - -$(HTMLDIR)/cl.html : cl.texi - $(TEXI2HTML_SPLIT) cl.texi - -$(HTMLDIR)/custom.html : custom.texi - $(TEXI2HTML_SPLIT) custom.texi - -$(HTMLDIR)/emodules.html : emodules.texi - $(TEXI2HTML_SPLIT) emodules.texi - -$(HTMLDIR)/external-widget.html : external-widget.texi - $(TEXI2HTML_SPLIT) external-widget.texi - -$(HTMLDIR)/info.html : info.texi - $(TEXI2HTML_SPLIT) info.texi - -$(HTMLDIR)/standards.html : standards.texi - $(TEXI2HTML_SPLIT) standards.texi - -$(HTMLDIR)/term.html : term.texi - $(TEXI2HTML_SPLIT) term.texi - -$(HTMLDIR)/termcap.html : termcap.texi - $(TEXI2HTML_SPLIT) termcap.texi - -$(HTMLDIR)/widget.html : widget.texi - $(TEXI2HTML_SPLIT) widget.texi - -$(HTMLDIR)/xemacs-faq.html : xemacs-faq.texi - $(TEXI2HTML_NOSPLIT) xemacs-faq.texi - $(TEXI2HTML_SPLIT) -top_file xemacs-faq_1.html xemacs-faq.texi - $(CP) $(PHOTODIR)/ben.png $(HTMLDIR) - $(CP) $(PHOTODIR)/cthomp.png $(HTMLDIR) - $(CP) $(PHOTODIR)/hniksic.png $(HTMLDIR) - $(CP) $(PHOTODIR)/jwz.png $(HTMLDIR) - $(CP) $(PHOTODIR)/martin.png $(HTMLDIR) - $(CP) $(PHOTODIR)/mly.png $(HTMLDIR) - $(CP) $(PHOTODIR)/piper.png $(HTMLDIR) - $(CP) $(PHOTODIR)/slb.png $(HTMLDIR) - -# Manuals with their own subdirectory -$(HTMLDIR)/xemacs.html : $(xemacs-srcs) - $(TEXI2HTML_SPLIT) xemacs/xemacs.texi - -$(HTMLDIR)/lispref.html : $(lispref-srcs) - $(TEXI2HTML_SPLIT) lispref/lispref.texi - -$(HTMLDIR)/internals.html : $(internals-srcs) - $(TEXI2HTML_SPLIT) internals/internals.texi - -$(HTMLDIR)/new-users-guide.html : $(new-users-guide-srcs) - $(TEXI2HTML_SPLIT) new-users-guide/new-users-guide.texi - -$(HTMLDIR)/texinfo.html : $(texinfo-srcs) - $(TEXI2HTML_SPLIT) texinfo/texinfo.texi - -xemacs : $(HTMLDIR)/xemacs.html -lispref : $(HTMLDIR)/lispref.html -internals : $(HTMLDIR)/internals.html -new-users-guide.html : $(HTMLDIR)/new-users-guide.html -texinfo : $(HTMLDIR)/texinfo.html - -html : $(html_files)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/Makefile.in Wed Jul 10 14:32:02 2013 +0100 @@ -0,0 +1,393 @@ +# Makefile for man subdirectory in XEmacs +# Copyright (C) 1995 Board of Trustees, University of Illinois +# Copyright (C) 1994, 1995 Sun Microsystems. +# Copyright (C) 2005, 2010 Ben Wing. + +# This file is part of XEmacs. + +# XEmacs 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. + +# XEmacs 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 XEmacs; see the file COPYING. If not, write to +# the Free Software Foundation, Inc., 59 Temple Place - Suite 330, +# Boston, MA 02111-1307, USA. + +DESTDIR= + +SHELL = /bin/sh +MAKEINFO = @MAKEINFO@ +TEXI2DVI = texi2dvi +TEXI2HTML = texi2html +TEXI2HTML_NOSPLIT = $(TEXI2HTML) -verbose -subdir $(HTMLDIR) +TEXI2HTML_SPLIT = $(TEXI2HTML) -verbose -subdir $(HTMLDIR) -split chapter + +RM = rm -f +CP = cp + +.SUFFIXES: +.SUFFIXES: .html .info .texi .dvi .pdf + +RECURSIVE_MAKE_ARGS = $(MFLAGS) MAKEINFO='$(MAKEINFO)' TEXI2DVI='$(TEXI2DVI)' + +all : info + +# Ughhh! The things we do to have portable makefiles... + +INFODIR = ../info +HTMLDIR = ../html +PHOTODIR = ../etc/photos + +src_files1 = \ + $(DIR)beta.texi \ + $(DIR)cl.texi \ + $(DIR)emodules.texi \ + $(DIR)external-widget.texi \ + $(DIR)info.texi \ + $(DIR)internals.texi \ + $(DIR)lispref.texi \ + $(DIR)new-users-guide.texi \ + $(DIR)standards.texi \ + $(DIR)termcap.texi \ + $(DIR)texinfo.texi \ + $(DIR)widget.texi \ + $(DIR)xemacs.texi \ + $(DIR)xemacs-faq.texi + +DIR:= +src_files := $(src_files1) + +DIR := $(INFODIR)/ +info_files := $(src_files1:.texi=.info) + +DIR := $(HTMLDIR)/ +html_files := $(src_files1:.texi=.html) + +dvi_files := $(src_files:.texi=.dvi) + +pdf_files := $(src_files:.texi=.pdf) + + +xemacs-srcs = \ + xemacs/abbrevs.texi \ + xemacs/basic.texi \ + xemacs/buffers.texi \ + xemacs/building.texi \ + xemacs/calendar.texi \ + xemacs/cmdargs.texi \ + xemacs/custom.texi \ + xemacs/display.texi \ + xemacs/entering.texi \ + xemacs/files.texi \ + xemacs/fixit.texi \ + xemacs/frame.texi \ + xemacs/glossary.texi \ + xemacs/gnu.texi \ + xemacs/help.texi \ + xemacs/indent.texi \ + xemacs/keystrokes.texi \ + xemacs/killing.texi \ + xemacs/m-x.texi \ + xemacs/major.texi \ + xemacs/mark.texi \ + xemacs/menus.texi \ + xemacs/mini.texi \ + xemacs/misc.texi \ + xemacs/mouse.texi \ + xemacs/mule.texi \ + xemacs/new.texi \ + xemacs/packages.texi \ + xemacs/picture.texi \ + xemacs/programs.texi \ + xemacs/reading.texi \ + xemacs/regs.texi \ + xemacs/search.texi \ + xemacs/sending.texi \ + xemacs/startup.texi \ + xemacs/text.texi \ + xemacs/trouble.texi \ + xemacs/undo.texi \ + xemacs/windows.texi \ + xemacs/xemacs.texi + +lispref-srcs = \ + lispref/abbrevs.texi \ + lispref/annotations.texi \ + lispref/back.texi \ + lispref/backups.texi \ + lispref/buffers.texi \ + lispref/building.texi \ + lispref/commands.texi \ + lispref/compile.texi \ + lispref/consoles-devices.texi \ + lispref/control.texi \ + lispref/customize.texi \ + lispref/databases.texi \ + lispref/debugging.texi \ + lispref/dialog.texi \ + lispref/display.texi \ + lispref/dragndrop.texi \ + lispref/edebug-inc.texi \ + lispref/edebug.texi \ + lispref/errors.texi \ + lispref/eval.texi \ + lispref/extents.texi \ + lispref/faces.texi \ + lispref/files.texi \ + lispref/frames.texi \ + lispref/functions.texi \ + lispref/glyphs.texi \ + lispref/hash-tables.texi \ + lispref/help.texi \ + lispref/hooks.texi \ + lispref/index.texi \ + lispref/internationalization.texi \ + lispref/intro.texi \ + lispref/keymaps.texi \ + lispref/ldap.texi \ + lispref/lispref.texi \ + lispref/lists.texi \ + lispref/loading.texi \ + lispref/locals.texi \ + lispref/macros.texi \ + lispref/maps.texi \ + lispref/markers.texi \ + lispref/menus.texi \ + lispref/minibuf.texi \ + lispref/modes.texi \ + lispref/mouse.texi \ + lispref/mule.texi \ + lispref/numbers.texi \ + lispref/objects.texi \ + lispref/os.texi \ + lispref/packaging.texi \ + lispref/positions.texi \ + lispref/processes.texi \ + lispref/range-tables.texi \ + lispref/scrollbars.texi \ + lispref/searching.texi \ + lispref/sequences.texi \ + lispref/specifiers.texi \ + lispref/streams.texi \ + lispref/strings.texi \ + lispref/symbols.texi \ + lispref/syntax.texi \ + lispref/text.texi \ + lispref/tips.texi \ + lispref/toolbar.texi \ + lispref/tooltalk.texi \ + lispref/variables.texi \ + lispref/windows.texi \ + lispref/x-windows.texi + +internals-srcs = \ + internals/internals.texi + +new-users-guide-srcs = \ + new-users-guide/custom1.texi \ + new-users-guide/custom2.texi \ + new-users-guide/edit.texi \ + new-users-guide/enter.texi \ + new-users-guide/files.texi \ + new-users-guide/help.texi \ + new-users-guide/modes.texi \ + new-users-guide/new-users-guide.texi \ + new-users-guide/region.texi \ + new-users-guide/search.texi \ + new-users-guide/xmenu.texi + +texinfo-srcs = \ + texinfo/fdl.texi \ + texinfo/texinfo.texi \ + texinfo/version.texi + +$(INFODIR)/beta.info : beta.texi + $(MAKEINFO) -o $(INFODIR)/beta.info beta.texi + +$(INFODIR)/cl.info : cl.texi + $(MAKEINFO) -o $(INFODIR)/cl.info cl.texi + +$(INFODIR)/custom.info : custom.texi + $(MAKEINFO) -o $(INFODIR)/custom.info custom.texi + +$(INFODIR)/emodules.info : emodules.texi + $(MAKEINFO) -o $(INFODIR)/emodules.info emodules.texi + +$(INFODIR)/external-widget.info : external-widget.texi + $(MAKEINFO) -o $(INFODIR)/external-widget.info external-widget.texi + +$(INFODIR)/info.info : info.texi + $(MAKEINFO) -o $(INFODIR)/info.info info.texi + +$(INFODIR)/standards.info : standards.texi + $(MAKEINFO) -o $(INFODIR)/standards.info standards.texi + +$(INFODIR)/term.info : term.texi + $(MAKEINFO) -o $(INFODIR)/term.info term.texi + +$(INFODIR)/termcap.info : termcap.texi + $(MAKEINFO) -o $(INFODIR)/termcap.info termcap.texi + +$(INFODIR)/widget.info : widget.texi doclicense.texi + $(MAKEINFO) -o $(INFODIR)/widget.info widget.texi + +$(INFODIR)/xemacs-faq.info : xemacs-faq.texi + $(MAKEINFO) -o $(INFODIR)/xemacs-faq.info xemacs-faq.texi + +# Manuals with their own subdirectory +$(INFODIR)/xemacs.info : $(xemacs-srcs) + $(MAKEINFO) -P xemacs -o $(INFODIR)/xemacs.info xemacs/xemacs.texi + +$(INFODIR)/lispref.info : $(lispref-srcs) + $(MAKEINFO) -P lispref -o $(INFODIR)/lispref.info lispref/lispref.texi + +$(INFODIR)/internals.info : $(internals-srcs) + $(MAKEINFO) -P internals -o $(INFODIR)/internals.info internals/internals.texi + +$(INFODIR)/new-users-guide.info : $(new-users-guide-srcs) + $(MAKEINFO) -P new-users-guide -o $(INFODIR)/new-users-guide.info new-users-guide/new-users-guide.texi + +$(INFODIR)/texinfo.info : $(texinfo-srcs) + $(MAKEINFO) -P texinfo -o $(INFODIR)/texinfo.info texinfo/texinfo.texi + +xemacs : $(INFODIR)/xemacs.info +lispref : $(INFODIR)/lispref.info +internals : $(INFODIR)/internals.info +new-users-guide.info : $(INFODIR)/new-users-guide.info +texinfo : $(INFODIR)/texinfo.info + +.PHONY : xemacs lispref internals new-users-guide texinfo info dvi pdf + +info : $(info_files) +html : $(html_files) + +.texi.dvi: + -$(TEXI2DVI) $< + +.texi.pdf: + -$(TEXI2DVI) --pdf $< + +xemacs.dvi : $(xemacs-srcs) + $(TEXI2DVI) -I xemacs xemacs/xemacs.texi + +lispref.dvi : $(lispref-srcs) + $(TEXI2DVI) -I lispref lispref/lispref.texi + +internals.dvi : $(internals-srcs) + $(TEXI2DVI) -I internals internals/internals.texi + +new-users-guide.dvi : $(new-users-guide-srcs) + $(TEXI2DVI) -I new-users-guide new-users-guide/new-users-guide.texi + +texinfo.dvi : $(texinfo-srcs) + $(TEXI2DVI) -I texinfo texinfo/texinfo.texi + +dvi : $(dvi_files) + +xemacs.pdf: $(xemacs-srcs) + $(TEXI2DVI) --pdf -I xemacs xemacs/xemacs.texi + +lispref.pdf: $(lispref-srcs) + $(TEXI2DVI) --pdf -I lispref lispref/lispref.texi + +internals.pdf: $(internals-srcs) + $(TEXI2DVI) --pdf -I internals internals/internals.texi + +new-users-guide.pdf: $(new-users-guide-srcs) + $(TEXI2DVI) --pdf -I new-users-guide new-users-guide/new-users-guide.texi + +texinfo.pdf: $(texinfo-srcs) + $(TEXI2DVI) --pdf -I texinfo texinfo/texinfo.texi + +pdf: $(pdf_files) + +.PHONY: mostlyclean clean distclean realclean extraclean +.PHONY: distclean-noconfig realclean-noconfig extraclean-noconfig +mostlyclean: + $(RM) *.toc *.aux *.log *.op *.cp *.cps *.fn *.fns + $(RM) *.ky *.kys *.pg *.pgs *.tp *.tps *.vr *.vrs +clean: mostlyclean + $(RM) core *.dvi *.pdf +distclean-noconfig: clean +distclean: distclean-noconfig +realclean-noconfig: distclean-noconfig +realclean: distclean +extraclean-noconfig: realclean-noconfig + $(RM) *~ \#* */*~ */\#* +extraclean: realclean + $(RM) *~ \#* */*~ */\#* + +############################################################################ + +$(HTMLDIR)/beta.html : beta.texi + $(TEXI2HTML_NOSPLIT) beta.texi + +$(HTMLDIR)/cl.html : cl.texi + $(TEXI2HTML_SPLIT) cl.texi + +$(HTMLDIR)/custom.html : custom.texi + $(TEXI2HTML_SPLIT) custom.texi + +$(HTMLDIR)/emodules.html : emodules.texi + $(TEXI2HTML_SPLIT) emodules.texi + +$(HTMLDIR)/external-widget.html : external-widget.texi + $(TEXI2HTML_SPLIT) external-widget.texi + +$(HTMLDIR)/info.html : info.texi + $(TEXI2HTML_SPLIT) info.texi + +$(HTMLDIR)/standards.html : standards.texi + $(TEXI2HTML_SPLIT) standards.texi + +$(HTMLDIR)/term.html : term.texi + $(TEXI2HTML_SPLIT) term.texi + +$(HTMLDIR)/termcap.html : termcap.texi + $(TEXI2HTML_SPLIT) termcap.texi + +$(HTMLDIR)/widget.html : widget.texi + $(TEXI2HTML_SPLIT) widget.texi + +$(HTMLDIR)/xemacs-faq.html : xemacs-faq.texi + $(TEXI2HTML_NOSPLIT) xemacs-faq.texi + $(TEXI2HTML_SPLIT) -top_file xemacs-faq_1.html xemacs-faq.texi + $(CP) $(PHOTODIR)/ben.png $(HTMLDIR) + $(CP) $(PHOTODIR)/cthomp.png $(HTMLDIR) + $(CP) $(PHOTODIR)/hniksic.png $(HTMLDIR) + $(CP) $(PHOTODIR)/jwz.png $(HTMLDIR) + $(CP) $(PHOTODIR)/martin.png $(HTMLDIR) + $(CP) $(PHOTODIR)/mly.png $(HTMLDIR) + $(CP) $(PHOTODIR)/piper.png $(HTMLDIR) + $(CP) $(PHOTODIR)/slb.png $(HTMLDIR) + +# Manuals with their own subdirectory +$(HTMLDIR)/xemacs.html : $(xemacs-srcs) + $(TEXI2HTML_SPLIT) xemacs/xemacs.texi + +$(HTMLDIR)/lispref.html : $(lispref-srcs) + $(TEXI2HTML_SPLIT) lispref/lispref.texi + +$(HTMLDIR)/internals.html : $(internals-srcs) + $(TEXI2HTML_SPLIT) internals/internals.texi + +$(HTMLDIR)/new-users-guide.html : $(new-users-guide-srcs) + $(TEXI2HTML_SPLIT) new-users-guide/new-users-guide.texi + +$(HTMLDIR)/texinfo.html : $(texinfo-srcs) + $(TEXI2HTML_SPLIT) texinfo/texinfo.texi + +xemacs : $(HTMLDIR)/xemacs.html +lispref : $(HTMLDIR)/lispref.html +internals : $(HTMLDIR)/internals.html +new-users-guide.html : $(HTMLDIR)/new-users-guide.html +texinfo : $(HTMLDIR)/texinfo.html + +html : $(html_files)
--- a/man/beta.texi Wed Jul 10 14:14:30 2013 +0100 +++ b/man/beta.texi Wed Jul 10 14:32:02 2013 +0100 @@ -34,7 +34,8 @@ for more details. You should have received a copy of the GNU General Public License -along with XEmacs. If not, see <http://www.gnu.org/licenses/>.@end ifinfo +along with XEmacs. If not, see <http://www.gnu.org/licenses/>. +@end ifinfo @c Combine indices. @syncodeindex fn cp
--- a/man/internals/internals.texi Wed Jul 10 14:14:30 2013 +0100 +++ b/man/internals/internals.texi Wed Jul 10 14:32:02 2013 +0100 @@ -1,4 +1,4 @@ - \input texinfo @c -*-texinfo-*- +\input texinfo @c -*-texinfo-*- @c %**start of header @setfilename ../../info/internals.info @settitle XEmacs Internals Manual @@ -88,6 +88,7 @@ @author Matthias Neubauer @author Olivier Galibert @author Andy Piper +@author Jerry James @page @@ -353,6 +354,7 @@ * CVS Techniques:: * XEmacs from the Inside:: * Basic Types:: +* Numeric Types:: * Low-Level Allocation:: * The XEmacs Object System (Abstractly Speaking):: * How Lisp Objects Are Represented in C:: @@ -3143,12 +3145,14 @@ @item @file{nt.c} @tab @item @file{ntheap.c} @tab @item @file{ntplay.c} @tab -@item @file{number-gmp.c} @tab -@item @file{number-gmp.h} @tab -@item @file{number-mp.c} @tab -@item @file{number-mp.h} @tab -@item @file{number.c} @tab -@item @file{number.h} @tab +@item @file{number-gmp.c} @tab @ref{GMP and MPIR driver} +@item @file{number-gmp.h} @tab @ref{GMP and MPIR driver} +@item @file{number-mp.c} @tab @ref{BSD MP driver} +@item @file{number-mp.h} @tab @ref{BSD MP driver} +@item @file{number-mpir.c} @tab @ref{GMP and MPIR driver} +@item @file{number-mpir.h} @tab @ref{GMP and MPIR driver} +@item @file{number.c} @tab @ref{Abstract Numeric Interface} +@item @file{number.h} @tab @ref{Abstract Numeric Interface} @item @file{fontcolor-gtk-impl.h} @tab @item @file{fontcolor-gtk.c} @tab @item @file{fontcolor-gtk.h} @tab @@ -7230,14 +7234,569 @@ of obscure and unwanted interactions occurring than if they were to change the C code. -@node Basic Types, Low-Level Allocation, XEmacs from the Inside, Top +@node Basic Types, Numeric Types, XEmacs from the Inside, Top @chapter Basic Types @cindex basic types @cindex types, basic Not yet documented. -@node Low-Level Allocation, The XEmacs Object System (Abstractly Speaking), Basic Types, Top +@node Numeric Types, Low-Level Allocation, Basic Types, Top +@chapter Numeric Types +@cindex numeric types +@cindex types, numeric + +@menu +* Abstract Numeric Interface:: +* GMP and MPIR driver:: +* BSD MP driver:: +* Numeric driver interface:: +@end menu + +@node Abstract Numeric Interface, GMP and MPIR driver, Numeric Types, Numeric Types +@section Abstract Interface +@cindex abstract numeric interface + +The following types are always defined in the same manner: +@itemize +@item fixnum +Whatever fits in the @code{Lisp_Object} type. +@item integer +The union of the @code{fixnum} and @code{bignum} types. +@item rational +The union of the @code{integer} and @code{ratio} types. +@item float +The equivalent of a C @code{double}. +@item floating +The union of the @code{float} and @code{bigfloat} types. +@item real +The union of the @code{rational} and @code{floating} types. +@item number +The union of the @code{real} and @code{complex} types. Since there is +no @code{complex} type, this is currently equivalent to the @code{real} +type. +@end itemize + +The remaining types (@code{bignum}, @code{ratio}, and @code{bigfloat}) +are defined by library-specific drivers, as detailed in the remaining +sections of this chapter. A given driver may define one or more of +these types to be empty. In fact, the default configuration makes all +three types empty, so that @code{integer} and @code{rational} are the +same types as @code{fixnum}, etc. The configure script sets zero or +more of the symbols @code{HAVE_BIGNUM}, @code{HAVE_RATIO}, and +@code{HAVE_BIGFLOAT} to indicate which types are nonempty. These are +the consequences of an empty type: +@itemize +@item bignum +Then @code{bignump(x)} is false for all x. Any attempt to create a +bignum causes an error to be raised. +@item ratio +Then @code{ratiop(x)} is false for all x. Any attempt to create a ratio +causes an error to be raised. +@item bigfloat +Then @code{bigfloat(x)} is false for all x. Any attempt to create a +bigfloat causes an error to be raised. +@end itemize + +We @code{(provide)} the following symbols, so that Lisp code can +determine when the various numeric types are available for use: +@itemize @bullet +@item +@code{(provide 'bignum)} if @code{HAVE_BIGNUM} is set +@item +@code{(provde 'ratio)} if @code{HAVE_RATIO} is set +@item +@code{(provide 'bigfloat)} if @code{HAVE_BIGFLOAT} is set +@end itemize + +C code should use one of the following macros to create a Lisp integer, +depending on the type of the C integer to be converted. +@itemize @bullet +@item +@code{make_fixnum(x)} if x is guaranteed to fit into a Lisp fixnum. +@item +@code{make_integer(x)} if x is a signed C integer of any type. +@item +@code{make_unsigned_integer(x)} if x is an unsigned C integer of any type. +@end itemize + +The @code{make_integer(x)} and @code{make_unsigned_integer(x)} macros +both create a fixnum if possible, and a bignum otherwise. The value +@code{x} can be a C integer of any size up to and including the size +of a C @code{long long int}. The @code{make_fixnum(x)} macro is +intended to signal the programmer's intent that only fixnum-sized +integers will be used. In some cases, if the compiler cannot prove +that the parameter is always in the fixnum range, this macro is also a +code optimization. + +@node GMP and MPIR driver, BSD MP driver, Abstract Numeric Interface, Numeric Types +@section GMP driver +@cindex gmp +@cindex mpir + +The GNU Multiple Precision library (@uref{http://gmplib.org/}) and its +fork, the Multiple Precision Integers and Rationals library +(@uref{http://www.mpir.org/}), provide large integers, ratios, and +floating point numbers. The same driver supports both GMP and MPIR, and +provides all 3 of the optional types: bignums, ratios, and bigfloats, +implemented with the types @code{mpz_t}, @code{mpq_t}, and @code{mpf_t}, +respectively. Most of the abstract numeric interface is defined in +terms of macros that expand directly into GMP or MPIR API calls, since +GMP and MPIR provide a rich interface. + +@node BSD MP driver, Numeric driver interface, GMP and MPIR driver, Numeric Types +@section BSD MP driver +@cindex BSD mp + +The BSD MP interface is less rich than its GMP and MPIR counterparts. +It provides only large integers, implemented as type @code{MINT *}; +ratios and bigfloats are not available. BSD MP libraries are supplied +by multiple vendors, with some small variations. This driver is +intended to work with any variation. + +Some BSD MP libraries use function names that are likely cause name +collisions, such as @code{gcd}, @code{mult}, and @code{pow}. Others +follow the Single Unix Specification recommendation (see +@uref{http://www.unix.com/man-page/all/3mp/mp_mcmp/}) and prefix all of +the function names with ``mp_'': @code{mp_gcd}, @code{mp_mult}, +@code{mp_pow}, etc. The XEmacs configure script detects which of the +two interfaces is in use, and defines @code{MP_PREFIX} for the latter +case. We use macros (@code{MP_MULT}, etc.) to hide this difference. + +Another variation is that some, but not all, BSD MP libraries supply a +function named @code{move} or @code{mp_move} that copies its first +argument into its second argument. We define the move operation as +setting the destination number to the source number plus zero for those +libraries that do not supply this function. + +The BSD MP interface does not directly support many of the operations +that we need, so the implementations sometimes consist of complex +functions. See the implementation of @code{bignum_random}, for +example. + +@node Numeric driver interface, , BSD MP driver, Numeric Types +@section Numeric driver interface +@cindex numeric driver interface + +@menu +* Bignum interface:: +* Ratio interface:: +* Bigfloat interface:: +@end menu + +@node Bignum interface, Ratio interface, Numeric driver interface, Numeric driver interface +@subsection Bignum interface +@cindex bignum interface + +Each bignum implementation defines @code{HAVE_BIGNUM} and an appropriate +bignum type. For example, the GMP driver uses this definition: + +@example +typedef mpz_t bignum; +@end example + +The following names are defined for each driver, either as real C +functions or as C preprocessor macros. +@itemize +@item void bignum_init(bignum b) +Does any necessary initialization before the bignum @code{b} can be +used. This function typically allocates memory for the bignum. +@item void bignum_fini(bignum b) +Cleans up any resources held by the bignum @code{b}, typically +deallocating the memory dedicated to that bignum. The object referred +to by @code{b} must not be accessed after this call returns. +@item unsigned int bignum_hashcode(bignum b) +Returns a hash code for the bignum, suitable for use in XEmacs hash +tables. +@item int bignum_sign(bignum b) +Returns a positive value, zero, or a negative value to indicate that +@code{b} is positive, zero, or negative, respectively. +@item int bignum_evenp(bignum b) +Returns a nonzero value if @code{b} is an even number, zero if it is odd. +@item int bignum_oddp(bignum b) +Returns a nonzero value if @code{b} is an odd number, zero if it is even. +@item int bignum_fits_int_p(bignum b) +Returns a nonzero value if @code{b} can be represented in a C +@code{int}, zero otherwise. +@item int bignum_fits_uint_p(bignum b) +Returns a nonzero value if @code{b} can be represented in a C +@code{unsigned int}, zero otherwise. +@item int bignum_fits_long_p(bignum b) +Returns a nonzero value if @code{b} can be represented in a C +@code{long int}, zero otherwise. +@item int bignum_fits_ulong_p(bignum b) +Returns a nonzero value if @code{b} can be represented in a C +@code{unsigned long int}, zero otherwise. +@item int bignum_fits_llong_p(bignum b) +Returns a nonzero value if @code{b} can be represented in a C +@code{long long int}, zero otherwise. +@item int bignum_fits_ullong_p(bignum b) +Returns a nonzero value if @code{b} can be represented in a C +@code{unsigned long long int}, zero otherwise. +@item void bignum_to_string(bignum b, int base) +Converts @code{b} into a string representation using the given base, +which is an integer between 2 and 36, inclusive. +@item int bignum_to_int(bignum b) +Converts @code{b} into a C @code{int}. If @code{b} does not fit into a +C @code{int}, the results are undefined. +@item unsigned int bignum_to_uint(bignum b) +Converts @code{b} into a C @code{unsigned int}. If @code{b} does not +fit into a C @code{unsigned int}, the results are undefined. +@item long bignum_to_long(bignum b) +Converts @code{b} into a C @code{long int}. If @code{b} does not fit +into a C @code{long int}, the results are undefined. +@item unsigned long bignum_to_ulong(bignum b) +Converts @code{b} into a C @code{unsigned long int}. If @code{b} does +not fit into a C @code{unsigned long int}, the results are undefined. +@item long long bignum_to_llong(bignum b) +Converts @code{b} into a C @code{long long int}. If @code{b} does not +fit into a C @code{long long int}, the results are undefined. +@item unsigned long long bignum_to_ullong(bignum b) +Converts @code{b} into a C @code{unsigned long long int}. If @code{b} +does not fit into a C @code{unsigned long long int}, the results are +undefined. +@item double bignum_to_double(bignum b) +Converts @code{b} into a C @code{double}. If @code{b} is too large to +represent as a C @code{double}, the results are implementation-specific. +Typically, the result is positive or negative infinity, for +implementations that can represent infinity. +@item void bignum_set(bignum b1, bignum b2) +Assigns the value of @code{b2} to the bignum @code{b1} by copying. +@item void bignum_set_string(bignum b, const char *s, int base) +Assigns @code{b} the value of the integer contained in string @code{s}, +which is a number in base @code{base}. +@item void bignum_set_long(bignum b, long l) +Assigns @code{b} the value of the long integer @code{l}. +@item void bignum_set_ulong(bignum b, unsigned long l) +Assigns @code{b} the value of the unsigned long integer @code{l}. +@item void bignum_set_llong(bignum b, long long l) +Assigns @code{b} the value of the long long integer @code{l}. +@item void bignum_set_ullong(bignum b, unsigned long long l) +Assigns @code{b} the value of the unsigned long long integer @code{l}. +@item void bignum_set_double(bignum b, double d) +Assigns @code{b} to the truncated value of @code{d}; i.e, the fractional +part of @code{d} is dropped. +@item void bignum_set_ratio(bignum b, ratio r) +Assigns @code{b} to the truncated value of @code{r}; i.e., the +non-integer part of @code{r} is dropped. This function exists only if +the driver supports ratios. +@item void bignum_set_bigfloat(bignum b, bigfloat f) +Assigns @code{b} to the truncated value of @code{f}; i.e., the +fractional part of @code{f} is dropped. This function exists only if +the driver supports bigfloats. +@item int bignum_cmp(bignum b1, bignum b2) +Returns a positive value, zero, or a negative value as @code{b1} is +greater than, equal to, or less than @code{b2}, respectively. +@item int bignum_lt(bignum b1, bignum b2) +Returns nonzero if @code{b1} is less than @code{b2}, zero otherwise. +@item int bignum_le(bignum b1, bignum b2) +Returns nonzero if @code{b1} is less than or equal to @code{b2}, zero +otherwise. +@item int bignum_eql(bignum b1, bignum b2) +Returns nonzero if @code{b1} is equal to @code{b2}, zero otherwise. +@item int bignum_ge(bignum b1, bignum b2) +Returns nonzero if @code{b1} is greater than or equal to @code{b2}, zero +otherwise. +@item int bignum_gt(bignum b1, bignum b2) +Returns nonzero if @code{b1} is greater than @code{b2}, zero otherwise. +@item void bignum_neg(bignum b, bignum b2) +Sets @code{b} to the negation of @code{b2}. +@item void bignum_abs(bignum b, bignum b2) +Sets @code{b} to the absolute value of @code{b2}. +@item void bignum_add(bignum b, bignum b1, bignum b2) +Sets @code{b} to the sum of @code{b1} and @code{b2}. +@item void bignum_sub(bignum b, bignum b1, bignum b2) +Sets @code{b} to the value of @code{b1} minus @code{b2}. +@item void bignum_mul(bignum b, bignum b1, bignum b2) +Sets @code{b} to the product of @code{b1} and @code{b2}. +@item int bignum_divisible_p(bignum b1, bignum b2) +Returns nonzero if @code{b1} is evenly divisible by @code{b2}. +@item void bignum_div(bignum b, bignum b1, bignum b2) +Sets @code{b} to the truncated value of @code{b1} divided by @code{b2}. +That is, this function rounds toward zero. +@item void bignum_ceil(bignum b, bignum b1, bignum b2) +Sets @code{b} to the ceiling of @code{b1} divided by @code{b2}. That +is, ths function rounds toward positive infinity. +@item void bignum_floor(bignum b, bignum b1, bignum b2) +Sets @code{b} to the floor of @code{b1} divided by @code{b2}. That is, +ths function rounds toward negative infinity. +@item void bignum_mod(bignum b, bignum b1, bignum b2) +Sets @code{b} to @code{b1} mod @code{b2}; i.e., the remainder after +dividing @code{b1} by @code{b2}. The sign is ignored; @code{b} is +always nonnegative after this operation. +@item void bignum_pow(bignum res, bignum b, unsigned int pow) +Sets @code{res} to @code{b} to the @code{pow}th power. +@item void bignum_gcd(bignum res, bignum b1, bignum b2) +Sets @code{res} to the greatest common divisor of @code{b1} and +@code{b2}. +@item void bignum_lcm(bignum res, bignum b1, bignum b2) +Sets @code{res} to the least common multiple of @code{b1} and @code{b2}. +@item void bignum_and(bignum res, bignum b1, bignum b2) +Sets @code{res} to the bitwise AND of @code{b1} and @code{b2}. +@item void bignum_ior(bignum res, bignum b1, bignum b2) +Sets @code{res} to the bitwise inclusive OR of @code{b1} and @code{b2}. +@item void bignum_xor(bignum res, bignum b1, bignum b2) +Sets @code{res} to the bitwise exclusive OR of @code{b1} and @code{b2}. +@item void bignum_not(bignum res, bignum b) +Sets @code{res} to the bitwise NOT of @code{b}. +@item void bignum_setbit(bignum b, unsigned int bit) +Sets the @code{bit}th bit of @code{b} to one, where the zeroth bit is +the least significant. +@item void bignum_clrbit(bignum b, unsigned int bit) +Clears the @code{bit}th bit of @code{b} (i.e., sets it to zero), where +the zeroth bit is the least significant. +@item int bignum_testbit(bignum b, unsigned int bit) +Returns the @code{bit}th bit of @code{b}, where the zeroth bit is the +least significant. +@item void bignum_lshift(bignum res, bignum b, unsigned int bits) +Sets @code{res} to the value of @code{b} shifted left by @code{bits} +bits. +@item void bignum_rshift(bignum res, bignum b, unsigned int bits) +Sets @code{res} to the value of @code{b} shifted right by @code{bits} +bits. +@item void bignum_random_seed(unsigned int seed) +If the implementing library has its own pseudorandom number generator, +then this function seeds the generator. If there is no generator, this +function is a no-op. +@item void bignum_random(bignum res, bignum limit) +Sets @code{res} to a random number between zero (inclusive) and +@code{limit} (exclusive). +@end itemize + +@node Ratio interface, Bigfloat interface, Bignum interface, Numeric driver interface +@subsection Ratio interface +@cindex ratio interface + +Each ratio implementation defines @code{HAVE_RATIO} and an appropriate +ratio type. For example, the GMP driver uses this definition: + +@example +typedef mpq_t ratio; +@end example + +The following names are defined for each driver, either as real C +functions or as C preprocessor macros. +@itemize +@item void ratio_init(ratio r) +Does any necessary initialization before the ratio @code{r} can be +used. This function typically allocates memory for the ratio. +@item void ratio_fini(ratio r) +Cleans up any resources held by the ratio @code{r}, typically +deallocating the memory dedicated to that ratio. The object referred +to by @code{r} must not be accessed after this call returns. +@item unsigned int ratio_hashcode(ratio r) +Returns a hash code for the ratio, suitable for use in XEmacs hash +tables. +@item int ratio_sign(ratio r) +Returns a positive value, zero, or a negative value to indicate that +@code{r} is positive, zero, or negative, respectively. +@item bignum ratio_numerator(ratio r) +Returns the numerator of @code{r}. +@item bignum ratio_denominator(ratio r) +Returns the denominator of @code{r}. +@item void ratio_canonicalize(ratio r) +Removes any common factors from the numerator and denominator of +@code{r}. +@item void ratio_to_string(ratio r, int base) +Converts @code{r} into a string representation using the given base, +which is an integer between 2 and 36, inclusive. +@item int ratio_to_int(ratio r) +Converts @code{r} into a C @code{int} by truncating the ratio. If the +truncation of @code{r} does not fit into a C @code{int}, the results are +undefined. +@item unsigned int ratio_to_uint(ratio r) +Converts @code{r} into a C @code{unsigned int} by truncating the ratio. +If the truncation of @code{r} does not fit into a C @code{unsigned int}, +the results are undefined. +@item long ratio_to_long(ratio r) +Converts @code{r} into a C @code{long int} by truncating the ratio. If +the truncation of @code{r} does not fit into a C @code{long int}, the +results are undefined. +@item unsigned long ratio_to_ulong(ratio r) +Converts @code{r} into a C @code{unsigned long int} by truncating the +ratio. If @code{r} does not fit into a C @code{unsigned long int}, the +results are undefined. +@item double ratio_to_double(ratio r) +Converts @code{r} into a C @code{double}. If @code{r} is too large to +represent as a C @code{double}, the results are implementation-specific. +Typically, the result is positive or negative infinity, for +implementations that can represent infinity. +@item void ratio_set(ratio r1, ratio r2) +Assigns the value of @code{r2} to the ratio @code{r1} by copying. +@item void ratio_set_string(ratio r, const char *s, int base) +Assigns @code{r} the value of the ratio contained in string @code{s}, +which is a pair of numbers in base @code{base} separated by a forward +slash. +@item void ratio_set_long(ratio r, long l) +Assigns @code{r} the value of the long integer @code{l}. +@item void ratio_set_ulong(ratio r, unsigned long l) +Assigns @code{r} the value of the unsigned long integer @code{l}. +@item void ratio_set_double(ratio r, double d) +Assigns @code{r} to the exact value of @code{d}. There is no rounding. +@item void ratio_set_bignum(ratio r, bignum b) +Assigns @code{r} to the value of @code{b}; i.e., the denominator is set +to one. +@item void ratio_set_bigfloat(ratio b, bigfloat f) +Assigns @code{b} to the exact value of @code{f}. There is no rounding. +This function exists only if the driver supports bigfloats. +@item void ratio_set_long_ulong(ratio r, long num, unsigned long den) +Assigns @code{r} the canonicalized ratio resulting from the division of +@code{num} by @code{den}. +@item void ratio_set_ulong_ulong(ratio r, unsigned long num, unsigned long den) +Assigns @code{r} the canonicalized ratio resulting from the division of +@code{num} by @code{den}. +@item void ratio_set_bignum_bignum(ratio r, bignum num, bignum den) +Assigns @code{r} the canonicalized ratio resulting from the division of +@code{num} by @code{den}. +@item int ratio_cmp(ratio r1, ratio r2) +Returns a positive value, zero, or a negative value as @code{r1} is +greater than, equal to, or less than @code{r2}, respectively. +@item int ratio_lt(ratio r1, ratio r2) +Returns nonzero if @code{r1} is less than @code{r2}, zero otherwise. +@item int ratio_le(ratio r1, ratio r2) +Returns nonzero if @code{r1} is less than or equal to @code{r2}, zero +otherwise. +@item int ratio_eql(ratio r1, ratio r2) +Returns nonzero if @code{r1} is equal to @code{r2}, zero otherwise. +@item int ratio_ge(ratio r1, ratio r2) +Returns nonzero if @code{r1} is greater than or equal to @code{r2}, zero +otherwise. +@item int ratio_gt(ratio r1, ratio r2) +Returns nonzero if @code{r1} is greater than @code{r2}, zero otherwise. +@item void ratio_neg(ratio q, ratio q2) +Sets @code{q} to the negation of @code{q2}. +@item void ratio_abs(ratio q, ratio q2) +Sets @code{q} to the absolute value of @code{q2}. +@item void ratio_inv(ratio q, ratio q2) +Sets @code{q} to the inverse of @code{q2}. +@item void ratio_add(ratio res, ratio q1, ratio q2) +Sets @code{res} to the sum of @code{q1} and @code{q2}. +@item void ratio_sub(ratio res, ratio q1, ratio q2) +Sets @code{res} to the value of @code{q1} minus @code{q2}. +@item void ratio_mul(ratio res, ratio q1, ratio q2) +Sets @code{res} to the product of @code{q1} and @code{q2}. +@item void ratio_div(ratio res, ratio q1, ratio q2) +Sets @code{res} to the value of @code{q1} divided by @code{q2}. +@end itemize + +@node Bigfloat interface, , Ratio interface, Numeric driver interface +@subsection Bigfloat interface +@cindex bigfloat interface + +Each bigfloat implementation defines @code{HAVE_BIGFLOAT} and an +appropriate bigfloat type. For example, the GMP driver uses this +definition: + +@example +typedef mpf_t bigfloat; +@end example + +The following names are defined for each driver, either as real C +functions or as C preprocessor macros. +@itemize +@item void bigfloat_init(bigfloat f) +Does any necessary initialization before the bigfloat @code{f} can be +used. This function typically allocates memory for the bigfloat. +@item void bigfloat_init_prec(bigfloat f, unsigned int prec) +Like @code{bigfloat_init}, but also sets the precision of @code{f} to +@emph{at least} @code{prec} bits. +@item void bigfloat_fini(bigfloat f) +Cleans up any resources held by the bigfloat @code{f}, typically +deallocating the memory dedicated to that bigfloat. The object referred +to by @code{f} must not be accessed after this call returns. +@item unsigned int bigfloat_hashcode(bigfloat f) +Returns a hash code for the bigfloat, suitable for use in XEmacs hash +tables. +@item int bigfloat_sign(bigfloat f) +Returns a positive value, zero, or a negative value to indicate that +@code{f} is positive, zero, or negative, respectively. +@item unsigned int bigfloat_get_prec(bigfloat f) +Returns the precision of @code{f} in bits. +@item void bigfloat_set_prec(bigfloat f, unsigned int prec) +Sets the precision of @code{f} to @emph{at least} @code{prec} bits. +@item void bigfloat_set_default_prec(unsigned int prec) +Sets the default precision of newly created bigfloats. +@item unsigned int bigfloat_get_default_prec(void) +Gets the default precision of newly created bigfloats. +@item void bigfloat_to_string(bigfloat f, int base) +Converts @code{f} into a string representation using the given base, +which is an integer between 2 and 36, inclusive. +@item int bigfloat_to_int(bigfloat f) +Converts @code{f} into a C @code{int} by truncating the bigfloat. If the +truncation of @code{f} does not fit into a C @code{int}, the results are +undefined. +@item unsigned int bigfloat_to_uint(bigfloat f) +Converts @code{f} into a C @code{unsigned int} by truncating the bigfloat. +If the truncation of @code{f} does not fit into a C @code{unsigned int}, +the results are undefined. +@item long bigfloat_to_long(bigfloat f) +Converts @code{f} into a C @code{long int} by truncating the bigfloat. If +the truncation of @code{f} does not fit into a C @code{long int}, the +results are undefined. +@item unsigned long bigfloat_to_ulong(bigfloat f) +Converts @code{f} into a C @code{unsigned long int} by truncating the +bigfloat. If @code{f} does not fit into a C @code{unsigned long int}, the +results are undefined. +@item double bigfloat_to_double(bigfloat f) +Converts @code{f} into a C @code{double}. If @code{f} is too large to +represent as a C @code{double}, the results are implementation-specific. +Typically, the result is positive or negative infinity, for +implementations that can represent infinity. +@item void bigfloat_set(bigfloat f1, bigfloat f2) +Assigns the value of @code{f2} to the bigfloat @code{f1} by copying. +@item void bigfloat_set_string(bigfloat f, const char *s, int base) +Assigns @code{f} the value of the bigfloat contained in string @code{s}. +@item void bigfloat_set_long(bigfloat f, long l) +Assigns @code{f} the value of the long integer @code{l}. +@item void bigfloat_set_ulong(bigfloat f, unsigned long l) +Assigns @code{f} the value of the unsigned long integer @code{l}. +@item void bigfloat_set_double(bigfloat f, double d) +Assigns @code{f} the value of @code{d}. +@item void bigfloat_set_bignum(bigfloat f, bignum b) +Assigns @code{f} to the value of @code{b}. +@item void bigfloat_set_ratio(bigfloat b, ratio r) +Assigns @code{b} to the result of dividing the numerator of @code{r} by +its denominator. +@item int bigfloat_cmp(bigfloat f1, bigfloat f2) +Returns a positive value, zero, or a negative value as @code{f1} is +greater than, equal to, or less than @code{f2}, respectively. +@item int bigfloat_lt(bigfloat f1, bigfloat f2) +Returns nonzero if @code{f1} is less than @code{f2}, zero otherwise. +@item int bigfloat_le(bigfloat f1, bigfloat f2) +Returns nonzero if @code{f1} is less than or equal to @code{f2}, zero +otherwise. +@item int bigfloat_eql(bigfloat f1, bigfloat f2) +Returns nonzero if @code{f1} is equal to @code{f2}, zero otherwise. +@item int bigfloat_ge(bigfloat f1, bigfloat f2) +Returns nonzero if @code{f1} is greater than or equal to @code{f2}, zero +otherwise. +@item int bigfloat_gt(bigfloat f1, bigfloat f2) +Returns nonzero if @code{f1} is greater than @code{f2}, zero otherwise. +@item void bigfloat_neg(bigfloat f, bigfloat f2) +Sets @code{f} to the negation of @code{f2}. +@item void bigfloat_abs(bigfloat f, bigfloat f2) +Sets @code{f} to the absolute value of @code{f2}. +@item void bigfloat_add(bigfloat res, bigfloat f1, bigfloat f2) +Sets @code{res} to the sum of @code{f1} and @code{f2}. +@item void bigfloat_sub(bigfloat res, bigfloat f1, bigfloat f2) +Sets @code{res} to the value of @code{f1} minus @code{f2}. +@item void bigfloat_mul(bigfloat res, bigfloat f1, bigfloat f2) +Sets @code{res} to the product of @code{f1} and @code{f2}. +@item void bigfloat_div(bigfloat res, bigfloat f1, bigfloat f2) +Sets @code{res} to the value of @code{f1} divided by @code{f2}. +@item void bigfloat_ceil(bigfloat res, bigfloat f) +Sets @code{res} to the ceiling of @code{f}. +@item void bigfloat_floor(bigfloat res, bigfloat f) +Sets @code{res} to the floor of @code{f}. +@item void bigfloat_trunc(bigfloat res, bigfloat f) +Sets @code{res} to the truncation of @code{f}. +@item void bigfloat_sqrt(bigfloat res, bigfloat f) +Sets @code{res} to the square root of @code{f}. +@item void bigfloat_pow(bigfloat res, bigfloat f, unsigned int exp) +Sets @code{res} to the value of @code{f} raised to the @code{exp}th power. +@end itemize + +@node Low-Level Allocation, The XEmacs Object System (Abstractly Speaking), Numeric Types, Top @chapter Low-Level Allocation @cindex low-level allocation @cindex allocation, low-level @@ -21337,7 +21896,7 @@ @node Ben's separate stderr notes, , Subprocesses, Subprocesses -@subsection Ben's separate stderr notes (probably obsolete) +@section Ben's separate stderr notes (probably obsolete) This node contains some notes that Ben kept on his separate subprocess workspace. These notes probably describe changes and features that have
--- a/man/lispref/edebug-inc.texi Wed Jul 10 14:14:30 2013 +0100 +++ b/man/lispref/edebug-inc.texi Wed Jul 10 14:32:02 2013 +0100 @@ -1103,7 +1103,7 @@ Here is a table of the possibilities for @var{specification} and how each directs processing of arguments. -@table @bullet +@table @asis @item @code{t} All arguments are instrumented for evaluation.
--- a/man/lispref/numbers.texi Wed Jul 10 14:14:30 2013 +0100 +++ b/man/lispref/numbers.texi Wed Jul 10 14:32:02 2013 +0100 @@ -320,28 +320,29 @@ numbers is limited only by the amount of virtual memory (and time) you can throw at them. - As of 09 April 2004, support for the GNU Multiple Precision -arithmetic library (GMP) is nearly complete, and support for the BSD -Multiple Precision arithmetic library (MP) is being debugged. To enable -bignum support using GMP (respectively MP), invoke configure with your -usual options, and add @samp{--use-number-lib=gmp} (respectively -@samp{--use-number-lib=mp}). The default is to disable bignum support, -but if you are using a script to automate the build process, it may be -convenient to explicitly disable support by @emph{appending} -@samp{--use-number-lib=no} to your invocation of configure. GMP has an -MP compatibility mode, but it is not recommended, as there remain poorly -understood bugs (even more so than for other vendors' versions of MP). + XEmacs supports the GNU Multiple Precision arithmetic library (GMP), +the Multiple Precision Integers and Rationals library (MPIR), and the +BSD Multiple Precision arithmetic library (MP). To enable bignum +support using GMP, MPIR, or MP, invoke configure with your usual options +and add @samp{--use-number-lib=gmp}, @samp{--use-number-lib=mpir}, or +@samp{--use-number-lib=mp}, respectively. The default is to disable +bignum support, but if you are using a script to automate the build +process, it may be convenient to explicitly disable support by +@emph{appending} @samp{--use-number-lib=no} to your invocation of +configure. GMP has an MP compatibility mode, but it is not recommended, +as there remain poorly understood bugs (even more so than for other +vendors' versions of MP). - With GMP, exact arithmetic with integers and ratios of arbitrary -precision and approximate (``floating point'') arithmetic of arbitrary -precision are implemented efficiently in the library. (Note that -numerical implementations are quite delicate and sensitive to + With GMP and MPIR, exact arithmetic with integers and ratios of +arbitrary precision and approximate (``floating point'') arithmetic of +arbitrary precision are implemented efficiently in the library. (Note +that numerical implementations are quite delicate and sensitive to optimization. If the library was poorly optimized for your hardware, as is often the case with Linux distributions for 80x86, you may achieve gains of @emph{several orders of magnitude} by rebuilding the MP -library. See @uref{http://www.swox.com/gmp/gmp-speed.html}.) The MP -implementation provides arbitrary precision integers. Ratios and arbitrary -precision floats are not available with MP. +library. See @uref{http://gmplib.org/gmpbench.html}.) The MP +implementation provides arbitrary precision integers. Ratios and +arbitrary precision floats are not available with MP. If your code needs to run correctly whether or not the feature is provided, you may test for the features @code{bignum}, @code{ratio}, and @@ -363,14 +364,6 @@ are bigfloat, and bigfloats are only coerced to other numerical types by explicit calls to the function @code{coerce}. - Bignum support is incomplete. If you would like to help with bignum -support, especially on BSD MP, please subscribe to the -@uref{http://www.xemacs.org/Lists/#xemacs-beta, XEmacs Beta mailing -list}, and book up on @file{number-gmp.h} and @file{number-mp.h}. Jerry -has promised to write internals documentation eventually, but if your -skills run more to analysis and documentation than to writing new code, -feel free to fill in the gap! - @menu * Bignum Basics:: Representation and range of integers. * Ratio Basics:: Representation and range of rational numbers. @@ -385,9 +378,9 @@ In most cases, bignum support should be transparent to users and Lisp programmers. A bignum-enabled XEmacs will automatically convert from -fixnums to bignums and back in pure integer arithmetic, and for GNU MP, -from floats to bigfloats. (Bigfloats must be explicitly coerced to -other types, even if they are exactly representable by less precise +fixnums to bignums and back in pure integer arithmetic, and for GMP and +MPIR, from floats to bigfloats. (Bigfloats must be explicitly coerced +to other types, even if they are exactly representable by less precise types.) The Lisp reader and printer have been enhanced to handle bignums, as have the mathematical functions. Rationals (fixnums, bignums, and ratios) are printed using the @samp{%d}, @samp{%o}, @@ -397,7 +390,7 @@ @node Ratio Basics @subsection Ratio Basics -Ratios, when available have the read syntax and print representation +Ratios, when available, have the read syntax and print representation @samp{3/5}. Like other rationals (fixnums and bignums), they are printed using the @samp{%d}, @samp{%o}, @samp{%x}, and @samp{%u} format conversions. @@ -413,10 +406,36 @@ setting @code{default-float-precision} to a non-zero value. Precision is given in bits, with a maximum precision of @code{bigfloat-maximum-precision}. -@c #### is this true? -Bigfloats are created automatically when a number with yes + +@example +(let* ((float1 (string-to-number "9999999999999999.99999999999999999999")) + (default-float-precision 256) + (float2 (string-to-number "9999999999999999.99999999999999999999"))) + (+ (if (bigfloatp float1) 1 0) + (if (bigfloatp float2) 2 0))) + @result{} 2 +@end example +@example +(let* ((float1 (float 999999999999999999999999999999999999999999999999999999)) + (default-float-precision 256) + (float2 (float 999999999999999999999999999999999999999999999999999999))) + (princ float1) + (terpri) + (princ float2) + (terpri)) + @result{} 9.999999999999999e+53 +9.99999999999999999999999999999999999999999999999999999E53 +t +@end example +Explicit type coercion is also available, although then the precision of +the bigfloat is no greater than the source type. + +@example +(coerce 999999999999999 'bigfloat) + @result{} 9.99999999999999E14 +@end example @node Canonicalization and Contagion @subsection Canonicalization and Contagion
--- a/man/lispref/packaging.texi Wed Jul 10 14:14:30 2013 +0100 +++ b/man/lispref/packaging.texi Wed Jul 10 14:32:02 2013 +0100 @@ -524,7 +524,7 @@ @item GNU make (3.79 or later preferred). @item makeinfo -(4.2 from texinfo-4.2) +(4.12 from texinfo-4.12) @item GNU tar (or equivalent). @item GNU gzip @@ -600,7 +600,7 @@ Does most of the work. Builds the elcs, infos at a minimum. @end table -@subsection The targets that most people would be interested in would be: +@section The targets that most people would be interested in would be: @itemize @bullet @item @code{all}
--- a/man/texinfo.tex Wed Jul 10 14:14:30 2013 +0100 +++ b/man/texinfo.tex Wed Jul 10 14:32:02 2013 +0100 @@ -1,13 +1,13 @@ % 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{2008-04-18.10} -% -% Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, +\def\texinfoversion{2013-03-19.11} +% +% Copyright 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, % 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, -% 2007, 2008 Free Software Foundation, Inc. +% 2007, 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc. % % This texinfo.tex file is free software: you can redistribute it and/or % modify it under the terms of the GNU General Public License as @@ -24,13 +24,14 @@ % % 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.) +% restriction. This Exception is an additional permission under section 7 +% of the GNU General Public License, version 3 ("GPLv3"). % % Please try the latest version of texinfo.tex before submitting bug % reports; you can get the latest version from: -% http://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). +% http://ftp.gnu.org/gnu/texinfo/ (the Texinfo release area), or +% http://ftpmirror.gnu.org/texinfo/ (same, via a mirror), or +% http://www.gnu.org/software/texinfo/ (the Texinfo home page) % The texinfo.tex in any given distribution could well be out % of date, so if that's what you're using, please check. % @@ -65,7 +66,6 @@ \everyjob{\message{[Texinfo version \texinfoversion]}% \catcode`+=\active \catcode`\_=\active} - \chardef\other=12 % We never want plain's \outer definition of \+ in Texinfo. @@ -93,11 +93,13 @@ \let\ptexnewwrite\newwrite \let\ptexnoindent=\noindent \let\ptexplus=+ +\let\ptexraggedright=\raggedright \let\ptexrbrace=\} \let\ptexslash=\/ \let\ptexstar=\* \let\ptext=\t \let\ptextop=\top +{\catcode`\'=\active \global\let\ptexquoteright'}% active in plain's math mode % If this character appears in an error message or help string, it % starts a new line in the output. @@ -115,10 +117,11 @@ % Set up fixed words for English if not already set. \ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi \ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi +\ifx\putworderror\undefined \gdef\putworderror{error}\fi \ifx\putwordfile\undefined \gdef\putwordfile{file}\fi \ifx\putwordin\undefined \gdef\putwordin{in}\fi -\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi -\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi +\ifx\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 @@ -157,15 +160,18 @@ \def\spaceisspace{\catcode`\ =\spacecat} % sometimes characters are active, so we need control sequences. +\chardef\ampChar = `\& \chardef\colonChar = `\: \chardef\commaChar = `\, \chardef\dashChar = `\- \chardef\dotChar = `\. \chardef\exclamChar= `\! +\chardef\hashChar = `\# \chardef\lquoteChar= `\` \chardef\questChar = `\? \chardef\rquoteChar= `\' \chardef\semiChar = `\; +\chardef\slashChar = `\/ \chardef\underChar = `\_ % Ignore a token. @@ -196,36 +202,7 @@ % 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 - }% - }% -} +\def\finalout{\overfullrule=0pt } % Sometimes it is convenient to have everything in the transcript file % and nothing on the terminal. We don't just call \tracingall here, @@ -243,7 +220,7 @@ \tracingmacros2 \tracingrestores1 \showboxbreadth\maxdimen \showboxdepth\maxdimen - \ifx\eTeXversion\undefined\else % etex gives us more logging + \ifx\eTeXversion\thisisundefined\else % etex gives us more logging \tracingscantokens1 \tracingifs1 \tracinggroups1 @@ -254,6 +231,13 @@ \errorcontextlines16 }% +% @errormsg{MSG}. Do the index-like expansions on MSG, but if things +% aren't perfect, it's not the end of the world, being an error message, +% after all. +% +\def\errormsg{\begingroup \indexnofonts \doerrormsg} +\def\doerrormsg#1{\errmessage{#1}} + % add check for \lastpenalty to plain's definitions. If the last thing % we did was a \nobreak, we don't want to insert more space. % @@ -264,7 +248,6 @@ \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 @@ -355,7 +338,7 @@ % We don't want .vr (or whatever) entries like this: % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}} % "\acronym" won't work when it's read back in; - % it needs to be + % it needs to be % {\code {{\tt \backslashcurfont }acronym} \shipout\vbox{% % Do this early so pdf references go to the beginning of the page. @@ -574,7 +557,7 @@ } \def\inenvironment#1{% \ifx#1\empty - out of any environment% + outside of any environment% \else in environment \expandafter\string#1% \fi @@ -586,7 +569,7 @@ \parseargdef\end{% \if 1\csname iscond.#1\endcsname \else - % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03 + % The general wording of \badenverr may not be ideal. \expandafter\checkenv\csname#1\endcsname \csname E#1\endcsname \endgroup @@ -596,85 +579,6 @@ \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/toc files. - \catcode`\{ = \other \catcode`\} = \other - \catcode`\[ = 1 \catcode`\] = 2 - \catcode`\! = 0 \catcode`\\ = \other - !gdef!lbracecmd[\{]% - !gdef!rbracecmd[\}]% - !gdef!lbraceatcmd[@{]% - !gdef!rbraceatcmd[@}]% -!endgroup - -% @comma{} to avoid , parsing problems. -\let\comma = , - -% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent -% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. -\let\, = \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 \ifmmode\imath \else\ptexi \fi - \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi - \else \errmessage{@dotless can be used only with i or j}% - \fi\fi -} - -% The \TeX{} logo, as in plain, but resetting the spacing so that a -% period following counts as ending a sentence. (Idea found in latex.) -% -\edef\TeX{\TeX \spacefactor=1000 } - -% @LaTeX{} logo. Not quite the same results as the definition in -% latex.ltx, since we use a different font for the raised A; it's most -% convenient for us to use an explicitly smaller font, rather than using -% the \scriptstyle font (since we don't reset \scriptstyle and -% \scriptscriptstyle). -% -\def\LaTeX{% - L\kern-.36em - {\setbox0=\hbox{T}% - \vbox to \ht0{\hbox{\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 @@ -691,7 +595,7 @@ \def\:{\spacefactor=1000 } % @* forces a line break. -\def\*{\hfil\break\hbox{}\ignorespaces} +\def\*{\unskip\hfil\break\hbox{}\ignorespaces} % @/ allows a line break. \let\/=\allowbreak @@ -706,7 +610,7 @@ \def\?{?\spacefactor=\endofsentencespacefactor\space} % @frenchspacing on|off says whether to put extra space after punctuation. -% +% \def\onword{on} \def\offword{off} % @@ -716,7 +620,7 @@ \else\ifx\temp\offword \plainnonfrenchspacing \else \errhelp = \EMsimple - \errmessage{Unknown @frenchspacing option `\temp', must be on/off}% + \errmessage{Unknown @frenchspacing option `\temp', must be on|off}% \fi\fi } @@ -798,15 +702,6 @@ \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. @@ -870,7 +765,7 @@ % @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'. +% class. WHICH is `l' or `r'. Not documented, written for gawk manual. % \newskip\inmarginspacing \inmarginspacing=1cm \def\strutdepth{\dp\strutbox} @@ -917,6 +812,36 @@ \temp } +% @| inserts a changebar to the left of the current line. It should +% surround any changed text. This approach does *not* work if the +% change spans more than two lines of output. To handle that, we would +% have adopt a much more difficult approach (putting marks into the main +% vertical list for the beginning and end of each change). This command +% is not documented, not supported, and doesn't work. +% +\def\|{% + % \vadjust can only be used in horizontal mode. + \leavevmode + % + % Append this vertical mode material after the current line in the output. + \vadjust{% + % We want to insert a rule with the height and depth of the current + % leading; that is exactly what \strutbox is supposed to record. + \vskip-\baselineskip + % + % \vadjust-items are inserted at the left edge of the type. So + % the \llap here moves out into the left-hand margin. + \llap{% + % + % For a thicker or thinner bar, change the `1pt'. + \vrule height\baselineskip width1pt + % + % This is the space between the bar and the text. + \hskip 12pt + }% + }% +} + % @include FILE -- \input text of FILE. % \def\include{\parseargusing\filenamecatcodes\includezzz} @@ -926,6 +851,8 @@ {% \makevalueexpandable % we want to expand any @value in FILE. \turnoffactive % and allow special characters in the expansion + \indexnofonts % Allow `@@' and other weird things in file names. + \wlog{texinfo.tex: doing @include of #1^^J}% \edef\temp{\noexpand\input #1 }% % % This trickery is to read FILE outside of a group, in case it makes @@ -944,6 +871,8 @@ \catcode`>=\other \catcode`+=\other \catcode`-=\other + \catcode`\`=\other + \catcode`\'=\other } \def\pushthisfilestack{% @@ -959,7 +888,7 @@ \def\popthisfilestack{\errthisfilestackempty} \def\errthisfilestackempty{\errmessage{Internal error: the stack of filenames is empty.}} - +% \def\thisfile{} % @center line @@ -967,36 +896,46 @@ % \parseargdef\center{% \ifhmode - \let\next\centerH + \let\centersub\centerH \else - \let\next\centerV + \let\centersub\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}} + \centersub{\hfil \ignorespaces#1\unskip \hfil}% + \let\centersub\relax % don't let the definition persist, just in case +} +\def\centerH#1{{% + \hfil\break + \advance\hsize by -\leftskip + \advance\hsize by -\rightskip + \line{#1}% + \break +}} +% +\newcount\centerpenalty +\def\centerV#1{% + % The idea here is the same as in \startdefun, \cartouche, etc.: if + % @center is the first thing after a section heading, we need to wipe + % out the negative parskip inserted by \sectionheading, but still + % prevent a page break here. + \centerpenalty = \lastpenalty + \ifnum\centerpenalty>10000 \vskip\parskip \fi + \ifnum\centerpenalty>9999 \penalty\centerpenalty \fi + \line{\kern\leftskip #1\kern\rightskip}% +} % @sp n outputs n lines of vertical space - +% \parseargdef\sp{\vskip #1\baselineskip} % @comment ...line which is ignored... % @c is the same as @comment % @ignore ... @end ignore is another way to write a comment - +% \def\comment{\begingroup \catcode`\^^M=\other% \catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% \commentxxx} {\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} - +% \let\c=\comment % @paragraphindent NCHARS @@ -1089,107 +1028,6 @@ } -% @asis just yields its argument. Used with @table, for example. -% -\def\asis#1{#1} - -% @math outputs its argument in math mode. -% -% One complication: _ usually means subscripts, but it could also mean -% an actual _ character, as in @math{@var{some_variable} + 1}. So make -% _ active, and distinguish by seeing if the current family is \slfam, -% which is what @var uses. -{ - \catcode`\_ = \active - \gdef\mathunderscore{% - \catcode`\_=\active - \def_{\ifnum\fam=\slfam \_\else\sb\fi}% - } -} -% Another complication: we want \\ (and @\) to output a \ 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 - % make the texinfo accent commands work in math mode - \let\"=\ddot - \let\'=\acute - \let\==\bar - \let\^=\hat - \let\`=\grave - \let\u=\breve - \let\v=\check - \let\~=\tilde - \let\dotaccent=\dot - $\finishmath -} -\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. - -% Some active characters (such as <) are spaced differently in math. -% We have to reset their definitions in case the @math was an argument -% to a command which sets the catcodes (such as @item or @section). -% -{ - \catcode`^ = \active - \catcode`< = \active - \catcode`> = \active - \catcode`+ = \active - \gdef\mathactive{% - \let^ = \ptexhat - \let< = \ptexless - \let> = \ptexgtr - \let+ = \ptexplus - } -} - -% Some math mode symbols. -\def\bullet{$\ptexbullet$} -\def\geq{\ifmmode \ge\else $\ge$\fi} -\def\leq{\ifmmode \le\else $\le$\fi} -\def\minus{\ifmmode -\else $-$\fi} - -% @dots{} outputs an ellipsis using the current font. -% We do .5em per period so that it has the same spacing in the cm -% typewriter fonts as three actual period characters; on the other hand, -% in other typewriter fonts three periods are wider than 1.5em. So do -% whichever is larger. -% -\def\dots{% - \leavevmode - \setbox0=\hbox{...}% get width of three periods - \ifdim\wd0 > 1.5em - \dimen0 = \wd0 - \else - \dimen0 = 1.5em - \fi - \hbox to \dimen0{% - \hskip 0pt plus.25fil - .\hskip 0pt plus1fil - .\hskip 0pt plus1fil - .\hskip 0pt plus.5fil - }% -} - -% @enddots{} is an end-of-sentence ellipsis. -% -\def\enddots{% - \dots - \spacefactor=\endofsentencespacefactor -} - -% @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 @@ -1254,9 +1092,8 @@ \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 +% can be set). So we test for \relax and 0 as well as being undefined. +\ifx\pdfoutput\thisisundefined \else \ifx\pdfoutput\relax \else @@ -1271,50 +1108,24 @@ % for display in the outlines, and in other places. Thus, we have to % double any backslashes. Otherwise, a name like "\node" will be % interpreted as a newline (\n), followed by o, d, e. Not good. -% http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html -% (and related messages, the final outcome is that it is up to the TeX -% user to double the backslashes and otherwise make the string valid, so -% that's what we do). - -% double active backslashes. % -{\catcode`\@=0 \catcode`\\=\active - @gdef@activebackslashdouble{% - @catcode`@\=@active - @let\=@doublebackslash} -} - -% To handle parens, we must adopt a different approach, since parens are -% not active characters. hyperref.dtx (which has the same problem as -% us) handles it with this amazing macro to replace tokens, with minor -% changes for Texinfo. It is included here under the GPL by permission -% from the author, Heiko Oberdiek. -% -% #1 is the tokens to replace. -% #2 is the replacement. -% #3 is the control sequence with the string. -% -\def\HyPsdSubst#1#2#3{% - \def\HyPsdReplace##1#1##2\END{% - ##1% - \ifx\\##2\\% - \else - #2% - \HyReturnAfterFi{% - \HyPsdReplace##2\END - }% - \fi - }% - \xdef#3{\expandafter\HyPsdReplace#3#1\END}% -} -\long\def\HyReturnAfterFi#1\fi{\fi#1} - -% #1 is a control sequence in which to do the replacements. -\def\backslashparens#1{% - \xdef#1{#1}% redefine it as its expansion; the definition is simply - % \lastnode when called from \setref -> \pdfmkdest. - \HyPsdSubst{(}{\realbackslash(}{#1}% - \HyPsdSubst{)}{\realbackslash)}{#1}% +% See http://www.ntg.nl/pipermail/ntg-pdftex/2004-July/000654.html and +% related messages. The final outcome is that it is up to the TeX user +% to double the backslashes and otherwise make the string valid, so +% that's what we do. pdftex 1.30.0 (ca.2005) introduced a primitive to +% do this reliably, so we use it. + +% #1 is a control sequence in which to do the replacements, +% which we \xdef. +\def\txiescapepdf#1{% + \ifx\pdfescapestring\thisisundefined + % No primitive available; should we give a warning or log? + % Many times it won't matter. + \else + % The expandable \pdfescapestring primitive escapes parentheses, + % backslashes, and other special chars. + \xdef#1{\pdfescapestring{#1}}% + \fi } \newhelp\nopdfimagehelp{Texinfo supports .png, .jpg, .jpeg, and .pdf images @@ -1324,11 +1135,17 @@ \ifpdf % - % Color manipulation macros based on pdfcolor.tex. - \def\cmykDarkRed{0.28 1 1 0.35} - \def\cmykBlack{0 0 0 1} - % - \def\pdfsetcolor#1{\pdfliteral{#1 k}} + % Color manipulation macros based on pdfcolor.tex, + % except using rgb instead of cmyk; the latter is said to render as a + % very dark gray on-screen and a very dark halftone in print, instead + % of actual black. + \def\rgbDarkRed{0.50 0.09 0.12} + \def\rgbBlack{0 0 0} + % + % k sets the color for filling (usual text, etc.); + % K sets the color for stroking (thin rules, e.g., normal _'s). + \def\pdfsetcolor#1{\pdfliteral{#1 rg #1 RG}} + % % Set color, and create a mark which defines \thiscolor accordingly, % so that \makeheadline knows which color to restore. \def\setcolor#1{% @@ -1337,7 +1154,7 @@ \pdfsetcolor{#1}% } % - \def\maincolor{\cmykBlack} + \def\maincolor{\rgbBlack} \pdfsetcolor{\maincolor} \edef\thiscolor{\maincolor} \def\lastcolordefs{} @@ -1367,32 +1184,34 @@ % % #1 is image name, #2 width (might be empty/whitespace), #3 height (ditto). \def\dopdfimage#1#2#3{% - \def\imagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}% - \def\imageheight{#3}\setbox2 = \hbox{\ignorespaces #3}% + \def\pdfimagewidth{#2}\setbox0 = \hbox{\ignorespaces #2}% + \def\pdfimageheight{#3}\setbox2 = \hbox{\ignorespaces #3}% % - % pdftex (and the PDF format) support .png, .jpg, .pdf (among - % others). Let's try in that order. + % pdftex (and the PDF format) support .pdf, .png, .jpg (among + % others). Let's try in that order, PDF first since if + % someone has a scalable image, presumably better to use that than a + % bitmap. \let\pdfimgext=\empty \begingroup - \openin 1 #1.png \ifeof 1 - \openin 1 #1.jpg \ifeof 1 - \openin 1 #1.jpeg \ifeof 1 - \openin 1 #1.JPG \ifeof 1 - \openin 1 #1.pdf \ifeof 1 - \openin 1 #1.PDF \ifeof 1 + \openin 1 #1.pdf \ifeof 1 + \openin 1 #1.PDF \ifeof 1 + \openin 1 #1.png \ifeof 1 + \openin 1 #1.jpg \ifeof 1 + \openin 1 #1.jpeg \ifeof 1 + \openin 1 #1.JPG \ifeof 1 \errhelp = \nopdfimagehelp \errmessage{Could not find image file #1 for pdf}% - \else \gdef\pdfimgext{PDF}% + \else \gdef\pdfimgext{JPG}% \fi - \else \gdef\pdfimgext{pdf}% + \else \gdef\pdfimgext{jpeg}% \fi - \else \gdef\pdfimgext{JPG}% + \else \gdef\pdfimgext{jpg}% \fi - \else \gdef\pdfimgext{jpeg}% + \else \gdef\pdfimgext{png}% \fi - \else \gdef\pdfimgext{jpg}% + \else \gdef\pdfimgext{PDF}% \fi - \else \gdef\pdfimgext{png}% + \else \gdef\pdfimgext{pdf}% \fi \closein 1 \endgroup @@ -1404,8 +1223,8 @@ \else \immediate\pdfximage \fi - \ifdim \wd0 >0pt width \imagewidth \fi - \ifdim \wd2 >0pt height \imageheight \fi + \ifdim \wd0 >0pt width \pdfimagewidth \fi + \ifdim \wd2 >0pt height \pdfimageheight \fi \ifnum\pdftexversion<13 #1.\pdfimgext \else @@ -1420,10 +1239,9 @@ % such as \, aren't expanded when present in a section title. \indexnofonts \turnoffactive - \activebackslashdouble \makevalueexpandable \def\pdfdestname{#1}% - \backslashparens\pdfdestname + \txiescapepdf\pdfdestname \safewhatsit{\pdfdest name{\pdfdestname} xyz}% }} % @@ -1432,8 +1250,8 @@ % % by default, use a color that is dark enough to print on paper as % nearly black, but still distinguishable for online viewing. - \def\urlcolor{\cmykDarkRed} - \def\linkcolor{\cmykDarkRed} + \def\urlcolor{\rgbDarkRed} + \def\linkcolor{\rgbDarkRed} \def\endlink{\setcolor{\maincolor}\pdfendlink} % % Adding outlines to PDF; macros for calculating structure of outlines @@ -1455,29 +1273,24 @@ % page number. We could generate a destination for the section % text in the case where a section has no node, but it doesn't % seem worth the trouble, since most documents are normally structured. - \def\pdfoutlinedest{#3}% + \edef\pdfoutlinedest{#3}% \ifx\pdfoutlinedest\empty \def\pdfoutlinedest{#4}% \else - % Doubled backslashes in the name. - {\activebackslashdouble \xdef\pdfoutlinedest{#3}% - \backslashparens\pdfoutlinedest}% + \txiescapepdf\pdfoutlinedest \fi % - % Also double the backslashes in the display string. - {\activebackslashdouble \xdef\pdfoutlinetext{#1}% - \backslashparens\pdfoutlinetext}% + % Also escape PDF chars in the display string. + \edef\pdfoutlinetext{#1}% + \txiescapepdf\pdfoutlinetext % \pdfoutline goto name{\pdfmkpgn{\pdfoutlinedest}}#2{\pdfoutlinetext}% } % \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\partentry##1##2##3##4{}% ignore parts in the outlines \def\numchapentry##1##2##3##4{% \def\thischapnum{##2}% \def\thissecnum{0}% @@ -1531,25 +1344,41 @@ % 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. + % TODO this right, we have to translate 8-bit characters to + % their "best" equivalent, based on the @documentencoding. Too + % much work for too little return. Just use the ASCII equivalents + % we use for the index sort strings. + % \indexnofonts \setupdatafile + % We can have normal brace characters in the PDF outlines, unlike + % Texinfo index files. So set that up. + \def\{{\lbracecharliteral}% + \def\}{\rbracecharliteral}% \catcode`\\=\active \otherbackslash \input \tocreadfilename \endgroup } + {\catcode`[=1 \catcode`]=2 + \catcode`{=\other \catcode`}=\other + \gdef\lbracecharliteral[{]% + \gdef\rbracecharliteral[}]% + ] % \def\skipspaces#1{\def\PP{#1}\def\D{|}% \ifx\PP\D\let\nextsp\relax \else\let\nextsp\skipspaces - \ifx\p\space\else\addtokens{\filename}{\PP}% - \advance\filenamelength by 1 - \fi + \addtokens{\filename}{\PP}% + \advance\filenamelength by 1 \fi \nextsp} - \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} + \def\getfilename#1{% + \filenamelength=0 + % If we don't expand the argument now, \skipspaces will get + % snagged on things like "@value{foo}". + \edef\temp{#1}% + \expandafter\skipspaces\temp|\relax + } \ifnum\pdftexversion < 14 \let \startlink \pdfannotlink \else @@ -1562,11 +1391,15 @@ % tried to figure out what each command should do in the context % of @url. for now, just make @/ a no-op, that's the only one % people have actually reported a problem with. - % + % \normalturnoffactive \def\@{@}% \let\/=\empty \makevalueexpandable + % do we want to go so far as to use \indexnofonts instead of just + % special-casing \var here? + \def\var##1{##1}% + % \leavevmode\setcolor{\urlcolor}% \startlink attr{/Border [0 0 0]}% user{/Subtype /Link /A << /S /URI /URI (#1) >>}% @@ -1597,6 +1430,7 @@ \setcolor{\linkcolor}#1\endlink} \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} \else + % non-pdf mode \let\pdfmkdest = \gobble \let\pdfurl = \gobble \let\endlink = \relax @@ -1627,6 +1461,10 @@ \def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf} \def\tt{\fam=\ttfam \setfontstyle{tt}} +% Unfortunately, we have to override this for titles and the like, since +% in those cases "rm" is bold. Sigh. +\def\rmisbold{\rm\def\curfontstyle{bf}} + % Texinfo sort of supports the sans serif font style, which plain TeX does not. % So we set up a \sf. \newfam\sffam @@ -1637,9 +1475,6 @@ \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. @@ -1651,6 +1486,7 @@ % can get a sort of poor man's double spacing by redefining this. \def\baselinefactor{1} % +\newdimen\textleading \def\setleading#1{% \dimen0 = #1\relax \normalbaselineskip = \baselinefactor\dimen0 @@ -1672,7 +1508,7 @@ % if we are producing pdf, and we have \pdffontattr, then define cmaps. % (\pdffontattr was introduced many years ago, but people still run % older pdftex's; it's easy to conditionalize, so we do.) -\ifpdf \ifx\pdffontattr\undefined \else +\ifpdf \ifx\pdffontattr\thisisundefined \else \begingroup \catcode`\^^M=\active \def^^M{^^J}% Output line endings as the ^^J char. \catcode`\%=12 \immediate\pdfobj stream {%!PS-Adobe-3.0 Resource-CMap @@ -1923,28 +1759,34 @@ \fi\fi -% Set the font macro #1 to the font named #2, adding on the -% specified font prefix (normally `cm'). +% Set the font macro #1 to the font named \fontprefix#2. % #3 is the font's design size, #4 is a scale factor, #5 is the CMap -% encoding (currently only OT1, OT1IT and OT1TT are allowed, pass -% empty to omit). +% encoding (only OT1, OT1IT and OT1TT are allowed, or empty to omit). +% Example: +% #1 = \textrm +% #2 = \rmshape +% #3 = 10 +% #4 = \mainmagstep +% #5 = OT1 +% \def\setfont#1#2#3#4#5{% \font#1=\fontprefix#2#3 scaled #4 \csname cmap#5\endcsname#1% } % This is what gets called when #5 of \setfont is empty. \let\cmap\gobble -% emacs-page end of cmaps +% +% (end of cmaps) % Use cm as the default font prefix. % To specify the font prefix, you must define \fontprefix % before you read in texinfo.tex. -\ifx\fontprefix\undefined +\ifx\fontprefix\thisisundefined \def\fontprefix{cm} \fi % Support font families that don't use the same naming scheme as CM. \def\rmshape{r} -\def\rmbshape{bx} %where the normal face is bold +\def\rmbshape{bx} % where the normal face is bold \def\bfshape{b} \def\bxshape{bx} \def\ttshape{tt} @@ -1959,9 +1801,8 @@ \def\scshape{csc} \def\scbshape{csc} -% Definitions for a main text size of 11pt. This is the default in -% Texinfo. -% +% Definitions for a main text size of 11pt. (The default in Texinfo.) +% \def\definetextfontsizexi{% % Text fonts (11.2pt, magstep1). \def\textnominalsize{11pt} @@ -2024,8 +1865,6 @@ \setfont\titlesc\scbshape{10}{\magstep4}{OT1} \font\titlei=cmmi12 scaled \magstep3 \font\titlesy=cmsy10 scaled \magstep4 -\def\authorrm{\secrm} -\def\authortt{\sectt} \def\titleecsize{2074} % Chapter (and unnumbered) fonts (17.28pt). @@ -2084,17 +1923,17 @@ \font\reducedsy=cmsy10 \def\reducedecsize{1000} -% reset the current fonts -\textfonts +\textleading = 13.2pt % line spacing for 11pt CM +\textfonts % reset the current fonts \rm -} % end of 11pt text font size definitions +} % end of 11pt text font size definitions, \definetextfontsizexi % Definitions to make the main text be 10pt Computer Modern, with % section, chapter, etc., sizes following suit. This is for the GNU % Press printing of the Emacs 22 manual. Maybe other manuals in the % future. Used with @smallbook, which sets the leading to 12pt. -% +% \def\definetextfontsizex{% % Text fonts (10pt). \def\textnominalsize{10pt} @@ -2157,8 +1996,6 @@ \setfont\titlesc\scbshape{10}{\magstep4}{OT1} \font\titlei=cmmi12 scaled \magstep3 \font\titlesy=cmsy10 scaled \magstep4 -\def\authorrm{\secrm} -\def\authortt{\sectt} \def\titleecsize{2074} % Chapter fonts (14.4pt). @@ -2185,7 +2022,7 @@ \setfont\secsf\sfbshape{12}{1000}{OT1} \let\secbf\secrm \setfont\secsc\scbshape{10}{\magstep1}{OT1} -\font\seci=cmmi12 +\font\seci=cmmi12 \font\secsy=cmsy10 scaled \magstep1 \def\sececsize{1200} @@ -2217,29 +2054,28 @@ \font\reducedsy=cmsy9 \def\reducedecsize{0900} -% reduce space between paragraphs -\divide\parskip by 2 - -% reset the current fonts -\textfonts +\divide\parskip by 2 % reduce space between paragraphs +\textleading = 12pt % line spacing for 10pt CM +\textfonts % reset the current fonts \rm -} % end of 10pt text font size definitions +} % end of 10pt text font size definitions, \definetextfontsizex % We provide the user-level command % @fonttextsize 10 % (or 11) to redefine the text font size. pt is assumed. -% +% +\def\xiword{11} \def\xword{10} -\def\xiword{11} +\def\xwordpt{10pt} % \parseargdef\fonttextsize{% \def\textsizearg{#1}% - \wlog{doing @fonttextsize \textsizearg}% + %\wlog{doing @fonttextsize \textsizearg}% % % Set \globaldefs so that documents can use this inside @tex, since % makeinfo 4.8 does not support it, but we need it nonetheless. - % + % \begingroup \globaldefs=1 \ifx\textsizearg\xword \definetextfontsizex \else \ifx\textsizearg\xiword \definetextfontsizexi @@ -2289,8 +2125,8 @@ \let\tenttsl=\titlettsl \def\curfontsize{title}% \def\lsize{chap}\def\lllsize{subsec}% - \resetmathfonts \setleading{25pt}} -\def\titlefont#1{{\titlefonts\rm #1}} + \resetmathfonts \setleading{27pt}} +\def\titlefont#1{{\titlefonts\rmisbold #1}} \def\chapfonts{% \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc @@ -2341,6 +2177,16 @@ \def\lsize{smaller}\def\lllsize{smaller}% \resetmathfonts \setleading{9.5pt}} +% Fonts for short table of contents. +\setfont\shortcontrm\rmshape{12}{1000}{OT1} +\setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12 +\setfont\shortcontsl\slshape{12}{1000}{OT1} +\setfont\shortconttt\ttshape{12}{1000}{OT1TT} + +% Define these just so they can be easily changed for other fonts. +\def\angleleft{$\langle$} +\def\angleright{$\rangle$} + % Set the fonts to use with the @small... environments. \let\smallexamplefonts = \smallfonts @@ -2354,53 +2200,213 @@ % % 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. % \definetextfontsizexi -% Define these so they can be easily changed for other fonts. -\def\angleleft{$\langle$} -\def\angleright{$\rangle$} + +\message{markup,} + +% Check if we are currently using a typewriter font. Since all the +% Computer Modern typewriter fonts have zero interword stretch (and +% shrink), and it is reasonable to expect all typewriter fonts to have +% this property, we can check that font parameter. +% +\def\ifmonospace{\ifdim\fontdimen3\font=0pt } + +% Markup style infrastructure. \defmarkupstylesetup\INITMACRO will +% define and register \INITMACRO to be called on markup style changes. +% \INITMACRO can check \currentmarkupstyle for the innermost +% style and the set of \ifmarkupSTYLE switches for all styles +% currently in effect. +\newif\ifmarkupvar +\newif\ifmarkupsamp +\newif\ifmarkupkey +%\newif\ifmarkupfile % @file == @samp. +%\newif\ifmarkupoption % @option == @samp. +\newif\ifmarkupcode +\newif\ifmarkupkbd +%\newif\ifmarkupenv % @env == @code. +%\newif\ifmarkupcommand % @command == @code. +\newif\ifmarkuptex % @tex (and part of @math, for now). +\newif\ifmarkupexample +\newif\ifmarkupverb +\newif\ifmarkupverbatim + +\let\currentmarkupstyle\empty + +\def\setupmarkupstyle#1{% + \csname markup#1true\endcsname + \def\currentmarkupstyle{#1}% + \markupstylesetup +} + +\let\markupstylesetup\empty + +\def\defmarkupstylesetup#1{% + \expandafter\def\expandafter\markupstylesetup + \expandafter{\markupstylesetup #1}% + \def#1% +} + +% Markup style setup for left and right quotes. +\defmarkupstylesetup\markupsetuplq{% + \expandafter\let\expandafter \temp + \csname markupsetuplq\currentmarkupstyle\endcsname + \ifx\temp\relax \markupsetuplqdefault \else \temp \fi +} + +\defmarkupstylesetup\markupsetuprq{% + \expandafter\let\expandafter \temp + \csname markupsetuprq\currentmarkupstyle\endcsname + \ifx\temp\relax \markupsetuprqdefault \else \temp \fi +} + +{ +\catcode`\'=\active +\catcode`\`=\active + +\gdef\markupsetuplqdefault{\let`\lq} +\gdef\markupsetuprqdefault{\let'\rq} + +\gdef\markupsetcodequoteleft{\let`\codequoteleft} +\gdef\markupsetcodequoteright{\let'\codequoteright} +} + +\let\markupsetuplqcode \markupsetcodequoteleft +\let\markupsetuprqcode \markupsetcodequoteright +% +\let\markupsetuplqexample \markupsetcodequoteleft +\let\markupsetuprqexample \markupsetcodequoteright +% +\let\markupsetuplqkbd \markupsetcodequoteleft +\let\markupsetuprqkbd \markupsetcodequoteright +% +\let\markupsetuplqsamp \markupsetcodequoteleft +\let\markupsetuprqsamp \markupsetcodequoteright +% +\let\markupsetuplqverb \markupsetcodequoteleft +\let\markupsetuprqverb \markupsetcodequoteright +% +\let\markupsetuplqverbatim \markupsetcodequoteleft +\let\markupsetuprqverbatim \markupsetcodequoteright + +% Allow an option to not use regular directed right quote/apostrophe +% (char 0x27), but instead the undirected quote from cmtt (char 0x0d). +% The undirected quote is ugly, so don't make it the default, but it +% works for pasting with more pdf viewers (at least evince), the +% lilypond developers report. xpdf does work with the regular 0x27. +% +\def\codequoteright{% + \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax + \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax + '% + \else \char'15 \fi + \else \char'15 \fi +} +% +% and a similar option for the left quote char vs. a grave accent. +% Modern fonts display ASCII 0x60 as a grave accent, so some people like +% the code environments to do likewise. +% +\def\codequoteleft{% + \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax + \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax + % [Knuth] pp. 380,381,391 + % \relax disables Spanish ligatures ?` and !` of \tt font. + \relax`% + \else \char'22 \fi + \else \char'22 \fi +} + +% Commands to set the quote options. +% +\parseargdef\codequoteundirected{% + \def\temp{#1}% + \ifx\temp\onword + \expandafter\let\csname SETtxicodequoteundirected\endcsname + = t% + \else\ifx\temp\offword + \expandafter\let\csname SETtxicodequoteundirected\endcsname + = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @codequoteundirected value `\temp', must be on|off}% + \fi\fi +} +% +\parseargdef\codequotebacktick{% + \def\temp{#1}% + \ifx\temp\onword + \expandafter\let\csname SETtxicodequotebacktick\endcsname + = t% + \else\ifx\temp\offword + \expandafter\let\csname SETtxicodequotebacktick\endcsname + = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @codequotebacktick value `\temp', must be on|off}% + \fi\fi +} + +% [Knuth] pp. 380,381,391, disable Spanish ligatures ?` and !` of \tt font. +\def\noligaturesquoteleft{\relax\lq} % Count depth in font-changes, for error checks \newcount\fontdepth \fontdepth=0 -% Fonts for short table of contents. -\setfont\shortcontrm\rmshape{12}{1000}{OT1} -\setfont\shortcontbf\bfshape{10}{\magstep1}{OT1} % no cmb12 -\setfont\shortcontsl\slshape{12}{1000}{OT1} -\setfont\shortconttt\ttshape{12}{1000}{OT1TT} - -%% 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 +% Font commands. + +% #1 is the font command (\sl or \it), #2 is the text to slant. +% If we are in a monospaced environment, however, 1) always use \ttsl, +% and 2) do not add an italic correction. +\def\dosmartslant#1#2{% + \ifusingtt + {{\ttsl #2}\let\next=\relax}% + {\def\next{{#1#2}\futurelet\next\smartitaliccorrection}}% + \next +} +\def\smartslanted{\dosmartslant\sl} +\def\smartitalic{\dosmartslant\it} + +% Output an italic correction unless \next (presumed to be the following +% character) is such as not to need one. +\def\smartitaliccorrection{% + \ifx\next,% + \else\ifx\next-% + \else\ifx\next.% + \else\ptexslash + \fi\fi\fi + \aftersmartic +} + +% Unconditional use \ttsl, and no ic. @var is set to this for defuns. +\def\ttslanted#1{{\ttsl #1}} + +% @cite is like \smartslanted except unconditionally use \sl. We never want % ttsl for book titles, do we? -\def\cite#1{{\sl #1}\futurelet\next\smartitalicx} +\def\cite#1{{\sl #1}\futurelet\next\smartitaliccorrection} + +\def\aftersmartic{} +\def\var#1{% + \let\saveaftersmartic = \aftersmartic + \def\aftersmartic{\null\let\aftersmartic=\saveaftersmartic}% + \smartslanted{#1}% +} \let\i=\smartitalic \let\slanted=\smartslanted -\let\var=\smartslanted \let\dfn=\smartslanted \let\emph=\smartitalic -% @b, explicit bold. +% Explicit font changes: @r, @sc, undocumented @ii. +\def\r#1{{\rm #1}} % roman font +\def\sc#1{{\smallcaps#1}} % smallcaps font +\def\ii#1{{\it #1}} % italic font + +% @b, explicit bold. Also @strong. \def\b#1{{\bf #1}} \let\strong=\b @@ -2432,30 +2438,21 @@ \catcode`@=\other \def\endofsentencespacefactor{3000}% default +% @t, explicit typewriter. \def\t#1{% {\tt \rawbackslash \plainfrenchspacing #1}% \null } -\def\samp#1{`\tclose{#1}'\null} -\setfont\keyrm\rmshape{8}{1000}{OT1} -\font\keysy=cmsy9 -\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% - \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% - \vbox{\hrule\kern-0.4pt - \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% - \kern-0.4pt\hrule}% - \kern-.06em\raise0.4pt\hbox{\angleright}}}} -\def\key #1{{\nohyphenation \uppercase{#1}}\null} -% 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. + +% @samp. +\def\samp#1{{\setupmarkupstyle{samp}\lq\tclose{#1}\rq\null}} + +% @indicateurl is \samp, that is, with quotes. +\let\indicateurl=\samp + +% @code (and similar) prints in typewriter, but with spaces the same +% size as normal in the surrounding text, without hyphenation, etc. +% This is a subroutine for that. \def\tclose#1{% {% % Change normal interword space to be same as for the current font. @@ -2474,13 +2471,13 @@ \plainfrenchspacing #1% }% - \null + \null % reset spacefactor to 1000 } % We *must* turn on hyphenation at `-' and `_' in @code. % Otherwise, it is too hard to avoid overfull hboxes % in the Emacs manual, the Library manual, etc. - +% % Unfortunately, TeX uses one parameter (\hyphenchar) to control % both hyphenation at - and hyphenation within words. % We must therefore turn them both off (\tclose does that) @@ -2489,24 +2486,26 @@ { \catcode`\-=\active \catcode`\_=\active \catcode`\'=\active \catcode`\`=\active + \global\let'=\rq \global\let`=\lq % default definitions % \global\def\code{\begingroup - \catcode\rquoteChar=\active \catcode\lquoteChar=\active - \let'\codequoteright \let`\codequoteleft - % + \setupmarkupstyle{code}% + % The following should really be moved into \setupmarkupstyle handlers. \catcode\dashChar=\active \catcode\underChar=\active \ifallowcodebreaks \let-\codedash \let_\codeunder \else - \let-\realdash + \let-\normaldash \let_\realunder \fi \codex } } -\def\realdash{-} +\def\codex #1{\tclose{#1}\endgroup} + +\def\normaldash{-} \def\codedash{-\discretionary{}{}{}} \def\codeunder{% % this is all so @math{@code{var_name}+1} can work. In math mode, _ @@ -2519,13 +2518,12 @@ \discretionary{}{}{}}% {\_}% } -\def\codex #1{\tclose{#1}\endgroup} % An additional complication: the above will allow breaks after, e.g., -% each of the four underscores in __typeof__. This is undesirable in -% some manuals, especially if they don't have long identifiers in -% general. @allowcodebreaks provides a way to control this. -% +% each of the four underscores in __typeof__. This is bad. +% @allowcodebreaks provides a document-level way to turn breaking at - +% and _ on and off. +% \newif\ifallowcodebreaks \allowcodebreakstrue \def\keywordtrue{true} @@ -2539,62 +2537,25 @@ \allowcodebreaksfalse \else \errhelp = \EMsimple - \errmessage{Unknown @allowcodebreaks option `\txiarg'}% + \errmessage{Unknown @allowcodebreaks option `\txiarg', must be true|false}% \fi\fi } -% @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\txiarg{#1}% - \ifx\txiarg\worddistinct - \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% - \else\ifx\txiarg\wordexample - \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% - \else\ifx\txiarg\wordcode - \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% - \else - \errhelp = \EMsimple - \errmessage{Unknown @kbdinputstyle option `\txiarg'}% - \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 +% For @command, @env, @file, @option quotes seem unnecessary, +% so use \code rather than \samp. +\let\command=\code \let\env=\code -\let\command=\code - -% @clicksequence{File @click{} Open ...} -\def\clicksequence#1{\begingroup #1\endgroup} - -% @clickstyle @arrow (by default) -\parseargdef\clickstyle{\def\click{#1}} -\def\click{\arrow} +\let\file=\code +\let\option=\code % @uref (abbreviation for `urlref') takes an optional (comma-separated) % second argument specifying the text to display and an optional third % arg as text to display instead of (rather than in addition to) the url -% itself. First (mandatory) arg is the url. Perhaps eventually put in -% a hypertex \special here. -% -\def\uref#1{\douref #1,,,\finish} -\def\douref#1,#2,#3,#4\finish{\begingroup +% itself. First (mandatory) arg is the url. +% (This \urefnobreak definition isn't used now, leaving it for a while +% for comparison.) +\def\urefnobreak#1{\dourefnobreak #1,,,\finish} +\def\dourefnobreak#1,#2,#3,#4\finish{\begingroup \unsepspaces \pdfurl{#1}% \setbox0 = \hbox{\ignorespaces #3}% @@ -2615,6 +2576,103 @@ \endlink \endgroup} +% This \urefbreak definition is the active one. +\def\urefbreak{\begingroup \urefcatcodes \dourefbreak} +\let\uref=\urefbreak +\def\dourefbreak#1{\urefbreakfinish #1,,,\finish} +\def\urefbreakfinish#1,#2,#3,#4\finish{% doesn't work in @example + \unsepspaces + \pdfurl{#1}% + \setbox0 = \hbox{\ignorespaces #3}% + \ifdim\wd0 > 0pt + \unhbox0 % third arg given, show only that + \else + \setbox0 = \hbox{\ignorespaces #2}% + \ifdim\wd0 > 0pt + \ifpdf + \unhbox0 % PDF: 2nd arg given, show only it + \else + \unhbox0\ (\urefcode{#1})% DVI: 2nd arg given, show both it and url + \fi + \else + \urefcode{#1}% only url given, so show it + \fi + \fi + \endlink +\endgroup} + +% Allow line breaks around only a few characters (only). +\def\urefcatcodes{% + \catcode\ampChar=\active \catcode\dotChar=\active + \catcode\hashChar=\active \catcode\questChar=\active + \catcode\slashChar=\active +} +{ + \urefcatcodes + % + \global\def\urefcode{\begingroup + \setupmarkupstyle{code}% + \urefcatcodes + \let&\urefcodeamp + \let.\urefcodedot + \let#\urefcodehash + \let?\urefcodequest + \let/\urefcodeslash + \codex + } + % + % By default, they are just regular characters. + \global\def&{\normalamp} + \global\def.{\normaldot} + \global\def#{\normalhash} + \global\def?{\normalquest} + \global\def/{\normalslash} +} + +% we put a little stretch before and after the breakable chars, to help +% line breaking of long url's. The unequal skips make look better in +% cmtt at least, especially for dots. +\def\urefprestretch{\urefprebreak \hskip0pt plus.13em } +\def\urefpoststretch{\urefpostbreak \hskip0pt plus.1em } +% +\def\urefcodeamp{\urefprestretch \&\urefpoststretch} +\def\urefcodedot{\urefprestretch .\urefpoststretch} +\def\urefcodehash{\urefprestretch \#\urefpoststretch} +\def\urefcodequest{\urefprestretch ?\urefpoststretch} +\def\urefcodeslash{\futurelet\next\urefcodeslashfinish} +{ + \catcode`\/=\active + \global\def\urefcodeslashfinish{% + \urefprestretch \slashChar + % Allow line break only after the final / in a sequence of + % slashes, to avoid line break between the slashes in http://. + \ifx\next/\else \urefpoststretch \fi + } +} + +% One more complication: by default we'll break after the special +% characters, but some people like to break before the special chars, so +% allow that. Also allow no breaking at all, for manual control. +% +\parseargdef\urefbreakstyle{% + \def\txiarg{#1}% + \ifx\txiarg\wordnone + \def\urefprebreak{\nobreak}\def\urefpostbreak{\nobreak} + \else\ifx\txiarg\wordbefore + \def\urefprebreak{\allowbreak}\def\urefpostbreak{\nobreak} + \else\ifx\txiarg\wordafter + \def\urefprebreak{\nobreak}\def\urefpostbreak{\allowbreak} + \else + \errhelp = \EMsimple + \errmessage{Unknown @urefbreakstyle setting `\txiarg'}% + \fi\fi\fi +} +\def\wordafter{after} +\def\wordbefore{before} +\def\wordnone{none} + +\urefbreakstyle after + % @url synonym for @uref, since that's how everyone uses it. % \let\url=\uref @@ -2636,34 +2694,81 @@ \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 } +% @kbdinputstyle -- arg is `distinct' (@kbd uses slanted tty font always), +% `example' (@kbd uses ttsl only inside of @example and friends), +% or `code' (@kbd uses normal tty font always). +\parseargdef\kbdinputstyle{% + \def\txiarg{#1}% + \ifx\txiarg\worddistinct + \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\ttsl}% + \else\ifx\txiarg\wordexample + \gdef\kbdexamplefont{\ttsl}\gdef\kbdfont{\tt}% + \else\ifx\txiarg\wordcode + \gdef\kbdexamplefont{\tt}\gdef\kbdfont{\tt}% + \else + \errhelp = \EMsimple + \errmessage{Unknown @kbdinputstyle setting `\txiarg'}% + \fi\fi\fi +} +\def\worddistinct{distinct} +\def\wordexample{example} +\def\wordcode{code} + +% Default is `distinct'. +\kbdinputstyle distinct + +% @kbd is like @code, except that if the argument is just one @key command, +% then @kbd has no effect. +\def\kbd#1{{\def\look{#1}\expandafter\kbdsub\look??\par}} + +\def\xkey{\key} +\def\kbdsub#1#2#3\par{% + \def\one{#1}\def\three{#3}\def\threex{??}% + \ifx\one\xkey\ifx\threex\three \key{#2}% + \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi + \else{\tclose{\kbdfont\setupmarkupstyle{kbd}\look}}\fi +} + +% definition of @key that produces a lozenge. Doesn't adjust to text size. +%\setfont\keyrm\rmshape{8}{1000}{OT1} +%\font\keysy=cmsy9 +%\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% +% \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% +% \vbox{\hrule\kern-0.4pt +% \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% +% \kern-0.4pt\hrule}% +% \kern-.06em\raise0.4pt\hbox{\angleright}}}} + +% definition of @key with no lozenge. If the current font is already +% monospace, don't change it; that way, we respect @kbdinputstyle. But +% if it isn't monospace, then use \tt. +% +\def\key#1{{\setupmarkupstyle{key}% + \nohyphenation + \ifmonospace\else\tt\fi + #1}\null} + +% @clicksequence{File @click{} Open ...} +\def\clicksequence#1{\begingroup #1\endgroup} + +% @clickstyle @arrow (by default) +\parseargdef\clickstyle{\def\click{#1}} +\def\click{\arrow} % Typeset a dimension, e.g., `in' or `pt'. The only reason for the % argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. % \def\dmn#1{\thinspace #1} -\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}% @@ -2671,11 +2776,12 @@ \ifx\temp\empty \else \space ({\unsepspaces \ignorespaces \temp \unskip})% \fi + \null % reset \spacefactor=1000 } % @abbr for "Comput. J." and the like. % No font change, but don't do end-of-sentence spacing. -% +% \def\abbr#1{\doabbr #1,,\finish} \def\doabbr#1,#2,#3\finish{% {\plainfrenchspacing #1}% @@ -2683,7 +2789,257 @@ \ifx\temp\empty \else \space ({\unsepspaces \ignorespaces \temp \unskip})% \fi -} + \null % reset \spacefactor=1000 +} + +% @asis just yields its argument. Used with @table, for example. +% +\def\asis#1{#1} + +% @math outputs its argument in math mode. +% +% One complication: _ usually means subscripts, but it could also mean +% an actual _ character, as in @math{@var{some_variable} + 1}. So make +% _ active, and distinguish by seeing if the current family is \slfam, +% which is what @var uses. +{ + \catcode`\_ = \active + \gdef\mathunderscore{% + \catcode`\_=\active + \def_{\ifnum\fam=\slfam \_\else\sb\fi}% + } +} +% Another complication: we want \\ (and @\) to output a math (or tt) \. +% FYI, plain.tex uses \\ as a temporary control sequence (for no +% particular reason), but this is not advertised and we don't care. +% +% The \mathchar is class=0=ordinary, family=7=ttfam, position=5C=\. +\def\mathbackslash{\ifnum\fam=\ttfam \mathchar"075C \else\backslash \fi} +% +\def\math{% + \tex + \mathunderscore + \let\\ = \mathbackslash + \mathactive + % make the texinfo accent commands work in math mode + \let\"=\ddot + \let\'=\acute + \let\==\bar + \let\^=\hat + \let\`=\grave + \let\u=\breve + \let\v=\check + \let\~=\tilde + \let\dotaccent=\dot + $\finishmath +} +\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. + +% Some active characters (such as <) are spaced differently in math. +% We have to reset their definitions in case the @math was an argument +% to a command which sets the catcodes (such as @item or @section). +% +{ + \catcode`^ = \active + \catcode`< = \active + \catcode`> = \active + \catcode`+ = \active + \catcode`' = \active + \gdef\mathactive{% + \let^ = \ptexhat + \let< = \ptexless + \let> = \ptexgtr + \let+ = \ptexplus + \let' = \ptexquoteright + } +} + +% ctrl is no longer a Texinfo command, but leave this definition for fun. +\def\ctrl #1{{\tt \rawbackslash \hat}#1} + +% @inlinefmt{FMTNAME,PROCESSED-TEXT} and @inlineraw{FMTNAME,RAW-TEXT}. +% Ignore unless FMTNAME == tex; then it is like @iftex and @tex, +% except specified as a normal braced arg, so no newlines to worry about. +% +\def\outfmtnametex{tex} +% +\long\def\inlinefmt#1{\doinlinefmt #1,\finish} +\long\def\doinlinefmt#1,#2,\finish{% + \def\inlinefmtname{#1}% + \ifx\inlinefmtname\outfmtnametex \ignorespaces #2\fi +} +% For raw, must switch into @tex before parsing the argument, to avoid +% setting catcodes prematurely. Doing it this way means that, for +% example, @inlineraw{html, foo{bar} gets a parse error instead of being +% ignored. But this isn't important because if people want a literal +% *right* brace they would have to use a command anyway, so they may as +% well use a command to get a left brace too. We could re-use the +% delimiter character idea from \verb, but it seems like overkill. +% +\long\def\inlineraw{\tex \doinlineraw} +\long\def\doinlineraw#1{\doinlinerawtwo #1,\finish} +\def\doinlinerawtwo#1,#2,\finish{% + \def\inlinerawname{#1}% + \ifx\inlinerawname\outfmtnametex \ignorespaces #2\fi + \endgroup % close group opened by \tex. +} + + +\message{glyphs,} +% and logos. + +% @@ prints an @, as does @atchar{}. +\def\@{\char64 } +\let\atchar=\@ + +% @{ @} @lbracechar{} @rbracechar{} all generate brace characters. +% Unless we're in typewriter, use \ecfont because the CM text fonts do +% not have braces, and we don't want to switch into math. +\def\mylbrace{{\ifmonospace\else\ecfont\fi \char123}} +\def\myrbrace{{\ifmonospace\else\ecfont\fi \char125}} +\let\{=\mylbrace \let\lbracechar=\{ +\let\}=\myrbrace \let\rbracechar=\} +\begingroup + % Definitions to produce \{ and \} commands for indices, + % and @{ and @} for the aux/toc files. + \catcode`\{ = \other \catcode`\} = \other + \catcode`\[ = 1 \catcode`\] = 2 + \catcode`\! = 0 \catcode`\\ = \other + !gdef!lbracecmd[\{]% + !gdef!rbracecmd[\}]% + !gdef!lbraceatcmd[@{]% + !gdef!rbraceatcmd[@}]% +!endgroup + +% @comma{} to avoid , parsing problems. +\let\comma = , + +% Accents: @, @dotaccent @ringaccent @ubaraccent @udotaccent +% Others are defined by plain TeX: @` @' @" @^ @~ @= @u @v @H. +\let\, = \ptexc +\let\dotaccent = \ptexdot +\def\ringaccent#1{{\accent23 #1}} +\let\tieaccent = \ptext +\let\ubaraccent = \ptexb +\let\udotaccent = \d + +% Other special characters: @questiondown @exclamdown @ordf @ordm +% Plain TeX defines: @AA @AE @O @OE @L (plus lowercase versions) @ss. +\def\questiondown{?`} +\def\exclamdown{!`} +\def\ordf{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{a}}} +\def\ordm{\leavevmode\raise1ex\hbox{\selectfonts\lllsize \underbar{o}}} + +% Dotless i and dotless j, used for accents. +\def\imacro{i} +\def\jmacro{j} +\def\dotless#1{% + \def\temp{#1}% + \ifx\temp\imacro \ifmmode\imath \else\ptexi \fi + \else\ifx\temp\jmacro \ifmmode\jmath \else\j \fi + \else \errmessage{@dotless can be used only with i or j}% + \fi\fi +} + +% The \TeX{} logo, as in plain, but resetting the spacing so that a +% period following counts as ending a sentence. (Idea found in latex.) +% +\edef\TeX{\TeX \spacefactor=1000 } + +% @LaTeX{} logo. Not quite the same results as the definition in +% latex.ltx, since we use a different font for the raised A; it's most +% convenient for us to use an explicitly smaller font, rather than using +% the \scriptstyle font (since we don't reset \scriptstyle and +% \scriptscriptstyle). +% +\def\LaTeX{% + L\kern-.36em + {\setbox0=\hbox{T}% + \vbox to \ht0{\hbox{% + \ifx\textnominalsize\xwordpt + % for 10pt running text, \lllsize (8pt) is too small for the A in LaTeX. + % Revert to plain's \scriptsize, which is 7pt. + \count255=\the\fam $\fam\count255 \scriptstyle A$% + \else + % For 11pt, we can use our lllsize. + \selectfonts\lllsize A% + \fi + }% + \vss + }}% + \kern-.15em + \TeX +} + +% Some math mode symbols. +\def\bullet{$\ptexbullet$} +\def\geq{\ifmmode \ge\else $\ge$\fi} +\def\leq{\ifmmode \le\else $\le$\fi} +\def\minus{\ifmmode -\else $-$\fi} + +% @dots{} outputs an ellipsis using the current font. +% We do .5em per period so that it has the same spacing in the cm +% typewriter fonts as three actual period characters; on the other hand, +% in other typewriter fonts three periods are wider than 1.5em. So do +% whichever is larger. +% +\def\dots{% + \leavevmode + \setbox0=\hbox{...}% get width of three periods + \ifdim\wd0 > 1.5em + \dimen0 = \wd0 + \else + \dimen0 = 1.5em + \fi + \hbox to \dimen0{% + \hskip 0pt plus.25fil + .\hskip 0pt plus1fil + .\hskip 0pt plus1fil + .\hskip 0pt plus.5fil + }% +} + +% @enddots{} is an end-of-sentence ellipsis. +% +\def\enddots{% + \dots + \spacefactor=\endofsentencespacefactor +} + +% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. +% +% Since these characters are used in examples, they should be an even number of +% \tt widths. Each \tt character is 1en, so two makes it 1em. +% +\def\point{$\star$} +\def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}} +\def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} +\def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}} +\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} +\def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}} + +% The @error{} command. +% Adapted from the TeXbook's \boxit. +% +\newbox\errorbox +% +{\tentt \global\dimen0 = 3em}% Width of the box. +\dimen2 = .55pt % Thickness of rules +% The text. (`r' is open on the right, `e' somewhat less so on the left.) +\setbox0 = \hbox{\kern-.75pt \reducedsf \putworderror\kern-1.5pt} +% +\setbox\errorbox=\hbox to \dimen0{\hfil + \hsize = \dimen0 \advance\hsize by -5.8pt % Space to left+right. + \advance\hsize by -2\dimen2 % Rules. + \vbox{% + \hrule height\dimen2 + \hbox{\vrule width\dimen2 \kern3pt % Space to left of text. + \vtop{\kern2.4pt \box0 \kern2.4pt}% Space above/below. + \kern3pt\vrule width\dimen2}% Space to right. + \hrule height\dimen2} + \hfil} +% +\def\error{\leavevmode\lower.7ex\copy\errorbox} % @pounds{} is a sterling sign, which Knuth put in the CM italic font. % @@ -2694,52 +3050,59 @@ % 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 + \ifx\curfontstyle\bfstylename % bold: \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize - \else + \else % regular: \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize \fi \thiseurofont } -% Hacks for glyphs from the EC fonts similar to \euro. We don't -% use \let for the aliases, because sometimes we redefine the original -% macro, and the alias should reflect the redefinition. +% Glyphs from the EC fonts. We don't use \let for the aliases, because +% sometimes we redefine the original macro, and the alias should reflect +% the redefinition. +% +% Use LaTeX names for the Icelandic letters. +\def\DH{{\ecfont \char"D0}} % Eth +\def\dh{{\ecfont \char"F0}} % eth +\def\TH{{\ecfont \char"DE}} % Thorn +\def\th{{\ecfont \char"FE}} % thorn +% \def\guillemetleft{{\ecfont \char"13}} \def\guillemotleft{\guillemetleft} \def\guillemetright{{\ecfont \char"14}} @@ -2749,19 +3112,52 @@ \def\quotedblbase{{\ecfont \char"12}} \def\quotesinglbase{{\ecfont \char"0D}} % +% This positioning is not perfect (see the ogonek LaTeX package), but +% we have the precomposed glyphs for the most common cases. We put the +% tests to use those glyphs in the single \ogonek macro so we have fewer +% dummy definitions to worry about for index entries, etc. +% +% ogonek is also used with other letters in Lithuanian (IOU), but using +% the precomposed glyphs for those is not so easy since they aren't in +% the same EC font. +\def\ogonek#1{{% + \def\temp{#1}% + \ifx\temp\macrocharA\Aogonek + \else\ifx\temp\macrochara\aogonek + \else\ifx\temp\macrocharE\Eogonek + \else\ifx\temp\macrochare\eogonek + \else + \ecfont \setbox0=\hbox{#1}% + \ifdim\ht0=1ex\accent"0C #1% + \else\ooalign{\unhbox0\crcr\hidewidth\char"0C \hidewidth}% + \fi + \fi\fi\fi\fi + }% +} +\def\Aogonek{{\ecfont \char"81}}\def\macrocharA{A} +\def\aogonek{{\ecfont \char"A1}}\def\macrochara{a} +\def\Eogonek{{\ecfont \char"86}}\def\macrocharE{E} +\def\eogonek{{\ecfont \char"A6}}\def\macrochare{e} +% +% Use the ec* fonts (cm-super in outline format) for non-CM glyphs. \def\ecfont{% - % We can't distinguish serif/sanserif and italic/slanted, but this + % We can't distinguish serif/sans and italic/slanted, but this % is used for crude hacks anyway (like adding French and German % quotes to documents typeset with CM, where we lose kerning), so % hopefully nobody will notice/care. \edef\ecsize{\csname\curfontsize ecsize\endcsname}% \edef\nominalsize{\csname\curfontsize nominalsize\endcsname}% - \ifx\curfontstyle\bfstylename - % bold: - \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize + \ifmonospace + % typewriter: + \font\thisecfont = ectt\ecsize \space at \nominalsize \else - % regular: - \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize + \ifx\curfontstyle\bfstylename + % bold: + \font\thisecfont = ecb\ifusingit{i}{x}\ecsize \space at \nominalsize + \else + % regular: + \font\thisecfont = ec\ifusingit{ti}{rm}\ecsize \space at \nominalsize + \fi \fi \thisecfont } @@ -2783,8 +3179,8 @@ % 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 +% +\ifx\Orb\thisisundefined \def\Orb{\mathhexbox20D} \fi @@ -2812,8 +3208,9 @@ \newif\ifsetshortcontentsaftertitlepage \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue -\parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% - \endgroup\page\hbox{}\page} +\parseargdef\shorttitlepage{% + \begingroup \hbox{}\vskip 1.5in \chaprm \centerline{#1}% + \endgroup\page\hbox{}\page} \envdef\titlepage{% % Open one extra group, as we want to close it in the middle of \Etitlepage. @@ -2873,17 +3270,28 @@ \finishedtitlepagetrue } -%%% Macros to be used within @titlepage: +% Settings used for typesetting titles: no hyphenation, no indentation, +% don't worry much about spacing, ragged right. This should be used +% inside a \vbox, and fonts need to be set appropriately first. Because +% it is always used for titles, nothing else, we call \rmisbold. \par +% should be specified before the end of the \vbox, since a vbox is a group. +% +\def\raggedtitlesettings{% + \rmisbold + \hyphenpenalty=10000 + \parindent=0pt + \tolerance=5000 + \ptexraggedright +} + +% Macros to be used within @titlepage: \let\subtitlerm=\tenrm \def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} -\def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines - \let\tt=\authortt} - \parseargdef\title{% \checkenv\titlepage - \leftline{\titlefonts\rm #1} + \vbox{\titlefonts \raggedtitlesettings #1\par}% % print a rule at the page bottom also. \finishedtitlepagefalse \vskip4pt \hrule height 4pt width \hsize \vskip4pt @@ -2904,12 +3312,12 @@ \else \checkenv\titlepage \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi - {\authorfont \leftline{#1}}% + {\secfonts\rmisbold \leftline{#1}}% \fi } -%%% Set up page headings and footings. +% Set up page headings and footings. \let\thispage=\folio @@ -3003,10 +3411,14 @@ \def\headings #1 {\csname HEADINGS#1\endcsname} -\def\HEADINGSoff{% -\global\evenheadline={\hfil} \global\evenfootline={\hfil} -\global\oddheadline={\hfil} \global\oddfootline={\hfil}} -\HEADINGSoff +\def\headingsoff{% non-global headings elimination + \evenheadline={\hfil}\evenfootline={\hfil}% + \oddheadline={\hfil}\oddfootline={\hfil}% +} + +\def\HEADINGSoff{{\globaldefs=1 \headingsoff}} % global setting +\HEADINGSoff % it's the default + % When we turn headings on, set the page number to 1. % For double-sided printing, put current file name in lower left corner, % chapter name on inside top of right hand pages, document @@ -3057,7 +3469,7 @@ % 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 +\ifx\today\thisisundefined \def\today{% \number\day\space \ifcase\month @@ -3118,7 +3530,7 @@ \begingroup \advance\leftskip by-\tableindent \advance\hsize by\tableindent - \advance\rightskip by0pt plus1fil + \advance\rightskip by0pt plus1fil\relax \leavevmode\unhbox0\par \endgroup % @@ -3132,7 +3544,7 @@ % 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 @@ -3226,9 +3638,18 @@ \parindent=0pt \parskip=\smallskipamount \ifdim\parskip=0pt \parskip=2pt \fi + % + % Try typesetting the item mark that if the document erroneously says + % something like @itemize @samp (intending @table), there's an error + % right away at the @itemize. It's not the best error message in the + % world, but it's better than leaving it to the @item. This means if + % the user wants an empty mark, they have to say @w{} not just @w. \def\itemcontents{#1}% + \setbox0 = \hbox{\itemcontents}% + % % @itemize with no arg is equivalent to @itemize @bullet. \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi + % \let\item=\itemizeitem } @@ -3249,6 +3670,7 @@ \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 } @@ -3470,12 +3892,19 @@ % % @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}% +% of an alignment entry. \everycr resets \everytab so we don't have to +% undo it ourselves. +\def\headitemfont{\b}% for people to use in the template row; not changeable +\def\headitem{% + \checkenv\multitable + \crcr + \global\everytab={\bf}% can't use \headitemfont since the parsing differs + \the\everytab % for the first item +}% % % A \tab used to include \hskip1sp. But then the space in a template % line is not enough. That is bad. So let's go back to just `&' until -% we encounter the problem it was intended to solve again. +% we again encounter the problem the 1sp was intended to solve. % --karl, nathan@acm.org, 20apr99. \def\tab{\checkenv\multitable &\the\everytab}% @@ -3587,18 +4016,18 @@ \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. +% 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. +\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. +\global\advance\multitableparskip-7pt % to keep parskip somewhat smaller + % than skip between lines in the table. \fi} @@ -3759,7 +4188,7 @@ % ..., 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 + \let-\normaldash \let_\normalunderscore } } @@ -3782,8 +4211,9 @@ % @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. +% +% To get the special treatment we need for `@end ifset,' we call +% \makecond and then redefine. % \makecond{ifset} \def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} @@ -3799,7 +4229,7 @@ } \def\ifsetfail{\doignore{ifset}} -% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been +% @ifclear VAR ... @end executes the `...' iff VAR has never been % defined with @set, or has been undefined with @clear. % % The `\else' inside the `\doifset' parameter is a trick to reuse the @@ -3810,6 +4240,35 @@ \def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} \def\ifclearfail{\doignore{ifclear}} +% @ifcommandisdefined CMD ... @end executes the `...' if CMD (written +% without the @) is in fact defined. We can only feasibly check at the +% TeX level, so something like `mathcode' is going to considered +% defined even though it is not a Texinfo command. +% +\makecond{ifcommanddefined} +\def\ifcommanddefined{\parsearg{\doifcmddefined{\let\next=\ifcmddefinedfail}}} +% +\def\doifcmddefined#1#2{{% + \makevalueexpandable + \let\next=\empty + \expandafter\ifx\csname #2\endcsname\relax + #1% If not defined, \let\next as above. + \fi + \expandafter + }\next +} +\def\ifcmddefinedfail{\doignore{ifcommanddefined}} + +% @ifcommandnotdefined CMD ... handled similar to @ifclear above. +\makecond{ifcommandnotdefined} +\def\ifcommandnotdefined{% + \parsearg{\doifcmddefined{\else \let\next=\ifcmdnotdefinedfail}}} +\def\ifcmdnotdefinedfail{\doignore{ifcommandnotdefined}} + +% Set the `txicommandconditionals' variable, so documents have a way to +% test if the @ifcommand...defined conditionals are available. +\set txicommandconditionals + % @dircategory CATEGORY -- specify a category of the dir file % which this file should belong to. Ignore this in TeX. \let\dircategory=\comment @@ -3874,11 +4333,11 @@ \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 + \expandafter \ifx\csname donesynindex#2\endcsname \relax % The \closeout helps reduce unnecessary open files; the limit on the % Acorn RISC OS is a mere 16 files. \expandafter\closeout\csname#2indfile\endcsname - \expandafter\let\csname\donesynindex#2\endcsname = 1 + \expandafter\let\csname donesynindex#2\endcsname = 1 \fi % redefine \fooindfile: \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname @@ -3913,11 +4372,14 @@ \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 + % Need these unexpandable (because we define \tt as a dummy) + % definitions when @{ or @} appear in index entry text. Also, more + % complicated, when \tex is in effect and \{ is a \delimiter again. + % We can't use \lbracecmd and \rbracecmd because texindex assumes + % braces and backslashes are used only as delimiters. Perhaps we + % should define @lbrace and @rbrace commands a la @comma. + \def\{{{\tt\char123}}% + \def\}{{\tt\char125}}% % % I don't entirely understand this, but when an index entry is % generated from a macro call, the \endinput which \scanmacro inserts @@ -3928,7 +4390,7 @@ % processing continues to some further point. On the other hand, it % seems \endinput does not hurt in the printed index arg, since that % is still getting written without apparent harm. - % + % % Sample source (mac-idx3.tex, reported by Graham Percival to % help-texinfo, 22may06): % @macro funindex {WORD} @@ -3936,12 +4398,12 @@ % @end macro % ... % @funindex commtest - % + % % The above is not enough to reproduce the bug, but it gives the flavor. - % + % % Sample whatsit resulting: % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}} - % + % % So: \let\endinput = \empty % @@ -3970,7 +4432,7 @@ \def\commondummies{% % % \definedummyword defines \#1 as \string\#1\space, thus effectively - % preventing its expansion. This is used only for control% words, + % 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. @@ -3989,23 +4451,28 @@ \commondummiesnofonts % \definedummyletter\_% + \definedummyletter\-% % % Non-English letters. \definedummyword\AA \definedummyword\AE + \definedummyword\DH \definedummyword\L + \definedummyword\O \definedummyword\OE - \definedummyword\O + \definedummyword\TH \definedummyword\aa \definedummyword\ae + \definedummyword\dh + \definedummyword\exclamdown \definedummyword\l - \definedummyword\oe \definedummyword\o - \definedummyword\ss - \definedummyword\exclamdown - \definedummyword\questiondown + \definedummyword\oe \definedummyword\ordf \definedummyword\ordm + \definedummyword\questiondown + \definedummyword\ss + \definedummyword\th % % Although these internal commands shouldn't show up, sometimes they do. \definedummyword\bf @@ -4021,21 +4488,27 @@ \definedummyword\TeX % % Assorted special characters. + \definedummyword\arrow \definedummyword\bullet \definedummyword\comma \definedummyword\copyright \definedummyword\registeredsymbol \definedummyword\dots \definedummyword\enddots + \definedummyword\entrybreak \definedummyword\equiv \definedummyword\error \definedummyword\euro + \definedummyword\expansion + \definedummyword\geq \definedummyword\guillemetleft \definedummyword\guillemetright \definedummyword\guilsinglleft \definedummyword\guilsinglright - \definedummyword\expansion + \definedummyword\lbracechar + \definedummyword\leq \definedummyword\minus + \definedummyword\ogonek \definedummyword\pounds \definedummyword\point \definedummyword\print @@ -4045,6 +4518,7 @@ \definedummyword\quoteleft \definedummyword\quoteright \definedummyword\quotesinglbase + \definedummyword\rbracechar \definedummyword\result \definedummyword\textdegree % @@ -4079,6 +4553,7 @@ \definedummyword\v \definedummyword\H \definedummyword\dotaccent + \definedummyword\ogonek \definedummyword\ringaccent \definedummyword\tieaccent \definedummyword\ubaraccent @@ -4089,18 +4564,27 @@ \definedummyword\b \definedummyword\i \definedummyword\r + \definedummyword\sansserif \definedummyword\sc + \definedummyword\slanted \definedummyword\t % % Commands that take arguments. + \definedummyword\abbr \definedummyword\acronym + \definedummyword\anchor \definedummyword\cite \definedummyword\code \definedummyword\command \definedummyword\dfn + \definedummyword\dmn + \definedummyword\email \definedummyword\emph \definedummyword\env \definedummyword\file + \definedummyword\image + \definedummyword\indicateurl + \definedummyword\inforef \definedummyword\kbd \definedummyword\key \definedummyword\math @@ -4128,7 +4612,7 @@ \def\definedummyaccent##1{\let##1\asis}% % We can just ignore other control letters. \def\definedummyletter##1{\let##1\empty}% - % Hopefully, all control words can become @asis. + % All control words become @asis by default; overrides below. \let\definedummyword\definedummyaccent % \commondummiesnofonts @@ -4140,48 +4624,63 @@ % \def\ { }% \def\@{@}% - % how to handle braces? \def\_{\normalunderscore}% + \def\-{}% @- shouldn't affect sorting + % + % Unfortunately, texindex is not prepared to handle braces in the + % content at all. So for index sorting, we map @{ and @} to strings + % starting with |, since that ASCII character is between ASCII { and }. + \def\{{|a}% + \def\lbracechar{|a}% + % + \def\}{|b}% + \def\rbracechar{|b}% % % Non-English letters. \def\AA{AA}% \def\AE{AE}% + \def\DH{DZZ}% \def\L{L}% \def\OE{OE}% \def\O{O}% + \def\TH{ZZZ}% \def\aa{aa}% \def\ae{ae}% + \def\dh{dzz}% + \def\exclamdown{!}% \def\l{l}% \def\oe{oe}% - \def\o{o}% - \def\ss{ss}% - \def\exclamdown{!}% - \def\questiondown{?}% \def\ordf{a}% \def\ordm{o}% + \def\o{o}% + \def\questiondown{?}% + \def\ss{ss}% + \def\th{zzz}% % \def\LaTeX{LaTeX}% \def\TeX{TeX}% % % Assorted special characters. % (The following {} will end up in the sort string, but that's ok.) + \def\arrow{->}% \def\bullet{bullet}% \def\comma{,}% \def\copyright{copyright}% - \def\registeredsymbol{R}% \def\dots{...}% \def\enddots{...}% \def\equiv{==}% \def\error{error}% \def\euro{euro}% + \def\expansion{==>}% + \def\geq{>=}% \def\guillemetleft{<<}% \def\guillemetright{>>}% \def\guilsinglleft{<}% \def\guilsinglright{>}% - \def\expansion{==>}% + \def\leq{<=}% \def\minus{-}% + \def\point{.}% \def\pounds{pounds}% - \def\point{.}% \def\print{-|}% \def\quotedblbase{"}% \def\quotedblleft{"}% @@ -4189,22 +4688,31 @@ \def\quoteleft{`}% \def\quoteright{'}% \def\quotesinglbase{,}% + \def\registeredsymbol{R}% \def\result{=>}% - \def\textdegree{degrees}% + \def\textdegree{o}% + % + \expandafter\ifx\csname SETtxiindexlquoteignore\endcsname\relax + \else \indexlquoteignore \fi % % We need to get rid of all macros, leaving only the arguments (if present). % Of course this is not nearly correct, but it is the best we can do for now. % makeinfo does not expand macros in the argument to @deffn, which ends up % writing an index entry, and texindex isn't prepared for an index sort entry % that starts with \. - % + % % Since macro invocations are followed by braces, we can just redefine them % to take a single TeX argument. The case of a macro invocation that % goes to end-of-line is not handled. - % + % \macrolist } +% Undocumented (for FSFS 2nd ed.): @set txiindexlquoteignore makes us +% ignore left quotes in the sort term. +{\catcode`\`=\active + \gdef\indexlquoteignore{\let`=\empty}} + \let\indexbackslash=0 %overridden during \printindex. \let\SETmarginindex=\relax % put index entries in margin (undocumented)? @@ -4302,10 +4810,9 @@ % % ..., ready, GO: % -\def\safewhatsit#1{% -\ifhmode +\def\safewhatsit#1{\ifhmode #1% -\else + \else % \lastskip and \lastpenalty cannot both be nonzero simultaneously. \whatsitskip = \lastskip \edef\lastskipmacro{\the\lastskip}% @@ -4329,7 +4836,6 @@ % 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. @@ -4342,8 +4848,7 @@ % (the whatsit from the \write), so we must insert a \nobreak. \nobreak\vskip\whatsitskip \fi -\fi -} +\fi} % The index entry written in the file actually looks like % \entry {sortstring}{page}{topic} @@ -4462,7 +4967,6 @@ % But this freezes the catcodes in the argument, and can cause problems to % @code, which sets - active. This problem was fixed by a kludge--- % ``-'' was active throughout whole index, but this isn't really right. -% % The right solution is to prevent \entry from swallowing the whole text. % --kasal, 21nov03 \def\entry{% @@ -4499,10 +5003,17 @@ % columns. \vskip 0pt plus1pt % + % When reading the text of entry, convert explicit line breaks + % from @* into spaces. The user might give these in long section + % titles, for instance. + \def\*{\unskip\space\ignorespaces}% + \def\entrybreak{\hfil\break}% + % % Swallow the left brace of the text (first parameter): \afterassignment\doentry \let\temp = } +\def\entrybreak{\unskip\space\ignorespaces}% \def\doentry{% \bgroup % Instead of the swallowed brace. \noindent @@ -4735,7 +5246,22 @@ \message{sectioning,} % Chapters, sections, etc. -% \unnumberedno is an oxymoron, of course. But we count the unnumbered +% Let's start with @part. +\outer\parseargdef\part{\partzzz{#1}} +\def\partzzz#1{% + \chapoddpage + \null + \vskip.3\vsize % move it down on the page a bit + \begingroup + \noindent \titlefonts\rmisbold #1\par % the text + \let\lastnode=\empty % no node to associate with + \writetocentry{part}{#1}{}% but put it in the toc + \headingsoff % no headline or footline on the part page + \chapoddpage + \endgroup +} + +% \unnumberedno is an oxymoron. But we count the unnumbered % sections so that we can refer to them unambiguously in the pdf % outlines by their "section number". We avoid collisions with chapter % numbers by starting them at 10000. (If a document ever has 10000 @@ -4814,8 +5340,8 @@ \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 +% To achieve this, remember the "biggest" unnum. sec. we are currently in: +\chardef\unnlevel = \maxseclevel % % Trace whether the current chapter is an appendix or not: % \chapheadtype is "N" or "A", unnumbered chapters are ignored. @@ -4840,8 +5366,8 @@ % The heading type: \def\headtype{#1}% \if \headtype U% - \ifnum \absseclevel < \unmlevel - \chardef\unmlevel = \absseclevel + \ifnum \absseclevel < \unnlevel + \chardef\unnlevel = \absseclevel \fi \else % Check for appendix sections: @@ -4853,10 +5379,10 @@ \fi\fi \fi % Check for numbered within unnumbered: - \ifnum \absseclevel > \unmlevel + \ifnum \absseclevel > \unnlevel \def\headtype{U}% \else - \chardef\unmlevel = 3 + \chardef\unnlevel = 3 \fi \fi % Now print the heading: @@ -4910,7 +5436,9 @@ \gdef\chaplevelprefix{\the\chapno.}% \resetallfloatnos % - \message{\putwordChapter\space \the\chapno}% + % \putwordChapter can contain complex things in translations. + \toks0=\expandafter{\putwordChapter}% + \message{\the\toks0 \space \the\chapno}% % % Write the actual heading. \chapmacro{#1}{Ynumbered}{\the\chapno}% @@ -4921,15 +5449,17 @@ \global\let\subsubsection = \numberedsubsubsec } -\outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz +\outer\parseargdef\appendix{\apphead0{#1}} % normally calls appendixzzz +% \def\appendixzzz#1{% \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 \global\advance\appendixno by 1 \gdef\chaplevelprefix{\appendixletter.}% \resetallfloatnos % - \def\appendixnum{\putwordAppendix\space \appendixletter}% - \message{\appendixnum}% + % \putwordAppendix can contain complex things in translations. + \toks0=\expandafter{\putwordAppendix}% + \message{\the\toks0 \space \appendixletter}% % \chapmacro{#1}{Yappendix}{\appendixletter}% % @@ -4938,7 +5468,8 @@ \global\let\subsubsection = \appendixsubsubsec } -\outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz +% normally unnmhead0 calls unnumberedzzz: +\outer\parseargdef\unnumbered{\unnmhead0{#1}} \def\unnumberedzzz#1{% \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 \global\advance\unnumberedno by 1 @@ -4982,40 +5513,47 @@ \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 +% normally calls appendixsectionzzz: +\outer\parseargdef\appendixsection{\apphead1{#1}} \def\appendixsectionzzz#1{% \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% } \let\appendixsec\appendixsection -\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz +% normally calls unnumberedseczzz: +\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} \def\unnumberedseczzz#1{% \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% } % Subsections. -\outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz +% +% normally calls numberedsubseczzz: +\outer\parseargdef\numberedsubsec{\numhead2{#1}} \def\numberedsubseczzz#1{% \global\subsubsecno=0 \global\advance\subsecno by 1 \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% } -\outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz +% normally calls appendixsubseczzz: +\outer\parseargdef\appendixsubsec{\apphead2{#1}} \def\appendixsubseczzz#1{% \global\subsubsecno=0 \global\advance\subsecno by 1 \sectionheading{#1}{subsec}{Yappendix}% {\appendixletter.\the\secno.\the\subsecno}% } -\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz +% normally calls unnumberedsubseczzz: +\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} \def\unnumberedsubseczzz#1{% \global\subsubsecno=0 \global\advance\subsecno by 1 \sectionheading{#1}{subsec}{Ynothing}% @@ -5023,21 +5561,25 @@ } % Subsubsections. -\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz +% +% normally numberedsubsubseczzz: +\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} \def\numberedsubsubseczzz#1{% \global\advance\subsubsecno by 1 \sectionheading{#1}{subsubsec}{Ynumbered}% {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% } -\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz +% normally appendixsubsubseczzz: +\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} \def\appendixsubsubseczzz#1{% \global\advance\subsubsecno by 1 \sectionheading{#1}{subsubsec}{Yappendix}% {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% } -\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz +% normally unnumberedsubsubseczzz: +\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} \def\unnumberedsubsubseczzz#1{% \global\advance\subsubsecno by 1 \sectionheading{#1}{subsubsec}{Ynothing}% @@ -5053,15 +5595,6 @@ % 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 @@ -5069,10 +5602,8 @@ \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 + \vbox{\chapfonts \raggedtitlesettings #1\par}% + \nobreak\bigskip \nobreak \suppressfirstparagraphindent } @@ -5088,14 +5619,13 @@ % (including whitespace, linebreaking, etc. around it), % given all the information in convenient, parsed form. -%%% Args are the skip and penalty (usually negative) +% 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 +% Define plain chapter starts, and page on/off switching for it. \def\chapbreak{\dobreak \chapheadingskip {-4000}} \def\chappager{\par\vfill\supereject} % Because \domark is called before \chapoddpage, the filler page will @@ -5105,9 +5635,8 @@ \chappager \ifodd\pageno \else \begingroup - \evenheadline={\hfil}\evenfootline={\hfil}% - \oddheadline={\hfil}\oddfootline={\hfil}% - \hbox to 0pt{}% + \headingsoff + \null \chappager \endgroup \fi @@ -5163,7 +5692,10 @@ \xdef\lastchapterdefs{% \gdef\noexpand\thischaptername{\the\toks0}% \gdef\noexpand\thischapternum{\appendixletter}% - \gdef\noexpand\thischapter{\putwordAppendix{} \noexpand\thischapternum: + % \noexpand\putwordAppendix avoids expanding indigestible + % commands in some of the translations. + \gdef\noexpand\thischapter{\noexpand\putwordAppendix{} + \noexpand\thischapternum: \noexpand\thischaptername}% }% \else @@ -5171,7 +5703,10 @@ \xdef\lastchapterdefs{% \gdef\noexpand\thischaptername{\the\toks0}% \gdef\noexpand\thischapternum{\the\chapno}% - \gdef\noexpand\thischapter{\putwordChapter{} \noexpand\thischapternum: + % \noexpand\putwordChapter avoids expanding indigestible + % commands in some of the translations. + \gdef\noexpand\thischapter{\noexpand\putwordChapter{} + \noexpand\thischapternum: \noexpand\thischaptername}% }% \fi\fi\fi @@ -5190,7 +5725,7 @@ \domark % {% - \chapfonts \rm + \chapfonts \rmisbold % % Have to define \lastsection before calling \donoderef, because the % xref code eventually uses it. On the other hand, it has to be called @@ -5227,8 +5762,7 @@ % % Typeset the actual heading. \nobreak % Avoid page breaks at the interline glue. - \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright - \hangindent=\wd0 \centerparametersmaybe + \vbox{\raggedtitlesettings \hangindent=\wd0 \centerparametersmaybe \unhbox0 #1\par}% }% \nobreak\bigskip % no page break after a chapter title @@ -5250,18 +5784,18 @@ \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 + \chapoddpage + \vbox{\chapfonts \raggedtitlesettings #1\par}% + \nobreak\bigskip\nobreak } \def\chfopen #1#2{\chapoddpage {\chapfonts \vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% \par\penalty 5000 % } \def\centerchfopen #1{% -\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt - \hfill {\rm #1}\hfill}}\bigskip \par\nobreak + \chapoddpage + \vbox{\chapfonts \raggedtitlesettings \hfill #1\hfill}% + \nobreak\bigskip \nobreak } \def\CHAPFopen{% \global\let\chapmacro=\chfopen @@ -5293,8 +5827,10 @@ % \def\sectionheading#1#2#3#4{% {% + \checkenv{}% should not be in an environment. + % % Switch to the right set of fonts. - \csname #2fonts\endcsname \rm + \csname #2fonts\endcsname \rmisbold % \def\sectionlevel{#2}% \def\temptype{#3}% @@ -5314,7 +5850,10 @@ \xdef\lastsectiondefs{% \gdef\noexpand\thissectionname{\the\toks0}% \gdef\noexpand\thissectionnum{#4}% - \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum: + % \noexpand\putwordSection avoids expanding indigestible + % commands in some of the translations. + \gdef\noexpand\thissection{\noexpand\putwordSection{} + \noexpand\thissectionnum: \noexpand\thissectionname}% }% \fi @@ -5324,12 +5863,20 @@ \xdef\lastsectiondefs{% \gdef\noexpand\thissectionname{\the\toks0}% \gdef\noexpand\thissectionnum{#4}% - \gdef\noexpand\thissection{\putwordSection{} \noexpand\thissectionnum: + % \noexpand\putwordSection avoids expanding indigestible + % commands in some of the translations. + \gdef\noexpand\thissection{\noexpand\putwordSection{} + \noexpand\thissectionnum: \noexpand\thissectionname}% }% \fi \fi\fi\fi % + % Go into vertical mode. Usually we'll already be there, but we + % don't want the following whatsit to end up in a preceding paragraph + % if the document didn't happen to have a blank line. + \par + % % Output the mark. Pass it through \safewhatsit, to take care of % the preceding space. \safewhatsit\domark @@ -5379,7 +5926,7 @@ \nobreak % % Output the actual section heading. - \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright + \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \ptexraggedright \hangindent=\wd0 % zero if no section number \unhbox0 #1}% }% @@ -5393,15 +5940,15 @@ % % 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.) + % discardable item.) However, when a paragraph is not started next + % (\startdefun, \cartouche, \center, etc.), this needs to be wiped out + % or the negative glue will cause weirdly wrong output, typically + % obscuring the section heading with something else. \vskip-\parskip - % - % This is 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 + % + % This is so the last item on the main vertical list is a known + % \penalty > 10000, so \startdefun, etc., can recognize the situation + % and do the needful. \penalty 10001 } @@ -5457,7 +6004,7 @@ % These characters do not print properly in the Computer Modern roman % fonts, so we must take special care. This is more or less redundant % with the Texinfo input format setup at the end of this file. -% +% \def\activecatcodes{% \catcode`\"=\active \catcode`\$=\active @@ -5507,7 +6054,7 @@ % redefined for the two-volume lispref. We always output on % \jobname.toc even if this is redefined. -% +% \def\tocreadfilename{\jobname.toc} % Normal (long) toc. @@ -5533,6 +6080,7 @@ \def\summarycontents{% \startcontents{\putwordShortTOC}% % + \let\partentry = \shortpartentry \let\numchapentry = \shortchapentry \let\appentry = \shortchapentry \let\unnchapentry = \shortunnchapentry @@ -5588,6 +6136,19 @@ % The last argument is the page number. % The arguments in between are the chapter number, section number, ... +% Parts, in the main contents. Replace the part number, which doesn't +% exist, with an empty box. Let's hope all the numbers have the same width. +% Also ignore the page number, which is conventionally not printed. +\def\numeralbox{\setbox0=\hbox{8}\hbox to \wd0{\hfil}} +\def\partentry#1#2#3#4{\dochapentry{\numeralbox\labelspace#1}{}} +% +% Parts, in the short toc. +\def\shortpartentry#1#2#3#4{% + \penalty-300 + \vskip.5\baselineskip plus.15\baselineskip minus.1\baselineskip + \shortchapentry{{\bf #1}}{\numeralbox}{}{}% +} + % Chapters, in the main contents. \def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} % @@ -5677,46 +6238,12 @@ \message{environments,} % @foo ... @end foo. -% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. -% -% Since these characters are used in examples, they should be an even number of -% \tt widths. Each \tt character is 1en, so two makes it 1em. -% -\def\point{$\star$} -\def\arrow{\leavevmode\raise.05ex\hbox to 1em{\hfil$\rightarrow$\hfil}} -\def\result{\leavevmode\raise.05ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} -\def\expansion{\leavevmode\hbox to 1em{\hfil$\mapsto$\hfil}} -\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} -\def\equiv{\leavevmode\hbox to 1em{\hfil$\ptexequiv$\hfil}} - -% The @error{} command. -% Adapted from the TeXbook's \boxit. -% -\newbox\errorbox -% -{\tentt \global\dimen0 = 3em}% Width of the box. -\dimen2 = .55pt % Thickness of rules -% The text. (`r' is open on the right, `e' somewhat less so on the left.) -\setbox0 = \hbox{\kern-.75pt \reducedsf 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. +% @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. +% But \@ or @@ will get a plain @ character. \envdef\tex{% + \setupmarkupstyle{tex}% \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie @@ -5726,8 +6253,14 @@ \catcode `\|=\other \catcode `\<=\other \catcode `\>=\other + \catcode`\`=\other + \catcode`\'=\other \escapechar=`\\ % + % ' is active in math mode (mathcode"8000). So reset it, and all our + % other math active characters (just in case), to plain's definitions. + \mathactive + % \let\b=\ptexb \let\bullet=\ptexbullet \let\c=\ptexc @@ -5831,6 +6364,12 @@ \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip % Flag to tell @lisp, etc., not to narrow margin. \let\nonarrowing = t% + % + % If this cartouche directly follows a sectioning command, we need the + % \parskip glue (backspaced over by default) or the cartouche can + % collide with the section heading. + \ifnum\lastpenalty>10000 \vskip\parskip \penalty\lastpenalty \fi + % \vbox\bgroup \baselineskip=0pt\parskip=0pt\lineskip=0pt \carttop @@ -5844,7 +6383,7 @@ \lineskip=\normlskip \parskip=\normpskip \vskip -\parskip - \comment % For explanation, see the end of \def\group. + \comment % For explanation, see the end of def\group. } \def\Ecartouche{% \ifhmode\par\fi @@ -5861,14 +6400,20 @@ % This macro is called at the beginning of all the @example variants, % inside a group. +\newdimen\nonfillparindent \def\nonfillstart{% \aboveenvbreak - \hfuzz = 12pt % Don't be fussy + \ifdim\hfuzz < 12pt \hfuzz = 12pt \fi % Don't be fussy \sepspaces % Make spaces be word-separators rather than space tokens. \let\par = \lisppar % don't ignore blank lines \obeylines % each line of input is a line of output \parskip = 0pt + % Turn off paragraph indentation but redefine \indent to emulate + % the normal \indent. + \nonfillparindent=\parindent \parindent = 0pt + \let\indent\nonfillindent + % \emergencystretch = 0pt % don't try to avoid overfull boxes \ifx\nonarrowing\relax \advance \leftskip by \lispnarrowing @@ -5879,6 +6424,24 @@ \let\exdent=\nofillexdent } +\begingroup +\obeyspaces +% We want to swallow spaces (but not other tokens) after the fake +% @indent in our nonfill-environments, where spaces are normally +% active and set to @tie, resulting in them not being ignored after +% @indent. +\gdef\nonfillindent{\futurelet\temp\nonfillindentcheck}% +\gdef\nonfillindentcheck{% +\ifx\temp % +\expandafter\nonfillindentgobble% +\else% +\leavevmode\nonfillindentbox% +\fi% +}% +\endgroup +\def\nonfillindentgobble#1{\nonfillindent} +\def\nonfillindentbox{\hbox to \nonfillparindent{\hss}} + % If you want all examples etc. small: @set dispenvsize small. % If you want even small examples the full size: @set dispenvsize nosmall. % This affects the following displayed environments: @@ -5906,41 +6469,42 @@ } % 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} +% Let's do it in one command. #1 is the env name, #2 the definition. +\def\makedispenvdef#1#2{% + \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2}% + \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2}% \expandafter\let\csname E#1\endcsname \afterenvbreak \expandafter\let\csname Esmall#1\endcsname \afterenvbreak } -% Define two synonyms: -\def\maketwodispenvs #1#2#3{ - \makedispenv{#1}{#3} - \makedispenv{#2}{#3} -} - -% @lisp: indented, narrowed, typewriter font; @example: same as @lisp. +% Define two environment synonyms (#1 and #2) for an environment. +\def\maketwodispenvdef#1#2#3{% + \makedispenvdef{#1}{#3}% + \makedispenvdef{#2}{#3}% +} +% +% @lisp: indented, narrowed, typewriter font; +% @example: same as @lisp. % % @smallexample and @smalllisp: use smaller fonts. % Originally contributed by Pavel@xerox. % -\maketwodispenvs {lisp}{example}{% +\maketwodispenvdef{lisp}{example}{% \nonfillstart - \tt\quoteexpand + \tt\setupmarkupstyle{example}% \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. - \gobble % eat return + \gobble % eat return } % @display/@smalldisplay: same as @lisp except keep current font. % -\makedispenv {display}{% +\makedispenvdef{display}{% \nonfillstart \gobble } % @format/@smallformat: same as @display except don't narrow margins. % -\makedispenv{format}{% +\makedispenvdef{format}{% \let\nonarrowing = t% \nonfillstart \gobble @@ -5959,28 +6523,47 @@ \envdef\flushright{% \let\nonarrowing = t% \nonfillstart - \advance\leftskip by 0pt plus 1fill + \advance\leftskip by 0pt plus 1fill\relax \gobble } \let\Eflushright = \afterenvbreak +% @raggedright does more-or-less normal line breaking but no right +% justification. From plain.tex. +\envdef\raggedright{% + \rightskip0pt plus2em \spaceskip.3333em \xspaceskip.5em\relax +} +\let\Eraggedright\par + +\envdef\raggedleft{% + \parindent=0pt \leftskip0pt plus2em + \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt + \hbadness=10000 % Last line will usually be underfull, so turn off + % badness reporting. +} +\let\Eraggedleft\par + +\envdef\raggedcenter{% + \parindent=0pt \rightskip0pt plus1em \leftskip0pt plus1em + \spaceskip.3333em \xspaceskip.5em \parfillskip=0pt + \hbadness=10000 % Last line will usually be underfull, so turn off + % badness reporting. +} +\let\Eraggedcenter\par + + % @quotation does normal linebreaking (hence we can't use \nonfillstart) % and narrows the margins. We keep \parskip nonzero in general, since % we're doing normal filling. So, when using \aboveenvbreak and % \afterenvbreak, temporarily make \parskip 0. % -\envdef\quotation{% - {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip - \parindent=0pt - % - % @cartouche defines \nonarrowing to inhibit narrowing at next level down. +\makedispenvdef{quotation}{\quotationstart} +% +\def\quotationstart{% + \indentedblockstart % same as \indentedblock, but increase right margin too. \ifx\nonarrowing\relax - \advance\leftskip by \lispnarrowing \advance\rightskip by \lispnarrowing - \exdentamount = \lispnarrowing - \else - \let\nonarrowing = \relax \fi \parsearg\quotationlabel } @@ -5990,12 +6573,13 @@ % \def\Equotation{% \par - \ifx\quotationauthor\undefined\else + \ifx\quotationauthor\thisisundefined\else % indent a bit. \leftline{\kern 2\leftskip \sl ---\quotationauthor}% \fi {\parskip=0pt \afterenvbreak}% } +\def\Esmallquotation{\Equotation} % If we're given an argument, typeset it in bold with a colon after. \def\quotationlabel#1{% @@ -6005,6 +6589,32 @@ \fi } +% @indentedblock is like @quotation, but indents only on the left and +% has no optional argument. +% +\makedispenvdef{indentedblock}{\indentedblockstart} +% +\def\indentedblockstart{% + {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip + \parindent=0pt + % + % @cartouche defines \nonarrowing to inhibit narrowing at next level down. + \ifx\nonarrowing\relax + \advance\leftskip by \lispnarrowing + \exdentamount = \lispnarrowing + \else + \let\nonarrowing = \relax + \fi +} + +% Keep a nonzero parskip for the environment, since we're doing normal filling. +% +\def\Eindentedblock{% + \par + {\parskip=0pt \afterenvbreak}% +} +\def\Esmallindentedblock{\Eindentedblock} + % LaTeX-like @verbatim...@end verbatim and @verb{<char>...<char>} % If we want to allow any <char> as delimiter, @@ -6020,18 +6630,16 @@ \do\ \do\\\do\{\do\}\do\$\do\&% \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% \do\<\do\>\do\|\do\@\do+\do\"% + % Don't do the quotes -- if we do, @set txicodequoteundirected and + % @set txicodequotebacktick will not have effect on @verb and + % @verbatim, and ?` and !` ligatures won't get disabled. + %\do\`\do\'% } % % [Knuth] p. 380 \def\uncatcodespecials{% \def\do##1{\catcode`##1=\other}\dospecials} % -% [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 @@ -6043,7 +6651,7 @@ \def\setupverb{% \tt % easiest (and conventionally used) font for verbatim \def\par{\leavevmode\endgraf}% - \catcode`\`=\active + \setupmarkupstyle{verb}% \tabeightspaces % Respect line breaks, % print special symbols as themselves, and @@ -6054,73 +6662,46 @@ % Setup for the @verbatim environment % -% Real tab expansion +% Real tab expansion. \newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount % -\def\starttabbox{\setbox0=\hbox\bgroup} - -% Allow an option to not replace quotes with a regular directed right -% quote/apostrophe (char 0x27), but instead use the undirected quote -% from cmtt (char 0x0d). The undirected quote is ugly, so don't make it -% the default, but it works for pasting with more pdf viewers (at least -% evince), the lilypond developers report. xpdf does work with the -% regular 0x27. -% -\def\codequoteright{% - \expandafter\ifx\csname SETtxicodequoteundirected\endcsname\relax - \expandafter\ifx\csname SETcodequoteundirected\endcsname\relax - '% - \else \char'15 \fi - \else \char'15 \fi -} -% -% and a similar option for the left quote char vs. a grave accent. -% Modern fonts display ASCII 0x60 as a grave accent, so some people like -% the code environments to do likewise. -% -\def\codequoteleft{% - \expandafter\ifx\csname SETtxicodequotebacktick\endcsname\relax - \expandafter\ifx\csname SETcodequotebacktick\endcsname\relax - `% - \else \char'22 \fi - \else \char'22 \fi -} +% We typeset each line of the verbatim in an \hbox, so we can handle +% tabs. The \global is in case the verbatim line starts with an accent, +% or some other command that starts with a begin-group. Otherwise, the +% entire \verbbox would disappear at the corresponding end-group, before +% it is typeset. Meanwhile, we can't have nested verbatim commands +% (can we?), so the \global won't be overwriting itself. +\newbox\verbbox +\def\starttabbox{\global\setbox\verbbox=\hbox\bgroup} % \begingroup \catcode`\^^I=\active \gdef\tabexpand{% \catcode`\^^I=\active \def^^I{\leavevmode\egroup - \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 + \dimen\verbbox=\wd\verbbox % the width so far, or since the previous tab + \divide\dimen\verbbox by\tabw + \multiply\dimen\verbbox by\tabw % compute previous multiple of \tabw + \advance\dimen\verbbox by\tabw % advance to next multiple of \tabw + \wd\verbbox=\dimen\verbbox \box\verbbox \starttabbox }% } - \catcode`\'=\active - \gdef\rquoteexpand{\catcode\rquoteChar=\active \def'{\codequoteright}}% - % - \catcode`\`=\active - \gdef\lquoteexpand{\catcode\lquoteChar=\active \def`{\codequoteleft}}% - % - \gdef\quoteexpand{\rquoteexpand \lquoteexpand}% \endgroup % start the verbatim environment. \def\setupverbatim{% \let\nonarrowing = t% \nonfillstart - % Easiest (and conventionally used) font for verbatim - \tt - \def\par{\leavevmode\egroup\box0\endgraf}% - \catcode`\`=\active + \tt % easiest (and conventionally used) font for verbatim + % The \leavevmode here is for blank lines. Otherwise, we would + % never \starttabox and the \egroup would end verbatim mode. + \def\par{\leavevmode\egroup\box\verbbox\endgraf}% \tabexpand - \quoteexpand + \setupmarkupstyle{verbatim}% % Respect line breaks, % print special symbols as themselves, and - % make each space count - % must do in this order: + % make each space count. + % Must do in this order: \obeylines \uncatcodespecials \sepspaces \everypar{\starttabbox}% } @@ -6176,6 +6757,8 @@ {% \makevalueexpandable \setupverbatim + \indexnofonts % Allow `@@' and other weird things in file names. + \wlog{texinfo.tex: doing @verbatiminclude of #1^^J}% \input #1 \afterenvbreak }% @@ -6225,7 +6808,7 @@ % commands also insert a nobreak penalty, and we don't want to allow % a break between a section heading and a defun. % - % As a minor refinement, we avoid "club" headers by signalling + % As a further refinement, we avoid "club" headers by signalling % with penalty of 10003 after the very first @deffn in the % sequence (see above), and penalty of 10002 after any following % @def command. @@ -6262,7 +6845,7 @@ #1#2 \endheader % common ending: \interlinepenalty = 10000 - \advance\rightskip by 0pt plus 1fil + \advance\rightskip by 0pt plus 1fil\relax \endgraf \nobreak\vskip -\parskip \penalty\defunpenalty % signal to \startdefun and \dodefunx @@ -6292,13 +6875,36 @@ \def\domakedefun#1#2#3{% \envdef#1{% \startdefun + \doingtypefnfalse % distinguish typed functions from all else \parseargusing\activeparens{\printdefunline#3}% }% \def#2{\dodefunx#1}% \def#3% } -%%% Untyped functions: +\newif\ifdoingtypefn % doing typed function? +\newif\ifrettypeownline % typeset return type on its own line? + +% @deftypefnnewline on|off says whether the return type of typed functions +% are printed on their own line. This affects @deftypefn, @deftypefun, +% @deftypeop, and @deftypemethod. +% +\parseargdef\deftypefnnewline{% + \def\temp{#1}% + \ifx\temp\onword + \expandafter\let\csname SETtxideftypefnnl\endcsname + = \empty + \else\ifx\temp\offword + \expandafter\let\csname SETtxideftypefnnl\endcsname + = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @txideftypefnnl value `\temp', + must be on|off}% + \fi\fi +} + +% Untyped functions: % @deffn category name args \makedefun{deffn}{\deffngeneral{}} @@ -6317,7 +6923,7 @@ \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% } -%%% Typed functions: +% Typed functions: % @deftypefn category type name args \makedefun{deftypefn}{\deftypefngeneral{}} @@ -6332,10 +6938,11 @@ % \def\deftypefngeneral#1#2 #3 #4 #5\endheader{% \dosubind{fn}{\code{#4}}{#1}% + \doingtypefntrue \defname{#2}{#3}{#4}\defunargs{#5\unskip}% } -%%% Typed variables: +% Typed variables: % @deftypevr category type var args \makedefun{deftypevr}{\deftypecvgeneral{}} @@ -6353,7 +6960,7 @@ \defname{#2}{#3}{#4}\defunargs{#5\unskip}% } -%%% Untyped variables: +% Untyped variables: % @defvr category var args \makedefun{defvr}#1 {\deftypevrheader{#1} {} } @@ -6364,7 +6971,8 @@ % \defcvof {category of}class var args \def\defcvof#1#2 {\deftypecvof{#1}#2 {} } -%%% Type: +% Types: + % @deftp category name args \makedefun{deftp}#1 #2 #3\endheader{% \doind{tp}{\code{#2}}% @@ -6392,25 +7000,49 @@ % We are followed by (but not passed) the arguments, if any. % \def\defname#1#2#3{% + \par % Get the values of \leftskip and \rightskip as they were outside the @def... \advance\leftskip by -\defbodyindent % - % How we'll format the type name. Putting it in brackets helps + % Determine if we are typesetting the return type of a typed function + % on a line by itself. + \rettypeownlinefalse + \ifdoingtypefn % doing a typed function specifically? + % then check user option for putting return type on its own line: + \expandafter\ifx\csname SETtxideftypefnnl\endcsname\relax \else + \rettypeownlinetrue + \fi + \fi + % + % How we'll format the category name. Putting it in brackets helps % distinguish it from the body text that may end up on the next line % just below it. \def\temp{#1}% \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi} % - % Figure out line sizes for the paragraph shape. + % Figure out line sizes for the paragraph shape. We'll always have at + % least two. + \tempnum = 2 + % % The first line needs space for \box0; but if \rightskip is nonzero, % we need only space for the part of \box0 which exceeds it: \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip + % + % If doing a return type on its own line, we'll have another line. + \ifrettypeownline + \advance\tempnum by 1 + \def\maybeshapeline{0in \hsize}% + \else + \def\maybeshapeline{}% + \fi + % % The continuations: \dimen2=\hsize \advance\dimen2 by -\defargsindent - % (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. + % + % The final paragraph shape: + \parshape \tempnum 0in \dimen0 \maybeshapeline \defargsindent \dimen2 + % + % Put the category name at the right margin. \noindent \hbox to 0pt{% \hfil\box0 \kern-\hsize @@ -6432,8 +7064,16 @@ % . 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 + \def\temp{#2}% text of the return type + \ifx\temp\empty\else + \tclose{\temp}% typeset the return type + \ifrettypeownline + % put return type on its own line; prohibit line break following: + \hfil\vadjust{\nobreak}\break + \else + \space % type on same line, so just followed by a space + \fi + \fi % no return type #3% output function name }% {\rm\enskip}% hskip 0.5 em of \tenrm @@ -6453,8 +7093,11 @@ \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 + % want a way to get ttsl. We used to recommend @var for that, so + % leave the code in, but it's strange for @var to lead to typewriter. + % Nowadays we recommend @code, since the difference between a ttsl hyphen + % and a tt hyphen is pretty tiny. @code also disables ?` !`. + \def\var##1{{\setupmarkupstyle{var}\ttslanted{##1}}}% #1% \sl\hyphenchar\font=45 } @@ -6551,7 +7194,7 @@ % 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 +\ifx\eTeXversion\thisisundefined \newwrite\macscribble \def\scantokens#1{% \toks0={#1}% @@ -6562,25 +7205,30 @@ } \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\scanmacro#1{\begingroup + \newlinechar`\^^M + \let\xeatspaces\eatspaces + % + % Undo catcode changes of \startcontents and \doprintindex + % When called from @insertcopying or (short)caption, we need active + % backslash to get it printed correctly. Previously, we had + % \catcode`\\=\other instead. We'll see whether a problem appears + % with macro expansion. --kasal, 19aug04 + \catcode`\@=0 \catcode`\\=\active \escapechar=`\@ + % + % ... and for \example: + \spaceisspace + % + % The \empty here causes a following catcode 5 newline to be eaten as + % part of reading whitespace after a control sequence. It does not + % eat a catcode 13 newline. There's no good way to handle the two + % cases (untried: maybe e-TeX's \everyeof could help, though plain TeX + % would then have different behavior). See the Macro Details node in + % the manual for the workaround we recommend for macros and + % line-oriented commands. + % + \scantokens{#1\empty}% +\endgroup} \def\scanexp#1{% \edef\temp{\noexpand\scanmacro{#1}}% @@ -6608,7 +7256,7 @@ % 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 @@ -6634,17 +7282,18 @@ % 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 \. - +% (as in normal texinfo). It is necessary to change the definition of \ +% to recognize macro arguments; this is the job of \mbodybackslash. +% % Non-ASCII encodings make 8-bit characters active, so un-activate % them to avoid their expansion. Must do this non-globally, to % confine the change to the current group. - +% % It's necessary to have hard CRs when the macro is executed. This is -% done by making ^^M (\endlinechar) catcode 12 when reading the macro +% done by making ^^M (\endlinechar) catcode 12 when reading the macro % body, and then making it the \newlinechar in \scanmacro. - -\def\scanctxt{% +% +\def\scanctxt{% used as subroutine \catcode`\"=\other \catcode`\+=\other \catcode`\<=\other @@ -6657,13 +7306,13 @@ \ifx\declaredencoding\ascii \else \setnonasciicharscatcodenonglobal\other \fi } -\def\scanargctxt{% +\def\scanargctxt{% used for copying and captions, not macros. \scanctxt \catcode`\\=\other \catcode`\^^M=\other } -\def\macrobodyctxt{% +\def\macrobodyctxt{% used for @macro definitions \scanctxt \catcode`\{=\other \catcode`\}=\other @@ -6671,32 +7320,56 @@ \usembodybackslash } -\def\macroargctxt{% +\def\macroargctxt{% used when scanning invocations \scanctxt - \catcode`\\=\other -} + \catcode`\\=0 +} +% why catcode 0 for \ in the above? To recognize \\ \{ \} as "escapes" +% for the single characters \ { }. Thus, we end up with the "commands" +% that would be written @\ @{ @} in a Texinfo document. +% +% We already have @{ and @}. For @\, we define it here, and only for +% this purpose, to produce a typewriter backslash (so, the @\ that we +% define for @math can't be used with @macro calls): +% +\def\\{\normalbackslash}% +% +% We would like to do this for \, too, since that is what makeinfo does. +% But it is not possible, because Texinfo already has a command @, for a +% cedilla accent. Documents must use @comma{} instead. +% +% \anythingelse will almost certainly be an error of some kind. + % \mbodybackslash is the definition of \ in @macro bodies. % It maps \foo\ => \csname macarg.foo\endcsname => #N % where N is the macro parameter number. % We define \csname macarg.\endcsname to be \realbackslash, so % \\ in macro replacement text gets you a backslash. - +% {\catcode`@=0 @catcode`@\=@active @gdef@usembodybackslash{@let\=@mbodybackslash} @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} } \expandafter\def\csname macarg.\endcsname{\realbackslash} +\def\margbackslash#1{\char`\#1 } + \def\macro{\recursivefalse\parsearg\macroxxx} \def\rmacro{\recursivetrue\parsearg\macroxxx} \def\macroxxx#1{% - \getargs{#1}% now \macname is the macname and \argl the arglist + \getargs{#1}% now \macname is the macname and \argl the arglist \ifx\argl\empty % no arguments - \paramno=0% + \paramno=0\relax \else \expandafter\parsemargdef \argl;% + \if\paramno>256\relax + \ifx\eTeXversion\thisisundefined + \errhelp = \EMsimple + \errmessage{You need eTeX to compile a file with macros with more than 256 arguments} + \fi + \fi \fi \if1\csname ismacro.\the\macname\endcsname \message{Warning: redefining \the\macname}% @@ -6743,46 +7416,269 @@ % 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\getmacname#1 #2\relax{\macname={#1}} \def\getmacargs#1{\def\argl{#1}} +% For macro processing make @ a letter so that we can make Texinfo private macro names. +\edef\texiatcatcode{\the\catcode`\@} +\catcode `@=11\relax + % Parse the optional {params} list. Set up \paramno and \paramlist -% so \defmacro knows what to do. Define \macarg.blah for each blah -% in the params list, to be ##N where N is the position in that list. +% so \defmacro knows what to do. Define \macarg.BLAH for each BLAH +% in the params list to some hook where the argument si to be expanded. If +% there are less than 10 arguments that hook is to be replaced by ##N where N +% is the position in that list, that is to say the macro arguments are to be +% defined `a la TeX in the macro body. +% % That gets used by \mbodybackslash (above). - +% % We need to get `macro parameter char #' into several definitions. -% The technique used is stolen from LaTeX: let \hash be something +% 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,;,} +% +% If there are 10 or more arguments, a different technique is used, where the +% hook remains in the body, and when macro is to be expanded the body is +% processed again to replace the arguments. +% +% In that case, the hook is \the\toks N-1, and we simply set \toks N-1 to the +% argument N value and then \edef the body (nothing else will expand because of +% the catcode regime underwhich the body was input). +% +% If you compile with TeX (not eTeX), and you have macros with 10 or more +% arguments, you need that no macro has more than 256 arguments, otherwise an +% error is produced. +\def\parsemargdef#1;{% + \paramno=0\def\paramlist{}% + \let\hash\relax + \let\xeatspaces\relax + \parsemargdefxxx#1,;,% + % In case that there are 10 or more arguments we parse again the arguments + % list to set new definitions for the \macarg.BLAH macros corresponding to + % each BLAH argument. It was anyhow needed to parse already once this list + % in order to count the arguments, and as macros with at most 9 arguments + % are by far more frequent than macro with 10 or more arguments, defining + % twice the \macarg.BLAH macros does not cost too much processing power. + \ifnum\paramno<10\relax\else + \paramno0\relax + \parsemmanyargdef@@#1,;,% 10 or more arguments + \fi +} \def\parsemargdefxxx#1,{% \if#1;\let\next=\relax \else \let\next=\parsemargdefxxx - \advance\paramno by 1% + \advance\paramno by 1 \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname {\xeatspaces{\hash\the\paramno}}% \edef\paramlist{\paramlist\hash\the\paramno,}% \fi\next} +\def\parsemmanyargdef@@#1,{% + \if#1;\let\next=\relax + \else + \let\next=\parsemmanyargdef@@ + \edef\tempb{\eatspaces{#1}}% + \expandafter\def\expandafter\tempa + \expandafter{\csname macarg.\tempb\endcsname}% + % Note that we need some extra \noexpand\noexpand, this is because we + % don't want \the to be expanded in the \parsermacbody as it uses an + % \xdef . + \expandafter\edef\tempa + {\noexpand\noexpand\noexpand\the\toks\the\paramno}% + \advance\paramno by 1\relax + \fi\next} + % These two commands read recursive and nonrecursive macro bodies. % (They're different since rec and nonrec macros end differently.) - +% + +\catcode `\@\texiatcatcode \long\def\parsemacbody#1@end macro% {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% \long\def\parsermacbody#1@end rmacro% {\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% - -% This defines the macro itself. There are six cases: recursive and -% nonrecursive macros of zero, one, and many arguments. +\catcode `\@=11\relax + +\let\endargs@\relax +\let\nil@\relax +\def\nilm@{\nil@}% +\long\def\nillm@{\nil@}% + +% This macro is expanded during the Texinfo macro expansion, not during its +% definition. It gets all the arguments values and assigns them to macros +% macarg.ARGNAME +% +% #1 is the macro name +% #2 is the list of argument names +% #3 is the list of argument values +\def\getargvals@#1#2#3{% + \def\macargdeflist@{}% + \def\saveparamlist@{#2}% Need to keep a copy for parameter expansion. + \def\paramlist{#2,\nil@}% + \def\macroname{#1}% + \begingroup + \macroargctxt + \def\argvaluelist{#3,\nil@}% + \def\@tempa{#3}% + \ifx\@tempa\empty + \setemptyargvalues@ + \else + \getargvals@@ + \fi +} + +% +\def\getargvals@@{% + \ifx\paramlist\nilm@ + % Some sanity check needed here that \argvaluelist is also empty. + \ifx\argvaluelist\nillm@ + \else + \errhelp = \EMsimple + \errmessage{Too many arguments in macro `\macroname'!}% + \fi + \let\next\macargexpandinbody@ + \else + \ifx\argvaluelist\nillm@ + % No more arguments values passed to macro. Set remaining named-arg + % macros to empty. + \let\next\setemptyargvalues@ + \else + % pop current arg name into \@tempb + \def\@tempa##1{\pop@{\@tempb}{\paramlist}##1\endargs@}% + \expandafter\@tempa\expandafter{\paramlist}% + % pop current argument value into \@tempc + \def\@tempa##1{\longpop@{\@tempc}{\argvaluelist}##1\endargs@}% + \expandafter\@tempa\expandafter{\argvaluelist}% + % Here \@tempb is the current arg name and \@tempc is the current arg value. + % First place the new argument macro definition into \@tempd + \expandafter\macname\expandafter{\@tempc}% + \expandafter\let\csname macarg.\@tempb\endcsname\relax + \expandafter\def\expandafter\@tempe\expandafter{% + \csname macarg.\@tempb\endcsname}% + \edef\@tempd{\long\def\@tempe{\the\macname}}% + \push@\@tempd\macargdeflist@ + \let\next\getargvals@@ + \fi + \fi + \next +} + +\def\push@#1#2{% + \expandafter\expandafter\expandafter\def + \expandafter\expandafter\expandafter#2% + \expandafter\expandafter\expandafter{% + \expandafter#1#2}% +} + +% Replace arguments by their values in the macro body, and place the result +% in macro \@tempa +\def\macvalstoargs@{% + % To do this we use the property that token registers that are \the'ed + % within an \edef expand only once. So we are going to place all argument + % values into respective token registers. + % + % First we save the token context, and initialize argument numbering. + \begingroup + \paramno0\relax + % Then, for each argument number #N, we place the corresponding argument + % value into a new token list register \toks#N + \expandafter\putargsintokens@\saveparamlist@,;,% + % Then, we expand the body so that argument are replaced by their + % values. The trick for values not to be expanded themselves is that they + % are within tokens and that tokens expand only once in an \edef . + \edef\@tempc{\csname mac.\macroname .body\endcsname}% + % Now we restore the token stack pointer to free the token list registers + % which we have used, but we make sure that expanded body is saved after + % group. + \expandafter + \endgroup + \expandafter\def\expandafter\@tempa\expandafter{\@tempc}% + } + +\def\macargexpandinbody@{% + %% Define the named-macro outside of this group and then close this group. + \expandafter + \endgroup + \macargdeflist@ + % First the replace in body the macro arguments by their values, the result + % is in \@tempa . + \macvalstoargs@ + % Then we point at the \norecurse or \gobble (for recursive) macro value + % with \@tempb . + \expandafter\let\expandafter\@tempb\csname mac.\macroname .recurse\endcsname + % Depending on whether it is recursive or not, we need some tailing + % \egroup . + \ifx\@tempb\gobble + \let\@tempc\relax + \else + \let\@tempc\egroup + \fi + % And now we do the real job: + \edef\@tempd{\noexpand\@tempb{\macroname}\noexpand\scanmacro{\@tempa}\@tempc}% + \@tempd +} + +\def\putargsintokens@#1,{% + \if#1;\let\next\relax + \else + \let\next\putargsintokens@ + % First we allocate the new token list register, and give it a temporary + % alias \@tempb . + \toksdef\@tempb\the\paramno + % Then we place the argument value into that token list register. + \expandafter\let\expandafter\@tempa\csname macarg.#1\endcsname + \expandafter\@tempb\expandafter{\@tempa}% + \advance\paramno by 1\relax + \fi + \next +} + +% Save the token stack pointer into macro #1 +\def\texisavetoksstackpoint#1{\edef#1{\the\@cclvi}} +% Restore the token stack pointer from number in macro #1 +\def\texirestoretoksstackpoint#1{\expandafter\mathchardef\expandafter\@cclvi#1\relax} +% newtoks that can be used non \outer . +\def\texinonouternewtoks{\alloc@ 5\toks \toksdef \@cclvi} + +% Tailing missing arguments are set to empty +\def\setemptyargvalues@{% + \ifx\paramlist\nilm@ + \let\next\macargexpandinbody@ + \else + \expandafter\setemptyargvaluesparser@\paramlist\endargs@ + \let\next\setemptyargvalues@ + \fi + \next +} + +\def\setemptyargvaluesparser@#1,#2\endargs@{% + \expandafter\def\expandafter\@tempa\expandafter{% + \expandafter\def\csname macarg.#1\endcsname{}}% + \push@\@tempa\macargdeflist@ + \def\paramlist{#2}% +} + +% #1 is the element target macro +% #2 is the list macro +% #3,#4\endargs@ is the list value +\def\pop@#1#2#3,#4\endargs@{% + \def#1{#3}% + \def#2{#4}% +} +\long\def\longpop@#1#2#3,#4\endargs@{% + \long\def#1{#3}% + \long\def#2{#4}% +} + +% This defines a Texinfo @macro. There are eight cases: recursive and +% nonrecursive macros of zero, one, up to nine, and many arguments. % Much magic with \expandafter here. % \xdef is used so that macro definitions will survive the file % they're defined in; @include reads the file inside a group. +% \def\defmacro{% \let\hash=##% convert placeholders to macro parameter chars \ifrecursive @@ -6797,17 +7693,25 @@ \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}}% + \else + \ifnum\paramno<10\relax % at most 9 + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \noexpand\csname\the\macname xx\endcsname}% + \expandafter\xdef\csname\the\macname xx\endcsname##1{% + \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% + \expandafter\expandafter + \expandafter\xdef + \expandafter\expandafter + \csname\the\macname xxx\endcsname + \paramlist{\egroup\noexpand\scanmacro{\temp}}% + \else % 10 or more + \expandafter\xdef\csname\the\macname\endcsname{% + \noexpand\getargvals@{\the\macname}{\argl}% + }% + \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp + \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\gobble + \fi \fi \else \ifcase\paramno @@ -6824,29 +7728,40 @@ \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}% + \else % at most 9 + \ifnum\paramno<10\relax + \expandafter\xdef\csname\the\macname\endcsname{% + \bgroup\noexpand\macroargctxt + \expandafter\noexpand\csname\the\macname xx\endcsname}% + \expandafter\xdef\csname\the\macname xx\endcsname##1{% + \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% + \expandafter\expandafter + \expandafter\xdef + \expandafter\expandafter + \csname\the\macname xxx\endcsname + \paramlist{% + \egroup + \noexpand\norecurse{\the\macname}% + \noexpand\scanmacro{\temp}\egroup}% + \else % 10 or more: + \expandafter\xdef\csname\the\macname\endcsname{% + \noexpand\getargvals@{\the\macname}{\argl}% + }% + \global\expandafter\let\csname mac.\the\macname .body\endcsname\temp + \global\expandafter\let\csname mac.\the\macname .recurse\endcsname\norecurse + \fi \fi \fi} +\catcode `\@\texiatcatcode\relax + \def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} % \braceorline decides whether the next nonwhitespace character is a % {. If so it reads up to the closing }, if not, it reads the whole % line. Whatever was read is then fed to the next control sequence -% as an argument (by \parsebrace or \parsearg) +% as an argument (by \parsebrace or \parsearg). +% \def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx} \def\braceorlinexxx{% \ifx\nchar\bgroup\else @@ -6856,7 +7771,8 @@ % @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. +% sign. Make them active and then expand them all to nothing. +% \def\alias{\parseargusing\obeyspaces\aliasxxx} \def\aliasxxx #1{\aliasyyy#1\relax} \def\aliasyyy #1=#2\relax{% @@ -6877,7 +7793,8 @@ % @inforef is relatively simple. \def\inforef #1{\inforefzzz #1,,,,**} -\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, +\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 @@ -6938,11 +7855,32 @@ \toks0 = \expandafter{\lastsection}% \immediate \writexrdef{title}{\the\toks0 }% \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. - \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, during \shipout + \safewhatsit{\writexrdef{pg}{\folio}}% will be written later, at \shipout }% \fi } +% @xrefautosectiontitle on|off says whether @section(ing) names are used +% automatically in xrefs, if the third arg is not explicitly specified. +% This was provided as a "secret" @set xref-automatic-section-title +% variable, now it's official. +% +\parseargdef\xrefautomaticsectiontitle{% + \def\temp{#1}% + \ifx\temp\onword + \expandafter\let\csname SETxref-automatic-section-title\endcsname + = \empty + \else\ifx\temp\offword + \expandafter\let\csname SETxref-automatic-section-title\endcsname + = \relax + \else + \errhelp = \EMsimple + \errmessage{Unknown @xrefautomaticsectiontitle value `\temp', + must be on|off}% + \fi\fi +} + +% % @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is % the node name, #2 the name of the Info cross-reference, #3 the printed % node name, #4 the name of the Info file, #5 the name of the printed @@ -6951,26 +7889,41 @@ \def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} \def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} \def\ref#1{\xrefX[#1,,,,,,,]} +% +\newbox\toprefbox +\newbox\printedrefnamebox +\newbox\infofilenamebox +\newbox\printedmanualbox +% \def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup \unsepspaces - \def\printedmanual{\ignorespaces #5}% + % + % Get args without leading/trailing spaces. \def\printedrefname{\ignorespaces #3}% - \setbox1=\hbox{\printedmanual\unskip}% - \setbox0=\hbox{\printedrefname\unskip}% - \ifdim \wd0 = 0pt + \setbox\printedrefnamebox = \hbox{\printedrefname\unskip}% + % + \def\infofilename{\ignorespaces #4}% + \setbox\infofilenamebox = \hbox{\infofilename\unskip}% + % + \def\printedmanual{\ignorespaces #5}% + \setbox\printedmanualbox = \hbox{\printedmanual\unskip}% + % + % If the printed reference name (arg #3) was not explicitly given in + % the @xref, figure out what we want to use. + \ifdim \wd\printedrefnamebox = 0pt % No printed node name was explicitly given. - \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax - % Use the node name inside the square brackets. + \expandafter\ifx\csname SETxref-automatic-section-title\endcsname \relax + % Not auto section-title: use node name inside the square brackets. \def\printedrefname{\ignorespaces #1}% \else - % 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. + % Auto section-title: use chapter/section title inside + % the square brackets if we have it. + \ifdim \wd\printedmanualbox > 0pt + % It is in another manual, so we don't have it; use node name. \def\printedrefname{\ignorespaces #1}% \else \ifhavexrefs - % We know the real title if we have the xref values. + % We (should) know the real title if we have the xref values. \def\printedrefname{\refx{#1-title}{}}% \else % Otherwise just copy the Info node name. @@ -6984,13 +7937,20 @@ \ifpdf {\indexnofonts \turnoffactive + \makevalueexpandable % This expands tokens, so do it after making catcode changes, so _ - % etc. don't get their TeX definitions. + % etc. don't get their TeX definitions. This ignores all spaces in + % #4, including (wrongly) those in the middle of the filename. \getfilename{#4}% % - % See comments at \activebackslashdouble. - {\activebackslashdouble \xdef\pdfxrefdest{#1}% - \backslashparens\pdfxrefdest}% + % This (wrongly) does not take account of leading or trailing + % spaces in #1, which should be ignored. + \edef\pdfxrefdest{#1}% + \ifx\pdfxrefdest\empty + \def\pdfxrefdest{Top}% no empty targets + \else + \txiescapepdf\pdfxrefdest % escape PDF special chars + \fi % \leavevmode \startlink attr{/Border [0 0 0]}% @@ -7017,29 +7977,42 @@ \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 + \ifdim\wd\printedrefnamebox = 0pt \refx{#1-snt}{}% \else \printedrefname \fi % - % if the user also gave the printed manual name (fifth arg), append + % If the user also gave the printed manual name (fifth arg), append % "in MANUALNAME". - \ifdim \wd1 > 0pt + \ifdim \wd\printedmanualbox > 0pt \space \putwordin{} \cite{\printedmanual}% \fi \else % node/anchor (non-float) references. + % + % If we use \unhbox to print the node names, TeX does not insert + % empty discretionaries after hyphens, which means that it will not + % find a line break at a hyphen in a node names. Since some manuals + % are best written with fairly long node names, containing hyphens, + % this is a loss. Therefore, we give the text of the node name + % again, so it is as if TeX is seeing it for the first time. + % + \ifdim \wd\printedmanualbox > 0pt + % Cross-manual reference with a printed manual name. + % + \crossmanualxref{\cite{\printedmanual\unskip}}% % - % 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\ifdim \wd\infofilenamebox > 0pt + % Cross-manual reference with only an info filename (arg 4), no + % printed manual name (arg 5). This is essentially the same as + % the case above; we output the filename, since we have nothing else. + % + \crossmanualxref{\code{\infofilename\unskip}}% + % \else + % Reference within this manual. + % % _ (for example) has to be the character _ for the purposes of the % control sequence corresponding to the node, but it has to expand % into the usual \leavevmode...\vrule stuff for purposes of @@ -7051,7 +8024,7 @@ \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. + % output the `[mynode]' via the macro below so it can be overridden. \xrefprintnodename\printedrefname % % But we always want a comma and a space: @@ -7059,11 +8032,37 @@ % % output the `page 3'. \turnoffactive \putwordpage\tie\refx{#1-pg}{}% - \fi + \fi\fi \fi \endlink \endgroup} +% Output a cross-manual xref to #1. Used just above (twice). +% +% Only include the text "Section ``foo'' in" if the foo is neither +% missing or Top. Thus, @xref{,,,foo,The Foo Manual} outputs simply +% "see The Foo Manual", the idea being to refer to the whole manual. +% +% But, this being TeX, we can't easily compare our node name against the +% string "Top" while ignoring the possible spaces before and after in +% the input. By adding the arbitrary 7sp below, we make it much less +% likely that a real node name would have the same width as "Top" (e.g., +% in a monospaced font). Hopefully it will never happen in practice. +% +% For the same basic reason, we retypeset the "Top" at every +% reference, since the current font is indeterminate. +% +\def\crossmanualxref#1{% + \setbox\toprefbox = \hbox{Top\kern7sp}% + \setbox2 = \hbox{\ignorespaces \printedrefname \unskip \kern7sp}% + \ifdim \wd2 > 7sp % nonempty? + \ifdim \wd2 = \wd\toprefbox \else % same as Top? + \putwordSection{} ``\printedrefname'' \putwordin{}\space + \fi + \fi + #1% +} + % This macro is called from \xrefX for the `[nodename]' part of xref % output. It's a separate macro only so it can be changed more easily, % since square brackets don't work well in some documents. Particularly @@ -7114,7 +8113,8 @@ \angleleft un\-de\-fined\angleright \iflinks \ifhavexrefs - \message{\linenumber Undefined cross reference `#1'.}% + {\toks0 = {#1}% avoid expansion of possibly-complex value + \message{\linenumber Undefined cross reference `\the\toks0'.}}% \else \ifwarnedxrefs\else \global\warnedxrefstrue @@ -7278,7 +8278,7 @@ % space to prevent strange expansion errors.) \def\supereject{\par\penalty -20000\footnoteno =0 } -% @footnotestyle is meaningful for info output only. +% @footnotestyle is meaningful for Info output only. \let\footnotestyle=\comment {\catcode `\@=11 @@ -7341,6 +8341,8 @@ % expands into a box, it must come within the paragraph, lest it % provide a place where TeX can split the footnote. \footstrut + % + % Invoke rest of plain TeX footnote routine. \futurelet\next\fo@t } }%end \catcode `\@=11 @@ -7428,7 +8430,7 @@ it from ftp://tug.org/tex/epsf.tex.} % \def\image#1{% - \ifx\epsfbox\undefined + \ifx\epsfbox\thisisundefined \ifwarnednoepsf \else \errhelp = \noepsfhelp \errmessage{epsf.tex not found, images will be ignored}% @@ -7444,7 +8446,7 @@ % #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. +% #6 is just the usual extra ignored arg for parsing stuff. \newif\ifimagevmode \def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup \catcode`\^^M = 5 % in case we're inside an example @@ -7452,6 +8454,13 @@ % If the image is by itself, center it. \ifvmode \imagevmodetrue + \else \ifx\centersub\centerV + % for @center @image, we need a vbox so we can have our vertical space + \imagevmodetrue + \vbox\bgroup % vbox has better behavior than vtop herev + \fi\fi + % + \ifimagevmode \nobreak\medskip % Usually we'll have text after the image which will insert % \parskip glue, so insert it here too to equalize the space @@ -7461,9 +8470,13 @@ \fi % % Leave vertical mode so that indentation from an enclosing - % environment such as @quotation is respected. On the other hand, if - % it's at the top level, we don't want the normal paragraph indentation. - \noindent + % environment such as @quotation is respected. + % However, if we're at the top level, we don't want the + % normal paragraph indentation. + % On the other hand, if we are in the case of @center @image, we don't + % want to start a paragraph, which will create a hsize-width box and + % eradicate the centering. + \ifx\centersub\centerV\else \noindent \fi % % Output the image. \ifpdf @@ -7475,7 +8488,10 @@ \epsfbox{#1.eps}% \fi % - \ifimagevmode \medskip \fi % space after the standalone image + \ifimagevmode + \medskip % space after a standalone image + \fi + \ifx\centersub\centerV \egroup \fi \endgroup} @@ -7747,10 +8763,9 @@ \message{localization,} -% @documentlanguage is usually given very early, just after -% @setfilename. If done too late, it may not override everything -% properly. Single argument is the language (de) or locale (de_DE) -% abbreviation. It would be nice if we could set up a hyphenation file. +% For single-language documents, @documentlanguage is usually given very +% early, just after @documentencoding. Single argument is the language +% (de) or locale (de_DE) abbreviation. % { \catcode`\_ = \active @@ -7763,31 +8778,60 @@ \ifeof 1 \documentlanguagetrywithoutunderscore{#1_\finish}% \else + \globaldefs = 1 % everything in the txi-LL files needs to persist \input txi-#1.tex \fi \closein 1 - \endgroup + \endgroup % end raw TeX \endgroup} -} % % If they passed de_DE, and txi-de_DE.tex doesn't exist, % try txi-de.tex. -% -\def\documentlanguagetrywithoutunderscore#1_#2\finish{% +% +\gdef\documentlanguagetrywithoutunderscore#1_#2\finish{% \openin 1 txi-#1.tex \ifeof 1 \errhelp = \nolanghelp \errmessage{Cannot read language file txi-#1.tex}% \else + \globaldefs = 1 % everything in the txi-LL files needs to persist \input txi-#1.tex \fi \closein 1 } +}% end of special _ catcode % \newhelp\nolanghelp{The given language definition file cannot be found or -is empty. Maybe you need to install it? In the current directory -should work if nowhere else does.} - +is empty. Maybe you need to install it? Putting it in the current +directory should work if nowhere else does.} + +% This macro is called from txi-??.tex files; the first argument is the +% \language name to set (without the "\lang@" prefix), the second and +% third args are \{left,right}hyphenmin. +% +% The language names to pass are determined when the format is built. +% See the etex.log file created at that time, e.g., +% /usr/local/texlive/2008/texmf-var/web2c/pdftex/etex.log. +% +% With TeX Live 2008, etex now includes hyphenation patterns for all +% available languages. This means we can support hyphenation in +% Texinfo, at least to some extent. (This still doesn't solve the +% accented characters problem.) +% +\catcode`@=11 +\def\txisetlanguage#1#2#3{% + % do not set the language if the name is undefined in the current TeX. + \expandafter\ifx\csname lang@#1\endcsname \relax + \message{no patterns for #1}% + \else + \global\language = \csname lang@#1\endcsname + \fi + % but there is no harm in adjusting the hyphenmin values regardless. + \global\lefthyphenmin = #2\relax + \global\righthyphenmin = #3\relax +} + +% Helpers for encodings. % Set the catcode of characters 128 through 255 to the specified number. % \def\setnonasciicharscatcode#1{% @@ -7828,7 +8872,7 @@ \setnonasciicharscatcode\active \lattwochardefs % - \else \ifx \declaredencoding \latone + \else \ifx \declaredencoding \latone \setnonasciicharscatcode\active \latonechardefs % @@ -7840,7 +8884,7 @@ \setnonasciicharscatcode\active \utfeightchardefs % - \else + \else \message{Unknown document encoding #1, ignoring.}% % \fi % utfeight @@ -7852,7 +8896,7 @@ % A message to be logged when using a character that isn't available % the default font encoding (OT1). -% +% \def\missingcharmsg#1{\message{Character missing in OT1 encoding: #1.}} % Take account of \c (plain) vs. \, (Texinfo) difference. @@ -7865,21 +8909,21 @@ % % Latin1 (ISO-8859-1) character definitions. \def\latonechardefs{% - \gdef^^a0{~} + \gdef^^a0{\tie} \gdef^^a1{\exclamdown} - \gdef^^a2{\missingcharmsg{CENT SIGN}} + \gdef^^a2{\missingcharmsg{CENT SIGN}} \gdef^^a3{{\pounds}} \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} \gdef^^a5{\missingcharmsg{YEN SIGN}} - \gdef^^a6{\missingcharmsg{BROKEN BAR}} + \gdef^^a6{\missingcharmsg{BROKEN BAR}} \gdef^^a7{\S} - \gdef^^a8{\"{}} - \gdef^^a9{\copyright} + \gdef^^a8{\"{}} + \gdef^^a9{\copyright} \gdef^^aa{\ordf} - \gdef^^ab{\missingcharmsg{LEFT-POINTING DOUBLE ANGLE QUOTATION MARK}} + \gdef^^ab{\guillemetleft} \gdef^^ac{$\lnot$} - \gdef^^ad{\-} - \gdef^^ae{\registeredsymbol} + \gdef^^ad{\-} + \gdef^^ae{\registeredsymbol} \gdef^^af{\={}} % \gdef^^b0{\textdegree} @@ -7895,7 +8939,7 @@ \gdef^^b9{$^1$} \gdef^^ba{\ordm} % - \gdef^^bb{\missingcharmsg{RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK}} + \gdef^^bb{\guillemetright} \gdef^^bc{$1\over4$} \gdef^^bd{$1\over2$} \gdef^^be{$3\over4$} @@ -7906,7 +8950,7 @@ \gdef^^c2{\^A} \gdef^^c3{\~A} \gdef^^c4{\"A} - \gdef^^c5{\ringaccent A} + \gdef^^c5{\ringaccent A} \gdef^^c6{\AE} \gdef^^c7{\cedilla C} \gdef^^c8{\`E} @@ -7918,7 +8962,7 @@ \gdef^^ce{\^I} \gdef^^cf{\"I} % - \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER ETH}} + \gdef^^d0{\DH} \gdef^^d1{\~N} \gdef^^d2{\`O} \gdef^^d3{\'O} @@ -7932,7 +8976,7 @@ \gdef^^db{\^U} \gdef^^dc{\"U} \gdef^^dd{\'Y} - \gdef^^de{\missingcharmsg{LATIN CAPITAL LETTER THORN}} + \gdef^^de{\TH} \gdef^^df{\ss} % \gdef^^e0{\`a} @@ -7952,7 +8996,7 @@ \gdef^^ee{\^{\dotless i}} \gdef^^ef{\"{\dotless i}} % - \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER ETH}} + \gdef^^f0{\dh} \gdef^^f1{\~n} \gdef^^f2{\`o} \gdef^^f3{\'o} @@ -7966,7 +9010,7 @@ \gdef^^fb{\^u} \gdef^^fc{\"u} \gdef^^fd{\'y} - \gdef^^fe{\missingcharmsg{LATIN SMALL LETTER THORN}} + \gdef^^fe{\th} \gdef^^ff{\"y} } @@ -7987,8 +9031,8 @@ % Latin2 (ISO-8859-2) character definitions. \def\lattwochardefs{% - \gdef^^a0{~} - \gdef^^a1{\missingcharmsg{LATIN CAPITAL LETTER A WITH OGONEK}} + \gdef^^a0{\tie} + \gdef^^a1{\ogonek{A}} \gdef^^a2{\u{}} \gdef^^a3{\L} \gdef^^a4{\missingcharmsg{CURRENCY SIGN}} @@ -8005,8 +9049,8 @@ \gdef^^af{\dotaccent Z} % \gdef^^b0{\textdegree} - \gdef^^b1{\missingcharmsg{LATIN SMALL LETTER A WITH OGONEK}} - \gdef^^b2{\missingcharmsg{OGONEK}} + \gdef^^b1{\ogonek{a}} + \gdef^^b2{\ogonek{ }} \gdef^^b3{\l} \gdef^^b4{\'{}} \gdef^^b5{\v l} @@ -8031,14 +9075,14 @@ \gdef^^c7{\cedilla C} \gdef^^c8{\v C} \gdef^^c9{\'E} - \gdef^^ca{\missingcharmsg{LATIN CAPITAL LETTER E WITH OGONEK}} + \gdef^^ca{\ogonek{E}} \gdef^^cb{\"E} \gdef^^cc{\v E} \gdef^^cd{\'I} \gdef^^ce{\^I} \gdef^^cf{\v D} % - \gdef^^d0{\missingcharmsg{LATIN CAPITAL LETTER D WITH STROKE}} + \gdef^^d0{\DH} \gdef^^d1{\'N} \gdef^^d2{\v N} \gdef^^d3{\'O} @@ -8047,7 +9091,7 @@ \gdef^^d6{\"O} \gdef^^d7{$\times$} \gdef^^d8{\v R} - \gdef^^d9{\ringaccent U} + \gdef^^d9{\ringaccent U} \gdef^^da{\'U} \gdef^^db{\H U} \gdef^^dc{\"U} @@ -8065,14 +9109,14 @@ \gdef^^e7{\cedilla c} \gdef^^e8{\v c} \gdef^^e9{\'e} - \gdef^^ea{\missingcharmsg{LATIN SMALL LETTER E WITH OGONEK}} + \gdef^^ea{\ogonek{e}} \gdef^^eb{\"e} \gdef^^ec{\v e} - \gdef^^ed{\'\i} - \gdef^^ee{\^\i} + \gdef^^ed{\'{\dotless{i}}} + \gdef^^ee{\^{\dotless{i}}} \gdef^^ef{\v d} % - \gdef^^f0{\missingcharmsg{LATIN SMALL LETTER D WITH STROKE}} + \gdef^^f0{\dh} \gdef^^f1{\'n} \gdef^^f2{\v n} \gdef^^f3{\'o} @@ -8091,11 +9135,11 @@ } % UTF-8 character definitions. -% +% % This code to support UTF-8 is based on LaTeX's utf8.def, with some % changes for Texinfo conventions. It is included here under the GPL by % permission from Frank Mittelbach and the LaTeX team. -% +% \newcount\countUTFx \newcount\countUTFy \newcount\countUTFz @@ -8160,7 +9204,7 @@ \gdef\DeclareUnicodeCharacter#1#2{% \countUTFz = "#1\relax - \wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}% + %\wlog{\space\space defining Unicode char U+#1 (decimal \the\countUTFz)}% \begingroup \parseXMLCharref \def\UTFviiiTwoOctets##1##2{% @@ -8245,6 +9289,7 @@ \DeclareUnicodeCharacter{00CE}{\^I} \DeclareUnicodeCharacter{00CF}{\"I} + \DeclareUnicodeCharacter{00D0}{\DH} \DeclareUnicodeCharacter{00D1}{\~N} \DeclareUnicodeCharacter{00D2}{\`O} \DeclareUnicodeCharacter{00D3}{\'O} @@ -8257,6 +9302,7 @@ \DeclareUnicodeCharacter{00DB}{\^U} \DeclareUnicodeCharacter{00DC}{\"U} \DeclareUnicodeCharacter{00DD}{\'Y} + \DeclareUnicodeCharacter{00DE}{\TH} \DeclareUnicodeCharacter{00DF}{\ss} \DeclareUnicodeCharacter{00E0}{\`a} @@ -8276,6 +9322,7 @@ \DeclareUnicodeCharacter{00EE}{\^{\dotless{i}}} \DeclareUnicodeCharacter{00EF}{\"{\dotless{i}}} + \DeclareUnicodeCharacter{00F0}{\dh} \DeclareUnicodeCharacter{00F1}{\~n} \DeclareUnicodeCharacter{00F2}{\`o} \DeclareUnicodeCharacter{00F3}{\'o} @@ -8288,16 +9335,21 @@ \DeclareUnicodeCharacter{00FB}{\^u} \DeclareUnicodeCharacter{00FC}{\"u} \DeclareUnicodeCharacter{00FD}{\'y} + \DeclareUnicodeCharacter{00FE}{\th} \DeclareUnicodeCharacter{00FF}{\"y} \DeclareUnicodeCharacter{0100}{\=A} \DeclareUnicodeCharacter{0101}{\=a} \DeclareUnicodeCharacter{0102}{\u{A}} \DeclareUnicodeCharacter{0103}{\u{a}} + \DeclareUnicodeCharacter{0104}{\ogonek{A}} + \DeclareUnicodeCharacter{0105}{\ogonek{a}} \DeclareUnicodeCharacter{0106}{\'C} \DeclareUnicodeCharacter{0107}{\'c} \DeclareUnicodeCharacter{0108}{\^C} \DeclareUnicodeCharacter{0109}{\^c} + \DeclareUnicodeCharacter{0118}{\ogonek{E}} + \DeclareUnicodeCharacter{0119}{\ogonek{e}} \DeclareUnicodeCharacter{010A}{\dotaccent{C}} \DeclareUnicodeCharacter{010B}{\dotaccent{c}} \DeclareUnicodeCharacter{010C}{\v{C}} @@ -8445,6 +9497,8 @@ \DeclareUnicodeCharacter{0233}{\=y} \DeclareUnicodeCharacter{0237}{\dotless{j}} + \DeclareUnicodeCharacter{02DB}{\ogonek{ }} + \DeclareUnicodeCharacter{1E02}{\dotaccent{B}} \DeclareUnicodeCharacter{1E03}{\dotaccent{b}} \DeclareUnicodeCharacter{1E04}{\udotaccent{B}} @@ -8618,8 +9672,8 @@ % Prevent underfull vbox error messages. \vbadness = 10000 -% Don't be so finicky about underfull hboxes, either. -\hbadness = 2000 +% Don't be very finicky about underfull hboxes, either. +\hbadness = 6666 % Following George Bush, get rid of widows and orphans. \widowpenalty=10000 @@ -8826,25 +9880,21 @@ \message{and turning on texinfo input format.} +\def^^L{\par} % remove \outer, so ^L can appear in an @comment + +% DEL is a comment character, in case @c does not suffice. +\catcode`\^^? = 14 + % Define macros to output various characters with catcode for normal text. -\catcode`\"=\other -\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 +\catcode`\"=\other \def\normaldoublequote{"} +\catcode`\$=\other \def\normaldollar{$}%$ font-lock fix +\catcode`\+=\other \def\normalplus{+} +\catcode`\<=\other \def\normalless{<} +\catcode`\>=\other \def\normalgreater{>} +\catcode`\^=\other \def\normalcaret{^} +\catcode`\_=\other \def\normalunderscore{_} +\catcode`\|=\other \def\normalverticalbar{|} +\catcode`\~=\other \def\normaltilde{~} % This macro is used to make a character print one way in \tt % (where it can probably be output as-is), and another way in other fonts, @@ -8922,32 +9972,48 @@ % In texinfo, backslash is an active character; it prints the backslash % in fixed width font. -\catcode`\\=\active -@def@normalbackslash{{@tt@backslashcurfont}} +\catcode`\\=\active % @ for escape char from now on. + +% The story here is that in math mode, the \char of \backslashcurfont +% ends up printing the roman \ from the math symbol font (because \char +% in math mode uses the \mathcode, and plain.tex sets +% \mathcode`\\="026E). It seems better for @backslashchar{} to always +% print a typewriter backslash, hence we use an explicit \mathchar, +% which is the decimal equivalent of "715c (class 7, e.g., use \fam; +% ignored family value; char position "5C). We can't use " for the +% usual hex value because it has already been made active. +@def@normalbackslash{{@tt @ifmmode @mathchar29020 @else @backslashcurfont @fi}} +@let@backslashchar = @normalbackslash % @backslashchar{} is for user documents. + % On startup, @fixbackslash assigns: % @let \ = @normalbackslash - % \rawbackslash defines an active \ to do \backslashcurfont. % \otherbackslash defines an active \ to be a literal `\' character with -% catcode other. +% catcode other. We switch back and forth between these. @gdef@rawbackslash{@let\=@backslashcurfont} @gdef@otherbackslash{@let\=@realbackslash} % Same as @turnoffactive except outputs \ as {\tt\char`\\} instead of -% the literal character `\'. -% -@def@normalturnoffactive{% - @let\=@normalbackslash - @let"=@normaldoublequote - @let~=@normaltilde - @let^=@normalcaret - @let_=@normalunderscore - @let|=@normalverticalbar - @let<=@normalless - @let>=@normalgreater - @let+=@normalplus - @let$=@normaldollar %$ font-lock fix - @unsepspaces +% the literal character `\'. Also revert - to its normal character, in +% case the active - from code has slipped in. +% +{@catcode`- = @active + @gdef@normalturnoffactive{% + @let-=@normaldash + @let"=@normaldoublequote + @let$=@normaldollar %$ font-lock fix + @let+=@normalplus + @let<=@normalless + @let>=@normalgreater + @let\=@normalbackslash + @let^=@normalcaret + @let_=@normalunderscore + @let|=@normalverticalbar + @let~=@normaltilde + @markupsetuplqdefault + @markupsetuprqdefault + @unsepspaces + } } % Make _ and + \other characters, temporarily. @@ -8976,11 +10042,28 @@ % Say @foo, not \foo, in error messages. @escapechar = `@@ +% These (along with & and #) are made active for url-breaking, so need +% active definitions as the normal characters. +@def@normaldot{.} +@def@normalquest{?} +@def@normalslash{/} + % These look ok in all fonts, so just make them not special. -@catcode`@& = @other -@catcode`@# = @other -@catcode`@% = @other - +% @hashchar{} gets its own user-level command, because of #line. +@catcode`@& = @other @def@normalamp{&} +@catcode`@# = @other @def@normalhash{#} +@catcode`@% = @other @def@normalpercent{%} + +@let @hashchar = @normalhash + +@c Finally, make ` and ' active, so that txicodequoteundirected and +@c txicodequotebacktick work right in, e.g., @w{@code{`foo'}}. If we +@c don't make ` and ' active, @code will not get them as active chars. +@c Do this last of all since we use ` in the previous @catcode assignments. +@catcode`@'=@active +@catcode`@`=@active +@markupsetuplqdefault +@markupsetuprqdefault @c Local variables: @c eval: (add-hook 'write-file-hooks 'time-stamp)
--- a/man/texinfo/texinfo.texi Wed Jul 10 14:14:30 2013 +0100 +++ b/man/texinfo/texinfo.texi Wed Jul 10 14:32:02 2013 +0100 @@ -13717,14 +13717,14 @@ @item US-ASCII This has no particular effect, but it's included for completeness. -@itemx UTF-8 +@item UTF-8 The vast global character encoding, expressed in 8-bit bytes. The Texinfo processors have no deep knowledge of Unicode; for the most part, they just pass along the input they are given to the output. -@itemx ISO-8859-1 +@item ISO-8859-1 @itemx ISO-8859-15 -@item ISO-8859-2 +@itemx ISO-8859-2 These specify the standard encodings for Western European (the first two) and Eastern European languages (the third), respectively. ISO 8859-15 replaces some little-used characters from 8859-1 (e.g., @@ -17428,7 +17428,7 @@ Generate the uppercase and lowercase AE ligatures, respectively: @AE{}, @ae{}. @xref{Inserting Accents}. -@itemx @@afivepaper +@item @@afivepaper Change page dimensions for the A5 paper size. @xref{A4 Paper}. @item @@afourlatex @@ -17955,7 +17955,7 @@ the corresponding @code{@@end ifnot@var{format}}. @xref{Conditionals}. -@itemx @@ifnotinfo +@item @@ifnotinfo Begin text to appear in output other than Info and (for historical compatibility) plain text. Pair with @code{@@end ifnotinfo}. @xref{Conditionals}.
--- a/man/widget.texi Wed Jul 10 14:14:30 2013 +0100 +++ b/man/widget.texi Wed Jul 10 14:32:02 2013 +0100 @@ -6,12 +6,11 @@ @syncodeindex vr cp @syncodeindex ky cp @c %**end of header -@c Synced up with: FSF 23.1.92. -@c Synced by: Ben Wing, 2-17-10. +@c Synced up with: FSF 24.3 +@c Synced by: Jerry James, 19-Jun-2013. @copying -Copyright @copyright{} 2000, 2001, 2002, 2003, 2004, 2005, -2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. +Copyright @copyright{} 2000--2013 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -108,25 +107,15 @@ @end detailmenu @end menu - - - - - - - - - - @node Introduction, User Interface, Top, Top @comment node-name, next, previous, up -@section Introduction +@chapter Introduction @c XEmacs changes to reflect history, native widgets, and GTK Most graphical user interface toolkits provide a number of standard user interface controls (sometimes known as `widgets' or `gadgets'). Historically, Emacs didn't support anything like -this, except for its incredible powerful text ``widget''. However, +this, except for its incredibly powerful text ``widget''. However, since XEmacs 21.4, XEmacs has supported ``native'' widgets (GUI controls implemented as Lisp APIs in C for the MS Windows, Motif, Athena, and GTK toolkits) and libglade (GUI controls with an XML API for the GTK @@ -193,13 +182,13 @@ You can have fixed sized fields, thus allowing multiple fields to be lined up in columns. @item -It is simple to query or set the value of a field. -@item +It is simple to query or set the value of a field. +@item Editing happens in a normal buffer, not in the mini-buffer. -@item +@item Packages using the library get a uniform look-and-feel, making them easier for the user to learn. -@item +@item As support for embedded graphics improve, the widget library will be extended to use the GUI features. This means that your code using the widget library will also use the new graphic features automatically. @@ -234,7 +223,7 @@ @node User Interface, Programming Example, Introduction, Top @comment node-name, next, previous, up -@section User Interface +@chapter User Interface A form consists of read only text for documentation and some fields, where each field contains two parts, a tag and a value. The tags are @@ -280,7 +269,7 @@ within a form, namely editing the editable text fields and activating the buttons. -@subsection Editable Text Fields +@section Editable Text Fields In the example, the value for the @samp{Name} is most likely displayed in an editable text field, and so are values for each of the members of @@ -317,7 +306,7 @@ Face used for other editing fields. @end deffn -@subsection Buttons +@section Buttons @cindex widget buttons @cindex button widgets @@ -388,7 +377,7 @@ it. @end defopt -@subsection Navigation +@section Navigation You can use all the normal Emacs commands to move around in a form buffer, plus you will have these additional commands: @@ -407,7 +396,7 @@ @node Programming Example, Setting Up the Buffer, User Interface, Top @comment node-name, next, previous, up -@section Programming Example +@chapter Programming Example @cindex widgets, programming example @cindex example of using widgets @@ -503,7 +492,7 @@ @node Setting Up the Buffer, Basic Types, Programming Example, Top @comment node-name, next, previous, up -@section Setting Up the Buffer +@chapter Setting Up the Buffer Widgets are created with @code{widget-create}, which returns a @dfn{widget} object. This object can be queried and manipulated by @@ -558,7 +547,7 @@ @node Basic Types, Sexp Types, Setting Up the Buffer, Top @comment node-name, next, previous, up -@section Basic Types +@chapter Basic Types This is the general syntax of a type specification: @@ -803,7 +792,7 @@ @node link, url-link, Basic Types, Basic Types @comment node-name, next, previous, up -@subsection The @code{link} Widget +@section The @code{link} Widget @findex link@r{ widget} Syntax: @@ -828,7 +817,7 @@ @node url-link, info-link, link, Basic Types @comment node-name, next, previous, up -@subsection The @code{url-link} Widget +@section The @code{url-link} Widget @findex url-link@r{ widget} Syntax: @@ -843,7 +832,7 @@ @node info-link, push-button, url-link, Basic Types @comment node-name, next, previous, up -@subsection The @code{info-link} Widget +@section The @code{info-link} Widget @findex info-link@r{ widget} Syntax: @@ -857,7 +846,7 @@ @node push-button, editable-field, info-link, Basic Types @comment node-name, next, previous, up -@subsection The @code{push-button} Widget +@section The @code{push-button} Widget @findex push-button@r{ widget} Syntax: @@ -882,7 +871,7 @@ @node editable-field, text, push-button, Basic Types @comment node-name, next, previous, up -@subsection The @code{editable-field} Widget +@section The @code{editable-field} Widget @findex editable-field@r{ widget} Syntax: @@ -934,7 +923,7 @@ @node text, menu-choice, editable-field, Basic Types @comment node-name, next, previous, up -@subsection The @code{text} Widget +@section The @code{text} Widget @findex text@r{ widget} @vindex widget-text-keymap @@ -944,7 +933,7 @@ @node menu-choice, radio-button-choice, text, Basic Types @comment node-name, next, previous, up -@subsection The @code{menu-choice} Widget +@section The @code{menu-choice} Widget @findex menu-choice@r{ widget} Syntax: @@ -985,7 +974,7 @@ @node radio-button-choice, item, menu-choice, Basic Types @comment node-name, next, previous, up -@subsection The @code{radio-button-choice} Widget +@section The @code{radio-button-choice} Widget @findex radio-button-choice@r{ widget} Syntax: @@ -1052,7 +1041,7 @@ @node item, choice-item, radio-button-choice, Basic Types @comment node-name, next, previous, up -@subsection The @code{item} Widget +@section The @code{item} Widget @findex item@r{ widget} Syntax: @@ -1067,7 +1056,7 @@ @node choice-item, toggle, item, Basic Types @comment node-name, next, previous, up -@subsection The @code{choice-item} Widget +@section The @code{choice-item} Widget @findex choice-item@r{ widget} Syntax: @@ -1084,7 +1073,7 @@ @node toggle, checkbox, choice-item, Basic Types @comment node-name, next, previous, up -@subsection The @code{toggle} Widget +@section The @code{toggle} Widget @findex toggle@r{ widget} Syntax: @@ -1117,7 +1106,7 @@ @node checkbox, checklist, toggle, Basic Types @comment node-name, next, previous, up -@subsection The @code{checkbox} Widget +@section The @code{checkbox} Widget @findex checkbox@r{ widget} This widget has two possible states, @samp{selected} and @@ -1131,7 +1120,7 @@ @node checklist, editable-list, checkbox, Basic Types @comment node-name, next, previous, up -@subsection The @code{checklist} Widget +@section The @code{checklist} Widget @findex checklist@r{ widget} Syntax: @@ -1189,7 +1178,7 @@ @node editable-list, group, checklist, Basic Types @comment node-name, next, previous, up -@subsection The @code{editable-list} Widget +@section The @code{editable-list} Widget @findex editable-list@r{ widget} Syntax: @@ -1247,7 +1236,7 @@ @node group, , editable-list, Basic Types @comment node-name, next, previous, up -@subsection The @code{group} Widget +@section The @code{group} Widget @findex group@r{ widget} This widget simply groups other widgets together. @@ -1262,7 +1251,7 @@ @node Sexp Types, Widget Properties, Basic Types, Top @comment -@section Sexp Types +@chapter Sexp Types @cindex sexp types A number of widgets for editing @dfn{s-expressions} (Lisp types), sexp @@ -1278,7 +1267,7 @@ @node constants, generic, Sexp Types, Sexp Types @comment node-name, next, previous, up -@subsection The Constant Widgets +@section The Constant Widgets @cindex constant widgets The @code{const} widget can contain any Lisp expression, but the user is @@ -1315,7 +1304,7 @@ @node generic, atoms, constants, Sexp Types @comment node-name, next, previous, up -@subsection Generic Sexp Widget +@section Generic Sexp Widget @cindex generic sexp widget The @code{sexp} widget can contain any Lisp expression, and allows the @@ -1337,7 +1326,7 @@ @node atoms, composite, generic, Sexp Types @comment node-name, next, previous, up -@subsection Atomic Sexp Widgets +@section Atomic Sexp Widgets @cindex atomic sexp widget The atoms are s-expressions that do not consist of other s-expressions. @@ -1415,7 +1404,7 @@ @node composite, , atoms, Sexp Types @comment node-name, next, previous, up -@subsection Composite Sexp Widgets +@section Composite Sexp Widgets @cindex composite sexp widgets The syntax for the composite widget construct is: @@ -1517,7 +1506,7 @@ @node Widget Properties, Defining New Widgets, Sexp Types, Top @comment node-name, next, previous, up -@section Properties +@chapter Properties @cindex properties of widgets @cindex widget properties @@ -1612,7 +1601,7 @@ @node Defining New Widgets, Widget Browser, Widget Properties, Top @comment node-name, next, previous, up -@section Defining New Widgets +@chapter Defining New Widgets @cindex new widgets @cindex defining new widgets @@ -1629,7 +1618,7 @@ The third argument @var{doc} is a documentation string for the widget. -After the new widget has been defined the following two calls will +After the new widget has been defined, the following two calls will create identical widgets: @itemize @bullet @@ -1856,7 +1845,7 @@ @node Widget Browser, Widget Minor Mode, Defining New Widgets, Top @comment node-name, next, previous, up -@section Widget Browser +@chapter Widget Browser @cindex widget browser There is a separate package to browse widgets. This is intended to help @@ -1881,7 +1870,7 @@ @node Widget Minor Mode, Utilities, Widget Browser, Top @comment node-name, next, previous, up -@section Widget Minor Mode +@chapter Widget Minor Mode @cindex widget minor mode There is a minor mode for manipulating widgets in major modes that @@ -1899,7 +1888,7 @@ @node Utilities, Widget Wishlist, Widget Minor Mode, Top @comment node-name, next, previous, up -@section Utilities. +@chapter Utilities @cindex utility functions for widgets @defun widget-prompt-value widget prompt [ value unbound ] @@ -1915,7 +1904,7 @@ @node Widget Wishlist, Widget Internals, Utilities, Top @comment node-name, next, previous, up -@section Wishlist +@chapter Wishlist @cindex todo @itemize @bullet @@ -2029,7 +2018,3 @@ @printindex cp @bye - -@ignore - arch-tag: 2b427731-4c61-4e72-85de-5ccec9c623f0 -@end ignore
--- a/man/xemacs-faq.texi Wed Jul 10 14:14:30 2013 +0100 +++ b/man/xemacs-faq.texi Wed Jul 10 14:32:02 2013 +0100 @@ -7950,19 +7950,19 @@ Thanks to @email{james@@xemacs.org, Jerry James}, XEmacs 21.5.18 and later can use the capabilities of multiple-precision libraries that may -be available for your platform. The GNU Multiple Precision (GMP) and -BSD Multiple Precision (MP) libraries are partially supported. GMP -gives you @dfn{bignums} (arbitrary precision integers), @dfn{ratios} -(arbitrary precision fractions), and @dfn{bigfloats} (arbitrary -precision floating point numbers). GNU MP is better-supported by XEmacs -at the time of writing (2004-04-06). BSD MP support does not include -ratios or bigfloats, and it throws errors that aren't understood. +be available for your platform. The GNU Multiple Precision (GMP), +Multiple Precision Integers and Rationals (MPIR), and BSD Multiple +Precision (MP) libraries are supported. GMP and MPIR give you +@dfn{bignums} (arbitrary precision integers), @dfn{ratios} (arbitrary +precision fractions), and @dfn{bigfloats} (arbitrary precision floating +point numbers). GMP and MPIR are better-supported by XEmacs. BSD MP +support does not include ratios or bigfloats. In most cases, bignum support should be transparent to users and Lisp programmers. A bignum-enabled XEmacs will automatically convert from -fixnums to bignums and back in pure integer arithmetic, and for GNU MP, -from floats to bigfloats. (Bigfloats must be explicitly coerced to -other types, even if they are exactly representable by less precise +fixnums to bignums and back in pure integer arithmetic, and for GMP and +MPIR, from floats to bigfloats. (Bigfloats must be explicitly coerced +to other types, even if they are exactly representable by less precise types.) The Lisp reader and printer have been enhanced to handle bignums, as have the mathematical functions. Rationals (fixnums, bignums, and ratios) are printed using the @samp{%d}, @samp{%o}, @@ -8002,17 +8002,9 @@ arbitrarily decide to hand you an unpleasant surprise rather than a bignum @ref{Q7.2.2, XEmacs segfaults when I use very big numbers!}. -To configure with GNU MP, add @samp{--use-number-lib=gmp} -(@samp{--enable-bignum=gmp} in 21.5 or later) to your invocation of -@file{configure}. For BSD MP, use @samp{--use-number-lib=mp} -(@samp{--enable-bignum=mp} for 21.5). - -If you would like to help with bignum support, especially on BSD MP, -please subscribe to the @uref{http://www.xemacs.org/Lists/#xemacs-beta, -XEmacs Beta mailing list}, and book up on @file{number-gmp.h} and -@file{number-mp.h}. Jerry has promised to write internals documentation -eventually, but if your skills run more to analysis and documentation -than to writing new code, feel free to fill in the gap! +To configure with GMP, add @samp{--enable-bignum=gmp} to your invocation +of @file{configure}. For MPIR, use @samp{--enable-bignum=mpir}. For +BSD MP, use @samp{--enable-bignum=mp}. @node Q7.2.2, Q7.2.3, Q7.2.1, Advanced @@ -8036,10 +8028,10 @@ @node Q7.2.3, Q7.2.4, Q7.2.2, Advanced @unnumberedsubsec Q7.2.3: Bignums are really slow! -Many Linux distributions compile all their packages for the i386, and -this is costly. An optimized version can give you two or three orders -of magnitude better performance for a Pentium III or IV. (Yes, really. -See @uref{http://www.swox.com/gmp/gmp-speed.html}.) +Many Unix and Linux distributions compile all packages for a generic +version of the supported CPU, and this is costly. An optimized version +can improve responiveness dramatically; see +@uref{http://gmplib.org/gmpbench.html}.) @node Q7.2.4, , Q7.2.3, Advanced @@ -8846,6 +8838,7 @@ * Q11.2.7:: Testing patches with Mercurial Queues. @end menu +@unnumberedsec 11.0: The XEmacs repositories @node Q11.0.1, Q11.0.2, Bleeding Edge, Bleeding Edge @unnumberedsubsec Where is the most recent XEmacs development code? @@ -8964,6 +8957,7 @@ @xref{Q11.2.1, What is Mercurial?}. +@unnumberedsec 11.1: Working with CVS @node Q11.1.1, Q11.2.1, Q11.0.5, Bleeding Edge @unnumberedsubsec How do I keep cool using CVS? @@ -8979,6 +8973,7 @@ For help using CVS, Google or ask on @email{xemacs-beta@@xemacs.org}. Please update this FAQ with one or two of the best references you find. +@unnumberedsec 11.1: Working with Mercurial @node Q11.2.1, Q11.2.2, Q11.1.1, Bleeding Edge @unnumberedsubsec What is Mercurial?
--- a/man/xemacs/packages.texi Wed Jul 10 14:14:30 2013 +0100 +++ b/man/xemacs/packages.texi Wed Jul 10 14:32:02 2013 +0100 @@ -420,7 +420,7 @@ @item GNU make (3.75 or later preferred). @item makeinfo -(4.2 from GNU texinfo 4.2 or later required). +(4.12 from GNU texinfo 4.12 or later required). @item GNU tar (or equivalent). @item GNU gzip
--- a/src/ChangeLog Wed Jul 10 14:14:30 2013 +0100 +++ b/src/ChangeLog Wed Jul 10 14:32:02 2013 +0100 @@ -1,3 +1,15 @@ +2013-06-17 Jerry James <james@xemacs.org> + + * Makefile.in.in: Support bignums with MPIR. + * config.h.in (WITH_MPIR): New macro. + * number.c: Add MPIR support. + * number.h: Ditto. + * number-gmp.h: Ditto. + (ratio_set_long_ulong): Canonicalize the ratio. + (ratio_set_ulong_ulong): Ditto. + * number-gmp.c (init_number_gmp): Add void param to silence GCC. + * number-mp.c (init_number_mp): Ditto. + 2013-07-10 Aidan Kehoe <kehoea@parhasard.net> * keymap.c:
--- a/src/Makefile.in.in Wed Jul 10 14:14:30 2013 +0100 +++ b/src/Makefile.in.in Wed Jul 10 14:32:02 2013 +0100 @@ -207,7 +207,7 @@ mule_wnn_objs=mule-wnnfns.o #endif -#ifdef WITH_GMP +#if defined(WITH_GMP) || defined(WITH_MPIR) number_objs=number-gmp.o number.o #endif #ifdef WITH_MP
--- a/src/config.h.in Wed Jul 10 14:14:30 2013 +0100 +++ b/src/config.h.in Wed Jul 10 14:32:02 2013 +0100 @@ -747,6 +747,7 @@ /* Enhanced numeric support */ #undef WITH_NUMBER_TYPES #undef WITH_GMP +#undef WITH_MPIR #undef WITH_MP #undef MP_PREFIX #undef HAVE_MP_MOVE
--- a/src/number-gmp.c Wed Jul 10 14:14:30 2013 +0100 +++ b/src/number-gmp.c Wed Jul 10 14:32:02 2013 +0100 @@ -1,5 +1,5 @@ -/* Numeric types for XEmacs using the GNU MP library. - Copyright (C) 2004 Jerry James. +/* Numeric types for XEmacs using the GMP or MPIR library. + Copyright (C) 2004,2013 Jerry James. This file is part of XEmacs. @@ -141,7 +141,7 @@ } void -init_number_gmp () +init_number_gmp (void) { mp_set_memory_functions ((void *(*) (size_t)) xmalloc, gmp_realloc, gmp_free);
--- a/src/number-gmp.h Wed Jul 10 14:14:30 2013 +0100 +++ b/src/number-gmp.h Wed Jul 10 14:32:02 2013 +0100 @@ -1,5 +1,5 @@ -/* Definitions of numeric types for XEmacs using the GNU MP library. - Copyright (C) 2004 Jerry James. +/* Definitions of numeric types for XEmacs using the GMP or MPIR library. + Copyright (C) 2004,2013 Jerry James. This file is part of XEmacs. @@ -38,7 +38,12 @@ Occurs on line 1596 of gmp.h in version 4.1.4. */ #pragma warning ( disable : 4146 ) #endif +#ifdef WITH_GMP #include <gmp.h> +#endif +#ifdef WITH_MPIR +#include <mpir.h> +#endif #ifdef _MSC_VER #pragma warning ( default : 4146 ) #endif @@ -165,9 +170,14 @@ #define ratio_set_double(r,f) mpq_set_d (r, f) #define ratio_set_bignum(r,b) mpq_set_z (r, b) #define ratio_set_bigfloat(r,f) mpq_set_f (r, f) -#define ratio_set_long_ulong(r,num,den) mpq_set_si (r, num, den) -#define ratio_set_ulong_ulong(r,num,den) mpq_set_ui (r, num, den) -/* FIXME: Why does this canonicalize, but the previous 2 don't? */ +#define ratio_set_long_ulong(r,num,den) do { \ + mpq_set_si (r, num, den); \ + mpq_canonicalize (r); \ + } while (0) +#define ratio_set_ulong_ulong(r,num,den) do { \ + mpq_set_ui (r, num, den); \ + mpq_canonicalize (r); \ + } while (0) #define ratio_set_bignum_bignum(r,num,den) do { \ mpz_set (mpq_numref (r), num); \ mpz_set (mpq_denref (r), den); \
--- a/src/number-mp.c Wed Jul 10 14:14:30 2013 +0100 +++ b/src/number-mp.c Wed Jul 10 14:32:02 2013 +0100 @@ -623,7 +623,7 @@ #endif void -init_number_mp () +init_number_mp (void) { #ifdef HAVE_MP_SET_MEMORY_FUNCTIONS mp_set_memory_functions ((void *(*) (size_t)) xmalloc, mp_realloc, mp_free);