[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 Perl_Warn_Off_(x)           ((x) / 8)
#define Perl_Warn_Bit_(x)           (1 << ((x) % 8))
#define PerlWarnIsSet_(a, x)        ((a)[Perl_Warn_Off_(x)] & Perl_Warn_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 *) &PL_WARN_ALL    /* use warnings 'all' */
#define pWARN_NONE		(STRLEN *) &PL_WARN_NONE   /* 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

/* Warnings Categories added in Perl 5.029 */

#define WARN_EXPERIMENTAL__PRIVATE_USE	 70
#define WARN_EXPERIMENTAL__UNIPROP_WILDCARDS 71
#define WARN_EXPERIMENTAL__VLB		 72

/* Warnings Categories added in Perl 5.031 */

#define WARN_EXPERIMENTAL__ISA		 73
#define WARNsize			 19
#define WARN_ALLstring			 "\125\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\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)	(PerlWarnIsSet_((U8 *)(c + 1), 2*(x)))
#define isWARNf_on(c,x)	(PerlWarnIsSet_((U8 *)(c + 1), 2*(x)+1))

#define DUP_WARNINGS(p) Perl_dup_warnings(aTHX_ p)

#define free_and_set_cop_warnings(cmp,w) STMT_START { \
  if (!specialWARN((cmp)->cop_warnings)) PerlMemShared_free((cmp)->cop_warnings); \
  (cmp)->cop_warnings = w; \
} STMT_END

/*

=head1 Warning and Dieing

In all these calls, the C<U32 wI<n>> parameters are warning category
constants.  You can see the ones currently available in
L<warnings/Category Hierarchy>, just capitalize all letters in the names
and prefix them by C<WARN_>.  So, for example, the category C<void> used in a
perl program becomes C<WARN_VOID> when used in XS code and passed to one of
the calls below.

=for apidoc Am|bool|ckWARN|U32 w
=for apidoc_item ||ckWARN2|U32 w1|U32 w2
=for apidoc_item ||ckWARN3|U32 w1|U32 w2|U32 w3
=for apidoc_item ||ckWARN4|U32 w1|U32 w2|U32 w3|U32 w4
These return a boolean as to whether or not warnings are enabled for any of
the warning category(ies) parameters:  C<w>, C<w1>, ....

Should any of the categories by default be enabled even if not within the
scope of S<C<use warnings>>, instead use the C<L</ckWARN_d>> macros.

The categories must be completely independent, one may not be subclassed from
the other.

=for apidoc Am|bool|ckWARN_d|U32 w
=for apidoc_item ||ckWARN2_d|U32 w1|U32 w2
=for apidoc_item ||ckWARN3_d|U32 w1|U32 w2|U32 w3
=for apidoc_item ||ckWARN4_d|U32 w1|U32 w2|U32 w3|U32 w4

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

=for apidoc Am|U32|packWARN|U32 w1
=for apidoc_item ||packWARN2|U32 w1|U32 w2
=for apidoc_item ||packWARN3|U32 w1|U32 w2|U32 w3
=for apidoc_item ||packWARN4|U32 w1|U32 w2|U32 w3|U32 w4

These macros are used to pack warning categories into a single U32 to pass to
macros and functions that take a warning category parameter.  The number of
categories to pack is given by the name, with a corresponding number of
category parameters passed.

=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)))))))))


/*
=for apidoc Amnh||WARN_ALL
=for apidoc Amnh||WARN_CLOSURE
=for apidoc Amnh||WARN_DEPRECATED
=for apidoc Amnh||WARN_EXITING
=for apidoc Amnh||WARN_GLOB
=for apidoc Amnh||WARN_IO
=for apidoc Amnh||WARN_CLOSED
=for apidoc Amnh||WARN_EXEC
=for apidoc Amnh||WARN_LAYER
=for apidoc Amnh||WARN_NEWLINE
=for apidoc Amnh||WARN_PIPE
=for apidoc Amnh||WARN_UNOPENED
=for apidoc Amnh||WARN_MISC
=for apidoc Amnh||WARN_NUMERIC
=for apidoc Amnh||WARN_ONCE
=for apidoc Amnh||WARN_OVERFLOW
=for apidoc Amnh||WARN_PACK
=for apidoc Amnh||WARN_PORTABLE
=for apidoc Amnh||WARN_RECURSION
=for apidoc Amnh||WARN_REDEFINE
=for apidoc Amnh||WARN_REGEXP
=for apidoc Amnh||WARN_SEVERE
=for apidoc Amnh||WARN_DEBUGGING
=for apidoc Amnh||WARN_INPLACE
=for apidoc Amnh||WARN_INTERNAL
=for apidoc Amnh||WARN_MALLOC
=for apidoc Amnh||WARN_SIGNAL
=for apidoc Amnh||WARN_SUBSTR
=for apidoc Amnh||WARN_SYNTAX
=for apidoc Amnh||WARN_AMBIGUOUS
=for apidoc Amnh||WARN_BAREWORD
=for apidoc Amnh||WARN_DIGIT
=for apidoc Amnh||WARN_PARENTHESIS
=for apidoc Amnh||WARN_PRECEDENCE
=for apidoc Amnh||WARN_PRINTF
=for apidoc Amnh||WARN_PROTOTYPE
=for apidoc Amnh||WARN_QW
=for apidoc Amnh||WARN_RESERVED
=for apidoc Amnh||WARN_SEMICOLON
=for apidoc Amnh||WARN_TAINT
=for apidoc Amnh||WARN_THREADS
=for apidoc Amnh||WARN_UNINITIALIZED
=for apidoc Amnh||WARN_UNPACK
=for apidoc Amnh||WARN_UNTIE
=for apidoc Amnh||WARN_UTF8
=for apidoc Amnh||WARN_VOID
=for apidoc Amnh||WARN_IMPRECISION
=for apidoc Amnh||WARN_ILLEGALPROTO
=for apidoc Amnh||WARN_NON_UNICODE
=for apidoc Amnh||WARN_NONCHAR
=for apidoc Amnh||WARN_SURROGATE
=for apidoc Amnh||WARN_EXPERIMENTAL
=for apidoc Amnh||WARN_EXPERIMENTAL__LEXICAL_SUBS
=for apidoc Amnh||WARN_EXPERIMENTAL__REGEX_SETS
=for apidoc Amnh||WARN_EXPERIMENTAL__SMARTMATCH
=for apidoc Amnh||WARN_EXPERIMENTAL__POSTDEREF
=for apidoc Amnh||WARN_EXPERIMENTAL__SIGNATURES
=for apidoc Amnh||WARN_SYSCALLS
=for apidoc Amnh||WARN_EXPERIMENTAL__BITWISE
=for apidoc Amnh||WARN_EXPERIMENTAL__CONST_ATTR
=for apidoc Amnh||WARN_EXPERIMENTAL__RE_STRICT
=for apidoc Amnh||WARN_EXPERIMENTAL__REFALIASING
=for apidoc Amnh||WARN_EXPERIMENTAL__WIN32_PERLIO
=for apidoc Amnh||WARN_LOCALE
=for apidoc Amnh||WARN_MISSING
=for apidoc Amnh||WARN_REDUNDANT
=for apidoc Amnh||WARN_EXPERIMENTAL__DECLARED_REFS
=for apidoc Amnh||WARN_EXPERIMENTAL__ALPHA_ASSERTIONS
=for apidoc Amnh||WARN_EXPERIMENTAL__SCRIPT_RUN
=for apidoc Amnh||WARN_SHADOW
=for apidoc Amnh||WARN_EXPERIMENTAL__PRIVATE_USE
=for apidoc Amnh||WARN_EXPERIMENTAL__UNIPROP_WILDCARDS
=for apidoc Amnh||WARN_EXPERIMENTAL__VLB
=for apidoc Amnh||WARN_EXPERIMENTAL__ISA

=cut
*/

/* 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
6f17df98 KW	8	#define Perl_Warn_Off_(x) ((x) / 8)
	9	#define Perl_Warn_Bit_(x) (1 << ((x) % 8))
	10	#define PerlWarnIsSet_(a, x) ((a)[Perl_Warn_Off_(x)] & Perl_Warn_Bit_(x))
599cee73	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
8c165a32 KW	21	#define pWARN_ALL (STRLEN ) &PL_WARN_ALL / use warnings 'all' */
8c165a32 KW	22	#define pWARN_NONE (STRLEN ) &PL_WARN_NONE / 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
21c34e97 KW	124	/* Warnings Categories added in Perl 5.029 */
	125
	126	#define WARN_EXPERIMENTAL__PRIVATE_USE 70
