]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/fileconf.cpp
1. use a manifest constant wxNO_LEN instead of -1 for lengths everywhere
[wxWidgets.git] / src / common / fileconf.cpp
index 5847840f55f5d3f397e30415a4a5cf860597659f..1b0eb091a3d7e7be5d1d8973a03a907f055e6936 100644 (file)
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        fileconf.cpp
+// Name:        src/common/fileconf.cpp
 // Purpose:     implementation of wxFileConfig derivation of wxConfig
 // Author:      Vadim Zeitlin
 // Modified by:
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "fileconf.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
@@ -275,7 +271,7 @@ wxString wxFileConfig::GetGlobalDir()
     strDir = wxMacFindFolder(  (short) kOnSystemDisk, kPreferencesFolderType, kDontCreateFolder ) ;
 #elif defined( __UNIX__ )
     strDir = wxT("/etc/");
-#elif defined(__WXPM__)
+#elif defined(__OS2__)
     ULONG aulSysInfo[QSV_MAX] = {0};
     UINT drive;
     APIRET rc;
@@ -291,7 +287,7 @@ wxString wxFileConfig::GetGlobalDir()
 #elif defined(__DOS__)
     // There's no such thing as global cfg dir in MS-DOS, let's return
     // current directory (FIXME_MGL?)
-    return wxT(".\\");
+    strDir = wxT(".\\");
 #elif defined(__WXWINCE__)
     strDir = wxT("\\Windows\\");
 #else // Windows
@@ -312,18 +308,22 @@ wxString wxFileConfig::GetLocalDir()
 
 #if defined(__WXMAC__) || defined(__DOS__)
     // no local dir concept on Mac OS 9 or MS-DOS
-    return GetGlobalDir() ;
+    strDir << GetGlobalDir() ;
 #else
     wxGetHomeDir(&strDir);
 
-#ifdef  __UNIX__
-#ifdef __VMS
-    if (strDir.Last() != wxT(']'))
-#endif
-    if (strDir.Last() != wxT('/')) strDir << wxT('/');
-#else
-    if (strDir.Last() != wxT('\\')) strDir << wxT('\\');
-#endif
+    #ifdef  __UNIX__
+        if (
+            (strDir.Last() != wxT('/'))
+        #ifdef __VMS
+            && (strDir.Last() != wxT(']'))
+        #endif
+            )
+            strDir << wxT('/');
+    #else
+        if (strDir.Last() != wxT('\\'))
+            strDir << wxT('\\');
+    #endif
 #endif
 
     return strDir;
