rtSaxCppParserIF.h

/*
 * Copyright (c) 2003-2022 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/

#ifndef __RTSAXCPPPARSERIF_H_
#define __RTSAXCPPPARSERIF_H_

#include "rtxsrc/rtxErrCodes.h"
#include "rtxsrc/OSRTInputStreamIF.h"
#include "rtxmlsrc/osrtxml.h"
#include "rtxmlsrc/rtSaxDefs.h"


class EXTXMLCLASS OSXMLErrorInfo {
 public:
   virtual ~OSXMLErrorInfo () {}
   virtual void resetErrorInfo () = 0;
   virtual void setErrorInfo (int status, const char* file = 0, int line = 0) = 0;
   virtual int  getErrorInfo (int* status, const char** file, int* line) = 0;
};

class EXTERNXML OSXMLErrorHandler
{
 public:
    virtual ~OSXMLErrorHandler () {}

   virtual void warning() = 0;

   virtual void error() = 0;

   virtual void fatalError() = 0;

   virtual void resetErrors() = 0;
};

class EXTERNXML OSXMLContentHandler
{
 public:
   virtual ~OSXMLContentHandler() {}

   virtual int characters
   (
       const OSUTF8CHAR* const chars,
       unsigned int      length
   ) = 0;

   virtual int endElement
   (
      const OSUTF8CHAR* const uri,
      const OSUTF8CHAR* const localname,
      const OSUTF8CHAR* const qname
   ) = 0;

   virtual int startElement
   (
      const   OSUTF8CHAR* const  uri,
      const   OSUTF8CHAR* const  localname,
      const   OSUTF8CHAR* const  qname,
      const   OSUTF8CHAR* const* attrs
   ) = 0;

};

class EXTXMLCLASS OSXMLBase {
protected:
   OSXMLBase () {}

   virtual ~OSXMLBase () {}
public:
   virtual void release () = 0;
};

#define DECLARE_XMLBASEIMP \
public: void release () { delete this; }

class EXTERNXML OSXMLReaderClass : public OSXMLBase
{
 public:

   virtual int parse () = 0;
   virtual int parse (OSRTInputStreamIF& source) = 0;

   virtual int parse
   (
      const char* const pBuffer,
      size_t            bufSize
   ) = 0;

   virtual int parse
   (
       const char* const systemId
   ) = 0;
};

class EXTERNXML OSXMLDefaultHandlerIF :
   public OSXMLContentHandler, public OSXMLErrorInfo
{
 public:
   virtual ~OSXMLDefaultHandlerIF () {}
#if 0
   // These are already defined in OSXMLContentHandler
   virtual int startElement
      (const OSUTF8CHAR* const uri,
       const OSUTF8CHAR* const localname,
       const OSUTF8CHAR* const qname,
       const OSUTF8CHAR* const* attrs) = 0;

   virtual int characters
      (const OSUTF8CHAR* const chars, unsigned int length) = 0;

   virtual int endElement
      (const OSUTF8CHAR* const uri,
       const OSUTF8CHAR* const localname,
       const OSUTF8CHAR* const qname) = 0;
#endif
   virtual void startDocument() = 0;
   virtual void endDocument () = 0;

   virtual int finalize () = 0;
} ;

class EXTXMLCLASS OSXMLParserCtxtIF {
 public:
   virtual ~OSXMLParserCtxtIF () {}
   virtual OSRTInputStreamIF* createInputStream () = 0;
   virtual OSRTInputStreamIF* createFileInputStream
      (const char* const filename) = 0;
   virtual OSRTInputStreamIF* createMemoryInputStream
      (OSOCTET* pMemBuf, size_t bufSize) = 0;
   virtual OSCTXT* getContext () = 0;
   virtual const OSUTF8CHAR* parseQName (const OSUTF8CHAR* const qname) = 0;
};

#ifdef __cplusplus
extern "C" {
#endif

OSXMLReaderClass* rtSaxCppCreateXmlReader
(OSXMLParserCtxtIF* pContext, OSXMLDefaultHandlerIF* pSaxHandler);

int rtSaxCppEnableThreadSafety ();

void rtSaxCppLockXmlLibrary ();

void rtSaxCppUnlockXmlLibrary ();

#ifdef __cplusplus
}
#endif

#endif /* __RTSAXCPPPARSERIF_H_ */