Changeset 6663 for trunk/tools/database

Timestamp:

Sep 6, 2001, 5:07:32 AM (24 years ago)

Author:

bird

Message:

Design note improovments.

Location:

trunk/tools/database

Files:

• CreateTables.sql (modified) (2 diffs)
• StateUpd.cpp (modified) (5 diffs)
• db.cpp (modified) (7 diffs)
• db.h (modified) (2 diffs)

trunk/tools/database/CreateTables.sql

@@ -1 @@
--- $Id: CreateTables.sql,v 1.17 2000-08-02 01:22:34 bird Exp $
+-- $Id: CreateTables.sql,v 1.18 2001-09-06 03:07:31 bird Exp $
 --
 -- Create all tables.
@@ -103 +103 @@
 
 --
--- This table holds design notes (per dll).
+-- This table holds design notes (per module).
+--
+-- seqnbrnote is a unique number used to order the
+--            sections within a design note.
+-- level      is the nesting level of the section.
+--            0 is the top section in the note.
 --
 CREATE TABLE designnote (
-    refcode     INTEGER NOT NULL AUTO_INCREMENT PRIMARY KEY,
+    refcode     INTEGER NOT NULL AUTO_INCREMENT,
     dll         TINYINT NOT NULL,
     file        INTEGER NOT NULL,
-    seqnbrfile  SMALLINT NOT NULL,
+    line        INTEGER  NOT NULL DEFAULT -1,
+    seqnbrnote  SMALLINT NOT NULL,
+    level       TINYINT NOT NULL,
     seqnbr      INTEGER NOT NULL,
-    line        INTEGER  NOT NULL DEFAULT -1,
-    title       TEXT,
+    name        TEXT,
     note        TEXT    NOT NULL,
-    UNIQUE      u1(refcode),
-    INDEX       u2(file, seqnbrfile, seqnbr, dll)
+    PRIMARY KEY(refcode, seqnbrnote),
+    UNIQUE      u1(refcode, seqnbrnote),
+    UNIQUE      u2(refcode, seqnbrnote, level),
+    UNIQUE      u3(dll, seqnbr, level, seqnbrnote, refcode),
+    INDEX       i1(file, refcode)
 );
 

trunk/tools/database/StateUpd.cpp

@@ -1 @@
-/* $Id: StateUpd.cpp,v 1.35 2001-09-05 23:14:12 bird Exp $
+/* $Id: StateUpd.cpp,v 1.36 2001-09-06 03:07:31 bird Exp $
  *
  * StateUpd - Scans source files for API functions and imports data on them.
@@ -65 +65 @@
 inline char *trim(char *psz);
 inline char *trimR(char *psz);
+static char *trimHtml(char *psz);
 inline char *skip(const char *psz);
 static void  copy(char *psz, char *pszFrom, int iFrom, char *pszTo, int iTo, char **papszLines);
@@ -827 +828 @@
     unsigned long   ulRc = 0;
     char            szBuffer[0x10000];
-    char *          psz;
+    char *          pszTitle;
 
     /*
@@ -835 +836 @@
      *
      */
