ACE/ACEXML/common/ZipCharStream.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    ZipCharStream.h
   6  *
   7  *  @author Krishnakumar B <kitty@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef _ACEXML_ZIPCHARSTREAM_H_
  12 #define _ACEXML_ZIPCHARSTREAM_H_
  13
  14 #ifdef USE_ZZIP
  15
  16 #include /**/ "ace/pre.h"
  17 #include "ACEXML/common/ACEXML_Export.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 #pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #include "ACEXML/common/CharStream.h"
  24 #include "ACEXML/common/Encoding.h"
  25 #include "zzip/zzip.h"
  26
  27 // Ugly wart to get aroung a macro version of read defined in zzip.h. Evil...
  28 #ifdef read
  29 #undef read
  30 #endif
  31
  32 /**
  33  * @class ACEXML_ZipCharStream
  34  *
  35  * An implementation of ACEXML_CharStream for reading input from a ZIP archive.
  36  */
  37 class ACEXML_Export ACEXML_ZipCharStream : public ACEXML_CharStream
  38 {
  39 public:
  40   /// Default constructor.
  41   ACEXML_ZipCharStream ();
  42
  43   /// Destructor
  44   virtual ~ACEXML_ZipCharStream ();
  45
  46   /// Open a file.
  47   int open (const ACEXML_Char *name);
  48
  49   /**
  50    * Returns the available ACEXML_Char in the buffer.  -1
  51    * if the object is not initialized properly.
  52    */
  53   virtual int available ();
  54
  55   /**
  56    * Close this stream and release all resources used by it.
  57    */
  58   virtual int close ();
  59
  60   /**
  61    * Read the next ACEXML_Char.  Return -1 if we are not able to
  62    * return an ACEXML_Char, 0 if EOF is reached, or 1 if succeed.
  63    */
  64   virtual int get (ACEXML_Char& ch);
  65
  66   /**
  67    * Read the next batch of ACEXML_Char strings
  68    */
  69   virtual int read (ACEXML_Char *str, size_t len);
  70
  71   /**
  72    *  Determine the encoding of the file.
  73    */
  74   virtual int determine_encoding ();
  75
  76
  77   /**
  78    * Peek the next ACEXML_Char in the CharStream.  Return the
  79    * character if success, -1 if EOF is reached.
  80    */
  81   virtual int peek ();
  82
  83   /**
  84    *  Resets the file pointer to the beginning of the stream.
  85    */
  86   virtual void rewind ();
  87
  88   /*
  89    * Get the character encoding for a byte stream or URI.
  90    */
  91   virtual const ACEXML_Char *getEncoding ();
  92
  93   /*
  94    * Get the systemId for the underlying CharStream
  95    */
  96   virtual const ACEXML_Char* getSystemId ();
  97
  98 protected:
  99   /** Read the next character as a normal character. Return -1 if EOF is
 100    *  reached, else return 0.
 101    */
 102   virtual int getchar_i (char& ch);
 103
 104   /**
 105    * Peek @c offset bytes into the stream and return the character at @c
 106    * offset. If EOF is reached, return -1.
 107    */
 108   virtual int peekchar_i (ACE_OFF_T offset = 0);
 109
 110 private:
 111 #if defined (ACE_USES_WCHAR)
 112   /**
 113    *  Read the next character from the stream taking into account the
 114    *  encoding of the file.
 115    */
 116   int get_i (ACEXML_Char& ch);
 117
 118   /**
 119    *  Return the next character from the stream taking into account the
 120    *  encoding of the file. Subsequent call to get() returns this
 121    *  character.
 122    */
 123   int peek_i ();
 124
 125 #endif /* ACE_USES_WCHAR */
 126
 127   ACEXML_Char*  filename_;
 128   ACEXML_Char*  encoding_;
 129   ACE_OFF_T     size_;
 130   ZZIP_FILE*    infile_;
 131   char          buf_[80];
 132   int           pos_;
 133   int           limit_;
 134 };
 135
 136 #include /**/ "ace/post.h"
 137
 138 #endif /* USE_ZZIP */
 139
 140 #endif /* _ACEXML_ZIPCHARSTREAM_H_ */