CrystalSpace

Public API Reference

cssysdef.h File Reference

This file should be #included before any other Crystal Space header files. More...

#include "csdef.h"
#include "csutil/csosdefs.h"
#include "csextern.h"
#include <stdio.h>
#include <stdlib.h>
#include <new>
#include <sys/param.h>
#include <malloc.h>

Go to the source code of this file.

Namespaces

namespace  CS
 

Main namespace for CrystalSpace.


namespace  CS::Debug
 

Debugging utilities and helpers.


Defines

#define CS_ALIGNED_MEMBER(Member, Align)   Member __attribute((aligned(Align)))
 Macro to align a class member (or local variable) to a specific byte boundary.
#define CS_ALLOC_STACK_ARRAY(type, var, size)   type var [size]
 Dynamic stack memory allocation.
#define CS_ASSERT(x)   (void)0
 Assertion.
#define CS_ASSERT_MSG(m, x)   (void)0
 Same as CS_ASSERT(expr), but additionally prints msg to stderr.
#define CS_ATTRIBUTE_INIT_PRIORITY(PRI)
 Namespace-level object initialization priority attribute.
#define CS_DEBUG_BREAK
 Stops program execution and break into debugger, if present - otherwise, probably just throws an exception/signal (ie crashes).
#define CS_DECLARE_STATIC_CLASSVAR(var, getterFunc, Type)
 Declare a static variable inside a class.
#define CS_DEFINE_STATICALLY_LINKED_FLAG
 Define the scfStaticallyLinked variable.
#define CS_DEPRECATED_METHOD   CS_ATTRIBUTE_DEPRECATED
 Use the CS_DEPRECATED_METHOD macro in front of method declarations to indicate that they are deprecated.
#define CS_DEPRECATED_METHOD
 Use the CS_DEPRECATED_METHOD macro in front of method declarations to indicate that they are deprecated.
#define CS_DEPRECATED_METHOD_MSG(msg)   CS_DEPRECATED_METHOD
 A variant of CS_DEPRECATED_METHOD that also emits the message msg on compilers that support it.
#define CS_DEPRECATED_TYPE   CS_ATTRIBUTE_DEPRECATED
 Use the CS_DEPRECATED_TYPE macro after type declarations to indicate that they are deprecated.
#define CS_DEPRECATED_TYPE
 Use the CS_DEPRECATED_TYPE macro after type declarations to indicate that they are deprecated.
#define CS_DEPRECATED_TYPE_MSG(msg)   CS_DEPRECATED_TYPE
 A variant of CS_DEPRECATED_TYPE that also emits the message msg on compilers that support it.
#define CS_DEPRECATED_VAR(decl)   decl CS_ATTRIBUTE_DEPRECATED
 Use the CS_DEPRECATED_VAR macro tol indicate that a variable or class/struct is deprecated.
#define CS_DEPRECATED_VAR(decl)   decl
 Use the CS_DEPRECATED_VAR macro tol indicate that a variable or class/struct is deprecated.
#define CS_DEPRECATED_VAR_MSG(msg, decl)   CS_DEPRECATED_VAR(decl)
 A variant of CS_DEPRECATED_VAR that also emits the message msg on compilers that support it.
#define CS_FUNCTION_NAME   __PRETTY_FUNCTION__
 Macro that resolves to a compiler-specific variable or string that contains the name of the current function.
#define CS_HEADER_GLOBAL(X, Y)   CS_HEADER_GLOBAL_COMPOSE(X,Y)
 The CS_HEADER_GLOBAL() macro composes a pathname from two components and wraps the path in `<' and `>'.
#define CS_HEADER_LOCAL(X, Y)   CS_HEADER_LOCAL_COMPOSE1(X,Y)
 The CS_HEADER_LOCAL() macro composes a pathname from two components and wraps the path in double-quotes.
