2961a013742998c04c5fbd586e05d16c416bf4c9
[openvswitch] / lib / dynamic-string.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef DYNAMIC_STRING_H
18 #define DYNAMIC_STRING_H 1
19
20 #include <stdarg.h>
21 #include <stdbool.h>
22 #include <stddef.h>
23 #include <stdint.h>
24 #include <stdio.h>
25 #include "compiler.h"
26
27 struct tm;
28
29 struct ds {
30     char *string;       /* Null-terminated string. */
31     size_t length;      /* Bytes used, not including null terminator. */
32     size_t allocated;   /* Bytes allocated, not including null terminator. */
33 };
34
35 #define DS_EMPTY_INITIALIZER { NULL, 0, 0 }
36
37 void ds_init(struct ds *);
38 void ds_clear(struct ds *);
39 void ds_truncate(struct ds *, size_t new_length);
40 void ds_reserve(struct ds *, size_t min_length);
41 char *ds_put_uninit(struct ds *, size_t n);
42 static inline void ds_put_char(struct ds *, char);
43 void ds_put_utf8(struct ds *, int uc);
44 void ds_put_char_multiple(struct ds *, char, size_t n);
45 void ds_put_buffer(struct ds *, const char *, size_t n);
46 void ds_put_cstr(struct ds *, const char *);
47 void ds_put_and_free_cstr(struct ds *, char *);
48 void ds_put_format(struct ds *, const char *, ...) PRINTF_FORMAT(2, 3);
49 void ds_put_format_valist(struct ds *, const char *, va_list)
50     PRINTF_FORMAT(2, 0);
51 void ds_put_printable(struct ds *, const char *, size_t);
52 void ds_put_strftime(struct ds *, const char *, const struct tm *)
53     STRFTIME_FORMAT(2);
54 void ds_put_hex_dump(struct ds *ds, const void *buf_, size_t size,
55                      uintptr_t ofs, bool ascii);
56 int ds_get_line(struct ds *, FILE *);
57 int ds_get_preprocessed_line(struct ds *, FILE *);
58
59 char *ds_cstr(struct ds *);
60 const char *ds_cstr_ro(const struct ds *);
61 char *ds_steal_cstr(struct ds *);
62 void ds_destroy(struct ds *);
63 void ds_swap(struct ds *, struct ds *);
64
65 int ds_last(const struct ds *);
66 void ds_chomp(struct ds *, int c);
67 \f
68 /* Inline functions. */
69
70 void ds_put_char__(struct ds *, char);
71
72 static inline void
73 ds_put_char(struct ds *ds, char c)
74 {
75     if (ds->length < ds->allocated) {
76         ds->string[ds->length++] = c;
77         ds->string[ds->length] = '\0';
78     } else {
79         ds_put_char__(ds, c);
80     }
81 }
82
83 #endif /* dynamic-string.h */