home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / pccts.zip / pccts / README < prev    next >
Text File  |  1994-03-31  |  8KB  |  211 lines
  1.  
  2.                             Welcome to PCCTS 1.20
  3.  
  4.                                  March 1994
  5.  
  6.  
  7.                   Purdue University Electrical Engineering
  8.  
  9.                                 Terence Parr
  10.                                  Will Cohen
  11.                                Russell Quong
  12.                                  Hank Dietz
  13.  
  14.  
  15.                                 INSTALLATION
  16.  
  17.      This document describes the installation of PCCTS 1.20 on UNIX
  18. and non-UNIX machines.  The UNIX installation is trivial while the
  19. non-UNIX folks have a bit more work to do as an install script
  20. explicitly for there machine will not exist--they will have to
  21. interpret the install script.
  22.  
  23.      PCCTS 1.20 includes a number of different programs and examples
  24. in the software release package -- most of which like to live in their
  25. own directories.  The install script will build a standard hierarchy.
  26. Or, if you get the tar file off the ftp site, the hierarchy will be
  27. constructed automatically by tar.
  28.  
  29.      The PCCTS executables (antlr, dlg) may be placed anywhere the user
  30. wishes but the install script places them in the bin directory created
  31. during installation.
  32.  
  33. 1.0.  UNIX USERS
  34.  
  35. This section is for UNIX users and describes the most convenient
  36. installation procedure.
  37.  
  38. 1.1.  FORMAT: pccts.tar
  39.  
  40. To begin installation, place the pccts.tar file into the directory
  41. where you want to place a pccts subdirectory.  Untar the file with
  42.  
  43.      tar xvf pccts.tar
  44.  
  45. and cd into it.  To install PCCTS, simply type
  46.  
  47.      make
  48.  
  49. which will build the standard PCCTS directory hierarchy (under the
  50. directory where you ran the install script) and build executable
  51. versions of antlr and dlg.
  52.  
  53. 1.2.  FORMAT: pccts.bag
  54.  
  55.      To begin installation, the user should create a directory (usually
  56. called pccts) where the PCCTS source subtree is to be created.  Place
  57. the pccts.bag file and the install script into this directory and cd
  58. into it.  To install PCCTS, simply type
  59.  
  60.      sh install
  61.  
  62. which will build the standard PCCTS directory hierarchy (under the
  63. directory where you ran the install script), "unbag" all of the files
  64. and build executable versions of antlr and dlg.
  65.  
  66. 2.0.  NON-UNIX USERS
  67.  
  68.      ANTLR was written using portable (we hope), vanilla K&R-style C,
  69. ANSI C, and C++.  It has been successfully ported to a variety of
  70. environments.  We do not provide an installation script explicitly for
  71. non-Unix users.  You must interpret the install script and perform the
  72. analogous operations on your machine.
  73.  
  74. IMPORTANT NOTE:  You must create the parser.dlg and "touch" scan.c in
  75.                  antlr and dlg directories or the makefiles will try to
  76.                  execute antlr and dlg, which don't exist yet.  The first
  77.                  time, you want only to compile the C files in order to
  78.                  obtain an executable for antlr and dlg.  From this point,
  79.                  a change in antlr.g or dlg_p.g will force antlr/dlg to
  80.                  regenerate themselves.
  81.  
  82. IMPORTANT NOTE:  See the notes about WORD SIZE below.  You MUST
  83.                  "#define PC" for the preprocessor so that the word size
  84.                  will be 16bits for int's IF you have a machine with
  85.                  this size; e.g. a IBM PC clone.  Our antlr and dlg
  86.                  makefiles take care of this for you if you live on
  87.                  a PC.
  88.  
  89.      For Mac programmers using MPW (Macintosh Programmer's Workshop),
  90. an "#ifdef MPW" is included to print error messages that can be
  91. "executed" to highlight the error location.  In other words, the line
  92. in the file where the error occured will be highlighted by hitting
  93. "enter" over the error message.  Add "-d MPW" to your list of compile
  94. flags.  See generic.h in antlr directory.
  95.  
  96. 3.0.  EMAIL VERSION RECIPIENTS
  97.  
  98.      If you received PCCTS via email response from
  99. pccts@ecn.purdue.edu you have one additional installation step to
  100. perform over the ftp folks (and pccts.tar is unavailable).  You will
  101. have received a number of bite-size chunks of pccts which are small
  102. enough to be emailed (~1500 lines each).  You must reconstruct the
  103. PCCTS files before you can begin installation.  In order to rebuild an
  104. original file, you must have "one.c" which will take the chunks and
  105. pack them together.  If you are a non-UNIX type, you must have the
  106. "unbag.c" file which unbags the bags created by our mail archiver.
  107. UNIX folks use the shell to unbag as they would for shar files (this
  108. will be done automatically by the install script).
  109.  
  110.      To install PCCTS, place all PCCTS mail messages into a pccts
  111. directory, remove the mail headers from one.c.  Then compile one.c
  112. with:
  113.  
  114.      cc -o one one.c
  115.  
  116. and then type:
  117.  
  118.      ./one f1 f2 ... fn
  119.  
  120. where f1..fn are the parts of PCCTS source sent as chunks (i.e. these
  121. files will be all the files you received NOT including one.c, unbag.c,
  122. README, install and the request acknowledge banner).  There is no need
  123. to remove mail headers from the chunk files and they may appear in any
  124. order.  The subject line of the mail will identify it as a chunk and a
  125. chunk of what file.  The "one" program should be used to put pccts.bag
  126. back together.  You are now in a position to begin normal PCCTS
  127. installation.  All files you receive should go into a pccts directory.
  128.  
  129.      Note that all files which arrive in "chunks" must be put back
  130. together using "one".  Beware that you do not mix chunks from more
  131. than one original file.  For instance, do not specify all chunks that
  132. you collect from the PCCTS mailbot on the "one" command line unless
  133. you have requested only one original file that was split into multiple
  134. files.  Each chunk knows which original file it is a part of, where it
  135. goes in that file and how many total chunks are required to rebuild
  136. that original.
  137.  
  138. 4.0.  WORD SIZE AND PC USERS
  139.  
  140.      PCCTS makefiles assume 32-bit integers.  If you have 16-bit
  141. integers, you must turn on preprocessor symbol PC to change wordsize
  142. definitions.  You can add another "#ifdef" for your machine or
  143. specific wordsize (see set.h in support/set and output.c in dlg) if
  144. your machine is really weird.  PC users may simple uncomment the
  145. appropriate section of the makefiles for their PC compiler and comment
  146. out the UNIX section.
  147.  
  148.                                 TUTORIAL
  149.  
  150.      The advanced tutorial should be placed in a directory at the
  151. same level as antlr, dlg, support etc...  Do a
  152.  
  153.      sh advtut.bag
  154.  
  155. to unbag (or use the unbag program) and then type
  156.  
  157.      make -s all
  158.  
  159. which will create executables called tut1-tut4.  Naturally, if you got
  160. the tutorials from the ftp site, the tar format of the tutorials can
  161. be obtained for easier installation.
  162.  
  163. Unfortunately, the tutorials have changed little since the 1.06
  164. release.  With luck, these will be enhanced and an AST tutorial will
  165. appear.
  166.  
  167.                               NEW FEATURES
  168.  
  169. o  C++ support
  170.  
  171. o  Token Classes
  172.  
  173. o  Improved genmk program
  174.  
  175. o  Various command-line options
  176.  
  177.  
  178.                          MACHINE COMPATIBILITY
  179.  
  180. PCCTS 1.10 was known to compile "out of the box" on the following
  181. machines and/or operating systems:
  182.  
  183. o  DECSTATION 5000
  184.  
  185. o  SGI, Running IRIX 4.0.5
  186.  
  187. o  Sun SparcStation (cc, gcc, g++, Cfront)
  188.  
  189. o  DOS and OS/2, Microsft C 6.0, 16 bit
  190.  
  191. o  DOS and OS/2, Borland C/C++, 16 bit
  192.  
  193. o  OS/2, IBM C-Set/2, 32 bit
  194.  
  195. o  VAX C under VMS
  196.  
  197. o  Linux SLS 0.99, gcc/g++
  198.  
  199. 1.20 was not tested as exhaustively due to time constraints.  However,
  200. we know it compiles under OS/2 and most UNIX flavors.
  201.  
  202.  
  203.                            INCOMPATIBILITIES
  204.  
  205. Please see the release notes.
  206.  
  207.  
  208.                                 CREDITS
  209.  
  210. Please see the history.ps or history.txt.
  211.