cheprep::XMLWriter Class Reference

#include <XMLWriter.h>

Inheritance diagram for cheprep::XMLWriter:

Public Member Functions
	XMLWriter (std::ostream *out, std::string indentString=" ", std::string defaultNameSpace="")
virtual	~XMLWriter ()
void	close ()
void	openDoc (std::string version="1.0", std::string encoding="", bool standalone=false)
void	referToDTD (std::string name, std::string pid, std::string ref)
void	referToDTD (std::string name, std::string system)
void	closeDoc (bool force=false)
void	printComment (std::string comment)
void	printPlain (std::string text)
void	print (std::string text)
void	println (std::string text)
void	openTag (std::string name)
void	closeTag ()
void	printTag (std::string name)
void	setAttribute (std::string name, char *value)
void	setAttribute (std::string name, std::string value)
void	setAttribute (std::string name, std::vector< double > value)
void	setAttribute (std::string name, int64 value)
void	setAttribute (std::string name, int value)
void	setAttribute (std::string name, bool value)
void	setAttribute (std::string name, double value)
void	printAttributes (int tagLength)
std::string	normalize (std::string s)
std::string	normalizeText (std::string s)
void	checkNameValid (std::string s)
void	openTag (std::string ns, std::string name)
void	printTag (std::string ns, std::string name)
void	setAttribute (std::string ns, std::string name, std::string value)
void	setAttribute (std::string ns, std::string name, double value)
Public Member Functions inherited from cheprep::AbstractXMLWriter
	AbstractXMLWriter (std::string aDefaultNameSpace)
virtual	~AbstractXMLWriter ()

Protected Attributes
bool	closed
IndentPrintWriter *	writer
Protected Attributes inherited from cheprep::AbstractXMLWriter
std::string	defaultNameSpace

Detailed Description

Definition at line 22 of file XMLWriter.h.

Constructor & Destructor Documentation

cheprep::XMLWriter::XMLWriter	(	std::ostream *	out,
		std::string	indentString = "  ",
		std::string	defaultNameSpace = ""
	)

Definition at line 18 of file XMLWriter.cc.

References closed, cheprep::IndentPrintWriter::setIndentString(), and writer.

    : AbstractXMLWriter(aDefaultNameSpace) {
    writer = new IndentPrintWriter(out);
    writer->setIndentString(indentString);
    closed = false;
    dtdName = "";
}

cheprep::XMLWriter::~XMLWriter ( )

virtual

Definition at line 26 of file XMLWriter.cc.

References cheprep::IndentPrintWriter::close(), and writer.

                      {
    writer->close();
    delete writer;
}

Member Function Documentation

void cheprep::XMLWriter::checkNameValid

(

std::string

s

)

Definition at line 280 of file XMLWriter.cc.

Referenced by openTag(), printAttributes(), and printTag().

                                     {
// Could be added.
//    if (!XMLCharacterProperties.validName(s)) throw new RuntimeException("Invalid name: "+s);
}

void cheprep::XMLWriter::close ( )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 31 of file XMLWriter.cc.

References cheprep::IndentPrintWriter::close(), closeDoc(), and writer.

                      {
    closeDoc();
    writer->close();
}

void cheprep::XMLWriter::closeDoc ( bool  force = false )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 70 of file XMLWriter.cc.

References closed, and closeTag().

Referenced by close().

                                   {
    if (!closed) {
        if (!openTags.empty()) {
            if (!force) cerr << "Not all tags were closed before closing XML document:" << endl;
            while (!openTags.empty()) {
                if (force) {
                    closeTag();
                } else {
                    cerr << "   </" << openTags.top().c_str() << ">" << endl;
                    openTags.pop();
                }
            }
        }
        closed = true;
    }
}

void cheprep::XMLWriter::closeTag ( )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 119 of file XMLWriter.cc.

References cheprep::IndentPrintWriter::close(), cheprep::IndentPrintWriter::outdent(), and writer.

