2 * collectd - src/utils_subst.h
3 * Copyright (C) 2008 Sebastian Harl
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Sebastian "tokkee" Harl <sh at tokkee.org>
23 * This module provides functions for string substitution.
27 #define UTILS_SUBST_H 1
34 * Replace a substring of a string with the specified replacement text. The
35 * resulting string is stored in the buffer pointed to by 'buf' of length
36 * 'buflen'. Upon success, the buffer will always be null-terminated. The
37 * result may be truncated if the buffer is too small.
39 * The substring to be replaces is identified by the two offsets 'off1' and
40 * 'off2' where 'off1' specifies the offset to the beginning of the substring
41 * and 'off2' specifies the offset to the first byte after the substring.
43 * The minimum buffer size to store the complete return value (including the
44 * terminating '\0' character) thus has to be:
45 * off1 + strlen(replacement) + strlen(string) - off2 + 1
50 * string = "foo_____bar"
62 * The function returns 'buf' on success, NULL else.
64 char *subst (char *buf, size_t buflen, const char *string, int off1, int off2,
65 const char *replacement);
70 * This function is very similar to subst(). It differs in that it
71 * automatically allocates the memory required for the return value which the
72 * user then has to free himself.
74 * Returns the newly allocated result string on success, NULL else.
76 char *asubst (const char *string, int off1, int off2, const char *replacement);
78 #endif /* UTILS_SUBST_H */
80 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */