Difference between revisions of "Defines"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Select which defines are actually to be defined by backend; removed lots of defines used only internally by a single engine or backend)
(Initial classification of the defines that ring a bell)
Line 3: Line 3:
 
No additional filtering has been performed as of yet; some tokens are defined by a platform, while others may not actually be used. Additionally, defined symbols not used in #ifndef or #ifdef are not included at all here.
 
No additional filtering has been performed as of yet; some tokens are defined by a platform, while others may not actually be used. Additionally, defined symbols not used in #ifndef or #ifdef are not included at all here.
  
==Defines to be set by/for backends==
+
=Defines to be set by/for backends=
 
The following defines are meant to be defined by backend authors, typically
 
The following defines are meant to be defined by backend authors, typically
 
in configure (or a custom Makefile). Usually these enable or disable certain
 
in configure (or a custom Makefile). Usually these enable or disable certain
Line 9: Line 9:
 
that won't work on the target device anyway, to free up some memory.
 
that won't work on the target device anyway, to free up some memory.
  
{| border="1" cellspacing="0" cellpadding="2" width=100
+
==Defines to configure the backend==
 +
{| border="1" cellspacing="0" cellpadding="2"
 
|-
 
|-
 
! Token
 
! Token
Line 31: Line 32:
 
|
 
|
 
|-
 
|-
| DISABLE_COMMAND_LINE
+
| MIXER_DOUBLE_BUFFERING
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_DOSBOX_OPL
+
| OUTPUT_UNSIGNED_AUDIO
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_FANCY_THEMES
+
| SCUMM_BIG_ENDIAN
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_GUI_BUILTIN_THEME
+
| SCUMM_LITTLE_ENDIAN
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_HELP
+
| SCUMM_NEED_ALIGNMENT
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_SID
+
| SCUMMVM_DONT_DEFINE_TYPES
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_TEXT_CONSOLE
+
| SMALL_SCREEN_DEVICE
 
|
 
|
 
|
 
|
 
|
 
|
 +
|}
 +
 +
==Defines to enable usage of external dependencies==
 +
{| border="1" cellspacing="0" cellpadding="2"
 
|-
 
|-
| DYNAMIC_MODULES
+
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 +
|-
 +
| LEGACY_FLAC
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_AGI
+
| USE_FLAC
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_AGOS2
+
| USE_MAD
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_FASCIN_ADLIB
+
| USE_MPEG2
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_GROOVIE2
+
| USE_MPEG2_0_3_1
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_HE
+
| USE_READLINE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_IHNM
+
| USE_TREMOLO
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_INHM
+
| USE_TREMOR
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_KEYMAPPER
+
| USE_VORBIS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_LOL
+
| USE_ZLIB
 
|
 
|
 
|
 
|
 
|
 
|
 +
|}
 +
 +
==Defines to configure plugin handling==
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| ENABLE_PROFILING
+
| DYNAMIC_MODULES
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_SAGA2
+
| PLUGIN_DIRECTORY
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_SCI32
+
| PLUGIN_EXPORT
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_SCI3_GAMES
+
| PLUGIN_PREFIX
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_SCUMM
+
| PLUGIN_SUFFIX
 
|
 
|
 
|
 
|
 
|
 
|
 +
|}
 +
 +
==Defines to enable engines or parts of them==
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| ENABLE_SCUMM_7_8
+
| ENABLE_AGI
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_VKEYBD
+
| ENABLE_AGOS2
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| FORCE_RTL
+
| ENABLE_GROOVIE2
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PLUGIN_DIRECTORY
+
| ENABLE_HE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PLUGIN_EXPORT
+
| ENABLE_IHNM
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PLUGIN_PREFIX
+
| ENABLE_LOL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PLUGIN_SUFFIX
+
| ENABLE_SAGA2
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCUMM_LITTLE_ENDIAN
+
| ENABLE_SCI32
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCUMM_NEED_ALIGNMENT
+
| ENABLE_SCI3_GAMES
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_ALSA
+
| ENABLE_SCUMM
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_ARM_COSTUME_ASM
+
| ENABLE_SCUMM_7_8
 
