DocBookOutput.h

Go to the documentation of this file.

// -*- Mode: c++; c-basic-offset: 4; tab-width: 4; -*-
 
/****************************************************************************** 
 * 
 *  file:  DocBookOutput.h
 * 
 *  Copyright (c) 2004, Michael E. Smoot
 *  Copyright (c) 2017, Google LLC
 *  All rights reserved.
 * 
 *  See the file COPYING in the top directory of this distribution for
 *  more information.
 *  
 *  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 TCLAP_DOCBOOKOUTPUT_H
#define TCLAP_DOCBOOKOUTPUT_H
 
#include <string>
#include <vector>
#include <list>
#include <iostream>
#include <algorithm>
 
#include <tclap/CmdLineInterface.h>
#include <tclap/CmdLineOutput.h>
#include <tclap/XorHandler.h>
#include <tclap/Arg.h>
 
namespace TCLAP {
 
class DocBookOutput : public CmdLineOutput
{
 
    public:
 
        virtual void usage(CmdLineInterface& c);
 
        virtual void version(CmdLineInterface& c);
 
        virtual void failure(CmdLineInterface& c, 
                             ArgException& e );
 
        DocBookOutput() : theDelimiter('=') {}
    protected:
    // Escape raw data once, at the XML output boundary (text and attributes).
    static std::string escapeXml(const std::string &text) {
        std::string result;
        for (std::string::const_iterator it = text.begin(); it != text.end(); ++it) {
            switch (*it) {
            case '&': result += "&amp;"; break;
            case '<': result += "&lt;"; break;
            case '>': result += "&gt;"; break;
            case '\"': result += "&quot;"; break;
            case '\'': result += "&apos;"; break;
            default: result += *it; break;
            }
        }
        return result;
    }
 
    static std::string valueLabel(const Arg &arg) {
        const std::string id = arg.shortID();
        const std::string label = arg.getFlag().empty()
                                      ? arg.nameStartString() + arg.getName()
                                      : arg.flagStartString() + arg.getFlag();
        const std::string::size_type labelStart = id.find(label);
        if (labelStart != std::string::npos) {
            const std::string::size_type open = labelStart + label.size() + 1;
            const std::string::size_type close = id.rfind('>');
            if (open < id.size() && id[open] == '<' &&
                close != std::string::npos && close > open)
                return id.substr(open + 1, close - open - 1);
        }
        return id;  // Custom IDs without the usual value wrapper.
    }
 
 
        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;
};
 
 
inline void DocBookOutput::version(CmdLineInterface& _cmd) 
{ 
    std::cout << _cmd.getVersion() << std::endl;
}
 
inline void DocBookOutput::usage(CmdLineInterface& _cmd ) 
{
    std::list<Arg*> argList = _cmd.getArgList();
    std::string progName = _cmd.getProgramName();
    std::string xversion = _cmd.getVersion();
    theDelimiter = _cmd.getDelimiter();
    XorHandler xorHandler = _cmd.getXorHandler();
    const std::vector< std::vector<Arg*> > xorList = xorHandler.getXorList();
    basename(progName);
 
    std::cout << "<?xml version='1.0'?>" << 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 << "<refentry>" << std::endl;
 
    std::cout << "<refmeta>" << std::endl;
    std::cout << "<refentrytitle>" << escapeXml(progName) << "</refentrytitle>" << std::endl;
    std::cout << "<manvolnum>1</manvolnum>" << std::endl;
    std::cout << "</refmeta>" << std::endl;
 
    std::cout << "<refnamediv>" << std::endl;
    std::cout << "<refname>" << escapeXml(progName) << "</refname>" << std::endl;
    std::cout << "<refpurpose>" << escapeXml(_cmd.getMessage()) << "</refpurpose>" << std::endl;
    std::cout << "</refnamediv>" << std::endl;
 
    std::cout << "<refsynopsisdiv>" << std::endl;
    std::cout << "<cmdsynopsis>" << std::endl;
 
    std::cout << "<command>" << escapeXml(progName) << "</command>" << std::endl;
 
    // Labeled XOR groups retain their grouping; groups with operands follow
    // the parser's positional order rather than being moved before operands.
    for (unsigned int i = 0; i < xorList.size(); ++i) {
        bool hasOperand = false;
        for (ArgVectorIterator it = xorList[i].begin(); it != xorList[i].end(); ++it)
            if (!(*it)->hasLabel()) hasOperand = true;
        if (hasOperand) continue;
        std::cout << "<group choice='req'>" << std::endl;
        for (ArgVectorIterator it = xorList[i].begin(); it != xorList[i].end(); ++it)
            printShortArg(*it);
        std::cout << "</group>" << std::endl;
    }
    for (ArgListIterator it = argList.begin(); it != argList.end(); ++it)
        if ((*it)->hasLabel() && !xorHandler.contains(*it)) printShortArg(*it);
    std::vector<bool> shown(xorList.size(), false);
    for (ArgListIterator it = argList.begin(); it != argList.end(); ++it) {
        Arg *arg = *it;
        if (arg->hasLabel()) continue;
        unsigned int owner = 0;
        for (; owner < xorList.size(); ++owner)
            if (std::find(xorList[owner].begin(), xorList[owner].end(), arg) !=
                xorList[owner].end()) break;
        if (owner == xorList.size()) {
            printShortArg(arg);
        } else if (!shown[owner]) {
            std::cout << "<group choice='req'>" << std::endl;
            for (ArgVectorIterator member = xorList[owner].begin();
                 member != xorList[owner].end(); ++member) printShortArg(*member);
            std::cout << "</group>" << std::endl;
            shown[owner] = true;
        }
    }
 
    std::cout << "</cmdsynopsis>" << 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 << escapeXml(_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 << escapeXml(xversion) << 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 ) 
{ 
    static_cast<void>(_cmd); // unused
    std::cout << e.what() << std::endl;
    throw ExitException(1);
}
 
inline void DocBookOutput::substituteSpecialChars( std::string& s,
                                                   char r,
                                                   std::string& x )
{
    size_t p;
    while ( (p = s.find_first_of(r)) != std::string::npos )
    {
        s.erase(p,1);
        s.insert(p,x);
    }
}
 
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 choice = "opt";
    if ( a->isRequired() )
        choice = "plain";
 
    std::cout << "<arg choice='" << choice << '\'';
    if ( a->acceptsMultipleValues() )
        std::cout << " rep='repeat'";
 
 
    std::cout << '>';
    if (!a->hasLabel()) {
        std::cout << "<replaceable>" << escapeXml(a->getName())
                  << "</replaceable></arg>" << std::endl;
        return;
    }
 
    if ( !a->getFlag().empty() )
        std::cout << escapeXml(std::string(1, a->flagStartChar()) + a->getFlag());
    else
        std::cout << escapeXml(a->nameStartString() + a->getName());
    if ( a->isValueRequired() )
    {
        std::string arg = valueLabel(*a);
        std::cout << escapeXml(std::string(1, theDelimiter));
        std::cout << "<replaceable>" << escapeXml(arg) << "</replaceable>";
    }
    std::cout << "</arg>" << std::endl;
 
}
 
inline void DocBookOutput::printLongArg(Arg* a)
{
 
 
    std::string desc = a->getDescription();
 
 
    std::cout << "<varlistentry>" << std::endl;
    if (!a->hasLabel()) {
        std::cout << "<term><replaceable>" << escapeXml(a->getName())
                  << "</replaceable></term>\n<listitem><para>"
                  << escapeXml(desc) << "</para></listitem>\n</varlistentry>"
                  << std::endl;
        return;
    }
 
    if ( !a->getFlag().empty() )
    {
        std::cout << "<term>" << std::endl;
        std::cout << "<option>";
        std::cout << escapeXml(std::string(1, a->flagStartChar()) + a->getFlag());
        std::cout << "</option>" << std::endl;
        std::cout << "</term>" << std::endl;
    }
 
    std::cout << "<term>" << std::endl;
    std::cout << "<option>";
    std::cout << escapeXml(a->nameStartString() + a->getName());
    if ( a->isValueRequired() )
    {
        std::string arg = valueLabel(*a);
        std::cout << escapeXml(std::string(1, theDelimiter));
        std::cout << "<replaceable>" << escapeXml(arg) << "</replaceable>";
    }
    std::cout << "</option>" << std::endl;
    std::cout << "</term>" << std::endl;
 
    std::cout << "<listitem>" << std::endl;
    std::cout << "<para>" << std::endl;
    std::cout << escapeXml(desc) << std::endl;
    std::cout << "</para>" << std::endl;
    std::cout << "</listitem>" << std::endl;
 
    std::cout << "</varlistentry>" << std::endl;
}
 
} //namespace TCLAP
#endif