Welcome to little lamb

Code » limb » master » tree

[master] / src / doc / genalloc.h / genalloc_cat.3.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
% limb manual
% genalloc_cat(3)
% limb 0.1.0
% 2023-07-24

# NAME

genalloc_catb, genalloc_cat, genalloc_copyb, genalloc_copy, genalloc_insertb,
genalloc_insert, genalloc_append - adding data into a genalloc

# SYNOPSIS

    #include <limb/genalloc.h>

```pre hl
int genalloc_catb(<em>type</em>, genalloc *<em>ga</em>, const <em>type</em> *<em>el</em>, int <em>num</em>)
int genalloc_cat(<em>type</em>, genalloc *<em>ga</em>, const genalloc *<em>gasce</em>)

int genalloc_copyb(<em>type</em>, genalloc *<em>ga</em>, const <em>type</em> *<em>el</em>, int <em>num</em>)
int genalloc_copy(<em>type</em>, genalloc *<em>ga</em>, const genalloc *<em>gasce</em>)

int genalloc_insertb(<em>type</em>, genalloc *<em>ga</em>, size_t <em>offset</em>, const <em>type</em> *<em>el</em>, int <em>num</em>)
int genalloc_insert(<em>type</em>, genalloc *<em>ga</em>, size_t <em>offset</em>, const genalloc *<em>gasce</em>)

int genalloc_append(<em>type</em>, genalloc *<em>ga</em>, type *<em>el</em>)
```

# DESCRIPTION

The `genalloc_catb`() macro appends the content of memory pointed by `el` -
which must be `num` elements of type `type` - into the genalloc pointed by `ga`.

The `genalloc_cat`() macro is similar to `genalloc_catb`() macro but
appending the content of genalloc `gasce`.


The `genalloc_copyb`() macro copies the content of memory pointed by `el` -
which must be `num` elements of type `type` - into the genalloc pointed by `ga`.
That is, the genalloc will only contain `el` afterwards.

The `genalloc_copy`() macro is similar to `genalloc_copyb`() macro but
copying the content of genalloc `gasce`.


The `genalloc_insertb`() macro inserts the content of memory pointed by
`el` - which must be `num` elements of type `type` -  into the genalloc pointed
by `ga` at offset `offset`.

The `genalloc_insert`() macro is similar to `genalloc_insertb`() macro but
inserting the content of genalloc `gasce`.


The `genalloc_append`() macro appends the element of type `type` pointed be
`el` into the genalloc pointed by `ga`.

! NOTE:
! Obviously all these macros ensure that there is enough room available in the
! genalloc `ga` before writing data into it.

# RETURN VALUE

These functions return 1 on success. Otherwise they return 0 and set `errno` to
indicate the error.

# ERRORS

The `genalloc_catb`(), `genalloc_cat`(), `genalloc_copyb`(), `genalloc_copy`(),
`genalloc_insertb`() and `genalloc_insert`() functions may fail for the errors
described for [stralloc_catb](3), [stralloc_cat](3), [stralloc_copyb](3),
[stralloc_copy](3), [stralloc_insertb](3) and [stralloc_insert](3) respectively.

The `genalloc_append`() function may fail for the error described for
[stralloc_catb](3).