archives/passage
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Initial source commit

Browse source
This commit is contained in:
Tony Bark 2025-10-03 02:19:59 -04:00
commit f1384c11ee
335 changed files with 52715 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

308
minorGems/util/SettingsManager.h Normal file
View file

@ -0,0 +1,308 @@
/*
* Modification History
*
* 2002-September-16 Jason Rohrer
* Created.
* Fixed a memory leak.
*
* 2002-September-25 Jason Rohrer
* Added a setSetting function that takes a string value.
*
* 2002-September-26 Jason Rohrer
* Added functions for integer values.
*
* 2003-August-24 Jason Rohrer
* Fixed to remove 499-character limit for a setting value.
*
* 2009-February-11 Jason Rohrer
* Made getSettingsFile public to support arbitry binary data in settings.
*
* 2009-February-12 Jason Rohrer
* Added support for secure hashing.
*
* 2010-May-14 Jason Rohrer
* String parameters as const to fix warnings.
*/
#include "minorGems/common.h"
#ifndef SETTINGS_MANAGER_INCLUDED
#define SETTINGS_MANAGER_INCLUDED
#include "minorGems/util/SimpleVector.h"
#include "minorGems/system/MutexLock.h"
#include <stdio.h>
// utility class for dealing with static member dealocation
class SettingsManagerStaticMembers;
/**
* Class that manages program settings.
*
* @author Jason Rohrer
*/
class SettingsManager {
public:
/**
* Sets the directory name where settings are stored.
*
* @param inName the name of the directory (relative to the
* program's working directory).
* Must be destroyed by caller if non-const.
*/
static void setDirectoryName( const char *inName );
/**
* Gets the directory name where settings are stored.
*
* @return the name of the directory (relative to the
* program's working directory).
* Must be destroyed by caller.
*/
static char *getDirectoryName();
/**
* Sets the salt to be used when hashing settings.
*
* @param inSalt the salt as an ASCII string.
* Must be destroyed by caller if non-const.
*/
static void setHashSalt( const char *inSalt );
/**
* Gets the salt to be used when hashing settings.
*
* @return the hash salt.
* Must be destroyed by caller.
*/
static char *getHashSalt();
/**
* Turns hashing on or off. If off, manager will reject
* settings in folder that do not have proper hashes.
*
* @param inOn true to turn hashing on.
*/
static void setHashingOn( char inOn );
/**
* Gets a setting.
*
* @param inSettingName the name of the setting to get.
* Must be destroyed by caller if non-const.
*
* @return a vector of strings representing the setting value.
* The vector and the strings it contains must be destroyed
* by the caller.
*/
static SimpleVector<char *> *getSetting( const char *inSettingName );
/**
* Gets a string setting.
*
* @param inSettingName the name of the setting to get.
* Must be destroyed by caller if non-const.
*
* @return the setting value string, or NULL if no setting
* value can be read.
* Must be destroyed by caller if non-NULL.
*/
static char *getStringSetting( const char *inSettingName );
/**
* Gets a float setting.
*
* @param inSettingName the name of the setting to get.
* Must be destroyed by caller if non-const.
* @param outValueFound pointer to where flag should be returned
* indicating whether or not the value was found.
* Set to true if the value was found, false otherwise.
*
* @return the setting value.
*/
static float getFloatSetting( const char *inSettingName,
char *outValueFound );
/**
* Gets an integer setting.
*
* @param inSettingName the name of the setting to get.
* Must be destroyed by caller if non-const.
* @param outValueFound pointer to where flag should be returned
* indicating whether or not the value was found.
* Set to true if the value was found, false otherwise.
*
* @return the setting value.
*/
static int getIntSetting( const char *inSettingName,
char *outValueFound );
/**
* Sets a setting.
*
* @param inSettingName the name of the setting to set.
* Must be destroyed by caller if non-const.
* @param inSettingVector a vector of strings representing the
* setting value.
* The vector and the strings it contains must be destroyed
* by the caller.
*/
static void setSetting( const char *inSettingName,
SimpleVector<char *> *inSettingVector );
/**
* Sets a setting to a single float value.
*
* @param inSettingName the name of the setting to set.
* Must be destroyed by caller if non-const.
* @param inSettingValue the value to set.
*/
static void setSetting( const char *inSettingName,
float inSettingValue );
/**
* Sets a setting to a single int value.
*
* @param inSettingName the name of the setting to set.
* Must be destroyed by caller if non-const.
* @param inSettingValue the value to set.
*/
static void setSetting( const char *inSettingName,
int inSettingValue );
/**
* Sets a setting to a single string value.
*
* @param inSettingName the name of the setting to set.
* Must be destroyed by caller if non-const.
* @param inSettingValue the value to set.
* Must be destroyed by caller.
*/
static void setSetting( const char *inSettingName,
const char *inSettingValue );
/**
* Gets the file for a setting name.
*
* @param inSettingName the name of the setting.
* Must be destroyed by caller if non-const.
* @param inReadWriteFlags the flags to pass into the
* fopen call. For example, "r" or "w".
*
* @return the file descriptor, or NULL if the open failed.
* Must be fclose()'d by caller if non-NULL.
*/
static FILE *getSettingsFile( const char *inSettingName,
const char *inReadWriteFlags );
protected:
static SettingsManagerStaticMembers mStaticMembers;
static char mHashingOn;
/**
* Gets the file name for a setting with the default ini extension.
* The .ini extension is added automatically by this call.
*
* @param inSettingName the name of the setting.
* Must be destroyed by caller if non-const.
*
* @return the name of the settings file.
* Must be destroyed by caller.
*/
static char *getSettingsFileName( const char *inSettingName );
/**
* Gets the file name for a setting with a custom extension.
* The extension should be passed in without a period in it.
*
* @param inSettingName the name of the setting.
* Must be destroyed by caller if non-const.
* @param inExtension the extension to add to the name.
* Example: "ini"
* Must be destroyed by caller if non-const.
*
* @return the name of the settings file.
* Must be destroyed by caller.
*/
static char *getSettingsFileName( const char *inSettingName,
const char *inExtension );
};
/**
* Container for static members to allow for their proper destruction
* on program termination.
*
* @author Jason Rohrer
*/
class SettingsManagerStaticMembers {
public:
SettingsManagerStaticMembers();
~SettingsManagerStaticMembers();
char *mDirectoryName;
char *mHashSalt;
};
#endif