iniReader.h

Go to the documentation of this file.

 
// Copyright (c) 2013-2015 OpenM++
// This code is licensed under the MIT license (see LICENSE.txt for details)
 
#ifndef OM_INI_READER_H
#define OM_INI_READER_H
 
#include "omFile.h"
 
using namespace std;
 
namespace openm
{
    struct IniEntry
    {
        string section;
 
        string key;
 
        string val;
 
        IniEntry(const string & i_section, const string & i_key, const string & i_value);
 
        bool bySectionKey(const char * i_sectionKey) const;
 
        bool equalTo(const char * i_section, const char * i_key) const;
 
    private:
        // set key name: remove = if present, unquote and trim
        void setKey(const string & i_key);
 
        // set value: trim space and remove "quotes" or 'apostrophes'
        void setValue(const string & i_value);
    };
 
    class IniFileReader
    {
        typedef vector<IniEntry> IniEntryVec;
 
    public:
        IniFileReader(const char * i_filePath, const char * i_codePageName = nullptr);
 
        bool isLoaded(void) const noexcept { return is_loaded; }
 
        bool isExist(const char * i_section, const char * i_key) const noexcept;
 
        bool isExist(const char * i_sectionKey) const noexcept;
 
        const string strValue(const char * i_section, const char * i_key, const string & i_default = "") const noexcept;
 
        const string strValue(const char * i_sectionKey, const string & i_default = "") const noexcept;
 
        const IniEntryVec & rowsCRef(void) const { return entryVec; }
 
        const NoCaseSet sectionSet(void) const noexcept;
 
        const NoCaseMap getSection(const char * i_section) const noexcept;
 
        static void loadMessages(const char * i_iniMsgPath, const string & i_language = "", const char * i_codePageName = nullptr) noexcept;
 
        static list<pair<string, unordered_map<string, string>>> loadAllMessages(const char * i_iniMsgPath, const char * i_codePageName = nullptr) noexcept;
 
    private:
        bool is_loaded;         // if true then ini-file loaded OK else error
        IniEntryVec entryVec;   // ini-file entries: (section, key, value)
 
        static const IniEntryVec load(const char * i_filePath, bool is_noCase, const char * i_codePageName);
 
        // find index of section and key or -1 if not found
        ptrdiff_t findIndex(const char * i_section, const char * i_key) const;
 
        // find index of section.key or -1 if not found
        ptrdiff_t findIndex(const char * i_sectionKey) const;
 
        // insert new or update existing ini-file entry:
        //  unquote key and value if "quoted" or 'single quoted'
        //  return false on error: if section or key is empty
        static bool addIniEntry(
            bool is_noCase, const string & i_src, int i_nLine, const string & i_section, const string & i_key, const string & i_value, IniEntryVec & o_entryVec
        );
    };
}
 
#endif  // OM_INI_READER_H