Committing in .

[wxWidgets.git] / src / common / fileconf.cpp

diff --git a/src/common/fileconf.cpp b/src/common/fileconf.cpp
index beaaab32e0640e24f6b9c1227acaa16bd2cba678..022a830255062a0ad495db9e1edc9e4be3433d71 100644 (file)
--- a/src/common/fileconf.cpp
+++ b/src/common/fileconf.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        fileconf.cpp
+// Name:        src/common/fileconf.cpp

 // Purpose:     implementation of wxFileConfig derivation of wxConfig
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     implementation of wxFileConfig derivation of wxConfig
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -10,10 +10,6 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "fileconf.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -49,6 +45,7 @@
 
 #if defined(__WXMAC__)
   #include  "wx/mac/private.h"  // includes mac headers
 
 #if defined(__WXMAC__)
   #include  "wx/mac/private.h"  // includes mac headers

+  #include  "wx/filename.h"     // for MacSetTypeAndCreator

 #endif
 
 #if defined(__WXMSW__)
 #endif
 
 #if defined(__WXMSW__)


@@ -274,7 +271,7 @@ wxString wxFileConfig::GetGlobalDir()
     strDir = wxMacFindFolder(  (short) kOnSystemDisk, kPreferencesFolderType, kDontCreateFolder ) ;
 #elif defined( __UNIX__ )
     strDir = wxT("/etc/");
     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;
     ULONG aulSysInfo[QSV_MAX] = {0};
     UINT drive;
     APIRET rc;


@@ -291,7 +288,10 @@ wxString wxFileConfig::GetGlobalDir()
     // There's no such thing as global cfg dir in MS-DOS, let's return
     // current directory (FIXME_MGL?)
     return wxT(".\\");
     // There's no such thing as global cfg dir in MS-DOS, let's return
     // current directory (FIXME_MGL?)
     return wxT(".\\");

+#elif defined(__WXWINCE__)
+    strDir = wxT("\\Windows\\");

 #else // Windows
 #else // Windows

+

     wxChar szWinDir[MAX_PATH];
     ::GetWindowsDirectory(szWinDir, MAX_PATH);
 
     wxChar szWinDir[MAX_PATH];
     ::GetWindowsDirectory(szWinDir, MAX_PATH);
 


@@ -378,7 +378,7 @@ wxString wxFileConfig::GetLocalFileName(const wxChar *szFile)
 void wxFileConfig::Init()
 {
     m_pCurrentGroup =
 void wxFileConfig::Init()
 {
     m_pCurrentGroup =

-    m_pRootGroup    = new wxFileConfigGroup(NULL, wxT(""), this);
+    m_pRootGroup    = new wxFileConfigGroup(NULL, wxEmptyString, this);

 
     m_linesHead =
     m_linesTail = NULL;
 
     m_linesHead =
     m_linesTail = NULL;


@@ -386,7 +386,7 @@ void wxFileConfig::Init()
     // It's not an error if (one of the) file(s) doesn't exist.
 
     // parse the global file
     // It's not an error if (one of the) file(s) doesn't exist.
 
     // parse the global file

-    if ( !m_strGlobalFile.IsEmpty() && wxFile::Exists(m_strGlobalFile) )
+    if ( !m_strGlobalFile.empty() && wxFile::Exists(m_strGlobalFile) )

     {
         wxTextFile fileGlobal(m_strGlobalFile);
 
     {
         wxTextFile fileGlobal(m_strGlobalFile);
 


@@ -402,7 +402,7 @@ void wxFileConfig::Init()
     }
 
     // parse the local file
     }
 
     // parse the local file

-    if ( !m_strLocalFile.IsEmpty() && wxFile::Exists(m_strLocalFile) )
+    if ( !m_strLocalFile.empty() && wxFile::Exists(m_strLocalFile) )

     {
         wxTextFile fileLocal(m_strLocalFile);
         if ( fileLocal.Open(m_conv/*ignored in ANSI build*/) )
     {
         wxTextFile fileLocal(m_strLocalFile);
         if ( fileLocal.Open(m_conv/*ignored in ANSI build*/) )


@@ -430,36 +430,36 @@ wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName,
               m_conv(conv)
 {
     // Make up names for files if empty
               m_conv(conv)
 {
     // Make up names for files if empty

-    if ( m_strLocalFile.IsEmpty() && (style & wxCONFIG_USE_LOCAL_FILE) )
+    if ( m_strLocalFile.empty() && (style & wxCONFIG_USE_LOCAL_FILE) )

         m_strLocalFile = GetLocalFileName(GetAppName());
 
         m_strLocalFile = GetLocalFileName(GetAppName());
 

-    if ( m_strGlobalFile.IsEmpty() && (style & wxCONFIG_USE_GLOBAL_FILE) )
+    if ( m_strGlobalFile.empty() && (style & wxCONFIG_USE_GLOBAL_FILE) )

         m_strGlobalFile = GetGlobalFileName(GetAppName());
 
     // Check if styles are not supplied, but filenames are, in which case
     // add the correct styles.
         m_strGlobalFile = GetGlobalFileName(GetAppName());
 
     // Check if styles are not supplied, but filenames are, in which case
     // add the correct styles.

-    if ( !m_strLocalFile.IsEmpty() )
+    if ( !m_strLocalFile.empty() )

         SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
 
         SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
 

-    if ( !m_strGlobalFile.IsEmpty() )
+    if ( !m_strGlobalFile.empty() )

         SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE);
 
     // if the path is not absolute, prepend the standard directory to it
     // UNLESS wxCONFIG_USE_RELATIVE_PATH style is set
     if ( !(style & wxCONFIG_USE_RELATIVE_PATH) )
     {
         SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE);
 
     // if the path is not absolute, prepend the standard directory to it
     // UNLESS wxCONFIG_USE_RELATIVE_PATH style is set
     if ( !(style & wxCONFIG_USE_RELATIVE_PATH) )
     {

-        if ( !m_strLocalFile.IsEmpty() && !wxIsAbsolutePath(m_strLocalFile) )
+        if ( !m_strLocalFile.empty() && !wxIsAbsolutePath(m_strLocalFile) )

         {
         {

-            wxString strLocal = m_strLocalFile;
+            const wxString strLocalOrig = m_strLocalFile;

             m_strLocalFile = GetLocalDir();
             m_strLocalFile = GetLocalDir();

-            m_strLocalFile << strLocal;
+            m_strLocalFile << strLocalOrig;

         }
 
         }
 

-        if ( !m_strGlobalFile.IsEmpty() && !wxIsAbsolutePath(m_strGlobalFile) )
+        if ( !m_strGlobalFile.empty() && !wxIsAbsolutePath(m_strGlobalFile) )

         {
         {

-            wxString strGlobal = m_strGlobalFile;
+            const wxString strGlobalOrig = m_strGlobalFile;

             m_strGlobalFile = GetGlobalDir();
             m_strGlobalFile = GetGlobalDir();

-            m_strGlobalFile << strGlobal;
+            m_strGlobalFile << strGlobalOrig;

         }
     }
 
         }
     }
 


@@ -477,7 +477,7 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
     SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
 
     m_pCurrentGroup =
     SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
 
     m_pCurrentGroup =

-    m_pRootGroup    = new wxFileConfigGroup(NULL, wxT(""), this);
+    m_pRootGroup    = new wxFileConfigGroup(NULL, wxEmptyString, this);

 
     m_linesHead =
     m_linesTail = NULL;
 
     m_linesHead =
     m_linesTail = NULL;


@@ -491,7 +491,7 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
         char buf[1024];
         do
         {
         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();
 
 
             const wxStreamError err = inStream.GetLastError();
 


@@ -501,7 +501,12 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
                 break;
             }
 
                 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() );
 
         }
         while ( !inStream.Eof() );
 


@@ -539,6 +544,7 @@ wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
     Parse(memText, true /* local */);
 
     SetRootPath();
     Parse(memText, true /* local */);
 
     SetRootPath();

+    ResetDirty();

 }
 
 #endif // wxUSE_STREAMS
 }
 
 #endif // wxUSE_STREAMS


@@ -566,7 +572,7 @@ wxFileConfig::~wxFileConfig()
 // parse a config file
 // ----------------------------------------------------------------------------
 
 // 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;
 {
   const wxChar *pStart;
   const wxChar *pEnd;


@@ -583,7 +589,7 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal)
     {
       LineListAppend(strLine);
 
     {
       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);
       if ( !n )
       {
         m_pCurrentGroup->SetLine(m_linesTail);


@@ -658,7 +664,7 @@ void wxFileConfig::Parse(wxTextBuffer& buffer, bool bLocal)
       }
     }
     else {                        // a key
       }
     }
     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
       while ( *pEnd && *pEnd != wxT('=') /* && !wxIsspace(*pEnd)*/ ) {
         if ( *pEnd == wxT('\\') ) {
           // next character may be space or not - still take it because it's


@@ -736,13 +742,14 @@ void wxFileConfig::SetRootPath()
   m_pCurrentGroup = m_pRootGroup;
 }
 
   m_pCurrentGroup = m_pRootGroup;
 }
 

-void wxFileConfig::SetPath(const wxString& strPath)
+bool
+wxFileConfig::DoSetPath(const wxString& strPath, bool createMissingComponents)

 {
   wxArrayString aParts;
 
 {
   wxArrayString aParts;
 

-  if ( strPath.IsEmpty() ) {
+  if ( strPath.empty() ) {

     SetRootPath();
     SetRootPath();

-    return;
+    return true;

   }
 
   if ( strPath[0] == wxCONFIG_PATH_SEPARATOR ) {
   }
 
   if ( strPath[0] == wxCONFIG_PATH_SEPARATOR ) {


@@ -762,7 +769,13 @@ void wxFileConfig::SetPath(const wxString& strPath)
   for ( n = 0; n < aParts.Count(); n++ ) {
     wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]);
     if ( pNextGroup == NULL )
   for ( n = 0; n < aParts.Count(); n++ ) {
     wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]);
     if ( pNextGroup == NULL )

+    {
+      if ( !createMissingComponents )
+        return false;
+

       pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]);
       pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]);

+    }
+

     m_pCurrentGroup = pNextGroup;
   }
 
     m_pCurrentGroup = pNextGroup;
   }
 


@@ -771,6 +784,13 @@ void wxFileConfig::SetPath(const wxString& strPath)
   for ( n = 0; n < aParts.Count(); n++ ) {
     m_strPath << wxCONFIG_PATH_SEPARATOR << aParts[n];
   }
   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 */);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -847,10 +867,20 @@ size_t wxFileConfig::GetNumberOfGroups(bool bRecursive) const
 
 bool wxFileConfig::HasGroup(const wxString& strName) 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 */);

 
 

-  wxFileConfigGroup *pGroup = m_pCurrentGroup->FindSubgroup(path.Name());
-  return pGroup != NULL;
+  self->SetPath(pathOld);
+
+  return rc;

 }
 
 bool wxFileConfig::HasEntry(const wxString& strName) const
 }
 
 bool wxFileConfig::HasEntry(const wxString& strName) const


@@ -902,11 +932,11 @@ bool wxFileConfig::DoWriteString(const wxString& key, const wxString& szValue)
                 szValue.c_str(),
                 GetPath().c_str() );
 
                 szValue.c_str(),
                 GetPath().c_str() );
 

-    if ( strName.IsEmpty() )
+    if ( strName.empty() )

     {
             // setting the value of a group is an error
 
     {
             // setting the value of a group is an error
 

-        wxASSERT_MSG( wxIsEmpty(szValue), wxT("can't set value of a group!") );
+        wxASSERT_MSG( szValue.empty(), wxT("can't set value of a group!") );

 
             // ... except if it's empty in which case it's a way to force it's creation
 
 
             // ... except if it's empty in which case it's a way to force it's creation
 


@@ -1009,7 +1039,9 @@ bool wxFileConfig::Save(wxOutputStream& os, wxMBConv& conv)
     {
         wxString line = p->Text();
         line += wxTextFile::GetEOL();
     {
         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."));
 
         {
             wxLogError(_("Error saving user configuration data."));
 


@@ -1086,12 +1118,13 @@ bool wxFileConfig::DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso)
   if ( !m_pCurrentGroup->DeleteEntry(path.Name()) )
     return false;
 
   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 ( 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
   }
     }
     //else: never delete the root group
   }


@@ -1125,7 +1158,7 @@ bool wxFileConfig::DeleteAll()
       }
 
       m_strLocalFile =
       }
 
       m_strLocalFile =

-      m_strGlobalFile = wxT("");
+      m_strGlobalFile = wxEmptyString;

   }
 
   Init();
   }
 
   Init();


@@ -1252,6 +1285,9 @@ void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine)
     else
         pNext->SetPrev(pPrev);
 
     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) );
     wxLogTrace( FILECONF_TRACE_MASK,
                 _T("        head: %s"),
                 ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );


@@ -1311,7 +1347,11 @@ wxFileConfigGroup::~wxFileConfigGroup()
 
 void wxFileConfigGroup::SetLine(wxFileConfigLineList *pLine)
 {
 
 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;
 }
 
     m_pLine = pLine;
 }
 


@@ -1766,7 +1806,7 @@ wxFileConfigEntry::wxFileConfigEntry(wxFileConfigGroup *pParent,
                                        int nLine)
                          : m_strName(strName)
 {
                                        int nLine)
                          : m_strName(strName)
 {

-  wxASSERT( !strName.IsEmpty() );
+  wxASSERT( !strName.empty() );

 
   m_pParent = pParent;
   m_nLine   = nLine;
 
   m_pParent = pParent;
   m_nLine   = nLine;


@@ -1835,7 +1875,10 @@ void wxFileConfigEntry::SetValue(const wxString& strValue, bool bUser)
         }
         else // this entry didn't exist in the local file
         {
         }
         else // this entry didn't exist in the local file
         {

-            // add a new line to the file
+            // 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();
             m_pLine = Group()->Config()->LineListInsert(strLine, line);
 
             wxFileConfigLineList *line = Group()->GetLastEntryLine();
             m_pLine = Group()->Config()->LineListInsert(strLine, line);
 


@@ -1880,7 +1923,7 @@ static wxString FilterInValue(const wxString& str)
   wxString strResult;
   strResult.Alloc(str.Len());
 
   wxString strResult;
   strResult.Alloc(str.Len());
 

-  bool bQuoted = !str.IsEmpty() && str[0] == '"';
+  bool bQuoted = !str.empty() && str[0] == '"';

 
   for ( size_t n = bQuoted ? 1 : 0; n < str.Len(); n++ ) {
     if ( str[n] == wxT('\\') ) {
 
   for ( size_t n = bQuoted ? 1 : 0; n < str.Len(); n++ ) {
     if ( str[n] == wxT('\\') ) {


@@ -2033,4 +2076,3 @@ static wxString GetAppName(const wxString& appName)
 }
 
 #endif // wxUSE_CONFIG
 }
 
 #endif // wxUSE_CONFIG

-