]>
Commit | Line | Data |
---|---|---|
2aa62f2b | 1 | /** @file\r |
2 | The header <stdlib.h> declares five types and several functions of general\r | |
3 | utility, and defines several macros.\r | |
4 | \r | |
53e1e5c6 | 5 | Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r |
2aa62f2b | 6 | This program and the accompanying materials are licensed and made available under\r |
7 | the terms and conditions of the BSD License that accompanies this distribution.\r | |
8 | The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php.\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | #ifndef _STDLIB_H\r | |
16 | #define _STDLIB_H\r | |
17 | #include <sys/EfiCdefs.h>\r | |
18 | \r | |
19 | #ifdef _EFI_SIZE_T_\r | |
20 | typedef _EFI_SIZE_T_ size_t;\r | |
21 | #undef _EFI_SIZE_T_\r | |
22 | #undef _BSD_SIZE_T_\r | |
23 | #endif\r | |
24 | \r | |
25 | #ifndef __cplusplus\r | |
26 | #ifdef _EFI_WCHAR_T\r | |
27 | typedef _EFI_WCHAR_T wchar_t;\r | |
28 | #undef _EFI_WCHAR_T\r | |
29 | #undef _BSD_WCHAR_T_\r | |
30 | #endif\r | |
31 | #endif\r | |
32 | \r | |
33 | /// A structure type that is the type of the value returned by the div function.\r | |
34 | typedef struct {\r | |
35 | int quot; /* quotient */\r | |
36 | int rem; /* remainder */\r | |
37 | } div_t;\r | |
38 | \r | |
39 | /// A structure type that is the type of the value returned by the ldiv function.\r | |
40 | typedef struct {\r | |
41 | long quot;\r | |
42 | long rem;\r | |
43 | } ldiv_t;\r | |
44 | \r | |
45 | /// A structure type that is the type of the value returned by the lldiv function.\r | |
46 | typedef struct {\r | |
47 | long long quot;\r | |
48 | long long rem;\r | |
49 | } lldiv_t;\r | |
50 | \r | |
51 | /** Expand to integer constant expressions that can be used as the argument to\r | |
52 | the exit function to return unsuccessful or successful termination status,\r | |
53 | respectively, to the host environment.\r | |
54 | **/\r | |
55 | #define EXIT_FAILURE 1\r | |
56 | #define EXIT_SUCCESS 0\r | |
57 | \r | |
58 | /** Expands to an integer constant expression that is the maximum value\r | |
59 | returned by the rand function.\r | |
60 | \r | |
61 | The value of the RAND_MAX macro shall be at least 32767.\r | |
62 | **/\r | |
63 | #define RAND_MAX 0x7fffffff\r | |
64 | \r | |
65 | /** Expands to a positive integer expression with type size_t that is the\r | |
66 | maximum number of bytes in a multibyte character for the extended character\r | |
67 | set specified by the current locale (category LC_CTYPE), which is never\r | |
68 | greater than MB_LEN_MAX.\r | |
69 | **/\r | |
70 | #define MB_CUR_MAX 2\r | |
71 | \r | |
72 | /** Maximum number of functions that can be registered by atexit.\r | |
73 | \r | |
74 | The C standard states that the implementation shall support the\r | |
75 | registration of at least 32 functions.\r | |
76 | **/\r | |
77 | #define ATEXIT_MAX 32\r | |
78 | \r | |
79 | __BEGIN_DECLS\r | |
80 | \r | |
81 | /* ################ Communication with the environment ################## */\r | |
82 | \r | |
83 | /** The abort function causes abnormal program termination to occur, unless\r | |
84 | the signal SIGABRT is being caught and the signal handler does not return.\r | |
85 | \r | |
86 | Open streams with unwritten buffered data are not flushed, open\r | |
87 | streams are not closed, and temporary files are not removed by abort.\r | |
88 | \r | |
89 | Unsuccessful termination is returned to the host environment by means of\r | |
90 | the function call, raise(SIGABRT).\r | |
91 | \r | |
92 | @sa signal.h\r | |
93 | **/\r | |
d7ce7006 | 94 | void abort(void) __noreturn;\r |
2aa62f2b | 95 | \r |
96 | /** The atexit function registers the function pointed to by func, to be\r | |
97 | called without arguments at normal program termination.\r | |
98 | \r | |
99 | The implementation supports the registration of up to 32 functions.\r | |
100 | \r | |
101 | @return The atexit function returns zero if the registration succeeds,\r | |
102 | nonzero if it fails.\r | |
103 | **/\r | |
104 | int atexit(void (*)(void));\r | |
105 | \r | |
106 | /** The exit function causes normal program termination to occur. If more than\r | |
107 | one call to the exit function is executed by a program,\r | |
108 | the behavior is undefined.\r | |
109 | \r | |
110 | First, all functions registered by the atexit function are called, in the\r | |
111 | reverse order of their registration, except that a function is called\r | |
112 | after any previously registered functions that had already been called at\r | |
113 | the time it was registered. If, during the call to any such function, a\r | |
114 | call to the longjmp function is made that would terminate the call to the\r | |
115 | registered function, the behavior is undefined.\r | |
116 | \r | |
117 | Next, all open streams with unwritten buffered data are flushed, all open\r | |
118 | streams are closed, and all files created by the tmpfile function\r | |
119 | are removed.\r | |
120 | \r | |
121 | Finally, control is returned to the host environment. If the value of\r | |
122 | status is zero, or EXIT_SUCCESS, status is returned unchanged. If the value\r | |
123 | of status is EXIT_FAILURE, EAPPLICATION is returned.\r | |
124 | Otherwise, status is returned unchanged.\r | |
d7ce7006 | 125 | \r |
126 | While this function does not return, it can NOT be marked as "__noreturn"\r | |
127 | without causing a warning to be emitted because the compilers can not\r | |
128 | determine that the function truly does not return.\r | |
2aa62f2b | 129 | **/\r |
130 | void exit(int status) __noreturn;\r | |
131 | \r | |
132 | /** The _Exit function causes normal program termination to occur and control\r | |
133 | to be returned to the host environment.\r | |
134 | \r | |
135 | No functions registered by the atexit function or signal handlers\r | |
136 | registered by the signal function are called. Open streams with unwritten\r | |
137 | buffered data are not flushed, open streams are not closed, and temporary\r | |
138 | files are not removed by abort.\r | |
139 | \r | |
53e1e5c6 | 140 | While this function does not return, it can NOT be marked as "__noreturn"\r |
141 | without causing a warning to be emitted because the compilers can not\r | |
142 | determine that the function truly does not return.\r | |
143 | \r | |
2aa62f2b | 144 | The status returned to the host environment is determined in the same way\r |
145 | as for the exit function.\r | |
146 | **/\r | |
d7ce7006 | 147 | void _Exit(int status) __noreturn;\r |
2aa62f2b | 148 | \r |
149 | /** The getenv function searches an environment list, provided by the host\r | |
150 | environment, for a string that matches the string pointed to by name. The\r | |
151 | set of environment names and the method for altering the environment list\r | |
152 | are determined by the underlying UEFI Shell implementation.\r | |
153 | \r | |
154 | @return The getenv function returns a pointer to a string associated with\r | |
155 | the matched list member. The string pointed to shall not be\r | |
156 | modified by the program, but may be overwritten by a subsequent\r | |
157 | call to the getenv function. If the specified name cannot be\r | |
158 | found, a null pointer is returned.\r | |
159 | **/\r | |
160 | char *getenv(const char *name);\r | |
161 | \r | |
53e1e5c6 | 162 | /**\r |
163 | Add or update a variable in the environment list\r | |
164 | \r | |
165 | @param name Address of a zero terminated name string\r | |
166 | @param value Address of a zero terminated value string\r | |
167 | @param rewrite TRUE allows overwriting existing values\r | |
168 | \r | |
169 | @retval Returns 0 upon success\r | |
170 | @retval Returns -1 upon failure, sets errno with more information\r | |
171 | \r | |
172 | **/\r | |
173 | int\r | |
174 | setenv (\r | |
175 | register const char * name,\r | |
176 | register const char * value,\r | |
177 | int rewrite\r | |
178 | );\r | |
179 | \r | |
2aa62f2b | 180 | /** If string is a null pointer, the system function determines whether the\r |
181 | host environment has a command processor. If string is not a null pointer,\r | |
182 | the system function passes the string pointed to by string to that command\r | |
183 | processor to be executed in a manner which the implementation shall\r | |
184 | document; this might then cause the program calling system to behave in a\r | |
185 | non-conforming manner or to terminate.\r | |
186 | \r | |
187 | @return If the argument is a null pointer, the system function returns\r | |
188 | nonzero only if a command processor is available. If the argument\r | |
189 | is not a null pointer, and the system function does return, it\r | |
190 | returns an implementation-defined value.\r | |
191 | **/\r | |
192 | int system(const char *string);\r | |
193 | \r | |
194 | \r | |
195 | /* ################ Integer arithmetic functions ######################## */\r | |
196 | \r | |
197 | /** Computes the absolute value of an integer j.\r | |
198 | \r | |
199 | @return The absolute value of j.\r | |
200 | **/\r | |
201 | int abs(int j);\r | |
202 | \r | |
203 | /** Computes the absolute value of an integer j.\r | |
204 | \r | |
205 | @return The absolute value of j.\r | |
206 | **/\r | |
207 | long labs(long j);\r | |
208 | \r | |
209 | /** Computes the absolute value of an integer j.\r | |
210 | \r | |
211 | @return The absolute value of j.\r | |
212 | **/\r | |
213 | long long\r | |
214 | llabs(long long j);\r | |
215 | \r | |
216 | /** Computes numer / denom and numer % denom in a single operation.\r | |
217 | \r | |
218 | @return Returns a structure of type div_t, comprising both the\r | |
219 | quotient and the remainder.\r | |
220 | **/\r | |
221 | div_t div(int numer, int denom);\r | |
222 | \r | |
223 | /** Computes numer / denom and numer % denom in a single operation.\r | |
224 | \r | |
225 | @return Returns a structure of type ldiv_t, comprising both the\r | |
226 | quotient and the remainder.\r | |
227 | **/\r | |
228 | ldiv_t ldiv(long numer, long denom);\r | |
229 | \r | |
230 | /** Computes numer / denom and numer % denom in a single operation.\r | |
231 | \r | |
232 | @return Returns a structure of type lldiv_t, comprising both the\r | |
233 | quotient and the remainder.\r | |
234 | **/\r | |
235 | lldiv_t lldiv(long long numer, long long denom);\r | |
236 | \r | |
237 | /* ############ Integer Numeric conversion functions #################### */\r | |
238 | \r | |
239 | /** The atoi function converts the initial portion of the string pointed to by\r | |
240 | nptr to int representation. Except for the behavior on error, it is\r | |
241 | equivalent to:\r | |
242 | - atoi: (int)strtol(nptr, (char **)NULL, 10)\r | |
243 | \r | |
244 | @return The atoi function returns the converted value.\r | |
245 | **/\r | |
246 | int atoi(const char *nptr);\r | |
247 | \r | |
248 | /** The atol function converts the initial portion of the string pointed to by\r | |
249 | nptr to long int representation. Except for the behavior on error, it is\r | |
250 | equivalent to:\r | |
251 | - atol: strtol(nptr, (char **)NULL, 10)\r | |
252 | \r | |
253 | @return The atol function returns the converted value.\r | |
254 | **/\r | |
255 | long atol(const char *nptr);\r | |
256 | \r | |
257 | /** The atoll function converts the initial portion of the string pointed to by\r | |
258 | nptr to long long int representation. Except for the behavior on error, it\r | |
259 | is equivalent to:\r | |
260 | - atoll: strtoll(nptr, (char **)NULL, 10)\r | |
261 | \r | |
262 | @return The atoll function returns the converted value.\r | |
263 | **/\r | |
264 | long long\r | |
265 | atoll(const char *nptr);\r | |
266 | \r | |
267 | /** The strtol, strtoll, strtoul, and strtoull functions convert the initial\r | |
268 | portion of the string pointed to by nptr to long int, long long int,\r | |
269 | unsigned long int, and unsigned long long int representation, respectively.\r | |
270 | First, they decompose the input string into three parts: an initial,\r | |
271 | possibly empty, sequence of white-space characters (as specified by the\r | |
272 | isspace function), a subject sequence resembling an integer represented in\r | |
273 | some radix determined by the value of base, and a final string of one or\r | |
274 | more unrecognized characters, including the terminating null character of\r | |
275 | the input string. Then, they attempt to convert the subject sequence to an\r | |
276 | integer, and return the result.\r | |
277 | \r | |
278 | If the value of base is zero, the expected form of the subject sequence is\r | |
279 | that of an integer constant as described in 6.4.4.1, optionally preceded\r | |
280 | by a plus or minus sign, but not including an integer suffix. If the value\r | |
281 | of base is between 2 and 36 (inclusive), the expected form of the subject\r | |
282 | sequence is a sequence of letters and digits representing an integer with\r | |
283 | the radix specified by base, optionally preceded by a plus or minus sign,\r | |
284 | but not including an integer suffix. The letters from a (or A) through z\r | |
285 | (or Z) are ascribed the values 10 through 35; only letters and digits whose\r | |
286 | ascribed values are less than that of base are permitted. If the value of\r | |
287 | base is 16, the characters 0x or 0X may optionally precede the sequence of\r | |
288 | letters and digits, following the sign if present.\r | |
289 | \r | |
290 | The subject sequence is defined as the longest initial subsequence of the\r | |
291 | input string, starting with the first non-white-space character, that is of\r | |
292 | the expected form. The subject sequence contains no characters if the input\r | |
293 | string is empty or consists entirely of white space, or if the first\r | |
294 | non-white-space character is other than a sign or a permissible letter or digit.\r | |
295 | \r | |
296 | If the subject sequence has the expected form and the value of base is\r | |
297 | zero, the sequence of characters starting with the first digit is\r | |
298 | interpreted as an integer constant. If the subject sequence has the\r | |
299 | expected form and the value of base is between 2 and 36, it is used as the\r | |
300 | base for conversion, ascribing to each letter its value as given above. If\r | |
301 | the subject sequence begins with a minus sign, the value resulting from the\r | |
302 | conversion is negated (in the return type). A pointer to the final string\r | |
303 | is stored in the object pointed to by endptr, provided that endptr is\r | |
304 | not a null pointer.\r | |
305 | \r | |
306 | In other than the "C" locale, additional locale-specific subject sequence\r | |
307 | forms may be accepted.\r | |
308 | \r | |
309 | If the subject sequence is empty or does not have the expected form, no\r | |
310 | conversion is performed; the value of nptr is stored in the object pointed\r | |
311 | to by endptr, provided that endptr is not a null pointer.\r | |
312 | \r | |
313 | @return The strtol, strtoll, strtoul, and strtoull functions return the\r | |
314 | converted value, if any. If no conversion could be performed, zero\r | |
315 | is returned. If the correct value is outside the range of\r | |
316 | representable values, LONG_MIN, LONG_MAX, LLONG_MIN, LLONG_MAX,\r | |
317 | ULONG_MAX, or ULLONG_MAX is returned (according to the return type\r | |
318 | and sign of the value, if any), and the value of the macro ERANGE\r | |
319 | is stored in errno.\r | |
320 | **/\r | |
321 | long strtol(const char * __restrict nptr, char ** __restrict endptr, int base);\r | |
322 | \r | |
323 | /** The strtoul function converts the initial portion of the string pointed to\r | |
324 | by nptr to unsigned long int representation.\r | |
325 | \r | |
326 | See the description for strtol for more information.\r | |
327 | \r | |
328 | @return The strtoul function returns the converted value, if any. If no\r | |
329 | conversion could be performed, zero is returned. If the correct\r | |
330 | value is outside the range of representable values, ULONG_MAX is\r | |
331 | returned and the value of the macro ERANGE is stored in errno.\r | |
332 | **/\r | |
333 | unsigned long\r | |
334 | strtoul(const char * __restrict nptr, char ** __restrict endptr, int base);\r | |
335 | \r | |
336 | /** The strtoll function converts the initial portion of the string pointed to\r | |
337 | by nptr to long long int representation.\r | |
338 | \r | |
339 | See the description for strtol for more information.\r | |
340 | \r | |
341 | @return The strtoll function returns the converted value, if any. If no\r | |
342 | conversion could be performed, zero is returned. If the correct\r | |
343 | value is outside the range of representable values, LLONG_MIN or\r | |
344 | LLONG_MAX is returned (according to the sign of the value, if any),\r | |
345 | and the value of the macro ERANGE is stored in errno.\r | |
346 | **/\r | |
347 | long long\r | |
348 | strtoll(const char * __restrict nptr, char ** __restrict endptr, int base);\r | |
349 | \r | |
350 | /** The strtoull function converts the initial portion of the string pointed to\r | |
351 | by nptr to unsigned long long int representation.\r | |
352 | \r | |
353 | See the description for strtol for more information.\r | |
354 | \r | |
355 | @return The strtoull function returns the converted value, if any. If no\r | |
356 | conversion could be performed, zero is returned. If the correct\r | |
357 | value is outside the range of representable values, ULLONG_MAX is\r | |
358 | returned and the value of the macro ERANGE is stored in errno.\r | |
359 | **/\r | |
360 | unsigned long long\r | |
361 | strtoull(const char * __restrict nptr, char ** __restrict endptr, int base);\r | |
362 | \r | |
363 | /* ######### Floating-point Numeric conversion functions ################ */\r | |
364 | \r | |
365 | /**\r | |
366 | \r | |
367 | @return\r | |
368 | **/\r | |
369 | double atof(const char *);\r | |
370 | \r | |
371 | /**\r | |
372 | \r | |
373 | @return\r | |
374 | **/\r | |
375 | double strtod(const char * __restrict nptr, char ** __restrict endptr);\r | |
376 | \r | |
377 | /**\r | |
378 | \r | |
379 | @return\r | |
380 | **/\r | |
381 | float strtof(const char * __restrict nptr, char ** __restrict endptr);\r | |
382 | \r | |
383 | /**\r | |
384 | \r | |
385 | @return\r | |
386 | **/\r | |
387 | long double\r | |
388 | strtold(const char * __restrict nptr, char ** __restrict endptr);\r | |
389 | \r | |
390 | /* ################ Pseudo-random sequence generation functions ######### */\r | |
391 | \r | |
392 | /** The rand function computes a sequence of pseudo-random integers in the\r | |
393 | range 0 to RAND_MAX.\r | |
394 | \r | |
395 | @return The rand function returns a pseudo-random integer.\r | |
396 | **/\r | |
397 | int rand(void);\r | |
398 | \r | |
399 | /** The srand function uses the argument as a seed for a new sequence of\r | |
400 | pseudo-random numbers to be returned by subsequent calls to rand.\r | |
401 | \r | |
402 | If srand is then called with the same seed value, the sequence of\r | |
403 | pseudo-random numbers shall be repeated. If rand is called before any calls\r | |
404 | to srand have been made, the same sequence shall be generated as when srand\r | |
405 | is first called with a seed value of 1.\r | |
406 | **/\r | |
407 | void srand(unsigned seed);\r | |
408 | \r | |
409 | /* ################ Memory management functions ######################### */\r | |
410 | \r | |
411 | /** The calloc function allocates space for an array of Num objects, each of\r | |
412 | whose size is Size. The space is initialized to all bits zero.\r | |
413 | \r | |
414 | @return NULL is returned if the space could not be allocated and errno\r | |
415 | contains the cause. Otherwise, a pointer to an 8-byte aligned\r | |
416 | region of the requested size is returned.\r | |
417 | **/\r | |
418 | void *calloc(size_t Num, size_t Size);\r | |
419 | \r | |
420 | /** The free function causes the space pointed to by Ptr to be deallocated,\r | |
421 | that is, made available for further allocation.\r | |
422 | \r | |
423 | If Ptr is a null pointer, no action occurs. Otherwise, if the argument\r | |
424 | does not match a pointer earlier returned by the calloc, malloc, or realloc\r | |
425 | function, or if the space has been deallocated by a call to free or\r | |
426 | realloc, the behavior is undefined.\r | |
427 | \r | |
428 | @param Ptr Pointer to a previously allocated region of memory to be freed.\r | |
429 | \r | |
430 | **/\r | |
431 | void free(void *);\r | |
432 | \r | |
433 | /** The malloc function allocates space for an object whose size is specified\r | |
434 | by size and whose value is indeterminate.\r | |
435 | \r | |
436 | This implementation uses the UEFI memory allocation boot services to get a\r | |
437 | region of memory that is 8-byte aligned and of the specified size. The\r | |
438 | region is allocated with type EfiLoaderData.\r | |
439 | \r | |
440 | @param size Size, in bytes, of the region to allocate.\r | |
441 | \r | |
442 | @return NULL is returned if the space could not be allocated and errno\r | |
443 | contains the cause. Otherwise, a pointer to an 8-byte aligned\r | |
444 | region of the requested size is returned.<BR>\r | |
445 | If NULL is returned, errno may contain:\r | |
446 | - EINVAL: Requested Size is zero.\r | |
447 | - ENOMEM: Memory could not be allocated.\r | |
448 | **/\r | |
449 | void *malloc(size_t);\r | |
450 | \r | |
451 | /** The realloc function changes the size of the object pointed to by Ptr to\r | |
452 | the size specified by NewSize.\r | |
453 | \r | |
454 | The contents of the object are unchanged up to the lesser of the new and\r | |
455 | old sizes. If the new size is larger, the value of the newly allocated\r | |
456 | portion of the object is indeterminate.\r | |
457 | \r | |
458 | If Ptr is a null pointer, the realloc function behaves like the malloc\r | |
459 | function for the specified size.\r | |
460 | \r | |
461 | If Ptr does not match a pointer earlier returned by the calloc, malloc, or\r | |
462 | realloc function, or if the space has been deallocated by a call to the free\r | |
463 | or realloc function, the behavior is undefined.\r | |
464 | \r | |
465 | If the space cannot be allocated, the object pointed to by Ptr is unchanged.\r | |
466 | \r | |
467 | If NewSize is zero and Ptr is not a null pointer, the object it points to\r | |
468 | is freed.\r | |
469 | \r | |
470 | This implementation uses the UEFI memory allocation boot services to get a\r | |
471 | region of memory that is 8-byte aligned and of the specified size. The\r | |
472 | region is allocated with type EfiLoaderData.\r | |
473 | \r | |
474 | @param Ptr Pointer to a previously allocated region of memory to be resized.\r | |
475 | @param NewSize Size, in bytes, of the new object to allocate space for.\r | |
476 | \r | |
477 | @return NULL is returned if the space could not be allocated and errno\r | |
478 | contains the cause. Otherwise, a pointer to an 8-byte aligned\r | |
479 | region of the requested size is returned. If NewSize is zero,\r | |
480 | NULL is returned and errno will be unchanged.\r | |
481 | **/\r | |
482 | void *realloc(void *Ptr, size_t NewSize);\r | |
483 | \r | |
484 | /* ################ Searching and Sorting utilities ##################### */\r | |
485 | \r | |
486 | /** The bsearch function searches an array of nmemb objects, the initial\r | |
487 | element of which is pointed to by base, for an element that matches the\r | |
488 | object pointed to by key. The size of each element of the array is\r | |
489 | specified by size.\r | |
490 | \r | |
491 | The comparison function pointed to by compar is called with two arguments\r | |
492 | that point to the key object and to an array element, in that order. The\r | |
493 | function returns an integer less than, equal to, or greater than zero if\r | |
494 | the key object is considered, respectively, to be less than, to match, or\r | |
495 | to be greater than the array element. The array consists of: all the\r | |
496 | elements that compare less than, all the elements that compare equal to,\r | |
497 | and all the elements that compare greater than the key object,\r | |
498 | in that order.\r | |
499 | \r | |
500 | @return The bsearch function returns a pointer to a matching element of the\r | |
501 | array, or a null pointer if no match is found. If two elements\r | |
502 | compare as equal, which element is matched is unspecified.\r | |
503 | **/\r | |
504 | void *\r | |
505 | bsearch( const void *key, const void *base0,\r | |
506 | size_t nmemb, size_t size,\r | |
507 | int (*compar)(const void *, const void *)\r | |
508 | );\r | |
509 | \r | |
510 | /** The qsort function sorts an array of nmemb objects, the initial element of\r | |
511 | which is pointed to by base. The size of each object is specified by size.\r | |
512 | \r | |
513 | The contents of the array are sorted into ascending order according to a\r | |
514 | comparison function pointed to by compar, which is called with two\r | |
515 | arguments that point to the objects being compared. The function shall\r | |
516 | return an integer less than, equal to, or greater than zero if the first\r | |
517 | argument is considered to be respectively less than, equal to, or greater\r | |
518 | than the second.\r | |
519 | \r | |
520 | If two elements compare as equal, their order in the resulting sorted array\r | |
521 | is unspecified.\r | |
522 | **/\r | |
523 | void qsort( void *base, size_t nmemb, size_t size,\r | |
524 | int (*compar)(const void *, const void *));\r | |
525 | \r | |
526 | /* ################ Multibyte/wide character conversion functions ####### */\r | |
527 | \r | |
53e1e5c6 | 528 | /** Determine the number of bytes comprising a multibyte character.\r |
2aa62f2b | 529 | \r |
53e1e5c6 | 530 | If s is not a null pointer, the mblen function determines the number of bytes\r |
531 | contained in the multibyte character pointed to by s. Except that the\r | |
532 | conversion state of the mbtowc function is not affected, it is equivalent to\r | |
533 | mbtowc((wchar_t *)0, s, n);\r | |
534 | \r | |
535 | The implementation shall behave as if no library function calls the mblen\r | |
536 | function.\r | |
537 | \r | |
538 | @return If s is a null pointer, the mblen function returns a nonzero or\r | |
539 | zero value, if multibyte character encodings, respectively, do\r | |
540 | or do not have state-dependent encodings. If s is not a null\r | |
541 | pointer, the mblen function either returns 0 (if s points to the\r | |
542 | null character), or returns the number of bytes that are contained\r | |
543 | in the multibyte character (if the next n or fewer bytes form a\r | |
544 | valid multibyte character), or returns -1 (if they do not form a\r | |
545 | valid multibyte character).\r | |
2aa62f2b | 546 | **/\r |
547 | int mblen(const char *, size_t);\r | |
548 | \r | |
53e1e5c6 | 549 | /** Convert a multibyte character into a wide character.\r |
2aa62f2b | 550 | \r |
53e1e5c6 | 551 | If s is not a null pointer, the mbtowc function inspects at most n bytes\r |
552 | beginning with the byte pointed to by s to determine the number of bytes\r | |
553 | needed to complete the next multibyte character (including any shift\r | |
554 | sequences). If the function determines that the next multibyte character\r | |
555 | is complete and valid, it determines the value of the corresponding wide\r | |
556 | character and then, if pwc is not a null pointer, stores that value in\r | |
557 | the object pointed to by pwc. If the corresponding wide character is the\r | |
558 | null wide character, the function is left in the initial conversion state.\r | |
559 | \r | |
560 | The implementation shall behave as if no library function calls the\r | |
561 | mbtowc function.\r | |
562 | \r | |
563 | @return If s is a null pointer, the mbtowc function returns a nonzero or\r | |
564 | zero value, if multibyte character encodings, respectively, do\r | |
565 | or do not have state-dependent encodings. If s is not a null\r | |
566 | pointer, the mbtowc function either returns 0 (if s points to\r | |
567 | the null character), or returns the number of bytes that are\r | |
568 | contained in the converted multibyte character (if the next n or\r | |
569 | fewer bytes form a valid multibyte character), or returns -1\r | |
570 | (if they do not form a valid multibyte character).\r | |
571 | \r | |
572 | In no case will the value returned be greater than n or the value\r | |
573 | of the MB_CUR_MAX macro.\r | |
2aa62f2b | 574 | **/\r |
575 | int mbtowc(wchar_t * __restrict, const char * __restrict, size_t);\r | |
576 | \r | |
577 | /**\r | |
53e1e5c6 | 578 | The wctomb function determines the number of bytes needed to represent the multibyte\r |
579 | character corresponding to the wide character given by wc (including any shift\r | |
580 | sequences), and stores the multibyte character representation in the array whose first\r | |
581 | element is pointed to by s (if s is not a null pointer). At most MB_CUR_MAX characters\r | |
582 | are stored. If wc is a null wide character, a null byte is stored, preceded by any shift\r | |
583 | sequence needed to restore the initial shift state, and the function is left in the initial\r | |
584 | conversion state.\r | |
585 | \r | |
586 | The implementation shall behave as if no library function calls the wctomb function.\r | |
2aa62f2b | 587 | \r |
588 | @return\r | |
53e1e5c6 | 589 | If s is a null pointer, the wctomb function returns a nonzero or zero value, if multibyte\r |
590 | character encodings, respectively, do or do not have state-dependent encodings. If s is\r | |
591 | not a null pointer, the wctomb function returns -1 if the value of wc does not correspond\r | |
592 | to a valid multibyte character, or returns the number of bytes that are contained in the\r | |
593 | multibyte character corresponding to the value of wc.\r | |
594 | \r | |
595 | In no case will the value returned be greater than the value of the MB_CUR_MAX macro.\r | |
596 | \r | |
2aa62f2b | 597 | **/\r |
598 | int wctomb(char *, wchar_t);\r | |
599 | \r | |
600 | /* ################ Multibyte/wide string conversion functions ########## */\r | |
601 | \r | |
53e1e5c6 | 602 | /** Convert a multibyte character string into a wide-character string.\r |
603 | \r | |
604 | The mbstowcs function converts a sequence of multibyte characters that\r | |
605 | begins in the initial shift state from the array pointed to by src into\r | |
606 | a sequence of corresponding wide characters and stores not more than limit\r | |
607 | wide characters into the array pointed to by dest. No multibyte\r | |
608 | characters that follow a null character (which is converted into a null\r | |
609 | wide character) will be examined or converted. Each multibyte character\r | |
610 | is converted as if by a call to the mbtowc function, except that the\r | |
611 | conversion state of the mbtowc function is not affected.\r | |
612 | \r | |
613 | No more than limit elements will be modified in the array pointed to by dest.\r | |
614 | If copying takes place between objects that overlap,\r | |
615 | the behavior is undefined.\r | |
616 | \r | |
617 | @return If an invalid multibyte character is encountered, the mbstowcs\r | |
618 | function returns (size_t)(-1). Otherwise, the mbstowcs function\r | |
619 | returns the number of array elements modified, not including a\r | |
620 | terminating null wide character, if any.\r | |
2aa62f2b | 621 | \r |
2aa62f2b | 622 | **/\r |
53e1e5c6 | 623 | size_t mbstowcs(wchar_t * __restrict dest, const char * __restrict src, size_t limit);\r |
2aa62f2b | 624 | \r |
53e1e5c6 | 625 | /** Convert a wide-character string into a multibyte character string.\r |
2aa62f2b | 626 | \r |
53e1e5c6 | 627 | The wcstombs function converts a sequence of wide characters from the\r |
628 | array pointed to by src into a sequence of corresponding multibyte\r | |
629 | characters that begins in the initial shift state, and stores these\r | |
630 | multibyte characters into the array pointed to by dest, stopping if a\r | |
631 | multibyte character would exceed the limit of limit total bytes or if a\r | |
632 | null character is stored. Each wide character is converted as if by\r | |
633 | a call to the wctomb function, except that the conversion state of\r | |
634 | the wctomb function is not affected.\r | |
635 | \r | |
636 | No more than limit bytes will be modified in the array pointed to by dest.\r | |
637 | If copying takes place between objects that overlap,\r | |
638 | the behavior is undefined.\r | |
639 | \r | |
640 | @return If a wide character is encountered that does not correspond to a\r | |
641 | valid multibyte character, the wcstombs function returns\r | |
642 | (size_t)(-1). Otherwise, the wcstombs function returns the number\r | |
643 | of bytes modified, not including a terminating null character,\r | |
644 | if any.\r | |
2aa62f2b | 645 | **/\r |
53e1e5c6 | 646 | size_t wcstombs(char * __restrict dest, const wchar_t * __restrict src, size_t limit);\r |
2aa62f2b | 647 | \r |
d7ce7006 | 648 | /**\r |
649 | The realpath() function shall derive, from the pathname pointed to by \r | |
650 | file_name, an absolute pathname that names the same file, whose resolution \r | |
651 | does not involve '.', '..', or symbolic links. The generated pathname shall\r | |
652 | be stored as a null-terminated string, up to a maximum of {PATH_MAX} bytes,\r | |
653 | in the buffer pointed to by resolved_name.\r | |
654 | \r | |
655 | If resolved_name is a null pointer, the behavior of realpath() is \r | |
656 | implementation-defined.\r | |
657 | \r | |
658 | @param[in] file_name The filename to convert.\r | |
659 | @param[in,out] resolved_name The resultant name.\r | |
660 | \r | |
661 | @retval NULL An error occured.\r | |
662 | @return resolved_name.\r | |
663 | **/\r | |
664 | char * realpath(char *file_name, char *resolved_name);\r | |
665 | \r | |
666 | /**\r | |
667 | The getprogname() function returns the name of the program. If the name\r | |
668 | has not been set yet, it will return NULL.\r | |
669 | \r | |
670 | @retval The name of the program.\r | |
671 | @retval NULL The name has not been set.\r | |
672 | **/\r | |
673 | const char * getprogname(void);\r | |
674 | \r | |
675 | /**\r | |
676 | The setprogname() function sets the name of the program.\r | |
677 | \r | |
678 | @param[in] The name of the program. This memory must be retained \r | |
679 | by the caller until no calls to "getprogname" will be \r | |
680 | called.\r | |
681 | **/\r | |
682 | void setprogname(const char *progname);\r | |
683 | \r | |
2aa62f2b | 684 | __END_DECLS\r |
685 | \r | |
686 | #endif /* _STDLIB_H */\r |