warnings.h

   1 /* -*- buffer-read-only: t -*-
   2    !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
   3    This file is built by regen/warnings.pl.
   4    Any changes made here will be lost!
   5  */
   6
   7
   8 #define Off(x)                  ((x) / 8)
   9 #define Bit(x)                  (1 << ((x) % 8))
  10 #define IsSet(a, x)             ((a)[Off(x)] & Bit(x))
  11
  12
  13 #define G_WARN_OFF              0       /* $^W == 0 */
  14 #define G_WARN_ON               1       /* -w flag and $^W != 0 */
  15 #define G_WARN_ALL_ON           2       /* -W flag */
  16 #define G_WARN_ALL_OFF          4       /* -X flag */
  17 #define G_WARN_ONCE             8       /* set if 'once' ever enabled */
  18 #define G_WARN_ALL_MASK         (G_WARN_ALL_ON|G_WARN_ALL_OFF)
  19
  20 #define pWARN_STD               NULL
  21 #define pWARN_ALL               (((STRLEN*)0)+1)    /* use warnings 'all' */
  22 #define pWARN_NONE              (((STRLEN*)0)+2)    /* no  warnings 'all' */
  23
  24 #define specialWARN(x)          ((x) == pWARN_STD || (x) == pWARN_ALL ||        \
  25                                  (x) == pWARN_NONE)
  26
  27 /* if PL_warnhook is set to this value, then warnings die */
  28 #define PERL_WARNHOOK_FATAL     (&PL_sv_placeholder)
  29
  30 /* Warnings Categories added in Perl 5.008 */
  31
  32 #define WARN_ALL                         0
  33 #define WARN_CLOSURE                     1
  34 #define WARN_DEPRECATED                  2
  35 #define WARN_EXITING                     3
  36 #define WARN_GLOB                        4
  37 #define WARN_IO                          5
  38 #define WARN_CLOSED                      6
  39 #define WARN_EXEC                        7
  40 #define WARN_LAYER                       8
  41 #define WARN_NEWLINE                     9
  42 #define WARN_PIPE                        10
  43 #define WARN_UNOPENED                    11
  44 #define WARN_MISC                        12
  45 #define WARN_NUMERIC                     13
  46 #define WARN_ONCE                        14
  47 #define WARN_OVERFLOW                    15
  48 #define WARN_PACK                        16
  49 #define WARN_PORTABLE                    17
  50 #define WARN_RECURSION                   18
  51 #define WARN_REDEFINE                    19
  52 #define WARN_REGEXP                      20
  53 #define WARN_SEVERE                      21
  54 #define WARN_DEBUGGING                   22
  55 #define WARN_INPLACE                     23
  56 #define WARN_INTERNAL                    24
  57 #define WARN_MALLOC                      25
  58 #define WARN_SIGNAL                      26
  59 #define WARN_SUBSTR                      27
  60 #define WARN_SYNTAX                      28
  61 #define WARN_AMBIGUOUS                   29
  62 #define WARN_BAREWORD                    30
  63 #define WARN_DIGIT                       31
  64 #define WARN_PARENTHESIS                 32
  65 #define WARN_PRECEDENCE                  33
  66 #define WARN_PRINTF                      34
  67 #define WARN_PROTOTYPE                   35
  68 #define WARN_QW                          36
  69 #define WARN_RESERVED                    37
  70 #define WARN_SEMICOLON                   38
  71 #define WARN_TAINT                       39
  72 #define WARN_THREADS                     40
  73 #define WARN_UNINITIALIZED               41
  74 #define WARN_UNPACK                      42
  75 #define WARN_UNTIE                       43
  76 #define WARN_UTF8                        44
  77 #define WARN_VOID                        45
  78
  79 /* Warnings Categories added in Perl 5.011 */
  80
  81 #define WARN_IMPRECISION                 46
  82 #define WARN_ILLEGALPROTO                47
  83
  84 /* Warnings Categories added in Perl 5.013 */
  85
  86 #define WARN_NON_UNICODE                 48
  87 #define WARN_NONCHAR                     49
  88 #define WARN_SURROGATE                   50
  89
  90 /* Warnings Categories added in Perl 5.017 */
  91
  92 #define WARN_EXPERIMENTAL                51
  93 #define WARN_EXPERIMENTAL__LEXICAL_SUBS  52
  94 #define WARN_EXPERIMENTAL__REGEX_SETS    53
  95 #define WARN_EXPERIMENTAL__SMARTMATCH    54
  96
  97 /* Warnings Categories added in Perl 5.019 */
  98
  99 #define WARN_EXPERIMENTAL__POSTDEREF     55
 100 #define WARN_EXPERIMENTAL__SIGNATURES    56
 101 #define WARN_SYSCALLS                    57
 102
 103 /* Warnings Categories added in Perl 5.021 */
 104
 105 #define WARN_EXPERIMENTAL__BITWISE       58
 106 #define WARN_EXPERIMENTAL__CONST_ATTR    59
 107 #define WARN_EXPERIMENTAL__RE_STRICT     60
 108 #define WARN_EXPERIMENTAL__REFALIASING   61
 109 #define WARN_EXPERIMENTAL__WIN32_PERLIO  62
 110 #define WARN_LOCALE                      63
 111 #define WARN_MISSING                     64
 112 #define WARN_REDUNDANT                   65
 113
 114 /* Warnings Categories added in Perl 5.025 */
 115
 116 #define WARN_EXPERIMENTAL__DECLARED_REFS 66
 117
 118 /* Warnings Categories added in Perl 5.027 */
 119
 120 #define WARN_SHADOW                      67
 121
 122 #define WARNsize                         17
 123 #define WARN_ALLstring                   "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
 124 #define WARN_NONEstring                  "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
 125
 126 #define isLEXWARN_on \
 127         cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
 128 #define isLEXWARN_off \
 129         cBOOL(!PL_curcop || PL_curcop->cop_warnings == pWARN_STD)
 130 #define isWARN_ONCE     (PL_dowarn & (G_WARN_ON|G_WARN_ONCE))
 131 #define isWARN_on(c,x)  (IsSet((U8 *)(c + 1), 2*(x)))
 132 #define isWARNf_on(c,x) (IsSet((U8 *)(c + 1), 2*(x)+1))
 133
 134 #define DUP_WARNINGS(p)         \
 135     (specialWARN(p) ? (STRLEN*)(p)      \
 136     : (STRLEN*)CopyD(p, PerlMemShared_malloc(sizeof(*p)+*p), sizeof(*p)+*p, \
 137                                              char))
 138
 139 /*
 140
 141 =head1 Warning and Dieing
 142
 143 =for apidoc Am|bool|ckWARN|U32 w
 144
 145 Returns a boolean as to whether or not warnings are enabled for the warning
 146 category C<w>.  If the category is by default enabled even if not within the
 147 scope of S<C<use warnings>>, instead use the L</ckWARN_d> macro.
 148
 149 =for apidoc Am|bool|ckWARN_d|U32 w
 150
 151 Like C<L</ckWARN>>, but for use if and only if the warning category is by
 152 default enabled even if not within the scope of S<C<use warnings>>.
 153
 154 =for apidoc Am|bool|ckWARN2|U32 w1|U32 w2
 155
 156 Like C<L</ckWARN>>, but takes two warnings categories as input, and returns
 157 TRUE if either is enabled.  If either category is by default enabled even if
 158 not within the scope of S<C<use warnings>>, instead use the L</ckWARN2_d>
 159 macro.  The categories must be completely independent, one may not be
 160 subclassed from the other.
 161
 162 =for apidoc Am|bool|ckWARN2_d|U32 w1|U32 w2
 163
 164 Like C<L</ckWARN2>>, but for use if and only if either warning category is by
 165 default enabled even if not within the scope of S<C<use warnings>>.
 166
 167 =for apidoc Am|bool|ckWARN3|U32 w1|U32 w2|U32 w3
 168
 169 Like C<L</ckWARN2>>, but takes three warnings categories as input, and returns
 170 TRUE if any is enabled.  If any of the categories is by default enabled even
 171 if not within the scope of S<C<use warnings>>, instead use the L</ckWARN3_d>
 172 macro.  The categories must be completely independent, one may not be
 173 subclassed from any other.
 174
 175 =for apidoc Am|bool|ckWARN3_d|U32 w1|U32 w2|U32 w3
 176
 177 Like C<L</ckWARN3>>, but for use if and only if any of the warning categories
 178 is by default enabled even if not within the scope of S<C<use warnings>>.
 179
 180 =for apidoc Am|bool|ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4
 181
 182 Like C<L</ckWARN3>>, but takes four warnings categories as input, and returns
 183 TRUE if any is enabled.  If any of the categories is by default enabled even
 184 if not within the scope of S<C<use warnings>>, instead use the L</ckWARN4_d>
 185 macro.  The categories must be completely independent, one may not be
 186 subclassed from any other.
 187
 188 =for apidoc Am|bool|ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4
 189
 190 Like C<L</ckWARN4>>, but for use if and only if any of the warning categories
 191 is by default enabled even if not within the scope of S<C<use warnings>>.
 192
 193 =cut
 194
 195 */
 196
 197 #define ckWARN(w)               Perl_ckwarn(aTHX_ packWARN(w))
 198
 199 /* The w1, w2 ... should be independent warnings categories; one shouldn't be
 200  * a subcategory of any other */
 201
 202 #define ckWARN2(w1,w2)          Perl_ckwarn(aTHX_ packWARN2(w1,w2))
 203 #define ckWARN3(w1,w2,w3)       Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
 204 #define ckWARN4(w1,w2,w3,w4)    Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))
 205
 206 #define ckWARN_d(w)             Perl_ckwarn_d(aTHX_ packWARN(w))
 207 #define ckWARN2_d(w1,w2)        Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
 208 #define ckWARN3_d(w1,w2,w3)     Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
 209 #define ckWARN4_d(w1,w2,w3,w4)  Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))
 210
 211 #define WARNshift               8
 212
 213 #define packWARN(a)             (a                                      )
 214
 215 /* The a, b, ... should be independent warnings categories; one shouldn't be
 216  * a subcategory of any other */
 217
 218 #define packWARN2(a,b)          ((a) | ((b)<<8)                         )
 219 #define packWARN3(a,b,c)        ((a) | ((b)<<8) | ((c)<<16)             )
 220 #define packWARN4(a,b,c,d)      ((a) | ((b)<<8) | ((c)<<16) | ((d) <<24))
 221
 222 #define unpackWARN1(x)          ((x)        & 0xFF)
 223 #define unpackWARN2(x)          (((x) >>8)  & 0xFF)
 224 #define unpackWARN3(x)          (((x) >>16) & 0xFF)
 225 #define unpackWARN4(x)          (((x) >>24) & 0xFF)
 226
 227 #define ckDEAD(x)                                                       \
 228    (PL_curcop &&                                                        \
 229     !specialWARN(PL_curcop->cop_warnings) &&                            \
 230     (isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) ||             \
 231       (unpackWARN2(x) &&                                                \
 232         (isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) ||         \
 233           (unpackWARN3(x) &&                                            \
 234             (isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) ||     \
 235               (unpackWARN4(x) &&                                        \
 236                 isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
 237
 238 /* end of file warnings.h */
 239
 240 /* ex: set ro: */