PreferenceChunk Class Reference

Objects of this class hold a chunk of preferences for a particular section of the preferences. There may be more than one chunk for a given section, depending on how accurate the initial declaration of the section's size was. More...

Inheritance diagram for PreferenceChunk:

List of all members.

Public Member Functions
	PreferenceChunk (UINT32 InitialSize)
	Constructs a chunk of memory which can contain preferences.
	~PreferenceChunk ()
	Destroys the PreferenceChunk - it deallocates any memory previously allocated for PreferenceEntry objects by this object.
void	Write (OILPreferences *OILPrefs, LPTCHAR Section)
	Writes out all the preferences contained in this chunk object, using the OIL.
BOOL	AddPref (LPTCHAR Name, PrefData EntryData, PreferenceType Type)
	Adds the given preference to this chunk.
BOOL	GetPrefValue (LPTCHAR Pref, PrefData EntryData, PreferenceType Type)
	Checks to see if the given preference exists in this chunk and if so returns the value currently assigned to that preference value by placing it in the variable pointed to by the PrefData structure passed in. This means one routine can be used as opposed to one per preference type.
BOOL	SetPrefValue (LPTCHAR Pref, PrefData EntryData, PreferenceType Type)
	Checks to see if the given preference exists in this chunk and if so sets the value stored in the preference user's variable to be the specified new value.
Public Attributes
BOOL	Valid
Private Attributes
UINT32	NumEntries
UINT32	NumEntriesUsed
PreferenceEntry *	pEntries

---

Detailed Description

Objects of this class hold a chunk of preferences for a particular section of the preferences. There may be more than one chunk for a given section, depending on how accurate the initial declaration of the section's size was.

Author:

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

Date:

17/8/93

See also:

-

Definition at line 165 of file prefs.cpp.

---

Constructor & Destructor Documentation

PreferenceChunk::PreferenceChunk (  UINT32  InitialSize  )

