home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tolkit45.zip / os2tk45 / som / include / somobj.sc < prev    next >
Text File  |  1999-02-22  |  9KB  |  225 lines
  1.  
  2. /*
  3.  * This file was generated by the SOM Compiler.
  4.  * FileName: somobj.sc.
  5.  * Generated using:
  6.  *     SOM Precompiler somipc: 2.29.1.17
  7.  *     SOM Emitter emitsc: 2.47
  8.  */
  9. class: SOMObject, 
  10.     externalstem = somob, majorversion = 1, 
  11.     minorversion = 5, filestem = somobj;
  12.  
  13.     --  This is the SOM root class, all SOM classes must be descended from
  14.     --  <SOMObject>. <SOMObject> has no instance data so there is no
  15.     --  per-instance cost to to being descended from it.
  16.  
  17.  
  18. release order:
  19.     somInit, somUninit, 
  20.     somFree, somDefaultVCopyInit, 
  21.     somGetClassName, somGetClass, 
  22.     somIsA, somRespondsTo, 
  23.     somIsInstanceOf, somGetSize, 
  24.     somDumpSelf, somDumpSelfInt, 
  25.     somPrintSelf, somDefaultConstVCopyInit, 
  26.     somDispatchV, somDispatchL, 
  27.     somDispatchA, somDispatchD, 
  28.     somDispatch, somClassDispatch, 
  29.     somCastObj, somResetObj, 
  30.     somDefaultInit, somDestruct, 
  31.     somPrivate1, somPrivate2, 
  32.     somDefaultCopyInit, somDefaultConstCopyInit, 
  33.     somDefaultAssign, somDefaultConstAssign, 
  34.     somDefaultVAssign, somDefaultConstVAssign;
  35.  
  36. methods:
  37.  
  38.  
  39.     void   somDefaultInit(som3InitCtrl* ctrl), descriptor = ::SOMObject::somDefaultInit, init, 
  40.     caller_owns_parameters = ctrl;
  41.  
  42.     --  A default initializer for a SOM object. Passing a null ctrl
  43.     --  indicates to the receiver that its class is the class of the
  44.     --  object being initialized, whereby the initializer will determine
  45.     --  an appropriate control structure.
  46.  
  47.     void   somDestruct(octet doFree,
  48.         som3DestructCtrl* ctrl), descriptor = ::SOMObject::somDestruct, caller_owns_parameters = ctrl;
  49.  
  50.     --  The default destructor for a SOM object. A nonzero <doFree>
  51.     --  indicates that the object storage should be freed by the
  52.     --  object's class (via somDeallocate) after uninitialization.
  53.     --  As with somDefaultInit, a null ctrl can be passed.
  54.  
  55.     void   somDefaultCopyInit(som3InitCtrl* ctrl,
  56.         SOMObject* fromObj), descriptor = ::SOMObject::somDefaultCopyInit, init, 
  57.     caller_owns_parameters = ctrl;
  58.  
  59.     --  A default copy constructor. Use this to make copies of objects for
  60.     --  calling methods with "by-value" argument semantics.
  61.  
  62.     SOMObject*   somDefaultAssign(som3AssignCtrl* ctrl,
  63.         SOMObject* fromObj), descriptor = ::SOMObject::somDefaultAssign, caller_owns_parameters = ctrl;
  64.  
  65.     --  A default assignment operator. Use this to "assign" the state of one
  66.     --  object to another.
  67.  
  68.     void   somDefaultConstCopyInit(som3InitCtrl* ctrl,
  69.         SOMObject* fromObj), descriptor = ::SOMObject::somDefaultConstCopyInit, init, 
  70.     caller_owns_parameters = ctrl;
  71.  
  72.     --  A default copy constructor that uses a const fromObj.
  73.  
  74.     void   somDefaultVCopyInit(som3InitCtrl* ctrl,
  75.         SOMObject* fromObj), descriptor = ::SOMObject::somDefaultVCopyInit, init, 
  76.     caller_owns_parameters = ctrl;
  77.  
  78.     --  A default copy constructor that uses a volatile fromObj.
  79.  
  80.     void   somDefaultConstVCopyInit(som3InitCtrl* ctrl,
  81.         SOMObject* fromObj), descriptor = ::SOMObject::somDefaultConstVCopyInit, init, 
  82.     caller_owns_parameters = ctrl;
  83.  
  84.     --  A default copy constructor that uses a const volatile fromObj.
  85.  
  86.     SOMObject*   somDefaultConstAssign(som3AssignCtrl* ctrl,
  87.         SOMObject* fromObj), descriptor = ::SOMObject::somDefaultConstAssign, caller_owns_parameters = ctrl;
  88.  
  89.     --  A default assignment operator that uses a const fromObj.
  90.  
  91.     SOMObject*   somDefaultVAssign(som3AssignCtrl* ctrl,
  92.         SOMObject* fromObj), descriptor = ::SOMObject::somDefaultVAssign, caller_owns_parameters = ctrl;
  93.  
  94.     --  A default assignment operator that uses a volatile fromObj.
  95.  
  96.     SOMObject*   somDefaultConstVAssign(som3AssignCtrl* ctrl,
  97.         SOMObject* fromObj), descriptor = ::SOMObject::somDefaultConstVAssign, caller_owns_parameters = ctrl;
  98.  
  99.     --  A default assignment operator that uses a const volatile fromObj.
  100.  
  101.     void   somInit(), descriptor = ::SOMObject::somInit;
  102.  
  103.     --  Obsolete but still supported. Override somDefaultInit instead of somInit.
  104.  
  105.     void   somFree(), descriptor = ::SOMObject::somFree;
  106.  
  107.     --  Use as directed by framework implementations.
  108.  
  109.     void   somUninit(), descriptor = ::SOMObject::somUninit;
  110.  
  111.     --  Obsolete but still supported. Override somDestruct instead of somUninit.
  112.  
  113.     SOMClass*   somGetClass(), descriptor = ::SOMObject::somGetClass;
  114.  
  115.     --  Return the receiver's class.
  116.  
  117.     string   somGetClassName(), descriptor = ::SOMObject::somGetClassName;
  118.  
  119.     --  Return the name of the receiver's class.
  120.  
  121.     long   somGetSize(), descriptor = ::SOMObject::somGetSize;
  122.  
  123.     --  Return the size of the receiver.
  124.  
  125.     boolean   somIsA(SOMClass* aClassObj), descriptor = ::SOMObject::somIsA;
  126.  
  127.     --  Returns 1 (true) if the receiver responds to methods
  128.     --  introduced by <aClassObj>, and 0 (false) otherwise.
  129.  
  130.     boolean   somIsInstanceOf(SOMClass* aClassObj), descriptor = ::SOMObject::somIsInstanceOf;
  131.  
  132.     --  Returns 1 (true) if the receiver is an instance of
  133.     --  <aClassObj> and 0 (false) otherwise.
  134.  
  135.     boolean   somRespondsTo(somId mId), descriptor = ::SOMObject::somRespondsTo, caller_owns_parameters = mId;
  136.  
  137.     --  Returns 1 (true) if the indicated method can be invoked
  138.     --  on the receiver and 0 (false) otherwise.
  139.  
  140.     boolean   somDispatch(somToken* retValue,
  141.         somId methodId,
  142.         ...), descriptor = ::SOMObject::somDispatch, caller_owns_parameters = methodId, ap;
  143.  
  144.     --  This method provides a generic, class-specific dispatch mechanism.
  145.     --  It accepts as input <retValue> a pointer to the memory area to be
  146.     --  loaded with the result of dispatching the method indicated by
  147.     --  <methodId> using the arguments in <ap>. <ap> contains the object
  148.     --  on which the method is to be invoked as the first argument.
  149.  
  150.     boolean   somClassDispatch(SOMClass* clsObj,
  151.         somToken* retValue,
  152.         somId methodId,
  153.         ...), descriptor = ::SOMObject::somClassDispatch, caller_owns_parameters = methodId, ap;
  154.  
  155.     --  Like somDispatch, but method resolution for static methods is done
  156.     --  according to the clsObj instance method table.
  157.  
  158.     boolean   somCastObj(SOMClass* cls), descriptor = ::SOMObject::somCastObj;
  159.  
  160.     --  cast the receiving object to cls (which must be an ancestor of the
  161.     --  objects true class. Returns true on success.
  162.  
  163.     boolean   somResetObj(), descriptor = ::SOMObject::somResetObj;
  164.  
  165.     --  reset an object to its true class. Returns true always.
  166.  
  167.     void   somDispatchV(somId methodId,
  168.         somId descriptor,
  169.         ...), descriptor = ::SOMObject::somDispatchV, caller_owns_parameters = methodId, descriptor, ap;
  170.  
  171.     --  Obsolete. Use somDispatch instead.
  172.  
  173.     long   somDispatchL(somId methodId,
  174.         somId descriptor,
  175.         ...), descriptor = ::SOMObject::somDispatchL, caller_owns_parameters = methodId, descriptor, ap;
  176.  
  177.     --  Obsolete. Use somDispatch instead.
  178.  
  179.     void*   somDispatchA(somId methodId,
  180.         somId descriptor,
  181.         ...), descriptor = ::SOMObject::somDispatchA, caller_owns_parameters = methodId, descriptor, ap;
  182.  
  183.     --  Obsolete. Use somDispatch instead.
  184.  
  185.     double   somDispatchD(somId methodId,
  186.         somId descriptor,
  187.         ...), descriptor = ::SOMObject::somDispatchD, caller_owns_parameters = methodId, descriptor, ap;
  188.  
  189.     --  Obsolete. Use somDispatch instead.
  190.  
  191.     SOMObject*   somPrintSelf(), descriptor = ::SOMObject::somPrintSelf;
  192.  
  193.     --  Uses <SOMOutCharRoutine> to write a brief string with identifying
  194.     --  information about this object.  The default implementation just gives
  195.     --  the object's class name and its address in memory.
  196.     --  <self> is returned.
  197.  
  198.     void   somDumpSelf(long level), descriptor = ::SOMObject::somDumpSelf;
  199.  
  200.     --  Uses <SOMOutCharRoutine> to write a detailed description of this object
  201.     --  and its current state.
  202.     -- 
  203.     --  <level> indicates the nesting level for describing compound objects
  204.     --  it must be greater than or equal to zero.  All lines in the
  205.     --  description will be preceeded by <2*level> spaces.
  206.     -- 
  207.     --  This routine only actually writes the data that concerns the object
  208.     --  as a whole, such as class, and uses <somDumpSelfInt> to describe
  209.     --  the object's current state.  This approach allows readable
  210.     --  descriptions of compound objects to be constructed.
  211.     -- 
  212.     --  Generally it is not necessary to override this method, if it is
  213.     --  overriden it generally must be completely replaced.
  214.  
  215.     void   somDumpSelfInt(long level), descriptor = ::SOMObject::somDumpSelfInt;
  216.  
  217.     --  Uses <SOMOutCharRoutine> to write in the current state of this object.
  218.     --  Generally this method will need to be overridden.  When overriding
  219.     --  it, begin by calling the parent class form of this method and then
  220.     --  write in a description of your class's instance data. This will
  221.     --  result in a description of all the object's instance data going
  222.     --  from its root ancestor class to its specific class.
  223.  
  224. #include <somcls.sc> 
  225.