This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlsub: Document state variables better
[perl5.git] / warnings.h
CommitLineData
37442d52
RGS
1/* -*- buffer-read-only: t -*-
2 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
78102347 3 This file is built by regen/warnings.pl.
599cee73 4 Any changes made here will be lost!
78102347 5 */
599cee73
PM
6
7
0453d815
PM
8#define Off(x) ((x) / 8)
9#define Bit(x) (1 << ((x) % 8))
599cee73
PM
10#define IsSet(a, x) ((a)[Off(x)] & Bit(x))
11
0453d815 12
599cee73 13#define G_WARN_OFF 0 /* $^W == 0 */
0453d815 14#define G_WARN_ON 1 /* -w flag and $^W != 0 */
599cee73
PM
15#define G_WARN_ALL_ON 2 /* -W flag */
16#define G_WARN_ALL_OFF 4 /* -X flag */
0453d815 17#define G_WARN_ONCE 8 /* set if 'once' ever enabled */
599cee73
PM
18#define G_WARN_ALL_MASK (G_WARN_ALL_ON|G_WARN_ALL_OFF)
19
84b2b14b 20#define pWARN_STD NULL
72dc9ed5
NC
21#define pWARN_ALL (((STRLEN*)0)+1) /* use warnings 'all' */
22#define pWARN_NONE (((STRLEN*)0)+2) /* no warnings 'all' */
599cee73 23
d3a7d8c7
GS
24#define specialWARN(x) ((x) == pWARN_STD || (x) == pWARN_ALL || \
25 (x) == pWARN_NONE)
0d658bf5 26
5f2d9966 27/* if PL_warnhook is set to this value, then warnings die */
06dcd5bf 28#define PERL_WARNHOOK_FATAL (&PL_sv_placeholder)
5f2d9966 29
0d658bf5
PM
30/* Warnings Categories added in Perl 5.008 */
31
d3a7d8c7 32#define WARN_ALL 0
3eae5ce4 33#define WARN_CLOSURE 1
12bcd1a6
PM
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
99ef548b
PM
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
38875929
DM
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
e476b1b5 78
b88df990
NC
79/* Warnings Categories added in Perl 5.011 */
80
81#define WARN_IMPRECISION 46
197afce1 82#define WARN_ILLEGALPROTO 47
b88df990 83
8457b38f
KW
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#define WARNsize 13
91#define WARN_ALLstring "\125\125\125\125\125\125\125\125\125\125\125\125\125"
92#define WARN_NONEstring "\0\0\0\0\0\0\0\0\0\0\0\0\0"
599cee73 93
d5a71f30
GS
94#define isLEXWARN_on (PL_curcop->cop_warnings != pWARN_STD)
95#define isLEXWARN_off (PL_curcop->cop_warnings == pWARN_STD)
96#define isWARN_ONCE (PL_dowarn & (G_WARN_ON|G_WARN_ONCE))
72dc9ed5
NC
97#define isWARN_on(c,x) (IsSet((U8 *)(c + 1), 2*(x)))
98#define isWARNf_on(c,x) (IsSet((U8 *)(c + 1), 2*(x)+1))
99
100#define DUP_WARNINGS(p) \
594cd643
NC
101 (specialWARN(p) ? (STRLEN*)(p) \
102 : (STRLEN*)CopyD(p, PerlMemShared_malloc(sizeof(*p)+*p), sizeof(*p)+*p, \
103 char))
d5a71f30 104
f54ba1c2
DM
105#define ckWARN(w) Perl_ckwarn(aTHX_ packWARN(w))
106#define ckWARN2(w1,w2) Perl_ckwarn(aTHX_ packWARN2(w1,w2))
107#define ckWARN3(w1,w2,w3) Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
108#define ckWARN4(w1,w2,w3,w4) Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))
109
110#define ckWARN_d(w) Perl_ckwarn_d(aTHX_ packWARN(w))
111#define ckWARN2_d(w1,w2) Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
112#define ckWARN3_d(w1,w2,w3) Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
113#define ckWARN4_d(w1,w2,w3,w4) Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))
12bcd1a6 114
98fe6610
NC
115#define WARNshift 8
116
3b9e3074
SH
117#define packWARN(a) (a )
118#define packWARN2(a,b) ((a) | ((b)<<8) )
119#define packWARN3(a,b,c) ((a) | ((b)<<8) | ((c)<<16) )
120#define packWARN4(a,b,c,d) ((a) | ((b)<<8) | ((c)<<16) | ((d) <<24))
12bcd1a6
PM
121
122#define unpackWARN1(x) ((x) & 0xFF)
123#define unpackWARN2(x) (((x) >>8) & 0xFF)
124#define unpackWARN3(x) (((x) >>16) & 0xFF)
125#define unpackWARN4(x) (((x) >>24) & 0xFF)
126
127#define ckDEAD(x) \
128 ( ! specialWARN(PL_curcop->cop_warnings) && \
129 ( isWARNf_on(PL_curcop->cop_warnings, WARN_ALL) || \
130 isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) || \
131 isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) || \
132 isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) || \
133 isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x))))
134
4438c4b7 135/* end of file warnings.h */
ce716c52 136
37442d52 137/* ex: set ro: */