Constructs a chunk of memory which can contain preferences. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: InitialSize  - the number of preferences this chunk should be able to hold. [INPUTS] -  [OUTPUTS] Returns: - Errors: The member variable 'Valid' is FALSE if the required memory was not allocated. See also: - Definition at line 260 of file prefs.cpp. { Valid = FALSE; // Sanity check ENSURE(InitialSize > 0, "Attempt to create a PreferenceChunk object of zero size"); // Allocate the memory for this chunk. pEntries = new PreferenceEntry[InitialSize]; if (pEntries == NULL) { // Not enough memory NumEntries = 0; NumEntriesUsed = 0; } // Set the entries fields correctly and tell the caller it worked NumEntries = InitialSize; NumEntriesUsed = 0; Valid = TRUE; }

PreferenceChunk::~PreferenceChunk (   )

Destroys the PreferenceChunk - it deallocates any memory previously allocated for PreferenceEntry objects by this object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 299 of file prefs.cpp. { PreferenceEntry *pEntry = pEntries; for (UINT32 i = 0; i < NumEntriesUsed; i++) { if (pEntry->Name) { CCFree(pEntry->Name); pEntry->Name=NULL; } pEntry++; } if (pEntries != NULL) delete [] pEntries; }

---

Member Function Documentation

BOOL PreferenceChunk::AddPref (  LPTCHAR  Name, PrefData  EntryData, PreferenceType  Type )

Adds the given preference to this chunk. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 17/8/93 Parameters: Name  - the name of the section to add this preference to. [INPUTS] EntryData - pointer to the memory that will hold the value of this preference. Type - the type of this preference - i.e., the type of data pointed to by the EntryData argument. -  [OUTPUTS] Returns: TRUE if the preference could be added to this chunk - FALSE if the chunk is full and the preference could not be added. Errors: - See also: - Definition at line 338 of file prefs.cpp. { // Is there enough space left to do this? if ((!Valid) || (NumEntriesUsed >= NumEntries)) return FALSE; // Fill in the entry (NB. obscure pointer arithmetic) PreferenceEntry *pEntry = pEntries + NumEntriesUsed; // Alex put in something to make a copy of the name UINT32 memsize = (camStrlen(Name) + 1) * sizeof(TCHAR); pEntry->Name = (LPTCHAR) CCMalloc( memsize ); if (!pEntry->Name) return FALSE; // error already set camStrcpy(pEntry->Name, Name); // pEntry->Name = Name; pEntry->Data = EntryData; pEntry->Type = Type; // Update chunk information NumEntriesUsed++; // Return success return TRUE; }

BOOL PreferenceChunk::GetPrefValue (  LPTCHAR  Pref, PrefData  EntryData, PreferenceType  Type )

Checks to see if the given preference exists in this chunk and if so returns the value currently assigned to that preference value by placing it in the variable pointed to by the PrefData structure passed in. This means one routine can be used as opposed to one per preference type. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/10/94 Parameters: Pref  - name of preference to look for. [INPUTS] EntryData - pointer to the variable that will be used to pass the preference value back in. Type - the type of this preference - i.e., the type of data pointed to by the EntryData argument. EntryData  - pointer to the variable that should now be set up to echo the [OUTPUTS] value of the specified preference. Returns: TRUE if the preference exists, FALSE otherwise. Errors: - See also: PreferenceChunk::SetPrefValue Definition at line 421 of file prefs.cpp. { PreferenceEntry *pEntry = pEntries; for (UINT32 i = 0; i < NumEntriesUsed; i++) { if (camStricmp(Pref, pEntry->Name) == 0) { // Found it so it does exist // Check that the type corresponds to the correct one if (pEntry->Type == Type) { // Preference exits and is of the correct type so return it by writing // the value pointed to by the preference into the value pointed to by // the preference structure passed in. switch (Type) { case PREF_INT: // integer supplied so use the pointer to integer *EntryData.pInt = *pEntry->Data.pInt; break; case PREF_UINT: *EntryData.pUInt = *pEntry->Data.pUInt; break; case PREF_DOUBLE: *EntryData.pDouble = *pEntry->Data.pDouble; break; case PREF_STRING: // Shouldn't be required so disable //*EntryData.pString = *pEntry->Data.pString; return FALSE; break; } return TRUE; } else { return FALSE; } } // Move on to the next preference pEntry++; } // Not found return FALSE; }

BOOL PreferenceChunk::SetPrefValue (  LPTCHAR  Pref, PrefData  EntryData, PreferenceType  Type )

Checks to see if the given preference exists in this chunk and if so sets the value stored in the preference user's variable to be the specified new value. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 17/10/94 Parameters: Pref  - name of preference to look for. [INPUTS] EntryData - pointer to the memory that is holding the value of this preference that we wish to set. Type - the type of this preference - i.e., the type of data pointed to by the EntryData argument. -  [OUTPUTS] Returns: TRUE if the preference exists, FALSE otherwise. Errors: - See also: PreferenceChunk::GetPrefValue Definition at line 489 of file prefs.cpp. { PreferenceEntry *pEntry = pEntries; for (UINT32 i = 0; i < NumEntriesUsed; i++) { if (camStricmp(Pref, pEntry->Name) == 0) { // Found it so it does exist // Check that the type corresponds to the correct one if (pEntry->Type == Type) { // Preference exits and is of the correct type so return it by writing // the value pointed to by the preference into the value pointed to by // the preference structure passed in. switch (Type) { case PREF_INT: // integer supplied so use the pointer to integer *pEntry->Data.pInt = *EntryData.pInt; break; case PREF_UINT: *pEntry->Data.pUInt = *EntryData.pUInt; break; case PREF_DOUBLE: *pEntry->Data.pDouble = *EntryData.pDouble; break; case PREF_STRING: // Shouldn't be required so disable //*EntryData.pString = *pEntry->Data.pString; return FALSE; break; } return TRUE; } else { return FALSE; } } // Move on to the next preference pEntry++; } // Not found return FALSE; }

void PreferenceChunk::Write (  OILPreferences *  OILPrefs, LPTCHAR  Section )

Writes out all the preferences contained in this chunk object, 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 the preferences out with. [INPUTS] Section - the name of the section that this chunk is a part of. -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 380 of file prefs.cpp. { // Write out each preference in this chunk PreferenceEntry *pEntry = pEntries; for (UINT32 i = 0; i < NumEntriesUsed; i++) { // Write this preference OILPrefs->Write(Section, pEntry->Name, pEntry->Type, pEntry->Data); // Move on to the next preference pEntry++; } }

---

Member Data Documentation

UINT32 PreferenceChunk::NumEntries [private]

Definition at line 180 of file prefs.cpp.

UINT32 PreferenceChunk::NumEntriesUsed [private]

Definition at line 181 of file prefs.cpp.

PreferenceEntry* PreferenceChunk::pEntries [private]

Definition at line 183 of file prefs.cpp.

BOOL PreferenceChunk::Valid

Definition at line 186 of file prefs.cpp.

---

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

• Kernel/prefs.cpp (r1785/r1464)

---