Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

object.h

Go to the documentation of this file.
00001 /*********************************************************************
00002 * lescegra                                                           *
00003 *                                                                    *
00004 * http://geeky.kicks-ass.org/projects/lescegra.html                  *
00005 *                                                                    *
00006 * Copyright 2003 by Enno Cramer <uebergeek@web.de>                   *
00007 *                                                                    *
00008 * This library is free software; you can redistribute it and/or      *
00009 * modify it under the terms of the GNU Library General Public        *
00010 * License as published by the Free Software Foundation; either       *
00011 * version 2 of the License, or (at your option) any later version.   *
00012 *                                                                    *
00013 * This library is distributed in the hope that it will be useful,    *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of     *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  *
00016 * Library General Public License for more details.                   *
00017 *                                                                    *
00018 * You should have received a copy of the GNU Library General Public  *
00019 * License along with this library; if not, write to the Free         *
00020 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
00021 *********************************************************************/
00022 
00023 #ifndef LSG_OBJECT_H
00024 #define LSG_OBJECT_H 1
00025 
00026 /**
00027  * \file  object.h
00028  * \brief Object hierarchy base class
00029  */
00030 
00031 typedef struct LsgObject LsgObject;
00032 
00033 /**
00034  * \brief Object hierarchy base class
00035  *
00036  * Abstract base class for the object hierarchy.
00037  */
00038 struct LsgObject {
00039     /**
00040      * Ye olde virtual destructor method
00041      */
00042     void (*destroy)(LsgObject*);
00043 };
00044 
00045 /**
00046  * Constructor method for LsgObject.
00047  * @param self  The instace variable
00048  */
00049 void LsgObject_init(LsgObject* self);
00050 
00051 /**
00052  * Destructor method for LsgObject.
00053  * @param self  The instance variable
00054  */
00055 void LsgObject_destroy(LsgObject* self);
00056 
00057 /**
00058  * Non virtual destructor for LsgObject instances.
00059  * Calls the virtual destructor method and afterwards frees the allocated memory.
00060  * @param self  The instance variable
00061  */
00062 void LsgObject_free(LsgObject* obj);
00063 
00064 #endif

(c) 2003, by Enno Cramer
generated on 9 Jul 2003
lescegra - doxygen