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 char *getaword(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 char qperiod[MAX_QWORD][MAX_QWORD_LENGTH];
383 signed int dupcnt[MAX_QWORD];
385 int main(int argc,char **argv)
389 char usertypo_file[MAX_PATH];
391 if (strlen(argv[0])<sizeof(running_from))
392 /* save the path to the executable */
393 strcpy(running_from,argv[0]);
394 /* find out what directory we're running from */
395 s=running_from+strlen(running_from);
396 for (;*s!='/' && *s!='\\' && s>=running_from;s--)
398 switno=strlen(SWITCHES);
399 for (i=switno;--i>0;)
400 pswit[i]=0; /* initialise switches */
402 * Standard loop to extract switches.
403 * When we come out of this loop, the arguments will be
404 * in argv[0] upwards and the switches used will be
405 * represented by their equivalent elements in pswit[]
407 while (--argc>0 && **++argv=='-')
408 for (argsw=argv[0]+1;*argsw!='\0';argsw++)
409 for (i=switno,invarg=1;(--i>=0) && invarg==1;)
410 if ((toupper(*argsw))==SWITCHES[i])
415 /* Paranoid checking is turned OFF, not on, by its switch */
416 pswit[PARANOID_SWITCH]^=1;
417 if (pswit[PARANOID_SWITCH])
418 /* if running in paranoid mode force typo checks as well */
419 pswit[TYPO_SWITCH]=pswit[TYPO_SWITCH]^1;
420 /* Line-end checking is turned OFF, not on, by its switch */
421 pswit[LINE_END_SWITCH]^=1;
422 /* Echoing is turned OFF, not on, by its switch */
423 pswit[ECHO_SWITCH]^=1;
424 if (pswit[OVERVIEW_SWITCH])
425 /* just print summary; don't echo */
426 pswit[ECHO_SWITCH]=0;
428 * Web uploads - for the moment, this is really just a placeholder
429 * until we decide what processing we really want to do on web uploads
431 if (pswit[WEB_SWITCH])
433 /* specific override for web uploads */
434 pswit[ECHO_SWITCH]=1;
435 pswit[SQUOTE_SWITCH]=0;
436 pswit[TYPO_SWITCH]=1;
437 pswit[QPARA_SWITCH]=0;
438 pswit[PARANOID_SWITCH]=1;
439 pswit[LINE_END_SWITCH]=0;
440 pswit[OVERVIEW_SWITCH]=0;
441 pswit[STDOUT_SWITCH]=0;
442 pswit[HEADER_SWITCH]=1;
443 pswit[VERBOSE_SWITCH]=0;
444 pswit[MARKUP_SWITCH]=0;
445 pswit[USERTYPO_SWITCH]=0;
448 if (argc<MINARGS || argc>MAXARGS)
450 /* check number of args */
454 /* read in the user-defined stealth scanno list */
455 if (pswit[USERTYPO_SWITCH])
457 /* ... we were told we had one! */
458 usertypofile=fopen(USERTYPO_FILE,"rb");
461 /* not in cwd. try excuteable directory. */
462 strcpy(usertypo_file,running_from);
463 strcat(usertypo_file,USERTYPO_FILE);
464 usertypofile=fopen(usertypo_file,"rb");
466 /* we ain't got no user typo file! */
467 printf(" --> I couldn't find gutcheck.typ "
468 "-- proceeding without user typos.\n");
474 /* we managed to open a User Typo File! */
475 if (pswit[USERTYPO_SWITCH])
477 while (flgets(aline,LINEBUFSIZE-1,usertypofile,
478 (long)usertypo_count))
484 s=malloc(strlen(aline)+1);
487 fprintf(stderr,"bookloupe: cannot get enough "
488 "memory for user typo file!\n");
492 usertypo[usertypo_count]=s;
494 if (usertypo_count>=MAX_USER_TYPOS)
496 printf(" --> Only %d user-defined typos "
497 "allowed: ignoring the rest\n",
505 fclose(usertypofile);
508 fprintf(stderr,"bookloupe: Check and report on an e-text\n");
509 cnt_dquot=cnt_squot=cnt_brack=cnt_bin=cnt_odd=cnt_long=
510 cnt_short=cnt_punct=cnt_dash=cnt_word=cnt_html=cnt_lineend=
513 if (pswit[OVERVIEW_SWITCH])
515 printf(" Checked %ld lines of %ld (head+foot = %ld)\n\n",
516 checked_linecnt,linecnt,linecnt-checked_linecnt);
517 printf(" --------------- Queries found --------------\n");
519 printf(" Long lines: %14ld\n",cnt_long);
521 printf(" Short lines: %14ld\n",cnt_short);
523 printf(" Line-end problems: %14ld\n",cnt_lineend);
525 printf(" Common typos: %14ld\n",cnt_word);
527 printf(" Unmatched quotes: %14ld\n",cnt_dquot);
529 printf(" Unmatched SingleQuotes: %14ld\n",cnt_squot);
531 printf(" Unmatched brackets: %14ld\n",cnt_brack);
533 printf(" Non-ASCII characters: %14ld\n",cnt_bin);
535 printf(" Proofing characters: %14ld\n",cnt_odd);
537 printf(" Punctuation & spacing queries: %14ld\n",cnt_punct);
539 printf(" Non-standard dashes: %14ld\n",cnt_dash);
541 printf(" Possible HTML tags: %14ld\n",cnt_html);
543 printf(" TOTAL QUERIES %14ld\n",
544 cnt_dquot+cnt_squot+cnt_brack+cnt_bin+cnt_odd+cnt_long+
545 cnt_short+cnt_punct+cnt_dash+cnt_word+cnt_html+cnt_lineend);
550 struct first_pass_results {
551 long firstline,astline;
552 long footerline,totlen,binlen,alphalen,endquote_count,shortline,dotcomma;
553 long fslashline,hyphens,longline,verylongline,htmcount,standalone_digit;
554 long spacedash,emdash,space_emdash,non_PG_space_emdash,PG_space_emdash;
555 signed int Dutchcount,Frenchcount;
561 * Run a first pass - verify that it's a valid PG
562 * file, decide whether to report some things that
563 * occur many times in the text like long or short
564 * lines, non-standard dashes, etc.
566 struct first_pass_results *first_pass(FILE *infile)
568 char laststart=CHAR_SPACE,*s;
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)
999 void procfile(char *filename)
1001 char *s,*t,*s1,laststart,*wordstart;
1002 char inword[MAXWORDLEN],testword[MAXWORDLEN];
1003 char parastart[81]; /* first line of current para */
1005 struct first_pass_results *first_pass_results;
1006 struct warnings *warnings;
1007 struct counters counters={0};
1009 long squot,start_para_line;
1010 signed int i,j,llen,isacro,isellipsis,istypo,alower,
1011 eNon_A,eTab,eTilde,eAst,eFSlash,eCarat;
1012 unsigned int lastlen,lastblen;
1013 signed int dquotepar,squotepar;
1014 signed int isnewpara,vowel,consonant;
1015 char dquote_err[80],squote_err[80],rbrack_err[80],sbrack_err[80],
1016 cbrack_err[80],unders_err[80];
1017 signed int qword_index,qperiod_index,isdup;
1019 laststart=CHAR_SPACE;
1021 *dquote_err=*squote_err=*rbrack_err=*cbrack_err=*sbrack_err=
1022 *unders_err=*prevline=0;
1023 linecnt=checked_linecnt=start_para_line=0;
1025 i=llen=isacro=isellipsis=istypo=0;
1026 isnewpara=vowel=consonant=enddash=0;
1027 qword_index=qperiod_index=isdup=0;
1028 *inword=*testword=0;
1029 dquotepar=squotepar=0;
1030 for (j=0;j<MAX_QWORD;j++)
1033 for (i=0;i<MAX_QWORD_LENGTH;i++)
1039 infile=fopen(filename,"rb");
1042 if (pswit[STDOUT_SWITCH])
1043 fprintf(stdout,"bookloupe: cannot open %s\n",filename);
1045 fprintf(stderr,"bookloupe: cannot open %s\n",filename);
1048 fprintf(stdout,"\n\nFile: %s\n\n",filename);
1049 first_pass_results=first_pass(infile);
1050 warnings=report_first_pass(first_pass_results);
1053 * Here we go with the main pass. Hold onto yer hat!
1054 * Re-init some variables we've dirtied.
1057 laststart=CHAR_SPACE;
1059 while (flgets(aline,LINEBUFSIZE-1,infile,linecnt+1))
1064 if (pswit[DP_SWITCH] && !strncmp(aline,"-----File: ",11))
1065 continue; // skip DP page separators completely
1066 if (linecnt<first_pass_results->firstline ||
1067 (first_pass_results->footerline>0 &&
1068 linecnt>first_pass_results->footerline))
1070 if (pswit[HEADER_SWITCH])
1072 if (!strncmp(aline,"Title:",6))
1073 printf(" %s\n",aline);
1074 if (!strncmp(aline,"Author:",7))
1075 printf(" %s\n",aline);
1076 if (!strncmp(aline,"Release Date:",13))
1077 printf(" %s\n",aline);
1078 if (!strncmp(aline,"Edition:",8))
1079 printf(" %s\n\n",aline);
1081 continue; /* skip through the header */
1086 * If we are in a state of unbalanced quotes, and this line
1087 * doesn't begin with a quote, output the stored error message.
1088 * If the -P switch was used, print the warning even if the
1089 * new para starts with quotes.
1095 if (*t!=CHAR_DQUOTE || pswit[QPARA_SWITCH])
1097 if (!pswit[OVERVIEW_SWITCH])
1099 if (pswit[ECHO_SWITCH])
1100 printf("\n%s\n",parastart);
1108 if (*t!=CHAR_SQUOTE && *t!=CHAR_OPEN_SQUOTE ||
1109 pswit[QPARA_SWITCH] || squot)
1111 if (!pswit[OVERVIEW_SWITCH])
1113 if (pswit[ECHO_SWITCH])
1114 printf("\n%s\n",parastart);
1124 if (!pswit[OVERVIEW_SWITCH])
1126 if (pswit[ECHO_SWITCH])
1127 printf("\n%s\n",parastart);
1135 if (!pswit[OVERVIEW_SWITCH])
1137 if (pswit[ECHO_SWITCH])
1138 printf("\n%s\n",parastart);
1146 if (!pswit[OVERVIEW_SWITCH])
1148 if (pswit[ECHO_SWITCH])
1149 printf("\n%s\n",parastart);
1157 if (!pswit[OVERVIEW_SWITCH])
1159 if (pswit[ECHO_SWITCH])
1160 printf("\n%s\n",parastart);
1166 *dquote_err=*squote_err=*rbrack_err=*cbrack_err=
1167 *sbrack_err=*unders_err=0;
1168 isemptyline=analyse_quotes(aline,&counters);
1169 if (isnewpara && !isemptyline)
1171 /* This line is the start of a new paragraph. */
1172 start_para_line=linecnt;
1173 /* Capture its first line in case we want to report it later. */
1174 strncpy(parastart,aline,80);
1176 dquotepar=squotepar=0; /* restart the quote count */
1178 while (!gcisalpha(*s) && !gcisdigit(*s) && *s)
1180 if (*s>='a' && *s<='z')
1182 /* and its first letter is lowercase */
1183 if (pswit[ECHO_SWITCH])
1184 printf("\n%s\n",aline);
1185 if (!pswit[OVERVIEW_SWITCH])
1186 printf(" Line %ld column %d - "
1187 "Paragraph starts with lower-case\n",
1188 linecnt,(int)(s-aline)+1);
1192 isnewpara=0; /* Signal the end of new para processing. */
1194 /* Check for an em-dash broken at line end. */
1195 if (enddash && *aline=='-')
1197 if (pswit[ECHO_SWITCH])
1198 printf("\n%s\n",aline);
1199 if (!pswit[OVERVIEW_SWITCH])
1200 printf(" Line %ld column 1 - Broken em-dash?\n",linecnt);
1205 for (s=aline+strlen(aline)-1;*s==' ' && s>aline;s--)
1207 if (s>=aline && *s=='-')
1210 * Check for invalid or questionable characters in the line
1211 * Anything above 127 is invalid for plain ASCII, and
1212 * non-printable control characters should also be flagged.
1213 * Tabs should generally not be there.
1215 for (s=aline;*s;s++)
1217 i=(unsigned char)*s;
1218 if (i<CHAR_SPACE && i!=CHAR_LF && i!=CHAR_CR && i!=CHAR_TAB)
1220 if (pswit[ECHO_SWITCH])
1221 printf("\n%s\n",aline);
1222 if (!pswit[OVERVIEW_SWITCH])
1223 printf(" Line %ld column %d - Control character %d\n",
1224 linecnt,(int)(s-aline)+1,i);
1231 /* Don't repeat multiple warnings on one line. */
1232 eNon_A=eTab=eTilde=eCarat=eFSlash=eAst=0;
1233 for (s=aline;*s;s++)
1236 (*s<CHAR_SPACE && *s!=9 && *s!='\n' || (unsigned char)*s>127))
1238 i=*s; /* annoying kludge for signed chars */
1241 if (pswit[ECHO_SWITCH])
1242 printf("\n%s\n",aline);
1243 if (!pswit[OVERVIEW_SWITCH])
1245 printf(" Line %ld column %d - "
1246 "Non-ISO-8859 character %d\n",
1247 linecnt,(int)(s-aline)+1,i);
1249 printf(" Line %ld column %d - "
1250 "Non-ASCII character %d\n",
1251 linecnt,(int)(s-aline)+1,i);
1256 if (!eTab && *s==CHAR_TAB)
1258 if (pswit[ECHO_SWITCH])
1259 printf("\n%s\n",aline);
1260 if (!pswit[OVERVIEW_SWITCH])
1261 printf(" Line %ld column %d - Tab character?\n",
1262 linecnt,(int)(s-aline)+1);
1267 if (!eTilde && *s==CHAR_TILDE)
1270 * Often used by OCR software to indicate an
1271 * unrecognizable character.
1273 if (pswit[ECHO_SWITCH])
1274 printf("\n%s\n",aline);
1275 if (!pswit[OVERVIEW_SWITCH])
1276 printf(" Line %ld column %d - Tilde character?\n",
1277 linecnt,(int)(s-aline)+1);
1282 if (!eCarat && *s==CHAR_CARAT)
1284 if (pswit[ECHO_SWITCH])
1285 printf("\n%s\n",aline);
1286 if (!pswit[OVERVIEW_SWITCH])
1287 printf(" Line %ld column %d - Carat character?\n",
1288 linecnt,(int)(s-aline)+1);
1293 if (!eFSlash && *s==CHAR_FORESLASH && warnings->fslash)
1295 if (pswit[ECHO_SWITCH])
1296 printf("\n%s\n",aline);
1297 if (!pswit[OVERVIEW_SWITCH])
1298 printf(" Line %ld column %d - Forward slash?\n",
1299 linecnt,(int)(s-aline)+1);
1305 * Report asterisks only in paranoid mode,
1306 * since they're often deliberate.
1308 if (!eAst && pswit[PARANOID_SWITCH] && warnings->ast &&
1309 !isemptyline && *s==CHAR_ASTERISK)
1311 if (pswit[ECHO_SWITCH])
1312 printf("\n%s\n",aline);
1313 if (!pswit[OVERVIEW_SWITCH])
1314 printf(" Line %ld column %d - Asterisk?\n",
1315 linecnt,(int)(s-aline)+1);
1322 /* Check for line too long. */
1323 if (warnings->longline)
1325 if (strlen(aline)>LONGEST_PG_LINE)
1327 if (pswit[ECHO_SWITCH])
1328 printf("\n%s\n",aline);
1329 if (!pswit[OVERVIEW_SWITCH])
1330 printf(" Line %ld column %d - Long line %d\n",
1331 linecnt,strlen(aline),strlen(aline));
1337 * Check for line too short.
1338 * This one is a bit trickier to implement: we don't want to
1339 * flag the last line of a paragraph for being short, so we
1340 * have to wait until we know that our current line is a
1341 * "normal" line, then report the _previous_ line if it was too
1342 * short. We also don't want to report indented lines like
1343 * chapter heads or formatted quotations. We therefore keep
1344 * lastlen as the length of the last line examined, and
1345 * lastblen as the length of the last but one, and try to
1346 * suppress unnecessary warnings by checking that both were of
1347 * "normal" length. We keep the first character of the last
1348 * line in laststart, and if it was a space, we assume that the
1349 * formatting is deliberate. I can't figure out a way to
1350 * distinguish something like a quoted verse left-aligned or
1351 * the header or footer of a letter from a paragraph of short
1352 * lines - maybe if I examined the whole paragraph, and if the
1353 * para has less than, say, 8 lines and if all lines are short,
1354 * then just assume it's OK? Need to look at some texts to see
1355 * how often a formula like this would get the right result.
1357 if (warnings->shortline && strlen(aline)>1 && lastlen>1 &&
1358 lastlen<SHORTEST_PG_LINE && lastblen>1 && lastblen>SHORTEST_PG_LINE &&
1359 laststart!=CHAR_SPACE)
1361 if (pswit[ECHO_SWITCH])
1362 printf("\n%s\n",prevline);
1363 if (!pswit[OVERVIEW_SWITCH])
1364 printf(" Line %ld column %d - Short line %d?\n",
1365 linecnt-1,strlen(prevline),strlen(prevline));
1370 lastlen=strlen(aline);
1372 /* Look for punctuation other than full ellipses at start of line. */
1373 if (*aline && strchr(".?!,;:",aline[0]) && strncmp(". . .",aline,5))
1375 if (pswit[ECHO_SWITCH])
1376 printf("\n%s\n",aline);
1377 if (!pswit[OVERVIEW_SWITCH])
1378 printf(" Line %ld column 1 - Begins with punctuation?\n",
1384 * Check for spaced em-dashes.
1385 * We must check _all_ occurrences of "--" on the line
1386 * hence the loop - even if the first double-dash is OK
1387 * there may be another that's wrong later on.
1392 while (strstr(s,"--"))
1394 if (*(strstr(s,"--")-1)==CHAR_SPACE ||
1395 (*(strstr(s,"--")+2)==CHAR_SPACE))
1397 if (pswit[ECHO_SWITCH])
1398 printf("\n%s\n",aline);
1399 if (!pswit[OVERVIEW_SWITCH])
1400 printf(" Line %ld column %d - Spaced em-dash?\n",
1401 linecnt,(int)(strstr(s,"--")-aline)+1);
1408 /* Check for spaced dashes. */
1411 if (strstr(aline," -"))
1413 if (*(strstr(aline," -")+2)!='-')
1415 if (pswit[ECHO_SWITCH])
1416 printf("\n%s\n",aline);
1417 if (!pswit[OVERVIEW_SWITCH])
1418 printf(" Line %ld column %d - Spaced dash?\n",
1419 linecnt,(int)(strstr(aline," -")-aline)+1);
1424 else if (strstr(aline,"- "))
1426 if (*(strstr(aline,"- ")-1)!='-')
1428 if (pswit[ECHO_SWITCH])
1429 printf("\n%s\n",aline);
1430 if (!pswit[OVERVIEW_SWITCH])
1431 printf(" Line %ld column %d - Spaced dash?\n",
1432 linecnt,(int)(strstr(aline,"- ")-aline)+1);
1439 * Check for unmarked paragraphs indicated by separate speakers.
1440 * May well be false positive:
1441 * "Bravo!" "Wonderful!" called the crowd.
1442 * but useful all the same.
1446 if (strstr(aline,"\" \""))
1447 s=strstr(aline,"\" \"");
1448 if (strstr(aline,"\" \""))
1449 s=strstr(aline,"\" \"");
1452 if (pswit[ECHO_SWITCH])
1453 printf("\n%s\n",aline);
1454 if (!pswit[OVERVIEW_SWITCH])
1455 printf(" Line %ld column %d - "
1456 "Query missing paragraph break?\n",
1457 linecnt,(int)(s-aline)+1);
1462 * Check for "to he" and other easy he/be errors.
1463 * This is a very inadequate effort on the he/be problem,
1464 * but the phrase "to he" is always an error, whereas "to
1465 * be" is quite common.
1466 * Similarly, '"Quiet!", be said.' is a non-be error
1467 * "to he" is _not_ always an error!:
1468 * "Where they went to he couldn't say."
1469 * Another false positive:
1470 * What would "Cinderella" be without the . . .
1471 * and another: "If he wants to he can see for himself."
1475 if (strstr(aline," to he "))
1476 s=strstr(aline," to he ");
1477 if (strstr(aline,"\" be "))
1478 s=strstr(aline,"\" be ");
1479 if (strstr(aline,"\", be "))
1480 s=strstr(aline,"\", be ");
1481 if (strstr(aline," is be "))
1482 s=strstr(aline," is be ");
1483 if (strstr(aline," be is "))
1484 s=strstr(aline," be is ");
1485 if (strstr(aline," was be "))
1486 s=strstr(aline," was be ");
1487 if (strstr(aline," be would "))
1488 s=strstr(aline," be would ");
1489 if (strstr(aline," be could "))
1490 s=strstr(aline," be could ");
1493 if (pswit[ECHO_SWITCH])
1494 printf("\n%s\n",aline);
1495 if (!pswit[OVERVIEW_SWITCH])
1496 printf(" Line %ld column %d - Query he/be error?\n",
1497 linecnt,(int)(s-aline)+1);
1503 if (strstr(aline," i bad "))
1504 s=strstr(aline," i bad ");
1505 if (strstr(aline," you bad "))
1506 s=strstr(aline," you bad ");
1507 if (strstr(aline," he bad "))
1508 s=strstr(aline," he bad ");
1509 if (strstr(aline," she bad "))
1510 s=strstr(aline," she bad ");
1511 if (strstr(aline," they bad "))
1512 s=strstr(aline," they bad ");
1513 if (strstr(aline," a had "))
1514 s=strstr(aline," a had ");
1515 if (strstr(aline," the had "))
1516 s=strstr(aline," the had ");
1519 if (pswit[ECHO_SWITCH])
1520 printf("\n%s\n",aline);
1521 if (!pswit[OVERVIEW_SWITCH])
1522 printf(" Line %ld column %d - Query had/bad error?\n",
1523 linecnt,(int)(s-aline)+1);
1529 if (strstr(aline,", hut "))
1530 s=strstr(aline,", hut ");
1531 if (strstr(aline,"; hut "))
1532 s=strstr(aline,"; hut ");
1535 if (pswit[ECHO_SWITCH])
1536 printf("\n%s\n",aline);
1537 if (!pswit[OVERVIEW_SWITCH])
1538 printf(" Line %ld column %d - Query hut/but error?\n",
1539 linecnt,(int)(s-aline)+1);
1544 * Special case - angled bracket in front of "From" placed there by an
1545 * MTA when sending an e-mail.
1547 if (strstr(aline,">From"))
1549 if (pswit[ECHO_SWITCH])
1550 printf("\n%s\n",aline);
1551 if (!pswit[OVERVIEW_SWITCH])
1552 printf(" Line %ld column %d - "
1553 "Query angled bracket with From\n",
1554 linecnt,(int)(strstr(aline,">From")-aline)+1);
1559 * Check for a single character line -
1560 * often an overflow from bad wrapping.
1562 if (*aline && !aline[1])
1564 if (*aline=='I' || *aline=='V' || *aline=='X' || *aline=='L' ||
1566 ; /* Nothing - ignore numerals alone on a line. */
1569 if (pswit[ECHO_SWITCH])
1570 printf("\n%s\n",aline);
1571 if (!pswit[OVERVIEW_SWITCH])
1572 printf(" Line %ld column 1 - "
1573 "Query single character line\n",linecnt);
1578 /* Check for I" - often should be ! */
1579 if (strstr(aline," I\""))
1581 if (pswit[ECHO_SWITCH])
1582 printf("\n%s\n",aline);
1583 if (!pswit[OVERVIEW_SWITCH])
1584 printf(" Line %ld column %ld - Query I=exclamation mark?\n",
1585 linecnt,strstr(aline," I\"")-aline);
1590 * Check for period without a capital letter. Cut-down from gutspell.
1591 * Only works when it happens on a single line.
1593 if (pswit[PARANOID_SWITCH])
1595 for (t=s=aline;strstr(t,". ");)
1601 /* start of line punctuation is handled elsewhere */
1604 if (!gcisalpha(t[-1]))
1609 if (warnings->isDutch)
1611 /* For Frank & Jeroen -- 's Middags case */
1612 if (t[2]==CHAR_SQUOTE && t[3]>='a' && t[3]<='z' &&
1613 t[4]==CHAR_SPACE && t[5]>='A' && t[5]<='Z')
1620 while (*s1 && !gcisalpha(*s1) && !isdigit(*s1))
1622 if (*s1>='a' && *s1<='z')
1624 /* we have something to investigate */
1626 /* so let's go back and find out */
1627 for (s1=t-1;s1>=s &&
1628 (gcisalpha(*s1) || gcisdigit(*s1) || *s1==CHAR_SQUOTE &&
1629 gcisalpha(s1[1]) && gcisalpha(s1[-1]));s1--)
1632 for (i=0;*s1 && *s1!='.';s1++,i++)
1635 for (i=0;*abbrev[i];i++)
1636 if (!strcmp(testword,abbrev[i]))
1638 if (gcisdigit(*testword))
1642 if (isroman(testword))
1647 for (i=0;testword[i];i++)
1648 if (strchr(vowels,testword[i]))
1654 if (strlen(testword)<MAX_QWORD_LENGTH &&
1655 !pswit[VERBOSE_SWITCH])
1656 for (i=0;i<qperiod_index;i++)
1657 if (!strcmp(testword,qperiod[i]))
1661 if (qperiod_index<MAX_QWORD &&
1662 strlen(testword)<MAX_QWORD_LENGTH)
1664 strcpy(qperiod[qperiod_index],testword);
1667 if (pswit[ECHO_SWITCH])
1668 printf("\n%s\n",aline);
1669 if (!pswit[OVERVIEW_SWITCH])
1670 printf(" Line %ld column %d - "
1671 "Extra period?\n",linecnt,(int)(t-aline)+1);
1680 if (pswit[TYPO_SWITCH])
1682 /* Check for words usually not followed by punctuation. */
1686 s=getaword(s,inword);
1690 for (i=0;*nocomma[i];i++)
1691 if (!strcmp(inword,nocomma[i]))
1693 if (*s==',' || *s==';' || *s==':')
1695 if (pswit[ECHO_SWITCH])
1696 printf("\n%s\n",aline);
1697 if (!pswit[OVERVIEW_SWITCH])
1698 printf(" Line %ld column %d - "
1699 "Query punctuation after %s?\n",
1700 linecnt,(int)(s-aline)+1,inword);
1705 for (i=0;*noperiod[i];i++)
1706 if (!strcmp(inword,noperiod[i]))
1708 if (*s=='.' || *s=='!')
1710 if (pswit[ECHO_SWITCH])
1711 printf("\n%s\n",aline);
1712 if (!pswit[OVERVIEW_SWITCH])
1713 printf(" Line %ld column %d - "
1714 "Query punctuation after %s?\n",
1715 linecnt,(int)(s-aline)+1,inword);
1723 * Check for commonly mistyped words,
1724 * and digits like 0 for O in a word.
1729 s=getaword(s,inword);
1731 continue; /* don't bother with empty lines */
1732 if (mixdigit(inword))
1734 if (pswit[ECHO_SWITCH])
1735 printf("\n%s\n",aline);
1736 if (!pswit[OVERVIEW_SWITCH])
1737 printf(" Line %ld column %d - Query digit in %s\n",
1738 linecnt,(int)(wordstart-aline)+1,inword);
1743 * Put the word through a series of tests for likely typos and OCR
1746 if (pswit[TYPO_SWITCH])
1749 strcpy(testword,inword);
1751 for (i=0;i<(signed int)strlen(testword);i++)
1753 /* lowercase for testing */
1754 if (testword[i]>='a' && testword[i]<='z')
1756 if (alower && testword[i]>='A' && testword[i]<='Z')
1759 * We have an uppercase mid-word. However, there are
1761 * Mac and Mc like McGill
1762 * French contractions like l'Abbe
1764 if (i==2 && testword[0]=='m' && testword[1]=='c' ||
1765 i==3 && testword[0]=='m' && testword[1]=='a' &&
1766 testword[2]=='c' || i>0 && testword[i-1]==CHAR_SQUOTE)
1771 testword[i]=(char)tolower(testword[i]);
1774 * Check for certain unlikely two-letter combinations at word
1777 if (strlen(testword)>1)
1779 for (i=0;*nostart[i];i++)
1780 if (!strncmp(testword,nostart[i],2))
1782 for (i=0;*noend[i];i++)
1783 if (!strncmp(testword+strlen(testword)-2,noend[i],2))
1786 /* ght is common, gbt never. Like that. */
1787 if (strstr(testword,"cb"))
1789 if (strstr(testword,"gbt"))
1791 if (strstr(testword,"pbt"))
1793 if (strstr(testword,"tbs"))
1795 if (strstr(testword,"mrn"))
1797 if (strstr(testword,"ahle"))
1799 if (strstr(testword,"ihle"))
1802 * "TBE" does happen - like HEARTBEAT - but uncommon.
1803 * Also "TBI" - frostbite, outbid - but uncommon.
1804 * Similarly "ii" like Hawaii, or Pompeii, and in Roman
1805 * numerals, but "ii" is a common scanno.
1807 if (strstr(testword,"tbi"))
1809 if (strstr(testword,"tbe"))
1811 if (strstr(testword,"ii"))
1814 * Check for no vowels or no consonants.
1815 * If none, flag a typo.
1817 if (!istypo && strlen(testword)>1)
1820 for (i=0;testword[i];i++)
1822 if (testword[i]=='y' || gcisdigit(testword[i]))
1824 /* Yah, this is loose. */
1828 else if (strchr(vowels,testword[i]))
1833 if (!vowel || !consonant)
1837 * Now exclude the word from being reported if it's in
1840 for (i=0;*okword[i];i++)
1841 if (!strcmp(testword,okword[i]))
1844 * What looks like a typo may be a Roman numeral.
1847 if (istypo && isroman(testword))
1849 /* Check the manual list of typos. */
1851 for (i=0;*typo[i];i++)
1852 if (!strcmp(testword,typo[i]))
1855 * Check lowercase s, l, i and m - special cases.
1856 * "j" - often a semi-colon gone wrong.
1857 * "d" for a missing apostrophe - he d
1860 if (!istypo && strlen(testword)==1 && strchr("slmijdn",*inword))
1865 if (strlen(testword)<MAX_QWORD_LENGTH &&
1866 !pswit[VERBOSE_SWITCH])
1867 for (i=0;i<qword_index;i++)
1868 if (!strcmp(testword,qword[i]))
1875 if (qword_index<MAX_QWORD &&
1876 strlen(testword)<MAX_QWORD_LENGTH)
1878 strcpy(qword[qword_index],testword);
1881 if (pswit[ECHO_SWITCH])
1882 printf("\n%s\n",aline);
1883 if (!pswit[OVERVIEW_SWITCH])
1885 printf(" Line %ld column %d - Query word %s",
1886 linecnt,(int)(wordstart-aline)+1,inword);
1887 if (strlen(testword)<MAX_QWORD_LENGTH &&
1888 !pswit[VERBOSE_SWITCH])
1889 printf(" - not reporting duplicates");
1897 /* check the user's list of typos */
1898 if (!istypo && usertypo_count)
1899 for (i=0;i<usertypo_count;i++)
1900 if (!strcmp(testword,usertypo[i]))
1902 if (pswit[ECHO_SWITCH])
1903 printf("\n%s\n",aline);
1904 if (!pswit[OVERVIEW_SWITCH])
1905 printf(" Line %ld column %d - "
1906 "Query possible scanno %s\n",
1907 linecnt,(int)(wordstart-aline)+2,inword);
1909 if (pswit[PARANOID_SWITCH] && warnings->digit)
1911 /* In paranoid mode, query all 0 and 1 standing alone. */
1912 if (!strcmp(inword,"0") || !strcmp(inword,"1"))
1914 if (pswit[ECHO_SWITCH])
1915 printf("\n%s\n",aline);
1916 if (!pswit[OVERVIEW_SWITCH])
1917 printf(" Line %ld column %d - Query standalone %s\n",
1918 linecnt,(int)(wordstart-aline)+2,inword);
1925 * Look for added or missing spaces around punctuation and quotes.
1926 * If there is a punctuation character like ! with no space on
1927 * either side, suspect a missing!space. If there are spaces on
1928 * both sides , assume a typo. If we see a double quote with no
1929 * space or punctuation on either side of it, assume unspaced
1930 * quotes "like"this.
1933 for (i=1;i<llen;i++)
1935 /* For each character in the line after the first. */
1936 if (strchr(".?!,;:_",aline[i])) /* if it's punctuation */
1938 /* we need to suppress warnings for acronyms like M.D. */
1940 /* we need to suppress warnings for ellipsis . . . */
1942 /* if there are letters on both sides of it or ... */
1943 if (gcisalpha(aline[i-1]) && gcisalpha(aline[i+1]) ||
1944 gcisalpha(aline[i+1]) && strchr("?!,;:",aline[i]))
1946 /* ...if it's strict punctuation followed by an alpha */
1949 if (i>2 && aline[i-2]=='.')
1951 if (i+2<llen && aline[i+2]=='.')
1956 if (pswit[ECHO_SWITCH])
1957 printf("\n%s\n",aline);
1958 if (!pswit[OVERVIEW_SWITCH])
1959 printf(" Line %ld column %d - Missing space?\n",
1965 if (aline[i-1]==CHAR_SPACE &&
1966 (aline[i+1]==CHAR_SPACE || aline[i+1]==0))
1969 * If there are spaces on both sides,
1970 * or space before and end of line.
1974 if (i>2 && aline[i-2]=='.')
1976 if (i+2<llen && aline[i+2]=='.')
1979 if (!isemptyline && !isellipsis)
1981 if (pswit[ECHO_SWITCH])
1982 printf("\n%s\n",aline);
1983 if (!pswit[OVERVIEW_SWITCH])
1984 printf(" Line %ld column %d - "
1985 "Spaced punctuation?\n",linecnt,i+1);
1992 /* Split out the characters that CANNOT be preceded by space. */
1994 for (i=1;i<llen;i++)
1996 /* for each character in the line after the first */
1997 if (strchr("?!,;:",aline[i]))
1999 /* if it's punctuation that _cannot_ have a space before it */
2000 if (aline[i-1]==CHAR_SPACE && !isemptyline &&
2001 aline[i+1]!=CHAR_SPACE)
2004 * If aline[i+1) DOES == space,
2005 * it was already reported just above.
2007 if (pswit[ECHO_SWITCH])
2008 printf("\n%s\n",aline);
2009 if (!pswit[OVERVIEW_SWITCH])
2010 printf(" Line %ld column %d - Spaced punctuation?\n",
2018 * Special case " .X" where X is any alpha.
2019 * This plugs a hole in the acronym code above.
2020 * Inelegant, but maintainable.
2023 for (i=1;i<llen;i++)
2025 /* for each character in the line after the first */
2028 /* if it's a period */
2029 if (aline[i-1]==CHAR_SPACE && gcisalpha(aline[i+1]))
2032 * If the period follows a space and
2033 * is followed by a letter.
2035 if (pswit[ECHO_SWITCH])
2036 printf("\n%s\n",aline);
2037 if (!pswit[OVERVIEW_SWITCH])
2038 printf(" Line %ld column %d - Spaced punctuation?\n",
2045 for (i=1;i<llen;i++)
2047 /* for each character in the line after the first */
2048 if (aline[i]==CHAR_DQUOTE)
2050 if (!strchr(" _-.'`,;:!/([{?}])",aline[i-1]) &&
2051 !strchr(" _-.'`,;:!/([{?}])",aline[i+1]) && aline[i+1] ||
2052 !strchr(" _-([{'`",aline[i-1]) && gcisalpha(aline[i+1]))
2054 if (pswit[ECHO_SWITCH])
2055 printf("\n%s\n",aline);
2056 if (!pswit[OVERVIEW_SWITCH])
2057 printf(" Line %ld column %d - Unspaced quotes?\n",
2064 /* Check parity of quotes. */
2065 for (s=aline;*s;s++)
2067 if (*s==CHAR_DQUOTE)
2069 if (!(dquotepar=!dquotepar))
2072 if (!strchr("_-.'`/,;:!?)]} ",s[1]))
2074 if (pswit[ECHO_SWITCH])
2075 printf("\n%s\n",aline);
2076 if (!pswit[OVERVIEW_SWITCH])
2077 printf(" Line %ld column %d - "
2078 "Wrongspaced quotes?\n",linecnt,(int)(s-aline)+1);
2086 if (!gcisalpha(s[1]) && !isdigit(s[1]) &&
2087 !strchr("_-/.'`([{$",s[1]) || !s[1])
2089 if (pswit[ECHO_SWITCH])
2090 printf("\n%s\n",aline);
2091 if (!pswit[OVERVIEW_SWITCH])
2092 printf(" Line %ld column %d - "
2093 "Wrongspaced quotes?\n",linecnt,(int)(s-aline)+1);
2100 if (*aline==CHAR_DQUOTE)
2102 if (strchr(",;:!?)]} ",aline[1]))
2104 if (pswit[ECHO_SWITCH])
2105 printf("\n%s\n",aline);
2106 if (!pswit[OVERVIEW_SWITCH])
2107 printf(" Line %ld column 1 - Wrongspaced quotes?\n",
2113 if (pswit[SQUOTE_SWITCH])
2115 for (s=aline;*s;s++)
2117 if ((*s==CHAR_SQUOTE || *s==CHAR_OPEN_SQUOTE) &&
2118 (s==aline || s>aline && !gcisalpha(s[-1]) ||
2121 if (!(squotepar=!squotepar))
2124 if (!strchr("_-.'`/\",;:!?)]} ",s[1]))
2126 if (pswit[ECHO_SWITCH])
2127 printf("\n%s\n",aline);
2128 if (!pswit[OVERVIEW_SWITCH])
2129 printf(" Line %ld column %d - "
2130 "Wrongspaced singlequotes?\n",
2131 linecnt,(int)(s-aline)+1);
2139 if (!gcisalpha(s[1]) && !isdigit(s[1]) &&
2140 !strchr("_-/\".'`",s[1]) || !s[1])
2142 if (pswit[ECHO_SWITCH])
2143 printf("\n%s\n",aline);
2144 if (!pswit[OVERVIEW_SWITCH])
2145 printf(" Line %ld column %d - "
2146 "Wrongspaced singlequotes?\n",
2147 linecnt,(int)(s-aline)+1);
2156 * Look for double punctuation like ,. or ,,
2157 * Thanks to DW for the suggestion!
2158 * In books with references, ".," and ".;" are common
2159 * e.g. "etc., etc.," and vol. 1.; vol 3.;
2160 * OTOH, from my initial tests, there are also fairly
2161 * common errors. What to do? Make these cases paranoid?
2162 * ".," is the most common, so warnings->dotcomma is used
2163 * to suppress detailed reporting if it occurs often.
2166 for (i=0;i<llen;i++)
2168 /* for each punctuation character in the line */
2169 if (strchr(".?!,;:",aline[i]) && (strchr(".?!,;:",aline[i+1])) &&
2170 aline[i] && aline[i+1])
2172 /* followed by punctuation, it's a query, unless . . . */
2173 if (aline[i]==aline[i+1] && (aline[i]=='.' || aline[i]=='?' ||
2175 !warnings->dotcomma && aline[i]=='.' && aline[i+1]==',' ||
2176 warnings->isFrench && !strncmp(aline+i,",...",4) ||
2177 warnings->isFrench && !strncmp(aline+i,"...,",4) ||
2178 warnings->isFrench && !strncmp(aline+i,";...",4) ||
2179 warnings->isFrench && !strncmp(aline+i,"...;",4) ||
2180 warnings->isFrench && !strncmp(aline+i,":...",4) ||
2181 warnings->isFrench && !strncmp(aline+i,"...:",4) ||
2182 warnings->isFrench && !strncmp(aline+i,"!...",4) ||
2183 warnings->isFrench && !strncmp(aline+i,"...!",4) ||
2184 warnings->isFrench && !strncmp(aline+i,"?...",4) ||
2185 warnings->isFrench && !strncmp(aline+i,"...?",4))
2187 if (warnings->isFrench && !strncmp(aline+i,",...",4) ||
2188 warnings->isFrench && !strncmp(aline+i,"...,",4) ||
2189 warnings->isFrench && !strncmp(aline+i,";...",4) ||
2190 warnings->isFrench && !strncmp(aline+i,"...;",4) ||
2191 warnings->isFrench && !strncmp(aline+i,":...",4) ||
2192 warnings->isFrench && !strncmp(aline+i,"...:",4) ||
2193 warnings->isFrench && !strncmp(aline+i,"!...",4) ||
2194 warnings->isFrench && !strncmp(aline+i,"...!",4) ||
2195 warnings->isFrench && !strncmp(aline+i,"?...",4) ||
2196 warnings->isFrench && !strncmp(aline+i,"...?",4))
2198 ; /* do nothing for .. !! and ?? which can be legit */
2202 if (pswit[ECHO_SWITCH])
2203 printf("\n%s\n",aline);
2204 if (!pswit[OVERVIEW_SWITCH])
2205 printf(" Line %ld column %d - Double punctuation?\n",
2213 while (strstr(s," \" "))
2215 if (pswit[ECHO_SWITCH])
2216 printf("\n%s\n",aline);
2217 if (!pswit[OVERVIEW_SWITCH])
2218 printf(" Line %ld column %d - Spaced doublequote?\n",
2219 linecnt,(int)(strstr(s," \" ")-aline+1));
2222 s=strstr(s," \" ")+2;
2225 while (strstr(s," ' "))
2227 if (pswit[ECHO_SWITCH])
2228 printf("\n%s\n",aline);
2229 if (!pswit[OVERVIEW_SWITCH])
2230 printf(" Line %ld column %d - Spaced singlequote?\n",
2231 linecnt,(int)(strstr(s," ' ")-aline+1));
2234 s=strstr(s," ' ")+2;
2237 while (strstr(s," ` "))
2239 if (pswit[ECHO_SWITCH])
2240 printf("\n%s\n",aline);
2241 if (!pswit[OVERVIEW_SWITCH])
2242 printf(" Line %ld column %d - Spaced singlequote?\n",
2243 linecnt,(int)(strstr(s," ` ")-aline+1));
2246 s=strstr(s," ` ")+2;
2248 /* check special case of 'S instead of 's at end of word */
2252 if (*s==CHAR_SQUOTE && s[1]=='S' && s[-1]>='a' && s[-1]<='z')
2254 if (pswit[ECHO_SWITCH])
2255 printf("\n%s\n",aline);
2256 if (!pswit[OVERVIEW_SWITCH])
2257 printf(" Line %ld column %d - Capital \"S\"?\n",
2258 linecnt,(int)(s-aline+2));
2265 * Now check special cases - start and end of line -
2266 * for single and double quotes. Start is sometimes [sic]
2267 * but better to query it anyway.
2268 * While we're here, check for dash at end of line.
2273 if (aline[llen-1]==CHAR_DQUOTE || aline[llen-1]==CHAR_SQUOTE ||
2274 aline[llen-1]==CHAR_OPEN_SQUOTE)
2275 if (aline[llen-2]==CHAR_SPACE)
2277 if (pswit[ECHO_SWITCH])
2278 printf("\n%s\n",aline);
2279 if (!pswit[OVERVIEW_SWITCH])
2280 printf(" Line %ld column %d - Spaced quote?\n",
2285 if ((aline[0]==CHAR_SQUOTE || aline[0]==CHAR_OPEN_SQUOTE) &&
2286 aline[1]==CHAR_SPACE)
2288 if (pswit[ECHO_SWITCH])
2289 printf("\n%s\n",aline);
2290 if (!pswit[OVERVIEW_SWITCH])
2291 printf(" Line %ld column 1 - Spaced quote?\n",linecnt);
2296 * Dash at end of line may well be legit - paranoid mode only
2297 * and don't report em-dash at line-end.
2299 if (pswit[PARANOID_SWITCH] && warnings->hyphen)
2301 for (i=llen-1;i>0 && (unsigned char)aline[i]<=CHAR_SPACE;i--)
2303 if (aline[i]=='-' && aline[i-1]!='-')
2305 if (pswit[ECHO_SWITCH])
2306 printf("\n%s\n",aline);
2307 if (!pswit[OVERVIEW_SWITCH])
2308 printf(" Line %ld column %d - "
2309 "Hyphen at end of line?\n",linecnt,i);
2314 * Brackets are often unspaced, but shouldn't be surrounded by alpha.
2315 * If so, suspect a scanno like "a]most".
2318 for (i=1;i<llen-1;i++)
2320 /* for each bracket character in the line except 1st & last */
2321 if (strchr("{[()]}",aline[i]) && gcisalpha(aline[i-1]) &&
2322 gcisalpha(aline[i+1]))
2324 if (pswit[ECHO_SWITCH])
2325 printf("\n%s\n",aline);
2326 if (!pswit[OVERVIEW_SWITCH])
2327 printf(" Line %ld column %d - Unspaced bracket?\n",
2334 if (warnings->endquote)
2336 for (i=1;i<llen;i++)
2338 /* for each character in the line except 1st */
2339 if (aline[i]==CHAR_DQUOTE && isalpha(aline[i-1]))
2341 if (pswit[ECHO_SWITCH])
2342 printf("\n%s\n",aline);
2343 if (!pswit[OVERVIEW_SWITCH])
2344 printf(" Line %ld column %d - "
2345 "endquote missing punctuation?\n",linecnt,i);
2352 * Check for <HTML TAG>.
2353 * If there is a < in the line, followed at some point
2354 * by a > then we suspect HTML.
2356 if (strstr(aline,"<") && strstr(aline,">"))
2358 i=(signed int)(strstr(aline,">")-strstr(aline,"<")+1);
2361 strncpy(wrk,strstr(aline,"<"),i);
2363 if (pswit[ECHO_SWITCH])
2364 printf("\n%s\n",aline);
2365 if (!pswit[OVERVIEW_SWITCH])
2366 printf(" Line %ld column %d - HTML Tag? %s \n",
2367 linecnt,(int)(strstr(aline,"<")-aline)+1,wrk);
2373 * Check for &symbol; HTML.
2374 * If there is a & in the line, followed at
2375 * some point by a ; then we suspect HTML.
2377 if (strstr(aline,"&") && strstr(aline,";"))
2379 i=(int)(strstr(aline,";")-strstr(aline,"&")+1);
2380 for (s=strstr(aline,"&");s<strstr(aline,";");s++)
2382 i=0; /* Don't report "Jones & Son;" */
2385 strncpy(wrk,strstr(aline,"&"),i);
2387 if (pswit[ECHO_SWITCH])
2388 printf("\n%s\n",aline);
2389 if (!pswit[OVERVIEW_SWITCH])
2390 printf(" Line %ld column %d - HTML symbol? %s \n",
2391 linecnt,(int)(strstr(aline,"&")-aline)+1,wrk);
2397 * At end of paragraph, check for mismatched quotes.
2398 * We don't want to report an error immediately, since it is a
2399 * common convention to omit the quotes at end of paragraph if
2400 * the next paragraph is a continuation of the same speaker.
2401 * Where this is the case, the next para should begin with a
2402 * quote, so we store the warning message and only display it
2403 * at the top of the next iteration if the new para doesn't
2404 * start with a quote.
2405 * The -p switch overrides this default, and warns of unclosed
2406 * quotes on _every_ paragraph, whether the next begins with a
2411 /* end of para - add up the totals */
2412 if (counters.quot%2)
2413 sprintf(dquote_err," Line %ld - Mismatched quotes\n",
2415 if (pswit[SQUOTE_SWITCH] && counters.open_single_quote &&
2416 counters.open_single_quote!=counters.close_single_quote)
2417 sprintf(squote_err," Line %ld - Mismatched singlequotes?\n",
2419 if (pswit[SQUOTE_SWITCH] && counters.open_single_quote &&
2420 counters.open_single_quote!=counters.close_single_quote &&
2421 counters.open_single_quote!=counters.close_single_quote+1)
2423 * Flag it to be noted regardless of the
2424 * first char of the next para.
2427 if (counters.r_brack)
2428 sprintf(rbrack_err," Line %ld - "
2429 "Mismatched round brackets?\n",linecnt);
2430 if (counters.s_brack)
2431 sprintf(sbrack_err," Line %ld - "
2432 "Mismatched square brackets?\n",linecnt);
2433 if (counters.c_brack)
2434 sprintf(cbrack_err," Line %ld - "
2435 "Mismatched curly brackets?\n",linecnt);
2436 if (counters.c_unders%2)
2437 sprintf(unders_err," Line %ld - Mismatched underscores?\n",
2439 memset(&counters,0,sizeof(counters));
2440 /* let the next iteration know that it's starting a new para */
2444 * Check for omitted punctuation at end of paragraph by working back
2445 * through prevline. DW.
2446 * Need to check this only for "normal" paras.
2447 * So what is a "normal" para?
2448 * Not normal if one-liner (chapter headings, etc.)
2449 * Not normal if doesn't contain at least one locase letter
2450 * Not normal if starts with space
2455 for (s=prevline,i=0;*s && !i;s++)
2457 /* use i to indicate the presence of a letter on the line */
2460 * This next "if" is a problem.
2461 * If we say "start_para_line <= linecnt - 1", that includes
2462 * one-line "paragraphs" like chapter heads. Lotsa false positives.
2463 * If we say "start_para_line < linecnt - 1" it doesn't, but then it
2464 * misses genuine one-line paragraphs.
2466 if (i && lastblen>2 && start_para_line<linecnt-1 &&
2467 *prevline>CHAR_SPACE)
2469 for (i=strlen(prevline)-1;
2470 (prevline[i]==CHAR_DQUOTE || prevline[i]==CHAR_SQUOTE) &&
2471 prevline[i]>CHAR_SPACE && i>0;
2476 if (gcisalpha(prevline[i]))
2478 if (pswit[ECHO_SWITCH])
2479 printf("\n%s\n",prevline);
2480 if (!pswit[OVERVIEW_SWITCH])
2481 printf(" Line %ld column %d - "
2482 "No punctuation at para end?\n",
2483 linecnt-1,strlen(prevline));
2488 if (strchr("-.:!([{?}])",prevline[i]))
2493 strcpy(prevline,aline);
2496 if (!pswit[OVERVIEW_SWITCH])
2497 for (i=0;i<MAX_QWORD;i++)
2499 printf("\nNote: Queried word %s was duplicated %d time%s\n",
2500 qword[i],dupcnt[i],"s");
2506 * Get one line from the input stream, checking for
2507 * the existence of exactly one CR/LF line-end per line.
2509 * Returns: a pointer to the line.
2511 char *flgets(char *theline,int maxlen,FILE *thefile,long lcnt)
2517 c=cint=fgetc(thefile);
2522 /* either way, it's end of line */
2529 /* Error - a LF without a preceding CR */
2530 if (pswit[LINE_END_SWITCH])
2532 if (pswit[ECHO_SWITCH])
2533 printf("\n%s\n",theline);
2534 if (!pswit[OVERVIEW_SWITCH])
2535 printf(" Line %ld - No CR?\n",lcnt);
2546 /* Error - two successive CRs */
2547 if (pswit[LINE_END_SWITCH])
2549 if (pswit[ECHO_SWITCH])
2550 printf("\n%s\n",theline);
2551 if (!pswit[OVERVIEW_SWITCH])
2552 printf(" Line %ld - Two successive CRs?\n",lcnt);
2561 if (pswit[LINE_END_SWITCH] && isCR)
2563 if (pswit[ECHO_SWITCH])
2564 printf("\n%s\n",theline);
2565 if (!pswit[OVERVIEW_SWITCH])
2566 printf(" Line %ld column %d - CR without LF?\n",
2576 c=cint=fgetc(thefile);
2577 } while(len<maxlen);
2578 if (pswit[MARKUP_SWITCH])
2579 postprocess_for_HTML(theline);
2580 if (pswit[DP_SWITCH])
2581 postprocess_for_DP(theline);
2588 * Takes a "word" as a parameter, and checks whether it
2589 * contains a mixture of alpha and digits. Generally, this is an
2590 * error, but may not be for cases like 4th or L5 12s. 3d.
2592 * Returns: 0 if no error found, 1 if error.
2594 int mixdigit(char *checkword)
2596 int wehaveadigit,wehavealetter,firstdigits,query,wl;
2598 wehaveadigit=wehavealetter=query=0;
2599 for (s=checkword;*s;s++)
2605 if (wehaveadigit && wehavealetter)
2607 /* Now exclude common legit cases, like "21st" and "12l. 3s. 11d." */
2609 wl=strlen(checkword);
2610 for (firstdigits=0;gcisdigit(checkword[firstdigits]);firstdigits++)
2612 /* digits, ending in st, rd, nd, th of either case */
2613 if (firstdigits+2==wl && (matchword(checkword+wl-2,"st") ||
2614 matchword(checkword+wl-2,"rd") || matchword(checkword+wl-2,"nd") ||
2615 matchword(checkword+wl-2,"th")))
2617 if (firstdigits+3==wl && (matchword(checkword+wl-3,"sts") ||
2618 matchword(checkword+wl-3,"rds") || matchword(checkword+wl-3,"nds") ||
2619 matchword(checkword+wl-3,"ths")))
2621 if (firstdigits+3==wl && (matchword(checkword+wl-4,"stly") ||
2622 matchword(checkword+wl-4,"rdly") ||
2623 matchword(checkword+wl-4,"ndly") || matchword(checkword+wl-4,"thly")))
2625 /* digits, ending in l, L, s or d */
2626 if (firstdigits+1==wl && (checkword[wl-1]=='l' ||
2627 checkword[wl-1]=='L' || checkword[wl-1]=='s' || checkword[wl-1]=='d'))
2630 * L at the start of a number, representing Britsh pounds, like L500.
2631 * This is cute. We know the current word is mixeddigit. If the first
2632 * letter is L, there must be at least one digit following. If both
2633 * digits and letters follow, we have a genuine error, else we have a
2634 * capital L followed by digits, and we accept that as a non-error.
2636 if (checkword[0]=='L' && !mixdigit(checkword+1))
2645 * Extracts the first/next "word" from the line, and puts
2646 * it into "thisword". A word is defined as one English word unit--or
2647 * at least that's the aim.
2649 * Returns: a pointer to the position in the line where we will start
2650 * looking for the next word.
2652 char *getaword(char *fromline,char *thisword)
2657 for (;!gcisdigit(*fromline) && !gcisalpha(*fromline) && *fromline;
2661 * Use a look-ahead to handle exceptions for numbers like 1,000 and 1.35.
2662 * Especially yucky is the case of L1,000
2663 * This section looks for a pattern of characters including a digit
2664 * followed by a comma or period followed by one or more digits.
2665 * If found, it returns this whole pattern as a word; otherwise we discard
2666 * the results and resume our normal programming.
2669 for (;(gcisdigit(*s) || gcisalpha(*s) || *s==',' || *s=='.') &&
2670 wordlen<MAXWORDLEN;s++)
2672 thisword[wordlen]=*s;
2675 thisword[wordlen]=0;
2676 for (i=1;i<wordlen-1;i++)
2678 if (thisword[i]=='.' || thisword[i]==',')
2680 if (gcisdigit(thisword[i-1]) && gcisdigit(thisword[i-1]))
2687 /* we didn't find a punctuated number - do the regular getword thing */
2689 for (;(gcisdigit(*fromline) || gcisalpha(*fromline) || *fromline=='\'') &&
2690 wordlen<MAXWORDLEN;fromline++)
2692 thisword[wordlen]=*fromline;
2695 thisword[wordlen]=0;
2702 * A case-insensitive string matcher.
2704 int matchword(char *checkfor,char *thisword)
2706 unsigned int ismatch,i;
2707 if (strlen(checkfor)!=strlen(thisword))
2709 ismatch=1; /* assume a match until we find a difference */
2710 for (i=0;i<strlen(checkfor);i++)
2711 if (toupper(checkfor[i])!=toupper(thisword[i]))
2719 * Lowercase the line.
2722 void lowerit(char *theline)
2724 for (;*theline;theline++)
2725 if (*theline>='A' && *theline<='Z')
2732 * Is this word a Roman Numeral?
2734 * It doesn't actually validate that the number is a valid Roman Numeral--for
2735 * example it will pass MXXXXXXXXXX as a valid Roman Numeral, but that's not
2736 * what we're here to do. If it passes this, it LOOKS like a Roman numeral.
2737 * Anyway, the actual Romans were pretty tolerant of bad arithmetic, or
2738 * expressions thereof, except when it came to taxes. Allow any number of M,
2739 * an optional D, an optional CM or CD, any number of optional Cs, an optional
2740 * XL or an optional XC, an optional IX or IV, an optional V and any number
2743 int isroman(char *t)
2749 while (*t=='m' && *t)
2753 if (*t=='c' && t[1]=='m')
2755 if (*t=='c' && t[1]=='d')
2757 while (*t=='c' && *t)
2759 if (*t=='x' && t[1]=='l')
2761 if (*t=='x' && t[1]=='c')
2765 while (*t=='x' && *t)
2767 if (*t=='i' && t[1]=='x')
2769 if (*t=='i' && t[1]=='v')
2773 while (*t=='i' && *t)
2781 * A version of isalpha() that is somewhat lenient on 8-bit texts.
2782 * If we use the standard function, 8-bit accented characters break
2783 * words, so that tete with accented characters appears to be two words, "t"
2784 * and "t", with 8-bit characters between them. This causes over-reporting of
2785 * errors. gcisalpha() recognizes accented letters from the CP1252 (Windows)
2786 * and ISO-8859-1 character sets, which are the most common PG 8-bit types.
2788 int gcisalpha(unsigned char c)
2790 if (c>='a' && c<='z')
2792 if (c>='A' && c<='Z')
2796 if (c>=192 && c!=208 && c!=215 && c!=222 && c!=240 && c!=247 && c!=254)
2798 if (c==140 || c==142 || c==156 || c==158 || c==159)
2806 * A version of isdigit() that doesn't get confused in 8-bit texts.
2808 int gcisdigit(unsigned char c)
2810 return c>='0' && c<='9';
2816 * A version of isletter() that doesn't get confused in 8-bit texts.
2817 * NB: this is ISO-8891-1-specific.
2819 int gcisletter(unsigned char c)
2821 return c>='A' && c<='Z' || c>='a' && c<='z' || c>=192;
2827 * Wraps strchr to return NULL if the character being searched for is zero.
2829 char *gcstrchr(char *s,char c)
2837 * postprocess_for_DP:
2839 * Invoked with the -d switch from flgets().
2840 * It simply "removes" from the line a hard-coded set of common
2841 * DP-specific tags, so that the line passed to the main routine has
2842 * been pre-cleaned of DP markup.
2844 void postprocess_for_DP(char *theline)
2850 for (i=0;*DPmarkup[i];i++)
2852 s=strstr(theline,DPmarkup[i]);
2855 t=s+strlen(DPmarkup[i]);
2863 s=strstr(theline,DPmarkup[i]);
2869 * postprocess_for_HTML:
2871 * Invoked with the -m switch from flgets().
2872 * It simply "removes" from the line a hard-coded set of common
2873 * HTML tags and "replaces" a hard-coded set of common HTML
2874 * entities, so that the line passed to the main routine has
2875 * been pre-cleaned of HTML.
2877 void postprocess_for_HTML(char *theline)
2879 if (strstr(theline,"<") && strstr(theline,">"))
2880 while (losemarkup(theline))
2882 while (loseentities(theline))
2886 char *losemarkup(char *theline)
2892 s=strstr(theline,"<");
2893 t=strstr(theline,">");
2896 for (i=0;*markup[i];i++)
2897 if (!tagcomp(s+1,markup[i]))
2910 /* It's an unrecognized <xxx>. */
2914 char *loseentities(char *theline)
2920 for (i=0;*entities[i].htmlent;i++)
2922 s=strstr(theline,entities[i].htmlent);
2925 t=malloc((size_t)strlen(s));
2928 strcpy(t,s+strlen(entities[i].htmlent));
2929 strcpy(s,entities[i].textent);
2935 for (i=0;*entities[i].htmlnum;i++)
2937 s=strstr(theline,entities[i].htmlnum);
2940 t=malloc((size_t)strlen(s));
2943 strcpy(t,s+strlen(entities[i].htmlnum));
2944 strcpy(s,entities[i].textent);
2953 int tagcomp(char *strin,char *basetag)
2959 t++; /* ignore a slash */
2962 if (tolower(*s)!=tolower(*t))
2972 fputs("Bookloupe version " PACKAGE_VERSION ".\n",stderr);
2973 fputs("Copyright 2000-2005 Jim Tinsley <jtinsley@pobox.com>.\n",stderr);
2974 fputs("Copyright 2012- J. Ali Harlow <ali@juiblex.co.uk>.\n",stderr);
2975 fputs("Bookloupe comes wih ABSOLUTELY NO WARRANTY. "
2976 "For details, read the file COPYING.\n",stderr);
2977 fputs("This is Free Software; "
2978 "you may redistribute it under certain conditions (GPL);\n",stderr);
2979 fputs("read the file COPYING for details.\n\n",stderr);
2980 fputs("Usage is: bookloupe [-setpxloyhud] filename\n",stderr);
2981 fputs(" where -s checks single quotes, -e suppresses echoing lines, "
2982 "-t checks typos\n",stderr);
2983 fputs(" -x (paranoid) switches OFF -t and extra checks, "
2984 "-l turns OFF line-end checks\n",stderr);
2985 fputs(" -o just displays overview without detail, "
2986 "-h echoes header fields\n",stderr);
2987 fputs(" -v (verbose) unsuppresses duplicate reporting, "
2988 "-m suppresses markup\n",stderr);
2989 fputs(" -d ignores DP-specific markup,\n",stderr);
2990 fputs(" -u uses a file gutcheck.typ to query user-defined "
2991 "possible typos\n",stderr);
2992 fputs("Sample usage: bookloupe warpeace.txt \n",stderr);
2994 fputs("Bookloupe looks for errors in Project Gutenberg(TM) etexts.\n",
2996 fputs("Bookloupe queries anything it thinks shouldn't be in a PG text; "
2997 "non-ASCII\n",stderr);
2998 fputs("characters like accented letters, "
2999 "lines longer than 75 or shorter than 55,\n",stderr);
3000 fputs("unbalanced quotes or brackets, "
3001 "a variety of badly formatted punctuation, \n",stderr);
3002 fputs("HTML tags, some likely typos. "
3003 "It is NOT a substitute for human judgement.\n",stderr);