4fa1c4b6	127	#define WARN_EXPERIMENTAL__UNIPROP_WILDCARDS 71
15a9bc0d	128	#define WARN_EXPERIMENTAL__VLB 72
21c34e97	129
813e85a0 PE	130	/* Warnings Categories added in Perl 5.031 */
	131
	132	#define WARN_EXPERIMENTAL__ISA 73
15a9bc0d KW	133	#define WARNsize 19
	134	#define WARN_ALLstring "\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125\125"
	135	#define WARN_NONEstring "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
599cee73	136
a2637ca0 FC	137	#define isLEXWARN_on \
	138	cBOOL(PL_curcop && PL_curcop->cop_warnings != pWARN_STD)
	139	#define isLEXWARN_off \
	140	cBOOL(!PL_curcop \|\| PL_curcop->cop_warnings == pWARN_STD)
d5a71f30	141	#define isWARN_ONCE (PL_dowarn & (G_WARN_ON\|G_WARN_ONCE))
6f17df98 KW	142	#define isWARN_on(c,x) (PerlWarnIsSet_((U8 )(c + 1), 2(x)))
6f17df98 KW	143	#define isWARNf_on(c,x) (PerlWarnIsSet_((U8 )(c + 1), 2(x)+1))
72dc9ed5	144
c1e47bad	145	#define DUP_WARNINGS(p) Perl_dup_warnings(aTHX_ p)
d5a71f30	146
94c8b9c1	147	#define free_and_set_cop_warnings(cmp,w) STMT_START { \
1943af61 DM	148	if (!specialWARN((cmp)->cop_warnings)) PerlMemShared_free((cmp)->cop_warnings); \
1943af61 DM	149	(cmp)->cop_warnings = w; \
94c8b9c1 N	150	} STMT_END
94c8b9c1 N	151
feff94e1 KW	152	/*
	153
	154	=head1 Warning and Dieing
	155
bb3eff5d KW	156	In all these calls, the C<U32 wI<n>> parameters are warning category
	157	constants. You can see the ones currently available in
	158	L<warnings/Category Hierarchy>, just capitalize all letters in the names
	159	and prefix them by C<WARN_>. So, for example, the category C<void> used in a
	160	perl program becomes C<WARN_VOID> when used in XS code and passed to one of
	161	the calls below.
	162
feff94e1	163	=for apidoc Am\|bool\|ckWARN\|U32 w
0afc88d2 KW	164	=for apidoc_item \|\|ckWARN2\|U32 w1\|U32 w2
	165	=for apidoc_item \|\|ckWARN3\|U32 w1\|U32 w2\|U32 w3
	166	=for apidoc_item \|\|ckWARN4\|U32 w1\|U32 w2\|U32 w3\|U32 w4
	167	These return a boolean as to whether or not warnings are enabled for any of
	168	the warning category(ies) parameters: C<w>, C<w1>, ....
feff94e1	169
0afc88d2 KW	170	Should any of the categories by default be enabled even if not within the
0afc88d2 KW	171	scope of S<C<use warnings>>, instead use the C<L</ckWARN_d>> macros.
feff94e1	172
0afc88d2 KW	173	The categories must be completely independent, one may not be subclassed from
0afc88d2 KW	174	the other.
feff94e1	175
0afc88d2	176	=for apidoc Am\|bool\|ckWARN_d\|U32 w
b8a2649a KW	177	=for apidoc_item \|\|ckWARN2_d\|U32 w1\|U32 w2
	178	=for apidoc_item \|\|ckWARN3_d\|U32 w1\|U32 w2\|U32 w3
	179	=for apidoc_item \|\|ckWARN4_d\|U32 w1\|U32 w2\|U32 w3\|U32 w4
feff94e1	180
0afc88d2	181	Like C<L</ckWARN>>, but for use if and only if the warning category(ies) is by
feff94e1 KW	182	default enabled even if not within the scope of S<C<use warnings>>.
feff94e1 KW	183
b8a2649a KW	184	=for apidoc Am\|U32\|packWARN\|U32 w1
	185	=for apidoc_item \|\|packWARN2\|U32 w1\|U32 w2
	186	=for apidoc_item \|\|packWARN3\|U32 w1\|U32 w2\|U32 w3
	187	=for apidoc_item \|\|packWARN4\|U32 w1\|U32 w2\|U32 w3\|U32 w4
	188
	189	These macros are used to pack warning categories into a single U32 to pass to
	190	macros and functions that take a warning category parameter. The number of
	191	categories to pack is given by the name, with a corresponding number of
	192	category parameters passed.
feff94e1 KW	193
	194	=cut
	195
	196	*/
	197
