BasicTypes.h

Go to the documentation of this file.

// ======================================================================
// \title  Fw/Types/BasicTypes.h
// \author mstarch
// \brief  h file for FPrime basic numerical aliases (I8, U64, etc.)
//
// \copyright
// Copyright 2024, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// FPrime allows use of shorthand fixed-with types. This file provides
// these definitions. I# is a signed integer of width #, U# is an unsigned
// integer of width #, F# is a floating point number of width #.
//
// This file also contains macros for a number of useful operations:
//
// - FW_NUM_ARRAY_ELEMENTS(a): number of elements in an array
// - FW_MAX(a, b): maximum of a and b
// - FW_MIN(a, b): minimum of a and b
//
// - FW_NO_ASSERT: constant for assertions turned off
// - FW_FILEID_ASSERT: constant for assertions reported as a file CRC and line number
// - FW_FILENAME_ASSERT: constant for assertions reported as a file path and line number
// - FW_RELATIVE_PATH_ASSERT: constant for assertions reported as a relative path within
//       FPrime and line number
//
//
// This header is intended to be C-compatible.
//
// ======================================================================
#ifndef FW_BASIC_TYPES_H
#define FW_BASIC_TYPES_H

#ifdef __cplusplus
extern "C" {
#endif
#include <config/FPrimeNumericalConfig.h>
#include <inttypes.h>  // Standard integer types and printf macros

// Compiler checks
#if defined(__GNUC__) || defined(__llvm__) || defined(PLATFORM_OVERRIDE_GCC_CLANG_CHECK)
#else
#error \
    "FPrime only supports GCC or Clang compilers. You may attempt to use other compilers by defining PLATFORM_OVERRIDE_GCC_CLANG_CHECK, but this is not recommended."
#endif

/*----------------------------------------------------------------------------*/
/* Type definitions:     I8, U8, I16, U16, ..., I64, U64, F32, and F64        */
/*----------------------------------------------------------------------------*/
typedef int8_t I8;    
#define PRI_I8 PRIi8  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END

typedef uint8_t U8;   
#define PRI_U8 PRIu8  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END

typedef U8 BYTE;        
#define PRI_BYTE PRIu8  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END

typedef char CHAR;
#define PRI_CHAR "c"  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END

#if FW_HAS_16_BIT
typedef int16_t I16;    
#define PRI_I16 PRIi16  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END
typedef uint16_t U16;   
#define PRI_U16 PRIu16  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END
#endif

#if FW_HAS_32_BIT
typedef int32_t I32;    
#define PRI_I32 PRIi32  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END
typedef uint32_t U32;   
#define PRI_U32 PRIu32  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END
#endif

#if FW_HAS_64_BIT
typedef int64_t I64;    
#define PRI_I64 PRIi64  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END
typedef uint64_t U64;   
#define PRI_U64 PRIu64  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END
#endif

typedef float F32;    
#define PRI_F64 "lf"  // NO_CODESONAR  LANG.PREPROC.MACROSTART/END
typedef double F64;   

/*----------------------------------------------------------------------------*/
/* Useful macro definitions                                                   */
/*----------------------------------------------------------------------------*/
#define FW_NUM_ARRAY_ELEMENTS(a) (sizeof(a) / sizeof((a)[0]))  
// Deprecated: prefer std::max/std::min from <algorithm> in C++ code.
// Kept for C compatibility only.
#define FW_MAX(a, b) (((a) > (b)) ? (a) : (b))  
#define FW_MIN(a, b) (((a) < (b)) ? (a) : (b))  

#define FW_NO_ASSERT (1)  
#define FW_FILEID_ASSERT \
    (2)  
#define FW_FILENAME_ASSERT (3)  
#define FW_RELATIVE_PATH_ASSERT \
    (4)  

#ifdef __cplusplus
}
#endif
#endif  // FW_BASIC_TYPES_H