]> git.saurik.com Git - wxWidgets.git/blobdiff - src/html/helpdata.cpp
some wxArtProv docs
[wxWidgets.git] / src / html / helpdata.cpp
index beb05d3d65e6fce8bb24f06e2dd20b6eb08cbf7b..44392854d328aca559ca8a164db12d991733ddfd 100644 (file)
@@ -48,22 +48,30 @@ WX_DEFINE_OBJARRAY(wxHtmlBookRecArray)
 //-----------------------------------------------------------------------------
 
 // Reads one line, stores it into buf and returns pointer to new line or NULL.
-static char* ReadLine(char *line, char *buf)
+static char* ReadLine(char *line, char *buf, size_t bufsize)
 {
-    char *writeptr = buf, *readptr = line;
+    char *writeptr = buf;
+    char *endptr = buf + bufsize - 1;
+    char *readptr = line;
 
-    while (*readptr != 0 && *readptr != '\r' && *readptr != '\n') *(writeptr++) = *(readptr++);
+    while (*readptr != 0 && *readptr != '\r' && *readptr != '\n' &&
+           writeptr != endptr) 
+        *(writeptr++) = *(readptr++);
     *writeptr = 0;
-    while (*readptr == '\r' || *readptr == '\n') readptr++;
-    if (*readptr == 0) return NULL;
-    else return readptr;
+    while (*readptr == '\r' || *readptr == '\n')
+        readptr++;
+    if (*readptr == 0)
+        return NULL;
+    else 
+        return readptr;
 }
 
 
 
-static int LINKAGEMODE IndexCompareFunc(const void *a, const void *b)
+extern "C" int LINKAGEMODE
+wxHtmlHelpIndexCompareFunc(const void *a, const void *b)
 {
-    return wxStrcmp(((wxHtmlContentsItem*)a)->m_Name, ((wxHtmlContentsItem*)b)->m_Name);
+    return wxStricmp(((wxHtmlContentsItem*)a)->m_Name, ((wxHtmlContentsItem*)b)->m_Name);
 }
 
 
