cmdDocBookOutput.h

Go to the documentation of this file.

/****************************************************************************** 
 * 
 *  file:  DocBookOutput.h
 * 
 *  Copyright (c) 2004, Michael E. Smoot
 *  All rights reverved.
 * 
 *  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 DtCmdLine_DOCBOOKOUTPUT_H
#define DtCmdLine_DOCBOOKOUTPUT_H
 

#include <string>
#include <vector>
#include <list>
#include <iostream>
#include <algorithm>

#include "cmdLineInterface.h"
#include "cmdLineOutput.h"
#include "cmdXorHandler.h"
#include "cmdArg.h"

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

namespace DtCmdLine {


   class DocBookOutput : public CmdLineOutput
   {

   public:

      virtual void usage(CmdLineInterface& c);

      virtual void version(CmdLineInterface& c);

      virtual void failure(CmdLineInterface& c, 
                           ArgException& e );

   protected:

      void substituteSpecialChars( std::string& s, char r, std::string& x );
   };


   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();
      XorHandler xorHandler = _cmd.getXorHandler();
      std::vector< std::vector<Arg*> > xorList = xorHandler.getXorList();


      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 << "\t\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\">" << std::endl << std::endl;

      std::cout << "<book>" << std::endl;
      std::cout << "<cmdsynopsis>" << std::endl;

      std::cout << "<command>" << progName << "</command>" << std::endl;

      std::string lt = "&lt;"; 
      std::string gt = "&gt;"; 

      for ( int i = 0; (unsigned int)i < xorList.size(); i++ )
      {
         std::cout << "<group>" << 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; 
         }

         std::cout << "</group>" << std::endl;
      }

      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; 
         }

      std::cout << "</cmdsynopsis>" << std::endl;
      std::cout << "</book>" << std::endl;

   }

   inline void DocBookOutput::failure( CmdLineInterface& _cmd,
                                       ArgException& e ) 
   { 
      std::cout << e.what() << std::endl;
   }

   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);
      }
   }

} //namespace DtCmdLine

#ifdef DtUSE_UTILITIES_NAMESPACE
}     
#endif

#endif