Changeset 251

Timestamp:

Mar 11, 2007, 2:22:39 PM (18 years ago)

Author:

cinc

Message:

Implemented some methods. Bug fixes and documentation.

Location:

trunk/nom

Files:

• class_c/nomclassmanager.c (modified) (2 diffs)
• class_c/nomcls.c (modified) (4 diffs)
• class_c/nomobj.c (modified) (7 diffs)
• idl/nomcls.idl (modified) (5 diffs)
• idl/nomobj.idl (modified) (1 diff)
• include/nomapi.h (modified) (2 diffs)

trunk/nom/class_c/nomclassmanager.c ¶

@@ -16 +16 @@
 * The Initial Developer of the Original Code is
 * netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
-* Portions created by the Initial Developer are Copyright (C) 2005-2006
+* Portions created by the Initial Developer are Copyright (C) 2005-2007
 * the Initial Developer. All Rights Reserved.
 *
@@ -35 +35 @@
  * And remember, phase 3 is near...
  */
+/** \file nomobj.idl 
+    
+    Implementation file for the NOM class NOMClassMgr.
+*/
+
 #ifndef NOM_NOMClassMgr_IMPLEMENTATION_FILE
 #define NOM_NOMClassMgr_IMPLEMENTATION_FILE

trunk/nom/class_c/nomcls.c ¶

@@ -32 +32 @@
 *
 * ***** END LICENSE BLOCK ***** */
+/** \file noncls.c
+    
+    Implementation file for the NOMClass class.
+*/
 #ifndef NOM_NOMClass_IMPLEMENTATION_FILE
 #define NOM_NOMClass_IMPLEMENTATION_FILE
@@ -83 +87 @@
   ncp=(NOMClassPriv*)_ncpObject;
 
+  /* Allocate memory big enough to hold an object. This means the size is that of the
+     mtab pointer and all instance variables. */
   if((nObj=_nomAllocate(nomSelf, ncp->mtab->ulInstanceSize, NULLHANDLE))==NULLHANDLE)
     return NULLHANDLE;
@@ -149 +155 @@
 
 /**
-   Function which implements the nomGetName() method of NOMClass.
+   Function which implements the nomGetCreatedClassName() method of NOMClass.
 */
-NOM_Scope CORBA_string NOMLINK impl_NOMClass_nomGetName(NOMClass* nomSelf, CORBA_Environment *ev)
-{
-  return nomSelf->mtab->nomClassName;
+NOM_Scope CORBA_string NOMLINK impl_NOMClass_nomGetCreatedClassName(NOMClass* nomSelf, CORBA_Environment *ev)
+{
+  NOMClassPriv* ncp;
+
+  /* The private struct characterizing the objects this meta class can create. */
+  ncp=_nomGetObjectCreateInfo(nomSelf, NULLHANDLE);
+
+  if(!ncp)
+    return ""; /* That can not happen but anyway... */
+
+  //  return nomSelf->mtab->nomClassName;
+  return ncp->mtab->nomClassName;
 }
 
@@ -212 +227 @@
 
       /* FIXME: no use of version information, yet. */
-      //nomPrintf("I'm here (%s): ", _nomGetName(nomSelf, NULLHANDLE));
-      if(!_nomFindClassFromName(NOMClassMgrObject, _nomGetName(nomSelf, NULLHANDLE),
+      
+      //The following was used before changing nomGetname()
+      //if(!_nomFindClassFromName(NOMClassMgrObject, _nomGetName(nomSelf, NULLHANDLE),
+      //                        0, 0, NULLHANDLE))
+      if(!_nomFindClassFromName(NOMClassMgrObject, _nomGetClassName(nomSelf, NULLHANDLE),
                               0, 0, NULLHANDLE))
+
         {
           NOMClassPriv* ncPriv;

trunk/nom/class_c/nomobj.c ¶

@@ -16 +16 @@
 * The Initial Developer of the Original Code is
 * netlabs.org: Chris Wohlgemuth <cinc-ml@netlabs.org>.
-* Portions created by the Initial Developer are Copyright (C) 2005-2006
+* Portions created by the Initial Developer are Copyright (C) 2005-2007
 * the Initial Developer. All Rights Reserved.
 *
@@ -32 +32 @@
 *
 * ***** END LICENSE BLOCK ***** */
+/** \file nomobj.idl 
+    
+    Implementation file for the NOM class NOMObject.
+*/
+
 #ifndef NOM_NOMObject_IMPLEMENTATION_FILE
 #define NOM_NOMObject_IMPLEMENTATION_FILE
@@ -49 +54 @@
 
 /**
-
     \brief This function implements the method nomInit() of class NOMObject.
  */
 NOM_Scope void  NOMLINK impl_NOMObject_nomInit(NOMObject *nomSelf, CORBA_Environment *ev)
 {  
-  //nomPrintf("    Entering %s (%x) with nomSelf: 0x%x. nomSelf is: %s.\n",
-  //        __FUNCTION__, impl_NOMObject_nomInit, nomSelf , nomSelf->mtab->nomClassName);
-}
-
-/**
-
+
+}
+
+/**
     \brief This function implements the method nomUnInit() of class NOMObject.
  */
@@ -71 +73 @@
 
 /**
-
     \brief This function implements the method nomGetSize() of class NOMObject.
  */
@@ -87 +88 @@
 
 /**
-
     \brief This function implements the method delete() of class NOMObject.
 
@@ -121 +121 @@
 
 /**
-
     \brief This function implements the method nomGetClass() of class NOMObject.
     It returns a pointer to the class object of this object.
@@ -162 +161 @@
 
 
+NOM_Scope CORBA_boolean NOMLINK impl_NOMObject_nomIsA(NOMObject* nomSelf, const PNOMClass nomClass, CORBA_Environment *ev)
+{
+  /* NOMObjectData* nomThis=NOMObjectGetData(nomSelf); */
+  NOMClassPriv* ncp;
+  nomMethodTabs mtabs; /* List of mtabs */
+
+  if(!nomIsObj(nomClass)){
+    g_warning("%s: class object pointer nomClass does not point to an object.", __FUNCTION__);
+    return FALSE;
+  }
+
+  /* Check if we have the class in our list of classes */
+  ncp=(NOMClassPriv*)nomSelf->mtab->nomClsInfo;
+  mtabs=&ncp->mtabList;
+  while(mtabs)
+    {
+      if(nomClass==mtabs->mtab->nomClassObject)
+          return TRUE;
+
+      mtabs=mtabs->next;
+    }
+  return FALSE;
+}
+
+
+NOM_Scope CORBA_boolean NOMLINK impl_NOMObject_nomIsInstanceOf(NOMObject* nomSelf, const PNOMClass nomClass, CORBA_Environment *ev)
+{
+  /* NOMObjectData* nomThis=NOMObjectGetData(nomSelf); */
+ 
+  if(!nomIsObj(nomClass)){
+    g_warning("%s: class object pointer nomClass does not point to an object.", __FUNCTION__);
+    return FALSE;
+  }
+ 
+  if(nomClass==_nomGetClass(nomSelf, NULLHANDLE))
+    return TRUE;
+  
+  return FALSE;
+}
+
+/**
+   Function which implements the nomGetClassName() method of NOMObject.
+*/
+NOM_Scope CORBA_string NOMLINK impl_NOMObject_nomGetClassName(NOMObject* nomSelf, CORBA_Environment *ev)
+{
+  /* NOMObjectData* nomThis=NOMObjectGetData(nomSelf); */
+  return nomSelf->mtab->nomClassName;
+}

trunk/nom/idl/nomcls.idl ¶

@@ -65 +65 @@
 
   /**
-     This method returns the name of the class this class object is an instance of.
+     This method returns the name of the class this class object is the meta class of. This
+     means the returned string is the name of the class the metaclass creates instances of.
+
+     \remarks This method used to be called nomGetName().
 
      \par How to override:
      This method is usually not overriden.
 
-     \sa impl_NOMClass_nomGetName()
+     \sa nomGetClassName()
    */
-  string nomGetName();
+  string nomGetCreatedClassName();
 
   /**
@@ -104 +107 @@
      method is always called during object creation.
 
-     \par How to override
+     \par How to override:
      This method can be overriden to track the creation of objects. When doing so
      the parent should be called first.
@@ -130 +133 @@
      this method does nothing. It's for compatibility with ported code.
 
-     \par How to override
+     \par How to override:
      This method is usually not overriden.
  
@@ -137 +140 @@
   void nomDeallocate(in gpointer memptr);
   void nomSetObjectCreateInfo(in gpointer ncpObject);
+
+  /**
+     \remarks
+     The return type may change.
+   */
   gpointer nomGetObjectCreateInfo();
 
@@ -145 +153 @@
      also be registered.
 
+     \remarks This method is only called by the system during class creation.
+
+     \par How to override:
+     This method is usually not overriden.
+
      \sa impl_NOMClass_nomClassReady()
    */
   void nomClassReady();
 
+  /**
+     \warning
+     The type of this variable will change!
+  */
   NOMINSTANCEVAR(string ncpObject);     //NOMClassPriv structure holding info about the object this class can create
   NOMOVERRIDE(nomInit); 

trunk/nom/idl/nomobj.idl ¶

@@ -161 +161 @@
    */
   PNOMObject new();
+
+  /**
+     This method checks if the object is an instance of the given class or some subclass. Using
+     this method one can make sure some feature is available if the introducing class is known.
+     Every subclass of a given class also supports the features of the introducing class. 
+
+     \remarks This method checks the validity of \e nomClass using nomIsObj() and returns FALSE
+     in case it's not an object.
+
+     \param nomClass Pointer to a class object.
+
+     \returns TRUE if the object is an instance of the given class or one of its
+     subclasses.
+
+     \sa nomIsInstanceOf()
+   */
+  boolean nomIsA(in PNOMClass nomClass);
+
+  /**
+     This method checks if the object is an instance of exactly the given class.
+
+
+     \remarks This method checks the validity of \e nomClass using nomIsObj() and returns FALSE
+     in case it's not an object.
+
+     \param nomClass Pointer to a class object.
+
+     \returns TRUE if the object is an instance of exactly the given class.
+
+     \sa nomIsA()
+   */
+  boolean nomIsInstanceOf(in PNOMClass nomClass);
+  /**
+     This method returns the name of the class this object is an instance of.
+     
+     \par How to override:
+     This method is usually not overriden.
+     
+     \returns A null terminated C string. Note that this is not a copy. The string
+     is valid as long as the class object exists (not the instance).
+
+     \sa impl_NOMClass_nomGetClassName()
+  */
+  string nomGetClassName();
+
+
 };
 

trunk/nom/include/nomapi.h ¶

@@ -73 +73 @@
 } nomClassDataStructure, *NomClassDataStructurePtr;
 
+/**
+   Structure describing the parameters of a static method. The information
+   is used for runtime type information.
+ */
 typedef struct nomParmInfoStruct {
   gulong ulNumParms;  /* The number of parameters for this method */
   gchar* pReturnType;
-  gchar* pParm[];    /* Parameter types */
+  gchar* pParm[];     /* Parameter types */
 }nomParmInfo;
 
@@ -141 +145 @@
 #define NOM_FLG_NOMUNINIT_OVERRIDEN  0x00000002
 
-/* This structure holds additional informationen about class not to be found in nomMethodTab.
+/* This structure holds additional informationen about a class not to be found in nomMethodTab.
    It holds the default method table of the class and the thunking code necessary to access
-   data and methods.
+   data and methods. Note that the name may be slightly misleading. This structure is not
+   limited to objects/classes which are related to NOMClass. It's a structure used by every NOM
+   class (be it a normal class or a meta class). 
 */
 typedef struct 
 {
   nomMethodTab  *mtab;                  /* This is the mtab for this class it points to thisMtab at the
-                                           end (not mtab for objects created by this meta class)          */
+                                           end. This is not an mtab for objects created by a meta class.
+                                           Meta classes store the pointer to a NOMClassPriv which specify
+                                           the objects they may create in a private instance variable.    */
   gulong            ulClassSize;        /* The size of an instance (mtab+ instance vars)                  */
   gulong        ulPrivClassSize;        /* The size of this private struct including mtab (not pointr but
                                            real filled structure. Do we need this?                         */
-  // gulong        ulIsMetaClass;          /* Set to 1 if this is a metaclass                                 */
   gulong        ulClassFlags;           /* Set to 1 if this is a metaclass                                 */
   nomStaticClassInfo *sci;              /* Class description                                               */
+  /* FIXME: the following list may be obsolete maybe when we just use the parentMtabStruc??                */
   nomMethodTabList mtabList;            /* The (private) internal list of mtabs we maintain 
                                            struct nomMethodTabList {