ScummVM
|
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< ArchiveMember > | ArchiveMemberPtr |
typedef List< ArchiveMemberPtr > | ArchiveMemberList |
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 CoroBaseContext * | CoroContext |
typedef void(* | CORO_ADDR) (CoroContext &, const void *) |
Coroutine parameter for methods converted to coroutines. More... | |
typedef PROCESS * | PPROCESS |
typedef uint32 | CustomEventType |
typedef HashMap< String, String, IgnoreCase_Hash, IgnoreCase_EqualTo > | StringMap |
typedef uint32 | IFF_ID |
typedef Array< JSONValue * > | JSONArray |
typedef HashMap< String, JSONValue * > | JSONObject |
typedef Array< uint16 > | MacResIDArray |
typedef Array< uint32 > | MacResTagArray |
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< String > | StringArray |
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< TLanguage > | TLangArray |
typedef HashMap< String, ArjHeader *, IgnoreCase_Hash, IgnoreCase_EqualTo > | ArjHeadersMap |
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 > | |
T | sortChoosePivot (T first, T last) |
template<typename T , class StrictWeakOrdering > | |
T | 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 > | |
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) | |
ReadStream * | wrapBufferedReadStream (ReadStream *parentStream, uint32 bufSize, DisposeAfterUse::Flag disposeParentStream) |
Take an arbitrary ReadStream and wrap it in a custom stream which transparently provides buffering. More... | |
SeekableReadStream * | wrapBufferedSeekableReadStream (SeekableReadStream *parentStream, uint32 bufSize, DisposeAfterUse::Flag disposeParentStream) |
Take an arbitrary SeekableReadStream and wrap it in a custom stream which transparently provides buffering. More... | |
WriteStream * | wrapBufferedWriteStream (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... | |
SeekableReadStream * | decompressDCL (SeekableReadStream *sourceStream, uint32 packedSize, uint32 unpackedSize) |
Try to decompress a PKWARE DCL (PKWARE data compression library) compressed stream. More... | |
SeekableReadStream * | decompressDCL (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) |
Archive * | makeInstallShieldArchive (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 > | |
T | trunc (T x) |
template<class InputT , class OutputT > | |
OutputT | rad2deg (InputT rad) |
template<class OutputT > | |
OutputT | rad2deg (double rad) |
template<class T > | |
T | rad2deg (T rad) |
template<class InputT , class OutputT > | |
OutputT | deg2rad (InputT deg) |
template<class OutputT > | |
OutputT | deg2rad (double deg) |
template<class T > | |
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 ArjHeader * | readHeader (SeekableReadStream &stream) |
Archive * | makeArjArchive (const String &name) |
This factory method creates an Archive instance corresponding to the content of the ARJ compressed file with the given name. More... | |
Archive * | makeZipArchive (const String &name) |
This factory method creates an Archive instance corresponding to the content of the ZIP compressed file with the given name. More... | |
Archive * | makeZipArchive (const FSNode &node) |
This factory method creates an Archive instance corresponding to the content of the ZIP compressed file with the given name. More... | |
Archive * | makeZipArchive (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... | |
SeekableReadStream * | wrapCompressedReadStream (SeekableReadStream *toBeWrapped, uint32 knownSize=0) |
Take an arbitrary SeekableReadStream and wrap it in a custom stream which provides transparent on-the-fly decompression. More... | |
WriteStream * | wrapCompressedWriteStream (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) | |
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:
typedef BitStreamImpl<SeekableReadStream, 16, false, false> Common::BitStream16BELSB |
16-bit big-endian data, LSB to MSB.
Definition at line 437 of file bitstream.h.
typedef BitStreamImpl<SeekableReadStream, 16, false, true > Common::BitStream16BEMSB |
16-bit big-endian data, MSB to LSB.
Definition at line 435 of file bitstream.h.
typedef BitStreamImpl<SeekableReadStream, 16, true , false> Common::BitStream16LELSB |
16-bit little-endian data, LSB to MSB.
Definition at line 433 of file bitstream.h.
typedef BitStreamImpl<SeekableReadStream, 16, true , true > Common::BitStream16LEMSB |
16-bit little-endian data, MSB to LSB.
Definition at line 431 of file bitstream.h.
typedef BitStreamImpl<SeekableReadStream, 32, false, false> Common::BitStream32BELSB |
32-bit big-endian data, LSB to MSB.
Definition at line 446 of file bitstream.h.
typedef BitStreamImpl<SeekableReadStream, 32, false, true > Common::BitStream32BEMSB |
32-bit big-endian data, MSB to LSB.
Definition at line 444 of file bitstream.h.
typedef BitStreamImpl<SeekableReadStream, 32, true , false> Common::BitStream32LELSB |
32-bit little-endian data, LSB to MSB.
Definition at line 442 of file bitstream.h.
typedef BitStreamImpl<SeekableReadStream, 32, true , true > Common::BitStream32LEMSB |
32-bit little-endian data, MSB to LSB.
Definition at line 440 of file bitstream.h.
typedef BitStreamImpl<SeekableReadStream, 8, false, false> Common::BitStream8LSB |
8-bit data, LSB to MSB.
Definition at line 428 of file bitstream.h.
typedef BitStreamImpl<SeekableReadStream, 8, false, true > Common::BitStream8MSB |
8-bit data, MSB to LSB.
Definition at line 426 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 16, false, false> Common::BitStreamMemory16BELSB |
16-bit big-endian data, LSB to MSB.
Definition at line 462 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 16, false, true > Common::BitStreamMemory16BEMSB |
16-bit big-endian data, MSB to LSB.
Definition at line 460 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 16, true , false> Common::BitStreamMemory16LELSB |
16-bit little-endian data, LSB to MSB.
Definition at line 458 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 16, true , true > Common::BitStreamMemory16LEMSB |
16-bit little-endian data, MSB to LSB.
Definition at line 456 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 32, false, false> Common::BitStreamMemory32BELSB |
32-bit big-endian data, LSB to MSB.
Definition at line 471 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 32, false, true > Common::BitStreamMemory32BEMSB |
32-bit big-endian data, MSB to LSB.
Definition at line 469 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 32, true , false> Common::BitStreamMemory32LELSB |
32-bit little-endian data, LSB to MSB.
Definition at line 467 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 32, true , true > Common::BitStreamMemory32LEMSB |
32-bit little-endian data, MSB to LSB.
Definition at line 465 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 8, false, false> Common::BitStreamMemory8LSB |
8-bit data, LSB to MSB.
Definition at line 453 of file bitstream.h.
typedef BitStreamImpl<BitStreamMemoryStream, 8, false, true > Common::BitStreamMemory8MSB |
8-bit data, MSB to LSB.
Definition at line 451 of file bitstream.h.
typedef uint32 Common::CustomEventType |
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.
typedef uint32 Common::IFF_ID |
Definition at line 34 of file iff_container.h.
typedef SeekableReadStream Common::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.
typedef Array<JSONValue*> Common::JSONArray |
typedef Array<uint16> Common::MacResIDArray |
Definition at line 43 of file macresman.h.
typedef Array<uint32> Common::MacResTagArray |
Definition at line 44 of file macresman.h.
typedef OSystem::MutexRef Common::MutexRef |
An pseudo-opaque mutex type.
See OSystem::createMutex etc. for more details.
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.
typedef Array<String> Common::StringArray |
An array of of strings.
Definition at line 34 of file str-array.h.
Definition at line 76 of file hash-str.h.
typedef Array<TLanguage> Common::TLangArray |
Definition at line 53 of file translation.h.
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.
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 |
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 |
Enumerator | |
---|---|
INITIAL_CHUNKS_PER_PAGE |
Definition at line 28 of file memorypool.cpp.
anonymous enum |
Enumerator | |
---|---|
kMP4IODescTag | |
kMP4ESDescTag | |
kMP4DecConfigDescTag | |
kMP4DecSpecificDescTag |
Definition at line 710 of file quicktime.cpp.
anonymous enum |
Enumerator | |
---|---|
LF | |
CR |
Definition at line 109 of file stream.cpp.
enum Common::CodePage |
enum Common::ErrorCode |
This file contains an enum with commonly used error codes.
Error codes which may be reported by plugins under various circumstances.
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 | |
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. |
enum Common::EventType |
The types of events backends may generate.
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 |
The list named buttons available from a joystick.
enum Common::JSONType |
enum Common::KeyCode |
Definition at line 39 of file keyboard.h.
enum Common::Language |
List of game language.
Definition at line 35 of file language.h.
enum Common::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.
Definition at line 38 of file platform.h.
Enumerator | |
---|---|
kRecorderEventTypeNormal | |
kRecorderEventTypeTimer |
Definition at line 39 of file recorderfile.h.
enum Common::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.
Enumerator | |
---|---|
kTranslationAutodetectId | |
kTranslationBuiltinId |
Definition at line 38 of file translation.h.
Definition at line 39 of file encoding.cpp.
|
static |
Definition at line 32 of file memorypool.cpp.
String Common::allRenderModesGUIOs | ( | ) |
Definition at line 118 of file rendermode.cpp.
|
inline |
|
inline |
Definition at line 95 of file gui_options.cpp.
Definition at line 117 of file language.cpp.
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.
[in] | stream | the stream of whose data the MD5 is computed |
[out] | digest | the computed MD5 checksum |
[in] | length | the number of bytes for which to compute the checksum; 0 means all |
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.
[in] | stream | the stream of whose data the MD5 is computed |
[in] | length | the number of bytes for which to compute the checksum; 0 means all |
Definition at line 385 of file str-enc.cpp.
Definition at line 377 of file str-enc.cpp.
Definition at line 389 of file str-enc.cpp.
Definition at line 381 of file str-enc.cpp.
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.
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.
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.
Common::DECLARE_SINGLETON | ( | OSDMessageQueue | ) |
Common::DECLARE_SINGLETON | ( | Testbed::ConfigParams | ) |
Common::DECLARE_SINGLETON | ( | Graphics::CursorManager | ) |
Common::DECLARE_SINGLETON | ( | GUI::EventRecorder | ) |
Common::DECLARE_SINGLETON | ( | Graphics::FontManager | ) |
Common::DECLARE_SINGLETON | ( | OpenGL::ShaderManager | ) |
Common::DECLARE_SINGLETON | ( | Pegasus::GameStateManager | ) |
Common::DECLARE_SINGLETON | ( | Sludge::FatalMsgManager | ) |
Common::DECLARE_SINGLETON | ( | PowerManager | ) |
Common::DECLARE_SINGLETON | ( | Lure::SoundManager | ) |
Common::DECLARE_SINGLETON | ( | Networking::ConnectionManager | ) |
Common::DECLARE_SINGLETON | ( | CoroutineScheduler | ) |
Common::DECLARE_SINGLETON | ( | Pegasus::InputDeviceManager | ) |
Common::DECLARE_SINGLETON | ( | Wintermute::BaseEngine | ) |
Common::DECLARE_SINGLETON | ( | DebugManager | ) |
Common::DECLARE_SINGLETON | ( | Cloud::CloudManager | ) |
Common::DECLARE_SINGLETON | ( | Sword25::RegionRegistry | ) |
Common::DECLARE_SINGLETON | ( | Sword25::AnimationTemplateRegistry | ) |
Common::DECLARE_SINGLETON | ( | PspRtc | ) |
Common::DECLARE_SINGLETON | ( | ConfigManager | ) |
Common::DECLARE_SINGLETON | ( | TranslationManager | ) |
Common::DECLARE_SINGLETON | ( | GUI::GuiManager | ) |
Common::DECLARE_SINGLETON | ( | Sword25::RenderObjectRegistry | ) |
Common::DECLARE_SINGLETON | ( | Networking::LocalWebserver | ) |
Common::DECLARE_SINGLETON | ( | VramAllocator | ) |
Common::DECLARE_SINGLETON | ( | Graphics::YUVToRGBManager | ) |
Common::DECLARE_SINGLETON | ( | ChainedGamesManager | ) |
Common::DECLARE_SINGLETON | ( | SearchManager | ) |
Common::DECLARE_SINGLETON | ( | EngineManager | ) |
Common::DECLARE_SINGLETON | ( | Graphics::TTFLibrary | ) |
Common::DECLARE_SINGLETON | ( | MusicManager | ) |
bool Common::decompressDCL | ( | ReadStream * | sourceStream, |
byte * | dest, | ||
uint32 | packedSize, | ||
uint32 | unpackedSize | ||
) |
SeekableReadStream * Common::decompressDCL | ( | SeekableReadStream * | sourceStream, |
uint32 | packedSize, | ||
uint32 | unpackedSize | ||
) |
SeekableReadStream * Common::decompressDCL | ( | SeekableReadStream * | sourceStream | ) |
|
inline |
|
inline |
unsigned int Common::distance | ( | T * | first, |
T * | last | ||
) |
Definition at line 150 of file algorithm.h.
unsigned int Common::distance | ( | T | first, |
T | last | ||
) |
Definition at line 155 of file algorithm.h.
signed char* Common::fill | ( | signed char * | first, |
signed char * | last, | ||
Value | val | ||
) |
Definition at line 83 of file algorithm.h.
unsigned char* Common::fill | ( | unsigned char * | first, |
unsigned char * | last, | ||
Value | val | ||
) |
Definition at line 89 of file algorithm.h.
char* Common::fill | ( | char * | first, |
char * | last, | ||
Value | val | ||
) |
Definition at line 95 of file algorithm.h.
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.
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.
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.
|
static |
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.
T Common::gcd | ( | T | a, |
T | b | ||
) |
Euclid's algorithm to compute the greatest common divisor.
Definition at line 252 of file algorithm.h.
Common::GENERATE_TRIVIAL_HASH_FUNCTOR | ( | bool | ) |
Common::GENERATE_TRIVIAL_HASH_FUNCTOR | ( | char | ) |
Common::GENERATE_TRIVIAL_HASH_FUNCTOR | ( | signed | char | ) |
Common::GENERATE_TRIVIAL_HASH_FUNCTOR | ( | unsigned | char | ) |
Common::GENERATE_TRIVIAL_HASH_FUNCTOR | ( | short | ) |
Common::GENERATE_TRIVIAL_HASH_FUNCTOR | ( | int | ) |
Common::GENERATE_TRIVIAL_HASH_FUNCTOR | ( | long | ) |
Definition at line 117 of file gui_options.cpp.
Definition at line 127 of file language.cpp.
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.
bytes | size in bytes to be represented |
unitsOut | (out-parameter) string with units |
const char * Common::getLanguageCode | ( | Language | id | ) |
Definition at line 90 of file language.cpp.
const char * Common::getLanguageDescription | ( | Language | id | ) |
Definition at line 108 of file language.cpp.
const char * Common::getLanguageLocale | ( | Language | id | ) |
Definition at line 99 of file language.cpp.
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.
id | Language id |
keyYes | Key code for yes |
keyNo | Key code for no |
Definition at line 28 of file localization.cpp.
Get localized equivalents for Y/N buttons of the current translation language of the ScummVM GUI.
keyYes | Key code for yes |
keyNo | Key code for no |
Definition at line 59 of file localization.cpp.
const char * Common::getPlatformAbbrev | ( | Platform | id | ) |
Definition at line 95 of file platform.cpp.
const char * Common::getPlatformCode | ( | Platform | id | ) |
Definition at line 86 of file platform.cpp.
const char * Common::getPlatformDescription | ( | Platform | id | ) |
Definition at line 104 of file platform.cpp.
const char * Common::getRenderModeCode | ( | RenderMode | id | ) |
Definition at line 89 of file rendermode.cpp.
const char * Common::getRenderModeDescription | ( | RenderMode | id | ) |
Definition at line 98 of file rendermode.cpp.
uint Common::hashit | ( | const char * | str | ) |
Definition at line 32 of file hashmap.cpp.
Definition at line 33 of file hash-str.h.
uint Common::hashit_lower | ( | const char * | str | ) |
Definition at line 44 of file hashmap.cpp.
Definition at line 34 of file hash-str.h.
Print a hexdump of the data passed in.
The number of bytes per line is customizable.
data | the data to be dumped |
len | the length of that data |
bytesPerLine | number of bytes to print per line (default: 16) |
startOffset | shift the shown offsets by the starting offset (default: 0) |
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.
dst | the buffer to store into. |
dstLen | the size of the destination buffer. |
src | the data to be decompressed. |
srcLen | the size of the compressed data. |
dict | (optional) a decompress dictionary. |
dictLen | (optional) the size of the dictionary. Mandatory if dict is not 0. |
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
dst | the destination stream to write decompressed data out to |
src | the Source stream |
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.
dst | the buffer to store into. |
dstLen | the size of the destination buffer. |
src | the data to be decompressed. |
srcLen | the size of the compressed data. |
bool Common::isAlnum | ( | int | c | ) |
bool Common::isAlpha | ( | int | c | ) |
bool Common::isCntrl | ( | int | c | ) |
bool Common::isDigit | ( | int | c | ) |
bool Common::isGraph | ( | int | c | ) |
bool Common::isLower | ( | int | c | ) |
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.
c | the character to test |
bool Common::isPunct | ( | int | c | ) |
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.
c | the character to test |
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.
c | the character to test |
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.
c | the character to test |
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'
path | the path of which we want to know the last component |
sep | character used to separate path components |
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.
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.
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
str | Text to be matched against the given pattern. |
pat | Glob pattern. |
ignoreCase | Whether to ignore the case when doing pattern match |
pathMode | Whether to use path mode, i.e., whether slashes must be matched explicitly. |
|
static |
|
static |
|
static |
|
static |
|
inline |
|
inline |
|
inline |
|
inline |
|
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.
|
inline |
|
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.
|
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.
Normalize a given path to a canonical form.
In particular:
path | the path to normalize |
sep | the separator token (usually '/' on Unix-style systems, or '\' on Windows based stuff) |
Definition at line 308 of file rational.cpp.
bool Common::operator!= | ( | const char * | y, |
const String & | x | ||
) |
Definition at line 288 of file rational.cpp.
Definition at line 276 of file rational.cpp.
Definition at line 282 of file rational.cpp.
Definition at line 294 of file rational.cpp.
Definition at line 43 of file translation.cpp.
Definition at line 316 of file rational.cpp.
Definition at line 324 of file rational.cpp.
Definition at line 304 of file rational.cpp.
bool Common::operator== | ( | const char * | y, |
const String & | x | ||
) |
Definition at line 312 of file rational.cpp.
Definition at line 320 of file rational.cpp.
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.
[in] | val | the string to parse |
[out] | valAsBool | the parsing result |
Definition at line 107 of file gui_options.cpp.
Convert a string containing a language name into a Language enum value.
Definition at line 64 of file language.cpp.
Language Common::parseLanguageFromLocale | ( | const char * | locale | ) |
Definition at line 77 of file language.cpp.
Convert a string containing a platform name into a Platform enum value.
Definition at line 63 of file platform.cpp.
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.
|
inline |
|
inline |
|
inline |
|
inline |
|
static |
|
static |
Definition at line 732 of file quicktime.cpp.
|
static |
Definition at line 717 of file quicktime.cpp.
String Common::renderMode2GUIO | ( | RenderMode | id | ) |
Definition at line 107 of file rendermode.cpp.
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".
[in,out] | begin | First element to be examined. |
[in] | end | Last element in the seubsection. Not examined. |
[in] | original | Elements to be replaced. |
[in] | replaced | Element to replace occurrences of "original". |
Definition at line 287 of file algorithm.h.
void Common::replace | ( | Common::String & | source, |
const Common::String & | what, | ||
const Common::String & | with | ||
) |
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.
void Common::setErrorOutputFormatter | ( | OutputFormatter | f | ) |
Set the output formatter used by error().
Definition at line 33 of file textconsole.cpp.
void Common::sort | ( | T | first, |
T | 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.
void Common::sort | ( | T * | first, |
T * | last | ||
) |
Simple sort function, modeled after std::sort.
Definition at line 232 of file algorithm.h.
void Common::sort | ( | T | first, |
T | last | ||
) |
Definition at line 237 of file algorithm.h.
T* Common::sortChoosePivot | ( | T * | first, |
T * | last | ||
) |
Definition at line 165 of file algorithm.h.
T Common::sortChoosePivot | ( | T | first, |
T | last | ||
) |
Definition at line 170 of file algorithm.h.
T Common::sortPartition | ( | T | first, |
T | last, | ||
T | pivot, | ||
StrictWeakOrdering & | comp | ||
) |
Definition at line 179 of file algorithm.h.
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.
dst | The string the source string should be appended to. |
src | The source string. |
size | The (total) size of the destination buffer. |
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.
dst | The destination buffer. |
src | The source string. |
size | The size of the destination buffer. |
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.
src | The source string. |
maxSize | The maximum size of the string. |
|
inline |
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.
dst | the buffer to store into. |
dstLen | a pointer to the size of the destination buffer. |
src | the data to be decompressed. |
srcLen | the size of the compressed data. |
Type* Common::uninitialized_copy | ( | In | first, |
In | last, | ||
Type * | dst | ||
) |
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.
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.
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.
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.
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.
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).
toBeWrapped | the stream to be wrapped (if it is in gzip-format) |
knownSize | a supplied length of the compressed data (if not available directly) |
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).
|
static |
Definition at line 364 of file encoding.cpp.
|
static |
Definition at line 328 of file encoding.cpp.
|
static |
Definition at line 467 of file encoding.cpp.
const ConversionTable Common::g_encodingConversionTables[] |
Definition at line 405 of file encoding.cpp.
const struct Common::GameOpt Common::g_gameOptions[] |
const LanguageDescription Common::g_languages |
Definition at line 29 of file language.cpp.
const PlatformDescription Common::g_platforms |
Definition at line 28 of file platform.cpp.
MemoryPool * Common::g_refCountPool = nullptr |
const RenderModeDescription Common::g_renderModes |
Definition at line 33 of file rendermode.cpp.
|
static |
Definition at line 148 of file str-enc.cpp.
|
static |
Definition at line 165 of file str-enc.cpp.
|
static |
Definition at line 182 of file str-enc.cpp.
|
static |
Definition at line 199 of file str-enc.cpp.
|
static |
Definition at line 216 of file str-enc.cpp.
|
static |
Definition at line 233 of file str-enc.cpp.
|
static |
Definition at line 250 of file str-enc.cpp.
|
static |
|
static |
|
static |
|
static |
Definition at line 37 of file textconsole.cpp.
|
static |
Definition at line 31 of file textconsole.cpp.
|
static |
Definition at line 58 of file rendermode.cpp.
|
static |
Definition at line 187 of file winexe_ne.cpp.
|
static |
Definition at line 29 of file updates.cpp.