annotate lib/xmemdup0.c @ 17587:344018b6e5d7

maint: update copyright I ran 'make update-copyright'. Signed-off-by: Eric Blake <eblake@redhat.com>
author Eric Blake <eblake@redhat.com>
date Wed, 01 Jan 2014 00:04:40 -0700
parents e542fd46ad6f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10068
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
1 /* xmemdup0.c -- copy a block of arbitrary bytes, plus a trailing NUL
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
2
17587
344018b6e5d7 maint: update copyright
Eric Blake <eblake@redhat.com>
parents: 17249
diff changeset
3 Copyright (C) 2008-2014 Free Software Foundation, Inc.
10068
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
4
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
5 This program is free software: you can redistribute it and/or modify
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
8 (at your option) any later version.
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
9
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
13 GNU General Public License for more details.
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
14
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
17
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
18 #include <config.h>
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
19
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
20 #include "xmemdup0.h"
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
21 #include "xalloc.h"
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
22
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
23 #include <string.h>
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
24
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
25 /* Clone an arbitrary block of bytes P of size S, with error checking,
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
26 and include a terminating NUL byte. P is of type 'void const *',
10068
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
27 to make it easier to use this with other mem* functions that return
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
28 'void *', but since appending a NUL byte only makes sense on bytes,
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
29 the return type is 'char *'.
10068
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
30
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
31 The terminating NUL makes it safe to use strlen or rawmemchr to
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
32 check for embedded NUL; it also speeds up algorithms such as escape
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
33 sequence processing on arbitrary memory, by making it always safe
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
34 to read the byte after the escape character rather than having to
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
35 check if each escape character is the last byte in the object. */
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
36
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
37 char *
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
38 xmemdup0 (void const *p, size_t s)
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
39 {
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
40 char *result = xcharalloc (s + 1);
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
41 memcpy (result, p, s);
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
42 result[s] = 0;
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
43 return result;
c7189e3f4fa9 Split xmemdup0 into its own module.
Eric Blake <ebb9@byu.net>
parents:
diff changeset
44 }