Add missing documentation.

[stg.git] / stglibs / conffiles.lib / conffiles.cpp

diff --git a/stglibs/conffiles.lib/conffiles.cpp b/stglibs/conffiles.lib/conffiles.cpp
index 9c8c46e8809719bab9b012f25505dfd52fb6935a..9578e24f298791daad4e3923ae948bde7da9cf62 100644 (file)
--- a/stglibs/conffiles.lib/conffiles.cpp
+++ b/stglibs/conffiles.lib/conffiles.cpp
@@ -28,146 +28,122 @@
  */
 
 //---------------------------------------------------------------------------
  */
 
 //---------------------------------------------------------------------------

-#include <cerrno>
+
+// getpid
+#include <sys/types.h>
+#include <unistd.h>
+
+#include <cerrno> // E*

 #include <cstring>
 #include <cstring>

+#include <sstream>

 #include <cstdlib>
 #include <cstdlib>

+#include <cstdio>

 
 #include <fstream>
 
 
 #include <fstream>
 

-#include "conffiles.h"
-#include "common.h"
+#include "stg/conffiles.h"

 
 

-using namespace std;
+namespace
+{
+//---------------------------------------------------------------------------
+std::string TrimL(std::string val)
+{
+size_t pos = val.find_first_not_of(" \t");
+if (pos == std::string::npos)
+    {
+    val.erase(val.begin(), val.end());
+    }
+else
+    {
+    val.erase(0, pos);
+    }
+return val;
+}
+//---------------------------------------------------------------------------
+std::string TrimR(std::string val)
+{
+size_t pos = val.find_last_not_of(" \t");
+if (pos != std::string::npos)
+    {
+    val.erase(pos + 1);
+    }
+return val;
+}
+//---------------------------------------------------------------------------
+std::string Trim(const std::string& val)
+{
+return TrimR(TrimL(val));
+}
+//---------------------------------------------------------------------------
+} // namespace anonymous

 
 //---------------------------------------------------------------------------
 
 //---------------------------------------------------------------------------

-bool StringCaseCmp(const string & str1, const string & str2)
+bool StringCaseCmp(const std::string & str1, const std::string & str2)

 {
 return (strcasecmp(str1.c_str(), str2.c_str()) < 0);
 }
 //---------------------------------------------------------------------------
 {
 return (strcasecmp(str1.c_str(), str2.c_str()) < 0);
 }
 //---------------------------------------------------------------------------

-CONFIGFILE::CONFIGFILE(const string & fn)
+CONFIGFILE::CONFIGFILE(const std::string & fn, bool nook)

     : param_val(StringCaseCmp),
       fileName(fn),
     : param_val(StringCaseCmp),
       fileName(fn),

-      error(0)
+      error(0),
+      changed(false)

 {
 {

-ifstream f(fileName.c_str());
-//FILE * f = fopen(fileName.c_str(), "rt");
+std::ifstream f(fileName.c_str());

 
 if (!f)
     {
 
 if (!f)
     {

-    error = -1;
+    if (!nook)
+        error = -1;

     return;
     }
 
     return;
     }
 

-string line;
+std::string line;

 while (getline(f, line))
     {
 while (getline(f, line))
     {

-    /*unsigned char c = fgetc(f);
-    while (!feof(f))
-        {
-        if (c == '\n')
-            break;
-        line.push_back(c);
-        c = fgetc(f);
-        }*/
-

     size_t pos = line.find('#');
     size_t pos = line.find('#');

-    if (pos != string::npos)
+    if (pos != std::string::npos)

         line.resize(pos);
 
         line.resize(pos);
 

-    if (line.find_first_not_of(" \t\r") == string::npos)
+    if (line.find_first_not_of(" \t\r") == std::string::npos)

         continue;
 
         continue;
 

-    /*bool emptyLine = true;
-    for (unsigned int i = 0; i < line.size(); i++)
-        {
-        if (line[i] != ' ' && line[i] != '\t' && line[i] != '\n' && line[i] != '\r')
-            {
-            emptyLine = false;
-            break;
-            }
-        }
-    if (emptyLine)
-        {
-        continue;
-        }*/
-

     pos = line.find_first_of('=');
     pos = line.find_first_of('=');

-    if (pos == string::npos)
+    if (pos == std::string::npos)

         {
         error = -1;
         return;
         }
 
         {
         error = -1;
         return;
         }
 

-    string parameter = line.substr(0, pos);
-    string value = line.substr(pos + 1);
+    std::string parameter = Trim(line.substr(0, pos));
+    std::string value = Trim(line.substr(pos + 1));

     param_val[parameter] = value;
     }
 }
 //---------------------------------------------------------------------------
 CONFIGFILE::~CONFIGFILE()
 {
     param_val[parameter] = value;
     }
 }
 //---------------------------------------------------------------------------
 CONFIGFILE::~CONFIGFILE()
 {

+Flush();

 }
 //---------------------------------------------------------------------------
 }
 //---------------------------------------------------------------------------

