rom/intuition/allocremember.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_intern.h"
   8 #include <exec/memory.h>
   9 #include <proto/exec.h>
  10
  11 /*****************************************************************************
  12
  13     NAME */
  14 #include <intuition/intuition.h>
  15 #include <proto/intuition.h>
  16
  17         AROS_LH3(APTR, AllocRemember,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct Remember **, rememberKey, A0),
  21         AROS_LHA(ULONG             , size, D0),
  22         AROS_LHA(ULONG             , flags, D1),
  23
  24 /*  LOCATION */
  25         struct IntuitionBase *, IntuitionBase, 66, Intuition)
  26
  27 /*  FUNCTION
  28         Allocate some memory and remember it in the Remember-List.
  29
  30     INPUTS
  31         rememberKey - Store information in this list. Must be NULL for
  32                       initial call.
  33         size - How many bytes to allocate
  34         flags - Attributes (see AllocMem())
  35
  36     RESULT
  37         Pointer to the allocated memory or NULL.
  38
  39     NOTES
  40
  41     EXAMPLE
  42         struct Remember *remkey;
  43         remkey = NULL;
  44         AllocRemember(&remkey, BUFSIZE, MEMF_ANY);
  45         FreeRemember(&remkey, TRUE);
  46
  47     BUGS
  48
  49     SEE ALSO
  50
  51     INTERNALS
  52
  53 *****************************************************************************/
  54 {
  55     AROS_LIBFUNC_INIT
  56
  57     struct Remember *newKey;
  58     APTR             ptr = NULL;
  59
  60     DEBUG_REMEMBER(dprintf("AllocRemember: Key 0x%lx Size 0x%lx Flags 0x%08lx\n",
  61                            rememberKey, size, flags));
  62
  63     newKey = AllocMem (sizeof (struct Remember), MEMF_ANY);
  64
  65     if (newKey)
  66     {
  67         ptr = AllocMem (size, flags);
  68
  69         if (ptr)
  70         {
  71             newKey->NextRemember = *rememberKey;
  72             newKey->Memory       = ptr;
  73             newKey->RememberSize = size;
  74
  75             *rememberKey = newKey;
  76         }
  77         else
  78         {
  79             FreeMem (newKey, sizeof (struct Remember));
  80         }
  81     }
  82
  83     DEBUG_REMEMBER(dprintf("AllocRemember: Ptr 0x%lx\n", ptr));
  84
  85     return ptr;
  86
  87     AROS_LIBFUNC_EXIT
  88 } /* AllocRemember */