/usr/include/camp/tagholder.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 | /****************************************************************************
**
** 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_TAGHOLDER_HPP
#define CAMP_TAGHOLDER_HPP
#include <camp/config.hpp>
#include <camp/detail/getter.hpp>
#include <camp/value.hpp>
#ifndef Q_MOC_RUN
#include <boost/shared_ptr.hpp>
#endif
#include <map>
namespace camp
{
template <typename T> class ClassBuilder;
class UserObject;
/**
* \brief Defines objects that hold a set of tags
*
* TagHolder defines an interface for accessing custom tags stored into instances.
*
* A tag is an identifier which can be of any supported type (it is stored in a camp::Value).
* It can also be associated to a value, either constant (static tags) or evaluated each
* time the tag is requested (dynamic tags).
*
* \code
* // Check tag existence
* bool scriptable = tagHolder.hasTag("scriptable");
*
* // Retrieve static tag
* int category = tagHolder.tag("category");
*
* // Retrieve dynamic tag whose value depends on an object's state
* bool hidden = tagHolder.tag("hidden", object);
* \endcode
*/
class CAMP_API TagHolder
{
public:
/**
* \brief Destructor
*/
virtual ~TagHolder();
/**
* \brief Get the total number of tags stored in the object
*
* \return Number of tags
*/
std::size_t tagCount() const;
/**
* \brief Get a tag by its index
*
* \param index Index of the tag to retrieve
*
* \return index-th tag
*
* \throw OutOfRange index is out of range
*/
const Value& tagId(std::size_t index) const;
/**
* \brief Check the existence of a tag
*
* \param id Identifier of the tag to check
*
* \return True if the tag exists, false otherwise
*/
bool hasTag(const Value& id) const;
/**
* \brief Get the value associated to a tag
*
* \param id Identifier of the tag to get
*
* \return Value associated to the tag, or Value::nothing if the tag doesn't exist
*/
const Value& tag(const Value& id) const;
/**
* \brief Get the value associated to a dynamic tag
*
* \param id Identifier of the tag to get
* \param object User object for which to get the tag value
*
* \return Value associated to the tag for \a object, or Value::nothing if the tag doesn't exist
*/
Value tag(const Value& id, const UserObject& object) const;
protected:
/**
* \brief Default constructor
*/
TagHolder();
private:
template <typename T> friend class ClassBuilder;
typedef std::map<Value, detail::Getter<Value> > TagsTable;
TagsTable m_tags; ///< Table of tags / values
};
} // namespace camp
#endif // CAMP_TAGHOLDER_HPP
|