common: add a comment
[olsrd.git] / src / common / string_handling.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 #include <assert.h>
47 #include <string.h>
48
49 #include "common/string_handling.h"
50
51 /**
52  * A somewhat safe version of strncpy.
53  * 1) This function never writes more than dest_size bytes.
54  * 2) This function always terminates the content of the dest buffer with
55  *    a zero byte.
56  * 3) This function does not write more than strlen(src)+1 bytes
57  *
58  * @param dest pointer to the destination buffer
59  * @param src pointer to the source buffer
60  * @param dest_size length of destination buffer in bytes
61  *
62  * @return pointer to destination buffer
63  */
64 static char *_internal_strscpy(char *dest, const char *src, size_t dest_size) {
65   /* number of bytes to be copied without null byte */
66   size_t length = 0;
67
68   /* reserve space for null byte in dest */
69   dest_size--;
70
71   /* determine src length (without null byte) */
72   while ((length < dest_size) && src[length]) {
73     length++;
74   }
75
76   /* force null byte */
77   dest[length] = 0;
78
79   /* copy src content without null byte */
80   return strncpy(dest, src, length);
81 }
82
83 /**
84  * A somewhat safe version of strncpy.
85  * 1) This function never writes more than dest_size bytes.
86  * 2) This function always terminates the content of the dest buffer with
87  *    a zero byte.
88  * 3) This function does not write more than strlen(src)+1 bytes
89  *
90  * @param dest pointer to the destination buffer
91  * @param src pointer to the source buffer
92  * @param dest_size length of destination buffer in bytes
93  *
94  * @return pointer to destination buffer
95  */
96 char * strscpy(char *dest, const char *src, size_t dest_size) {
97   /* fail hard on debug build */
98   assert(dest);
99   assert(src);
100   assert(dest_size);
101
102   /* just return for non-debug build */
103   if (!src || !dest || !dest_size) {
104     return NULL ;
105   }
106
107   return _internal_strscpy(dest, src, dest_size);
108 }
109
110 /**
111  * A somewhat safe version of strncat, it appends the string
112  * content of src to dest.
113  * 1) This function never writes more than dest_size bytes.
114  * 2) This function always terminates the content of the dest buffer with
115  *    a zero byte.
116  * 3) This function does not write more than strlen(src)+1 bytes
117  *
118  * The function returns an error if dst or src or dst_size is zero.
119  *
120  * @param dest pointer to the destination buffer
121  * @param src pointer to the source buffer
122  * @param dest_size length of destination buffer in bytes
123  *
124  * @return pointer to destination buffer, NULL if an error happened
125  */
126 char * strscat(char *dest, const char *src, size_t dest_size) {
127   size_t dst_content_len;
128
129   /* fail hard on debug build */
130   assert(dest);
131   assert(src);
132   assert(dest_size);
133
134   /* just return for non-debug build */
135   if (!src || !dest || !dest_size) {
136     return NULL ;
137   }
138
139   dst_content_len = strlen(dest);
140   if (dest_size <= dst_content_len) {
141     return dest;
142   }
143   return _internal_strscpy(dest + dst_content_len, src, dest_size - dst_content_len);
144 }