-const string & CONFIGFILE::GetFileName() const
+const std::string & CONFIGFILE::GetFileName() const

 {
 return fileName;
 }
 //---------------------------------------------------------------------------
 {
 return fileName;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::Error()
+int CONFIGFILE::Error() const

 {
 int e = error;
 error = 0;
 return e;
 }
 //---------------------------------------------------------------------------
 {
 int e = error;
 error = 0;
 return e;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::Flush()
-{
-ofstream f(fileName.c_str());
-if (!f.is_open())
-    {
-    error = EIO;
-    return EIO;
-    }
-
-map<string, string>::const_iterator it = param_val.begin();
-while (it != param_val.end())
-    {
-    f << it->first << "=" << it->second << endl;
-    it++;
-    }
-
-f.close();
-
-return 0;
-}
-/*//---------------------------------------------------------------------------
-int CONFIGFILE::ReadString(const string & param, char * str, int * maxLen, const char * defaultVal) const
+int CONFIGFILE::ReadString(const std::string & param, std::string * val, const std::string & defaultVal) const

 {
 {

-it = param_val.find(param);
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ
-    strncpy(str, param_val[param].c_str(), *maxLen);
-    *maxLen = param_val[param].size();
-    return 0;
-    }
-
-strncpy(str, defaultVal, *maxLen);
-*maxLen = strlen(defaultVal);
-return -1;
-}*/
-//---------------------------------------------------------------------------
-int CONFIGFILE::ReadString(const string & param, string * val, const string & defaultVal) const
-{
-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
-
-if (it != param_val.end())
-    {
-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     *val = it->second;
     return 0;
     }
     *val = it->second;
     return 0;
     }


@@ -175,23 +151,16 @@ if (it != param_val.end())
 *val = defaultVal;
 return -1;
 }
 *val = defaultVal;
 return -1;
 }

-/*//---------------------------------------------------------------------------
-int CONFIGFILE::WriteString(const string & param, const char * val)
-{
-WriteString(param, string(val));
-return 0;
-}*/

 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------

