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
|
<html>
<head>
<title>~/src/firstworks/rudiments-0.27/include/rudiments/charstring.h.html</title>
<meta name="Generator" content="Vim/6.2">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
</head>
<body bgcolor="#ffffff" text="#000000">
<pre>
<font color="#0000ff">// Copyright (c) 2003 David Muse</font>
<font color="#0000ff">// See the COPYING file for more information.</font>
<font color="#a520f7">#ifndef RUDIMENTS_CHARSTRING_H</font>
<font color="#a520f7">#define RUDIMENTS_CHARSTRING_H</font>
<font color="#a520f7">#include </font><font color="#ff00ff"><rudiments/private/charstringincludes.h></font>
<font color="#0000ff">// The charstring class provides methods for manipulating strings.</font>
<font color="#298a52"><b>class</b></font> charstring {
<font color="#a52829"><b>public</b></font>:
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>size_t</b></font> length(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string);
<font color="#0000ff">// Returns the length of "string".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> zero(<font color="#298a52"><b>char</b></font> *str, <font color="#298a52"><b>size_t</b></font> size);
<font color="#0000ff">// Sets "size" bytes of "str" to NULL.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *append(<font color="#298a52"><b>char</b></font> *dest, <font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *source);
<font color="#0000ff">// Appends "source" to "dest". Assumes that there</font>
<font color="#0000ff">// is enough room remaining in "dest" to accommodate</font>
<font color="#0000ff">// the new string.</font>
<font color="#0000ff">// Returns a pointer to "dest".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *append(<font color="#298a52"><b>char</b></font> *dest, <font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *source,
<font color="#298a52"><b>size_t</b></font> size);
<font color="#0000ff">// Appends "size" bytes of "source" to "dest". Assumes</font>
<font color="#0000ff">// that there is enough room remaining in "dest" to</font>
<font color="#0000ff">// accommodate the new string.</font>
<font color="#0000ff">// Returns a pointer to "dest".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *copy(<font color="#298a52"><b>char</b></font> *dest, <font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *source);
<font color="#0000ff">// Replaces "dest" with "source". Assumes that there</font>
<font color="#0000ff">// is enough room in "dest" to accommodate "source".</font>
<font color="#0000ff">// Returns a pointer to "dest".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *copy(<font color="#298a52"><b>char</b></font> *dest,
<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *source, <font color="#298a52"><b>size_t</b></font> size);
<font color="#0000ff">// Replaces the first "size" bytes of "dest" with</font>
<font color="#0000ff">// "source". Assumes that "dest" is at least "size"</font>
<font color="#0000ff">// bytes long.</font>
<font color="#0000ff">// Returns a pointer to "dest".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *copy(<font color="#298a52"><b>char</b></font> *dest, <font color="#298a52"><b>size_t</b></font> location,
<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *source);
<font color="#0000ff">// Replaces "dest" with "source", starting "location"</font>
<font color="#0000ff">// bytes into "dest". Assumes that there is enough</font>
<font color="#0000ff">// room in "dest" (after "location" bytes) to</font>
<font color="#0000ff">// accommodate "source".</font>
<font color="#0000ff">// Returns a pointer to "dest".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *copy(<font color="#298a52"><b>char</b></font> *dest, <font color="#298a52"><b>size_t</b></font> location,
<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *source, <font color="#298a52"><b>size_t</b></font> size);
<font color="#0000ff">// Replaces "size" bytes of "dest" with "source",</font>
<font color="#0000ff">// starting "location" bytes into "dest". Assumes that</font>
<font color="#0000ff">// there are "size" bytes in "dest" (after "location"</font>
<font color="#0000ff">// bytes).</font>
<font color="#0000ff">// Returns a pointer to "dest".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>int</b></font> compare(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *str1, <font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *str2);
<font color="#0000ff">// Returns -1,0 or 1 if "str1" is greater than, </font>
<font color="#0000ff">// equal to or less than "str2".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>int</b></font> compare(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *str1, <font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *str2,
<font color="#298a52"><b>size_t</b></font> size);
<font color="#0000ff">// Returns -1,0 or 1 if "size" bytes of "str1" are</font>
<font color="#0000ff">// greater than, equal to or less than "size" bytes of</font>
<font color="#0000ff">// "str2".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>int</b></font> compareIgnoringCase(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *str1,
<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *str2);
<font color="#0000ff">// Returns -1,0 or 1 if "str1" is greater than, </font>
<font color="#0000ff">// equal to or less than "str2", ignoring case.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>int</b></font> compareIgnoringCase(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *str1,
<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *str2,
<font color="#298a52"><b>size_t</b></font> size);
<font color="#0000ff">// Returns -1,0 or 1 if "size" bytes of "str1" are</font>
<font color="#0000ff">// greater than, equal to or less than "size" bytes of</font>
<font color="#0000ff">// "str2", ignoring case.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>bool</b></font> contains(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *haystack,
<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *needle);
<font color="#0000ff">// Returns true if "haystack" contains "needle" or</font>
<font color="#0000ff">// false otherwise.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>bool</b></font> contains(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *haystack,
<font color="#298a52"><b>char</b></font> needle);
<font color="#0000ff">// Returns true if "haystack" contains "needle" or</font>
<font color="#0000ff">// false otherwise.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *findFirst(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *haystack,
<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *needle);
<font color="#0000ff">// Returns a pointer to the first occurrance of "needle"</font>
<font color="#0000ff">// in "haystack" or NULL if not found.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *findFirst(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *haystack,
<font color="#298a52"><b>char</b></font> needle);
<font color="#0000ff">// Returns a pointer to the first occurrance of "needle"</font>
<font color="#0000ff">// in "haystack" or NULL if not found.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *findLast(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *haystack,
<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *needle);
<font color="#0000ff">// Returns a pointer to the last occurrance of "needle"</font>
<font color="#0000ff">// in "haystack" or NULL if not found.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *findLast(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *haystack,
<font color="#298a52"><b>char</b></font> needle);
<font color="#0000ff">// Returns a pointer to the last occurrance of "needle"</font>
<font color="#0000ff">// in "haystack" or NULL if not found.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *duplicate(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *str);
<font color="#0000ff">// Creates a duplicate of "str" and returns a pointer</font>
<font color="#0000ff">// to it. Note that this method allocates a buffer for</font>
<font color="#0000ff">// the duplicate string internally and returns it. The</font>
<font color="#0000ff">// calling program must deallocate this buffer.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> upper(<font color="#298a52"><b>char</b></font> *str);
<font color="#0000ff">// Converts "str" to uppercase.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> lower(<font color="#298a52"><b>char</b></font> *str);
<font color="#0000ff">// Converts "str" to lowercase.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> rightTrim(<font color="#298a52"><b>char</b></font> *str);
<font color="#0000ff">// Rrims all spaces off of the right hand side of "str".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> rightTrim(<font color="#298a52"><b>char</b></font> *str, <font color="#298a52"><b>char</b></font> character);
<font color="#0000ff">// Rrims all "character"'s off of the right hand side</font>
<font color="#0000ff">// of "str".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> leftTrim(<font color="#298a52"><b>char</b></font> *str);
<font color="#0000ff">// Trims all spaces off of the left hand side of "str".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> leftTrim(<font color="#298a52"><b>char</b></font> *str, <font color="#298a52"><b>char</b></font> character);
<font color="#0000ff">// Trims all "character"'s off of the left hand side</font>
<font color="#0000ff">// of "str".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> bothTrim(<font color="#298a52"><b>char</b></font> *str);
<font color="#0000ff">// Trims all spaces off of both sides of "str".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> bothTrim(<font color="#298a52"><b>char</b></font> *str, <font color="#298a52"><b>char</b></font> character);
<font color="#0000ff">// Trims all characters off of both sides of "str".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> strip(<font color="#298a52"><b>char</b></font> *str, <font color="#298a52"><b>char</b></font> character);
<font color="#0000ff">// Strips all instances of "character" from "str".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> strip(<font color="#298a52"><b>char</b></font> *str1, <font color="#298a52"><b>char</b></font> *str2);
<font color="#0000ff">// Strips all instances of "str2" from "str1".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>int</b></font> integerLength(<font color="#298a52"><b>long</b></font> number);
<font color="#0000ff">// Returns the number of characters needed to represent</font>
<font color="#0000ff">// "number" as a string.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>bool</b></font> isInteger(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *val);
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>bool</b></font> isInteger(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *val, <font color="#298a52"><b>int</b></font> size);
<font color="#0000ff">// Returns true if the string "val" is an integer and</font>
<font color="#0000ff">// false if it is not an integer.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>bool</b></font> isNumber(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *val);
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>bool</b></font> isNumber(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *val, <font color="#298a52"><b>int</b></font> size);
<font color="#0000ff">// Returns true the string "val" is a number and false</font>
<font color="#0000ff">// if it is not a number</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *parseNumber(<font color="#298a52"><b>long</b></font> number);
<font color="#0000ff">// Returns a string representing "number". The string</font>
<font color="#0000ff">// is allocated inside the function and must be deleted</font>
<font color="#0000ff">// by the calling program.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *parseNumber(<font color="#298a52"><b>double</b></font> number);
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *parseNumber(<font color="#298a52"><b>double</b></font> number,
<font color="#298a52"><b>unsigned</b></font> <font color="#298a52"><b>short</b></font> scale);
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *parseNumber(<font color="#298a52"><b>double</b></font> number,
<font color="#298a52"><b>unsigned</b></font> <font color="#298a52"><b>short</b></font> precision,
<font color="#298a52"><b>unsigned</b></font> <font color="#298a52"><b>short</b></font> scale);
<font color="#0000ff">// Returns a string representing "number". The string</font>
<font color="#0000ff">// is allocated inside the function and must be deleted</font>
<font color="#0000ff">// by the calling program.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> toLong(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string);
<font color="#0000ff">// Converts "string" to a long integer.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> toLong(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string, <font color="#298a52"><b>char</b></font> **endptr);
<font color="#0000ff">// Converts "string" to a long integer. If non-NULL,</font>
<font color="#0000ff">// endptr will be set to the first character in the</font>
<font color="#0000ff">// string after the number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> toLong(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string, <font color="#298a52"><b>int</b></font> base);
<font color="#0000ff">// Converts "string" to a long integer of base "base".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> toLong(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string,
<font color="#298a52"><b>char</b></font> **endptr, <font color="#298a52"><b>int</b></font> base);
<font color="#0000ff">// Converts "string" to a long integer of base "base".</font>
<font color="#0000ff">// If non-NULL, endptr will be set to the first</font>
<font color="#0000ff">// character in the string after the number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> <font color="#298a52"><b>long</b></font> toLongLong(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string);
<font color="#0000ff">// Converts "string" to a long integer.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> <font color="#298a52"><b>long</b></font> toLongLong(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string,
<font color="#298a52"><b>char</b></font> **endptr);
<font color="#0000ff">// Converts "string" to a long long integer. If</font>
<font color="#0000ff">// non-NULL, endptr will be set to the first character</font>
<font color="#0000ff">// in the string after the number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> <font color="#298a52"><b>long</b></font> toLongLong(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string,
<font color="#298a52"><b>int</b></font> base);
<font color="#0000ff">// Converts "string" to a long long integer of</font>
<font color="#0000ff">// base "base".</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> <font color="#298a52"><b>long</b></font> toLongLong(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string,
<font color="#298a52"><b>char</b></font> **endptr, <font color="#298a52"><b>int</b></font> base);
<font color="#0000ff">// Converts "string" to a long long integer of</font>
<font color="#0000ff">// base "base". If non-NULL, endptr will be set to the</font>
<font color="#0000ff">// first character in the string after the number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>float</b></font> toFloat(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string);
<font color="#0000ff">// Converts "string" to a floating point number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>float</b></font> toFloat(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string, <font color="#298a52"><b>char</b></font> **endptr);
<font color="#0000ff">// Converts "string" to a floating point number. If</font>
<font color="#0000ff">// non-NULL, endptr will be set to the first character</font>
<font color="#0000ff">// in the string after the number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>double</b></font> toDouble(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string);
<font color="#0000ff">// Converts "string" to a double precision</font>
<font color="#0000ff">// floating point number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>double</b></font> toDouble(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string, <font color="#298a52"><b>char</b></font> **endptr);
<font color="#0000ff">// Converts "string" to a double precision floating</font>
<font color="#0000ff">// point number. If non-NULL, endptr will be set to</font>
<font color="#0000ff">// the first character in the string after the number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> <font color="#298a52"><b>double</b></font> toLongDouble(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string);
<font color="#0000ff">// Converts "string" to a long double precision</font>
<font color="#0000ff">// floating point number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>long</b></font> <font color="#298a52"><b>double</b></font> toLongDouble(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *string,
<font color="#298a52"><b>char</b></font> **endptr);
<font color="#0000ff">// Converts "string" to a long double precision floating</font>
<font color="#0000ff">// point number. If non-NULL, endptr will be set to</font>
<font color="#0000ff">// the first character in the string after the number.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>char</b></font> *httpEscape(<font color="#298a52"><b>const</b></font> <font color="#298a52"><b>char</b></font> *input);
<font color="#0000ff">// http escapes "input" and returns it in a buffer</font>
<font color="#0000ff">// allocated inside the function. This buffer must be</font>
<font color="#0000ff">// deleted by the calling program.</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> leftJustify(<font color="#298a52"><b>char</b></font> *str, <font color="#298a52"><b>int</b></font> length);
<font color="#0000ff">// Moves leading spaces to the end of "str" for</font>
<font color="#0000ff">// "length" characters.</font>
<font color="#0000ff">// </font>
<font color="#0000ff">// Example:</font>
<font color="#0000ff">// " hello " -> "hello "</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> rightJustify(<font color="#298a52"><b>char</b></font> *str, <font color="#298a52"><b>int</b></font> length);
<font color="#0000ff">// Moves trailing spaces to the beginning of "str" for</font>
<font color="#0000ff">// "length" characters.</font>
<font color="#0000ff">// </font>
<font color="#0000ff">// Example:</font>
<font color="#0000ff">// " hello " -> " hello"</font>
<font color="#298a52"><b>static</b></font> <font color="#298a52"><b>void</b></font> center(<font color="#298a52"><b>char</b></font> *str, <font color="#298a52"><b>int</b></font> length);
<font color="#0000ff">// Centers the text of "str" for "length" characters.</font>
<font color="#0000ff">// </font>
<font color="#0000ff">// Example:</font>
<font color="#0000ff">// "hello " -> " hello "</font>
<font color="#a520f7"> #include </font><font color="#ff00ff"><rudiments/private/charstring.h></font>
};
<font color="#a520f7">#ifdef ENABLE_RUDIMENTS_INLINES</font>
<font color="#a520f7"> #include </font><font color="#ff00ff"><rudiments/private/charstringinlines.h></font>
<font color="#a520f7">#endif</font>
<font color="#a520f7">#endif</font>
</pre>
</body>
</html>
|