@@ -394,7 +394,7 @@ void wxFileConfig::Init()
     {
         wxTextFile fileGlobal(m_strGlobalFile);
 
-        if ( fileGlobal.Open(m_conv/*ignored in ANSI build*/) )
+        if ( fileGlobal.Open(*m_conv/*ignored in ANSI build*/) )
         {
             Parse(fileGlobal, false /* global */);
             SetRootPath();
@@ -409,7 +409,7 @@ void wxFileConfig::Init()
     if ( !m_strLocalFile.empty() && wxFile::Exists(m_strLocalFile) )
     {
         wxTextFile fileLocal(m_strLocalFile);
-        if ( fileLocal.Open(m_conv/*ignored in ANSI build*/) )
+        if ( fileLocal.Open(*m_conv/*ignored in ANSI build*/) )
         {
             Parse(fileLocal, true /* local */);
             SetRootPath();
@@ -426,12 +426,13 @@ void wxFileConfig::Init()
 // constructor supports creation of wxFileConfig objects of any type
 wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName,
                            const wxString& strLocal, const wxString& strGlobal,
-                           long style, wxMBConv& conv)
+                           long style,
+                           const wxMBConv& conv)
             : wxConfigBase(::GetAppName(appName), vendorName,
                            strLocal, strGlobal,
                            style),
               m_strLocalFile(strLocal), m_strGlobalFile(strGlobal),
-              m_conv(conv)
+              m_conv(conv.Clone())
 {
     // Make up names for files if empty
     if ( m_strLocalFile.empty() && (style & wxCONFIG_USE_LOCAL_FILE) )
@@ -454,16 +455,16 @@ wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName,
     {
         if ( !m_strLocalFile.empty() && !wxIsAbsolutePath(m_strLocalFile) )
         {
-            wxString strLocal = m_strLocalFile;
+            const wxString strLocalOrig = m_strLocalFile;
             m_strLocalFile = GetLocalDir();
-            m_strLocalFile << strLocal;
+            m_strLocalFile << strLocalOrig;
         }
 
         if ( !m_strGlobalFile.empty() && !wxIsAbsolutePath(m_strGlobalFile) )
         {
-            wxString strGlobal = m_strGlobalFile;
+            const wxString strGlobalOrig = m_strGlobalFile;
             m_strGlobalFile = GetGlobalDir();
-            m_strGlobalFile << strGlobal;
+            m_strGlobalFile << strGlobalOrig;
         }
     }
 
@@ -474,8 +475,8 @@ wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName,
 
 #if wxUSE_STREAMS
 
-wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
-            : m_conv(conv)
+wxFileConfig::wxFileConfig(wxInputStream &inStream, const wxMBConv& conv)
+            : m_conv(conv.Clone())
 {
     // always local_file when this constructor is called (?)
     SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
@@ -495,7 +496,7 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
         char buf[1024];
         do
         {
-            inStream.Read(buf, WXSIZEOF(buf));
+            inStream.Read(buf, WXSIZEOF(buf)-1);  // leave room for the NULL
 
             const wxStreamError err = inStream.GetLastError();
 
@@ -505,7 +506,12 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
                 break;
             }
 
-            strTmp.append(wxConvertMB2WX(buf), inStream.LastRead());
+            // FIXME: this is broken because if we have part of multibyte
+            //        character in the buffer (and another part hasn't been
+            //        read yet) we're going to lose data because of conversion
+            //        errors
+            buf[inStream.LastRead()] = '\0';
+            strTmp += conv.cMB2WX(buf);
         }
         while ( !inStream.Eof() );
 
@@ -543,34 +549,35 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
     Parse(memText, true /* local */);
 
     SetRootPath();
+    ResetDirty();
 }
 
 #endif // wxUSE_STREAMS
 
 void wxFileConfig::CleanUp()
 {
-  delete m_pRootGroup;
+    delete m_pRootGroup;
 
-  wxFileConfigLineList *pCur = m_linesHead;
-  while ( pCur != NULL ) {
-    wxFileConfigLineList *pNext = pCur->Next();
-    delete pCur;
-    pCur = pNext;
-  }
+    wxFileConfigLineList *pCur = m_linesHead;
+    while ( pCur != NULL ) {
+        wxFileConfigLineList *pNext = pCur->Next();
+        delete pCur;
+        pCur = pNext;
+    }
 }
 
 wxFileConfig::~wxFileConfig()
 {
-  Flush();
+    Flush();
 
-  CleanUp();
+    CleanUp();
 }
 
 // ----------------------------------------------------------------------------
 // parse a config file
 // ----------------------------------------------------------------------------
 
-void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal)
+void wxFileConfig::Parse(const wxTextBuffer& buffer, bool bLocal)
 {
   const wxChar *pStart;
   const wxChar *pEnd;
@@ -587,7 +594,7 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal)
     {
       LineListAppend(strLine);
 
-      // let the root group have it start line as well
+      // let the root group have its start line as well
       if ( !n )
       {
         m_pCurrentGroup->SetLine(m_linesTail);
@@ -662,7 +669,7 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal)
       }
     }
     else {                        // a key
-      const wxChar *pEnd = pStart;
+      pEnd = pStart;
       while ( *pEnd && *pEnd != wxT('=') /* && !wxIsspace(*pEnd)*/ ) {
         if ( *pEnd == wxT('\\') ) {
           // next character may be space or not - still take it because it's
@@ -736,45 +743,59 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal)
 
 void wxFileConfig::SetRootPath()
 {
-  m_strPath.Empty();
-  m_pCurrentGroup = m_pRootGroup;
+    m_strPath.Empty();
+    m_pCurrentGroup = m_pRootGroup;
 }
 
-void wxFileConfig::SetPath(const wxString& strPath)
+bool
+wxFileConfig::DoSetPath(const wxString& strPath, bool createMissingComponents)
 {
-  wxArrayString aParts;
+    wxArrayString aParts;
 
-  if ( strPath.empty() ) {
-    SetRootPath();
-    return;
-  }
+    if ( strPath.empty() ) {
+        SetRootPath();
+        return true;
+    }
 
-  if ( strPath[0] == wxCONFIG_PATH_SEPARATOR ) {
-    // absolute path
-    wxSplitPath(aParts, strPath);
-  }
-  else {
-    // relative path, combine with current one
-    wxString strFullPath = m_strPath;
-    strFullPath << wxCONFIG_PATH_SEPARATOR << strPath;
-    wxSplitPath(aParts, strFullPath);
-  }
+    if ( strPath[0] == wxCONFIG_PATH_SEPARATOR ) {
+        // absolute path
+        wxSplitPath(aParts, strPath);
+    }
+    else {
+        // relative path, combine with current one
+        wxString strFullPath = m_strPath;
+        strFullPath << wxCONFIG_PATH_SEPARATOR << strPath;
+        wxSplitPath(aParts, strFullPath);
+    }
 
-  // change current group
-  size_t n;
-  m_pCurrentGroup = m_pRootGroup;
-  for ( n = 0; n < aParts.Count(); n++ ) {
-    wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]);
-    if ( pNextGroup == NULL )
-      pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]);
-    m_pCurrentGroup = pNextGroup;
-  }
+    // change current group
+    size_t n;
+    m_pCurrentGroup = m_pRootGroup;
+    for ( n = 0; n < aParts.Count(); n++ ) {
+        wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]);
+        if ( pNextGroup == NULL )
+        {
+            if ( !createMissingComponents )
+                return false;
 
-  // recombine path parts in one variable
-  m_strPath.Empty();
-  for ( n = 0; n < aParts.Count(); n++ ) {
-    m_strPath << wxCONFIG_PATH_SEPARATOR << aParts[n];
-  }
+            pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]);
+        }
+
+        m_pCurrentGroup = pNextGroup;
+    }
+
+    // recombine path parts in one variable
+    m_strPath.Empty();
+    for ( n = 0; n < aParts.Count(); n++ ) {
+        m_strPath << wxCONFIG_PATH_SEPARATOR << aParts[n];
+    }
+
+    return true;
+}
+
+void wxFileConfig::SetPath(const wxString& strPath)
+{
+    DoSetPath(strPath, true /* create missing path components */);
 }
 
 // ----------------------------------------------------------------------------