#define CS_IMPLEMENT_APPLICATION
 The CS_IMPLEMENT_APPLICATION macro should be placed at the global scope in exactly one compilation unit comprising an application.
#define CS_IMPLEMENT_FOREIGN_DLL
 The CS_IMPLEMENT_FOREIGN_DLL macro should be placed at the global scope in exactly one compilation unit comprising a foreign (non-Crystal Space) module.
#define CS_IMPLEMENT_IMPLICIT_PTR_CAST(classname)
 Implements a static member function for a class which can be used to perform implicit pointer casts.
#define CS_IMPLEMENT_STATIC_CLASSVAR(Class, var, getterFunc, Type, initParam)   CS_IMPLEMENT_STATIC_CLASSVAR_EXT(Class,var,getterFunc,Type,initParam,_kill)
 Create the static class variable that has been declared with CS_DECLARE_STATIC_CLASSVAR.
#define CS_IMPLEMENT_STATIC_VAR(getterFunc, Type, initParam)   CS_IMPLEMENT_STATIC_VAR_EXT(getterFunc,Type,initParam,_kill)
 Implement a file-scoped static variable that is created on demand.
#define CS_IMPLICIT_PTR_CAST(classname, ptr)   (classname::_CS_IMPLICITPTRCAST_NAME(ptr))
 Perform a compiler implicit cast of a pointer to another pointer type using a static member function declared with the CS_IMPLEMENT_IMPLICIT_PTR_CAST macro.
#define CS_INITIALIZE_PLATFORM_APPLICATION
 Perform platform-specific application initializations.
#define CS_MAXPATHLEN   1024
 Maximum length of a filesystem pathname.
#define CS_NO_EXCEPTIONS
 This is defined when the project was compiled without support for exceptions.
#define CS_REGISTER_STATIC_FOR_DESTRUCTION(getterFunc)   csStaticVarCleanup (getterFunc);
 Register a method that will destruct one static variable.
#define CS_STATIC_VARIABLE_CLEANUP   csStaticVarCleanup (0);
 Invoke the function that will call all destruction functions.
#define CS_STRING_TO_WIDE(x)   CS_STRING_TO_WIDE_(x)
 Convert a string to a wide string.
#define CS_VA_COPY(dest, src)   __va_copy(dest, src)
 Copies the state of a va_list value.
Plugin namespace helpers

To avoid symbol conflicts when employing static linking, it is a good idea to put everything into a private namespace.

The CS_PLUGIN_NAMESPACE_BEGIN and CS_PLUGIN_NAMESPACE_END macros help with that by putting the plugin namespace into a sub-namespace for plugins.

Use like:

 #include <...>

 CS_IMPLEMENT_PLUGIN

 CS_PLUGIN_NAMESPACE_BEGIN(MyPlugin)
 {
   ...
   MyClass::MyClass (...) { ... }
   ...
 }
 CS_PLUGIN_NAMESPACE_END(MyPlugin)

