Skip to content

File generator_defs.h

FileList > defs > generator_defs > generator_defs.h

Go to the source code of this file

Common definitions for generator objects. More...

  • #include "tang_defs.h"
  • #include "stdlib.h"
  • #include "stdint.h"
  • #include "stddef.h"

Macros

Type Name
define GEN_DEFS_CONFIG_FAIL (1u)
We use bit 0 to indicate a fail. Specific failures encoded in higher bits.
define GEN_DEFS_CONFIG_SUCCESS (0u)
Success is a 0. That lets us use hight bits for generator specific codes.
define GEN_DEFS_GENERATION_FAIL (1u)
We use bit 0 to indicate a fail. Specific failures encoded in higher bits.
define GEN_DEFS_GENERATION_SUCCESS (0u)
Success is a 0. That lets us use hight bits for generator specific codes.
define GEN_STATUS_BLDR (FLAG, HIGH_BITS) ((FLAG) \| (HIGH\_BITS))
A function like macro for building bitfield flags.

Detailed Description

Author:

Joe Starr

Macro Definition Documentation

define GEN_DEFS_CONFIG_FAIL

We use bit 0 to indicate a fail. Specific failures encoded in higher bits. 

#define GEN_DEFS_CONFIG_FAIL `(1u)`

define GEN_DEFS_CONFIG_SUCCESS

Success is a 0. That lets us use hight bits for generator specific codes. 

#define GEN_DEFS_CONFIG_SUCCESS `(0u)`

define GEN_DEFS_GENERATION_FAIL

We use bit 0 to indicate a fail. Specific failures encoded in higher bits. 

#define GEN_DEFS_GENERATION_FAIL `(1u)`

define GEN_DEFS_GENERATION_SUCCESS

Success is a 0. That lets us use hight bits for generator specific codes. 

#define GEN_DEFS_GENERATION_SUCCESS `(0u)`

define GEN_STATUS_BLDR

A function like macro for building bitfield flags. 

#define GEN_STATUS_BLDR (
    FLAG,
    HIGH_BITS
) `((FLAG) | (HIGH_BITS))`

The documentation for this class was generated from the following file source/defs/generator_defs/generator_defs.h