Commit | Line | Data |
---|---|---|
e0492643 NC |
1 | -*- buffer-read-only: t -*- |
2 | ||
3 | !!!!!!! DO NOT EDIT THIS FILE !!!!!!! | |
4 | This file is built by autodoc.pl extracting documentation from the C source | |
5 | files. | |
6 | ||
954c1994 GS |
7 | =head1 NAME |
8 | ||
9 | perlapi - autogenerated documentation for the perl public API | |
10 | ||
11 | =head1 DESCRIPTION | |
d8c40edc | 12 | X<Perl API> X<API> X<api> |
954c1994 | 13 | |
1c846c1f NIS |
14 | This file contains the documentation of the perl public API generated by |
15 | embed.pl, specifically a listing of functions, macros, flags, and variables | |
16 | that may be used by extension writers. The interfaces of any functions that | |
954c1994 GS |
17 | are not listed here are subject to change without notice. For this reason, |
18 | blindly using functions listed in proto.h is to be avoided when writing | |
19 | extensions. | |
20 | ||
21 | Note that all Perl API global variables must be referenced with the C<PL_> | |
22 | prefix. Some macros are provided for compatibility with the older, | |
23 | unadorned names, but this support may be disabled in a future release. | |
24 | ||
25 | The listing is alphabetical, case insensitive. | |
26 | ||
94bdecf9 JH |
27 | |
28 | =head1 "Gimme" Values | |
29 | ||
30 | =over 8 | |
31 | ||
32 | =item GIMME | |
d8c40edc | 33 | X<GIMME> |
94bdecf9 JH |
34 | |
35 | A backward-compatible version of C<GIMME_V> which can only return | |
36 | C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>. | |
37 | Deprecated. Use C<GIMME_V> instead. | |
38 | ||
39 | U32 GIMME | |
40 | ||
41 | =for hackers | |
42 | Found in file op.h | |
43 | ||
44 | =item GIMME_V | |
d8c40edc | 45 | X<GIMME_V> |
94bdecf9 JH |
46 | |
47 | The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>, | |
48 | C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context, | |
49 | respectively. | |
50 | ||
51 | U32 GIMME_V | |
52 | ||
53 | =for hackers | |
54 | Found in file op.h | |
55 | ||
56 | =item G_ARRAY | |
d8c40edc | 57 | X<G_ARRAY> |
94bdecf9 JH |
58 | |
59 | Used to indicate list context. See C<GIMME_V>, C<GIMME> and | |
60 | L<perlcall>. | |
61 | ||
62 | =for hackers | |
63 | Found in file cop.h | |
64 | ||
65 | =item G_DISCARD | |
d8c40edc | 66 | X<G_DISCARD> |
94bdecf9 JH |
67 | |
68 | Indicates that arguments returned from a callback should be discarded. See | |
69 | L<perlcall>. | |
70 | ||
71 | =for hackers | |
72 | Found in file cop.h | |
73 | ||
74 | =item G_EVAL | |
d8c40edc | 75 | X<G_EVAL> |
94bdecf9 JH |
76 | |
77 | Used to force a Perl C<eval> wrapper around a callback. See | |
78 | L<perlcall>. | |
79 | ||
80 | =for hackers | |
81 | Found in file cop.h | |
82 | ||
83 | =item G_NOARGS | |
d8c40edc | 84 | X<G_NOARGS> |
94bdecf9 JH |
85 | |
86 | Indicates that no arguments are being sent to a callback. See | |
87 | L<perlcall>. | |
88 | ||
89 | =for hackers | |
90 | Found in file cop.h | |
91 | ||
92 | =item G_SCALAR | |
d8c40edc | 93 | X<G_SCALAR> |
94bdecf9 JH |
94 | |
95 | Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and | |
96 | L<perlcall>. | |
97 | ||
98 | =for hackers | |
99 | Found in file cop.h | |
100 | ||
101 | =item G_VOID | |
d8c40edc | 102 | X<G_VOID> |
94bdecf9 JH |
103 | |
104 | Used to indicate void context. See C<GIMME_V> and L<perlcall>. | |
105 | ||
106 | =for hackers | |
107 | Found in file cop.h | |
108 | ||
109 | ||
110 | =back | |
111 | ||
112 | =head1 Array Manipulation Functions | |
113 | ||
954c1994 GS |
114 | =over 8 |
115 | ||
116 | =item AvFILL | |
d8c40edc | 117 | X<AvFILL> |
954c1994 GS |
118 | |
119 | Same as C<av_len()>. Deprecated, use C<av_len()> instead. | |
120 | ||
121 | int AvFILL(AV* av) | |
122 | ||
497711e7 GS |
123 | =for hackers |
124 | Found in file av.h | |
125 | ||
954c1994 | 126 | =item av_clear |
d8c40edc | 127 | X<av_clear> |
954c1994 GS |
128 | |
129 | Clears an array, making it empty. Does not free the memory used by the | |
130 | array itself. | |
131 | ||
132 | void av_clear(AV* ar) | |
133 | ||
497711e7 GS |
134 | =for hackers |
135 | Found in file av.c | |
136 | ||
bcdf7404 YO |
137 | =item av_create_and_push |
138 | X<av_create_and_push> | |
139 | ||
140 | Push an SV onto the end of the array, creating the array if necessary. | |
141 | A small internal helper function to remove a commonly duplicated idiom. | |
142 | ||
143 | NOTE: this function is experimental and may change or be | |
144 | removed without notice. | |
145 | ||
146 | void av_create_and_push(AV **const avp, SV *const val) | |
147 | ||
148 | =for hackers | |
149 | Found in file av.c | |
150 | ||
151 | =item av_create_and_unshift_one | |
152 | X<av_create_and_unshift_one> | |
153 | ||
154 | Unshifts an SV onto the beginning of the array, creating the array if | |
155 | necessary. | |
156 | A small internal helper function to remove a commonly duplicated idiom. | |
157 | ||
158 | NOTE: this function is experimental and may change or be | |
159 | removed without notice. | |
160 | ||
161 | SV** av_create_and_unshift_one(AV **const avp, SV *const val) | |
162 | ||
163 | =for hackers | |
164 | Found in file av.c | |
165 | ||
f3b76584 | 166 | =item av_delete |
d8c40edc | 167 | X<av_delete> |
f3b76584 SC |
168 | |
169 | Deletes the element indexed by C<key> from the array. Returns the | |
b9381830 JP |
170 | deleted element. If C<flags> equals C<G_DISCARD>, the element is freed |
171 | and null is returned. | |
f3b76584 SC |
172 | |
173 | SV* av_delete(AV* ar, I32 key, I32 flags) | |
174 | ||
175 | =for hackers | |
176 | Found in file av.c | |
177 | ||
178 | =item av_exists | |
d8c40edc | 179 | X<av_exists> |
f3b76584 SC |
180 | |
181 | Returns true if the element indexed by C<key> has been initialized. | |
182 | ||
183 | This relies on the fact that uninitialized array elements are set to | |
184 | C<&PL_sv_undef>. | |
185 | ||
186 | bool av_exists(AV* ar, I32 key) | |
187 | ||
188 | =for hackers | |
189 | Found in file av.c | |
190 | ||
954c1994 | 191 | =item av_extend |
d8c40edc | 192 | X<av_extend> |
954c1994 GS |
193 | |
194 | Pre-extend an array. The C<key> is the index to which the array should be | |
195 | extended. | |
196 | ||
197 | void av_extend(AV* ar, I32 key) | |
198 | ||
497711e7 GS |
199 | =for hackers |
200 | Found in file av.c | |
201 | ||
954c1994 | 202 | =item av_fetch |
d8c40edc | 203 | X<av_fetch> |
954c1994 GS |
204 | |
205 | Returns the SV at the specified index in the array. The C<key> is the | |
206 | index. If C<lval> is set then the fetch will be part of a store. Check | |
207 | that the return value is non-null before dereferencing it to a C<SV*>. | |
208 | ||
96f1132b GS |
209 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for |
210 | more information on how to use this function on tied arrays. | |
954c1994 GS |
211 | |
212 | SV** av_fetch(AV* ar, I32 key, I32 lval) | |
213 | ||
497711e7 GS |
214 | =for hackers |
215 | Found in file av.c | |
216 | ||
f3b76584 | 217 | =item av_fill |
d8c40edc | 218 | X<av_fill> |
f3b76584 | 219 | |
1d51329b | 220 | Set the highest index in the array to the given number, equivalent to |
f3b76584 SC |
221 | Perl's C<$#array = $fill;>. |
222 | ||
1d51329b RGS |
223 | The number of elements in the an array will be C<fill + 1> after |
224 | av_fill() returns. If the array was previously shorter then the | |
225 | additional elements appended are set to C<PL_sv_undef>. If the array | |
226 | was longer, then the excess elements are freed. C<av_fill(av, -1)> is | |
227 | the same as C<av_clear(av)>. | |
228 | ||
f3b76584 SC |
229 | void av_fill(AV* ar, I32 fill) |
230 | ||
231 | =for hackers | |
232 | Found in file av.c | |
233 | ||
954c1994 | 234 | =item av_len |
d8c40edc | 235 | X<av_len> |
954c1994 | 236 | |
1d51329b RGS |
237 | Returns the highest index in the array. The number of elements in the |
238 | array is C<av_len(av) + 1>. Returns -1 if the array is empty. | |
954c1994 | 239 | |
35a4481c | 240 | I32 av_len(const AV* ar) |
954c1994 | 241 | |
497711e7 GS |
242 | =for hackers |
243 | Found in file av.c | |
244 | ||
954c1994 | 245 | =item av_make |
d8c40edc | 246 | X<av_make> |
954c1994 GS |
247 | |
248 | Creates a new AV and populates it with a list of SVs. The SVs are copied | |
249 | into the array, so they may be freed after the call to av_make. The new AV | |
250 | will have a reference count of 1. | |
251 | ||
252 | AV* av_make(I32 size, SV** svp) | |
253 | ||
497711e7 GS |
254 | =for hackers |
255 | Found in file av.c | |
256 | ||
954c1994 | 257 | =item av_pop |
d8c40edc | 258 | X<av_pop> |
954c1994 GS |
259 | |
260 | Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array | |
261 | is empty. | |
262 | ||
263 | SV* av_pop(AV* ar) | |
264 | ||
497711e7 GS |
265 | =for hackers |
266 | Found in file av.c | |
267 | ||
954c1994 | 268 | =item av_push |
d8c40edc | 269 | X<av_push> |
954c1994 GS |
270 | |
271 | Pushes an SV onto the end of the array. The array will grow automatically | |
272 | to accommodate the addition. | |
273 | ||
274 | void av_push(AV* ar, SV* val) | |
275 | ||
497711e7 GS |
276 | =for hackers |
277 | Found in file av.c | |
278 | ||
954c1994 | 279 | =item av_shift |
d8c40edc | 280 | X<av_shift> |
954c1994 GS |
281 | |
282 | Shifts an SV off the beginning of the array. | |
283 | ||
284 | SV* av_shift(AV* ar) | |
285 | ||
497711e7 GS |
286 | =for hackers |
287 | Found in file av.c | |
288 | ||
954c1994 | 289 | =item av_store |
d8c40edc | 290 | X<av_store> |
954c1994 GS |
291 | |
292 | Stores an SV in an array. The array index is specified as C<key>. The | |
293 | return value will be NULL if the operation failed or if the value did not | |
294 | need to be actually stored within the array (as in the case of tied | |
295 | arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note | |
296 | that the caller is responsible for suitably incrementing the reference | |
297 | count of C<val> before the call, and decrementing it if the function | |
298 | returned NULL. | |
299 | ||
96f1132b | 300 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for |
954c1994 GS |
301 | more information on how to use this function on tied arrays. |
302 | ||
303 | SV** av_store(AV* ar, I32 key, SV* val) | |
304 | ||
497711e7 GS |
305 | =for hackers |
306 | Found in file av.c | |
307 | ||
954c1994 | 308 | =item av_undef |
d8c40edc | 309 | X<av_undef> |
954c1994 GS |
310 | |
311 | Undefines the array. Frees the memory used by the array itself. | |
312 | ||
313 | void av_undef(AV* ar) | |
314 | ||
497711e7 GS |
315 | =for hackers |
316 | Found in file av.c | |
317 | ||
954c1994 | 318 | =item av_unshift |
d8c40edc | 319 | X<av_unshift> |
954c1994 GS |
320 | |
321 | Unshift the given number of C<undef> values onto the beginning of the | |
322 | array. The array will grow automatically to accommodate the addition. You | |
323 | must then use C<av_store> to assign values to these new elements. | |
324 | ||
325 | void av_unshift(AV* ar, I32 num) | |
326 | ||
497711e7 GS |
327 | =for hackers |
328 | Found in file av.c | |
329 | ||
94bdecf9 | 330 | =item get_av |
d8c40edc | 331 | X<get_av> |
9f2ea798 | 332 | |
94bdecf9 JH |
333 | Returns the AV of the specified Perl array. If C<create> is set and the |
334 | Perl variable does not exist then it will be created. If C<create> is not | |
335 | set and the variable does not exist then NULL is returned. | |
9f2ea798 | 336 | |
94bdecf9 JH |
337 | NOTE: the perl_ form of this function is deprecated. |
338 | ||
339 | AV* get_av(const char* name, I32 create) | |
9f2ea798 DM |
340 | |
341 | =for hackers | |
94bdecf9 | 342 | Found in file perl.c |
9f2ea798 | 343 | |
94bdecf9 | 344 | =item newAV |
d8c40edc | 345 | X<newAV> |
f9a63242 | 346 | |
94bdecf9 | 347 | Creates a new AV. The reference count is set to 1. |
f9a63242 | 348 | |
94bdecf9 JH |
349 | AV* newAV() |
350 | ||
351 | =for hackers | |
352 | Found in file av.c | |
353 | ||
94bdecf9 | 354 | =item sortsv |
d8c40edc | 355 | X<sortsv> |
497711e7 | 356 | |
94bdecf9 | 357 | Sort an array. Here is an example: |
497711e7 | 358 | |
94bdecf9 | 359 | sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale); |
eebe1485 | 360 | |
7b9ef140 RH |
361 | Currently this always uses mergesort. See sortsv_flags for a more |
362 | flexible routine. | |
641d4181 | 363 | |
aa924a5a | 364 | void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp) |
497711e7 GS |
365 | |
366 | =for hackers | |
94bdecf9 JH |
367 | Found in file pp_sort.c |
368 | ||
7b9ef140 RH |
369 | =item sortsv_flags |
370 | X<sortsv_flags> | |
371 | ||
372 | Sort an array, with various options. | |
373 | ||
374 | void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags) | |
375 | ||
376 | =for hackers | |
377 | Found in file pp_sort.c | |
378 | ||
94bdecf9 JH |
379 | |
380 | =back | |
381 | ||
382 | =head1 Callback Functions | |
383 | ||
384 | =over 8 | |
497711e7 | 385 | |
954c1994 | 386 | =item call_argv |
d8c40edc | 387 | X<call_argv> |
954c1994 GS |
388 | |
389 | Performs a callback to the specified Perl sub. See L<perlcall>. | |
390 | ||
391 | NOTE: the perl_ form of this function is deprecated. | |
392 | ||
8f42b153 | 393 | I32 call_argv(const char* sub_name, I32 flags, char** argv) |
954c1994 | 394 | |
497711e7 GS |
395 | =for hackers |
396 | Found in file perl.c | |
397 | ||
954c1994 | 398 | =item call_method |
d8c40edc | 399 | X<call_method> |
954c1994 GS |
400 | |
401 | Performs a callback to the specified Perl method. The blessed object must | |
402 | be on the stack. See L<perlcall>. | |
403 | ||
404 | NOTE: the perl_ form of this function is deprecated. | |
405 | ||
406 | I32 call_method(const char* methname, I32 flags) | |
407 | ||
497711e7 GS |
408 | =for hackers |
409 | Found in file perl.c | |
410 | ||
954c1994 | 411 | =item call_pv |
d8c40edc | 412 | X<call_pv> |
954c1994 GS |
413 | |
414 | Performs a callback to the specified Perl sub. See L<perlcall>. | |
415 | ||
416 | NOTE: the perl_ form of this function is deprecated. | |
417 | ||
418 | I32 call_pv(const char* sub_name, I32 flags) | |
419 | ||
497711e7 GS |
420 | =for hackers |
421 | Found in file perl.c | |
422 | ||
954c1994 | 423 | =item call_sv |
d8c40edc | 424 | X<call_sv> |
954c1994 GS |
425 | |
426 | Performs a callback to the Perl sub whose name is in the SV. See | |
427 | L<perlcall>. | |
428 | ||
429 | NOTE: the perl_ form of this function is deprecated. | |
430 | ||
431 | I32 call_sv(SV* sv, I32 flags) | |
432 | ||
497711e7 GS |
433 | =for hackers |
434 | Found in file perl.c | |
435 | ||
94bdecf9 | 436 | =item ENTER |
d8c40edc | 437 | X<ENTER> |
954c1994 | 438 | |
94bdecf9 | 439 | Opening bracket on a callback. See C<LEAVE> and L<perlcall>. |
954c1994 | 440 | |
94bdecf9 | 441 | ENTER; |
954c1994 | 442 | |
497711e7 | 443 | =for hackers |
94bdecf9 | 444 | Found in file scope.h |
497711e7 | 445 | |
94bdecf9 | 446 | =item eval_pv |
d8c40edc | 447 | X<eval_pv> |
954c1994 | 448 | |
94bdecf9 | 449 | Tells Perl to C<eval> the given string and return an SV* result. |
954c1994 | 450 | |
94bdecf9 | 451 | NOTE: the perl_ form of this function is deprecated. |
954c1994 | 452 | |
94bdecf9 | 453 | SV* eval_pv(const char* p, I32 croak_on_error) |
497711e7 | 454 | |
94bdecf9 JH |
455 | =for hackers |
456 | Found in file perl.c | |
954c1994 | 457 | |
94bdecf9 | 458 | =item eval_sv |
d8c40edc | 459 | X<eval_sv> |
c9d5ac95 | 460 | |
94bdecf9 | 461 | Tells Perl to C<eval> the string in the SV. |
c9d5ac95 | 462 | |
94bdecf9 | 463 | NOTE: the perl_ form of this function is deprecated. |
954c1994 | 464 | |
94bdecf9 | 465 | I32 eval_sv(SV* sv, I32 flags) |
954c1994 | 466 | |
497711e7 | 467 | =for hackers |
94bdecf9 | 468 | Found in file perl.c |
497711e7 | 469 | |
94bdecf9 | 470 | =item FREETMPS |
d8c40edc | 471 | X<FREETMPS> |
954c1994 | 472 | |
94bdecf9 JH |
473 | Closing bracket for temporaries on a callback. See C<SAVETMPS> and |
474 | L<perlcall>. | |
954c1994 | 475 | |
94bdecf9 | 476 | FREETMPS; |
954c1994 | 477 | |
497711e7 | 478 | =for hackers |
94bdecf9 | 479 | Found in file scope.h |
beab0874 | 480 | |
94bdecf9 | 481 | =item LEAVE |
d8c40edc | 482 | X<LEAVE> |
beab0874 | 483 | |
94bdecf9 | 484 | Closing bracket on a callback. See C<ENTER> and L<perlcall>. |
beab0874 | 485 | |
94bdecf9 | 486 | LEAVE; |
beab0874 JT |
487 | |
488 | =for hackers | |
94bdecf9 | 489 | Found in file scope.h |
beab0874 | 490 | |
94bdecf9 | 491 | =item SAVETMPS |
d8c40edc | 492 | X<SAVETMPS> |
9f2ea798 | 493 | |
94bdecf9 JH |
494 | Opening bracket for temporaries on a callback. See C<FREETMPS> and |
495 | L<perlcall>. | |
9f2ea798 | 496 | |
94bdecf9 | 497 | SAVETMPS; |
9f2ea798 DM |
498 | |
499 | =for hackers | |
94bdecf9 | 500 | Found in file scope.h |
9f2ea798 | 501 | |
9f2ea798 | 502 | |
94bdecf9 | 503 | =back |
9f2ea798 | 504 | |
94bdecf9 | 505 | =head1 Character classes |
9f2ea798 | 506 | |
94bdecf9 | 507 | =over 8 |
9f2ea798 | 508 | |
94bdecf9 | 509 | =item isALNUM |
d8c40edc | 510 | X<isALNUM> |
954c1994 | 511 | |
94bdecf9 JH |
512 | Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric |
513 | character (including underscore) or digit. | |
954c1994 | 514 | |
94bdecf9 | 515 | bool isALNUM(char ch) |
954c1994 | 516 | |
497711e7 | 517 | =for hackers |
94bdecf9 | 518 | Found in file handy.h |
497711e7 | 519 | |
94bdecf9 | 520 | =item isALPHA |
d8c40edc | 521 | X<isALPHA> |
954c1994 | 522 | |
94bdecf9 JH |
523 | Returns a boolean indicating whether the C C<char> is an ASCII alphabetic |
524 | character. | |
954c1994 | 525 | |
94bdecf9 | 526 | bool isALPHA(char ch) |
954c1994 | 527 | |
497711e7 | 528 | =for hackers |
94bdecf9 | 529 | Found in file handy.h |
497711e7 | 530 | |
94bdecf9 | 531 | =item isDIGIT |
d8c40edc | 532 | X<isDIGIT> |
954c1994 | 533 | |
94bdecf9 JH |
534 | Returns a boolean indicating whether the C C<char> is an ASCII |
535 | digit. | |
954c1994 | 536 | |
94bdecf9 | 537 | bool isDIGIT(char ch) |
954c1994 | 538 | |
497711e7 | 539 | =for hackers |
94bdecf9 | 540 | Found in file handy.h |
497711e7 | 541 | |
94bdecf9 | 542 | =item isLOWER |
d8c40edc | 543 | X<isLOWER> |
954c1994 | 544 | |
94bdecf9 JH |
545 | Returns a boolean indicating whether the C C<char> is a lowercase |
546 | character. | |
954c1994 | 547 | |
94bdecf9 | 548 | bool isLOWER(char ch) |
954c1994 | 549 | |
497711e7 | 550 | =for hackers |
94bdecf9 | 551 | Found in file handy.h |
497711e7 | 552 | |
94bdecf9 | 553 | =item isSPACE |
d8c40edc | 554 | X<isSPACE> |
954c1994 | 555 | |
94bdecf9 | 556 | Returns a boolean indicating whether the C C<char> is whitespace. |
954c1994 | 557 | |
94bdecf9 | 558 | bool isSPACE(char ch) |
954c1994 | 559 | |
497711e7 | 560 | =for hackers |
94bdecf9 | 561 | Found in file handy.h |
497711e7 | 562 | |
94bdecf9 | 563 | =item isUPPER |
d8c40edc | 564 | X<isUPPER> |
954c1994 | 565 | |
94bdecf9 JH |
566 | Returns a boolean indicating whether the C C<char> is an uppercase |
567 | character. | |
954c1994 | 568 | |
94bdecf9 | 569 | bool isUPPER(char ch) |
954c1994 | 570 | |
497711e7 | 571 | =for hackers |
94bdecf9 | 572 | Found in file handy.h |
497711e7 | 573 | |
94bdecf9 | 574 | =item toLOWER |
d8c40edc | 575 | X<toLOWER> |
954c1994 | 576 | |
94bdecf9 | 577 | Converts the specified character to lowercase. |
954c1994 | 578 | |
94bdecf9 | 579 | char toLOWER(char ch) |
954c1994 | 580 | |
94bdecf9 JH |
581 | =for hackers |
582 | Found in file handy.h | |
583 | ||
584 | =item toUPPER | |
d8c40edc | 585 | X<toUPPER> |
94bdecf9 JH |
586 | |
587 | Converts the specified character to uppercase. | |
588 | ||
589 | char toUPPER(char ch) | |
954c1994 | 590 | |
497711e7 | 591 | =for hackers |
94bdecf9 | 592 | Found in file handy.h |
497711e7 | 593 | |
954c1994 | 594 | |
94bdecf9 | 595 | =back |
954c1994 | 596 | |
94bdecf9 | 597 | =head1 Cloning an interpreter |
954c1994 | 598 | |
94bdecf9 JH |
599 | =over 8 |
600 | ||
601 | =item perl_clone | |
d8c40edc | 602 | X<perl_clone> |
94bdecf9 JH |
603 | |
604 | Create and return a new interpreter by cloning the current one. | |
605 | ||
4be49ee6 | 606 | perl_clone takes these flags as parameters: |
c78c2b74 | 607 | |
b0bc38e6 NC |
608 | CLONEf_COPY_STACKS - is used to, well, copy the stacks also, |
609 | without it we only clone the data and zero the stacks, | |
610 | with it we copy the stacks and the new perl interpreter is | |
611 | ready to run at the exact same point as the previous one. | |
612 | The pseudo-fork code uses COPY_STACKS while the | |
878090d5 | 613 | threads->create doesn't. |
c78c2b74 HS |
614 | |
615 | CLONEf_KEEP_PTR_TABLE | |
b0bc38e6 NC |
616 | perl_clone keeps a ptr_table with the pointer of the old |
617 | variable as a key and the new variable as a value, | |
618 | this allows it to check if something has been cloned and not | |
619 | clone it again but rather just use the value and increase the | |
620 | refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill | |
621 | the ptr_table using the function | |
622 | C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>, | |
623 | reason to keep it around is if you want to dup some of your own | |
624 | variable who are outside the graph perl scans, example of this | |
c78c2b74 HS |
625 | code is in threads.xs create |
626 | ||
627 | CLONEf_CLONE_HOST | |
b0bc38e6 NC |
628 | This is a win32 thing, it is ignored on unix, it tells perls |
629 | win32host code (which is c++) to clone itself, this is needed on | |
630 | win32 if you want to run two threads at the same time, | |
631 | if you just want to do some stuff in a separate perl interpreter | |
632 | and then throw it away and return to the original one, | |
c78c2b74 HS |
633 | you don't need to do anything. |
634 | ||
94bdecf9 | 635 | PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags) |
954c1994 | 636 | |
497711e7 | 637 | =for hackers |
94bdecf9 | 638 | Found in file sv.c |
497711e7 | 639 | |
954c1994 | 640 | |
94bdecf9 | 641 | =back |
954c1994 | 642 | |
94bdecf9 JH |
643 | =head1 CV Manipulation Functions |
644 | ||
645 | =over 8 | |
646 | ||
647 | =item CvSTASH | |
d8c40edc | 648 | X<CvSTASH> |
94bdecf9 JH |
649 | |
650 | Returns the stash of the CV. | |
651 | ||
652 | HV* CvSTASH(CV* cv) | |
954c1994 | 653 | |
497711e7 | 654 | =for hackers |
94bdecf9 | 655 | Found in file cv.h |
497711e7 | 656 | |
94bdecf9 | 657 | =item get_cv |
d8c40edc | 658 | X<get_cv> |
954c1994 | 659 | |
36dfb072 | 660 | Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>. |
954c1994 | 661 | |
94bdecf9 JH |
662 | NOTE: the perl_ form of this function is deprecated. |
663 | ||
36dfb072 NC |
664 | CV* get_cv(const char* name, I32 flags) |
665 | ||
666 | =for hackers | |
667 | Found in file perl.c | |
668 | ||
669 | =item get_cvn_flags | |
670 | X<get_cvn_flags> | |
671 | ||
672 | Returns the CV of the specified Perl subroutine. C<flags> are passed to | |
673 | C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not | |
674 | exist then it will be declared (which has the same effect as saying | |
675 | C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist | |
676 | then NULL is returned. | |
677 | ||
678 | NOTE: the perl_ form of this function is deprecated. | |
679 | ||
680 | CV* get_cvn_flags(const char* name, STRLEN len, I32 flags) | |
954c1994 | 681 | |
497711e7 | 682 | =for hackers |
94bdecf9 | 683 | Found in file perl.c |
497711e7 | 684 | |
7c9e965c | 685 | |
94bdecf9 | 686 | =back |
7c9e965c | 687 | |
94bdecf9 | 688 | =head1 Embedding Functions |
7c9e965c | 689 | |
94bdecf9 | 690 | =over 8 |
7c9e965c | 691 | |
7dafbf52 | 692 | =item cv_undef |
d8c40edc | 693 | X<cv_undef> |
7dafbf52 DM |
694 | |
695 | Clear out all the active components of a CV. This can happen either | |
696 | by an explicit C<undef &foo>, or by the reference count going to zero. | |
697 | In the former case, we keep the CvOUTSIDE pointer, so that any anonymous | |
698 | children can still follow the full lexical scope chain. | |
699 | ||
700 | void cv_undef(CV* cv) | |
701 | ||
702 | =for hackers | |
703 | Found in file op.c | |
704 | ||
94bdecf9 | 705 | =item load_module |
d8c40edc | 706 | X<load_module> |
7c9e965c | 707 | |
94bdecf9 JH |
708 | Loads the module whose name is pointed to by the string part of name. |
709 | Note that the actual module name, not its filename, should be given. | |
710 | Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of | |
711 | PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS | |
712 | (or 0 for no flags). ver, if specified, provides version semantics | |
713 | similar to C<use Foo::Bar VERSION>. The optional trailing SV* | |
714 | arguments can be used to specify arguments to the module's import() | |
715 | method, similar to C<use Foo::Bar VERSION LIST>. | |
7c9e965c | 716 | |
94bdecf9 | 717 | void load_module(U32 flags, SV* name, SV* ver, ...) |
7c9e965c JP |
718 | |
719 | =for hackers | |
94bdecf9 | 720 | Found in file op.c |
7c9e965c | 721 | |
62375a60 | 722 | =item nothreadhook |
d8c40edc | 723 | X<nothreadhook> |
62375a60 NIS |
724 | |
725 | Stub that provides thread hook for perl_destruct when there are | |
726 | no threads. | |
727 | ||
728 | int nothreadhook() | |
729 | ||
730 | =for hackers | |
731 | Found in file perl.c | |
732 | ||
94bdecf9 | 733 | =item perl_alloc |
d8c40edc | 734 | X<perl_alloc> |
954c1994 | 735 | |
94bdecf9 | 736 | Allocates a new Perl interpreter. See L<perlembed>. |
954c1994 | 737 | |
94bdecf9 | 738 | PerlInterpreter* perl_alloc() |
954c1994 | 739 | |
497711e7 | 740 | =for hackers |
94bdecf9 | 741 | Found in file perl.c |
497711e7 | 742 | |
94bdecf9 | 743 | =item perl_construct |
d8c40edc | 744 | X<perl_construct> |
89423764 | 745 | |
94bdecf9 | 746 | Initializes a new Perl interpreter. See L<perlembed>. |
89423764 | 747 | |
94bdecf9 | 748 | void perl_construct(PerlInterpreter* interp) |
89423764 GS |
749 | |
750 | =for hackers | |
94bdecf9 | 751 | Found in file perl.c |
954c1994 | 752 | |
94bdecf9 | 753 | =item perl_destruct |
d8c40edc | 754 | X<perl_destruct> |
954c1994 | 755 | |
94bdecf9 | 756 | Shuts down a Perl interpreter. See L<perlembed>. |
954c1994 | 757 | |
94bdecf9 | 758 | int perl_destruct(PerlInterpreter* interp) |
954c1994 | 759 | |
497711e7 GS |
760 | =for hackers |
761 | Found in file perl.c | |
762 | ||
94bdecf9 | 763 | =item perl_free |
d8c40edc | 764 | X<perl_free> |
954c1994 | 765 | |
94bdecf9 | 766 | Releases a Perl interpreter. See L<perlembed>. |
954c1994 | 767 | |
94bdecf9 | 768 | void perl_free(PerlInterpreter* interp) |
954c1994 | 769 | |
497711e7 GS |
770 | =for hackers |
771 | Found in file perl.c | |
772 | ||
94bdecf9 | 773 | =item perl_parse |
d8c40edc | 774 | X<perl_parse> |
954c1994 | 775 | |
94bdecf9 | 776 | Tells a Perl interpreter to parse a Perl script. See L<perlembed>. |
954c1994 | 777 | |
94bdecf9 | 778 | int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env) |
954c1994 | 779 | |
94bdecf9 JH |
780 | =for hackers |
781 | Found in file perl.c | |
782 | ||
783 | =item perl_run | |
d8c40edc | 784 | X<perl_run> |
94bdecf9 JH |
785 | |
786 | Tells a Perl interpreter to run. See L<perlembed>. | |
787 | ||
788 | int perl_run(PerlInterpreter* interp) | |
954c1994 | 789 | |
497711e7 GS |
790 | =for hackers |
791 | Found in file perl.c | |
792 | ||
94bdecf9 | 793 | =item require_pv |
d8c40edc | 794 | X<require_pv> |
954c1994 | 795 | |
94bdecf9 JH |
796 | Tells Perl to C<require> the file named by the string argument. It is |
797 | analogous to the Perl code C<eval "require '$file'">. It's even | |
2307c6d0 | 798 | implemented that way; consider using load_module instead. |
954c1994 GS |
799 | |
800 | NOTE: the perl_ form of this function is deprecated. | |
801 | ||
94bdecf9 | 802 | void require_pv(const char* pv) |
954c1994 | 803 | |
497711e7 GS |
804 | =for hackers |
805 | Found in file perl.c | |
806 | ||
954c1994 | 807 | |
94bdecf9 | 808 | =back |
954c1994 | 809 | |
3df15adc YO |
810 | =head1 Functions in file dump.c |
811 | ||
812 | ||
813 | =over 8 | |
814 | ||
815 | =item pv_display | |
816 | X<pv_display> | |
817 | ||
818 | char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, | |
819 | STRLEN pvlim, U32 flags) | |
820 | ||
821 | Similar to | |
822 | ||
823 | pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE); | |
824 | ||
825 | except that an additional "\0" will be appended to the string when | |
826 | len > cur and pv[cur] is "\0". | |
827 | ||
828 | Note that the final string may be up to 7 chars longer than pvlim. | |
829 | ||
830 | char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim) | |
831 | ||
832 | =for hackers | |
833 | Found in file dump.c | |
834 | ||
835 | =item pv_escape | |
836 | X<pv_escape> | |
837 | ||
ddc5bc0f YO |
838 | |const STRLEN count|const STRLEN max |
839 | |STRLEN const *escaped, const U32 flags | |
840 | ||
3df15adc | 841 | Escapes at most the first "count" chars of pv and puts the results into |
ddc5bc0f | 842 | dsv such that the size of the escaped string will not exceed "max" chars |
3df15adc YO |
843 | and will not contain any incomplete escape sequences. |
844 | ||
ddc5bc0f YO |
845 | If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string |
846 | will also be escaped. | |
3df15adc YO |
847 | |
848 | Normally the SV will be cleared before the escaped string is prepared, | |
ddc5bc0f YO |
849 | but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur. |
850 | ||
851 | If PERL_PV_ESCAPE_UNI is set then the input string is treated as unicode, | |
852 | if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned | |
853 | using C<is_utf8_string()> to determine if it is unicode. | |
854 | ||
855 | If PERL_PV_ESCAPE_ALL is set then all input chars will be output | |
856 | using C<\x01F1> style escapes, otherwise only chars above 255 will be | |
857 | escaped using this style, other non printable chars will use octal or | |
858 | common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH | |
859 | then all chars below 255 will be treated as printable and | |
860 | will be output as literals. | |
861 | ||
862 | If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the | |
863 | string will be escaped, regardles of max. If the string is utf8 and | |
864 | the chars value is >255 then it will be returned as a plain hex | |
865 | sequence. Thus the output will either be a single char, | |
866 | an octal escape sequence, a special escape like C<\n> or a 3 or | |
867 | more digit hex value. | |
868 | ||
44a2ac75 YO |
869 | If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and |
870 | not a '\\'. This is because regexes very often contain backslashed | |
871 | sequences, whereas '%' is not a particularly common character in patterns. | |
872 | ||
ddc5bc0f | 873 | Returns a pointer to the escaped text as held by dsv. |
3df15adc | 874 | |
ddc5bc0f YO |
875 | NOTE: the perl_ form of this function is deprecated. |
876 | ||
877 | char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags) | |
878 | ||
879 | =for hackers | |
880 | Found in file dump.c | |
3df15adc | 881 | |
ddc5bc0f YO |
882 | =item pv_pretty |
883 | X<pv_pretty> | |
884 | ||
885 | |const STRLEN count|const STRLEN max\ | |
886 | |const char const *start_color| const char const *end_color\ | |
887 | |const U32 flags | |
888 | ||
889 | Converts a string into something presentable, handling escaping via | |
890 | pv_escape() and supporting quoting and elipses. | |
891 | ||
892 | If the PERL_PV_PRETTY_QUOTE flag is set then the result will be | |
893 | double quoted with any double quotes in the string escaped. Otherwise | |
894 | if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in | |
895 | angle brackets. | |
896 | ||
897 | If the PERL_PV_PRETTY_ELIPSES flag is set and not all characters in | |
898 | string were output then an elipses C<...> will be appended to the | |
899 | string. Note that this happens AFTER it has been quoted. | |
900 | ||
901 | If start_color is non-null then it will be inserted after the opening | |
902 | quote (if there is one) but before the escaped text. If end_color | |
903 | is non-null then it will be inserted after the escaped text but before | |
904 | any quotes or elipses. | |
905 | ||
906 | Returns a pointer to the prettified text as held by dsv. | |
907 | ||
3df15adc YO |
908 | NOTE: the perl_ form of this function is deprecated. |
909 | ||
ddc5bc0f | 910 | char* pv_pretty(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, char const * const start_color, char const * const end_color, const U32 flags) |
3df15adc YO |
911 | |
912 | =for hackers | |
913 | Found in file dump.c | |
914 | ||
915 | ||
916 | =back | |
917 | ||
9244d4ad RGS |
918 | =head1 Functions in file mathoms.c |
919 | ||
920 | ||
921 | =over 8 | |
922 | ||
923 | =item gv_fetchmethod | |
924 | X<gv_fetchmethod> | |
925 | ||
926 | See L<gv_fetchmethod_autoload>. | |
927 | ||
928 | GV* gv_fetchmethod(HV* stash, const char* name) | |
929 | ||
930 | =for hackers | |
931 | Found in file mathoms.c | |
932 | ||
b47163a2 NC |
933 | =item pack_cat |
934 | X<pack_cat> | |
935 | ||
936 | The engine implementing pack() Perl function. Note: parameters next_in_list and | |
937 | flags are not used. This call should not be used; use packlist instead. | |
938 | ||
939 | void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags) | |
940 | ||
941 | =for hackers | |
942 | Found in file mathoms.c | |
943 | ||
9244d4ad RGS |
944 | =item sv_2pvbyte_nolen |
945 | X<sv_2pvbyte_nolen> | |
946 | ||
947 | Return a pointer to the byte-encoded representation of the SV. | |
948 | May cause the SV to be downgraded from UTF-8 as a side-effect. | |
949 | ||
950 | Usually accessed via the C<SvPVbyte_nolen> macro. | |
951 | ||
952 | char* sv_2pvbyte_nolen(SV* sv) | |
953 | ||
954 | =for hackers | |
955 | Found in file mathoms.c | |
956 | ||
957 | =item sv_2pvutf8_nolen | |
958 | X<sv_2pvutf8_nolen> | |
959 | ||
960 | Return a pointer to the UTF-8-encoded representation of the SV. | |
961 | May cause the SV to be upgraded to UTF-8 as a side-effect. | |
962 | ||
963 | Usually accessed via the C<SvPVutf8_nolen> macro. | |
964 | ||
965 | char* sv_2pvutf8_nolen(SV* sv) | |
966 | ||
967 | =for hackers | |
968 | Found in file mathoms.c | |
969 | ||
970 | =item sv_2pv_nolen | |
971 | X<sv_2pv_nolen> | |
972 | ||
973 | Like C<sv_2pv()>, but doesn't return the length too. You should usually | |
974 | use the macro wrapper C<SvPV_nolen(sv)> instead. | |
975 | char* sv_2pv_nolen(SV* sv) | |
976 | ||
977 | =for hackers | |
978 | Found in file mathoms.c | |
979 | ||
980 | =item sv_catpvn_mg | |
981 | X<sv_catpvn_mg> | |
982 | ||
983 | Like C<sv_catpvn>, but also handles 'set' magic. | |
984 | ||
985 | void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len) | |
986 | ||
987 | =for hackers | |
988 | Found in file mathoms.c | |
989 | ||
990 | =item sv_catsv_mg | |
991 | X<sv_catsv_mg> | |
992 | ||
993 | Like C<sv_catsv>, but also handles 'set' magic. | |
994 | ||
995 | void sv_catsv_mg(SV *dstr, SV *sstr) | |
996 | ||
997 | =for hackers | |
998 | Found in file mathoms.c | |
999 | ||
1000 | =item sv_force_normal | |
1001 | X<sv_force_normal> | |
1002 | ||
1003 | Undo various types of fakery on an SV: if the PV is a shared string, make | |
1004 | a private copy; if we're a ref, stop refing; if we're a glob, downgrade to | |
1005 | an xpvmg. See also C<sv_force_normal_flags>. | |
1006 | ||
1007 | void sv_force_normal(SV *sv) | |
1008 | ||
1009 | =for hackers | |
1010 | Found in file mathoms.c | |
1011 | ||
1012 | =item sv_iv | |
1013 | X<sv_iv> | |
1014 | ||
1015 | A private implementation of the C<SvIVx> macro for compilers which can't | |
1016 | cope with complex macro expressions. Always use the macro instead. | |
1017 | ||
1018 | IV sv_iv(SV* sv) | |
1019 | ||
1020 | =for hackers | |
1021 | Found in file mathoms.c | |
1022 | ||
1023 | =item sv_nolocking | |
1024 | X<sv_nolocking> | |
1025 | ||
1026 | Dummy routine which "locks" an SV when there is no locking module present. | |
1027 | Exists to avoid test for a NULL function pointer and because it could | |
1028 | potentially warn under some level of strict-ness. | |
1029 | ||
1030 | "Superseded" by sv_nosharing(). | |
1031 | ||
c48640ec | 1032 | void sv_nolocking(SV *sv) |
9244d4ad RGS |
1033 | |
1034 | =for hackers | |
1035 | Found in file mathoms.c | |
1036 | ||
1037 | =item sv_nounlocking | |
1038 | X<sv_nounlocking> | |
1039 | ||
1040 | Dummy routine which "unlocks" an SV when there is no locking module present. | |
1041 | Exists to avoid test for a NULL function pointer and because it could | |
1042 | potentially warn under some level of strict-ness. | |
1043 | ||
1044 | "Superseded" by sv_nosharing(). | |
1045 | ||
c48640ec | 1046 | void sv_nounlocking(SV *sv) |
9244d4ad RGS |
1047 | |
1048 | =for hackers | |
1049 | Found in file mathoms.c | |
1050 | ||
1051 | =item sv_nv | |
1052 | X<sv_nv> | |
1053 | ||
1054 | A private implementation of the C<SvNVx> macro for compilers which can't | |
1055 | cope with complex macro expressions. Always use the macro instead. | |
1056 | ||
1057 | NV sv_nv(SV* sv) | |
1058 | ||
1059 | =for hackers | |
1060 | Found in file mathoms.c | |
1061 | ||
1062 | =item sv_pv | |
1063 | X<sv_pv> | |
1064 | ||
1065 | Use the C<SvPV_nolen> macro instead | |
1066 | ||
1067 | char* sv_pv(SV *sv) | |
1068 | ||
1069 | =for hackers | |
1070 | Found in file mathoms.c | |
1071 | ||
1072 | =item sv_pvbyte | |
1073 | X<sv_pvbyte> | |
1074 | ||
1075 | Use C<SvPVbyte_nolen> instead. | |
1076 | ||
1077 | char* sv_pvbyte(SV *sv) | |
1078 | ||
1079 | =for hackers | |
1080 | Found in file mathoms.c | |
1081 | ||
1082 | =item sv_pvbyten | |
1083 | X<sv_pvbyten> | |
1084 | ||
1085 | A private implementation of the C<SvPVbyte> macro for compilers | |
1086 | which can't cope with complex macro expressions. Always use the macro | |
1087 | instead. | |
1088 | ||
1089 | char* sv_pvbyten(SV *sv, STRLEN *len) | |
1090 | ||
1091 | =for hackers | |
1092 | Found in file mathoms.c | |
1093 | ||
1094 | =item sv_pvn | |
1095 | X<sv_pvn> | |
1096 | ||
1097 | A private implementation of the C<SvPV> macro for compilers which can't | |
1098 | cope with complex macro expressions. Always use the macro instead. | |
1099 | ||
1100 | char* sv_pvn(SV *sv, STRLEN *len) | |
1101 | ||
1102 | =for hackers | |
1103 | Found in file mathoms.c | |
1104 | ||
1105 | =item sv_pvutf8 | |
1106 | X<sv_pvutf8> | |
1107 | ||
1108 | Use the C<SvPVutf8_nolen> macro instead | |
1109 | ||
1110 | char* sv_pvutf8(SV *sv) | |
1111 | ||
1112 | =for hackers | |
1113 | Found in file mathoms.c | |
1114 | ||
1115 | =item sv_pvutf8n | |
1116 | X<sv_pvutf8n> | |
1117 | ||
1118 | A private implementation of the C<SvPVutf8> macro for compilers | |
1119 | which can't cope with complex macro expressions. Always use the macro | |
1120 | instead. | |
1121 | ||
1122 | char* sv_pvutf8n(SV *sv, STRLEN *len) | |
1123 | ||
1124 | =for hackers | |
1125 | Found in file mathoms.c | |
1126 | ||
1127 | =item sv_taint | |
1128 | X<sv_taint> | |
1129 | ||
1130 | Taint an SV. Use C<SvTAINTED_on> instead. | |
1131 | void sv_taint(SV* sv) | |
1132 | ||
1133 | =for hackers | |
1134 | Found in file mathoms.c | |
1135 | ||
1136 | =item sv_unref | |
1137 | X<sv_unref> | |
1138 | ||
1139 | Unsets the RV status of the SV, and decrements the reference count of | |
1140 | whatever was being referenced by the RV. This can almost be thought of | |
1141 | as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag> | |
1142 | being zero. See C<SvROK_off>. | |
1143 | ||
1144 | void sv_unref(SV* sv) | |
1145 | ||
1146 | =for hackers | |
1147 | Found in file mathoms.c | |
1148 | ||
fed01289 SP |
1149 | =item sv_usepvn |
1150 | X<sv_usepvn> | |
1151 | ||
1152 | Tells an SV to use C<ptr> to find its string value. Implemented by | |
1153 | calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set' | |
1154 | magic. See C<sv_usepvn_flags>. | |
1155 | ||
1156 | void sv_usepvn(SV* sv, char* ptr, STRLEN len) | |
1157 | ||
1158 | =for hackers | |
1159 | Found in file mathoms.c | |
1160 | ||
1161 | =item sv_usepvn_mg | |
1162 | X<sv_usepvn_mg> | |
1163 | ||
1164 | Like C<sv_usepvn>, but also handles 'set' magic. | |
1165 | ||
1166 | void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len) | |
1167 | ||
1168 | =for hackers | |
1169 | Found in file mathoms.c | |
1170 | ||
9244d4ad RGS |
1171 | =item sv_uv |
1172 | X<sv_uv> | |
1173 | ||
1174 | A private implementation of the C<SvUVx> macro for compilers which can't | |
1175 | cope with complex macro expressions. Always use the macro instead. | |
1176 | ||
1177 | UV sv_uv(SV* sv) | |
1178 | ||
1179 | =for hackers | |
1180 | Found in file mathoms.c | |
1181 | ||
95be277c NC |
1182 | =item unpack_str |
1183 | X<unpack_str> | |
1184 | ||
1185 | The engine implementing unpack() Perl function. Note: parameters strbeg, new_s | |
1186 | and ocnt are not used. This call should not be used, use unpackstring instead. | |
1187 | ||
1188 | I32 unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const char *strend, char **new_s, I32 ocnt, U32 flags) | |
1189 | ||
1190 | =for hackers | |
1191 | Found in file mathoms.c | |
1192 | ||
9244d4ad RGS |
1193 | |
1194 | =back | |
1195 | ||
6050d10e JP |
1196 | =head1 Functions in file pp_pack.c |
1197 | ||
1198 | ||
1199 | =over 8 | |
1200 | ||
7accc089 | 1201 | =item packlist |
d8c40edc | 1202 | X<packlist> |
6050d10e JP |
1203 | |
1204 | The engine implementing pack() Perl function. | |
1205 | ||
f7fe979e | 1206 | void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist) |
7accc089 JH |
1207 | |
1208 | =for hackers | |
1209 | Found in file pp_pack.c | |
1210 | ||
7accc089 | 1211 | =item unpackstring |
d8c40edc | 1212 | X<unpackstring> |
6050d10e | 1213 | |
608d3aed WL |
1214 | The engine implementing unpack() Perl function. C<unpackstring> puts the |
1215 | extracted list items on the stack and returns the number of elements. | |
1216 | Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function. | |
6050d10e | 1217 | |
f7fe979e | 1218 | I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags) |
7accc089 JH |
1219 | |
1220 | =for hackers | |
1221 | Found in file pp_pack.c | |
1222 | ||
6050d10e JP |
1223 | |
1224 | =back | |
1225 | ||
94bdecf9 | 1226 | =head1 GV Functions |
6e9d1081 | 1227 | |
94bdecf9 | 1228 | =over 8 |
6e9d1081 | 1229 | |
954c1994 | 1230 | =item GvSV |
d8c40edc | 1231 | X<GvSV> |
954c1994 GS |
1232 | |
1233 | Return the SV from the GV. | |
1234 | ||
1235 | SV* GvSV(GV* gv) | |
1236 | ||
497711e7 GS |
1237 | =for hackers |
1238 | Found in file gv.h | |
1239 | ||
9f435386 RGS |
1240 | =item gv_const_sv |
1241 | X<gv_const_sv> | |
1242 | ||
1243 | If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for | |
1244 | inlining, or C<gv> is a placeholder reference that would be promoted to such | |
1245 | a typeglob, then returns the value returned by the sub. Otherwise, returns | |
1246 | NULL. | |
1247 | ||
1248 | SV* gv_const_sv(GV* gv) | |
1249 | ||
1250 | =for hackers | |
1251 | Found in file gv.c | |
1252 | ||
954c1994 | 1253 | =item gv_fetchmeth |
d8c40edc | 1254 | X<gv_fetchmeth> |
954c1994 GS |
1255 | |
1256 | Returns the glob with the given C<name> and a defined subroutine or | |
1257 | C<NULL>. The glob lives in the given C<stash>, or in the stashes | |
a453c169 | 1258 | accessible via @ISA and UNIVERSAL::. |
954c1994 GS |
1259 | |
1260 | The argument C<level> should be either 0 or -1. If C<level==0>, as a | |
1261 | side-effect creates a glob with the given C<name> in the given C<stash> | |
1262 | which in the case of success contains an alias for the subroutine, and sets | |
e1a479c5 | 1263 | up caching info for this glob. |
954c1994 GS |
1264 | |
1265 | This function grants C<"SUPER"> token as a postfix of the stash name. The | |
1266 | GV returned from C<gv_fetchmeth> may be a method cache entry, which is not | |
4929bf7b | 1267 | visible to Perl code. So when calling C<call_sv>, you should not use |
954c1994 | 1268 | the GV directly; instead, you should use the method's CV, which can be |
1c846c1f | 1269 | obtained from the GV with the C<GvCV> macro. |
954c1994 GS |
1270 | |
1271 | GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level) | |
1272 | ||
497711e7 GS |
1273 | =for hackers |
1274 | Found in file gv.c | |
1275 | ||
954c1994 | 1276 | =item gv_fetchmethod_autoload |
d8c40edc | 1277 | X<gv_fetchmethod_autoload> |
954c1994 GS |
1278 | |
1279 | Returns the glob which contains the subroutine to call to invoke the method | |
1280 | on the C<stash>. In fact in the presence of autoloading this may be the | |
1281 | glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is | |
1c846c1f | 1282 | already setup. |
954c1994 GS |
1283 | |
1284 | The third parameter of C<gv_fetchmethod_autoload> determines whether | |
1285 | AUTOLOAD lookup is performed if the given method is not present: non-zero | |
1c846c1f | 1286 | means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD. |
954c1994 | 1287 | Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload> |
1c846c1f | 1288 | with a non-zero C<autoload> parameter. |
954c1994 GS |
1289 | |
1290 | These functions grant C<"SUPER"> token as a prefix of the method name. Note | |
1291 | that if you want to keep the returned glob for a long time, you need to | |
1292 | check for it being "AUTOLOAD", since at the later time the call may load a | |
1293 | different subroutine due to $AUTOLOAD changing its value. Use the glob | |
1c846c1f | 1294 | created via a side effect to do this. |
954c1994 GS |
1295 | |
1296 | These functions have the same side-effects and as C<gv_fetchmeth> with | |
1297 | C<level==0>. C<name> should be writable if contains C<':'> or C<' | |
1298 | ''>. The warning against passing the GV returned by C<gv_fetchmeth> to | |
1c846c1f | 1299 | C<call_sv> apply equally to these functions. |
954c1994 GS |
1300 | |
1301 | GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload) | |
1302 | ||
497711e7 GS |
1303 | =for hackers |
1304 | Found in file gv.c | |
1305 | ||
0c81b680 | 1306 | =item gv_fetchmeth_autoload |
d8c40edc | 1307 | X<gv_fetchmeth_autoload> |
0c81b680 JH |
1308 | |
1309 | Same as gv_fetchmeth(), but looks for autoloaded subroutines too. | |
1310 | Returns a glob for the subroutine. | |
1311 | ||
1312 | For an autoloaded subroutine without a GV, will create a GV even | |
1313 | if C<level < 0>. For an autoloaded subroutine without a stub, GvCV() | |
1314 | of the result may be zero. | |
1315 | ||
1316 | GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level) | |
1317 | ||
1318 | =for hackers | |
1319 | Found in file gv.c | |
1320 | ||
954c1994 | 1321 | =item gv_stashpv |
d8c40edc | 1322 | X<gv_stashpv> |
954c1994 | 1323 | |
da51bb9b | 1324 | Returns a pointer to the stash for a specified package. Uses C<strlen> to |
75c442e4 | 1325 | determine the length of C<name>, then calls C<gv_stashpvn()>. |
bc96cb06 | 1326 | |
da51bb9b | 1327 | HV* gv_stashpv(const char* name, I32 flags) |
bc96cb06 SH |
1328 | |
1329 | =for hackers | |
1330 | Found in file gv.c | |
1331 | ||
1332 | =item gv_stashpvn | |
d8c40edc | 1333 | X<gv_stashpvn> |
bc96cb06 | 1334 | |
da51bb9b NC |
1335 | Returns a pointer to the stash for a specified package. The C<namelen> |
1336 | parameter indicates the length of the C<name>, in bytes. C<flags> is passed | |
1337 | to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be | |
1338 | created if it does not already exist. If the package does not exist and | |
1339 | C<flags> is 0 (or any other setting that does not create packages) then NULL | |
1340 | is returned. | |
954c1994 | 1341 | |
da51bb9b NC |
1342 | |
1343 | HV* gv_stashpvn(const char* name, U32 namelen, I32 flags) | |
954c1994 | 1344 | |
497711e7 GS |
1345 | =for hackers |
1346 | Found in file gv.c | |
1347 | ||
3fe05580 MHM |
1348 | =item gv_stashpvs |
1349 | X<gv_stashpvs> | |
1350 | ||
1351 | Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair. | |
1352 | ||
1353 | HV* gv_stashpvs(const char* name, I32 create) | |
1354 | ||
1355 | =for hackers | |
1356 | Found in file handy.h | |
1357 | ||
954c1994 | 1358 | =item gv_stashsv |
d8c40edc | 1359 | X<gv_stashsv> |
954c1994 | 1360 | |
da51bb9b | 1361 | Returns a pointer to the stash for a specified package. See C<gv_stashpvn>. |
954c1994 | 1362 | |
da51bb9b | 1363 | HV* gv_stashsv(SV* sv, I32 flags) |
954c1994 | 1364 | |
497711e7 GS |
1365 | =for hackers |
1366 | Found in file gv.c | |
1367 | ||
954c1994 | 1368 | |
94bdecf9 | 1369 | =back |
954c1994 | 1370 | |
94bdecf9 | 1371 | =head1 Handy Values |
497711e7 | 1372 | |
94bdecf9 | 1373 | =over 8 |
954c1994 | 1374 | |
e509e693 | 1375 | =item Nullav |
d8c40edc | 1376 | X<Nullav> |
497711e7 | 1377 | |
e509e693 | 1378 | Null AV pointer. |
954c1994 | 1379 | |
94bdecf9 | 1380 | =for hackers |
e509e693 | 1381 | Found in file av.h |
954c1994 | 1382 | |
dd2155a4 | 1383 | =item Nullch |
d8c40edc | 1384 | X<Nullch> |
94bdecf9 JH |
1385 | |
1386 | Null character pointer. | |
2307c6d0 | 1387 | |
497711e7 | 1388 | =for hackers |
94bdecf9 | 1389 | Found in file handy.h |
497711e7 | 1390 | |
e509e693 | 1391 | =item Nullcv |
d8c40edc | 1392 | X<Nullcv> |
e509e693 SH |
1393 | |
1394 | Null CV pointer. | |
1395 | ||
1396 | =for hackers | |
1397 | Found in file cv.h | |
1398 | ||
1399 | =item Nullhv | |
d8c40edc | 1400 | X<Nullhv> |
e509e693 SH |
1401 | |
1402 | Null HV pointer. | |
1403 | ||
1404 | =for hackers | |
1405 | Found in file hv.h | |
1406 | ||
94bdecf9 | 1407 | =item Nullsv |
d8c40edc | 1408 | X<Nullsv> |
954c1994 | 1409 | |
94bdecf9 | 1410 | Null SV pointer. |
954c1994 | 1411 | |
497711e7 | 1412 | =for hackers |
94bdecf9 | 1413 | Found in file handy.h |
497711e7 | 1414 | |
954c1994 | 1415 | |
94bdecf9 | 1416 | =back |
954c1994 | 1417 | |
94bdecf9 | 1418 | =head1 Hash Manipulation Functions |
497711e7 | 1419 | |
94bdecf9 | 1420 | =over 8 |
954c1994 | 1421 | |
94bdecf9 | 1422 | =item get_hv |
d8c40edc | 1423 | X<get_hv> |
954c1994 | 1424 | |
94bdecf9 JH |
1425 | Returns the HV of the specified Perl hash. If C<create> is set and the |
1426 | Perl variable does not exist then it will be created. If C<create> is not | |
1427 | set and the variable does not exist then NULL is returned. | |
497711e7 | 1428 | |
94bdecf9 | 1429 | NOTE: the perl_ form of this function is deprecated. |
954c1994 | 1430 | |
94bdecf9 | 1431 | HV* get_hv(const char* name, I32 create) |
954c1994 | 1432 | |
497711e7 | 1433 | =for hackers |
94bdecf9 | 1434 | Found in file perl.c |
497711e7 | 1435 | |
e509e693 | 1436 | =item HEf_SVKEY |
d8c40edc | 1437 | X<HEf_SVKEY> |
e509e693 SH |
1438 | |
1439 | This flag, used in the length slot of hash entries and magic structures, | |
1440 | specifies the structure contains an C<SV*> pointer where a C<char*> pointer | |
1441 | is to be expected. (For information only--not to be used). | |
1442 | ||
1443 | =for hackers | |
1444 | Found in file hv.h | |
1445 | ||
954c1994 | 1446 | =item HeHASH |
d8c40edc | 1447 | X<HeHASH> |
954c1994 GS |
1448 | |
1449 | Returns the computed hash stored in the hash entry. | |
1450 | ||
1451 | U32 HeHASH(HE* he) | |
1452 | ||
497711e7 GS |
1453 | =for hackers |
1454 | Found in file hv.h | |
1455 | ||
954c1994 | 1456 | =item HeKEY |
d8c40edc | 1457 | X<HeKEY> |
954c1994 GS |
1458 | |
1459 | Returns the actual pointer stored in the key slot of the hash entry. The | |
1460 | pointer may be either C<char*> or C<SV*>, depending on the value of | |
1461 | C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are | |
1462 | usually preferable for finding the value of a key. | |
1463 | ||
1464 | void* HeKEY(HE* he) | |
1465 | ||
497711e7 GS |
1466 | =for hackers |
1467 | Found in file hv.h | |
1468 | ||
954c1994 | 1469 | =item HeKLEN |
d8c40edc | 1470 | X<HeKLEN> |
954c1994 GS |
1471 | |
1472 | If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry | |
1473 | holds an C<SV*> key. Otherwise, holds the actual length of the key. Can | |
1474 | be assigned to. The C<HePV()> macro is usually preferable for finding key | |
1475 | lengths. | |
1476 | ||
1477 | STRLEN HeKLEN(HE* he) | |
1478 | ||
497711e7 GS |
1479 | =for hackers |
1480 | Found in file hv.h | |
1481 | ||
954c1994 | 1482 | =item HePV |
d8c40edc | 1483 | X<HePV> |
954c1994 GS |
1484 | |
1485 | Returns the key slot of the hash entry as a C<char*> value, doing any | |
1486 | necessary dereferencing of possibly C<SV*> keys. The length of the string | |
1487 | is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do | |
1488 | not care about what the length of the key is, you may use the global | |
1489 | variable C<PL_na>, though this is rather less efficient than using a local | |
1490 | variable. Remember though, that hash keys in perl are free to contain | |
1491 | embedded nulls, so using C<strlen()> or similar is not a good way to find | |
1492 | the length of hash keys. This is very similar to the C<SvPV()> macro | |
1493 | described elsewhere in this document. | |
1494 | ||
1495 | char* HePV(HE* he, STRLEN len) | |
1496 | ||
497711e7 GS |
1497 | =for hackers |
1498 | Found in file hv.h | |
1499 | ||
954c1994 | 1500 | =item HeSVKEY |
d8c40edc | 1501 | X<HeSVKEY> |
954c1994 | 1502 | |
458cb9d2 | 1503 | Returns the key as an C<SV*>, or C<NULL> if the hash entry does not |
954c1994 GS |
1504 | contain an C<SV*> key. |
1505 | ||
1506 | SV* HeSVKEY(HE* he) | |
1507 | ||
497711e7 GS |
1508 | =for hackers |
1509 | Found in file hv.h | |
1510 | ||
954c1994 | 1511 | =item HeSVKEY_force |
d8c40edc | 1512 | X<HeSVKEY_force> |
954c1994 GS |
1513 | |
1514 | Returns the key as an C<SV*>. Will create and return a temporary mortal | |
1515 | C<SV*> if the hash entry contains only a C<char*> key. | |
1516 | ||
1517 | SV* HeSVKEY_force(HE* he) | |
1518 | ||
497711e7 GS |
1519 | =for hackers |
1520 | Found in file hv.h | |
1521 | ||
954c1994 | 1522 | =item HeSVKEY_set |
d8c40edc | 1523 | X<HeSVKEY_set> |
954c1994 GS |
1524 | |
1525 | Sets the key to a given C<SV*>, taking care to set the appropriate flags to | |
1526 | indicate the presence of an C<SV*> key, and returns the same | |
1527 | C<SV*>. | |
1528 | ||
1529 | SV* HeSVKEY_set(HE* he, SV* sv) | |
1530 | ||
497711e7 GS |
1531 | =for hackers |
1532 | Found in file hv.h | |
1533 | ||
954c1994 | 1534 | =item HeVAL |
d8c40edc | 1535 | X<HeVAL> |
954c1994 GS |
1536 | |
1537 | Returns the value slot (type C<SV*>) stored in the hash entry. | |
1538 | ||
1539 | SV* HeVAL(HE* he) | |
1540 | ||
497711e7 GS |
1541 | =for hackers |
1542 | Found in file hv.h | |
1543 | ||
954c1994 | 1544 | =item HvNAME |
d8c40edc | 1545 | X<HvNAME> |
954c1994 | 1546 | |
9282b5fd SH |
1547 | Returns the package name of a stash, or NULL if C<stash> isn't a stash. |
1548 | See C<SvSTASH>, C<CvSTASH>. | |
954c1994 GS |
1549 | |
1550 | char* HvNAME(HV* stash) | |
1551 | ||
497711e7 GS |
1552 | =for hackers |
1553 | Found in file hv.h | |
1554 | ||
ecae49c0 | 1555 | =item hv_assert |
d8c40edc | 1556 | X<hv_assert> |
ecae49c0 NC |
1557 | |
1558 | Check that a hash is in an internally consistent state. | |
1559 | ||
1560 | void hv_assert(HV* tb) | |
1561 | ||
1562 | =for hackers | |
1563 | Found in file hv.c | |
1564 | ||
954c1994 | 1565 | =item hv_clear |
d8c40edc | 1566 | X<hv_clear> |
954c1994 GS |
1567 | |
1568 | Clears a hash, making it empty. | |
1569 | ||
1570 | void hv_clear(HV* tb) | |
1571 | ||
497711e7 GS |
1572 | =for hackers |
1573 | Found in file hv.c | |
1574 | ||
3540d4ce | 1575 | =item hv_clear_placeholders |
d8c40edc | 1576 | X<hv_clear_placeholders> |
3540d4ce AB |
1577 | |
1578 | Clears any placeholders from a hash. If a restricted hash has any of its keys | |
1579 | marked as readonly and the key is subsequently deleted, the key is not actually | |
1580 | deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags | |
1581 | it so it will be ignored by future operations such as iterating over the hash, | |
fa11829f | 1582 | but will still allow the hash to have a value reassigned to the key at some |
3540d4ce AB |
1583 | future point. This function clears any such placeholder keys from the hash. |
1584 | See Hash::Util::lock_keys() for an example of its use. | |
1585 | ||
1586 | void hv_clear_placeholders(HV* hb) | |
1587 | ||
1588 | =for hackers | |
1589 | Found in file hv.c | |
1590 | ||
954c1994 | 1591 | =item hv_delete |
d8c40edc | 1592 | X<hv_delete> |
954c1994 GS |
1593 | |
1594 | Deletes a key/value pair in the hash. The value SV is removed from the | |
1c846c1f | 1595 | hash and returned to the caller. The C<klen> is the length of the key. |
954c1994 GS |
1596 | The C<flags> value will normally be zero; if set to G_DISCARD then NULL |
1597 | will be returned. | |
1598 | ||
da58a35d | 1599 | SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags) |
954c1994 | 1600 | |
497711e7 GS |
1601 | =for hackers |
1602 | Found in file hv.c | |
1603 | ||
954c1994 | 1604 | =item hv_delete_ent |
d8c40edc | 1605 | X<hv_delete_ent> |
954c1994 GS |
1606 | |
1607 | Deletes a key/value pair in the hash. The value SV is removed from the | |
1608 | hash and returned to the caller. The C<flags> value will normally be zero; | |
1609 | if set to G_DISCARD then NULL will be returned. C<hash> can be a valid | |
1610 | precomputed hash value, or 0 to ask for it to be computed. | |
1611 | ||
1612 | SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash) | |
1613 | ||
497711e7 GS |
1614 | =for hackers |
1615 | Found in file hv.c | |
1616 | ||
954c1994 | 1617 | =item hv_exists |
d8c40edc | 1618 | X<hv_exists> |
954c1994 GS |
1619 | |
1620 | Returns a boolean indicating whether the specified hash key exists. The | |
1621 | C<klen> is the length of the key. | |
1622 | ||
da58a35d | 1623 | bool hv_exists(HV* tb, const char* key, I32 klen) |
954c1994 | 1624 | |
497711e7 GS |
1625 | =for hackers |
1626 | Found in file hv.c | |
1627 | ||
954c1994 | 1628 | =item hv_exists_ent |
d8c40edc | 1629 | X<hv_exists_ent> |
954c1994 GS |
1630 | |
1631 | Returns a boolean indicating whether the specified hash key exists. C<hash> | |
1632 | can be a valid precomputed hash value, or 0 to ask for it to be | |
1633 | computed. | |
1634 | ||
1635 | bool hv_exists_ent(HV* tb, SV* key, U32 hash) | |
1636 | ||
497711e7 GS |
1637 | =for hackers |
1638 | Found in file hv.c | |
1639 | ||
954c1994 | 1640 | =item hv_fetch |
d8c40edc | 1641 | X<hv_fetch> |
954c1994 GS |
1642 | |
1643 | Returns the SV which corresponds to the specified key in the hash. The | |
1644 | C<klen> is the length of the key. If C<lval> is set then the fetch will be | |
1645 | part of a store. Check that the return value is non-null before | |
f4758303 | 1646 | dereferencing it to an C<SV*>. |
954c1994 | 1647 | |
96f1132b | 1648 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 GS |
1649 | information on how to use this function on tied hashes. |
1650 | ||
da58a35d | 1651 | SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval) |
954c1994 | 1652 | |
497711e7 GS |
1653 | =for hackers |
1654 | Found in file hv.c | |
1655 | ||
3fe05580 MHM |
1656 | =item hv_fetchs |
1657 | X<hv_fetchs> | |
1658 | ||
1659 | Like C<hv_fetch>, but takes a literal string instead of a string/length pair. | |
1660 | ||
1661 | SV** hv_fetchs(HV* tb, const char* key, I32 lval) | |
1662 | ||
1663 | =for hackers | |
1664 | Found in file handy.h | |
1665 | ||
954c1994 | 1666 | =item hv_fetch_ent |
d8c40edc | 1667 | X<hv_fetch_ent> |
954c1994 GS |
1668 | |
1669 | Returns the hash entry which corresponds to the specified key in the hash. | |
1670 | C<hash> must be a valid precomputed hash number for the given C<key>, or 0 | |
1671 | if you want the function to compute it. IF C<lval> is set then the fetch | |
1672 | will be part of a store. Make sure the return value is non-null before | |
1673 | accessing it. The return value when C<tb> is a tied hash is a pointer to a | |
1674 | static location, so be sure to make a copy of the structure if you need to | |
1c846c1f | 1675 | store it somewhere. |
954c1994 | 1676 | |
96f1132b | 1677 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 GS |
1678 | information on how to use this function on tied hashes. |
1679 | ||
1680 | HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash) | |
1681 | ||
497711e7 GS |
1682 | =for hackers |
1683 | Found in file hv.c | |
1684 | ||
954c1994 | 1685 | =item hv_iterinit |
d8c40edc | 1686 | X<hv_iterinit> |
954c1994 GS |
1687 | |
1688 | Prepares a starting point to traverse a hash table. Returns the number of | |
1689 | keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is | |
1c846c1f | 1690 | currently only meaningful for hashes without tie magic. |
954c1994 GS |
1691 | |
1692 | NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of | |
1693 | hash buckets that happen to be in use. If you still need that esoteric | |
1694 | value, you can get it through the macro C<HvFILL(tb)>. | |
1695 | ||
641d4181 | 1696 | |
954c1994 GS |
1697 | I32 hv_iterinit(HV* tb) |
1698 | ||
497711e7 GS |
1699 | =for hackers |
1700 | Found in file hv.c | |
1701 | ||
954c1994 | 1702 | =item hv_iterkey |
d8c40edc | 1703 | X<hv_iterkey> |
954c1994 GS |
1704 | |
1705 | Returns the key from the current position of the hash iterator. See | |
1706 | C<hv_iterinit>. | |
1707 | ||
1708 | char* hv_iterkey(HE* entry, I32* retlen) | |
1709 | ||
497711e7 GS |
1710 | =for hackers |
1711 | Found in file hv.c | |
1712 | ||
954c1994 | 1713 | =item hv_iterkeysv |
d8c40edc | 1714 | X<hv_iterkeysv> |
954c1994 GS |
1715 | |
1716 | Returns the key as an C<SV*> from the current position of the hash | |
1717 | iterator. The return value will always be a mortal copy of the key. Also | |
1718 | see C<hv_iterinit>. | |
1719 | ||
1720 | SV* hv_iterkeysv(HE* entry) | |
1721 | ||
497711e7 GS |
1722 | =for hackers |
1723 | Found in file hv.c | |
1724 | ||
954c1994 | 1725 | =item hv_iternext |
d8c40edc | 1726 | X<hv_iternext> |
954c1994 GS |
1727 | |
1728 | Returns entries from a hash iterator. See C<hv_iterinit>. | |
1729 | ||
641d4181 JH |
1730 | You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the |
1731 | iterator currently points to, without losing your place or invalidating your | |
1732 | iterator. Note that in this case the current entry is deleted from the hash | |
1733 | with your iterator holding the last reference to it. Your iterator is flagged | |
1734 | to free the entry on the next call to C<hv_iternext>, so you must not discard | |
1735 | your iterator immediately else the entry will leak - call C<hv_iternext> to | |
1736 | trigger the resource deallocation. | |
1737 | ||
954c1994 GS |
1738 | HE* hv_iternext(HV* tb) |
1739 | ||
497711e7 GS |
1740 | =for hackers |
1741 | Found in file hv.c | |
1742 | ||
954c1994 | 1743 | =item hv_iternextsv |
d8c40edc | 1744 | X<hv_iternextsv> |
954c1994 GS |
1745 | |
1746 | Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one | |
1747 | operation. | |
1748 | ||
1749 | SV* hv_iternextsv(HV* hv, char** key, I32* retlen) | |
1750 | ||
497711e7 GS |
1751 | =for hackers |
1752 | Found in file hv.c | |
1753 | ||
641d4181 | 1754 | =item hv_iternext_flags |
d8c40edc | 1755 | X<hv_iternext_flags> |
641d4181 JH |
1756 | |
1757 | Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>. | |
1758 | The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is | |
1759 | set the placeholders keys (for restricted hashes) will be returned in addition | |
1760 | to normal keys. By default placeholders are automatically skipped over. | |
384679aa RGS |
1761 | Currently a placeholder is implemented with a value that is |
1762 | C<&Perl_sv_placeholder>. Note that the implementation of placeholders and | |
641d4181 JH |
1763 | restricted hashes may change, and the implementation currently is |
1764 | insufficiently abstracted for any change to be tidy. | |
1765 | ||
1766 | NOTE: this function is experimental and may change or be | |
1767 | removed without notice. | |
1768 | ||
1769 | HE* hv_iternext_flags(HV* tb, I32 flags) | |
1770 | ||
1771 | =for hackers | |
1772 | Found in file hv.c | |
1773 | ||
954c1994 | 1774 | =item hv_iterval |
d8c40edc | 1775 | X<hv_iterval> |
954c1994 GS |
1776 | |
1777 | Returns the value from the current position of the hash iterator. See | |
1778 | C<hv_iterkey>. | |
1779 | ||
1780 | SV* hv_iterval(HV* tb, HE* entry) | |
1781 | ||
497711e7 GS |
1782 | =for hackers |
1783 | Found in file hv.c | |
1784 | ||
954c1994 | 1785 | =item hv_magic |
d8c40edc | 1786 | X<hv_magic> |
954c1994 GS |
1787 | |
1788 | Adds magic to a hash. See C<sv_magic>. | |
1789 | ||
1790 | void hv_magic(HV* hv, GV* gv, int how) | |
1791 | ||
497711e7 GS |
1792 | =for hackers |
1793 | Found in file hv.c | |
1794 | ||
a3bcc51e | 1795 | =item hv_scalar |
d8c40edc | 1796 | X<hv_scalar> |
a3bcc51e TP |
1797 | |
1798 | Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied. | |
1799 | ||
1800 | SV* hv_scalar(HV* hv) | |
1801 | ||
1802 | =for hackers | |
1803 | Found in file hv.c | |
1804 | ||
954c1994 | 1805 | =item hv_store |
d8c40edc | 1806 | X<hv_store> |
954c1994 GS |
1807 | |
1808 | Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is | |
1809 | the length of the key. The C<hash> parameter is the precomputed hash | |
1810 | value; if it is zero then Perl will compute it. The return value will be | |
1811 | NULL if the operation failed or if the value did not need to be actually | |
1812 | stored within the hash (as in the case of tied hashes). Otherwise it can | |
1813 | be dereferenced to get the original C<SV*>. Note that the caller is | |
1814 | responsible for suitably incrementing the reference count of C<val> before | |
7e8c5dac HS |
1815 | the call, and decrementing it if the function returned NULL. Effectively |
1816 | a successful hv_store takes ownership of one reference to C<val>. This is | |
1817 | usually what you want; a newly created SV has a reference count of one, so | |
1818 | if all your code does is create SVs then store them in a hash, hv_store | |
1819 | will own the only reference to the new SV, and your code doesn't need to do | |
1820 | anything further to tidy up. hv_store is not implemented as a call to | |
1821 | hv_store_ent, and does not create a temporary SV for the key, so if your | |
1822 | key data is not already in SV form then use hv_store in preference to | |
1823 | hv_store_ent. | |
954c1994 | 1824 | |
96f1132b | 1825 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 GS |
1826 | information on how to use this function on tied hashes. |
1827 | ||
da58a35d | 1828 | SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash) |
954c1994 | 1829 | |
497711e7 GS |
1830 | =for hackers |
1831 | Found in file hv.c | |
1832 | ||
3fe05580 MHM |
1833 | =item hv_stores |
1834 | X<hv_stores> | |
1835 | ||
1836 | Like C<hv_store>, but takes a literal string instead of a string/length pair | |
1837 | and omits the hash parameter. | |
1838 | ||
1839 | SV** hv_stores(HV* tb, const char* key, NULLOK SV* val) | |
1840 | ||
1841 | =for hackers | |
1842 | Found in file handy.h | |
1843 | ||
954c1994 | 1844 | =item hv_store_ent |
d8c40edc | 1845 | X<hv_store_ent> |
954c1994 GS |
1846 | |
1847 | Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash> | |
1848 | parameter is the precomputed hash value; if it is zero then Perl will | |
1849 | compute it. The return value is the new hash entry so created. It will be | |
1850 | NULL if the operation failed or if the value did not need to be actually | |
1851 | stored within the hash (as in the case of tied hashes). Otherwise the | |
f22d8e4b | 1852 | contents of the return value can be accessed using the C<He?> macros |
954c1994 GS |
1853 | described here. Note that the caller is responsible for suitably |
1854 | incrementing the reference count of C<val> before the call, and | |
7e8c5dac HS |
1855 | decrementing it if the function returned NULL. Effectively a successful |
1856 | hv_store_ent takes ownership of one reference to C<val>. This is | |
1857 | usually what you want; a newly created SV has a reference count of one, so | |
1858 | if all your code does is create SVs then store them in a hash, hv_store | |
1859 | will own the only reference to the new SV, and your code doesn't need to do | |
1860 | anything further to tidy up. Note that hv_store_ent only reads the C<key>; | |
1861 | unlike C<val> it does not take ownership of it, so maintaining the correct | |
1862 | reference count on C<key> is entirely the caller's responsibility. hv_store | |
1863 | is not implemented as a call to hv_store_ent, and does not create a temporary | |
1864 | SV for the key, so if your key data is not already in SV form then use | |
1865 | hv_store in preference to hv_store_ent. | |
954c1994 | 1866 | |
96f1132b | 1867 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 GS |
1868 | information on how to use this function on tied hashes. |
1869 | ||
1870 | HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash) | |
1871 | ||
497711e7 GS |
1872 | =for hackers |
1873 | Found in file hv.c | |
1874 | ||
954c1994 | 1875 | =item hv_undef |
d8c40edc | 1876 | X<hv_undef> |
954c1994 GS |
1877 | |
1878 | Undefines the hash. | |
1879 | ||
1880 | void hv_undef(HV* tb) | |
1881 | ||
497711e7 GS |
1882 | =for hackers |
1883 | Found in file hv.c | |
1884 | ||
94bdecf9 | 1885 | =item newHV |
d8c40edc | 1886 | X<newHV> |
d2cc3551 | 1887 | |
94bdecf9 | 1888 | Creates a new HV. The reference count is set to 1. |
d2cc3551 | 1889 | |
94bdecf9 | 1890 | HV* newHV() |
d2cc3551 JH |
1891 | |
1892 | =for hackers | |
94bdecf9 | 1893 | Found in file hv.c |
d2cc3551 | 1894 | |
954c1994 | 1895 | |
94bdecf9 | 1896 | =back |
954c1994 | 1897 | |
94bdecf9 | 1898 | =head1 Magical Functions |
954c1994 | 1899 | |
94bdecf9 | 1900 | =over 8 |
497711e7 | 1901 | |
94bdecf9 | 1902 | =item mg_clear |
d8c40edc | 1903 | X<mg_clear> |
954c1994 | 1904 | |
94bdecf9 | 1905 | Clear something magical that the SV represents. See C<sv_magic>. |
954c1994 | 1906 | |
94bdecf9 | 1907 | int mg_clear(SV* sv) |
954c1994 | 1908 | |
497711e7 | 1909 | =for hackers |
94bdecf9 | 1910 | Found in file mg.c |
497711e7 | 1911 | |
94bdecf9 | 1912 | =item mg_copy |
d8c40edc | 1913 | X<mg_copy> |
954c1994 | 1914 | |
94bdecf9 | 1915 | Copies the magic from one SV to another. See C<sv_magic>. |
954c1994 | 1916 | |
94bdecf9 | 1917 | int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen) |
954c1994 | 1918 | |
497711e7 | 1919 | =for hackers |
94bdecf9 | 1920 | Found in file mg.c |
497711e7 | 1921 | |
94bdecf9 | 1922 | =item mg_find |
d8c40edc | 1923 | X<mg_find> |
954c1994 | 1924 | |
94bdecf9 | 1925 | Finds the magic pointer for type matching the SV. See C<sv_magic>. |
954c1994 | 1926 | |
35a4481c | 1927 | MAGIC* mg_find(const SV* sv, int type) |
954c1994 | 1928 | |
497711e7 | 1929 | =for hackers |
94bdecf9 | 1930 | Found in file mg.c |
497711e7 | 1931 | |
94bdecf9 | 1932 | =item mg_free |
d8c40edc | 1933 | X<mg_free> |
954c1994 | 1934 | |
94bdecf9 | 1935 | Free any magic storage used by the SV. See C<sv_magic>. |
954c1994 | 1936 | |
94bdecf9 | 1937 | int mg_free(SV* sv) |
954c1994 | 1938 | |
497711e7 | 1939 | =for hackers |
94bdecf9 | 1940 | Found in file mg.c |
497711e7 | 1941 | |
94bdecf9 | 1942 | =item mg_get |
d8c40edc | 1943 | X<mg_get> |
eebe1485 | 1944 | |
94bdecf9 | 1945 | Do magic after a value is retrieved from the SV. See C<sv_magic>. |
282f25c9 | 1946 | |
94bdecf9 | 1947 | int mg_get(SV* sv) |
eebe1485 SC |
1948 | |
1949 | =for hackers | |
94bdecf9 | 1950 | Found in file mg.c |
eebe1485 | 1951 | |
94bdecf9 | 1952 | =item mg_length |
d8c40edc | 1953 | X<mg_length> |
eebe1485 | 1954 | |
94bdecf9 | 1955 | Report on the SV's length. See C<sv_magic>. |
eebe1485 | 1956 | |
94bdecf9 | 1957 | U32 mg_length(SV* sv) |
eebe1485 SC |
1958 | |
1959 | =for hackers | |
94bdecf9 | 1960 | Found in file mg.c |
eebe1485 | 1961 | |
94bdecf9 | 1962 | =item mg_magical |
d8c40edc | 1963 | X<mg_magical> |
954c1994 | 1964 | |
94bdecf9 | 1965 | Turns on the magical status of an SV. See C<sv_magic>. |
954c1994 | 1966 | |
94bdecf9 | 1967 | void mg_magical(SV* sv) |
954c1994 | 1968 | |
497711e7 | 1969 | =for hackers |
94bdecf9 | 1970 | Found in file mg.c |
497711e7 | 1971 | |
94bdecf9 | 1972 | =item mg_set |
d8c40edc | 1973 | X<mg_set> |
954c1994 | 1974 | |
94bdecf9 | 1975 | Do magic after a value is assigned to the SV. See C<sv_magic>. |
954c1994 | 1976 | |
94bdecf9 | 1977 | int mg_set(SV* sv) |
954c1994 | 1978 | |
497711e7 | 1979 | =for hackers |
94bdecf9 | 1980 | Found in file mg.c |
497711e7 | 1981 | |
94bdecf9 | 1982 | =item SvGETMAGIC |
d8c40edc | 1983 | X<SvGETMAGIC> |
954c1994 | 1984 | |
94bdecf9 JH |
1985 | Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its |
1986 | argument more than once. | |
954c1994 | 1987 | |
94bdecf9 | 1988 | void SvGETMAGIC(SV* sv) |
954c1994 | 1989 | |
497711e7 | 1990 | =for hackers |
94bdecf9 | 1991 | Found in file sv.h |
497711e7 | 1992 | |
a4f1a029 | 1993 | =item SvLOCK |
d8c40edc | 1994 | X<SvLOCK> |
a4f1a029 NIS |
1995 | |
1996 | Arranges for a mutual exclusion lock to be obtained on sv if a suitable module | |
1997 | has been loaded. | |
1998 | ||
1999 | void SvLOCK(SV* sv) | |
2000 | ||
2001 | =for hackers | |
2002 | Found in file sv.h | |
2003 | ||
94bdecf9 | 2004 | =item SvSETMAGIC |
d8c40edc | 2005 | X<SvSETMAGIC> |
7d3fb230 | 2006 | |
94bdecf9 JH |
2007 | Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its |
2008 | argument more than once. | |
7d3fb230 | 2009 | |
94bdecf9 | 2010 | void SvSETMAGIC(SV* sv) |
7d3fb230 BS |
2011 | |
2012 | =for hackers | |
94bdecf9 | 2013 | Found in file sv.h |
7d3fb230 | 2014 | |
94bdecf9 | 2015 | =item SvSetMagicSV |
d8c40edc | 2016 | X<SvSetMagicSV> |
954c1994 | 2017 | |
94bdecf9 | 2018 | Like C<SvSetSV>, but does any set magic required afterwards. |
954c1994 | 2019 | |
94bdecf9 | 2020 | void SvSetMagicSV(SV* dsb, SV* ssv) |
954c1994 | 2021 | |
497711e7 | 2022 | =for hackers |
94bdecf9 | 2023 | Found in file sv.h |
497711e7 | 2024 | |
a4f1a029 | 2025 | =item SvSetMagicSV_nosteal |
d8c40edc | 2026 | X<SvSetMagicSV_nosteal> |
a4f1a029 | 2027 | |
80663158 | 2028 | Like C<SvSetSV_nosteal>, but does any set magic required afterwards. |
a4f1a029 NIS |
2029 | |
2030 | void SvSetMagicSV_nosteal(SV* dsv, SV* ssv) | |
2031 | ||
2032 | =for hackers | |
2033 | Found in file sv.h | |
2034 | ||
94bdecf9 | 2035 | =item SvSetSV |
d8c40edc | 2036 | X<SvSetSV> |
954c1994 | 2037 | |
94bdecf9 JH |
2038 | Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments |
2039 | more than once. | |
2040 | ||
2041 | void SvSetSV(SV* dsb, SV* ssv) | |
954c1994 | 2042 | |
497711e7 | 2043 | =for hackers |
94bdecf9 | 2044 | Found in file sv.h |
497711e7 | 2045 | |
94bdecf9 | 2046 | =item SvSetSV_nosteal |
d8c40edc | 2047 | X<SvSetSV_nosteal> |
954c1994 | 2048 | |
94bdecf9 JH |
2049 | Calls a non-destructive version of C<sv_setsv> if dsv is not the same as |
2050 | ssv. May evaluate arguments more than once. | |
954c1994 | 2051 | |
94bdecf9 | 2052 | void SvSetSV_nosteal(SV* dsv, SV* ssv) |
954c1994 | 2053 | |
497711e7 | 2054 | =for hackers |
94bdecf9 | 2055 | Found in file sv.h |
497711e7 | 2056 | |
a4f1a029 | 2057 | =item SvSHARE |
d8c40edc | 2058 | X<SvSHARE> |
a4f1a029 NIS |
2059 | |
2060 | Arranges for sv to be shared between threads if a suitable module | |
2061 | has been loaded. | |
2062 | ||
2063 | void SvSHARE(SV* sv) | |
2064 | ||
2065 | =for hackers | |
2066 | Found in file sv.h | |
2067 | ||
e509e693 | 2068 | =item SvUNLOCK |
d8c40edc | 2069 | X<SvUNLOCK> |
e509e693 SH |
2070 | |
2071 | Releases a mutual exclusion lock on sv if a suitable module | |
2072 | has been loaded. | |
2073 | ||
2074 | void SvUNLOCK(SV* sv) | |
2075 | ||
2076 | =for hackers | |
2077 | Found in file sv.h | |
2078 | ||
954c1994 | 2079 | |
94bdecf9 | 2080 | =back |
954c1994 | 2081 | |
94bdecf9 | 2082 | =head1 Memory Management |
954c1994 | 2083 | |
94bdecf9 | 2084 | =over 8 |
497711e7 | 2085 | |
94bdecf9 | 2086 | =item Copy |
d8c40edc | 2087 | X<Copy> |
954c1994 | 2088 | |
94bdecf9 JH |
2089 | The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the |
2090 | source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is | |
2091 | the type. May fail on overlapping copies. See also C<Move>. | |
954c1994 | 2092 | |
94bdecf9 | 2093 | void Copy(void* src, void* dest, int nitems, type) |
954c1994 | 2094 | |
497711e7 | 2095 | =for hackers |
94bdecf9 | 2096 | Found in file handy.h |
497711e7 | 2097 | |
e90e2364 | 2098 | =item CopyD |
d8c40edc | 2099 | X<CopyD> |
e90e2364 NC |
2100 | |
2101 | Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call | |
2102 | optimise. | |
2103 | ||
2104 | void * CopyD(void* src, void* dest, int nitems, type) | |
2105 | ||
2106 | =for hackers | |
2107 | Found in file handy.h | |
2108 | ||
94bdecf9 | 2109 | =item Move |
d8c40edc | 2110 | X<Move> |
954c1994 | 2111 | |
94bdecf9 JH |
2112 | The XSUB-writer's interface to the C C<memmove> function. The C<src> is the |
2113 | source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is | |
2114 | the type. Can do overlapping moves. See also C<Copy>. | |
954c1994 | 2115 | |
94bdecf9 | 2116 | void Move(void* src, void* dest, int nitems, type) |
954c1994 | 2117 | |
497711e7 | 2118 | =for hackers |
94bdecf9 | 2119 | Found in file handy.h |
497711e7 | 2120 | |
e90e2364 | 2121 | =item MoveD |
d8c40edc | 2122 | X<MoveD> |
e90e2364 NC |
2123 | |
2124 | Like C<Move> but returns dest. Useful for encouraging compilers to tail-call | |
2125 | optimise. | |
2126 | ||
2127 | void * MoveD(void* src, void* dest, int nitems, type) | |
2128 | ||
2129 | =for hackers | |
2130 | Found in file handy.h | |
2131 | ||
a02a5408 | 2132 | =item Newx |
d8c40edc | 2133 | X<Newx> |
954c1994 | 2134 | |
94bdecf9 | 2135 | The XSUB-writer's interface to the C C<malloc> function. |
954c1994 | 2136 | |
c5008215 JC |
2137 | In 5.9.3, Newx() and friends replace the older New() API, and drops |
2138 | the first parameter, I<x>, a debug aid which allowed callers to identify | |
37b8b4c9 | 2139 | themselves. This aid has been superseded by a new build option, |
c5008215 JC |
2140 | PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still |
2141 | there for use in XS modules supporting older perls. | |
2142 | ||
a02a5408 | 2143 | void Newx(void* ptr, int nitems, type) |
954c1994 | 2144 | |
497711e7 | 2145 | =for hackers |
94bdecf9 | 2146 | Found in file handy.h |
497711e7 | 2147 | |
a02a5408 | 2148 | =item Newxc |
d8c40edc | 2149 | X<Newxc> |
954c1994 | 2150 | |
94bdecf9 | 2151 | The XSUB-writer's interface to the C C<malloc> function, with |
c5008215 | 2152 | cast. See also C<Newx>. |
954c1994 | 2153 | |
a02a5408 | 2154 | void Newxc(void* ptr, int nitems, type, cast) |
954c1994 | 2155 | |
497711e7 | 2156 | =for hackers |
94bdecf9 | 2157 | Found in file handy.h |
954c1994 | 2158 | |
a02a5408 | 2159 | =item Newxz |
d8c40edc | 2160 | X<Newxz> |
954c1994 | 2161 | |
94bdecf9 | 2162 | The XSUB-writer's interface to the C C<malloc> function. The allocated |
c5008215 | 2163 | memory is zeroed with C<memzero>. See also C<Newx>. |
a02a5408 JC |
2164 | |
2165 | void Newxz(void* ptr, int nitems, type) | |
954c1994 | 2166 | |
497711e7 GS |
2167 | =for hackers |
2168 | Found in file handy.h | |
2169 | ||
9965345d | 2170 | =item Poison |
d8c40edc | 2171 | X<Poison> |
9965345d | 2172 | |
7e337ee0 | 2173 | PoisonWith(0xEF) for catching access to freed memory. |
9965345d JH |
2174 | |
2175 | void Poison(void* dest, int nitems, type) | |
2176 | ||
2177 | =for hackers | |
2178 | Found in file handy.h | |
2179 | ||
3fe05580 MHM |
2180 | =item PoisonFree |
2181 | X<PoisonFree> | |
2182 | ||
2183 | PoisonWith(0xEF) for catching access to freed memory. | |
2184 | ||
2185 | void PoisonFree(void* dest, int nitems, type) | |
2186 | ||
2187 | =for hackers | |
2188 | Found in file handy.h | |
2189 | ||
7e337ee0 JH |
2190 | =item PoisonNew |
2191 | X<PoisonNew> | |
2192 | ||
2193 | PoisonWith(0xAB) for catching access to allocated but uninitialized memory. | |
2194 | ||
2195 | void PoisonNew(void* dest, int nitems, type) | |
2196 | ||
2197 | =for hackers | |
2198 | Found in file handy.h | |
2199 | ||
2200 | =item PoisonWith | |
2201 | X<PoisonWith> | |
2202 | ||
2203 | Fill up memory with a byte pattern (a byte repeated over and over | |
2204 | again) that hopefully catches attempts to access uninitialized memory. | |
2205 | ||
2206 | void PoisonWith(void* dest, int nitems, type, U8 byte) | |
2207 | ||
2208 | =for hackers | |
2209 | Found in file handy.h | |
2210 | ||
94bdecf9 | 2211 | =item Renew |
d8c40edc | 2212 | X<Renew> |
954c1994 | 2213 | |
94bdecf9 | 2214 | The XSUB-writer's interface to the C C<realloc> function. |
954c1994 | 2215 | |
94bdecf9 | 2216 | void Renew(void* ptr, int nitems, type) |
954c1994 | 2217 | |
497711e7 GS |
2218 | =for hackers |
2219 | Found in file handy.h | |
2220 | ||
94bdecf9 | 2221 | =item Renewc |
d8c40edc | 2222 | X<Renewc> |
954c1994 | 2223 | |
94bdecf9 JH |
2224 | The XSUB-writer's interface to the C C<realloc> function, with |
2225 | cast. | |
954c1994 | 2226 | |
94bdecf9 | 2227 | void Renewc(void* ptr, int nitems, type, cast) |
954c1994 | 2228 | |
497711e7 | 2229 | =for hackers |
94bdecf9 | 2230 | Found in file handy.h |
497711e7 | 2231 | |
94bdecf9 | 2232 | =item Safefree |
d8c40edc | 2233 | X<Safefree> |
954c1994 | 2234 | |
94bdecf9 | 2235 | The XSUB-writer's interface to the C C<free> function. |
954c1994 | 2236 | |
94bdecf9 | 2237 | void Safefree(void* ptr) |
954c1994 | 2238 | |
497711e7 GS |
2239 | =for hackers |
2240 | Found in file handy.h | |
2241 | ||
94bdecf9 | 2242 | =item savepv |
d8c40edc | 2243 | X<savepv> |
954c1994 | 2244 | |
641d4181 JH |
2245 | Perl's version of C<strdup()>. Returns a pointer to a newly allocated |
2246 | string which is a duplicate of C<pv>. The size of the string is | |
2247 | determined by C<strlen()>. The memory allocated for the new string can | |
2248 | be freed with the C<Safefree()> function. | |
954c1994 | 2249 | |
641d4181 | 2250 | char* savepv(const char* pv) |
954c1994 | 2251 | |
497711e7 | 2252 | =for hackers |
94bdecf9 | 2253 | Found in file util.c |
497711e7 | 2254 | |
94bdecf9 | 2255 | =item savepvn |
d8c40edc | 2256 | X<savepvn> |
954c1994 | 2257 | |
641d4181 JH |
2258 | Perl's version of what C<strndup()> would be if it existed. Returns a |
2259 | pointer to a newly allocated string which is a duplicate of the first | |
cbf82dd0 NC |
2260 | C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for |
2261 | the new string can be freed with the C<Safefree()> function. | |
954c1994 | 2262 | |
641d4181 | 2263 | char* savepvn(const char* pv, I32 len) |
954c1994 | 2264 | |
497711e7 | 2265 | =for hackers |
94bdecf9 | 2266 | Found in file util.c |
497711e7 | 2267 | |
3fe05580 MHM |
2268 | =item savepvs |
2269 | X<savepvs> | |
2270 | ||
2271 | Like C<savepvn>, but takes a literal string instead of a string/length pair. | |
2272 | ||
2273 | char* savepvs(const char* s) | |
2274 | ||
2275 | =for hackers | |
2276 | Found in file handy.h | |
2277 | ||
a4f1a029 | 2278 | =item savesharedpv |
d8c40edc | 2279 | X<savesharedpv> |
a4f1a029 | 2280 | |
641d4181 JH |
2281 | A version of C<savepv()> which allocates the duplicate string in memory |
2282 | which is shared between threads. | |
a4f1a029 | 2283 | |
641d4181 | 2284 | char* savesharedpv(const char* pv) |
a4f1a029 NIS |
2285 | |
2286 | =for hackers | |
2287 | Found in file util.c | |
2288 | ||
d9095cec NC |
2289 | =item savesharedpvn |
2290 | X<savesharedpvn> | |
2291 | ||
2292 | A version of C<savepvn()> which allocates the duplicate string in memory | |
2293 | which is shared between threads. (With the specific difference that a NULL | |
2294 | pointer is not acceptable) | |
2295 | ||
2296 | char* savesharedpvn(const char *const pv, const STRLEN len) | |
2297 | ||
2298 | =for hackers | |
2299 | Found in file util.c | |
2300 | ||
766f8916 | 2301 | =item savesvpv |
d8c40edc | 2302 | X<savesvpv> |
766f8916 | 2303 | |
9c2fe30c | 2304 | A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from |
766f8916 MHM |
2305 | the passed in SV using C<SvPV()> |
2306 | ||
2307 | char* savesvpv(SV* sv) | |
2308 | ||
2309 | =for hackers | |
2310 | Found in file util.c | |
2311 | ||
94bdecf9 | 2312 | =item StructCopy |
d8c40edc | 2313 | X<StructCopy> |
954c1994 | 2314 | |
94bdecf9 | 2315 | This is an architecture-independent macro to copy one structure to another. |
954c1994 | 2316 | |
94bdecf9 | 2317 | void StructCopy(type src, type dest, type) |
954c1994 | 2318 | |
497711e7 | 2319 | =for hackers |
94bdecf9 | 2320 | Found in file handy.h |
497711e7 | 2321 | |
94bdecf9 | 2322 | =item Zero |
d8c40edc | 2323 | X<Zero> |
954c1994 | 2324 | |
94bdecf9 JH |
2325 | The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the |
2326 | destination, C<nitems> is the number of items, and C<type> is the type. | |
954c1994 | 2327 | |
94bdecf9 | 2328 | void Zero(void* dest, int nitems, type) |
954c1994 | 2329 | |
497711e7 | 2330 | =for hackers |
94bdecf9 | 2331 | Found in file handy.h |
497711e7 | 2332 | |
e90e2364 | 2333 | =item ZeroD |
d8c40edc | 2334 | X<ZeroD> |
e90e2364 NC |
2335 | |
2336 | Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call | |
2337 | optimise. | |
2338 | ||
2339 | void * ZeroD(void* dest, int nitems, type) | |
2340 | ||
2341 | =for hackers | |
2342 | Found in file handy.h | |
2343 | ||
954c1994 | 2344 | |
94bdecf9 | 2345 | =back |
954c1994 | 2346 | |
94bdecf9 | 2347 | =head1 Miscellaneous Functions |
954c1994 | 2348 | |
94bdecf9 | 2349 | =over 8 |
497711e7 | 2350 | |
94bdecf9 | 2351 | =item fbm_compile |
d8c40edc | 2352 | X<fbm_compile> |
8b4ac5a4 | 2353 | |
94bdecf9 JH |
2354 | Analyses the string in order to make fast searches on it using fbm_instr() |
2355 | -- the Boyer-Moore algorithm. | |
8b4ac5a4 | 2356 | |
94bdecf9 | 2357 | void fbm_compile(SV* sv, U32 flags) |
8b4ac5a4 JH |
2358 | |
2359 | =for hackers | |
94bdecf9 | 2360 | Found in file util.c |
8b4ac5a4 | 2361 | |
94bdecf9 | 2362 | =item fbm_instr |
d8c40edc | 2363 | X<fbm_instr> |
954c1994 | 2364 | |
94bdecf9 | 2365 | Returns the location of the SV in the string delimited by C<str> and |
bd61b366 | 2366 | C<strend>. It returns C<NULL> if the string can't be found. The C<sv> |
94bdecf9 JH |
2367 | does not have to be fbm_compiled, but the search will not be as fast |
2368 | then. | |
954c1994 | 2369 | |
94bdecf9 | 2370 | char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags) |
954c1994 | 2371 | |
497711e7 | 2372 | =for hackers |
94bdecf9 | 2373 | Found in file util.c |
497711e7 | 2374 | |
94bdecf9 | 2375 | =item form |
d8c40edc | 2376 | X<form> |
954c1994 | 2377 | |
94bdecf9 JH |
2378 | Takes a sprintf-style format pattern and conventional |
2379 | (non-SV) arguments and returns the formatted string. | |
954c1994 | 2380 | |
94bdecf9 | 2381 | (char *) Perl_form(pTHX_ const char* pat, ...) |
954c1994 | 2382 | |
94bdecf9 | 2383 | can be used any place a string (char *) is required: |
497711e7 | 2384 | |
94bdecf9 | 2385 | char * s = Perl_form("%d.%d",major,minor); |
954c1994 | 2386 | |
94bdecf9 JH |
2387 | Uses a single private buffer so if you want to format several strings you |
2388 | must explicitly copy the earlier strings away (and free the copies when you | |
2389 | are done). | |
954c1994 | 2390 | |
94bdecf9 | 2391 | char* form(const char* pat, ...) |
954c1994 | 2392 | |
497711e7 | 2393 | =for hackers |
94bdecf9 | 2394 | Found in file util.c |
497711e7 | 2395 | |
94bdecf9 | 2396 | =item getcwd_sv |
d8c40edc | 2397 | X<getcwd_sv> |
954c1994 | 2398 | |
94bdecf9 | 2399 | Fill the sv with current working directory |
954c1994 | 2400 | |
94bdecf9 | 2401 | int getcwd_sv(SV* sv) |
954c1994 | 2402 | |
497711e7 | 2403 | =for hackers |
94bdecf9 | 2404 | Found in file util.c |
497711e7 | 2405 | |
d9fad198 JH |
2406 | =item my_snprintf |
2407 | X<my_snprintf> | |
2408 | ||
2409 | The C library C<snprintf> functionality, if available and | |
5b692037 | 2410 | standards-compliant (uses C<vsnprintf>, actually). However, if the |
d9fad198 | 2411 | C<vsnprintf> is not available, will unfortunately use the unsafe |
5b692037 JH |
2412 | C<vsprintf> which can overrun the buffer (there is an overrun check, |
2413 | but that may be too late). Consider using C<sv_vcatpvf> instead, or | |
2414 | getting C<vsnprintf>. | |
d9fad198 JH |
2415 | |
2416 | int my_snprintf(char *buffer, const Size_t len, const char *format, ...) | |
2417 | ||
2418 | =for hackers | |
2419 | Found in file util.c | |
2420 | ||
9244d4ad RGS |
2421 | =item my_sprintf |
2422 | X<my_sprintf> | |
2423 | ||
2424 | The C library C<sprintf>, wrapped if necessary, to ensure that it will return | |
2425 | the length of the string written to the buffer. Only rare pre-ANSI systems | |
2426 | need the wrapper function - usually this is a direct call to C<sprintf>. | |
2427 | ||
2428 | int my_sprintf(char *buffer, const char *pat, ...) | |
2429 | ||
2430 | =for hackers | |
2431 | Found in file util.c | |
2432 | ||
d9fad198 JH |
2433 | =item my_vsnprintf |
2434 | X<my_vsnprintf> | |
2435 | ||
5b692037 JH |
2436 | The C library C<vsnprintf> if available and standards-compliant. |
2437 | However, if if the C<vsnprintf> is not available, will unfortunately | |
2438 | use the unsafe C<vsprintf> which can overrun the buffer (there is an | |
2439 | overrun check, but that may be too late). Consider using | |
2440 | C<sv_vcatpvf> instead, or getting C<vsnprintf>. | |
d9fad198 JH |
2441 | |
2442 | int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap) | |
2443 | ||
2444 | =for hackers | |
2445 | Found in file util.c | |
2446 | ||
f333445c | 2447 | =item new_version |
d8c40edc | 2448 | X<new_version> |
f333445c JP |
2449 | |
2450 | Returns a new version object based on the passed in SV: | |
2451 | ||
2452 | SV *sv = new_version(SV *ver); | |
2453 | ||
2454 | Does not alter the passed in ver SV. See "upg_version" if you | |
2455 | want to upgrade the SV. | |
2456 | ||
2457 | SV* new_version(SV *ver) | |
2458 | ||
2459 | =for hackers | |
2460 | Found in file util.c | |
2461 | ||
2462 | =item scan_version | |
d8c40edc | 2463 | X<scan_version> |
f333445c JP |
2464 | |
2465 | Returns a pointer to the next character after the parsed | |
2466 | version string, as well as upgrading the passed in SV to | |
2467 | an RV. | |
2468 | ||
2469 | Function must be called with an already existing SV like | |
2470 | ||
137d6fc0 | 2471 | sv = newSV(0); |
8a0be661 | 2472 | s = scan_version(s, SV *sv, bool qv); |
f333445c JP |
2473 | |
2474 | Performs some preprocessing to the string to ensure that | |
2475 | it has the correct characteristics of a version. Flags the | |
2476 | object if it contains an underscore (which denotes this | |
8a0be661 | 2477 | is an alpha version). The boolean qv denotes that the version |
137d6fc0 JP |
2478 | should be interpreted as if it had multiple decimals, even if |
2479 | it doesn't. | |
f333445c | 2480 | |
9137345a | 2481 | const char* scan_version(const char *vstr, SV *sv, bool qv) |
f333445c JP |
2482 | |
2483 | =for hackers | |
2484 | Found in file util.c | |
2485 | ||
94bdecf9 | 2486 | =item strEQ |
d8c40edc | 2487 | X<strEQ> |
954c1994 | 2488 | |
94bdecf9 | 2489 | Test two strings to see if they are equal. Returns true or false. |
954c1994 | 2490 | |
94bdecf9 | 2491 | bool strEQ(char* s1, char* s2) |
954c1994 | 2492 | |
497711e7 | 2493 | =for hackers |
94bdecf9 | 2494 | Found in file handy.h |
497711e7 | 2495 | |
94bdecf9 | 2496 | =item strGE |
d8c40edc | 2497 | X<strGE> |
1c846c1f | 2498 | |
94bdecf9 JH |
2499 | Test two strings to see if the first, C<s1>, is greater than or equal to |
2500 | the second, C<s2>. Returns true or false. | |
1c846c1f | 2501 | |
94bdecf9 | 2502 | bool strGE(char* s1, char* s2) |
1c846c1f NIS |
2503 | |
2504 | =for hackers | |
94bdecf9 | 2505 | Found in file handy.h |
1c846c1f | 2506 | |
94bdecf9 | 2507 | =item strGT |
d8c40edc | 2508 | X<strGT> |
954c1994 | 2509 | |
94bdecf9 JH |
2510 | Test two strings to see if the first, C<s1>, is greater than the second, |
2511 | C<s2>. Returns true or false. | |
954c1994 | 2512 | |
94bdecf9 | 2513 | bool strGT(char* s1, char* s2) |
954c1994 | 2514 | |
497711e7 | 2515 | =for hackers |
94bdecf9 | 2516 | Found in file handy.h |
497711e7 | 2517 | |
94bdecf9 | 2518 | =item strLE |
d8c40edc | 2519 | X<strLE> |
954c1994 | 2520 | |
94bdecf9 JH |
2521 | Test two strings to see if the first, C<s1>, is less than or equal to the |
2522 | second, C<s2>. Returns true or false. | |
954c1994 | 2523 | |
94bdecf9 | 2524 | bool strLE(char* s1, char* s2) |
954c1994 | 2525 | |
497711e7 | 2526 | =for hackers |
94bdecf9 | 2527 | Found in file handy.h |
497711e7 | 2528 | |
94bdecf9 | 2529 | =item strLT |
d8c40edc | 2530 | X<strLT> |
1a3327fb | 2531 | |
94bdecf9 JH |
2532 | Test two strings to see if the first, C<s1>, is less than the second, |
2533 | C<s2>. Returns true or false. | |
1a3327fb | 2534 | |
94bdecf9 | 2535 | bool strLT(char* s1, char* s2) |
1a3327fb | 2536 | |
497711e7 | 2537 | =for hackers |
94bdecf9 | 2538 | Found in file handy.h |
497711e7 | 2539 | |
94bdecf9 | 2540 | =item strNE |
d8c40edc | 2541 | X<strNE> |
954c1994 | 2542 | |
94bdecf9 JH |
2543 | Test two strings to see if they are different. Returns true or |
2544 | false. | |
2545 | ||
2546 | bool strNE(char* s1, char* s2) | |
954c1994 | 2547 | |
497711e7 | 2548 | =for hackers |
94bdecf9 | 2549 | Found in file handy.h |
497711e7 | 2550 | |
94bdecf9 | 2551 | =item strnEQ |
d8c40edc | 2552 | X<strnEQ> |
954c1994 | 2553 | |
94bdecf9 JH |
2554 | Test two strings to see if they are equal. The C<len> parameter indicates |
2555 | the number of bytes to compare. Returns true or false. (A wrapper for | |
2556 | C<strncmp>). | |
2557 | ||
2558 | bool strnEQ(char* s1, char* s2, STRLEN len) | |
954c1994 | 2559 | |
497711e7 | 2560 | =for hackers |
94bdecf9 | 2561 | Found in file handy.h |
497711e7 | 2562 | |
94bdecf9 | 2563 | =item strnNE |
d8c40edc | 2564 | X<strnNE> |
954c1994 | 2565 | |
94bdecf9 JH |
2566 | Test two strings to see if they are different. The C<len> parameter |
2567 | indicates the number of bytes to compare. Returns true or false. (A | |
2568 | wrapper for C<strncmp>). | |
954c1994 | 2569 | |
94bdecf9 | 2570 | bool strnNE(char* s1, char* s2, STRLEN len) |
954c1994 | 2571 | |
497711e7 GS |
2572 | =for hackers |
2573 | Found in file handy.h | |
2574 | ||
f333445c | 2575 | =item sv_nosharing |
d8c40edc | 2576 | X<sv_nosharing> |
f333445c JP |
2577 | |
2578 | Dummy routine which "shares" an SV when there is no sharing module present. | |
9244d4ad RGS |
2579 | Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument. |
2580 | Exists to avoid test for a NULL function pointer and because it could | |
2581 | potentially warn under some level of strict-ness. | |
f333445c | 2582 | |
c48640ec | 2583 | void sv_nosharing(SV *sv) |
f333445c JP |
2584 | |
2585 | =for hackers | |
2586 | Found in file util.c | |
2587 | ||
f333445c | 2588 | =item upg_version |
d8c40edc | 2589 | X<upg_version> |
f333445c JP |
2590 | |
2591 | In-place upgrade of the supplied SV to a version object. | |
2592 | ||
ac0e6a2f | 2593 | SV *sv = upg_version(SV *sv, bool qv); |
f333445c | 2594 | |
ac0e6a2f RGS |
2595 | Returns a pointer to the upgraded SV. Set the boolean qv if you want |
2596 | to force this SV to be interpreted as an "extended" version. | |
f333445c | 2597 | |
ac0e6a2f | 2598 | SV* upg_version(SV *ver, bool qv) |
f333445c JP |
2599 | |
2600 | =for hackers | |
2601 | Found in file util.c | |
2602 | ||
2603 | =item vcmp | |
d8c40edc | 2604 | X<vcmp> |
f333445c JP |
2605 | |
2606 | Version object aware cmp. Both operands must already have been | |
2607 | converted into version objects. | |
2608 | ||
2609 | int vcmp(SV *lvs, SV *rvs) | |
2610 | ||
2611 | =for hackers | |
2612 | Found in file util.c | |
2613 | ||
b9381830 | 2614 | =item vnormal |
d8c40edc | 2615 | X<vnormal> |
b9381830 JP |
2616 | |
2617 | Accepts a version object and returns the normalized string | |
2618 | representation. Call like: | |
2619 | ||
2620 | sv = vnormal(rv); | |
2621 | ||
2622 | NOTE: you can pass either the object directly or the SV | |
2623 | contained within the RV. | |
2624 | ||
2625 | SV* vnormal(SV *vs) | |
2626 | ||
2627 | =for hackers | |
2628 | Found in file util.c | |
2629 | ||
f333445c | 2630 | =item vnumify |
d8c40edc | 2631 | X<vnumify> |
f333445c JP |
2632 | |
2633 | Accepts a version object and returns the normalized floating | |
2634 | point representation. Call like: | |
2635 | ||
2636 | sv = vnumify(rv); | |
2637 | ||
2638 | NOTE: you can pass either the object directly or the SV | |
2639 | contained within the RV. | |
2640 | ||
2641 | SV* vnumify(SV *vs) | |
2642 | ||
2643 | =for hackers | |
2644 | Found in file util.c | |
2645 | ||
2646 | =item vstringify | |
d8c40edc | 2647 | X<vstringify> |
f333445c | 2648 | |
b9381830 JP |
2649 | In order to maintain maximum compatibility with earlier versions |
2650 | of Perl, this function will return either the floating point | |
2651 | notation or the multiple dotted notation, depending on whether | |
2652 | the original version contained 1 or more dots, respectively | |
f333445c JP |
2653 | |
2654 | SV* vstringify(SV *vs) | |
2655 | ||
2656 | =for hackers | |
2657 | Found in file util.c | |
2658 | ||
e0218a61 | 2659 | =item vverify |
d8c40edc | 2660 | X<vverify> |
e0218a61 JP |
2661 | |
2662 | Validates that the SV contains a valid version object. | |
2663 | ||
2664 | bool vverify(SV *vobj); | |
2665 | ||
2666 | Note that it only confirms the bare minimum structure (so as not to get | |
2667 | confused by derived classes which may contain additional hash entries): | |
2668 | ||
2669 | bool vverify(SV *vs) | |
2670 | ||
2671 | =for hackers | |
2672 | Found in file util.c | |
2673 | ||
f4758303 | 2674 | |
94bdecf9 | 2675 | =back |
7207e29d | 2676 | |
47c9dd14 BB |
2677 | =head1 MRO Functions |
2678 | ||
2679 | =over 8 | |
2680 | ||
2681 | =item mro_get_linear_isa | |
2682 | X<mro_get_linear_isa> | |
2683 | ||
2684 | Returns either C<mro_get_linear_isa_c3> or | |
2685 | C<mro_get_linear_isa_dfs> for the given stash, | |
2686 | dependant upon which MRO is in effect | |
2687 | for that stash. The return value is a | |
2688 | read-only AV*. | |
2689 | ||
2690 | You are responsible for C<SvREFCNT_inc()> on the | |
2691 | return value if you plan to store it anywhere | |
2692 | semi-permanently (otherwise it might be deleted | |
2693 | out from under you the next time the cache is | |
2694 | invalidated). | |
2695 | ||
2696 | AV* mro_get_linear_isa(HV* stash) | |
2697 | ||
2698 | =for hackers | |
2699 | Found in file mro.c | |
2700 | ||
2701 | =item mro_get_linear_isa_c3 | |
2702 | X<mro_get_linear_isa_c3> | |
2703 | ||
2704 | Returns the C3 linearization of @ISA | |
2705 | the given stash. The return value is a read-only AV*. | |
2706 | C<level> should be 0 (it is used internally in this | |
2707 | function's recursion). | |
2708 | ||
2709 | You are responsible for C<SvREFCNT_inc()> on the | |
2710 | return value if you plan to store it anywhere | |
2711 | semi-permanently (otherwise it might be deleted | |
2712 | out from under you the next time the cache is | |
2713 | invalidated). | |
2714 | ||
2715 | AV* mro_get_linear_isa_c3(HV* stash, I32 level) | |
2716 | ||
2717 | =for hackers | |
2718 | Found in file mro.c | |
2719 | ||
2720 | =item mro_get_linear_isa_dfs | |
2721 | X<mro_get_linear_isa_dfs> | |
2722 | ||
2723 | Returns the Depth-First Search linearization of @ISA | |
2724 | the given stash. The return value is a read-only AV*. | |
2725 | C<level> should be 0 (it is used internally in this | |
2726 | function's recursion). | |
2727 | ||
2728 | You are responsible for C<SvREFCNT_inc()> on the | |
2729 | return value if you plan to store it anywhere | |
2730 | semi-permanently (otherwise it might be deleted | |
2731 | out from under you the next time the cache is | |
2732 | invalidated). | |
2733 | ||
2734 | AV* mro_get_linear_isa_dfs(HV* stash, I32 level) | |
2735 | ||
2736 | =for hackers | |
2737 | Found in file mro.c | |
2738 | ||
2739 | =item mro_method_changed_in | |
2740 | X<mro_method_changed_in> | |
2741 | ||
2742 | Invalidates method caching on any child classes | |
2743 | of the given stash, so that they might notice | |
2744 | the changes in this one. | |
2745 | ||
2746 | Ideally, all instances of C<PL_sub_generation++> in | |
dd69841b BB |
2747 | perl source outside of C<mro.c> should be |
2748 | replaced by calls to this. | |
2749 | ||
2750 | Perl automatically handles most of the common | |
2751 | ways a method might be redefined. However, there | |
2752 | are a few ways you could change a method in a stash | |
2753 | without the cache code noticing, in which case you | |
2754 | need to call this method afterwards: | |
2755 | ||
2756 | 1) Directly manipulating the stash HV entries from | |
2757 | XS code. | |
2758 | ||
2759 | 2) Assigning a reference to a readonly scalar | |
2760 | constant into a stash entry in order to create | |
2761 | a constant subroutine (like constant.pm | |
2762 | does). | |
2763 | ||
2764 | This same method is available from pure perl | |
2765 | via, C<mro::method_changed_in(classname)>. | |
47c9dd14 BB |
2766 | |
2767 | void mro_method_changed_in(HV* stash) | |
2768 | ||
2769 | =for hackers | |
2770 | Found in file mro.c | |
2771 | ||
2772 | ||
2773 | =back | |
2774 | ||
cd299c6e RGS |
2775 | =head1 Multicall Functions |
2776 | ||
2777 | =over 8 | |
2778 | ||
2779 | =item dMULTICALL | |
2780 | X<dMULTICALL> | |
2781 | ||
2782 | Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>. | |
2783 | ||
2784 | dMULTICALL; | |
2785 | ||
2786 | =for hackers | |
2787 | Found in file cop.h | |
2788 | ||
2789 | =item MULTICALL | |
2790 | X<MULTICALL> | |
2791 | ||
2792 | Make a lightweight callback. See L<perlcall/Lightweight Callbacks>. | |
2793 | ||
2794 | MULTICALL; | |
2795 | ||
2796 | =for hackers | |
2797 | Found in file cop.h | |
2798 | ||
2799 | =item POP_MULTICALL | |
2800 | X<POP_MULTICALL> | |
2801 | ||
2802 | Closing bracket for a lightweight callback. | |
2803 | See L<perlcall/Lightweight Callbacks>. | |
2804 | ||
2805 | POP_MULTICALL; | |
2806 | ||
2807 | =for hackers | |
2808 | Found in file cop.h | |
2809 | ||
2810 | =item PUSH_MULTICALL | |
2811 | X<PUSH_MULTICALL> | |
2812 | ||
2813 | Opening bracket for a lightweight callback. | |
2814 | See L<perlcall/Lightweight Callbacks>. | |
2815 | ||
2816 | PUSH_MULTICALL; | |
2817 | ||
2818 | =for hackers | |
2819 | Found in file cop.h | |
2820 | ||
2821 | ||
2822 | =back | |
2823 | ||
94bdecf9 | 2824 | =head1 Numeric functions |
7207e29d | 2825 | |
94bdecf9 | 2826 | =over 8 |
f4758303 | 2827 | |
94bdecf9 | 2828 | =item grok_bin |
d8c40edc | 2829 | X<grok_bin> |
f4758303 | 2830 | |
94bdecf9 JH |
2831 | converts a string representing a binary number to numeric form. |
2832 | ||
2833 | On entry I<start> and I<*len> give the string to scan, I<*flags> gives | |
2834 | conversion flags, and I<result> should be NULL or a pointer to an NV. | |
2835 | The scan stops at the end of the string, or the first invalid character. | |
7b667b5f MHM |
2836 | Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an |
2837 | invalid character will also trigger a warning. | |
2838 | On return I<*len> is set to the length of the scanned string, | |
2839 | and I<*flags> gives output flags. | |
94bdecf9 | 2840 | |
7fc63493 | 2841 | If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear, |
94bdecf9 JH |
2842 | and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin> |
2843 | returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags, | |
2844 | and writes the value to I<*result> (or the value is discarded if I<result> | |
2845 | is NULL). | |
2846 | ||
7b667b5f | 2847 | The binary number may optionally be prefixed with "0b" or "b" unless |
94bdecf9 JH |
2848 | C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If |
2849 | C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary | |
2850 | number may use '_' characters to separate digits. | |
2851 | ||
a3b680e6 | 2852 | UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result) |
f4758303 JP |
2853 | |
2854 | =for hackers | |
94bdecf9 | 2855 | Found in file numeric.c |
f4758303 | 2856 | |
94bdecf9 | 2857 | =item grok_hex |
d8c40edc | 2858 | X<grok_hex> |
954c1994 | 2859 | |
94bdecf9 JH |
2860 | converts a string representing a hex number to numeric form. |
2861 | ||
2862 | On entry I<start> and I<*len> give the string to scan, I<*flags> gives | |
2863 | conversion flags, and I<result> should be NULL or a pointer to an NV. | |
7b667b5f MHM |
2864 | The scan stops at the end of the string, or the first invalid character. |
2865 | Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an | |
2866 | invalid character will also trigger a warning. | |
2867 | On return I<*len> is set to the length of the scanned string, | |
2868 | and I<*flags> gives output flags. | |
94bdecf9 JH |
2869 | |
2870 | If the value is <= UV_MAX it is returned as a UV, the output flags are clear, | |
2871 | and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex> | |
2872 | returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags, | |
2873 | and writes the value to I<*result> (or the value is discarded if I<result> | |
2874 | is NULL). | |
2875 | ||
2876 | The hex number may optionally be prefixed with "0x" or "x" unless | |
2877 | C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If | |
2878 | C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex | |
2879 | number may use '_' characters to separate digits. | |
2880 | ||
a3b680e6 | 2881 | UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result) |
954c1994 | 2882 | |
497711e7 | 2883 | =for hackers |
94bdecf9 | 2884 | Found in file numeric.c |
497711e7 | 2885 | |
94bdecf9 | 2886 | =item grok_number |
d8c40edc | 2887 | X<grok_number> |
954c1994 | 2888 | |
94bdecf9 JH |
2889 | Recognise (or not) a number. The type of the number is returned |
2890 | (0 if unrecognised), otherwise it is a bit-ORed combination of | |
2891 | IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT, | |
2892 | IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h). | |
2893 | ||
2894 | If the value of the number can fit an in UV, it is returned in the *valuep | |
2895 | IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV | |
2896 | will never be set unless *valuep is valid, but *valuep may have been assigned | |
2897 | to during processing even though IS_NUMBER_IN_UV is not set on return. | |
2898 | If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when | |
2899 | valuep is non-NULL, but no actual assignment (or SEGV) will occur. | |
2900 | ||
2901 | IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were | |
2902 | seen (in which case *valuep gives the true value truncated to an integer), and | |
2903 | IS_NUMBER_NEG if the number is negative (in which case *valuep holds the | |
2904 | absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the | |
2905 | number is larger than a UV. | |
2906 | ||
2907 | int grok_number(const char *pv, STRLEN len, UV *valuep) | |
954c1994 | 2908 | |
497711e7 | 2909 | =for hackers |
94bdecf9 | 2910 | Found in file numeric.c |
497711e7 | 2911 | |
94bdecf9 | 2912 | =item grok_numeric_radix |
d8c40edc | 2913 | X<grok_numeric_radix> |
954c1994 | 2914 | |
94bdecf9 JH |
2915 | Scan and skip for a numeric decimal separator (radix). |
2916 | ||
2917 | bool grok_numeric_radix(const char **sp, const char *send) | |
954c1994 | 2918 | |
497711e7 | 2919 | =for hackers |
94bdecf9 | 2920 | Found in file numeric.c |
497711e7 | 2921 | |
94bdecf9 | 2922 | =item grok_oct |
d8c40edc | 2923 | X<grok_oct> |
954c1994 | 2924 | |
7b667b5f MHM |
2925 | converts a string representing an octal number to numeric form. |
2926 | ||
2927 | On entry I<start> and I<*len> give the string to scan, I<*flags> gives | |
2928 | conversion flags, and I<result> should be NULL or a pointer to an NV. | |
2929 | The scan stops at the end of the string, or the first invalid character. | |
2930 | Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an | |
2931 | invalid character will also trigger a warning. | |
2932 | On return I<*len> is set to the length of the scanned string, | |
2933 | and I<*flags> gives output flags. | |
2934 | ||
2935 | If the value is <= UV_MAX it is returned as a UV, the output flags are clear, | |
2936 | and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct> | |
2937 | returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags, | |
2938 | and writes the value to I<*result> (or the value is discarded if I<result> | |
2939 | is NULL). | |
2940 | ||
2941 | If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal | |
2942 | number may use '_' characters to separate digits. | |
94bdecf9 | 2943 | |
a3b680e6 | 2944 | UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result) |
954c1994 | 2945 | |
497711e7 | 2946 | =for hackers |
94bdecf9 | 2947 | Found in file numeric.c |
497711e7 | 2948 | |
ed140128 AD |
2949 | =item Perl_signbit |
2950 | X<Perl_signbit> | |
2951 | ||
2952 | Return a non-zero integer if the sign bit on an NV is set, and 0 if | |
2953 | it is not. | |
2954 | ||
2955 | If Configure detects this system has a signbit() that will work with | |
2956 | our NVs, then we just use it via the #define in perl.h. Otherwise, | |
2957 | fall back on this implementation. As a first pass, this gets everything | |
2958 | right except -0.0. Alas, catching -0.0 is the main use for this function, | |
2959 | so this is not too helpful yet. Still, at least we have the scaffolding | |
2960 | in place to support other systems, should that prove useful. | |
2961 | ||
2962 | ||
2963 | Configure notes: This function is called 'Perl_signbit' instead of a | |
2964 | plain 'signbit' because it is easy to imagine a system having a signbit() | |
2965 | function or macro that doesn't happen to work with our particular choice | |
2966 | of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect | |
2967 | the standard system headers to be happy. Also, this is a no-context | |
2968 | function (no pTHX_) because Perl_signbit() is usually re-#defined in | |
2969 | perl.h as a simple macro call to the system's signbit(). | |
2970 | Users should just always call Perl_signbit(). | |
2971 | ||
2972 | NOTE: this function is experimental and may change or be | |
2973 | removed without notice. | |
2974 | ||
2975 | int Perl_signbit(NV f) | |
2976 | ||
2977 | =for hackers | |
2978 | Found in file numeric.c | |
2979 | ||
94bdecf9 | 2980 | =item scan_bin |
d8c40edc | 2981 | X<scan_bin> |
954c1994 | 2982 | |
94bdecf9 JH |
2983 | For backwards compatibility. Use C<grok_bin> instead. |
2984 | ||
73d840c0 | 2985 | NV scan_bin(const char* start, STRLEN len, STRLEN* retlen) |
954c1994 | 2986 | |
497711e7 | 2987 | =for hackers |
94bdecf9 | 2988 | Found in file numeric.c |
497711e7 | 2989 | |
94bdecf9 | 2990 | =item scan_hex |
d8c40edc | 2991 | X<scan_hex> |
954c1994 | 2992 | |
94bdecf9 JH |
2993 | For backwards compatibility. Use C<grok_hex> instead. |
2994 | ||
73d840c0 | 2995 | NV scan_hex(const char* start, STRLEN len, STRLEN* retlen) |
954c1994 | 2996 | |
497711e7 | 2997 | =for hackers |
94bdecf9 | 2998 | Found in file numeric.c |
497711e7 | 2999 | |
94bdecf9 | 3000 | =item scan_oct |
d8c40edc | 3001 | X<scan_oct> |
954c1994 | 3002 | |
94bdecf9 | 3003 | For backwards compatibility. Use C<grok_oct> instead. |
954c1994 | 3004 | |
73d840c0 | 3005 | NV scan_oct(const char* start, STRLEN len, STRLEN* retlen) |
954c1994 | 3006 | |
497711e7 | 3007 | =for hackers |
94bdecf9 | 3008 | Found in file numeric.c |
497711e7 | 3009 | |
645c22ef | 3010 | |
94bdecf9 | 3011 | =back |
645c22ef | 3012 | |
94bdecf9 JH |
3013 | =head1 Optree Manipulation Functions |
3014 | ||
3015 | =over 8 | |
3016 | ||
3017 | =item cv_const_sv | |
d8c40edc | 3018 | X<cv_const_sv> |
94bdecf9 JH |
3019 | |
3020 | If C<cv> is a constant sub eligible for inlining. returns the constant | |
3021 | value returned by the sub. Otherwise, returns NULL. | |
3022 | ||
3023 | Constant subs can be created with C<newCONSTSUB> or as described in | |
3024 | L<perlsub/"Constant Functions">. | |
3025 | ||
3026 | SV* cv_const_sv(CV* cv) | |
645c22ef DM |
3027 | |
3028 | =for hackers | |
94bdecf9 | 3029 | Found in file op.c |
645c22ef | 3030 | |
94bdecf9 | 3031 | =item newCONSTSUB |
d8c40edc | 3032 | X<newCONSTSUB> |
954c1994 | 3033 | |
94bdecf9 JH |
3034 | Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is |
3035 | eligible for inlining at compile-time. | |
954c1994 | 3036 | |
e1ec3a88 | 3037 | CV* newCONSTSUB(HV* stash, const char* name, SV* sv) |
954c1994 | 3038 | |
497711e7 | 3039 | =for hackers |
94bdecf9 | 3040 | Found in file op.c |
497711e7 | 3041 | |
94bdecf9 | 3042 | =item newXS |
d8c40edc | 3043 | X<newXS> |
954c1994 | 3044 | |
77004dee NC |
3045 | Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be |
3046 | static storage, as it is used directly as CvFILE(), without a copy being made. | |
954c1994 | 3047 | |
94bdecf9 JH |
3048 | =for hackers |
3049 | Found in file op.c | |
3050 | ||
3051 | ||
3052 | =back | |
3053 | ||
dd2155a4 DM |
3054 | =head1 Pad Data Structures |
3055 | ||
3056 | =over 8 | |
3057 | ||
3058 | =item pad_sv | |
d8c40edc | 3059 | X<pad_sv> |
dd2155a4 DM |
3060 | |
3061 | Get the value at offset po in the current pad. | |
3062 | Use macro PAD_SV instead of calling this function directly. | |
3063 | ||
3064 | SV* pad_sv(PADOFFSET po) | |
3065 | ||
3066 | =for hackers | |
3067 | Found in file pad.c | |
3068 | ||
3069 | ||
3070 | =back | |
907b3e23 DM |
3071 | |
3072 | =head1 Per-Interpreter Variables | |
3073 | ||
3074 | =over 8 | |
3075 | ||
3076 | =item PL_modglobal | |
3077 | X<PL_modglobal> | |
3078 | ||
3079 | C<PL_modglobal> is a general purpose, interpreter global HV for use by | |
3080 | extensions that need to keep information on a per-interpreter basis. | |
3081 | In a pinch, it can also be used as a symbol table for extensions | |
3082 | to share data among each other. It is a good idea to use keys | |
3083 | prefixed by the package name of the extension that owns the data. | |
3084 | ||
3085 | HV* PL_modglobal | |
3086 | ||
3087 | =for hackers | |
3088 | Found in file intrpvar.h | |
3089 | ||
3090 | =item PL_na | |
3091 | X<PL_na> | |
3092 | ||
3093 | A convenience variable which is typically used with C<SvPV> when one | |
3094 | doesn't care about the length of the string. It is usually more efficient | |
3095 | to either declare a local variable and use that instead or to use the | |
3096 | C<SvPV_nolen> macro. | |
3097 | ||
3098 | STRLEN PL_na | |
3099 | ||
3100 | =for hackers | |
3101 | Found in file intrpvar.h | |
3102 | ||
3103 | =item PL_sv_no | |
3104 | X<PL_sv_no> | |
3105 | ||
3106 | This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as | |
3107 | C<&PL_sv_no>. | |
3108 | ||
3109 | SV PL_sv_no | |
3110 | ||
3111 | =for hackers | |
3112 | Found in file intrpvar.h | |
3113 | ||
3114 | =item PL_sv_undef | |
3115 | X<PL_sv_undef> | |
3116 | ||
3117 | This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>. | |
3118 | ||
3119 | SV PL_sv_undef | |
3120 | ||
3121 | =for hackers | |
3122 | Found in file intrpvar.h | |
3123 | ||
3124 | =item PL_sv_yes | |
3125 | X<PL_sv_yes> | |
3126 | ||
3127 | This is the C<true> SV. See C<PL_sv_no>. Always refer to this as | |
3128 | C<&PL_sv_yes>. | |
3129 | ||
3130 | SV PL_sv_yes | |
3131 | ||
3132 | =for hackers | |
3133 | Found in file intrpvar.h | |
3134 | ||
3135 | ||
3136 | =back | |
dd2155a4 | 3137 | |
59887a99 MHM |
3138 | =head1 Simple Exception Handling Macros |
3139 | ||
3140 | =over 8 | |
3141 | ||
3142 | =item dXCPT | |
d8c40edc | 3143 | X<dXCPT> |
59887a99 | 3144 | |
2dfe1b17 | 3145 | Set up necessary local variables for exception handling. |
59887a99 MHM |
3146 | See L<perlguts/"Exception Handling">. |
3147 | ||
3148 | dXCPT; | |
3149 | ||
3150 | =for hackers | |
3151 | Found in file XSUB.h | |
3152 | ||
3153 | =item XCPT_CATCH | |
d8c40edc | 3154 | X<XCPT_CATCH> |
59887a99 MHM |
3155 | |
3156 | Introduces a catch block. See L<perlguts/"Exception Handling">. | |
3157 | ||
3158 | =for hackers | |
3159 | Found in file XSUB.h | |
3160 | ||
3161 | =item XCPT_RETHROW | |
d8c40edc | 3162 | X<XCPT_RETHROW> |
59887a99 MHM |
3163 | |
3164 | Rethrows a previously caught exception. See L<perlguts/"Exception Handling">. | |
3165 | ||
3166 | XCPT_RETHROW; | |
3167 | ||
3168 | =for hackers | |
3169 | Found in file XSUB.h | |
3170 | ||
3171 | =item XCPT_TRY_END | |
d8c40edc | 3172 | X<XCPT_TRY_END> |
59887a99 MHM |
3173 | |
3174 | Ends a try block. See L<perlguts/"Exception Handling">. | |
3175 | ||
3176 | =for hackers | |
3177 | Found in file XSUB.h | |
3178 | ||
3179 | =item XCPT_TRY_START | |
d8c40edc | 3180 | X<XCPT_TRY_START> |
59887a99 MHM |
3181 | |
3182 | Starts a try block. See L<perlguts/"Exception Handling">. | |
3183 | ||
3184 | =for hackers | |
3185 | Found in file XSUB.h | |
3186 | ||
3187 | ||
3188 | =back | |
3189 | ||
94bdecf9 JH |
3190 | =head1 Stack Manipulation Macros |
3191 | ||
3192 | =over 8 | |
3193 | ||
3194 | =item dMARK | |
d8c40edc | 3195 | X<dMARK> |
954c1994 | 3196 | |
94bdecf9 JH |
3197 | Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and |
3198 | C<dORIGMARK>. | |
954c1994 | 3199 | |
94bdecf9 | 3200 | dMARK; |
954c1994 | 3201 | |
497711e7 | 3202 | =for hackers |
94bdecf9 | 3203 | Found in file pp.h |
497711e7 | 3204 | |
94bdecf9 | 3205 | =item dORIGMARK |
d8c40edc | 3206 | X<dORIGMARK> |
954c1994 | 3207 | |
94bdecf9 | 3208 | Saves the original stack mark for the XSUB. See C<ORIGMARK>. |
954c1994 | 3209 | |
94bdecf9 | 3210 | dORIGMARK; |
954c1994 | 3211 | |
497711e7 | 3212 | =for hackers |
94bdecf9 | 3213 | Found in file pp.h |
497711e7 | 3214 | |
94bdecf9 | 3215 | =item dSP |
d8c40edc | 3216 | X<dSP> |
954c1994 | 3217 | |
94bdecf9 JH |
3218 | Declares a local copy of perl's stack pointer for the XSUB, available via |
3219 | the C<SP> macro. See C<SP>. | |
954c1994 | 3220 | |
94bdecf9 | 3221 | dSP; |
954c1994 | 3222 | |
497711e7 | 3223 | =for hackers |
94bdecf9 | 3224 | Found in file pp.h |
497711e7 | 3225 | |
94bdecf9 | 3226 | =item EXTEND |
d8c40edc | 3227 | X<EXTEND> |
954c1994 | 3228 | |
94bdecf9 JH |
3229 | Used to extend the argument stack for an XSUB's return values. Once |
3230 | used, guarantees that there is room for at least C<nitems> to be pushed | |
3231 | onto the stack. | |
954c1994 | 3232 | |
94bdecf9 | 3233 | void EXTEND(SP, int nitems) |
954c1994 | 3234 | |
497711e7 | 3235 | =for hackers |
94bdecf9 | 3236 | Found in file pp.h |
954c1994 | 3237 | |
94bdecf9 | 3238 | =item MARK |
d8c40edc | 3239 | X<MARK> |
954c1994 | 3240 | |
94bdecf9 | 3241 | Stack marker variable for the XSUB. See C<dMARK>. |
954c1994 | 3242 | |
497711e7 | 3243 | =for hackers |
94bdecf9 | 3244 | Found in file pp.h |
954c1994 | 3245 | |
d82b684c | 3246 | =item mPUSHi |
d8c40edc | 3247 | X<mPUSHi> |
d82b684c SH |
3248 | |
3249 | Push an integer onto the stack. The stack must have room for this element. | |
de4f2208 RGS |
3250 | Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> |
3251 | and C<XPUSHi>. | |
d82b684c SH |
3252 | |
3253 | void mPUSHi(IV iv) | |
3254 | ||
3255 | =for hackers | |
3256 | Found in file pp.h | |
3257 | ||
3258 | =item mPUSHn | |
d8c40edc | 3259 | X<mPUSHn> |
d82b684c SH |
3260 | |
3261 | Push a double onto the stack. The stack must have room for this element. | |
de4f2208 RGS |
3262 | Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> |
3263 | and C<XPUSHn>. | |
d82b684c SH |
3264 | |
3265 | void mPUSHn(NV nv) | |
3266 | ||
3267 | =for hackers | |
3268 | Found in file pp.h | |
3269 | ||
3270 | =item mPUSHp | |
d8c40edc | 3271 | X<mPUSHp> |
d82b684c SH |
3272 | |
3273 | Push a string onto the stack. The stack must have room for this element. | |
de4f2208 RGS |
3274 | The C<len> indicates the length of the string. Handles 'set' magic. Does |
3275 | not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>. | |
d82b684c SH |
3276 | |
3277 | void mPUSHp(char* str, STRLEN len) | |
3278 | ||
3279 | =for hackers | |
3280 | Found in file pp.h | |
3281 | ||
3282 | =item mPUSHu | |
d8c40edc | 3283 | X<mPUSHu> |
d82b684c SH |
3284 | |
3285 | Push an unsigned integer onto the stack. The stack must have room for this | |
de4f2208 RGS |
3286 | element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>, |
3287 | C<mXPUSHu> and C<XPUSHu>. | |
d82b684c SH |
3288 | |
3289 | void mPUSHu(UV uv) | |
3290 | ||
3291 | =for hackers | |
3292 | Found in file pp.h | |
3293 | ||
3294 | =item mXPUSHi | |
d8c40edc | 3295 | X<mXPUSHi> |
d82b684c | 3296 | |
de4f2208 RGS |
3297 | Push an integer onto the stack, extending the stack if necessary. Handles |
3298 | 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and | |
3299 | C<PUSHi>. | |
d82b684c SH |
3300 | |
3301 | void mXPUSHi(IV iv) | |
3302 | ||
3303 | =for hackers | |
3304 | Found in file pp.h | |
3305 | ||
3306 | =item mXPUSHn | |
d8c40edc | 3307 | X<mXPUSHn> |
d82b684c | 3308 | |
de4f2208 RGS |
3309 | Push a double onto the stack, extending the stack if necessary. Handles |
3310 | 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and | |
3311 | C<PUSHn>. | |
d82b684c SH |
3312 | |
3313 | void mXPUSHn(NV nv) | |
3314 | ||
3315 | =for hackers | |
3316 | Found in file pp.h | |
3317 | ||
3318 | =item mXPUSHp | |
d8c40edc | 3319 | X<mXPUSHp> |
d82b684c SH |
3320 | |
3321 | Push a string onto the stack, extending the stack if necessary. The C<len> | |
de4f2208 RGS |
3322 | indicates the length of the string. Handles 'set' magic. Does not use |
3323 | C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>. | |
d82b684c SH |
3324 | |
3325 | void mXPUSHp(char* str, STRLEN len) | |
3326 | ||
3327 | =for hackers | |
3328 | Found in file pp.h | |
3329 | ||
3330 | =item mXPUSHu | |
d8c40edc | 3331 | X<mXPUSHu> |
d82b684c SH |
3332 | |
3333 | Push an unsigned integer onto the stack, extending the stack if necessary. | |
de4f2208 RGS |
3334 | Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> |
3335 | and C<PUSHu>. | |
d82b684c SH |
3336 | |
3337 | void mXPUSHu(UV uv) | |
3338 | ||
3339 | =for hackers | |
3340 | Found in file pp.h | |
3341 | ||
94bdecf9 | 3342 | =item ORIGMARK |
d8c40edc | 3343 | X<ORIGMARK> |
954c1994 | 3344 | |
94bdecf9 | 3345 | The original stack mark for the XSUB. See C<dORIGMARK>. |
954c1994 | 3346 | |
497711e7 | 3347 | =for hackers |
94bdecf9 | 3348 | Found in file pp.h |
497711e7 | 3349 | |
954c1994 | 3350 | =item POPi |
d8c40edc | 3351 | X<POPi> |
954c1994 GS |
3352 | |
3353 | Pops an integer off the stack. | |
3354 | ||
3355 | IV POPi | |
3356 | ||
497711e7 GS |
3357 | =for hackers |
3358 | Found in file pp.h | |
3359 | ||
954c1994 | 3360 | =item POPl |
d8c40edc | 3361 | X<POPl> |
954c1994 GS |
3362 | |
3363 | Pops a long off the stack. | |
3364 | ||
3365 | long POPl | |
3366 | ||
497711e7 GS |
3367 | =for hackers |
3368 | Found in file pp.h | |
3369 | ||
954c1994 | 3370 | =item POPn |
d8c40edc | 3371 | X<POPn> |
954c1994 GS |
3372 | |
3373 | Pops a double off the stack. | |
3374 | ||
3375 | NV POPn | |
3376 | ||
497711e7 GS |
3377 | =for hackers |
3378 | Found in file pp.h | |
3379 | ||
954c1994 | 3380 | =item POPp |
d8c40edc | 3381 | X<POPp> |
954c1994 | 3382 | |
184499a4 | 3383 | Pops a string off the stack. Deprecated. New code should use POPpx. |
954c1994 GS |
3384 | |
3385 | char* POPp | |
3386 | ||
497711e7 GS |
3387 | =for hackers |
3388 | Found in file pp.h | |
3389 | ||
fa519979 | 3390 | =item POPpbytex |
d8c40edc | 3391 | X<POPpbytex> |
fa519979 JH |
3392 | |
3393 | Pops a string off the stack which must consist of bytes i.e. characters < 256. | |
fa519979 JH |
3394 | |
3395 | char* POPpbytex | |
3396 | ||
3397 | =for hackers | |
3398 | Found in file pp.h | |
3399 | ||
3400 | =item POPpx | |
d8c40edc | 3401 | X<POPpx> |
fa519979 JH |
3402 | |
3403 | Pops a string off the stack. | |
fa519979 JH |
3404 | |
3405 | char* POPpx | |
3406 | ||
3407 | =for hackers | |
3408 | Found in file pp.h | |
3409 | ||
954c1994 | 3410 | =item POPs |
d8c40edc | 3411 | X<POPs> |
954c1994 GS |
3412 | |
3413 | Pops an SV off the stack. | |
3414 | ||
3415 | SV* POPs | |
3416 | ||
497711e7 GS |
3417 | =for hackers |
3418 | Found in file pp.h | |
3419 | ||
954c1994 | 3420 | =item PUSHi |
d8c40edc | 3421 | X<PUSHi> |
954c1994 GS |
3422 | |
3423 | Push an integer onto the stack. The stack must have room for this element. | |
d82b684c SH |
3424 | Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be |
3425 | called to declare it. Do not call multiple C<TARG>-oriented macros to | |
3426 | return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and | |
3427 | C<mXPUSHi>. | |
954c1994 GS |
3428 | |
3429 | void PUSHi(IV iv) | |
3430 | ||
497711e7 GS |
3431 | =for hackers |
3432 | Found in file pp.h | |
3433 | ||
954c1994 | 3434 | =item PUSHMARK |
d8c40edc | 3435 | X<PUSHMARK> |
954c1994 GS |
3436 | |
3437 | Opening bracket for arguments on a callback. See C<PUTBACK> and | |
3438 | L<perlcall>. | |
3439 | ||
c578083c | 3440 | void PUSHMARK(SP) |
954c1994 | 3441 | |
497711e7 GS |
3442 | =for hackers |
3443 | Found in file pp.h | |
3444 | ||
d82b684c | 3445 | =item PUSHmortal |
d8c40edc | 3446 | X<PUSHmortal> |
d82b684c SH |
3447 | |
3448 | Push a new mortal SV onto the stack. The stack must have room for this | |
3449 | element. Does not handle 'set' magic. Does not use C<TARG>. See also | |
3450 | C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>. | |
3451 | ||
3452 | void PUSHmortal() | |
3453 | ||
3454 | =for hackers | |
3455 | Found in file pp.h | |
3456 | ||
954c1994 | 3457 | =item PUSHn |
d8c40edc | 3458 | X<PUSHn> |
954c1994 GS |
3459 | |
3460 | Push a double onto the stack. The stack must have room for this element. | |
d82b684c SH |
3461 | Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be |
3462 | called to declare it. Do not call multiple C<TARG>-oriented macros to | |
3463 | return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and | |
3464 | C<mXPUSHn>. | |
954c1994 GS |
3465 | |
3466 | void PUSHn(NV nv) | |
3467 | ||
497711e7 GS |
3468 | =for hackers |
3469 | Found in file pp.h | |
3470 | ||
954c1994 | 3471 | =item PUSHp |
d8c40edc | 3472 | X<PUSHp> |
954c1994 GS |
3473 | |
3474 | Push a string onto the stack. The stack must have room for this element. | |
d82b684c SH |
3475 | The C<len> indicates the length of the string. Handles 'set' magic. Uses |
3476 | C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not | |
3477 | call multiple C<TARG>-oriented macros to return lists from XSUB's - see | |
3478 | C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>. | |
954c1994 GS |
3479 | |
3480 | void PUSHp(char* str, STRLEN len) | |
3481 | ||
497711e7 GS |
3482 | =for hackers |
3483 | Found in file pp.h | |
3484 | ||
954c1994 | 3485 | =item PUSHs |
d8c40edc | 3486 | X<PUSHs> |
954c1994 | 3487 | |
1c846c1f | 3488 | Push an SV onto the stack. The stack must have room for this element. |
d82b684c SH |
3489 | Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>, |
3490 | C<XPUSHs> and C<XPUSHmortal>. | |
954c1994 GS |
3491 | |
3492 | void PUSHs(SV* sv) | |
3493 | ||
497711e7 GS |
3494 | =for hackers |
3495 | Found in file pp.h | |
3496 | ||
954c1994 | 3497 | =item PUSHu |
d8c40edc | 3498 | X<PUSHu> |
954c1994 GS |
3499 | |
3500 | Push an unsigned integer onto the stack. The stack must have room for this | |
d82b684c SH |
3501 | element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> |
3502 | should be called to declare it. Do not call multiple C<TARG>-oriented | |
3503 | macros to return lists from XSUB's - see C<mPUSHu> instead. See also | |
3504 | C<XPUSHu> and C<mXPUSHu>. | |
954c1994 GS |
3505 | |
3506 | void PUSHu(UV uv) | |
3507 | ||
497711e7 GS |
3508 | =for hackers |
3509 | Found in file pp.h | |
3510 | ||
954c1994 | 3511 | =item PUTBACK |
d8c40edc | 3512 | X<PUTBACK> |
954c1994 GS |
3513 | |
3514 | Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>. | |
3515 | See C<PUSHMARK> and L<perlcall> for other uses. | |
3516 | ||
3517 | PUTBACK; | |
3518 | ||
497711e7 GS |
3519 | =for hackers |
3520 | Found in file pp.h | |
3521 | ||
94bdecf9 | 3522 | =item SP |
d8c40edc | 3523 | X<SP> |
d2cc3551 | 3524 | |
94bdecf9 JH |
3525 | Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and |
3526 | C<SPAGAIN>. | |
d2cc3551 | 3527 | |
94bdecf9 JH |
3528 | =for hackers |
3529 | Found in file pp.h | |
3530 | ||
3531 | =item SPAGAIN | |
d8c40edc | 3532 | X<SPAGAIN> |
94bdecf9 JH |
3533 | |
3534 | Refetch the stack pointer. Used after a callback. See L<perlcall>. | |
3535 | ||
3536 | SPAGAIN; | |
d2cc3551 JH |
3537 | |
3538 | =for hackers | |
94bdecf9 | 3539 | Found in file pp.h |
d2cc3551 | 3540 | |
94bdecf9 | 3541 | =item XPUSHi |
d8c40edc | 3542 | X<XPUSHi> |
954c1994 | 3543 | |
94bdecf9 | 3544 | Push an integer onto the stack, extending the stack if necessary. Handles |
d82b684c SH |
3545 | 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to |
3546 | declare it. Do not call multiple C<TARG>-oriented macros to return lists | |
3547 | from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>. | |
954c1994 | 3548 | |
94bdecf9 | 3549 | void XPUSHi(IV iv) |
954c1994 | 3550 | |
497711e7 | 3551 | =for hackers |
94bdecf9 | 3552 | Found in file pp.h |
497711e7 | 3553 | |
d82b684c | 3554 | =item XPUSHmortal |
d8c40edc | 3555 | X<XPUSHmortal> |
d82b684c SH |
3556 | |
3557 | Push a new mortal SV onto the stack, extending the stack if necessary. Does | |
3558 | not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>, | |
3559 | C<PUSHmortal> and C<PUSHs>. | |
3560 | ||
3561 | void XPUSHmortal() | |
3562 | ||
3563 | =for hackers | |
3564 | Found in file pp.h | |
3565 | ||
94bdecf9 | 3566 | =item XPUSHn |
d8c40edc | 3567 | X<XPUSHn> |
954c1994 | 3568 | |
94bdecf9 | 3569 | Push a double onto the stack, extending the stack if necessary. Handles |
d82b684c SH |
3570 | 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to |
3571 | declare it. Do not call multiple C<TARG>-oriented macros to return lists | |
3572 | from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>. | |
954c1994 | 3573 | |
94bdecf9 | 3574 | void XPUSHn(NV nv) |
954c1994 | 3575 | |
497711e7 | 3576 | =for hackers |
94bdecf9 | 3577 | Found in file pp.h |
497711e7 | 3578 | |
94bdecf9 | 3579 | =item XPUSHp |
d8c40edc | 3580 | X<XPUSHp> |
954c1994 | 3581 | |
94bdecf9 | 3582 | Push a string onto the stack, extending the stack if necessary. The C<len> |
d82b684c SH |
3583 | indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so |
3584 | C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call | |
3585 | multiple C<TARG>-oriented macros to return lists from XSUB's - see | |
3586 | C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>. | |
954c1994 | 3587 | |
94bdecf9 | 3588 | void XPUSHp(char* str, STRLEN len) |
954c1994 | 3589 | |
94bdecf9 JH |
3590 | =for hackers |
3591 | Found in file pp.h | |
3592 | ||
3593 | =item XPUSHs | |
d8c40edc | 3594 | X<XPUSHs> |
94bdecf9 JH |
3595 | |
3596 | Push an SV onto the stack, extending the stack if necessary. Does not | |
d82b684c SH |
3597 | handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>, |
3598 | C<PUSHs> and C<PUSHmortal>. | |
94bdecf9 JH |
3599 | |
3600 | void XPUSHs(SV* sv) | |
954c1994 | 3601 | |
497711e7 | 3602 | =for hackers |
94bdecf9 | 3603 | Found in file pp.h |
497711e7 | 3604 | |
94bdecf9 | 3605 | =item XPUSHu |
d8c40edc | 3606 | X<XPUSHu> |
954c1994 | 3607 | |
94bdecf9 | 3608 | Push an unsigned integer onto the stack, extending the stack if necessary. |
d82b684c SH |
3609 | Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be |
3610 | called to declare it. Do not call multiple C<TARG>-oriented macros to | |
3611 | return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and | |
3612 | C<mPUSHu>. | |
954c1994 | 3613 | |
94bdecf9 JH |
3614 | void XPUSHu(UV uv) |
3615 | ||
3616 | =for hackers | |
3617 | Found in file pp.h | |
3618 | ||
3619 | =item XSRETURN | |
d8c40edc | 3620 | X<XSRETURN> |
94bdecf9 JH |
3621 | |
3622 | Return from XSUB, indicating number of items on the stack. This is usually | |
3623 | handled by C<xsubpp>. | |
3624 | ||
3625 | void XSRETURN(int nitems) | |
954c1994 | 3626 | |
497711e7 GS |
3627 | =for hackers |
3628 | Found in file XSUB.h | |
3629 | ||
e509e693 | 3630 | =item XSRETURN_EMPTY |
d8c40edc | 3631 | X<XSRETURN_EMPTY> |
e509e693 SH |
3632 | |
3633 | Return an empty list from an XSUB immediately. | |
3634 | ||
3635 | XSRETURN_EMPTY; | |
3636 | ||
3637 | =for hackers | |
3638 | Found in file XSUB.h | |
3639 | ||
94bdecf9 | 3640 | =item XSRETURN_IV |
d8c40edc | 3641 | X<XSRETURN_IV> |
954c1994 | 3642 | |
94bdecf9 | 3643 | Return an integer from an XSUB immediately. Uses C<XST_mIV>. |
954c1994 | 3644 | |
94bdecf9 | 3645 | void XSRETURN_IV(IV iv) |
954c1994 | 3646 | |
497711e7 | 3647 | =for hackers |
94bdecf9 | 3648 | Found in file XSUB.h |
497711e7 | 3649 | |
94bdecf9 | 3650 | =item XSRETURN_NO |
d8c40edc | 3651 | X<XSRETURN_NO> |
954c1994 | 3652 | |
94bdecf9 | 3653 | Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>. |
954c1994 | 3654 | |
94bdecf9 | 3655 | XSRETURN_NO; |
954c1994 | 3656 | |
497711e7 | 3657 | =for hackers |
94bdecf9 | 3658 | Found in file XSUB.h |
497711e7 | 3659 | |
94bdecf9 | 3660 | =item XSRETURN_NV |
d8c40edc | 3661 | X<XSRETURN_NV> |
954c1994 | 3662 | |
94bdecf9 | 3663 | Return a double from an XSUB immediately. Uses C<XST_mNV>. |
954c1994 | 3664 | |
94bdecf9 | 3665 | void XSRETURN_NV(NV nv) |
954c1994 | 3666 | |
497711e7 | 3667 | =for hackers |
94bdecf9 JH |
3668 | Found in file XSUB.h |
3669 | ||
3670 | =item XSRETURN_PV | |
d8c40edc | 3671 | X<XSRETURN_PV> |
94bdecf9 JH |
3672 | |
3673 | Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>. | |
3674 | ||
3675 | void XSRETURN_PV(char* str) | |
3676 | ||
3677 | =for hackers | |
3678 | Found in file XSUB.h | |
3679 | ||
3680 | =item XSRETURN_UNDEF | |
d8c40edc | 3681 | X<XSRETURN_UNDEF> |
94bdecf9 JH |
3682 | |
3683 | Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>. | |
3684 | ||
3685 | XSRETURN_UNDEF; | |
3686 | ||
3687 | =for hackers | |
3688 | Found in file XSUB.h | |
3689 | ||
0ee80f49 | 3690 | =item XSRETURN_UV |
d8c40edc | 3691 | X<XSRETURN_UV> |
0ee80f49 JH |
3692 | |
3693 | Return an integer from an XSUB immediately. Uses C<XST_mUV>. | |
3694 | ||
3695 | void XSRETURN_UV(IV uv) | |
3696 | ||
3697 | =for hackers | |
3698 | Found in file XSUB.h | |
3699 | ||
94bdecf9 | 3700 | =item XSRETURN_YES |
d8c40edc | 3701 | X<XSRETURN_YES> |
94bdecf9 JH |
3702 | |
3703 | Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>. | |
3704 | ||
3705 | XSRETURN_YES; | |
3706 | ||
3707 | =for hackers | |
3708 | Found in file XSUB.h | |
3709 | ||
3710 | =item XST_mIV | |
d8c40edc | 3711 | X<XST_mIV> |
94bdecf9 JH |
3712 | |
3713 | Place an integer into the specified position C<pos> on the stack. The | |
3714 | value is stored in a new mortal SV. | |
3715 | ||
3716 | void XST_mIV(int pos, IV iv) | |
3717 | ||
3718 | =for hackers | |
3719 | Found in file XSUB.h | |
3720 | ||
3721 | =item XST_mNO | |
d8c40edc | 3722 | X<XST_mNO> |
94bdecf9 JH |
3723 | |
3724 | Place C<&PL_sv_no> into the specified position C<pos> on the | |
3725 | stack. | |
3726 | ||
3727 | void XST_mNO(int pos) | |
3728 | ||
3729 | =for hackers | |
3730 | Found in file XSUB.h | |
3731 | ||
3732 | =item XST_mNV | |
d8c40edc | 3733 | X<XST_mNV> |
94bdecf9 JH |
3734 | |
3735 | Place a double into the specified position C<pos> on the stack. The value | |
3736 | is stored in a new mortal SV. | |
3737 | ||
3738 | void XST_mNV(int pos, NV nv) | |
3739 | ||
3740 | =for hackers | |
3741 | Found in file XSUB.h | |
3742 | ||
3743 | =item XST_mPV | |
d8c40edc | 3744 | X<XST_mPV> |
94bdecf9 JH |
3745 | |
3746 | Place a copy of a string into the specified position C<pos> on the stack. | |
3747 | The value is stored in a new mortal SV. | |
3748 | ||
3749 | void XST_mPV(int pos, char* str) | |
3750 | ||
3751 | =for hackers | |
3752 | Found in file XSUB.h | |
3753 | ||
3754 | =item XST_mUNDEF | |
d8c40edc | 3755 | X<XST_mUNDEF> |
94bdecf9 JH |
3756 | |
3757 | Place C<&PL_sv_undef> into the specified position C<pos> on the | |
3758 | stack. | |
3759 | ||
3760 | void XST_mUNDEF(int pos) | |
3761 | ||
3762 | =for hackers | |
3763 | Found in file XSUB.h | |
3764 | ||
3765 | =item XST_mYES | |
d8c40edc | 3766 | X<XST_mYES> |
94bdecf9 JH |
3767 | |
3768 | Place C<&PL_sv_yes> into the specified position C<pos> on the | |
3769 | stack. | |
3770 | ||
3771 | void XST_mYES(int pos) | |
3772 | ||
3773 | =for hackers | |
3774 | Found in file XSUB.h | |
3775 | ||
3776 | ||
3777 | =back | |
3778 | ||
3779 | =head1 SV Flags | |
497711e7 | 3780 | |
94bdecf9 | 3781 | =over 8 |
954c1994 | 3782 | |
94bdecf9 | 3783 | =item svtype |
d8c40edc | 3784 | X<svtype> |
954c1994 | 3785 | |
94bdecf9 JH |
3786 | An enum of flags for Perl types. These are found in the file B<sv.h> |
3787 | in the C<svtype> enum. Test these flags with the C<SvTYPE> macro. | |
954c1994 | 3788 | |
497711e7 | 3789 | =for hackers |
94bdecf9 | 3790 | Found in file sv.h |
6e9d1081 | 3791 | |
94bdecf9 | 3792 | =item SVt_IV |
d8c40edc | 3793 | X<SVt_IV> |
6e9d1081 | 3794 | |
94bdecf9 | 3795 | Integer type flag for scalars. See C<svtype>. |
6e9d1081 NC |
3796 | |
3797 | =for hackers | |
94bdecf9 | 3798 | Found in file sv.h |
6e9d1081 | 3799 | |
94bdecf9 | 3800 | =item SVt_NV |
d8c40edc | 3801 | X<SVt_NV> |
6e9d1081 | 3802 | |
94bdecf9 | 3803 | Double type flag for scalars. See C<svtype>. |
6e9d1081 NC |
3804 | |
3805 | =for hackers | |
94bdecf9 | 3806 | Found in file sv.h |
6e9d1081 | 3807 | |
94bdecf9 | 3808 | =item SVt_PV |
d8c40edc | 3809 | X<SVt_PV> |
6e9d1081 | 3810 | |
94bdecf9 | 3811 | Pointer type flag for scalars. See C<svtype>. |
6e9d1081 NC |
3812 | |
3813 | =for hackers | |
94bdecf9 | 3814 | Found in file sv.h |
cd1ee231 | 3815 | |
94bdecf9 | 3816 | =item SVt_PVAV |
d8c40edc | 3817 | X<SVt_PVAV> |
cd1ee231 | 3818 | |
94bdecf9 | 3819 | Type flag for arrays. See C<svtype>. |
cd1ee231 JH |
3820 | |
3821 | =for hackers | |
94bdecf9 | 3822 | Found in file sv.h |
cd1ee231 | 3823 | |
94bdecf9 | 3824 | =item SVt_PVCV |
d8c40edc | 3825 | X<SVt_PVCV> |
cd1ee231 | 3826 | |
94bdecf9 | 3827 | Type flag for code refs. See C<svtype>. |
cd1ee231 JH |
3828 | |
3829 | =for hackers | |
94bdecf9 | 3830 | Found in file sv.h |
cd1ee231 | 3831 | |
94bdecf9 | 3832 | =item SVt_PVHV |
d8c40edc | 3833 | X<SVt_PVHV> |
cd1ee231 | 3834 | |
94bdecf9 | 3835 | Type flag for hashes. See C<svtype>. |
cd1ee231 JH |
3836 | |
3837 | =for hackers | |
94bdecf9 | 3838 | Found in file sv.h |
cd1ee231 | 3839 | |
94bdecf9 | 3840 | =item SVt_PVMG |
d8c40edc | 3841 | X<SVt_PVMG> |
cd1ee231 | 3842 | |
94bdecf9 | 3843 | Type flag for blessed scalars. See C<svtype>. |
cd1ee231 JH |
3844 | |
3845 | =for hackers | |
94bdecf9 | 3846 | Found in file sv.h |
cd1ee231 | 3847 | |
cd1ee231 | 3848 | |
94bdecf9 | 3849 | =back |
cd1ee231 | 3850 | |
94bdecf9 | 3851 | =head1 SV Manipulation Functions |
cd1ee231 | 3852 | |
94bdecf9 | 3853 | =over 8 |
cd1ee231 | 3854 | |
94bdecf9 | 3855 | =item get_sv |
d8c40edc | 3856 | X<get_sv> |
cd1ee231 | 3857 | |
94bdecf9 JH |
3858 | Returns the SV of the specified Perl scalar. If C<create> is set and the |
3859 | Perl variable does not exist then it will be created. If C<create> is not | |
3860 | set and the variable does not exist then NULL is returned. | |
3861 | ||
3862 | NOTE: the perl_ form of this function is deprecated. | |
3863 | ||
3864 | SV* get_sv(const char* name, I32 create) | |
cd1ee231 JH |
3865 | |
3866 | =for hackers | |
94bdecf9 | 3867 | Found in file perl.c |
cd1ee231 | 3868 | |
94bdecf9 | 3869 | =item newRV_inc |
d8c40edc | 3870 | X<newRV_inc> |
2a5a0c38 | 3871 | |
94bdecf9 JH |
3872 | Creates an RV wrapper for an SV. The reference count for the original SV is |
3873 | incremented. | |
2a5a0c38 | 3874 | |
94bdecf9 | 3875 | SV* newRV_inc(SV* sv) |
2a5a0c38 JH |
3876 | |
3877 | =for hackers | |
94bdecf9 | 3878 | Found in file sv.h |
2a5a0c38 | 3879 | |
954c1994 | 3880 | =item SvCUR |
d8c40edc | 3881 | X<SvCUR> |
954c1994 GS |
3882 | |
3883 | Returns the length of the string which is in the SV. See C<SvLEN>. | |
3884 | ||
3885 | STRLEN SvCUR(SV* sv) | |
3886 | ||
497711e7 GS |
3887 | =for hackers |
3888 | Found in file sv.h | |
3889 | ||
954c1994 | 3890 | =item SvCUR_set |
d8c40edc | 3891 | X<SvCUR_set> |
954c1994 | 3892 | |
20799e15 SP |
3893 | Set the current length of the string which is in the SV. See C<SvCUR> |
3894 | and C<SvIV_set>. | |
954c1994 GS |
3895 | |
3896 | void SvCUR_set(SV* sv, STRLEN len) | |
3897 | ||
497711e7 GS |
3898 | =for hackers |
3899 | Found in file sv.h | |
3900 | ||
94bdecf9 | 3901 | =item SvEND |
d8c40edc | 3902 | X<SvEND> |
954c1994 | 3903 | |
94bdecf9 JH |
3904 | Returns a pointer to the last character in the string which is in the SV. |
3905 | See C<SvCUR>. Access the character as *(SvEND(sv)). | |
954c1994 | 3906 | |
94bdecf9 | 3907 | char* SvEND(SV* sv) |
954c1994 | 3908 | |
497711e7 GS |
3909 | =for hackers |
3910 | Found in file sv.h | |
3911 | ||
d34786ba NC |
3912 | =item SvGAMAGIC |
3913 | X<SvGAMAGIC> | |
3914 | ||
3915 | Returns true if the SV has get magic or overloading. If either is true then | |
3916 | the scalar is active data, and has the potential to return a new value every | |
3917 | time it is accessed. Hence you must be careful to only read it once per user | |
3918 | logical operation and work with that returned value. If neither is true then | |
3919 | the scalar's value cannot change unless written to. | |
3920 | ||
3921 | char* SvGAMAGIC(SV* sv) | |
3922 | ||
3923 | =for hackers | |
3924 | Found in file sv.h | |
3925 | ||
954c1994 | 3926 | =item SvGROW |
d8c40edc | 3927 | X<SvGROW> |
954c1994 GS |
3928 | |
3929 | Expands the character buffer in the SV so that it has room for the | |
3930 | indicated number of bytes (remember to reserve space for an extra trailing | |
8cf8f3d1 | 3931 | NUL character). Calls C<sv_grow> to perform the expansion if necessary. |
954c1994 GS |
3932 | Returns a pointer to the character buffer. |
3933 | ||
679ac26e | 3934 | char * SvGROW(SV* sv, STRLEN len) |
954c1994 | 3935 | |
497711e7 GS |
3936 | =for hackers |
3937 | Found in file sv.h | |
3938 | ||
954c1994 | 3939 | =item SvIOK |
d8c40edc | 3940 | X<SvIOK> |
954c1994 | 3941 | |
fbf9f983 | 3942 | Returns a U32 value indicating whether the SV contains an integer. |
954c1994 | 3943 | |
fbf9f983 | 3944 | U32 SvIOK(SV* sv) |
954c1994 | 3945 | |
497711e7 GS |
3946 | =for hackers |
3947 | Found in file sv.h | |
3948 | ||
954c1994 | 3949 | =item SvIOKp |
d8c40edc | 3950 | X<SvIOKp> |
954c1994 | 3951 | |
fbf9f983 | 3952 | Returns a U32 value indicating whether the SV contains an integer. Checks |
954c1994 GS |
3953 | the B<private> setting. Use C<SvIOK>. |
3954 | ||
fbf9f983 | 3955 | U32 SvIOKp(SV* sv) |
954c1994 | 3956 | |
497711e7 GS |
3957 | =for hackers |
3958 | Found in file sv.h | |
3959 | ||
e331fc52 | 3960 | =item SvIOK_notUV |
d8c40edc | 3961 | X<SvIOK_notUV> |
e331fc52 | 3962 | |
f4758303 | 3963 | Returns a boolean indicating whether the SV contains a signed integer. |
e331fc52 | 3964 | |
12fa07df | 3965 | bool SvIOK_notUV(SV* sv) |
e331fc52 JH |
3966 | |
3967 | =for hackers | |
3968 | Found in file sv.h | |
3969 | ||
954c1994 | 3970 | =item SvIOK_off |
d8c40edc | 3971 | X<SvIOK_off> |
954c1994 GS |
3972 | |
3973 | Unsets the IV status of an SV. | |
3974 | ||
3975 | void SvIOK_off(SV* sv) | |
3976 | ||
497711e7 GS |
3977 | =for hackers |
3978 | Found in file sv.h | |
3979 | ||
954c1994 | 3980 | =item SvIOK_on |
d8c40edc | 3981 | X<SvIOK_on> |
954c1994 GS |
3982 | |
3983 | Tells an SV that it is an integer. | |
3984 | ||
3985 | void SvIOK_on(SV* sv) | |
3986 | ||
497711e7 GS |
3987 | =for hackers |
3988 | Found in file sv.h | |
3989 | ||
954c1994 | 3990 | =item SvIOK_only |
d8c40edc | 3991 | X<SvIOK_only> |
954c1994 GS |
3992 | |
3993 | Tells an SV that it is an integer and disables all other OK bits. | |
3994 | ||
3995 | void SvIOK_only(SV* sv) | |
3996 | ||
497711e7 GS |
3997 | =for hackers |
3998 | Found in file sv.h | |
3999 | ||
e331fc52 | 4000 | =item SvIOK_only_UV |
d8c40edc | 4001 | X<SvIOK_only_UV> |
e331fc52 JH |
4002 | |
4003 | Tells and SV that it is an unsigned integer and disables all other OK bits. | |
4004 | ||
4005 | void SvIOK_only_UV(SV* sv) | |
4006 | ||
4007 | =for hackers | |
4008 | Found in file sv.h | |
4009 | ||
4010 | =item SvIOK_UV | |
d8c40edc | 4011 | X<SvIOK_UV> |
e331fc52 JH |
4012 | |
4013 | Returns a boolean indicating whether the SV contains an unsigned integer. | |
4014 | ||
12fa07df | 4015 | bool SvIOK_UV(SV* sv) |
e331fc52 JH |
4016 | |
4017 | =for hackers | |
4018 | Found in file sv.h | |
4019 | ||
19dbb8f1 | 4020 | =item SvIsCOW |
d8c40edc | 4021 | X<SvIsCOW> |
19dbb8f1 NC |
4022 | |
4023 | Returns a boolean indicating whether the SV is Copy-On-Write. (either shared | |
4024 | hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for | |
4025 | COW) | |
4026 | ||
4027 | bool SvIsCOW(SV* sv) | |
4028 | ||
4029 | =for hackers | |
4030 | Found in file sv.h | |
4031 | ||
4032 | =item SvIsCOW_shared_hash | |
d8c40edc | 4033 | X<SvIsCOW_shared_hash> |
19dbb8f1 NC |
4034 | |
4035 | Returns a boolean indicating whether the SV is Copy-On-Write shared hash key | |
4036 | scalar. | |
4037 | ||
4038 | bool SvIsCOW_shared_hash(SV* sv) | |
4039 | ||
4040 | =for hackers | |
4041 | Found in file sv.h | |
4042 | ||
954c1994 | 4043 | =item SvIV |
d8c40edc | 4044 | X<SvIV> |
954c1994 | 4045 | |
c40f1585 | 4046 | Coerces the given SV to an integer and returns it. See C<SvIVx> for a |
645c22ef | 4047 | version which guarantees to evaluate sv only once. |
954c1994 GS |
4048 | |
4049 | IV SvIV(SV* sv) | |
4050 | ||
497711e7 GS |
4051 | =for hackers |
4052 | Found in file sv.h | |
4053 | ||
df344c0f | 4054 | =item SvIVX |
d8c40edc | 4055 | X<SvIVX> |
954c1994 | 4056 | |
df344c0f NC |
4057 | Returns the raw value in the SV's IV slot, without checks or conversions. |
4058 | Only use when you are sure SvIOK is true. See also C<SvIV()>. | |
954c1994 | 4059 | |
df344c0f | 4060 | IV SvIVX(SV* sv) |
954c1994 | 4061 | |
497711e7 GS |
4062 | =for hackers |
4063 | Found in file sv.h | |
4064 | ||
df344c0f | 4065 | =item SvIVx |
d8c40edc | 4066 | X<SvIVx> |
645c22ef | 4067 | |
df344c0f | 4068 | Coerces the given SV to an integer and returns it. Guarantees to evaluate |
4ea561bc NC |
4069 | C<sv> only once. Only use this if C<sv> is an expression with side effects, |
4070 | otherwise use the more efficient C<SvIV>. | |
645c22ef | 4071 | |
df344c0f | 4072 | IV SvIVx(SV* sv) |
645c22ef DM |
4073 | |
4074 | =for hackers | |
4075 | Found in file sv.h | |
4076 | ||
891f9566 | 4077 | =item SvIV_nomg |
d8c40edc | 4078 | X<SvIV_nomg> |
891f9566 YST |
4079 | |
4080 | Like C<SvIV> but doesn't process magic. | |
4081 | ||
4082 | IV SvIV_nomg(SV* sv) | |
4083 | ||
4084 | =for hackers | |
4085 | Found in file sv.h | |
4086 | ||
672994ce | 4087 | =item SvIV_set |
d8c40edc | 4088 | X<SvIV_set> |
672994ce | 4089 | |
20799e15 SP |
4090 | Set the value of the IV pointer in sv to val. It is possible to perform |
4091 | the same function of this macro with an lvalue assignment to C<SvIVX>. | |
4092 | With future Perls, however, it will be more efficient to use | |
4093 | C<SvIV_set> instead of the lvalue assignment to C<SvIVX>. | |
672994ce SP |
4094 | |
4095 | void SvIV_set(SV* sv, IV val) | |
4096 | ||
4097 | =for hackers | |
4098 | Found in file sv.h | |
4099 | ||
954c1994 | 4100 | =item SvLEN |
d8c40edc | 4101 | X<SvLEN> |
954c1994 | 4102 | |
91e74348 JH |
4103 | Returns the size of the string buffer in the SV, not including any part |
4104 | attributable to C<SvOOK>. See C<SvCUR>. | |
954c1994 GS |
4105 | |
4106 | STRLEN SvLEN(SV* sv) | |
4107 | ||
497711e7 GS |
4108 | =for hackers |
4109 | Found in file sv.h | |
4110 | ||
672994ce | 4111 | =item SvLEN_set |
d8c40edc | 4112 | X<SvLEN_set> |
672994ce | 4113 | |
20799e15 | 4114 | Set the actual length of the string which is in the SV. See C<SvIV_set>. |
672994ce SP |
4115 | |
4116 | void SvLEN_set(SV* sv, STRLEN len) | |
4117 | ||
4118 | =for hackers | |
4119 | Found in file sv.h | |
4120 | ||
4121 | =item SvMAGIC_set | |
d8c40edc | 4122 | X<SvMAGIC_set> |
672994ce | 4123 | |
20799e15 | 4124 | Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
4125 | |
4126 | void SvMAGIC_set(SV* sv, MAGIC* val) | |
4127 | ||
4128 | =for hackers | |
4129 | Found in file sv.h | |
4130 | ||
954c1994 | 4131 | =item SvNIOK |
d8c40edc | 4132 | X<SvNIOK> |
954c1994 | 4133 | |
fbf9f983 | 4134 | Returns a U32 value indicating whether the SV contains a number, integer or |
954c1994 GS |
4135 | double. |
4136 | ||
fbf9f983 | 4137 | U32 SvNIOK(SV* sv) |
954c1994 | 4138 | |
497711e7 GS |
4139 | =for hackers |
4140 | Found in file sv.h | |
4141 | ||
954c1994 | 4142 | =item SvNIOKp |
d8c40edc | 4143 | X<SvNIOKp> |
954c1994 | 4144 | |
fbf9f983 | 4145 | Returns a U32 value indicating whether the SV contains a number, integer or |
954c1994 GS |
4146 | double. Checks the B<private> setting. Use C<SvNIOK>. |
4147 | ||
fbf9f983 | 4148 | U32 SvNIOKp(SV* sv) |
954c1994 | 4149 | |
497711e7 GS |
4150 | =for hackers |
4151 | Found in file sv.h | |
4152 | ||
954c1994 | 4153 | =item SvNIOK_off |
d8c40edc | 4154 | X<SvNIOK_off> |
954c1994 GS |
4155 | |
4156 | Unsets the NV/IV status of an SV. | |
4157 | ||
4158 | void SvNIOK_off(SV* sv) | |
4159 | ||
497711e7 GS |
4160 | =for hackers |
4161 | Found in file sv.h | |
4162 | ||
954c1994 | 4163 | =item SvNOK |
d8c40edc | 4164 | X<SvNOK> |
954c1994 | 4165 | |
fbf9f983 | 4166 | Returns a U32 value indicating whether the SV contains a double. |
954c1994 | 4167 | |
fbf9f983 | 4168 | U32 SvNOK(SV* sv) |
954c1994 | 4169 | |
497711e7 GS |
4170 | =for hackers |
4171 | Found in file sv.h | |
4172 | ||
954c1994 | 4173 | =item SvNOKp |
d8c40edc | 4174 | X<SvNOKp> |
954c1994 | 4175 | |
fbf9f983 | 4176 | Returns a U32 value indicating whether the SV contains a double. Checks the |
954c1994 GS |
4177 | B<private> setting. Use C<SvNOK>. |
4178 | ||
fbf9f983 | 4179 | U32 SvNOKp(SV* sv) |
954c1994 | 4180 | |
497711e7 GS |
4181 | =for hackers |
4182 | Found in file sv.h | |
4183 | ||
954c1994 | 4184 | =item SvNOK_off |
d8c40edc | 4185 | X<SvNOK_off> |
954c1994 GS |
4186 | |
4187 | Unsets the NV status of an SV. | |
4188 | ||
4189 | void SvNOK_off(SV* sv) | |
4190 | ||
497711e7 GS |
4191 | =for hackers |
4192 | Found in file sv.h | |
4193 | ||
954c1994 | 4194 | =item SvNOK_on |
d8c40edc | 4195 | X<SvNOK_on> |
954c1994 GS |
4196 | |
4197 | Tells an SV that it is a double. | |
4198 | ||
4199 | void SvNOK_on(SV* sv) | |
4200 | ||
497711e7 GS |
4201 | =for hackers |
4202 | Found in file sv.h | |
4203 | ||
954c1994 | 4204 | =item SvNOK_only |
d8c40edc | 4205 | X<SvNOK_only> |
954c1994 GS |
4206 | |
4207 | Tells an SV that it is a double and disables all other OK bits. | |
4208 | ||
4209 | void SvNOK_only(SV* sv) | |
4210 | ||
497711e7 GS |
4211 | =for hackers |
4212 | Found in file sv.h | |
4213 | ||
954c1994 | 4214 | =item SvNV |
d8c40edc | 4215 | X<SvNV> |
954c1994 | 4216 | |
c40f1585 | 4217 | Coerce the given SV to a double and return it. See C<SvNVx> for a version |
645c22ef | 4218 | which guarantees to evaluate sv only once. |
954c1994 GS |
4219 | |
4220 | NV SvNV(SV* sv) | |
4221 | ||
497711e7 GS |
4222 | =for hackers |
4223 | Found in file sv.h | |
4224 | ||
b9381830 | 4225 | =item SvNVX |
d8c40edc | 4226 | X<SvNVX> |
645c22ef | 4227 | |
b9381830 JP |
4228 | Returns the raw value in the SV's NV slot, without checks or conversions. |
4229 | Only use when you are sure SvNOK is true. See also C<SvNV()>. | |
645c22ef | 4230 | |
b9381830 | 4231 | NV SvNVX(SV* sv) |
645c22ef DM |
4232 | |
4233 | =for hackers | |
4234 | Found in file sv.h | |
4235 | ||
b9381830 | 4236 | =item SvNVx |
d8c40edc | 4237 | X<SvNVx> |
954c1994 | 4238 | |
b9381830 | 4239 | Coerces the given SV to a double and returns it. Guarantees to evaluate |
4ea561bc NC |
4240 | C<sv> only once. Only use this if C<sv> is an expression with side effects, |
4241 | otherwise use the more efficient C<SvNV>. | |
954c1994 | 4242 | |
b9381830 | 4243 | NV SvNVx(SV* sv) |
954c1994 | 4244 | |
497711e7 GS |
4245 | =for hackers |
4246 | Found in file sv.h | |
4247 | ||
672994ce | 4248 | =item SvNV_set |
d8c40edc | 4249 | X<SvNV_set> |
672994ce | 4250 | |
20799e15 | 4251 | Set the value of the NV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
4252 | |
4253 | void SvNV_set(SV* sv, NV val) | |
4254 | ||
4255 | =for hackers | |
4256 | Found in file sv.h | |
4257 | ||
954c1994 | 4258 | =item SvOK |
d8c40edc | 4259 | X<SvOK> |
954c1994 | 4260 | |
fbf9f983 | 4261 | Returns a U32 value indicating whether the value is an SV. It also tells |
9adebda4 | 4262 | whether the value is defined or not. |
954c1994 | 4263 | |
fbf9f983 | 4264 | U32 SvOK(SV* sv) |
954c1994 | 4265 | |
497711e7 GS |
4266 | =for hackers |
4267 | Found in file sv.h | |
4268 | ||
954c1994 | 4269 | =item SvOOK |
d8c40edc | 4270 | X<SvOOK> |
954c1994 | 4271 | |
fbf9f983 | 4272 | Returns a U32 indicating whether the SvIVX is a valid offset value for |
954c1994 GS |
4273 | the SvPVX. This hack is used internally to speed up removal of characters |
4274 | from the beginning of a SvPV. When SvOOK is true, then the start of the | |
4275 | allocated string buffer is really (SvPVX - SvIVX). | |
4276 | ||
fbf9f983 | 4277 | U32 SvOOK(SV* sv) |
954c1994 | 4278 | |
497711e7 GS |
4279 | =for hackers |
4280 | Found in file sv.h | |
4281 | ||
954c1994 | 4282 | =item SvPOK |
d8c40edc | 4283 | X<SvPOK> |
954c1994 | 4284 | |
fbf9f983 | 4285 | Returns a U32 value indicating whether the SV contains a character |
954c1994 GS |
4286 | string. |
4287 | ||
fbf9f983 | 4288 | U32 SvPOK(SV* sv) |
954c1994 | 4289 | |
497711e7 GS |
4290 | =for hackers |
4291 | Found in file sv.h | |
4292 | ||
954c1994 | 4293 | =item SvPOKp |
d8c40edc | 4294 | X<SvPOKp> |
954c1994 | 4295 | |
fbf9f983 | 4296 | Returns a U32 value indicating whether the SV contains a character string. |
954c1994 GS |
4297 | Checks the B<private> setting. Use C<SvPOK>. |
4298 | ||
fbf9f983 | 4299 | U32 SvPOKp(SV* sv) |
954c1994 | 4300 | |
497711e7 GS |
4301 | =for hackers |
4302 | Found in file sv.h | |
4303 | ||
954c1994 | 4304 | =item SvPOK_off |
d8c40edc | 4305 | X<SvPOK_off> |
954c1994 GS |
4306 | |
4307 | Unsets the PV status of an SV. | |
4308 | ||
4309 | void SvPOK_off(SV* sv) | |
4310 | ||
497711e7 GS |
4311 | =for hackers |
4312 | Found in file sv.h | |
4313 | ||
954c1994 | 4314 | =item SvPOK_on |
d8c40edc | 4315 | X<SvPOK_on> |
954c1994 GS |
4316 | |
4317 | Tells an SV that it is a string. | |
4318 | ||
4319 | void SvPOK_on(SV* sv) | |
4320 | ||
497711e7 GS |
4321 | =for hackers |
4322 | Found in file sv.h | |
4323 | ||
954c1994 | 4324 | =item SvPOK_only |
d8c40edc | 4325 | X<SvPOK_only> |
954c1994 GS |
4326 | |
4327 | Tells an SV that it is a string and disables all other OK bits. | |
1e54db1a | 4328 | Will also turn off the UTF-8 status. |
954c1994 GS |
4329 | |
4330 | void SvPOK_only(SV* sv) | |
4331 | ||
497711e7 GS |
4332 | =for hackers |
4333 | Found in file sv.h | |
4334 | ||
914184e1 | 4335 | =item SvPOK_only_UTF8 |
d8c40edc | 4336 | X<SvPOK_only_UTF8> |
914184e1 | 4337 | |
d5ce4a7c | 4338 | Tells an SV that it is a string and disables all other OK bits, |
1e54db1a | 4339 | and leaves the UTF-8 status as it was. |
f1a1024e | 4340 | |
914184e1 JH |
4341 | void SvPOK_only_UTF8(SV* sv) |
4342 | ||
4343 | =for hackers | |
4344 | Found in file sv.h | |
4345 | ||
954c1994 | 4346 | =item SvPV |
d8c40edc | 4347 | X<SvPV> |
954c1994 | 4348 | |
12b7c5c7 JH |
4349 | Returns a pointer to the string in the SV, or a stringified form of |
4350 | the SV if the SV does not contain a string. The SV may cache the | |
4351 | stringified version becoming C<SvPOK>. Handles 'get' magic. See also | |
645c22ef | 4352 | C<SvPVx> for a version which guarantees to evaluate sv only once. |
954c1994 GS |
4353 | |
4354 | char* SvPV(SV* sv, STRLEN len) | |
4355 | ||
497711e7 GS |
4356 | =for hackers |
4357 | Found in file sv.h | |
4358 | ||
645c22ef | 4359 | =item SvPVbyte |
d8c40edc | 4360 | X<SvPVbyte> |
645c22ef DM |
4361 | |
4362 | Like C<SvPV>, but converts sv to byte representation first if necessary. | |
4363 | ||
4364 | char* SvPVbyte(SV* sv, STRLEN len) | |
4365 | ||
4366 | =for hackers | |
4367 | Found in file sv.h | |
4368 | ||
4369 | =item SvPVbytex | |
d8c40edc | 4370 | X<SvPVbytex> |
645c22ef DM |
4371 | |
4372 | Like C<SvPV>, but converts sv to byte representation first if necessary. | |
d1be9408 | 4373 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte> |
645c22ef DM |
4374 | otherwise. |
4375 | ||
645c22ef DM |
4376 | char* SvPVbytex(SV* sv, STRLEN len) |
4377 | ||
4378 | =for hackers | |
4379 | Found in file sv.h | |
4380 | ||
4381 | =item SvPVbytex_force | |
d8c40edc | 4382 | X<SvPVbytex_force> |
645c22ef DM |
4383 | |
4384 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. | |
d1be9408 | 4385 | Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force> |
645c22ef DM |
4386 | otherwise. |
4387 | ||
4388 | char* SvPVbytex_force(SV* sv, STRLEN len) | |
4389 | ||
4390 | =for hackers | |
4391 | Found in file sv.h | |
4392 | ||
4393 | =item SvPVbyte_force | |
d8c40edc | 4394 | X<SvPVbyte_force> |
645c22ef DM |
4395 | |
4396 | Like C<SvPV_force>, but converts sv to byte representation first if necessary. | |
4397 | ||
4398 | char* SvPVbyte_force(SV* sv, STRLEN len) | |
4399 | ||
4400 | =for hackers | |
4401 | Found in file sv.h | |
4402 | ||
4403 | =item SvPVbyte_nolen | |
d8c40edc | 4404 | X<SvPVbyte_nolen> |
645c22ef DM |
4405 | |
4406 | Like C<SvPV_nolen>, but converts sv to byte representation first if necessary. | |
4407 | ||
1fdc5aa6 | 4408 | char* SvPVbyte_nolen(SV* sv) |
645c22ef DM |
4409 | |
4410 | =for hackers | |
4411 | Found in file sv.h | |
4412 | ||
4413 | =item SvPVutf8 | |
d8c40edc | 4414 | X<SvPVutf8> |
645c22ef | 4415 | |
1fdc5aa6 | 4416 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
645c22ef DM |
4417 | |
4418 | char* SvPVutf8(SV* sv, STRLEN len) | |
4419 | ||
4420 | =for hackers | |
4421 | Found in file sv.h | |
4422 | ||
4423 | =item SvPVutf8x | |
d8c40edc | 4424 | X<SvPVutf8x> |
645c22ef | 4425 | |
1fdc5aa6 | 4426 | Like C<SvPV>, but converts sv to utf8 first if necessary. |
d1be9408 | 4427 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8> |
645c22ef DM |
4428 | otherwise. |
4429 | ||
4430 | char* SvPVutf8x(SV* sv, STRLEN len) | |
4431 | ||
4432 | =for hackers | |
4433 | Found in file sv.h | |
4434 | ||
4435 | =item SvPVutf8x_force | |
d8c40edc | 4436 | X<SvPVutf8x_force> |
645c22ef | 4437 | |
1fdc5aa6 | 4438 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
d1be9408 | 4439 | Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force> |
645c22ef DM |
4440 | otherwise. |
4441 | ||
4442 | char* SvPVutf8x_force(SV* sv, STRLEN len) | |
4443 | ||
4444 | =for hackers | |
4445 | Found in file sv.h | |
4446 | ||
4447 | =item SvPVutf8_force | |
d8c40edc | 4448 | X<SvPVutf8_force> |
645c22ef | 4449 | |
1fdc5aa6 | 4450 | Like C<SvPV_force>, but converts sv to utf8 first if necessary. |
645c22ef DM |
4451 | |
4452 | char* SvPVutf8_force(SV* sv, STRLEN len) | |
4453 | ||
4454 | =for hackers | |
4455 | Found in file sv.h | |
4456 | ||
4457 | =item SvPVutf8_nolen | |
d8c40edc | 4458 | X<SvPVutf8_nolen> |
645c22ef | 4459 | |
1fdc5aa6 | 4460 | Like C<SvPV_nolen>, but converts sv to utf8 first if necessary. |
645c22ef | 4461 | |
1fdc5aa6 | 4462 | char* SvPVutf8_nolen(SV* sv) |
645c22ef DM |
4463 | |
4464 | =for hackers | |
4465 | Found in file sv.h | |
4466 | ||
df344c0f | 4467 | =item SvPVX |
d8c40edc | 4468 | X<SvPVX> |
645c22ef | 4469 | |
df344c0f NC |
4470 | Returns a pointer to the physical string in the SV. The SV must contain a |
4471 | string. | |
645c22ef | 4472 | |
df344c0f | 4473 | char* SvPVX(SV* sv) |
645c22ef DM |
4474 | |
4475 | =for hackers | |
4476 | Found in file sv.h | |
4477 | ||
df344c0f | 4478 | =item SvPVx |
d8c40edc | 4479 | X<SvPVx> |
954c1994 | 4480 | |
4ea561bc NC |
4481 | A version of C<SvPV> which guarantees to evaluate C<sv> only once. |
4482 | Only use this if C<sv> is an expression with side effects, otherwise use the | |
4483 | more efficient C<SvPVX>. | |
954c1994 | 4484 | |
df344c0f | 4485 | char* SvPVx(SV* sv, STRLEN len) |
954c1994 | 4486 | |
497711e7 GS |
4487 | =for hackers |
4488 | Found in file sv.h | |
4489 | ||
954c1994 | 4490 | =item SvPV_force |
d8c40edc | 4491 | X<SvPV_force> |
954c1994 | 4492 | |
12b7c5c7 JH |
4493 | Like C<SvPV> but will force the SV into containing just a string |
4494 | (C<SvPOK_only>). You want force if you are going to update the C<SvPVX> | |
4495 | directly. | |
954c1994 GS |
4496 | |
4497 | char* SvPV_force(SV* sv, STRLEN len) | |
4498 | ||
497711e7 GS |
4499 | =for hackers |
4500 | Found in file sv.h | |
4501 | ||
645c22ef | 4502 | =item SvPV_force_nomg |
d8c40edc | 4503 | X<SvPV_force_nomg> |
645c22ef | 4504 | |
12b7c5c7 JH |
4505 | Like C<SvPV> but will force the SV into containing just a string |
4506 | (C<SvPOK_only>). You want force if you are going to update the C<SvPVX> | |
4507 | directly. Doesn't process magic. | |
645c22ef DM |
4508 | |
4509 | char* SvPV_force_nomg(SV* sv, STRLEN len) | |
4510 | ||
4511 | =for hackers | |
4512 | Found in file sv.h | |
4513 | ||
954c1994 | 4514 | =item SvPV_nolen |
d8c40edc | 4515 | X<SvPV_nolen> |
954c1994 | 4516 | |
12b7c5c7 JH |
4517 | Returns a pointer to the string in the SV, or a stringified form of |
4518 | the SV if the SV does not contain a string. The SV may cache the | |
4519 | stringified form becoming C<SvPOK>. Handles 'get' magic. | |
954c1994 GS |
4520 | |
4521 | char* SvPV_nolen(SV* sv) | |
4522 | ||
497711e7 GS |
4523 | =for hackers |
4524 | Found in file sv.h | |
4525 | ||
891f9566 | 4526 | =item SvPV_nomg |
d8c40edc | 4527 | X<SvPV_nomg> |
891f9566 YST |
4528 | |
4529 | Like C<SvPV> but doesn't process magic. | |
4530 | ||
4531 | char* SvPV_nomg(SV* sv, STRLEN len) | |
4532 | ||
4533 | =for hackers | |
4534 | Found in file sv.h | |
4535 | ||
672994ce | 4536 | =item SvPV_set |
d8c40edc | 4537 | X<SvPV_set> |
672994ce | 4538 | |
20799e15 | 4539 | Set the value of the PV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
4540 | |
4541 | void SvPV_set(SV* sv, char* val) | |
4542 | ||
4543 | =for hackers | |
4544 | Found in file sv.h | |
4545 | ||
954c1994 | 4546 | =item SvREFCNT |
d8c40edc | 4547 | X<SvREFCNT> |
954c1994 GS |
4548 | |
4549 | Returns the value of the object's reference count. | |
4550 | ||
4551 | U32 SvREFCNT(SV* sv) | |
4552 | ||
497711e7 GS |
4553 | =for hackers |
4554 | Found in file sv.h | |
4555 | ||
954c1994 | 4556 | =item SvREFCNT_dec |
d8c40edc | 4557 | X<SvREFCNT_dec> |
954c1994 GS |
4558 | |
4559 | Decrements the reference count of the given SV. | |
4560 | ||
4561 | void SvREFCNT_dec(SV* sv) | |
4562 | ||
497711e7 GS |
4563 | =for hackers |
4564 | Found in file sv.h | |
4565 | ||
954c1994 | 4566 | =item SvREFCNT_inc |
d8c40edc | 4567 | X<SvREFCNT_inc> |
954c1994 GS |
4568 | |
4569 | Increments the reference count of the given SV. | |
4570 | ||
3fe05580 MHM |
4571 | All of the following SvREFCNT_inc* macros are optimized versions of |
4572 | SvREFCNT_inc, and can be replaced with SvREFCNT_inc. | |
4573 | ||
954c1994 GS |
4574 | SV* SvREFCNT_inc(SV* sv) |
4575 | ||
497711e7 GS |
4576 | =for hackers |
4577 | Found in file sv.h | |
4578 | ||
b37c2d43 AL |
4579 | =item SvREFCNT_inc_NN |
4580 | X<SvREFCNT_inc_NN> | |
4581 | ||
4582 | Same as SvREFCNT_inc, but can only be used if you know I<sv> | |
4583 | is not NULL. Since we don't have to check the NULLness, it's faster | |
4584 | and smaller. | |
4585 | ||
4586 | SV* SvREFCNT_inc_NN(SV* sv) | |
4587 | ||
4588 | =for hackers | |
4589 | Found in file sv.h | |
4590 | ||
4591 | =item SvREFCNT_inc_simple | |
4592 | X<SvREFCNT_inc_simple> | |
4593 | ||
4ea561bc NC |
4594 | Same as SvREFCNT_inc, but can only be used with expressions without side |
4595 | effects. Since we don't have to store a temporary value, it's faster. | |
b37c2d43 AL |
4596 | |
4597 | SV* SvREFCNT_inc_simple(SV* sv) | |
4598 | ||
4599 | =for hackers | |
4600 | Found in file sv.h | |
4601 | ||
4602 | =item SvREFCNT_inc_simple_NN | |
4603 | X<SvREFCNT_inc_simple_NN> | |
4604 | ||
4605 | Same as SvREFCNT_inc_simple, but can only be used if you know I<sv> | |
4606 | is not NULL. Since we don't have to check the NULLness, it's faster | |
4607 | and smaller. | |
4608 | ||
4609 | SV* SvREFCNT_inc_simple_NN(SV* sv) | |
4610 | ||
4611 | =for hackers | |
4612 | Found in file sv.h | |
4613 | ||
4614 | =item SvREFCNT_inc_simple_void | |
4615 | X<SvREFCNT_inc_simple_void> | |
4616 | ||
4617 | Same as SvREFCNT_inc_simple, but can only be used if you don't need the | |
4618 | return value. The macro doesn't need to return a meaningful value. | |
4619 | ||
f8f4df2c | 4620 | void SvREFCNT_inc_simple_void(SV* sv) |
b37c2d43 AL |
4621 | |
4622 | =for hackers | |
4623 | Found in file sv.h | |
4624 | ||
3fe05580 MHM |
4625 | =item SvREFCNT_inc_simple_void_NN |
4626 | X<SvREFCNT_inc_simple_void_NN> | |
4627 | ||
4628 | Same as SvREFCNT_inc, but can only be used if you don't need the return | |
4629 | value, and you know that I<sv> is not NULL. The macro doesn't need | |
4630 | to return a meaningful value, or check for NULLness, so it's smaller | |
4631 | and faster. | |
4632 | ||
f8f4df2c | 4633 | void SvREFCNT_inc_simple_void_NN(SV* sv) |
3fe05580 MHM |
4634 | |
4635 | =for hackers | |
4636 | Found in file sv.h | |
4637 | ||
b37c2d43 AL |
4638 | =item SvREFCNT_inc_void |
4639 | X<SvREFCNT_inc_void> | |
4640 | ||
4641 | Same as SvREFCNT_inc, but can only be used if you don't need the | |
4642 | return value. The macro doesn't need to return a meaningful value. | |
4643 | ||
f8f4df2c | 4644 | void SvREFCNT_inc_void(SV* sv) |
b37c2d43 AL |
4645 | |
4646 | =for hackers | |
4647 | Found in file sv.h | |
4648 | ||
4649 | =item SvREFCNT_inc_void_NN | |
4650 | X<SvREFCNT_inc_void_NN> | |
4651 | ||
4652 | Same as SvREFCNT_inc, but can only be used if you don't need the return | |
4653 | value, and you know that I<sv> is not NULL. The macro doesn't need | |
4654 | to return a meaningful value, or check for NULLness, so it's smaller | |
4655 | and faster. | |
4656 | ||
f8f4df2c | 4657 | void SvREFCNT_inc_void_NN(SV* sv) |
b37c2d43 AL |
4658 | |
4659 | =for hackers | |
4660 | Found in file sv.h | |
4661 | ||
954c1994 | 4662 | =item SvROK |
d8c40edc | 4663 | X<SvROK> |
954c1994 GS |
4664 | |
4665 | Tests if the SV is an RV. | |
4666 | ||
fbf9f983 | 4667 | U32 SvROK(SV* sv) |
954c1994 | 4668 | |
497711e7 GS |
4669 | =for hackers |
4670 | Found in file sv.h | |
4671 | ||
954c1994 | 4672 | =item SvROK_off |
d8c40edc | 4673 | X<SvROK_off> |
954c1994 GS |
4674 | |
4675 | Unsets the RV status of an SV. | |
4676 | ||
4677 | void SvROK_off(SV* sv) | |
4678 | ||
497711e7 GS |
4679 | =for hackers |
4680 | Found in file sv.h | |
4681 | ||
954c1994 | 4682 | =item SvROK_on |
d8c40edc | 4683 | X<SvROK_on> |
954c1994 GS |
4684 | |
4685 | Tells an SV that it is an RV. | |
4686 | ||
4687 | void SvROK_on(SV* sv) | |
4688 | ||
497711e7 GS |
4689 | =for hackers |
4690 | Found in file sv.h | |
4691 | ||
954c1994 | 4692 | =item SvRV |
d8c40edc | 4693 | X<SvRV> |
954c1994 GS |
4694 | |
4695 | Dereferences an RV to return the SV. | |
4696 | ||
4697 | SV* SvRV(SV* sv) | |
4698 | ||
497711e7 GS |
4699 | =for hackers |
4700 | Found in file sv.h | |
4701 | ||
672994ce | 4702 | =item SvRV_set |
d8c40edc | 4703 | X<SvRV_set> |
672994ce | 4704 | |
20799e15 | 4705 | Set the value of the RV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
4706 | |
4707 | void SvRV_set(SV* sv, SV* val) | |
4708 | ||
4709 | =for hackers | |
4710 | Found in file sv.h | |
4711 | ||
954c1994 | 4712 | =item SvSTASH |
d8c40edc | 4713 | X<SvSTASH> |
954c1994 GS |
4714 | |
4715 | Returns the stash of the SV. | |
4716 | ||
4717 | HV* SvSTASH(SV* sv) | |
4718 | ||
497711e7 GS |
4719 | =for hackers |
4720 | Found in file sv.h | |
4721 | ||
672994ce | 4722 | =item SvSTASH_set |
d8c40edc | 4723 | X<SvSTASH_set> |
672994ce | 4724 | |
20799e15 | 4725 | Set the value of the STASH pointer in sv to val. See C<SvIV_set>. |
672994ce | 4726 | |
d070ff45 | 4727 | void SvSTASH_set(SV* sv, HV* val) |
672994ce SP |
4728 | |
4729 | =for hackers | |
4730 | Found in file sv.h | |
4731 | ||
954c1994 | 4732 | =item SvTAINT |
d8c40edc | 4733 | X<SvTAINT> |
954c1994 | 4734 | |
c55831ac | 4735 | Taints an SV if tainting is enabled. |
954c1994 GS |
4736 | |
4737 | void SvTAINT(SV* sv) | |
4738 | ||
497711e7 GS |
4739 | =for hackers |
4740 | Found in file sv.h | |
4741 | ||
954c1994 | 4742 | =item SvTAINTED |
d8c40edc | 4743 | X<SvTAINTED> |
954c1994 GS |
4744 | |
4745 | Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if | |
4746 | not. | |
4747 | ||
4748 | bool SvTAINTED(SV* sv) | |
4749 | ||
497711e7 GS |
4750 | =for hackers |
4751 | Found in file sv.h | |
4752 | ||
954c1994 | 4753 | =item SvTAINTED_off |
d8c40edc | 4754 | X<SvTAINTED_off> |
954c1994 GS |
4755 | |
4756 | Untaints an SV. Be I<very> careful with this routine, as it short-circuits | |
4757 | some of Perl's fundamental security features. XS module authors should not | |
4758 | use this function unless they fully understand all the implications of | |
4759 | unconditionally untainting the value. Untainting should be done in the | |
4760 | standard perl fashion, via a carefully crafted regexp, rather than directly | |
4761 | untainting variables. | |
4762 | ||
4763 | void SvTAINTED_off(SV* sv) | |
4764 | ||
497711e7 GS |
4765 | =for hackers |
4766 | Found in file sv.h | |
4767 | ||
954c1994 | 4768 | =item SvTAINTED_on |
d8c40edc | 4769 | X<SvTAINTED_on> |
954c1994 | 4770 | |
c55831ac | 4771 | Marks an SV as tainted if tainting is enabled. |
954c1994 GS |
4772 | |
4773 | void SvTAINTED_on(SV* sv) | |
4774 | ||
497711e7 GS |
4775 | =for hackers |
4776 | Found in file sv.h | |
4777 | ||
954c1994 | 4778 | =item SvTRUE |
d8c40edc | 4779 | X<SvTRUE> |
954c1994 GS |
4780 | |
4781 | Returns a boolean indicating whether Perl would evaluate the SV as true or | |
4782 | false, defined or undefined. Does not handle 'get' magic. | |
4783 | ||
4784 | bool SvTRUE(SV* sv) | |
4785 | ||
497711e7 GS |
4786 | =for hackers |
4787 | Found in file sv.h | |
4788 | ||
9f4817db | 4789 | =item SvTYPE |
d8c40edc | 4790 | X<SvTYPE> |
af3c7592 | 4791 | |
9f4817db JH |
4792 | Returns the type of the SV. See C<svtype>. |
4793 | ||
4794 | svtype SvTYPE(SV* sv) | |
954c1994 | 4795 | |
497711e7 GS |
4796 | =for hackers |
4797 | Found in file sv.h | |
4798 | ||
a8586c98 | 4799 | =item SvUOK |
d8c40edc | 4800 | X<SvUOK> |
a8586c98 JH |
4801 | |
4802 | Returns a boolean indicating whether the SV contains an unsigned integer. | |
4803 | ||
fbf9f983 | 4804 | bool SvUOK(SV* sv) |
a8586c98 JH |
4805 | |
4806 | =for hackers | |
4807 | Found in file sv.h | |
4808 | ||
954c1994 | 4809 | =item SvUPGRADE |
d8c40edc | 4810 | X<SvUPGRADE> |
954c1994 GS |
4811 | |
4812 | Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to | |
4813 | perform the upgrade if necessary. See C<svtype>. | |
4814 | ||
4815 | void SvUPGRADE(SV* sv, svtype type) | |
4816 | ||
497711e7 GS |
4817 | =for hackers |
4818 | Found in file sv.h | |
4819 | ||
914184e1 | 4820 | =item SvUTF8 |
d8c40edc | 4821 | X<SvUTF8> |
914184e1 | 4822 | |
fbf9f983 | 4823 | Returns a U32 value indicating whether the SV contains UTF-8 encoded data. |
5912531f DM |
4824 | Call this after SvPV() in case any call to string overloading updates the |
4825 | internal flag. | |
914184e1 | 4826 | |
fbf9f983 | 4827 | U32 SvUTF8(SV* sv) |
914184e1 JH |
4828 | |
4829 | =for hackers | |
4830 | Found in file sv.h | |
4831 | ||
4832 | =item SvUTF8_off | |
d8c40edc | 4833 | X<SvUTF8_off> |
914184e1 | 4834 | |
1e54db1a | 4835 | Unsets the UTF-8 status of an SV. |
914184e1 JH |
4836 | |
4837 | void SvUTF8_off(SV *sv) | |
4838 | ||
4839 | =for hackers | |
4840 | Found in file sv.h | |
4841 | ||
4842 | =item SvUTF8_on | |
d8c40edc | 4843 | X<SvUTF8_on> |
914184e1 | 4844 | |
1e54db1a | 4845 | Turn on the UTF-8 status of an SV (the data is not changed, just the flag). |
d5ce4a7c | 4846 | Do not use frivolously. |
914184e1 JH |
4847 | |
4848 | void SvUTF8_on(SV *sv) | |
4849 | ||
4850 | =for hackers | |
4851 | Found in file sv.h | |
4852 | ||
954c1994 | 4853 | =item SvUV |
d8c40edc | 4854 | X<SvUV> |
954c1994 | 4855 | |
645c22ef DM |
4856 | Coerces the given SV to an unsigned integer and returns it. See C<SvUVx> |
4857 | for a version which guarantees to evaluate sv only once. | |
954c1994 GS |
4858 | |
4859 | UV SvUV(SV* sv) | |
4860 | ||
497711e7 GS |
4861 | =for hackers |
4862 | Found in file sv.h | |
4863 | ||
b9381830 | 4864 | =item SvUVX |
d8c40edc | 4865 | X<SvUVX> |
891f9566 | 4866 | |
b9381830 JP |
4867 | Returns the raw value in the SV's UV slot, without checks or conversions. |
4868 | Only use when you are sure SvIOK is true. See also C<SvUV()>. | |
891f9566 | 4869 | |
b9381830 | 4870 | UV SvUVX(SV* sv) |
891f9566 YST |
4871 | |
4872 | =for hackers | |
4873 | Found in file sv.h | |
4874 | ||
b9381830 | 4875 | =item SvUVx |
d8c40edc | 4876 | X<SvUVx> |
b0f01acb | 4877 | |
b9381830 | 4878 | Coerces the given SV to an unsigned integer and returns it. Guarantees to |
4ea561bc NC |
4879 | C<sv> only once. Only use this if C<sv> is an expression with side effects, |
4880 | otherwise use the more efficient C<SvUV>. | |
b0f01acb | 4881 | |
b9381830 | 4882 | UV SvUVx(SV* sv) |
b0f01acb JP |
4883 | |
4884 | =for hackers | |
4885 | Found in file sv.h | |
4886 | ||
891f9566 | 4887 | =item SvUV_nomg |
d8c40edc | 4888 | X<SvUV_nomg> |
954c1994 | 4889 | |
891f9566 | 4890 | Like C<SvUV> but doesn't process magic. |
954c1994 | 4891 | |
891f9566 | 4892 | UV SvUV_nomg(SV* sv) |
954c1994 | 4893 | |
497711e7 GS |
4894 | =for hackers |
4895 | Found in file sv.h | |
4896 | ||
672994ce | 4897 | =item SvUV_set |
d8c40edc | 4898 | X<SvUV_set> |
672994ce | 4899 | |
20799e15 | 4900 | Set the value of the UV pointer in sv to val. See C<SvIV_set>. |
672994ce SP |
4901 | |
4902 | void SvUV_set(SV* sv, UV val) | |
4903 | ||
4904 | =for hackers | |
4905 | Found in file sv.h | |
4906 | ||
b0f01acb | 4907 | =item SvVOK |
d8c40edc | 4908 | X<SvVOK> |
645c22ef | 4909 | |
b0f01acb | 4910 | Returns a boolean indicating whether the SV contains a v-string. |
645c22ef | 4911 | |
b0f01acb | 4912 | bool SvVOK(SV* sv) |
645c22ef DM |
4913 | |
4914 | =for hackers | |
4915 | Found in file sv.h | |
4916 | ||
d2a0f284 JC |
4917 | =item sv_catpvn_nomg |
4918 | X<sv_catpvn_nomg> | |
4919 | ||
4920 | Like C<sv_catpvn> but doesn't process magic. | |
4921 | ||
4922 | void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len) | |
4923 | ||
4924 | =for hackers | |
4925 | Found in file sv.h | |
4926 | ||
4927 | =item sv_catsv_nomg | |
4928 | X<sv_catsv_nomg> | |
4929 | ||
4930 | Like C<sv_catsv> but doesn't process magic. | |
4931 | ||
4932 | void sv_catsv_nomg(SV* dsv, SV* ssv) | |
4933 | ||
4934 | =for hackers | |
4935 | Found in file sv.h | |
4936 | ||
4937 | =item sv_derived_from | |
4938 | X<sv_derived_from> | |
4939 | ||
6885da0e | 4940 | Returns a boolean indicating whether the SV is derived from the specified class |
4941 | I<at the C level>. To check derivation at the Perl level, call C<isa()> as a | |
4942 | normal Perl method. | |
d2a0f284 JC |
4943 | |
4944 | bool sv_derived_from(SV* sv, const char* name) | |
4945 | ||
4946 | =for hackers | |
4947 | Found in file universal.c | |
4948 | ||
cbc021f9 | 4949 | =item sv_does |
4950 | X<sv_does> | |
4951 | ||
4952 | Returns a boolean indicating whether the SV performs a specific, named role. | |
4953 | The SV can be a Perl object or the name of a Perl class. | |
4954 | ||
4955 | bool sv_does(SV* sv, const char* name) | |
4956 | ||
4957 | =for hackers | |
4958 | Found in file universal.c | |
4959 | ||
d2a0f284 JC |
4960 | =item sv_report_used |
4961 | X<sv_report_used> | |
4962 | ||
4963 | Dump the contents of all SVs not yet freed. (Debugging aid). | |
4964 | ||
4965 | void sv_report_used() | |
4966 | ||
4967 | =for hackers | |
4968 | Found in file sv.c | |
4969 | ||
4970 | =item sv_setsv_nomg | |
4971 | X<sv_setsv_nomg> | |
4972 | ||
4973 | Like C<sv_setsv> but doesn't process magic. | |
4974 | ||
4975 | void sv_setsv_nomg(SV* dsv, SV* ssv) | |
4976 | ||
4977 | =for hackers | |
4978 | Found in file sv.h | |
4979 | ||
4980 | ||
4981 | =back | |
4982 | ||
4983 | =head1 SV-Body Allocation | |
4984 | ||
4985 | =over 8 | |
4986 | ||
4987 | =item looks_like_number | |
4988 | X<looks_like_number> | |
4989 | ||
4990 | Test if the content of an SV looks like a number (or is a number). | |
4991 | C<Inf> and C<Infinity> are treated as numbers (so will not issue a | |
4992 | non-numeric warning), even if your atof() doesn't grok them. | |
4993 | ||
4994 | I32 looks_like_number(SV* sv) | |
4995 | ||
4996 | =for hackers | |
4997 | Found in file sv.c | |
4998 | ||
4999 | =item newRV_noinc | |
5000 | X<newRV_noinc> | |
5001 | ||
5002 | Creates an RV wrapper for an SV. The reference count for the original | |
5003 | SV is B<not> incremented. | |
5004 | ||
7f466ec7 | 5005 | SV* newRV_noinc(SV* sv) |
d2a0f284 JC |
5006 | |
5007 | =for hackers | |
5008 | Found in file sv.c | |
5009 | ||
5010 | =item newSV | |
5011 | X<newSV> | |
5012 | ||
5013 | Creates a new SV. A non-zero C<len> parameter indicates the number of | |
5014 | bytes of preallocated string space the SV should have. An extra byte for a | |
5015 | trailing NUL is also reserved. (SvPOK is not set for the SV even if string | |
5016 | space is allocated.) The reference count for the new SV is set to 1. | |
5017 | ||
5018 | In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first | |
5019 | parameter, I<x>, a debug aid which allowed callers to identify themselves. | |
5020 | This aid has been superseded by a new build option, PERL_MEM_LOG (see | |
5021 | L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS | |
5022 | modules supporting older perls. | |
5023 | ||
5024 | SV* newSV(STRLEN len) | |
5025 | ||
5026 | =for hackers | |
5027 | Found in file sv.c | |
5028 | ||
5029 | =item newSVhek | |
5030 | X<newSVhek> | |
5031 | ||
5032 | Creates a new SV from the hash key structure. It will generate scalars that | |
5033 | point to the shared string table where possible. Returns a new (undefined) | |
5034 | SV if the hek is NULL. | |
5035 | ||
5036 | SV* newSVhek(const HEK *hek) | |
5037 | ||
5038 | =for hackers | |
5039 | Found in file sv.c | |
5040 | ||
5041 | =item newSViv | |
5042 | X<newSViv> | |
5043 | ||
5044 | Creates a new SV and copies an integer into it. The reference count for the | |
5045 | SV is set to 1. | |
5046 | ||
5047 | SV* newSViv(IV i) | |
5048 | ||
5049 | =for hackers | |
5050 | Found in file sv.c | |
5051 | ||
5052 | =item newSVnv | |
5053 | X<newSVnv> | |
5054 | ||
5055 | Creates a new SV and copies a floating point value into it. | |
5056 | The reference count for the SV is set to 1. | |
5057 | ||
5058 | SV* newSVnv(NV n) | |
5059 | ||
5060 | =for hackers | |
5061 | Found in file sv.c | |
5062 | ||
5063 | =item newSVpv | |
5064 | X<newSVpv> | |
5065 | ||
5066 | Creates a new SV and copies a string into it. The reference count for the | |
5067 | SV is set to 1. If C<len> is zero, Perl will compute the length using | |
5068 | strlen(). For efficiency, consider using C<newSVpvn> instead. | |
5069 | ||
5070 | SV* newSVpv(const char* s, STRLEN len) | |
5071 | ||
5072 | =for hackers | |
5073 | Found in file sv.c | |
5074 | ||
5075 | =item newSVpvf | |
5076 | X<newSVpvf> | |
5077 | ||
5078 | Creates a new SV and initializes it with the string formatted like | |
5079 | C<sprintf>. | |
5080 | ||
5081 | SV* newSVpvf(const char* pat, ...) | |
5082 | ||
5083 | =for hackers | |
5084 | Found in file sv.c | |
5085 | ||
5086 | =item newSVpvn | |
5087 | X<newSVpvn> | |
5088 | ||
5089 | Creates a new SV and copies a string into it. The reference count for the | |
5090 | SV is set to 1. Note that if C<len> is zero, Perl will create a zero length | |
5091 | string. You are responsible for ensuring that the source string is at least | |
5092 | C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined. | |
5093 | ||
5094 | SV* newSVpvn(const char* s, STRLEN len) | |
5095 | ||
5096 | =for hackers | |
5097 | Found in file sv.c | |
5098 | ||
5099 | =item newSVpvn_share | |
5100 | X<newSVpvn_share> | |
5101 | ||
5102 | Creates a new SV with its SvPVX_const pointing to a shared string in the string | |
5103 | table. If the string does not already exist in the table, it is created | |
5104 | first. Turns on READONLY and FAKE. The string's hash is stored in the UV | |
5105 | slot of the SV; if the C<hash> parameter is non-zero, that value is used; | |
5106 | otherwise the hash is computed. The idea here is that as the string table | |
5107 | is used for shared hash keys these strings will have SvPVX_const == HeKEY and | |
5108 | hash lookup will avoid string compare. | |
5109 | ||
5110 | SV* newSVpvn_share(const char* s, I32 len, U32 hash) | |
5111 | ||
5112 | =for hackers | |
5113 | Found in file sv.c | |
5114 | ||
3fe05580 MHM |
5115 | =item newSVpvs |
5116 | X<newSVpvs> | |
5117 | ||
5118 | Like C<newSVpvn>, but takes a literal string instead of a string/length pair. | |
5119 | ||
5120 | SV* newSVpvs(const char* s) | |
5121 | ||
5122 | =for hackers | |
5123 | Found in file handy.h | |
5124 | ||
5125 | =item newSVpvs_share | |
5126 | X<newSVpvs_share> | |
5127 | ||
5128 | Like C<newSVpvn_share>, but takes a literal string instead of a string/length | |
5129 | pair and omits the hash parameter. | |
5130 | ||
5131 | SV* newSVpvs_share(const char* s) | |
5132 | ||
5133 | =for hackers | |
5134 | Found in file handy.h | |
5135 | ||
d2a0f284 JC |
5136 | =item newSVrv |
5137 | X<newSVrv> | |
5138 | ||
5139 | Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then | |
5140 | it will be upgraded to one. If C<classname> is non-null then the new SV will | |
5141 | be blessed in the specified package. The new SV is returned and its | |
5142 | reference count is 1. | |
5143 | ||
5144 | SV* newSVrv(SV* rv, const char* classname) | |
5145 | ||
5146 | =for hackers | |
5147 | Found in file sv.c | |
5148 | ||
5149 | =item newSVsv | |
5150 | X<newSVsv> | |
5151 | ||
5152 | Creates a new SV which is an exact duplicate of the original SV. | |
5153 | (Uses C<sv_setsv>). | |
5154 | ||
5155 | SV* newSVsv(SV* old) | |
5156 | ||
5157 | =for hackers | |
5158 | Found in file sv.c | |
5159 | ||
5160 | =item newSVuv | |
5161 | X<newSVuv> | |
5162 | ||
5163 | Creates a new SV and copies an unsigned integer into it. | |
5164 | The reference count for the SV is set to 1. | |
5165 | ||
5166 | SV* newSVuv(UV u) | |
5167 | ||
5168 | =for hackers | |
5169 | Found in file sv.c | |
5170 | ||
bae1192d JH |
5171 | =item newSV_type |
5172 | X<newSV_type> | |
5173 | ||
5174 | Creates a new SV, of the type specificied. The reference count for the new SV | |
5175 | is set to 1. | |
5176 | ||
5177 | SV* newSV_type(svtype type) | |
5178 | ||
5179 | =for hackers | |
5180 | Found in file sv.c | |
5181 | ||
645c22ef | 5182 | =item sv_2bool |
d8c40edc | 5183 | X<sv_2bool> |
645c22ef DM |
5184 | |
5185 | This function is only called on magical items, and is only used by | |
8cf8f3d1 | 5186 | sv_true() or its macro equivalent. |
645c22ef DM |
5187 | |
5188 | bool sv_2bool(SV* sv) | |
5189 | ||
5190 | =for hackers | |
5191 | Found in file sv.c | |
5192 | ||
5193 | =item sv_2cv | |
d8c40edc | 5194 | X<sv_2cv> |
645c22ef DM |
5195 | |
5196 | Using various gambits, try to get a CV from an SV; in addition, try if | |
5197 | possible to set C<*st> and C<*gvp> to the stash and GV associated with it. | |
9f435386 | 5198 | The flags in C<lref> are passed to sv_fetchsv. |
645c22ef DM |
5199 | |
5200 | CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref) | |
5201 | ||
5202 | =for hackers | |
5203 | Found in file sv.c | |
5204 | ||
5205 | =item sv_2io | |
d8c40edc | 5206 | X<sv_2io> |
645c22ef DM |
5207 | |
5208 | Using various gambits, try to get an IO from an SV: the IO slot if its a | |
5209 | GV; or the recursive result if we're an RV; or the IO slot of the symbol | |
5210 | named after the PV if we're a string. | |
5211 | ||
5212 | IO* sv_2io(SV* sv) | |
5213 | ||
5214 | =for hackers | |
5215 | Found in file sv.c | |
5216 | ||
891f9566 | 5217 | =item sv_2iv_flags |
d8c40edc | 5218 | X<sv_2iv_flags> |
645c22ef | 5219 | |
891f9566 YST |
5220 | Return the integer value of an SV, doing any necessary string |
5221 | conversion. If flags includes SV_GMAGIC, does an mg_get() first. | |
5222 | Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros. | |
645c22ef | 5223 | |
891f9566 | 5224 | IV sv_2iv_flags(SV* sv, I32 flags) |
645c22ef DM |
5225 | |
5226 | =for hackers | |
5227 | Found in file sv.c | |
5228 | ||
954c1994 | 5229 | =item sv_2mortal |
d8c40edc | 5230 | X<sv_2mortal> |
954c1994 | 5231 | |
793edb8a JH |
5232 | Marks an existing SV as mortal. The SV will be destroyed "soon", either |
5233 | by an explicit call to FREETMPS, or by an implicit call at places such as | |
b0bc38e6 NC |
5234 | statement boundaries. SvTEMP() is turned on which means that the SV's |
5235 | string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal> | |
5236 | and C<sv_mortalcopy>. | |
954c1994 GS |
5237 | |
5238 | SV* sv_2mortal(SV* sv) | |
5239 | ||
497711e7 GS |
5240 | =for hackers |
5241 | Found in file sv.c | |
5242 | ||
645c22ef | 5243 | =item sv_2nv |
d8c40edc | 5244 | X<sv_2nv> |
645c22ef DM |
5245 | |
5246 | Return the num value of an SV, doing any necessary string or integer | |
5247 | conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> | |
5248 | macros. | |
5249 | ||
5250 | NV sv_2nv(SV* sv) | |
5251 | ||
5252 | =for hackers | |
5253 | Found in file sv.c | |
5254 | ||
451be7b1 | 5255 | =item sv_2pvbyte |
d8c40edc | 5256 | X<sv_2pvbyte> |
451be7b1 DM |
5257 | |
5258 | Return a pointer to the byte-encoded representation of the SV, and set *lp | |
1e54db1a | 5259 | to its length. May cause the SV to be downgraded from UTF-8 as a |
451be7b1 DM |
5260 | side-effect. |
5261 | ||
5262 | Usually accessed via the C<SvPVbyte> macro. | |
5263 | ||
5264 | char* sv_2pvbyte(SV* sv, STRLEN* lp) | |
5265 | ||
5266 | =for hackers | |
5267 | Found in file sv.c | |
5268 | ||
035cbb0e RGS |
5269 | =item sv_2pvutf8 |
5270 | X<sv_2pvutf8> | |
5271 | ||
5272 | Return a pointer to the UTF-8-encoded representation of the SV, and set *lp | |
5273 | to its length. May cause the SV to be upgraded to UTF-8 as a side-effect. | |
5274 | ||
5275 | Usually accessed via the C<SvPVutf8> macro. | |
5276 | ||
5277 | char* sv_2pvutf8(SV* sv, STRLEN* lp) | |
5278 | ||
5279 | =for hackers | |
5280 | Found in file sv.c | |
5281 | ||
645c22ef | 5282 | =item sv_2pv_flags |
d8c40edc | 5283 | X<sv_2pv_flags> |
645c22ef | 5284 | |
ff276b08 | 5285 | Returns a pointer to the string value of an SV, and sets *lp to its length. |
645c22ef DM |
5286 | If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string |
5287 | if necessary. | |
5288 | Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg> | |
5289 | usually end up here too. | |
5290 | ||
5291 | char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags) | |
5292 | ||
5293 | =for hackers | |
5294 | Found in file sv.c | |
5295 | ||
891f9566 | 5296 | =item sv_2uv_flags |
d8c40edc | 5297 | X<sv_2uv_flags> |
645c22ef DM |
5298 | |
5299 | Return the unsigned integer value of an SV, doing any necessary string | |
891f9566 YST |
5300 | conversion. If flags includes SV_GMAGIC, does an mg_get() first. |
5301 | Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros. | |
645c22ef | 5302 | |
891f9566 | 5303 | UV sv_2uv_flags(SV* sv, I32 flags) |
645c22ef DM |
5304 | |
5305 | =for hackers | |
5306 | Found in file sv.c | |
5307 | ||
5308 | =item sv_backoff | |
d8c40edc | 5309 | X<sv_backoff> |
645c22ef DM |
5310 | |
5311 | Remove any string offset. You should normally use the C<SvOOK_off> macro | |
5312 | wrapper instead. | |
5313 | ||
5314 | int sv_backoff(SV* sv) | |
5315 | ||
5316 | =for hackers | |
5317 | Found in file sv.c | |
5318 | ||
954c1994 | 5319 | =item sv_bless |
d8c40edc | 5320 | X<sv_bless> |
954c1994 GS |
5321 | |
5322 | Blesses an SV into a specified package. The SV must be an RV. The package | |
5323 | must be designated by its stash (see C<gv_stashpv()>). The reference count | |
5324 | of the SV is unaffected. | |
5325 | ||
5326 | SV* sv_bless(SV* sv, HV* stash) | |
5327 | ||
497711e7 GS |
5328 | =for hackers |
5329 | Found in file sv.c | |
5330 | ||
954c1994 | 5331 | =item sv_catpv |
d8c40edc | 5332 | X<sv_catpv> |
954c1994 GS |
5333 | |
5334 | Concatenates the string onto the end of the string which is in the SV. | |
1e54db1a JH |
5335 | If the SV has the UTF-8 status set, then the bytes appended should be |
5336 | valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>. | |
954c1994 GS |
5337 | |
5338 | void sv_catpv(SV* sv, const char* ptr) | |
5339 | ||
497711e7 GS |
5340 | =for hackers |
5341 | Found in file sv.c | |
5342 | ||
954c1994 | 5343 | =item sv_catpvf |
d8c40edc | 5344 | X<sv_catpvf> |
954c1994 | 5345 | |
d5ce4a7c GA |
5346 | Processes its arguments like C<sprintf> and appends the formatted |
5347 | output to an SV. If the appended data contains "wide" characters | |
5348 | (including, but not limited to, SVs with a UTF-8 PV formatted with %s, | |
5349 | and characters >255 formatted with %c), the original SV might get | |
bffc3d17 | 5350 | upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See |
cdd94ca7 NC |
5351 | C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be |
5352 | valid UTF-8; if the original SV was bytes, the pattern should be too. | |
954c1994 GS |
5353 | |
5354 | void sv_catpvf(SV* sv, const char* pat, ...) | |
5355 | ||
497711e7 GS |
5356 | =for hackers |
5357 | Found in file sv.c | |
5358 | ||
954c1994 | 5359 | =item sv_catpvf_mg |
d8c40edc | 5360 | X<sv_catpvf_mg> |
954c1994 GS |
5361 | |
5362 | Like C<sv_catpvf>, but also handles 'set' magic. | |
5363 | ||
5364 | void sv_catpvf_mg(SV *sv, const char* pat, ...) | |
5365 | ||
497711e7 GS |
5366 | =for hackers |
5367 | Found in file sv.c | |
5368 | ||
954c1994 | 5369 | =item sv_catpvn |
d8c40edc | 5370 | X<sv_catpvn> |
954c1994 GS |
5371 | |
5372 | Concatenates the string onto the end of the string which is in the SV. The | |
1e54db1a JH |
5373 | C<len> indicates number of bytes to copy. If the SV has the UTF-8 |
5374 | status set, then the bytes appended should be valid UTF-8. | |
d5ce4a7c | 5375 | Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>. |
954c1994 GS |
5376 | |
5377 | void sv_catpvn(SV* sv, const char* ptr, STRLEN len) | |
5378 | ||
497711e7 GS |
5379 | =for hackers |
5380 | Found in file sv.c | |
5381 | ||
8d6d96c1 | 5382 | =item sv_catpvn_flags |
d8c40edc | 5383 | X<sv_catpvn_flags> |
8d6d96c1 HS |
5384 | |
5385 | Concatenates the string onto the end of the string which is in the SV. The | |
1e54db1a JH |
5386 | C<len> indicates number of bytes to copy. If the SV has the UTF-8 |
5387 | status set, then the bytes appended should be valid UTF-8. | |
8d6d96c1 HS |
5388 | If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if |
5389 | appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented | |
5390 | in terms of this function. | |
5391 | ||
5392 | void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags) | |
5393 | ||
5394 | =for hackers | |
5395 | Found in file sv.c | |
5396 | ||
3fe05580 MHM |
5397 | =item sv_catpvs |
5398 | X<sv_catpvs> | |
5399 | ||
5400 | Like C<sv_catpvn>, but takes a literal string instead of a string/length pair. | |
5401 | ||
f8f4df2c | 5402 | void sv_catpvs(SV* sv, const char* s) |
3fe05580 MHM |
5403 | |
5404 | =for hackers | |
5405 | Found in file handy.h | |
5406 | ||
954c1994 | 5407 | =item sv_catpv_mg |
d8c40edc | 5408 | X<sv_catpv_mg> |
954c1994 GS |
5409 | |
5410 | Like C<sv_catpv>, but also handles 'set' magic. | |
5411 | ||
5412 | void sv_catpv_mg(SV *sv, const char *ptr) | |
5413 | ||
497711e7 GS |
5414 | =for hackers |
5415 | Found in file sv.c | |
5416 | ||
954c1994 | 5417 | =item sv_catsv |
d8c40edc | 5418 | X<sv_catsv> |
954c1994 | 5419 | |
1aa99e6b IH |
5420 | Concatenates the string from SV C<ssv> onto the end of the string in |
5421 | SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but | |
5422 | not 'set' magic. See C<sv_catsv_mg>. | |
954c1994 GS |
5423 | |
5424 | void sv_catsv(SV* dsv, SV* ssv) | |
5425 | ||
497711e7 GS |
5426 | =for hackers |
5427 | Found in file sv.c | |
5428 | ||
8d6d96c1 | 5429 | =item sv_catsv_flags |
d8c40edc | 5430 | X<sv_catsv_flags> |
8d6d96c1 HS |
5431 | |
5432 | Concatenates the string from SV C<ssv> onto the end of the string in | |
5433 | SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC> | |
5434 | bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv> | |
5435 | and C<sv_catsv_nomg> are implemented in terms of this function. | |
5436 | ||
5437 | void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags) | |
5438 | ||
5439 | =for hackers | |
5440 | Found in file sv.c | |
5441 | ||
954c1994 | 5442 | =item sv_chop |
d8c40edc | 5443 | X<sv_chop> |
954c1994 | 5444 | |
1c846c1f | 5445 | Efficient removal of characters from the beginning of the string buffer. |
954c1994 GS |
5446 | SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside |
5447 | the string buffer. The C<ptr> becomes the first character of the adjusted | |
645c22ef | 5448 | string. Uses the "OOK hack". |
3f7c398e | 5449 | Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer |
5c3943b6 | 5450 | refer to the same chunk of data. |
954c1994 | 5451 | |
f54cb97a | 5452 | void sv_chop(SV* sv, const char* ptr) |
954c1994 | 5453 | |
497711e7 GS |
5454 | =for hackers |
5455 | Found in file sv.c | |
5456 | ||
c461cf8f | 5457 | =item sv_clear |
d8c40edc | 5458 | X<sv_clear> |
c461cf8f | 5459 | |
645c22ef DM |
5460 | Clear an SV: call any destructors, free up any memory used by the body, |
5461 | and free the body itself. The SV's head is I<not> freed, although | |
5462 | its type is set to all 1's so that it won't inadvertently be assumed | |
5463 | to be live during global destruction etc. | |
5464 | This function should only be called when REFCNT is zero. Most of the time | |
5465 | you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>) | |
5466 | instead. | |
c461cf8f JH |
5467 | |
5468 | void sv_clear(SV* sv) | |
5469 | ||
5470 | =for hackers | |
5471 | Found in file sv.c | |
5472 | ||
954c1994 | 5473 | =item sv_cmp |
d8c40edc | 5474 | X<sv_cmp> |
954c1994 GS |
5475 | |
5476 | Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the | |
5477 | string in C<sv1> is less than, equal to, or greater than the string in | |
645c22ef DM |
5478 | C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will |
5479 | coerce its args to strings if necessary. See also C<sv_cmp_locale>. | |
954c1994 GS |
5480 | |
5481 | I32 sv_cmp(SV* sv1, SV* sv2) | |
5482 | ||
497711e7 GS |
5483 | =for hackers |
5484 | Found in file sv.c | |
5485 | ||
c461cf8f | 5486 | =item sv_cmp_locale |
d8c40edc | 5487 | X<sv_cmp_locale> |
c461cf8f | 5488 | |
645c22ef DM |
5489 | Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and |
5490 | 'use bytes' aware, handles get magic, and will coerce its args to strings | |
5491 | if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>. | |
c461cf8f JH |
5492 | |
5493 | I32 sv_cmp_locale(SV* sv1, SV* sv2) | |
5494 | ||
5495 | =for hackers | |
5496 | Found in file sv.c | |
5497 | ||
645c22ef | 5498 | =item sv_collxfrm |
d8c40edc | 5499 | X<sv_collxfrm> |
645c22ef DM |
5500 | |
5501 | Add Collate Transform magic to an SV if it doesn't already have it. | |
5502 | ||
5503 | Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the | |
5504 | scalar data of the variable, but transformed to such a format that a normal | |
5505 | memory comparison can be used to compare the data according to the locale | |
5506 | settings. | |
5507 | ||
5508 | char* sv_collxfrm(SV* sv, STRLEN* nxp) | |
5509 | ||
5510 | =for hackers | |
5511 | Found in file sv.c | |
5512 | ||
6050d10e | 5513 | =item sv_copypv |
d8c40edc | 5514 | X<sv_copypv> |
6050d10e JP |
5515 | |
5516 | Copies a stringified representation of the source SV into the | |
5517 | destination SV. Automatically performs any necessary mg_get and | |
9ede5bc8 | 5518 | coercion of numeric values into strings. Guaranteed to preserve |
2575c402 | 5519 | UTF8 flag even from overloaded objects. Similar in nature to |
9ede5bc8 DM |
5520 | sv_2pv[_flags] but operates directly on an SV instead of just the |
5521 | string. Mostly uses sv_2pv_flags to do its work, except when that | |
6050d10e JP |
5522 | would lose the UTF-8'ness of the PV. |
5523 | ||
5524 | void sv_copypv(SV* dsv, SV* ssv) | |
5525 | ||
5526 | =for hackers | |
5527 | Found in file sv.c | |
5528 | ||
954c1994 | 5529 | =item sv_dec |
d8c40edc | 5530 | X<sv_dec> |
954c1994 | 5531 | |
645c22ef DM |
5532 | Auto-decrement of the value in the SV, doing string to numeric conversion |
5533 | if necessary. Handles 'get' magic. | |
954c1994 GS |
5534 | |
5535 | void sv_dec(SV* sv) | |
5536 | ||
497711e7 GS |
5537 | =for hackers |
5538 | Found in file sv.c | |
5539 | ||
954c1994 | 5540 | =item sv_eq |
d8c40edc | 5541 | X<sv_eq> |
954c1994 GS |
5542 | |
5543 | Returns a boolean indicating whether the strings in the two SVs are | |
645c22ef DM |
5544 | identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will |
5545 | coerce its args to strings if necessary. | |
954c1994 GS |
5546 | |
5547 | I32 sv_eq(SV* sv1, SV* sv2) | |
5548 | ||
497711e7 GS |
5549 | =for hackers |
5550 | Found in file sv.c | |
5551 | ||
645c22ef | 5552 | =item sv_force_normal_flags |
d8c40edc | 5553 | X<sv_force_normal_flags> |
645c22ef DM |
5554 | |
5555 | Undo various types of fakery on an SV: if the PV is a shared string, make | |
5556 | a private copy; if we're a ref, stop refing; if we're a glob, downgrade to | |
765f542d NC |
5557 | an xpvmg; if we're a copy-on-write scalar, this is the on-write time when |
5558 | we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set | |
5559 | then a copy-on-write scalar drops its PV buffer (if any) and becomes | |
5560 | SvPOK_off rather than making a copy. (Used where this scalar is about to be | |
d3050d9d | 5561 | set to some other value.) In addition, the C<flags> parameter gets passed to |
765f542d NC |
5562 | C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function |
5563 | with flags set to 0. | |
645c22ef DM |
5564 | |
5565 | void sv_force_normal_flags(SV *sv, U32 flags) | |
5566 | ||
5567 | =for hackers | |
5568 | Found in file sv.c | |
5569 | ||
c461cf8f | 5570 | =item sv_free |
d8c40edc | 5571 | X<sv_free> |
c461cf8f | 5572 | |
645c22ef DM |
5573 | Decrement an SV's reference count, and if it drops to zero, call |
5574 | C<sv_clear> to invoke destructors and free up any memory used by | |
5575 | the body; finally, deallocate the SV's head itself. | |
5576 | Normally called via a wrapper macro C<SvREFCNT_dec>. | |
c461cf8f JH |
5577 | |
5578 | void sv_free(SV* sv) | |
5579 | ||
5580 | =for hackers | |
5581 | Found in file sv.c | |
5582 | ||
5583 | =item sv_gets | |
d8c40edc | 5584 | X<sv_gets> |
c461cf8f JH |
5585 | |
5586 | Get a line from the filehandle and store it into the SV, optionally | |
5587 | appending to the currently-stored string. | |
5588 | ||
5589 | char* sv_gets(SV* sv, PerlIO* fp, I32 append) | |
5590 | ||
5591 | =for hackers | |
5592 | Found in file sv.c | |
5593 | ||
954c1994 | 5594 | =item sv_grow |
d8c40edc | 5595 | X<sv_grow> |
954c1994 | 5596 | |
645c22ef DM |
5597 | Expands the character buffer in the SV. If necessary, uses C<sv_unref> and |
5598 | upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer. | |
5599 | Use the C<SvGROW> wrapper instead. | |
954c1994 GS |
5600 | |
5601 | char* sv_grow(SV* sv, STRLEN newlen) | |
5602 | ||
497711e7 GS |
5603 | =for hackers |
5604 | Found in file sv.c | |
5605 | ||
954c1994 | 5606 | =item sv_inc |
d8c40edc | 5607 | X<sv_inc> |
954c1994 | 5608 | |
645c22ef DM |
5609 | Auto-increment of the value in the SV, doing string to numeric conversion |
5610 | if necessary. Handles 'get' magic. | |
954c1994 GS |
5611 | |
5612 | void sv_inc(SV* sv) | |
5613 | ||
497711e7 GS |
5614 | =for hackers |
5615 | Found in file sv.c | |
5616 | ||
954c1994 | 5617 | =item sv_insert |
d8c40edc | 5618 | X<sv_insert> |
954c1994 GS |
5619 | |
5620 | Inserts a string at the specified offset/length within the SV. Similar to | |
5621 | the Perl substr() function. | |
5622 | ||
e1ec3a88 | 5623 | void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, const char* little, STRLEN littlelen) |
954c1994 | 5624 | |
497711e7 GS |
5625 | =for hackers |
5626 | Found in file sv.c | |
5627 | ||
954c1994 | 5628 | =item sv_isa |
d8c40edc | 5629 | X<sv_isa> |
954c1994 GS |
5630 | |
5631 | Returns a boolean indicating whether the SV is blessed into the specified | |
5632 | class. This does not check for subtypes; use C<sv_derived_from> to verify | |
5633 | an inheritance relationship. | |
5634 | ||
5635 | int sv_isa(SV* sv, const char* name) | |
5636 | ||
497711e7 GS |
5637 | =for hackers |
5638 | Found in file sv.c | |
5639 | ||
954c1994 | 5640 | =item sv_isobject |
d8c40edc | 5641 | X<sv_isobject> |
954c1994 GS |
5642 | |
5643 | Returns a boolean indicating whether the SV is an RV pointing to a blessed | |
5644 | object. If the SV is not an RV, or if the object is not blessed, then this | |
5645 | will return false. | |
5646 | ||
5647 | int sv_isobject(SV* sv) | |
5648 | ||
497711e7 GS |
5649 | =for hackers |
5650 | Found in file sv.c | |
5651 | ||
954c1994 | 5652 | =item sv_len |
d8c40edc | 5653 | X<sv_len> |
954c1994 | 5654 | |
645c22ef DM |
5655 | Returns the length of the string in the SV. Handles magic and type |
5656 | coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot. | |
954c1994 GS |
5657 | |
5658 | STRLEN sv_len(SV* sv) | |
5659 | ||
497711e7 GS |
5660 | =for hackers |
5661 | Found in file sv.c | |
5662 | ||
c461cf8f | 5663 | =item sv_len_utf8 |
d8c40edc | 5664 | X<sv_len_utf8> |
c461cf8f JH |
5665 | |
5666 | Returns the number of characters in the string in an SV, counting wide | |
1e54db1a | 5667 | UTF-8 bytes as a single character. Handles magic and type coercion. |
c461cf8f JH |
5668 | |
5669 | STRLEN sv_len_utf8(SV* sv) | |
5670 | ||
5671 | =for hackers | |
5672 | Found in file sv.c | |
5673 | ||
954c1994 | 5674 | =item sv_magic |
d8c40edc | 5675 | X<sv_magic> |
954c1994 | 5676 | |
645c22ef DM |
5677 | Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary, |
5678 | then adds a new magic item of type C<how> to the head of the magic list. | |
5679 | ||
2d8d5d5a SH |
5680 | See C<sv_magicext> (which C<sv_magic> now calls) for a description of the |
5681 | handling of the C<name> and C<namlen> arguments. | |
5682 | ||
4509d3fb SB |
5683 | You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also |
5684 | to add more than one instance of the same 'how'. | |
5685 | ||
954c1994 GS |
5686 | void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen) |
5687 | ||
497711e7 GS |
5688 | =for hackers |
5689 | Found in file sv.c | |
5690 | ||
a4f1a029 | 5691 | =item sv_magicext |
d8c40edc | 5692 | X<sv_magicext> |
a4f1a029 NIS |
5693 | |
5694 | Adds magic to an SV, upgrading it if necessary. Applies the | |
2d8d5d5a | 5695 | supplied vtable and returns a pointer to the magic added. |
a4f1a029 | 5696 | |
2d8d5d5a SH |
5697 | Note that C<sv_magicext> will allow things that C<sv_magic> will not. |
5698 | In particular, you can add magic to SvREADONLY SVs, and add more than | |
5699 | one instance of the same 'how'. | |
a4f1a029 | 5700 | |
2d8d5d5a SH |
5701 | If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is |
5702 | stored, if C<namlen> is zero then C<name> is stored as-is and - as another | |
5703 | special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed | |
5704 | to contain an C<SV*> and is stored as-is with its REFCNT incremented. | |
a4f1a029 | 5705 | |
2d8d5d5a | 5706 | (This is now used as a subroutine by C<sv_magic>.) |
a4f1a029 | 5707 | |
53d44271 | 5708 | MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen) |
a4f1a029 NIS |
5709 | |
5710 | =for hackers | |
5711 | Found in file sv.c | |
5712 | ||
954c1994 | 5713 | =item sv_mortalcopy |
d8c40edc | 5714 | X<sv_mortalcopy> |
954c1994 | 5715 | |
645c22ef | 5716 | Creates a new SV which is a copy of the original SV (using C<sv_setsv>). |
793edb8a JH |
5717 | The new SV is marked as mortal. It will be destroyed "soon", either by an |
5718 | explicit call to FREETMPS, or by an implicit call at places such as | |
5719 | statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>. | |
954c1994 GS |
5720 | |
5721 | SV* sv_mortalcopy(SV* oldsv) | |
5722 | ||
497711e7 GS |
5723 | =for hackers |
5724 | Found in file sv.c | |
5725 | ||
954c1994 | 5726 | =item sv_newmortal |
d8c40edc | 5727 | X<sv_newmortal> |
954c1994 | 5728 | |
645c22ef | 5729 | Creates a new null SV which is mortal. The reference count of the SV is |
793edb8a JH |
5730 | set to 1. It will be destroyed "soon", either by an explicit call to |
5731 | FREETMPS, or by an implicit call at places such as statement boundaries. | |
5732 | See also C<sv_mortalcopy> and C<sv_2mortal>. | |
954c1994 GS |
5733 | |
5734 | SV* sv_newmortal() | |
5735 | ||
497711e7 GS |
5736 | =for hackers |
5737 | Found in file sv.c | |
5738 | ||
645c22ef | 5739 | =item sv_newref |
d8c40edc | 5740 | X<sv_newref> |
645c22ef DM |
5741 | |
5742 | Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper | |
5743 | instead. | |
5744 | ||
5745 | SV* sv_newref(SV* sv) | |
5746 | ||
5747 | =for hackers | |
5748 | Found in file sv.c | |
5749 | ||
645c22ef | 5750 | =item sv_pos_b2u |
d8c40edc | 5751 | X<sv_pos_b2u> |
645c22ef DM |
5752 | |
5753 | Converts the value pointed to by offsetp from a count of bytes from the | |
1e54db1a | 5754 | start of the string, to a count of the equivalent number of UTF-8 chars. |
645c22ef DM |
5755 | Handles magic and type coercion. |
5756 | ||
5757 | void sv_pos_b2u(SV* sv, I32* offsetp) | |
5758 | ||
5759 | =for hackers | |
5760 | Found in file sv.c | |
5761 | ||
5762 | =item sv_pos_u2b | |
d8c40edc | 5763 | X<sv_pos_u2b> |
645c22ef | 5764 | |
1e54db1a | 5765 | Converts the value pointed to by offsetp from a count of UTF-8 chars from |
645c22ef DM |
5766 | the start of the string, to a count of the equivalent number of bytes; if |
5767 | lenp is non-zero, it does the same to lenp, but this time starting from | |
5768 | the offset, rather than from the start of the string. Handles magic and | |
5769 | type coercion. | |
5770 | ||
5771 | void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp) | |
5772 | ||
5773 | =for hackers | |
5774 | Found in file sv.c | |
5775 | ||
645c22ef | 5776 | =item sv_pvbyten_force |
d8c40edc | 5777 | X<sv_pvbyten_force> |
645c22ef | 5778 | |
9244d4ad | 5779 | The backend for the C<SvPVbytex_force> macro. Always use the macro instead. |
645c22ef DM |
5780 | |
5781 | char* sv_pvbyten_force(SV* sv, STRLEN* lp) | |
5782 | ||
5783 | =for hackers | |
5784 | Found in file sv.c | |
5785 | ||
c461cf8f | 5786 | =item sv_pvn_force |
d8c40edc | 5787 | X<sv_pvn_force> |
c461cf8f JH |
5788 | |
5789 | Get a sensible string out of the SV somehow. | |
645c22ef DM |
5790 | A private implementation of the C<SvPV_force> macro for compilers which |
5791 | can't cope with complex macro expressions. Always use the macro instead. | |
c461cf8f JH |
5792 | |
5793 | char* sv_pvn_force(SV* sv, STRLEN* lp) | |
5794 | ||
5795 | =for hackers | |
5796 | Found in file sv.c | |
5797 | ||
8d6d96c1 | 5798 | =item sv_pvn_force_flags |
d8c40edc | 5799 | X<sv_pvn_force_flags> |
8d6d96c1 HS |
5800 | |
5801 | Get a sensible string out of the SV somehow. | |
5802 | If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if | |
5803 | appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are | |
5804 | implemented in terms of this function. | |
645c22ef DM |
5805 | You normally want to use the various wrapper macros instead: see |
5806 | C<SvPV_force> and C<SvPV_force_nomg> | |
8d6d96c1 HS |
5807 | |
5808 | char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags) | |
5809 | ||
5810 | =for hackers | |
5811 | Found in file sv.c | |
5812 | ||
c461cf8f | 5813 | =item sv_pvutf8n_force |
d8c40edc | 5814 | X<sv_pvutf8n_force> |
c461cf8f | 5815 | |
9244d4ad | 5816 | The backend for the C<SvPVutf8x_force> macro. Always use the macro instead. |
c461cf8f JH |
5817 | |
5818 | char* sv_pvutf8n_force(SV* sv, STRLEN* lp) | |
5819 | ||
5820 | =for hackers | |
5821 | Found in file sv.c | |
5822 | ||
5823 | =item sv_reftype | |
d8c40edc | 5824 | X<sv_reftype> |
c461cf8f JH |
5825 | |
5826 | Returns a string describing what the SV is a reference to. | |
5827 | ||
2b388283 | 5828 | const char* sv_reftype(const SV* sv, int ob) |
c461cf8f JH |
5829 | |
5830 | =for hackers | |
5831 | Found in file sv.c | |
5832 | ||
5833 | =item sv_replace | |
d8c40edc | 5834 | X<sv_replace> |
c461cf8f JH |
5835 | |
5836 | Make the first argument a copy of the second, then delete the original. | |
645c22ef DM |
5837 | The target SV physically takes over ownership of the body of the source SV |
5838 | and inherits its flags; however, the target keeps any magic it owns, | |
5839 | and any magic in the source is discarded. | |
ff276b08 | 5840 | Note that this is a rather specialist SV copying operation; most of the |
645c22ef | 5841 | time you'll want to use C<sv_setsv> or one of its many macro front-ends. |
c461cf8f JH |
5842 | |
5843 | void sv_replace(SV* sv, SV* nsv) | |
5844 | ||
5845 | =for hackers | |
5846 | Found in file sv.c | |
5847 | ||
451be7b1 | 5848 | =item sv_reset |
d8c40edc | 5849 | X<sv_reset> |
451be7b1 DM |
5850 | |
5851 | Underlying implementation for the C<reset> Perl function. | |
5852 | Note that the perl-level function is vaguely deprecated. | |
5853 | ||
e1ec3a88 | 5854 | void sv_reset(const char* s, HV* stash) |
451be7b1 DM |
5855 | |
5856 | =for hackers | |
5857 | Found in file sv.c | |
5858 | ||
c461cf8f | 5859 | =item sv_rvweaken |
d8c40edc | 5860 | X<sv_rvweaken> |
c461cf8f | 5861 | |
645c22ef DM |
5862 | Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the |
5863 | referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and | |
5864 | push a back-reference to this RV onto the array of backreferences | |
1e73acc8 AS |
5865 | associated with that magic. If the RV is magical, set magic will be |
5866 | called after the RV is cleared. | |
c461cf8f JH |
5867 | |
5868 | SV* sv_rvweaken(SV *sv) | |
5869 | ||
5870 | =for hackers | |
5871 | Found in file sv.c | |
5872 | ||
954c1994 | 5873 | =item sv_setiv |
d8c40edc | 5874 | X<sv_setiv> |
954c1994 | 5875 | |
645c22ef DM |
5876 | Copies an integer into the given SV, upgrading first if necessary. |
5877 | Does not handle 'set' magic. See also C<sv_setiv_mg>. | |
954c1994 GS |
5878 | |
5879 | void sv_setiv(SV* sv, IV num) | |
5880 | ||
497711e7 GS |
5881 | =for hackers |
5882 | Found in file sv.c | |
5883 | ||
954c1994 | 5884 | =item sv_setiv_mg |
d8c40edc | 5885 | X<sv_setiv_mg> |
954c1994 GS |
5886 | |
5887 | Like C<sv_setiv>, but also handles 'set' magic. | |
5888 | ||
5889 | void sv_setiv_mg(SV *sv, IV i) | |
5890 | ||
497711e7 GS |
5891 | =for hackers |
5892 | Found in file sv.c | |
5893 | ||
954c1994 | 5894 | =item sv_setnv |
d8c40edc | 5895 | X<sv_setnv> |
954c1994 | 5896 | |
645c22ef DM |
5897 | Copies a double into the given SV, upgrading first if necessary. |
5898 | Does not handle 'set' magic. See also C<sv_setnv_mg>. | |
954c1994 GS |
5899 | |
5900 | void sv_setnv(SV* sv, NV num) | |
5901 | ||
497711e7 GS |
5902 | =for hackers |
5903 | Found in file sv.c | |
5904 | ||
954c1994 | 5905 | =item sv_setnv_mg |
d8c40edc | 5906 | X<sv_setnv_mg> |
954c1994 GS |
5907 | |
5908 | Like C<sv_setnv>, but also handles 'set' magic. | |
5909 | ||
5910 | void sv_setnv_mg(SV *sv, NV num) | |
5911 | ||
497711e7 GS |
5912 | =for hackers |
5913 | Found in file sv.c | |
5914 | ||
954c1994 | 5915 | =item sv_setpv |
d8c40edc | 5916 | X<sv_setpv> |
954c1994 GS |
5917 | |
5918 | Copies a string into an SV. The string must be null-terminated. Does not | |
5919 | handle 'set' magic. See C<sv_setpv_mg>. | |
5920 | ||
5921 | void sv_setpv(SV* sv, const char* ptr) | |
5922 | ||
497711e7 GS |
5923 | =for hackers |
5924 | Found in file sv.c | |
5925 | ||
954c1994 | 5926 | =item sv_setpvf |
d8c40edc | 5927 | X<sv_setpvf> |
954c1994 | 5928 | |
bffc3d17 SH |
5929 | Works like C<sv_catpvf> but copies the text into the SV instead of |
5930 | appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>. | |
954c1994 GS |
5931 | |
5932 | void sv_setpvf(SV* sv, const char* pat, ...) | |
5933 | ||
497711e7 GS |
5934 | =for hackers |
5935 | Found in file sv.c | |
5936 | ||
954c1994 | 5937 | =item sv_setpvf_mg |
d8c40edc | 5938 | X<sv_setpvf_mg> |
954c1994 GS |
5939 | |
5940 | Like C<sv_setpvf>, but also handles 'set' magic. | |
5941 | ||
5942 | void sv_setpvf_mg(SV *sv, const char* pat, ...) | |
5943 | ||
497711e7 GS |
5944 | =for hackers |
5945 | Found in file sv.c | |
5946 | ||
2307c6d0 | 5947 | =item sv_setpviv |
d8c40edc | 5948 | X<sv_setpviv> |
2307c6d0 SB |
5949 | |
5950 | Copies an integer into the given SV, also updating its string value. | |
5951 | Does not handle 'set' magic. See C<sv_setpviv_mg>. | |
5952 | ||
5953 | void sv_setpviv(SV* sv, IV num) | |
5954 | ||
5955 | =for hackers | |
5956 | Found in file sv.c | |
5957 | ||
5958 | =item sv_setpviv_mg | |
d8c40edc | 5959 | X<sv_setpviv_mg> |
2307c6d0 SB |
5960 | |
5961 | Like C<sv_setpviv>, but also handles 'set' magic. | |
5962 | ||
5963 | void sv_setpviv_mg(SV *sv, IV iv) | |
5964 | ||
5965 | =for hackers | |
5966 | Found in file sv.c | |
5967 | ||
954c1994 | 5968 | =item sv_setpvn |
d8c40edc | 5969 | X<sv_setpvn> |
954c1994 GS |
5970 | |
5971 | Copies a string into an SV. The C<len> parameter indicates the number of | |
9e09f5f2 MHM |
5972 | bytes to be copied. If the C<ptr> argument is NULL the SV will become |
5973 | undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>. | |
954c1994 GS |
5974 | |
5975 | void sv_setpvn(SV* sv, const char* ptr, STRLEN len) | |
5976 | ||
497711e7 GS |
5977 | =for hackers |
5978 | Found in file sv.c | |
5979 | ||
954c1994 | 5980 | =item sv_setpvn_mg |
d8c40edc | 5981 | X<sv_setpvn_mg> |
954c1994 GS |
5982 | |
5983 | Like C<sv_setpvn>, but also handles 'set' magic. | |
5984 | ||
5985 | void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len) | |
5986 | ||
497711e7 GS |
5987 | =for hackers |
5988 | Found in file sv.c | |
5989 | ||
3fe05580 MHM |
5990 | =item sv_setpvs |
5991 | X<sv_setpvs> | |
5992 | ||
5993 | Like C<sv_setpvn>, but takes a literal string instead of a string/length pair. | |
5994 | ||
f8f4df2c | 5995 | void sv_setpvs(SV* sv, const char* s) |
3fe05580 MHM |
5996 | |
5997 | =for hackers | |
5998 | Found in file handy.h | |
5999 | ||
954c1994 | 6000 | =item sv_setpv_mg |
d8c40edc | 6001 | X<sv_setpv_mg> |
954c1994 GS |
6002 | |
6003 | Like C<sv_setpv>, but also handles 'set' magic. | |
6004 | ||
6005 | void sv_setpv_mg(SV *sv, const char *ptr) | |
6006 | ||
497711e7 GS |
6007 | =for hackers |
6008 | Found in file sv.c | |
6009 | ||
954c1994 | 6010 | =item sv_setref_iv |
d8c40edc | 6011 | X<sv_setref_iv> |
954c1994 GS |
6012 | |
6013 | Copies an integer into a new SV, optionally blessing the SV. The C<rv> | |
6014 | argument will be upgraded to an RV. That RV will be modified to point to | |
6015 | the new SV. The C<classname> argument indicates the package for the | |
bd61b366 | 6016 | blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV |
d34c2299 | 6017 | will have a reference count of 1, and the RV will be returned. |
954c1994 GS |
6018 | |
6019 | SV* sv_setref_iv(SV* rv, const char* classname, IV iv) | |
6020 | ||
497711e7 GS |
6021 | =for hackers |
6022 | Found in file sv.c | |
6023 | ||
954c1994 | 6024 | =item sv_setref_nv |
d8c40edc | 6025 | X<sv_setref_nv> |
954c1994 GS |
6026 | |
6027 | Copies a double into a new SV, optionally blessing the SV. The C<rv> | |
6028 | argument will be upgraded to an RV. That RV will be modified to point to | |
6029 | the new SV. The C<classname> argument indicates the package for the | |
bd61b366 | 6030 | blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV |
d34c2299 | 6031 | will have a reference count of 1, and the RV will be returned. |
954c1994 GS |
6032 | |
6033 | SV* sv_setref_nv(SV* rv, const char* classname, NV nv) | |
6034 | ||
497711e7 GS |
6035 | =for hackers |
6036 | Found in file sv.c | |
6037 | ||
954c1994 | 6038 | =item sv_setref_pv |
d8c40edc | 6039 | X<sv_setref_pv> |
954c1994 GS |
6040 | |
6041 | Copies a pointer into a new SV, optionally blessing the SV. The C<rv> | |
6042 | argument will be upgraded to an RV. That RV will be modified to point to | |
6043 | the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed | |
6044 | into the SV. The C<classname> argument indicates the package for the | |
bd61b366 | 6045 | blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV |
d34c2299 | 6046 | will have a reference count of 1, and the RV will be returned. |
954c1994 GS |
6047 | |
6048 | Do not use with other Perl types such as HV, AV, SV, CV, because those | |
6049 | objects will become corrupted by the pointer copy process. | |
6050 | ||
6051 | Note that C<sv_setref_pvn> copies the string while this copies the pointer. | |
6052 | ||
6053 | SV* sv_setref_pv(SV* rv, const char* classname, void* pv) | |
6054 | ||
497711e7 GS |
6055 | =for hackers |
6056 | Found in file sv.c | |
6057 | ||
954c1994 | 6058 | =item sv_setref_pvn |
d8c40edc | 6059 | X<sv_setref_pvn> |
954c1994 GS |
6060 | |
6061 | Copies a string into a new SV, optionally blessing the SV. The length of the | |
6062 | string must be specified with C<n>. The C<rv> argument will be upgraded to | |
6063 | an RV. That RV will be modified to point to the new SV. The C<classname> | |
6064 | argument indicates the package for the blessing. Set C<classname> to | |
bd61b366 | 6065 | C<NULL> to avoid the blessing. The new SV will have a reference count |
d34c2299 | 6066 | of 1, and the RV will be returned. |
954c1994 GS |
6067 | |
6068 | Note that C<sv_setref_pv> copies the pointer while this copies the string. | |
6069 | ||
1b6737cc | 6070 | SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n) |
954c1994 | 6071 | |
497711e7 GS |
6072 | =for hackers |
6073 | Found in file sv.c | |
6074 | ||
e1c57cef | 6075 | =item sv_setref_uv |
d8c40edc | 6076 | X<sv_setref_uv> |
e1c57cef JH |
6077 | |
6078 | Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv> | |
6079 | argument will be upgraded to an RV. That RV will be modified to point to | |
6080 | the new SV. The C<classname> argument indicates the package for the | |
bd61b366 | 6081 | blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV |
d34c2299 | 6082 | will have a reference count of 1, and the RV will be returned. |
e1c57cef JH |
6083 | |
6084 | SV* sv_setref_uv(SV* rv, const char* classname, UV uv) | |
6085 | ||
6086 | =for hackers | |
6087 | Found in file sv.c | |
6088 | ||
954c1994 | 6089 | =item sv_setsv |
d8c40edc | 6090 | X<sv_setsv> |
954c1994 | 6091 | |
645c22ef DM |
6092 | Copies the contents of the source SV C<ssv> into the destination SV |
6093 | C<dsv>. The source SV may be destroyed if it is mortal, so don't use this | |
6094 | function if the source SV needs to be reused. Does not handle 'set' magic. | |
6095 | Loosely speaking, it performs a copy-by-value, obliterating any previous | |
6096 | content of the destination. | |
6097 | ||
6098 | You probably want to use one of the assortment of wrappers, such as | |
6099 | C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and | |
6100 | C<SvSetMagicSV_nosteal>. | |
6101 | ||
954c1994 GS |
6102 | void sv_setsv(SV* dsv, SV* ssv) |
6103 | ||
497711e7 GS |
6104 | =for hackers |
6105 | Found in file sv.c | |
6106 | ||
8d6d96c1 | 6107 | =item sv_setsv_flags |
d8c40edc | 6108 | X<sv_setsv_flags> |
8d6d96c1 | 6109 | |
645c22ef DM |
6110 | Copies the contents of the source SV C<ssv> into the destination SV |
6111 | C<dsv>. The source SV may be destroyed if it is mortal, so don't use this | |
6112 | function if the source SV needs to be reused. Does not handle 'set' magic. | |
6113 | Loosely speaking, it performs a copy-by-value, obliterating any previous | |
6114 | content of the destination. | |
6115 | If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on | |
2d8d5d5a SH |
6116 | C<ssv> if appropriate, else not. If the C<flags> parameter has the |
6117 | C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv> | |
6118 | and C<sv_setsv_nomg> are implemented in terms of this function. | |
645c22ef DM |
6119 | |
6120 | You probably want to use one of the assortment of wrappers, such as | |
6121 | C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and | |
6122 | C<SvSetMagicSV_nosteal>. | |
6123 | ||
6124 | This is the primary function for copying scalars, and most other | |
6125 | copy-ish functions and macros use this underneath. | |
8d6d96c1 HS |
6126 | |
6127 | void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags) | |
6128 | ||
6129 | =for hackers | |
6130 | Found in file sv.c | |
6131 | ||
954c1994 | 6132 | =item sv_setsv_mg |
d8c40edc | 6133 | X<sv_setsv_mg> |
954c1994 GS |
6134 | |
6135 | Like C<sv_setsv>, but also handles 'set' magic. | |
6136 | ||
6137 | void sv_setsv_mg(SV *dstr, SV *sstr) | |
6138 | ||
497711e7 GS |
6139 | =for hackers |
6140 | Found in file sv.c | |
6141 | ||
954c1994 | 6142 | =item sv_setuv |
d8c40edc | 6143 | X<sv_setuv> |
954c1994 | 6144 | |
645c22ef DM |
6145 | Copies an unsigned integer into the given SV, upgrading first if necessary. |
6146 | Does not handle 'set' magic. See also C<sv_setuv_mg>. | |
954c1994 GS |
6147 | |
6148 | void sv_setuv(SV* sv, UV num) | |
6149 | ||
497711e7 GS |
6150 | =for hackers |
6151 | Found in file sv.c | |
6152 | ||
954c1994 | 6153 | =item sv_setuv_mg |
d8c40edc | 6154 | X<sv_setuv_mg> |
954c1994 GS |
6155 | |
6156 | Like C<sv_setuv>, but also handles 'set' magic. | |
6157 | ||
6158 | void sv_setuv_mg(SV *sv, UV u) | |
6159 | ||
497711e7 GS |
6160 | =for hackers |
6161 | Found in file sv.c | |
6162 | ||
451be7b1 | 6163 | =item sv_tainted |
d8c40edc | 6164 | X<sv_tainted> |
451be7b1 DM |
6165 | |
6166 | Test an SV for taintedness. Use C<SvTAINTED> instead. | |
6167 | bool sv_tainted(SV* sv) | |
6168 | ||
6169 | =for hackers | |
6170 | Found in file sv.c | |
6171 | ||
c461cf8f | 6172 | =item sv_true |
d8c40edc | 6173 | X<sv_true> |
c461cf8f JH |
6174 | |
6175 | Returns true if the SV has a true value by Perl's rules. | |
645c22ef DM |
6176 | Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may |
6177 | instead use an in-line version. | |
c461cf8f JH |
6178 | |
6179 | I32 sv_true(SV *sv) | |
6180 | ||
6181 | =for hackers | |
6182 | Found in file sv.c | |
6183 | ||
6184 | =item sv_unmagic | |
d8c40edc | 6185 | X<sv_unmagic> |
c461cf8f | 6186 | |
645c22ef | 6187 | Removes all magic of type C<type> from an SV. |
c461cf8f JH |
6188 | |
6189 | int sv_unmagic(SV* sv, int type) | |
6190 | ||
6191 | =for hackers | |
6192 | Found in file sv.c | |
6193 | ||
840a7b70 | 6194 | =item sv_unref_flags |
d8c40edc | 6195 | X<sv_unref_flags> |
840a7b70 IZ |
6196 | |
6197 | Unsets the RV status of the SV, and decrements the reference count of | |
6198 | whatever was being referenced by the RV. This can almost be thought of | |
6199 | as a reversal of C<newSVrv>. The C<cflags> argument can contain | |
6200 | C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented | |
6201 | (otherwise the decrementing is conditional on the reference count being | |
6202 | different from one or the reference being a readonly SV). | |
ae154d6d | 6203 | See C<SvROK_off>. |
840a7b70 IZ |
6204 | |
6205 | void sv_unref_flags(SV* sv, U32 flags) | |
6206 | ||
6207 | =for hackers | |
6208 | Found in file sv.c | |
6209 | ||
451be7b1 | 6210 | =item sv_untaint |
d8c40edc | 6211 | X<sv_untaint> |
451be7b1 DM |
6212 | |
6213 | Untaint an SV. Use C<SvTAINTED_off> instead. | |
6214 | void sv_untaint(SV* sv) | |
6215 | ||
6216 | =for hackers | |
6217 | Found in file sv.c | |
6218 | ||
954c1994 | 6219 | =item sv_upgrade |
d8c40edc | 6220 | X<sv_upgrade> |
954c1994 | 6221 | |
ff276b08 | 6222 | Upgrade an SV to a more complex form. Generally adds a new body type to the |
645c22ef | 6223 | SV, then copies across as much information as possible from the old body. |
ff276b08 | 6224 | You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>. |
954c1994 | 6225 | |
42d0e0b7 | 6226 | void sv_upgrade(SV* sv, svtype new_type) |
954c1994 | 6227 | |
497711e7 GS |
6228 | =for hackers |
6229 | Found in file sv.c | |
6230 | ||
fed01289 SP |
6231 | =item sv_usepvn_flags |
6232 | X<sv_usepvn_flags> | |
954c1994 | 6233 | |
794a0d33 JH |
6234 | Tells an SV to use C<ptr> to find its string value. Normally the |
6235 | string is stored inside the SV but sv_usepvn allows the SV to use an | |
6236 | outside string. The C<ptr> should point to memory that was allocated | |
fed01289 SP |
6237 | by C<malloc>. The string length, C<len>, must be supplied. By default |
6238 | this function will realloc (i.e. move) the memory pointed to by C<ptr>, | |
794a0d33 JH |
6239 | so that pointer should not be freed or used by the programmer after |
6240 | giving it to sv_usepvn, and neither should any pointers from "behind" | |
fed01289 | 6241 | that pointer (e.g. ptr + 1) be used. |
954c1994 | 6242 | |
fed01289 SP |
6243 | If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> & |
6244 | SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc | |
cbf82dd0 | 6245 | will be skipped. (i.e. the buffer is actually at least 1 byte longer than |
fed01289 | 6246 | C<len>, and already meets the requirements for storing in C<SvPVX>) |
954c1994 | 6247 | |
fed01289 | 6248 | void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags) |
954c1994 | 6249 | |
497711e7 GS |
6250 | =for hackers |
6251 | Found in file sv.c | |
6252 | ||
2457d041 | 6253 | =item sv_utf8_decode |
d8c40edc | 6254 | X<sv_utf8_decode> |
2457d041 | 6255 | |
78ea37eb TS |
6256 | If the PV of the SV is an octet sequence in UTF-8 |
6257 | and contains a multiple-byte character, the C<SvUTF8> flag is turned on | |
6258 | so that it looks like a character. If the PV contains only single-byte | |
6259 | characters, the C<SvUTF8> flag stays being off. | |
6260 | Scans PV for validity and returns false if the PV is invalid UTF-8. | |
2457d041 JH |
6261 | |
6262 | NOTE: this function is experimental and may change or be | |
6263 | removed without notice. | |
6264 | ||
6265 | bool sv_utf8_decode(SV *sv) | |
6266 | ||
6267 | =for hackers | |
6268 | Found in file sv.c | |
6269 | ||
c461cf8f | 6270 | =item sv_utf8_downgrade |
d8c40edc | 6271 | X<sv_utf8_downgrade> |
c461cf8f | 6272 | |
78ea37eb TS |
6273 | Attempts to convert the PV of an SV from characters to bytes. |
6274 | If the PV contains a character beyond byte, this conversion will fail; | |
6275 | in this case, either returns false or, if C<fail_ok> is not | |
c461cf8f JH |
6276 | true, croaks. |
6277 | ||
9ede5bc8 DM |
6278 | This is not as a general purpose Unicode to byte encoding interface: |
6279 | use the Encode extension for that. | |
6280 | ||
c461cf8f JH |
6281 | NOTE: this function is experimental and may change or be |
6282 | removed without notice. | |
6283 | ||
6284 | bool sv_utf8_downgrade(SV *sv, bool fail_ok) | |
6285 | ||
6286 | =for hackers | |
6287 | Found in file sv.c | |
6288 | ||
6289 | =item sv_utf8_encode | |
d8c40edc | 6290 | X<sv_utf8_encode> |
c461cf8f | 6291 | |
78ea37eb TS |
6292 | Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8> |
6293 | flag off so that it looks like octets again. | |
c461cf8f JH |
6294 | |
6295 | void sv_utf8_encode(SV *sv) | |
6296 | ||
6297 | =for hackers | |
6298 | Found in file sv.c | |
6299 | ||
6300 | =item sv_utf8_upgrade | |
d8c40edc | 6301 | X<sv_utf8_upgrade> |
c461cf8f | 6302 | |
78ea37eb | 6303 | Converts the PV of an SV to its UTF-8-encoded form. |
645c22ef | 6304 | Forces the SV to string form if it is not already. |
2457d041 JH |
6305 | Always sets the SvUTF8 flag to avoid future validity checks even |
6306 | if all the bytes have hibit clear. | |
c461cf8f | 6307 | |
9ede5bc8 DM |
6308 | This is not as a general purpose byte encoding to Unicode interface: |
6309 | use the Encode extension for that. | |
6310 | ||
2457d041 | 6311 | STRLEN sv_utf8_upgrade(SV *sv) |
c461cf8f JH |
6312 | |
6313 | =for hackers | |
6314 | Found in file sv.c | |
6315 | ||
8d6d96c1 | 6316 | =item sv_utf8_upgrade_flags |
d8c40edc | 6317 | X<sv_utf8_upgrade_flags> |
8d6d96c1 | 6318 | |
78ea37eb | 6319 | Converts the PV of an SV to its UTF-8-encoded form. |
645c22ef | 6320 | Forces the SV to string form if it is not already. |
8d6d96c1 HS |
6321 | Always sets the SvUTF8 flag to avoid future validity checks even |
6322 | if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set, | |
6323 | will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and | |
6324 | C<sv_utf8_upgrade_nomg> are implemented in terms of this function. | |
6325 | ||
9ede5bc8 DM |
6326 | This is not as a general purpose byte encoding to Unicode interface: |
6327 | use the Encode extension for that. | |
6328 | ||
8d6d96c1 HS |
6329 | STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags) |
6330 | ||
6331 | =for hackers | |
6332 | Found in file sv.c | |
6333 | ||
bffc3d17 | 6334 | =item sv_vcatpvf |
d8c40edc | 6335 | X<sv_vcatpvf> |
bffc3d17 SH |
6336 | |
6337 | Processes its arguments like C<vsprintf> and appends the formatted output | |
6338 | to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>. | |
6339 | ||
6340 | Usually used via its frontend C<sv_catpvf>. | |
6341 | ||
6342 | void sv_vcatpvf(SV* sv, const char* pat, va_list* args) | |
6343 | ||
6344 | =for hackers | |
6345 | Found in file sv.c | |
6346 | ||
954c1994 | 6347 | =item sv_vcatpvfn |
d8c40edc | 6348 | X<sv_vcatpvfn> |
954c1994 GS |
6349 | |
6350 | Processes its arguments like C<vsprintf> and appends the formatted output | |
6351 | to an SV. Uses an array of SVs if the C style variable argument list is | |
6352 | missing (NULL). When running with taint checks enabled, indicates via | |
6353 | C<maybe_tainted> if results are untrustworthy (often due to the use of | |
6354 | locales). | |
6355 | ||
bffc3d17 | 6356 | Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>. |
645c22ef | 6357 | |
954c1994 GS |
6358 | void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted) |
6359 | ||
497711e7 GS |
6360 | =for hackers |
6361 | Found in file sv.c | |
6362 | ||
bffc3d17 | 6363 | =item sv_vcatpvf_mg |
d8c40edc | 6364 | X<sv_vcatpvf_mg> |
bffc3d17 SH |
6365 | |
6366 | Like C<sv_vcatpvf>, but also handles 'set' magic. | |
6367 | ||
6368 | Usually used via its frontend C<sv_catpvf_mg>. | |
6369 | ||
6370 | void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args) | |
6371 | ||
6372 | =for hackers | |
6373 | Found in file sv.c | |
6374 | ||
6375 | =item sv_vsetpvf | |
d8c40edc | 6376 | X<sv_vsetpvf> |
bffc3d17 SH |
6377 | |
6378 | Works like C<sv_vcatpvf> but copies the text into the SV instead of | |
6379 | appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>. | |
6380 | ||
6381 | Usually used via its frontend C<sv_setpvf>. | |
6382 | ||
6383 | void sv_vsetpvf(SV* sv, const char* pat, va_list* args) | |
6384 | ||
6385 | =for hackers | |
6386 | Found in file sv.c | |
6387 | ||
954c1994 | 6388 | =item sv_vsetpvfn |
d8c40edc | 6389 | X<sv_vsetpvfn> |
954c1994 | 6390 | |
bffc3d17 | 6391 | Works like C<sv_vcatpvfn> but copies the text into the SV instead of |
954c1994 GS |
6392 | appending it. |
6393 | ||
bffc3d17 | 6394 | Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>. |
645c22ef | 6395 | |
954c1994 GS |
6396 | void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted) |
6397 | ||
497711e7 | 6398 | =for hackers |
94bdecf9 JH |
6399 | Found in file sv.c |
6400 | ||
bffc3d17 | 6401 | =item sv_vsetpvf_mg |
d8c40edc | 6402 | X<sv_vsetpvf_mg> |
bffc3d17 SH |
6403 | |
6404 | Like C<sv_vsetpvf>, but also handles 'set' magic. | |
6405 | ||
6406 | Usually used via its frontend C<sv_setpvf_mg>. | |
6407 | ||
6408 | void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args) | |
6409 | ||
6410 | =for hackers | |
6411 | Found in file sv.c | |
6412 | ||
94bdecf9 JH |
6413 | |
6414 | =back | |
6415 | ||
6416 | =head1 Unicode Support | |
6417 | ||
6418 | =over 8 | |
6419 | ||
6420 | =item bytes_from_utf8 | |
d8c40edc | 6421 | X<bytes_from_utf8> |
94bdecf9 | 6422 | |
1e54db1a | 6423 | Converts a string C<s> of length C<len> from UTF-8 into byte encoding. |
35a4481c | 6424 | Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to |
94bdecf9 JH |
6425 | the newly-created string, and updates C<len> to contain the new |
6426 | length. Returns the original string if no conversion occurs, C<len> | |
6427 | is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to | |
6428 | 0 if C<s> is converted or contains all 7bit characters. | |
6429 | ||
6430 | NOTE: this function is experimental and may change or be | |
6431 | removed without notice. | |
6432 | ||
e1ec3a88 | 6433 | U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8) |
94bdecf9 JH |
6434 | |
6435 | =for hackers | |
6436 | Found in file utf8.c | |
6437 | ||
6438 | =item bytes_to_utf8 | |
d8c40edc | 6439 | X<bytes_to_utf8> |
94bdecf9 | 6440 | |
1e54db1a | 6441 | Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding. |
94bdecf9 JH |
6442 | Returns a pointer to the newly-created string, and sets C<len> to |
6443 | reflect the new length. | |
6444 | ||
1e54db1a | 6445 | If you want to convert to UTF-8 from other encodings than ASCII, |
bd5cf849 HS |
6446 | see sv_recode_to_utf8(). |
6447 | ||
94bdecf9 JH |
6448 | NOTE: this function is experimental and may change or be |
6449 | removed without notice. | |
6450 | ||
35a4481c | 6451 | U8* bytes_to_utf8(const U8 *s, STRLEN *len) |
94bdecf9 JH |
6452 | |
6453 | =for hackers | |
6454 | Found in file utf8.c | |
6455 | ||
6456 | =item ibcmp_utf8 | |
d8c40edc | 6457 | X<ibcmp_utf8> |
94bdecf9 JH |
6458 | |
6459 | Return true if the strings s1 and s2 differ case-insensitively, false | |
6460 | if not (if they are equal case-insensitively). If u1 is true, the | |
6461 | string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true, | |
6462 | the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2 | |
6463 | are false, the respective string is assumed to be in native 8-bit | |
6464 | encoding. | |
6465 | ||
6466 | If the pe1 and pe2 are non-NULL, the scanning pointers will be copied | |
6467 | in there (they will point at the beginning of the I<next> character). | |
6468 | If the pointers behind pe1 or pe2 are non-NULL, they are the end | |
6469 | pointers beyond which scanning will not continue under any | |
fa11829f | 6470 | circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and |
94bdecf9 JH |
6471 | s2+l2 will be used as goal end pointers that will also stop the scan, |
6472 | and which qualify towards defining a successful match: all the scans | |
6473 | that define an explicit length must reach their goal pointers for | |
6474 | a match to succeed). | |
6475 | ||
6476 | For case-insensitiveness, the "casefolding" of Unicode is used | |
6477 | instead of upper/lowercasing both the characters, see | |
6478 | http://www.unicode.org/unicode/reports/tr21/ (Case Mappings). | |
6479 | ||
6480 | I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2) | |
6481 | ||
6482 | =for hackers | |
6483 | Found in file utf8.c | |
6484 | ||
6485 | =item is_utf8_char | |
d8c40edc | 6486 | X<is_utf8_char> |
94bdecf9 JH |
6487 | |
6488 | Tests if some arbitrary number of bytes begins in a valid UTF-8 | |
641d4181 JH |
6489 | character. Note that an INVARIANT (i.e. ASCII) character is a valid |
6490 | UTF-8 character. The actual number of bytes in the UTF-8 character | |
6491 | will be returned if it is valid, otherwise 0. | |
94bdecf9 | 6492 | |
7fc63493 | 6493 | STRLEN is_utf8_char(const U8 *p) |
94bdecf9 JH |
6494 | |
6495 | =for hackers | |
6496 | Found in file utf8.c | |
6497 | ||
6498 | =item is_utf8_string | |
d8c40edc | 6499 | X<is_utf8_string> |
94bdecf9 | 6500 | |
bd5cf849 | 6501 | Returns true if first C<len> bytes of the given string form a valid |
1e54db1a JH |
6502 | UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does |
6503 | not mean 'a string that contains code points above 0x7F encoded in UTF-8' | |
6504 | because a valid ASCII string is a valid UTF-8 string. | |
94bdecf9 | 6505 | |
768c67ee JH |
6506 | See also is_utf8_string_loclen() and is_utf8_string_loc(). |
6507 | ||
7fc63493 | 6508 | bool is_utf8_string(const U8 *s, STRLEN len) |
94bdecf9 JH |
6509 | |
6510 | =for hackers | |
6511 | Found in file utf8.c | |
497711e7 | 6512 | |
72d6ef7d | 6513 | =item is_utf8_string_loc |
d8c40edc | 6514 | X<is_utf8_string_loc> |
72d6ef7d | 6515 | |
9244d4ad | 6516 | Like is_utf8_string() but stores the location of the failure (in the |
768c67ee JH |
6517 | case of "utf8ness failure") or the location s+len (in the case of |
6518 | "utf8ness success") in the C<ep>. | |
6519 | ||
6520 | See also is_utf8_string_loclen() and is_utf8_string(). | |
72d6ef7d | 6521 | |
7fc63493 | 6522 | bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p) |
72d6ef7d JH |
6523 | |
6524 | =for hackers | |
6525 | Found in file utf8.c | |
6526 | ||
768c67ee | 6527 | =item is_utf8_string_loclen |
d8c40edc | 6528 | X<is_utf8_string_loclen> |
768c67ee | 6529 | |
9244d4ad | 6530 | Like is_utf8_string() but stores the location of the failure (in the |
768c67ee JH |
6531 | case of "utf8ness failure") or the location s+len (in the case of |
6532 | "utf8ness success") in the C<ep>, and the number of UTF-8 | |
6533 | encoded characters in the C<el>. | |
6534 | ||
6535 | See also is_utf8_string_loc() and is_utf8_string(). | |
6536 | ||
6537 | bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el) | |
6538 | ||
6539 | =for hackers | |
6540 | Found in file utf8.c | |
6541 | ||
94bdecf9 | 6542 | =item pv_uni_display |
d8c40edc | 6543 | X<pv_uni_display> |
954c1994 | 6544 | |
94bdecf9 JH |
6545 | Build to the scalar dsv a displayable version of the string spv, |
6546 | length len, the displayable version being at most pvlim bytes long | |
6547 | (if longer, the rest is truncated and "..." will be appended). | |
0a2ef054 JH |
6548 | |
6549 | The flags argument can have UNI_DISPLAY_ISPRINT set to display | |
a4f1a029 | 6550 | isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH |
0a2ef054 JH |
6551 | to display the \\[nrfta\\] as the backslashed versions (like '\n') |
6552 | (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\). | |
6553 | UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both | |
6554 | UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on. | |
6555 | ||
94bdecf9 | 6556 | The pointer to the PV of the dsv is returned. |
954c1994 | 6557 | |
e1ec3a88 | 6558 | char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags) |
954c1994 | 6559 | |
497711e7 | 6560 | =for hackers |
94bdecf9 | 6561 | Found in file utf8.c |
497711e7 | 6562 | |
220e2d4e | 6563 | =item sv_cat_decode |
d8c40edc | 6564 | X<sv_cat_decode> |
220e2d4e IH |
6565 | |
6566 | The encoding is assumed to be an Encode object, the PV of the ssv is | |
6567 | assumed to be octets in that encoding and decoding the input starts | |
6568 | from the position which (PV + *offset) pointed to. The dsv will be | |
6569 | concatenated the decoded UTF-8 string from ssv. Decoding will terminate | |
6570 | when the string tstr appears in decoding output or the input ends on | |
6571 | the PV of the ssv. The value which the offset points will be modified | |
6572 | to the last input position on the ssv. | |
6573 | ||
6574 | Returns TRUE if the terminator was found, else returns FALSE. | |
6575 | ||
6576 | bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen) | |
6577 | ||
6578 | =for hackers | |
6579 | Found in file sv.c | |
6580 | ||
94bdecf9 | 6581 | =item sv_recode_to_utf8 |
d8c40edc | 6582 | X<sv_recode_to_utf8> |
954c1994 | 6583 | |
94bdecf9 JH |
6584 | The encoding is assumed to be an Encode object, on entry the PV |
6585 | of the sv is assumed to be octets in that encoding, and the sv | |
6586 | will be converted into Unicode (and UTF-8). | |
954c1994 | 6587 | |
94bdecf9 JH |
6588 | If the sv already is UTF-8 (or if it is not POK), or if the encoding |
6589 | is not a reference, nothing is done to the sv. If the encoding is not | |
6590 | an C<Encode::XS> Encoding object, bad things will happen. | |
6591 | (See F<lib/encoding.pm> and L<Encode>). | |
6592 | ||
6593 | The PV of the sv is returned. | |
6594 | ||
6595 | char* sv_recode_to_utf8(SV* sv, SV *encoding) | |
954c1994 | 6596 | |
497711e7 | 6597 | =for hackers |
94bdecf9 | 6598 | Found in file sv.c |
497711e7 | 6599 | |
94bdecf9 | 6600 | =item sv_uni_display |
d8c40edc | 6601 | X<sv_uni_display> |
954c1994 | 6602 | |
94bdecf9 | 6603 | Build to the scalar dsv a displayable version of the scalar sv, |
0a2ef054 | 6604 | the displayable version being at most pvlim bytes long |
94bdecf9 | 6605 | (if longer, the rest is truncated and "..." will be appended). |
0a2ef054 JH |
6606 | |
6607 | The flags argument is as in pv_uni_display(). | |
6608 | ||
94bdecf9 | 6609 | The pointer to the PV of the dsv is returned. |
954c1994 | 6610 | |
94bdecf9 | 6611 | char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags) |
954c1994 | 6612 | |
497711e7 | 6613 | =for hackers |
94bdecf9 | 6614 | Found in file utf8.c |
497711e7 | 6615 | |
6b5c0936 | 6616 | =item to_utf8_case |
d8c40edc | 6617 | X<to_utf8_case> |
6b5c0936 JH |
6618 | |
6619 | The "p" contains the pointer to the UTF-8 string encoding | |
6620 | the character that is being converted. | |
6621 | ||
6622 | The "ustrp" is a pointer to the character buffer to put the | |
6623 | conversion result to. The "lenp" is a pointer to the length | |
6624 | of the result. | |
6625 | ||
12b7c5c7 | 6626 | The "swashp" is a pointer to the swash to use. |
6b5c0936 | 6627 | |
12b7c5c7 | 6628 | Both the special and normal mappings are stored lib/unicore/To/Foo.pl, |
979f2922 | 6629 | and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually, |
12b7c5c7 JH |
6630 | but not always, a multicharacter mapping), is tried first. |
6631 | ||
6632 | The "special" is a string like "utf8::ToSpecLower", which means the | |
6633 | hash %utf8::ToSpecLower. The access to the hash is through | |
6634 | Perl_to_utf8_case(). | |
6b5c0936 | 6635 | |
12b7c5c7 JH |
6636 | The "normal" is a string like "ToLower" which means the swash |
6637 | %utf8::ToLower. | |
6b5c0936 | 6638 | |
9a957fbc | 6639 | UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special) |
6b5c0936 JH |
6640 | |
6641 | =for hackers | |
6642 | Found in file utf8.c | |
6643 | ||
d3e79532 | 6644 | =item to_utf8_fold |
d8c40edc | 6645 | X<to_utf8_fold> |
d3e79532 JH |
6646 | |
6647 | Convert the UTF-8 encoded character at p to its foldcase version and | |
6648 | store that in UTF-8 in ustrp and its length in bytes in lenp. Note | |
59887a99 | 6649 | that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the |
d3e79532 JH |
6650 | foldcase version may be longer than the original character (up to |
6651 | three characters). | |
6652 | ||
6653 | The first character of the foldcased version is returned | |
6654 | (but note, as explained above, that there may be more.) | |
6655 | ||
7fc63493 | 6656 | UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp) |
d3e79532 JH |
6657 | |
6658 | =for hackers | |
6659 | Found in file utf8.c | |
6660 | ||
6661 | =item to_utf8_lower | |
d8c40edc | 6662 | X<to_utf8_lower> |
d3e79532 JH |
6663 | |
6664 | Convert the UTF-8 encoded character at p to its lowercase version and | |
6665 | store that in UTF-8 in ustrp and its length in bytes in lenp. Note | |
59887a99 MHM |
6666 | that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the |
6667 | lowercase version may be longer than the original character. | |
d3e79532 JH |
6668 | |
6669 | The first character of the lowercased version is returned | |
6670 | (but note, as explained above, that there may be more.) | |
6671 | ||
7fc63493 | 6672 | UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp) |
d3e79532 JH |
6673 | |
6674 | =for hackers | |
6675 | Found in file utf8.c | |
6676 | ||
6677 | =item to_utf8_title | |
d8c40edc | 6678 | X<to_utf8_title> |
d3e79532 JH |
6679 | |
6680 | Convert the UTF-8 encoded character at p to its titlecase version and | |
6681 | store that in UTF-8 in ustrp and its length in bytes in lenp. Note | |
59887a99 MHM |
6682 | that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the |
6683 | titlecase version may be longer than the original character. | |
d3e79532 JH |
6684 | |
6685 | The first character of the titlecased version is returned | |
6686 | (but note, as explained above, that there may be more.) | |
6687 | ||
7fc63493 | 6688 | UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp) |
d3e79532 JH |
6689 | |
6690 | =for hackers | |
6691 | Found in file utf8.c | |
6692 | ||
6693 | =item to_utf8_upper | |
d8c40edc | 6694 | X<to_utf8_upper> |
d3e79532 JH |
6695 | |
6696 | Convert the UTF-8 encoded character at p to its uppercase version and | |
6697 | store that in UTF-8 in ustrp and its length in bytes in lenp. Note | |
59887a99 MHM |
6698 | that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since |
6699 | the uppercase version may be longer than the original character. | |
d3e79532 JH |
6700 | |
6701 | The first character of the uppercased version is returned | |
6702 | (but note, as explained above, that there may be more.) | |
6703 | ||
7fc63493 | 6704 | UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp) |
d3e79532 JH |
6705 | |
6706 | =for hackers | |
6707 | Found in file utf8.c | |
6708 | ||
cd299c6e RGS |
6709 | =item utf8n_to_uvchr |
6710 | X<utf8n_to_uvchr> | |
6711 | ||
6712 | flags | |
6713 | ||
6714 | Returns the native character value of the first character in the string | |
6715 | C<s> | |
6716 | which is assumed to be in UTF-8 encoding; C<retlen> will be set to the | |
6717 | length, in bytes, of that character. | |
6718 | ||
6719 | Allows length and flags to be passed to low level routine. | |
6720 | ||
6721 | UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags) | |
6722 | ||
6723 | =for hackers | |
6724 | Found in file utf8.c | |
6725 | ||
282f25c9 | 6726 | =item utf8n_to_uvuni |
d8c40edc | 6727 | X<utf8n_to_uvuni> |
282f25c9 JH |
6728 | |
6729 | Bottom level UTF-8 decode routine. | |
6730 | Returns the unicode code point value of the first character in the string C<s> | |
1e54db1a | 6731 | which is assumed to be in UTF-8 encoding and no longer than C<curlen>; |
282f25c9 JH |
6732 | C<retlen> will be set to the length, in bytes, of that character. |
6733 | ||
1e54db1a | 6734 | If C<s> does not point to a well-formed UTF-8 character, the behaviour |
282f25c9 JH |
6735 | is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY, |
6736 | it is assumed that the caller will raise a warning, and this function | |
6737 | will silently just set C<retlen> to C<-1> and return zero. If the | |
6738 | C<flags> does not contain UTF8_CHECK_ONLY, warnings about | |
6739 | malformations will be given, C<retlen> will be set to the expected | |
6740 | length of the UTF-8 character in bytes, and zero will be returned. | |
6741 | ||
6742 | The C<flags> can also contain various flags to allow deviations from | |
6743 | the strict UTF-8 encoding (see F<utf8.h>). | |
6744 | ||
6745 | Most code should use utf8_to_uvchr() rather than call this directly. | |
6746 | ||
9a957fbc | 6747 | UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags) |
282f25c9 JH |
6748 | |
6749 | =for hackers | |
6750 | Found in file utf8.c | |
6751 | ||
b06226ff | 6752 | =item utf8_distance |
d8c40edc | 6753 | X<utf8_distance> |
b06226ff | 6754 | |
1e54db1a | 6755 | Returns the number of UTF-8 characters between the UTF-8 pointers C<a> |
b06226ff JH |
6756 | and C<b>. |
6757 | ||
6758 | WARNING: use only if you *know* that the pointers point inside the | |
6759 | same UTF-8 buffer. | |
6760 | ||
35a4481c | 6761 | IV utf8_distance(const U8 *a, const U8 *b) |
b06226ff JH |
6762 | |
6763 | =for hackers | |
6764 | Found in file utf8.c | |
6765 | ||
6766 | =item utf8_hop | |
d8c40edc | 6767 | X<utf8_hop> |
b06226ff | 6768 | |
8850bf83 JH |
6769 | Return the UTF-8 pointer C<s> displaced by C<off> characters, either |
6770 | forward or backward. | |
b06226ff JH |
6771 | |
6772 | WARNING: do not use the following unless you *know* C<off> is within | |
8850bf83 JH |
6773 | the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned |
6774 | on the first byte of character or just after the last byte of a character. | |
b06226ff | 6775 | |
4373e329 | 6776 | U8* utf8_hop(const U8 *s, I32 off) |
b06226ff JH |
6777 | |
6778 | =for hackers | |
6779 | Found in file utf8.c | |
6780 | ||
6781 | =item utf8_length | |
d8c40edc | 6782 | X<utf8_length> |
b06226ff JH |
6783 | |
6784 | Return the length of the UTF-8 char encoded string C<s> in characters. | |
6785 | Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end | |
6786 | up past C<e>, croaks. | |
6787 | ||
35a4481c | 6788 | STRLEN utf8_length(const U8* s, const U8 *e) |
b06226ff JH |
6789 | |
6790 | =for hackers | |
6791 | Found in file utf8.c | |
6792 | ||
497711e7 | 6793 | =item utf8_to_bytes |
d8c40edc | 6794 | X<utf8_to_bytes> |
497711e7 | 6795 | |
1e54db1a | 6796 | Converts a string C<s> of length C<len> from UTF-8 into byte encoding. |
246fae53 MG |
6797 | Unlike C<bytes_to_utf8>, this over-writes the original string, and |
6798 | updates len to contain the new length. | |
67e989fb | 6799 | Returns zero on failure, setting C<len> to -1. |
497711e7 | 6800 | |
95be277c NC |
6801 | If you need a copy of the string, see C<bytes_from_utf8>. |
6802 | ||
eebe1485 SC |
6803 | NOTE: this function is experimental and may change or be |
6804 | removed without notice. | |
6805 | ||
6806 | U8* utf8_to_bytes(U8 *s, STRLEN *len) | |
497711e7 GS |
6807 | |
6808 | =for hackers | |
6809 | Found in file utf8.c | |
6810 | ||
282f25c9 | 6811 | =item utf8_to_uvchr |
d8c40edc | 6812 | X<utf8_to_uvchr> |
b6b716fe | 6813 | |
282f25c9 | 6814 | Returns the native character value of the first character in the string C<s> |
1e54db1a | 6815 | which is assumed to be in UTF-8 encoding; C<retlen> will be set to the |
282f25c9 | 6816 | length, in bytes, of that character. |
28d3d195 | 6817 | |
1e54db1a | 6818 | If C<s> does not point to a well-formed UTF-8 character, zero is |
282f25c9 | 6819 | returned and retlen is set, if possible, to -1. |
444155da | 6820 | |
9a957fbc | 6821 | UV utf8_to_uvchr(const U8 *s, STRLEN *retlen) |
444155da JH |
6822 | |
6823 | =for hackers | |
6824 | Found in file utf8.c | |
6825 | ||
282f25c9 | 6826 | =item utf8_to_uvuni |
d8c40edc | 6827 | X<utf8_to_uvuni> |
444155da | 6828 | |
282f25c9 | 6829 | Returns the Unicode code point of the first character in the string C<s> |
1e54db1a | 6830 | which is assumed to be in UTF-8 encoding; C<retlen> will be set to the |
1aa99e6b | 6831 | length, in bytes, of that character. |
444155da | 6832 | |
282f25c9 JH |
6833 | This function should only be used when returned UV is considered |
6834 | an index into the Unicode semantic tables (e.g. swashes). | |
6835 | ||
1e54db1a | 6836 | If C<s> does not point to a well-formed UTF-8 character, zero is |
dcad2880 | 6837 | returned and retlen is set, if possible, to -1. |
b6b716fe | 6838 | |
9a957fbc | 6839 | UV utf8_to_uvuni(const U8 *s, STRLEN *retlen) |
282f25c9 JH |
6840 | |
6841 | =for hackers | |
6842 | Found in file utf8.c | |
6843 | ||
cd299c6e RGS |
6844 | =item uvchr_to_utf8 |
6845 | X<uvchr_to_utf8> | |
6846 | ||
6847 | Adds the UTF-8 representation of the Native codepoint C<uv> to the end | |
6848 | of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free | |
6849 | bytes available. The return value is the pointer to the byte after the | |
6850 | end of the new character. In other words, | |
6851 | ||
6852 | d = uvchr_to_utf8(d, uv); | |
6853 | ||
6854 | is the recommended wide native character-aware way of saying | |
6855 | ||
6856 | *(d++) = uv; | |
6857 | ||
6858 | U8* uvchr_to_utf8(U8 *d, UV uv) | |
6859 | ||
6860 | =for hackers | |
6861 | Found in file utf8.c | |
6862 | ||
b851fbc1 | 6863 | =item uvuni_to_utf8_flags |
d8c40edc | 6864 | X<uvuni_to_utf8_flags> |
eebe1485 | 6865 | |
1e54db1a | 6866 | Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end |
59887a99 | 6867 | of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free |
eebe1485 | 6868 | bytes available. The return value is the pointer to the byte after the |
282f25c9 | 6869 | end of the new character. In other words, |
eebe1485 | 6870 | |
b851fbc1 JH |
6871 | d = uvuni_to_utf8_flags(d, uv, flags); |
6872 | ||
6873 | or, in most cases, | |
6874 | ||
282f25c9 | 6875 | d = uvuni_to_utf8(d, uv); |
eebe1485 | 6876 | |
b851fbc1 JH |
6877 | (which is equivalent to) |
6878 | ||
6879 | d = uvuni_to_utf8_flags(d, uv, 0); | |
6880 | ||
eebe1485 SC |
6881 | is the recommended Unicode-aware way of saying |
6882 | ||
6883 | *(d++) = uv; | |
6884 | ||
b851fbc1 | 6885 | U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags) |
b6b716fe SC |
6886 | |
6887 | =for hackers | |
6888 | Found in file utf8.c | |
6889 | ||
497711e7 | 6890 | |
94bdecf9 | 6891 | =back |
954c1994 | 6892 | |
94bdecf9 | 6893 | =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions |
954c1994 | 6894 | |
94bdecf9 | 6895 | =over 8 |
954c1994 | 6896 | |
94bdecf9 | 6897 | =item ax |
d8c40edc | 6898 | X<ax> |
497711e7 | 6899 | |
94bdecf9 JH |
6900 | Variable which is setup by C<xsubpp> to indicate the stack base offset, |
6901 | used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro | |
6902 | must be called prior to setup the C<MARK> variable. | |
954c1994 | 6903 | |
94bdecf9 | 6904 | I32 ax |
954c1994 | 6905 | |
497711e7 GS |
6906 | =for hackers |
6907 | Found in file XSUB.h | |
6908 | ||
94bdecf9 | 6909 | =item CLASS |
d8c40edc | 6910 | X<CLASS> |
954c1994 | 6911 | |
94bdecf9 JH |
6912 | Variable which is setup by C<xsubpp> to indicate the |
6913 | class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>. | |
954c1994 | 6914 | |
94bdecf9 | 6915 | char* CLASS |
954c1994 | 6916 | |
497711e7 GS |
6917 | =for hackers |
6918 | Found in file XSUB.h | |
6919 | ||
94bdecf9 | 6920 | =item dAX |
d8c40edc | 6921 | X<dAX> |
954c1994 | 6922 | |
94bdecf9 JH |
6923 | Sets up the C<ax> variable. |
6924 | This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>. | |
954c1994 | 6925 | |
94bdecf9 | 6926 | dAX; |
954c1994 | 6927 | |
497711e7 GS |
6928 | =for hackers |
6929 | Found in file XSUB.h | |
6930 | ||
557b887a | 6931 | =item dAXMARK |
d8c40edc | 6932 | X<dAXMARK> |
557b887a SS |
6933 | |
6934 | Sets up the C<ax> variable and stack marker variable C<mark>. | |
6935 | This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>. | |
6936 | ||
6937 | dAXMARK; | |
6938 | ||
6939 | =for hackers | |
6940 | Found in file XSUB.h | |
6941 | ||
94bdecf9 | 6942 | =item dITEMS |
d8c40edc | 6943 | X<dITEMS> |
954c1994 | 6944 | |
94bdecf9 JH |
6945 | Sets up the C<items> variable. |
6946 | This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>. | |
954c1994 | 6947 | |
94bdecf9 | 6948 | dITEMS; |
954c1994 | 6949 | |
497711e7 GS |
6950 | =for hackers |
6951 | Found in file XSUB.h | |
6952 | ||
88037a85 | 6953 | =item dUNDERBAR |
d8c40edc | 6954 | X<dUNDERBAR> |
88037a85 RGS |
6955 | |
6956 | Sets up the C<padoff_du> variable for an XSUB that wishes to use | |
6957 | C<UNDERBAR>. | |
6958 | ||
6959 | dUNDERBAR; | |
6960 | ||
6961 | =for hackers | |
6962 | Found in file XSUB.h | |
6963 | ||
94bdecf9 | 6964 | =item dXSARGS |
d8c40edc | 6965 | X<dXSARGS> |
954c1994 | 6966 | |
94bdecf9 JH |
6967 | Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. |
6968 | Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>. | |
6969 | This is usually handled automatically by C<xsubpp>. | |
954c1994 | 6970 | |
94bdecf9 | 6971 | dXSARGS; |
954c1994 | 6972 | |
497711e7 GS |
6973 | =for hackers |
6974 | Found in file XSUB.h | |
6975 | ||
94bdecf9 | 6976 | =item dXSI32 |
d8c40edc | 6977 | X<dXSI32> |
954c1994 | 6978 | |
94bdecf9 JH |
6979 | Sets up the C<ix> variable for an XSUB which has aliases. This is usually |
6980 | handled automatically by C<xsubpp>. | |
954c1994 | 6981 | |
94bdecf9 | 6982 | dXSI32; |
954c1994 | 6983 | |
497711e7 GS |
6984 | =for hackers |
6985 | Found in file XSUB.h | |
6986 | ||
94bdecf9 | 6987 | =item items |
d8c40edc | 6988 | X<items> |
954c1994 | 6989 | |
94bdecf9 JH |
6990 | Variable which is setup by C<xsubpp> to indicate the number of |
6991 | items on the stack. See L<perlxs/"Variable-length Parameter Lists">. | |
954c1994 | 6992 | |
94bdecf9 | 6993 | I32 items |
954c1994 | 6994 | |
497711e7 GS |
6995 | =for hackers |
6996 | Found in file XSUB.h | |
6997 | ||
94bdecf9 | 6998 | =item ix |
d8c40edc | 6999 | X<ix> |
954c1994 | 7000 | |
94bdecf9 JH |
7001 | Variable which is setup by C<xsubpp> to indicate which of an |
7002 | XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">. | |
954c1994 | 7003 | |
94bdecf9 | 7004 | I32 ix |
954c1994 | 7005 | |
497711e7 GS |
7006 | =for hackers |
7007 | Found in file XSUB.h | |
7008 | ||
94bdecf9 | 7009 | =item newXSproto |
d8c40edc | 7010 | X<newXSproto> |
954c1994 | 7011 | |
94bdecf9 JH |
7012 | Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to |
7013 | the subs. | |
954c1994 | 7014 | |
497711e7 GS |
7015 | =for hackers |
7016 | Found in file XSUB.h | |
7017 | ||
94bdecf9 | 7018 | =item RETVAL |
d8c40edc | 7019 | X<RETVAL> |
954c1994 | 7020 | |
94bdecf9 JH |
7021 | Variable which is setup by C<xsubpp> to hold the return value for an |
7022 | XSUB. This is always the proper type for the XSUB. See | |
7023 | L<perlxs/"The RETVAL Variable">. | |
954c1994 | 7024 | |
94bdecf9 | 7025 | (whatever) RETVAL |
954c1994 | 7026 | |
497711e7 GS |
7027 | =for hackers |
7028 | Found in file XSUB.h | |
7029 | ||
94bdecf9 | 7030 | =item ST |
d8c40edc | 7031 | X<ST> |
954c1994 | 7032 | |
94bdecf9 | 7033 | Used to access elements on the XSUB's stack. |
954c1994 | 7034 | |
94bdecf9 | 7035 | SV* ST(int ix) |
954c1994 | 7036 | |
497711e7 GS |
7037 | =for hackers |
7038 | Found in file XSUB.h | |
7039 | ||
94bdecf9 | 7040 | =item THIS |
d8c40edc | 7041 | X<THIS> |
954c1994 | 7042 | |
94bdecf9 JH |
7043 | Variable which is setup by C<xsubpp> to designate the object in a C++ |
7044 | XSUB. This is always the proper type for the C++ object. See C<CLASS> and | |
7045 | L<perlxs/"Using XS With C++">. | |
954c1994 | 7046 | |
94bdecf9 | 7047 | (whatever) THIS |
954c1994 | 7048 | |
497711e7 GS |
7049 | =for hackers |
7050 | Found in file XSUB.h | |
7051 | ||
88037a85 | 7052 | =item UNDERBAR |
d8c40edc | 7053 | X<UNDERBAR> |
88037a85 RGS |
7054 | |
7055 | The SV* corresponding to the $_ variable. Works even if there | |
7056 | is a lexical $_ in scope. | |
7057 | ||
7058 | =for hackers | |
7059 | Found in file XSUB.h | |
7060 | ||
94bdecf9 | 7061 | =item XS |
d8c40edc | 7062 | X<XS> |
954c1994 | 7063 | |
94bdecf9 JH |
7064 | Macro to declare an XSUB and its C parameter list. This is handled by |
7065 | C<xsubpp>. | |
954c1994 | 7066 | |
497711e7 GS |
7067 | =for hackers |
7068 | Found in file XSUB.h | |
7069 | ||
954c1994 | 7070 | =item XS_VERSION |
d8c40edc | 7071 | X<XS_VERSION> |
954c1994 GS |
7072 | |
7073 | The version identifier for an XS module. This is usually | |
7074 | handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>. | |
7075 | ||
497711e7 GS |
7076 | =for hackers |
7077 | Found in file XSUB.h | |
7078 | ||
954c1994 | 7079 | =item XS_VERSION_BOOTCHECK |
d8c40edc | 7080 | X<XS_VERSION_BOOTCHECK> |
954c1994 GS |
7081 | |
7082 | Macro to verify that a PM module's $VERSION variable matches the XS | |
7083 | module's C<XS_VERSION> variable. This is usually handled automatically by | |
7084 | C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">. | |
7085 | ||
7086 | XS_VERSION_BOOTCHECK; | |
7087 | ||
497711e7 GS |
7088 | =for hackers |
7089 | Found in file XSUB.h | |
7090 | ||
954c1994 | 7091 | |
94bdecf9 | 7092 | =back |
954c1994 | 7093 | |
94bdecf9 JH |
7094 | =head1 Warning and Dieing |
7095 | ||
7096 | =over 8 | |
7097 | ||
7098 | =item croak | |
d8c40edc | 7099 | X<croak> |
94bdecf9 JH |
7100 | |
7101 | This is the XSUB-writer's interface to Perl's C<die> function. | |
966353fd MF |
7102 | Normally call this function the same way you call the C C<printf> |
7103 | function. Calling C<croak> returns control directly to Perl, | |
7104 | sidestepping the normal C order of execution. See C<warn>. | |
94bdecf9 JH |
7105 | |
7106 | If you want to throw an exception object, assign the object to | |
bd61b366 | 7107 | C<$@> and then pass C<NULL> to croak(): |
94bdecf9 JH |
7108 | |
7109 | errsv = get_sv("@", TRUE); | |
7110 | sv_setsv(errsv, exception_object); | |
bd61b366 | 7111 | croak(NULL); |
94bdecf9 JH |
7112 | |
7113 | void croak(const char* pat, ...) | |
954c1994 | 7114 | |
497711e7 | 7115 | =for hackers |
94bdecf9 JH |
7116 | Found in file util.c |
7117 | ||
7118 | =item warn | |
d8c40edc | 7119 | X<warn> |
94bdecf9 | 7120 | |
966353fd MF |
7121 | This is the XSUB-writer's interface to Perl's C<warn> function. Call this |
7122 | function the same way you call the C C<printf> function. See C<croak>. | |
94bdecf9 JH |
7123 | |
7124 | void warn(const char* pat, ...) | |
7125 | ||
7126 | =for hackers | |
7127 | Found in file util.c | |
7128 | ||
497711e7 | 7129 | |
954c1994 GS |
7130 | =back |
7131 | ||
7132 | =head1 AUTHORS | |
7133 | ||
7134 | Until May 1997, this document was maintained by Jeff Okamoto | |
7135 | <okamoto@corp.hp.com>. It is now maintained as part of Perl itself. | |
7136 | ||
7137 | With lots of help and suggestions from Dean Roehrich, Malcolm Beattie, | |
7138 | Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil | |
7139 | Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, | |
7140 | Stephen McCamant, and Gurusamy Sarathy. | |
7141 | ||
7142 | API Listing originally by Dean Roehrich <roehrich@cray.com>. | |
7143 | ||
7144 | Updated to be autogenerated from comments in the source by Benjamin Stuhl. | |
7145 | ||
7146 | =head1 SEE ALSO | |
7147 | ||
7148 | perlguts(1), perlxs(1), perlxstut(1), perlintern(1) | |
7149 | ||
e0492643 NC |
7150 | =cut |
7151 | ||
3f98fbb3 | 7152 | ex: set ro: |