Changeset 6503 for trunk/licq

Timestamp:

09/06/08 03:25:28 (3 months ago)

Author:

flynd

Message:

Added ReadNum/WriteNum? functions for int and unsigned int since long is 64 bits on 64 bit systems. Since time_t is declared as int on some systems (at least in BSD) this caused crashes when calling ReadNum?.
ReadNum/WriteNum? for unsigned long are left to keep existing code working for now but since we probably don't need to save any 64 bit values they are marked as deprecated.

Location:

trunk/licq

Files:

• include/licq_file.h (modified) (2 diffs)
• src/file.cpp (modified) (9 diffs)

trunk/licq/include/licq_file.h

@@ -1 +1 @@
 #ifndef INIFILE_H
 #define INIFILE_H
+
+#include <string>
+
+// Define for marking functions as deprecated
+#ifndef LICQ_DEPRECATED
+# if defined(__GNUC__) && !defined(__INTEL_COMPILER) && (__GNUC__ - 0 > 3 || (__GNUC__ - 0 == 3 && __GNUC_MINOR__ - 0 >= 2))
+#  define LICQ_DEPRECATED __attribute__ ((__deprecated__))
+# elif defined(_MSC_VER) && (_MSC_VER >= 1300)
+#  define LICQ_DEPRECATED __declspec(deprecated)
+# else
+#  define LICQ_DEPRECATED
+# endif
+#endif
 
 #define MAX_SECTIONxNAME_LEN 160
@@ -46 +59 @@
   bool SetSection(const char *_szSectionName);
   bool CreateSection(const char *_szSectionName);
-  bool ReadStr(const char *_szKey, char *_szData, const char *_szDefault = NULL, bool bTrim = true, int _nMax = 0);
-  bool ReadNum(const char *_szKey, unsigned long &data, const unsigned long _nDefault = 0);
-  bool ReadNum(const char *_szKey, unsigned short &data, const unsigned short _nDefault = 0);
-  bool ReadNum(const char *_szKey, signed short &data, const signed short _nDefault = 0);
-  bool ReadNum(const char *_szKey, char &data, const char _nDefault = 0);
-  bool ReadBool(const char *_szKey, bool &data, const bool _bDefault = false);
+  bool ReadStr(const std::string& Key, char* data, const char* defValue = NULL, bool trim = true, int maxLength = 0);
+  bool ReadNum(const std::string& key, unsigned int &data, unsigned int defValue = 0);
+  bool ReadNum(const std::string& key, signed int &data, signed int defValue = 0);
+  bool ReadNum(const std::string& key, unsigned short &data, unsigned short defValue = 0);
+  bool ReadNum(const std::string& key, signed short &data, signed short defValue = 0);
+  bool ReadNum(const std::string& key, char &data, char defValue = 0);
+  bool ReadBool(const std::string& key, bool &data, const bool defValue = false);
 
-  bool WriteStr(const char *_szKey, const char *_szData);
-  bool WriteNum(const char *_szKey, const unsigned long _szData);
-  bool WriteNum(const char *_szKey, const unsigned short _szData);
-  bool WriteNum(const char *_szKey, const signed short _szData);
-  bool WriteNum(const char *_szKey, const char _szData);
-  bool WriteBool(const char *_szKey, const bool _szData);
+  bool WriteStr(const std::string& key, const char* data);
+  bool WriteNum(const std::string& key, unsigned int data);
+  bool WriteNum(const std::string& key, signed int data);
+  bool WriteNum(const std::string& key, unsigned short data);
+  bool WriteNum(const std::string& key, signed short data);
+  bool WriteNum(const std::string& key, char data);
+  bool WriteBool(const std::string& key, bool data);
 
   int Error()  { return (m_nError); }
   const char *FileName()  { return m_szFilename; }