Referenced by closeDoc().

                         {
    if (openTags.empty()) {
        writer->close();
        cerr << "XMLWriter::closeTag(), No open tags" << endl;
    }
    string name = openTags.top();
    openTags.pop();
    writer->outdent();
    *writer << "</" << name.c_str() << ">" << endl;
}

string cheprep::XMLWriter::normalize

(

std::string

s

)

Definition at line 201 of file XMLWriter.cc.

References buffer.

Referenced by printAttributes().

                                    {
    string str = "";
    char buffer[20];

    int len = s.length();
    for (int i = 0; i < len; i++) {
        char ch = s[i];
        switch (ch) {
            case '<': {
                str.append("&lt;");
                break;
            }
            case '>': {
                str.append("&gt;");
                break;
            }
            case '&': {
                str.append("&amp;");
                break;
            }
            case '"': {
                str.append("&quot;");
                break;
            }
            case '\r':
            case '\n': {
                sprintf(buffer, "&#%ud", ch);
                str.append(buffer);
                str.append(";");
                break;
            }
            default: {
//                if (ch > 0x00FF) {
//                    sprintf(buffer, "&#x%4.4x", ch);
//                    str.append(buffer);
//                    str.append(";");
//                } else {
                    str.append(&ch, 1);
//                }
            }
        }
    }

    return str;
}

string cheprep::XMLWriter::normalizeText

(

std::string

s

)

Definition at line 247 of file XMLWriter.cc.

Referenced by print(), and printComment().

                                        {
    string str = "";

    int len = s.length();
    for (int i = 0; i < len; i++) {
        char ch = s[i];
        switch (ch) {
            case '<': {
                str.append("&lt;");
                break;
            }
            case '>': {
                str.append("&gt;");
                break;
            }
            case '&': {
                str.append("&amp;");
                break;
            }
            default: {
//                if (ch > 0x00FF) {
//                    sprintf(buffer, "&#x%4.4x", ch);
//                    str.append(buffer);
//                    str.append(";");
//                } else {
                    str.append(&ch, 1);
//                }
            }
        }
    }
    return str;
}

void cheprep::XMLWriter::openDoc ( std::string  version = "1.0", std::string  encoding = "", bool  standalone = false  )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 36 of file XMLWriter.cc.

References cheprep::IndentPrintWriter::getIndentString(), cheprep::IndentPrintWriter::setIndentString(), and writer.

                                                                        {
    string indentString = writer->getIndentString();
    writer->setIndentString(indentString);

//    if (!XMLCharacterProperties.validVersionNum(version)) throw new RuntimeException("Invalid version number: "+version);
    *writer << "<?xml version=\"" << version.c_str() << "\" ";
    if (encoding.compare("") != 0) {
//        if (!XMLCharacterProperties.validEncName(encoding)) throw new RuntimeException("Invalid encoding name: "+encoding);
        *writer << "encoding=\"" << encoding.c_str() << "\" ";
    }
    if (standalone) {
        *writer << "standalone=\"yes\" ";
    }
    *writer << "?>";
    *writer << endl;
    writer->setIndentString(indentString);
}

void cheprep::XMLWriter::openTag ( std::string  name )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 107 of file XMLWriter.cc.

References checkNameValid(), cheprep::IndentPrintWriter::indent(), printAttributes(), and writer.

Referenced by openTag().

                                   {
    checkNameValid(name);
    if (openTags.empty() && dtdName.compare("") && dtdName.compare(name)) {
        cerr << "XMLWriter::openTag(), First tag: '" << name << "' not equal to DTD id: '" << dtdName << "'" << endl;
    }
    *writer << "<" << name.c_str();
    printAttributes(name.length());
    *writer << ">" << endl;
    writer->indent();
    openTags.push(name);
}

void cheprep::XMLWriter::openTag ( std::string  ns, std::string  name  )

inlinevirtual

Implements cheprep::AbstractXMLWriter.

