annotate buf_resize.3 @ 14:1297027290b9

misc: add CHANGES.md
author David Demelier <markand@malikania.fr>
date Wed, 16 Dec 2020 15:41:26 +0100
parents b1991ee4451d
children 939fe74cd80a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .\" buf_resize.3 -- simple string buffer for C
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Copyright (c) 2019-2020 David Demelier <markand@malikania.fr>
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" Permission to use, copy, modify, and/or distribute this software for any
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\" purpose with or without fee is hereby granted, provided that the above
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" copyright notice and this permission notice appear in all copies.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Dd October 29, 2019-2020
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .Dt BUF_RESIZE 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Os
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .\" NAME
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Sh NAME
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .Nm buf_resize
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Nd change string length
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .\" SYNOPSIS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Sh SYNOPSIS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .In buf.h
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Ft bool
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .Fn buf_resize "struct buf *b" "size_t size" "char c"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .\" DESCRIPTION
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .Sh DESCRIPTION
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 Change the buffer length specified by
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .Fa b
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 to the new
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Fa size
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 and optionally fill new space with character
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Fa c .
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 .Pp
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 This function serves two purposes, it can reduce the string length if the
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .Fa size
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 argument is smaller than current
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Fa b
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 length or it can increase it and fill the new region with
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 .Fa c .
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 In the first case, the function never fails in the second it may need to
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 reallocate data which could fail if no memory is available.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 .Pp
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 Note that in constrast to
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .Fn buf_shrink
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 function, the
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 .Fn buf_resize
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 function never reallocate data if the new size is smaller, you may want to call
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 .Fn buf_shrink
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 if memory should be released.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 .\" RETURN VALUE
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 .Sh RETURN VALUE
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 The
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .Fn buf_resize
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 function returns false in case of error and
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 .Va errno
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 is set to indicate the error.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 .\" ERRORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 .Sh ERRORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 .Bl -tag -width Er
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .It Bq Er ENOMEM
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 Couldn't allocate more memory.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .El
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 .\" SEE ALSO
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 .Sh SEE ALSO
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 .Xr libbuf 3 ,
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 .Xr buf_resize 3 ,
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 .Xr buf_shrink 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 .\" AUTHORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 .Sh AUTHORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 The
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 .Nm libbuf
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 library was written by
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 .An David Demelier <markand@malikania.fr>