home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / program / funnel / texhead.h < prev    next >
Encoding:
C/C++ Source or Header  |  1993-10-23  |  7.0 KB  |  122 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. /*                                  TEXHEAD.H                                 */
  40. /******************************************************************************/
  41. /*                                                                            */
  42. /* TEX HEADER PACKAGE                                                         */
  43. /* ==================                                                         */
  44. /* This package contains a single function that writes the TeX header         */
  45. /* (containing all the Weave macros) to the specified stream. The package     */
  46. /* consists of:                                                               */
  47. /*                                                                            */
  48. /* texhead.tex - The header file ("source code" for texhead.ctx).             */
  49. /* texhead.ctx - C code automatically generated by texhead.tex.               */
  50. /* texhead.h   - This file, containing a function definition.                 */
  51. /* texhead.c   - Contains a function body.                                    */
  52. /*                                                                            */
  53. /* The first version of FunnelWeb (1986) generated TeX output files that used */
  54. /* a collection of macros to neaten and simplify the bulk of the TeX output   */
  55. /* file. For example, the macro \fwbtx provided a simple way to specify       */
  56. /* verbatim text. This system worked extremely well, the only inconvenience   */
  57. /* being that each FunnelWeb TeX output file had to "\input" the TeX header   */
  58. /* file containing all the macros. At the time, this seemed a sensible        */
  59. /* factorization of the macros, and, within the limited environment in which  */
  60. /* FunnelWeb was operating, worked well.                                      */
  61. /*                                                                            */
  62. /* In NEW, IMPROVED FunnelWeb, "\input"ing the header file has the potential  */
  63. /* to cause lots of problems, the major ones being:                           */
  64. /*                                                                            */
  65. /* - The header file would have to be installed as part of the FunnelWeb      */
  66. /*   system. Currently this means that it would be the ONLY other file        */
  67. /*   necessary apart from the FunnelWeb executable. It would be far more      */
  68. /*   desirable to avoid having to install the header file.                    */
  69. /*                                                                            */
  70. /* - The header file would have to be referred to somehow by the TeX file.    */
  71. /*   As it makes sense to have only one copy of the header file on a machine, */
  72. /*   TeX files would have to refer to that copy. This would require one of a  */
  73. /*   number of messy machine-specific mechanisms such as (VMS) logical name   */
  74. /*   translation or environment variable translation.                         */
  75. /*                                                                            */
  76. /* - TeX files could not be easily moved to other machines (particularly      */
  77. /*   those not running FunnelWeb themselves) without also sending the header  */
  78. /*   file.                                                                    */
  79. /*                                                                            */
  80. /* - If FunnelWeb and the header file were ever jointly modified, the dynamic */
  81. /*   binding of old TeX files would mean that they may no longer be printable.*/
  82. /*                                                                            */
  83. /* For all these reasons, the decision was made to write the library of TeX   */
  84. /* macros at the start of each TeX output file, thus making each TeX output   */
  85. /* file entirely self-contained. To do this, the header file had to be        */
  86. /* converted into a sequence of C output statments. To this end, a new        */
  87. /* FunnelWeb shell command CODIFY was added that performs this transformation.*/
  88. /* CODIFY could have been a separate utility program, but if it was, it might */
  89. /* somehow be separated from the rest of FunnelWeb during distribution. By    */
  90. /* building CODIFY into FunnelWeb itself, this possibility is eliminated.     */
  91. /*                                                                            */
  92. /* This package encapsulates the automatically generated C code. This header  */
  93. /* file defines a function that writes it to a specified stream. The package  */
  94. /* body texhead.c contains the body of the function which consists mainly of  */
  95. /* a #include of the automatically generated C code in texhead.ctx.           */
  96. /*                                                                            */
  97. /******************************************************************************/
  98.  
  99. /* Ensure that the body of this header file is included at most once.         */
  100. #ifndef DONE_TEXH
  101. #define DONE_TEXH
  102.  
  103. /******************************************************************************/
  104.  
  105. #include "style.h"
  106.  
  107. #include "writfile.h"
  108.  
  109. /******************************************************************************/
  110.  
  111. EXPORT void tex_head P_((p_wf_t));
  112. /* Writes the FunnelWeb TeX header block to the argument stream. */
  113.  
  114. /******************************************************************************/
  115.  
  116. /* For #ifndef preventing multiple inclusion of the body of this header file. */
  117. #endif
  118.  
  119. /******************************************************************************/
  120. /*                             End of TEXHEAD.H                               */
  121. /******************************************************************************/
  122.