Changeset 1515 for trunk/third_party/tclap/DocBookOutput.h

Timestamp:

24/08/10 11:23:06 (21 months ago)

Author:

Freddie Akeroyd

Message:

Update to tclap 1.2.0 from ​http://tclap.sourceforge.net/
Refs #244

File:

• trunk/third_party/tclap/DocBookOutput.h (modified) (4 diffs)

trunk/third_party/tclap/DocBookOutput.h

@@ +1 @@
+// -*- Mode: c++; c-basic-offset: 4; tab-width: 4; -*-
 
 /****************************************************************************** 
@@ -77 +78 @@
                  */
                 void substituteSpecialChars( std::string& s, char r, std::string& x );
+                void removeChar( std::string& s, char r);
+                void basename( std::string& s );
+
+                void printShortArg(Arg* it);
+                void printLongArg(Arg* it);
+
+                char theDelimiter;
 };
 
@@ -89 +97 @@
         std::list<Arg*> argList = _cmd.getArgList();
         std::string progName = _cmd.getProgramName();
+        std::string version = _cmd.getVersion();
+        theDelimiter = _cmd.getDelimiter();
         XorHandler xorHandler = _cmd.getXorHandler();
         std::vector< std::vector<Arg*> > xorList = xorHandler.getXorList();
-
+        basename(progName);
 
         std::cout << "<?xml version='1.0'?>" << std::endl;
-        std::cout << "<!DOCTYPE book PUBLIC \"-//Norman Walsh//DTD DocBk XML V4.2//EN\"" << std::endl;
+        std::cout << "<!DOCTYPE refentry PUBLIC \"-//OASIS//DTD DocBook XML V4.2//EN\"" << std::endl;
         std::cout << "\t\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" << std::endl << std::endl;
 
-        std::cout << "<book>" << std::endl;
+        std::cout << "<refentry>" << std::endl;
+
+        std::cout << "<refmeta>" << std::endl;
+        std::cout << "<refentrytitle>" << progName << "</refentrytitle>" << std::endl;
+        std::cout << "<manvolnum>1</manvolnum>" << std::endl;
+        std::cout << "</refmeta>" << std::endl;
+
+        std::cout << "<refnamediv>" << std::endl;
+        std::cout << "<refname>" << progName << "</refname>" << std::endl;
+        std::cout << "<refpurpose>" << _cmd.getMessage() << "</refpurpose>" << std::endl;
+        std::cout << "</refnamediv>" << std::endl;
+
+        std::cout << "<refsynopsisdiv>" << std::endl;
         std::cout << "<cmdsynopsis>" << std::endl;
 
         std::cout << "<command>" << progName << "</command>" << std::endl;
-
-        std::string lt = "&lt;"; 
-        std::string gt = "&gt;"; 
 
         // xor
         for ( int i = 0; (unsigned int)i < xorList.size(); i++ )
         {
-                std::cout << "<group>" << std::endl;
+                std::cout << "<group choice='req'>" << std::endl;
                 for ( ArgVectorIterator it = xorList[i].begin(); 
                                                 it != xorList[i].end(); it++ )
-                {
-                        std::string id = (*it)->shortID();
-                        substituteSpecialChars(id,'<',lt);
-                        substituteSpecialChars(id,'>',gt);
-                        std::cout << "<arg>" << id << "</arg>" << std::endl; 
-                }
+                        printShortArg((*it));
 
                 std::cout << "</group>" << std::endl;
         }
-
+        
+        // rest of args
         for (ArgListIterator it = argList.begin(); it != argList.end(); it++)
                 if ( !xorHandler.contains( (*it) ) )
-                {
-                        std::string id = (*it)->shortID();
-                        substituteSpecialChars(id,'<',lt);
-                        substituteSpecialChars(id,'>',gt);
-                        std::cout << "<arg>" << id << "</arg>" << std::endl; 
-                }
+                        printShortArg((*it));
 
         std::cout << "</cmdsynopsis>" << std::endl;
-        std::cout << "</book>" << std::endl;
+        std::cout << "</refsynopsisdiv>" << std::endl;
+
+        std::cout << "<refsect1>" << std::endl;
+        std::cout << "<title>Description</title>" << std::endl;
+        std::cout << "<para>" << std::endl;
+        std::cout << _cmd.getMessage() << std::endl; 
+        std::cout << "</para>" << std::endl;
+        std::cout << "</refsect1>" << std::endl;
+
+        std::cout << "<refsect1>" << std::endl;
+        std::cout << "<title>Options</title>" << std::endl;
+
+        std::cout << "<variablelist>" << std::endl;
+        
+        for (ArgListIterator it = argList.begin(); it != argList.end(); it++)
+                printLongArg((*it));
+
+        std::cout << "</variablelist>" << std::endl;
+        std::cout << "</refsect1>" << std::endl;
+
+        std::cout << "<refsect1>" << std::endl;
+        std::cout << "<title>Version</title>" << std::endl;
+        std::cout << "<para>" << std::endl;
+        std::cout << version << std::endl; 
+        std::cout << "</para>" << std::endl;
+        std::cout << "</refsect1>" << std::endl;
+        
+        std::cout << "</refentry>" << std::endl;
 
 }
 
 inline void DocBookOutput::failure( CmdLineInterface& _cmd,
-                                                ArgException& e ) 
+                                    ArgException& e ) 
 { 
-                std::cout << e.what() << std::endl;
+        static_cast<void>(_cmd); // unused
+        std::cout << e.what() << std::endl;
+        throw ExitException(1);
 }
 
@@ -153 +192 @@
 }
 
+inline void DocBookOutput::removeChar( std::string& s, char r)
+{
+        size_t p;
+        while ( (p = s.find_first_of(r)) != std::string::npos )
+        {
+                s.erase(p,1);
+        }
+}
+
+inline void DocBookOutput::basename( std::string& s )
+{
+        size_t p = s.find_last_of('/');
+        if ( p != std::string::npos )
+        {
+                s.erase(0, p + 1);
+        }
+}
+
+inline void DocBookOutput::printShortArg(Arg* a)
+{
+        std::string lt = "&lt;"; 
+        std::string gt = "&gt;"; 
+
+        std::string id = a->shortID();
+        substituteSpecialChars(id,'<',lt);
+        substituteSpecialChars(id,'>',gt);
+        removeChar(id,'[');
+        removeChar(id,']');
+        
+        std::string choice = "opt";
+        if ( a->isRequired() )
+                choice = "plain";
+
+        std::cout << "<arg choice='" << choice << '\'';
+        if ( a->acceptsMultipleValues() )
+                std::cout << " rep='repeat'";
+
+
+        std::cout << '>';
+        if ( !a->getFlag().empty() )
+                std::cout << a->flagStartChar() << a->getFlag();
+        else
+                std::cout << a->nameStartString() << a->getName();
+        if ( a->isValueRequired() )
+        {
+                std::string arg = a->shortID();
+                removeChar(arg,'[');
+                removeChar(arg,']');
+                removeChar(arg,'<');
+                removeChar(arg,'>');
+                arg.erase(0, arg.find_last_of(theDelimiter) + 1);
+                std::cout << theDelimiter;
+                std::cout << "<replaceable>" << arg << "</replaceable>";
+        }
+        std::cout << "</arg>" << std::endl;
+
+}
+
+inline void DocBookOutput::printLongArg(Arg* a)
+{
+        std::string lt = "&lt;"; 
+        std::string gt = "&gt;"; 
+
+        std::string desc = a->getDescription();
+        substituteSpecialChars(desc,'<',lt);
+        substituteSpecialChars(desc,'>',gt);
+
+        std::cout << "<varlistentry>" << std::endl;
+
+        if ( !a->getFlag().empty() )
+        {
+                std::cout << "<term>" << std::endl;
+                std::cout << "<option>";
+                std::cout << a->flagStartChar() << a->getFlag();
+                std::cout << "</option>" << std::endl;
+                std::cout << "</term>" << std::endl;
+        }
+
+        std::cout << "<term>" << std::endl;
+        std::cout << "<option>";
+        std::cout << a->nameStartString() << a->getName();
+        if ( a->isValueRequired() )
+        {
+                std::string arg = a->shortID();
+                removeChar(arg,'[');
+                removeChar(arg,']');
+                removeChar(arg,'<');
+                removeChar(arg,'>');
+                arg.erase(0, arg.find_last_of(theDelimiter) + 1);
+                std::cout << theDelimiter;
+                std::cout << "<replaceable>" << arg << "</replaceable>";
+        }
+        std::cout << "</option>" << std::endl;
+        std::cout << "</term>" << std::endl;
+
+        std::cout << "<listitem>" << std::endl;
+        std::cout << "<para>" << std::endl;
+        std::cout << desc << std::endl;
+        std::cout << "</para>" << std::endl;
+        std::cout << "</listitem>" << std::endl;
+
+        std::cout << "</varlistentry>" << std::endl;
+}
+
 } //namespace TCLAP
 #endif