status_enum.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
 * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_status_enum
#define _H_status_enum
/*  FILE: status_enum.h
*********************************************************************
*                                                                    *
*                         P U R P O S E                              *
*                                                                    *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date             init     comment
----------------------------------------------------------------------
03-jan-92    abb      move statusT from global.h to here
18-apr-96    abb      adapted for gr8cgi project
29-sep-13    abb      split out from status.h for use without libncx
*/
 
/* YPW-1746:
 * Some customer C files including this file before including
 * procdefs.h; Used to work in 18.10 branch but YPACK is now
 * used from procdefs.h
 */
#ifndef _H_procdefs
#include "procdefs.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************************************************************
*                                                                    *
*                          C O N S T A N T S                         *
*                                                                    *
*********************************************************************/
 
 
/* group the error messages by severity */
#define ERR_INT_BASE         0        /* really 2, hold 'NO_ERR' here */
#define ERR_FIRST_INT        2
#define ERR_SYS_BASE         100
#define ERR_USR_BASE         200
#define ERR_WARN_BASE        1000   // ! was 400
#define ERR_INFO_BASE        2000   // ! was 900
 
/* for backward compatability */
#define statusT         status_t
 
#define SET_ERROR(E) set_error(__FILE__, __LINE__, E, 0)
 
 
#define IS_INT_ERR(E) (((E) > 0) && ((E) < ERR_SYS_BASE))
 
 
#define IS_SYS_ERR(E) (((E) >= ERR_SYS_BASE) && ((E) < ERR_USR_BASE))
 
 
#define IS_USR_ERR(E) (((E) >= ERR_USR_BASE) && ((E) < ERR_WARN_BASE))
 
 
#define IS_WARN_ERR(E) (((E) >= ERR_WARN_BASE) && ((E) < ERR_INFO_BASE))
 
 
#define IS_INFO_ERR(E) (((E) >= ERR_INFO_BASE) && ((E) < ERR_LAST_INFO))
 
 
#if defined(INT_ERROR_CRASH) || defined(DEBUG2)
#define FLAG_INT_ERROR set_error(__FILE__, __LINE__, ERR_INTERNAL_VAL, 0)
#else
#define FLAG_INT_ERROR \
    log_write("\nError: INTERNAL in file '%s', function '%s', line %d", \
              __FILE__, __FUNCTION__, __LINE__)
#endif  // INT_ERROR_CRASH
 
 
/********************************************************************
*                                   *
*                T Y P E S                  *
*                                   *
*********************************************************************/
 
