/usr/include/camp/classvisitor.hpp is in libcamp-dev 0.8.1-2.
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 160 161 162 163 164 165 166 167 168 | /****************************************************************************
**
** Copyright (C) 2009-2014 TEGESO/TEGESOFT and/or its subsidiary(-ies) and mother company.
** Contact: Tegesoft Information (contact@tegesoft.com)
**
** This file is part of the CAMP library.
**
** The MIT License (MIT)
**
** Copyright (C) 2009-2014 TEGESO/TEGESOFT and/or its subsidiary(-ies) and mother company.
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
**
** The above copyright notice and this permission notice shall be included in
** all copies or substantial portions of the Software.
**
** 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 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
|