]> git.saurik.com Git - wxWidgets.git/blob - src/common/fileconf.cpp
projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Improve extended key handling code readability.
[wxWidgets.git] / src / common / fileconf.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/fileconf.cpp
3 // Purpose: implementation of wxFileConfig derivation of wxConfig
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 07.04.98 (adapted from appconf.cpp)
7 // RCS-ID: $Id$
8 // Copyright: (c) 1997 Karsten Ballüder & Vadim Zeitlin
9 // Ballueder@usa.net <zeitlin@dptmaths.ens-cachan.fr>
10 // Licence: wxWindows licence
11 ///////////////////////////////////////////////////////////////////////////////
12
13 // ----------------------------------------------------------------------------
14 // headers
15 // ----------------------------------------------------------------------------
16
17 #include "wx/wxprec.h"
18
19 #ifdef __BORLANDC__
20 #pragma hdrstop
21 #endif //__BORLANDC__
22
23 #if wxUSE_CONFIG && wxUSE_FILECONFIG
24
25 #ifndef WX_PRECOMP
26 #include "wx/string.h"
27 #include "wx/intl.h"
28 #endif //WX_PRECOMP
29
30 #include "wx/app.h"
31 #include "wx/dynarray.h"
32 #include "wx/file.h"
33 #include "wx/log.h"
34 #include "wx/textfile.h"
35 #include "wx/memtext.h"
36 #include "wx/config.h"
37 #include "wx/fileconf.h"
38 #include "wx/filefn.h"
39
40 #if wxUSE_STREAMS
41 #include "wx/stream.h"
42 #endif // wxUSE_STREAMS
43
44 #include "wx/utils.h" // for wxGetHomeDir
45
46 #if defined(__WXMAC__)
47 #include "wx/mac/private.h" // includes mac headers
48 #include "wx/filename.h" // for MacSetTypeAndCreator
49 #endif
50
51 #if defined(__WXMSW__)
52 #include "wx/msw/private.h"
53 #endif //windows.h
54 #if defined(__WXPM__)
55 #define INCL_DOS
56 #include <os2.h>
57 #endif
58
59 #include <stdlib.h>
60 #include <ctype.h>
61
62 // ----------------------------------------------------------------------------
63 // macros
64 // ----------------------------------------------------------------------------
65 #define CONST_CAST ((wxFileConfig *)this)->
66
67 // ----------------------------------------------------------------------------
68 // constants
69 // ----------------------------------------------------------------------------
70
71 #ifndef MAX_PATH
72 #define MAX_PATH 512
73 #endif
74
75 #define FILECONF_TRACE_MASK _T("fileconf")
76
77 // ----------------------------------------------------------------------------
78 // global functions declarations
79 // ----------------------------------------------------------------------------
80
81 // compare functions for sorting the arrays
82 static int LINKAGEMODE CompareEntries(wxFileConfigEntry *p1, wxFileConfigEntry *p2);
83 static int LINKAGEMODE CompareGroups(wxFileConfigGroup *p1, wxFileConfigGroup *p2);
84
85 // filter strings
86 static wxString FilterInValue(const wxString& str);
87 static wxString FilterOutValue(const wxString& str);
88
89 static wxString FilterInEntryName(const wxString& str);
90 static wxString FilterOutEntryName(const wxString& str);
91
92 // get the name to use in wxFileConfig ctor
93 static wxString GetAppName(const wxString& appname);
94
95 // ============================================================================
96 // private classes
97 // ============================================================================
98
99 // ----------------------------------------------------------------------------
100 // "template" array types
101 // ----------------------------------------------------------------------------
102
103 #ifdef WXMAKINGDLL_BASE
104 WX_DEFINE_SORTED_USER_EXPORTED_ARRAY(wxFileConfigEntry *, ArrayEntries,
105 WXDLLIMPEXP_BASE);
106 WX_DEFINE_SORTED_USER_EXPORTED_ARRAY(wxFileConfigGroup *, ArrayGroups,
107 WXDLLIMPEXP_BASE);
108 #else
109 WX_DEFINE_SORTED_ARRAY(wxFileConfigEntry *, ArrayEntries);
110 WX_DEFINE_SORTED_ARRAY(wxFileConfigGroup *, ArrayGroups);
111 #endif
112
113 // ----------------------------------------------------------------------------
114 // wxFileConfigLineList
115 // ----------------------------------------------------------------------------
116
117 // we store all lines of the local config file as a linked list in memory
118 class wxFileConfigLineList
119 {
120 public:
121 void SetNext(wxFileConfigLineList *pNext) { m_pNext = pNext; }
122 void SetPrev(wxFileConfigLineList *pPrev) { m_pPrev = pPrev; }
123
124 // ctor
125 wxFileConfigLineList(const wxString& str,
126 wxFileConfigLineList *pNext = NULL) : m_strLine(str)
127 { SetNext(pNext); SetPrev(NULL); }
128
129 // next/prev nodes in the linked list
130 wxFileConfigLineList *Next() const { return m_pNext; }
131 wxFileConfigLineList *Prev() const { return m_pPrev; }
132
133 // get/change lines text
134 void SetText(const wxString& str) { m_strLine = str; }
135 const wxString& Text() const { return m_strLine; }
136
137 private:
138 wxString m_strLine; // line contents
139 wxFileConfigLineList *m_pNext, // next node
140 *m_pPrev; // previous one
141
142 DECLARE_NO_COPY_CLASS(wxFileConfigLineList)
143 };
144
145 // ----------------------------------------------------------------------------
146 // wxFileConfigEntry: a name/value pair
147 // ----------------------------------------------------------------------------
148
149 class wxFileConfigEntry
150 {
151 private:
152 wxFileConfigGroup *m_pParent; // group that contains us
153
154 wxString m_strName, // entry name
155 m_strValue; // value
156 bool m_bImmutable:1, // can be overriden locally?
157 m_bHasValue:1; // set after first call to SetValue()
158
159 int m_nLine; // used if m_pLine == NULL only
160
161 // pointer to our line in the linked list or NULL if it was found in global
162 // file (which we don't modify)
163 wxFileConfigLineList *m_pLine;
164
165 public:
166 wxFileConfigEntry(wxFileConfigGroup *pParent,
167 const wxString& strName, int nLine);
168
169 // simple accessors
170 const wxString& Name() const { return m_strName; }
171 const wxString& Value() const { return m_strValue; }
172 wxFileConfigGroup *Group() const { return m_pParent; }
173 bool IsImmutable() const { return m_bImmutable; }
174 bool IsLocal() const { return m_pLine != 0; }
175 int Line() const { return m_nLine; }
176 wxFileConfigLineList *
177 GetLine() const { return m_pLine; }
178
179 // modify entry attributes
180 void SetValue(const wxString& strValue, bool bUser = true);
181 void SetLine(wxFileConfigLineList *pLine);
182
183 DECLARE_NO_COPY_CLASS(wxFileConfigEntry)
184 };
185
186 // ----------------------------------------------------------------------------
187 // wxFileConfigGroup: container of entries and other groups
188 // ----------------------------------------------------------------------------
189
190 class wxFileConfigGroup
191 {
192 private:
193 wxFileConfig *m_pConfig; // config object we belong to
194 wxFileConfigGroup *m_pParent; // parent group (NULL for root group)
195 ArrayEntries m_aEntries; // entries in this group
196 ArrayGroups m_aSubgroups; // subgroups
197 wxString m_strName; // group's name
198 wxFileConfigLineList *m_pLine; // pointer to our line in the linked list
199 wxFileConfigEntry *m_pLastEntry; // last entry/subgroup of this group in the
200 wxFileConfigGroup *m_pLastGroup; // local file (we insert new ones after it)
201
202 // DeleteSubgroupByName helper
203 bool DeleteSubgroup(wxFileConfigGroup *pGroup);
204
205 // used by Rename()
206 void UpdateGroupAndSubgroupsLines();
207
208 public:
209 // ctor
210 wxFileConfigGroup(wxFileConfigGroup *pParent, const wxString& strName, wxFileConfig *);
211
212 // dtor deletes all entries and subgroups also
213 ~wxFileConfigGroup();
214
215 // simple accessors
216 const wxString& Name() const { return m_strName; }
217 wxFileConfigGroup *Parent() const { return m_pParent; }
218 wxFileConfig *Config() const { return m_pConfig; }
219
220 const ArrayEntries& Entries() const { return m_aEntries; }
221 const ArrayGroups& Groups() const { return m_aSubgroups; }
222 bool IsEmpty() const { return Entries().IsEmpty() && Groups().IsEmpty(); }
223
224 // find entry/subgroup (NULL if not found)
225 wxFileConfigGroup *FindSubgroup(const wxChar *szName) const;
226 wxFileConfigEntry *FindEntry (const wxChar *szName) const;
227
228 // delete entry/subgroup, return false if doesn't exist
229 bool DeleteSubgroupByName(const wxChar *szName);
230 bool DeleteEntry(const wxChar *szName);
231
232 // create new entry/subgroup returning pointer to newly created element
233 wxFileConfigGroup *AddSubgroup(const wxString& strName);
234 wxFileConfigEntry *AddEntry (const wxString& strName, int nLine = wxNOT_FOUND);
235
236 void SetLine(wxFileConfigLineList *pLine);
237
238 // rename: no checks are done to ensure that the name is unique!
239 void Rename(const wxString& newName);
240
241 //
242 wxString GetFullName() const;
243
244 // get the last line belonging to an entry/subgroup of this group
245 wxFileConfigLineList *GetGroupLine(); // line which contains [group]
246 wxFileConfigLineList *GetLastEntryLine(); // after which our subgroups start
247 wxFileConfigLineList *GetLastGroupLine(); // after which the next group starts
248
249 // called by entries/subgroups when they're created/deleted
250 void SetLastEntry(wxFileConfigEntry *pEntry);
251 void SetLastGroup(wxFileConfigGroup *pGroup)
252 { m_pLastGroup = pGroup; }
253
254 DECLARE_NO_COPY_CLASS(wxFileConfigGroup)
255 };
256
257 // ============================================================================
258 // implementation
259 // ============================================================================
260
261 // ----------------------------------------------------------------------------
262 // static functions
263 // ----------------------------------------------------------------------------
264 wxString wxFileConfig::GetGlobalDir()
265 {
266 wxString strDir;
267
268 #ifdef __VMS__ // Note if __VMS is defined __UNIX is also defined
269 strDir = wxT("sys$manager:");
270 #elif defined(__WXMAC__)
271 strDir = wxMacFindFolder( (short) kOnSystemDisk, kPreferencesFolderType, kDontCreateFolder ) ;
272 #elif defined( __UNIX__ )
273 strDir = wxT("/etc/");
274 #elif defined(__OS2__)
275 ULONG aulSysInfo[QSV_MAX] = {0};
276 UINT drive;
277 APIRET rc;
278
279 rc = DosQuerySysInfo( 1L, QSV_MAX, (PVOID)aulSysInfo, sizeof(ULONG)*QSV_MAX);
280 if (rc == 0)
281 {
282 drive = aulSysInfo[QSV_BOOT_DRIVE - 1];
283 strDir.Printf(wxT("%c:\\OS2\\"), 'A'+drive-1);
284 }
285 #elif defined(__WXSTUBS__)
286 wxASSERT_MSG( false, wxT("TODO") ) ;
287 #elif defined(__DOS__)
288 // There's no such thing as global cfg dir in MS-DOS, let's return
289 // current directory (FIXME_MGL?)
290 strDir = wxT(".\\");
291 #elif defined(__WXWINCE__)
292 strDir = wxT("\\Windows\\");
293 #else // Windows
294
295 wxChar szWinDir[MAX_PATH];
296 ::GetWindowsDirectory(szWinDir, MAX_PATH);
297
298 strDir = szWinDir;
299 strDir << wxT('\\');
300 #endif // Unix/Windows
301
302 return strDir;
303 }
304
305 wxString wxFileConfig::GetLocalDir()
306 {
307 wxString strDir;
308
309 #if defined(__WXMAC__) || defined(__DOS__)
310 // no local dir concept on Mac OS 9 or MS-DOS
311 strDir << GetGlobalDir() ;
312 #else
313 wxGetHomeDir(&strDir);
314
315 #ifdef __UNIX__
316 if (
317 (strDir.Last() != wxT('/'))
318 #ifdef __VMS
319 && (strDir.Last() != wxT(']'))
320 #endif
321 )
322 strDir << wxT('/');
323 #else
324 if (strDir.Last() != wxT('\\'))
325 strDir << wxT('\\');
326 #endif
327 #endif
328
329 return strDir;
330 }
331
332 wxString wxFileConfig::GetGlobalFileName(const wxChar *szFile)
333 {
334 wxString str = GetGlobalDir();
335 str << szFile;
336
337 if ( wxStrchr(szFile, wxT('.')) == NULL )
338 #if defined( __WXMAC__ )
339 str << wxT(" Preferences") ;
340 #elif defined( __UNIX__ )
341 str << wxT(".conf");
342 #else // Windows
343 str << wxT(".ini");
344 #endif // UNIX/Win
345
346 return str;
347 }
348
349 wxString wxFileConfig::GetLocalFileName(const wxChar *szFile)
350 {
351 #ifdef __VMS__
352 // On VMS I saw the problem that the home directory was appended
353 // twice for the configuration file. Does that also happen for
354 // other platforms?
355 wxString str = wxT( '.' );
356 #else
357 wxString str = GetLocalDir();
358 #endif
359
360 #if defined( __UNIX__ ) && !defined( __VMS ) && !defined( __WXMAC__ )
361 str << wxT('.');
362 #endif
363
364 str << szFile;
365
366 #if defined(__WINDOWS__) || defined(__DOS__)
367 if ( wxStrchr(szFile, wxT('.')) == NULL )
368 str << wxT(".ini");
369 #endif
370
371 #ifdef __WXMAC__
372 str << wxT(" Preferences") ;
373 #endif
374
375 return str;
376 }
377
378 // ----------------------------------------------------------------------------
379 // ctor
380 // ----------------------------------------------------------------------------
381
382 void wxFileConfig::Init()
383 {
384 m_pCurrentGroup =
385 m_pRootGroup = new wxFileConfigGroup(NULL, wxEmptyString, this);
386
387 m_linesHead =
388 m_linesTail = NULL;
389
390 // It's not an error if (one of the) file(s) doesn't exist.
391
392 // parse the global file
393 if ( !m_strGlobalFile.empty() && wxFile::Exists(m_strGlobalFile) )
394 {
395 wxTextFile fileGlobal(m_strGlobalFile);
396
397 if ( fileGlobal.Open(m_conv/*ignored in ANSI build*/) )
398 {
399 Parse(fileGlobal, false /* global */);
400 SetRootPath();
401 }
402 else
403 {
404 wxLogWarning(_("can't open global configuration file '%s'."), m_strGlobalFile.c_str());
405 }
406 }
407
408 // parse the local file
409 if ( !m_strLocalFile.empty() && wxFile::Exists(m_strLocalFile) )
410 {
411 wxTextFile fileLocal(m_strLocalFile);
412 if ( fileLocal.Open(m_conv/*ignored in ANSI build*/) )
413 {
414 Parse(fileLocal, true /* local */);
415 SetRootPath();
416 }
417 else
418 {
419 wxLogWarning(_("can't open user configuration file '%s'."), m_strLocalFile.c_str() );
420 }
421 }
422
423 m_isDirty = false;
424 }
425
426 // constructor supports creation of wxFileConfig objects of any type
427 wxFileConfig::wxFileConfig(const wxString& appName, const wxString& vendorName,
428 const wxString& strLocal, const wxString& strGlobal,
429 long style, wxMBConv& conv)
430 : wxConfigBase(::GetAppName(appName), vendorName,
431 strLocal, strGlobal,
432 style),
433 m_strLocalFile(strLocal), m_strGlobalFile(strGlobal),
434 m_conv(conv)
435 {
436 // Make up names for files if empty
437 if ( m_strLocalFile.empty() && (style & wxCONFIG_USE_LOCAL_FILE) )
438 m_strLocalFile = GetLocalFileName(GetAppName());
439
440 if ( m_strGlobalFile.empty() && (style & wxCONFIG_USE_GLOBAL_FILE) )
441 m_strGlobalFile = GetGlobalFileName(GetAppName());
442
443 // Check if styles are not supplied, but filenames are, in which case
444 // add the correct styles.
445 if ( !m_strLocalFile.empty() )
446 SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
447
448 if ( !m_strGlobalFile.empty() )
449 SetStyle(GetStyle() | wxCONFIG_USE_GLOBAL_FILE);
450
451 // if the path is not absolute, prepend the standard directory to it
452 // UNLESS wxCONFIG_USE_RELATIVE_PATH style is set
453 if ( !(style & wxCONFIG_USE_RELATIVE_PATH) )
454 {
455 if ( !m_strLocalFile.empty() && !wxIsAbsolutePath(m_strLocalFile) )
456 {
457 const wxString strLocalOrig = m_strLocalFile;
458 m_strLocalFile = GetLocalDir();
459 m_strLocalFile << strLocalOrig;
460 }
461
462 if ( !m_strGlobalFile.empty() && !wxIsAbsolutePath(m_strGlobalFile) )
463 {
464 const wxString strGlobalOrig = m_strGlobalFile;
465 m_strGlobalFile = GetGlobalDir();
466 m_strGlobalFile << strGlobalOrig;
467 }
468 }
469
470 SetUmask(-1);
471
472 Init();
473 }
474
475 #if wxUSE_STREAMS
476
477 wxFileConfig::wxFileConfig(wxInputStream &inStream, wxMBConv& conv)
478 : m_conv(conv)
479 {
480 // always local_file when this constructor is called (?)
481 SetStyle(GetStyle() | wxCONFIG_USE_LOCAL_FILE);
482
483 m_pCurrentGroup =
484 m_pRootGroup = new wxFileConfigGroup(NULL, wxEmptyString, this);
485
486 m_linesHead =
487 m_linesTail = NULL;
488
489 // translate everything to the current (platform-dependent) line
490 // termination character
491 wxString strTrans;
492 {
493 wxString strTmp;
494
495 char buf[1024];
496 do
497 {
498 inStream.Read(buf, WXSIZEOF(buf)-1); // leave room for the NULL
499
500 const wxStreamError err = inStream.GetLastError();
501
502 if ( err != wxSTREAM_NO_ERROR && err != wxSTREAM_EOF )
503 {
504 wxLogError(_("Error reading config options."));
505 break;
506 }
507
508 // FIXME: this is broken because if we have part of multibyte
509 // character in the buffer (and another part hasn't been
510 // read yet) we're going to lose data because of conversion
511 // errors
512 buf[inStream.LastRead()] = '\0';
513 strTmp += conv.cMB2WX(buf);
514 }
515 while ( !inStream.Eof() );
516
517 strTrans = wxTextBuffer::Translate(strTmp);
518 }
519
520 wxMemoryText memText;
521
522 // Now we can add the text to the memory text. To do this we extract line
523 // by line from the translated string, until we've reached the end.
524 //
525 // VZ: all this is horribly inefficient, we should do the translation on
526 // the fly in one pass saving both memory and time (TODO)
527
528 const wxChar *pEOL = wxTextBuffer::GetEOL(wxTextBuffer::typeDefault);
529 const size_t EOLLen = wxStrlen(pEOL);
530
531 int posLineStart = strTrans.Find(pEOL);
532 while ( posLineStart != -1 )
533 {
534 wxString line(strTrans.Left(posLineStart));
535
536 memText.AddLine(line);
537
538 strTrans = strTrans.Mid(posLineStart + EOLLen);
539
540 posLineStart = strTrans.Find(pEOL);
541 }
542
543 // also add whatever we have left in the translated string.
544 if ( !strTrans.empty() )
545 memText.AddLine(strTrans);
546
547 // Finally we can parse it all.
548 Parse(memText, true /* local */);
549
550 SetRootPath();
551 ResetDirty();
552 }
553
554 #endif // wxUSE_STREAMS
555
556 void wxFileConfig::CleanUp()
557 {
558 delete m_pRootGroup;
559
560 wxFileConfigLineList *pCur = m_linesHead;
561 while ( pCur != NULL ) {
562 wxFileConfigLineList *pNext = pCur->Next();
563 delete pCur;
564 pCur = pNext;
565 }
566 }
567
568 wxFileConfig::~wxFileConfig()
569 {
570 Flush();
571
572 CleanUp();
573 }
574
575 // ----------------------------------------------------------------------------
576 // parse a config file
577 // ----------------------------------------------------------------------------
578
579 void wxFileConfig::Parse(const wxTextBuffer& buffer, bool bLocal)
580 {
581 const wxChar *pStart;
582 const wxChar *pEnd;
583 wxString strLine;
584
585 size_t nLineCount = buffer.GetLineCount();
586
587 for ( size_t n = 0; n < nLineCount; n++ )
588 {
589 strLine = buffer[n];
590
591 // add the line to linked list
592 if ( bLocal )
593 {
594 LineListAppend(strLine);
595
596 // let the root group have its start line as well
597 if ( !n )
598 {
599 m_pCurrentGroup->SetLine(m_linesTail);
600 }
601 }
602
603
604 // skip leading spaces
605 for ( pStart = strLine; wxIsspace(*pStart); pStart++ )
606 ;
607
608 // skip blank/comment lines
609 if ( *pStart == wxT('\0')|| *pStart == wxT(';') || *pStart == wxT('#') )
610 continue;
611
612 if ( *pStart == wxT('[') ) { // a new group
613 pEnd = pStart;
614
615 while ( *++pEnd != wxT(']') ) {
616 if ( *pEnd == wxT('\\') ) {
617 // the next char is escaped, so skip it even if it is ']'
618 pEnd++;
619 }
620
621 if ( *pEnd == wxT('\n') || *pEnd == wxT('\0') ) {
622 // we reached the end of line, break out of the loop
623 break;
624 }
625 }
626
627 if ( *pEnd != wxT(']') ) {
628 wxLogError(_("file '%s': unexpected character %c at line %d."),
629 buffer.GetName(), *pEnd, n + 1);
630 continue; // skip this line
631 }
632
633 // group name here is always considered as abs path
634 wxString strGroup;
635 pStart++;
636 strGroup << wxCONFIG_PATH_SEPARATOR
637 << FilterInEntryName(wxString(pStart, pEnd - pStart));
638
639 // will create it if doesn't yet exist
640 SetPath(strGroup);
641
642 if ( bLocal )
643 {
644 if ( m_pCurrentGroup->Parent() )
645 m_pCurrentGroup->Parent()->SetLastGroup(m_pCurrentGroup);
646 m_pCurrentGroup->SetLine(m_linesTail);
647 }
648
649 // check that there is nothing except comments left on this line
650 bool bCont = true;
651 while ( *++pEnd != wxT('\0') && bCont ) {
652 switch ( *pEnd ) {
653 case wxT('#'):
654 case wxT(';'):
655 bCont = false;
656 break;
657
658 case wxT(' '):
659 case wxT('\t'):
660 // ignore whitespace ('\n' impossible here)
661 break;
662
663 default:
664 wxLogWarning(_("file '%s', line %d: '%s' ignored after group header."),
665 buffer.GetName(), n + 1, pEnd);
666 bCont = false;
667 }
668 }
669 }
670 else { // a key
671 pEnd = pStart;
672 while ( *pEnd && *pEnd != wxT('=') /* && !wxIsspace(*pEnd)*/ ) {
673 if ( *pEnd == wxT('\\') ) {
674 // next character may be space or not - still take it because it's
675 // quoted (unless there is nothing)
676 pEnd++;
677 if ( !*pEnd ) {
678 // the error message will be given below anyhow
679 break;
680 }
681 }
682
683 pEnd++;
684 }
685
686 wxString strKey(FilterInEntryName(wxString(pStart, pEnd).Trim()));
687
688 // skip whitespace
689 while ( wxIsspace(*pEnd) )
690 pEnd++;
691
692 if ( *pEnd++ != wxT('=') ) {
693 wxLogError(_("file '%s', line %d: '=' expected."),
694 buffer.GetName(), n + 1);
695 }
696 else {
697 wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strKey);
698
699 if ( pEntry == NULL ) {
700 // new entry
701 pEntry = m_pCurrentGroup->AddEntry(strKey, n);
702 }
703 else {
704 if ( bLocal && pEntry->IsImmutable() ) {
705 // immutable keys can't be changed by user
706 wxLogWarning(_("file '%s', line %d: value for immutable key '%s' ignored."),
707 buffer.GetName(), n + 1, strKey.c_str());
708 continue;
709 }
710 // the condition below catches the cases (a) and (b) but not (c):
711 // (a) global key found second time in global file
712 // (b) key found second (or more) time in local file
713 // (c) key from global file now found in local one
714 // which is exactly what we want.
715 else if ( !bLocal || pEntry->IsLocal() ) {
716 wxLogWarning(_("file '%s', line %d: key '%s' was first found at line %d."),
717 buffer.GetName(), n + 1, strKey.c_str(), pEntry->Line());
718
719 }
720 }
721
722 if ( bLocal )
723 pEntry->SetLine(m_linesTail);
724
725 // skip whitespace
726 while ( wxIsspace(*pEnd) )
727 pEnd++;
728
729 wxString value = pEnd;
730 if ( !(GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS) )
731 value = FilterInValue(value);
732
733 pEntry->SetValue(value, false);
734 }
735 }
736 }
737 }
738
739 // ----------------------------------------------------------------------------
740 // set/retrieve path
741 // ----------------------------------------------------------------------------
742
743 void wxFileConfig::SetRootPath()
744 {
745 m_strPath.Empty();
746 m_pCurrentGroup = m_pRootGroup;
747 }
748
749 bool
750 wxFileConfig::DoSetPath(const wxString& strPath, bool createMissingComponents)
751 {
752 wxArrayString aParts;
753
754 if ( strPath.empty() ) {
755 SetRootPath();
756 return true;
757 }
758
759 if ( strPath[0] == wxCONFIG_PATH_SEPARATOR ) {
760 // absolute path
761 wxSplitPath(aParts, strPath);
762 }
763 else {
764 // relative path, combine with current one
765 wxString strFullPath = m_strPath;
766 strFullPath << wxCONFIG_PATH_SEPARATOR << strPath;
767 wxSplitPath(aParts, strFullPath);
768 }
769
770 // change current group
771 size_t n;
772 m_pCurrentGroup = m_pRootGroup;
773 for ( n = 0; n < aParts.Count(); n++ ) {
774 wxFileConfigGroup *pNextGroup = m_pCurrentGroup->FindSubgroup(aParts[n]);
775 if ( pNextGroup == NULL )
776 {
777 if ( !createMissingComponents )
778 return false;
779
780 pNextGroup = m_pCurrentGroup->AddSubgroup(aParts[n]);
781 }
782
783 m_pCurrentGroup = pNextGroup;
784 }
785
786 // recombine path parts in one variable
787 m_strPath.Empty();
788 for ( n = 0; n < aParts.Count(); n++ ) {
789 m_strPath << wxCONFIG_PATH_SEPARATOR << aParts[n];
790 }
791
792 return true;
793 }
794
795 void wxFileConfig::SetPath(const wxString& strPath)
796 {
797 DoSetPath(strPath, true /* create missing path components */);
798 }
799
800 // ----------------------------------------------------------------------------
801 // enumeration
802 // ----------------------------------------------------------------------------
803
804 bool wxFileConfig::GetFirstGroup(wxString& str, long& lIndex) const
805 {
806 lIndex = 0;
807 return GetNextGroup(str, lIndex);
808 }
809
810 bool wxFileConfig::GetNextGroup (wxString& str, long& lIndex) const
811 {
812 if ( size_t(lIndex) < m_pCurrentGroup->Groups().Count() ) {
813 str = m_pCurrentGroup->Groups()[(size_t)lIndex++]->Name();
814 return true;
815 }
816 else
817 return false;
818 }
819
820 bool wxFileConfig::GetFirstEntry(wxString& str, long& lIndex) const
821 {
822 lIndex = 0;
823 return GetNextEntry(str, lIndex);
824 }
825
826 bool wxFileConfig::GetNextEntry (wxString& str, long& lIndex) const
827 {
828 if ( size_t(lIndex) < m_pCurrentGroup->Entries().Count() ) {
829 str = m_pCurrentGroup->Entries()[(size_t)lIndex++]->Name();
830 return true;
831 }
832 else
833 return false;
834 }
835
836 size_t wxFileConfig::GetNumberOfEntries(bool bRecursive) const
837 {
838 size_t n = m_pCurrentGroup->Entries().Count();
839 if ( bRecursive ) {
840 wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
841 size_t nSubgroups = m_pCurrentGroup->Groups().Count();
842 for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
843 CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
844 n += GetNumberOfEntries(true);
845 CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
846 }
847 }
848
849 return n;
850 }
851
852 size_t wxFileConfig::GetNumberOfGroups(bool bRecursive) const
853 {
854 size_t n = m_pCurrentGroup->Groups().Count();
855 if ( bRecursive ) {
856 wxFileConfigGroup *pOldCurrentGroup = m_pCurrentGroup;
857 size_t nSubgroups = m_pCurrentGroup->Groups().Count();
858 for ( size_t nGroup = 0; nGroup < nSubgroups; nGroup++ ) {
859 CONST_CAST m_pCurrentGroup = m_pCurrentGroup->Groups()[nGroup];
860 n += GetNumberOfGroups(true);
861 CONST_CAST m_pCurrentGroup = pOldCurrentGroup;
862 }
863 }
864
865 return n;
866 }
867
868 // ----------------------------------------------------------------------------
869 // tests for existence
870 // ----------------------------------------------------------------------------
871
872 bool wxFileConfig::HasGroup(const wxString& strName) const
873 {
874 // special case: DoSetPath("") does work as it's equivalent to DoSetPath("/")
875 // but there is no group with empty name so treat this separately
876 if ( strName.empty() )
877 return false;
878
879 const wxString pathOld = GetPath();
880
881 wxFileConfig *self = wx_const_cast(wxFileConfig *, this);
882 const bool
883 rc = self->DoSetPath(strName, false /* don't create missing components */);
884
885 self->SetPath(pathOld);
886
887 return rc;
888 }
889
890 bool wxFileConfig::HasEntry(const wxString& strName) const
891 {
892 wxConfigPathChanger path(this, strName);
893
894 wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
895 return pEntry != NULL;
896 }
897
898 // ----------------------------------------------------------------------------
899 // read/write values
900 // ----------------------------------------------------------------------------
901
902 bool wxFileConfig::DoReadString(const wxString& key, wxString* pStr) const
903 {
904 wxConfigPathChanger path(this, key);
905
906 wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(path.Name());
907 if (pEntry == NULL) {
908 return false;
909 }
910
911 *pStr = pEntry->Value();
912
913 return true;
914 }
915
916 bool wxFileConfig::DoReadLong(const wxString& key, long *pl) const
917 {
918 wxString str;
919 if ( !Read(key, &str) )
920 return false;
921
922 // extra spaces shouldn't prevent us from reading numeric values
923 str.Trim();
924
925 return str.ToLong(pl);
926 }
927
928 bool wxFileConfig::DoWriteString(const wxString& key, const wxString& szValue)
929 {
930 wxConfigPathChanger path(this, key);
931 wxString strName = path.Name();
932
933 wxLogTrace( FILECONF_TRACE_MASK,
934 _T(" Writing String '%s' = '%s' to Group '%s'"),
935 strName.c_str(),
936 szValue.c_str(),
937 GetPath().c_str() );
938
939 if ( strName.empty() )
940 {
941 // setting the value of a group is an error
942
943 wxASSERT_MSG( szValue.empty(), wxT("can't set value of a group!") );
944
945 // ... except if it's empty in which case it's a way to force it's creation
946
947 wxLogTrace( FILECONF_TRACE_MASK,
948 _T(" Creating group %s"),
949 m_pCurrentGroup->Name().c_str() );
950
951 SetDirty();
952
953 // this will add a line for this group if it didn't have it before
954
955 (void)m_pCurrentGroup->GetGroupLine();
956 }
957 else
958 {
959 // writing an entry check that the name is reasonable
960 if ( strName[0u] == wxCONFIG_IMMUTABLE_PREFIX )
961 {
962 wxLogError( _("Config entry name cannot start with '%c'."),
963 wxCONFIG_IMMUTABLE_PREFIX);
964 return false;
965 }
966
967 wxFileConfigEntry *pEntry = m_pCurrentGroup->FindEntry(strName);
968
969 if ( pEntry == 0 )
970 {
971 wxLogTrace( FILECONF_TRACE_MASK,
972 _T(" Adding Entry %s"),
973 strName.c_str() );
974 pEntry = m_pCurrentGroup->AddEntry(strName);
975 }
976
977 wxLogTrace( FILECONF_TRACE_MASK,
978 _T(" Setting value %s"),
979 szValue.c_str() );
980 pEntry->SetValue(szValue);
981
982 SetDirty();
983 }
984
985 return true;
986 }
987
988 bool wxFileConfig::DoWriteLong(const wxString& key, long lValue)
989 {
990 return Write(key, wxString::Format(_T("%ld"), lValue));
991 }
992
993 bool wxFileConfig::Flush(bool /* bCurrentOnly */)
994 {
995 if ( !IsDirty() || !m_strLocalFile )
996 return true;
997
998 // set the umask if needed
999 wxCHANGE_UMASK(m_umask);
1000
1001 wxTempFile file(m_strLocalFile);
1002
1003 if ( !file.IsOpened() )
1004 {
1005 wxLogError(_("can't open user configuration file."));
1006 return false;
1007 }
1008
1009 // write all strings to file
1010 for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() )
1011 {
1012 wxString line = p->Text();
1013 line += wxTextFile::GetEOL();
1014 if ( !file.Write(line, m_conv) )
1015 {
1016 wxLogError(_("can't write user configuration file."));
1017 return false;
1018 }
1019 }
1020
1021 if ( !file.Commit() )
1022 {
1023 wxLogError(_("Failed to update user configuration file."));
1024
1025 return false;
1026 }
1027
1028 ResetDirty();
1029
1030 #if defined(__WXMAC__)
1031 wxFileName(m_strLocalFile).MacSetTypeAndCreator('TEXT', 'ttxt');
1032 #endif // __WXMAC__
1033
1034 return true;
1035 }
1036
1037 #if wxUSE_STREAMS
1038
1039 bool wxFileConfig::Save(wxOutputStream& os, wxMBConv& conv)
1040 {
1041 // save unconditionally, even if not dirty
1042 for ( wxFileConfigLineList *p = m_linesHead; p != NULL; p = p->Next() )
1043 {
1044 wxString line = p->Text();
1045 line += wxTextFile::GetEOL();
1046
1047 wxCharBuffer buf(line.mb_str(conv));
1048 if ( !os.Write(buf, strlen(buf)) )
1049 {
1050 wxLogError(_("Error saving user configuration data."));
1051
1052 return false;
1053 }
1054 }
1055
1056 ResetDirty();
1057
1058 return true;
1059 }
1060
1061 #endif // wxUSE_STREAMS
1062
1063 // ----------------------------------------------------------------------------
1064 // renaming groups/entries
1065 // ----------------------------------------------------------------------------
1066
1067 bool wxFileConfig::RenameEntry(const wxString& oldName,
1068 const wxString& newName)
1069 {
1070 wxASSERT_MSG( !wxStrchr(oldName, wxCONFIG_PATH_SEPARATOR),
1071 _T("RenameEntry(): paths are not supported") );
1072
1073 // check that the entry exists
1074 wxFileConfigEntry *oldEntry = m_pCurrentGroup->FindEntry(oldName);
1075 if ( !oldEntry )
1076 return false;
1077
1078 // check that the new entry doesn't already exist
1079 if ( m_pCurrentGroup->FindEntry(newName) )
1080 return false;
1081
1082 // delete the old entry, create the new one
1083 wxString value = oldEntry->Value();
1084 if ( !m_pCurrentGroup->DeleteEntry(oldName) )
1085 return false;
1086
1087 SetDirty();
1088
1089 wxFileConfigEntry *newEntry = m_pCurrentGroup->AddEntry(newName);
1090 newEntry->SetValue(value);
1091
1092 return true;
1093 }
1094
1095 bool wxFileConfig::RenameGroup(const wxString& oldName,
1096 const wxString& newName)
1097 {
1098 // check that the group exists
1099 wxFileConfigGroup *group = m_pCurrentGroup->FindSubgroup(oldName);
1100 if ( !group )
1101 return false;
1102
1103 // check that the new group doesn't already exist
1104 if ( m_pCurrentGroup->FindSubgroup(newName) )
1105 return false;
1106
1107 group->Rename(newName);
1108
1109 SetDirty();
1110
1111 return true;
1112 }
1113
1114 // ----------------------------------------------------------------------------
1115 // delete groups/entries
1116 // ----------------------------------------------------------------------------
1117
1118 bool wxFileConfig::DeleteEntry(const wxString& key, bool bGroupIfEmptyAlso)
1119 {
1120 wxConfigPathChanger path(this, key);
1121
1122 if ( !m_pCurrentGroup->DeleteEntry(path.Name()) )
1123 return false;
1124
1125 SetDirty();
1126
1127 if ( bGroupIfEmptyAlso && m_pCurrentGroup->IsEmpty() ) {
1128 if ( m_pCurrentGroup != m_pRootGroup ) {
1129 wxFileConfigGroup *pGroup = m_pCurrentGroup;
1130 SetPath(wxT("..")); // changes m_pCurrentGroup!
1131 m_pCurrentGroup->DeleteSubgroupByName(pGroup->Name());
1132 }
1133 //else: never delete the root group
1134 }
1135
1136 return true;
1137 }
1138
1139 bool wxFileConfig::DeleteGroup(const wxString& key)
1140 {
1141 wxConfigPathChanger path(this, key);
1142
1143 if ( !m_pCurrentGroup->DeleteSubgroupByName(path.Name()) )
1144 return false;
1145
1146 SetDirty();
1147
1148 return true;
1149 }
1150
1151 bool wxFileConfig::DeleteAll()
1152 {
1153 CleanUp();
1154
1155 if ( !m_strLocalFile.empty() )
1156 {
1157 if ( wxFile::Exists(m_strLocalFile) && wxRemove(m_strLocalFile) == -1 )
1158 {
1159 wxLogSysError(_("can't delete user configuration file '%s'"),
1160 m_strLocalFile.c_str());
1161 return false;
1162 }
1163
1164 m_strLocalFile =
1165 m_strGlobalFile = wxEmptyString;
1166 }
1167
1168 Init();
1169
1170 return true;
1171 }
1172
1173 // ----------------------------------------------------------------------------
1174 // linked list functions
1175 // ----------------------------------------------------------------------------
1176
1177 // append a new line to the end of the list
1178
1179 wxFileConfigLineList *wxFileConfig::LineListAppend(const wxString& str)
1180 {
1181 wxLogTrace( FILECONF_TRACE_MASK,
1182 _T(" ** Adding Line '%s'"),
1183 str.c_str() );
1184 wxLogTrace( FILECONF_TRACE_MASK,
1185 _T(" head: %s"),
1186 ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
1187 wxLogTrace( FILECONF_TRACE_MASK,
1188 _T(" tail: %s"),
1189 ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
1190
1191 wxFileConfigLineList *pLine = new wxFileConfigLineList(str);
1192
1193 if ( m_linesTail == NULL )
1194 {
1195 // list is empty
1196 m_linesHead = pLine;
1197 }
1198 else
1199 {
1200 // adjust pointers
1201 m_linesTail->SetNext(pLine);
1202 pLine->SetPrev(m_linesTail);
1203 }
1204
1205 m_linesTail = pLine;
1206
1207 wxLogTrace( FILECONF_TRACE_MASK,
1208 _T(" head: %s"),
1209 ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
1210 wxLogTrace( FILECONF_TRACE_MASK,
1211 _T(" tail: %s"),
1212 ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
1213
1214 return m_linesTail;
1215 }
1216
1217 // insert a new line after the given one or in the very beginning if !pLine
1218 wxFileConfigLineList *wxFileConfig::LineListInsert(const wxString& str,
1219 wxFileConfigLineList *pLine)
1220 {
1221 wxLogTrace( FILECONF_TRACE_MASK,
1222 _T(" ** Inserting Line '%s' after '%s'"),
1223 str.c_str(),
1224 ((pLine) ? pLine->Text().c_str() : wxEmptyString) );
1225 wxLogTrace( FILECONF_TRACE_MASK,
1226 _T(" head: %s"),
1227 ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
1228 wxLogTrace( FILECONF_TRACE_MASK,
1229 _T(" tail: %s"),
1230 ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
1231
1232 if ( pLine == m_linesTail )
1233 return LineListAppend(str);
1234
1235 wxFileConfigLineList *pNewLine = new wxFileConfigLineList(str);
1236 if ( pLine == NULL )
1237 {
1238 // prepend to the list
1239 pNewLine->SetNext(m_linesHead);
1240 m_linesHead->SetPrev(pNewLine);
1241 m_linesHead = pNewLine;
1242 }
1243 else
1244 {
1245 // insert before pLine
1246 wxFileConfigLineList *pNext = pLine->Next();
1247 pNewLine->SetNext(pNext);
1248 pNewLine->SetPrev(pLine);
1249 pNext->SetPrev(pNewLine);
1250 pLine->SetNext(pNewLine);
1251 }
1252
1253 wxLogTrace( FILECONF_TRACE_MASK,
1254 _T(" head: %s"),
1255 ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
1256 wxLogTrace( FILECONF_TRACE_MASK,
1257 _T(" tail: %s"),
1258 ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
1259
1260 return pNewLine;
1261 }
1262
1263 void wxFileConfig::LineListRemove(wxFileConfigLineList *pLine)
1264 {
1265 wxLogTrace( FILECONF_TRACE_MASK,
1266 _T(" ** Removing Line '%s'"),
1267 pLine->Text().c_str() );
1268 wxLogTrace( FILECONF_TRACE_MASK,
1269 _T(" head: %s"),
1270 ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
1271 wxLogTrace( FILECONF_TRACE_MASK,
1272 _T(" tail: %s"),
1273 ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
1274
1275 wxFileConfigLineList *pPrev = pLine->Prev(),
1276 *pNext = pLine->Next();
1277
1278 // first entry?
1279
1280 if ( pPrev == NULL )
1281 m_linesHead = pNext;
1282 else
1283 pPrev->SetNext(pNext);
1284
1285 // last entry?
1286
1287 if ( pNext == NULL )
1288 m_linesTail = pPrev;
1289 else
1290 pNext->SetPrev(pPrev);
1291
1292 if ( m_pRootGroup->GetGroupLine() == pLine )
1293 m_pRootGroup->SetLine(m_linesHead);
1294
1295 wxLogTrace( FILECONF_TRACE_MASK,
1296 _T(" head: %s"),
1297 ((m_linesHead) ? m_linesHead->Text().c_str() : wxEmptyString) );
1298 wxLogTrace( FILECONF_TRACE_MASK,
1299 _T(" tail: %s"),
1300 ((m_linesTail) ? m_linesTail->Text().c_str() : wxEmptyString) );
1301
1302 delete pLine;
1303 }
1304
1305 bool wxFileConfig::LineListIsEmpty()
1306 {
1307 return m_linesHead == NULL;
1308 }
1309
1310 // ============================================================================
1311 // wxFileConfig::wxFileConfigGroup
1312 // ============================================================================
1313
1314 // ----------------------------------------------------------------------------
1315 // ctor/dtor
1316 // ----------------------------------------------------------------------------
1317
1318 // ctor
1319 wxFileConfigGroup::wxFileConfigGroup(wxFileConfigGroup *pParent,
1320 const wxString& strName,
1321 wxFileConfig *pConfig)
1322 : m_aEntries(CompareEntries),
1323 m_aSubgroups(CompareGroups),
1324 m_strName(strName)
1325 {
1326 m_pConfig = pConfig;
1327 m_pParent = pParent;
1328 m_pLine = NULL;
1329
1330 m_pLastEntry = NULL;
1331 m_pLastGroup = NULL;
1332 }
1333
1334 // dtor deletes all children
1335 wxFileConfigGroup::~wxFileConfigGroup()
1336 {
1337 // entries
1338 size_t n, nCount = m_aEntries.Count();
1339 for ( n = 0; n < nCount; n++ )
1340 delete m_aEntries[n];
1341
1342 // subgroups
1343 nCount = m_aSubgroups.Count();
1344 for ( n = 0; n < nCount; n++ )
1345 delete m_aSubgroups[n];
1346 }
1347
1348 // ----------------------------------------------------------------------------
1349 // line
1350 // ----------------------------------------------------------------------------
1351
1352 void wxFileConfigGroup::SetLine(wxFileConfigLineList *pLine)
1353 {
1354 // for a normal (i.e. not root) group this method shouldn't be called twice
1355 // unless we are resetting the line
1356 wxASSERT_MSG( !m_pParent || !m_pLine || !pLine,
1357 _T("changing line for a non-root group?") );
1358
1359 m_pLine = pLine;
1360 }
1361
1362 /*
1363 This is a bit complicated, so let me explain it in details. All lines that
1364 were read from the local file (the only one we will ever modify) are stored
1365 in a (doubly) linked list. Our problem is to know at which position in this
1366 list should we insert the new entries/subgroups. To solve it we keep three
1367 variables for each group: m_pLine, m_pLastEntry and m_pLastGroup.
1368
1369 m_pLine points to the line containing "[group_name]"
1370 m_pLastEntry points to the last entry of this group in the local file.
1371 m_pLastGroup subgroup
1372
1373 Initially, they're NULL all three. When the group (an entry/subgroup) is read
1374 from the local file, the corresponding variable is set. However, if the group
1375 was read from the global file and then modified or created by the application
1376 these variables are still NULL and we need to create the corresponding lines.
1377 See the following functions (and comments preceding them) for the details of
1378 how we do it.
1379
1380 Also, when our last entry/group are deleted we need to find the new last
1381 element - the code in DeleteEntry/Subgroup does this by backtracking the list
1382 of lines until it either founds an entry/subgroup (and this is the new last
1383 element) or the m_pLine of the group, in which case there are no more entries
1384 (or subgroups) left and m_pLast<element> becomes NULL.
1385
1386 NB: This last problem could be avoided for entries if we added new entries
1387 immediately after m_pLine, but in this case the entries would appear
1388 backwards in the config file (OTOH, it's not that important) and as we
1389 would still need to do it for the subgroups the code wouldn't have been
1390 significantly less complicated.
1391 */
1392
1393 // Return the line which contains "[our name]". If we're still not in the list,
1394 // add our line to it immediately after the last line of our parent group if we
1395 // have it or in the very beginning if we're the root group.
1396 wxFileConfigLineList *wxFileConfigGroup::GetGroupLine()
1397 {
1398 wxLogTrace( FILECONF_TRACE_MASK,
1399 _T(" GetGroupLine() for Group '%s'"),
1400 Name().c_str() );
1401
1402 if ( !m_pLine )
1403 {
1404 wxLogTrace( FILECONF_TRACE_MASK,
1405 _T(" Getting Line item pointer") );
1406
1407 wxFileConfigGroup *pParent = Parent();
1408
1409 // this group wasn't present in local config file, add it now
1410 if ( pParent )
1411 {
1412 wxLogTrace( FILECONF_TRACE_MASK,
1413 _T(" checking parent '%s'"),
1414 pParent->Name().c_str() );
1415
1416 wxString strFullName;
1417
1418 // add 1 to the name because we don't want to start with '/'
1419 strFullName << wxT("[")
1420 << FilterOutEntryName(GetFullName().c_str() + 1)
1421 << wxT("]");
1422 m_pLine = m_pConfig->LineListInsert(strFullName,
1423 pParent->GetLastGroupLine());
1424 pParent->SetLastGroup(this); // we're surely after all the others
1425 }
1426 //else: this is the root group and so we return NULL because we don't
1427 // have any group line
1428 }
1429
1430 return m_pLine;
1431 }
1432
1433 // Return the last line belonging to the subgroups of this group (after which
1434 // we can add a new subgroup), if we don't have any subgroups or entries our
1435 // last line is the group line (m_pLine) itself.
1436 wxFileConfigLineList *wxFileConfigGroup::GetLastGroupLine()
1437 {
1438 // if we have any subgroups, our last line is the last line of the last
1439 // subgroup
1440 if ( m_pLastGroup )
1441 {
1442 wxFileConfigLineList *pLine = m_pLastGroup->GetLastGroupLine();
1443
1444 wxASSERT_MSG( pLine, _T("last group must have !NULL associated line") );
1445
1446 return pLine;
1447 }
1448
1449 // no subgroups, so the last line is the line of thelast entry (if any)
1450 return GetLastEntryLine();
1451 }
1452
1453 // return the last line belonging to the entries of this group (after which
1454 // we can add a new entry), if we don't have any entries we will add the new
1455 // one immediately after the group line itself.
1456 wxFileConfigLineList *wxFileConfigGroup::GetLastEntryLine()
1457 {
1458 wxLogTrace( FILECONF_TRACE_MASK,
1459 _T(" GetLastEntryLine() for Group '%s'"),
1460 Name().c_str() );
1461
1462 if ( m_pLastEntry )
1463 {
1464 wxFileConfigLineList *pLine = m_pLastEntry->GetLine();
1465
1466 wxASSERT_MSG( pLine, _T("last entry must have !NULL associated line") );
1467
1468 return pLine;
1469 }
1470
1471 // no entries: insert after the group header, if any
1472 return GetGroupLine();
1473 }
1474
1475 void wxFileConfigGroup::SetLastEntry(wxFileConfigEntry *pEntry)
1476 {
1477 m_pLastEntry = pEntry;
1478
1479 if ( !m_pLine )
1480 {
1481 // the only situation in which a group without its own line can have
1482 // an entry is when the first entry is added to the initially empty
1483 // root pseudo-group
1484 wxASSERT_MSG( !m_pParent, _T("unexpected for non root group") );
1485
1486 // let the group know that it does have a line in the file now
1487 m_pLine = pEntry->GetLine();
1488 }
1489 }
1490
1491 // ----------------------------------------------------------------------------
1492 // group name
1493 // ----------------------------------------------------------------------------
1494
1495 void wxFileConfigGroup::UpdateGroupAndSubgroupsLines()
1496 {
1497 // update the line of this group
1498 wxFileConfigLineList *line = GetGroupLine();
1499 wxCHECK_RET( line, _T("a non root group must have a corresponding line!") );
1500
1501 // +1: skip the leading '/'
1502 line->SetText(wxString::Format(_T("[%s]"), GetFullName().c_str() + 1));
1503
1504
1505 // also update all subgroups as they have this groups name in their lines
1506 const size_t nCount = m_aSubgroups.Count();
1507 for ( size_t n = 0; n < nCount; n++ )
1508 {
1509 m_aSubgroups[n]->UpdateGroupAndSubgroupsLines();
1510 }
1511 }
1512
1513 void wxFileConfigGroup::Rename(const wxString& newName)
1514 {
1515 wxCHECK_RET( m_pParent, _T("the root group can't be renamed") );
1516
1517 m_strName = newName;
1518
1519 // update the group lines recursively
1520 UpdateGroupAndSubgroupsLines();
1521 }
1522
1523 wxString wxFileConfigGroup::GetFullName() const
1524 {
1525 wxString fullname;
1526 if ( Parent() )
1527 fullname = Parent()->GetFullName() + wxCONFIG_PATH_SEPARATOR + Name();
1528
1529 return fullname;
1530 }
1531
1532 // ----------------------------------------------------------------------------
1533 // find an item
1534 // ----------------------------------------------------------------------------
1535
1536 // use binary search because the array is sorted
1537 wxFileConfigEntry *
1538 wxFileConfigGroup::FindEntry(const wxChar *szName) const
1539 {
1540 size_t i,
1541 lo = 0,
1542 hi = m_aEntries.Count();
1543 int res;
1544 wxFileConfigEntry *pEntry;
1545
1546 while ( lo < hi ) {
1547 i = (lo + hi)/2;
1548 pEntry = m_aEntries[i];
1549
1550 #if wxCONFIG_CASE_SENSITIVE
1551 res = wxStrcmp(pEntry->Name(), szName);
1552 #else
1553 res = wxStricmp(pEntry->Name(), szName);
1554 #endif
1555
1556 if ( res > 0 )
1557 hi = i;
1558 else if ( res < 0 )
1559 lo = i + 1;
1560 else
1561 return pEntry;
1562 }
1563
1564 return NULL;
1565 }
1566
1567 wxFileConfigGroup *
1568 wxFileConfigGroup::FindSubgroup(const wxChar *szName) const
1569 {
1570 size_t i,
1571 lo = 0,
1572 hi = m_aSubgroups.Count();
1573 int res;
1574 wxFileConfigGroup *pGroup;
1575
1576 while ( lo < hi ) {
1577 i = (lo + hi)/2;
1578 pGroup = m_aSubgroups[i];
1579
1580 #if wxCONFIG_CASE_SENSITIVE
1581 res = wxStrcmp(pGroup->Name(), szName);
1582 #else
1583 res = wxStricmp(pGroup->Name(), szName);
1584 #endif
1585
1586 if ( res > 0 )
1587 hi = i;
1588 else if ( res < 0 )
1589 lo = i + 1;
1590 else
1591 return pGroup;
1592 }
1593
1594 return NULL;
1595 }
1596
1597 // ----------------------------------------------------------------------------
1598 // create a new item
1599 // ----------------------------------------------------------------------------
1600
1601 // create a new entry and add it to the current group
1602 wxFileConfigEntry *wxFileConfigGroup::AddEntry(const wxString& strName, int nLine)
1603 {
1604 wxASSERT( FindEntry(strName) == 0 );
1605
1606 wxFileConfigEntry *pEntry = new wxFileConfigEntry(this, strName, nLine);
1607
1608 m_aEntries.Add(pEntry);
1609 return pEntry;
1610 }
1611
1612 // create a new group and add it to the current group
1613 wxFileConfigGroup *wxFileConfigGroup::AddSubgroup(const wxString& strName)
1614 {
1615 wxASSERT( FindSubgroup(strName) == 0 );
1616
1617 wxFileConfigGroup *pGroup = new wxFileConfigGroup(this, strName, m_pConfig);
1618
1619 m_aSubgroups.Add(pGroup);
1620 return pGroup;
1621 }
1622
1623 // ----------------------------------------------------------------------------
1624 // delete an item
1625 // ----------------------------------------------------------------------------
1626
1627 /*
1628 The delete operations are _very_ slow if we delete the last item of this
1629 group (see comments before GetXXXLineXXX functions for more details),
1630 so it's much better to start with the first entry/group if we want to
1631 delete several of them.
1632 */
1633
1634 bool wxFileConfigGroup::DeleteSubgroupByName(const wxChar *szName)
1635 {
1636 wxFileConfigGroup * const pGroup = FindSubgroup(szName);
1637
1638 return pGroup ? DeleteSubgroup(pGroup) : false;
1639 }
1640
1641 // Delete the subgroup and remove all references to it from
1642 // other data structures.
1643 bool wxFileConfigGroup::DeleteSubgroup(wxFileConfigGroup *pGroup)
1644 {
1645 wxCHECK_MSG( pGroup, false, _T("deleting non existing group?") );
1646
1647 wxLogTrace( FILECONF_TRACE_MASK,
1648 _T("Deleting group '%s' from '%s'"),
1649 pGroup->Name().c_str(),
1650 Name().c_str() );
1651
1652 wxLogTrace( FILECONF_TRACE_MASK,
1653 _T(" (m_pLine) = prev: %p, this %p, next %p"),
1654 ((m_pLine) ? m_pLine->Prev() : 0),
1655 m_pLine,
1656 ((m_pLine) ? m_pLine->Next() : 0) );
1657 wxLogTrace( FILECONF_TRACE_MASK,
1658 _T(" text: '%s'"),
1659 ((m_pLine) ? m_pLine->Text().c_str() : wxEmptyString) );
1660
1661 // delete all entries...
1662 size_t nCount = pGroup->m_aEntries.Count();
1663
1664 wxLogTrace(FILECONF_TRACE_MASK,
1665 _T("Removing %lu entries"), (unsigned long)nCount );
1666
1667 for ( size_t nEntry = 0; nEntry < nCount; nEntry++ )
1668 {
1669 wxFileConfigLineList *pLine = pGroup->m_aEntries[nEntry]->GetLine();
1670
1671 if ( pLine )
1672 {
1673 wxLogTrace( FILECONF_TRACE_MASK,
1674 _T(" '%s'"),
1675 pLine->Text().c_str() );
1676 m_pConfig->LineListRemove(pLine);
1677 }
1678 }
1679
1680 // ...and subgroups of this subgroup
1681 nCount = pGroup->m_aSubgroups.Count();
1682
1683 wxLogTrace( FILECONF_TRACE_MASK,
1684 _T("Removing %lu subgroups"), (unsigned long)nCount );
1685
1686 for ( size_t nGroup = 0; nGroup < nCount; nGroup++ )
1687 {
1688 pGroup->DeleteSubgroup(pGroup->m_aSubgroups[0]);
1689 }
1690
1691 // and then finally the group itself
1692 wxFileConfigLineList *pLine = pGroup->m_pLine;
1693 if ( pLine )
1694 {
1695 wxLogTrace( FILECONF_TRACE_MASK,
1696 _T(" Removing line for group '%s' : '%s'"),
1697 pGroup->Name().c_str(),
1698 pLine->Text().c_str() );
1699 wxLogTrace( FILECONF_TRACE_MASK,
1700 _T(" Removing from group '%s' : '%s'"),
1701 Name().c_str(),
1702 ((m_pLine) ? m_pLine->Text().c_str() : wxEmptyString) );
1703
1704 // notice that we may do this test inside the previous "if"
1705 // because the last entry's line is surely !NULL
1706 if ( pGroup == m_pLastGroup )
1707 {
1708 wxLogTrace( FILECONF_TRACE_MASK,
1709 _T(" Removing last group") );
1710
1711 // our last entry is being deleted, so find the last one which
1712 // stays by going back until we find a subgroup or reach the
1713 // group line
1714 const size_t nSubgroups = m_aSubgroups.Count();
1715
1716 m_pLastGroup = NULL;
1717 for ( wxFileConfigLineList *pl = pLine->Prev();
1718 pl && pl != m_pLine && !m_pLastGroup;
1719 pl = pl->Prev() )
1720 {
1721 // does this line belong to our subgroup?
1722 for ( size_t n = 0; n < nSubgroups; n++ )
1723 {
1724 // do _not_ call GetGroupLine! we don't want to add it to
1725 // the local file if it's not already there
1726 if ( m_aSubgroups[n]->m_pLine == pl )
1727 {
1728 m_pLastGroup = m_aSubgroups[n];
1729 break;
1730 }
1731 }
1732 }
1733 }
1734
1735 m_pConfig->LineListRemove(pLine);
1736 }
1737 else
1738 {
1739 wxLogTrace( FILECONF_TRACE_MASK,
1740 _T(" No line entry for Group '%s'?"),
1741 pGroup->Name().c_str() );
1742 }
1743
1744 m_aSubgroups.Remove(pGroup);
1745 delete pGroup;
1746
1747 return true;
1748 }
1749
1750 bool wxFileConfigGroup::DeleteEntry(const wxChar *szName)
1751 {
1752 wxFileConfigEntry *pEntry = FindEntry(szName);
1753 if ( !pEntry )
1754 {
1755 // entry doesn't exist, nothing to do
1756 return false;
1757 }
1758
1759 wxFileConfigLineList *pLine = pEntry->GetLine();
1760 if ( pLine != NULL ) {
1761 // notice that we may do this test inside the previous "if" because the
1762 // last entry's line is surely !NULL
1763 if ( pEntry == m_pLastEntry ) {
1764 // our last entry is being deleted - find the last one which stays
1765 wxASSERT( m_pLine != NULL ); // if we have an entry with !NULL pLine...
1766
1767 // go back until we find another entry or reach the group's line
1768 wxFileConfigEntry *pNewLast = NULL;
1769 size_t n, nEntries = m_aEntries.Count();
1770 wxFileConfigLineList *pl;
1771 for ( pl = pLine->Prev(); pl != m_pLine; pl = pl->Prev() ) {
1772 // is it our subgroup?
1773 for ( n = 0; (pNewLast == NULL) && (n < nEntries); n++ ) {
1774 if ( m_aEntries[n]->GetLine() == m_pLine )
1775 pNewLast = m_aEntries[n];
1776 }
1777
1778 if ( pNewLast != NULL ) // found?
1779 break;
1780 }
1781
1782 if ( pl == m_pLine ) {
1783 wxASSERT( !pNewLast ); // how comes it has the same line as we?
1784
1785 // we've reached the group line without finding any subgroups
1786 m_pLastEntry = NULL;
1787 }
1788 else
1789 m_pLastEntry = pNewLast;
1790 }
1791
1792 m_pConfig->LineListRemove(pLine);
1793 }
1794
1795 m_aEntries.Remove(pEntry);
1796 delete pEntry;
1797
1798 return true;
1799 }
1800
1801 // ============================================================================
1802 // wxFileConfig::wxFileConfigEntry
1803 // ============================================================================
1804
1805 // ----------------------------------------------------------------------------
1806 // ctor
1807 // ----------------------------------------------------------------------------
1808 wxFileConfigEntry::wxFileConfigEntry(wxFileConfigGroup *pParent,
1809 const wxString& strName,
1810 int nLine)
1811 : m_strName(strName)
1812 {
1813 wxASSERT( !strName.empty() );
1814
1815 m_pParent = pParent;
1816 m_nLine = nLine;
1817 m_pLine = NULL;
1818
1819 m_bHasValue = false;
1820
1821 m_bImmutable = strName[0] == wxCONFIG_IMMUTABLE_PREFIX;
1822 if ( m_bImmutable )
1823 m_strName.erase(0, 1); // remove first character
1824 }
1825
1826 // ----------------------------------------------------------------------------
1827 // set value
1828 // ----------------------------------------------------------------------------
1829
1830 void wxFileConfigEntry::SetLine(wxFileConfigLineList *pLine)
1831 {
1832 if ( m_pLine != NULL ) {
1833 wxLogWarning(_("entry '%s' appears more than once in group '%s'"),
1834 Name().c_str(), m_pParent->GetFullName().c_str());
1835 }
1836
1837 m_pLine = pLine;
1838 Group()->SetLastEntry(this);
1839 }
1840
1841 // second parameter is false if we read the value from file and prevents the
1842 // entry from being marked as 'dirty'
1843 void wxFileConfigEntry::SetValue(const wxString& strValue, bool bUser)
1844 {
1845 if ( bUser && IsImmutable() )
1846 {
1847 wxLogWarning( _("attempt to change immutable key '%s' ignored."),
1848 Name().c_str());
1849 return;
1850 }
1851
1852 // do nothing if it's the same value: but don't test for it if m_bHasValue
1853 // hadn't been set yet or we'd never write empty values to the file
1854 if ( m_bHasValue && strValue == m_strValue )
1855 return;
1856
1857 m_bHasValue = true;
1858 m_strValue = strValue;
1859
1860 if ( bUser )
1861 {
1862 wxString strValFiltered;
1863
1864 if ( Group()->Config()->GetStyle() & wxCONFIG_USE_NO_ESCAPE_CHARACTERS )
1865 {
1866 strValFiltered = strValue;
1867 }
1868 else {
1869 strValFiltered = FilterOutValue(strValue);
1870 }
1871
1872 wxString strLine;
1873 strLine << FilterOutEntryName(m_strName) << wxT('=') << strValFiltered;
1874
1875 if ( m_pLine )
1876 {
1877 // entry was read from the local config file, just modify the line
1878 m_pLine->SetText(strLine);
1879 }
1880 else // this entry didn't exist in the local file
1881 {
1882 // add a new line to the file: note that line returned by
1883 // GetLastEntryLine() may be NULL if we're in the root group and it
1884 // doesn't have any entries yet, but this is ok as passing NULL
1885 // line to LineListInsert() means to prepend new line to the list
1886 wxFileConfigLineList *line = Group()->GetLastEntryLine();
1887 m_pLine = Group()->Config()->LineListInsert(strLine, line);
1888
1889 Group()->SetLastEntry(this);
1890 }
1891 }
1892 }
1893
1894 // ============================================================================
1895 // global functions
1896 // ============================================================================
1897
1898 // ----------------------------------------------------------------------------
1899 // compare functions for array sorting
1900 // ----------------------------------------------------------------------------
1901
1902 int CompareEntries(wxFileConfigEntry *p1, wxFileConfigEntry *p2)
1903 {
1904 #if wxCONFIG_CASE_SENSITIVE
1905 return wxStrcmp(p1->Name(), p2->Name());
1906 #else
1907 return wxStricmp(p1->Name(), p2->Name());
1908 #endif
1909 }
1910
1911 int CompareGroups(wxFileConfigGroup *p1, wxFileConfigGroup *p2)
1912 {
1913 #if wxCONFIG_CASE_SENSITIVE
1914 return wxStrcmp(p1->Name(), p2->Name());
1915 #else
1916 return wxStricmp(p1->Name(), p2->Name());
1917 #endif
1918 }
1919
1920 // ----------------------------------------------------------------------------
1921 // filter functions
1922 // ----------------------------------------------------------------------------
1923
1924 // undo FilterOutValue
1925 static wxString FilterInValue(const wxString& str)
1926 {
1927 wxString strResult;
1928 strResult.Alloc(str.Len());
1929
1930 bool bQuoted = !str.empty() && str[0] == '"';
1931
1932 for ( size_t n = bQuoted ? 1 : 0; n < str.Len(); n++ ) {
1933 if ( str[n] == wxT('\\') ) {
1934 switch ( str[++n] ) {
1935 case wxT('n'):
1936 strResult += wxT('\n');
1937 break;
1938
1939 case wxT('r'):
1940 strResult += wxT('\r');
1941 break;
1942
1943 case wxT('t'):
1944 strResult += wxT('\t');
1945 break;
1946
1947 case wxT('\\'):
1948 strResult += wxT('\\');
1949 break;
1950
1951 case wxT('"'):
1952 strResult += wxT('"');
1953 break;
1954 }
1955 }
1956 else {
1957 if ( str[n] != wxT('"') || !bQuoted )
1958 strResult += str[n];
1959 else if ( n != str.Len() - 1 ) {
1960 wxLogWarning(_("unexpected \" at position %d in '%s'."),
1961 n, str.c_str());
1962 }
1963 //else: it's the last quote of a quoted string, ok
1964 }
1965 }
1966
1967 return strResult;
1968 }
1969
1970 // quote the string before writing it to file
1971 static wxString FilterOutValue(const wxString& str)
1972 {
1973 if ( !str )
1974 return str;
1975
1976 wxString strResult;
1977 strResult.Alloc(str.Len());
1978
1979 // quoting is necessary to preserve spaces in the beginning of the string
1980 bool bQuote = wxIsspace(str[0]) || str[0] == wxT('"');
1981
1982 if ( bQuote )
1983 strResult += wxT('"');
1984
1985 wxChar c;
1986 for ( size_t n = 0; n < str.Len(); n++ ) {
1987 switch ( str[n] ) {
1988 case wxT('\n'):
1989 c = wxT('n');
1990 break;
1991
1992 case wxT('\r'):
1993 c = wxT('r');
1994 break;
1995
1996 case wxT('\t'):
1997 c = wxT('t');
1998 break;
1999
2000 case wxT('\\'):
2001 c = wxT('\\');
2002 break;
2003
2004 case wxT('"'):
2005 if ( bQuote ) {
2006 c = wxT('"');
2007 break;
2008 }
2009 //else: fall through
2010
2011 default:
2012 strResult += str[n];
2013 continue; // nothing special to do
2014 }
2015
2016 // we get here only for special characters
2017 strResult << wxT('\\') << c;
2018 }
2019
2020 if ( bQuote )
2021 strResult += wxT('"');
2022
2023 return strResult;
2024 }
2025
2026 // undo FilterOutEntryName
2027 static wxString FilterInEntryName(const wxString& str)
2028 {
2029 wxString strResult;
2030 strResult.Alloc(str.Len());
2031
2032 for ( const wxChar *pc = str.c_str(); *pc != '\0'; pc++ ) {
2033 if ( *pc == wxT('\\') ) {
2034 // we need to test it here or we'd skip past the NUL in the loop line
2035 if ( *++pc == _T('\0') )
2036 break;
2037 }
2038
2039 strResult += *pc;
2040 }
2041
2042 return strResult;
2043 }
2044
2045 // sanitize entry or group name: insert '\\' before any special characters
2046 static wxString FilterOutEntryName(const wxString& str)
2047 {
2048 wxString strResult;
2049 strResult.Alloc(str.Len());
2050
2051 for ( const wxChar *pc = str.c_str(); *pc != wxT('\0'); pc++ ) {
2052 const wxChar c = *pc;
2053
2054 // we explicitly allow some of "safe" chars and 8bit ASCII characters
2055 // which will probably never have special meaning and with which we can't
2056 // use isalnum() anyhow (in ASCII built, in Unicode it's just fine)
2057 //
2058 // NB: note that wxCONFIG_IMMUTABLE_PREFIX and wxCONFIG_PATH_SEPARATOR
2059 // should *not* be quoted
2060 if (
2061 #if !wxUSE_UNICODE
2062 ((unsigned char)c < 127) &&
2063 #endif // ANSI
2064 !wxIsalnum(c) && !wxStrchr(wxT("@_/-!.*%"), c) )
2065 {
2066 strResult += wxT('\\');
2067 }
2068
2069 strResult += c;
2070 }
2071
2072 return strResult;
2073 }
2074
2075 // we can't put ?: in the ctor initializer list because it confuses some
2076 // broken compilers (Borland C++)
2077 static wxString GetAppName(const wxString& appName)
2078 {
2079 if ( !appName && wxTheApp )
2080 return wxTheApp->GetAppName();
2081 else
2082 return appName;
2083 }
2084
2085 #endif // wxUSE_CONFIG
wxWidgets (Impactor)