@@ -287,78 +295,78 @@ bool wxHtmlHelpData::LoadMSProject(wxHtmlBookRecord *book, wxFileSystem& fsys, c
 
 
 
+inline static void CacheWriteInt32(wxOutputStream *f, wxInt32 value)
+{
+    wxInt32 x = wxINT32_SWAP_ON_BE(value);
+    f->Write(&x, sizeof(x));
+}
 
-#if wxUSE_UNICODE
-
-#define READ_STRING(f, s, lng) { char tmpc; for (int i = 0; i < lng; i++) { f->Read(&tmpc, 1); s[i] = (wxChar)tmpc;} }
-#define WRITE_STRING(f, s, lng) { char tmpc; for (int i = 0; i < lng; i++) { tmpc = (char)s[i]; f->Write(&tmpc, 1);} }
-
-#else
-
-#define READ_STRING(f, s, lng) f->Read(s, lng * sizeof(char));
-#define WRITE_STRING(f, s, lng) f->Write(s, lng * sizeof(char));
+inline static wxInt32 CacheReadInt32(wxInputStream *f)
+{
+    wxInt32 x;
+    f->Read(&x, sizeof(x));
+    return wxINT32_SWAP_ON_BE(x);
+}
 
-#endif
+inline static void CacheWriteString(wxOutputStream *f, const wxChar *str)
+{
+    size_t len = wxStrlen(str)+1;
+    CacheWriteInt32(f, len);
+    f->Write(str, len * sizeof(wxChar));
+}
 
+inline static wxChar *CacheReadString(wxInputStream *f)
+{
+    wxChar *str;
+    size_t len = (size_t)CacheReadInt32(f);
+    str = new wxChar[len];
+    f->Read(str, len * sizeof(wxChar));
+    return str;
+}
 
-#define CURRENT_CACHED_BOOK_VERSION     1
+#define CURRENT_CACHED_BOOK_VERSION     2
 
 bool wxHtmlHelpData::LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f)
 {
     int i, st;
-    wxInt32 x;
     wxInt32 version;
 
     /* load header - version info : */
-
-    f->Read(&x, sizeof(x));
-    version = wxINT32_SWAP_ON_BE(x);
+    version = CacheReadInt32(f);
 
     if (version != CURRENT_CACHED_BOOK_VERSION)
     {
-        wxLogError(_("Incorrect version of HTML help book"));
+        // NB: We can just silently return FALSE here and don't worry about
+        //     it anymore, because AddBookParam will load the MS project in
+        //     absence of (properly versioned) .cached file and automatically 
+        //     create new .cached file immediately afterward.
         return FALSE;
-        // NOTE: when adding new version, please ensure backward compatibility!
     }
 
     /* load contents : */
-
-    f->Read(&x, sizeof(x));
     st = m_ContentsCnt;
-    m_ContentsCnt += wxINT32_SWAP_ON_BE(x);
+    m_ContentsCnt += CacheReadInt32(f);
     m_Contents = (wxHtmlContentsItem*) realloc(m_Contents,
                                                (m_ContentsCnt / wxHTML_REALLOC_STEP + 1) *
                                                wxHTML_REALLOC_STEP * sizeof(wxHtmlContentsItem));
     for (i = st; i < m_ContentsCnt; i++)
     {
-        f->Read(&x, sizeof(x));
-        m_Contents[i].m_Level = wxINT32_SWAP_ON_BE(x);
-        f->Read(&x, sizeof(x));
-        m_Contents[i].m_ID = wxINT32_SWAP_ON_BE(x);
-        f->Read(&x, sizeof(x)); x = wxINT32_SWAP_ON_BE(x);
-        m_Contents[i].m_Name = new wxChar[x];
-        READ_STRING(f, m_Contents[i].m_Name, x);
-        f->Read(&x, sizeof(x)); x = wxINT32_SWAP_ON_BE(x);
-        m_Contents[i].m_Page = new wxChar[x];
-        READ_STRING(f, m_Contents[i].m_Page, x);
+        m_Contents[i].m_Level = CacheReadInt32(f);
+        m_Contents[i].m_ID = CacheReadInt32(f);
+        m_Contents[i].m_Name = CacheReadString(f);
+        m_Contents[i].m_Page = CacheReadString(f);
         m_Contents[i].m_Book = book;
     }
 
     /* load index : */
-
-    f->Read(&x, sizeof(x));
     st = m_IndexCnt;
-    m_IndexCnt += wxINT32_SWAP_ON_BE(x);
+    m_IndexCnt += CacheReadInt32(f);
     m_Index = (wxHtmlContentsItem*) realloc(m_Index, (m_IndexCnt / wxHTML_REALLOC_STEP + 1) *
                                                      wxHTML_REALLOC_STEP * sizeof(wxHtmlContentsItem));
     for (i = st; i < m_IndexCnt; i++)
     {
-        f->Read(&x, sizeof(x)); x = wxINT32_SWAP_ON_BE(x);
-        m_Index[i].m_Name = new wxChar[x];
-        READ_STRING(f, m_Index[i].m_Name, x);
-        f->Read(&x, sizeof(x)); x = wxINT32_SWAP_ON_BE(x);
-        m_Index[i].m_Page = new wxChar[x];
-        READ_STRING(f, m_Index[i].m_Page, x);
+        m_Index[i].m_Name = CacheReadString(f);
+        m_Index[i].m_Page = CacheReadString(f);
         m_Index[i].m_Book = book;
     }
     return TRUE;
@@ -368,49 +376,39 @@ bool wxHtmlHelpData::LoadCachedBook(wxHtmlBookRecord *book, wxInputStream *f)
 bool wxHtmlHelpData::SaveCachedBook(wxHtmlBookRecord *book, wxOutputStream *f)
 {
     int i;
-    wxInt32 x;
+    wxInt32 cnt;
 
     /* save header - version info : */
-
-    x = wxINT32_SWAP_ON_BE(CURRENT_CACHED_BOOK_VERSION);
-    f->Write(&x, sizeof(x));
+    CacheWriteInt32(f, CURRENT_CACHED_BOOK_VERSION);
 
     /* save contents : */
+    for (cnt = 0, i = 0; i < m_ContentsCnt; i++) 
+        if (m_Contents[i].m_Book == book && m_Contents[i].m_Level > 0)
+            cnt++;
+    CacheWriteInt32(f, cnt);
 
-    x = 0;
-    for (i = 0; i < m_ContentsCnt; i++) if (m_Contents[i].m_Book == book && m_Contents[i].m_Level > 0) x++;
-    x = wxINT32_SWAP_ON_BE(x);
-    f->Write(&x, sizeof(x));
     for (i = 0; i < m_ContentsCnt; i++)
     {
-        if (m_Contents[i].m_Book != book || m_Contents[i].m_Level == 0) continue;
-        x = wxINT32_SWAP_ON_BE(m_Contents[i].m_Level);
-        f->Write(&x, sizeof(x));
-        x = wxINT32_SWAP_ON_BE(m_Contents[i].m_ID);
-        f->Write(&x, sizeof(x));
-        x = wxINT32_SWAP_ON_BE(wxStrlen(m_Contents[i].m_Name) + 1);
-        f->Write(&x, sizeof(x));
-        WRITE_STRING(f, m_Contents[i].m_Name, x);
-        x = wxINT32_SWAP_ON_BE(wxStrlen(m_Contents[i].m_Page) + 1);
-        f->Write(&x, sizeof(x));
-        WRITE_STRING(f, m_Contents[i].m_Page, x);
+        if (m_Contents[i].m_Book != book || m_Contents[i].m_Level == 0) 
+            continue;
+        CacheWriteInt32(f, m_Contents[i].m_Level);
+        CacheWriteInt32(f, m_Contents[i].m_ID);
+        CacheWriteString(f, m_Contents[i].m_Name);
+        CacheWriteString(f, m_Contents[i].m_Page);
     }
 
     /* save index : */
+    for (cnt = 0, i = 0; i < m_IndexCnt; i++) 
+        if (m_Index[i].m_Book == book && m_Index[i].m_Level > 0) 
+            cnt++;
+    CacheWriteInt32(f, cnt);
 
-    x = 0;
-    for (i = 0; i < m_IndexCnt; i++) if (m_Index[i].m_Book == book && m_Index[i].m_Level > 0) x++;
-    x = wxINT32_SWAP_ON_BE(x);
-    f->Write(&x, sizeof(x));
     for (i = 0; i < m_IndexCnt; i++)
     {
-        if (m_Index[i].m_Book != book || m_Index[i].m_Level == 0) continue;
-        x = wxINT32_SWAP_ON_BE(wxStrlen(m_Index[i].m_Name) + 1);
-        f->Write(&x, sizeof(x));
-        WRITE_STRING(f, m_Index[i].m_Name, x);
-        x = wxINT32_SWAP_ON_BE(wxStrlen(m_Index[i].m_Page) + 1);
-        f->Write(&x, sizeof(x));
-        WRITE_STRING(f, m_Index[i].m_Page, x);
+        if (m_Index[i].m_Book != book || m_Index[i].m_Level == 0) 
+            continue;
+        CacheWriteString(f, m_Index[i].m_Name);
+        CacheWriteString(f, m_Index[i].m_Page);
     }
     return TRUE;
 }
@@ -454,11 +452,18 @@ bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile,
     int IndexOld = m_IndexCnt,
         ContentsOld = m_ContentsCnt;
 
-    if (! path.IsEmpty())
+    if (!path.IsEmpty())
         fsys.ChangePathTo(path, TRUE);
 
-    bookr = new wxHtmlBookRecord(fsys.GetPath(), title, deftopic);
+    size_t booksCnt = m_BookRecords.GetCount();
+    for (size_t i = 0; i < booksCnt; i++)
+    {
+        if ( m_BookRecords[i].GetBookFile() == bookfile.GetLocation() )
+            return TRUE; // book is (was) loaded
+    }
 
+    bookr = new wxHtmlBookRecord(bookfile.GetLocation(), fsys.GetPath(), title, deftopic);
+    
     if (m_ContentsCnt % wxHTML_REALLOC_STEP == 0)
         m_Contents = (wxHtmlContentsItem*) realloc(m_Contents, (m_ContentsCnt + wxHTML_REALLOC_STEP) * sizeof(wxHtmlContentsItem));
     m_Contents[m_ContentsCnt].m_Level = 0;
@@ -524,7 +529,7 @@ bool wxHtmlHelpData::AddBookParam(const wxFSFile& bookfile,
 
     m_BookRecords.Add(bookr);
     if (m_IndexCnt > 0)
-        qsort(m_Index, m_IndexCnt, sizeof(wxHtmlContentsItem), IndexCompareFunc);
+        qsort(m_Index, m_IndexCnt, sizeof(wxHtmlContentsItem), wxHtmlHelpIndexCompareFunc);
 
     return TRUE;
 }
@@ -534,7 +539,6 @@ bool wxHtmlHelpData::AddBook(const wxString& book)
 {
     if (book.Right(4).Lower() == wxT(".zip") ||
         book.Right(4).Lower() == wxT(".htb") /*html book*/)
-
     {
         wxFileSystem fsys;
         wxString s;
@@ -549,8 +553,6 @@ bool wxHtmlHelpData::AddBook(const wxString& book)
 
         return rt;
     }
-
-
     else
     {
         wxFSFile *fi;
@@ -558,10 +560,6 @@ bool wxHtmlHelpData::AddBook(const wxString& book)
         wxInputStream *s;
         wxString bookFull;
 
-        int sz;
-        char *buff, *lineptr;
-        char linebuf[300];
-
         wxString title = _("noname"),
                  safetitle,
                  start = wxEmptyString,
@@ -587,31 +585,40 @@ bool wxHtmlHelpData::AddBook(const wxString& book)
         }
         fsys.ChangePathTo(bookFull);
         s = fi->GetStream();
+
+        int sz;
+        char *buff, *lineptr;
+        char linebuf[300];
+
         sz = s->GetSize();
         buff = new char[sz + 1];
         buff[sz] = 0;
         s->Read(buff, sz);
         lineptr = buff;
 
-        do {
-            lineptr = ReadLine(lineptr, linebuf);
-
-            if (strstr(linebuf, "Title=") == linebuf)
-                title = linebuf + strlen("Title=");
-            if (strstr(linebuf, "Default topic=") == linebuf)
-                start = linebuf + strlen("Default topic=");
-            if (strstr(linebuf, "Index file=") == linebuf)
-                index = linebuf + strlen("Index file=");
-            if (strstr(linebuf, "Contents file=") == linebuf)
-                contents = linebuf + strlen("Contents file=");
-            if (strstr(linebuf, "Charset=") == linebuf)
-                charset = linebuf + strlen("Charset=");
+        do 
+        {
+            lineptr = ReadLine(lineptr, linebuf, 300);
+            
+            for (char *ch = linebuf; *ch != '\0' && *ch != '='; ch++)
+               *ch = tolower(*ch);
+
+            if (strstr(linebuf, "title=") == linebuf)
+                title = linebuf + strlen("title=");
+            if (strstr(linebuf, "default topic=") == linebuf)
+                start = linebuf + strlen("default topic=");
+            if (strstr(linebuf, "index file=") == linebuf)
+                index = linebuf + strlen("index file=");
+            if (strstr(linebuf, "contents file=") == linebuf)
+                contents = linebuf + strlen("contents file=");
+            if (strstr(linebuf, "charset=") == linebuf)
+                charset = linebuf + strlen("charset=");
         } while (lineptr != NULL);
         delete[] buff;
 
         wxFontEncoding enc;
         if (charset == wxEmptyString) enc = wxFONTENCODING_SYSTEM;
-        else enc = wxTheFontMapper->CharsetToEncoding(charset);
+        else enc = wxFontMapper::Get()->CharsetToEncoding(charset);
         bool rtval = AddBookParam(*fi, enc,
                                   title, contents, index, start, fsys.GetPath());
         delete fi;