1/* $NetBSD: prop_string.h,v 1.4 2020/06/06 21:25:59 thorpej Exp $ */
2
3/*-
4 * Copyright (c) 2006, 2020 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _PROPLIB_PROP_STRING_H_
33#define _PROPLIB_PROP_STRING_H_
34
35#include <prop/prop_object.h>
36
37typedef struct _prop_string *prop_string_t;
38
39__BEGIN_DECLS
40prop_string_t prop_string_create_format(const char *, ...) __printflike(1, 2);
41prop_string_t prop_string_create_copy(const char *);
42prop_string_t prop_string_create_nocopy(const char *);
43
44prop_string_t prop_string_copy(prop_string_t);
45bool prop_string_copy_value(prop_string_t, void *, size_t);
46
47size_t prop_string_size(prop_string_t);
48const char * prop_string_value(prop_string_t);
49
50bool prop_string_equals(prop_string_t, prop_string_t);
51bool prop_string_equals_string(prop_string_t, const char *);
52int prop_string_compare(prop_string_t, prop_string_t);
53int prop_string_compare_string(prop_string_t, const char *);
54
55
56/* Deprecated functions. */
57prop_string_t prop_string_create(void);
58prop_string_t prop_string_create_cstring(const char *);
59prop_string_t prop_string_create_cstring_nocopy(const char *);
60
61prop_string_t prop_string_copy_mutable(prop_string_t);
62
63char * prop_string_cstring(prop_string_t);
64const char * prop_string_cstring_nocopy(prop_string_t);
65
66bool prop_string_mutable(prop_string_t);
67
68bool prop_string_equals_cstring(prop_string_t, const char *);
69
70bool prop_string_append(prop_string_t, prop_string_t);
71bool prop_string_append_cstring(prop_string_t, const char *);
72__END_DECLS
73
74#endif /* _PROPLIB_PROP_STRING_H_ */