iniparser.h

#ifndef unt_INICover_stlH
#define unt_INICover_stlH
//===========================================================================
// ============================================================================================ //
// ============================================================================================ //

//========================================================================
// A. ДОПОЛНИТЕЛЬНЫЕ ПОДКЛЮЧЕНИЯ (Типы и модули, необходимые для .h - файла)
//------------------------------------------------------------------------
#include "global_definitions.h"
#include "libtools.h"
#include "anymap.h"

#include <string>
#include <fstream>
#include <list>
#include <set>
#include <map>
//========================================================================
namespace com
{
    namespace ini
    {
        enum INIParamType
        {
            ptString, 
            ptArray, 
            ptTwoDimList, 
            ptSet, 
            ptCheck, 
            ptFile, 
            ptTree, 
            ptRange, 
            ptUnitValue, 
            ptDBTableValue, 
            ptSubParam, 
        };

        enum enu_LoadMode
        {
            lmDefault,  
            lmRecursive 
        };
        
    //режим парсинга параметров
        enum enu_ReadMode
        {
            rmDefault, 
            rmRecursive
        };

        struct MAC_DLLEXPORT INIRange
        {
            double mCur; 
            double mStep; 
            double mMin; 
            double mMax; 
        };

        struct ParamAddress
        {
            ParamAddress(const std::string& p_section, const std::string& p_paramName)
                : mParamName(p_paramName)
                , mSection(p_section)
            {}

            std::string mSection; 
            std::string mParamName; 
        };

        std::string MAC_DLLEXPORT makeSubParam(const std::string& p_param, const std::string& p_subparam);

        class MAC_DLLEXPORT INIParser
        {
            // Cтруктура для хранения данных по одному узлу дерева
            struct INITreeNode
            {
                INITreeNode(const std::map< std::string, std::string >& p_node)
                    : mNodeData(p_node)
                {}

                std::map< std::string, std::string > mNodeData;
                };

            struct ParamContent
            {
                std::string mParamValue;
                std::string mParamDescr;
            };

            // Структура для хранения параметров в списке
            struct stc_ParamLines
            {
                stc_ParamLines(const std::string& p_paramName, const ParamContent& p_paramContent)
                    : mParamName(p_paramName)
                    , mParamContent(p_paramContent)
                {}

                std::string mParamName;
                ParamContent mParamContent;
            };

            typedef std::list< stc_ParamLines > tdf_ParamLinesList;

            // Представление строки типа "Param=Value//Description" в парсере
            //          ParamName   ParamContent
            typedef std::map< std::string, ParamContent >  tdf_ParamLinesMap;

            struct stc_Section
            {
                tdf_ParamLinesMap mParamLines;
                std::string mComment;
                tdf_ParamLinesList mParamLinesList;
                int mPos;
            };

            // Представление INI-файла в парсере
            //           Section    Data
            typedef std::map< std::string, stc_Section > INIView;

        public:
            enum ErrorCode
            {
                ecSuccessful, 
                ecFileNotFound, 
                ecFileCannotBeOpened, 
                ecInvalidString, 
                ecSectionNotFound, 
                ecParameterNotFound, 
                ecParameterIndexNotFound, 
                ecIncorrectParameterType, 
                ecValueParsingError, 
                ecBadListConversion, 
                ecBadTwoDimDoubleListConversion, 
                ecBadStrDoubleMapConversion, 
                ecBadStrStrMapConversion, 
                ecBadSetConversion, 
                ecBadSaving, 
                ecUnknownError 
            };

            INIParser(const std::string& p_projectOrFileName, const std::string& p_hostPath);
            INIParser(const std::string& p_projectOrFileName);
            ~INIParser();

            bool isLoaded();

            std::string getCurrentINIFilename() const;

            std::string getDefaultINIFilename() const;

            void setINIFilename(const std::string& p_INIFilename);

            void setDefaultINIFilename();

            ErrorCode save();

            com::ini::INIParamType getParamType(const std::string& p_section, const std::string& p_paramName) const;

            ErrorCode getScriptFromFile(const std::string& p_section,
                                            std::list< std::string >& o_script,
                                            bool p_removeSubcomments = true ) const;

            void getSections(std::vector< std::string >& o_sections) const;

            ErrorCode getParamNamesList(const std::string& p_section, std::list< std::string >& o_paramNames);

            bool sectionExists(const std::string& p_section) const;

            ErrorCode getParamDescription(const std::string& p_section,
                                              const std::string& p_paramName,
                                              std::string& o_paramDescr);

            ErrorCode getSectionDescription(const std::string& p_section, std::string& o_sectionDescr);

            ErrorCode setOptionValueInFile(const std::string& p_section,
                                               const std::string& p_paramName,
                                               const std::string& p_newValue);

            int getIntOptionValue(const std::string& p_section,
                                  const std::string& p_paramName,
                                  ErrorCode* o_error = NULL) const;

            std::string getStrOptionValueRecursive(const std::string& p_section,
                                                   const std::string& p_paramName,
                                                   enu_ReadMode rm,
                                                   ErrorCode* o_error) const;

