Commit | Line | Data |
---|---|---|
954c1994 GS |
1 | =head1 NAME |
2 | ||
3 | perlapi - autogenerated documentation for the perl public API | |
4 | ||
5 | =head1 DESCRIPTION | |
6 | ||
1c846c1f NIS |
7 | This file contains the documentation of the perl public API generated by |
8 | embed.pl, specifically a listing of functions, macros, flags, and variables | |
9 | that may be used by extension writers. The interfaces of any functions that | |
954c1994 GS |
10 | are not listed here are subject to change without notice. For this reason, |
11 | blindly using functions listed in proto.h is to be avoided when writing | |
12 | extensions. | |
13 | ||
14 | Note that all Perl API global variables must be referenced with the C<PL_> | |
15 | prefix. Some macros are provided for compatibility with the older, | |
16 | unadorned names, but this support may be disabled in a future release. | |
17 | ||
18 | The listing is alphabetical, case insensitive. | |
19 | ||
94bdecf9 JH |
20 | |
21 | =head1 "Gimme" Values | |
22 | ||
23 | =over 8 | |
24 | ||
25 | =item GIMME | |
26 | ||
27 | A backward-compatible version of C<GIMME_V> which can only return | |
28 | C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>. | |
29 | Deprecated. Use C<GIMME_V> instead. | |
30 | ||
31 | U32 GIMME | |
32 | ||
33 | =for hackers | |
34 | Found in file op.h | |
35 | ||
36 | =item GIMME_V | |
37 | ||
38 | The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>, | |
39 | C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context, | |
40 | respectively. | |
41 | ||
42 | U32 GIMME_V | |
43 | ||
44 | =for hackers | |
45 | Found in file op.h | |
46 | ||
47 | =item G_ARRAY | |
48 | ||
49 | Used to indicate list context. See C<GIMME_V>, C<GIMME> and | |
50 | L<perlcall>. | |
51 | ||
52 | =for hackers | |
53 | Found in file cop.h | |
54 | ||
55 | =item G_DISCARD | |
56 | ||
57 | Indicates that arguments returned from a callback should be discarded. See | |
58 | L<perlcall>. | |
59 | ||
60 | =for hackers | |
61 | Found in file cop.h | |
62 | ||
63 | =item G_EVAL | |
64 | ||
65 | Used to force a Perl C<eval> wrapper around a callback. See | |
66 | L<perlcall>. | |
67 | ||
68 | =for hackers | |
69 | Found in file cop.h | |
70 | ||
71 | =item G_NOARGS | |
72 | ||
73 | Indicates that no arguments are being sent to a callback. See | |
74 | L<perlcall>. | |
75 | ||
76 | =for hackers | |
77 | Found in file cop.h | |
78 | ||
79 | =item G_SCALAR | |
80 | ||
81 | Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and | |
82 | L<perlcall>. | |
83 | ||
84 | =for hackers | |
85 | Found in file cop.h | |
86 | ||
87 | =item G_VOID | |
88 | ||
89 | Used to indicate void context. See C<GIMME_V> and L<perlcall>. | |
90 | ||
91 | =for hackers | |
92 | Found in file cop.h | |
93 | ||
94 | ||
95 | =back | |
96 | ||
97 | =head1 Array Manipulation Functions | |
98 | ||
954c1994 GS |
99 | =over 8 |
100 | ||
101 | =item AvFILL | |
102 | ||
103 | Same as C<av_len()>. Deprecated, use C<av_len()> instead. | |
104 | ||
105 | int AvFILL(AV* av) | |
106 | ||
497711e7 GS |
107 | =for hackers |
108 | Found in file av.h | |
109 | ||
954c1994 GS |
110 | =item av_clear |
111 | ||
112 | Clears an array, making it empty. Does not free the memory used by the | |
113 | array itself. | |
114 | ||
115 | void av_clear(AV* ar) | |
116 | ||
497711e7 GS |
117 | =for hackers |
118 | Found in file av.c | |
119 | ||
f3b76584 SC |
120 | =item av_delete |
121 | ||
122 | Deletes the element indexed by C<key> from the array. Returns the | |
123 | deleted element. C<flags> is currently ignored. | |
124 | ||
125 | SV* av_delete(AV* ar, I32 key, I32 flags) | |
126 | ||
127 | =for hackers | |
128 | Found in file av.c | |
129 | ||
130 | =item av_exists | |
131 | ||
132 | Returns true if the element indexed by C<key> has been initialized. | |
133 | ||
134 | This relies on the fact that uninitialized array elements are set to | |
135 | C<&PL_sv_undef>. | |
136 | ||
137 | bool av_exists(AV* ar, I32 key) | |
138 | ||
139 | =for hackers | |
140 | Found in file av.c | |
141 | ||
954c1994 GS |
142 | =item av_extend |
143 | ||
144 | Pre-extend an array. The C<key> is the index to which the array should be | |
145 | extended. | |
146 | ||
147 | void av_extend(AV* ar, I32 key) | |
148 | ||
497711e7 GS |
149 | =for hackers |
150 | Found in file av.c | |
151 | ||
954c1994 GS |
152 | =item av_fetch |
153 | ||
154 | Returns the SV at the specified index in the array. The C<key> is the | |
155 | index. If C<lval> is set then the fetch will be part of a store. Check | |
156 | that the return value is non-null before dereferencing it to a C<SV*>. | |
157 | ||
96f1132b GS |
158 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for |
159 | more information on how to use this function on tied arrays. | |
954c1994 GS |
160 | |
161 | SV** av_fetch(AV* ar, I32 key, I32 lval) | |
162 | ||
497711e7 GS |
163 | =for hackers |
164 | Found in file av.c | |
165 | ||
f3b76584 SC |
166 | =item av_fill |
167 | ||
168 | Ensure than an array has a given number of elements, equivalent to | |
169 | Perl's C<$#array = $fill;>. | |
170 | ||
171 | void av_fill(AV* ar, I32 fill) | |
172 | ||
173 | =for hackers | |
174 | Found in file av.c | |
175 | ||
954c1994 GS |
176 | =item av_len |
177 | ||
178 | Returns the highest index in the array. Returns -1 if the array is | |
179 | empty. | |
180 | ||
181 | I32 av_len(AV* ar) | |
182 | ||
497711e7 GS |
183 | =for hackers |
184 | Found in file av.c | |
185 | ||
954c1994 GS |
186 | =item av_make |
187 | ||
188 | Creates a new AV and populates it with a list of SVs. The SVs are copied | |
189 | into the array, so they may be freed after the call to av_make. The new AV | |
190 | will have a reference count of 1. | |
191 | ||
192 | AV* av_make(I32 size, SV** svp) | |
193 | ||
497711e7 GS |
194 | =for hackers |
195 | Found in file av.c | |
196 | ||
954c1994 GS |
197 | =item av_pop |
198 | ||
199 | Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array | |
200 | is empty. | |
201 | ||
202 | SV* av_pop(AV* ar) | |
203 | ||
497711e7 GS |
204 | =for hackers |
205 | Found in file av.c | |
206 | ||
954c1994 GS |
207 | =item av_push |
208 | ||
209 | Pushes an SV onto the end of the array. The array will grow automatically | |
210 | to accommodate the addition. | |
211 | ||
212 | void av_push(AV* ar, SV* val) | |
213 | ||
497711e7 GS |
214 | =for hackers |
215 | Found in file av.c | |
216 | ||
954c1994 GS |
217 | =item av_shift |
218 | ||
219 | Shifts an SV off the beginning of the array. | |
220 | ||
221 | SV* av_shift(AV* ar) | |
222 | ||
497711e7 GS |
223 | =for hackers |
224 | Found in file av.c | |
225 | ||
954c1994 GS |
226 | =item av_store |
227 | ||
228 | Stores an SV in an array. The array index is specified as C<key>. The | |
229 | return value will be NULL if the operation failed or if the value did not | |
230 | need to be actually stored within the array (as in the case of tied | |
231 | arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note | |
232 | that the caller is responsible for suitably incrementing the reference | |
233 | count of C<val> before the call, and decrementing it if the function | |
234 | returned NULL. | |
235 | ||
96f1132b | 236 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for |
954c1994 GS |
237 | more information on how to use this function on tied arrays. |
238 | ||
239 | SV** av_store(AV* ar, I32 key, SV* val) | |
240 | ||
497711e7 GS |
241 | =for hackers |
242 | Found in file av.c | |
243 | ||
954c1994 GS |
244 | =item av_undef |
245 | ||
246 | Undefines the array. Frees the memory used by the array itself. | |
247 | ||
248 | void av_undef(AV* ar) | |
249 | ||
497711e7 GS |
250 | =for hackers |
251 | Found in file av.c | |
252 | ||
954c1994 GS |
253 | =item av_unshift |
254 | ||
255 | Unshift the given number of C<undef> values onto the beginning of the | |
256 | array. The array will grow automatically to accommodate the addition. You | |
257 | must then use C<av_store> to assign values to these new elements. | |
258 | ||
259 | void av_unshift(AV* ar, I32 num) | |
260 | ||
497711e7 GS |
261 | =for hackers |
262 | Found in file av.c | |
263 | ||
94bdecf9 | 264 | =item get_av |
9f2ea798 | 265 | |
94bdecf9 JH |
266 | Returns the AV of the specified Perl array. If C<create> is set and the |
267 | Perl variable does not exist then it will be created. If C<create> is not | |
268 | set and the variable does not exist then NULL is returned. | |
9f2ea798 | 269 | |
94bdecf9 JH |
270 | NOTE: the perl_ form of this function is deprecated. |
271 | ||
272 | AV* get_av(const char* name, I32 create) | |
9f2ea798 DM |
273 | |
274 | =for hackers | |
94bdecf9 | 275 | Found in file perl.c |
9f2ea798 | 276 | |
94bdecf9 | 277 | =item newAV |
f9a63242 | 278 | |
94bdecf9 | 279 | Creates a new AV. The reference count is set to 1. |
f9a63242 | 280 | |
94bdecf9 JH |
281 | AV* newAV() |
282 | ||
283 | =for hackers | |
284 | Found in file av.c | |
285 | ||
286 | =item Nullav | |
287 | ||
288 | Null AV pointer. | |
f9a63242 | 289 | |
f9a63242 JH |
290 | |
291 | =for hackers | |
94bdecf9 | 292 | Found in file av.h |
f9a63242 | 293 | |
94bdecf9 | 294 | =item sortsv |
497711e7 | 295 | |
94bdecf9 | 296 | Sort an array. Here is an example: |
497711e7 | 297 | |
94bdecf9 | 298 | sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale); |
eebe1485 | 299 | |
641d4181 JH |
300 | See lib/sort.pm for details about controlling the sorting algorithm. |
301 | ||
94bdecf9 | 302 | void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp) |
497711e7 GS |
303 | |
304 | =for hackers | |
94bdecf9 JH |
305 | Found in file pp_sort.c |
306 | ||
307 | ||
308 | =back | |
309 | ||
310 | =head1 Callback Functions | |
311 | ||
312 | =over 8 | |
497711e7 | 313 | |
954c1994 GS |
314 | =item call_argv |
315 | ||
316 | Performs a callback to the specified Perl sub. See L<perlcall>. | |
317 | ||
318 | NOTE: the perl_ form of this function is deprecated. | |
319 | ||
320 | I32 call_argv(const char* sub_name, I32 flags, char** argv) | |
321 | ||
497711e7 GS |
322 | =for hackers |
323 | Found in file perl.c | |
324 | ||
954c1994 GS |
325 | =item call_method |
326 | ||
327 | Performs a callback to the specified Perl method. The blessed object must | |
328 | be on the stack. See L<perlcall>. | |
329 | ||
330 | NOTE: the perl_ form of this function is deprecated. | |
331 | ||
332 | I32 call_method(const char* methname, I32 flags) | |
333 | ||
497711e7 GS |
334 | =for hackers |
335 | Found in file perl.c | |
336 | ||
954c1994 GS |
337 | =item call_pv |
338 | ||
339 | Performs a callback to the specified Perl sub. See L<perlcall>. | |
340 | ||
341 | NOTE: the perl_ form of this function is deprecated. | |
342 | ||
343 | I32 call_pv(const char* sub_name, I32 flags) | |
344 | ||
497711e7 GS |
345 | =for hackers |
346 | Found in file perl.c | |
347 | ||
954c1994 GS |
348 | =item call_sv |
349 | ||
350 | Performs a callback to the Perl sub whose name is in the SV. See | |
351 | L<perlcall>. | |
352 | ||
353 | NOTE: the perl_ form of this function is deprecated. | |
354 | ||
355 | I32 call_sv(SV* sv, I32 flags) | |
356 | ||
497711e7 GS |
357 | =for hackers |
358 | Found in file perl.c | |
359 | ||
94bdecf9 | 360 | =item ENTER |
954c1994 | 361 | |
94bdecf9 | 362 | Opening bracket on a callback. See C<LEAVE> and L<perlcall>. |
954c1994 | 363 | |
94bdecf9 | 364 | ENTER; |
954c1994 | 365 | |
497711e7 | 366 | =for hackers |
94bdecf9 | 367 | Found in file scope.h |
497711e7 | 368 | |
94bdecf9 | 369 | =item eval_pv |
954c1994 | 370 | |
94bdecf9 | 371 | Tells Perl to C<eval> the given string and return an SV* result. |
954c1994 | 372 | |
94bdecf9 | 373 | NOTE: the perl_ form of this function is deprecated. |
954c1994 | 374 | |
94bdecf9 | 375 | SV* eval_pv(const char* p, I32 croak_on_error) |
497711e7 | 376 | |
94bdecf9 JH |
377 | =for hackers |
378 | Found in file perl.c | |
954c1994 | 379 | |
94bdecf9 | 380 | =item eval_sv |
c9d5ac95 | 381 | |
94bdecf9 | 382 | Tells Perl to C<eval> the string in the SV. |
c9d5ac95 | 383 | |
94bdecf9 | 384 | NOTE: the perl_ form of this function is deprecated. |
954c1994 | 385 | |
94bdecf9 | 386 | I32 eval_sv(SV* sv, I32 flags) |
954c1994 | 387 | |
497711e7 | 388 | =for hackers |
94bdecf9 | 389 | Found in file perl.c |
497711e7 | 390 | |
94bdecf9 | 391 | =item FREETMPS |
954c1994 | 392 | |
94bdecf9 JH |
393 | Closing bracket for temporaries on a callback. See C<SAVETMPS> and |
394 | L<perlcall>. | |
954c1994 | 395 | |
94bdecf9 | 396 | FREETMPS; |
954c1994 | 397 | |
497711e7 | 398 | =for hackers |
94bdecf9 | 399 | Found in file scope.h |
beab0874 | 400 | |
94bdecf9 | 401 | =item LEAVE |
beab0874 | 402 | |
94bdecf9 | 403 | Closing bracket on a callback. See C<ENTER> and L<perlcall>. |
beab0874 | 404 | |
94bdecf9 | 405 | LEAVE; |
beab0874 JT |
406 | |
407 | =for hackers | |
94bdecf9 | 408 | Found in file scope.h |
beab0874 | 409 | |
94bdecf9 | 410 | =item SAVETMPS |
9f2ea798 | 411 | |
94bdecf9 JH |
412 | Opening bracket for temporaries on a callback. See C<FREETMPS> and |
413 | L<perlcall>. | |
9f2ea798 | 414 | |
94bdecf9 | 415 | SAVETMPS; |
9f2ea798 DM |
416 | |
417 | =for hackers | |
94bdecf9 | 418 | Found in file scope.h |
9f2ea798 | 419 | |
9f2ea798 | 420 | |
94bdecf9 | 421 | =back |
9f2ea798 | 422 | |
94bdecf9 | 423 | =head1 Character classes |
9f2ea798 | 424 | |
94bdecf9 | 425 | =over 8 |
9f2ea798 | 426 | |
94bdecf9 | 427 | =item isALNUM |
954c1994 | 428 | |
94bdecf9 JH |
429 | Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric |
430 | character (including underscore) or digit. | |
954c1994 | 431 | |
94bdecf9 | 432 | bool isALNUM(char ch) |
954c1994 | 433 | |
497711e7 | 434 | =for hackers |
94bdecf9 | 435 | Found in file handy.h |
497711e7 | 436 | |
94bdecf9 | 437 | =item isALPHA |
954c1994 | 438 | |
94bdecf9 JH |
439 | Returns a boolean indicating whether the C C<char> is an ASCII alphabetic |
440 | character. | |
954c1994 | 441 | |
94bdecf9 | 442 | bool isALPHA(char ch) |
954c1994 | 443 | |
497711e7 | 444 | =for hackers |
94bdecf9 | 445 | Found in file handy.h |
497711e7 | 446 | |
94bdecf9 | 447 | =item isDIGIT |
954c1994 | 448 | |
94bdecf9 JH |
449 | Returns a boolean indicating whether the C C<char> is an ASCII |
450 | digit. | |
954c1994 | 451 | |
94bdecf9 | 452 | bool isDIGIT(char ch) |
954c1994 | 453 | |
497711e7 | 454 | =for hackers |
94bdecf9 | 455 | Found in file handy.h |
497711e7 | 456 | |
94bdecf9 | 457 | =item isLOWER |
954c1994 | 458 | |
94bdecf9 JH |
459 | Returns a boolean indicating whether the C C<char> is a lowercase |
460 | character. | |
954c1994 | 461 | |
94bdecf9 | 462 | bool isLOWER(char ch) |
954c1994 | 463 | |
497711e7 | 464 | =for hackers |
94bdecf9 | 465 | Found in file handy.h |
497711e7 | 466 | |
94bdecf9 | 467 | =item isSPACE |
954c1994 | 468 | |
94bdecf9 | 469 | Returns a boolean indicating whether the C C<char> is whitespace. |
954c1994 | 470 | |
94bdecf9 | 471 | bool isSPACE(char ch) |
954c1994 | 472 | |
497711e7 | 473 | =for hackers |
94bdecf9 | 474 | Found in file handy.h |
497711e7 | 475 | |
94bdecf9 | 476 | =item isUPPER |
954c1994 | 477 | |
94bdecf9 JH |
478 | Returns a boolean indicating whether the C C<char> is an uppercase |
479 | character. | |
954c1994 | 480 | |
94bdecf9 | 481 | bool isUPPER(char ch) |
954c1994 | 482 | |
497711e7 | 483 | =for hackers |
94bdecf9 | 484 | Found in file handy.h |
497711e7 | 485 | |
94bdecf9 | 486 | =item toLOWER |
954c1994 | 487 | |
94bdecf9 | 488 | Converts the specified character to lowercase. |
954c1994 | 489 | |
94bdecf9 | 490 | char toLOWER(char ch) |
954c1994 | 491 | |
94bdecf9 JH |
492 | =for hackers |
493 | Found in file handy.h | |
494 | ||
495 | =item toUPPER | |
496 | ||
497 | Converts the specified character to uppercase. | |
498 | ||
499 | char toUPPER(char ch) | |
954c1994 | 500 | |
497711e7 | 501 | =for hackers |
94bdecf9 | 502 | Found in file handy.h |
497711e7 | 503 | |
954c1994 | 504 | |
94bdecf9 | 505 | =back |
954c1994 | 506 | |
94bdecf9 | 507 | =head1 Cloning an interpreter |
954c1994 | 508 | |
94bdecf9 JH |
509 | =over 8 |
510 | ||
511 | =item perl_clone | |
512 | ||
513 | Create and return a new interpreter by cloning the current one. | |
514 | ||
515 | PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags) | |
954c1994 | 516 | |
497711e7 | 517 | =for hackers |
94bdecf9 | 518 | Found in file sv.c |
497711e7 | 519 | |
954c1994 | 520 | |
94bdecf9 | 521 | =back |
954c1994 | 522 | |
94bdecf9 JH |
523 | =head1 CV Manipulation Functions |
524 | ||
525 | =over 8 | |
526 | ||
527 | =item CvSTASH | |
528 | ||
529 | Returns the stash of the CV. | |
530 | ||
531 | HV* CvSTASH(CV* cv) | |
954c1994 | 532 | |
497711e7 | 533 | =for hackers |
94bdecf9 | 534 | Found in file cv.h |
497711e7 | 535 | |
94bdecf9 | 536 | =item get_cv |
954c1994 | 537 | |
94bdecf9 JH |
538 | Returns the CV of the specified Perl subroutine. If C<create> is set and |
539 | the Perl subroutine does not exist then it will be declared (which has the | |
540 | same effect as saying C<sub name;>). If C<create> is not set and the | |
541 | subroutine does not exist then NULL is returned. | |
954c1994 | 542 | |
94bdecf9 JH |
543 | NOTE: the perl_ form of this function is deprecated. |
544 | ||
545 | CV* get_cv(const char* name, I32 create) | |
954c1994 | 546 | |
497711e7 | 547 | =for hackers |
94bdecf9 | 548 | Found in file perl.c |
497711e7 | 549 | |
94bdecf9 | 550 | =item Nullcv |
954c1994 | 551 | |
94bdecf9 | 552 | Null CV pointer. |
954c1994 | 553 | |
954c1994 | 554 | |
497711e7 | 555 | =for hackers |
94bdecf9 | 556 | Found in file cv.h |
497711e7 | 557 | |
7c9e965c | 558 | |
94bdecf9 | 559 | =back |
7c9e965c | 560 | |
94bdecf9 | 561 | =head1 Embedding Functions |
7c9e965c | 562 | |
94bdecf9 | 563 | =over 8 |
7c9e965c | 564 | |
94bdecf9 | 565 | =item load_module |
7c9e965c | 566 | |
94bdecf9 JH |
567 | Loads the module whose name is pointed to by the string part of name. |
568 | Note that the actual module name, not its filename, should be given. | |
569 | Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of | |
570 | PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS | |
571 | (or 0 for no flags). ver, if specified, provides version semantics | |
572 | similar to C<use Foo::Bar VERSION>. The optional trailing SV* | |
573 | arguments can be used to specify arguments to the module's import() | |
574 | method, similar to C<use Foo::Bar VERSION LIST>. | |
7c9e965c | 575 | |
94bdecf9 | 576 | void load_module(U32 flags, SV* name, SV* ver, ...) |
7c9e965c JP |
577 | |
578 | =for hackers | |
94bdecf9 | 579 | Found in file op.c |
7c9e965c | 580 | |
62375a60 NIS |
581 | =item nothreadhook |
582 | ||
583 | Stub that provides thread hook for perl_destruct when there are | |
584 | no threads. | |
585 | ||
586 | int nothreadhook() | |
587 | ||
588 | =for hackers | |
589 | Found in file perl.c | |
590 | ||
94bdecf9 | 591 | =item perl_alloc |
954c1994 | 592 | |
94bdecf9 | 593 | Allocates a new Perl interpreter. See L<perlembed>. |
954c1994 | 594 | |
94bdecf9 | 595 | PerlInterpreter* perl_alloc() |
954c1994 | 596 | |
497711e7 | 597 | =for hackers |
94bdecf9 | 598 | Found in file perl.c |
497711e7 | 599 | |
94bdecf9 | 600 | =item perl_construct |
89423764 | 601 | |
94bdecf9 | 602 | Initializes a new Perl interpreter. See L<perlembed>. |
89423764 | 603 | |
94bdecf9 | 604 | void perl_construct(PerlInterpreter* interp) |
89423764 GS |
605 | |
606 | =for hackers | |
94bdecf9 | 607 | Found in file perl.c |
954c1994 | 608 | |
94bdecf9 | 609 | =item perl_destruct |
954c1994 | 610 | |
94bdecf9 | 611 | Shuts down a Perl interpreter. See L<perlembed>. |
954c1994 | 612 | |
94bdecf9 | 613 | int perl_destruct(PerlInterpreter* interp) |
954c1994 | 614 | |
497711e7 GS |
615 | =for hackers |
616 | Found in file perl.c | |
617 | ||
94bdecf9 | 618 | =item perl_free |
954c1994 | 619 | |
94bdecf9 | 620 | Releases a Perl interpreter. See L<perlembed>. |
954c1994 | 621 | |
94bdecf9 | 622 | void perl_free(PerlInterpreter* interp) |
954c1994 | 623 | |
497711e7 GS |
624 | =for hackers |
625 | Found in file perl.c | |
626 | ||
94bdecf9 | 627 | =item perl_parse |
954c1994 | 628 | |
94bdecf9 | 629 | Tells a Perl interpreter to parse a Perl script. See L<perlembed>. |
954c1994 | 630 | |
94bdecf9 | 631 | int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env) |
954c1994 | 632 | |
94bdecf9 JH |
633 | =for hackers |
634 | Found in file perl.c | |
635 | ||
636 | =item perl_run | |
637 | ||
638 | Tells a Perl interpreter to run. See L<perlembed>. | |
639 | ||
640 | int perl_run(PerlInterpreter* interp) | |
954c1994 | 641 | |
497711e7 GS |
642 | =for hackers |
643 | Found in file perl.c | |
644 | ||
94bdecf9 | 645 | =item require_pv |
954c1994 | 646 | |
94bdecf9 JH |
647 | Tells Perl to C<require> the file named by the string argument. It is |
648 | analogous to the Perl code C<eval "require '$file'">. It's even | |
649 | implemented that way; consider using Perl_load_module instead. | |
954c1994 GS |
650 | |
651 | NOTE: the perl_ form of this function is deprecated. | |
652 | ||
94bdecf9 | 653 | void require_pv(const char* pv) |
954c1994 | 654 | |
497711e7 GS |
655 | =for hackers |
656 | Found in file perl.c | |
657 | ||
954c1994 | 658 | |
94bdecf9 | 659 | =back |
954c1994 | 660 | |
6050d10e JP |
661 | =head1 Functions in file pp_pack.c |
662 | ||
663 | ||
664 | =over 8 | |
665 | ||
666 | =item pack_cat | |
667 | ||
668 | The engine implementing pack() Perl function. | |
669 | ||
670 | void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags) | |
671 | ||
672 | =for hackers | |
673 | Found in file pp_pack.c | |
674 | ||
675 | =item unpack_str | |
676 | ||
677 | The engine implementing unpack() Perl function. | |
678 | ||
679 | I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags) | |
680 | ||
681 | =for hackers | |
682 | Found in file pp_pack.c | |
683 | ||
684 | ||
685 | =back | |
686 | ||
94bdecf9 | 687 | =head1 Global Variables |
954c1994 | 688 | |
94bdecf9 | 689 | =over 8 |
497711e7 | 690 | |
94bdecf9 | 691 | =item PL_modglobal |
954c1994 | 692 | |
94bdecf9 JH |
693 | C<PL_modglobal> is a general purpose, interpreter global HV for use by |
694 | extensions that need to keep information on a per-interpreter basis. | |
695 | In a pinch, it can also be used as a symbol table for extensions | |
696 | to share data among each other. It is a good idea to use keys | |
697 | prefixed by the package name of the extension that owns the data. | |
954c1994 | 698 | |
94bdecf9 | 699 | HV* PL_modglobal |
954c1994 | 700 | |
497711e7 | 701 | =for hackers |
94bdecf9 | 702 | Found in file intrpvar.h |
497711e7 | 703 | |
94bdecf9 | 704 | =item PL_na |
6e9d1081 | 705 | |
94bdecf9 JH |
706 | A convenience variable which is typically used with C<SvPV> when one |
707 | doesn't care about the length of the string. It is usually more efficient | |
708 | to either declare a local variable and use that instead or to use the | |
709 | C<SvPV_nolen> macro. | |
6e9d1081 | 710 | |
94bdecf9 | 711 | STRLEN PL_na |
6e9d1081 | 712 | |
94bdecf9 JH |
713 | =for hackers |
714 | Found in file thrdvar.h | |
6e9d1081 | 715 | |
94bdecf9 | 716 | =item PL_sv_no |
6e9d1081 | 717 | |
94bdecf9 JH |
718 | This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as |
719 | C<&PL_sv_no>. | |
720 | ||
721 | SV PL_sv_no | |
6e9d1081 NC |
722 | |
723 | =for hackers | |
94bdecf9 | 724 | Found in file intrpvar.h |
6e9d1081 | 725 | |
94bdecf9 | 726 | =item PL_sv_undef |
6e9d1081 | 727 | |
94bdecf9 | 728 | This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>. |
6e9d1081 | 729 | |
94bdecf9 | 730 | SV PL_sv_undef |
6e9d1081 | 731 | |
94bdecf9 JH |
732 | =for hackers |
733 | Found in file intrpvar.h | |
6e9d1081 | 734 | |
94bdecf9 | 735 | =item PL_sv_yes |
6e9d1081 | 736 | |
94bdecf9 JH |
737 | This is the C<true> SV. See C<PL_sv_no>. Always refer to this as |
738 | C<&PL_sv_yes>. | |
739 | ||
740 | SV PL_sv_yes | |
6e9d1081 NC |
741 | |
742 | =for hackers | |
94bdecf9 | 743 | Found in file intrpvar.h |
6e9d1081 | 744 | |
6e9d1081 | 745 | |
94bdecf9 | 746 | =back |
6e9d1081 | 747 | |
94bdecf9 | 748 | =head1 GV Functions |
6e9d1081 | 749 | |
94bdecf9 | 750 | =over 8 |
6e9d1081 | 751 | |
954c1994 GS |
752 | =item GvSV |
753 | ||
754 | Return the SV from the GV. | |
755 | ||
756 | SV* GvSV(GV* gv) | |
757 | ||
497711e7 GS |
758 | =for hackers |
759 | Found in file gv.h | |
760 | ||
954c1994 GS |
761 | =item gv_fetchmeth |
762 | ||
763 | Returns the glob with the given C<name> and a defined subroutine or | |
764 | C<NULL>. The glob lives in the given C<stash>, or in the stashes | |
a453c169 | 765 | accessible via @ISA and UNIVERSAL::. |
954c1994 GS |
766 | |
767 | The argument C<level> should be either 0 or -1. If C<level==0>, as a | |
768 | side-effect creates a glob with the given C<name> in the given C<stash> | |
769 | which in the case of success contains an alias for the subroutine, and sets | |
1c846c1f | 770 | up caching info for this glob. Similarly for all the searched stashes. |
954c1994 GS |
771 | |
772 | This function grants C<"SUPER"> token as a postfix of the stash name. The | |
773 | GV returned from C<gv_fetchmeth> may be a method cache entry, which is not | |
4929bf7b | 774 | visible to Perl code. So when calling C<call_sv>, you should not use |
954c1994 | 775 | the GV directly; instead, you should use the method's CV, which can be |
1c846c1f | 776 | obtained from the GV with the C<GvCV> macro. |
954c1994 GS |
777 | |
778 | GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level) | |
779 | ||
497711e7 GS |
780 | =for hackers |
781 | Found in file gv.c | |
782 | ||
954c1994 GS |
783 | =item gv_fetchmethod |
784 | ||
6d0f518e | 785 | See L<gv_fetchmethod_autoload>. |
954c1994 GS |
786 | |
787 | GV* gv_fetchmethod(HV* stash, const char* name) | |
788 | ||
497711e7 GS |
789 | =for hackers |
790 | Found in file gv.c | |
791 | ||
954c1994 GS |
792 | =item gv_fetchmethod_autoload |
793 | ||
794 | Returns the glob which contains the subroutine to call to invoke the method | |
795 | on the C<stash>. In fact in the presence of autoloading this may be the | |
796 | glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is | |
1c846c1f | 797 | already setup. |
954c1994 GS |
798 | |
799 | The third parameter of C<gv_fetchmethod_autoload> determines whether | |
800 | AUTOLOAD lookup is performed if the given method is not present: non-zero | |
1c846c1f | 801 | means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD. |
954c1994 | 802 | Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload> |
1c846c1f | 803 | with a non-zero C<autoload> parameter. |
954c1994 GS |
804 | |
805 | These functions grant C<"SUPER"> token as a prefix of the method name. Note | |
806 | that if you want to keep the returned glob for a long time, you need to | |
807 | check for it being "AUTOLOAD", since at the later time the call may load a | |
808 | different subroutine due to $AUTOLOAD changing its value. Use the glob | |
1c846c1f | 809 | created via a side effect to do this. |
954c1994 GS |
810 | |
811 | These functions have the same side-effects and as C<gv_fetchmeth> with | |
812 | C<level==0>. C<name> should be writable if contains C<':'> or C<' | |
813 | ''>. The warning against passing the GV returned by C<gv_fetchmeth> to | |
1c846c1f | 814 | C<call_sv> apply equally to these functions. |
954c1994 GS |
815 | |
816 | GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload) | |
817 | ||
497711e7 GS |
818 | =for hackers |
819 | Found in file gv.c | |
820 | ||
0c81b680 JH |
821 | =item gv_fetchmeth_autoload |
822 | ||
823 | Same as gv_fetchmeth(), but looks for autoloaded subroutines too. | |
824 | Returns a glob for the subroutine. | |
825 | ||
826 | For an autoloaded subroutine without a GV, will create a GV even | |
827 | if C<level < 0>. For an autoloaded subroutine without a stub, GvCV() | |
828 | of the result may be zero. | |
829 | ||
830 | GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level) | |
831 | ||
832 | =for hackers | |
833 | Found in file gv.c | |
834 | ||
954c1994 GS |
835 | =item gv_stashpv |
836 | ||
386d01d6 GS |
837 | Returns a pointer to the stash for a specified package. C<name> should |
838 | be a valid UTF-8 string. If C<create> is set then the package will be | |
839 | created if it does not already exist. If C<create> is not set and the | |
840 | package does not exist then NULL is returned. | |
954c1994 GS |
841 | |
842 | HV* gv_stashpv(const char* name, I32 create) | |
843 | ||
497711e7 GS |
844 | =for hackers |
845 | Found in file gv.c | |
846 | ||
954c1994 GS |
847 | =item gv_stashsv |
848 | ||
386d01d6 GS |
849 | Returns a pointer to the stash for a specified package, which must be a |
850 | valid UTF-8 string. See C<gv_stashpv>. | |
954c1994 GS |
851 | |
852 | HV* gv_stashsv(SV* sv, I32 create) | |
853 | ||
497711e7 GS |
854 | =for hackers |
855 | Found in file gv.c | |
856 | ||
954c1994 | 857 | |
94bdecf9 | 858 | =back |
954c1994 | 859 | |
94bdecf9 | 860 | =head1 Handy Values |
497711e7 | 861 | |
94bdecf9 | 862 | =over 8 |
954c1994 | 863 | |
94bdecf9 | 864 | =item HEf_SVKEY |
954c1994 | 865 | |
94bdecf9 JH |
866 | This flag, used in the length slot of hash entries and magic structures, |
867 | specifies the structure contains an C<SV*> pointer where a C<char*> pointer | |
868 | is to be expected. (For information only--not to be used). | |
497711e7 | 869 | |
954c1994 | 870 | |
94bdecf9 JH |
871 | =for hackers |
872 | Found in file hv.h | |
954c1994 | 873 | |
dd2155a4 | 874 | =item Nullch |
94bdecf9 JH |
875 | |
876 | Null character pointer. | |
497711e7 | 877 | =for hackers |
94bdecf9 | 878 | Found in file handy.h |
497711e7 | 879 | |
94bdecf9 | 880 | =item Nullsv |
954c1994 | 881 | |
94bdecf9 | 882 | Null SV pointer. |
954c1994 | 883 | |
497711e7 | 884 | =for hackers |
94bdecf9 | 885 | Found in file handy.h |
497711e7 | 886 | |
954c1994 | 887 | |
94bdecf9 | 888 | =back |
954c1994 | 889 | |
94bdecf9 | 890 | =head1 Hash Manipulation Functions |
497711e7 | 891 | |
94bdecf9 | 892 | =over 8 |
954c1994 | 893 | |
94bdecf9 | 894 | =item get_hv |
954c1994 | 895 | |
94bdecf9 JH |
896 | Returns the HV of the specified Perl hash. If C<create> is set and the |
897 | Perl variable does not exist then it will be created. If C<create> is not | |
898 | set and the variable does not exist then NULL is returned. | |
497711e7 | 899 | |
94bdecf9 | 900 | NOTE: the perl_ form of this function is deprecated. |
954c1994 | 901 | |
94bdecf9 | 902 | HV* get_hv(const char* name, I32 create) |
954c1994 | 903 | |
497711e7 | 904 | =for hackers |
94bdecf9 | 905 | Found in file perl.c |
497711e7 | 906 | |
954c1994 GS |
907 | =item HeHASH |
908 | ||
909 | Returns the computed hash stored in the hash entry. | |
910 | ||
911 | U32 HeHASH(HE* he) | |
912 | ||
497711e7 GS |
913 | =for hackers |
914 | Found in file hv.h | |
915 | ||
954c1994 GS |
916 | =item HeKEY |
917 | ||
918 | Returns the actual pointer stored in the key slot of the hash entry. The | |
919 | pointer may be either C<char*> or C<SV*>, depending on the value of | |
920 | C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are | |
921 | usually preferable for finding the value of a key. | |
922 | ||
923 | void* HeKEY(HE* he) | |
924 | ||
497711e7 GS |
925 | =for hackers |
926 | Found in file hv.h | |
927 | ||
954c1994 GS |
928 | =item HeKLEN |
929 | ||
930 | If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry | |
931 | holds an C<SV*> key. Otherwise, holds the actual length of the key. Can | |
932 | be assigned to. The C<HePV()> macro is usually preferable for finding key | |
933 | lengths. | |
934 | ||
935 | STRLEN HeKLEN(HE* he) | |
936 | ||
497711e7 GS |
937 | =for hackers |
938 | Found in file hv.h | |
939 | ||
954c1994 GS |
940 | =item HePV |
941 | ||
942 | Returns the key slot of the hash entry as a C<char*> value, doing any | |
943 | necessary dereferencing of possibly C<SV*> keys. The length of the string | |
944 | is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do | |
945 | not care about what the length of the key is, you may use the global | |
946 | variable C<PL_na>, though this is rather less efficient than using a local | |
947 | variable. Remember though, that hash keys in perl are free to contain | |
948 | embedded nulls, so using C<strlen()> or similar is not a good way to find | |
949 | the length of hash keys. This is very similar to the C<SvPV()> macro | |
950 | described elsewhere in this document. | |
951 | ||
952 | char* HePV(HE* he, STRLEN len) | |
953 | ||
497711e7 GS |
954 | =for hackers |
955 | Found in file hv.h | |
956 | ||
954c1994 GS |
957 | =item HeSVKEY |
958 | ||
959 | Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not | |
960 | contain an C<SV*> key. | |
961 | ||
962 | SV* HeSVKEY(HE* he) | |
963 | ||
497711e7 GS |
964 | =for hackers |
965 | Found in file hv.h | |
966 | ||
954c1994 GS |
967 | =item HeSVKEY_force |
968 | ||
969 | Returns the key as an C<SV*>. Will create and return a temporary mortal | |
970 | C<SV*> if the hash entry contains only a C<char*> key. | |
971 | ||
972 | SV* HeSVKEY_force(HE* he) | |
973 | ||
497711e7 GS |
974 | =for hackers |
975 | Found in file hv.h | |
976 | ||
954c1994 GS |
977 | =item HeSVKEY_set |
978 | ||
979 | Sets the key to a given C<SV*>, taking care to set the appropriate flags to | |
980 | indicate the presence of an C<SV*> key, and returns the same | |
981 | C<SV*>. | |
982 | ||
983 | SV* HeSVKEY_set(HE* he, SV* sv) | |
984 | ||
497711e7 GS |
985 | =for hackers |
986 | Found in file hv.h | |
987 | ||
954c1994 GS |
988 | =item HeVAL |
989 | ||
990 | Returns the value slot (type C<SV*>) stored in the hash entry. | |
991 | ||
992 | SV* HeVAL(HE* he) | |
993 | ||
497711e7 GS |
994 | =for hackers |
995 | Found in file hv.h | |
996 | ||
954c1994 GS |
997 | =item HvNAME |
998 | ||
999 | Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>. | |
1000 | ||
1001 | char* HvNAME(HV* stash) | |
1002 | ||
497711e7 GS |
1003 | =for hackers |
1004 | Found in file hv.h | |
1005 | ||
954c1994 GS |
1006 | =item hv_clear |
1007 | ||
1008 | Clears a hash, making it empty. | |
1009 | ||
1010 | void hv_clear(HV* tb) | |
1011 | ||
497711e7 GS |
1012 | =for hackers |
1013 | Found in file hv.c | |
1014 | ||
954c1994 GS |
1015 | =item hv_delete |
1016 | ||
1017 | Deletes a key/value pair in the hash. The value SV is removed from the | |
1c846c1f | 1018 | hash and returned to the caller. The C<klen> is the length of the key. |
954c1994 GS |
1019 | The C<flags> value will normally be zero; if set to G_DISCARD then NULL |
1020 | will be returned. | |
1021 | ||
da58a35d | 1022 | SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags) |
954c1994 | 1023 | |
497711e7 GS |
1024 | =for hackers |
1025 | Found in file hv.c | |
1026 | ||
954c1994 GS |
1027 | =item hv_delete_ent |
1028 | ||
1029 | Deletes a key/value pair in the hash. The value SV is removed from the | |
1030 | hash and returned to the caller. The C<flags> value will normally be zero; | |
1031 | if set to G_DISCARD then NULL will be returned. C<hash> can be a valid | |
1032 | precomputed hash value, or 0 to ask for it to be computed. | |
1033 | ||
1034 | SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash) | |
1035 | ||
497711e7 GS |
1036 | =for hackers |
1037 | Found in file hv.c | |
1038 | ||
954c1994 GS |
1039 | =item hv_exists |
1040 | ||
1041 | Returns a boolean indicating whether the specified hash key exists. The | |
1042 | C<klen> is the length of the key. | |
1043 | ||
da58a35d | 1044 | bool hv_exists(HV* tb, const char* key, I32 klen) |
954c1994 | 1045 | |
497711e7 GS |
1046 | =for hackers |
1047 | Found in file hv.c | |
1048 | ||
954c1994 GS |
1049 | =item hv_exists_ent |
1050 | ||
1051 | Returns a boolean indicating whether the specified hash key exists. C<hash> | |
1052 | can be a valid precomputed hash value, or 0 to ask for it to be | |
1053 | computed. | |
1054 | ||
1055 | bool hv_exists_ent(HV* tb, SV* key, U32 hash) | |
1056 | ||
497711e7 GS |
1057 | =for hackers |
1058 | Found in file hv.c | |
1059 | ||
954c1994 GS |
1060 | =item hv_fetch |
1061 | ||
1062 | Returns the SV which corresponds to the specified key in the hash. The | |
1063 | C<klen> is the length of the key. If C<lval> is set then the fetch will be | |
1064 | part of a store. Check that the return value is non-null before | |
f4758303 | 1065 | dereferencing it to an C<SV*>. |
954c1994 | 1066 | |
96f1132b | 1067 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 GS |
1068 | information on how to use this function on tied hashes. |
1069 | ||
da58a35d | 1070 | SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval) |
954c1994 | 1071 | |
497711e7 GS |
1072 | =for hackers |
1073 | Found in file hv.c | |
1074 | ||
954c1994 GS |
1075 | =item hv_fetch_ent |
1076 | ||
1077 | Returns the hash entry which corresponds to the specified key in the hash. | |
1078 | C<hash> must be a valid precomputed hash number for the given C<key>, or 0 | |
1079 | if you want the function to compute it. IF C<lval> is set then the fetch | |
1080 | will be part of a store. Make sure the return value is non-null before | |
1081 | accessing it. The return value when C<tb> is a tied hash is a pointer to a | |
1082 | static location, so be sure to make a copy of the structure if you need to | |
1c846c1f | 1083 | store it somewhere. |
954c1994 | 1084 | |
96f1132b | 1085 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 GS |
1086 | information on how to use this function on tied hashes. |
1087 | ||
1088 | HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash) | |
1089 | ||
497711e7 GS |
1090 | =for hackers |
1091 | Found in file hv.c | |
1092 | ||
954c1994 GS |
1093 | =item hv_iterinit |
1094 | ||
1095 | Prepares a starting point to traverse a hash table. Returns the number of | |
1096 | keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is | |
1c846c1f | 1097 | currently only meaningful for hashes without tie magic. |
954c1994 GS |
1098 | |
1099 | NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of | |
1100 | hash buckets that happen to be in use. If you still need that esoteric | |
1101 | value, you can get it through the macro C<HvFILL(tb)>. | |
1102 | ||
641d4181 | 1103 | |
954c1994 GS |
1104 | I32 hv_iterinit(HV* tb) |
1105 | ||
497711e7 GS |
1106 | =for hackers |
1107 | Found in file hv.c | |
1108 | ||
954c1994 GS |
1109 | =item hv_iterkey |
1110 | ||
1111 | Returns the key from the current position of the hash iterator. See | |
1112 | C<hv_iterinit>. | |
1113 | ||
1114 | char* hv_iterkey(HE* entry, I32* retlen) | |
1115 | ||
497711e7 GS |
1116 | =for hackers |
1117 | Found in file hv.c | |
1118 | ||
954c1994 GS |
1119 | =item hv_iterkeysv |
1120 | ||
1121 | Returns the key as an C<SV*> from the current position of the hash | |
1122 | iterator. The return value will always be a mortal copy of the key. Also | |
1123 | see C<hv_iterinit>. | |
1124 | ||
1125 | SV* hv_iterkeysv(HE* entry) | |
1126 | ||
497711e7 GS |
1127 | =for hackers |
1128 | Found in file hv.c | |
1129 | ||
954c1994 GS |
1130 | =item hv_iternext |
1131 | ||
1132 | Returns entries from a hash iterator. See C<hv_iterinit>. | |
1133 | ||
641d4181 JH |
1134 | You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the |
1135 | iterator currently points to, without losing your place or invalidating your | |
1136 | iterator. Note that in this case the current entry is deleted from the hash | |
1137 | with your iterator holding the last reference to it. Your iterator is flagged | |
1138 | to free the entry on the next call to C<hv_iternext>, so you must not discard | |
1139 | your iterator immediately else the entry will leak - call C<hv_iternext> to | |
1140 | trigger the resource deallocation. | |
1141 | ||
954c1994 GS |
1142 | HE* hv_iternext(HV* tb) |
1143 | ||
497711e7 GS |
1144 | =for hackers |
1145 | Found in file hv.c | |
1146 | ||
954c1994 GS |
1147 | =item hv_iternextsv |
1148 | ||
1149 | Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one | |
1150 | operation. | |
1151 | ||
1152 | SV* hv_iternextsv(HV* hv, char** key, I32* retlen) | |
1153 | ||
497711e7 GS |
1154 | =for hackers |
1155 | Found in file hv.c | |
1156 | ||
641d4181 JH |
1157 | =item hv_iternext_flags |
1158 | ||
1159 | Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>. | |
1160 | The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is | |
1161 | set the placeholders keys (for restricted hashes) will be returned in addition | |
1162 | to normal keys. By default placeholders are automatically skipped over. | |
1163 | Currently a placeholder is implemented with a value that is literally | |
1164 | <&Perl_sv_undef> (a regular C<undef> value is a normal read-write SV for which | |
1165 | C<!SvOK> is false). Note that the implementation of placeholders and | |
1166 | restricted hashes may change, and the implementation currently is | |
1167 | insufficiently abstracted for any change to be tidy. | |
1168 | ||
1169 | NOTE: this function is experimental and may change or be | |
1170 | removed without notice. | |
1171 | ||
1172 | HE* hv_iternext_flags(HV* tb, I32 flags) | |
1173 | ||
1174 | =for hackers | |
1175 | Found in file hv.c | |
1176 | ||
954c1994 GS |
1177 | =item hv_iterval |
1178 | ||
1179 | Returns the value from the current position of the hash iterator. See | |
1180 | C<hv_iterkey>. | |
1181 | ||
1182 | SV* hv_iterval(HV* tb, HE* entry) | |
1183 | ||
497711e7 GS |
1184 | =for hackers |
1185 | Found in file hv.c | |
1186 | ||
954c1994 GS |
1187 | =item hv_magic |
1188 | ||
1189 | Adds magic to a hash. See C<sv_magic>. | |
1190 | ||
1191 | void hv_magic(HV* hv, GV* gv, int how) | |
1192 | ||
497711e7 GS |
1193 | =for hackers |
1194 | Found in file hv.c | |
1195 | ||
954c1994 GS |
1196 | =item hv_store |
1197 | ||
1198 | Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is | |
1199 | the length of the key. The C<hash> parameter is the precomputed hash | |
1200 | value; if it is zero then Perl will compute it. The return value will be | |
1201 | NULL if the operation failed or if the value did not need to be actually | |
1202 | stored within the hash (as in the case of tied hashes). Otherwise it can | |
1203 | be dereferenced to get the original C<SV*>. Note that the caller is | |
1204 | responsible for suitably incrementing the reference count of C<val> before | |
1c846c1f | 1205 | the call, and decrementing it if the function returned NULL. |
954c1994 | 1206 | |
96f1132b | 1207 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 GS |
1208 | information on how to use this function on tied hashes. |
1209 | ||
da58a35d | 1210 | SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash) |
954c1994 | 1211 | |
497711e7 GS |
1212 | =for hackers |
1213 | Found in file hv.c | |
1214 | ||
954c1994 GS |
1215 | =item hv_store_ent |
1216 | ||
1217 | Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash> | |
1218 | parameter is the precomputed hash value; if it is zero then Perl will | |
1219 | compute it. The return value is the new hash entry so created. It will be | |
1220 | NULL if the operation failed or if the value did not need to be actually | |
1221 | stored within the hash (as in the case of tied hashes). Otherwise the | |
f22d8e4b | 1222 | contents of the return value can be accessed using the C<He?> macros |
954c1994 GS |
1223 | described here. Note that the caller is responsible for suitably |
1224 | incrementing the reference count of C<val> before the call, and | |
1c846c1f | 1225 | decrementing it if the function returned NULL. |
954c1994 | 1226 | |
96f1132b | 1227 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 GS |
1228 | information on how to use this function on tied hashes. |
1229 | ||
1230 | HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash) | |
1231 | ||
497711e7 GS |
1232 | =for hackers |
1233 | Found in file hv.c | |
1234 | ||
954c1994 GS |
1235 | =item hv_undef |
1236 | ||
1237 | Undefines the hash. | |
1238 | ||
1239 | void hv_undef(HV* tb) | |
1240 | ||
497711e7 GS |
1241 | =for hackers |
1242 | Found in file hv.c | |
1243 | ||
94bdecf9 | 1244 | =item newHV |
d2cc3551 | 1245 | |
94bdecf9 | 1246 | Creates a new HV. The reference count is set to 1. |
d2cc3551 | 1247 | |
94bdecf9 | 1248 | HV* newHV() |
d2cc3551 JH |
1249 | |
1250 | =for hackers | |
94bdecf9 | 1251 | Found in file hv.c |
d2cc3551 | 1252 | |
94bdecf9 | 1253 | =item Nullhv |
954c1994 | 1254 | |
94bdecf9 | 1255 | Null HV pointer. |
954c1994 | 1256 | |
954c1994 | 1257 | |
497711e7 | 1258 | =for hackers |
94bdecf9 | 1259 | Found in file hv.h |
497711e7 | 1260 | |
954c1994 | 1261 | |
94bdecf9 | 1262 | =back |
954c1994 | 1263 | |
94bdecf9 | 1264 | =head1 Magical Functions |
954c1994 | 1265 | |
94bdecf9 | 1266 | =over 8 |
497711e7 | 1267 | |
94bdecf9 | 1268 | =item mg_clear |
954c1994 | 1269 | |
94bdecf9 | 1270 | Clear something magical that the SV represents. See C<sv_magic>. |
954c1994 | 1271 | |
94bdecf9 | 1272 | int mg_clear(SV* sv) |
954c1994 | 1273 | |
497711e7 | 1274 | =for hackers |
94bdecf9 | 1275 | Found in file mg.c |
497711e7 | 1276 | |
94bdecf9 | 1277 | =item mg_copy |
954c1994 | 1278 | |
94bdecf9 | 1279 | Copies the magic from one SV to another. See C<sv_magic>. |
954c1994 | 1280 | |
94bdecf9 | 1281 | int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen) |
954c1994 | 1282 | |
497711e7 | 1283 | =for hackers |
94bdecf9 | 1284 | Found in file mg.c |
497711e7 | 1285 | |
94bdecf9 | 1286 | =item mg_find |
954c1994 | 1287 | |
94bdecf9 | 1288 | Finds the magic pointer for type matching the SV. See C<sv_magic>. |
954c1994 | 1289 | |
94bdecf9 | 1290 | MAGIC* mg_find(SV* sv, int type) |
954c1994 | 1291 | |
497711e7 | 1292 | =for hackers |
94bdecf9 | 1293 | Found in file mg.c |
497711e7 | 1294 | |
94bdecf9 | 1295 | =item mg_free |
954c1994 | 1296 | |
94bdecf9 | 1297 | Free any magic storage used by the SV. See C<sv_magic>. |
954c1994 | 1298 | |
94bdecf9 | 1299 | int mg_free(SV* sv) |
954c1994 | 1300 | |
497711e7 | 1301 | =for hackers |
94bdecf9 | 1302 | Found in file mg.c |
497711e7 | 1303 | |
94bdecf9 | 1304 | =item mg_get |
eebe1485 | 1305 | |
94bdecf9 | 1306 | Do magic after a value is retrieved from the SV. See C<sv_magic>. |
282f25c9 | 1307 | |
94bdecf9 | 1308 | int mg_get(SV* sv) |
eebe1485 SC |
1309 | |
1310 | =for hackers | |
94bdecf9 | 1311 | Found in file mg.c |
eebe1485 | 1312 | |
94bdecf9 | 1313 | =item mg_length |
eebe1485 | 1314 | |
94bdecf9 | 1315 | Report on the SV's length. See C<sv_magic>. |
eebe1485 | 1316 | |
94bdecf9 | 1317 | U32 mg_length(SV* sv) |
eebe1485 SC |
1318 | |
1319 | =for hackers | |
94bdecf9 | 1320 | Found in file mg.c |
eebe1485 | 1321 | |
94bdecf9 | 1322 | =item mg_magical |
954c1994 | 1323 | |
94bdecf9 | 1324 | Turns on the magical status of an SV. See C<sv_magic>. |
954c1994 | 1325 | |
94bdecf9 | 1326 | void mg_magical(SV* sv) |
954c1994 | 1327 | |
497711e7 | 1328 | =for hackers |
94bdecf9 | 1329 | Found in file mg.c |
497711e7 | 1330 | |
94bdecf9 | 1331 | =item mg_set |
954c1994 | 1332 | |
94bdecf9 | 1333 | Do magic after a value is assigned to the SV. See C<sv_magic>. |
954c1994 | 1334 | |
94bdecf9 | 1335 | int mg_set(SV* sv) |
954c1994 | 1336 | |
497711e7 | 1337 | =for hackers |
94bdecf9 | 1338 | Found in file mg.c |
497711e7 | 1339 | |
94bdecf9 | 1340 | =item SvGETMAGIC |
954c1994 | 1341 | |
94bdecf9 JH |
1342 | Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its |
1343 | argument more than once. | |
954c1994 | 1344 | |
94bdecf9 | 1345 | void SvGETMAGIC(SV* sv) |
954c1994 | 1346 | |
497711e7 | 1347 | =for hackers |
94bdecf9 | 1348 | Found in file sv.h |
497711e7 | 1349 | |
a4f1a029 NIS |
1350 | =item SvLOCK |
1351 | ||
1352 | Arranges for a mutual exclusion lock to be obtained on sv if a suitable module | |
1353 | has been loaded. | |
1354 | ||
1355 | void SvLOCK(SV* sv) | |
1356 | ||
1357 | =for hackers | |
1358 | Found in file sv.h | |
1359 | ||
94bdecf9 | 1360 | =item SvSETMAGIC |
7d3fb230 | 1361 | |
94bdecf9 JH |
1362 | Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its |
1363 | argument more than once. | |
7d3fb230 | 1364 | |
94bdecf9 | 1365 | void SvSETMAGIC(SV* sv) |
7d3fb230 BS |
1366 | |
1367 | =for hackers | |
94bdecf9 | 1368 | Found in file sv.h |
7d3fb230 | 1369 | |
94bdecf9 | 1370 | =item SvSetMagicSV |
954c1994 | 1371 | |
94bdecf9 | 1372 | Like C<SvSetSV>, but does any set magic required afterwards. |
954c1994 | 1373 | |
94bdecf9 | 1374 | void SvSetMagicSV(SV* dsb, SV* ssv) |
954c1994 | 1375 | |
497711e7 | 1376 | =for hackers |
94bdecf9 | 1377 | Found in file sv.h |
497711e7 | 1378 | |
a4f1a029 NIS |
1379 | =item SvSetMagicSV_nosteal |
1380 | ||
1381 | Like C<SvSetMagicSV>, but does any set magic required afterwards. | |
1382 | ||
1383 | void SvSetMagicSV_nosteal(SV* dsv, SV* ssv) | |
1384 | ||
1385 | =for hackers | |
1386 | Found in file sv.h | |
1387 | ||
94bdecf9 | 1388 | =item SvSetSV |
954c1994 | 1389 | |
94bdecf9 JH |
1390 | Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments |
1391 | more than once. | |
1392 | ||
1393 | void SvSetSV(SV* dsb, SV* ssv) | |
954c1994 | 1394 | |
497711e7 | 1395 | =for hackers |
94bdecf9 | 1396 | Found in file sv.h |
497711e7 | 1397 | |
94bdecf9 | 1398 | =item SvSetSV_nosteal |
954c1994 | 1399 | |
94bdecf9 JH |
1400 | Calls a non-destructive version of C<sv_setsv> if dsv is not the same as |
1401 | ssv. May evaluate arguments more than once. | |
954c1994 | 1402 | |
94bdecf9 | 1403 | void SvSetSV_nosteal(SV* dsv, SV* ssv) |
954c1994 | 1404 | |
497711e7 | 1405 | =for hackers |
94bdecf9 | 1406 | Found in file sv.h |
497711e7 | 1407 | |
a4f1a029 NIS |
1408 | =item SvSHARE |
1409 | ||
1410 | Arranges for sv to be shared between threads if a suitable module | |
1411 | has been loaded. | |
1412 | ||
1413 | void SvSHARE(SV* sv) | |
1414 | ||
1415 | =for hackers | |
1416 | Found in file sv.h | |
1417 | ||
954c1994 | 1418 | |
94bdecf9 | 1419 | =back |
954c1994 | 1420 | |
94bdecf9 | 1421 | =head1 Memory Management |
954c1994 | 1422 | |
94bdecf9 | 1423 | =over 8 |
497711e7 | 1424 | |
94bdecf9 | 1425 | =item Copy |
954c1994 | 1426 | |
94bdecf9 JH |
1427 | The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the |
1428 | source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is | |
1429 | the type. May fail on overlapping copies. See also C<Move>. | |
954c1994 | 1430 | |
94bdecf9 | 1431 | void Copy(void* src, void* dest, int nitems, type) |
954c1994 | 1432 | |
497711e7 | 1433 | =for hackers |
94bdecf9 | 1434 | Found in file handy.h |
497711e7 | 1435 | |
94bdecf9 | 1436 | =item Move |
954c1994 | 1437 | |
94bdecf9 JH |
1438 | The XSUB-writer's interface to the C C<memmove> function. The C<src> is the |
1439 | source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is | |
1440 | the type. Can do overlapping moves. See also C<Copy>. | |
954c1994 | 1441 | |
94bdecf9 | 1442 | void Move(void* src, void* dest, int nitems, type) |
954c1994 | 1443 | |
497711e7 | 1444 | =for hackers |
94bdecf9 | 1445 | Found in file handy.h |
497711e7 | 1446 | |
94bdecf9 | 1447 | =item New |
954c1994 | 1448 | |
94bdecf9 | 1449 | The XSUB-writer's interface to the C C<malloc> function. |
954c1994 | 1450 | |
94bdecf9 | 1451 | void New(int id, void* ptr, int nitems, type) |
954c1994 | 1452 | |
497711e7 | 1453 | =for hackers |
94bdecf9 | 1454 | Found in file handy.h |
497711e7 | 1455 | |
94bdecf9 | 1456 | =item Newc |
954c1994 | 1457 | |
94bdecf9 JH |
1458 | The XSUB-writer's interface to the C C<malloc> function, with |
1459 | cast. | |
954c1994 | 1460 | |
94bdecf9 | 1461 | void Newc(int id, void* ptr, int nitems, type, cast) |
954c1994 | 1462 | |
497711e7 | 1463 | =for hackers |
94bdecf9 | 1464 | Found in file handy.h |
954c1994 | 1465 | |
94bdecf9 | 1466 | =item NEWSV |
497711e7 | 1467 | |
94bdecf9 JH |
1468 | Creates a new SV. A non-zero C<len> parameter indicates the number of |
1469 | bytes of preallocated string space the SV should have. An extra byte for a | |
1470 | tailing NUL is also reserved. (SvPOK is not set for the SV even if string | |
1471 | space is allocated.) The reference count for the new SV is set to 1. | |
1472 | C<id> is an integer id between 0 and 1299 (used to identify leaks). | |
954c1994 | 1473 | |
954c1994 | 1474 | |
94bdecf9 | 1475 | SV* NEWSV(int id, STRLEN len) |
954c1994 | 1476 | |
497711e7 | 1477 | =for hackers |
94bdecf9 | 1478 | Found in file handy.h |
497711e7 | 1479 | |
94bdecf9 | 1480 | =item Newz |
954c1994 | 1481 | |
94bdecf9 JH |
1482 | The XSUB-writer's interface to the C C<malloc> function. The allocated |
1483 | memory is zeroed with C<memzero>. | |
954c1994 | 1484 | |
94bdecf9 | 1485 | void Newz(int id, void* ptr, int nitems, type) |
954c1994 | 1486 | |
497711e7 GS |
1487 | =for hackers |
1488 | Found in file handy.h | |
1489 | ||
9965345d JH |
1490 | =item Poison |
1491 | ||
1492 | Fill up memory with a pattern (byte 0xAB over and over again) that | |
1493 | hopefully catches attempts to access uninitialized memory. | |
1494 | ||
1495 | void Poison(void* dest, int nitems, type) | |
1496 | ||
1497 | =for hackers | |
1498 | Found in file handy.h | |
1499 | ||
94bdecf9 | 1500 | =item Renew |
954c1994 | 1501 | |
94bdecf9 | 1502 | The XSUB-writer's interface to the C C<realloc> function. |
954c1994 | 1503 | |
94bdecf9 | 1504 | void Renew(void* ptr, int nitems, type) |
954c1994 | 1505 | |
497711e7 GS |
1506 | =for hackers |
1507 | Found in file handy.h | |
1508 | ||
94bdecf9 | 1509 | =item Renewc |
954c1994 | 1510 | |
94bdecf9 JH |
1511 | The XSUB-writer's interface to the C C<realloc> function, with |
1512 | cast. | |
954c1994 | 1513 | |
94bdecf9 | 1514 | void Renewc(void* ptr, int nitems, type, cast) |
954c1994 | 1515 | |
497711e7 | 1516 | =for hackers |
94bdecf9 | 1517 | Found in file handy.h |
497711e7 | 1518 | |
94bdecf9 | 1519 | =item Safefree |
954c1994 | 1520 | |
94bdecf9 | 1521 | The XSUB-writer's interface to the C C<free> function. |
954c1994 | 1522 | |
94bdecf9 | 1523 | void Safefree(void* ptr) |
954c1994 | 1524 | |
497711e7 GS |
1525 | =for hackers |
1526 | Found in file handy.h | |
1527 | ||
94bdecf9 | 1528 | =item savepv |
954c1994 | 1529 | |
641d4181 JH |
1530 | Perl's version of C<strdup()>. Returns a pointer to a newly allocated |
1531 | string which is a duplicate of C<pv>. The size of the string is | |
1532 | determined by C<strlen()>. The memory allocated for the new string can | |
1533 | be freed with the C<Safefree()> function. | |
954c1994 | 1534 | |
641d4181 | 1535 | char* savepv(const char* pv) |
954c1994 | 1536 | |
497711e7 | 1537 | =for hackers |
94bdecf9 | 1538 | Found in file util.c |
497711e7 | 1539 | |
94bdecf9 | 1540 | =item savepvn |
954c1994 | 1541 | |
641d4181 JH |
1542 | Perl's version of what C<strndup()> would be if it existed. Returns a |
1543 | pointer to a newly allocated string which is a duplicate of the first | |
1544 | C<len> bytes from C<pv>. The memory allocated for the new string can be | |
1545 | freed with the C<Safefree()> function. | |
954c1994 | 1546 | |
641d4181 | 1547 | char* savepvn(const char* pv, I32 len) |
954c1994 | 1548 | |
497711e7 | 1549 | =for hackers |
94bdecf9 | 1550 | Found in file util.c |
497711e7 | 1551 | |
a4f1a029 NIS |
1552 | =item savesharedpv |
1553 | ||
641d4181 JH |
1554 | A version of C<savepv()> which allocates the duplicate string in memory |
1555 | which is shared between threads. | |
a4f1a029 | 1556 | |
641d4181 | 1557 | char* savesharedpv(const char* pv) |
a4f1a029 NIS |
1558 | |
1559 | =for hackers | |
1560 | Found in file util.c | |
1561 | ||
94bdecf9 | 1562 | =item StructCopy |
954c1994 | 1563 | |
94bdecf9 | 1564 | This is an architecture-independent macro to copy one structure to another. |
954c1994 | 1565 | |
94bdecf9 | 1566 | void StructCopy(type src, type dest, type) |
954c1994 | 1567 | |
497711e7 | 1568 | =for hackers |
94bdecf9 | 1569 | Found in file handy.h |
497711e7 | 1570 | |
94bdecf9 | 1571 | =item Zero |
954c1994 | 1572 | |
94bdecf9 JH |
1573 | The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the |
1574 | destination, C<nitems> is the number of items, and C<type> is the type. | |
954c1994 | 1575 | |
94bdecf9 | 1576 | void Zero(void* dest, int nitems, type) |
954c1994 | 1577 | |
497711e7 | 1578 | =for hackers |
94bdecf9 | 1579 | Found in file handy.h |
497711e7 | 1580 | |
954c1994 | 1581 | |
94bdecf9 | 1582 | =back |
954c1994 | 1583 | |
94bdecf9 | 1584 | =head1 Miscellaneous Functions |
954c1994 | 1585 | |
94bdecf9 | 1586 | =over 8 |
497711e7 | 1587 | |
94bdecf9 | 1588 | =item fbm_compile |
8b4ac5a4 | 1589 | |
94bdecf9 JH |
1590 | Analyses the string in order to make fast searches on it using fbm_instr() |
1591 | -- the Boyer-Moore algorithm. | |
8b4ac5a4 | 1592 | |
94bdecf9 | 1593 | void fbm_compile(SV* sv, U32 flags) |
8b4ac5a4 JH |
1594 | |
1595 | =for hackers | |
94bdecf9 | 1596 | Found in file util.c |
8b4ac5a4 | 1597 | |
94bdecf9 | 1598 | =item fbm_instr |
954c1994 | 1599 | |
94bdecf9 JH |
1600 | Returns the location of the SV in the string delimited by C<str> and |
1601 | C<strend>. It returns C<Nullch> if the string can't be found. The C<sv> | |
1602 | does not have to be fbm_compiled, but the search will not be as fast | |
1603 | then. | |
954c1994 | 1604 | |
94bdecf9 | 1605 | char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags) |
954c1994 | 1606 | |
497711e7 | 1607 | =for hackers |
94bdecf9 | 1608 | Found in file util.c |
497711e7 | 1609 | |
94bdecf9 | 1610 | =item form |
954c1994 | 1611 | |
94bdecf9 JH |
1612 | Takes a sprintf-style format pattern and conventional |
1613 | (non-SV) arguments and returns the formatted string. | |
954c1994 | 1614 | |
94bdecf9 | 1615 | (char *) Perl_form(pTHX_ const char* pat, ...) |
954c1994 | 1616 | |
94bdecf9 | 1617 | can be used any place a string (char *) is required: |
497711e7 | 1618 | |
94bdecf9 | 1619 | char * s = Perl_form("%d.%d",major,minor); |
954c1994 | 1620 | |
94bdecf9 JH |
1621 | Uses a single private buffer so if you want to format several strings you |
1622 | must explicitly copy the earlier strings away (and free the copies when you | |
1623 | are done). | |
954c1994 | 1624 | |
94bdecf9 | 1625 | char* form(const char* pat, ...) |
954c1994 | 1626 | |
497711e7 | 1627 | =for hackers |
94bdecf9 | 1628 | Found in file util.c |
497711e7 | 1629 | |
94bdecf9 | 1630 | =item getcwd_sv |
954c1994 | 1631 | |
94bdecf9 | 1632 | Fill the sv with current working directory |
954c1994 | 1633 | |
94bdecf9 | 1634 | int getcwd_sv(SV* sv) |
954c1994 | 1635 | |
497711e7 | 1636 | =for hackers |
94bdecf9 | 1637 | Found in file util.c |
497711e7 | 1638 | |
94bdecf9 | 1639 | =item strEQ |
954c1994 | 1640 | |
94bdecf9 | 1641 | Test two strings to see if they are equal. Returns true or false. |
954c1994 | 1642 | |
94bdecf9 | 1643 | bool strEQ(char* s1, char* s2) |
954c1994 | 1644 | |
497711e7 | 1645 | =for hackers |
94bdecf9 | 1646 | Found in file handy.h |
497711e7 | 1647 | |
94bdecf9 | 1648 | =item strGE |
1c846c1f | 1649 | |
94bdecf9 JH |
1650 | Test two strings to see if the first, C<s1>, is greater than or equal to |
1651 | the second, C<s2>. Returns true or false. | |
1c846c1f | 1652 | |
94bdecf9 | 1653 | bool strGE(char* s1, char* s2) |
1c846c1f NIS |
1654 | |
1655 | =for hackers | |
94bdecf9 | 1656 | Found in file handy.h |
1c846c1f | 1657 | |
94bdecf9 | 1658 | =item strGT |
954c1994 | 1659 | |
94bdecf9 JH |
1660 | Test two strings to see if the first, C<s1>, is greater than the second, |
1661 | C<s2>. Returns true or false. | |
954c1994 | 1662 | |
94bdecf9 | 1663 | bool strGT(char* s1, char* s2) |
954c1994 | 1664 | |
497711e7 | 1665 | =for hackers |
94bdecf9 | 1666 | Found in file handy.h |
497711e7 | 1667 | |
94bdecf9 | 1668 | =item strLE |
954c1994 | 1669 | |
94bdecf9 JH |
1670 | Test two strings to see if the first, C<s1>, is less than or equal to the |
1671 | second, C<s2>. Returns true or false. | |
954c1994 | 1672 | |
94bdecf9 | 1673 | bool strLE(char* s1, char* s2) |
954c1994 | 1674 | |
497711e7 | 1675 | =for hackers |
94bdecf9 | 1676 | Found in file handy.h |
497711e7 | 1677 | |
94bdecf9 | 1678 | =item strLT |
1a3327fb | 1679 | |
94bdecf9 JH |
1680 | Test two strings to see if the first, C<s1>, is less than the second, |
1681 | C<s2>. Returns true or false. | |
1a3327fb | 1682 | |
94bdecf9 | 1683 | bool strLT(char* s1, char* s2) |
1a3327fb | 1684 | |
497711e7 | 1685 | =for hackers |
94bdecf9 | 1686 | Found in file handy.h |
497711e7 | 1687 | |
94bdecf9 | 1688 | =item strNE |
954c1994 | 1689 | |
94bdecf9 JH |
1690 | Test two strings to see if they are different. Returns true or |
1691 | false. | |
1692 | ||
1693 | bool strNE(char* s1, char* s2) | |
954c1994 | 1694 | |
497711e7 | 1695 | =for hackers |
94bdecf9 | 1696 | Found in file handy.h |
497711e7 | 1697 | |
94bdecf9 | 1698 | =item strnEQ |
954c1994 | 1699 | |
94bdecf9 JH |
1700 | Test two strings to see if they are equal. The C<len> parameter indicates |
1701 | the number of bytes to compare. Returns true or false. (A wrapper for | |
1702 | C<strncmp>). | |
1703 | ||
1704 | bool strnEQ(char* s1, char* s2, STRLEN len) | |
954c1994 | 1705 | |
497711e7 | 1706 | =for hackers |
94bdecf9 | 1707 | Found in file handy.h |
497711e7 | 1708 | |
94bdecf9 | 1709 | =item strnNE |
954c1994 | 1710 | |
94bdecf9 JH |
1711 | Test two strings to see if they are different. The C<len> parameter |
1712 | indicates the number of bytes to compare. Returns true or false. (A | |
1713 | wrapper for C<strncmp>). | |
954c1994 | 1714 | |
94bdecf9 | 1715 | bool strnNE(char* s1, char* s2, STRLEN len) |
954c1994 | 1716 | |
497711e7 GS |
1717 | =for hackers |
1718 | Found in file handy.h | |
1719 | ||
f4758303 | 1720 | |
94bdecf9 | 1721 | =back |
7207e29d | 1722 | |
94bdecf9 | 1723 | =head1 Numeric functions |
7207e29d | 1724 | |
94bdecf9 | 1725 | =over 8 |
f4758303 | 1726 | |
94bdecf9 | 1727 | =item grok_bin |
f4758303 | 1728 | |
94bdecf9 JH |
1729 | converts a string representing a binary number to numeric form. |
1730 | ||
1731 | On entry I<start> and I<*len> give the string to scan, I<*flags> gives | |
1732 | conversion flags, and I<result> should be NULL or a pointer to an NV. | |
1733 | The scan stops at the end of the string, or the first invalid character. | |
1734 | On return I<*len> is set to the length scanned string, and I<*flags> gives | |
1735 | output flags. | |
1736 | ||
1737 | If the value is <= UV_MAX it is returned as a UV, the output flags are clear, | |
1738 | and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin> | |
1739 | returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags, | |
1740 | and writes the value to I<*result> (or the value is discarded if I<result> | |
1741 | is NULL). | |
1742 | ||
1743 | The hex number may optionally be prefixed with "0b" or "b" unless | |
1744 | C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If | |
1745 | C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary | |
1746 | number may use '_' characters to separate digits. | |
1747 | ||
1748 | UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result) | |
f4758303 JP |
1749 | |
1750 | =for hackers | |
94bdecf9 | 1751 | Found in file numeric.c |
f4758303 | 1752 | |
94bdecf9 | 1753 | =item grok_hex |
954c1994 | 1754 | |
94bdecf9 JH |
1755 | converts a string representing a hex number to numeric form. |
1756 | ||
1757 | On entry I<start> and I<*len> give the string to scan, I<*flags> gives | |
1758 | conversion flags, and I<result> should be NULL or a pointer to an NV. | |
1759 | The scan stops at the end of the string, or the first non-hex-digit character. | |
1760 | On return I<*len> is set to the length scanned string, and I<*flags> gives | |
1761 | output flags. | |
1762 | ||
1763 | If the value is <= UV_MAX it is returned as a UV, the output flags are clear, | |
1764 | and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex> | |
1765 | returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags, | |
1766 | and writes the value to I<*result> (or the value is discarded if I<result> | |
1767 | is NULL). | |
1768 | ||
1769 | The hex number may optionally be prefixed with "0x" or "x" unless | |
1770 | C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If | |
1771 | C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex | |
1772 | number may use '_' characters to separate digits. | |
1773 | ||
1774 | UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result) | |
954c1994 | 1775 | |
497711e7 | 1776 | =for hackers |
94bdecf9 | 1777 | Found in file numeric.c |
497711e7 | 1778 | |
94bdecf9 | 1779 | =item grok_number |
954c1994 | 1780 | |
94bdecf9 JH |
1781 | Recognise (or not) a number. The type of the number is returned |
1782 | (0 if unrecognised), otherwise it is a bit-ORed combination of | |
1783 | IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT, | |
1784 | IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h). | |
1785 | ||
1786 | If the value of the number can fit an in UV, it is returned in the *valuep | |
1787 | IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV | |
1788 | will never be set unless *valuep is valid, but *valuep may have been assigned | |
1789 | to during processing even though IS_NUMBER_IN_UV is not set on return. | |
1790 | If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when | |
1791 | valuep is non-NULL, but no actual assignment (or SEGV) will occur. | |
1792 | ||
1793 | IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were | |
1794 | seen (in which case *valuep gives the true value truncated to an integer), and | |
1795 | IS_NUMBER_NEG if the number is negative (in which case *valuep holds the | |
1796 | absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the | |
1797 | number is larger than a UV. | |
1798 | ||
1799 | int grok_number(const char *pv, STRLEN len, UV *valuep) | |
954c1994 | 1800 | |
497711e7 | 1801 | =for hackers |
94bdecf9 | 1802 | Found in file numeric.c |
497711e7 | 1803 | |
94bdecf9 | 1804 | =item grok_numeric_radix |
954c1994 | 1805 | |
94bdecf9 JH |
1806 | Scan and skip for a numeric decimal separator (radix). |
1807 | ||
1808 | bool grok_numeric_radix(const char **sp, const char *send) | |
954c1994 | 1809 | |
497711e7 | 1810 | =for hackers |
94bdecf9 | 1811 | Found in file numeric.c |
497711e7 | 1812 | |
94bdecf9 | 1813 | =item grok_oct |
954c1994 | 1814 | |
94bdecf9 JH |
1815 | |
1816 | UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result) | |
954c1994 | 1817 | |
497711e7 | 1818 | =for hackers |
94bdecf9 | 1819 | Found in file numeric.c |
497711e7 | 1820 | |
94bdecf9 | 1821 | =item scan_bin |
954c1994 | 1822 | |
94bdecf9 JH |
1823 | For backwards compatibility. Use C<grok_bin> instead. |
1824 | ||
1825 | NV scan_bin(char* start, STRLEN len, STRLEN* retlen) | |
954c1994 | 1826 | |
497711e7 | 1827 | =for hackers |
94bdecf9 | 1828 | Found in file numeric.c |
497711e7 | 1829 | |
94bdecf9 | 1830 | =item scan_hex |
954c1994 | 1831 | |
94bdecf9 JH |
1832 | For backwards compatibility. Use C<grok_hex> instead. |
1833 | ||
1834 | NV scan_hex(char* start, STRLEN len, STRLEN* retlen) | |
954c1994 | 1835 | |
497711e7 | 1836 | =for hackers |
94bdecf9 | 1837 | Found in file numeric.c |
497711e7 | 1838 | |
94bdecf9 | 1839 | =item scan_oct |
954c1994 | 1840 | |
94bdecf9 | 1841 | For backwards compatibility. Use C<grok_oct> instead. |
954c1994 | 1842 | |
94bdecf9 | 1843 | NV scan_oct(char* start, STRLEN len, STRLEN* retlen) |
954c1994 | 1844 | |
497711e7 | 1845 | =for hackers |
94bdecf9 | 1846 | Found in file numeric.c |
497711e7 | 1847 | |
645c22ef | 1848 | |
94bdecf9 | 1849 | =back |
645c22ef | 1850 | |
94bdecf9 JH |
1851 | =head1 Optree Manipulation Functions |
1852 | ||
1853 | =over 8 | |
1854 | ||
1855 | =item cv_const_sv | |
1856 | ||
1857 | If C<cv> is a constant sub eligible for inlining. returns the constant | |
1858 | value returned by the sub. Otherwise, returns NULL. | |
1859 | ||
1860 | Constant subs can be created with C<newCONSTSUB> or as described in | |
1861 | L<perlsub/"Constant Functions">. | |
1862 | ||
1863 | SV* cv_const_sv(CV* cv) | |
645c22ef DM |
1864 | |
1865 | =for hackers | |
94bdecf9 | 1866 | Found in file op.c |
645c22ef | 1867 | |
94bdecf9 | 1868 | =item newCONSTSUB |
954c1994 | 1869 | |
94bdecf9 JH |
1870 | Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is |
1871 | eligible for inlining at compile-time. | |
954c1994 | 1872 | |
94bdecf9 | 1873 | CV* newCONSTSUB(HV* stash, char* name, SV* sv) |
954c1994 | 1874 | |
497711e7 | 1875 | =for hackers |
94bdecf9 | 1876 | Found in file op.c |
497711e7 | 1877 | |
94bdecf9 | 1878 | =item newXS |
954c1994 | 1879 | |
94bdecf9 | 1880 | Used by C<xsubpp> to hook up XSUBs as Perl subs. |
954c1994 | 1881 | |
94bdecf9 JH |
1882 | =for hackers |
1883 | Found in file op.c | |
1884 | ||
1885 | ||
1886 | =back | |
1887 | ||
dd2155a4 DM |
1888 | =head1 Pad Data Structures |
1889 | ||
1890 | =over 8 | |
1891 | ||
1892 | =item pad_sv | |
1893 | ||
1894 | Get the value at offset po in the current pad. | |
1895 | Use macro PAD_SV instead of calling this function directly. | |
1896 | ||
1897 | SV* pad_sv(PADOFFSET po) | |
1898 | ||
1899 | =for hackers | |
1900 | Found in file pad.c | |
1901 | ||
1902 | ||
1903 | =back | |
1904 | ||
94bdecf9 JH |
1905 | =head1 Stack Manipulation Macros |
1906 | ||
1907 | =over 8 | |
1908 | ||
1909 | =item dMARK | |
954c1994 | 1910 | |
94bdecf9 JH |
1911 | Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and |
1912 | C<dORIGMARK>. | |
954c1994 | 1913 | |
94bdecf9 | 1914 | dMARK; |
954c1994 | 1915 | |
497711e7 | 1916 | =for hackers |
94bdecf9 | 1917 | Found in file pp.h |
497711e7 | 1918 | |
94bdecf9 | 1919 | =item dORIGMARK |
954c1994 | 1920 | |
94bdecf9 | 1921 | Saves the original stack mark for the XSUB. See C<ORIGMARK>. |
954c1994 | 1922 | |
94bdecf9 | 1923 | dORIGMARK; |
954c1994 | 1924 | |
497711e7 | 1925 | =for hackers |
94bdecf9 | 1926 | Found in file pp.h |
497711e7 | 1927 | |
94bdecf9 | 1928 | =item dSP |
954c1994 | 1929 | |
94bdecf9 JH |
1930 | Declares a local copy of perl's stack pointer for the XSUB, available via |
1931 | the C<SP> macro. See C<SP>. | |
954c1994 | 1932 | |
94bdecf9 | 1933 | dSP; |
954c1994 | 1934 | |
497711e7 | 1935 | =for hackers |
94bdecf9 | 1936 | Found in file pp.h |
497711e7 | 1937 | |
94bdecf9 | 1938 | =item EXTEND |
954c1994 | 1939 | |
94bdecf9 JH |
1940 | Used to extend the argument stack for an XSUB's return values. Once |
1941 | used, guarantees that there is room for at least C<nitems> to be pushed | |
1942 | onto the stack. | |
954c1994 | 1943 | |
94bdecf9 | 1944 | void EXTEND(SP, int nitems) |
954c1994 | 1945 | |
497711e7 | 1946 | =for hackers |
94bdecf9 | 1947 | Found in file pp.h |
954c1994 | 1948 | |
94bdecf9 | 1949 | =item MARK |
954c1994 | 1950 | |
94bdecf9 | 1951 | Stack marker variable for the XSUB. See C<dMARK>. |
954c1994 | 1952 | |
497711e7 | 1953 | =for hackers |
94bdecf9 | 1954 | Found in file pp.h |
954c1994 | 1955 | |
94bdecf9 | 1956 | =item ORIGMARK |
954c1994 | 1957 | |
94bdecf9 | 1958 | The original stack mark for the XSUB. See C<dORIGMARK>. |
954c1994 | 1959 | |
497711e7 | 1960 | =for hackers |
94bdecf9 | 1961 | Found in file pp.h |
497711e7 | 1962 | |
954c1994 GS |
1963 | =item POPi |
1964 | ||
1965 | Pops an integer off the stack. | |
1966 | ||
1967 | IV POPi | |
1968 | ||
497711e7 GS |
1969 | =for hackers |
1970 | Found in file pp.h | |
1971 | ||
954c1994 GS |
1972 | =item POPl |
1973 | ||
1974 | Pops a long off the stack. | |
1975 | ||
1976 | long POPl | |
1977 | ||
497711e7 GS |
1978 | =for hackers |
1979 | Found in file pp.h | |
1980 | ||
954c1994 GS |
1981 | =item POPn |
1982 | ||
1983 | Pops a double off the stack. | |
1984 | ||
1985 | NV POPn | |
1986 | ||
497711e7 GS |
1987 | =for hackers |
1988 | Found in file pp.h | |
1989 | ||
954c1994 GS |
1990 | =item POPp |
1991 | ||
fa519979 JH |
1992 | Pops a string off the stack. Deprecated. New code should provide |
1993 | a STRLEN n_a and use POPpx. | |
954c1994 GS |
1994 | |
1995 | char* POPp | |
1996 | ||
497711e7 GS |
1997 | =for hackers |
1998 | Found in file pp.h | |
1999 | ||
fa519979 JH |
2000 | =item POPpbytex |
2001 | ||
2002 | Pops a string off the stack which must consist of bytes i.e. characters < 256. | |
2003 | Requires a variable STRLEN n_a in scope. | |
2004 | ||
2005 | char* POPpbytex | |
2006 | ||
2007 | =for hackers | |
2008 | Found in file pp.h | |
2009 | ||
2010 | =item POPpx | |
2011 | ||
2012 | Pops a string off the stack. | |
2013 | Requires a variable STRLEN n_a in scope. | |
2014 | ||
2015 | char* POPpx | |
2016 | ||
2017 | =for hackers | |
2018 | Found in file pp.h | |
2019 | ||
954c1994 GS |
2020 | =item POPs |
2021 | ||
2022 | Pops an SV off the stack. | |
2023 | ||
2024 | SV* POPs | |
2025 | ||
497711e7 GS |
2026 | =for hackers |
2027 | Found in file pp.h | |
2028 | ||
954c1994 GS |
2029 | =item PUSHi |
2030 | ||
2031 | Push an integer onto the stack. The stack must have room for this element. | |
2032 | Handles 'set' magic. See C<XPUSHi>. | |
2033 | ||
2034 | void PUSHi(IV iv) | |
2035 | ||
497711e7 GS |
2036 | =for hackers |
2037 | Found in file pp.h | |
2038 | ||
954c1994 GS |
2039 | =item PUSHMARK |
2040 | ||
2041 | Opening bracket for arguments on a callback. See C<PUTBACK> and | |
2042 | L<perlcall>. | |
2043 | ||
2044 | PUSHMARK; | |
2045 | ||
497711e7 GS |
2046 | =for hackers |
2047 | Found in file pp.h | |
2048 | ||
954c1994 GS |
2049 | =item PUSHn |
2050 | ||
2051 | Push a double onto the stack. The stack must have room for this element. | |
2052 | Handles 'set' magic. See C<XPUSHn>. | |
2053 | ||
2054 | void PUSHn(NV nv) | |
2055 | ||
497711e7 GS |
2056 | =for hackers |
2057 | Found in file pp.h | |
2058 | ||
954c1994 GS |
2059 | =item PUSHp |
2060 | ||
2061 | Push a string onto the stack. The stack must have room for this element. | |
2062 | The C<len> indicates the length of the string. Handles 'set' magic. See | |
2063 | C<XPUSHp>. | |
2064 | ||
2065 | void PUSHp(char* str, STRLEN len) | |
2066 | ||
497711e7 GS |
2067 | =for hackers |
2068 | Found in file pp.h | |
2069 | ||
954c1994 GS |
2070 | =item PUSHs |
2071 | ||
1c846c1f | 2072 | Push an SV onto the stack. The stack must have room for this element. |
954c1994 GS |
2073 | Does not handle 'set' magic. See C<XPUSHs>. |
2074 | ||
2075 | void PUSHs(SV* sv) | |
2076 | ||
497711e7 GS |
2077 | =for hackers |
2078 | Found in file pp.h | |
2079 | ||
954c1994 GS |
2080 | =item PUSHu |
2081 | ||
2082 | Push an unsigned integer onto the stack. The stack must have room for this | |
2083 | element. See C<XPUSHu>. | |
2084 | ||
2085 | void PUSHu(UV uv) | |
2086 | ||
497711e7 GS |
2087 | =for hackers |
2088 | Found in file pp.h | |
2089 | ||
954c1994 GS |
2090 | =item PUTBACK |
2091 | ||
2092 | Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>. | |
2093 | See C<PUSHMARK> and L<perlcall> for other uses. | |
2094 | ||
2095 | PUTBACK; | |
2096 | ||
497711e7 GS |
2097 | =for hackers |
2098 | Found in file pp.h | |
2099 | ||
94bdecf9 | 2100 | =item SP |
d2cc3551 | 2101 | |
94bdecf9 JH |
2102 | Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and |
2103 | C<SPAGAIN>. | |
d2cc3551 | 2104 | |
94bdecf9 JH |
2105 | =for hackers |
2106 | Found in file pp.h | |
2107 | ||
2108 | =item SPAGAIN | |
2109 | ||
2110 | Refetch the stack pointer. Used after a callback. See L<perlcall>. | |
2111 | ||
2112 | SPAGAIN; | |
d2cc3551 JH |
2113 | |
2114 | =for hackers | |
94bdecf9 | 2115 | Found in file pp.h |
d2cc3551 | 2116 | |
94bdecf9 | 2117 | =item XPUSHi |
954c1994 | 2118 | |
94bdecf9 JH |
2119 | Push an integer onto the stack, extending the stack if necessary. Handles |
2120 | 'set' magic. See C<PUSHi>. | |
954c1994 | 2121 | |
94bdecf9 | 2122 | void XPUSHi(IV iv) |
954c1994 | 2123 | |
497711e7 | 2124 | =for hackers |
94bdecf9 | 2125 | Found in file pp.h |
497711e7 | 2126 | |
94bdecf9 | 2127 | =item XPUSHn |
954c1994 | 2128 | |
94bdecf9 JH |
2129 | Push a double onto the stack, extending the stack if necessary. Handles |
2130 | 'set' magic. See C<PUSHn>. | |
954c1994 | 2131 | |
94bdecf9 | 2132 | void XPUSHn(NV nv) |
954c1994 | 2133 | |
497711e7 | 2134 | =for hackers |
94bdecf9 | 2135 | Found in file pp.h |
497711e7 | 2136 | |
94bdecf9 | 2137 | =item XPUSHp |
954c1994 | 2138 | |
94bdecf9 JH |
2139 | Push a string onto the stack, extending the stack if necessary. The C<len> |
2140 | indicates the length of the string. Handles 'set' magic. See | |
2141 | C<PUSHp>. | |
954c1994 | 2142 | |
94bdecf9 | 2143 | void XPUSHp(char* str, STRLEN len) |
954c1994 | 2144 | |
94bdecf9 JH |
2145 | =for hackers |
2146 | Found in file pp.h | |
2147 | ||
2148 | =item XPUSHs | |
2149 | ||
2150 | Push an SV onto the stack, extending the stack if necessary. Does not | |
2151 | handle 'set' magic. See C<PUSHs>. | |
2152 | ||
2153 | void XPUSHs(SV* sv) | |
954c1994 | 2154 | |
497711e7 | 2155 | =for hackers |
94bdecf9 | 2156 | Found in file pp.h |
497711e7 | 2157 | |
94bdecf9 | 2158 | =item XPUSHu |
954c1994 | 2159 | |
94bdecf9 JH |
2160 | Push an unsigned integer onto the stack, extending the stack if necessary. |
2161 | See C<PUSHu>. | |
954c1994 | 2162 | |
94bdecf9 JH |
2163 | void XPUSHu(UV uv) |
2164 | ||
2165 | =for hackers | |
2166 | Found in file pp.h | |
2167 | ||
2168 | =item XSRETURN | |
2169 | ||
2170 | Return from XSUB, indicating number of items on the stack. This is usually | |
2171 | handled by C<xsubpp>. | |
2172 | ||
2173 | void XSRETURN(int nitems) | |
954c1994 | 2174 | |
497711e7 GS |
2175 | =for hackers |
2176 | Found in file XSUB.h | |
2177 | ||
94bdecf9 | 2178 | =item XSRETURN_IV |
954c1994 | 2179 | |
94bdecf9 | 2180 | Return an integer from an XSUB immediately. Uses C<XST_mIV>. |
954c1994 | 2181 | |
94bdecf9 | 2182 | void XSRETURN_IV(IV iv) |
954c1994 | 2183 | |
497711e7 | 2184 | =for hackers |
94bdecf9 | 2185 | Found in file XSUB.h |
497711e7 | 2186 | |
94bdecf9 | 2187 | =item XSRETURN_NO |
954c1994 | 2188 | |
94bdecf9 | 2189 | Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>. |
954c1994 | 2190 | |
94bdecf9 | 2191 | XSRETURN_NO; |
954c1994 | 2192 | |
497711e7 | 2193 | =for hackers |
94bdecf9 | 2194 | Found in file XSUB.h |
497711e7 | 2195 | |
94bdecf9 | 2196 | =item XSRETURN_NV |
954c1994 | 2197 | |
94bdecf9 | 2198 | Return a double from an XSUB immediately. Uses C<XST_mNV>. |
954c1994 | 2199 | |
94bdecf9 | 2200 | void XSRETURN_NV(NV nv) |
954c1994 | 2201 | |
497711e7 | 2202 | =for hackers |
94bdecf9 JH |
2203 | Found in file XSUB.h |
2204 | ||
2205 | =item XSRETURN_PV | |
2206 | ||
2207 | Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>. | |
2208 | ||
2209 | void XSRETURN_PV(char* str) | |
2210 | ||
2211 | =for hackers | |
2212 | Found in file XSUB.h | |
2213 | ||
2214 | =item XSRETURN_UNDEF | |
2215 | ||
2216 | Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>. | |
2217 | ||
2218 | XSRETURN_UNDEF; | |
2219 | ||
2220 | =for hackers | |
2221 | Found in file XSUB.h | |
2222 | ||
2223 | =item XSRETURN_YES | |
2224 | ||
2225 | Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>. | |
2226 | ||
2227 | XSRETURN_YES; | |
2228 | ||
2229 | =for hackers | |
2230 | Found in file XSUB.h | |
2231 | ||
2232 | =item XST_mIV | |
2233 | ||
2234 | Place an integer into the specified position C<pos> on the stack. The | |
2235 | value is stored in a new mortal SV. | |
2236 | ||
2237 | void XST_mIV(int pos, IV iv) | |
2238 | ||
2239 | =for hackers | |
2240 | Found in file XSUB.h | |
2241 | ||
2242 | =item XST_mNO | |
2243 | ||
2244 | Place C<&PL_sv_no> into the specified position C<pos> on the | |
2245 | stack. | |
2246 | ||
2247 | void XST_mNO(int pos) | |
2248 | ||
2249 | =for hackers | |
2250 | Found in file XSUB.h | |
2251 | ||
2252 | =item XST_mNV | |
2253 | ||
2254 | Place a double into the specified position C<pos> on the stack. The value | |
2255 | is stored in a new mortal SV. | |
2256 | ||
2257 | void XST_mNV(int pos, NV nv) | |
2258 | ||
2259 | =for hackers | |
2260 | Found in file XSUB.h | |
2261 | ||
2262 | =item XST_mPV | |
2263 | ||
2264 | Place a copy of a string into the specified position C<pos> on the stack. | |
2265 | The value is stored in a new mortal SV. | |
2266 | ||
2267 | void XST_mPV(int pos, char* str) | |
2268 | ||
2269 | =for hackers | |
2270 | Found in file XSUB.h | |
2271 | ||
2272 | =item XST_mUNDEF | |
2273 | ||
2274 | Place C<&PL_sv_undef> into the specified position C<pos> on the | |
2275 | stack. | |
2276 | ||
2277 | void XST_mUNDEF(int pos) | |
2278 | ||
2279 | =for hackers | |
2280 | Found in file XSUB.h | |
2281 | ||
2282 | =item XST_mYES | |
2283 | ||
2284 | Place C<&PL_sv_yes> into the specified position C<pos> on the | |
2285 | stack. | |
2286 | ||
2287 | void XST_mYES(int pos) | |
2288 | ||
2289 | =for hackers | |
2290 | Found in file XSUB.h | |
2291 | ||
2292 | ||
2293 | =back | |
2294 | ||
2295 | =head1 SV Flags | |
497711e7 | 2296 | |
94bdecf9 | 2297 | =over 8 |
954c1994 | 2298 | |
94bdecf9 | 2299 | =item svtype |
954c1994 | 2300 | |
94bdecf9 JH |
2301 | An enum of flags for Perl types. These are found in the file B<sv.h> |
2302 | in the C<svtype> enum. Test these flags with the C<SvTYPE> macro. | |
954c1994 | 2303 | |
497711e7 | 2304 | =for hackers |
94bdecf9 | 2305 | Found in file sv.h |
6e9d1081 | 2306 | |
94bdecf9 | 2307 | =item SVt_IV |
6e9d1081 | 2308 | |
94bdecf9 | 2309 | Integer type flag for scalars. See C<svtype>. |
6e9d1081 NC |
2310 | |
2311 | =for hackers | |
94bdecf9 | 2312 | Found in file sv.h |
6e9d1081 | 2313 | |
94bdecf9 | 2314 | =item SVt_NV |
6e9d1081 | 2315 | |
94bdecf9 | 2316 | Double type flag for scalars. See C<svtype>. |
6e9d1081 NC |
2317 | |
2318 | =for hackers | |
94bdecf9 | 2319 | Found in file sv.h |
6e9d1081 | 2320 | |
94bdecf9 | 2321 | =item SVt_PV |
6e9d1081 | 2322 | |
94bdecf9 | 2323 | Pointer type flag for scalars. See C<svtype>. |
6e9d1081 NC |
2324 | |
2325 | =for hackers | |
94bdecf9 | 2326 | Found in file sv.h |
cd1ee231 | 2327 | |
94bdecf9 | 2328 | =item SVt_PVAV |
cd1ee231 | 2329 | |
94bdecf9 | 2330 | Type flag for arrays. See C<svtype>. |
cd1ee231 JH |
2331 | |
2332 | =for hackers | |
94bdecf9 | 2333 | Found in file sv.h |
cd1ee231 | 2334 | |
94bdecf9 | 2335 | =item SVt_PVCV |
cd1ee231 | 2336 | |
94bdecf9 | 2337 | Type flag for code refs. See C<svtype>. |
cd1ee231 JH |
2338 | |
2339 | =for hackers | |
94bdecf9 | 2340 | Found in file sv.h |
cd1ee231 | 2341 | |
94bdecf9 | 2342 | =item SVt_PVHV |
cd1ee231 | 2343 | |
94bdecf9 | 2344 | Type flag for hashes. See C<svtype>. |
cd1ee231 JH |
2345 | |
2346 | =for hackers | |
94bdecf9 | 2347 | Found in file sv.h |
cd1ee231 | 2348 | |
94bdecf9 | 2349 | =item SVt_PVMG |
cd1ee231 | 2350 | |
94bdecf9 | 2351 | Type flag for blessed scalars. See C<svtype>. |
cd1ee231 JH |
2352 | |
2353 | =for hackers | |
94bdecf9 | 2354 | Found in file sv.h |
cd1ee231 | 2355 | |
cd1ee231 | 2356 | |
94bdecf9 | 2357 | =back |
cd1ee231 | 2358 | |
94bdecf9 | 2359 | =head1 SV Manipulation Functions |
cd1ee231 | 2360 | |
94bdecf9 | 2361 | =over 8 |
cd1ee231 | 2362 | |
94bdecf9 | 2363 | =item get_sv |
cd1ee231 | 2364 | |
94bdecf9 JH |
2365 | Returns the SV of the specified Perl scalar. If C<create> is set and the |
2366 | Perl variable does not exist then it will be created. If C<create> is not | |
2367 | set and the variable does not exist then NULL is returned. | |
2368 | ||
2369 | NOTE: the perl_ form of this function is deprecated. | |
2370 | ||
2371 | SV* get_sv(const char* name, I32 create) | |
cd1ee231 JH |
2372 | |
2373 | =for hackers | |
94bdecf9 | 2374 | Found in file perl.c |
cd1ee231 | 2375 | |
94bdecf9 | 2376 | =item looks_like_number |
cd1ee231 | 2377 | |
94bdecf9 JH |
2378 | Test if the content of an SV looks like a number (or is a number). |
2379 | C<Inf> and C<Infinity> are treated as numbers (so will not issue a | |
2380 | non-numeric warning), even if your atof() doesn't grok them. | |
cd1ee231 | 2381 | |
94bdecf9 | 2382 | I32 looks_like_number(SV* sv) |
cd1ee231 JH |
2383 | |
2384 | =for hackers | |
94bdecf9 | 2385 | Found in file sv.c |
2a5a0c38 | 2386 | |
94bdecf9 | 2387 | =item newRV_inc |
2a5a0c38 | 2388 | |
94bdecf9 JH |
2389 | Creates an RV wrapper for an SV. The reference count for the original SV is |
2390 | incremented. | |
2a5a0c38 | 2391 | |
94bdecf9 | 2392 | SV* newRV_inc(SV* sv) |
2a5a0c38 JH |
2393 | |
2394 | =for hackers | |
94bdecf9 | 2395 | Found in file sv.h |
2a5a0c38 | 2396 | |
94bdecf9 | 2397 | =item newRV_noinc |
954c1994 | 2398 | |
94bdecf9 JH |
2399 | Creates an RV wrapper for an SV. The reference count for the original |
2400 | SV is B<not> incremented. | |
2401 | ||
2402 | SV* newRV_noinc(SV *sv) | |
954c1994 | 2403 | |
497711e7 | 2404 | =for hackers |
94bdecf9 | 2405 | Found in file sv.c |
497711e7 | 2406 | |
94bdecf9 | 2407 | =item newSV |
954c1994 | 2408 | |
94bdecf9 JH |
2409 | Create a new null SV, or if len > 0, create a new empty SVt_PV type SV |
2410 | with an initial PV allocation of len+1. Normally accessed via the C<NEWSV> | |
2411 | macro. | |
954c1994 | 2412 | |
94bdecf9 | 2413 | SV* newSV(STRLEN len) |
954c1994 | 2414 | |
497711e7 | 2415 | =for hackers |
94bdecf9 | 2416 | Found in file sv.c |
497711e7 | 2417 | |
94bdecf9 | 2418 | =item newSViv |
954c1994 | 2419 | |
94bdecf9 JH |
2420 | Creates a new SV and copies an integer into it. The reference count for the |
2421 | SV is set to 1. | |
954c1994 | 2422 | |
94bdecf9 | 2423 | SV* newSViv(IV i) |
954c1994 | 2424 | |
497711e7 | 2425 | =for hackers |
94bdecf9 | 2426 | Found in file sv.c |
497711e7 | 2427 | |
94bdecf9 | 2428 | =item newSVnv |
954c1994 | 2429 | |
94bdecf9 JH |
2430 | Creates a new SV and copies a floating point value into it. |
2431 | The reference count for the SV is set to 1. | |
954c1994 | 2432 | |
94bdecf9 | 2433 | SV* newSVnv(NV n) |
954c1994 | 2434 | |
497711e7 | 2435 | =for hackers |
94bdecf9 | 2436 | Found in file sv.c |
497711e7 | 2437 | |
94bdecf9 | 2438 | =item newSVpv |
954c1994 | 2439 | |
94bdecf9 JH |
2440 | Creates a new SV and copies a string into it. The reference count for the |
2441 | SV is set to 1. If C<len> is zero, Perl will compute the length using | |
2442 | strlen(). For efficiency, consider using C<newSVpvn> instead. | |
954c1994 | 2443 | |
94bdecf9 | 2444 | SV* newSVpv(const char* s, STRLEN len) |
954c1994 | 2445 | |
497711e7 | 2446 | =for hackers |
94bdecf9 | 2447 | Found in file sv.c |
497711e7 | 2448 | |
94bdecf9 | 2449 | =item newSVpvf |
954c1994 | 2450 | |
94bdecf9 JH |
2451 | Creates a new SV and initializes it with the string formatted like |
2452 | C<sprintf>. | |
954c1994 | 2453 | |
94bdecf9 | 2454 | SV* newSVpvf(const char* pat, ...) |
954c1994 | 2455 | |
497711e7 | 2456 | =for hackers |
94bdecf9 | 2457 | Found in file sv.c |
497711e7 | 2458 | |
94bdecf9 | 2459 | =item newSVpvn |
954c1994 | 2460 | |
94bdecf9 JH |
2461 | Creates a new SV and copies a string into it. The reference count for the |
2462 | SV is set to 1. Note that if C<len> is zero, Perl will create a zero length | |
2463 | string. You are responsible for ensuring that the source string is at least | |
2464 | C<len> bytes long. | |
954c1994 | 2465 | |
94bdecf9 | 2466 | SV* newSVpvn(const char* s, STRLEN len) |
954c1994 | 2467 | |
497711e7 | 2468 | =for hackers |
94bdecf9 | 2469 | Found in file sv.c |
497711e7 | 2470 | |
94bdecf9 | 2471 | =item newSVpvn_share |
954c1994 | 2472 | |
94bdecf9 JH |
2473 | Creates a new SV with its SvPVX pointing to a shared string in the string |
2474 | table. If the string does not already exist in the table, it is created | |
2475 | first. Turns on READONLY and FAKE. The string's hash is stored in the UV | |
2476 | slot of the SV; if the C<hash> parameter is non-zero, that value is used; | |
2477 | otherwise the hash is computed. The idea here is that as the string table | |
2478 | is used for shared hash keys these strings will have SvPVX == HeKEY and | |
2479 | hash lookup will avoid string compare. | |
954c1994 | 2480 | |
94bdecf9 | 2481 | SV* newSVpvn_share(const char* s, I32 len, U32 hash) |
954c1994 | 2482 | |
497711e7 | 2483 | =for hackers |
94bdecf9 | 2484 | Found in file sv.c |
497711e7 | 2485 | |
94bdecf9 | 2486 | =item newSVrv |
954c1994 | 2487 | |
94bdecf9 JH |
2488 | Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then |
2489 | it will be upgraded to one. If C<classname> is non-null then the new SV will | |
2490 | be blessed in the specified package. The new SV is returned and its | |
2491 | reference count is 1. | |
954c1994 | 2492 | |
94bdecf9 | 2493 | SV* newSVrv(SV* rv, const char* classname) |
954c1994 | 2494 | |
497711e7 | 2495 | =for hackers |
94bdecf9 | 2496 | Found in file sv.c |
497711e7 | 2497 | |
94bdecf9 | 2498 | =item newSVsv |
954c1994 | 2499 | |
94bdecf9 JH |
2500 | Creates a new SV which is an exact duplicate of the original SV. |
2501 | (Uses C<sv_setsv>). | |
954c1994 | 2502 | |
94bdecf9 | 2503 | SV* newSVsv(SV* old) |
954c1994 | 2504 | |
497711e7 | 2505 | =for hackers |
94bdecf9 | 2506 | Found in file sv.c |
497711e7 | 2507 | |
94bdecf9 | 2508 | =item newSVuv |
954c1994 | 2509 | |
94bdecf9 JH |
2510 | Creates a new SV and copies an unsigned integer into it. |
2511 | The reference count for the SV is set to 1. | |
954c1994 | 2512 | |
94bdecf9 | 2513 | SV* newSVuv(UV u) |
954c1994 | 2514 | |
497711e7 | 2515 | =for hackers |
94bdecf9 | 2516 | Found in file sv.c |
497711e7 | 2517 | |
b0f01acb JP |
2518 | =item new_version |
2519 | ||
2520 | Returns a new version object based on the passed in SV: | |
2521 | ||
2522 | SV *sv = new_version(SV *ver); | |
2523 | ||
2524 | Does not alter the passed in ver SV. See "upg_version" if you | |
2525 | want to upgrade the SV. | |
2526 | ||
2527 | SV* new_version(SV *ver) | |
2528 | ||
2529 | =for hackers | |
2530 | Found in file util.c | |
2531 | ||
2532 | =item scan_version | |
2533 | ||
2534 | Returns a pointer to the next character after the parsed | |
2535 | version string, as well as upgrading the passed in SV to | |
2536 | an RV. | |
2537 | ||
2538 | Function must be called with an already existing SV like | |
2539 | ||
2540 | sv = NEWSV(92,0); | |
2541 | s = scan_version(s,sv); | |
2542 | ||
2543 | Performs some preprocessing to the string to ensure that | |
2544 | it has the correct characteristics of a version. Flags the | |
2545 | object if it contains an underscore (which denotes this | |
2546 | is a beta version). | |
2547 | ||
2548 | char* scan_version(char *vstr, SV *sv) | |
2549 | ||
2550 | =for hackers | |
2551 | Found in file util.c | |
2552 | ||
2553 | =item scan_vstring | |
954c1994 | 2554 | |
94bdecf9 JH |
2555 | Returns a pointer to the next character after the parsed |
2556 | vstring, as well as updating the passed in sv. | |
954c1994 | 2557 | |
94bdecf9 JH |
2558 | Function must be called like |
2559 | ||
b0f01acb JP |
2560 | sv = NEWSV(92,5); |
2561 | s = scan_vstring(s,sv); | |
94bdecf9 | 2562 | |
b0f01acb JP |
2563 | The sv should already be large enough to store the vstring |
2564 | passed in, for performance reasons. | |
94bdecf9 | 2565 | |
b0f01acb | 2566 | char* scan_vstring(char *vstr, SV *sv) |
954c1994 | 2567 | |
497711e7 | 2568 | =for hackers |
94bdecf9 | 2569 | Found in file util.c |
497711e7 | 2570 | |
954c1994 GS |
2571 | =item SvCUR |
2572 | ||
2573 | Returns the length of the string which is in the SV. See C<SvLEN>. | |
2574 | ||
2575 | STRLEN SvCUR(SV* sv) | |
2576 | ||
497711e7 GS |
2577 | =for hackers |
2578 | Found in file sv.h | |
2579 | ||
954c1994 GS |
2580 | =item SvCUR_set |
2581 | ||
2582 | Set the length of the string which is in the SV. See C<SvCUR>. | |
2583 | ||
2584 | void SvCUR_set(SV* sv, STRLEN len) | |
2585 | ||
497711e7 GS |
2586 | =for hackers |
2587 | Found in file sv.h | |
2588 | ||
94bdecf9 | 2589 | =item SvEND |
954c1994 | 2590 | |
94bdecf9 JH |
2591 | Returns a pointer to the last character in the string which is in the SV. |
2592 | See C<SvCUR>. Access the character as *(SvEND(sv)). | |
954c1994 | 2593 | |
94bdecf9 | 2594 | char* SvEND(SV* sv) |
954c1994 | 2595 | |
497711e7 GS |
2596 | =for hackers |
2597 | Found in file sv.h | |
2598 | ||
954c1994 GS |
2599 | =item SvGROW |
2600 | ||
2601 | Expands the character buffer in the SV so that it has room for the | |
2602 | indicated number of bytes (remember to reserve space for an extra trailing | |
8cf8f3d1 | 2603 | NUL character). Calls C<sv_grow> to perform the expansion if necessary. |
954c1994 GS |
2604 | Returns a pointer to the character buffer. |
2605 | ||
679ac26e | 2606 | char * SvGROW(SV* sv, STRLEN len) |
954c1994 | 2607 | |
497711e7 GS |
2608 | =for hackers |
2609 | Found in file sv.h | |
2610 | ||
954c1994 GS |
2611 | =item SvIOK |
2612 | ||
2613 | Returns a boolean indicating whether the SV contains an integer. | |
2614 | ||
2615 | bool SvIOK(SV* sv) | |
2616 | ||
497711e7 GS |
2617 | =for hackers |
2618 | Found in file sv.h | |
2619 | ||
954c1994 GS |
2620 | =item SvIOKp |
2621 | ||
2622 | Returns a boolean indicating whether the SV contains an integer. Checks | |
2623 | the B<private> setting. Use C<SvIOK>. | |
2624 | ||
2625 | bool SvIOKp(SV* sv) | |
2626 | ||
497711e7 GS |
2627 | =for hackers |
2628 | Found in file sv.h | |
2629 | ||
e331fc52 JH |
2630 | =item SvIOK_notUV |
2631 | ||
f4758303 | 2632 | Returns a boolean indicating whether the SV contains a signed integer. |
e331fc52 JH |
2633 | |
2634 | void SvIOK_notUV(SV* sv) | |
2635 | ||
2636 | =for hackers | |
2637 | Found in file sv.h | |
2638 | ||
954c1994 GS |
2639 | =item SvIOK_off |
2640 | ||
2641 | Unsets the IV status of an SV. | |
2642 | ||
2643 | void SvIOK_off(SV* sv) | |
2644 | ||
497711e7 GS |
2645 | =for hackers |
2646 | Found in file sv.h | |
2647 | ||
954c1994 GS |
2648 | =item SvIOK_on |
2649 | ||
2650 | Tells an SV that it is an integer. | |
2651 | ||
2652 | void SvIOK_on(SV* sv) | |
2653 | ||
497711e7 GS |
2654 | =for hackers |
2655 | Found in file sv.h | |
2656 | ||
954c1994 GS |
2657 | =item SvIOK_only |
2658 | ||
2659 | Tells an SV that it is an integer and disables all other OK bits. | |
2660 | ||
2661 | void SvIOK_only(SV* sv) | |
2662 | ||
497711e7 GS |
2663 | =for hackers |
2664 | Found in file sv.h | |
2665 | ||
e331fc52 JH |
2666 | =item SvIOK_only_UV |
2667 | ||
2668 | Tells and SV that it is an unsigned integer and disables all other OK bits. | |
2669 | ||
2670 | void SvIOK_only_UV(SV* sv) | |
2671 | ||
2672 | =for hackers | |
2673 | Found in file sv.h | |
2674 | ||
2675 | =item SvIOK_UV | |
2676 | ||
2677 | Returns a boolean indicating whether the SV contains an unsigned integer. | |
2678 | ||
2679 | void SvIOK_UV(SV* sv) | |
2680 | ||
2681 | =for hackers | |
2682 | Found in file sv.h | |
2683 | ||
954c1994 GS |
2684 | =item SvIV |
2685 | ||
645c22ef DM |
2686 | Coerces the given SV to an integer and returns it. See C<SvIVx> for a |
2687 | version which guarantees to evaluate sv only once. | |
954c1994 GS |
2688 | |
2689 | IV SvIV(SV* sv) | |
2690 | ||
497711e7 GS |
2691 | =for hackers |
2692 | Found in file sv.h | |
2693 | ||
baca2b92 | 2694 | =item SvIVx |
954c1994 | 2695 | |
baca2b92 DM |
2696 | Coerces the given SV to an integer and returns it. Guarantees to evaluate |
2697 | sv only once. Use the more efficient C<SvIV> otherwise. | |
954c1994 | 2698 | |
baca2b92 | 2699 | IV SvIVx(SV* sv) |
954c1994 | 2700 | |
497711e7 GS |
2701 | =for hackers |
2702 | Found in file sv.h | |
2703 | ||
baca2b92 | 2704 | =item SvIVX |
645c22ef | 2705 | |
baca2b92 DM |
2706 | Returns the raw value in the SV's IV slot, without checks or conversions. |
2707 | Only use when you are sure SvIOK is true. See also C<SvIV()>. | |
645c22ef | 2708 | |
baca2b92 | 2709 | IV SvIVX(SV* sv) |
645c22ef DM |
2710 | |
2711 | =for hackers | |
2712 | Found in file sv.h | |
2713 | ||
954c1994 GS |
2714 | =item SvLEN |
2715 | ||
91e74348 JH |
2716 | Returns the size of the string buffer in the SV, not including any part |
2717 | attributable to C<SvOOK>. See C<SvCUR>. | |
954c1994 GS |
2718 | |
2719 | STRLEN SvLEN(SV* sv) | |
2720 | ||
497711e7 GS |
2721 | =for hackers |
2722 | Found in file sv.h | |
2723 | ||
954c1994 GS |
2724 | =item SvNIOK |
2725 | ||
2726 | Returns a boolean indicating whether the SV contains a number, integer or | |
2727 | double. | |
2728 | ||
2729 | bool SvNIOK(SV* sv) | |
2730 | ||
497711e7 GS |
2731 | =for hackers |
2732 | Found in file sv.h | |
2733 | ||
954c1994 GS |
2734 | =item SvNIOKp |
2735 | ||
2736 | Returns a boolean indicating whether the SV contains a number, integer or | |
2737 | double. Checks the B<private> setting. Use C<SvNIOK>. | |
2738 | ||
2739 | bool SvNIOKp(SV* sv) | |
2740 | ||
497711e7 GS |
2741 | =for hackers |
2742 | Found in file sv.h | |
2743 | ||
954c1994 GS |
2744 | =item SvNIOK_off |
2745 | ||
2746 | Unsets the NV/IV status of an SV. | |
2747 | ||
2748 | void SvNIOK_off(SV* sv) | |
2749 | ||
497711e7 GS |
2750 | =for hackers |
2751 | Found in file sv.h | |
2752 | ||
954c1994 GS |
2753 | =item SvNOK |
2754 | ||
2755 | Returns a boolean indicating whether the SV contains a double. | |
2756 | ||
2757 | bool SvNOK(SV* sv) | |
2758 | ||
497711e7 GS |
2759 | =for hackers |
2760 | Found in file sv.h | |
2761 | ||
954c1994 GS |
2762 | =item SvNOKp |
2763 | ||
2764 | Returns a boolean indicating whether the SV contains a double. Checks the | |
2765 | B<private> setting. Use C<SvNOK>. | |
2766 | ||
2767 | bool SvNOKp(SV* sv) | |
2768 | ||
497711e7 GS |
2769 | =for hackers |
2770 | Found in file sv.h | |
2771 | ||
954c1994 GS |
2772 | =item SvNOK_off |
2773 | ||
2774 | Unsets the NV status of an SV. | |
2775 | ||
2776 | void SvNOK_off(SV* sv) | |
2777 | ||
497711e7 GS |
2778 | =for hackers |
2779 | Found in file sv.h | |
2780 | ||
954c1994 GS |
2781 | =item SvNOK_on |
2782 | ||
2783 | Tells an SV that it is a double. | |
2784 | ||
2785 | void SvNOK_on(SV* sv) | |
2786 | ||
497711e7 GS |
2787 | =for hackers |
2788 | Found in file sv.h | |
2789 | ||
954c1994 GS |
2790 | =item SvNOK_only |
2791 | ||
2792 | Tells an SV that it is a double and disables all other OK bits. | |
2793 | ||
2794 | void SvNOK_only(SV* sv) | |
2795 | ||
497711e7 GS |
2796 | =for hackers |
2797 | Found in file sv.h | |
2798 | ||
954c1994 GS |
2799 | =item SvNV |
2800 | ||
645c22ef DM |
2801 | Coerce the given SV to a double and return it. See C<SvNVx> for a version |
2802 | which guarantees to evaluate sv only once. | |
954c1994 GS |
2803 | |
2804 | NV SvNV(SV* sv) | |
2805 | ||
497711e7 GS |
2806 | =for hackers |
2807 | Found in file sv.h | |
2808 | ||
baca2b92 | 2809 | =item SvNVX |
645c22ef | 2810 | |
baca2b92 DM |
2811 | Returns the raw value in the SV's NV slot, without checks or conversions. |
2812 | Only use when you are sure SvNOK is true. See also C<SvNV()>. | |
645c22ef | 2813 | |
baca2b92 | 2814 | NV SvNVX(SV* sv) |
645c22ef DM |
2815 | |
2816 | =for hackers | |
2817 | Found in file sv.h | |
2818 | ||
baca2b92 | 2819 | =item SvNVx |
954c1994 | 2820 | |
baca2b92 DM |
2821 | Coerces the given SV to a double and returns it. Guarantees to evaluate |
2822 | sv only once. Use the more efficient C<SvNV> otherwise. | |
954c1994 | 2823 | |
baca2b92 | 2824 | NV SvNVx(SV* sv) |
954c1994 | 2825 | |
497711e7 GS |
2826 | =for hackers |
2827 | Found in file sv.h | |
2828 | ||
954c1994 GS |
2829 | =item SvOK |
2830 | ||
2831 | Returns a boolean indicating whether the value is an SV. | |
2832 | ||
2833 | bool SvOK(SV* sv) | |
2834 | ||
497711e7 GS |
2835 | =for hackers |
2836 | Found in file sv.h | |
2837 | ||
954c1994 GS |
2838 | =item SvOOK |
2839 | ||
2840 | Returns a boolean indicating whether the SvIVX is a valid offset value for | |
2841 | the SvPVX. This hack is used internally to speed up removal of characters | |
2842 | from the beginning of a SvPV. When SvOOK is true, then the start of the | |
2843 | allocated string buffer is really (SvPVX - SvIVX). | |
2844 | ||
2845 | bool SvOOK(SV* sv) | |
2846 | ||
497711e7 GS |
2847 | =for hackers |
2848 | Found in file sv.h | |
2849 | ||
954c1994 GS |
2850 | =item SvPOK |
2851 | ||
2852 | Returns a boolean indicating whether the SV contains a character | |
2853 | string. | |
2854 | ||
2855 | bool SvPOK(SV* sv) | |
2856 | ||
497711e7 GS |
2857 | =for hackers |
2858 | Found in file sv.h | |
2859 | ||
954c1994 GS |
2860 | =item SvPOKp |
2861 | ||
2862 | Returns a boolean indicating whether the SV contains a character string. | |
2863 | Checks the B<private> setting. Use C<SvPOK>. | |
2864 | ||
2865 | bool SvPOKp(SV* sv) | |
2866 | ||
497711e7 GS |
2867 | =for hackers |
2868 | Found in file sv.h | |
2869 | ||
954c1994 GS |
2870 | =item SvPOK_off |
2871 | ||
2872 | Unsets the PV status of an SV. | |
2873 | ||
2874 | void SvPOK_off(SV* sv) | |
2875 | ||
497711e7 GS |
2876 | =for hackers |
2877 | Found in file sv.h | |
2878 | ||
954c1994 GS |
2879 | =item SvPOK_on |
2880 | ||
2881 | Tells an SV that it is a string. | |
2882 | ||
2883 | void SvPOK_on(SV* sv) | |
2884 | ||
497711e7 GS |
2885 | =for hackers |
2886 | Found in file sv.h | |
2887 | ||
954c1994 GS |
2888 | =item SvPOK_only |
2889 | ||
2890 | Tells an SV that it is a string and disables all other OK bits. | |
d5ce4a7c | 2891 | Will also turn off the UTF8 status. |
954c1994 GS |
2892 | |
2893 | void SvPOK_only(SV* sv) | |
2894 | ||
497711e7 GS |
2895 | =for hackers |
2896 | Found in file sv.h | |
2897 | ||
914184e1 JH |
2898 | =item SvPOK_only_UTF8 |
2899 | ||
d5ce4a7c GA |
2900 | Tells an SV that it is a string and disables all other OK bits, |
2901 | and leaves the UTF8 status as it was. | |
f1a1024e | 2902 | |
914184e1 JH |
2903 | void SvPOK_only_UTF8(SV* sv) |
2904 | ||
2905 | =for hackers | |
2906 | Found in file sv.h | |
2907 | ||
954c1994 GS |
2908 | =item SvPV |
2909 | ||
12b7c5c7 JH |
2910 | Returns a pointer to the string in the SV, or a stringified form of |
2911 | the SV if the SV does not contain a string. The SV may cache the | |
2912 | stringified version becoming C<SvPOK>. Handles 'get' magic. See also | |
645c22ef | 2913 | C<SvPVx> for a version which guarantees to evaluate sv only once. |
954c1994 GS |
2914 | |
2915 | char* SvPV(SV* sv, STRLEN len) | |
2916 | ||
497711e7 GS |
2917 | =for hackers |
2918 | Found in file sv.h | |
2919 | ||
645c22ef DM |
2920 | =item SvPVbyte |
2921 | ||
2922 | Like C<SvPV>, but converts sv to byte representation first if necessary. | |
2923 | ||
2924 | char* SvPVbyte(SV* sv, STRLEN len) | |
2925 | ||
2926 | =for hackers | |
2927 | Found in file sv.h | |
2928 | ||
2929 | =item SvPVbytex | |
2930 | ||
2931 | Like C<SvPV>, but converts sv to byte representation first if necessary. | |
d1be9408 | 2932 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte> |
645c22ef DM |
2933 | otherwise. |
2934 | ||
2935 | ||
2936 | char* SvPVbytex(SV* sv, STRLEN len) | |
2937 | ||
2938 | =for hackers | |
2939 | Found in file sv.h | |
2940 | ||
2941 | =item SvPVbytex_force | |
2942 | ||
2943 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. | |
d1be9408 | 2944 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force> |
645c22ef DM |
2945 | otherwise. |
2946 | ||
2947 | char* SvPVbytex_force(SV* sv, STRLEN len) | |
2948 | ||
2949 | =for hackers | |
2950 | Found in file sv.h | |
2951 | ||
2952 | =item SvPVbyte_force | |
2953 | ||
2954 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. | |
2955 | ||
2956 | char* SvPVbyte_force(SV* sv, STRLEN len) | |
2957 | ||
2958 | =for hackers | |
2959 | Found in file sv.h | |
2960 | ||
2961 | =item SvPVbyte_nolen | |
2962 | ||
2963 | Like C<SvPV_nolen>, but converts sv to byte representation first if necessary. | |
2964 | ||
1fdc5aa6 | 2965 | char* SvPVbyte_nolen(SV* sv) |
645c22ef DM |
2966 | |
2967 | =for hackers | |
2968 | Found in file sv.h | |
2969 | ||
2970 | =item SvPVutf8 | |
2971 | ||
1fdc5aa6 | 2972 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
645c22ef DM |
2973 | |
2974 | char* SvPVutf8(SV* sv, STRLEN len) | |
2975 | ||
2976 | =for hackers | |
2977 | Found in file sv.h | |
2978 | ||
2979 | =item SvPVutf8x | |
2980 | ||
1fdc5aa6 | 2981 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
d1be9408 | 2982 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8> |
645c22ef DM |
2983 | otherwise. |
2984 | ||
2985 | char* SvPVutf8x(SV* sv, STRLEN len) | |
2986 | ||
2987 | =for hackers | |
2988 | Found in file sv.h | |
2989 | ||
2990 | =item SvPVutf8x_force | |
2991 | ||
1fdc5aa6 | 2992 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
d1be9408 | 2993 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force> |
645c22ef DM |
2994 | otherwise. |
2995 | ||
2996 | char* SvPVutf8x_force(SV* sv, STRLEN len) | |
2997 | ||
2998 | =for hackers | |
2999 | Found in file sv.h | |
3000 | ||
3001 | =item SvPVutf8_force | |
3002 | ||
1fdc5aa6 | 3003 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
645c22ef DM |
3004 | |
3005 | char* SvPVutf8_force(SV* sv, STRLEN len) | |
3006 | ||
3007 | =for hackers | |
3008 | Found in file sv.h | |
3009 | ||
3010 | =item SvPVutf8_nolen | |
3011 | ||
1fdc5aa6 | 3012 | Like C<SvPV_nolen>, but converts sv to utf8 first if necessary. |
645c22ef | 3013 | |
1fdc5aa6 | 3014 | char* SvPVutf8_nolen(SV* sv) |
645c22ef DM |
3015 | |
3016 | =for hackers | |
3017 | Found in file sv.h | |
3018 | ||
b0f01acb | 3019 | =item SvPVx |
645c22ef | 3020 | |
b0f01acb | 3021 | A version of C<SvPV> which guarantees to evaluate sv only once. |
645c22ef | 3022 | |
b0f01acb | 3023 | char* SvPVx(SV* sv, STRLEN len) |
645c22ef DM |
3024 | |
3025 | =for hackers | |
3026 | Found in file sv.h | |
3027 | ||
b0f01acb | 3028 | =item SvPVX |
954c1994 | 3029 | |
b0f01acb JP |
3030 | Returns a pointer to the physical string in the SV. The SV must contain a |
3031 | string. | |
954c1994 | 3032 | |
b0f01acb | 3033 | char* SvPVX(SV* sv) |
954c1994 | 3034 | |
497711e7 GS |
3035 | =for hackers |
3036 | Found in file sv.h | |
3037 | ||
954c1994 GS |
3038 | =item SvPV_force |
3039 | ||
12b7c5c7 JH |
3040 | Like C<SvPV> but will force the SV into containing just a string |
3041 | (C<SvPOK_only>). You want force if you are going to update the C<SvPVX> | |
3042 | directly. | |
954c1994 GS |
3043 | |
3044 | char* SvPV_force(SV* sv, STRLEN len) | |
3045 | ||
497711e7 GS |
3046 | =for hackers |
3047 | Found in file sv.h | |
3048 | ||
645c22ef DM |
3049 | =item SvPV_force_nomg |
3050 | ||
12b7c5c7 JH |
3051 | Like C<SvPV> but will force the SV into containing just a string |
3052 | (C<SvPOK_only>). You want force if you are going to update the C<SvPVX> | |
3053 | directly. Doesn't process magic. | |
645c22ef DM |
3054 | |
3055 | char* SvPV_force_nomg(SV* sv, STRLEN len) | |
3056 | ||
3057 | =for hackers | |
3058 | Found in file sv.h | |
3059 | ||
954c1994 GS |
3060 | =item SvPV_nolen |
3061 | ||
12b7c5c7 JH |
3062 | Returns a pointer to the string in the SV, or a stringified form of |
3063 | the SV if the SV does not contain a string. The SV may cache the | |
3064 | stringified form becoming C<SvPOK>. Handles 'get' magic. | |
954c1994 GS |
3065 | |
3066 | char* SvPV_nolen(SV* sv) | |
3067 | ||
497711e7 GS |
3068 | =for hackers |
3069 | Found in file sv.h | |
3070 | ||
954c1994 GS |
3071 | =item SvREFCNT |
3072 | ||
3073 | Returns the value of the object's reference count. | |
3074 | ||
3075 | U32 SvREFCNT(SV* sv) | |
3076 | ||
497711e7 GS |
3077 | =for hackers |
3078 | Found in file sv.h | |
3079 | ||
954c1994 GS |
3080 | =item SvREFCNT_dec |
3081 | ||
3082 | Decrements the reference count of the given SV. | |
3083 | ||
3084 | void SvREFCNT_dec(SV* sv) | |
3085 | ||
497711e7 GS |
3086 | =for hackers |
3087 | Found in file sv.h | |
3088 | ||
954c1994 GS |
3089 | =item SvREFCNT_inc |
3090 | ||
3091 | Increments the reference count of the given SV. | |
3092 | ||
3093 | SV* SvREFCNT_inc(SV* sv) | |
3094 | ||
497711e7 GS |
3095 | =for hackers |
3096 | Found in file sv.h | |
3097 | ||
954c1994 GS |
3098 | =item SvROK |
3099 | ||
3100 | Tests if the SV is an RV. | |
3101 | ||
3102 | bool SvROK(SV* sv) | |
3103 | ||
497711e7 GS |
3104 | =for hackers |
3105 | Found in file sv.h | |
3106 | ||
954c1994 GS |
3107 | =item SvROK_off |
3108 | ||
3109 | Unsets the RV status of an SV. | |
3110 | ||
3111 | void SvROK_off(SV* sv) | |
3112 | ||
497711e7 GS |
3113 | =for hackers |
3114 | Found in file sv.h | |
3115 | ||
954c1994 GS |
3116 | =item SvROK_on |
3117 | ||
3118 | Tells an SV that it is an RV. | |
3119 | ||
3120 | void SvROK_on(SV* sv) | |
3121 | ||
497711e7 GS |
3122 | =for hackers |
3123 | Found in file sv.h | |
3124 | ||
954c1994 GS |
3125 | =item SvRV |
3126 | ||
3127 | Dereferences an RV to return the SV. | |
3128 | ||
3129 | SV* SvRV(SV* sv) | |
3130 | ||
497711e7 GS |
3131 | =for hackers |
3132 | Found in file sv.h | |
3133 | ||
954c1994 GS |
3134 | =item SvSTASH |
3135 | ||
3136 | Returns the stash of the SV. | |
3137 | ||
3138 | HV* SvSTASH(SV* sv) | |
3139 | ||
497711e7 GS |
3140 | =for hackers |
3141 | Found in file sv.h | |
3142 | ||
954c1994 GS |
3143 | =item SvTAINT |
3144 | ||
3145 | Taints an SV if tainting is enabled | |
3146 | ||
3147 | void SvTAINT(SV* sv) | |
3148 | ||
497711e7 GS |
3149 | =for hackers |
3150 | Found in file sv.h | |
3151 | ||
954c1994 GS |
3152 | =item SvTAINTED |
3153 | ||
3154 | Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if | |
3155 | not. | |
3156 | ||
3157 | bool SvTAINTED(SV* sv) | |
3158 | ||
497711e7 GS |
3159 | =for hackers |
3160 | Found in file sv.h | |
3161 | ||
954c1994 GS |
3162 | =item SvTAINTED_off |
3163 | ||
3164 | Untaints an SV. Be I<very> careful with this routine, as it short-circuits | |
3165 | some of Perl's fundamental security features. XS module authors should not | |
3166 | use this function unless they fully understand all the implications of | |
3167 | unconditionally untainting the value. Untainting should be done in the | |
3168 | standard perl fashion, via a carefully crafted regexp, rather than directly | |
3169 | untainting variables. | |
3170 | ||
3171 | void SvTAINTED_off(SV* sv) | |
3172 | ||
497711e7 GS |
3173 | =for hackers |
3174 | Found in file sv.h | |
3175 | ||
954c1994 GS |
3176 | =item SvTAINTED_on |
3177 | ||
3178 | Marks an SV as tainted. | |
3179 | ||
3180 | void SvTAINTED_on(SV* sv) | |
3181 | ||
497711e7 GS |
3182 | =for hackers |
3183 | Found in file sv.h | |
3184 | ||
954c1994 GS |
3185 | =item SvTRUE |
3186 | ||
3187 | Returns a boolean indicating whether Perl would evaluate the SV as true or | |
3188 | false, defined or undefined. Does not handle 'get' magic. | |
3189 | ||
3190 | bool SvTRUE(SV* sv) | |
3191 | ||
497711e7 GS |
3192 | =for hackers |
3193 | Found in file sv.h | |
3194 | ||
9f4817db | 3195 | =item SvTYPE |
af3c7592 | 3196 | |
9f4817db JH |
3197 | Returns the type of the SV. See C<svtype>. |
3198 | ||
3199 | svtype SvTYPE(SV* sv) | |
954c1994 | 3200 | |
497711e7 GS |
3201 | =for hackers |
3202 | Found in file sv.h | |
3203 | ||
a4f1a029 NIS |
3204 | =item SvUNLOCK |
3205 | ||
3206 | Releases a mutual exclusion lock on sv if a suitable module | |
3207 | has been loaded. | |
3208 | ||
3209 | ||
3210 | void SvUNLOCK(SV* sv) | |
3211 | ||
3212 | =for hackers | |
3213 | Found in file sv.h | |
3214 | ||
a8586c98 JH |
3215 | =item SvUOK |
3216 | ||
3217 | Returns a boolean indicating whether the SV contains an unsigned integer. | |
3218 | ||
3219 | void SvUOK(SV* sv) | |
3220 | ||
3221 | =for hackers | |
3222 | Found in file sv.h | |
3223 | ||
954c1994 GS |
3224 | =item SvUPGRADE |
3225 | ||
3226 | Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to | |
3227 | perform the upgrade if necessary. See C<svtype>. | |
3228 | ||
3229 | void SvUPGRADE(SV* sv, svtype type) | |
3230 | ||
497711e7 GS |
3231 | =for hackers |
3232 | Found in file sv.h | |
3233 | ||
914184e1 JH |
3234 | =item SvUTF8 |
3235 | ||
3236 | Returns a boolean indicating whether the SV contains UTF-8 encoded data. | |
3237 | ||
3238 | void SvUTF8(SV* sv) | |
3239 | ||
3240 | =for hackers | |
3241 | Found in file sv.h | |
3242 | ||
3243 | =item SvUTF8_off | |
3244 | ||
3245 | Unsets the UTF8 status of an SV. | |
3246 | ||
3247 | void SvUTF8_off(SV *sv) | |
3248 | ||
3249 | =for hackers | |
3250 | Found in file sv.h | |
3251 | ||
3252 | =item SvUTF8_on | |
3253 | ||
d5ce4a7c GA |
3254 | Turn on the UTF8 status of an SV (the data is not changed, just the flag). |
3255 | Do not use frivolously. | |
914184e1 JH |
3256 | |
3257 | void SvUTF8_on(SV *sv) | |
3258 | ||
3259 | =for hackers | |
3260 | Found in file sv.h | |
3261 | ||
954c1994 GS |
3262 | =item SvUV |
3263 | ||
645c22ef DM |
3264 | Coerces the given SV to an unsigned integer and returns it. See C<SvUVx> |
3265 | for a version which guarantees to evaluate sv only once. | |
954c1994 GS |
3266 | |
3267 | UV SvUV(SV* sv) | |
3268 | ||
497711e7 GS |
3269 | =for hackers |
3270 | Found in file sv.h | |
3271 | ||
b0f01acb JP |
3272 | =item SvUVX |
3273 | ||
3274 | Returns the raw value in the SV's UV slot, without checks or conversions. | |
3275 | Only use when you are sure SvIOK is true. See also C<SvUV()>. | |
3276 | ||
3277 | UV SvUVX(SV* sv) | |
3278 | ||
3279 | =for hackers | |
3280 | Found in file sv.h | |
3281 | ||
d6721266 | 3282 | =item SvUVx |
954c1994 | 3283 | |
d6721266 DM |
3284 | Coerces the given SV to an unsigned integer and returns it. Guarantees to |
3285 | evaluate sv only once. Use the more efficient C<SvUV> otherwise. | |
954c1994 | 3286 | |
d6721266 | 3287 | UV SvUVx(SV* sv) |
954c1994 | 3288 | |
497711e7 GS |
3289 | =for hackers |
3290 | Found in file sv.h | |
3291 | ||
b0f01acb | 3292 | =item SvVOK |
645c22ef | 3293 | |
b0f01acb | 3294 | Returns a boolean indicating whether the SV contains a v-string. |
645c22ef | 3295 | |
b0f01acb | 3296 | bool SvVOK(SV* sv) |
645c22ef DM |
3297 | |
3298 | =for hackers | |
3299 | Found in file sv.h | |
3300 | ||
3301 | =item sv_2bool | |
3302 | ||
3303 | This function is only called on magical items, and is only used by | |
8cf8f3d1 | 3304 | sv_true() or its macro equivalent. |
645c22ef DM |
3305 | |
3306 | bool sv_2bool(SV* sv) | |
3307 | ||
3308 | =for hackers | |
3309 | Found in file sv.c | |
3310 | ||
3311 | =item sv_2cv | |
3312 | ||
3313 | Using various gambits, try to get a CV from an SV; in addition, try if | |
3314 | possible to set C<*st> and C<*gvp> to the stash and GV associated with it. | |
3315 | ||
3316 | CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref) | |
3317 | ||
3318 | =for hackers | |
3319 | Found in file sv.c | |
3320 | ||
3321 | =item sv_2io | |
3322 | ||
3323 | Using various gambits, try to get an IO from an SV: the IO slot if its a | |
3324 | GV; or the recursive result if we're an RV; or the IO slot of the symbol | |
3325 | named after the PV if we're a string. | |
3326 | ||
3327 | IO* sv_2io(SV* sv) | |
3328 | ||
3329 | =for hackers | |
3330 | Found in file sv.c | |
3331 | ||
3332 | =item sv_2iv | |
3333 | ||
3334 | Return the integer value of an SV, doing any necessary string conversion, | |
3335 | magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros. | |
3336 | ||
3337 | IV sv_2iv(SV* sv) | |
3338 | ||
3339 | =for hackers | |
3340 | Found in file sv.c | |
3341 | ||
954c1994 GS |
3342 | =item sv_2mortal |
3343 | ||
793edb8a JH |
3344 | Marks an existing SV as mortal. The SV will be destroyed "soon", either |
3345 | by an explicit call to FREETMPS, or by an implicit call at places such as | |
3346 | statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>. | |
954c1994 GS |
3347 | |
3348 | SV* sv_2mortal(SV* sv) | |
3349 | ||
497711e7 GS |
3350 | =for hackers |
3351 | Found in file sv.c | |
3352 | ||
645c22ef DM |
3353 | =item sv_2nv |
3354 | ||
3355 | Return the num value of an SV, doing any necessary string or integer | |
3356 | conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> | |
3357 | macros. | |
3358 | ||
3359 | NV sv_2nv(SV* sv) | |
3360 | ||
3361 | =for hackers | |
3362 | Found in file sv.c | |
3363 | ||
451be7b1 DM |
3364 | =item sv_2pvbyte |
3365 | ||
3366 | Return a pointer to the byte-encoded representation of the SV, and set *lp | |
3367 | to its length. May cause the SV to be downgraded from UTF8 as a | |
3368 | side-effect. | |
3369 | ||
3370 | Usually accessed via the C<SvPVbyte> macro. | |
3371 | ||
3372 | char* sv_2pvbyte(SV* sv, STRLEN* lp) | |
3373 | ||
3374 | =for hackers | |
3375 | Found in file sv.c | |
3376 | ||
645c22ef DM |
3377 | =item sv_2pvbyte_nolen |
3378 | ||
3379 | Return a pointer to the byte-encoded representation of the SV. | |
3380 | May cause the SV to be downgraded from UTF8 as a side-effect. | |
3381 | ||
3382 | Usually accessed via the C<SvPVbyte_nolen> macro. | |
3383 | ||
3384 | char* sv_2pvbyte_nolen(SV* sv) | |
3385 | ||
3386 | =for hackers | |
3387 | Found in file sv.c | |
3388 | ||
451be7b1 DM |
3389 | =item sv_2pvutf8 |
3390 | ||
3391 | Return a pointer to the UTF8-encoded representation of the SV, and set *lp | |
3392 | to its length. May cause the SV to be upgraded to UTF8 as a side-effect. | |
3393 | ||
3394 | Usually accessed via the C<SvPVutf8> macro. | |
3395 | ||
3396 | char* sv_2pvutf8(SV* sv, STRLEN* lp) | |
3397 | ||
3398 | =for hackers | |
3399 | Found in file sv.c | |
3400 | ||
645c22ef DM |
3401 | =item sv_2pvutf8_nolen |
3402 | ||
3403 | Return a pointer to the UTF8-encoded representation of the SV. | |
3404 | May cause the SV to be upgraded to UTF8 as a side-effect. | |
3405 | ||
3406 | Usually accessed via the C<SvPVutf8_nolen> macro. | |
3407 | ||
3408 | char* sv_2pvutf8_nolen(SV* sv) | |
3409 | ||
3410 | =for hackers | |
3411 | Found in file sv.c | |
3412 | ||
3413 | =item sv_2pv_flags | |
3414 | ||
ff276b08 | 3415 | Returns a pointer to the string value of an SV, and sets *lp to its length. |
645c22ef DM |
3416 | If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string |
3417 | if necessary. | |
3418 | Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg> | |
3419 | usually end up here too. | |
3420 | ||
3421 | char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags) | |
3422 | ||
3423 | =for hackers | |
3424 | Found in file sv.c | |
3425 | ||
3426 | =item sv_2pv_nolen | |
3427 | ||
3428 | Like C<sv_2pv()>, but doesn't return the length too. You should usually | |
3429 | use the macro wrapper C<SvPV_nolen(sv)> instead. | |
3430 | char* sv_2pv_nolen(SV* sv) | |
3431 | ||
3432 | =for hackers | |
3433 | Found in file sv.c | |
3434 | ||
3435 | =item sv_2uv | |
3436 | ||
3437 | Return the unsigned integer value of an SV, doing any necessary string | |
3438 | conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> | |
3439 | macros. | |
3440 | ||
3441 | UV sv_2uv(SV* sv) | |
3442 | ||
3443 | =for hackers | |
3444 | Found in file sv.c | |
3445 | ||
3446 | =item sv_backoff | |
3447 | ||
3448 | Remove any string offset. You should normally use the C<SvOOK_off> macro | |
3449 | wrapper instead. | |
3450 | ||
3451 | int sv_backoff(SV* sv) | |
3452 | ||
3453 | =for hackers | |
3454 | Found in file sv.c | |
3455 | ||
954c1994 GS |
3456 | =item sv_bless |
3457 | ||
3458 | Blesses an SV into a specified package. The SV must be an RV. The package | |
3459 | must be designated by its stash (see C<gv_stashpv()>). The reference count | |
3460 | of the SV is unaffected. | |
3461 | ||
3462 | SV* sv_bless(SV* sv, HV* stash) | |
3463 | ||
497711e7 GS |
3464 | =for hackers |
3465 | Found in file sv.c | |
3466 | ||
954c1994 GS |
3467 | =item sv_catpv |
3468 | ||
3469 | Concatenates the string onto the end of the string which is in the SV. | |
d5ce4a7c GA |
3470 | If the SV has the UTF8 status set, then the bytes appended should be |
3471 | valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>. | |
954c1994 GS |
3472 | |
3473 | void sv_catpv(SV* sv, const char* ptr) | |
3474 | ||
497711e7 GS |
3475 | =for hackers |
3476 | Found in file sv.c | |
3477 | ||
954c1994 GS |
3478 | =item sv_catpvf |
3479 | ||
d5ce4a7c GA |
3480 | Processes its arguments like C<sprintf> and appends the formatted |
3481 | output to an SV. If the appended data contains "wide" characters | |
3482 | (including, but not limited to, SVs with a UTF-8 PV formatted with %s, | |
3483 | and characters >255 formatted with %c), the original SV might get | |
3484 | upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. | |
3485 | C<SvSETMAGIC()> must typically be called after calling this function | |
3486 | to handle 'set' magic. | |
954c1994 GS |
3487 | |
3488 | void sv_catpvf(SV* sv, const char* pat, ...) | |
3489 | ||
497711e7 GS |
3490 | =for hackers |
3491 | Found in file sv.c | |
3492 | ||
954c1994 GS |
3493 | =item sv_catpvf_mg |
3494 | ||
3495 | Like C<sv_catpvf>, but also handles 'set' magic. | |
3496 | ||
3497 | void sv_catpvf_mg(SV *sv, const char* pat, ...) | |
3498 | ||
497711e7 GS |
3499 | =for hackers |
3500 | Found in file sv.c | |
3501 | ||
954c1994 GS |
3502 | =item sv_catpvn |
3503 | ||
3504 | Concatenates the string onto the end of the string which is in the SV. The | |
d5ce4a7c GA |
3505 | C<len> indicates number of bytes to copy. If the SV has the UTF8 |
3506 | status set, then the bytes appended should be valid UTF8. | |
3507 | Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>. | |
954c1994 GS |
3508 | |
3509 | void sv_catpvn(SV* sv, const char* ptr, STRLEN len) | |
3510 | ||
497711e7 GS |
3511 | =for hackers |
3512 | Found in file sv.c | |
3513 | ||
8d6d96c1 HS |
3514 | =item sv_catpvn_flags |
3515 | ||
3516 | Concatenates the string onto the end of the string which is in the SV. The | |
3517 | C<len> indicates number of bytes to copy. If the SV has the UTF8 | |
3518 | status set, then the bytes appended should be valid UTF8. | |
3519 | If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if | |
3520 | appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented | |
3521 | in terms of this function. | |
3522 | ||
3523 | void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags) | |
3524 | ||
3525 | =for hackers | |
3526 | Found in file sv.c | |
3527 | ||
954c1994 GS |
3528 | =item sv_catpvn_mg |
3529 | ||
3530 | Like C<sv_catpvn>, but also handles 'set' magic. | |
3531 | ||
3532 | void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len) | |
3533 | ||
497711e7 GS |
3534 | =for hackers |
3535 | Found in file sv.c | |
3536 | ||
954c1994 GS |
3537 | =item sv_catpv_mg |
3538 | ||
3539 | Like C<sv_catpv>, but also handles 'set' magic. | |
3540 | ||
3541 | void sv_catpv_mg(SV *sv, const char *ptr) | |
3542 | ||
497711e7 GS |
3543 | =for hackers |
3544 | Found in file sv.c | |
3545 | ||
954c1994 GS |
3546 | =item sv_catsv |
3547 | ||
1aa99e6b IH |
3548 | Concatenates the string from SV C<ssv> onto the end of the string in |
3549 | SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but | |
3550 | not 'set' magic. See C<sv_catsv_mg>. | |
954c1994 GS |
3551 | |
3552 | void sv_catsv(SV* dsv, SV* ssv) | |
3553 | ||
497711e7 GS |
3554 | =for hackers |
3555 | Found in file sv.c | |
3556 | ||
8d6d96c1 HS |
3557 | =item sv_catsv_flags |
3558 | ||
3559 | Concatenates the string from SV C<ssv> onto the end of the string in | |
3560 | SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC> | |
3561 | bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv> | |
3562 | and C<sv_catsv_nomg> are implemented in terms of this function. | |
3563 | ||
3564 | void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags) | |
3565 | ||
3566 | =for hackers | |
3567 | Found in file sv.c | |
3568 | ||
954c1994 GS |
3569 | =item sv_catsv_mg |
3570 | ||
3571 | Like C<sv_catsv>, but also handles 'set' magic. | |
3572 | ||
3573 | void sv_catsv_mg(SV *dstr, SV *sstr) | |
3574 | ||
497711e7 GS |
3575 | =for hackers |
3576 | Found in file sv.c | |
3577 | ||
954c1994 GS |
3578 | =item sv_chop |
3579 | ||
1c846c1f | 3580 | Efficient removal of characters from the beginning of the string buffer. |
954c1994 GS |
3581 | SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside |
3582 | the string buffer. The C<ptr> becomes the first character of the adjusted | |
645c22ef | 3583 | string. Uses the "OOK hack". |
954c1994 GS |
3584 | |
3585 | void sv_chop(SV* sv, char* ptr) | |
3586 | ||
497711e7 GS |
3587 | =for hackers |
3588 | Found in file sv.c | |
3589 | ||
c461cf8f JH |
3590 | =item sv_clear |
3591 | ||
645c22ef DM |
3592 | Clear an SV: call any destructors, free up any memory used by the body, |
3593 | and free the body itself. The SV's head is I<not> freed, although | |
3594 | its type is set to all 1's so that it won't inadvertently be assumed | |
3595 | to be live during global destruction etc. | |
3596 | This function should only be called when REFCNT is zero. Most of the time | |
3597 | you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>) | |
3598 | instead. | |
c461cf8f JH |
3599 | |
3600 | void sv_clear(SV* sv) | |
3601 | ||
3602 | =for hackers | |
3603 | Found in file sv.c | |
3604 | ||
954c1994 GS |
3605 | =item sv_cmp |
3606 | ||
3607 | Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the | |
3608 | string in C<sv1> is less than, equal to, or greater than the string in | |
645c22ef DM |
3609 | C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will |
3610 | coerce its args to strings if necessary. See also C<sv_cmp_locale>. | |
954c1994 GS |
3611 | |
3612 | I32 sv_cmp(SV* sv1, SV* sv2) | |
3613 | ||
497711e7 GS |
3614 | =for hackers |
3615 | Found in file sv.c | |
3616 | ||
c461cf8f JH |
3617 | =item sv_cmp_locale |
3618 | ||
645c22ef DM |
3619 | Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and |
3620 | 'use bytes' aware, handles get magic, and will coerce its args to strings | |
3621 | if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>. | |
c461cf8f JH |
3622 | |
3623 | I32 sv_cmp_locale(SV* sv1, SV* sv2) | |
3624 | ||
3625 | =for hackers | |
3626 | Found in file sv.c | |
3627 | ||
645c22ef DM |
3628 | =item sv_collxfrm |
3629 | ||
3630 | Add Collate Transform magic to an SV if it doesn't already have it. | |
3631 | ||
3632 | Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the | |
3633 | scalar data of the variable, but transformed to such a format that a normal | |
3634 | memory comparison can be used to compare the data according to the locale | |
3635 | settings. | |
3636 | ||
3637 | char* sv_collxfrm(SV* sv, STRLEN* nxp) | |
3638 | ||
3639 | =for hackers | |
3640 | Found in file sv.c | |
3641 | ||
6050d10e JP |
3642 | =item sv_copypv |
3643 | ||
3644 | Copies a stringified representation of the source SV into the | |
3645 | destination SV. Automatically performs any necessary mg_get and | |
9ede5bc8 | 3646 | coercion of numeric values into strings. Guaranteed to preserve |
6050d10e | 3647 | UTF-8 flag even from overloaded objects. Similar in nature to |
9ede5bc8 DM |
3648 | sv_2pv[_flags] but operates directly on an SV instead of just the |
3649 | string. Mostly uses sv_2pv_flags to do its work, except when that | |
6050d10e JP |
3650 | would lose the UTF-8'ness of the PV. |
3651 | ||
3652 | void sv_copypv(SV* dsv, SV* ssv) | |
3653 | ||
3654 | =for hackers | |
3655 | Found in file sv.c | |
3656 | ||
954c1994 GS |
3657 | =item sv_dec |
3658 | ||
645c22ef DM |
3659 | Auto-decrement of the value in the SV, doing string to numeric conversion |
3660 | if necessary. Handles 'get' magic. | |
954c1994 GS |
3661 | |
3662 | void sv_dec(SV* sv) | |
3663 | ||
497711e7 GS |
3664 | =for hackers |
3665 | Found in file sv.c | |
3666 | ||
954c1994 GS |
3667 | =item sv_derived_from |
3668 | ||
3669 | Returns a boolean indicating whether the SV is derived from the specified | |
3670 | class. This is the function that implements C<UNIVERSAL::isa>. It works | |
3671 | for class names as well as for objects. | |
3672 | ||
3673 | bool sv_derived_from(SV* sv, const char* name) | |
3674 | ||
497711e7 GS |
3675 | =for hackers |
3676 | Found in file universal.c | |
3677 | ||
954c1994 GS |
3678 | =item sv_eq |
3679 | ||
3680 | Returns a boolean indicating whether the strings in the two SVs are | |
645c22ef DM |
3681 | identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will |
3682 | coerce its args to strings if necessary. | |
954c1994 GS |
3683 | |
3684 | I32 sv_eq(SV* sv1, SV* sv2) | |
3685 | ||
497711e7 GS |
3686 | =for hackers |
3687 | Found in file sv.c | |
3688 | ||
645c22ef DM |
3689 | =item sv_force_normal |
3690 | ||
3691 | Undo various types of fakery on an SV: if the PV is a shared string, make | |
3692 | a private copy; if we're a ref, stop refing; if we're a glob, downgrade to | |
3693 | an xpvmg. See also C<sv_force_normal_flags>. | |
3694 | ||
3695 | void sv_force_normal(SV *sv) | |
3696 | ||
3697 | =for hackers | |
3698 | Found in file sv.c | |
3699 | ||
3700 | =item sv_force_normal_flags | |
3701 | ||
3702 | Undo various types of fakery on an SV: if the PV is a shared string, make | |
3703 | a private copy; if we're a ref, stop refing; if we're a glob, downgrade to | |
765f542d NC |
3704 | an xpvmg; if we're a copy-on-write scalar, this is the on-write time when |
3705 | we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set | |
3706 | then a copy-on-write scalar drops its PV buffer (if any) and becomes | |
3707 | SvPOK_off rather than making a copy. (Used where this scalar is about to be | |
3708 | set to some other value. In addtion, the C<flags> parameter gets passed to | |
3709 | C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function | |
3710 | with flags set to 0. | |
645c22ef DM |
3711 | |
3712 | void sv_force_normal_flags(SV *sv, U32 flags) | |
3713 | ||
3714 | =for hackers | |
3715 | Found in file sv.c | |
3716 | ||
c461cf8f JH |
3717 | =item sv_free |
3718 | ||
645c22ef DM |
3719 | Decrement an SV's reference count, and if it drops to zero, call |
3720 | C<sv_clear> to invoke destructors and free up any memory used by | |
3721 | the body; finally, deallocate the SV's head itself. | |
3722 | Normally called via a wrapper macro C<SvREFCNT_dec>. | |
c461cf8f JH |
3723 | |
3724 | void sv_free(SV* sv) | |
3725 | ||
3726 | =for hackers | |
3727 | Found in file sv.c | |
3728 | ||
3729 | =item sv_gets | |
3730 | ||
3731 | Get a line from the filehandle and store it into the SV, optionally | |
3732 | appending to the currently-stored string. | |
3733 | ||
3734 | char* sv_gets(SV* sv, PerlIO* fp, I32 append) | |
3735 | ||
3736 | =for hackers | |
3737 | Found in file sv.c | |
3738 | ||
954c1994 GS |
3739 | =item sv_grow |
3740 | ||
645c22ef DM |
3741 | Expands the character buffer in the SV. If necessary, uses C<sv_unref> and |
3742 | upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer. | |
3743 | Use the C<SvGROW> wrapper instead. | |
954c1994 GS |
3744 | |
3745 | char* sv_grow(SV* sv, STRLEN newlen) | |
3746 | ||
497711e7 GS |
3747 | =for hackers |
3748 | Found in file sv.c | |
3749 | ||
954c1994 GS |
3750 | =item sv_inc |
3751 | ||
645c22ef DM |
3752 | Auto-increment of the value in the SV, doing string to numeric conversion |
3753 | if necessary. Handles 'get' magic. | |
954c1994 GS |
3754 | |
3755 | void sv_inc(SV* sv) | |
3756 | ||
497711e7 GS |
3757 | =for hackers |
3758 | Found in file sv.c | |
3759 | ||
954c1994 GS |
3760 | =item sv_insert |
3761 | ||
3762 | Inserts a string at the specified offset/length within the SV. Similar to | |
3763 | the Perl substr() function. | |
3764 | ||
3765 | void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen) | |
3766 | ||
497711e7 GS |
3767 | =for hackers |
3768 | Found in file sv.c | |
3769 | ||
954c1994 GS |
3770 | =item sv_isa |
3771 | ||
3772 | Returns a boolean indicating whether the SV is blessed into the specified | |
3773 | class. This does not check for subtypes; use C<sv_derived_from> to verify | |
3774 | an inheritance relationship. | |
3775 | ||
3776 | int sv_isa(SV* sv, const char* name) | |
3777 | ||
497711e7 GS |
3778 | =for hackers |
3779 | Found in file sv.c | |
3780 | ||
954c1994 GS |
3781 | =item sv_isobject |
3782 | ||
3783 | Returns a boolean indicating whether the SV is an RV pointing to a blessed | |
3784 | object. If the SV is not an RV, or if the object is not blessed, then this | |
3785 | will return false. | |
3786 | ||
3787 | int sv_isobject(SV* sv) | |
3788 | ||
497711e7 GS |
3789 | =for hackers |
3790 | Found in file sv.c | |
3791 | ||
645c22ef DM |
3792 | =item sv_iv |
3793 | ||
3794 | A private implementation of the C<SvIVx> macro for compilers which can't | |
3795 | cope with complex macro expressions. Always use the macro instead. | |
3796 | ||
3797 | IV sv_iv(SV* sv) | |
3798 | ||
3799 | =for hackers | |
3800 | Found in file sv.c | |
3801 | ||
954c1994 GS |
3802 | =item sv_len |
3803 | ||
645c22ef DM |
3804 | Returns the length of the string in the SV. Handles magic and type |
3805 | coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot. | |
954c1994 GS |
3806 | |
3807 | STRLEN sv_len(SV* sv) | |
3808 | ||
497711e7 GS |
3809 | =for hackers |
3810 | Found in file sv.c | |
3811 | ||
c461cf8f JH |
3812 | =item sv_len_utf8 |
3813 | ||
3814 | Returns the number of characters in the string in an SV, counting wide | |
645c22ef | 3815 | UTF8 bytes as a single character. Handles magic and type coercion. |
c461cf8f JH |
3816 | |
3817 | STRLEN sv_len_utf8(SV* sv) | |
3818 | ||
3819 | =for hackers | |
3820 | Found in file sv.c | |
3821 | ||
954c1994 GS |
3822 | =item sv_magic |
3823 | ||
645c22ef DM |
3824 | Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary, |
3825 | then adds a new magic item of type C<how> to the head of the magic list. | |
3826 | ||
954c1994 GS |
3827 | void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen) |
3828 | ||
497711e7 GS |
3829 | =for hackers |
3830 | Found in file sv.c | |
3831 | ||
a4f1a029 NIS |
3832 | =item sv_magicext |
3833 | ||
3834 | Adds magic to an SV, upgrading it if necessary. Applies the | |
3835 | supplied vtable and returns pointer to the magic added. | |
3836 | ||
3837 | Note that sv_magicext will allow things that sv_magic will not. | |
3838 | In particular you can add magic to SvREADONLY SVs and and more than | |
3839 | one instance of the same 'how' | |
3840 | ||
3841 | I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored, | |
3842 | if C<namelen> is zero then C<name> is stored as-is and - as another special | |
3843 | case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain | |
3844 | an C<SV*> and has its REFCNT incremented | |
3845 | ||
3846 | (This is now used as a subroutine by sv_magic.) | |
3847 | ||
3848 | MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen ) | |
3849 | ||
3850 | =for hackers | |
3851 | Found in file sv.c | |
3852 | ||
954c1994 GS |
3853 | =item sv_mortalcopy |
3854 | ||
645c22ef | 3855 | Creates a new SV which is a copy of the original SV (using C<sv_setsv>). |
793edb8a JH |
3856 | The new SV is marked as mortal. It will be destroyed "soon", either by an |
3857 | explicit call to FREETMPS, or by an implicit call at places such as | |
3858 | statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>. | |
954c1994 GS |
3859 | |
3860 | SV* sv_mortalcopy(SV* oldsv) | |
3861 | ||
497711e7 GS |
3862 | =for hackers |
3863 | Found in file sv.c | |
3864 | ||
954c1994 GS |
3865 | =item sv_newmortal |
3866 | ||
645c22ef | 3867 | Creates a new null SV which is mortal. The reference count of the SV is |
793edb8a JH |
3868 | set to 1. It will be destroyed "soon", either by an explicit call to |
3869 | FREETMPS, or by an implicit call at places such as statement boundaries. | |
3870 | See also C<sv_mortalcopy> and C<sv_2mortal>. | |
954c1994 GS |
3871 | |
3872 | SV* sv_newmortal() | |
3873 | ||
497711e7 GS |
3874 | =for hackers |
3875 | Found in file sv.c | |
3876 | ||
645c22ef DM |
3877 | =item sv_newref |
3878 | ||
3879 | Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper | |
3880 | instead. | |
3881 | ||
3882 | SV* sv_newref(SV* sv) | |
3883 | ||
3884 | =for hackers | |
3885 | Found in file sv.c | |
3886 | ||
a4f1a029 NIS |
3887 | =item sv_nolocking |
3888 | ||
3889 | Dummy routine which "locks" an SV when there is no locking module present. | |
3890 | Exists to avoid test for a NULL function pointer and because it could potentially warn under | |
3891 | some level of strict-ness. | |
3892 | ||
3893 | void sv_nolocking(SV *) | |
3894 | ||
3895 | =for hackers | |
3896 | Found in file util.c | |
3897 | ||
3898 | =item sv_nosharing | |
3899 | ||
3900 | Dummy routine which "shares" an SV when there is no sharing module present. | |
3901 | Exists to avoid test for a NULL function pointer and because it could potentially warn under | |
3902 | some level of strict-ness. | |
3903 | ||
3904 | void sv_nosharing(SV *) | |
3905 | ||
3906 | =for hackers | |
3907 | Found in file util.c | |
3908 | ||
3909 | =item sv_nounlocking | |
3910 | ||
3911 | Dummy routine which "unlocks" an SV when there is no locking module present. | |
3912 | Exists to avoid test for a NULL function pointer and because it could potentially warn under | |
3913 | some level of strict-ness. | |
3914 | ||
3915 | void sv_nounlocking(SV *) | |
3916 | ||
3917 | =for hackers | |
3918 | Found in file util.c | |
3919 | ||
645c22ef DM |
3920 | =item sv_nv |
3921 | ||
3922 | A private implementation of the C<SvNVx> macro for compilers which can't | |
3923 | cope with complex macro expressions. Always use the macro instead. | |
3924 | ||
3925 | NV sv_nv(SV* sv) | |
3926 | ||
3927 | =for hackers | |
3928 | Found in file sv.c | |
3929 | ||
3930 | =item sv_pos_b2u | |
3931 | ||
3932 | Converts the value pointed to by offsetp from a count of bytes from the | |
3933 | start of the string, to a count of the equivalent number of UTF8 chars. | |
3934 | Handles magic and type coercion. | |
3935 | ||
3936 | void sv_pos_b2u(SV* sv, I32* offsetp) | |
3937 | ||
3938 | =for hackers | |
3939 | Found in file sv.c | |
3940 | ||
3941 | =item sv_pos_u2b | |
3942 | ||
3943 | Converts the value pointed to by offsetp from a count of UTF8 chars from | |
3944 | the start of the string, to a count of the equivalent number of bytes; if | |
3945 | lenp is non-zero, it does the same to lenp, but this time starting from | |
3946 | the offset, rather than from the start of the string. Handles magic and | |
3947 | type coercion. | |
3948 | ||
3949 | void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp) | |
3950 | ||
3951 | =for hackers | |
3952 | Found in file sv.c | |
3953 | ||
451be7b1 DM |
3954 | =item sv_pv |
3955 | ||
baca2b92 | 3956 | Use the C<SvPV_nolen> macro instead |
451be7b1 DM |
3957 | |
3958 | char* sv_pv(SV *sv) | |
3959 | ||
3960 | =for hackers | |
3961 | Found in file sv.c | |
3962 | ||
645c22ef DM |
3963 | =item sv_pvbyte |
3964 | ||
baca2b92 | 3965 | Use C<SvPVbyte_nolen> instead. |
645c22ef DM |
3966 | |
3967 | char* sv_pvbyte(SV *sv) | |
3968 | ||
3969 | =for hackers | |
3970 | Found in file sv.c | |
3971 | ||
3972 | =item sv_pvbyten | |
3973 | ||
3974 | A private implementation of the C<SvPVbyte> macro for compilers | |
3975 | which can't cope with complex macro expressions. Always use the macro | |
3976 | instead. | |
3977 | ||
3978 | char* sv_pvbyten(SV *sv, STRLEN *len) | |
3979 | ||
3980 | =for hackers | |
3981 | Found in file sv.c | |
3982 | ||
3983 | =item sv_pvbyten_force | |
3984 | ||
3985 | A private implementation of the C<SvPVbytex_force> macro for compilers | |
3986 | which can't cope with complex macro expressions. Always use the macro | |
3987 | instead. | |
3988 | ||
3989 | char* sv_pvbyten_force(SV* sv, STRLEN* lp) | |
3990 | ||
3991 | =for hackers | |
3992 | Found in file sv.c | |
3993 | ||
451be7b1 DM |
3994 | =item sv_pvn |
3995 | ||
3996 | A private implementation of the C<SvPV> macro for compilers which can't | |
3997 | cope with complex macro expressions. Always use the macro instead. | |
3998 | ||
3999 | char* sv_pvn(SV *sv, STRLEN *len) | |
4000 | ||
4001 | =for hackers | |
4002 | Found in file sv.c | |
4003 | ||
c461cf8f JH |
4004 | =item sv_pvn_force |
4005 | ||
4006 | Get a sensible string out of the SV somehow. | |
645c22ef DM |
4007 | A private implementation of the C<SvPV_force> macro for compilers which |
4008 | can't cope with complex macro expressions. Always use the macro instead. | |
c461cf8f JH |
4009 | |
4010 | char* sv_pvn_force(SV* sv, STRLEN* lp) | |
4011 | ||
4012 | =for hackers | |
4013 | Found in file sv.c | |
4014 | ||
8d6d96c1 HS |
4015 | =item sv_pvn_force_flags |
4016 | ||
4017 | Get a sensible string out of the SV somehow. | |
4018 | If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if | |
4019 | appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are | |
4020 | implemented in terms of this function. | |
645c22ef DM |
4021 | You normally want to use the various wrapper macros instead: see |
4022 | C<SvPV_force> and C<SvPV_force_nomg> | |
8d6d96c1 HS |
4023 | |
4024 | char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags) | |
4025 | ||
4026 | =for hackers | |
4027 | Found in file sv.c | |
4028 | ||
645c22ef DM |
4029 | =item sv_pvutf8 |
4030 | ||
baca2b92 | 4031 | Use the C<SvPVutf8_nolen> macro instead |
645c22ef DM |
4032 | |
4033 | char* sv_pvutf8(SV *sv) | |
4034 | ||
4035 | =for hackers | |
4036 | Found in file sv.c | |
4037 | ||
4038 | =item sv_pvutf8n | |
4039 | ||
4040 | A private implementation of the C<SvPVutf8> macro for compilers | |
4041 | which can't cope with complex macro expressions. Always use the macro | |
4042 | instead. | |
4043 | ||
4044 | char* sv_pvutf8n(SV *sv, STRLEN *len) | |
4045 | ||
4046 | =for hackers | |
4047 | Found in file sv.c | |
4048 | ||
c461cf8f JH |
4049 | =item sv_pvutf8n_force |
4050 | ||
645c22ef DM |
4051 | A private implementation of the C<SvPVutf8_force> macro for compilers |
4052 | which can't cope with complex macro expressions. Always use the macro | |
4053 | instead. | |
c461cf8f JH |
4054 | |
4055 | char* sv_pvutf8n_force(SV* sv, STRLEN* lp) | |
4056 | ||
4057 | =for hackers | |
4058 | Found in file sv.c | |
4059 | ||
4060 | =item sv_reftype | |
4061 | ||
4062 | Returns a string describing what the SV is a reference to. | |
4063 | ||
4064 | char* sv_reftype(SV* sv, int ob) | |
4065 | ||
4066 | =for hackers | |
4067 | Found in file sv.c | |
4068 | ||
4069 | =item sv_replace | |
4070 | ||
4071 | Make the first argument a copy of the second, then delete the original. | |
645c22ef DM |
4072 | The target SV physically takes over ownership of the body of the source SV |
4073 | and inherits its flags; however, the target keeps any magic it owns, | |
4074 | and any magic in the source is discarded. | |
ff276b08 | 4075 | Note that this is a rather specialist SV copying operation; most of the |
645c22ef | 4076 | time you'll want to use C<sv_setsv> or one of its many macro front-ends. |
c461cf8f JH |
4077 | |
4078 | void sv_replace(SV* sv, SV* nsv) | |
4079 | ||
4080 | =for hackers | |
4081 | Found in file sv.c | |
4082 | ||
645c22ef DM |
4083 | =item sv_report_used |
4084 | ||
4085 | Dump the contents of all SVs not yet freed. (Debugging aid). | |
4086 | ||
4087 | void sv_report_used() | |
4088 | ||
4089 | =for hackers | |
4090 | Found in file sv.c | |
4091 | ||
451be7b1 DM |
4092 | =item sv_reset |
4093 | ||
4094 | Underlying implementation for the C<reset> Perl function. | |
4095 | Note that the perl-level function is vaguely deprecated. | |
4096 | ||
4097 | void sv_reset(char* s, HV* stash) | |
4098 | ||
4099 | =for hackers | |
4100 | Found in file sv.c | |
4101 | ||
c461cf8f JH |
4102 | =item sv_rvweaken |
4103 | ||
645c22ef DM |
4104 | Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the |
4105 | referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and | |
4106 | push a back-reference to this RV onto the array of backreferences | |
4107 | associated with that magic. | |
c461cf8f JH |
4108 | |
4109 | SV* sv_rvweaken(SV *sv) | |
4110 | ||
4111 | =for hackers | |
4112 | Found in file sv.c | |
4113 | ||
954c1994 GS |
4114 | =item sv_setiv |
4115 | ||
645c22ef DM |
4116 | Copies an integer into the given SV, upgrading first if necessary. |
4117 | Does not handle 'set' magic. See also C<sv_setiv_mg>. | |
954c1994 GS |
4118 | |
4119 | void sv_setiv(SV* sv, IV num) | |
4120 | ||
497711e7 GS |
4121 | =for hackers |
4122 | Found in file sv.c | |
4123 | ||
954c1994 GS |
4124 | =item sv_setiv_mg |
4125 | ||
4126 | Like C<sv_setiv>, but also handles 'set' magic. | |
4127 | ||
4128 | void sv_setiv_mg(SV *sv, IV i) | |
4129 | ||
497711e7 GS |
4130 | =for hackers |
4131 | Found in file sv.c | |
4132 | ||
954c1994 GS |
4133 | =item sv_setnv |
4134 | ||
645c22ef DM |
4135 | Copies a double into the given SV, upgrading first if necessary. |
4136 | Does not handle 'set' magic. See also C<sv_setnv_mg>. | |
954c1994 GS |
4137 | |
4138 | void sv_setnv(SV* sv, NV num) | |
4139 | ||
497711e7 GS |
4140 | =for hackers |
4141 | Found in file sv.c | |
4142 | ||
954c1994 GS |
4143 | =item sv_setnv_mg |
4144 | ||
4145 | Like C<sv_setnv>, but also handles 'set' magic. | |
4146 | ||
4147 | void sv_setnv_mg(SV *sv, NV num) | |
4148 | ||
497711e7 GS |
4149 | =for hackers |
4150 | Found in file sv.c | |
4151 | ||
954c1994 GS |
4152 | =item sv_setpv |
4153 | ||
4154 | Copies a string into an SV. The string must be null-terminated. Does not | |
4155 | handle 'set' magic. See C<sv_setpv_mg>. | |
4156 | ||
4157 | void sv_setpv(SV* sv, const char* ptr) | |
4158 | ||
497711e7 GS |
4159 | =for hackers |
4160 | Found in file sv.c | |
4161 | ||
954c1994 GS |
4162 | =item sv_setpvf |
4163 | ||
4164 | Processes its arguments like C<sprintf> and sets an SV to the formatted | |
4165 | output. Does not handle 'set' magic. See C<sv_setpvf_mg>. | |
4166 | ||
4167 | void sv_setpvf(SV* sv, const char* pat, ...) | |
4168 | ||
497711e7 GS |
4169 | =for hackers |
4170 | Found in file sv.c | |
4171 | ||
954c1994 GS |
4172 | =item sv_setpvf_mg |
4173 | ||
4174 | Like C<sv_setpvf>, but also handles 'set' magic. | |
4175 | ||
4176 | void sv_setpvf_mg(SV *sv, const char* pat, ...) | |
4177 | ||
497711e7 GS |
4178 | =for hackers |
4179 | Found in file sv.c | |
4180 | ||
954c1994 GS |
4181 | =item sv_setpvn |
4182 | ||
4183 | Copies a string into an SV. The C<len> parameter indicates the number of | |
4184 | bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>. | |
4185 | ||
4186 | void sv_setpvn(SV* sv, const char* ptr, STRLEN len) | |
4187 | ||
497711e7 GS |
4188 | =for hackers |
4189 | Found in file sv.c | |
4190 | ||
954c1994 GS |
4191 | =item sv_setpvn_mg |
4192 | ||
4193 | Like C<sv_setpvn>, but also handles 'set' magic. | |
4194 | ||
4195 | void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len) | |
4196 | ||
497711e7 GS |
4197 | =for hackers |
4198 | Found in file sv.c | |
4199 | ||
954c1994 GS |
4200 | =item sv_setpv_mg |
4201 | ||
4202 | Like C<sv_setpv>, but also handles 'set' magic. | |
4203 | ||
4204 | void sv_setpv_mg(SV *sv, const char *ptr) | |
4205 | ||
497711e7 GS |
4206 | =for hackers |
4207 | Found in file sv.c | |
4208 | ||
954c1994 GS |
4209 | =item sv_setref_iv |
4210 | ||
4211 | Copies an integer into a new SV, optionally blessing the SV. The C<rv> | |
4212 | argument will be upgraded to an RV. That RV will be modified to point to | |
4213 | the new SV. The C<classname> argument indicates the package for the | |
4214 | blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV | |
4215 | will be returned and will have a reference count of 1. | |
4216 | ||
4217 | SV* sv_setref_iv(SV* rv, const char* classname, IV iv) | |
4218 | ||
497711e7 GS |
4219 | =for hackers |
4220 | Found in file sv.c | |
4221 | ||
954c1994 GS |
4222 | =item sv_setref_nv |
4223 | ||
4224 | Copies a double into a new SV, optionally blessing the SV. The C<rv> | |
4225 | argument will be upgraded to an RV. That RV will be modified to point to | |
4226 | the new SV. The C<classname> argument indicates the package for the | |
4227 | blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV | |
4228 | will be returned and will have a reference count of 1. | |
4229 | ||
4230 | SV* sv_setref_nv(SV* rv, const char* classname, NV nv) | |
4231 | ||
497711e7 GS |
4232 | =for hackers |
4233 | Found in file sv.c | |
4234 | ||
954c1994 GS |
4235 | =item sv_setref_pv |
4236 | ||
4237 | Copies a pointer into a new SV, optionally blessing the SV. The C<rv> | |
4238 | argument will be upgraded to an RV. That RV will be modified to point to | |
4239 | the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed | |
4240 | into the SV. The C<classname> argument indicates the package for the | |
4241 | blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV | |
4242 | will be returned and will have a reference count of 1. | |
4243 | ||
4244 | Do not use with other Perl types such as HV, AV, SV, CV, because those | |
4245 | objects will become corrupted by the pointer copy process. | |
4246 | ||
4247 | Note that C<sv_setref_pvn> copies the string while this copies the pointer. | |
4248 | ||
4249 | SV* sv_setref_pv(SV* rv, const char* classname, void* pv) | |
4250 | ||
497711e7 GS |
4251 | =for hackers |
4252 | Found in file sv.c | |
4253 | ||
954c1994 GS |
4254 | =item sv_setref_pvn |
4255 | ||
4256 | Copies a string into a new SV, optionally blessing the SV. The length of the | |
4257 | string must be specified with C<n>. The C<rv> argument will be upgraded to | |
4258 | an RV. That RV will be modified to point to the new SV. The C<classname> | |
4259 | argument indicates the package for the blessing. Set C<classname> to | |
4260 | C<Nullch> to avoid the blessing. The new SV will be returned and will have | |
4261 | a reference count of 1. | |
4262 | ||
4263 | Note that C<sv_setref_pv> copies the pointer while this copies the string. | |
4264 | ||
4265 | SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n) | |
4266 | ||
497711e7 GS |
4267 | =for hackers |
4268 | Found in file sv.c | |
4269 | ||
e1c57cef JH |
4270 | =item sv_setref_uv |
4271 | ||
4272 | Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv> | |
4273 | argument will be upgraded to an RV. That RV will be modified to point to | |
4274 | the new SV. The C<classname> argument indicates the package for the | |
4275 | blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV | |
4276 | will be returned and will have a reference count of 1. | |
4277 | ||
4278 | SV* sv_setref_uv(SV* rv, const char* classname, UV uv) | |
4279 | ||
4280 | =for hackers | |
4281 | Found in file sv.c | |
4282 | ||
954c1994 GS |
4283 | =item sv_setsv |
4284 | ||
645c22ef DM |
4285 | Copies the contents of the source SV C<ssv> into the destination SV |
4286 | C<dsv>. The source SV may be destroyed if it is mortal, so don't use this | |
4287 | function if the source SV needs to be reused. Does not handle 'set' magic. | |
4288 | Loosely speaking, it performs a copy-by-value, obliterating any previous | |
4289 | content of the destination. | |
4290 | ||
4291 | You probably want to use one of the assortment of wrappers, such as | |
4292 | C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and | |
4293 | C<SvSetMagicSV_nosteal>. | |
4294 | ||
954c1994 GS |
4295 | void sv_setsv(SV* dsv, SV* ssv) |
4296 | ||
497711e7 GS |
4297 | =for hackers |
4298 | Found in file sv.c | |
4299 | ||
8d6d96c1 HS |
4300 | =item sv_setsv_flags |
4301 | ||
645c22ef DM |
4302 | Copies the contents of the source SV C<ssv> into the destination SV |
4303 | C<dsv>. The source SV may be destroyed if it is mortal, so don't use this | |
4304 | function if the source SV needs to be reused. Does not handle 'set' magic. | |
4305 | Loosely speaking, it performs a copy-by-value, obliterating any previous | |
4306 | content of the destination. | |
4307 | If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on | |
4308 | C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are | |
4309 | implemented in terms of this function. | |
4310 | ||
4311 | You probably want to use one of the assortment of wrappers, such as | |
4312 | C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and | |
4313 | C<SvSetMagicSV_nosteal>. | |
4314 | ||
4315 | This is the primary function for copying scalars, and most other | |
4316 | copy-ish functions and macros use this underneath. | |
8d6d96c1 HS |
4317 | |
4318 | void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags) | |
4319 | ||
4320 | =for hackers | |
4321 | Found in file sv.c | |
4322 | ||
954c1994 GS |
4323 | =item sv_setsv_mg |
4324 | ||
4325 | Like C<sv_setsv>, but also handles 'set' magic. | |
4326 | ||
4327 | void sv_setsv_mg(SV *dstr, SV *sstr) | |
4328 | ||
497711e7 GS |
4329 | =for hackers |
4330 | Found in file sv.c | |
4331 | ||
954c1994 GS |
4332 | =item sv_setuv |
4333 | ||
645c22ef DM |
4334 | Copies an unsigned integer into the given SV, upgrading first if necessary. |
4335 | Does not handle 'set' magic. See also C<sv_setuv_mg>. | |
954c1994 GS |
4336 | |
4337 | void sv_setuv(SV* sv, UV num) | |
4338 | ||
497711e7 GS |
4339 | =for hackers |
4340 | Found in file sv.c | |
4341 | ||
954c1994 GS |
4342 | =item sv_setuv_mg |
4343 | ||
4344 | Like C<sv_setuv>, but also handles 'set' magic. | |
4345 | ||
4346 | void sv_setuv_mg(SV *sv, UV u) | |
4347 | ||
497711e7 GS |
4348 | =for hackers |
4349 | Found in file sv.c | |
4350 | ||
645c22ef DM |
4351 | =item sv_taint |
4352 | ||
4353 | Taint an SV. Use C<SvTAINTED_on> instead. | |
4354 | void sv_taint(SV* sv) | |
4355 | ||
4356 | =for hackers | |
4357 | Found in file sv.c | |
4358 | ||
451be7b1 DM |
4359 | =item sv_tainted |
4360 | ||
4361 | Test an SV for taintedness. Use C<SvTAINTED> instead. | |
4362 | bool sv_tainted(SV* sv) | |
4363 | ||
4364 | =for hackers | |
4365 | Found in file sv.c | |
4366 | ||
c461cf8f JH |
4367 | =item sv_true |
4368 | ||
4369 | Returns true if the SV has a true value by Perl's rules. | |
645c22ef DM |
4370 | Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may |
4371 | instead use an in-line version. | |
c461cf8f JH |
4372 | |
4373 | I32 sv_true(SV *sv) | |
4374 | ||
4375 | =for hackers | |
4376 | Found in file sv.c | |
4377 | ||
4378 | =item sv_unmagic | |
4379 | ||
645c22ef | 4380 | Removes all magic of type C<type> from an SV. |
c461cf8f JH |
4381 | |
4382 | int sv_unmagic(SV* sv, int type) | |
4383 | ||
4384 | =for hackers | |
4385 | Found in file sv.c | |
4386 | ||
954c1994 GS |
4387 | =item sv_unref |
4388 | ||
4389 | Unsets the RV status of the SV, and decrements the reference count of | |
4390 | whatever was being referenced by the RV. This can almost be thought of | |
b06226ff | 4391 | as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag> |
ae154d6d | 4392 | being zero. See C<SvROK_off>. |
954c1994 GS |
4393 | |
4394 | void sv_unref(SV* sv) | |
4395 | ||
497711e7 GS |
4396 | =for hackers |
4397 | Found in file sv.c | |
4398 | ||
840a7b70 IZ |
4399 | =item sv_unref_flags |
4400 | ||
4401 | Unsets the RV status of the SV, and decrements the reference count of | |
4402 | whatever was being referenced by the RV. This can almost be thought of | |
4403 | as a reversal of C<newSVrv>. The C<cflags> argument can contain | |
4404 | C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented | |
4405 | (otherwise the decrementing is conditional on the reference count being | |
4406 | different from one or the reference being a readonly SV). | |
ae154d6d | 4407 | See C<SvROK_off>. |
840a7b70 IZ |
4408 | |
4409 | void sv_unref_flags(SV* sv, U32 flags) | |
4410 | ||
4411 | =for hackers | |
4412 | Found in file sv.c | |
4413 | ||
451be7b1 DM |
4414 | =item sv_untaint |
4415 | ||
4416 | Untaint an SV. Use C<SvTAINTED_off> instead. | |
4417 | void sv_untaint(SV* sv) | |
4418 | ||
4419 | =for hackers | |
4420 | Found in file sv.c | |
4421 | ||
954c1994 GS |
4422 | =item sv_upgrade |
4423 | ||
ff276b08 | 4424 | Upgrade an SV to a more complex form. Generally adds a new body type to the |
645c22ef | 4425 | SV, then copies across as much information as possible from the old body. |
ff276b08 | 4426 | You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>. |
954c1994 GS |
4427 | |
4428 | bool sv_upgrade(SV* sv, U32 mt) | |
4429 | ||
497711e7 GS |
4430 | =for hackers |
4431 | Found in file sv.c | |
4432 | ||
954c1994 GS |
4433 | =item sv_usepvn |
4434 | ||
4435 | Tells an SV to use C<ptr> to find its string value. Normally the string is | |
1c846c1f | 4436 | stored inside the SV but sv_usepvn allows the SV to use an outside string. |
954c1994 GS |
4437 | The C<ptr> should point to memory that was allocated by C<malloc>. The |
4438 | string length, C<len>, must be supplied. This function will realloc the | |
4439 | memory pointed to by C<ptr>, so that pointer should not be freed or used by | |
4440 | the programmer after giving it to sv_usepvn. Does not handle 'set' magic. | |
4441 | See C<sv_usepvn_mg>. | |
4442 | ||
4443 | void sv_usepvn(SV* sv, char* ptr, STRLEN len) | |
4444 | ||
497711e7 GS |
4445 | =for hackers |
4446 | Found in file sv.c | |
4447 | ||
954c1994 GS |
4448 | =item sv_usepvn_mg |
4449 | ||
4450 | Like C<sv_usepvn>, but also handles 'set' magic. | |
4451 | ||
4452 | void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len) | |
4453 | ||
497711e7 GS |
4454 | =for hackers |
4455 | Found in file sv.c | |
4456 | ||
2457d041 JH |
4457 | =item sv_utf8_decode |
4458 | ||
4459 | Convert the octets in the PV from UTF-8 to chars. Scan for validity and then | |
645c22ef | 4460 | turn off SvUTF8 if needed so that we see characters. Used as a building block |
2457d041 JH |
4461 | for decode_utf8 in Encode.xs |
4462 | ||
4463 | NOTE: this function is experimental and may change or be | |
4464 | removed without notice. | |
4465 | ||
4466 | bool sv_utf8_decode(SV *sv) | |
4467 | ||
4468 | =for hackers | |
4469 | Found in file sv.c | |
4470 | ||
c461cf8f JH |
4471 | =item sv_utf8_downgrade |
4472 | ||
4473 | Attempt to convert the PV of an SV from UTF8-encoded to byte encoding. | |
4474 | This may not be possible if the PV contains non-byte encoding characters; | |
4475 | if this is the case, either returns false or, if C<fail_ok> is not | |
4476 | true, croaks. | |
4477 | ||
9ede5bc8 DM |
4478 | This is not as a general purpose Unicode to byte encoding interface: |
4479 | use the Encode extension for that. | |
4480 | ||
c461cf8f JH |
4481 | NOTE: this function is experimental and may change or be |
4482 | removed without notice. | |
4483 | ||
4484 | bool sv_utf8_downgrade(SV *sv, bool fail_ok) | |
4485 | ||
4486 | =for hackers | |
4487 | Found in file sv.c | |
4488 | ||
4489 | =item sv_utf8_encode | |
4490 | ||
4491 | Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8> | |
2457d041 JH |
4492 | flag so that it looks like octets again. Used as a building block |
4493 | for encode_utf8 in Encode.xs | |
c461cf8f JH |
4494 | |
4495 | void sv_utf8_encode(SV *sv) | |
4496 | ||
4497 | =for hackers | |
4498 | Found in file sv.c | |
4499 | ||
4500 | =item sv_utf8_upgrade | |
4501 | ||
4502 | Convert the PV of an SV to its UTF8-encoded form. | |
645c22ef | 4503 | Forces the SV to string form if it is not already. |
2457d041 JH |
4504 | Always sets the SvUTF8 flag to avoid future validity checks even |
4505 | if all the bytes have hibit clear. | |
c461cf8f | 4506 | |
9ede5bc8 DM |
4507 | This is not as a general purpose byte encoding to Unicode interface: |
4508 | use the Encode extension for that. | |
4509 | ||
2457d041 | 4510 | STRLEN sv_utf8_upgrade(SV *sv) |
c461cf8f JH |
4511 | |
4512 | =for hackers | |
4513 | Found in file sv.c | |
4514 | ||
8d6d96c1 HS |
4515 | =item sv_utf8_upgrade_flags |
4516 | ||
4517 | Convert the PV of an SV to its UTF8-encoded form. | |
645c22ef | 4518 | Forces the SV to string form if it is not already. |
8d6d96c1 HS |
4519 | Always sets the SvUTF8 flag to avoid future validity checks even |
4520 | if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set, | |
4521 | will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and | |
4522 | C<sv_utf8_upgrade_nomg> are implemented in terms of this function. | |
4523 | ||
9ede5bc8 DM |
4524 | This is not as a general purpose byte encoding to Unicode interface: |
4525 | use the Encode extension for that. | |
4526 | ||
8d6d96c1 HS |
4527 | STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags) |
4528 | ||
4529 | =for hackers | |
4530 | Found in file sv.c | |
4531 | ||
645c22ef DM |
4532 | =item sv_uv |
4533 | ||
4534 | A private implementation of the C<SvUVx> macro for compilers which can't | |
4535 | cope with complex macro expressions. Always use the macro instead. | |
4536 | ||
4537 | UV sv_uv(SV* sv) | |
4538 | ||
4539 | =for hackers | |
4540 | Found in file sv.c | |
4541 | ||
954c1994 GS |
4542 | =item sv_vcatpvfn |
4543 | ||
4544 | Processes its arguments like C<vsprintf> and appends the formatted output | |
4545 | to an SV. Uses an array of SVs if the C style variable argument list is | |
4546 | missing (NULL). When running with taint checks enabled, indicates via | |
4547 | C<maybe_tainted> if results are untrustworthy (often due to the use of | |
4548 | locales). | |
4549 | ||
645c22ef DM |
4550 | Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>. |
4551 | ||
954c1994 GS |
4552 | void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted) |
4553 | ||
497711e7 GS |
4554 | =for hackers |
4555 | Found in file sv.c | |
4556 | ||
954c1994 GS |
4557 | =item sv_vsetpvfn |
4558 | ||
4559 | Works like C<vcatpvfn> but copies the text into the SV instead of | |
4560 | appending it. | |
4561 | ||
645c22ef DM |
4562 | Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>. |
4563 | ||
954c1994 GS |
4564 | void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted) |
4565 | ||
497711e7 | 4566 | =for hackers |
94bdecf9 JH |
4567 | Found in file sv.c |
4568 | ||
b0f01acb JP |
4569 | =item upg_version |
4570 | ||
4571 | In-place upgrade of the supplied SV to a version object. | |
4572 | ||
4573 | SV *sv = upg_version(SV *sv); | |
4574 | ||
4575 | Returns a pointer to the upgraded SV. | |
4576 | ||
4577 | SV* upg_version(SV *ver) | |
4578 | ||
4579 | =for hackers | |
4580 | Found in file util.c | |
4581 | ||
ad63d80f JP |
4582 | =item vcmp |
4583 | ||
4584 | Version object aware cmp. Both operands must already have been | |
4585 | converted into version objects. | |
4586 | ||
4587 | int vcmp(SV *lvs, SV *rvs) | |
4588 | ||
4589 | =for hackers | |
4590 | Found in file util.c | |
4591 | ||
b0f01acb JP |
4592 | =item vnumify |
4593 | ||
ad63d80f JP |
4594 | Accepts a version object and returns the normalized floating |
4595 | point representation. Call like: | |
b0f01acb | 4596 | |
ad63d80f | 4597 | sv = vnumify(rv); |
b0f01acb | 4598 | |
ad63d80f JP |
4599 | NOTE: you can pass either the object directly or the SV |
4600 | contained within the RV. | |
b0f01acb | 4601 | |
ad63d80f | 4602 | SV* vnumify(SV *vs) |
b0f01acb JP |
4603 | |
4604 | =for hackers | |
4605 | Found in file util.c | |
4606 | ||
4607 | =item vstringify | |
4608 | ||
ad63d80f JP |
4609 | Accepts a version object and returns the normalized string |
4610 | representation. Call like: | |
b0f01acb | 4611 | |
ad63d80f | 4612 | sv = vstringify(rv); |
b0f01acb | 4613 | |
ad63d80f JP |
4614 | NOTE: you can pass either the object directly or the SV |
4615 | contained within the RV. | |
b0f01acb | 4616 | |
ad63d80f | 4617 | SV* vstringify(SV *vs) |
b0f01acb JP |
4618 | |
4619 | =for hackers | |
4620 | Found in file util.c | |
4621 | ||
94bdecf9 JH |
4622 | |
4623 | =back | |
4624 | ||
4625 | =head1 Unicode Support | |
4626 | ||
4627 | =over 8 | |
4628 | ||
4629 | =item bytes_from_utf8 | |
4630 | ||
4631 | Converts a string C<s> of length C<len> from UTF8 into byte encoding. | |
4632 | Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to | |
4633 | the newly-created string, and updates C<len> to contain the new | |
4634 | length. Returns the original string if no conversion occurs, C<len> | |
4635 | is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to | |
4636 | 0 if C<s> is converted or contains all 7bit characters. | |
4637 | ||
4638 | NOTE: this function is experimental and may change or be | |
4639 | removed without notice. | |
4640 | ||
4641 | U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8) | |
4642 | ||
4643 | =for hackers | |
4644 | Found in file utf8.c | |
4645 | ||
4646 | =item bytes_to_utf8 | |
4647 | ||
4648 | Converts a string C<s> of length C<len> from ASCII into UTF8 encoding. | |
4649 | Returns a pointer to the newly-created string, and sets C<len> to | |
4650 | reflect the new length. | |
4651 | ||
4652 | NOTE: this function is experimental and may change or be | |
4653 | removed without notice. | |
4654 | ||
4655 | U8* bytes_to_utf8(U8 *s, STRLEN *len) | |
4656 | ||
4657 | =for hackers | |
4658 | Found in file utf8.c | |
4659 | ||
4660 | =item ibcmp_utf8 | |
4661 | ||
4662 | Return true if the strings s1 and s2 differ case-insensitively, false | |
4663 | if not (if they are equal case-insensitively). If u1 is true, the | |
4664 | string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true, | |
4665 | the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2 | |
4666 | are false, the respective string is assumed to be in native 8-bit | |
4667 | encoding. | |
4668 | ||
4669 | If the pe1 and pe2 are non-NULL, the scanning pointers will be copied | |
4670 | in there (they will point at the beginning of the I<next> character). | |
4671 | If the pointers behind pe1 or pe2 are non-NULL, they are the end | |
4672 | pointers beyond which scanning will not continue under any | |
4673 | circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and | |
4674 | s2+l2 will be used as goal end pointers that will also stop the scan, | |
4675 | and which qualify towards defining a successful match: all the scans | |
4676 | that define an explicit length must reach their goal pointers for | |
4677 | a match to succeed). | |
4678 | ||
4679 | For case-insensitiveness, the "casefolding" of Unicode is used | |
4680 | instead of upper/lowercasing both the characters, see | |
4681 | http://www.unicode.org/unicode/reports/tr21/ (Case Mappings). | |
4682 | ||
4683 | I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2) | |
4684 | ||
4685 | =for hackers | |
4686 | Found in file utf8.c | |
4687 | ||
4688 | =item is_utf8_char | |
4689 | ||
4690 | Tests if some arbitrary number of bytes begins in a valid UTF-8 | |
641d4181 JH |
4691 | character. Note that an INVARIANT (i.e. ASCII) character is a valid |
4692 | UTF-8 character. The actual number of bytes in the UTF-8 character | |
4693 | will be returned if it is valid, otherwise 0. | |
94bdecf9 JH |
4694 | |
4695 | STRLEN is_utf8_char(U8 *p) | |
4696 | ||
4697 | =for hackers | |
4698 | Found in file utf8.c | |
4699 | ||
4700 | =item is_utf8_string | |
4701 | ||
4702 | Returns true if first C<len> bytes of the given string form a valid UTF8 | |
4703 | string, false otherwise. Note that 'a valid UTF8 string' does not mean | |
4704 | 'a string that contains UTF8' because a valid ASCII string is a valid | |
4705 | UTF8 string. | |
4706 | ||
4707 | bool is_utf8_string(U8 *s, STRLEN len) | |
4708 | ||
4709 | =for hackers | |
4710 | Found in file utf8.c | |
497711e7 | 4711 | |
94bdecf9 | 4712 | =item pv_uni_display |
954c1994 | 4713 | |
94bdecf9 JH |
4714 | Build to the scalar dsv a displayable version of the string spv, |
4715 | length len, the displayable version being at most pvlim bytes long | |
4716 | (if longer, the rest is truncated and "..." will be appended). | |
0a2ef054 JH |
4717 | |
4718 | The flags argument can have UNI_DISPLAY_ISPRINT set to display | |
a4f1a029 | 4719 | isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH |
0a2ef054 JH |
4720 | to display the \\[nrfta\\] as the backslashed versions (like '\n') |
4721 | (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\). | |
4722 | UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both | |
4723 | UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on. | |
4724 | ||
94bdecf9 | 4725 | The pointer to the PV of the dsv is returned. |
954c1994 | 4726 | |
94bdecf9 | 4727 | char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags) |
954c1994 | 4728 | |
497711e7 | 4729 | =for hackers |
94bdecf9 | 4730 | Found in file utf8.c |
497711e7 | 4731 | |
94bdecf9 | 4732 | =item sv_recode_to_utf8 |
954c1994 | 4733 | |
94bdecf9 JH |
4734 | The encoding is assumed to be an Encode object, on entry the PV |
4735 | of the sv is assumed to be octets in that encoding, and the sv | |
4736 | will be converted into Unicode (and UTF-8). | |
954c1994 | 4737 | |
94bdecf9 JH |
4738 | If the sv already is UTF-8 (or if it is not POK), or if the encoding |
4739 | is not a reference, nothing is done to the sv. If the encoding is not | |
4740 | an C<Encode::XS> Encoding object, bad things will happen. | |
4741 | (See F<lib/encoding.pm> and L<Encode>). | |
4742 | ||
4743 | The PV of the sv is returned. | |
4744 | ||
4745 | char* sv_recode_to_utf8(SV* sv, SV *encoding) | |
954c1994 | 4746 | |
497711e7 | 4747 | =for hackers |
94bdecf9 | 4748 | Found in file sv.c |
497711e7 | 4749 | |
94bdecf9 | 4750 | =item sv_uni_display |
954c1994 | 4751 | |
94bdecf9 | 4752 | Build to the scalar dsv a displayable version of the scalar sv, |
0a2ef054 | 4753 | the displayable version being at most pvlim bytes long |
94bdecf9 | 4754 | (if longer, the rest is truncated and "..." will be appended). |
0a2ef054 JH |
4755 | |
4756 | The flags argument is as in pv_uni_display(). | |
4757 | ||
94bdecf9 | 4758 | The pointer to the PV of the dsv is returned. |
954c1994 | 4759 | |
94bdecf9 | 4760 | char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags) |
954c1994 | 4761 | |
497711e7 | 4762 | =for hackers |
94bdecf9 | 4763 | Found in file utf8.c |
497711e7 | 4764 | |
6b5c0936 JH |
4765 | =item to_utf8_case |
4766 | ||
4767 | The "p" contains the pointer to the UTF-8 string encoding | |
4768 | the character that is being converted. | |
4769 | ||
4770 | The "ustrp" is a pointer to the character buffer to put the | |
4771 | conversion result to. The "lenp" is a pointer to the length | |
4772 | of the result. | |
4773 | ||
12b7c5c7 | 4774 | The "swashp" is a pointer to the swash to use. |
6b5c0936 | 4775 | |
12b7c5c7 JH |
4776 | Both the special and normal mappings are stored lib/unicore/To/Foo.pl, |
4777 | and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually, | |
4778 | but not always, a multicharacter mapping), is tried first. | |
4779 | ||
4780 | The "special" is a string like "utf8::ToSpecLower", which means the | |
4781 | hash %utf8::ToSpecLower. The access to the hash is through | |
4782 | Perl_to_utf8_case(). | |
6b5c0936 | 4783 | |
12b7c5c7 JH |
4784 | The "normal" is a string like "ToLower" which means the swash |
4785 | %utf8::ToLower. | |
6b5c0936 JH |
4786 | |
4787 | UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special) | |
4788 | ||
4789 | =for hackers | |
4790 | Found in file utf8.c | |
4791 | ||
d3e79532 JH |
4792 | =item to_utf8_fold |
4793 | ||
4794 | Convert the UTF-8 encoded character at p to its foldcase version and | |
4795 | store that in UTF-8 in ustrp and its length in bytes in lenp. Note | |
4796 | that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the | |
4797 | foldcase version may be longer than the original character (up to | |
4798 | three characters). | |
4799 | ||
4800 | The first character of the foldcased version is returned | |
4801 | (but note, as explained above, that there may be more.) | |
4802 | ||
4803 | UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp) | |
4804 | ||
4805 | =for hackers | |
4806 | Found in file utf8.c | |
4807 | ||
4808 | =item to_utf8_lower | |
4809 | ||
4810 | Convert the UTF-8 encoded character at p to its lowercase version and | |
4811 | store that in UTF-8 in ustrp and its length in bytes in lenp. Note | |
4812 | that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the | |
4813 | lowercase version may be longer than the original character (up to two | |
4814 | characters). | |
4815 | ||
4816 | The first character of the lowercased version is returned | |
4817 | (but note, as explained above, that there may be more.) | |
4818 | ||
4819 | UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp) | |
4820 | ||
4821 | =for hackers | |
4822 | Found in file utf8.c | |
4823 | ||
4824 | =item to_utf8_title | |
4825 | ||
4826 | Convert the UTF-8 encoded character at p to its titlecase version and | |
4827 | store that in UTF-8 in ustrp and its length in bytes in lenp. Note | |
4828 | that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the | |
4829 | titlecase version may be longer than the original character (up to two | |
4830 | characters). | |
4831 | ||
4832 | The first character of the titlecased version is returned | |
4833 | (but note, as explained above, that there may be more.) | |
4834 | ||
4835 | UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp) | |
4836 | ||
4837 | =for hackers | |
4838 | Found in file utf8.c | |
4839 | ||
4840 | =item to_utf8_upper | |
4841 | ||
4842 | Convert the UTF-8 encoded character at p to its uppercase version and | |
4843 | store that in UTF-8 in ustrp and its length in bytes in lenp. Note | |
4844 | that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the | |
4845 | uppercase version may be longer than the original character (up to two | |
4846 | characters). | |
4847 | ||
4848 | The first character of the uppercased version is returned | |
4849 | (but note, as explained above, that there may be more.) | |
4850 | ||
4851 | UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp) | |
4852 | ||
4853 | =for hackers | |
4854 | Found in file utf8.c | |
4855 | ||
282f25c9 JH |
4856 | =item utf8n_to_uvchr |
4857 | ||
4858 | Returns the native character value of the first character in the string C<s> | |
4859 | which is assumed to be in UTF8 encoding; C<retlen> will be set to the | |
4860 | length, in bytes, of that character. | |
4861 | ||
4862 | Allows length and flags to be passed to low level routine. | |
4863 | ||
4864 | UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags) | |
4865 | ||
4866 | =for hackers | |
4867 | Found in file utf8.c | |
4868 | ||
4869 | =item utf8n_to_uvuni | |
4870 | ||
4871 | Bottom level UTF-8 decode routine. | |
4872 | Returns the unicode code point value of the first character in the string C<s> | |
4873 | which is assumed to be in UTF8 encoding and no longer than C<curlen>; | |
4874 | C<retlen> will be set to the length, in bytes, of that character. | |
4875 | ||
4876 | If C<s> does not point to a well-formed UTF8 character, the behaviour | |
4877 | is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY, | |
4878 | it is assumed that the caller will raise a warning, and this function | |
4879 | will silently just set C<retlen> to C<-1> and return zero. If the | |
4880 | C<flags> does not contain UTF8_CHECK_ONLY, warnings about | |
4881 | malformations will be given, C<retlen> will be set to the expected | |
4882 | length of the UTF-8 character in bytes, and zero will be returned. | |
4883 | ||
4884 | The C<flags> can also contain various flags to allow deviations from | |
4885 | the strict UTF-8 encoding (see F<utf8.h>). | |
4886 | ||
4887 | Most code should use utf8_to_uvchr() rather than call this directly. | |
4888 | ||
4889 | UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags) | |
4890 | ||
4891 | =for hackers | |
4892 | Found in file utf8.c | |
4893 | ||
b06226ff JH |
4894 | =item utf8_distance |
4895 | ||
4896 | Returns the number of UTF8 characters between the UTF-8 pointers C<a> | |
4897 | and C<b>. | |
4898 | ||
4899 | WARNING: use only if you *know* that the pointers point inside the | |
4900 | same UTF-8 buffer. | |
4901 | ||
4902 | IV utf8_distance(U8 *a, U8 *b) | |
4903 | ||
4904 | =for hackers | |
4905 | Found in file utf8.c | |
4906 | ||
4907 | =item utf8_hop | |
4908 | ||
8850bf83 JH |
4909 | Return the UTF-8 pointer C<s> displaced by C<off> characters, either |
4910 | forward or backward. | |
b06226ff JH |
4911 | |
4912 | WARNING: do not use the following unless you *know* C<off> is within | |
8850bf83 JH |
4913 | the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned |
4914 | on the first byte of character or just after the last byte of a character. | |
b06226ff JH |
4915 | |
4916 | U8* utf8_hop(U8 *s, I32 off) | |
4917 | ||
4918 | =for hackers | |
4919 | Found in file utf8.c | |
4920 | ||
4921 | =item utf8_length | |
4922 | ||
4923 | Return the length of the UTF-8 char encoded string C<s> in characters. | |
4924 | Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end | |
4925 | up past C<e>, croaks. | |
4926 | ||
4927 | STRLEN utf8_length(U8* s, U8 *e) | |
4928 | ||
4929 | =for hackers | |
4930 | Found in file utf8.c | |
4931 | ||
497711e7 GS |
4932 | =item utf8_to_bytes |
4933 | ||
246fae53 MG |
4934 | Converts a string C<s> of length C<len> from UTF8 into byte encoding. |
4935 | Unlike C<bytes_to_utf8>, this over-writes the original string, and | |
4936 | updates len to contain the new length. | |
67e989fb | 4937 | Returns zero on failure, setting C<len> to -1. |
497711e7 | 4938 | |
eebe1485 SC |
4939 | NOTE: this function is experimental and may change or be |
4940 | removed without notice. | |
4941 | ||
4942 | U8* utf8_to_bytes(U8 *s, STRLEN *len) | |
497711e7 GS |
4943 | |
4944 | =for hackers | |
4945 | Found in file utf8.c | |
4946 | ||
282f25c9 | 4947 | =item utf8_to_uvchr |
b6b716fe | 4948 | |
282f25c9 JH |
4949 | Returns the native character value of the first character in the string C<s> |
4950 | which is assumed to be in UTF8 encoding; C<retlen> will be set to the | |
4951 | length, in bytes, of that character. | |
28d3d195 | 4952 | |
282f25c9 JH |
4953 | If C<s> does not point to a well-formed UTF8 character, zero is |
4954 | returned and retlen is set, if possible, to -1. | |
444155da | 4955 | |
282f25c9 | 4956 | UV utf8_to_uvchr(U8 *s, STRLEN* retlen) |
444155da JH |
4957 | |
4958 | =for hackers | |
4959 | Found in file utf8.c | |
4960 | ||
282f25c9 | 4961 | =item utf8_to_uvuni |
444155da | 4962 | |
282f25c9 | 4963 | Returns the Unicode code point of the first character in the string C<s> |
dcad2880 | 4964 | which is assumed to be in UTF8 encoding; C<retlen> will be set to the |
1aa99e6b | 4965 | length, in bytes, of that character. |
444155da | 4966 | |
282f25c9 JH |
4967 | This function should only be used when returned UV is considered |
4968 | an index into the Unicode semantic tables (e.g. swashes). | |
4969 | ||
dcad2880 JH |
4970 | If C<s> does not point to a well-formed UTF8 character, zero is |
4971 | returned and retlen is set, if possible, to -1. | |
b6b716fe | 4972 | |
282f25c9 JH |
4973 | UV utf8_to_uvuni(U8 *s, STRLEN* retlen) |
4974 | ||
4975 | =for hackers | |
4976 | Found in file utf8.c | |
4977 | ||
4978 | =item uvchr_to_utf8 | |
4979 | ||
4980 | Adds the UTF8 representation of the Native codepoint C<uv> to the end | |
4981 | of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free | |
4982 | bytes available. The return value is the pointer to the byte after the | |
4983 | end of the new character. In other words, | |
4984 | ||
4985 | d = uvchr_to_utf8(d, uv); | |
4986 | ||
4987 | is the recommended wide native character-aware way of saying | |
4988 | ||
4989 | *(d++) = uv; | |
4990 | ||
4991 | U8* uvchr_to_utf8(U8 *d, UV uv) | |
eebe1485 SC |
4992 | |
4993 | =for hackers | |
4994 | Found in file utf8.c | |
4995 | ||
b851fbc1 | 4996 | =item uvuni_to_utf8_flags |
eebe1485 SC |
4997 | |
4998 | Adds the UTF8 representation of the Unicode codepoint C<uv> to the end | |
4999 | of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free | |
5000 | bytes available. The return value is the pointer to the byte after the | |
282f25c9 | 5001 | end of the new character. In other words, |
eebe1485 | 5002 | |
b851fbc1 JH |
5003 | d = uvuni_to_utf8_flags(d, uv, flags); |
5004 | ||
5005 | or, in most cases, | |
5006 | ||
282f25c9 | 5007 | d = uvuni_to_utf8(d, uv); |
eebe1485 | 5008 | |
b851fbc1 JH |
5009 | (which is equivalent to) |
5010 | ||
5011 | d = uvuni_to_utf8_flags(d, uv, 0); | |
5012 | ||
eebe1485 SC |
5013 | is the recommended Unicode-aware way of saying |
5014 | ||
5015 | *(d++) = uv; | |
5016 | ||
b851fbc1 | 5017 | U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags) |
b6b716fe SC |
5018 | |
5019 | =for hackers | |
5020 | Found in file utf8.c | |
5021 | ||
497711e7 | 5022 | |
94bdecf9 | 5023 | =back |
954c1994 | 5024 | |
94bdecf9 | 5025 | =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions |
954c1994 | 5026 | |
94bdecf9 | 5027 | =over 8 |
954c1994 | 5028 | |
94bdecf9 | 5029 | =item ax |
497711e7 | 5030 | |
94bdecf9 JH |
5031 | Variable which is setup by C<xsubpp> to indicate the stack base offset, |
5032 | used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro | |
5033 | must be called prior to setup the C<MARK> variable. | |
954c1994 | 5034 | |
94bdecf9 | 5035 | I32 ax |
954c1994 | 5036 | |
497711e7 GS |
5037 | =for hackers |
5038 | Found in file XSUB.h | |
5039 | ||
94bdecf9 | 5040 | =item CLASS |
954c1994 | 5041 | |
94bdecf9 JH |
5042 | Variable which is setup by C<xsubpp> to indicate the |
5043 | class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>. | |
954c1994 | 5044 | |
94bdecf9 | 5045 | char* CLASS |
954c1994 | 5046 | |
497711e7 GS |
5047 | =for hackers |
5048 | Found in file XSUB.h | |
5049 | ||
94bdecf9 | 5050 | =item dAX |
954c1994 | 5051 | |
94bdecf9 JH |
5052 | Sets up the C<ax> variable. |
5053 | This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>. | |
954c1994 | 5054 | |
94bdecf9 | 5055 | dAX; |
954c1994 | 5056 | |
497711e7 GS |
5057 | =for hackers |
5058 | Found in file XSUB.h | |
5059 | ||
94bdecf9 | 5060 | =item dITEMS |
954c1994 | 5061 | |
94bdecf9 JH |
5062 | Sets up the C<items> variable. |
5063 | This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>. | |
954c1994 | 5064 | |
94bdecf9 | 5065 | dITEMS; |
954c1994 | 5066 | |
497711e7 GS |
5067 | =for hackers |
5068 | Found in file XSUB.h | |
5069 | ||
94bdecf9 | 5070 | =item dXSARGS |
954c1994 | 5071 | |
94bdecf9 JH |
5072 | Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. |
5073 | Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>. | |
5074 | This is usually handled automatically by C<xsubpp>. | |
954c1994 | 5075 | |
94bdecf9 | 5076 | dXSARGS; |
954c1994 | 5077 | |
497711e7 GS |
5078 | =for hackers |
5079 | Found in file XSUB.h | |
5080 | ||
94bdecf9 | 5081 | =item dXSI32 |
954c1994 | 5082 | |
94bdecf9 JH |
5083 | Sets up the C<ix> variable for an XSUB which has aliases. This is usually |
5084 | handled automatically by C<xsubpp>. | |
954c1994 | 5085 | |
94bdecf9 | 5086 | dXSI32; |
954c1994 | 5087 | |
497711e7 GS |
5088 | =for hackers |
5089 | Found in file XSUB.h | |
5090 | ||
94bdecf9 | 5091 | =item items |
954c1994 | 5092 | |
94bdecf9 JH |
5093 | Variable which is setup by C<xsubpp> to indicate the number of |
5094 | items on the stack. See L<perlxs/"Variable-length Parameter Lists">. | |
954c1994 | 5095 | |
94bdecf9 | 5096 | I32 items |
954c1994 | 5097 | |
497711e7 GS |
5098 | =for hackers |
5099 | Found in file XSUB.h | |
5100 | ||
94bdecf9 | 5101 | =item ix |
954c1994 | 5102 | |
94bdecf9 JH |
5103 | Variable which is setup by C<xsubpp> to indicate which of an |
5104 | XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">. | |
954c1994 | 5105 | |
94bdecf9 | 5106 | I32 ix |
954c1994 | 5107 | |
497711e7 GS |
5108 | =for hackers |
5109 | Found in file XSUB.h | |
5110 | ||
94bdecf9 | 5111 | =item newXSproto |
954c1994 | 5112 | |
94bdecf9 JH |
5113 | Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to |
5114 | the subs. | |
954c1994 | 5115 | |
497711e7 GS |
5116 | =for hackers |
5117 | Found in file XSUB.h | |
5118 | ||
94bdecf9 | 5119 | =item RETVAL |
954c1994 | 5120 | |
94bdecf9 JH |
5121 | Variable which is setup by C<xsubpp> to hold the return value for an |
5122 | XSUB. This is always the proper type for the XSUB. See | |
5123 | L<perlxs/"The RETVAL Variable">. | |
954c1994 | 5124 | |
94bdecf9 | 5125 | (whatever) RETVAL |
954c1994 | 5126 | |
497711e7 GS |
5127 | =for hackers |
5128 | Found in file XSUB.h | |
5129 | ||
94bdecf9 | 5130 | =item ST |
954c1994 | 5131 | |
94bdecf9 | 5132 | Used to access elements on the XSUB's stack. |
954c1994 | 5133 | |
94bdecf9 | 5134 | SV* ST(int ix) |
954c1994 | 5135 | |
497711e7 GS |
5136 | =for hackers |
5137 | Found in file XSUB.h | |
5138 | ||
94bdecf9 | 5139 | =item THIS |
954c1994 | 5140 | |
94bdecf9 JH |
5141 | Variable which is setup by C<xsubpp> to designate the object in a C++ |
5142 | XSUB. This is always the proper type for the C++ object. See C<CLASS> and | |
5143 | L<perlxs/"Using XS With C++">. | |
954c1994 | 5144 | |
94bdecf9 | 5145 | (whatever) THIS |
954c1994 | 5146 | |
497711e7 GS |
5147 | =for hackers |
5148 | Found in file XSUB.h | |
5149 | ||
94bdecf9 | 5150 | =item XS |
954c1994 | 5151 | |
94bdecf9 JH |
5152 | Macro to declare an XSUB and its C parameter list. This is handled by |
5153 | C<xsubpp>. | |
954c1994 | 5154 | |
497711e7 GS |
5155 | =for hackers |
5156 | Found in file XSUB.h | |
5157 | ||
94bdecf9 | 5158 | =item XSRETURN_EMPTY |
497711e7 | 5159 | |
94bdecf9 | 5160 | Return an empty list from an XSUB immediately. |
954c1994 | 5161 | |
954c1994 | 5162 | |
94bdecf9 | 5163 | XSRETURN_EMPTY; |
954c1994 | 5164 | |
497711e7 GS |
5165 | =for hackers |
5166 | Found in file XSUB.h | |
5167 | ||
954c1994 GS |
5168 | =item XS_VERSION |
5169 | ||
5170 | The version identifier for an XS module. This is usually | |
5171 | handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>. | |
5172 | ||
497711e7 GS |
5173 | =for hackers |
5174 | Found in file XSUB.h | |
5175 | ||
954c1994 GS |
5176 | =item XS_VERSION_BOOTCHECK |
5177 | ||
5178 | Macro to verify that a PM module's $VERSION variable matches the XS | |
5179 | module's C<XS_VERSION> variable. This is usually handled automatically by | |
5180 | C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">. | |
5181 | ||
5182 | XS_VERSION_BOOTCHECK; | |
5183 | ||
497711e7 GS |
5184 | =for hackers |
5185 | Found in file XSUB.h | |
5186 | ||
954c1994 | 5187 | |
94bdecf9 | 5188 | =back |
954c1994 | 5189 | |
94bdecf9 JH |
5190 | =head1 Warning and Dieing |
5191 | ||
5192 | =over 8 | |
5193 | ||
5194 | =item croak | |
5195 | ||
5196 | This is the XSUB-writer's interface to Perl's C<die> function. | |
5197 | Normally use this function the same way you use the C C<printf> | |
5198 | function. See C<warn>. | |
5199 | ||
5200 | If you want to throw an exception object, assign the object to | |
5201 | C<$@> and then pass C<Nullch> to croak(): | |
5202 | ||
5203 | errsv = get_sv("@", TRUE); | |
5204 | sv_setsv(errsv, exception_object); | |
5205 | croak(Nullch); | |
5206 | ||
5207 | void croak(const char* pat, ...) | |
954c1994 | 5208 | |
497711e7 | 5209 | =for hackers |
94bdecf9 JH |
5210 | Found in file util.c |
5211 | ||
5212 | =item warn | |
5213 | ||
5214 | This is the XSUB-writer's interface to Perl's C<warn> function. Use this | |
5215 | function the same way you use the C C<printf> function. See | |
5216 | C<croak>. | |
5217 | ||
5218 | void warn(const char* pat, ...) | |
5219 | ||
5220 | =for hackers | |
5221 | Found in file util.c | |
5222 | ||
497711e7 | 5223 | |
954c1994 GS |
5224 | =back |
5225 | ||
5226 | =head1 AUTHORS | |
5227 | ||
5228 | Until May 1997, this document was maintained by Jeff Okamoto | |
5229 | <okamoto@corp.hp.com>. It is now maintained as part of Perl itself. | |
5230 | ||
5231 | With lots of help and suggestions from Dean Roehrich, Malcolm Beattie, | |
5232 | Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil | |
5233 | Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, | |
5234 | Stephen McCamant, and Gurusamy Sarathy. | |
5235 | ||
5236 | API Listing originally by Dean Roehrich <roehrich@cray.com>. | |
5237 | ||
5238 | Updated to be autogenerated from comments in the source by Benjamin Stuhl. | |
5239 | ||
5240 | =head1 SEE ALSO | |
5241 | ||
5242 | perlguts(1), perlxs(1), perlxstut(1), perlintern(1) | |
5243 |