[perl5.git] / warnings.h

/* -*- buffer-read-only: t -*-
   !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
   This file is built by regen/warnings.pl.
   Any changes made here will be lost!
 */


#define Off(x)			((x) / 8)
#define Bit(x)			(1 << ((x) % 8))
#define IsSet(a, x)		((a)[Off(x)] & Bit(x))


#define G_WARN_OFF		0 	/* $^W == 0 */
#define G_WARN_ON		1	/* -w flag and $^W != 0 */
#define G_WARN_ALL_ON		2	/* -W flag */
#define G_WARN_ALL_OFF		4	/* -X flag */
#define G_WARN_ONCE		8	/* set if 'once' ever enabled */
#define G_WARN_ALL_MASK		(G_WARN_ALL_ON|G_WARN_ALL_OFF)

#define pWARN_STD		NULL
#define pWARN_ALL		(((STRLEN*)0)+1)    /* use warnings 'all' */
#define pWARN_NONE		(((STRLEN*)0)+2)    /* no  warnings 'all' */

#define specialWARN(x)		((x) == pWARN_STD || (x) == pWARN_ALL ||	\
				 (x) == pWARN_NONE)

/* if PL_warnhook is set to this value, then warnings die */
#define PERL_WARNHOOK_FATAL	(&PL_sv_placeholder)

/* Warnings Categories added in Perl 5.008 */

#define WARN_ALL			 0
#define WARN_CLOSURE			 1
#define WARN_DEPRECATED			 2
#define WARN_EXITING			 3
#define WARN_GLOB			 4
#define WARN_IO				 5
#define WARN_CLOSED			 6
#define WARN_EXEC			 7
#define WARN_LAYER			 8
#define WARN_NEWLINE			 9
#define WARN_PIPE			 10
#define WARN_UNOPENED			 11
#define WARN_MISC			 12
#define WARN_NUMERIC			 13
#define WARN_ONCE			 14
#define WARN_OVERFLOW			 15
#define WARN_PACK			 16
#define WARN_PORTABLE			 17
#define WARN_RECURSION			 18
#define WARN_REDEFINE			 19
#define WARN_REGEXP			 20
#define WARN_SEVERE			 21
#define WARN_DEBUGGING			 22
#define WARN_INPLACE			 23
#define WARN_INTERNAL			 24
#define WARN_MALLOC			 25
#define WARN_SIGNAL			 26
#define WARN_SUBSTR			 27
#define WARN_SYNTAX			 28
#define WARN_AMBIGUOUS			 29
#define WARN_BAREWORD			 30
#define WARN_DIGIT			 31
#define WARN_PARENTHESIS		 32
#define WARN_PRECEDENCE			 33
#define WARN_PRINTF			 34
#define WARN_PROTOTYPE			 35
#define WARN_QW				 36
#define WARN_RESERVED			 37
#define WARN_SEMICOLON			 38
#define WARN_TAINT			 39
#define WARN_THREADS			 40
#define WARN_UNINITIALIZED		 41
#define WARN_UNPACK			 42
#define WARN_UNTIE			 43
#define WARN_UTF8			 44
#define WARN_VOID			 45

/* Warnings Categories added in Perl 5.011 */

#define WARN_IMPRECISION		 46
#define WARN_ILLEGALPROTO		 47

/* Warnings Categories added in Perl 5.013 */

#define WARN_NON_UNICODE		 48
#define WARN_NONCHAR			 49
#define WARN_SURROGATE			 50

/* Warnings Categories added in Perl 5.017 */

#define WARN_EXPERIMENTAL		 51
#define WARN_EXPERIMENTAL__LEXICAL_SUBS	 52
#define WARN_EXPERIMENTAL__REGEX_SETS	 53
#define WARN_EXPERIMENTAL__SMARTMATCH	 54

/* Warnings Categories added in Perl 5.019 */

