mathoms.c

   1 /*    mathoms.c
   2  *
   3  *    Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010,
   4  *    2011, 2012 by Larry Wall and others
   5  *
   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.
   8  *
   9  */
  10
  11 /*
  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.
  16  *
  17  *     [p.5 of _The Lord of the Rings_: "Prologue"]
  18  */
  19
  20
  21
  22 /*
  23  * This file contains mathoms, various binary artifacts from previous
  24  * versions of Perl which we cannot completely remove from the core
  25  * code. There are two reasons functions should be here:
  26  *
  27  * 1) A function has been been replaced by a macro within a minor release,
  28  *    so XS modules compiled against an older release will expect to
  29  *    still be able to link against the function
  30  * 2) A function Perl_foo(...) with #define foo Perl_foo(aTHX_ ...)
  31  *    has been replaced by a macro, e.g. #define foo(...) foo_flags(...,0)
  32  *    but XS code may still explicitly use the long form, i.e.
  33  *    Perl_foo(aTHX_ ...)
  34  *
  35  * NOTE: ALL FUNCTIONS IN THIS FILE should have an entry with the 'b' flag in
  36  * embed.fnc.
  37  *
  38  * To move a function to this file, simply cut and paste it here, and change
  39  * its embed.fnc entry to additionally have the 'b' flag.  If, for some reason
  40  * a function you'd like to be treated as mathoms can't be moved from its
  41  * current place, simply enclose it between
  42  *
  43  * #ifndef NO_MATHOMS
  44  *    ...
  45  * #endif
  46  *
  47  * and add the 'b' flag in embed.fnc.
  48  *
  49  * The compilation of this file can be suppressed; see INSTALL
  50  *
  51  * Some blurb for perlapi.pod:
  52
  53 =head1 Obsolete backwards compatibility functions
  54
  55 Some of these are also deprecated.  You can exclude these from
  56 your compiled Perl by adding this option to Configure:
  57 C<-Accflags='-DNO_MATHOMS'>
  58
  59 =cut
  60
  61  */
  62
  63
  64 #include "EXTERN.h"
  65 #define PERL_IN_MATHOMS_C
  66 #include "perl.h"
  67
  68 #ifdef NO_MATHOMS
  69 /* ..." warning: ISO C forbids an empty source file"
  70    So make sure we have something in here by processing the headers anyway.
  71  */
  72 #else
  73
  74 /* The functions in this file should be able to call other deprecated functions
  75  * without a compiler warning */
  76 GCC_DIAG_IGNORE(-Wdeprecated-declarations)
  77
  78 /* ref() is now a macro using Perl_doref;
  79  * this version provided for binary compatibility only.
  80  */
  81 OP *
  82 Perl_ref(pTHX_ OP *o, I32 type)
  83 {
  84     return doref(o, type, TRUE);
  85 }
  86
  87 /*
  88 =for apidoc sv_unref
  89
  90 Unsets the RV status of the SV, and decrements the reference count of
  91 whatever was being referenced by the RV.  This can almost be thought of
  92 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
  93 being zero.  See C<L</SvROK_off>>.
  94
  95 =cut
  96 */
  97
  98 void
  99 Perl_sv_unref(pTHX_ SV *sv)
 100 {
 101     PERL_ARGS_ASSERT_SV_UNREF;
 102
 103     sv_unref_flags(sv, 0);
 104 }
 105
 106 /*
 107 =for apidoc sv_taint
 108
 109 Taint an SV.  Use C<SvTAINTED_on> instead.
 110
 111 =cut
 112 */
 113
 114 void
 115 Perl_sv_taint(pTHX_ SV *sv)
 116 {
 117     PERL_ARGS_ASSERT_SV_TAINT;
 118
 119     sv_magic((sv), NULL, PERL_MAGIC_taint, NULL, 0);
 120 }
 121
 122 /* sv_2iv() is now a macro using Perl_sv_2iv_flags();
 123  * this function provided for binary compatibility only
 124  */
 125
 126 IV
 127 Perl_sv_2iv(pTHX_ SV *sv)
 128 {
 129     PERL_ARGS_ASSERT_SV_2IV;
 130
 131     return sv_2iv_flags(sv, SV_GMAGIC);
 132 }
 133
 134 /* sv_2uv() is now a macro using Perl_sv_2uv_flags();
 135  * this function provided for binary compatibility only
 136  */
 137
 138 UV
 139 Perl_sv_2uv(pTHX_ SV *sv)
 140 {
 141     PERL_ARGS_ASSERT_SV_2UV;
 142
 143     return sv_2uv_flags(sv, SV_GMAGIC);
 144 }
 145
 146 /* sv_2nv() is now a macro using Perl_sv_2nv_flags();
 147  * this function provided for binary compatibility only
 148  */
 149
 150 NV
 151 Perl_sv_2nv(pTHX_ SV *sv)
 152 {
 153     return sv_2nv_flags(sv, SV_GMAGIC);
 154 }
 155
 156
 157 /* sv_2pv() is now a macro using Perl_sv_2pv_flags();
 158  * this function provided for binary compatibility only
 159  */
 160
 161 char *
 162 Perl_sv_2pv(pTHX_ SV *sv, STRLEN *lp)
 163 {
 164     PERL_ARGS_ASSERT_SV_2PV;
 165
 166     return sv_2pv_flags(sv, lp, SV_GMAGIC);
 167 }
 168
 169 /*
 170 =for apidoc sv_2pv_nolen
 171
 172 Like C<sv_2pv()>, but doesn't return the length too.  You should usually
 173 use the macro wrapper C<SvPV_nolen(sv)> instead.
 174
 175 =cut
 176 */
 177
 178 char *
 179 Perl_sv_2pv_nolen(pTHX_ SV *sv)
 180 {
 181     PERL_ARGS_ASSERT_SV_2PV_NOLEN;
 182     return sv_2pv(sv, NULL);
 183 }
 184
 185 /*
 186 =for apidoc sv_2pvbyte_nolen
 187
 188 Return a pointer to the byte-encoded representation of the SV.
 189 May cause the SV to be downgraded from UTF-8 as a side-effect.
 190
 191 Usually accessed via the C<SvPVbyte_nolen> macro.
 192
 193 =cut
 194 */
 195
 196 char *
 197 Perl_sv_2pvbyte_nolen(pTHX_ SV *sv)
 198 {
 199     PERL_ARGS_ASSERT_SV_2PVBYTE_NOLEN;
 200
 201     return sv_2pvbyte(sv, NULL);
 202 }
 203
 204 /*
 205 =for apidoc sv_2pvutf8_nolen
 206
 207 Return a pointer to the UTF-8-encoded representation of the SV.
 208 May cause the SV to be upgraded to UTF-8 as a side-effect.
 209
 210 Usually accessed via the C<SvPVutf8_nolen> macro.
 211
 212 =cut
 213 */
 214
 215 char *
 216 Perl_sv_2pvutf8_nolen(pTHX_ SV *sv)
 217 {
 218     PERL_ARGS_ASSERT_SV_2PVUTF8_NOLEN;
 219
 220     return sv_2pvutf8(sv, NULL);
 221 }
 222
 223 /*
 224 =for apidoc sv_force_normal
 225
 226 Undo various types of fakery on an SV: if the PV is a shared string, make
 227 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
 228 an C<xpvmg>.  See also C<L</sv_force_normal_flags>>.
 229
 230 =cut
 231 */
 232
 233 void
 234 Perl_sv_force_normal(pTHX_ SV *sv)
 235 {
 236     PERL_ARGS_ASSERT_SV_FORCE_NORMAL;
 237
 238     sv_force_normal_flags(sv, 0);
 239 }
 240
 241 /* sv_setsv() is now a macro using Perl_sv_setsv_flags();
 242  * this function provided for binary compatibility only
 243  */
 244
 245 void
 246 Perl_sv_setsv(pTHX_ SV *dstr, SV *sstr)
 247 {
 248     PERL_ARGS_ASSERT_SV_SETSV;
 249
 250     sv_setsv_flags(dstr, sstr, SV_GMAGIC);
 251 }
 252
 253 /* sv_catpvn() is now a macro using Perl_sv_catpvn_flags();
 254  * this function provided for binary compatibility only
 255  */
 256
 257 void
 258 Perl_sv_catpvn(pTHX_ SV *dsv, const char* sstr, STRLEN slen)
 259 {
 260     PERL_ARGS_ASSERT_SV_CATPVN;
 261
 262     sv_catpvn_flags(dsv, sstr, slen, SV_GMAGIC);
 263 }
 264
 265 /*
 266 =for apidoc sv_catpvn_mg
 267
 268 Like C<sv_catpvn>, but also handles 'set' magic.
 269
 270 =cut
 271 */
 272
 273 void
 274 Perl_sv_catpvn_mg(pTHX_ SV *sv, const char *ptr, STRLEN len)
 275 {
 276     PERL_ARGS_ASSERT_SV_CATPVN_MG;
 277
 278     sv_catpvn_flags(sv,ptr,len,SV_GMAGIC|SV_SMAGIC);
 279 }
 280
 281 /* sv_catsv() is now a macro using Perl_sv_catsv_flags();
 282  * this function provided for binary compatibility only
 283  */
 284
 285 void
 286 Perl_sv_catsv(pTHX_ SV *dstr, SV *sstr)
 287 {
 288     PERL_ARGS_ASSERT_SV_CATSV;
 289
 290     sv_catsv_flags(dstr, sstr, SV_GMAGIC);
 291 }
 292
 293 /*
 294 =for apidoc sv_catsv_mg
 295
 296 Like C<sv_catsv>, but also handles 'set' magic.
 297
 298 =cut
 299 */
 300
 301 void
 302 Perl_sv_catsv_mg(pTHX_ SV *dsv, SV *ssv)
 303 {
 304     PERL_ARGS_ASSERT_SV_CATSV_MG;
 305
 306     sv_catsv_flags(dsv,ssv,SV_GMAGIC|SV_SMAGIC);
 307 }
 308
 309 /*
 310 =for apidoc sv_iv
 311
 312 A private implementation of the C<SvIVx> macro for compilers which can't
 313 cope with complex macro expressions.  Always use the macro instead.
 314
 315 =cut
 316 */
 317
 318 IV
 319 Perl_sv_iv(pTHX_ SV *sv)
 320 {
 321     PERL_ARGS_ASSERT_SV_IV;
 322
 323     if (SvIOK(sv)) {
 324         if (SvIsUV(sv))
 325             return (IV)SvUVX(sv);
 326         return SvIVX(sv);
 327     }
 328     return sv_2iv(sv);
 329 }
 330
 331 /*
 332 =for apidoc sv_uv
 333
 334 A private implementation of the C<SvUVx> macro for compilers which can't
 335 cope with complex macro expressions.  Always use the macro instead.
 336
 337 =cut
 338 */
 339
 340 UV
 341 Perl_sv_uv(pTHX_ SV *sv)
 342 {
 343     PERL_ARGS_ASSERT_SV_UV;
 344
 345     if (SvIOK(sv)) {
 346         if (SvIsUV(sv))
 347             return SvUVX(sv);
 348         return (UV)SvIVX(sv);
 349     }
 350     return sv_2uv(sv);
 351 }
 352
 353 /*
 354 =for apidoc sv_nv
 355
 356 A private implementation of the C<SvNVx> macro for compilers which can't
 357 cope with complex macro expressions.  Always use the macro instead.
 358
 359 =cut
 360 */
 361
 362 NV
 363 Perl_sv_nv(pTHX_ SV *sv)
 364 {
 365     PERL_ARGS_ASSERT_SV_NV;
 366
 367     if (SvNOK(sv))
 368         return SvNVX(sv);
 369     return sv_2nv(sv);
 370 }
 371
 372 /*
 373 =for apidoc sv_pv
 374
 375 Use the C<SvPV_nolen> macro instead
 376
 377 =for apidoc sv_pvn
 378
 379 A private implementation of the C<SvPV> macro for compilers which can't
 380 cope with complex macro expressions.  Always use the macro instead.
 381
 382 =cut
 383 */
 384
 385 char *
 386 Perl_sv_pvn(pTHX_ SV *sv, STRLEN *lp)
 387 {
 388     PERL_ARGS_ASSERT_SV_PVN;
 389
 390     if (SvPOK(sv)) {
 391         *lp = SvCUR(sv);
 392         return SvPVX(sv);
 393     }
 394     return sv_2pv(sv, lp);
 395 }
 396
 397
 398 char *
 399 Perl_sv_pvn_nomg(pTHX_ SV *sv, STRLEN *lp)
 400 {
 401     PERL_ARGS_ASSERT_SV_PVN_NOMG;
 402
 403     if (SvPOK(sv)) {
 404         *lp = SvCUR(sv);
 405         return SvPVX(sv);
 406     }
 407     return sv_2pv_flags(sv, lp, 0);
 408 }
 409
 410 /* sv_pv() is now a macro using SvPV_nolen();
 411  * this function provided for binary compatibility only
 412  */
 413
 414 char *
 415 Perl_sv_pv(pTHX_ SV *sv)
 416 {
 417     PERL_ARGS_ASSERT_SV_PV;
 418
 419     if (SvPOK(sv))
 420         return SvPVX(sv);
 421
 422     return sv_2pv(sv, NULL);
 423 }
 424
 425 /* sv_pvn_force() is now a macro using Perl_sv_pvn_force_flags();
 426  * this function provided for binary compatibility only
 427  */
 428
 429 char *
 430 Perl_sv_pvn_force(pTHX_ SV *sv, STRLEN *lp)
 431 {
 432     PERL_ARGS_ASSERT_SV_PVN_FORCE;
 433
 434     return sv_pvn_force_flags(sv, lp, SV_GMAGIC);
 435 }
 436
 437 /* sv_pvbyte () is now a macro using Perl_sv_2pv_flags();
 438  * this function provided for binary compatibility only
 439  */
 440
 441 char *
 442 Perl_sv_pvbyte(pTHX_ SV *sv)
 443 {
 444     PERL_ARGS_ASSERT_SV_PVBYTE;
 445
 446     sv_utf8_downgrade(sv, FALSE);
 447     return sv_pv(sv);
 448 }
 449
 450 /*
 451 =for apidoc sv_pvbyte
 452
 453 Use C<SvPVbyte_nolen> instead.
 454
 455 =for apidoc sv_pvbyten
 456
 457 A private implementation of the C<SvPVbyte> macro for compilers
 458 which can't cope with complex macro expressions.  Always use the macro
 459 instead.
 460
 461 =cut
 462 */
 463
 464 char *
 465 Perl_sv_pvbyten(pTHX_ SV *sv, STRLEN *lp)
 466 {
 467     PERL_ARGS_ASSERT_SV_PVBYTEN;
 468
 469     sv_utf8_downgrade(sv, FALSE);
 470     return sv_pvn(sv,lp);
 471 }
 472
 473 /* sv_pvutf8 () is now a macro using Perl_sv_2pv_flags();
 474  * this function provided for binary compatibility only
 475  */
 476
 477 char *
 478 Perl_sv_pvutf8(pTHX_ SV *sv)
 479 {
 480     PERL_ARGS_ASSERT_SV_PVUTF8;
 481
 482     sv_utf8_upgrade(sv);
 483     return sv_pv(sv);
 484 }
 485
 486 /*
 487 =for apidoc sv_pvutf8
 488
 489 Use the C<SvPVutf8_nolen> macro instead
 490
 491 =for apidoc sv_pvutf8n
 492
 493 A private implementation of the C<SvPVutf8> macro for compilers
 494 which can't cope with complex macro expressions.  Always use the macro
 495 instead.
 496
 497 =cut
 498 */
 499
 500 char *
 501 Perl_sv_pvutf8n(pTHX_ SV *sv, STRLEN *lp)
 502 {
 503     PERL_ARGS_ASSERT_SV_PVUTF8N;
 504
 505     sv_utf8_upgrade(sv);
 506     return sv_pvn(sv,lp);
 507 }
 508
 509 /* sv_utf8_upgrade() is now a macro using sv_utf8_upgrade_flags();
 510  * this function provided for binary compatibility only
 511  */
 512
 513 STRLEN
 514 Perl_sv_utf8_upgrade(pTHX_ SV *sv)
 515 {
 516     PERL_ARGS_ASSERT_SV_UTF8_UPGRADE;
 517
 518     return sv_utf8_upgrade_flags(sv, SV_GMAGIC);
 519 }
 520
 521 int
 522 Perl_fprintf_nocontext(PerlIO *stream, const char *format, ...)
 523 {
 524     int ret = 0;
 525     va_list arglist;
 526
 527     /* Easier to special case this here than in embed.pl. (Look at what it
 528        generates for proto.h) */
 529 #ifdef PERL_IMPLICIT_CONTEXT
 530     PERL_ARGS_ASSERT_FPRINTF_NOCONTEXT;
 531 #endif
 532
 533     va_start(arglist, format);
 534     ret = PerlIO_vprintf(stream, format, arglist);
 535     va_end(arglist);
 536     return ret;
 537 }
 538
 539 int
 540 Perl_printf_nocontext(const char *format, ...)
 541 {
 542     dTHX;
 543     va_list arglist;
 544     int ret = 0;
 545
 546 #ifdef PERL_IMPLICIT_CONTEXT
 547     PERL_ARGS_ASSERT_PRINTF_NOCONTEXT;
 548 #endif
 549
 550     va_start(arglist, format);
 551     ret = PerlIO_vprintf(PerlIO_stdout(), format, arglist);
 552     va_end(arglist);
 553     return ret;
 554 }
 555
 556 #if defined(HUGE_VAL) || (defined(USE_LONG_DOUBLE) && defined(HUGE_VALL))
 557 /*
 558  * This hack is to force load of "huge" support from libm.a
 559  * So it is in perl for (say) POSIX to use.
 560  * Needed for SunOS with Sun's 'acc' for example.
 561  */
 562 NV
 563 Perl_huge(void)
 564 {
 565 #  if defined(USE_LONG_DOUBLE) && defined(HUGE_VALL)
 566     return HUGE_VALL;
 567 #  else
 568     return HUGE_VAL;
 569 #  endif
 570 }
 571 #endif
 572
 573 /* compatibility with versions <= 5.003. */
 574 void
 575 Perl_gv_fullname(pTHX_ SV *sv, const GV *gv)
 576 {
 577     PERL_ARGS_ASSERT_GV_FULLNAME;
 578
 579     gv_fullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
 580 }
 581
 582 /* compatibility with versions <= 5.003. */
 583 void
 584 Perl_gv_efullname(pTHX_ SV *sv, const GV *gv)
 585 {
 586     PERL_ARGS_ASSERT_GV_EFULLNAME;
 587
 588     gv_efullname3(sv, gv, sv == (const SV*)gv ? "*" : "");
 589 }
 590
 591 void
 592 Perl_gv_fullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
 593 {
 594     PERL_ARGS_ASSERT_GV_FULLNAME3;
 595
 596     gv_fullname4(sv, gv, prefix, TRUE);
 597 }
 598
 599 void
 600 Perl_gv_efullname3(pTHX_ SV *sv, const GV *gv, const char *prefix)
 601 {
 602     PERL_ARGS_ASSERT_GV_EFULLNAME3;
 603
 604     gv_efullname4(sv, gv, prefix, TRUE);
 605 }
 606
 607 /*
 608 =for apidoc gv_fetchmethod
 609
 610 See L</gv_fetchmethod_autoload>.
 611
 612 =cut
 613 */
 614
 615 GV *
 616 Perl_gv_fetchmethod(pTHX_ HV *stash, const char *name)
 617 {
 618     PERL_ARGS_ASSERT_GV_FETCHMETHOD;
 619
 620     return gv_fetchmethod_autoload(stash, name, TRUE);
 621 }
 622
 623 HE *
 624 Perl_hv_iternext(pTHX_ HV *hv)
 625 {
 626     PERL_ARGS_ASSERT_HV_ITERNEXT;
 627
 628     return hv_iternext_flags(hv, 0);
 629 }
 630
 631 void
 632 Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how)
 633 {
 634     PERL_ARGS_ASSERT_HV_MAGIC;
 635
 636     sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0);
 637 }
 638
 639 bool
 640 Perl_do_open(pTHX_ GV *gv, const char *name, I32 len, int as_raw,
 641              int rawmode, int rawperm, PerlIO *supplied_fp)
 642 {
 643     PERL_ARGS_ASSERT_DO_OPEN;
 644
 645     return do_openn(gv, name, len, as_raw, rawmode, rawperm,
 646                     supplied_fp, (SV **) NULL, 0);
 647 }
 648
 649 bool
 650 Perl_do_open9(pTHX_ GV *gv, const char *name, I32 len, int
 651 as_raw,
 652               int rawmode, int rawperm, PerlIO *supplied_fp, SV *svs,
 653               I32 num_svs)
 654 {
 655     PERL_ARGS_ASSERT_DO_OPEN9;
 656
 657     PERL_UNUSED_ARG(num_svs);
 658     return do_openn(gv, name, len, as_raw, rawmode, rawperm,
 659                     supplied_fp, &svs, 1);
 660 }
 661
 662 int
 663 Perl_do_binmode(pTHX_ PerlIO *fp, int iotype, int mode)
 664 {
 665  /* The old body of this is now in non-LAYER part of perlio.c
 666   * This is a stub for any XS code which might have been calling it.
 667   */
 668  const char *name = ":raw";
 669
 670  PERL_ARGS_ASSERT_DO_BINMODE;
 671
 672 #ifdef PERLIO_USING_CRLF
 673  if (!(mode & O_BINARY))
 674      name = ":crlf";
 675 #endif
 676  return PerlIO_binmode(aTHX_ fp, iotype, mode, name);
 677 }
 678
 679 #ifndef OS2
 680 bool
 681 Perl_do_aexec(pTHX_ SV *really, SV **mark, SV **sp)
 682 {
 683     PERL_ARGS_ASSERT_DO_AEXEC;
 684
 685     return do_aexec5(really, mark, sp, 0, 0);
 686 }
 687 #endif
 688
 689 /* Backwards compatibility. */
 690 int
 691 Perl_init_i18nl14n(pTHX_ int printwarn)
 692 {
 693     return init_i18nl10n(printwarn);
 694 }
 695
 696 bool
 697 Perl_is_utf8_string_loc(const U8 *s, const STRLEN len, const U8 **ep)
 698 {
 699     PERL_ARGS_ASSERT_IS_UTF8_STRING_LOC;
 700
 701     return is_utf8_string_loclen(s, len, ep, 0);
 702 }
 703
 704 /*
 705 =for apidoc sv_nolocking
 706
 707 Dummy routine which "locks" an SV when there is no locking module present.
 708 Exists to avoid test for a C<NULL> function pointer and because it could
 709 potentially warn under some level of strict-ness.
 710
 711 "Superseded" by C<sv_nosharing()>.
 712
 713 =cut
 714 */
 715
 716 void
 717 Perl_sv_nolocking(pTHX_ SV *sv)
 718 {
 719     PERL_UNUSED_CONTEXT;
 720     PERL_UNUSED_ARG(sv);
 721 }
 722
 723
 724 /*
 725 =for apidoc sv_nounlocking
 726
 727 Dummy routine which "unlocks" an SV when there is no locking module present.
 728 Exists to avoid test for a C<NULL> function pointer and because it could
 729 potentially warn under some level of strict-ness.
 730
 731 "Superseded" by C<sv_nosharing()>.
 732
 733 =cut
 734
 735 PERL_UNLOCK_HOOK in intrpvar.h is the macro that refers to this, and guarantees
 736 that mathoms gets loaded.
 737
 738 */
 739
 740 void
 741 Perl_sv_nounlocking(pTHX_ SV *sv)
 742 {
 743     PERL_UNUSED_CONTEXT;
 744     PERL_UNUSED_ARG(sv);
 745 }
 746
 747 void
 748 Perl_save_long(pTHX_ long int *longp)
 749 {
 750     PERL_ARGS_ASSERT_SAVE_LONG;
 751
 752     SSCHECK(3);
 753     SSPUSHLONG(*longp);
 754     SSPUSHPTR(longp);
 755     SSPUSHUV(SAVEt_LONG);
 756 }
 757
 758 void
 759 Perl_save_nogv(pTHX_ GV *gv)
 760 {
 761     PERL_ARGS_ASSERT_SAVE_NOGV;
 762
 763     SSCHECK(2);
 764     SSPUSHPTR(gv);
 765     SSPUSHUV(SAVEt_NSTAB);
 766 }
 767
 768 void
 769 Perl_save_list(pTHX_ SV **sarg, I32 maxsarg)
 770 {
 771     I32 i;
 772
 773     PERL_ARGS_ASSERT_SAVE_LIST;
 774
 775     for (i = 1; i <= maxsarg; i++) {
 776         SV *sv;
 777         SvGETMAGIC(sarg[i]);
 778         sv = newSV(0);
 779         sv_setsv_nomg(sv,sarg[i]);
 780         SSCHECK(3);
 781         SSPUSHPTR(sarg[i]);             /* remember the pointer */
 782         SSPUSHPTR(sv);                  /* remember the value */
 783         SSPUSHUV(SAVEt_ITEM);
 784     }
 785 }
 786
 787 /*
 788 =for apidoc sv_usepvn_mg
 789
 790 Like C<sv_usepvn>, but also handles 'set' magic.
 791
 792 =cut
 793 */
 794
 795 void
 796 Perl_sv_usepvn_mg(pTHX_ SV *sv, char *ptr, STRLEN len)
 797 {
 798     PERL_ARGS_ASSERT_SV_USEPVN_MG;
 799
 800     sv_usepvn_flags(sv,ptr,len, SV_SMAGIC);
 801 }
 802
 803 /*
 804 =for apidoc sv_usepvn
 805
 806 Tells an SV to use C<ptr> to find its string value.  Implemented by
 807 calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
 808 magic.  See C<L</sv_usepvn_flags>>.
 809
 810 =cut
 811 */
 812
 813 void
 814 Perl_sv_usepvn(pTHX_ SV *sv, char *ptr, STRLEN len)
 815 {
 816     PERL_ARGS_ASSERT_SV_USEPVN;
 817
 818     sv_usepvn_flags(sv,ptr,len, 0);
 819 }
 820
 821 /*
 822 =for apidoc unpack_str
 823
 824 The engine implementing C<unpack()> Perl function.  Note: parameters C<strbeg>,
 825 C<new_s> and C<ocnt> are not used.  This call should not be used, use
 826 C<unpackstring> instead.
 827
 828 =cut */
 829
 830 SSize_t
 831 Perl_unpack_str(pTHX_ const char *pat, const char *patend, const char *s,
 832                 const char *strbeg, const char *strend, char **new_s, I32 ocnt,
 833                 U32 flags)
 834 {
 835     PERL_ARGS_ASSERT_UNPACK_STR;
 836
 837     PERL_UNUSED_ARG(strbeg);
 838     PERL_UNUSED_ARG(new_s);
 839     PERL_UNUSED_ARG(ocnt);
 840
 841     return unpackstring(pat, patend, s, strend, flags);
 842 }
 843
 844 /*
 845 =for apidoc pack_cat
 846
 847 The engine implementing C<pack()> Perl function.  Note: parameters
 848 C<next_in_list> and C<flags> are not used.  This call should not be used; use
 849 C<packlist> instead.
 850
 851 =cut
 852 */
 853
 854 void
 855 Perl_pack_cat(pTHX_ SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
 856 {
 857     PERL_ARGS_ASSERT_PACK_CAT;
 858
 859     PERL_UNUSED_ARG(next_in_list);
 860     PERL_UNUSED_ARG(flags);
 861
 862     packlist(cat, pat, patend, beglist, endlist);
 863 }
 864
 865 HE *
 866 Perl_hv_store_ent(pTHX_ HV *hv, SV *keysv, SV *val, U32 hash)
 867 {
 868   return (HE *)hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISSTORE, val, hash);
 869 }
 870
 871 bool
 872 Perl_hv_exists_ent(pTHX_ HV *hv, SV *keysv, U32 hash)
 873 {
 874     PERL_ARGS_ASSERT_HV_EXISTS_ENT;
 875
 876     return cBOOL(hv_common(hv, keysv, NULL, 0, 0, HV_FETCH_ISEXISTS, 0, hash));
 877 }
 878
 879 HE *
 880 Perl_hv_fetch_ent(pTHX_ HV *hv, SV *keysv, I32 lval, U32 hash)
 881 {
 882     PERL_ARGS_ASSERT_HV_FETCH_ENT;
 883
 884     return (HE *)hv_common(hv, keysv, NULL, 0, 0,
 885                      (lval ? HV_FETCH_LVALUE : 0), NULL, hash);
 886 }
 887
 888 SV *
 889 Perl_hv_delete_ent(pTHX_ HV *hv, SV *keysv, I32 flags, U32 hash)
 890 {
 891     PERL_ARGS_ASSERT_HV_DELETE_ENT;
 892
 893     return MUTABLE_SV(hv_common(hv, keysv, NULL, 0, 0, flags | HV_DELETE, NULL,
 894                                 hash));
 895 }
 896
 897 SV**
 898 Perl_hv_store_flags(pTHX_ HV *hv, const char *key, I32 klen, SV *val, U32 hash,
 899                     int flags)
 900 {
 901     return (SV**) hv_common(hv, NULL, key, klen, flags,
 902                             (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
 903 }
 904
 905 SV**
 906 Perl_hv_store(pTHX_ HV *hv, const char *key, I32 klen_i32, SV *val, U32 hash)
 907 {
 908     STRLEN klen;
 909     int flags;
 910
 911     if (klen_i32 < 0) {
 912         klen = -klen_i32;
 913         flags = HVhek_UTF8;
 914     } else {
 915         klen = klen_i32;
 916         flags = 0;
 917     }
 918     return (SV **) hv_common(hv, NULL, key, klen, flags,
 919                              (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), val, hash);
 920 }
 921
 922 bool
 923 Perl_hv_exists(pTHX_ HV *hv, const char *key, I32 klen_i32)
 924 {
 925     STRLEN klen;
 926     int flags;
 927
 928     PERL_ARGS_ASSERT_HV_EXISTS;
 929
 930     if (klen_i32 < 0) {
 931         klen = -klen_i32;
 932         flags = HVhek_UTF8;
 933     } else {
 934         klen = klen_i32;
 935         flags = 0;
 936     }
 937     return cBOOL(hv_common(hv, NULL, key, klen, flags, HV_FETCH_ISEXISTS, 0, 0));
 938 }
 939
 940 SV**
 941 Perl_hv_fetch(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 lval)
 942 {
 943     STRLEN klen;
 944     int flags;
 945
 946     PERL_ARGS_ASSERT_HV_FETCH;
 947
 948     if (klen_i32 < 0) {
 949         klen = -klen_i32;
 950         flags = HVhek_UTF8;
 951     } else {
 952         klen = klen_i32;
 953         flags = 0;
 954     }
 955     return (SV **) hv_common(hv, NULL, key, klen, flags,
 956                              lval ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)
 957                              : HV_FETCH_JUST_SV, NULL, 0);
 958 }
 959
 960 SV *
 961 Perl_hv_delete(pTHX_ HV *hv, const char *key, I32 klen_i32, I32 flags)
 962 {
 963     STRLEN klen;
 964     int k_flags;
 965
 966     PERL_ARGS_ASSERT_HV_DELETE;
 967
 968     if (klen_i32 < 0) {
 969         klen = -klen_i32;
 970         k_flags = HVhek_UTF8;
 971     } else {
 972         klen = klen_i32;
 973         k_flags = 0;
 974     }
 975     return MUTABLE_SV(hv_common(hv, NULL, key, klen, k_flags, flags | HV_DELETE,
 976                                 NULL, 0));
 977 }
 978
 979 AV *
 980 Perl_newAV(pTHX)
 981 {
 982     return MUTABLE_AV(newSV_type(SVt_PVAV));
 983     /* sv_upgrade does AvREAL_only():
 984     AvALLOC(av) = 0;
 985     AvARRAY(av) = NULL;
 986     AvMAX(av) = AvFILLp(av) = -1; */
 987 }
 988
 989 HV *
 990 Perl_newHV(pTHX)
 991 {
 992     HV * const hv = MUTABLE_HV(newSV_type(SVt_PVHV));
 993     assert(!SvOK(hv));
 994
 995     return hv;
 996 }
 997
 998 void
 999 Perl_sv_insert(pTHX_ SV *const bigstr, const STRLEN offset, const STRLEN len,
1000               const char *const little, const STRLEN littlelen)
1001 {
1002     PERL_ARGS_ASSERT_SV_INSERT;
1003     sv_insert_flags(bigstr, offset, len, little, littlelen, SV_GMAGIC);
1004 }
1005
1006 void
1007 Perl_save_freesv(pTHX_ SV *sv)
1008 {
1009     save_freesv(sv);
1010 }
1011
1012 void
1013 Perl_save_mortalizesv(pTHX_ SV *sv)
1014 {
1015     PERL_ARGS_ASSERT_SAVE_MORTALIZESV;
1016
1017     save_mortalizesv(sv);
1018 }
1019
1020 void
1021 Perl_save_freeop(pTHX_ OP *o)
1022 {
1023     save_freeop(o);
1024 }
1025
1026 void
1027 Perl_save_freepv(pTHX_ char *pv)
1028 {
1029     save_freepv(pv);
1030 }
1031
1032 void
1033 Perl_save_op(pTHX)
1034 {
1035     save_op();
1036 }
1037
1038 #ifdef PERL_DONT_CREATE_GVSV
1039 GV *
1040 Perl_gv_SVadd(pTHX_ GV *gv)
1041 {
1042     return gv_SVadd(gv);
1043 }
1044 #endif
1045
1046 GV *
1047 Perl_gv_AVadd(pTHX_ GV *gv)
1048 {
1049     return gv_AVadd(gv);
1050 }
1051
1052 GV *
1053 Perl_gv_HVadd(pTHX_ GV *gv)
1054 {
1055     return gv_HVadd(gv);
1056 }
1057
1058 GV *
1059 Perl_gv_IOadd(pTHX_ GV *gv)
1060 {
1061     return gv_IOadd(gv);
1062 }
1063
1064 IO *
1065 Perl_newIO(pTHX)
1066 {
1067     return MUTABLE_IO(newSV_type(SVt_PVIO));
1068 }
1069
1070 I32
1071 Perl_my_stat(pTHX)
1072 {
1073     return my_stat_flags(SV_GMAGIC);
1074 }
1075
1076 I32
1077 Perl_my_lstat(pTHX)
1078 {
1079     return my_lstat_flags(SV_GMAGIC);
1080 }
1081
1082 I32
1083 Perl_sv_eq(pTHX_ SV *sv1, SV *sv2)
1084 {
1085     return sv_eq_flags(sv1, sv2, SV_GMAGIC);
1086 }
1087
1088 #ifdef USE_LOCALE_COLLATE
1089 char *
1090 Perl_sv_collxfrm(pTHX_ SV *const sv, STRLEN *const nxp)
1091 {
1092     PERL_ARGS_ASSERT_SV_COLLXFRM;
1093     return sv_collxfrm_flags(sv, nxp, SV_GMAGIC);
1094 }
1095
1096 char *
1097 Perl_mem_collxfrm(pTHX_ const char *input_string, STRLEN len, STRLEN *xlen)
1098 {
1099     /* This function is retained for compatibility in case someone outside core
1100      * is using this (but it is undocumented) */
1101
1102     PERL_ARGS_ASSERT_MEM_COLLXFRM;
1103
1104     return _mem_collxfrm(input_string, len, xlen, FALSE);
1105 }
1106
1107 #endif
1108
1109 bool
1110 Perl_sv_2bool(pTHX_ SV *const sv)
1111 {
1112     PERL_ARGS_ASSERT_SV_2BOOL;
1113     return sv_2bool_flags(sv, SV_GMAGIC);
1114 }
1115
1116
1117 /*
1118 =for apidoc custom_op_name
1119 Return the name for a given custom op.  This was once used by the C<OP_NAME>
1120 macro, but is no longer: it has only been kept for compatibility, and
1121 should not be used.
1122
1123 =for apidoc custom_op_desc
1124 Return the description of a given custom op.  This was once used by the
1125 C<OP_DESC> macro, but is no longer: it has only been kept for
1126 compatibility, and should not be used.
1127
1128 =cut
1129 */
1130
1131 const char*
1132 Perl_custom_op_name(pTHX_ const OP* o)
1133 {
1134     PERL_ARGS_ASSERT_CUSTOM_OP_NAME;
1135     return XopENTRYCUSTOM(o, xop_name);
1136 }
1137
1138 const char*
1139 Perl_custom_op_desc(pTHX_ const OP* o)
1140 {
1141     PERL_ARGS_ASSERT_CUSTOM_OP_DESC;
1142     return XopENTRYCUSTOM(o, xop_desc);
1143 }
1144
1145 CV *
1146 Perl_newSUB(pTHX_ I32 floor, OP *o, OP *proto, OP *block)
1147 {
1148     return newATTRSUB(floor, o, proto, NULL, block);
1149 }
1150
1151 SV *
1152 Perl_sv_mortalcopy(pTHX_ SV *const oldstr)
1153 {
1154     return Perl_sv_mortalcopy_flags(aTHX_ oldstr, SV_GMAGIC);
1155 }
1156
1157 void
1158 Perl_sv_copypv(pTHX_ SV *const dsv, SV *const ssv)
1159 {
1160     PERL_ARGS_ASSERT_SV_COPYPV;
1161
1162     sv_copypv_flags(dsv, ssv, SV_GMAGIC);
1163 }
1164
1165 UV      /* Made into a function, so can be deprecated */
1166 NATIVE_TO_NEED(const UV enc, const UV ch)
1167 {
1168     PERL_UNUSED_ARG(enc);
1169     return ch;
1170 }
1171
1172 UV      /* Made into a function, so can be deprecated */
1173 ASCII_TO_NEED(const UV enc, const UV ch)
1174 {
1175     PERL_UNUSED_ARG(enc);
1176     return ch;
1177 }
1178
1179 /*
1180 =for apidoc is_utf8_char
1181
1182 Tests if some arbitrary number of bytes begins in a valid UTF-8
1183 character.  Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
1184 character is a valid UTF-8 character.  The actual number of bytes in the UTF-8
1185 character will be returned if it is valid, otherwise 0.
1186
1187 This function is deprecated due to the possibility that malformed input could
1188 cause reading beyond the end of the input buffer.  Use L</isUTF8_CHAR>
1189 instead.
1190
1191 =cut */
1192
1193 STRLEN
1194 Perl_is_utf8_char(const U8 *s)
1195 {
1196     PERL_ARGS_ASSERT_IS_UTF8_CHAR;
1197
1198     /* Assumes we have enough space, which is why this is deprecated.  But the
1199      * UTF8_CHK_SKIP(s)) makes it safe for the common case of NUL-terminated
1200      * strings */
1201     return isUTF8_CHAR(s, s + UTF8_CHK_SKIP(s));
1202 }
1203
1204 /*
1205 =for apidoc is_utf8_char_buf
1206
1207 This is identical to the macro L<perlapi/isUTF8_CHAR>.
1208
1209 =cut */
1210
1211 STRLEN
1212 Perl_is_utf8_char_buf(const U8 *buf, const U8* buf_end)
1213 {
1214
1215     PERL_ARGS_ASSERT_IS_UTF8_CHAR_BUF;
1216
1217     return isUTF8_CHAR(buf, buf_end);
1218 }
1219
1220 /* DEPRECATED!
1221  * Like L</utf8_to_uvuni_buf>(), but should only be called when it is known that
1222  * there are no malformations in the input UTF-8 string C<s>.  Surrogates,
1223  * non-character code points, and non-Unicode code points are allowed */
1224
1225 UV
1226 Perl_valid_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1227 {
1228     PERL_UNUSED_CONTEXT;
1229     PERL_ARGS_ASSERT_VALID_UTF8_TO_UVUNI;
1230
1231     return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1232 }
1233
1234 /*
1235 =for apidoc utf8_to_uvuni
1236
1237 Returns the Unicode code point of the first character in the string C<s>
1238 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1239 length, in bytes, of that character.
1240
1241 Some, but not all, UTF-8 malformations are detected, and in fact, some
1242 malformed input could cause reading beyond the end of the input buffer, which
1243 is one reason why this function is deprecated.  The other is that only in
1244 extremely limited circumstances should the Unicode versus native code point be
1245 of any interest to you.  See L</utf8_to_uvuni_buf> for alternatives.
1246
1247 If C<s> points to one of the detected malformations, and UTF8 warnings are
1248 enabled, zero is returned and C<*retlen> is set (if C<retlen> doesn't point to
1249 NULL) to -1.  If those warnings are off, the computed value if well-defined (or
1250 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1251 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1252 next possible position in C<s> that could begin a non-malformed character.
1253 See L<perlapi/utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1254
1255 =cut
1256 */
1257
1258 UV
1259 Perl_utf8_to_uvuni(pTHX_ const U8 *s, STRLEN *retlen)
1260 {
1261     PERL_UNUSED_CONTEXT;
1262     PERL_ARGS_ASSERT_UTF8_TO_UVUNI;
1263
1264     return NATIVE_TO_UNI(valid_utf8_to_uvchr(s, retlen));
1265 }
1266
1267 /*
1268 =for apidoc pad_compname_type
1269
1270 Looks up the type of the lexical variable at position C<po> in the
1271 currently-compiling pad.  If the variable is typed, the stash of the
1272 class to which it is typed is returned.  If not, C<NULL> is returned.
1273
1274 =cut
1275 */
1276
1277 HV *
1278 Perl_pad_compname_type(pTHX_ const PADOFFSET po)
1279 {
1280     return PAD_COMPNAME_TYPE(po);
1281 }
1282
1283 /* return ptr to little string in big string, NULL if not found */
1284 /* The original version of this routine was donated by Corey Satten. */
1285
1286 char *
1287 Perl_instr(const char *big, const char *little)
1288 {
1289     PERL_ARGS_ASSERT_INSTR;
1290
1291     return instr((char *) big, (char *) little);
1292 }
1293
1294 SV *
1295 Perl_newSVsv(pTHX_ SV *const old)
1296 {
1297     return newSVsv(old);
1298 }
1299
1300 bool
1301 Perl_sv_utf8_downgrade(pTHX_ SV *const sv, const bool fail_ok)
1302 {
1303     PERL_ARGS_ASSERT_SV_UTF8_DOWNGRADE;
1304
1305     return sv_utf8_downgrade(sv, fail_ok);
1306 }
1307
1308 char *
1309 Perl_sv_2pvutf8(pTHX_ SV *sv, STRLEN *const lp)
1310 {
1311     PERL_ARGS_ASSERT_SV_2PVUTF8;
1312
1313     return sv_2pvutf8(sv, lp);
1314 }
1315
1316 char *
1317 Perl_sv_2pvbyte(pTHX_ SV *sv, STRLEN *const lp)
1318 {
1319     PERL_ARGS_ASSERT_SV_2PVBYTE;
1320
1321     return sv_2pvbyte(sv, lp);
1322 }
1323
1324 U8 *
1325 Perl_uvuni_to_utf8(pTHX_ U8 *d, UV uv)
1326 {
1327     PERL_ARGS_ASSERT_UVUNI_TO_UTF8;
1328
1329     return uvoffuni_to_utf8_flags(d, uv, 0);
1330 }
1331
1332 /*
1333 =for apidoc utf8n_to_uvuni
1334
1335 Instead use L<perlapi/utf8_to_uvchr_buf>, or rarely, L<perlapi/utf8n_to_uvchr>.
1336
1337 This function was useful for code that wanted to handle both EBCDIC and
1338 ASCII platforms with Unicode properties, but starting in Perl v5.20, the
1339 distinctions between the platforms have mostly been made invisible to most
1340 code, so this function is quite unlikely to be what you want.  If you do need
1341 this precise functionality, use instead
1342 C<L<NATIVE_TO_UNI(utf8_to_uvchr_buf(...))|perlapi/utf8_to_uvchr_buf>>
1343 or C<L<NATIVE_TO_UNI(utf8n_to_uvchr(...))|perlapi/utf8n_to_uvchr>>.
1344
1345 =cut
1346 */
1347
1348 UV
1349 Perl_utf8n_to_uvuni(pTHX_ const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
1350 {
1351     PERL_ARGS_ASSERT_UTF8N_TO_UVUNI;
1352
1353     return NATIVE_TO_UNI(utf8n_to_uvchr(s, curlen, retlen, flags));
1354 }
1355
1356 /*
1357 =for apidoc uvuni_to_utf8_flags
1358
1359 Instead you almost certainly want to use L<perlapi/uvchr_to_utf8> or
1360 L<perlapi/uvchr_to_utf8_flags>.
1361
1362 This function is a deprecated synonym for L</uvoffuni_to_utf8_flags>,
1363 which itself, while not deprecated, should be used only in isolated
1364 circumstances.  These functions were useful for code that wanted to handle
1365 both EBCDIC and ASCII platforms with Unicode properties, but starting in Perl
1366 v5.20, the distinctions between the platforms have mostly been made invisible
1367 to most code, so this function is quite unlikely to be what you want.
1368
1369 =cut
1370 */
1371
1372 U8 *
1373 Perl_uvuni_to_utf8_flags(pTHX_ U8 *d, UV uv, UV flags)
1374 {
1375     PERL_ARGS_ASSERT_UVUNI_TO_UTF8_FLAGS;
1376
1377     return uvoffuni_to_utf8_flags(d, uv, flags);
1378 }
1379
1380 /*
1381 =for apidoc utf8_to_uvchr
1382
1383 Returns the native code point of the first character in the string C<s>
1384 which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
1385 length, in bytes, of that character.
1386
1387 Some, but not all, UTF-8 malformations are detected, and in fact, some
1388 malformed input could cause reading beyond the end of the input buffer, which
1389 is why this function is deprecated.  Use L</utf8_to_uvchr_buf> instead.
1390
1391 If C<s> points to one of the detected malformations, and UTF8 warnings are
1392 enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
1393 C<NULL>) to -1.  If those warnings are off, the computed value if well-defined (or
1394 the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1395 is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
1396 next possible position in C<s> that could begin a non-malformed character.
1397 See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
1398
1399 =cut
1400 */
1401
1402 UV
1403 Perl_utf8_to_uvchr(pTHX_ const U8 *s, STRLEN *retlen)
1404 {
1405     PERL_ARGS_ASSERT_UTF8_TO_UVCHR;
1406
1407     /* This function is unsafe if malformed UTF-8 input is given it, which is
1408      * why the function is deprecated.  If the first byte of the input
1409      * indicates that there are more bytes remaining in the sequence that forms
1410      * the character than there are in the input buffer, it can read past the
1411      * end.  But we can make it safe if the input string happens to be
1412      * NUL-terminated, as many strings in Perl are, by refusing to read past a
1413      * NUL, which is what UTF8_CHK_SKIP() does.  A NUL indicates the start of
1414      * the next character anyway.  If the input isn't NUL-terminated, the
1415      * function remains unsafe, as it always has been. */
1416
1417     return utf8_to_uvchr_buf(s, s + UTF8_CHK_SKIP(s), retlen);
1418 }
1419
1420 GCC_DIAG_RESTORE
1421
1422 #endif /* NO_MATHOMS */
1423
1424 /*
1425  * ex: set ts=8 sts=4 sw=4 et:
1426  */