Doug Anson / endpoint_core

Core Base Classes for the Light Endpoints

Dependencies:   BufferedSerial

Dependents:   mbed_mqtt_endpoint_ublox_ethernet mbed_mqtt_endpoint_ublox_cellular mbed_nsp_endpoint_ublox_cellular mbed_nsp_endpoint_ublox_ethernet ... more

Preferences.cpp@135:7f3f963cd159, 2014-03-28 (annotated)

Committer:
ansond
Date:
Fri Mar 28 17:49:10 2014 +0000
Revision:
135:7f3f963cd159
Parent:
123:b0d950f80ed9
Child:
152:659a8ebcbe93
updates

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 112:1fb53d4729af 1 /* Copyright C2013 Doug Anson, MIT License
ansond 112:1fb53d4729af 2 *
ansond 112:1fb53d4729af 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
ansond 112:1fb53d4729af 4 * and associated documentation files the "Software", to deal in the Software without restriction,
ansond 112:1fb53d4729af 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
ansond 112:1fb53d4729af 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
ansond 112:1fb53d4729af 7 * furnished to do so, subject to the following conditions:
ansond 112:1fb53d4729af 8 *
ansond 112:1fb53d4729af 9 * The above copyright notice and this permission notice shall be included in all copies or
ansond 112:1fb53d4729af 10 * substantial portions of the Software.
ansond 112:1fb53d4729af 11 *
ansond 112:1fb53d4729af 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
ansond 112:1fb53d4729af 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
ansond 112:1fb53d4729af 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
ansond 112:1fb53d4729af 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ansond 112:1fb53d4729af 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
ansond 112:1fb53d4729af 17 */
ansond 112:1fb53d4729af 18
ansond 112:1fb53d4729af 19 #include "mbed.h"
ansond 112:1fb53d4729af 20 #include "Preferences.h"
ansond 112:1fb53d4729af 21
ansond 116:428281cb5066 22 LocalFileSystem local("local");
ansond 116:428281cb5066 23
ansond 112:1fb53d4729af 24 // default constructor
ansond 135:7f3f963cd159 25 Preferences::Preferences(ErrorHandler *error_handler) : BaseClass(error_handler,NULL) {
ansond 112:1fb53d4729af 26 this->initialize();
ansond 112:1fb53d4729af 27 }
ansond 112:1fb53d4729af 28
ansond 112:1fb53d4729af 29 // destructor
ansond 112:1fb53d4729af 30 Preferences::~Preferences() {
ansond 112:1fb53d4729af 31 }
ansond 112:1fb53d4729af 32
ansond 112:1fb53d4729af 33 // initialize the preferences from the preferences file
ansond 112:1fb53d4729af 34 bool Preferences::initialize() {
ansond 123:b0d950f80ed9 35 char name[PREFERENCE_NAME_LEN+1];
ansond 123:b0d950f80ed9 36 char value[PREFERENCE_VALUE_LEN+1];
ansond 118:c8a80adfe90d 37 char buffer[PREFERENCE_NAME_LEN + PREFERENCE_NAME_LEN + 10];
ansond 112:1fb53d4729af 38 bool success = true;
ansond 112:1fb53d4729af 39
ansond 118:c8a80adfe90d 40 // initialize the memory buffers and count
ansond 118:c8a80adfe90d 41 for(int i=0;i<MAX_NUM_PREFERENCES;++i) {
ansond 118:c8a80adfe90d 42 memset(this->m_names[i],0,PREFERENCE_NAME_LEN+1);
ansond 118:c8a80adfe90d 43 memset(this->m_values[i],0,PREFERENCE_VALUE_LEN+1);
ansond 118:c8a80adfe90d 44 }
ansond 118:c8a80adfe90d 45 this->m_num_preferences = 0;
ansond 118:c8a80adfe90d 46
ansond 118:c8a80adfe90d 47 // read and open the config file
ansond 118:c8a80adfe90d 48 FILE *fp = fopen(PREFERENCES_FILE,"r");
ansond 118:c8a80adfe90d 49 if (fp != NULL) {
ansond 118:c8a80adfe90d 50 // read in the first line
ansond 118:c8a80adfe90d 51 memset(buffer,0,PREFERENCE_NAME_LEN + PREFERENCE_NAME_LEN + 10);
ansond 118:c8a80adfe90d 52 int n = fscanf(fp,"%s",buffer);
ansond 118:c8a80adfe90d 53
ansond 118:c8a80adfe90d 54 // loop and read each line
ansond 118:c8a80adfe90d 55 while(n != EOF) {
ansond 118:c8a80adfe90d 56 // replace the equals sign with a space
ansond 118:c8a80adfe90d 57 for(int i=0;i<strlen(buffer);++i) if (buffer[i] == '=') buffer[i] = ' ';
ansond 118:c8a80adfe90d 58
ansond 118:c8a80adfe90d 59 // parse
ansond 123:b0d950f80ed9 60 memset(name,0,PREFERENCE_NAME_LEN+1);
ansond 123:b0d950f80ed9 61 memset(value,0,PREFERENCE_VALUE_LEN+1);
ansond 123:b0d950f80ed9 62 sscanf(buffer,"%s%s",name,value);
ansond 123:b0d950f80ed9 63 strcpy(this->m_names[this->m_num_preferences],name);
ansond 123:b0d950f80ed9 64 strcpy(this->m_values[this->m_num_preferences],value);
ansond 118:c8a80adfe90d 65
ansond 118:c8a80adfe90d 66 // DEBUG
ansond 118:c8a80adfe90d 67 this->logger()->log("Installed Preference: %s=%s",this->m_names[this->m_num_preferences],this->m_values[this->m_num_preferences]);
ansond 118:c8a80adfe90d 68
ansond 118:c8a80adfe90d 69 // increment the tally
ansond 118:c8a80adfe90d 70 ++this->m_num_preferences;
ansond 118:c8a80adfe90d 71
ansond 118:c8a80adfe90d 72 // reset the buffer and read in another line
ansond 118:c8a80adfe90d 73 memset(buffer,0,PREFERENCE_NAME_LEN + PREFERENCE_NAME_LEN + 10);
ansond 118:c8a80adfe90d 74 n = fscanf(fp,"%s",buffer);
ansond 112:1fb53d4729af 75 }
ansond 118:c8a80adfe90d 76
ansond 118:c8a80adfe90d 77 // close
ansond 118:c8a80adfe90d 78 fclose(fp);
ansond 118:c8a80adfe90d 79
ansond 118:c8a80adfe90d 80 // summary
ansond 118:c8a80adfe90d 81 this->logger()->log("Installed %d preferences",this->m_num_preferences);
ansond 112:1fb53d4729af 82 }
ansond 112:1fb53d4729af 83 else {
ansond 118:c8a80adfe90d 84 // unable to open the preferences file - not loaded
ansond 118:c8a80adfe90d 85 this->logger()->log("Unable to open preferences file %s... Preferences not loaded.",PREFERENCES_FILE);
ansond 112:1fb53d4729af 86 success = false;
ansond 112:1fb53d4729af 87 }
ansond 112:1fb53d4729af 88
ansond 112:1fb53d4729af 89 // return our status
ansond 112:1fb53d4729af 90 return success;
ansond 112:1fb53d4729af 91 }
ansond 112:1fb53d4729af 92
ansond 120:edf33bd41e4f 93 // HACK: fix up coords because IOC's POINT() macro does not like commas
ansond 120:edf33bd41e4f 94 void Preferences::fixCoordsForIOC() {
ansond 121:40bb95a10a0e 95 int index = this->indexOfPreference("coords");
ansond 120:edf33bd41e4f 96 if (index >= 0) {
ansond 120:edf33bd41e4f 97 // remove the comma...
ansond 120:edf33bd41e4f 98 for(int i=0;i<strlen(this->m_values[index]);++i) if (this->m_values[index][i] == ',') this->m_values[index][i] = ' ';
ansond 120:edf33bd41e4f 99 }
ansond 120:edf33bd41e4f 100 }
ansond 120:edf33bd41e4f 101
ansond 112:1fb53d4729af 102 // integer preference with defaults
ansond 112:1fb53d4729af 103 int Preferences::getIntPreference(char *name,int def_value) {\
ansond 112:1fb53d4729af 104 int int_value = def_value;
ansond 112:1fb53d4729af 105 char buffer[PREFERENCE_VALUE_LEN+1];
ansond 112:1fb53d4729af 106 memset(buffer,0,PREFERENCE_VALUE_LEN+1);
ansond 112:1fb53d4729af 107 char *value = this->getPreference(name,buffer,PREFERENCE_VALUE_LEN,NULL);
ansond 116:428281cb5066 108 if (value != NULL && strlen(value) > 0) sscanf(buffer,"%d",&int_value);
ansond 112:1fb53d4729af 109 return int_value;
ansond 112:1fb53d4729af 110 }
ansond 112:1fb53d4729af 111
ansond 112:1fb53d4729af 112 // boolean preference with defaults
ansond 112:1fb53d4729af 113 bool Preferences::getBooleanPreference(char *name,bool def_value) {
ansond 112:1fb53d4729af 114 bool bool_value = def_value;
ansond 112:1fb53d4729af 115 char buffer[PREFERENCE_VALUE_LEN+1];
ansond 112:1fb53d4729af 116 memset(buffer,0,PREFERENCE_VALUE_LEN+1);
ansond 112:1fb53d4729af 117 char *value = this->getPreference(name,buffer,PREFERENCE_VALUE_LEN,NULL);
ansond 112:1fb53d4729af 118 if (value != NULL && strcmp(value,"true") == 0) bool_value = true;
ansond 112:1fb53d4729af 119 if (value != NULL && strcmp(value,"false") == 0) bool_value = false;
ansond 112:1fb53d4729af 120 return bool_value;
ansond 112:1fb53d4729af 121 }
ansond 112:1fb53d4729af 122
ansond 112:1fb53d4729af 123 // string preference with defaults
ansond 112:1fb53d4729af 124 char *Preferences::getPreference(char *name,char *buffer,int buffer_length,char *def_value) {
ansond 118:c8a80adfe90d 125 char *value = NULL;
ansond 118:c8a80adfe90d 126
ansond 118:c8a80adfe90d 127 // clean the buffer
ansond 118:c8a80adfe90d 128 memset(buffer,0,buffer_length);
ansond 118:c8a80adfe90d 129
ansond 122:21be9cc9e63d 130 // DEBUG
ansond 122:21be9cc9e63d 131 //this->logger()->log("GET: %s DEFAULT: %s BUFFER_LEN=%d",name,def_value,buffer_length);
ansond 122:21be9cc9e63d 132
ansond 118:c8a80adfe90d 133 // get our index
ansond 118:c8a80adfe90d 134 int index = this->indexOfPreference(name);
ansond 118:c8a80adfe90d 135 if (index >= 0) {
ansond 118:c8a80adfe90d 136 // fill with our value
ansond 118:c8a80adfe90d 137 strncpy(buffer,this->m_values[index],this->min(buffer_length,strlen(this->m_values[index])));
ansond 118:c8a80adfe90d 138 value = buffer;
ansond 122:21be9cc9e63d 139 //this->logger()->log("Preference GET: %s=%s",name,value);
ansond 118:c8a80adfe90d 140 }
ansond 118:c8a80adfe90d 141 else {
ansond 118:c8a80adfe90d 142 // fill with the default
ansond 122:21be9cc9e63d 143 if (def_value != NULL) {
ansond 122:21be9cc9e63d 144 strncpy(buffer,def_value,this->min(buffer_length,strlen(def_value)));
ansond 122:21be9cc9e63d 145 value = buffer;
ansond 122:21be9cc9e63d 146 //this->logger()->log("Using Defaults for %s=%s",name,value);
ansond 122:21be9cc9e63d 147 }
ansond 122:21be9cc9e63d 148 else {
ansond 122:21be9cc9e63d 149 // no defaults
ansond 122:21be9cc9e63d 150 //this->logger()->log("No default for GET: %s",name);
ansond 122:21be9cc9e63d 151 value = buffer;
ansond 122:21be9cc9e63d 152 }
ansond 114:bd38ad417d6a 153 }
ansond 118:c8a80adfe90d 154
ansond 118:c8a80adfe90d 155 // return the value
ansond 118:c8a80adfe90d 156 return value;
ansond 118:c8a80adfe90d 157 }
ansond 118:c8a80adfe90d 158
ansond 118:c8a80adfe90d 159 // get the index of the named preference
ansond 118:c8a80adfe90d 160 int Preferences::indexOfPreference(char *name) {
ansond 118:c8a80adfe90d 161 bool found = false;
ansond 118:c8a80adfe90d 162 int index = -1;
ansond 118:c8a80adfe90d 163
ansond 118:c8a80adfe90d 164 // parameter check
ansond 118:c8a80adfe90d 165 if (name != NULL && strlen(name) > 0) {
ansond 118:c8a80adfe90d 166
ansond 118:c8a80adfe90d 167 // loop until we find the name.. then stop and record its index
ansond 118:c8a80adfe90d 168 for(int i=0;i<this->m_num_preferences && !found;++i) {
ansond 118:c8a80adfe90d 169 if (strcmp(name,this->m_names[i]) == 0) {
ansond 118:c8a80adfe90d 170 found = true;
ansond 118:c8a80adfe90d 171 index = i;
ansond 118:c8a80adfe90d 172 }
ansond 118:c8a80adfe90d 173 }
ansond 118:c8a80adfe90d 174 }
ansond 118:c8a80adfe90d 175
ansond 118:c8a80adfe90d 176 // return the index value
ansond 118:c8a80adfe90d 177 return index;
ansond 112:1fb53d4729af 178 }
ansond 135:7f3f963cd159 179
ansond 112:1fb53d4729af 180 // get our preference count
ansond 118:c8a80adfe90d 181 int Preferences::numPreferences() { return this->m_num_preferences; }
ansond 112:1fb53d4729af 182
ansond 112:1fb53d4729af 183 // min function
ansond 112:1fb53d4729af 184 int Preferences::min(int value1,int value2) {
ansond 112:1fb53d4729af 185 if (value1 < value2) return value1;
ansond 112:1fb53d4729af 186 return value2;
ansond 112:1fb53d4729af 187 }