#define WARN_EXPERIMENTAL__POSTDEREF	 55
#define WARN_EXPERIMENTAL__SIGNATURES	 56
#define WARN_SYSCALLS			 57

/* Warnings Categories added in Perl 5.021 */

#define WARN_EXPERIMENTAL__BITWISE	 58
#define WARN_EXPERIMENTAL__CONST_ATTR	 59
#define WARN_EXPERIMENTAL__RE_STRICT	 60
#define WARN_EXPERIMENTAL__REFALIASING	 61
#define WARN_EXPERIMENTAL__WIN32_PERLIO	 62
#define WARN_LOCALE			 63
#define WARN_MISSING			 64
#define WARN_REDUNDANT			 65

/* Warnings Categories added in Perl 5.025 */

#define WARN_EXPERIMENTAL__DECLARED_REFS 66

/* Warnings Categories added in Perl 5.027 */

#define WARN_EXPERIMENTAL__ALPHA_ASSERTIONS 67
#define WARN_EXPERIMENTAL__SCRIPT_RUN	 68
#define WARN_SHADOW			 69

#define WARNsize			 18
#define WARN_ALLstring			 "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
#define WARN_NONEstring			 "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"

#define isLEXWARN_on \
	cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
#define isLEXWARN_off \
	cBOOL(!PL_curcop || PL_curcop->cop_warnings == pWARN_STD)
#define isWARN_ONCE	(PL_dowarn & (G_WARN_ON|G_WARN_ONCE))
#define isWARN_on(c,x)	(IsSet((U8 *)(c + 1), 2*(x)))
#define isWARNf_on(c,x)	(IsSet((U8 *)(c + 1), 2*(x)+1))

#define DUP_WARNINGS(p)		\
    (specialWARN(p) ? (STRLEN*)(p)	\
    : (STRLEN*)CopyD(p, PerlMemShared_malloc(sizeof(*p)+*p), sizeof(*p)+*p, \
		     			     char))

/*

=head1 Warning and Dieing

=for apidoc Am|bool|ckWARN|U32 w

Returns a boolean as to whether or not warnings are enabled for the warning
category C<w>.  If the category is by default enabled even if not within the
scope of S<C<use warnings>>, instead use the L</ckWARN_d> macro.

=for apidoc Am|bool|ckWARN_d|U32 w

Like C<L</ckWARN>>, but for use if and only if the warning category is by
default enabled even if not within the scope of S<C<use warnings>>.

=for apidoc Am|bool|ckWARN2|U32 w1|U32 w2

Like C<L</ckWARN>>, but takes two warnings categories as input, and returns
TRUE if either is enabled.  If either category is by default enabled even if
not within the scope of S<C<use warnings>>, instead use the L</ckWARN2_d>
macro.  The categories must be completely independent, one may not be
subclassed from the other.

=for apidoc Am|bool|ckWARN2_d|U32 w1|U32 w2

Like C<L</ckWARN2>>, but for use if and only if either warning category is by
default enabled even if not within the scope of S<C<use warnings>>.

=for apidoc Am|bool|ckWARN3|U32 w1|U32 w2|U32 w3

Like C<L</ckWARN2>>, but takes three warnings categories as input, and returns
TRUE if any is enabled.  If any of the categories is by default enabled even
if not within the scope of S<C<use warnings>>, instead use the L</ckWARN3_d>
macro.  The categories must be completely independent, one may not be
subclassed from any other.

=for apidoc Am|bool|ckWARN3_d|U32 w1|U32 w2|U32 w3

Like C<L</ckWARN3>>, but for use if and only if any of the warning categories
is by default enabled even if not within the scope of S<C<use warnings>>.

=for apidoc Am|bool|ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4

Like C<L</ckWARN3>>, but takes four warnings categories as input, and returns
TRUE if any is enabled.  If any of the categories is by default enabled even
if not within the scope of S<C<use warnings>>, instead use the L</ckWARN4_d>
macro.  The categories must be completely independent, one may not be
subclassed from any other.

=for apidoc Am|bool|ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4

Like C<L</ckWARN4>>, but for use if and only if any of the warning categories
is by default enabled even if not within the scope of S<C<use warnings>>.

=cut

*/

#define ckWARN(w)		Perl_ckwarn(aTHX_ packWARN(w))

/* The w1, w2 ... should be independent warnings categories; one shouldn't be
 * a subcategory of any other */

#define ckWARN2(w1,w2)		Perl_ckwarn(aTHX_ packWARN2(w1,w2))
#define ckWARN3(w1,w2,w3)	Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
#define ckWARN4(w1,w2,w3,w4)	Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))

#define ckWARN_d(w)		Perl_ckwarn_d(aTHX_ packWARN(w))
#define ckWARN2_d(w1,w2)	Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
#define ckWARN3_d(w1,w2,w3)	Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
#define ckWARN4_d(w1,w2,w3,w4)	Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))

#define WARNshift		8

#define packWARN(a)		(a                                      )

/* The a, b, ... should be independent warnings categories; one shouldn't be
 * a subcategory of any other */

#define packWARN2(a,b)		((a) | ((b)<<8)                         )
#define packWARN3(a,b,c)	((a) | ((b)<<8) | ((c)<<16)             )
#define packWARN4(a,b,c,d)	((a) | ((b)<<8) | ((c)<<16) | ((d) <<24))

#define unpackWARN1(x)		((x)        & 0xFF)
#define unpackWARN2(x)		(((x) >>8)  & 0xFF)
#define unpackWARN3(x)		(((x) >>16) & 0xFF)
#define unpackWARN4(x)		(((x) >>24) & 0xFF)

#define ckDEAD(x)							\
   (PL_curcop &&                                                        \
    !specialWARN(PL_curcop->cop_warnings) &&			        \
    (isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) ||	        \
      (unpackWARN2(x) &&                                                \
	(isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) ||	        \
	  (unpackWARN3(x) &&                                            \
	    (isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) ||	\
	      (unpackWARN4(x) &&                                        \
		isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))

/* end of file warnings.h */

/* ex: set ro: */
Commit	Line	Data
37442d52 RGS	1	/* -- buffer-read-only: t --
37442d52 RGS	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
599cee73 PM	7
0453d815 PM	8	#define Off(x) ((x) / 8)
0453d815 PM	9	#define Bit(x) (1 << ((x) % 8))
599cee73 PM	10	#define IsSet(a, x) ((a)[Off(x)] & Bit(x))
599cee73 PM	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 */
599cee73 PM	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)
599cee73 PM	19
84b2b14b	20	#define pWARN_STD NULL
72dc9ed5 NC	21	#define pWARN_ALL (((STRLEN)0)+1) / use warnings 'all' */
72dc9ed5 NC	22	#define pWARN_NONE (((STRLEN)0)+2) / no warnings 'all' */
599cee73	23
d3a7d8c7 GS	24	#define specialWARN(x) ((x) == pWARN_STD \|\| (x) == pWARN_ALL \|\| \
d3a7d8c7 GS	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 */
0d658bf5 PM	31
3c3f8cd6 AB	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
e476b1b5	78
b88df990 NC	79	/* Warnings Categories added in Perl 5.011 */
b88df990 NC	80
3c3f8cd6 AB	81	#define WARN_IMPRECISION 46
3c3f8cd6 AB	82	#define WARN_ILLEGALPROTO 47
b88df990	83
8457b38f KW	84	/* Warnings Categories added in Perl 5.013 */
8457b38f KW	85
3c3f8cd6 AB	86	#define WARN_NON_UNICODE 48
	87	#define WARN_NONCHAR 49
	88	#define WARN_SURROGATE 50
8457b38f	89
6f87cb12 FC	90	/* Warnings Categories added in Perl 5.017 */
6f87cb12 FC	91
3c3f8cd6 AB	92	#define WARN_EXPERIMENTAL 51
3c3f8cd6 AB	93	#define WARN_EXPERIMENTAL__LEXICAL_SUBS 52
c29314de FC	94	#define WARN_EXPERIMENTAL__REGEX_SETS 53
c29314de FC	95	#define WARN_EXPERIMENTAL__SMARTMATCH 54
6f87cb12	96
c8028aa6 TC	97	/* Warnings Categories added in Perl 5.019 */
c8028aa6 TC	98
c29314de FC	99	#define WARN_EXPERIMENTAL__POSTDEREF 55
	100	#define WARN_EXPERIMENTAL__SIGNATURES 56
	101	#define WARN_SYSCALLS 57
c8028aa6	102
7ac92924 TC	103	/* Warnings Categories added in Perl 5.021 */
7ac92924 TC	104
c29314de FC	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
3c3f8cd6	113
88d5dae9 FC	114	/* Warnings Categories added in Perl 5.025 */
	115
	116	#define WARN_EXPERIMENTAL__DECLARED_REFS 66
	117
52e3acf8 Z	118	/* Warnings Categories added in Perl 5.027 */
52e3acf8 Z	119
948f26d8 KW	120	#define WARN_EXPERIMENTAL__ALPHA_ASSERTIONS 67
	121	#define WARN_EXPERIMENTAL__SCRIPT_RUN 68
	122	#define WARN_SHADOW 69
52e3acf8	123
0d76344b KW	124	#define WARNsize 18
	125	#define WARN_ALLstring "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
	126	#define WARN_NONEstring "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
599cee73	127
a2637ca0 FC	128	#define isLEXWARN_on \
	129	cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
	130	#define isLEXWARN_off \
	131	cBOOL(!PL_curcop \|\| PL_curcop->cop_warnings == pWARN_STD)
d5a71f30	132	#define isWARN_ONCE (PL_dowarn & (G_WARN_ON\|G_WARN_ONCE))
72dc9ed5 NC	133	#define isWARN_on(c,x) (IsSet((U8 )(c + 1), 2(x)))
	134	#define isWARNf_on(c,x) (IsSet((U8 )(c + 1), 2(x)+1))
	135
	136	#define DUP_WARNINGS(p) \
594cd643 NC	137	(specialWARN(p) ? (STRLEN*)(p) \
	138	: (STRLEN)CopyD(p, PerlMemShared_malloc(sizeof(p)+p), sizeof(p)+*p, \
	139	char))
d5a71f30	140
feff94e1 KW	141	/*
	142
	143	=head1 Warning and Dieing
	144
	145	=for apidoc Am\|bool\|ckWARN\|U32 w
	146
	147	Returns a boolean as to whether or not warnings are enabled for the warning
	148	category C<w>. If the category is by default enabled even if not within the
	149	scope of S<C<use warnings>>, instead use the L</ckWARN_d> macro.
	150
	151	=for apidoc Am\|bool\|ckWARN_d\|U32 w
	152
	153	Like C<L</ckWARN>>, but for use if and only if the warning category is by
	154	default enabled even if not within the scope of S<C<use warnings>>.
	155
	156	=for apidoc Am\|bool\|ckWARN2\|U32 w1\|U32 w2
	157
	158	Like C<L</ckWARN>>, but takes two warnings categories as input, and returns
	159	TRUE if either is enabled. If either category is by default enabled even if
	160	not within the scope of S<C<use warnings>>, instead use the L</ckWARN2_d>
	161	macro. The categories must be completely independent, one may not be
	162	subclassed from the other.
	163
	164	=for apidoc Am\|bool\|ckWARN2_d\|U32 w1\|U32 w2
	165
	166	Like C<L</ckWARN2>>, but for use if and only if either warning category is by
	167	default enabled even if not within the scope of S<C<use warnings>>.
	168
	169	=for apidoc Am\|bool\|ckWARN3\|U32 w1\|U32 w2\|U32 w3
	170
	171	Like C<L</ckWARN2>>, but takes three warnings categories as input, and returns
	172	TRUE if any is enabled. If any of the categories is by default enabled even
	173	if not within the scope of S<C<use warnings>>, instead use the L</ckWARN3_d>
	174	macro. The categories must be completely independent, one may not be
	175	subclassed from any other.
	176
	177	=for apidoc Am\|bool\|ckWARN3_d\|U32 w1\|U32 w2\|U32 w3
	178
	179	Like C<L</ckWARN3>>, but for use if and only if any of the warning categories
	180	is by default enabled even if not within the scope of S<C<use warnings>>.
	181
	182	=for apidoc Am\|bool\|ckWARN4\|U32 w1\|U32 w2\|U32 w3\|U32 w4
	183
	184	Like C<L</ckWARN3>>, but takes four warnings categories as input, and returns
	185	TRUE if any is enabled. If any of the categories is by default enabled even
	186	if not within the scope of S<C<use warnings>>, instead use the L</ckWARN4_d>
	187	macro. The categories must be completely independent, one may not be
	188	subclassed from any other.
	189
	190	=for apidoc Am\|bool\|ckWARN4_d\|U32 w1\|U32 w2\|U32 w3\|U32 w4
	191
	192	Like C<L</ckWARN4>>, but for use if and only if any of the warning categories
	193	is by default enabled even if not within the scope of S<C<use warnings>>.
	194
	195	=cut
	196
	197	*/
	198
f54ba1c2	199	#define ckWARN(w) Perl_ckwarn(aTHX_ packWARN(w))
7c08c4c5 KW	200
	201	/* The w1, w2 ... should be independent warnings categories; one shouldn't be
	202	* a subcategory of any other */
	203
f54ba1c2 DM	204	#define ckWARN2(w1,w2) Perl_ckwarn(aTHX_ packWARN2(w1,w2))
	205	#define ckWARN3(w1,w2,w3) Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
	206	#define ckWARN4(w1,w2,w3,w4) Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))
	207
	208	#define ckWARN_d(w) Perl_ckwarn_d(aTHX_ packWARN(w))
	209	#define ckWARN2_d(w1,w2) Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
	210	#define ckWARN3_d(w1,w2,w3) Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
	211	#define ckWARN4_d(w1,w2,w3,w4) Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))
12bcd1a6	212
98fe6610 NC	213	#define WARNshift 8
98fe6610 NC	214
3b9e3074	215	#define packWARN(a) (a )
7c08c4c5 KW	216
	217	/* The a, b, ... should be independent warnings categories; one shouldn't be
	218	* a subcategory of any other */
	219
3b9e3074 SH	220	#define packWARN2(a,b) ((a) \| ((b)<<8) )
	221	#define packWARN3(a,b,c) ((a) \| ((b)<<8) \| ((c)<<16) )
	222	#define packWARN4(a,b,c,d) ((a) \| ((b)<<8) \| ((c)<<16) \| ((d) <<24))
12bcd1a6 PM	223
	224	#define unpackWARN1(x) ((x) & 0xFF)
	225	#define unpackWARN2(x) (((x) >>8) & 0xFF)
	226	#define unpackWARN3(x) (((x) >>16) & 0xFF)
	227	#define unpackWARN4(x) (((x) >>24) & 0xFF)
	228
	229	#define ckDEAD(x) \
006c1a1d Z	230	(PL_curcop && \
	231	!specialWARN(PL_curcop->cop_warnings) && \
	232	(isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) \|\| \
	233	(unpackWARN2(x) && \
	234	(isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) \|\| \
	235	(unpackWARN3(x) && \
	236	(isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) \|\| \
	237	(unpackWARN4(x) && \
	238	isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
12bcd1a6	239
4438c4b7	240	/* end of file warnings.h */
ce716c52	241
37442d52	242	/* ex: set ro: */