f54ba1c2	198	#define ckWARN(w) Perl_ckwarn(aTHX_ packWARN(w))
7c08c4c5 KW	199
	200	/* The w1, w2 ... should be independent warnings categories; one shouldn't be
	201	* a subcategory of any other */
	202
f54ba1c2 DM	203	#define ckWARN2(w1,w2) Perl_ckwarn(aTHX_ packWARN2(w1,w2))
	204	#define ckWARN3(w1,w2,w3) Perl_ckwarn(aTHX_ packWARN3(w1,w2,w3))
	205	#define ckWARN4(w1,w2,w3,w4) Perl_ckwarn(aTHX_ packWARN4(w1,w2,w3,w4))
	206
	207	#define ckWARN_d(w) Perl_ckwarn_d(aTHX_ packWARN(w))
	208	#define ckWARN2_d(w1,w2) Perl_ckwarn_d(aTHX_ packWARN2(w1,w2))
	209	#define ckWARN3_d(w1,w2,w3) Perl_ckwarn_d(aTHX_ packWARN3(w1,w2,w3))
	210	#define ckWARN4_d(w1,w2,w3,w4) Perl_ckwarn_d(aTHX_ packWARN4(w1,w2,w3,w4))
12bcd1a6	211
98fe6610 NC	212	#define WARNshift 8
98fe6610 NC	213
3b9e3074	214	#define packWARN(a) (a )
7c08c4c5 KW	215
	216	/* The a, b, ... should be independent warnings categories; one shouldn't be
	217	* a subcategory of any other */
	218
3b9e3074 SH	219	#define packWARN2(a,b) ((a) \| ((b)<<8) )
	220	#define packWARN3(a,b,c) ((a) \| ((b)<<8) \| ((c)<<16) )
	221	#define packWARN4(a,b,c,d) ((a) \| ((b)<<8) \| ((c)<<16) \| ((d) <<24))
12bcd1a6 PM	222
	223	#define unpackWARN1(x) ((x) & 0xFF)
	224	#define unpackWARN2(x) (((x) >>8) & 0xFF)
	225	#define unpackWARN3(x) (((x) >>16) & 0xFF)
	226	#define unpackWARN4(x) (((x) >>24) & 0xFF)
	227
	228	#define ckDEAD(x) \
006c1a1d Z	229	(PL_curcop && \
	230	!specialWARN(PL_curcop->cop_warnings) && \
	231	(isWARNf_on(PL_curcop->cop_warnings, unpackWARN1(x)) \|\| \
	232	(unpackWARN2(x) && \
	233	(isWARNf_on(PL_curcop->cop_warnings, unpackWARN2(x)) \|\| \
	234	(unpackWARN3(x) && \
	235	(isWARNf_on(PL_curcop->cop_warnings, unpackWARN3(x)) \|\| \
	236	(unpackWARN4(x) && \
	237	isWARNf_on(PL_curcop->cop_warnings, unpackWARN4(x)))))))))
