tools/README: Finishing up the repeats commentary.
[dwarf-doc.git] / dwarf5 / tools / README
1 These tools are intended to help updating the latex
2 source of a DWARF document to get its references
3 complete and correct.
4 A list of the python source files with the purpose
5 of each is near the end of this FILE.
6
7 BASIC CHECKS:
8 One way to do a spell check on the final document,
9 and to get a simple text output to look for word repeats
10 is to do the following (assuming you have the necessary
11 tools):
12    # -enc Latin1 to avoid utf8, we do not need utf8 here.
13    pdftotext -enc Latin1 dwarf5.pdf
14    # Now you have dwarf5.txt
15    # The _ are not understood by spell
16    sed -e 's/_//g' <dwarf5.txt >dwarf5.txt2
17    # Let upper and lower case compare equal
18    spell dwarf5.txt2 |sort -f |uniq -i
19
20 Once you have dwarf5.txt, the following script and tool
21 will look for repeated words and short phrases, something
22 that can creep in via typos or by accidents of latex use:
23 We use several lines to keep the lines short here.
24 This is more than a little sloppy and repeats.py
25 is not very powerful. But it seems potentially useful.
26    pdftotext -enc Latin1 dwarf5.pdf
27    # Strip out some characters
28    sed -e 's/:/ /g' <../latexdoc/dwarf5.txt >junk.txt
29    sed -e 's/,/ /g' -e 's/;/ /g' <junk.txt >junk2.txt
30    sed -e 's/:/ /g' <junk2.txt >junk3.txt
31    sed -e 's/(/ /g' -e 's/)/ /g' -e 's/[.]/ /g'  <junk3.txt >junk4.txt
32    # Look for 1-word repeated in a 2-word window
33    python repeats.py 2 1 junk4.txt
34    # Look for 2 words repeated in a 4-word window
35    python repeats.py 4 2 junk4.txt
36
37
38
39 CAUTION: 
40 The tools don't really do parsing and
41 the lexical processing is barely adequate for the task.
42
43 They don't understand the % means 'comment', so avoid
44 comments containing latex code or anything like latex.
45
46 The tools are not necessarily equivalent in what
47 details of input they accept.   For example, 
48 Some will handle  \livelink{chap:DWTAGfoo}{  DW\_TAG\_foo  }
49 (notice the spaces around the DW\_TAG\_foo) and some won't.
50 So use \livelink{chap:DWTAGfoo}{DW\_TAG\_foo} instead with
51 no pointless spaces (or newlines). Then you won't be disappointed.
52
53 The tools assume you use \livelink and other local commands.
54 If you use the native latex equivalent the tools won't understand.
55
56
57 The requirement of the \ before _ in latex is annoying.
58 You can avoid work typing that cruft by just typeing
59 DW_TAG_foo  and running  tohyphen.py on the text, which will
60 turn it into   DW\-\_TAG\-\_foo which is what you want.
61 The hyphens result in nicely formatted lines with line breaks in
62 the DW_* strings, at
63 least in some contexts (but not always).
64
65
66 Various character (% - and more) have special meaning to latex.
67 So just typing them and expecting them to appear in the generated
68 document is going to result in disappointment.  See the use
69 of \dash in the document.
70
71
72 Our fundamental approach is to tokenize the input line-by-line
73 and then use trivial pattern matching to determine what
74 tokens need updating on what lines.  Always trying to ensure
75 that unless we intend to change a line that it is emitted
76 byte-for-byte unchanged.  We change lines (in most cases)
77 by simply inserting new tokens on the line (or possibly
78 inserting characters into a token).
79
80 Because latex names are non-traditional (compared to
81 other languages) we adopt an inefficient but
82 simple scanning and lexing approach.
83
84 BORING DETAILS (you can ignore what follows):
85 Every latex source file is read completely into an dwfile object 
86 which contains a 
87 List of lines
88    each line composed of a list of tokens
89        each token described below.
90
91 If we are writing out updated latex source we want all the
92 unchanged text output to match the input.  No spacing changes
93 and no changes except what the task at hand is to do.
94 So the tokens serve that task.
95
96 For example, one task at hand might be to find every DW_*
97 reference and ensure it is either a link target (livetarg) or a
98 link (livelink), and rewrite any that are neither as a link.
99 (see our latex commands livelink and livetarg in latex source).
100
101
102 Another task at hand might be to take every DW_ and rewrite
103 things like  DW\_AT\_foo as DW\-\_AT\-\_foo  so that latex
104 can hyphenate.
105
106 Sometimes we'll want to read a single latex file, sometimes several of them.
107  
108 If we're reading all the files at once (for some reason) we construct
109 an overall 
110    List of LFile (LFile mentioned above).
111
112
113 TOKENS:
114 This part is idiosyncratic to reflect our other goals.
115
116 INDIVIDUAL TOKEN characters:
117 {
118 }
119 [
120 ]
121 space-character
122 tab-character
123 are individual tokens.
124 All 4 forms (tex, underbar, std, label) are identical.
125
126 The space or tab character is an individual token.
127 All 4 forms (tex, underbar, std, label) are identical.
128
129 We swallow the input linefeed (or CR-LF) on input,
130 it does not appear in the tokens.
131
132 IDENTIFIER:
133 The letters in \-_A-Za-z0-9 allowed in an identifier.
134 An identifier begins with one of _ \ letter and has
135 at least one letter in it.
136 Identifers are held in multiple strings in a token
137         tex:   (meaning with \_ and possibly \-)
138         underbar:  (meaning with \_, no \-)
139         std:   (meaning with _ no \, as in the DWARF std)  
140         label: (meaning with no _ or \ the form used as part of labels )
141
142 OTHER:
143 All other characters are considered letters which are
144 to be reproduced on output.  A glob of such are simply considered
145 a non-identifier single token. 
146 All 4 forms (tex, underbar, std, label) are identical.
147
148
149 Performance:
150 We simply don't care about performance as long as a task takes
151 less than a few minutes. There are only about 70,000 words in a complete
152 document so we ignore efficiency issues.
153
154 SOURCE FILES:
155 The change to internal use of DWTAGfoo etc in the document
156 instead of DW\_AT\_foo (see dwarfnamecmds.tex) 
157 means many of these commands are not as useful
158 as they were originally.  But even so they may form useful
159 examples.
160
161 anylink.py: Looks for designated prefixes like DW_ADDR etc.
162   Used by other code, this was never that useful alone.
163
164 attrlink.py: Uses anylink.py to turn DW_AT_ into \livelink
165
166 copyfile.py: Uses fileio.py to parse and output a .tex file.
167  So we can use diff to verify the result is byte-for-byte
168  identical to the input.
169
170 dellivelink.py: This uses fileio.py and replaces \livelink
171  and \livetarg with \DWXXXyyy per Ron Brender email of
172  Oct 4, 2013. Strives to be idempotent so rerunning
173  produces no further changes.  A few cases not
174  handled perfectly (where a } is at end of line?) 
175  so if needed again could use a bit of fixing.
176  The list of files to process are built into the source,
177  and the list is not totally up to date.
178  The program is obsolete now though, as we
179  use \DW* very differently in the source (from when
180  this was written).
181
182 fileio.py:  Given a list of file (.tex) names, it reads in
183   and tokenizes each file.  Functions here let
184   code eventually write stuff back out (changed or not)
185   but the output file always has a ".out" appended, it won't
186   overwrite the input.
187
188 formlink.py: Using anylink.py, this transforms DW_FORM_ into
189   \livelink and \livetarg.
190
191 printnameswithinteger.py: Identical to dellivelink.py, 
192   so it is horribly misnamed!  This one needs 
193   an input list of files to process supplied on the
194   command line.
195
196
197 printstandard.py:  Print the DW_* entries (and only them)
198   in the files named on the command line
199   one per line.   With any \- or \_ removed.
200   use example:
201   python printstandard.py ../latexdoc/*.tex  |sort|uniq 
202
203 printtokens.py: Reads and tokenizes files named on the command
204   line . Prints the tokenized data.
205   Solely for debugging the tokenizing.
206
207 refclassfixup.py:  Fixes up certain strings
208   (specified in this file) to use \livelink
209
210 removehyphen.py: Turns \-\_ into \_ .
211   This was once a needed task. But run long ago, so
212   This is now a useless bit of code.
213
214 removeutf8.py:  The pdf we started from had
215   various utf-8 characters. These got in the way of
216   our text processing, so this app deleted those.
217   This is now a useless bit of code.
218   
219 taglink.py:  Finds all the instances of DW_TAG_ in 
220   .tex files named on the command line.
221
222 tohyphen.py: The opposite of removehyphen.
223   This is now a useless bit of code.
224
225 uses.py: Looks for duplicate uses and definitions of 
226   latex tags.  
227   This is based on the original approach to naming
228   and linking in .tex, not the
229   latest use using dwarfnamecmds.tex
230   
231
232