File: cxstring_8h_source.html

package info (click to toggle)
cpl 6.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 18,764 kB
  • sloc: ansic: 111,368; sh: 14,549; makefile: 626
file content (203 lines) | stat: -rw-r--r-- 19,448 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>C Standard Library Extensions: cxstring.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">C Standard Library Extensions
   &#160;<span id="projectnumber">1.1</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.8.0 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="dir_c2959b2ad5731f3b356ab222d87e802c.html">cext</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="headertitle">
<div class="title">cxstring.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* $Id: cxstring.h,v 1.8 2011/02/21 14:15:31 rpalsa Exp $</span>
<a name="l00002"></a>00002 <span class="comment"> *</span>
<a name="l00003"></a>00003 <span class="comment"> * This file is part of the ESO C Extension Library</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2001-2011 European Southern Observatory</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> * (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00014"></a>00014 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="comment">/*</span>
<a name="l00022"></a>00022 <span class="comment"> * $Author: rpalsa $</span>
<a name="l00023"></a>00023 <span class="comment"> * $Date: 2011/02/21 14:15:31 $</span>
<a name="l00024"></a>00024 <span class="comment"> * $Revision: 1.8 $</span>
<a name="l00025"></a>00025 <span class="comment"> * $Name: cpl-6_1_1 $</span>
<a name="l00026"></a>00026 <span class="comment"> */</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef CX_STRING_H_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CX_STRING_H_ 1</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;stdarg.h&gt;</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;string.h&gt;</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;ctype.h&gt;</span>
<a name="l00034"></a>00034 
<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;cxtypes.h&gt;</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;cxmemory.h&gt;</span>
<a name="l00037"></a>00037 <span class="preprocessor">#include &lt;cxmessages.h&gt;</span>
<a name="l00038"></a>00038 <span class="preprocessor">#include &lt;cxutils.h&gt;</span>
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 
<a name="l00041"></a>00041 CX_BEGIN_DECLS
<a name="l00042"></a>00042 
<a name="l00043"></a>00043 <span class="keyword">struct </span>_cx_string_ {
<a name="l00044"></a>00044 
<a name="l00045"></a>00045     <span class="comment">/* &lt;private&gt; */</span>
<a name="l00046"></a>00046 
<a name="l00047"></a>00047     cxchar  *data;
<a name="l00048"></a>00048     cxsize sz;
<a name="l00049"></a>00049 
<a name="l00050"></a>00050 };
<a name="l00051"></a>00051 
<a name="l00052"></a>00052 
<a name="l00060"></a><a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb">00060</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>_cx_string_ <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a>;
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 
<a name="l00063"></a>00063 <span class="comment">/*</span>
<a name="l00064"></a>00064 <span class="comment"> * Create, copy and destroy operations</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#ga2677bfd02e0324dcaf6a16146cc5d613" title="Create a new, initialized string container.">cx_string_new</a>(<span class="keywordtype">void</span>);
<a name="l00068"></a>00068 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#ga173e094b6b10810d3b9b0891012d50a4" title="Create a copy a cx_string.">cx_string_copy</a>(<span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00069"></a>00069 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#gae21504ed4cde96fd5233167f09d90872" title="Create a new string from a standard C string.">cx_string_create</a>(<span class="keyword">const</span> cxchar *);
<a name="l00070"></a>00070 <span class="keywordtype">void</span> <a class="code" href="group__cxstring.html#ga7c9522f40844cecd8aa31a537d594a73" title="Destroy a string.">cx_string_delete</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00071"></a>00071 
<a name="l00072"></a>00072 <span class="comment">/*</span>
<a name="l00073"></a>00073 <span class="comment"> * Non modifying operations</span>
<a name="l00074"></a>00074 <span class="comment"> */</span>
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 cxsize <a class="code" href="group__cxstring.html#gad62f3f0eaf0a991913c826d2fb36c8c2" title="Computes the length of the string.">cx_string_size</a>(<span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00077"></a>00077 cxbool <a class="code" href="group__cxstring.html#gab302e36ebde49a78e387bda399762faa" title="Checks whether a string contains any characters.">cx_string_empty</a>(<span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00078"></a>00078 
<a name="l00079"></a>00079 <span class="comment">/*</span>
<a name="l00080"></a>00080 <span class="comment"> * Data access</span>
<a name="l00081"></a>00081 <span class="comment"> */</span>
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 <span class="keyword">const</span> cxchar *<a class="code" href="group__cxstring.html#ga90d4fbf5e229be5dcbd05a83c4fa547a" title="Get the string&#39;s value.">cx_string_get</a>(<span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00084"></a>00084 
<a name="l00085"></a>00085 <span class="comment">/*</span>
<a name="l00086"></a>00086 <span class="comment"> * Assignment operations</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088 
<a name="l00089"></a>00089 <span class="keywordtype">void</span> <a class="code" href="group__cxstring.html#ga745c3e5f86abb0e9e64c3a4fa785c1de" title="Assign a value to a string.">cx_string_set</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, <span class="keyword">const</span> cxchar *);
<a name="l00090"></a>00090 
<a name="l00091"></a>00091 <span class="comment">/*</span>
<a name="l00092"></a>00092 <span class="comment"> * Modifying operations</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 
<a name="l00095"></a>00095 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#ga8c8b03637f4a99432f40b200bcd9bd0a" title="Converts the string into uppercase.">cx_string_upper</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00096"></a>00096 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#gad99ff4d8cec308e5b7319f969f0330c0" title="Converts the string into lowercase.">cx_string_lower</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00097"></a>00097 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#gad38326b29c82dcdc93bfb3252f3c9f49" title="Remove leading whitespaces from the string.">cx_string_trim</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00098"></a>00098 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#gae7a22caf2e7286730e882170cf4a6fe3" title="Remove trailing whitespaces from the string.">cx_string_rtrim</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00099"></a>00099 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#gad1c1ed2a92a736ed8900101cdfbd3ce7" title="Remove leading and trailing whitespaces from the string.">cx_string_strip</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00100"></a>00100 
<a name="l00101"></a>00101 <span class="comment">/*</span>
<a name="l00102"></a>00102 <span class="comment"> * Inserting and removing elements</span>
<a name="l00103"></a>00103 <span class="comment"> */</span>
<a name="l00104"></a>00104 
<a name="l00105"></a>00105 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#ga5255beabea7b5da62d4d2bf7bf6a27ad" title="Prepend an array of characters to the string.">cx_string_prepend</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, <span class="keyword">const</span> cxchar *);
<a name="l00106"></a>00106 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#ga5488378ca5476e1402fa9ac880c5c2e6" title="Append an array of characters to the string.">cx_string_append</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, <span class="keyword">const</span> cxchar *);
<a name="l00107"></a>00107 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#gaa9916cdc9590244f118ee8d82d88f576" title="Inserts a copy of a string at a given position.">cx_string_insert</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, cxssize, <span class="keyword">const</span> cxchar *);
<a name="l00108"></a>00108 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#gac36b30ef4a5fa1036a333964db2ddbd0" title="Erase a portion of the string.">cx_string_erase</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, cxssize, cxssize);
<a name="l00109"></a>00109 <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *<a class="code" href="group__cxstring.html#ga871347bfc5e8a5beacf9864b250e0fc0" title="Truncate the string.">cx_string_truncate</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, cxsize);
<a name="l00110"></a>00110 
<a name="l00111"></a>00111 <span class="comment">/*</span>
<a name="l00112"></a>00112 <span class="comment"> *  Comparison functions</span>
<a name="l00113"></a>00113 <span class="comment"> */</span>
<a name="l00114"></a>00114 
<a name="l00115"></a>00115 cxbool <a class="code" href="group__cxstring.html#gabfb7b87860630a2170ca42f81fdca313" title="Compare two cx_string for equality.">cx_string_equal</a> (<span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, <span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00116"></a>00116 cxint <a class="code" href="group__cxstring.html#ga369142333463cf53a883641d6188add9" title="Compare two strings.">cx_string_compare</a>(<span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, <span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00117"></a>00117 cxint <a class="code" href="group__cxstring.html#gaf1405a4f49042e53c06380f32875f901" title="Compare two strings ignoring the case of characters.">cx_string_casecmp</a>(<span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, <span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *);
<a name="l00118"></a>00118 cxint <a class="code" href="group__cxstring.html#gaf0c12330806814bce631fdc121c8283b" title="Compare the first n characters of two strings ignoring the case of characters.">cx_string_ncasecmp</a>(<span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, <span class="keyword">const</span> <a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *, cxsize);
<a name="l00119"></a>00119 
<a name="l00120"></a>00120 <span class="comment">/*</span>
<a name="l00121"></a>00121 <span class="comment"> * I/O functions</span>
<a name="l00122"></a>00122 <span class="comment"> */</span>
<a name="l00123"></a>00123 
<a name="l00124"></a>00124 cxint <a class="code" href="group__cxstring.html#ga29362244440619a3d7090259c7549585" title="Writes to a string under format control.">cx_string_sprintf</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *,
<a name="l00125"></a>00125                         <span class="keyword">const</span> cxchar *, ...) CX_GNUC_PRINTF(2, 3);
<a name="l00126"></a>00126 cxint <a class="code" href="group__cxstring.html#ga27c9339137a6f0b90cb93cb0bbd1c476" title="Write to the string from a variable-length argument list under format control.">cx_string_vsprintf</a>(<a class="code" href="group__cxstring.html#ga48dfca37e3a62f7fe98edc3f38c0faeb" title="The cx_string data type.">cx_string</a> *,
<a name="l00127"></a>00127                          const cxchar *, va_list) CX_GNUC_PRINTF(2, 0);
<a name="l00128"></a>00128 
<a name="l00129"></a>00129 <span class="comment">/*</span>
<a name="l00130"></a>00130 <span class="comment"> * Debugging utilities</span>
<a name="l00131"></a>00131 <span class="comment"> */</span>
<a name="l00132"></a>00132 
<a name="l00133"></a>00133 <span class="keywordtype">void</span> <a class="code" href="group__cxstring.html#gac7f190519bb7e5497c088cf8a60f2856" title="Print the value of a cx_string to the standard output.">cx_string_print</a>(const cx_string *);
<a name="l00134"></a>00134 
<a name="l00135"></a>00135 CX_END_DECLS
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 <span class="preprocessor">#endif </span><span class="comment">/* CX_STRING_H */</span>
</pre></div></div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Tue May 22 2012 06:56:06 for C Standard Library Extensions by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>

</body>
</html>