feat: improve portability

Signed-off-by: PDLdeLange <[email protected]>

Fix for #88.

Description:
- removed 'using namespace std'
- introduced casbin namespace

Author: PDLdeLange

casbin/config/config.cpp

@@ -30,28 +30,30 @@
 #include "../exception/illegal_argument_exception.h"
 #include "../util/util.h"
 
-const string Config::DEFAULT_SECTION = "default";
-const string Config::DEFAULT_COMMENT = "#";
-const string Config::DEFAULT_COMMENT_SEM = ";";
-mutex Config::mtx_lock;
+namespace casbin {
+
+const std::string Config::DEFAULT_SECTION = "default";
+const std::string Config::DEFAULT_COMMENT = "#";
+const std::string Config::DEFAULT_COMMENT_SEM = ";";
+std::mutex Config::mtx_lock;
 
 /**
  * addConfig adds a new section->key:value to the configuration.
  */
-bool Config :: AddConfig(string section, string option, string value) {
+bool Config :: AddConfig(std::string section, std::string option, std::string value) {
     if (!section.compare(""))
         section = DEFAULT_SECTION;
     bool ok = data[section].find(option) != data[section].end();
     data[section][option] = value;
     return !ok;
 }
 
-void Config :: Parse(string f_name) {
+void Config :: Parse(std::string f_name) {
     mtx_lock.lock();
-    ifstream infile;
+    std::ifstream infile;
     try {
         infile.open(f_name);
-    } catch (const ifstream::failure e) {
+    } catch (const std::ifstream::failure e) {
         mtx_lock.unlock();
         throw IOException("Cannot open file.");
     }
@@ -60,10 +62,10 @@ void Config :: Parse(string f_name) {
     infile.close();
 }
 
-void Config :: ParseBuffer(istream* buf){
-    string section = "";
+void Config ::ParseBuffer(std::istream * buf) {
+    std::string section = "";
     int line_num = 0;
-    string line;
+    std::string line;
     while (true) {
         line_num++;
         if (getline(*buf, line, '\n')){
@@ -77,17 +79,17 @@ void Config :: ParseBuffer(istream* buf){
             continue;
         else if (line.find(DEFAULT_COMMENT_SEM)==0)
             continue;
-        else if (line.find("[")==0 && EndsWith(line, string("]")))
+        else if (line.find("[")==0 && EndsWith(line, std::string("]")))
             section = line.substr(1, line.length() - 2);
         else {
-            vector<string> option_val = Split(line, string("="), 2);
+            std::vector<std::string> option_val = Split(line, std::string("="), 2);
             if (option_val.size() != 2) {
                 char* error = new char;
                 sprintf(error, "parse the content error : line %d , %s = ? ", line_num, option_val[0].c_str());
-                throw IllegalArgumentException(string(error));
+                throw IllegalArgumentException(std::string(error));
             }
-            string option = Trim(option_val[0]);
-            string value = Trim(option_val[1]);
+            std::string option = Trim(option_val[0]);
+            std::string value = Trim(option_val[1]);
             AddConfig(section, option, value);
         }
     }
@@ -99,8 +101,8 @@ void Config :: ParseBuffer(istream* buf){
  * @param confName the path of the model file.
  * @return the constructor of Config.
  */
-shared_ptr<Config> Config :: NewConfig(string conf_name) {
-    shared_ptr<Config> c(new Config);
+std::shared_ptr<Config> Config :: NewConfig(std::string conf_name) {
+    std::shared_ptr<Config> c(new Config);
     c->Parse(conf_name);
     return c;
 }
@@ -111,50 +113,50 @@ shared_ptr<Config> Config :: NewConfig(string conf_name) {
  * @param text the model text.
  * @return the constructor of Config.
  */
-shared_ptr<Config> Config :: NewConfigFromText(string text) {
-    shared_ptr<Config> c(new Config);
-    stringstream stream(text);
+std::shared_ptr<Config> Config :: NewConfigFromText(std::string text) {
+    std::shared_ptr<Config> c(new Config);
+    std::stringstream stream(text);
     c->ParseBuffer(&stream);
     return c;
 }
 
-bool Config :: GetBool(string key) {
+bool Config :: GetBool(std::string key) {
     return Get(key).compare("true")==0;
 }
 
-int Config :: GetInt(string key) {
+int Config :: GetInt(std::string key) {
     return atoi(Get(key).c_str());
 }
 
-float Config :: GetFloat(string key) {
+float Config :: GetFloat(std::string key) {
     return float(atof(Get(key).c_str()));
 }
 
-string Config :: GetString(string key) {
+std::string Config :: GetString(std::string key) {
     return Get(key);
 }
 
-vector<string> Config :: GetStrings(string key) {
-    string v = Get(key);
+std::vector<std::string> Config :: GetStrings(std::string key) {
+    std::string v = Get(key);
     if (!v.compare("")) {
-        vector<string> empty;
+        std::vector<std::string> empty;
         return empty;
     }
-    return Split(v,string(","));
+    return Split(v,std::string(","));
 }
 
-void Config :: Set(string key, string value) {
+void Config :: Set(std::string key, std::string value) {
     mtx_lock.lock();
     if (key.length() == 0) {
         mtx_lock.unlock();
         throw IllegalArgumentException("key is empty");
     }
 
-    string section = "";
-    string option;
+    std::string section = "";
+    std::string option;
 
     transform(key.begin(), key.end(), key.begin(), ::tolower);
-    vector<string> keys = Split(key, string("::"));
+    std::vector<std::string> keys = Split(key, std::string("::"));
     if (keys.size() >= 2) {
         section = keys[0];
         option = keys[1];
@@ -166,11 +168,11 @@ void Config :: Set(string key, string value) {
     mtx_lock.unlock();
 }
 
-string Config :: Get(string key) {
-    string section;
-    string option;
+std::string Config :: Get(std::string key) {
+    std::string section;
+    std::string option;
     transform(key.begin(), key.end(), key.begin(), ::tolower);
-    vector<string> keys = Split(key, string("::"));
+    std::vector<std::string> keys = Split(key, std::string("::"));
     if (keys.size() >= 2) {
         section = keys[0];
         option = keys[1];
@@ -184,4 +186,6 @@ string Config :: Get(string key) {
     return "";
 }
 
+} // namespace casbin
+
 #endif // CONFIG_CPP

casbin/config/config.h

@@ -23,26 +23,26 @@
 
 #include "./config_interface.h"
 
-using namespace std;
+namespace casbin {
 
 class Config : public ConfigInterface {
     private:
 
-        static const string DEFAULT_SECTION;
-        static const string DEFAULT_COMMENT;
-        static const string DEFAULT_COMMENT_SEM;
-        static mutex mtx_lock;
+        static const std::string DEFAULT_SECTION;
+        static const std::string DEFAULT_COMMENT;
+        static const std::string DEFAULT_COMMENT_SEM;
+        static std::mutex mtx_lock;
 
-        unordered_map<string, unordered_map<string, string>> data;
+        std::unordered_map<std::string, std::unordered_map<std::string, std::string>> data;
 
         /**
          * addConfig adds a new section->key:value to the configuration.
          */
-        bool AddConfig(string section, string option, string value);
+        bool AddConfig(std::string section, std::string option, std::string value);
 
-        void Parse(string f_name);
+        void Parse(std::string f_name);
 
-        void ParseBuffer(istream* buf);
+        void ParseBuffer(std::istream* buf);
 
     public:
 
@@ -52,29 +52,31 @@ class Config : public ConfigInterface {
          * @param confName the path of the model file.
          * @return the constructor of Config.
          */
-        static shared_ptr<Config> NewConfig(string conf_name);
+        static std::shared_ptr<Config> NewConfig(std::string conf_name);
 
         /**
          * newConfigFromText create an empty configuration representation from text.
          *
          * @param text the model text.
          * @return the constructor of Config.
          */
-        static shared_ptr<Config> NewConfigFromText(string text);
+        static std::shared_ptr<Config> NewConfigFromText(std::string text);
 
-        bool GetBool(string key);
+        bool GetBool(std::string key);
 
-        int GetInt(string key);
+        int GetInt(std::string key);
 
-        float GetFloat(string key);
+        float GetFloat(std::string key);
 
-        string GetString(string key);
+        std::string GetString(std::string key);
 
-        vector<string> GetStrings(string key);
+        std::vector<std::string> GetStrings(std::string key);
 
-        void Set(string key, string value);
+        void Set(std::string key, std::string value);
 
-        string Get(string key);
+        std::string Get(std::string key);
 };
 
+} // namespace casbin
+
 #endif

casbin/config/config_interface.h

@@ -20,18 +20,20 @@
 #include <string>
 #include <vector>
 
-using namespace std;
+namespace casbin {
 
 class ConfigInterface {
     public:
 
-        virtual string GetString(string key) = 0;
-        virtual vector <string> GetStrings(string key) = 0;
-        virtual bool GetBool(string key) = 0;
-        virtual int GetInt(string key) = 0;
-        virtual float GetFloat(string key) = 0;
-        virtual void Set(string key, string value) = 0;
+        virtual std::string GetString(std::string key) = 0;
+        virtual std::vector<std::string> GetStrings(std::string key) = 0;
+        virtual bool GetBool(std::string key) = 0;
+        virtual int GetInt(std::string key) = 0;
+        virtual float GetFloat(std::string key) = 0;
+        virtual void Set(std::string key, std::string value) = 0;
 
 };
 
+} // namespace casbin
+
 #endif

casbin/effect/default_effector.cpp

@@ -23,10 +23,12 @@
 #include "./default_effector.h"
 #include "../exception/unsupported_operation_exception.h"
 
+namespace casbin {
+
 /**
  * MergeEffects merges all matching results collected by the enforcer into a single decision.
  */
-bool DefaultEffector :: MergeEffects(string expr, vector<Effect> effects, vector<float> results) {
+bool DefaultEffector :: MergeEffects(std::string expr, std::vector<Effect> effects, std::vector<float> results) {
     bool result;
 
     if (!expr.compare("some(where (p.eft == allow))")) {
@@ -74,4 +76,6 @@ bool DefaultEffector :: MergeEffects(string expr, vector<Effect> effects, vector
     return result;
 }
 
+} // namespace casbin
+
 #endif // DEFAULT_EFFECTOR_CPP

casbin/effect/default_effector.h

@@ -19,6 +19,8 @@
 
 #include "effector.h"
 
+namespace casbin {
+
 /**
  * DefaultEffector is default effector for Casbin.
  */
@@ -28,7 +30,9 @@ class DefaultEffector : public Effector{
         /**
          * MergeEffects merges all matching results collected by the enforcer into a single decision.
          */
-        bool MergeEffects(string expr, vector<Effect> effects, vector<float> results);
+        bool MergeEffects(std::string expr, std::vector<Effect> effects, std::vector<float> results);
 };
 
+} // namespace casbin
+
 #endif

casbin/effect/effect.h

@@ -17,10 +17,14 @@
 #ifndef CASBIN_CPP_EFFECT_EFFECT
 #define CASBIN_CPP_EFFECT_EFFECT
 
+namespace casbin {
+
 enum class Effect{
     Allow, Indeterminate, Deny
 };
 
 typedef enum Effect Effect;
 
+} // namespace casbin
+
 #endif

casbin/effect/effector.h

@@ -22,7 +22,7 @@
 
 #include "effect.h"
 
-using namespace std;
+namespace casbin {
 
 /**
  * Effector is the abstract class for Casbin effectors.
@@ -37,7 +37,9 @@ class Effector{
          * @param results the matcher results of all matched rules.
          * @return the final effect.
          */
-        virtual bool MergeEffects(string expr, vector<Effect> effects, vector<float> results) = 0;
+        virtual bool MergeEffects(std::string expr, std::vector<Effect> effects, std::vector<float> results) = 0;
 };
 
+} // namespace casbin
+
 #endif