diff --git a/.coveralls.yml b/.coveralls.yml new file mode 100644 index 0000000..3ac81fe --- /dev/null +++ b/.coveralls.yml @@ -0,0 +1 @@ +repo_token: xl1m2EiKjG4YlJQ0KjTTBNDRcAFD0lCVt diff --git a/.dir-locals.el b/.dir-locals.el new file mode 100644 index 0000000..2dc381f --- /dev/null +++ b/.dir-locals.el @@ -0,0 +1,6 @@ +((cperl-mode . ((dumb-jump-force-searcher . rg) + (cperl-indent-level . 4) + (cperl-close-paren-offset . -4) + (cperl-indent-subs-specially . nil) + (indent-tabs-mode . nil) + (eval . (auto-fill-mode -1))))) diff --git a/.dumbjump b/.dumbjump new file mode 100644 index 0000000..060cbbd --- /dev/null +++ b/.dumbjump @@ -0,0 +1,2 @@ ++bin/*.in ++lib/*.pm.in diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..b2433de --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,80 @@ +# This file is part of GNU Stow. +# +# GNU Stow is free software: you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# GNU Stow is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see https://www.gnu.org/licenses/. + +name: Test suite + +on: + push: + branches: [master] + + pull_request: + branches: [master] + types: [opened, synchronize, reopened, ready_for_review] + +jobs: + # call-simple-perl-test: + # uses: perl-actions/github-workflows/.github/workflows/simple-perltester-workflow.yml@main + # with: + # since-perl: 5.14 + + test: + name: Perl ${{ matrix.perl-version }} + runs-on: ubuntu-latest + + strategy: + matrix: + perl-version: + - '5.38' + - '5.36' + - '5.34' + - '5.32' + - '5.30' + + container: + # This Docker image should avoid the need to run: + # + # cpanm -n Devel::Cover::Report::Coveralls + image: perldocker/perl-tester:${{ matrix.perl-version }} + + steps: + - run: apt-get update && apt-get install -y sudo texinfo texlive + + - name: Checkout code + uses: actions/checkout@v2 + +# - uses: awalsh128/cache-apt-pkgs-action@latest +# with: +# debug: true +# packages: texinfo texlive +# version: 1.0 + + - run: autoreconf --install + - name: ./configure && make + run: | + eval `perl -V:siteprefix` + # Note: this will complain Test::Output isn't yet installed: + ./configure --prefix=$siteprefix && make + + # but that's OK because we install it here: + make cpanm + + #- name: Run tests + # run: make test + + - run: make distcheck + - run: perl Build.PL + - run: ./Build build + - run: cover -test -report coveralls + - run: ./Build distcheck diff --git a/.gitignore b/.gitignore index dcb7f4d..caf4ba3 100644 --- a/.gitignore +++ b/.gitignore @@ -9,7 +9,8 @@ /bin/stow /doc/stow.info /doc/version.texi -tmp-testing-trees/ +/playground/ +tmp-testing-trees*/ _build/ autom4te.cache/ blib/ diff --git a/AUTHORS b/AUTHORS index 58d7ad1..1e98122 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,3 +1,7 @@ +This file documents the high-level history of Stow, and some of its +major contributors. See also the THANKS file for a more complete list +of contributors. + Stow was originally written by Bob Glickstein , Zanshin Software, Inc. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1752a8e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,123 @@ +Contributing to GNU Stow +======================== + +Development of Stow, and GNU in general, is a volunteer effort, and +you can contribute. If you'd like to get involved, it's a good idea to join +the [stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel) +mailing list. + +Bug reporting +------------- + +Please follow the procedure described in [the "Reporting Bugs" +section](https://www.gnu.org/software/stow/manual/html_node/Reporting-Bugs.html#Reporting-Bugs) +of [the manual](README.md#documentation). + +Development +----------- + +For [development sources](https://savannah.gnu.org/git/?group=stow) +and other information, please see the [Stow project +page](http://savannah.gnu.org/projects/stow/) at +[savannah.gnu.org](http://savannah.gnu.org). + +There is also a +[stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel) +mailing list (see [Mailing lists](README.md#mailing-lists)). + +Please be aware that all program source files (excluding the test +suite) end in `.in`, and are pre-processed by `Makefile` into +corresponding files with that prefix stripped before execution. So if +you want to test any modifications to the source, make sure that you +change the `.in` files and then run `make` to regenerate the +pre-processed versions before doing any testing. To avoid forgetting +(which can potentially waste a lot of time debugging the wrong code), +you can automatically run `make` in an infinite loop every second via: + + make watch + +(You could even use fancier approaches like +[`inotifywait(1)`](https://www.man7.org/linux/man-pages/man1/inotifywait.1.html) +or [Guard](https://guardgem.org/). But those are probably overkill in +this case where the simple `while` loop is plenty good enough.) + +Testing +~~~~~~~ + +The test suite can be found in the [`t/`](t/) subdirectory. You can +run the test suite via: + + make check + +Tests can be run individually as follows. First you have to ensure +that the `t/`, `bin/`, and `lib/` directories are on Perl's search path. +Assuming that you run all tests from the root of the repository tree, +this will do the job: + + export PERL5LIB=t:bin:lib + +(Not all tests require all of these, but it's safer to include all of +them.) + +Secondly, be aware that if you want to test modifications to the +source files, you will need to run `make watch`, or `make` before each +test run as explained above. + +Now running an individual test is as simple as: + + perl t/chkstow.t + +or with a given debugging verbosity corresponding to the `-v` / `--verbose` +command-line option: + + TEST_VERBOSE=4 perl t/chkstow.t + +The [`prove(1)` test runner](https://perldoc.perl.org/prove) is another +good alternative which provides several handy extra features. Invocation +is very similar, e.g.: + + prove t/stow.t + +or to run the whole suite: + + prove + +However currently there is an issue where this interferes with +`TEST_VERBOSE`. + +If you want to create test files for experimentation, it is +recommended to put them in a subdirectory called `playground/` since +this will be automatically ignored by git and the build process, +avoiding any undesirable complications. + +Test coverage +~~~~~~~~~~~~~ + +To view test coverage reports, first ensure that +[`Devel::Cover`](https://metacpan.org/dist/Devel-Cover) is installed. +Then type `make coverage`. The last lines of the output should +include something like: + + HTML output written to /home/user/path/to/stow/cover_db/coverage.html + +which you can open in a web browser to view the report. + +Translating Stow +---------------- + +Stow is not currently multi-lingual, but patches would be very +gratefully accepted. Please e-mail +[stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel) if you +intend to work on this. + +Maintainers +----------- + +Stow is currently being maintained by Adam Spiers. Please use [the +mailing lists](README.md#mailing-lists). + +Helping the GNU project +----------------------- + +For more general information, please read [How to help +GNU](https://www.gnu.org/help/). diff --git a/MANIFEST b/MANIFEST index ae4a0cd..09cb2bf 100644 --- a/MANIFEST +++ b/MANIFEST @@ -3,6 +3,7 @@ aclocal.m4 automake/install-sh automake/mdate-sh automake/missing +automake/texinfo.tex bin/chkstow bin/chkstow.in bin/stow @@ -11,6 +12,7 @@ Build.PL ChangeLog configure configure.ac +CONTRIBUTING.md COPYING default-ignore-list doc/ChangeLog.OLD @@ -19,7 +21,6 @@ doc/manual.pdf doc/stow.8 doc/stow.info doc/stow.texi -doc/texinfo.tex doc/version.texi INSTALL.md lib/Stow.pm @@ -43,12 +44,12 @@ t/find_stowed_path.t t/foldable.t t/ignore.t t/join_paths.t +t/link_dest_within_stow_dir.t t/parent.t t/stow.t t/rc_options.t t/testutil.pm t/unstow.t -t/unstow_orig.t tools/get-version THANKS TODO diff --git a/MANIFEST.SKIP b/MANIFEST.SKIP index 259024a..522b3fd 100644 --- a/MANIFEST.SKIP +++ b/MANIFEST.SKIP @@ -83,7 +83,14 @@ ^doc/HOWTO-RELEASE$ # Avoid test files -tmp-testing-trees -.travis.yml +tmp-testing-trees* +^.coveralls.yml +^.github/workflows/ +^.travis.yml ^docker/ ^[a-zA-Z]*-docker.sh +^playground/ + +# Avoid development config +^.dir-locals.el +^.dumbjump diff --git a/META.json b/META.json index 7c582ce..a94e94f 100644 --- a/META.json +++ b/META.json @@ -4,7 +4,7 @@ "unknown" ], "dynamic_config" : 1, - "generated_by" : "Module::Build version 0.4224", + "generated_by" : "Module::Build version 0.4234", "license" : [ "gpl_1" ], @@ -37,11 +37,11 @@ "provides" : { "Stow" : { "file" : "lib/Stow.pm", - "version" : "v2.3.2-fixbug56727" + "version" : "v2.4.0" }, "Stow::Util" : { "file" : "lib/Stow/Util.pm", - "version" : "v2.3.2-fixbug56727" + "version" : "v2.4.0" } }, "release_status" : "stable", @@ -55,6 +55,6 @@ "url" : "git://git.savannah.gnu.org/stow.git" } }, - "version" : "v2.3.2-fixbug56727", - "x_serialization_backend" : "JSON::PP version 4.00" + "version" : "v2.4.0", + "x_serialization_backend" : "JSON::PP version 4.16" } diff --git a/META.yml b/META.yml index f7da35a..f59b25b 100644 --- a/META.yml +++ b/META.yml @@ -9,7 +9,7 @@ build_requires: configure_requires: Module::Build: '0' dynamic_config: 1 -generated_by: 'Module::Build version 0.4224, CPAN::Meta::Converter version 2.150010' +generated_by: 'Module::Build version 0.4234, CPAN::Meta::Converter version 2.150010' license: gpl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html @@ -18,10 +18,10 @@ name: Stow provides: Stow: file: lib/Stow.pm - version: v2.3.2-fixbug56727 + version: v2.4.0 Stow::Util: file: lib/Stow/Util.pm - version: v2.3.2-fixbug56727 + version: v2.4.0 requires: Carp: '0' IO::File: '0' @@ -30,5 +30,5 @@ resources: homepage: https://savannah.gnu.org/projects/stow license: http://www.gnu.org/licenses/gpl-2.0.html repository: git://git.savannah.gnu.org/stow.git -version: v2.3.2-fixbug56727 +version: v2.4.0 x_serialization_backend: 'CPAN::Meta::YAML version 0.018' diff --git a/Makefile.am b/Makefile.am index ab99056..43d7f3b 100644 --- a/Makefile.am +++ b/Makefile.am @@ -32,26 +32,26 @@ pmstowdir = $(pmdir)/Stow pm_DATA = lib/Stow.pm pmstow_DATA = lib/Stow/Util.pm -TEXINFO_TEX = doc/texinfo.tex export TEXI2DVI_BUILD_MODE = clean AM_MAKEINFOFLAGS = -I $(srcdir) # We require this -I parameter to ensure that the include of the -# default ignore list in the manual works. Unfortunately this is -# the only way to do it: +# default ignore list in the manual works correctly, even when the +# manual is being built via make distcheck from a different directory. +# Unfortunately this is the only way to do it: # -# http://article.gmane.org/gmane.comp.sysutils.automake.bugs/4334/match=passing+parameters +# https://lists.gnu.org/archive/html/bug-automake/2008-09/msg00040.html # # even though it annoyingly produces a warning with the -Wall option # to AM_INIT_AUTOMAKE which has to be silenced via -Wno-override. TEXI2DVI = texi2dvi $(AM_MAKEINFOFLAGS) -doc_deps = $(info_TEXINFOS) doc/version.texi - DEFAULT_IGNORE_LIST = $(srcdir)/default-ignore-list +doc_deps = $(info_TEXINFOS) doc/version.texi $(DEFAULT_IGNORE_LIST) + TESTS_DIR = $(srcdir)/t -TESTS_OUT = tmp-testing-trees +TESTS_OUT = tmp-testing-trees tmp-testing-trees-compat TESTS_ENVIRONMENT = $(PERL) -Ibin -Ilib -I$(TESTS_DIR) # This is a kind of hack; TESTS needs to be set to ensure that the @@ -77,7 +77,7 @@ check_DATA = $(TESTS_OUT) # Note that automake's `check' rule cannot be overridden # for some weird reason: # -# http://thread.gmane.org/gmane.comp.sysutils.automake.general/13040/focus=13041 +# https://lists.gnu.org/archive/html/automake/2011-09/msg00029.html # # so we override check-TESTS instead which is where the real work is # done anyway. Unfortunately this produces a warning with the -Wall @@ -87,6 +87,10 @@ check-TESTS: dir=$(TESTS_DIR); \ $(TESTS_ENVIRONMENT) -MTest::Harness -e 'runtests(@ARGV)' "$${dir#./}"/*.t +coverage: + PERL5OPT=-MDevel::Cover $(MAKE) check-TESTS + cover + $(TESTS_OUT): mkdir -p $@ @@ -95,7 +99,6 @@ EXTRA_DIST = \ bin/stow.in bin/chkstow.in lib/Stow.pm.in lib/Stow/Util.pm.in \ doc/manual-split \ $(TESTS) t/testutil.pm \ - $(TEXINFO_TEX) \ $(DEFAULT_IGNORE_LIST) \ $(CPAN_FILES) CLEANFILES = $(bin_SCRIPTS) $(pm_DATA) $(pmstow_DATA) @@ -193,7 +196,7 @@ doc/stow.8: bin/stow.in Makefile.am # # If it were not for a troublesome dependency on doc/$(am__dirstamp): # -# http://article.gmane.org/gmane.comp.sysutils.automake.general/13192 +# https://lists.gnu.org/archive/html/automake/2011-11/msg00107.html # # we could have achieved this using the built-in rules combined with # install-data-hook to rename from stow.pdf to manual.pdf etc. on @@ -302,3 +305,28 @@ ChangeLog: doc/ChangeLog.OLD else \ echo "Not in a git repository; can't update ChangeLog."; \ fi + +# Watch for changes, and if any rebuilds are required, also do a +# make install. +# +# If we solved https://github.com/aspiers/stow/issues/84, we could +# probably ditch this: +watch: + @echo "Watching for changes to program source files ..." + @while true; do \ + if $(MAKE) 2>&1 | \ + grep -vE 'make\[[1-9]\]: (Entering|Leaving) directory ' | \ + grep -v 'Nothing to be done'; \ + then \ + echo; \ + echo "-----------------------------------------------------"; \ + echo "make found things to rebuild; doing $(MAKE) install ..."; \ + echo; \ + $(MAKE) install; \ + echo; \ + echo ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"; \ + echo; \ + fi; \ + sleep 1; \ + done 2>&1 | \ + grep -vE 'make\[[1-9]\]: (Entering|Leaving) directory ' diff --git a/NEWS b/NEWS index 7a398ac..490cb6c 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,81 @@ News file for Stow. +* Changes in version 2.4.0 + +*** --dotfiles now works with directories + + A long-standing bug preventing the --dotfiles option from working + correctly with directories has been fixed. + + It should also works in combination with the --compat option. + +*** Eliminated a spurious warning on unstowing + + 2.3.1 introduced a benign but annoying warning when unstowing + in certain circumstances. It looked like: + + BUG in find_stowed_path? Absolute/relative mismatch between Stow dir X and path Y + + This was caused by erroneous logic, and has now been fixed. + +*** Unstowing logic has been improved in other cases + + Several other improvements have been made internally to the + unstowing logic. These changes should all be either invisible + (except for changes to debug output) or improvements, but if you + encounter any unexpected behaviour, please report it as directed + in the manual. + +*** Improved debug output + + Extra output resulting from use of the -v / --verbose flag + now appears in a more logical and understandable way. + +*** Janitorial tasks + + Users are not substantially affected by these changes. + +***** Added some more information from the web page to the README + +***** Made some improvements to the documentation + +***** Improve readability of source code + + Quite a few extra details have been added in comments to clarify + how the code works. Many variable names have also been + improved. The comments of many Stow class methods have been + converted into Perl POD format. + +***** Added a =CONTRIBUTING.md= file + +***** Add a =watch= target to =Makefile= + + =make watch= provides easy continual pre-processing during + development, which reduces the risk of debugging the wrong code. + +***** Removed texinfo.tex from the distribution + + This eliminates existing and future bit-rot. + +***** Updated aclocal.m4 from 1.15.1 to 1.16.5 + + This mostly just updates copyright notices to 2021, and URLs to https. + +***** Replace broken gmane links with links to lists.gnu.org + + [[https://lars.ingebrigtsen.no/2020/01/06/whatever-happened-to-news-gmane-org/][gmane has been dead for quite a while.]] + +***** Improve support for navigating / editing source via emacs + +******* Support source navigation in emacs via [[https://github.com/jacktasia/dumb-jump][dumb-jump]]. + +******* Configure cperl-mode to match existing coding style. + +*** Various maintainer tweaks + + Further improved the release process and its documentation in + various minor ways. + * Changes in version 2.3.1 *** Remove dependencies on Hash::Merge and Clone::Choose @@ -138,6 +214,7 @@ News file for Stow. consistency. - INSTALL.md now also documents how to build directly from git. + *** Fixes for bugs, tests, and other technical debt ***** Add Docker files for convenient testing across multiple Perl versions @@ -235,7 +312,7 @@ due to Stow::Util missing $VERSION. stow directory path being calculated as ../../../usr/home/user/local/stow relative to the target. - See http://article.gmane.org/gmane.comp.gnu.stow.bugs/8820 for details. + See https://lists.gnu.org/archive/html/bug-stow/2013-04/msg00000.html for details. *** Fix stowing of relative links when --no-folding is used. @@ -276,7 +353,7 @@ due to Stow::Util missing $VERSION. Thanks to Gabriele Balducci for reporting this problem: - http://thread.gmane.org/gmane.comp.gnu.stow.general/6676 + https://lists.gnu.org/archive/html/help-stow/2014-09/msg00000.html *** Internal code cleanups @@ -586,4 +663,5 @@ due to Stow::Util missing $VERSION. org-export-with-toc: nil org-export-with-author: nil org-toc-odd-levels-only: t + org-blank-before-new-entry: ((heading . auto) (plain-list-item . auto)) End: diff --git a/README.md b/README.md index 525a573..d91c9a4 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,56 @@ You can get the latest information about Stow from the home page: http://www.gnu.org/software/stow/ +Installation +------------ + +See [`INSTALL.md`](INSTALL.md) for installation instructions. + +Documentation +------------- + +Documentation for Stow is available +[online](https://www.gnu.org/software/stow/manual/), as is +[documentation for most GNU +software](https://www.gnu.org/software/manual/). Once you have Stow +installed, you may also find more information about Stow by running +`info stow` or `man stow`, or by looking at `/usr/share/doc/stow/`, +`/usr/local/doc/stow/`, or similar directories on your system. A +brief summary is available by running `stow --help`. + +Mailing lists +------------- + +Stow has the following mailing lists: + +- [help-stow](https://lists.gnu.org/mailman/listinfo/help-stow) is for + general user help and discussion. +- [stow-devel](https://lists.gnu.org/mailman/listinfo/stow-devel) is + used to discuss most aspects of Stow, including development and + enhancement requests. +- [bug-stow](https://lists.gnu.org/mailman/listinfo/bug-stow) is for + bug reports. + +Announcements about Stow are posted to +[info-stow](http://lists.gnu.org/mailman/listinfo/info-stow) and also, +as with most other GNU software, to +[info-gnu](http://lists.gnu.org/mailman/listinfo/info-gnu) +([archive](http://lists.gnu.org/archive/html/info-gnu/)). + +Security reports that should not be made immediately public can be +sent directly to the maintainer. If there is no response to an urgent +issue, you can escalate to the general +[security](http://lists.gnu.org/mailman/listinfo/security) mailing +list for advice. + +The Savannah project also has a [mailing +lists](https://savannah.gnu.org/mail/?group=stow) page. + +Getting involved +---------------- + +Please see the [`CONTRIBUTING.md` file](CONTRIBUTING.md). + License ------- @@ -71,18 +121,6 @@ are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty. -Installation ------------- - -See [`INSTALL.md`](INSTALL.md) for installation instructions. - -Feedback --------- - -Please do send comments, questions, and constructive criticism. The -mailing lists and any other communication channels are detailed on the -above home page. - Brief history and authorship ---------------------------- diff --git a/TODO b/TODO index a42d4cb..c2da1f4 100644 --- a/TODO +++ b/TODO @@ -4,7 +4,7 @@ install-info, amongst other things: *** http://unix.stackexchange.com/questions/73426/dealing-with-gnu-stow-conflicts -*** http://article.gmane.org/gmane.comp.gnu.stow.general/6661 +*** https://lists.gnu.org/archive/html/help-stow/2013-04/msg00016.html * Get permission for next documentation release to be under FDL 1.3 diff --git a/aclocal.m4 b/aclocal.m4 index 6d04fca..53cbb40 100644 --- a/aclocal.m4 +++ b/aclocal.m4 @@ -14,8 +14,8 @@ m4_ifndef([AC_CONFIG_MACRO_DIRS], [m4_defun([_AM_CONFIG_MACRO_DIRS], [])m4_defun([AC_CONFIG_MACRO_DIRS], [_AM_CONFIG_MACRO_DIRS($@)])]) m4_ifndef([AC_AUTOCONF_VERSION], [m4_copy([m4_PACKAGE_VERSION], [AC_AUTOCONF_VERSION])])dnl -m4_if(m4_defn([AC_AUTOCONF_VERSION]), [2.71],, -[m4_warning([this file was generated for autoconf 2.71. +m4_if(m4_defn([AC_AUTOCONF_VERSION]), [2.72],, +[m4_warning([this file was generated for autoconf 2.72. You have another version of autoconf. It may work, but is not guaranteed to. If you have problems, you may need to regenerate the build system entirely. To do so, use the procedure documented by the package, typically 'autoreconf'.])]) diff --git a/automake/.gitignore b/automake/.gitignore index f23d52a..cfd5146 100644 --- a/automake/.gitignore +++ b/automake/.gitignore @@ -2,3 +2,4 @@ install-sh missing mdate-sh test-driver +texinfo.tex diff --git a/bin/chkstow.in b/bin/chkstow.in index b583b32..e23774d 100755 --- a/bin/chkstow.in +++ b/bin/chkstow.in @@ -123,6 +123,5 @@ sub list { # Local variables: # mode: perl -# cperl-indent-level: 4 # End: # vim: ft=perl diff --git a/bin/stow.in b/bin/stow.in index 76b150c..024b152 100755 --- a/bin/stow.in +++ b/bin/stow.in @@ -474,7 +474,6 @@ sub main { my ($options, $pkgs_to_unstow, $pkgs_to_stow) = process_options(); my $stow = new Stow(%$options); - # current dir is now the target directory $stow->plan_unstow(@$pkgs_to_unstow); $stow->plan_stow (@$pkgs_to_stow); @@ -849,6 +848,5 @@ sub version { # Local variables: # mode: perl -# cperl-indent-level: 4 # end: # vim: ft=perl diff --git a/configure.ac b/configure.ac index 0869e17..33b7163 100644 --- a/configure.ac +++ b/configure.ac @@ -15,11 +15,11 @@ dnl along with this program. If not, see https://www.gnu.org/licenses/. dnl Process this file with Autoconf to produce configure dnl -AC_INIT([stow], [2.3.2-fixbug56727], [bug-stow@gnu.org]) +AC_INIT([stow], [2.4.0], [bug-stow@gnu.org]) AC_PREREQ([2.61]) AC_CONFIG_AUX_DIR([automake]) # Unfortunately we have to disable warnings for overrides, because we -# need to override the built-in `check' rule and also the TEXI2DVI +# need to override the built-in `check-TESTS' rule and also the TEXI2DVI # variable. AM_INIT_AUTOMAKE([-Wall -Werror -Wno-override dist-bzip2 foreign]) AC_PROG_INSTALL diff --git a/default-ignore-list b/default-ignore-list index 17bf13d..0ebf4fb 100644 --- a/default-ignore-list +++ b/default-ignore-list @@ -13,6 +13,7 @@ _darcs \.git \.gitignore +\.gitmodules .+~ # emacs backup files \#.*\# # emacs autosave files diff --git a/doc/HOWTO-RELEASE b/doc/HOWTO-RELEASE index 2b0daab..fb72cec 100644 --- a/doc/HOWTO-RELEASE +++ b/doc/HOWTO-RELEASE @@ -21,17 +21,16 @@ Release procedure version=$( tools/get-version ) && echo $version -- Ensure NEWS contains the latest changes, and that any new - contributors have been added to THANKS. If necessary, commit +- Ensure NEWS contains the latest changes. If necessary, commit any additions: - git commit -m "Prepare NEWS and THANKS for $version release" + git commit -m "Prepare NEWS for $version release" - Check CPAN distribution will work via Module::Build: - Start from a clean slate: - make distclean + make maintainer-clean autoreconf -iv - Generate stow, chkstow, and lib/Stow.pm via: diff --git a/doc/stow.texi b/doc/stow.texi index 0b00860..a875308 100644 --- a/doc/stow.texi +++ b/doc/stow.texi @@ -19,13 +19,13 @@ This manual describes GNU Stow version @value{VERSION} Software and documentation is copyrighted by the following: -@copyright{} 1993, 1994, 1995, 1996 Bob Glickstein +@copyright{} 1993, 1994, 1995, 1996 Bob Glickstein @email{bobg+stow@@zanshin.com} @* -@copyright{} 2000, 2001 Guillaume Morin +@copyright{} 2000, 2001 Guillaume Morin @email{gmorin@@gnu.org} @* -@copyright{} 2007 Kahlil (Kal) Hodgson +@copyright{} 2007 Kahlil (Kal) Hodgson @email{kahlil@@internode.on.net} @* -@copyright{} 2011 Adam Spiers +@copyright{} 2011 Adam Spiers @email{stow@@adamspiers.org} @quotation Permission is granted to make and distribute verbatim copies of this @@ -99,7 +99,7 @@ appear to be installed in a single directory tree. * Multiple Stow Directories:: Further segregating software. * Target Maintenance:: Cleaning up mistakes. * Resource Files:: Setting default command line options. -* Compile-time vs Install-time:: Faking out `make install'. +* Compile-time vs. Install-time:: Faking out `make install'. * Bootstrapping:: When stow and perl are not yet stowed. * Reporting Bugs:: How, what, where, and when to report. * Known Bugs:: Don't report any of these. @@ -220,9 +220,12 @@ to be installed in a particular directory structure --- e.g., with @cindex target directory A @dfn{target directory} is the root of a tree in which one or more -packages wish to @emph{appear} to be installed. A common, but by no -means the only such location is @file{/usr/local}. The examples in this -manual will use @file{/usr/local} as the target directory. +packages wish to @emph{appear} to be installed. @file{/usr/local} is a +common choice for this, but by no means the only such location. Another +common choice is @file{~} (i.e.@: the user's @code{$HOME} directory) in +the case where Stow is being used to manage the user's configuration +(``dotfiles'') and other files in their @code{$HOME}. The examples in +this manual will use @file{/usr/local} as the target directory. @cindex stow directory A @dfn{stow directory} is the root of a tree containing separate @@ -240,6 +243,11 @@ installation image for Perl includes: a @file{bin} directory containing containing Texinfo documentation; a @file{lib/perl} directory containing Perl libraries; and a @file{man/man1} directory containing man pages. +@quotation Note +This is a @emph{pre-}installation image which exists even before Stow +has installed any symlinks into the target directory which point to it. +@end quotation + @cindex package directory @cindex package name A @dfn{package directory} is the root of a tree containing the @@ -255,15 +263,68 @@ target directory, @file{/usr/local/stow} is the stow directory, @file{/usr/local/stow/perl} is the package directory, and @file{bin/perl} within is part of the installation image. +@anchor{symlink} @cindex symlink +@cindex symlink source +@cindex symlink destination @cindex relative symlink @cindex absolute symlink -A @dfn{symlink} is a symbolic link. A symlink can be @dfn{relative} or -@dfn{absolute}. An absolute symlink names a full path; that is, one -starting from @file{/}. A relative symlink names a relative path; that -is, one not starting from @file{/}. The target of a relative symlink is -computed starting from the symlink's own directory. Stow only -creates relative symlinks. +A @dfn{symlink} is a symbolic link, i.e.@: an entry on the filesystem +whose path is sometimes called the @dfn{symlink source}, which points to +another location on the filesystem called the @dfn{symlink destination}. +There is no guarantee that the destination actually exists. + +In general, symlinks can be @dfn{relative} or @dfn{absolute}. A symlink +is absolute when the destination names a full path; that is, one +starting from @file{/}. A symlink is relative when the destination +names a relative path; that is, one not starting from @file{/}. The +destination of a relative symlink is computed starting from the +symlink's own directory, i.e.@: the directory containing the symlink +source. + +@quotation Note +Stow only creates symlinks within the target directory which point to +locations @emph{outside} the target directory and inside the stow +directory. + +Consequently, we avoid referring to symlink destinations as symlink +@emph{targets}, since this would result in the word ``target'' having +two different meanings: + +@enumerate + +@item +the target directory, i.e.@: the directory into which Stow targets +installation, where symlinks are managed by Stow, and + +@item +the destinations of those symlinks. + +@end enumerate + +If we did not avoid the second meaning of ``target'', then it would lead +to confusing language, such as describing Stow as installing symlinks +into the target directory which point to targets @emph{outside} the +target directory. + +Similarly, the word ``source'' can have two different meanings in this +context: + +@enumerate + +@item +the installation image, or some of its contents, and + +@item +the location of symlinks (the ``source'' of the link, vs.@: its +destination). + +@end enumerate + +Therefore it should also be avoided, or at least care taken to ensure +that the meaning is not ambiguous. + +@end quotation @c =========================================================================== @node Invoking Stow, Ignore Lists, Terminology, Top @@ -383,7 +444,7 @@ refolding (@pxref{tree refolding}). If a new subdirectory is encountered whilst stowing a new package, the subdirectory is created within the target, and its contents are symlinked, rather than just creating a symlink for the directory. If removal of symlinks whilst -unstowing a package causes a subtree to be foldable (i.e. only +unstowing a package causes a subtree to be foldable (i.e.@: only containing symlinks to a single package), that subtree will not be removed and replaced with a symlink. @@ -428,13 +489,15 @@ doing. Verbosity levels are from 0 to 5; 0 is the default. Using @item -p @itemx --compat -Scan the whole target tree when unstowing. By default, only -directories specified in the @dfn{installation image} are scanned -during an unstow operation. Scanning the whole tree can be -prohibitive if your target tree is very large. This option restores -the legacy behaviour; however, the @option{--badlinks} option to the -@command{chkstow} utility may be a better way of ensuring that your -installation does not have any dangling symlinks (@pxref{Target +Scan the whole target tree when unstowing. By default, only directories +specified in the @dfn{installation image} are scanned during an unstow +operation. Previously Stow scanned the whole tree, which can be +prohibitive if your target tree is very large, but on the other hand has +the advantage of unstowing previously stowed links which are no longer +present in the installation image and therefore orphaned. This option +restores the legacy behaviour; however, the @option{--badlinks} option +to the @command{chkstow} utility may be a better way of ensuring that +your installation does not have any dangling symlinks (@pxref{Target Maintenance}). @item -V @@ -813,7 +876,7 @@ This is much faster and cleaner than performing two separate invocations of stow, because redundant folding/unfolding operations can be factored out. In addition, all the operations are calculated and merged before being executed (@pxref{Deferred Operation}), so the -amount of of time in which GNU Emacs is unavailable is minimised. +amount of time in which GNU Emacs is unavailable is minimised. You can mix and match any number of actions, for example, @@ -893,7 +956,7 @@ directory. @end table @c =========================================================================== -@node Resource Files, Compile-time vs Install-time, Target Maintenance, Top +@node Resource Files, Compile-time vs. Install-time, Target Maintenance, Top @chapter Resource Files @cindex resource files @cindex configuration files @@ -960,8 +1023,8 @@ resource files. This is also true of any package names given in the resource file. @c =========================================================================== -@node Compile-time vs Install-time, Bootstrapping, Resource Files, Top -@chapter Compile-time vs Install-time +@node Compile-time vs. Install-time, Bootstrapping, Resource Files, Top +@chapter Compile-time vs. Install-time Software whose installation is managed with Stow needs to be installed in one place (the package directory, e.g. @file{/usr/local/stow/perl}) @@ -1043,7 +1106,7 @@ following sections. @end menu @c --------------------------------------------------------------------------- -@node GNU Emacs, Other FSF Software, Compile-time vs Install-time, Compile-time vs Install-time +@node GNU Emacs, Other FSF Software, Compile-time vs. Install-time, Compile-time vs. Install-time @section GNU Emacs Although the Free Software Foundation has many enlightened practices @@ -1076,7 +1139,7 @@ make do-install prefix=/usr/local/stow/emacs @end example @c --------------------------------------------------------------------------- -@node Other FSF Software, Cygnus Software, GNU Emacs, Compile-time vs Install-time +@node Other FSF Software, Cygnus Software, GNU Emacs, Compile-time vs. Install-time @section Other FSF Software The Free Software Foundation, the organization behind the GNU project, @@ -1097,7 +1160,7 @@ and @samp{make install} steps to work correctly without needing to ``fool'' the build process. @c --------------------------------------------------------------------------- -@node Cygnus Software, Perl and Perl 5 Modules, Other FSF Software, Compile-time vs Install-time +@node Cygnus Software, Perl and Perl 5 Modules, Other FSF Software, Compile-time vs. Install-time @section Cygnus Software Cygnus is a commercial supplier and supporter of GNU software. It has @@ -1126,7 +1189,7 @@ is recompiling files. Usually it will work just fine; otherwise, install manually. @c --------------------------------------------------------------------------- -@node Perl and Perl 5 Modules, , Cygnus Software, Compile-time vs Install-time +@node Perl and Perl 5 Modules, , Cygnus Software, Compile-time vs. Install-time @section Perl and Perl 5 Modules Perl 4.036 allows you to specify different locations for installation @@ -1229,7 +1292,7 @@ find cpan.* \( -name .exists -o -name perllocal.pod \) -print | \ @c --------------------------------------------------------------------------- -@node Bootstrapping, Reporting Bugs, Compile-time vs Install-time, Top +@node Bootstrapping, Reporting Bugs, Compile-time vs. Install-time, Top @chapter Bootstrapping Suppose you have a stow directory all set up and ready to go: @@ -1264,9 +1327,32 @@ perl/bin/perl stow/bin/stow -vv * @node Reporting Bugs, Known Bugs, Bootstrapping, Top @chapter Reporting Bugs -Please send bug reports to the current maintainers by electronic -mail. The address to use is @samp{}. Please -include: +You can report bugs to the current maintainers in one of three ways: + +@enumerate +@item +Send e-mail to @email{bug-stow@@gnu.org}. + +@item +File an issue in @uref{https://savannah.gnu.org/bugs/?group=stow, +the Savannah bug tracker}. + +@item +File an issue in +@uref{https://github.com/aspiers/stow/issues/, the GitHub project}. +@end enumerate + +While GitHub is arguably the most convenient of these three options, it +@uref{https://www.gnu.org/software/repo-criteria-evaluation.html#GitHub, +is not the most ethical or freedom-preserving way to host software +projects}. Therefore the GitHub project may be +@uref{https://github.com/aspiers/stow/issues/43, moved to a more ethical +hosting service} in the future. + +Before reporting a bug, it is recommended to check whether it is already +known, so please first @pxref{Known Bugs}. + +When reporting a new bug, please include: @itemize @bullet @item @@ -1287,12 +1373,13 @@ the precise command you gave; @item the output from the command (preferably verbose output, obtained by -adding @samp{--verbose=3} to the Stow command line). +adding @samp{--verbose=5} to the Stow command line). @end itemize If you are really keen, consider developing a minimal test case and -creating a new test. See the @file{t/} directory in the source for -lots of examples. +creating a new test. See the @file{t/} directory in the source for lots +of examples, and the @file{CONTRIBUTING.md} file for a guide on how to +contribute. Before reporting a bug, please read the manual carefully, especially @ref{Known Bugs}, to see whether you're encountering @@ -1303,13 +1390,22 @@ something that doesn't need reporting. @node Known Bugs, GNU General Public License, Reporting Bugs, Top @chapter Known Bugs -There are no known bugs in Stow version @value{VERSION}! -If you think you have found one, please @pxref{Reporting Bugs}. +Known bugs can be found in the following locations: -@c @itemize @bullet -@c @item -@c Put known bugs here -@c @end itemize +@itemize +@item +@uref{https://github.com/aspiers/stow/issues/, the GitHub issue tracker} + +@item +@uref{https://savannah.gnu.org/bugs/?group=stow, the Savannah bug +tracker} + +@item +the @uref{https://lists.gnu.org/archive/html/bug-stow/, bug-stow list +archives} +@end itemize + +If you think you have found a new bug, please @pxref{Reporting Bugs}. @c =========================================================================== @node GNU General Public License, Index, Known Bugs, Top diff --git a/doc/texinfo.tex b/doc/texinfo.tex deleted file mode 100644 index f15767d..0000000 --- a/doc/texinfo.tex +++ /dev/null @@ -1,7482 +0,0 @@ -% texinfo.tex -- TeX macros to handle Texinfo files. -% -% Load plain if necessary, i.e., if running under initex. -\expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi -% -\def\texinfoversion{2011-11-21.13} -% -% Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995, -% 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free -% Software Foundation, Inc. -% -% This texinfo.tex file is free software; you can redistribute it and/or -% modify it under the terms of the GNU General Public License as -% published by the Free Software Foundation; either version 2, or (at -% your option) any later version. -% -% This texinfo.tex file is distributed in the hope that it will be -% useful, but WITHOUT ANY WARRANTY; without even the implied warranty -% of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -% General Public License for more details. -% -% You should have received a copy of the GNU General Public License -% along with this texinfo.tex file; see the file COPYING. If not, write -% to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, -% Boston, MA 02110-1301, USA. -% -% As a special exception, when this file is read by TeX when processing -% a Texinfo source document, you may use the result without -% restriction. (This has been our intent since Texinfo was invented.) -% -% Please try the latest version of texinfo.tex before submitting bug -% reports; you can get the latest version from: -% http://www.gnu.org/software/texinfo/ (the Texinfo home page), or -% ftp://tug.org/tex/texinfo.tex -% (and all CTAN mirrors, see http://www.ctan.org). -% The texinfo.tex in any given distribution could well be out -% of date, so if that's what you're using, please check. -% -% Send bug reports to bug-texinfo@gnu.org. Please include including a -% complete document in each bug report with which we can reproduce the -% problem. Patches are, of course, greatly appreciated. -% -% To process a Texinfo manual with TeX, it's most reliable to use the -% texi2dvi shell script that comes with the distribution. For a simple -% manual foo.texi, however, you can get away with this: -% tex foo.texi -% texindex foo.?? -% tex foo.texi -% tex foo.texi -% dvips foo.dvi -o # or whatever; this makes foo.ps. -% The extra TeX runs get the cross-reference information correct. -% Sometimes one run after texindex suffices, and sometimes you need more -% than two; texi2dvi does it as many times as necessary. -% -% It is possible to adapt texinfo.tex for other languages, to some -% extent. You can get the existing language-specific files from the -% full Texinfo distribution. -% -% The GNU Texinfo home page is http://www.gnu.org/software/texinfo. - - -\message{Loading texinfo [version \texinfoversion]:} - -% If in a .fmt file, print the version number -% and turn on active characters that we couldn't do earlier because -% they might have appeared in the input file name. -\everyjob{\message{[Texinfo version \texinfoversion]}% - \catcode`+=\active \catcode`\_=\active} - -\message{Basics,} -\chardef\other=12 - -% We never want plain's \outer definition of \+ in Texinfo. -% For @tex, we can use \tabalign. -\let\+ = \relax - -% Save some plain tex macros whose names we will redefine. -\let\ptexb=\b -\let\ptexbullet=\bullet -\let\ptexc=\c -\let\ptexcomma=\, -\let\ptexdot=\. -\let\ptexdots=\dots -\let\ptexend=\end -\let\ptexequiv=\equiv -\let\ptexexclam=\! -\let\ptexfootnote=\footnote -\let\ptexgtr=> -\let\ptexhat=^ -\let\ptexi=\i -\let\ptexindent=\indent -\let\ptexinsert=\insert -\let\ptexlbrace=\{ -\let\ptexless=< -\let\ptexnewwrite\newwrite -\let\ptexnoindent=\noindent -\let\ptexplus=+ -\let\ptexrbrace=\} -\let\ptexslash=\/ -\let\ptexstar=\* -\let\ptext=\t - -% If this character appears in an error message or help string, it -% starts a new line in the output. -\newlinechar = `^^J - -% Use TeX 3.0's \inputlineno to get the line number, for better error -% messages, but if we're using an old version of TeX, don't do anything. -% -\ifx\inputlineno\thisisundefined - \let\linenumber = \empty % Pre-3.0. -\else - \def\linenumber{l.\the\inputlineno:\space} -\fi - -% Set up fixed words for English if not already set. -\ifx\putwordAppendix\undefined \gdef\putwordAppendix{Appendix}\fi -\ifx\putwordChapter\undefined \gdef\putwordChapter{Chapter}\fi -\ifx\putwordfile\undefined \gdef\putwordfile{file}\fi -\ifx\putwordin\undefined \gdef\putwordin{in}\fi -\ifx\putwordIndexIsEmpty\undefined \gdef\putwordIndexIsEmpty{(Index is empty)}\fi -\ifx\putwordIndexNonexistent\undefined \gdef\putwordIndexNonexistent{(Index is nonexistent)}\fi -\ifx\putwordInfo\undefined \gdef\putwordInfo{Info}\fi -\ifx\putwordInstanceVariableof\undefined \gdef\putwordInstanceVariableof{Instance Variable of}\fi -\ifx\putwordMethodon\undefined \gdef\putwordMethodon{Method on}\fi -\ifx\putwordNoTitle\undefined \gdef\putwordNoTitle{No Title}\fi -\ifx\putwordof\undefined \gdef\putwordof{of}\fi -\ifx\putwordon\undefined \gdef\putwordon{on}\fi -\ifx\putwordpage\undefined \gdef\putwordpage{page}\fi -\ifx\putwordsection\undefined \gdef\putwordsection{section}\fi -\ifx\putwordSection\undefined \gdef\putwordSection{Section}\fi -\ifx\putwordsee\undefined \gdef\putwordsee{see}\fi -\ifx\putwordSee\undefined \gdef\putwordSee{See}\fi -\ifx\putwordShortTOC\undefined \gdef\putwordShortTOC{Short Contents}\fi -\ifx\putwordTOC\undefined \gdef\putwordTOC{Table of Contents}\fi -% -\ifx\putwordMJan\undefined \gdef\putwordMJan{January}\fi -\ifx\putwordMFeb\undefined \gdef\putwordMFeb{February}\fi -\ifx\putwordMMar\undefined \gdef\putwordMMar{March}\fi -\ifx\putwordMApr\undefined \gdef\putwordMApr{April}\fi -\ifx\putwordMMay\undefined \gdef\putwordMMay{May}\fi -\ifx\putwordMJun\undefined \gdef\putwordMJun{June}\fi -\ifx\putwordMJul\undefined \gdef\putwordMJul{July}\fi -\ifx\putwordMAug\undefined \gdef\putwordMAug{August}\fi -\ifx\putwordMSep\undefined \gdef\putwordMSep{September}\fi -\ifx\putwordMOct\undefined \gdef\putwordMOct{October}\fi -\ifx\putwordMNov\undefined \gdef\putwordMNov{November}\fi -\ifx\putwordMDec\undefined \gdef\putwordMDec{December}\fi -% -\ifx\putwordDefmac\undefined \gdef\putwordDefmac{Macro}\fi -\ifx\putwordDefspec\undefined \gdef\putwordDefspec{Special Form}\fi -\ifx\putwordDefvar\undefined \gdef\putwordDefvar{Variable}\fi -\ifx\putwordDefopt\undefined \gdef\putwordDefopt{User Option}\fi -\ifx\putwordDeffunc\undefined \gdef\putwordDeffunc{Function}\fi - -% Since the category of space is not known, we have to be careful. -\chardef\spacecat = 10 -\def\spaceisspace{\catcode`\ =\spacecat} - -% sometimes characters are active, so we need control sequences. -\chardef\colonChar = `\: -\chardef\commaChar = `\, -\chardef\dashChar = `\- -\chardef\dotChar = `\. -\chardef\exclamChar= `\! -\chardef\lquoteChar= `\` -\chardef\questChar = `\? -\chardef\rquoteChar= `\' -\chardef\semiChar = `\; -\chardef\underChar = `\_ - -% Ignore a token. -% -\def\gobble#1{} - -% The following is used inside several \edef's. -\def\makecsname#1{\expandafter\noexpand\csname#1\endcsname} - -% Hyphenation fixes. -\hyphenation{ - Flor-i-da Ghost-script Ghost-view Mac-OS Post-Script - ap-pen-dix bit-map bit-maps - data-base data-bases eshell fall-ing half-way long-est man-u-script - man-u-scripts mini-buf-fer mini-buf-fers over-view par-a-digm - par-a-digms rath-er rec-tan-gu-lar ro-bot-ics se-vere-ly set-up spa-ces - spell-ing spell-ings - stand-alone strong-est time-stamp time-stamps which-ever white-space - wide-spread wrap-around -} - -% Margin to add to right of even pages, to left of odd pages. -\newdimen\bindingoffset -\newdimen\normaloffset -\newdimen\pagewidth \newdimen\pageheight - -% For a final copy, take out the rectangles -% that mark overfull boxes (in case you have decided -% that the text looks ok even though it passes the margin). -% -\def\finalout{\overfullrule=0pt} - -% @| inserts a changebar to the left of the current line. It should -% surround any changed text. This approach does *not* work if the -% change spans more than two lines of output. To handle that, we would -% have adopt a much more difficult approach (putting marks into the main -% vertical list for the beginning and end of each change). -% -\def\|{% - % \vadjust can only be used in horizontal mode. - \leavevmode - % - % Append this vertical mode material after the current line in the output. - \vadjust{% - % We want to insert a rule with the height and depth of the current - % leading; that is exactly what \strutbox is supposed to record. - \vskip-\baselineskip - % - % \vadjust-items are inserted at the left edge of the type. So - % the \llap here moves out into the left-hand margin. - \llap{% - % - % For a thicker or thinner bar, change the `1pt'. - \vrule height\baselineskip width1pt - % - % This is the space between the bar and the text. - \hskip 12pt - }% - }% -} - -% Sometimes it is convenient to have everything in the transcript file -% and nothing on the terminal. We don't just call \tracingall here, -% since that produces some useless output on the terminal. We also make -% some effort to order the tracing commands to reduce output in the log -% file; cf. trace.sty in LaTeX. -% -\def\gloggingall{\begingroup \globaldefs = 1 \loggingall \endgroup}% -\def\loggingall{% - \tracingstats2 - \tracingpages1 - \tracinglostchars2 % 2 gives us more in etex - \tracingparagraphs1 - \tracingoutput1 - \tracingmacros2 - \tracingrestores1 - \showboxbreadth\maxdimen \showboxdepth\maxdimen - \ifx\eTeXversion\undefined\else % etex gives us more logging - \tracingscantokens1 - \tracingifs1 - \tracinggroups1 - \tracingnesting2 - \tracingassigns1 - \fi - \tracingcommands3 % 3 gives us more in etex - \errorcontextlines16 -}% - -% add check for \lastpenalty to plain's definitions. If the last thing -% we did was a \nobreak, we don't want to insert more space. -% -\def\smallbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\smallskipamount - \removelastskip\penalty-50\smallskip\fi\fi} -\def\medbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\medskipamount - \removelastskip\penalty-100\medskip\fi\fi} -\def\bigbreak{\ifnum\lastpenalty<10000\par\ifdim\lastskip<\bigskipamount - \removelastskip\penalty-200\bigskip\fi\fi} - -% For @cropmarks command. -% Do @cropmarks to get crop marks. -% -\newif\ifcropmarks -\let\cropmarks = \cropmarkstrue -% -% Dimensions to add cropmarks at corners. -% Added by P. A. MacKay, 12 Nov. 1986 -% -\newdimen\outerhsize \newdimen\outervsize % set by the paper size routines -\newdimen\cornerlong \cornerlong=1pc -\newdimen\cornerthick \cornerthick=.3pt -\newdimen\topandbottommargin \topandbottommargin=.75in - -% Main output routine. -\chardef\PAGE = 255 -\output = {\onepageout{\pagecontents\PAGE}} - -\newbox\headlinebox -\newbox\footlinebox - -% \onepageout takes a vbox as an argument. Note that \pagecontents -% does insertions, but you have to call it yourself. -\def\onepageout#1{% - \ifcropmarks \hoffset=0pt \else \hoffset=\normaloffset \fi - % - \ifodd\pageno \advance\hoffset by \bindingoffset - \else \advance\hoffset by -\bindingoffset\fi - % - % Do this outside of the \shipout so @code etc. will be expanded in - % the headline as they should be, not taken literally (outputting ''code). - \setbox\headlinebox = \vbox{\let\hsize=\pagewidth \makeheadline}% - \setbox\footlinebox = \vbox{\let\hsize=\pagewidth \makefootline}% - % - {% - % Have to do this stuff outside the \shipout because we want it to - % take effect in \write's, yet the group defined by the \vbox ends - % before the \shipout runs. - % - \indexdummies % don't expand commands in the output. - \normalturnoffactive % \ in index entries must not stay \, e.g., if - % the page break happens to be in the middle of an example. - % We don't want .vr (or whatever) entries like this: - % \entry{{\tt \indexbackslash }acronym}{32}{\code {\acronym}} - % "\acronym" won't work when it's read back in; - % it needs to be - % {\code {{\tt \backslashcurfont }acronym} - \shipout\vbox{% - % Do this early so pdf references go to the beginning of the page. - \ifpdfmakepagedest \pdfdest name{\the\pageno} xyz\fi - % - \ifcropmarks \vbox to \outervsize\bgroup - \hsize = \outerhsize - \vskip-\topandbottommargin - \vtop to0pt{% - \line{\ewtop\hfil\ewtop}% - \nointerlineskip - \line{% - \vbox{\moveleft\cornerthick\nstop}% - \hfill - \vbox{\moveright\cornerthick\nstop}% - }% - \vss}% - \vskip\topandbottommargin - \line\bgroup - \hfil % center the page within the outer (page) hsize. - \ifodd\pageno\hskip\bindingoffset\fi - \vbox\bgroup - \fi - % - \unvbox\headlinebox - \pagebody{#1}% - \ifdim\ht\footlinebox > 0pt - % Only leave this space if the footline is nonempty. - % (We lessened \vsize for it in \oddfootingyyy.) - % The \baselineskip=24pt in plain's \makefootline has no effect. - \vskip 24pt - \unvbox\footlinebox - \fi - % - \ifcropmarks - \egroup % end of \vbox\bgroup - \hfil\egroup % end of (centering) \line\bgroup - \vskip\topandbottommargin plus1fill minus1fill - \boxmaxdepth = \cornerthick - \vbox to0pt{\vss - \line{% - \vbox{\moveleft\cornerthick\nsbot}% - \hfill - \vbox{\moveright\cornerthick\nsbot}% - }% - \nointerlineskip - \line{\ewbot\hfil\ewbot}% - }% - \egroup % \vbox from first cropmarks clause - \fi - }% end of \shipout\vbox - }% end of group with \indexdummies - \advancepageno - \ifnum\outputpenalty>-20000 \else\dosupereject\fi -} - -\newinsert\margin \dimen\margin=\maxdimen - -\def\pagebody#1{\vbox to\pageheight{\boxmaxdepth=\maxdepth #1}} -{\catcode`\@ =11 -\gdef\pagecontents#1{\ifvoid\topins\else\unvbox\topins\fi -% marginal hacks, juha@viisa.uucp (Juha Takala) -\ifvoid\margin\else % marginal info is present - \rlap{\kern\hsize\vbox to\z@{\kern1pt\box\margin \vss}}\fi -\dimen@=\dp#1 \unvbox#1 -\ifvoid\footins\else\vskip\skip\footins\footnoterule \unvbox\footins\fi -\ifr@ggedbottom \kern-\dimen@ \vfil \fi} -} - -% Here are the rules for the cropmarks. Note that they are -% offset so that the space between them is truly \outerhsize or \outervsize -% (P. A. MacKay, 12 November, 1986) -% -\def\ewtop{\vrule height\cornerthick depth0pt width\cornerlong} -\def\nstop{\vbox - {\hrule height\cornerthick depth\cornerlong width\cornerthick}} -\def\ewbot{\vrule height0pt depth\cornerthick width\cornerlong} -\def\nsbot{\vbox - {\hrule height\cornerlong depth\cornerthick width\cornerthick}} - -% Parse an argument, then pass it to #1. The argument is the rest of -% the input line (except we remove a trailing comment). #1 should be a -% macro which expects an ordinary undelimited TeX argument. -% -\def\parsearg{\parseargusing{}} -\def\parseargusing#1#2{% - \def\argtorun{#2}% - \begingroup - \obeylines - \spaceisspace - #1% - \parseargline\empty% Insert the \empty token, see \finishparsearg below. -} - -{\obeylines % - \gdef\parseargline#1^^M{% - \endgroup % End of the group started in \parsearg. - \argremovecomment #1\comment\ArgTerm% - }% -} - -% First remove any @comment, then any @c comment. -\def\argremovecomment#1\comment#2\ArgTerm{\argremovec #1\c\ArgTerm} -\def\argremovec#1\c#2\ArgTerm{\argcheckspaces#1\^^M\ArgTerm} - -% Each occurence of `\^^M' or `\^^M' is replaced by a single space. -% -% \argremovec might leave us with trailing space, e.g., -% @end itemize @c foo -% This space token undergoes the same procedure and is eventually removed -% by \finishparsearg. -% -\def\argcheckspaces#1\^^M{\argcheckspacesX#1\^^M \^^M} -\def\argcheckspacesX#1 \^^M{\argcheckspacesY#1\^^M} -\def\argcheckspacesY#1\^^M#2\^^M#3\ArgTerm{% - \def\temp{#3}% - \ifx\temp\empty - % Do not use \next, perhaps the caller of \parsearg uses it; reuse \temp: - \let\temp\finishparsearg - \else - \let\temp\argcheckspaces - \fi - % Put the space token in: - \temp#1 #3\ArgTerm -} - -% If a _delimited_ argument is enclosed in braces, they get stripped; so -% to get _exactly_ the rest of the line, we had to prevent such situation. -% We prepended an \empty token at the very beginning and we expand it now, -% just before passing the control to \argtorun. -% (Similarily, we have to think about #3 of \argcheckspacesY above: it is -% either the null string, or it ends with \^^M---thus there is no danger -% that a pair of braces would be stripped. -% -% But first, we have to remove the trailing space token. -% -\def\finishparsearg#1 \ArgTerm{\expandafter\argtorun\expandafter{#1}} - -% \parseargdef\foo{...} -% is roughly equivalent to -% \def\foo{\parsearg\Xfoo} -% \def\Xfoo#1{...} -% -% Actually, I use \csname\string\foo\endcsname, ie. \\foo, as it is my -% favourite TeX trick. --kasal, 16nov03 - -\def\parseargdef#1{% - \expandafter \doparseargdef \csname\string#1\endcsname #1% -} -\def\doparseargdef#1#2{% - \def#2{\parsearg#1}% - \def#1##1% -} - -% Several utility definitions with active space: -{ - \obeyspaces - \gdef\obeyedspace{ } - - % Make each space character in the input produce a normal interword - % space in the output. Don't allow a line break at this space, as this - % is used only in environments like @example, where each line of input - % should produce a line of output anyway. - % - \gdef\sepspaces{\obeyspaces\let =\tie} - - % If an index command is used in an @example environment, any spaces - % therein should become regular spaces in the raw index file, not the - % expansion of \tie (\leavevmode \penalty \@M \ ). - \gdef\unsepspaces{\let =\space} -} - - -\def\flushcr{\ifx\par\lisppar \def\next##1{}\else \let\next=\relax \fi \next} - -% Define the framework for environments in texinfo.tex. It's used like this: -% -% \envdef\foo{...} -% \def\Efoo{...} -% -% It's the responsibility of \envdef to insert \begingroup before the -% actual body; @end closes the group after calling \Efoo. \envdef also -% defines \thisenv, so the current environment is known; @end checks -% whether the environment name matches. The \checkenv macro can also be -% used to check whether the current environment is the one expected. -% -% Non-false conditionals (@iftex, @ifset) don't fit into this, so they -% are not treated as enviroments; they don't open a group. (The -% implementation of @end takes care not to call \endgroup in this -% special case.) - - -% At runtime, environments start with this: -\def\startenvironment#1{\begingroup\def\thisenv{#1}} -% initialize -\let\thisenv\empty - -% ... but they get defined via ``\envdef\foo{...}'': -\long\def\envdef#1#2{\def#1{\startenvironment#1#2}} -\def\envparseargdef#1#2{\parseargdef#1{\startenvironment#1#2}} - -% Check whether we're in the right environment: -\def\checkenv#1{% - \def\temp{#1}% - \ifx\thisenv\temp - \else - \badenverr - \fi -} - -% Evironment mismatch, #1 expected: -\def\badenverr{% - \errhelp = \EMsimple - \errmessage{This command can appear only \inenvironment\temp, - not \inenvironment\thisenv}% -} -\def\inenvironment#1{% - \ifx#1\empty - out of any environment% - \else - in environment \expandafter\string#1% - \fi -} - -% @end foo executes the definition of \Efoo. -% But first, it executes a specialized version of \checkenv -% -\parseargdef\end{% - \if 1\csname iscond.#1\endcsname - \else - % The general wording of \badenverr may not be ideal, but... --kasal, 06nov03 - \expandafter\checkenv\csname#1\endcsname - \csname E#1\endcsname - \endgroup - \fi -} - -\newhelp\EMsimple{Press RETURN to continue.} - - -%% Simple single-character @ commands - -% @@ prints an @ -% Kludge this until the fonts are right (grr). -\def\@{{\tt\char64}} - -% This is turned off because it was never documented -% and you can use @w{...} around a quote to suppress ligatures. -%% Define @` and @' to be the same as ` and ' -%% but suppressing ligatures. -%\def\`{{`}} -%\def\'{{'}} - -% Used to generate quoted braces. -\def\mylbrace {{\tt\char123}} -\def\myrbrace {{\tt\char125}} -\let\{=\mylbrace -\let\}=\myrbrace -\begingroup - % Definitions to produce \{ and \} commands for indices, - % and @{ and @} for the aux/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 \ptexi - \else\ifx\temp\jmacro \j - \else \errmessage{@dotless can be used only with i or j}% - \fi\fi -} - -% The \TeX{} logo, as in plain, but resetting the spacing so that a -% period following counts as ending a sentence. (Idea found in latex.) -% -\edef\TeX{\TeX \spacefactor=1000 } - -% @LaTeX{} logo. Not quite the same results as the definition in -% latex.ltx, since we use a different font for the raised A; it's most -% convenient for us to use an explicitly smaller font, rather than using -% the \scriptstyle font (since we don't reset \scriptstyle and -% \scriptscriptstyle). -% -\def\LaTeX{% - L\kern-.36em - {\setbox0=\hbox{T}% - \vbox to \ht0{\hbox{\selectfonts\lllsize A}\vss}}% - \kern-.15em - \TeX -} - -% Be sure we're in horizontal mode when doing a tie, since we make space -% equivalent to this in @example-like environments. Otherwise, a space -% at the beginning of a line will start with \penalty -- and -% since \penalty is valid in vertical mode, we'd end up putting the -% penalty on the vertical list instead of in the new paragraph. -{\catcode`@ = 11 - % Avoid using \@M directly, because that causes trouble - % if the definition is written into an index file. - \global\let\tiepenalty = \@M - \gdef\tie{\leavevmode\penalty\tiepenalty\ } -} - -% @: forces normal size whitespace following. -\def\:{\spacefactor=1000 } - -% @* forces a line break. -\def\*{\hfil\break\hbox{}\ignorespaces} - -% @/ allows a line break. -\let\/=\allowbreak - -% @. is an end-of-sentence period. -\def\.{.\spacefactor=\endofsentencespacefactor\space} - -% @! is an end-of-sentence bang. -\def\!{!\spacefactor=\endofsentencespacefactor\space} - -% @? is an end-of-sentence query. -\def\?{?\spacefactor=\endofsentencespacefactor\space} - -% @frenchspacing on|off says whether to put extra space after punctuation. -% -\def\onword{on} -\def\offword{off} -% -\parseargdef\frenchspacing{% - \def\temp{#1}% - \ifx\temp\onword \plainfrenchspacing - \else\ifx\temp\offword \plainnonfrenchspacing - \else - \errhelp = \EMsimple - \errmessage{Unknown @frenchspacing option `\temp', must be on/off}% - \fi\fi -} - -% @w prevents a word break. Without the \leavevmode, @w at the -% beginning of a paragraph, when TeX is still in vertical mode, would -% produce a whole line of output instead of starting the paragraph. -\def\w#1{\leavevmode\hbox{#1}} - -% @group ... @end group forces ... to be all on one page, by enclosing -% it in a TeX vbox. We use \vtop instead of \vbox to construct the box -% to keep its height that of a normal line. According to the rules for -% \topskip (p.114 of the TeXbook), the glue inserted is -% max (\topskip - \ht (first item), 0). If that height is large, -% therefore, no glue is inserted, and the space between the headline and -% the text is small, which looks bad. -% -% Another complication is that the group might be very large. This can -% cause the glue on the previous page to be unduly stretched, because it -% does not have much material. In this case, it's better to add an -% explicit \vfill so that the extra space is at the bottom. The -% threshold for doing this is if the group is more than \vfilllimit -% percent of a page (\vfilllimit can be changed inside of @tex). -% -\newbox\groupbox -\def\vfilllimit{0.7} -% -\envdef\group{% - \ifnum\catcode`\^^M=\active \else - \errhelp = \groupinvalidhelp - \errmessage{@group invalid in context where filling is enabled}% - \fi - \startsavinginserts - % - \setbox\groupbox = \vtop\bgroup - % Do @comment since we are called inside an environment such as - % @example, where each end-of-line in the input causes an - % end-of-line in the output. We don't want the end-of-line after - % the `@group' to put extra space in the output. Since @group - % should appear on a line by itself (according to the Texinfo - % manual), we don't worry about eating any user text. - \comment -} -% -% The \vtop produces a box with normal height and large depth; thus, TeX puts -% \baselineskip glue before it, and (when the next line of text is done) -% \lineskip glue after it. Thus, space below is not quite equal to space -% above. But it's pretty close. -\def\Egroup{% - % To get correct interline space between the last line of the group - % and the first line afterwards, we have to propagate \prevdepth. - \endgraf % Not \par, as it may have been set to \lisppar. - \global\dimen1 = \prevdepth - \egroup % End the \vtop. - % \dimen0 is the vertical size of the group's box. - \dimen0 = \ht\groupbox \advance\dimen0 by \dp\groupbox - % \dimen2 is how much space is left on the page (more or less). - \dimen2 = \pageheight \advance\dimen2 by -\pagetotal - % if the group doesn't fit on the current page, and it's a big big - % group, force a page break. - \ifdim \dimen0 > \dimen2 - \ifdim \pagetotal < \vfilllimit\pageheight - \page - \fi - \fi - \box\groupbox - \prevdepth = \dimen1 - \checkinserts -} -% -% TeX puts in an \escapechar (i.e., `@') at the beginning of the help -% message, so this ends up printing `@group can only ...'. -% -\newhelp\groupinvalidhelp{% -group can only be used in environments such as @example,^^J% -where each line of input produces a line of output.} - -% @need space-in-mils -% forces a page break if there is not space-in-mils remaining. - -\newdimen\mil \mil=0.001in - -% Old definition--didn't work. -%\parseargdef\need{\par % -%% This method tries to make TeX break the page naturally -%% if the depth of the box does not fit. -%{\baselineskip=0pt% -%\vtop to #1\mil{\vfil}\kern -#1\mil\nobreak -%\prevdepth=-1000pt -%}} - -\parseargdef\need{% - % Ensure vertical mode, so we don't make a big box in the middle of a - % paragraph. - \par - % - % If the @need value is less than one line space, it's useless. - \dimen0 = #1\mil - \dimen2 = \ht\strutbox - \advance\dimen2 by \dp\strutbox - \ifdim\dimen0 > \dimen2 - % - % Do a \strut just to make the height of this box be normal, so the - % normal leading is inserted relative to the preceding line. - % And a page break here is fine. - \vtop to #1\mil{\strut\vfil}% - % - % TeX does not even consider page breaks if a penalty added to the - % main vertical list is 10000 or more. But in order to see if the - % empty box we just added fits on the page, we must make it consider - % page breaks. On the other hand, we don't want to actually break the - % page after the empty box. So we use a penalty of 9999. - % - % There is an extremely small chance that TeX will actually break the - % page at this \penalty, if there are no other feasible breakpoints in - % sight. (If the user is using lots of big @group commands, which - % almost-but-not-quite fill up a page, TeX will have a hard time doing - % good page breaking, for example.) However, I could not construct an - % example where a page broke at this \penalty; if it happens in a real - % document, then we can reconsider our strategy. - \penalty9999 - % - % Back up by the size of the box, whether we did a page break or not. - \kern -#1\mil - % - % Do not allow a page break right after this kern. - \nobreak - \fi -} - -% @br forces paragraph break (and is undocumented). - -\let\br = \par - -% @page forces the start of a new page. -% -\def\page{\par\vfill\supereject} - -% @exdent text.... -% outputs text on separate line in roman font, starting at standard page margin - -% This records the amount of indent in the innermost environment. -% That's how much \exdent should take out. -\newskip\exdentamount - -% This defn is used inside fill environments such as @defun. -\parseargdef\exdent{\hfil\break\hbox{\kern -\exdentamount{\rm#1}}\hfil\break} - -% This defn is used inside nofill environments such as @example. -\parseargdef\nofillexdent{{\advance \leftskip by -\exdentamount - \leftline{\hskip\leftskip{\rm#1}}}} - -% @inmargin{WHICH}{TEXT} puts TEXT in the WHICH margin next to the current -% paragraph. For more general purposes, use the \margin insertion -% class. WHICH is `l' or `r'. -% -\newskip\inmarginspacing \inmarginspacing=1cm -\def\strutdepth{\dp\strutbox} -% -\def\doinmargin#1#2{\strut\vadjust{% - \nobreak - \kern-\strutdepth - \vtop to \strutdepth{% - \baselineskip=\strutdepth - \vss - % if you have multiple lines of stuff to put here, you'll need to - % make the vbox yourself of the appropriate size. - \ifx#1l% - \llap{\ignorespaces #2\hskip\inmarginspacing}% - \else - \rlap{\hskip\hsize \hskip\inmarginspacing \ignorespaces #2}% - \fi - \null - }% -}} -\def\inleftmargin{\doinmargin l} -\def\inrightmargin{\doinmargin r} -% -% @inmargin{TEXT [, RIGHT-TEXT]} -% (if RIGHT-TEXT is given, use TEXT for left page, RIGHT-TEXT for right; -% else use TEXT for both). -% -\def\inmargin#1{\parseinmargin #1,,\finish} -\def\parseinmargin#1,#2,#3\finish{% not perfect, but better than nothing. - \setbox0 = \hbox{\ignorespaces #2}% - \ifdim\wd0 > 0pt - \def\lefttext{#1}% have both texts - \def\righttext{#2}% - \else - \def\lefttext{#1}% have only one text - \def\righttext{#1}% - \fi - % - \ifodd\pageno - \def\temp{\inrightmargin\righttext}% odd page -> outside is right margin - \else - \def\temp{\inleftmargin\lefttext}% - \fi - \temp -} - -% @include file insert text of that file as input. -% -\def\include{\parseargusing\filenamecatcodes\includezzz} -\def\includezzz#1{% - \pushthisfilestack - \def\thisfile{#1}% - {% - \makevalueexpandable - \def\temp{\input #1 }% - \expandafter - }\temp - \popthisfilestack -} -\def\filenamecatcodes{% - \catcode`\\=\other - \catcode`~=\other - \catcode`^=\other - \catcode`_=\other - \catcode`|=\other - \catcode`<=\other - \catcode`>=\other - \catcode`+=\other - \catcode`-=\other -} - -\def\pushthisfilestack{% - \expandafter\pushthisfilestackX\popthisfilestack\StackTerm -} -\def\pushthisfilestackX{% - \expandafter\pushthisfilestackY\thisfile\StackTerm -} -\def\pushthisfilestackY #1\StackTerm #2\StackTerm {% - \gdef\popthisfilestack{\gdef\thisfile{#1}\gdef\popthisfilestack{#2}}% -} - -\def\popthisfilestack{\errthisfilestackempty} -\def\errthisfilestackempty{\errmessage{Internal error: - the stack of filenames is empty.}} - -\def\thisfile{} - -% @center line -% outputs that line, centered. -% -\parseargdef\center{% - \ifhmode - \let\next\centerH - \else - \let\next\centerV - \fi - \next{\hfil \ignorespaces#1\unskip \hfil}% -} -\def\centerH#1{% - {% - \hfil\break - \advance\hsize by -\leftskip - \advance\hsize by -\rightskip - \line{#1}% - \break - }% -} -\def\centerV#1{\line{\kern\leftskip #1\kern\rightskip}} - -% @sp n outputs n lines of vertical space - -\parseargdef\sp{\vskip #1\baselineskip} - -% @comment ...line which is ignored... -% @c is the same as @comment -% @ignore ... @end ignore is another way to write a comment - -\def\comment{\begingroup \catcode`\^^M=\other% -\catcode`\@=\other \catcode`\{=\other \catcode`\}=\other% -\commentxxx} -{\catcode`\^^M=\other \gdef\commentxxx#1^^M{\endgroup}} - -\let\c=\comment - -% @paragraphindent NCHARS -% We'll use ems for NCHARS, close enough. -% NCHARS can also be the word `asis' or `none'. -% We cannot feasibly implement @paragraphindent asis, though. -% -\def\asisword{asis} % no translation, these are keywords -\def\noneword{none} -% -\parseargdef\paragraphindent{% - \def\temp{#1}% - \ifx\temp\asisword - \else - \ifx\temp\noneword - \defaultparindent = 0pt - \else - \defaultparindent = #1em - \fi - \fi - \parindent = \defaultparindent -} - -% @exampleindent NCHARS -% We'll use ems for NCHARS like @paragraphindent. -% It seems @exampleindent asis isn't necessary, but -% I preserve it to make it similar to @paragraphindent. -\parseargdef\exampleindent{% - \def\temp{#1}% - \ifx\temp\asisword - \else - \ifx\temp\noneword - \lispnarrowing = 0pt - \else - \lispnarrowing = #1em - \fi - \fi -} - -% @firstparagraphindent WORD -% If WORD is `none', then suppress indentation of the first paragraph -% after a section heading. If WORD is `insert', then do indent at such -% paragraphs. -% -% The paragraph indentation is suppressed or not by calling -% \suppressfirstparagraphindent, which the sectioning commands do. -% We switch the definition of this back and forth according to WORD. -% By default, we suppress indentation. -% -\def\suppressfirstparagraphindent{\dosuppressfirstparagraphindent} -\def\insertword{insert} -% -\parseargdef\firstparagraphindent{% - \def\temp{#1}% - \ifx\temp\noneword - \let\suppressfirstparagraphindent = \dosuppressfirstparagraphindent - \else\ifx\temp\insertword - \let\suppressfirstparagraphindent = \relax - \else - \errhelp = \EMsimple - \errmessage{Unknown @firstparagraphindent option `\temp'}% - \fi\fi -} - -% Here is how we actually suppress indentation. Redefine \everypar to -% \kern backwards by \parindent, and then reset itself to empty. -% -% We also make \indent itself not actually do anything until the next -% paragraph. -% -\gdef\dosuppressfirstparagraphindent{% - \gdef\indent{% - \restorefirstparagraphindent - \indent - }% - \gdef\noindent{% - \restorefirstparagraphindent - \noindent - }% - \global\everypar = {% - \kern -\parindent - \restorefirstparagraphindent - }% -} - -\gdef\restorefirstparagraphindent{% - \global \let \indent = \ptexindent - \global \let \noindent = \ptexnoindent - \global \everypar = {}% -} - - -% @asis just yields its argument. Used with @table, for example. -% -\def\asis#1{#1} - -% @math outputs its argument in math mode. -% -% One complication: _ usually means subscripts, but it could also mean -% an actual _ character, as in @math{@var{some_variable} + 1}. So make -% _ active, and distinguish by seeing if the current family is \slfam, -% which is what @var uses. -{ - \catcode`\_ = \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 - $\finishmath -} -\def\finishmath#1{#1$\endgroup} % Close the group opened by \tex. - -% Some active characters (such as <) are spaced differently in math. -% We have to reset their definitions in case the @math was an argument -% to a command which sets the catcodes (such as @item or @section). -% -{ - \catcode`^ = \active - \catcode`< = \active - \catcode`> = \active - \catcode`+ = \active - \gdef\mathactive{% - \let^ = \ptexhat - \let< = \ptexless - \let> = \ptexgtr - \let+ = \ptexplus - } -} - -% @bullet and @minus need the same treatment as @math, just above. -\def\bullet{$\ptexbullet$} -\def\minus{$-$} - -% @dots{} outputs an ellipsis using the current font. -% We do .5em per period so that it has the same spacing in 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 - -% If working on a large document in chapters, it is convenient to -% be able to disable indexing, cross-referencing, and contents, for test runs. -% This is done with @novalidate (before @setfilename). -% -\newif\iflinks \linkstrue % by default we want the aux files. -\let\novalidate = \linksfalse - -% @setfilename is done at the beginning of every texinfo file. -% So open here the files we need to have open while reading the input. -% This makes it possible to make a .fmt file for texinfo. -\def\setfilename{% - \fixbackslash % Turn off hack to swallow `\input texinfo'. - \iflinks - \tryauxfile - % Open the new aux file. TeX will close it automatically at exit. - \immediate\openout\auxfile=\jobname.aux - \fi % \openindices needs to do some work in any case. - \openindices - \let\setfilename=\comment % Ignore extra @setfilename cmds. - % - % If texinfo.cnf is present on the system, read it. - % Useful for site-wide @afourpaper, etc. - \openin 1 texinfo.cnf - \ifeof 1 \else \input texinfo.cnf \fi - \closein 1 - % - \comment % Ignore the actual filename. -} - -% Called from \setfilename. -% -\def\openindices{% - \newindex{cp}% - \newcodeindex{fn}% - \newcodeindex{vr}% - \newcodeindex{tp}% - \newcodeindex{ky}% - \newcodeindex{pg}% -} - -% @bye. -\outer\def\bye{\pagealignmacro\tracingstats=1\ptexend} - - -\message{pdf,} -% adobe `portable' document format -\newcount\tempnum -\newcount\lnkcount -\newtoks\filename -\newcount\filenamelength -\newcount\pgn -\newtoks\toksA -\newtoks\toksB -\newtoks\toksC -\newtoks\toksD -\newbox\boxA -\newcount\countA -\newif\ifpdf -\newif\ifpdfmakepagedest - -% when pdftex is run in dvi mode, \pdfoutput is defined (so \pdfoutput=1 -% can be set). So we test for \relax and 0 as well as \undefined, -% borrowed from ifpdf.sty. -\ifx\pdfoutput\undefined -\else - \ifx\pdfoutput\relax - \else - \ifcase\pdfoutput - \else - \pdftrue - \fi - \fi -\fi - -% PDF uses PostScript string constants for the names of xref targets, -% for display in the outlines, and in other places. Thus, we have to -% double any backslashes. Otherwise, a name like "\node" will be -% interpreted as a newline (\n), followed by o, d, e. Not good. -% 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. I've -% tinkered with it a little for texinfo, but it's definitely from there. -% -% #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}% -} - -\ifpdf - \input pdfcolor - \pdfcatalog{/PageMode /UseOutlines}% - % #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}% - % without \immediate, pdftex seg faults when the same image is - % included twice. (Version 3.14159-pre-1.0-unofficial-20010704.) - \ifnum\pdftexversion < 14 - \immediate\pdfimage - \else - \immediate\pdfximage - \fi - \ifdim \wd0 >0pt width \imagewidth \fi - \ifdim \wd2 >0pt height \imageheight \fi - \ifnum\pdftexversion<13 - #1.pdf% - \else - {#1.pdf}% - \fi - \ifnum\pdftexversion < 14 \else - \pdfrefximage \pdflastximage - \fi} - \def\pdfmkdest#1{{% - % We have to set dummies so commands such as @code, and characters - % such as \, aren't expanded when present in a section title. - \atdummies - \activebackslashdouble - \def\pdfdestname{#1}% - \backslashparens\pdfdestname - \pdfdest name{\pdfdestname} xyz% - }}% - % - % used to mark target names; must be expandable. - \def\pdfmkpgn#1{#1}% - % - \let\linkcolor = \Blue % was Cyan, but that seems light? - \def\endlink{\Black\pdfendlink} - % Adding outlines to PDF; macros for calculating structure of outlines - % come from Petr Olsak - \def\expnumber#1{\expandafter\ifx\csname#1\endcsname\relax 0% - \else \csname#1\endcsname \fi} - \def\advancenumber#1{\tempnum=\expnumber{#1}\relax - \advance\tempnum by 1 - \expandafter\xdef\csname#1\endcsname{\the\tempnum}} - % - % #1 is the section text, which is what will be displayed in the - % outline by the pdf viewer. #2 is the pdf expression for the number - % of subentries (or empty, for subsubsections). #3 is the node text, - % which might be empty if this toc entry had no corresponding node. - % #4 is the page number - % - \def\dopdfoutline#1#2#3#4{% - % Generate a link to the node text if that exists; else, use the - % page number. We could generate a destination for the section - % text in the case where a section has no node, but it doesn't - % seem worth the trouble, since most documents are normally structured. - \def\pdfoutlinedest{#3}% - \ifx\pdfoutlinedest\empty - \def\pdfoutlinedest{#4}% - \else - % Doubled backslashes in the name. - {\activebackslashdouble \xdef\pdfoutlinedest{#3}% - \backslashparens\pdfoutlinedest}% - \fi - % - % Also double the backslashes in the display string. - {\activebackslashdouble \xdef\pdfoutlinetext{#1}% - \backslashparens\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\numchapentry##1##2##3##4{% - \def\thischapnum{##2}% - \def\thissecnum{0}% - \def\thissubsecnum{0}% - }% - \def\numsecentry##1##2##3##4{% - \advancenumber{chap\thischapnum}% - \def\thissecnum{##2}% - \def\thissubsecnum{0}% - }% - \def\numsubsecentry##1##2##3##4{% - \advancenumber{sec\thissecnum}% - \def\thissubsecnum{##2}% - }% - \def\numsubsubsecentry##1##2##3##4{% - \advancenumber{subsec\thissubsecnum}% - }% - \def\thischapnum{0}% - \def\thissecnum{0}% - \def\thissubsecnum{0}% - % - % use \def rather than \let here because we redefine \chapentry et - % al. a second time, below. - \def\appentry{\numchapentry}% - \def\appsecentry{\numsecentry}% - \def\appsubsecentry{\numsubsecentry}% - \def\appsubsubsecentry{\numsubsubsecentry}% - \def\unnchapentry{\numchapentry}% - \def\unnsecentry{\numsecentry}% - \def\unnsubsecentry{\numsubsecentry}% - \def\unnsubsubsecentry{\numsubsubsecentry}% - \readdatafile{toc}% - % - % Read toc second time, this time actually producing the outlines. - % The `-' means take the \expnumber as the absolute number of - % subentries, which we calculated on our first read of the .toc above. - % - % We use the node names as the destinations. - \def\numchapentry##1##2##3##4{% - \dopdfoutline{##1}{count-\expnumber{chap##2}}{##3}{##4}}% - \def\numsecentry##1##2##3##4{% - \dopdfoutline{##1}{count-\expnumber{sec##2}}{##3}{##4}}% - \def\numsubsecentry##1##2##3##4{% - \dopdfoutline{##1}{count-\expnumber{subsec##2}}{##3}{##4}}% - \def\numsubsubsecentry##1##2##3##4{% count is always zero - \dopdfoutline{##1}{}{##3}{##4}}% - % - % PDF outlines are displayed using system fonts, instead of - % document fonts. Therefore we cannot use special characters, - % since the encoding is unknown. For example, the eogonek from - % Latin 2 (0xea) gets translated to a | character. Info from - % Staszek Wawrykiewicz, 19 Jan 2004 04:09:24 +0100. - % - % xx to do this right, we have to translate 8-bit characters to - % their "best" equivalent, based on the @documentencoding. Right - % now, I guess we'll just let the pdf reader have its way. - \indexnofonts - \setupdatafile - \catcode`\\=\active \otherbackslash - \input \jobname.toc - \endgroup - } - % - \def\skipspaces#1{\def\PP{#1}\def\D{|}% - \ifx\PP\D\let\nextsp\relax - \else\let\nextsp\skipspaces - \ifx\p\space\else\addtokens{\filename}{\PP}% - \advance\filenamelength by 1 - \fi - \fi - \nextsp} - \def\getfilename#1{\filenamelength=0\expandafter\skipspaces#1|\relax} - \ifnum\pdftexversion < 14 - \let \startlink \pdfannotlink - \else - \let \startlink \pdfstartlink - \fi - % make a live url in pdf output. - \def\pdfurl#1{% - \begingroup - % it seems we really need yet another set of dummies; have not - % tried to figure out what each command should do in the context - % of @url. for now, just make @/ a no-op, that's the only one - % people have actually reported a problem with. - % - \normalturnoffactive - \def\@{@}% - \let\/=\empty - \makevalueexpandable - \leavevmode\Red - \startlink attr{/Border [0 0 0]}% - user{/Subtype /Link /A << /S /URI /URI (#1) >>}% - \endgroup} - \def\pdfgettoks#1.{\setbox\boxA=\hbox{\toksA={#1.}\toksB={}\maketoks}} - \def\addtokens#1#2{\edef\addtoks{\noexpand#1={\the#1#2}}\addtoks} - \def\adn#1{\addtokens{\toksC}{#1}\global\countA=1\let\next=\maketoks} - \def\poptoks#1#2|ENDTOKS|{\let\first=#1\toksD={#1}\toksA={#2}} - \def\maketoks{% - \expandafter\poptoks\the\toksA|ENDTOKS|\relax - \ifx\first0\adn0 - \else\ifx\first1\adn1 \else\ifx\first2\adn2 \else\ifx\first3\adn3 - \else\ifx\first4\adn4 \else\ifx\first5\adn5 \else\ifx\first6\adn6 - \else\ifx\first7\adn7 \else\ifx\first8\adn8 \else\ifx\first9\adn9 - \else - \ifnum0=\countA\else\makelink\fi - \ifx\first.\let\next=\done\else - \let\next=\maketoks - \addtokens{\toksB}{\the\toksD} - \ifx\first,\addtokens{\toksB}{\space}\fi - \fi - \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi - \next} - \def\makelink{\addtokens{\toksB}% - {\noexpand\pdflink{\the\toksC}}\toksC={}\global\countA=0} - \def\pdflink#1{% - \startlink attr{/Border [0 0 0]} goto name{\pdfmkpgn{#1}} - \linkcolor #1\endlink} - \def\done{\edef\st{\global\noexpand\toksA={\the\toksB}}\st} -\else - \let\pdfmkdest = \gobble - \let\pdfurl = \gobble - \let\endlink = \relax - \let\linkcolor = \relax - \let\pdfmakeoutlines = \relax -\fi % \ifx\pdfoutput - - -\message{fonts,} - -% Change the current font style to #1, remembering it in \curfontstyle. -% For now, we do not accumulate font styles: @b{@i{foo}} prints foo in -% italics, not bold italics. -% -\def\setfontstyle#1{% - \def\curfontstyle{#1}% not as a control sequence, because we are \edef'd. - \csname ten#1\endcsname % change the current font -} - -% Select #1 fonts with the current style. -% -\def\selectfonts#1{\csname #1fonts\endcsname \csname\curfontstyle\endcsname} - -\def\rm{\fam=0 \setfontstyle{rm}} -\def\it{\fam=\itfam \setfontstyle{it}} -\def\sl{\fam=\slfam \setfontstyle{sl}} -\def\bf{\fam=\bffam \setfontstyle{bf}}\def\bfstylename{bf} -\def\tt{\fam=\ttfam \setfontstyle{tt}} - -% Texinfo sort of supports the sans serif font style, which plain TeX does not. -% So we set up a \sf. -\newfam\sffam -\def\sf{\fam=\sffam \setfontstyle{sf}} -\let\li = \sf % Sometimes we call it \li, not \sf. - -% We don't need math for this font style. -\def\ttsl{\setfontstyle{ttsl}} - - -% Default leading. -\newdimen\textleading \textleading = 13.2pt - -% Set the baselineskip to #1, and the lineskip and strut size -% correspondingly. There is no deep meaning behind these magic numbers -% used as factors; they just match (closely enough) what Knuth defined. -% -\def\lineskipfactor{.08333} -\def\strutheightpercent{.70833} -\def\strutdepthpercent {.29167} -% -\def\setleading#1{% - \normalbaselineskip = #1\relax - \normallineskip = \lineskipfactor\normalbaselineskip - \normalbaselines - \setbox\strutbox =\hbox{% - \vrule width0pt height\strutheightpercent\baselineskip - depth \strutdepthpercent \baselineskip - }% -} - - -% Set the font macro #1 to the font named #2, adding on the -% specified font prefix (normally `cm'). -% #3 is the font's design size, #4 is a scale factor -\def\setfont#1#2#3#4{\font#1=\fontprefix#2#3 scaled #4} - - -% Use cm as the default font prefix. -% To specify the font prefix, you must define \fontprefix -% before you read in texinfo.tex. -\ifx\fontprefix\undefined -\def\fontprefix{cm} -\fi -% Support font families that don't use the same naming scheme as CM. -\def\rmshape{r} -\def\rmbshape{bx} %where the normal face is bold -\def\bfshape{b} -\def\bxshape{bx} -\def\ttshape{tt} -\def\ttbshape{tt} -\def\ttslshape{sltt} -\def\itshape{ti} -\def\itbshape{bxti} -\def\slshape{sl} -\def\slbshape{bxsl} -\def\sfshape{ss} -\def\sfbshape{ss} -\def\scshape{csc} -\def\scbshape{csc} - -% Definitions for a main text size of 11pt. This is the default in -% Texinfo. -% -\def\definetextfontsizexi{ -% Text fonts (11.2pt, magstep1). -\def\textnominalsize{11pt} -\edef\mainmagstep{\magstephalf} -\setfont\textrm\rmshape{10}{\mainmagstep} -\setfont\texttt\ttshape{10}{\mainmagstep} -\setfont\textbf\bfshape{10}{\mainmagstep} -\setfont\textit\itshape{10}{\mainmagstep} -\setfont\textsl\slshape{10}{\mainmagstep} -\setfont\textsf\sfshape{10}{\mainmagstep} -\setfont\textsc\scshape{10}{\mainmagstep} -\setfont\textttsl\ttslshape{10}{\mainmagstep} -\font\texti=cmmi10 scaled \mainmagstep -\font\textsy=cmsy10 scaled \mainmagstep - -% A few fonts for @defun names and args. -\setfont\defbf\bfshape{10}{\magstep1} -\setfont\deftt\ttshape{10}{\magstep1} -\setfont\defttsl\ttslshape{10}{\magstep1} -\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} - -% Fonts for indices, footnotes, small examples (9pt). -\def\smallnominalsize{9pt} -\setfont\smallrm\rmshape{9}{1000} -\setfont\smalltt\ttshape{9}{1000} -\setfont\smallbf\bfshape{10}{900} -\setfont\smallit\itshape{9}{1000} -\setfont\smallsl\slshape{9}{1000} -\setfont\smallsf\sfshape{9}{1000} -\setfont\smallsc\scshape{10}{900} -\setfont\smallttsl\ttslshape{10}{900} -\font\smalli=cmmi9 -\font\smallsy=cmsy9 - -% Fonts for small examples (8pt). -\def\smallernominalsize{8pt} -\setfont\smallerrm\rmshape{8}{1000} -\setfont\smallertt\ttshape{8}{1000} -\setfont\smallerbf\bfshape{10}{800} -\setfont\smallerit\itshape{8}{1000} -\setfont\smallersl\slshape{8}{1000} -\setfont\smallersf\sfshape{8}{1000} -\setfont\smallersc\scshape{10}{800} -\setfont\smallerttsl\ttslshape{10}{800} -\font\smalleri=cmmi8 -\font\smallersy=cmsy8 - -% Fonts for title page (20.4pt): -\def\titlenominalsize{20pt} -\setfont\titlerm\rmbshape{12}{\magstep3} -\setfont\titleit\itbshape{10}{\magstep4} -\setfont\titlesl\slbshape{10}{\magstep4} -\setfont\titlett\ttbshape{12}{\magstep3} -\setfont\titlettsl\ttslshape{10}{\magstep4} -\setfont\titlesf\sfbshape{17}{\magstep1} -\let\titlebf=\titlerm -\setfont\titlesc\scbshape{10}{\magstep4} -\font\titlei=cmmi12 scaled \magstep3 -\font\titlesy=cmsy10 scaled \magstep4 -\def\authorrm{\secrm} -\def\authortt{\sectt} - -% Chapter (and unnumbered) fonts (17.28pt). -\def\chapnominalsize{17pt} -\setfont\chaprm\rmbshape{12}{\magstep2} -\setfont\chapit\itbshape{10}{\magstep3} -\setfont\chapsl\slbshape{10}{\magstep3} -\setfont\chaptt\ttbshape{12}{\magstep2} -\setfont\chapttsl\ttslshape{10}{\magstep3} -\setfont\chapsf\sfbshape{17}{1000} -\let\chapbf=\chaprm -\setfont\chapsc\scbshape{10}{\magstep3} -\font\chapi=cmmi12 scaled \magstep2 -\font\chapsy=cmsy10 scaled \magstep3 - -% Section fonts (14.4pt). -\def\secnominalsize{14pt} -\setfont\secrm\rmbshape{12}{\magstep1} -\setfont\secit\itbshape{10}{\magstep2} -\setfont\secsl\slbshape{10}{\magstep2} -\setfont\sectt\ttbshape{12}{\magstep1} -\setfont\secttsl\ttslshape{10}{\magstep2} -\setfont\secsf\sfbshape{12}{\magstep1} -\let\secbf\secrm -\setfont\secsc\scbshape{10}{\magstep2} -\font\seci=cmmi12 scaled \magstep1 -\font\secsy=cmsy10 scaled \magstep2 - -% Subsection fonts (13.15pt). -\def\ssecnominalsize{13pt} -\setfont\ssecrm\rmbshape{12}{\magstephalf} -\setfont\ssecit\itbshape{10}{1315} -\setfont\ssecsl\slbshape{10}{1315} -\setfont\ssectt\ttbshape{12}{\magstephalf} -\setfont\ssecttsl\ttslshape{10}{1315} -\setfont\ssecsf\sfbshape{12}{\magstephalf} -\let\ssecbf\ssecrm -\setfont\ssecsc\scbshape{10}{1315} -\font\sseci=cmmi12 scaled \magstephalf -\font\ssecsy=cmsy10 scaled 1315 - -% Reduced fonts for @acro in text (10pt). -\def\reducednominalsize{10pt} -\setfont\reducedrm\rmshape{10}{1000} -\setfont\reducedtt\ttshape{10}{1000} -\setfont\reducedbf\bfshape{10}{1000} -\setfont\reducedit\itshape{10}{1000} -\setfont\reducedsl\slshape{10}{1000} -\setfont\reducedsf\sfshape{10}{1000} -\setfont\reducedsc\scshape{10}{1000} -\setfont\reducedttsl\ttslshape{10}{1000} -\font\reducedi=cmmi10 -\font\reducedsy=cmsy10 - -% reset the current fonts -\textfonts -\rm -} % end of 11pt text font size definitions - - -% Definitions to make the main text be 10pt Computer Modern, with -% section, chapter, etc., sizes following suit. This is for the GNU -% Press printing of the Emacs 22 manual. Maybe other manuals in the -% future. Used with @smallbook, which sets the leading to 12pt. -% -\def\definetextfontsizex{% -% Text fonts (10pt). -\def\textnominalsize{10pt} -\edef\mainmagstep{1000} -\setfont\textrm\rmshape{10}{\mainmagstep} -\setfont\texttt\ttshape{10}{\mainmagstep} -\setfont\textbf\bfshape{10}{\mainmagstep} -\setfont\textit\itshape{10}{\mainmagstep} -\setfont\textsl\slshape{10}{\mainmagstep} -\setfont\textsf\sfshape{10}{\mainmagstep} -\setfont\textsc\scshape{10}{\mainmagstep} -\setfont\textttsl\ttslshape{10}{\mainmagstep} -\font\texti=cmmi10 scaled \mainmagstep -\font\textsy=cmsy10 scaled \mainmagstep - -% A few fonts for @defun names and args. -\setfont\defbf\bfshape{10}{\magstephalf} -\setfont\deftt\ttshape{10}{\magstephalf} -\setfont\defttsl\ttslshape{10}{\magstephalf} -\def\df{\let\tentt=\deftt \let\tenbf = \defbf \let\tenttsl=\defttsl \bf} - -% Fonts for indices, footnotes, small examples (9pt). -\def\smallnominalsize{9pt} -\setfont\smallrm\rmshape{9}{1000} -\setfont\smalltt\ttshape{9}{1000} -\setfont\smallbf\bfshape{10}{900} -\setfont\smallit\itshape{9}{1000} -\setfont\smallsl\slshape{9}{1000} -\setfont\smallsf\sfshape{9}{1000} -\setfont\smallsc\scshape{10}{900} -\setfont\smallttsl\ttslshape{10}{900} -\font\smalli=cmmi9 -\font\smallsy=cmsy9 - -% Fonts for small examples (8pt). -\def\smallernominalsize{8pt} -\setfont\smallerrm\rmshape{8}{1000} -\setfont\smallertt\ttshape{8}{1000} -\setfont\smallerbf\bfshape{10}{800} -\setfont\smallerit\itshape{8}{1000} -\setfont\smallersl\slshape{8}{1000} -\setfont\smallersf\sfshape{8}{1000} -\setfont\smallersc\scshape{10}{800} -\setfont\smallerttsl\ttslshape{10}{800} -\font\smalleri=cmmi8 -\font\smallersy=cmsy8 - -% Fonts for title page (20.4pt): -\def\titlenominalsize{20pt} -\setfont\titlerm\rmbshape{12}{\magstep3} -\setfont\titleit\itbshape{10}{\magstep4} -\setfont\titlesl\slbshape{10}{\magstep4} -\setfont\titlett\ttbshape{12}{\magstep3} -\setfont\titlettsl\ttslshape{10}{\magstep4} -\setfont\titlesf\sfbshape{17}{\magstep1} -\let\titlebf=\titlerm -\setfont\titlesc\scbshape{10}{\magstep4} -\font\titlei=cmmi12 scaled \magstep3 -\font\titlesy=cmsy10 scaled \magstep4 -\def\authorrm{\secrm} -\def\authortt{\sectt} - -% Chapter fonts (14.4pt). -\def\chapnominalsize{14pt} -\setfont\chaprm\rmbshape{12}{\magstep1} -\setfont\chapit\itbshape{10}{\magstep2} -\setfont\chapsl\slbshape{10}{\magstep2} -\setfont\chaptt\ttbshape{12}{\magstep1} -\setfont\chapttsl\ttslshape{10}{\magstep2} -\setfont\chapsf\sfbshape{12}{\magstep1} -\let\chapbf\chaprm -\setfont\chapsc\scbshape{10}{\magstep2} -\font\chapi=cmmi12 scaled \magstep1 -\font\chapsy=cmsy10 scaled \magstep2 - -% Section fonts (12pt). -\def\secnominalsize{12pt} -\setfont\secrm\rmbshape{12}{1000} -\setfont\secit\itbshape{10}{\magstep1} -\setfont\secsl\slbshape{10}{\magstep1} -\setfont\sectt\ttbshape{12}{1000} -\setfont\secttsl\ttslshape{10}{\magstep1} -\setfont\secsf\sfbshape{12}{1000} -\let\secbf\secrm -\setfont\secsc\scbshape{10}{\magstep1} -\font\seci=cmmi12 -\font\secsy=cmsy10 scaled \magstep1 - -% Subsection fonts (10pt). -\def\ssecnominalsize{10pt} -\setfont\ssecrm\rmbshape{10}{1000} -\setfont\ssecit\itbshape{10}{1000} -\setfont\ssecsl\slbshape{10}{1000} -\setfont\ssectt\ttbshape{10}{1000} -\setfont\ssecttsl\ttslshape{10}{1000} -\setfont\ssecsf\sfbshape{10}{1000} -\let\ssecbf\ssecrm -\setfont\ssecsc\scbshape{10}{1000} -\font\sseci=cmmi10 -\font\ssecsy=cmsy10 - -% Reduced fonts for @acro in text (9pt). -\def\reducednominalsize{9pt} -\setfont\reducedrm\rmshape{9}{1000} -\setfont\reducedtt\ttshape{9}{1000} -\setfont\reducedbf\bfshape{10}{900} -\setfont\reducedit\itshape{9}{1000} -\setfont\reducedsl\slshape{9}{1000} -\setfont\reducedsf\sfshape{9}{1000} -\setfont\reducedsc\scshape{10}{900} -\setfont\reducedttsl\ttslshape{10}{900} -\font\reducedi=cmmi9 -\font\reducedsy=cmsy9 - -% reduce space between paragraphs -\divide\parskip by 2 - -% reset the current fonts -\textfonts -\rm -} % end of 10pt text font size definitions - - -% We provide the user-level command -% @fonttextsize 10 -% (or 11) to redefine the text font size. pt is assumed. -% -\def\xword{10} -\def\xiword{11} -% -\parseargdef\fonttextsize{% - \def\textsizearg{#1}% - \wlog{doing @fonttextsize \textsizearg}% - % - % Set \globaldefs so that documents can use this inside @tex, since - % makeinfo 4.8 does not support it, but we need it nonetheless. - % - \begingroup \globaldefs=1 - \ifx\textsizearg\xword \definetextfontsizex - \else \ifx\textsizearg\xiword \definetextfontsizexi - \else - \errhelp=\EMsimple - \errmessage{@fonttextsize only supports `10' or `11', not `\textsizearg'} - \fi\fi - \endgroup -} - - -% In order for the font changes to affect most math symbols and letters, -% we have to define the \textfont of the standard families. Since -% texinfo doesn't allow for producing subscripts and superscripts except -% in the main text, we don't bother to reset \scriptfont and -% \scriptscriptfont (which would also require loading a lot more fonts). -% -\def\resetmathfonts{% - \textfont0=\tenrm \textfont1=\teni \textfont2=\tensy - \textfont\itfam=\tenit \textfont\slfam=\tensl \textfont\bffam=\tenbf - \textfont\ttfam=\tentt \textfont\sffam=\tensf -} - -% The font-changing commands redefine the meanings of \tenSTYLE, instead -% of just \STYLE. We do this because \STYLE needs to also set the -% current \fam for math mode. Our \STYLE (e.g., \rm) commands hardwire -% \tenSTYLE to set the current font. -% -% Each font-changing command also sets the names \lsize (one size lower) -% and \lllsize (three sizes lower). These relative commands are used in -% the LaTeX logo and acronyms. -% -% This all needs generalizing, badly. -% -\def\textfonts{% - \let\tenrm=\textrm \let\tenit=\textit \let\tensl=\textsl - \let\tenbf=\textbf \let\tentt=\texttt \let\smallcaps=\textsc - \let\tensf=\textsf \let\teni=\texti \let\tensy=\textsy - \let\tenttsl=\textttsl - \def\curfontsize{text}% - \def\lsize{reduced}\def\lllsize{smaller}% - \resetmathfonts \setleading{\textleading}} -\def\titlefonts{% - \let\tenrm=\titlerm \let\tenit=\titleit \let\tensl=\titlesl - \let\tenbf=\titlebf \let\tentt=\titlett \let\smallcaps=\titlesc - \let\tensf=\titlesf \let\teni=\titlei \let\tensy=\titlesy - \let\tenttsl=\titlettsl - \def\curfontsize{title}% - \def\lsize{chap}\def\lllsize{subsec}% - \resetmathfonts \setleading{25pt}} -\def\titlefont#1{{\titlefonts\rm #1}} -\def\chapfonts{% - \let\tenrm=\chaprm \let\tenit=\chapit \let\tensl=\chapsl - \let\tenbf=\chapbf \let\tentt=\chaptt \let\smallcaps=\chapsc - \let\tensf=\chapsf \let\teni=\chapi \let\tensy=\chapsy - \let\tenttsl=\chapttsl - \def\curfontsize{chap}% - \def\lsize{sec}\def\lllsize{text}% - \resetmathfonts \setleading{19pt}} -\def\secfonts{% - \let\tenrm=\secrm \let\tenit=\secit \let\tensl=\secsl - \let\tenbf=\secbf \let\tentt=\sectt \let\smallcaps=\secsc - \let\tensf=\secsf \let\teni=\seci \let\tensy=\secsy - \let\tenttsl=\secttsl - \def\curfontsize{sec}% - \def\lsize{subsec}\def\lllsize{reduced}% - \resetmathfonts \setleading{16pt}} -\def\subsecfonts{% - \let\tenrm=\ssecrm \let\tenit=\ssecit \let\tensl=\ssecsl - \let\tenbf=\ssecbf \let\tentt=\ssectt \let\smallcaps=\ssecsc - \let\tensf=\ssecsf \let\teni=\sseci \let\tensy=\ssecsy - \let\tenttsl=\ssecttsl - \def\curfontsize{ssec}% - \def\lsize{text}\def\lllsize{small}% - \resetmathfonts \setleading{15pt}} -\let\subsubsecfonts = \subsecfonts -\def\reducedfonts{% - \let\tenrm=\reducedrm \let\tenit=\reducedit \let\tensl=\reducedsl - \let\tenbf=\reducedbf \let\tentt=\reducedtt \let\reducedcaps=\reducedsc - \let\tensf=\reducedsf \let\teni=\reducedi \let\tensy=\reducedsy - \let\tenttsl=\reducedttsl - \def\curfontsize{reduced}% - \def\lsize{small}\def\lllsize{smaller}% - \resetmathfonts \setleading{10.5pt}} -\def\smallfonts{% - \let\tenrm=\smallrm \let\tenit=\smallit \let\tensl=\smallsl - \let\tenbf=\smallbf \let\tentt=\smalltt \let\smallcaps=\smallsc - \let\tensf=\smallsf \let\teni=\smalli \let\tensy=\smallsy - \let\tenttsl=\smallttsl - \def\curfontsize{small}% - \def\lsize{smaller}\def\lllsize{smaller}% - \resetmathfonts \setleading{10.5pt}} -\def\smallerfonts{% - \let\tenrm=\smallerrm \let\tenit=\smallerit \let\tensl=\smallersl - \let\tenbf=\smallerbf \let\tentt=\smallertt \let\smallcaps=\smallersc - \let\tensf=\smallersf \let\teni=\smalleri \let\tensy=\smallersy - \let\tenttsl=\smallerttsl - \def\curfontsize{smaller}% - \def\lsize{smaller}\def\lllsize{smaller}% - \resetmathfonts \setleading{9.5pt}} - -% Set the fonts to use with the @small... environments. -\let\smallexamplefonts = \smallfonts - -% About \smallexamplefonts. If we use \smallfonts (9pt), @smallexample -% can fit this many characters: -% 8.5x11=86 smallbook=72 a4=90 a5=69 -% If we use \scriptfonts (8pt), then we can fit this many characters: -% 8.5x11=90+ smallbook=80 a4=90+ a5=77 -% For me, subjectively, the few extra characters that fit aren't worth -% the additional smallness of 8pt. So I'm making the default 9pt. -% -% By the way, for comparison, here's what fits with @example (10pt): -% 8.5x11=71 smallbook=60 a4=75 a5=58 -% -% I wish the USA used A4 paper. -% --karl, 24jan03. - - -% Set up the default fonts, so we can use them for creating boxes. -% -\definetextfontsizexi - -% Define these so they can be easily changed for other fonts. -\def\angleleft{$\langle$} -\def\angleright{$\rangle$} - -% Count depth in font-changes, for error checks -\newcount\fontdepth \fontdepth=0 - -% Fonts for short table of contents. -\setfont\shortcontrm\rmshape{12}{1000} -\setfont\shortcontbf\bfshape{10}{\magstep1} % no cmb12 -\setfont\shortcontsl\slshape{12}{1000} -\setfont\shortconttt\ttshape{12}{1000} - -%% Add scribe-like font environments, plus @l for inline lisp (usually sans -%% serif) and @ii for TeX italic - -% \smartitalic{ARG} outputs arg in italics, followed by an italic correction -% unless the following character is such as not to need one. -\def\smartitalicx{\ifx\next,\else\ifx\next-\else\ifx\next.\else - \ptexslash\fi\fi\fi} -\def\smartslanted#1{{\ifusingtt\ttsl\sl #1}\futurelet\next\smartitalicx} -\def\smartitalic#1{{\ifusingtt\ttsl\it #1}\futurelet\next\smartitalicx} - -% like \smartslanted except unconditionally uses \ttsl. -% @var is set to this for defun arguments. -\def\ttslanted#1{{\ttsl #1}\futurelet\next\smartitalicx} - -% like \smartslanted except unconditionally use \sl. We never want -% ttsl for book titles, do we? -\def\cite#1{{\sl #1}\futurelet\next\smartitalicx} - -\let\i=\smartitalic -\let\slanted=\smartslanted -\let\var=\smartslanted -\let\dfn=\smartslanted -\let\emph=\smartitalic - -% @b, explicit bold. -\def\b#1{{\bf #1}} -\let\strong=\b - -% @sansserif, explicit sans. -\def\sansserif#1{{\sf #1}} - -% We can't just use \exhyphenpenalty, because that only has effect at -% the end of a paragraph. Restore normal hyphenation at the end of the -% group within which \nohyphenation is presumably called. -% -\def\nohyphenation{\hyphenchar\font = -1 \aftergroup\restorehyphenation} -\def\restorehyphenation{\hyphenchar\font = `- } - -% Set sfcode to normal for the chars that usually have another value. -% Can't use plain's \frenchspacing because it uses the `\x notation, and -% sometimes \x has an active definition that messes things up. -% -\catcode`@=11 - \def\plainfrenchspacing{% - \sfcode\dotChar =\@m \sfcode\questChar=\@m \sfcode\exclamChar=\@m - \sfcode\colonChar=\@m \sfcode\semiChar =\@m \sfcode\commaChar =\@m - \def\endofsentencespacefactor{1000}% for @. and friends - } - \def\plainnonfrenchspacing{% - \sfcode`\.3000\sfcode`\?3000\sfcode`\!3000 - \sfcode`\:2000\sfcode`\;1500\sfcode`\,1250 - \def\endofsentencespacefactor{3000}% for @. and friends - } -\catcode`@=\other -\def\endofsentencespacefactor{3000}% default - -\def\t#1{% - {\tt \rawbackslash \plainfrenchspacing #1}% - \null -} -\def\samp#1{`\tclose{#1}'\null} -\setfont\keyrm\rmshape{8}{1000} -\font\keysy=cmsy9 -\def\key#1{{\keyrm\textfont2=\keysy \leavevmode\hbox{% - \raise0.4pt\hbox{\angleleft}\kern-.08em\vtop{% - \vbox{\hrule\kern-0.4pt - \hbox{\raise0.4pt\hbox{\vphantom{\angleleft}}#1}}% - \kern-0.4pt\hrule}% - \kern-.06em\raise0.4pt\hbox{\angleright}}}} -% The old definition, with no lozenge: -%\def\key #1{{\ttsl \nohyphenation \uppercase{#1}}\null} -\def\ctrl #1{{\tt \rawbackslash \hat}#1} - -% @file, @option are the same as @samp. -\let\file=\samp -\let\option=\samp - -% @code is a modification of @t, -% which makes spaces the same size as normal in the surrounding text. -\def\tclose#1{% - {% - % Change normal interword space to be same as for the current font. - \spaceskip = \fontdimen2\font - % - % Switch to typewriter. - \tt - % - % But `\ ' produces the large typewriter interword space. - \def\ {{\spaceskip = 0pt{} }}% - % - % Turn off hyphenation. - \nohyphenation - % - \rawbackslash - \plainfrenchspacing - #1% - }% - \null -} - -% We *must* turn on hyphenation at `-' and `_' in @code. -% Otherwise, it is too hard to avoid overfull hboxes -% in the Emacs manual, the Library manual, etc. - -% Unfortunately, TeX uses one parameter (\hyphenchar) to control -% both hyphenation at - and hyphenation within words. -% We must therefore turn them both off (\tclose does that) -% and arrange explicitly to hyphenate at a dash. -% -- rms. -{ - \catcode`\-=\active \catcode`\_=\active - \catcode`\'=\active \catcode`\`=\active - % - \global\def\code{\begingroup - \catcode\rquoteChar=\active \catcode\lquoteChar=\active - \let'\codequoteright \let`\codequoteleft - % - \catcode\dashChar=\active \catcode\underChar=\active - \ifallowcodebreaks - \let-\codedash - \let_\codeunder - \else - \let-\realdash - \let_\realunder - \fi - \codex - } -} - -\def\realdash{-} -\def\codedash{-\discretionary{}{}{}} -\def\codeunder{% - % this is all so @math{@code{var_name}+1} can work. In math mode, _ - % is "active" (mathcode"8000) and \normalunderscore (or \char95, etc.) - % will therefore expand the active definition of _, which is us - % (inside @code that is), therefore an endless loop. - \ifusingtt{\ifmmode - \mathchar"075F % class 0=ordinary, family 7=ttfam, pos 0x5F=_. - \else\normalunderscore \fi - \discretionary{}{}{}}% - {\_}% -} -\def\codex #1{\tclose{#1}\endgroup} - -% 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. -% -\newif\ifallowcodebreaks \allowcodebreakstrue - -\def\keywordtrue{true} -\def\keywordfalse{false} - -\parseargdef\allowcodebreaks{% - \def\txiarg{#1}% - \ifx\txiarg\keywordtrue - \allowcodebreakstrue - \else\ifx\txiarg\keywordfalse - \allowcodebreaksfalse - \else - \errhelp = \EMsimple - \errmessage{Unknown @allowcodebreaks option `\txiarg'}% - \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 -\let\env=\code -\let\command=\code - -% @uref (abbreviation for `urlref') takes an optional (comma-separated) -% second argument specifying the text to display and an optional third -% arg as text to display instead of (rather than in addition to) the url -% itself. First (mandatory) arg is the url. Perhaps eventually put in -% a hypertex \special here. -% -\def\uref#1{\douref #1,,,\finish} -\def\douref#1,#2,#3,#4\finish{\begingroup - \unsepspaces - \pdfurl{#1}% - \setbox0 = \hbox{\ignorespaces #3}% - \ifdim\wd0 > 0pt - \unhbox0 % third arg given, show only that - \else - \setbox0 = \hbox{\ignorespaces #2}% - \ifdim\wd0 > 0pt - \ifpdf - \unhbox0 % PDF: 2nd arg given, show only it - \else - \unhbox0\ (\code{#1})% DVI: 2nd arg given, show both it and url - \fi - \else - \code{#1}% only url given, so show it - \fi - \fi - \endlink -\endgroup} - -% @url synonym for @uref, since that's how everyone uses it. -% -\let\url=\uref - -% rms does not like angle brackets --karl, 17may97. -% So now @email is just like @uref, unless we are pdf. -% -%\def\email#1{\angleleft{\tt #1}\angleright} -\ifpdf - \def\email#1{\doemail#1,,\finish} - \def\doemail#1,#2,#3\finish{\begingroup - \unsepspaces - \pdfurl{mailto:#1}% - \setbox0 = \hbox{\ignorespaces #2}% - \ifdim\wd0>0pt\unhbox0\else\code{#1}\fi - \endlink - \endgroup} -\else - \let\email=\uref -\fi - -% Check if we are currently using a typewriter font. Since all the -% Computer Modern typewriter fonts have zero interword stretch (and -% shrink), and it is reasonable to expect all typewriter fonts to have -% this property, we can check that font parameter. -% -\def\ifmonospace{\ifdim\fontdimen3\font=0pt } - -% Typeset a dimension, e.g., `in' or `pt'. The only reason for the -% argument is to make the input look right: @dmn{pt} instead of @dmn{}pt. -% -\def\dmn#1{\thinspace #1} - -\def\kbd#1{\def\look{#1}\expandafter\kbdfoo\look??\par} - -% @l was never documented to mean ``switch to the Lisp font'', -% and it is not used as such in any manual I can find. We need it for -% Polish suppressed-l. --karl, 22sep96. -%\def\l#1{{\li #1}\null} - -% Explicit font changes: @r, @sc, undocumented @ii. -\def\r#1{{\rm #1}} % roman font -\def\sc#1{{\smallcaps#1}} % smallcaps font -\def\ii#1{{\it #1}} % italic font - -% @acronym for "FBI", "NATO", and the like. -% We print this one point size smaller, since it's intended for -% all-uppercase. -% -\def\acronym#1{\doacronym #1,,\finish} -\def\doacronym#1,#2,#3\finish{% - {\selectfonts\lsize #1}% - \def\temp{#2}% - \ifx\temp\empty \else - \space ({\unsepspaces \ignorespaces \temp \unskip})% - \fi -} - -% @abbr for "Comput. J." and the like. -% No font change, but don't do end-of-sentence spacing. -% -\def\abbr#1{\doabbr #1,,\finish} -\def\doabbr#1,#2,#3\finish{% - {\plainfrenchspacing #1}% - \def\temp{#2}% - \ifx\temp\empty \else - \space ({\unsepspaces \ignorespaces \temp \unskip})% - \fi -} - -% @pounds{} is a sterling sign, which Knuth put in the CM italic font. -% -\def\pounds{{\it\$}} - -% @euro{} comes from a separate font, depending on the current style. -% We use the free feym* fonts from the eurosym package by Henrik -% Theiling, which support regular, slanted, bold and bold slanted (and -% "outlined" (blackboard board, sort of) versions, which we don't need). -% It is available from http://www.ctan.org/tex-archive/fonts/eurosym. -% -% Although only regular is the truly official Euro symbol, we ignore -% that. The Euro is designed to be slightly taller than the regular -% font height. -% -% feymr - regular -% feymo - slanted -% feybr - bold -% feybo - bold slanted -% -% There is no good (free) typewriter version, to my knowledge. -% A feymr10 euro is ~7.3pt wide, while a normal cmtt10 char is ~5.25pt wide. -% Hmm. -% -% Also doesn't work in math. Do we need to do math with euro symbols? -% Hope not. -% -% -\def\euro{{\eurofont e}} -\def\eurofont{% - % We set the font at each command, rather than predefining it in - % \textfonts and the other font-switching commands, so that - % installations which never need the symbol don't have to have the - % font installed. - % - % There is only one designed size (nominal 10pt), so we always scale - % that to the current nominal size. - % - % By the way, simply using "at 1em" works for cmr10 and the like, but - % does not work for cmbx10 and other extended/shrunken fonts. - % - \def\eurosize{\csname\curfontsize nominalsize\endcsname}% - % - \ifx\curfontstyle\bfstylename - % bold: - \font\thiseurofont = \ifusingit{feybo10}{feybr10} at \eurosize - \else - % regular: - \font\thiseurofont = \ifusingit{feymo10}{feymr10} at \eurosize - \fi - \thiseurofont -} - -% @registeredsymbol - R in a circle. The font for the R should really -% be smaller yet, but lllsize is the best we can do for now. -% Adapted from the plain.tex definition of \copyright. -% -\def\registeredsymbol{% - $^{{\ooalign{\hfil\raise.07ex\hbox{\selectfonts\lllsize R}% - \hfil\crcr\Orb}}% - }$% -} - -% @textdegree - the normal degrees sign. -% -\def\textdegree{$^\circ$} - -% Laurent Siebenmann reports \Orb undefined with: -% Textures 1.7.7 (preloaded format=plain 93.10.14) (68K) 16 APR 2004 02:38 -% so we'll define it if necessary. -% -\ifx\Orb\undefined -\def\Orb{\mathhexbox20D} -\fi - - -\message{page headings,} - -\newskip\titlepagetopglue \titlepagetopglue = 1.5in -\newskip\titlepagebottomglue \titlepagebottomglue = 2pc - -% First the title page. Must do @settitle before @titlepage. -\newif\ifseenauthor -\newif\iffinishedtitlepage - -% Do an implicit @contents or @shortcontents after @end titlepage if the -% user says @setcontentsaftertitlepage or @setshortcontentsaftertitlepage. -% -\newif\ifsetcontentsaftertitlepage - \let\setcontentsaftertitlepage = \setcontentsaftertitlepagetrue -\newif\ifsetshortcontentsaftertitlepage - \let\setshortcontentsaftertitlepage = \setshortcontentsaftertitlepagetrue - -\parseargdef\shorttitlepage{\begingroup\hbox{}\vskip 1.5in \chaprm \centerline{#1}% - \endgroup\page\hbox{}\page} - -\envdef\titlepage{% - % Open one extra group, as we want to close it in the middle of \Etitlepage. - \begingroup - \parindent=0pt \textfonts - % Leave some space at the very top of the page. - \vglue\titlepagetopglue - % No rule at page bottom unless we print one at the top with @title. - \finishedtitlepagetrue - % - % Most title ``pages'' are actually two pages long, with space - % at the top of the second. We don't want the ragged left on the second. - \let\oldpage = \page - \def\page{% - \iffinishedtitlepage\else - \finishtitlepage - \fi - \let\page = \oldpage - \page - \null - }% -} - -\def\Etitlepage{% - \iffinishedtitlepage\else - \finishtitlepage - \fi - % It is important to do the page break before ending the group, - % because the headline and footline are only empty inside the group. - % If we use the new definition of \page, we always get a blank page - % after the title page, which we certainly don't want. - \oldpage - \endgroup - % - % Need this before the \...aftertitlepage checks so that if they are - % in effect the toc pages will come out with page numbers. - \HEADINGSon - % - % If they want short, they certainly want long too. - \ifsetshortcontentsaftertitlepage - \shortcontents - \contents - \global\let\shortcontents = \relax - \global\let\contents = \relax - \fi - % - \ifsetcontentsaftertitlepage - \contents - \global\let\contents = \relax - \global\let\shortcontents = \relax - \fi -} - -\def\finishtitlepage{% - \vskip4pt \hrule height 2pt width \hsize - \vskip\titlepagebottomglue - \finishedtitlepagetrue -} - -%%% Macros to be used within @titlepage: - -\let\subtitlerm=\tenrm -\def\subtitlefont{\subtitlerm \normalbaselineskip = 13pt \normalbaselines} - -\def\authorfont{\authorrm \normalbaselineskip = 16pt \normalbaselines - \let\tt=\authortt} - -\parseargdef\title{% - \checkenv\titlepage - \leftline{\titlefonts\rm #1} - % print a rule at the page bottom also. - \finishedtitlepagefalse - \vskip4pt \hrule height 4pt width \hsize \vskip4pt -} - -\parseargdef\subtitle{% - \checkenv\titlepage - {\subtitlefont \rightline{#1}}% -} - -% @author should come last, but may come many times. -% It can also be used inside @quotation. -% -\parseargdef\author{% - \def\temp{\quotation}% - \ifx\thisenv\temp - \def\quotationauthor{#1}% printed in \Equotation. - \else - \checkenv\titlepage - \ifseenauthor\else \vskip 0pt plus 1filll \seenauthortrue \fi - {\authorfont \leftline{#1}}% - \fi -} - - -%%% Set up page headings and footings. - -\let\thispage=\folio - -\newtoks\evenheadline % headline on even pages -\newtoks\oddheadline % headline on odd pages -\newtoks\evenfootline % footline on even pages -\newtoks\oddfootline % footline on odd pages - -% Now make TeX use those variables -\headline={{\textfonts\rm \ifodd\pageno \the\oddheadline - \else \the\evenheadline \fi}} -\footline={{\textfonts\rm \ifodd\pageno \the\oddfootline - \else \the\evenfootline \fi}\HEADINGShook} -\let\HEADINGShook=\relax - -% Commands to set those variables. -% For example, this is what @headings on does -% @evenheading @thistitle|@thispage|@thischapter -% @oddheading @thischapter|@thispage|@thistitle -% @evenfooting @thisfile|| -% @oddfooting ||@thisfile - - -\def\evenheading{\parsearg\evenheadingxxx} -\def\evenheadingxxx #1{\evenheadingyyy #1\|\|\|\|\finish} -\def\evenheadingyyy #1\|#2\|#3\|#4\finish{% -\global\evenheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} - -\def\oddheading{\parsearg\oddheadingxxx} -\def\oddheadingxxx #1{\oddheadingyyy #1\|\|\|\|\finish} -\def\oddheadingyyy #1\|#2\|#3\|#4\finish{% -\global\oddheadline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} - -\parseargdef\everyheading{\oddheadingxxx{#1}\evenheadingxxx{#1}}% - -\def\evenfooting{\parsearg\evenfootingxxx} -\def\evenfootingxxx #1{\evenfootingyyy #1\|\|\|\|\finish} -\def\evenfootingyyy #1\|#2\|#3\|#4\finish{% -\global\evenfootline={\rlap{\centerline{#2}}\line{#1\hfil#3}}} - -\def\oddfooting{\parsearg\oddfootingxxx} -\def\oddfootingxxx #1{\oddfootingyyy #1\|\|\|\|\finish} -\def\oddfootingyyy #1\|#2\|#3\|#4\finish{% - \global\oddfootline = {\rlap{\centerline{#2}}\line{#1\hfil#3}}% - % - % Leave some space for the footline. Hopefully ok to assume - % @evenfooting will not be used by itself. - \global\advance\pageheight by -12pt - \global\advance\vsize by -12pt -} - -\parseargdef\everyfooting{\oddfootingxxx{#1}\evenfootingxxx{#1}} - - -% @headings double turns headings on for double-sided printing. -% @headings single turns headings on for single-sided printing. -% @headings off turns them off. -% @headings on same as @headings double, retained for compatibility. -% @headings after turns on double-sided headings after this page. -% @headings doubleafter turns on double-sided headings after this page. -% @headings singleafter turns on single-sided headings after this page. -% By default, they are off at the start of a document, -% and turned `on' after @end titlepage. - -\def\headings #1 {\csname HEADINGS#1\endcsname} - -\def\HEADINGSoff{% -\global\evenheadline={\hfil} \global\evenfootline={\hfil} -\global\oddheadline={\hfil} \global\oddfootline={\hfil}} -\HEADINGSoff -% When we turn headings on, set the page number to 1. -% For double-sided printing, put current file name in lower left corner, -% chapter name on inside top of right hand pages, document -% title on inside top of left hand pages, and page numbers on outside top -% edge of all pages. -\def\HEADINGSdouble{% -\global\pageno=1 -\global\evenfootline={\hfil} -\global\oddfootline={\hfil} -\global\evenheadline={\line{\folio\hfil\thistitle}} -\global\oddheadline={\line{\thischapter\hfil\folio}} -\global\let\contentsalignmacro = \chapoddpage -} -\let\contentsalignmacro = \chappager - -% For single-sided printing, chapter title goes across top left of page, -% page number on top right. -\def\HEADINGSsingle{% -\global\pageno=1 -\global\evenfootline={\hfil} -\global\oddfootline={\hfil} -\global\evenheadline={\line{\thischapter\hfil\folio}} -\global\oddheadline={\line{\thischapter\hfil\folio}} -\global\let\contentsalignmacro = \chappager -} -\def\HEADINGSon{\HEADINGSdouble} - -\def\HEADINGSafter{\let\HEADINGShook=\HEADINGSdoublex} -\let\HEADINGSdoubleafter=\HEADINGSafter -\def\HEADINGSdoublex{% -\global\evenfootline={\hfil} -\global\oddfootline={\hfil} -\global\evenheadline={\line{\folio\hfil\thistitle}} -\global\oddheadline={\line{\thischapter\hfil\folio}} -\global\let\contentsalignmacro = \chapoddpage -} - -\def\HEADINGSsingleafter{\let\HEADINGShook=\HEADINGSsinglex} -\def\HEADINGSsinglex{% -\global\evenfootline={\hfil} -\global\oddfootline={\hfil} -\global\evenheadline={\line{\thischapter\hfil\folio}} -\global\oddheadline={\line{\thischapter\hfil\folio}} -\global\let\contentsalignmacro = \chappager -} - -% Subroutines used in generating headings -% This produces Day Month Year style of output. -% Only define if not already defined, in case a txi-??.tex file has set -% up a different format (e.g., txi-cs.tex does this). -\ifx\today\undefined -\def\today{% - \number\day\space - \ifcase\month - \or\putwordMJan\or\putwordMFeb\or\putwordMMar\or\putwordMApr - \or\putwordMMay\or\putwordMJun\or\putwordMJul\or\putwordMAug - \or\putwordMSep\or\putwordMOct\or\putwordMNov\or\putwordMDec - \fi - \space\number\year} -\fi - -% @settitle line... specifies the title of the document, for headings. -% It generates no output of its own. -\def\thistitle{\putwordNoTitle} -\def\settitle{\parsearg{\gdef\thistitle}} - - -\message{tables,} -% Tables -- @table, @ftable, @vtable, @item(x). - -% default indentation of table text -\newdimen\tableindent \tableindent=.8in -% default indentation of @itemize and @enumerate text -\newdimen\itemindent \itemindent=.3in -% margin between end of table item and start of table text. -\newdimen\itemmargin \itemmargin=.1in - -% used internally for \itemindent minus \itemmargin -\newdimen\itemmax - -% Note @table, @ftable, and @vtable define @item, @itemx, etc., with -% these defs. -% They also define \itemindex -% to index the item name in whatever manner is desired (perhaps none). - -\newif\ifitemxneedsnegativevskip - -\def\itemxpar{\par\ifitemxneedsnegativevskip\nobreak\vskip-\parskip\nobreak\fi} - -\def\internalBitem{\smallbreak \parsearg\itemzzz} -\def\internalBitemx{\itemxpar \parsearg\itemzzz} - -\def\itemzzz #1{\begingroup % - \advance\hsize by -\rightskip - \advance\hsize by -\tableindent - \setbox0=\hbox{\itemindicate{#1}}% - \itemindex{#1}% - \nobreak % This prevents a break before @itemx. - % - % If the item text does not fit in the space we have, put it on a line - % by itself, and do not allow a page break either before or after that - % line. We do not start a paragraph here because then if the next - % command is, e.g., @kindex, the whatsit would get put into the - % horizontal list on a line by itself, resulting in extra blank space. - \ifdim \wd0>\itemmax - % - % Make this a paragraph so we get the \parskip glue and wrapping, - % but leave it ragged-right. - \begingroup - \advance\leftskip by-\tableindent - \advance\hsize by\tableindent - \advance\rightskip by0pt plus1fil - \leavevmode\unhbox0\par - \endgroup - % - % We're going to be starting a paragraph, but we don't want the - % \parskip glue -- logically it's part of the @item we just started. - \nobreak \vskip-\parskip - % - % Stop a page break at the \parskip glue coming up. However, if - % what follows is an environment such as @example, there will be no - % \parskip glue; then the negative vskip we just inserted would - % cause the example and the item to crash together. So we use this - % bizarre value of 10001 as a signal to \aboveenvbreak to insert - % \parskip glue after all. Section titles are handled this way also. - % - \penalty 10001 - \endgroup - \itemxneedsnegativevskipfalse - \else - % The item text fits into the space. Start a paragraph, so that the - % following text (if any) will end up on the same line. - \noindent - % Do this with kerns and \unhbox so that if there is a footnote in - % the item text, it can migrate to the main vertical list and - % eventually be printed. - \nobreak\kern-\tableindent - \dimen0 = \itemmax \advance\dimen0 by \itemmargin \advance\dimen0 by -\wd0 - \unhbox0 - \nobreak\kern\dimen0 - \endgroup - \itemxneedsnegativevskiptrue - \fi -} - -\def\item{\errmessage{@item while not in a list environment}} -\def\itemx{\errmessage{@itemx while not in a list environment}} - -% @table, @ftable, @vtable. -\envdef\table{% - \let\itemindex\gobble - \tablecheck{table}% -} -\envdef\ftable{% - \def\itemindex ##1{\doind {fn}{\code{##1}}}% - \tablecheck{ftable}% -} -\envdef\vtable{% - \def\itemindex ##1{\doind {vr}{\code{##1}}}% - \tablecheck{vtable}% -} -\def\tablecheck#1{% - \ifnum \the\catcode`\^^M=\active - \endgroup - \errmessage{This command won't work in this context; perhaps the problem is - that we are \inenvironment\thisenv}% - \def\next{\doignore{#1}}% - \else - \let\next\tablex - \fi - \next -} -\def\tablex#1{% - \def\itemindicate{#1}% - \parsearg\tabley -} -\def\tabley#1{% - {% - \makevalueexpandable - \edef\temp{\noexpand\tablez #1\space\space\space}% - \expandafter - }\temp \endtablez -} -\def\tablez #1 #2 #3 #4\endtablez{% - \aboveenvbreak - \ifnum 0#1>0 \advance \leftskip by #1\mil \fi - \ifnum 0#2>0 \tableindent=#2\mil \fi - \ifnum 0#3>0 \advance \rightskip by #3\mil \fi - \itemmax=\tableindent - \advance \itemmax by -\itemmargin - \advance \leftskip by \tableindent - \exdentamount=\tableindent - \parindent = 0pt - \parskip = \smallskipamount - \ifdim \parskip=0pt \parskip=2pt \fi - \let\item = \internalBitem - \let\itemx = \internalBitemx -} -\def\Etable{\endgraf\afterenvbreak} -\let\Eftable\Etable -\let\Evtable\Etable -\let\Eitemize\Etable -\let\Eenumerate\Etable - -% This is the counter used by @enumerate, which is really @itemize - -\newcount \itemno - -\envdef\itemize{\parsearg\doitemize} - -\def\doitemize#1{% - \aboveenvbreak - \itemmax=\itemindent - \advance\itemmax by -\itemmargin - \advance\leftskip by \itemindent - \exdentamount=\itemindent - \parindent=0pt - \parskip=\smallskipamount - \ifdim\parskip=0pt \parskip=2pt \fi - \def\itemcontents{#1}% - % @itemize with no arg is equivalent to @itemize @bullet. - \ifx\itemcontents\empty\def\itemcontents{\bullet}\fi - \let\item=\itemizeitem -} - -% Definition of @item while inside @itemize and @enumerate. -% -\def\itemizeitem{% - \advance\itemno by 1 % for enumerations - {\let\par=\endgraf \smallbreak}% reasonable place to break - {% - % If the document has an @itemize directly after a section title, a - % \nobreak will be last on the list, and \sectionheading will have - % done a \vskip-\parskip. In that case, we don't want to zero - % parskip, or the item text will crash with the heading. On the - % other hand, when there is normal text preceding the item (as there - % usually is), we do want to zero parskip, or there would be too much - % space. In that case, we won't have a \nobreak before. At least - % that's the theory. - \ifnum\lastpenalty<10000 \parskip=0in \fi - \noindent - \hbox to 0pt{\hss \itemcontents \kern\itemmargin}% - \vadjust{\penalty 1200}}% not good to break after first line of item. - \flushcr -} - -% \splitoff TOKENS\endmark defines \first to be the first token in -% TOKENS, and \rest to be the remainder. -% -\def\splitoff#1#2\endmark{\def\first{#1}\def\rest{#2}}% - -% Allow an optional argument of an uppercase letter, lowercase letter, -% or number, to specify the first label in the enumerated list. No -% argument is the same as `1'. -% -\envparseargdef\enumerate{\enumeratey #1 \endenumeratey} -\def\enumeratey #1 #2\endenumeratey{% - % If we were given no argument, pretend we were given `1'. - \def\thearg{#1}% - \ifx\thearg\empty \def\thearg{1}\fi - % - % Detect if the argument is a single token. If so, it might be a - % letter. Otherwise, the only valid thing it can be is a number. - % (We will always have one token, because of the test we just made. - % This is a good thing, since \splitoff doesn't work given nothing at - % all -- the first parameter is undelimited.) - \expandafter\splitoff\thearg\endmark - \ifx\rest\empty - % Only one token in the argument. It could still be anything. - % A ``lowercase letter'' is one whose \lccode is nonzero. - % An ``uppercase letter'' is one whose \lccode is both nonzero, and - % not equal to itself. - % Otherwise, we assume it's a number. - % - % We need the \relax at the end of the \ifnum lines to stop TeX from - % continuing to look for a . - % - \ifnum\lccode\expandafter`\thearg=0\relax - \numericenumerate % a number (we hope) - \else - % It's a letter. - \ifnum\lccode\expandafter`\thearg=\expandafter`\thearg\relax - \lowercaseenumerate % lowercase letter - \else - \uppercaseenumerate % uppercase letter - \fi - \fi - \else - % Multiple tokens in the argument. We hope it's a number. - \numericenumerate - \fi -} - -% An @enumerate whose labels are integers. The starting integer is -% given in \thearg. -% -\def\numericenumerate{% - \itemno = \thearg - \startenumeration{\the\itemno}% -} - -% The starting (lowercase) letter is in \thearg. -\def\lowercaseenumerate{% - \itemno = \expandafter`\thearg - \startenumeration{% - % Be sure we're not beyond the end of the alphabet. - \ifnum\itemno=0 - \errmessage{No more lowercase letters in @enumerate; get a bigger - alphabet}% - \fi - \char\lccode\itemno - }% -} - -% The starting (uppercase) letter is in \thearg. -\def\uppercaseenumerate{% - \itemno = \expandafter`\thearg - \startenumeration{% - % Be sure we're not beyond the end of the alphabet. - \ifnum\itemno=0 - \errmessage{No more uppercase letters in @enumerate; get a bigger - alphabet} - \fi - \char\uccode\itemno - }% -} - -% Call \doitemize, adding a period to the first argument and supplying the -% common last two arguments. Also subtract one from the initial value in -% \itemno, since @item increments \itemno. -% -\def\startenumeration#1{% - \advance\itemno by -1 - \doitemize{#1.}\flushcr -} - -% @alphaenumerate and @capsenumerate are abbreviations for giving an arg -% to @enumerate. -% -\def\alphaenumerate{\enumerate{a}} -\def\capsenumerate{\enumerate{A}} -\def\Ealphaenumerate{\Eenumerate} -\def\Ecapsenumerate{\Eenumerate} - - -% @multitable macros -% Amy Hendrickson, 8/18/94, 3/6/96 -% -% @multitable ... @end multitable will make as many columns as desired. -% Contents of each column will wrap at width given in preamble. Width -% can be specified either with sample text given in a template line, -% or in percent of \hsize, the current width of text on page. - -% Table can continue over pages but will only break between lines. - -% To make preamble: -% -% Either define widths of columns in terms of percent of \hsize: -% @multitable @columnfractions .25 .3 .45 -% @item ... -% -% Numbers following @columnfractions are the percent of the total -% current hsize to be used for each column. You may use as many -% columns as desired. - - -% Or use a template: -% @multitable {Column 1 template} {Column 2 template} {Column 3 template} -% @item ... -% using the widest term desired in each column. - -% Each new table line starts with @item, each subsequent new column -% starts with @tab. Empty columns may be produced by supplying @tab's -% with nothing between them for as many times as empty columns are needed, -% ie, @tab@tab@tab will produce two empty columns. - -% @item, @tab do not need to be on their own lines, but it will not hurt -% if they are. - -% Sample multitable: - -% @multitable {Column 1 template} {Column 2 template} {Column 3 template} -% @item first col stuff @tab second col stuff @tab third col -% @item -% first col stuff -% @tab -% second col stuff -% @tab -% third col -% @item first col stuff @tab second col stuff -% @tab Many paragraphs of text may be used in any column. -% -% They will wrap at the width determined by the template. -% @item@tab@tab This will be in third column. -% @end multitable - -% Default dimensions may be reset by user. -% @multitableparskip is vertical space between paragraphs in table. -% @multitableparindent is paragraph indent in table. -% @multitablecolmargin is horizontal space to be left between columns. -% @multitablelinespace is space to leave between table items, baseline -% to baseline. -% 0pt means it depends on current normal line spacing. -% -\newskip\multitableparskip -\newskip\multitableparindent -\newdimen\multitablecolspace -\newskip\multitablelinespace -\multitableparskip=0pt -\multitableparindent=6pt -\multitablecolspace=12pt -\multitablelinespace=0pt - -% Macros used to set up halign preamble: -% -\let\endsetuptable\relax -\def\xendsetuptable{\endsetuptable} -\let\columnfractions\relax -\def\xcolumnfractions{\columnfractions} -\newif\ifsetpercent - -% #1 is the @columnfraction, usually a decimal number like .5, but might -% be just 1. We just use it, whatever it is. -% -\def\pickupwholefraction#1 {% - \global\advance\colcount by 1 - \expandafter\xdef\csname col\the\colcount\endcsname{#1\hsize}% - \setuptable -} - -\newcount\colcount -\def\setuptable#1{% - \def\firstarg{#1}% - \ifx\firstarg\xendsetuptable - \let\go = \relax - \else - \ifx\firstarg\xcolumnfractions - \global\setpercenttrue - \else - \ifsetpercent - \let\go\pickupwholefraction - \else - \global\advance\colcount by 1 - \setbox0=\hbox{#1\unskip\space}% Add a normal word space as a - % separator; typically that is always in the input, anyway. - \expandafter\xdef\csname col\the\colcount\endcsname{\the\wd0}% - \fi - \fi - \ifx\go\pickupwholefraction - % Put the argument back for the \pickupwholefraction call, so - % we'll always have a period there to be parsed. - \def\go{\pickupwholefraction#1}% - \else - \let\go = \setuptable - \fi% - \fi - \go -} - -% multitable-only commands. -% -% @headitem starts a heading row, which we typeset in bold. -% Assignments have to be global since we are inside the implicit group -% of an alignment entry. Note that \everycr resets \everytab. -\def\headitem{\checkenv\multitable \crcr \global\everytab={\bf}\the\everytab}% -% -% A \tab used to include \hskip1sp. But then the space in a template -% line is not enough. That is bad. So let's go back to just `&' until -% we encounter the problem it was intended to solve again. -% --karl, nathan@acm.org, 20apr99. -\def\tab{\checkenv\multitable &\the\everytab}% - -% @multitable ... @end multitable definitions: -% -\newtoks\everytab % insert after every tab. -% -\envdef\multitable{% - \vskip\parskip - \startsavinginserts - % - % @item within a multitable starts a normal row. - % We use \def instead of \let so that if one of the multitable entries - % contains an @itemize, we don't choke on the \item (seen as \crcr aka - % \endtemplate) expanding \doitemize. - \def\item{\crcr}% - % - \tolerance=9500 - \hbadness=9500 - \setmultitablespacing - \parskip=\multitableparskip - \parindent=\multitableparindent - \overfullrule=0pt - \global\colcount=0 - % - \everycr = {% - \noalign{% - \global\everytab={}% - \global\colcount=0 % Reset the column counter. - % Check for saved footnotes, etc. - \checkinserts - % Keeps underfull box messages off when table breaks over pages. - %\filbreak - % Maybe so, but it also creates really weird page breaks when the - % table breaks over pages. Wouldn't \vfil be better? Wait until the - % problem manifests itself, so it can be fixed for real --karl. - }% - }% - % - \parsearg\domultitable -} -\def\domultitable#1{% - % To parse everything between @multitable and @item: - \setuptable#1 \endsetuptable - % - % This preamble sets up a generic column definition, which will - % be used as many times as user calls for columns. - % \vtop will set a single line and will also let text wrap and - % continue for many paragraphs if desired. - \halign\bgroup &% - \global\advance\colcount by 1 - \multistrut - \vtop{% - % Use the current \colcount to find the correct column width: - \hsize=\expandafter\csname col\the\colcount\endcsname - % - % In order to keep entries from bumping into each other - % we will add a \leftskip of \multitablecolspace to all columns after - % the first one. - % - % If a template has been used, we will add \multitablecolspace - % to the width of each template entry. - % - % If the user has set preamble in terms of percent of \hsize we will - % use that dimension as the width of the column, and the \leftskip - % will keep entries from bumping into each other. Table will start at - % left margin and final column will justify at right margin. - % - % Make sure we don't inherit \rightskip from the outer environment. - \rightskip=0pt - \ifnum\colcount=1 - % The first column will be indented with the surrounding text. - \advance\hsize by\leftskip - \else - \ifsetpercent \else - % If user has not set preamble in terms of percent of \hsize - % we will advance \hsize by \multitablecolspace. - \advance\hsize by \multitablecolspace - \fi - % In either case we will make \leftskip=\multitablecolspace: - \leftskip=\multitablecolspace - \fi - % Ignoring space at the beginning and end avoids an occasional spurious - % blank line, when TeX decides to break the line at the space before the - % box from the multistrut, so the strut ends up on a line by itself. - % For example: - % @multitable @columnfractions .11 .89 - % @item @code{#} - % @tab Legal holiday which is valid in major parts of the whole country. - % Is automatically provided with highlighting sequences respectively - % marking characters. - \noindent\ignorespaces##\unskip\multistrut - }\cr -} -\def\Emultitable{% - \crcr - \egroup % end the \halign - \global\setpercentfalse -} - -\def\setmultitablespacing{% - \def\multistrut{\strut}% just use the standard line spacing - % - % Compute \multitablelinespace (if not defined by user) for use in - % \multitableparskip calculation. We used define \multistrut based on - % this, but (ironically) that caused the spacing to be off. - % See bug-texinfo report from Werner Lemberg, 31 Oct 2004 12:52:20 +0100. -\ifdim\multitablelinespace=0pt -\setbox0=\vbox{X}\global\multitablelinespace=\the\baselineskip -\global\advance\multitablelinespace by-\ht0 -\fi -%% Test to see if parskip is larger than space between lines of -%% table. If not, do nothing. -%% If so, set to same dimension as multitablelinespace. -\ifdim\multitableparskip>\multitablelinespace -\global\multitableparskip=\multitablelinespace -\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller - %% than skip between lines in the table. -\fi% -\ifdim\multitableparskip=0pt -\global\multitableparskip=\multitablelinespace -\global\advance\multitableparskip-7pt %% to keep parskip somewhat smaller - %% than skip between lines in the table. -\fi} - - -\message{conditionals,} - -% @iftex, @ifnotdocbook, @ifnothtml, @ifnotinfo, @ifnotplaintext, -% @ifnotxml always succeed. They currently do nothing; we don't -% attempt to check whether the conditionals are properly nested. But we -% have to remember that they are conditionals, so that @end doesn't -% attempt to close an environment group. -% -\def\makecond#1{% - \expandafter\let\csname #1\endcsname = \relax - \expandafter\let\csname iscond.#1\endcsname = 1 -} -\makecond{iftex} -\makecond{ifnotdocbook} -\makecond{ifnothtml} -\makecond{ifnotinfo} -\makecond{ifnotplaintext} -\makecond{ifnotxml} - -% Ignore @ignore, @ifhtml, @ifinfo, and the like. -% -\def\direntry{\doignore{direntry}} -\def\documentdescription{\doignore{documentdescription}} -\def\docbook{\doignore{docbook}} -\def\html{\doignore{html}} -\def\ifdocbook{\doignore{ifdocbook}} -\def\ifhtml{\doignore{ifhtml}} -\def\ifinfo{\doignore{ifinfo}} -\def\ifnottex{\doignore{ifnottex}} -\def\ifplaintext{\doignore{ifplaintext}} -\def\ifxml{\doignore{ifxml}} -\def\ignore{\doignore{ignore}} -\def\menu{\doignore{menu}} -\def\xml{\doignore{xml}} - -% Ignore text until a line `@end #1', keeping track of nested conditionals. -% -% A count to remember the depth of nesting. -\newcount\doignorecount - -\def\doignore#1{\begingroup - % Scan in ``verbatim'' mode: - \obeylines - \catcode`\@ = \other - \catcode`\{ = \other - \catcode`\} = \other - % - % Make sure that spaces turn into tokens that match what \doignoretext wants. - \spaceisspace - % - % Count number of #1's that we've seen. - \doignorecount = 0 - % - % Swallow text until we reach the matching `@end #1'. - \dodoignore{#1}% -} - -{ \catcode`_=11 % We want to use \_STOP_ which cannot appear in texinfo source. - \obeylines % - % - \gdef\dodoignore#1{% - % #1 contains the command name as a string, e.g., `ifinfo'. - % - % Define a command to find the next `@end #1'. - \long\def\doignoretext##1^^M@end #1{% - \doignoretextyyy##1^^M@#1\_STOP_}% - % - % And this command to find another #1 command, at the beginning of a - % line. (Otherwise, we would consider a line `@c @ifset', for - % example, to count as an @ifset for nesting.) - \long\def\doignoretextyyy##1^^M@#1##2\_STOP_{\doignoreyyy{##2}\_STOP_}% - % - % And now expand that command. - \doignoretext ^^M% - }% -} - -\def\doignoreyyy#1{% - \def\temp{#1}% - \ifx\temp\empty % Nothing found. - \let\next\doignoretextzzz - \else % Found a nested condition, ... - \advance\doignorecount by 1 - \let\next\doignoretextyyy % ..., look for another. - % If we're here, #1 ends with ^^M\ifinfo (for example). - \fi - \next #1% the token \_STOP_ is present just after this macro. -} - -% We have to swallow the remaining "\_STOP_". -% -\def\doignoretextzzz#1{% - \ifnum\doignorecount = 0 % We have just found the outermost @end. - \let\next\enddoignore - \else % Still inside a nested condition. - \advance\doignorecount by -1 - \let\next\doignoretext % Look for the next @end. - \fi - \next -} - -% Finish off ignored text. -{ \obeylines% - % Ignore anything after the last `@end #1'; this matters in verbatim - % environments, where otherwise the newline after an ignored conditional - % would result in a blank line in the output. - \gdef\enddoignore#1^^M{\endgroup\ignorespaces}% -} - - -% @set VAR sets the variable VAR to an empty value. -% @set VAR REST-OF-LINE sets VAR to the value REST-OF-LINE. -% -% Since we want to separate VAR from REST-OF-LINE (which might be -% empty), we can't just use \parsearg; we have to insert a space of our -% own to delimit the rest of the line, and then take it out again if we -% didn't need it. -% We rely on the fact that \parsearg sets \catcode`\ =10. -% -\parseargdef\set{\setyyy#1 \endsetyyy} -\def\setyyy#1 #2\endsetyyy{% - {% - \makevalueexpandable - \def\temp{#2}% - \edef\next{\gdef\makecsname{SET#1}}% - \ifx\temp\empty - \next{}% - \else - \setzzz#2\endsetzzz - \fi - }% -} -% Remove the trailing space \setxxx inserted. -\def\setzzz#1 \endsetzzz{\next{#1}} - -% @clear VAR clears (i.e., unsets) the variable VAR. -% -\parseargdef\clear{% - {% - \makevalueexpandable - \global\expandafter\let\csname SET#1\endcsname=\relax - }% -} - -% @value{foo} gets the text saved in variable foo. -\def\value{\begingroup\makevalueexpandable\valuexxx} -\def\valuexxx#1{\expandablevalue{#1}\endgroup} -{ - \catcode`\- = \active \catcode`\_ = \active - % - \gdef\makevalueexpandable{% - \let\value = \expandablevalue - % We don't want these characters active, ... - \catcode`\-=\other \catcode`\_=\other - % ..., but we might end up with active ones in the argument if - % we're called from @code, as @code{@value{foo-bar_}}, though. - % So \let them to their normal equivalents. - \let-\realdash \let_\normalunderscore - } -} - -% We have this subroutine so that we can handle at least some @value's -% properly in indexes (we call \makevalueexpandable in \indexdummies). -% The command has to be fully expandable (if the variable is set), since -% the result winds up in the index file. This means that if the -% variable's value contains other Texinfo commands, it's almost certain -% it will fail (although perhaps we could fix that with sufficient work -% to do a one-level expansion on the result, instead of complete). -% -\def\expandablevalue#1{% - \expandafter\ifx\csname SET#1\endcsname\relax - {[No value for ``#1'']}% - \message{Variable `#1', used in @value, is not set.}% - \else - \csname SET#1\endcsname - \fi -} - -% @ifset VAR ... @end ifset reads the `...' iff VAR has been defined -% with @set. -% -% To get special treatment of `@end ifset,' call \makeond and the redefine. -% -\makecond{ifset} -\def\ifset{\parsearg{\doifset{\let\next=\ifsetfail}}} -\def\doifset#1#2{% - {% - \makevalueexpandable - \let\next=\empty - \expandafter\ifx\csname SET#2\endcsname\relax - #1% If not set, redefine \next. - \fi - \expandafter - }\next -} -\def\ifsetfail{\doignore{ifset}} - -% @ifclear VAR ... @end ifclear reads the `...' iff VAR has never been -% defined with @set, or has been undefined with @clear. -% -% The `\else' inside the `\doifset' parameter is a trick to reuse the -% above code: if the variable is not set, do nothing, if it is set, -% then redefine \next to \ifclearfail. -% -\makecond{ifclear} -\def\ifclear{\parsearg{\doifset{\else \let\next=\ifclearfail}}} -\def\ifclearfail{\doignore{ifclear}} - -% @dircategory CATEGORY -- specify a category of the dir file -% which this file should belong to. Ignore this in TeX. -\let\dircategory=\comment - -% @defininfoenclose. -\let\definfoenclose=\comment - - -\message{indexing,} -% Index generation facilities - -% Define \newwrite to be identical to plain tex's \newwrite -% except not \outer, so it can be used within macros and \if's. -\edef\newwrite{\makecsname{ptexnewwrite}} - -% \newindex {foo} defines an index named foo. -% It automatically defines \fooindex such that -% \fooindex ...rest of line... puts an entry in the index foo. -% It also defines \fooindfile to be the number of the output channel for -% the file that accumulates this index. The file's extension is foo. -% The name of an index should be no more than 2 characters long -% for the sake of vms. -% -\def\newindex#1{% - \iflinks - \expandafter\newwrite \csname#1indfile\endcsname - \openout \csname#1indfile\endcsname \jobname.#1 % Open the file - \fi - \expandafter\xdef\csname#1index\endcsname{% % Define @#1index - \noexpand\doindex{#1}} -} - -% @defindex foo == \newindex{foo} -% -\def\defindex{\parsearg\newindex} - -% Define @defcodeindex, like @defindex except put all entries in @code. -% -\def\defcodeindex{\parsearg\newcodeindex} -% -\def\newcodeindex#1{% - \iflinks - \expandafter\newwrite \csname#1indfile\endcsname - \openout \csname#1indfile\endcsname \jobname.#1 - \fi - \expandafter\xdef\csname#1index\endcsname{% - \noexpand\docodeindex{#1}}% -} - - -% @synindex foo bar makes index foo feed into index bar. -% Do this instead of @defindex foo if you don't want it as a separate index. -% -% @syncodeindex foo bar similar, but put all entries made for index foo -% inside @code. -% -\def\synindex#1 #2 {\dosynindex\doindex{#1}{#2}} -\def\syncodeindex#1 #2 {\dosynindex\docodeindex{#1}{#2}} - -% #1 is \doindex or \docodeindex, #2 the index getting redefined (foo), -% #3 the target index (bar). -\def\dosynindex#1#2#3{% - % Only do \closeout if we haven't already done it, else we'll end up - % closing the target index. - \expandafter \ifx\csname donesynindex#2\endcsname \undefined - % The \closeout helps reduce unnecessary open files; the limit on the - % Acorn RISC OS is a mere 16 files. - \expandafter\closeout\csname#2indfile\endcsname - \expandafter\let\csname\donesynindex#2\endcsname = 1 - \fi - % redefine \fooindfile: - \expandafter\let\expandafter\temp\expandafter=\csname#3indfile\endcsname - \expandafter\let\csname#2indfile\endcsname=\temp - % redefine \fooindex: - \expandafter\xdef\csname#2index\endcsname{\noexpand#1{#3}}% -} - -% Define \doindex, the driver for all \fooindex macros. -% Argument #1 is generated by the calling \fooindex macro, -% and it is "foo", the name of the index. - -% \doindex just uses \parsearg; it calls \doind for the actual work. -% This is because \doind is more useful to call from other macros. - -% There is also \dosubind {index}{topic}{subtopic} -% which makes an entry in a two-level index such as the operation index. - -\def\doindex#1{\edef\indexname{#1}\parsearg\singleindexer} -\def\singleindexer #1{\doind{\indexname}{#1}} - -% like the previous two, but they put @code around the argument. -\def\docodeindex#1{\edef\indexname{#1}\parsearg\singlecodeindexer} -\def\singlecodeindexer #1{\doind{\indexname}{\code{#1}}} - -% Take care of Texinfo commands that can appear in an index entry. -% Since there are some commands we want to expand, and others we don't, -% we have to laboriously prevent expansion for those that we don't. -% -\def\indexdummies{% - \escapechar = `\\ % use backslash in output files. - \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 - % - % I don't entirely understand this, but when an index entry is - % generated from a macro call, the \endinput which \scanmacro inserts - % causes processing to be prematurely terminated. This is, - % apparently, because \indexsorttmp is fully expanded, and \endinput - % is an expandable command. The redefinition below makes \endinput - % disappear altogether for that purpose -- although logging shows that - % processing continues to some further point. On the other hand, it - % seems \endinput does not hurt in the printed index arg, since that - % is still getting written without apparent harm. - % - % Sample source (mac-idx3.tex, reported by Graham Percival to - % help-texinfo, 22may06): - % @macro funindex {WORD} - % @findex xyz - % @end macro - % ... - % @funindex commtest - % - % The above is not enough to reproduce the bug, but it gives the flavor. - % - % Sample whatsit resulting: - % .@write3{\entry{xyz}{@folio }{@code {xyz@endinput }}} - % - % So: - \let\endinput = \empty - % - % Do the redefinitions. - \commondummies -} - -% For the aux and toc files, @ is the escape character. So we want to -% redefine everything using @ as the escape character (instead of -% \realbackslash, still used for index files). When everything uses @, -% this will be simpler. -% -\def\atdummies{% - \def\@{@@}% - \def\ {@ }% - \let\{ = \lbraceatcmd - \let\} = \rbraceatcmd - % - % Do the redefinitions. - \commondummies - \otherbackslash -} - -% Called from \indexdummies and \atdummies. -% -\def\commondummies{% - % - % \definedummyword defines \#1 as \string\#1\space, thus effectively - % preventing its expansion. This is used only for control% words, - % not control letters, because the \space would be incorrect for - % control characters, but is needed to separate the control word - % from whatever follows. - % - % For control letters, we have \definedummyletter, which omits the - % space. - % - % These can be used both for control words that take an argument and - % those that do not. If it is followed by {arg} in the input, then - % that will dutifully get written to the index (or wherever). - % - \def\definedummyword ##1{\def##1{\string##1\space}}% - \def\definedummyletter##1{\def##1{\string##1}}% - \let\definedummyaccent\definedummyletter - % - \commondummiesnofonts - % - \definedummyletter\_% - % - % Non-English letters. - \definedummyword\AA - \definedummyword\AE - \definedummyword\L - \definedummyword\OE - \definedummyword\O - \definedummyword\aa - \definedummyword\ae - \definedummyword\l - \definedummyword\oe - \definedummyword\o - \definedummyword\ss - \definedummyword\exclamdown - \definedummyword\questiondown - \definedummyword\ordf - \definedummyword\ordm - % - % Although these internal commands shouldn't show up, sometimes they do. - \definedummyword\bf - \definedummyword\gtr - \definedummyword\hat - \definedummyword\less - \definedummyword\sf - \definedummyword\sl - \definedummyword\tclose - \definedummyword\tt - % - \definedummyword\LaTeX - \definedummyword\TeX - % - % Assorted special characters. - \definedummyword\bullet - \definedummyword\comma - \definedummyword\copyright - \definedummyword\registeredsymbol - \definedummyword\dots - \definedummyword\enddots - \definedummyword\equiv - \definedummyword\error - \definedummyword\euro - \definedummyword\expansion - \definedummyword\minus - \definedummyword\pounds - \definedummyword\point - \definedummyword\print - \definedummyword\result - \definedummyword\textdegree - % - % We want to disable all macros so that they are not expanded by \write. - \macrolist - % - \normalturnoffactive - % - % Handle some cases of @value -- where it does not contain any - % (non-fully-expandable) commands. - \makevalueexpandable -} - -% \commondummiesnofonts: common to \commondummies and \indexnofonts. -% -\def\commondummiesnofonts{% - % Control letters and accents. - \definedummyletter\!% - \definedummyaccent\"% - \definedummyaccent\'% - \definedummyletter\*% - \definedummyaccent\,% - \definedummyletter\.% - \definedummyletter\/% - \definedummyletter\:% - \definedummyaccent\=% - \definedummyletter\?% - \definedummyaccent\^% - \definedummyaccent\`% - \definedummyaccent\~% - \definedummyword\u - \definedummyword\v - \definedummyword\H - \definedummyword\dotaccent - \definedummyword\ringaccent - \definedummyword\tieaccent - \definedummyword\ubaraccent - \definedummyword\udotaccent - \definedummyword\dotless - % - % Texinfo font commands. - \definedummyword\b - \definedummyword\i - \definedummyword\r - \definedummyword\sc - \definedummyword\t - % - % Commands that take arguments. - \definedummyword\acronym - \definedummyword\cite - \definedummyword\code - \definedummyword\command - \definedummyword\dfn - \definedummyword\emph - \definedummyword\env - \definedummyword\file - \definedummyword\kbd - \definedummyword\key - \definedummyword\math - \definedummyword\option - \definedummyword\pxref - \definedummyword\ref - \definedummyword\samp - \definedummyword\strong - \definedummyword\tie - \definedummyword\uref - \definedummyword\url - \definedummyword\var - \definedummyword\verb - \definedummyword\w - \definedummyword\xref -} - -% \indexnofonts is used when outputting the strings to sort the index -% by, and when constructing control sequence names. It eliminates all -% control sequences and just writes whatever the best ASCII sort string -% would be for a given command (usually its argument). -% -\def\indexnofonts{% - % Accent commands should become @asis. - \def\definedummyaccent##1{\let##1\asis}% - % We can just ignore other control letters. - \def\definedummyletter##1{\let##1\empty}% - % Hopefully, all control words can become @asis. - \let\definedummyword\definedummyaccent - % - \commondummiesnofonts - % - % Don't no-op \tt, since it isn't a user-level command - % and is used in the definitions of the active chars like <, >, |, etc. - % Likewise with the other plain tex font commands. - %\let\tt=\asis - % - \def\ { }% - \def\@{@}% - % how to handle braces? - \def\_{\normalunderscore}% - % - % Non-English letters. - \def\AA{AA}% - \def\AE{AE}% - \def\L{L}% - \def\OE{OE}% - \def\O{O}% - \def\aa{aa}% - \def\ae{ae}% - \def\l{l}% - \def\oe{oe}% - \def\o{o}% - \def\ss{ss}% - \def\exclamdown{!}% - \def\questiondown{?}% - \def\ordf{a}% - \def\ordm{o}% - % - \def\LaTeX{LaTeX}% - \def\TeX{TeX}% - % - % Assorted special characters. - % (The following {} will end up in the sort string, but that's ok.) - \def\bullet{bullet}% - \def\comma{,}% - \def\copyright{copyright}% - \def\registeredsymbol{R}% - \def\dots{...}% - \def\enddots{...}% - \def\equiv{==}% - \def\error{error}% - \def\euro{euro}% - \def\expansion{==>}% - \def\minus{-}% - \def\pounds{pounds}% - \def\point{.}% - \def\print{-|}% - \def\result{=>}% - \def\textdegree{degrees}% - % - % We need to get rid of all macros, leaving only the arguments (if present). - % Of course this is not nearly correct, but it is the best we can do for now. - % makeinfo does not expand macros in the argument to @deffn, which ends up - % writing an index entry, and texindex isn't prepared for an index sort entry - % that starts with \. - % - % Since macro invocations are followed by braces, we can just redefine them - % to take a single TeX argument. The case of a macro invocation that - % goes to end-of-line is not handled. - % - \macrolist -} - -\let\indexbackslash=0 %overridden during \printindex. -\let\SETmarginindex=\relax % put index entries in margin (undocumented)? - -% Most index entries go through here, but \dosubind is the general case. -% #1 is the index name, #2 is the entry text. -\def\doind#1#2{\dosubind{#1}{#2}{}} - -% Workhorse for all \fooindexes. -% #1 is name of index, #2 is stuff to put there, #3 is subentry -- -% empty if called from \doind, as we usually are (the main exception -% is with most defuns, which call us directly). -% -\def\dosubind#1#2#3{% - \iflinks - {% - % Store the main index entry text (including the third arg). - \toks0 = {#2}% - % If third arg is present, precede it with a space. - \def\thirdarg{#3}% - \ifx\thirdarg\empty \else - \toks0 = \expandafter{\the\toks0 \space #3}% - \fi - % - \edef\writeto{\csname#1indfile\endcsname}% - % - \ifvmode - \dosubindsanitize - \else - \dosubindwrite - \fi - }% - \fi -} - -% Write the entry in \toks0 to the index file: -% -\def\dosubindwrite{% - % Put the index entry in the margin if desired. - \ifx\SETmarginindex\relax\else - \insert\margin{\hbox{\vrule height8pt depth3pt width0pt \the\toks0}}% - \fi - % - % Remember, we are within a group. - \indexdummies % Must do this here, since \bf, etc expand at this stage - \def\backslashcurfont{\indexbackslash}% \indexbackslash isn't defined now - % so it will be output as is; and it will print as backslash. - % - % Process the index entry with all font commands turned off, to - % get the string to sort by. - {\indexnofonts - \edef\temp{\the\toks0}% need full expansion - \xdef\indexsorttmp{\temp}% - }% - % - % Set up the complete index entry, with both the sort key and - % the original text, including any font commands. We write - % three arguments to \entry to the .?? file (four in the - % subentry case), texindex reduces to two when writing the .??s - % sorted result. - \edef\temp{% - \write\writeto{% - \string\entry{\indexsorttmp}{\noexpand\folio}{\the\toks0}}% - }% - \temp -} - -% Take care of unwanted page breaks: -% -% If a skip is the last thing on the list now, preserve it -% by backing up by \lastskip, doing the \write, then inserting -% the skip again. Otherwise, the whatsit generated by the -% \write will make \lastskip zero. The result is that sequences -% like this: -% @end defun -% @tindex whatever -% @defun ... -% will have extra space inserted, because the \medbreak in the -% start of the @defun won't see the skip inserted by the @end of -% the previous defun. -% -% But don't do any of this if we're not in vertical mode. We -% don't want to do a \vskip and prematurely end a paragraph. -% -% Avoid page breaks due to these extra skips, too. -% -% But wait, there is a catch there: -% We'll have to check whether \lastskip is zero skip. \ifdim is not -% sufficient for this purpose, as it ignores stretch and shrink parts -% of the skip. The only way seems to be to check the textual -% representation of the skip. -% -% The following is almost like \def\zeroskipmacro{0.0pt} except that -% the ``p'' and ``t'' characters have catcode \other, not 11 (letter). -% -\edef\zeroskipmacro{\expandafter\the\csname z@skip\endcsname} -% -% ..., ready, GO: -% -\def\dosubindsanitize{% - % \lastskip and \lastpenalty cannot both be nonzero simultaneously. - \skip0 = \lastskip - \edef\lastskipmacro{\the\lastskip}% - \count255 = \lastpenalty - % - % If \lastskip is nonzero, that means the last item was a - % skip. And since a skip is discardable, that means this - % -\skip0 glue we're inserting is preceded by a - % non-discardable item, therefore it is not a potential - % breakpoint, therefore no \nobreak needed. - \ifx\lastskipmacro\zeroskipmacro - \else - \vskip-\skip0 - \fi - % - \dosubindwrite - % - \ifx\lastskipmacro\zeroskipmacro - % If \lastskip was zero, perhaps the last item was a penalty, and - % perhaps it was >=10000, e.g., a \nobreak. In that case, we want - % to re-insert the same penalty (values >10000 are used for various - % signals); since we just inserted a non-discardable item, any - % following glue (such as a \parskip) would be a breakpoint. For example: - % - % @deffn deffn-whatever - % @vindex index-whatever - % Description. - % would allow a break between the index-whatever whatsit - % and the "Description." paragraph. - \ifnum\count255>9999 \penalty\count255 \fi - \else - % On the other hand, if we had a nonzero \lastskip, - % this make-up glue would be preceded by a non-discardable item - % (the whatsit from the \write), so we must insert a \nobreak. - \nobreak\vskip\skip0 - \fi -} - -% The index entry written in the file actually looks like -% \entry {sortstring}{page}{topic} -% or -% \entry {sortstring}{page}{topic}{subtopic} -% The texindex program reads in these files and writes files -% containing these kinds of lines: -% \initial {c} -% before the first topic whose initial is c -% \entry {topic}{pagelist} -% for a topic that is used without subtopics -% \primary {topic} -% for the beginning of a topic that is used with subtopics -% \secondary {subtopic}{pagelist} -% for each subtopic. - -% Define the user-accessible indexing commands -% @findex, @vindex, @kindex, @cindex. - -\def\findex {\fnindex} -\def\kindex {\kyindex} -\def\cindex {\cpindex} -\def\vindex {\vrindex} -\def\tindex {\tpindex} -\def\pindex {\pgindex} - -\def\cindexsub {\begingroup\obeylines\cindexsub} -{\obeylines % -\gdef\cindexsub "#1" #2^^M{\endgroup % -\dosubind{cp}{#2}{#1}}} - -% Define the macros used in formatting output of the sorted index material. - -% @printindex causes a particular index (the ??s file) to get printed. -% It does not print any chapter heading (usually an @unnumbered). -% -\parseargdef\printindex{\begingroup - \dobreak \chapheadingskip{10000}% - % - \smallfonts \rm - \tolerance = 9500 - \everypar = {}% don't want the \kern\-parindent from indentation suppression. - % - % See if the index file exists and is nonempty. - % Change catcode of @ here so that if the index file contains - % \initial {@} - % as its first line, TeX doesn't complain about mismatched braces - % (because it thinks @} is a control sequence). - \catcode`\@ = 11 - \openin 1 \jobname.#1s - \ifeof 1 - % \enddoublecolumns gets confused if there is no text in the index, - % and it loses the chapter title and the aux file entries for the - % index. The easiest way to prevent this problem is to make sure - % there is some text. - \putwordIndexNonexistent - \else - % - % If the index file exists but is empty, then \openin leaves \ifeof - % false. We have to make TeX try to read something from the file, so - % it can discover if there is anything in it. - \read 1 to \temp - \ifeof 1 - \putwordIndexIsEmpty - \else - % Index files are almost Texinfo source, but we use \ as the escape - % character. It would be better to use @, but that's too big a change - % to make right now. - \def\indexbackslash{\backslashcurfont}% - \catcode`\\ = 0 - \escapechar = `\\ - \begindoublecolumns - \input \jobname.#1s - \enddoublecolumns - \fi - \fi - \closein 1 -\endgroup} - -% These macros are used by the sorted index file itself. -% Change them to control the appearance of the index. - -\def\initial#1{{% - % Some minor font changes for the special characters. - \let\tentt=\sectt \let\tt=\sectt \let\sf=\sectt - % - % Remove any glue we may have, we'll be inserting our own. - \removelastskip - % - % We like breaks before the index initials, so insert a bonus. - \nobreak - \vskip 0pt plus 3\baselineskip - \penalty 0 - \vskip 0pt plus -3\baselineskip - % - % Typeset the initial. Making this add up to a whole number of - % baselineskips increases the chance of the dots lining up from column - % to column. It still won't often be perfect, because of the stretch - % we need before each entry, but it's better. - % - % No shrink because it confuses \balancecolumns. - \vskip 1.67\baselineskip plus .5\baselineskip - \leftline{\secbf #1}% - % Do our best not to break after the initial. - \nobreak - \vskip .33\baselineskip plus .1\baselineskip -}} - -% \entry typesets a paragraph consisting of the text (#1), dot leaders, and -% then page number (#2) flushed to the right margin. It is used for index -% and table of contents entries. The paragraph is indented by \leftskip. -% -% A straightforward implementation would start like this: -% \def\entry#1#2{... -% But this frozes the catcodes in the argument, and can cause problems to -% @code, which sets - active. This problem was fixed by a kludge--- -% ``-'' was active throughout whole index, but this isn't really right. -% -% The right solution is to prevent \entry from swallowing the whole text. -% --kasal, 21nov03 -\def\entry{% - \begingroup - % - % Start a new paragraph if necessary, so our assignments below can't - % affect previous text. - \par - % - % Do not fill out the last line with white space. - \parfillskip = 0in - % - % No extra space above this paragraph. - \parskip = 0in - % - % Do not prefer a separate line ending with a hyphen to fewer lines. - \finalhyphendemerits = 0 - % - % \hangindent is only relevant when the entry text and page number - % don't both fit on one line. In that case, bob suggests starting the - % dots pretty far over on the line. Unfortunately, a large - % indentation looks wrong when the entry text itself is broken across - % lines. So we use a small indentation and put up with long leaders. - % - % \hangafter is reset to 1 (which is the value we want) at the start - % of each paragraph, so we need not do anything with that. - \hangindent = 2em - % - % When the entry text needs to be broken, just fill out the first line - % with blank space. - \rightskip = 0pt plus1fil - % - % A bit of stretch before each entry for the benefit of balancing - % columns. - \vskip 0pt plus1pt - % - % Swallow the left brace of the text (first parameter): - \afterassignment\doentry - \let\temp = -} -\def\doentry{% - \bgroup % Instead of the swallowed brace. - \noindent - \aftergroup\finishentry - % And now comes the text of the entry. -} -\def\finishentry#1{% - % #1 is the page number. - % - % The following is kludged to not output a line of dots in the index if - % there are no page numbers. The next person who breaks this will be - % cursed by a Unix daemon. - \def\tempa{{\rm }}% - \def\tempb{#1}% - \edef\tempc{\tempa}% - \edef\tempd{\tempb}% - \ifx\tempc\tempd - \ % - \else - % - % If we must, put the page number on a line of its own, and fill out - % this line with blank space. (The \hfil is overwhelmed with the - % fill leaders glue in \indexdotfill if the page number does fit.) - \hfil\penalty50 - \null\nobreak\indexdotfill % Have leaders before the page number. - % - % The `\ ' here is removed by the implicit \unskip that TeX does as - % part of (the primitive) \par. Without it, a spurious underfull - % \hbox ensues. - \ifpdf - \pdfgettoks#1.% - \ \the\toksA - \else - \ #1% - \fi - \fi - \par - \endgroup -} - -% Like plain.tex's \dotfill, except uses up at least 1 em. -\def\indexdotfill{\cleaders - \hbox{$\mathsurround=0pt \mkern1.5mu.\mkern1.5mu$}\hskip 1em plus 1fill} - -\def\primary #1{\line{#1\hfil}} - -\newskip\secondaryindent \secondaryindent=0.5cm -\def\secondary#1#2{{% - \parfillskip=0in - \parskip=0in - \hangindent=1in - \hangafter=1 - \noindent\hskip\secondaryindent\hbox{#1}\indexdotfill - \ifpdf - \pdfgettoks#2.\ \the\toksA % The page number ends the paragraph. - \else - #2 - \fi - \par -}} - -% Define two-column mode, which we use to typeset indexes. -% Adapted from the TeXbook, page 416, which is to say, -% the manmac.tex format used to print the TeXbook itself. -\catcode`\@=11 - -\newbox\partialpage -\newdimen\doublecolumnhsize - -\def\begindoublecolumns{\begingroup % ended by \enddoublecolumns - % Grab any single-column material above us. - \output = {% - % - % Here is a possibility not foreseen in manmac: if we accumulate a - % whole lot of material, we might end up calling this \output - % routine twice in a row (see the doublecol-lose test, which is - % essentially a couple of indexes with @setchapternewpage off). In - % that case we just ship out what is in \partialpage with the normal - % output routine. Generally, \partialpage will be empty when this - % runs and this will be a no-op. See the indexspread.tex test case. - \ifvoid\partialpage \else - \onepageout{\pagecontents\partialpage}% - \fi - % - \global\setbox\partialpage = \vbox{% - % Unvbox the main output page. - \unvbox\PAGE - \kern-\topskip \kern\baselineskip - }% - }% - \eject % run that output routine to set \partialpage - % - % Use the double-column output routine for subsequent pages. - \output = {\doublecolumnout}% - % - % Change the page size parameters. We could do this once outside this - % routine, in each of @smallbook, @afourpaper, and the default 8.5x11 - % format, but then we repeat the same computation. Repeating a couple - % of assignments once per index is clearly meaningless for the - % execution time, so we may as well do it in one place. - % - % First we halve the line length, less a little for the gutter between - % the columns. We compute the gutter based on the line length, so it - % changes automatically with the paper format. The magic constant - % below is chosen so that the gutter has the same value (well, +-<1pt) - % as it did when we hard-coded it. - % - % We put the result in a separate register, \doublecolumhsize, so we - % can restore it in \pagesofar, after \hsize itself has (potentially) - % been clobbered. - % - \doublecolumnhsize = \hsize - \advance\doublecolumnhsize by -.04154\hsize - \divide\doublecolumnhsize by 2 - \hsize = \doublecolumnhsize - % - % Double the \vsize as well. (We don't need a separate register here, - % since nobody clobbers \vsize.) - \vsize = 2\vsize -} - -% The double-column output routine for all double-column pages except -% the last. -% -\def\doublecolumnout{% - \splittopskip=\topskip \splitmaxdepth=\maxdepth - % Get the available space for the double columns -- the normal - % (undoubled) page height minus any material left over from the - % previous page. - \dimen@ = \vsize - \divide\dimen@ by 2 - \advance\dimen@ by -\ht\partialpage - % - % box0 will be the left-hand column, box2 the right. - \setbox0=\vsplit255 to\dimen@ \setbox2=\vsplit255 to\dimen@ - \onepageout\pagesofar - \unvbox255 - \penalty\outputpenalty -} -% -% Re-output the contents of the output page -- any previous material, -% followed by the two boxes we just split, in box0 and box2. -\def\pagesofar{% - \unvbox\partialpage - % - \hsize = \doublecolumnhsize - \wd0=\hsize \wd2=\hsize - \hbox to\pagewidth{\box0\hfil\box2}% -} -% -% All done with double columns. -\def\enddoublecolumns{% - \output = {% - % Split the last of the double-column material. Leave it on the - % current page, no automatic page break. - \balancecolumns - % - % If we end up splitting too much material for the current page, - % though, there will be another page break right after this \output - % invocation ends. Having called \balancecolumns once, we do not - % want to call it again. Therefore, reset \output to its normal - % definition right away. (We hope \balancecolumns will never be - % called on to balance too much material, but if it is, this makes - % the output somewhat more palatable.) - \global\output = {\onepageout{\pagecontents\PAGE}}% - }% - \eject - \endgroup % started in \begindoublecolumns - % - % \pagegoal was set to the doubled \vsize above, since we restarted - % the current page. We're now back to normal single-column - % typesetting, so reset \pagegoal to the normal \vsize (after the - % \endgroup where \vsize got restored). - \pagegoal = \vsize -} -% -% Called at the end of the double column material. -\def\balancecolumns{% - \setbox0 = \vbox{\unvbox255}% like \box255 but more efficient, see p.120. - \dimen@ = \ht0 - \advance\dimen@ by \topskip - \advance\dimen@ by-\baselineskip - \divide\dimen@ by 2 % target to split to - %debug\message{final 2-column material height=\the\ht0, target=\the\dimen@.}% - \splittopskip = \topskip - % Loop until we get a decent breakpoint. - {% - \vbadness = 10000 - \loop - \global\setbox3 = \copy0 - \global\setbox1 = \vsplit3 to \dimen@ - \ifdim\ht3>\dimen@ - \global\advance\dimen@ by 1pt - \repeat - }% - %debug\message{split to \the\dimen@, column heights: \the\ht1, \the\ht3.}% - \setbox0=\vbox to\dimen@{\unvbox1}% - \setbox2=\vbox to\dimen@{\unvbox3}% - % - \pagesofar -} -\catcode`\@ = \other - - -\message{sectioning,} -% Chapters, sections, etc. - -% \unnumberedno is an oxymoron, of course. But we count the unnumbered -% sections so that we can refer to them unambiguously in the pdf -% outlines by their "section number". We avoid collisions with chapter -% numbers by starting them at 10000. (If a document ever has 10000 -% chapters, we're in trouble anyway, I'm sure.) -\newcount\unnumberedno \unnumberedno = 10000 -\newcount\chapno -\newcount\secno \secno=0 -\newcount\subsecno \subsecno=0 -\newcount\subsubsecno \subsubsecno=0 - -% This counter is funny since it counts through charcodes of letters A, B, ... -\newcount\appendixno \appendixno = `\@ -% -% \def\appendixletter{\char\the\appendixno} -% We do the following ugly conditional instead of the above simple -% construct for the sake of pdftex, which needs the actual -% letter in the expansion, not just typeset. -% -\def\appendixletter{% - \ifnum\appendixno=`A A% - \else\ifnum\appendixno=`B B% - \else\ifnum\appendixno=`C C% - \else\ifnum\appendixno=`D D% - \else\ifnum\appendixno=`E E% - \else\ifnum\appendixno=`F F% - \else\ifnum\appendixno=`G G% - \else\ifnum\appendixno=`H H% - \else\ifnum\appendixno=`I I% - \else\ifnum\appendixno=`J J% - \else\ifnum\appendixno=`K K% - \else\ifnum\appendixno=`L L% - \else\ifnum\appendixno=`M M% - \else\ifnum\appendixno=`N N% - \else\ifnum\appendixno=`O O% - \else\ifnum\appendixno=`P P% - \else\ifnum\appendixno=`Q Q% - \else\ifnum\appendixno=`R R% - \else\ifnum\appendixno=`S S% - \else\ifnum\appendixno=`T T% - \else\ifnum\appendixno=`U U% - \else\ifnum\appendixno=`V V% - \else\ifnum\appendixno=`W W% - \else\ifnum\appendixno=`X X% - \else\ifnum\appendixno=`Y Y% - \else\ifnum\appendixno=`Z Z% - % The \the is necessary, despite appearances, because \appendixletter is - % expanded while writing the .toc file. \char\appendixno is not - % expandable, thus it is written literally, thus all appendixes come out - % with the same letter (or @) in the toc without it. - \else\char\the\appendixno - \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi - \fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi\fi} - -% Each @chapter defines this as the name of the chapter. -% page headings and footings can use it. @section does likewise. -% However, they are not reliable, because we don't use marks. -\def\thischapter{} -\def\thissection{} - -\newcount\absseclevel % used to calculate proper heading level -\newcount\secbase\secbase=0 % @raisesections/@lowersections modify this count - -% @raisesections: treat @section as chapter, @subsection as section, etc. -\def\raisesections{\global\advance\secbase by -1} -\let\up=\raisesections % original BFox name - -% @lowersections: treat @chapter as section, @section as subsection, etc. -\def\lowersections{\global\advance\secbase by 1} -\let\down=\lowersections % original BFox name - -% we only have subsub. -\chardef\maxseclevel = 3 -% -% A numbered section within an unnumbered changes to unnumbered too. -% To achive this, remember the "biggest" unnum. sec. we are currently in: -\chardef\unmlevel = \maxseclevel -% -% Trace whether the current chapter is an appendix or not: -% \chapheadtype is "N" or "A", unnumbered chapters are ignored. -\def\chapheadtype{N} - -% Choose a heading macro -% #1 is heading type -% #2 is heading level -% #3 is text for heading -\def\genhead#1#2#3{% - % Compute the abs. sec. level: - \absseclevel=#2 - \advance\absseclevel by \secbase - % Make sure \absseclevel doesn't fall outside the range: - \ifnum \absseclevel < 0 - \absseclevel = 0 - \else - \ifnum \absseclevel > 3 - \absseclevel = 3 - \fi - \fi - % The heading type: - \def\headtype{#1}% - \if \headtype U% - \ifnum \absseclevel < \unmlevel - \chardef\unmlevel = \absseclevel - \fi - \else - % Check for appendix sections: - \ifnum \absseclevel = 0 - \edef\chapheadtype{\headtype}% - \else - \if \headtype A\if \chapheadtype N% - \errmessage{@appendix... within a non-appendix chapter}% - \fi\fi - \fi - % Check for numbered within unnumbered: - \ifnum \absseclevel > \unmlevel - \def\headtype{U}% - \else - \chardef\unmlevel = 3 - \fi - \fi - % Now print the heading: - \if \headtype U% - \ifcase\absseclevel - \unnumberedzzz{#3}% - \or \unnumberedseczzz{#3}% - \or \unnumberedsubseczzz{#3}% - \or \unnumberedsubsubseczzz{#3}% - \fi - \else - \if \headtype A% - \ifcase\absseclevel - \appendixzzz{#3}% - \or \appendixsectionzzz{#3}% - \or \appendixsubseczzz{#3}% - \or \appendixsubsubseczzz{#3}% - \fi - \else - \ifcase\absseclevel - \chapterzzz{#3}% - \or \seczzz{#3}% - \or \numberedsubseczzz{#3}% - \or \numberedsubsubseczzz{#3}% - \fi - \fi - \fi - \suppressfirstparagraphindent -} - -% an interface: -\def\numhead{\genhead N} -\def\apphead{\genhead A} -\def\unnmhead{\genhead U} - -% @chapter, @appendix, @unnumbered. Increment top-level counter, reset -% all lower-level sectioning counters to zero. -% -% Also set \chaplevelprefix, which we prepend to @float sequence numbers -% (e.g., figures), q.v. By default (before any chapter), that is empty. -\let\chaplevelprefix = \empty -% -\outer\parseargdef\chapter{\numhead0{#1}} % normally numhead0 calls chapterzzz -\def\chapterzzz#1{% - % section resetting is \global in case the chapter is in a group, such - % as an @include file. - \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 - \global\advance\chapno by 1 - % - % Used for \float. - \gdef\chaplevelprefix{\the\chapno.}% - \resetallfloatnos - % - \message{\putwordChapter\space \the\chapno}% - % - % Write the actual heading. - \chapmacro{#1}{Ynumbered}{\the\chapno}% - % - % So @section and the like are numbered underneath this chapter. - \global\let\section = \numberedsec - \global\let\subsection = \numberedsubsec - \global\let\subsubsection = \numberedsubsubsec -} - -\outer\parseargdef\appendix{\apphead0{#1}} % normally apphead0 calls appendixzzz -\def\appendixzzz#1{% - \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 - \global\advance\appendixno by 1 - \gdef\chaplevelprefix{\appendixletter.}% - \resetallfloatnos - % - \def\appendixnum{\putwordAppendix\space \appendixletter}% - \message{\appendixnum}% - % - \chapmacro{#1}{Yappendix}{\appendixletter}% - % - \global\let\section = \appendixsec - \global\let\subsection = \appendixsubsec - \global\let\subsubsection = \appendixsubsubsec -} - -\outer\parseargdef\unnumbered{\unnmhead0{#1}} % normally unnmhead0 calls unnumberedzzz -\def\unnumberedzzz#1{% - \global\secno=0 \global\subsecno=0 \global\subsubsecno=0 - \global\advance\unnumberedno by 1 - % - % Since an unnumbered has no number, no prefix for figures. - \global\let\chaplevelprefix = \empty - \resetallfloatnos - % - % This used to be simply \message{#1}, but TeX fully expands the - % argument to \message. Therefore, if #1 contained @-commands, TeX - % expanded them. For example, in `@unnumbered The @cite{Book}', TeX - % expanded @cite (which turns out to cause errors because \cite is meant - % to be executed, not expanded). - % - % Anyway, we don't want the fully-expanded definition of @cite to appear - % as a result of the \message, we just want `@cite' itself. We use - % \the to achieve this: TeX expands \the only once, - % simply yielding the contents of . (We also do this for - % the toc entries.) - \toks0 = {#1}% - \message{(\the\toks0)}% - % - \chapmacro{#1}{Ynothing}{\the\unnumberedno}% - % - \global\let\section = \unnumberedsec - \global\let\subsection = \unnumberedsubsec - \global\let\subsubsection = \unnumberedsubsubsec -} - -% @centerchap is like @unnumbered, but the heading is centered. -\outer\parseargdef\centerchap{% - % Well, we could do the following in a group, but that would break - % an assumption that \chapmacro is called at the outermost level. - % Thus we are safer this way: --kasal, 24feb04 - \let\centerparametersmaybe = \centerparameters - \unnmhead0{#1}% - \let\centerparametersmaybe = \relax -} - -% @top is like @unnumbered. -\let\top\unnumbered - -% Sections. -\outer\parseargdef\numberedsec{\numhead1{#1}} % normally calls seczzz -\def\seczzz#1{% - \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 - \sectionheading{#1}{sec}{Ynumbered}{\the\chapno.\the\secno}% -} - -\outer\parseargdef\appendixsection{\apphead1{#1}} % normally calls appendixsectionzzz -\def\appendixsectionzzz#1{% - \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 - \sectionheading{#1}{sec}{Yappendix}{\appendixletter.\the\secno}% -} -\let\appendixsec\appendixsection - -\outer\parseargdef\unnumberedsec{\unnmhead1{#1}} % normally calls unnumberedseczzz -\def\unnumberedseczzz#1{% - \global\subsecno=0 \global\subsubsecno=0 \global\advance\secno by 1 - \sectionheading{#1}{sec}{Ynothing}{\the\unnumberedno.\the\secno}% -} - -% Subsections. -\outer\parseargdef\numberedsubsec{\numhead2{#1}} % normally calls numberedsubseczzz -\def\numberedsubseczzz#1{% - \global\subsubsecno=0 \global\advance\subsecno by 1 - \sectionheading{#1}{subsec}{Ynumbered}{\the\chapno.\the\secno.\the\subsecno}% -} - -\outer\parseargdef\appendixsubsec{\apphead2{#1}} % normally calls appendixsubseczzz -\def\appendixsubseczzz#1{% - \global\subsubsecno=0 \global\advance\subsecno by 1 - \sectionheading{#1}{subsec}{Yappendix}% - {\appendixletter.\the\secno.\the\subsecno}% -} - -\outer\parseargdef\unnumberedsubsec{\unnmhead2{#1}} %normally calls unnumberedsubseczzz -\def\unnumberedsubseczzz#1{% - \global\subsubsecno=0 \global\advance\subsecno by 1 - \sectionheading{#1}{subsec}{Ynothing}% - {\the\unnumberedno.\the\secno.\the\subsecno}% -} - -% Subsubsections. -\outer\parseargdef\numberedsubsubsec{\numhead3{#1}} % normally numberedsubsubseczzz -\def\numberedsubsubseczzz#1{% - \global\advance\subsubsecno by 1 - \sectionheading{#1}{subsubsec}{Ynumbered}% - {\the\chapno.\the\secno.\the\subsecno.\the\subsubsecno}% -} - -\outer\parseargdef\appendixsubsubsec{\apphead3{#1}} % normally appendixsubsubseczzz -\def\appendixsubsubseczzz#1{% - \global\advance\subsubsecno by 1 - \sectionheading{#1}{subsubsec}{Yappendix}% - {\appendixletter.\the\secno.\the\subsecno.\the\subsubsecno}% -} - -\outer\parseargdef\unnumberedsubsubsec{\unnmhead3{#1}} %normally unnumberedsubsubseczzz -\def\unnumberedsubsubseczzz#1{% - \global\advance\subsubsecno by 1 - \sectionheading{#1}{subsubsec}{Ynothing}% - {\the\unnumberedno.\the\secno.\the\subsecno.\the\subsubsecno}% -} - -% These macros control what the section commands do, according -% to what kind of chapter we are in (ordinary, appendix, or unnumbered). -% Define them by default for a numbered chapter. -\let\section = \numberedsec -\let\subsection = \numberedsubsec -\let\subsubsection = \numberedsubsubsec - -% Define @majorheading, @heading and @subheading - -% NOTE on use of \vbox for chapter headings, section headings, and such: -% 1) We use \vbox rather than the earlier \line to permit -% overlong headings to fold. -% 2) \hyphenpenalty is set to 10000 because hyphenation in a -% heading is obnoxious; this forbids it. -% 3) Likewise, headings look best if no \parindent is used, and -% if justification is not attempted. Hence \raggedright. - - -\def\majorheading{% - {\advance\chapheadingskip by 10pt \chapbreak }% - \parsearg\chapheadingzzz -} - -\def\chapheading{\chapbreak \parsearg\chapheadingzzz} -\def\chapheadingzzz#1{% - {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt\raggedright - \rm #1\hfill}}% - \bigskip \par\penalty 200\relax - \suppressfirstparagraphindent -} - -% @heading, @subheading, @subsubheading. -\parseargdef\heading{\sectionheading{#1}{sec}{Yomitfromtoc}{} - \suppressfirstparagraphindent} -\parseargdef\subheading{\sectionheading{#1}{subsec}{Yomitfromtoc}{} - \suppressfirstparagraphindent} -\parseargdef\subsubheading{\sectionheading{#1}{subsubsec}{Yomitfromtoc}{} - \suppressfirstparagraphindent} - -% These macros generate a chapter, section, etc. heading only -% (including whitespace, linebreaking, etc. around it), -% given all the information in convenient, parsed form. - -%%% Args are the skip and penalty (usually negative) -\def\dobreak#1#2{\par\ifdim\lastskip<#1\removelastskip\penalty#2\vskip#1\fi} - -%%% Define plain chapter starts, and page on/off switching for it -% Parameter controlling skip before chapter headings (if needed) - -\newskip\chapheadingskip - -\def\chapbreak{\dobreak \chapheadingskip {-4000}} -\def\chappager{\par\vfill\supereject} -\def\chapoddpage{\chappager \ifodd\pageno \else \hbox to 0pt{} \chappager\fi} - -\def\setchapternewpage #1 {\csname CHAPPAG#1\endcsname} - -\def\CHAPPAGoff{% -\global\let\contentsalignmacro = \chappager -\global\let\pchapsepmacro=\chapbreak -\global\let\pagealignmacro=\chappager} - -\def\CHAPPAGon{% -\global\let\contentsalignmacro = \chappager -\global\let\pchapsepmacro=\chappager -\global\let\pagealignmacro=\chappager -\global\def\HEADINGSon{\HEADINGSsingle}} - -\def\CHAPPAGodd{% -\global\let\contentsalignmacro = \chapoddpage -\global\let\pchapsepmacro=\chapoddpage -\global\let\pagealignmacro=\chapoddpage -\global\def\HEADINGSon{\HEADINGSdouble}} - -\CHAPPAGon - -% Chapter opening. -% -% #1 is the text, #2 is the section type (Ynumbered, Ynothing, -% Yappendix, Yomitfromtoc), #3 the chapter number. -% -% To test against our argument. -\def\Ynothingkeyword{Ynothing} -\def\Yomitfromtockeyword{Yomitfromtoc} -\def\Yappendixkeyword{Yappendix} -% -\def\chapmacro#1#2#3{% - \pchapsepmacro - {% - \chapfonts \rm - % - % Have to define \thissection before calling \donoderef, because the - % xref code eventually uses it. On the other hand, it has to be called - % after \pchapsepmacro, or the headline will change too soon. - \gdef\thissection{#1}% - \gdef\thischaptername{#1}% - % - % Only insert the separating space if we have a chapter/appendix - % number, and don't print the unnumbered ``number''. - \def\temptype{#2}% - \ifx\temptype\Ynothingkeyword - \setbox0 = \hbox{}% - \def\toctype{unnchap}% - \gdef\thischapternum{}% - \gdef\thischapter{#1}% - \else\ifx\temptype\Yomitfromtockeyword - \setbox0 = \hbox{}% contents like unnumbered, but no toc entry - \def\toctype{omit}% - \gdef\thischapternum{}% - \gdef\thischapter{}% - \else\ifx\temptype\Yappendixkeyword - \setbox0 = \hbox{\putwordAppendix{} #3\enspace}% - \def\toctype{app}% - \xdef\thischapternum{\appendixletter}% - % We don't substitute the actual chapter name into \thischapter - % because we don't want its macros evaluated now. And we don't - % use \thissection because that changes with each section. - % - \xdef\thischapter{\putwordAppendix{} \appendixletter: - \noexpand\thischaptername}% - \else - \setbox0 = \hbox{#3\enspace}% - \def\toctype{numchap}% - \xdef\thischapternum{\the\chapno}% - \xdef\thischapter{\putwordChapter{} \the\chapno: - \noexpand\thischaptername}% - \fi\fi\fi - % - % Write the toc entry for this chapter. Must come before the - % \donoderef, because we include the current node name in the toc - % entry, and \donoderef resets it to empty. - \writetocentry{\toctype}{#1}{#3}% - % - % For pdftex, we have to write out the node definition (aka, make - % the pdfdest) after any page break, but before the actual text has - % been typeset. If the destination for the pdf outline is after the - % text, then jumping from the outline may wind up with the text not - % being visible, for instance under high magnification. - \donoderef{#2}% - % - % Typeset the actual heading. - \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright - \hangindent=\wd0 \centerparametersmaybe - \unhbox0 #1\par}% - }% - \nobreak\bigskip % no page break after a chapter title - \nobreak -} - -% @centerchap -- centered and unnumbered. -\let\centerparametersmaybe = \relax -\def\centerparameters{% - \advance\rightskip by 3\rightskip - \leftskip = \rightskip - \parfillskip = 0pt -} - - -% I don't think this chapter style is supported any more, so I'm not -% updating it with the new noderef stuff. We'll see. --karl, 11aug03. -% -\def\setchapterstyle #1 {\csname CHAPF#1\endcsname} -% -\def\unnchfopen #1{% -\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt\raggedright - \rm #1\hfill}}\bigskip \par\nobreak -} -\def\chfopen #1#2{\chapoddpage {\chapfonts -\vbox to 3in{\vfil \hbox to\hsize{\hfil #2} \hbox to\hsize{\hfil #1} \vfil}}% -\par\penalty 5000 % -} -\def\centerchfopen #1{% -\chapoddpage {\chapfonts \vbox{\hyphenpenalty=10000\tolerance=5000 - \parindent=0pt - \hfill {\rm #1}\hfill}}\bigskip \par\nobreak -} -\def\CHAPFopen{% - \global\let\chapmacro=\chfopen - \global\let\centerchapmacro=\centerchfopen} - - -% Section titles. These macros combine the section number parts and -% call the generic \sectionheading to do the printing. -% -\newskip\secheadingskip -\def\secheadingbreak{\dobreak \secheadingskip{-1000}} - -% Subsection titles. -\newskip\subsecheadingskip -\def\subsecheadingbreak{\dobreak \subsecheadingskip{-500}} - -% Subsubsection titles. -\def\subsubsecheadingskip{\subsecheadingskip} -\def\subsubsecheadingbreak{\subsecheadingbreak} - - -% Print any size, any type, section title. -% -% #1 is the text, #2 is the section level (sec/subsec/subsubsec), #3 is -% the section type for xrefs (Ynumbered, Ynothing, Yappendix), #4 is the -% section number. -% -\def\sectionheading#1#2#3#4{% - {% - % Switch to the right set of fonts. - \csname #2fonts\endcsname \rm - % - % Insert space above the heading. - \csname #2headingbreak\endcsname - % - % Only insert the space after the number if we have a section number. - \def\sectionlevel{#2}% - \def\temptype{#3}% - % - \ifx\temptype\Ynothingkeyword - \setbox0 = \hbox{}% - \def\toctype{unn}% - \gdef\thissection{#1}% - \else\ifx\temptype\Yomitfromtockeyword - % for @headings -- no section number, don't include in toc, - % and don't redefine \thissection. - \setbox0 = \hbox{}% - \def\toctype{omit}% - \let\sectionlevel=\empty - \else\ifx\temptype\Yappendixkeyword - \setbox0 = \hbox{#4\enspace}% - \def\toctype{app}% - \gdef\thissection{#1}% - \else - \setbox0 = \hbox{#4\enspace}% - \def\toctype{num}% - \gdef\thissection{#1}% - \fi\fi\fi - % - % Write the toc entry (before \donoderef). See comments in \chapmacro. - \writetocentry{\toctype\sectionlevel}{#1}{#4}% - % - % Write the node reference (= pdf destination for pdftex). - % Again, see comments in \chapmacro. - \donoderef{#3}% - % - % Interline glue will be inserted when the vbox is completed. - % That glue will be a valid breakpoint for the page, since it'll be - % preceded by a whatsit (usually from the \donoderef, or from the - % \writetocentry if there was no node). We don't want to allow that - % break, since then the whatsits could end up on page n while the - % section is on page n+1, thus toc/etc. are wrong. Debian bug 276000. - \nobreak - % - % Output the actual section heading. - \vbox{\hyphenpenalty=10000 \tolerance=5000 \parindent=0pt \raggedright - \hangindent=\wd0 % zero if no section number - \unhbox0 #1}% - }% - % Add extra space after the heading -- half of whatever came above it. - % Don't allow stretch, though. - \kern .5 \csname #2headingskip\endcsname - % - % Do not let the kern be a potential breakpoint, as it would be if it - % was followed by glue. - \nobreak - % - % We'll almost certainly start a paragraph next, so don't let that - % glue accumulate. (Not a breakpoint because it's preceded by a - % discardable item.) - \vskip-\parskip - % - % This is purely so the last item on the list is a known \penalty > - % 10000. This is so \startdefun can avoid allowing breakpoints after - % section headings. Otherwise, it would insert a valid breakpoint between: - % - % @section sec-whatever - % @deffn def-whatever - \penalty 10001 -} - - -\message{toc,} -% Table of contents. -\newwrite\tocfile - -% Write an entry to the toc file, opening it if necessary. -% Called from @chapter, etc. -% -% Example usage: \writetocentry{sec}{Section Name}{\the\chapno.\the\secno} -% We append the current node name (if any) and page number as additional -% arguments for the \{chap,sec,...}entry macros which will eventually -% read this. The node name is used in the pdf outlines as the -% destination to jump to. -% -% We open the .toc file for writing here instead of at @setfilename (or -% any other fixed time) so that @contents can be anywhere in the document. -% But if #1 is `omit', then we don't do anything. This is used for the -% table of contents chapter openings themselves. -% -\newif\iftocfileopened -\def\omitkeyword{omit}% -% -\def\writetocentry#1#2#3{% - \edef\writetoctype{#1}% - \ifx\writetoctype\omitkeyword \else - \iftocfileopened\else - \immediate\openout\tocfile = \jobname.toc - \global\tocfileopenedtrue - \fi - % - \iflinks - {\atdummies - \edef\temp{% - \write\tocfile{@#1entry{#2}{#3}{\lastnode}{\noexpand\folio}}}% - \temp - }% - \fi - \fi - % - % Tell \shipout to create a pdf destination on each page, if we're - % writing pdf. These are used in the table of contents. We can't - % just write one on every page because the title pages are numbered - % 1 and 2 (the page numbers aren't printed), and so are the first - % two pages of the document. Thus, we'd have two destinations named - % `1', and two named `2'. - \ifpdf \global\pdfmakepagedesttrue \fi -} - - -% These characters do not print properly in the Computer Modern roman -% fonts, so we must take special care. This is more or less redundant -% with the Texinfo input format setup at the end of this file. -% -\def\activecatcodes{% - \catcode`\"=\active - \catcode`\$=\active - \catcode`\<=\active - \catcode`\>=\active - \catcode`\\=\active - \catcode`\^=\active - \catcode`\_=\active - \catcode`\|=\active - \catcode`\~=\active -} - - -% Read the toc file, which is essentially Texinfo input. -\def\readtocfile{% - \setupdatafile - \activecatcodes - \input \jobname.toc -} - -\newskip\contentsrightmargin \contentsrightmargin=1in -\newcount\savepageno -\newcount\lastnegativepageno \lastnegativepageno = -1 - -% Prepare to read what we've written to \tocfile. -% -\def\startcontents#1{% - % If @setchapternewpage on, and @headings double, the contents should - % start on an odd page, unlike chapters. Thus, we maintain - % \contentsalignmacro in parallel with \pagealignmacro. - % From: Torbjorn Granlund - \contentsalignmacro - \immediate\closeout\tocfile - % - % Don't need to put `Contents' or `Short Contents' in the headline. - % It is abundantly clear what they are. - \def\thischapter{}% - \chapmacro{#1}{Yomitfromtoc}{}% - % - \savepageno = \pageno - \begingroup % Set up to handle contents files properly. - \raggedbottom % Worry more about breakpoints than the bottom. - \advance\hsize by -\contentsrightmargin % Don't use the full line length. - % - % Roman numerals for page numbers. - \ifnum \pageno>0 \global\pageno = \lastnegativepageno \fi -} - - -% Normal (long) toc. -\def\contents{% - \startcontents{\putwordTOC}% - \openin 1 \jobname.toc - \ifeof 1 \else - \readtocfile - \fi - \vfill \eject - \contentsalignmacro % in case @setchapternewpage odd is in effect - \ifeof 1 \else - \pdfmakeoutlines - \fi - \closein 1 - \endgroup - \lastnegativepageno = \pageno - \global\pageno = \savepageno -} - -% And just the chapters. -\def\summarycontents{% - \startcontents{\putwordShortTOC}% - % - \let\numchapentry = \shortchapentry - \let\appentry = \shortchapentry - \let\unnchapentry = \shortunnchapentry - % We want a true roman here for the page numbers. - \secfonts - \let\rm=\shortcontrm \let\bf=\shortcontbf - \let\sl=\shortcontsl \let\tt=\shortconttt - \rm - \hyphenpenalty = 10000 - \advance\baselineskip by 1pt % Open it up a little. - \def\numsecentry##1##2##3##4{} - \let\appsecentry = \numsecentry - \let\unnsecentry = \numsecentry - \let\numsubsecentry = \numsecentry - \let\appsubsecentry = \numsecentry - \let\unnsubsecentry = \numsecentry - \let\numsubsubsecentry = \numsecentry - \let\appsubsubsecentry = \numsecentry - \let\unnsubsubsecentry = \numsecentry - \openin 1 \jobname.toc - \ifeof 1 \else - \readtocfile - \fi - \closein 1 - \vfill \eject - \contentsalignmacro % in case @setchapternewpage odd is in effect - \endgroup - \lastnegativepageno = \pageno - \global\pageno = \savepageno -} -\let\shortcontents = \summarycontents - -% Typeset the label for a chapter or appendix for the short contents. -% The arg is, e.g., `A' for an appendix, or `3' for a chapter. -% -\def\shortchaplabel#1{% - % This space should be enough, since a single number is .5em, and the - % widest letter (M) is 1em, at least in the Computer Modern fonts. - % But use \hss just in case. - % (This space doesn't include the extra space that gets added after - % the label; that gets put in by \shortchapentry above.) - % - % We'd like to right-justify chapter numbers, but that looks strange - % with appendix letters. And right-justifying numbers and - % left-justifying letters looks strange when there is less than 10 - % chapters. Have to read the whole toc once to know how many chapters - % there are before deciding ... - \hbox to 1em{#1\hss}% -} - -% These macros generate individual entries in the table of contents. -% The first argument is the chapter or section name. -% The last argument is the page number. -% The arguments in between are the chapter number, section number, ... - -% Chapters, in the main contents. -\def\numchapentry#1#2#3#4{\dochapentry{#2\labelspace#1}{#4}} -% -% Chapters, in the short toc. -% See comments in \dochapentry re vbox and related settings. -\def\shortchapentry#1#2#3#4{% - \tocentry{\shortchaplabel{#2}\labelspace #1}{\doshortpageno\bgroup#4\egroup}% -} - -% Appendices, in the main contents. -% Need the word Appendix, and a fixed-size box. -% -\def\appendixbox#1{% - % We use M since it's probably the widest letter. - \setbox0 = \hbox{\putwordAppendix{} M}% - \hbox to \wd0{\putwordAppendix{} #1\hss}} -% -\def\appentry#1#2#3#4{\dochapentry{\appendixbox{#2}\labelspace#1}{#4}} - -% Unnumbered chapters. -\def\unnchapentry#1#2#3#4{\dochapentry{#1}{#4}} -\def\shortunnchapentry#1#2#3#4{\tocentry{#1}{\doshortpageno\bgroup#4\egroup}} - -% Sections. -\def\numsecentry#1#2#3#4{\dosecentry{#2\labelspace#1}{#4}} -\let\appsecentry=\numsecentry -\def\unnsecentry#1#2#3#4{\dosecentry{#1}{#4}} - -% Subsections. -\def\numsubsecentry#1#2#3#4{\dosubsecentry{#2\labelspace#1}{#4}} -\let\appsubsecentry=\numsubsecentry -\def\unnsubsecentry#1#2#3#4{\dosubsecentry{#1}{#4}} - -% And subsubsections. -\def\numsubsubsecentry#1#2#3#4{\dosubsubsecentry{#2\labelspace#1}{#4}} -\let\appsubsubsecentry=\numsubsubsecentry -\def\unnsubsubsecentry#1#2#3#4{\dosubsubsecentry{#1}{#4}} - -% This parameter controls the indentation of the various levels. -% Same as \defaultparindent. -\newdimen\tocindent \tocindent = 15pt - -% Now for the actual typesetting. In all these, #1 is the text and #2 is the -% page number. -% -% If the toc has to be broken over pages, we want it to be at chapters -% if at all possible; hence the \penalty. -\def\dochapentry#1#2{% - \penalty-300 \vskip1\baselineskip plus.33\baselineskip minus.25\baselineskip - \begingroup - \chapentryfonts - \tocentry{#1}{\dopageno\bgroup#2\egroup}% - \endgroup - \nobreak\vskip .25\baselineskip plus.1\baselineskip -} - -\def\dosecentry#1#2{\begingroup - \secentryfonts \leftskip=\tocindent - \tocentry{#1}{\dopageno\bgroup#2\egroup}% -\endgroup} - -\def\dosubsecentry#1#2{\begingroup - \subsecentryfonts \leftskip=2\tocindent - \tocentry{#1}{\dopageno\bgroup#2\egroup}% -\endgroup} - -\def\dosubsubsecentry#1#2{\begingroup - \subsubsecentryfonts \leftskip=3\tocindent - \tocentry{#1}{\dopageno\bgroup#2\egroup}% -\endgroup} - -% We use the same \entry macro as for the index entries. -\let\tocentry = \entry - -% Space between chapter (or whatever) number and the title. -\def\labelspace{\hskip1em \relax} - -\def\dopageno#1{{\rm #1}} -\def\doshortpageno#1{{\rm #1}} - -\def\chapentryfonts{\secfonts \rm} -\def\secentryfonts{\textfonts} -\def\subsecentryfonts{\textfonts} -\def\subsubsecentryfonts{\textfonts} - - -\message{environments,} -% @foo ... @end foo. - -% @point{}, @result{}, @expansion{}, @print{}, @equiv{}. -% -% Since these characters are used in examples, it should be an even number of -% \tt widths. Each \tt character is 1en, so two makes it 1em. -% -\def\point{$\star$} -\def\result{\leavevmode\raise.15ex\hbox to 1em{\hfil$\Rightarrow$\hfil}} -\def\expansion{\leavevmode\raise.1ex\hbox to 1em{\hfil$\mapsto$\hfil}} -\def\print{\leavevmode\lower.1ex\hbox to 1em{\hfil$\dashv$\hfil}} -\def\equiv{\leavevmode\lower.1ex\hbox to 1em{\hfil$\ptexequiv$\hfil}} - -% The @error{} command. -% Adapted from the TeXbook's \boxit. -% -\newbox\errorbox -% -{\tentt \global\dimen0 = 3em}% Width of the box. -\dimen2 = .55pt % Thickness of rules -% The text. (`r' is open on the right, `e' somewhat less so on the left.) -\setbox0 = \hbox{\kern-.75pt \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. -% One exception: @ is still an escape character, so that @end tex works. -% But \@ or @@ will get a plain tex @ character. - -\envdef\tex{% - \catcode `\\=0 \catcode `\{=1 \catcode `\}=2 - \catcode `\$=3 \catcode `\&=4 \catcode `\#=6 - \catcode `\^=7 \catcode `\_=8 \catcode `\~=\active \let~=\tie - \catcode `\%=14 - \catcode `\+=\other - \catcode `\"=\other - \catcode `\|=\other - \catcode `\<=\other - \catcode `\>=\other - \escapechar=`\\ - % - \let\b=\ptexb - \let\bullet=\ptexbullet - \let\c=\ptexc - \let\,=\ptexcomma - \let\.=\ptexdot - \let\dots=\ptexdots - \let\equiv=\ptexequiv - \let\!=\ptexexclam - \let\i=\ptexi - \let\indent=\ptexindent - \let\noindent=\ptexnoindent - \let\{=\ptexlbrace - \let\+=\tabalign - \let\}=\ptexrbrace - \let\/=\ptexslash - \let\*=\ptexstar - \let\t=\ptext - \let\frenchspacing=\plainfrenchspacing - % - \def\endldots{\mathinner{\ldots\ldots\ldots\ldots}}% - \def\enddots{\relax\ifmmode\endldots\else$\mathsurround=0pt \endldots\,$\fi}% - \def\@{@}% -} -% There is no need to define \Etex. - -% Define @lisp ... @end lisp. -% @lisp environment forms a group so it can rebind things, -% including the definition of @end lisp (which normally is erroneous). - -% Amount to narrow the margins by for @lisp. -\newskip\lispnarrowing \lispnarrowing=0.4in - -% This is the definition that ^^M gets inside @lisp, @example, and other -% such environments. \null is better than a space, since it doesn't -% have any width. -\def\lisppar{\null\endgraf} - -% This space is always present above and below environments. -\newskip\envskipamount \envskipamount = 0pt - -% Make spacing and below environment symmetrical. We use \parskip here -% to help in doing that, since in @example-like environments \parskip -% is reset to zero; thus the \afterenvbreak inserts no space -- but the -% start of the next paragraph will insert \parskip. -% -\def\aboveenvbreak{{% - % =10000 instead of <10000 because of a special case in \itemzzz and - % \sectionheading, q.v. - \ifnum \lastpenalty=10000 \else - \advance\envskipamount by \parskip - \endgraf - \ifdim\lastskip<\envskipamount - \removelastskip - % it's not a good place to break if the last penalty was \nobreak - % or better ... - \ifnum\lastpenalty<10000 \penalty-50 \fi - \vskip\envskipamount - \fi - \fi -}} - -\let\afterenvbreak = \aboveenvbreak - -% \nonarrowing is a flag. If "set", @lisp etc don't narrow margins; it will -% also clear it, so that its embedded environments do the narrowing again. -\let\nonarrowing=\relax - -% @cartouche ... @end cartouche: draw rectangle w/rounded corners around -% environment contents. -\font\circle=lcircle10 -\newdimen\circthick -\newdimen\cartouter\newdimen\cartinner -\newskip\normbskip\newskip\normpskip\newskip\normlskip -\circthick=\fontdimen8\circle -% -\def\ctl{{\circle\char'013\hskip -6pt}}% 6pt from pl file: 1/2charwidth -\def\ctr{{\hskip 6pt\circle\char'010}} -\def\cbl{{\circle\char'012\hskip -6pt}} -\def\cbr{{\hskip 6pt\circle\char'011}} -\def\carttop{\hbox to \cartouter{\hskip\lskip - \ctl\leaders\hrule height\circthick\hfil\ctr - \hskip\rskip}} -\def\cartbot{\hbox to \cartouter{\hskip\lskip - \cbl\leaders\hrule height\circthick\hfil\cbr - \hskip\rskip}} -% -\newskip\lskip\newskip\rskip - -\envdef\cartouche{% - \ifhmode\par\fi % can't be in the midst of a paragraph. - \startsavinginserts - \lskip=\leftskip \rskip=\rightskip - \leftskip=0pt\rightskip=0pt % we want these *outside*. - \cartinner=\hsize \advance\cartinner by-\lskip - \advance\cartinner by-\rskip - \cartouter=\hsize - \advance\cartouter by 18.4pt % allow for 3pt kerns on either - % side, and for 6pt waste from - % each corner char, and rule thickness - \normbskip=\baselineskip \normpskip=\parskip \normlskip=\lineskip - % Flag to tell @lisp, etc., not to narrow margin. - \let\nonarrowing = t% - \vbox\bgroup - \baselineskip=0pt\parskip=0pt\lineskip=0pt - \carttop - \hbox\bgroup - \hskip\lskip - \vrule\kern3pt - \vbox\bgroup - \kern3pt - \hsize=\cartinner - \baselineskip=\normbskip - \lineskip=\normlskip - \parskip=\normpskip - \vskip -\parskip - \comment % For explanation, see the end of \def\group. -} -\def\Ecartouche{% - \ifhmode\par\fi - \kern3pt - \egroup - \kern3pt\vrule - \hskip\rskip - \egroup - \cartbot - \egroup - \checkinserts -} - - -% This macro is called at the beginning of all the @example variants, -% inside a group. -\def\nonfillstart{% - \aboveenvbreak - \hfuzz = 12pt % Don't be fussy - \sepspaces % Make spaces be word-separators rather than space tokens. - \let\par = \lisppar % don't ignore blank lines - \obeylines % each line of input is a line of output - \parskip = 0pt - \parindent = 0pt - \emergencystretch = 0pt % don't try to avoid overfull boxes - \ifx\nonarrowing\relax - \advance \leftskip by \lispnarrowing - \exdentamount=\lispnarrowing - \else - \let\nonarrowing = \relax - \fi - \let\exdent=\nofillexdent -} - -% If you want all examples etc. small: @set dispenvsize small. -% If you want even small examples the full size: @set dispenvsize nosmall. -% This affects the following displayed environments: -% @example, @display, @format, @lisp -% -\def\smallword{small} -\def\nosmallword{nosmall} -\let\SETdispenvsize\relax -\def\setnormaldispenv{% - \ifx\SETdispenvsize\smallword - \smallexamplefonts \rm - \fi -} -\def\setsmalldispenv{% - \ifx\SETdispenvsize\nosmallword - \else - \smallexamplefonts \rm - \fi -} - -% We often define two environments, @foo and @smallfoo. -% Let's do it by one command: -\def\makedispenv #1#2{ - \expandafter\envdef\csname#1\endcsname {\setnormaldispenv #2} - \expandafter\envdef\csname small#1\endcsname {\setsmalldispenv #2} - \expandafter\let\csname E#1\endcsname \afterenvbreak - \expandafter\let\csname Esmall#1\endcsname \afterenvbreak -} - -% Define two synonyms: -\def\maketwodispenvs #1#2#3{ - \makedispenv{#1}{#3} - \makedispenv{#2}{#3} -} - -% @lisp: indented, narrowed, typewriter font; @example: same as @lisp. -% -% @smallexample and @smalllisp: use smaller fonts. -% Originally contributed by Pavel@xerox. -% -\maketwodispenvs {lisp}{example}{% - \nonfillstart - \tt\quoteexpand - \let\kbdfont = \kbdexamplefont % Allow @kbd to do something special. - \gobble % eat return -} -% @display/@smalldisplay: same as @lisp except keep current font. -% -\makedispenv {display}{% - \nonfillstart - \gobble -} - -% @format/@smallformat: same as @display except don't narrow margins. -% -\makedispenv{format}{% - \let\nonarrowing = t% - \nonfillstart - \gobble -} - -% @flushleft: same as @format, but doesn't obey \SETdispenvsize. -\envdef\flushleft{% - \let\nonarrowing = t% - \nonfillstart - \gobble -} -\let\Eflushleft = \afterenvbreak - -% @flushright. -% -\envdef\flushright{% - \let\nonarrowing = t% - \nonfillstart - \advance\leftskip by 0pt plus 1fill - \gobble -} -\let\Eflushright = \afterenvbreak - - -% @quotation does normal linebreaking (hence we can't use \nonfillstart) -% and narrows the margins. We keep \parskip nonzero in general, since -% we're doing normal filling. So, when using \aboveenvbreak and -% \afterenvbreak, temporarily make \parskip 0. -% -\envdef\quotation{% - {\parskip=0pt \aboveenvbreak}% because \aboveenvbreak inserts \parskip - \parindent=0pt - % - % @cartouche defines \nonarrowing to inhibit narrowing at next level down. - \ifx\nonarrowing\relax - \advance\leftskip by \lispnarrowing - \advance\rightskip by \lispnarrowing - \exdentamount = \lispnarrowing - \else - \let\nonarrowing = \relax - \fi - \parsearg\quotationlabel -} - -% We have retained a nonzero parskip for the environment, since we're -% doing normal filling. -% -\def\Equotation{% - \par - \ifx\quotationauthor\undefined\else - % indent a bit. - \leftline{\kern 2\leftskip \sl ---\quotationauthor}% - \fi - {\parskip=0pt \afterenvbreak}% -} - -% If we're given an argument, typeset it in bold with a colon after. -\def\quotationlabel#1{% - \def\temp{#1}% - \ifx\temp\empty \else - {\bf #1: }% - \fi -} - - -% LaTeX-like @verbatim...@end verbatim and @verb{...} -% If we want to allow any as delimiter, -% we need the curly braces so that makeinfo sees the @verb command, eg: -% `@verbx...x' would look like the '@verbx' command. --janneke@gnu.org -% -% [Knuth]: Donald Ervin Knuth, 1996. The TeXbook. -% -% [Knuth] p.344; only we need to do the other characters Texinfo sets -% active too. Otherwise, they get lost as the first character on a -% verbatim line. -\def\dospecials{% - \do\ \do\\\do\{\do\}\do\$\do\&% - \do\#\do\^\do\^^K\do\_\do\^^A\do\%\do\~% - \do\<\do\>\do\|\do\@\do+\do\"% -} -% -% [Knuth] p. 380 -\def\uncatcodespecials{% - \def\do##1{\catcode`##1=\other}\dospecials} -% -% [Knuth] pp. 380,381,391 -% Disable Spanish ligatures ?` and !` of \tt font -\begingroup - \catcode`\`=\active\gdef`{\relax\lq} -\endgroup -% -% Setup for the @verb command. -% -% Eight spaces for a tab -\begingroup - \catcode`\^^I=\active - \gdef\tabeightspaces{\catcode`\^^I=\active\def^^I{\ \ \ \ \ \ \ \ }} -\endgroup -% -\def\setupverb{% - \tt % easiest (and conventionally used) font for verbatim - \def\par{\leavevmode\endgraf}% - \catcode`\`=\active - \tabeightspaces - % Respect line breaks, - % print special symbols as themselves, and - % make each space count - % must do in this order: - \obeylines \uncatcodespecials \sepspaces -} - -% Setup for the @verbatim environment -% -% Real tab expansion -\newdimen\tabw \setbox0=\hbox{\tt\space} \tabw=8\wd0 % tab amount -% -\def\starttabbox{\setbox0=\hbox\bgroup} - -% 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 SETcodequoteundirected\endcsname\relax - '% - \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 SETcodequotebacktick\endcsname\relax - `% - \else - \char'22 - \fi -} -% -\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 - }% - } - \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 - \tabexpand - \quoteexpand - % Respect line breaks, - % print special symbols as themselves, and - % make each space count - % must do in this order: - \obeylines \uncatcodespecials \sepspaces - \everypar{\starttabbox}% -} - -% Do the @verb magic: verbatim text is quoted by unique -% delimiter characters. Before first delimiter expect a -% right brace, after last delimiter expect closing brace: -% -% \def\doverb'{'#1'}'{#1} -% -% [Knuth] p. 382; only eat outer {} -\begingroup - \catcode`[=1\catcode`]=2\catcode`\{=\other\catcode`\}=\other - \gdef\doverb{#1[\def\next##1#1}[##1\endgroup]\next] -\endgroup -% -\def\verb{\begingroup\setupverb\doverb} -% -% -% Do the @verbatim magic: define the macro \doverbatim so that -% the (first) argument ends when '@end verbatim' is reached, ie: -% -% \def\doverbatim#1@end verbatim{#1} -% -% For Texinfo it's a lot easier than for LaTeX, -% because texinfo's \verbatim doesn't stop at '\end{verbatim}': -% we need not redefine '\', '{' and '}'. -% -% Inspired by LaTeX's verbatim command set [latex.ltx] -% -\begingroup - \catcode`\ =\active - \obeylines % - % ignore everything up to the first ^^M, that's the newline at the end - % of the @verbatim input line itself. Otherwise we get an extra blank - % line in the output. - \xdef\doverbatim#1^^M#2@end verbatim{#2\noexpand\end\gobble verbatim}% - % We really want {...\end verbatim} in the body of the macro, but - % without the active space; thus we have to use \xdef and \gobble. -\endgroup -% -\envdef\verbatim{% - \setupverbatim\doverbatim -} -\let\Everbatim = \afterenvbreak - - -% @verbatiminclude FILE - insert text of file in verbatim environment. -% -\def\verbatiminclude{\parseargusing\filenamecatcodes\doverbatiminclude} -% -\def\doverbatiminclude#1{% - {% - \makevalueexpandable - \setupverbatim - \input #1 - \afterenvbreak - }% -} - -% @copying ... @end copying. -% Save the text away for @insertcopying later. -% -% We save the uninterpreted tokens, rather than creating a box. -% Saving the text in a box would be much easier, but then all the -% typesetting commands (@smallbook, font changes, etc.) have to be done -% beforehand -- and a) we want @copying to be done first in the source -% file; b) letting users define the frontmatter in as flexible order as -% possible is very desirable. -% -\def\copying{\checkenv{}\begingroup\scanargctxt\docopying} -\def\docopying#1@end copying{\endgroup\def\copyingtext{#1}} -% -\def\insertcopying{% - \begingroup - \parindent = 0pt % paragraph indentation looks wrong on title page - \scanexp\copyingtext - \endgroup -} - -\message{defuns,} -% @defun etc. - -\newskip\defbodyindent \defbodyindent=.4in -\newskip\defargsindent \defargsindent=50pt -\newskip\deflastargmargin \deflastargmargin=18pt - -% Start the processing of @deffn: -\def\startdefun{% - \ifnum\lastpenalty<10000 - \medbreak - \else - % If there are two @def commands in a row, we'll have a \nobreak, - % which is there to keep the function description together with its - % header. But if there's nothing but headers, we need to allow a - % break somewhere. Check specifically for penalty 10002, inserted - % by \defargscommonending, instead of 10000, since the sectioning - % commands also insert a nobreak penalty, and we don't want to allow - % a break between a section heading and a defun. - % - \ifnum\lastpenalty=10002 \penalty2000 \fi - % - % Similarly, after a section heading, do not allow a break. - % But do insert the glue. - \medskip % preceded by discardable penalty, so not a breakpoint - \fi - % - \parindent=0in - \advance\leftskip by \defbodyindent - \exdentamount=\defbodyindent -} - -\def\dodefunx#1{% - % First, check whether we are in the right environment: - \checkenv#1% - % - % As above, allow line break if we have multiple x headers in a row. - % It's not a great place, though. - \ifnum\lastpenalty=10002 \penalty3000 \fi - % - % And now, it's time to reuse the body of the original defun: - \expandafter\gobbledefun#1% -} -\def\gobbledefun#1\startdefun{} - -% \printdefunline \deffnheader{text} -% -\def\printdefunline#1#2{% - \begingroup - % call \deffnheader: - #1#2 \endheader - % common ending: - \interlinepenalty = 10000 - \advance\rightskip by 0pt plus 1fil - \endgraf - \nobreak\vskip -\parskip - \penalty 10002 % signal to \startdefun and \dodefunx - % Some of the @defun-type tags do not enable magic parentheses, - % rendering the following check redundant. But we don't optimize. - \checkparencounts - \endgroup -} - -\def\Edefun{\endgraf\medbreak} - -% \makedefun{deffn} creates \deffn, \deffnx and \Edeffn; -% the only thing remainnig is to define \deffnheader. -% -\def\makedefun#1{% - \expandafter\let\csname E#1\endcsname = \Edefun - \edef\temp{\noexpand\domakedefun - \makecsname{#1}\makecsname{#1x}\makecsname{#1header}}% - \temp -} - -% \domakedefun \deffn \deffnx \deffnheader -% -% Define \deffn and \deffnx, without parameters. -% \deffnheader has to be defined explicitly. -% -\def\domakedefun#1#2#3{% - \envdef#1{% - \startdefun - \parseargusing\activeparens{\printdefunline#3}% - }% - \def#2{\dodefunx#1}% - \def#3% -} - -%%% Untyped functions: - -% @deffn category name args -\makedefun{deffn}{\deffngeneral{}} - -% @deffn category class name args -\makedefun{defop}#1 {\defopon{#1\ \putwordon}} - -% \defopon {category on}class name args -\def\defopon#1#2 {\deffngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } - -% \deffngeneral {subind}category name args -% -\def\deffngeneral#1#2 #3 #4\endheader{% - % Remember that \dosubind{fn}{foo}{} is equivalent to \doind{fn}{foo}. - \dosubind{fn}{\code{#3}}{#1}% - \defname{#2}{}{#3}\magicamp\defunargs{#4\unskip}% -} - -%%% Typed functions: - -% @deftypefn category type name args -\makedefun{deftypefn}{\deftypefngeneral{}} - -% @deftypeop category class type name args -\makedefun{deftypeop}#1 {\deftypeopon{#1\ \putwordon}} - -% \deftypeopon {category on}class type name args -\def\deftypeopon#1#2 {\deftypefngeneral{\putwordon\ \code{#2}}{#1\ \code{#2}} } - -% \deftypefngeneral {subind}category type name args -% -\def\deftypefngeneral#1#2 #3 #4 #5\endheader{% - \dosubind{fn}{\code{#4}}{#1}% - \defname{#2}{#3}{#4}\defunargs{#5\unskip}% -} - -%%% Typed variables: - -% @deftypevr category type var args -\makedefun{deftypevr}{\deftypecvgeneral{}} - -% @deftypecv category class type var args -\makedefun{deftypecv}#1 {\deftypecvof{#1\ \putwordof}} - -% \deftypecvof {category of}class type var args -\def\deftypecvof#1#2 {\deftypecvgeneral{\putwordof\ \code{#2}}{#1\ \code{#2}} } - -% \deftypecvgeneral {subind}category type var args -% -\def\deftypecvgeneral#1#2 #3 #4 #5\endheader{% - \dosubind{vr}{\code{#4}}{#1}% - \defname{#2}{#3}{#4}\defunargs{#5\unskip}% -} - -%%% Untyped variables: - -% @defvr category var args -\makedefun{defvr}#1 {\deftypevrheader{#1} {} } - -% @defcv category class var args -\makedefun{defcv}#1 {\defcvof{#1\ \putwordof}} - -% \defcvof {category of}class var args -\def\defcvof#1#2 {\deftypecvof{#1}#2 {} } - -%%% Type: -% @deftp category name args -\makedefun{deftp}#1 #2 #3\endheader{% - \doind{tp}{\code{#2}}% - \defname{#1}{}{#2}\defunargs{#3\unskip}% -} - -% Remaining @defun-like shortcuts: -\makedefun{defun}{\deffnheader{\putwordDeffunc} } -\makedefun{defmac}{\deffnheader{\putwordDefmac} } -\makedefun{defspec}{\deffnheader{\putwordDefspec} } -\makedefun{deftypefun}{\deftypefnheader{\putwordDeffunc} } -\makedefun{defvar}{\defvrheader{\putwordDefvar} } -\makedefun{defopt}{\defvrheader{\putwordDefopt} } -\makedefun{deftypevar}{\deftypevrheader{\putwordDefvar} } -\makedefun{defmethod}{\defopon\putwordMethodon} -\makedefun{deftypemethod}{\deftypeopon\putwordMethodon} -\makedefun{defivar}{\defcvof\putwordInstanceVariableof} -\makedefun{deftypeivar}{\deftypecvof\putwordInstanceVariableof} - -% \defname, which formats the name of the @def (not the args). -% #1 is the category, such as "Function". -% #2 is the return type, if any. -% #3 is the function name. -% -% We are followed by (but not passed) the arguments, if any. -% -\def\defname#1#2#3{% - % Get the values of \leftskip and \rightskip as they were outside the @def... - \advance\leftskip by -\defbodyindent - % - % How we'll format the type name. Putting it in brackets helps - % distinguish it from the body text that may end up on the next line - % just below it. - \def\temp{#1}% - \setbox0=\hbox{\kern\deflastargmargin \ifx\temp\empty\else [\rm\temp]\fi} - % - % Figure out line sizes for the paragraph shape. - % The first line needs space for \box0; but if \rightskip is nonzero, - % we need only space for the part of \box0 which exceeds it: - \dimen0=\hsize \advance\dimen0 by -\wd0 \advance\dimen0 by \rightskip - % The continuations: - \dimen2=\hsize \advance\dimen2 by -\defargsindent - % (plain.tex says that \dimen1 should be used only as global.) - \parshape 2 0in \dimen0 \defargsindent \dimen2 - % - % Put the type name to the right margin. - \noindent - \hbox to 0pt{% - \hfil\box0 \kern-\hsize - % \hsize has to be shortened this way: - \kern\leftskip - % Intentionally do not respect \rightskip, since we need the space. - }% - % - % Allow all lines to be underfull without complaint: - \tolerance=10000 \hbadness=10000 - \exdentamount=\defbodyindent - {% - % defun fonts. We use typewriter by default (used to be bold) because: - % . we're printing identifiers, they should be in tt in principle. - % . in languages with many accents, such as Czech or French, it's - % common to leave accents off identifiers. The result looks ok in - % tt, but exceedingly strange in rm. - % . we don't want -- and --- to be treated as ligatures. - % . this still does not fix the ?` and !` ligatures, but so far no - % one has made identifiers using them :). - \df \tt - \def\temp{#2}% return value type - \ifx\temp\empty\else \tclose{\temp} \fi - #3% output function name - }% - {\rm\enskip}% hskip 0.5 em of \tenrm - % - \boldbrax - % arguments will be output next, if any. -} - -% Print arguments in slanted roman (not ttsl), inconsistently with using -% tt for the name. This is because literal text is sometimes needed in -% the argument list (groff manual), and ttsl and tt are not very -% distinguishable. Prevent hyphenation at `-' chars. -% -\def\defunargs#1{% - % use sl by default (not ttsl), - % tt for the names. - \df \sl \hyphenchar\font=0 - % - % On the other hand, if an argument has two dashes (for instance), we - % want a way to get ttsl. Let's try @var for that. - \let\var=\ttslanted - #1% - \sl\hyphenchar\font=45 -} - -% We want ()&[] to print specially on the defun line. -% -\def\activeparens{% - \catcode`\(=\active \catcode`\)=\active - \catcode`\[=\active \catcode`\]=\active - \catcode`\&=\active -} - -% Make control sequences which act like normal parenthesis chars. -\let\lparen = ( \let\rparen = ) - -% Be sure that we always have a definition for `(', etc. For example, -% if the fn name has parens in it, \boldbrax will not be in effect yet, -% so TeX would otherwise complain about undefined control sequence. -{ - \activeparens - \global\let(=\lparen \global\let)=\rparen - \global\let[=\lbrack \global\let]=\rbrack - \global\let& = \& - - \gdef\boldbrax{\let(=\opnr\let)=\clnr\let[=\lbrb\let]=\rbrb} - \gdef\magicamp{\let&=\amprm} -} - -\newcount\parencount - -% If we encounter &foo, then turn on ()-hacking afterwards -\newif\ifampseen -\def\amprm#1 {\ampseentrue{\bf\ }} - -\def\parenfont{% - \ifampseen - % At the first level, print parens in roman, - % otherwise use the default font. - \ifnum \parencount=1 \rm \fi - \else - % The \sf parens (in \boldbrax) actually are a little bolder than - % the contained text. This is especially needed for [ and ] . - \sf - \fi -} -\def\infirstlevel#1{% - \ifampseen - \ifnum\parencount=1 - #1% - \fi - \fi -} -\def\bfafterword#1 {#1 \bf} - -\def\opnr{% - \global\advance\parencount by 1 - {\parenfont(}% - \infirstlevel \bfafterword -} -\def\clnr{% - {\parenfont)}% - \infirstlevel \sl - \global\advance\parencount by -1 -} - -\newcount\brackcount -\def\lbrb{% - \global\advance\brackcount by 1 - {\bf[}% -} -\def\rbrb{% - {\bf]}% - \global\advance\brackcount by -1 -} - -\def\checkparencounts{% - \ifnum\parencount=0 \else \badparencount \fi - \ifnum\brackcount=0 \else \badbrackcount \fi -} -\def\badparencount{% - \errmessage{Unbalanced parentheses in @def}% - \global\parencount=0 -} -\def\badbrackcount{% - \errmessage{Unbalanced square braces in @def}% - \global\brackcount=0 -} - - -\message{macros,} -% @macro. - -% To do this right we need a feature of e-TeX, \scantokens, -% which we arrange to emulate with a temporary file in ordinary TeX. -\ifx\eTeXversion\undefined - \newwrite\macscribble - \def\scantokens#1{% - \toks0={#1}% - \immediate\openout\macscribble=\jobname.tmp - \immediate\write\macscribble{\the\toks0}% - \immediate\closeout\macscribble - \input \jobname.tmp - } -\fi - -\def\scanmacro#1{% - \begingroup - \newlinechar`\^^M - \let\xeatspaces\eatspaces - % Undo catcode changes of \startcontents and \doprintindex - % When called from @insertcopying or (short)caption, we need active - % backslash to get it printed correctly. Previously, we had - % \catcode`\\=\other instead. We'll see whether a problem appears - % with macro expansion. --kasal, 19aug04 - \catcode`\@=0 \catcode`\\=\active \escapechar=`\@ - % ... and \example - \spaceisspace - % - % Append \endinput to make sure that TeX does not see the ending newline. - % I've verified that it is necessary both for e-TeX and for ordinary TeX - % --kasal, 29nov03 - \scantokens{#1\endinput}% - \endgroup -} - -\def\scanexp#1{% - \edef\temp{\noexpand\scanmacro{#1}}% - \temp -} - -\newcount\paramno % Count of parameters -\newtoks\macname % Macro name -\newif\ifrecursive % Is it recursive? - -% List of all defined macros in the form -% \definedummyword\macro1\definedummyword\macro2... -% Currently is also contains all @aliases; the list can be split -% if there is a need. -\def\macrolist{} - -% Add the macro to \macrolist -\def\addtomacrolist#1{\expandafter \addtomacrolistxxx \csname#1\endcsname} -\def\addtomacrolistxxx#1{% - \toks0 = \expandafter{\macrolist\definedummyword#1}% - \xdef\macrolist{\the\toks0}% -} - -% Utility routines. -% This does \let #1 = #2, with \csnames; that is, -% \let \csname#1\endcsname = \csname#2\endcsname -% (except of course we have to play expansion games). -% -\def\cslet#1#2{% - \expandafter\let - \csname#1\expandafter\endcsname - \csname#2\endcsname -} - -% Trim leading and trailing spaces off a string. -% Concepts from aro-bend problem 15 (see CTAN). -{\catcode`\@=11 -\gdef\eatspaces #1{\expandafter\trim@\expandafter{#1 }} -\gdef\trim@ #1{\trim@@ @#1 @ #1 @ @@} -\gdef\trim@@ #1@ #2@ #3@@{\trim@@@\empty #2 @} -\def\unbrace#1{#1} -\unbrace{\gdef\trim@@@ #1 } #2@{#1} -} - -% Trim a single trailing ^^M off a string. -{\catcode`\^^M=\other \catcode`\Q=3% -\gdef\eatcr #1{\eatcra #1Q^^MQ}% -\gdef\eatcra#1^^MQ{\eatcrb#1Q}% -\gdef\eatcrb#1Q#2Q{#1}% -} - -% Macro bodies are absorbed as an argument in a context where -% all characters are catcode 10, 11 or 12, except \ which is active -% (as in normal texinfo). It is necessary to change the definition of \. - -% It's necessary to have hard CRs when the macro is executed. This is -% done by making ^^M (\endlinechar) catcode 12 when reading the macro -% body, and then making it the \newlinechar in \scanmacro. - -\def\scanctxt{% - \catcode`\"=\other - \catcode`\+=\other - \catcode`\<=\other - \catcode`\>=\other - \catcode`\@=\other - \catcode`\^=\other - \catcode`\_=\other - \catcode`\|=\other - \catcode`\~=\other -} - -\def\scanargctxt{% - \scanctxt - \catcode`\\=\other - \catcode`\^^M=\other -} - -\def\macrobodyctxt{% - \scanctxt - \catcode`\{=\other - \catcode`\}=\other - \catcode`\^^M=\other - \usembodybackslash -} - -\def\macroargctxt{% - \scanctxt - \catcode`\\=\other -} - -% \mbodybackslash is the definition of \ in @macro bodies. -% It maps \foo\ => \csname macarg.foo\endcsname => #N -% where N is the macro parameter number. -% We define \csname macarg.\endcsname to be \realbackslash, so -% \\ in macro replacement text gets you a backslash. - -{\catcode`@=0 @catcode`@\=@active - @gdef@usembodybackslash{@let\=@mbodybackslash} - @gdef@mbodybackslash#1\{@csname macarg.#1@endcsname} -} -\expandafter\def\csname macarg.\endcsname{\realbackslash} - -\def\macro{\recursivefalse\parsearg\macroxxx} -\def\rmacro{\recursivetrue\parsearg\macroxxx} - -\def\macroxxx#1{% - \getargs{#1}% now \macname is the macname and \argl the arglist - \ifx\argl\empty % no arguments - \paramno=0% - \else - \expandafter\parsemargdef \argl;% - \fi - \if1\csname ismacro.\the\macname\endcsname - \message{Warning: redefining \the\macname}% - \else - \expandafter\ifx\csname \the\macname\endcsname \relax - \else \errmessage{Macro name \the\macname\space already defined}\fi - \global\cslet{macsave.\the\macname}{\the\macname}% - \global\expandafter\let\csname ismacro.\the\macname\endcsname=1% - \addtomacrolist{\the\macname}% - \fi - \begingroup \macrobodyctxt - \ifrecursive \expandafter\parsermacbody - \else \expandafter\parsemacbody - \fi} - -\parseargdef\unmacro{% - \if1\csname ismacro.#1\endcsname - \global\cslet{#1}{macsave.#1}% - \global\expandafter\let \csname ismacro.#1\endcsname=0% - % Remove the macro name from \macrolist: - \begingroup - \expandafter\let\csname#1\endcsname \relax - \let\definedummyword\unmacrodo - \xdef\macrolist{\macrolist}% - \endgroup - \else - \errmessage{Macro #1 not defined}% - \fi -} - -% Called by \do from \dounmacro on each macro. The idea is to omit any -% macro definitions that have been changed to \relax. -% -\def\unmacrodo#1{% - \ifx #1\relax - % remove this - \else - \noexpand\definedummyword \noexpand#1% - \fi -} - -% This makes use of the obscure feature that if the last token of a -% is #, then the preceding argument is delimited by -% an opening brace, and that opening brace is not consumed. -\def\getargs#1{\getargsxxx#1{}} -\def\getargsxxx#1#{\getmacname #1 \relax\getmacargs} -\def\getmacname #1 #2\relax{\macname={#1}} -\def\getmacargs#1{\def\argl{#1}} - -% Parse the optional {params} list. Set up \paramno and \paramlist -% so \defmacro knows what to do. Define \macarg.blah for each blah -% in the params list, to be ##N where N is the position in that list. -% That gets used by \mbodybackslash (above). - -% We need to get `macro parameter char #' into several definitions. -% The technique used is stolen from LaTeX: let \hash be something -% unexpandable, insert that wherever you need a #, and then redefine -% it to # just before using the token list produced. -% -% The same technique is used to protect \eatspaces till just before -% the macro is used. - -\def\parsemargdef#1;{\paramno=0\def\paramlist{}% - \let\hash\relax\let\xeatspaces\relax\parsemargdefxxx#1,;,} -\def\parsemargdefxxx#1,{% - \if#1;\let\next=\relax - \else \let\next=\parsemargdefxxx - \advance\paramno by 1% - \expandafter\edef\csname macarg.\eatspaces{#1}\endcsname - {\xeatspaces{\hash\the\paramno}}% - \edef\paramlist{\paramlist\hash\the\paramno,}% - \fi\next} - -% These two commands read recursive and nonrecursive macro bodies. -% (They're different since rec and nonrec macros end differently.) - -\long\def\parsemacbody#1@end macro% -{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% -\long\def\parsermacbody#1@end rmacro% -{\xdef\temp{\eatcr{#1}}\endgroup\defmacro}% - -% This defines the macro itself. There are six cases: recursive and -% nonrecursive macros of zero, one, and many arguments. -% Much magic with \expandafter here. -% \xdef is used so that macro definitions will survive the file -% they're defined in; @include reads the file inside a group. -\def\defmacro{% - \let\hash=##% convert placeholders to macro parameter chars - \ifrecursive - \ifcase\paramno - % 0 - \expandafter\xdef\csname\the\macname\endcsname{% - \noexpand\scanmacro{\temp}}% - \or % 1 - \expandafter\xdef\csname\the\macname\endcsname{% - \bgroup\noexpand\macroargctxt - \noexpand\braceorline - \expandafter\noexpand\csname\the\macname xxx\endcsname}% - \expandafter\xdef\csname\the\macname xxx\endcsname##1{% - \egroup\noexpand\scanmacro{\temp}}% - \else % many - \expandafter\xdef\csname\the\macname\endcsname{% - \bgroup\noexpand\macroargctxt - \noexpand\csname\the\macname xx\endcsname}% - \expandafter\xdef\csname\the\macname xx\endcsname##1{% - \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% - \expandafter\expandafter - \expandafter\xdef - \expandafter\expandafter - \csname\the\macname xxx\endcsname - \paramlist{\egroup\noexpand\scanmacro{\temp}}% - \fi - \else - \ifcase\paramno - % 0 - \expandafter\xdef\csname\the\macname\endcsname{% - \noexpand\norecurse{\the\macname}% - \noexpand\scanmacro{\temp}\egroup}% - \or % 1 - \expandafter\xdef\csname\the\macname\endcsname{% - \bgroup\noexpand\macroargctxt - \noexpand\braceorline - \expandafter\noexpand\csname\the\macname xxx\endcsname}% - \expandafter\xdef\csname\the\macname xxx\endcsname##1{% - \egroup - \noexpand\norecurse{\the\macname}% - \noexpand\scanmacro{\temp}\egroup}% - \else % many - \expandafter\xdef\csname\the\macname\endcsname{% - \bgroup\noexpand\macroargctxt - \expandafter\noexpand\csname\the\macname xx\endcsname}% - \expandafter\xdef\csname\the\macname xx\endcsname##1{% - \expandafter\noexpand\csname\the\macname xxx\endcsname ##1,}% - \expandafter\expandafter - \expandafter\xdef - \expandafter\expandafter - \csname\the\macname xxx\endcsname - \paramlist{% - \egroup - \noexpand\norecurse{\the\macname}% - \noexpand\scanmacro{\temp}\egroup}% - \fi - \fi} - -\def\norecurse#1{\bgroup\cslet{#1}{macsave.#1}} - -% \braceorline decides whether the next nonwhitespace character is a -% {. If so it reads up to the closing }, if not, it reads the whole -% line. Whatever was read is then fed to the next control sequence -% as an argument (by \parsebrace or \parsearg) -\def\braceorline#1{\let\macnamexxx=#1\futurelet\nchar\braceorlinexxx} -\def\braceorlinexxx{% - \ifx\nchar\bgroup\else - \expandafter\parsearg - \fi \macnamexxx} - - -% @alias. -% We need some trickery to remove the optional spaces around the equal -% sign. Just make them active and then expand them all to nothing. -\def\alias{\parseargusing\obeyspaces\aliasxxx} -\def\aliasxxx #1{\aliasyyy#1\relax} -\def\aliasyyy #1=#2\relax{% - {% - \expandafter\let\obeyedspace=\empty - \addtomacrolist{#1}% - \xdef\next{\global\let\makecsname{#1}=\makecsname{#2}}% - }% - \next -} - - -\message{cross references,} - -\newwrite\auxfile - -\newif\ifhavexrefs % True if xref values are known. -\newif\ifwarnedxrefs % True if we warned once that they aren't known. - -% @inforef is relatively simple. -\def\inforef #1{\inforefzzz #1,,,,**} -\def\inforefzzz #1,#2,#3,#4**{\putwordSee{} \putwordInfo{} \putwordfile{} \file{\ignorespaces #3{}}, - node \samp{\ignorespaces#1{}}} - -% @node's only job in TeX is to define \lastnode, which is used in -% cross-references. The @node line might or might not have commas, and -% might or might not have spaces before the first comma, like: -% @node foo , bar , ... -% We don't want such trailing spaces in the node name. -% -\parseargdef\node{\checkenv{}\donode #1 ,\finishnodeparse} -% -% also remove a trailing comma, in case of something like this: -% @node Help-Cross, , , Cross-refs -\def\donode#1 ,#2\finishnodeparse{\dodonode #1,\finishnodeparse} -\def\dodonode#1,#2\finishnodeparse{\gdef\lastnode{#1}} - -\let\nwnode=\node -\let\lastnode=\empty - -% Write a cross-reference definition for the current node. #1 is the -% type (Ynumbered, Yappendix, Ynothing). -% -\def\donoderef#1{% - \ifx\lastnode\empty\else - \setref{\lastnode}{#1}% - \global\let\lastnode=\empty - \fi -} - -% @anchor{NAME} -- define xref target at arbitrary point. -% -\newcount\savesfregister -% -\def\savesf{\relax \ifhmode \savesfregister=\spacefactor \fi} -\def\restoresf{\relax \ifhmode \spacefactor=\savesfregister \fi} -\def\anchor#1{\savesf \setref{#1}{Ynothing}\restoresf \ignorespaces} - -% \setref{NAME}{SNT} defines a cross-reference point NAME (a node or an -% anchor), which consists of three parts: -% 1) NAME-title - the current sectioning name taken from \thissection, -% or the anchor name. -% 2) NAME-snt - section number and type, passed as the SNT arg, or -% empty for anchors. -% 3) NAME-pg - the page number. -% -% This is called from \donoderef, \anchor, and \dofloat. In the case of -% floats, there is an additional part, which is not written here: -% 4) NAME-lof - the text as it should appear in a @listoffloats. -% -\def\setref#1#2{% - \pdfmkdest{#1}% - \iflinks - {% - \atdummies % preserve commands, but don't expand them - \edef\writexrdef##1##2{% - \write\auxfile{@xrdef{#1-% #1 of \setref, expanded by the \edef - ##1}{##2}}% these are parameters of \writexrdef - }% - \toks0 = \expandafter{\thissection}% - \immediate \writexrdef{title}{\the\toks0 }% - \immediate \writexrdef{snt}{\csname #2\endcsname}% \Ynumbered etc. - \writexrdef{pg}{\folio}% will be written later, during \shipout - }% - \fi -} - -% @xref, @pxref, and @ref generate cross-references. For \xrefX, #1 is -% the node name, #2 the name of the Info cross-reference, #3 the printed -% node name, #4 the name of the Info file, #5 the name of the printed -% manual. All but the node name can be omitted. -% -\def\pxref#1{\putwordsee{} \xrefX[#1,,,,,,,]} -\def\xref#1{\putwordSee{} \xrefX[#1,,,,,,,]} -\def\ref#1{\xrefX[#1,,,,,,,]} -\def\xrefX[#1,#2,#3,#4,#5,#6]{\begingroup - \unsepspaces - \def\printedmanual{\ignorespaces #5}% - \def\printedrefname{\ignorespaces #3}% - \setbox1=\hbox{\printedmanual\unskip}% - \setbox0=\hbox{\printedrefname\unskip}% - \ifdim \wd0 = 0pt - % No printed node name was explicitly given. - \expandafter\ifx\csname SETxref-automatic-section-title\endcsname\relax - % Use the node name inside the square brackets. - \def\printedrefname{\ignorespaces #1}% - \else - % Use the actual chapter/section title appear inside - % the square brackets. Use the real section title if we have it. - \ifdim \wd1 > 0pt - % It is in another manual, so we don't have it. - \def\printedrefname{\ignorespaces #1}% - \else - \ifhavexrefs - % We know the real title if we have the xref values. - \def\printedrefname{\refx{#1-title}{}}% - \else - % Otherwise just copy the Info node name. - \def\printedrefname{\ignorespaces #1}% - \fi% - \fi - \fi - \fi - % - % Make link in pdf output. - \ifpdf - \leavevmode - \getfilename{#4}% - {\turnoffactive - % See comments at \activebackslashdouble. - {\activebackslashdouble \xdef\pdfxrefdest{#1}% - \backslashparens\pdfxrefdest}% - % - \ifnum\filenamelength>0 - \startlink attr{/Border [0 0 0]}% - goto file{\the\filename.pdf} name{\pdfxrefdest}% - \else - \startlink attr{/Border [0 0 0]}% - goto name{\pdfmkpgn{\pdfxrefdest}}% - \fi - }% - \linkcolor - \fi - % - % Float references are printed completely differently: "Figure 1.2" - % instead of "[somenode], p.3". We distinguish them by the - % LABEL-title being set to a magic string. - {% - % Have to otherify everything special to allow the \csname to - % include an _ in the xref name, etc. - \indexnofonts - \turnoffactive - \expandafter\global\expandafter\let\expandafter\Xthisreftitle - \csname XR#1-title\endcsname - }% - \iffloat\Xthisreftitle - % If the user specified the print name (third arg) to the ref, - % print it instead of our usual "Figure 1.2". - \ifdim\wd0 = 0pt - \refx{#1-snt}{}% - \else - \printedrefname - \fi - % - % if the user also gave the printed manual name (fifth arg), append - % "in MANUALNAME". - \ifdim \wd1 > 0pt - \space \putwordin{} \cite{\printedmanual}% - \fi - \else - % node/anchor (non-float) references. - % - % If we use \unhbox0 and \unhbox1 to print the node names, TeX does not - % insert empty discretionaries after hyphens, which means that it will - % not find a line break at a hyphen in a node names. Since some manuals - % are best written with fairly long node names, containing hyphens, this - % is a loss. Therefore, we give the text of the node name again, so it - % is as if TeX is seeing it for the first time. - \ifdim \wd1 > 0pt - \putwordsection{} ``\printedrefname'' \putwordin{} \cite{\printedmanual}% - \else - % _ (for example) has to be the character _ for the purposes of the - % control sequence corresponding to the node, but it has to expand - % into the usual \leavevmode...\vrule stuff for purposes of - % printing. So we \turnoffactive for the \refx-snt, back on for the - % printing, back off for the \refx-pg. - {\turnoffactive - % Only output a following space if the -snt ref is nonempty; for - % @unnumbered and @anchor, it won't be. - \setbox2 = \hbox{\ignorespaces \refx{#1-snt}{}}% - \ifdim \wd2 > 0pt \refx{#1-snt}\space\fi - }% - % output the `[mynode]' via a macro so it can be overridden. - \xrefprintnodename\printedrefname - % - % But we always want a comma and a space: - ,\space - % - % output the `page 3'. - \turnoffactive \putwordpage\tie\refx{#1-pg}{}% - \fi - \fi - \endlink -\endgroup} - -% This macro is called from \xrefX for the `[nodename]' part of xref -% output. It's a separate macro only so it can be changed more easily, -% since square brackets don't work well in some documents. Particularly -% one that Bob is working on :). -% -\def\xrefprintnodename#1{[#1]} - -% Things referred to by \setref. -% -\def\Ynothing{} -\def\Yomitfromtoc{} -\def\Ynumbered{% - \ifnum\secno=0 - \putwordChapter@tie \the\chapno - \else \ifnum\subsecno=0 - \putwordSection@tie \the\chapno.\the\secno - \else \ifnum\subsubsecno=0 - \putwordSection@tie \the\chapno.\the\secno.\the\subsecno - \else - \putwordSection@tie \the\chapno.\the\secno.\the\subsecno.\the\subsubsecno - \fi\fi\fi -} -\def\Yappendix{% - \ifnum\secno=0 - \putwordAppendix@tie @char\the\appendixno{}% - \else \ifnum\subsecno=0 - \putwordSection@tie @char\the\appendixno.\the\secno - \else \ifnum\subsubsecno=0 - \putwordSection@tie @char\the\appendixno.\the\secno.\the\subsecno - \else - \putwordSection@tie - @char\the\appendixno.\the\secno.\the\subsecno.\the\subsubsecno - \fi\fi\fi -} - -% Define \refx{NAME}{SUFFIX} to reference a cross-reference string named NAME. -% If its value is nonempty, SUFFIX is output afterward. -% -\def\refx#1#2{% - {% - \indexnofonts - \otherbackslash - \expandafter\global\expandafter\let\expandafter\thisrefX - \csname XR#1\endcsname - }% - \ifx\thisrefX\relax - % If not defined, say something at least. - \angleleft un\-de\-fined\angleright - \iflinks - \ifhavexrefs - \message{\linenumber Undefined cross reference `#1'.}% - \else - \ifwarnedxrefs\else - \global\warnedxrefstrue - \message{Cross reference values unknown; you must run TeX again.}% - \fi - \fi - \fi - \else - % It's defined, so just use it. - \thisrefX - \fi - #2% Output the suffix in any case. -} - -% This is the macro invoked by entries in the aux file. Usually it's -% just a \def (we prepend XR to the control sequence name to avoid -% collisions). But if this is a float type, we have more work to do. -% -\def\xrdef#1#2{% - \expandafter\gdef\csname XR#1\endcsname{#2}% remember this xref value. - % - % Was that xref control sequence that we just defined for a float? - \expandafter\iffloat\csname XR#1\endcsname - % it was a float, and we have the (safe) float type in \iffloattype. - \expandafter\let\expandafter\floatlist - \csname floatlist\iffloattype\endcsname - % - % Is this the first time we've seen this float type? - \expandafter\ifx\floatlist\relax - \toks0 = {\do}% yes, so just \do - \else - % had it before, so preserve previous elements in list. - \toks0 = \expandafter{\floatlist\do}% - \fi - % - % Remember this xref in the control sequence \floatlistFLOATTYPE, - % for later use in \listoffloats. - \expandafter\xdef\csname floatlist\iffloattype\endcsname{\the\toks0{#1}}% - \fi -} - -% Read the last existing aux file, if any. No error if none exists. -% -\def\tryauxfile{% - \openin 1 \jobname.aux - \ifeof 1 \else - \readdatafile{aux}% - \global\havexrefstrue - \fi - \closein 1 -} - -\def\setupdatafile{% - \catcode`\^^@=\other - \catcode`\^^A=\other - \catcode`\^^B=\other - \catcode`\^^C=\other - \catcode`\^^D=\other - \catcode`\^^E=\other - \catcode`\^^F=\other - \catcode`\^^G=\other - \catcode`\^^H=\other - \catcode`\^^K=\other - \catcode`\^^L=\other - \catcode`\^^N=\other - \catcode`\^^P=\other - \catcode`\^^Q=\other - \catcode`\^^R=\other - \catcode`\^^S=\other - \catcode`\^^T=\other - \catcode`\^^U=\other - \catcode`\^^V=\other - \catcode`\^^W=\other - \catcode`\^^X=\other - \catcode`\^^Z=\other - \catcode`\^^[=\other - \catcode`\^^\=\other - \catcode`\^^]=\other - \catcode`\^^^=\other - \catcode`\^^_=\other - % It was suggested to set the catcode of ^ to 7, which would allow ^^e4 etc. - % in xref tags, i.e., node names. But since ^^e4 notation isn't - % supported in the main text, it doesn't seem desirable. Furthermore, - % that is not enough: for node names that actually contain a ^ - % character, we would end up writing a line like this: 'xrdef {'hat - % b-title}{'hat b} and \xrdef does a \csname...\endcsname on the first - % argument, and \hat is not an expandable control sequence. It could - % all be worked out, but why? Either we support ^^ or we don't. - % - % The other change necessary for this was to define \auxhat: - % \def\auxhat{\def^{'hat }}% extra space so ok if followed by letter - % and then to call \auxhat in \setq. - % - \catcode`\^=\other - % - % Special characters. Should be turned off anyway, but... - \catcode`\~=\other - \catcode`\[=\other - \catcode`\]=\other - \catcode`\"=\other - \catcode`\_=\other - \catcode`\|=\other - \catcode`\<=\other - \catcode`\>=\other - \catcode`\$=\other - \catcode`\#=\other - \catcode`\&=\other - \catcode`\%=\other - \catcode`+=\other % avoid \+ for paranoia even though we've turned it off - % - % This is to support \ in node names and titles, since the \ - % characters end up in a \csname. It's easier than - % leaving it active and making its active definition an actual \ - % character. What I don't understand is why it works in the *value* - % of the xrdef. Seems like it should be a catcode12 \, and that - % should not typeset properly. But it works, so I'm moving on for - % now. --karl, 15jan04. - \catcode`\\=\other - % - % Make the characters 128-255 be printing characters. - {% - \count1=128 - \def\loop{% - \catcode\count1=\other - \advance\count1 by 1 - \ifnum \count1<256 \loop \fi - }% - }% - % - % @ is our escape character in .aux files, and we need braces. - \catcode`\{=1 - \catcode`\}=2 - \catcode`\@=0 -} - -\def\readdatafile#1{% -\begingroup - \setupdatafile - \input\jobname.#1 -\endgroup} - -\message{insertions,} -% including footnotes. - -\newcount \footnoteno - -% The trailing space in the following definition for supereject is -% vital for proper filling; pages come out unaligned when you do a -% pagealignmacro call if that space before the closing brace is -% removed. (Generally, numeric constants should always be followed by a -% space to prevent strange expansion errors.) -\def\supereject{\par\penalty -20000\footnoteno =0 } - -% @footnotestyle is meaningful for info output only. -\let\footnotestyle=\comment - -{\catcode `\@=11 -% -% Auto-number footnotes. Otherwise like plain. -\gdef\footnote{% - \let\indent=\ptexindent - \let\noindent=\ptexnoindent - \global\advance\footnoteno by \@ne - \edef\thisfootno{$^{\the\footnoteno}$}% - % - % In case the footnote comes at the end of a sentence, preserve the - % extra spacing after we do the footnote number. - \let\@sf\empty - \ifhmode\edef\@sf{\spacefactor\the\spacefactor}\ptexslash\fi - % - % Remove inadvertent blank space before typesetting the footnote number. - \unskip - \thisfootno\@sf - \dofootnote -}% - -% Don't bother with the trickery in plain.tex to not require the -% footnote text as a parameter. Our footnotes don't need to be so general. -% -% Oh yes, they do; otherwise, @ifset (and anything else that uses -% \parseargline) fails inside footnotes because the tokens are fixed when -% the footnote is read. --karl, 16nov96. -% -\gdef\dofootnote{% - \insert\footins\bgroup - % We want to typeset this text as a normal paragraph, even if the - % footnote reference occurs in (for example) a display environment. - % So reset some parameters. - \hsize=\pagewidth - \interlinepenalty\interfootnotelinepenalty - \splittopskip\ht\strutbox % top baseline for broken footnotes - \splitmaxdepth\dp\strutbox - \floatingpenalty\@MM - \leftskip\z@skip - \rightskip\z@skip - \spaceskip\z@skip - \xspaceskip\z@skip - \parindent\defaultparindent - % - \smallfonts \rm - % - % Because we use hanging indentation in footnotes, a @noindent appears - % to exdent this text, so make it be a no-op. makeinfo does not use - % hanging indentation so @noindent can still be needed within footnote - % text after an @example or the like (not that this is good style). - \let\noindent = \relax - % - % Hang the footnote text off the number. Use \everypar in case the - % footnote extends for more than one paragraph. - \everypar = {\hang}% - \textindent{\thisfootno}% - % - % Don't crash into the line above the footnote text. Since this - % expands into a box, it must come within the paragraph, lest it - % provide a place where TeX can split the footnote. - \footstrut - \futurelet\next\fo@t -} -}%end \catcode `\@=11 - -% In case a @footnote appears in a vbox, save the footnote text and create -% the real \insert just after the vbox finished. Otherwise, the insertion -% would be lost. -% Similarily, if a @footnote appears inside an alignment, save the footnote -% text to a box and make the \insert when a row of the table is finished. -% And the same can be done for other insert classes. --kasal, 16nov03. - -% Replace the \insert primitive by a cheating macro. -% Deeper inside, just make sure that the saved insertions are not spilled -% out prematurely. -% -\def\startsavinginserts{% - \ifx \insert\ptexinsert - \let\insert\saveinsert - \else - \let\checkinserts\relax - \fi -} - -% This \insert replacement works for both \insert\footins{foo} and -% \insert\footins\bgroup foo\egroup, but it doesn't work for \insert27{foo}. -% -\def\saveinsert#1{% - \edef\next{\noexpand\savetobox \makeSAVEname#1}% - \afterassignment\next - % swallow the left brace - \let\temp = -} -\def\makeSAVEname#1{\makecsname{SAVE\expandafter\gobble\string#1}} -\def\savetobox#1{\global\setbox#1 = \vbox\bgroup \unvbox#1} - -\def\checksaveins#1{\ifvoid#1\else \placesaveins#1\fi} - -\def\placesaveins#1{% - \ptexinsert \csname\expandafter\gobblesave\string#1\endcsname - {\box#1}% -} - -% eat @SAVE -- beware, all of them have catcode \other: -{ - \def\dospecials{\do S\do A\do V\do E} \uncatcodespecials % ;-) - \gdef\gobblesave @SAVE{} -} - -% initialization: -\def\newsaveins #1{% - \edef\next{\noexpand\newsaveinsX \makeSAVEname#1}% - \next -} -\def\newsaveinsX #1{% - \csname newbox\endcsname #1% - \expandafter\def\expandafter\checkinserts\expandafter{\checkinserts - \checksaveins #1}% -} - -% initialize: -\let\checkinserts\empty -\newsaveins\footins -\newsaveins\margin - - -% @image. We use the macros from epsf.tex to support this. -% If epsf.tex is not installed and @image is used, we complain. -% -% Check for and read epsf.tex up front. If we read it only at @image -% time, we might be inside a group, and then its definitions would get -% undone and the next image would fail. -\openin 1 = epsf.tex -\ifeof 1 \else - % Do not bother showing banner with epsf.tex v2.7k (available in - % doc/epsf.tex and on ctan). - \def\epsfannounce{\toks0 = }% - \input epsf.tex -\fi -\closein 1 -% -% We will only complain once about lack of epsf.tex. -\newif\ifwarnednoepsf -\newhelp\noepsfhelp{epsf.tex must be installed for images to - work. It is also included in the Texinfo distribution, or you can get - it from ftp://tug.org/tex/epsf.tex.} -% -\def\image#1{% - \ifx\epsfbox\undefined - \ifwarnednoepsf \else - \errhelp = \noepsfhelp - \errmessage{epsf.tex not found, images will be ignored}% - \global\warnednoepsftrue - \fi - \else - \imagexxx #1,,,,,\finish - \fi -} -% -% Arguments to @image: -% #1 is (mandatory) image filename; we tack on .eps extension. -% #2 is (optional) width, #3 is (optional) height. -% #4 is (ignored optional) html alt text. -% #5 is (ignored optional) extension. -% #6 is just the usual extra ignored arg for parsing this stuff. -\newif\ifimagevmode -\def\imagexxx#1,#2,#3,#4,#5,#6\finish{\begingroup - \catcode`\^^M = 5 % in case we're inside an example - \normalturnoffactive % allow _ et al. in names - % If the image is by itself, center it. - \ifvmode - \imagevmodetrue - \nobreak\bigskip - % Usually we'll have text after the image which will insert - % \parskip glue, so insert it here too to equalize the space - % above and below. - \nobreak\vskip\parskip - \nobreak - \line\bgroup - \fi - % - % Output the image. - \ifpdf - \dopdfimage{#1}{#2}{#3}% - \else - % \epsfbox itself resets \epsf?size at each figure. - \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \epsfxsize=#2\relax \fi - \setbox0 = \hbox{\ignorespaces #3}\ifdim\wd0 > 0pt \epsfysize=#3\relax \fi - \epsfbox{#1.eps}% - \fi - % - \ifimagevmode \egroup \bigbreak \fi % space after the image -\endgroup} - - -% @float FLOATTYPE,LABEL,LOC ... @end float for displayed figures, tables, -% etc. We don't actually implement floating yet, we always include the -% float "here". But it seemed the best name for the future. -% -\envparseargdef\float{\eatcommaspace\eatcommaspace\dofloat#1, , ,\finish} - -% There may be a space before second and/or third parameter; delete it. -\def\eatcommaspace#1, {#1,} - -% #1 is the optional FLOATTYPE, the text label for this float, typically -% "Figure", "Table", "Example", etc. Can't contain commas. If omitted, -% this float will not be numbered and cannot be referred to. -% -% #2 is the optional xref label. Also must be present for the float to -% be referable. -% -% #3 is the optional positioning argument; for now, it is ignored. It -% will somehow specify the positions allowed to float to (here, top, bottom). -% -% We keep a separate counter for each FLOATTYPE, which we reset at each -% chapter-level command. -\let\resetallfloatnos=\empty -% -\def\dofloat#1,#2,#3,#4\finish{% - \let\thiscaption=\empty - \let\thisshortcaption=\empty - % - % don't lose footnotes inside @float. - % - % BEWARE: when the floats start float, we have to issue warning whenever an - % insert appears inside a float which could possibly float. --kasal, 26may04 - % - \startsavinginserts - % - % We can't be used inside a paragraph. - \par - % - \vtop\bgroup - \def\floattype{#1}% - \def\floatlabel{#2}% - \def\floatloc{#3}% we do nothing with this yet. - % - \ifx\floattype\empty - \let\safefloattype=\empty - \else - {% - % the floattype might have accents or other special characters, - % but we need to use it in a control sequence name. - \indexnofonts - \turnoffactive - \xdef\safefloattype{\floattype}% - }% - \fi - % - % If label is given but no type, we handle that as the empty type. - \ifx\floatlabel\empty \else - % We want each FLOATTYPE to be numbered separately (Figure 1, - % Table 1, Figure 2, ...). (And if no label, no number.) - % - \expandafter\getfloatno\csname\safefloattype floatno\endcsname - \global\advance\floatno by 1 - % - {% - % This magic value for \thissection is output by \setref as the - % XREFLABEL-title value. \xrefX uses it to distinguish float - % labels (which have a completely different output format) from - % node and anchor labels. And \xrdef uses it to construct the - % lists of floats. - % - \edef\thissection{\floatmagic=\safefloattype}% - \setref{\floatlabel}{Yfloat}% - }% - \fi - % - % start with \parskip glue, I guess. - \vskip\parskip - % - % Don't suppress indentation if a float happens to start a section. - \restorefirstparagraphindent -} - -% we have these possibilities: -% @float Foo,lbl & @caption{Cap}: Foo 1.1: Cap -% @float Foo,lbl & no caption: Foo 1.1 -% @float Foo & @caption{Cap}: Foo: Cap -% @float Foo & no caption: Foo -% @float ,lbl & Caption{Cap}: 1.1: Cap -% @float ,lbl & no caption: 1.1 -% @float & @caption{Cap}: Cap -% @float & no caption: -% -\def\Efloat{% - \let\floatident = \empty - % - % In all cases, if we have a float type, it comes first. - \ifx\floattype\empty \else \def\floatident{\floattype}\fi - % - % If we have an xref label, the number comes next. - \ifx\floatlabel\empty \else - \ifx\floattype\empty \else % if also had float type, need tie first. - \appendtomacro\floatident{\tie}% - \fi - % the number. - \appendtomacro\floatident{\chaplevelprefix\the\floatno}% - \fi - % - % Start the printed caption with what we've constructed in - % \floatident, but keep it separate; we need \floatident again. - \let\captionline = \floatident - % - \ifx\thiscaption\empty \else - \ifx\floatident\empty \else - \appendtomacro\captionline{: }% had ident, so need a colon between - \fi - % - % caption text. - \appendtomacro\captionline{\scanexp\thiscaption}% - \fi - % - % If we have anything to print, print it, with space before. - % Eventually this needs to become an \insert. - \ifx\captionline\empty \else - \vskip.5\parskip - \captionline - % - % Space below caption. - \vskip\parskip - \fi - % - % If have an xref label, write the list of floats info. Do this - % after the caption, to avoid chance of it being a breakpoint. - \ifx\floatlabel\empty \else - % Write the text that goes in the lof to the aux file as - % \floatlabel-lof. Besides \floatident, we include the short - % caption if specified, else the full caption if specified, else nothing. - {% - \atdummies - % - % since we read the caption text in the macro world, where ^^M - % is turned into a normal character, we have to scan it back, so - % we don't write the literal three characters "^^M" into the aux file. - \scanexp{% - \xdef\noexpand\gtemp{% - \ifx\thisshortcaption\empty - \thiscaption - \else - \thisshortcaption - \fi - }% - }% - \immediate\write\auxfile{@xrdef{\floatlabel-lof}{\floatident - \ifx\gtemp\empty \else : \gtemp \fi}}% - }% - \fi - \egroup % end of \vtop - % - % place the captured inserts - % - % BEWARE: when the floats start floating, we have to issue warning - % whenever an insert appears inside a float which could possibly - % float. --kasal, 26may04 - % - \checkinserts -} - -% Append the tokens #2 to the definition of macro #1, not expanding either. -% -\def\appendtomacro#1#2{% - \expandafter\def\expandafter#1\expandafter{#1#2}% -} - -% @caption, @shortcaption -% -\def\caption{\docaption\thiscaption} -\def\shortcaption{\docaption\thisshortcaption} -\def\docaption{\checkenv\float \bgroup\scanargctxt\defcaption} -\def\defcaption#1#2{\egroup \def#1{#2}} - -% The parameter is the control sequence identifying the counter we are -% going to use. Create it if it doesn't exist and assign it to \floatno. -\def\getfloatno#1{% - \ifx#1\relax - % Haven't seen this figure type before. - \csname newcount\endcsname #1% - % - % Remember to reset this floatno at the next chap. - \expandafter\gdef\expandafter\resetallfloatnos - \expandafter{\resetallfloatnos #1=0 }% - \fi - \let\floatno#1% -} - -% \setref calls this to get the XREFLABEL-snt value. We want an @xref -% to the FLOATLABEL to expand to "Figure 3.1". We call \setref when we -% first read the @float command. -% -\def\Yfloat{\floattype@tie \chaplevelprefix\the\floatno}% - -% Magic string used for the XREFLABEL-title value, so \xrefX can -% distinguish floats from other xref types. -\def\floatmagic{!!float!!} - -% #1 is the control sequence we are passed; we expand into a conditional -% which is true if #1 represents a float ref. That is, the magic -% \thissection value which we \setref above. -% -\def\iffloat#1{\expandafter\doiffloat#1==\finish} -% -% #1 is (maybe) the \floatmagic string. If so, #2 will be the -% (safe) float type for this float. We set \iffloattype to #2. -% -\def\doiffloat#1=#2=#3\finish{% - \def\temp{#1}% - \def\iffloattype{#2}% - \ifx\temp\floatmagic -} - -% @listoffloats FLOATTYPE - print a list of floats like a table of contents. -% -\parseargdef\listoffloats{% - \def\floattype{#1}% floattype - {% - % the floattype might have accents or other special characters, - % but we need to use it in a control sequence name. - \indexnofonts - \turnoffactive - \xdef\safefloattype{\floattype}% - }% - % - % \xrdef saves the floats as a \do-list in \floatlistSAFEFLOATTYPE. - \expandafter\ifx\csname floatlist\safefloattype\endcsname \relax - \ifhavexrefs - % if the user said @listoffloats foo but never @float foo. - \message{\linenumber No `\safefloattype' floats to list.}% - \fi - \else - \begingroup - \leftskip=\tocindent % indent these entries like a toc - \let\do=\listoffloatsdo - \csname floatlist\safefloattype\endcsname - \endgroup - \fi -} - -% This is called on each entry in a list of floats. We're passed the -% xref label, in the form LABEL-title, which is how we save it in the -% aux file. We strip off the -title and look up \XRLABEL-lof, which -% has the text we're supposed to typeset here. -% -% Figures without xref labels will not be included in the list (since -% they won't appear in the aux file). -% -\def\listoffloatsdo#1{\listoffloatsdoentry#1\finish} -\def\listoffloatsdoentry#1-title\finish{{% - % Can't fully expand XR#1-lof because it can contain anything. Just - % pass the control sequence. On the other hand, XR#1-pg is just the - % page number, and we want to fully expand that so we can get a link - % in pdf output. - \toksA = \expandafter{\csname XR#1-lof\endcsname}% - % - % use the same \entry macro we use to generate the TOC and index. - \edef\writeentry{\noexpand\entry{\the\toksA}{\csname XR#1-pg\endcsname}}% - \writeentry -}} - -\message{localization,} -% and i18n. - -% @documentlanguage is usually given very early, just after -% @setfilename. If done too late, it may not override everything -% properly. Single argument is the language abbreviation. -% It would be nice if we could set up a hyphenation file here. -% -\parseargdef\documentlanguage{% - \tex % read txi-??.tex file in plain TeX. - % Read the file if it exists. - \openin 1 txi-#1.tex - \ifeof 1 - \errhelp = \nolanghelp - \errmessage{Cannot read language file txi-#1.tex}% - \else - \input txi-#1.tex - \fi - \closein 1 - \endgroup -} -\newhelp\nolanghelp{The given language definition file cannot be found or -is empty. Maybe you need to install it? In the current directory -should work if nowhere else does.} - - -% @documentencoding should change something in TeX eventually, most -% likely, but for now just recognize it. -\let\documentencoding = \comment - - -% Page size parameters. -% -\newdimen\defaultparindent \defaultparindent = 15pt - -\chapheadingskip = 15pt plus 4pt minus 2pt -\secheadingskip = 12pt plus 3pt minus 2pt -\subsecheadingskip = 9pt plus 2pt minus 2pt - -% Prevent underfull vbox error messages. -\vbadness = 10000 - -% Don't be so finicky about underfull hboxes, either. -\hbadness = 2000 - -% Following George Bush, just get rid of widows and orphans. -\widowpenalty=10000 -\clubpenalty=10000 - -% Use TeX 3.0's \emergencystretch to help line breaking, but if we're -% using an old version of TeX, don't do anything. We want the amount of -% stretch added to depend on the line length, hence the dependence on -% \hsize. We call this whenever the paper size is set. -% -\def\setemergencystretch{% - \ifx\emergencystretch\thisisundefined - % Allow us to assign to \emergencystretch anyway. - \def\emergencystretch{\dimen0}% - \else - \emergencystretch = .15\hsize - \fi -} - -% Parameters in order: 1) textheight; 2) textwidth; -% 3) voffset; 4) hoffset; 5) binding offset; 6) topskip; -% 7) physical page height; 8) physical page width. -% -% We also call \setleading{\textleading}, so the caller should define -% \textleading. The caller should also set \parskip. -% -\def\internalpagesizes#1#2#3#4#5#6#7#8{% - \voffset = #3\relax - \topskip = #6\relax - \splittopskip = \topskip - % - \vsize = #1\relax - \advance\vsize by \topskip - \outervsize = \vsize - \advance\outervsize by 2\topandbottommargin - \pageheight = \vsize - % - \hsize = #2\relax - \outerhsize = \hsize - \advance\outerhsize by 0.5in - \pagewidth = \hsize - % - \normaloffset = #4\relax - \bindingoffset = #5\relax - % - \ifpdf - \pdfpageheight #7\relax - \pdfpagewidth #8\relax - \fi - % - \setleading{\textleading} - % - \parindent = \defaultparindent - \setemergencystretch -} - -% @letterpaper (the default). -\def\letterpaper{{\globaldefs = 1 - \parskip = 3pt plus 2pt minus 1pt - \textleading = 13.2pt - % - % If page is nothing but text, make it come out even. - \internalpagesizes{46\baselineskip}{6in}% - {\voffset}{.25in}% - {\bindingoffset}{36pt}% - {11in}{8.5in}% -}} - -% Use @smallbook to reset parameters for 7x9.25 trim size. -\def\smallbook{{\globaldefs = 1 - \parskip = 2pt plus 1pt - \textleading = 12pt - % - \internalpagesizes{7.5in}{5in}% - {\voffset}{.25in}% - {\bindingoffset}{16pt}% - {9.25in}{7in}% - % - \lispnarrowing = 0.3in - \tolerance = 700 - \hfuzz = 1pt - \contentsrightmargin = 0pt - \defbodyindent = .5cm -}} - -% Use @smallerbook to reset parameters for 6x9 trim size. -% (Just testing, parameters still in flux.) -\def\smallerbook{{\globaldefs = 1 - \parskip = 1.5pt plus 1pt - \textleading = 12pt - % - \internalpagesizes{7.4in}{4.8in}% - {-.2in}{-.4in}% - {0pt}{14pt}% - {9in}{6in}% - % - \lispnarrowing = 0.25in - \tolerance = 700 - \hfuzz = 1pt - \contentsrightmargin = 0pt - \defbodyindent = .4cm -}} - -% Use @afourpaper to print on European A4 paper. -\def\afourpaper{{\globaldefs = 1 - \parskip = 3pt plus 2pt minus 1pt - \textleading = 13.2pt - % - % Double-side printing via postscript on Laserjet 4050 - % prints double-sided nicely when \bindingoffset=10mm and \hoffset=-6mm. - % To change the settings for a different printer or situation, adjust - % \normaloffset until the front-side and back-side texts align. Then - % do the same for \bindingoffset. You can set these for testing in - % your texinfo source file like this: - % @tex - % \global\normaloffset = -6mm - % \global\bindingoffset = 10mm - % @end tex - \internalpagesizes{51\baselineskip}{160mm} - {\voffset}{\hoffset}% - {\bindingoffset}{44pt}% - {297mm}{210mm}% - % - \tolerance = 700 - \hfuzz = 1pt - \contentsrightmargin = 0pt - \defbodyindent = 5mm -}} - -% Use @afivepaper to print on European A5 paper. -% From romildo@urano.iceb.ufop.br, 2 July 2000. -% He also recommends making @example and @lisp be small. -\def\afivepaper{{\globaldefs = 1 - \parskip = 2pt plus 1pt minus 0.1pt - \textleading = 12.5pt - % - \internalpagesizes{160mm}{120mm}% - {\voffset}{\hoffset}% - {\bindingoffset}{8pt}% - {210mm}{148mm}% - % - \lispnarrowing = 0.2in - \tolerance = 800 - \hfuzz = 1.2pt - \contentsrightmargin = 0pt - \defbodyindent = 2mm - \tableindent = 12mm -}} - -% A specific text layout, 24x15cm overall, intended for A4 paper. -\def\afourlatex{{\globaldefs = 1 - \afourpaper - \internalpagesizes{237mm}{150mm}% - {\voffset}{4.6mm}% - {\bindingoffset}{7mm}% - {297mm}{210mm}% - % - % Must explicitly reset to 0 because we call \afourpaper. - \globaldefs = 0 -}} - -% Use @afourwide to print on A4 paper in landscape format. -\def\afourwide{{\globaldefs = 1 - \afourpaper - \internalpagesizes{241mm}{165mm}% - {\voffset}{-2.95mm}% - {\bindingoffset}{7mm}% - {297mm}{210mm}% - \globaldefs = 0 -}} - -% @pagesizes TEXTHEIGHT[,TEXTWIDTH] -% Perhaps we should allow setting the margins, \topskip, \parskip, -% and/or leading, also. Or perhaps we should compute them somehow. -% -\parseargdef\pagesizes{\pagesizesyyy #1,,\finish} -\def\pagesizesyyy#1,#2,#3\finish{{% - \setbox0 = \hbox{\ignorespaces #2}\ifdim\wd0 > 0pt \hsize=#2\relax \fi - \globaldefs = 1 - % - \parskip = 3pt plus 2pt minus 1pt - \setleading{\textleading}% - % - \dimen0 = #1 - \advance\dimen0 by \voffset - % - \dimen2 = \hsize - \advance\dimen2 by \normaloffset - % - \internalpagesizes{#1}{\hsize}% - {\voffset}{\normaloffset}% - {\bindingoffset}{44pt}% - {\dimen0}{\dimen2}% -}} - -% Set default to letter. -% -\letterpaper - - -\message{and turning on texinfo input format.} - -% Define macros to output various characters with catcode for normal text. -\catcode`\"=\other -\catcode`\~=\other -\catcode`\^=\other -\catcode`\_=\other -\catcode`\|=\other -\catcode`\<=\other -\catcode`\>=\other -\catcode`\+=\other -\catcode`\$=\other -\def\normaldoublequote{"} -\def\normaltilde{~} -\def\normalcaret{^} -\def\normalunderscore{_} -\def\normalverticalbar{|} -\def\normalless{<} -\def\normalgreater{>} -\def\normalplus{+} -\def\normaldollar{$}%$ font-lock fix - -% This macro is used to make a character print one way in \tt -% (where it can probably be output as-is), and another way in other fonts, -% where something hairier probably needs to be done. -% -% #1 is what to print if we are indeed using \tt; #2 is what to print -% otherwise. Since all the Computer Modern typewriter fonts have zero -% interword stretch (and shrink), and it is reasonable to expect all -% typewriter fonts to have this, we can check that font parameter. -% -\def\ifusingtt#1#2{\ifdim \fontdimen3\font=0pt #1\else #2\fi} - -% Same as above, but check for italic font. Actually this also catches -% non-italic slanted fonts since it is impossible to distinguish them from -% italic fonts. But since this is only used by $ and it uses \sl anyway -% this is not a problem. -\def\ifusingit#1#2{\ifdim \fontdimen1\font>0pt #1\else #2\fi} - -% Turn off all special characters except @ -% (and those which the user can use as if they were ordinary). -% Most of these we simply print from the \tt font, but for some, we can -% use math or other variants that look better in normal text. - -\catcode`\"=\active -\def\activedoublequote{{\tt\char34}} -\let"=\activedoublequote -\catcode`\~=\active -\def~{{\tt\char126}} -\chardef\hat=`\^ -\catcode`\^=\active -\def^{{\tt \hat}} - -\catcode`\_=\active -\def_{\ifusingtt\normalunderscore\_} -\let\realunder=_ -% Subroutine for the previous macro. -\def\_{\leavevmode \kern.07em \vbox{\hrule width.3em height.1ex}\kern .07em } - -\catcode`\|=\active -\def|{{\tt\char124}} -\chardef \less=`\< -\catcode`\<=\active -\def<{{\tt \less}} -\chardef \gtr=`\> -\catcode`\>=\active -\def>{{\tt \gtr}} -\catcode`\+=\active -\def+{{\tt \char 43}} -\catcode`\$=\active -\def${\ifusingit{{\sl\$}}\normaldollar}%$ font-lock fix - -% If a .fmt file is being used, characters that might appear in a file -% name cannot be active until we have parsed the command line. -% So turn them off again, and have \everyjob (or @setfilename) turn them on. -% \otherifyactive is called near the end of this file. -\def\otherifyactive{\catcode`+=\other \catcode`\_=\other} - -% Used sometimes to turn off (effectively) the active characters even after -% parsing them. -\def\turnoffactive{% - \normalturnoffactive - \otherbackslash -} - -\catcode`\@=0 - -% \backslashcurfont outputs one backslash character in current font, -% as in \char`\\. -\global\chardef\backslashcurfont=`\\ -\global\let\rawbackslashxx=\backslashcurfont % let existing .??s files work - -% \realbackslash is an actual character `\' with catcode other, and -% \doublebackslash is two of them (for the pdf outlines). -{\catcode`\\=\other @gdef@realbackslash{\} @gdef@doublebackslash{\\}} - -% In texinfo, backslash is an active character; it prints the backslash -% in fixed width font. -\catcode`\\=\active -@def@normalbackslash{{@tt@backslashcurfont}} -% 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. -@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 -} - -% Make _ and + \other characters, temporarily. -% This is canceled by @fixbackslash. -@otherifyactive - -% If a .fmt file is being used, we don't want the `\input texinfo' to show up. -% That is what \eatinput is for; after that, the `\' should revert to printing -% a backslash. -% -@gdef@eatinput input texinfo{@fixbackslash} -@global@let\ = @eatinput - -% On the other hand, perhaps the file did not have a `\input texinfo'. Then -% the first `\' in the file would cause an error. This macro tries to fix -% that, assuming it is called before the first `\' could plausibly occur. -% Also turn back on active characters that might appear in the input -% file name, in case not using a pre-dumped format. -% -@gdef@fixbackslash{% - @ifx\@eatinput @let\ = @normalbackslash @fi - @catcode`+=@active - @catcode`@_=@active -} - -% Say @foo, not \foo, in error messages. -@escapechar = `@@ - -% These look ok in all fonts, so just make them not special. -@catcode`@& = @other -@catcode`@# = @other -@catcode`@% = @other - - -@c Local variables: -@c eval: (add-hook 'write-file-hooks 'time-stamp) -@c page-delimiter: "^\\\\message" -@c time-stamp-start: "def\\\\texinfoversion{" -@c time-stamp-format: "%:y-%02m-%02d.%02H" -@c time-stamp-end: "}" -@c End: - -@c vim:sw=2: - -@ignore - arch-tag: e1b36e32-c96e-4135-a41a-0b2efa2ea115 -@end ignore diff --git a/docker/Dockerfile b/docker/Dockerfile index ec8f089..80ed7f3 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -16,10 +16,9 @@ # Build docker image: `docker build -t stowtest` # Run tests: (from stow src directory) # `docker run --rm -it -v $(pwd):$(pwd) -w $(pwd) stowtest` -FROM debian:jessie -RUN printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list +FROM debian:bookworm +RUN DEBIAN_FRONTEND=noninteractive apt-get update -qq RUN DEBIAN_FRONTEND=noninteractive \ -apt-get update -qq && \ apt-get install -y -q \ autoconf \ bzip2 \ diff --git a/lib/Stow.pm.in b/lib/Stow.pm.in index 87a25e1..b9b3b30 100755 --- a/lib/Stow.pm.in +++ b/lib/Stow.pm.in @@ -56,7 +56,8 @@ use File::Spec; use POSIX qw(getcwd); use Stow::Util qw(set_debug_level debug error set_test_mode - join_paths restore_cwd canon_path parent adjust_dotfile); + join_paths restore_cwd canon_path parent + adjust_dotfile unadjust_dotfile); our $ProgramName = 'stow'; our $VERSION = '@VERSION@'; @@ -202,10 +203,15 @@ sub set_stow_dir { my $stow_dir = canon_path($self->{dir}); my $target = canon_path($self->{target}); + + # Calculate relative path from target directory to stow directory. + # This will be commonly used as a prefix for constructing and + # recognising symlinks "installed" in the target directory which + # point to package files under the stow directory. $self->{stow_path} = File::Spec->abs2rel($stow_dir, $target); - debug(2, "stow dir is $stow_dir"); - debug(2, "stow dir path relative to target $target is $self->{stow_path}"); + debug(2, 0, "stow dir is $stow_dir"); + debug(2, 0, "stow dir path relative to target $target is $self->{stow_path}"); } sub init_state { @@ -265,29 +271,23 @@ sub plan_unstow { my $self = shift; my @packages = @_; + return unless @packages; + + debug(2, 0, "Planning unstow of: @packages ..."); + $self->within_target_do(sub { for my $package (@packages) { - my $path = join_paths($self->{stow_path}, $package); - if (not -d $path) { + my $pkg_path = join_paths($self->{stow_path}, $package); + if (not -d $pkg_path) { error("The stow directory $self->{stow_path} does not contain package $package"); } - debug(2, "Planning unstow of package $package..."); - if ($self->{compat}) { - $self->unstow_contents_orig( - $self->{stow_path}, - $package, - '.', - ); - } - else { - $self->unstow_contents( - $self->{stow_path}, - $package, - '.', - $path, - ); - } - debug(2, "Planning unstow of package $package... done"); + debug(2, 0, "Planning unstow of package $package..."); + $self->unstow_contents( + $package, + '.', + '.', + ); + debug(2, 0, "Planning unstow of package $package... done"); $self->{action_count}++; } }); @@ -305,36 +305,47 @@ sub plan_stow { my $self = shift; my @packages = @_; + return unless @packages; + + debug(2, 0, "Planning stow of: @packages ..."); + $self->within_target_do(sub { for my $package (@packages) { - my $path = join_paths($self->{stow_path}, $package); - if (not -d $path) { + my $pkg_path = join_paths($self->{stow_path}, $package); + if (not -d $pkg_path) { error("The stow directory $self->{stow_path} does not contain package $package"); } - debug(2, "Planning stow of package $package..."); + debug(2, 0, "Planning stow of package $package..."); $self->stow_contents( $self->{stow_path}, $package, '.', - $path, # source from target - 0, + '.', ); - debug(2, "Planning stow of package $package... done"); + debug(2, 0, "Planning stow of package $package... done"); $self->{action_count}++; } }); } -#===== METHOD =============================================================== -# Name : within_target_do() -# Purpose : execute code within target directory, preserving cwd -# Parameters: $code => anonymous subroutine to execute within target dir -# Returns : n/a -# Throws : n/a -# Comments : This is done to ensure that the consumer of the Stow interface -# : doesn't have to worry about (a) what their cwd is, and -# : (b) that their cwd might change. -#============================================================================ +=head2 within_target_do($code) + +Execute code within target directory, preserving cwd. + +=over 4 + +=item $code + +Anonymous subroutine to execute within target dir. + +=back + +This is done to ensure that the consumer of the Stow interface doesn't +have to worry about (a) what their cwd is, and (b) that their cwd +might change. + +=cut + sub within_target_do { my $self = shift; my ($code) = @_; @@ -342,176 +353,236 @@ sub within_target_do { my $cwd = getcwd(); chdir($self->{target}) or error("Cannot chdir to target tree: $self->{target} ($!)"); - debug(3, "cwd now $self->{target}"); + debug(3, 0, "cwd now $self->{target}"); $self->$code(); restore_cwd($cwd); - debug(3, "cwd restored to $cwd"); + debug(3, 0, "cwd restored to $cwd"); } -#===== METHOD =============================================================== -# Name : stow_contents() -# Purpose : stow the contents of the given directory -# Parameters: $stow_path => relative path from current (i.e. target) directory -# : to the stow dir containing the package to be stowed -# : $package => the package whose contents are being stowed -# : $target => subpath relative to package directory which needs -# : stowing as a symlink at subpath relative to target -# : directory. -# : $source => relative path from the (sub)dir of target -# : to symlink source -# Returns : n/a -# Throws : a fatal error if directory cannot be read -# Comments : stow_node() and stow_contents() are mutually recursive. -# : $source and $target are used for creating the symlink -# : $path is used for folding/unfolding trees as necessary -#============================================================================ +=head2 stow_contents($stow_path, $package, $pkg_subdir, $target_subdir) + +Stow the contents of the given directory. + +=over 4 + +=item $stow_path + +Relative path from current (i.e. target) directory to the stow dir +containing the package to be stowed. This can differ from +C<$self->{stow_path}> when unfolding a (sub)tree which is already +stowed from a package in a different stow directory (see the "Multiple +Stow Directories" section of the manual). + +=item $package + +The package whose contents are being stowed. + +=item $pkg_subdir + +Subdirectory of the installation image in the package directory which +needs stowing as a symlink which points to it. This is relative to +the top-level package directory. + +=item $target_subdir + +Subdirectory of the target directory which either needs a symlink to the +corresponding package subdirectory in the installation image, or if +it's an existing directory, it's an unfolded tree which may need to +be folded or recursed into. + +=back + +C and C are mutually recursive. + +=cut + sub stow_contents { my $self = shift; - my ($stow_path, $package, $target, $source, $level) = @_; + my ($stow_path, $package, $pkg_subdir, $target_subdir) = @_; - # Remove leading $level times .. from $source - my $n = 0; - my $path = join '/', map { (++$n <= $level) ? ( ) : $_ } (split m{/+}, $source); - - return if $self->should_skip_target_which_is_stow_dir($target); + return if $self->should_skip_target($pkg_subdir); my $cwd = getcwd(); - my $msg = "Stowing contents of $path (cwd=$cwd)"; + my $msg = "Stowing contents of $stow_path / $package / $pkg_subdir (cwd=$cwd)"; $msg =~ s!$ENV{HOME}(/|$)!~$1!g; - debug(3, $msg); - debug(4, " => $source"); + debug(3, 0, $msg); + debug(4, 1, "target subdir is $target_subdir"); - error("stow_contents() called with non-directory path: $path") - unless -d $path; - error("stow_contents() called with non-directory target: $target") - unless $self->is_a_node($target); + # Calculate the path to the package directory or sub-directory + # whose contents need to be stowed, relative to the current + # (target directory). This is needed so that we can check it's a + # valid directory, and can read its contents to iterate over them. + my $pkg_path_from_cwd = join_paths($stow_path, $package, $pkg_subdir); - opendir my $DIR, $path - or error("cannot read directory: $path ($!)"); + error("stow_contents() called with non-directory target: $target_subdir") + unless $self->is_a_node($target_subdir); + + opendir my $DIR, $pkg_path_from_cwd + or error("cannot read directory: $pkg_path_from_cwd ($!)"); my @listing = readdir $DIR; closedir $DIR; NODE: - for my $node (@listing) { + for my $node (sort @listing) { next NODE if $node eq '.'; next NODE if $node eq '..'; - my $node_target = join_paths($target, $node); - next NODE if $self->ignore($stow_path, $package, $node_target); + + my $package_node_path = join_paths($pkg_subdir, $node); + my $target_node = $node; if ($self->{dotfiles}) { - my $adj_node_target = adjust_dotfile($node_target); - debug(4, " Adjusting: $node_target => $adj_node_target"); - $node_target = $adj_node_target; + my $adjusted = adjust_dotfile($node); + if ($adjusted ne $node) { + debug(4, 1, "Adjusting: $node => $adjusted"); + $target_node = $adjusted; + } } + my $target_node_path = join_paths($target_subdir, $target_node); + + next NODE if $self->ignore($stow_path, $package, $target_node_path); $self->stow_node( $stow_path, $package, - $node_target, # target - join_paths($source, $node), # source - $level + $package_node_path, + $target_node_path ); } } -#===== METHOD =============================================================== -# Name : stow_node() -# Purpose : stow the given node -# Parameters: $stow_path => relative path from current (i.e. target) directory -# : to the stow dir containing the node to be stowed -# : $package => the package containing the node being stowed -# : $target => subpath relative to package directory of node which -# : needs stowing as a symlink at subpath relative to -# : target directory. -# : $source => relative path to symlink source from the dir of target -# Returns : n/a -# Throws : fatal exception if a conflict arises -# Comments : stow_node() and stow_contents() are mutually recursive -# : $source and $target are used for creating the symlink -# : $path is used for folding/unfolding trees as necessary -#============================================================================ +=head2 stow_node($stow_path, $package, $pkg_subpath, $target_subpath) + +Stow the given node + +=over 4 + +=item $stow_path + +Relative path from current (i.e. target) directory to the stow dir +containing the node to be stowed. This can differ from +C<$self->{stow_path}> when unfolding a (sub)tree which is already +stowed from a package in a different stow directory (see the "Multiple +Stow Directories" section of the manual). + +=item $package + +The package containing the node being stowed. + +=item $pkg_subpath + +Subpath of the installation image in the package directory which needs +stowing as a symlink which points to it. This is relative to the +top-level package directory. + +=item $target_subpath + +Subpath of the target directory which either needs a symlink to the +corresponding package subpathectory in the installation image, or if +it's an existing directory, it's an unfolded tree which may need to +be folded or recursed into. + +=back + +C and C are mutually recursive. + +=cut + sub stow_node { my $self = shift; - my ($stow_path, $package, $target, $source, $level) = @_; + my ($stow_path, $package, $pkg_subpath, $target_subpath) = @_; - my $path = join_paths($stow_path, $package, $target); - - debug(3, "Stowing $stow_path / $package / $target"); - debug(4, " => $source"); + debug(3, 0, "Stowing entry $stow_path / $package / $pkg_subpath"); + # Calculate the path to the package directory or sub-directory + # whose contents need to be stowed, relative to the current + # (target directory). This is needed so that we can check it's a + # valid directory, and can read its contents to iterate over them. + my $pkg_path_from_cwd = join_paths($stow_path, $package, $pkg_subpath); # Don't try to stow absolute symlinks (they can't be unstowed) - if (-l $source) { - my $second_source = $self->read_a_link($source); - if ($second_source =~ m{\A/}) { + if (-l $pkg_path_from_cwd) { + my $link_dest = $self->read_a_link($pkg_path_from_cwd); + if ($link_dest =~ m{\A/}) { $self->conflict( 'stow', $package, - "source is an absolute symlink $source => $second_source" + "source is an absolute symlink $pkg_path_from_cwd => $link_dest" ); - debug(3, "Absolute symlinks cannot be unstowed"); + debug(3, 0, "Absolute symlinks cannot be unstowed"); return; } } + # How many directories deep are we? + my $level = ($pkg_subpath =~ tr,/,,); + debug(2, 1, "level of $pkg_subpath is $level"); + + # Calculate the destination of the symlink which would need to be + # installed within this directory in the absence of folding. This + # is relative to the target (sub-)directory where the symlink will + # be installed when the plans are executed, so as we descend down + # into the package hierarchy, it will have extra "../" segments + # prefixed to it. + my $link_dest = join_paths('../' x $level, $pkg_path_from_cwd); + debug(4, 1, "link destination $link_dest"); + # Does the target already exist? - if ($self->is_a_link($target)) { + if ($self->is_a_link($target_subpath)) { # Where is the link pointing? - my $existing_source = $self->read_a_link($target); - if (not $existing_source) { - error("Could not read link: $target"); + my $existing_link_dest = $self->read_a_link($target_subpath); + if (not $existing_link_dest) { + error("Could not read link: $target_subpath"); } - debug(4, " Evaluate existing link: $target => $existing_source"); + debug(4, 1, "Evaluate existing link: $target_subpath => $existing_link_dest"); # Does it point to a node under any stow directory? - my ($existing_path, $existing_stow_path, $existing_package) = - $self->find_stowed_path($target, $existing_source); - if (not $existing_path) { + my ($existing_pkg_path_from_cwd, $existing_stow_path, $existing_package) = + $self->find_stowed_path($target_subpath, $existing_link_dest); + if (not $existing_pkg_path_from_cwd) { $self->conflict( 'stow', $package, - "existing target is not owned by stow: $target" + "existing target is not owned by stow: $target_subpath" ); - return; # XXX # + return; } - # Does the existing $target actually point to anything? - if ($self->is_a_node($existing_path)) { - if ($existing_source eq $source) { - debug(2, "--- Skipping $target as it already points to $source"); + # Does the existing $target_subpath actually point to anything? + if ($self->is_a_node($existing_pkg_path_from_cwd)) { + if ($existing_link_dest eq $link_dest) { + debug(2, 0, "--- Skipping $target_subpath as it already points to $link_dest"); } - elsif ($self->defer($target)) { - debug(2, "--- Deferring installation of: $target"); + elsif ($self->defer($target_subpath)) { + debug(2, 0, "--- Deferring installation of: $target_subpath"); } - elsif ($self->override($target)) { - debug(2, "--- Overriding installation of: $target"); - $self->do_unlink($target); - $self->do_link($source, $target); + elsif ($self->override($target_subpath)) { + debug(2, 0, "--- Overriding installation of: $target_subpath"); + $self->do_unlink($target_subpath); + $self->do_link($link_dest, $target_subpath); } - elsif ($self->is_a_dir(join_paths(parent($target), $existing_source)) && - $self->is_a_dir(join_paths(parent($target), $source)) ) { + elsif ($self->is_a_dir(join_paths(parent($target_subpath), $existing_link_dest)) && + $self->is_a_dir(join_paths(parent($target_subpath), $link_dest))) + { # If the existing link points to a directory, # and the proposed new link points to a directory, # then we can unfold (split open) the tree at that point - debug(2, "--- Unfolding $target which was already owned by $existing_package"); - $self->do_unlink($target); - $self->do_mkdir($target); + debug(2, 0, "--- Unfolding $target_subpath which was already owned by $existing_package"); + $self->do_unlink($target_subpath); + $self->do_mkdir($target_subpath); $self->stow_contents( $existing_stow_path, $existing_package, - $target, - join_paths('..', $existing_source), - $level + 1, + $pkg_subpath, + $target_subpath, ); $self->stow_contents( $self->{stow_path}, $package, - $target, - join_paths('..', $source), - $level + 1, + $pkg_subpath, + $target_subpath, ); } else { @@ -519,68 +590,100 @@ sub stow_node { 'stow', $package, "existing target is stowed to a different package: " - . "$target => $existing_source" + . "$target_subpath => $existing_link_dest" ); } } else { # The existing link is invalid, so replace it with a good link - debug(2, "--- replacing invalid link: $path"); - $self->do_unlink($target); - $self->do_link($source, $target); + debug(2, 0, "--- replacing invalid link: $target_subpath"); + $self->do_unlink($target_subpath); + $self->do_link($link_dest, $target_subpath); } } - elsif ($self->is_a_node($target)) { - debug(4, " Evaluate existing node: $target"); - if ($self->is_a_dir($target)) { - $self->stow_contents( - $self->{stow_path}, - $package, - $target, - join_paths('..', $source), - $level + 1, - ); + elsif ($self->is_a_node($target_subpath)) { + debug(4, 1, "Evaluate existing node: $target_subpath"); + if ($self->is_a_dir($target_subpath)) { + if (! -d $pkg_path_from_cwd) { + # FIXME: why wasn't this ever needed before? + $self->conflict( + 'stow', + $package, + "cannot stow non-directory $pkg_path_from_cwd over existing directory target $target_subpath" + ); + } + else { + $self->stow_contents( + $self->{stow_path}, + $package, + $pkg_subpath, + $target_subpath, + ); + } } else { + # If we're here, $target_subpath is not a current or + # planned directory. + if ($self->{adopt}) { - $self->do_mv($target, $path); - $self->do_link($source, $target); + if (-d $pkg_path_from_cwd) { + $self->conflict( + 'stow', + $package, + "cannot stow directory $pkg_path_from_cwd over existing non-directory target $target_subpath" + ); + } + else { + $self->do_mv($target_subpath, $pkg_path_from_cwd); + $self->do_link($link_dest, $target_subpath); + } } else { $self->conflict( 'stow', $package, - "existing target is neither a link nor a directory: $target" + "cannot stow $pkg_path_from_cwd over existing target $target_subpath since neither a link nor a directory and --adopt not specified" ); } } } - elsif ($self->{'no-folding'} && -d $path && ! -l $path) { - $self->do_mkdir($target); + elsif ($self->{'no-folding'} && -d $pkg_path_from_cwd && ! -l $pkg_path_from_cwd) { + $self->do_mkdir($target_subpath); $self->stow_contents( $self->{stow_path}, $package, - $target, - join_paths('..', $source), - $level + 1, + $pkg_subpath, + $target_subpath, ); } else { - $self->do_link($source, $target); + $self->do_link($link_dest, $target_subpath); } return; } -#===== METHOD =============================================================== -# Name : should_skip_target_which_is_stow_dir() -# Purpose : determine whether target is a stow directory which should -# : not be stowed to or unstowed from -# Parameters: $target => relative path to symlink target from the current directory -# Returns : true iff target is a stow directory -# Throws : n/a -# Comments : none -#============================================================================ -sub should_skip_target_which_is_stow_dir { +=head2 should_skip_target($target_subdir) + +Determine whether C<$target_subdir> is a stow directory which should +not be stowed to or unstowed from. This mechanism protects stow +directories from being altered by stow, and is a necessary safety +check because the stow directory could live beneath the target +directory. + +=over 4 + +=item $target_subdir => relative path to symlink target from the current directory + +=back + +Returns true iff target is a stow directory + +cwd must be the top-level target directory, otherwise +C won't work. + +=cut + +sub should_skip_target { my $self = shift; my ($target) = @_; @@ -591,427 +694,472 @@ sub should_skip_target_which_is_stow_dir { } if ($self->marked_stow_dir($target)) { + warn "WARNING: skipping marked Stow directory $target\n"; + return 1; + } + + if (-e join_paths($target, ".nonstow")) { warn "WARNING: skipping protected directory $target\n"; return 1; } - debug(4, "$target not protected"); + debug(4, 1, "$target not protected; shouldn't skip"); return 0; } +# cwd must be the top-level target directory, otherwise +# marked_stow_dir() won't work. sub marked_stow_dir { my $self = shift; - my ($target) = @_; - for my $f (".stow", ".nonstow") { - if (-e join_paths($target, $f)) { - debug(4, "$target contained $f"); - return 1; - } + my ($dir) = @_; + if (-e join_paths($dir, ".stow")) { + debug(5, 5, "> $dir contained .stow"); + return 1; } return 0; } -#===== METHOD =============================================================== -# Name : unstow_contents_orig() -# Purpose : unstow the contents of the given directory -# Parameters: $stow_path => relative path from current (i.e. target) directory -# : to the stow dir containing the package to be unstowed -# : $package => the package whose contents are being unstowed -# : $target => relative path to symlink target from the current directory -# Returns : n/a -# Throws : a fatal error if directory cannot be read -# Comments : unstow_node_orig() and unstow_contents_orig() are mutually recursive -# : Here we traverse the target tree, rather than the source tree. -#============================================================================ -sub unstow_contents_orig { - my $self = shift; - my ($stow_path, $package, $target) = @_; +=head2 unstow_contents($package, $pkg_subdir, $target_subdir) - my $path = join_paths($stow_path, $package, $target); +Unstow the contents of the given directory - return if $self->should_skip_target_which_is_stow_dir($target); +=over 4 - my $cwd = getcwd(); - my $msg = "Unstowing from $target (compat mode, cwd=$cwd, stow dir=$self->{stow_path})"; - $msg =~ s!$ENV{HOME}(/|$)!~$1!g; - debug(3, $msg); - debug(4, " source path is $path"); - # In compat mode we traverse the target tree not the source tree, - # so we're unstowing the contents of /target/foo, there's no - # guarantee that the corresponding /stow/mypkg/foo exists. - error("unstow_contents_orig() called with non-directory target: $target") - unless -d $target; +=item $package - opendir my $DIR, $target - or error("cannot read directory: $target ($!)"); - my @listing = readdir $DIR; - closedir $DIR; +The package whose contents are being unstowed. - NODE: - for my $node (@listing) { - next NODE if $node eq '.'; - next NODE if $node eq '..'; - my $node_target = join_paths($target, $node); - next NODE if $self->ignore($stow_path, $package, $node_target); - $self->unstow_node_orig($stow_path, $package, $node_target); - } -} +=item $pkg_subdir -#===== METHOD =============================================================== -# Name : unstow_node_orig() -# Purpose : unstow the given node -# Parameters: $stow_path => relative path from current (i.e. target) directory -# : to the stow dir containing the node to be stowed -# : $package => the package containing the node being stowed -# : $target => relative path to symlink target from the current directory -# Returns : n/a -# Throws : fatal error if a conflict arises -# Comments : unstow_node() and unstow_contents() are mutually recursive -#============================================================================ -sub unstow_node_orig { - my $self = shift; - my ($stow_path, $package, $target) = @_; +Subdirectory of the installation image in the package directory which +may need a symlink pointing to it to be unstowed. This is relative to +the top-level package directory. - my $path = join_paths($stow_path, $package, $target); +=item $target_subdir - debug(3, "Unstowing $target (compat mode)"); - debug(4, " source path is $path"); +Subdirectory of the target directory which either needs unstowing of a +symlink to the corresponding package subdirectory in the installation +image, or if it's an existing directory, it's an unfolded tree which +may need to be recursed into. - # Does the target exist? - if ($self->is_a_link($target)) { - debug(4, " Evaluate existing link: $target"); +=back - # Where is the link pointing? - my $existing_source = $self->read_a_link($target); - if (not $existing_source) { - error("Could not read link: $target"); - } +C and C are mutually recursive. +Here we traverse the package tree, rather than the target tree. - # Does it point to a node under any stow directory? - my ($existing_path, $existing_stow_path, $existing_package) = - $self->find_stowed_path($target, $existing_source); - if (not $existing_path) { - # We're traversing the target tree not the package tree, - # so we definitely expect to find stuff not owned by stow. - # Therefore we can't flag a conflict. - return; # XXX # - } +=cut - # Does the existing $target actually point to anything? - if (-e $existing_path) { - # Does link point to the right place? - if ($existing_path eq $path) { - $self->do_unlink($target); - } - elsif ($self->override($target)) { - debug(2, "--- overriding installation of: $target"); - $self->do_unlink($target); - } - # else leave it alone - } - else { - debug(2, "--- removing invalid link into a stow directory: $path"); - $self->do_unlink($target); - } - } - elsif (-d $target) { - $self->unstow_contents_orig($stow_path, $package, $target); - - # This action may have made the parent directory foldable - if (my $parent = $self->foldable($target)) { - $self->fold_tree($target, $parent); - } - } - elsif (-e $target) { - $self->conflict( - 'unstow', - $package, - "existing target is neither a link nor a directory: $target", - ); - } - else { - debug(2, "$target did not exist to be unstowed"); - } - return; -} - -#===== METHOD =============================================================== -# Name : unstow_contents() -# Purpose : unstow the contents of the given directory -# Parameters: $stow_path => relative path from current (i.e. target) directory -# : to the stow dir containing the package to be unstowed -# : $package => the package whose contents are being unstowed -# : $target => relative path to symlink target from the current directory -# Returns : n/a -# Throws : a fatal error if directory cannot be read -# Comments : unstow_node() and unstow_contents() are mutually recursive -# : Here we traverse the source tree, rather than the target tree. -#============================================================================ sub unstow_contents { my $self = shift; - my ($stow_path, $package, $target, $path) = @_; + my ($package, $pkg_subdir, $target_subdir) = @_; - return if $self->should_skip_target_which_is_stow_dir($target); + return if $self->should_skip_target($target_subdir); my $cwd = getcwd(); - my $msg = "Unstowing from $target (cwd=$cwd, stow dir=$self->{stow_path})"; + my $msg = "Unstowing contents of $self->{stow_path} / $package / $pkg_subdir (cwd=$cwd" . ($self->{compat} ? ', compat' : '') . ")"; $msg =~ s!$ENV{HOME}/!~/!g; - debug(3, $msg); - debug(4, " source path is $path"); - # We traverse the source tree not the target tree, so $path must exist. - error("unstow_contents() called with non-directory path: $path") - unless -d $path; - # When called at the top level, $target should exist. And - # unstow_node() should only call this via mutual recursion if - # $target exists. - error("unstow_contents() called with invalid target: $target") - unless $self->is_a_node($target); + debug(3, 0, $msg); + debug(4, 1, "target subdir is $target_subdir"); - opendir my $DIR, $path - or error("cannot read directory: $path ($!)"); + # Calculate the path to the package directory or sub-directory + # whose contents need to be unstowed, relative to the current + # (target directory). This is needed so that we can check it's a + # valid directory, and can read its contents to iterate over them. + my $pkg_path_from_cwd = join_paths($self->{stow_path}, $package, $pkg_subdir); + + if ($self->{compat}) { + # In compat mode we traverse the target tree not the source tree, + # so we're unstowing the contents of /target/foo, there's no + # guarantee that the corresponding /stow/mypkg/foo exists. + error("unstow_contents() in compat mode called with non-directory target: $target_subdir") + unless -d $target_subdir; + } + else { + # We traverse the package installation image tree not the + # target tree, so $pkg_path_from_cwd must exist. + error("unstow_contents() called with non-directory path: $pkg_path_from_cwd") + unless -d $pkg_path_from_cwd; + + # When called at the top level, $target_subdir should exist. And + # unstow_node() should only call this via mutual recursion if + # $target_subdir exists. + error("unstow_contents() called with invalid target: $target_subdir") + unless $self->is_a_node($target_subdir); + } + + my $dir = $self->{compat} ? $target_subdir : $pkg_path_from_cwd; + opendir my $DIR, $dir + or error("cannot read directory: $dir ($!)"); my @listing = readdir $DIR; closedir $DIR; NODE: - for my $node (@listing) { + for my $node (sort @listing) { next NODE if $node eq '.'; next NODE if $node eq '..'; - my $node_target = join_paths($target, $node); - next NODE if $self->ignore($stow_path, $package, $node_target); + + my $package_node = $node; + my $target_node = $node; if ($self->{dotfiles}) { - my $adj_node_target = adjust_dotfile($node_target); - debug(4, " Adjusting: $node_target => $adj_node_target"); - $node_target = $adj_node_target; + if ($self->{compat}) { + # $node is in the target tree, so we need to reverse + # adjust any .* files in case they came from a dot-* + # file. + my $adjusted = unadjust_dotfile($node); + if ($adjusted ne $node) { + debug(4, 1, "Reverse adjusting: $node => $adjusted"); + $package_node = $adjusted; + } + } + else { + # $node is in the package tree, so adjust any dot-* + # files for the target. + my $adjusted = adjust_dotfile($node); + if ($adjusted ne $node) { + debug(4, 1, "Adjusting: $node => $adjusted"); + $target_node = $adjusted; + } + } } + my $package_node_path = join_paths($pkg_subdir, $package_node); + my $target_node_path = join_paths($target_subdir, $target_node); - $self->unstow_node($stow_path, $package, $node_target, join_paths($path, $node)); + next NODE if $self->ignore($self->{stow_path}, $package, $target_node_path); + + $self->unstow_node( + $package, + $package_node_path, + $target_node_path + ); } - if (-d $target) { - $self->cleanup_invalid_links($target); + + if (! $self->{compat} && -d $target_subdir) { + $self->cleanup_invalid_links($target_subdir); } } -#===== METHOD =============================================================== -# Name : unstow_node() -# Purpose : unstow the given node -# Parameters: $stow_path => relative path from current (i.e. target) directory -# : to the stow dir containing the node to be stowed -# : $package => the package containing the node being unstowed -# : $target => relative path to symlink target from the current directory -# Returns : n/a -# Throws : fatal error if a conflict arises -# Comments : unstow_node() and unstow_contents() are mutually recursive -#============================================================================ +=head2 unstow_node($package, $pkg_subpath, $target_subpath) + +Unstow the given node. + +=over 4 + +=item $package + +The package containing the node being unstowed. + +=item $pkg_subpath + +Subpath of the installation image in the package directory which needs +stowing as a symlink which points to it. This is relative to the +top-level package directory. + +=item $target_subpath + +Subpath of the target directory which either needs a symlink to the +corresponding package subpathectory in the installation image, or if +it's an existing directory, it's an unfolded tree which may need to +be folded or recursed into. + +=back + +C and C are mutually recursive. + +=cut + sub unstow_node { my $self = shift; - my ($stow_path, $package, $target, $source) = @_; - - my $path = join_paths($stow_path, $package, $target); - - debug(3, "Unstowing $path"); - debug(4, " target is $target"); + my ($package, $pkg_subpath, $target_subpath) = @_; + debug(3, 0, "Unstowing entry from target: $target_subpath"); + debug(4, 1, "Package entry: $self->{stow_path} / $package / $pkg_subpath"); + # Calculate the path to the package directory or sub-directory + # whose contents need to be unstowed, relative to the current + # (target directory). # Does the target exist? - if ($self->is_a_link($target)) { - debug(4, " Evaluate existing link: $target"); + if ($self->is_a_link($target_subpath)) { + $self->unstow_link_node($package, $pkg_subpath, $target_subpath); + } + elsif (-d $target_subpath) { + $self->unstow_contents($package, $pkg_subpath, $target_subpath); - # Where is the link pointing? - my $existing_source = $self->read_a_link($target); - if (not $existing_source) { - error("Could not read link: $target"); - } - - if ($existing_source =~ m{\A/}) { - warn "Ignoring an absolute symlink: $target => $existing_source\n"; - return; # XXX # - } - - # Does it point to a node under any stow directory? - my ($existing_path, $existing_stow_path, $existing_package) = - $self->find_stowed_path($target, $existing_source); - if (not $existing_path) { - $self->conflict( - 'unstow', - $package, - "existing target is not owned by stow: $target => $existing_source" - ); - return; # XXX # - } - - # Does the existing $target actually point to anything? - if (-e $existing_path) { - # Does link points to the right place? - - # Adjust for dotfile if necessary. - if ($self->{dotfiles}) { - $existing_path = adjust_dotfile($existing_path); - } - - if ($existing_path eq $path) { - $self->do_unlink($target); - } - - # XXX we quietly ignore links that are stowed to a different - # package. - - #elsif (defer($target)) { - # debug(2, "--- deferring to installation of: $target"); - #} - #elsif ($self->override($target)) { - # debug(2, "--- overriding installation of: $target"); - # $self->do_unlink($target); - #} - #else { - # $self->conflict( - # 'unstow', - # $package, - # "existing target is stowed to a different package: " - # . "$target => $existing_source" - # ); - #} - } - else { - debug(2, "--- removing invalid link into a stow directory: $path"); - $self->do_unlink($target); + # This action may have made the parent directory foldable + if (my $parent_in_pkg = $self->foldable($target_subpath)) { + $self->fold_tree($target_subpath, $parent_in_pkg); } } - elsif (-e $target) { - debug(4, " Evaluate existing node: $target"); - if (-d $target) { - $self->unstow_contents($stow_path, $package, $target, $source); + elsif (-e $target_subpath) { + debug(2, 1, "$target_subpath doesn't need to be unstowed"); + } + else { + debug(2, 1, "$target_subpath did not exist to be unstowed"); + } +} - # This action may have made the parent directory foldable - if (my $parent = $self->foldable($target)) { - $self->fold_tree($target, $parent); - } +sub unstow_link_node { + my $self = shift; + my ($package, $pkg_subpath, $target_subpath) = @_; + debug(4, 2, "Evaluate existing link: $target_subpath"); + + # Where is the link pointing? + my $link_dest = $self->read_a_link($target_subpath); + if (not $link_dest) { + error("Could not read link: $target_subpath"); + } + + if ($link_dest =~ m{\A/}) { + warn "Ignoring an absolute symlink: $target_subpath => $link_dest\n"; + return; + } + + # Does it point to a node under any stow directory? + my ($existing_pkg_path_from_cwd, $existing_stow_path, $existing_package) = + $self->find_stowed_path($target_subpath, $link_dest); + if (not $existing_pkg_path_from_cwd) { + # The user is unstowing the package, so they don't want links to it. + # Therefore we should allow them to have a link pointing elsewhere + # which would conflict with the package if they were stowing it. + debug(5, 3, "Ignoring unowned link $target_subpath => $link_dest"); + return; + } + + my $pkg_path_from_cwd = join_paths($self->{stow_path}, $package, $pkg_subpath); + + # Does the existing $target_subpath actually point to anything? + if (-e $existing_pkg_path_from_cwd) { + if ($existing_pkg_path_from_cwd eq $pkg_path_from_cwd) { + # It points to the package we're unstowing, so unstow the link. + $self->do_unlink($target_subpath); } else { - $self->conflict( - 'unstow', - $package, - "existing target is neither a link nor a directory: $target", - ); + debug(5, 3, "Ignoring link $target_subpath => $link_dest"); } } else { - debug(2, "$target did not exist to be unstowed"); + debug(2, 0, "--- removing invalid link into a stow directory: $pkg_path_from_cwd"); + $self->do_unlink($target_subpath); } - return; } -#===== METHOD =============================================================== -# Name : path_owned_by_package() -# Purpose : determine whether the given link points to a member of a -# : stowed package -# Parameters: $target => path to a symbolic link under current directory -# : $source => where that link points to -# Returns : the package iff link is owned by stow, otherwise '' -# Throws : n/a -# Comments : lossy wrapper around find_stowed_path() -#============================================================================ -sub path_owned_by_package { - my $self = shift; - my ($target, $source) = @_; +=head2 link_owned_by_package($target_subpath, $link_dest) - my ($path, $stow_path, $package) = - $self->find_stowed_path($target, $source); +Determine whether the given link points to a member of a stowed +package. + +=over 4 + +=item $target_subpath + +Path to a symbolic link under current directory. + +=item $link_dest + +Where that link points to. + +=back + +Lossy wrapper around find_stowed_path(). + +Returns the package iff link is owned by stow, otherwise ''. + +=cut + +sub link_owned_by_package { + my $self = shift; + my ($target_subpath, $link_dest) = @_; + + my ($pkg_path_from_cwd, $stow_path, $package) = + $self->find_stowed_path($target_subpath, $link_dest); return $package; } -#===== METHOD =============================================================== -# Name : find_stowed_path() -# Purpose : determine whether the given link points to a member of a -# : stowed package -# Parameters: $target => path to a symbolic link under current directory. -# : Must share a common prefix with $self->{stow_path} -# : $source => where that link points to (needed because link -# : might not exist yet due to two-phase approach, -# : so we can't just call readlink()). This must be -# : expressed relative to (the directory containing) -# : $target. -# Returns : ($path, $stow_path, $package) where $path and $stow_path are -# : relative from the current (i.e. target) directory. $path -# : is the full relative path, $stow_path is the relative path -# : to the stow directory, and $package is the name of the package. -# : or ('', '', '') if link is not owned by stow -# Throws : n/a -# Comments : Allow for stow dir not being under target dir. -# : We could put more logic under here for multiple stow dirs. -#============================================================================ +=head2 find_stowed_path($target_subpath, $link_dest) + +Determine whether the given symlink within the target directory is a +stowed path pointing to a member of a package under the stow dir, and +if so, obtain a breakdown of information about this stowed path. + +=over 4 + +=item $target_subpath + +Path to a symbolic link somewhere under the target directory, relative +to the top-level target directory (which is also expected to be the +current directory). + +=item $link_dest + +Where that link points to (needed because link might not exist yet due +to two-phase approach, so we can't just call C). If this +is owned by Stow, it will be expressed relative to (the directory +containing) C<$target_subpath>. However if it's not, it could of course be +relative or absolute, point absolutely anywhere, and could even be +dangling. + +=back + +Returns C<($pkg_path_from_cwd, $stow_path, $package)> where +C<$pkg_path_from_cwd> and C<$stow_path> are relative from the +top-level target directory. C<$pkg_path_from_cwd> is the full +relative path to the member of the package pointed to by +C<$link_dest>; C<$stow_path> is the relative path to the stow +directory; and C<$package> is the name of the package; or C<('', '', +'')> if link is not owned by stow. + +cwd must be the top-level target directory, otherwise +C won't work. Allow for stow dir +not being under target dir. + +=cut + sub find_stowed_path { my $self = shift; - my ($target, $source) = @_; + my ($target_subpath, $link_dest) = @_; - # Evaluate softlink relative to its target - my $path = join_paths(parent($target), $source); - debug(4, " is path $path owned by stow?"); - - # Search for .stow files - this allows us to detect links - # owned by stow directories other than the current one. - my $dir = ''; - my @path = split m{/+}, $path; - for my $i (0 .. $#path) { - my $part = $path[$i]; - $dir = join_paths($dir, $part); - if ($self->marked_stow_dir($dir)) { - # FIXME - not sure if this can ever happen - internal_error("find_stowed_path() called directly on stow dir") - if $i == $#path; - - debug(4, " yes - $dir was marked as a stow dir"); - my $package = $path[$i + 1]; - return ($path, $dir, $package); - } - } - - # If no .stow file was found, we need to find out whether it's - # owned by the current stow directory, in which case $path will be - # a prefix of $self->{stow_path}. - if (substr($path, 0, 1) eq '/' xor substr($self->{stow_path}, 0, 1) eq '/') - { - warn "BUG in find_stowed_path? Absolute/relative mismatch between " . - "Stow dir $self->{stow_path} and path $path"; - } - - my @stow_path = split m{/+}, $self->{stow_path}; - - # Strip off common prefixes until one is empty - while (@path && @stow_path) { - if ((shift @path) ne (shift @stow_path)) { - debug(4, " no - either $path not under $self->{stow_path} or vice-versa"); - return ('', '', ''); - } - } - - if (@stow_path) { # @path must be empty - debug(4, " no - $path is not under $self->{stow_path}"); + if (substr($link_dest, 0, 1) eq '/') { + # Symlink points to an absolute path, therefore it cannot be + # owned by Stow. return ('', '', ''); } - my $package = shift @path; + # Evaluate softlink relative to its target, without relying on + # what's actually on the filesystem, since the link might not + # exist yet. + debug(4, 2, "find_stowed_path(target=$target_subpath; source=$link_dest)"); + my $pkg_path_from_cwd = join_paths(parent($target_subpath), $link_dest); + debug(4, 3, "is symlink destination $pkg_path_from_cwd owned by stow?"); - debug(4, " yes - by $package in " . join_paths(@path)); - return ($path, $self->{stow_path}, $package); + # First check whether the link is owned by the current stow + # directory, in which case $pkg_path_from_cwd will be a prefix of + # $self->{stow_path}. + my ($package, $pkg_subpath) = $self->link_dest_within_stow_dir($pkg_path_from_cwd); + if (length $package) { + debug(4, 3, "yes - package $package in $self->{stow_path} may contain $pkg_subpath"); + return ($pkg_path_from_cwd, $self->{stow_path}, $package); + } + + # If no .stow file was found, we need to find out whether it's + # owned by the current stow directory, in which case + # $pkg_path_from_cwd will be a prefix of $self->{stow_path}. + my ($stow_path, $ext_package) = $self->find_containing_marked_stow_dir($pkg_path_from_cwd); + if (length $stow_path) { + debug(5, 5, "yes - $stow_path in $pkg_path_from_cwd was marked as a stow dir; package=$ext_package"); + return ($pkg_path_from_cwd, $stow_path, $ext_package); + } + + return ('', '', ''); } -#===== METHOD ================================================================ -# Name : cleanup_invalid_links() -# Purpose : clean up invalid links that may block folding -# Parameters: $dir => path to directory to check -# Returns : n/a -# Throws : no exceptions -# Comments : removing files from a stowed package is probably a bad practice -# : so this kind of clean up is not _really_ stow's responsibility; -# : however, failing to clean up can block tree folding, so we'll do -# : it anyway -#============================================================================= +=head2 link_dest_within_stow_dir($link_dest) + +Detect whether symlink destination is within current stow dir + +=over 4 + +=item $link_dest - destination of the symlink relative + +=back + +Returns C<($package, $pkg_subpath)> - package within the current stow +dir and subpath within that package which the symlink points to. + +=cut + +sub link_dest_within_stow_dir { + my $self = shift; + my ($link_dest) = @_; + + debug(4, 4, "common prefix? link_dest=$link_dest; stow_path=$self->{stow_path}"); + + my $removed = $link_dest =~ s,^\Q$self->{stow_path}/,,; + if (! $removed) { + debug(4, 3, "no - $link_dest not under $self->{stow_path}"); + return ('', ''); + } + + debug(4, 4, "remaining after removing $self->{stow_path}: $link_dest"); + my @dirs = File::Spec->splitdir($link_dest); + my $package = shift @dirs; + my $pkg_subpath = File::Spec->catdir(@dirs); + return ($package, $pkg_subpath); +} + +=head2 find_containing_marked_stow_dir($pkg_path_from_cwd) + +Detect whether path is within a marked stow directory + +=over 4 + +=item $pkg_path_from_cwd => path to directory to check + +=back + +Returns C<($stow_path, $package)> where C<$stow_path> is the highest +directory (relative from the top-level target directory) which is +marked as a Stow directory, and C<$package> is the containing package; +or C<('', '')> if no containing directory is marked as a stow +directory. + +cwd must be the top-level target directory, otherwise +C won't work. + +=cut + +sub find_containing_marked_stow_dir { + my $self = shift; + my ($pkg_path_from_cwd) = @_; + + # Search for .stow files - this allows us to detect links + # owned by stow directories other than the current one. + my @segments = File::Spec->splitdir($pkg_path_from_cwd); + for my $last_segment (0 .. $#segments) { + my $pkg_path_from_cwd = join_paths(@segments[0 .. $last_segment]); + debug(5, 5, "is $pkg_path_from_cwd marked stow dir?"); + if ($self->marked_stow_dir($pkg_path_from_cwd)) { + if ($last_segment == $#segments) { + # This should probably never happen. Even if it did, + # there would be no way of calculating $package. + internal_error("find_stowed_path() called directly on stow dir"); + } + + my $package = $segments[$last_segment + 1]; + return ($pkg_path_from_cwd, $package); + } + } + return ('', ''); +} + +=head2 cleanup_invalid_links($dir) + +Clean up orphaned links that may block folding + +=over 4 + +=item $dir + +Path to directory to check + +=back + +This is invoked by C. We only clean up links which +are both orphaned and owned by Stow, i.e. they point to a non-existent +location within a Stow package. These can block tree folding, and +they can easily occur when a file in Stow package is renamed or +removed, so the benefit should outweigh the low risk of actually +someone wanting to keep an orphaned link to within a Stow package. + +=cut + sub cleanup_invalid_links { my $self = shift; my ($dir) = @_; + my $cwd = getcwd(); + debug(2, 0, "Cleaning up any invalid links in $dir (pwd=$cwd)"); + if (not -d $dir) { - error("cleanup_invalid_links() called with a non-directory: $dir"); + internal_error("cleanup_invalid_links() called with a non-directory: $dir"); } opendir my $DIR, $dir @@ -1020,152 +1168,224 @@ sub cleanup_invalid_links { closedir $DIR; NODE: - for my $node (@listing) { + for my $node (sort @listing) { next NODE if $node eq '.'; next NODE if $node eq '..'; my $node_path = join_paths($dir, $node); - if (-l $node_path and not exists $self->{link_task_for}{$node_path}) { + next unless -l $node_path; - # Where is the link pointing? - # (don't use read_a_link() here) - my $source = readlink($node_path); - if (not $source) { - error("Could not read link $node_path"); - } + debug(4, 1, "Checking validity of link $node_path"); - if ( - not -e join_paths($dir, $source) and # bad link - $self->path_owned_by_package($node_path, $source) # owned by stow - ){ - debug(2, "--- removing stale link: $node_path => " . - join_paths($dir, $source)); - $self->do_unlink($node_path); + if (exists $self->{link_task_for}{$node_path}) { + my $action = $self->{link_task_for}{$node_path}{action}; + if ($action ne 'remove') { + warn "Unexpected action $action scheduled for $node_path; skipping clean-up\n"; } + else { + debug(4, 2, "$node_path scheduled for removal; skipping clean-up"); + } + next; + } + + # Where is the link pointing? + # (don't use read_a_link() here) + my $link_dest = readlink($node_path); + if (not $link_dest) { + error("Could not read link $node_path"); + } + + my $target_subpath = join_paths($dir, $link_dest); + debug(4, 2, "join $dir $link_dest"); + if (-e $target_subpath) { + debug(4, 2, "Link target $link_dest exists at $target_subpath; skipping clean up"); + next; + } + else { + debug(4, 2, "Link target $link_dest doesn't exist at $target_subpath"); + } + + debug(3, 1, + "Checking whether valid link $node_path -> $link_dest is " . + "owned by stow"); + + my $owner = $self->link_owned_by_package($node_path, $link_dest); + if ($owner) { + # owned by stow + debug(2, 0, "--- removing link owned by $owner: $node_path => " . + join_paths($dir, $link_dest)); + $self->do_unlink($node_path); } } return; } -#===== METHOD =============================================================== -# Name : foldable() -# Purpose : determine whether a tree can be folded -# Parameters: $target => path to a directory -# Returns : path to the parent dir iff the tree can be safely folded -# Throws : n/a -# Comments : the path returned is relative to the parent of $target, -# : that is, it can be used as the source for a replacement symlink -#============================================================================ +=head2 foldable($target_subdir) + +Determine whether a tree can be folded + +=over 4 + +=item $target_subdir + +Path to the target sub-directory to check for foldability, relative to +the current directory (the top-level target directory). + +=back + +Returns path to the parent dir iff the tree can be safely folded. The +path returned is relative to the parent of C<$target_subdir>, i.e. it +can be used as the source for a replacement symlink. + +=cut + sub foldable { my $self = shift; - my ($target) = @_; + my ($target_subdir) = @_; - debug(3, "--- Is $target foldable?"); + debug(3, 2, "Is $target_subdir foldable?"); if ($self->{'no-folding'}) { - debug(3, "--- no because --no-folding enabled"); + debug(3, 3, "Not foldable because --no-folding enabled"); return ''; } - opendir my $DIR, $target - or error(qq{Cannot read directory "$target" ($!)\n}); + opendir my $DIR, $target_subdir + or error(qq{Cannot read directory "$target_subdir" ($!)\n}); my @listing = readdir $DIR; closedir $DIR; - my $parent = ''; - NODE: - for my $node (@listing) { + # We want to see if all the symlinks in $target_subdir point to + # files under the same parent subdirectory in the package + # (e.g. ../../stow/pkg1/common_dir/file1). So remember which + # parent subdirectory we've already seen, and if we come across a + # second one which is different, + # (e.g. ../../stow/pkg2/common_dir/file2), then $target_subdir + # common_dir which contains file{1,2} cannot be folded to be + # a symlink to (say) ../../stow/pkg1/common_dir. + my $parent_in_pkg = ''; + NODE: + for my $node (sort @listing) { next NODE if $node eq '.'; next NODE if $node eq '..'; - my $path = join_paths($target, $node); + my $target_node_path = join_paths($target_subdir, $node); # Skip nodes scheduled for removal - next NODE if not $self->is_a_node($path); + next NODE if not $self->is_a_node($target_node_path); # If it's not a link then we can't fold its parent - return '' if not $self->is_a_link($path); + if (not $self->is_a_link($target_node_path)) { + debug(3, 3, "Not foldable because $target_node_path not a link"); + return ''; + } # Where is the link pointing? - my $source = $self->read_a_link($path); - if (not $source) { - error("Could not read link $path"); + my $link_dest = $self->read_a_link($target_node_path); + if (not $link_dest) { + error("Could not read link $target_node_path"); } - if ($parent eq '') { - $parent = parent($source) + my $new_parent = parent($link_dest); + if ($parent_in_pkg eq '') { + $parent_in_pkg = $new_parent; } - elsif ($parent ne parent($source)) { + elsif ($parent_in_pkg ne $new_parent) { + debug(3, 3, "Not foldable because $target_subdir contains links to entries in both $parent_in_pkg and $new_parent"); return ''; } } - return '' if not $parent; + if (not $parent_in_pkg) { + debug(3, 3, "Not foldable because $target_subdir contains no links"); + return ''; + } - # If we get here then all nodes inside $target are links, and those links - # point to nodes inside the same directory. + # If we get here then all nodes inside $target_subdir are links, + # and those links point to nodes inside the same directory. # chop of leading '..' to get the path to the common parent directory - # relative to the parent of our $target - $parent =~ s{\A\.\./}{}; + # relative to the parent of our $target_subdir + $parent_in_pkg =~ s{\A\.\./}{}; # If the resulting path is owned by stow, we can fold it - if ($self->path_owned_by_package($target, $parent)) { - debug(3, "--- $target is foldable"); - return $parent; + if ($self->link_owned_by_package($target_subdir, $parent_in_pkg)) { + debug(3, 3, "$target_subdir is foldable"); + return $parent_in_pkg; } else { + debug(3, 3, "$target_subdir is not foldable"); return ''; } } -#===== METHOD =============================================================== -# Name : fold_tree() -# Purpose : fold the given tree -# Parameters: $source => link to the folded tree source -# : $target => directory that we will replace with a link to $source -# Returns : n/a -# Throws : none -# Comments : only called iff foldable() is true so we can remove some checks -#============================================================================ +=head2 fold_tree($target_subdir, $pkg_subpath) + +Fold the given tree + +=over 4 + +=item $target_subdir + +Directory that we will replace with a link to $pkg_subpath. + +=item $pkg_subpath + +link to the folded tree source + +=back + +Only called iff foldable() is true so we can remove some checks. + +=cut + sub fold_tree { my $self = shift; - my ($target, $source) = @_; + my ($target_subdir, $pkg_subpath) = @_; - debug(3, "--- Folding tree: $target => $source"); + debug(3, 0, "--- Folding tree: $target_subdir => $pkg_subpath"); - opendir my $DIR, $target - or error(qq{Cannot read directory "$target" ($!)\n}); + opendir my $DIR, $target_subdir + or error(qq{Cannot read directory "$target_subdir" ($!)\n}); my @listing = readdir $DIR; closedir $DIR; NODE: - for my $node (@listing) { + for my $node (sort @listing) { next NODE if $node eq '.'; next NODE if $node eq '..'; - next NODE if not $self->is_a_node(join_paths($target, $node)); - $self->do_unlink(join_paths($target, $node)); + next NODE if not $self->is_a_node(join_paths($target_subdir, $node)); + $self->do_unlink(join_paths($target_subdir, $node)); } - $self->do_rmdir($target); - $self->do_link($source, $target); + $self->do_rmdir($target_subdir); + $self->do_link($pkg_subpath, $target_subdir); return; } -#===== METHOD =============================================================== -# Name : conflict() -# Purpose : handle conflicts in stow operations -# Parameters: $package => the package involved with the conflicting operation -# : $message => a description of the conflict -# Returns : n/a -# Throws : none -# Comments : none -#============================================================================ +=head2 conflict($package, $message) + +Handle conflicts in stow operations + +=over 4 + +=item $package + +the package involved with the conflicting operation + +=item $message + +a description of the conflict + +=back + +=cut + sub conflict { my $self = shift; my ($action, $package, $message) = @_; - debug(2, "CONFLICT when ${action}ing $package: $message"); + debug(2, 0, "CONFLICT when ${action}ing $package: $message"); $self->{conflicts}{$action}{$package} ||= []; push @{ $self->{conflicts}{$action}{$package} }, $message; $self->{conflict_count}++; @@ -1229,17 +1449,31 @@ sub get_action_count { return $self->{action_count}; } -#===== METHOD ================================================================ -# Name : ignore -# Purpose : determine if the given path matches a regex in our ignore list -# Parameters: $stow_path => the stow directory containing the package -# : $package => the package containing the path -# : $target => the path to check against the ignore list -# : relative to its package directory -# Returns : true iff the path should be ignored -# Throws : no exceptions -# Comments : none -#============================================================================= +=head2 ignore($stow_path, $package, $target) + +Determine if the given path matches a regex in our ignore list. + +=over 4 + +=item $stow_path + +the stow directory containing the package + +=item $package + +the package containing the path + +=item $target + +the path to check against the ignore list relative to its package +directory + +=back + +Returns true iff the path should be ignored. + +=cut + sub ignore { my $self = shift; my ($stow_path, $package, $target) = @_; @@ -1249,7 +1483,7 @@ sub ignore { for my $suffix (@{ $self->{ignore} }) { if ($target =~ m/$suffix/) { - debug(4, " Ignoring path $target due to --ignore=$suffix"); + debug(4, 1, "Ignoring path $target due to --ignore=$suffix"); return 1; } } @@ -1257,23 +1491,23 @@ sub ignore { my $package_dir = join_paths($stow_path, $package); my ($path_regexp, $segment_regexp) = $self->get_ignore_regexps($package_dir); - debug(5, " Ignore list regexp for paths: " . + debug(5, 2, "Ignore list regexp for paths: " . (defined $path_regexp ? "/$path_regexp/" : "none")); - debug(5, " Ignore list regexp for segments: " . + debug(5, 2, "Ignore list regexp for segments: " . (defined $segment_regexp ? "/$segment_regexp/" : "none")); if (defined $path_regexp and "/$target" =~ $path_regexp) { - debug(4, " Ignoring path /$target"); + debug(4, 1, "Ignoring path /$target"); return 1; } (my $basename = $target) =~ s!.+/!!; if (defined $segment_regexp and $basename =~ $segment_regexp) { - debug(4, " Ignoring path segment $basename"); + debug(4, 1, "Ignoring path segment $basename"); return 1; } - debug(5, " Not ignoring $target"); + debug(5, 1, "Not ignoring $target"); return 0; } @@ -1293,15 +1527,15 @@ sub get_ignore_regexps { for my $file ($local_stow_ignore, $global_stow_ignore) { if (-e $file) { - debug(5, " Using ignore file: $file"); + debug(5, 1, "Using ignore file: $file"); return $self->get_ignore_regexps_from_file($file); } else { - debug(5, " $file didn't exist"); + debug(5, 1, "$file didn't exist"); } } - debug(4, " Using built-in ignore list"); + debug(4, 1, "Using built-in ignore list"); return @default_global_ignore_regexps; } @@ -1312,12 +1546,12 @@ sub get_ignore_regexps_from_file { my ($file) = @_; if (exists $ignore_file_regexps{$file}) { - debug(4, " Using memoized regexps from $file"); + debug(4, 2, "Using memoized regexps from $file"); return @{ $ignore_file_regexps{$file} }; } if (! open(REGEXPS, $file)) { - debug(4, " Failed to open $file: $!"); + debug(4, 2, "Failed to open $file: $!"); return undef; } @@ -1342,11 +1576,11 @@ sub invalidate_memoized_regexp { my $self = shift; my ($file) = @_; if (exists $ignore_file_regexps{$file}) { - debug(4, " Invalidated memoized regexp for $file"); + debug(4, 2, "Invalidated memoized regexp for $file"); delete $ignore_file_regexps{$file}; } else { - debug(2, " WARNING: no memoized regexp for $file to invalidate"); + debug(2, 1, "WARNING: no memoized regexp for $file to invalidate"); } } @@ -1415,14 +1649,20 @@ sub get_default_global_ignore_regexps { return $class->get_ignore_regexps_from_fh(\*DATA); } -#===== METHOD ================================================================ -# Name : defer -# Purpose : determine if the given path matches a regex in our defer list -# Parameters: $path -# Returns : Boolean -# Throws : no exceptions -# Comments : none -#============================================================================= +=head2 defer($path) + +Determine if the given path matches a regex in our C list + +=over 4 + +=item $path + +=back + +Returns boolean. + +=cut + sub defer { my $self = shift; my ($path) = @_; @@ -1433,14 +1673,20 @@ sub defer { return 0; } -#===== METHOD ================================================================ -# Name : override -# Purpose : determine if the given path matches a regex in our override list -# Parameters: $path -# Returns : Boolean -# Throws : no exceptions -# Comments : none -#============================================================================= +=head2 override($path) + +Determine if the given path matches a regex in our C list + +=over 4 + +=item $path + +=back + +Returns boolean + +=cut + sub override { my $self = shift; my ($path) = @_; @@ -1458,18 +1704,25 @@ sub override { # ############################################################################## -#===== METHOD =============================================================== -# Name : process_tasks() -# Purpose : process each task in the tasks list -# Parameters: none -# Returns : n/a -# Throws : fatal error if tasks list is corrupted or a task fails -# Comments : none -#============================================================================ +=head2 process_tasks() + +Process each task in the tasks list + +=over 4 + +=item none + +=back + +Returns : n/a +Throws : fatal error if tasks list is corrupted or a task fails + +=cut + sub process_tasks { my $self = shift; - debug(2, "Processing tasks..."); + debug(2, 0, "Processing tasks..."); # Strip out all tasks with a skip action $self->{tasks} = [ grep { $_->{action} ne 'skip' } @{ $self->{tasks} } ]; @@ -1484,19 +1737,28 @@ sub process_tasks { } }); - debug(2, "Processing tasks... done"); + debug(2, 0, "Processing tasks... done"); } -#===== METHOD =============================================================== -# Name : process_task() -# Purpose : process a single task -# Parameters: $task => the task to process -# Returns : n/a -# Throws : fatal error if task fails -# Comments : Must run from within target directory. -# : Task involve either creating or deleting dirs and symlinks -# : an action is set to 'skip' if it is found to be redundant -#============================================================================ +=head2 process_task($task) + +Process a single task. + +=over 4 + +=item $task => the task to process + +=back + +Returns : n/a +Throws : fatal error if task fails +# # +Must run from within target directory. Task involve either creating +or deleting dirs and symlinks an action is set to 'skip' if it is +found to be redundant + +=cut + sub process_task { my $self = shift; my ($task) = @_; @@ -1543,20 +1805,27 @@ sub process_task { internal_error("bad task action: $task->{action}"); } -#===== METHOD =============================================================== -# Name : link_task_action() -# Purpose : finds the link task action for the given path, if there is one -# Parameters: $path -# Returns : 'remove', 'create', or '' if there is no action -# Throws : a fatal exception if an invalid action is found -# Comments : none -#============================================================================ +=head2 link_task_action($path) + +Finds the link task action for the given path, if there is one + +=over 4 + +=item $path + +=back + +Returns C<'remove'>, C<'create'>, or C<''> if there is no action. +Throws a fatal exception if an invalid action is found. + +=cut + sub link_task_action { my $self = shift; my ($path) = @_; if (! exists $self->{link_task_for}{$path}) { - debug(4, " link_task_action($path): no task"); + debug(4, 4, "| link_task_action($path): no task"); return ''; } @@ -1564,24 +1833,31 @@ sub link_task_action { internal_error("bad task action: $action") unless $action eq 'remove' or $action eq 'create'; - debug(4, " link_task_action($path): link task exists with action $action"); + debug(4, 1, "link_task_action($path): link task exists with action $action"); return $action; } -#===== METHOD =============================================================== -# Name : dir_task_action() -# Purpose : finds the dir task action for the given path, if there is one -# Parameters: $path -# Returns : 'remove', 'create', or '' if there is no action -# Throws : a fatal exception if an invalid action is found -# Comments : none -#============================================================================ +=head2 dir_task_action($path) + +Finds the dir task action for the given path, if there is one. + +=over 4 + +=item $path + +=back + +Returns C<'remove'>, C<'create'>, or C<''> if there is no action. +Throws a fatal exception if an invalid action is found. + +=cut + sub dir_task_action { my $self = shift; my ($path) = @_; if (! exists $self->{dir_task_for}{$path}) { - debug(4, " dir_task_action($path): no task"); + debug(4, 4, "| dir_task_action($path): no task"); return ''; } @@ -1589,90 +1865,108 @@ sub dir_task_action { internal_error("bad task action: $action") unless $action eq 'remove' or $action eq 'create'; - debug(4, " dir_task_action($path): dir task exists with action $action"); + debug(4, 4, "| dir_task_action($path): dir task exists with action $action"); return $action; } -#===== METHOD =============================================================== -# Name : parent_link_scheduled_for_removal() -# Purpose : determine whether the given path or any parent thereof -# : is a link scheduled for removal -# Parameters: $path -# Returns : Boolean -# Throws : none -# Comments : none -#============================================================================ +=head2 parent_link_scheduled_for_removal($target_path) + +Determine whether the given path or any parent thereof is a link +scheduled for removal + +=over 4 + +=item $target_path + +=back + +Returns boolean + +=cut + sub parent_link_scheduled_for_removal { my $self = shift; - my ($path) = @_; + my ($target_path) = @_; my $prefix = ''; - for my $part (split m{/+}, $path) { + for my $part (split m{/+}, $target_path) { $prefix = join_paths($prefix, $part); - debug(4, " parent_link_scheduled_for_removal($path): prefix $prefix"); + debug(5, 4, "| parent_link_scheduled_for_removal($target_path): prefix $prefix"); if (exists $self->{link_task_for}{$prefix} and $self->{link_task_for}{$prefix}->{action} eq 'remove') { - debug(4, " parent_link_scheduled_for_removal($path): link scheduled for removal"); + debug(4, 4, "| parent_link_scheduled_for_removal($target_path): link scheduled for removal"); return 1; } } - debug(4, " parent_link_scheduled_for_removal($path): returning false"); + debug(4, 4, "| parent_link_scheduled_for_removal($target_path): returning false"); return 0; } -#===== METHOD =============================================================== -# Name : is_a_link() -# Purpose : determine if the given path is a current or planned link -# Parameters: $path -# Returns : Boolean -# Throws : none -# Comments : returns false if an existing link is scheduled for removal -# : and true if a non-existent link is scheduled for creation -#============================================================================ +=head2 is_a_link($target_path) + +Determine if the given path is a current or planned link. + +=over 4 + +=item $target_path + +=back + +Returns false if an existing link is scheduled for removal and true if +a non-existent link is scheduled for creation. + +=cut + sub is_a_link { my $self = shift; - my ($path) = @_; - debug(4, " is_a_link($path)"); + my ($target_path) = @_; + debug(4, 2, "is_a_link($target_path)"); - if (my $action = $self->link_task_action($path)) { + if (my $action = $self->link_task_action($target_path)) { if ($action eq 'remove') { - debug(4, " is_a_link($path): returning 0 (remove action found)"); + debug(4, 2, "is_a_link($target_path): returning 0 (remove action found)"); return 0; } elsif ($action eq 'create') { - debug(4, " is_a_link($path): returning 1 (create action found)"); + debug(4, 2, "is_a_link($target_path): returning 1 (create action found)"); return 1; } } - if (-l $path) { + if (-l $target_path) { # Check if any of its parent are links scheduled for removal # (need this for edge case during unfolding) - debug(4, " is_a_link($path): is a real link"); - return $self->parent_link_scheduled_for_removal($path) ? 0 : 1; + debug(4, 2, "is_a_link($target_path): is a real link"); + return $self->parent_link_scheduled_for_removal($target_path) ? 0 : 1; } - debug(4, " is_a_link($path): returning 0"); + debug(4, 2, "is_a_link($target_path): returning 0"); return 0; } -#===== METHOD =============================================================== -# Name : is_a_dir() -# Purpose : determine if the given path is a current or planned directory -# Parameters: $path -# Returns : Boolean -# Throws : none -# Comments : returns false if an existing directory is scheduled for removal -# : and true if a non-existent directory is scheduled for creation -# : we also need to be sure we are not just following a link -#============================================================================ +=head2 is_a_dir($target_path) + +Determine if the given path is a current or planned directory + +=over 4 + +=item $target_path + +=back + +Returns false if an existing directory is scheduled for removal and +true if a non-existent directory is scheduled for creation. We also +need to be sure we are not just following a link. + +=cut + sub is_a_dir { my $self = shift; - my ($path) = @_; - debug(4, " is_a_dir($path)"); + my ($target_path) = @_; + debug(4, 1, "is_a_dir($target_path)"); - if (my $action = $self->dir_task_action($path)) { + if (my $action = $self->dir_task_action($target_path)) { if ($action eq 'remove') { return 0; } @@ -1681,42 +1975,48 @@ sub is_a_dir { } } - return 0 if $self->parent_link_scheduled_for_removal($path); + return 0 if $self->parent_link_scheduled_for_removal($target_path); - if (-d $path) { - debug(4, " is_a_dir($path): real dir"); + if (-d $target_path) { + debug(4, 1, "is_a_dir($target_path): real dir"); return 1; } - debug(4, " is_a_dir($path): returning false"); + debug(4, 1, "is_a_dir($target_path): returning false"); return 0; } -#===== METHOD =============================================================== -# Name : is_a_node() -# Purpose : determine whether the given path is a current or planned node -# Parameters: $path -# Returns : Boolean -# Throws : none -# Comments : returns false if an existing node is scheduled for removal -# : true if a non-existent node is scheduled for creation -# : we also need to be sure we are not just following a link -#============================================================================ +=head2 is_a_node($target_path) + +Determine whether the given path is a current or planned node. + +=over 4 + +=item $target_path + +=back + +Returns false if an existing node is scheduled for removal, or true if +a non-existent node is scheduled for creation. We also need to be +sure we are not just following a link. + +=cut + sub is_a_node { my $self = shift; - my ($path) = @_; - debug(4, " is_a_node($path)"); + my ($target_path) = @_; + debug(4, 4, "| Checking whether $target_path is a current/planned node"); - my $laction = $self->link_task_action($path); - my $daction = $self->dir_task_action($path); + my $laction = $self->link_task_action($target_path); + my $daction = $self->dir_task_action($target_path); if ($laction eq 'remove') { if ($daction eq 'remove') { - internal_error("removing link and dir: $path"); + internal_error("removing link and dir: $target_path"); return 0; } elsif ($daction eq 'create') { - # Assume that we're unfolding $path, and that the link + # Assume that we're unfolding $target_path, and that the link # removal action is earlier than the dir creation action # in the task queue. FIXME: is this a safe assumption? return 1; @@ -1727,13 +2027,13 @@ sub is_a_node { } elsif ($laction eq 'create') { if ($daction eq 'remove') { - # Assume that we're folding $path, and that the dir + # Assume that we're folding $target_path, and that the dir # removal action is earlier than the link creation action # in the task queue. FIXME: is this a safe assumption? return 1; } elsif ($daction eq 'create') { - internal_error("creating link and dir: $path"); + internal_error("creating link and dir: $target_path"); return 1; } else { # no dir action @@ -1753,72 +2053,92 @@ sub is_a_node { } } - return 0 if $self->parent_link_scheduled_for_removal($path); + return 0 if $self->parent_link_scheduled_for_removal($target_path); - if (-e $path) { - debug(4, " is_a_node($path): really exists"); + if (-e $target_path) { + debug(4, 3, "| is_a_node($target_path): really exists"); return 1; } - debug(4, " is_a_node($path): returning false"); + debug(4, 3, "| is_a_node($target_path): returning false"); return 0; } -#===== METHOD =============================================================== -# Name : read_a_link() -# Purpose : return the source of a current or planned link -# Parameters: $path => path to the link target -# Returns : a string -# Throws : fatal exception if the given path is not a current or planned -# : link -# Comments : none -#============================================================================ +=head2 read_a_link($link) + +Return the destination of a current or planned link. + +=over 4 + +=item $link + +Path to the link target. + +=back + +Returns the destination of the given link. Throws a fatal exception +if the given path is not a current or planned link. + +=cut + sub read_a_link { my $self = shift; - my ($path) = @_; + my ($link) = @_; - if (my $action = $self->link_task_action($path)) { - debug(4, " read_a_link($path): task exists with action $action"); + if (my $action = $self->link_task_action($link)) { + debug(4, 2, "read_a_link($link): task exists with action $action"); if ($action eq 'create') { - return $self->{link_task_for}{$path}->{source}; + return $self->{link_task_for}{$link}->{source}; } elsif ($action eq 'remove') { internal_error( - "read_a_link() passed a path that is scheduled for removal: $path" + "read_a_link() passed a path that is scheduled for removal: $link" ); } } - elsif (-l $path) { - debug(4, " read_a_link($path): real link"); - my $target = readlink $path or error("Could not read link: $path ($!)"); - return $target; + elsif (-l $link) { + debug(4, 2, "read_a_link($link): is a real link"); + my $link_dest = readlink $link or error("Could not read link: $link ($!)"); + return $link_dest; } - internal_error("read_a_link() passed a non link path: $path\n"); + internal_error("read_a_link() passed a non-link path: $link\n"); } -#===== METHOD =============================================================== -# Name : do_link() -# Purpose : wrap 'link' operation for later processing -# Parameters: $oldfile => the existing file to link to -# : $newfile => the file to link -# Returns : n/a -# Throws : error if this clashes with an existing planned operation -# Comments : cleans up operations that undo previous operations -#============================================================================ +=head2 do_link($link_dest, $link_src) + +Wrap 'link' operation for later processing + +=over 4 + +=item $link_dest + +the existing file to link to + +=item $link_src + +the file to link + +=back + +Throws an error if this clashes with an existing planned operation. +Cleans up operations that undo previous operations. + +=cut + sub do_link { my $self = shift; - my ($oldfile, $newfile) = @_; + my ($link_dest, $link_src) = @_; - if (exists $self->{dir_task_for}{$newfile}) { - my $task_ref = $self->{dir_task_for}{$newfile}; + if (exists $self->{dir_task_for}{$link_src}) { + my $task_ref = $self->{dir_task_for}{$link_src}; if ($task_ref->{action} eq 'create') { if ($task_ref->{type} eq 'dir') { internal_error( "new link (%s => %s) clashes with planned new directory", - $newfile, - $oldfile, + $link_src, + $link_dest, ); } } @@ -1830,11 +2150,11 @@ sub do_link { } } - if (exists $self->{link_task_for}{$newfile}) { - my $task_ref = $self->{link_task_for}{$newfile}; + if (exists $self->{link_task_for}{$link_src}) { + my $task_ref = $self->{link_task_for}{$link_src}; if ($task_ref->{action} eq 'create') { - if ($task_ref->{source} ne $oldfile) { + if ($task_ref->{source} ne $link_dest) { internal_error( "new link clashes with planned new link: %s => %s", $task_ref->{path}, @@ -1842,16 +2162,16 @@ sub do_link { ) } else { - debug(1, "LINK: $newfile => $oldfile (duplicates previous action)"); + debug(1, 0, "LINK: $link_src => $link_dest (duplicates previous action)"); return; } } elsif ($task_ref->{action} eq 'remove') { - if ($task_ref->{source} eq $oldfile) { + if ($task_ref->{source} eq $link_dest) { # No need to remove a link we are going to recreate - debug(1, "LINK: $newfile => $oldfile (reverts previous action)"); - $self->{link_task_for}{$newfile}->{action} = 'skip'; - delete $self->{link_task_for}{$newfile}; + debug(1, 0, "LINK: $link_src => $link_dest (reverts previous action)"); + $self->{link_task_for}{$link_src}->{action} = 'skip'; + delete $self->{link_task_for}{$link_src}; return; } # We may need to remove a link to replace it so continue @@ -1862,27 +2182,36 @@ sub do_link { } # Creating a new link - debug(1, "LINK: $newfile => $oldfile"); + debug(1, 0, "LINK: $link_src => $link_dest"); my $task = { action => 'create', type => 'link', - path => $newfile, - source => $oldfile, + path => $link_src, + source => $link_dest, }; push @{ $self->{tasks} }, $task; - $self->{link_task_for}{$newfile} = $task; + $self->{link_task_for}{$link_src} = $task; return; } -#===== METHOD =============================================================== -# Name : do_unlink() -# Purpose : wrap 'unlink' operation for later processing -# Parameters: $file => the file to unlink -# Returns : n/a -# Throws : error if this clashes with an existing planned operation -# Comments : will remove an existing planned link -#============================================================================ +=head2 do_unlink($file) + +Wrap 'unlink' operation for later processing + +=over 4 + +=item $file + +the file to unlink + +=back + +Throws an error if this clashes with an existing planned operation. +Will remove an existing planned link. + +=cut + sub do_unlink { my $self = shift; my ($file) = @_; @@ -1890,12 +2219,12 @@ sub do_unlink { if (exists $self->{link_task_for}{$file}) { my $task_ref = $self->{link_task_for}{$file}; if ($task_ref->{action} eq 'remove') { - debug(1, "UNLINK: $file (duplicates previous action)"); + debug(1, 0, "UNLINK: $file (duplicates previous action)"); return; } elsif ($task_ref->{action} eq 'create') { # Do need to create a link then remove it - debug(1, "UNLINK: $file (reverts previous action)"); + debug(1, 0, "UNLINK: $file (reverts previous action)"); $self->{link_task_for}{$file}->{action} = 'skip'; delete $self->{link_task_for}{$file}; return; @@ -1914,7 +2243,7 @@ sub do_unlink { } # Remove the link - debug(1, "UNLINK: $file"); + debug(1, 0, "UNLINK: $file"); my $source = readlink $file or error("could not readlink $file ($!)"); @@ -1930,16 +2259,24 @@ sub do_unlink { return; } -#===== METHOD =============================================================== -# Name : do_mkdir() -# Purpose : wrap 'mkdir' operation -# Parameters: $dir => the directory to remove -# Returns : n/a -# Throws : fatal exception if operation fails -# Comments : outputs a message if 'verbose' option is set -# : does not perform operation if 'simulate' option is set -# Comments : cleans up operations that undo previous operations -#============================================================================ +=head2 do_mkdir($dir) + +Wrap 'mkdir' operation + +=over 4 + +=item $dir + +the directory to remove + +=back + +Throws a fatal exception if operation fails. Outputs a message if +'verbose' option is set. Does not perform operation if 'simulate' +option is set. Cleans up operations that undo previous operations. + +=cut + sub do_mkdir { my $self = shift; my ($dir) = @_; @@ -1966,11 +2303,11 @@ sub do_mkdir { my $task_ref = $self->{dir_task_for}{$dir}; if ($task_ref->{action} eq 'create') { - debug(1, "MKDIR: $dir (duplicates previous action)"); + debug(1, 0, "MKDIR: $dir (duplicates previous action)"); return; } elsif ($task_ref->{action} eq 'remove') { - debug(1, "MKDIR: $dir (reverts previous action)"); + debug(1, 0, "MKDIR: $dir (reverts previous action)"); $self->{dir_task_for}{$dir}->{action} = 'skip'; delete $self->{dir_task_for}{$dir}; return; @@ -1980,7 +2317,7 @@ sub do_mkdir { } } - debug(1, "MKDIR: $dir"); + debug(1, 0, "MKDIR: $dir"); my $task = { action => 'create', type => 'dir', @@ -1993,15 +2330,24 @@ sub do_mkdir { return; } -#===== METHOD =============================================================== -# Name : do_rmdir() -# Purpose : wrap 'rmdir' operation -# Parameters: $dir => the directory to remove -# Returns : n/a -# Throws : fatal exception if operation fails -# Comments : outputs a message if 'verbose' option is set -# : does not perform operation if 'simulate' option is set -#============================================================================ +=head2 do_rmdir($dir) + +Wrap 'rmdir' operation + +=over 4 + +=item $dir + +the directory to remove + +=back + +Throws a fatal exception if operation fails. Outputs a message if +'verbose' option is set. Does not perform operation if 'simulate' +option is set. + +=cut + sub do_rmdir { my $self = shift; my ($dir) = @_; @@ -2020,11 +2366,11 @@ sub do_rmdir { my $task_ref = $self->{link_task_for}{$dir}; if ($task_ref->{action} eq 'remove') { - debug(1, "RMDIR $dir (duplicates previous action)"); + debug(1, 0, "RMDIR $dir (duplicates previous action)"); return; } elsif ($task_ref->{action} eq 'create') { - debug(1, "MKDIR $dir (reverts previous action)"); + debug(1, 0, "MKDIR $dir (reverts previous action)"); $self->{link_task_for}{$dir}->{action} = 'skip'; delete $self->{link_task_for}{$dir}; return; @@ -2034,7 +2380,7 @@ sub do_rmdir { } } - debug(1, "RMDIR $dir"); + debug(1, 0, "RMDIR $dir"); my $task = { action => 'remove', type => 'dir', @@ -2047,15 +2393,27 @@ sub do_rmdir { return; } -#===== METHOD =============================================================== -# Name : do_mv() -# Purpose : wrap 'move' operation for later processing -# Parameters: $src => the file to move -# : $dst => the path to move it to -# Returns : n/a -# Throws : error if this clashes with an existing planned operation -# Comments : alters contents of package installation image in stow dir -#============================================================================ +=head2 do_mv($src, $dst) + +Wrap 'move' operation for later processing. + +=over 4 + +=item $src + +the file to move + +=item $dst + +the path to move it to + +=back + +Throws an error if this clashes with an existing planned operation. +Alters contents of package installation image in stow dir. + +=cut + sub do_mv { my $self = shift; my ($src, $dst) = @_; @@ -2078,7 +2436,7 @@ sub do_mv { } # Remove the link - debug(1, "MV: $src -> $dst"); + debug(1, 0, "MV: $src -> $dst"); my $task = { action => 'move', @@ -2101,14 +2459,20 @@ sub do_mv { # FIXME: Ideally these should be in a separate module. -#===== PRIVATE SUBROUTINE =================================================== +# ===== PRIVATE SUBROUTINE =================================================== # Name : internal_error() # Purpose : output internal error message in a consistent form and die -# Parameters: $message => error message to output -# Returns : n/a -# Throws : n/a -# Comments : none -#============================================================================ +=over 4 + +=item $message => error message to output + +=back + +Returns : n/a +Throws : n/a + +=cut + sub internal_error { my ($format, @args) = @_; my $error = sprintf($format, @args); @@ -2132,7 +2496,6 @@ EOF # Local variables: # mode: perl -# cperl-indent-level: 4 # end: # vim: ft=perl diff --git a/lib/Stow/Util.pm.in b/lib/Stow/Util.pm.in index e3e932b..b33fb5a 100644 --- a/lib/Stow/Util.pm.in +++ b/lib/Stow/Util.pm.in @@ -32,12 +32,14 @@ Supporting utility routines for L. use strict; use warnings; +use File::Spec; use POSIX qw(getcwd); use base qw(Exporter); our @EXPORT_OK = qw( error debug set_debug_level set_test_mode - join_paths parent canon_path restore_cwd adjust_dotfile + join_paths parent canon_path restore_cwd + adjust_dotfile unadjust_dotfile ); our $ProgramName = 'stow'; @@ -93,7 +95,7 @@ sub set_test_mode { } } -=head2 debug($level, $msg) +=head2 debug($level[, $indent_level], $msg) Logs to STDERR based on C<$debug_level> setting. C<$level> is the minimum verbosity level required to output C<$msg>. All output is to @@ -125,13 +127,18 @@ overriding, fixing invalid links =cut sub debug { - my ($level, $msg) = @_; + my $level = shift; + my $indent_level; + # Maintain backwards-compatibility in case anyone's relying on this. + $indent_level = $_[0] =~ /^\d+$/ ? shift : 0; + my $msg = shift; if ($debug_level >= $level) { + my $indent = ' ' x $indent_level; if ($test_mode) { - print "# $msg\n"; + print "# $indent$msg\n"; } else { - warn "$msg\n"; + warn "$indent$msg\n"; } } } @@ -142,29 +149,53 @@ sub debug { # Parameters: path1, path2, ... => paths # Returns : concatenation of given paths # Throws : n/a -# Comments : factors out redundant path elements: -# : '//' => '/' and 'a/b/../c' => 'a/c' +# Comments : Factors out some redundant path elements: +# : '//' => '/', and 'a/b/../c' => 'a/c'. We need this function +# : with this behaviour, even though b could be a symlink to +# : elsewhere, as noted in the perldoc for File::Spec->canonpath(). +# : This behaviour is deliberately different to +# : Stow::Util::canon_path(), because the way join_paths() is used +# : relies on this. Firstly, there is no guarantee that the paths +# : exist, so a filesystem check is inappropriate. +# : +# : For example, it's used to determine the path from the target +# : directory to a symlink destination. So if a symlink +# : path/to/target/a/b/c points to ../../../stow/pkg/a/b/c, +# : then joining path/to/target/a/b with ../../../stow/pkg/a/b/c +# : yields path/to/stow/pkg/a/b/c, and it's crucial that the +# : path/to/stow prefix matches a recognisable stow directory. #============================================================================ sub join_paths { my @paths = @_; - # weed out empty components and concatenate - my $result = join '/', grep {! /\A\z/} @paths; + debug(5, 5, "| Joining: @paths"); + my $result = ''; + for my $part (@paths) { + next if ! length $part; # probably shouldn't happen? + $part = File::Spec->canonpath($part); - # factor out back references and remove redundant /'s) - my @result = (); - PART: - for my $part (split m{/+}, $result) { - next PART if $part eq '.'; - if (@result && $part eq '..' && $result[-1] ne '..') { - pop @result; + if (substr($part, 0, 1) eq '/') { + $result = $part; # absolute path, so ignore all previous parts } else { - push @result, $part; + $result .= '/' if length $result && $result ne '/'; + $result .= $part; } + debug(7, 6, "| Join now: $result"); } + debug(6, 5, "| Joined: $result"); - return join '/', @result; + # Need this to remove any initial ./ + $result = File::Spec->canonpath($result); + + # remove foo/.. + 1 while $result =~ s,(^|/)(?!\.\.)[^/]+/\.\.(/|$),$1,; + debug(6, 5, "| After .. removal: $result"); + + $result = File::Spec->canonpath($result); + debug(5, 5, "| Final join: $result"); + + return $result; } #===== METHOD =============================================================== @@ -181,7 +212,7 @@ sub parent { my $path = join '/', @_; my @elts = split m{/+}, $path; pop @elts; - return join '/', @elts; + return join '/', @elts; } #===== METHOD =============================================================== @@ -209,17 +240,17 @@ sub restore_cwd { } sub adjust_dotfile { - my ($target) = @_; + my ($pkg_node) = @_; + (my $adjusted = $pkg_node) =~ s/^dot-([^.])/.$1/; + return $adjusted; +} - my @result = (); - for my $part (split m{/+}, $target) { - if (($part ne "dot-") && ($part ne "dot-.")) { - $part =~ s/^dot-/./; - } - push @result, $part; - } - - return join '/', @result; +# Needed when unstowing with --compat and --dotfiles +sub unadjust_dotfile { + my ($target_node) = @_; + return $target_node if $target_node =~ /^\.\.?$/; + (my $adjusted = $target_node) =~ s/^\./dot-/; + return $adjusted; } =head1 BUGS @@ -232,6 +263,5 @@ sub adjust_dotfile { # Local variables: # mode: perl -# cperl-indent-level: 4 # end: # vim: ft=perl diff --git a/t/cleanup_invalid_links.t b/t/cleanup_invalid_links.t index 3b54b71..a859356 100755 --- a/t/cleanup_invalid_links.t +++ b/t/cleanup_invalid_links.t @@ -22,10 +22,11 @@ use strict; use warnings; -use Test::More tests => 6; +use Test::More tests => 4; use English qw(-no_match_vars); use testutil; +use Stow::Util; init_test_dirs(); cd("$TEST_DIR/target"); @@ -34,48 +35,64 @@ my $stow; # Note that each of the following tests use a distinct set of files -# -# nothing to clean in a simple tree -# +subtest('nothing to clean in a simple tree' => sub { + plan tests => 1; + make_path('../stow/pkg1/bin1'); + make_file('../stow/pkg1/bin1/file1'); + make_link('bin1', '../stow/pkg1/bin1'); -make_path('../stow/pkg1/bin1'); -make_file('../stow/pkg1/bin1/file1'); -make_link('bin1', '../stow/pkg1/bin1'); + $stow = new_Stow(); + $stow->cleanup_invalid_links('./'); + is( + scalar($stow->get_tasks), 0 + => 'nothing to clean' + ); +}); -$stow = new_Stow(); -$stow->cleanup_invalid_links('./'); -is( - scalar($stow->get_tasks), 0 - => 'nothing to clean' -); +subtest('cleanup an orphaned owned link in a simple tree' => sub { + plan tests => 3; -# -# cleanup a bad link in a simple tree -# -make_path('bin2'); -make_path('../stow/pkg2/bin2'); -make_file('../stow/pkg2/bin2/file2a'); -make_link('bin2/file2a', '../../stow/pkg2/bin2/file2a'); -make_invalid_link('bin2/file2b', '../../stow/pkg2/bin2/file2b'); + make_path('bin2'); + make_path('../stow/pkg2/bin2'); + make_file('../stow/pkg2/bin2/file2a'); + make_link('bin2/file2a', '../../stow/pkg2/bin2/file2a'); + make_invalid_link('bin2/file2b', '../../stow/pkg2/bin2/file2b'); -$stow = new_Stow(); -$stow->cleanup_invalid_links('bin2'); -is($stow->get_conflict_count, 0, 'no conflicts cleaning up bad link'); -is(scalar($stow->get_tasks), 1, 'one task cleaning up bad link'); -is($stow->link_task_action('bin2/file2b'), 'remove', 'removal task for bad link'); + $stow = new_Stow(); + $stow->cleanup_invalid_links('bin2'); + is($stow->get_conflict_count, 0, 'no conflicts cleaning up bad link'); + is(scalar($stow->get_tasks), 1, 'one task cleaning up bad link'); + is($stow->link_task_action('bin2/file2b'), 'remove', 'removal task for bad link'); +}); -# -# dont cleanup a bad link not owned by stow -# +subtest("don't cleanup a bad link not owned by stow" => sub { + plan tests => 2; -make_path('bin3'); -make_path('../stow/pkg3/bin3'); -make_file('../stow/pkg3/bin3/file3a'); -make_link('bin3/file3a', '../../stow/pkg3/bin3/file3a'); -make_invalid_link('bin3/file3b', '../../empty'); + make_path('bin3'); + make_path('../stow/pkg3/bin3'); + make_file('../stow/pkg3/bin3/file3a'); + make_link('bin3/file3a', '../../stow/pkg3/bin3/file3a'); + make_invalid_link('bin3/file3b', '../../empty'); -$stow = new_Stow(); -$stow->cleanup_invalid_links('bin3'); -is($stow->get_conflict_count, 0, 'no conflicts cleaning up bad link not owned by stow'); -is(scalar($stow->get_tasks), 0, 'no tasks cleaning up bad link not owned by stow'); + $stow = new_Stow(); + $stow->cleanup_invalid_links('bin3'); + is($stow->get_conflict_count, 0, 'no conflicts cleaning up bad link not owned by stow'); + is(scalar($stow->get_tasks), 0, 'no tasks cleaning up bad link not owned by stow'); +}); + +subtest("don't cleanup a valid link in the target not owned by stow" => sub { + plan tests => 2; + + make_path('bin4'); + make_path('../stow/pkg4/bin4'); + make_file('../stow/pkg4/bin4/file3a'); + make_link('bin4/file3a', '../../stow/pkg4/bin4/file3a'); + make_file("unowned"); + make_link('bin4/file3b', '../unowned'); + + $stow = new_Stow(); + $stow->cleanup_invalid_links('bin4'); + is($stow->get_conflict_count, 0, 'no conflicts cleaning up bad link not owned by stow'); + is(scalar($stow->get_tasks), 0, 'no tasks cleaning up bad link not owned by stow'); +}); diff --git a/t/dotfiles.t b/t/dotfiles.t index 9e70ad4..643b873 100755 --- a/t/dotfiles.t +++ b/t/dotfiles.t @@ -22,190 +22,214 @@ use strict; use warnings; -use testutil; - -use Test::More tests => 10; +use Test::More tests => 12; use English qw(-no_match_vars); +use Stow::Util qw(adjust_dotfile unadjust_dotfile); use testutil; init_test_dirs(); cd("$TEST_DIR/target"); +subtest('adjust_dotfile()', sub { + plan tests => 4; + my @TESTS = ( + ['file'], + ['dot-'], + ['dot-.'], + ['dot-file', '.file'], + ); + for my $test (@TESTS) { + my ($input, $expected) = @$test; + $expected ||= $input; + is(adjust_dotfile($input), $expected); + } +}); + +subtest('unadjust_dotfile()', sub { + plan tests => 4; + my @TESTS = ( + ['file'], + ['.'], + ['..'], + ['.file', 'dot-file'], + ); + for my $test (@TESTS) { + my ($input, $expected) = @$test; + $expected ||= $input; + is(unadjust_dotfile($input), $expected); + } +}); + my $stow; -# -# process a dotfile marked with 'dot' prefix -# +subtest("stow dot-foo as .foo", sub { + plan tests => 1; + $stow = new_Stow(dir => '../stow', dotfiles => 1); + make_path('../stow/dotfiles'); + make_file('../stow/dotfiles/dot-foo'); -$stow = new_Stow(dir => '../stow', dotfiles => 1); + $stow->plan_stow('dotfiles'); + $stow->process_tasks(); + is( + readlink('.foo'), + '../stow/dotfiles/dot-foo', + => 'processed dotfile' + ); +}); -make_path('../stow/dotfiles'); -make_file('../stow/dotfiles/dot-foo'); +subtest("stow dot-foo as dot-foo without --dotfile enabled", sub { + plan tests => 1; + $stow = new_Stow(dir => '../stow', dotfiles => 0); + make_path('../stow/dotfiles'); + make_file('../stow/dotfiles/dot-foo'); -$stow->plan_stow('dotfiles'); -$stow->process_tasks(); -is( - readlink('.foo'), - '../stow/dotfiles/dot-foo', - => 'processed dotfile' -); + $stow->plan_stow('dotfiles'); + $stow->process_tasks(); + is( + readlink('dot-foo'), + '../stow/dotfiles/dot-foo', + => 'unprocessed dotfile' + ); +}); -# -# ensure that turning off dotfile processing links files as usual -# +subtest("stow dot-emacs dir as .emacs", sub { + plan tests => 1; + $stow = new_Stow(dir => '../stow', dotfiles => 1); -$stow = new_Stow(dir => '../stow', dotfiles => 0); + make_path('../stow/dotfiles/dot-emacs'); + make_file('../stow/dotfiles/dot-emacs/init.el'); -make_path('../stow/dotfiles'); -make_file('../stow/dotfiles/dot-foo'); + $stow->plan_stow('dotfiles'); + $stow->process_tasks(); + is( + readlink('.emacs'), + '../stow/dotfiles/dot-emacs', + => 'processed dotfile dir' + ); +}); -$stow->plan_stow('dotfiles'); -$stow->process_tasks(); -is( - readlink('dot-foo'), - '../stow/dotfiles/dot-foo', - => 'unprocessed dotfile' -); +subtest("stow dir marked with 'dot' prefix when directory exists in target", sub { + plan tests => 1; + $stow = new_Stow(dir => '../stow', dotfiles => 1); + make_path('../stow/dotfiles/dot-emacs.d'); + make_file('../stow/dotfiles/dot-emacs.d/init.el'); + make_path('.emacs.d'); -# -# process folder marked with 'dot' prefix -# + $stow->plan_stow('dotfiles'); + $stow->process_tasks(); + is( + readlink('.emacs.d/init.el'), + '../../stow/dotfiles/dot-emacs.d/init.el', + => 'processed dotfile dir when dir exists (1 level)' + ); +}); -$stow = new_Stow(dir => '../stow', dotfiles => 1); +subtest("stow dir marked with 'dot' prefix when directory exists in target (2 levels)", sub { + plan tests => 1; + $stow = new_Stow(dir => '../stow', dotfiles => 1); -make_path('../stow/dotfiles/dot-emacs'); -make_file('../stow/dotfiles/dot-emacs/init.el'); + make_path('../stow/dotfiles/dot-emacs.d/dot-emacs.d'); + make_file('../stow/dotfiles/dot-emacs.d/dot-emacs.d/init.el'); + make_path('.emacs.d'); -$stow->plan_stow('dotfiles'); -$stow->process_tasks(); -is( - readlink('.emacs'), - '../stow/dotfiles/dot-emacs', - => 'processed dotfile folder' -); + $stow->plan_stow('dotfiles'); + $stow->process_tasks(); + is( + readlink('.emacs.d/.emacs.d'), + '../../stow/dotfiles/dot-emacs.d/dot-emacs.d', + => 'processed dotfile dir exists (2 levels)' + ); +}); -# -# process folder marked with 'dot' prefix -# when directory exists is target -# +subtest("stow dir marked with 'dot' prefix when directory exists in target", sub { + plan tests => 1; + $stow = new_Stow(dir => '../stow', dotfiles => 1); -$stow = new_Stow(dir => '../stow', dotfiles => 1); + make_path('../stow/dotfiles/dot-one/dot-two'); + make_file('../stow/dotfiles/dot-one/dot-two/three'); + make_path('.one/.two'); -make_path('../stow/dotfiles/dot-emacs.d'); -make_file('../stow/dotfiles/dot-emacs.d/init.el'); -make_path('.emacs.d'); + $stow->plan_stow('dotfiles'); + $stow->process_tasks(); + is( + readlink('./.one/.two/three'), + '../../../stow/dotfiles/dot-one/dot-two/three', + => 'processed dotfile 2 dir exists (2 levels)' + ); -$stow->plan_stow('dotfiles'); -$stow->process_tasks(); -is( - readlink('.emacs.d/init.el'), - '../../stow/dotfiles/dot-emacs.d/init.el', - => 'processed dotfile folder when folder exists (1 level)' -); +}); -# -# process folder marked with 'dot' prefix -# when directory exists is target (2 levels) -# +subtest("dot-. should not have that part expanded.", sub { + plan tests => 2; + $stow = new_Stow(dir => '../stow', dotfiles => 1); -$stow = new_Stow(dir => '../stow', dotfiles => 1); + make_path('../stow/dotfiles'); + make_file('../stow/dotfiles/dot-'); -make_path('../stow/dotfiles/dot-emacs.d/dot-emacs.d'); -make_file('../stow/dotfiles/dot-emacs.d/dot-emacs.d/init.el'); -make_path('.emacs.d'); + make_path('../stow/dotfiles/dot-.'); + make_file('../stow/dotfiles/dot-./foo'); -$stow->plan_stow('dotfiles'); -$stow->process_tasks(); -is( - readlink('.emacs.d/.emacs.d'), - '../../stow/dotfiles/dot-emacs.d/dot-emacs.d', - => 'processed dotfile folder exists (2 levels)' -); + $stow->plan_stow('dotfiles'); + $stow->process_tasks(); + is( + readlink('dot-'), + '../stow/dotfiles/dot-', + => 'processed dotfile' + ); + is( + readlink('dot-.'), + '../stow/dotfiles/dot-.', + => 'unprocessed dotfile' + ); +}); -# -# process folder marked with 'dot' prefix -# when directory exists is target -# +subtest("unstow .bar from dot-bar", sub { + plan tests => 3; + $stow = new_Stow(dir => '../stow', dotfiles => 1); -$stow = new_Stow(dir => '../stow', dotfiles => 1); + make_path('../stow/dotfiles'); + make_file('../stow/dotfiles/dot-bar'); + make_link('.bar', '../stow/dotfiles/dot-bar'); -make_path('../stow/dotfiles/dot-one/dot-two'); -make_file('../stow/dotfiles/dot-one/dot-two/three'); -make_path('.one/.two'); + $stow->plan_unstow('dotfiles'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0); + ok(-f '../stow/dotfiles/dot-bar', 'package file untouched'); + ok(! -e '.bar' => '.bar was unstowed'); +}); -$stow->plan_stow('dotfiles'); -$stow->process_tasks(); -is( - readlink('./.one/.two/three'), - '../../../stow/dotfiles/dot-one/dot-two/three', - => 'processed dotfile 2 folder exists (2 levels)' -); +subtest("unstow dot-emacs.d/init.el when .emacs.d/init.el in target", sub { + plan tests => 4; + $stow = new_Stow(dir => '../stow', dotfiles => 1); + make_path('../stow/dotfiles/dot-emacs.d'); + make_file('../stow/dotfiles/dot-emacs.d/init.el'); + make_path('.emacs.d'); + make_link('.emacs.d/init.el', '../../stow/dotfiles/dot-emacs.d/init.el'); -# -# corner case: paths that have a part in them that's just "$DOT_PREFIX" or -# "$DOT_PREFIX." should not have that part expanded. -# + $stow->plan_unstow('dotfiles'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0); + ok(-f '../stow/dotfiles/dot-emacs.d/init.el'); + ok(! -e '.emacs.d/init.el', '.emacs.d/init.el unstowed'); + ok(-d '.emacs.d/' => '.emacs.d left behind'); +}); -$stow = new_Stow(dir => '../stow', dotfiles => 1); +subtest("unstow dot-emacs.d/init.el in --compat mode", sub { + plan tests => 4; + $stow = new_compat_Stow(dir => '../stow', dotfiles => 1); -make_path('../stow/dotfiles'); -make_file('../stow/dotfiles/dot-'); + make_path('../stow/dotfiles/dot-emacs.d'); + make_file('../stow/dotfiles/dot-emacs.d/init.el'); + make_path('.emacs.d'); + make_link('.emacs.d/init.el', '../../stow/dotfiles/dot-emacs.d/init.el'); -make_path('../stow/dotfiles/dot-.'); -make_file('../stow/dotfiles/dot-./foo'); - -$stow->plan_stow('dotfiles'); -$stow->process_tasks(); -is( - readlink('dot-'), - '../stow/dotfiles/dot-', - => 'processed dotfile' -); -is( - readlink('dot-.'), - '../stow/dotfiles/dot-.', - => 'unprocessed dotfile' -); - -# -# simple unstow scenario -# - -$stow = new_Stow(dir => '../stow', dotfiles => 1); - -make_path('../stow/dotfiles'); -make_file('../stow/dotfiles/dot-bar'); -make_link('.bar', '../stow/dotfiles/dot-bar'); - -$stow->plan_unstow('dotfiles'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f '../stow/dotfiles/dot-bar' && ! -e '.bar' - => 'unstow a simple dotfile' -); - -# -# unstow process folder marked with 'dot' prefix -# when directory exists is target -# - -$stow = new_Stow(dir => '../stow', dotfiles => 1); - -make_path('../stow/dotfiles/dot-emacs.d'); -make_file('../stow/dotfiles/dot-emacs.d/init.el'); -make_path('.emacs.d'); -make_link('.emacs.d/init.el', '../../stow/dotfiles/dot-emacs.d/init.el'); - -$stow->plan_unstow('dotfiles'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f '../stow/dotfiles/dot-emacs.d/init.el' && - ! -e '.emacs.d/init.el' && - -d '.emacs.d/' - => 'unstow dotfile folder when folder already exists' -); + $stow->plan_unstow('dotfiles'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0); + ok(-f '../stow/dotfiles/dot-emacs.d/init.el'); + ok(! -e '.emacs.d/init.el', '.emacs.d/init.el unstowed'); + ok(-d '.emacs.d/' => '.emacs.d left behind'); +}); diff --git a/t/find_stowed_path.t b/t/find_stowed_path.t index 7b82520..8ae4fca 100755 --- a/t/find_stowed_path.t +++ b/t/find_stowed_path.t @@ -16,65 +16,133 @@ # along with this program. If not, see https://www.gnu.org/licenses/. # -# Testing find_stowed_path() +# Testing Stow:: find_stowed_path() # use strict; use warnings; -use Test::More tests => 18; +use Test::More tests => 10; use testutil; use Stow::Util qw(set_debug_level); init_test_dirs(); -my $stow = new_Stow(dir => "$TEST_DIR/stow"); -#set_debug_level(4); +subtest("find link to a stowed path with relative target" => sub { + plan tests => 3; -my ($path, $stow_path, $package) = - $stow->find_stowed_path("$TEST_DIR/target/a/b/c", "../../../stow/a/b/c"); -is($path, "$TEST_DIR/stow/a/b/c", "path"); -is($stow_path, "$TEST_DIR/stow", "stow path"); -is($package, "a", "package"); + # This is a relative path, unlike $ABS_TEST_DIR below. + my $target = "$TEST_DIR/target"; -cd("$TEST_DIR/target"); -$stow->set_stow_dir("../stow"); -($path, $stow_path, $package) = - $stow->find_stowed_path("a/b/c", "../../../stow/a/b/c"); -is($path, "../stow/a/b/c", "path from target directory"); -is($stow_path, "../stow", "stow path from target directory"); -is($package, "a", "from target directory"); + my $stow = new_Stow(dir => "$TEST_DIR/stow", target => $target); + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "../../../stow/a/b/c"); + is($path, "../stow/a/b/c", "path"); + is($stow_path, "../stow", "stow path"); + is($package, "a", "package"); +}); -make_path("stow"); -cd("../.."); -$stow->set_stow_dir("$TEST_DIR/target/stow"); +my $stow = new_Stow(dir => "$ABS_TEST_DIR/stow", target => "$ABS_TEST_DIR/target"); -($path, $stow_path, $package) = - $stow->find_stowed_path("$TEST_DIR/target/a/b/c", "../../stow/a/b/c"); -is($path, "$TEST_DIR/target/stow/a/b/c", "path"); -is($stow_path, "$TEST_DIR/target/stow", "stow path"); -is($package, "a", "stow is subdir of target directory"); +# Required by creation of stow2 and stow2/.stow below +cd("$ABS_TEST_DIR/target"); -($path, $stow_path, $package) = - $stow->find_stowed_path("$TEST_DIR/target/a/b/c", "../../empty"); -is($path, "", "empty path"); -is($stow_path, "", "empty stow path"); -is($package, "", "target is not stowed"); +subtest("find link to a stowed path" => sub { + plan tests => 3; + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "../../../stow/a/b/c"); + is($path, "../stow/a/b/c", "path from target directory"); + is($stow_path, "../stow", "stow path from target directory"); + is($package, "a", "from target directory"); +}); -make_path("$TEST_DIR/target/stow2"); -make_file("$TEST_DIR/target/stow2/.stow"); +subtest("find link to alien path not owned by Stow" => sub { + plan tests => 3; + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "../../alien"); + is($path, "", "alien is not stowed, so path is empty"); + is($stow_path, "", "alien, so stow path is empty"); + is($package, "", "alien is not stowed in any package"); +}); -($path, $stow_path, $package) = - $stow->find_stowed_path("$TEST_DIR/target/a/b/c","../../stow2/a/b/c"); -is($path, "$TEST_DIR/target/stow2/a/b/c", "path"); -is($stow_path, "$TEST_DIR/target/stow2", "stow path"); -is($package, "a", "detect alternate stow directory"); +# Make a second stow directory within the target directory, so that we +# can check that links to package files within that stow directory are +# detected correctly. +make_path("stow2"); -# Possible corner case with rogue symlink pointing to ancestor of -# stow dir. -($path, $stow_path, $package) = - $stow->find_stowed_path("$TEST_DIR/target/a/b/c","../../.."); -is($path, "", "path"); -is($stow_path, "", "stow path"); -is($package, "", "corner case - link points to ancestor of stow dir"); +# However this second stow directory is still "alien" to stow until we +# put a .stow file in it. So first test a symlink pointing to a path +# within this second stow directory +subtest("second stow dir still alien without .stow" => sub { + plan tests => 3; + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "../../stow2/a/b/c"); + is($path, "", "stow2 not a stow dir yet, so path is empty"); + is($stow_path, "", "stow2 not a stow dir yet so stow path is empty"); + is($package, "", "not stowed in any recognised package yet"); +}); + +# Now make stow2 a secondary stow directory and test that +make_file("stow2/.stow"); + +subtest(".stow makes second stow dir owned by Stow" => sub { + plan tests => 3; + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "../../stow2/a/b/c"); + is($path, "stow2/a/b/c", "path"); + is($stow_path, "stow2", "stow path"); + is($package, "a", "detect alternate stow directory"); +}); + +subtest("relative symlink pointing to target dir" => sub { + plan tests => 3; + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "../../.."); + # Technically the target dir is not owned by Stow, since + # Stow won't touch the target dir itself, only its contents. + is($path, "", "path"); + is($stow_path, "", "stow path"); + is($package, "", "corner case - link points to target dir"); +}); + +subtest("relative symlink pointing to parent of target dir" => sub { + plan tests => 3; + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "../../../.."); + is($path, "", "path"); + is($stow_path, "", "stow path"); + is($package, "", "corner case - link points to parent of target dir"); +}); + +subtest("unowned symlink pointing to absolute path inside target" => sub { + plan tests => 3; + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "$ABS_TEST_DIR/target/d"); + is($path, "", "path"); + is($stow_path, "", "stow path"); + is($package, "", "symlink unowned by Stow points to absolute path outside target directory"); +}); + +subtest("unowned symlink pointing to absolute path outside target" => sub { + plan tests => 3; + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "/dev/null"); + is($path, "", "path"); + is($stow_path, "", "stow path"); + is($package, "", "symlink unowned by Stow points to absolute path outside target directory"); +}); + +# Now make stow2 the primary stow directory and test that it still +# works when the stow directory is under the target directory +$stow->set_stow_dir("$ABS_TEST_DIR/target/stow2"); + +subtest("stow2 becomes the primary stow directory" => sub { + plan tests => 3; + + my ($path, $stow_path, $package) = + $stow->find_stowed_path("a/b/c", "../../stow2/a/b/c"); + is($path, "stow2/a/b/c", "path in stow2"); + is($stow_path, "stow2", "stow path for stow2"); + is($package, "a", "stow2 is subdir of target directory"); +}); diff --git a/t/join_paths.t b/t/join_paths.t index fa96d66..40c5a8f 100755 --- a/t/join_paths.t +++ b/t/join_paths.t @@ -22,91 +22,40 @@ use strict; use warnings; -use Stow::Util qw(join_paths); +use Stow::Util qw(join_paths set_debug_level); -use Test::More tests => 14; +#set_debug_level(4); -is( - join_paths('a/b/c', 'd/e/f'), - 'a/b/c/d/e/f' - => 'simple' +use Test::More tests => 22; + +my @TESTS = ( + [['a/b/c', 'd/e/f'], 'a/b/c/d/e/f' => 'simple'], + [['a/b/c', '/d/e/f'], '/d/e/f' => 'relative then absolute'], + [['/a/b/c', 'd/e/f'], '/a/b/c/d/e/f' => 'absolute then relative'], + [['/a/b/c', '/d/e/f'], '/d/e/f' => 'two absolutes'], + [['/a/b/c/', '/d/e/f/'], '/d/e/f' => 'two absolutes with trailing /'], + [['///a/b///c//', '/d///////e/f'], '/d/e/f' => "multiple /'s, absolute"], + [['///a/b///c//', 'd///////e/f'], '/a/b/c/d/e/f' => "multiple /'s, relative"], + [['', 'a/b/c'], 'a/b/c' => 'first empty'], + [['a/b/c', ''], 'a/b/c' => 'second empty'], + [['/', 'a/b/c'], '/a/b/c' => 'first is /'], + [['a/b/c', '/'], '/' => 'second is /'], + [['../a1/b1/../c1/', 'a2/../b2/e2'], '../a1/c1/b2/e2' => 'relative with ../'], + [['../a1/b1/../c1/', '/a2/../b2/e2'], '/b2/e2' => 'absolute with ../'], + [['../a1/../../c1', 'a2/../../'], '../..' => 'lots of ../'], + [['./', '../a2'], '../a2' => 'drop any "./"'], + [['./a1', '../../a2'], '../a2' => 'drop any "./foo"'], + [['a/b/c', '.'], 'a/b/c' => '. on RHS'], + [['a/b/c', '.', 'd/e'], 'a/b/c/d/e' => '. in middle'], + [['0', 'a/b'], '0/a/b' => '0 at start'], + [['/0', 'a/b'], '/0/a/b' => '/0 at start'], + [['a/b/c', '0', 'd/e'], 'a/b/c/0/d/e' => '0 in middle'], + [['a/b', '0'], 'a/b/0' => '0 at end'], ); -is( - join_paths('/a/b/c', '/d/e/f'), - '/a/b/c/d/e/f' - => 'leading /' -); - -is( - join_paths('/a/b/c/', '/d/e/f/'), - '/a/b/c/d/e/f' - => 'trailing /' -); - -is( - join_paths('///a/b///c//', '/d///////e/f'), - '/a/b/c/d/e/f' - => 'mltiple /\'s' -); - -is( - join_paths('', 'a/b/c'), - 'a/b/c' - => 'first empty' -); - -is( - join_paths('a/b/c', ''), - 'a/b/c' - => 'second empty' -); - -is( - join_paths('/', 'a/b/c'), - '/a/b/c' - => 'first is /' -); - -is( - join_paths('a/b/c', '/'), - 'a/b/c' - => 'second is /' -); - -is( - join_paths('///a/b///c//', '/d///////e/f'), - '/a/b/c/d/e/f' - => 'multiple /\'s' -); - - -is( - join_paths('../a1/b1/../c1/', '/a2/../b2/e2'), - '../a1/c1/b2/e2' - => 'simple deref ".."' -); - -is( - join_paths('../a1/b1/../c1/d1/e1', '../a2/../b2/c2/d2/../e2'), - '../a1/c1/d1/b2/c2/e2' - => 'complex deref ".."' -); - -is( - join_paths('../a1/../../c1', 'a2/../../'), - '../..' - => 'too many ".."' -); - -is( - join_paths('./a1', '../../a2'), - '../a2' - => 'drop any "./"' -); - -is( - join_paths('a/b/c', '.'), - 'a/b/c' - => '. on RHS' -); +for my $test (@TESTS) { + my ($inputs, $expected, $scenario) = @$test; + my $got = join_paths(@$inputs); + my $descr = "$scenario: in=[" . join(', ', map "'$_'", @$inputs) . "] exp=[$expected] got=[$got]"; + is($got, $expected, $descr); +} diff --git a/t/link_dest_within_stow_dir.t b/t/link_dest_within_stow_dir.t new file mode 100755 index 0000000..01ec2f4 --- /dev/null +++ b/t/link_dest_within_stow_dir.t @@ -0,0 +1,88 @@ +#!/usr/bin/perl +# +# This file is part of GNU Stow. +# +# GNU Stow is free software: you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# GNU Stow is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see https://www.gnu.org/licenses/. + +# +# Testing Stow::link_dest_within_stow_dir() +# + +use strict; +use warnings; + +use Test::More tests => 6; + +use testutil; +use Stow::Util; + +init_test_dirs(); + +# This is a relative path, unlike $ABS_TEST_DIR below. +my $stow = new_Stow(dir => "$TEST_DIR/stow", + target => "$TEST_DIR/target"); + +subtest("relative stow dir, link to top-level package file" => sub { + plan tests => 2; + my ($package, $path) = + $stow->link_dest_within_stow_dir("../stow/pkg/dir/file"); + is($package, "pkg", "package"); + is($path, "dir/file", "path"); +}); + +subtest("relative stow dir, link to second-level package file" => sub { + plan tests => 2; + my ($package, $path) = + $stow->link_dest_within_stow_dir("../stow/pkg/dir/subdir/file"); + is($package, "pkg", "package"); + is($path, "dir/subdir/file", "path"); +}); + +# This is an absolute path, unlike $TEST_DIR above. +$stow = new_Stow(dir => "$ABS_TEST_DIR/stow", + target => "$ABS_TEST_DIR/target"); + +subtest("relative stow dir, link to second-level package file" => sub { + plan tests => 2; + my ($package, $path) = + $stow->link_dest_within_stow_dir("../stow/pkg/dir/file"); + is($package, "pkg", "package"); + is($path, "dir/file", "path"); +}); + +subtest("absolute stow dir, link to top-level package file" => sub { + plan tests => 2; + my ($package, $path) = + $stow->link_dest_within_stow_dir("../stow/pkg/dir/subdir/file"); + is($package, "pkg", "package"); + is($path, "dir/subdir/file", "path"); +}); + +# Links with destination in the target are not pointing within +# the stow dir, so they're not owned by stow. +subtest("link to path in target" => sub { + plan tests => 2; + my ($package, $path) = + $stow->link_dest_within_stow_dir("./alien"); + is($path, "", "alien is in target, so path is empty"); + is($package, "", "alien is in target, so package is empty"); +}); + +subtest("link to path outside target and stow dir" => sub { + plan tests => 2; + my ($package, $path) = + $stow->link_dest_within_stow_dir("../alien"); + is($path, "", "alien is outside, so path is empty"); + is($package, "", "alien is outside, so package is empty"); +}); diff --git a/t/stow.t b/t/stow.t index 0563457..d23e8d6 100755 --- a/t/stow.t +++ b/t/stow.t @@ -22,7 +22,7 @@ use strict; use warnings; -use Test::More tests => 118; +use Test::More tests => 22; use Test::Output; use English qw(-no_match_vars); @@ -37,520 +37,535 @@ my %conflicts; # Note that each of the following tests use a distinct set of files -# -# stow a simple tree minimally -# -$stow = new_Stow(dir => '../stow'); +subtest('stow a simple tree minimally', sub { + plan tests => 2; + my $stow = new_Stow(dir => '../stow'); -make_path('../stow/pkg1/bin1'); -make_file('../stow/pkg1/bin1/file1'); + make_path('../stow/pkg1/bin1'); + make_file('../stow/pkg1/bin1/file1'); -$stow->plan_stow('pkg1'); -$stow->process_tasks(); -is_deeply([ $stow->get_conflicts ], [], 'no conflicts with minimal stow'); -is( - readlink('bin1'), - '../stow/pkg1/bin1', - => 'minimal stow of a simple tree' -); - -# -# stow a simple tree into an existing directory -# -$stow = new_Stow(); - -make_path('../stow/pkg2/lib2'); -make_file('../stow/pkg2/lib2/file2'); -make_path('lib2'); - -$stow->plan_stow('pkg2'); -$stow->process_tasks(); -is( - readlink('lib2/file2'), - '../../stow/pkg2/lib2/file2', - => 'stow simple tree to existing directory' -); - -# -# unfold existing tree -# -$stow = new_Stow(); - -make_path('../stow/pkg3a/bin3'); -make_file('../stow/pkg3a/bin3/file3a'); -make_link('bin3' => '../stow/pkg3a/bin3'); # emulate stow - -make_path('../stow/pkg3b/bin3'); -make_file('../stow/pkg3b/bin3/file3b'); - -$stow->plan_stow('pkg3b'); -$stow->process_tasks(); -ok( - -d 'bin3' && - readlink('bin3/file3a') eq '../../stow/pkg3a/bin3/file3a' && - readlink('bin3/file3b') eq '../../stow/pkg3b/bin3/file3b' - => 'target already has 1 stowed package' -); - -# -# Link to a new dir 'bin4' conflicts with existing non-dir so can't -# unfold -# -$stow = new_Stow(); - -make_file('bin4'); # this is a file but named like a directory -make_path('../stow/pkg4/bin4'); -make_file('../stow/pkg4/bin4/file4'); - -$stow->plan_stow('pkg4'); -%conflicts = $stow->get_conflicts(); -ok( - $stow->get_conflict_count == 1 && - $conflicts{stow}{pkg4}[0] =~ - qr/existing target is neither a link nor a directory/ - => 'link to new dir bin4 conflicts with existing non-directory' -); - -# -# Link to a new dir 'bin4a' conflicts with existing non-dir so can't -# unfold even with --adopt -# -#$stow = new_Stow(adopt => 1); -$stow = new_Stow(); - -make_file('bin4a'); # this is a file but named like a directory -make_path('../stow/pkg4a/bin4a'); -make_file('../stow/pkg4a/bin4a/file4a'); - -$stow->plan_stow('pkg4a'); -%conflicts = $stow->get_conflicts(); -ok( - $stow->get_conflict_count == 1 && - $conflicts{stow}{pkg4a}[0] =~ - qr/existing target is neither a link nor a directory/ - => 'link to new dir bin4a conflicts with existing non-directory' -); - -# -# Link to files 'file4b' and 'bin4b' conflict with existing files -# without --adopt -# -$stow = new_Stow(); - -# Populate target -make_file('file4b', 'file4b - version originally in target'); -make_path ('bin4b'); -make_file('bin4b/file4b', 'bin4b/file4b - version originally in target'); - -# Populate -make_path ('../stow/pkg4b/bin4b'); -make_file('../stow/pkg4b/file4b', 'file4b - version originally in stow package'); -make_file('../stow/pkg4b/bin4b/file4b', 'bin4b/file4b - version originally in stow package'); - -$stow->plan_stow('pkg4b'); -%conflicts = $stow->get_conflicts(); -is($stow->get_conflict_count, 2 => 'conflict per file'); -for my $i (0, 1) { - like( - $conflicts{stow}{pkg4b}[$i], - qr/existing target is neither a link nor a directory/ - => 'link to file4b conflicts with existing non-directory' - ); -} - -# -# Link to files 'file4b' and 'bin4b' do not conflict with existing -# files when --adopt is given -# -$stow = new_Stow(adopt => 1); - -# Populate target -make_file('file4c', "file4c - version originally in target\n"); -make_path ('bin4c'); -make_file('bin4c/file4c', "bin4c/file4c - version originally in target\n"); - -# Populate -make_path ('../stow/pkg4c/bin4c'); -make_file('../stow/pkg4c/file4c', "file4c - version originally in stow package\n"); -make_file('../stow/pkg4c/bin4c/file4c', "bin4c/file4c - version originally in stow package\n"); - -$stow->plan_stow('pkg4c'); -is($stow->get_conflict_count, 0 => 'no conflicts with --adopt'); -is($stow->get_tasks, 4 => 'two tasks per file'); -$stow->process_tasks(); -for my $file ('file4c', 'bin4c/file4c') { - ok(-l $file, "$file turned into a symlink"); + $stow->plan_stow('pkg1'); + $stow->process_tasks(); + is_deeply([ $stow->get_conflicts ], [], 'no conflicts with minimal stow'); is( - readlink $file, - (index($file, '/') == -1 ? '' : '../' ) - . "../stow/pkg4c/$file" => "$file points to right place" + readlink('bin1'), + '../stow/pkg1/bin1', + => 'minimal stow of a simple tree' ); - is(cat_file($file), "$file - version originally in target\n" => "$file has right contents"); -} +}); +subtest('stow a simple tree into an existing directory', sub { + plan tests => 1; + my $stow = new_Stow(); -# -# Target already exists but is not owned by stow -# -$stow = new_Stow(); + make_path('../stow/pkg2/lib2'); + make_file('../stow/pkg2/lib2/file2'); + make_path('lib2'); -make_path('bin5'); -make_invalid_link('bin5/file5','../../empty'); -make_path('../stow/pkg5/bin5/file5'); + $stow->plan_stow('pkg2'); + $stow->process_tasks(); + is( + readlink('lib2/file2'), + '../../stow/pkg2/lib2/file2', + => 'stow simple tree to existing directory' + ); +}); -$stow->plan_stow('pkg5'); -%conflicts = $stow->get_conflicts(); -like( - $conflicts{stow}{pkg5}[-1], - qr/not owned by stow/ - => 'target already exists but is not owned by stow' -); +subtest('unfold existing tree', sub { + plan tests => 3; + my $stow = new_Stow(); -# -# Replace existing but invalid target -# -$stow = new_Stow(); + make_path('../stow/pkg3a/bin3'); + make_file('../stow/pkg3a/bin3/file3a'); + make_link('bin3' => '../stow/pkg3a/bin3'); # emulate stow -make_invalid_link('file6','../stow/path-does-not-exist'); -make_path('../stow/pkg6'); -make_file('../stow/pkg6/file6'); + make_path('../stow/pkg3b/bin3'); + make_file('../stow/pkg3b/bin3/file3b'); -$stow->plan_stow('pkg6'); -$stow->process_tasks(); -is( - readlink('file6'), - '../stow/pkg6/file6' - => 'replace existing but invalid target' -); + $stow->plan_stow('pkg3b'); + $stow->process_tasks(); + ok(-d 'bin3'); + is(readlink('bin3/file3a'), '../../stow/pkg3a/bin3/file3a'); + is(readlink('bin3/file3b'), '../../stow/pkg3b/bin3/file3b' + => 'target already has 1 stowed package'); +}); -# -# Target already exists, is owned by stow, but points to a non-directory -# (can't unfold) -# -$stow = new_Stow(); -#set_debug_level(4); +subtest("Package dir 'bin4' conflicts with existing non-dir so can't unfold", sub { + plan tests => 2; + my $stow = new_Stow(); -make_path('bin7'); -make_path('../stow/pkg7a/bin7'); -make_file('../stow/pkg7a/bin7/node7'); -make_link('bin7/node7','../../stow/pkg7a/bin7/node7'); -make_path('../stow/pkg7b/bin7/node7'); -make_file('../stow/pkg7b/bin7/node7/file7'); + make_file('bin4'); # this is a file but named like a directory + make_path('../stow/pkg4/bin4'); + make_file('../stow/pkg4/bin4/file4'); -$stow->plan_stow('pkg7b'); -%conflicts = $stow->get_conflicts(); -like( - $conflicts{stow}{pkg7b}[-1], - qr/existing target is stowed to a different package/ - => 'link to new dir conflicts with existing stowed non-directory' -); + $stow->plan_stow('pkg4'); + %conflicts = $stow->get_conflicts(); + is($stow->get_conflict_count, 1); + like( + $conflicts{stow}{pkg4}[0], + qr!cannot stow ../stow/pkg4/bin4 over existing target bin4 since neither a link nor a directory and --adopt not specified! + => 'link to new dir bin4 conflicts with existing non-directory' + ); +}); -# -# stowing directories named 0 -# -$stow = new_Stow(); +subtest("Package dir 'bin4a' conflicts with existing non-dir " . + "so can't unfold even with --adopt", sub { + plan tests => 2; + my $stow = new_Stow(adopt => 1); -make_path('../stow/pkg8a/0'); -make_file('../stow/pkg8a/0/file8a'); -make_link('0' => '../stow/pkg8a/0'); # emulate stow + make_file('bin4a'); # this is a file but named like a directory + make_path('../stow/pkg4a/bin4a'); + make_file('../stow/pkg4a/bin4a/file4a'); -make_path('../stow/pkg8b/0'); -make_file('../stow/pkg8b/0/file8b'); + $stow->plan_stow('pkg4a'); + %conflicts = $stow->get_conflicts(); + is($stow->get_conflict_count, 1); + like( + $conflicts{stow}{pkg4a}[0], + qr!cannot stow directory ../stow/pkg4a/bin4a over existing non-directory target bin4a! + => 'link to new dir bin4a conflicts with existing non-directory' + ); +}); -$stow->plan_stow('pkg8b'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -d '0' && - readlink('0/file8a') eq '../../stow/pkg8a/0/file8a' && - readlink('0/file8b') eq '../../stow/pkg8b/0/file8b' - => 'stowing directories named 0' -); +subtest("Package files 'file4b' and 'bin4b' conflict with existing files", sub { + plan tests => 3; + my $stow = new_Stow(); -# -# overriding already stowed documentation -# -$stow = new_Stow(override => ['man9', 'info9']); + # Populate target + make_file('file4b', 'file4b - version originally in target'); + make_path('bin4b'); + make_file('bin4b/file4b', 'bin4b/file4b - version originally in target'); -make_path('../stow/pkg9a/man9/man1'); -make_file('../stow/pkg9a/man9/man1/file9.1'); -make_path('man9/man1'); -make_link('man9/man1/file9.1' => '../../../stow/pkg9a/man9/man1/file9.1'); # emulate stow + # Populate stow package + make_path('../stow/pkg4b'); + make_file('../stow/pkg4b/file4b', 'file4b - version originally in stow package'); + make_path('../stow/pkg4b/bin4b'); + make_file('../stow/pkg4b/bin4b/file4b', 'bin4b/file4b - version originally in stow package'); -make_path('../stow/pkg9b/man9/man1'); -make_file('../stow/pkg9b/man9/man1/file9.1'); + $stow->plan_stow('pkg4b'); + %conflicts = $stow->get_conflicts(); + is($stow->get_conflict_count, 2 => 'conflict per file'); + for my $i (0, 1) { + my $target = $i ? 'file4b' : 'bin4b/file4b'; + like( + $conflicts{stow}{pkg4b}[$i], + qr,cannot stow ../stow/pkg4b/$target over existing target $target since neither a link nor a directory and --adopt not specified, + => 'link to file4b conflicts with existing non-directory' + ); + } +}); -$stow->plan_stow('pkg9b'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - readlink('man9/man1/file9.1') eq '../../../stow/pkg9b/man9/man1/file9.1' - => 'overriding existing documentation files' -); +subtest("Package files 'file4d' conflicts with existing directories", sub { + plan tests => 3; + my $stow = new_Stow(); -# -# deferring to already stowed documentation -# -$stow = new_Stow(defer => ['man10', 'info10']); + # Populate target + make_path('file4d'); # this is a directory but named like a file to create the conflict + make_path('bin4d/file4d'); # same here -make_path('../stow/pkg10a/man10/man1'); -make_file('../stow/pkg10a/man10/man1/file10.1'); -make_path('man10/man1'); -make_link('man10/man1/file10.1' => '../../../stow/pkg10a/man10/man1/file10.1'); # emulate stow + # Populate stow package + make_path('../stow/pkg4d'); + make_file('../stow/pkg4d/file4d', 'file4d - version originally in stow package'); + make_path('../stow/pkg4d/bin4d'); + make_file('../stow/pkg4d/bin4d/file4d', 'bin4d/file4d - version originally in stow package'); -make_path('../stow/pkg10b/man10/man1'); -make_file('../stow/pkg10b/man10/man1/file10.1'); + $stow->plan_stow('pkg4d'); + %conflicts = $stow->get_conflicts(); + is($stow->get_conflict_count, 2 => 'conflict per file'); + for my $i (0, 1) { + my $target = $i ? 'file4d' : 'bin4d/file4d'; + like( + $conflicts{stow}{pkg4d}[$i], + qr!cannot stow non-directory ../stow/pkg4d/$target over existing directory target $target! + => 'link to file4d conflicts with existing non-directory' + ); + } +}); -$stow->plan_stow('pkg10b'); -is($stow->get_tasks, 0, 'no tasks to process'); -ok( - $stow->get_conflict_count == 0 && - readlink('man10/man1/file10.1') eq '../../../stow/pkg10a/man10/man1/file10.1' - => 'defer to existing documentation files' -); +subtest("Package files 'file4c' and 'bin4c' can adopt existing versions", sub { + plan tests => 8; + my $stow = new_Stow(adopt => 1); -# -# Ignore temp files -# -$stow = new_Stow(ignore => ['~', '\.#.*']); + # Populate target + make_file('file4c', "file4c - version originally in target\n"); + make_path ('bin4c'); + make_file('bin4c/file4c', "bin4c/file4c - version originally in target\n"); -make_path('../stow/pkg11/man11/man1'); -make_file('../stow/pkg11/man11/man1/file11.1'); -make_file('../stow/pkg11/man11/man1/file11.1~'); -make_file('../stow/pkg11/man11/man1/.#file11.1'); -make_path('man11/man1'); + # Populate stow package + make_path('../stow/pkg4c'); + make_file('../stow/pkg4c/file4c', "file4c - version originally in stow package\n"); + make_path ('../stow/pkg4c/bin4c'); + make_file('../stow/pkg4c/bin4c/file4c', "bin4c/file4c - version originally in stow package\n"); -$stow->plan_stow('pkg11'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - readlink('man11/man1/file11.1') eq '../../../stow/pkg11/man11/man1/file11.1' && - !-e 'man11/man1/file11.1~' && - !-e 'man11/man1/.#file11.1' - => 'ignore temp files' -); + $stow->plan_stow('pkg4c'); + is($stow->get_conflict_count, 0 => 'no conflicts with --adopt'); + is($stow->get_tasks, 4 => 'two tasks per file'); + $stow->process_tasks(); + for my $file ('file4c', 'bin4c/file4c') { + ok(-l $file, "$file turned into a symlink"); + is( + readlink $file, + (index($file, '/') == -1 ? '' : '../' ) + . "../stow/pkg4c/$file" => "$file points to right place" + ); + is(cat_file($file), "$file - version originally in target\n" => "$file has right contents"); + } -# -# stowing links library files -# -$stow = new_Stow(); +}); -make_path('../stow/pkg12/lib12/'); -make_file('../stow/pkg12/lib12/lib.so.1'); -make_link('../stow/pkg12/lib12/lib.so', 'lib.so.1'); +subtest("Target already exists but is not owned by stow", sub { + plan tests => 1; + my $stow = new_Stow(); -make_path('lib12/'); + make_path('bin5'); + make_invalid_link('bin5/file5','../../empty'); + make_path('../stow/pkg5/bin5/file5'); -$stow->plan_stow('pkg12'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - readlink('lib12/lib.so.1') eq '../../stow/pkg12/lib12/lib.so.1' && - readlink('lib12/lib.so' ) eq '../../stow/pkg12/lib12/lib.so' - => 'stow links to libraries' -); + $stow->plan_stow('pkg5'); + %conflicts = $stow->get_conflicts(); + like( + $conflicts{stow}{pkg5}[-1], + qr/not owned by stow/ + => 'target already exists but is not owned by stow' + ); +}); -# -# unfolding to stow links to library files -# -$stow = new_Stow(); +subtest("Replace existing but invalid target", sub { + plan tests => 1; + my $stow = new_Stow(); -make_path('../stow/pkg13a/lib13/'); -make_file('../stow/pkg13a/lib13/liba.so.1'); -make_link('../stow/pkg13a/lib13/liba.so', 'liba.so.1'); -make_link('lib13','../stow/pkg13a/lib13'); + make_invalid_link('file6','../stow/path-does-not-exist'); + make_path('../stow/pkg6'); + make_file('../stow/pkg6/file6'); -make_path('../stow/pkg13b/lib13/'); -make_file('../stow/pkg13b/lib13/libb.so.1'); -make_link('../stow/pkg13b/lib13/libb.so', 'libb.so.1'); + $stow->plan_stow('pkg6'); + $stow->process_tasks(); + is( + readlink('file6'), + '../stow/pkg6/file6' + => 'replace existing but invalid target' + ); +}); -$stow->plan_stow('pkg13b'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - readlink('lib13/liba.so.1') eq '../../stow/pkg13a/lib13/liba.so.1' && - readlink('lib13/liba.so' ) eq '../../stow/pkg13a/lib13/liba.so' && - readlink('lib13/libb.so.1') eq '../../stow/pkg13b/lib13/libb.so.1' && - readlink('lib13/libb.so' ) eq '../../stow/pkg13b/lib13/libb.so' - => 'unfolding to stow links to libraries' -); +subtest("Target already exists, is owned by stow, but points to a non-directory", sub { + plan tests => 1; + my $stow = new_Stow(); + #set_debug_level(4); -# -# stowing to stow dir should fail -# -make_path('stow'); -$stow = new_Stow(dir => 'stow'); + make_path('bin7'); + make_path('../stow/pkg7a/bin7'); + make_file('../stow/pkg7a/bin7/node7'); + make_link('bin7/node7','../../stow/pkg7a/bin7/node7'); + make_path('../stow/pkg7b/bin7/node7'); + make_file('../stow/pkg7b/bin7/node7/file7'); -make_path('stow/pkg14/stow/pkg15'); -make_file('stow/pkg14/stow/pkg15/node15'); + $stow->plan_stow('pkg7b'); + %conflicts = $stow->get_conflicts(); + like( + $conflicts{stow}{pkg7b}[-1], + qr/existing target is stowed to a different package/ + => 'link to new dir conflicts with existing stowed non-directory' + ); +}); -capture_stderr(); -$stow->plan_stow('pkg14'); -is($stow->get_tasks, 0, 'no tasks to process'); -ok( - $stow->get_conflict_count == 0 && - ! -l 'stow/pkg15' - => "stowing to stow dir should fail" -); -like($stderr, - qr/WARNING: skipping target which was current stow directory stow/ - => "stowing to stow dir should give warning"); -uncapture_stderr(); +subtest("stowing directories named 0", sub { + plan tests => 4; + my $stow = new_Stow(); -# -# stow a simple tree minimally when cwd isn't target -# -cd('../..'); -$stow = new_Stow(dir => "$TEST_DIR/stow", target => "$TEST_DIR/target"); + make_path('../stow/pkg8a/0'); + make_file('../stow/pkg8a/0/file8a'); + make_link('0' => '../stow/pkg8a/0'); # emulate stow -make_path("$TEST_DIR/stow/pkg16/bin16"); -make_file("$TEST_DIR/stow/pkg16/bin16/file16"); + make_path('../stow/pkg8b/0'); + make_file('../stow/pkg8b/0/file8b'); -$stow->plan_stow('pkg16'); -$stow->process_tasks(); -is_deeply([ $stow->get_conflicts ], [], 'no conflicts with minimal stow'); -is( - readlink("$TEST_DIR/target/bin16"), - '../stow/pkg16/bin16', - => "minimal stow of a simple tree when cwd isn't target" -); + $stow->plan_stow('pkg8b'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0); + ok(-d '0'); + is(readlink('0/file8a'), '../../stow/pkg8a/0/file8a'); + is(readlink('0/file8b'), '../../stow/pkg8b/0/file8b' + => 'stowing directories named 0' + ); +}); -# -# stow a simple tree minimally to absolute stow dir when cwd isn't -# target -# -$stow = new_Stow(dir => canon_path("$TEST_DIR/stow"), - target => "$TEST_DIR/target"); +subtest("overriding already stowed documentation", sub { + plan tests => 2; + my $stow = new_Stow(override => ['man9', 'info9']); -make_path("$TEST_DIR/stow/pkg17/bin17"); -make_file("$TEST_DIR/stow/pkg17/bin17/file17"); + make_path('../stow/pkg9a/man9/man1'); + make_file('../stow/pkg9a/man9/man1/file9.1'); + make_path('man9/man1'); + make_link('man9/man1/file9.1' => '../../../stow/pkg9a/man9/man1/file9.1'); # emulate stow -$stow->plan_stow('pkg17'); -$stow->process_tasks(); -is_deeply([ $stow->get_conflicts ], [], 'no conflicts with minimal stow'); -is( - readlink("$TEST_DIR/target/bin17"), - '../stow/pkg17/bin17', - => "minimal stow of a simple tree with absolute stow dir" -); + make_path('../stow/pkg9b/man9/man1'); + make_file('../stow/pkg9b/man9/man1/file9.1'); -# -# stow a simple tree minimally with absolute stow AND target dirs when -# cwd isn't target -# -$stow = new_Stow(dir => canon_path("$TEST_DIR/stow"), - target => canon_path("$TEST_DIR/target")); + $stow->plan_stow('pkg9b'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0); + is(readlink('man9/man1/file9.1'), '../../../stow/pkg9b/man9/man1/file9.1' + => 'overriding existing documentation files' + ); +}); -make_path("$TEST_DIR/stow/pkg18/bin18"); -make_file("$TEST_DIR/stow/pkg18/bin18/file18"); +subtest("deferring to already stowed documentation", sub { + plan tests => 3; + my $stow = new_Stow(defer => ['man10', 'info10']); -$stow->plan_stow('pkg18'); -$stow->process_tasks(); -is_deeply([ $stow->get_conflicts ], [], 'no conflicts with minimal stow'); -is( - readlink("$TEST_DIR/target/bin18"), - '../stow/pkg18/bin18', - => "minimal stow of a simple tree with absolute stow and target dirs" -); + make_path('../stow/pkg10a/man10/man1'); + make_file('../stow/pkg10a/man10/man1/file10.1'); + make_path('man10/man1'); + make_link('man10/man1/file10.1' => '../../../stow/pkg10a/man10/man1/file10.1'); # emulate stow -# -# stow a tree with no-folding enabled - -# no new folded directories should be created, and existing -# folded directories should be split open (unfolded) where -# (and only where) necessary -# -cd("$TEST_DIR/target"); + make_path('../stow/pkg10b/man10/man1'); + make_file('../stow/pkg10b/man10/man1/file10.1'); -sub create_pkg { - my ($id, $pkg) = @_; + $stow->plan_stow('pkg10b'); + is($stow->get_tasks, 0, 'no tasks to process'); + is($stow->get_conflict_count, 0); + is(readlink('man10/man1/file10.1'), '../../../stow/pkg10a/man10/man1/file10.1' + => 'defer to existing documentation files' + ); +}); - my $stow_pkg = "../stow/$id-$pkg"; - make_path ($stow_pkg); - make_file("$stow_pkg/$id-file-$pkg"); +subtest("Ignore temp files", sub { + plan tests => 4; + my $stow = new_Stow(ignore => ['~', '\.#.*']); - # create a shallow hierarchy specific to this package which isn't - # yet stowed - make_path ("$stow_pkg/$id-$pkg-only-new"); - make_file("$stow_pkg/$id-$pkg-only-new/$id-file-$pkg"); + make_path('../stow/pkg11/man11/man1'); + make_file('../stow/pkg11/man11/man1/file11.1'); + make_file('../stow/pkg11/man11/man1/file11.1~'); + make_file('../stow/pkg11/man11/man1/.#file11.1'); + make_path('man11/man1'); - # create a deeper hierarchy specific to this package which isn't - # yet stowed - make_path ("$stow_pkg/$id-$pkg-only-new2/subdir"); - make_file("$stow_pkg/$id-$pkg-only-new2/subdir/$id-file-$pkg"); - make_link("$stow_pkg/$id-$pkg-only-new2/current", "subdir"); + $stow->plan_stow('pkg11'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0); + is(readlink('man11/man1/file11.1'), '../../../stow/pkg11/man11/man1/file11.1'); + ok(!-e 'man11/man1/file11.1~'); + ok(!-e 'man11/man1/.#file11.1' + => 'ignore temp files' + ); +}); - # create a hierarchy specific to this package which is already - # stowed via a folded tree - make_path ("$stow_pkg/$id-$pkg-only-old"); - make_link("$id-$pkg-only-old", "$stow_pkg/$id-$pkg-only-old"); - make_file("$stow_pkg/$id-$pkg-only-old/$id-file-$pkg"); +subtest("stowing links library files", sub { + plan tests => 3; + my $stow = new_Stow(); - # create a shared hierarchy which this package uses - make_path ("$stow_pkg/$id-shared"); - make_file("$stow_pkg/$id-shared/$id-file-$pkg"); + make_path('../stow/pkg12/lib12/'); + make_file('../stow/pkg12/lib12/lib.so.1'); + make_link('../stow/pkg12/lib12/lib.so', 'lib.so.1'); - # create a partially shared hierarchy which this package uses - make_path ("$stow_pkg/$id-shared2/subdir-$pkg"); - make_file("$stow_pkg/$id-shared2/$id-file-$pkg"); - make_file("$stow_pkg/$id-shared2/subdir-$pkg/$id-file-$pkg"); -} + make_path('lib12/'); -foreach my $pkg (qw{a b}) { - create_pkg('no-folding', $pkg); -} + $stow->plan_stow('pkg12'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0); + is(readlink('lib12/lib.so.1'), '../../stow/pkg12/lib12/lib.so.1'); + is(readlink('lib12/lib.so'), '../../stow/pkg12/lib12/lib.so' + => 'stow links to libraries' + ); +}); -$stow = new_Stow('no-folding' => 1); -$stow->plan_stow('no-folding-a'); -is_deeply([ $stow->get_conflicts ], [] => 'no conflicts with --no-folding'); -my @tasks = $stow->get_tasks; -use Data::Dumper; -is(scalar(@tasks), 13 => "6 dirs, 7 links") || warn Dumper(\@tasks); -$stow->process_tasks(); +subtest("unfolding to stow links to library files", sub { + plan tests => 5; + my $stow = new_Stow(); -sub check_no_folding { - my ($pkg) = @_; - my $stow_pkg = "../stow/no-folding-$pkg"; - is_link("no-folding-file-$pkg", "$stow_pkg/no-folding-file-$pkg"); + make_path('../stow/pkg13a/lib13/'); + make_file('../stow/pkg13a/lib13/liba.so.1'); + make_link('../stow/pkg13a/lib13/liba.so', 'liba.so.1'); + make_link('lib13','../stow/pkg13a/lib13'); - # check existing folded tree is untouched - is_link("no-folding-$pkg-only-old", "$stow_pkg/no-folding-$pkg-only-old"); + make_path('../stow/pkg13b/lib13/'); + make_file('../stow/pkg13b/lib13/libb.so.1'); + make_link('../stow/pkg13b/lib13/libb.so', 'libb.so.1'); - # check newly stowed shallow tree is not folded - is_dir_not_symlink("no-folding-$pkg-only-new"); - is_link("no-folding-$pkg-only-new/no-folding-file-$pkg", - "../$stow_pkg/no-folding-$pkg-only-new/no-folding-file-$pkg"); + $stow->plan_stow('pkg13b'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0); + is(readlink('lib13/liba.so.1'), '../../stow/pkg13a/lib13/liba.so.1'); + is(readlink('lib13/liba.so' ), '../../stow/pkg13a/lib13/liba.so'); + is(readlink('lib13/libb.so.1'), '../../stow/pkg13b/lib13/libb.so.1'); + is(readlink('lib13/libb.so' ), '../../stow/pkg13b/lib13/libb.so' + => 'unfolding to stow links to libraries' + ); +}); - # check newly stowed deeper tree is not folded - is_dir_not_symlink("no-folding-$pkg-only-new2"); - is_dir_not_symlink("no-folding-$pkg-only-new2/subdir"); - is_link("no-folding-$pkg-only-new2/subdir/no-folding-file-$pkg", - "../../$stow_pkg/no-folding-$pkg-only-new2/subdir/no-folding-file-$pkg"); - is_link("no-folding-$pkg-only-new2/current", - "../$stow_pkg/no-folding-$pkg-only-new2/current"); +subtest("stowing to stow dir should fail", sub { + plan tests => 4; + make_path('stow'); + $stow = new_Stow(dir => 'stow'); - # check shared tree is not folded. first time round this will be - # newly stowed. - is_dir_not_symlink('no-folding-shared'); - is_link("no-folding-shared/no-folding-file-$pkg", - "../$stow_pkg/no-folding-shared/no-folding-file-$pkg"); + make_path('stow/pkg14/stow/pkg15'); + make_file('stow/pkg14/stow/pkg15/node15'); - # check partially shared tree is not folded. first time round this - # will be newly stowed. - is_dir_not_symlink('no-folding-shared2'); - is_link("no-folding-shared2/no-folding-file-$pkg", - "../$stow_pkg/no-folding-shared2/no-folding-file-$pkg"); - is_link("no-folding-shared2/no-folding-file-$pkg", - "../$stow_pkg/no-folding-shared2/no-folding-file-$pkg"); -} + stderr_like( + sub { $stow->plan_stow('pkg14'); }, + qr/WARNING: skipping target which was current stow directory stow/, + "stowing to stow dir should give warning" + ); -check_no_folding('a'); + is($stow->get_tasks, 0, 'no tasks to process'); + is($stow->get_conflict_count, 0); + ok( + ! -l 'stow/pkg15' + => "stowing to stow dir should fail" + ); +}); -$stow = new_Stow('no-folding' => 1); -$stow->plan_stow('no-folding-b'); -is_deeply([ $stow->get_conflicts ], [] => 'no conflicts with --no-folding'); -@tasks = $stow->get_tasks; -is(scalar(@tasks), 11 => '4 dirs, 7 links') || warn Dumper(\@tasks); -$stow->process_tasks(); +subtest("stow a simple tree minimally when cwd isn't target", sub { + plan tests => 2; + cd('../..'); + $stow = new_Stow(dir => "$TEST_DIR/stow", target => "$TEST_DIR/target"); -check_no_folding('a'); -check_no_folding('b'); + make_path("$TEST_DIR/stow/pkg16/bin16"); + make_file("$TEST_DIR/stow/pkg16/bin16/file16"); + + $stow->plan_stow('pkg16'); + $stow->process_tasks(); + is_deeply([ $stow->get_conflicts ], [], 'no conflicts with minimal stow'); + is( + readlink("$TEST_DIR/target/bin16"), + '../stow/pkg16/bin16', + => "minimal stow of a simple tree when cwd isn't target" + ); +}); + +subtest("stow a simple tree minimally to absolute stow dir when cwd isn't", sub { + plan tests => 2; + my $stow = new_Stow(dir => canon_path("$TEST_DIR/stow"), + target => "$TEST_DIR/target"); + + make_path("$TEST_DIR/stow/pkg17/bin17"); + make_file("$TEST_DIR/stow/pkg17/bin17/file17"); + + $stow->plan_stow('pkg17'); + $stow->process_tasks(); + is_deeply([ $stow->get_conflicts ], [], 'no conflicts with minimal stow'); + is( + readlink("$TEST_DIR/target/bin17"), + '../stow/pkg17/bin17', + => "minimal stow of a simple tree with absolute stow dir" + ); +}); + +subtest("stow a simple tree minimally with absolute stow AND target dirs when", sub { + plan tests => 2; + my $stow = new_Stow(dir => canon_path("$TEST_DIR/stow"), + target => canon_path("$TEST_DIR/target")); + + make_path("$TEST_DIR/stow/pkg18/bin18"); + make_file("$TEST_DIR/stow/pkg18/bin18/file18"); + + $stow->plan_stow('pkg18'); + $stow->process_tasks(); + is_deeply([ $stow->get_conflicts ], [], 'no conflicts with minimal stow'); + is( + readlink("$TEST_DIR/target/bin18"), + '../stow/pkg18/bin18', + => "minimal stow of a simple tree with absolute stow and target dirs" + ); +}); + +subtest("stow a tree with no-folding enabled", sub { + plan tests => 82; + # folded directories should be split open (unfolded) where + # (and only where) necessary + # + cd("$TEST_DIR/target"); + + sub create_pkg { + my ($id, $pkg) = @_; + + my $stow_pkg = "../stow/$id-$pkg"; + make_path ($stow_pkg); + make_file("$stow_pkg/$id-file-$pkg"); + + # create a shallow hierarchy specific to this package which isn't + # yet stowed + make_path ("$stow_pkg/$id-$pkg-only-new"); + make_file("$stow_pkg/$id-$pkg-only-new/$id-file-$pkg"); + + # create a deeper hierarchy specific to this package which isn't + # yet stowed + make_path ("$stow_pkg/$id-$pkg-only-new2/subdir"); + make_file("$stow_pkg/$id-$pkg-only-new2/subdir/$id-file-$pkg"); + make_link("$stow_pkg/$id-$pkg-only-new2/current", "subdir"); + + # create a hierarchy specific to this package which is already + # stowed via a folded tree + make_path ("$stow_pkg/$id-$pkg-only-old"); + make_link("$id-$pkg-only-old", "$stow_pkg/$id-$pkg-only-old"); + make_file("$stow_pkg/$id-$pkg-only-old/$id-file-$pkg"); + + # create a shared hierarchy which this package uses + make_path ("$stow_pkg/$id-shared"); + make_file("$stow_pkg/$id-shared/$id-file-$pkg"); + + # create a partially shared hierarchy which this package uses + make_path ("$stow_pkg/$id-shared2/subdir-$pkg"); + make_file("$stow_pkg/$id-shared2/$id-file-$pkg"); + make_file("$stow_pkg/$id-shared2/subdir-$pkg/$id-file-$pkg"); + } + + foreach my $pkg (qw{a b}) { + create_pkg('no-folding', $pkg); + } + + $stow = new_Stow('no-folding' => 1); + $stow->plan_stow('no-folding-a'); + is_deeply([ $stow->get_conflicts ], [] => 'no conflicts with --no-folding'); + my @tasks = $stow->get_tasks; + use Data::Dumper; + is(scalar(@tasks), 13 => "6 dirs, 7 links") || warn Dumper(\@tasks); + $stow->process_tasks(); + + sub check_no_folding { + my ($pkg) = @_; + my $stow_pkg = "../stow/no-folding-$pkg"; + is_link("no-folding-file-$pkg", "$stow_pkg/no-folding-file-$pkg"); + + # check existing folded tree is untouched + is_link("no-folding-$pkg-only-old", "$stow_pkg/no-folding-$pkg-only-old"); + + # check newly stowed shallow tree is not folded + is_dir_not_symlink("no-folding-$pkg-only-new"); + is_link("no-folding-$pkg-only-new/no-folding-file-$pkg", + "../$stow_pkg/no-folding-$pkg-only-new/no-folding-file-$pkg"); + + # check newly stowed deeper tree is not folded + is_dir_not_symlink("no-folding-$pkg-only-new2"); + is_dir_not_symlink("no-folding-$pkg-only-new2/subdir"); + is_link("no-folding-$pkg-only-new2/subdir/no-folding-file-$pkg", + "../../$stow_pkg/no-folding-$pkg-only-new2/subdir/no-folding-file-$pkg"); + is_link("no-folding-$pkg-only-new2/current", + "../$stow_pkg/no-folding-$pkg-only-new2/current"); + + # check shared tree is not folded. first time round this will be + # newly stowed. + is_dir_not_symlink('no-folding-shared'); + is_link("no-folding-shared/no-folding-file-$pkg", + "../$stow_pkg/no-folding-shared/no-folding-file-$pkg"); + + # check partially shared tree is not folded. first time round this + # will be newly stowed. + is_dir_not_symlink('no-folding-shared2'); + is_link("no-folding-shared2/no-folding-file-$pkg", + "../$stow_pkg/no-folding-shared2/no-folding-file-$pkg"); + is_link("no-folding-shared2/no-folding-file-$pkg", + "../$stow_pkg/no-folding-shared2/no-folding-file-$pkg"); + } + + check_no_folding('a'); + + $stow = new_Stow('no-folding' => 1); + $stow->plan_stow('no-folding-b'); + is_deeply([ $stow->get_conflicts ], [] => 'no conflicts with --no-folding'); + @tasks = $stow->get_tasks; + is(scalar(@tasks), 11 => '4 dirs, 7 links') || warn Dumper(\@tasks); + $stow->process_tasks(); + + check_no_folding('a'); + check_no_folding('b'); +}); diff --git a/t/testutil.pm b/t/testutil.pm index ff1e6b4..2b4e097 100755 --- a/t/testutil.pm +++ b/t/testutil.pm @@ -24,11 +24,10 @@ package testutil; use strict; use warnings; -use Carp qw(croak); +use Carp qw(confess croak); use File::Basename; use File::Path qw(make_path remove_tree); use File::Spec; -use IO::Scalar; use Test::More; use Stow; @@ -38,7 +37,6 @@ use base qw(Exporter); our @EXPORT = qw( $ABS_TEST_DIR $TEST_DIR - $stderr init_test_dirs cd new_Stow new_compat_Stow @@ -46,45 +44,41 @@ our @EXPORT = qw( remove_dir remove_file remove_link cat_file is_link is_dir_not_symlink is_nonexistent_path - capture_stderr uncapture_stderr ); our $TEST_DIR = 'tmp-testing-trees'; our $ABS_TEST_DIR = File::Spec->rel2abs('tmp-testing-trees'); -our $stderr; -my $tied_err; - -sub capture_stderr { - undef $stderr; - $tied_err = tie *STDERR, 'IO::Scalar', \$stderr; -} - -sub uncapture_stderr { - undef $tied_err; - untie *STDERR; -} - sub init_test_dirs { + my $test_dir = shift || $TEST_DIR; + my $abs_test_dir = File::Spec->rel2abs($test_dir); + # Create a run_from/ subdirectory for tests which want to run # from a separate directory outside the Stow directory or # target directory. for my $dir ("target", "stow", "run_from") { - my $path = "$TEST_DIR/$dir"; + my $path = "$test_dir/$dir"; -d $path and remove_tree($path); make_path($path); } # Don't let user's ~/.stow-global-ignore affect test results - $ENV{HOME} = $ABS_TEST_DIR; + $ENV{HOME} = $abs_test_dir; + return $abs_test_dir; } sub new_Stow { my %opts = @_; + # These default paths assume that execution will be triggered from + # within the target directory. $opts{dir} ||= '../stow'; $opts{target} ||= '.'; $opts{test_mode} = 1; - return new Stow(%opts); + my $stow = eval { new Stow(%opts) }; + if ($@) { + confess "Error while trying to instantiate new Stow(%opts): $@"; + } + return $stow; } sub new_compat_Stow { @@ -96,28 +90,28 @@ sub new_compat_Stow { #===== SUBROUTINE =========================================================== # Name : make_link() # Purpose : safely create a link -# Parameters: $target => path to the link -# : $source => where the new link should point -# : $invalid => true iff $source refers to non-existent file +# Parameters: $link_src => path to the link +# : $link_dest => where the new link should point +# : $invalid => true iff $link_dest refers to non-existent file # Returns : n/a # Throws : fatal error if the link can not be safely created # Comments : checks for existing nodes #============================================================================ sub make_link { - my ($target, $source, $invalid) = @_; + my ($link_src, $link_dest, $invalid) = @_; - if (-l $target) { - my $old_source = readlink join('/', parent($target), $source) - or die "$target is already a link but could not read link $target/$source"; - if ($old_source ne $source) { - die "$target already exists but points elsewhere\n"; + if (-l $link_src) { + my $old_source = readlink join('/', parent($link_src), $link_dest) + or croak "$link_src is already a link but could not read link $link_src/$link_dest"; + if ($old_source ne $link_dest) { + croak "$link_src already exists but points elsewhere\n"; } } - die "$target already exists and is not a link\n" if -e $target; - my $abs_target = File::Spec->rel2abs($target); - my $target_container = dirname($abs_target); - my $abs_source = File::Spec->rel2abs($source, $target_container); - #warn "t $target c $target_container as $abs_source"; + croak "$link_src already exists and is not a link\n" if -e $link_src; + my $abs_target = File::Spec->rel2abs($link_src); + my $link_src_container = dirname($abs_target); + my $abs_source = File::Spec->rel2abs($link_dest, $link_src_container); + #warn "t $link_src c $link_src_container as $abs_source"; if (-e $abs_source) { croak "Won't make invalid link pointing to existing $abs_target" if $invalid; @@ -126,8 +120,8 @@ sub make_link { croak "Won't make link pointing to non-existent $abs_target" unless $invalid; } - symlink $source, $target - or die "could not create link $target => $source ($!)\n"; + symlink $link_dest, $link_src + or croak "could not create link $link_src => $link_dest ($!)\n"; } #===== SUBROUTINE =========================================================== @@ -157,11 +151,11 @@ sub make_file { my ($path, $contents) = @_; if (-e $path and ! -f $path) { - die "a non-file already exists at $path\n"; + croak "a non-file already exists at $path\n"; } open my $FILE ,'>', $path - or die "could not create file: $path ($!)\n"; + or croak "could not create file: $path ($!)\n"; print $FILE $contents if defined $contents; close $FILE; } @@ -178,9 +172,9 @@ sub make_file { sub remove_link { my ($path) = @_; if (not -l $path) { - die qq(remove_link() called with a non-link: $path); + croak qq(remove_link() called with a non-link: $path); } - unlink $path or die "could not remove link: $path ($!)\n"; + unlink $path or croak "could not remove link: $path ($!)\n"; return; } @@ -195,9 +189,9 @@ sub remove_link { sub remove_file { my ($path) = @_; if (-z $path) { - die "file at $path is non-empty\n"; + croak "file at $path is non-empty\n"; } - unlink $path or die "could not remove empty file: $path ($!)\n"; + unlink $path or croak "could not remove empty file: $path ($!)\n"; return; } @@ -213,10 +207,10 @@ sub remove_dir { my ($dir) = @_; if (not -d $dir) { - die "$dir is not a directory"; + croak "$dir is not a directory"; } - opendir my $DIR, $dir or die "cannot read directory: $dir ($!)\n"; + opendir my $DIR, $dir or croak "cannot read directory: $dir ($!)\n"; my @listing = readdir $DIR; closedir $DIR; @@ -227,16 +221,16 @@ sub remove_dir { my $path = "$dir/$node"; if (-l $path or (-f $path and -z $path) or $node eq $Stow::LOCAL_IGNORE_FILE) { - unlink $path or die "cannot unlink $path ($!)\n"; + unlink $path or croak "cannot unlink $path ($!)\n"; } elsif (-d "$path") { remove_dir($path); } else { - die "$path is not a link, directory, or empty file\n"; + croak "$path is not a link, directory, or empty file\n"; } } - rmdir $dir or die "cannot rmdir $dir ($!)\n"; + rmdir $dir or croak "cannot rmdir $dir ($!)\n"; return; } @@ -251,7 +245,7 @@ sub remove_dir { #============================================================================ sub cd { my ($dir) = @_; - chdir $dir or die "Failed to chdir($dir): $!\n"; + chdir $dir or croak "Failed to chdir($dir): $!\n"; } #===== SUBROUTINE =========================================================== @@ -264,7 +258,7 @@ sub cd { #============================================================================ sub cat_file { my ($file) = @_; - open F, $file or die "Failed to open($file): $!\n"; + open F, $file or croak "Failed to open($file): $!\n"; my $contents = join '', ; close(F); return $contents; @@ -309,6 +303,5 @@ sub is_nonexistent_path { # Local variables: # mode: perl -# cperl-indent-level: 4 # end: # vim: ft=perl diff --git a/t/unstow.t b/t/unstow.t index 5cabf26..4252694 100755 --- a/t/unstow.t +++ b/t/unstow.t @@ -22,429 +22,528 @@ use strict; use warnings; -use Test::More tests => 39; +use File::Spec qw(make_path); +use POSIX qw(getcwd); +use Test::More tests => 35; use Test::Output; use English qw(-no_match_vars); use testutil; use Stow::Util qw(canon_path); -init_test_dirs(); -cd("$TEST_DIR/target"); +my $repo = getcwd(); -# Note that each of the following tests use a distinct set of files +init_test_dirs($TEST_DIR); -my $stow; -my %conflicts; +our $COMPAT_TEST_DIR = "${TEST_DIR}-compat"; +our $COMPAT_ABS_TEST_DIR = init_test_dirs($COMPAT_TEST_DIR); +sub init_stow2 { + make_path('stow2'); # make our alternate stow dir a subdir of target + make_file('stow2/.stow'); +} + +sub create_unowned_files { + # Make things harder for Stow to figure out, by adding + # a bunch of alien files unrelated to Stow. + my @UNOWNED_DIRS = ('unowned-dir', '.unowned-dir', 'dot-unowned-dir'); + for my $dir ('.', @UNOWNED_DIRS) { + for my $subdir ('.', @UNOWNED_DIRS) { + make_path("$dir/$subdir"); + make_file("$dir/$subdir/unowned"); + make_file("$dir/$subdir/.unowned"); + make_file("$dir/$subdir/dot-unowned"); + } + } +} + +# Run a subtest twice, with compat off then on, in parallel test trees. # -# unstow a simple tree minimally -# -$stow = new_Stow(); - -make_path('../stow/pkg1/bin1'); -make_file('../stow/pkg1/bin1/file1'); -make_link('bin1', '../stow/pkg1/bin1'); - -$stow->plan_unstow('pkg1'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f '../stow/pkg1/bin1/file1' && ! -e 'bin1' - => 'unstow a simple tree' -); - +# Params: $name[, $setup], $test_code # -# unstow a simple tree from an existing directory -# -$stow = new_Stow(); +# $setup is an optional ref to an options hash to pass into the new +# Stow() constructor, or a ref to a sub which performs setup before +# the constructor gets called and then returns that options hash. +sub subtests { + my $name = shift; + my $setup = @_ == 2 ? shift : {}; + my $code = shift; -make_path('lib2'); -make_path('../stow/pkg2/lib2'); -make_file('../stow/pkg2/lib2/file2'); -make_link('lib2/file2', '../../stow/pkg2/lib2/file2'); -$stow->plan_unstow('pkg2'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f '../stow/pkg2/lib2/file2' && -d 'lib2' - => 'unstow simple tree from a pre-existing directory' -); + $ENV{HOME} = $ABS_TEST_DIR; + cd($repo); + cd("$TEST_DIR/target"); + create_unowned_files(); + # cd first to allow setup to cd somewhere else. + my $opts = ref($setup) eq 'HASH' ? $setup : $setup->($TEST_DIR); + subtest($name, sub { + make_path($opts->{dir}) if $opts->{dir}; + my $stow = new_Stow(%$opts); + $code->($stow, $TEST_DIR); + }); -# -# fold tree after unstowing -# -$stow = new_Stow(); + $ENV{HOME} = $COMPAT_ABS_TEST_DIR; + cd($repo); + cd("$COMPAT_TEST_DIR/target"); + create_unowned_files(); + # cd first to allow setup to cd somewhere else. + $opts = ref $setup eq 'HASH' ? $setup : $setup->($COMPAT_TEST_DIR); + subtest("$name (compat mode)", sub { + make_path($opts->{dir}) if $opts->{dir}; + my $stow = new_compat_Stow(%$opts); + $code->($stow, $COMPAT_TEST_DIR); + }); +} -make_path('bin3'); +sub plan_tests { + my ($stow, $count) = @_; + plan tests => $stow->{compat} ? $count + 2 : $count; +} -make_path('../stow/pkg3a/bin3'); -make_file('../stow/pkg3a/bin3/file3a'); -make_link('bin3/file3a' => '../../stow/pkg3a/bin3/file3a'); # emulate stow +subtests("unstow a simple tree minimally", sub { + my ($stow) = @_; + plan tests => 3; -make_path('../stow/pkg3b/bin3'); -make_file('../stow/pkg3b/bin3/file3b'); -make_link('bin3/file3b' => '../../stow/pkg3b/bin3/file3b'); # emulate stow -$stow->plan_unstow('pkg3b'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -l 'bin3' && - readlink('bin3') eq '../stow/pkg3a/bin3' - => 'fold tree after unstowing' -); + make_path('../stow/pkg1/bin1'); + make_file('../stow/pkg1/bin1/file1'); + make_link('bin1', '../stow/pkg1/bin1'); -# -# existing link is owned by stow but is invalid so it gets removed anyway -# -$stow = new_Stow(); + $stow->plan_unstow('pkg1'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-f '../stow/pkg1/bin1/file1'); + ok(! -e 'bin1' => 'unstow a simple tree'); +}); -make_path('bin4'); -make_path('../stow/pkg4/bin4'); -make_file('../stow/pkg4/bin4/file4'); -make_invalid_link('bin4/file4', '../../stow/pkg4/bin4/does-not-exist'); +subtests("unstow a simple tree from an existing directory", sub { + my ($stow) = @_; + plan tests => 3; -$stow->plan_unstow('pkg4'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - ! -e 'bin4/file4' - => q(remove invalid link owned by stow) -); + make_path('lib2'); + make_path('../stow/pkg2/lib2'); + make_file('../stow/pkg2/lib2/file2'); + make_link('lib2/file2', '../../stow/pkg2/lib2/file2'); + $stow->plan_unstow('pkg2'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-f '../stow/pkg2/lib2/file2'); + ok(-d 'lib2' + => 'unstow simple tree from a pre-existing directory' + ); +}); -# -# Existing link is not owned by stow -# -$stow = new_Stow(); +subtests("fold tree after unstowing", sub { + my ($stow) = @_; + plan tests => 3; -make_path('../stow/pkg5/bin5'); -make_invalid_link('bin5', '../not-stow'); + make_path('bin3'); -$stow->plan_unstow('pkg5'); -%conflicts = $stow->get_conflicts; -like( - $conflicts{unstow}{pkg5}[-1], - qr(existing target is not owned by stow) - => q(existing link not owned by stow) -); + make_path('../stow/pkg3a/bin3'); + make_file('../stow/pkg3a/bin3/file3a'); + make_link('bin3/file3a' => '../../stow/pkg3a/bin3/file3a'); # emulate stow -# -# Target already exists, is owned by stow, but points to a different package -# -$stow = new_Stow(); + make_path('../stow/pkg3b/bin3'); + make_file('../stow/pkg3b/bin3/file3b'); + make_link('bin3/file3b' => '../../stow/pkg3b/bin3/file3b'); # emulate stow + $stow->plan_unstow('pkg3b'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-l 'bin3'); + is(readlink('bin3'), '../stow/pkg3a/bin3' + => 'fold tree after unstowing' + ); +}); -make_path('bin6'); -make_path('../stow/pkg6a/bin6'); -make_file('../stow/pkg6a/bin6/file6'); -make_link('bin6/file6', '../../stow/pkg6a/bin6/file6'); +subtests("existing link is owned by stow but is invalid so it gets removed anyway", sub { + my ($stow) = @_; + plan tests => 2; -make_path('../stow/pkg6b/bin6'); -make_file('../stow/pkg6b/bin6/file6'); + make_path('bin4'); + make_path('../stow/pkg4/bin4'); + make_file('../stow/pkg4/bin4/file4'); + make_invalid_link('bin4/file4', '../../stow/pkg4/bin4/does-not-exist'); -$stow->plan_unstow('pkg6b'); -ok( - $stow->get_conflict_count == 0 && - -l 'bin6/file6' && - readlink('bin6/file6') eq '../../stow/pkg6a/bin6/file6' - => q(ignore existing link that points to a different package) -); + $stow->plan_unstow('pkg4'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(! -e 'bin4/file4' + => q(remove invalid link owned by stow) + ); +}); -# -# Don't unlink anything under the stow directory -# -make_path('stow'); # make out stow dir a subdir of target -$stow = new_Stow(dir => 'stow'); +subtests("Existing invalid link is not owned by stow", sub { + my ($stow) = @_; + plan tests => 3; -# emulate stowing into ourself (bizarre corner case or accident) -make_path('stow/pkg7a/stow/pkg7b'); -make_file('stow/pkg7a/stow/pkg7b/file7b'); -make_link('stow/pkg7b', '../stow/pkg7a/stow/pkg7b'); + make_path('../stow/pkg5/bin5'); + make_invalid_link('bin5', '../not-stow'); -$stow->plan_unstow('pkg7b'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg7b'); -ok( - $stow->get_conflict_count == 0 && - -l 'stow/pkg7b' && - readlink('stow/pkg7b') eq '../stow/pkg7a/stow/pkg7b' - => q(don't unlink any nodes under the stow directory) -); + $stow->plan_unstow('pkg5'); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-l 'bin5', 'invalid link not removed'); + is(readlink('bin5'), '../not-stow' => "invalid link not changed"); +}); +subtests("Target already exists, is owned by stow, but points to a different package", sub { + my ($stow) = @_; + plan tests => 3; -# -# Don't unlink any nodes under another stow directory -# -$stow = new_Stow(dir => 'stow'); + make_path('bin6'); + make_path('../stow/pkg6a/bin6'); + make_file('../stow/pkg6a/bin6/file6'); + make_link('bin6/file6', '../../stow/pkg6a/bin6/file6'); -make_path('stow2'); # make our alternate stow dir a subdir of target -make_file('stow2/.stow'); + make_path('../stow/pkg6b/bin6'); + make_file('../stow/pkg6b/bin6/file6'); -# emulate stowing into ourself (bizarre corner case or accident) -make_path('stow/pkg8a/stow2/pkg8b'); -make_file('stow/pkg8a/stow2/pkg8b/file8b'); -make_link('stow2/pkg8b', '../stow/pkg8a/stow2/pkg8b'); + $stow->plan_unstow('pkg6b'); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-l 'bin6/file6'); + is( + readlink('bin6/file6'), + '../../stow/pkg6a/bin6/file6' + => q(ignore existing link that points to a different package) + ); +}); -capture_stderr(); -$stow->plan_unstow('pkg8a'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg8a'); -ok( - $stow->get_conflict_count == 0 && - -l 'stow2/pkg8b' && - readlink('stow2/pkg8b') eq '../stow/pkg8a/stow2/pkg8b' - => q(don't unlink any nodes under another stow directory) -); -like($stderr, - qr/WARNING: skipping protected directory stow2/ - => "unstowing from ourself should skip stow"); -uncapture_stderr(); +subtests("Don't unlink anything under the stow directory", + sub { + make_path('stow'); + return { dir => 'stow' }; + # target dir defaults to parent of stow, which is target directory + }, + sub { + plan tests => 5; + my ($stow) = @_; -# -# overriding already stowed documentation -# -$stow = new_Stow(override => ['man9', 'info9']); -make_file('stow/.stow'); + # Emulate stowing into ourself (bizarre corner case or accident): + make_path('stow/pkg7a/stow/pkg7b'); + make_file('stow/pkg7a/stow/pkg7b/file7b'); + # Make a package be a link to a package of the same name inside another package. + make_link('stow/pkg7b', '../stow/pkg7a/stow/pkg7b'); -make_path('../stow/pkg9a/man9/man1'); -make_file('../stow/pkg9a/man9/man1/file9.1'); -make_path('man9/man1'); -make_link('man9/man1/file9.1' => '../../../stow/pkg9a/man9/man1/file9.1'); # emulate stow + stderr_like( + sub { $stow->plan_unstow('pkg7b'); }, + $stow->{compat} ? qr/WARNING: skipping target which was current stow directory stow/ : qr// + => "warn when unstowing from ourself" + ); + is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg7b'); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-l 'stow/pkg7b'); + is( + readlink('stow/pkg7b'), + '../stow/pkg7a/stow/pkg7b' + => q(don't unlink any nodes under the stow directory) + ); +}); -make_path('../stow/pkg9b/man9/man1'); -make_file('../stow/pkg9b/man9/man1/file9.1'); -$stow->plan_unstow('pkg9b'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - !-l 'man9/man1/file9.1' - => 'overriding existing documentation files' -); +subtests("Don't unlink any nodes under another stow directory", + sub { + make_path('stow'); + return { dir => 'stow' }; + }, + sub { + my ($stow) = @_; + plan tests => 5; -# -# deferring to already stowed documentation -# -$stow = new_Stow(defer => ['man10', 'info10']); + init_stow2(); + # emulate stowing into ourself (bizarre corner case or accident) + make_path('stow/pkg8a/stow2/pkg8b'); + make_file('stow/pkg8a/stow2/pkg8b/file8b'); + make_link('stow2/pkg8b', '../stow/pkg8a/stow2/pkg8b'); -make_path('../stow/pkg10a/man10/man1'); -make_file('../stow/pkg10a/man10/man1/file10a.1'); -make_path('man10/man1'); -make_link('man10/man1/file10a.1' => '../../../stow/pkg10a/man10/man1/file10a.1'); + stderr_like( + sub { $stow->plan_unstow('pkg8a'); }, + qr/WARNING: skipping marked Stow directory stow2/ + => "warn when skipping unstowing" + ); + is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg8a'); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-l 'stow2/pkg8b'); + is( + readlink('stow2/pkg8b'), + '../stow/pkg8a/stow2/pkg8b' + => q(don't unlink any nodes under another stow directory) + ); +}); -# need this to block folding -make_path('../stow/pkg10b/man10/man1'); -make_file('../stow/pkg10b/man10/man1/file10b.1'); -make_link('man10/man1/file10b.1' => '../../../stow/pkg10b/man10/man1/file10b.1'); +# This will be used by subsequent tests +sub check_protected_dirs_skipped { + my ($stderr) = @_; + for my $dir (qw{stow stow2}) { + like($stderr, + qr/WARNING: skipping marked Stow directory $dir/ + => "warn when skipping marked directory $dir"); + } +} +subtests("overriding already stowed documentation", + {override => ['man9', 'info9']}, + sub { + my ($stow) = @_; + plan_tests($stow, 2); -make_path('../stow/pkg10c/man10/man1'); -make_file('../stow/pkg10c/man10/man1/file10a.1'); -$stow->plan_unstow('pkg10c'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg10c'); -ok( - $stow->get_conflict_count == 0 && - readlink('man10/man1/file10a.1') eq '../../../stow/pkg10a/man10/man1/file10a.1' - => 'defer to existing documentation files' -); + make_file('stow/.stow'); + init_stow2(); + make_path('../stow/pkg9a/man9/man1'); + make_file('../stow/pkg9a/man9/man1/file9.1'); + make_path('man9/man1'); + make_link('man9/man1/file9.1' => '../../../stow/pkg9a/man9/man1/file9.1'); # emulate stow -# -# Ignore temp files -# -$stow = new_Stow(ignore => ['~', '\.#.*']); + make_path('../stow/pkg9b/man9/man1'); + make_file('../stow/pkg9b/man9/man1/file9.1'); + my $stderr = stderr_from { $stow->plan_unstow('pkg9b') }; + check_protected_dirs_skipped($stderr) if $stow->{compat}; + $stow->process_tasks(); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(!-l 'man9/man1/file9.1' + => 'overriding existing documentation files' + ); +}); -make_path('../stow/pkg12/man12/man1'); -make_file('../stow/pkg12/man12/man1/file12.1'); -make_file('../stow/pkg12/man12/man1/file12.1~'); -make_file('../stow/pkg12/man12/man1/.#file12.1'); -make_path('man12/man1'); -make_link('man12/man1/file12.1' => '../../../stow/pkg12/man12/man1/file12.1'); +subtests("deferring to already stowed documentation", + {defer => ['man10', 'info10']}, + sub { + my ($stow) = @_; + plan_tests($stow, 3); -$stow->plan_unstow('pkg12'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - !-e 'man12/man1/file12.1' - => 'ignore temp files' -); + init_stow2(); + make_path('../stow/pkg10a/man10/man1'); + make_file('../stow/pkg10a/man10/man1/file10a.1'); + make_path('man10/man1'); + make_link('man10/man1/file10a.1' => '../../../stow/pkg10a/man10/man1/file10a.1'); -# -# Unstow an already unstowed package -# -$stow = new_Stow(); -$stow->plan_unstow('pkg12'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg12'); -ok( - $stow->get_conflict_count == 0 - => 'unstow already unstowed package pkg12' -); + # need this to block folding + make_path('../stow/pkg10b/man10/man1'); + make_file('../stow/pkg10b/man10/man1/file10b.1'); + make_link('man10/man1/file10b.1' => '../../../stow/pkg10b/man10/man1/file10b.1'); -# -# Unstow a never stowed package -# + make_path('../stow/pkg10c/man10/man1'); + make_file('../stow/pkg10c/man10/man1/file10a.1'); + my $stderr = stderr_from { $stow->plan_unstow('pkg10c') }; + check_protected_dirs_skipped($stderr) if $stow->{compat}; + is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg10c'); + is($stow->get_conflict_count, 0, 'conflict count'); + is( + readlink('man10/man1/file10a.1'), + '../../../stow/pkg10a/man10/man1/file10a.1' + => 'defer to existing documentation files' + ); +}); -eval { remove_dir("$TEST_DIR/target"); }; -mkdir("$TEST_DIR/target"); +subtests("Ignore temp files", + {ignore => ['~', '\.#.*']}, + sub { + my ($stow) = @_; + plan_tests($stow, 2); -$stow = new_Stow(); -$stow->plan_unstow('pkg12'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg12 which was never stowed'); -ok( - $stow->get_conflict_count == 0 - => 'unstow never stowed package pkg12' -); + init_stow2(); + make_path('../stow/pkg12/man12/man1'); + make_file('../stow/pkg12/man12/man1/file12.1'); + make_file('../stow/pkg12/man12/man1/file12.1~'); + make_file('../stow/pkg12/man12/man1/.#file12.1'); + make_path('man12/man1'); + make_link('man12/man1/file12.1' => '../../../stow/pkg12/man12/man1/file12.1'); -# -# Unstowing when target contains a real file shouldn't be an issue. -# -make_file('man12/man1/file12.1'); + my $stderr = stderr_from { $stow->plan_unstow('pkg12') }; + check_protected_dirs_skipped($stderr) if $stow->{compat}; + $stow->process_tasks(); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(! -e 'man12/man1/file12.1' => 'man12/man1/file12.1 was unstowed'); +}); -$stow = new_Stow(); -$stow->plan_unstow('pkg12'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg12 for third time'); -%conflicts = $stow->get_conflicts; -ok( - $stow->get_conflict_count == 1 && - $conflicts{unstow}{pkg12}[0] - =~ m!existing target is neither a link nor a directory: man12/man1/file12\.1! - => 'unstow pkg12 for third time' -); +subtests("Unstow an already unstowed package", sub { + my ($stow) = @_; + plan_tests($stow, 2); -# -# unstow a simple tree minimally when cwd isn't target -# -cd('../..'); -$stow = new_Stow(dir => "$TEST_DIR/stow", target => "$TEST_DIR/target"); + my $stderr = stderr_from { $stow->plan_unstow('pkg12') }; + check_protected_dirs_skipped($stderr) if $stow->{compat}; + is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg12'); + is($stow->get_conflict_count, 0, 'conflict count'); +}); -make_path("$TEST_DIR/stow/pkg13/bin13"); -make_file("$TEST_DIR/stow/pkg13/bin13/file13"); -make_link("$TEST_DIR/target/bin13", '../stow/pkg13/bin13'); +subtests("Unstow a never stowed package", sub { + my ($stow) = @_; + plan tests => 2; -$stow->plan_unstow('pkg13'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f "$TEST_DIR/stow/pkg13/bin13/file13" && ! -e "$TEST_DIR/target/bin13" - => 'unstow a simple tree' -); + eval { remove_dir($stow->{target}); }; + mkdir($stow->{target}); -# -# unstow a simple tree minimally with absolute stow dir when cwd isn't -# target -# -$stow = new_Stow(dir => canon_path("$TEST_DIR/stow"), - target => "$TEST_DIR/target"); + $stow->plan_unstow('pkg12'); + is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg12 which was never stowed'); + is($stow->get_conflict_count, 0, 'conflict count'); +}); -make_path("$TEST_DIR/stow/pkg14/bin14"); -make_file("$TEST_DIR/stow/pkg14/bin14/file14"); -make_link("$TEST_DIR/target/bin14", '../stow/pkg14/bin14'); +subtests("Unstowing when target contains real files shouldn't be an issue", sub { + my ($stow) = @_; + plan tests => 4; -$stow->plan_unstow('pkg14'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f "$TEST_DIR/stow/pkg14/bin14/file14" && ! -e "$TEST_DIR/target/bin14" - => 'unstow a simple tree with absolute stow dir' -); + # Test both a file which do / don't overlap with the package + make_path('man12/man1'); + make_file('man12/man1/alien'); + make_file('man12/man1/file12.1'); -# -# unstow a simple tree minimally with absolute stow AND target dirs -# when cwd isn't target -# -$stow = new_Stow(dir => canon_path("$TEST_DIR/stow"), - target => canon_path("$TEST_DIR/target")); + $stow->plan_unstow('pkg12'); + is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg12 for third time'); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-f 'man12/man1/alien', 'alien untouched'); + ok(-f 'man12/man1/file12.1', 'file overlapping with pkg untouched'); +}); -make_path("$TEST_DIR/stow/pkg15/bin15"); -make_file("$TEST_DIR/stow/pkg15/bin15/file15"); -make_link("$TEST_DIR/target/bin15", '../stow/pkg15/bin15'); +subtests("unstow a simple tree minimally when cwd isn't target", + sub { + my $test_dir = shift; + cd($repo); + return { + dir => "$test_dir/stow", + target => "$test_dir/target" + } + }, + sub { + my ($stow, $test_dir) = @_; + plan tests => 3; -$stow->plan_unstow('pkg15'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f "$TEST_DIR/stow/pkg15/bin15/file15" && ! -e "$TEST_DIR/target/bin15" - => 'unstow a simple tree with absolute stow and target dirs' -); + make_path("$test_dir/stow/pkg13/bin13"); + make_file("$test_dir/stow/pkg13/bin13/file13"); + make_link("$test_dir/target/bin13", '../stow/pkg13/bin13'); -# -# unstow a tree with no-folding enabled - -# no refolding should take place -# -cd("$TEST_DIR/target"); + $stow->plan_unstow('pkg13'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-f "$test_dir/stow/pkg13/bin13/file13", 'package file untouched'); + ok(! -e "$test_dir/target/bin13" => 'bin13/ unstowed'); +}); + +subtests("unstow a simple tree minimally with absolute stow dir when cwd isn't target", + sub { + my $test_dir = shift; + cd($repo); + return { + dir => canon_path("$test_dir/stow"), + target => "$test_dir/target" + }; + }, + sub { + plan tests => 3; + my ($stow, $test_dir) = @_; + + make_path("$test_dir/stow/pkg14/bin14"); + make_file("$test_dir/stow/pkg14/bin14/file14"); + make_link("$test_dir/target/bin14", '../stow/pkg14/bin14'); + + $stow->plan_unstow('pkg14'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-f "$test_dir/stow/pkg14/bin14/file14"); + ok(! -e "$test_dir/target/bin14" + => 'unstow a simple tree with absolute stow dir' + ); +}); + +subtests("unstow a simple tree minimally with absolute stow AND target dirs when cwd isn't target", + sub { + my $test_dir = shift; + cd($repo); + return { + dir => canon_path("$test_dir/stow"), + target => canon_path("$test_dir/target") + }; + }, + sub { + my ($stow, $test_dir) = @_; + plan tests => 3; + + make_path("$test_dir/stow/pkg15/bin15"); + make_file("$test_dir/stow/pkg15/bin15/file15"); + make_link("$test_dir/target/bin15", '../stow/pkg15/bin15'); + + $stow->plan_unstow('pkg15'); + $stow->process_tasks(); + is($stow->get_conflict_count, 0, 'conflict count'); + ok(-f "$test_dir/stow/pkg15/bin15/file15"); + ok(! -e "$test_dir/target/bin15" + => 'unstow a simple tree with absolute stow and target dirs' + ); +}); sub create_and_stow_pkg { my ($id, $pkg) = @_; my $stow_pkg = "../stow/$id-$pkg"; - make_path ($stow_pkg); + make_path($stow_pkg); make_file("$stow_pkg/$id-file-$pkg"); # create a shallow hierarchy specific to this package and stow # via folding - make_path ("$stow_pkg/$id-$pkg-only-folded"); + make_path("$stow_pkg/$id-$pkg-only-folded"); make_file("$stow_pkg/$id-$pkg-only-folded/file-$pkg"); make_link("$id-$pkg-only-folded", "$stow_pkg/$id-$pkg-only-folded"); # create a deeper hierarchy specific to this package and stow # via folding - make_path ("$stow_pkg/$id-$pkg-only-folded2/subdir"); + make_path("$stow_pkg/$id-$pkg-only-folded2/subdir"); make_file("$stow_pkg/$id-$pkg-only-folded2/subdir/file-$pkg"); make_link("$id-$pkg-only-folded2", "$stow_pkg/$id-$pkg-only-folded2"); # create a shallow hierarchy specific to this package and stow # without folding - make_path ("$stow_pkg/$id-$pkg-only-unfolded"); + make_path("$stow_pkg/$id-$pkg-only-unfolded"); make_file("$stow_pkg/$id-$pkg-only-unfolded/file-$pkg"); - make_path ("$id-$pkg-only-unfolded"); + make_path("$id-$pkg-only-unfolded"); make_link("$id-$pkg-only-unfolded/file-$pkg", "../$stow_pkg/$id-$pkg-only-unfolded/file-$pkg"); # create a deeper hierarchy specific to this package and stow # without folding - make_path ("$stow_pkg/$id-$pkg-only-unfolded2/subdir"); + make_path("$stow_pkg/$id-$pkg-only-unfolded2/subdir"); make_file("$stow_pkg/$id-$pkg-only-unfolded2/subdir/file-$pkg"); - make_path ("$id-$pkg-only-unfolded2/subdir"); + make_path("$id-$pkg-only-unfolded2/subdir"); make_link("$id-$pkg-only-unfolded2/subdir/file-$pkg", "../../$stow_pkg/$id-$pkg-only-unfolded2/subdir/file-$pkg"); # create a shallow shared hierarchy which this package uses, and stow # its contents without folding - make_path ("$stow_pkg/$id-shared"); + make_path("$stow_pkg/$id-shared"); make_file("$stow_pkg/$id-shared/file-$pkg"); - make_path ("$id-shared"); + make_path("$id-shared"); make_link("$id-shared/file-$pkg", "../$stow_pkg/$id-shared/file-$pkg"); # create a deeper shared hierarchy which this package uses, and stow # its contents without folding - make_path ("$stow_pkg/$id-shared2/subdir"); + make_path("$stow_pkg/$id-shared2/subdir"); make_file("$stow_pkg/$id-shared2/file-$pkg"); make_file("$stow_pkg/$id-shared2/subdir/file-$pkg"); - make_path ("$id-shared2/subdir"); + make_path("$id-shared2/subdir"); make_link("$id-shared2/file-$pkg", "../$stow_pkg/$id-shared2/file-$pkg"); make_link("$id-shared2/subdir/file-$pkg", "../../$stow_pkg/$id-shared2/subdir/file-$pkg"); } -foreach my $pkg (qw{a b}) { - create_and_stow_pkg('no-folding', $pkg); -} +subtest("unstow a tree with no-folding enabled - no refolding should take place", sub { + cd("$TEST_DIR/target"); + plan tests => 15; -$stow = new_Stow('no-folding' => 1); -$stow->plan_unstow('no-folding-b'); -is_deeply([ $stow->get_conflicts ], [] => 'no conflicts with --no-folding'); -use Data::Dumper; -#warn Dumper($stow->get_tasks); + foreach my $pkg (qw{a b}) { + create_and_stow_pkg('no-folding', $pkg); + } -$stow->process_tasks(); + my $stow = new_Stow('no-folding' => 1); + $stow->plan_unstow('no-folding-b'); + is_deeply([ $stow->get_conflicts ], [] => 'no conflicts with --no-folding'); -is_nonexistent_path('no-folding-b-only-folded'); -is_nonexistent_path('no-folding-b-only-folded2'); -is_nonexistent_path('no-folding-b-only-unfolded/file-b'); -is_nonexistent_path('no-folding-b-only-unfolded2/subdir/file-b'); -is_dir_not_symlink('no-folding-shared'); -is_dir_not_symlink('no-folding-shared2'); -is_dir_not_symlink('no-folding-shared2/subdir'); + $stow->process_tasks(); + is_nonexistent_path('no-folding-b-only-folded'); + is_nonexistent_path('no-folding-b-only-folded2'); + is_nonexistent_path('no-folding-b-only-unfolded/file-b'); + is_nonexistent_path('no-folding-b-only-unfolded2/subdir/file-b'); + is_dir_not_symlink('no-folding-shared'); + is_dir_not_symlink('no-folding-shared2'); + is_dir_not_symlink('no-folding-shared2/subdir'); +}); -# Todo -# -# Test cleaning up subdirs with --paranoid option +# subtests("Test cleaning up subdirs with --paranoid option", sub { +# TODO +# }); diff --git a/t/unstow_orig.t b/t/unstow_orig.t deleted file mode 100755 index 6d5ff8d..0000000 --- a/t/unstow_orig.t +++ /dev/null @@ -1,403 +0,0 @@ -#!/usr/bin/perl -# -# This file is part of GNU Stow. -# -# GNU Stow is free software: you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# GNU Stow is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see https://www.gnu.org/licenses/. - -# -# Test unstowing packages in compat mode -# - -use strict; -use warnings; - -use File::Spec qw(make_path); -use Test::More tests => 37; -use Test::Output; -use English qw(-no_match_vars); - -use testutil; -use Stow::Util qw(canon_path); - -init_test_dirs(); -cd("$TEST_DIR/target"); - -# Note that each of the following tests use a distinct set of files - -my $stow; -my %conflicts; - -# -# unstow a simple tree minimally -# - -$stow = new_compat_Stow(); - -make_path('../stow/pkg1/bin1'); -make_file('../stow/pkg1/bin1/file1'); -make_link('bin1', '../stow/pkg1/bin1'); - -$stow->plan_unstow('pkg1'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f '../stow/pkg1/bin1/file1' && ! -e 'bin1' - => 'unstow a simple tree' -); - -# -# unstow a simple tree from an existing directory -# -$stow = new_compat_Stow(); - -make_path('lib2'); -make_path('../stow/pkg2/lib2'); -make_file('../stow/pkg2/lib2/file2'); -make_link('lib2/file2', '../../stow/pkg2/lib2/file2'); -$stow->plan_unstow('pkg2'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f '../stow/pkg2/lib2/file2' && -d 'lib2' - => 'unstow simple tree from a pre-existing directory' -); - -# -# fold tree after unstowing -# -$stow = new_compat_Stow(); - -make_path('bin3'); - -make_path('../stow/pkg3a/bin3'); -make_file('../stow/pkg3a/bin3/file3a'); -make_link('bin3/file3a' => '../../stow/pkg3a/bin3/file3a'); # emulate stow - -make_path('../stow/pkg3b/bin3'); -make_file('../stow/pkg3b/bin3/file3b'); -make_link('bin3/file3b' => '../../stow/pkg3b/bin3/file3b'); # emulate stow -$stow->plan_unstow('pkg3b'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -l 'bin3' && - readlink('bin3') eq '../stow/pkg3a/bin3' - => 'fold tree after unstowing' -); - -# -# existing link is owned by stow but is invalid so it gets removed anyway -# -$stow = new_compat_Stow(); - -make_path('bin4'); -make_path('../stow/pkg4/bin4'); -make_file('../stow/pkg4/bin4/file4'); -make_invalid_link('bin4/file4', '../../stow/pkg4/bin4/does-not-exist'); - -$stow->plan_unstow('pkg4'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - ! -e 'bin4/file4' - => q(remove invalid link owned by stow) -); - -# -# Existing link is not owned by stow -# -$stow = new_compat_Stow(); - -make_path('../stow/pkg5/bin5'); -make_invalid_link('bin5', '../not-stow'); - -$stow->plan_unstow('pkg5'); -# Unlike the corresponding stow_contents.t test, this doesn't -# cause any conflicts. -# -#like( -# $Conflicts[-1], qr(can't unlink.*not owned by stow) -# => q(existing link not owned by stow) -#); -ok( - -l 'bin5' && readlink('bin5') eq '../not-stow' - => q(existing link not owned by stow) -); - -# -# Target already exists, is owned by stow, but points to a different package -# -$stow = new_compat_Stow(); - -make_path('bin6'); -make_path('../stow/pkg6a/bin6'); -make_file('../stow/pkg6a/bin6/file6'); -make_link('bin6/file6', '../../stow/pkg6a/bin6/file6'); - -make_path('../stow/pkg6b/bin6'); -make_file('../stow/pkg6b/bin6/file6'); - -$stow->plan_unstow('pkg6b'); -ok( - $stow->get_conflict_count == 0 && - -l 'bin6/file6' && - readlink('bin6/file6') eq '../../stow/pkg6a/bin6/file6' - => q(ignore existing link that points to a different package) -); - -# -# Don't unlink anything under the stow directory -# -make_path('stow'); # make out stow dir a subdir of target -$stow = new_compat_Stow(dir => 'stow'); - -# emulate stowing into ourself (bizarre corner case or accident) -make_path('stow/pkg7a/stow/pkg7b'); -make_file('stow/pkg7a/stow/pkg7b/file7b'); -make_link('stow/pkg7b', '../stow/pkg7a/stow/pkg7b'); - -capture_stderr(); -$stow->plan_unstow('pkg7b'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg7b'); -ok( - $stow->get_conflict_count == 0 && - -l 'stow/pkg7b' && - readlink('stow/pkg7b') eq '../stow/pkg7a/stow/pkg7b' - => q(don't unlink any nodes under the stow directory) -); -like($stderr, - qr/WARNING: skipping target which was current stow directory stow/ - => "warn when unstowing from ourself"); -uncapture_stderr(); - -# -# Don't unlink any nodes under another stow directory -# -$stow = new_compat_Stow(dir => 'stow'); - -make_path('stow2'); # make our alternate stow dir a subdir of target -make_file('stow2/.stow'); - -# emulate stowing into ourself (bizarre corner case or accident) -make_path('stow/pkg8a/stow2/pkg8b'); -make_file('stow/pkg8a/stow2/pkg8b/file8b'); -make_link('stow2/pkg8b', '../stow/pkg8a/stow2/pkg8b'); - -capture_stderr(); -$stow->plan_unstow('pkg8a'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg8a'); -ok( - $stow->get_conflict_count == 0 && - -l 'stow2/pkg8b' && - readlink('stow2/pkg8b') eq '../stow/pkg8a/stow2/pkg8b' - => q(don't unlink any nodes under another stow directory) -); -like($stderr, - qr/WARNING: skipping target which was current stow directory stow/ - => "warn when skipping unstowing"); -uncapture_stderr(); - -# -# overriding already stowed documentation -# - -# This will be used by this and subsequent tests -sub check_protected_dirs_skipped { - for my $dir (qw{stow stow2}) { - like($stderr, - qr/WARNING: skipping protected directory $dir/ - => "warn when skipping protected directory $dir"); - } - uncapture_stderr(); -} - -$stow = new_compat_Stow(override => ['man9', 'info9']); -make_file('stow/.stow'); - -make_path('../stow/pkg9a/man9/man1'); -make_file('../stow/pkg9a/man9/man1/file9.1'); -make_path('man9/man1'); -make_link('man9/man1/file9.1' => '../../../stow/pkg9a/man9/man1/file9.1'); # emulate stow - -make_path('../stow/pkg9b/man9/man1'); -make_file('../stow/pkg9b/man9/man1/file9.1'); -capture_stderr(); -$stow->plan_unstow('pkg9b'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - !-l 'man9/man1/file9.1' - => 'overriding existing documentation files' -); -check_protected_dirs_skipped(); - -# -# deferring to already stowed documentation -# -$stow = new_compat_Stow(defer => ['man10', 'info10']); - -make_path('../stow/pkg10a/man10/man1'); -make_file('../stow/pkg10a/man10/man1/file10a.1'); -make_path('man10/man1'); -make_link('man10/man1/file10a.1' => '../../../stow/pkg10a/man10/man1/file10a.1'); - -# need this to block folding -make_path('../stow/pkg10b/man10/man1'); -make_file('../stow/pkg10b/man10/man1/file10b.1'); -make_link('man10/man1/file10b.1' => '../../../stow/pkg10b/man10/man1/file10b.1'); - - -make_path('../stow/pkg10c/man10/man1'); -make_file('../stow/pkg10c/man10/man1/file10a.1'); -capture_stderr(); -$stow->plan_unstow('pkg10c'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg10c'); -ok( - $stow->get_conflict_count == 0 && - readlink('man10/man1/file10a.1') eq '../../../stow/pkg10a/man10/man1/file10a.1' - => 'defer to existing documentation files' -); -check_protected_dirs_skipped(); - -# -# Ignore temp files -# -$stow = new_compat_Stow(ignore => ['~', '\.#.*']); - -make_path('../stow/pkg12/man12/man1'); -make_file('../stow/pkg12/man12/man1/file12.1'); -make_file('../stow/pkg12/man12/man1/file12.1~'); -make_file('../stow/pkg12/man12/man1/.#file12.1'); -make_path('man12/man1'); -make_link('man12/man1/file12.1' => '../../../stow/pkg12/man12/man1/file12.1'); - -capture_stderr(); -$stow->plan_unstow('pkg12'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - !-e 'man12/man1/file12.1' - => 'ignore temp files' -); -check_protected_dirs_skipped(); - -# -# Unstow an already unstowed package -# -$stow = new_compat_Stow(); -capture_stderr(); -$stow->plan_unstow('pkg12'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg12'); -ok( - $stow->get_conflict_count == 0 - => 'unstow already unstowed package pkg12' -); -check_protected_dirs_skipped(); - -# -# Unstow a never stowed package -# - -eval { remove_dir("$TEST_DIR/target"); }; -mkdir("$TEST_DIR/target"); - -$stow = new_compat_Stow(); -capture_stderr(); -$stow->plan_unstow('pkg12'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg12 which was never stowed'); -ok( - $stow->get_conflict_count == 0 - => 'unstow never stowed package pkg12' -); -check_protected_dirs_skipped(); - -# -# Unstowing when target contains a real file shouldn't be an issue. -# -make_file('man12/man1/file12.1'); - -$stow = new_compat_Stow(); -capture_stderr(); -$stow->plan_unstow('pkg12'); -is($stow->get_tasks, 0, 'no tasks to process when unstowing pkg12 for third time'); -%conflicts = $stow->get_conflicts; -ok( - $stow->get_conflict_count == 1 && - $conflicts{unstow}{pkg12}[0] - =~ m!existing target is neither a link nor a directory: man12/man1/file12\.1! - => 'unstow pkg12 for third time' -); -check_protected_dirs_skipped(); - -# -# unstow a simple tree minimally when cwd isn't target -# -cd('../..'); -$stow = new_Stow(dir => "$TEST_DIR/stow", target => "$TEST_DIR/target"); - -make_path("$TEST_DIR/stow/pkg13/bin13"); -make_file("$TEST_DIR/stow/pkg13/bin13/file13"); -make_link("$TEST_DIR/target/bin13", '../stow/pkg13/bin13'); - -$stow->plan_unstow('pkg13'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f "$TEST_DIR/stow/pkg13/bin13/file13" && ! -e "$TEST_DIR/target/bin13" - => 'unstow a simple tree' -); - -# -# unstow a simple tree minimally with absolute stow dir when cwd isn't -# target -# -$stow = new_Stow(dir => canon_path("$TEST_DIR/stow"), - target => "$TEST_DIR/target"); - -make_path("$TEST_DIR/stow/pkg14/bin14"); -make_file("$TEST_DIR/stow/pkg14/bin14/file14"); -make_link("$TEST_DIR/target/bin14", '../stow/pkg14/bin14'); - -$stow->plan_unstow('pkg14'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f "$TEST_DIR/stow/pkg14/bin14/file14" && ! -e "$TEST_DIR/target/bin14" - => 'unstow a simple tree with absolute stow dir' -); - -# -# unstow a simple tree minimally with absolute stow AND target dirs -# when cwd isn't target -# -$stow = new_Stow(dir => canon_path("$TEST_DIR/stow"), - target => canon_path("$TEST_DIR/target")); - -make_path("$TEST_DIR/stow/pkg15/bin15"); -make_file("$TEST_DIR/stow/pkg15/bin15/file15"); -make_link("$TEST_DIR/target/bin15", '../stow/pkg15/bin15'); - -$stow->plan_unstow('pkg15'); -$stow->process_tasks(); -ok( - $stow->get_conflict_count == 0 && - -f "$TEST_DIR/stow/pkg15/bin15/file15" && ! -e "$TEST_DIR/target/bin15" - => 'unstow a simple tree with absolute stow and target dirs' -); - - -# Todo -# -# Test cleaning up subdirs with --paranoid option -