Fix some cleanall issues
[mirror_edk2.git] / Tools / Source / TianoTools / Pccts / dlg / dlg.1
1 .TH dlg 1 "April 1994" "DLG" "PCCTS Manual Pages"
2 .SH NAME
3 dlg \- DFA Lexical Analyzer Generator
4 .SH SYNTAX
5 .LP
6 \fBdlg\fR [\fIoptions\fR] \fIlexical_spec\fR [\fIoutput_file\fR]
7 .SH DESCRIPTION
8 .B dlg
9 is a tool that produces fast deterministic finite automata for recognizing
10 regular expressions in input.
11 .SH OPTIONS
12 .IP "\fB-CC\fR"
13 Generate C++ output. The \fIoutput_file\fP is not specified in this
14 case.
15 .IP "\fB-C\fR[\fP level\fR]
16 Where \fPlevel\fR is the compression level used. 0 indications no
17 compression, 1 removes all unused characters from the transition from table,
18 and 2 maps equivalent characters into the same character classes. It is
19 suggested that level -C2 is used, since it will significantly reduce the size
20 of the dfa produced for lexical analyzer.
21 .IP "\fB-m\fP
22 Produces the header file for the lexical mode with a name other than
23 the default name of "mode.h".
24 .IP \fB-i\fP
25 An interactive, or as interactive as possible, parser is produced. A character
26 is only obtained when required to decide which state to go to. Some care
27 must be taken to obtain accept states that do not require look ahead at the
28 next character to determine if that is the stop state. Any regular expression
29 with a Kleene closure at the end is guaranteed to require another character
30 of look ahead.
31 .IP "\fB-cl\fP class
32 Specify a class name for DLG to generate. The default is DLGLexer.
33 'class' will be a subclass of DLGLexerBase; only used for -CC.
34 .IP \fB-ci\fP
35 The automaton will treat upper and lower case characters identically.
36 This is accomplished in the automaton; the characters in the lexical
37 buffer are unmodified.
38 .IP \fB-cs\fP
39 Upper and lower case characters are treated as distinct. This is the
40 default.
41 .IP "\fB-o\fP dir
42 Directory where output files should go (default="."). This is very
43 nice for keeping the source directory clear of ANTLR and DLG spawn.
44 .IP \fB-Wambiguity\fP
45 Warns if more than one regular expression could match the same character
46 sequence. The warnings give the numbers of the expressions in the dlg
47 lexical specification file. The numbering of the expressions starts at one.
48 Multiple warnings may be print for the same expressions.
49 .IP \-
50 Used in place of file names to get input from standard in or send output
51 to standard out.
52 .SH "SPECIAL CONSIDERATIONS"
53 .PP
54 \fIDlg\fP works... we think. There is no implicit guarantee of
55 anything. We reserve no \fBlegal\fP rights to the software known as
56 the Purdue Compiler Construction Tool Set (PCCTS) \(em PCCTS is in the
57 public domain. An individual or company may do whatever they wish
58 with source code distributed with PCCTS or the code generated by
59 PCCTS, including the incorporation of PCCTS, or its output, into
60 commercial software. We encourage users to develop software with
61 PCCTS. However, we do ask that credit is given to us for developing
62 PCCTS. By "credit", we mean that if you incorporate our source code
63 into one of your programs (commercial product, research project, or
64 otherwise) that you acknowledge this fact somewhere in the
65 documentation, research report, etc... If you like PCCTS and have
66 developed a nice tool with the output, please mention that you
67 developed it using PCCTS. As long as these guidelines are followed, we
68 expect to continue enhancing this system and expect to make other
69 tools available as they are completed.
70 .SH FILES
71 .B mode.h
72 ,
73 .B dlgauto.h
74 ,
75 .B dlgdef.h
76 .SH SEE ALSO
77 .BR antlr (1),
78 .BR pccts (1)
79 .SH BUGS