@@ -783,66 +804,66 @@ void wxFileConfig::SetPath(const wxString& strPath)
 
 bool wxFileConfig::GetFirstGroup(wxString& str, long& lIndex) const
 {
-  lIndex = 0;
-  return GetNextGroup(str, lIndex);
+    lIndex = 0;
+    return GetNextGroup(str, lIndex);
 }
 
 bool wxFileConfig::GetNextGroup (wxString& str, long& lIndex) const
 {
-  if ( size_t(lIndex) < m_pCurrentGroup->Groups().Count() ) {
-    str = m_pCurrentGroup->Groups()[(size_t)lIndex++]->Name();
-    return true;
-  }
-  else
-    return false;
+    if ( size_t(lIndex) < m_pCurrentGroup->Groups().Count() ) {
+        str = m_pCurrentGroup->Groups()[(size_t)lIndex++]->Name();
+        return true;
+    }
+    else
+        return false;
 }
 
 bool wxFileConfig::GetFirstEntry(wxString& str, long& lIndex) const
 {
-  lIndex = 0;
-  return GetNextEntry(str, lIndex);
+    lIndex = 0;
+    return GetNextEntry(str, lIndex);
 }
 
 bool wxFileConfig::GetNextEntry (wxString& str, long& lIndex) const
 {
-  if ( size_t(lIndex) < m_pCurrentGroup->Entries().Count() ) {
-    str = m_pCurrentGroup->Entries()[(size_t)lIndex++]->Name();
-    return true;
-  }
-  else
-    return false;
+    if ( size_t(lIndex) < m_pCurrentGroup->Entries().Count() ) {
+        str = m_pCurrentGroup->Entries()[(size_t)lIndex++]->Name();
+        return true;
+    }
+    else
+        return false;
 }
 
 size_t wxFileConfig::GetNumberOfEntries(bool bRecursive) const
 {
-  size_t n = m_pCurrentGroup->Entries().Count();
-  if ( bRecursive ) {
-    wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
-    size_t nSubgroups = m_pCurrentGroup->Groups().Count();
-    for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
-      CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
-      n += GetNumberOfEntries(true);
-      CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
+    size_t n = m_pCurrentGroup->Entries().Count();
+    if ( bRecursive ) {
+        wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
+        size_t nSubgroups = m_pCurrentGroup->Groups().Count();
+        for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
+            CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
+            n += GetNumberOfEntries(true);
+            CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
+        }
     }
-  }
 
