-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy patha00044_source.html
305 lines (303 loc) · 38.5 KB
/
a00044_source.html
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tesseract: /tesseract/include/tesseract/strngs.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">tesseract
 <span id="projectnumber">5.0.0-alpha-619-ge9db</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00044_source.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">strngs.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00044.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**********************************************************************</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * File: strngs.h (Formerly strings.h)</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Description: STRING class definition.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Author: Ray Smith</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (C) Copyright 1991, Hewlett-Packard Ltd.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> ** Licensed under the Apache License, Version 2.0 (the "License");</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> ** you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> ** You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> ** http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> ** Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> ** distributed under the License is distributed on an "AS IS" BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> ** See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ** limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> **********************************************************************/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef STRNGS_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define STRNGS_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <cassert></span> <span class="comment">// for assert</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdint></span> <span class="comment">// for uint32_t</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <cstdio></span> <span class="comment">// for FILE</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <cstring></span> <span class="comment">// for strncpy</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="a00029.html">platform.h</a>"</span> <span class="comment">// for TESS_API</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="a01818.html">tesseract</a> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>TFile;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> } <span class="comment">// namespace tesseract.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// STRING_IS_PROTECTED means that string[index] = X is invalid</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// because you have to go through strings interface to modify it.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// This allows the string to ensure internal integrity and maintain</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// its own string length. Unfortunately this is not possible because</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// STRINGS are used as direct-manipulation data buffers for things</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// like length arrays and many places cast away the const on c_str()</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// to mutate the string. Turning this off means that internally we</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="a00044.html#ae34f333b4c79f6aab173f8f78cc1d64b"> 40</a></span> <span class="comment">// cannot assume we know the strlen.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define STRING_IS_PROTECTED 0</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">class </span><a class="code" href="a02434.html">GenericVector</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="a02542.html"> 45</a></span>  </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">class </span><a class="code" href="a00029.html#a86e51270628c53ce7e2c23b1c2b4490e">TESS_API</a> <a class="code" href="a02542.html">STRING</a> {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="a02542.html">STRING</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="a02542.html">STRING</a>(<span class="keyword">const</span> <a class="code" href="a02542.html">STRING</a>& <span class="keywordtype">string</span>);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="a02542.html">STRING</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">string</span>);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="a02542.html">STRING</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> length);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  ~<a class="code" href="a02542.html">STRING</a>();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Writes to the given file. Returns false in case of error.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">bool</span> <a class="code" href="a01818.html#afe7f068f18d05b9fb1d26dcafd7459c5">Serialize</a>(FILE* fp) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// Reads from the given file. Returns false in case of error.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// If swap is true, assumes a big/little-endian swap is needed.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">bool</span> <a class="code" href="a01818.html#a522554508e3ceb96201f3f3f697df7ae">DeSerialize</a>(<span class="keywordtype">bool</span> swap, FILE* fp);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// Writes to the given file. Returns false in case of error.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">bool</span> <a class="code" href="a01818.html#afe7f068f18d05b9fb1d26dcafd7459c5">Serialize</a>(<a class="code" href="a02538.html">tesseract::TFile</a>* fp) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// Reads from the given file. Returns false in case of error.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// If swap is true, assumes a big/little-endian swap is needed.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">bool</span> <a class="code" href="a01818.html#a522554508e3ceb96201f3f3f697df7ae">DeSerialize</a>(<a class="code" href="a02538.html">tesseract::TFile</a>* fp);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// As DeSerialize, but only seeks past the data - hence a static method.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> SkipDeSerialize(<a class="code" href="a02538.html">tesseract::TFile</a>* fp);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">bool</span> contains(<span class="keywordtype">char</span> c) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="a02542.html#a29621611b58cbde60f8fc53f9a689570"> 68</a></span>  int32_t length() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  int32_t size()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> length();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="a02542.html#ae2d06687c4bac24187890e5a2357b9d1"> 72</a></span>  <span class="comment">// Workaround to avoid g++ -Wsign-compare warnings.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  uint32_t unsigned_size()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> int32_t len = length();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  assert(0 <= len);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">return</span> static_cast<uint32_t>(len);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* c_str() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="a02542.html#a5a977382e8488465cd5d6ec802e7eec9"> 79</a></span>  </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">inline</span> <span class="keywordtype">char</span>* strdup()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  int32_t len = length() + 1;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> strncpy(<span class="keyword">new</span> <span class="keywordtype">char</span>[len], GetCStr(), len);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#if STRING_IS_PROTECTED</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>& operator[](int32_t index) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// len is number of chars in s to insert starting at index in this string</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> insert_range(int32_t index, <span class="keyword">const</span> <span class="keywordtype">char</span>* s, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">void</span> erase_range(int32_t index, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">char</span>& operator[](int32_t index) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> split(<span class="keywordtype">char</span> c, <a class="code" href="a02434.html">GenericVector<STRING></a>* splited);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">void</span> truncate_at(int32_t index);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">bool</span> <a class="code" href="a01784.html#a93c576ef12c5a23d4dd278acc7843495">operator==</a>(<span class="keyword">const</span> <a class="code" href="a02542.html">STRING</a>& <span class="keywordtype">string</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">bool</span> <a class="code" href="a01787.html#ae3bdbd18f4b760c3e4b684240d26da5f">operator!=</a>(<span class="keyword">const</span> <a class="code" href="a02542.html">STRING</a>& <span class="keywordtype">string</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">bool</span> <a class="code" href="a01787.html#ae3bdbd18f4b760c3e4b684240d26da5f">operator!=</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">string</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <a class="code" href="a02542.html">STRING</a>& operator=(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">string</span>);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="a02542.html">STRING</a>& operator=(<span class="keyword">const</span> <a class="code" href="a02542.html">STRING</a>& <span class="keywordtype">string</span>);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="a02542.html">STRING</a> <a class="code" href="a00392.html#afb03632aa6602c5193bf4af7964e6751">operator+</a>(<span class="keyword">const</span> <a class="code" href="a02542.html">STRING</a>& <span class="keywordtype">string</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="a02542.html">STRING</a> <a class="code" href="a00392.html#afb03632aa6602c5193bf4af7964e6751">operator+</a>(<span class="keywordtype">char</span> ch) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="a02542.html">STRING</a>& <a class="code" href="a00392.html#a7bdc2726e11ac29db02c5152d33ed9bd">operator+=</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">string</span>);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="a02542.html">STRING</a>& <a class="code" href="a00392.html#a7bdc2726e11ac29db02c5152d33ed9bd">operator+=</a>(<span class="keyword">const</span> <a class="code" href="a02542.html">STRING</a>& <span class="keywordtype">string</span>);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="a02542.html">STRING</a>& <a class="code" href="a00392.html#a7bdc2726e11ac29db02c5152d33ed9bd">operator+=</a>(<span class="keywordtype">char</span> ch);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// Assignment for strings which are not null-terminated.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> assign(<span class="keyword">const</span> <span class="keywordtype">char</span>* cstr, <span class="keywordtype">int</span> len);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="comment">// Appends the given string and int (as a %d) to this.</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="comment">// += cannot be used for ints as there as a char += operator that would</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">// be ambiguous, and ints usually need a string before or between them</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">// anyway.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">void</span> add_str_int(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, <span class="keywordtype">int</span> number);</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="comment">// Appends the given string and double (as a %.8g) to this.</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">void</span> add_str_double(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, <span class="keywordtype">double</span> number);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="a02542.html#a94853b2b0f8d0fdac8333820fc335d09"> 121</a></span>  <span class="comment">// ensure capacity but keep pointer encapsulated</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> ensure(int32_t min_capacity) {</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  ensure_cstr(min_capacity);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  }</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">typedef</span> <span class="keyword">struct </span>STRING_HEADER {</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="comment">// How much space was allocated in the string buffer for char data.</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">int</span> capacity_;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="comment">// used_ is how much of the capacity is currently being used,</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="comment">// including a '\0' terminator.</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="comment">//</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="comment">// If used_ is 0 then string is nullptr (not even the '\0')</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="comment">// else if used_ > 0 then it is strlen() + 1 (because it includes '\0')</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="comment">// else strlen is >= 0 (not nullptr) but needs to be computed.</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="comment">// this condition is set when encapsulation is violated because</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="comment">// an API returned a mutable string.</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="comment">//</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="comment">// capacity_ - used_ = excess capacity that the string can grow</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="comment">// without reallocating</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">mutable</span> <span class="keywordtype">int</span> used_;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  } STRING_HEADER;</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="comment">// To preserve the behavior of the old serialization, we only have space</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="comment">// for one pointer in this structure. So we are embedding a data structure</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="comment">// at the start of the storage that will hold additional state variables,</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">// then storing the actual string contents immediately after.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  STRING_HEADER* data_;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">// returns the header part of the storage</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keyword">inline</span> STRING_HEADER* GetHeader() {</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">return</span> data_;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  }</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keyword">inline</span> <span class="keyword">const</span> STRING_HEADER* GetHeader()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordflow">return</span> data_;</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  }</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  </div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="comment">// returns the string data part of storage</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keyword">inline</span> <span class="keywordtype">char</span>* GetCStr() {</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordflow">return</span> (reinterpret_cast<char*>(data_)) + <span class="keyword">sizeof</span>(STRING_HEADER);</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  }</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  </div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetCStr()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordflow">return</span> (reinterpret_cast<const char*>(data_)) + <span class="keyword">sizeof</span>(STRING_HEADER);</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  }</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">inline</span> <span class="keywordtype">bool</span> InvariantOk()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="preprocessor">#if STRING_IS_PROTECTED</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordflow">return</span> (GetHeader()->used_ == 0)</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  ? (c_str() == <span class="keyword">nullptr</span>)</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  : (GetHeader()->used_ == (strlen(c_str()) + 1));</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  }</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="comment">// Ensure string has requested capacity as optimization</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="comment">// to avoid unnecessary reallocations.</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="comment">// The return value is a cstr buffer with at least requested capacity</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">char</span>* ensure_cstr(int32_t min_capacity);</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">void</span> FixHeader() <span class="keyword">const</span>; <span class="comment">// make used_ non-negative, even if const</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">char</span>* AllocData(<span class="keywordtype">int</span> used, <span class="keywordtype">int</span> capacity);</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keywordtype">void</span> DiscardData();</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> };</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aa00392_html_a7bdc2726e11ac29db02c5152d33ed9bd"><div class="ttname"><a href="a00392.html#a7bdc2726e11ac29db02c5152d33ed9bd">operator+=</a></div><div class="ttdeci">ICOORD & operator+=(ICOORD &op1, const ICOORD &op2)</div><div class="ttdef"><b>Definition:</b> <a href="a00392_source.html#l00376">points.h:376</a></div></div>
