rom/intuition/disposeobject.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5 */
   6
   7 #include <intuition/classes.h>
   8 #include <proto/alib.h>
   9 #include "intuition_intern.h"
  10
  11 /*****************************************************************************
  12
  13     NAME */
  14 #include <intuition/classusr.h>
  15 #include <proto/intuition.h>
  16
  17         AROS_LH1(void, DisposeObject,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(APTR, object, A0),
  21
  22 /*  LOCATION */
  23         struct IntuitionBase *, IntuitionBase, 107, Intuition)
  24
  25 /*  FUNCTION
  26         Deletes a BOOPSI object. All memory associated with the object
  27         is freed. The object must have been created with NewObject().
  28         Some object contain other object which might be freed as well
  29         when this function is used on the "parent" while others might
  30         also contain children but won't free them. Read the documentation
  31         of the class carefully to find out how it behaves.
  32
  33     INPUTS
  34         object - The result of a call to NewObject() or a similar function,
  35              may be NULL.
  36
  37     RESULT
  38         None.
  39
  40     NOTES
  41         This functions sends OM_DISPOSE to the oejct.
  42
  43     EXAMPLE
  44
  45     BUGS
  46
  47     SEE ALSO
  48         NewObjectA(), SetAttrsA(), GetAttr(), MakeClass()
  49         "Basic Object-Oriented Programming System for Intuition" and
  50         "boopsi Class Reference" Document.
  51
  52     INTERNALS
  53
  54 *****************************************************************************/
  55 {
  56     AROS_LIBFUNC_INIT
  57
  58     STACKULONG MethodID = OM_DISPOSE;
  59
  60     DEBUG_DISPOSEOBJECT(dprintf("DisposeObject: Object 0x%lx\n", object));
  61
  62     if (!object)
  63         return;
  64
  65     DoMethodA (object, (Msg)&MethodID);
  66
  67     DEBUG_DISPOSEOBJECT(dprintf("DisposeObject: 0x%lx deleted\n", object));
  68
  69     DEBUG_DISPOSEOBJECT(dprintf("DisposeObject: done\n"));
  70
  71     AROS_LIBFUNC_EXIT
  72 } /* DisposeObject() */