xref: /freebsd/contrib/atf/atf-c/detail/dynstr.h (revision c243e4902be8df1e643c76b5f18b68bb77cc5268)
1*c243e490SMarcel Moolenaar /*
2*c243e490SMarcel Moolenaar  * Automated Testing Framework (atf)
3*c243e490SMarcel Moolenaar  *
4*c243e490SMarcel Moolenaar  * Copyright (c) 2008 The NetBSD Foundation, Inc.
5*c243e490SMarcel Moolenaar  * All rights reserved.
6*c243e490SMarcel Moolenaar  *
7*c243e490SMarcel Moolenaar  * Redistribution and use in source and binary forms, with or without
8*c243e490SMarcel Moolenaar  * modification, are permitted provided that the following conditions
9*c243e490SMarcel Moolenaar  * are met:
10*c243e490SMarcel Moolenaar  * 1. Redistributions of source code must retain the above copyright
11*c243e490SMarcel Moolenaar  *    notice, this list of conditions and the following disclaimer.
12*c243e490SMarcel Moolenaar  * 2. Redistributions in binary form must reproduce the above copyright
13*c243e490SMarcel Moolenaar  *    notice, this list of conditions and the following disclaimer in the
14*c243e490SMarcel Moolenaar  *    documentation and/or other materials provided with the distribution.
15*c243e490SMarcel Moolenaar  *
16*c243e490SMarcel Moolenaar  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
17*c243e490SMarcel Moolenaar  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
18*c243e490SMarcel Moolenaar  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19*c243e490SMarcel Moolenaar  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20*c243e490SMarcel Moolenaar  * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
21*c243e490SMarcel Moolenaar  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22*c243e490SMarcel Moolenaar  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23*c243e490SMarcel Moolenaar  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24*c243e490SMarcel Moolenaar  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25*c243e490SMarcel Moolenaar  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26*c243e490SMarcel Moolenaar  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27*c243e490SMarcel Moolenaar  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*c243e490SMarcel Moolenaar  */
29*c243e490SMarcel Moolenaar 
30*c243e490SMarcel Moolenaar #if !defined(ATF_C_DYNSTR_H)
31*c243e490SMarcel Moolenaar #define ATF_C_DYNSTR_H
32*c243e490SMarcel Moolenaar 
33*c243e490SMarcel Moolenaar #include <stdarg.h>
34*c243e490SMarcel Moolenaar #include <stdbool.h>
35*c243e490SMarcel Moolenaar #include <stddef.h>
36*c243e490SMarcel Moolenaar 
37*c243e490SMarcel Moolenaar #include <atf-c/error_fwd.h>
38*c243e490SMarcel Moolenaar 
39*c243e490SMarcel Moolenaar /* ---------------------------------------------------------------------
40*c243e490SMarcel Moolenaar  * The "atf_dynstr" type.
41*c243e490SMarcel Moolenaar  * --------------------------------------------------------------------- */
42*c243e490SMarcel Moolenaar 
43*c243e490SMarcel Moolenaar struct atf_dynstr {
44*c243e490SMarcel Moolenaar     char *m_data;
45*c243e490SMarcel Moolenaar     size_t m_datasize;
46*c243e490SMarcel Moolenaar     size_t m_length;
47*c243e490SMarcel Moolenaar };
48*c243e490SMarcel Moolenaar typedef struct atf_dynstr atf_dynstr_t;
49*c243e490SMarcel Moolenaar 
50*c243e490SMarcel Moolenaar /* Constants */
51*c243e490SMarcel Moolenaar extern const size_t atf_dynstr_npos;
52*c243e490SMarcel Moolenaar 
53*c243e490SMarcel Moolenaar /* Constructors and destructors */
54*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_init(atf_dynstr_t *);
55*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_init_ap(atf_dynstr_t *, const char *, va_list);
56*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_init_fmt(atf_dynstr_t *, const char *, ...);
57*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_init_raw(atf_dynstr_t *, const void *, size_t);
58*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_init_rep(atf_dynstr_t *, size_t, char);
59*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_init_substr(atf_dynstr_t *, const atf_dynstr_t *,
60*c243e490SMarcel Moolenaar                                    size_t, size_t);
61*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_copy(atf_dynstr_t *, const atf_dynstr_t *);
62*c243e490SMarcel Moolenaar void atf_dynstr_fini(atf_dynstr_t *);
63*c243e490SMarcel Moolenaar char *atf_dynstr_fini_disown(atf_dynstr_t *);
64*c243e490SMarcel Moolenaar 
65*c243e490SMarcel Moolenaar /* Getters */
66*c243e490SMarcel Moolenaar const char *atf_dynstr_cstring(const atf_dynstr_t *);
67*c243e490SMarcel Moolenaar size_t atf_dynstr_length(const atf_dynstr_t *);
68*c243e490SMarcel Moolenaar size_t atf_dynstr_rfind_ch(const atf_dynstr_t *, char);
69*c243e490SMarcel Moolenaar 
70*c243e490SMarcel Moolenaar /* Modifiers */
71*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_append_ap(atf_dynstr_t *, const char *, va_list);
72*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_append_fmt(atf_dynstr_t *, const char *, ...);
73*c243e490SMarcel Moolenaar void atf_dynstr_clear(atf_dynstr_t *);
74*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_prepend_ap(atf_dynstr_t *, const char *, va_list);
75*c243e490SMarcel Moolenaar atf_error_t atf_dynstr_prepend_fmt(atf_dynstr_t *, const char *, ...);
76*c243e490SMarcel Moolenaar 
77*c243e490SMarcel Moolenaar /* Operators */
78*c243e490SMarcel Moolenaar bool atf_equal_dynstr_cstring(const atf_dynstr_t *, const char *);
79*c243e490SMarcel Moolenaar bool atf_equal_dynstr_dynstr(const atf_dynstr_t *, const atf_dynstr_t *);
80*c243e490SMarcel Moolenaar 
81*c243e490SMarcel Moolenaar #endif /* ATF_C_DYNSTR_H */
82