<div class="ttc" id="aa00029_html"><div class="ttname"><a href="a00029.html">platform.h</a></div></div>
<div class="ttc" id="aa02542_html"><div class="ttname"><a href="a02542.html">STRING</a></div><div class="ttdef"><b>Definition:</b> <a href="a00044_source.html#l00045">strngs.h:45</a></div></div>
<div class="ttc" id="aa02538_html"><div class="ttname"><a href="a02538.html">tesseract::TFile</a></div><div class="ttdef"><b>Definition:</b> <a href="a00041_source.html#l00075">serialis.h:75</a></div></div>
<div class="ttc" id="aa01818_html"><div class="ttname"><a href="a01818.html">tesseract</a></div><div class="ttdef"><b>Definition:</b> <a href="a00005_source.html#l00065">baseapi.h:65</a></div></div>
<div class="ttc" id="aa02434_html"><div class="ttname"><a href="a02434.html">GenericVector</a></div><div class="ttdef"><b>Definition:</b> <a href="a00005_source.html#l00040">baseapi.h:40</a></div></div>
<div class="ttc" id="aa00392_html_afb03632aa6602c5193bf4af7964e6751"><div class="ttname"><a href="a00392.html#afb03632aa6602c5193bf4af7964e6751">operator+</a></div><div class="ttdeci">ICOORD operator+(const ICOORD &op1, const ICOORD &op2)</div><div class="ttdef"><b>Definition:</b> <a href="a00392_source.html#l00359">points.h:359</a></div></div>
<div class="ttc" id="aa00029_html_a86e51270628c53ce7e2c23b1c2b4490e"><div class="ttname"><a href="a00029.html#a86e51270628c53ce7e2c23b1c2b4490e">TESS_API</a></div><div class="ttdeci">#define TESS_API</div><div class="ttdef"><b>Definition:</b> <a href="a00029_source.html#l00054">platform.h:54</a></div></div>
<div class="ttc" id="aa01784_html_a93c576ef12c5a23d4dd278acc7843495"><div class="ttname"><a href="a01784.html#a93c576ef12c5a23d4dd278acc7843495">operator==</a></div><div class="ttdeci">bool operator==(const UnicodeText &lhs, const UnicodeText &rhs)</div><div class="ttdef"><b>Definition:</b> <a href="a01784_source.html#l00375">unicodetext.cc:375</a></div></div>
<div class="ttc" id="aa01787_html_ae3bdbd18f4b760c3e4b684240d26da5f"><div class="ttname"><a href="a01787.html#ae3bdbd18f4b760c3e4b684240d26da5f">operator!=</a></div><div class="ttdeci">bool operator!=(const UnicodeText &lhs, const UnicodeText &rhs)</div><div class="ttdef"><b>Definition:</b> <a href="a01787_source.html#l00380">unicodetext.h:380</a></div></div>
<div class="ttc" id="aa01818_html_a522554508e3ceb96201f3f3f697df7ae"><div class="ttname"><a href="a01818.html#a522554508e3ceb96201f3f3f697df7ae">tesseract::DeSerialize</a></div><div class="ttdeci">bool DeSerialize(FILE *fp, char *data, size_t n=1)</div><div class="ttdef"><b>Definition:</b> <a href="a00566_source.html#l00041">serialis.cpp:41</a></div></div>
<div class="ttc" id="aa01818_html_afe7f068f18d05b9fb1d26dcafd7459c5"><div class="ttname"><a href="a01818.html#afe7f068f18d05b9fb1d26dcafd7459c5">tesseract::Serialize</a></div><div class="ttdeci">bool Serialize(FILE *fp, const char *data, size_t n=1)</div><div class="ttdef"><b>Definition:</b> <a href="a00566_source.html#l00073">serialis.cpp:73</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_00200a555532e7ec3afbcddd6091e65a.html">tesseract</a></li><li class="navelem"><a class="el" href="a00044.html">strngs.h</a></li>
<li class="footer">Generated on Thu Jan 30 2020 14:22:19 for tesseract by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li>
</ul>
</div>
</body>
</html>