12bcd1a6	238
c286f332 KW	239
	240
	241	/*
	242	=for apidoc Amnh\|\|WARN_ALL
	243	=for apidoc Amnh\|\|WARN_CLOSURE
	244	=for apidoc Amnh\|\|WARN_DEPRECATED
	245	=for apidoc Amnh\|\|WARN_EXITING
	246	=for apidoc Amnh\|\|WARN_GLOB
	247	=for apidoc Amnh\|\|WARN_IO
	248	=for apidoc Amnh\|\|WARN_CLOSED
	249	=for apidoc Amnh\|\|WARN_EXEC
	250	=for apidoc Amnh\|\|WARN_LAYER
	251	=for apidoc Amnh\|\|WARN_NEWLINE
	252	=for apidoc Amnh\|\|WARN_PIPE
	253	=for apidoc Amnh\|\|WARN_UNOPENED
	254	=for apidoc Amnh\|\|WARN_MISC
	255	=for apidoc Amnh\|\|WARN_NUMERIC
	256	=for apidoc Amnh\|\|WARN_ONCE
	257	=for apidoc Amnh\|\|WARN_OVERFLOW
	258	=for apidoc Amnh\|\|WARN_PACK
	259	=for apidoc Amnh\|\|WARN_PORTABLE
	260	=for apidoc Amnh\|\|WARN_RECURSION
	261	=for apidoc Amnh\|\|WARN_REDEFINE
	262	=for apidoc Amnh\|\|WARN_REGEXP
	263	=for apidoc Amnh\|\|WARN_SEVERE
	264	=for apidoc Amnh\|\|WARN_DEBUGGING
	265	=for apidoc Amnh\|\|WARN_INPLACE
	266	=for apidoc Amnh\|\|WARN_INTERNAL
	267	=for apidoc Amnh\|\|WARN_MALLOC
	268	=for apidoc Amnh\|\|WARN_SIGNAL
	269	=for apidoc Amnh\|\|WARN_SUBSTR
	270	=for apidoc Amnh\|\|WARN_SYNTAX
	271	=for apidoc Amnh\|\|WARN_AMBIGUOUS
	272	=for apidoc Amnh\|\|WARN_BAREWORD
	273	=for apidoc Amnh\|\|WARN_DIGIT
	274	=for apidoc Amnh\|\|WARN_PARENTHESIS
	275	=for apidoc Amnh\|\|WARN_PRECEDENCE
	276	=for apidoc Amnh\|\|WARN_PRINTF
	277	=for apidoc Amnh\|\|WARN_PROTOTYPE
	278	=for apidoc Amnh\|\|WARN_QW
	279	=for apidoc Amnh\|\|WARN_RESERVED
	280	=for apidoc Amnh\|\|WARN_SEMICOLON
	281	=for apidoc Amnh\|\|WARN_TAINT
	282	=for apidoc Amnh\|\|WARN_THREADS
	283	=for apidoc Amnh\|\|WARN_UNINITIALIZED
	284	=for apidoc Amnh\|\|WARN_UNPACK
	285	=for apidoc Amnh\|\|WARN_UNTIE
	286	=for apidoc Amnh\|\|WARN_UTF8
	287	=for apidoc Amnh\|\|WARN_VOID
	288	=for apidoc Amnh\|\|WARN_IMPRECISION
	289	=for apidoc Amnh\|\|WARN_ILLEGALPROTO
	290	=for apidoc Amnh\|\|WARN_NON_UNICODE
	291	=for apidoc Amnh\|\|WARN_NONCHAR
	292	=for apidoc Amnh\|\|WARN_SURROGATE
	293	=for apidoc Amnh\|\|WARN_EXPERIMENTAL
	294	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__LEXICAL_SUBS
	295	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__REGEX_SETS
	296	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__SMARTMATCH
	297	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__POSTDEREF
	298	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__SIGNATURES
	299	=for apidoc Amnh\|\|WARN_SYSCALLS
	300	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__BITWISE
	301	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__CONST_ATTR
	302	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__RE_STRICT
303	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__REFALIASING
304	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__WIN32_PERLIO
305	=for apidoc Amnh\|\|WARN_LOCALE
306	=for apidoc Amnh\|\|WARN_MISSING
307	=for apidoc Amnh\|\|WARN_REDUNDANT
308	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__DECLARED_REFS
309	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__ALPHA_ASSERTIONS
310	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__SCRIPT_RUN
311	=for apidoc Amnh\|\|WARN_SHADOW
312	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__PRIVATE_USE
313	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__UNIPROP_WILDCARDS
314	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__VLB
315	=for apidoc Amnh\|\|WARN_EXPERIMENTAL__ISA
316
317	=cut
318	*/
319
4438c4b7	320	/* end of file warnings.h */
ce716c52	321
37442d52	322	/* ex: set ro: */