1
0
Fork 0
arangodb/lib/ProgramOptions/Section.h

113 lines
3.1 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2016 ArangoDB GmbH, Cologne, Germany
///
/// 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.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Jan Steemann
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGODB_PROGRAM_OPTIONS_SECTION_H
#define ARANGODB_PROGRAM_OPTIONS_SECTION_H 1
#include "Basics/Common.h"
#include "Basics/shell-colors.h"
#include "ProgramOptions/Option.h"
namespace arangodb {
namespace options {
// a single program options section
struct Section {
// sections are default copy-constructible and default movable
Section(std::string const& name, std::string const& description,
std::string const& alias, bool hidden, bool obsolete)
: name(name),
description(description),
alias(alias),
hidden(hidden),
obsolete(obsolete) {}
// adds a program option to the section
void addOption(Option const& option) { options.emplace(option.name, option); }
// get display name for the section
std::string displayName() const { return alias.empty() ? name : alias; }
// whether or not the section has (displayable) options
bool hasOptions() const {
if (!hidden) {
for (auto const& it : options) {
if (!it.second.hidden) {
return true;
}
}
}
return false;
}
// print help for a section
// the special search string "." will show help for all sections, even if hidden
void printHelp(std::string const& search, size_t tw, size_t ow, bool colors) const {
if (search != "." && (hidden || !hasOptions())) {
return;
}
if (colors) {
std::cout << "Section '" << TRI_SHELL_COLOR_BRIGHT << displayName() << TRI_SHELL_COLOR_RESET << "' (" << description << ")"
<< std::endl;
} else {
std::cout << "Section '" << displayName() << "' (" << description << ")"
<< std::endl;
}
// propagate print command to options
for (auto const& it : options) {
it.second.printHelp(search, tw, ow, colors);
}
std::cout << std::endl;
}
// determine display width for a section
size_t optionsWidth() const {
size_t width = 0;
if (!hidden) {
for (auto const& it : options) {
width = (std::max)(width, it.second.optionsWidth());
}
}
return width;
}
std::string name;
std::string description;
std::string alias;
bool hidden;
bool obsolete;
// program options of the section
std::map<std::string, Option> options;
};
}
}
#endif