+
+  // Long differs in size between 32 bit systems and 64 bit systems so int
+  // should be used instead. This function is kept to keep old code working but
+  // since it is unlikely that we need to save any 64 bit integers these
+  // function is declared as deprecated.
+  LICQ_DEPRECATED bool ReadNum(const std::string& key, unsigned long &data, unsigned long defValue = 0);
+  LICQ_DEPRECATED bool WriteNum(const std::string& key, unsigned long data);
 
 protected:

trunk/licq/src/file.cpp

@@ -32 +32 @@
 #include "licq_log.h"
 
+using namespace std;
 
 //=====Pre class helper functions==============================================
@@ -657 +658 @@
 /*! \brief Finds a key and sets the data.  Returns false if the key does not exist.
  */
-bool CIniFile::ReadStr(const char *szKey, char *szData,
+bool CIniFile::ReadStr(const string& key, char *szData,
                        const char *szDefault, bool bTrim, int _nMax)
 {
@@ -670 +671 @@
     if (sz == NULL)
     {
-       if (szLine == NULL) Warn(INI_ExNOKEY, szKey);
+      if (szLine == NULL)
+        Warn(INI_ExNOKEY, key.c_str());
        if (szDefault != NULL) strcpy(szData, szDefault);
        return (false);
     }
   }
-  while (strcmp(sz, szKey) != 0);
+  while (sz != key);
 
   if ((sz = GetDataFromLine(szData, szLine, bTrim, _nMax)) == NULL)
@@ -692 +694 @@
  * exist.
  */
-bool CIniFile::ReadNum(const char *_szKey, unsigned long &data,
-                       const unsigned long _nDefault)
-{
-  char szData[MAX_LINE_LEN];
-  if (!ReadStr(_szKey, szData, NULL))
-  {
-    data = _nDefault;
-    return (false);
-  }
-
-  //can't use atol because it truncates numbers over 0x7FFFFFFF
-  data = strtoul(szData, (char **)NULL, 10);
-  return(true);
-}
-
-bool CIniFile::ReadNum(const char *_szKey, unsigned short &data,
-                       const unsigned short _nDefault)
-{
-  char szData[MAX_LINE_LEN];
-  if (!ReadStr(_szKey, szData, NULL))
-  {
-    data = _nDefault;
-    return (false);
-  }
-
-  data = (unsigned short)atoi(szData);
-  return(true);
-}
-
-
-bool CIniFile::ReadNum(const char *_szKey, char &data, const char _nDefault)
-{
-  char szData[MAX_LINE_LEN];
-  if (!ReadStr(_szKey, szData, NULL))
-  {
-    data = _nDefault;
-    return (false);
-  }
-
-  data = (char)atoi(szData);
-  return(true);
-}
-
-bool CIniFile::ReadNum(const char *_szKey, signed short &data,
-                       const signed short _nDefault)
-{
-  char szData[MAX_LINE_LEN];
-  if (!ReadStr(_szKey, szData, NULL))
-  {
-    data = _nDefault;
-    return (false);
-  }
-
-  data = (signed short)atoi(szData);
-  return(true);
-}
-
+
+#define MAKE_READNUM(valueType, convertion) \
+    bool CIniFile::ReadNum(const string& key, valueType &data, valueType defValue) \
+    { \
+      char strData[MAX_LINE_LEN]; \
+      if (!ReadStr(key, strData, NULL)) \
+      { \
+        data = defValue; \
+        return false; \
+      } \
+      data = convertion; \
+      return true; \
+    }
+
+MAKE_READNUM(unsigned long, strtoul(strData, (char**)NULL, 10))
+MAKE_READNUM(unsigned int, strtoul(strData, (char**)NULL, 10))
+MAKE_READNUM(signed int, atoi(strData))
+MAKE_READNUM(unsigned short, (unsigned short)atoi(strData))
+MAKE_READNUM(signed short, (signed short)atoi(strData))
+MAKE_READNUM(char, (char)atoi(strData))
 
 //-----ReadBool----------------------------------------------------------------
@@ -756 +721 @@
  * mean true.  Returns false if the key does not exist.
  */
-bool CIniFile::ReadBool(const char *_szKey, bool &data, const bool _bDefault)
+bool CIniFile::ReadBool(const string& key, bool &data, const bool _bDefault)
 {
   char szData[MAX_LINE_LEN];
-  if (!ReadStr(_szKey, szData, NULL))
+  if (!ReadStr(key, szData, NULL))
   {
     data = _bDefault;
@@ -835 +800 @@
  * key at the end of the current section.  Always returns true.
  */
-bool CIniFile::WriteStr(const char *_szKey, const char *_szData)
+bool CIniFile::WriteStr(const string& key, const char *_szData)
 {
   char *sz, *szLine, szLineBuffer[MAX_LINE_LEN], szKeyBuffer[MAX_KEYxNAME_LEN];
@@ -849 +814 @@
     sz = GetKeyFromLine(szKeyBuffer, szLine);
   }
-  while (sz != NULL && strcmp(sz, _szKey) != 0);
+  while (sz != NULL && sz != key);
   int nCutEnd = m_nBufPos;
 
@@ -858 +823 @@
   {
     gLog.Warn("%sInternal Error: CIniFile::WriteStr(%s, NULL).\n",
-              L_WARNxSTR, _szKey);
+        L_WARNxSTR, key.c_str());
     strcpy(szDataNoNL, "");
   }
-  snprintf(szNewLine, MAX_LINE_LEN, "%s = %s\n", _szKey, szDataNoNL);
+  snprintf(szNewLine, MAX_LINE_LEN, "%s = %s\n", key.c_str(), szDataNoNL);
   szNewLine[MAX_LINE_LEN - 1] = '\0';
   // Don't lose the following key if szNewLine was truncated by snprintf
@@ -875 +840 @@
 }
 
-
-bool CIniFile::WriteNum(const char *_szKey, const unsigned short _nData)
-{
-   char szN[32];
-   snprintf(szN, 32, "%u", _nData);
-   szN[31] = '\0';
-   return(WriteStr(_szKey, szN));
-}
-
-bool CIniFile::WriteNum(const char *_szKey, const unsigned long _nData)
-{
-   char szN[32];
-   snprintf(szN, 32, "%lu", _nData);
-   szN[31] = '\0';
-   return(WriteStr(_szKey, szN));
-}
-
-bool CIniFile::WriteNum(const char *_szKey, const signed short _nData)
-{
-  char szN[32];
-  snprintf(szN, 32, "%d", _nData);
-  szN[31] = '\0';
-  return(WriteStr(_szKey, szN));
-}
-
-bool CIniFile::WriteNum(const char *_szKey, const char _nData)
-{
-  char szN[32];
-  snprintf(szN, 32, "%d", _nData);
-  szN[31] = '\0';
-  return(WriteStr(_szKey, szN));
-}
-
-bool CIniFile::WriteBool(const char *_szKey, const bool _nData)
-{
-   return(WriteStr(_szKey, _nData ? "1" : "0"));
-}
-
+#define MAKE_WRITENUM(valueType, convertion) \
+    bool CIniFile::WriteNum(const string& key, valueType data) \
+    { \
+      char strData[32]; \
+      snprintf(strData, sizeof(strData), convertion, data); \
+      return WriteStr(key, strData); \
+    }
+
+MAKE_WRITENUM(unsigned long, "%lu")
+MAKE_WRITENUM(unsigned int, "%u")
+MAKE_WRITENUM(signed int, "%i")
+MAKE_WRITENUM(unsigned short, "%i")
+MAKE_WRITENUM(signed short, "%i")
+MAKE_WRITENUM(char, "%i")
+
+bool CIniFile::WriteBool(const string& key, bool data)
+{
+   return(WriteStr(key, data ? "1" : "0"));
+}
+