u8-line: Add definition of an initializer.
[pspp] / src / libpspp / u8-line.h
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 2011, 2012 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #ifndef LIBPSPP_U8_LINE_H
18 #define LIBPSPP_U8_LINE_H 1
19
20 #include "libpspp/str.h"
21
22 struct pool;
23
24 /* A line of text, encoded in UTF-8, with support functions that properly
25    handle double-width characters and backspaces.
26
27    Designed to make appending text fast, and access and modification of other
28    column positions possible. */
29 struct u8_line
30   {
31     struct string s;            /* Content, in UTF-8. */
32     size_t width;               /* Display width, in character positions. */
33   };
34
35 #define U8_LINE_INITIALIZER { .s = DS_EMPTY_INITIALIZER };
36
37 void u8_line_init (struct u8_line *);
38 void u8_line_destroy (struct u8_line *);
39 void u8_line_clear (struct u8_line *);
40 char *u8_line_reserve (struct u8_line *, int x0, int x1, int n);
41 void u8_line_put (struct u8_line *, int x0, int x1, const char *s, int n);
42 void u8_line_set_length (struct u8_line *, int x);
43
44 #endif /* libpspp/u8-line.h */