INIInterface.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: INIInterface
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/INIFactory.h>
 
namespace NDEVR
{
    class ProgressInfo;
 
    /**----------------------------------------------------------------------------
    \brief Contains methods for easily reading and writing to an INI file including
        efficient casting, callback, and variable storage methods.
    ----------------------------------------------------------------------------*/
    class NDEVR_BASE_API INIInterface
    {
    public:
        INIInterface(const File& default_ini);
        virtual ~INIInterface(){}
        virtual void writeToLog(ProgressInfo* log, uint01 log_level = 2U);
        virtual void writeToLog(const String& title, ProgressInfo* log, uint01 log_level = 2U);
        virtual void getINI(INIFactory& factory) = 0;
        void setDefaultINIFile(const File& file);
        virtual bool readINIOptions();
        virtual bool readINIOptions(File& ini_file);
        virtual void finishReadingINI(INIFactory&) {};//called after reading an INI.
        virtual void prepareForINI(INIFactory&) {};//called before reading or writing an INI.
        virtual bool saveINIOptions(bool multithead = false);
        virtual bool saveINIOptions(File& ini_file, bool multithead = false);
    protected:
        File m_default_ini;
    };
};