types.h

Go to the documentation of this file.

 
#ifndef OPENSNES_TYPES_H
#define OPENSNES_TYPES_H
 
/*============================================================================
 * Fixed-Width Integer Types
 *============================================================================*/


typedef signed char s8;

typedef unsigned char u8;

typedef signed short s16;

typedef unsigned short u16;

#ifdef __OPENSNES__
typedef signed long s32;
#else
typedef signed int s32;
#endif

#ifdef __OPENSNES__
typedef unsigned long u32;
#else
typedef unsigned int u32;
#endif
 /* end of types group */
 
/*============================================================================
 * Volatile Types
 *============================================================================*/


#ifdef __OPENSNES__
#define FAR __far
#else
#define FAR             /* host compilers (the clang syntax lint) have no address spaces */
#endif

#ifdef __OPENSNES__
#define RAM_CODE __ramcode
#else
#define RAM_CODE        /* host compilers (the clang syntax lint) */
#endif
 
typedef volatile u8 vu8;
typedef volatile u16 vu16;
typedef volatile u32 vu32;
typedef volatile s8 vs8;
typedef volatile s16 vs16;
typedef volatile s32 vs32;

 
/*============================================================================
 * Boolean Type
 *============================================================================*/

 
/*
 * Bool type compatibility — CORRECTED 2026-09-20. C11 has `_Bool` built in,
 * but `bool` / `true` / `false` come from <stdbool.h>, which this freestanding
 * SDK does not ship: on cproc (the only supported compiler) `bool` is NOT
 * defined, and the branch below — for pre-C99 compilers — is dead. No public
 * function uses `bool`; every predicate returns `u8` 0 / 1 (unified
 * 2026-09-22, API audit 3.2 — TRUE was 0xFF until then).
 */
#if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
typedef unsigned char bool;
#define false 0
#define true  1
#endif
 
/* TRUE is 1 since 2026-09-22. It was 0xFF (a PVSnesLib habit): `isPAL() ==
 * 1` was false on PAL, and `if (x == TRUE)` failed on every predicate that
 * returned 1. Every predicate of this SDK now returns 0 or 1, and the three
 * that returned TRUE (isPAL, isInVBlank, padIsConnected) return 1. Compare
 * with `if (pred())`, never with a literal — that works under both values. */
#define FALSE 0
#define TRUE  1

 
/*============================================================================
 * Common Macros
 *============================================================================*/


#ifndef NULL
#define NULL ((void*)0)
#endif

#define BIT(n) (1u << (n))

#define LO_BYTE(x) ((u8)((x) & 0xFF))

#define HI_BYTE(x) ((u8)(((x) >> 8) & 0xFF))

#define MAKE_WORD(lo, hi) ((u16)(((u8)(hi) << 8) | (u8)(lo)))

#define MIN(a, b) (((a) < (b)) ? (a) : (b))

#define MAX(a, b) (((a) > (b)) ? (a) : (b))

#define CLAMP(x, lo, hi) (((x) < (lo)) ? (lo) : (((x) > (hi)) ? (hi) : (x)))

#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))

 
/*============================================================================
 * Function Pointer Types
 *============================================================================*/


typedef void (*VoidFn)(void);

 
/*============================================================================
 * Deprecation
 *============================================================================*/

#define OPENSNES_DEPRECATED(msg) __attribute__((deprecated(msg)))
 
#endif /* OPENSNES_TYPES_H */