gcc/m2/gm2-libs/SysStorage.def

   1 (* SysStorage.def provides dynamic allocation for the system components.
   2
   3 Copyright (C) 2001-2024 Free Software Foundation, Inc.
   4 Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
   5
   6 This file is part of GNU Modula-2.
   7
   8 GNU Modula-2 is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 3, or (at your option)
  11 any later version.
  12
  13 GNU Modula-2 is distributed in the hope that it will be useful, but
  14 WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 General Public License for more details.
  17
  18 Under Section 7 of GPL version 3, you are granted additional
  19 permissions described in the GCC Runtime Library Exception, version
  20 3.1, as published by the Free Software Foundation.
  21
  22 You should have received a copy of the GNU General Public License and
  23 a copy of the GCC Runtime Library Exception along with this program;
  24 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  25 <http://www.gnu.org/licenses/>.  *)
  26
  27 DEFINITION MODULE SysStorage ;
  28
  29 (*  Provides dynamic allocation for the system components.
  30     This allows the application to use the traditional Storage module
  31     which can be handled differently.  *)
  32
  33 FROM SYSTEM IMPORT ADDRESS ;
  34 EXPORT QUALIFIED ALLOCATE, DEALLOCATE, REALLOCATE, Available, Init ;
  35
  36
  37 (*
  38    ALLOCATE - attempt to allocate memory from the heap.
  39               NIL is returned in, a, if ALLOCATE fails.
  40 *)
  41
  42 PROCEDURE ALLOCATE (VAR a: ADDRESS ; size: CARDINAL) ;
  43
  44
  45 (*
  46    DEALLOCATE - return, size, bytes to the heap.
  47                 The variable, a, is set to NIL.
  48 *)
  49
  50 PROCEDURE DEALLOCATE (VAR a: ADDRESS ; size: CARDINAL) ;
  51
  52
  53 (*
  54    REALLOCATE - attempts to reallocate storage. The address,
  55                 a, should either be NIL in which case ALLOCATE
  56                 is called, or alternatively it should have already
  57                 been initialized by ALLOCATE. The allocated storage
  58                 is resized accordingly.
  59 *)
  60
  61 PROCEDURE REALLOCATE (VAR a: ADDRESS; size: CARDINAL) ;
  62
  63
  64 (*
  65    Available - returns TRUE if, size, bytes can be allocated.
  66 *)
  67
  68 PROCEDURE Available (size: CARDINAL) : BOOLEAN;
  69
  70
  71 (*
  72    Init - initializes the heap.
  73           This does nothing on a GNU/Linux system.
  74           But it remains here since it might be used in an
  75           embedded system.
  76 *)
  77
  78 PROCEDURE Init ;
  79
  80
  81 END SysStorage.