Definition at line 54 of file XMLWriter.h.

References cheprep::AbstractXMLWriter::defaultNameSpace, and openTag().

                                                   {
            openTag(ns == defaultNameSpace ? name : ns.append(":").append(name));
        }

void cheprep::XMLWriter::print

(

std::string

text

)

Definition at line 98 of file XMLWriter.cc.

References normalizeText(), and writer.

Referenced by println().

                                 {
    *writer << normalizeText(text).c_str();
}

void cheprep::XMLWriter::printAttributes

(

int

tagLength

)

Definition at line 176 of file XMLWriter.cc.

References checkNameValid(), cheprep::IndentPrintWriter::getIndent(), cheprep::IndentPrintWriter::indent(), normalize(), cheprep::IndentPrintWriter::outdent(), width, and writer.

Referenced by openTag(), and printTag().

                                             {
    int width = tagLength + 1;
    bool extraIndent = false;
    for (map<string,string>::iterator i = attributes.begin(); i != attributes.end(); i++) {
        string key = i->first;
        checkNameValid(key);
        string value = normalize(i->second);
        int length = key.length() + value.length() + 3;
        if (width > 0 && width + length + 2*writer->getIndent() > 60) {
            width = 0;
            *writer << endl;
            if (!extraIndent) {
                writer->indent();
                extraIndent = true;
            }
        } else {
            width += length;
            *writer << " ";
        }
        *writer << key.c_str() << "=\"" << value.c_str() << "\"";
    }
    attributes.clear();
    if (extraIndent) writer->outdent();
}

void cheprep::XMLWriter::printComment

(

std::string

comment

)

Definition at line 87 of file XMLWriter.cc.

References normalizeText(), and writer.

                                           {
    if (comment.find("--") != string::npos) {
        cerr << "XMLWriter::printComment '--' sequence not allowed in comment" << endl;
    }
    *writer << "<!--" << normalizeText(comment).c_str() << "-->" << endl;
}

void cheprep::XMLWriter::println

(

std::string

text

)

Definition at line 102 of file XMLWriter.cc.

References print(), and writer.

                                   {
    print(text);
    *writer << endl;
}

void cheprep::XMLWriter::printPlain

(

std::string

text

)

Definition at line 94 of file XMLWriter.cc.

References writer.

                                      {
    *writer << text.c_str();
}

void cheprep::XMLWriter::printTag ( std::string  name )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 130 of file XMLWriter.cc.

References checkNameValid(), printAttributes(), and writer.

Referenced by printTag().

                                    {
    checkNameValid(name);
    *writer << "<" << name.c_str();
    printAttributes(name.length());
    *writer << "/>" << endl;
}

void cheprep::XMLWriter::printTag ( std::string  ns, std::string  name  )

inlinevirtual

Implements cheprep::AbstractXMLWriter.

Definition at line 57 of file XMLWriter.h.

References cheprep::AbstractXMLWriter::defaultNameSpace, and printTag().

                                                    {
            printTag(ns == defaultNameSpace ? name : ns.append(":").append(name));
        }

void cheprep::XMLWriter::referToDTD	(	std::string	name,
		std::string	pid,
		std::string	ref
	)

Definition at line 54 of file XMLWriter.cc.

References writer.

                                                              {
    if (dtdName != "") {
        cerr << "XMLWriter::ReferToDTD cannot be called twice" << endl;
    }
    dtdName = name;
    *writer << "<!DOCTYPE " << name.c_str() << " PUBLIC \"" << pid.c_str() << "\" \"" << ref.c_str() << "\">" << endl;
}

void cheprep::XMLWriter::referToDTD	(	std::string	name,
		std::string	system
	)

Definition at line 62 of file XMLWriter.cc.

References writer.

                                                     {
    if (dtdName != "") {
        cerr << "XMLWriter::ReferToDTD cannot be called twice";
    }
    dtdName = name;
    *writer << "<!DOCTYPE " << name.c_str() << " SYSTEM \"" << system.c_str() << "\">" << endl;
}

