INIReader.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
Licensee a limited, non-exclusive, non-transferable, royalty-free license
(without the right to sublicense) to use the API solely for the purpose of
Licensee's internal development efforts to develop applications for which
the API was provided.
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: INIReader
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/String.h>
#include <NDEVR/ProgressInfo.h>
#include <NDEVR/Resource.h>
#include <NDEVR/Scanner.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/Dictionary.h>
#include <NDEVR/Matrix.h>
#include <stdio.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A class used with INIFactory to store a reference to an object in the program that can be
        inherited to provide read and write functionality to the factory.
    **/
    class NDEVR_BASE_API INIOption
    {
    public:
        explicit INIOption();
        virtual ~INIOption() {}
        virtual void readOptionAscii(String option) = 0;
        virtual void readOptionAscii(Scanner& option) = 0;
        virtual String writeOptionAscii() const = 0;
        virtual void writeOptionBinary(FILE* stream) const = 0;
        virtual void readOptionBinary(const char* bytes) = 0;
        virtual INIOption* copy() const = 0;
    };
    /**----------------------------------------------------------------------------
    \brief Contains methods for easily reading and writing to an INI file including
        efficient casting, callback, and variable storage methods.
 
    addOption functions take a REFERENCE to an object and will modify that reference
        when option is read in.
    ----------------------------------------------------------------------------*/
    class NDEVR_BASE_API INIFactory
    {
    public:
        INIFactory();
        INIFactory(const INIFactory& reader) = delete;
        INIFactory(INIFactory&& reader) noexcept;
        virtual ~INIFactory();
        void addINIOption(const String& label, INIOption* option);
        template<uint01 t_dims, class t_type>
        void addOption(const String& label, Resource<Vector<t_dims, t_type>>& mem_loc)
        {
            addINIOption(label, new INIObject<Vector<t_dims, t_type>>(mem_loc));
        }
 
        template<uint01 t_dims, class t_type>
        void addOption(const String& label, Vector<t_dims, t_type>& mem_loc)
        {
            addINIOption(label, new INIObject<Vector<t_dims, t_type>>(mem_loc));
        }
 
        template<class t_type>
        void addOption(const String& label, const Resource<t_type>& mem_loc) = delete;
 
        template<class t_type>
        void addOption(const String& label, Resource<t_type>& mem_loc)
        {
            addINIOption(label, new INIObject<t_type>(mem_loc));
        }
        template<class t_type>
        void addOption(const String& label, const t_type& mem_loc) = delete;
 
        template<class t_type>
        void addOption(const String& label, t_type& mem_loc)
        {
            addINIOption(label, new INIObject<t_type>(mem_loc));
        }
        template<class t_type, uint01 t_row_dims, uint01 t_col_dims>
        void addOption(const String& label, Resource<Matrix<t_type, t_row_dims, t_col_dims>>& mem_loc)
        {
            addINIOption(label, new INIObject<Matrix<t_type, t_row_dims, t_col_dims>>(mem_loc));
        }
        void clear();
        bool addManagedOption(const String& option_label, const String& option, bool replace = true);
        bool hasOption(const String& option) const;
        bool hasOption(uint08 hash_option) const;
        void setDelimiter(char delimiter);
        void setComment(char comment) { m_comment = comment; };
        void read(Scanner& file);
        void readAsciiFile(File& file);
        void readBinaryFile(File& file);
        void setPreserveOrder(bool preserve_order) { m_preserve_order = preserve_order; }
        bool preserveOrder() const { return m_preserve_order; }
        void writeToAsciiFile(File& file, bool include_end_comment = false);
        void writeToBinaryFile(File& file);
        void writeToLog(const String& title, ProgressInfo* log, uint01 log_level = 2);
        void setUseHashLabels(bool use_hash_labels);
        Dictionary<String, String> extraOptions() const;
        Dictionary<String, String*>& extraOptionsRef() { return m_extra_options; };
        String getOption(const String& option, const String& default_value = String()) const;
        static void ConvertToINIString(String& s);
        static void ConvertFromINIString(String& s);
        template<class t_type>
        static INIOption* ToOption(t_type& mem_loc)
        {
            return new INIObject<t_type>(mem_loc);
        }
        template<class t_type>
        static INIOption* ToOption(Resource<t_type>& value)
        {
            return new INIObject<t_type>(value);
        }
    private:
        template<class t_type>
        class INIObject : public INIOption
        {
        public:
            INIObject(Resource<t_type>& value)
                : INIOption()
                , m_type_pointer_shared(&value)
                , m_type_pointer(nullptr)
            {}
            INIObject(t_type& value)
                : INIOption()
                , m_type_pointer_shared(nullptr)
                , m_type_pointer(&value)
            {}
            INIObject(const INIObject& other)
                : INIOption()
                , m_type_pointer_shared(other.m_type_pointer_shared)
                , m_type_pointer(other.m_type_pointer)
            {}
            ~INIObject() {}
            void readOptionAscii(Scanner& scan) override
            {
                readOptionAscii(scan.getNext<String>());
            }
            void readOptionAscii(String option) override
            {
                INIFactory::ConvertFromINIString(option);
                if (option.size() > 0)
                {
                    if (m_type_pointer_shared != nullptr)
                        m_type_pointer_shared->set(option.getAs<t_type>());
                    else
                        *m_type_pointer = option.getAs<t_type>();
                }
            }
            String writeOptionAscii() const override
            {
                String s;
                if (m_type_pointer_shared != nullptr)
                    s = String(m_type_pointer_shared->get());
                else
                    s = String(*m_type_pointer);
                INIFactory::ConvertToINIString(s);
                return s;
            }
            void readOptionBinary(const char* bytes) override
            {
                if (ObjectInfo<t_type>::Primitive)
                {
                    t_type value;
                    memcpy(&value, bytes, sizeof(t_type));
                    if (m_type_pointer_shared != nullptr)
                        m_type_pointer_shared->set(value);
                    else
                        *m_type_pointer = value;
                }
                else
                {
                    readOptionAscii(String(bytes));
                }
            }
            void writeOptionBinary(FILE* stream) const override
            {
                if (ObjectInfo<t_type>::Primitive)
                {
                    uint04 size = sizeof(t_type);
                    fwrite(&size, sizeof(uint04), 1, stream);
                    if (m_type_pointer_shared != nullptr)
                        fwrite(&(m_type_pointer_shared->get()), sizeof(t_type), 1, stream);
                    else
                        fwrite(m_type_pointer, sizeof(t_type), 1, stream);
                }
                else
                {
                    const String value = writeOptionAscii();
                    const uint04 value_size = value.size();
                    fwrite(&value_size, sizeof(uint04), 1, stream);
                    fwrite(value.c_str(), sizeof(char), value_size, stream);
                }
            }
            INIObject<t_type>* copy() const override
            {
                return new INIObject<t_type>(*this);
            }
        protected:
            Resource<t_type>* const m_type_pointer_shared;
            t_type* const m_type_pointer;
        };
        template<class t_type>
        class INIObject<Angle<t_type>> : public INIOption
        {
        public:
            INIObject(Resource<Angle<t_type>>& value)
                : INIOption()
                , m_type_pointer_shared(&value)
                , m_type_pointer(nullptr)
            {}
            INIObject(Angle<t_type>& value)
                : INIOption()
                , m_type_pointer_shared(nullptr)
                , m_type_pointer(&value)
            {}
            INIObject(const INIObject& other)
                : INIOption()
                , m_type_pointer_shared(other.m_type_pointer_shared)
                , m_type_pointer(other.m_type_pointer)
            {}
            ~INIObject() {}
            void readOptionAscii(Scanner& scan) override
            {
                readOptionAscii(scan.getNext<String>());
            }
            void readOptionAscii(String option) override
            {
                INIFactory::ConvertFromINIString(option);
                if (option.size() > 0)
                {
                    if (m_type_pointer_shared != nullptr)
                        m_type_pointer_shared->set(Angle<t_type>(DEGREES, option.getAs<fltp08>()));
                    else
                        *m_type_pointer = Angle<t_type>(DEGREES, option.getAs<fltp08>());
                }
            }
            String writeOptionAscii() const override
            {
                String s;
                if (m_type_pointer_shared != nullptr)
                    s = String(m_type_pointer_shared->get().template as<DEGREES>());
                else
                    s = String(m_type_pointer->template as<DEGREES>());
                INIFactory::ConvertToINIString(s);
                return s;
            }
            void readOptionBinary(const char* bytes) override
            {
                Angle<t_type> value;
                memcpy(&value, bytes, sizeof(Angle<t_type>));
                if (m_type_pointer_shared != nullptr)
                    m_type_pointer_shared->set(value);
                else
                    *m_type_pointer = value;
            }
            void writeOptionBinary(FILE* stream) const override
            {
                uint04 size = sizeof(Angle<t_type>);
                fwrite(&size, sizeof(uint04), 1, stream);
                if (m_type_pointer_shared != nullptr)
                    fwrite(&(m_type_pointer_shared->get()), sizeof(Angle<t_type>), 1, stream);
                else
                    fwrite(m_type_pointer, sizeof(Angle<t_type>), 1, stream);
            }
            INIObject<Angle<t_type>>* copy() const override
            {
                return new INIObject<Angle<t_type>>(*this);
            }
        protected:
            Resource<Angle<t_type>>* const m_type_pointer_shared;
            Angle<t_type>* const m_type_pointer;
        };
    private:
        Dictionary<String, INIOption*> m_options;
        Dictionary<uint08, INIOption*> m_hashed_options;
        Dictionary<String, String*> m_extra_options;
        Buffer<String> m_ordered_options;
        char m_delimiter;
        char m_comment;
        bool m_preserve_order = false;
        bool m_use_hash_labels = false;
    };
 
}