-  return n;
+    return n;
 }
 
 size_t wxFileConfig::GetNumberOfGroups(bool bRecursive) const
 {
-  size_t n = m_pCurrentGroup->Groups().Count();
-  if ( bRecursive ) {
-    wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
-    size_t nSubgroups = m_pCurrentGroup->Groups().Count();
-    for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
-      CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
-      n += GetNumberOfGroups(true);
-      CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
+    size_t n = m_pCurrentGroup->Groups().Count();
+    if ( bRecursive ) {
+        wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
+        size_t nSubgroups = m_pCurrentGroup->Groups().Count();
+        for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
+            CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
+            n += GetNumberOfGroups(true);
+            CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
+        }
     }
-  }
 
-  return n;
+    return n;
 }
 
 // ----------------------------------------------------------------------------
@@ -851,18 +872,28 @@ size_t wxFileConfig::GetNumberOfGroups(bool bRecursive) const
 
 bool wxFileConfig::HasGroup(const wxString& strName) const
 {
-  wxConfigPathChanger path(this, strName);
+    // special case: DoSetPath("") does work as it's equivalent to DoSetPath("/")
+    // but there is no group with empty name so treat this separately
+    if ( strName.empty() )
+        return false;
+
+    const wxString pathOld = GetPath();
+
+    wxFileConfig *self = wx_const_cast(wxFileConfig *, this);
+    const bool
+        rc = self->DoSetPath(strName, false /* don't create missing components */);
+
+    self->SetPath(pathOld);
 
-  wxFileConfigGroup *pGroup = m_pCurrentGroup->FindSubgroup(path.Name());
-  return pGroup != NULL;
+    return rc;
 }
 
 bool wxFileConfig::HasEntry(const wxString& strName) const
 {
-  wxConfigPathChanger path(this, strName);
+    wxConfigPathChanger path(this, strName);
 
-  wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
-  return pEntry != NULL;
+    wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
+    return pEntry != NULL;
 }
 
 // ----------------------------------------------------------------------------
@@ -871,16 +902,16 @@ bool wxFileConfig::HasEntry(const wxString& strName) const
 
 bool wxFileConfig::DoReadString(const wxString& key, wxString* pStr) const
 {
-  wxConfigPathChanger path(this, key);
+    wxConfigPathChanger path(this, key);
 
-  wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
-  if (pEntry == NULL) {
-    return false;
-  }
+    wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
+    if (pEntry == NULL) {
+        return false;
+    }
 
-  *pStr = pEntry->Value();
+    *pStr = pEntry->Value();
 
-  return true;
+    return true;
 }
 
 bool wxFileConfig::DoReadLong(const wxString& key, long *pl) const
