Ipelib: ipe::XmlParser Class Reference

Ipelib

- Main Page
- Modules
- Classes

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | Protected Member Functions | Protected Attributes

# ipe::XmlParser Class Reference
Ipe Base

Base class for XML stream parsing. More...

`#include <ipexml.h>`

Inherited by FontmapParser, and ipe::ImlParser.

List of all members.

## Public Member Functions

- XmlParser (DataSource &source)
- virtual ~XmlParser ()
- int parsePosition () const
- String parseToTag ()
- bool parseAttributes (XmlAttributes &attr, bool qm=false)
- bool parsePCDATA (String tag, String &pcdata)
- bool isTagChar (int ch)
- void getChar ()
- bool eos ()
- void skipWhitespace ()

## Protected Member Functions

- String parseToTagX ()

## Protected Attributes

- DataSource & iSource
- String iTopElement
- int iCh
- int iPos

## Detailed Description

Base class for XML stream parsing.

This is the base class for Ipe's XML parser. It only provides some utility functions for parsing tags and PCDATA. Derived classes implement the actual parsing using recursive descent parsers---after experimenting with various schemes for XML parsing, this seems to work best for Ipe.

Tag names and attribute names must consist of ASCII letters only. Only entities for '&', '<', and '>' are recognized.

## Constructor & Destructor Documentation

XmlParser::XmlParser | ( | DataSource & | source | ) |

Construct with a data source.

XmlParser::~XmlParser | ( |  | ) | `[virtual]`

Virtual destructor, so one can destroy through pointer.

## Member Function Documentation

int ipe::XmlParser::parsePosition | ( |  | ) | const`[inline]`

String XmlParser::parseToTag | ( |  | ) |

Parse whitespace and the name of a tag.

Like ParseToTagX, but silently skips over all tags whose name starts with "x-"

bool XmlParser::parseAttributes | ( | XmlAttributes & | attr,
|  | bool | qm = `false`
| ) |  |

Parse XML attributes.

Returns with stream just after >. Caller can check whether the tag ended with a / by checking attr.slash().

Set qm to true to allow a question mark just before the >.

bool XmlParser::parsePCDATA | ( | String | tag,
|  | String & | pcdata
| ) |  |

Parse PCDATA.

Checks whether the data is terminated by `</tag>`, and returns with stream past the >.

bool ipe::XmlParser::isTagChar | ( | int | ch | ) | `[inline]`

void ipe::XmlParser::getChar | ( |  | ) | `[inline]`

bool ipe::XmlParser::eos | ( |  | ) | `[inline]`

void XmlParser::skipWhitespace | ( |  | ) |

String XmlParser::parseToTagX | ( |  | ) | `[protected]`

Parse whitespace and the name of a tag.

If the tag is a closing tag, skips > and returns with stream after that. Otherwise, returns with stream just after the tag name.

Comments and <!TAG .. > are skipped silently.

## Member Data Documentation

DataSource& ipe::XmlParser::iSource`[protected]`

String ipe::XmlParser::iTopElement`[protected]`

int ipe::XmlParser::iCh`[protected]`

int ipe::XmlParser::iPos`[protected]`

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

- ipexml.h
- ipexml.cpp