<html> <head> <link rel="stylesheet" href="page.css" type="text/css"> <title>fox-toolkit.org - Documentation</title> </head> <body bgcolor=#ffffff link=#990033 vlink=#990033 alink=#990033 text=#000000> <font face='verdana,sans-serif' size=2 > <!---- TOPIC TITLE WITH LOGO---> <table border=0 cellpadding= cellspacing=2 width=100% ><tr><td><a href='http://www.fox-toolkit.org/doc.html'><img src='../art/foxlogo_small.jpg' border=0></a></td><td width=100% valign=bottom><font face='verdana,sans-serif' size=2 ><b> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <br><img src='../art/line.gif' width=100% height=1></b></font></td></tr></table> <p> <!--- TOPIC TITLE WITH LOGO ---> <!-- Generated by Doxygen 1.3.3 --> <h1>FXObject.h</h1><div class="fragment"><pre>00001 <span class="comment">/********************************************************************************</span> 00002 <span class="comment">* *</span> 00003 <span class="comment">* T o p l e v el O b j e c t *</span> 00004 <span class="comment">* *</span> 00005 <span class="comment">*********************************************************************************</span> 00006 <span class="comment">* Copyright (C) 1997,2004 by Jeroen van der Zijp. All Rights Reserved. *</span> 00007 <span class="comment">*********************************************************************************</span> 00008 <span class="comment">* This library is free software; you can redistribute it and/or *</span> 00009 <span class="comment">* modify it under the terms of the GNU Lesser General Public *</span> 00010 <span class="comment">* License as published by the Free Software Foundation; either *</span> 00011 <span class="comment">* version 2.1 of the License, or (at your option) any later version. *</span> 00012 <span class="comment">* *</span> 00013 <span class="comment">* This library is distributed in the hope that it will be useful, *</span> 00014 <span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of *</span> 00015 <span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span> 00016 <span class="comment">* Lesser General Public License for more details. *</span> 00017 <span class="comment">* *</span> 00018 <span class="comment">* You should have received a copy of the GNU Lesser General Public *</span> 00019 <span class="comment">* License along with this library; if not, write to the Free Software *</span> 00020 <span class="comment">* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. *</span> 00021 <span class="comment">*********************************************************************************</span> 00022 <span class="comment">* $Id: FXObject.h,v 1.25 2004/02/08 17:17:34 fox Exp $ *</span> 00023 <span class="comment">********************************************************************************/</span> 00024 <span class="preprocessor">#ifndef FXOBJECT_H</span> 00025 <span class="preprocessor"></span><span class="preprocessor">#define FXOBJECT_H</span> 00026 <span class="preprocessor"></span> 00027 <span class="keyword">namespace </span>FX { 00028 <span class="comment"></span> 00029 <span class="comment">/// Minimum and maximum message id</span> 00030 <span class="comment"></span><span class="keyword">enum</span> { 00031 MINKEY = 0, 00032 MAXKEY = 65535 00033 }; 00034 00035 <span class="comment"></span> 00036 <span class="comment">/// Minimum and maximum message type</span> 00037 <span class="comment"></span><span class="keyword">enum</span> { 00038 MINTYPE = 0, 00039 MAXTYPE = 65535 00040 }; 00041 00042 00043 <span class="comment">// Association key</span> 00044 <span class="keyword">typedef</span> FXuint FXSelector; 00045 00046 00047 <span class="comment">// Forward</span> 00048 <span class="keyword">class </span>FXObject; 00049 00050 <span class="comment"></span> 00051 <span class="comment">/// Describes a FOX object</span> 00052 <span class="comment"></span><span class="keyword">class </span>FXAPI FXMetaClass { 00053 <span class="keyword">private</span>: 00054 <span class="keyword">const</span> FXchar *className; 00055 FXObject* (*manufacture)(); 00056 <span class="keyword">const</span> FXMetaClass *baseClass; 00057 <span class="keyword">const</span> <span class="keywordtype">void</span> *assoc; 00058 FXuint nassocs; 00059 FXuint assocsz; 00060 FXuint namelen; 00061 <span class="keyword">private</span>: 00062 <span class="keyword">static</span> <span class="keyword">const</span> FXMetaClass **metaClassTable; 00063 <span class="keyword">static</span> FXuint nmetaClassTable; 00064 <span class="keyword">static</span> FXuint nmetaClasses; <a name="l00065"></a><a class="code" href="classFX_1_1FXMetaClass.html">00065</a> <span class="keyword">private</span>: 00066 <span class="keyword">static</span> <span class="keywordtype">void</span> resize(FXuint n); 00067 <span class="keyword">public</span>: 00068 FXMetaClass(<span class="keyword">const</span> FXchar* name,<a class="code" href="classFX_1_1FXObject.html">FXObject</a> *(fac)(),<span class="keyword">const</span> FXMetaClass* base,<span class="keyword">const</span> <span class="keywordtype">void</span>* ass,FXuint nass,FXuint assz,FXuint len); 00069 <span class="comment"></span> 00070 <span class="comment"> /// Check if metaclass is subclass of some other metaclass</span> 00071 <span class="comment"></span> FXbool isSubClassOf(<span class="keyword">const</span> FXMetaClass* metaclass) <span class="keyword">const</span>; 00072 <span class="comment"></span> 00073 <span class="comment"> /// Make instance of some object</span> 00074 <span class="comment"></span> <a class="code" href="classFX_1_1FXObject.html">FXObject</a>* makeInstance() <span class="keyword">const</span>; 00075 <span class="comment"></span> <a name="l00076"></a><a class="code" href="classFX_1_1FXMetaClass.html#a3">00076</a> <span class="comment"> /// Ask class name</span> 00077 <span class="comment"></span> <span class="keyword">const</span> FXchar* getClassName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> className; } 00078 <span class="comment"></span> <a name="l00079"></a><a class="code" href="classFX_1_1FXMetaClass.html#a4">00079</a> <span class="comment"> /// Obtain class name length</span> 00080 <span class="comment"></span> FXuint getClassNameLength()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> namelen; } 00081 <span class="comment"></span> <a name="l00082"></a><a class="code" href="classFX_1_1FXMetaClass.html#a5">00082</a> <span class="comment"> /// Ask base class</span> 00083 <span class="comment"></span> <span class="keyword">const</span> FXMetaClass* getBaseClass()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> baseClass; } 00084 <span class="comment"></span> 00085 <span class="comment"> /// Find metaclass object</span> 00086 <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> FXMetaClass* getMetaClassFromName(<span class="keyword">const</span> FXchar* name); 00087 <span class="comment"></span> 00088 <span class="comment"> /// Search message map</span> 00089 <span class="comment"></span> <span class="keyword">const</span> <span class="keywordtype">void</span>* search(FXSelector key) <span class="keyword">const</span>; 00090 00091 ~FXMetaClass(); 00092 }; 00093 00094 <span class="comment"></span> 00095 <span class="comment">/// Macro to set up class declaration</span> 00096 <span class="comment"></span><span class="preprocessor">#define FXDECLARE(classname) \</span> 00097 <span class="preprocessor"> public: \</span> 00098 <span class="preprocessor"> struct FXMapEntry { FX::FXSelector keylo; FX::FXSelector keyhi; long (classname::* func)(FX::FXObject*,FX::FXSelector,void*); }; \</span> 00099 <span class="preprocessor"> static const FX::FXMetaClass metaClass; \</span> 00100 <span class="preprocessor"> static FX::FXObject* manufacture(); \</span> 00101 <span class="preprocessor"> virtual long handle(FX::FXObject* sender,FX::FXSelector sel,void* ptr); \</span> 00102 <span class="preprocessor"> virtual const FX::FXMetaClass* getMetaClass() const { return &metaClass; } \</span> 00103 <span class="preprocessor"> friend FX::FXStream& operator<<(FX::FXStream& store,const classname* obj){return store.saveObject((FX::FXObjectPtr)(obj));} \</span> 00104 <span class="preprocessor"> friend FX::FXStream& operator>>(FX::FXStream& store,classname*& obj){return store.loadObject((FX::FXObjectPtr&)(obj));} \</span> 00105 <span class="preprocessor"> private:</span> 00106 <span class="preprocessor"></span> 00107 <span class="comment"></span> 00108 <span class="comment">/// Macro to set up class implementation</span> 00109 <span class="comment"></span><span class="preprocessor">#define FXIMPLEMENT(classname,baseclassname,mapping,nmappings) \</span> 00110 <span class="preprocessor"> FX::FXObject* classname::manufacture(){return new classname;} \</span> 00111 <span class="preprocessor"> const FX::FXMetaClass classname::metaClass(#classname,classname::manufacture,&baseclassname::metaClass,mapping,nmappings,sizeof(classname::FXMapEntry),sizeof(#classname)); \</span> 00112 <span class="preprocessor"> long classname::handle(FX::FXObject* sender,FX::FXSelector sel,void* ptr){ \</span> 00113 <span class="preprocessor"> const FXMapEntry* me=(const FXMapEntry*)metaClass.search(sel); \</span> 00114 <span class="preprocessor"> return me ? (this->* me->func)(sender,sel,ptr) : baseclassname::handle(sender,sel,ptr); \</span> 00115 <span class="preprocessor"> }</span> 00116 <span class="preprocessor"></span> 00117 <span class="comment"></span> 00118 <span class="comment">/// Macro to set up abstract class declaration</span> 00119 <span class="comment"></span><span class="preprocessor">#define FXDECLARE_ABSTRACT(classname) \</span> 00120 <span class="preprocessor"> public: \</span> 00121 <span class="preprocessor"> struct FXMapEntry { FX::FXSelector keylo; FX::FXSelector keyhi; long (classname::* func)(FX::FXObject*,FX::FXSelector,void*); }; \</span> 00122 <span class="preprocessor"> static const FX::FXMetaClass metaClass; \</span> 00123 <span class="preprocessor"> virtual long handle(FX::FXObject* sender,FX::FXSelector sel,void* ptr); \</span> 00124 <span class="preprocessor"> virtual const FX::FXMetaClass* getMetaClass() const { return &metaClass; } \</span> 00125 <span class="preprocessor"> friend FX::FXStream& operator<<(FX::FXStream& store,const classname* obj){return store.saveObject((FX::FXObjectPtr)(obj));} \</span> 00126 <span class="preprocessor"> friend FX::FXStream& operator>>(FX::FXStream& store,classname*& obj){return store.loadObject((FX::FXObjectPtr&)(obj));} \</span> 00127 <span class="preprocessor"> private:</span> 00128 <span class="preprocessor"></span> 00129 <span class="comment"></span> 00130 <span class="comment">/// Macro to set up abstract class implementation</span> 00131 <span class="comment"></span><span class="preprocessor">#define FXIMPLEMENT_ABSTRACT(classname,baseclassname,mapping,nmappings) \</span> 00132 <span class="preprocessor"> const FX::FXMetaClass classname::metaClass(#classname,NULL,&baseclassname::metaClass,mapping,nmappings,sizeof(classname::FXMapEntry),sizeof(#classname)); \</span> 00133 <span class="preprocessor"> long classname::handle(FX::FXObject* sender,FX::FXSelector sel,void* ptr){ \</span> 00134 <span class="preprocessor"> const FXMapEntry* me=(const FXMapEntry*)metaClass.search(sel); \</span> 00135 <span class="preprocessor"> return me ? (this->* me->func)(sender,sel,ptr) : baseclassname::handle(sender,sel,ptr); \</span> 00136 <span class="preprocessor"> }</span> 00137 <span class="preprocessor"></span> 00138 <span class="comment"></span> 00139 <span class="comment">/// MetaClass of a class</span> 00140 <span class="comment"></span><span class="preprocessor">#define FXMETACLASS(classname) (&classname::metaClass)</span> 00141 <span class="preprocessor"></span> 00142 <span class="comment"></span> 00143 <span class="comment">/// Set up map type</span> 00144 <span class="comment"></span><span class="preprocessor">#define FXDEFMAP(classname) static const classname::FXMapEntry</span> 00145 <span class="preprocessor"></span><span class="comment"></span> 00146 <span class="comment">/// Define range of function types</span> 00147 <span class="comment"></span><span class="preprocessor">#define FXMAPTYPES(typelo,typehi,func) {MKUINT(MINKEY,typelo),MKUINT(MAXKEY,typehi),&func}</span> 00148 <span class="preprocessor"></span><span class="comment"></span> 00149 <span class="comment">/// Define range of function types</span> 00150 <span class="comment"></span><span class="preprocessor">#define FXMAPTYPE(type,func) {MKUINT(MINKEY,type),MKUINT(MAXKEY,type),&func}</span> 00151 <span class="preprocessor"></span><span class="comment"></span> 00152 <span class="comment">/// Define range of functions</span> 00153 <span class="comment"></span><span class="preprocessor">#define FXMAPFUNCS(type,keylo,keyhi,func) {MKUINT(keylo,type),MKUINT(keyhi,type),&func}</span> 00154 <span class="preprocessor"></span><span class="comment"></span> 00155 <span class="comment">/// Define one function</span> 00156 <span class="comment"></span><span class="preprocessor">#define FXMAPFUNC(type,key,func) {MKUINT(key,type),MKUINT(key,type),&func}</span> 00157 <span class="preprocessor"></span> 00158 <span class="comment"></span> 00159 <span class="comment">/// Base of all FOX object</span> 00160 <span class="comment"></span><span class="keyword">class </span>FXAPI FXObject { 00161 FXDECLARE(FXObject) <a name="l00162"></a><a class="code" href="classFX_1_1FXObject.html">00162</a> <span class="keyword">public</span>: 00163 <span class="comment"></span> 00164 <span class="comment"> /// Called for unhandled messages</span> 00165 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">long</span> onDefault(FXObject*,FXSelector,<span class="keywordtype">void</span>*); 00166 00167 <span class="keyword">public</span>: 00168 <span class="comment"></span> 00169 <span class="comment"> /// Get class name of some object</span> 00170 <span class="comment"></span> <span class="keyword">const</span> FXchar* getClassName() <span class="keyword">const</span>; 00171 <span class="comment"></span> 00172 <span class="comment"> /// Check if object is member of metaclass</span> 00173 <span class="comment"></span> FXbool isMemberOf(<span class="keyword">const</span> FXMetaClass* metaclass) <span class="keyword">const</span>; 00174 <span class="comment"></span> 00175 <span class="comment"> /// Save object to stream</span> 00176 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(<a class="code" href="classFX_1_1FXStream.html">FXStream</a>& store) <span class="keyword">const</span>; 00177 <span class="comment"></span> 00178 <span class="comment"> /// Load object from stream</span> 00179 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> load(<a class="code" href="classFX_1_1FXStream.html">FXStream</a>& store); 00180 <span class="comment"></span> 00181 <span class="comment"> /// Virtual destructor</span> 00182 <span class="comment"></span> <span class="keyword">virtual</span> ~FXObject(); 00183 }; 00184 00185 } 00186 00187 <span class="preprocessor">#endif</span> </pre></div></font> <!--- COPYRIGHT --> <p> <table width=100% cellpadding=0 cellspacing=0><tr><td width=100% valign=top id=HEADLINE align=right> <img src='../art/line.gif' width=100% height=1><font size=-1> Copyright © 1997-2004 Jeroen van der Zijp</font> </td></tr></table> </p> <!--- COPYRIGHT --> </body> </html>