Skip to content

File notation_defs.h

FileList > defs > notation_defs > notation_defs.h

Go to the source code of this file

Common definitions for notation objects. More...

  • #include "tang_defs.h"

Macros

Type Name
define NOTE_DEFS_DECODE_FAIL (1u)
We use bit 0 to indicate a fail. Specific failures encoded in higher bits.
define NOTE_DEFS_DECODE_SUCCESS (0u)
Success is a 0. That lets us use hight bits for notation specific codes.
define NOTE_DEFS_ENCODE_FAIL (1u)
We use bit 0 to indicate a fail. Specific failures encoded in higher bits.
define NOTE_DEFS_ENCODE_SUCCESS (0u)
Success is a 0. That lets us use hight bits for notation specific codes.
define NOTE_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 NOTE_DEFS_DECODE_FAIL

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

#define NOTE_DEFS_DECODE_FAIL `(1u)`


define NOTE_DEFS_DECODE_SUCCESS

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

#define NOTE_DEFS_DECODE_SUCCESS `(0u)`


define NOTE_DEFS_ENCODE_FAIL

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

#define NOTE_DEFS_ENCODE_FAIL `(1u)`


define NOTE_DEFS_ENCODE_SUCCESS

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

#define NOTE_DEFS_ENCODE_SUCCESS `(0u)`


define NOTE_STATUS_BLDR

A function like macro for building bitfield flags.

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



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