add types for temp_(v/nmbr/pntr)String, use const (#37)

* add types for temp_(v/nmbr/pntr)String, use const

* improve docs

* make len const

* fix signed char dependence in ascii_

Co-authored-by: Wolf Lammen <[email protected]>

Author: digama0

src/mmdata.c

@@ -22,7 +22,15 @@ extern flag g_toolsMode; /* In metamath mode:  0 = metamath, 1 = tools */
 typedef long nmbrString; /* String of numbers */
 typedef void* pntrString; /* String of pointers */
 
+/* A nmbrString allocated in temporary storage. These strings will be deallocated
+   after the next call to `nmbrLet`.
+   See also `temp_vstring` for information on how temporaries are handled. */
+typedef nmbrString temp_nmbrString;
 
+/* A pntrString allocated in temporary storage. These strings will be deallocated
+   after the next call to `pntrLet`.
+   See also `temp_vstring` for information on how temporaries are handled. */
+typedef pntrString temp_pntrString;
 
 enum mTokenType { var_, con_ };
 #define lb_ '{' /* ${ */
@@ -186,7 +194,7 @@ void initBigArrays(void);
 long getFreeSpace(long max);
 
 /* Fatal memory allocation error */
-void outOfMemory(vstring msg);
+void outOfMemory(const char *msg);
 
 /* Bug check error */
 void bug(int bugNum);
@@ -213,13 +221,13 @@ extern struct nullPntrStruct g_PntrNull;
 
 /* This function returns a 1 if any entry in a comma-separated list
    matches using the matches() function. */
-flag matchesList(vstring testString, vstring pattern, char wildCard,
+flag matchesList(const char *testString, const char *pattern, char wildCard,
     char oneCharWildCard);
 
 /* This function returns a 1 if the first argument matches the pattern of
    the second argument.  The second argument may have 0-or-more and
    exactly-1 character match wildcards, typically '*' and '?'.*/
-flag matches(vstring testString, vstring pattern, char wildCard,
+flag matches(const char *testString, const char *pattern, char wildCard,
     char oneCharWildCard);
 
 
@@ -247,117 +255,114 @@ void nmbrMakeTempAlloc(nmbrString *s);
 
 
 /* String assignment - MUST be used to assign vstrings */
-void nmbrLet(nmbrString **target,nmbrString *source);
+void nmbrLet(nmbrString **target, const nmbrString *source);
 
 /* String concatenation - last argument MUST be NULL */
-nmbrString *nmbrCat(nmbrString *string1,...);
+temp_nmbrString *nmbrCat(const nmbrString *string1,...);
 
 /* Emulation of nmbrString functions similar to BASIC string functions */
-nmbrString *nmbrSeg(nmbrString *sin, long p1, long p2);
-nmbrString *nmbrMid(nmbrString *sin, long p, long l);
-nmbrString *nmbrLeft(nmbrString *sin, long n);
-nmbrString *nmbrRight(nmbrString *sin, long n);
+temp_nmbrString *nmbrSeg(const nmbrString *sin, long p1, long p2);
+temp_nmbrString *nmbrMid(const nmbrString *sin, long p, long l);
+temp_nmbrString *nmbrLeft(const nmbrString *sin, long n);
+temp_nmbrString *nmbrRight(const nmbrString *sin, long n);
 
 /* Allocate and return an "empty" string n "characters" long */
-nmbrString *nmbrSpace(long n);
+temp_nmbrString *nmbrSpace(long n);
 
-long nmbrLen(nmbrString *s);
-long nmbrAllocLen(nmbrString *s);
+long nmbrLen(const nmbrString *s);
+long nmbrAllocLen(const nmbrString *s);
 void nmbrZapLen(nmbrString *s, long length);
 
 /* Search for string2 in string 1 starting at start_position */
-long nmbrInstr(long start, nmbrString *sin, nmbrString *s);
+long nmbrInstr(long start, const nmbrString *sin, const nmbrString *s);
 
 /* Search for string2 in string 1 in reverse starting at start_position */
 /* (Reverse nmbrInstr) */
-long nmbrRevInstr(long start_position,nmbrString *string1,
-    nmbrString *string2);
+long nmbrRevInstr(long start_position, const nmbrString *string1,
+   const nmbrString *string2);
 
 /* 1 if strings are equal, 0 otherwise */
-int nmbrEq(nmbrString *sout,nmbrString *sin);
+flag nmbrEq(const nmbrString *s, const nmbrString *t);
 
 /* Converts mString to a vstring with one space between tokens */
-vstring nmbrCvtMToVString(nmbrString *s);
+temp_vstring nmbrCvtMToVString(const nmbrString *s);
 
 /* Converts rString to a vstring with one space between tokens */
-vstring nmbrCvtRToVString(nmbrString *s,
+temp_vstring nmbrCvtRToVString(const nmbrString *s,
     flag explicitTargets,
     long statemNum);
 
 /* Get step numbers in an rString - needed by cvtRToVString & elsewhere */
-nmbrString *nmbrGetProofStepNumbs(nmbrString *reason);
+nmbrString *nmbrGetProofStepNumbs(const nmbrString *reason);
 
 /* Converts any nmbrString to an ASCII string of numbers corresponding
    to the .tokenNum field -- used for debugging only. */
-vstring nmbrCvtAnyToVString(nmbrString *s);
+temp_vstring nmbrCvtAnyToVString(const nmbrString *s);
 
 /* Extract variables from a math token string */
-nmbrString *nmbrExtractVars(nmbrString *m);
+temp_nmbrString *nmbrExtractVars(const nmbrString *m);
 
 /* Determine if an element is in a nmbrString; return position if it is */
-long nmbrElementIn(long start, nmbrString *g, long element);
+long nmbrElementIn(long start, const nmbrString *g, long element);
 
 /* Add a single number to end of a nmbrString - faster than nmbrCat */
-nmbrString *nmbrAddElement(nmbrString *g, long element);
+temp_nmbrString *nmbrAddElement(const nmbrString *g, long element);
 
 /* Get the set union of two math token strings (presumably
    variable lists) */
-nmbrString *nmbrUnion(nmbrString *m1,nmbrString *m2);
+temp_nmbrString *nmbrUnion(const nmbrString *m1, const nmbrString *m2);
 
 /* Get the set intersection of two math token strings (presumably
    variable lists) */
-nmbrString *nmbrIntersection(nmbrString *m1,nmbrString *m2);
+temp_nmbrString *nmbrIntersection(const nmbrString *m1, const nmbrString *m2);
 
 /* Get the set difference m1-m2 of two math token strings (presumably
    variable lists) */
-nmbrString *nmbrSetMinus(nmbrString *m1,nmbrString *m2);
+temp_nmbrString *nmbrSetMinus(const nmbrString *m1,const nmbrString *m2);
 
 
 
 /* This is a utility function that returns the length of a subproof that
    ends at step */
-long nmbrGetSubproofLen(nmbrString *proof, long step);
+long nmbrGetSubproofLen(const nmbrString *proof, long step);
 
 /* This function returns a "squished" proof, putting in {} references
    to previous subproofs. */
-nmbrString *nmbrSquishProof(nmbrString *proof);
+temp_nmbrString *nmbrSquishProof(const nmbrString *proof);
 
 /* This function unsquishes a "squished" proof, replacing {} references
-   to previous subproofs by the subproofs themselvs.  The returned nmbrString
-   must be deallocated by the caller. */
-nmbrString *nmbrUnsquishProof(nmbrString *proof);
+   to previous subproofs by the subproofs themselves. */
+temp_nmbrString *nmbrUnsquishProof(const nmbrString *proof);
 
 /* This function returns the indentation level vs. step number of a proof
    string.  This information is used for formatting proof displays.  The
    function calls itself recursively, but the first call should be with
-   startingLevel = 0.  The caller is responsible for deallocating the
-   result. */
-nmbrString *nmbrGetIndentation(nmbrString *proof,
+   startingLevel = 0. */
+temp_nmbrString *nmbrGetIndentation(const nmbrString *proof,
   long startingLevel);
 
 /* This function returns essential (1) or floating (0) vs. step number of a
    proof string.  This information is used for formatting proof displays.  The
    function calls itself recursively, but the first call should be with
-   startingLevel = 0.  The caller is responsible for deallocating the
-   result. */
-nmbrString *nmbrGetEssential(nmbrString *proof);
+   startingLevel = 0. */
+temp_nmbrString *nmbrGetEssential(const nmbrString *proof);
 
 /* This function returns the target hypothesis vs. step number of a proof
    string.  This information is used for formatting proof displays.  The
-   function calls itself recursively.  The caller is responsible for
-   deallocating the result.  statemNum is the statement being proved. */
-nmbrString *nmbrGetTargetHyp(nmbrString *proof, long statemNum);
+   function calls itself recursively.
+   statemNum is the statement being proved. */
+temp_nmbrString *nmbrGetTargetHyp(const nmbrString *proof, long statemNum);
 
 /* Converts a proof string to a compressed-proof-format ASCII string.
    Normally, the proof string would be compacted with squishProof first,
    although it's not a requirement. */
 /* The statement number is needed because required hypotheses are
    implicit in the compressed proof. */
-vstring compressProof(nmbrString *proof, long statemNum,
+temp_vstring compressProof(const nmbrString *proof, long statemNum,
     flag oldCompressionAlgorithm);
 
 /* Gets length of the ASCII form of a compressed proof */
-long compressedProofSize(nmbrString *proof, long statemNum);
+long compressedProofSize(const nmbrString *proof, long statemNum);
 
 
 /*******************************************************************/
@@ -383,48 +388,48 @@ void pntrMakeTempAlloc(pntrString *s);
 
 
 /* String assignment - MUST be used to assign vstrings */
-void pntrLet(pntrString **target,pntrString *source);
+void pntrLet(pntrString **target, const pntrString *source);
 
 /* String concatenation - last argument MUST be NULL */
-pntrString *pntrCat(pntrString *string1,...);
+temp_pntrString *pntrCat(const pntrString *string1,...);
 
 /* Emulation of pntrString functions similar to BASIC string functions */
-pntrString *pntrSeg(pntrString *sin, long p1, long p2);
-pntrString *pntrMid(pntrString *sin, long p, long length);
-pntrString *pntrLeft(pntrString *sin, long n);
-pntrString *pntrRight(pntrString *sin, long n);
+temp_pntrString *pntrSeg(const pntrString *sin, long p1, long p2);
+temp_pntrString *pntrMid(const pntrString *sin, long p, long length);
+temp_pntrString *pntrLeft(const pntrString *sin, long n);
+temp_pntrString *pntrRight(const pntrString *sin, long n);
 
 /* Allocate and return an "empty" string n "characters" long */
-pntrString *pntrSpace(long n);
+temp_pntrString *pntrSpace(long n);
 
 /* Allocate and return an "empty" string n "characters" long
    initialized to nmbrStrings instead of vStrings */
-pntrString *pntrNSpace(long n);
+temp_pntrString *pntrNSpace(long n);
 
 /* Allocate and return an "empty" string n "characters" long
    initialized to pntrStrings instead of vStrings */
-pntrString *pntrPSpace(long n);
+temp_pntrString *pntrPSpace(long n);
 
-long pntrLen(pntrString *s);
-long pntrAllocLen(pntrString *s);
+long pntrLen(const pntrString *s);
+long pntrAllocLen(const pntrString *s);
 void pntrZapLen(pntrString *s, long length);
 
 /* Search for string2 in string 1 starting at start_position */
-long pntrInstr(long start, pntrString *sin, pntrString *s);
+long pntrInstr(long start, const pntrString *sin, const pntrString *s);
 
 /* Search for string2 in string 1 in reverse starting at start_position */
 /* (Reverse pntrInstr) */
-long pntrRevInstr(long start_position,pntrString *string1,
-    pntrString *string2);
+long pntrRevInstr(long start_position, const pntrString *string1,
+    const pntrString *string2);
 
 /* 1 if strings are equal, 0 otherwise */
-int pntrEq(pntrString *sout,pntrString *sin);
+flag pntrEq(const pntrString *sout, const pntrString *sin);
 
 /* Add a single null string element to a pntrString - faster than pntrCat */
-pntrString *pntrAddElement(pntrString *g);
+temp_pntrString *pntrAddElement(const pntrString *g);
 
 /* Add a single null pntrString element to a pntrString - faster than pntrCat */
-pntrString *pntrAddGElement(pntrString *g);
+temp_pntrString *pntrAddGElement(const pntrString *g);
 
 /* Utility functions */
 

src/mmdata.h

@@ -66,7 +66,7 @@ flag backFromCmdInput = 0; /* User typed "B" at main prompt */
 /* Returns 0 if user typed "q" during scroll prompt; this lets a procedure
    interrupt it's output for speedup (rest of output will be suppressed anyway
    until next command line prompt) */
-flag print2(char* fmt, ...) {
+flag print2(const char* fmt, ...) {
   /* This performs the same operations as printf, except that if a log file is
     open, the characters will also be printed to the log file. */
   /* Also, scrolling is paused at each page if in scroll-prompted mode. */
@@ -356,8 +356,7 @@ flag print2(char* fmt, ...) {
 /* Special:  if breakMatch is " (quote), treat as if space but don't break
              quotes, and also let lines grow long - use this call for all HTML
              code */
-void printLongLine(vstring line, vstring startNextLine, vstring breakMatch)
-{
+void printLongLine(const char *line, const char *startNextLine, const char *breakMatch) {
   vstring longLine = "";
   vstring multiLine = "";
   vstring prefix = "";
@@ -606,7 +605,7 @@ void printLongLine(vstring line, vstring startNextLine, vstring breakMatch)
 } /* printLongLine */
 
 
-vstring cmdInput(FILE *stream, vstring ask) {
+vstring cmdInput(FILE *stream, const char *ask) {
   /* This function prints a prompt (if 'ask' is not NULL) and gets a line from
     the input stream.  NULL is returned when end-of-file is encountered.
     New memory is allocated each time linput is called.  This space must
@@ -733,8 +732,7 @@ vstring cmdInput(FILE *stream, vstring ask) {
   return g;
 } /* cmdInput */
 
-vstring cmdInput1(vstring ask)
-{
+vstring cmdInput1(const char *ask) {
   /* This function gets a line from either the terminal or the command file
     stream depending on g_commandFileNestingLevel > 0.  It calls cmdInput(). */
   /* Warning: the calling program must deallocate the returned string. */
@@ -956,7 +954,7 @@ void errorMessage(vstring line, long lineNum, long column, long tokenLength,
 
 /* Opens files with error message; opens output files with
    backup of previous version.   Mode must be "r" or "w" or "d" (delete). */
-FILE *fSafeOpen(vstring fileName, vstring mode, flag noVersioningFlag) {
+FILE *fSafeOpen(const char *fileName, const char *mode, flag noVersioningFlag) {
   FILE *fp;
   vstring prefix = "";
   vstring postfix = "";
@@ -1103,8 +1101,7 @@ FILE *fSafeOpen(vstring fileName, vstring mode, flag noVersioningFlag) {
 
 /* Renames a file with backup of previous version.  If non-zero
    is returned, there was an error. */
-int fSafeRename(vstring oldFileName, vstring newFileName)
-{
+int fSafeRename(const char *oldFileName, const char *newFileName) {
   int error = 0;
   int i;
   FILE *fp;
@@ -1154,8 +1151,7 @@ int fSafeRename(vstring oldFileName, vstring newFileName)
         str1 = fTmpName("zz~list");  ]
    The file whose name is the returned string is not left open;
    the caller must separately open the file. */
-vstring fGetTmpName(vstring filePrefix)
-{
+vstring fGetTmpName(const char *filePrefix) {
   FILE *fp;
   vstring fname = "";
   static long counter = 0;
@@ -1182,7 +1178,7 @@ vstring fGetTmpName(vstring filePrefix)
    must deallocate the returned string.  If a NULL is returned, the file
    could not be opened or had a non-ASCII Unicode character or some other
    problem.   If verbose is 0, error and warning messages are suppressed. */
-vstring readFileToString(vstring fileName, char verbose, long *charCount) {
+vstring readFileToString(const char *fileName, char verbose, long *charCount) {
   FILE *inputFp;
   long fileBufSize;
   char *fileBuf;

src/mminou.c

@@ -34,7 +34,7 @@ extern vstring g_input_fn, g_output_fn;  /* File names */
 
 /* Warning:  never call print2 with string longer than PRINTBUFFERSIZE - 1 */
 /* print2 returns 0 if the user has quit the printout. */
-flag print2(char* fmt,...);
+flag print2(const char* fmt,...);
 extern long g_screenHeight; /* Height of screen */
 extern long g_screenWidth; /* Width of screen */
 #define MAX_LEN 79 /* Default width of screen */
@@ -43,34 +43,35 @@ extern flag g_scrollMode; /* Flag for continuous or prompted scroll */
 extern flag g_quitPrint; /* Flag that user typed 'q' to last scrolling prompt */
 
 /* printLongLine automatically puts a newline \n in the output line. */
-void printLongLine(vstring line, vstring startNextLine, vstring breakMatch);
-vstring cmdInput(FILE *stream,vstring ask);
-vstring cmdInput1(vstring ask);
+void printLongLine(const char *line, const char *startNextLine, const char *breakMatch);
+vstring cmdInput(FILE *stream, const char *ask);
+vstring cmdInput1(const char *ask);
+flag cmdInputIsY(const char *ask);
 
 enum severity {notice_,warning_,error_,fatal_};
 void errorMessage(vstring line, long lineNum, long column, long tokenLength,
   vstring error, vstring fileName, long statementNum, flag warnFlag);
 
 /* Opens files with error message; opens output files with
    backup of previous version.   Mode must be "r" or "w". */
-FILE *fSafeOpen(vstring fileName, vstring mode, flag noVersioningFlag);
+FILE *fSafeOpen(const char *fileName, const char *mode, flag noVersioningFlag);
 
 /* Renames a file with backup of previous version.  If non-zero
    is returned, there was an error. */
-int fSafeRename(vstring oldFileName, vstring newFileName);
+int fSafeRename(const char *oldFileName, const char *newFileName);
 
 /* Finds the name of the first file of the form filePrefix +
    nnn + ".tmp" that does not exist.  THE CALLER MUST DEALLOCATE
    THE RETURNED STRING. */
-vstring fGetTmpName(vstring filePrefix);
+vstring fGetTmpName(const char *filePrefix);
 
 /* This function returns a character string containing the entire contents of
    an ASCII file, or Unicode file with only ASCII characters.   On some
    systems it is faster than reading the file line by line.  THE CALLER
    MUST DEALLOCATE THE RETURNED STRING.  If a NULL is returned, the file
    could not be opened or had a non-ASCII Unicode character or some other
    problem.   If verbose is 0, error and warning messages are suppressed. */
-vstring readFileToString(vstring fileName, char verbose, long *charCount);
+vstring readFileToString(const char *fileName, char verbose, long *charCount);
 
 /* Returns total elapsed time in seconds since starting session (for the
    lcc compiler) or the CPU time used (for the gcc compiler).  The