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.
29 * The compilation of this file can be suppressed; see INSTALL
31 =head1 Obsolete backwards compatibility functions
32 Some of these are also deprecated. You can exclude these from
33 your compiled Perl by adding this option to Configure:
34 C<-Accflags='-DNO_MATHOMS'>
42 #define PERL_IN_MATHOMS_C
46 /* ..." warning: ISO C forbids an empty source file"
47 So make sure we have something in here by processing the headers anyway.
51 /* Not all of these have prototypes elsewhere, so do this to get
56 PERL_CALLCONV OP * Perl_ref(pTHX_ OP *o, I32 type);
57 PERL_CALLCONV void Perl_sv_unref(pTHX_ SV *sv);
58 PERL_CALLCONV void Perl_sv_taint(pTHX_ SV *sv);
59 PERL_CALLCONV IV Perl_sv_2iv(pTHX_ SV *sv);
60 PERL_CALLCONV UV Perl_sv_2uv(pTHX_ SV *sv);
61 PERL_CALLCONV NV Perl_sv_2nv(pTHX_ SV *sv);
62 PERL_CALLCONV char * Perl_sv_2pv(pTHX_ SV *sv, STRLEN *lp);
63 PERL_CALLCONV char * Perl_sv_2pv_nolen(pTHX_ SV *sv);
64 PERL_CALLCONV char * Perl_sv_2pvbyte_nolen(pTHX_ SV *sv);
65 PERL_CALLCONV char * Perl_sv_2pvutf8_nolen(pTHX_ SV *sv);
66 PERL_CALLCONV void Perl_sv_force_normal(pTHX_ SV *sv);
67 PERL_CALLCONV void Perl_sv_setsv(pTHX_ SV *dstr, SV *sstr);
68 PERL_CALLCONV void Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen);
69 PERL_CALLCONV void Perl_sv_catpvn_mg(pTHX_ SV *sv, const char *ptr, STRLEN len);
70 PERL_CALLCONV void Perl_sv_catsv(pTHX_ SV *dstr, SV *sstr);
71 PERL_CALLCONV void Perl_sv_catsv_mg(pTHX_ SV *dsv, SV *ssv);
72 PERL_CALLCONV char * Perl_sv_pv(pTHX_ SV *sv);
73 PERL_CALLCONV char * Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp);
74 PERL_CALLCONV char * Perl_sv_pvbyte(pTHX_ SV *sv);
75 PERL_CALLCONV char * Perl_sv_pvutf8(pTHX_ SV *sv);
76 PERL_CALLCONV STRLEN Perl_sv_utf8_upgrade(pTHX_ SV *sv);
77 PERL_CALLCONV NV Perl_huge(void);
78 PERL_CALLCONV void Perl_gv_fullname3(pTHX_ SV *sv, const GV *gv, const char *prefix);
79 PERL_CALLCONV void Perl_gv_efullname3(pTHX_ SV *sv, const GV *gv, const char *prefix);
80 PERL_CALLCONV GV * Perl_gv_fetchmethod(pTHX_ HV *stash, const char *name);
81 PERL_CALLCONV HE * Perl_hv_iternext(pTHX_ HV *hv);
82 PERL_CALLCONV void Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how);
83 PERL_CALLCONV bool Perl_do_open(pTHX_ GV *gv, const char *name, I32 len, int as_raw, int rawmode, int rawperm, PerlIO *supplied_fp);
84 PERL_CALLCONV bool Perl_do_aexec(pTHX_ SV *really, SV **mark, SV **sp);
85 PERL_CALLCONV U8 * Perl_uvuni_to_utf8(pTHX_ U8 *d, UV uv);
86 PERL_CALLCONV bool Perl_is_utf8_string_loc(pTHX_ const U8 *s, STRLEN len, const U8 **ep);
87 PERL_CALLCONV void Perl_sv_nolocking(pTHX_ SV *sv);
88 PERL_CALLCONV void Perl_sv_usepvn_mg(pTHX_ SV *sv, char *ptr, STRLEN len);
89 PERL_CALLCONV void Perl_sv_usepvn(pTHX_ SV *sv, char *ptr, STRLEN len);
90 PERL_CALLCONV int Perl_fprintf_nocontext(PerlIO *stream, const char *format, ...);
91 PERL_CALLCONV int Perl_printf_nocontext(const char *format, ...);
92 PERL_CALLCONV int Perl_magic_setglob(pTHX_ SV* sv, MAGIC* mg);
93 PERL_CALLCONV AV * Perl_newAV(pTHX);
94 PERL_CALLCONV HV * Perl_newHV(pTHX);
95 PERL_CALLCONV IO * Perl_newIO(pTHX);
96 PERL_CALLCONV I32 Perl_my_stat(pTHX);
97 PERL_CALLCONV I32 Perl_my_lstat(pTHX);
98 PERL_CALLCONV I32 Perl_sv_eq(pTHX_ SV *sv1, SV *sv2);
99 PERL_CALLCONV char * Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp);
100 PERL_CALLCONV bool Perl_sv_2bool(pTHX_ SV *const sv);
101 PERL_CALLCONV CV * Perl_newSUB(pTHX_ I32 floor, OP* o, OP* proto, OP* block);
102 PERL_CALLCONV UV Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp);
103 PERL_CALLCONV UV Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp);
104 PERL_CALLCONV UV Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp);
105 PERL_CALLCONV UV Perl_to_utf8_fold(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp);
106 PERL_CALLCONV SV *Perl_sv_mortalcopy(pTHX_ SV *const oldstr);
108 /* ref() is now a macro using Perl_doref;
109 * this version provided for binary compatibility only.
112 Perl_ref(pTHX_ OP *o, I32 type)
114 return doref(o, type, TRUE);
120 Unsets the RV status of the SV, and decrements the reference count of
121 whatever was being referenced by the RV. This can almost be thought of
122 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
123 being zero. See C<SvROK_off>.
129 Perl_sv_unref(pTHX_ SV *sv)
131 PERL_ARGS_ASSERT_SV_UNREF;
133 sv_unref_flags(sv, 0);
139 Taint an SV. Use C<SvTAINTED_on> instead.
145 Perl_sv_taint(pTHX_ SV *sv)
147 PERL_ARGS_ASSERT_SV_TAINT;
149 sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0);
152 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
153 * this function provided for binary compatibility only
157 Perl_sv_2iv(pTHX_ SV *sv)
159 PERL_ARGS_ASSERT_SV_2IV;
161 return sv_2iv_flags(sv, SV_GMAGIC);
164 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
165 * this function provided for binary compatibility only
169 Perl_sv_2uv(pTHX_ SV *sv)
171 PERL_ARGS_ASSERT_SV_2UV;
173 return sv_2uv_flags(sv, SV_GMAGIC);
176 /* sv_2nv() is now a macro using Perl_sv_2nv_flags();
177 * this function provided for binary compatibility only
181 Perl_sv_2nv(pTHX_ SV *sv)
183 return sv_2nv_flags(sv, SV_GMAGIC);
187 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
188 * this function provided for binary compatibility only
192 Perl_sv_2pv(pTHX_ SV *sv, STRLEN *lp)
194 PERL_ARGS_ASSERT_SV_2PV;
196 return sv_2pv_flags(sv, lp, SV_GMAGIC);
200 =for apidoc sv_2pv_nolen
202 Like C<sv_2pv()>, but doesn't return the length too. You should usually
203 use the macro wrapper C<SvPV_nolen(sv)> instead.
209 Perl_sv_2pv_nolen(pTHX_ SV *sv)
211 PERL_ARGS_ASSERT_SV_2PV_NOLEN;
212 return sv_2pv(sv, NULL);
216 =for apidoc sv_2pvbyte_nolen
218 Return a pointer to the byte-encoded representation of the SV.
219 May cause the SV to be downgraded from UTF-8 as a side-effect.
221 Usually accessed via the C<SvPVbyte_nolen> macro.
227 Perl_sv_2pvbyte_nolen(pTHX_ SV *sv)
229 PERL_ARGS_ASSERT_SV_2PVBYTE_NOLEN;
231 return sv_2pvbyte(sv, NULL);
235 =for apidoc sv_2pvutf8_nolen
237 Return a pointer to the UTF-8-encoded representation of the SV.
238 May cause the SV to be upgraded to UTF-8 as a side-effect.
240 Usually accessed via the C<SvPVutf8_nolen> macro.
246 Perl_sv_2pvutf8_nolen(pTHX_ SV *sv)
248 PERL_ARGS_ASSERT_SV_2PVUTF8_NOLEN;
250 return sv_2pvutf8(sv, NULL);
254 =for apidoc sv_force_normal
256 Undo various types of fakery on an SV: if the PV is a shared string, make
257 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
258 an xpvmg. See also C<sv_force_normal_flags>.
264 Perl_sv_force_normal(pTHX_ SV *sv)
266 PERL_ARGS_ASSERT_SV_FORCE_NORMAL;
268 sv_force_normal_flags(sv, 0);
271 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
272 * this function provided for binary compatibility only
276 Perl_sv_setsv(pTHX_ SV *dstr, SV *sstr)
278 PERL_ARGS_ASSERT_SV_SETSV;
280 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
283 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
284 * this function provided for binary compatibility only
288 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
290 PERL_ARGS_ASSERT_SV_CATPVN;
292 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
296 =for apidoc sv_catpvn_mg
298 Like C<sv_catpvn>, but also handles 'set' magic.
304 Perl_sv_catpvn_mg(pTHX_ SV *sv, const char *ptr, STRLEN len)
306 PERL_ARGS_ASSERT_SV_CATPVN_MG;
308 sv_catpvn_flags(sv,ptr,len,SV_GMAGIC|SV_SMAGIC);
311 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
312 * this function provided for binary compatibility only
316 Perl_sv_catsv(pTHX_ SV *dstr, SV *sstr)
318 PERL_ARGS_ASSERT_SV_CATSV;
320 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
324 =for apidoc sv_catsv_mg
326 Like C<sv_catsv>, but also handles 'set' magic.
332 Perl_sv_catsv_mg(pTHX_ SV *dsv, SV *ssv)
334 PERL_ARGS_ASSERT_SV_CATSV_MG;
336 sv_catsv_flags(dsv,ssv,SV_GMAGIC|SV_SMAGIC);
342 A private implementation of the C<SvIVx> macro for compilers which can't
343 cope with complex macro expressions. Always use the macro instead.
349 Perl_sv_iv(pTHX_ SV *sv)
351 PERL_ARGS_ASSERT_SV_IV;
355 return (IV)SvUVX(sv);
364 A private implementation of the C<SvUVx> macro for compilers which can't
365 cope with complex macro expressions. Always use the macro instead.
371 Perl_sv_uv(pTHX_ SV *sv)
373 PERL_ARGS_ASSERT_SV_UV;
378 return (UV)SvIVX(sv);
386 A private implementation of the C<SvNVx> macro for compilers which can't
387 cope with complex macro expressions. Always use the macro instead.
393 Perl_sv_nv(pTHX_ SV *sv)
395 PERL_ARGS_ASSERT_SV_NV;
405 Use the C<SvPV_nolen> macro instead
409 A private implementation of the C<SvPV> macro for compilers which can't
410 cope with complex macro expressions. Always use the macro instead.
416 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
418 PERL_ARGS_ASSERT_SV_PVN;
424 return sv_2pv(sv, lp);
429 Perl_sv_pvn_nomg(pTHX_ SV *sv, STRLEN *lp)
431 PERL_ARGS_ASSERT_SV_PVN_NOMG;
437 return sv_2pv_flags(sv, lp, 0);
440 /* sv_pv() is now a macro using SvPV_nolen();
441 * this function provided for binary compatibility only
445 Perl_sv_pv(pTHX_ SV *sv)
447 PERL_ARGS_ASSERT_SV_PV;
452 return sv_2pv(sv, NULL);
455 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
456 * this function provided for binary compatibility only
460 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
462 PERL_ARGS_ASSERT_SV_PVN_FORCE;
464 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
467 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
468 * this function provided for binary compatibility only
472 Perl_sv_pvbyte(pTHX_ SV *sv)
474 PERL_ARGS_ASSERT_SV_PVBYTE;
476 sv_utf8_downgrade(sv, FALSE);
481 =for apidoc sv_pvbyte
483 Use C<SvPVbyte_nolen> instead.
485 =for apidoc sv_pvbyten
487 A private implementation of the C<SvPVbyte> macro for compilers
488 which can't cope with complex macro expressions. Always use the macro
495 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
497 PERL_ARGS_ASSERT_SV_PVBYTEN;
499 sv_utf8_downgrade(sv, FALSE);
500 return sv_pvn(sv,lp);
503 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
504 * this function provided for binary compatibility only
508 Perl_sv_pvutf8(pTHX_ SV *sv)
510 PERL_ARGS_ASSERT_SV_PVUTF8;
517 =for apidoc sv_pvutf8
519 Use the C<SvPVutf8_nolen> macro instead
521 =for apidoc sv_pvutf8n
523 A private implementation of the C<SvPVutf8> macro for compilers
524 which can't cope with complex macro expressions. Always use the macro
531 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
533 PERL_ARGS_ASSERT_SV_PVUTF8N;
536 return sv_pvn(sv,lp);
539 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
540 * this function provided for binary compatibility only
544 Perl_sv_utf8_upgrade(pTHX_ SV *sv)
546 PERL_ARGS_ASSERT_SV_UTF8_UPGRADE;
548 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
552 Perl_fprintf_nocontext(PerlIO *stream, const char *format, ...)
557 /* Easier to special case this here than in embed.pl. (Look at what it
558 generates for proto.h) */
559 #ifdef PERL_IMPLICIT_CONTEXT
560 PERL_ARGS_ASSERT_FPRINTF_NOCONTEXT;
563 va_start(arglist, format);
564 ret = PerlIO_vprintf(stream, format, arglist);
570 Perl_printf_nocontext(const char *format, ...)
576 #ifdef PERL_IMPLICIT_CONTEXT
577 PERL_ARGS_ASSERT_PRINTF_NOCONTEXT;
580 va_start(arglist, format);
581 ret = PerlIO_vprintf(PerlIO_stdout(), format, arglist);
586 #if defined(HUGE_VAL) || (defined(USE_LONG_DOUBLE) && defined(HUGE_VALL))
588 * This hack is to force load of "huge" support from libm.a
589 * So it is in perl for (say) POSIX to use.
590 * Needed for SunOS with Sun's 'acc' for example.
595 # if defined(USE_LONG_DOUBLE) && defined(HUGE_VALL)
603 /* compatibility with versions <= 5.003. */
605 Perl_gv_fullname(pTHX_ SV *sv, const GV *gv)
607 PERL_ARGS_ASSERT_GV_FULLNAME;
609 gv_fullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
612 /* compatibility with versions <= 5.003. */
614 Perl_gv_efullname(pTHX_ SV *sv, const GV *gv)
616 PERL_ARGS_ASSERT_GV_EFULLNAME;
618 gv_efullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
622 Perl_gv_fullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
624 PERL_ARGS_ASSERT_GV_FULLNAME3;
626 gv_fullname4(sv, gv, prefix, TRUE);
630 Perl_gv_efullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
632 PERL_ARGS_ASSERT_GV_EFULLNAME3;
634 gv_efullname4(sv, gv, prefix, TRUE);
638 =for apidoc gv_fetchmethod
640 See L</gv_fetchmethod_autoload>.
646 Perl_gv_fetchmethod(pTHX_ HV *stash, const char *name)
648 PERL_ARGS_ASSERT_GV_FETCHMETHOD;
650 return gv_fetchmethod_autoload(stash, name, TRUE);
654 Perl_hv_iternext(pTHX_ HV *hv)
656 PERL_ARGS_ASSERT_HV_ITERNEXT;
658 return hv_iternext_flags(hv, 0);
662 Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how)
664 PERL_ARGS_ASSERT_HV_MAGIC;
666 sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0);
670 Perl_do_open(pTHX_ GV *gv, const char *name, I32 len, int as_raw,
671 int rawmode, int rawperm, PerlIO *supplied_fp)
673 PERL_ARGS_ASSERT_DO_OPEN;
675 return do_openn(gv, name, len, as_raw, rawmode, rawperm,
676 supplied_fp, (SV **) NULL, 0);
680 Perl_do_open9(pTHX_ GV *gv, const char *name, I32 len, int
682 int rawmode, int rawperm, PerlIO *supplied_fp, SV *svs,
685 PERL_ARGS_ASSERT_DO_OPEN9;
687 PERL_UNUSED_ARG(num_svs);
688 return do_openn(gv, name, len, as_raw, rawmode, rawperm,
689 supplied_fp, &svs, 1);
693 Perl_do_binmode(pTHX_ PerlIO *fp, int iotype, int mode)
695 /* The old body of this is now in non-LAYER part of perlio.c
696 * This is a stub for any XS code which might have been calling it.
698 const char *name = ":raw";
700 PERL_ARGS_ASSERT_DO_BINMODE;
702 #ifdef PERLIO_USING_CRLF
703 if (!(mode & O_BINARY))
706 return PerlIO_binmode(aTHX_ fp, iotype, mode, name);
711 Perl_do_aexec(pTHX_ SV *really, SV **mark, SV **sp)
713 PERL_ARGS_ASSERT_DO_AEXEC;
715 return do_aexec5(really, mark, sp, 0, 0);
719 /* Backwards compatibility. */
721 Perl_init_i18nl14n(pTHX_ int printwarn)
723 return init_i18nl10n(printwarn);
727 Perl_is_utf8_string_loc(pTHX_ const U8 *s, STRLEN len, const U8 **ep)
729 PERL_ARGS_ASSERT_IS_UTF8_STRING_LOC;
732 return is_utf8_string_loclen(s, len, ep, 0);
736 =for apidoc sv_nolocking
738 Dummy routine which "locks" an SV when there is no locking module present.
739 Exists to avoid test for a NULL function pointer and because it could
740 potentially warn under some level of strict-ness.
742 "Superseded" by sv_nosharing().
748 Perl_sv_nolocking(pTHX_ SV *sv)
756 =for apidoc sv_nounlocking
758 Dummy routine which "unlocks" an SV when there is no locking module present.
759 Exists to avoid test for a NULL function pointer and because it could
760 potentially warn under some level of strict-ness.
762 "Superseded" by sv_nosharing().
768 Perl_sv_nounlocking(pTHX_ SV *sv)
775 Perl_save_long(pTHX_ long int *longp)
777 PERL_ARGS_ASSERT_SAVE_LONG;
782 SSPUSHUV(SAVEt_LONG);
786 Perl_save_iv(pTHX_ IV *ivp)
788 PERL_ARGS_ASSERT_SAVE_IV;
797 Perl_save_nogv(pTHX_ GV *gv)
799 PERL_ARGS_ASSERT_SAVE_NOGV;
803 SSPUSHUV(SAVEt_NSTAB);
807 Perl_save_list(pTHX_ SV **sarg, I32 maxsarg)
811 PERL_ARGS_ASSERT_SAVE_LIST;
813 for (i = 1; i <= maxsarg; i++) {
817 sv_setsv_nomg(sv,sarg[i]);
819 SSPUSHPTR(sarg[i]); /* remember the pointer */
820 SSPUSHPTR(sv); /* remember the value */
821 SSPUSHUV(SAVEt_ITEM);
826 =for apidoc sv_usepvn_mg
828 Like C<sv_usepvn>, but also handles 'set' magic.
834 Perl_sv_usepvn_mg(pTHX_ SV *sv, char *ptr, STRLEN len)
836 PERL_ARGS_ASSERT_SV_USEPVN_MG;
838 sv_usepvn_flags(sv,ptr,len, SV_SMAGIC);
842 =for apidoc sv_usepvn
844 Tells an SV to use C<ptr> to find its string value. Implemented by
845 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
846 magic. See C<sv_usepvn_flags>.
852 Perl_sv_usepvn(pTHX_ SV *sv, char *ptr, STRLEN len)
854 PERL_ARGS_ASSERT_SV_USEPVN;
856 sv_usepvn_flags(sv,ptr,len, 0);
860 =for apidoc unpack_str
862 The engine implementing unpack() Perl function. Note: parameters strbeg,
863 new_s and ocnt are not used. This call should not be used, use
864 unpackstring instead.
869 Perl_unpack_str(pTHX_ const char *pat, const char *patend, const char *s,
870 const char *strbeg, const char *strend, char **new_s, I32 ocnt,
873 PERL_ARGS_ASSERT_UNPACK_STR;
875 PERL_UNUSED_ARG(strbeg);
876 PERL_UNUSED_ARG(new_s);
877 PERL_UNUSED_ARG(ocnt);
879 return unpackstring(pat, patend, s, strend, flags);
885 The engine implementing pack() Perl function. Note: parameters
886 next_in_list and flags are not used. This call should not be used; use
893 Perl_pack_cat(pTHX_ SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
895 PERL_ARGS_ASSERT_PACK_CAT;
897 PERL_UNUSED_ARG(next_in_list);
898 PERL_UNUSED_ARG(flags);
900 packlist(cat, pat, patend, beglist, endlist);
904 Perl_hv_store_ent(pTHX_ HV *hv, SV *keysv, SV *val, U32 hash)
906 return (HE *)hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISSTORE, val, hash);
910 Perl_hv_exists_ent(pTHX_ HV *hv, SV *keysv, U32 hash)
912 PERL_ARGS_ASSERT_HV_EXISTS_ENT;
914 return hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISEXISTS, 0, hash)
919 Perl_hv_fetch_ent(pTHX_ HV *hv, SV *keysv, I32 lval, U32 hash)
921 PERL_ARGS_ASSERT_HV_FETCH_ENT;
923 return (HE *)hv_common(hv, keysv, NULL, 0, 0,
924 (lval ? HV_FETCH_LVALUE : 0), NULL, hash);
928 Perl_hv_delete_ent(pTHX_ HV *hv, SV *keysv, I32 flags, U32 hash)
930 PERL_ARGS_ASSERT_HV_DELETE_ENT;
932 return MUTABLE_SV(hv_common(hv, keysv, NULL, 0, 0, flags | HV_DELETE, NULL,
937 Perl_hv_store_flags(pTHX_ HV *hv, const char *key, I32 klen, SV *val, U32 hash,
940 return (SV**) hv_common(hv, NULL, key, klen, flags,
941 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
945 Perl_hv_store(pTHX_ HV *hv, const char *key, I32 klen_i32, SV *val, U32 hash)
957 return (SV **) hv_common(hv, NULL, key, klen, flags,
958 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
962 Perl_hv_exists(pTHX_ HV *hv, const char *key, I32 klen_i32)
967 PERL_ARGS_ASSERT_HV_EXISTS;
976 return hv_common(hv, NULL, key, klen, flags, HV_FETCH_ISEXISTS, 0, 0)
981 Perl_hv_fetch(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 lval)
986 PERL_ARGS_ASSERT_HV_FETCH;
995 return (SV **) hv_common(hv, NULL, key, klen, flags,
996 lval ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)
997 : HV_FETCH_JUST_SV, NULL, 0);
1001 Perl_hv_delete(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 flags)
1006 PERL_ARGS_ASSERT_HV_DELETE;
1010 k_flags = HVhek_UTF8;
1015 return MUTABLE_SV(hv_common(hv, NULL, key, klen, k_flags, flags | HV_DELETE,
1019 /* Functions after here were made mathoms post 5.10.0 but pre 5.8.9 */
1024 return MUTABLE_AV(newSV_type(SVt_PVAV));
1025 /* sv_upgrade does AvREAL_only():
1028 AvMAX(av) = AvFILLp(av) = -1; */
1034 HV * const hv = MUTABLE_HV(newSV_type(SVt_PVHV));
1041 Perl_sv_insert(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len,
1042 const char *const little, const STRLEN littlelen)
1044 PERL_ARGS_ASSERT_SV_INSERT;
1045 sv_insert_flags(bigstr, offset, len, little, littlelen, SV_GMAGIC);
1049 Perl_save_freesv(pTHX_ SV *sv)
1055 Perl_save_mortalizesv(pTHX_ SV *sv)
1057 PERL_ARGS_ASSERT_SAVE_MORTALIZESV;
1059 save_mortalizesv(sv);
1063 Perl_save_freeop(pTHX_ OP *o)
1069 Perl_save_freepv(pTHX_ char *pv)
1080 #ifdef PERL_DONT_CREATE_GVSV
1082 Perl_gv_SVadd(pTHX_ GV *gv)
1084 return gv_SVadd(gv);
1089 Perl_gv_AVadd(pTHX_ GV *gv)
1091 return gv_AVadd(gv);
1095 Perl_gv_HVadd(pTHX_ GV *gv)
1097 return gv_HVadd(gv);
1101 Perl_gv_IOadd(pTHX_ GV *gv)
1103 return gv_IOadd(gv);
1109 return MUTABLE_IO(newSV_type(SVt_PVIO));
1115 return my_stat_flags(SV_GMAGIC);
1121 return my_lstat_flags(SV_GMAGIC);
1125 Perl_sv_eq(pTHX_ SV *sv1, SV *sv2)
1127 return sv_eq_flags(sv1, sv2, SV_GMAGIC);
1130 #ifdef USE_LOCALE_COLLATE
1132 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
1134 return sv_collxfrm_flags(sv, nxp, SV_GMAGIC);
1139 Perl_sv_2bool(pTHX_ SV *const sv)
1141 return sv_2bool_flags(sv, SV_GMAGIC);
1146 =for apidoc custom_op_name
1147 Return the name for a given custom op. This was once used by the OP_NAME
1148 macro, but is no longer: it has only been kept for compatibility, and
1151 =for apidoc custom_op_desc
1152 Return the description of a given custom op. This was once used by the
1153 OP_DESC macro, but is no longer: it has only been kept for
1154 compatibility, and should not be used.
1160 Perl_custom_op_name(pTHX_ const OP* o)
1162 PERL_ARGS_ASSERT_CUSTOM_OP_NAME;
1163 return XopENTRYCUSTOM(o, xop_name);
1167 Perl_custom_op_desc(pTHX_ const OP* o)
1169 PERL_ARGS_ASSERT_CUSTOM_OP_DESC;
1170 return XopENTRYCUSTOM(o, xop_desc);
1174 Perl_newSUB(pTHX_ I32 floor, OP *o, OP *proto, OP *block)
1176 return newATTRSUB(floor, o, proto, NULL, block);
1180 Perl_to_utf8_fold(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1182 PERL_ARGS_ASSERT_TO_UTF8_FOLD;
1184 return _to_utf8_fold_flags(p, ustrp, lenp, FOLD_FLAGS_FULL);
1188 Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1190 PERL_ARGS_ASSERT_TO_UTF8_LOWER;
1192 return _to_utf8_lower_flags(p, ustrp, lenp, FALSE);
1196 Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1198 PERL_ARGS_ASSERT_TO_UTF8_TITLE;
1200 return _to_utf8_title_flags(p, ustrp, lenp, FALSE);
1204 Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1206 PERL_ARGS_ASSERT_TO_UTF8_UPPER;
1208 return _to_utf8_upper_flags(p, ustrp, lenp, FALSE);
1212 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
1214 return Perl_sv_mortalcopy_flags(aTHX_ oldstr, SV_GMAGIC);
1217 UV /* Made into a function, so can be deprecated */
1218 NATIVE_TO_NEED(const UV enc, const UV ch)
1220 PERL_UNUSED_ARG(enc);
1224 UV /* Made into a function, so can be deprecated */
1225 ASCII_TO_NEED(const UV enc, const UV ch)
1227 PERL_UNUSED_ARG(enc);
1231 bool /* Made into a function, so can be deprecated */
1232 Perl_isIDFIRST_lazy(pTHX_ const char* p)
1234 PERL_ARGS_ASSERT_ISIDFIRST_LAZY;
1236 return isIDFIRST_lazy_if(p,1);
1239 bool /* Made into a function, so can be deprecated */
1240 Perl_isALNUM_lazy(pTHX_ const char* p)
1242 PERL_ARGS_ASSERT_ISALNUM_LAZY;
1244 return isALNUM_lazy_if(p,1);
1248 Perl_is_uni_alnum(pTHX_ UV c)
1250 return isWORDCHAR_uni(c);
1254 Perl_is_uni_alnumc(pTHX_ UV c)
1256 return isALNUM_uni(c);
1260 Perl_is_uni_alpha(pTHX_ UV c)
1262 return isALPHA_uni(c);
1266 Perl_is_uni_ascii(pTHX_ UV c)
1268 PERL_UNUSED_CONTEXT;
1269 return isASCII_uni(c);
1273 Perl_is_uni_blank(pTHX_ UV c)
1275 PERL_UNUSED_CONTEXT;
1276 return isBLANK_uni(c);
1280 Perl_is_uni_space(pTHX_ UV c)
1282 PERL_UNUSED_CONTEXT;
1283 return isSPACE_uni(c);
1287 Perl_is_uni_digit(pTHX_ UV c)
1289 PERL_UNUSED_CONTEXT;
1290 return isDIGIT_uni(c);
1294 Perl_is_uni_upper(pTHX_ UV c)
1296 PERL_UNUSED_CONTEXT;
1297 return isUPPER_uni(c);
1301 Perl_is_uni_lower(pTHX_ UV c)
1303 PERL_UNUSED_CONTEXT;
1304 return isLOWER_uni(c);
1308 Perl_is_uni_cntrl(pTHX_ UV c)
1310 PERL_UNUSED_CONTEXT;
1311 return isCNTRL_L1(c);
1315 Perl_is_uni_graph(pTHX_ UV c)
1317 PERL_UNUSED_CONTEXT;
1318 return isGRAPH_uni(c);
1322 Perl_is_uni_print(pTHX_ UV c)
1324 PERL_UNUSED_CONTEXT;
1325 return isPRINT_uni(c);
1329 Perl_is_uni_punct(pTHX_ UV c)
1331 PERL_UNUSED_CONTEXT;
1332 return isPUNCT_uni(c);
1336 Perl_is_uni_xdigit(pTHX_ UV c)
1338 PERL_UNUSED_CONTEXT;
1339 return isXDIGIT_uni(c);
1343 Perl_is_uni_alnum_lc(pTHX_ UV c)
1345 PERL_UNUSED_CONTEXT;
1346 return isWORDCHAR_LC_uvchr(c);
1350 Perl_is_uni_alnumc_lc(pTHX_ UV c)
1352 PERL_UNUSED_CONTEXT;
1353 return isALPHANUMERIC_LC_uvchr(c);
1357 Perl_is_uni_idfirst_lc(pTHX_ UV c)
1359 PERL_UNUSED_CONTEXT;
1360 /* XXX Should probably be something that resolves to the old IDFIRST, but
1361 * this function is deprecated, so not bothering */
1362 return isIDFIRST_LC_uvchr(c);
1366 Perl_is_uni_alpha_lc(pTHX_ UV c)
1368 PERL_UNUSED_CONTEXT;
1369 return isALPHA_LC_uvchr(c);
1373 Perl_is_uni_ascii_lc(pTHX_ UV c)
1375 PERL_UNUSED_CONTEXT;
1376 return isASCII_LC_uvchr(c);
1380 Perl_is_uni_blank_lc(pTHX_ UV c)
1382 PERL_UNUSED_CONTEXT;
1383 return isBLANK_LC_uvchr(c);
1387 Perl_is_uni_space_lc(pTHX_ UV c)
1389 PERL_UNUSED_CONTEXT;
1390 return isSPACE_LC_uvchr(c);
1394 Perl_is_uni_digit_lc(pTHX_ UV c)
1396 return isDIGIT_LC_uvchr(c);
1400 Perl_is_uni_idfirst(pTHX_ UV c)
1402 U8 tmpbuf[UTF8_MAXBYTES+1];
1403 uvchr_to_utf8(tmpbuf, c);
1404 return _is_utf8_idstart(tmpbuf);
1408 Perl_is_utf8_idfirst(pTHX_ const U8 *p) /* The naming is historical. */
1410 PERL_ARGS_ASSERT_IS_UTF8_IDFIRST;
1412 return _is_utf8_idstart(p);
1416 Perl_is_utf8_xidfirst(pTHX_ const U8 *p) /* The naming is historical. */
1418 PERL_ARGS_ASSERT_IS_UTF8_XIDFIRST;
1420 return _is_utf8_xidstart(p);
1424 Perl_is_utf8_idcont(pTHX_ const U8 *p)
1426 PERL_ARGS_ASSERT_IS_UTF8_IDCONT;
1428 return _is_utf8_idcont(p);
1432 Perl_is_utf8_xidcont(pTHX_ const U8 *p)
1434 PERL_ARGS_ASSERT_IS_UTF8_XIDCONT;
1436 return _is_utf8_xidcont(p);
1440 Perl_is_uni_upper_lc(pTHX_ UV c)
1442 return isUPPER_LC_uvchr(c);
1446 Perl_is_uni_lower_lc(pTHX_ UV c)
1448 return isLOWER_LC_uvchr(c);
1452 Perl_is_uni_cntrl_lc(pTHX_ UV c)
1454 return isCNTRL_LC_uvchr(c);
1458 Perl_is_uni_graph_lc(pTHX_ UV c)
1460 return isGRAPH_LC_uvchr(c);
1464 Perl_is_uni_print_lc(pTHX_ UV c)
1466 return isPRINT_LC_uvchr(c);
1470 Perl_is_uni_punct_lc(pTHX_ UV c)
1472 return isPUNCT_LC_uvchr(c);
1476 Perl_is_uni_xdigit_lc(pTHX_ UV c)
1478 return isXDIGIT_LC_uvchr(c);
1482 Perl_to_uni_upper_lc(pTHX_ U32 c)
1484 /* XXX returns only the first character -- do not use XXX */
1485 /* XXX no locale support yet */
1487 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1488 return (U32)to_uni_upper(c, tmpbuf, &len);
1492 Perl_to_uni_title_lc(pTHX_ U32 c)
1494 /* XXX returns only the first character XXX -- do not use XXX */
1495 /* XXX no locale support yet */
1497 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1498 return (U32)to_uni_title(c, tmpbuf, &len);
1502 Perl_to_uni_lower_lc(pTHX_ U32 c)
1504 /* XXX returns only the first character -- do not use XXX */
1505 /* XXX no locale support yet */
1507 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1508 return (U32)to_uni_lower(c, tmpbuf, &len);
1512 Perl_is_utf8_alnum(pTHX_ const U8 *p)
1514 PERL_ARGS_ASSERT_IS_UTF8_ALNUM;
1516 /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
1517 * descendant of isalnum(3), in other words, it doesn't
1518 * contain the '_'. --jhi */
1519 return isWORDCHAR_utf8(p);
1523 Perl_is_utf8_alnumc(pTHX_ const U8 *p)
1525 PERL_ARGS_ASSERT_IS_UTF8_ALNUMC;
1527 return isALPHANUMERIC_utf8(p);
1531 Perl_is_utf8_alpha(pTHX_ const U8 *p)
1533 PERL_ARGS_ASSERT_IS_UTF8_ALPHA;
1535 return isALPHA_utf8(p);
1539 Perl_is_utf8_ascii(pTHX_ const U8 *p)
1541 PERL_ARGS_ASSERT_IS_UTF8_ASCII;
1542 PERL_UNUSED_CONTEXT;
1544 return isASCII_utf8(p);
1548 Perl_is_utf8_blank(pTHX_ const U8 *p)
1550 PERL_ARGS_ASSERT_IS_UTF8_BLANK;
1551 PERL_UNUSED_CONTEXT;
1553 return isBLANK_utf8(p);
1557 Perl_is_utf8_space(pTHX_ const U8 *p)
1559 PERL_ARGS_ASSERT_IS_UTF8_SPACE;
1560 PERL_UNUSED_CONTEXT;
1562 return isSPACE_utf8(p);
1566 Perl_is_utf8_perl_space(pTHX_ const U8 *p)
1568 PERL_ARGS_ASSERT_IS_UTF8_PERL_SPACE;
1569 PERL_UNUSED_CONTEXT;
1571 /* Only true if is an ASCII space-like character, and ASCII is invariant
1572 * under utf8, so can just use the macro */
1573 return isSPACE_A(*p);
1577 Perl_is_utf8_perl_word(pTHX_ const U8 *p)
1579 PERL_ARGS_ASSERT_IS_UTF8_PERL_WORD;
1580 PERL_UNUSED_CONTEXT;
1582 /* Only true if is an ASCII word character, and ASCII is invariant
1583 * under utf8, so can just use the macro */
1584 return isWORDCHAR_A(*p);
1588 Perl_is_utf8_digit(pTHX_ const U8 *p)
1590 PERL_ARGS_ASSERT_IS_UTF8_DIGIT;
1592 return isDIGIT_utf8(p);
1596 Perl_is_utf8_posix_digit(pTHX_ const U8 *p)
1598 PERL_ARGS_ASSERT_IS_UTF8_POSIX_DIGIT;
1599 PERL_UNUSED_CONTEXT;
1601 /* Only true if is an ASCII digit character, and ASCII is invariant
1602 * under utf8, so can just use the macro */
1603 return isDIGIT_A(*p);
1607 Perl_is_utf8_upper(pTHX_ const U8 *p)
1609 PERL_ARGS_ASSERT_IS_UTF8_UPPER;
1611 return isUPPER_utf8(p);
1615 Perl_is_utf8_lower(pTHX_ const U8 *p)
1617 PERL_ARGS_ASSERT_IS_UTF8_LOWER;
1619 return isLOWER_utf8(p);
1623 Perl_is_utf8_cntrl(pTHX_ const U8 *p)
1625 PERL_ARGS_ASSERT_IS_UTF8_CNTRL;
1626 PERL_UNUSED_CONTEXT;
1628 return isCNTRL_utf8(p);
1632 Perl_is_utf8_graph(pTHX_ const U8 *p)
1634 PERL_ARGS_ASSERT_IS_UTF8_GRAPH;
1636 return isGRAPH_utf8(p);
1640 Perl_is_utf8_print(pTHX_ const U8 *p)
1642 PERL_ARGS_ASSERT_IS_UTF8_PRINT;
1644 return isPRINT_utf8(p);
1648 Perl_is_utf8_punct(pTHX_ const U8 *p)
1650 PERL_ARGS_ASSERT_IS_UTF8_PUNCT;
1652 return isPUNCT_utf8(p);
1656 Perl_is_utf8_xdigit(pTHX_ const U8 *p)
1658 PERL_ARGS_ASSERT_IS_UTF8_XDIGIT;
1659 PERL_UNUSED_CONTEXT;
1661 return isXDIGIT_utf8(p);
1665 Perl_is_utf8_mark(pTHX_ const U8 *p)
1667 PERL_ARGS_ASSERT_IS_UTF8_MARK;
1669 return _is_utf8_mark(p);
1673 =for apidoc is_utf8_char
1675 Tests if some arbitrary number of bytes begins in a valid UTF-8
1676 character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
1677 character is a valid UTF-8 character. The actual number of bytes in the UTF-8
1678 character will be returned if it is valid, otherwise 0.
1680 This function is deprecated due to the possibility that malformed input could
1681 cause reading beyond the end of the input buffer. Use L</isUTF8_CHAR>
1687 Perl_is_utf8_char(const U8 *s)
1689 PERL_ARGS_ASSERT_IS_UTF8_CHAR;
1691 /* Assumes we have enough space, which is why this is deprecated */
1692 return isUTF8_CHAR(s, s + UTF8SKIP(s));
1696 * Like L</utf8_to_uvuni_buf>(), but should only be called when it is known that
1697 * there are no malformations in the input UTF-8 string C<s>. Surrogates,
1698 * non-character code points, and non-Unicode code points are allowed */
1701 Perl_valid_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1703 PERL_ARGS_ASSERT_VALID_UTF8_TO_UVUNI;
1705 return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1709 =for apidoc utf8_to_uvchr
1711 Returns the native code point of the first character in the string C<s>
1712 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1713 length, in bytes, of that character.
1715 Some, but not all, UTF-8 malformations are detected, and in fact, some
1716 malformed input could cause reading beyond the end of the input buffer, which
1717 is why this function is deprecated. Use L</utf8_to_uvchr_buf> instead.
1719 If C<s> points to one of the detected malformations, and UTF8 warnings are
1720 enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
1721 NULL) to -1. If those warnings are off, the computed value if well-defined (or
1722 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1723 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1724 next possible position in C<s> that could begin a non-malformed character.
1725 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1731 Perl_utf8_to_uvchr(pTHX_ const U8 *s, STRLEN *retlen)
1733 PERL_ARGS_ASSERT_UTF8_TO_UVCHR;
1735 return utf8_to_uvchr_buf(s, s + UTF8_MAXBYTES, retlen);
1739 =for apidoc utf8_to_uvuni
1741 Returns the Unicode code point of the first character in the string C<s>
1742 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1743 length, in bytes, of that character.
1745 Some, but not all, UTF-8 malformations are detected, and in fact, some
1746 malformed input could cause reading beyond the end of the input buffer, which
1747 is one reason why this function is deprecated. The other is that only in
1748 extremely limited circumstances should the Unicode versus native code point be
1749 of any interest to you. See L</utf8_to_uvuni_buf> for alternatives.
1751 If C<s> points to one of the detected malformations, and UTF8 warnings are
1752 enabled, zero is returned and C<*retlen> is set (if C<retlen> doesn't point to
1753 NULL) to -1. If those warnings are off, the computed value if well-defined (or
1754 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1755 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1756 next possible position in C<s> that could begin a non-malformed character.
1757 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1763 Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1765 PERL_ARGS_ASSERT_UTF8_TO_UVUNI;
1767 return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1772 #endif /* NO_MATHOMS */
1776 * c-indentation-style: bsd
1778 * indent-tabs-mode: nil
1781 * ex: set ts=8 sts=4 sw=4 et: