src/st-heap.h

   1 /*
   2  * st-heap.h
   3  *
   4  * Copyright (C) 2008 Vincent Geddes
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23 */
  24
  25 #ifndef __ST_HEAP_H__
  26 #define __ST_HEAP_H__
  27
  28 #include <st-types.h>
  29
  30 typedef struct st_heap
  31 {
  32     st_uchar *start; /* start of reserved address space */
  33     st_uchar *p;     /* end of committed address space (`start' to `p' is thus writeable memory) */
  34     st_uchar *end;   /* end of reserved address space */
  35
  36 } st_heap;
  37
  38 st_heap  *st_heap_new       (st_uint reserved_size);
  39
  40 bool      st_heap_grow      (st_heap *heap, st_uint grow_size);
  41
  42 bool      st_heap_shrink    (st_heap *heap, st_uint shrink_size);
  43
  44 void      st_heap_destroy   (st_heap *heap);
  45
  46
  47 #endif /* __ST_HEAP_H__ */