options.hxx

Go to the documentation of this file.

// options.hxx -- class to handle command line options
//
// Written by Curtis Olson, started April 1998.
//
// Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program 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
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
//
// $Id$
 
 
#ifndef _OPTIONS_HXX
#define _OPTIONS_HXX
 
#include <memory>
#include <optional>
#include <string>
 
#include <simgear/misc/strutils.hxx>
 
// forward decls
class SGPath;
 
namespace flightgear
{

    SGPath defaultDownloadDir();
 

    enum OptionResult {
        FG_OPTIONS_OK = 0,
        FG_OPTIONS_HELP,
        FG_OPTIONS_ERROR,
        FG_OPTIONS_EXIT,
        FG_OPTIONS_VERBOSE_HELP,
        FG_OPTIONS_SHOW_AIRCRAFT,
        FG_OPTIONS_SHOW_SOUND_DEVICES,
        FG_OPTIONS_SHOW_INFO,
        FG_OPTIONS_NO_DEFAULT_CONFIG
    };
 
    class Options
    {
    private:
        Options();
 
    public:
        static Options* sharedInstance();

        static void reset();
 
        ~Options();

        OptionResult init(int argc, char* argv[], const SGPath& appDataPath);

        void readConfig(const SGPath& path);

        std::string valueForOption(const std::string& key, const std::string& defValue = std::string()) const;

        string_list valuesForOption(const std::string& key) const;

        bool isOptionSet(const std::string& key) const;

  std::optional<bool> checkBoolOptionSet(const std::string& key) const;

        bool isBoolOptionEnable(const std::string& key) const;

        bool isBoolOptionDisable(const std::string& key) const;

        int addOption(const std::string& key, const std::string& value);

        int setOption(const std::string& key, const std::string& value);
 
        void clearOption(const std::string& key);

        OptionResult processOptions();

        void initPaths();

        OptionResult initAircraft();

        bool shouldLoadDefaultConfig() const;

        void setShouldLoadDefaultConfig(bool load);

        static bool checkForArg(int argc, char* argv[], const char* arg);

  static std::optional<bool> checkForBoolArg(int argc, char* argv[], const std::string& checkArg);

        static bool checkForArgEnable(int argc, char* argv[], const std::string& checkArg);

        static bool checkForArgDisable(int argc, char* argv[], const std::string& checkArg);

        static std::string getArgValue(int argc, char* argv[], const char* checkArg);
 
 
        SGPath platformDefaultRoot() const;

        string_list extractOptions() const;

        SGPath actualDownloadDir();

        static bool paramToBool(const std::string& param);
 
    private:
        void showUsage() const;
        void showVersion() const;

        void showInfo() const;
 
        // Write info such as FG version, FG_ROOT, FG_HOME, scenery paths, aircraft
        // paths, etc. to stdout in JSON format, using the UTF-8 encoding.
        void printJSONReport() const;
 
        // The 'fromConfigFile' parameter indicates whether the option comes from a
        // config file or directly from the command line.
        int parseOption(const std::string& s, const std::optional<std::string>& val, bool fromConfigFile);
 
        int parseConfigOption(const SGPath& path, bool fromConfigFile);
 
        std::string getValueForBooleanOption(const std::string& str, const std::string& option, const std::optional<std::string>& value);

        static std::optional<std::string> getValueFromNextParam(int index, int argc, char** argv);
 
        void processArgResult(int result);

        OptionResult setupRoot(int argc, char** argv);
 
 
        class OptionsPrivate;
        std::unique_ptr<OptionsPrivate> p;
    };
 
} // of namespace flightgear
 
void fgSetDefaults();
 
#endif /* _OPTIONS_HXX */