1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/**
* mds — A micro-display server
* Copyright © 2014 Mattias Andrée (maandree@member.fsf.org)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MDS_MDS_KBDC_RAW_DATA_H
#define MDS_MDS_KBDC_RAW_DATA_H
#include <stddef.h>
/**
* Source code by lines, with and without comments
*/
typedef struct mds_kbdc_source_code
{
/**
* Source code by lines without comments,
* `NULL`-terminated.
*/
char** restrict lines;
/**
* Source code by lines with comments,
* `NULL`-terminated.
*/
char** restrict real_lines;
/**
* Data for `lines` (internal data)
*/
char* content;
/**
* Data for `real_lines` (internal data)
*/
char* real_content;
/**
* The number of lines, that is, the number of
* elements in `lines` and `real_lines`.
*/
size_t line_count;
/**
* The number of duplicates there are of this
* structure that shared the memory
*/
size_t duplicates;
} mds_kbdc_source_code_t;
/**
* Initialise a `mds_kbdc_source_code_t*`
*
* @param this The `mds_kbdc_source_code_t*`
*/
void mds_kbdc_source_code_initialise(mds_kbdc_source_code_t* restrict this);
/**
* Release all data in a `mds_kbdc_source_code_t*`
*
* @param this The `mds_kbdc_source_code_t*`
*/
void mds_kbdc_source_code_destroy(mds_kbdc_source_code_t* restrict this);
/**
* Release all data in a `mds_kbdc_source_code_t*`, and free it
*
* @param this The `mds_kbdc_source_code_t*`
*/
void mds_kbdc_source_code_free(mds_kbdc_source_code_t* restrict this);
/**
* Create a duplicate of a `mds_kbdc_source_code_t*`
*
* @param this The `mds_kbdc_source_code_t*`
* @return `this` is returned
*/
mds_kbdc_source_code_t* mds_kbdc_source_code_dup(mds_kbdc_source_code_t* restrict this);
/**
* Find the end of a function call
*
* @param content The code
* @param offset The index after the first character after the backslash
* that triggered this call
* @param size The length of `code`
* @return The index of the character after the bracket that closes
* the function call (may be outside the code by one character),
* or `size` if the call do not end (that is, the code ends
* prematurely), or zero if there is no function call at `offset`
*/
size_t get_end_of_call(char* restrict content, size_t offset, size_t size) __attribute__((pure));
/**
* Read lines of a source file
*
* @param pathname The pathname of the source file
* @param source_code Output parameter for read data
* @return Zero on success, -1 on error
*/
int read_source_lines(const char* restrict pathname, mds_kbdc_source_code_t* restrict source_code);
/**
* Parse a quoted and escaped string that may not include function calls or variable dereferences
*
* @param string The string
* @return The string in machine-readable format, `NULL` on error
*/
char* parse_raw_string(const char* restrict string);
#endif
|