@@ -981,7 +1012,7 @@ bool wxFileConfig::Flush(bool /* bCurrentOnly */)
   {
     wxString line = p->Text();
     line += wxTextFile::GetEOL();
-    if ( !file.Write(line, m_conv) )
+    if ( !file.Write(line, *m_conv) )
     {
       wxLogError(_("can't write user configuration file."));
       return false;
@@ -1006,14 +1037,16 @@ bool wxFileConfig::Flush(bool /* bCurrentOnly */)
 
 #if wxUSE_STREAMS
 
-bool wxFileConfig::Save(wxOutputStream& os, wxMBConv& conv)
+bool wxFileConfig::Save(wxOutputStream& os, const wxMBConv& conv)
 {
     // save unconditionally, even if not dirty
     for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() )
     {
         wxString line = p->Text();
         line += wxTextFile::GetEOL();
-        if ( !os.Write(line.mb_str(conv), line.length()) )
+
+        wxCharBuffer buf(line.mb_str(conv));
+        if ( !os.Write(buf, strlen(buf)) )
         {
             wxLogError(_("Error saving user configuration data."));
 
@@ -1090,12 +1123,13 @@ bool wxFileConfig::DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso)
   if ( !m_pCurrentGroup->DeleteEntry(path.Name()) )
     return false;
 
+  SetDirty();
+
   if ( bGroupIfEmptyAlso && m_pCurrentGroup->IsEmpty() ) {
     if ( m_pCurrentGroup != m_pRootGroup ) {
       wxFileConfigGroup *pGroup = m_pCurrentGroup;
       SetPath(wxT(".."));  // changes m_pCurrentGroup!
-      if ( m_pCurrentGroup->DeleteSubgroupByName(pGroup->Name()) )
-          SetDirty();
+      m_pCurrentGroup->DeleteSubgroupByName(pGroup->Name());
     }
     //else: never delete the root group
   }
@@ -1127,9 +1161,6 @@ bool wxFileConfig::DeleteAll()
                         m_strLocalFile.c_str());
           return false;
       }
-
-      m_strLocalFile =
-      m_strGlobalFile = wxEmptyString;
   }
 
   Init();
@@ -1256,6 +1287,9 @@ void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine)
     else
         pNext->SetPrev(pPrev);
 
+    if ( m_pRootGroup->GetGroupLine() == pLine )
+        m_pRootGroup->SetLine(m_linesHead);
+
     wxLogTrace( FILECONF_TRACE_MASK,
                 _T("        head: %s"),
                 ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
@@ -1315,7 +1349,11 @@ wxFileConfigGroup::~wxFileConfigGroup()
 
 void wxFileConfigGroup::SetLine(wxFileConfigLineList *pLine)
 {
-    wxASSERT( m_pLine == 0 ); // shouldn't be called twice
+    // for a normal (i.e. not root) group this method shouldn't be called twice
+    // unless we are resetting the line
+    wxASSERT_MSG( !m_pParent || !m_pLine || !pLine,
+                   _T("changing line for a non-root group?") );
+
     m_pLine = pLine;
 }
 
@@ -1839,20 +1877,11 @@ void wxFileConfigEntry::SetValue(const wxString& strValue, bool bUser)
         }
         else // this entry didn't exist in the local file
         {
-            // add a new line to the file: note the hack for the root group
-            // which is special in that it doesn't have its own group line
-            // (something like "[/]") and so the line we get for it may be not
-            // its line at all if it doesn't have any entries
-            //
-            // this is definitely not the right place to fix it but changing
-            // the root group to have NULL m_pLine will probably break too
-            // much stuff elsewhere so I don't dare to do it...
+            // add a new line to the file: note that line returned by
+            // GetLastEntryLine() may be NULL if we're in the root group and it
+            // doesn't have any entries yet, but this is ok as passing NULL
+            // line to LineListInsert() means to prepend new line to the list
             wxFileConfigLineList *line = Group()->GetLastEntryLine();
-            if ( !Group()->Parent() && line == Group()->GetGroupLine() )
-            {
-                // prepend the first root group entry to the head of the list
-                line = NULL;
-            }
             m_pLine = Group()->Config()->LineListInsert(strLine, line);
 
             Group()->SetLastEntry(this);
@@ -1999,8 +2028,11 @@ static wxString FilterInEntryName(const wxString& str)
   strResult.Alloc(str.Len());
 
   for ( const wxChar *pc = str.c_str(); *pc != '\0'; pc++ ) {
-    if ( *pc == wxT('\\') )
-      pc++;
+    if ( *pc == wxT('\\') ) {
+      // we need to test it here or we'd skip past the NUL in the loop line
+      if ( *++pc == _T('\0') )
+        break;
+    }
 
     strResult += *pc;
   }
@@ -2049,4 +2081,3 @@ static wxString GetAppName(const wxString& appName)
 }
 
 #endif // wxUSE_CONFIG
-