From 3b19860795514db6eada52603a57b40044f2a655 Mon Sep 17 00:00:00 2001 From: naelstrof Date: Tue, 23 May 2017 20:01:51 -0600 Subject: [PATCH] Switched to using a POSIX compliant argument parser. This will break scripts! sorry --- CMakeLists.txt | 5 +- README.md | 8 +- src/cxxopts.hpp | 1468 +++++++++++++++++++++++++++++++++++++++++++++++ src/main.cpp | 127 +++- src/options.cpp | 246 -------- src/options.hpp | 61 -- 6 files changed, 1572 insertions(+), 343 deletions(-) create mode 100644 src/cxxopts.hpp delete mode 100644 src/options.cpp delete mode 100644 src/options.hpp diff --git a/CMakeLists.txt b/CMakeLists.txt index 881a7ee..c9b9c76 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -21,7 +21,7 @@ endif() include_directories("${PROJECT_BINARY_DIR}") -add_definitions(-DSLOP_VERSION="v5.3.38") +add_definitions(-DSLOP_VERSION="v6.3.38") # The names have to be unique unfortunately. set(EXECUTABLE_NAME "slop") @@ -44,8 +44,7 @@ add_library(${LIBRARY_NAME} SHARED src/mouse.cpp set_property(TARGET ${LIBRARY_NAME} PROPERTY CXX_STANDARD_REQUIRED ON) set_property(TARGET ${LIBRARY_NAME} PROPERTY CXX_STANDARD 11) -add_executable(${EXECUTABLE_NAME} src/options.cpp - src/main.cpp) +add_executable(${EXECUTABLE_NAME} src/main.cpp) set_property(TARGET ${EXECUTABLE_NAME} PROPERTY CXX_STANDARD_REQUIRED ON) set_property(TARGET ${EXECUTABLE_NAME} PROPERTY CXX_STANDARD 11) diff --git a/README.md b/README.md index f178a61..f353e32 100644 --- a/README.md +++ b/README.md @@ -86,21 +86,21 @@ Shaders are loaded from the `--shader` flag in slop. They are delimited by comma Enough chatting about it though, here's some example shaders you can copy from [shaderexamples](https://github.com/naelstrof/slop/tree/master/shaderexamples) to `~/.config/slop` to try out! The files listed to the right of the `|` are the required files for the command to the left to work correctly. -* `slop -rblur1,blur2 -b100` | `~/.config/slop/{blur1,blur2}{.frag,.vert}` +* `slop -r blur1,blur2 -b 100` | `~/.config/slop/{blur1,blur2}{.frag,.vert}` ![slop blur](https://my.mixtape.moe/bvsrzr.png) -* `slop -rwiggle -b10` | `~/.config/slop/wiggle{.frag,.vert}` +* `slop -r wiggle -b 10` | `~/.config/slop/wiggle{.frag,.vert}` ![slop animation](http://i.giphy.com/12vjSbFZ0CWDW8.gif) And all together now... -* `slop -rblur1,blur2,wiggle -b50 -c1,1,1` | `~/.config/slop/{blur1,blur2,wiggle}{.frag,.vert}` +* `slop -r blur1,blur2,wiggle -b 50 -c 1,1,1` | `~/.config/slop/{blur1,blur2,wiggle}{.frag,.vert}` ![slop animation](http://i.giphy.com/kfBLafeJfLs2Y.gif) Finally here's an example of a magnifying glass. -* `slop -rcrosshair` | `~/.config/slop/crosshair{.frag,.vert}` +* `slop -r crosshair` | `~/.config/slop/crosshair{.frag,.vert}` ![slop animation](http://i.giphy.com/2xy0fC2LOFQfm.gif) diff --git a/src/cxxopts.hpp b/src/cxxopts.hpp new file mode 100644 index 0000000..5afc307 --- /dev/null +++ b/src/cxxopts.hpp @@ -0,0 +1,1468 @@ +/* + +Copyright (c) 2014, 2015, 2016 Jarryd Beck + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +*/ + +#ifndef CXX_OPTS_HPP +#define CXX_OPTS_HPP + +#if defined(__GNUC__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wnon-virtual-dtor" +#endif + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +//when we ask cxxopts to use Unicode, help strings are processed using ICU, +//which results in the correct lengths being computed for strings when they +//are formatted for the help output +//it is necessary to make sure that can be found by the +//compiler, and that icu-uc is linked in to the binary. + +#ifdef CXXOPTS_USE_UNICODE +#include + +namespace cxxopts +{ + typedef icu::UnicodeString String; + + inline + String + toLocalString(std::string s) + { + return icu::UnicodeString::fromUTF8(s); + } + + class UnicodeStringIterator : public + std::iterator + { + public: + + UnicodeStringIterator(const icu::UnicodeString* s, int32_t pos) + : s(s) + , i(pos) + { + } + + value_type + operator*() const + { + return s->char32At(i); + } + + bool + operator==(const UnicodeStringIterator& rhs) const + { + return s == rhs.s && i == rhs.i; + } + + bool + operator!=(const UnicodeStringIterator& rhs) const + { + return !(*this == rhs); + } + + UnicodeStringIterator& + operator++() + { + ++i; + return *this; + } + + UnicodeStringIterator + operator+(int32_t v) + { + return UnicodeStringIterator(s, i + v); + } + + private: + const icu::UnicodeString* s; + int32_t i; + }; + + inline + String& + stringAppend(String&s, String a) + { + return s.append(std::move(a)); + } + + inline + String& + stringAppend(String& s, int n, UChar32 c) + { + for (int i = 0; i != n; ++i) + { + s.append(c); + } + + return s; + } + + template + String& + stringAppend(String& s, Iterator begin, Iterator end) + { + while (begin != end) + { + s.append(*begin); + ++begin; + } + + return s; + } + + inline + size_t + stringLength(const String& s) + { + return s.length(); + } + + inline + std::string + toUTF8String(const String& s) + { + std::string result; + s.toUTF8String(result); + + return result; + } + + inline + bool + empty(const String& s) + { + return s.isEmpty(); + } +} + +namespace std +{ + cxxopts::UnicodeStringIterator + begin(const icu::UnicodeString& s) + { + return cxxopts::UnicodeStringIterator(&s, 0); + } + + cxxopts::UnicodeStringIterator + end(const icu::UnicodeString& s) + { + return cxxopts::UnicodeStringIterator(&s, s.length()); + } +} + +//ifdef CXXOPTS_USE_UNICODE +#else + +namespace cxxopts +{ + typedef std::string String; + + template + T + toLocalString(T&& t) + { + return t; + } + + inline + size_t + stringLength(const String& s) + { + return s.length(); + } + + inline + String& + stringAppend(String&s, String a) + { + return s.append(std::move(a)); + } + + inline + String& + stringAppend(String& s, size_t n, char c) + { + return s.append(n, c); + } + + template + String& + stringAppend(String& s, Iterator begin, Iterator end) + { + return s.append(begin, end); + } + + template + std::string + toUTF8String(T&& t) + { + return std::forward(t); + } + + inline + bool + empty(const std::string& s) + { + return s.empty(); + } +} + +//ifdef CXXOPTS_USE_UNICODE +#endif + +namespace cxxopts +{ + class Value : public std::enable_shared_from_this + { + public: + + virtual void + parse(const std::string& text) const = 0; + + virtual void + parse() const = 0; + + virtual bool + has_arg() const = 0; + + virtual bool + has_default() const = 0; + + virtual bool + is_container() const = 0; + + virtual bool + has_implicit() const = 0; + + virtual std::string + get_default_value() const = 0; + + virtual std::string + get_implicit_value() const = 0; + + virtual std::shared_ptr + default_value(const std::string& value) = 0; + + virtual std::shared_ptr + implicit_value(const std::string& value) = 0; + }; + + class OptionException : public std::exception + { + public: + OptionException(const std::string& message) + : m_message(message) + { + } + + virtual const char* + what() const noexcept + { + return m_message.c_str(); + } + + private: + std::string m_message; + }; + + class OptionSpecException : public OptionException + { + public: + + OptionSpecException(const std::string& message) + : OptionException(message) + { + } + }; + + class OptionParseException : public OptionException + { + public: + OptionParseException(const std::string& message) + : OptionException(message) + { + } + }; + + class option_exists_error : public OptionSpecException + { + public: + option_exists_error(const std::string& option) + : OptionSpecException(u8"Option ‘" + option + u8"’ already exists") + { + } + }; + + class invalid_option_format_error : public OptionSpecException + { + public: + invalid_option_format_error(const std::string& format) + : OptionSpecException(u8"Invalid option format ‘" + format + u8"’") + { + } + }; + + class option_not_exists_exception : public OptionParseException + { + public: + option_not_exists_exception(const std::string& option) + : OptionParseException(u8"Option ‘" + option + u8"’ does not exist") + { + } + }; + + class missing_argument_exception : public OptionParseException + { + public: + missing_argument_exception(const std::string& option) + : OptionParseException(u8"Option ‘" + option + u8"’ is missing an argument") + { + } + }; + + class option_requires_argument_exception : public OptionParseException + { + public: + option_requires_argument_exception(const std::string& option) + : OptionParseException(u8"Option ‘" + option + u8"’ requires an argument") + { + } + }; + + class option_not_has_argument_exception : public OptionParseException + { + public: + option_not_has_argument_exception + ( + const std::string& option, + const std::string& arg + ) + : OptionParseException( + u8"Option ‘" + option + u8"’ does not take an argument, but argument‘" + + arg + "’ given") + { + } + }; + + class option_not_present_exception : public OptionParseException + { + public: + option_not_present_exception(const std::string& option) + : OptionParseException(u8"Option ‘" + option + u8"’ not present") + { + } + }; + + class argument_incorrect_type : public OptionParseException + { + public: + argument_incorrect_type + ( + const std::string& arg + ) + : OptionParseException( + u8"Argument ‘" + arg + u8"’ failed to parse" + ) + { + } + }; + + namespace values + { + template + void + parse_value(const std::string& text, T& value) + { + std::istringstream is(text); + if (!(is >> value)) + { + throw argument_incorrect_type(text); + } + + if (is.rdbuf()->in_avail() != 0) + { + throw argument_incorrect_type(text); + } + } + + inline + void + parse_value(const std::string& /*text*/, bool& value) + { + //TODO recognise on, off, yes, no, enable, disable + //so that we can write --long=yes explicitly + value = true; + } + + inline + void + parse_value(const std::string& text, std::string& value) + { + value = text; + } + + template + void + parse_value(const std::string& text, std::vector& value) + { + T v; + parse_value(text, v); + value.push_back(v); + } + + template + struct value_has_arg + { + static constexpr bool value = true; + }; + + template <> + struct value_has_arg + { + static constexpr bool value = false; + }; + + template + struct type_is_container + { + static constexpr bool value = false; + }; + + template + struct type_is_container> + { + static constexpr bool value = true; + }; + + template + class standard_value : public Value + { + public: + standard_value() + : m_result(std::make_shared()) + , m_store(m_result.get()) + { + } + + standard_value(T* t) + : m_store(t) + { + } + + void + parse(const std::string& text) const + { + parse_value(text, *m_store); + } + + bool + is_container() const + { + return type_is_container::value; + } + + void + parse() const + { + parse_value(m_default_value, *m_store); + } + + bool + has_arg() const + { + return value_has_arg::value; + } + + bool + has_default() const + { + return m_default; + } + + bool + has_implicit() const + { + return m_implicit; + } + + virtual std::shared_ptr + default_value(const std::string& value){ + m_default = true; + m_default_value = value; + return shared_from_this(); + } + + virtual std::shared_ptr + implicit_value(const std::string& value){ + m_implicit = true; + m_implicit_value = value; + return shared_from_this(); + } + + std::string + get_default_value() const + { + return m_default_value; + } + + std::string + get_implicit_value() const + { + return m_implicit_value; + } + + const T& + get() const + { + if (m_store == nullptr) + { + return *m_result; + } + else + { + return *m_store; + } + } + + protected: + std::shared_ptr m_result; + T* m_store; + bool m_default = false; + std::string m_default_value; + bool m_implicit = false; + std::string m_implicit_value; + }; + } + + template + std::shared_ptr + value() + { + return std::make_shared>(); + } + + template + std::shared_ptr + value(T& t) + { + return std::make_shared>(&t); + } + + class OptionAdder; + + class OptionDetails + { + public: + OptionDetails + ( + const String& description, + std::shared_ptr value + ) + : m_desc(description) + , m_value(value) + , m_count(0) + { + } + + const String& + description() const + { + return m_desc; + } + + bool + has_arg() const + { + return m_value->has_arg(); + } + + void + parse(const std::string& text) + { + m_value->parse(text); + ++m_count; + } + + void + parse_default() + { + m_value->parse(); + } + + int + count() const + { + return m_count; + } + + const Value& value() const { + return *m_value; + } + + template + const T& + as() const + { +#ifdef CXXOPTS_NO_RTTI + return static_cast&>(*m_value).get(); +#else + return dynamic_cast&>(*m_value).get(); +#endif + } + + private: + String m_desc; + std::shared_ptr m_value; + int m_count; + }; + + struct HelpOptionDetails + { + std::string s; + std::string l; + String desc; + bool has_arg; + bool has_default; + std::string default_value; + bool has_implicit; + std::string implicit_value; + std::string arg_help; + bool is_container; + }; + + struct HelpGroupDetails + { + std::string name; + std::string description; + std::vector options; + }; + + class Options + { + public: + + Options(std::string program, std::string help_string = "") + : m_program(std::move(program)) + , m_help_string(toLocalString(std::move(help_string))) + , m_positional_help("positional parameters") + , m_next_positional(m_positional.end()) + { + } + + inline + Options& + positional_help(const std::string& help_text) + { + m_positional_help = std::move(help_text); + return *this; + } + + inline + void + parse(int& argc, char**& argv); + + inline + OptionAdder + add_options(std::string group = ""); + + inline + void + add_option + ( + const std::string& group, + const std::string& s, + const std::string& l, + std::string desc, + std::shared_ptr value, + std::string arg_help + ); + + int + count(const std::string& o) const + { + auto iter = m_options.find(o); + if (iter == m_options.end()) + { + return 0; + } + + return iter->second->count(); + } + + const OptionDetails& + operator[](const std::string& option) const + { + auto iter = m_options.find(option); + + if (iter == m_options.end()) + { + throw option_not_present_exception(option); + } + + return *iter->second; + } + + //parse positional arguments into the given option + inline + void + parse_positional(std::string option); + + inline + void + parse_positional(std::vector options); + + inline + std::string + help(const std::vector& groups = {""}) const; + + inline + const std::vector + groups() const; + + inline + const HelpGroupDetails& + group_help(const std::string& group) const; + + private: + + inline + void + add_one_option + ( + const std::string& option, + std::shared_ptr details + ); + + inline + bool + consume_positional(std::string a); + + inline + void + add_to_option(const std::string& option, const std::string& arg); + + inline + void + parse_option + ( + std::shared_ptr value, + const std::string& name, + const std::string& arg = "" + ); + + inline + void + checked_parse_arg + ( + int argc, + char* argv[], + int& current, + std::shared_ptr value, + const std::string& name + ); + + inline + String + help_one_group(const std::string& group) const; + + inline + void + generate_group_help(String& result, const std::vector& groups) const; + + inline + void + generate_all_groups_help(String& result) const; + + std::string m_program; + String m_help_string; + std::string m_positional_help; + + std::map> m_options; + std::vector m_positional; + std::vector::iterator m_next_positional; + std::unordered_set m_positional_set; + + //mapping from groups to help options + std::map m_help; + }; + + class OptionAdder + { + public: + + OptionAdder(Options& options, std::string group) + : m_options(options), m_group(std::move(group)) + { + } + + inline + OptionAdder& + operator() + ( + const std::string& opts, + const std::string& desc, + std::shared_ptr value + = ::cxxopts::value(), + std::string arg_help = "" + ); + + private: + Options& m_options; + std::string m_group; + }; + +} + +namespace cxxopts +{ + + namespace + { + + constexpr int OPTION_LONGEST = 30; + constexpr int OPTION_DESC_GAP = 2; + + std::basic_regex option_matcher + ("--([[:alnum:]][-_[:alnum:]]+)(=(.*))?|-([[:alnum:]]+)"); + + std::basic_regex option_specifier + ("(([[:alnum:]]),)?([[:alnum:]][-_[:alnum:]]+)"); + + String + format_option + ( + const HelpOptionDetails& o + ) + { + auto& s = o.s; + auto& l = o.l; + + String result = " "; + + if (s.size() > 0) + { + result += "-" + toLocalString(s) + ","; + } + else + { + result += " "; + } + + if (l.size() > 0) + { + result += " --" + toLocalString(l); + } + + if (o.has_arg) + { + auto arg = o.arg_help.size() > 0 ? toLocalString(o.arg_help) : "arg"; + + if (o.has_implicit) + { + result += " [=" + arg + "(=" + toLocalString(o.implicit_value) + ")]"; + } + else + { + result += " " + arg; + } + } + + return result; + } + + String + format_description + ( + const HelpOptionDetails& o, + size_t start, + size_t width + ) + { + auto desc = o.desc; + + if (o.has_default) + { + desc += toLocalString(" (default: " + o.default_value + ")"); + } + + String result; + + auto current = std::begin(desc); + auto startLine = current; + auto lastSpace = current; + + auto size = size_t{}; + + while (current != std::end(desc)) + { + if (*current == ' ') + { + lastSpace = current; + } + + if (size > width) + { + if (lastSpace == startLine) + { + stringAppend(result, startLine, current + 1); + stringAppend(result, "\n"); + stringAppend(result, start, ' '); + startLine = current + 1; + lastSpace = startLine; + } + else + { + stringAppend(result, startLine, lastSpace); + stringAppend(result, "\n"); + stringAppend(result, start, ' '); + startLine = lastSpace + 1; + } + size = 0; + } + else + { + ++size; + } + + ++current; + } + + //append whatever is left + stringAppend(result, startLine, current); + + return result; + } + } + +OptionAdder +Options::add_options(std::string group) +{ + return OptionAdder(*this, std::move(group)); +} + +OptionAdder& +OptionAdder::operator() +( + const std::string& opts, + const std::string& desc, + std::shared_ptr value, + std::string arg_help +) +{ + std::match_results result; + std::regex_match(opts.c_str(), result, option_specifier); + + if (result.empty()) + { + throw invalid_option_format_error(opts); + } + + const auto& s = result[2]; + const auto& l = result[3]; + + m_options.add_option(m_group, s.str(), l.str(), desc, value, + std::move(arg_help)); + + return *this; +} + +void +Options::parse_option +( + std::shared_ptr value, + const std::string& /*name*/, + const std::string& arg +) +{ + value->parse(arg); +} + +void +Options::checked_parse_arg +( + int argc, + char* argv[], + int& current, + std::shared_ptr value, + const std::string& name +) +{ + if (current + 1 >= argc) + { + if (value->value().has_implicit()) + { + parse_option(value, name, value->value().get_implicit_value()); + } + else + { + throw missing_argument_exception(name); + } + } + else + { + if (argv[current + 1][0] == '-' && value->value().has_implicit()) + { + parse_option(value, name, value->value().get_implicit_value()); + } + else + { + parse_option(value, name, argv[current + 1]); + ++current; + } + } +} + +void +Options::add_to_option(const std::string& option, const std::string& arg) +{ + auto iter = m_options.find(option); + + if (iter == m_options.end()) + { + throw option_not_exists_exception(option); + } + + parse_option(iter->second, option, arg); +} + +bool +Options::consume_positional(std::string a) +{ + while (m_next_positional != m_positional.end()) + { + auto iter = m_options.find(*m_next_positional); + if (iter != m_options.end()) + { + if (!iter->second->value().is_container()) + { + if (iter->second->count() == 0) + { + add_to_option(*m_next_positional, a); + ++m_next_positional; + return true; + } + else + { + ++m_next_positional; + continue; + } + } + else + { + add_to_option(*m_next_positional, a); + return true; + } + } + ++m_next_positional; + } + + return false; +} + +void +Options::parse_positional(std::string option) +{ + parse_positional(std::vector{option}); +} + +void +Options::parse_positional(std::vector options) +{ + m_positional = std::move(options); + m_next_positional = m_positional.begin(); + + m_positional_set.insert(m_positional.begin(), m_positional.end()); +} + +void +Options::parse(int& argc, char**& argv) +{ + int current = 1; + + int nextKeep = 1; + + bool consume_remaining = false; + + while (current != argc) + { + if (strcmp(argv[current], "--") == 0) + { + consume_remaining = true; + ++current; + break; + } + + std::match_results result; + std::regex_match(argv[current], result, option_matcher); + + if (result.empty()) + { + //not a flag + + //if true is returned here then it was consumed, otherwise it is + //ignored + if (consume_positional(argv[current])) + { + } + else + { + argv[nextKeep] = argv[current]; + ++nextKeep; + } + //if we return from here then it was parsed successfully, so continue + } + else + { + //short or long option? + if (result[4].length() != 0) + { + const std::string& s = result[4]; + + for (std::size_t i = 0; i != s.size(); ++i) + { + std::string name(1, s[i]); + auto iter = m_options.find(name); + + if (iter == m_options.end()) + { + throw option_not_exists_exception(name); + } + + auto value = iter->second; + + //if no argument then just add it + if (!value->has_arg()) + { + parse_option(value, name); + } + else + { + //it must be the last argument + if (i + 1 == s.size()) + { + checked_parse_arg(argc, argv, current, value, name); + } + else if (value->value().has_implicit()) + { + parse_option(value, name, value->value().get_implicit_value()); + } + else + { + //error + throw option_requires_argument_exception(name); + } + } + } + } + else if (result[1].length() != 0) + { + const std::string& name = result[1]; + + auto iter = m_options.find(name); + + if (iter == m_options.end()) + { + throw option_not_exists_exception(name); + } + + auto opt = iter->second; + + //equals provided for long option? + if (result[3].length() != 0) + { + //parse the option given + + //but if it doesn't take an argument, this is an error + if (!opt->has_arg()) + { + throw option_not_has_argument_exception(name, result[3]); + } + + parse_option(opt, name, result[3]); + } + else + { + if (opt->has_arg()) + { + //parse the next argument + checked_parse_arg(argc, argv, current, opt, name); + } + else + { + //parse with empty argument + parse_option(opt, name); + } + } + } + + } + + ++current; + } + + for (auto& opt : m_options) + { + auto& detail = opt.second; + auto& value = detail->value(); + + if(!detail->count() && value.has_default()){ + detail->parse_default(); + } + } + + if (consume_remaining) + { + while (current < argc) + { + if (!consume_positional(argv[current])) { + break; + } + ++current; + } + + //adjust argv for any that couldn't be swallowed + while (current != argc) { + argv[nextKeep] = argv[current]; + ++nextKeep; + ++current; + } + } + + argc = nextKeep; + +} + +void +Options::add_option +( + const std::string& group, + const std::string& s, + const std::string& l, + std::string desc, + std::shared_ptr value, + std::string arg_help +) +{ + auto stringDesc = toLocalString(std::move(desc)); + auto option = std::make_shared(stringDesc, value); + + if (s.size() > 0) + { + add_one_option(s, option); + } + + if (l.size() > 0) + { + add_one_option(l, option); + } + + //add the help details + auto& options = m_help[group]; + + options.options.emplace_back(HelpOptionDetails{s, l, stringDesc, + value->has_arg(), + value->has_default(), value->get_default_value(), + value->has_implicit(), value->get_implicit_value(), + std::move(arg_help), + value->is_container()}); +} + +void +Options::add_one_option +( + const std::string& option, + std::shared_ptr details +) +{ + auto in = m_options.emplace(option, details); + + if (!in.second) + { + throw option_exists_error(option); + } +} + +String +Options::help_one_group(const std::string& g) const +{ + typedef std::vector> OptionHelp; + + auto group = m_help.find(g); + if (group == m_help.end()) + { + return ""; + } + + OptionHelp format; + + size_t longest = 0; + + String result; + + if (!g.empty()) + { + result += toLocalString(" " + g + " options:\n"); + } + + for (const auto& o : group->second.options) + { + if (o.is_container && m_positional_set.find(o.l) != m_positional_set.end()) + { + continue; + } + + auto s = format_option(o); + longest = std::max(longest, stringLength(s)); + format.push_back(std::make_pair(s, String())); + } + + longest = std::min(longest, static_cast(OPTION_LONGEST)); + + //widest allowed description + auto allowed = size_t{76} - longest - OPTION_DESC_GAP; + + auto fiter = format.begin(); + for (const auto& o : group->second.options) + { + if (o.is_container && m_positional_set.find(o.l) != m_positional_set.end()) + { + continue; + } + + auto d = format_description(o, longest + OPTION_DESC_GAP, allowed); + + result += fiter->first; + if (stringLength(fiter->first) > longest) + { + result += '\n'; + result += toLocalString(std::string(longest + OPTION_DESC_GAP, ' ')); + } + else + { + result += toLocalString(std::string(longest + OPTION_DESC_GAP - + stringLength(fiter->first), + ' ')); + } + result += d; + result += '\n'; + + ++fiter; + } + + return result; +} + +void +Options::generate_group_help(String& result, const std::vector& groups) const +{ + for (std::size_t i = 0; i < groups.size(); ++i) + { + String const& group_help = help_one_group(groups[i]); + if (empty(group_help)) continue; + result += group_help; + if (i < groups.size() - 1) + { + result += '\n'; + } + } +} + +void +Options::generate_all_groups_help(String& result) const +{ + std::vector groups; + groups.reserve(m_help.size()); + + for (auto& group : m_help) + { + groups.push_back(group.first); + } + + generate_group_help(result, groups); +} + +std::string +Options::help(const std::vector& groups) const +{ + String result = m_help_string + "\nUsage:\n " + + toLocalString(m_program) + " [OPTION...]"; + + if (m_positional.size() > 0) { + result += " " + toLocalString(m_positional_help); + } + + result += "\n\n"; + + if (groups.size() == 0) + { + generate_all_groups_help(result); + } + else + { + generate_group_help(result, groups); + } + + return toUTF8String(result); +} + +const std::vector +Options::groups() const +{ + std::vector g; + + std::transform( + m_help.begin(), + m_help.end(), + std::back_inserter(g), + [] (const std::map::value_type& pair) + { + return pair.first; + } + ); + + return g; +} + +const HelpGroupDetails& +Options::group_help(const std::string& group) const +{ + return m_help.at(group); +} + +} + +#if defined(__GNU__) +#pragma GCC diagnostic pop +#endif + +#endif //CXX_OPTS_HPP diff --git a/src/main.cpp b/src/main.cpp index 41b3941..ed95bca 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -20,8 +20,12 @@ #include #include +#include +#include +#include + +#include "cxxopts.hpp" #include "slop.hpp" -#include "options.hpp" using namespace slop; @@ -34,41 +38,79 @@ static void split(const std::string &s, char delim, Out result) { *(result++) = item; } } + static std::vector split(const std::string &s, char delim) { std::vector elems; split(s, delim, std::back_inserter(elems)); return elems; } -SlopOptions* getOptions( Options& options ) { - SlopOptions* foo = new SlopOptions(); - options.getFloat("bordersize", 'b', foo->borderSize); - options.getFloat("padding", 'p', foo->padding); - options.getFloat("tolerance", 't', foo->tolerance); +glm::vec4 parseColor( std::string value ) { + std::string valuecopy = value; + glm::vec4 found; + std::string::size_type sz; + try { + found[0] = std::stof(value,&sz); + value = value.substr(sz+1); + found[1] = std::stof(value,&sz); + value = value.substr(sz+1); + found[2] = std::stof(value,&sz); + if ( value.size() != sz ) { + value = value.substr(sz+1); + found[3] = std::stof(value,&sz); + if ( value.size() != sz ) { + throw "dur"; + } + } else { + found[3] = 1; + } + } catch ( ... ) { + throw new std::invalid_argument("Unable to parse value `" + valuecopy + "` as a color. Should be in the format r,g,b or r,g,b,a. Like 1,1,1,1."); + } + return found; +} + +SlopOptions* getOptions( cxxopts::Options& options ) { + slop::SlopOptions* foo = new slop::SlopOptions(); + if ( options.count( "bordersize" ) > 0 ) { + foo->borderSize = options["bordersize"].as(); + } + if ( options.count( "padding" ) > 0 ) { + foo->padding = options["padding"].as(); + } + if ( options.count( "tolerance" ) > 0 ) { + foo->tolerance = options["tolerance"].as(); + } glm::vec4 color = glm::vec4( foo->r, foo->g, foo->b, foo->a ); - options.getColor("color", 'c', color); - options.getBool("nokeyboard", 'k', foo->nokeyboard); - options.getBool("noopengl", 'o', foo->noopengl); - options.getString( "xdisplay", 'x', foo->xdisplay ); - std::string shaders = "textured"; - options.getString( "shader", 'r', shaders ); - foo->shaders = split( shaders, ',' ); + if ( options.count( "color" ) > 0 ) { + color = parseColor( options["color"].as() ); + } foo->r = color.r; foo->g = color.g; foo->b = color.b; foo->a = color.a; - options.getBool("highlight", 'l', foo->highlight); - try { - bool test = false; - options.getBool("nodecorations", 'n', test); - if ( test ) { - foo->nodecorations = 1; - } - } catch( ... ) { - options.getInt("nodecorations", 'n', foo->nodecorations); + if ( options.count( "nokeyboard" ) > 0 ) { + foo->nokeyboard = options["nokeyboard"].as(); + } + if ( options.count( "xdisplay" ) > 0 ) { + foo->xdisplay = options["xdisplay"].as(); } - if ( foo->nodecorations < 0 || foo->nodecorations > 2 ) { - throw new std::invalid_argument( "--nodecorations must be between 0 and 2. Or be used as a flag." ); + std::string shaders = "textured"; + if ( options.count( "shader" ) > 0 ) { + shaders = options["shader"].as(); + } + foo->shaders = split( shaders, ',' ); + if ( options.count( "noopengl" ) > 0 ) { + foo->noopengl = options["noopengl"].as(); + } + if ( options.count( "highlight" ) > 0 ) { + foo->highlight = options["highlight"].as(); + } + if ( options.count( "nodecorations" ) > 0 ) { + foo->nodecorations = options["nodecorations"].as(); + if ( foo->nodecorations < 0 || foo->nodecorations > 2 ) { + throw new std::invalid_argument( "--nodecorations must be between 0 and 2. Or be used as a flag." ); + } } return foo; } @@ -184,16 +226,42 @@ void printHelp() { } int app( int argc, char** argv ) { + cxxopts::Options options("maim", "Screenshot application."); + options.add_options() + ("h,help", "Print help and exit.") + ("v,version", "Print version and exit.") + ("x,xdisplay", "Sets the xdisplay to use", cxxopts::value()) + ("f,format", "Sets the output format for slop. Format specifiers are %x, %y, %w, %h, %i, %c, and %g. If actual percentage signs are desired in output, use a double percentage sign like so `%%`.", cxxopts::value()) + ("b,bordersize", "Sets the selection rectangle's thickness.", cxxopts::value()) + ("p,padding", "Sets the padding size for the selection, this can be negative.", cxxopts::value()) + ("t,tolerance", "How far in pixels the mouse can move after clicking, and still be detected as a normal click instead of a click-and-drag. Setting this to 0 will disable window selections. Alternatively setting it to 9999999 would force a window selection.", cxxopts::value()) + ("c,color", "Sets the selection rectangle's color. Supports RGB or RGBA input. Depending on the system's window manager/OpenGL support, the opacity may be ignored.", cxxopts::value()) + ("r,shader", "This sets the vertex shader, and fragment shader combo to use when drawing the final framebuffer to the screen. This obviously only works when OpenGL is enabled. The shaders are loaded from ~/.config/maim. See https://github.com/naelstrof/slop for more information on how to create your own shaders.", cxxopts::value()) + ("n,nodecorations", "Sets the level of aggressiveness when trying to remove window decroations. `0' is off, `1' will try lightly to remove decorations, and `2' will recursively descend into the root tree until it gets the deepest available visible child under the mouse. Defaults to `0'.", cxxopts::value()->implicit_value("1")) + ("l,highlight", "Instead of outlining a selection, maim will highlight it instead. This is particularly useful if the color is set to an opacity lower than 1.") + ("q,quiet", "Disable any unnecessary cerr output. Any warnings or info simply won't print.") + ("k,nokeyboard", "Disables the ability to cancel selections with the keyboard.") + ("o,noopengl", "Disables graphics hardware acceleration.") + ; + options.parse(argc, argv); // Options just validates all of our input from argv - Options options( argc, argv ); bool quiet = false; - options.getBool( "quiet", 'q', quiet ); + if ( options.count( "quiet" ) > 0 ) { + quiet = options["quiet"].as(); + } bool help = false; - if ( options.getBool( "help", 'h', help ) ) { + if ( options.count( "help" ) > 0 ) { + help = options["help"].as(); + } + if ( help ) { printHelp(); return 0; } - if ( options.getBool( "version", 'v', help ) ) { + bool version = false; + if ( options.count( "version" ) > 0 ) { + version = options["version"].as(); + } + if ( version ) { std::cout << SLOP_VERSION << "\n"; return 0; } @@ -204,8 +272,9 @@ int app( int argc, char** argv ) { // on a fake selection. SlopSelection selection(0,0,0,0,0); std::string format; - bool gotFormat = options.getString("format", 'f', format); + bool gotFormat = options.count( "format" ) > 0; if ( gotFormat ) { + format = options["format"].as(); formatOutput( format, selection, false ); } diff --git a/src/options.cpp b/src/options.cpp deleted file mode 100644 index 60e34a2..0000000 --- a/src/options.cpp +++ /dev/null @@ -1,246 +0,0 @@ -#include "options.hpp" - -Options::Options( int argc, char** argv ) { - validArguments.push_back( Argument( "nodecorations", 'n', true ) ); - validArguments.push_back( Argument( "bordersize", 'b', false ) ); - validArguments.push_back( Argument( "padding", 'p', false ) ); - validArguments.push_back( Argument( "color", 'c', false ) ); - validArguments.push_back( Argument( "shader", 'r', false ) ); - validArguments.push_back( Argument( "highlight", 'l', true ) ); - validArguments.push_back( Argument( "format", 'f', false ) ); - validArguments.push_back( Argument( "tolerance", 't', false ) ); - validArguments.push_back( Argument( "nokeyboard", 'k', true ) ); - validArguments.push_back( Argument( "noopengl", 'o', true ) ); - validArguments.push_back( Argument( "help", 'h', true ) ); - validArguments.push_back( Argument( "xdisplay", 'x', false ) ); - validArguments.push_back( Argument( "version", 'v', true ) ); - validArguments.push_back( Argument( "quiet", 'q', true ) ); - try { - validate( argc, argv ); - } catch( ... ) { - arguments.clear(); - values.clear(); - floatingValues.clear(); - validArguments[0].isFlagArgument = false; - validate( argc, argv ); - } -} - - -int Options::validateStringOption( int argc, char** argv, int argumentIndex ) { - std::string argument = argv[argumentIndex]; - unsigned int index = 0; - while( index < validArguments.size() ) { - Argument& check = validArguments[index]; - for( unsigned int i=0;i maxFloatingValues ) { - throw new std::invalid_argument("Unexpected floating value `" + argument + "`. Forget to specify an option?" ); - } - i++; - continue; - } - if ( argument[0] == '-' && argument[1] == '-' ) { - i += validateStringOption( argc, argv, i ); - continue; - } - i += validateCharOption( argc, argv, i ); - } -} - -bool Options::getFloat( std::string name, char namec, float& found ) { - for( unsigned int i=0;i 1 && arguments[i].find("=") == std::string::npos ) { - throw new std::invalid_argument("Expected `=` after " + arguments[i]); - } - std::string::size_type sz; - float retvar; - try { - retvar = std::stoi(values[i],&sz); - } catch ( ... ) { - throw new std::invalid_argument("Unable to parse " + arguments[i] + "'s value " + values[i] + " as an integer."); - } - if ( sz != values[i].length() ) { - throw new std::invalid_argument("Unable to parse " + arguments[i] + "'s value " + values[i] + " as an integer."); - } - found = retvar; - return true; - } - } - return false; -} - -bool Options::getString( std::string name, char namec, std::string& found ) { - for( unsigned int i=0;i. - */ - -#ifndef N_OPTIONS_H_ -#define N_OPTIONS_H_ - -#include -#include -#include -#include -#include -#include - -class Argument { -public: - std::string name; - char cname; - bool isFlagArgument; - Argument( std::string name, char cname, bool isFlagArgument ) : name(name), cname(cname), isFlagArgument(isFlagArgument) {} -}; - -static std::vector validArguments; -static unsigned int maxFloatingValues = 0; - -class Options { -private: - std::vector arguments; - std::vector values; - std::vector floatingValues; - int parseCharOption( int argc, char** argv, int argumentIndex, int validIndex ); - int parseStringOption( int argc, char** argv, int argumentIndex, int validIndex ); - int validateStringOption( int argc, char** argv, int argumentIndex ); - int validateCharOption( int argc, char** argv, int argumentIndex ); - void validate( int argc, char** argv ); -public: - Options( int argc, char** argv ); - bool getFloat( std::string name, char namec, float& found ); - bool getInt( std::string name, char namec, int& found ); - bool getString( std::string name, char namec, std::string& found ); - bool getColor( std::string name, char namec, glm::vec4& found ); - bool getBool( std::string name, char namec, bool& found ); -}; - -#endif // N_OPTIONS_H_