ScummVM
Common Namespace Reference

Internal interface to the QuickTime audio decoder. More...

Namespaces

 impl
 
 ListInternal
 
 SpanInternal
 

Classes

struct  AddConst
 
class  Archive
 Archive allows managing of member of arbitrary containers in a uniform fashion, allowing lookup by (file)names. More...
 
class  ArchiveMember
 ArchiveMember is an abstract interface to represent elements inside implementations of Archive. More...
 
struct  ArchiveMemberListComparator
 
class  ArjArchive
 
class  ArjDecoder
 
struct  ArjHeader
 
class  Array
 This class implements a dynamically sized container, which can be accessed similar to a regular C++ array. More...
 
class  ArtificialEventSource
 An artificial event source. More...
 
class  BaseCallback
 BaseCallback<S> is a simple base class for object-oriented callbacks. More...
 
struct  BinaryFunction
 Generic binary function. More...
 
class  Binder1st
 
class  Binder2nd
 
class  BitStreamImpl
 A template implementing a bit stream for different data memory layouts. More...
 
class  BitStreamMemoryStream
 A cut-down version of MemoryReadStream specifically for use with BitStream. More...
 
class  Callback
 Callback<T, S> implements an object-oriented callback. More...
 
class  CallbackBridge
 CallbackBridge<T, OS, S> helps you to chain callbacks. More...
 
struct  CaseSensitiveString_EqualTo
 
struct  CaseSensitiveString_Hash
 
struct  Complex
 A complex number. More...
 
struct  Conditional
 
struct  Conditional< false, T, U >
 
class  ConfigManager
 The (singleton) configuration manager, used to query & set configuration values using string keys. More...
 
class  ConstMemFunc0
 
class  ConstMemFunc1
 
class  ConstMemFuncRef0
 
class  ConstMemFuncRef1
 
struct  ConversionTable
 
struct  CoroBaseContext
 The core of any coroutine context which captures the 'state' of a coroutine. More...
 
class  CoroContextHolder
 Wrapper class which holds a pointer to a pointer to a CoroBaseContext. More...
 
class  CoroutineScheduler
 Creates and manages "processes" (really coroutines). More...
 
class  CosineTable
 
class  CRC32
 
class  DCT
 (Inverse) Discrete Cosine Transforms. More...
 
class  DebugManager
 
class  DecompressorDCL
 
struct  DefaultDeleter
 
class  DefaultEventMapper
 
class  DisposablePtr
 
class  DumpFile
 TODO: document this class. More...
 
class  Encoding
 A class, that allows conversion between different text encoding, the encodings available depend on the current backend and if the ScummVM is compiled with or without iconv. More...
 
struct  EqualTo
 Predicate to check for equallity of two data elements. More...
 
class  Error
 An Error instance pairs an error code with string description providing more details about the error. More...
 
struct  EVENT
 Event structure. More...
 
struct  Event
 Data structure for an event. More...
 
class  EventDispatcher
 Dispatches events from various sources to various observers. More...
 
class  EventManager
 The EventManager provides user input events to the client code. More...
 
class  EventMapper
 A event mapper, which will map events to others. More...
 
class  EventObserver
 Object which catches and processes Events. More...
 
class  EventSource
 A source of Events. More...
 
class  FFT
 (Inverse) Fast Fourier Transform. More...
 
class  File
 TODO: vital to document this core class properly!!! For both users and implementors. More...
 
class  FixedSizeMemoryPool
 This is a memory pool which already contains in itself some storage space for a fixed number of chunks. More...
 
class  FixedSizeMemoryPool< CHUNK_SIZE, 0 >
 
class  FixedStack
 Extremly simple fixed size stack class. More...
 
class  FSDirectory
 FSDirectory models a directory tree from the filesystem and allows users to access it through the Archive interface. More...
 
class  FSList
 List of multiple file system nodes. More...
 
class  FSNode
 FSNode, short for "File System Node", provides an abstraction for file paths, allowing for portable file system browsing. More...
 
struct  Functor0
 Generic functor object for function objects without parameters. More...
 
class  Functor0Mem
 Functor object for a class member function without parameter. More...
 
struct  Functor1
 Generic functor object for unary function objects. More...
 
class  Functor1Mem
 Functor object for an unary class member function. More...
 
struct  Functor2
 Generic functor object for binary function objects. More...
 
class  Functor2Fun
 Functor object for a binary function. More...
 
class  Functor2Mem
 Functor object for a binary class member function. More...
 
struct  GameOpt
 
class  GenericArchiveMember
 Simple ArchiveMember implementation which allows creation of ArchiveMember compatible objects via a simple Archive and name pair. More...
 
class  GlobalFunctionCallback
 GlobalFunctionCallback<T> is a simple wrapper for global C functions. More...
 
struct  Greater
 Predicate to check for x being greater than y. More...
 
class  GZipReadStream
 A simple wrapper class which can be used to wrap around an arbitrary other SeekableReadStream and will then provide on-the-fly decompression support. More...
 
class  GZipWriteStream
 A simple wrapper class which can be used to wrap around an arbitrary other WriteStream and will then provide on-the-fly compression support. More...
 
struct  Hash
 Base template for hash functor objects, used by HashMap. More...
 
struct  Hash< const char * >
 
struct  Hash< CryOmni3D::Versailles::PlaceActionKey >
 
struct  Hash< CryOmni3D::Versailles::PlaceStateActionKey >
 
struct  Hash< String >
 
struct  Hash< T * >
 Partial specialization of the Hash functor to be able to use pointers as HashMap keys. More...
 
struct  Hash< void * >
 
struct  Hash< Wintermute::SystemClass * >
 
struct  Hash< Wintermute::SystemInstance * >
 
class  HashMap
 HashMap<Key,Val> maps objects of type Key to objects of type Val. More...
 
class  Huffman
 Huffman bitstream decoding. More...
 
struct  IFFChunk
 Represents a IFF chunk available to client code. More...
 
class  IFFParser
 Parser for IFF containers. More...
 
struct  IgnoreCase_EqualTo
 
struct  IgnoreCase_Hash
 
class  INIFile
 This class allows reading/writing INI style config files. More...
 
class  InstallShieldCabinet
 
struct  JoystickState
 Data structure for joystick events. More...
 
class  JSON
 
class  JSONValue
 
struct  KeyState
 Keyboard status, as used in the Event struct. More...
 
struct  LanguageDescription
 
struct  Less
 Predicate to check for x being less than y. More...
 
class  List
 Simple double linked list, modeled after the list template of the standard C++ library. More...
 
class  MacResManager
 Class for handling Mac data and resource forks. More...
 
struct  md5_context
 
class  MemFunc0
 
class  MemFunc1
 
class  MemFuncRef0
 
class  MemFuncRef1
 
class  MemoryPool
 This class provides a pool of memory 'chunks' of identical size. More...
 
class  MemoryReadStream
 Simple memory based 'stream', which implements the ReadStream interface for a plain memory block. More...
 
class  MemoryReadStreamEndian
 This is a MemoryReadStream subclass which adds non-endian read methods whose endianness is set on the stream creation. More...
 
class  MemoryReadWriteStream
 MemoryStream based on RingBuffer. More...
 
class  MemoryWriteStream
 Simple memory based 'stream', which implements the WriteStream interface for a plain memory block. More...
 
class  MemoryWriteStreamDynamic
 A sort of hybrid between MemoryWriteStream and Array classes. More...
 
class  Mutex
 Wrapper class around the OSystem mutex functions. More...
 
class  NamedSpan
 
class  NamedSpanImpl
 
class  NEResources
 A class able to load resources from a Windows New Executable, such as cursors, bitmaps, and sounds. More...
 
class  NonCopyable
 Subclass of NonCopyable can not be copied due to the fact that we made the copy constructor and assigment operator private. More...
 
class  ObjectPool
 A memory pool for C++ objects. More...
 
class  OSDMessageQueue
 Queue OSD messages from any thread to be displayed by the graphic thread. More...
 
class  OutSaveFile
 A class which allows game engines to save game state data. More...
 
class  PackBitsReadStream
 Decode a given PackBits encoded stream. More...
 
class  PEResources
 A class able to load resources from a Windows Portable Executable, such as cursors, bitmaps, and sounds. More...
 
struct  PlatformDescription
 
class  PlaybackFile
 
struct  Point
 Simple class for handling both 2D position and size. More...
 
class  PointerToBinaryFunc
 
class  PointerToUnaryFunc
 
struct  PoMessageEntry
 
struct  PROCESS
 process structure More...
 
class  Queue
 Variable size Queue class, implemented using our List class. More...
 
class  QuickTimeParser
 Parser for QuickTime/MPEG-4 files. More...
 
class  RandomSource
 Simple random number generator. More...
 
class  Rational
 A simple rational class that holds fractions. More...
 
class  RDFT
 (Inverse) Real Discrete Fourier Transform. More...
 
class  ReadStream
 Generic interface for a readable data stream. More...
 
class  ReadStreamEndian
 This is a ReadStream mixin subclass which adds non-endian read methods whose endianness is set during the stream creation. More...
 
struct  RecorderEvent
 
struct  Rect
 Simple class for handling a rectangular zone. More...
 
struct  RemoveConst
 
struct  RemoveConst< const T >
 
struct  RenderGUIOMapping
 
struct  RenderModeDescription
 
struct  SafeBool
 Prevents operator bool from implicitly converting to other types. More...
 
class  SafeSeekableSubReadStream
 A seekable substream that removes the exclusivity demand required by the normal SeekableSubReadStream, at the cost of seek()ing the parent stream before each read(). More...
 
class  SaveFileManager
 The SaveFileManager is serving as a factory for InSaveFile and OutSaveFile objects. More...
 
class  ScopedPtr
 
class  SearchManager
 
class  SearchSet
 SearchSet enables access to a group of Archives through the Archive interface. More...
 
class  SeekableMemoryWriteStream
 MemoryWriteStream subclass with ability to set stream position indicator. More...
 
class  SeekableReadStream
 Interface for a seekable & readable data stream. More...
 
class  SeekableReadStreamEndian
 This is a SeekableReadStream subclass which adds non-endian read methods whose endianness is set during the stream creation. More...
 
class  SeekableSubReadStream
 
class  SeekableSubReadStreamEndian
 This is a SeekableSubReadStream subclass which adds non-endian read methods whose endianness is set on the stream creation. More...
 
class  SeekableWriteStream
 Derived abstract base class for write streams streams that are seekable. More...
 
class  Serializable
 
class  Serializer
 This class allows syncing / serializing data (primarily game savestates) between memory and Read/WriteStreams. More...
 
class  SharedPtr
 A simple shared pointer implementation modelled after boost. More...
 
class  SharedPtrDeletionDeleterImpl
 
class  SharedPtrDeletionImpl
 
class  SharedPtrDeletionInternal
 
class  SineTable
 
class  Singleton
 Generic template base class for implementing the singleton design pattern. More...
 
class  SortedArray
 Double linked list with sorted nodes. More...
 
class  Span
 
class  SpanBase
 
class  SpanImpl
 
class  SpanOwner
 Similar to ScopedPtr, but allows holding and disposing pointers inside Spans without requiring an additional pointer to data, and with copyability. More...
 
class  Stack
 Variable size stack class, implemented using our Array class. More...
 
class  StackLock
 Auxillary class to (un)lock a mutex on the stack. More...
 
class  Stream
 Virtual base class for both ReadStream and WriteStream. More...
 
class  String
 Simple string class for ScummVM. More...
 
class  StringTokenizer
 A simple non-optimized string tokenizer. More...
 
class  SubReadStream
 SubReadStream provides access to a ReadStream restricted to the range [currentPosition, currentPosition+end). More...
 
class  TaskbarManager
 The TaskbarManager allows interaction with the ScummVM application icon: More...
 
class  TimerManager
 
struct  TLanguage
 
class  TranslationManager
 Message translation manager. More...
 
class  U32String
 Very simple string class for UTF-32 strings in ScummVM. More...
 
struct  UnaryFunction
 Generic unary function. More...
 
class  UpdateManager
 The UpdateManager allows configuring of the automatic update checking for systems that support it: More...
 
class  WinResourceID
 
struct  WinResourceID_EqualTo
 
struct  WinResourceID_Hash
 
class  WriteStream
 Generic interface for a writable data stream. More...
 
class  XMLParser
 The base XMLParser class implements generic functionality for parsing XML-like files. More...
 
class  ZipArchive
 

Typedefs

typedef SharedPtr< ArchiveMemberArchiveMemberPtr
 
typedef List< ArchiveMemberPtrArchiveMemberList
 
typedef BitStreamImpl< SeekableReadStream, 8, false, true > BitStream8MSB
 8-bit data, MSB to LSB. More...
 
typedef BitStreamImpl< SeekableReadStream, 8, false, false > BitStream8LSB
 8-bit data, LSB to MSB. More...
 
typedef BitStreamImpl< SeekableReadStream, 16, true, true > BitStream16LEMSB
 16-bit little-endian data, MSB to LSB. More...
 
typedef BitStreamImpl< SeekableReadStream, 16, true, false > BitStream16LELSB
 16-bit little-endian data, LSB to MSB. More...
 
typedef BitStreamImpl< SeekableReadStream, 16, false, true > BitStream16BEMSB
 16-bit big-endian data, MSB to LSB. More...
 
typedef BitStreamImpl< SeekableReadStream, 16, false, false > BitStream16BELSB
 16-bit big-endian data, LSB to MSB. More...
 
typedef BitStreamImpl< SeekableReadStream, 32, true, true > BitStream32LEMSB
 32-bit little-endian data, MSB to LSB. More...
 
typedef BitStreamImpl< SeekableReadStream, 32, true, false > BitStream32LELSB
 32-bit little-endian data, LSB to MSB. More...
 
typedef BitStreamImpl< SeekableReadStream, 32, false, true > BitStream32BEMSB
 32-bit big-endian data, MSB to LSB. More...
 
typedef BitStreamImpl< SeekableReadStream, 32, false, false > BitStream32BELSB
 32-bit big-endian data, LSB to MSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 8, false, true > BitStreamMemory8MSB
 8-bit data, MSB to LSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 8, false, false > BitStreamMemory8LSB
 8-bit data, LSB to MSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 16, true, true > BitStreamMemory16LEMSB
 16-bit little-endian data, MSB to LSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 16, true, false > BitStreamMemory16LELSB
 16-bit little-endian data, LSB to MSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 16, false, true > BitStreamMemory16BEMSB
 16-bit big-endian data, MSB to LSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 16, false, false > BitStreamMemory16BELSB
 16-bit big-endian data, LSB to MSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 32, true, true > BitStreamMemory32LEMSB
 32-bit little-endian data, MSB to LSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 32, true, false > BitStreamMemory32LELSB
 32-bit little-endian data, LSB to MSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 32, false, true > BitStreamMemory32BEMSB
 32-bit big-endian data, MSB to LSB. More...
 
typedef BitStreamImpl< BitStreamMemoryStream, 32, false, false > BitStreamMemory32BELSB
 32-bit big-endian data, LSB to MSB. More...
 
typedef CoroBaseContextCoroContext
 
typedef void(* CORO_ADDR) (CoroContext &, const void *)
 Coroutine parameter for methods converted to coroutines. More...
 
typedef PROCESSPPROCESS
 
typedef uint32 CustomEventType
 
typedef HashMap< String, String, IgnoreCase_Hash, IgnoreCase_EqualToStringMap
 
typedef uint32 IFF_ID
 
typedef Array< JSONValue * > JSONArray
 
typedef HashMap< String, JSONValue * > JSONObject
 
typedef Array< uint16MacResIDArray
 
typedef Array< uint32MacResTagArray
 
typedef OSystem::MutexRef MutexRef
 An pseudo-opaque mutex type. More...
 
typedef SeekableReadStream InSaveFile
 A class which allows game engines to load game state data. More...
 
typedef Array< StringStringArray
 An array of of strings. More...
 
typedef void(* OutputFormatter) (char *dst, const char *src, size_t dstSize)
 An output formatter takes a source string and 'decorates' it with extra information, storing the result in a destination buffer. More...
 
typedef void(* ErrorHandler) (const char *msg)
 A callback which is invoked by error() just before aborting. More...
 
typedef Array< TLanguageTLangArray
 
typedef HashMap< String, ArjHeader *, IgnoreCase_Hash, IgnoreCase_EqualToArjHeadersMap
 

Enumerations

enum  ErrorCode {
  kNoError = 0, kNoGameDataFoundError, kUnsupportedGameidError, kUnsupportedColorMode,
  kAudioDeviceInitFailed, kReadPermissionDenied, kWritePermissionDenied, kPathDoesNotExist,
  kPathNotDirectory, kPathNotFile, kCreatingFileFailed, kReadingFailed,
  kWritingFailed, kEnginePluginNotFound, kEnginePluginNotSupportSaves, kUserCanceled,
  kUnknownError
}
 This file contains an enum with commonly used error codes. More...
 
