Home Page Toolkit Overview Using GML   User Input Services     Finger Tracker     Calibrator     Frame Grabber     Service protocol Obtaining GML   Installing GML   Licence Developer Documentation   Tcl/Tk API     The GML Canvas     Image processing   Tcl Scripts Library     List of Classes     List of Files   C/C++ API     List of Classes     List of Files

gml_Alloc.h Go to the documentation of this file. /** @file gml_Alloc.h * * Memory allocation / deallocation for objects / structures. * * Copyright (c) 1995-2004 CLIPS-IMAG * * See the file "gml_LicenseTerms.txt" for information on usage and redistribution * of this file, and for a DISCLAIMER OF ALL WARRANTIES. * * Created on November, 1995 (FB). */ #ifndef __GML_ALLOC__ #define __GML_ALLOC__ #include "gml/base/gml_Types.h" #include "gml/base/gml_Errors.h" #include <assert.h> #include <stdlib.h> #include <string.h> #ifdef HAVE_DMALLOC #include "dmalloc.h" #endif /** * gml_Zero -- * * Set all bytes in a data structure to zero. * @param[in] ptr a pointer to the operand structure */ template <class T> inline void gml_Zero (T* ptr) { assert (ptr != (T*)NULL); bzero ((void*)ptr, sizeof (T)); } /** * gml_ZeroArray -- * * Set all bytes of all structures in an array to zero. * @param[in] ptr a pointer to the operand array * @param[in] size the number of elements to zero */ template<class T> inline void gml_ZeroArray (T* ptr, gml_TBlockSize size) { assert (ptr != (T*)NULL); bzero ((void*)ptr, sizeof (T) * size); } /** * gml_Malloc -- * * Allocate an array of <size> structures. * * @param[out] ptr the pointer in which the newly allocated address will be stored * @param[in] size the number of structures to allocate */ template<class T> inline gml_TError gml_Malloc (T* &ptr, gml_TBlockSize size = 1) { ptr = (T*)malloc ((size_t)size * sizeof(T)); if (ptr == (T*)NULL) return gml_gErrorMemFull; else return gml_cNoError; } /** * gml_MallocAndZero -- * * Allocate an array of <size> structures and zero it. * @param[out] ptr the pointer in which the newly allocated address will be stored * @param[in] size the number of structures to allocate and zero * @see gml_Malloc() and gml_ZeroArray(). */ template<class T> inline gml_TError gml_MallocAndZero (T* &ptr, gml_TBlockSize size = 1) { ptr = (T*)malloc ((size_t)size * sizeof(T)); if (ptr == (T*)NULL) { return gml_gErrorMemFull; } else { gml_ZeroArray (ptr, size); return gml_cNoError; } } /** * gml_Free -- * * Release resources claimed by gml_Malloc(). * The pointer <ptr> will be set to NULL. * @param[in,out] ptr the pointer to the data to free */ template<class T> inline void gml_Free (T* &ptr) { assert (ptr != (T*)NULL); free ((void*)ptr); ptr = (T*)NULL; } /** * gml_TestAndFree -- * * Release resources claimed by gml_Malloc(), iff <ptr> is not NULL. * @param[in,out] ptr the pointer to the data to free */ template<class T> inline void gml_TestAndFree (T* &ptr) { if (ptr != (T*)NULL) gml_Free (ptr); } /** * gml_New -- * * Create a new instance of class <T>. * @param[out] object will be set to the address of the new object. */ template<class T> inline gml_TError gml_New (T* &object) { gml_TError err = gml_cNoError; object = new T; if (object == (T*)NULL) err = gml_gErrorMemFull; return err; } /** * gml_NewArray -- * * Create a new array of instances of class <T>. * @param[out] object will be set to the address of the new array. * @param[in] size requested length of the array. */ template<class T> inline gml_TError gml_NewArray (T* &object, gml_TBlockSize size) { gml_TError err = gml_cNoError; object = new T[size]; if (object == (T*)NULL) err = gml_gErrorMemFull; return err; } /** * gml_NewAndInit -- * * Create a new instance of class <T> and call its <Init> method. * The <Init> method is called without arguments. * @param[out] object will be set to the address of the new object. */ template<class T> inline gml_TError gml_NewAndInit (T* &object) { gml_TError err = gml_cNoError; err = gml_New (object); if (err == gml_cNoError) { err = object->Init (); if (err != gml_cNoError) gml_DisposeAndDelete (object); } return err; } /** * gml_NewAndInitArray -- * * Create a new array of instances of class <T>, and call their <Init> method. * @param[out] object will be set to the address of the new array. * @param[in] size requested length of the array. */ template<class T> inline gml_TError gml_NewAndInitArray (T* &object, gml_TBlockSize size) { gml_TError err = gml_cNoError; int i; if ((err = gml_NewArray (object, size)) != gml_cNoError) return err; for (i = 0; (err == gml_cNoError) && (i < size); i++) err = (object[i]).Init (); if (err != gml_cNoError) { for (; i != 0; i--) (object[i-1]).Dispose (); gml_DeleteArray (object); } return err; } /** * gml_Delete -- * * Delete an instance of class <T>. * @param[in,out] object the address of the object; will be set to NULL. */ template<class T> inline void gml_Delete (T* &object) { assert (object != (T*)NULL); delete object; object = (T*)NULL; } /** * gml_DeleteArray -- * * Delete an array of instances of class <T>. * @param[in,out] object the address of the array; will be set to NULL. */ template<class T> inline void gml_DeleteArray (T* &object) { assert (object != (T*)NULL); delete[] object; object = (T*)NULL; } /** * gml_DisposeAndDelete -- * * Same as gml_Delete(); * The object's <Dispose> method will be called first. */ template<class T> inline void gml_DisposeAndDelete (T* &object) { object->Dispose (); gml_Delete (object); } /** * gml_DisposeAndDeleteArray -- * * Same as gml_DeleteArray(); * the objects' <Dispose> methods will be called first. */ template<class T> inline void gml_DisposeAndDeleteArray (T* &object, gml_TBlockSize size) { int i; for (i = 0; i < size; i++) (object[i]).Dispose (); gml_DeleteArray (object); } /** * gml_TestDisposeAndDelete -- * * Same as gml_DisposeAndDelete(); * nothing will be done if <object> is NULL. */ template<class T> inline void gml_TestDisposeAndDelete (T* &object) { if (object != (T*)NULL) gml_DisposeAndDelete (object); } /** * gml_TestDisposeAndDeleteArray -- * * Same as gml_DisposeAndDeleteArray() * nothing will be done if <object> is NULL. * */ template<class T> inline void gml_TestDisposeAndDeleteArray (T* &object, gml_TBlockSize size) { if (object != (T*)NULL) gml_DisposeAndDeleteArray (object, size); } /** * gml_TestAndDelete -- * * Same as gml_Delete(); * nothing will be done if <object> is NULL. * */ template<class T> inline void gml_TestAndDelete (T* &object) { if (object != (T*)NULL) gml_Delete (object); } /** * gml_TestAndDeleteArray -- * * Same as gml_DeleteArray(); * nothing will be done if <object> is NULL. * */ template<class T> inline void gml_TestAndDeleteArray (T* &object) { if (object != (T*)NULL) gml_DeleteArray (object); } /** * gml_GetGlobalObject -- * * Put in <ref> a reference to the global object * of the class that <ref> is a pointer to. If no global object of this * class was allocated yet, do it. * * @return gml_cNoError on success * @return gml_gErrorMemFull on failure, or an error code from the * <Init> initialisation method of the class. */ template<class T> inline gml_TError gml_GetGlobalObject (T* &ref) { gml_TError err = gml_cNoError; // look if the global object have to be allocated if (T::fNumberOfRef == 0) // allocate a new object err = gml_NewAndInit (T::fGlobalRef); if (err == gml_cNoError) { ref = T::fGlobalRef; T::fNumberOfRef++; } return err; } /** * gml_ReleaseGlobalObject -- * * If <ref> if not NULL, decrement the number * of references to the global object of the class that <ref> is a pointer to. * If this number becomes 0, dispose and delete the * global object. * @post <ref> is always NULL. */ template<class T> inline void gml_ReleaseGlobalObject (T* &ref) { if (ref != (T*)NULL) { if (T::fNumberOfRef == 1) gml_DisposeAndDelete (T::fGlobalRef); ref = (T*)NULL; T::fNumberOfRef--; } } #endif Generated on Tue Jun 12 14:03:27 2007 for gml by Doxygen 1.5.2.

Contact: julien (dot) letessier (at) gmail (dot) com. Copyright (c) 2000-2007 CLIPS-IMAG Laboratory, Grenoble, France. All rights reserved. W3CXHTML 1.0 W3CCSS 2.0