kvoctrain/kvoctrain/kvt-core/kvt-xml/XmlReader.h

   1 /* -*- C++ -*-
   2   $Id$
   3
   4   This file is part of KIllustrator.
   5   Copyright (C) 1998 Kai-Uwe Sattler (kus@iti.cs.uni-magdeburg.de)
   6
   7   modified for kvoctrain by Ewald Arnold kvoctrain@ewald-arnold.dein April ´99
   8 */
   9
  10 #ifndef XmlReader_h_
  11 #define XmlReader_h_
  12
  13 #include "XmlElement.h"
  14 #include "XmlTokenizer.h"
  15
  16 class KOXML_ISTREAM;
  17
  18 /**
  19  * The XMLReader class supports reading elements from a XML stream.
  20  *
  21  * @short     A class for reading XML elements from a stream.
  22  * @author    Kai-Uwe Sattler (kus@iti.cs.uni-magdeburg.de), modifications: Ewald Arnold (kvoctrain@ewald-arnold.de)
  23  * @version   2000/07/02
  24  */
  25 class XmlReader {
  26 public:
  27   /**
  28    * Construct a XmlReader instance for the given input stream.
  29    *
  30    * @param is   The open input stream.
  31    */
  32   XmlReader (KOXML_ISTREAM& is);
  33
  34   /**
  35    * Desctructor
  36    */
  37   ~XmlReader ();
  38
  39   /**
  40    * Check the input stream for a valid XML header.
  41    * A header should look like
  42    * <pre>
  43    *  <?xml version="1.0"?>
  44    *  <!doctype dtype system dtd>
  45    * </pre>
  46    * where @p dtype and @p dtd are simple strings.
  47    *
  48    * @return  @p true if the header conforms to XML, otherwise
  49    *          @p false.
  50    */
  51   bool validHeader ();
  52
  53   /**
  54    * Return the document type.
  55    *
  56    * @return   The name of the document type.
  57    */
  58   const KOXML_STRING& doctype () const;
  59
  60   /**
  61    * Return the name of the document type definition.
  62    *
  63    * @return   The name of the DTD.
  64    */
  65   const KOXML_STRING& dtd () const;
  66
  67   /**
  68    * Read a XML element from the stream. If the content is plain text
  69    * (no tag), an element with the pseudo ID @p #PCDATA is returned
  70    * and the text is available via method getText.
  71    *
  72    * @see #getText
  73    *
  74    * @param elem    The XML element which is initialized by the method.
  75    * @return        @p true for successful reading.
  76    */
  77   bool readElement (XmlElement& elem);
  78
  79   /**
  80    * Read plain text from the stream.
  81    *
  82    * @return The text as a string.
  83    */
  84   const KOXML_STRING& getText ();
  85
  86   /**
  87    * Returns current line number
  88    *
  89    * @return The current line number
  90    */
  91   inline int lineNumber() { return tokenizer.lineNumber(); }
  92
  93 protected:
  94   bool parseEndElement (XmlElement& elem);
  95   bool parseElement (const KOXML_STRING& id, XmlElement& elem);
  96   bool readAttributes (std::list<XmlAttribute>& attrib_list);
  97
  98 private:
  99   XmlTokenizer tokenizer;
 100   KOXML_STRING s_dtype,
 101                s_dtd;
 102   KOXML_STRING text;
 103 };
 104
 105 #endif