enum  EventType {
  EVENT_INVALID = 0, EVENT_KEYDOWN = 1, EVENT_KEYUP = 2, EVENT_MOUSEMOVE = 3,
  EVENT_LBUTTONDOWN = 4, EVENT_LBUTTONUP = 5, EVENT_RBUTTONDOWN = 6, EVENT_RBUTTONUP = 7,
  EVENT_WHEELUP = 8, EVENT_WHEELDOWN = 9, EVENT_MBUTTONDOWN = 13, EVENT_MBUTTONUP = 14,
  EVENT_MAINMENU = 15, EVENT_RTL = 16, EVENT_MUTE = 17, EVENT_QUIT = 10,
  EVENT_SCREEN_CHANGED = 11, EVENT_PREDICTIVE_DIALOG = 12, EVENT_DROP_FILE = 23, EVENT_JOYAXIS_MOTION = 24,
  EVENT_JOYBUTTON_DOWN = 25, EVENT_JOYBUTTON_UP = 26, EVENT_CLIPBOARD_UPDATE = 27
}
 The types of events backends may generate. More...
 
enum  JoystickButton {
  JOYSTICK_BUTTON_A, JOYSTICK_BUTTON_B, JOYSTICK_BUTTON_X, JOYSTICK_BUTTON_Y,
  JOYSTICK_BUTTON_BACK, JOYSTICK_BUTTON_GUIDE, JOYSTICK_BUTTON_START, JOYSTICK_BUTTON_LEFT_STICK,
  JOYSTICK_BUTTON_RIGHT_STICK, JOYSTICK_BUTTON_LEFT_SHOULDER, JOYSTICK_BUTTON_RIGHT_SHOULDER, JOYSTICK_BUTTON_DPAD_UP,
  JOYSTICK_BUTTON_DPAD_DOWN, JOYSTICK_BUTTON_DPAD_LEFT, JOYSTICK_BUTTON_DPAD_RIGHT
}
 The list named buttons available from a joystick. More...
 
enum  JSONType {
  JSONType_Null, JSONType_String, JSONType_Bool, JSONType_Number,
  JSONType_IntegerNumber, JSONType_Array, JSONType_Object
}
 
enum  KeyCode {
  KEYCODE_INVALID = 0, KEYCODE_BACKSPACE = 8, KEYCODE_TAB = 9, KEYCODE_CLEAR = 12,
  KEYCODE_RETURN = 13, KEYCODE_PAUSE = 19, KEYCODE_ESCAPE = 27, KEYCODE_SPACE = 32,
  KEYCODE_EXCLAIM = 33, KEYCODE_QUOTEDBL = 34, KEYCODE_HASH = 35, KEYCODE_DOLLAR = 36,
  KEYCODE_AMPERSAND = 38, KEYCODE_QUOTE = 39, KEYCODE_LEFTPAREN = 40, KEYCODE_RIGHTPAREN = 41,
  KEYCODE_ASTERISK = 42, KEYCODE_PLUS = 43, KEYCODE_COMMA = 44, KEYCODE_MINUS = 45,
  KEYCODE_PERIOD = 46, KEYCODE_SLASH = 47, KEYCODE_0 = 48, KEYCODE_1 = 49,
  KEYCODE_2 = 50, KEYCODE_3 = 51, KEYCODE_4 = 52, KEYCODE_5 = 53,
  KEYCODE_6 = 54, KEYCODE_7 = 55, KEYCODE_8 = 56, KEYCODE_9 = 57,
  KEYCODE_COLON = 58, KEYCODE_SEMICOLON = 59, KEYCODE_LESS = 60, KEYCODE_EQUALS = 61,
  KEYCODE_GREATER = 62, KEYCODE_QUESTION = 63, KEYCODE_AT = 64, KEYCODE_LEFTBRACKET = 91,
  KEYCODE_BACKSLASH = 92, KEYCODE_RIGHTBRACKET = 93, KEYCODE_CARET = 94, KEYCODE_UNDERSCORE = 95,
  KEYCODE_BACKQUOTE = 96, KEYCODE_a = 97, KEYCODE_b = 98, KEYCODE_c = 99,
  KEYCODE_d = 100, KEYCODE_e = 101, KEYCODE_f = 102, KEYCODE_g = 103,
  KEYCODE_h = 104, KEYCODE_i = 105, KEYCODE_j = 106, KEYCODE_k = 107,
  KEYCODE_l = 108, KEYCODE_m = 109, KEYCODE_n = 110, KEYCODE_o = 111,
  KEYCODE_p = 112, KEYCODE_q = 113, KEYCODE_r = 114, KEYCODE_s = 115,
  KEYCODE_t = 116, KEYCODE_u = 117, KEYCODE_v = 118, KEYCODE_w = 119,
  KEYCODE_x = 120, KEYCODE_y = 121, KEYCODE_z = 122, KEYCODE_DELETE = 127,
  KEYCODE_TILDE = 176, KEYCODE_KP0 = 256, KEYCODE_KP1 = 257, KEYCODE_KP2 = 258,
  KEYCODE_KP3 = 259, KEYCODE_KP4 = 260, KEYCODE_KP5 = 261, KEYCODE_KP6 = 262,
  KEYCODE_KP7 = 263, KEYCODE_KP8 = 264, KEYCODE_KP9 = 265, KEYCODE_KP_PERIOD = 266,
  KEYCODE_KP_DIVIDE = 267, KEYCODE_KP_MULTIPLY = 268, KEYCODE_KP_MINUS = 269, KEYCODE_KP_PLUS = 270,
  KEYCODE_KP_ENTER = 271, KEYCODE_KP_EQUALS = 272, KEYCODE_UP = 273, KEYCODE_DOWN = 274,
  KEYCODE_RIGHT = 275, KEYCODE_LEFT = 276, KEYCODE_INSERT = 277, KEYCODE_HOME = 278,
  KEYCODE_END = 279, KEYCODE_PAGEUP = 280, KEYCODE_PAGEDOWN = 281, KEYCODE_F1 = 282,
  KEYCODE_F2 = 283, KEYCODE_F3 = 284, KEYCODE_F4 = 285, KEYCODE_F5 = 286,
  KEYCODE_F6 = 287, KEYCODE_F7 = 288, KEYCODE_F8 = 289, KEYCODE_F9 = 290,
  KEYCODE_F10 = 291, KEYCODE_F11 = 292, KEYCODE_F12 = 293, KEYCODE_F13 = 294,
  KEYCODE_F14 = 295, KEYCODE_F15 = 296, KEYCODE_NUMLOCK = 300, KEYCODE_CAPSLOCK = 301,
  KEYCODE_SCROLLOCK = 302, KEYCODE_RSHIFT = 303, KEYCODE_LSHIFT = 304, KEYCODE_RCTRL = 305,
  KEYCODE_LCTRL = 306, KEYCODE_RALT = 307, KEYCODE_LALT = 308, KEYCODE_RMETA = 309,
  KEYCODE_LMETA = 310, KEYCODE_LSUPER = 311, KEYCODE_RSUPER = 312, KEYCODE_MODE = 313,
  KEYCODE_COMPOSE = 314, KEYCODE_HELP = 315, KEYCODE_PRINT = 316, KEYCODE_SYSREQ = 317,
  KEYCODE_BREAK = 318, KEYCODE_MENU = 319, KEYCODE_POWER = 320, KEYCODE_EURO = 321,
  KEYCODE_UNDO = 322
}
 
enum  {
  ASCII_BACKSPACE = 8, ASCII_TAB = 9, ASCII_RETURN = 13, ASCII_ESCAPE = 27,
  ASCII_SPACE = 32, ASCII_F1 = 315, ASCII_F2 = 316, ASCII_F3 = 317,
  ASCII_F4 = 318, ASCII_F5 = 319, ASCII_F6 = 320, ASCII_F7 = 321,
  ASCII_F8 = 322, ASCII_F9 = 323, ASCII_F10 = 324, ASCII_F11 = 325,
  ASCII_F12 = 326
}
 List of certain special and some fake 'ascii' values used in keyboard events. More...
 
enum  {
  KBD_CTRL = 1 << 0, KBD_ALT = 1 << 1, KBD_SHIFT = 1 << 2, KBD_META = 1 << 3,
  KBD_NON_STICKY = (KBD_CTRL|KBD_ALT|KBD_SHIFT|KBD_META), KBD_NUM = 1 << 4, KBD_CAPS = 1 << 5, KBD_SCRL = 1 << 6,
  KBD_STICKY = (KBD_NUM|KBD_CAPS|KBD_SCRL)
}
 Keyboard modifier flags, used for Event::kbd::flags. More...
 
enum  Language {
  ZH_CNA, ZH_TWN, HR_HRV, CZ_CZE,
  DA_DAN, NL_NLD, EN_ANY, EN_GRB,
  EN_USA, ET_EST, FI_FIN, FR_FRA,
  DE_DEU, GR_GRE, HE_ISR, HU_HUN,
  IT_ITA, JA_JPN, KO_KOR, LV_LAT,
  NB_NOR, PL_POL, PT_BRA, PT_POR,
  RU_RUS, SK_SVK, ES_ESP, SE_SWE,
  TR_TUR, UA_UKR, UNK_LANG = -1
}
 List of game language. More...
 
enum  { INITIAL_CHUNKS_PER_PAGE = 8 }
 
enum  Platform {
  kPlatformDOS, kPlatformAmiga, kPlatformAtari8Bit, kPlatformAtariST,
  kPlatformMacintosh, kPlatformFMTowns, kPlatformWindows, kPlatformNES,
  kPlatformC64, kPlatformCoCo3, kPlatformLinux, kPlatformAcorn,
  kPlatformSegaCD, kPlatform3DO, kPlatformPCEngine, kPlatformApple2,
  kPlatformApple2GS, kPlatformPC98, kPlatformWii, kPlatformPSX,
  kPlatformCDi, kPlatformIOS, kPlatformOS2, kPlatformBeOS,
  kPlatformPocketPC, kPlatformUnknown = -1
}
 List of game platforms. More...
 
enum  { kMP4IODescTag = 2, kMP4ESDescTag = 3, kMP4DecConfigDescTag = 4, kMP4DecSpecificDescTag = 5 }
 
enum  RecorderEventType { kRecorderEventTypeNormal = 0, kRecorderEventTypeTimer = 1 }
 
enum  RenderMode {
  kRenderDefault = 0, kRenderVGA = 1, kRenderEGA = 2, kRenderCGA = 3,
  kRenderHercG = 4, kRenderHercA = 5, kRenderAmiga = 6, kRenderFMTowns = 7,
  kRenderPC9821 = 8, kRenderPC9801 = 9, kRenderApple2GS = 10, kRenderAtariST = 11,
  kRenderMacintosh = 12
}
 List of render modes. More...
 
enum  { kSpanMaxSize = 0xFFFFFFFF, kSpanKeepOffset = 0xFFFFFFFF }
 
enum  SpanValidationMode { kValidateRead, kValidateWrite, kValidateSeek }
 
enum  CodePage {
  kUtf8, kWindows1250, kWindows1251, kWindows1252,
  kWindows1253, kWindows1254, kWindows1255, kWindows1257
}
 
enum  { LF = 0x0A, CR = 0x0D }
 
enum  TranslationIDs { kTranslationAutodetectId = 0, kTranslationBuiltinId = 1000 }
 
enum  WinResourceType {
  kWinCursor = 0x01, kWinBitmap = 0x02, kWinIcon = 0x03, kWinMenu = 0x04,
  kWinDialog = 0x05, kWinString = 0x06, kWinFontDir = 0x07, kWinFont = 0x08,
  kWinAccelerator = 0x09, kWinRCData = 0x0A, kWinMessageTable = 0x0B, kWinGroupCursor = 0x0C,
  kWinGroupIcon = 0x0E, kWinVersion = 0x10, kWinDlgInclude = 0x11, kWinPlugPlay = 0x13,
  kWinVXD = 0x14, kWinAniCursor = 0x15, kWinAniIcon = 0x16, kWinHTML = 0x17,
  kWinManifest = 0x18
}
 The default Windows resources. More...
 
enum  { kTempBufSize = 65536 }
 

Functions

 DECLARE_SINGLETON (Cloud::CloudManager)
 
 DECLARE_SINGLETON (OpenGL::ShaderManager)
 
 DECLARE_SINGLETON (Networking::ConnectionManager)
 
 DECLARE_SINGLETON (Networking::LocalWebserver)
 
 DECLARE_SINGLETON (VramAllocator)
 
 DECLARE_SINGLETON (PowerManager)
 
 DECLARE_SINGLETON (PspRtc)
 
 DECLARE_SINGLETON (EngineManager)
 
 DECLARE_SINGLETON (MusicManager)
 
template<class In , class Out >
Out copy (In first, In last, Out dst)
 Copies data from the range [first, last) to [dst, dst + (last - first)). More...
 
template<class In , class Out >
Out copy_backward (In first, In last, Out dst)
 Copies data from the range [first, last) to [dst - (last - first), dst). More...
 
template<class In , class Out , class Op >
Out copy_if (In first, In last, Out dst, Op op)
 Copies data from the range [first, last) to [dst, dst + (last - first)). More...
 
template<class Value >
signed char * fill (signed char *first, signed char *last, Value val)
 
template<class Value >
unsigned char * fill (unsigned char *first, unsigned char *last, Value val)
 
template<class Value >
char * fill (char *first, char *last, Value val)
 
template<class In , class Value >
In fill (In first, In last, const Value &val)
 Sets all elements in the range [first, last) to val. More...
 
template<class In , class T >
In find (In first, In last, const T &v)
 Finds the first data value in the range [first, last) matching v. More...
 
template<class In , class Pred >
In find_if (In first, In last, Pred p)
 Finds the first data value in the range [first, last) for which the specified predicate p returns true. More...
 
template<class In , class Op >
Op for_each (In first, In last, Op f)
 Applies the function f on all elements of the range [first, last). More...
 
template<typename T >
unsigned int distance (T *first, T *last)
 
template<typename T >
unsigned int distance (T first, T last)
 
template<typename T >
T * sortChoosePivot (T *first, T *last)
 
template<typename T >
sortChoosePivot (T first, T last)
 
template<typename T , class StrictWeakOrdering >
sortPartition (T first, T last, T pivot, StrictWeakOrdering &comp)
 
template<typename T , class StrictWeakOrdering >
void sort (T first, T last, StrictWeakOrdering comp)
 Simple sort function, modeled after std::sort. More...
 
template<typename T >
void sort (T *first, T *last)
 Simple sort function, modeled after std::sort. More...
 
template<class T >
void sort (T first, T last)
 
template<class T >
gcd (T a, T b)
 Euclid's algorithm to compute the greatest common divisor. More...
 
template<class It , class Dat >
void replace (It begin, It end, const Dat &original, const Dat &replaced)
 Replacement algorithm for iterables. More...
 
 DECLARE_SINGLETON (SearchManager)
 
ReadStreamwrapBufferedReadStream (ReadStream *parentStream, uint32 bufSize, DisposeAfterUse::Flag disposeParentStream)
 Take an arbitrary ReadStream and wrap it in a custom stream which transparently provides buffering. More...
 
SeekableReadStreamwrapBufferedSeekableReadStream (SeekableReadStream *parentStream, uint32 bufSize, DisposeAfterUse::Flag disposeParentStream)
 Take an arbitrary SeekableReadStream and wrap it in a custom stream which transparently provides buffering. More...
 
WriteStreamwrapBufferedWriteStream (WriteStream *parentStream, uint32 bufSize)
 Take an arbitrary WriteStream and wrap it in a custom stream which transparently provides buffering. More...
 
 DECLARE_SINGLETON (ConfigManager)
 
 DECLARE_SINGLETON (CoroutineScheduler)
 
bool decompressDCL (ReadStream *sourceStream, byte *dest, uint32 packedSize, uint32 unpackedSize)
 Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. More...
 
SeekableReadStreamdecompressDCL (SeekableReadStream *sourceStream, uint32 packedSize, uint32 unpackedSize)
 Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. More...
 
SeekableReadStreamdecompressDCL (SeekableReadStream *sourceStream)
 Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. More...
 
 DECLARE_SINGLETON (DebugManager)
 
String addUtfEndianness (const String &str)
 
static String errorToString (ErrorCode errorCode)
 Maps an error code to equivalent string description. More...
 
template<class Op >
Binder1st< Op > bind1st (const Op &op, typename Op::FirstArgumentType t)
 Transforms a binary function object into an unary function object. More...
 
template<class Op >
Binder2nd< Op > bind2nd (const Op &op, typename Op::SecondArgumentType t)
 Transforms a binary function object into an unary function object. More...
 
template<class Arg , class Result >
PointerToUnaryFunc< Arg, Result > ptr_fun (Result(*func)(Arg))
 Creates an unary function object from a function pointer. More...
 
template<class Arg1 , class Arg2 , class Result >
PointerToBinaryFunc< Arg1, Arg2, Result > ptr_fun (Result(*func)(Arg1, Arg2))
 Creates an binary function object from a function pointer. More...
 
