EdkCompatibilityPkg/Other/Maintained/Tools/Pccts/README

   1 ---------------------------------------------------------------------------------
   2 README for pccts 1.33mr20 (Maintenance Release #20) release date 5 August 1999
   3 ---------------------------------------------------------------------------------
   4
   5                           Parr Research Corporation
   6                                     with
   7                   Purdue University Electrical Engineering
   8                                     and
   9                        University of Minnesota, AHPCRC
  10
  11                                 Terence Parr
  12                                 Russell Quong
  13                                  Will Cohen
  14                                  Hank Dietz
  15
  16
  17 A central place for information about PCCTS 1.33 is:
  18
  19         http://www.polhode.com/pccts.html
  20
  21 The maintenance release is available from:
  22
  23         http://www.polhode.com/pccts133mr.zip
  24
  25 There is a ready-to-run version for win32 for Microsoft Visual Studio
  26 at the same site.  It is available from:
  27
  28         http://www.polhode.com/win32.zip
  29
  30 There is a newsgroup dedicated to pccts 1.33 and related topics:
  31
  32         comp.compilers.tools.pccts
  33
  34 You may also want to register for the antlr-interest mailing list
  35 which is provided gratis by the following service:
  36
  37         http://www.onesite.com
  38
  39 New users should visit http://www.polhode.com/pccts.html in
  40 order to get the following document:
  41
  42         "Notes For New Users of PCCTS"
  43
  44 This is a Postscript file of about 40 pages which is extremely
  45 useful for someone starting out. It is a based on 1.33mr7 so is a
  46 little bit out-of-date.  The section on semantic predicates is
  47 very out of date, but I have not had time to revise it.
  48
  49 When you have a little more experience, be sure to review the
  50 following documents in the distribution kit:
  51
  52             CHANGES_FROM_133.txt
  53             CHANGES_FROM_133_BEFORE_MR13.txt
  54             KNOWN_PROBLEMS.txt
  55
  56 -------------------------------------------------------------------------
  57                       INSTALLATION (Unix)
  58 -------------------------------------------------------------------------
  59 0. Download http://www.polhode.com/pccts133mr.zip
  60
  61 1. Unzip the distribution kit to your preferred location.
  62
  63 2. cd to the main pccts directory.
  64
  65 3. make
  66
  67    This will create:
  68
  69         antlr.exe
  70         dlg.exe
  71         sorcerer.exe
  72         genmk.exe
  73
  74 4. Add pccts/bin to your path.
  75
  76 5. To get an up-to-date list of program options execute the
  77    program with no command line options.  To get up-to-date
  78    documentation read CHANGES_FROM_133*.txt and KNOWN_PROBLEMS.txt
  79    at:
  80
  81            http://www.polhode.com/pccts.html.
  82
  83 6. You need not create a library.  The makefile created by genmk
  84    assumes that the files are not part of a library.
  85
  86    If you wish to create a library from elements of pccts/h:
  87
  88    If the first letter of the filename is lowercase (uppercase) it is
  89    related to the code generated using the pccts C mode (C++ mode).
  90    Some of the .c and .cpp files in the h directory are not meant to
  91    be placed in a library and will not compile because they are meant
  92    to be #include in pccts generated files which are grammar specific.
  93
  94    For C++ users place the following elements in the library:
  95
  96         AParser.cpp
  97         ASTBase.cpp
  98         ATokenBuffer.cpp
  99         BufFileInput.cpp (optional)
 100         DLexerBase.cpp
 101         PCCTSAST.cpp
 102         SList.cpp
 103
 104 -------------------------------------------------------------------------
 105                     INSTALLATION (Win32)
 106 -------------------------------------------------------------------------
 107
 108 I've tried to keep the win32 kit to the minimum necessary to get
 109 up and running.  The complete kit contains additional information
 110 (some historical), source code, and DevStudio projects for
 111 rebuilding pccts from the source code.
 112
 113 The kit is now distributed with both MSVC 5 and MSVC6 style projects.
 114
 115 0. Download http://www.polhode.com/win32.zip.
 116
 117    You may also wish to download:
 118
 119         http://www.polhode.com/CHANGES_FROM_133.txt
 120         http://www.polhode.com/CHANGES_FROM_133_BEFORE_MR13.txt
 121         http://www.polhode.com/KNOWN_PROBLEMS.txt
 122
 123 1. Unzip the distribution kit to your preferred location.
 124
 125    This will create:
 126
 127          a pccts directory tree
 128             pccts/bin/*.exe
 129             pccts/lib/*.lib
 130             pccts/h/*
 131             sorcerer/lib/*
 132             sorcerer/h/*
 133
 134          an example directory tree
 135             example\calcAST\*
 136             example\simple\*
 137
 138 2. Define the environment variable PCCTS to point to the main
 139    pccts directory.
 140
 141 3. Try building the simple project: example\simple\simple50.dsw
 142    or simple60.dsw.
 143
 144 4. Try building the complex project: example\calcAST\calcAST50.dsw
 145    or calcAST60.dsw.
 146
 147 -------------------------------------------------------------------------
 148                       INSTALLATION (DEC/VMS)
 149 -------------------------------------------------------------------------
 150
 151 DEC/VMS support added by Piéronne Jean-François (jfp@altavista.net)
 152
 153 0. Download http://www.polhode.com/pccts133mr.zip
 154
 155 1. Unzip the distribution kit to your preferred location.
 156
 157 2. set default to the main pccts directory.
 158
 159 3. @makefile.vms
 160
 161    This will create in directory [.bin]:
 162
 163         antlr.exe
 164         dlg.exe
 165         sorcerer.exe
 166         genmk.exe
 167
 168 5. To get an up-to-date list of program options execute the
 169    program with no command line options.  To get up-to-date
 170    documentation read CHANGES_FROM_133*.txt and KNOWN_PROBLEMS.txt
 171    at http://www.polhode.com/pccts.html.