1  /* do not edit automatically generated by mc from SysStorage.  */
       2  /* SysStorage.def provides dynamic allocation for the system components.
       3  
       4  Copyright (C) 2001-2023 Free Software Foundation, Inc.
       5  Contributed by Gaius Mulley <gaius.mulley@southwales.ac.uk>.
       6  
       7  This file is part of GNU Modula-2.
       8  
       9  GNU Modula-2 is free software; you can redistribute it and/or modify
      10  it under the terms of the GNU General Public License as published by
      11  the Free Software Foundation; either version 3, or (at your option)
      12  any later version.
      13  
      14  GNU Modula-2 is distributed in the hope that it will be useful, but
      15  WITHOUT ANY WARRANTY; without even the implied warranty of
      16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      17  General Public License for more details.
      18  
      19  Under Section 7 of GPL version 3, you are granted additional
      20  permissions described in the GCC Runtime Library Exception, version
      21  3.1, as published by the Free Software Foundation.
      22  
      23  You should have received a copy of the GNU General Public License and
      24  a copy of the GCC Runtime Library Exception along with this program;
      25  see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
      26  <http://www.gnu.org/licenses/>.  */
      27  
      28  
      29  #if !defined (_SysStorage_H)
      30  #   define _SysStorage_H
      31  
      32  #include "config.h"
      33  #include "system.h"
      34  #   ifdef __cplusplus
      35  extern "C" {
      36  #   endif
      37  #include <stdbool.h>
      38  #   if !defined (PROC_D)
      39  #      define PROC_D
      40         typedef void (*PROC_t) (void);
      41         typedef struct { PROC_t proc; } PROC;
      42  #   endif
      43  
      44  #   include "GSYSTEM.h"
      45  
      46  #   if defined (_SysStorage_C)
      47  #      define EXTERN
      48  #   else
      49  #      define EXTERN extern
      50  #   endif
      51  
      52  
      53  /*
      54     ALLOCATE - attempt to allocate memory from the heap.
      55                NIL is returned in, a, if ALLOCATE fails.
      56  */
      57  
      58  EXTERN void SysStorage_ALLOCATE (void * *a, unsigned int size);
      59  
      60  /*
      61     DEALLOCATE - return, size, bytes to the heap.
      62                  The variable, a, is set to NIL.
      63  */
      64  
      65  EXTERN void SysStorage_DEALLOCATE (void * *a, unsigned int size);
      66  
      67  /*
      68     REALLOCATE - attempts to reallocate storage. The address,
      69                  a, should either be NIL in which case ALLOCATE
      70                  is called, or alternatively it should have already
      71                  been initialized by ALLOCATE. The allocated storage
      72                  is resized accordingly.
      73  */
      74  
      75  EXTERN void SysStorage_REALLOCATE (void * *a, unsigned int size);
      76  
      77  /*
      78     Available - returns TRUE if, size, bytes can be allocated.
      79  */
      80  
      81  EXTERN bool SysStorage_Available (unsigned int size);
      82  
      83  /*
      84     Init - initializes the heap.
      85            This does nothing on a GNU/Linux system.
      86            But it remains here since it might be used in an
      87            embedded system.
      88  */
      89  
      90  EXTERN void SysStorage_Init (void);
      91  #   ifdef __cplusplus
      92  }
      93  #   endif
      94  
      95  #   undef EXTERN
      96  #endif