-    psz = stristr(papszLines[i], "@design");
-    if (psz != NULL && (psz[7] == '\0' || psz[7] == ' '))
-    {
+    pszTitle = stristr(papszLines[i], "@design");
+    if (pszTitle != NULL && (pszTitle[7] == '\0' || pszTitle[7] == ' '))
+    {
+        char *          psz;
         signed long     lSeqNbr;
-
-        psz = findEndOfWord(psz+1)+1;
-        lSeqNbr = atol(psz);
+        signed long     lSeqNbrNote;
+        signed long     lRefCode;
+        long            alSeqNbrs[1024];
+        long            lLevel;
+
+        memset(alSeqNbrs, 0, sizeof(alSeqNbrs));
+
+        /*
+         * Get title and seqnbr. Then copy the entire stuff to the buffer.
+         */
+        pszTitle = findEndOfWord(pszTitle+1)+1;
+        lSeqNbr = atol(pszTitle);
         if (lSeqNbr != 0)
-            psz = findEndOfWord(psz);
-        psz = trim(psz);
-        if (psz != NULL && strstr(psz, "*/") != NULL)
+            pszTitle = findEndOfWord(pszTitle);
+        pszTitle = trim(pszTitle);
+        if (pszTitle != NULL && strstr(pszTitle, "*/") != NULL)
         {
             szBuffer[0] = '\0';
-            *strstr(psz, "*/") = '\0';
+            *strstr(pszTitle, "*/") = '\0';
         }
         else
             copyComment(&szBuffer[0], 0, i+1, papszLines, TRUE, TRUE);
-
-        /* Update database */
-        if (!dbAddDesignNote(pOptions->lDllRefcode, pOptions->lFileRefcode, psz, &szBuffer[0], lSeqNbr, pOptions->lSeqFile++, i + 1))
-        {
-            ulRc = 0x00010000;
-            fprintf(phSignal, "%s(%d): Failed to add designnote. %s\n", dbGetLastErrorDesc());
-        }
+        pszTitle = trim(pszTitle);
+
+        /*
+         * Add design note section by section.
+         */
+        psz = &szBuffer[0];
+        lLevel = 0;
+        lSeqNbrNote = 0;
+        do
+        {
+            char *  pszEnd;
+            long    lNextLevel = -1;
+
+            /*
+             * Parse out title and section/squence number if not lLevel 0.
+             * (psz = "@sub...")
+             */
+            if (lLevel > 0)
+            {
+                pszTitle = findEndOfWord(psz+1);
+                lSeqNbr = atol(pszTitle);
+                if (lSeqNbr != 0)
+                {
+                    pszTitle = findEndOfWord(pszTitle);
+                    alSeqNbrs[lLevel] = lSeqNbr;
+                }
+                else
+                    lSeqNbr = ++alSeqNbrs[lLevel];
+
+                pszTitle = trim(pszTitle);
+                if (pszTitle != NULL && (psz = strstr(pszTitle, "\n")) != NULL)
+                    *psz++ = '\0';
+                else
+                    psz = "";
+            }
+
+
+            /*
+             * Find end of this section.
+             * (pszEnd will point at @sub or '\0'.)
+             */
+            pszEnd = psz;
+            do
+            {
+                while (*pszEnd == '\n' || *pszEnd == ' ' || *pszEnd == '\t' || *pszEnd == '\r')
+                    ++pszEnd;
+                if (!strnicmp(pszEnd, "@sub", 4) && !strnicmp(findEndOfWord(pszEnd + 1) - 7, "section", 7))
+                {
+                    lNextLevel = 1;
+                    while (!strnicmp(pszEnd + 1 + lNextLevel * 3, "sub", 3))
+                        lNextLevel++;
+                    break;
+                }
+            } while ((pszEnd = strchr(pszEnd, '\n')) != NULL);
+            if (!pszEnd)
+                pszEnd = psz + strlen(psz);
+            else
+                pszEnd[-1] = '\0';
+
+            /*
+             * Strip end and start of section.
+             */
+            psz = trimHtml(psz);
+            pszTitle = trimHtml(pszTitle);
+
+            /*
+             * Add the note.
+             */
+            if (!dbAddDesignNote(pOptions->lDllRefcode, pOptions->lFileRefcode,
+                                 pszTitle, psz,
+                                 lLevel, lSeqNbr, lSeqNbrNote++, i + 1, lLevel > 0, &lRefCode))
+            {
+                ulRc += 0x00010000;
+                fprintf(phSignal, "%s(%d): Failed to add designnote. %s\n", pszFilename, i, dbGetLastErrorDesc());
+            }
+
+            /*
+             * Next.
+             */
+            psz = pszEnd;
+            if (lLevel < lNextLevel)
+                memset(&alSeqNbrs[lLevel+1], 0, (lNextLevel - lLevel) * sizeof(alSeqNbrs[0]));
+            lLevel = lNextLevel;
+
+        } while (*psz);
+
 
         /* Skip to line after comment end. */
@@ -2457 +2547 @@
 }
 
+/**
+ * Trims string. <BR>, <P>, '@', '\t', '\n' and '\t' is trimmed from both ends of the string.
+ * @returns Pointer to string.
+ * @param   psz     String to trim.
+ */
+char *trimHtml(char *psz)
+{
+    if (!psz)
+        return NULL;
+
+    char *pszEnd = psz + strlen(psz) - 1;
+
+    while (pszEnd > psz)
+    {
+        if (*pszEnd == '@' || *pszEnd == ' ' || *pszEnd == '\t' || *pszEnd == '\n' || *pszEnd == '\r')
+            pszEnd--;
+        else if (!strnicmp(pszEnd - 3, "<BR>", 4))
+            pszEnd -= 4;
+        else if (!strnicmp(pszEnd - 2, "<P>", 3))
+            pszEnd -= 3;
+        else
+            break;
+    }
+    *++pszEnd = '\0';
+
+    while (psz < pszEnd)
+    {
+        if (*psz == '@' || *psz == ' ' || *psz == '\t' || *psz == '\n' || *psz == '\r')
+            psz++;
+        else if (!strnicmp(psz, "<BR>", 4))
+            psz += 4;
+        else if (!strnicmp(psz, "<P>", 3))
+            psz += 3;
+        else
+            break;
+    }
+
+    return psz;
+}
+
 
 /**

trunk/tools/database/db.cpp

@@ -1 @@
-/* $Id: db.cpp,v 1.24 2001-09-05 13:59:03 bird Exp $ *
+/* $Id: db.cpp,v 1.25 2001-09-06 03:07:32 bird Exp $ *
  *
  * DB - contains all database routines.
@@ -1172 +1172 @@
  * @param       pszTitle        Design note title.
  * @param       pszText         Design note text.
+ * @param       lLevel          Level of the note section. 0 is the design note it self.
  * @param       lSeqNbr         Sequence number (in dll). If 0 the use next available number.
- * @param       lSeqNbrFile     Sequence number in file.
+ * @param       lSeqNbrNote     Sequence number in note.
  * @param       lLine           Line number (1 - based!).
+ * @param       fSubSection     TRUE if subsection FALSE if design note.
+ *                              if TRUE *plRefCode will hold the reference id of the note.
+ *                              if FALSE *plRefCode will receive the reference id of the note being created.
+ * @param       plRefCode       Pointer to reference id of the design note. see fSubSection for more info.
  */
 BOOL            _System dbAddDesignNote(signed long lDll,
@@ -1180 +1185 @@
                                         const char *pszTitle,
                                         const char *pszText,
+                                        signed long lLevel,
                                         signed long lSeqNbr,
-                                        signed long lSeqNbrFile,
-                                        signed long lLine)
-{
+                                        signed long lSeqNbrNote,
+                                        signed long lLine,
+                                        BOOL        fSubSection,
+                                        signed long *plRefCode)
+{
+    int         rc;
     char        szQuery[0x10200];
     MYSQL_RES * pres;
@@ -1189 +1198 @@
 
     assert(lDll >= 0 && lFile >= 0);
-    assert(lSeqNbrFile >= 0);
+    assert(lSeqNbrNote >= 0);
 
     /*
      * If no lSqlNbr the make one.
      */
-    if (lSeqNbr == 0)
-    {
-        sprintf(&szQuery[0], "SELECT MAX(seqnbr) + 1 FROM designnote WHERE dll = %ld", lDll);
+    if (lSeqNbr == 0 && !fSubSection)
+    {
+        sprintf(&szQuery[0], "SELECT MAX(seqnbr) + 1 FROM designnote WHERE dll = %ld AND level = 0", lDll);
         if (mysql_query(pmysql, &szQuery[0]) >= 0)
         {
@@ -1203 +1212 @@
             {
                 MYSQL_ROW parow = mysql_fetch_row(pres);
-                if (parow != NULL)
+                if (parow != NULL && parow[0])
                     lSeqNbr = getvalue(0, parow);
                 else
@@ -1217 +1226 @@
 
     /*
-     * Create update query.
+     * Create insert query.
      */
-    sprintf(&szQuery[0], "INSERT INTO designnote(dll, file, seqnbrfile, seqnbr, line, title, note) "
-                         "VALUES (%ld, %ld, %ld, %ld, %ld, ",
-            lDll, lFile, lSeqNbrFile, lSeqNbr, lLine);
+    if (!fSubSection)
+        sprintf(&szQuery[0], "INSERT INTO designnote(dll, file, level, seqnbrnote, seqnbr, line, name, note) "
+                             "VALUES (%ld, %ld, %ld, %ld, %ld, %ld, ",
+                lDll, lFile, lLevel, lSeqNbrNote, lSeqNbr, lLine);
+    else
+        sprintf(&szQuery[0], "INSERT INTO designnote(refcode, dll, file, level, seqnbrnote, seqnbr, line, name, note) "
+                             "VALUES (%ld, %ld, %ld, %ld, %ld, %ld, %ld, ",
+                *plRefCode, lDll, lFile, lLevel, lSeqNbrNote, lSeqNbr, lLine);
+
     if (pszTitle != NULL && *pszTitle != '\0')
         sqlstrcat(&szQuery[0], NULL, pszTitle);
@@ -1228 +1243 @@
     sqlstrcat(&szQuery[0], ", ", pszText == NULL ? "" : pszText, ")");
 
-    return mysql_query(pmysql, &szQuery[0]) >= 0;
+    if (mysql_query(pmysql, &szQuery[0]) >= 0)
+    {
+        if (!fSubSection)
+            *plRefCode = mysql_insert_id(pmysql);
+        return TRUE;
+    }
+    return FALSE;
 }
 

trunk/tools/database/db.h

@@ -1 @@
-/* $Id: db.h,v 1.13 2000-08-02 02:18:05 bird Exp $ */
+/* $Id: db.h,v 1.14 2001-09-06 03:07:32 bird Exp $ */
 /*
  * DB - contains all database routines
@@ -140 +140 @@
                                              const char *pszTitle,
                                              const char *pszText,
+                                             signed long lLevel,
                                              signed long lSeqNbr,
-                                             signed long lSeqNbrFile,
-                                             signed long lLine);
+                                             signed long lSeqNbrNote,
+                                             signed long lLine,
+                                             BOOL        fSubSection,
+                                             signed long *plRefCode);
     unsigned long    _System dbCreateHistory(char *pszError);
     unsigned long    _System dbCheckIntegrity(char *pszError);