mirror of
https://github.com/GnoConsortium/gno.git
synced 2024-10-02 13:55:11 +00:00
1 line
5.6 KiB
C
1 line
5.6 KiB
C
|
/*
* Copyright (c) Kopriha Software, 1990-1991
* All Rights Reserved
*
* ks.defines.h
*
* Description: This include file contains all the master
* definitions.
*
*
* Table of contents:
*
* Structures:
*
* KS_STRUCT_ID . . . . . . . . . Structure for structure id.
*
* External variables:
*
* ks_expected_id . . . . . . . . Structure ID that was expected
* in the called routine (this will
* give the error processing code
* a hint as to what structure caused
* the error).
*
*
* Macros:
*
* KS_SUCCESS() . . . . . . . . . Return to a calling procedure
* with a success.
* KS_ERROR() . . . . . . . . . . Return to a calling procedure
* with an error.
*
*
* Structure IDs for all Kopriha Software Structures:
*
* KS_FILE_ID . . . . . . . . . . KS FILE structure id
*
*
* Error codes for all Kopriha Software:
*
* KS_E_SUCCESS . . . . . . . Success (same as ((word) 0))
* KS_E_INVALID_STRUCT_ID . . Structure has a bad structure id
* KS_E_INVALID_OPTION . . . Invalid option for a routine
*
*
* History:July 13, 1990 Dave Created this file
*
* March 3, 1991 Dave Added KS_FILE_ID
*
*/
#ifndef _KS_DEFINES_
#define _KS_DEFINES_
#ifndef __TYPES__
#include <types.h>
#endif
#ifndef _PORTABLE_C_
#include "Portable.C.h"
#endif
#ifndef _KS_ROUTINES_
#include "ks.routines.h"
#endif
#ifndef __orca__
#include <orca.h>
#endif
#ifndef EXTERNAL
#define EXTERNAL extern
#endif
/* ****************************************************************** *
* Structure definitions: *
* ****************************************************************** */
/*
* KS_E_ERROR . . . . . . . . . Type for any error code returned.
*/
typedef Word KS_E_ERROR;
/*
* KS_STRUCT_ID . . . . . . . . . Structure for structure id.
* (IE: a unique identifier for each structure)
*/
typedef Longword KS_STRUCT_ID;
/* ****************************************************************** *
* External definitions: *
* ****************************************************************** */
/* ****************************************************************** *
* ks_expected_id - The structure id of the structure we took an *
* error dealing with (this may indicate what was *
* happening when an error occured...) For memErr *
* it indicates which structure we couldn't get *
* allocate. *
* *
* History: July 13, 1990 Dave Created these structures *
* ****************************************************************** */
EXTERNAL KS_STRUCT_ID ks_expected_id;
/* ****************************************************************** *
* Macro definitions: *
* ****************************************************************** */
/*
* define DEBUG_CODE
* - add # to define to create all modules
* with debug code.
*/
/*
* KS_SUCCESS macro - used to return a success to our caller.
*/
#define KS_SUCCESS() \
\
ROUTINE_EXIT( KS_E_SUCCESS ); \
return( KS_E_SUCCESS )
/*
* KS_ERROR macro - used to return an error to our caller.
*/
#define KS_ERROR(_error, _struct_id) \
\
ks_expected_id = (_struct_id); \
ROUTINE_EXIT( (_error)
|