diff options
-rw-r--r-- | regen/warnings.pl | 58 | ||||
-rw-r--r-- | warnings.h | 58 |
2 files changed, 116 insertions, 0 deletions
diff --git a/regen/warnings.pl b/regen/warnings.pl index 739a7b4894..83bf8bc3c4 100644 --- a/regen/warnings.pl +++ b/regen/warnings.pl @@ -373,6 +373,64 @@ EOM : (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 diff --git a/warnings.h b/warnings.h index f018137623..6d675209f8 100644 --- a/warnings.h +++ b/warnings.h @@ -132,6 +132,64 @@ : (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 |