1 | // |
---|
2 | // Cforall Version 1.0.0 Copyright (C) 2016 University of Waterloo |
---|
3 | // |
---|
4 | // The contents of this file are covered under the licence agreement in the |
---|
5 | // file "LICENCE" distributed with Cforall. |
---|
6 | // |
---|
7 | // string -- variable-length, mutable run of text, with value semantics |
---|
8 | // |
---|
9 | // Author : Michael L. Brooks |
---|
10 | // Created On : Fri Sep 03 11:00:00 2021 |
---|
11 | // Last Modified By : Peter A. Buhr |
---|
12 | // Last Modified On : Thu Aug 31 11:47:27 2023 |
---|
13 | // Update Count : 49 |
---|
14 | // |
---|
15 | |
---|
16 | #pragma once |
---|
17 | |
---|
18 | #include <fstream.hfa> |
---|
19 | |
---|
20 | |
---|
21 | // in string_res.hfa |
---|
22 | struct string_res; |
---|
23 | struct charclass_res; |
---|
24 | |
---|
25 | struct string { |
---|
26 | string_res * inner; |
---|
27 | }; |
---|
28 | |
---|
29 | // Getters |
---|
30 | size_t size(const string & s); |
---|
31 | |
---|
32 | // RAII, assignment |
---|
33 | void ?{}(string & this); // empty string |
---|
34 | void ?{}(string & s, const char * initial); // copy from string literal (NULL-terminated) |
---|
35 | void ?{}(string & s, const char * buffer, size_t bsize); // copy specific length from buffer |
---|
36 | |
---|
37 | void ?{}(string & s, const string & s2); |
---|
38 | void ?{}(string & s, string & s2); |
---|
39 | |
---|
40 | void ?=?(string & s, const char * other); // copy assignment from literal |
---|
41 | void ?=?(string & s, const string & other); |
---|
42 | void ?=?(string & s, char other); |
---|
43 | string & ?=?(string & s, string & other); // surprising ret seems to help avoid calls to autogen |
---|
44 | //string ?=?( string &, string ) = void; |
---|
45 | void ^?{}(string & s); |
---|
46 | |
---|
47 | // Alternate construction: request shared edits |
---|
48 | struct string_WithSharedEdits { |
---|
49 | string * s; |
---|
50 | }; |
---|
51 | string_WithSharedEdits ?`shareEdits( string & this ); |
---|
52 | void ?{}( string & this, string_WithSharedEdits src ); |
---|
53 | |
---|
54 | // IO Operator |
---|
55 | ofstream & ?|?(ofstream & out, const string & s); |
---|
56 | void ?|?(ofstream & out, const string & s); |
---|
57 | ifstream & ?|?(ifstream & in, string & s); |
---|
58 | void ?|?( ifstream & in, string & this ); |
---|
59 | |
---|
60 | struct _Istream_str { |
---|
61 | string & s; |
---|
62 | inline _Istream_str_base; |
---|
63 | }; // _Istream_str |
---|
64 | |
---|
65 | static inline { |
---|
66 | // read width does not include null terminator |
---|
67 | _Istream_str wdi( unsigned int rwd, string & s ) { return (_Istream_str)@{ s, {{0p}, rwd, {.flags.rwd : true}} }; } |
---|
68 | _Istream_str skip( const char scanset[] ) { return (_Istream_str)@{ *0p, {{scanset}, -1, {.all : 0}} }; } |
---|
69 | _Istream_str skip( unsigned int wd ) { return (_Istream_str)@{ *0p, {{0p}, wd, {.all : 0}} }; } |
---|
70 | _Istream_str getline( string & s, const char delimit = '\n' ) { |
---|
71 | return (_Istream_str)@{ s, {{.delimit : { delimit, '\0' } }, -1, {.flags.delimit : true, .flags.inex : true}} }; |
---|
72 | } |
---|
73 | _Istream_str & getline( _Istream_str & fmt, const char delimit = '\n' ) { |
---|
74 | fmt.delimit[0] = delimit; fmt.delimit[1] = '\0'; fmt.flags.delimit = true; fmt.flags.inex = true; return fmt; |
---|
75 | } |
---|
76 | _Istream_str incl( const char scanset[], string & s ) { return (_Istream_str)@{ s, {{scanset}, -1, {.flags.inex : false}} }; } |
---|
77 | _Istream_str & incl( const char scanset[], _Istream_str & fmt ) { fmt.scanset = scanset; fmt.flags.inex = false; return fmt; } |
---|
78 | _Istream_str excl( const char scanset[], string & s ) { return (_Istream_str)@{ s, {{scanset}, -1, {.flags.inex : true}} }; } |
---|
79 | _Istream_str & excl( const char scanset[], _Istream_str & fmt ) { fmt.scanset = scanset; fmt.flags.inex = true; return fmt; } |
---|
80 | _Istream_str ignore( string & s ) { return (_Istream_str)@{ s, {{0p}, -1, {.flags.ignore : true}} }; } |
---|
81 | _Istream_str & ignore( _Istream_str & fmt ) { fmt.flags.ignore = true; return fmt; } |
---|
82 | } // distribution |
---|
83 | ifstream & ?|?( ifstream & is, _Istream_str f ); |
---|
84 | void ?|?( ifstream & is, _Istream_str t ); |
---|
85 | |
---|
86 | // Concatenation |
---|
87 | void ?+=?(string & s, char other); // append a character |
---|
88 | void ?+=?(string & s, const string & s2); // append-concatenate to first string |
---|
89 | void ?+=?(string & s, const char * other); // append-concatenate to first string |
---|
90 | string ?+?(const string & s, char other); // add a character to a copy of the string |
---|
91 | string ?+?(const string & s, const string & s2); // copy and concatenate both strings |
---|
92 | string ?+?(const char * s1, const char * s2); // concatenate both strings |
---|
93 | string ?+?(const string & s, const char * other); // copy and concatenate with NULL-terminated string |
---|
94 | |
---|
95 | // Repetition |
---|
96 | string ?*?(const string & s, size_t factor); |
---|
97 | string ?*?(char c, size_t size); |
---|
98 | string ?*?(const char *s, size_t size); |
---|
99 | |
---|
100 | // Character access |
---|
101 | char ?[?](const string & s, size_t index); |
---|
102 | string ?[?](string & s, size_t index); // mutable length-1 slice of original |
---|
103 | //char codePointAt(const string & s, size_t index); // to revisit under Unicode |
---|
104 | |
---|
105 | // Comparisons |
---|
106 | bool ?==?(const string & s, const string & other); |
---|
107 | bool ?!=?(const string & s, const string & other); |
---|
108 | bool ?==?(const string & s, const char * other); |
---|
109 | bool ?!=?(const string & s, const char * other); |
---|
110 | |
---|
111 | // Slicing |
---|
112 | string ?()( string & this, size_t start, size_t end ); // TODO const? |
---|
113 | string ?()( string & this, size_t start); |
---|
114 | |
---|
115 | // String search |
---|
116 | bool contains(const string & s, char ch); // single character |
---|
117 | |
---|
118 | int find(const string & s, char search); |
---|
119 | int find(const string & s, const string & search); |
---|
120 | int find(const string & s, const char * search); |
---|
121 | int find(const string & s, const char * search, size_t searchsize); |
---|
122 | |
---|
123 | int findFrom(const string & s, size_t fromPos, char search); |
---|
124 | int findFrom(const string & s, size_t fromPos, const string & search); |
---|
125 | int findFrom(const string & s, size_t fromPos, const char * search); |
---|
126 | int findFrom(const string & s, size_t fromPos, const char * search, size_t searchsize); |
---|
127 | |
---|
128 | bool includes(const string & s, const string & search); |
---|
129 | bool includes(const string & s, const char * search); |
---|
130 | bool includes(const string & s, const char * search, size_t searchsize); |
---|
131 | |
---|
132 | bool startsWith(const string & s, const string & prefix); |
---|
133 | bool startsWith(const string & s, const char * prefix); |
---|
134 | bool startsWith(const string & s, const char * prefix, size_t prefixsize); |
---|
135 | |
---|
136 | bool endsWith(const string & s, const string & suffix); |
---|
137 | bool endsWith(const string & s, const char * suffix); |
---|
138 | bool endsWith(const string & s, const char * suffix, size_t suffixsize); |
---|
139 | |
---|
140 | // Modifiers |
---|
141 | void padStart(string & s, size_t n); |
---|
142 | void padStart(string & s, size_t n, char padding); |
---|
143 | void padEnd(string & s, size_t n); |
---|
144 | void padEnd(string & s, size_t n, char padding); |
---|
145 | |
---|
146 | |
---|
147 | |
---|
148 | struct charclass { |
---|
149 | charclass_res * inner; |
---|
150 | }; |
---|
151 | |
---|
152 | void ?{}( charclass & ) = void; |
---|
153 | void ?{}( charclass &, charclass) = void; |
---|
154 | charclass ?=?( charclass &, charclass) = void; |
---|
155 | |
---|
156 | void ?{}( charclass &, const string & chars); |
---|
157 | void ?{}( charclass &, const char * chars ); |
---|
158 | void ?{}( charclass &, const char * chars, size_t charssize ); |
---|
159 | void ^?{}( charclass & ); |
---|
160 | |
---|
161 | int include(const string & s, const charclass & mask); |
---|
162 | |
---|
163 | int exclude(const string & s, const charclass & mask); |
---|
164 | |
---|
165 | /* |
---|
166 | What to do with? |
---|
167 | StrRet include(string & s, const charclass & mask); |
---|
168 | StrRet exclude(string & s, const charclass & mask); |
---|
169 | */ |
---|