Add in the 1st version of ECP.

[mirror_edk2.git] / EdkCompatibilityPkg / Other / Maintained / Tools / Pccts / README

---------------------------------------------------------------------------------\r
README for pccts 1.33mr20 (Maintenance Release #20) release date 5 August 1999\r
---------------------------------------------------------------------------------\r
\r
                          Parr Research Corporation\r
                                    with\r
                  Purdue University Electrical Engineering\r
                                    and\r
                       University of Minnesota, AHPCRC\r
\r
                                Terence Parr\r
                                Russell Quong\r
                                 Will Cohen\r
                                 Hank Dietz\r
\r
\r
A central place for information about PCCTS 1.33 is:\r
\r
        http://www.polhode.com/pccts.html\r
\r
The maintenance release is available from:\r
\r
        http://www.polhode.com/pccts133mr.zip\r
\r
There is a ready-to-run version for win32 for Microsoft Visual Studio\r
at the same site.  It is available from:\r
\r
        http://www.polhode.com/win32.zip\r
\r
There is a newsgroup dedicated to pccts 1.33 and related topics:\r
\r
        comp.compilers.tools.pccts\r
\r
You may also want to register for the antlr-interest mailing list\r
which is provided gratis by the following service:\r
\r
        http://www.onesite.com\r
\r
New users should visit http://www.polhode.com/pccts.html in\r
order to get the following document:\r
\r
        "Notes For New Users of PCCTS"\r
\r
This is a Postscript file of about 40 pages which is extremely \r
useful for someone starting out. It is a based on 1.33mr7 so is a\r
little bit out-of-date.  The section on semantic predicates is\r
very out of date, but I have not had time to revise it.\r
\r
When you have a little more experience, be sure to review the\r
following documents in the distribution kit:\r
\r
            CHANGES_FROM_133.txt\r
            CHANGES_FROM_133_BEFORE_MR13.txt\r
            KNOWN_PROBLEMS.txt\r
\r
-------------------------------------------------------------------------\r
                      INSTALLATION (Unix)\r
-------------------------------------------------------------------------\r
0. Download http://www.polhode.com/pccts133mr.zip\r
\r
1. Unzip the distribution kit to your preferred location.\r
\r
2. cd to the main pccts directory.\r
\r
3. make\r
\r
   This will create:\r
\r
        antlr.exe\r
        dlg.exe\r
        sorcerer.exe\r
        genmk.exe\r
\r
4. Add pccts/bin to your path.\r
\r
5. To get an up-to-date list of program options execute the\r
   program with no command line options.  To get up-to-date\r
   documentation read CHANGES_FROM_133*.txt and KNOWN_PROBLEMS.txt\r
   at:\r
\r
           http://www.polhode.com/pccts.html.\r
\r
6. You need not create a library.  The makefile created by genmk\r
   assumes that the files are not part of a library. \r
\r
   If you wish to create a library from elements of pccts/h:\r
\r
   If the first letter of the filename is lowercase (uppercase) it is\r
   related to the code generated using the pccts C mode (C++ mode).\r
   Some of the .c and .cpp files in the h directory are not meant to\r
   be placed in a library and will not compile because they are meant\r
   to be #include in pccts generated files which are grammar specific.\r
\r
   For C++ users place the following elements in the library:\r
\r
        AParser.cpp\r
        ASTBase.cpp\r
        ATokenBuffer.cpp\r
        BufFileInput.cpp (optional)\r
        DLexerBase.cpp\r
        PCCTSAST.cpp\r
        SList.cpp\r
\r
-------------------------------------------------------------------------\r
                    INSTALLATION (Win32)\r
-------------------------------------------------------------------------\r
\r
I've tried to keep the win32 kit to the minimum necessary to get \r
up and running.  The complete kit contains additional information\r
(some historical), source code, and DevStudio projects for \r
rebuilding pccts from the source code.\r
\r
The kit is now distributed with both MSVC 5 and MSVC6 style projects.\r
\r
0. Download http://www.polhode.com/win32.zip.\r
\r
   You may also wish to download:\r
\r
        http://www.polhode.com/CHANGES_FROM_133.txt\r
        http://www.polhode.com/CHANGES_FROM_133_BEFORE_MR13.txt\r
        http://www.polhode.com/KNOWN_PROBLEMS.txt\r
\r
1. Unzip the distribution kit to your preferred location.\r
\r
   This will create:\r
\r
         a pccts directory tree\r
            pccts/bin/*.exe\r
            pccts/lib/*.lib\r
            pccts/h/*\r
            sorcerer/lib/*\r
            sorcerer/h/*\r
\r
         an example directory tree\r
            example\calcAST\*\r
            example\simple\*\r
\r
2. Define the environment variable PCCTS to point to the main\r
   pccts directory.\r
\r
3. Try building the simple project: example\simple\simple50.dsw\r
   or simple60.dsw.\r
\r
4. Try building the complex project: example\calcAST\calcAST50.dsw\r
   or calcAST60.dsw.\r
\r
-------------------------------------------------------------------------\r
                      INSTALLATION (DEC/VMS)\r
-------------------------------------------------------------------------\r
\r