To refer to members of the namespace (e.g. for template specializations, use CS_PLUGIN_NAMESPACE_NAME.

#define CS_PLUGIN_NAMESPACE_BEGIN(name)   namespace CS_NAMESPACE_PACKAGE_NAME { namespace Plugin { namespace name
#define CS_PLUGIN_NAMESPACE_END(name)   } }
#define CS_PLUGIN_NAMESPACE_NAME(name)   CS_NAMESPACE_PACKAGE_NAME::Plugin::name

Functions

static void CS::Debug::DebugBreak ()
 Break execution for debugging purposes.
void CS::Debug::DumpAllocateMemoryBlocks ()
 Print all memory blocks allocated with the "checking" functions, including where they were allocated, to a file "allocations.txt".
bool CS::Debug::VerifyAllMemory ()
 Verify that all memory blocks allocated with the "checking" functions did not overrun or the allocated space.
ptmalloc memory allocation

void * ptmalloc (size_t n)
void ptfree (void *p)
void * ptrealloc (void *p, size_t n)
void * ptcalloc (size_t n, size_t s)
'Cookie' memory allocation

void * ptmalloc_sentinel (size_t n)
void ptfree_sentinel (void *p)
void * ptrealloc_sentinel (void *p, size_t n)
void * ptcalloc_sentinel (size_t n, size_t s)
'Located' memory allocation

void * ptmalloc_located (size_t n)
void ptfree_located (void *p)
void * ptrealloc_located (void *p, size_t n)
void * ptcalloc_located (size_t n, size_t s)
'Checking' memory allocation

Located allocation, but additionally all allocated blocks are frequently checked for corruption, not just when a block is freed.

void * ptmalloc_checking (size_t n)
void ptfree_checking (void *p)
void * ptrealloc_checking (void *p, size_t n)
void * ptcalloc_checking (size_t n, size_t s)
Default Crystal Space memory allocation

Always the same memory allocation functions as internally used by Crystal Space.

void * cs_malloc (size_t n)
void cs_free (void *p)
void * cs_realloc (void *p, size_t n)
void * cs_calloc (size_t n, size_t s)

Detailed Description

This file should be #included before any other Crystal Space header files.

It sets up a compilation environment which smooths over differences between platforms, allowing the same code to compile cleanly over a variety of operating systems and build tools. It also provides a number of utility macros useful to projects utilizing Crystal Space and to the Crystal Space code itself.

Definition in file cssysdef.h.


Define Documentation

#define CS_ALIGNED_MEMBER (   Member,
  Align 
)    Member __attribute((aligned(Align)))

Macro to align a class member (or local variable) to a specific byte boundary.

Example:

 struct MyStruct
 {
   CS_ALIGNED_MEMBER(int x[4], 16);
 };

Definition at line 1029 of file cssysdef.h.

#define CS_ALLOC_STACK_ARRAY (   type,
  var,
  size 
)    type var [size]

Dynamic stack memory allocation.

Parameters:
type Type of the array elements.
var Name of the array to be allocated.
size Number of elements to be allocated.

Definition at line 258 of file cssysdef.h.

#define CS_ASSERT (   x  )     (void)0

Assertion.

If expr is false, a message containing the failing expression as well as a call stack is printed to stderr and a debug break is performed

Remarks:
Breaking execution can be avoided at runtime by setting the environment variable "CS_ASSERT_IGNORE" to a value other than 0.
#define CS_ASSERT_MSG (   m,
  x 
)    (void)0

Same as CS_ASSERT(expr), but additionally prints msg to stderr.

#define CS_ATTRIBUTE_INIT_PRIORITY (   PRI  ) 

Namespace-level object initialization priority attribute.

Definition at line 116 of file cssysdef.h.

#define CS_DEBUG_BREAK

Stops program execution and break into debugger, if present - otherwise, probably just throws an exception/signal (ie crashes).

#define CS_DECLARE_STATIC_CLASSVAR (   var,
  getterFunc,
  Type 
)
Value:
static Type *var;                                             \
static Type *getterFunc ();                                   \
static void getterFunc ## _kill ();                           \
static void getterFunc ## _kill_array ();

Declare a static variable inside a class.

This will also declare a Getter function. Example:

 CS_DECLARE_STATIC_CLASSVAR (pool, GetVertexPool, csVertexPool)
 

Definition at line 617 of file cssysdef.h.

#define CS_DEFINE_STATICALLY_LINKED_FLAG

Define the scfStaticallyLinked variable.

Definition at line 422 of file cssysdef.h.

#define CS_DEPRECATED_METHOD   CS_ATTRIBUTE_DEPRECATED

Use the CS_DEPRECATED_METHOD macro in front of method declarations to indicate that they are deprecated.

Example:

 struct iFoo : iBase {
   CS_DEPRECATED_METHOD virtual void Plankton() const = 0;
 }

Compilers which are capable of flagging deprecation will exhibit a warning when it encounters client code invoking methods so tagged.