|
 
|
 
|
 
|
 
|
 
|
 +
|}
 +
 +
==Defines to change user-visible default behaviours==
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| USE_ARM_GFX_ASM
+
| FORCE_RTL
|
 
 
|
 
|
 
|
 
|
 +
|Makes ScummVM return to the launcher instead of exiting (ideal for ports that take a long while to load)
 
|-
 
|-
| USE_ARM_SCALER_ASM
+
| LURE_CLICKABLE_MENUS
|
 
 
|
 
|
 
|
 
|
 +
|Makes the Lure of the Temptress' menus clickable instead of hoverable (making them more usable for touchscreens)
 +
|}
 +
 +
==Defines to enable common optional features==
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| USE_ARM_SMUSH_ASM
+
| ENABLE_KEYMAPPER
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_DETECTLANG
+
| ENABLE_VKEYBD
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_FLAC
+
| DISABLE_COMMAND_LINE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_FLUIDSYNTH
+
| DISABLE_FANCY_THEMES
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_HQ_SCALERS
+
| DISABLE_HELP
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_INDEO3
+
| DISABLE_TEXT_CONSOLE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_MAD
+
| USE_HQ_SCALERS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_MPEG2
+
| USE_INDEO3
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_MPEG2_0_3_1
+
| USE_OSD
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_MT32EMU
+
| USE_RGB_COLOR
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_NASM
+
| USE_SCALERS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_OSD
+
| USE_TEXT_CONSOLE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_PROFILER
+
| USE_TRANSLATION
 
|
 
|
 
|
 
|
 
|
 
|
 +
|}
 +
 +
==Defines to enable platform specific optional features==
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| USE_READLINE
+
| DISABLE_PSP_MP3
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_RGB_COLOR
+
| USE_DETECTLANG
|
 
 
|
 
|
 
|
 
|
 +
|Enables the detection of the system language (supported on POSIX systems, Windows(?))
 +
|}
 +
 +
==Defines to enable emulation of audio devices==
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| USE_SCALERS
+
| DISABLE_DOSBOX_OPL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_SEQ_MIDI
+
| DISABLE_NES_APU
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_TEXT_CONSOLE
+
| DISABLE_SID
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_TRANSLATION
+
| ENABLE_FASCIN_ADLIB
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_TREMOLO
+
| USE_MT32EMU
 
|
 
|
 
|
 
|
 
|
 
|
 +
|}
 +
 +
==Defines to enable platform specific MIDI drivers==
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| USE_TREMOR
+
| USE_ALSA
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_VORBIS
+
| USE_FLUIDSYNTH
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_ZLIB
+
| USE_SEQ_MIDI
 
|
 
|
 
|
 
|
Line 322: Line 395:
 
|}
 
|}
  
==Unsorted==
+
==Defines to enable common optimizations==
The following defines have not yet put into any category.
+
{| border="1" cellspacing="0" cellpadding="2"
Many of them might also be inappropriate for this page.
 
 
 
{| border="1" cellspacing="0" cellpadding="2" width=100
 
 
|-
 
|-
 
! Token
 
! Token
Line 333: Line 403:
 
! Purpose
 
! Purpose
 
|-
 
|-
| ANDROID
+
| DISABLE_GUI_BUILTIN_THEME
|
 
 
|
 
|
 
|
 
|
 +
|Disables embedding the default theme into the executable (reduces the binary size)
 
|-
 
|-
| ARM
+
| DISABLE_SAVEGAME_SORTING
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| COREAUDIO_DISABLE_REVERB
+
| REDUCE_MEMORY_USAGE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DEBUG
+
| STREAM_AUDIO_FROM_DISK
 
|
 
|
 
|
 
|
 
|
 
|
 +
|}
 +
 +
==Defines to enable platform specific optimizations==
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| DEBUG_ADLIB
+
| MT32EMU_HAVE_X86
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DEBUG_EXTRACTION_TABLES
+
| USE_ARM_COSTUME_ASM
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DEBUG_HASH_COLLISIONS
+
| USE_ARM_GFX_ASM
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DEBUG_PARSER
+
| USE_ARM_SCALER_ASM
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DEBUG_RATECONV
+
| USE_ARM_SMUSH_ASM
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DEBUG_SPRITE_MASK
+
| USE_NASM
|
 
 
|
 
|
 
|
 
|
 +
|Enables x86 optimized versions of the HQ scalers
 +
|}
 +
 +