typedef enum errtyp_t_
{
    ERR_TYP_NONE,         
    ERR_TYP_INTERNAL,     
    ERR_TYP_SYSTEM,       
    ERR_TYP_USER,         
    ERR_TYP_WARN,         
    ERR_TYP_INFO          
} errtyp_t;
 
 
typedef enum status_t_
{
    NO_ERR,
 
    ERR_END_OF_FILE,
 
    ERR_INTERNAL_PTR=ERR_FIRST_INT,
 
    ERR_INTERNAL_MEM,
 
    ERR_INTERNAL_VAL,
 
    ERR_INTERNAL_BUFF,
 
    ERR_INTERNAL_QDEL,
 
    ERR_INTERNAL_INIT_SEQ,
 
    ERR_QNODE_NOT_HDR,
 
    ERR_QNODE_NOT_DATA,
 
    ERR_BAD_QLINK,
 
    ERR_Q_ALREADY,
 
    ERR_TOO_MANY_ENTRIES,
 
    ERR_XML2_FAILED,
 
    ERR_RWLOCK_ERR,
 
    ERR_MUTEX_ERR,
 
    ERR_HEAPCHK_ERR,
 
    ERR_SPIN_LOCK_ERR,
 
    ERR_GENERAL_ERR,
 
    ERR_LAST_INT_ERR,
 
    ERR_FIL_OPEN=ERR_SYS_BASE,
 
    ERR_FIL_READ,
 
    ERR_FIL_CLOSE,
 
    ERR_FIL_WRITE,
 
    ERR_FIL_CHDIR,
 
    ERR_FIL_STAT,
 
    ERR_BUFF_OVFL,
 
    ERR_FIL_DELETE,
 
    ERR_FIL_SETPOS,
 
    ERR_DB_CONNECT_FAILED,
 
    ERR_DB_ENTRY_EXISTS,
 
    ERR_DB_NOT_FOUND,
 
    ERR_DB_QUERY_FAILED,
 
    ERR_DB_DELETE_FAILED,
 
    ERR_DB_WRONG_CKSUM,
 
    ERR_DB_WRONG_TAGTYPE,
 
    ERR_DB_READ_FAILED,
 
    ERR_DB_WRITE_FAILED,
 
    ERR_DB_INIT_FAILED,
 
    ERR_TR_BEEP_INIT,
 
    ERR_TR_BEEP_NC_INIT,
 
    ERR_XML_READER_INTERNAL,
 
    ERR_OPEN_DIR_FAILED,
 
    ERR_READ_DIR_FAILED,
 
    ERR_LAST_SYS_ERR,
 
    ERR_NO_CFGFILE=ERR_USR_BASE,
 
    ERR_NO_SRCFILE,
 
    ERR_PARSPOST_RD_INPUT,
 
    ERR_FIL_BAD_DRIVE,
 
    ERR_FIL_BAD_PATH,
 
    ERR_FIL_BAD_FILENAME,
 
    ERR_DUP_VALPAIR,
 
    ERR_PAGE_NOT_HANDLED,
 
    ERR_PAGE_ACCESS_DENIED,
 
    ERR_MISSING_FORM_PARAMS,
 
    ERR_FORM_STATE,
 
    ERR_DUP_NS,
 
    ERR_XML_READER_START_FAILED,
 
    ERR_XML_READER_READ,
 
    ERR_XML_READER_NODETYP,
 
    ERR_XML_READER_NULLNAME,
 
    ERR_XML_READER_NULLVAL,
 
    ERR_XML_READER_WRONGNAME,
 
    ERR_XML_READER_WRONGVAL,
 
    ERR_XML_READER_WRONGEL,
 
    ERR_XML_READER_EXTRANODES,
 
    ERR_XML_READER_EOF,
 
    ERR_NCX_WRONG_LEN,
 
    ERR_NCX_ENTRY_EXISTS,
 
    ERR_NCX_DUP_ENTRY,
 
    ERR_NCX_NOT_FOUND,
 
    ERR_NCX_MISSING_FILE,
 
    ERR_NCX_UNKNOWN_PARM,
 
    ERR_NCX_INVALID_NAME,
 
    ERR_NCX_UNKNOWN_NS,
 
    ERR_NCX_WRONG_NS,
 
    ERR_NCX_WRONG_TYPE,
 
    ERR_NCX_WRONG_VAL,
 
    ERR_NCX_MISSING_PARM,
 
    ERR_NCX_EXTRA_PARM,
 
    ERR_NCX_EMPTY_VAL,
 
    ERR_NCX_MOD_NOT_FOUND,
 
    ERR_NCX_LEN_EXCEEDED,
 
    ERR_NCX_INVALID_TOKEN,
 
    ERR_NCX_UNENDED_QSTRING,
 
    ERR_NCX_READ_FAILED,
 
    ERR_NCX_INVALID_NUM,
 
    ERR_NCX_INVALID_HEXNUM,
 
    ERR_NCX_INVALID_REALNUM,
 
    ERR_NCX_EOF,
 
    ERR_NCX_WRONG_TKTYPE,
 
    ERR_NCX_WRONG_TKVAL,
 
    ERR_NCX_BUFF_SHORT,
 
    ERR_NCX_INVALID_RANGE,
 
    ERR_NCX_OVERLAP_RANGE,
 
    ERR_NCX_DEF_NOT_FOUND,
 
 
    ERR_NCX_DEFSEG_NOT_FOUND,
 
    ERR_NCX_TYPE_NOT_INDEX,
 
    ERR_NCX_INDEX_TYPE_NOT_FOUND,
 
    ERR_NCX_TYPE_NOT_MDATA,
 
    ERR_NCX_MDATA_NOT_ALLOWED,
 
    ERR_NCX_TOP_NOT_FOUND,
 
    ERR_NCX_IN_USE,
 
    ERR_NCX_INVALID_VALUE,
 
    ERR_NCX_TOO_BIG,
 
    ERR_NCX_MISSING_ATTRIBUTE,
 
    ERR_NCX_BAD_ATTRIBUTE,
 
    ERR_NCX_UNKNOWN_ATTRIBUTE,
 
    ERR_NCX_MISSING_ELEMENT,
 
    ERR_NCX_BAD_ELEMENT,
 
    ERR_NCX_UNKNOWN_ELEMENT,
 
    ERR_NCX_UNKNOWN_NAMESPACE,
 
    ERR_NCX_ACCESS_DENIED,
 
    ERR_NCX_LOCK_DENIED,
 
    ERR_NCX_RESOURCE_DENIED,
 
    ERR_NCX_ROLLBACK_FAILED,
 
    ERR_NCX_DATA_EXISTS,
 
    ERR_NCX_DATA_MISSING,
 
    ERR_NCX_OPERATION_NOT_SUPPORTED,
 
    ERR_NCX_OPERATION_FAILED,
 
    ERR_NCX_PARTIAL_OPERATION,
 
    ERR_NCX_WRONG_NAMESPACE,
 
    ERR_NCX_WRONG_NODEDEPTH,
 
    ERR_NCX_WRONG_OWNER,
 
    ERR_NCX_WRONG_ELEMENT,
 
    ERR_NCX_WRONG_ORDER,
 
    ERR_NCX_EXTRA_NODE,
 
    ERR_NCX_WRONG_NODETYP,
 
    ERR_NCX_WRONG_NODETYP_SIM,
 
    ERR_NCX_WRONG_NODETYP_CPX,
 
    ERR_NCX_WRONG_DATATYP,
 
    ERR_NCX_WRONG_DATAVAL,
 
    ERR_NCX_NUMLEN_TOOBIG,
 
    ERR_NCX_NOT_IN_RANGE,
 
    ERR_NCX_WRONG_NUMTYP,
 
    ERR_NCX_EXTRA_ENUMCH,
 
 
    ERR_NCX_VAL_NOTINSET,
 
    ERR_NCX_EXTRA_LISTSTR,
 
    ERR_NCX_UNKNOWN_OBJECT,
 
    ERR_NCX_EXTRA_PARMINST,
 
    ERR_NCX_EXTRA_CHOICE,
 
    ERR_NCX_MISSING_CHOICE,
 
    ERR_NCX_CFG_STATE,
 
    ERR_NCX_UNKNOWN_APP,
 
    ERR_NCX_UNKNOWN_TYPE,
 
    ERR_NCX_NO_ACCESS_ACL,
 
    ERR_NCX_NO_ACCESS_LOCK,
 
    ERR_NCX_NO_ACCESS_STATE,
 
    ERR_NCX_NO_ACCESS_MAX,
 
 
    ERR_NCX_WRONG_INDEX_TYPE,
 
 
    ERR_NCX_WRONG_INSTANCE_TYPE,
 
 
    ERR_NCX_MISSING_INDEX,
 
    ERR_NCX_CFG_NOT_FOUND,
 
    ERR_NCX_EXTRA_ATTR,
 
    ERR_NCX_MISSING_ATTR,
 
    ERR_NCX_MISSING_VAL_INST,
 
    ERR_NCX_EXTRA_VAL_INST,
 
    ERR_NCX_NOT_WRITABLE,
 
    ERR_NCX_INVALID_PATTERN,
 
    ERR_NCX_WRONG_VERSION,
 
    ERR_NCX_CONNECT_FAILED,
 
    ERR_NCX_UNKNOWN_HOST,
 
    ERR_NCX_SESSION_FAILED,
 
    ERR_NCX_AUTH_FAILED,
 
    ERR_NCX_UNENDED_COMMENT,
 
    ERR_NCX_INVALID_CONCAT,
 
    ERR_NCX_IMP_NOT_FOUND,
 
    ERR_NCX_MISSING_TYPE,
 
    ERR_NCX_RESTRICT_NOT_ALLOWED,
 
    ERR_NCX_REFINE_NOT_ALLOWED,
 
    ERR_NCX_DEF_LOOP,
 
    ERR_NCX_DEFCHOICE_NOT_OPTIONAL,
 
    ERR_NCX_IMPORT_LOOP,
 
    ERR_NCX_INCLUDE_LOOP,
 
    ERR_NCX_EXP_MODULE,
 
    ERR_NCX_EXP_SUBMODULE,
 
    ERR_NCX_PREFIX_NOT_FOUND,
 
    ERR_NCX_IMPORT_ERRORS,
 
    ERR_NCX_PATTERN_FAILED,
 
    ERR_NCX_INVALID_TYPE_CHANGE,
 
    ERR_NCX_MANDATORY_NOT_ALLOWED,
 
    ERR_NCX_UNIQUE_TEST_FAILED,
 
    ERR_NCX_MAX_ELEMS_VIOLATION,
 
    ERR_NCX_MIN_ELEMS_VIOLATION,
 
    ERR_NCX_MUST_TEST_FAILED,
 
    ERR_NCX_DATA_REST_VIOLATION,
 
    ERR_NCX_INSERT_MISSING_INSTANCE,
 
    ERR_NCX_NOT_CONFIG,
 
    ERR_NCX_INVALID_CONDITIONAL,
 
    ERR_NCX_USING_OBSOLETE,
 
    ERR_NCX_INVALID_AUGTARGET,
 
    ERR_NCX_DUP_REFINE_STMT,
 
    ERR_NCX_INVALID_DEV_STMT,
 
    ERR_NCX_INVALID_XPATH_EXPR,
 
    ERR_NCX_INVALID_INSTANCEID,
 
 
    ERR_NCX_MISSING_INSTANCE,
 
    ERR_NCX_UNEXPECTED_INSERT_ATTRS,
 
    ERR_NCX_INVALID_UNIQUE_NODE,
 
    ERR_NCX_INVALID_DUP_IMPORT,
 
    ERR_NCX_INVALID_DUP_INCLUDE,
 
    ERR_NCX_AMBIGUOUS_CMD,
 
    ERR_NCX_UNKNOWN_MODULE,
 
    ERR_NCX_UNKNOWN_VERSION,
 
    ERR_NCX_VALUE_NOT_SUPPORTED,
 
    ERR_NCX_LEAFREF_LOOP,
 
    ERR_NCX_VAR_NOT_FOUND,
 
    ERR_NCX_VAR_READ_ONLY,
 
    ERR_NCX_DEC64_BASEOVFL,
 
    ERR_NCX_DEC64_FRACOVFL,
 
    ERR_NCX_RPC_WHEN_FAILED,
 
    ERR_NCX_NO_MATCHES,
 
    ERR_NCX_MISSING_REFTARGET,
 
    ERR_NCX_CANDIDATE_DIRTY,
 
    ERR_NCX_TIMEOUT,
 
    ERR_NCX_GET_SCHEMA_DUPLICATES,
 
    ERR_NCX_XPATH_NOT_NODESET,
 
    ERR_NCX_XPATH_NODESET_EMPTY,
 
    ERR_NCX_IN_USE_LOCKED,
 
    ERR_NCX_IN_USE_COMMIT,
 
    ERR_NCX_SUBMOD_NOT_LOADED,
 
    ERR_NCX_ACCESS_READ_ONLY,
 
    ERR_NCX_CONFIG_NOT_TARGET,
 
    ERR_NCX_MISSING_RBRACE,
 
    ERR_NCX_INVALID_FRAMING,
 
    ERR_NCX_PROTO11_NOT_ENABLED,
 
    ERR_NCX_CC_NOT_ACTIVE,
 
    ERR_NCX_MULTIPLE_MATCHES,
 
    ERR_NCX_NO_DEFAULT,
 
    ERR_NCX_MISSING_KEY,
 
    ERR_NCX_TOP_LEVEL_MANDATORY_FAILED,
 
    ERR_NCX_RESOURCE_UNKNOWN,
 
    ERR_NCX_UNENDED_BLOCK,
 
    ERR_NCX_EVAL_VERSION,
 
    ERR_NCX_RESOURCE_INSTANCE_UNKNOWN,
 
    ERR_NCX_UNEXPECTED_INPUT,
 
    ERR_NCX_METHOD_NOT_ALLOWED,
 
    ERR_NCX_QPARAM_NOT_ALLOWED,
 
    ERR_NCX_PRECONDITION_FAILED,
 
    ERR_NCX_HEADER_NOT_ALLOWED,
 
    ERR_NCX_RUNNING_NOT_VALID,
 
    ERR_NCX_BINARY_FILE,
 
    ERR_NCX_IMPORT_DEPENDENCY,
 
    ERR_NCX_UNLOAD_NOT_ALLOWED,
 
    ERR_NCX_EVAL_LIMIT_REACHED,
 
    ERR_NCX_SELECT_FAILED,
 
    ERR_NCX_SESSION_DROPPED,
 
    ERR_NCX_INVALID_MEDIA,
 
    ERR_NCX_INVALID_FORMAT,
 
    ERR_NCX_INVALID_CONT_TYPE,
 
    ERR_NCX_UNKNOWN_QUERY_PARM,
 
    ERR_NCX_MISSING_ACCEPT_HEADER,
 
    ERR_NCX_PASSWORD_TOO_SHORT,
 
    ERR_NCX_MISSING_INPUT,
 
    ERR_NCX_VALUE_DISABLED,
 
    ERR_NCX_WHEN_KEY,
 
    ERR_NCX_IF_FEATURE_KEY,
 
    ERR_NCX_TOO_MANY_XML,
 
    ERR_NCX_JSON_NOT_YET,
 
    ERR_NCX_MISSING_DATA_DEF_STMT,
 
    ERR_NCX_CONDITIONAL_DEFVAL,
 
    ERR_NCX_INVALID_ESCSTR,
 
    ERR_NCX_INVALID_STATUS_REF,
 
    ERR_NCX_TEMPLATE_NOT_FOUND,
 
    ERR_NCX_SHUTDOWN_MODE,
 
    ERR_NCX_NOTIFS_NOT_ENABLED,
 
    ERR_NCX_MAINTENANCE_MODE,
 
    ERR_NCX_NOTIF_DSCP_UNAVAILABLE,
 
    ERR_NCX_NOTIF_ENCODING_UNSUPPORTED,
 
    ERR_NCX_NOTIF_FILTER_UNAVAILABLE,
 
    ERR_NCX_NOTIF_FILTER_UNSUPPORTED,
 
    ERR_NCX_NOTIF_INSUFFICIENT_RESOURCES,
 
    ERR_NCX_NOTIF_NO_SUCH_SUBSCRIPTION,
 
    ERR_NCX_NOTIF_REPLAY_UNSUPPORTED,
 
    ERR_NCX_NOTIF_STREAM_UNAVAILABLE,
 
    ERR_NCX_PUSH_CANT_EXCLUDE,
 
    ERR_NCX_PUSH_DATASTORE_NOT_SUBSCRIBABLE,
 
    ERR_NCX_PUSH_NO_SUCH_RESYNC,
 
    ERR_NCX_PUSH_ON_CHANGE_UNSUPPORTED,
 
    ERR_NCX_PUSH_ON_CHANGE_SYNC_UNSUPPORTED,
 
    ERR_NCX_PUSH_PERIOD_UNSUPPORTED,
 
    ERR_NCX_PUSH_UPDATE_TOO_BIG,
 
    ERR_NCX_PUSH_SYNC_TOO_BIG,
 
    ERR_NCX_PUSH_UNCHANGING_SELECTION,
 
    ERR_NCX_NESTED_EDITOP,
 
    ERR_NCX_MALFORMED_MESSAGE,
 
    ERR_LAST_USR_ERR,
 
    ERR_MAKFILE_DUP_SRC=ERR_WARN_BASE,
 
    ERR_INC_NOT_FOUND,
 
    ERR_CMDLINE_VAL,
 
    ERR_CMDLINE_OPT,
 
    ERR_CMDLINE_OPT_UNKNOWN,
 
    ERR_CMDLINE_SYNTAX,
 
    ERR_CMDLINE_VAL_REQUIRED,
 
    ERR_FORM_INPUT,
 
    ERR_FORM_UNKNOWN,
 
    ERR_NCX_NO_INSTANCE,
 
    ERR_NCX_SESSION_CLOSED,
 
    ERR_NCX_DUP_IMPORT,
 
    ERR_NCX_PREFIX_DUP_IMPORT,
 
    ERR_NCX_TYPDEF_NOT_USED,
 
    ERR_NCX_GRPDEF_NOT_USED,
 
    ERR_NCX_IMPORT_NOT_USED,
 
    ERR_NCX_DUP_UNIQUE_COMP,
 
    ERR_NCX_STMT_IGNORED,
 
    ERR_NCX_DUP_INCLUDE,
 
    ERR_NCX_INCLUDE_NOT_USED,
 
    ERR_NCX_DATE_PAST,
 
    ERR_NCX_DATE_FUTURE,
 
    ERR_NCX_ENUM_VAL_ORDER,
 
    ERR_NCX_BIT_POS_ORDER,
 
    ERR_NCX_INVALID_STATUS,
 
    ERR_NCX_DUP_AUGNODE,
 
    ERR_NCX_DUP_IF_FEATURE,
 
    ERR_NCX_USING_DEPRECATED,
 
    ERR_NCX_MAX_KEY_CHECK,
 
    ERR_NCX_EMPTY_XPATH_RESULT,
 
    ERR_NCX_NO_XPATH_ANCESTOR,
 
    ERR_NCX_NO_XPATH_PARENT,
 
    ERR_NCX_NO_XPATH_CHILD,
 
    ERR_NCX_NO_XPATH_DESCENDANT,
 
    ERR_NCX_NO_XPATH_NODES,
 
    ERR_NCX_BAD_REV_ORDER,
 
    ERR_NCX_DUP_PREFIX,
 
    ERR_NCX_IDLEN_EXCEEDED,
 
    ERR_NCX_LINELEN_EXCEEDED,
 
    ERR_NCX_RCV_UNKNOWN_CAP,
 
    ERR_NCX_RCV_INVALID_MODCAP,
 
    ERR_NCX_USING_ANYXML,
 
    ERR_NCX_USING_BADDATA,
 
    ERR_NCX_USING_STRING,
 
    ERR_NCX_USING_RESERVED_NAME,
 
    ERR_NCX_CONF_PARM_EXISTS,
 
    ERR_NCX_NO_REVISION,
 
    ERR_NCX_DEPENDENCY_ERRORS,
 
    ERR_NCX_TOP_LEVEL_MANDATORY,
 
    ERR_NCX_FILE_MOD_MISMATCH,
 
    ERR_NCX_UNIQUE_CONDITIONAL_MISMATCH,
 
    ERR_NCX_SIL_BUSY,
 
    ERR_NCX_XPATH_COMPARE,
 
    ERR_NCX_XPATH_OBJ_COMPARE,
 
    ERR_NCX_DUP_REVISION,
 
    ERR_NCX_NONCONFIG_XPATH,
 
    ERR_NCX_MANDATORY_AUGEXTERN,
 
    ERR_NCX_XPATH_SELF_REF,
 
    ERR_NCX_XPATH_REF_REMOVED,
 
    ERR_LAST_WARN,
 
    ERR_PARS_SECDONE=ERR_INFO_BASE,
 
    ERR_NCX_SKIPPED,
 
    ERR_NCX_CANCELED,
 
    ERR_NCX_LOOP_ENDED,
 
    ERR_NCX_FOUND_INLINE,
 
    ERR_NCX_FOUND_URL,
 
    ERR_NCX_FOUND_GET2,
 
    ERR_NCX_NOMATCH_GET2,
 
    ERR_LAST_INFO
 
} YPACK status_t;
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif     /* _H_status_enum */