cu/fwd.h: Forward Declarations
[cu: Common Infrastructure]

Defines
#define	CU_SINLINE   static inline
#define	CU_MARG(ptr_t, ptr)   ((ptr_t)(1? (ptr_t)(ptr) : (ptr)))
#define	CU_NOINIT(...)   = __VA_ARGS__
#define	CU_DISCARD(call)   ((call)? cu_noop() : cu_noop())
#define	CU_ATTR_NORETURN
#define	CU_ATTR_PURE
#define	CU_ATTR_CONST
#define	CU_ATTR_UNUSED
#define	CU_ATTR_DEPRECATED
#define	CU_ATTR_MALLOC
#define	cu_expect(e, c)   (e)
#define	cu_expect_false(e)   cu_expect(e, cu_false)
#define	cu_expect_true(e)   cu_expect(e, cu_true)
#define	CU_END_BOILERPLATE   struct cuP_expecting_semicolor_after_boilerplate
#define	CU_DOXY_FAKED
#define	CU_DOXY_ENDFAKED(...)
#define	CU_DOXY_AID(fake,...)
#define	cu_true   1
#define	cu_false   0
#define	CU_RANK_MAX   UINT_MAX
#define	cu_logsize_width   6
#define	CUCONF_SIZEOF_CU_HASH_T   CUCONF_SIZEOF_LONG
#define	CU_WORD_WIDTH   CUCONF_WIDTHOF_INTPTR_T
#define	CU_WORD_P2WIDTH   CUCONF_P2WIDTHOF_INTPTR_T
#define	CU_WORD_LOG2_P2WIDTH   CUCONF_LOG2_P2WIDTHOF_INTPTR_T
#define	CU_WORD_SIZE   CUCONF_SIZEOF_INTPTR_T
#define	CU_WORD_C(x)   ((cu_word_t)x##UL)
#define	CU_PRIdWORD   PRIdPTR
#define	CU_PRIuWORD   PRIuPTR
#define	CU_PRIxWORD   PRIxPTR
#define	CU_SCNdWORD   SCNdPTR
#define	CU_SCNiWORD   SCNiPTR
#define	CU_SCNuWORD   SCNuPTR
#define	CU_SCNxWORD   SCNxPTR
#define	CU_UINTPTR_C(x)   ((uintptr_t)x##UL)
#define	CU_OFFSET_NAME   CUP_UINT_NAME
Typedefs
typedef unsigned int	cu_bool_t
typedef unsigned int	cu_bool_fast_t
typedef unsigned char	cu_bool_least_t
typedef void *	cu_ptr_t
typedef void *	cu_ptr_ptr_t
typedef void(*	cu_fnptr_t )()
typedef unsigned int	cu_shortsize_t
typedef unsigned int	cu_rank_t
typedef unsigned int	cu_logsize_fast_t
typedef unsigned char	cu_logsize_least_t
typedef unsigned long int	cu_hash_t
typedef uintptr_t	cu_word_t
typedef int	cu_offset_t
typedef unsigned int	cu_count_t
typedef int	cu_countdiff_t
typedef struct cu_buffer *	cu_buffer_t
typedef struct cu_dlink *	cu_dlink_t
typedef struct cu_dbufsink *	cu_dbufsink_t
typedef struct cu_dcountsink *	cu_dcountsink_t
typedef struct cu_dsink *	cu_dsink_t
typedef struct cu_dsource *	cu_dsource_t
typedef struct cu_idr *	cu_idr_t
typedef struct cu_locbound *	cu_locbound_t
typedef struct cu_locorigin *	cu_locorigin_t
typedef struct cu_location *	cu_location_t
typedef struct cu_log_facility *	cu_log_facility_t
typedef struct cu_ptr_array_source *	cu_ptr_array_source_t
typedef struct cu_ptr_source *	cu_ptr_source_t
typedef struct cu_ptr_sink *	cu_ptr_sink_t
typedef struct cu_ptr_junction *	cu_ptr_junction_t
typedef struct cu_ptr_sinktor *	cu_ptr_sinktor_t
typedef struct cu_ptr_junctor *	cu_ptr_junctor_t
typedef struct cu_location *	cu_sref_t
typedef struct cu_str *	cu_str_t
typedef struct cu_wstring *	cu_wstring_t
Functions
void	cu_noop ()
void	cu_init (void)

---

Define Documentation

#define CU_DISCARD

(

call

)

((call)? cu_noop() : cu_noop())

Used to silence warnings about the result of call being discarded.

#define CU_DOXY_AID	(	fake,
		...		)

Value:

\
\
\
\
    fake

#define cu_false   0

The integer value 0 used to represent false.

#define cu_true   1

A non-zero integer value used to represent true.

#define CUCONF_SIZEOF_CU_HASH_T   CUCONF_SIZEOF_LONG

sizeof(cu_hash_t) as a const literal.

---

Typedef Documentation

typedef unsigned int cu_bool_fast_t

Deprecated:

Use cu_bool_t.

typedef unsigned char cu_bool_least_t

The smallest integer type which can hold a boolean.

typedef unsigned int cu_bool_t

Real Definition

The following is the actual definition. It was omitted above since it is unparsable to the documentation generator.

 __VA_ARGS__ 

The integer type used to pass around booleans.

typedef void(* cu_fnptr_t)()

The type conventionally used for generic function pointers. This shall be cast back to the actual function pointer type when used.

typedef unsigned long int cu_hash_t

An unsigned integer used for weak (non-cryptographic) hashes.

typedef uintptr_t cu_word_t

An integer of the biggest width which can be efficiently handled by the architecture. This must also be wide enough to hold a pointer, so if there are architetures where pointers are wider than the maximum natural integer with, a less efficient integer type must me chosen.

---

Function Documentation

void cu_init

(

void

)

Initialises the cu module. This must be called at least once before using cu_* functions. It is automatically called by the initialisation functions of dependent modules.