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;
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)
779 PERL_ARGS_ASSERT_SAVE_LONG;
784 SSPUSHUV(SAVEt_LONG);
788 Perl_save_iv(pTHX_ IV *ivp)
792 PERL_ARGS_ASSERT_SAVE_IV;
801 Perl_save_nogv(pTHX_ GV *gv)
805 PERL_ARGS_ASSERT_SAVE_NOGV;
809 SSPUSHUV(SAVEt_NSTAB);
813 Perl_save_list(pTHX_ SV **sarg, I32 maxsarg)
818 PERL_ARGS_ASSERT_SAVE_LIST;
820 for (i = 1; i <= maxsarg; i++) {
824 sv_setsv_nomg(sv,sarg[i]);
826 SSPUSHPTR(sarg[i]); /* remember the pointer */
827 SSPUSHPTR(sv); /* remember the value */
828 SSPUSHUV(SAVEt_ITEM);
833 =for apidoc sv_usepvn_mg
835 Like C<sv_usepvn>, but also handles 'set' magic.
841 Perl_sv_usepvn_mg(pTHX_ SV *sv, char *ptr, STRLEN len)
843 PERL_ARGS_ASSERT_SV_USEPVN_MG;
845 sv_usepvn_flags(sv,ptr,len, SV_SMAGIC);
849 =for apidoc sv_usepvn
851 Tells an SV to use C<ptr> to find its string value. Implemented by
852 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
853 magic. See C<sv_usepvn_flags>.
859 Perl_sv_usepvn(pTHX_ SV *sv, char *ptr, STRLEN len)
861 PERL_ARGS_ASSERT_SV_USEPVN;
863 sv_usepvn_flags(sv,ptr,len, 0);
867 =for apidoc unpack_str
869 The engine implementing unpack() Perl function. Note: parameters strbeg,
870 new_s and ocnt are not used. This call should not be used, use
871 unpackstring instead.
876 Perl_unpack_str(pTHX_ const char *pat, const char *patend, const char *s,
877 const char *strbeg, const char *strend, char **new_s, I32 ocnt,
880 PERL_ARGS_ASSERT_UNPACK_STR;
882 PERL_UNUSED_ARG(strbeg);
883 PERL_UNUSED_ARG(new_s);
884 PERL_UNUSED_ARG(ocnt);
886 return unpackstring(pat, patend, s, strend, flags);
892 The engine implementing pack() Perl function. Note: parameters
893 next_in_list and flags are not used. This call should not be used; use
900 Perl_pack_cat(pTHX_ SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
902 PERL_ARGS_ASSERT_PACK_CAT;
904 PERL_UNUSED_ARG(next_in_list);
905 PERL_UNUSED_ARG(flags);
907 packlist(cat, pat, patend, beglist, endlist);
911 Perl_hv_store_ent(pTHX_ HV *hv, SV *keysv, SV *val, U32 hash)
913 return (HE *)hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISSTORE, val, hash);
917 Perl_hv_exists_ent(pTHX_ HV *hv, SV *keysv, U32 hash)
919 PERL_ARGS_ASSERT_HV_EXISTS_ENT;
921 return hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISEXISTS, 0, hash)
926 Perl_hv_fetch_ent(pTHX_ HV *hv, SV *keysv, I32 lval, U32 hash)
928 PERL_ARGS_ASSERT_HV_FETCH_ENT;
930 return (HE *)hv_common(hv, keysv, NULL, 0, 0,
931 (lval ? HV_FETCH_LVALUE : 0), NULL, hash);
935 Perl_hv_delete_ent(pTHX_ HV *hv, SV *keysv, I32 flags, U32 hash)
937 PERL_ARGS_ASSERT_HV_DELETE_ENT;
939 return MUTABLE_SV(hv_common(hv, keysv, NULL, 0, 0, flags | HV_DELETE, NULL,
944 Perl_hv_store_flags(pTHX_ HV *hv, const char *key, I32 klen, SV *val, U32 hash,
947 return (SV**) hv_common(hv, NULL, key, klen, flags,
948 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
952 Perl_hv_store(pTHX_ HV *hv, const char *key, I32 klen_i32, SV *val, U32 hash)
964 return (SV **) hv_common(hv, NULL, key, klen, flags,
965 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
969 Perl_hv_exists(pTHX_ HV *hv, const char *key, I32 klen_i32)
974 PERL_ARGS_ASSERT_HV_EXISTS;
983 return hv_common(hv, NULL, key, klen, flags, HV_FETCH_ISEXISTS, 0, 0)
988 Perl_hv_fetch(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 lval)
993 PERL_ARGS_ASSERT_HV_FETCH;
1002 return (SV **) hv_common(hv, NULL, key, klen, flags,
1003 lval ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)
1004 : HV_FETCH_JUST_SV, NULL, 0);
1008 Perl_hv_delete(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 flags)
1013 PERL_ARGS_ASSERT_HV_DELETE;
1017 k_flags = HVhek_UTF8;
1022 return MUTABLE_SV(hv_common(hv, NULL, key, klen, k_flags, flags | HV_DELETE,
1026 /* Functions after here were made mathoms post 5.10.0 but pre 5.8.9 */
1031 return MUTABLE_AV(newSV_type(SVt_PVAV));
1032 /* sv_upgrade does AvREAL_only():
1035 AvMAX(av) = AvFILLp(av) = -1; */
1041 HV * const hv = MUTABLE_HV(newSV_type(SVt_PVHV));
1048 Perl_sv_insert(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len,
1049 const char *const little, const STRLEN littlelen)
1051 PERL_ARGS_ASSERT_SV_INSERT;
1052 sv_insert_flags(bigstr, offset, len, little, littlelen, SV_GMAGIC);
1056 Perl_save_freesv(pTHX_ SV *sv)
1063 Perl_save_mortalizesv(pTHX_ SV *sv)
1067 PERL_ARGS_ASSERT_SAVE_MORTALIZESV;
1069 save_mortalizesv(sv);
1073 Perl_save_freeop(pTHX_ OP *o)
1080 Perl_save_freepv(pTHX_ char *pv)
1093 #ifdef PERL_DONT_CREATE_GVSV
1095 Perl_gv_SVadd(pTHX_ GV *gv)
1097 return gv_SVadd(gv);
1102 Perl_gv_AVadd(pTHX_ GV *gv)
1104 return gv_AVadd(gv);
1108 Perl_gv_HVadd(pTHX_ GV *gv)
1110 return gv_HVadd(gv);
1114 Perl_gv_IOadd(pTHX_ GV *gv)
1116 return gv_IOadd(gv);
1122 return MUTABLE_IO(newSV_type(SVt_PVIO));
1128 return my_stat_flags(SV_GMAGIC);
1134 return my_lstat_flags(SV_GMAGIC);
1138 Perl_sv_eq(pTHX_ SV *sv1, SV *sv2)
1140 return sv_eq_flags(sv1, sv2, SV_GMAGIC);
1143 #ifdef USE_LOCALE_COLLATE
1145 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
1147 return sv_collxfrm_flags(sv, nxp, SV_GMAGIC);
1152 Perl_sv_2bool(pTHX_ SV *const sv)
1154 return sv_2bool_flags(sv, SV_GMAGIC);
1159 =for apidoc custom_op_name
1160 Return the name for a given custom op. This was once used by the OP_NAME
1161 macro, but is no longer: it has only been kept for compatibility, and
1164 =for apidoc custom_op_desc
1165 Return the description of a given custom op. This was once used by the
1166 OP_DESC macro, but is no longer: it has only been kept for
1167 compatibility, and should not be used.
1173 Perl_custom_op_name(pTHX_ const OP* o)
1175 PERL_ARGS_ASSERT_CUSTOM_OP_NAME;
1176 return XopENTRYCUSTOM(o, xop_name);
1180 Perl_custom_op_desc(pTHX_ const OP* o)
1182 PERL_ARGS_ASSERT_CUSTOM_OP_DESC;
1183 return XopENTRYCUSTOM(o, xop_desc);
1187 Perl_newSUB(pTHX_ I32 floor, OP *o, OP *proto, OP *block)
1189 return newATTRSUB(floor, o, proto, NULL, block);
1193 Perl_to_utf8_fold(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1195 PERL_ARGS_ASSERT_TO_UTF8_FOLD;
1197 return _to_utf8_fold_flags(p, ustrp, lenp, FOLD_FLAGS_FULL);
1201 Perl_to_utf8_lower(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1203 PERL_ARGS_ASSERT_TO_UTF8_LOWER;
1205 return _to_utf8_lower_flags(p, ustrp, lenp, FALSE);
1209 Perl_to_utf8_title(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1211 PERL_ARGS_ASSERT_TO_UTF8_TITLE;
1213 return _to_utf8_title_flags(p, ustrp, lenp, FALSE);
1217 Perl_to_utf8_upper(pTHX_ const U8 *p, U8* ustrp, STRLEN *lenp)
1219 PERL_ARGS_ASSERT_TO_UTF8_UPPER;
1221 return _to_utf8_upper_flags(p, ustrp, lenp, FALSE);
1225 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
1227 return Perl_sv_mortalcopy_flags(aTHX_ oldstr, SV_GMAGIC);
1230 UV /* Made into a function, so can be deprecated */
1231 NATIVE_TO_NEED(const UV enc, const UV ch)
1233 PERL_UNUSED_ARG(enc);
1237 UV /* Made into a function, so can be deprecated */
1238 ASCII_TO_NEED(const UV enc, const UV ch)
1240 PERL_UNUSED_ARG(enc);
1244 bool /* Made into a function, so can be deprecated */
1245 Perl_isIDFIRST_lazy(pTHX_ const char* p)
1247 PERL_ARGS_ASSERT_ISIDFIRST_LAZY;
1249 return isIDFIRST_lazy_if(p,1);
1252 bool /* Made into a function, so can be deprecated */
1253 Perl_isALNUM_lazy(pTHX_ const char* p)
1255 PERL_ARGS_ASSERT_ISALNUM_LAZY;
1257 return isALNUM_lazy_if(p,1);
1261 Perl_is_uni_alnum(pTHX_ UV c)
1263 return isWORDCHAR_uni(c);
1267 Perl_is_uni_alnumc(pTHX_ UV c)
1269 return isALNUM_uni(c);
1273 Perl_is_uni_alpha(pTHX_ UV c)
1275 return isALPHA_uni(c);
1279 Perl_is_uni_ascii(pTHX_ UV c)
1281 return isASCII_uni(c);
1285 Perl_is_uni_blank(pTHX_ UV c)
1287 return isBLANK_uni(c);
1291 Perl_is_uni_space(pTHX_ UV c)
1293 return isSPACE_uni(c);
1297 Perl_is_uni_digit(pTHX_ UV c)
1299 return isDIGIT_uni(c);
1303 Perl_is_uni_upper(pTHX_ UV c)
1305 return isUPPER_uni(c);
1309 Perl_is_uni_lower(pTHX_ UV c)
1311 return isLOWER_uni(c);
1315 Perl_is_uni_cntrl(pTHX_ UV c)
1317 return isCNTRL_L1(c);
1321 Perl_is_uni_graph(pTHX_ UV c)
1323 return isGRAPH_uni(c);
1327 Perl_is_uni_print(pTHX_ UV c)
1329 return isPRINT_uni(c);
1333 Perl_is_uni_punct(pTHX_ UV c)
1335 return isPUNCT_uni(c);
1339 Perl_is_uni_xdigit(pTHX_ UV c)
1341 return isXDIGIT_uni(c);
1345 Perl_is_uni_alnum_lc(pTHX_ UV c)
1347 return isWORDCHAR_LC_uvchr(c);
1351 Perl_is_uni_alnumc_lc(pTHX_ UV c)
1353 return isALPHANUMERIC_LC_uvchr(c);
1357 Perl_is_uni_idfirst_lc(pTHX_ UV c)
1359 /* XXX Should probably be something that resolves to the old IDFIRST, but
1360 * this function is deprecated, so not bothering */
1361 return isIDFIRST_LC_uvchr(c);
1365 Perl_is_uni_alpha_lc(pTHX_ UV c)
1367 return isALPHA_LC_uvchr(c);
1371 Perl_is_uni_ascii_lc(pTHX_ UV c)
1373 return isASCII_LC_uvchr(c);
1377 Perl_is_uni_blank_lc(pTHX_ UV c)
1379 return isBLANK_LC_uvchr(c);
1383 Perl_is_uni_space_lc(pTHX_ UV c)
1385 return isSPACE_LC_uvchr(c);
1389 Perl_is_uni_digit_lc(pTHX_ UV c)
1391 return isDIGIT_LC_uvchr(c);
1395 Perl_is_uni_idfirst(pTHX_ UV c)
1397 U8 tmpbuf[UTF8_MAXBYTES+1];
1398 uvchr_to_utf8(tmpbuf, c);
1399 return _is_utf8_idstart(tmpbuf);
1403 Perl_is_utf8_idfirst(pTHX_ const U8 *p) /* The naming is historical. */
1407 PERL_ARGS_ASSERT_IS_UTF8_IDFIRST;
1409 return _is_utf8_idstart(p);
1413 Perl_is_utf8_xidfirst(pTHX_ const U8 *p) /* The naming is historical. */
1417 PERL_ARGS_ASSERT_IS_UTF8_XIDFIRST;
1419 return _is_utf8_xidstart(p);
1423 Perl_is_utf8_idcont(pTHX_ const U8 *p)
1427 PERL_ARGS_ASSERT_IS_UTF8_IDCONT;
1429 return _is_utf8_idcont(p);
1433 Perl_is_utf8_xidcont(pTHX_ const U8 *p)
1437 PERL_ARGS_ASSERT_IS_UTF8_XIDCONT;
1439 return _is_utf8_xidcont(p);
1443 Perl_is_uni_upper_lc(pTHX_ UV c)
1445 return isUPPER_LC_uvchr(c);
1449 Perl_is_uni_lower_lc(pTHX_ UV c)
1451 return isLOWER_LC_uvchr(c);
1455 Perl_is_uni_cntrl_lc(pTHX_ UV c)
1457 return isCNTRL_LC_uvchr(c);
1461 Perl_is_uni_graph_lc(pTHX_ UV c)
1463 return isGRAPH_LC_uvchr(c);
1467 Perl_is_uni_print_lc(pTHX_ UV c)
1469 return isPRINT_LC_uvchr(c);
1473 Perl_is_uni_punct_lc(pTHX_ UV c)
1475 return isPUNCT_LC_uvchr(c);
1479 Perl_is_uni_xdigit_lc(pTHX_ UV c)
1481 return isXDIGIT_LC_uvchr(c);
1485 Perl_to_uni_upper_lc(pTHX_ U32 c)
1487 /* XXX returns only the first character -- do not use XXX */
1488 /* XXX no locale support yet */
1490 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1491 return (U32)to_uni_upper(c, tmpbuf, &len);
1495 Perl_to_uni_title_lc(pTHX_ U32 c)
1497 /* XXX returns only the first character XXX -- do not use XXX */
1498 /* XXX no locale support yet */
1500 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1501 return (U32)to_uni_title(c, tmpbuf, &len);
1505 Perl_to_uni_lower_lc(pTHX_ U32 c)
1507 /* XXX returns only the first character -- do not use XXX */
1508 /* XXX no locale support yet */
1510 U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
1511 return (U32)to_uni_lower(c, tmpbuf, &len);
1515 Perl_is_utf8_alnum(pTHX_ const U8 *p)
1519 PERL_ARGS_ASSERT_IS_UTF8_ALNUM;
1521 /* NOTE: "IsWord", not "IsAlnum", since Alnum is a true
1522 * descendant of isalnum(3), in other words, it doesn't
1523 * contain the '_'. --jhi */
1524 return isWORDCHAR_utf8(p);
1528 Perl_is_utf8_alnumc(pTHX_ const U8 *p)
1532 PERL_ARGS_ASSERT_IS_UTF8_ALNUMC;
1534 return isALPHANUMERIC_utf8(p);
1538 Perl_is_utf8_alpha(pTHX_ const U8 *p)
1542 PERL_ARGS_ASSERT_IS_UTF8_ALPHA;
1544 return isALPHA_utf8(p);
1548 Perl_is_utf8_ascii(pTHX_ const U8 *p)
1552 PERL_ARGS_ASSERT_IS_UTF8_ASCII;
1554 return isASCII_utf8(p);
1558 Perl_is_utf8_blank(pTHX_ const U8 *p)
1562 PERL_ARGS_ASSERT_IS_UTF8_BLANK;
1564 return isBLANK_utf8(p);
1568 Perl_is_utf8_space(pTHX_ const U8 *p)
1572 PERL_ARGS_ASSERT_IS_UTF8_SPACE;
1574 return isSPACE_utf8(p);
1578 Perl_is_utf8_perl_space(pTHX_ const U8 *p)
1582 PERL_ARGS_ASSERT_IS_UTF8_PERL_SPACE;
1584 /* Only true if is an ASCII space-like character, and ASCII is invariant
1585 * under utf8, so can just use the macro */
1586 return isSPACE_A(*p);
1590 Perl_is_utf8_perl_word(pTHX_ const U8 *p)
1594 PERL_ARGS_ASSERT_IS_UTF8_PERL_WORD;
1596 /* Only true if is an ASCII word character, and ASCII is invariant
1597 * under utf8, so can just use the macro */
1598 return isWORDCHAR_A(*p);
1602 Perl_is_utf8_digit(pTHX_ const U8 *p)
1606 PERL_ARGS_ASSERT_IS_UTF8_DIGIT;
1608 return isDIGIT_utf8(p);
1612 Perl_is_utf8_posix_digit(pTHX_ const U8 *p)
1616 PERL_ARGS_ASSERT_IS_UTF8_POSIX_DIGIT;
1618 /* Only true if is an ASCII digit character, and ASCII is invariant
1619 * under utf8, so can just use the macro */
1620 return isDIGIT_A(*p);
1624 Perl_is_utf8_upper(pTHX_ const U8 *p)
1628 PERL_ARGS_ASSERT_IS_UTF8_UPPER;
1630 return isUPPER_utf8(p);
1634 Perl_is_utf8_lower(pTHX_ const U8 *p)
1638 PERL_ARGS_ASSERT_IS_UTF8_LOWER;
1640 return isLOWER_utf8(p);
1644 Perl_is_utf8_cntrl(pTHX_ const U8 *p)
1648 PERL_ARGS_ASSERT_IS_UTF8_CNTRL;
1650 return isCNTRL_utf8(p);
1654 Perl_is_utf8_graph(pTHX_ const U8 *p)
1658 PERL_ARGS_ASSERT_IS_UTF8_GRAPH;
1660 return isGRAPH_utf8(p);
1664 Perl_is_utf8_print(pTHX_ const U8 *p)
1668 PERL_ARGS_ASSERT_IS_UTF8_PRINT;
1670 return isPRINT_utf8(p);
1674 Perl_is_utf8_punct(pTHX_ const U8 *p)
1678 PERL_ARGS_ASSERT_IS_UTF8_PUNCT;
1680 return isPUNCT_utf8(p);
1684 Perl_is_utf8_xdigit(pTHX_ const U8 *p)
1688 PERL_ARGS_ASSERT_IS_UTF8_XDIGIT;
1690 return isXDIGIT_utf8(p);
1694 Perl_is_utf8_mark(pTHX_ const U8 *p)
1698 PERL_ARGS_ASSERT_IS_UTF8_MARK;
1700 return _is_utf8_mark(p);
1704 =for apidoc is_utf8_char
1706 Tests if some arbitrary number of bytes begins in a valid UTF-8
1707 character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
1708 character is a valid UTF-8 character. The actual number of bytes in the UTF-8
1709 character will be returned if it is valid, otherwise 0.
1711 This function is deprecated due to the possibility that malformed input could
1712 cause reading beyond the end of the input buffer. Use L</isUTF8_CHAR>
1718 Perl_is_utf8_char(const U8 *s)
1720 PERL_ARGS_ASSERT_IS_UTF8_CHAR;
1722 /* Assumes we have enough space, which is why this is deprecated */
1723 return isUTF8_CHAR(s, s + UTF8SKIP(s));
1727 * Like L</utf8_to_uvuni_buf>(), but should only be called when it is known that
1728 * there are no malformations in the input UTF-8 string C<s>. Surrogates,
1729 * non-character code points, and non-Unicode code points are allowed */
1732 Perl_valid_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1734 PERL_ARGS_ASSERT_VALID_UTF8_TO_UVUNI;
1736 return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1740 =for apidoc utf8_to_uvchr
1742 Returns the native code point of the first character in the string C<s>
1743 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1744 length, in bytes, of that character.
1746 Some, but not all, UTF-8 malformations are detected, and in fact, some
1747 malformed input could cause reading beyond the end of the input buffer, which
1748 is why this function is deprecated. Use L</utf8_to_uvchr_buf> instead.
1750 If C<s> points to one of the detected malformations, and UTF8 warnings are
1751 enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
1752 NULL) to -1. If those warnings are off, the computed value if well-defined (or
1753 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1754 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1755 next possible position in C<s> that could begin a non-malformed character.
1756 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1762 Perl_utf8_to_uvchr(pTHX_ const U8 *s, STRLEN *retlen)
1764 PERL_ARGS_ASSERT_UTF8_TO_UVCHR;
1766 return utf8_to_uvchr_buf(s, s + UTF8_MAXBYTES, retlen);
1770 =for apidoc utf8_to_uvuni
1772 Returns the Unicode code point of the first character in the string C<s>
1773 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1774 length, in bytes, of that character.
1776 Some, but not all, UTF-8 malformations are detected, and in fact, some
1777 malformed input could cause reading beyond the end of the input buffer, which
1778 is one reason why this function is deprecated. The other is that only in
1779 extremely limited circumstances should the Unicode versus native code point be
1780 of any interest to you. See L</utf8_to_uvuni_buf> for alternatives.
1782 If C<s> points to one of the detected malformations, and UTF8 warnings are
1783 enabled, zero is returned and C<*retlen> is set (if C<retlen> doesn't point to
1784 NULL) to -1. If those warnings are off, the computed value if well-defined (or
1785 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1786 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1787 next possible position in C<s> that could begin a non-malformed character.
1788 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1794 Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1796 PERL_ARGS_ASSERT_UTF8_TO_UVUNI;
1798 return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1803 #endif /* NO_MATHOMS */
1807 * c-indentation-style: bsd
1809 * indent-tabs-mode: nil
1812 * ex: set ts=8 sts=4 sw=4 et: