From 6bf4607eac463c19c598c9da790bb35ce7208857 Mon Sep 17 00:00:00 2001 From: Vladimir Prus Date: Wed, 6 Nov 2013 09:23:14 +0000 Subject: [PATCH] Align columns across groups in --help output. Patch from Leo Goodstadt. Fixes #6114. [SVN r86571] --- .../program_options/options_description.hpp | 6 +++- src/options_description.cpp | 30 ++++++++++++++----- 2 files changed, 27 insertions(+), 9 deletions(-) diff --git a/include/boost/program_options/options_description.hpp b/include/boost/program_options/options_description.hpp index a66b083..32f6990 100644 --- a/include/boost/program_options/options_description.hpp +++ b/include/boost/program_options/options_description.hpp @@ -199,6 +199,10 @@ namespace program_options { */ options_description& add(const options_description& desc); + /** Find the maximum width of the option column, including options + in groups. */ + unsigned get_option_column_width() const; + public: /** Returns an object of implementation-defined type suitable for adding options to options_description. The returned object will @@ -229,7 +233,7 @@ namespace program_options { /** Outputs 'desc' to the specified stream, calling 'f' to output each option_description element. */ - void print(std::ostream& os) const; + void print(std::ostream& os, unsigned width = 0) const; private: typedef std::map::const_iterator name2index_iterator; diff --git a/src/options_description.cpp b/src/options_description.cpp index 343bd30..9d51ce9 100644 --- a/src/options_description.cpp +++ b/src/options_description.cpp @@ -604,12 +604,9 @@ namespace boost { namespace program_options { } } - void - options_description::print(std::ostream& os) const + unsigned + options_description::get_option_column_width() const { - if (!m_caption.empty()) - os << m_caption << ":\n"; - /* Find the maximum width of the option column */ unsigned width(23); unsigned i; // vc6 has broken for loop scoping @@ -620,6 +617,11 @@ namespace boost { namespace program_options { ss << " " << opt.format_name() << ' ' << opt.format_parameter(); width = (max)(width, static_cast(ss.str().size())); } + + /* Get width of groups as well*/ + for (unsigned j = 0; j < groups.size(); ++j) + width = max(width, groups[j]->get_option_column_width()); + /* this is the column were description should start, if first column is longer, we go to a new line */ const unsigned start_of_description_column = m_line_length - m_min_description_length; @@ -628,9 +630,20 @@ namespace boost { namespace program_options { /* add an additional space to improve readability */ ++width; - + return width; + } + + void + options_description::print(std::ostream& os, unsigned width) const + { + if (!m_caption.empty()) + os << m_caption << ":\n"; + + if (!width) + width = get_option_column_width(); + /* The options formatting style is stolen from Subversion. */ - for (i = 0; i < m_options.size(); ++i) + for (unsigned i = 0; i < m_options.size(); ++i) { if (belong_to_group[i]) continue; @@ -643,7 +656,8 @@ namespace boost { namespace program_options { } for (unsigned j = 0; j < groups.size(); ++j) { - os << "\n" << *groups[j]; + os << "\n"; + groups[j]->print(os, width); } }