void cheprep::XMLWriter::setAttribute ( std::string  name, char *  value  )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 137 of file XMLWriter.cc.

Referenced by setAttribute().

                                                     {
    setAttribute(name, (string)value);
}

void cheprep::XMLWriter::setAttribute ( std::string  name, std::string  value  )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 141 of file XMLWriter.cc.

                                                      {
    attributes[name] = value;
    // NOTE: never set type here
}

void cheprep::XMLWriter::setAttribute ( std::string  name, std::vector< double >  value  )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 146 of file XMLWriter.cc.

References cheprep::DefaultHepRepAttValue::getAsString(), and setAttribute().

                                                                    {
    if (name == "value") setAttribute("type", (std::string)"Color");
    setAttribute(name, DefaultHepRepAttValue::getAsString(value));
}

void cheprep::XMLWriter::setAttribute ( std::string  name, int64  value  )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 151 of file XMLWriter.cc.

References cheprep::DefaultHepRepAttValue::getAsString(), and setAttribute().

                                                        {
    if (name == "value") setAttribute("type", (std::string)"long");
    setAttribute(name, DefaultHepRepAttValue::getAsString(value));
}

void cheprep::XMLWriter::setAttribute ( std::string  name, int  value  )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 156 of file XMLWriter.cc.

References cheprep::DefaultHepRepAttValue::getAsString(), setAttribute(), and cheprep::DefaultHepRepAttValue::toShowLabel().

                                                      {
    if (name == "showlabel") {
        string label = DefaultHepRepAttValue::toShowLabel(value);
        setAttribute("showlabel", label);
    } else {
        if (name == "value") setAttribute("type", (std::string)"int");
        setAttribute(name, DefaultHepRepAttValue::getAsString(value));
    }
}

void cheprep::XMLWriter::setAttribute ( std::string  name, bool  value  )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 166 of file XMLWriter.cc.

References cheprep::DefaultHepRepAttValue::getAsString(), and setAttribute().

                                                       {
    if (name == "value") setAttribute("type", (std::string)"boolean");
    setAttribute(name, DefaultHepRepAttValue::getAsString(value));
}

void cheprep::XMLWriter::setAttribute ( std::string  name, double  value  )

virtual

Implements cheprep::AbstractXMLWriter.

Definition at line 171 of file XMLWriter.cc.

References cheprep::DefaultHepRepAttValue::getAsString(), and setAttribute().

                                                      {
    if (name == "value") setAttribute("type", (std::string)"double");
    setAttribute(name, DefaultHepRepAttValue::getAsString(value));
}

void cheprep::XMLWriter::setAttribute ( std::string  ns, std::string  name, std::string  value  )

inlinevirtual

Implements cheprep::AbstractXMLWriter.

Definition at line 60 of file XMLWriter.h.

References setAttribute().

                                                                         {
            setAttribute(ns.append(":").append(name), value);
        }

void cheprep::XMLWriter::setAttribute ( std::string  ns, std::string  name, double  value  )

inlinevirtual

Implements cheprep::AbstractXMLWriter.

Definition at line 63 of file XMLWriter.h.

References setAttribute().

                                                                      {
            setAttribute(ns.append(":").append(name), value);
        }

Field Documentation

bool cheprep::XMLWriter::closed

protected

Definition at line 70 of file XMLWriter.h.

Referenced by closeDoc(), and XMLWriter().

IndentPrintWriter* cheprep::XMLWriter::writer

protected

Definition at line 71 of file XMLWriter.h.

Referenced by close(), closeTag(), openDoc(), openTag(), print(), printAttributes(), printComment(), println(), printPlain(), printTag(), referToDTD(), XMLWriter(), and ~XMLWriter().

---

The documentation for this class was generated from the following files:

• XMLWriter.h
• XMLWriter.cc