summaryrefslogtreecommitdiff
path: root/BaseTools/Source/C/VfrCompile/Pccts/README
blob: d089b638b4c9edd025f314330131b65d17d37e30 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

                          Parr Research Corporation
                                    with
                  Purdue University Electrical Engineering
                                    and
                       University of Minnesota, AHPCRC

                                Terence Parr
                                Russell Quong
                                 Will Cohen
                                 Hank Dietz


A central place for information about PCCTS 1.33 is:

        http://www.polhode.com/pccts.html

The maintenance release is available from:

        http://www.polhode.com/pccts133mr.zip

There is a ready-to-run version for win32 for Microsoft Visual Studio
at the same site.  It is available from:

        http://www.polhode.com/win32.zip

New users should visit http://www.polhode.com/pccts.html in
order to get the following document:

        "Notes For New Users of PCCTS"

This is a Postscript file of about 40 pages which is extremely 
useful for someone starting out. It is a based on 1.33mr21

When you have a little more experience, be sure to review the
following documents in the distribution kit:

            CHANGES_FROM_133.txt
            CHANGES_FROM_133_BEFORE_MR13.txt
            KNOWN_PROBLEMS.txt

-------------------------------------------------------------------------
                      INSTALLATION (Unix)
-------------------------------------------------------------------------
0. Download http://www.polhode.com/pccts133mr.zip

1. Unzip the distribution kit to your preferred location.  
   If there are newline problems try using zip -a ...

2. cd to the main pccts directory.

3. make

   This will create:

        antlr
        dlg
        sorcerer
        genmk

4. Copy to /usr/local/bin or /usr/local/bin if you like.  If you
   don't wish to then add pccts/bin to your path.

5. To get an up-to-date list of program options execute the
   program with no command line options.  To get up-to-date
   documentation read CHANGES_FROM_133*.txt and KNOWN_PROBLEMS.txt
   at:

           http://www.polhode.com/pccts.html

6. You need not create a library.  The makefile created by genmk
   assumes that the files are not part of a library. 

   If you wish to create a library from elements of pccts/h:

   If the first letter of the filename is lowercase (uppercase) it is
   related to the code generated using the pccts C mode (C++ mode).
   Some of the .c and .cpp files in the h directory are not meant to
   be placed in a library and will not compile because they are meant
   to be #include in pccts generated files which are grammar specific.

   For C++ users place the following elements in the library:

        AParser.cpp
        ASTBase.cpp
        ATokenBuffer.cpp
        BufFileInput.cpp (optional)
        DLexerBase.cpp
        PCCTSAST.cpp
        SList.cpp

-------------------------------------------------------------------------
                    INSTALLATION (Win32)
-------------------------------------------------------------------------

I've tried to keep the win32 kit to the minimum necessary to get 
up and running.  The complete kit contains additional information
(some historical), source code, and DevStudio projects for 
rebuilding pccts from the source code.

The kit is now distributed with both MSVC 5 and MSVC6 style projects.

0. Download http://www.polhode.com/win32.zip.

   You may also wish to download:

        http://www.polhode.com/CHANGES_FROM_133.txt
        http://www.polhode.com/CHANGES_FROM_133_BEFORE_MR13.txt
        http://www.polhode.com/KNOWN_PROBLEMS.txt

1. Unzip the distribution kit to your preferred location.

   This will create:

         a pccts directory tree
            pccts/bin/*.exe
            pccts/lib/*.lib
            pccts/h/*
            sorcerer/lib/*
            sorcerer/h/*

         an example directory tree
            pccts\example\calcAST\*
            pccts\example\simple\*

2. Define the environment variable PCCTS to point to the main
   pccts directory.

3. Try building the simple project: pccts\example\simple\simple50.dsw
   or simple60.dsw.

4. Try building the complex project: pccts\example\calcAST\calcAST50.dsw
   or calcAST60.dsw.

-------------------------------------------------------------------------
                      INSTALLATION (DEC/VMS)
-------------------------------------------------------------------------

DEC/VMS support added by Piéronne Jean-François (jfp@altavista.net)

0. Download http://www.polhode.com/pccts133mr.zip

1. Unzip the distribution kit to your preferred location.

2. set default to the main pccts directory.

3. @makefile.vms

   This will create in directory [.bin]:

        antlr.exe
        dlg.exe
        sorcerer.exe
        genmk.exe

5. To get an up-to-date list of program options execute the
   program with no command line options.  To get up-to-date
   documentation read CHANGES_FROM_133*.txt and KNOWN_PROBLEMS.txt
   at http://www.polhode.com/pccts.html.