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