Changeset fb0ad9a in git

Timestamp:

Jun 6, 2014, 7:22:07 PM (9 years ago)

Author:

Hans Schoenemann <hannes@…>

Branches:

(u'spielwiese', '8e0ad00ce244dfd0756200662572aef8402f13d5')

Children:

257a6088d9ed9376744c6ee6bc85af8dc6f426f9

Parents:

daf33cafc0fabbaa48beaca0cabac5a28ba4164e

Message:

restructured gentable/tok.h etc. to generate doc.

Location:

Singular

Files:

• HOWTO.addKernelCmds (added)
• gentable.cc (modified) (8 diffs)
• tok.h (modified) (2 diffs)

Singular/gentable.cc

@@ -12 +12 @@
 #include <time.h>
 #include <unistd.h>
-
-
-
-
-#include <kernel/mod2.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+
+// need to include all tokens: *_CMD:
+#include "grammar.h"
 #include "tok.h"
-#include "grammar.h"
 
 // to produce convert_table.texi for doc:
-//#define CONVERT_TABLE 1
+#define CONVERT_TABLE 1
 
 // bits 0,1 for PLURAL
@@ -27 +26 @@
 #define ALLOW_PLURAL     1
 #define COMM_PLURAL      2
-#define  PLURAL_MASK     3
+#define PLURAL_MASK      3
 
 // bit 2 for RING-CF
@@ -36 +35 @@
 #define NO_ZERODIVISOR   8
 #define ALLOW_ZERODIVISOR  0
+ #define ZERODIVISOR_MASK 8
 
 // bit 4 for warning, if used at toplevel
@@ -188 +188 @@
 
   return strcmp(pCmdL->name, pCmdR->name);
+}
+
+static int _texi_sort_cmds( const void *a, const void *b )
+{
+  cmdnames *pCmdL = (cmdnames*)a;
+  cmdnames *pCmdR = (cmdnames*)b;
+
+  if(a==NULL || b==NULL)             return 0;
+
+  /* empty entries goes to the end of the list for later reuse */
+  if(pCmdL->name==NULL) return 1;
+  if(pCmdR->name==NULL) return -1;
+
+  /* $INVALID$ must come first */
+  if(strcmp(pCmdL->name, "$INVALID$")==0) return -1;
+  if(strcmp(pCmdR->name, "$INVALID$")==0) return  1;
+  char *ls=strdup(pCmdL->name);
+  char *rs=strdup(pCmdR->name);
+  char *s=ls;
+  while (*s) { *s=tolower(*s); s++; }
+  s=rs;
+  while (*s) { *s=tolower(*s); s++; }
+
+  /* tokval=-1 are reserved names at the end */
+  if (pCmdL->tokval==-1)
+  {
+    if (pCmdR->tokval==-1)
+       { int r=strcmp(ls,rs); free(ls); free(rs); return r; }
+    /* pCmdL->tokval==-1, pCmdL goes at the end */
+    free(ls);free(rs);
+    return 1;
+  }
+  /* pCmdR->tokval==-1, pCmdR goes at the end */
+  if(pCmdR->tokval==-1) 
+  { free(ls);free(rs);return -1;}
+
+  { int r=strcmp(ls,rs); free(ls); free(rs); return r; }
 }
 
@@ -291 +328 @@
           s,
           Tok2Cmdname(dArith1[i].arg),
-          Tok2Cmdname(ABS(dArith1[i].res)));
+          Tok2Cmdname(dArith1[i].res));
     i++;
   }
@@ -437 +474 @@
   fclose(outfile);
 }
