BlitzMax Extended  0.8.19
Pushing Blitz to the Max.
Macros
blitz.h File Reference

Complete API for using the BlitzMax runtime. More...

#include "c/_common.h"
#include "c/blitz_types.h"
#include "c/blitz_memory.h"
#include "c/blitz_thread.h"
#include "c/blitz_gc.h"
#include "c/blitz_ex.h"
#include "c/blitz_cclib.h"
#include "c/blitz_debug.h"
#include "c/blitz_module.h"
#include "c/blitz_incbin.h"
#include "c/blitz_class.h"
#include "c/blitz_object.h"
#include "c/blitz_string.h"
#include "c/blitz_array.h"
#include "c/blitz_handle.h"
#include "c/blitz_app.h"
#include "c/exceptions/blitz_exception.h"
#include "c/exceptions/blitz_blitzexception.h"
#include "c/exceptions/blitz_nullobjectexception.h"
#include "c/exceptions/blitz_nullmethodexception.h"
#include "c/exceptions/blitz_nullfunctionexception.h"
#include "c/exceptions/blitz_arrayboundsexception.h"
#include "c/exceptions/blitz_outofdataexception.h"
#include "c/exceptions/blitz_runtimeexception.h"

Go to the source code of this file.

Macros

#define BB_ISNULL(ptr)
 Checks if a pointer is NULL.
#define BB_EQUALS(obj, rhs)
 Checks if two objects are equal.
#define BB_THROW(cstring_or_obj)
 Throws a BlitzMax exception.

Detailed Description

Complete API for using the BlitzMax runtime.


Macro Definition Documentation

#define BB_EQUALS (   obj,
  rhs 
)

Checks if two objects are equal.

Todo:
Won't work with primitive data types yet.
Parameters:
objThe object which provides the Compare() function  
rhsThe right-hand side object which is compared with the first one
Return values:
trueIf both instances are considered to be equal
falseIf the instances differ in some way
#define BB_ISNULL (   ptr)

Checks if a pointer is NULL.

The BlitzMax runtime has three compile time objects to represents NULL instances of their specific type (Object, String, Array).

Checking for those is performed via GCC builtin functionality. If the given parameter x is neither of the three above mentioned, this returns if x is the C NULL pointer.

See also:
BBNULLOBJECT, BBNULLSTRING, BBNULLARRAY
Parameters:
ptrA pointer to test
Return values:
trueIf the pointer is considered to be NULL
falseIf the pointer is referencing to a valid value
#define BB_THROW (   cstring_or_obj)

Throws a BlitzMax exception.

Parameters:
cstring_or_objA string or object describing the problem