==Defines to enable debugging and testing facilities==
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| DEBUG_WII_GDB
+
| DEBUG
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DEBUG_WII_MEMSTATS
+
| DEBUG_ADLIB
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DETECTOR_TESTING_HACK
+
| DEBUG_EXTRACTION_TABLES
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DETECT_BRODERBUND_TITLES
+
| DEBUG_HASH_COLLISIONS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_MD5
+
| DEBUG_PARSER
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_NES_APU
+
| DEBUG_RATECONV
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_PSP_MP3
+
| DEBUG_SPRITE_MASK
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISABLE_SAVEGAME_SORTING
+
| DEBUG_WII_GDB
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DISC_CACHE
+
| DEBUG_WII_MEMSTATS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DITHER
+
| DETECTOR_TESTING_HACK
 
|
 
|
 
|
 
|
Line 434: Line 522:
 
|-
 
|-
 
| DL_DEBUG
 
| DL_DEBUG
|
 
|
 
|
 
|-
 
| DRAW_GRAPHICS
 
 
|
 
|
 
|
 
|
Line 463: Line 546:
 
|
 
|
 
|-
 
|-
| DW2_EXACT_SIZE
+
| ENABLE_PROFILING
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| DXA_EXPERIMENT_MAXD
+
| FUNCTION_DEBUG
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| ENABLE_RENDER_MEASURE
+
| INTRO_TEST
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| EPOC_AS_APP
+
| LAYOUT_DEBUG_DIALOG
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| FILE_TIME_SUPPORT
+
| NDEBUG
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| FORCEINLINE
+
| PSP_ENABLE_SPEED_TESTS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| FORCE_SLIDY
+
| PSP_ENABLE_UNIT_TESTS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| FUNCTION_DEBUG
+
| SAGA_DEBUG
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| GAMECUBE
+
| SCENE_DEBUG
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| GUI_THEME_EVAL
+
| SCI_DEBUG_PARSE_TREE_AUGMENTATION
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| HEAVY_LOGGING
+
| SCI_VERBOSE_RESMAN
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| INADDR_NONE
+
| SCRIPT_DEBUG
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| INCLUDED_FROM_BASE_VERSION_CPP
+
| SCRIPT_TEST
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| INTRO_TEST
+
| SWORD2_DEBUG
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| IPHONE
+
| TEST_MEMORY_COPY
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| IPHONE_OFFICIAL
+
| USE_PROFILER
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| JAPAN
+
| VM_DEBUG_SEND
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| JOY_ANALOG
+
| __PS2_DEBUG__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| JOY_INVERT_Y
+
| __PS2_FILE_DEBUG__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| LAYOUT_DEBUG_DIALOG
+
| __PSP_DEBUG_FUNCS__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| LEGACY_FLAC
+
| __PSP_DEBUG_PRINT__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| LIMIT_FPS
+
| __PSP_PRINT_TO_FILE__
 
|
 
|
 
|
 
|
 
|
 
|
 +
|}
 +
 +
==Unsorted==
 +
The following defines have not yet put into any category.
 +
