From b939caccaa3aa0b61e2c02fb7064737729952d00 Mon Sep 17 00:00:00 2001
From: claudiol <claudiol@sourceforge.net>
Date: Thu, 15 Mar 2018 19:05:36 -0400
Subject: [PATCH] Created command information extractor for the Wiki. Added
 test descriptions to one library.

---
 newrpl/lib-30-complex.c                    |  12 +
 tools/extractcmd/extractcmd/.gitignore     |  73 ++++++
 tools/extractcmd/extractcmd/extractcmd.pro |   6 +
 tools/extractcmd/extractcmd/main.c         | 279 +++++++++++++++++++++
 4 files changed, 370 insertions(+)
 create mode 100644 tools/extractcmd/extractcmd/.gitignore
 create mode 100644 tools/extractcmd/extractcmd/extractcmd.pro
 create mode 100644 tools/extractcmd/extractcmd/main.c

diff --git a/newrpl/lib-30-complex.c b/newrpl/lib-30-complex.c
index 67c4d79..c69e516 100644
--- a/newrpl/lib-30-complex.c
+++ b/newrpl/lib-30-complex.c
@@ -18,6 +18,7 @@
 // REPLACE THE NUMBER
 #define LIBRARY_NUMBER  30
 
+//@TITLE=Operations with Complex Numbers
 
 // LIST OF COMMANDS EXPORTED,
 // INCLUDING INFORMATION FOR SYMBOLIC COMPILER
