1 /*************************************************************************/
2 /* bookloupe--check for assorted weirdnesses in a PG candidate text file */
4 /* Copyright 2000-2005 Jim Tinsley <jtinsley@pobox.com> */
5 /* Copyright 2012- J. Ali Harlow <ali@juiblex.co.uk> */
7 /* This program is free software; you can redistribute it and/or modify */
8 /* it under the terms of the GNU General Public License as published by */
9 /* the Free Software Foundation; either version 2 of the License, or */
10 /* (at your option) any later version. */
12 /* This program is distributed in the hope that it will be useful, */
13 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
14 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
15 /* GNU General Public License for more details. */
17 /* You should have received a copy of the GNU General Public License */
18 /* along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 /*************************************************************************/
26 #define MAXWORDLEN 80 /* max length of one word */
27 #define LINEBUFSIZE 2048 /* buffer size for an input line */
29 #define MAX_USER_TYPOS 1000
30 #define USERTYPO_FILE "gutcheck.typ"
33 #define MAX_PATH 16384
36 char aline[LINEBUFSIZE];
37 char prevline[LINEBUFSIZE];
41 "teh", "th", "og", "fi", "ro", "adn", "yuo", "ot", "fo", "thet", "ane",
42 "nad", "te", "ig", "acn", "ahve", "alot", "anbd", "andt", "awya", "aywa",
43 "bakc", "om", "btu", "byt", "cna", "cxan", "coudl", "dont", "didnt",
44 "couldnt", "wouldnt", "doesnt", "shouldnt", "doign", "ehr", "hmi", "hse",
45 "esle", "eyt", "fitrs", "firts", "foudn", "frmo", "fromt", "fwe", "gaurd",
46 "gerat", "goign", "gruop", "haev", "hda", "hearign", "seeign", "sayign",
47 "herat", "hge", "hsa", "hsi", "hte", "htere", "htese", "htey", "htis",
48 "hvae", "hwich", "idae", "ihs", "iits", "int", "iwll", "iwth", "jsut",
49 "loev", "sefl", "myu", "nkow", "nver", "nwe", "nwo", "ocur", "ohter",
50 "omre", "onyl", "otehr", "otu", "owrk", "owuld", "peice", "peices",
51 "peolpe", "peopel", "perhasp", "perhpas", "pleasent", "poeple", "porblem",
52 "porblems", "rwite", "saidt", "saidh", "saids", "seh", "smae", "smoe",
53 "sohw", "stnad", "stopry", "stoyr", "stpo", "tahn", "taht", "tath",
54 "tehy", "tghe", "tghis", "theri", "theyll", "thgat", "thge", "thier",
55 "thna", "thne", "thnig", "thnigs", "thsi", "thsoe", "thta", "timne",
56 "tirne", "tkae", "tthe", "tyhat", "tyhe", "veyr", "vou", "vour", "vrey",
57 "waht", "wasnt", "awtn", "watn", "wehn", "whic", "whcih", "whihc", "whta",
58 "wihch", "wief", "wiht", "witha", "wiull", "wnat", "wnated", "wnats",
59 "woh", "wohle", "wokr", "woudl", "wriet", "wrod", "wroet", "wroking",
60 "wtih", "wuould", "wya", "yera", "yeras", "yersa", "yoiu", "youve",
61 "ytou", "yuor", "abead", "ahle", "ahout", "ahove", "altbough", "balf",
62 "bardly", "bas", "bave", "baving", "bebind", "beld", "belp", "belped",
63 "ber", "bere", "bim", "bis", "bome", "bouse", "bowever", "buge",
64 "dehates", "deht", "han", "hecause", "hecome", "heen", "hefore", "hegan",
65 "hegin", "heing", "helieve", "henefit", "hetter", "hetween", "heyond",
66 "hig", "higber", "huild", "huy", "hy", "jobn", "joh", "meanwbile",
67 "memher", "memhers", "numher", "numhers", "perbaps", "prohlem", "puhlic",
68 "witbout", "arn", "hin", "hirn", "wrok", "wroked", "amd", "aud",
69 "prornise", "prornised", "modem", "bo", "heside", "chapteb", "chaptee",
73 char *usertypo[MAX_USER_TYPOS];
75 /* Common abbreviations and other OK words not to query as typos. */
77 "mr", "mrs", "mss", "mssrs", "ft", "pm", "st", "dr", "hmm", "h'm", "hmmm",
78 "rd", "sh", "br", "pp", "hm", "cf", "jr", "sr", "vs", "lb", "lbs", "ltd",
79 "pompeii","hawaii","hawaiian", "hotbed", "heartbeat", "heartbeats",
80 "outbid", "outbids", "frostbite", "frostbitten", ""
83 /* Common abbreviations that cause otherwise unexplained periods. */
85 "cent", "cents", "viz", "vol", "vols", "vid", "ed", "al", "etc", "op",
86 "cit", "deg", "min", "chap", "oz", "mme", "mlle", "mssrs", ""
90 * Two-Letter combinations that rarely if ever start words,
91 * but are common scannos or otherwise common letter combinations.
94 "hr", "hl", "cb", "sb", "tb", "wb", "tl", "tn", "rn", "lt", "tj", ""
98 * Two-Letter combinations that rarely if ever end words,
99 * but are common scannos or otherwise common letter combinations.
102 "cb", "gb", "pb", "sb", "tb", "wh", "fr", "br", "qu", "tw", "gl", "fl",
103 "sw", "gr", "sl", "cl", "iy", ""
107 "a", "b", "big", "blockquote", "body", "br", "center", "col", "div", "em",
108 "font", "h1", "h2", "h3", "h4", "h5", "h6", "head", "hr", "html", "i",
109 "img", "li", "meta", "ol", "p", "pre", "small", "span", "strong", "sub",
110 "sup", "table", "td", "tfoot", "thead", "title", "tr", "tt", "u", "ul", ""
114 "<sc>", "</sc>", "/*", "*/", "/#", "#/", "/$", "$/", "<tb>", ""
118 "the", "it's", "their", "an", "mrs", "a", "our", "that's", "its", "whose",
119 "every", "i'll", "your", "my", "mr", "mrs", "mss", "mssrs", "ft", "pm",
120 "st", "dr", "rd", "pp", "cf", "jr", "sr", "vs", "lb", "lbs", "ltd", "i'm",
121 "during", "let", "toward", "among", ""
125 "every", "i'm", "during", "that's", "their", "your", "our", "my", "or",
126 "and", "but", "as", "if", "the", "its", "it's", "until", "than", "whether",
127 "i'll", "whose", "who", "because", "when", "let", "till", "very", "an",
128 "among", "those", "into", "whom", "having", "thence", ""
131 char vowels[] = "aeiouàáâãäæèéêëìíîïòóôõöùúûü";
138 "&", "&", "&",
139 "<", "<", "<",
140 ">", ">", ">",
141 "°", "°", " degrees",
142 "£", "£", "L",
143 """, """, "\"", /* quotation mark = APL quote */
144 "Œ", "Œ", "OE", /* latin capital ligature OE */
145 "œ", "œ", "oe", /* latin small ligature oe */
146 "Š", "Š", "S", /* latin capital letter S with caron */
147 "š", "š", "s", /* latin small letter s with caron */
148 "Ÿ", "Ÿ", "Y", /* latin capital letter Y with diaeresis */
149 "ˆ", "ˆ", "", /* modifier letter circumflex accent */
150 "˜", "˜", "~", /* small tilde, U+02DC ISOdia */
151 " ", " ", " ", /* en space, U+2002 ISOpub */
152 " ", " ", " ", /* em space, U+2003 ISOpub */
153 " ", " ", " ", /* thin space, U+2009 ISOpub */
154 "–", "–", "-", /* en dash, U+2013 ISOpub */
155 "—", "—", "--", /* em dash, U+2014 ISOpub */
156 "’", "’", "'", /* right single quotation mark */
157 "‚", "‚", "'", /* single low-9 quotation mark */
158 "“", "“", "\"", /* left double quotation mark */
159 "”", "”", "\"", /* right double quotation mark */
160 "„", "„", "\"", /* double low-9 quotation mark */
161 "‹", "‹", "\"", /* single left-pointing angle quotation mark */
162 "›", "›", "\"", /* single right-pointing angle quotation mark */
163 " ", " ", " ", /* no-break space = non-breaking space, */
164 "¡", "¡", "!", /* inverted exclamation mark */
165 "¢", "¢", "c", /* cent sign */
166 "£", "£", "L", /* pound sign */
167 "¤", "¤", "$", /* currency sign */
168 "¥", "¥", "Y", /* yen sign = yuan sign */
169 "§", "§", "--", /* section sign */
170 "¨", "¨", " ", /* diaeresis = spacing diaeresis */
171 "©", "©", "(C) ", /* copyright sign */
172 "ª", "ª", " ", /* feminine ordinal indicator */
173 "«", "«", "\"", /* left-pointing double angle quotation mark */
174 "­", "­", "-", /* soft hyphen = discretionary hyphen */
175 "®", "®", "(R) ", /* registered sign = registered trade mark sign */
176 "¯", "¯", " ", /* macron = spacing macron = overline */
177 "°", "°", " degrees", /* degree sign */
178 "±", "±", "+-", /* plus-minus sign = plus-or-minus sign */
179 "²", "²", "2", /* superscript two = superscript digit two */
180 "³", "³", "3", /* superscript three = superscript digit three */
181 "´", "´", " ", /* acute accent = spacing acute */
182 "µ", "µ", "m", /* micro sign */
183 "¶", "¶", "--", /* pilcrow sign = paragraph sign */
184 "¸", "¸", " ", /* cedilla = spacing cedilla */
185 "¹", "¹", "1", /* superscript one = superscript digit one */
186 "º", "º", " ", /* masculine ordinal indicator */
187 "»", "»", "\"", /* right-pointing double angle quotation mark */
188 "¼", "¼", "1/4", /* vulgar fraction one quarter */
189 "½", "½", "1/2", /* vulgar fraction one half */
190 "¾", "¾", "3/4", /* vulgar fraction three quarters */
191 "¿", "¿", "?", /* inverted question mark */
192 "À", "À", "A", /* latin capital letter A with grave */
193 "Á", "Á", "A", /* latin capital letter A with acute */
194 "Â", "Â", "A", /* latin capital letter A with circumflex */
195 "Ã", "Ã", "A", /* latin capital letter A with tilde */
196 "Ä", "Ä", "A", /* latin capital letter A with diaeresis */
197 "Å", "Å", "A", /* latin capital letter A with ring above */
198 "Æ", "Æ", "AE", /* latin capital letter AE */
199 "Ç", "Ç", "C", /* latin capital letter C with cedilla */
200 "È", "È", "E", /* latin capital letter E with grave */
201 "É", "É", "E", /* latin capital letter E with acute */
202 "Ê", "Ê", "E", /* latin capital letter E with circumflex */
203 "Ë", "Ë", "E", /* latin capital letter E with diaeresis */
204 "Ì", "Ì", "I", /* latin capital letter I with grave */
205 "Í", "Í", "I", /* latin capital letter I with acute */
206 "Î", "Î", "I", /* latin capital letter I with circumflex */
207 "Ï", "Ï", "I", /* latin capital letter I with diaeresis */
208 "Ð", "Ð", "E", /* latin capital letter ETH */
209 "Ñ", "Ñ", "N", /* latin capital letter N with tilde */
210 "Ò", "Ò", "O", /* latin capital letter O with grave */
211 "Ó", "Ó", "O", /* latin capital letter O with acute */
212 "Ô", "Ô", "O", /* latin capital letter O with circumflex */
213 "Õ", "Õ", "O", /* latin capital letter O with tilde */
214 "Ö", "Ö", "O", /* latin capital letter O with diaeresis */
215 "×", "×", "*", /* multiplication sign */
216 "Ø", "Ø", "O", /* latin capital letter O with stroke */
217 "Ù", "Ù", "U", /* latin capital letter U with grave */
218 "Ú", "Ú", "U", /* latin capital letter U with acute */
219 "Û", "Û", "U", /* latin capital letter U with circumflex */
220 "Ü", "Ü", "U", /* latin capital letter U with diaeresis */
221 "Ý", "Ý", "Y", /* latin capital letter Y with acute */
222 "Þ", "Þ", "TH", /* latin capital letter THORN */
223 "ß", "ß", "sz", /* latin small letter sharp s = ess-zed */
224 "à", "à", "a", /* latin small letter a with grave */
225 "á", "á", "a", /* latin small letter a with acute */
226 "â", "â", "a", /* latin small letter a with circumflex */
227 "ã", "ã", "a", /* latin small letter a with tilde */
228 "ä", "ä", "a", /* latin small letter a with diaeresis */
229 "å", "å", "a", /* latin small letter a with ring above */
230 "æ", "æ", "ae", /* latin small letter ae */
231 "ç", "ç", "c", /* latin small letter c with cedilla */
232 "è", "è", "e", /* latin small letter e with grave */
233 "é", "é", "e", /* latin small letter e with acute */
234 "ê", "ê", "e", /* latin small letter e with circumflex */
235 "ë", "ë", "e", /* latin small letter e with diaeresis */
236 "ì", "ì", "i", /* latin small letter i with grave */
237 "í", "í", "i", /* latin small letter i with acute */
238 "î", "î", "i", /* latin small letter i with circumflex */
239 "ï", "ï", "i", /* latin small letter i with diaeresis */
240 "ð", "ð", "eth", /* latin small letter eth */
241 "ñ", "ñ", "n", /* latin small letter n with tilde */
242 "ò", "ò", "o", /* latin small letter o with grave */
243 "ó", "ó", "o", /* latin small letter o with acute */
244 "ô", "ô", "o", /* latin small letter o with circumflex */
245 "õ", "õ", "o", /* latin small letter o with tilde */
246 "ö", "ö", "o", /* latin small letter o with diaeresis */
247 "÷", "÷", "/", /* division sign */
248 "ø", "ø", "o", /* latin small letter o with stroke */
249 "ù", "ù", "u", /* latin small letter u with grave */
250 "ú", "ú", "u", /* latin small letter u with acute */
251 "û", "û", "u", /* latin small letter u with circumflex */
252 "ü", "ü", "u", /* latin small letter u with diaeresis */
253 "ý", "ý", "y", /* latin small letter y with acute */
254 "þ", "þ", "th", /* latin small letter thorn */
255 "ÿ", "ÿ", "y", /* latin small letter y with diaeresis */
259 /* special characters */
260 #define CHAR_SPACE 32
264 #define CHAR_DQUOTE 34
265 #define CHAR_SQUOTE 39
266 #define CHAR_OPEN_SQUOTE 96
267 #define CHAR_TILDE 126
268 #define CHAR_ASTERISK 42
269 #define CHAR_FORESLASH 47
270 #define CHAR_CARAT 94
272 #define CHAR_UNDERSCORE '_'
273 #define CHAR_OPEN_CBRACK '{'
274 #define CHAR_CLOSE_CBRACK '}'
275 #define CHAR_OPEN_RBRACK '('
276 #define CHAR_CLOSE_RBRACK ')'
277 #define CHAR_OPEN_SBRACK '['
278 #define CHAR_CLOSE_SBRACK ']'
280 /* longest and shortest normal PG line lengths */
281 #define LONGEST_PG_LINE 75
282 #define WAY_TOO_LONG 80
283 #define SHORTEST_PG_LINE 55
285 #define SWITCHES "ESTPXLOYHWVMUD" /* switches:- */
286 /* D - ignore DP-specific markup */
287 /* E - echo queried line */
288 /* S - check single quotes */
289 /* T - check common typos */
290 /* P - require closure of quotes on */
291 /* every paragraph */
292 /* X - "Trust no one" :-) Paranoid! */
293 /* Queries everything */
294 /* L - line end checking defaults on */
295 /* -L turns it off */
296 /* O - overview. Just shows counts. */
297 /* Y - puts errors to stdout */
298 /* instead of stderr */
299 /* H - Echoes header fields */
300 /* M - Ignore markup in < > */
301 /* U - Use file of User-defined Typos*/
302 /* W - Defaults for use on Web upload*/
303 /* V - Verbose - list EVERYTHING! */
304 #define SWITNO 14 /* max number of switch parms */
305 /* - used for defining array-size */
306 #define MINARGS 1 /* minimum no of args excl switches */
307 #define MAXARGS 1 /* maximum no of args excl switches */
309 int pswit[SWITNO]; /* program switches set by SWITCHES */
311 #define ECHO_SWITCH 0
312 #define SQUOTE_SWITCH 1
313 #define TYPO_SWITCH 2
314 #define QPARA_SWITCH 3
315 #define PARANOID_SWITCH 4
316 #define LINE_END_SWITCH 5
317 #define OVERVIEW_SWITCH 6
318 #define STDOUT_SWITCH 7
319 #define HEADER_SWITCH 8
321 #define VERBOSE_SWITCH 10
322 #define MARKUP_SWITCH 11
323 #define USERTYPO_SWITCH 12
326 long cnt_dquot; /* for overview mode, count of doublequote queries */
327 long cnt_squot; /* for overview mode, count of singlequote queries */
328 long cnt_brack; /* for overview mode, count of brackets queries */
329 long cnt_bin; /* for overview mode, count of non-ASCII queries */
330 long cnt_odd; /* for overview mode, count of odd character queries */
331 long cnt_long; /* for overview mode, count of long line errors */
332 long cnt_short; /* for overview mode, count of short line queries */
333 long cnt_punct; /* for overview mode, count of punctuation and spacing queries */
334 long cnt_dash; /* for overview mode, count of dash-related queries */
335 long cnt_word; /* for overview mode, count of word queries */
336 long cnt_html; /* for overview mode, count of html queries */
337 long cnt_lineend; /* for overview mode, count of line-end queries */
338 long cnt_spacend; /* count of lines with space at end */
339 long linecnt; /* count of total lines in the file */
340 long checked_linecnt; /* count of lines actually checked */
343 void procfile(char *);
345 #define LOW_THRESHOLD 0
346 #define HIGH_THRESHOLD 1
352 #define FIRST_OF_PAIR 0
353 #define SECOND_OF_PAIR 1
355 #define MAX_WORDPAIR 1000
357 char running_from[MAX_PATH];
359 int mixdigit(char *);
360 const char *getaword(const char *,char *);
361 int matchword(char *,char *);
362 char *flgets(char *,int,FILE *,long);
363 void lowerit(char *);
364 int gcisalpha(unsigned char);
365 int gcisdigit(unsigned char);
366 int gcisletter(unsigned char);
367 char *gcstrchr(char *s,char c);
368 void postprocess_for_HTML(char *);
369 char *linehasmarkup(char *);
370 char *losemarkup(char *);
371 int tagcomp(char *,char *);
372 char *loseentities(char *);
375 void postprocess_for_DP(char *);
377 char wrk[LINEBUFSIZE];
380 #define MAX_QWORD_LENGTH 40
381 char qword[MAX_QWORD][MAX_QWORD_LENGTH];
382 signed int dupcnt[MAX_QWORD];
384 int main(int argc,char **argv)
388 char usertypo_file[MAX_PATH];
390 if (strlen(argv[0])<sizeof(running_from))
391 /* save the path to the executable */
392 strcpy(running_from,argv[0]);
393 /* find out what directory we're running from */
394 s=running_from+strlen(running_from);
395 for (;*s!='/' && *s!='\\' && s>=running_from;s--)
397 switno=strlen(SWITCHES);
398 for (i=switno;--i>0;)
399 pswit[i]=0; /* initialise switches */
401 * Standard loop to extract switches.
402 * When we come out of this loop, the arguments will be
403 * in argv[0] upwards and the switches used will be
404 * represented by their equivalent elements in pswit[]
406 while (--argc>0 && **++argv=='-')
407 for (argsw=argv[0]+1;*argsw!='\0';argsw++)
408 for (i=switno,invarg=1;(--i>=0) && invarg==1;)
409 if ((toupper(*argsw))==SWITCHES[i])
414 /* Paranoid checking is turned OFF, not on, by its switch */
415 pswit[PARANOID_SWITCH]^=1;
416 if (pswit[PARANOID_SWITCH])
417 /* if running in paranoid mode force typo checks as well */
418 pswit[TYPO_SWITCH]=pswit[TYPO_SWITCH]^1;
419 /* Line-end checking is turned OFF, not on, by its switch */
420 pswit[LINE_END_SWITCH]^=1;
421 /* Echoing is turned OFF, not on, by its switch */
422 pswit[ECHO_SWITCH]^=1;
423 if (pswit[OVERVIEW_SWITCH])
424 /* just print summary; don't echo */
425 pswit[ECHO_SWITCH]=0;
427 * Web uploads - for the moment, this is really just a placeholder
428 * until we decide what processing we really want to do on web uploads
430 if (pswit[WEB_SWITCH])
432 /* specific override for web uploads */
433 pswit[ECHO_SWITCH]=1;
434 pswit[SQUOTE_SWITCH]=0;
435 pswit[TYPO_SWITCH]=1;
436 pswit[QPARA_SWITCH]=0;
437 pswit[PARANOID_SWITCH]=1;
438 pswit[LINE_END_SWITCH]=0;
439 pswit[OVERVIEW_SWITCH]=0;
440 pswit[STDOUT_SWITCH]=0;
441 pswit[HEADER_SWITCH]=1;
442 pswit[VERBOSE_SWITCH]=0;
443 pswit[MARKUP_SWITCH]=0;
444 pswit[USERTYPO_SWITCH]=0;
447 if (argc<MINARGS || argc>MAXARGS)
449 /* check number of args */
453 /* read in the user-defined stealth scanno list */
454 if (pswit[USERTYPO_SWITCH])
456 /* ... we were told we had one! */
457 usertypofile=fopen(USERTYPO_FILE,"rb");
460 /* not in cwd. try excuteable directory. */
461 strcpy(usertypo_file,running_from);
462 strcat(usertypo_file,USERTYPO_FILE);
463 usertypofile=fopen(usertypo_file,"rb");
465 /* we ain't got no user typo file! */
466 printf(" --> I couldn't find gutcheck.typ "
467 "-- proceeding without user typos.\n");
473 /* we managed to open a User Typo File! */
474 if (pswit[USERTYPO_SWITCH])
476 while (flgets(aline,LINEBUFSIZE-1,usertypofile,
477 (long)usertypo_count))
483 s=malloc(strlen(aline)+1);
486 fprintf(stderr,"bookloupe: cannot get enough "
487 "memory for user typo file!\n");
491 usertypo[usertypo_count]=s;
493 if (usertypo_count>=MAX_USER_TYPOS)
495 printf(" --> Only %d user-defined typos "
496 "allowed: ignoring the rest\n",
504 fclose(usertypofile);
507 fprintf(stderr,"bookloupe: Check and report on an e-text\n");
508 cnt_dquot=cnt_squot=cnt_brack=cnt_bin=cnt_odd=cnt_long=
509 cnt_short=cnt_punct=cnt_dash=cnt_word=cnt_html=cnt_lineend=
512 if (pswit[OVERVIEW_SWITCH])
514 printf(" Checked %ld lines of %ld (head+foot = %ld)\n\n",
515 checked_linecnt,linecnt,linecnt-checked_linecnt);
516 printf(" --------------- Queries found --------------\n");
518 printf(" Long lines: %14ld\n",cnt_long);
520 printf(" Short lines: %14ld\n",cnt_short);
522 printf(" Line-end problems: %14ld\n",cnt_lineend);
524 printf(" Common typos: %14ld\n",cnt_word);
526 printf(" Unmatched quotes: %14ld\n",cnt_dquot);
528 printf(" Unmatched SingleQuotes: %14ld\n",cnt_squot);
530 printf(" Unmatched brackets: %14ld\n",cnt_brack);
532 printf(" Non-ASCII characters: %14ld\n",cnt_bin);
534 printf(" Proofing characters: %14ld\n",cnt_odd);
536 printf(" Punctuation & spacing queries: %14ld\n",cnt_punct);
538 printf(" Non-standard dashes: %14ld\n",cnt_dash);
540 printf(" Possible HTML tags: %14ld\n",cnt_html);
542 printf(" TOTAL QUERIES %14ld\n",
543 cnt_dquot+cnt_squot+cnt_brack+cnt_bin+cnt_odd+cnt_long+
544 cnt_short+cnt_punct+cnt_dash+cnt_word+cnt_html+cnt_lineend);
549 struct first_pass_results {
550 long firstline,astline;
551 long footerline,totlen,binlen,alphalen,endquote_count,shortline,dotcomma;
552 long fslashline,hyphens,longline,verylongline,htmcount,standalone_digit;
553 long spacedash,emdash,space_emdash,non_PG_space_emdash,PG_space_emdash;
554 signed int Dutchcount,Frenchcount;
560 * Run a first pass - verify that it's a valid PG
561 * file, decide whether to report some things that
562 * occur many times in the text like long or short
563 * lines, non-standard dashes, etc.
565 struct first_pass_results *first_pass(FILE *infile)
567 char laststart=CHAR_SPACE;
570 unsigned int lastlen=0,lastblen=0;
571 long spline=0,nspline=0;
572 static struct first_pass_results results={0};
573 char inword[MAXWORDLEN]="";
574 while (fgets(aline,LINEBUFSIZE-1,infile))
576 while (aline[strlen(aline)-1]==10 || aline[strlen(aline)-1]==13)
577 aline[strlen(aline)-1]=0;
579 if (strstr(aline,"*END") && strstr(aline,"SMALL PRINT") &&
580 (strstr(aline,"PUBLIC DOMAIN") || strstr(aline,"COPYRIGHT")))
583 printf(" --> Duplicate header?\n");
584 spline=linecnt+1; /* first line of non-header text, that is */
586 if (!strncmp(aline,"*** START",9) && strstr(aline,"PROJECT GUTENBERG"))
589 printf(" --> Duplicate header?\n");
590 nspline=linecnt+1; /* first line of non-header text, that is */
592 if (spline || nspline)
595 if (strstr(aline,"end") && strstr(aline,"project gutenberg"))
597 if (strstr(aline,"end")<strstr(aline,"project gutenberg"))
599 if (results.footerline)
601 /* it's an old-form header - we can detect duplicates */
603 printf(" --> Duplicate footer?\n");
606 results.footerline=linecnt;
611 results.firstline=spline;
613 results.firstline=nspline; /* override with new */
614 if (results.footerline)
615 continue; /* don't count the boilerplate in the footer */
617 results.totlen+=llen;
620 if ((unsigned char)aline[i]>127)
622 if (gcisalpha(aline[i]))
624 if (i>0 && aline[i]==CHAR_DQUOTE && isalpha(aline[i-1]))
625 results.endquote_count++;
627 if (strlen(aline)>2 && lastlen>2 && lastlen<SHORTEST_PG_LINE &&
628 lastblen>2 && lastblen>SHORTEST_PG_LINE && laststart!=CHAR_SPACE)
630 if (*aline && (unsigned char)aline[strlen(aline)-1]<=CHAR_SPACE)
632 if (strstr(aline,".,"))
634 /* only count ast lines for ignoring purposes where there is */
635 /* locase text on the line */
636 if (strstr(aline,"*"))
639 if (*s>='a' && *s<='z')
644 if (strstr(aline,"/"))
645 results.fslashline++;
646 for (i=llen-1;i>0 && (unsigned char)aline[i]<=CHAR_SPACE;i--)
648 if (aline[i]=='-' && aline[i-1]!='-')
650 if (llen>LONGEST_PG_LINE)
652 if (llen>WAY_TOO_LONG)
653 results.verylongline++;
654 if (strstr(aline,"<") && strstr(aline,">"))
656 i=(signed int)(strstr(aline,">")-strstr(aline,"<")+1);
659 if (strstr(aline,"<i>"))
660 results.htmcount+=4; /* bonus marks! */
662 /* Check for spaced em-dashes */
663 if (strstr(aline,"--"))
666 if (*(strstr(aline,"--")-1)==CHAR_SPACE ||
667 (*(strstr(aline,"--")+2)==CHAR_SPACE))
668 results.space_emdash++;
669 if (*(strstr(aline,"--")-1)==CHAR_SPACE &&
670 (*(strstr(aline,"--")+2)==CHAR_SPACE))
671 /* count of em-dashes with spaces both sides */
672 results.non_PG_space_emdash++;
673 if (*(strstr(aline,"--")-1)!=CHAR_SPACE &&
674 (*(strstr(aline,"--")+2)!=CHAR_SPACE))
675 /* count of PG-type em-dashes with no spaces */
676 results.PG_space_emdash++;
680 s=getaword(s,inword);
681 if (!strcmp(inword,"hij") || !strcmp(inword,"niet"))
682 results.Dutchcount++;
683 if (!strcmp(inword,"dans") || !strcmp(inword,"avec"))
684 results.Frenchcount++;
685 if (!strcmp(inword,"0") || !strcmp(inword,"1"))
686 results.standalone_digit++;
688 /* Check for spaced dashes */
689 if (strstr(aline," -") && *(strstr(aline," -")+2)!='-')
692 lastlen=strlen(aline);
699 signed int shortline,longline,bin,dash,dotcomma,ast,fslash,digit,hyphen;
700 signed int endquote,isDutch,isFrench;
706 * Make some snap decisions based on the first pass results.
708 struct warnings *report_first_pass(struct first_pass_results *results)
710 static struct warnings warnings={0};
712 printf(" --> %ld lines in this file have white space at end\n",
715 if (results->dotcomma>5)
718 printf(" --> %ld lines in this file contain '.,'. "
719 "Not reporting them.\n",results->dotcomma);
722 * If more than 50 lines, or one-tenth, are short,
723 * don't bother reporting them.
725 warnings.shortline=1;
726 if (results->shortline>50 || results->shortline*10>linecnt)
728 warnings.shortline=0;
729 printf(" --> %ld lines in this file are short. "
730 "Not reporting short lines.\n",results->shortline);
733 * If more than 50 lines, or one-tenth, are long,
734 * don't bother reporting them.
737 if (results->longline>50 || results->longline*10>linecnt)
740 printf(" --> %ld lines in this file are long. "
741 "Not reporting long lines.\n",results->longline);
743 /* If more than 10 lines contain asterisks, don't bother reporting them. */
745 if (results->astline>10)
748 printf(" --> %ld lines in this file contain asterisks. "
749 "Not reporting them.\n",results->astline);
752 * If more than 10 lines contain forward slashes,
753 * don't bother reporting them.
756 if (results->fslashline>10)
759 printf(" --> %ld lines in this file contain forward slashes. "
760 "Not reporting them.\n",results->fslashline);
763 * If more than 20 lines contain unpunctuated endquotes,
764 * don't bother reporting them.
767 if (results->endquote_count>20)
770 printf(" --> %ld lines in this file contain unpunctuated endquotes. "
771 "Not reporting them.\n",results->endquote_count);
774 * If more than 15 lines contain standalone digits,
775 * don't bother reporting them.
778 if (results->standalone_digit>10)
781 printf(" --> %ld lines in this file contain standalone 0s and 1s. "
782 "Not reporting them.\n",results->standalone_digit);
785 * If more than 20 lines contain hyphens at end,
786 * don't bother reporting them.
789 if (results->hyphens>20)
792 printf(" --> %ld lines in this file have hyphens at end. "
793 "Not reporting them.\n",results->hyphens);
795 if (results->htmcount>20 && !pswit[MARKUP_SWITCH])
797 printf(" --> Looks like this is HTML. Switching HTML mode ON.\n");
798 pswit[MARKUP_SWITCH]=1;
800 if (results->verylongline>0)
801 printf(" --> %ld lines in this file are VERY long!\n",
802 results->verylongline);
804 * If there are more non-PG spaced dashes than PG em-dashes,
805 * assume it's deliberate.
806 * Current PG guidelines say don't use them, but older texts do,
807 * and some people insist on them whatever the guidelines say.
810 if (results->spacedash+results->non_PG_space_emdash>
811 results->PG_space_emdash)
814 printf(" --> There are %ld spaced dashes and em-dashes. "
815 "Not reporting them.\n",
816 results->spacedash+results->non_PG_space_emdash);
818 /* If more than a quarter of characters are hi-bit, bug out. */
820 if (results->binlen*4>results->totlen)
822 printf(" --> This file does not appear to be ASCII. "
823 "Terminating. Best of luck with it!\n");
826 if (results->alphalen*4<results->totlen)
828 printf(" --> This file does not appear to be text. "
829 "Terminating. Best of luck with it!\n");
832 if (results->binlen*100>results->totlen || results->binlen>100)
834 printf(" --> There are a lot of foreign letters here. "
835 "Not reporting them.\n");
839 if (results->Dutchcount>50)
842 printf(" --> This looks like Dutch - "
843 "switching off dashes and warnings for 's Middags case.\n");
846 if (results->Frenchcount>50)
849 printf(" --> This looks like French - "
850 "switching off some doublepunct.\n");
852 if (results->firstline && results->footerline)
853 printf(" The PG header and footer appear to be already on.\n");
856 if (results->firstline)
857 printf(" The PG header is on - no footer.\n");
858 if (results->footerline)
859 printf(" The PG footer is on - no header.\n");
862 if (pswit[VERBOSE_SWITCH])
865 warnings.shortline=1;
874 printf(" *** Verbose output is ON -- you asked for it! ***\n");
876 if (warnings.isDutch)
878 if (results->footerline>0 && results->firstline>0 &&
879 results->footerline>results->firstline &&
880 results->footerline-results->firstline<100)
882 printf(" --> I don't really know where this text starts. \n");
883 printf(" There are no reference points.\n");
884 printf(" I'm going to have to report the header and footer "
886 results->firstline=0;
893 signed int c_unders,c_brack,s_brack,r_brack;
894 signed int open_single_quote,close_single_quote;
900 * Look along the line, accumulate the count of quotes, and see
901 * if this is an empty line - i.e. a line with nothing on it
903 * If line has just spaces, period, * and/or - on it, don't
904 * count it, since empty lines with asterisks or dashes to
905 * separate sections are common.
907 * Returns: Non-zero if the line is empty.
909 int analyse_quotes(const char *s,struct counters *counters)
911 signed int guessquote=0;
912 int isemptyline=1; /* assume the line is empty until proven otherwise */
917 if (*s==CHAR_SQUOTE || *s==CHAR_OPEN_SQUOTE)
922 * At start of line, it can only be an openquote.
923 * Hardcode a very common exception!
925 if (strncmp(s+2,"tis",3) && strncmp(s+2,"Tis",3))
926 counters->open_single_quote++;
928 else if (gcisalpha(s[-1]) && gcisalpha(s[1]))
929 /* Do nothing! it's definitely an apostrophe, not a quote */
931 /* it's outside a word - let's check it out */
932 else if (*s==CHAR_OPEN_SQUOTE || gcisalpha(s[1]))
934 /* it damwell better BE an openquote */
935 if (strncmp(s+1,"tis",3) && strncmp(s+1,"Tis",3))
936 /* hardcode a very common exception! */
937 counters->open_single_quote++;
941 /* now - is it a closequote? */
942 guessquote=0; /* accumulate clues */
943 if (gcisalpha(s[-1]))
945 /* it follows a letter - could be either */
949 /* looks like a plural apostrophe */
951 if (s[1]==CHAR_SPACE) /* bonus marks! */
955 /* it doesn't have a letter either side */
956 else if (strchr(".?!,;:",s[-1]) && strchr(".?!,;: ",s[1]))
957 guessquote+=8; /* looks like a closequote */
960 if (counters->open_single_quote>counters->close_single_quote)
962 * Give it the benefit of some doubt,
963 * if a squote is already open.
969 counters->close_single_quote++;
972 if (*s!=CHAR_SPACE && *s!='-' && *s!='.' && *s!=CHAR_ASTERISK &&
974 isemptyline=0; /* ignore lines like * * * as spacers */
975 if (*s==CHAR_UNDERSCORE)
976 counters->c_unders++;
977 if (*s==CHAR_OPEN_CBRACK)
979 if (*s==CHAR_CLOSE_CBRACK)
981 if (*s==CHAR_OPEN_RBRACK)
983 if (*s==CHAR_CLOSE_RBRACK)
985 if (*s==CHAR_OPEN_SBRACK)
987 if (*s==CHAR_CLOSE_SBRACK)
995 * check_for_odd_characters:
997 * Check for binary and other odd characters.
999 void check_for_odd_characters(const char *aline,const struct warnings *warnings,
1002 /* Don't repeat multiple warnings on one line. */
1003 signed int eNon_A=0,eTab=0,eTilde=0,eCarat=0,eFSlash=0,eAst=0;
1006 for (s=aline;*s;s++)
1008 c=*(unsigned char *)s;
1009 if (!eNon_A && (*s<CHAR_SPACE && *s!=9 && *s!='\n' || c>127))
1011 if (pswit[ECHO_SWITCH])
1012 printf("\n%s\n",aline);
1013 if (!pswit[OVERVIEW_SWITCH])
1015 printf(" Line %ld column %d - "
1016 "Non-ISO-8859 character %d\n",linecnt,(int)(s-aline)+1,c);
1018 printf(" Line %ld column %d - Non-ASCII character %d\n",
1019 linecnt,(int)(s-aline)+1,c);
1024 if (!eTab && *s==CHAR_TAB)
1026 if (pswit[ECHO_SWITCH])
1027 printf("\n%s\n",aline);
1028 if (!pswit[OVERVIEW_SWITCH])
1029 printf(" Line %ld column %d - Tab character?\n",
1030 linecnt,(int)(s-aline)+1);
1035 if (!eTilde && *s==CHAR_TILDE)
1038 * Often used by OCR software to indicate an
1039 * unrecognizable character.
1041 if (pswit[ECHO_SWITCH])
1042 printf("\n%s\n",aline);
1043 if (!pswit[OVERVIEW_SWITCH])
1044 printf(" Line %ld column %d - Tilde character?\n",
1045 linecnt,(int)(s-aline)+1);
1050 if (!eCarat && *s==CHAR_CARAT)
1052 if (pswit[ECHO_SWITCH])
1053 printf("\n%s\n",aline);
1054 if (!pswit[OVERVIEW_SWITCH])
1055 printf(" Line %ld column %d - Carat character?\n",
1056 linecnt,(int)(s-aline)+1);
1061 if (!eFSlash && *s==CHAR_FORESLASH && warnings->fslash)
1063 if (pswit[ECHO_SWITCH])
1064 printf("\n%s\n",aline);
1065 if (!pswit[OVERVIEW_SWITCH])
1066 printf(" Line %ld column %d - Forward slash?\n",
1067 linecnt,(int)(s-aline)+1);
1073 * Report asterisks only in paranoid mode,
1074 * since they're often deliberate.
1076 if (!eAst && pswit[PARANOID_SWITCH] && warnings->ast && !isemptyline &&
1079 if (pswit[ECHO_SWITCH])
1080 printf("\n%s\n",aline);
1081 if (!pswit[OVERVIEW_SWITCH])
1082 printf(" Line %ld column %d - Asterisk?\n",
1083 linecnt,(int)(s-aline)+1);
1092 * check_for_long_line:
1094 * Check for line too long.
1096 void check_for_long_line(const char *aline)
1098 if (strlen(aline)>LONGEST_PG_LINE)
1100 if (pswit[ECHO_SWITCH])
1101 printf("\n%s\n",aline);
1102 if (!pswit[OVERVIEW_SWITCH])
1103 printf(" Line %ld column %d - Long line %d\n",
1104 linecnt,strlen(aline),strlen(aline));
1110 struct line_properties {
1111 unsigned int len,blen;
1116 * check_for_short_line:
1118 * Check for line too short.
1120 * This one is a bit trickier to implement: we don't want to
1121 * flag the last line of a paragraph for being short, so we
1122 * have to wait until we know that our current line is a
1123 * "normal" line, then report the _previous_ line if it was too
1124 * short. We also don't want to report indented lines like
1125 * chapter heads or formatted quotations. We therefore keep
1126 * last->len as the length of the last line examined, and
1127 * last->blen as the length of the last but one, and try to
1128 * suppress unnecessary warnings by checking that both were of
1129 * "normal" length. We keep the first character of the last
1130 * line in last->start, and if it was a space, we assume that
1131 * the formatting is deliberate. I can't figure out a way to
1132 * distinguish something like a quoted verse left-aligned or
1133 * the header or footer of a letter from a paragraph of short
1134 * lines - maybe if I examined the whole paragraph, and if the
1135 * para has less than, say, 8 lines and if all lines are short,
1136 * then just assume it's OK? Need to look at some texts to see
1137 * how often a formula like this would get the right result.
1139 void check_for_short_line(const char *aline,const struct line_properties *last)
1141 if (strlen(aline)>1 && last->len>1 && last->len<SHORTEST_PG_LINE &&
1142 last->blen>1 && last->blen>SHORTEST_PG_LINE && last->start!=CHAR_SPACE)
1144 if (pswit[ECHO_SWITCH])
1145 printf("\n%s\n",prevline);
1146 if (!pswit[OVERVIEW_SWITCH])
1147 printf(" Line %ld column %d - Short line %d?\n",
1148 linecnt-1,strlen(prevline),strlen(prevline));
1155 * check_for_starting_punctuation:
1157 * Look for punctuation other than full ellipses at start of line.
1159 void check_for_starting_punctuation(const char *aline)
1161 if (*aline && strchr(".?!,;:",aline[0]) && strncmp(". . .",aline,5))
1163 if (pswit[ECHO_SWITCH])
1164 printf("\n%s\n",aline);
1165 if (!pswit[OVERVIEW_SWITCH])
1166 printf(" Line %ld column 1 - Begins with punctuation?\n",
1174 * check_for_spaced_emdash:
1176 * Check for spaced em-dashes.
1178 * We must check _all_ occurrences of "--" on the line
1179 * hence the loop - even if the first double-dash is OK
1180 * there may be another that's wrong later on.
1182 void check_for_spaced_emdash(const char *aline)
1186 while ((t=strstr(s,"--")))
1188 if (t>aline && t[-1]==CHAR_SPACE || t[2]==CHAR_SPACE)
1190 if (pswit[ECHO_SWITCH])
1191 printf("\n%s\n",aline);
1192 if (!pswit[OVERVIEW_SWITCH])
1193 printf(" Line %ld column %d - Spaced em-dash?\n",
1194 linecnt,(int)(t-aline)+1);
1203 * check_for_spaced_dash:
1205 * Check for spaced dashes.
1207 void check_for_spaced_dash(const char *aline)
1210 if ((s=strstr(aline," -")))
1214 if (pswit[ECHO_SWITCH])
1215 printf("\n%s\n",aline);
1216 if (!pswit[OVERVIEW_SWITCH])
1217 printf(" Line %ld column %d - Spaced dash?\n",
1218 linecnt,(int)(s-aline)+1);
1223 else if ((s=strstr(aline,"- ")))
1225 if (s==aline || s[-1]!='-')
1227 if (pswit[ECHO_SWITCH])
1228 printf("\n%s\n",aline);
1229 if (!pswit[OVERVIEW_SWITCH])
1230 printf(" Line %ld column %d - Spaced dash?\n",
1231 linecnt,(int)(s-aline)+1);
1239 * check_for_unmarked_paragraphs:
1241 * Check for unmarked paragraphs indicated by separate speakers.
1243 * May well be false positive:
1244 * "Bravo!" "Wonderful!" called the crowd.
1245 * but useful all the same.
1247 void check_for_unmarked_paragraphs(const char *aline)
1250 s=strstr(aline,"\" \"");
1252 s=strstr(aline,"\" \"");
1255 if (pswit[ECHO_SWITCH])
1256 printf("\n%s\n",aline);
1257 if (!pswit[OVERVIEW_SWITCH])
1258 printf(" Line %ld column %d - Query missing paragraph break?\n",
1259 linecnt,(int)(s-aline)+1);
1266 * check_for_jeebies:
1268 * Check for "to he" and other easy h/b errors.
1270 * This is a very inadequate effort on the h/b problem,
1271 * but the phrase "to he" is always an error, whereas "to
1272 * be" is quite common.
1273 * Similarly, '"Quiet!", be said.' is a non-be error
1274 * "to he" is _not_ always an error!:
1275 * "Where they went to he couldn't say."
1276 * Another false positive:
1277 * What would "Cinderella" be without the . . .
1278 * and another: "If he wants to he can see for himself."
1280 void check_for_jeebies(const char *aline)
1283 s=strstr(aline," be could ");
1285 s=strstr(aline," be would ");
1287 s=strstr(aline," was be ");
1289 s=strstr(aline," be is ");
1291 s=strstr(aline," is be ");
1293 s=strstr(aline,"\", be ");
1295 s=strstr(aline,"\" be ");
1297 s=strstr(aline,"\" be ");
1299 s=strstr(aline," to he ");
1302 if (pswit[ECHO_SWITCH])
1303 printf("\n%s\n",aline);
1304 if (!pswit[OVERVIEW_SWITCH])
1305 printf(" Line %ld column %d - Query he/be error?\n",
1306 linecnt,(int)(s-aline)+1);
1310 s=strstr(aline," the had ");
1312 s=strstr(aline," a had ");
1314 s=strstr(aline," they bad ");
1316 s=strstr(aline," she bad ");
1318 s=strstr(aline," he bad ");
1320 s=strstr(aline," you bad ");
1322 s=strstr(aline," i bad ");
1325 if (pswit[ECHO_SWITCH])
1326 printf("\n%s\n",aline);
1327 if (!pswit[OVERVIEW_SWITCH])
1328 printf(" Line %ld column %d - Query had/bad error?\n",
1329 linecnt,(int)(s-aline)+1);
1333 s=strstr(aline,"; hut ");
1335 s=strstr(aline,", hut ");
1338 if (pswit[ECHO_SWITCH])
1339 printf("\n%s\n",aline);
1340 if (!pswit[OVERVIEW_SWITCH])
1341 printf(" Line %ld column %d - Query hut/but error?\n",
1342 linecnt,(int)(s-aline)+1);
1349 * check_for_mta_from:
1351 * Special case - angled bracket in front of "From" placed there by an
1352 * MTA when sending an e-mail.
1354 void check_for_mta_from(const char *aline)
1357 s=strstr(aline,">From");
1360 if (pswit[ECHO_SWITCH])
1361 printf("\n%s\n",aline);
1362 if (!pswit[OVERVIEW_SWITCH])
1363 printf(" Line %ld column %d - Query angled bracket with From\n",
1364 linecnt,(int)(s-aline)+1);
1371 * check_for_orphan_character:
1373 * Check for a single character line -
1374 * often an overflow from bad wrapping.
1376 void check_for_orphan_character(const char *aline)
1378 if (*aline && !aline[1])
1380 if (*aline=='I' || *aline=='V' || *aline=='X' || *aline=='L' ||
1382 ; /* Nothing - ignore numerals alone on a line. */
1385 if (pswit[ECHO_SWITCH])
1386 printf("\n%s\n",aline);
1387 if (!pswit[OVERVIEW_SWITCH])
1388 printf(" Line %ld column 1 - Query single character line\n",
1397 * check_for_pling_scanno:
1399 * Check for I" - often should be !
1401 void check_for_pling_scanno(const char *aline)
1404 s=strstr(aline," I\"");
1407 if (pswit[ECHO_SWITCH])
1408 printf("\n%s\n",aline);
1409 if (!pswit[OVERVIEW_SWITCH])
1410 printf(" Line %ld column %ld - Query I=exclamation mark?\n",
1418 * check_for_extra_period:
1420 * Check for period without a capital letter. Cut-down from gutspell.
1421 * Only works when it happens on a single line.
1423 void check_for_extra_period(const char *aline,const struct warnings *warnings)
1425 const char *s,*t,*s1;
1426 signed int i,istypo,isdup;
1427 static char qperiod[MAX_QWORD][MAX_QWORD_LENGTH];
1428 static int qperiod_index=0;
1429 char testword[MAXWORDLEN]="";
1430 if (pswit[PARANOID_SWITCH])
1432 for (t=s=aline;strstr(t,". ");)
1438 /* start of line punctuation is handled elsewhere */
1441 if (!gcisalpha(t[-1]))
1446 if (warnings->isDutch)
1448 /* For Frank & Jeroen -- 's Middags case */
1449 if (t[2]==CHAR_SQUOTE && t[3]>='a' && t[3]<='z' &&
1450 t[4]==CHAR_SPACE && t[5]>='A' && t[5]<='Z')
1457 while (*s1 && !gcisalpha(*s1) && !isdigit(*s1))
1459 if (*s1>='a' && *s1<='z')
1461 /* we have something to investigate */
1463 /* so let's go back and find out */
1464 for (s1=t-1;s1>=s &&
1465 (gcisalpha(*s1) || gcisdigit(*s1) || *s1==CHAR_SQUOTE &&
1466 gcisalpha(s1[1]) && gcisalpha(s1[-1]));s1--)
1469 for (i=0;*s1 && *s1!='.';s1++,i++)
1472 for (i=0;*abbrev[i];i++)
1473 if (!strcmp(testword,abbrev[i]))
1475 if (gcisdigit(*testword))
1479 if (isroman(testword))
1484 for (i=0;testword[i];i++)
1485 if (strchr(vowels,testword[i]))
1491 if (strlen(testword)<MAX_QWORD_LENGTH &&
1492 !pswit[VERBOSE_SWITCH])
1493 for (i=0;i<qperiod_index;i++)
1494 if (!strcmp(testword,qperiod[i]))
1498 if (qperiod_index<MAX_QWORD &&
1499 strlen(testword)<MAX_QWORD_LENGTH)
1501 strcpy(qperiod[qperiod_index],testword);
1504 if (pswit[ECHO_SWITCH])
1505 printf("\n%s\n",aline);
1506 if (!pswit[OVERVIEW_SWITCH])
1507 printf(" Line %ld column %d - Extra period?\n",
1508 linecnt,(int)(t-aline)+1);
1520 * check_for_following_punctuation:
1522 * Check for words usually not followed by punctuation.
1524 void check_for_following_punctuation(const char *aline)
1527 const char *s,*wordstart;
1528 char inword[MAXWORDLEN];
1529 if (pswit[TYPO_SWITCH])
1534 s=getaword(s,inword);
1538 for (i=0;*nocomma[i];i++)
1539 if (!strcmp(inword,nocomma[i]))
1541 if (*s==',' || *s==';' || *s==':')
1543 if (pswit[ECHO_SWITCH])
1544 printf("\n%s\n",aline);
1545 if (!pswit[OVERVIEW_SWITCH])
1546 printf(" Line %ld column %d - "
1547 "Query punctuation after %s?\n",
1548 linecnt,(int)(s-aline)+1,inword);
1553 for (i=0;*noperiod[i];i++)
1554 if (!strcmp(inword,noperiod[i]))
1556 if (*s=='.' || *s=='!')
1558 if (pswit[ECHO_SWITCH])
1559 printf("\n%s\n",aline);
1560 if (!pswit[OVERVIEW_SWITCH])
1561 printf(" Line %ld column %d - "
1562 "Query punctuation after %s?\n",
1563 linecnt,(int)(s-aline)+1,inword);
1575 * Check for commonly mistyped words,
1576 * and digits like 0 for O in a word.
1578 void check_for_typos(const char *aline,struct warnings *warnings)
1580 const char *s,*wordstart;
1581 char inword[MAXWORDLEN],testword[MAXWORDLEN];
1582 int i,istypo,isdup,alower,vowel,consonant;
1583 static int qword_index=0;
1587 s=getaword(s,inword);
1589 continue; /* don't bother with empty lines */
1590 if (mixdigit(inword))
1592 if (pswit[ECHO_SWITCH])
1593 printf("\n%s\n",aline);
1594 if (!pswit[OVERVIEW_SWITCH])
1595 printf(" Line %ld column %d - Query digit in %s\n",
1596 linecnt,(int)(wordstart-aline)+1,inword);
1601 * Put the word through a series of tests for likely typos and OCR
1604 if (pswit[TYPO_SWITCH])
1607 strcpy(testword,inword);
1609 for (i=0;i<(signed int)strlen(testword);i++)
1611 /* lowercase for testing */
1612 if (testword[i]>='a' && testword[i]<='z')
1614 if (alower && testword[i]>='A' && testword[i]<='Z')
1617 * We have an uppercase mid-word. However, there are
1619 * Mac and Mc like McGill
1620 * French contractions like l'Abbe
1622 if (i==2 && testword[0]=='m' && testword[1]=='c' ||
1623 i==3 && testword[0]=='m' && testword[1]=='a' &&
1624 testword[2]=='c' || i>0 && testword[i-1]==CHAR_SQUOTE)
1629 testword[i]=(char)tolower(testword[i]);
1632 * Check for certain unlikely two-letter combinations at word
1635 if (strlen(testword)>1)
1637 for (i=0;*nostart[i];i++)
1638 if (!strncmp(testword,nostart[i],2))
1640 for (i=0;*noend[i];i++)
1641 if (!strncmp(testword+strlen(testword)-2,noend[i],2))
1644 /* ght is common, gbt never. Like that. */
1645 if (strstr(testword,"cb"))
1647 if (strstr(testword,"gbt"))
1649 if (strstr(testword,"pbt"))
1651 if (strstr(testword,"tbs"))
1653 if (strstr(testword,"mrn"))
1655 if (strstr(testword,"ahle"))
1657 if (strstr(testword,"ihle"))
1660 * "TBE" does happen - like HEARTBEAT - but uncommon.
1661 * Also "TBI" - frostbite, outbid - but uncommon.
1662 * Similarly "ii" like Hawaii, or Pompeii, and in Roman
1663 * numerals, but "ii" is a common scanno.
1665 if (strstr(testword,"tbi"))
1667 if (strstr(testword,"tbe"))
1669 if (strstr(testword,"ii"))
1672 * Check for no vowels or no consonants.
1673 * If none, flag a typo.
1675 if (!istypo && strlen(testword)>1)
1678 for (i=0;testword[i];i++)
1680 if (testword[i]=='y' || gcisdigit(testword[i]))
1682 /* Yah, this is loose. */
1686 else if (strchr(vowels,testword[i]))
1691 if (!vowel || !consonant)
1695 * Now exclude the word from being reported if it's in
1698 for (i=0;*okword[i];i++)
1699 if (!strcmp(testword,okword[i]))
1702 * What looks like a typo may be a Roman numeral.
1705 if (istypo && isroman(testword))
1707 /* Check the manual list of typos. */
1709 for (i=0;*typo[i];i++)
1710 if (!strcmp(testword,typo[i]))
1713 * Check lowercase s, l, i and m - special cases.
1714 * "j" - often a semi-colon gone wrong.
1715 * "d" for a missing apostrophe - he d
1718 if (!istypo && strlen(testword)==1 && strchr("slmijdn",*inword))
1723 if (strlen(testword)<MAX_QWORD_LENGTH &&
1724 !pswit[VERBOSE_SWITCH])
1725 for (i=0;i<qword_index;i++)
1726 if (!strcmp(testword,qword[i]))
1733 if (qword_index<MAX_QWORD &&
1734 strlen(testword)<MAX_QWORD_LENGTH)
1736 strcpy(qword[qword_index],testword);
1739 if (pswit[ECHO_SWITCH])
1740 printf("\n%s\n",aline);
1741 if (!pswit[OVERVIEW_SWITCH])
1743 printf(" Line %ld column %d - Query word %s",
1744 linecnt,(int)(wordstart-aline)+1,inword);
1745 if (strlen(testword)<MAX_QWORD_LENGTH &&
1746 !pswit[VERBOSE_SWITCH])
1747 printf(" - not reporting duplicates");
1755 /* check the user's list of typos */
1756 if (!istypo && usertypo_count)
1757 for (i=0;i<usertypo_count;i++)
1758 if (!strcmp(testword,usertypo[i]))
1760 if (pswit[ECHO_SWITCH])
1761 printf("\n%s\n",aline);
1762 if (!pswit[OVERVIEW_SWITCH])
1763 printf(" Line %ld column %d - "
1764 "Query possible scanno %s\n",
1765 linecnt,(int)(wordstart-aline)+2,inword);
1767 if (pswit[PARANOID_SWITCH] && warnings->digit)
1769 /* In paranoid mode, query all 0 and 1 standing alone. */
1770 if (!strcmp(inword,"0") || !strcmp(inword,"1"))
1772 if (pswit[ECHO_SWITCH])
1773 printf("\n%s\n",aline);
1774 if (!pswit[OVERVIEW_SWITCH])
1775 printf(" Line %ld column %d - Query standalone %s\n",
1776 linecnt,(int)(wordstart-aline)+2,inword);
1789 * check_for_misspaced_punctuation:
1791 * Look for added or missing spaces around punctuation and quotes.
1792 * If there is a punctuation character like ! with no space on
1793 * either side, suspect a missing!space. If there are spaces on
1794 * both sides , assume a typo. If we see a double quote with no
1795 * space or punctuation on either side of it, assume unspaced
1796 * quotes "like"this.
1798 void check_for_misspaced_punctuation(const char *aline,
1799 struct parities *parities,int isemptyline)
1801 int i,llen,isacro,isellipsis;
1804 for (i=1;i<llen;i++)
1806 /* For each character in the line after the first. */
1807 if (strchr(".?!,;:_",aline[i])) /* if it's punctuation */
1809 /* we need to suppress warnings for acronyms like M.D. */
1811 /* we need to suppress warnings for ellipsis . . . */
1813 /* if there are letters on both sides of it or ... */
1814 if (gcisalpha(aline[i-1]) && gcisalpha(aline[i+1]) ||
1815 gcisalpha(aline[i+1]) && strchr("?!,;:",aline[i]))
1817 /* ...if it's strict punctuation followed by an alpha */
1820 if (i>2 && aline[i-2]=='.')
1822 if (i+2<llen && aline[i+2]=='.')
1827 if (pswit[ECHO_SWITCH])
1828 printf("\n%s\n",aline);
1829 if (!pswit[OVERVIEW_SWITCH])
1830 printf(" Line %ld column %d - Missing space?\n",
1836 if (aline[i-1]==CHAR_SPACE &&
1837 (aline[i+1]==CHAR_SPACE || aline[i+1]==0))
1840 * If there are spaces on both sides,
1841 * or space before and end of line.
1845 if (i>2 && aline[i-2]=='.')
1847 if (i+2<llen && aline[i+2]=='.')
1850 if (!isemptyline && !isellipsis)
1852 if (pswit[ECHO_SWITCH])
1853 printf("\n%s\n",aline);
1854 if (!pswit[OVERVIEW_SWITCH])
1855 printf(" Line %ld column %d - "
1856 "Spaced punctuation?\n",linecnt,i+1);
1863 /* Split out the characters that CANNOT be preceded by space. */
1865 for (i=1;i<llen;i++)
1867 /* for each character in the line after the first */
1868 if (strchr("?!,;:",aline[i]))
1870 /* if it's punctuation that _cannot_ have a space before it */
1871 if (aline[i-1]==CHAR_SPACE && !isemptyline &&
1872 aline[i+1]!=CHAR_SPACE)
1875 * If aline[i+1) DOES == space,
1876 * it was already reported just above.
1878 if (pswit[ECHO_SWITCH])
1879 printf("\n%s\n",aline);
1880 if (!pswit[OVERVIEW_SWITCH])
1881 printf(" Line %ld column %d - Spaced punctuation?\n",
1889 * Special case " .X" where X is any alpha.
1890 * This plugs a hole in the acronym code above.
1891 * Inelegant, but maintainable.
1894 for (i=1;i<llen;i++)
1896 /* for each character in the line after the first */
1899 /* if it's a period */
1900 if (aline[i-1]==CHAR_SPACE && gcisalpha(aline[i+1]))
1903 * If the period follows a space and
1904 * is followed by a letter.
1906 if (pswit[ECHO_SWITCH])
1907 printf("\n%s\n",aline);
1908 if (!pswit[OVERVIEW_SWITCH])
1909 printf(" Line %ld column %d - Spaced punctuation?\n",
1916 for (i=1;i<llen;i++)
1918 /* for each character in the line after the first */
1919 if (aline[i]==CHAR_DQUOTE)
1921 if (!strchr(" _-.'`,;:!/([{?}])",aline[i-1]) &&
1922 !strchr(" _-.'`,;:!/([{?}])",aline[i+1]) && aline[i+1] ||
1923 !strchr(" _-([{'`",aline[i-1]) && gcisalpha(aline[i+1]))
1925 if (pswit[ECHO_SWITCH])
1926 printf("\n%s\n",aline);
1927 if (!pswit[OVERVIEW_SWITCH])
1928 printf(" Line %ld column %d - Unspaced quotes?\n",
1935 /* Check parity of quotes. */
1936 for (s=aline;*s;s++)
1938 if (*s==CHAR_DQUOTE)
1940 parities->dquote=!parities->dquote;
1941 if (!parities->dquote)
1944 if (!strchr("_-.'`/,;:!?)]} ",s[1]))
1946 if (pswit[ECHO_SWITCH])
1947 printf("\n%s\n",aline);
1948 if (!pswit[OVERVIEW_SWITCH])
1949 printf(" Line %ld column %d - "
1950 "Wrongspaced quotes?\n",linecnt,(int)(s-aline)+1);
1958 if (!gcisalpha(s[1]) && !isdigit(s[1]) &&
1959 !strchr("_-/.'`([{$",s[1]) || !s[1])
1961 if (pswit[ECHO_SWITCH])
1962 printf("\n%s\n",aline);
1963 if (!pswit[OVERVIEW_SWITCH])
1964 printf(" Line %ld column %d - "
1965 "Wrongspaced quotes?\n",linecnt,(int)(s-aline)+1);
1972 if (*aline==CHAR_DQUOTE)
1974 if (strchr(",;:!?)]} ",aline[1]))
1976 if (pswit[ECHO_SWITCH])
1977 printf("\n%s\n",aline);
1978 if (!pswit[OVERVIEW_SWITCH])
1979 printf(" Line %ld column 1 - Wrongspaced quotes?\n",
1985 if (pswit[SQUOTE_SWITCH])
1987 for (s=aline;*s;s++)
1989 if ((*s==CHAR_SQUOTE || *s==CHAR_OPEN_SQUOTE) &&
1990 (s==aline || s>aline && !gcisalpha(s[-1]) ||
1993 parities->squote=!parities->squote;
1994 if (!parities->squote)
1997 if (!strchr("_-.'`/\",;:!?)]} ",s[1]))
1999 if (pswit[ECHO_SWITCH])
2000 printf("\n%s\n",aline);
2001 if (!pswit[OVERVIEW_SWITCH])
2002 printf(" Line %ld column %d - "
2003 "Wrongspaced singlequotes?\n",
2004 linecnt,(int)(s-aline)+1);
2012 if (!gcisalpha(s[1]) && !isdigit(s[1]) &&
2013 !strchr("_-/\".'`",s[1]) || !s[1])
2015 if (pswit[ECHO_SWITCH])
2016 printf("\n%s\n",aline);
2017 if (!pswit[OVERVIEW_SWITCH])
2018 printf(" Line %ld column %d - "
2019 "Wrongspaced singlequotes?\n",
2020 linecnt,(int)(s-aline)+1);
2031 * check_for_double_punctuation:
2033 * Look for double punctuation like ,. or ,,
2034 * Thanks to DW for the suggestion!
2035 * In books with references, ".," and ".;" are common
2036 * e.g. "etc., etc.," and vol. 1.; vol 3.;
2037 * OTOH, from my initial tests, there are also fairly
2038 * common errors. What to do? Make these cases paranoid?
2039 * ".," is the most common, so warnings->dotcomma is used
2040 * to suppress detailed reporting if it occurs often.
2042 void check_for_double_punctuation(const char *aline,struct warnings *warnings)
2046 for (i=0;i<llen;i++)
2048 /* for each punctuation character in the line */
2049 if (strchr(".?!,;:",aline[i]) && strchr(".?!,;:",aline[i+1]) &&
2050 aline[i] && aline[i+1])
2052 /* followed by punctuation, it's a query, unless . . . */
2053 if (aline[i]==aline[i+1] && (aline[i]=='.' || aline[i]=='?' ||
2055 !warnings->dotcomma && aline[i]=='.' && aline[i+1]==',' ||
2056 warnings->isFrench && !strncmp(aline+i,",...",4) ||
2057 warnings->isFrench && !strncmp(aline+i,"...,",4) ||
2058 warnings->isFrench && !strncmp(aline+i,";...",4) ||
2059 warnings->isFrench && !strncmp(aline+i,"...;",4) ||
2060 warnings->isFrench && !strncmp(aline+i,":...",4) ||
2061 warnings->isFrench && !strncmp(aline+i,"...:",4) ||
2062 warnings->isFrench && !strncmp(aline+i,"!...",4) ||
2063 warnings->isFrench && !strncmp(aline+i,"...!",4) ||
2064 warnings->isFrench && !strncmp(aline+i,"?...",4) ||
2065 warnings->isFrench && !strncmp(aline+i,"...?",4))
2067 if (warnings->isFrench && !strncmp(aline+i,",...",4) ||
2068 warnings->isFrench && !strncmp(aline+i,"...,",4) ||
2069 warnings->isFrench && !strncmp(aline+i,";...",4) ||
2070 warnings->isFrench && !strncmp(aline+i,"...;",4) ||
2071 warnings->isFrench && !strncmp(aline+i,":...",4) ||
2072 warnings->isFrench && !strncmp(aline+i,"...:",4) ||
2073 warnings->isFrench && !strncmp(aline+i,"!...",4) ||
2074 warnings->isFrench && !strncmp(aline+i,"...!",4) ||
2075 warnings->isFrench && !strncmp(aline+i,"?...",4) ||
2076 warnings->isFrench && !strncmp(aline+i,"...?",4))
2078 ; /* do nothing for .. !! and ?? which can be legit */
2082 if (pswit[ECHO_SWITCH])
2083 printf("\n%s\n",aline);
2084 if (!pswit[OVERVIEW_SWITCH])
2085 printf(" Line %ld column %d - Double punctuation?\n",
2099 void procfile(char *filename)
2102 char parastart[81]; /* first line of current para */
2104 struct first_pass_results *first_pass_results;
2105 struct warnings *warnings;
2106 struct counters counters={0};
2107 struct line_properties last={0};
2108 struct parities parities={0};
2110 long squot,start_para_line;
2111 signed int i,llen,isacro,isellipsis;
2112 signed int isnewpara;
2113 char dquote_err[80],squote_err[80],rbrack_err[80],sbrack_err[80],
2114 cbrack_err[80],unders_err[80];
2116 last.start=CHAR_SPACE;
2117 *dquote_err=*squote_err=*rbrack_err=*cbrack_err=*sbrack_err=
2118 *unders_err=*prevline=0;
2119 linecnt=checked_linecnt=start_para_line=0;
2121 i=llen=isacro=isellipsis=0;
2122 isnewpara=enddash=0;
2123 infile=fopen(filename,"rb");
2126 if (pswit[STDOUT_SWITCH])
2127 fprintf(stdout,"bookloupe: cannot open %s\n",filename);
2129 fprintf(stderr,"bookloupe: cannot open %s\n",filename);
2132 fprintf(stdout,"\n\nFile: %s\n\n",filename);
2133 first_pass_results=first_pass(infile);
2134 warnings=report_first_pass(first_pass_results);
2137 * Here we go with the main pass. Hold onto yer hat!
2138 * Re-init some variables we've dirtied.
2141 while (flgets(aline,LINEBUFSIZE-1,infile,linecnt+1))
2146 if (pswit[DP_SWITCH] && !strncmp(aline,"-----File: ",11))
2147 continue; // skip DP page separators completely
2148 if (linecnt<first_pass_results->firstline ||
2149 (first_pass_results->footerline>0 &&
2150 linecnt>first_pass_results->footerline))
2152 if (pswit[HEADER_SWITCH])
2154 if (!strncmp(aline,"Title:",6))
2155 printf(" %s\n",aline);
2156 if (!strncmp(aline,"Author:",7))
2157 printf(" %s\n",aline);
2158 if (!strncmp(aline,"Release Date:",13))
2159 printf(" %s\n",aline);
2160 if (!strncmp(aline,"Edition:",8))
2161 printf(" %s\n\n",aline);
2163 continue; /* skip through the header */
2168 * If we are in a state of unbalanced quotes, and this line
2169 * doesn't begin with a quote, output the stored error message.
2170 * If the -P switch was used, print the warning even if the
2171 * new para starts with quotes.
2177 if (*t!=CHAR_DQUOTE || pswit[QPARA_SWITCH])
2179 if (!pswit[OVERVIEW_SWITCH])
2181 if (pswit[ECHO_SWITCH])
2182 printf("\n%s\n",parastart);
2190 if (*t!=CHAR_SQUOTE && *t!=CHAR_OPEN_SQUOTE ||
2191 pswit[QPARA_SWITCH] || squot)
2193 if (!pswit[OVERVIEW_SWITCH])
2195 if (pswit[ECHO_SWITCH])
2196 printf("\n%s\n",parastart);
2206 if (!pswit[OVERVIEW_SWITCH])
2208 if (pswit[ECHO_SWITCH])
2209 printf("\n%s\n",parastart);
2217 if (!pswit[OVERVIEW_SWITCH])
2219 if (pswit[ECHO_SWITCH])
2220 printf("\n%s\n",parastart);
2228 if (!pswit[OVERVIEW_SWITCH])
2230 if (pswit[ECHO_SWITCH])
2231 printf("\n%s\n",parastart);
2239 if (!pswit[OVERVIEW_SWITCH])
2241 if (pswit[ECHO_SWITCH])
2242 printf("\n%s\n",parastart);
2248 *dquote_err=*squote_err=*rbrack_err=*cbrack_err=
2249 *sbrack_err=*unders_err=0;
2250 isemptyline=analyse_quotes(aline,&counters);
2251 if (isnewpara && !isemptyline)
2253 /* This line is the start of a new paragraph. */
2254 start_para_line=linecnt;
2255 /* Capture its first line in case we want to report it later. */
2256 strncpy(parastart,aline,80);
2258 memset(&parities,0,sizeof(parities)); /* restart the quote count */
2260 while (!gcisalpha(*s) && !gcisdigit(*s) && *s)
2262 if (*s>='a' && *s<='z')
2264 /* and its first letter is lowercase */
2265 if (pswit[ECHO_SWITCH])
2266 printf("\n%s\n",aline);
2267 if (!pswit[OVERVIEW_SWITCH])
2268 printf(" Line %ld column %d - "
2269 "Paragraph starts with lower-case\n",
2270 linecnt,(int)(s-aline)+1);
2274 isnewpara=0; /* Signal the end of new para processing. */
2276 /* Check for an em-dash broken at line end. */
2277 if (enddash && *aline=='-')
2279 if (pswit[ECHO_SWITCH])
2280 printf("\n%s\n",aline);
2281 if (!pswit[OVERVIEW_SWITCH])
2282 printf(" Line %ld column 1 - Broken em-dash?\n",linecnt);
2287 for (s=aline+strlen(aline)-1;*s==' ' && s>aline;s--)
2289 if (s>=aline && *s=='-')
2292 * Check for invalid or questionable characters in the line
2293 * Anything above 127 is invalid for plain ASCII, and
2294 * non-printable control characters should also be flagged.
2295 * Tabs should generally not be there.
2297 for (s=aline;*s;s++)
2299 i=(unsigned char)*s;
2300 if (i<CHAR_SPACE && i!=CHAR_LF && i!=CHAR_CR && i!=CHAR_TAB)
2302 if (pswit[ECHO_SWITCH])
2303 printf("\n%s\n",aline);
2304 if (!pswit[OVERVIEW_SWITCH])
2305 printf(" Line %ld column %d - Control character %d\n",
2306 linecnt,(int)(s-aline)+1,i);
2312 check_for_odd_characters(aline,warnings,isemptyline);
2313 if (warnings->longline)
2314 check_for_long_line(aline);
2315 if (warnings->shortline)
2316 check_for_short_line(aline,&last);
2318 last.len=strlen(aline);
2319 last.start=aline[0];
2320 check_for_starting_punctuation(aline);
2323 check_for_spaced_emdash(aline);
2324 check_for_spaced_dash(aline);
2326 check_for_unmarked_paragraphs(aline);
2327 check_for_jeebies(aline);
2328 check_for_mta_from(aline);
2329 check_for_orphan_character(aline);
2330 check_for_pling_scanno(aline);
2331 check_for_extra_period(aline,warnings);
2332 check_for_following_punctuation(aline);
2333 check_for_typos(aline,warnings);
2334 check_for_misspaced_punctuation(aline,&parities,isemptyline);
2335 check_for_double_punctuation(aline,warnings);
2337 while (strstr(s," \" "))
2339 if (pswit[ECHO_SWITCH])
2340 printf("\n%s\n",aline);
2341 if (!pswit[OVERVIEW_SWITCH])
2342 printf(" Line %ld column %d - Spaced doublequote?\n",
2343 linecnt,(int)(strstr(s," \" ")-aline+1));
2346 s=strstr(s," \" ")+2;
2349 while (strstr(s," ' "))
2351 if (pswit[ECHO_SWITCH])
2352 printf("\n%s\n",aline);
2353 if (!pswit[OVERVIEW_SWITCH])
2354 printf(" Line %ld column %d - Spaced singlequote?\n",
2355 linecnt,(int)(strstr(s," ' ")-aline+1));
2358 s=strstr(s," ' ")+2;
2361 while (strstr(s," ` "))
2363 if (pswit[ECHO_SWITCH])
2364 printf("\n%s\n",aline);
2365 if (!pswit[OVERVIEW_SWITCH])
2366 printf(" Line %ld column %d - Spaced singlequote?\n",
2367 linecnt,(int)(strstr(s," ` ")-aline+1));
2370 s=strstr(s," ` ")+2;
2372 /* check special case of 'S instead of 's at end of word */
2376 if (*s==CHAR_SQUOTE && s[1]=='S' && s[-1]>='a' && s[-1]<='z')
2378 if (pswit[ECHO_SWITCH])
2379 printf("\n%s\n",aline);
2380 if (!pswit[OVERVIEW_SWITCH])
2381 printf(" Line %ld column %d - Capital \"S\"?\n",
2382 linecnt,(int)(s-aline+2));
2389 * Now check special cases - start and end of line -
2390 * for single and double quotes. Start is sometimes [sic]
2391 * but better to query it anyway.
2392 * While we're here, check for dash at end of line.
2397 if (aline[llen-1]==CHAR_DQUOTE || aline[llen-1]==CHAR_SQUOTE ||
2398 aline[llen-1]==CHAR_OPEN_SQUOTE)
2399 if (aline[llen-2]==CHAR_SPACE)
2401 if (pswit[ECHO_SWITCH])
2402 printf("\n%s\n",aline);
2403 if (!pswit[OVERVIEW_SWITCH])
2404 printf(" Line %ld column %d - Spaced quote?\n",
2409 if ((aline[0]==CHAR_SQUOTE || aline[0]==CHAR_OPEN_SQUOTE) &&
2410 aline[1]==CHAR_SPACE)
2412 if (pswit[ECHO_SWITCH])
2413 printf("\n%s\n",aline);
2414 if (!pswit[OVERVIEW_SWITCH])
2415 printf(" Line %ld column 1 - Spaced quote?\n",linecnt);
2420 * Dash at end of line may well be legit - paranoid mode only
2421 * and don't report em-dash at line-end.
2423 if (pswit[PARANOID_SWITCH] && warnings->hyphen)
2425 for (i=llen-1;i>0 && (unsigned char)aline[i]<=CHAR_SPACE;i--)
2427 if (aline[i]=='-' && aline[i-1]!='-')
2429 if (pswit[ECHO_SWITCH])
2430 printf("\n%s\n",aline);
2431 if (!pswit[OVERVIEW_SWITCH])
2432 printf(" Line %ld column %d - "
2433 "Hyphen at end of line?\n",linecnt,i);
2438 * Brackets are often unspaced, but shouldn't be surrounded by alpha.
2439 * If so, suspect a scanno like "a]most".
2442 for (i=1;i<llen-1;i++)
2444 /* for each bracket character in the line except 1st & last */
2445 if (strchr("{[()]}",aline[i]) && gcisalpha(aline[i-1]) &&
2446 gcisalpha(aline[i+1]))
2448 if (pswit[ECHO_SWITCH])
2449 printf("\n%s\n",aline);
2450 if (!pswit[OVERVIEW_SWITCH])
2451 printf(" Line %ld column %d - Unspaced bracket?\n",
2458 if (warnings->endquote)
2460 for (i=1;i<llen;i++)
2462 /* for each character in the line except 1st */
2463 if (aline[i]==CHAR_DQUOTE && isalpha(aline[i-1]))
2465 if (pswit[ECHO_SWITCH])
2466 printf("\n%s\n",aline);
2467 if (!pswit[OVERVIEW_SWITCH])
2468 printf(" Line %ld column %d - "
2469 "endquote missing punctuation?\n",linecnt,i);
2476 * Check for <HTML TAG>.
2477 * If there is a < in the line, followed at some point
2478 * by a > then we suspect HTML.
2480 if (strstr(aline,"<") && strstr(aline,">"))
2482 i=(signed int)(strstr(aline,">")-strstr(aline,"<")+1);
2485 strncpy(wrk,strstr(aline,"<"),i);
2487 if (pswit[ECHO_SWITCH])
2488 printf("\n%s\n",aline);
2489 if (!pswit[OVERVIEW_SWITCH])
2490 printf(" Line %ld column %d - HTML Tag? %s \n",
2491 linecnt,(int)(strstr(aline,"<")-aline)+1,wrk);
2497 * Check for &symbol; HTML.
2498 * If there is a & in the line, followed at
2499 * some point by a ; then we suspect HTML.
2501 if (strstr(aline,"&") && strstr(aline,";"))
2503 i=(int)(strstr(aline,";")-strstr(aline,"&")+1);
2504 for (s=strstr(aline,"&");s<strstr(aline,";");s++)
2506 i=0; /* Don't report "Jones & Son;" */
2509 strncpy(wrk,strstr(aline,"&"),i);
2511 if (pswit[ECHO_SWITCH])
2512 printf("\n%s\n",aline);
2513 if (!pswit[OVERVIEW_SWITCH])
2514 printf(" Line %ld column %d - HTML symbol? %s \n",
2515 linecnt,(int)(strstr(aline,"&")-aline)+1,wrk);
2521 * At end of paragraph, check for mismatched quotes.
2522 * We don't want to report an error immediately, since it is a
2523 * common convention to omit the quotes at end of paragraph if
2524 * the next paragraph is a continuation of the same speaker.
2525 * Where this is the case, the next para should begin with a
2526 * quote, so we store the warning message and only display it
2527 * at the top of the next iteration if the new para doesn't
2528 * start with a quote.
2529 * The -p switch overrides this default, and warns of unclosed
2530 * quotes on _every_ paragraph, whether the next begins with a
2535 /* end of para - add up the totals */
2536 if (counters.quot%2)
2537 sprintf(dquote_err," Line %ld - Mismatched quotes\n",
2539 if (pswit[SQUOTE_SWITCH] && counters.open_single_quote &&
2540 counters.open_single_quote!=counters.close_single_quote)
2541 sprintf(squote_err," Line %ld - Mismatched singlequotes?\n",
2543 if (pswit[SQUOTE_SWITCH] && counters.open_single_quote &&
2544 counters.open_single_quote!=counters.close_single_quote &&
2545 counters.open_single_quote!=counters.close_single_quote+1)
2547 * Flag it to be noted regardless of the
2548 * first char of the next para.
2551 if (counters.r_brack)
2552 sprintf(rbrack_err," Line %ld - "
2553 "Mismatched round brackets?\n",linecnt);
2554 if (counters.s_brack)
2555 sprintf(sbrack_err," Line %ld - "
2556 "Mismatched square brackets?\n",linecnt);
2557 if (counters.c_brack)
2558 sprintf(cbrack_err," Line %ld - "
2559 "Mismatched curly brackets?\n",linecnt);
2560 if (counters.c_unders%2)
2561 sprintf(unders_err," Line %ld - Mismatched underscores?\n",
2563 memset(&counters,0,sizeof(counters));
2564 /* let the next iteration know that it's starting a new para */
2568 * Check for omitted punctuation at end of paragraph by working back
2569 * through prevline. DW.
2570 * Need to check this only for "normal" paras.
2571 * So what is a "normal" para?
2572 * Not normal if one-liner (chapter headings, etc.)
2573 * Not normal if doesn't contain at least one locase letter
2574 * Not normal if starts with space
2579 for (s=prevline,i=0;*s && !i;s++)
2581 /* use i to indicate the presence of a letter on the line */
2584 * This next "if" is a problem.
2585 * If we say "start_para_line <= linecnt - 1", that includes
2586 * one-line "paragraphs" like chapter heads. Lotsa false positives.
2587 * If we say "start_para_line < linecnt - 1" it doesn't, but then it
2588 * misses genuine one-line paragraphs.
2590 if (i && last.blen>2 && start_para_line<linecnt-1 &&
2591 *prevline>CHAR_SPACE)
2593 for (i=strlen(prevline)-1;
2594 (prevline[i]==CHAR_DQUOTE || prevline[i]==CHAR_SQUOTE) &&
2595 prevline[i]>CHAR_SPACE && i>0;
2600 if (gcisalpha(prevline[i]))
2602 if (pswit[ECHO_SWITCH])
2603 printf("\n%s\n",prevline);
2604 if (!pswit[OVERVIEW_SWITCH])
2605 printf(" Line %ld column %d - "
2606 "No punctuation at para end?\n",
2607 linecnt-1,strlen(prevline));
2612 if (strchr("-.:!([{?}])",prevline[i]))
2617 strcpy(prevline,aline);
2620 if (!pswit[OVERVIEW_SWITCH])
2621 for (i=0;i<MAX_QWORD;i++)
2623 printf("\nNote: Queried word %s was duplicated %d time%s\n",
2624 qword[i],dupcnt[i],"s");
2630 * Get one line from the input stream, checking for
2631 * the existence of exactly one CR/LF line-end per line.
2633 * Returns: a pointer to the line.
2635 char *flgets(char *theline,int maxlen,FILE *thefile,long lcnt)
2641 c=cint=fgetc(thefile);
2646 /* either way, it's end of line */
2653 /* Error - a LF without a preceding CR */
2654 if (pswit[LINE_END_SWITCH])
2656 if (pswit[ECHO_SWITCH])
2657 printf("\n%s\n",theline);
2658 if (!pswit[OVERVIEW_SWITCH])
2659 printf(" Line %ld - No CR?\n",lcnt);
2670 /* Error - two successive CRs */
2671 if (pswit[LINE_END_SWITCH])
2673 if (pswit[ECHO_SWITCH])
2674 printf("\n%s\n",theline);
2675 if (!pswit[OVERVIEW_SWITCH])
2676 printf(" Line %ld - Two successive CRs?\n",lcnt);
2685 if (pswit[LINE_END_SWITCH] && isCR)
2687 if (pswit[ECHO_SWITCH])
2688 printf("\n%s\n",theline);
2689 if (!pswit[OVERVIEW_SWITCH])
2690 printf(" Line %ld column %d - CR without LF?\n",
2700 c=cint=fgetc(thefile);
2701 } while(len<maxlen);
2702 if (pswit[MARKUP_SWITCH])
2703 postprocess_for_HTML(theline);
2704 if (pswit[DP_SWITCH])
2705 postprocess_for_DP(theline);
2712 * Takes a "word" as a parameter, and checks whether it
2713 * contains a mixture of alpha and digits. Generally, this is an
2714 * error, but may not be for cases like 4th or L5 12s. 3d.
2716 * Returns: 0 if no error found, 1 if error.
2718 int mixdigit(char *checkword)
2720 int wehaveadigit,wehavealetter,firstdigits,query,wl;
2722 wehaveadigit=wehavealetter=query=0;
2723 for (s=checkword;*s;s++)
2729 if (wehaveadigit && wehavealetter)
2731 /* Now exclude common legit cases, like "21st" and "12l. 3s. 11d." */
2733 wl=strlen(checkword);
2734 for (firstdigits=0;gcisdigit(checkword[firstdigits]);firstdigits++)
2736 /* digits, ending in st, rd, nd, th of either case */
2737 if (firstdigits+2==wl && (matchword(checkword+wl-2,"st") ||
2738 matchword(checkword+wl-2,"rd") || matchword(checkword+wl-2,"nd") ||
2739 matchword(checkword+wl-2,"th")))
2741 if (firstdigits+3==wl && (matchword(checkword+wl-3,"sts") ||
2742 matchword(checkword+wl-3,"rds") || matchword(checkword+wl-3,"nds") ||
2743 matchword(checkword+wl-3,"ths")))
2745 if (firstdigits+3==wl && (matchword(checkword+wl-4,"stly") ||
2746 matchword(checkword+wl-4,"rdly") ||
2747 matchword(checkword+wl-4,"ndly") || matchword(checkword+wl-4,"thly")))
2749 /* digits, ending in l, L, s or d */
2750 if (firstdigits+1==wl && (checkword[wl-1]=='l' ||
2751 checkword[wl-1]=='L' || checkword[wl-1]=='s' || checkword[wl-1]=='d'))
2754 * L at the start of a number, representing Britsh pounds, like L500.
2755 * This is cute. We know the current word is mixeddigit. If the first
2756 * letter is L, there must be at least one digit following. If both
2757 * digits and letters follow, we have a genuine error, else we have a
2758 * capital L followed by digits, and we accept that as a non-error.
2760 if (checkword[0]=='L' && !mixdigit(checkword+1))
2769 * Extracts the first/next "word" from the line, and puts
2770 * it into "thisword". A word is defined as one English word unit--or
2771 * at least that's the aim.
2773 * Returns: a pointer to the position in the line where we will start
2774 * looking for the next word.
2776 const char *getaword(const char *fromline,char *thisword)
2781 for (;!gcisdigit(*fromline) && !gcisalpha(*fromline) && *fromline;
2785 * Use a look-ahead to handle exceptions for numbers like 1,000 and 1.35.
2786 * Especially yucky is the case of L1,000
2787 * This section looks for a pattern of characters including a digit
2788 * followed by a comma or period followed by one or more digits.
2789 * If found, it returns this whole pattern as a word; otherwise we discard
2790 * the results and resume our normal programming.
2793 for (;(gcisdigit(*s) || gcisalpha(*s) || *s==',' || *s=='.') &&
2794 wordlen<MAXWORDLEN;s++)
2796 thisword[wordlen]=*s;
2799 thisword[wordlen]=0;
2800 for (i=1;i<wordlen-1;i++)
2802 if (thisword[i]=='.' || thisword[i]==',')
2804 if (gcisdigit(thisword[i-1]) && gcisdigit(thisword[i-1]))
2811 /* we didn't find a punctuated number - do the regular getword thing */
2813 for (;(gcisdigit(*fromline) || gcisalpha(*fromline) || *fromline=='\'') &&
2814 wordlen<MAXWORDLEN;fromline++)
2816 thisword[wordlen]=*fromline;
2819 thisword[wordlen]=0;
2826 * A case-insensitive string matcher.
2828 int matchword(char *checkfor,char *thisword)
2830 unsigned int ismatch,i;
2831 if (strlen(checkfor)!=strlen(thisword))
2833 ismatch=1; /* assume a match until we find a difference */
2834 for (i=0;i<strlen(checkfor);i++)
2835 if (toupper(checkfor[i])!=toupper(thisword[i]))
2843 * Lowercase the line.
2846 void lowerit(char *theline)
2848 for (;*theline;theline++)
2849 if (*theline>='A' && *theline<='Z')
2856 * Is this word a Roman Numeral?
2858 * It doesn't actually validate that the number is a valid Roman Numeral--for
2859 * example it will pass MXXXXXXXXXX as a valid Roman Numeral, but that's not
2860 * what we're here to do. If it passes this, it LOOKS like a Roman numeral.
2861 * Anyway, the actual Romans were pretty tolerant of bad arithmetic, or
2862 * expressions thereof, except when it came to taxes. Allow any number of M,
2863 * an optional D, an optional CM or CD, any number of optional Cs, an optional
2864 * XL or an optional XC, an optional IX or IV, an optional V and any number
2867 int isroman(char *t)
2873 while (*t=='m' && *t)
2877 if (*t=='c' && t[1]=='m')
2879 if (*t=='c' && t[1]=='d')
2881 while (*t=='c' && *t)
2883 if (*t=='x' && t[1]=='l')
2885 if (*t=='x' && t[1]=='c')
2889 while (*t=='x' && *t)
2891 if (*t=='i' && t[1]=='x')
2893 if (*t=='i' && t[1]=='v')
2897 while (*t=='i' && *t)
2905 * A version of isalpha() that is somewhat lenient on 8-bit texts.
2906 * If we use the standard function, 8-bit accented characters break
2907 * words, so that tete with accented characters appears to be two words, "t"
2908 * and "t", with 8-bit characters between them. This causes over-reporting of
2909 * errors. gcisalpha() recognizes accented letters from the CP1252 (Windows)
2910 * and ISO-8859-1 character sets, which are the most common PG 8-bit types.
2912 int gcisalpha(unsigned char c)
2914 if (c>='a' && c<='z')
2916 if (c>='A' && c<='Z')
2920 if (c>=192 && c!=208 && c!=215 && c!=222 && c!=240 && c!=247 && c!=254)
2922 if (c==140 || c==142 || c==156 || c==158 || c==159)
2930 * A version of isdigit() that doesn't get confused in 8-bit texts.
2932 int gcisdigit(unsigned char c)
2934 return c>='0' && c<='9';
2940 * A version of isletter() that doesn't get confused in 8-bit texts.
2941 * NB: this is ISO-8891-1-specific.
2943 int gcisletter(unsigned char c)
2945 return c>='A' && c<='Z' || c>='a' && c<='z' || c>=192;
2951 * Wraps strchr to return NULL if the character being searched for is zero.
2953 char *gcstrchr(char *s,char c)
2961 * postprocess_for_DP:
2963 * Invoked with the -d switch from flgets().
2964 * It simply "removes" from the line a hard-coded set of common
2965 * DP-specific tags, so that the line passed to the main routine has
2966 * been pre-cleaned of DP markup.
2968 void postprocess_for_DP(char *theline)
2974 for (i=0;*DPmarkup[i];i++)
2976 s=strstr(theline,DPmarkup[i]);
2979 t=s+strlen(DPmarkup[i]);
2987 s=strstr(theline,DPmarkup[i]);
2993 * postprocess_for_HTML:
2995 * Invoked with the -m switch from flgets().
2996 * It simply "removes" from the line a hard-coded set of common
2997 * HTML tags and "replaces" a hard-coded set of common HTML
2998 * entities, so that the line passed to the main routine has
2999 * been pre-cleaned of HTML.
3001 void postprocess_for_HTML(char *theline)
3003 if (strstr(theline,"<") && strstr(theline,">"))
3004 while (losemarkup(theline))
3006 while (loseentities(theline))
3010 char *losemarkup(char *theline)
3016 s=strstr(theline,"<");
3017 t=strstr(theline,">");
3020 for (i=0;*markup[i];i++)
3021 if (!tagcomp(s+1,markup[i]))
3034 /* It's an unrecognized <xxx>. */
3038 char *loseentities(char *theline)
3044 for (i=0;*entities[i].htmlent;i++)
3046 s=strstr(theline,entities[i].htmlent);
3049 t=malloc((size_t)strlen(s));
3052 strcpy(t,s+strlen(entities[i].htmlent));
3053 strcpy(s,entities[i].textent);
3059 for (i=0;*entities[i].htmlnum;i++)
3061 s=strstr(theline,entities[i].htmlnum);
3064 t=malloc((size_t)strlen(s));
3067 strcpy(t,s+strlen(entities[i].htmlnum));
3068 strcpy(s,entities[i].textent);
3077 int tagcomp(char *strin,char *basetag)
3083 t++; /* ignore a slash */
3086 if (tolower(*s)!=tolower(*t))
3096 fputs("Bookloupe version " PACKAGE_VERSION ".\n",stderr);
3097 fputs("Copyright 2000-2005 Jim Tinsley <jtinsley@pobox.com>.\n",stderr);
3098 fputs("Copyright 2012- J. Ali Harlow <ali@juiblex.co.uk>.\n",stderr);
3099 fputs("Bookloupe comes wih ABSOLUTELY NO WARRANTY. "
3100 "For details, read the file COPYING.\n",stderr);
3101 fputs("This is Free Software; "
3102 "you may redistribute it under certain conditions (GPL);\n",stderr);
3103 fputs("read the file COPYING for details.\n\n",stderr);
3104 fputs("Usage is: bookloupe [-setpxloyhud] filename\n",stderr);
3105 fputs(" where -s checks single quotes, -e suppresses echoing lines, "
3106 "-t checks typos\n",stderr);
3107 fputs(" -x (paranoid) switches OFF -t and extra checks, "
3108 "-l turns OFF line-end checks\n",stderr);
3109 fputs(" -o just displays overview without detail, "
3110 "-h echoes header fields\n",stderr);
3111 fputs(" -v (verbose) unsuppresses duplicate reporting, "
3112 "-m suppresses markup\n",stderr);
3113 fputs(" -d ignores DP-specific markup,\n",stderr);
3114 fputs(" -u uses a file gutcheck.typ to query user-defined "
3115 "possible typos\n",stderr);
3116 fputs("Sample usage: bookloupe warpeace.txt \n",stderr);
3118 fputs("Bookloupe looks for errors in Project Gutenberg(TM) etexts.\n",
3120 fputs("Bookloupe queries anything it thinks shouldn't be in a PG text; "
3121 "non-ASCII\n",stderr);
3122 fputs("characters like accented letters, "
3123 "lines longer than 75 or shorter than 55,\n",stderr);
3124 fputs("unbalanced quotes or brackets, "
3125 "a variety of badly formatted punctuation, \n",stderr);
3126 fputs("HTML tags, some likely typos. "
3127 "It is NOT a substitute for human judgement.\n",stderr);