cmdlineparser.h

/*
* Copyright 2021 Xilinx, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*   http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#ifndef CMDLINEPARSER_H_
#define CMDLINEPARSER_H_

#include <map>
#include <string>
#include <vector>

using namespace std;

namespace sda {
namespace utils {

bool is_file(const std::string& name);

/*!
 * Synopsis:
 * 1.Parses the command line passed in from the user and stores all enabled
 * 	 system options.
 * 2.Prints help for the user if an option is not valid.
 * 3.Stores options and provides a mechanism to read those options
 */
class CmdLineParser {
public:
	class CmdSwitch {
	public:
		CmdSwitch() {}
		CmdSwitch(const CmdSwitch& rhs) {
			copyfrom(rhs);
		}

		void copyfrom(const CmdSwitch& rhs) {
			this->key = rhs.key;
			this->shortcut = rhs.shortcut;
			this->default_value = rhs.default_value;
			this->value = rhs.value;
			this->desc = rhs.desc;
			this->istoggle = rhs.istoggle;
			this->isvalid = rhs.isvalid;
		}

		CmdSwitch& operator=(const CmdSwitch& rhs) {
			this->copyfrom(rhs);
			return *this;
		}
	public:
		string key;
		string shortcut;
		string default_value;
		string value;
		string desc;
		bool istoggle;
		bool isvalid;
	};

public:
	CmdLineParser();
	//CmdLineParser(int argc, char* argv[]);
	virtual ~CmdLineParser();


	bool addSwitch(const CmdSwitch& s);
	bool addSwitch(const string& name, const string& shortcut,
					const string& desc, const string& default_value = "",
					bool istoggle = false);

	/*!
	 * sets default key to be able to read a 2 argumented call
	 */
	bool setDefaultKey(const char* key);

	/*!
	 * parse and store command line
	 */
	int parse(int argc, char* argv[]);

	/*!
	 * retrieve value using a key
	 */
	string value(const char* key);

	bool value_to_bool(const char* key);

	int value_to_int(const char* key);

	double value_to_double(const char* key);

	/*!
	 * Returns true if a valid value is supplied by user
	 */
	bool isValid(const char* key);

	/*!
	 * prints the help menu in case the options are not correct.
	 */
	virtual void printHelp();

protected:
	/*!
	 * Retrieve command switch
	 */
	CmdSwitch* getCmdSwitch(const char* key);

	bool token_to_fullkeyname(const string& token, string& fullkey);


private:
	map<string, CmdSwitch*> m_mapKeySwitch;
	map<string, string> m_mapShortcutKeys;
	vector<CmdSwitch*> m_vSwitches;
	string m_strDefaultKey;
	string m_appname;
};

//bool starts_with(const string& src, const string& sub);

}
}
#endif /* CMDLINEPARSER_H_ */