documentparser.hpp

sloedgy open sip stack source code

 /****************License************************************************
  *
  * Copyright 2000-2003.  ScanSoft, Inc.    
  *
  * Use of this software is subject to notices and obligations set forth 
  * in the SpeechWorks Public License - Software Version 1.2 which is 
  * included with this software. 
  *
  * ScanSoft is a registered trademark of ScanSoft, Inc., and OpenSpeech, 
  * SpeechWorks and the SpeechWorks logo are registered trademarks or 
  * trademarks of SpeechWorks International, Inc. in the United States 
  * and other countries.
  *
  ***********************************************************************/
 
#include <vxibuildopts.h>
#if P_VXI

 #include "vxi/VXIvalue.h"
 #include <string>
 #include "vxibuildopts.h"
 #include <xercesc/sax2/SAX2XMLReader.hpp>
 
 class DocumentConverter;
 class VXMLDocument;
 class SimpleLogger;
 extern "C" struct VXIcacheInterface;
 extern "C" struct VXIinetInterface;
 
 typedef std::basic_string<VXIchar> vxistring;
 
 
 class DocumentParser {
 public:
   static bool Initialize(unsigned int cacheSize);
   // One time initialization of DocumentParser interface.
   //
   // Returns: True - initialization succeeded.
   //          False - initialization failed.
 
   static void Deinitialize();
   // One time cleanup of DocumentParser interface.
 
   DocumentParser();   // May throw VXIException::OutOfMemory
   ~DocumentParser();
 
 public:
   int FetchDocument(const VXIchar * uri, const VXIMapHolder & properties,
                     VXIinetInterface * inet, VXIcacheInterface * cache,
                     SimpleLogger & log, VXMLDocument & document,
                     VXIMapHolder & docProperties, bool isDefaults = false,
                     VXIbyte **content = NULL, VXIulong *size = 0);
   // This retrieves a given URI and converts its contents into a VXMLElement
   // tree.  The returned 'document' will contain only the contents of the
   // <vxml> section.  Thus, only documents containing <vxml> are supported.
   //
   // Returns: -1 Out of memory?
   //           0 Success
   //           1 Invalid parameter
   //           2 Unable to open URI
   //           3 Unable to read from URI
   //           4 Unable to parse contents of URI
 
   static int FetchContent(const VXIchar * uri, const VXIMapHolder & properties,
                           VXIMapHolder & fetchInfo,
                           VXIinetInterface * inet, SimpleLogger & log,
                           const vxistring & encoding, vxistring & content);
   // Returns: -1 Out of memory?
   //           0 Success
   //           1 Invalid parameter, such as unsupported encoding
   //           2 Unable to open URI
   //           3 Unable to read from URI
 
 private:
   static int FetchBuffer(const VXIchar * uri, const VXIMapHolder & properties,
                          VXIMapHolder & fetchStatus,
                          VXIinetInterface * inet, SimpleLogger & log,
                          const VXIbyte * & buffer, VXIulong & bufferSize,
                          vxistring & docURI);
   static void ReleaseBuffer(const VXIbyte * & buffer);
   // FetchBuffer will create a memory buffer containing the contents of the
   // URI.  ReleaseBuffer must be called by the consumer to cleanup this memory.
   //
   // Returns: -1 Out of memory?
   //           0 Success
   //           1 Invalid parameter
   //           2 Unable to open URI
   //           3 Unable to read from URI
   //           4 Unsupported encoding
 
  
 private:
   xercesc::SAX2XMLReader * parser;
   DocumentConverter * converter;
   bool loadedVXML20;
 };

#endif