            std::string getStrOptionValue(const std::string& p_section,
                                          const std::string& p_paramName,
                                          ErrorCode* o_error = NULL) const;

            double getFloatOptionValue(const std::string& p_section,
                                       const std::string& p_paramName,
                                       ErrorCode* o_error = NULL) const;

            ErrorCode getDoubleArrayOptionValue(const std::string& p_section,
                                                    const std::string& p_paramName,
                                                    std::vector< double >& o_array) const;

            ErrorCode getStrArrayOptionValue(const std::string& p_section,
                                                 const std::string& p_paramName,
                                                 std::vector< std::string >& o_array) const;

            ErrorCode getTwoDimensionalArray(const std::string& p_section,
                                             const std::string& p_paramName,
                                             std::vector< std::vector<double> >& o_list,
                                             double& o_currentValue,
                                             std::vector<std::string>& o_units) const;

            ErrorCode getTreeNodes(const std::string& p_section,
                                       const std::string& p_paramName,
                                       std::list< std::string >& o_nodesSids,
                                       std::map< std::string, std::map< std::string, std::string > >& o_nodesData,
                                       std::set< std::string >& o_nodesDataFields) const;

            ErrorCode getFileParamData(const std::string& p_section,
                                const std::string& p_paramName,
                                std::string& o_filename) const;

            ErrorCode getRangeValue(const std::string& p_section, const std::string& p_paramName, com::ini::INIRange& o_range) const;

            bool getCheckValue(const std::string& p_section,
                               const std::string& p_paramName,
                               INIParser::ErrorCode* o_error = NULL) const;

            ErrorCode getSetValue(const std::string& p_section,
                                      const std::string& p_paramName,
                                      std::string& o_currentValue,
                                      std::list< std::string >& o_valueList) const;

            ErrorCode getCurrentSetValue(const std::string& p_section,
                                             const std::string& p_paramName,
                                             std::string& o_currentValue) const;

            ErrorCode getUnitValue(const std::string& p_section,
                                       const std::string& p_paramName,
                                       std::string& o_value,
                                       std::string& o_unit) const;

            ErrorCode getDBTableValue(const std::string& p_section,
                                const std::string& p_paramName,
                                std::string& o_defaultValue,
                                std::string& o_sourceTable) const;

            INIParser::ErrorCode splitParamLine(const std::string&  p_section,
                                                int p_paramIndex,
                                                std::string& o_paramName,
                                                std::string& o_paramValue,
                                                std::string& o_paramDescription) const;

            void loadINIDataToAnyMap(Anymap& o_anyMapData,
                                     const std::vector<std::string>& extNames,
                                     enu_LoadMode loadMode = lmDefault);

            std::vector< com::ini::ParamAddress > getParNamesByType(com::ini::INIParamType p_type) const;

        private:
            void loadSectionParamsToAnyMap(Anymap& o_sectionContentAnyMap,
                                           std::vector< std::string >::iterator p_sectionsIt,
                                           enu_LoadMode loadMode,
                                           const std::vector<std::string>& extNames);

            void loadParamToAnyMap(Anymap& o_AnyMap,
                                   const std::string &sectionName,
                                   const std::string &paramName,
                                   enu_LoadMode loadMode,
                                   const std::vector<std::string>& extNames);

        private:
            int initParser(const std::string& p_projectOrFileName, const std::string& p_hostPath);
            int initParser(const std::string& p_projectOrFileName);
            ErrorCode loadINIFile();
            void convertDecimalSeparator( std::string& p_value) const;
            std::string removeSubComment( const std::string& p_source );
            ErrorCode splitRawParamLine( const std::string& p_paramLine, ParamContent& o_paramContent, std::string& o_paramName) const;
            ErrorCode getParamContent(const std::string& p_section, const std::string& p_paramName, ParamContent& o_paramContent) const;
            std::string cutOffUnit( const std::string& p_unitValue ) const;

        private: // устаревшие функции
            // Возвращает логическое значение true|false в зависимости от файла (0|1)
            bool getBoolOptionValue(const std::string& pSection, const std::string& pParamName, ErrorCode* o_error = NULL) const;

            // Возвращает список строк
            ErrorCode getStrListValue(const std::string& pSection,
                                          const std::string& pParamName,
                                          std::list< std::string >& oList,
                                          char pLeftBracket = '{',
                                          char pRightBracket = '}',
                                          char pDelim = ',') const;

        private:
        //    std::string mDefaultINIFilename; // имя INI файла по умолчанию (т.е. то, которое было задано в конструкторе)
            std::string mINIFilename; // имя INI файла, который сейчас парсится
            INIView* mINIView; // INI-Представление файла в парсере. Здесь храняться только секции и соответствующие
                                                        // им линии параметров (Param=Value//Comment)
            std::map< int, std::string >* mRawStrings; // Здесь хранятся строки, не имеющие практического значения для INI-представления
                                                  // (переводы строк, построчные комментарии), но необходимые для сохранения файла
                                                  // после изменений в INI-представлении ключ - номер строки в исходном файле.
            bool misINIViewModified; // флаг указывает, что список был модифицирован
            bool mIsLoaded;
        };
    }
}

//===========================================================================
#endif
//===========================================================================