ApplicationUsage.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author Maxim Serebrennik
*/

#pragma once

#include <trUtil/Export.h>

#include <osg/ApplicationUsage>
#include <osg/ref_ptr>

#include <string>
#include <map>


namespace trUtil
{
    class TR_UTIL_EXPORT ApplicationUsage
    {
    public:

        using UsageMap = std::map<std::string, std::string>;

        enum class Type
        {
            NO_HELP = osg::ApplicationUsage::NO_HELP,
            COMMAND_LINE_OPTION = osg::ApplicationUsage::COMMAND_LINE_OPTION,
            ENVIRONMENTAL_VARIABLE = osg::ApplicationUsage::ENVIRONMENTAL_VARIABLE,
            KEYBOARD_MOUSE_BINDING = osg::ApplicationUsage::KEYBOARD_MOUSE_BINDING,
            HELP_ALL = KEYBOARD_MOUSE_BINDING | ENVIRONMENTAL_VARIABLE | COMMAND_LINE_OPTION
        };

        ApplicationUsage();

        ApplicationUsage(osg::ApplicationUsage* applicationUsage);

        ApplicationUsage(const std::string& commandLineUsage);

        ~ApplicationUsage();

        void SetApplicationName(const std::string& name);

        const std::string& GetApplicationName() const;

        void SetDescription(const std::string& desc);

        const std::string& GetDescription() const;

        void AddUsageExplanation(Type type, const std::string& option, const std::string& explanation);

        void SetCommandLineUsage(const std::string& explanation);

        const std::string& GetCommandLineUsage() const;

        void AddCommandLineOption(const std::string& option, const std::string& explanation, const std::string &defaultValue = "");

        void SetCommandLineOptions(const UsageMap& usageMap);

        const UsageMap& GetCommandLineOptions() const;

        void SetCommandLineOptionsDefaults(const UsageMap& usageMap);

        const UsageMap& GetCommandLineOptionsDefaults() const;

        void AddEnvironmentalVariable(const std::string& option, const std::string& explanation, const std::string& defaultValue = "");

        void SetEnvironmentalVariables(const UsageMap& usageMap);

        const UsageMap& GetEnvironmentalVariables() const;

        void SetEnvironmentalVariablesDefaults(const UsageMap& usageMap);

        const UsageMap& GetEnvironmentalVariablesDefaults() const;

        void AddKeyboardMouseBinding(const std::string& prefix, int key, const std::string& explanation);

        void AddKeyboardMouseBinding(int key, const std::string& explanation);

        void AddKeyboardMouseBinding(const std::string& option, const std::string& explanation);

        void SetKeyboardMouseBindings(const UsageMap& usageMap);

        const UsageMap& GetKeyboardMouseBindings() const;

        void GetFormattedString(std::string& str, const UsageMap& um, unsigned int widthOfOutput = 80, bool showDefaults = false, const UsageMap& ud = UsageMap());

        void Write(std::ostream& output, const UsageMap& um, unsigned int widthOfOutput = 80, bool showDefaults = false, const UsageMap& ud = UsageMap());

        void Write(std::ostream& output, Type type = Type::COMMAND_LINE_OPTION, unsigned int widthOfOutput = 80, bool showDefaults = false);

        void WriteEnvironmentSettings(std::ostream& output);

        operator osg::ApplicationUsage& ();

        operator const osg::ApplicationUsage& () const;

        operator osg::ApplicationUsage* ();

        operator const osg::ApplicationUsage* () const;

    protected:
       osg::ref_ptr<osg::ApplicationUsage> mAppUsage = nullptr;
    };
}