-int CONFIGFILE::WriteString(const string & param, const string &val)
+void CONFIGFILE::WriteString(const std::string & param, const std::string &val)

 {
 param_val[param] = val;
 {
 param_val[param] = val;

-Flush();
-return 0;
+changed = true;

 }
 //---------------------------------------------------------------------------
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadTime(const string & param, time_t * val, time_t defaultVal) const
+int CONFIGFILE::ReadTime(const std::string & param, time_t * val, time_t defaultVal) const

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {


@@ -209,16 +178,14 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadInt(const string & param, int * val, int defaultVal) const
+int CONFIGFILE::ReadInt(const std::string & param, int * val, int defaultVal) const

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     char *res;
     char *res;

-    *val = strtol(it->second.c_str(), &res, 10);
+    *val = static_cast<int>(strtol(it->second.c_str(), &res, 10));

     if (*res != 0)
         {
         *val = defaultVal; //Error!
     if (*res != 0)
         {
         *val = defaultVal; //Error!


@@ -231,16 +198,14 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadUInt(const string & param, unsigned int * val, unsigned int defaultVal) const
+int CONFIGFILE::ReadUInt(const std::string & param, unsigned int * val, unsigned int defaultVal) const

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     char *res;
     char *res;

-    *val = strtoul(it->second.c_str(), &res, 10);
+    *val = static_cast<unsigned int>(strtoul(it->second.c_str(), &res, 10));

     if (*res != 0)
         {
         *val = defaultVal; //Error!
     if (*res != 0)
         {
         *val = defaultVal; //Error!


@@ -253,14 +218,12 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadLongInt(const string & param, long int * val, long int defaultVal) const
+int CONFIGFILE::ReadLongInt(const std::string & param, long int * val, long int defaultVal) const

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     char *res;
     *val = strtol(it->second.c_str(), &res, 10);
     if (*res != 0)
     char *res;
     *val = strtol(it->second.c_str(), &res, 10);
     if (*res != 0)


@@ -275,14 +238,12 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadULongInt(const string & param, unsigned long int * val, unsigned long int defaultVal) const
+int CONFIGFILE::ReadULongInt(const std::string & param, unsigned long int * val, unsigned long int defaultVal) const

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     char *res;
     *val = strtoul(it->second.c_str(), &res, 10);
     if (*res != 0)
     char *res;
     *val = strtoul(it->second.c_str(), &res, 10);
     if (*res != 0)


@@ -297,14 +258,12 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadLongLongInt(const string & param, int64_t * val, int64_t defaultVal) const
+int CONFIGFILE::ReadLongLongInt(const std::string & param, int64_t * val, int64_t defaultVal) const

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     char *res;
     *val = strtoll(it->second.c_str(), &res, 10);
     if (*res != 0)
     char *res;
     *val = strtoll(it->second.c_str(), &res, 10);
     if (*res != 0)


@@ -319,14 +278,12 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadULongLongInt(const string & param, uint64_t * val, uint64_t defaultVal) const
+int CONFIGFILE::ReadULongLongInt(const std::string & param, uint64_t * val, uint64_t defaultVal) const

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     char *res;
     *val = strtoull(it->second.c_str(), &res, 10);
     if (*res != 0)
     char *res;
     *val = strtoull(it->second.c_str(), &res, 10);
     if (*res != 0)


@@ -341,14 +298,12 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadShortInt(const string & param, short int * val, short int defaultVal) const
+int CONFIGFILE::ReadShortInt(const std::string & param, short int * val, short int defaultVal) const

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     char *res;
     *val = (short)strtol(it->second.c_str(), &res, 10);
     if (*res != 0)
     char *res;
     *val = (short)strtol(it->second.c_str(), &res, 10);
     if (*res != 0)


@@ -363,14 +318,12 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadUShortInt(const string & param, unsigned short int * val, unsigned short int defaultVal) const
+int CONFIGFILE::ReadUShortInt(const std::string & param, unsigned short int * val, unsigned short int defaultVal) const

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     char *res;
     *val = (short)strtoul(it->second.c_str(), &res, 10);
     if (*res != 0)
     char *res;
     *val = (short)strtoul(it->second.c_str(), &res, 10);
     if (*res != 0)


@@ -385,24 +338,28 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::WriteInt(const string & param, int64_t val)
+void CONFIGFILE::WriteInt(const std::string & param, int64_t val)

 {
 {

-string s;
-//sprintf(s, "%lld", val);
-x2str(val, s);
-param_val[param] = s;
-Flush();
-return 0;
+char buf[32];
+snprintf(buf, sizeof(buf), "%lld", static_cast<long long int>(val));
+param_val[param] = buf;
+changed = true;

 }
 //---------------------------------------------------------------------------
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::ReadDouble(const string & param, double * val, double defaultVal) const
+void CONFIGFILE::WriteTime(const std::string & param, time_t val)

 {
 {

-const map<string, string>::const_iterator it(param_val.find(param));
-// îÁÛÌÉ ÎÕÖÎÕÀ ÐÅÒÅÍÅÎÎÕÀ
+std::stringstream ss;
+ss<<val;
+param_val[param] = ss.str();
+changed = true;
+}
+//---------------------------------------------------------------------------
+int CONFIGFILE::ReadDouble(const std::string & param, double * val, double defaultVal) const
+{
+const std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it(param_val.find(param));

 
 if (it != param_val.end())
     {
 
 if (it != param_val.end())
     {

-    // þÔÏ-ÔÏ ÓÔÏÉÔ

     char *res;
     *val = strtod(it->second.c_str(), &res);
     if (*res != 0)
     char *res;
     *val = strtod(it->second.c_str(), &res);
     if (*res != 0)


@@ -417,12 +374,50 @@ if (it != param_val.end())
 return -1;
 }
 //---------------------------------------------------------------------------
 return -1;
 }
 //---------------------------------------------------------------------------

-int CONFIGFILE::WriteDouble(const string & param, double val)
+void CONFIGFILE::WriteDouble(const std::string & param, double val)

 {
 char s[30];
 {
 char s[30];

-sprintf(s, "%f", val);
+snprintf(s, 30, "%f", val);

 param_val[param] = s;
 param_val[param] = s;

-Flush();
+changed = true;
+}
+//---------------------------------------------------------------------------
+int CONFIGFILE::Flush(const std::string & path) const
+{
+std::ofstream f(path.c_str());
+if (!f.is_open())
+    {
+    error = EIO;
+    return EIO;
+    }
+
+std::map<std::string, std::string, StringCaseCmp_t>::const_iterator it = param_val.begin();
+while (it != param_val.end())
+    {
+    f << it->first << "=" << it->second << "\n";
+    ++it;
+    }
+
+f.close();
+return 0;
+}
+//---------------------------------------------------------------------------
+int CONFIGFILE::Flush() const
+{
+if (!changed)
+    return 0;
+
+char pid[6];
+snprintf(pid, sizeof(pid), "%d", getpid());
+
+if (Flush(fileName + "." + pid))
+    return -1;
+
+if (rename((fileName + "." + pid).c_str(), fileName.c_str()))
+    return -1;
+
+changed = false;
+

 return 0;
 }
 //---------------------------------------------------------------------------
 return 0;
 }
 //---------------------------------------------------------------------------