Changeset 10381

Timestamp:

04/18/11 10:58:17 (14 years ago)

Author:

tbretz

Message:

Turned comment and unit in constructor, added a function to return a html formatted list.

Location:

trunk/FACT++/src

Files:

• Description.cc (modified) (3 diffs)
• Description.h (modified) (1 diff)

trunk/FACT++/src/Description.cc

@@ -43 +43 @@
 #include <sstream>
 
+#include "tools.h"
+
 using namespace std;
+
+// --------------------------------------------------------------------------
+//
+//! Construct a Description object
+//!
+//! @param n
+//!     Name of the Description, e.g. "temp"
+//!
+//! @param c
+//!     Descriptive text of the Description, e.g. "Temperature of the moon"
+//!
+//! @param u
+//!     Unit of the Description, e.g. "K"
+//
+Description::Description(const string &n, const string &c, const string &u)
+    : name(Trim(n)), comment(Trim(c)), unit(Trim(u))
+{
+}
 
 // --------------------------------------------------------------------------
@@ -72 +92 @@
 
     vector<Description> vec;
-    vec.push_back(Description(svc, "", d));
+    vec.push_back(Description(svc, d));
 
     if (p==string::npos)
@@ -98 +118 @@
         const string name = hasunit ? buf.substr(0, p2) : buf;
 
-        vec.push_back(Description(name, unit, comment));
+        vec.push_back(Description(name, comment, unit));
     }
 
     return vec;
 }
+
+
+// --------------------------------------------------------------------------
+//
+//! Returns a string with an html formatted text containing the descriptions
+//! as returned by SplitDescription
+//!
+//! @param vec
+//!     vector of Description for the individual arguments. First
+//!     element is the global description of the command or service.
+//!
+//! @returns
+//!     string with html formatted text
+//
+string Description::GetHtmlDescription(const vector<Description> &vec)
+{
+    stringstream str;
+    str << '|';
+
+    str << "<H3>" << vec[0].name << "</H3>";
+
+    str << "Usage:";
+    for (vector<Description>::const_iterator i=vec.begin()+1; i!=vec.end(); i++)
+        str << "&nbsp;<font color='maroon'>&lt;" << i->name <<    "&gt;</font>";
+
+    if (vec.size()==1)
+        str << " &lt;no arguments&gt;";
+
+    str << "<P>" << vec[0].comment << "<P>";
+
+    str << "<table>";
+
+    for (vector<Description>::const_iterator i=vec.begin()+1; i!=vec.end(); i++)
+    {
+        str << "<tr>"
+            "<td><font color='maroon'>" << i->name <<     "</font>";
+
+        if (i->unit.empty() && !i->comment.empty() && !i->name.empty())
+            str << ':';
+
+        str << "</td>";
+
+        if (!i->unit.empty())
+            str << "<td><font color='green'>[" << i->unit <<    "]</font>";
+
+        if (!i->unit.empty() && !i->comment.empty())
+            str << ':';
+
+        str <<
+            "</td>"
+            "<td><font color='navy'>"   << i->comment <<  "</font></td>"
+            "</tr>";
+    }
+
+    str << "</table>";
+
+    return str.str();
+}

trunk/FACT++/src/Description.h

@@ -5 +5 @@
 #include <vector>
 
-#include "tools.h"
-
 struct Description
 {
     std::string name;
+    std::string comment;
     std::string unit;
-    std::string comment;
 
     static std::vector<Description> SplitDescription(const std::string &buffer);
+    static std::string GetHtmlDescription(const std::vector<Description> &vec);
 
-    Description(const std::string &n, const std::string &u, const std::string &c)
-        : name(Trim(n)), unit(Trim(u)), comment(Trim(c)) { }
+    Description(const std::string &n, const std::string &c, const std::string &u="");
 };