template<class Result , class T >
MemFunc0< Result, T > mem_fun (Result(T::*f)())
 Creates a unary function object from a class member function pointer. More...
 
template<class Result , class T >
ConstMemFunc0< Result, T > mem_fun (Result(T::*f)() const)
 Creates a unary function object from a class member function pointer. More...
 
template<class Result , class Arg , class T >
MemFunc1< Result, Arg, T > mem_fun (Result(T::*f)(Arg))
 Creates a binary function object from a class member function pointer. More...
 
template<class Result , class Arg , class T >
ConstMemFunc1< Result, Arg, T > mem_fun (Result(T::*f)(Arg) const)
 Creates a binary function object from a class member function pointer. More...
 
template<class Result , class T >
MemFuncRef0< Result, T > mem_fun_ref (Result(T::*f)())
 Creates a unary function object from a class member function pointer. More...
 
template<class Result , class T >
ConstMemFuncRef0< Result, T > mem_fun_Ref (Result(T::*f)() const)
 Creates a unary function object from a class member function pointer. More...
 
template<class Result , class Arg , class T >
MemFuncRef1< Result, Arg, T > mem_fun_ref (Result(T::*f)(Arg))
 Creates a binary function object from a class member function pointer. More...
 
template<class Result , class Arg , class T >
ConstMemFuncRef1< Result, Arg, T > mem_fun_ref (Result(T::*f)(Arg) const)
 Creates a binary function object from a class member function pointer. More...
 
 GENERATE_TRIVIAL_HASH_FUNCTOR (bool)
 
 GENERATE_TRIVIAL_HASH_FUNCTOR (char)
 
 GENERATE_TRIVIAL_HASH_FUNCTOR (signed char)
 
 GENERATE_TRIVIAL_HASH_FUNCTOR (unsigned char)
 
 GENERATE_TRIVIAL_HASH_FUNCTOR (short)
 
 GENERATE_TRIVIAL_HASH_FUNCTOR (int)
 
 GENERATE_TRIVIAL_HASH_FUNCTOR (long)
 
bool checkGameGUIOption (const String &option, const String &str)
 
String parseGameGUIOptions (const String &str)
 
const String getGameGUIOptionsDescription (const String &options)
 
void updateGameGUIOptions (const String &options, const String &langOption)
 Updates the GUI options of the current config manager domain, when they differ to the ones passed as parameter. More...
 
uint hashit (const char *str)
 
uint hashit_lower (const char *str)
 
uint hashit (const String &str)
 
uint hashit_lower (const String &str)
 
uint32 REVERSEBITS (uint32 x)
 
ArchivemakeInstallShieldArchive (SeekableReadStream *stream, DisposeAfterUse::Flag disposeAfterUse=DisposeAfterUse::YES)
 This factory method creates an Archive instance corresponding to the content of the InstallShield compressed stream. More...
 
Language parseLanguage (const String &str)
 Convert a string containing a language name into a Language enum value. More...
 
Language parseLanguageFromLocale (const char *locale)
 
const char * getLanguageCode (Language id)
 
const char * getLanguageLocale (Language id)
 
const char * getLanguageDescription (Language id)
 
bool checkGameGUIOptionLanguage (Language lang, const String &str)
 
const String getGameGUIOptionsDescriptionLanguage (Language lang)
 
void getLanguageYesNo (Language id, KeyCode &keyYes, KeyCode &keyNo)
 Get localized equivalents for Y/N buttons of the specified language. More...
 
void getLanguageYesNo (KeyCode &keyYes, KeyCode &keyNo)
 Get localized equivalents for Y/N buttons of the current translation language of the ScummVM GUI. More...
 
int intLog2 (uint32 v)
 
template<class InputT , class OutputT >
OutputT trunc (InputT x)
 
template<class T >
trunc (T x)
 
template<class InputT , class OutputT >
OutputT rad2deg (InputT rad)
 
template<class OutputT >
OutputT rad2deg (double rad)
 
template<class T >
rad2deg (T rad)
 
template<class InputT , class OutputT >
OutputT deg2rad (InputT deg)
 
template<class OutputT >
OutputT deg2rad (double deg)
 
template<class T >
deg2rad (T deg)
 
static void md5_starts (md5_context *ctx)
 
static void md5_update (md5_context *ctx, const uint8 *input, uint32 length)
 
static void md5_finish (md5_context *ctx, uint8 digest[16])
 
static void md5_process (md5_context *ctx, const uint8 data[64])
 
bool computeStreamMD5 (ReadStream &stream, uint8 digest[16], uint32 length=0)
 Compute the MD5 checksum of the content of the given ReadStream. More...
 
String computeStreamMD5AsString (ReadStream &stream, uint32 length=0)
 Compute the MD5 checksum of the content of the given ReadStream. More...
 
template<class In , class Type >
Type * uninitialized_copy (In first, In last, Type *dst)
 Copies data from the range [first, last) to [dst, dst + (last - first)). More...
 
template<class Type , class Value >
void uninitialized_fill_n (Type *dst, size_t n, const Value &x)
 Initializes the memory [first, first + (last - first)) with the value x. More...
 
static size_t adjustChunkSize (size_t chunkSize)
 
 DECLARE_SINGLETON (OSDMessageQueue)
 
Platform parsePlatform (const String &str)
 Convert a string containing a platform name into a Platform enum value. More...
 
const char * getPlatformCode (Platform id)
 
const char * getPlatformAbbrev (Platform id)
 
const char * getPlatformDescription (Platform id)
 
static int readMP4DescLength (SeekableReadStream *stream)
 
static void readMP4Desc (SeekableReadStream *stream, byte &tag, int &length)
 
const Rational operator+ (int left, const Rational &right)
 
const Rational operator- (int left, const Rational &right)
 
const Rational operator* (int left, const Rational &right)
 
const Rational operator/ (int left, const Rational &right)
 
bool operator== (int left, const Rational &right)
 
bool operator!= (int left, const Rational &right)
 
bool operator> (int left, const Rational &right)
 
bool operator< (int left, const Rational &right)
 
bool operator>= (int left, const Rational &right)
 
bool operator<= (int left, const Rational &right)
 
RenderMode parseRenderMode (const String &str)
 Convert a string containing a render mode name into a RenderingMode enum value. More...
 
const char * getRenderModeCode (RenderMode id)
 
const char * getRenderModeDescription (RenderMode id)
 
String renderMode2GUIO (RenderMode id)
 
String allRenderModesGUIOs ()
 
U32String convertToU32String (const char *str, CodePage page)
 
U32String convertUtf8ToUtf32 (const String &str)
 
String convertFromU32String (const U32String &string, CodePage page)
 
String convertUtf32ToUtf8 (const U32String &u32str)
 
void lockMemoryPoolMutex ()
 
void unlockMemoryPoolMutex ()
 
static uint32 computeCapacity (uint32 len)
 
bool operator== (const char *y, const String &x)
 
bool operator!= (const char *y, const String &x)
 
String operator+ (const String &x, const String &y)
 
String operator+ (const char *x, const String &y)
 
String operator+ (const String &x, const char *y)
 
String operator+ (char x, const String &y)
 
String operator+ (const String &x, char y)
 
char * ltrim (char *t)
 
char * rtrim (char *t)
 
char * trim (char *t)
 
String lastPathComponent (const String &path, const char sep)
 Returns the last component of a given path. More...
 
String normalizePath (const String &path, const char sep)
 Normalize a given path to a canonical form. More...
 
bool matchString (const char *str, const char *pat, bool ignoreCase=false, bool pathMode=false)
 Simple DOS-style pattern matching function (understands * and ? like used in DOS). More...
 
void replace (Common::String &source, const Common::String &what, const Common::String &with)
 Function which replaces substring with the other. More...
 
String tag2string (uint32 tag)
 Take a 32 bit value and turn it into a four character string, where each of the four bytes is turned into one character. More...
 
size_t strlcpy (char *dst, const char *src, size_t size)
 Copy up to size - 1 characters from src to dst and also zero terminate the result. More...
 
size_t strlcat (char *dst, const char *src, size_t size)
 Append the string src to the string dst. More...
 
size_t strnlen (const char *src, size_t maxSize)
 Determine the length of a string up to a maximum of maxSize characters. More...
 
void setErrorOutputFormatter (OutputFormatter f)
 Set the output formatter used by error(). More...
 
void setErrorHandler (ErrorHandler handler)
 Set a callback that is invoked by error() after the error message has been printed, but before the application is terminated. More...
 
 DECLARE_SINGLETON (TranslationManager)
 
bool operator< (const TLanguage &l, const TLanguage &r)
 
static int32 findHeader (SeekableReadStream &stream)
 
static ArjHeaderreadHeader (SeekableReadStream &stream)
 
ArchivemakeArjArchive (const String &name)
 This factory method creates an Archive instance corresponding to the content of the ARJ compressed file with the given name. More...
 
ArchivemakeZipArchive (const String &name)
 This factory method creates an Archive instance corresponding to the content of the ZIP compressed file with the given name. More...
 
ArchivemakeZipArchive (const FSNode &node)
 This factory method creates an Archive instance corresponding to the content of the ZIP compressed file with the given name. More...
 
ArchivemakeZipArchive (SeekableReadStream *stream)
 This factory method creates an Archive instance corresponding to the content of the given ZIP compressed datastream. More...
 
static uint32 computeCapacity (uint32 len)
 
U32String operator+ (const U32String &x, const U32String &y)
 
void hexdump (const byte *data, int len, int bytesPerLine=16, int startOffset=0)
 Print a hexdump of the data passed in. More...
 
bool parseBool (const String &val, bool &valAsBool)
 Parse a string for a boolean value. More...
 
bool isAlnum (int c)
 Test whether the given character is alphanumeric (a-z, A-Z, 0-9). More...
 
bool isAlpha (int c)
 Test whether the given character is an alphabetic letter (a-z, A-Z). More...
 
bool isDigit (int c)
 Test whether the given character is a decimal-digit (0-9). More...
 
bool isXDigit (int c)
 Test whether the given character is a hwzadecimal-digit (0-9 or A-F). More...
 
bool isLower (int c)
 Test whether the given character is a lower-case letter (a-z). More...
 
bool isSpace (int c)
 Test whether the given character is a white-space. More...
 
bool isUpper (int c)
 Test whether the given character is an upper-case letter (A-Z). More...
 
bool isPrint (int c)
 Test whether the given character is printable. More...
 
