summaryrefslogtreecommitdiff
path: root/cli/cli/man.cxx
diff options
context:
space:
mode:
Diffstat (limited to 'cli/cli/man.cxx')
-rw-r--r--cli/cli/man.cxx278
1 files changed, 278 insertions, 0 deletions
diff --git a/cli/cli/man.cxx b/cli/cli/man.cxx
new file mode 100644
index 0000000..df703e8
--- /dev/null
+++ b/cli/cli/man.cxx
@@ -0,0 +1,278 @@
+// file : cli/man.cxx
+// author : Boris Kolpackov <boris@codesynthesis.com>
+// license : MIT; see accompanying LICENSE file
+
+#include <vector>
+#include <iostream>
+
+#include <cli/man.hxx>
+
+using namespace std;
+
+namespace
+{
+ // According to groff_mdoc(7), groff may have issues with any of the
+ // following characters at the beginning of the line:
+ //
+ // {}+-/*%<>=,&`'"
+ //
+ // Plus, escaping leading '.' with '\' is not sufficient.
+ //
+ static const string escape ("{}+-/*%<>=,&`'\"");
+
+ static string
+ escape_line (const string& s, size_t b, size_t e)
+ {
+ string r;
+ size_t n (e - b);
+
+
+ if (escape.find (s[b]) != string::npos ||
+ (n > 1 && s[b] == '\\' && s[b + 1] == '.'))
+ r = "\\&";
+
+ r.append (s, b, n);
+ return r;
+ }
+
+ static void
+ wrap_lines (ostream& os, const string& d)
+ {
+ size_t b (0), e (0), i (0);
+ for (size_t n (d.size ()); i < n; ++i)
+ {
+ // First handle preformatted text (.nf/.fi).
+ //
+ if (d.compare (i, 4, ".nf\n") == 0 && (i == 0 || d[i - 1] == '\n'))
+ {
+ assert (b == i); // We should have nothing accumulated.
+
+ // Output everything until (and including) closing .fi as is.
+ //
+ e = d.find ("\n.fi", i + 4);
+ assert (e != string::npos);
+ e += 4; // Now points past 'i'.
+
+ os << string (d, i, e - i);
+
+ b = e;
+ i = e - 1; // For ++i in loop header.
+ continue;
+ }
+
+ if (d[i] == ' ' || d[i] == '\n')
+ e = i;
+
+ if (d[i] == '\n' || (i - b >= 78 && e != b))
+ {
+ os << escape_line (d, b, e) << endl;
+ b = e = e + 1;
+ }
+ }
+
+ // Flush the last line.
+ //
+ if (b != i)
+ os << escape_line (d, b, i);
+ }
+
+ struct doc: traversal::doc, context
+ {
+ doc (context& c, class_doc_type cd): context (c), cd_ (cd) {}
+
+ virtual void
+ traverse (type& ds)
+ {
+ if (ds.name ().compare (0, 3, "doc") != 0) // Ignore doc variables.
+ return;
+
+ // n = 1 - common doc string
+ // n = 2 - arg string, common doc string
+ // n > 2 - arg string, short string, long string
+ //
+ size_t n (ds.size ());
+ const string& d (
+ n == 1
+ ? (cd_ == cd_short ? first_sentence (ds[0]) : ds[0])
+ : (n == 2
+ ? (cd_ == cd_short ? first_sentence (ds[1]) : ds[1])
+ : ds[cd_ == cd_short ? 1 : 2]));
+
+ std::set<string> arg_set;
+ if (n > 1)
+ translate_arg (ds[0], arg_set);
+
+ string s (format (ds.scope (), translate (d, arg_set), true));
+
+ if (s.empty ())
+ return;
+
+ wrap_lines (os, s);
+ os << endl;
+ }
+
+ private:
+ class_doc_type cd_;
+ };
+
+ struct option: traversal::option, context
+ {
+ option (context& c, class_doc_type cd) : context (c), cd_ (cd) {}
+
+ virtual void
+ traverse (type& o)
+ {
+ using semantics::names;
+
+ semantics::doc_strings const& doc (o.doc ());
+
+ if (options.suppress_undocumented () && doc.empty ())
+ return;
+
+ names& n (o.named ());
+
+ os << ".IP \"\\fB";
+
+ for (names::name_iterator i (n.name_begin ()); i != n.name_end (); ++i)
+ {
+ if (i != n.name_begin ())
+ os << "\\fR|\\fB";
+
+ os << *i;
+ }
+
+ os << "\\fR";
+
+ string type (o.type ().name ());
+
+ std::set<string> arg_set;
+
+ if (type != "bool" || doc.size () >= 3)
+ {
+ string s (
+ translate_arg (
+ doc.size () > 0 ? doc[0] : string ("<arg>"), arg_set));
+
+ os << ' ' << format (o.scope (), s, false);
+ }
+
+ os << "\"" << endl;
+
+ string d;
+ if (type == "bool" && doc.size () < 3)
+ {
+ if (doc.size () > 1)
+ d = doc[cd_ == cd_short ? 0 : 1];
+ else if (doc.size () > 0)
+ d = (cd_ == cd_short ? first_sentence (doc[0]) : doc[0]);
+ }
+ else
+ {
+ if (doc.size () > 2)
+ d = doc[cd_ == cd_short ? 1 : 2];
+ else if (doc.size () > 1)
+ d = (cd_ == cd_short ? first_sentence (doc[1]) : doc[1]);
+ }
+
+ // Format the documentation string.
+ //
+ d = format (o.scope (), translate (d, arg_set), false);
+
+ wrap_lines (os, d);
+ os << endl;
+ }
+
+ private:
+ class_doc_type cd_;
+ };
+
+ //
+ //
+ struct class_: traversal::class_, context
+ {
+ class_ (context& c): context (c), base_ (false)
+ {
+ *this >> inherits_ >> *this;
+ }
+
+ virtual void
+ traverse (type& c)
+ {
+ class_doc_type cd (class_doc (c));
+
+ if (cd == cd_exclude || (base_ && cd == cd_exclude_base))
+ return;
+
+ if (!options.exclude_base () && !options.include_base_last ())
+ {
+ bool ob (base_);
+ base_ = true;
+ inherits (c);
+ base_ = ob;
+ }
+
+ doc dc (*this, cd);
+ option op (*this, cd);
+ traversal::names n;
+ n >> dc;
+ n >> op;
+ names (c, n);
+
+ if (!options.exclude_base () && options.include_base_last ())
+ {
+ bool ob (base_);
+ base_ = true;
+ inherits (c);
+ base_ = ob;
+ }
+ }
+
+ private:
+ bool base_;
+ traversal::inherits inherits_;
+ };
+}
+
+void
+generate_man (context& ctx)
+{
+ traversal::cli_unit unit;
+ traversal::names unit_names;
+ traversal::namespace_ ns;
+ doc dc (ctx, cd_default);
+ class_ cl (ctx);
+ unit >> unit_names;
+ unit_names >> ns;
+ unit_names >> dc;
+ unit_names >> cl;
+
+ traversal::names ns_names;
+ ns >> ns_names;
+ ns_names >> ns;
+ ns_names >> dc;
+ ns_names >> cl;
+
+ if (ctx.options.class_ ().empty ())
+ unit.dispatch (ctx.unit);
+ else
+ {
+ for (vector<string>::const_iterator i (ctx.options.class_ ().begin ());
+ i != ctx.options.class_ ().end (); ++i)
+ {
+ string n (*i);
+
+ // Strip leading :: if present.
+ //
+ if (n.size () > 2 && n[0] == ':' && n[1] == ':')
+ n = string (n, 2, string::npos);
+
+ if (semantics::class_* c = ctx.unit.lookup<semantics::class_> ("", n))
+ cl.traverse (*c);
+ else
+ {
+ cerr << "error: class '" << *i << "' not found" << endl;
+ throw generation_failed ();
+ }
+ }
+ }
+}