cmdoption.hh

Go to the documentation of this file.

/* -*- mia-c++  -*-
 *
 * This file is part of MIA - a toolbox for medical image analysis 
 * Copyright (c) Leipzig, Madrid 1999-2017 Gert Wollny
 *
 * MIA 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 3 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 MIA; if not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef mia_core_cmdoption_hh
#define mia_core_cmdoption_hh

#include <string>
#include <memory>
#include <iostream>
#include <mia/core/cmdoptionflags.hh>
#include <mia/core/handlerbase.hh>

NS_MIA_BEGIN

class CCmdOption;
class CXMLElement; 

typedef std::map<char,  CCmdOption *>        CShortoptionMap;

typedef std::map<std::string,  CCmdOption *> CLongoptionMap;


class EXPORT_CORE CCmdOption  {
public:
        
        
        CCmdOption(char short_opt, const char *long_opt, const char *long_help, 
                   const char *short_help, CCmdOptionFlags flags);
        

        virtual ~CCmdOption();

        void add_option(CShortoptionMap& sm, CLongoptionMap& lm);

        size_t get_needed_args() const;

        void   write_value(std::ostream& os) const;

        void set_value(const char *str_value);

        const char *get_long_option() const;

        char get_short_option() const;

        void print_short_help(std::ostream& os) const;

        void get_opt_help(std::ostream& os)const;

        void get_long_help(std::ostream& os)const;

        const std::string get_value_as_string() const;

        bool is_required() const; 

        const char *long_help() const;

        std::string get_long_help_xml(CXMLElement& parent, HandlerHelpMap& handler_map) const; 

        void post_set(); 

        void add_option_xml(CXMLElement& parent, HandlerHelpMap& handler_map) const;
protected:

        void clear_required(); 
        
        virtual void do_get_long_help(std::ostream& os) const;

        bool has_flag(CCmdOptionFlags test_flags) const;

        void xmlhelp_set_attribute(CXMLElement& node, const char *name, const std::string& value) const; 
private:
        std::string get_flag_string() const; 
        const char *get_short_help() const;

        virtual void do_add_option(CShortoptionMap& sm, CLongoptionMap& lm);
        virtual void do_print_short_help(std::ostream& os) const;
        virtual void do_get_opt_help(std::ostream& os) const;

        virtual bool do_set_value(const char *str_value) = 0;
        virtual size_t do_get_needed_args() const;
        virtual void do_write_value(std::ostream& os) const = 0;

        virtual const std::string do_get_value_as_string() const;
        virtual void do_post_set(); 

        virtual void do_get_long_help_xml(std::ostream& os, CXMLElement& parent, HandlerHelpMap& handler_map) const; 

        char m_short_opt; 
        const char *m_long_opt;
        const char *m_long_help;
        const char *m_short_help;
        CCmdOptionFlags  m_flags;
};

typedef std::shared_ptr<CCmdOption > PCmdOption;

NS_MIA_END

#endif