3 * Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010,
4 * 2011, 2012 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * Anything that Hobbits had no immediate use for, but were unwilling to
13 * throw away, they called a mathom. Their dwellings were apt to become
14 * rather crowded with mathoms, and many of the presents that passed from
15 * hand to hand were of that sort.
17 * [p.5 of _The Lord of the Rings_: "Prologue"]
23 * This file contains mathoms, various binary artifacts from previous
24 * versions of Perl. For binary or source compatibility reasons, though,
25 * we cannot completely remove them from the core code.
27 * REMEMBER to update makedef.pl when adding a function to mathoms.c!!!
31 * The compilation of this file can be suppressed; see INSTALL
33 =head1 Obsolete backwards compatibility functions
34 Some of these are also deprecated. You can exclude these from
35 your compiled Perl by adding this option to Configure:
36 C<-Accflags='-DNO_MATHOMS'>
44 #define PERL_IN_MATHOMS_C
48 /* ..." warning: ISO C forbids an empty source file"
49 So make sure we have something in here by processing the headers anyway.
53 /* Not all of these have prototypes elsewhere, so do this to get
58 PERL_CALLCONV OP * Perl_ref(pTHX_ OP *o, I32 type);
59 PERL_CALLCONV void Perl_sv_unref(pTHX_ SV *sv);
60 PERL_CALLCONV void Perl_sv_taint(pTHX_ SV *sv);
61 PERL_CALLCONV IV Perl_sv_2iv(pTHX_ SV *sv);
62 PERL_CALLCONV UV Perl_sv_2uv(pTHX_ SV *sv);
63 PERL_CALLCONV NV Perl_sv_2nv(pTHX_ SV *sv);
64 PERL_CALLCONV char * Perl_sv_2pv(pTHX_ SV *sv, STRLEN *lp);
65 PERL_CALLCONV char * Perl_sv_2pv_nolen(pTHX_ SV *sv);
66 PERL_CALLCONV char * Perl_sv_2pvbyte_nolen(pTHX_ SV *sv);
67 PERL_CALLCONV char * Perl_sv_2pvutf8_nolen(pTHX_ SV *sv);
68 PERL_CALLCONV void Perl_sv_force_normal(pTHX_ SV *sv);
69 PERL_CALLCONV void Perl_sv_setsv(pTHX_ SV *dstr, SV *sstr);
70 PERL_CALLCONV void Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen);
71 PERL_CALLCONV void Perl_sv_catpvn_mg(pTHX_ SV *sv, const char *ptr, STRLEN len);
72 PERL_CALLCONV void Perl_sv_catsv(pTHX_ SV *dstr, SV *sstr);
73 PERL_CALLCONV void Perl_sv_catsv_mg(pTHX_ SV *dsv, SV *ssv);
74 PERL_CALLCONV char * Perl_sv_pv(pTHX_ SV *sv);
75 PERL_CALLCONV char * Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp);
76 PERL_CALLCONV char * Perl_sv_pvbyte(pTHX_ SV *sv);
77 PERL_CALLCONV char * Perl_sv_pvutf8(pTHX_ SV *sv);
78 PERL_CALLCONV STRLEN Perl_sv_utf8_upgrade(pTHX_ SV *sv);
79 PERL_CALLCONV NV Perl_huge(void);
80 PERL_CALLCONV void Perl_gv_fullname3(pTHX_ SV *sv, const GV *gv, const char *prefix);
81 PERL_CALLCONV void Perl_gv_efullname3(pTHX_ SV *sv, const GV *gv, const char *prefix);
82 PERL_CALLCONV GV * Perl_gv_fetchmethod(pTHX_ HV *stash, const char *name);
83 PERL_CALLCONV HE * Perl_hv_iternext(pTHX_ HV *hv);
84 PERL_CALLCONV void Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how);
85 PERL_CALLCONV bool Perl_do_open(pTHX_ GV *gv, const char *name, I32 len, int as_raw, int rawmode, int rawperm, PerlIO *supplied_fp);
86 PERL_CALLCONV bool Perl_do_aexec(pTHX_ SV *really, SV **mark, SV **sp);
87 PERL_CALLCONV U8 * Perl_uvuni_to_utf8(pTHX_ U8 *d, UV uv);
88 PERL_CALLCONV bool Perl_is_utf8_string_loc(pTHX_ const U8 *s, STRLEN len, const U8 **ep);
89 PERL_CALLCONV void Perl_sv_nolocking(pTHX_ SV *sv);
90 PERL_CALLCONV void Perl_sv_usepvn_mg(pTHX_ SV *sv, char *ptr, STRLEN len);
91 PERL_CALLCONV void Perl_sv_usepvn(pTHX_ SV *sv, char *ptr, STRLEN len);
92 PERL_CALLCONV int Perl_fprintf_nocontext(PerlIO *stream, const char *format, ...);
93 PERL_CALLCONV int Perl_printf_nocontext(const char *format, ...);
94 PERL_CALLCONV int Perl_magic_setglob(pTHX_ SV* sv, MAGIC* mg);
95 PERL_CALLCONV AV * Perl_newAV(pTHX);
96 PERL_CALLCONV HV * Perl_newHV(pTHX);
97 PERL_CALLCONV IO * Perl_newIO(pTHX);
98 PERL_CALLCONV I32 Perl_my_stat(pTHX);
99 PERL_CALLCONV I32 Perl_my_lstat(pTHX);
100 PERL_CALLCONV I32 Perl_sv_eq(pTHX_ SV *sv1, SV *sv2);
101 PERL_CALLCONV char * Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp);
102 PERL_CALLCONV bool Perl_sv_2bool(pTHX_ SV *const sv);
103 PERL_CALLCONV CV * Perl_newSUB(pTHX_ I32 floor, OP* o, OP* proto, OP* block);
104 PERL_CALLCONV UV Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp);
105 PERL_CALLCONV UV Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp);
106 PERL_CALLCONV UV Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp);
107 PERL_CALLCONV UV Perl_to_utf8_fold(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp);
108 PERL_CALLCONV SV *Perl_sv_mortalcopy(pTHX_ SV *const oldstr);
110 /* ref() is now a macro using Perl_doref;
111 * this version provided for binary compatibility only.
114 Perl_ref(pTHX_ OP *o, I32 type)
116 return doref(o, type, TRUE);
122 Unsets the RV status of the SV, and decrements the reference count of
123 whatever was being referenced by the RV. This can almost be thought of
124 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
125 being zero. See C<SvROK_off>.
131 Perl_sv_unref(pTHX_ SV *sv)
133 PERL_ARGS_ASSERT_SV_UNREF;
135 sv_unref_flags(sv, 0);
141 Taint an SV. Use C<SvTAINTED_on> instead.
147 Perl_sv_taint(pTHX_ SV *sv)
149 PERL_ARGS_ASSERT_SV_TAINT;
151 sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0);
154 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
155 * this function provided for binary compatibility only
159 Perl_sv_2iv(pTHX_ SV *sv)
161 PERL_ARGS_ASSERT_SV_2IV;
163 return sv_2iv_flags(sv, SV_GMAGIC);
166 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
167 * this function provided for binary compatibility only
171 Perl_sv_2uv(pTHX_ SV *sv)
173 PERL_ARGS_ASSERT_SV_2UV;
175 return sv_2uv_flags(sv, SV_GMAGIC);
178 /* sv_2nv() is now a macro using Perl_sv_2nv_flags();
179 * this function provided for binary compatibility only
183 Perl_sv_2nv(pTHX_ SV *sv)
185 return sv_2nv_flags(sv, SV_GMAGIC);
189 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
190 * this function provided for binary compatibility only
194 Perl_sv_2pv(pTHX_ SV *sv, STRLEN *lp)
196 PERL_ARGS_ASSERT_SV_2PV;
198 return sv_2pv_flags(sv, lp, SV_GMAGIC);
202 =for apidoc sv_2pv_nolen
204 Like C<sv_2pv()>, but doesn't return the length too. You should usually
205 use the macro wrapper C<SvPV_nolen(sv)> instead.
211 Perl_sv_2pv_nolen(pTHX_ SV *sv)
213 PERL_ARGS_ASSERT_SV_2PV_NOLEN;
214 return sv_2pv(sv, NULL);
218 =for apidoc sv_2pvbyte_nolen
220 Return a pointer to the byte-encoded representation of the SV.
221 May cause the SV to be downgraded from UTF-8 as a side-effect.
223 Usually accessed via the C<SvPVbyte_nolen> macro.
229 Perl_sv_2pvbyte_nolen(pTHX_ SV *sv)
231 PERL_ARGS_ASSERT_SV_2PVBYTE_NOLEN;
233 return sv_2pvbyte(sv, NULL);
237 =for apidoc sv_2pvutf8_nolen
239 Return a pointer to the UTF-8-encoded representation of the SV.
240 May cause the SV to be upgraded to UTF-8 as a side-effect.
242 Usually accessed via the C<SvPVutf8_nolen> macro.
248 Perl_sv_2pvutf8_nolen(pTHX_ SV *sv)
250 PERL_ARGS_ASSERT_SV_2PVUTF8_NOLEN;
252 return sv_2pvutf8(sv, NULL);
256 =for apidoc sv_force_normal
258 Undo various types of fakery on an SV: if the PV is a shared string, make
259 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
260 an xpvmg. See also C<sv_force_normal_flags>.
266 Perl_sv_force_normal(pTHX_ SV *sv)
268 PERL_ARGS_ASSERT_SV_FORCE_NORMAL;
270 sv_force_normal_flags(sv, 0);
273 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
274 * this function provided for binary compatibility only
278 Perl_sv_setsv(pTHX_ SV *dstr, SV *sstr)
280 PERL_ARGS_ASSERT_SV_SETSV;
282 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
285 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
286 * this function provided for binary compatibility only
290 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
292 PERL_ARGS_ASSERT_SV_CATPVN;
294 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
298 =for apidoc sv_catpvn_mg
300 Like C<sv_catpvn>, but also handles 'set' magic.
306 Perl_sv_catpvn_mg(pTHX_ SV *sv, const char *ptr, STRLEN len)
308 PERL_ARGS_ASSERT_SV_CATPVN_MG;
310 sv_catpvn_flags(sv,ptr,len,SV_GMAGIC|SV_SMAGIC);
313 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
314 * this function provided for binary compatibility only
318 Perl_sv_catsv(pTHX_ SV *dstr, SV *sstr)
320 PERL_ARGS_ASSERT_SV_CATSV;
322 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
326 =for apidoc sv_catsv_mg
328 Like C<sv_catsv>, but also handles 'set' magic.
334 Perl_sv_catsv_mg(pTHX_ SV *dsv, SV *ssv)
336 PERL_ARGS_ASSERT_SV_CATSV_MG;
338 sv_catsv_flags(dsv,ssv,SV_GMAGIC|SV_SMAGIC);
344 A private implementation of the C<SvIVx> macro for compilers which can't
345 cope with complex macro expressions. Always use the macro instead.
351 Perl_sv_iv(pTHX_ SV *sv)
353 PERL_ARGS_ASSERT_SV_IV;
357 return (IV)SvUVX(sv);
366 A private implementation of the C<SvUVx> macro for compilers which can't
367 cope with complex macro expressions. Always use the macro instead.
373 Perl_sv_uv(pTHX_ SV *sv)
375 PERL_ARGS_ASSERT_SV_UV;
380 return (UV)SvIVX(sv);
388 A private implementation of the C<SvNVx> macro for compilers which can't
389 cope with complex macro expressions. Always use the macro instead.
395 Perl_sv_nv(pTHX_ SV *sv)
397 PERL_ARGS_ASSERT_SV_NV;
407 Use the C<SvPV_nolen> macro instead
411 A private implementation of the C<SvPV> macro for compilers which can't
412 cope with complex macro expressions. Always use the macro instead.
418 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
420 PERL_ARGS_ASSERT_SV_PVN;
426 return sv_2pv(sv, lp);
431 Perl_sv_pvn_nomg(pTHX_ SV *sv, STRLEN *lp)
433 PERL_ARGS_ASSERT_SV_PVN_NOMG;
439 return sv_2pv_flags(sv, lp, 0);
442 /* sv_pv() is now a macro using SvPV_nolen();
443 * this function provided for binary compatibility only
447 Perl_sv_pv(pTHX_ SV *sv)
449 PERL_ARGS_ASSERT_SV_PV;
454 return sv_2pv(sv, NULL);
457 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
458 * this function provided for binary compatibility only
462 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
464 PERL_ARGS_ASSERT_SV_PVN_FORCE;
466 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
469 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
470 * this function provided for binary compatibility only
474 Perl_sv_pvbyte(pTHX_ SV *sv)
476 PERL_ARGS_ASSERT_SV_PVBYTE;
478 sv_utf8_downgrade(sv, FALSE);
483 =for apidoc sv_pvbyte
485 Use C<SvPVbyte_nolen> instead.
487 =for apidoc sv_pvbyten
489 A private implementation of the C<SvPVbyte> macro for compilers
490 which can't cope with complex macro expressions. Always use the macro
497 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
499 PERL_ARGS_ASSERT_SV_PVBYTEN;
501 sv_utf8_downgrade(sv, FALSE);
502 return sv_pvn(sv,lp);
505 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
506 * this function provided for binary compatibility only
510 Perl_sv_pvutf8(pTHX_ SV *sv)
512 PERL_ARGS_ASSERT_SV_PVUTF8;
519 =for apidoc sv_pvutf8
521 Use the C<SvPVutf8_nolen> macro instead
523 =for apidoc sv_pvutf8n
525 A private implementation of the C<SvPVutf8> macro for compilers
526 which can't cope with complex macro expressions. Always use the macro
533 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
535 PERL_ARGS_ASSERT_SV_PVUTF8N;
538 return sv_pvn(sv,lp);
541 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
542 * this function provided for binary compatibility only
546 Perl_sv_utf8_upgrade(pTHX_ SV *sv)
548 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE;
550 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
554 Perl_fprintf_nocontext(PerlIO *stream, const char *format, ...)
559 /* Easier to special case this here than in embed.pl. (Look at what it
560 generates for proto.h) */
561 #ifdef PERL_IMPLICIT_CONTEXT
562 PERL_ARGS_ASSERT_FPRINTF_NOCONTEXT;
565 va_start(arglist, format);
566 ret = PerlIO_vprintf(stream, format, arglist);
572 Perl_printf_nocontext(const char *format, ...)
578 #ifdef PERL_IMPLICIT_CONTEXT
579 PERL_ARGS_ASSERT_PRINTF_NOCONTEXT;
582 va_start(arglist, format);
583 ret = PerlIO_vprintf(PerlIO_stdout(), format, arglist);
588 #if defined(HUGE_VAL) || (defined(USE_LONG_DOUBLE) && defined(HUGE_VALL))
590 * This hack is to force load of "huge" support from libm.a
591 * So it is in perl for (say) POSIX to use.
592 * Needed for SunOS with Sun's 'acc' for example.
597 # if defined(USE_LONG_DOUBLE) && defined(HUGE_VALL)
605 /* compatibility with versions <= 5.003. */
607 Perl_gv_fullname(pTHX_ SV *sv, const GV *gv)
609 PERL_ARGS_ASSERT_GV_FULLNAME;
611 gv_fullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
614 /* compatibility with versions <= 5.003. */
616 Perl_gv_efullname(pTHX_ SV *sv, const GV *gv)
618 PERL_ARGS_ASSERT_GV_EFULLNAME;
620 gv_efullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
624 Perl_gv_fullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
626 PERL_ARGS_ASSERT_GV_FULLNAME3;
628 gv_fullname4(sv, gv, prefix, TRUE);
632 Perl_gv_efullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
634 PERL_ARGS_ASSERT_GV_EFULLNAME3;
636 gv_efullname4(sv, gv, prefix, TRUE);
640 =for apidoc gv_fetchmethod
642 See L</gv_fetchmethod_autoload>.
648 Perl_gv_fetchmethod(pTHX_ HV *stash, const char *name)
650 PERL_ARGS_ASSERT_GV_FETCHMETHOD;
652 return gv_fetchmethod_autoload(stash, name, TRUE);
656 Perl_hv_iternext(pTHX_ HV *hv)
658 PERL_ARGS_ASSERT_HV_ITERNEXT;
660 return hv_iternext_flags(hv, 0);
664 Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how)
666 PERL_ARGS_ASSERT_HV_MAGIC;
668 sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0);
672 Perl_do_open(pTHX_ GV *gv, const char *name, I32 len, int as_raw,
673 int rawmode, int rawperm, PerlIO *supplied_fp)
675 PERL_ARGS_ASSERT_DO_OPEN;
677 return do_openn(gv, name, len, as_raw, rawmode, rawperm,
678 supplied_fp, (SV **) NULL, 0);
682 Perl_do_open9(pTHX_ GV *gv, const char *name, I32 len, int
684 int rawmode, int rawperm, PerlIO *supplied_fp, SV *svs,
687 PERL_ARGS_ASSERT_DO_OPEN9;
689 PERL_UNUSED_ARG(num_svs);
690 return do_openn(gv, name, len, as_raw, rawmode, rawperm,
691 supplied_fp, &svs, 1);
695 Perl_do_binmode(pTHX_ PerlIO *fp, int iotype, int mode)
697 /* The old body of this is now in non-LAYER part of perlio.c
698 * This is a stub for any XS code which might have been calling it.
700 const char *name = ":raw";
702 PERL_ARGS_ASSERT_DO_BINMODE;
704 #ifdef PERLIO_USING_CRLF
705 if (!(mode & O_BINARY))
708 return PerlIO_binmode(aTHX_ fp, iotype, mode, name);
713 Perl_do_aexec(pTHX_ SV *really, SV **mark, SV **sp)
715 PERL_ARGS_ASSERT_DO_AEXEC;
717 return do_aexec5(really, mark, sp, 0, 0);
721 /* Backwards compatibility. */
723 Perl_init_i18nl14n(pTHX_ int printwarn)
725 return init_i18nl10n(printwarn);
729 Perl_is_utf8_string_loc(pTHX_ const U8 *s, STRLEN len, const U8 **ep)
731 PERL_ARGS_ASSERT_IS_UTF8_STRING_LOC;
734 return is_utf8_string_loclen(s, len, ep, 0);
738 =for apidoc sv_nolocking
740 Dummy routine which "locks" an SV when there is no locking module present.
741 Exists to avoid test for a NULL function pointer and because it could
742 potentially warn under some level of strict-ness.
744 "Superseded" by sv_nosharing().
750 Perl_sv_nolocking(pTHX_ SV *sv)
758 =for apidoc sv_nounlocking
760 Dummy routine which "unlocks" an SV when there is no locking module present.
761 Exists to avoid test for a NULL function pointer and because it could
762 potentially warn under some level of strict-ness.
764 "Superseded" by sv_nosharing().
770 Perl_sv_nounlocking(pTHX_ SV *sv)
777 Perl_save_long(pTHX_ long int *longp)
779 PERL_ARGS_ASSERT_SAVE_LONG;
784 SSPUSHUV(SAVEt_LONG);
788 Perl_save_iv(pTHX_ IV *ivp)
790 PERL_ARGS_ASSERT_SAVE_IV;
799 Perl_save_nogv(pTHX_ GV *gv)
801 PERL_ARGS_ASSERT_SAVE_NOGV;
805 SSPUSHUV(SAVEt_NSTAB);
809 Perl_save_list(pTHX_ SV **sarg, I32 maxsarg)
813 PERL_ARGS_ASSERT_SAVE_LIST;
815 for (i = 1; i <= maxsarg; i++) {
819 sv_setsv_nomg(sv,sarg[i]);
821 SSPUSHPTR(sarg[i]); /* remember the pointer */
822 SSPUSHPTR(sv); /* remember the value */
823 SSPUSHUV(SAVEt_ITEM);
828 =for apidoc sv_usepvn_mg
830 Like C<sv_usepvn>, but also handles 'set' magic.
836 Perl_sv_usepvn_mg(pTHX_ SV *sv, char *ptr, STRLEN len)
838 PERL_ARGS_ASSERT_SV_USEPVN_MG;
840 sv_usepvn_flags(sv,ptr,len, SV_SMAGIC);
844 =for apidoc sv_usepvn
846 Tells an SV to use C<ptr> to find its string value. Implemented by
847 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
848 magic. See C<sv_usepvn_flags>.
854 Perl_sv_usepvn(pTHX_ SV *sv, char *ptr, STRLEN len)
856 PERL_ARGS_ASSERT_SV_USEPVN;
858 sv_usepvn_flags(sv,ptr,len, 0);
862 =for apidoc unpack_str
864 The engine implementing unpack() Perl function. Note: parameters strbeg,
865 new_s and ocnt are not used. This call should not be used, use
866 unpackstring instead.
871 Perl_unpack_str(pTHX_ const char *pat, const char *patend, const char *s,
872 const char *strbeg, const char *strend, char **new_s, I32 ocnt,
875 PERL_ARGS_ASSERT_UNPACK_STR;
877 PERL_UNUSED_ARG(strbeg);
878 PERL_UNUSED_ARG(new_s);
879 PERL_UNUSED_ARG(ocnt);
881 return unpackstring(pat, patend, s, strend, flags);
887 The engine implementing pack() Perl function. Note: parameters
888 next_in_list and flags are not used. This call should not be used; use
895 Perl_pack_cat(pTHX_ SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
897 PERL_ARGS_ASSERT_PACK_CAT;
899 PERL_UNUSED_ARG(next_in_list);
900 PERL_UNUSED_ARG(flags);
902 packlist(cat, pat, patend, beglist, endlist);
906 Perl_hv_store_ent(pTHX_ HV *hv, SV *keysv, SV *val, U32 hash)
908 return (HE *)hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISSTORE, val, hash);
912 Perl_hv_exists_ent(pTHX_ HV *hv, SV *keysv, U32 hash)
914 PERL_ARGS_ASSERT_HV_EXISTS_ENT;
916 return hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISEXISTS, 0, hash)
921 Perl_hv_fetch_ent(pTHX_ HV *hv, SV *keysv, I32 lval, U32 hash)
923 PERL_ARGS_ASSERT_HV_FETCH_ENT;
925 return (HE *)hv_common(hv, keysv, NULL, 0, 0,
926 (lval ? HV_FETCH_LVALUE : 0), NULL, hash);
930 Perl_hv_delete_ent(pTHX_ HV *hv, SV *keysv, I32 flags, U32 hash)
932 PERL_ARGS_ASSERT_HV_DELETE_ENT;
934 return MUTABLE_SV(hv_common(hv, keysv, NULL, 0, 0, flags | HV_DELETE, NULL,
939 Perl_hv_store_flags(pTHX_ HV *hv, const char *key, I32 klen, SV *val, U32 hash,
942 return (SV**) hv_common(hv, NULL, key, klen, flags,
943 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
947 Perl_hv_store(pTHX_ HV *hv, const char *key, I32 klen_i32, SV *val, U32 hash)
959 return (SV **) hv_common(hv, NULL, key, klen, flags,
960 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
964 Perl_hv_exists(pTHX_ HV *hv, const char *key, I32 klen_i32)
969 PERL_ARGS_ASSERT_HV_EXISTS;
978 return hv_common(hv, NULL, key, klen, flags, HV_FETCH_ISEXISTS, 0, 0)
983 Perl_hv_fetch(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 lval)
988 PERL_ARGS_ASSERT_HV_FETCH;
997 return (SV **) hv_common(hv, NULL, key, klen, flags,
998 lval ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)
999 : HV_FETCH_JUST_SV, NULL, 0);
1003 Perl_hv_delete(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 flags)
1008 PERL_ARGS_ASSERT_HV_DELETE;
1012 k_flags = HVhek_UTF8;
1017 return MUTABLE_SV(hv_common(hv, NULL, key, klen, k_flags, flags | HV_DELETE,
1021 /* Functions after here were made mathoms post 5.10.0 but pre 5.8.9 */
1026 return MUTABLE_AV(newSV_type(SVt_PVAV));
1027 /* sv_upgrade does AvREAL_only():
1030 AvMAX(av) = AvFILLp(av) = -1; */
1036 HV * const hv = MUTABLE_HV(newSV_type(SVt_PVHV));
1043 Perl_sv_insert(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len,
1044 const char *const little, const STRLEN littlelen)
1046 PERL_ARGS_ASSERT_SV_INSERT;
1047 sv_insert_flags(bigstr, offset, len, little, littlelen, SV_GMAGIC);
1051 Perl_save_freesv(pTHX_ SV *sv)
1057 Perl_save_mortalizesv(pTHX_ SV *sv)
1059 PERL_ARGS_ASSERT_SAVE_MORTALIZESV;
1061 save_mortalizesv(sv);
1065 Perl_save_freeop(pTHX_ OP *o)
1071 Perl_save_freepv(pTHX_ char *pv)
1082 #ifdef PERL_DONT_CREATE_GVSV
1084 Perl_gv_SVadd(pTHX_ GV *gv)
1086 return gv_SVadd(gv);
1091 Perl_gv_AVadd(pTHX_ GV *gv)
1093 return gv_AVadd(gv);
1097 Perl_gv_HVadd(pTHX_ GV *gv)
1099 return gv_HVadd(gv);
1103 Perl_gv_IOadd(pTHX_ GV *gv)
1105 return gv_IOadd(gv);
1111 return MUTABLE_IO(newSV_type(SVt_PVIO));
1117 return my_stat_flags(SV_GMAGIC);
1123 return my_lstat_flags(SV_GMAGIC);
1127 Perl_sv_eq(pTHX_ SV *sv1, SV *sv2)
1129 return sv_eq_flags(sv1, sv2, SV_GMAGIC);
1132 #ifdef USE_LOCALE_COLLATE
1134 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
1136 return sv_collxfrm_flags(sv, nxp, SV_GMAGIC);
1141 Perl_sv_2bool(pTHX_ SV *const sv)
1143 return sv_2bool_flags(sv, SV_GMAGIC);
1148 =for apidoc custom_op_name
1149 Return the name for a given custom op. This was once used by the OP_NAME
1150 macro, but is no longer: it has only been kept for compatibility, and
1153 =for apidoc custom_op_desc
1154 Return the description of a given custom op. This was once used by the
1155 OP_DESC macro, but is no longer: it has only been kept for
1156 compatibility, and should not be used.
1162 Perl_custom_op_name(pTHX_ const OP* o)
1164 PERL_ARGS_ASSERT_CUSTOM_OP_NAME;
1165 return XopENTRYCUSTOM(o, xop_name);
1169 Perl_custom_op_desc(pTHX_ const OP* o)
1171 PERL_ARGS_ASSERT_CUSTOM_OP_DESC;
1172 return XopENTRYCUSTOM(o, xop_desc);
1176 Perl_newSUB(pTHX_ I32 floor, OP *o, OP *proto, OP *block)
1178 return newATTRSUB(floor, o, proto, NULL, block);
1182 Perl_to_utf8_fold(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1184 PERL_ARGS_ASSERT_TO_UTF8_FOLD;
1186 return _to_utf8_fold_flags(p, ustrp, lenp, FOLD_FLAGS_FULL);
1190 Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1192 PERL_ARGS_ASSERT_TO_UTF8_LOWER;
1194 return _to_utf8_lower_flags(p, ustrp, lenp, FALSE);
1198 Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1200 PERL_ARGS_ASSERT_TO_UTF8_TITLE;
1202 return _to_utf8_title_flags(p, ustrp, lenp, FALSE);
1206 Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1208 PERL_ARGS_ASSERT_TO_UTF8_UPPER;
1210 return _to_utf8_upper_flags(p, ustrp, lenp, FALSE);
1214 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
1216 return Perl_sv_mortalcopy_flags(aTHX_ oldstr, SV_GMAGIC);
1219 UV /* Made into a function, so can be deprecated */
1220 NATIVE_TO_NEED(const UV enc, const UV ch)
1222 PERL_UNUSED_ARG(enc);
1226 UV /* Made into a function, so can be deprecated */
1227 ASCII_TO_NEED(const UV enc, const UV ch)
1229 PERL_UNUSED_ARG(enc);
1233 bool /* Made into a function, so can be deprecated */
1234 Perl_isIDFIRST_lazy(pTHX_ const char* p)
1236 PERL_ARGS_ASSERT_ISIDFIRST_LAZY;
1238 return isIDFIRST_lazy_if(p,1);
1241 bool /* Made into a function, so can be deprecated */
1242 Perl_isALNUM_lazy(pTHX_ const char* p)
1244 PERL_ARGS_ASSERT_ISALNUM_LAZY;
1246 return isALNUM_lazy_if(p,1);
1250 Perl_is_uni_alnum(pTHX_ UV c)
1252 return isWORDCHAR_uni(c);
1256 Perl_is_uni_alnumc(pTHX_ UV c)
1258 return isALNUM_uni(c);
1262 Perl_is_uni_alpha(pTHX_ UV c)
1264 return isALPHA_uni(c);
1268 Perl_is_uni_ascii(pTHX_ UV c)
1270 PERL_UNUSED_CONTEXT;
1271 return isASCII_uni(c);
1275 Perl_is_uni_blank(pTHX_ UV c)
1277 PERL_UNUSED_CONTEXT;
1278 return isBLANK_uni(c);
1282 Perl_is_uni_space(pTHX_ UV c)
1284 PERL_UNUSED_CONTEXT;
1285 return isSPACE_uni(c);
1289 Perl_is_uni_digit(pTHX_ UV c)
1291 PERL_UNUSED_CONTEXT;
1292 return isDIGIT_uni(c);
1296 Perl_is_uni_upper(pTHX_ UV c)
1298 PERL_UNUSED_CONTEXT;
1299 return isUPPER_uni(c);
1303 Perl_is_uni_lower(pTHX_ UV c)
1305 PERL_UNUSED_CONTEXT;
1306 return isLOWER_uni(c);
1310 Perl_is_uni_cntrl(pTHX_ UV c)
1312 PERL_UNUSED_CONTEXT;
1313 return isCNTRL_L1(c);
1317 Perl_is_uni_graph(pTHX_ UV c)
1319 PERL_UNUSED_CONTEXT;
1320 return isGRAPH_uni(c);
1324 Perl_is_uni_print(pTHX_ UV c)
1326 PERL_UNUSED_CONTEXT;
1327 return isPRINT_uni(c);
1331 Perl_is_uni_punct(pTHX_ UV c)
1333 PERL_UNUSED_CONTEXT;
1334 return isPUNCT_uni(c);
1338 Perl_is_uni_xdigit(pTHX_ UV c)
1340 PERL_UNUSED_CONTEXT;
1341 return isXDIGIT_uni(c);
1345 Perl_is_uni_alnum_lc(pTHX_ UV c)
1347 PERL_UNUSED_CONTEXT;
1348 return isWORDCHAR_LC_uvchr(c);
1352 Perl_is_uni_alnumc_lc(pTHX_ UV c)
1354 PERL_UNUSED_CONTEXT;
1355 return isALPHANUMERIC_LC_uvchr(c);
1359 Perl_is_uni_idfirst_lc(pTHX_ UV c)
1361 PERL_UNUSED_CONTEXT;
1362 /* XXX Should probably be something that resolves to the old IDFIRST, but
1363 * this function is deprecated, so not bothering */
1364 return isIDFIRST_LC_uvchr(c);
1368 Perl_is_uni_alpha_lc(pTHX_ UV c)
1370 PERL_UNUSED_CONTEXT;
1371 return isALPHA_LC_uvchr(c);
1375 Perl_is_uni_ascii_lc(pTHX_ UV c)
1377 PERL_UNUSED_CONTEXT;
1378 return isASCII_LC_uvchr(c);
1382 Perl_is_uni_blank_lc(pTHX_ UV c)
1384 PERL_UNUSED_CONTEXT;
1385 return isBLANK_LC_uvchr(c);
1389 Perl_is_uni_space_lc(pTHX_ UV c)
1391 PERL_UNUSED_CONTEXT;
1392 return isSPACE_LC_uvchr(c);
1396 Perl_is_uni_digit_lc(pTHX_ UV c)
1398 return isDIGIT_LC_uvchr(c);
1402 Perl_is_uni_idfirst(pTHX_ UV c)
1404 U8 tmpbuf[UTF8_MAXBYTES+1];
1405 uvchr_to_utf8(tmpbuf, c);
1406 return _is_utf8_idstart(tmpbuf);
1410 Perl_is_utf8_idfirst(pTHX_ const U8 *p) /* The naming is historical. */
1412 PERL_ARGS_ASSERT_IS_UTF8_IDFIRST;
1414 return _is_utf8_idstart(p);
1418 Perl_is_utf8_xidfirst(pTHX_ const U8 *p) /* The naming is historical. */
1420 PERL_ARGS_ASSERT_IS_UTF8_XIDFIRST;
1422 return _is_utf8_xidstart(p);
1426 Perl_is_utf8_idcont(pTHX_ const U8 *p)
1428 PERL_ARGS_ASSERT_IS_UTF8_IDCONT;
1430 return _is_utf8_idcont(p);
1434 Perl_is_utf8_xidcont(pTHX_ const U8 *p)
1436 PERL_ARGS_ASSERT_IS_UTF8_XIDCONT;
1438 return _is_utf8_xidcont(p);
1442 Perl_is_uni_upper_lc(pTHX_ UV c)
1444 return isUPPER_LC_uvchr(c);
1448 Perl_is_uni_lower_lc(pTHX_ UV c)
1450 return isLOWER_LC_uvchr(c);
1454 Perl_is_uni_cntrl_lc(pTHX_ UV c)
1456 return isCNTRL_LC_uvchr(c);
1460 Perl_is_uni_graph_lc(pTHX_ UV c)
1462 return isGRAPH_LC_uvchr(c);
1466 Perl_is_uni_print_lc(pTHX_ UV c)
1468 return isPRINT_LC_uvchr(c);
1472 Perl_is_uni_punct_lc(pTHX_ UV c)
1474 return isPUNCT_LC_uvchr(c);
1478 Perl_is_uni_xdigit_lc(pTHX_ UV c)
1480 return isXDIGIT_LC_uvchr(c);
1484 Perl_to_uni_upper_lc(pTHX_ U32 c)
1486 /* XXX returns only the first character -- do not use XXX */
1487 /* XXX no locale support yet */
1489 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1490 return (U32)to_uni_upper(c, tmpbuf, &len);
1494 Perl_to_uni_title_lc(pTHX_ U32 c)
1496 /* XXX returns only the first character XXX -- do not use XXX */
1497 /* XXX no locale support yet */
1499 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1500 return (U32)to_uni_title(c, tmpbuf, &len);
1504 Perl_to_uni_lower_lc(pTHX_ U32 c)
1506 /* XXX returns only the first character -- do not use XXX */
1507 /* XXX no locale support yet */
1509 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1510 return (U32)to_uni_lower(c, tmpbuf, &len);
1514 Perl_is_utf8_alnum(pTHX_ const U8 *p)
1516 PERL_ARGS_ASSERT_IS_UTF8_ALNUM;
1518 /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
1519 * descendant of isalnum(3), in other words, it doesn't
1520 * contain the '_'. --jhi */
1521 return isWORDCHAR_utf8(p);
1525 Perl_is_utf8_alnumc(pTHX_ const U8 *p)
1527 PERL_ARGS_ASSERT_IS_UTF8_ALNUMC;
1529 return isALPHANUMERIC_utf8(p);
1533 Perl_is_utf8_alpha(pTHX_ const U8 *p)
1535 PERL_ARGS_ASSERT_IS_UTF8_ALPHA;
1537 return isALPHA_utf8(p);
1541 Perl_is_utf8_ascii(pTHX_ const U8 *p)
1543 PERL_ARGS_ASSERT_IS_UTF8_ASCII;
1544 PERL_UNUSED_CONTEXT;
1546 return isASCII_utf8(p);
1550 Perl_is_utf8_blank(pTHX_ const U8 *p)
1552 PERL_ARGS_ASSERT_IS_UTF8_BLANK;
1553 PERL_UNUSED_CONTEXT;
1555 return isBLANK_utf8(p);
1559 Perl_is_utf8_space(pTHX_ const U8 *p)
1561 PERL_ARGS_ASSERT_IS_UTF8_SPACE;
1562 PERL_UNUSED_CONTEXT;
1564 return isSPACE_utf8(p);
1568 Perl_is_utf8_perl_space(pTHX_ const U8 *p)
1570 PERL_ARGS_ASSERT_IS_UTF8_PERL_SPACE;
1571 PERL_UNUSED_CONTEXT;
1573 /* Only true if is an ASCII space-like character, and ASCII is invariant
1574 * under utf8, so can just use the macro */
1575 return isSPACE_A(*p);
1579 Perl_is_utf8_perl_word(pTHX_ const U8 *p)
1581 PERL_ARGS_ASSERT_IS_UTF8_PERL_WORD;
1582 PERL_UNUSED_CONTEXT;
1584 /* Only true if is an ASCII word character, and ASCII is invariant
1585 * under utf8, so can just use the macro */
1586 return isWORDCHAR_A(*p);
1590 Perl_is_utf8_digit(pTHX_ const U8 *p)
1592 PERL_ARGS_ASSERT_IS_UTF8_DIGIT;
1594 return isDIGIT_utf8(p);
1598 Perl_is_utf8_posix_digit(pTHX_ const U8 *p)
1600 PERL_ARGS_ASSERT_IS_UTF8_POSIX_DIGIT;
1601 PERL_UNUSED_CONTEXT;
1603 /* Only true if is an ASCII digit character, and ASCII is invariant
1604 * under utf8, so can just use the macro */
1605 return isDIGIT_A(*p);
1609 Perl_is_utf8_upper(pTHX_ const U8 *p)
1611 PERL_ARGS_ASSERT_IS_UTF8_UPPER;
1613 return isUPPER_utf8(p);
1617 Perl_is_utf8_lower(pTHX_ const U8 *p)
1619 PERL_ARGS_ASSERT_IS_UTF8_LOWER;
1621 return isLOWER_utf8(p);
1625 Perl_is_utf8_cntrl(pTHX_ const U8 *p)
1627 PERL_ARGS_ASSERT_IS_UTF8_CNTRL;
1628 PERL_UNUSED_CONTEXT;
1630 return isCNTRL_utf8(p);
1634 Perl_is_utf8_graph(pTHX_ const U8 *p)
1636 PERL_ARGS_ASSERT_IS_UTF8_GRAPH;
1638 return isGRAPH_utf8(p);
1642 Perl_is_utf8_print(pTHX_ const U8 *p)
1644 PERL_ARGS_ASSERT_IS_UTF8_PRINT;
1646 return isPRINT_utf8(p);
1650 Perl_is_utf8_punct(pTHX_ const U8 *p)
1652 PERL_ARGS_ASSERT_IS_UTF8_PUNCT;
1654 return isPUNCT_utf8(p);
1658 Perl_is_utf8_xdigit(pTHX_ const U8 *p)
1660 PERL_ARGS_ASSERT_IS_UTF8_XDIGIT;
1661 PERL_UNUSED_CONTEXT;
1663 return isXDIGIT_utf8(p);
1667 Perl_is_utf8_mark(pTHX_ const U8 *p)
1669 PERL_ARGS_ASSERT_IS_UTF8_MARK;
1671 return _is_utf8_mark(p);
1675 =for apidoc is_utf8_char
1677 Tests if some arbitrary number of bytes begins in a valid UTF-8
1678 character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
1679 character is a valid UTF-8 character. The actual number of bytes in the UTF-8
1680 character will be returned if it is valid, otherwise 0.
1682 This function is deprecated due to the possibility that malformed input could
1683 cause reading beyond the end of the input buffer. Use L</isUTF8_CHAR>
1689 Perl_is_utf8_char(const U8 *s)
1691 PERL_ARGS_ASSERT_IS_UTF8_CHAR;
1693 /* Assumes we have enough space, which is why this is deprecated */
1694 return isUTF8_CHAR(s, s + UTF8SKIP(s));
1698 * Like L</utf8_to_uvuni_buf>(), but should only be called when it is known that
1699 * there are no malformations in the input UTF-8 string C<s>. Surrogates,
1700 * non-character code points, and non-Unicode code points are allowed */
1703 Perl_valid_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1705 PERL_ARGS_ASSERT_VALID_UTF8_TO_UVUNI;
1707 return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1711 =for apidoc utf8_to_uvchr
1713 Returns the native code point of the first character in the string C<s>
1714 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1715 length, in bytes, of that character.
1717 Some, but not all, UTF-8 malformations are detected, and in fact, some
1718 malformed input could cause reading beyond the end of the input buffer, which
1719 is why this function is deprecated. Use L</utf8_to_uvchr_buf> instead.
1721 If C<s> points to one of the detected malformations, and UTF8 warnings are
1722 enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
1723 NULL) to -1. If those warnings are off, the computed value if well-defined (or
1724 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1725 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1726 next possible position in C<s> that could begin a non-malformed character.
1727 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1733 Perl_utf8_to_uvchr(pTHX_ const U8 *s, STRLEN *retlen)
1735 PERL_ARGS_ASSERT_UTF8_TO_UVCHR;
1737 return utf8_to_uvchr_buf(s, s + UTF8_MAXBYTES, retlen);
1741 =for apidoc utf8_to_uvuni
1743 Returns the Unicode code point of the first character in the string C<s>
1744 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1745 length, in bytes, of that character.
1747 Some, but not all, UTF-8 malformations are detected, and in fact, some
1748 malformed input could cause reading beyond the end of the input buffer, which
1749 is one reason why this function is deprecated. The other is that only in
1750 extremely limited circumstances should the Unicode versus native code point be
1751 of any interest to you. See L</utf8_to_uvuni_buf> for alternatives.
1753 If C<s> points to one of the detected malformations, and UTF8 warnings are
1754 enabled, zero is returned and C<*retlen> is set (if C<retlen> doesn't point to
1755 NULL) to -1. If those warnings are off, the computed value if well-defined (or
1756 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1757 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1758 next possible position in C<s> that could begin a non-malformed character.
1759 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1765 Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1767 PERL_ARGS_ASSERT_UTF8_TO_UVUNI;
1769 return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1773 Perl_save_re_context(pTHX)
1775 PERL_UNUSED_CONTEXT;
1779 =for apidoc Am|HV *|pad_compname_type|PADOFFSET po
1781 Looks up the type of the lexical variable at position I<po> in the
1782 currently-compiling pad. If the variable is typed, the stash of the
1783 class to which it is typed is returned. If not, C<NULL> is returned.
1789 Perl_pad_compname_type(pTHX_ const PADOFFSET po)
1791 return PAD_COMPNAME_TYPE(po);
1797 #endif /* NO_MATHOMS */
1801 * c-indentation-style: bsd
1803 * indent-tabs-mode: nil
1806 * ex: set ts=8 sts=4 sw=4 et: