This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Remove per-thread section; move to real scns
[perl5.git] / warnings.h
index 6f0bf6b..4d5b3ef 100644 (file)
@@ -5,9 +5,9 @@
  */
 
 
-#define Off(x)                 ((x) / 8)
-#define Bit(x)                 (1 << ((x) % 8))
-#define IsSet(a, x)            ((a)[Off(x)] & Bit(x))
+#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 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_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 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
 
-=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
+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.
 
-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|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>, ....
 
-=for apidoc Am|bool|ckWARN2|U32 w1|U32 w2
+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.
 
-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.
+The categories must be completely independent, one may not be subclassed from
+the other.
 
-=for apidoc Am|bool|ckWARN2_d|U32 w1|U32 w2
+=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</ckWARN2>>, but for use if and only if either warning category is by
+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|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
+=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
 
-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>>.
+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
 
@@ -240,6 +236,87 @@ is by default enabled even if not within the scope of S<C<use warnings>>.
              (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: */