3 * Copyright (C) 2005, 2006, by Larry Wall and others
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
11 * "Anything that Hobbits had no immediate use for, but were unwilling to
12 * throw away, they called a mathom. Their dwellings were apt to become
13 * rather crowded with mathoms, and many of the presents that passed from
14 * hand to hand were of that sort."
20 * This file contains mathoms, various binary artifacts from previous
21 * versions of Perl. For binary or source compatibility reasons, though,
22 * we cannot completely remove them from the core code.
29 #define PERL_IN_MATHOMS_C
32 PERL_CALLCONV OP * Perl_ref(pTHX_ OP *o, I32 type);
33 PERL_CALLCONV void Perl_sv_unref(pTHX_ SV *sv);
34 PERL_CALLCONV void Perl_sv_taint(pTHX_ SV *sv);
35 PERL_CALLCONV IV Perl_sv_2iv(pTHX_ register SV *sv);
36 PERL_CALLCONV UV Perl_sv_2uv(pTHX_ register SV *sv);
37 PERL_CALLCONV char * Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp);
38 PERL_CALLCONV char * Perl_sv_2pv_nolen(pTHX_ register SV *sv);
39 PERL_CALLCONV char * Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv);
40 PERL_CALLCONV char * Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv);
41 PERL_CALLCONV void Perl_sv_force_normal(pTHX_ register SV *sv);
42 PERL_CALLCONV void Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr);
43 PERL_CALLCONV void Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen);
44 PERL_CALLCONV void Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len);
45 PERL_CALLCONV void Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr);
46 PERL_CALLCONV void Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv);
47 PERL_CALLCONV char * Perl_sv_pv(pTHX_ SV *sv);
48 PERL_CALLCONV char * Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp);
49 PERL_CALLCONV char * Perl_sv_pvbyte(pTHX_ SV *sv);
50 PERL_CALLCONV char * Perl_sv_pvutf8(pTHX_ SV *sv);
51 PERL_CALLCONV STRLEN Perl_sv_utf8_upgrade(pTHX_ register SV *sv);
52 PERL_CALLCONV NV Perl_huge(void);
53 PERL_CALLCONV void Perl_gv_fullname3(pTHX_ SV *sv, const GV *gv, const char *prefix);
54 PERL_CALLCONV void Perl_gv_efullname3(pTHX_ SV *sv, const GV *gv, const char *prefix);
55 PERL_CALLCONV GV * Perl_gv_fetchmethod(pTHX_ HV *stash, const char *name);
56 PERL_CALLCONV HE * Perl_hv_iternext(pTHX_ HV *hv);
57 PERL_CALLCONV void Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how);
58 PERL_CALLCONV bool Perl_do_open(pTHX_ GV *gv, register const char *name, I32 len, int as_raw, int rawmode, int rawperm, PerlIO *supplied_fp);
59 PERL_CALLCONV bool Perl_do_aexec(pTHX_ SV *really, register SV **mark, register SV **sp);
60 PERL_CALLCONV bool Perl_do_exec(pTHX_ const char *cmd);
61 PERL_CALLCONV U8 * Perl_uvuni_to_utf8(pTHX_ U8 *d, UV uv);
62 PERL_CALLCONV bool Perl_is_utf8_string_loc(pTHX_ const U8 *s, STRLEN len, const U8 **ep);
63 PERL_CALLCONV void Perl_sv_nolocking(pTHX_ SV *sv);
64 PERL_CALLCONV void Perl_sv_usepvn_mg(pTHX_ SV *sv, char *ptr, STRLEN len);
65 PERL_CALLCONV void Perl_sv_usepvn(pTHX_ SV *sv, char *ptr, STRLEN len);
66 PERL_CALLCONV int Perl_fprintf_nocontext(PerlIO *stream, const char *format, ...);
67 PERL_CALLCONV int Perl_printf_nocontext(const char *format, ...);
70 /* ref() is now a macro using Perl_doref;
71 * this version provided for binary compatibility only.
74 Perl_ref(pTHX_ OP *o, I32 type)
76 return doref(o, type, TRUE);
82 Unsets the RV status of the SV, and decrements the reference count of
83 whatever was being referenced by the RV. This can almost be thought of
84 as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
85 being zero. See C<SvROK_off>.
91 Perl_sv_unref(pTHX_ SV *sv)
93 sv_unref_flags(sv, 0);
99 Taint an SV. Use C<SvTAINTED_on> instead.
104 Perl_sv_taint(pTHX_ SV *sv)
106 sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0);
109 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
110 * this function provided for binary compatibility only
114 Perl_sv_2iv(pTHX_ register SV *sv)
116 return sv_2iv_flags(sv, SV_GMAGIC);
119 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
120 * this function provided for binary compatibility only
124 Perl_sv_2uv(pTHX_ register SV *sv)
126 return sv_2uv_flags(sv, SV_GMAGIC);
129 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
130 * this function provided for binary compatibility only
134 Perl_sv_2pv(pTHX_ register SV *sv, STRLEN *lp)
136 return sv_2pv_flags(sv, lp, SV_GMAGIC);
140 =for apidoc sv_2pv_nolen
142 Like C<sv_2pv()>, but doesn't return the length too. You should usually
143 use the macro wrapper C<SvPV_nolen(sv)> instead.
148 Perl_sv_2pv_nolen(pTHX_ register SV *sv)
150 return sv_2pv(sv, NULL);
154 =for apidoc sv_2pvbyte_nolen
156 Return a pointer to the byte-encoded representation of the SV.
157 May cause the SV to be downgraded from UTF-8 as a side-effect.
159 Usually accessed via the C<SvPVbyte_nolen> macro.
165 Perl_sv_2pvbyte_nolen(pTHX_ register SV *sv)
167 return sv_2pvbyte(sv, NULL);
171 =for apidoc sv_2pvutf8_nolen
173 Return a pointer to the UTF-8-encoded representation of the SV.
174 May cause the SV to be upgraded to UTF-8 as a side-effect.
176 Usually accessed via the C<SvPVutf8_nolen> macro.
182 Perl_sv_2pvutf8_nolen(pTHX_ register SV *sv)
184 return sv_2pvutf8(sv, NULL);
188 =for apidoc sv_force_normal
190 Undo various types of fakery on an SV: if the PV is a shared string, make
191 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
192 an xpvmg. See also C<sv_force_normal_flags>.
198 Perl_sv_force_normal(pTHX_ register SV *sv)
200 sv_force_normal_flags(sv, 0);
203 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
204 * this function provided for binary compatibility only
208 Perl_sv_setsv(pTHX_ SV *dstr, register SV *sstr)
210 sv_setsv_flags(dstr, sstr, SV_GMAGIC);
213 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
214 * this function provided for binary compatibility only
218 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
220 sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
224 =for apidoc sv_catpvn_mg
226 Like C<sv_catpvn>, but also handles 'set' magic.
232 Perl_sv_catpvn_mg(pTHX_ register SV *sv, register const char *ptr, register STRLEN len)
234 sv_catpvn_flags(sv,ptr,len,SV_GMAGIC|SV_SMAGIC);
237 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
238 * this function provided for binary compatibility only
242 Perl_sv_catsv(pTHX_ SV *dstr, register SV *sstr)
244 sv_catsv_flags(dstr, sstr, SV_GMAGIC);
248 =for apidoc sv_catsv_mg
250 Like C<sv_catsv>, but also handles 'set' magic.
256 Perl_sv_catsv_mg(pTHX_ SV *dsv, register SV *ssv)
258 sv_catsv_flags(dsv,ssv,SV_GMAGIC|SV_SMAGIC);
264 A private implementation of the C<SvIVx> macro for compilers which can't
265 cope with complex macro expressions. Always use the macro instead.
271 Perl_sv_iv(pTHX_ register SV *sv)
275 return (IV)SvUVX(sv);
284 A private implementation of the C<SvUVx> macro for compilers which can't
285 cope with complex macro expressions. Always use the macro instead.
291 Perl_sv_uv(pTHX_ register SV *sv)
296 return (UV)SvIVX(sv);
304 A private implementation of the C<SvNVx> macro for compilers which can't
305 cope with complex macro expressions. Always use the macro instead.
311 Perl_sv_nv(pTHX_ register SV *sv)
321 Use the C<SvPV_nolen> macro instead
325 A private implementation of the C<SvPV> macro for compilers which can't
326 cope with complex macro expressions. Always use the macro instead.
332 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
338 return sv_2pv(sv, lp);
343 Perl_sv_pvn_nomg(pTHX_ register SV *sv, STRLEN *lp)
349 return sv_2pv_flags(sv, lp, 0);
352 /* sv_pv() is now a macro using SvPV_nolen();
353 * this function provided for binary compatibility only
357 Perl_sv_pv(pTHX_ SV *sv)
362 return sv_2pv(sv, NULL);
365 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
366 * this function provided for binary compatibility only
370 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
372 return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
375 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
376 * this function provided for binary compatibility only
380 Perl_sv_pvbyte(pTHX_ SV *sv)
382 sv_utf8_downgrade(sv, FALSE);
387 =for apidoc sv_pvbyte
389 Use C<SvPVbyte_nolen> instead.
391 =for apidoc sv_pvbyten
393 A private implementation of the C<SvPVbyte> macro for compilers
394 which can't cope with complex macro expressions. Always use the macro
401 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
403 sv_utf8_downgrade(sv, FALSE);
404 return sv_pvn(sv,lp);
407 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
408 * this function provided for binary compatibility only
412 Perl_sv_pvutf8(pTHX_ SV *sv)
419 =for apidoc sv_pvutf8
421 Use the C<SvPVutf8_nolen> macro instead
423 =for apidoc sv_pvutf8n
425 A private implementation of the C<SvPVutf8> macro for compilers
426 which can't cope with complex macro expressions. Always use the macro
433 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
436 return sv_pvn(sv,lp);
439 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
440 * this function provided for binary compatibility only
444 Perl_sv_utf8_upgrade(pTHX_ register SV *sv)
446 return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
450 Perl_fprintf_nocontext(PerlIO *stream, const char *format, ...)
454 va_start(arglist, format);
455 return PerlIO_vprintf(stream, format, arglist);
459 Perl_printf_nocontext(const char *format, ...)
463 va_start(arglist, format);
464 return PerlIO_vprintf(PerlIO_stdout(), format, arglist);
467 #if defined(HUGE_VAL) || (defined(USE_LONG_DOUBLE) && defined(HUGE_VALL))
469 * This hack is to force load of "huge" support from libm.a
470 * So it is in perl for (say) POSIX to use.
471 * Needed for SunOS with Sun's 'acc' for example.
476 # if defined(USE_LONG_DOUBLE) && defined(HUGE_VALL)
484 /* compatibility with versions <= 5.003. */
486 Perl_gv_fullname(pTHX_ SV *sv, const GV *gv)
488 gv_fullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
491 /* compatibility with versions <= 5.003. */
493 Perl_gv_efullname(pTHX_ SV *sv, const GV *gv)
495 gv_efullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
499 Perl_gv_fullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
501 gv_fullname4(sv, gv, prefix, TRUE);
505 Perl_gv_efullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
507 gv_efullname4(sv, gv, prefix, TRUE);
511 =for apidoc gv_fetchmethod
513 See L<gv_fetchmethod_autoload>.
519 Perl_gv_fetchmethod(pTHX_ HV *stash, const char *name)
521 return gv_fetchmethod_autoload(stash, name, TRUE);
525 Perl_hv_iternext(pTHX_ HV *hv)
527 return hv_iternext_flags(hv, 0);
531 Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how)
533 sv_magic((SV*)hv, (SV*)gv, how, NULL, 0);
536 #if 0 /* use the macro from hv.h instead */
539 Perl_sharepvn(pTHX_ const char *sv, I32 len, U32 hash)
541 return HEK_KEY(share_hek(sv, len, hash));
547 Perl_av_fake(pTHX_ register I32 size, register SV **strp)
550 register AV * const av = (AV*)newSV(0);
552 sv_upgrade((SV *)av, SVt_PVAV);
553 Newx(ary,size+1,SV*);
555 Copy(strp,ary,size,SV*);
558 AvFILLp(av) = size - 1;
559 AvMAX(av) = size - 1;
569 Perl_do_open(pTHX_ GV *gv, register const char *name, I32 len, int as_raw,
570 int rawmode, int rawperm, PerlIO *supplied_fp)
572 return do_openn(gv, name, len, as_raw, rawmode, rawperm,
573 supplied_fp, (SV **) NULL, 0);
577 Perl_do_open9(pTHX_ GV *gv, register const char *name, I32 len, int
579 int rawmode, int rawperm, PerlIO *supplied_fp, SV *svs,
582 PERL_UNUSED_ARG(num_svs);
583 return do_openn(gv, name, len, as_raw, rawmode, rawperm,
584 supplied_fp, &svs, 1);
588 Perl_do_binmode(pTHX_ PerlIO *fp, int iotype, int mode)
590 /* The old body of this is now in non-LAYER part of perlio.c
591 * This is a stub for any XS code which might have been calling it.
593 const char *name = ":raw";
594 #ifdef PERLIO_USING_CRLF
595 if (!(mode & O_BINARY))
598 return PerlIO_binmode(aTHX_ fp, iotype, mode, name);
603 Perl_do_aexec(pTHX_ SV *really, register SV **mark, register SV **sp)
605 return do_aexec5(really, mark, sp, 0, 0);
609 #ifdef PERL_DEFAULT_DO_EXEC3_IMPLEMENTATION
611 Perl_do_exec(pTHX_ const char *cmd)
613 return do_exec3(cmd,0,0);
619 Perl_do_pipe(pTHX_ SV *sv, GV *rgv, GV *wgv)
639 if (PerlProc_pipe(fd) < 0)
641 IoIFP(rstio) = PerlIO_fdopen(fd[0], "r"PIPE_OPEN_MODE);
642 IoOFP(wstio) = PerlIO_fdopen(fd[1], "w"PIPE_OPEN_MODE);
643 IoOFP(rstio) = IoIFP(rstio);
644 IoIFP(wstio) = IoOFP(wstio);
645 IoTYPE(rstio) = IoTYPE_RDONLY;
646 IoTYPE(wstio) = IoTYPE_WRONLY;
647 if (!IoIFP(rstio) || !IoOFP(wstio)) {
648 if (IoIFP(rstio)) PerlIO_close(IoIFP(rstio));
649 else PerlLIO_close(fd[0]);
650 if (IoOFP(wstio)) PerlIO_close(IoOFP(wstio));
651 else PerlLIO_close(fd[1]);
655 sv_setsv(sv,&PL_sv_yes);
659 sv_setsv(sv,&PL_sv_undef);
664 /* Backwards compatibility. */
666 Perl_init_i18nl14n(pTHX_ int printwarn)
668 return init_i18nl10n(printwarn);
671 /* XXX kept for BINCOMPAT only */
673 Perl_save_hints(pTHX)
675 Perl_croak(aTHX_ "internal error: obsolete function save_hints() called");
680 Perl_ck_retarget(pTHX_ OP *o)
682 Perl_croak(aTHX_ "NOT IMPL LINE %d",__LINE__);
689 Perl_oopsCV(pTHX_ OP *o)
691 Perl_croak(aTHX_ "NOT IMPL LINE %d",__LINE__);
694 NORETURN_FUNCTION_END;
699 DIE(aTHX_ "NOT IMPL LINE %d",__LINE__);
704 DIE(aTHX_ "tried to access per-thread data in non-threaded perl");
709 DIE(aTHX_ "panic: mapstart"); /* uses grepstart */
712 /* These ops all have the same body as pp_null. */
737 /* Ops that are calls to do_kv. */
748 /* Ops that are simply calls to other ops. */
787 return pp_ssockopt();
792 return pp_getpeername();
802 return pp_ftrowned();
827 return pp_shmwrite();
842 return pp_ghostent();
847 return pp_ghostent();
862 return pp_gprotoent();
867 return pp_gprotoent();
872 return pp_gservent();
877 return pp_gservent();
922 return pp_ftrowned();
927 return pp_ftrowned();
932 return pp_ftrowned();
937 return pp_ftrowned();
942 return pp_ftrowned();
947 return pp_ftrowned();
952 return pp_ftrowned();
957 return pp_ftrowned();
962 return pp_ftrowned();
967 return pp_ftrowned();
1002 return pp_ftrread();
1007 return pp_ftrread();
1012 return pp_ftrread();
1017 return pp_ftrread();
1022 return pp_shmwrite();
1027 return pp_shmwrite();
1037 return pp_shmwrite();
1042 return pp_defined();
1057 return pp_defined();
1062 return pp_ucfirst();
1121 Perl_uvuni_to_utf8(pTHX_ U8 *d, UV uv)
1123 return Perl_uvuni_to_utf8_flags(aTHX_ d, uv, 0);
1127 Perl_is_utf8_string_loc(pTHX_ const U8 *s, STRLEN len, const U8 **ep)
1129 return is_utf8_string_loclen(s, len, ep, 0);
1133 =for apidoc sv_nolocking
1135 Dummy routine which "locks" an SV when there is no locking module present.
1136 Exists to avoid test for a NULL function pointer and because it could
1137 potentially warn under some level of strict-ness.
1139 "Superseded" by sv_nosharing().
1145 Perl_sv_nolocking(pTHX_ SV *sv)
1147 PERL_UNUSED_CONTEXT;
1148 PERL_UNUSED_ARG(sv);
1153 =for apidoc sv_nounlocking
1155 Dummy routine which "unlocks" an SV when there is no locking module present.
1156 Exists to avoid test for a NULL function pointer and because it could
1157 potentially warn under some level of strict-ness.
1159 "Superseded" by sv_nosharing().
1165 Perl_sv_nounlocking(pTHX_ SV *sv)
1167 PERL_UNUSED_CONTEXT;
1168 PERL_UNUSED_ARG(sv);
1172 Perl_save_long(pTHX_ long int *longp)
1178 SSPUSHINT(SAVEt_LONG);
1182 Perl_save_I16(pTHX_ I16 *intp)
1188 SSPUSHINT(SAVEt_I16);
1192 Perl_save_iv(pTHX_ IV *ivp)
1198 SSPUSHINT(SAVEt_IV);
1202 Perl_save_nogv(pTHX_ GV *gv)
1207 SSPUSHINT(SAVEt_NSTAB);
1211 Perl_save_list(pTHX_ register SV **sarg, I32 maxsarg)
1216 for (i = 1; i <= maxsarg; i++) {
1217 register SV * const sv = newSV(0);
1218 sv_setsv(sv,sarg[i]);
1220 SSPUSHPTR(sarg[i]); /* remember the pointer */
1221 SSPUSHPTR(sv); /* remember the value */
1222 SSPUSHINT(SAVEt_ITEM);
1227 =for apidoc sv_usepvn_mg
1229 Like C<sv_usepvn>, but also handles 'set' magic.
1235 Perl_sv_usepvn_mg(pTHX_ SV *sv, char *ptr, STRLEN len)
1237 sv_usepvn_flags(sv,ptr,len, SV_SMAGIC);
1241 =for apidoc sv_usepvn
1243 Tells an SV to use C<ptr> to find its string value. Implemented by
1244 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
1245 magic. See C<sv_usepvn_flags>.
1251 Perl_sv_usepvn(pTHX_ SV *sv, char *ptr, STRLEN len)
1253 sv_usepvn_flags(sv,ptr,len, 0);
1257 Perl_cv_ckproto(pTHX_ const CV *cv, const GV *gv, const char *p)
1259 cv_ckproto_len(cv, gv, p, p ? strlen(p) : 0);
1263 =for apidoc unpack_str
1265 The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1266 and ocnt are not used. This call should not be used, use unpackstring instead.
1271 Perl_unpack_str(pTHX_ const char *pat, const char *patend, const char *s,
1272 const char *strbeg, const char *strend, char **new_s, I32 ocnt,
1275 PERL_UNUSED_ARG(strbeg);
1276 PERL_UNUSED_ARG(new_s);
1277 PERL_UNUSED_ARG(ocnt);
1279 return unpackstring(pat, patend, s, strend, flags);
1283 =for apidoc pack_cat
1285 The engine implementing pack() Perl function. Note: parameters next_in_list and
1286 flags are not used. This call should not be used; use packlist instead.
1292 Perl_pack_cat(pTHX_ SV *cat, const char *pat, const char *patend, register SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
1294 PERL_UNUSED_ARG(next_in_list);
1295 PERL_UNUSED_ARG(flags);
1297 packlist(cat, pat, patend, beglist, endlist);
1299 #endif /* NO_MATHOMS */
1303 * c-indentation-style: bsd
1305 * indent-tabs-mode: t
1308 * ex: set ts=8 sts=4 sw=4 noet: