aria2/src/OptionHandlerImpl.h

307 lines
12 KiB
C++

/* <!-- copyright */
/*
* aria2 - The high speed download utility
*
* Copyright (C) 2006 Tatsuhiro Tsujikawa
*
* 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
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of portions of this program with the
* OpenSSL library under certain conditions as described in each
* individual source file, and distribute linked combinations
* including the two.
* You must obey the GNU General Public License in all respects
* for all of the code used other than OpenSSL. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you
* do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source
* files in the program, then also delete it here.
*/
/* copyright --> */
#ifndef D_OPTION_HANDLER_IMPL_H
#define D_OPTION_HANDLER_IMPL_H
#include "OptionHandler.h"
#include <vector>
#include "AbstractOptionHandler.h"
#include "A2STR.h"
namespace aria2 {
class Option;
struct Pref;
class BooleanOptionHandler : public AbstractOptionHandler {
public:
BooleanOptionHandler(const Pref* pref,
const char* description = NO_DESCRIPTION,
const std::string& defaultValue = NO_DEFAULT_VALUE,
OptionHandler::ARG_TYPE argType = OptionHandler::REQ_ARG,
char shortName = 0);
virtual ~BooleanOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class IntegerRangeOptionHandler : public AbstractOptionHandler {
private:
int32_t min_;
int32_t max_;
public:
IntegerRangeOptionHandler(const Pref* pref,
const char* description,
const std::string& defaultValue,
int32_t min, int32_t max,
char shortName = 0);
virtual ~IntegerRangeOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class NumberOptionHandler : public AbstractOptionHandler {
private:
int64_t min_;
int64_t max_;
public:
NumberOptionHandler(const Pref* pref,
const char* description = NO_DESCRIPTION,
const std::string& defaultValue = NO_DEFAULT_VALUE,
int64_t min = -1,
int64_t max = -1,
char shortName = 0);
virtual ~NumberOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
void parseArg(Option& option, int64_t number) const;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class UnitNumberOptionHandler : public NumberOptionHandler {
public:
UnitNumberOptionHandler(const Pref* pref,
const char* description = NO_DESCRIPTION,
const std::string& defaultValue = NO_DEFAULT_VALUE,
int64_t min = -1,
int64_t max = -1,
char shortName = 0);
virtual ~UnitNumberOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
};
class FloatNumberOptionHandler : public AbstractOptionHandler {
private:
double min_;
double max_;
public:
FloatNumberOptionHandler(const Pref* pref,
const char* description = NO_DESCRIPTION,
const std::string& defaultValue = NO_DEFAULT_VALUE,
double min = -1, double max = -1,
char shortName = 0);
virtual ~FloatNumberOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class DefaultOptionHandler : public AbstractOptionHandler {
private:
std::string possibleValuesString_;
public:
DefaultOptionHandler(const Pref* pref,
const char* description = NO_DESCRIPTION,
const std::string& defaultValue = NO_DEFAULT_VALUE,
const std::string& possibleValuesString = A2STR::NIL,
OptionHandler::ARG_TYPE argType = OptionHandler::REQ_ARG,
char shortName = 0);
virtual ~DefaultOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class CumulativeOptionHandler : public AbstractOptionHandler {
private:
std::string delim_;
std::string possibleValuesString_;
public:
CumulativeOptionHandler(const Pref* pref,
const char* description,
const std::string& defaultValue,
const std::string& delim,
const std::string& possibleValuesString = A2STR::NIL,
OptionHandler::ARG_TYPE argType =
OptionHandler::REQ_ARG,
char shortName = 0);
virtual ~CumulativeOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class IndexOutOptionHandler : public AbstractOptionHandler {
public:
IndexOutOptionHandler(const Pref* pref,
const char* description,
char shortName = 0);
virtual ~IndexOutOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
#ifdef ENABLE_MESSAGE_DIGEST
class ChecksumOptionHandler : public AbstractOptionHandler {
public:
ChecksumOptionHandler(const Pref* pref,
const char* description,
char shortName = 0);
virtual ~ChecksumOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
#endif // ENABLE_MESSAGE_DIGEST
class ParameterOptionHandler : public AbstractOptionHandler {
private:
std::vector<std::string> validParamValues_;
public:
ParameterOptionHandler(const Pref* pref,
const char* description,
const std::string& defaultValue,
std::vector<std::string> validParamValues,
char shortName = 0);
virtual ~ParameterOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class HostPortOptionHandler : public AbstractOptionHandler {
private:
const Pref* hostOptionName_;
const Pref* portOptionName_;
public:
HostPortOptionHandler(const Pref* pref,
const char* description,
const std::string& defaultValue,
const Pref* hostOptionName,
const Pref* portOptionName,
char shortName = 0);
virtual ~HostPortOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
void setHostAndPort
(Option& option, const std::string& hostname, uint16_t port) const;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class HttpProxyOptionHandler : public AbstractOptionHandler {
private:
const Pref* proxyUserPref_;
const Pref* proxyPasswdPref_;
public:
HttpProxyOptionHandler(const Pref* pref,
const char* description,
const std::string& defaultValue,
char shortName = 0);
virtual ~HttpProxyOptionHandler();
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class LocalFilePathOptionHandler : public AbstractOptionHandler {
private:
bool acceptStdin_;
public:
LocalFilePathOptionHandler
(const Pref* pref,
const char* description = NO_DESCRIPTION,
const std::string& defaultValue = NO_DEFAULT_VALUE,
bool acceptStdin = false,
char shortName = 0);
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
class PrioritizePieceOptionHandler:public AbstractOptionHandler {
public:
PrioritizePieceOptionHandler
(const Pref* pref,
const char* description = NO_DESCRIPTION,
const std::string& defaultValue = NO_DEFAULT_VALUE,
char shortName = 0);
virtual void parseArg(Option& option, const std::string& optarg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
};
// This class is used to deprecate option and optionally handle its
// option value using replacing option.
class DeprecatedOptionHandler:public OptionHandler {
private:
OptionHandler* depOptHandler_;
const OptionHandler* repOptHandler_;
public:
// depOptHandler is deprecated option and repOptHandler is replacing
// new option. If there is no replacing option, omit second
// argument.
DeprecatedOptionHandler
(OptionHandler* depOptHandler,
const OptionHandler* repOptHandler = nullptr);
virtual ~DeprecatedOptionHandler();
virtual void parse(Option& option, const std::string& arg) const
CXX11_OVERRIDE;
virtual std::string createPossibleValuesString() const CXX11_OVERRIDE;
virtual bool hasTag(uint32_t tag) const CXX11_OVERRIDE;
virtual void addTag(uint32_t tag) CXX11_OVERRIDE;
virtual std::string toTagString() const CXX11_OVERRIDE;
virtual const char* getName() const CXX11_OVERRIDE;
virtual const char* getDescription() const CXX11_OVERRIDE;
virtual const std::string& getDefaultValue() const CXX11_OVERRIDE;
virtual bool isHidden() const CXX11_OVERRIDE;
virtual void hide() CXX11_OVERRIDE;
virtual const Pref* getPref() const CXX11_OVERRIDE;
virtual ARG_TYPE getArgType() const CXX11_OVERRIDE;
virtual char getShortName() const CXX11_OVERRIDE;
virtual bool getEraseAfterParse() const CXX11_OVERRIDE;
virtual void setEraseAfterParse(bool eraseAfterParse) CXX11_OVERRIDE;
virtual bool getInitialOption() const CXX11_OVERRIDE;
virtual void setInitialOption(bool f) CXX11_OVERRIDE;
virtual bool getChangeOption() const CXX11_OVERRIDE;
virtual void setChangeOption(bool f) CXX11_OVERRIDE;
virtual bool getChangeOptionForReserved() const CXX11_OVERRIDE;
virtual void setChangeOptionForReserved(bool f) CXX11_OVERRIDE;
virtual bool getChangeGlobalOption() const CXX11_OVERRIDE;
virtual void setChangeGlobalOption(bool f) CXX11_OVERRIDE;
virtual bool getCumulative() const CXX11_OVERRIDE;
virtual void setCumulative(bool f) CXX11_OVERRIDE;
};
} // namespace aria2
#endif // D_OPTION_HANDLER_IMPL_H