Welcome to little lamb

Code » limb » release » tree

[release] / src / doc / genalloc.h / genalloc.h.0.md 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
% limb manual
% genalloc.h(0)
% limb 0.1.0
% 2023-07-24

# NAME

genalloc.h - general heap memory management

# SYNOPSIS

    #include <limb/genalloc.h>

# DESCRIPTION

This header defines functions to work heap-allocated memory. It is implemented
on top of *stralloc* (See [stralloc.h](0) for more) providing an API to store
dynamic arrays of fixed-size objects.

<inc skalibs.md>

## Types

The following types are defined :

: *genalloc*
:: A *struct stralloc*, as *genalloc* is implemented on top of *stralloc*

## Objects

The following objects are defined :

: *genalloc_zero*
:: An empty *genalloc*, which can be used for initialization.

## Macros

The following macros are defined :

: *GENALLOC_ZERO*
:: Value to initialize a stack-allocated *genalloc*.

## Functions

The following functions/macros are defined :

: [genalloc_ready_tuned](3)
:: Ensure there's enough space in a *genalloc*.

: [genalloc_ready](3)
:: Ensure there's enough space in a *genalloc*.

: [genalloc_readyplus](3)
:: Ensure there's enough extra space in a *genalloc*.


: [genalloc_free](3)
:: Free memory associated with a *genalloc*.

: [genalloc_deepfree](3)
:: Free memory associated with a *genalloc*.

: [genalloc_deepfree_size](3)
:: Free memory associated with a *genalloc*.

: [genalloc_shrink](3)
:: Reduce memory usage to what's used.


: [genalloc_s](3)
:: Return a pointer to the data in a *genalloc*

: [genalloc_len](3)
:: Return the length/number of element in a *genalloc*

: [genalloc_setlen](3)
:: Set the length/number of element in a *genalloc*


: [genalloc_copyb](3)
:: Copy data into a *genalloc*.

: [genalloc_copy](3)
:: Copy content of a *genalloc* into another one.

: [genalloc_catb](3)
:: Append data into a *genalloc*.

: [genalloc_cat](3)
:: Append the content of a *genalloc* into another one.

: [genalloc_append](3)
:: Append a character into a *genalloc*.


: [genalloc_insertb](3)
:: Insert data into a *genalloc* at a specific offset.

: [genalloc_insert](3)
:: Insert the content of a *genalloc* into another one at a specific offset.


: [genalloc_qsort_full](3)
:: Sort a section of a *genalloc* using [qsort](3).

: [genalloc_qsort_r_full](3)
:: Similar to [genalloc_qsort_full](3) but using [qsort_r](3).

: [genalloc_qsort](3)
:: Sort a full *genalloc* using [qsort](3).

: [genalloc_qsort_r](3)
:: Similar to [genalloc_qsort](3) but using [qsort_r](3).


: [genalloc_remove](3)
:: Remove data from a *genalloc*.


: [genalloc_reverse](3)
:: Reverse the content of a *genalloc*.