Commit | Line | Data |
954c1994 |
1 | =head1 NAME |
2 | |
3 | perlapi - autogenerated documentation for the perl public API |
4 | |
5 | =head1 DESCRIPTION |
6 | |
1c846c1f |
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 |
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 | |
20 | =over 8 |
21 | |
22 | =item AvFILL |
23 | |
24 | Same as C<av_len()>. Deprecated, use C<av_len()> instead. |
25 | |
26 | int AvFILL(AV* av) |
27 | |
497711e7 |
28 | =for hackers |
29 | Found in file av.h |
30 | |
954c1994 |
31 | =item av_clear |
32 | |
33 | Clears an array, making it empty. Does not free the memory used by the |
34 | array itself. |
35 | |
36 | void av_clear(AV* ar) |
37 | |
497711e7 |
38 | =for hackers |
39 | Found in file av.c |
40 | |
f3b76584 |
41 | =item av_delete |
42 | |
43 | Deletes the element indexed by C<key> from the array. Returns the |
44 | deleted element. C<flags> is currently ignored. |
45 | |
46 | SV* av_delete(AV* ar, I32 key, I32 flags) |
47 | |
48 | =for hackers |
49 | Found in file av.c |
50 | |
51 | =item av_exists |
52 | |
53 | Returns true if the element indexed by C<key> has been initialized. |
54 | |
55 | This relies on the fact that uninitialized array elements are set to |
56 | C<&PL_sv_undef>. |
57 | |
58 | bool av_exists(AV* ar, I32 key) |
59 | |
60 | =for hackers |
61 | Found in file av.c |
62 | |
954c1994 |
63 | =item av_extend |
64 | |
65 | Pre-extend an array. The C<key> is the index to which the array should be |
66 | extended. |
67 | |
68 | void av_extend(AV* ar, I32 key) |
69 | |
497711e7 |
70 | =for hackers |
71 | Found in file av.c |
72 | |
954c1994 |
73 | =item av_fetch |
74 | |
75 | Returns the SV at the specified index in the array. The C<key> is the |
76 | index. If C<lval> is set then the fetch will be part of a store. Check |
77 | that the return value is non-null before dereferencing it to a C<SV*>. |
78 | |
96f1132b |
79 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for |
80 | more information on how to use this function on tied arrays. |
954c1994 |
81 | |
82 | SV** av_fetch(AV* ar, I32 key, I32 lval) |
83 | |
497711e7 |
84 | =for hackers |
85 | Found in file av.c |
86 | |
f3b76584 |
87 | =item av_fill |
88 | |
89 | Ensure than an array has a given number of elements, equivalent to |
90 | Perl's C<$#array = $fill;>. |
91 | |
92 | void av_fill(AV* ar, I32 fill) |
93 | |
94 | =for hackers |
95 | Found in file av.c |
96 | |
954c1994 |
97 | =item av_len |
98 | |
99 | Returns the highest index in the array. Returns -1 if the array is |
100 | empty. |
101 | |
102 | I32 av_len(AV* ar) |
103 | |
497711e7 |
104 | =for hackers |
105 | Found in file av.c |
106 | |
954c1994 |
107 | =item av_make |
108 | |
109 | Creates a new AV and populates it with a list of SVs. The SVs are copied |
110 | into the array, so they may be freed after the call to av_make. The new AV |
111 | will have a reference count of 1. |
112 | |
113 | AV* av_make(I32 size, SV** svp) |
114 | |
497711e7 |
115 | =for hackers |
116 | Found in file av.c |
117 | |
954c1994 |
118 | =item av_pop |
119 | |
120 | Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array |
121 | is empty. |
122 | |
123 | SV* av_pop(AV* ar) |
124 | |
497711e7 |
125 | =for hackers |
126 | Found in file av.c |
127 | |
954c1994 |
128 | =item av_push |
129 | |
130 | Pushes an SV onto the end of the array. The array will grow automatically |
131 | to accommodate the addition. |
132 | |
133 | void av_push(AV* ar, SV* val) |
134 | |
497711e7 |
135 | =for hackers |
136 | Found in file av.c |
137 | |
954c1994 |
138 | =item av_shift |
139 | |
140 | Shifts an SV off the beginning of the array. |
141 | |
142 | SV* av_shift(AV* ar) |
143 | |
497711e7 |
144 | =for hackers |
145 | Found in file av.c |
146 | |
954c1994 |
147 | =item av_store |
148 | |
149 | Stores an SV in an array. The array index is specified as C<key>. The |
150 | return value will be NULL if the operation failed or if the value did not |
151 | need to be actually stored within the array (as in the case of tied |
152 | arrays). Otherwise it can be dereferenced to get the original C<SV*>. Note |
153 | that the caller is responsible for suitably incrementing the reference |
154 | count of C<val> before the call, and decrementing it if the function |
155 | returned NULL. |
156 | |
96f1132b |
157 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for |
954c1994 |
158 | more information on how to use this function on tied arrays. |
159 | |
160 | SV** av_store(AV* ar, I32 key, SV* val) |
161 | |
497711e7 |
162 | =for hackers |
163 | Found in file av.c |
164 | |
954c1994 |
165 | =item av_undef |
166 | |
167 | Undefines the array. Frees the memory used by the array itself. |
168 | |
169 | void av_undef(AV* ar) |
170 | |
497711e7 |
171 | =for hackers |
172 | Found in file av.c |
173 | |
954c1994 |
174 | =item av_unshift |
175 | |
176 | Unshift the given number of C<undef> values onto the beginning of the |
177 | array. The array will grow automatically to accommodate the addition. You |
178 | must then use C<av_store> to assign values to these new elements. |
179 | |
180 | void av_unshift(AV* ar, I32 num) |
181 | |
497711e7 |
182 | =for hackers |
183 | Found in file av.c |
184 | |
185 | =item bytes_to_utf8 |
186 | |
187 | Converts a string C<s> of length C<len> from ASCII into UTF8 encoding. |
6662521e |
188 | Returns a pointer to the newly-created string, and sets C<len> to |
189 | reflect the new length. |
497711e7 |
190 | |
6662521e |
191 | U8 * bytes_to_utf8(U8 *s, STRLEN *len) |
497711e7 |
192 | |
193 | =for hackers |
194 | Found in file utf8.c |
195 | |
954c1994 |
196 | =item call_argv |
197 | |
198 | Performs a callback to the specified Perl sub. See L<perlcall>. |
199 | |
200 | NOTE: the perl_ form of this function is deprecated. |
201 | |
202 | I32 call_argv(const char* sub_name, I32 flags, char** argv) |
203 | |
497711e7 |
204 | =for hackers |
205 | Found in file perl.c |
206 | |
954c1994 |
207 | =item call_method |
208 | |
209 | Performs a callback to the specified Perl method. The blessed object must |
210 | be on the stack. See L<perlcall>. |
211 | |
212 | NOTE: the perl_ form of this function is deprecated. |
213 | |
214 | I32 call_method(const char* methname, I32 flags) |
215 | |
497711e7 |
216 | =for hackers |
217 | Found in file perl.c |
218 | |
954c1994 |
219 | =item call_pv |
220 | |
221 | Performs a callback to the specified Perl sub. See L<perlcall>. |
222 | |
223 | NOTE: the perl_ form of this function is deprecated. |
224 | |
225 | I32 call_pv(const char* sub_name, I32 flags) |
226 | |
497711e7 |
227 | =for hackers |
228 | Found in file perl.c |
229 | |
954c1994 |
230 | =item call_sv |
231 | |
232 | Performs a callback to the Perl sub whose name is in the SV. See |
233 | L<perlcall>. |
234 | |
235 | NOTE: the perl_ form of this function is deprecated. |
236 | |
237 | I32 call_sv(SV* sv, I32 flags) |
238 | |
497711e7 |
239 | =for hackers |
240 | Found in file perl.c |
241 | |
954c1994 |
242 | =item CLASS |
243 | |
244 | Variable which is setup by C<xsubpp> to indicate the |
245 | class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>. |
246 | |
247 | char* CLASS |
248 | |
497711e7 |
249 | =for hackers |
250 | Found in file XSUB.h |
251 | |
954c1994 |
252 | =item Copy |
253 | |
254 | The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the |
255 | source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is |
256 | the type. May fail on overlapping copies. See also C<Move>. |
257 | |
258 | void Copy(void* src, void* dest, int nitems, type) |
259 | |
497711e7 |
260 | =for hackers |
261 | Found in file handy.h |
262 | |
954c1994 |
263 | =item croak |
264 | |
c9d5ac95 |
265 | This is the XSUB-writer's interface to Perl's C<die> function. |
266 | Normally use this function the same way you use the C C<printf> |
267 | function. See C<warn>. |
268 | |
269 | If you want to throw an exception object, assign the object to |
270 | C<$@> and then pass C<Nullch> to croak(): |
271 | |
272 | errsv = get_sv("@", TRUE); |
273 | sv_setsv(errsv, exception_object); |
274 | croak(Nullch); |
954c1994 |
275 | |
276 | void croak(const char* pat, ...) |
277 | |
497711e7 |
278 | =for hackers |
279 | Found in file util.c |
280 | |
954c1994 |
281 | =item CvSTASH |
282 | |
283 | Returns the stash of the CV. |
284 | |
285 | HV* CvSTASH(CV* cv) |
286 | |
497711e7 |
287 | =for hackers |
288 | Found in file cv.h |
289 | |
beab0874 |
290 | =item cv_const_sv |
291 | |
292 | If C<cv> is a constant sub eligible for inlining. returns the constant |
293 | value returned by the sub. Otherwise, returns NULL. |
294 | |
295 | Constant subs can be created with C<newCONSTSUB> or as described in |
296 | L<perlsub/"Constant Functions">. |
297 | |
298 | SV* cv_const_sv(CV* cv) |
299 | |
300 | =for hackers |
35676c7e |
301 | Found in file op.c |
beab0874 |
302 | |
954c1994 |
303 | =item dMARK |
304 | |
305 | Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and |
306 | C<dORIGMARK>. |
307 | |
308 | dMARK; |
309 | |
497711e7 |
310 | =for hackers |
311 | Found in file pp.h |
312 | |
954c1994 |
313 | =item dORIGMARK |
314 | |
315 | Saves the original stack mark for the XSUB. See C<ORIGMARK>. |
316 | |
317 | dORIGMARK; |
318 | |
497711e7 |
319 | =for hackers |
320 | Found in file pp.h |
321 | |
954c1994 |
322 | =item dSP |
323 | |
324 | Declares a local copy of perl's stack pointer for the XSUB, available via |
325 | the C<SP> macro. See C<SP>. |
326 | |
327 | dSP; |
328 | |
497711e7 |
329 | =for hackers |
330 | Found in file pp.h |
331 | |
954c1994 |
332 | =item dXSARGS |
333 | |
334 | Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This |
335 | is usually handled automatically by C<xsubpp>. Declares the C<items> |
336 | variable to indicate the number of items on the stack. |
337 | |
338 | dXSARGS; |
339 | |
497711e7 |
340 | =for hackers |
341 | Found in file XSUB.h |
342 | |
954c1994 |
343 | =item dXSI32 |
344 | |
345 | Sets up the C<ix> variable for an XSUB which has aliases. This is usually |
346 | handled automatically by C<xsubpp>. |
347 | |
348 | dXSI32; |
349 | |
497711e7 |
350 | =for hackers |
351 | Found in file XSUB.h |
352 | |
954c1994 |
353 | =item ENTER |
354 | |
355 | Opening bracket on a callback. See C<LEAVE> and L<perlcall>. |
356 | |
357 | ENTER; |
358 | |
497711e7 |
359 | =for hackers |
360 | Found in file scope.h |
361 | |
954c1994 |
362 | =item eval_pv |
363 | |
364 | Tells Perl to C<eval> the given string and return an SV* result. |
365 | |
366 | NOTE: the perl_ form of this function is deprecated. |
367 | |
368 | SV* eval_pv(const char* p, I32 croak_on_error) |
369 | |
497711e7 |
370 | =for hackers |
371 | Found in file perl.c |
372 | |
954c1994 |
373 | =item eval_sv |
374 | |
375 | Tells Perl to C<eval> the string in the SV. |
376 | |
377 | NOTE: the perl_ form of this function is deprecated. |
378 | |
379 | I32 eval_sv(SV* sv, I32 flags) |
380 | |
497711e7 |
381 | =for hackers |
382 | Found in file perl.c |
383 | |
954c1994 |
384 | =item EXTEND |
385 | |
386 | Used to extend the argument stack for an XSUB's return values. Once |
4375e838 |
387 | used, guarantees that there is room for at least C<nitems> to be pushed |
954c1994 |
388 | onto the stack. |
389 | |
390 | void EXTEND(SP, int nitems) |
391 | |
497711e7 |
392 | =for hackers |
393 | Found in file pp.h |
394 | |
954c1994 |
395 | =item fbm_compile |
396 | |
397 | Analyses the string in order to make fast searches on it using fbm_instr() |
398 | -- the Boyer-Moore algorithm. |
399 | |
400 | void fbm_compile(SV* sv, U32 flags) |
401 | |
497711e7 |
402 | =for hackers |
403 | Found in file util.c |
404 | |
954c1994 |
405 | =item fbm_instr |
406 | |
407 | Returns the location of the SV in the string delimited by C<str> and |
408 | C<strend>. It returns C<Nullch> if the string can't be found. The C<sv> |
409 | does not have to be fbm_compiled, but the search will not be as fast |
410 | then. |
411 | |
412 | char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags) |
413 | |
497711e7 |
414 | =for hackers |
415 | Found in file util.c |
416 | |
954c1994 |
417 | =item FREETMPS |
418 | |
419 | Closing bracket for temporaries on a callback. See C<SAVETMPS> and |
420 | L<perlcall>. |
421 | |
422 | FREETMPS; |
423 | |
497711e7 |
424 | =for hackers |
425 | Found in file scope.h |
426 | |
954c1994 |
427 | =item get_av |
428 | |
429 | Returns the AV of the specified Perl array. If C<create> is set and the |
430 | Perl variable does not exist then it will be created. If C<create> is not |
431 | set and the variable does not exist then NULL is returned. |
432 | |
433 | NOTE: the perl_ form of this function is deprecated. |
434 | |
435 | AV* get_av(const char* name, I32 create) |
436 | |
497711e7 |
437 | =for hackers |
438 | Found in file perl.c |
439 | |
954c1994 |
440 | =item get_cv |
441 | |
442 | Returns the CV of the specified Perl subroutine. If C<create> is set and |
443 | the Perl subroutine does not exist then it will be declared (which has the |
444 | same effect as saying C<sub name;>). If C<create> is not set and the |
445 | subroutine does not exist then NULL is returned. |
446 | |
447 | NOTE: the perl_ form of this function is deprecated. |
448 | |
449 | CV* get_cv(const char* name, I32 create) |
450 | |
497711e7 |
451 | =for hackers |
452 | Found in file perl.c |
453 | |
954c1994 |
454 | =item get_hv |
455 | |
456 | Returns the HV of the specified Perl hash. If C<create> is set and the |
457 | Perl variable does not exist then it will be created. If C<create> is not |
458 | set and the variable does not exist then NULL is returned. |
459 | |
460 | NOTE: the perl_ form of this function is deprecated. |
461 | |
462 | HV* get_hv(const char* name, I32 create) |
463 | |
497711e7 |
464 | =for hackers |
465 | Found in file perl.c |
466 | |
954c1994 |
467 | =item get_sv |
468 | |
469 | Returns the SV of the specified Perl scalar. If C<create> is set and the |
470 | Perl variable does not exist then it will be created. If C<create> is not |
471 | set and the variable does not exist then NULL is returned. |
472 | |
473 | NOTE: the perl_ form of this function is deprecated. |
474 | |
475 | SV* get_sv(const char* name, I32 create) |
476 | |
497711e7 |
477 | =for hackers |
478 | Found in file perl.c |
479 | |
954c1994 |
480 | =item GIMME |
481 | |
482 | A backward-compatible version of C<GIMME_V> which can only return |
483 | C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>. |
484 | Deprecated. Use C<GIMME_V> instead. |
485 | |
486 | U32 GIMME |
487 | |
497711e7 |
488 | =for hackers |
489 | Found in file op.h |
490 | |
954c1994 |
491 | =item GIMME_V |
492 | |
493 | The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>, |
90fdbbb7 |
494 | C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context, |
954c1994 |
495 | respectively. |
496 | |
497 | U32 GIMME_V |
498 | |
497711e7 |
499 | =for hackers |
500 | Found in file op.h |
501 | |
954c1994 |
502 | =item GvSV |
503 | |
504 | Return the SV from the GV. |
505 | |
506 | SV* GvSV(GV* gv) |
507 | |
497711e7 |
508 | =for hackers |
509 | Found in file gv.h |
510 | |
954c1994 |
511 | =item gv_fetchmeth |
512 | |
513 | Returns the glob with the given C<name> and a defined subroutine or |
514 | C<NULL>. The glob lives in the given C<stash>, or in the stashes |
1c846c1f |
515 | accessible via @ISA and @UNIVERSAL. |
954c1994 |
516 | |
517 | The argument C<level> should be either 0 or -1. If C<level==0>, as a |
518 | side-effect creates a glob with the given C<name> in the given C<stash> |
519 | which in the case of success contains an alias for the subroutine, and sets |
1c846c1f |
520 | up caching info for this glob. Similarly for all the searched stashes. |
954c1994 |
521 | |
522 | This function grants C<"SUPER"> token as a postfix of the stash name. The |
523 | GV returned from C<gv_fetchmeth> may be a method cache entry, which is not |
4929bf7b |
524 | visible to Perl code. So when calling C<call_sv>, you should not use |
954c1994 |
525 | the GV directly; instead, you should use the method's CV, which can be |
1c846c1f |
526 | obtained from the GV with the C<GvCV> macro. |
954c1994 |
527 | |
528 | GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level) |
529 | |
497711e7 |
530 | =for hackers |
531 | Found in file gv.c |
532 | |
954c1994 |
533 | =item gv_fetchmethod |
534 | |
6d0f518e |
535 | See L<gv_fetchmethod_autoload>. |
954c1994 |
536 | |
537 | GV* gv_fetchmethod(HV* stash, const char* name) |
538 | |
497711e7 |
539 | =for hackers |
540 | Found in file gv.c |
541 | |
954c1994 |
542 | =item gv_fetchmethod_autoload |
543 | |
544 | Returns the glob which contains the subroutine to call to invoke the method |
545 | on the C<stash>. In fact in the presence of autoloading this may be the |
546 | glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is |
1c846c1f |
547 | already setup. |
954c1994 |
548 | |
549 | The third parameter of C<gv_fetchmethod_autoload> determines whether |
550 | AUTOLOAD lookup is performed if the given method is not present: non-zero |
1c846c1f |
551 | means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD. |
954c1994 |
552 | Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload> |
1c846c1f |
553 | with a non-zero C<autoload> parameter. |
954c1994 |
554 | |
555 | These functions grant C<"SUPER"> token as a prefix of the method name. Note |
556 | that if you want to keep the returned glob for a long time, you need to |
557 | check for it being "AUTOLOAD", since at the later time the call may load a |
558 | different subroutine due to $AUTOLOAD changing its value. Use the glob |
1c846c1f |
559 | created via a side effect to do this. |
954c1994 |
560 | |
561 | These functions have the same side-effects and as C<gv_fetchmeth> with |
562 | C<level==0>. C<name> should be writable if contains C<':'> or C<' |
563 | ''>. The warning against passing the GV returned by C<gv_fetchmeth> to |
1c846c1f |
564 | C<call_sv> apply equally to these functions. |
954c1994 |
565 | |
566 | GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload) |
567 | |
497711e7 |
568 | =for hackers |
569 | Found in file gv.c |
570 | |
954c1994 |
571 | =item gv_stashpv |
572 | |
386d01d6 |
573 | Returns a pointer to the stash for a specified package. C<name> should |
574 | be a valid UTF-8 string. If C<create> is set then the package will be |
575 | created if it does not already exist. If C<create> is not set and the |
576 | package does not exist then NULL is returned. |
954c1994 |
577 | |
578 | HV* gv_stashpv(const char* name, I32 create) |
579 | |
497711e7 |
580 | =for hackers |
581 | Found in file gv.c |
582 | |
954c1994 |
583 | =item gv_stashsv |
584 | |
386d01d6 |
585 | Returns a pointer to the stash for a specified package, which must be a |
586 | valid UTF-8 string. See C<gv_stashpv>. |
954c1994 |
587 | |
588 | HV* gv_stashsv(SV* sv, I32 create) |
589 | |
497711e7 |
590 | =for hackers |
591 | Found in file gv.c |
592 | |
954c1994 |
593 | =item G_ARRAY |
594 | |
90fdbbb7 |
595 | Used to indicate list context. See C<GIMME_V>, C<GIMME> and |
954c1994 |
596 | L<perlcall>. |
597 | |
497711e7 |
598 | =for hackers |
599 | Found in file cop.h |
600 | |
954c1994 |
601 | =item G_DISCARD |
602 | |
603 | Indicates that arguments returned from a callback should be discarded. See |
604 | L<perlcall>. |
605 | |
497711e7 |
606 | =for hackers |
607 | Found in file cop.h |
608 | |
954c1994 |
609 | =item G_EVAL |
610 | |
611 | Used to force a Perl C<eval> wrapper around a callback. See |
612 | L<perlcall>. |
613 | |
497711e7 |
614 | =for hackers |
615 | Found in file cop.h |
616 | |
954c1994 |
617 | =item G_NOARGS |
618 | |
619 | Indicates that no arguments are being sent to a callback. See |
620 | L<perlcall>. |
621 | |
497711e7 |
622 | =for hackers |
623 | Found in file cop.h |
624 | |
954c1994 |
625 | =item G_SCALAR |
626 | |
627 | Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and |
628 | L<perlcall>. |
629 | |
497711e7 |
630 | =for hackers |
631 | Found in file cop.h |
632 | |
954c1994 |
633 | =item G_VOID |
634 | |
635 | Used to indicate void context. See C<GIMME_V> and L<perlcall>. |
636 | |
497711e7 |
637 | =for hackers |
638 | Found in file cop.h |
639 | |
954c1994 |
640 | =item HEf_SVKEY |
641 | |
642 | This flag, used in the length slot of hash entries and magic structures, |
643 | specifies the structure contains a C<SV*> pointer where a C<char*> pointer |
644 | is to be expected. (For information only--not to be used). |
645 | |
497711e7 |
646 | =for hackers |
647 | Found in file hv.h |
648 | |
954c1994 |
649 | =item HeHASH |
650 | |
651 | Returns the computed hash stored in the hash entry. |
652 | |
653 | U32 HeHASH(HE* he) |
654 | |
497711e7 |
655 | =for hackers |
656 | Found in file hv.h |
657 | |
954c1994 |
658 | =item HeKEY |
659 | |
660 | Returns the actual pointer stored in the key slot of the hash entry. The |
661 | pointer may be either C<char*> or C<SV*>, depending on the value of |
662 | C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are |
663 | usually preferable for finding the value of a key. |
664 | |
665 | void* HeKEY(HE* he) |
666 | |
497711e7 |
667 | =for hackers |
668 | Found in file hv.h |
669 | |
954c1994 |
670 | =item HeKLEN |
671 | |
672 | If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry |
673 | holds an C<SV*> key. Otherwise, holds the actual length of the key. Can |
674 | be assigned to. The C<HePV()> macro is usually preferable for finding key |
675 | lengths. |
676 | |
677 | STRLEN HeKLEN(HE* he) |
678 | |
497711e7 |
679 | =for hackers |
680 | Found in file hv.h |
681 | |
954c1994 |
682 | =item HePV |
683 | |
684 | Returns the key slot of the hash entry as a C<char*> value, doing any |
685 | necessary dereferencing of possibly C<SV*> keys. The length of the string |
686 | is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do |
687 | not care about what the length of the key is, you may use the global |
688 | variable C<PL_na>, though this is rather less efficient than using a local |
689 | variable. Remember though, that hash keys in perl are free to contain |
690 | embedded nulls, so using C<strlen()> or similar is not a good way to find |
691 | the length of hash keys. This is very similar to the C<SvPV()> macro |
692 | described elsewhere in this document. |
693 | |
694 | char* HePV(HE* he, STRLEN len) |
695 | |
497711e7 |
696 | =for hackers |
697 | Found in file hv.h |
698 | |
954c1994 |
699 | =item HeSVKEY |
700 | |
701 | Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not |
702 | contain an C<SV*> key. |
703 | |
704 | SV* HeSVKEY(HE* he) |
705 | |
497711e7 |
706 | =for hackers |
707 | Found in file hv.h |
708 | |
954c1994 |
709 | =item HeSVKEY_force |
710 | |
711 | Returns the key as an C<SV*>. Will create and return a temporary mortal |
712 | C<SV*> if the hash entry contains only a C<char*> key. |
713 | |
714 | SV* HeSVKEY_force(HE* he) |
715 | |
497711e7 |
716 | =for hackers |
717 | Found in file hv.h |
718 | |
954c1994 |
719 | =item HeSVKEY_set |
720 | |
721 | Sets the key to a given C<SV*>, taking care to set the appropriate flags to |
722 | indicate the presence of an C<SV*> key, and returns the same |
723 | C<SV*>. |
724 | |
725 | SV* HeSVKEY_set(HE* he, SV* sv) |
726 | |
497711e7 |
727 | =for hackers |
728 | Found in file hv.h |
729 | |
954c1994 |
730 | =item HeVAL |
731 | |
732 | Returns the value slot (type C<SV*>) stored in the hash entry. |
733 | |
734 | SV* HeVAL(HE* he) |
735 | |
497711e7 |
736 | =for hackers |
737 | Found in file hv.h |
738 | |
954c1994 |
739 | =item HvNAME |
740 | |
741 | Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>. |
742 | |
743 | char* HvNAME(HV* stash) |
744 | |
497711e7 |
745 | =for hackers |
746 | Found in file hv.h |
747 | |
954c1994 |
748 | =item hv_clear |
749 | |
750 | Clears a hash, making it empty. |
751 | |
752 | void hv_clear(HV* tb) |
753 | |
497711e7 |
754 | =for hackers |
755 | Found in file hv.c |
756 | |
954c1994 |
757 | =item hv_delete |
758 | |
759 | Deletes a key/value pair in the hash. The value SV is removed from the |
1c846c1f |
760 | hash and returned to the caller. The C<klen> is the length of the key. |
954c1994 |
761 | The C<flags> value will normally be zero; if set to G_DISCARD then NULL |
762 | will be returned. |
763 | |
da58a35d |
764 | SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags) |
954c1994 |
765 | |
497711e7 |
766 | =for hackers |
767 | Found in file hv.c |
768 | |
954c1994 |
769 | =item hv_delete_ent |
770 | |
771 | Deletes a key/value pair in the hash. The value SV is removed from the |
772 | hash and returned to the caller. The C<flags> value will normally be zero; |
773 | if set to G_DISCARD then NULL will be returned. C<hash> can be a valid |
774 | precomputed hash value, or 0 to ask for it to be computed. |
775 | |
776 | SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash) |
777 | |
497711e7 |
778 | =for hackers |
779 | Found in file hv.c |
780 | |
954c1994 |
781 | =item hv_exists |
782 | |
783 | Returns a boolean indicating whether the specified hash key exists. The |
784 | C<klen> is the length of the key. |
785 | |
da58a35d |
786 | bool hv_exists(HV* tb, const char* key, I32 klen) |
954c1994 |
787 | |
497711e7 |
788 | =for hackers |
789 | Found in file hv.c |
790 | |
954c1994 |
791 | =item hv_exists_ent |
792 | |
793 | Returns a boolean indicating whether the specified hash key exists. C<hash> |
794 | can be a valid precomputed hash value, or 0 to ask for it to be |
795 | computed. |
796 | |
797 | bool hv_exists_ent(HV* tb, SV* key, U32 hash) |
798 | |
497711e7 |
799 | =for hackers |
800 | Found in file hv.c |
801 | |
954c1994 |
802 | =item hv_fetch |
803 | |
804 | Returns the SV which corresponds to the specified key in the hash. The |
805 | C<klen> is the length of the key. If C<lval> is set then the fetch will be |
806 | part of a store. Check that the return value is non-null before |
1c846c1f |
807 | dereferencing it to a C<SV*>. |
954c1994 |
808 | |
96f1132b |
809 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 |
810 | information on how to use this function on tied hashes. |
811 | |
da58a35d |
812 | SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval) |
954c1994 |
813 | |
497711e7 |
814 | =for hackers |
815 | Found in file hv.c |
816 | |
954c1994 |
817 | =item hv_fetch_ent |
818 | |
819 | Returns the hash entry which corresponds to the specified key in the hash. |
820 | C<hash> must be a valid precomputed hash number for the given C<key>, or 0 |
821 | if you want the function to compute it. IF C<lval> is set then the fetch |
822 | will be part of a store. Make sure the return value is non-null before |
823 | accessing it. The return value when C<tb> is a tied hash is a pointer to a |
824 | static location, so be sure to make a copy of the structure if you need to |
1c846c1f |
825 | store it somewhere. |
954c1994 |
826 | |
96f1132b |
827 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 |
828 | information on how to use this function on tied hashes. |
829 | |
830 | HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash) |
831 | |
497711e7 |
832 | =for hackers |
833 | Found in file hv.c |
834 | |
954c1994 |
835 | =item hv_iterinit |
836 | |
837 | Prepares a starting point to traverse a hash table. Returns the number of |
838 | keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is |
1c846c1f |
839 | currently only meaningful for hashes without tie magic. |
954c1994 |
840 | |
841 | NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of |
842 | hash buckets that happen to be in use. If you still need that esoteric |
843 | value, you can get it through the macro C<HvFILL(tb)>. |
844 | |
845 | I32 hv_iterinit(HV* tb) |
846 | |
497711e7 |
847 | =for hackers |
848 | Found in file hv.c |
849 | |
954c1994 |
850 | =item hv_iterkey |
851 | |
852 | Returns the key from the current position of the hash iterator. See |
853 | C<hv_iterinit>. |
854 | |
855 | char* hv_iterkey(HE* entry, I32* retlen) |
856 | |
497711e7 |
857 | =for hackers |
858 | Found in file hv.c |
859 | |
954c1994 |
860 | =item hv_iterkeysv |
861 | |
862 | Returns the key as an C<SV*> from the current position of the hash |
863 | iterator. The return value will always be a mortal copy of the key. Also |
864 | see C<hv_iterinit>. |
865 | |
866 | SV* hv_iterkeysv(HE* entry) |
867 | |
497711e7 |
868 | =for hackers |
869 | Found in file hv.c |
870 | |
954c1994 |
871 | =item hv_iternext |
872 | |
873 | Returns entries from a hash iterator. See C<hv_iterinit>. |
874 | |
875 | HE* hv_iternext(HV* tb) |
876 | |
497711e7 |
877 | =for hackers |
878 | Found in file hv.c |
879 | |
954c1994 |
880 | =item hv_iternextsv |
881 | |
882 | Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one |
883 | operation. |
884 | |
885 | SV* hv_iternextsv(HV* hv, char** key, I32* retlen) |
886 | |
497711e7 |
887 | =for hackers |
888 | Found in file hv.c |
889 | |
954c1994 |
890 | =item hv_iterval |
891 | |
892 | Returns the value from the current position of the hash iterator. See |
893 | C<hv_iterkey>. |
894 | |
895 | SV* hv_iterval(HV* tb, HE* entry) |
896 | |
497711e7 |
897 | =for hackers |
898 | Found in file hv.c |
899 | |
954c1994 |
900 | =item hv_magic |
901 | |
902 | Adds magic to a hash. See C<sv_magic>. |
903 | |
904 | void hv_magic(HV* hv, GV* gv, int how) |
905 | |
497711e7 |
906 | =for hackers |
907 | Found in file hv.c |
908 | |
954c1994 |
909 | =item hv_store |
910 | |
911 | Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is |
912 | the length of the key. The C<hash> parameter is the precomputed hash |
913 | value; if it is zero then Perl will compute it. The return value will be |
914 | NULL if the operation failed or if the value did not need to be actually |
915 | stored within the hash (as in the case of tied hashes). Otherwise it can |
916 | be dereferenced to get the original C<SV*>. Note that the caller is |
917 | responsible for suitably incrementing the reference count of C<val> before |
1c846c1f |
918 | the call, and decrementing it if the function returned NULL. |
954c1994 |
919 | |
96f1132b |
920 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 |
921 | information on how to use this function on tied hashes. |
922 | |
da58a35d |
923 | SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash) |
954c1994 |
924 | |
497711e7 |
925 | =for hackers |
926 | Found in file hv.c |
927 | |
954c1994 |
928 | =item hv_store_ent |
929 | |
930 | Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash> |
931 | parameter is the precomputed hash value; if it is zero then Perl will |
932 | compute it. The return value is the new hash entry so created. It will be |
933 | NULL if the operation failed or if the value did not need to be actually |
934 | stored within the hash (as in the case of tied hashes). Otherwise the |
935 | contents of the return value can be accessed using the C<He???> macros |
936 | described here. Note that the caller is responsible for suitably |
937 | incrementing the reference count of C<val> before the call, and |
1c846c1f |
938 | decrementing it if the function returned NULL. |
954c1994 |
939 | |
96f1132b |
940 | See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more |
954c1994 |
941 | information on how to use this function on tied hashes. |
942 | |
943 | HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash) |
944 | |
497711e7 |
945 | =for hackers |
946 | Found in file hv.c |
947 | |
954c1994 |
948 | =item hv_undef |
949 | |
950 | Undefines the hash. |
951 | |
952 | void hv_undef(HV* tb) |
953 | |
497711e7 |
954 | =for hackers |
955 | Found in file hv.c |
956 | |
954c1994 |
957 | =item isALNUM |
958 | |
4375e838 |
959 | Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric |
f1cbbd6e |
960 | character (including underscore) or digit. |
954c1994 |
961 | |
962 | bool isALNUM(char ch) |
963 | |
497711e7 |
964 | =for hackers |
965 | Found in file handy.h |
966 | |
954c1994 |
967 | =item isALPHA |
968 | |
4375e838 |
969 | Returns a boolean indicating whether the C C<char> is an ASCII alphabetic |
954c1994 |
970 | character. |
971 | |
972 | bool isALPHA(char ch) |
973 | |
497711e7 |
974 | =for hackers |
975 | Found in file handy.h |
976 | |
954c1994 |
977 | =item isDIGIT |
978 | |
4375e838 |
979 | Returns a boolean indicating whether the C C<char> is an ASCII |
954c1994 |
980 | digit. |
981 | |
982 | bool isDIGIT(char ch) |
983 | |
497711e7 |
984 | =for hackers |
985 | Found in file handy.h |
986 | |
954c1994 |
987 | =item isLOWER |
988 | |
989 | Returns a boolean indicating whether the C C<char> is a lowercase |
990 | character. |
991 | |
992 | bool isLOWER(char ch) |
993 | |
497711e7 |
994 | =for hackers |
995 | Found in file handy.h |
996 | |
954c1994 |
997 | =item isSPACE |
998 | |
999 | Returns a boolean indicating whether the C C<char> is whitespace. |
1000 | |
1001 | bool isSPACE(char ch) |
1002 | |
497711e7 |
1003 | =for hackers |
1004 | Found in file handy.h |
1005 | |
954c1994 |
1006 | =item isUPPER |
1007 | |
1008 | Returns a boolean indicating whether the C C<char> is an uppercase |
1009 | character. |
1010 | |
1011 | bool isUPPER(char ch) |
1012 | |
497711e7 |
1013 | =for hackers |
1014 | Found in file handy.h |
1015 | |
954c1994 |
1016 | =item items |
1017 | |
1018 | Variable which is setup by C<xsubpp> to indicate the number of |
1019 | items on the stack. See L<perlxs/"Variable-length Parameter Lists">. |
1020 | |
1021 | I32 items |
1022 | |
497711e7 |
1023 | =for hackers |
1024 | Found in file XSUB.h |
1025 | |
954c1994 |
1026 | =item ix |
1027 | |
1028 | Variable which is setup by C<xsubpp> to indicate which of an |
1029 | XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">. |
1030 | |
1031 | I32 ix |
1032 | |
497711e7 |
1033 | =for hackers |
1034 | Found in file XSUB.h |
1035 | |
954c1994 |
1036 | =item LEAVE |
1037 | |
1038 | Closing bracket on a callback. See C<ENTER> and L<perlcall>. |
1039 | |
1040 | LEAVE; |
1041 | |
497711e7 |
1042 | =for hackers |
1043 | Found in file scope.h |
1044 | |
954c1994 |
1045 | =item looks_like_number |
1046 | |
1047 | Test if an the content of an SV looks like a number (or is a |
a8586c98 |
1048 | number). C<Inf> and C<Infinity> are treated as numbers (so will not |
1049 | issue a non-numeric warning), even if your atof() doesn't grok them. |
954c1994 |
1050 | |
1051 | I32 looks_like_number(SV* sv) |
1052 | |
497711e7 |
1053 | =for hackers |
1054 | Found in file sv.c |
1055 | |
954c1994 |
1056 | =item MARK |
1057 | |
1058 | Stack marker variable for the XSUB. See C<dMARK>. |
1059 | |
497711e7 |
1060 | =for hackers |
1061 | Found in file pp.h |
1062 | |
954c1994 |
1063 | =item mg_clear |
1064 | |
1065 | Clear something magical that the SV represents. See C<sv_magic>. |
1066 | |
1067 | int mg_clear(SV* sv) |
1068 | |
497711e7 |
1069 | =for hackers |
1070 | Found in file mg.c |
1071 | |
954c1994 |
1072 | =item mg_copy |
1073 | |
1074 | Copies the magic from one SV to another. See C<sv_magic>. |
1075 | |
1076 | int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen) |
1077 | |
497711e7 |
1078 | =for hackers |
1079 | Found in file mg.c |
1080 | |
954c1994 |
1081 | =item mg_find |
1082 | |
1083 | Finds the magic pointer for type matching the SV. See C<sv_magic>. |
1084 | |
1085 | MAGIC* mg_find(SV* sv, int type) |
1086 | |
497711e7 |
1087 | =for hackers |
1088 | Found in file mg.c |
1089 | |
954c1994 |
1090 | =item mg_free |
1091 | |
1092 | Free any magic storage used by the SV. See C<sv_magic>. |
1093 | |
1094 | int mg_free(SV* sv) |
1095 | |
497711e7 |
1096 | =for hackers |
1097 | Found in file mg.c |
1098 | |
954c1994 |
1099 | =item mg_get |
1100 | |
1101 | Do magic after a value is retrieved from the SV. See C<sv_magic>. |
1102 | |
1103 | int mg_get(SV* sv) |
1104 | |
497711e7 |
1105 | =for hackers |
1106 | Found in file mg.c |
1107 | |
954c1994 |
1108 | =item mg_length |
1109 | |
1110 | Report on the SV's length. See C<sv_magic>. |
1111 | |
1112 | U32 mg_length(SV* sv) |
1113 | |
497711e7 |
1114 | =for hackers |
1115 | Found in file mg.c |
1116 | |
954c1994 |
1117 | =item mg_magical |
1118 | |
1119 | Turns on the magical status of an SV. See C<sv_magic>. |
1120 | |
1121 | void mg_magical(SV* sv) |
1122 | |
497711e7 |
1123 | =for hackers |
1124 | Found in file mg.c |
1125 | |
954c1994 |
1126 | =item mg_set |
1127 | |
1128 | Do magic after a value is assigned to the SV. See C<sv_magic>. |
1129 | |
1130 | int mg_set(SV* sv) |
1131 | |
497711e7 |
1132 | =for hackers |
1133 | Found in file mg.c |
1134 | |
954c1994 |
1135 | =item Move |
1136 | |
1137 | The XSUB-writer's interface to the C C<memmove> function. The C<src> is the |
1138 | source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is |
1139 | the type. Can do overlapping moves. See also C<Copy>. |
1140 | |
1141 | void Move(void* src, void* dest, int nitems, type) |
1142 | |
497711e7 |
1143 | =for hackers |
1144 | Found in file handy.h |
1145 | |
954c1994 |
1146 | =item New |
1147 | |
1148 | The XSUB-writer's interface to the C C<malloc> function. |
1149 | |
1150 | void New(int id, void* ptr, int nitems, type) |
1151 | |
497711e7 |
1152 | =for hackers |
1153 | Found in file handy.h |
1154 | |
954c1994 |
1155 | =item newAV |
1156 | |
1157 | Creates a new AV. The reference count is set to 1. |
1158 | |
1159 | AV* newAV() |
1160 | |
497711e7 |
1161 | =for hackers |
1162 | Found in file av.c |
1163 | |
954c1994 |
1164 | =item Newc |
1165 | |
1166 | The XSUB-writer's interface to the C C<malloc> function, with |
1167 | cast. |
1168 | |
1169 | void Newc(int id, void* ptr, int nitems, type, cast) |
1170 | |
497711e7 |
1171 | =for hackers |
1172 | Found in file handy.h |
1173 | |
954c1994 |
1174 | =item newCONSTSUB |
1175 | |
1176 | Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is |
1177 | eligible for inlining at compile-time. |
1178 | |
beab0874 |
1179 | CV* newCONSTSUB(HV* stash, char* name, SV* sv) |
954c1994 |
1180 | |
497711e7 |
1181 | =for hackers |
35676c7e |
1182 | Found in file op.c |
497711e7 |
1183 | |
954c1994 |
1184 | =item newHV |
1185 | |
1186 | Creates a new HV. The reference count is set to 1. |
1187 | |
1188 | HV* newHV() |
1189 | |
497711e7 |
1190 | =for hackers |
1191 | Found in file hv.c |
1192 | |
954c1994 |
1193 | =item newRV_inc |
1194 | |
1195 | Creates an RV wrapper for an SV. The reference count for the original SV is |
1196 | incremented. |
1197 | |
1198 | SV* newRV_inc(SV* sv) |
1199 | |
497711e7 |
1200 | =for hackers |
1201 | Found in file sv.h |
1202 | |
954c1994 |
1203 | =item newRV_noinc |
1204 | |
1205 | Creates an RV wrapper for an SV. The reference count for the original |
1206 | SV is B<not> incremented. |
1207 | |
1208 | SV* newRV_noinc(SV *sv) |
1209 | |
497711e7 |
1210 | =for hackers |
1211 | Found in file sv.c |
1212 | |
954c1994 |
1213 | =item NEWSV |
1214 | |
1215 | Creates a new SV. A non-zero C<len> parameter indicates the number of |
1216 | bytes of preallocated string space the SV should have. An extra byte for a |
1217 | tailing NUL is also reserved. (SvPOK is not set for the SV even if string |
444155da |
1218 | space is allocated.) The reference count for the new SV is set to 1. |
954c1994 |
1219 | C<id> is an integer id between 0 and 1299 (used to identify leaks). |
1220 | |
1221 | SV* NEWSV(int id, STRLEN len) |
1222 | |
497711e7 |
1223 | =for hackers |
1224 | Found in file handy.h |
1225 | |
954c1994 |
1226 | =item newSViv |
1227 | |
1228 | Creates a new SV and copies an integer into it. The reference count for the |
1229 | SV is set to 1. |
1230 | |
1231 | SV* newSViv(IV i) |
1232 | |
497711e7 |
1233 | =for hackers |
1234 | Found in file sv.c |
1235 | |
954c1994 |
1236 | =item newSVnv |
1237 | |
1238 | Creates a new SV and copies a floating point value into it. |
1239 | The reference count for the SV is set to 1. |
1240 | |
1241 | SV* newSVnv(NV n) |
1242 | |
497711e7 |
1243 | =for hackers |
1244 | Found in file sv.c |
1245 | |
954c1994 |
1246 | =item newSVpv |
1247 | |
1248 | Creates a new SV and copies a string into it. The reference count for the |
1249 | SV is set to 1. If C<len> is zero, Perl will compute the length using |
1250 | strlen(). For efficiency, consider using C<newSVpvn> instead. |
1251 | |
1252 | SV* newSVpv(const char* s, STRLEN len) |
1253 | |
497711e7 |
1254 | =for hackers |
1255 | Found in file sv.c |
1256 | |
954c1994 |
1257 | =item newSVpvf |
1258 | |
1259 | Creates a new SV an initialize it with the string formatted like |
1260 | C<sprintf>. |
1261 | |
1262 | SV* newSVpvf(const char* pat, ...) |
1263 | |
497711e7 |
1264 | =for hackers |
1265 | Found in file sv.c |
1266 | |
954c1994 |
1267 | =item newSVpvn |
1268 | |
1269 | Creates a new SV and copies a string into it. The reference count for the |
1c846c1f |
1270 | SV is set to 1. Note that if C<len> is zero, Perl will create a zero length |
954c1994 |
1271 | string. You are responsible for ensuring that the source string is at least |
1272 | C<len> bytes long. |
1273 | |
1274 | SV* newSVpvn(const char* s, STRLEN len) |
1275 | |
497711e7 |
1276 | =for hackers |
1277 | Found in file sv.c |
1278 | |
1c846c1f |
1279 | =item newSVpvn_share |
1280 | |
1281 | Creates a new SV and populates it with a string from |
1282 | the string table. Turns on READONLY and FAKE. |
1283 | The idea here is that as string table is used for shared hash |
1284 | keys these strings will have SvPVX == HeKEY and hash lookup |
1285 | will avoid string compare. |
1286 | |
ae154d6d |
1287 | SV* newSVpvn_share(const char* s, I32 len, U32 hash) |
1c846c1f |
1288 | |
1289 | =for hackers |
1290 | Found in file sv.c |
1291 | |
954c1994 |
1292 | =item newSVrv |
1293 | |
1294 | Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then |
1295 | it will be upgraded to one. If C<classname> is non-null then the new SV will |
1296 | be blessed in the specified package. The new SV is returned and its |
1297 | reference count is 1. |
1298 | |
1299 | SV* newSVrv(SV* rv, const char* classname) |
1300 | |
497711e7 |
1301 | =for hackers |
1302 | Found in file sv.c |
1303 | |
954c1994 |
1304 | =item newSVsv |
1305 | |
1306 | Creates a new SV which is an exact duplicate of the original SV. |
1307 | |
1308 | SV* newSVsv(SV* old) |
1309 | |
497711e7 |
1310 | =for hackers |
1311 | Found in file sv.c |
1312 | |
1a3327fb |
1313 | =item newSVuv |
1314 | |
1315 | Creates a new SV and copies an unsigned integer into it. |
1316 | The reference count for the SV is set to 1. |
1317 | |
1318 | SV* newSVuv(UV u) |
1319 | |
497711e7 |
1320 | =for hackers |
1321 | Found in file sv.c |
1322 | |
954c1994 |
1323 | =item newXS |
1324 | |
1325 | Used by C<xsubpp> to hook up XSUBs as Perl subs. |
1326 | |
497711e7 |
1327 | =for hackers |
35676c7e |
1328 | Found in file op.c |
497711e7 |
1329 | |
954c1994 |
1330 | =item newXSproto |
1331 | |
1332 | Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to |
1333 | the subs. |
1334 | |
497711e7 |
1335 | =for hackers |
1336 | Found in file XSUB.h |
1337 | |
954c1994 |
1338 | =item Newz |
1339 | |
1340 | The XSUB-writer's interface to the C C<malloc> function. The allocated |
1341 | memory is zeroed with C<memzero>. |
1342 | |
1343 | void Newz(int id, void* ptr, int nitems, type) |
1344 | |
497711e7 |
1345 | =for hackers |
1346 | Found in file handy.h |
1347 | |
954c1994 |
1348 | =item Nullav |
1349 | |
1350 | Null AV pointer. |
1351 | |
497711e7 |
1352 | =for hackers |
1353 | Found in file av.h |
1354 | |
954c1994 |
1355 | =item Nullch |
1356 | |
1357 | Null character pointer. |
1358 | |
497711e7 |
1359 | =for hackers |
1360 | Found in file handy.h |
1361 | |
954c1994 |
1362 | =item Nullcv |
1363 | |
1364 | Null CV pointer. |
1365 | |
497711e7 |
1366 | =for hackers |
1367 | Found in file cv.h |
1368 | |
954c1994 |
1369 | =item Nullhv |
1370 | |
1371 | Null HV pointer. |
1372 | |
497711e7 |
1373 | =for hackers |
1374 | Found in file hv.h |
1375 | |
954c1994 |
1376 | =item Nullsv |
1377 | |
1378 | Null SV pointer. |
1379 | |
497711e7 |
1380 | =for hackers |
1381 | Found in file handy.h |
1382 | |
954c1994 |
1383 | =item ORIGMARK |
1384 | |
1385 | The original stack mark for the XSUB. See C<dORIGMARK>. |
1386 | |
497711e7 |
1387 | =for hackers |
1388 | Found in file pp.h |
1389 | |
954c1994 |
1390 | =item perl_alloc |
1391 | |
1392 | Allocates a new Perl interpreter. See L<perlembed>. |
1393 | |
1394 | PerlInterpreter* perl_alloc() |
1395 | |
497711e7 |
1396 | =for hackers |
1397 | Found in file perl.c |
1398 | |
954c1994 |
1399 | =item perl_construct |
1400 | |
1401 | Initializes a new Perl interpreter. See L<perlembed>. |
1402 | |
1403 | void perl_construct(PerlInterpreter* interp) |
1404 | |
497711e7 |
1405 | =for hackers |
1406 | Found in file perl.c |
1407 | |
954c1994 |
1408 | =item perl_destruct |
1409 | |
1410 | Shuts down a Perl interpreter. See L<perlembed>. |
1411 | |
1412 | void perl_destruct(PerlInterpreter* interp) |
1413 | |
497711e7 |
1414 | =for hackers |
1415 | Found in file perl.c |
1416 | |
954c1994 |
1417 | =item perl_free |
1418 | |
1419 | Releases a Perl interpreter. See L<perlembed>. |
1420 | |
1421 | void perl_free(PerlInterpreter* interp) |
1422 | |
497711e7 |
1423 | =for hackers |
1424 | Found in file perl.c |
1425 | |
954c1994 |
1426 | =item perl_parse |
1427 | |
1428 | Tells a Perl interpreter to parse a Perl script. See L<perlembed>. |
1429 | |
1430 | int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env) |
1431 | |
497711e7 |
1432 | =for hackers |
1433 | Found in file perl.c |
1434 | |
954c1994 |
1435 | =item perl_run |
1436 | |
1437 | Tells a Perl interpreter to run. See L<perlembed>. |
1438 | |
1439 | int perl_run(PerlInterpreter* interp) |
1440 | |
497711e7 |
1441 | =for hackers |
1442 | Found in file perl.c |
1443 | |
954c1994 |
1444 | =item PL_DBsingle |
1445 | |
1446 | When Perl is run in debugging mode, with the B<-d> switch, this SV is a |
ae154d6d |
1447 | boolean which indicates whether subs are being single-stepped. |
954c1994 |
1448 | Single-stepping is automatically turned on after every step. This is the C |
1449 | variable which corresponds to Perl's $DB::single variable. See |
1450 | C<PL_DBsub>. |
1451 | |
1452 | SV * PL_DBsingle |
1453 | |
497711e7 |
1454 | =for hackers |
1455 | Found in file intrpvar.h |
1456 | |
954c1994 |
1457 | =item PL_DBsub |
1458 | |
1459 | When Perl is run in debugging mode, with the B<-d> switch, this GV contains |
1460 | the SV which holds the name of the sub being debugged. This is the C |
1461 | variable which corresponds to Perl's $DB::sub variable. See |
1462 | C<PL_DBsingle>. |
1463 | |
1464 | GV * PL_DBsub |
1465 | |
497711e7 |
1466 | =for hackers |
1467 | Found in file intrpvar.h |
1468 | |
954c1994 |
1469 | =item PL_DBtrace |
1470 | |
1471 | Trace variable used when Perl is run in debugging mode, with the B<-d> |
1472 | switch. This is the C variable which corresponds to Perl's $DB::trace |
1473 | variable. See C<PL_DBsingle>. |
1474 | |
1475 | SV * PL_DBtrace |
1476 | |
497711e7 |
1477 | =for hackers |
1478 | Found in file intrpvar.h |
1479 | |
954c1994 |
1480 | =item PL_dowarn |
1481 | |
1482 | The C variable which corresponds to Perl's $^W warning variable. |
1483 | |
1484 | bool PL_dowarn |
1485 | |
497711e7 |
1486 | =for hackers |
1487 | Found in file intrpvar.h |
1488 | |
c155e47c |
1489 | =item PL_last_in_gv |
1490 | |
1491 | The GV which was last used for a filehandle input operation. (C<< <FH> >>) |
1492 | |
1493 | GV* PL_last_in_gv |
1494 | |
1495 | =for hackers |
1496 | Found in file thrdvar.h |
1497 | |
954c1994 |
1498 | =item PL_modglobal |
1499 | |
ae154d6d |
1500 | C<PL_modglobal> is a general purpose, interpreter global HV for use by |
954c1994 |
1501 | extensions that need to keep information on a per-interpreter basis. |
ae154d6d |
1502 | In a pinch, it can also be used as a symbol table for extensions |
1503 | to share data among each other. It is a good idea to use keys |
954c1994 |
1504 | prefixed by the package name of the extension that owns the data. |
1505 | |
1506 | HV* PL_modglobal |
1507 | |
497711e7 |
1508 | =for hackers |
1509 | Found in file intrpvar.h |
1510 | |
954c1994 |
1511 | =item PL_na |
1512 | |
1513 | A convenience variable which is typically used with C<SvPV> when one |
1514 | doesn't care about the length of the string. It is usually more efficient |
1515 | to either declare a local variable and use that instead or to use the |
1516 | C<SvPV_nolen> macro. |
1517 | |
1518 | STRLEN PL_na |
1519 | |
497711e7 |
1520 | =for hackers |
1521 | Found in file thrdvar.h |
1522 | |
c155e47c |
1523 | =item PL_ofs_sv |
1524 | |
1525 | The output field separator - C<$,> in Perl space. |
1526 | |
1527 | SV* PL_ofs_sv |
1528 | |
1529 | =for hackers |
1530 | Found in file thrdvar.h |
1531 | |
1532 | =item PL_rs |
1533 | |
1534 | The input record separator - C<$/> in Perl space. |
1535 | |
1536 | SV* PL_rs |
1537 | |
1538 | =for hackers |
1539 | Found in file thrdvar.h |
1540 | |
954c1994 |
1541 | =item PL_sv_no |
1542 | |
1543 | This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as |
1544 | C<&PL_sv_no>. |
1545 | |
1546 | SV PL_sv_no |
1547 | |
497711e7 |
1548 | =for hackers |
1549 | Found in file intrpvar.h |
1550 | |
954c1994 |
1551 | =item PL_sv_undef |
1552 | |
1553 | This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>. |
1554 | |
1555 | SV PL_sv_undef |
1556 | |
497711e7 |
1557 | =for hackers |
1558 | Found in file intrpvar.h |
1559 | |
954c1994 |
1560 | =item PL_sv_yes |
1561 | |
1562 | This is the C<true> SV. See C<PL_sv_no>. Always refer to this as |
1563 | C<&PL_sv_yes>. |
1564 | |
1565 | SV PL_sv_yes |
1566 | |
497711e7 |
1567 | =for hackers |
1568 | Found in file intrpvar.h |
1569 | |
954c1994 |
1570 | =item POPi |
1571 | |
1572 | Pops an integer off the stack. |
1573 | |
1574 | IV POPi |
1575 | |
497711e7 |
1576 | =for hackers |
1577 | Found in file pp.h |
1578 | |
954c1994 |
1579 | =item POPl |
1580 | |
1581 | Pops a long off the stack. |
1582 | |
1583 | long POPl |
1584 | |
497711e7 |
1585 | =for hackers |
1586 | Found in file pp.h |
1587 | |
954c1994 |
1588 | =item POPn |
1589 | |
1590 | Pops a double off the stack. |
1591 | |
1592 | NV POPn |
1593 | |
497711e7 |
1594 | =for hackers |
1595 | Found in file pp.h |
1596 | |
954c1994 |
1597 | =item POPp |
1598 | |
1599 | Pops a string off the stack. |
1600 | |
1601 | char* POPp |
1602 | |
497711e7 |
1603 | =for hackers |
1604 | Found in file pp.h |
1605 | |
954c1994 |
1606 | =item POPs |
1607 | |
1608 | Pops an SV off the stack. |
1609 | |
1610 | SV* POPs |
1611 | |
497711e7 |
1612 | =for hackers |
1613 | Found in file pp.h |
1614 | |
954c1994 |
1615 | =item PUSHi |
1616 | |
1617 | Push an integer onto the stack. The stack must have room for this element. |
1618 | Handles 'set' magic. See C<XPUSHi>. |
1619 | |
1620 | void PUSHi(IV iv) |
1621 | |
497711e7 |
1622 | =for hackers |
1623 | Found in file pp.h |
1624 | |
954c1994 |
1625 | =item PUSHMARK |
1626 | |
1627 | Opening bracket for arguments on a callback. See C<PUTBACK> and |
1628 | L<perlcall>. |
1629 | |
1630 | PUSHMARK; |
1631 | |
497711e7 |
1632 | =for hackers |
1633 | Found in file pp.h |
1634 | |
954c1994 |
1635 | =item PUSHn |
1636 | |
1637 | Push a double onto the stack. The stack must have room for this element. |
1638 | Handles 'set' magic. See C<XPUSHn>. |
1639 | |
1640 | void PUSHn(NV nv) |
1641 | |
497711e7 |
1642 | =for hackers |
1643 | Found in file pp.h |
1644 | |
954c1994 |
1645 | =item PUSHp |
1646 | |
1647 | Push a string onto the stack. The stack must have room for this element. |
1648 | The C<len> indicates the length of the string. Handles 'set' magic. See |
1649 | C<XPUSHp>. |
1650 | |
1651 | void PUSHp(char* str, STRLEN len) |
1652 | |
497711e7 |
1653 | =for hackers |
1654 | Found in file pp.h |
1655 | |
954c1994 |
1656 | =item PUSHs |
1657 | |
1c846c1f |
1658 | Push an SV onto the stack. The stack must have room for this element. |
954c1994 |
1659 | Does not handle 'set' magic. See C<XPUSHs>. |
1660 | |
1661 | void PUSHs(SV* sv) |
1662 | |
497711e7 |
1663 | =for hackers |
1664 | Found in file pp.h |
1665 | |
954c1994 |
1666 | =item PUSHu |
1667 | |
1668 | Push an unsigned integer onto the stack. The stack must have room for this |
1669 | element. See C<XPUSHu>. |
1670 | |
1671 | void PUSHu(UV uv) |
1672 | |
497711e7 |
1673 | =for hackers |
1674 | Found in file pp.h |
1675 | |
954c1994 |
1676 | =item PUTBACK |
1677 | |
1678 | Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>. |
1679 | See C<PUSHMARK> and L<perlcall> for other uses. |
1680 | |
1681 | PUTBACK; |
1682 | |
497711e7 |
1683 | =for hackers |
1684 | Found in file pp.h |
1685 | |
954c1994 |
1686 | =item Renew |
1687 | |
1688 | The XSUB-writer's interface to the C C<realloc> function. |
1689 | |
1690 | void Renew(void* ptr, int nitems, type) |
1691 | |
497711e7 |
1692 | =for hackers |
1693 | Found in file handy.h |
1694 | |
954c1994 |
1695 | =item Renewc |
1696 | |
1697 | The XSUB-writer's interface to the C C<realloc> function, with |
1698 | cast. |
1699 | |
1700 | void Renewc(void* ptr, int nitems, type, cast) |
1701 | |
497711e7 |
1702 | =for hackers |
1703 | Found in file handy.h |
1704 | |
954c1994 |
1705 | =item require_pv |
1706 | |
1707 | Tells Perl to C<require> a module. |
1708 | |
1709 | NOTE: the perl_ form of this function is deprecated. |
1710 | |
1711 | void require_pv(const char* pv) |
1712 | |
497711e7 |
1713 | =for hackers |
1714 | Found in file perl.c |
1715 | |
954c1994 |
1716 | =item RETVAL |
1717 | |
1718 | Variable which is setup by C<xsubpp> to hold the return value for an |
1719 | XSUB. This is always the proper type for the XSUB. See |
1720 | L<perlxs/"The RETVAL Variable">. |
1721 | |
1722 | (whatever) RETVAL |
1723 | |
497711e7 |
1724 | =for hackers |
1725 | Found in file XSUB.h |
1726 | |
954c1994 |
1727 | =item Safefree |
1728 | |
1729 | The XSUB-writer's interface to the C C<free> function. |
1730 | |
49b8b560 |
1731 | void Safefree(void* ptr) |
954c1994 |
1732 | |
497711e7 |
1733 | =for hackers |
1734 | Found in file handy.h |
1735 | |
954c1994 |
1736 | =item savepv |
1737 | |
1738 | Copy a string to a safe spot. This does not use an SV. |
1739 | |
1740 | char* savepv(const char* sv) |
1741 | |
497711e7 |
1742 | =for hackers |
1743 | Found in file util.c |
1744 | |
954c1994 |
1745 | =item savepvn |
1746 | |
1747 | Copy a string to a safe spot. The C<len> indicates number of bytes to |
1748 | copy. This does not use an SV. |
1749 | |
1750 | char* savepvn(const char* sv, I32 len) |
1751 | |
497711e7 |
1752 | =for hackers |
1753 | Found in file util.c |
1754 | |
954c1994 |
1755 | =item SAVETMPS |
1756 | |
1757 | Opening bracket for temporaries on a callback. See C<FREETMPS> and |
1758 | L<perlcall>. |
1759 | |
1760 | SAVETMPS; |
1761 | |
497711e7 |
1762 | =for hackers |
1763 | Found in file scope.h |
1764 | |
954c1994 |
1765 | =item SP |
1766 | |
1767 | Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and |
1768 | C<SPAGAIN>. |
1769 | |
497711e7 |
1770 | =for hackers |
1771 | Found in file pp.h |
1772 | |
954c1994 |
1773 | =item SPAGAIN |
1774 | |
1775 | Refetch the stack pointer. Used after a callback. See L<perlcall>. |
1776 | |
1777 | SPAGAIN; |
1778 | |
497711e7 |
1779 | =for hackers |
1780 | Found in file pp.h |
1781 | |
954c1994 |
1782 | =item ST |
1783 | |
1784 | Used to access elements on the XSUB's stack. |
1785 | |
1786 | SV* ST(int ix) |
1787 | |
497711e7 |
1788 | =for hackers |
1789 | Found in file XSUB.h |
1790 | |
954c1994 |
1791 | =item strEQ |
1792 | |
1793 | Test two strings to see if they are equal. Returns true or false. |
1794 | |
1795 | bool strEQ(char* s1, char* s2) |
1796 | |
497711e7 |
1797 | =for hackers |
1798 | Found in file handy.h |
1799 | |
954c1994 |
1800 | =item strGE |
1801 | |
1802 | Test two strings to see if the first, C<s1>, is greater than or equal to |
1803 | the second, C<s2>. Returns true or false. |
1804 | |
1805 | bool strGE(char* s1, char* s2) |
1806 | |
497711e7 |
1807 | =for hackers |
1808 | Found in file handy.h |
1809 | |
954c1994 |
1810 | =item strGT |
1811 | |
1812 | Test two strings to see if the first, C<s1>, is greater than the second, |
1813 | C<s2>. Returns true or false. |
1814 | |
1815 | bool strGT(char* s1, char* s2) |
1816 | |
497711e7 |
1817 | =for hackers |
1818 | Found in file handy.h |
1819 | |
954c1994 |
1820 | =item strLE |
1821 | |
1822 | Test two strings to see if the first, C<s1>, is less than or equal to the |
1823 | second, C<s2>. Returns true or false. |
1824 | |
1825 | bool strLE(char* s1, char* s2) |
1826 | |
497711e7 |
1827 | =for hackers |
1828 | Found in file handy.h |
1829 | |
954c1994 |
1830 | =item strLT |
1831 | |
1832 | Test two strings to see if the first, C<s1>, is less than the second, |
1833 | C<s2>. Returns true or false. |
1834 | |
1835 | bool strLT(char* s1, char* s2) |
1836 | |
497711e7 |
1837 | =for hackers |
1838 | Found in file handy.h |
1839 | |
954c1994 |
1840 | =item strNE |
1841 | |
1842 | Test two strings to see if they are different. Returns true or |
1843 | false. |
1844 | |
1845 | bool strNE(char* s1, char* s2) |
1846 | |
497711e7 |
1847 | =for hackers |
1848 | Found in file handy.h |
1849 | |
954c1994 |
1850 | =item strnEQ |
1851 | |
1852 | Test two strings to see if they are equal. The C<len> parameter indicates |
1853 | the number of bytes to compare. Returns true or false. (A wrapper for |
1854 | C<strncmp>). |
1855 | |
1856 | bool strnEQ(char* s1, char* s2, STRLEN len) |
1857 | |
497711e7 |
1858 | =for hackers |
1859 | Found in file handy.h |
1860 | |
954c1994 |
1861 | =item strnNE |
1862 | |
1863 | Test two strings to see if they are different. The C<len> parameter |
1864 | indicates the number of bytes to compare. Returns true or false. (A |
1865 | wrapper for C<strncmp>). |
1866 | |
1867 | bool strnNE(char* s1, char* s2, STRLEN len) |
1868 | |
497711e7 |
1869 | =for hackers |
1870 | Found in file handy.h |
1871 | |
954c1994 |
1872 | =item StructCopy |
1873 | |
4375e838 |
1874 | This is an architecture-independent macro to copy one structure to another. |
954c1994 |
1875 | |
1876 | void StructCopy(type src, type dest, type) |
1877 | |
497711e7 |
1878 | =for hackers |
1879 | Found in file handy.h |
1880 | |
954c1994 |
1881 | =item SvCUR |
1882 | |
1883 | Returns the length of the string which is in the SV. See C<SvLEN>. |
1884 | |
1885 | STRLEN SvCUR(SV* sv) |
1886 | |
497711e7 |
1887 | =for hackers |
1888 | Found in file sv.h |
1889 | |
954c1994 |
1890 | =item SvCUR_set |
1891 | |
1892 | Set the length of the string which is in the SV. See C<SvCUR>. |
1893 | |
1894 | void SvCUR_set(SV* sv, STRLEN len) |
1895 | |
497711e7 |
1896 | =for hackers |
1897 | Found in file sv.h |
1898 | |
954c1994 |
1899 | =item SvEND |
1900 | |
1901 | Returns a pointer to the last character in the string which is in the SV. |
1902 | See C<SvCUR>. Access the character as *(SvEND(sv)). |
1903 | |
1904 | char* SvEND(SV* sv) |
1905 | |
497711e7 |
1906 | =for hackers |
1907 | Found in file sv.h |
1908 | |
954c1994 |
1909 | =item SvGETMAGIC |
1910 | |
1911 | Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its |
1912 | argument more than once. |
1913 | |
1914 | void SvGETMAGIC(SV* sv) |
1915 | |
497711e7 |
1916 | =for hackers |
1917 | Found in file sv.h |
1918 | |
954c1994 |
1919 | =item SvGROW |
1920 | |
1921 | Expands the character buffer in the SV so that it has room for the |
1922 | indicated number of bytes (remember to reserve space for an extra trailing |
1923 | NUL character). Calls C<sv_grow> to perform the expansion if necessary. |
1924 | Returns a pointer to the character buffer. |
1925 | |
1926 | void SvGROW(SV* sv, STRLEN len) |
1927 | |
497711e7 |
1928 | =for hackers |
1929 | Found in file sv.h |
1930 | |
954c1994 |
1931 | =item SvIOK |
1932 | |
1933 | Returns a boolean indicating whether the SV contains an integer. |
1934 | |
1935 | bool SvIOK(SV* sv) |
1936 | |
497711e7 |
1937 | =for hackers |
1938 | Found in file sv.h |
1939 | |
954c1994 |
1940 | =item SvIOKp |
1941 | |
1942 | Returns a boolean indicating whether the SV contains an integer. Checks |
1943 | the B<private> setting. Use C<SvIOK>. |
1944 | |
1945 | bool SvIOKp(SV* sv) |
1946 | |
497711e7 |
1947 | =for hackers |
1948 | Found in file sv.h |
1949 | |
e331fc52 |
1950 | =item SvIOK_notUV |
1951 | |
1952 | Returns a boolean indicating whether the SV contains an signed integer. |
1953 | |
1954 | void SvIOK_notUV(SV* sv) |
1955 | |
1956 | =for hackers |
1957 | Found in file sv.h |
1958 | |
954c1994 |
1959 | =item SvIOK_off |
1960 | |
1961 | Unsets the IV status of an SV. |
1962 | |
1963 | void SvIOK_off(SV* sv) |
1964 | |
497711e7 |
1965 | =for hackers |
1966 | Found in file sv.h |
1967 | |
954c1994 |
1968 | =item SvIOK_on |
1969 | |
1970 | Tells an SV that it is an integer. |
1971 | |
1972 | void SvIOK_on(SV* sv) |
1973 | |
497711e7 |
1974 | =for hackers |
1975 | Found in file sv.h |
1976 | |
954c1994 |
1977 | =item SvIOK_only |
1978 | |
1979 | Tells an SV that it is an integer and disables all other OK bits. |
1980 | |
1981 | void SvIOK_only(SV* sv) |
1982 | |
497711e7 |
1983 | =for hackers |
1984 | Found in file sv.h |
1985 | |
e331fc52 |
1986 | =item SvIOK_only_UV |
1987 | |
1988 | Tells and SV that it is an unsigned integer and disables all other OK bits. |
1989 | |
1990 | void SvIOK_only_UV(SV* sv) |
1991 | |
1992 | =for hackers |
1993 | Found in file sv.h |
1994 | |
1995 | =item SvIOK_UV |
1996 | |
1997 | Returns a boolean indicating whether the SV contains an unsigned integer. |
1998 | |
1999 | void SvIOK_UV(SV* sv) |
2000 | |
2001 | =for hackers |
2002 | Found in file sv.h |
2003 | |
954c1994 |
2004 | =item SvIV |
2005 | |
2006 | Coerces the given SV to an integer and returns it. |
2007 | |
2008 | IV SvIV(SV* sv) |
2009 | |
497711e7 |
2010 | =for hackers |
2011 | Found in file sv.h |
2012 | |
954c1994 |
2013 | =item SvIVX |
2014 | |
2015 | Returns the integer which is stored in the SV, assuming SvIOK is |
2016 | true. |
2017 | |
2018 | IV SvIVX(SV* sv) |
2019 | |
497711e7 |
2020 | =for hackers |
2021 | Found in file sv.h |
2022 | |
954c1994 |
2023 | =item SvLEN |
2024 | |
91e74348 |
2025 | Returns the size of the string buffer in the SV, not including any part |
2026 | attributable to C<SvOOK>. See C<SvCUR>. |
954c1994 |
2027 | |
2028 | STRLEN SvLEN(SV* sv) |
2029 | |
497711e7 |
2030 | =for hackers |
2031 | Found in file sv.h |
2032 | |
954c1994 |
2033 | =item SvNIOK |
2034 | |
2035 | Returns a boolean indicating whether the SV contains a number, integer or |
2036 | double. |
2037 | |
2038 | bool SvNIOK(SV* sv) |
2039 | |
497711e7 |
2040 | =for hackers |
2041 | Found in file sv.h |
2042 | |
954c1994 |
2043 | =item SvNIOKp |
2044 | |
2045 | Returns a boolean indicating whether the SV contains a number, integer or |
2046 | double. Checks the B<private> setting. Use C<SvNIOK>. |
2047 | |
2048 | bool SvNIOKp(SV* sv) |
2049 | |
497711e7 |
2050 | =for hackers |
2051 | Found in file sv.h |
2052 | |
954c1994 |
2053 | =item SvNIOK_off |
2054 | |
2055 | Unsets the NV/IV status of an SV. |
2056 | |
2057 | void SvNIOK_off(SV* sv) |
2058 | |
497711e7 |
2059 | =for hackers |
2060 | Found in file sv.h |
2061 | |
954c1994 |
2062 | =item SvNOK |
2063 | |
2064 | Returns a boolean indicating whether the SV contains a double. |
2065 | |
2066 | bool SvNOK(SV* sv) |
2067 | |
497711e7 |
2068 | =for hackers |
2069 | Found in file sv.h |
2070 | |
954c1994 |
2071 | =item SvNOKp |
2072 | |
2073 | Returns a boolean indicating whether the SV contains a double. Checks the |
2074 | B<private> setting. Use C<SvNOK>. |
2075 | |
2076 | bool SvNOKp(SV* sv) |
2077 | |
497711e7 |
2078 | =for hackers |
2079 | Found in file sv.h |
2080 | |
954c1994 |
2081 | =item SvNOK_off |
2082 | |
2083 | Unsets the NV status of an SV. |
2084 | |
2085 | void SvNOK_off(SV* sv) |
2086 | |
497711e7 |
2087 | =for hackers |
2088 | Found in file sv.h |
2089 | |
954c1994 |
2090 | =item SvNOK_on |
2091 | |
2092 | Tells an SV that it is a double. |
2093 | |
2094 | void SvNOK_on(SV* sv) |
2095 | |
497711e7 |
2096 | =for hackers |
2097 | Found in file sv.h |
2098 | |
954c1994 |
2099 | =item SvNOK_only |
2100 | |
2101 | Tells an SV that it is a double and disables all other OK bits. |
2102 | |
2103 | void SvNOK_only(SV* sv) |
2104 | |
497711e7 |
2105 | =for hackers |
2106 | Found in file sv.h |
2107 | |
954c1994 |
2108 | =item SvNV |
2109 | |
2110 | Coerce the given SV to a double and return it. |
2111 | |
2112 | NV SvNV(SV* sv) |
2113 | |
497711e7 |
2114 | =for hackers |
2115 | Found in file sv.h |
2116 | |
954c1994 |
2117 | =item SvNVX |
2118 | |
2119 | Returns the double which is stored in the SV, assuming SvNOK is |
2120 | true. |
2121 | |
2122 | NV SvNVX(SV* sv) |
2123 | |
497711e7 |
2124 | =for hackers |
2125 | Found in file sv.h |
2126 | |
954c1994 |
2127 | =item SvOK |
2128 | |
2129 | Returns a boolean indicating whether the value is an SV. |
2130 | |
2131 | bool SvOK(SV* sv) |
2132 | |
497711e7 |
2133 | =for hackers |
2134 | Found in file sv.h |
2135 | |
954c1994 |
2136 | =item SvOOK |
2137 | |
2138 | Returns a boolean indicating whether the SvIVX is a valid offset value for |
2139 | the SvPVX. This hack is used internally to speed up removal of characters |
2140 | from the beginning of a SvPV. When SvOOK is true, then the start of the |
2141 | allocated string buffer is really (SvPVX - SvIVX). |
2142 | |
2143 | bool SvOOK(SV* sv) |
2144 | |
497711e7 |
2145 | =for hackers |
2146 | Found in file sv.h |
2147 | |
954c1994 |
2148 | =item SvPOK |
2149 | |
2150 | Returns a boolean indicating whether the SV contains a character |
2151 | string. |
2152 | |
2153 | bool SvPOK(SV* sv) |
2154 | |
497711e7 |
2155 | =for hackers |
2156 | Found in file sv.h |
2157 | |
954c1994 |
2158 | =item SvPOKp |
2159 | |
2160 | Returns a boolean indicating whether the SV contains a character string. |
2161 | Checks the B<private> setting. Use C<SvPOK>. |
2162 | |
2163 | bool SvPOKp(SV* sv) |
2164 | |
497711e7 |
2165 | =for hackers |
2166 | Found in file sv.h |
2167 | |
954c1994 |
2168 | =item SvPOK_off |
2169 | |
2170 | Unsets the PV status of an SV. |
2171 | |
2172 | void SvPOK_off(SV* sv) |
2173 | |
497711e7 |
2174 | =for hackers |
2175 | Found in file sv.h |
2176 | |
954c1994 |
2177 | =item SvPOK_on |
2178 | |
2179 | Tells an SV that it is a string. |
2180 | |
2181 | void SvPOK_on(SV* sv) |
2182 | |
497711e7 |
2183 | =for hackers |
2184 | Found in file sv.h |
2185 | |
954c1994 |
2186 | =item SvPOK_only |
2187 | |
2188 | Tells an SV that it is a string and disables all other OK bits. |
2189 | |
2190 | void SvPOK_only(SV* sv) |
2191 | |
497711e7 |
2192 | =for hackers |
2193 | Found in file sv.h |
2194 | |
914184e1 |
2195 | =item SvPOK_only_UTF8 |
2196 | |
2197 | Tells an SV that it is a UTF8 string (do not use frivolously) |
2198 | and disables all other OK bits. |
2199 | |
2200 | void SvPOK_only_UTF8(SV* sv) |
2201 | |
2202 | =for hackers |
2203 | Found in file sv.h |
2204 | |
954c1994 |
2205 | =item SvPV |
2206 | |
2207 | Returns a pointer to the string in the SV, or a stringified form of the SV |
2208 | if the SV does not contain a string. Handles 'get' magic. |
2209 | |
2210 | char* SvPV(SV* sv, STRLEN len) |
2211 | |
497711e7 |
2212 | =for hackers |
2213 | Found in file sv.h |
2214 | |
954c1994 |
2215 | =item SvPVX |
2216 | |
2217 | Returns a pointer to the string in the SV. The SV must contain a |
2218 | string. |
2219 | |
2220 | char* SvPVX(SV* sv) |
2221 | |
497711e7 |
2222 | =for hackers |
2223 | Found in file sv.h |
2224 | |
954c1994 |
2225 | =item SvPV_force |
2226 | |
2227 | Like <SvPV> but will force the SV into becoming a string (SvPOK). You want |
2228 | force if you are going to update the SvPVX directly. |
2229 | |
2230 | char* SvPV_force(SV* sv, STRLEN len) |
2231 | |
497711e7 |
2232 | =for hackers |
2233 | Found in file sv.h |
2234 | |
954c1994 |
2235 | =item SvPV_nolen |
2236 | |
2237 | Returns a pointer to the string in the SV, or a stringified form of the SV |
2238 | if the SV does not contain a string. Handles 'get' magic. |
2239 | |
2240 | char* SvPV_nolen(SV* sv) |
2241 | |
497711e7 |
2242 | =for hackers |
2243 | Found in file sv.h |
2244 | |
954c1994 |
2245 | =item SvREFCNT |
2246 | |
2247 | Returns the value of the object's reference count. |
2248 | |
2249 | U32 SvREFCNT(SV* sv) |
2250 | |
497711e7 |
2251 | =for hackers |
2252 | Found in file sv.h |
2253 | |
954c1994 |
2254 | =item SvREFCNT_dec |
2255 | |
2256 | Decrements the reference count of the given SV. |
2257 | |
2258 | void SvREFCNT_dec(SV* sv) |
2259 | |
497711e7 |
2260 | =for hackers |
2261 | Found in file sv.h |
2262 | |
954c1994 |
2263 | =item SvREFCNT_inc |
2264 | |
2265 | Increments the reference count of the given SV. |
2266 | |
2267 | SV* SvREFCNT_inc(SV* sv) |
2268 | |
497711e7 |
2269 | =for hackers |
2270 | Found in file sv.h |
2271 | |
954c1994 |
2272 | =item SvROK |
2273 | |
2274 | Tests if the SV is an RV. |
2275 | |
2276 | bool SvROK(SV* sv) |
2277 | |
497711e7 |
2278 | =for hackers |
2279 | Found in file sv.h |
2280 | |
954c1994 |
2281 | =item SvROK_off |
2282 | |
2283 | Unsets the RV status of an SV. |
2284 | |
2285 | void SvROK_off(SV* sv) |
2286 | |
497711e7 |
2287 | =for hackers |
2288 | Found in file sv.h |
2289 | |
954c1994 |
2290 | =item SvROK_on |
2291 | |
2292 | Tells an SV that it is an RV. |
2293 | |
2294 | void SvROK_on(SV* sv) |
2295 | |
497711e7 |
2296 | =for hackers |
2297 | Found in file sv.h |
2298 | |
954c1994 |
2299 | =item SvRV |
2300 | |
2301 | Dereferences an RV to return the SV. |
2302 | |
2303 | SV* SvRV(SV* sv) |
2304 | |
497711e7 |
2305 | =for hackers |
2306 | Found in file sv.h |
2307 | |
954c1994 |
2308 | =item SvSETMAGIC |
2309 | |
2310 | Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its |
2311 | argument more than once. |
2312 | |
2313 | void SvSETMAGIC(SV* sv) |
2314 | |
497711e7 |
2315 | =for hackers |
2316 | Found in file sv.h |
2317 | |
954c1994 |
2318 | =item SvSetSV |
2319 | |
2320 | Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments |
2321 | more than once. |
2322 | |
2323 | void SvSetSV(SV* dsb, SV* ssv) |
2324 | |
497711e7 |
2325 | =for hackers |
2326 | Found in file sv.h |
2327 | |
954c1994 |
2328 | =item SvSetSV_nosteal |
2329 | |
2330 | Calls a non-destructive version of C<sv_setsv> if dsv is not the same as |
2331 | ssv. May evaluate arguments more than once. |
2332 | |
2333 | void SvSetSV_nosteal(SV* dsv, SV* ssv) |
2334 | |
497711e7 |
2335 | =for hackers |
2336 | Found in file sv.h |
2337 | |
954c1994 |
2338 | =item SvSTASH |
2339 | |
2340 | Returns the stash of the SV. |
2341 | |
2342 | HV* SvSTASH(SV* sv) |
2343 | |
497711e7 |
2344 | =for hackers |
2345 | Found in file sv.h |
2346 | |
954c1994 |
2347 | =item SvTAINT |
2348 | |
2349 | Taints an SV if tainting is enabled |
2350 | |
2351 | void SvTAINT(SV* sv) |
2352 | |
497711e7 |
2353 | =for hackers |
2354 | Found in file sv.h |
2355 | |
954c1994 |
2356 | =item SvTAINTED |
2357 | |
2358 | Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if |
2359 | not. |
2360 | |
2361 | bool SvTAINTED(SV* sv) |
2362 | |
497711e7 |
2363 | =for hackers |
2364 | Found in file sv.h |
2365 | |
954c1994 |
2366 | =item SvTAINTED_off |
2367 | |
2368 | Untaints an SV. Be I<very> careful with this routine, as it short-circuits |
2369 | some of Perl's fundamental security features. XS module authors should not |
2370 | use this function unless they fully understand all the implications of |
2371 | unconditionally untainting the value. Untainting should be done in the |
2372 | standard perl fashion, via a carefully crafted regexp, rather than directly |
2373 | untainting variables. |
2374 | |
2375 | void SvTAINTED_off(SV* sv) |
2376 | |
497711e7 |
2377 | =for hackers |
2378 | Found in file sv.h |
2379 | |
954c1994 |
2380 | =item SvTAINTED_on |
2381 | |
2382 | Marks an SV as tainted. |
2383 | |
2384 | void SvTAINTED_on(SV* sv) |
2385 | |
497711e7 |
2386 | =for hackers |
2387 | Found in file sv.h |
2388 | |
954c1994 |
2389 | =item SvTRUE |
2390 | |
2391 | Returns a boolean indicating whether Perl would evaluate the SV as true or |
2392 | false, defined or undefined. Does not handle 'get' magic. |
2393 | |
2394 | bool SvTRUE(SV* sv) |
2395 | |
497711e7 |
2396 | =for hackers |
2397 | Found in file sv.h |
2398 | |
c155e47c |
2399 | =item SvTYPE |
be2c7115 |
2400 | |
c155e47c |
2401 | Returns the type of the SV. See C<svtype>. |
2402 | |
2403 | svtype SvTYPE(SV* sv) |
34f7a5fe |
2404 | |
497711e7 |
2405 | =for hackers |
2406 | Found in file sv.h |
2407 | |
c155e47c |
2408 | =item svtype |
840a7b70 |
2409 | |
c155e47c |
2410 | An enum of flags for Perl types. These are found in the file B<sv.h> |
2411 | in the C<svtype> enum. Test these flags with the C<SvTYPE> macro. |
954c1994 |
2412 | |
497711e7 |
2413 | =for hackers |
2414 | Found in file sv.h |
2415 | |
954c1994 |
2416 | =item SVt_IV |
2417 | |
2418 | Integer type flag for scalars. See C<svtype>. |
2419 | |
497711e7 |
2420 | =for hackers |
2421 | Found in file sv.h |
2422 | |
954c1994 |
2423 | =item SVt_NV |
2424 | |
2425 | Double type flag for scalars. See C<svtype>. |
2426 | |
497711e7 |
2427 | =for hackers |
2428 | Found in file sv.h |
2429 | |
954c1994 |
2430 | =item SVt_PV |
2431 | |
2432 | Pointer type flag for scalars. See C<svtype>. |
2433 | |
497711e7 |
2434 | =for hackers |
2435 | Found in file sv.h |
2436 | |
954c1994 |
2437 | =item SVt_PVAV |
2438 | |
2439 | Type flag for arrays. See C<svtype>. |
2440 | |
497711e7 |
2441 | =for hackers |
2442 | Found in file sv.h |
2443 | |
954c1994 |
2444 | =item SVt_PVCV |
2445 | |
2446 | Type flag for code refs. See C<svtype>. |
2447 | |
497711e7 |
2448 | =for hackers |
2449 | Found in file sv.h |
2450 | |
954c1994 |
2451 | =item SVt_PVHV |
2452 | |
2453 | Type flag for hashes. See C<svtype>. |
2454 | |
497711e7 |
2455 | =for hackers |
2456 | Found in file sv.h |
2457 | |
954c1994 |
2458 | =item SVt_PVMG |
2459 | |
2460 | Type flag for blessed scalars. See C<svtype>. |
2461 | |
497711e7 |
2462 | =for hackers |
2463 | Found in file sv.h |
2464 | |
a8586c98 |
2465 | =item SvUOK |
2466 | |
2467 | Returns a boolean indicating whether the SV contains an unsigned integer. |
2468 | |
2469 | void SvUOK(SV* sv) |
2470 | |
2471 | =for hackers |
2472 | Found in file sv.h |
2473 | |
954c1994 |
2474 | =item SvUPGRADE |
2475 | |
2476 | Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to |
2477 | perform the upgrade if necessary. See C<svtype>. |
2478 | |
2479 | void SvUPGRADE(SV* sv, svtype type) |
2480 | |
497711e7 |
2481 | =for hackers |
2482 | Found in file sv.h |
2483 | |
914184e1 |
2484 | =item SvUTF8 |
2485 | |
2486 | Returns a boolean indicating whether the SV contains UTF-8 encoded data. |
2487 | |
2488 | void SvUTF8(SV* sv) |
2489 | |
2490 | =for hackers |
2491 | Found in file sv.h |
2492 | |
2493 | =item SvUTF8_off |
2494 | |
2495 | Unsets the UTF8 status of an SV. |
2496 | |
2497 | void SvUTF8_off(SV *sv) |
2498 | |
2499 | =for hackers |
2500 | Found in file sv.h |
2501 | |
2502 | =item SvUTF8_on |
2503 | |
2504 | Tells an SV that it is a string and encoded in UTF8. Do not use frivolously. |
2505 | |
2506 | void SvUTF8_on(SV *sv) |
2507 | |
2508 | =for hackers |
2509 | Found in file sv.h |
2510 | |
954c1994 |
2511 | =item SvUV |
2512 | |
2513 | Coerces the given SV to an unsigned integer and returns it. |
2514 | |
2515 | UV SvUV(SV* sv) |
2516 | |
497711e7 |
2517 | =for hackers |
2518 | Found in file sv.h |
2519 | |
954c1994 |
2520 | =item SvUVX |
2521 | |
2522 | Returns the unsigned integer which is stored in the SV, assuming SvIOK is |
2523 | true. |
2524 | |
2525 | UV SvUVX(SV* sv) |
2526 | |
497711e7 |
2527 | =for hackers |
2528 | Found in file sv.h |
2529 | |
954c1994 |
2530 | =item sv_2mortal |
2531 | |
2532 | Marks an SV as mortal. The SV will be destroyed when the current context |
2533 | ends. |
2534 | |
2535 | SV* sv_2mortal(SV* sv) |
2536 | |
497711e7 |
2537 | =for hackers |
2538 | Found in file sv.c |
2539 | |
954c1994 |
2540 | =item sv_bless |
2541 | |
2542 | Blesses an SV into a specified package. The SV must be an RV. The package |
2543 | must be designated by its stash (see C<gv_stashpv()>). The reference count |
2544 | of the SV is unaffected. |
2545 | |
2546 | SV* sv_bless(SV* sv, HV* stash) |
2547 | |
497711e7 |
2548 | =for hackers |
2549 | Found in file sv.c |
2550 | |
954c1994 |
2551 | =item sv_catpv |
2552 | |
2553 | Concatenates the string onto the end of the string which is in the SV. |
2554 | Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>. |
2555 | |
2556 | void sv_catpv(SV* sv, const char* ptr) |
2557 | |
497711e7 |
2558 | =for hackers |
2559 | Found in file sv.c |
2560 | |
954c1994 |
2561 | =item sv_catpvf |
2562 | |
2563 | Processes its arguments like C<sprintf> and appends the formatted output |
2564 | to an SV. Handles 'get' magic, but not 'set' magic. C<SvSETMAGIC()> must |
2565 | typically be called after calling this function to handle 'set' magic. |
2566 | |
2567 | void sv_catpvf(SV* sv, const char* pat, ...) |
2568 | |
497711e7 |
2569 | =for hackers |
2570 | Found in file sv.c |
2571 | |
954c1994 |
2572 | =item sv_catpvf_mg |
2573 | |
2574 | Like C<sv_catpvf>, but also handles 'set' magic. |
2575 | |
2576 | void sv_catpvf_mg(SV *sv, const char* pat, ...) |
2577 | |
497711e7 |
2578 | =for hackers |
2579 | Found in file sv.c |
2580 | |
954c1994 |
2581 | =item sv_catpvn |
2582 | |
2583 | Concatenates the string onto the end of the string which is in the SV. The |
2584 | C<len> indicates number of bytes to copy. Handles 'get' magic, but not |
2585 | 'set' magic. See C<sv_catpvn_mg>. |
2586 | |
2587 | void sv_catpvn(SV* sv, const char* ptr, STRLEN len) |
2588 | |
497711e7 |
2589 | =for hackers |
2590 | Found in file sv.c |
2591 | |
954c1994 |
2592 | =item sv_catpvn_mg |
2593 | |
2594 | Like C<sv_catpvn>, but also handles 'set' magic. |
2595 | |
2596 | void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len) |
2597 | |
497711e7 |
2598 | =for hackers |
2599 | Found in file sv.c |
2600 | |
954c1994 |
2601 | =item sv_catpv_mg |
2602 | |
2603 | Like C<sv_catpv>, but also handles 'set' magic. |
2604 | |
2605 | void sv_catpv_mg(SV *sv, const char *ptr) |
2606 | |
497711e7 |
2607 | =for hackers |
2608 | Found in file sv.c |
2609 | |
954c1994 |
2610 | =item sv_catsv |
2611 | |
1aa99e6b |
2612 | Concatenates the string from SV C<ssv> onto the end of the string in |
2613 | SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but |
2614 | not 'set' magic. See C<sv_catsv_mg>. |
954c1994 |
2615 | |
2616 | void sv_catsv(SV* dsv, SV* ssv) |
2617 | |
497711e7 |
2618 | =for hackers |
2619 | Found in file sv.c |
2620 | |
954c1994 |
2621 | =item sv_catsv_mg |
2622 | |
2623 | Like C<sv_catsv>, but also handles 'set' magic. |
2624 | |
2625 | void sv_catsv_mg(SV *dstr, SV *sstr) |
2626 | |
497711e7 |
2627 | =for hackers |
2628 | Found in file sv.c |
2629 | |
954c1994 |
2630 | =item sv_chop |
2631 | |
1c846c1f |
2632 | Efficient removal of characters from the beginning of the string buffer. |
954c1994 |
2633 | SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside |
2634 | the string buffer. The C<ptr> becomes the first character of the adjusted |
2635 | string. |
2636 | |
2637 | void sv_chop(SV* sv, char* ptr) |
2638 | |
497711e7 |
2639 | =for hackers |
2640 | Found in file sv.c |
2641 | |
c461cf8f |
2642 | =item sv_clear |
2643 | |
2644 | Clear an SV, making it empty. Does not free the memory used by the SV |
2645 | itself. |
2646 | |
2647 | void sv_clear(SV* sv) |
2648 | |
2649 | =for hackers |
2650 | Found in file sv.c |
2651 | |
954c1994 |
2652 | =item sv_cmp |
2653 | |
2654 | Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the |
2655 | string in C<sv1> is less than, equal to, or greater than the string in |
2656 | C<sv2>. |
2657 | |
2658 | I32 sv_cmp(SV* sv1, SV* sv2) |
2659 | |
497711e7 |
2660 | =for hackers |
2661 | Found in file sv.c |
2662 | |
c461cf8f |
2663 | =item sv_cmp_locale |
2664 | |
2665 | Compares the strings in two SVs in a locale-aware manner. See |
2666 | L</sv_cmp_locale> |
2667 | |
2668 | I32 sv_cmp_locale(SV* sv1, SV* sv2) |
2669 | |
2670 | =for hackers |
2671 | Found in file sv.c |
2672 | |
954c1994 |
2673 | =item sv_dec |
2674 | |
2675 | Auto-decrement of the value in the SV. |
2676 | |
2677 | void sv_dec(SV* sv) |
2678 | |
497711e7 |
2679 | =for hackers |
2680 | Found in file sv.c |
2681 | |
954c1994 |
2682 | =item sv_derived_from |
2683 | |
2684 | Returns a boolean indicating whether the SV is derived from the specified |
2685 | class. This is the function that implements C<UNIVERSAL::isa>. It works |
2686 | for class names as well as for objects. |
2687 | |
2688 | bool sv_derived_from(SV* sv, const char* name) |
2689 | |
497711e7 |
2690 | =for hackers |
2691 | Found in file universal.c |
2692 | |
954c1994 |
2693 | =item sv_eq |
2694 | |
2695 | Returns a boolean indicating whether the strings in the two SVs are |
2696 | identical. |
2697 | |
2698 | I32 sv_eq(SV* sv1, SV* sv2) |
2699 | |
497711e7 |
2700 | =for hackers |
2701 | Found in file sv.c |
2702 | |
c461cf8f |
2703 | =item sv_free |
2704 | |
2705 | Free the memory used by an SV. |
2706 | |
2707 | void sv_free(SV* sv) |
2708 | |
2709 | =for hackers |
2710 | Found in file sv.c |
2711 | |
2712 | =item sv_gets |
2713 | |
2714 | Get a line from the filehandle and store it into the SV, optionally |
2715 | appending to the currently-stored string. |
2716 | |
2717 | char* sv_gets(SV* sv, PerlIO* fp, I32 append) |
2718 | |
2719 | =for hackers |
2720 | Found in file sv.c |
2721 | |
954c1994 |
2722 | =item sv_grow |
2723 | |
2724 | Expands the character buffer in the SV. This will use C<sv_unref> and will |
2725 | upgrade the SV to C<SVt_PV>. Returns a pointer to the character buffer. |
2726 | Use C<SvGROW>. |
2727 | |
2728 | char* sv_grow(SV* sv, STRLEN newlen) |
2729 | |
497711e7 |
2730 | =for hackers |
2731 | Found in file sv.c |
2732 | |
954c1994 |
2733 | =item sv_inc |
2734 | |
2735 | Auto-increment of the value in the SV. |
2736 | |
2737 | void sv_inc(SV* sv) |
2738 | |
497711e7 |
2739 | =for hackers |
2740 | Found in file sv.c |
2741 | |
954c1994 |
2742 | =item sv_insert |
2743 | |
2744 | Inserts a string at the specified offset/length within the SV. Similar to |
2745 | the Perl substr() function. |
2746 | |
2747 | void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen) |
2748 | |
497711e7 |
2749 | =for hackers |
2750 | Found in file sv.c |
2751 | |
954c1994 |
2752 | =item sv_isa |
2753 | |
2754 | Returns a boolean indicating whether the SV is blessed into the specified |
2755 | class. This does not check for subtypes; use C<sv_derived_from> to verify |
2756 | an inheritance relationship. |
2757 | |
2758 | int sv_isa(SV* sv, const char* name) |
2759 | |
497711e7 |
2760 | =for hackers |
2761 | Found in file sv.c |
2762 | |
954c1994 |
2763 | =item sv_isobject |
2764 | |
2765 | Returns a boolean indicating whether the SV is an RV pointing to a blessed |
2766 | object. If the SV is not an RV, or if the object is not blessed, then this |
2767 | will return false. |
2768 | |
2769 | int sv_isobject(SV* sv) |
2770 | |
497711e7 |
2771 | =for hackers |
2772 | Found in file sv.c |
2773 | |
954c1994 |
2774 | =item sv_len |
2775 | |
2776 | Returns the length of the string in the SV. See also C<SvCUR>. |
2777 | |
2778 | STRLEN sv_len(SV* sv) |
2779 | |
497711e7 |
2780 | =for hackers |
2781 | Found in file sv.c |
2782 | |
c461cf8f |
2783 | =item sv_len_utf8 |
2784 | |
2785 | Returns the number of characters in the string in an SV, counting wide |
2786 | UTF8 bytes as a single character. |
2787 | |
2788 | STRLEN sv_len_utf8(SV* sv) |
2789 | |
2790 | =for hackers |
2791 | Found in file sv.c |
2792 | |
954c1994 |
2793 | =item sv_magic |
2794 | |
2795 | Adds magic to an SV. |
2796 | |
2797 | void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen) |
2798 | |
497711e7 |
2799 | =for hackers |
2800 | Found in file sv.c |
2801 | |
954c1994 |
2802 | =item sv_mortalcopy |
2803 | |
2804 | Creates a new SV which is a copy of the original SV. The new SV is marked |
2805 | as mortal. |
2806 | |
2807 | SV* sv_mortalcopy(SV* oldsv) |
2808 | |
497711e7 |
2809 | =for hackers |
2810 | Found in file sv.c |
2811 | |
954c1994 |
2812 | =item sv_newmortal |
2813 | |
2814 | Creates a new SV which is mortal. The reference count of the SV is set to 1. |
2815 | |
2816 | SV* sv_newmortal() |
2817 | |
497711e7 |
2818 | =for hackers |
2819 | Found in file sv.c |
2820 | |
c461cf8f |
2821 | =item sv_pvn_force |
2822 | |
2823 | Get a sensible string out of the SV somehow. |
2824 | |
2825 | char* sv_pvn_force(SV* sv, STRLEN* lp) |
2826 | |
2827 | =for hackers |
2828 | Found in file sv.c |
2829 | |
2830 | =item sv_pvutf8n_force |
2831 | |
2832 | Get a sensible UTF8-encoded string out of the SV somehow. See |
2833 | L</sv_pvn_force>. |
2834 | |
2835 | char* sv_pvutf8n_force(SV* sv, STRLEN* lp) |
2836 | |
2837 | =for hackers |
2838 | Found in file sv.c |
2839 | |
2840 | =item sv_reftype |
2841 | |
2842 | Returns a string describing what the SV is a reference to. |
2843 | |
2844 | char* sv_reftype(SV* sv, int ob) |
2845 | |
2846 | =for hackers |
2847 | Found in file sv.c |
2848 | |
2849 | =item sv_replace |
2850 | |
2851 | Make the first argument a copy of the second, then delete the original. |
2852 | |
2853 | void sv_replace(SV* sv, SV* nsv) |
2854 | |
2855 | =for hackers |
2856 | Found in file sv.c |
2857 | |
2858 | =item sv_rvweaken |
2859 | |
2860 | Weaken a reference. |
2861 | |
2862 | SV* sv_rvweaken(SV *sv) |
2863 | |
2864 | =for hackers |
2865 | Found in file sv.c |
2866 | |
954c1994 |
2867 | =item sv_setiv |
2868 | |
2869 | Copies an integer into the given SV. Does not handle 'set' magic. See |
2870 | C<sv_setiv_mg>. |
2871 | |
2872 | void sv_setiv(SV* sv, IV num) |
2873 | |
497711e7 |
2874 | =for hackers |
2875 | Found in file sv.c |
2876 | |
954c1994 |
2877 | =item sv_setiv_mg |
2878 | |
2879 | Like C<sv_setiv>, but also handles 'set' magic. |
2880 | |
2881 | void sv_setiv_mg(SV *sv, IV i) |
2882 | |
497711e7 |
2883 | =for hackers |
2884 | Found in file sv.c |
2885 | |
954c1994 |
2886 | =item sv_setnv |
2887 | |
2888 | Copies a double into the given SV. Does not handle 'set' magic. See |
2889 | C<sv_setnv_mg>. |
2890 | |
2891 | void sv_setnv(SV* sv, NV num) |
2892 | |
497711e7 |
2893 | =for hackers |
2894 | Found in file sv.c |
2895 | |
954c1994 |
2896 | =item sv_setnv_mg |
2897 | |
2898 | Like C<sv_setnv>, but also handles 'set' magic. |
2899 | |
2900 | void sv_setnv_mg(SV *sv, NV num) |
2901 | |
497711e7 |
2902 | =for hackers |
2903 | Found in file sv.c |
2904 | |
954c1994 |
2905 | =item sv_setpv |
2906 | |
2907 | Copies a string into an SV. The string must be null-terminated. Does not |
2908 | handle 'set' magic. See C<sv_setpv_mg>. |
2909 | |
2910 | void sv_setpv(SV* sv, const char* ptr) |
2911 | |
497711e7 |
2912 | =for hackers |
2913 | Found in file sv.c |
2914 | |
954c1994 |
2915 | =item sv_setpvf |
2916 | |
2917 | Processes its arguments like C<sprintf> and sets an SV to the formatted |
2918 | output. Does not handle 'set' magic. See C<sv_setpvf_mg>. |
2919 | |
2920 | void sv_setpvf(SV* sv, const char* pat, ...) |
2921 | |
497711e7 |
2922 | =for hackers |
2923 | Found in file sv.c |
2924 | |
954c1994 |
2925 | =item sv_setpvf_mg |
2926 | |
2927 | Like C<sv_setpvf>, but also handles 'set' magic. |
2928 | |
2929 | void sv_setpvf_mg(SV *sv, const char* pat, ...) |
2930 | |
497711e7 |
2931 | =for hackers |
2932 | Found in file sv.c |
2933 | |
954c1994 |
2934 | =item sv_setpviv |
2935 | |
2936 | Copies an integer into the given SV, also updating its string value. |
2937 | Does not handle 'set' magic. See C<sv_setpviv_mg>. |
2938 | |
2939 | void sv_setpviv(SV* sv, IV num) |
2940 | |
497711e7 |
2941 | =for hackers |
2942 | Found in file sv.c |
2943 | |
954c1994 |
2944 | =item sv_setpviv_mg |
2945 | |
2946 | Like C<sv_setpviv>, but also handles 'set' magic. |
2947 | |
2948 | void sv_setpviv_mg(SV *sv, IV iv) |
2949 | |
497711e7 |
2950 | =for hackers |
2951 | Found in file sv.c |
2952 | |
954c1994 |
2953 | =item sv_setpvn |
2954 | |
2955 | Copies a string into an SV. The C<len> parameter indicates the number of |
2956 | bytes to be copied. Does not handle 'set' magic. See C<sv_setpvn_mg>. |
2957 | |
2958 | void sv_setpvn(SV* sv, const char* ptr, STRLEN len) |
2959 | |
497711e7 |
2960 | =for hackers |
2961 | Found in file sv.c |
2962 | |
954c1994 |
2963 | =item sv_setpvn_mg |
2964 | |
2965 | Like C<sv_setpvn>, but also handles 'set' magic. |
2966 | |
2967 | void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len) |
2968 | |
497711e7 |
2969 | =for hackers |
2970 | Found in file sv.c |
2971 | |
954c1994 |
2972 | =item sv_setpv_mg |
2973 | |
2974 | Like C<sv_setpv>, but also handles 'set' magic. |
2975 | |
2976 | void sv_setpv_mg(SV *sv, const char *ptr) |
2977 | |
497711e7 |
2978 | =for hackers |
2979 | Found in file sv.c |
2980 | |
954c1994 |
2981 | =item sv_setref_iv |
2982 | |
2983 | Copies an integer into a new SV, optionally blessing the SV. The C<rv> |
2984 | argument will be upgraded to an RV. That RV will be modified to point to |
2985 | the new SV. The C<classname> argument indicates the package for the |
2986 | blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV |
2987 | will be returned and will have a reference count of 1. |
2988 | |
2989 | SV* sv_setref_iv(SV* rv, const char* classname, IV iv) |
2990 | |
497711e7 |
2991 | =for hackers |
2992 | Found in file sv.c |
2993 | |
954c1994 |
2994 | =item sv_setref_nv |
2995 | |
2996 | Copies a double into a new SV, optionally blessing the SV. The C<rv> |
2997 | argument will be upgraded to an RV. That RV will be modified to point to |
2998 | the new SV. The C<classname> argument indicates the package for the |
2999 | blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV |
3000 | will be returned and will have a reference count of 1. |
3001 | |
3002 | SV* sv_setref_nv(SV* rv, const char* classname, NV nv) |
3003 | |
497711e7 |
3004 | =for hackers |
3005 | Found in file sv.c |
3006 | |
954c1994 |
3007 | =item sv_setref_pv |
3008 | |
3009 | Copies a pointer into a new SV, optionally blessing the SV. The C<rv> |
3010 | argument will be upgraded to an RV. That RV will be modified to point to |
3011 | the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed |
3012 | into the SV. The C<classname> argument indicates the package for the |
3013 | blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV |
3014 | will be returned and will have a reference count of 1. |
3015 | |
3016 | Do not use with other Perl types such as HV, AV, SV, CV, because those |
3017 | objects will become corrupted by the pointer copy process. |
3018 | |
3019 | Note that C<sv_setref_pvn> copies the string while this copies the pointer. |
3020 | |
3021 | SV* sv_setref_pv(SV* rv, const char* classname, void* pv) |
3022 | |
497711e7 |
3023 | =for hackers |
3024 | Found in file sv.c |
3025 | |
954c1994 |
3026 | =item sv_setref_pvn |
3027 | |
3028 | Copies a string into a new SV, optionally blessing the SV. The length of the |
3029 | string must be specified with C<n>. The C<rv> argument will be upgraded to |
3030 | an RV. That RV will be modified to point to the new SV. The C<classname> |
3031 | argument indicates the package for the blessing. Set C<classname> to |
3032 | C<Nullch> to avoid the blessing. The new SV will be returned and will have |
3033 | a reference count of 1. |
3034 | |
3035 | Note that C<sv_setref_pv> copies the pointer while this copies the string. |
3036 | |
3037 | SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n) |
3038 | |
497711e7 |
3039 | =for hackers |
3040 | Found in file sv.c |
3041 | |
954c1994 |
3042 | =item sv_setsv |
3043 | |
3044 | Copies the contents of the source SV C<ssv> into the destination SV C<dsv>. |
3045 | The source SV may be destroyed if it is mortal. Does not handle 'set' |
3046 | magic. See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and |
3047 | C<sv_setsv_mg>. |
3048 | |
3049 | void sv_setsv(SV* dsv, SV* ssv) |
3050 | |
497711e7 |
3051 | =for hackers |
3052 | Found in file sv.c |
3053 | |
954c1994 |
3054 | =item sv_setsv_mg |
3055 | |
3056 | Like C<sv_setsv>, but also handles 'set' magic. |
3057 | |
3058 | void sv_setsv_mg(SV *dstr, SV *sstr) |
3059 | |
497711e7 |
3060 | =for hackers |
3061 | Found in file sv.c |
3062 | |
954c1994 |
3063 | =item sv_setuv |
3064 | |
3065 | Copies an unsigned integer into the given SV. Does not handle 'set' magic. |
3066 | See C<sv_setuv_mg>. |
3067 | |
3068 | void sv_setuv(SV* sv, UV num) |
3069 | |
497711e7 |
3070 | =for hackers |
3071 | Found in file sv.c |
3072 | |
954c1994 |
3073 | =item sv_setuv_mg |
3074 | |
3075 | Like C<sv_setuv>, but also handles 'set' magic. |
3076 | |
3077 | void sv_setuv_mg(SV *sv, UV u) |
3078 | |
497711e7 |
3079 | =for hackers |
3080 | Found in file sv.c |
3081 | |
c461cf8f |
3082 | =item sv_true |
3083 | |
3084 | Returns true if the SV has a true value by Perl's rules. |
3085 | |
3086 | I32 sv_true(SV *sv) |
3087 | |
3088 | =for hackers |
3089 | Found in file sv.c |
3090 | |
3091 | =item sv_unmagic |
3092 | |
3093 | Removes magic from an SV. |
3094 | |
3095 | int sv_unmagic(SV* sv, int type) |
3096 | |
3097 | =for hackers |
3098 | Found in file sv.c |
3099 | |
954c1994 |
3100 | =item sv_unref |
3101 | |
3102 | Unsets the RV status of the SV, and decrements the reference count of |
3103 | whatever was being referenced by the RV. This can almost be thought of |
b06226ff |
3104 | as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag> |
ae154d6d |
3105 | being zero. See C<SvROK_off>. |
954c1994 |
3106 | |
3107 | void sv_unref(SV* sv) |
3108 | |
497711e7 |
3109 | =for hackers |
3110 | Found in file sv.c |
3111 | |
840a7b70 |
3112 | =item sv_unref_flags |
3113 | |
3114 | Unsets the RV status of the SV, and decrements the reference count of |
3115 | whatever was being referenced by the RV. This can almost be thought of |
3116 | as a reversal of C<newSVrv>. The C<cflags> argument can contain |
3117 | C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented |
3118 | (otherwise the decrementing is conditional on the reference count being |
3119 | different from one or the reference being a readonly SV). |
ae154d6d |
3120 | See C<SvROK_off>. |
840a7b70 |
3121 | |
3122 | void sv_unref_flags(SV* sv, U32 flags) |
3123 | |
3124 | =for hackers |
3125 | Found in file sv.c |
3126 | |
954c1994 |
3127 | =item sv_upgrade |
3128 | |
3129 | Upgrade an SV to a more complex form. Use C<SvUPGRADE>. See |
3130 | C<svtype>. |
3131 | |
3132 | bool sv_upgrade(SV* sv, U32 mt) |
3133 | |
497711e7 |
3134 | =for hackers |
3135 | Found in file sv.c |
3136 | |
954c1994 |
3137 | =item sv_usepvn |
3138 | |
3139 | Tells an SV to use C<ptr> to find its string value. Normally the string is |
1c846c1f |
3140 | stored inside the SV but sv_usepvn allows the SV to use an outside string. |
954c1994 |
3141 | The C<ptr> should point to memory that was allocated by C<malloc>. The |
3142 | string length, C<len>, must be supplied. This function will realloc the |
3143 | memory pointed to by C<ptr>, so that pointer should not be freed or used by |
3144 | the programmer after giving it to sv_usepvn. Does not handle 'set' magic. |
3145 | See C<sv_usepvn_mg>. |
3146 | |
3147 | void sv_usepvn(SV* sv, char* ptr, STRLEN len) |
3148 | |
497711e7 |
3149 | =for hackers |
3150 | Found in file sv.c |
3151 | |
954c1994 |
3152 | =item sv_usepvn_mg |
3153 | |
3154 | Like C<sv_usepvn>, but also handles 'set' magic. |
3155 | |
3156 | void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len) |
3157 | |
497711e7 |
3158 | =for hackers |
3159 | Found in file sv.c |
3160 | |
c461cf8f |
3161 | =item sv_utf8_downgrade |
3162 | |
3163 | Attempt to convert the PV of an SV from UTF8-encoded to byte encoding. |
3164 | This may not be possible if the PV contains non-byte encoding characters; |
3165 | if this is the case, either returns false or, if C<fail_ok> is not |
3166 | true, croaks. |
3167 | |
3168 | NOTE: this function is experimental and may change or be |
3169 | removed without notice. |
3170 | |
3171 | bool sv_utf8_downgrade(SV *sv, bool fail_ok) |
3172 | |
3173 | =for hackers |
3174 | Found in file sv.c |
3175 | |
3176 | =item sv_utf8_encode |
3177 | |
3178 | Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8> |
1c846c1f |
3179 | flag so that it looks like bytes again. Nothing calls this. |
c461cf8f |
3180 | |
3181 | NOTE: this function is experimental and may change or be |
3182 | removed without notice. |
3183 | |
3184 | void sv_utf8_encode(SV *sv) |
3185 | |
3186 | =for hackers |
3187 | Found in file sv.c |
3188 | |
3189 | =item sv_utf8_upgrade |
3190 | |
3191 | Convert the PV of an SV to its UTF8-encoded form. |
3192 | |
3193 | void sv_utf8_upgrade(SV *sv) |
3194 | |
3195 | =for hackers |
3196 | Found in file sv.c |
3197 | |
954c1994 |
3198 | =item sv_vcatpvfn |
3199 | |
3200 | Processes its arguments like C<vsprintf> and appends the formatted output |
3201 | to an SV. Uses an array of SVs if the C style variable argument list is |
3202 | missing (NULL). When running with taint checks enabled, indicates via |
3203 | C<maybe_tainted> if results are untrustworthy (often due to the use of |
3204 | locales). |
3205 | |
3206 | void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted) |
3207 | |
497711e7 |
3208 | =for hackers |
3209 | Found in file sv.c |
3210 | |
954c1994 |
3211 | =item sv_vsetpvfn |
3212 | |
3213 | Works like C<vcatpvfn> but copies the text into the SV instead of |
3214 | appending it. |
3215 | |
3216 | void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted) |
3217 | |
497711e7 |
3218 | =for hackers |
3219 | Found in file sv.c |
3220 | |
954c1994 |
3221 | =item THIS |
3222 | |
3223 | Variable which is setup by C<xsubpp> to designate the object in a C++ |
3224 | XSUB. This is always the proper type for the C++ object. See C<CLASS> and |
3225 | L<perlxs/"Using XS With C++">. |
3226 | |
3227 | (whatever) THIS |
3228 | |
497711e7 |
3229 | =for hackers |
3230 | Found in file XSUB.h |
3231 | |
954c1994 |
3232 | =item toLOWER |
3233 | |
3234 | Converts the specified character to lowercase. |
3235 | |
3236 | char toLOWER(char ch) |
3237 | |
497711e7 |
3238 | =for hackers |
3239 | Found in file handy.h |
3240 | |
954c1994 |
3241 | =item toUPPER |
3242 | |
3243 | Converts the specified character to uppercase. |
3244 | |
3245 | char toUPPER(char ch) |
3246 | |
497711e7 |
3247 | =for hackers |
3248 | Found in file handy.h |
3249 | |
6662521e |
3250 | =item U8 *s |
3251 | |
b6b716fe |
3252 | Returns true if first C<len> bytes of the given string form valid a UTF8 |
3253 | string, false otherwise. |
67e989fb |
3254 | |
b6b716fe |
3255 | is_utf8_string U8 *s(STRLEN len) |
6662521e |
3256 | |
3257 | =for hackers |
3258 | Found in file utf8.c |
3259 | |
b06226ff |
3260 | =item utf8_distance |
3261 | |
3262 | Returns the number of UTF8 characters between the UTF-8 pointers C<a> |
3263 | and C<b>. |
3264 | |
3265 | WARNING: use only if you *know* that the pointers point inside the |
3266 | same UTF-8 buffer. |
3267 | |
3268 | IV utf8_distance(U8 *a, U8 *b) |
3269 | |
3270 | =for hackers |
3271 | Found in file utf8.c |
3272 | |
3273 | =item utf8_hop |
3274 | |
8850bf83 |
3275 | Return the UTF-8 pointer C<s> displaced by C<off> characters, either |
3276 | forward or backward. |
b06226ff |
3277 | |
3278 | WARNING: do not use the following unless you *know* C<off> is within |
8850bf83 |
3279 | the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned |
3280 | on the first byte of character or just after the last byte of a character. |
b06226ff |
3281 | |
3282 | U8* utf8_hop(U8 *s, I32 off) |
3283 | |
3284 | =for hackers |
3285 | Found in file utf8.c |
3286 | |
3287 | =item utf8_length |
3288 | |
3289 | Return the length of the UTF-8 char encoded string C<s> in characters. |
3290 | Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end |
3291 | up past C<e>, croaks. |
3292 | |
3293 | STRLEN utf8_length(U8* s, U8 *e) |
3294 | |
3295 | =for hackers |
3296 | Found in file utf8.c |
3297 | |
497711e7 |
3298 | =item utf8_to_bytes |
3299 | |
246fae53 |
3300 | Converts a string C<s> of length C<len> from UTF8 into byte encoding. |
3301 | Unlike C<bytes_to_utf8>, this over-writes the original string, and |
3302 | updates len to contain the new length. |
67e989fb |
3303 | Returns zero on failure, setting C<len> to -1. |
497711e7 |
3304 | |
246fae53 |
3305 | U8 * utf8_to_bytes(U8 *s, STRLEN *len) |
497711e7 |
3306 | |
3307 | =for hackers |
3308 | Found in file utf8.c |
3309 | |
b6b716fe |
3310 | =item utf8_to_uv |
3311 | |
3312 | Returns the character value of the first character in the string C<s> |
dcad2880 |
3313 | which is assumed to be in UTF8 encoding and no longer than C<curlen>; |
1aa99e6b |
3314 | C<retlen> will be set to the length, in bytes, of that character. |
b6b716fe |
3315 | |
dcad2880 |
3316 | If C<s> does not point to a well-formed UTF8 character, the behaviour |
e9e021e6 |
3317 | is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY, |
3318 | it is assumed that the caller will raise a warning, and this function |
28d3d195 |
3319 | will silently just set C<retlen> to C<-1> and return zero. If the |
3320 | C<flags> does not contain UTF8_CHECK_ONLY, warnings about |
3321 | malformations will be given, C<retlen> will be set to the expected |
3322 | length of the UTF-8 character in bytes, and zero will be returned. |
3323 | |
3324 | The C<flags> can also contain various flags to allow deviations from |
3325 | the strict UTF-8 encoding (see F<utf8.h>). |
444155da |
3326 | |
be2c7115 |
3327 | U8* s utf8_to_uv(STRLEN curlen, STRLEN *retlen, U32 flags) |
444155da |
3328 | |
3329 | =for hackers |
3330 | Found in file utf8.c |
3331 | |
dcad2880 |
3332 | =item utf8_to_uv_simple |
444155da |
3333 | |
3334 | Returns the character value of the first character in the string C<s> |
dcad2880 |
3335 | which is assumed to be in UTF8 encoding; C<retlen> will be set to the |
1aa99e6b |
3336 | length, in bytes, of that character. |
444155da |
3337 | |
dcad2880 |
3338 | If C<s> does not point to a well-formed UTF8 character, zero is |
3339 | returned and retlen is set, if possible, to -1. |
b6b716fe |
3340 | |
dcad2880 |
3341 | U8* s utf8_to_uv_simple(STRLEN *retlen) |
b6b716fe |
3342 | |
3343 | =for hackers |
3344 | Found in file utf8.c |
3345 | |
954c1994 |
3346 | =item warn |
3347 | |
3348 | This is the XSUB-writer's interface to Perl's C<warn> function. Use this |
3349 | function the same way you use the C C<printf> function. See |
3350 | C<croak>. |
3351 | |
3352 | void warn(const char* pat, ...) |
3353 | |
497711e7 |
3354 | =for hackers |
3355 | Found in file util.c |
3356 | |
954c1994 |
3357 | =item XPUSHi |
3358 | |
3359 | Push an integer onto the stack, extending the stack if necessary. Handles |
3360 | 'set' magic. See C<PUSHi>. |
3361 | |
3362 | void XPUSHi(IV iv) |
3363 | |
497711e7 |
3364 | =for hackers |
3365 | Found in file pp.h |
3366 | |
954c1994 |
3367 | =item XPUSHn |
3368 | |
3369 | Push a double onto the stack, extending the stack if necessary. Handles |
3370 | 'set' magic. See C<PUSHn>. |
3371 | |
3372 | void XPUSHn(NV nv) |
3373 | |
497711e7 |
3374 | =for hackers |
3375 | Found in file pp.h |
3376 | |
954c1994 |
3377 | =item XPUSHp |
3378 | |
3379 | Push a string onto the stack, extending the stack if necessary. The C<len> |
3380 | indicates the length of the string. Handles 'set' magic. See |
3381 | C<PUSHp>. |
3382 | |
3383 | void XPUSHp(char* str, STRLEN len) |
3384 | |
497711e7 |
3385 | =for hackers |
3386 | Found in file pp.h |
3387 | |
954c1994 |
3388 | =item XPUSHs |
3389 | |
3390 | Push an SV onto the stack, extending the stack if necessary. Does not |
3391 | handle 'set' magic. See C<PUSHs>. |
3392 | |
3393 | void XPUSHs(SV* sv) |
3394 | |
497711e7 |
3395 | =for hackers |
3396 | Found in file pp.h |
3397 | |
954c1994 |
3398 | =item XPUSHu |
3399 | |
1c846c1f |
3400 | Push an unsigned integer onto the stack, extending the stack if necessary. |
954c1994 |
3401 | See C<PUSHu>. |
3402 | |
3403 | void XPUSHu(UV uv) |
3404 | |
497711e7 |
3405 | =for hackers |
3406 | Found in file pp.h |
3407 | |
954c1994 |
3408 | =item XS |
3409 | |
3410 | Macro to declare an XSUB and its C parameter list. This is handled by |
3411 | C<xsubpp>. |
3412 | |
497711e7 |
3413 | =for hackers |
3414 | Found in file XSUB.h |
3415 | |
954c1994 |
3416 | =item XSRETURN |
3417 | |
3418 | Return from XSUB, indicating number of items on the stack. This is usually |
3419 | handled by C<xsubpp>. |
3420 | |
3421 | void XSRETURN(int nitems) |
3422 | |
497711e7 |
3423 | =for hackers |
3424 | Found in file XSUB.h |
3425 | |
954c1994 |
3426 | =item XSRETURN_EMPTY |
3427 | |
3428 | Return an empty list from an XSUB immediately. |
3429 | |
3430 | XSRETURN_EMPTY; |
3431 | |
497711e7 |
3432 | =for hackers |
3433 | Found in file XSUB.h |
3434 | |
954c1994 |
3435 | =item XSRETURN_IV |
3436 | |
3437 | Return an integer from an XSUB immediately. Uses C<XST_mIV>. |
3438 | |
3439 | void XSRETURN_IV(IV iv) |
3440 | |
497711e7 |
3441 | =for hackers |
3442 | Found in file XSUB.h |
3443 | |
954c1994 |
3444 | =item XSRETURN_NO |
3445 | |
3446 | Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>. |
3447 | |
3448 | XSRETURN_NO; |
3449 | |
497711e7 |
3450 | =for hackers |
3451 | Found in file XSUB.h |
3452 | |
954c1994 |
3453 | =item XSRETURN_NV |
3454 | |
3455 | Return an double from an XSUB immediately. Uses C<XST_mNV>. |
3456 | |
3457 | void XSRETURN_NV(NV nv) |
3458 | |
497711e7 |
3459 | =for hackers |
3460 | Found in file XSUB.h |
3461 | |
954c1994 |
3462 | =item XSRETURN_PV |
3463 | |
3464 | Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>. |
3465 | |
3466 | void XSRETURN_PV(char* str) |
3467 | |
497711e7 |
3468 | =for hackers |
3469 | Found in file XSUB.h |
3470 | |
954c1994 |
3471 | =item XSRETURN_UNDEF |
3472 | |
3473 | Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>. |
3474 | |
3475 | XSRETURN_UNDEF; |
3476 | |
497711e7 |
3477 | =for hackers |
3478 | Found in file XSUB.h |
3479 | |
954c1994 |
3480 | =item XSRETURN_YES |
3481 | |
3482 | Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>. |
3483 | |
3484 | XSRETURN_YES; |
3485 | |
497711e7 |
3486 | =for hackers |
3487 | Found in file XSUB.h |
3488 | |
954c1994 |
3489 | =item XST_mIV |
3490 | |
3491 | Place an integer into the specified position C<pos> on the stack. The |
3492 | value is stored in a new mortal SV. |
3493 | |
3494 | void XST_mIV(int pos, IV iv) |
3495 | |
497711e7 |
3496 | =for hackers |
3497 | Found in file XSUB.h |
3498 | |
954c1994 |
3499 | =item XST_mNO |
3500 | |
3501 | Place C<&PL_sv_no> into the specified position C<pos> on the |
3502 | stack. |
3503 | |
3504 | void XST_mNO(int pos) |
3505 | |
497711e7 |
3506 | =for hackers |
3507 | Found in file XSUB.h |
3508 | |
954c1994 |
3509 | =item XST_mNV |
3510 | |
3511 | Place a double into the specified position C<pos> on the stack. The value |
3512 | is stored in a new mortal SV. |
3513 | |
3514 | void XST_mNV(int pos, NV nv) |
3515 | |
497711e7 |
3516 | =for hackers |
3517 | Found in file XSUB.h |
3518 | |
954c1994 |
3519 | =item XST_mPV |
3520 | |
3521 | Place a copy of a string into the specified position C<pos> on the stack. |
3522 | The value is stored in a new mortal SV. |
3523 | |
3524 | void XST_mPV(int pos, char* str) |
3525 | |
497711e7 |
3526 | =for hackers |
3527 | Found in file XSUB.h |
3528 | |
954c1994 |
3529 | =item XST_mUNDEF |
3530 | |
3531 | Place C<&PL_sv_undef> into the specified position C<pos> on the |
3532 | stack. |
3533 | |
3534 | void XST_mUNDEF(int pos) |
3535 | |
497711e7 |
3536 | =for hackers |
3537 | Found in file XSUB.h |
3538 | |
954c1994 |
3539 | =item XST_mYES |
3540 | |
3541 | Place C<&PL_sv_yes> into the specified position C<pos> on the |
3542 | stack. |
3543 | |
3544 | void XST_mYES(int pos) |
3545 | |
497711e7 |
3546 | =for hackers |
3547 | Found in file XSUB.h |
3548 | |
954c1994 |
3549 | =item XS_VERSION |
3550 | |
3551 | The version identifier for an XS module. This is usually |
3552 | handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>. |
3553 | |
497711e7 |
3554 | =for hackers |
3555 | Found in file XSUB.h |
3556 | |
954c1994 |
3557 | =item XS_VERSION_BOOTCHECK |
3558 | |
3559 | Macro to verify that a PM module's $VERSION variable matches the XS |
3560 | module's C<XS_VERSION> variable. This is usually handled automatically by |
3561 | C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">. |
3562 | |
3563 | XS_VERSION_BOOTCHECK; |
3564 | |
497711e7 |
3565 | =for hackers |
3566 | Found in file XSUB.h |
3567 | |
954c1994 |
3568 | =item Zero |
3569 | |
3570 | The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the |
3571 | destination, C<nitems> is the number of items, and C<type> is the type. |
3572 | |
3573 | void Zero(void* dest, int nitems, type) |
3574 | |
497711e7 |
3575 | =for hackers |
3576 | Found in file handy.h |
3577 | |
954c1994 |
3578 | =back |
3579 | |
3580 | =head1 AUTHORS |
3581 | |
3582 | Until May 1997, this document was maintained by Jeff Okamoto |
3583 | <okamoto@corp.hp.com>. It is now maintained as part of Perl itself. |
3584 | |
3585 | With lots of help and suggestions from Dean Roehrich, Malcolm Beattie, |
3586 | Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil |
3587 | Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, |
3588 | Stephen McCamant, and Gurusamy Sarathy. |
3589 | |
3590 | API Listing originally by Dean Roehrich <roehrich@cray.com>. |
3591 | |
3592 | Updated to be autogenerated from comments in the source by Benjamin Stuhl. |
3593 | |
3594 | =head1 SEE ALSO |
3595 | |
3596 | perlguts(1), perlxs(1), perlxstut(1), perlintern(1) |
3597 | |