PreferenceSection Class Reference

Holds all the preferences for a particular section of the preference file. These preferences are stored in one or more instances of the PreferenceChunk class. These instances are linked together as a List by this class. More...

Inheritance diagram for PreferenceSection:

List of all members.

Public Member Functions
	PreferenceSection (LPTCHAR SectionName, UINT32 InitialSize)
	Checks to see if the given preference exists in this chunk. Only exists in DEBUG builds. Creates a new section object. A chunk of memory is allocated to hold the preferences for this object. If the memory is not available for this, then the 'Valid' data member contains the value 'FALSE'.
	~PreferenceSection ()
	Deletes all PreferenceChunk objects used by this section.
void	Write (OILPreferences *OILPrefs)
	Writes all the preferences in this section out to the preference file, using the OIL.
BOOL	AddPref (OILPreferences *OILPrefs, LPTCHAR Pref, PreferenceType Type, PrefData PrefVar)
	Adds a preference to this PreferenceSection object. If a new PreferenceChunk is needed to do this, it is allocated automatically, and added to this object's list of chunks.
BOOL	GetPrefValue (OILPreferences *OILPrefs, LPTCHAR Pref, PreferenceType Type, PrefData PrefVar)
	Reads a preference value from this PreferenceSection object by looking through all the chunks in this section for the named preference.
BOOL	SetPrefValue (OILPreferences *OILPrefs, LPTCHAR Pref, PreferenceType Type, PrefData PrefVar)
	Finds a preference value from this PreferenceSection object by looking through all the chunks in this section for the named preference and then sets the value to the specifed new value.
Public Attributes
LPTCHAR	Section
BOOL	Valid
List	ChunkList

---

Detailed Description

Holds all the preferences for a particular section of the preference file. These preferences are stored in one or more instances of the PreferenceChunk class. These instances are linked together as a List by this class.

Author:

Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>

Date:

17/8/93

See also:

-

Definition at line 215 of file prefs.cpp.

---

Constructor & Destructor Documentation

PreferenceSection::PreferenceSection (  LPTCHAR  SectionName, UINT32  InitialSize )

Checks to see if the given preference exists in this chunk. Only exists in DEBUG builds. Creates a new section object. A chunk of memory is allocated to hold the preferences for this object. If the memory is not available for this, then the 'Valid' data member contains the value 'FALSE'. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: SectionName  - The name to be associated with this section object. [INPUTS] InitialSize - The caller's estimate of how many preferences will typically be stored in this section. Used as a guideline for allocating memory. -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 596 of file prefs.cpp. { Valid = FALSE; // Remember the name of this section (note that it uses the original - it does not // take a copy). Section = SectionName; // Get a preference chunk for this section, using the size recommended // by the caller PreferenceChunk *pChunk = new PreferenceChunk(InitialSize); if ((pChunk == NULL) || (!pChunk->Valid)) { delete pChunk; return; // Section is invalid } // Got a chunk ok, so add it to the head of the (empty) list. ChunkList.AddHead(pChunk); // Success Valid = TRUE; }

PreferenceSection::~PreferenceSection (   )

Deletes all PreferenceChunk objects used by this section. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 636 of file prefs.cpp. { PreferenceChunk *pChunk; // Delete all the chunks for this section do { // Unlink the first item from the list pChunk = (PreferenceChunk *) ChunkList.RemoveHead(); // It doesn't matter if pChunk is NULL - delete handles it delete pChunk; } while (pChunk != NULL); }

---

Member Function Documentation

BOOL PreferenceSection::AddPref (  OILPreferences *  OILPrefs, LPTCHAR  Pref, PreferenceType  Type, PrefData  PrefVar )

Adds a preference to this PreferenceSection object. If a new PreferenceChunk is needed to do this, it is allocated automatically, and added to this object's list of chunks. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: Pref  - the name of the preference to add (e.g. "autosaveinterval") [INPUTS] Type - the type of data used for this preference. PrefVar - pointer to the memory that holds this preference's data. OILPrefs - the object to use to read the preference from the file. -  [OUTPUTS] Returns: TRUE if the preference was added to the preference system successfully, FALSE otherwise. Errors: - See also: - Definition at line 674 of file prefs.cpp. { #ifdef _DEBUG if ((camStrnicmp(Pref, _T("blobby"), 7) == 0) || (camStrnicmp(Pref, _T("wobjob"), 7) == 0)) { // Silly names not allowed ENSURE(FALSE, "Preference section has suffered a cliche overload"); abort(); } #endif // Used for scanning the chunk list PreferenceChunk *pChunk; // In debug builds, check that this preference has not already been declared. // This check ensures that two preferences with the same name are not used. #ifdef _DEBUG pChunk = (PreferenceChunk *) ChunkList.GetHead(); while (pChunk != NULL) { ERROR3IF_PF((pChunk->PrefExists(Pref) != FALSE), ( "Preference '%s' in section '%s' declared more than once", Pref, Section ) ); pChunk = (PreferenceChunk *) ChunkList.GetNext(pChunk); } #endif // New chunks are added to the head of the list, so the partially unused one // is always the first in the list. pChunk = (PreferenceChunk *) ChunkList.GetHead(); // Try to add the preference to this chunk. if (!pChunk->AddPref(Pref, PrefVar, Type)) { // No room left in this chunk - try to get another one and put it in that. // The extension chunk is big enough to hold another 10 preferences (this is pretty // arbitrary). pChunk = new PreferenceChunk(10); if ((pChunk == NULL) || (!pChunk->Valid)) { delete pChunk; return FALSE; // Failure - no memory left. } // Got a chunk ok, so add it to the head of the list. ChunkList.AddHead(pChunk); // Add the preference to it ('guaranteed' to work) pChunk->AddPref(Pref, PrefVar, Type); } // Try to read the preference if (OILPrefs != NULL) OILPrefs->Read(Section, Pref, Type, PrefVar); return TRUE; }

BOOL PreferenceSection::GetPrefValue (  OILPreferences *  OILPrefs, LPTCHAR  Pref, PreferenceType  Type, PrefData  PrefVar )

Reads a preference value from this PreferenceSection object by looking through all the chunks in this section for the named preference. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/10/94 Parameters: Pref  - the name of the preference to add (e.g. "autosaveinterval") [INPUTS] Type - the type of data used for this preference. PrefVar - pointer to the memory that holds this preference's data. OILPrefs - the object to use to read the preference from the file. -  [OUTPUTS] Returns: TRUE if the preference was read from the preference system successfully, FALSE otherwise. Errors: - See also: PreferenceSection::GetPrefValue Definition at line 758 of file prefs.cpp. { #if !defined(EXCLUDE_FROM_RALPH) // Used for scanning the chunk list PreferenceChunk *pChunk; // Check that this preference has not already been declared. // New chunks are added to the head of the list, so the partially unused one // is always the first in the list. pChunk = (PreferenceChunk *) ChunkList.GetHead(); while (pChunk != NULL ) { // Try to read the preference value from this chunk. if (pChunk->GetPrefValue(Pref, PrefVar, Type)) return TRUE; // The read went ok so return that value to the caller // Preference not in that chunk so move onto next chunk in list pChunk = (PreferenceChunk *) ChunkList.GetNext(pChunk); } #endif return FALSE; // Value was not read ok, not the correct type or not present }

BOOL PreferenceSection::SetPrefValue (  OILPreferences *  OILPrefs, LPTCHAR  Pref, PreferenceType  Type, PrefData  PrefVar )

Finds a preference value from this PreferenceSection object by looking through all the chunks in this section for the named preference and then sets the value to the specifed new value. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/10/94 Parameters: Pref  - the name of the preference to add (e.g. "autosaveinterval") [INPUTS] Type - the type of data used for this preference. PrefVar - pointer to the memory that holds the new preference's data value. OILPrefs - the object to use to read the preference from the file. -  [OUTPUTS] Returns: TRUE if the preference was found in the preference system successfully and the new value applied to it, FALSE otherwise. Errors: - See also: PreferenceSection::GetPrefValue Definition at line 806 of file prefs.cpp. { #if !defined(EXCLUDE_FROM_RALPH) // Used for scanning the chunk list PreferenceChunk *pChunk; // Check that this preference has not already been declared. // New chunks are added to the head of the list, so the partially unused one // is always the first in the list. pChunk = (PreferenceChunk *) ChunkList.GetHead(); while (pChunk != NULL ) { // Try to read the preference value from this chunk. if (pChunk->SetPrefValue(Pref, PrefVar, Type)) return TRUE; // The read went ok so return that value to the caller // Preference not in that chunk so move onto next chunk in list pChunk = (PreferenceChunk *) ChunkList.GetNext(pChunk); } #endif return FALSE; // Value was not set ok, not the correct type or not present }

void PreferenceSection::Write (  OILPreferences *  OILPrefs  )

Writes all the preferences in this section out to the preference file, using the OIL. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: OILPrefs  - the OIL object to use to write out the preferences with. [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 849 of file prefs.cpp. { // Write out each chunk in this section PreferenceChunk *pChunk = (PreferenceChunk *) ChunkList.GetHead(); while (pChunk != NULL) { // Write out this chunk and move on to the next pChunk->Write(OILPrefs, Section); pChunk = (PreferenceChunk *) ChunkList.GetNext(pChunk); } }

---

Member Data Documentation

List PreferenceSection::ChunkList

Definition at line 231 of file prefs.cpp.

LPTCHAR PreferenceSection::Section

Definition at line 228 of file prefs.cpp.

BOOL PreferenceSection::Valid

Definition at line 229 of file prefs.cpp.

---

The documentation for this class was generated from the following file:

• Kernel/prefs.cpp (r1785/r1464)

---