@@ -6411,6 +6412,7 @@ void LIB_HANDLER()
 
     case RE:
     {
+        //@SHORT_DESC=Real part of a complex number
         if(rplDepthData()<1) {
             rplError(ERR_BADARGCOUNT);
             return;
@@ -6466,6 +6468,8 @@ void LIB_HANDLER()
     }
     case IM:
     {
+        //@SHORT_DESC=Imaginary part of a complex number
+
         if(rplDepthData()<1) {
             rplError(ERR_BADARGCOUNT);
             return;
@@ -6524,6 +6528,8 @@ void LIB_HANDLER()
     }
     case ARG:
     {
+        //@SHORT_DESC=Argument of a complex number
+
         if(rplDepthData()<1) {
             rplError(ERR_BADARGCOUNT);
             return;
@@ -6617,6 +6623,8 @@ void LIB_HANDLER()
     }
     case CONJ:
     {
+        //@SHORT_DESC=Conjugate of a complex number
+
         if(rplDepthData()<1) {
             rplError(ERR_BADARGCOUNT);
             return;
@@ -6668,6 +6676,8 @@ void LIB_HANDLER()
 
 
     case CPLX2REAL:
+        //@SHORT_DESC=Split Complex into two Reals
+
         if(rplDepthData()<1) {
             rplError(ERR_BADARGCOUNT);
             return;
@@ -6688,6 +6698,8 @@ void LIB_HANDLER()
 
     case REAL2CPLX:
     {
+        //@SHORT_DESC=Make Complex from real and imaginary parts
+
         if(rplDepthData()<2) {
             rplError(ERR_BADARGCOUNT);
             return;
diff --git a/tools/extractcmd/extractcmd/.gitignore b/tools/extractcmd/extractcmd/.gitignore
new file mode 100644
index 0000000..fab7372
--- /dev/null
+++ b/tools/extractcmd/extractcmd/.gitignore
@@ -0,0 +1,73 @@
+# This file is used to ignore files which are generated
+# ----------------------------------------------------------------------------
+
+*~
+*.autosave
+*.a
+*.core
+*.moc
+*.o
+*.obj
+*.orig
+*.rej
+*.so
+*.so.*
+*_pch.h.cpp
+*_resource.rc
+*.qm
+.#*
+*.*#
+core
+!core/
+tags
+.DS_Store
+.directory
+*.debug
+Makefile*
+*.prl
+*.app
+moc_*.cpp
+ui_*.h
+qrc_*.cpp
+Thumbs.db
+*.res
+*.rc
+/.qmake.cache
+/.qmake.stash
+
+# qtcreator generated files
+*.pro.user*
+
+# xemacs temporary files
+*.flc
+
+# Vim temporary files
+.*.swp
+
+# Visual Studio generated files
+*.ib_pdb_index
+*.idb
+*.ilk
+*.pdb
+*.sln
+*.suo
+*.vcproj
+*vcproj.*.*.user
+*.ncb
+*.sdf
+*.opensdf
+*.vcxproj
+*vcxproj.*
+
+# MinGW generated files
+*.Debug
+*.Release
+
+# Python byte code
+*.pyc
+
+# Binaries
+# --------
+*.dll
+*.exe
+
diff --git a/tools/extractcmd/extractcmd/extractcmd.pro b/tools/extractcmd/extractcmd/extractcmd.pro
new file mode 100644
index 0000000..fc18d89
--- /dev/null
+++ b/tools/extractcmd/extractcmd/extractcmd.pro
@@ -0,0 +1,6 @@
+TEMPLATE = app
+CONFIG += console
+CONFIG -= app_bundle
+CONFIG -= qt
+
+SOURCES += main.c
diff --git a/tools/extractcmd/extractcmd/main.c b/tools/extractcmd/extractcmd/main.c
new file mode 100644
index 0000000..33a283b
--- /dev/null
+++ b/tools/extractcmd/extractcmd/main.c
@@ -0,0 +1,279 @@
+/*
+ * Copyright (c) 2014-2015, Claudio Lapilli and the newRPL Team
+ * All rights reserved.
+ * This file is released under the 3-clause BSD license.
+ * See the file LICENSE.txt that shipped with this distribution.
+ */
+
+
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include <ctype.h>
+
+int main(int argc, char *argv[])
+{
+
+    char *mainbuffer;
+
+    if(argc<2) {
+    printf("NewRPL command extract - Version 1.0\n");
+    printf("Usage: extractcmd <filename.c> -d <path>\n");
+    printf("\nOptions:\n");
+   printf("\t\t-d <path>\tSpecify a the directory where the output file will be created (by default, same as the source file)\n\n\n");
+    return 0;
+    }
+
+    int argidx=1;
+    int needoutputpath=0;
+    int needcleanup=0;
+    int nameoffset,namelen;
+    char *outputfile=NULL;
+    char *outputpath=NULL;
+    char *inputfile=NULL;
+    while(argidx<argc) {
+        if(needoutputpath) { outputpath=argv[argidx]; needoutputpath=0; }
+        else if((argv[argidx][0]=='-')&&(argv[argidx][1]=='d')) {
+                if(argv[argidx][2]==0) needoutputpath=1;
+                else outputpath=argv[argidx]+2;
+                } else inputfile=argv[argidx];
+
+        ++argidx;
+    }
+
+    // HERE WE HAVE ALL ARGUMENTS PROCESSED
+    if(!inputfile) {
+        fprintf(stderr,"Error: No input file\n");
+        return 1;
+    }
+
+    if(!outputfile) {
+
+        // CREATE AN OUTPUT FILE NAME FROM THE INPUT FILE
+        char *end=inputfile+strlen(inputfile)-1;
+        char *libname=inputfile;
+
+        while((end>inputfile)&&(*end!='.')&&(*end!='/')&&(*end!='\\')) --end;
+        if(end<=inputfile) end=inputfile+strlen(inputfile);
+        else if(*end!='.') { libname=end; end=inputfile+strlen(inputfile); }
+        needcleanup++;
+
+        while(strrchr(libname,'-')>libname) libname=strrchr(libname,'-')+1;
+
+        outputfile=malloc(end-libname+10+((outputpath)? strlen(outputpath):0));
+        if(!outputfile) {
+            fprintf(stderr,"error: Memory allocation error\n");
+            return 1;
+        }
+        nameoffset=0;
+        namelen=end-libname;
+        if(outputpath) {
+            strcpy(outputfile,outputpath);
+            nameoffset=strlen(outputpath);
+            if(outputpath[nameoffset-1]!='/') outputpath[nameoffset++]='/';
+        }
+        memmove(outputfile+nameoffset,libname,namelen);
+        strcpy(outputfile+nameoffset+namelen,".txt");
+
+    }
+
+    // HERE WE HAVE THE SECTION NAME AT outputfile[nameoffset]..outputfile[nameoffset+namelen-1]
+
+    // READ THE INPUT FILE INTO A BUFFER
+    FILE *f=fopen(inputfile,"rb");
+    if(f==NULL) {
+        fprintf(stderr,"error: File not found %s\n",inputfile);
+        if(needcleanup) free(outputfile);
+        return 1;
+    }
+    fseek(f,0,SEEK_END);
+    long long length=ftell(f);
+    fseek(f,0,SEEK_SET);
+
+    mainbuffer=malloc(length);
+    if(!mainbuffer) {
+        fprintf(stderr,"error: Memory allocation error\n");
+        if(needcleanup) free(outputfile);
+        return 1;
+    }
+    if(fread(mainbuffer,1,length,f)!=(size_t)length) {
+        fprintf(stderr,"error: Can't read from input file\n");
+        if(needcleanup) free(outputfile);
+        free(mainbuffer);
+        return 1;
+    }
+    fclose(f);
+
+    // HERE WE HAVE THE MAIN FILE LOADED, EXTRACT THE COMMANDS
+
+
+      // FIND COMMANDS
+
+    char *chunk=mainbuffer;
+    int ncmd=0,extcommand;
+    char *cmdname[1000],*cmdstring[1000],*cmddesc[1000];
+    int cmdnamelen[1000],cmdstrlen[1000],cmddesclen[1000];
+    int line=1;
+    char *libtitle=0;
+    int libtitlelen=0;
+    int currentcmd=0;
+
+    int k;
+    // SET ALL LENGTHS TO ZERO
+    for(k=0;k<1000;++k)
+    {
+        cmdnamelen[k]=cmdstrlen[k]=cmddesclen[k]=0;
+    }
+
+    while(chunk-mainbuffer<length) {
+
+        // SKIP ANY TABS OR SPACES
+        while((chunk-mainbuffer<length)&&((*chunk==' ')||(*chunk=='\t'))) ++chunk;
+
+        if((chunk-mainbuffer<length-9) && !strncmp(chunk,"//@TITLE=",9)) {
+            // FOUND TITLE OF THE LIBRARY
+            libtitle=chunk+9;
+            while( (*chunk!='\n')&&(*chunk!='\r')&&(chunk-mainbuffer<length)) ++chunk;
+            libtitlelen=chunk-libtitle;
+        }
+
+
+        // KEEP TRACK OF CURRENT COMMAND DEFINITION
+        if((chunk-mainbuffer<length-4) && !strncmp(chunk,"case",4)) {
+            // FOUND COMMAND DEFINITION
+            chunk+=4;
+            // SKIP ANY TABS OR SPACES
+            while((chunk-mainbuffer<length)&&((*chunk==' ')||(*chunk=='\t'))) ++chunk;
+            char *findcmd=chunk;
+            int findcmdlen;
+            // SKIP UNTIL THE COLON IS FOUND
+            while( (*chunk!=':')&&(*chunk!='\n')&&(chunk-mainbuffer<length)) ++chunk;
+            if(*chunk==':') {
+                // FOUND A COMMAND
+                findcmdlen=chunk-findcmd;
+                for(k=0;k<ncmd;++k) {
+                    if( (cmdnamelen[k]==findcmdlen) && !strncmp(cmdname[k],findcmd,findcmdlen)) { currentcmd=k; break; }
+                }
+            }
+
+
+        }
+
+        if((chunk-mainbuffer<length-14) && !strncmp(chunk,"//@SHORT_DESC=",14)) {
+            // FOUND SHORT DESCRIPTION OF THE CURRENT COMMAND
+            cmddesc[currentcmd]=chunk+14;
+            while( (*chunk!='\n')&&(*chunk!='\r')&&(chunk-mainbuffer<length)) ++chunk;
+            cmddesclen[currentcmd]=chunk-cmddesc[currentcmd];
+        }
+
+        if(*chunk=='E') { extcommand=1; ++chunk; }
+        else extcommand=0;
+        if(chunk-mainbuffer>=length) break;
+
+        if(*chunk=='C') {
+            ++chunk;
+            if(chunk-mainbuffer>=length) break;
+            if(*chunk=='M') {
+                ++chunk;
+                if(chunk-mainbuffer>=length) break;
+                if(*chunk=='D') {
+                    ++chunk;
+                    if(chunk-mainbuffer>=length) break;
+                    if(*chunk=='(') {
+                        ++chunk;
+                        if(chunk-mainbuffer>=length) break;
+                        cmdname[ncmd]=chunk;
+                        while((chunk-mainbuffer<length)&&((*chunk!=',')&&(*chunk!=' ')&&(*chunk!='\n'))) ++chunk;
+                        cmdnamelen[ncmd]=chunk-cmdname[ncmd];
+
+                        if(extcommand) {
+                            if(*chunk!=',') {
+                                // INVALID SYNTAX, FORGET IT
+                                fprintf(stderr,"Warning: Bad syntax line %d, skipping.\n",line);
+                            }
+                            else {
+                            ++chunk;
+                            while((chunk-mainbuffer<length)&&((*chunk!='\"')&&(*chunk!='\n')&&(*chunk!=','))) ++chunk;
+
+                            if(*chunk=='\"') {
+                                ++chunk;
+                                cmdstring[ncmd]=chunk;
+                                while((chunk-mainbuffer<length)&&((*chunk!='\"')&&(*chunk!='\n'))) ++chunk;
+                                if(*chunk!='\"') {
+                                    fprintf(stderr,"Warning: Bad syntax line %d, skipping.\n",line);
+                                }
+                                else {
+                                cmdstrlen[ncmd]=chunk-cmdstring[ncmd];
+                                ++ncmd;
+                                }
+                            }
+                            else {
+                                fprintf(stderr,"Warning: Bad syntax line %d, skipping.\n",line);
+                            }
+                            }
+                        }
+                        else {
+                         cmdstring[ncmd]=cmdname[ncmd];
+                         cmdstrlen[ncmd]=cmdnamelen[ncmd];
+                         ++ncmd;
+                        }
+
+                        // CHECK IF EVERYTHING IS OK
+
+                        if((cmdstrlen[ncmd-1]<=0)) --ncmd;   // THIS IS AN UNNAMED COMMAND, REMOVE FROM THE LIST
+                        else {
+                            // TODO: GET THE TOKENINFO DATA
+
+                        }
+                    }
+                }
+            }
+        }
+
+        // DONE, SKIP TO NEXT LINE
+
+      //SKIP TO THE NEXT LINE
+    ++line;
+    while( (*chunk!='\n')&&(*chunk!='\r')&&(chunk-mainbuffer<length)) ++chunk;
+    while( ((*chunk=='\n')||(*chunk=='\r'))&&(chunk-mainbuffer<length)) ++chunk;
+
+    }
+
+    // DONE ANALYZING THE FILE, NOW CREATE THE SUMMARY INFO TEMPLATES
+
+
+
+    f=fopen(outputfile,"wb");
+    if(f==NULL) {
+        fprintf(stderr,"error: Can't open %s for writing.\n",outputfile);
+        if(needcleanup) free(outputfile);
+        free(mainbuffer);
+        return 1;
+    }
+
+    int j;
+
+    char buffer[1024];
+
+    for(k=0;k<ncmd;++k) {
+    fprintf(f,"| **[[manual:chapter6:");
+    fwrite(outputfile+nameoffset,namelen,1,f);
+    fprintf(f,":cmd_");
+    for(j=0;j<cmdnamelen[k];++j) buffer[j]=tolower(cmdname[k][j]);
+    fwrite(buffer,cmdnamelen[k],1,f);
+    fprintf(f,"|");
+    fwrite(cmdstring[k],cmdstrlen[k],1,f);
+    fprintf(f,"]]** | ");
+    if(cmddesclen[k]) fwrite(cmddesc[k],cmddesclen[k],1,f);
+    fprintf(f," |  |\n");
+    }
+
+    // CLOSE THE OUTPUT FILE
+    fclose(f);
+
+    // TODO: CREATE THE DIRECTORY FOR THE TEMPLATES
+
+
+    return 0;
+
+}