/*
uf_defs.h
File Description :
Open C API definitions. These are general typedefs and macros required by
all Open C API interfaces. Typedefs that are specific to a particular
module will be placed in a header file for that specific module.
*****************************************************************************/
#ifndef UF_DEFS_INCLUDED
#define UF_DEFS_INCLUDED
#ifdef USE_PRAGMA_ONCE
#pragma once
#endif
/***************************************************************************
***************************************************************************/
/*
Compute the proper buffer size based on the currently supported maximum bytes per character.
*/
#ifndef NX_BUFSIZE
#define NX_BUFSIZE(num) (3*(num)+1)
#endif
/****************************************************************************
* Limit definitions *
* *
* MAX_FSPEC_SIZE is being deprecated because NX is moving to support *
* multibyte characters. User written programs should start using the *
* new definitions for file specifications: *
* MAX_FSPEC_BUFSIZE should be used for buffer allocations and memory *
* allocations, e.g. char my_fspec[MAX_FSPEC_BUFSIZE]; *
* MAX_FSPEC_NCHARS should be used to limit the number of characters in *
* a buffer. NX code will enforce these limits. *
* New routines have been added which will help in this transition: *
* UF_TEXT_count_characters() will count the number of characters in a *
* buffer. *
* UF_TEXT_terminate_chars() will terminate a C string after the given *
* number of characters. *
*
****************************************************************************/
#define MAX_FSPEC_NCHARS 1156 /* Maximum number of characters in a filespec excluding the trailing '\0'. These may be multi-byte characters. */
#define MAX_FSPEC_BUFSIZE NX_BUFSIZE(MAX_FSPEC_NCHARS) /* Buffer size to hold a filespec. Takes into account the largest possible multi-byte character. */
/* */
#define MAX_FSPEC_SIZE (MAX_FSPEC_BUFSIZE - 1) /* filespec len (not including '\0') */
/* */
/****************************************************************************
* Limit definitions *
* *
* MAX_ENTITY_NAME_SIZE and MAX_LINE_SIZE are being deprecated because NX *
* is moving to support multibyte characters. User written programs should*
* start using the new definitions for file specifications: *
* UF_OBJ_NAME_BUFSIZE *
* MAX_LINE_BUFSIZE should be used for buffer allocations and memory *
* allocations, e.g. char name[UF_OBJ_NAME_BUFSIZE]; *
* UF_OBJ_NAME_NCHARS *
* MAX_LINE_NCHARS should be used to limit the number of characters *
* in a buffer. NX code will enforce these limits. *
* New routines have been added which will help in this transition: *
* UF_TEXT_count_characters() will count the number of characters in a *
* buffer. *
* UF_TEXT_terminate_chars() will terminate a C string after the given *
* number of characters. *
*
*
****************************************************************************/
#define MAX_LINE_NCHARS 132
#define MAX_LINE_BUFSIZE NX_BUFSIZE(MAX_LINE_NCHARS)
/* */
#define MAX_ENTITY_NAME_SIZE (UF_OBJ_NAME_BUFSIZE - 1) /* entity name len (not including '\0') */
#define MAX_LINE_SIZE (MAX_LINE_BUFSIZE-1)
/* */
/****************************************************************************
* All typedefs will have the following suffixes to denote their type: *
* *
* _t Data type *
* _p_t Pointer to type *
* _s Structure tag *
* *
****************************************************************************/
/* typedef for all tags used in User Function. The new term "tag" is *
* used instead of the old term "EID" (Entity ID). */
#ifndef TAG_T_DEFINED
#define TAG_T_DEFINED
typedef unsigned int tag_t;
typedef tag_t *tag_p_t;
#endif
#ifndef UF_LIST_T_DEFINED
#define UF_LIST_T_DEFINED
typedef struct uf_list_s *uf_list_p_t;
struct uf_list_s {
tag_t eid ; /* Object ID */
struct uf_list_s *next; /* Pointer to the next OID in the list */
};
typedef struct uf_list_s uf_list_t;
#endif
#ifndef NULL_TAG
#define NULL_TAG ((tag_t)0)
#endif
#ifndef null_tag
#define null_tag ((tag_t)0)
#endif
#ifndef PI
#define PI 3.14159265358979324
#endif
#ifndef TWOPI
#define TWOPI 6.28318530717958648
#endif
#ifndef RADEG
#define RADEG 57.29577951308235
#define DEGRA .01745329251994328
#endif
/* typedef for a logical variable. Its value can be "false" or "true". */
#ifndef LOGICAL_DEFINED
#define LOGICAL_DEFINED
#if defined(__cplusplus)
typedef bool logical;
#else
typedef unsigned char logical;
#endif
#endif
#ifndef BYTE_DEFINED
#define BYTE_DEFINED
typedef unsigned char byte;
#endif
#if !defined(true) && !defined(__cplusplus)
#define true 1
#define false 0
#endif
#ifndef TRUE
#define TRUE 1
#define FALSE 0
#endif
/****************************************************************************
* Macro definitions *
****************************************************************************/
/*****************************************************************
* ERROR_OK macro *
*****************************************************************/
#ifndef ERROR_OK
#define ERROR_OK 0
#endif
/*
* The use of the FTN macro is deprecated, as it is no longer needed
* on any NX platform.
*
*/
/* */
#ifndef FTN
#define FTN(name) name
#endif /* FTN */
/* */
/*****************************************************************
* DllExport *
* This macro is used in function prototypes on Windows NT to *
* indicate that the associated function is to be exported from *
* the containing dynamic link library. On other platforms the *
* macro is null. *
*****************************************************************/
#if defined(_WIN32)
#define DllExport __declspec(dllexport)
#else
#define DllExport
#endif
#endif /* UF_DEFS_INCLUDED */