/usr/include/cxxtools/xml/entityresolver.h is in libcxxtools-dev 2.2.1-1.
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 | /*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* As a special exception, you may use this file as part of a free
* software library without restriction. Specifically, if other files
* instantiate templates or use macros or inline functions from this
* file, or you compile this file and link it with other files to
* produce an executable, this file does not by itself cause the
* resulting executable to be covered by the GNU General Public
* License. This exception does not however invalidate any other
* reasons why the executable file might be covered by the GNU Library
* General Public License.
*
* This library 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 this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef cxxtools_xml_EntityResolver_h
#define cxxtools_xml_EntityResolver_h
#include <cxxtools/xml/api.h>
#include <cxxtools/string.h>
#include <map>
namespace cxxtools
{
namespace xml
{
/**
* @brief Entity resolver class which associates entities to resolved entity values.
*
* Entities can be added to this class using the method addEntity(). This method takes
* the entity and the resolved entity value. To resolve the resolves value for an entity
* the method resolveEntity() can be used.
*/
class CXXTOOLS_XML_API EntityResolver
{
public:
/**
* @brief Constructs a new Resolver object and initializes the entity list using the XML default entities.
*
* The constructor calls clear() which clears the entity list and adds the XML default entities.
*/
EntityResolver()
{ }
/**
* @brief Resets the entity list to the XML default entities.
*
* The default entities are all entities from HTML4
*/
void clear()
{ _entityMap.clear(); }
/**
* @brief Adds the given entity and the given resolved entity value (token) to the entity list.
*
* To determine the resolved entity value of a entity the method resolveEntity() can be used.
*
* @param entity A list entry for this entity is created and associated with the also given token.
* @param token The resolved entity value that is associated with the also given entity.
*/
void addEntity(const String& entity, const String& token)
{ _entityMap.insert( std::pair<String, String>(entity, token) ); }
/**
* @brief Returns the resolved entity value (token) for the given entity.
*
* If the entity is not in the list or an dec or hex entity is invalid an exception is thrown.
*
* @param entity The resolved entity value for this entity is returned.
* @return The resolved entity.
* @throws XmlError if the entity is not in the list.
*
*/
String resolveEntity(const String& entity) const;
/**
* @brief Returns the entity value (token) of the given character.
*
* Returns the entity of the given char. If there is no entity found, either the
* given character as a string or a numeric entity is returned depending of the
* passed flag.
*/
String getEntity(Char ch) const;
/**
* @brief Outputs the entity value (token) of the given character.
*
* Returns the entity of the given char. If there is no entity found, either the
* given character as a string or a numeric entity is returned depending of the
* passed flag.
*/
void getEntity(std::basic_ostream<Char>& os, Char ch) const;
private:
//! Entity map containing entities which are associated to their resolved entity value.
typedef std::map<String, String> EntityMap;
EntityMap _entityMap;
};
}
}
#endif
|