Many of them might also be inappropriate for this page.
 +
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| LIMIT_FRAME_RATE
+
| COREAUDIO_DISABLE_REVERB
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| LINUPY
+
| DETECT_BRODERBUND_TITLES
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| LINUXMOTO_SDL
+
| DISABLE_MD5
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| LURE_CLICKABLE_MENUS
+
| DISC_CACHE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MACOSX
+
| DITHER
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MAC_OPTIONS
+
| DRAW_GRAPHICS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MAXPATHLEN
+
| DW2_EXACT_SIZE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MAXTRAX_HAS_MICROTONAL
+
| DXA_EXPERIMENT_MAXD
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MAXTRAX_HAS_MODULATION
+
| ENABLE_RENDER_MEASURE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MAX_INT
+
| EPOC_AS_APP
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MIN
+
| FILE_TIME_SUPPORT
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MIXER_DOUBLE_BUFFERING
+
| FORCEINLINE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MOTOEZX
+
| FORCE_SLIDY
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MOTOMAGX
+
| GUI_THEME_EVAL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| MT32EMU_HAVE_X86
+
| HEAVY_LOGGING
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| NDEBUG
+
| INADDR_NONE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| NDS
+
| INCLUDED_FROM_BASE_VERSION_CPP
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| NORETURN_POST
+
| JAPAN
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| NORETURN_PRE
+
| JOY_ANALOG
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| NOSERIAL
+
| JOY_INVERT_Y
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| NO_ADAPTOR
+
| LIMIT_FPS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| OUTPUT_UNSIGNED_AUDIO
+
| LIMIT_FRAME_RATE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PATH_MAX
+
| MAC_OPTIONS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PERFECT_5_TO_4_RESCALING
+
| MAXPATHLEN
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PRINT_BUFFERS
+
| MAXTRAX_HAS_MICROTONAL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PSP_ENABLE_SPEED_TESTS
+
| MAXTRAX_HAS_MODULATION
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PSP_ENABLE_UNIT_TESTS
+
| MAX_INT
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| PSP_KB_SHELL
+
| MIN
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| QTOPIA
+
| NORETURN_POST
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| REDUCE_MEMORY_USAGE
+
| NORETURN_PRE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| REG_EXEMEMCNT
+
| NOSERIAL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| REG_EXMEMCNT
+
| NO_ADAPTOR
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| RELEASE_BUILD
+
| PATH_MAX
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| RONIN_TIMER_ACCESS
+
| PERFECT_5_TO_4_RESCALING
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| S60
+
| PRINT_BUFFERS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SAGA_DEBUG
+
| PSP_KB_SHELL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SAMPLES_PER_SEC_8000
+
| REG_EXEMEMCNT
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCALER_PROFILE
+
| REG_EXMEMCNT
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCENE_DEBUG
+
| RELEASE_BUILD
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCI_CONSOLE
+
| RONIN_TIMER_ACCESS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCI_DEBUG_PARSE_TREE_AUGMENTATION
+
| SAMPLES_PER_SEC_8000
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCI_VERBOSE_RESMAN
+
| SCALER_PROFILE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCRIPT_DEBUG
+
| SCI_CONSOLE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCRIPT_TEST
+
| SCUMMVM_SVN_REVISION
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCUMMVM_DONT_DEFINE_TYPES
+
| SCUMM_IMUSE_INTERNAL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCUMMVM_IPC_INCLUDE
+
| SKIP_INTRO
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCUMMVM_SVN_REVISION
+
| SLOW_RINCE_DOWN
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCUMM_BIG_ENDIAN
+
| SCUMMVM_IPC_INCLUDE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SCUMM_IMUSE_INTERNAL
+
| SNPRINTF_LONGLONG_SUPPORT
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SKIP_INTRO
+
| SOUND_CROP_CHANNELS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SLOW_RINCE_DOWN
+
| STRINGBUFLEN
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SMALL_SCREEN_DEVICE
+
| SYSEX_CALLBACK_FUNCTION
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SNPRINTF_LONGLONG_SUPPORT
+
| TIMIDITY_LOW_DELAY
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SOUND_CROP_CHANNELS
+
| UNICODE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| STREAM_AUDIO_FROM_DISK
+
| UNZ_BUFSIZE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| STRINGBUFLEN
+
| UNZ_MAXFILENAMEINZIP
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SWORD2_DEBUG
+
| UPGRADE_ALL_TARGETS_HACK
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| SYSEX_CALLBACK_FUNCTION
+
| USERSPACE_ONLY
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| TEST_MEMORY_COPY
+
| USE_HASHMAP_MEMORY_POOL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| TIMIDITY_LOW_DELAY
+
| WAVE_PRECISION
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| UIQ
+
| WIN32_PLATFORM_WFSP
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| UNICODE
+
| WRAP_MALLOC
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| UNIX
+
| __FRAMFS_SAVE_MANAGER__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| UNZ_BUFSIZE
+
| __MINGW32CE__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| UNZ_MAXFILENAMEINZIP
+
| __MMX__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| UPGRADE_ALL_TARGETS_HACK
+
| __N64_PORTDEFS__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USERSPACE_ONLY
+
| __PAKFS_SAVE_MANAGER__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| USE_HASHMAP_MEMORY_POOL
+
| __PS2FILE_IO__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| VM_DEBUG_SEND
+
| __PS2_FILE_SEMA__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| WAVE_PRECISION
+
| __SSE__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| WIN32
+
| __USE_INLINE__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| WIN32_PLATFORM_WFSP
+
| __USE_LIBMC__
 
