/usr/include/mia-2.2/mia/core/handlerbase.hh is in libmia-2.2-dev 2.2.2-1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | /* -*- mia-c++ -*-
*
* This file is part of MIA - a toolbox for medical image analysis
* Copyright (c) Leipzig, Madrid 1999-2014 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_handlerbase_hh
#define mia_core_handlerbase_hh
#include <ostream>
#include <fstream>
#include <map>
#include <libxml++/libxml++.h>
#include <mia/core/defines.hh>
NS_MIA_BEGIN
class CPluginHandlerBase;
/**
\ingroup plugin
\brief A map that is used to collect the plug-in handlers used in a program
This map is used to collect that plug-in handlers that are used by the
TFactoryParameter in order to obtain a list of plug.in dependecies for the
program help.
*/
typedef std::map<std::string, const CPluginHandlerBase*> HandlerHelpMap;
/**
\ingroup plugin
\brief The base class for all plugin handlers
This clas provides some basic funcionallity that is common to all plugin handlers.
In addition, the copy constructor and assigment operator are deleted in order to forbit copying
of instances of this class.
*/
class EXPORT_CORE CPluginHandlerBase {
public:
/**
Constructor
\param descriptor plugin search path descriptor, used to identify the plugin type for users
*/
CPluginHandlerBase(const std::string& descriptor);
/**
forbid copying - doxygen should drop these from the documentation
*/
CPluginHandlerBase(const CPluginHandlerBase& other) = delete;
/**
forbid copying - doxygen should drop these from the documentation
*/
CPluginHandlerBase& operator = (const CPluginHandlerBase& other) = delete;
virtual ~CPluginHandlerBase();
/**
Print out the short help to an output stream
@param os
*/
void print_short_help(std::ostream& os) const;
/**
Print out the help to an output stream
@param os
*/
void print_help(std::ostream& os) const;
/**
Add the help for all plug-ins to the xml tree
\param root toot element the documentation is added to
*/
void get_xml_help(xmlpp::Element *root) const;
/// \returns the plug-in handler descriptor
const std::string& get_descriptor() const;
/** add all plug-in handler that may be called by this plug-in handler
\param [in,out] handler_map plug in handler map to add to
*/
void add_dependend_handlers(HandlerHelpMap& handler_map) const;
/**
write the XML description of this handler to an XML node
@param os stream to write additional descriptions to.
@param root the parent node the information is added to
*/
void get_string_help_description_xml(std::ostream& os, xmlpp::Element *root) const;
/**
@returns the type name of the plug-in handler
*/
std::string get_handler_type_string() const;
/**
Validate the given string to see whether anything useful can be done
with it. The actual way how this is validated depends on the plug-in
type.
*/
bool validate_parameter_string(const std::string& s) const;
private:
virtual void do_print_short_help(std::ostream& os) const = 0;
virtual void do_print_help(std::ostream& os) const = 0;
virtual void do_get_xml_help(xmlpp::Element *root) const = 0;
virtual void do_add_dependend_handlers(HandlerHelpMap& handler_map) const = 0;
virtual std::string get_handler_type_string_and_help(std::ostream& os) const;
virtual std::string do_get_handler_type_string() const;
virtual bool do_validate_parameter_string(const std::string& s) const;
std::string m_descriptor;
};
NS_MIA_END
#endif
|