bool isPunct (int c)
 Test whether the given character is a punctuation character, (i.e. More...
 
bool isCntrl (int c)
 Test whether the given character is a control character. More...
 
bool isGraph (int c)
 Test whether the given character has a graphical representation. More...
 
Common::String getHumanReadableBytes (uint64 bytes, Common::String &unitsOut)
 Represent bytes size of a file as a number with floating point and largest suitable units. More...
 
bool uncompress (byte *dst, unsigned long *dstLen, const byte *src, unsigned long srcLen)
 Thin wrapper around zlib's uncompress() function. More...
 
bool inflateZlibHeaderless (byte *dst, uint dstLen, const byte *src, uint srcLen, const byte *dict=nullptr, uint dictLen=0)
 Wrapper around zlib's inflate functions. More...
 
bool inflateZlibInstallShield (byte *dst, uint dstLen, const byte *src, uint srcLen)
 Wrapper around zlib's inflate functions. More...
 
bool inflateZlibHeaderless (Common::WriteStream *dst, Common::SeekableReadStream *src)
 Wrapper around zlib's inflate functions. More...
 
SeekableReadStreamwrapCompressedReadStream (SeekableReadStream *toBeWrapped, uint32 knownSize=0)
 Take an arbitrary SeekableReadStream and wrap it in a custom stream which provides transparent on-the-fly decompression. More...
 
WriteStreamwrapCompressedWriteStream (WriteStream *toBeWrapped)
 Take an arbitrary WriteStream and wrap it in a custom stream which provides transparent on-the-fly compression. More...
 
 DECLARE_SINGLETON (ChainedGamesManager)
 
 DECLARE_SINGLETON (Lure::SoundManager)
 
 DECLARE_SINGLETON (Pegasus::GameStateManager)
 
 DECLARE_SINGLETON (Pegasus::InputDeviceManager)
 
 DECLARE_SINGLETON (Sludge::FatalMsgManager)
 
 DECLARE_SINGLETON (Sword25::AnimationTemplateRegistry)
 
 DECLARE_SINGLETON (Sword25::RegionRegistry)
 
 DECLARE_SINGLETON (Sword25::RenderObjectRegistry)
 
 DECLARE_SINGLETON (Testbed::ConfigParams)
 
 DECLARE_SINGLETON (Wintermute::BaseEngine)
 
 DECLARE_SINGLETON (Graphics::CursorManager)
 
 DECLARE_SINGLETON (Graphics::FontManager)
 
 DECLARE_SINGLETON (Graphics::TTFLibrary)
 
 DECLARE_SINGLETON (Graphics::YUVToRGBManager)
 
 DECLARE_SINGLETON (GUI::EventRecorder)
 
 DECLARE_SINGLETON (GUI::GuiManager)
 

Variables

CoroContext nullContext = nullptr
 Helper null context instance. More...
 
static const int length_tree []
 
static const int distance_tree []
 
static const int ascii_tree []
 
static uint32 g_cp850ConversionTable []
 
static uint32 g_cp437ConversionTable []
 
const ConversionTable g_encodingConversionTables []
 
static char g_cyrillicTransliterationTable []
 
const int16 JOYAXIS_MIN = -32768
 
const int16 JOYAXIS_MAX = 32767
 
const struct Common::GameOpt g_gameOptions []
 
const LanguageDescription g_languages []
 
static const char LogTable256 [256]
 
static const uint8 md5_padding [64]
 
const PlatformDescription g_platforms []
 
const RenderModeDescription g_renderModes []
 
static const RenderGUIOMapping s_renderGUIOMapping []
 
static const uint32 g_windows1250ConversionTable []
 
static const uint32 g_windows1251ConversionTable []
 
static const uint32 g_windows1252ConversionTable []
 
static const uint32 g_windows1253ConversionTable []
 
static const uint32 g_windows1254ConversionTable []
 
static const uint32 g_windows1255ConversionTable []
 
static const uint32 g_windows1257ConversionTable []
 
MemoryPoolg_refCountPool = nullptr
 
MutexRef g_refCountPoolMutex = nullptr
 
static OutputFormatter s_errorOutputFormatter = nullptr
 
static ErrorHandler s_errorHandler = nullptr
 
static const int updateIntervals []
 
static const char * s_resTypeNames []
 
static bool _shownBackwardSeekingWarning = false
 

Detailed Description

Internal interface to the QuickTime audio decoder.

This is the namespace of the AGOS engine.

Boost Software License - Version 1.0 - August 17th, 2003.

This code is heavily based on the Pluto code base.

This is available so that the QuickTimeVideoDecoder can use this directly.

Copyright below

Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following:

The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Status of this engine: ???

Games using this engine:

  • Elvira: Mistress of the Dark
  • Elvira 2: The Jaws of Cerberus
  • The Feeble Files
  • Simon the Sorcerer
  • Simon the Sorcerer 2
  • Simon the Sorcerer Puzzle Pack

Typedef Documentation

◆ ArchiveMemberList

Definition at line 54 of file archive.h.

◆ ArchiveMemberPtr

Definition at line 53 of file archive.h.

◆ ArjHeadersMap

◆ BitStream16BELSB

16-bit big-endian data, LSB to MSB.

Definition at line 437 of file bitstream.h.

◆ BitStream16BEMSB

16-bit big-endian data, MSB to LSB.

Definition at line 435 of file bitstream.h.

◆ BitStream16LELSB

16-bit little-endian data, LSB to MSB.

Definition at line 433 of file bitstream.h.

◆ BitStream16LEMSB

16-bit little-endian data, MSB to LSB.

Definition at line 431 of file bitstream.h.

◆ BitStream32BELSB

32-bit big-endian data, LSB to MSB.

Definition at line 446 of file bitstream.h.

◆ BitStream32BEMSB

32-bit big-endian data, MSB to LSB.

Definition at line 444 of file bitstream.h.

◆ BitStream32LELSB

32-bit little-endian data, LSB to MSB.

Definition at line 442 of file bitstream.h.

◆ BitStream32LEMSB

32-bit little-endian data, MSB to LSB.

Definition at line 440 of file bitstream.h.

◆ BitStream8LSB

8-bit data, LSB to MSB.

Definition at line 428 of file bitstream.h.

◆ BitStream8MSB

8-bit data, MSB to LSB.

Definition at line 426 of file bitstream.h.

◆ BitStreamMemory16BELSB

16-bit big-endian data, LSB to MSB.

Definition at line 462 of file bitstream.h.

◆ BitStreamMemory16BEMSB

16-bit big-endian data, MSB to LSB.

Definition at line 460 of file bitstream.h.

◆ BitStreamMemory16LELSB

16-bit little-endian data, LSB to MSB.

Definition at line 458 of file bitstream.h.

◆ BitStreamMemory16LEMSB

16-bit little-endian data, MSB to LSB.

Definition at line 456 of file bitstream.h.

◆ BitStreamMemory32BELSB

32-bit big-endian data, LSB to MSB.

Definition at line 471 of file bitstream.h.

◆ BitStreamMemory32BEMSB

32-bit big-endian data, MSB to LSB.

Definition at line 469 of file bitstream.h.

◆ BitStreamMemory32LELSB

32-bit little-endian data, LSB to MSB.

Definition at line 467 of file bitstream.h.

◆ BitStreamMemory32LEMSB

32-bit little-endian data, MSB to LSB.

Definition at line 465 of file bitstream.h.

◆ BitStreamMemory8LSB

8-bit data, LSB to MSB.

Definition at line 453 of file bitstream.h.

◆ BitStreamMemory8MSB

8-bit data, MSB to LSB.

Definition at line 451 of file bitstream.h.

◆ CustomEventType

Definition at line 141 of file events.h.

◆ ErrorHandler

typedef void(* Common::ErrorHandler) (const char *msg)

A callback which is invoked by error() just before aborting.

A typical example would be a function which shows a debug console and displays the given message in it.

Definition at line 50 of file textconsole.h.

◆ IFF_ID

Definition at line 34 of file iff_container.h.

◆ InSaveFile

A class which allows game engines to load game state data.

That typically means "save games", but also includes things like the IQ points in Indy3.

Definition at line 40 of file savefile.h.

◆ JSONArray

Definition at line 82 of file json.h.

◆ JSONObject

Definition at line 84 of file json.h.

◆ MacResIDArray

Definition at line 43 of file macresman.h.

◆ MacResTagArray

Definition at line 44 of file macresman.h.

◆ MutexRef

An pseudo-opaque mutex type.

See OSystem::createMutex etc. for more details.

Definition at line 31 of file mutex.h.

◆ OutputFormatter

typedef void(* Common::OutputFormatter) (char *dst, const char *src, size_t dstSize)

An output formatter takes a source string and 'decorates' it with extra information, storing the result in a destination buffer.

A typical use is to (optionally) enhance the output given by the error() and debug() functions with extra information on the state of the active engine.

Definition at line 37 of file textconsole.h.

◆ StringArray

An array of of strings.

Definition at line 34 of file str-array.h.

◆ StringMap

◆ TLangArray

Definition at line 53 of file translation.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

List of certain special and some fake 'ascii' values used in keyboard events.

The values for the function keys listed here are based on what certain SCUMM games expect in their scripts.

Todo:
Get rid of the function key values, and instead enforce that engines use the keycode value to handle these.
Enumerator
ASCII_BACKSPACE 
ASCII_TAB 
ASCII_RETURN 
ASCII_ESCAPE 
ASCII_SPACE 
ASCII_F1 
ASCII_F2 
ASCII_F3 
ASCII_F4 
ASCII_F5 
ASCII_F6 
ASCII_F7 
ASCII_F8 
ASCII_F9 
ASCII_F10 
ASCII_F11 
ASCII_F12 

Definition at line 198 of file keyboard.h.

◆ anonymous enum

anonymous enum

Keyboard modifier flags, used for Event::kbd::flags.

Enumerator
KBD_CTRL 
KBD_ALT 
KBD_SHIFT 
KBD_META 
KBD_NON_STICKY 
KBD_NUM 
KBD_CAPS 
KBD_SCRL 
KBD_STICKY 

Definition at line 222 of file keyboard.h.

◆ anonymous enum

anonymous enum
Enumerator
INITIAL_CHUNKS_PER_PAGE 

Definition at line 28 of file memorypool.cpp.

◆ anonymous enum

anonymous enum
Enumerator
kMP4IODescTag 
kMP4ESDescTag 
kMP4DecConfigDescTag 
kMP4DecSpecificDescTag 

Definition at line 710 of file quicktime.cpp.

◆ anonymous enum

anonymous enum
Enumerator
kSpanMaxSize 
kSpanKeepOffset 

Definition at line 46 of file span.h.

◆ anonymous enum

anonymous enum
Enumerator
LF 
CR 

Definition at line 109 of file stream.cpp.

◆ anonymous enum

anonymous enum
Enumerator
kTempBufSize 

Definition at line 90 of file zlib.cpp.

◆ CodePage

Enumerator
kUtf8 
kWindows1250 
kWindows1251 
kWindows1252 
kWindows1253 
kWindows1254 
kWindows1255 
kWindows1257 

Definition at line 31 of file str-enc.h.

◆ ErrorCode

This file contains an enum with commonly used error codes.

Error codes which may be reported by plugins under various circumstances.

Note
Error names should follow the pattern k-NOUN/ACTION-CONDITION-Error. So kPathInvalidError would be correct, but these would not be: kInvalidPath, kPathInvalid, kPathIsInvalid, kInvalidPathError.
Todo:
Adjust all error codes to comply with these conventions.
Enumerator
kNoError 

No error occurred.

kNoGameDataFoundError 

Engine initialization: No game data was found in the specified location.

kUnsupportedGameidError 

Engine initialization: Gameid not supported by this (Meta)Engine.

kUnsupportedColorMode 

Engine initialization: Engine does not support backend's color mode.

kAudioDeviceInitFailed 

Engine initialization: Audio device initialization failed.

kReadPermissionDenied 

Unable to read data due to missing read permission.

kWritePermissionDenied 

Unable to write data due to missing write permission.

kPathDoesNotExist 

The specified path does not exist.

kPathNotDirectory 

The specified path does not point to a directory.

kPathNotFile 

The specified path does not point to a file.

kCreatingFileFailed 

Failed creating a (savestate) file.

kReadingFailed 

Failed to read a file (permission denied?)

kWritingFailed 

Failure to write data – disk full?

kEnginePluginNotFound 

Failed to find plugin to handle target.

kEnginePluginNotSupportSaves 

Failed if plugin does not support listing save states.

kUserCanceled 

User has canceled the launching of the game.

kUnknownError 

Catch-all error, used if no other error code matches.

Definition at line 44 of file error.h.

◆ EventType

The types of events backends may generate.

See also
Event
Todo:
Merge EVENT_LBUTTONDOWN, EVENT_RBUTTONDOWN and EVENT_WHEELDOWN; likewise EVENT_LBUTTONUP, EVENT_RBUTTONUP, EVENT_WHEELUP. To do that, we just have to add a field to the Event which indicates which button was pressed.
Enumerator
EVENT_INVALID 
EVENT_KEYDOWN 

A key was pressed, details in Event::kbd.

EVENT_KEYUP 

A key was released, details in Event::kbd.

EVENT_MOUSEMOVE 

The mouse moved, details in Event::mouse.

EVENT_LBUTTONDOWN 
EVENT_LBUTTONUP 
EVENT_RBUTTONDOWN 
EVENT_RBUTTONUP 
EVENT_WHEELUP 
EVENT_WHEELDOWN 
EVENT_MBUTTONDOWN 
EVENT_MBUTTONUP 
EVENT_MAINMENU 
EVENT_RTL 
EVENT_MUTE 
EVENT_QUIT 
EVENT_SCREEN_CHANGED 
EVENT_PREDICTIVE_DIALOG 

The backend requests the agi engine's predictive dialog to be shown.

TODO: Fingolfin suggests that it would be of better value to expand on this notion by generalizing its use. For example the backend could use events to ask for the save game dialog or to pause the engine. An associated enumerated type can accomplish this.

EVENT_DROP_FILE 
EVENT_JOYAXIS_MOTION 
EVENT_JOYBUTTON_DOWN 
EVENT_JOYBUTTON_UP 
EVENT_CLIPBOARD_UPDATE 

Definition at line 45 of file events.h.

◆ JoystickButton

The list named buttons available from a joystick.

Enumerator
JOYSTICK_BUTTON_A 
JOYSTICK_BUTTON_B 
JOYSTICK_BUTTON_X 
JOYSTICK_BUTTON_Y 
JOYSTICK_BUTTON_BACK 
JOYSTICK_BUTTON_GUIDE 
JOYSTICK_BUTTON_START 
JOYSTICK_BUTTON_LEFT_STICK 
JOYSTICK_BUTTON_RIGHT_STICK 
JOYSTICK_BUTTON_LEFT_SHOULDER 
JOYSTICK_BUTTON_RIGHT_SHOULDER 
JOYSTICK_BUTTON_DPAD_UP 
JOYSTICK_BUTTON_DPAD_DOWN 
JOYSTICK_BUTTON_DPAD_LEFT 
JOYSTICK_BUTTON_DPAD_RIGHT 

Definition at line 123 of file events.h.

◆ JSONType

Enumerator
JSONType_Null 
JSONType_String 
JSONType_Bool 
JSONType_Number 
JSONType_IntegerNumber 
JSONType_Array 
JSONType_Object 

Definition at line 88 of file json.h.

◆ KeyCode

Enumerator
KEYCODE_INVALID 
KEYCODE_BACKSPACE 
KEYCODE_TAB 
KEYCODE_CLEAR 
KEYCODE_RETURN 
KEYCODE_PAUSE 
KEYCODE_ESCAPE 
KEYCODE_SPACE 
KEYCODE_EXCLAIM 
KEYCODE_QUOTEDBL 
KEYCODE_HASH 
KEYCODE_DOLLAR 
KEYCODE_AMPERSAND 
KEYCODE_QUOTE 
KEYCODE_LEFTPAREN 
KEYCODE_RIGHTPAREN 
KEYCODE_ASTERISK 
KEYCODE_PLUS 
KEYCODE_COMMA 
KEYCODE_MINUS 
KEYCODE_PERIOD 
KEYCODE_SLASH 
KEYCODE_0 
KEYCODE_1 
KEYCODE_2 
KEYCODE_3 
KEYCODE_4 
KEYCODE_5 
KEYCODE_6 
KEYCODE_7 
KEYCODE_8 
KEYCODE_9 
KEYCODE_COLON 
KEYCODE_SEMICOLON 
KEYCODE_LESS 
KEYCODE_EQUALS 
KEYCODE_GREATER 
KEYCODE_QUESTION 
KEYCODE_AT 
KEYCODE_LEFTBRACKET 
KEYCODE_BACKSLASH 
KEYCODE_RIGHTBRACKET 
KEYCODE_CARET 
KEYCODE_UNDERSCORE 
KEYCODE_BACKQUOTE 
KEYCODE_a 
KEYCODE_b 
KEYCODE_c 
KEYCODE_d 
KEYCODE_e 
KEYCODE_f 
KEYCODE_g 
KEYCODE_h 
KEYCODE_i 
KEYCODE_j 
KEYCODE_k 
KEYCODE_l 
KEYCODE_m 
KEYCODE_n 
KEYCODE_o 
KEYCODE_p 
KEYCODE_q 
KEYCODE_r 
KEYCODE_s 
KEYCODE_t 
KEYCODE_u 
KEYCODE_v 
KEYCODE_w 
KEYCODE_x 
KEYCODE_y 
KEYCODE_z 
KEYCODE_DELETE 
KEYCODE_TILDE 
KEYCODE_KP0 
KEYCODE_KP1 
KEYCODE_KP2 
KEYCODE_KP3 
KEYCODE_KP4 
KEYCODE_KP5 
KEYCODE_KP6 
KEYCODE_KP7 
KEYCODE_KP8 
KEYCODE_KP9 
KEYCODE_KP_PERIOD 
KEYCODE_KP_DIVIDE 
KEYCODE_KP_MULTIPLY 
KEYCODE_KP_MINUS 
KEYCODE_KP_PLUS 
KEYCODE_KP_ENTER 
KEYCODE_KP_EQUALS 
KEYCODE_UP 
KEYCODE_DOWN 
KEYCODE_RIGHT 
KEYCODE_LEFT 
KEYCODE_INSERT 
KEYCODE_HOME 
KEYCODE_END 
KEYCODE_PAGEUP 
KEYCODE_PAGEDOWN 
KEYCODE_F1 
KEYCODE_F2 
KEYCODE_F3 
KEYCODE_F4 
KEYCODE_F5 
KEYCODE_F6 
KEYCODE_F7 
KEYCODE_F8 
KEYCODE_F9 
KEYCODE_F10 
KEYCODE_F11 
KEYCODE_F12 
KEYCODE_F13 
KEYCODE_F14 
KEYCODE_F15 
KEYCODE_NUMLOCK 
KEYCODE_CAPSLOCK 
KEYCODE_SCROLLOCK 
KEYCODE_RSHIFT 
KEYCODE_LSHIFT 
KEYCODE_RCTRL 
KEYCODE_LCTRL 
KEYCODE_RALT 
KEYCODE_LALT 
KEYCODE_RMETA 
KEYCODE_LMETA 
KEYCODE_LSUPER 
KEYCODE_RSUPER 
KEYCODE_MODE 
KEYCODE_COMPOSE 
KEYCODE_HELP 
KEYCODE_PRINT 
KEYCODE_SYSREQ 
KEYCODE_BREAK 
KEYCODE_MENU 
KEYCODE_POWER 
KEYCODE_EURO 
KEYCODE_UNDO 

Definition at line 39 of file keyboard.h.

◆ Language

List of game language.

Enumerator
ZH_CNA 
ZH_TWN 
HR_HRV 
CZ_CZE 
DA_DAN 
NL_NLD 
EN_ANY 
EN_GRB 
EN_USA 
ET_EST 
FI_FIN 
FR_FRA 
DE_DEU 
GR_GRE 
HE_ISR 
HU_HUN 
IT_ITA 
JA_JPN 
KO_KOR 
LV_LAT 
NB_NOR 
PL_POL 
PT_BRA 
PT_POR 
RU_RUS 
SK_SVK 
ES_ESP 
SE_SWE 
TR_TUR 
UA_UKR 
UNK_LANG 

Definition at line 35 of file language.h.

◆ Platform

List of game platforms.

Specifying a platform for a target can be used to give the game engines a hint for which platform the game data file are. This may be optional or required, depending on the game engine and the game in question.

Enumerator
kPlatformDOS 
kPlatformAmiga 
kPlatformAtari8Bit 
kPlatformAtariST 
kPlatformMacintosh 
kPlatformFMTowns 
kPlatformWindows 
kPlatformNES 
kPlatformC64 
kPlatformCoCo3 
kPlatformLinux 
kPlatformAcorn 
kPlatformSegaCD 
kPlatform3DO 
kPlatformPCEngine 
kPlatformApple2 
kPlatformApple2GS 
kPlatformPC98 
kPlatformWii 
kPlatformPSX 
kPlatformCDi 
kPlatformIOS 
kPlatformOS2 
kPlatformBeOS 
kPlatformPocketPC 
kPlatformUnknown 

Definition at line 38 of file platform.h.

◆ RecorderEventType

Enumerator
kRecorderEventTypeNormal 
kRecorderEventTypeTimer 

Definition at line 39 of file recorderfile.h.

◆ RenderMode

List of render modes.

It specifies which original graphics mode to use. Some targets used postprocessing dithering routines for reducing color depth of final image which let it to be rendered on such low-level adapters as CGA or Hercules.

Enumerator
kRenderDefault 
kRenderVGA 
kRenderEGA 
kRenderCGA 
kRenderHercG 
kRenderHercA 
kRenderAmiga 
kRenderFMTowns 
kRenderPC9821 
kRenderPC9801 
kRenderApple2GS 
kRenderAtariST 
kRenderMacintosh 

Definition at line 38 of file rendermode.h.

◆ SpanValidationMode

Enumerator
kValidateRead 
kValidateWrite 
kValidateSeek 

Definition at line 54 of file span.h.

◆ TranslationIDs

Enumerator
kTranslationAutodetectId 
kTranslationBuiltinId 

Definition at line 38 of file translation.h.

◆ WinResourceType

The default Windows resources.

Enumerator
kWinCursor 
kWinBitmap 
kWinIcon 
kWinMenu 
kWinDialog 
kWinString 
kWinFontDir 
kWinFont 
kWinAccelerator 
kWinRCData 
kWinMessageTable 
kWinGroupCursor 
kWinGroupIcon 
kWinVersion 
kWinDlgInclude 
kWinPlugPlay 
kWinVXD 
kWinAniCursor 
kWinAniIcon 
kWinHTML 
kWinManifest 

Definition at line 32 of file winexe.h.

Function Documentation

◆ addUtfEndianness()

String Common::addUtfEndianness ( const String str)

Definition at line 39 of file encoding.cpp.

◆ adjustChunkSize()

static size_t Common::adjustChunkSize ( size_t  chunkSize)
static

Definition at line 32 of file memorypool.cpp.

◆ allRenderModesGUIOs()

String Common::allRenderModesGUIOs ( )

Definition at line 118 of file rendermode.cpp.

◆ bind1st()

template<class Op >
Binder1st<Op> Common::bind1st ( const Op &  op,
typename Op::FirstArgumentType  t 
)
inline

Transforms a binary function object into an unary function object.

To achieve that the first parameter is bound to the passed value t.

Definition at line 91 of file func.h.

◆ bind2nd()

template<class Op >
Binder2nd<Op> Common::bind2nd ( const Op &  op,
typename Op::SecondArgumentType  t 
)
inline

Transforms a binary function object into an unary function object.

To achieve that the first parameter is bound to the passed value t.

Definition at line 113 of file func.h.

◆ checkGameGUIOption()

bool Common::checkGameGUIOption ( const String option,
const String str 
)

Definition at line 95 of file gui_options.cpp.

◆ checkGameGUIOptionLanguage()

bool Common::checkGameGUIOptionLanguage ( Language  lang,
const String str 
)

Definition at line 117 of file language.cpp.

◆ computeCapacity() [1/2]

static uint32 Common::computeCapacity ( uint32  len)
static

Definition at line 31 of file ustr.cpp.

◆ computeCapacity() [2/2]

static uint32 Common::computeCapacity ( uint32  len)
static

Definition at line 59 of file str.cpp.

◆ computeStreamMD5()

bool Common::computeStreamMD5 ( ReadStream stream,
uint8  digest[16],
uint32  length = 0 
)

Compute the MD5 checksum of the content of the given ReadStream.

The 128 bit MD5 checksum is returned directly in the array digest. If length is set to a positive value, then only the first length bytes of the stream are used to compute the checksum.

Parameters
[in]streamthe stream of whose data the MD5 is computed
[out]digestthe computed MD5 checksum
[in]lengththe number of bytes for which to compute the checksum; 0 means all
Returns
true on success, false if an error occurred

Definition at line 247 of file md5.cpp.

◆ computeStreamMD5AsString()

String Common::computeStreamMD5AsString ( ReadStream stream,
uint32  length = 0 
)

Compute the MD5 checksum of the content of the given ReadStream.

The 128 bit MD5 checksum is converted to a human readable lowercase hex string of length 32. If length is set to a positive value, then only the first length bytes of the stream are used to compute the checksum.

Parameters
[in]streamthe stream of whose data the MD5 is computed
[in]lengththe number of bytes for which to compute the checksum; 0 means all
Returns
the MD5 as a hex string on success, and an empty string if an error occurred

Definition at line 283 of file md5.cpp.

◆ convertFromU32String()

String Common::convertFromU32String ( const U32String string,
CodePage  page 
)

Definition at line 385 of file str-enc.cpp.

◆ convertToU32String()

U32String Common::convertToU32String ( const char *  str,
CodePage  page 
)

Definition at line 377 of file str-enc.cpp.

◆ convertUtf32ToUtf8()

String Common::convertUtf32ToUtf8 ( const U32String u32str)

Definition at line 389 of file str-enc.cpp.

◆ convertUtf8ToUtf32()

U32String Common::convertUtf8ToUtf32 ( const String str)

Definition at line 381 of file str-enc.cpp.

◆ copy()

template<class In , class Out >
Out Common::copy ( In  first,
In  last,
Out  dst 
)

Copies data from the range [first, last) to [dst, dst + (last - first)).

It requires the range [dst, dst + (last - first)) to be valid. It also requires dst not to be in the range [first, last).

Definition at line 38 of file algorithm.h.

◆ copy_backward()

template<class In , class Out >
Out Common::copy_backward ( In  first,
In  last,
Out  dst 
)

Copies data from the range [first, last) to [dst - (last - first), dst).

It requires the range [dst - (last - first), dst) to be valid. It also requires dst not to be in the range [first, last).

Unlike copy copy_backward copies the data from the end to the beginning.

Definition at line 52 of file algorithm.h.

◆ copy_if()

template<class In , class Out , class Op >
Out Common::copy_if ( In  first,
In  last,
Out  dst,
Op  op 
)

Copies data from the range [first, last) to [dst, dst + (last - first)).

It requires the range [dst, dst + (last - first)) to be valid. It also requires dst not to be in the range [first, last).

Unlike copy or copy_backward it does not copy all data. It only copies a data element when operator() of the op parameter returns true for the passed data element.

Definition at line 68 of file algorithm.h.

◆ DECLARE_SINGLETON() [1/31]

Common::DECLARE_SINGLETON ( OSDMessageQueue  )

◆ DECLARE_SINGLETON() [2/31]

Common::DECLARE_SINGLETON ( Testbed::ConfigParams  )

◆ DECLARE_SINGLETON() [3/31]

Common::DECLARE_SINGLETON ( Graphics::CursorManager  )

◆ DECLARE_SINGLETON() [4/31]

Common::DECLARE_SINGLETON ( GUI::EventRecorder  )

◆ DECLARE_SINGLETON() [5/31]

Common::DECLARE_SINGLETON ( Graphics::FontManager  )

◆ DECLARE_SINGLETON() [6/31]

Common::DECLARE_SINGLETON ( OpenGL::ShaderManager  )

◆ DECLARE_SINGLETON() [7/31]

Common::DECLARE_SINGLETON ( Pegasus::GameStateManager  )

◆ DECLARE_SINGLETON() [8/31]

Common::DECLARE_SINGLETON ( Sludge::FatalMsgManager  )

◆ DECLARE_SINGLETON() [9/31]

Common::DECLARE_SINGLETON ( PowerManager  )

◆ DECLARE_SINGLETON() [10/31]

Common::DECLARE_SINGLETON ( Lure::SoundManager  )

◆ DECLARE_SINGLETON() [11/31]

Common::DECLARE_SINGLETON ( Networking::ConnectionManager  )

◆ DECLARE_SINGLETON() [12/31]

Common::DECLARE_SINGLETON ( CoroutineScheduler  )

◆ DECLARE_SINGLETON() [13/31]

Common::DECLARE_SINGLETON ( Pegasus::InputDeviceManager  )

◆ DECLARE_SINGLETON() [14/31]

Common::DECLARE_SINGLETON ( Wintermute::BaseEngine  )

◆ DECLARE_SINGLETON() [15/31]

Common::DECLARE_SINGLETON ( DebugManager  )

◆ DECLARE_SINGLETON() [16/31]

Common::DECLARE_SINGLETON ( Cloud::CloudManager  )

◆ DECLARE_SINGLETON() [17/31]

Common::DECLARE_SINGLETON ( Sword25::RegionRegistry  )

◆ DECLARE_SINGLETON() [18/31]

Common::DECLARE_SINGLETON ( Sword25::AnimationTemplateRegistry  )

◆ DECLARE_SINGLETON() [19/31]

Common::DECLARE_SINGLETON ( PspRtc  )

◆ DECLARE_SINGLETON() [20/31]

Common::DECLARE_SINGLETON ( ConfigManager  )

◆ DECLARE_SINGLETON() [21/31]

Common::DECLARE_SINGLETON ( TranslationManager  )

◆ DECLARE_SINGLETON() [22/31]

Common::DECLARE_SINGLETON ( GUI::GuiManager  )

◆ DECLARE_SINGLETON() [23/31]

Common::DECLARE_SINGLETON ( Sword25::RenderObjectRegistry  )

◆ DECLARE_SINGLETON() [24/31]

Common::DECLARE_SINGLETON ( Networking::LocalWebserver  )

◆ DECLARE_SINGLETON() [25/31]

Common::DECLARE_SINGLETON ( VramAllocator  )

◆ DECLARE_SINGLETON() [26/31]

Common::DECLARE_SINGLETON ( Graphics::YUVToRGBManager  )

◆ DECLARE_SINGLETON() [27/31]

Common::DECLARE_SINGLETON ( ChainedGamesManager  )

◆ DECLARE_SINGLETON() [28/31]

Common::DECLARE_SINGLETON ( SearchManager  )

◆ DECLARE_SINGLETON() [29/31]

Common::DECLARE_SINGLETON ( EngineManager  )

◆ DECLARE_SINGLETON() [30/31]

Common::DECLARE_SINGLETON ( Graphics::TTFLibrary  )

◆ DECLARE_SINGLETON() [31/31]

Common::DECLARE_SINGLETON ( MusicManager  )

◆ decompressDCL() [1/3]

bool Common::decompressDCL ( ReadStream sourceStream,
byte dest,
uint32  packedSize,
uint32  unpackedSize 
)

Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream.

Returns true if successful.

Definition at line 459 of file dcl.cpp.

◆ decompressDCL() [2/3]

SeekableReadStream * Common::decompressDCL ( SeekableReadStream sourceStream,
uint32  packedSize,
uint32  unpackedSize 
)

Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream.

Returns a valid pointer if successful and 0 otherwise.

Definition at line 482 of file dcl.cpp.

◆ decompressDCL() [3/3]

SeekableReadStream * Common::decompressDCL ( SeekableReadStream sourceStream)

Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream.

Returns a valid pointer if successful and 0 otherwise. This method is meant for cases, where the unpacked size is not known.

Definition at line 506 of file dcl.cpp.

◆ deg2rad() [1/3]

template<class InputT , class OutputT >
OutputT Common::deg2rad ( InputT  deg)
inline

Definition at line 149 of file math.h.

◆ deg2rad() [2/3]

template<class OutputT >
OutputT Common::deg2rad ( double  deg)
inline

Definition at line 155 of file math.h.

◆ deg2rad() [3/3]

template<class T >
T Common::deg2rad ( deg)
inline

Definition at line 162 of file math.h.

◆ distance() [1/2]

template<typename T >
unsigned int Common::distance ( T *  first,
T *  last 
)

Definition at line 150 of file algorithm.h.

◆ distance() [2/2]

template<typename T >
unsigned int Common::distance ( first,
last 
)

Definition at line 155 of file algorithm.h.

◆ errorToString()

static String Common::errorToString ( ErrorCode  errorCode)
static

Maps an error code to equivalent string description.

Parameters
errorCodeerror code to be converted
Returns
a pointer to string description of the error

Definition at line 35 of file error.cpp.

◆ fill() [1/4]

template<class Value >
signed char* Common::fill ( signed char *  first,
signed char *  last,
Value  val 
)

Definition at line 83 of file algorithm.h.

◆ fill() [2/4]

template<class Value >
unsigned char* Common::fill ( unsigned char *  first,
unsigned char *  last,
Value  val 
)

Definition at line 89 of file algorithm.h.

◆ fill() [3/4]

template<class Value >
char* Common::fill ( char *  first,
char *  last,
Value  val 
)

Definition at line 95 of file algorithm.h.

◆ fill() [4/4]

template<class In , class Value >
In Common::fill ( In  first,
In  last,
const Value val 
)

Sets all elements in the range [first, last) to val.

Definition at line 104 of file algorithm.h.

◆ find()

template<class In , class T >
In Common::find ( In  first,
In  last,
const T &  v 
)

Finds the first data value in the range [first, last) matching v.

For data comperance it uses operator == of the data elements.

Definition at line 115 of file algorithm.h.

◆ find_if()

template<class In , class Pred >
In Common::find_if ( In  first,
In  last,
Pred  p 
)

Finds the first data value in the range [first, last) for which the specified predicate p returns true.

Definition at line 129 of file algorithm.h.

◆ findHeader()

int32 Common::findHeader ( SeekableReadStream stream)
static

Definition at line 205 of file unarj.cpp.

◆ for_each()

template<class In , class Op >
Op Common::for_each ( In  first,
In  last,
Op  f 
)

Applies the function f on all elements of the range [first, last).

The processing order is from beginning to end.

Definition at line 143 of file algorithm.h.

◆ gcd()

template<class T >
T Common::gcd ( a,
b 
)

Euclid's algorithm to compute the greatest common divisor.

Definition at line 252 of file algorithm.h.

◆ GENERATE_TRIVIAL_HASH_FUNCTOR() [1/7]

Common::GENERATE_TRIVIAL_HASH_FUNCTOR ( bool  )

◆ GENERATE_TRIVIAL_HASH_FUNCTOR() [2/7]

Common::GENERATE_TRIVIAL_HASH_FUNCTOR ( char  )

◆ GENERATE_TRIVIAL_HASH_FUNCTOR() [3/7]

Common::GENERATE_TRIVIAL_HASH_FUNCTOR ( signed  char)

◆ GENERATE_TRIVIAL_HASH_FUNCTOR() [4/7]

Common::GENERATE_TRIVIAL_HASH_FUNCTOR ( unsigned  char)

◆ GENERATE_TRIVIAL_HASH_FUNCTOR() [5/7]

Common::GENERATE_TRIVIAL_HASH_FUNCTOR ( short  )

◆ GENERATE_TRIVIAL_HASH_FUNCTOR() [6/7]

Common::GENERATE_TRIVIAL_HASH_FUNCTOR ( int  )

◆ GENERATE_TRIVIAL_HASH_FUNCTOR() [7/7]

Common::GENERATE_TRIVIAL_HASH_FUNCTOR ( long  )

◆ getGameGUIOptionsDescription()

const String Common::getGameGUIOptionsDescription ( const String options)

Definition at line 117 of file gui_options.cpp.

◆ getGameGUIOptionsDescriptionLanguage()

const String Common::getGameGUIOptionsDescriptionLanguage ( Language  lang)

Definition at line 127 of file language.cpp.

◆ getHumanReadableBytes()

Common::String Common::getHumanReadableBytes ( uint64  bytes,
Common::String unitsOut 
)

Represent bytes size of a file as a number with floating point and largest suitable units.

For example, 1474560 bytes as 1.4 MB.

Parameters
bytessize in bytes to be represented
unitsOut(out-parameter) string with units
Note
use _() to translate units correctly
Returns
string with a floating point number representing given size

Definition at line 170 of file util.cpp.

◆ getLanguageCode()

const char * Common::getLanguageCode ( Language  id)

Definition at line 90 of file language.cpp.

◆ getLanguageDescription()

const char * Common::getLanguageDescription ( Language  id)

Definition at line 108 of file language.cpp.

◆ getLanguageLocale()

const char * Common::getLanguageLocale ( Language  id)

Definition at line 99 of file language.cpp.

◆ getLanguageYesNo() [1/2]

void Common::getLanguageYesNo ( Language  id,
KeyCode keyYes,
KeyCode keyNo 
)

Get localized equivalents for Y/N buttons of the specified language.

In case there is no specialized keys for the given language it will fall back to the English keys.

Parameters
idLanguage id
keyYesKey code for yes
keyNoKey code for no

Definition at line 28 of file localization.cpp.

◆ getLanguageYesNo() [2/2]

void Common::getLanguageYesNo ( KeyCode keyYes,
KeyCode keyNo 
)

Get localized equivalents for Y/N buttons of the current translation language of the ScummVM GUI.

Parameters
keyYesKey code for yes
keyNoKey code for no

Definition at line 59 of file localization.cpp.

◆ getPlatformAbbrev()

const char * Common::getPlatformAbbrev ( Platform  id)

Definition at line 95 of file platform.cpp.

◆ getPlatformCode()

const char * Common::getPlatformCode ( Platform  id)

Definition at line 86 of file platform.cpp.

◆ getPlatformDescription()

const char * Common::getPlatformDescription ( Platform  id)

Definition at line 104 of file platform.cpp.

◆ getRenderModeCode()

const char * Common::getRenderModeCode ( RenderMode  id)

Definition at line 89 of file rendermode.cpp.

◆ getRenderModeDescription()

const char * Common::getRenderModeDescription ( RenderMode  id)

Definition at line 98 of file rendermode.cpp.

◆ hashit() [1/2]

uint Common::hashit ( const char *  str)

Definition at line 32 of file hashmap.cpp.

◆ hashit() [2/2]

uint Common::hashit ( const String str)
inline

Definition at line 33 of file hash-str.h.

◆ hashit_lower() [1/2]

uint Common::hashit_lower ( const char *  str)

Definition at line 44 of file hashmap.cpp.

◆ hashit_lower() [2/2]

uint Common::hashit_lower ( const String str)
inline

Definition at line 34 of file hash-str.h.

◆ hexdump()

void Common::hexdump ( const byte data,
int  len,
int  bytesPerLine = 16,
int  startOffset = 0 
)

Print a hexdump of the data passed in.

The number of bytes per line is customizable.

Parameters
datathe data to be dumped
lenthe length of that data
bytesPerLinenumber of bytes to print per line (default: 16)
startOffsetshift the shown offsets by the starting offset (default: 0)

Definition at line 33 of file util.cpp.

◆ inflateZlibHeaderless() [1/2]

bool Common::inflateZlibHeaderless ( byte dst,
uint  dstLen,
const byte src,
uint  srcLen,
const byte dict = nullptr,
uint  dictLen = 0 
)

Wrapper around zlib's inflate functions.

This function will call the necessary inflate functions to uncompress data compressed with deflate but not with the standard zlib header.

Decompresses the src buffer into the dst buffer. srcLen is the byte length of the source buffer, dstLen is the byte length of the output buffer. It decompress as much data as possible, up to dstLen bytes. If a dictionary is provided through the dict buffer, uses it to initializes the internal decompression dictionary, before the decompression takes place.

Parameters
dstthe buffer to store into.
dstLenthe size of the destination buffer.
srcthe data to be decompressed.
srcLenthe size of the compressed data.
dict(optional) a decompress dictionary.
dictLen(optional) the size of the dictionary. Mandatory if dict is not 0.
Returns
true on success (Z_OK or Z_STREAM_END), false otherwise.

Definition at line 54 of file zlib.cpp.

◆ inflateZlibHeaderless() [2/2]

bool Common::inflateZlibHeaderless ( Common::WriteStream dst,
Common::SeekableReadStream src 
)

Wrapper around zlib's inflate functions.

This function is used by Glk to decompress TAF 4.0 files, which are headerless Zlib compressed streams with a custom header

Parameters
dstthe destination stream to write decompressed data out to
srcthe Source stream
Returns
true on success (Z_OK or Z_STREAM_END), false otherwise.

Definition at line 144 of file zlib.cpp.

◆ inflateZlibInstallShield()

bool Common::inflateZlibInstallShield ( byte dst,
uint  dstLen,
const byte src,
uint  srcLen 
)

Wrapper around zlib's inflate functions.

This function will call the necessary inflate functions to uncompress data compressed for InstallShield cabinet files.

Decompresses the src buffer into the dst buffer. srcLen is the byte length of the source buffer, dstLen is the byte length of the output buffer. It decompress as much data as possible, up to dstLen bytes.

Parameters
dstthe buffer to store into.
dstLenthe size of the destination buffer.
srcthe data to be decompressed.
srcLenthe size of the compressed data.
Returns
true on success (Z_OK or Z_STREAM_END), false otherwise.

Definition at line 94 of file zlib.cpp.

◆ intLog2()

int Common::intLog2 ( uint32  v)
inline

Definition at line 100 of file math.h.

◆ isAlnum()

bool Common::isAlnum ( int  c)

Test whether the given character is alphanumeric (a-z, A-Z, 0-9).

If the parameter is outside the range of a signed or unsigned char, then false is returned.

Parameters
cthe character to test
Returns
true if the character is alphanumeric, false otherwise.

Definition at line 111 of file util.cpp.

◆ isAlpha()

bool Common::isAlpha ( int  c)

Test whether the given character is an alphabetic letter (a-z, A-Z).

If the parameter is outside the range of a signed or unsigned char, then false is returned.

Parameters
cthe character to test
Returns
true if the character is alphabetic, false otherwise.

Definition at line 116 of file util.cpp.

◆ isCntrl()

bool Common::isCntrl ( int  c)

Test whether the given character is a control character.

Parameters
cthe character to test
Returns
true if the character is a control character, false otherwise.

Definition at line 156 of file util.cpp.

◆ isDigit()

bool Common::isDigit ( int  c)

Test whether the given character is a decimal-digit (0-9).

If the parameter is outside the range of a signed or unsigned char, then false is returned.

Parameters
cthe character to test
Returns
true if the character is a decimal-digit, false otherwise.

Definition at line 121 of file util.cpp.

◆ isGraph()

bool Common::isGraph ( int  c)

Test whether the given character has a graphical representation.

Parameters
cthe character to test
Returns
true if the character is a graphic, false otherwise.

Definition at line 161 of file util.cpp.

◆ isLower()

bool Common::isLower ( int  c)

Test whether the given character is a lower-case letter (a-z).

If the parameter is outside the range of a signed or unsigned char, then false is returned.

Parameters
cthe character to test
Returns
true if the character is a lower-case letter, false otherwise.

Definition at line 131 of file util.cpp.

◆ isPrint()

bool Common::isPrint ( int  c)

Test whether the given character is printable.

This includes the space character (' ').

If the parameter is outside the range of a signed or unsigned char, then false is returned.

Parameters
cthe character to test
Returns
true if the character is printable, false otherwise.

Definition at line 146 of file util.cpp.

◆ isPunct()

bool Common::isPunct ( int  c)

Test whether the given character is a punctuation character, (i.e.

not alphanumeric).

Parameters
cthe character to test
Returns
true if the character is punctuation, false otherwise.

Definition at line 151 of file util.cpp.

◆ isSpace()

bool Common::isSpace ( int  c)

Test whether the given character is a white-space.

White-space characters are ' ', '', '', '
', '', ''.

If the parameter is outside the range of a signed or unsigned char, then false is returned.

Parameters
cthe character to test
Returns
true if the character is a white-space, false otherwise.

Definition at line 136 of file util.cpp.

◆ isUpper()

bool Common::isUpper ( int  c)

Test whether the given character is an upper-case letter (A-Z).

If the parameter is outside the range of a signed or unsigned char, then false is returned.

Parameters
cthe character to test
Returns
true if the character is an upper-case letter, false otherwise.

Definition at line 141 of file util.cpp.

◆ isXDigit()

bool Common::isXDigit ( int  c)

Test whether the given character is a hwzadecimal-digit (0-9 or A-F).

If the parameter is outside the range of a signed or unsigned char, then false is returned.

Parameters
cthe character to test
Returns
true if the character is a hexadecimal-digit, false otherwise.

Definition at line 126 of file util.cpp.

◆ lastPathComponent()

String Common::lastPathComponent ( const String path,
const char  sep 
)

Returns the last component of a given path.

Examples: /foo/bar.txt would return 'bar.txt' /foo/bar/ would return 'bar' /foo/./bar// would return 'bar'

Parameters
paththe path of which we want to know the last component
sepcharacter used to separate path components
Returns
The last component of the path.

Definition at line 831 of file str.cpp.

◆ lockMemoryPoolMutex()

void Common::lockMemoryPoolMutex ( )

Definition at line 35 of file str.cpp.

◆ ltrim()

char * Common::ltrim ( char *  t)

Definition at line 814 of file str.cpp.

◆ makeArjArchive()

Archive * Common::makeArjArchive ( const String name)

This factory method creates an Archive instance corresponding to the content of the ARJ compressed file with the given name.

May return 0 in case of a failure.

Definition at line 812 of file unarj.cpp.

◆ makeInstallShieldArchive()

Archive * Common::makeInstallShieldArchive ( SeekableReadStream stream,
DisposeAfterUse::Flag  disposeAfterUse = DisposeAfterUse::YES 
)

This factory method creates an Archive instance corresponding to the content of the InstallShield compressed stream.

May return 0 in case of a failure.

Definition at line 208 of file installshield_cab.cpp.

◆ makeZipArchive() [1/3]

Archive * Common::makeZipArchive ( const String name)

This factory method creates an Archive instance corresponding to the content of the ZIP compressed file with the given name.

May return 0 in case of a failure.

Definition at line 1520 of file unzip.cpp.

◆ makeZipArchive() [2/3]

Archive * Common::makeZipArchive ( const FSNode node)

This factory method creates an Archive instance corresponding to the content of the ZIP compressed file with the given name.

May return 0 in case of a failure.

Definition at line 1524 of file unzip.cpp.

◆ makeZipArchive() [3/3]

Archive * Common::makeZipArchive ( SeekableReadStream stream)

This factory method creates an Archive instance corresponding to the content of the given ZIP compressed datastream.

This takes ownership of the stream, in particular, it is deleted when the ZipArchive is deleted.

May return 0 in case of a failure. In this case stream will still be deleted.

Definition at line 1528 of file unzip.cpp.

◆ matchString()

bool Common::matchString ( const char *  str,
const char *  pat,
bool  ignoreCase = false,
bool  pathMode = false 
)

Simple DOS-style pattern matching function (understands * and ? like used in DOS).

Taken from exult/files/listfiles.cc

Token meaning: "*": any character, any amount of times. "?": any character, only once. "#": any decimal digit, only once.

Example strings/patterns: String: monkey.s01 Pattern: monkey.s?? => true String: monkey.s101 Pattern: monkey.s?? => false String: monkey.s99 Pattern: monkey.s?1 => false String: monkey.s101 Pattern: monkey.s* => true String: monkey.s99 Pattern: monkey.s*1 => false String: monkey.s01 Pattern: monkey.s## => true String: monkey.s01 Pattern: monkey.### => false

Parameters
strText to be matched against the given pattern.
patGlob pattern.
ignoreCaseWhether to ignore the case when doing pattern match
pathModeWhether to use path mode, i.e., whether slashes must be matched explicitly.
Returns
true if str matches the pattern, false otherwise.

Definition at line 906 of file str.cpp.

◆ md5_finish()

void Common::md5_finish ( md5_context ctx,
uint8  digest[16] 
)
static

Definition at line 223 of file md5.cpp.

◆ md5_process()

static void Common::md5_process ( md5_context ctx,
const uint8  data[64] 
)
static

Definition at line 60 of file md5.cpp.

◆ md5_starts()

void Common::md5_starts ( md5_context ctx)
static

Definition at line 50 of file md5.cpp.

◆ md5_update()

void Common::md5_update ( md5_context ctx,
const uint8 input,
uint32  length 
)
static

Definition at line 182 of file md5.cpp.

◆ mem_fun() [1/4]

template<class Result , class T >
MemFunc0<Result, T> Common::mem_fun ( Result(T::*)()  f)
inline

Creates a unary function object from a class member function pointer.

The parameter passed to the function object is the 'this' pointer to be used for the function call.

Definition at line 217 of file func.h.

◆ mem_fun() [2/4]

template<class Result , class T >
ConstMemFunc0<Result, T> Common::mem_fun ( Result(T::*)() const  f)
inline

Creates a unary function object from a class member function pointer.

The parameter passed to the function object is the 'this' pointer to be used for the function call.

Definition at line 227 of file func.h.

◆ mem_fun() [3/4]

template<class Result , class Arg , class T >
MemFunc1<Result, Arg, T> Common::mem_fun ( Result(T::*)(Arg)  f)
inline

Creates a binary function object from a class member function pointer.

The first parameter passed to the function object is the 'this' pointer to be used for the function call. The second one is the parameter passed to the member function.

Definition at line 238 of file func.h.

◆ mem_fun() [4/4]

template<class Result , class Arg , class T >
ConstMemFunc1<Result, Arg, T> Common::mem_fun ( Result(T::*)(Arg) const  f)
inline

Creates a binary function object from a class member function pointer.

The first parameter passed to the function object is the 'this' pointer to be used for the function call. The second one is the parameter passed to the member function.

Definition at line 249 of file func.h.

◆ mem_fun_ref() [1/3]

template<class Result , class T >
MemFuncRef0<Result, T> Common::mem_fun_ref ( Result(T::*)()  f)
inline

Creates a unary function object from a class member function pointer.

The parameter passed to the function object is the object instance to be used for the function call. Note unlike mem_fun, it takes a reference as parameter. Note unlike mem_fun, it takes a reference as parameter.

Definition at line 313 of file func.h.

◆ mem_fun_Ref()

template<class Result , class T >
ConstMemFuncRef0<Result, T> Common::mem_fun_Ref ( Result(T::*)() const  f)
inline

Creates a unary function object from a class member function pointer.

The parameter passed to the function object is the object instance to be used for the function call. Note unlike mem_fun, it takes a reference as parameter.

Definition at line 324 of file func.h.

◆ mem_fun_ref() [2/3]

template<class Result , class Arg , class T >
MemFuncRef1<Result, Arg, T> Common::mem_fun_ref ( Result(T::*)(Arg)  f)
inline

Creates a binary function object from a class member function pointer.

The first parameter passed to the function object is the object instance to be used for the function call. Note unlike mem_fun, it takes a reference as parameter. The second one is the parameter passed to the member function.

Definition at line 336 of file func.h.

◆ mem_fun_ref() [3/3]

template<class Result , class Arg , class T >
ConstMemFuncRef1<Result, Arg, T> Common::mem_fun_ref ( Result(T::*)(Arg) const  f)
inline

Creates a binary function object from a class member function pointer.

The first parameter passed to the function object is the object instance to be used for the function call. Note unlike mem_fun, it takes a reference as parameter. The second one is the parameter passed to the member function.

Definition at line 348 of file func.h.

◆ normalizePath()

String Common::normalizePath ( const String path,
const char  sep 
)

Normalize a given path to a canonical form.

In particular:

  • trailing separators are removed: /foo/bar/ -> /foo/bar
  • double separators (= empty components) are removed: /foo//bar -> /foo/bar
  • dot components are removed: /foo/./bar -> /foo/bar
Todo:
remove double dot components: /foo/baz/../bar -> /foo/bar
Parameters
paththe path to normalize
septhe separator token (usually '/' on Unix-style systems, or '\' on Windows based stuff)
Returns
the normalized path

Definition at line 854 of file str.cpp.

◆ operator!=() [1/2]

bool Common::operator!= ( int  left,
const Rational right 
)

Definition at line 308 of file rational.cpp.

◆ operator!=() [2/2]

bool Common::operator!= ( const char *  y,
const String x 
)

Definition at line 740 of file str.cpp.

◆ operator*()

const Rational Common::operator* ( int  left,
const Rational right 
)

Definition at line 288 of file rational.cpp.

◆ operator+() [1/7]

const Rational Common::operator+ ( int  left,
const Rational right 
)

Definition at line 276 of file rational.cpp.

◆ operator+() [2/7]

U32String Common::operator+ ( const U32String x,
const U32String y 
)

Definition at line 456 of file ustr.cpp.

◆ operator+() [3/7]

String Common::operator+ ( const String x,
const String y 
)

Definition at line 784 of file str.cpp.

◆ operator+() [4/7]

String Common::operator+ ( const char *  x,
const String y 
)

Definition at line 790 of file str.cpp.

◆ operator+() [5/7]

String Common::operator+ ( const String x,
const char *  y 
)

Definition at line 796 of file str.cpp.

◆ operator+() [6/7]

String Common::operator+ ( char  x,
const String y 
)

Definition at line 802 of file str.cpp.

◆ operator+() [7/7]

String Common::operator+ ( const String x,
char  y 
)

Definition at line 808 of file str.cpp.

◆ operator-()

const Rational Common::operator- ( int  left,
const Rational right 
)

Definition at line 282 of file rational.cpp.

◆ operator/()

const Rational Common::operator/ ( int  left,
const Rational right 
)

Definition at line 294 of file rational.cpp.

◆ operator<() [1/2]

bool Common::operator< ( const TLanguage l,
const TLanguage r 
)

Definition at line 43 of file translation.cpp.

◆ operator<() [2/2]

bool Common::operator< ( int  left,
const Rational right 
)

Definition at line 316 of file rational.cpp.

◆ operator<=()

bool Common::operator<= ( int  left,
const Rational right 
)

Definition at line 324 of file rational.cpp.

◆ operator==() [1/2]

bool Common::operator== ( int  left,
const Rational right 
)

Definition at line 304 of file rational.cpp.

◆ operator==() [2/2]

bool Common::operator== ( const char *  y,
const String x 
)

Definition at line 736 of file str.cpp.

◆ operator>()

bool Common::operator> ( int  left,
const Rational right 
)

Definition at line 312 of file rational.cpp.

◆ operator>=()

bool Common::operator>= ( int  left,
const Rational right 
)

Definition at line 320 of file rational.cpp.

◆ parseBool()

bool Common::parseBool ( const String val,
bool &  valAsBool 
)

Parse a string for a boolean value.

The strings "true", "yes", and "1" are interpreted as true. The strings "false", "no", and "0" are interpreted as false. This function ignores case.

Parameters
[in]valthe string to parse
[out]valAsBoolthe parsing result
Returns
true if the string parsed correctly, false if an error occurred.

Definition at line 86 of file util.cpp.

◆ parseGameGUIOptions()

String Common::parseGameGUIOptions ( const String str)

Definition at line 107 of file gui_options.cpp.

◆ parseLanguage()

Language Common::parseLanguage ( const String str)

Convert a string containing a language name into a Language enum value.

Definition at line 64 of file language.cpp.

◆ parseLanguageFromLocale()

Language Common::parseLanguageFromLocale ( const char *  locale)

Definition at line 77 of file language.cpp.

◆ parsePlatform()

Platform Common::parsePlatform ( const String str)

Convert a string containing a platform name into a Platform enum value.

Definition at line 63 of file platform.cpp.

◆ parseRenderMode()

RenderMode Common::parseRenderMode ( const String str)

Convert a string containing a render mode name into a RenderingMode enum value.

Definition at line 76 of file rendermode.cpp.

◆ ptr_fun() [1/2]

template<class Arg , class Result >
PointerToUnaryFunc<Arg, Result> Common::ptr_fun ( Result(*)(Arg)  func)
inline

Creates an unary function object from a function pointer.

Definition at line 147 of file func.h.

◆ ptr_fun() [2/2]

template<class Arg1 , class Arg2 , class Result >
PointerToBinaryFunc<Arg1, Arg2, Result> Common::ptr_fun ( Result(*)(Arg1, Arg2)  func)
inline

Creates an binary function object from a function pointer.

Definition at line 155 of file func.h.

◆ rad2deg() [1/3]

template<class InputT , class OutputT >
OutputT Common::rad2deg ( InputT  rad)
inline

Definition at line 128 of file math.h.

◆ rad2deg() [2/3]

template<class OutputT >
OutputT Common::rad2deg ( double  rad)
inline

Definition at line 134 of file math.h.

◆ rad2deg() [3/3]

template<class T >
T Common::rad2deg ( rad)
inline

Definition at line 141 of file math.h.

◆ readHeader()

ArjHeader * Common::readHeader ( SeekableReadStream stream)
static

Definition at line 244 of file unarj.cpp.

◆ readMP4Desc()

static void Common::readMP4Desc ( SeekableReadStream stream,
byte tag,
int length 
)
static

Definition at line 732 of file quicktime.cpp.

◆ readMP4DescLength()

static int Common::readMP4DescLength ( SeekableReadStream stream)
static

Definition at line 717 of file quicktime.cpp.

◆ renderMode2GUIO()

String Common::renderMode2GUIO ( RenderMode  id)

Definition at line 107 of file rendermode.cpp.

◆ replace() [1/2]

template<class It , class Dat >
void Common::replace ( It  begin,
It  end,
const Dat &  original,
const Dat &  replaced 
)

Replacement algorithm for iterables.

Replaces all occurrences of "original" in [begin, end) with occurrences of "replaced".

Parameters
[in,out]beginFirst element to be examined.
[in]endLast element in the seubsection. Not examined.
[in]originalElements to be replaced.
[in]replacedElement to replace occurrences of "original".
Note
Usage examples and unit tests may be found in "test/common/algorithm.h"

Definition at line 287 of file algorithm.h.

◆ replace() [2/2]

void Common::replace ( Common::String source,
const Common::String what,
const Common::String with 
)

Function which replaces substring with the other.

It happens in place. If there is no substring found, original string is not changed.

Parameters
sourceString to search and replace substring in.
whatSubstring to replace.
withString to replace with.

Definition at line 986 of file str.cpp.

◆ REVERSEBITS()

uint32 Common::REVERSEBITS ( uint32  x)
inline

Definition at line 34 of file huffman.h.

◆ rtrim()

char * Common::rtrim ( char *  t)

Definition at line 820 of file str.cpp.

◆ setErrorHandler()

void Common::setErrorHandler ( ErrorHandler  handler)

Set a callback that is invoked by error() after the error message has been printed, but before the application is terminated.

This can be used to e.g. show a debugger console.

Definition at line 39 of file textconsole.cpp.

◆ setErrorOutputFormatter()

void Common::setErrorOutputFormatter ( OutputFormatter  f)

Set the output formatter used by error().

Definition at line 33 of file textconsole.cpp.

◆ sort() [1/3]

template<typename T , class StrictWeakOrdering >
void Common::sort ( first,
last,
StrictWeakOrdering  comp 
)

Simple sort function, modeled after std::sort.

It compares data with the given comparator object comp.

Like std::sort this is not guaranteed to be stable.

Two small quotes from wikipedia about stability:

Stable sorting algorithms maintain the relative order of records with equal keys.

Unstable sorting algorithms may change the relative order of records with equal keys, but stable sorting algorithms never do so.

For more information on that topic check out: http://en.wikipedia.org/wiki/Sorting_algorithm#Stability

NOTE: Actually as the time of writing our implementation is unstable.

Definition at line 218 of file algorithm.h.

◆ sort() [2/3]

template<typename T >
void Common::sort ( T *  first,
T *  last 
)

Simple sort function, modeled after std::sort.

Definition at line 232 of file algorithm.h.

◆ sort() [3/3]

template<class T >
void Common::sort ( first,
last 
)

Definition at line 237 of file algorithm.h.

◆ sortChoosePivot() [1/2]

template<typename T >
T* Common::sortChoosePivot ( T *  first,
T *  last 
)

Definition at line 165 of file algorithm.h.

◆ sortChoosePivot() [2/2]

template<typename T >
T Common::sortChoosePivot ( first,
last 
)

Definition at line 170 of file algorithm.h.

◆ sortPartition()

template<typename T , class StrictWeakOrdering >
T Common::sortPartition ( first,
last,
pivot,
StrictWeakOrdering &  comp 
)

Definition at line 179 of file algorithm.h.

◆ strlcat()

size_t Common::strlcat ( char *  dst,
const char *  src,
size_t  size 
)

Append the string src to the string dst.

Note that both src and dst must be zero terminated. The result will be zero terminated. At most "size - strlen(dst) - 1" bytes will be appended.

In case the dst string does not contain a zero within the first "size" bytes the dst string will not be changed and size + strlen(src) is returned.

Note
This is modeled after OpenBSD's strlcat. See the manpage here: http://www.openbsd.org/cgi-bin/man.cgi?query=strlcat
Parameters
dstThe string the source string should be appended to.
srcThe source string.
sizeThe (total) size of the destination buffer.
Returns
The length of the (non-truncated) result. That is strlen(dst) + strlen(src). In case strlen(dst) > size size + strlen(src) is returned.

Definition at line 1042 of file str.cpp.

◆ strlcpy()

size_t Common::strlcpy ( char *  dst,
const char *  src,
size_t  size 
)

Copy up to size - 1 characters from src to dst and also zero terminate the result.

Note that src must be a zero terminated string.

In case size is zero this function just returns the length of the source string.

Note
This is modeled after OpenBSD's strlcpy. See the manpage here: http://www.openbsd.org/cgi-bin/man.cgi?query=strlcpy
Parameters
dstThe destination buffer.
srcThe source string.
sizeThe size of the destination buffer.
Returns
The length of the (non-truncated) result, i.e. strlen(src).

Definition at line 1010 of file str.cpp.

◆ strnlen()

size_t Common::strnlen ( const char *  src,
size_t  maxSize 
)

Determine the length of a string up to a maximum of maxSize characters.

This should be used instead of strlen when reading the length of a C string from potentially unsafe or corrupt sources, like game assets.

Parameters
srcThe source string.
maxSizeThe maximum size of the string.
Returns
The length of the string.

Definition at line 1090 of file str.cpp.

◆ tag2string()

String Common::tag2string ( uint32  tag)

Take a 32 bit value and turn it into a four character string, where each of the four bytes is turned into one character.

Most significant byte is printed first.

Definition at line 995 of file str.cpp.

◆ trim()

char * Common::trim ( char *  t)

Definition at line 827 of file str.cpp.

◆ trunc() [1/2]

template<class InputT , class OutputT >
OutputT Common::trunc ( InputT  x)
inline

Definition at line 113 of file math.h.

◆ trunc() [2/2]

template<class T >
T Common::trunc ( x)
inline

Definition at line 120 of file math.h.

◆ uncompress()

bool Common::uncompress ( byte dst,
unsigned long *  dstLen,
const byte src,
unsigned long  srcLen 
)

Thin wrapper around zlib's uncompress() function.

This wrapper makes it possible to uncompress data in engines without being forced to link them against zlib, thus simplifying the build system.

Taken from the zlib manual: Decompresses the src buffer into the dst buffer. srcLen is the byte length of the source buffer. Upon entry, dstLen is the total size of the destination buffer, which must be large enough to hold the entire uncompressed data. Upon exit, dstLen is the actual size of the compressed buffer.

Parameters
dstthe buffer to store into.
dstLena pointer to the size of the destination buffer.
srcthe data to be decompressed.
srcLenthe size of the compressed data.
Returns
true on success (i.e. Z_OK), false otherwise.

Definition at line 50 of file zlib.cpp.

◆ uninitialized_copy()

template<class In , class Type >
Type* Common::uninitialized_copy ( In  first,
In  last,
Type *  dst 
)

Copies data from the range [first, last) to [dst, dst + (last - first)).

It requires the range [dst, dst + (last - first)) to be valid and uninitialized.

Definition at line 36 of file memory.h.

◆ uninitialized_fill_n()

template<class Type , class Value >
void Common::uninitialized_fill_n ( Type *  dst,
size_t  n,
const Value x 
)

Initializes the memory [first, first + (last - first)) with the value x.

It requires the range [first, first + (last - first)) to be valid and uninitialized. Initializes the memory [dst, dst + n) with the value x. It requires the range [dst, dst + n) to be valid and uninitialized.

Definition at line 59 of file memory.h.

◆ unlockMemoryPoolMutex()

void Common::unlockMemoryPoolMutex ( )

Definition at line 47 of file str.cpp.

◆ updateGameGUIOptions()

void Common::updateGameGUIOptions ( const String options,
const String langOption 
)

Updates the GUI options of the current config manager domain, when they differ to the ones passed as parameter.

Definition at line 129 of file gui_options.cpp.

◆ wrapBufferedReadStream()

ReadStream * Common::wrapBufferedReadStream ( ReadStream parentStream,
uint32  bufSize,
DisposeAfterUse::Flag  disposeParentStream 
)

Take an arbitrary ReadStream and wrap it in a custom stream which transparently provides buffering.

Users can specify how big the buffer should be, and whether the wrapped stream should be disposed when the wrapper is disposed.

It is safe to call this with a NULL parameter (in this case, NULL is returned).

Definition at line 359 of file stream.cpp.

◆ wrapBufferedSeekableReadStream()

SeekableReadStream * Common::wrapBufferedSeekableReadStream ( SeekableReadStream parentStream,
uint32  bufSize,
DisposeAfterUse::Flag  disposeParentStream 
)

Take an arbitrary SeekableReadStream and wrap it in a custom stream which transparently provides buffering.

Users can specify how big the buffer should be, and whether the wrapped stream should be disposed when the wrapper is disposed.

It is safe to call this with a NULL parameter (in this case, NULL is returned).

Definition at line 436 of file stream.cpp.

◆ wrapBufferedWriteStream()

WriteStream * Common::wrapBufferedWriteStream ( WriteStream parentStream,
uint32  bufSize 
)

Take an arbitrary WriteStream and wrap it in a custom stream which transparently provides buffering.

Users can specify how big the buffer should be. Currently, the parent stream is always disposed when the wrapper is disposed.

It is safe to call this with a NULL parameter (in this case, NULL is returned).

Definition at line 520 of file stream.cpp.

◆ wrapCompressedReadStream()

SeekableReadStream * Common::wrapCompressedReadStream ( SeekableReadStream toBeWrapped,
uint32  knownSize = 0 
)

Take an arbitrary SeekableReadStream and wrap it in a custom stream which provides transparent on-the-fly decompression.

Assumes the data it retrieves from the wrapped stream to be either uncompressed or in gzip format. In the former case, the original stream is returned unmodified (and in particular, not wrapped). In the latter case the stream is returned wrapped, unless there is no ZLIB support, then NULL is returned and the old stream is destroyed.

Certain GZip-formats don't supply an easily readable length, if you still need the length carried along with the stream, and you know the decompressed length at wrap-time, then it can be supplied as knownSize here. knownSize will be ignored if the GZip-stream DOES include a length. The created stream also becomes responsible for freeing the passed stream.

It is safe to call this with a NULL parameter (in this case, NULL is returned).

Parameters
toBeWrappedthe stream to be wrapped (if it is in gzip-format)
knownSizea supplied length of the compressed data (if not available directly)

Definition at line 491 of file zlib.cpp.

◆ wrapCompressedWriteStream()

WriteStream * Common::wrapCompressedWriteStream ( WriteStream toBeWrapped)

Take an arbitrary WriteStream and wrap it in a custom stream which provides transparent on-the-fly compression.

The compressed data is written in the gzip format, unless ZLIB support has been disabled, in which case the given stream is returned unmodified (and in particular, not wrapped). The created stream also becomes responsible for freeing the passed stream.

It is safe to call this with a NULL parameter (in this case, NULL is returned).

Definition at line 510 of file zlib.cpp.

Variable Documentation

◆ _shownBackwardSeekingWarning

bool Common::_shownBackwardSeekingWarning = false
static

Definition at line 218 of file zlib.cpp.

◆ ascii_tree

const int Common::ascii_tree[]
static

Definition at line 177 of file dcl.cpp.

◆ distance_tree

const int Common::distance_tree[]
static

Definition at line 134 of file dcl.cpp.

◆ g_cp437ConversionTable

uint32 Common::g_cp437ConversionTable[]
static

Definition at line 364 of file encoding.cpp.

◆ g_cp850ConversionTable

uint32 Common::g_cp850ConversionTable[]
static

Definition at line 328 of file encoding.cpp.

◆ g_cyrillicTransliterationTable

char Common::g_cyrillicTransliterationTable[]
static
Initial value:
= {
' ', 'E', 'D', 'G', 'E', 'Z', 'I', 'I', 'J', 'L', 'N', 'C', 'K', '-', 'U', 'D',
'A', 'B', 'V', 'G', 'D', 'E', 'Z', 'Z', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
'R', 'S', 'T', 'U', 'F', 'H', 'C', 'C', 'S', 'S', '\"', 'Y', '\'', 'E', 'U', 'A',
'a', 'b', 'v', 'g', 'd', 'e', 'z', 'z', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p',
'r', 's', 't', 'u', 'f', 'h', 'c', 'c', 's', 's', '\"', 'y', '\'', 'e', 'u', 'a',
'N', 'e', 'd', 'g', 'e', 'z', 'i', 'i', 'j', 'l', 'n', 'c', 'k', '?', 'u', 'd',
}

Definition at line 467 of file encoding.cpp.

◆ g_encodingConversionTables

const ConversionTable Common::g_encodingConversionTables[]
Initial value:
= {
{nullptr, nullptr}
}
static uint32 g_cp437ConversionTable[]
Definition: encoding.cpp:364
static uint32 g_cp850ConversionTable[]
Definition: encoding.cpp:328

Definition at line 405 of file encoding.cpp.

◆ g_gameOptions

const struct Common::GameOpt Common::g_gameOptions[]

◆ g_languages

const LanguageDescription Common::g_languages

Definition at line 29 of file language.cpp.

◆ g_platforms

const PlatformDescription Common::g_platforms

Definition at line 28 of file platform.cpp.

◆ g_refCountPool

MemoryPool * Common::g_refCountPool = nullptr

Definition at line 32 of file str.cpp.

◆ g_refCountPoolMutex

MutexRef Common::g_refCountPoolMutex = nullptr

Definition at line 33 of file str.cpp.

◆ g_renderModes

const RenderModeDescription Common::g_renderModes
Initial value:
= {
{ "hercGreen", _s("Hercules Green"), kRenderHercG },
{ "hercAmber", _s("Hercules Amber"), kRenderHercA },
{ "cga", "CGA", kRenderCGA },
{ "ega", "EGA", kRenderEGA },
{ "vga", "VGA", kRenderVGA },
{ "amiga", "Amiga", kRenderAmiga },
{ "fmtowns", "FM-TOWNS", kRenderFMTowns },
{ "pc9821", _s("PC-9821 (256 Colors)"), kRenderPC9821 },
{ "pc9801", _s("PC-9801 (16 Colors)"), kRenderPC9801 },
{ "2gs", "Apple IIgs", kRenderApple2GS },
{ "atari", "Atari ST", kRenderAtariST },
{ "macintosh", "Macintosh", kRenderMacintosh },
{nullptr, nullptr, kRenderDefault}
}
#define _s(str)
Definition: translation.h:244

Definition at line 33 of file rendermode.cpp.

◆ g_windows1250ConversionTable

const uint32 Common::g_windows1250ConversionTable[]
static
Initial value:
= {0x20AC, 0x0081, 0x201A, 0x0083, 0x201E, 0x2026, 0x2020, 0x2021,
0x0088, 0x2030, 0x0160, 0x2039, 0x015A, 0x0164, 0x017D, 0x0179,
0x0090, 0x2018, 0x2019, 0x201C, 0x201D, 0x2022, 0x2013, 0x2014,
0x0098, 0x2122, 0x0161, 0x203A, 0x015B, 0x0165, 0x017E, 0x017A,
0x00A0, 0x02C7, 0x02D8, 0x0141, 0x00A4, 0x0104, 0x00A6, 0x00A7,
0x00A8, 0x00A9, 0x015E, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x017B,
0x00B0, 0x00B1, 0x02DB, 0x0142, 0x00B4, 0x00B5, 0x00B6, 0x00B7,
0x00B8, 0x0105, 0x015F, 0x00BB, 0x013D, 0x02DD, 0x013E, 0x017C,
0x0154, 0x00C1, 0x00C2, 0x0102, 0x00C4, 0x0139, 0x0106, 0x00C7,
0x010C, 0x00C9, 0x0118, 0x00CB, 0x011A, 0x00CD, 0x00CE, 0x010E,
0x0110, 0x0143, 0x0147, 0x00D3, 0x00D4, 0x0150, 0x00D6, 0x00D7,
0x0158, 0x016E, 0x00DA, 0x0170, 0x00DC, 0x00DD, 0x0162, 0x00DF,
0x0155, 0x00E1, 0x00E2, 0x0103, 0x00E4, 0x013A, 0x0107, 0x00E7,
0x010D, 0x00E9, 0x0119, 0x00EB, 0x011B, 0x00ED, 0x00EE, 0x010F,
0x0111, 0x0144, 0x0148, 0x00F3, 0x00F4, 0x0151, 0x00F6, 0x00F7,
0x0159, 0x016F, 0x00FA, 0x0171, 0x00FC, 0x00FD, 0x0163, 0x02D9}

Definition at line 148 of file str-enc.cpp.

◆ g_windows1251ConversionTable

const uint32 Common::g_windows1251ConversionTable[]
static
Initial value:
= {0x0402, 0x0403, 0x201A, 0x0453, 0x201E, 0x2026, 0x2020, 0x2021,
0x20AC, 0x2030, 0x0409, 0x2039, 0x040A, 0x040C, 0x040B, 0x040F,
0x0452, 0x2018, 0x2019, 0x201C, 0x201D, 0x2022, 0x2013, 0x2014,
0x0098, 0x2122, 0x0459, 0x203A, 0x045A, 0x045C, 0x045B, 0x045F,
0x00A0, 0x040E, 0x045E, 0x0408, 0x00A4, 0x0490, 0x00A6, 0x00A7,
0x0401, 0x00A9, 0x0404, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x0407,
0x00B0, 0x00B1, 0x0406, 0x0456, 0x0491, 0x00B5, 0x00B6, 0x00B7,
0x0451, 0x2116, 0x0454, 0x00BB, 0x0458, 0x0405, 0x0455, 0x0457,
0x0410, 0x0411, 0x0412, 0x0413, 0x0414, 0x0415, 0x0416, 0x0417,
0x0418, 0x0419, 0x041A, 0x041B, 0x041C, 0x041D, 0x041E, 0x041F,
0x0420, 0x0421, 0x0422, 0x0423, 0x0424, 0x0425, 0x0426, 0x0427,
0x0428, 0x0429, 0x042A, 0x042B, 0x042C, 0x042D, 0x042E, 0x042F,
0x0430, 0x0431, 0x0432, 0x0433, 0x0434, 0x0435, 0x0436, 0x0437,
0x0438, 0x0439, 0x043A, 0x043B, 0x043C, 0x043D, 0x043E, 0x043F,
0x0440, 0x0441, 0x0442, 0x0443, 0x0444, 0x0445, 0x0446, 0x0447,
0x0448, 0x0449, 0x044A, 0x044B, 0x044C, 0x044D, 0x044E, 0x044F}

Definition at line 165 of file str-enc.cpp.

◆ g_windows1252ConversionTable

const uint32 Common::g_windows1252ConversionTable[]
static
Initial value:
= {0x20AC, 0x0081, 0x201A, 0x0192, 0x201E, 0x2026, 0x2020, 0x2021,
0x02C6, 0x2030, 0x0160, 0x2039, 0x0152, 0x008D, 0x017D, 0x008F,
0x0090, 0x2018, 0x2019, 0x201C, 0x201D, 0x2022, 0x2013, 0x2014,
0x02DC, 0x2122, 0x0161, 0x203A, 0x0153, 0x009D, 0x017E, 0x0178,
0x00A0, 0x00A1, 0x00A2, 0x00A3, 0x00A4, 0x00A5, 0x00A6, 0x00A7,
0x00A8, 0x00A9, 0x00AA, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x00AF,
0x00B0, 0x00B1, 0x00B2, 0x00B3, 0x00B4, 0x00B5, 0x00B6, 0x00B7,
0x00B8, 0x00B9, 0x00BA, 0x00BB, 0x00BC, 0x00BD, 0x00BE, 0x00BF,
0x00C0, 0x00C1, 0x00C2, 0x00C3, 0x00C4, 0x00C5, 0x00C6, 0x00C7,
0x00C8, 0x00C9, 0x00CA, 0x00CB, 0x00CC, 0x00CD, 0x00CE, 0x00CF,
0x00D0, 0x00D1, 0x00D2, 0x00D3, 0x00D4, 0x00D5, 0x00D6, 0x00D7,
0x00D8, 0x00D9, 0x00DA, 0x00DB, 0x00DC, 0x00DD, 0x00DE, 0x00DF,
0x00E0, 0x00E1, 0x00E2, 0x00E3, 0x00E4, 0x00E5, 0x00E6, 0x00E7,
0x00E8, 0x00E9, 0x00EA, 0x00EB, 0x00EC, 0x00ED, 0x00EE, 0x00EF,
0x00F0, 0x00F1, 0x00F2, 0x00F3, 0x00F4, 0x00F5, 0x00F6, 0x00F7,
0x00F8, 0x00F9, 0x00FA, 0x00FB, 0x00FC, 0x00FD, 0x00FE, 0x00FF}

Definition at line 182 of file str-enc.cpp.

◆ g_windows1253ConversionTable

const uint32 Common::g_windows1253ConversionTable[]
static
Initial value:
= {0x20AC, 0x0081, 0x201A, 0x0192, 0x201E, 0x2026, 0x2020, 0x2021,
0x0088, 0x2030, 0x008A, 0x2039, 0x008C, 0x008D, 0x008E, 0x008F,
0x0090, 0x2018, 0x2019, 0x201C, 0x201D, 0x2022, 0x2013, 0x2014,
0x0098, 0x2122, 0x009A, 0x203A, 0x009C, 0x009D, 0x009E, 0x009F,
0x00A0, 0x0385, 0x0386, 0x00A3, 0x00A4, 0x00A5, 0x00A6, 0x00A7,
0x00A8, 0x00A9, 0x00AA, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x2015,
0x00B0, 0x00B1, 0x00B2, 0x00B3, 0x0384, 0x00B5, 0x00B6, 0x00B7,
0x0388, 0x0389, 0x038A, 0x00BB, 0x038C, 0x00BD, 0x038E, 0x038F,
0x0390, 0x0391, 0x0392, 0x0393, 0x0394, 0x0395, 0x0396, 0x0397,
0x0398, 0x0399, 0x039A, 0x039B, 0x039C, 0x039D, 0x039E, 0x039F,
0x03A0, 0x03A1, 0x00D2, 0x03A3, 0x03A4, 0x03A5, 0x03A6, 0x03A7,
0x03A8, 0x03A9, 0x03AA, 0x03AB, 0x03AC, 0x03AD, 0x03AE, 0x03AF,
0x03B0, 0x03B1, 0x03B2, 0x03B3, 0x03B4, 0x03B5, 0x03B6, 0x03B7,
0x03B8, 0x03B9, 0x03BA, 0x03BB, 0x03BC, 0x03BD, 0x03BE, 0x03BF,
0x03C0, 0x03C1, 0x03C2, 0x03C3, 0x03C4, 0x03C5, 0x03C6, 0x03C7,
0x03C8, 0x03C9, 0x03CA, 0x03CB, 0x03CC, 0x03CD, 0x03CE, 0x00FF}

Definition at line 199 of file str-enc.cpp.

◆ g_windows1254ConversionTable

const uint32 Common::g_windows1254ConversionTable[]
static
Initial value:
= {0x20AC, 0x0081, 0x201A, 0x0192, 0x201E, 0x2026, 0x2020, 0x2021,
0x02C6, 0x2030, 0x0160, 0x2039, 0x0152, 0x008D, 0x008E, 0x008F,
0x0090, 0x2018, 0x2019, 0x201C, 0x201D, 0x2022, 0x2013, 0x2014,
0x02DC, 0x2122, 0x0161, 0x203A, 0x0153, 0x009D, 0x009E, 0x0178,
0x00A0, 0x00A1, 0x00A2, 0x00A3, 0x00A4, 0x00A5, 0x00A6, 0x00A7,
0x00A8, 0x00A9, 0x00AA, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x00AF,
0x00B0, 0x00B1, 0x00B2, 0x00B3, 0x00B4, 0x00B5, 0x00B6, 0x00B7,
0x00B8, 0x00B9, 0x00BA, 0x00BB, 0x00BC, 0x00BD, 0x00BE, 0x00BF,
0x00C0, 0x00C1, 0x00C2, 0x00C3, 0x00C4, 0x00C5, 0x00C6, 0x00C7,
0x00C8, 0x00C9, 0x00CA, 0x00CB, 0x00CC, 0x00CD, 0x00CE, 0x00CF,
0x011E, 0x00D1, 0x00D2, 0x00D3, 0x00D4, 0x00D5, 0x00D6, 0x00D7,
0x00D8, 0x00D9, 0x00DA, 0x00DB, 0x00DC, 0x0130, 0x015E, 0x00DF,
0x00E0, 0x00E1, 0x00E2, 0x00E3, 0x00E4, 0x00E5, 0x00E6, 0x00E7,
0x00E8, 0x00E9, 0x00EA, 0x00EB, 0x00EC, 0x00ED, 0x00EE, 0x00EF,
0x011F, 0x00F1, 0x00F2, 0x00F3, 0x00F4, 0x00F5, 0x00F6, 0x00F7,
0x00F8, 0x00F9, 0x00FA, 0x00FB, 0x00FC, 0x0131, 0x015F, 0x00FF}

Definition at line 216 of file str-enc.cpp.

◆ g_windows1255ConversionTable

const uint32 Common::g_windows1255ConversionTable[]
static
Initial value:
= {0x20AC, 0x0081, 0x201A, 0x0192, 0x201E, 0x2026, 0x2020, 0x2021,
0x02C6, 0x2030, 0x008A, 0x2039, 0x008C, 0x008D, 0x008E, 0x008F,
0x0090, 0x2018, 0x2019, 0x201C, 0x201D, 0x2022, 0x2013, 0x2014,
0x02DC, 0x2122, 0x009A, 0x203A, 0x009C, 0x009D, 0x009E, 0x009F,
0x00A0, 0x00A1, 0x00A2, 0x00A3, 0x20AA, 0x00A5, 0x00A6, 0x00A7,
0x00A8, 0x00A9, 0x00D7, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x00AF,
0x00B0, 0x00B1, 0x00B2, 0x00B3, 0x00B4, 0x00B5, 0x00B6, 0x00B7,
0x00B8, 0x00B9, 0x00F7, 0x00BB, 0x00BC, 0x00BD, 0x00BE, 0x00BF,
0x05B0, 0x05B1, 0x05B2, 0x05B3, 0x05B4, 0x05B5, 0x05B6, 0x05B7,
0x05B8, 0x05B9, 0x05BA, 0x05BB, 0x05BC, 0x05BD, 0x05BE, 0x05BF,
0x05C0, 0x05C1, 0x05C2, 0x05C3, 0x05F0, 0x05F1, 0x05F2, 0x05F3,
0x05F4, 0x00D9, 0x00DA, 0x00DB, 0x00DC, 0x00DD, 0x00DE, 0x00DF,
0x05D0, 0x05D1, 0x05D2, 0x05D3, 0x05D4, 0x05D5, 0x05D6, 0x05D7,
0x05D8, 0x05D9, 0x05DA, 0x05DB, 0x05DC, 0x05DD, 0x05DE, 0x05DF,
0x05E0, 0x05E1, 0x05E2, 0x05E3, 0x05E4, 0x05E5, 0x05E6, 0x05E7,
0x05E8, 0x05E9, 0x05EA, 0x00FB, 0x00FC, 0x200E, 0x200F, 0x00FF}

Definition at line 233 of file str-enc.cpp.

◆ g_windows1257ConversionTable

const uint32 Common::g_windows1257ConversionTable[]
static
Initial value:
= {0x20AC, 0x0081, 0x201A, 0x0083, 0x201E, 0x2026, 0x2020, 0x2021,
0x0088, 0x2030, 0x008A, 0x2039, 0x008C, 0x00A8, 0x02C7, 0x00B8,
0x0090, 0x2018, 0x2019, 0x201C, 0x201D, 0x2022, 0x2013, 0x2014,
0x0098, 0x2122, 0x009A, 0x203A, 0x009C, 0x00AF, 0x02DB, 0x009F,
0x00A0, 0x00A1, 0x00A2, 0x00A3, 0x00A4, 0x00A5, 0x00A6, 0x00A7,
0x00D8, 0x00A9, 0x0156, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x00C6,
0x00B0, 0x00B1, 0x00B2, 0x00B3, 0x00B4, 0x00B5, 0x00B6, 0x00B7,
0x00F8, 0x00B9, 0x0157, 0x00BB, 0x00BC, 0x00BD, 0x00BE, 0x00E6,
0x0104, 0x012E, 0x0100, 0x0106, 0x00C4, 0x00C5, 0x0118, 0x0112,
0x010C, 0x00C9, 0x0179, 0x0116, 0x0122, 0x0136, 0x012A, 0x013B,
0x0160, 0x0143, 0x0145, 0x00D3, 0x014C, 0x00D5, 0x00D6, 0x00D7,
0x0172, 0x0141, 0x015A, 0x016A, 0x00DC, 0x017B, 0x017D, 0x00DF,
0x0105, 0x012F, 0x0101, 0x0107, 0x00E4, 0x00E5, 0x0119, 0x0113,
0x010D, 0x00E9, 0x017A, 0x0117, 0x0123, 0x0137, 0x012B, 0x013C,
0x0161, 0x0144, 0x0146, 0x00F3, 0x014D, 0x00F5, 0x00F6, 0x00F7,
0x0173, 0x0142, 0x015B, 0x016B, 0x00FC, 0x017C, 0x017E, 0x02D9}

Definition at line 250 of file str-enc.cpp.

◆ JOYAXIS_MAX

const int16 Common::JOYAXIS_MAX = 32767

Definition at line 99 of file events.h.

◆ JOYAXIS_MIN

const int16 Common::JOYAXIS_MIN = -32768

Definition at line 98 of file events.h.

◆ length_tree

const int Common::length_tree[]
static
Initial value:
= {
BN(1, 3, 4) BN(2, 5, 6)
BN(3, 7, 8) BN(4, 9, 10) BN(5, 11, 12) LN(6, 1)
BN(7, 13, 14) BN(8, 15, 16) BN(9, 17, 18) LN(10, 3) LN(11, 2) LN(12, 0)
BN(13, 19, 20) BN(14, 21, 22) BN(15, 23, 24) LN(16, 6) LN(17, 5) LN(18, 4)
BN(19, 25, 26) BN(20, 27, 28) LN(21, 10) LN(22, 9) LN(23, 8) LN(24, 7)
BN(25, 29, 30) LN(26, 13) LN(27, 12) LN(28, 11)
LN(29, 15) LN(30, 14)
0
}
#define LN(pos, value)
Definition: dcl.cpp:120
#define BN(pos, left, right)
Definition: dcl.cpp:118

Definition at line 122 of file dcl.cpp.

◆ LogTable256

const char Common::LogTable256[256]
static
Initial value:
= {
#define LT(n)
-1, 0, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3,
LT(4), LT(5), LT(5), LT(6), LT(6), LT(6), LT(6),
LT(7), LT(7), LT(7), LT(7), LT(7), LT(7), LT(7), LT(7)
}
#define LT(n)

Definition at line 93 of file math.h.

◆ md5_padding

const uint8 Common::md5_padding[64]
static
Initial value:
= {
0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
}

Definition at line 216 of file md5.cpp.

◆ s_errorHandler

ErrorHandler Common::s_errorHandler = nullptr
static

Definition at line 37 of file textconsole.cpp.

◆ s_errorOutputFormatter

OutputFormatter Common::s_errorOutputFormatter = nullptr
static

Definition at line 31 of file textconsole.cpp.

◆ s_renderGUIOMapping

const RenderGUIOMapping Common::s_renderGUIOMapping[]
static
Initial value:
= {
}
#define GUIO_RENDEREGA
Definition: gui_options.h:52
#define GUIO_RENDERMACINTOSH
Definition: gui_options.h:60
#define GUIO_RENDERATARIST
Definition: gui_options.h:59
#define GUIO_RENDERHERCAMBER
Definition: gui_options.h:50
#define GUIO_RENDERCGA
Definition: gui_options.h:51
#define GUIO_RENDERPC9821
Definition: gui_options.h:56
#define GUIO_RENDERPC9801
Definition: gui_options.h:57
#define GUIO_RENDERFMTOWNS
Definition: gui_options.h:55
#define GUIO_RENDERHERCGREEN
Definition: gui_options.h:49
#define GUIO_RENDERAPPLE2GS
Definition: gui_options.h:58
#define GUIO_RENDERAMIGA
Definition: gui_options.h:54
#define GUIO_RENDERVGA
Definition: gui_options.h:53

Definition at line 58 of file rendermode.cpp.

◆ s_resTypeNames

const char* Common::s_resTypeNames[]
static
Initial value:
= {
"", "cursor", "bitmap", "icon", "menu", "dialog", "string",
"font_dir", "font", "accelerator", "rc_data", "msg_table",
"group_cursor", "", "group_icon", "", "version", "dlg_include",
"", "plug_play", "vxd", "ani_cursor", "ani_icon", "html",
"manifest"
}

Definition at line 187 of file winexe_ne.cpp.

◆ updateIntervals

const int Common::updateIntervals[]
static
Initial value:
= {
UpdateManager::kUpdateIntervalNotSupported,
UpdateManager::kUpdateIntervalOneDay,
UpdateManager::kUpdateIntervalOneWeek,
UpdateManager::kUpdateIntervalOneMonth,
-1
}

Definition at line 29 of file updates.cpp.