Definition at line 146 of file cssysdef.h.

#define CS_DEPRECATED_METHOD

Use the CS_DEPRECATED_METHOD macro in front of method declarations to indicate that they are deprecated.

Example:

 struct iFoo : iBase {
   CS_DEPRECATED_METHOD virtual void Plankton() const = 0;
 }

Compilers which are capable of flagging deprecation will exhibit a warning when it encounters client code invoking methods so tagged.

Definition at line 146 of file cssysdef.h.

#define CS_DEPRECATED_METHOD_MSG (   msg  )     CS_DEPRECATED_METHOD

A variant of CS_DEPRECATED_METHOD that also emits the message msg on compilers that support it.

Definition at line 158 of file cssysdef.h.

#define CS_DEPRECATED_TYPE   CS_ATTRIBUTE_DEPRECATED

Use the CS_DEPRECATED_TYPE macro after type declarations to indicate that they are deprecated.

Example:

 typedef CS_DEPRECATED_TYPE csFoo csBar;
 class CS_DEPRECATED_TYPE csBaz { };

Compilers which are capable of flagging deprecation will exhibit a warning when it encounters client code using types so tagged.

Definition at line 176 of file cssysdef.h.

#define CS_DEPRECATED_TYPE

Use the CS_DEPRECATED_TYPE macro after type declarations to indicate that they are deprecated.

Example:

 typedef CS_DEPRECATED_TYPE csFoo csBar;
 class CS_DEPRECATED_TYPE csBaz { };

Compilers which are capable of flagging deprecation will exhibit a warning when it encounters client code using types so tagged.

Definition at line 176 of file cssysdef.h.

#define CS_DEPRECATED_TYPE_MSG (   msg  )     CS_DEPRECATED_TYPE

A variant of CS_DEPRECATED_TYPE that also emits the message msg on compilers that support it.

Definition at line 188 of file cssysdef.h.

#define CS_DEPRECATED_VAR (   decl  )     decl CS_ATTRIBUTE_DEPRECATED

Use the CS_DEPRECATED_VAR macro tol indicate that a variable or class/struct is deprecated.

Example:

 struct MyStuff
 {
   int newStuff;
   CS_DEPRECATED_VAR(int oldStuff);
 };

Compilers which are capable of flagging deprecation will exhibit a warning when it encounters client code using types so tagged.

Definition at line 209 of file cssysdef.h.

#define CS_DEPRECATED_VAR (   decl  )     decl

Use the CS_DEPRECATED_VAR macro tol indicate that a variable or class/struct is deprecated.

Example:

 struct MyStuff
 {
   int newStuff;
   CS_DEPRECATED_VAR(int oldStuff);
 };

Compilers which are capable of flagging deprecation will exhibit a warning when it encounters client code using types so tagged.

Definition at line 209 of file cssysdef.h.

#define CS_DEPRECATED_VAR_MSG (   msg,
  decl 
)    CS_DEPRECATED_VAR(decl)

A variant of CS_DEPRECATED_VAR that also emits the message msg on compilers that support it.

Definition at line 221 of file cssysdef.h.

#define CS_FUNCTION_NAME   __PRETTY_FUNCTION__

Macro that resolves to a compiler-specific variable or string that contains the name of the current function.

Definition at line 722 of file cssysdef.h.

#define CS_HEADER_GLOBAL (   X,
  Y 
)    CS_HEADER_GLOBAL_COMPOSE(X,Y)

The CS_HEADER_GLOBAL() macro composes a pathname from two components and wraps the path in `<' and `>'.

This macro is useful in cases where one does not have the option of augmenting the preprocessor's header search path, even though the include path for some header file may vary from platform to platform. For instance, on many platforms OpenGL headers are in a `GL' directory, whereas on other platforms they are in an `OpenGL' directory. As an example, in the first case, the platform might define the preprocessor macro GLPATH with the value `GL', and in the second case GLPATH would be given the value `OpenGL'. To actually include an OpenGL header, such as gl.h, the following code would be used:

 #include CS_HEADER_GLOBAL(GLPATH,gl.h)
 

