AbstractOptionHandler.h 4.26 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
/* <!-- 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_ABSTRACT_OPTION_HANDLER_H
#define D_ABSTRACT_OPTION_HANDLER_H

#include "OptionHandler.h"

namespace aria2 {

class Option;
43
struct Pref;
44 45 46

class AbstractOptionHandler : public OptionHandler {
protected:
47
  PrefPtr pref_;
48 49 50 51 52 53 54 55 56

  const char* description_;

  std::string defaultValue_;

  OptionHandler::ARG_TYPE argType_;

  char shortName_;

57
  virtual void parseArg(Option& option, const std::string& arg) const = 0;
58

59
public:
60 61 62
  AbstractOptionHandler(PrefPtr pref, const char* description = NO_DESCRIPTION,
                        const std::string& defaultValue = NO_DEFAULT_VALUE,
                        ARG_TYPE argType = REQ_ARG, char shortName = 0);
63 64 65

  virtual ~AbstractOptionHandler();

66 67
  virtual void parse(Option& option,
                     const std::string& arg) const CXX11_OVERRIDE;
68

69
  virtual bool hasTag(uint32_t tag) const CXX11_OVERRIDE;
70

71
  virtual void addTag(uint32_t tag) CXX11_OVERRIDE;
72

73
  virtual std::string toTagString() const CXX11_OVERRIDE;
74

75
  virtual const char* getName() const CXX11_OVERRIDE;
76

77
  virtual const char* getDescription() const CXX11_OVERRIDE
78 79 80 81
  {
    return description_;
  }

82
  virtual const std::string& getDefaultValue() const CXX11_OVERRIDE
83 84 85 86
  {
    return defaultValue_;
  }

87
  virtual PrefPtr getPref() const CXX11_OVERRIDE { return pref_; }
88

89
  virtual char getShortName() const CXX11_OVERRIDE { return shortName_; }
90

91
  virtual OptionHandler::ARG_TYPE getArgType() const CXX11_OVERRIDE
92 93 94 95
  {
    return argType_;
  }

96
  virtual bool isHidden() const CXX11_OVERRIDE;
97

98
  virtual void hide() CXX11_OVERRIDE;
99

100
  virtual bool getEraseAfterParse() const CXX11_OVERRIDE;
101

102
  virtual void setEraseAfterParse(bool f) CXX11_OVERRIDE;
103

104
  virtual bool getInitialOption() const CXX11_OVERRIDE;
105

106
  virtual void setInitialOption(bool f) CXX11_OVERRIDE;
107

108
  virtual bool getChangeOption() const CXX11_OVERRIDE;
109

110
  virtual void setChangeOption(bool f) CXX11_OVERRIDE;
111

112
  virtual bool getChangeOptionForReserved() const CXX11_OVERRIDE;
113

114
  virtual void setChangeOptionForReserved(bool f) CXX11_OVERRIDE;
115

116
  virtual bool getChangeGlobalOption() const CXX11_OVERRIDE;
117

118
  virtual void setChangeGlobalOption(bool f) CXX11_OVERRIDE;
119

120
  virtual bool getCumulative() const CXX11_OVERRIDE;
121

122
  virtual void setCumulative(bool f) CXX11_OVERRIDE;
123 124 125 126 127 128 129 130 131 132

  enum Flag {
    FLAG_HIDDEN = 1,
    FLAG_ERASE_AFTER_PARSE = 1 << 1,
    FLAG_INITIAL_OPTION = 1 << 2,
    FLAG_CHANGE_OPTION = 1 << 3,
    FLAG_CHANGE_OPTION_FOR_RESERVED = 1 << 4,
    FLAG_CHANGE_GLOBAL_OPTION = 1 << 5,
    FLAG_CUMULATIVE = 1 << 6
  };
133

134 135 136 137 138 139 140 141
private:
  // bitwise OR of (1 << HelpTag value) defined in help_tags.h.
  uint32_t tags_;

  // bitwise OR of Flag values.
  uint8_t flags_;

  void updateFlags(int flag, bool val);
142 143 144 145 146
};

} // namespace aria2

#endif // D_ABSTRACT_OPTION_HANDLER_H