/*
 * Copyright (c) 2007-2024 Real-Time Innovations, Inc. All rights reserved.
 * No duplications, whole or partial, manual or electronic, may be made
 * without express written permission.  Any such copies, or revisions thereof,
 * must display this notice unaltered.
 * This code contains trade secrets of Real-Time Innovations, Inc.
 */

#ifndef rtixml_log_h
#define rtixml_log_h


#ifndef rtixml_dll_h
  #include "rtixml/rtixml_dll.h"
#endif
#ifndef log_common_h
  #include "log/log_common.h"
#endif
#ifdef __cplusplus
    extern "C" {
#endif

/*e \file
  \brief Logging facilities for the rtixml module
*/

/*e \defgroup RTIXMLLog RTIXMLLog
  \ingroup RTIXMLModule

  @brief Logging facilities for rtixml module
*/

/*
  NOTE: When a new submodule is added to RTIXML, it must be given
  a number and entered here.  Because of the use of this id
  for logging, there are 16 submodule id's: 0x0000, 0x1000,...
  ..., 0xF000.
  It is suggested we put the modules here in an order that
  respects their dependencies: modules with a lower number
  cannot depend on modules with a higher number.
*/

/*e \ingroup RTIXMLLog
  Submodule ID for Parser submodule
*/
#define SUBMODULE_RTIXML_PARSER (0x1000)


/*e \ingroup RTIXMLLog
  Mask for turning on logging for only the parser submodule
*/
#define RTIXML_SUBMODULE_MASK_PARSER (0x0001)
/*e \ingroup RTIXMLLog
  Mask for turning on logging for all submoudles
*/
#define RTIXML_SUBMODULE_MASK_ALL RTI_LOG_SUBMODULE_MASK_ALL

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_BASE_NOT_FOUND_s;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_PARSE_FAILURE_ss;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_PARSE_FAILURE_s;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_PARSE_FAILURE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_PARSE_FAILURE_dss;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_PARSE_FILE_FAILURE_s;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_TAG_CREATION_FAILURE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_DTD_PARSER_PARSE_FAILURE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_UNEXPECTED_TAG_FAILURE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_TAG_NOT_SUPPORTED_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_UNEXPECTED_ATTRIBUTE_FAILURE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_UNEXPECTED_ATTRIBUTE_VALUE_FAILURE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_UNEXPECTED_TEXT_FAILURE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_REQUIRED_ATTRIBUTE_FAILURE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_INVALID_ATTRIBUTE_INT_VALUE_ddssdd;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_INVALID_ATTRIBUTE_INT_VALUE_W_UNBOUNDED_ddssddd;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_INVALID_ATTRIBUTE_UINT_VALUE_dussuu;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_INVALID_INT_VALUE_IN_EXPRESSION_ddsdd;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_INVALID_INT_VALUE_IN_EXPRESSION_W_UNBOUNDED_ddsddd;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_INVALID_UINT_VALUE_IN_EXPRESSION_dusuu;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_INTERNAL_FAILURE_s;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_INTERNAL_FAILURE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_ILLEGAL_VALUE_ds;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_ENV_VAR_NOT_DEFINED_s;

/*e \ingroup RTIXMLLog
*/
extern RTIXMLDllVariable const struct RTILogMessage
RTIXML_LOG_PARSER_DUPLICATE_TAG_PARSE_FAILURE_dsd;


#ifdef __cplusplus
  }	/* extern "C" */
#endif

#endif /* rtixml_log_h */