File: str.h

package info (click to toggle)
opendnssec 1%3A2.0.4-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 7,568 kB
  • ctags: 5,591
  • sloc: ansic: 73,214; sh: 4,739; sql: 1,288; makefile: 592; perl: 305; xml: 88
file content (104 lines) | stat: -rw-r--r-- 3,633 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*
 * Copyright (c) 2011 NLNet Labs. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

/**
 * String utilities.
 *
 */

#ifndef SHARED_STR_H
#define SHARED_STR_H

#include "config.h"
#include "status.h"
#include <time.h>


/**
 * Tokenize string
 * 
 * A return value > argc indicates there where 1 or 
 * more tokens available that did not fit in argv; Function is
 * destructive wrt buf.
 * 
 * \param[in/out] buf, string to tokenize
 * \param[in] argc, length of argv array
 * \param[out] argv, where the tokens are stored.
 * \return number of tokens processed.
 */
int ods_str_explode(char *buf, int argc, const char *argv[]);

/**
 * Concatenate characters without custom allocators.
 * 
 * Will always allocate at least 1 byte (when catting empty strings) so
 * result should always be freed by the caller.
 * 
 * \param[in] argc, number of strings in argv.
 * \param[in] argv, storage of strings.
 * \param[in] delim, delimiter used to join the strings.
 * \return string, may be empty string.
 */
char *ods_strcat_delim(int argc, char* argv[], char delim);

/**
 * Remove leading and trailing whitespace.
 * \param[in] str string to trim
 * \param[in] keep_newline whether to keep a single trailing newline or not
 * \return the same reference to the string
 *
 */
char* ods_str_trim(char* str, int keep_newline);

/**
 * Version of ctime_r that does not feature a trailing '\n' character
 *
 * \param[in] buf buffer to write the formatted date/time to
 * \param[in] nbuf size of buf, including any terminating zero characters.
 * \param[in] t time_t value to print to buf
 * \return	buf to indicate success or NULL to indicate failure.
 */
char *ods_ctime_r(char *buf, size_t nbuf, time_t t);

/**
 * Compare commandline with command, return arguments if found.
 *
 * \param[in] cmd, commandline to test
 * \param[in] cmdsize, string length of cmd
 * \param[in] scmd, command to look for
 * \return Pointer to arguments within cmd. NULL if scmd not found.
 */
const char *ods_check_command(const char *cmd, int cmdsize, 
                              const char *scmd);

int ods_find_arg(int *pargc, const char *argv[],
                 const char *longname, const char *shortname);

int ods_find_arg_and_param(int *pargc, const char *argv[],
                           const char *longname, const char *shortname,
                           const char **pvalue);

#endif /* SHARED_STR_H */