home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / program / funnel / help.c < prev    next >
Encoding:
C/C++ Source or Header  |  1993-10-23  |  29.7 KB  |  606 lines
  1. /*##############################################################################
  2.  
  3. FUNNNELWEB COPYRIGHT
  4. ====================
  5. FunnelWeb is a literate-programming macro preprocessor.
  6.  
  7. Copyright (C) 1992 Ross N. Williams.
  8.  
  9.    Ross N. Williams
  10.    ross@spam.adelaide.edu.au
  11.    16 Lerwick Avenue, Hazelwood Park 5066, Australia.
  12.  
  13. This program is free software; you can redistribute it and/or modify
  14. it under the terms of Version 2 of the GNU General Public License as
  15. published by the Free Software Foundation.
  16.  
  17. This program is distributed WITHOUT ANY WARRANTY; without even the implied
  18. warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  19. See Version 2 of the GNU General Public License for more details.
  20.  
  21. You should have received a copy of Version 2 of the GNU General Public
  22. License along with this program. If not, you can FTP the license from
  23. prep.ai.mit.edu/pub/gnu/COPYING-2 or write to the Free Software
  24. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25.  
  26. Section 2a of the license requires that all changes to this file be
  27. recorded prominently in this file. Please record all changes here.
  28.  
  29. Programmers:
  30.    RNW  Ross N. Williams  ross@spam.adelaide.edu.au
  31.  
  32. Changes:
  33.    07-May-1992  RNW  Program prepared for release under GNU GPL V2.
  34.  
  35. ##############################################################################*/
  36.  
  37.  
  38. /******************************************************************************/
  39. /*                                   HELP.C                                   */
  40. /******************************************************************************/
  41. /*                                                                            */
  42. /* REPRESENTING MESSAGES AS C CODE                                            */
  43. /* ===============================                                            */
  44. /* Experience has shown that it is much more reliable to code text messages   */
  45. /* into a program than to expect the program to track down text files         */
  46. /* containing the messages at run time. Worthwhile for smallish files (such   */
  47. /* as these help messages) at least. For this reason, most the messages in    */
  48. /* this module are represented by code (e.g. as in printf statements).        */
  49. /*                                                                            */
  50. /* The only exception is the 18K Gnu license message which is a bit too big   */
  51. /* to be done by hand. It has been moved to the help_gnu module.              */
  52. /*                                                                            */
  53. /******************************************************************************/
  54.  
  55. #include <ctype.h>
  56. #include "style.h"
  57.  
  58. #include "as.h"
  59. #include "help.h"
  60. #include "help_gnu.h"
  61. #include "misc.h"
  62. #include "option.h"
  63.  
  64. /******************************************************************************/
  65.  
  66. /* This module contains many many output statements that call an output       */
  67. /* function. To neaten up all these calls, we define a global variable to     */
  68. /* hold a pointer to the function and simple macro to write output using      */
  69. /* the function.                                                              */
  70. LOCVAR void (*pf) P_((char *));
  71.  
  72. #define WX(STR) (*pf)(STR)
  73.  
  74. /******************************************************************************/
  75.  
  76. LOCAL void hel_men P_((void));
  77. LOCAL void hel_men ()
  78. {
  79.  WX("\n");
  80.  WX("FunnelWeb Help Messages\n");
  81.  WX("-----------------------\n");
  82.  WX("Introduction  - Introduction to FunnelWeb.\n");
  83.  WX("DOcumentation - How to obtain FunnelWeb documentation.\n");
  84.  WX("Options       - Command line options.\n");
  85.  WX("DEfoptions    - Default command line options.\n");
  86.  WX("COMmands      - Interactive commands.\n");
  87.  WX("Registration  - How to register as an \"official\" FunnelWeb user.\n");
  88.  WX("Support       - How you can help support FunnelWeb development.\n");
  89.  WX("COPyright     - Copyright notice.\n");
  90.  WX("License       - The license under which this software is distributed (long).\n");
  91.  WX("Nowarranty    - Extract from the GNU license concerning lack of warranty.\n");
  92.  WX("DIstribution  - Extract from the GNU license concerning distribution.\n");
  93.  WX("MOdification  - Read this message if you intend to modify FunnelWeb.\n");
  94.  WX("Versions      - A list of existing versions of FunnelWeb.\n");
  95.  WX("Acknowledge   - Thanks to people who helped with FunnelWeb development.\n");
  96.  WX("MEnu          - The message you are reading (the default help message).\n");
  97.  WX("\n");
  98.  WX("To display a message, give its (optionally abbreviated) name in a help command.\n");
  99.  WX("To capture a message to a file, add +J<filename> to the fw command. Examples:\n");
  100.  WX("\n");
  101.  WX("          fw +Hintroduction +Jintro.txt   -- From the operating system level.\n");
  102.  WX("          help introduction               -- From FunnelWeb interactive mode.\n");
  103. }
  104.  
  105. /******************************************************************************/
  106.  
  107. LOCAL void hel_int P_((void));
  108. LOCAL void hel_int ()
  109. {
  110.  WX("\n");
  111.  WX("FunnelWeb Introduction\n");
  112.  WX("----------------------\n");
  113.  WX("Welcome to FunnelWeb, a literate-programming macro preprocessor.\n");
  114.  WX("\n");
  115.  WX("Traditional computer programs are primarily written for computers and consist\n");
  116.  WX("of code laced with comments. In contrast, literate programs are primarily\n");
  117.  WX("written for humans and consist of comments laced with code.  While simple, the\n");
  118.  WX("effect of this inversion can be so profound as to change one's whole approach\n");
  119.  WX("to programming.  The literate programmer focuses on conveying meaning to other\n");
  120.  WX("intelligent beings rather than merely convincing the computer to behave in a\n");
  121.  WX("particular way. It is the difference between performing and exposing a magic\n");
  122.  WX("trick.\n");
  123.  WX("\n");
  124.  WX("FunnelWeb is a production-quality literate-programming tool that emphasises\n");
  125.  WX("simplicity and reliability. It provides a macro facility, and assists in the\n");
  126.  WX("production of typeset documentation. FunnelWeb runs on most popular machines\n");
  127.  WX("(Sun, VAX, Mac, PC) and its highly portable source code in C is freely\n");
  128.  WX("available under a GNU license.\n");
  129.  WX("\n");
  130.  WX("To get started with FunnelWeb, obtain a printed copy of the \"FunnelWeb User's\n");
  131.  WX("Manual\" (see the \"DOCUMENTATION\" help message). Read the introduction and work\n");
  132.  WX("through the tutorial. The manual contains an overview of FunnelWeb, an\n");
  133.  WX("introductory tutorial, and a comprehensive reference manual. Try it!\n");
  134. }
  135.  
  136. /******************************************************************************/
  137.  
  138. LOCAL void hel_opt P_((void));
  139. LOCAL void hel_opt ()
  140. {
  141.  WX("\n");
  142.  WX("FunnelWeb Command Line Options\n");
  143.  WX("------------------------------\n");
  144.  WX("Options are of the form (\"+\" | \"=\" | \"-\") <letter> [<string>].\n");
  145.  WX("+ turns on an option. - turns it off. = doesn't affect it's onoffedness.\n");
  146.  WX("The case (e.g. upper or lower) of <letter> does not matter.\n");
  147.  WX("<string> is usually a filename or directory, but sometimes a number.\n");
  148.  WX("Convention: f=filename, n=decimal number, h=help message name.\n");
  149.  WX("\n");
  150.  WX("Example: fw sloth +L +Jaardvark.xxx +W80 -Q =Twalrus.tex\n");
  151.  WX("\n");
  152.  WX("Action options: (choose at least one when you invoke FunnelWeb from the OS).\n");
  153.  WX("If you choose more than one, they will be executed in the order given here.\n");
  154.  WX("   +Xf   Execute specified Funnelweb script.\n");
  155.  WX("   +Ff   Process specified input file.\n");
  156.  WX("   +Hh   Display specified help message.\n");
  157.  WX("   +K    Invoke FunnelWeb's interative mode.\n");
  158.  WX("\n");
  159.  WX("Other options:\n");
  160.  WX("   +B1   Diagnostic: Dump image of input file    to listing file.\n");
  161.  WX("   +B2   Diagnostic: Dump scanner's line list    to listing file.\n");
  162.  WX("   +B3   Diagnostic: Dump scanner's token list   to listing file.\n");
  163.  WX("   +B4   Diagnostic: Dump parser's macro table   to listing file.\n");
  164.  WX("   +B5   Diagnostic: Dump parser's document list to listing file.\n");
  165.  WX("   +B6   Diagnostic: Dump time breakdown report  to listing file.\n");
  166.  WX("   +B7   Diagnostic: Suppress non-deterministic output.\n");
  167.  WX("   +Cn   Number of lines of context around diagnostics in listing file.\n");
  168.  WX("   +D    Delete each output file identical to its previous version.\n");
  169.  WX("   +If   Default file specification for include files.\n");
  170.  WX("   +Jf   Generate journal file.  Default file specification.\n");
  171.  WX("   +Lf   Generate listing file.  Default file specification.\n");
  172.  WX("   +Of   Generate product files. Default file specification.\n");
  173.  WX("   +Q    Quiet mode. Only really important messages displayed on console.\n");
  174.  WX("   +Tf   Generate typesetter file. Default file specification.\n");
  175.  WX("   +Sn   Send errors to console with specified number of lines of context.\n");
  176.  WX("   +Wn   Set maximum length of lines in product files.\n");
  177.  WX("\n");
  178.  WX("If an option appears more than once, the rightmost one dominates.\n");
  179.  WX("For more detailed information, refer to the FunnelWeb User's Manual.\n");
  180.  WX("For default values refer to the \"DEFOPTIONS\" help message.\n");
  181. }
  182.  
  183. /******************************************************************************/
  184.  
  185. LOCAL void hel_dop P_((void));
  186. LOCAL void hel_dop ()
  187. {
  188.  op_t defop;
  189.  
  190.  WX("\n");
  191.  WX("FunnelWeb Default Option Settings\n");
  192.  WX("---------------------------------\n");
  193.  WX("These are the settings FunnelWeb STARTS UP with.\n");
  194.  op_ini(&defop);
  195.  WX("\n");
  196.  op_wri(&defop,pf);
  197.  WX("\n");
  198.  WX("See the OPTIONS help message for a brief description of these options.\n");
  199.  WX("For more detailed information, refer to the FunnelWeb User's Manual.\n");
  200. }
  201.  
  202. /******************************************************************************/
  203.  
  204. LOCAL void hel_com P_((void));
  205. LOCAL void hel_com ()
  206. {
  207.  WX("\n");
  208.  WX("FunnelWeb Interactive Commands\n");
  209.  WX("------------------------------\n");
  210.  WX("   !                       - Comment. Ignores the whole line.             \n");
  211.  WX("   ABSENT fn               - Aborts if specified file exists.             \n");
  212.  WX("   CODIFY ftext fC         - Convert text file into C code to write text. \n");
  213.  WX("   COMPARE f1 f2           - Aborts if two files are different.           \n");
  214.  WX("   DEFINE n \"text\"         - Defines $n to translate to text.             \n");
  215.  WX("   DIFF f1 f2 logf [ABORT] - Writes differences between f1 and f2 to logf.\n");
  216.  WX("                           - Severe if different and ABORT is present.    \n");
  217.  WX("   DIFFSUMMARY             - Summary of differences done since DIFFZERO.  \n");
  218.  WX("   DIFFZERO                - Zeros differences counters.                  \n");
  219.  WX("   ENEO fn                 - Establish Non Existence Of file.             \n");
  220.  WX("   EXECUTE fn              - Execute commands in specified file.          \n");
  221.  WX("   EXISTS fn               - Aborts if file does not exist.               \n");
  222.  WX("   FIXEOLS fn [outf]       - Fixes up EOL markers in specified file.      \n");
  223.  WX("   FW options              - Invoke FunnelWeb-proper once.                \n");
  224.  WX("   HELP [name]             - Displays specified help message.             \n");
  225.  WX("   HERE                    - Terminates effect of SKIPTO command.         \n");
  226.  WX("   QUIT                    - Quits FunnelWeb.                             \n");
  227.  WX("   SET options             - Sets options.                                \n");
  228.  WX("   SHOW                    - Displays currently active options.           \n");
  229.  WX("   SKIPTO                  - Ignore commands until HERE command.          \n");
  230.  WX("   STATUS                  - Write out status and diagnostic counts.      \n");
  231.  WX("   STATUS [Sn] [En] [Wn]   - Aborts if status is not as specified.        \n");
  232.  WX("   TOLERATE                - Don't abort script if next commmand gens err.\n");
  233.  WX("   TRACE ON | OFF          - Turns command tracing ON or OFF.             \n");
  234.  WX("   WRITE \"text\"            - Writes specified text to screen and journal. \n");
  235.  WX("   WRITEU \"text\"           - Same as WRITE but underlines text.           \n");
  236.  WX("\n");
  237.  WX("More detailed information can be found in the FunnelWeb User's Manual.\n");
  238.  WX("\n");
  239.  WX("Most of these commands were created to support regression testing and\n");
  240.  WX("can be ignored by most users. In fact most users will never need to invoke\n");
  241.  WX("FunnelWeb's interactive mode at all. If you are just getting started\n");
  242.  WX("with FunnelWeb, it's probably best to run FunnelWeb directly from your\n");
  243.  WX("command interface and ignore the +K command line option for now.\n");
  244. }
  245.  
  246. /******************************************************************************/
  247.  
  248. LOCAL void hel_doc P_((void));
  249. LOCAL void hel_doc ()
  250. {
  251.  WX("\n");
  252.  WX("FunnelWeb Documentation\n");
  253.  WX("-----------------------\n");
  254.  WX("The following FunnelWeb documentation is available:\n");
  255.  WX("\n");
  256.  WX("   \"FunnelWeb User's   Manual\": Tutorial, Hints, Reference Manual.\n");
  257.  WX("   \"FunnelWeb Hacker's Manual\": Notes on Design and Implementation.\n");
  258.  WX("\n");
  259.  WX("Everyone involved with FunnelWeb should read the User's Manual.\n");
  260.  WX("It contains everything you need to learn how to use FunnelWeb.\n");
  261.  WX("\n");
  262.  WX("The Hacker's Manual is for those who want to install, modify, fix,\n");
  263.  WX("fiddle with, and generally hack the FunnelWeb C source code.\n");
  264.  WX("\n");
  265.  WX("Both of these manuals are shipped with the FunnelWeb distribution\n");
  266.  WX("kit, and should be available on your machine in the form of LaTeX text\n");
  267.  WX("files. If you cannot find them, you can obtain them by FTP from:\n");
  268.  WX("\n");
  269.  WX("    Machine  : sirius.itd.adelaide.edu.au [IP=129.127.40.3].\n");
  270.  WX("    Directory: ~pub/funnelweb/   (or a directory of similar name).\n");
  271.  WX("\n");
  272. }
  273.  
  274. /******************************************************************************/
  275.  
  276. LOCAL void hel_reg P_((void));
  277. LOCAL void hel_reg ()
  278. {
  279.  WX("FunnelWeb Registration\n");
  280.  WX("----------------------\n");
  281.  WX("If you install or use FunnelWeb, please fill in and return this form:\n");
  282.  WX("\n");
  283.  WX("   +----------------------FunnelWeb Registration Form----------------------+\n");
  284.  WX("   | 1. Date:                                                              |\n");
  285.  WX("   | 2. Title and name:                                                    |\n");
  286.  WX("   | 3. Internet email address:                                            |\n");
  287.  WX("   | 4. Snail mail address:                                                |\n");
  288.  WX("   | 5. Work phone number (country,area,number):                           |\n");
  289.  WX("   | 6. Which category of FunnelWeb user best describes you?               |\n");
  290.  WX("   |       Latent    - Installed FunnelWeb, but don't intend to use it.    |\n");
  291.  WX("   |       Beginner  - Haven't used FunnelWeb much yet; have an open mind. |\n");
  292.  WX("   |       Casual    - Use FunnelWeb occasionally.                         |\n");
  293.  WX("   |       Convert   - Use FunnelWeb to do most programming.               |\n");
  294.  WX("   |       Fanatic   - FunnelWeb has become a way of life.                 |\n");
  295.  WX("   | 7. What changes or new features would you like to see in FunnelWeb?   |\n");
  296.  WX("   | 8. Do you want to be kept informed of new FunnelWeb developments?     |\n");
  297.  WX("   | 9. Email this form to \"ross@spam.adelaide.edu.au\", OR snail mail to   |\n");
  298.  WX("   |    Ross Williams, 16 Lerwick Avenue, Hazelwood Park 5066, Australia.  |\n");
  299.  WX("   +-----------------------------------------------------------------------+\n");
  300.  WX("To write this form to a file, use \"fw +hreg +jregform.txt\".\n");
  301.  WX("You may wish to make a contribution when you register. See SUPPORT.\n");
  302. }
  303.  
  304. /******************************************************************************/
  305.  
  306. LOCAL void hel_cop P_((void));
  307. LOCAL void hel_cop ()
  308. {
  309.  WX("\n");
  310.  WX("FunnelWeb Copyright\n");
  311.  WX("-------------------\n");
  312.  WX("Copyright (C) 1992 Ross Williams.\n");
  313.  WX("\n");
  314.  WX("However, FunnelWeb has been released by the author and copyright owner Ross\n");
  315.  WX("Williams (ross@spam.adelaide.edu.au) under Version 2 of the GNU General Public\n");
  316.  WX("License published by the Free Software Foundation. This means that you can\n");
  317.  WX("redistribute FunnelWeb and/or modify it under the terms of the license.\n");
  318.  WX("\n");
  319.  WX("Note: This program is distributed WITHOUT ANY WARRANTY; without even the\n");
  320.  WX("implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n");
  321.  WX("\n");
  322.  WX("The following help messages provide further information:\n");
  323.  WX("\n");
  324.  WX("   License       - The license under which this software is distributed (long).\n");
  325.  WX("   DIstribution  - Extract from the GNU license concerning distribution.\n");
  326.  WX("   Nowarranty    - Extract from the GNU license concerning lack of warranty.\n");
  327.  WX("   MOdification  - Read this message if you intend to modify FunnelWeb.\n");
  328.  WX("   Registration  - How to register as an \"official\" FunnelWeb user.\n");
  329.  WX("\n");
  330. }
  331.  
  332. /******************************************************************************/
  333.  
  334. LOCAL void hel_now P_((void));
  335. LOCAL void hel_now ()
  336. {
  337.  WX("\n");
  338.  WX("FunnelWeb Comes With No Warranty\n");
  339.  WX("--------------------------------\n");
  340.  WX("Here is an extract from the GNU General Public License Version 2, under which\n");
  341.  WX("FunnelWeb is distributed. See help message \"LICENSE\" for the full license.\n");
  342.  WX("\n");
  343.  WX("     11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY\n");
  344.  WX("   FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN\n");
  345.  WX("   OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES\n");
  346.  WX("   PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED\n");
  347.  WX("   OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\n");
  348.  WX("   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS\n");
  349.  WX("   TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE\n");
  350.  WX("   PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,\n");
  351.  WX("   REPAIR OR CORRECTION.\n");
  352.  WX("\n");
  353.  WX("     12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\n");
  354.  WX("   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR\n");
  355.  WX("   REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,\n");
  356.  WX("   INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING\n");
  357.  WX("   OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED\n");
  358.  WX("   TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY\n");
  359.  WX("   YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER\n");
  360.  WX("   PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE\n");
  361.  WX("   POSSIBILITY OF SUCH DAMAGES.\n");
  362. }
  363.  
  364. /******************************************************************************/
  365.  
  366. LOCAL void hel_dis P_((void));
  367. LOCAL void hel_dis ()
  368. {
  369.  WX("\n");
  370.  WX("FunnelWeb Distribution\n");
  371.  WX("----------------------\n");
  372.  WX("The following is an extract from the GNU General Public License Version 2,\n");
  373.  WX("under which FunnelWeb is distributed.\n");
  374.  WX("\n");
  375.  WX("     1. You may copy and distribute verbatim copies of the Program's\n");
  376.  WX("   source code as you receive it, in any medium, provided that you\n");
  377.  WX("   conspicuously and appropriately publish on each copy an appropriate\n");
  378.  WX("   copyright notice and disclaimer of warranty; keep intact all the\n");
  379.  WX("   notices that refer to this License and to the absence of any warranty;\n");
  380.  WX("   and give any other recipients of the Program a copy of this License\n");
  381.  WX("   along with the Program.\n");
  382.  WX("\n");
  383.  WX("   You may charge a fee for the physical act of transferring a copy, and\n");
  384.  WX("   you may at your option offer warranty protection in exchange for a fee.\n");
  385.  WX("\n");
  386.  WX("The license also allows you other freedoms.  For more information refer\n");
  387.  WX("to the full text of the license in the help message \"LICENSE\".\n");
  388. }
  389.  
  390. /******************************************************************************/
  391.  
  392. LOCAL void hel_ack P_((void));
  393. LOCAL void hel_ack ()
  394. {
  395.  WX("\n");
  396.  WX("FunnelWeb Acknowledgements\n");
  397.  WX("--------------------------\n");
  398.  WX("The following people assisted with the preparation of FunnelWeb V3.0.\n");
  399.  WX("\n");
  400.  WX("Many thanks go to DAVID HULSE (dave@cs.adelaide.edu.au) who translated the 1986\n");
  401.  WX("version of FunnelWeb (V1) written in Ada into a public domain C version (V2).\n");
  402.  WX("The C code written by David formed the basis of V3 of FunnelWeb, but was\n");
  403.  WX("entirely rewritten during the intensive refinement and feature-injection\n");
  404.  WX("period leading up to this release (V3 is about 3 times the size of V2).\n");
  405.  WX("\n");
  406.  WX("Thanks go to SIMON HACKETT (simon@internode.com.au) of Internode Systems\n");
  407.  WX("Pty Ltd for the use of his Sun, Mac, and PC, for assistance in porting\n");
  408.  WX("FunnelWeb to the Sun and PC, and for helpful discussions.\n");
  409.  WX("\n");
  410.  WX("Thanks go to JEREMY BEGG (jeremy@vsm.com.au) of VSM Software Services\n");
  411.  WX("for the use of his VAX, and for assistance with the VMS-specific code.\n");
  412.  WX("\n");
  413.  WX("Ross Williams (ross@spam.adelaide.edu.au), 12 May 1992.\n");
  414. }
  415.  
  416. /******************************************************************************/
  417.  
  418. LOCAL void hel_ver P_((void));
  419. LOCAL void hel_ver ()
  420. {
  421.  WX("\n");
  422.  WX("FunnelWeb Versions\n");
  423.  WX("------------------\n");
  424.  WX("FunnelWeb was created in 1986 and was used extensively by Ross Williams\n");
  425.  WX("(ross@spam.adelaide.edu.au) for three years. However, Version 1.0 was written\n");
  426.  WX("in Ada and was not very portable (it was fairly VAX/VMS specific). David Hulse\n");
  427.  WX("(dave@cs.adelaide.edu.au) took the first step towards a release by translating\n");
  428.  WX("the Ada code into C. Ross Williams then extensively reworked the C code, making\n");
  429.  WX("it robust and portable, adding new features, and polishing it to its current\n");
  430.  WX("form.\n");
  431.  WX("\n");
  432.  WX("Vers  Lang  Created  Released   Author          Copyright      Licensing      \n");
  433.  WX("----  ----  -------  --------   --------------  -------------  ---------      \n");
  434.  WX("V1.0  Ada   1986     Never      Ross  Williams  Ross Williams                 \n");
  435.  WX("V2.0  C     1989     Never      David Hulse     Public domain  No restriction.\n");
  436.  WX("V3.0  C     1992     May-1992   Ross  Williams  Ross Williams  GNU release.   \n");
  437.  WX("\n");
  438.  WX("This is FunnelWeb Version 3.0. Unless otherwise specified, all references\n");
  439.  WX("in this release to \"FunnelWeb\" refer either to the abstract identity\n");
  440.  WX("of FunnelWeb, or to this version, FunnelWeb Version 3.0.\n");
  441. }
  442.  
  443. /******************************************************************************/
  444.  
  445. LOCAL void hel_sup P_((void));
  446. LOCAL void hel_sup ()
  447. {
  448.  WX("\n");
  449.  WX("FunnelWeb Support\n");
  450.  WX("-----------------\n");
  451.  WX("FunnelWeb is released \"as is\" under a GNU license, and no formal support\n");
  452.  WX("is available. You have the right to make changes to FunnelWeb and to use\n");
  453.  WX("the modified versions created by random programmers. However, this is\n");
  454.  WX("discouraged (see the MODIFICATION help message).\n");
  455.  WX("\n");
  456.  WX("In fact the support that is most needed is your financial support for the\n");
  457.  WX("FunnelWeb developers! It has taken MONTHS of full-time UNPAID work to bring\n");
  458.  WX("FunnelWeb to you in its current form. I don't want to inconvenience users\n");
  459.  WX("who install FunnelWeb, play with it, and then hardly ever use it. If you are\n");
  460.  WX("in this category, please register, but don't bother contributing. However,\n");
  461.  WX("if you find that FunnelWeb has become a useful programming tool, a contribution\n");
  462.  WX("of some positive multiple of US$50 would be appreciated.\n");
  463.  WX("\n");
  464.  WX("To make a contribution, send payment with a completed registration form\n");
  465.  WX("(see the REGISTRATION help message) to:\n");
  466.  WX("\n");
  467.  WX("   Renaissance Software Pty Ltd\n");
  468.  WX("   Email: ross@spam.adelaide.edu.au\n");
  469.  WX("   Snail: 16 Lerwick Avenue, Hazelwood Park 5066, Australia.\n");
  470.  WX("\n");
  471.  WX("Payment can be by personal or bank cheque to any bank in the world or by\n");
  472.  WX("Visa or Mastercard. Please give the card name, number, expiry date, and\n");
  473.  WX("the amount to be paid in US dollars. All contributions will be appreciated\n");
  474.  WX("and will encourage further FunnelWeb development. However, no undertaking\n");
  475.  WX("is made whatsoever about how the money will be used.\n");
  476.  WX("\n");
  477.  WX("Ross Williams (ross@spam.adelaide.edu.au), 12 May 1992.\n");
  478. }
  479.  
  480. /******************************************************************************/
  481.  
  482. LOCAL void hel_mod P_((void));
  483. LOCAL void hel_mod ()
  484. {
  485.  WX("\n");
  486.  WX("FunnelWeb Modifications\n");
  487.  WX("-----------------------\n");
  488.  WX("FunnelWeb is distributed under a GNU license, and you are free to modify the\n");
  489.  WX("source code and distribute modified copies (see the help message LICENSE).\n");
  490.  WX("However, there are good reasons why you should avoid doing this.\n");
  491.  WX("\n");
  492.  WX("   1) If you distribute modified versions of FunnelWeb, you run the risk of\n");
  493.  WX("   creating a version that will diverge from the \"official\" version of\n");
  494.  WX("   FunnelWeb which I intend to maintain.\n");
  495.  WX("\n");
  496.  WX("   2) If you release a version of FunnelWeb with a changed input language,\n");
  497.  WX("   users of your modified version will create source files that will no\n");
  498.  WX("   longer work on other versions of FunnelWeb. The result will be chaos.\n");
  499.  WX("\n");
  500.  WX("For these reasons I request that you do not distribute modified versions of\n");
  501.  WX("FunnelWeb, particularly versions with a modified language. However, if you must\n");
  502.  WX("distribute a version with a modified language, PLEASE CHANGE ITS NAME (i.e.\n");
  503.  WX("from \"FunnelWeb\" to something else). Please also allocate a new file extension\n");
  504.  WX("to replace \".fw\" as the extension for source files written in the modified\n");
  505.  WX("language. For more information, refer to the FunnelWeb Hacker's Manual.\n");
  506.  WX("\n");
  507.  WX("Ross Williams (ross@spam.adelaide.edu.au), 12 May 1992.\n");
  508. }
  509.  
  510. /******************************************************************************/
  511.  
  512. LOCAL bool prefeq P_((char *,char *));
  513. LOCAL bool prefeq (p_pref,p_target)
  514. /* Returns TRUE iff string p_pref is a case insensitive prefix of p_target.   */
  515. char *p_pref;
  516. char *p_target;
  517. {
  518.  char *p,*q;
  519.  
  520.  if (strlen(p_pref) > strlen(p_target))
  521.     return FALSE;
  522.  
  523.  p=p_pref;
  524.  q=p_target;
  525.  while (*p != EOS)
  526.    {
  527.     if (toupper(*p) != toupper(*q)) return FALSE;
  528.     p++;
  529.     q++;
  530.    }
  531.  return TRUE;
  532. }
  533.  
  534. /******************************************************************************/
  535.  
  536. EXPORT uword hel_num (p_name)
  537. char *p_name;
  538. {
  539.  uword matches = 0;
  540.  uword messnum;
  541.  
  542.  /* We want to be fairly lenient on the user here as the user is trying to    */
  543.  /* obtain help and will probably get annoyed and give up if it doesn't work, */
  544.  /* so we perform case insensitive prefix matching.  However, we don't want   */
  545.  /* to match if the user inputs a prefix that matches two message names. This */
  546.  /* means we can't just return when we find a match; we have to see if there  */
  547.  /* are any others as well.                                                   */
  548.  
  549.  if (prefeq(p_name,"MENU"         )) {messnum=HL_MEN; matches++;}
  550.  if (prefeq(p_name,"INTRODUCTION" )) {messnum=HL_INT; matches++;}
  551.  if (prefeq(p_name,"OPTIONS"      )) {messnum=HL_OPT; matches++;}
  552.  if (prefeq(p_name,"DEFOPTIONS"   )) {messnum=HL_DOP; matches++;}
  553.  if (prefeq(p_name,"COMMANDS"     )) {messnum=HL_COM; matches++;}
  554.  if (prefeq(p_name,"DOCUMENTATION")) {messnum=HL_DOC; matches++;}
  555.  if (prefeq(p_name,"REGISTRATION" )) {messnum=HL_REG; matches++;}
  556.  if (prefeq(p_name,"LICENSE"      )) {messnum=HL_GNU; matches++;}
  557.  if (prefeq(p_name,"COPYRIGHT"    )) {messnum=HL_COP; matches++;}
  558.  if (prefeq(p_name,"NOWARRANTY"   )) {messnum=HL_NOW; matches++;}
  559.  if (prefeq(p_name,"DISTRIBUTION" )) {messnum=HL_DIS; matches++;}
  560.  if (prefeq(p_name,"ACKNOWLEDGE"  )) {messnum=HL_ACK; matches++;}
  561.  if (prefeq(p_name,"VERSIONS"     )) {messnum=HL_VER; matches++;}
  562.  if (prefeq(p_name,"SUPPORT"      )) {messnum=HL_SUP; matches++;}
  563.  if (prefeq(p_name,"MODIFICATION" )) {messnum=HL_MOD; matches++;}
  564.  
  565.  if (matches != 1) return HL_ERR;
  566.  
  567.  return messnum;
  568. }
  569.  
  570. /******************************************************************************/
  571.  
  572. EXPORT void hel_wri (p_outf,messno)
  573. void (*p_outf) P_((char *));
  574. uword messno;
  575. {
  576.  as_cold(     1 <= messno, "hel_wri: Message number is zero.");
  577.  as_cold(messno <= HL_MAX, "hel_wri: Message number is greater than HL_MAX.");
  578.  
  579.  /* Set the global output function pointer. */
  580.  pf=p_outf;
  581.  
  582.  switch(messno)
  583.    {
  584.     case HL_MEN: hel_men(); break;
  585.     case HL_INT: hel_int(); break;
  586.     case HL_OPT: hel_opt(); break;
  587.     case HL_DOP: hel_dop(); break;
  588.     case HL_COM: hel_com(); break;
  589.     case HL_DOC: hel_doc(); break;
  590.     case HL_REG: hel_reg(); break;
  591.     case HL_GNU: hel_gnu(p_outf); break; /* Calling another module. */
  592.     case HL_COP: hel_cop(); break;
  593.     case HL_NOW: hel_now(); break;
  594.     case HL_DIS: hel_dis(); break;
  595.     case HL_ACK: hel_ack(); break;
  596.     case HL_VER: hel_ver(); break;
  597.     case HL_SUP: hel_sup(); break;
  598.     case HL_MOD: hel_mod(); break;
  599.     default    : as_bomb("hel_wri: switch defaulted.");
  600.    }
  601. }
  602.  
  603. /******************************************************************************/
  604. /*                               End of HELP.C                                */
  605. /******************************************************************************/
  606.