home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / gnu / aplusplus-1.01-src.lha / src / amiga / aplusplus-1.01 / include / aplusplus / environment / APPObject.h next >
C/C++ Source or Header  |  1994-05-09  |  5KB  |  150 lines
  1. #ifndef APPObject_H
  2. #define APPObject_H
  3. /******************************************************************************
  4.  **
  5.  **    C++ Class Library for the Amiga© system software.
  6.  **
  7.  **    Copyright (C) 1994 by Armin Vogt  **  EMail: armin@uni-paderborn.de
  8.  **    All Rights Reserved.
  9.  **
  10.  **    $VER: apphome:APlusPlus/environment/APPObject.h 1.04 (04.05.94) $
  11.  **    
  12.  ******************************************************************************/
  13.  
  14. extern "C" {
  15. #include <exec/types.h>
  16. #include <stdlib.h>
  17. }
  18. #include <iostream.h>
  19. #include <APlusPlus/environment/Classes.h>
  20.  
  21. #define APPOBJECT_INVALID 0
  22.  
  23. #ifndef abs
  24. #define abs(x) ((x)<0?-(x):(x))
  25. #endif
  26.  
  27. #ifndef max
  28. #define max(x,y) ((x)>(y)?(x):(y))
  29. #endif
  30.  
  31. #ifndef min
  32. #define min(x,y) ((x)<=(y)?(x):(y))
  33. #endif
  34.  
  35. /******************************************************************************************
  36.       » APPObject class «
  37.  
  38.    Always inherit APPObject virtually!
  39.    See for a tutorial below.
  40.  
  41.  ******************************************************************************************/
  42.  
  43. class APPObject
  44. {
  45.    protected:
  46.       long _status;
  47.  
  48.       APPObject() { _status = APPOBJECT_INVALID; }
  49.       virtual ~APPObject() { _status = APPOBJECT_INVALID; }
  50.       void setError(LONG code) { _status = -abs(code); }
  51.       void setID(LONG id) { _status = abs(id); }
  52.  
  53.    public:
  54.       BOOL Ok() { return (_status > 0); }  // object' methods are allowed to be invoked only when TRUE.
  55.  
  56.       ULONG error() { return _status < 0 ? -_status : 0; }
  57.       // returns the error number specific for the failed class constructor or 0 if no error ocurred
  58.       ULONG ID() { return _status > 0 ? _status : 0; }  // returns the class ID if the object is valid
  59.       LONG status() { return _status; }
  60.       BOOL isClass(LONG id) { return id==_status; }   // check for class membership
  61. };
  62.  
  63. // check with APPOK(object) if object points to an object and if this object is Ok
  64. // On uncertainties wether to invoke a method on an object is safe check with APPOK(object).
  65. #define APPOK(obj) (obj!=NULL && obj->Ok())
  66.  
  67.  
  68. #define CHECK(obj) if((obj->status<=0) cerr<<"APPObject: invalid in "<<__FILE__<<" at "<<__LINE__<<endl;
  69.  
  70. // set error code within constructors.
  71. #define _ierror(code) { setError(code); cerr<<#code<<"//"; }
  72.  
  73. #define BUGOUT __FILE__<<":"<<__LINE__<<endl
  74. /****************************************************************************************/
  75. /*  ostreams that should only be compiled while debugging can be enclosed with _dout( ) */
  76.  
  77. #ifdef DEBUG
  78. #define _dout(msg) { cerr << msg; }
  79. #else
  80. #define _dout(msg) {;}
  81. #endif
  82.  
  83. /*****************************************************************************************/
  84. /*  Some standard error types following:                                                 */
  85.  
  86. #define OUT_OF_MEMORY 103
  87.  
  88.  
  89. /*****************************************************************************************
  90.       » APPObject class «
  91.  
  92.    This is a virtual base class for all APlusPlus classes. It is used to detect constructor failures
  93.    within the inheritance path of an object. Therefore each constructor of a derived class
  94.    should check for the proper initialisation of its super classes and in case of failure
  95.    should not allocate any resources but let the user see the occured error.
  96.    The class user who creates an object should test it for valid with obj->Ok().
  97.  
  98.    myProcedure( )
  99.    {
  100.       DerivedObject *obj = new DerivedObject( );
  101.  
  102.       if (obj)          // check for memory allocation failure
  103.       {
  104.          if (obj->Ok())    // check validity of the created object
  105.          {
  106.             ....  // work on the object
  107.          }
  108.          else
  109.          {
  110.             _dout(cerr << "Initialisation error occured: " << obj->IError() << endl;)
  111.             delete obj;    // free the memory allocated for the object data
  112.          }
  113.       }
  114.    }
  115.  
  116.    Class implementors may check the base class validity within their constructor:
  117.  
  118.    class MyClass : private InheritedClass, virtual public APPObject
  119.    {
  120.       public:
  121.          MyClass( )
  122.          {
  123.             if (Ok())   // has an error already occured ?
  124.             {
  125.                // at this point the object has the class ID of the last class in the
  126.                // inheritance list.
  127.                if (initialise( )==FALSE)    // class initialisation
  128.                {
  129.                   #define MYCLASS_SOMETHING_FAILED (MY_CLASS+1)
  130.                   _ierror(MYCLASS_SOMETHING_FAILED);
  131.                   // set the error variable to a value and
  132.                   // print the error string "MYCLASS_SOMETHING_FAILED" to stderr
  133.                }
  134.                else setID(MY_CLASS);
  135.             }
  136.             else  // initialise only for SAFE destruction, no resource allocation
  137.             {
  138.             }
  139.          }
  140.    }
  141.  
  142.    And add your class to the APlusPlus classes list with its personal class ID:
  143.  
  144.    ADD IN FILE: APlusPlus/environment/Classes.h
  145.  
  146.    #define MY_CLASS xxx
  147.  
  148.  *****************************************************************************************/
  149. #endif
  150.