|
 
|
 
|
 
|
 
|
 
|
 +
|}
 +
 +
=Defines used to determine the target platform/OS=
 +
{| border="1" cellspacing="0" cellpadding="2"
 +
|-
 +
! Token
 +
! Defined by
 +
! Used in
 +
! Purpose
 
|-
 
|-
| WRAP_MALLOC
+
| ANDROID
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __DC__
+
| ARM
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __DS__
+
| GAMECUBE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __FRAMFS_SAVE_MANAGER__
+
| IPHONE
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __MINGW32CE__
+
| IPHONE_OFFICIAL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __MMX__
+
| LINUPY
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __N64_PORTDEFS__
+
| LINUXMOTO_SDL
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __N64__
+
| MACOSX
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __OS2__
+
| MOTOEZX
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PAKFS_SAVE_MANAGER__
+
| MOTOMAGX
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PLAYSTATION2__
+
| NDS
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PS2FILE_IO__
+
| QTOPIA
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PS2_DEBUG__
+
| S60
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PS2_FILE_DEBUG__
+
| UIQ
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PS2_FILE_SEMA__
+
| UNIX
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PSP_DEBUG_FUNCS__
+
| WIN32
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PSP_DEBUG_PRINT__
+
| __DC__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PSP_PRINT_TO_FILE__
+
| __DS__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __PSP__
+
| __N64__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __sgi
+
| __OS2__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __SSE__
+
| __PLAYSTATION2__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __SYMBIAN32__
+
| __PSP__
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __USE_INLINE__
+
| __sgi
 
|
 
|
 
|
 
|
 
|
 
|
 
|-
 
|-
| __USE_LIBMC__
+
| __SYMBIAN32__
 
|
 
|
 
|
 
|

Revision as of 23:16, 28 September 2010

This is a list of all the tokens that are being used in a #ifdef or #ifndef in a .cpp or .h file, except for .h files, where tokens used as #ifndef FOO_H or #ifndef FOO_H_ are excluded, as these are almost certainly just include guards. The list is current as of r52922.

No additional filtering has been performed as of yet; some tokens are defined by a platform, while others may not actually be used. Additionally, defined symbols not used in #ifndef or #ifdef are not included at all here.

Defines to be set by/for backends

The following defines are meant to be defined by backend authors, typically in configure (or a custom Makefile). Usually these enable or disable certain features in ScummVM. E.g. a low-powered port might turn off some features that won't work on the target device anyway, to free up some memory.

Defines to configure the backend

Token Defined by Used in Purpose
AUDIO_REVERSE_STEREO
BACKEND_8BIT
DATA_PATH
MIXER_DOUBLE_BUFFERING
OUTPUT_UNSIGNED_AUDIO
SCUMM_BIG_ENDIAN
SCUMM_LITTLE_ENDIAN
SCUMM_NEED_ALIGNMENT
SCUMMVM_DONT_DEFINE_TYPES
SMALL_SCREEN_DEVICE

Defines to enable usage of external dependencies

Token Defined by Used in Purpose
LEGACY_FLAC
USE_FLAC
USE_MAD
USE_MPEG2
USE_MPEG2_0_3_1
USE_READLINE
USE_TREMOLO
USE_TREMOR
USE_VORBIS
USE_ZLIB

Defines to configure plugin handling

Token Defined by Used in Purpose
DYNAMIC_MODULES
PLUGIN_DIRECTORY
PLUGIN_EXPORT
PLUGIN_PREFIX
PLUGIN_SUFFIX

Defines to enable engines or parts of them

Token Defined by Used in Purpose
ENABLE_AGI
ENABLE_AGOS2
ENABLE_GROOVIE2
ENABLE_HE
ENABLE_IHNM
ENABLE_LOL
ENABLE_SAGA2
ENABLE_SCI32
ENABLE_SCI3_GAMES
ENABLE_SCUMM
ENABLE_SCUMM_7_8

Defines to change user-visible default behaviours

Token Defined by Used in Purpose
FORCE_RTL Makes ScummVM return to the launcher instead of exiting (ideal for ports that take a long while to load)
LURE_CLICKABLE_MENUS Makes the Lure of the Temptress' menus clickable instead of hoverable (making them more usable for touchscreens)

Defines to enable common optional features

Token Defined by Used in Purpose
ENABLE_KEYMAPPER
ENABLE_VKEYBD
DISABLE_COMMAND_LINE
DISABLE_FANCY_THEMES
DISABLE_HELP
DISABLE_TEXT_CONSOLE
USE_HQ_SCALERS
USE_INDEO3
USE_OSD
USE_RGB_COLOR
USE_SCALERS
USE_TEXT_CONSOLE
USE_TRANSLATION

Defines to enable platform specific optional features

Token Defined by Used in Purpose
DISABLE_PSP_MP3
USE_DETECTLANG Enables the detection of the system language (supported on POSIX systems, Windows(?))

Defines to enable emulation of audio devices

Token Defined by Used in Purpose
DISABLE_DOSBOX_OPL
DISABLE_NES_APU
DISABLE_SID
ENABLE_FASCIN_ADLIB
USE_MT32EMU

Defines to enable platform specific MIDI drivers

Token Defined by Used in Purpose
USE_ALSA
USE_FLUIDSYNTH
USE_SEQ_MIDI

Defines to enable common optimizations

Token Defined by Used in Purpose
DISABLE_GUI_BUILTIN_THEME Disables embedding the default theme into the executable (reduces the binary size)
DISABLE_SAVEGAME_SORTING
REDUCE_MEMORY_USAGE
STREAM_AUDIO_FROM_DISK

Defines to enable platform specific optimizations

Token Defined by Used in Purpose
MT32EMU_HAVE_X86
USE_ARM_COSTUME_ASM
USE_ARM_GFX_ASM
USE_ARM_SCALER_ASM
USE_ARM_SMUSH_ASM
USE_NASM Enables x86 optimized versions of the HQ scalers

Defines to enable debugging and testing facilities

Token Defined by Used in Purpose
DEBUG
DEBUG_ADLIB
DEBUG_EXTRACTION_TABLES
DEBUG_HASH_COLLISIONS
DEBUG_PARSER
DEBUG_RATECONV
DEBUG_SPRITE_MASK
DEBUG_WII_GDB
DEBUG_WII_MEMSTATS
DETECTOR_TESTING_HACK
DL_DEBUG
DUMP_OBJECT
DUMP_SCRIPT
DUMP_SCRIPTS
DUMP_STDOUT
ENABLE_PROFILING
FUNCTION_DEBUG
INTRO_TEST
LAYOUT_DEBUG_DIALOG
NDEBUG
PSP_ENABLE_SPEED_TESTS
PSP_ENABLE_UNIT_TESTS
SAGA_DEBUG
SCENE_DEBUG
SCI_DEBUG_PARSE_TREE_AUGMENTATION
SCI_VERBOSE_RESMAN
SCRIPT_DEBUG
SCRIPT_TEST
SWORD2_DEBUG
TEST_MEMORY_COPY
USE_PROFILER
VM_DEBUG_SEND
__PS2_DEBUG__
__PS2_FILE_DEBUG__
__PSP_DEBUG_FUNCS__
__PSP_DEBUG_PRINT__
__PSP_PRINT_TO_FILE__

Unsorted

The following defines have not yet put into any category. Many of them might also be inappropriate for this page.

Token Defined by Used in Purpose
COREAUDIO_DISABLE_REVERB
DETECT_BRODERBUND_TITLES
DISABLE_MD5
DISC_CACHE
DITHER
DRAW_GRAPHICS
DW2_EXACT_SIZE
DXA_EXPERIMENT_MAXD
ENABLE_RENDER_MEASURE
EPOC_AS_APP
FILE_TIME_SUPPORT
FORCEINLINE
FORCE_SLIDY
GUI_THEME_EVAL
HEAVY_LOGGING
INADDR_NONE
INCLUDED_FROM_BASE_VERSION_CPP
JAPAN
JOY_ANALOG
JOY_INVERT_Y
LIMIT_FPS
LIMIT_FRAME_RATE
MAC_OPTIONS
MAXPATHLEN
MAXTRAX_HAS_MICROTONAL
MAXTRAX_HAS_MODULATION
MAX_INT
MIN
NORETURN_POST
NORETURN_PRE
NOSERIAL
NO_ADAPTOR
PATH_MAX
PERFECT_5_TO_4_RESCALING
PRINT_BUFFERS
PSP_KB_SHELL
REG_EXEMEMCNT
REG_EXMEMCNT
RELEASE_BUILD
RONIN_TIMER_ACCESS
SAMPLES_PER_SEC_8000
SCALER_PROFILE
SCI_CONSOLE
SCUMMVM_SVN_REVISION
SCUMM_IMUSE_INTERNAL
SKIP_INTRO
SLOW_RINCE_DOWN
SCUMMVM_IPC_INCLUDE
SNPRINTF_LONGLONG_SUPPORT
SOUND_CROP_CHANNELS
STRINGBUFLEN
SYSEX_CALLBACK_FUNCTION
TIMIDITY_LOW_DELAY
UNICODE
UNZ_BUFSIZE
UNZ_MAXFILENAMEINZIP
UPGRADE_ALL_TARGETS_HACK
USERSPACE_ONLY
USE_HASHMAP_MEMORY_POOL
WAVE_PRECISION
WIN32_PLATFORM_WFSP
WRAP_MALLOC
__FRAMFS_SAVE_MANAGER__
__MINGW32CE__
__MMX__
__N64_PORTDEFS__
__PAKFS_SAVE_MANAGER__
__PS2FILE_IO__
__PS2_FILE_SEMA__
__SSE__
__USE_INLINE__
__USE_LIBMC__

Defines used to determine the target platform/OS

Token Defined by Used in Purpose
ANDROID
ARM
GAMECUBE
IPHONE
IPHONE_OFFICIAL
LINUPY
LINUXMOTO_SDL
MACOSX
MOTOEZX
MOTOMAGX
NDS
QTOPIA
S60
UIQ
UNIX
WIN32
__DC__
__DS__
__N64__
__OS2__
__PLAYSTATION2__
__PSP__
__sgi
__SYMBIAN32__
__WII__