//! \~\file picli.h
//! \~\ingroup Application
//! \brief
//! \~english Command-line argument parser
//! \~russian Парсер аргументов командной строки
/*
    PIP - Platform Independent Primitives
    Command-Line Parser
    Ivan Pelipenko peri4ko@yandex.ru

    This program 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 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef PICLI_H
#define PICLI_H

#include "piset.h"
#include "pistringlist.h"

//! \~\ingroup Application
//! \~\brief
//! \~english Command-line argument parser class
//! \~russian Класс парсера аргументов командной строки
//! \details
//! \~english The PICLI class provides convenient parsing of command-line arguments. It supports short keys (e.g., -c), full keys (e.g.,
//! --console), and arguments with/without values.
//! \~russian Класс PICLI предоставляет удобный разбор аргументов командной строки. Поддерживаются короткие ключи (например, -c), полные
//! ключи (например, --console) и аргументы с значениями/без значений.
class PIP_EXPORT PICLI {
public:
	//! \~english Constructs %PICLI from "argc" and "argv" from "int main()" method.
	//! \~russian Создает %PICLI из "argc" и "argv" из метода "int main()".
	PICLI(int argc, char * argv[]);


	//! \~english Add argument with name "name", short key = name first letter and full key = name.
	//! \~russian Добавляет аргумент с именем "name", коротким ключом = первой букве имени и полным ключом = имени.
	void addArgument(const PIString & name, bool value = false);

	//! \~english Add argument with name "name", short key = "shortKey" and full key = name.
	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = имени.
	void addArgument(const PIString & name, const PIChar & shortKey, bool value = false);

	//! \~english Add argument with name "name", short key = "shortKey" and full key = name.
	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = имени.
	void addArgument(const PIString & name, const char * shortKey, bool value = false);

	//! \~english Add argument with name "name", short key = "shortKey" and full key = "fullKey".
	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = "fullKey".
	void addArgument(const PIString & name, const PIChar & shortKey, const PIString & fullKey, bool value = false);

	//! \~english Add argument with name "name", short key = "shortKey" and full key = "fullKey".
	//! \~russian Добавляет аргумент с именем "name", коротким ключом = "shortKey" и полным ключом = "fullKey".
	void addArgument(const PIString & name, const char * shortKey, const PIString & fullKey, bool value = false);


	//! \~english Returns unparsed command-line argument by index "index". Index 0 is program execute command.
	//! \~russian Возвращает исходный аргумент командной строки по индексу "index". Индекс 0 это команда вызова программы.
	PIString rawArgument(int index);

	//! \~english Returns mandatory positional argument by index.
	//! \~russian Возвращает обязательный позиционный аргумент по индексу.
	PIString mandatoryArgument(int index);

	//! \~english Returns optional positional argument by index.
	//! \~russian Возвращает необязательный позиционный аргумент по индексу.
	PIString optionalArgument(int index);

	//! \~english Returns unparsed command-line arguments.
	//! \~russian Возвращает исходные аргументы командной строки.
	const PIStringList & rawArguments();

	//! \~english Returns all mandatory positional arguments.
	//! \~russian Возвращает все обязательные позиционные аргументы.
	const PIStringList & mandatoryArguments();

	//! \~english Returns all optional positional arguments.
	//! \~russian Возвращает все необязательные позиционные аргументы.
	const PIStringList & optionalArguments();

	//! \~english Returns program execute command without arguments.
	//! \~russian Возвращает команду вызова программы без аргументов.
	PIString programCommand();

	//! \~english Returns if argument "name" found.
	//! \~russian Возвращает найден ли аргумент "name".
	bool hasArgument(const PIString & name);

	//! \~english Returns argument "name" value, or empty string if this is no value.
	//! \~russian Возвращает значение аргумента "name" или пустую строку, если значения нет.
	PIString argumentValue(const PIString & name);

	//! \~english Returns short key of argument "name", or empty string if this is no argument.
	//! \~russian Возвращает короткий ключ аргумента "name" или пустую строку, если аргумента нет.
	PIString argumentShortKey(const PIString & name);

	//! \~english Returns full key of argument "name", or empty string if this is no argument.
	//! \~russian Возвращает полный ключ аргумента "name" или пустую строку, если аргумента нет.
	PIString argumentFullKey(const PIString & name);

	//! \~english Returns prefix used for short keys.
	//! \~russian Возвращает префикс коротких ключей.
	const PIString & shortKeyPrefix() const { return _prefix_short; }

	//! \~english Returns prefix used for full keys.
	//! \~russian Возвращает префикс полных ключей.
	const PIString & fullKeyPrefix() const { return _prefix_full; }

	//! \~english Returns expected count of mandatory positional arguments.
	//! \~russian Возвращает ожидаемое количество обязательных позиционных аргументов.
	int mandatoryArgumentsCount() const { return _count_mand; }

	//! \~english Returns expected count of optional positional arguments.
	//! \~russian Возвращает ожидаемое количество необязательных позиционных аргументов.
	int optionalArgumentsCount() const { return _count_opt; }

	//! \~english Sets prefix used for short keys such as "-d".
	//! \~russian Устанавливает префикс коротких ключей, например "-d".
	void setShortKeyPrefix(const PIString & prefix);

	//! \~english Sets prefix used for full keys such as "--debug".
	//! \~russian Устанавливает префикс полных ключей, например "--debug".
	void setFullKeyPrefix(const PIString & prefix);

	//! \~english Sets count of mandatory positional arguments collected before optional ones.
	//! \~russian Устанавливает количество обязательных позиционных аргументов, собираемых до необязательных.
	void setMandatoryArgumentsCount(const int count);

	//! \~english Sets count of optional positional arguments. Negative value means unlimited.
	//! \~russian Устанавливает количество необязательных позиционных аргументов. Отрицательное значение означает без ограничения.
	void setOptionalArgumentsCount(const int count);

	//! \~english Returns debug mode flag.
	//! \~russian Возвращает флаг режима отладки.
	bool debug() const { return debug_; }

	//! \~english Enables or disables debug mode.
	//! \~russian Включает или выключает режим отладки.
	void setDebug(bool debug) { debug_ = debug; }

	//! \~english Returns class name.
	//! \~russian Возвращает имя класса.
	PIConstChars className() const { return "PICLI"; }

	//! \~english Returns human-readable object name.
	//! \~russian Возвращает читаемое имя объекта.
	PIString name() const { return PIStringAscii("CLI"); }

private:
	struct Argument {
		Argument() {}
		Argument(const PIString & n, const PIChar & s, const PIString & f, bool v) {
			name      = n;
			short_key = s;
			full_key  = f;
			has_value = v;
		}
		PIString name;
		PIChar short_key;
		PIString full_key;
		PIString value;
		bool has_value = false, found = false;
	};

	void parse();

	PIString _prefix_short = "-", _prefix_full = "--";
	PIStringList _args_raw, _args_mand, _args_opt;
	PISet<PIString> keys_full, keys_short;
	PIVector<Argument> _args;
	int _count_mand = 0, _count_opt = 0;
	bool needParse = true, debug_ = true;
};

#endif // PICLI_H
