ACE/ACEXML/common/CharStream.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    CharStream.h
   6  *
   7  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef _ACEXML_CHARSTREAM_H_
  12 #define _ACEXML_CHARSTREAM_H_
  13
  14 #include /**/ "ace/pre.h"
  15 #include "ACEXML/common/ACEXML_Export.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 #pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20 #include "ACEXML/common/XML_Types.h"
  21
  22 /**
  23  * @class ACEXML_CharStream
  24  *
  25  * ACEXML_CharStream is an abstract class (interface) which defines the
  26  * basic opertions a parser could use to retrieve XML charater sequence.
  27  * The sequence can be read from a file or a character buffer.
  28  */
  29 class ACEXML_Export ACEXML_CharStream
  30 {
  31 public:
  32   /**
  33    * Virtual destructor, must have.
  34    */
  35   virtual ~ACEXML_CharStream () = 0;
  36
  37   /**
  38    * Returns the available ACEXML_Char in the buffer.  -1
  39    * if the object is not initialized properly.
  40    */
  41   virtual int available () = 0;
  42
  43   /**
  44    * Close this stream and release all resources used by it.
  45    */
  46   virtual int close () = 0;
  47
  48   /**
  49    * Read the next ACEXML_Char.  Return -1 if we are not able to
  50    * return an ACEXML_Char, 0 if EOS is reached, or 1 if succeed.
  51    */
  52   virtual int get (ACEXML_Char& ch) = 0;
  53
  54   /**
  55    * Read the next batch of ACEXML_Char strings
  56    */
  57   virtual int read (ACEXML_Char *str, size_t len) = 0;
  58
  59   /**
  60    * Peek the next ACEXML_Char in the CharStream.  Return the
  61    * character if succeess, -1 if EOS is reached.
  62    */
  63   virtual int peek () = 0;
  64
  65   /**
  66    *  Resets the pointer to the beginning of the stream.
  67    */
  68   virtual void rewind () = 0;
  69
  70   /*
  71    * Get the character encoding for a byte stream or URI.
  72    */
  73   virtual const ACEXML_Char *getEncoding ()  = 0;
  74
  75   /*
  76    * Get the systemId for the underlying CharStream
  77    */
  78   virtual const ACEXML_Char* getSystemId () = 0;
  79 };
  80
  81 #include /**/ "ace/post.h"
  82
  83
  84 #endif /* _ACEXML_CHARSTREAM_H_ */