/usr/include/camp/classvisitor.hpp is in libcamp0.7-dev 0.7.1.1-1ubuntu2.
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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | /****************************************************************************
**
** Copyright (C) 2009-2010 TECHNOGERMA Systems France and/or its subsidiary(-ies).
** Contact: Technogerma Systems France Information (contact@technogerma.fr)
**
** This file is part of the CAMP library.
**
** CAMP is free software: you can redistribute it and/or modify
** it under the terms of the GNU Lesser General Public License as published by
** the Free Software Foundation, either version 3 of the License, or
** (at your option) any later version.
**
** CAMP 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 Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public License
** along with CAMP. If not, see <http://www.gnu.org/licenses/>.
**
****************************************************************************/
#ifndef CAMP_CLASSVISITOR_HPP
#define CAMP_CLASSVISITOR_HPP
#include <camp/config.hpp>
namespace camp
{
class Property;
class SimpleProperty;
class ArrayProperty;
class EnumProperty;
class UserProperty;
class Function;
/**
* \brief Base class for writing custom Class visitors
*
* A ClassVisitor, when applied to a Class, will be notified for each member property and function of
* the target class. To receive this notification for a specific type T of property or function,
* you have to override the \c visit(T) function.
*
* The benefit of such visitation is that you directly get the actual type of the
* property or function, and can handle it safely without having to use dangerous downcasts.
*
* Another benefit of this method is that you can easily filter the properties and functions
* according to their C++ type: if you don't want to handle a specific type of property or function,
* just don't override the corresponding \c visit function.
*
* Here an example of a visitor which prints the contents of a class:
* \code
* class MyClassVisitor : public camp::ClassVisitor
* {
* void visit(const camp::SimpleProperty& property)
* {
* std::cout << "Simple property: " << property.name() << std::endl;
* }
*
* void visit(const camp::ArrayProperty& property)
* {
* std::cout << "Array property: " << property.name() << " - "
* << "dynamic:" << property.dynamic() << std::endl;
* }
*
* void visit(const camp::EnumProperty& property)
* {
* std::cout << "Enum property: " << property.name() << " - "
* << "owner enum:" << property.getEnum().name() << std::endl;
* }
*
* void visit(const camp::UserProperty& property)
* {
* std::cout << "User property: " << property.name() << " - "
* << "owner class:" << property.getClass().name() << std::endl;
* }
*
* void visit(const camp::Function& function)
* {
* std::cout << "Function: " << function.name() << " - "
* << "number of arguments:" << function.argCount() << std::endl;
* }
* };
*
* const camp::Class& metaclass = camp::classByName("MyClass");
* MyClassVisitor visitor;
* metaclass.visit(visitor);
* \endcode
*/
class CAMP_API ClassVisitor
{
public:
/**
* \brief Destructor
*/
virtual ~ClassVisitor();
/**
* \brief Visit any kind of property
*
* This function is a generic callback which can be used
* to receive all property types which are not handled with
* their derived type.
*
* \param property Property which is being visited
*/
virtual void visit(const Property& property);
/**
* \brief Visit a simple property
*
* \param property Property which is being visited
*/
virtual void visit(const SimpleProperty& property);
/**
* \brief Visit an array property
*
* \param property Property which is being visited
*/
virtual void visit(const ArrayProperty& property);
/**
* \brief Visit an enum property
*
* \param property Property which is being visited
*/
virtual void visit(const EnumProperty& property);
/**
* \brief Visit a user property
*
* \param property Property which is being visited
*/
virtual void visit(const UserProperty& property);
/**
* \brief Visit a function
*
* \param function Function which is being visited
*/
virtual void visit(const Function& function);
protected:
/**
* \brief Default constructor
*/
ClassVisitor();
};
} // namespace camp
#endif // CAMP_VALUEVISITOR_HPP
|