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, ...)
558 /* Easier to special case this here than in embed.pl. (Look at what it
559 generates for proto.h) */
560 #ifdef PERL_IMPLICIT_CONTEXT
561 PERL_ARGS_ASSERT_FPRINTF_NOCONTEXT;
564 va_start(arglist, format);
565 ret = PerlIO_vprintf(stream, format, arglist);
571 Perl_printf_nocontext(const char *format, ...)
577 #ifdef PERL_IMPLICIT_CONTEXT
578 PERL_ARGS_ASSERT_PRINTF_NOCONTEXT;
581 va_start(arglist, format);
582 ret = PerlIO_vprintf(PerlIO_stdout(), format, arglist);
587 #if defined(HUGE_VAL) || (defined(USE_LONG_DOUBLE) && defined(HUGE_VALL))
589 * This hack is to force load of "huge" support from libm.a
590 * So it is in perl for (say) POSIX to use.
591 * Needed for SunOS with Sun's 'acc' for example.
596 # if defined(USE_LONG_DOUBLE) && defined(HUGE_VALL)
604 /* compatibility with versions <= 5.003. */
606 Perl_gv_fullname(pTHX_ SV *sv, const GV *gv)
608 PERL_ARGS_ASSERT_GV_FULLNAME;
610 gv_fullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
613 /* compatibility with versions <= 5.003. */
615 Perl_gv_efullname(pTHX_ SV *sv, const GV *gv)
617 PERL_ARGS_ASSERT_GV_EFULLNAME;
619 gv_efullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
623 Perl_gv_fullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
625 PERL_ARGS_ASSERT_GV_FULLNAME3;
627 gv_fullname4(sv, gv, prefix, TRUE);
631 Perl_gv_efullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
633 PERL_ARGS_ASSERT_GV_EFULLNAME3;
635 gv_efullname4(sv, gv, prefix, TRUE);
639 =for apidoc gv_fetchmethod
641 See L</gv_fetchmethod_autoload>.
647 Perl_gv_fetchmethod(pTHX_ HV *stash, const char *name)
649 PERL_ARGS_ASSERT_GV_FETCHMETHOD;
651 return gv_fetchmethod_autoload(stash, name, TRUE);
655 Perl_hv_iternext(pTHX_ HV *hv)
657 PERL_ARGS_ASSERT_HV_ITERNEXT;
659 return hv_iternext_flags(hv, 0);
663 Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how)
665 PERL_ARGS_ASSERT_HV_MAGIC;
667 sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0);
671 Perl_do_open(pTHX_ GV *gv, const char *name, I32 len, int as_raw,
672 int rawmode, int rawperm, PerlIO *supplied_fp)
674 PERL_ARGS_ASSERT_DO_OPEN;
676 return do_openn(gv, name, len, as_raw, rawmode, rawperm,
677 supplied_fp, (SV **) NULL, 0);
681 Perl_do_open9(pTHX_ GV *gv, const char *name, I32 len, int
683 int rawmode, int rawperm, PerlIO *supplied_fp, SV *svs,
686 PERL_ARGS_ASSERT_DO_OPEN9;
688 PERL_UNUSED_ARG(num_svs);
689 return do_openn(gv, name, len, as_raw, rawmode, rawperm,
690 supplied_fp, &svs, 1);
694 Perl_do_binmode(pTHX_ PerlIO *fp, int iotype, int mode)
696 /* The old body of this is now in non-LAYER part of perlio.c
697 * This is a stub for any XS code which might have been calling it.
699 const char *name = ":raw";
701 PERL_ARGS_ASSERT_DO_BINMODE;
703 #ifdef PERLIO_USING_CRLF
704 if (!(mode & O_BINARY))
707 return PerlIO_binmode(aTHX_ fp, iotype, mode, name);
712 Perl_do_aexec(pTHX_ SV *really, SV **mark, SV **sp)
714 PERL_ARGS_ASSERT_DO_AEXEC;
716 return do_aexec5(really, mark, sp, 0, 0);
720 /* Backwards compatibility. */
722 Perl_init_i18nl14n(pTHX_ int printwarn)
724 return init_i18nl10n(printwarn);
728 Perl_is_utf8_string_loc(pTHX_ const U8 *s, STRLEN len, const U8 **ep)
730 PERL_ARGS_ASSERT_IS_UTF8_STRING_LOC;
733 return is_utf8_string_loclen(s, len, ep, 0);
737 =for apidoc sv_nolocking
739 Dummy routine which "locks" an SV when there is no locking module present.
740 Exists to avoid test for a NULL function pointer and because it could
741 potentially warn under some level of strict-ness.
743 "Superseded" by sv_nosharing().
749 Perl_sv_nolocking(pTHX_ SV *sv)
757 =for apidoc sv_nounlocking
759 Dummy routine which "unlocks" an SV when there is no locking module present.
760 Exists to avoid test for a NULL function pointer and because it could
761 potentially warn under some level of strict-ness.
763 "Superseded" by sv_nosharing().
769 Perl_sv_nounlocking(pTHX_ SV *sv)
776 Perl_save_long(pTHX_ long int *longp)
780 PERL_ARGS_ASSERT_SAVE_LONG;
785 SSPUSHUV(SAVEt_LONG);
789 Perl_save_iv(pTHX_ IV *ivp)
793 PERL_ARGS_ASSERT_SAVE_IV;
802 Perl_save_nogv(pTHX_ GV *gv)
806 PERL_ARGS_ASSERT_SAVE_NOGV;
810 SSPUSHUV(SAVEt_NSTAB);
814 Perl_save_list(pTHX_ SV **sarg, I32 maxsarg)
819 PERL_ARGS_ASSERT_SAVE_LIST;
821 for (i = 1; i <= maxsarg; i++) {
825 sv_setsv_nomg(sv,sarg[i]);
827 SSPUSHPTR(sarg[i]); /* remember the pointer */
828 SSPUSHPTR(sv); /* remember the value */
829 SSPUSHUV(SAVEt_ITEM);
834 =for apidoc sv_usepvn_mg
836 Like C<sv_usepvn>, but also handles 'set' magic.
842 Perl_sv_usepvn_mg(pTHX_ SV *sv, char *ptr, STRLEN len)
844 PERL_ARGS_ASSERT_SV_USEPVN_MG;
846 sv_usepvn_flags(sv,ptr,len, SV_SMAGIC);
850 =for apidoc sv_usepvn
852 Tells an SV to use C<ptr> to find its string value. Implemented by
853 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
854 magic. See C<sv_usepvn_flags>.
860 Perl_sv_usepvn(pTHX_ SV *sv, char *ptr, STRLEN len)
862 PERL_ARGS_ASSERT_SV_USEPVN;
864 sv_usepvn_flags(sv,ptr,len, 0);
868 =for apidoc unpack_str
870 The engine implementing unpack() Perl function. Note: parameters strbeg,
871 new_s and ocnt are not used. This call should not be used, use
872 unpackstring instead.
877 Perl_unpack_str(pTHX_ const char *pat, const char *patend, const char *s,
878 const char *strbeg, const char *strend, char **new_s, I32 ocnt,
881 PERL_ARGS_ASSERT_UNPACK_STR;
883 PERL_UNUSED_ARG(strbeg);
884 PERL_UNUSED_ARG(new_s);
885 PERL_UNUSED_ARG(ocnt);
887 return unpackstring(pat, patend, s, strend, flags);
893 The engine implementing pack() Perl function. Note: parameters
894 next_in_list and flags are not used. This call should not be used; use
901 Perl_pack_cat(pTHX_ SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
903 PERL_ARGS_ASSERT_PACK_CAT;
905 PERL_UNUSED_ARG(next_in_list);
906 PERL_UNUSED_ARG(flags);
908 packlist(cat, pat, patend, beglist, endlist);
912 Perl_hv_store_ent(pTHX_ HV *hv, SV *keysv, SV *val, U32 hash)
914 return (HE *)hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISSTORE, val, hash);
918 Perl_hv_exists_ent(pTHX_ HV *hv, SV *keysv, U32 hash)
920 PERL_ARGS_ASSERT_HV_EXISTS_ENT;
922 return hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISEXISTS, 0, hash)
927 Perl_hv_fetch_ent(pTHX_ HV *hv, SV *keysv, I32 lval, U32 hash)
929 PERL_ARGS_ASSERT_HV_FETCH_ENT;
931 return (HE *)hv_common(hv, keysv, NULL, 0, 0,
932 (lval ? HV_FETCH_LVALUE : 0), NULL, hash);
936 Perl_hv_delete_ent(pTHX_ HV *hv, SV *keysv, I32 flags, U32 hash)
938 PERL_ARGS_ASSERT_HV_DELETE_ENT;
940 return MUTABLE_SV(hv_common(hv, keysv, NULL, 0, 0, flags | HV_DELETE, NULL,
945 Perl_hv_store_flags(pTHX_ HV *hv, const char *key, I32 klen, SV *val, U32 hash,
948 return (SV**) hv_common(hv, NULL, key, klen, flags,
949 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
953 Perl_hv_store(pTHX_ HV *hv, const char *key, I32 klen_i32, SV *val, U32 hash)
965 return (SV **) hv_common(hv, NULL, key, klen, flags,
966 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
970 Perl_hv_exists(pTHX_ HV *hv, const char *key, I32 klen_i32)
975 PERL_ARGS_ASSERT_HV_EXISTS;
984 return hv_common(hv, NULL, key, klen, flags, HV_FETCH_ISEXISTS, 0, 0)
989 Perl_hv_fetch(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 lval)
994 PERL_ARGS_ASSERT_HV_FETCH;
1003 return (SV **) hv_common(hv, NULL, key, klen, flags,
1004 lval ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)
1005 : HV_FETCH_JUST_SV, NULL, 0);
1009 Perl_hv_delete(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 flags)
1014 PERL_ARGS_ASSERT_HV_DELETE;
1018 k_flags = HVhek_UTF8;
1023 return MUTABLE_SV(hv_common(hv, NULL, key, klen, k_flags, flags | HV_DELETE,
1027 /* Functions after here were made mathoms post 5.10.0 but pre 5.8.9 */
1032 return MUTABLE_AV(newSV_type(SVt_PVAV));
1033 /* sv_upgrade does AvREAL_only():
1036 AvMAX(av) = AvFILLp(av) = -1; */
1042 HV * const hv = MUTABLE_HV(newSV_type(SVt_PVHV));
1049 Perl_sv_insert(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len,
1050 const char *const little, const STRLEN littlelen)
1052 PERL_ARGS_ASSERT_SV_INSERT;
1053 sv_insert_flags(bigstr, offset, len, little, littlelen, SV_GMAGIC);
1057 Perl_save_freesv(pTHX_ SV *sv)
1064 Perl_save_mortalizesv(pTHX_ SV *sv)
1068 PERL_ARGS_ASSERT_SAVE_MORTALIZESV;
1070 save_mortalizesv(sv);
1074 Perl_save_freeop(pTHX_ OP *o)
1081 Perl_save_freepv(pTHX_ char *pv)
1094 #ifdef PERL_DONT_CREATE_GVSV
1096 Perl_gv_SVadd(pTHX_ GV *gv)
1098 return gv_SVadd(gv);
1103 Perl_gv_AVadd(pTHX_ GV *gv)
1105 return gv_AVadd(gv);
1109 Perl_gv_HVadd(pTHX_ GV *gv)
1111 return gv_HVadd(gv);
1115 Perl_gv_IOadd(pTHX_ GV *gv)
1117 return gv_IOadd(gv);
1123 return MUTABLE_IO(newSV_type(SVt_PVIO));
1129 return my_stat_flags(SV_GMAGIC);
1135 return my_lstat_flags(SV_GMAGIC);
1139 Perl_sv_eq(pTHX_ SV *sv1, SV *sv2)
1141 return sv_eq_flags(sv1, sv2, SV_GMAGIC);
1144 #ifdef USE_LOCALE_COLLATE
1146 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
1148 return sv_collxfrm_flags(sv, nxp, SV_GMAGIC);
1153 Perl_sv_2bool(pTHX_ SV *const sv)
1155 return sv_2bool_flags(sv, SV_GMAGIC);
1160 =for apidoc custom_op_name
1161 Return the name for a given custom op. This was once used by the OP_NAME
1162 macro, but is no longer: it has only been kept for compatibility, and
1165 =for apidoc custom_op_desc
1166 Return the description of a given custom op. This was once used by the
1167 OP_DESC macro, but is no longer: it has only been kept for
1168 compatibility, and should not be used.
1174 Perl_custom_op_name(pTHX_ const OP* o)
1176 PERL_ARGS_ASSERT_CUSTOM_OP_NAME;
1177 return XopENTRYCUSTOM(o, xop_name);
1181 Perl_custom_op_desc(pTHX_ const OP* o)
1183 PERL_ARGS_ASSERT_CUSTOM_OP_DESC;
1184 return XopENTRYCUSTOM(o, xop_desc);
1188 Perl_newSUB(pTHX_ I32 floor, OP *o, OP *proto, OP *block)
1190 return newATTRSUB(floor, o, proto, NULL, block);
1194 Perl_to_utf8_fold(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1196 PERL_ARGS_ASSERT_TO_UTF8_FOLD;
1198 return _to_utf8_fold_flags(p, ustrp, lenp, FOLD_FLAGS_FULL);
1202 Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1204 PERL_ARGS_ASSERT_TO_UTF8_LOWER;
1206 return _to_utf8_lower_flags(p, ustrp, lenp, FALSE);
1210 Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1212 PERL_ARGS_ASSERT_TO_UTF8_TITLE;
1214 return _to_utf8_title_flags(p, ustrp, lenp, FALSE);
1218 Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1220 PERL_ARGS_ASSERT_TO_UTF8_UPPER;
1222 return _to_utf8_upper_flags(p, ustrp, lenp, FALSE);
1226 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
1228 return Perl_sv_mortalcopy_flags(aTHX_ oldstr, SV_GMAGIC);
1231 UV /* Made into a function, so can be deprecated */
1232 NATIVE_TO_NEED(const UV enc, const UV ch)
1234 PERL_UNUSED_ARG(enc);
1238 UV /* Made into a function, so can be deprecated */
1239 ASCII_TO_NEED(const UV enc, const UV ch)
1241 PERL_UNUSED_ARG(enc);
1245 bool /* Made into a function, so can be deprecated */
1246 Perl_isIDFIRST_lazy(pTHX_ const char* p)
1248 PERL_ARGS_ASSERT_ISIDFIRST_LAZY;
1250 return isIDFIRST_lazy_if(p,1);
1253 bool /* Made into a function, so can be deprecated */
1254 Perl_isALNUM_lazy(pTHX_ const char* p)
1256 PERL_ARGS_ASSERT_ISALNUM_LAZY;
1258 return isALNUM_lazy_if(p,1);
1262 Perl_is_uni_alnum(pTHX_ UV c)
1264 return isWORDCHAR_uni(c);
1268 Perl_is_uni_alnumc(pTHX_ UV c)
1270 return isALNUM_uni(c);
1274 Perl_is_uni_alpha(pTHX_ UV c)
1276 return isALPHA_uni(c);
1280 Perl_is_uni_ascii(pTHX_ UV c)
1282 PERL_UNUSED_CONTEXT;
1283 return isASCII_uni(c);
1287 Perl_is_uni_blank(pTHX_ UV c)
1289 PERL_UNUSED_CONTEXT;
1290 return isBLANK_uni(c);
1294 Perl_is_uni_space(pTHX_ UV c)
1296 PERL_UNUSED_CONTEXT;
1297 return isSPACE_uni(c);
1301 Perl_is_uni_digit(pTHX_ UV c)
1303 PERL_UNUSED_CONTEXT;
1304 return isDIGIT_uni(c);
1308 Perl_is_uni_upper(pTHX_ UV c)
1310 PERL_UNUSED_CONTEXT;
1311 return isUPPER_uni(c);
1315 Perl_is_uni_lower(pTHX_ UV c)
1317 PERL_UNUSED_CONTEXT;
1318 return isLOWER_uni(c);
1322 Perl_is_uni_cntrl(pTHX_ UV c)
1324 PERL_UNUSED_CONTEXT;
1325 return isCNTRL_L1(c);
1329 Perl_is_uni_graph(pTHX_ UV c)
1331 PERL_UNUSED_CONTEXT;
1332 return isGRAPH_uni(c);
1336 Perl_is_uni_print(pTHX_ UV c)
1338 PERL_UNUSED_CONTEXT;
1339 return isPRINT_uni(c);
1343 Perl_is_uni_punct(pTHX_ UV c)
1345 PERL_UNUSED_CONTEXT;
1346 return isPUNCT_uni(c);
1350 Perl_is_uni_xdigit(pTHX_ UV c)
1352 PERL_UNUSED_CONTEXT;
1353 return isXDIGIT_uni(c);
1357 Perl_is_uni_alnum_lc(pTHX_ UV c)
1359 PERL_UNUSED_CONTEXT;
1360 return isWORDCHAR_LC_uvchr(c);
1364 Perl_is_uni_alnumc_lc(pTHX_ UV c)
1366 PERL_UNUSED_CONTEXT;
1367 return isALPHANUMERIC_LC_uvchr(c);
1371 Perl_is_uni_idfirst_lc(pTHX_ UV c)
1373 PERL_UNUSED_CONTEXT;
1374 /* XXX Should probably be something that resolves to the old IDFIRST, but
1375 * this function is deprecated, so not bothering */
1376 return isIDFIRST_LC_uvchr(c);
1380 Perl_is_uni_alpha_lc(pTHX_ UV c)
1382 PERL_UNUSED_CONTEXT;
1383 return isALPHA_LC_uvchr(c);
1387 Perl_is_uni_ascii_lc(pTHX_ UV c)
1389 PERL_UNUSED_CONTEXT;
1390 return isASCII_LC_uvchr(c);
1394 Perl_is_uni_blank_lc(pTHX_ UV c)
1396 PERL_UNUSED_CONTEXT;
1397 return isBLANK_LC_uvchr(c);
1401 Perl_is_uni_space_lc(pTHX_ UV c)
1403 PERL_UNUSED_CONTEXT;
1404 return isSPACE_LC_uvchr(c);
1408 Perl_is_uni_digit_lc(pTHX_ UV c)
1410 return isDIGIT_LC_uvchr(c);
1414 Perl_is_uni_idfirst(pTHX_ UV c)
1416 U8 tmpbuf[UTF8_MAXBYTES+1];
1417 uvchr_to_utf8(tmpbuf, c);
1418 return _is_utf8_idstart(tmpbuf);
1422 Perl_is_utf8_idfirst(pTHX_ const U8 *p) /* The naming is historical. */
1426 PERL_ARGS_ASSERT_IS_UTF8_IDFIRST;
1428 return _is_utf8_idstart(p);
1432 Perl_is_utf8_xidfirst(pTHX_ const U8 *p) /* The naming is historical. */
1436 PERL_ARGS_ASSERT_IS_UTF8_XIDFIRST;
1438 return _is_utf8_xidstart(p);
1442 Perl_is_utf8_idcont(pTHX_ const U8 *p)
1446 PERL_ARGS_ASSERT_IS_UTF8_IDCONT;
1448 return _is_utf8_idcont(p);
1452 Perl_is_utf8_xidcont(pTHX_ const U8 *p)
1456 PERL_ARGS_ASSERT_IS_UTF8_XIDCONT;
1458 return _is_utf8_xidcont(p);
1462 Perl_is_uni_upper_lc(pTHX_ UV c)
1464 return isUPPER_LC_uvchr(c);
1468 Perl_is_uni_lower_lc(pTHX_ UV c)
1470 return isLOWER_LC_uvchr(c);
1474 Perl_is_uni_cntrl_lc(pTHX_ UV c)
1476 return isCNTRL_LC_uvchr(c);
1480 Perl_is_uni_graph_lc(pTHX_ UV c)
1482 return isGRAPH_LC_uvchr(c);
1486 Perl_is_uni_print_lc(pTHX_ UV c)
1488 return isPRINT_LC_uvchr(c);
1492 Perl_is_uni_punct_lc(pTHX_ UV c)
1494 return isPUNCT_LC_uvchr(c);
1498 Perl_is_uni_xdigit_lc(pTHX_ UV c)
1500 return isXDIGIT_LC_uvchr(c);
1504 Perl_to_uni_upper_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_upper(c, tmpbuf, &len);
1514 Perl_to_uni_title_lc(pTHX_ U32 c)
1516 /* XXX returns only the first character XXX -- do not use XXX */
1517 /* XXX no locale support yet */
1519 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1520 return (U32)to_uni_title(c, tmpbuf, &len);
1524 Perl_to_uni_lower_lc(pTHX_ U32 c)
1526 /* XXX returns only the first character -- do not use XXX */
1527 /* XXX no locale support yet */
1529 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1530 return (U32)to_uni_lower(c, tmpbuf, &len);
1534 Perl_is_utf8_alnum(pTHX_ const U8 *p)
1538 PERL_ARGS_ASSERT_IS_UTF8_ALNUM;
1540 /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
1541 * descendant of isalnum(3), in other words, it doesn't
1542 * contain the '_'. --jhi */
1543 return isWORDCHAR_utf8(p);
1547 Perl_is_utf8_alnumc(pTHX_ const U8 *p)
1551 PERL_ARGS_ASSERT_IS_UTF8_ALNUMC;
1553 return isALPHANUMERIC_utf8(p);
1557 Perl_is_utf8_alpha(pTHX_ const U8 *p)
1561 PERL_ARGS_ASSERT_IS_UTF8_ALPHA;
1563 return isALPHA_utf8(p);
1567 Perl_is_utf8_ascii(pTHX_ const U8 *p)
1571 PERL_ARGS_ASSERT_IS_UTF8_ASCII;
1572 PERL_UNUSED_CONTEXT;
1574 return isASCII_utf8(p);
1578 Perl_is_utf8_blank(pTHX_ const U8 *p)
1582 PERL_ARGS_ASSERT_IS_UTF8_BLANK;
1583 PERL_UNUSED_CONTEXT;
1585 return isBLANK_utf8(p);
1589 Perl_is_utf8_space(pTHX_ const U8 *p)
1593 PERL_ARGS_ASSERT_IS_UTF8_SPACE;
1594 PERL_UNUSED_CONTEXT;
1596 return isSPACE_utf8(p);
1600 Perl_is_utf8_perl_space(pTHX_ const U8 *p)
1604 PERL_ARGS_ASSERT_IS_UTF8_PERL_SPACE;
1605 PERL_UNUSED_CONTEXT;
1607 /* Only true if is an ASCII space-like character, and ASCII is invariant
1608 * under utf8, so can just use the macro */
1609 return isSPACE_A(*p);
1613 Perl_is_utf8_perl_word(pTHX_ const U8 *p)
1617 PERL_ARGS_ASSERT_IS_UTF8_PERL_WORD;
1618 PERL_UNUSED_CONTEXT;
1620 /* Only true if is an ASCII word character, and ASCII is invariant
1621 * under utf8, so can just use the macro */
1622 return isWORDCHAR_A(*p);
1626 Perl_is_utf8_digit(pTHX_ const U8 *p)
1630 PERL_ARGS_ASSERT_IS_UTF8_DIGIT;
1632 return isDIGIT_utf8(p);
1636 Perl_is_utf8_posix_digit(pTHX_ const U8 *p)
1640 PERL_ARGS_ASSERT_IS_UTF8_POSIX_DIGIT;
1641 PERL_UNUSED_CONTEXT;
1643 /* Only true if is an ASCII digit character, and ASCII is invariant
1644 * under utf8, so can just use the macro */
1645 return isDIGIT_A(*p);
1649 Perl_is_utf8_upper(pTHX_ const U8 *p)
1653 PERL_ARGS_ASSERT_IS_UTF8_UPPER;
1655 return isUPPER_utf8(p);
1659 Perl_is_utf8_lower(pTHX_ const U8 *p)
1663 PERL_ARGS_ASSERT_IS_UTF8_LOWER;
1665 return isLOWER_utf8(p);
1669 Perl_is_utf8_cntrl(pTHX_ const U8 *p)
1673 PERL_ARGS_ASSERT_IS_UTF8_CNTRL;
1674 PERL_UNUSED_CONTEXT;
1676 return isCNTRL_utf8(p);
1680 Perl_is_utf8_graph(pTHX_ const U8 *p)
1684 PERL_ARGS_ASSERT_IS_UTF8_GRAPH;
1686 return isGRAPH_utf8(p);
1690 Perl_is_utf8_print(pTHX_ const U8 *p)
1694 PERL_ARGS_ASSERT_IS_UTF8_PRINT;
1696 return isPRINT_utf8(p);
1700 Perl_is_utf8_punct(pTHX_ const U8 *p)
1704 PERL_ARGS_ASSERT_IS_UTF8_PUNCT;
1706 return isPUNCT_utf8(p);
1710 Perl_is_utf8_xdigit(pTHX_ const U8 *p)
1714 PERL_ARGS_ASSERT_IS_UTF8_XDIGIT;
1715 PERL_UNUSED_CONTEXT;
1717 return isXDIGIT_utf8(p);
1721 Perl_is_utf8_mark(pTHX_ const U8 *p)
1725 PERL_ARGS_ASSERT_IS_UTF8_MARK;
1727 return _is_utf8_mark(p);
1731 =for apidoc is_utf8_char
1733 Tests if some arbitrary number of bytes begins in a valid UTF-8
1734 character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
1735 character is a valid UTF-8 character. The actual number of bytes in the UTF-8
1736 character will be returned if it is valid, otherwise 0.
1738 This function is deprecated due to the possibility that malformed input could
1739 cause reading beyond the end of the input buffer. Use L</isUTF8_CHAR>
1745 Perl_is_utf8_char(const U8 *s)
1747 PERL_ARGS_ASSERT_IS_UTF8_CHAR;
1749 /* Assumes we have enough space, which is why this is deprecated */
1750 return isUTF8_CHAR(s, s + UTF8SKIP(s));
1754 * Like L</utf8_to_uvuni_buf>(), but should only be called when it is known that
1755 * there are no malformations in the input UTF-8 string C<s>. Surrogates,
1756 * non-character code points, and non-Unicode code points are allowed */
1759 Perl_valid_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1761 PERL_ARGS_ASSERT_VALID_UTF8_TO_UVUNI;
1763 return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1767 =for apidoc utf8_to_uvchr
1769 Returns the native code point of the first character in the string C<s>
1770 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1771 length, in bytes, of that character.
1773 Some, but not all, UTF-8 malformations are detected, and in fact, some
1774 malformed input could cause reading beyond the end of the input buffer, which
1775 is why this function is deprecated. Use L</utf8_to_uvchr_buf> instead.
1777 If C<s> points to one of the detected malformations, and UTF8 warnings are
1778 enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
1779 NULL) to -1. If those warnings are off, the computed value if well-defined (or
1780 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1781 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1782 next possible position in C<s> that could begin a non-malformed character.
1783 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1789 Perl_utf8_to_uvchr(pTHX_ const U8 *s, STRLEN *retlen)
1791 PERL_ARGS_ASSERT_UTF8_TO_UVCHR;
1793 return utf8_to_uvchr_buf(s, s + UTF8_MAXBYTES, retlen);
1797 =for apidoc utf8_to_uvuni
1799 Returns the Unicode code point of the first character in the string C<s>
1800 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1801 length, in bytes, of that character.
1803 Some, but not all, UTF-8 malformations are detected, and in fact, some
1804 malformed input could cause reading beyond the end of the input buffer, which
1805 is one reason why this function is deprecated. The other is that only in
1806 extremely limited circumstances should the Unicode versus native code point be
1807 of any interest to you. See L</utf8_to_uvuni_buf> for alternatives.
1809 If C<s> points to one of the detected malformations, and UTF8 warnings are
1810 enabled, zero is returned and C<*retlen> is set (if C<retlen> doesn't point to
1811 NULL) to -1. If those warnings are off, the computed value if well-defined (or
1812 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1813 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1814 next possible position in C<s> that could begin a non-malformed character.
1815 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1821 Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1823 PERL_ARGS_ASSERT_UTF8_TO_UVUNI;
1825 return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1830 #endif /* NO_MATHOMS */
1834 * c-indentation-style: bsd
1836 * indent-tabs-mode: nil
1839 * ex: set ts=8 sts=4 sw=4 et: