/usr/include/CLAM/XmlWriteContext.hxx is in libclam-dev 1.4.0-7.
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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | /*
* Copyright (c) 2004 MUSIC TECHNOLOGY GROUP (MTG)
* UNIVERSITAT POMPEU FABRA
*
*
* This program 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 2 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef __XMLWRITECONTEXT_HXX__
#define __XMLWRITECONTEXT_HXX__
#include <ostream>
#include <string>
#include "Assert.hxx"
namespace CLAM
{
/**
* This class provides primitives to write an XML document to a target
* stream and to keep track of the writting state.
* You can only have an instance of that class at a time.
* Instances of this class are created normally by as members of a
* root Scoped object like XmlDocument or XmlFragment.
* You can also instanciate this class directly whenever you want
* to use its primitives without intermediates.
* @todo Indentation
* @todo Explicit namespaces (now are supported by hand)
* @todo Checks on element levels
*/
class XmlWriteContext
{
public:
XmlWriteContext(std::ostream & targetStream) :
mTarget(targetStream)
{
CLAM_ASSERT(!sCurrentContext,
"An XML generation context is already defined");
sCurrentContext = this;
mLastWasAContent=false;
mElementInserted=false;
mTagOpened=false;
mCurrentLevel = 0;
mUseIndentation=false;
}
~XmlWriteContext()
{
sCurrentContext = 0;
}
static XmlWriteContext & CurrentContext()
{
CLAM_ASSERT(sCurrentContext,"XML generation context not created");
return *sCurrentContext;
}
std::ostream & GetTarget()
{
return mTarget;
}
template <typename T>
void InsertContent(const T & content)
{
if (mTagOpened) EndOpenTag();
if (mElementInserted)
NewIndentedLineIfEnabled();
mTarget << content;
mLastWasAContent = true;
}
void OpenElement(const std::string & name)
{
if (mTagOpened) EndOpenTag();
NewIndentedLineIfEnabled();
// TODO: Change the temporary to normal insertion with the upgrade to 0.5.2
mTarget << std::string("<") << name;
mTagOpened = true;
mElementInserted = false;
mLastWasAContent = false;
mCurrentLevel++;
}
void CloseElement(const std::string & name)
{
mCurrentLevel--;
if (mLastWasAContent || mElementInserted)
CloseFullElement(name);
else
CloseEmptyElement();
mElementInserted = true;
mLastWasAContent = false;
}
template <typename T>
void InsertAttribute(const std::string &name, const T & content)
{
CLAM_ASSERT(mTagOpened, "Appending attribute outside a tag");
mTarget << std::string(" ") << name << std::string("='")
<< content << std::string("'");
}
/**
* @return true when the last thing inserted on the current node
* has been plain content.
*/
bool LastWasAContent()
{
return mLastWasAContent;
}
/**
* @return true when an element has been inserted on the current node.
*/
bool ElementInserted()
{
return mElementInserted;
}
unsigned int CurrentLevel()
{
return mCurrentLevel;
}
void UseIndentation(bool useIt)
{
mUseIndentation = useIt;
}
private:
void CloseFullElement(const std::string & name)
{
if (mElementInserted)
NewIndentedLineIfEnabled();
// TODO: Change the temporary to normal insertion with the upgrade to 0.5.2
mTarget << std::string("</") << name << std::string(">");
}
void CloseEmptyElement()
{
CLAM_ASSERT(mTagOpened,"No open tag to close");
// TODO: Change the temporary to normal insertion with the upgrade to 0.5.2
mTarget << std::string(" />");
mTagOpened = false;
}
void EndOpenTag()
{
CLAM_ASSERT(mTagOpened,"No open tag to close");
// TODO: Change the temporary to normal insertion with the upgrade to 0.5.2
mTarget << std::string(">");
mTagOpened = false;
}
void NewIndentedLineIfEnabled()
{
if (!mUseIndentation) return;
// TODO: Change the temporary to normal insertion with the upgrade to 0.5.2
if (mCurrentLevel!=0 || mLastWasAContent || mElementInserted)
mTarget << std::string("\n");
mTarget << std::string(mCurrentLevel,'\t');
}
private:
std::ostream & mTarget;
bool mLastWasAContent;
bool mElementInserted;
bool mTagOpened;
bool mUseIndentation;
unsigned int mCurrentLevel;
static XmlWriteContext * sCurrentContext;
};
} // ns CLAM
#endif//__XMLWRITECONTEXT_HXX__
|