fix verify markup polarity (#35)

* fix verify markup polarity

* fix comments

* standardize fileCheck line comments, add docs

Author: digama0

src/metamath.c

@@ -2156,7 +2156,7 @@ void command(int argc, char *argv[]) {
       writeBibliography(g_fullArg[2],
           "*", /* labelMatch - all labels */
           0,  /* 1 = no output, just warning msgs if any */
-          1); /* 1 = check missing external files (gifs, bib, etc.) */
+          1); /* 1 = check external files (gifs and bib) */
       continue;
     }  /* End of "WRITE BIBLIOGRAPHY" */
 
@@ -6382,23 +6382,18 @@ void command(int argc, char *argv[]) {
     }
 
     if (cmdMatches("VERIFY MARKUP")) {
-      i = (switchPos("/ DATE_SKIP") != 0) ? 1 : 0;
-      j = (switchPos("/ TOP_DATE_SKIP") != 0) ? 1 : 0;
-      k = (switchPos("/ FILE_SKIP") != 0) ? 1 : 0;
-      l = (switchPos("/ UNDERSCORE_SKIP") != 0) ? 1 : 0;
-      m = (switchPos("/ MATHBOX_SKIP") != 0) ? 1 : 0;
-      n = (switchPos("/ VERBOSE") != 0) ? 1 : 0;
-      if (i == 1 && j == 1) {
-        printf(
-            "?Only one of / DATE_SKIP and / TOP_DATE_SKIP may be specified.\n");
-        continue;
-      }
+      i = switchPos("/ DATE_SKIP") == 0;
+      j = switchPos("/ TOP_DATE_CHECK") != 0;
+      k = switchPos("/ FILE_CHECK") != 0;
+      l = switchPos("/ UNDERSCORE_SKIP") == 0;
+      m = switchPos("/ MATHBOX_SKIP") == 0;
+      n = switchPos("/ VERBOSE") != 0;
       verifyMarkup(g_fullArg[2],
-          (flag)i, /* 1 = skip checking date consistency */
-          (flag)j, /* 1 = skip checking top date only */
-          (flag)k, /* 1 = skip checking external files GIF, mmset.html,... */
-          (flag)l, /* 1 = skip checking labels for underscores */
-          (flag)m, /* 1 = skip checking mathbox cross-references */
+          (flag)i, /* 1 = check date consistency */
+          (flag)j, /* 1 = check top date */
+          (flag)k, /* 1 = check external files (gifs and bib) */
+          (flag)l, /* 1 = check labels for underscores */
+          (flag)m, /* 1 = check mathbox cross-references */
           (flag)n); /* 1 = verbose mode */
       continue;
     }

src/mmcmds.c

@@ -4768,8 +4768,8 @@ void verifyProofs(vstring labelMatch, flag verifyFlag) {
 
 void verifyMarkup(vstring labelMatch,
     flag dateCheck, /* 1 = check date consistency */
-    flag topDateCheck, /* 1 = check top date but check others */
-    flag fileCheck, /* 1 = check external files (gifs, mmset.html,...) */
+    flag topDateCheck, /* 1 = check top date */
+    flag fileCheck, /* 1 = check external files (gifs and bib) */
     flag underscoreCheck, /* 1 = check labels for "_" characters) */
     flag mathboxCheck, /* 1 = check mathbox cross-references) */
     flag verboseMode) /* 1 = more details */ {
@@ -5325,7 +5325,7 @@ void verifyMarkup(vstring labelMatch,
   f = writeBibliography("mmbiblio.html",
           labelMatch,
           1,  /* 1 = no output, just warning msgs if any */
-          fileCheck); /* 1 = check missing external files (gifs, bib, etc.) */
+          fileCheck); /* 1 = check external files (gifs and bib) */
   if (f != 0) errFound = 1;
 
   /* Check mathboxes for cross-references */

src/mmcmds.h

@@ -85,7 +85,7 @@ void verifyProofs(vstring labelMatch, flag verifyFlag);
 
 
 /* If checkFiles = 0, do not open external files.
-   If checkFiles = 1, check mm*.html, presence of gifs, etc. */
+   If checkFiles = 1, check for presence of gifs and biblio file */
 void verifyMarkup(vstring labelMatch, flag dateCheck, flag topDateCheck,
     flag fileCheck,
     flag underscoreCheck,

src/mmwtex.c

@@ -1663,7 +1663,7 @@ flag printTexComment(vstring commentPtr, flag htmlCenterFlag,
            (These new values were added instead of adding a new argument,
            so as not to have to modify ~60 other calls to this function) */
 
-    flag fileCheck)  /* 1 = check for missing external files (gifs, bib, etc.) */
+    flag fileCheck)  /* 1 = check external files (gifs and bib) */
 {
   vstring cmtptr; /* Not allocated */
   vstring srcptr; /* Not allocated */
@@ -5087,7 +5087,7 @@ vstring getTexOrHtmlHypAndAssertion(long statemNum) {
 flag writeBibliography(vstring bibFile,
     vstring labelMatch, /* Normally "*" except when called by verifyMarkup() */
     flag errorsOnly,  /* 1 = no output, just warning msgs if any */
-    flag fileCheck) /* 1 = check missing external files (mmbiblio.html) */
+    flag fileCheck) /* 1 = check external files (gifs and bib) */
 {
   flag errFlag;
   FILE *list1_fp = NULL;

src/mmwtex.h

@@ -46,6 +46,8 @@ void eraseTexDefs(void); /* Undo readTexDefs() */
 /* TeX/HTML/ALT_HTML word-processor-specific routines */
 /* Returns 2 if there were severe parsing errors, 1 if there were warnings but
    no errors, 0 if no errors or warnings */
+/* The GIF check ensures that for every 'htmldef' definition containing
+   `IMG SRC="bla.gif"`, `bla.gif` must exist. */
 flag readTexDefs(
   flag errorsOnly,  /* 1 = supprees non-error messages */
   flag gifCheck   /* 1 = check for missing GIFs */);
@@ -164,10 +166,14 @@ vstring getTexOrHtmlHypAndAssertion(long statemNum);
 
 /* For WRITE BIBLIOGRAPHY command and error checking by VERIFY MARKUP */
 /* Returns 0 if OK, 1 if error or warning found */
+/* In addition to checking for GIFs (see readTexDefs()),
+   the `fileCheck` flag controls whether to attempt to open and parse the
+   `htmlbibliograhy` or `exthtmlbibliograhy` file to search for anchors,
+   which can be used to verify the correctness of bibliography tags. */
 flag writeBibliography(vstring bibFile,
     vstring labelMatch, /* Normally "*" except by verifyMarkup() */
     flag errorsOnly,  /* 1 = no output, just warning msgs if any */
-    flag fileCheck); /* 1 = check missing external files (gifs, bib, etc.) */
+    flag fileCheck); /* 1 = check external files (gifs and bib) */
 
 /* Globals to hold mathbox information.  They should be re-initialized
    by the ERASE command (eraseSource()).  g_mathboxStmt = 0 indicates