David Smart / IniManager

A simple .ini file interface.

Dependents:   Smart-WiFly-WebServer SignalGenerator WattEye X10Svr

IniManager.h@8:f128b10dfab1, 2014-07-07 (annotated)

Committer:
WiredHome
Date:
Mon Jul 07 15:19:16 2014 +0000
Revision:
8:f128b10dfab1
Parent:
6:cd28ab597256
Child:
10:57b93035ad82
Internal changes only to try to make it more robust, and require less memory.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WiredHome 0:ae5bf432c249 1
WiredHome 0:ae5bf432c249 2 #ifndef INIMANAGER_H
WiredHome 0:ae5bf432c249 3 #define INIMANAGER_H
WiredHome 0:ae5bf432c249 4
WiredHome 0:ae5bf432c249 5 #define INTERNAL_BUF_SIZE 250
WiredHome 0:ae5bf432c249 6
WiredHome 0:ae5bf432c249 7 /** A simple ini file manager.
WiredHome 0:ae5bf432c249 8 *
WiredHome 0:ae5bf432c249 9 * This is a simple ini file manager intended for low duty cycle usage.
WiredHome 0:ae5bf432c249 10 *
WiredHome 0:ae5bf432c249 11 * It follows an old "Windows" style of ini file format with section, key, and value.
WiredHome 0:ae5bf432c249 12 * This version only operates on strings at this time.
WiredHome 0:ae5bf432c249 13 *
WiredHome 0:ae5bf432c249 14 * As a "simple" ini file manager, this version does not cache anything internally.
WiredHome 0:ae5bf432c249 15 * This comes at the "cost" that each write transaction will read and replace the
WiredHome 0:ae5bf432c249 16 * ini file. Read transactions will open and scan the file.
WiredHome 0:ae5bf432c249 17 *
WiredHome 0:ae5bf432c249 18 * Also, an internal stack-frame buffer is used to manage the read operations. As
WiredHome 0:ae5bf432c249 19 * such, no single record in the file can exceed this buffer size (compile time set
WiredHome 0:ae5bf432c249 20 * with a default of 250 bytes). A single record for a section is surrounded with
WiredHome 0:ae5bf432c249 21 * '[' and ']' and a new line appended. A single record for an entry within a
WiredHome 0:ae5bf432c249 22 * section for a key, value pair is separated with an '=' and a new line appended.
WiredHome 0:ae5bf432c249 23 * @code
WiredHome 0:ae5bf432c249 24 * [section name]
WiredHome 0:ae5bf432c249 25 * Key name=value for Key name
WiredHome 0:ae5bf432c249 26 * Another key=another value
WiredHome 0:ae5bf432c249 27 * @endcode
WiredHome 0:ae5bf432c249 28 */
WiredHome 0:ae5bf432c249 29 class INI
WiredHome 0:ae5bf432c249 30 {
WiredHome 0:ae5bf432c249 31 public:
WiredHome 6:cd28ab597256 32 /** Constructor for an INI file interface.
WiredHome 0:ae5bf432c249 33 *
WiredHome 6:cd28ab597256 34 * Constructor for an INI file interface.
WiredHome 6:cd28ab597256 35 *
WiredHome 6:cd28ab597256 36 * @param[in] file is the filename to manage. Memory is allocated to hold
WiredHome 0:ae5bf432c249 37 * a private copy of the filename. Be sure that this parameter
WiredHome 0:ae5bf432c249 38 * has the right path prefix based on what file system you have.
WiredHome 0:ae5bf432c249 39 */
WiredHome 5:bfeb0882bd82 40 INI(const char * file = NULL);
WiredHome 0:ae5bf432c249 41
WiredHome 0:ae5bf432c249 42 /** destructor for the ini manager.
WiredHome 0:ae5bf432c249 43 *
WiredHome 0:ae5bf432c249 44 * releases the memory allocation.
WiredHome 0:ae5bf432c249 45 */
WiredHome 0:ae5bf432c249 46 ~INI(void);
WiredHome 0:ae5bf432c249 47
WiredHome 8:f128b10dfab1 48 /** Determine if a file exists
WiredHome 8:f128b10dfab1 49 *
WiredHome 8:f128b10dfab1 50 * This API can be used to determine if a file exists. The file may
WiredHome 8:f128b10dfab1 51 * be specified as a parameter, but if no parameter is supplied it will
WiredHome 8:f128b10dfab1 52 * then check to see if the INI file exists. This is either the file
WiredHome 8:f128b10dfab1 53 * passed to the constructor, or the file passed to the SetFile API.
WiredHome 8:f128b10dfab1 54 *
WiredHome 8:f128b10dfab1 55 * @param[in] file is the optional filename to check for existance.
WiredHome 8:f128b10dfab1 56 * @returns true if the file exists.
WiredHome 8:f128b10dfab1 57 */
WiredHome 8:f128b10dfab1 58 bool Exists(const char * file = NULL);
WiredHome 8:f128b10dfab1 59
WiredHome 5:bfeb0882bd82 60 /** set the file to use
WiredHome 5:bfeb0882bd82 61 *
WiredHome 5:bfeb0882bd82 62 * If not set at the time of construction, or if a change is needed, this
WiredHome 5:bfeb0882bd82 63 * API can be used.
WiredHome 5:bfeb0882bd82 64 *
WiredHome 6:cd28ab597256 65 * @param[in] file is the filename to manage.
WiredHome 5:bfeb0882bd82 66 * @returns true if success, false if memory could not be allocated.
WiredHome 5:bfeb0882bd82 67 */
WiredHome 5:bfeb0882bd82 68 bool SetFile(const char * file);
WiredHome 5:bfeb0882bd82 69
WiredHome 0:ae5bf432c249 70 /** Read a string from the ini file - if it exists.
WiredHome 0:ae5bf432c249 71 *
WiredHome 0:ae5bf432c249 72 * This searches the ini file for the named section and key and if found it will
WiredHome 0:ae5bf432c249 73 * return the string associated with that entry into a user supplied buffer.
WiredHome 0:ae5bf432c249 74 *
WiredHome 6:cd28ab597256 75 * @param[in] section is the name of the section to search.
WiredHome 6:cd28ab597256 76 * @param[in] key is the name of the key to search.
WiredHome 6:cd28ab597256 77 * @param[out] buffer is the caller provided buffer for this method to put the string into.
WiredHome 6:cd28ab597256 78 * @param[in] bufferSize is the caller provided declaration of the available space.
WiredHome 6:cd28ab597256 79 * @param[in] defaultString is an optional parameter that sets the buffer if the section/key is not found.
WiredHome 0:ae5bf432c249 80 *
WiredHome 0:ae5bf432c249 81 * @return true if the section, key, and value are found AND the value will fit in the buffer
WiredHome 0:ae5bf432c249 82 * in which case it is written into the buffer; false otherwise.
WiredHome 0:ae5bf432c249 83 */
WiredHome 0:ae5bf432c249 84 bool ReadString(const char * section, const char * key, char * buffer, size_t bufferSize, const char * defaultString = NULL);
WiredHome 0:ae5bf432c249 85
WiredHome 0:ae5bf432c249 86 /** Writes a string into the ini file
WiredHome 0:ae5bf432c249 87 *
WiredHome 0:ae5bf432c249 88 * This writes a given string into an ini file in the named section and key.
WiredHome 0:ae5bf432c249 89 *
WiredHome 6:cd28ab597256 90 * @param[in] section is the name of the section to search.
WiredHome 6:cd28ab597256 91 * @param[in] key is the name of the key to search.
WiredHome 6:cd28ab597256 92 * @param[in] buffer is the caller provided buffer containing the string to write. If
WiredHome 0:ae5bf432c249 93 * buffer is NULL, then any existing entry is removed.
WiredHome 0:ae5bf432c249 94 *
WiredHome 0:ae5bf432c249 95 * @return true if the write was successful; false otherwise.
WiredHome 0:ae5bf432c249 96 */
WiredHome 0:ae5bf432c249 97 bool WriteString(const char * section, const char * key, char * buffer);
WiredHome 0:ae5bf432c249 98
WiredHome 0:ae5bf432c249 99 private:
WiredHome 0:ae5bf432c249 100 char * iniFile;
WiredHome 0:ae5bf432c249 101
WiredHome 8:f128b10dfab1 102 /** Cleanup temporary files.
WiredHome 0:ae5bf432c249 103 *
WiredHome 8:f128b10dfab1 104 * This will attempt to clean up any temporary files. This can happen
WiredHome 8:f128b10dfab1 105 * while writing a new file, if something went wrong and the program
WiredHome 8:f128b10dfab1 106 * crashed or otherwise could not complete the process.
WiredHome 8:f128b10dfab1 107 * This will look for the temp files, try to finish processing them
WiredHome 8:f128b10dfab1 108 * and remove the extraneous.
WiredHome 0:ae5bf432c249 109 *
WiredHome 0:ae5bf432c249 110 * @return true, always until I find a reason not to.
WiredHome 0:ae5bf432c249 111 */
WiredHome 8:f128b10dfab1 112 bool CleanUp();
WiredHome 0:ae5bf432c249 113
WiredHome 0:ae5bf432c249 114 /** Rename a file
WiredHome 0:ae5bf432c249 115 *
WiredHome 0:ae5bf432c249 116 * This version also works on the local file system.
WiredHome 0:ae5bf432c249 117 *
WiredHome 6:cd28ab597256 118 * @param[in] oldfname is the old file name
WiredHome 6:cd28ab597256 119 * @param[in] newfname is the new file name
WiredHome 0:ae5bf432c249 120 * @returns 0 on success, -1 on error
WiredHome 0:ae5bf432c249 121 */
WiredHome 0:ae5bf432c249 122 int Rename(const char *oldfname, const char *newfname);
WiredHome 0:ae5bf432c249 123
WiredHome 0:ae5bf432c249 124 /** Copy a file
WiredHome 0:ae5bf432c249 125 *
WiredHome 0:ae5bf432c249 126 * This version also works on the local file system.
WiredHome 0:ae5bf432c249 127 *
WiredHome 6:cd28ab597256 128 * @param[in] src is the source file
WiredHome 6:cd28ab597256 129 * @param[in] dst is the destination file
WiredHome 0:ae5bf432c249 130 * @returns 0 on success, -1 on error
WiredHome 0:ae5bf432c249 131 */
WiredHome 0:ae5bf432c249 132 int Copy(const char *src, const char *dst);
WiredHome 0:ae5bf432c249 133 };
WiredHome 0:ae5bf432c249 134
WiredHome 0:ae5bf432c249 135 #endif // INIMANAGER_H