Definition at line 293 of file cssysdef.h.

#define CS_HEADER_LOCAL (   X,
  Y 
)    CS_HEADER_LOCAL_COMPOSE1(X,Y)

The CS_HEADER_LOCAL() macro composes a pathname from two components and wraps the path in double-quotes.

This macro is useful in cases where one does not have the option of augmenting the preprocessor's header search path, even though the include path for some header file may vary from platform to platform. For example, assuming that the preprocessor macro UTILPATH is defined with some platform-specific value, to actually include a header, such as util.h, the following code would be used:

 #include CS_HEADER_LOCAL(UTILPATH,util.h)
 

Definition at line 308 of file cssysdef.h.

#define CS_IMPLEMENT_APPLICATION
Value:
CS_DECLARE_DEFAULT_STATIC_VARIABLE_REGISTRATION                 \
  CS_DEFINE_STATICALLY_LINKED_FLAG                                      \
  CS_DEFINE_STATIC_VARIABLE_REGISTRATION (csStaticVarCleanup_csutil);   \
  CS_IMPLEMENT_PLATFORM_APPLICATION                                     \
  CS_DEFINE_MEMTRACKER_MODULE

The CS_IMPLEMENT_APPLICATION macro should be placed at the global scope in exactly one compilation unit comprising an application.

For maximum portability, each application should employ this macro. Platforms may override the definition of this macro in order to augment the implementation of an application with any special implementation details required by the platform.

Definition at line 532 of file cssysdef.h.

#define CS_IMPLEMENT_FOREIGN_DLL
Value:
CS_IMPLEMENT_STATIC_VARIABLE_REGISTRATION(csStaticVarCleanup_local); \
       CS_DEFINE_STATICALLY_LINKED_FLAG                                     \
       CS_DEFINE_STATIC_VARIABLE_REGISTRATION (csStaticVarCleanup_local);   \
       CS_DEFINE_MEMTRACKER_MODULE

The CS_IMPLEMENT_FOREIGN_DLL macro should be placed at the global scope in exactly one compilation unit comprising a foreign (non-Crystal Space) module.

For maximum portability, each such module should employ this macro. This is useful for situations in which a dynamic load library (DLL) is being built for some other facility. Obvious examples are pure extension modules for Python, Perl, and Java. For Crystal Space plugins, instead use CS_IMPLEMENT_PLUGIN. Platforms may override the definition of this macro in order to augment the implementation of the foreign module with any special implementation details required by the platform. If the foreign module will be interacting with Crystal Space, then it also needs to initialize the global iSCF::SCF variable manually. This variable should be set to point at the single shared instance of iSCF which is created by the application's invocation of scfInitialize(), csInitializer::InitializeSCF(), or csInitializer::CreateEnvironment(). In real Crystal Space plugins (those using CS_IMPLEMENT_PLUGIN), iSCF::SCF is initialized automatically; but in foreign DLL's, it is the responsibility of the DLL's author to ensure that iSCF::SCF gets initialized.

Definition at line 470 of file cssysdef.h.

#define CS_IMPLEMENT_IMPLICIT_PTR_CAST (   classname  ) 
Value:
inline static classname* _CS_IMPLICITPTRCAST_NAME (classname* ptr) \
  { \
    return ptr;\
  }

Implements a static member function for a class which can be used to perform implicit pointer casts.

