asn1CppEvtHndlr64.h

Go to the documentation of this file.

/*
 * Copyright (c) 1997-2023 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.
 *
 *****************************************************************************/

// rtsrc/asn1CppEvtHndlr64.h - this .h file defines the object that is
// registered for the C++ version of the event handler feature.

#ifndef _ASN1CPPEVTHNDLR64_H_
#define _ASN1CPPEVTHNDLR64_H_

#include "rtsrc/asn1CppEvtHndlr.h"

#ifndef _WIN32
/* Set gcc to ignore the "virtual override intended?" warning for this header
   file.  It is not an error - the override is indeed intended (ASN-9912).
   However, a customer who has warnings set as errors (such as for ASN-11080)
   will get compilation failures if it is not marked as ignored...
*/
#pragma GCC diagnostic ignored "-Woverloaded-virtual"
#endif

// The following pure abstract class defines the event handler interface
// callback functions that are invoked as a message is parsed..
class EXTRTCLASS Asn1NamedEventHandler64 : public Asn1NullEventHandler {
 public:
   Asn1NamedEventHandler64() {}
   virtual ~Asn1NamedEventHandler64() {}

   // Start element callback function.  This is invoked upon entry into
   // an element in a constructed type (SEQUENCE, SET, SEQUENCE OF,
   // SET OF, or CHOICE).  A single char* argument (name) is passed.
   virtual void startElement (const char* name, OSSIZE index) = 0;
#if __cplusplus >= 201103L
   using Asn1NullEventHandler::startElement;
#endif

   // End element callback function.  This is invoked upon exit from
   // a constructed type.  A single char* argument (name) is passed.
   virtual void endElement (const char* name, OSSIZE index) = 0;
#if __cplusplus >= 201103L
   using Asn1NullEventHandler::endElement;
#endif

   // Data callback functions.  These are invoked when data contents
   // are parsed from a field.  A separate callback is invoked for
   // each of the ASN.1 primitive data types..

   virtual void bitStrValue (OSSIZE numbits, const OSOCTET* data) {
      OS_UNUSED_ARG(numbits);  OS_UNUSED_ARG(data);
   }
#if __cplusplus >= 201103L
   using Asn1NamedEventHandler::bitStrValue;
#endif

   virtual void octStrValue (OSSIZE numocts, const OSOCTET* data) {
      OS_UNUSED_ARG(numocts);  OS_UNUSED_ARG(data);
   }
#if __cplusplus >= 201103L
   using Asn1NamedEventHandler::octStrValue;
#endif

   virtual void charStrValue (OSSIZE nchars, const OSUTF8CHAR* value) {
      OS_UNUSED_ARG(nchars); OS_UNUSED_ARG(value);
   }
#if __cplusplus >= 201103L
   using Asn1NamedEventHandler::charStrValue;
#endif

   virtual void charStrValue (OSSIZE nchars, OSUNICHAR* data) {
      OS_UNUSED_ARG(nchars); OS_UNUSED_ARG(data);
   }

   virtual void charStrValue (OSSIZE nchars, OS32BITCHAR* data) {
      OS_UNUSED_ARG(nchars); OS_UNUSED_ARG(data);
   }

   virtual void openTypeValue (OSSIZE numocts, const OSOCTET* data) {
      OS_UNUSED_ARG(numocts); OS_UNUSED_ARG(data);
   }
#if __cplusplus >= 201103L
   using Asn1NamedEventHandler::openTypeValue;
#endif

   // The following static methods are invoked from within the generated
   // code to call the various user-defined event handler methods ..

   EXTRTMETHOD static void invokeStartElement
      (OSCTXT* pCtxt, const char* name, OSSIZE index);

   EXTRTMETHOD static void invokeEndElement
      (OSCTXT* pCtxt, const char* name, OSSIZE index);

   EXTRTMETHOD static void invokeBitStrValue
      (OSCTXT* pCtxt, OSSIZE numbits, const OSOCTET* data);

   EXTRTMETHOD static void invokeOctStrValue
      (OSCTXT* pCtxt, OSSIZE numocts, const OSOCTET* data);

   EXTRTMETHOD static void invokeCharStrValue
      (OSCTXT* pCtxt, OSSIZE nchars, OSUNICHAR* data);

   EXTRTMETHOD static void invokeCharStrValue
      (OSCTXT* pCtxt, OSSIZE nchars, OS32BITCHAR* data);

   EXTRTMETHOD static void invokeCharStrValue
      (OSCTXT* pCtxt, OSSIZE nchars, const OSUTF8CHAR* data);

   EXTRTMETHOD static void invokeOpenTypeValue
      (OSCTXT* pCtxt, OSSIZE numocts, const OSOCTET* data);

} ;

// Null event handler class.  This class contains an empty implementation
// of all user methods..

class EXTRTCLASS Asn1NullEventHandler64 : public Asn1NamedEventHandler64 {
 public:
   virtual void startElement (const char* , OSSIZE ) {}
   virtual void endElement (const char* , OSSIZE ) {}
} ;

#endif