inline.h

   1 /*    inline.h
   2  *
   3  *    Copyright (C) 2012 by Larry Wall and others
   4  *
   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.
   7  *
   8  * This file is a home for static inline functions that cannot go in other
   9  * headers files, because they depend on proto.h (included after most other
  10  * headers) or struct definitions.
  11  *
  12  * Each section names the header file that the functions "belong" to.
  13  */
  14
  15 /* ------------------------------- cv.h ------------------------------- */
  16
  17 PERL_STATIC_INLINE I32 *
  18 S_CvDEPTHp(const CV * const sv)
  19 {
  20     assert(SvTYPE(sv) == SVt_PVCV || SvTYPE(sv) == SVt_PVFM);
  21     return &((XPVCV*)SvANY(sv))->xcv_depth;
  22 }
  23
  24 /* ----------------------------- regexp.h ----------------------------- */
  25
  26 PERL_STATIC_INLINE struct regexp *
  27 S_ReANY(const REGEXP * const re)
  28 {
  29     assert(isREGEXP(re));
  30     return re->sv_u.svu_rx;
  31 }
  32
  33 /* ------------------------------- sv.h ------------------------------- */
  34
  35 PERL_STATIC_INLINE SV *
  36 S_SvREFCNT_inc(SV *sv)
  37 {
  38     if (sv)
  39         SvREFCNT(sv)++;
  40     return sv;
  41 }
  42 PERL_STATIC_INLINE SV *
  43 S_SvREFCNT_inc_NN(SV *sv)
  44 {
  45     SvREFCNT(sv)++;
  46     return sv;
  47 }
  48 PERL_STATIC_INLINE void
  49 S_SvREFCNT_inc_void(SV *sv)
  50 {
  51     if (sv)
  52         SvREFCNT(sv)++;
  53 }
  54 PERL_STATIC_INLINE void
  55 S_SvREFCNT_dec(pTHX_ SV *sv)
  56 {
  57     if (sv) {
  58         if (SvREFCNT(sv)) {
  59             if (--(SvREFCNT(sv)) == 0)
  60                 Perl_sv_free2(aTHX_ sv);
  61         } else {
  62             sv_free(sv);
  63         }
  64     }
  65 }
  66
  67 PERL_STATIC_INLINE void
  68 SvAMAGIC_on(SV *sv)
  69 {
  70     assert(SvROK(sv));
  71     if (SvOBJECT(SvRV(sv))) HvAMAGIC_on(SvSTASH(SvRV(sv)));
  72 }
  73 PERL_STATIC_INLINE void
  74 SvAMAGIC_off(SV *sv)
  75 {
  76     if (SvROK(sv) && SvOBJECT(SvRV(sv)))
  77         HvAMAGIC_off(SvSTASH(SvRV(sv)));
  78 }
  79
  80 PERL_STATIC_INLINE U32
  81 S_SvPADTMP_on(SV *sv)
  82 {
  83     assert(!(SvFLAGS(sv) & SVs_PADMY));
  84     return SvFLAGS(sv) |= SVs_PADTMP;
  85 }
  86 PERL_STATIC_INLINE U32
  87 S_SvPADTMP_off(SV *sv)
  88 {
  89     assert(!(SvFLAGS(sv) & SVs_PADMY));
  90     return SvFLAGS(sv) &= ~SVs_PADTMP;
  91 }
  92 PERL_STATIC_INLINE U32
  93 S_SvPADSTALE_on(SV *sv)
  94 {
  95     assert(SvFLAGS(sv) & SVs_PADMY);
  96     return SvFLAGS(sv) |= SVs_PADSTALE;
  97 }
  98 PERL_STATIC_INLINE U32
  99 S_SvPADSTALE_off(SV *sv)
 100 {
 101     assert(SvFLAGS(sv) & SVs_PADMY);
 102     return SvFLAGS(sv) &= ~SVs_PADSTALE;
 103 }
 104 #ifdef PERL_CORE
 105 PERL_STATIC_INLINE STRLEN
 106 S_sv_or_pv_pos_u2b(pTHX_ SV *sv, const char *pv, STRLEN pos, STRLEN *lenp)
 107 {
 108     if (SvGAMAGIC(sv)) {
 109         U8 *hopped = utf8_hop((U8 *)pv, pos);
 110         if (lenp) *lenp = (STRLEN)(utf8_hop(hopped, *lenp) - hopped);
 111         return (STRLEN)(hopped - (U8 *)pv);
 112     }
 113     return sv_pos_u2b_flags(sv,pos,lenp,SV_CONST_RETURN);
 114 }
 115 #endif
 116
 117 /* ------------------------------- handy.h ------------------------------- */
 118
 119 /* saves machine code for a common noreturn idiom typically used in Newx*() */
 120 static void
 121 S_croak_memory_wrap(void)
 122 {
 123     Perl_croak_nocontext("%s",PL_memory_wrap);
 124 }