Parameters:
classname Name of the class that the macro is being used in.
Remarks:
This macro is intended to support typecasting within macros, allowing the compiler to provide a more descriptive error message. Use CS_IMPLEMENT_IMPLICIT_PTR_CAST() in the declaration of the class and CS_IMPLICIT_PTR_CAST() in the macro declaration.
Example:
 struct iObjectRegistry : public iBase
 {
   // Allow implicit casts through static function.
   CS_IMPLEMENT_IMPLICIT_PTR_CAST(iObjectRegistry);
   ...
 }

 #define CS_QUERY_REGISTRY_TAG(Reg, Tag) \
  csPtr<iBase> (CS_IMPLICIT_PTR_CAST(iObjectRegistry, Reg)->Get (Tag))

Definition at line 1062 of file cssysdef.h.

#define CS_IMPLEMENT_STATIC_CLASSVAR (   Class,
  var,
  getterFunc,
  Type,
  initParam 
)    CS_IMPLEMENT_STATIC_CLASSVAR_EXT(Class,var,getterFunc,Type,initParam,_kill)

Create the static class variable that has been declared with CS_DECLARE_STATIC_CLASSVAR.

This will also create the Getter function and the destruction function. The destruction function will be registered upon the first invocation of the Getter function. Example:

 CS_IMPLEMENT_STATIC_CLASSVAR (csPolygon2D, pool, GetVertexPool,
                               csVertexPool,)
 

Definition at line 668 of file cssysdef.h.

#define CS_IMPLEMENT_STATIC_VAR (   getterFunc,
  Type,
  initParam 
)    CS_IMPLEMENT_STATIC_VAR_EXT(getterFunc,Type,initParam,_kill)

Implement a file-scoped static variable that is created on demand.

Defines a 'getter' function to access the variable and a 'destruction' function. The 'getter' function will register the 'destruction' function on first invocation. Example:

 CS_IMPLEMENT_STATIC_VAR (GetVertexPool, csVertexPool,)
 

This will give you a file-scoped static 'getter' function GetVertexPool() that returns a pointer to a static variable.

Definition at line 600 of file cssysdef.h.

#define CS_IMPLICIT_PTR_CAST (   classname,
  ptr 
)    (classname::_CS_IMPLICITPTRCAST_NAME(ptr))

Perform a compiler implicit cast of a pointer to another pointer type using a static member function declared with the CS_IMPLEMENT_IMPLICIT_PTR_CAST macro.

Parameters:
classname Name of the class to convert to
ptr Pointer to be convereted into
See also:
CS_IMPLEMENT_IMPLICIT_PTR_CAST

Definition at line 1076 of file cssysdef.h.

#define CS_INITIALIZE_PLATFORM_APPLICATION

Perform platform-specific application initializations.

This macro should be invoked very near to the "beginning" of the application.

Remarks:
NB: It is invoked in csInitializer::CreateEnvironment().

Definition at line 356 of file cssysdef.h.

#define CS_MAXPATHLEN   1024

Maximum length of a filesystem pathname.

Useful for declaring character buffers for calls to system functions which return a pathname in the buffer.

Definition at line 243 of file cssysdef.h.

#define CS_NO_EXCEPTIONS

This is defined when the project was compiled without support for exceptions.

Definition at line 235 of file cssysdef.h.

#define CS_REGISTER_STATIC_FOR_DESTRUCTION (   getterFunc  )     csStaticVarCleanup (getterFunc);

Register a method that will destruct one static variable.

Definition at line 544 of file cssysdef.h.

#define CS_STATIC_VARIABLE_CLEANUP   csStaticVarCleanup (0);

Invoke the function that will call all destruction functions.

Definition at line 552 of file cssysdef.h.

#define CS_STRING_TO_WIDE (   x  )     CS_STRING_TO_WIDE_(x)

Convert a string to a wide string.

Also works in macros.

 void bar (const wchar_t* baz);
 #define FOO(x) bar (CS_STRING_TO_WIDE (#x));

Definition at line 1100 of file cssysdef.h.

#define CS_VA_COPY (   dest,
  src 
)    __va_copy(dest, src)

Copies the state of a va_list value.

Definition at line 1086 of file cssysdef.h.


Generated for Crystal Space 1.4.1 by doxygen 1.7.1