CmdHelp.hpp

/*
 * CmdHelp.hpp
 * 
 * Copyright 2021 Fernando Pujaico Rivera <fernando.pujaico.rivera@gmail.com>
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 * 
 */
 
#ifndef __PDS_CMDHELP_HPP__
#define __PDS_CMDHELP_HPP__
 
 
#include <sstream>      // std::ostringstream
#include <vector>
#include <string>
 
 
namespace Pds{
 
typedef struct 
{
  unsigned int param_type;
  std::string param_long;
  std::string param_short;
  std::string description;
  std::string bydefault;
}HelpParamRow;
 
class CmdHelp
{
private:
    std::string program;
 
    std::string version;
    
    std::string abstract;
 
    std::string commandexample;
 
    std::vector<Pds::HelpParamRow> data;
private:
    std::string titleprogram;
    std::string titleversion;
    std::string titleabstract;
    std::string titlecommand;
    std::string titleparameters;
    std::string titlelong;
    std::string titleshort;
    std::string titledescription;
    std::string titledata;
    std::string titledefault;
    std::string textdata;
    
public:
 
    CmdHelp(void);
    
    CmdHelp(const std::string &program,const std::string &version);
 
    
    ~CmdHelp();
    
public:
    
    bool AddParam(const unsigned int &ptype,
                const std::string &plong,
                const std::string &pshort,
                const std::string &description,
                const std::string &bydefault="");
                
    bool SetCommandExample(const std::string &commandexample);
    
    bool SetAbstract(const std::string &abstract);
    
    bool IsEmpty(void) const;
 
    bool Print(void) const;
 
}; // Class CmdHelp
 
} // namespace Pds
 
 
#endif