1 /* SPDX-License-Identifier: GPL-2.0 */
3 * C++ stream style string builder used in KUnit for building messages.
5 * Copyright (C) 2019, Google LLC.
6 * Author: Brendan Higgins <brendanhiggins@google.com>
9 #ifndef _KUNIT_STRING_STREAM_H
10 #define _KUNIT_STRING_STREAM_H
12 #include <linux/spinlock.h>
13 #include <linux/types.h>
14 #include <linux/stdarg.h>
16 struct string_stream_fragment {
17 struct list_head node;
21 struct string_stream {
23 struct list_head fragments;
24 /* length and fragments are protected by this lock */
32 struct string_stream *kunit_alloc_string_stream(struct kunit *test, gfp_t gfp);
33 void kunit_free_string_stream(struct kunit *test, struct string_stream *stream);
35 struct string_stream *alloc_string_stream(gfp_t gfp);
36 void free_string_stream(struct string_stream *stream);
38 int __printf(2, 3) string_stream_add(struct string_stream *stream,
39 const char *fmt, ...);
41 int __printf(2, 0) string_stream_vadd(struct string_stream *stream,
45 void string_stream_clear(struct string_stream *stream);
47 char *string_stream_get_string(struct string_stream *stream);
49 int string_stream_append(struct string_stream *stream,
50 struct string_stream *other);
52 bool string_stream_is_empty(struct string_stream *stream);
54 void string_stream_destroy(struct string_stream *stream);
56 static inline void string_stream_set_append_newlines(struct string_stream *stream,
59 stream->append_newlines = append_newlines;
62 #endif /* _KUNIT_STRING_STREAM_H */