annotate man/mlk_alloc_new.3 @ 491:734b598534c4

ui: frame -> mlk_frame
author David Demelier <markand@malikania.fr>
date Tue, 28 Feb 2023 13:16:47 +0100
parents 9c3b3935f0aa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
442
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .Dd $Mdocdate$
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .Dt MLK_ALLOC_NEW 3
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .Os
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .Sh NAME
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .Nm mlk_alloc_new ,
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .Nm mlk_alloc_new0 ,
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .Nm mlk_alloc_renew ,
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .Nm mlk_alloc_renew0
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .Nd allocate memory
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .Sh LIBRARY
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 libmlk-core (-lmlk-core)
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .Sh SYNOPSIS
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .In mlk/core/alloc.h
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .Ft void *
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .Fn mlk_alloc_new "size_t size"
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Ft void *
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Fn mlk_alloc_new0 "size_t size"
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Ft void *
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .Fn mlk_alloc_renew "void *ptr, size_t size"
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Ft void *
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .Fn mlk_alloc_renew0 "void *ptr, size_t oldsize, size_t newsize"
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Sh DESCRIPTION
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .Pp
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 The
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .Fn mlk_alloc_new
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 and
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .Fn mlk_alloc_new0
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 functions allocate memory data of the given
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .Fa size .
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 The
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .Fn mlk_alloc_new0
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 variant ensure the data is being zero-initialized.
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .Pp
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 The
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Fn mlk_alloc_renew
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 function reallocates the pointer
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Fa ptr
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 according to its
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 .Fa size .
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .Pp
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 The
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Fn mlk_alloc_renew0
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 function is similar to
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 .Fn mlk_alloc_renew
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 but zero-initialize the memory. It needs the previous size given in
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .Fa oldsize
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 argument because the function would not know which memory region to zero
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 initialize when increasing the memory.
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .Sh RETURN VALUES
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 All functions return a pointer to the memory according to the current
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 allocation strategy.
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 .Sh SEE ALSO
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 .Xr mlk-alloc 3 ,
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 .Xr mlk_alloc_set 3
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 .Sh AUTHORS
9c3b3935f0aa core: rework allocations
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 .An David Demelier Aq Mt markand@malikania.fr .