home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / program / funnel / help.h < prev    next >
Encoding:
C/C++ Source or Header  |  1993-10-23  |  7.9 KB  |  162 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.H                                   */
  40. /******************************************************************************/
  41. /*                                                                            */
  42. /* HELP PACKAGE                                                               */
  43. /* ============                                                               */
  44. /* As I came closer and closer to completing the release version of           */
  45. /* FunnelWeb, I noticed that the online help was a bit of a mess. I had       */
  46. /* random commands and command line options here and there to provide bits of */
  47. /* information. After a close look and some thought, I decided to centralize  */
  48. /* all of FunnelWeb's help messages into one module, and provide a clean and  */
  49. /* consistent interface to the help messages, both in the command line, and   */
  50. /* in interactive mode.                                                       */
  51. /*                                                                            */
  52. /* The result is that all of the help messages have been  moved to            */
  53. /* this module. Each help message has a name consisting of a string. One      */
  54. /* particular message has the name "MENU" and is the root help message (the   */
  55. /* "menu message"). It contains a list of all the help messages available and */
  56. /* their names.                                                               */
  57. /*                                                                            */
  58. /* The command line connects to help by providing a single command line       */
  59. /* option called +Hx which has the effect of displaying the help message      */
  60. /* called x. The default is -Hmenu. The "-" means that help is not invoked by */
  61. /* default, but that if the user specifies +H, the menu message will be       */
  62. /* printed. If the user specifies (say) +Hsloth, message SLOTH will be        */
  63. /* displayed. The menu message is printed if the user invokes FunnelWeb with  */
  64. /* no actions. The +H option is classified as an action option.               */
  65. /*                                                                            */
  66. /* Interactive mode connects to help through the HELP command. In the spirit  */
  67. /* of the command line interface, if no argument is given, the menu message   */
  68. /* is displayed. If an argument is given, the specified message is written    */
  69. /* out.                                                                       */
  70. /*                                                                            */
  71. /* This module contributes two things to this process:                        */
  72. /*    1) Provides a mapping from message names to messages.                   */
  73. /*    2) Acts as a repository for the messages themselves.                    */
  74. /*                                                                            */
  75. /******************************************************************************/
  76.  
  77. /* Ensure that the body of this header file is included at most once.         */
  78. #ifndef DONE_HELP
  79. #define DONE_HELP
  80.  
  81. /******************************************************************************/
  82.  
  83. #include "style.h"
  84.  
  85. /******************************************************************************/
  86.  
  87. /* Place a bound on help name length, and define an array type to hold them.  */
  88. #define HL_NMLEN 20
  89. typedef char hn_t[HL_NMLEN+1];
  90.  
  91. /******************************************************************************/
  92.  
  93. /* Each of the messages has a unique symbol and number. The reason for        */
  94. /* defining these symbols instead of just using the message names in the code */
  95. /* is that doing it this way allows us to change the exact message names      */
  96. /* without having to track down all their occurences in the code, or getting  */
  97. /* nasty surprises later down the track at run time (the compiler will tell   */
  98. /* you in a call containing HL_SLT that the symbol doesn't exist, but it      */
  99. /* won't complain about a string argument that just happens not to be the     */
  100. /* name of a message anymore).                                                */
  101.  
  102. /* HL_ERR is the non-existent message. */
  103. #define HL_ERR 0
  104.  
  105. /* HL_MEN - Help messages.             */
  106. /* HL_INT - Introduction to FunnelWeb. */
  107. /* HL_OPT - Command line options.      */
  108. /* HL_DOP - Option defaults.           */
  109. /* HL_COM - Interactive commands.      */
  110. /* HL_DOC - Documentation.             */
  111. /* HL_REG - Registration.              */
  112. /* HL_LIC - The GNU License.           */
  113. /* HL_COP - Copyright notice.          */
  114. /* HL_NOW - No Warranty notice.        */
  115. /* HL_DIS - Distribution notice.       */
  116. /* HL_ACK - Acknowledgements.          */
  117. /* HL_VER - Versions.                  */
  118. /* HL_SUP - Support.                   */
  119. /* HL_MOD - Modifications.             */
  120. #define HL_MEN  1
  121. #define HL_INT  2
  122. #define HL_OPT  3
  123. #define HL_DOP  4
  124. #define HL_COM  5
  125. #define HL_DOC  6
  126. #define HL_REG  7
  127. #define HL_GNU  8
  128. #define HL_COP  9
  129. #define HL_NOW 10
  130. #define HL_DIS 11
  131. #define HL_ACK 12
  132. #define HL_VER 13
  133. #define HL_SUP 14
  134. #define HL_MOD 15
  135.  
  136. /* The following symbol does not represent a message. It is the number of     */
  137. /* messages. This is useful for range checking and possibly in for loops.     */
  138. #define HL_MAX 15
  139.  
  140. /******************************************************************************/
  141.  
  142. EXPORT uword hel_num P_((char *));
  143. /* Accepts a character string that is supposed to be the name of a message    */
  144. /* and returns the number of the message, or HL_ERR if the string does not    */
  145. /* correspond to any defined message. A match will occur if the argument      */
  146. /* string is the same (with case independent matching) as the prefix (of      */
  147. /* corresponding length) of exactly one message name.                         */
  148.  
  149. EXPORT void hel_wri P_((void (*)(char *),uword));
  150. /* Accepts a message number and writes the message using the function         */
  151. /* provided in the first argument. Bombs the program if the message number in */
  152. /* the second argument is not in the range [1,HL_MAX].                        */
  153.  
  154. /******************************************************************************/
  155.  
  156. /* For #ifndef preventing multiple inclusion of the body of this header file. */
  157. #endif
  158.  
  159. /******************************************************************************/
  160. /*                               End of HELP.H                                */
  161. /******************************************************************************/
  162.