-/*-------------------------------------------------------------------*/
-#if 0
-void ttGen2()
-{
-  FILE *outfile = fopen(iparith_inc,"a");
-  fprintf(outfile,
-  "/****************************************\n"
-  "*  Computer Algebra System SINGULAR     *\n"
-  "****************************************/\n\n");
-/*-------------------------------------------------------------------*/
-  fprintf(outfile,"// identifier table for Singular\n//\n");
-
-  fprintf(outfile,
-  "cmdnames OLDcmds[] =\n"
-  "{  // name-string     alias  tokval toktype\n"
-  "{ \"$INVALID$\",            0,  -1, 0},\n");
-  int i=1;
-  int m=-1;
-  int id_nr=0;
-  BOOLEAN f=FALSE;
-  loop
-  {
-    while (cmds[i].tokval!=0)
-    {
-      if ((cmds[i].tokval!=-1)&&(cmds[i].name!=NULL))
-      {
-        if(m==-1)
-        {
-          m=i;
-          f=TRUE;
-        }
-        else if(strcmp(cmds[m].name,cmds[i].name)>0)
-        {
-          m=i;
-          f=TRUE;
-        }
-      }
-      i++;
-    }
-    if(f)
-    {
-      id_nr++;
-      fprintf(outfile,"  {\"%s\", %*d, %3d, ",cmds[m].name,
-                                             20-strlen(cmds[m].name),
-                                             cmds[m].alias,
-                                             cmds[m].tokval);
-      switch(cmds[m].toktype)
-      {
-        case CMD_1:            fprintf(outfile,"CMD_1 },\n"); break;
-        case CMD_2:            fprintf(outfile,"CMD_2 },\n"); break;
-        case CMD_3:            fprintf(outfile,"CMD_3 },\n"); break;
-        case CMD_12:           fprintf(outfile,"CMD_12 },\n"); break;
-        case CMD_123 :         fprintf(outfile,"CMD_123 },\n"); break;
-        case CMD_23:           fprintf(outfile,"CMD_23 },\n"); break;
-        case CMD_M:            fprintf(outfile,"CMD_M },\n"); break;
-        case SYSVAR:           fprintf(outfile,"SYSVAR },\n"); break;
-        case ROOT_DECL:        fprintf(outfile,"ROOT_DECL },\n"); break;
-        case ROOT_DECL_LIST:   fprintf(outfile,"ROOT_DECL_LIST },\n"); break;
-        case RING_DECL:        fprintf(outfile,"RING_DECL },\n"); break;
-        case NONE:             fprintf(outfile,"NONE },\n"); break;
-        default:               if((cmds[m].toktype>' ')
-                               &&(cmds[m].toktype<127))
-                               {
-                                 fprintf(outfile,"'%c' },\n",cmds[m].toktype);
-                               }
-                               else
-                               {
-                                 fprintf(outfile,"%d },\n",cmds[m].toktype);
-                               }
-                               break;
-      }
-      cmds[m].name=NULL;
-      m=-1;
-      i=1;
-      f=FALSE;
-    }
-    else break;
-  }
-  fprintf(outfile,
-"/* list of scanner identifiers/only for feread/reservedName */\n");
-  f=FALSE;
-  i=1;m=-1;
-  loop
-  {
-    while (cmds[i].tokval!=0)
-    {
-      if (cmds[i].name!=NULL)
-      {
-        if(m==-1)
-        {
-          m=i;
-          f=TRUE;
-        }
-        else if(strcmp(cmds[m].name,cmds[i].name)>0)
-        {
-          m=i;
-          f=TRUE;
-        }
-      }
-      i++;
-    }
-    if(f)
-    {
-      fprintf(outfile,"  {\"%s\", %*d,  -1, 0 },\n",cmds[m].name,
-                                             20-strlen(cmds[m].name),
-                                             0/*cmds[m].alias*/
-                                             /*-1 cmds[m].tokval*/
-                                             /*0 cmds[m].toktype*/);
-      cmds[m].name=NULL;
-      m=-1;
-      i=1;
-      f=FALSE;
-    }
-    else break;
-  }
-  fprintf(outfile,
-"/* end of list marker */\n"
-"  { NULL, 0, 0, 0}\n"
-"};\n"
-"#define LAST_IDENTIFIER %d\n"
-  ,id_nr);
-  fclose(outfile);
-}
-#endif
 /*---------------------------------------------------------------------*/
 /**
@@ -649 +562 @@
   fclose(outfile);
 }
-/*-------------------------------------------------------------------*/
-#if 0
-void ttGen3()
-{
-  FILE *outfile = fopen("mpsr_tok.inc","w");
-  fprintf(outfile,
-  "/****************************************\n"
-  "*  Computer Algebra System SINGULAR     *\n"
-  "****************************************/\n\n");
-/*-------------------------------------------------------------------*/
-  fprintf(outfile,"// token table for Singular\n//\n");
-
-  fprintf(outfile,
-  "short vtok[] =\n"
-  "{\n");
-  // operations with 1 arg: ===========================================
-  int i=0;
-  while (dArith1[i].cmd!=0)
-  {
-    if ((dArith1[i].p!=jjWRONG)
-    &&((i==0)||(dArith1[i].cmd!=dArith1[i-1].cmd)))
-    {
-      fprintf(outfile,"  %d,\n",dArith1[i].cmd);
-    }
-    i++;
-  }
-  // operations with 2 args: ===========================================
-  i=0;
-  while (dArith2[i].cmd!=0)
-  {
-    if ((dArith2[i].p!=jjWRONG2)
-    &&((i==0)||(dArith2[i].cmd!=dArith2[i-1].cmd)))
-    {
-      fprintf(outfile,"  %d,\n",dArith2[i].cmd);
-    }
-    i++;
-  }
-  // operations with 3 args: ===========================================
-  i=0;
-  while (dArith3[i].cmd!=0)
-  {
-    if (
-    ((i==0)||(dArith3[i].cmd!=dArith3[i-1].cmd)))
-    {
-      fprintf(outfile,"  %d,\n",dArith3[i].cmd);
-    }
-    i++;
-  }
-  // operations with many args: ===========================================
-  i=0;
-  while (dArithM[i].cmd!=0)
-  {
-    if (
-    ((i==0)||(dArithM[i].cmd!=dArithM[i-1].cmd)))
-    {
-      fprintf(outfile,"  %d,\n",dArithM[i].cmd);
-    }
-    i++;
-  }
-  // ====================================================================
-  fprintf(outfile,
-  "/* end of list marker */\n"
-  " %d };\n",MAX_TOK);
+void ttGen2c()
+{
+  int cmd_size = (sizeof(cmds)/sizeof(cmdnames))-1;
+
+  FILE *outfile = fopen("reference_table.texi","w");
+  fprintf(outfile, "@menu\n");
+/*-------------------------------------------------------------------*/
+  qsort(&cmds, cmd_size, sizeof(cmdnames), (&_texi_sort_cmds));
+
+  int m;
+  for(m=0; m<cmd_size; m++)
+  {
+    // assume that cmds[0].tokval== -1 and all others with tokval -1 at the end
+    if(cmds[m].tokval>0)
+    {
+      fprintf(outfile,"* %s::\n",cmds[m].name);
+    }
+  }
+  fprintf(outfile, "@end menu\n@c ---------------------------\n");
+  for(m=0; m<cmd_size; m++)
+  {
+    // assume that cmds[0].tokval== -1 and all others with tokval -1 at the end
+    if(cmds[m].tokval>0)
+    {
+      fprintf(outfile,"@node %s,",cmds[m].name);
+      // next:
+      if (cmds[m+1].tokval>0)
+        fprintf(outfile,"%s,",cmds[m+1].name);
+      else
+        fprintf(outfile,",");
+      // prev:
+      if (cmds[m-1].tokval>0)
+        fprintf(outfile,"%s,",cmds[m-1].name);
+      else
+        fprintf(outfile,",");
+      // up:, and header
+      fprintf(outfile,"Functions\n"
+      "@subsection %s\n"
+      "@cindex %s\n",cmds[m].name,cmds[m].name);
+      fprintf(outfile,"@include %s.part\n",cmds[m].name);
+      char partName[50];
+      sprintf(partName,"%s.part",cmds[m].name);
+      struct stat buf;
+      if (lstat(partName,&buf)!=0)
+      {
+        int op,i;
+        int only_field=0,only_comm=0,no_zerodiv=0;
+        FILE *part=fopen(partName,"w");
+        fprintf(part,"@table @code\n@item @strong{Syntax:}\n");
+        if ((cmds[m].toktype==CMD_1)
+        || (cmds[m].toktype==CMD_12)
+        || (cmds[m].toktype==CMD_13)
+        || (cmds[m].toktype==CMD_123))
+        {
+          op= cmds[m].tokval;
+          i=0;
+          while ((dArith1[i].cmd!=op) && (dArith1[i].cmd!=0)) i++;
+          while (dArith1[i].cmd==op)
+          {
+            if (dArith1[i].p!=jjWRONG)
+            {
+              fprintf(part,"@code{%s (} %s @code{)}\n",cmds[m].name,Tok2Cmdname(dArith1[i].arg));
+              fprintf(part,"@item @strong{Type:}\n%s\n",Tok2Cmdname(dArith1[i].res));
+              if ((dArith1[i].valid_for & ALLOW_PLURAL)==0)
+                only_comm=1;
+              if ((dArith1[i].valid_for & ALLOW_RING)==0)
+                only_field=1;
+              if ((dArith1[i].valid_for & ZERODIVISOR_MASK)==NO_ZERODIVISOR)
+                no_zerodiv=1;
+            }
+            i++;
+          }
+        }
+        if ((cmds[m].toktype==CMD_23)
+        || (cmds[m].toktype==CMD_12)
+        || (cmds[m].toktype==CMD_2)
+        || (cmds[m].toktype==CMD_123))
+        {
+          op= cmds[m].tokval;
+          i=0;
+          while ((dArith2[i].cmd!=op) && (dArith2[i].cmd!=0)) i++;
+          while (dArith2[i].cmd==op)
+          {
+            if (dArith2[i].p!=jjWRONG)
+            {
+              fprintf(part,"@code{%s (} %s, %s @code{)}\n",cmds[m].name,Tok2Cmdname(dArith2[i].arg1),Tok2Cmdname(dArith2[i].arg2));
+              fprintf(part,"@item @strong{Type:}\n%s\n",Tok2Cmdname(dArith2[i].res));
+              if ((dArith2[i].valid_for & ALLOW_PLURAL)==0)
+                 only_comm=1;
+              if ((dArith2[i].valid_for & ALLOW_RING)==0)
+                 only_field=1;
+              if ((dArith2[i].valid_for & ZERODIVISOR_MASK)==NO_ZERODIVISOR)
+                no_zerodiv=1;
+            }
+            i++;
+          }
+        }
+        if ((cmds[m].toktype==CMD_23)
+        || (cmds[m].toktype==CMD_13)
+        || (cmds[m].toktype==CMD_3)
+        || (cmds[m].toktype==CMD_123))
+        {
+          op= cmds[m].tokval;
+          i=0;
+          while ((dArith3[i].cmd!=op) && (dArith3[i].cmd!=0)) i++;
+          while (dArith3[i].cmd==op)
+          {
+            if (dArith3[i].p!=jjWRONG)
+            {
+              fprintf(part,"@code{%s (} %s, %s, %s @code{)}\n",cmds[m].name,
+                Tok2Cmdname(dArith3[i].arg1),
+                Tok2Cmdname(dArith3[i].arg2),
+                Tok2Cmdname(dArith3[i].arg3));
+              fprintf(part,"@item @strong{Type:}\n%s\n",Tok2Cmdname(dArith3[i].res));
+              if ((dArith3[i].valid_for & ALLOW_PLURAL)==0)
+                only_comm=1;
+              if ((dArith3[i].valid_for & ALLOW_RING)==0)
+                only_field=1;
+              if ((dArith3[i].valid_for & ZERODIVISOR_MASK)==NO_ZERODIVISOR)
+                no_zerodiv=1;
+            }
+            i++;
+          }
+        }
+        if (cmds[m].toktype==CMD_M)
+        {
+          op= cmds[m].tokval;
+          i=0;
+          while ((dArithM[i].cmd!=op) && (dArithM[i].cmd!=0)) i++;
+          while (dArithM[i].cmd==op)
+          {
+            if (dArithM[i].p!=jjWRONG)
+            {
+              fprintf(part,"@code{%s (} ... @code{)}\n",cmds[m].name);
+              fprintf(part,"@item @strong{Type:}\n%s\n",Tok2Cmdname(dArithM[i].res));
+              if ((dArithM[i].valid_for & ALLOW_PLURAL)==0)
+                only_comm=1;
+              if ((dArithM[i].valid_for & ALLOW_RING)==0)
+                only_field=1;
+              if ((dArithM[i].valid_for & ZERODIVISOR_MASK)==NO_ZERODIVISOR)
+                no_zerodiv=1;
+            }
+            i++;
+          }
+        }
+        if (only_comm)
+              fprintf(part,"@item @strong{Remark:}\n"
+                           "only for commutive polynomial rings\n");
+        if (only_field)
+              fprintf(part,"@item @strong{Remark:}\n"
+                           "only for polynomial rings over fields\n");
+        if (no_zerodiv)
+              fprintf(part,"@item @strong{Remark:}\n"
+                           "only for polynomial rings over domains\n");
+        fprintf(part,"@item @strong{Purpose:}\n"
+                     "@item @strong{Example:}\n"
+                     "@smallexample\n"
+                     "@c example\n"
+                     "@c example\n"
+                     "@end smallexample\n"
+                     "@c ref\n"
+                     "@c See\n"
+                     "@c ref{....};\n"
+                     "@c ref{....}.\n"
+                     "@c ref\n");
+        fclose(part);
+      }
+    }
+  }
   fclose(outfile);
 }
-#endif
+/*-------------------------------------------------------------------*/
 void ttGen4()
 {
@@ -846 +865 @@
   fprintf(outfile,"@end table\n");
   fclose(outfile);
-}
-/*-------------------------------------------------------------------*/
-
-  // some special cmds which do not fit in with the others, and
-  // nevertheless need to be transmitted
-short ExtraCmds[] =
-{
-  OPTION_CMD,
-  NAMES_CMD,
-//  RESERVEDNAME_CMD,
-  PROC_CMD,
-  MAP_CMD,
-  PACKAGE_CMD,
-  '=',
-  0
-};
-
-// This returns 1 if tok is a token which can appear in a Singular
-// (quoted) command, and 0 otherwise
-short IsCmdToken(short tok)
-{
-  int i = 0;
-  // cmds with one arg
-  while (dArith1[i].cmd != 0)
-    if (dArith1[i].cmd == tok) return 1;
-    else i++;
-
-  // cmds with two args
-  i=0;
-  while (dArith2[i].cmd != 0)
-    if (dArith2[i].cmd == tok) return 1;
-    else i++;
-
-  // cmds with three args
-  i=0;
-  while (dArith3[i].cmd != 0)
-    if (dArith3[i].cmd == tok) return 1;
-    else i++;
-
-  // cmds with many args
-  i=0;
-  while (dArithM[i].cmd != 0)
-    if (dArithM[i].cmd == tok) return 1;
-    else i++;
-
-  // cmds which are somewhat special (like those having 0 args)
-  i=0;
-  while (ExtraCmds[i] != 0)
-    if (ExtraCmds[i] == tok) return 1;
-    else i++;
-
-  return 0;
-}
+  rename("plural_cmd.xx","plural_cmd.inc");
+}
+/*-------------------------------------------------------------------*/
 
 int main()
 {
-  ttGen4();
+  //ttGen4();
   ttGen1();
   ttGen2b();
+  //ttGen2c();
   rename(iparith_inc,"iparith.inc");
-  rename("plural_cmd.xx","plural_cmd.inc");
   return 0;
 }

Singular/tok.h

@@ -8 +8 @@
 */
 
-#ifndef MYYSTYPE
-#include <kernel/structs.h>
-#endif
 #ifndef UMINUS
 #include <Singular/grammar.h>
@@ -37 +34 @@
 #define ANY_TYPE          UMINUS+3
 #define IDHDL             UMINUS+4
-#define NSHDL             UMINUS+5
 
 enum {