home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / program / funnel / help_gnu.c < prev    next >
Encoding:
C/C++ Source or Header  |  1993-10-23  |  4.9 KB  |  106 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_GNU.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, all the messages in     */
  48. /* this module are represented by code (e.g. as in printf statements).        */
  49. /*                                                                            */
  50. /* There is no difficulty turning a short message into code; simply place it  */
  51. /* in output statements. However, large messages (e.g. the GNU license) are   */
  52. /* more tedious, and also present more of a problem if it is necessary to     */
  53. /* change them substantially at a later date. This problem has been solved in */
  54. /* FunnelWeb by writing a small program that reads a text file and writes out */
  55. /* C code that writes the text file. The files involved are:                  */
  56. /*                                                                            */
  57. /*    help_gnu.mes - The original message.                                    */
  58. /*    help_gnu.c   - C code to write out the original message.                */
  59. /*                                                                            */
  60. /* To turn help_gnu.mes into help_gnu.c, give the following command in        */
  61. /* FunnelWeb interactive mode: codify help_gnu.txt help_gnu.c                 */
  62. /*                                                                            */
  63. /******************************************************************************/
  64.  
  65. #include "style.h"
  66.  
  67. #include "help_gnu.h"
  68.  
  69. /******************************************************************************/
  70.  
  71. /* This module contains many many output statements that call an output       */
  72. /* function. To neaten up all these calls, we define a global variable to     */
  73. /* hold a pointer to the function and simple macro to write output using      */
  74. /* the function.                                                              */
  75. LOCVAR void (*pf) P_((char *));
  76.  
  77. #define WX(STR) (*pf)(STR);(*pf)("\n")
  78. #define WY(STR) (*pf)(STR)
  79.  
  80. /******************************************************************************/
  81.  
  82. EXPORT void hel_gnu (p_outf)
  83. void (*p_outf) P_((char *));
  84. {
  85.  pf=p_outf;
  86.  WY("\n");
  87.  WY("FunnelWeb License\n");
  88.  WY("-----------------\n");
  89.  WY("FunnelWeb is distributed under the following license.\n");
  90.  WY("\n");
  91.  WY("--<Start of GNU License>--\n");
  92. #include "help_gnu.ctx"
  93.  WY("--<End of GNU License>--\n");
  94.  WY("\n");
  95.  WY("If all that scrolled off your screen too quickly, don't worry. You can\n");
  96.  WY("capture this message (or any other FunnelWeb output) in a file by\n");
  97.  WY("specifying the +J option when you invoke FunnelWeb. For example:\n");
  98.  WY("\n");
  99.  WY("       fw +hlicense +jresult.txt\n");
  100.  WY("\n");
  101. }
  102.  
  103. /******************************************************************************/
  104. /*                             End of HELP_GNU.C                              */
  105. /******************************************************************************/
  106.