lib/warnings.pm

   1 # -*- buffer-read-only: t -*-
   2 # !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
   3 # This file is built by regen/warnings.pl.
   4 # Any changes made here will be lost!
   5
   6 package warnings;
   7
   8 our $VERSION = "1.37";
   9
  10 # Verify that we're called correctly so that warnings will work.
  11 # Can't use Carp, since Carp uses us!
  12 # String regexps because constant folding = smaller optree = less memory vs regexp literal
  13 # see also strict.pm.
  14 die sprintf "Incorrect use of pragma '%s' at %s line %d.\n", __PACKAGE__, +(caller)[1,2]
  15     if __FILE__ !~ ( '(?x) \b     '.__PACKAGE__.'  \.pmc? \z' )
  16     && __FILE__ =~ ( '(?x) \b (?i:'.__PACKAGE__.') \.pmc? \z' );
  17
  18 our %Offsets = (
  19     # Warnings Categories added in Perl 5.008
  20     'all'                               => 0,
  21     'closure'                           => 2,
  22     'deprecated'                        => 4,
  23     'exiting'                           => 6,
  24     'glob'                              => 8,
  25     'io'                                => 10,
  26     'closed'                            => 12,
  27     'exec'                              => 14,
  28     'layer'                             => 16,
  29     'newline'                           => 18,
  30     'pipe'                              => 20,
  31     'unopened'                          => 22,
  32     'misc'                              => 24,
  33     'numeric'                           => 26,
  34     'once'                              => 28,
  35     'overflow'                          => 30,
  36     'pack'                              => 32,
  37     'portable'                          => 34,
  38     'recursion'                         => 36,
  39     'redefine'                          => 38,
  40     'regexp'                            => 40,
  41     'severe'                            => 42,
  42     'debugging'                         => 44,
  43     'inplace'                           => 46,
  44     'internal'                          => 48,
  45     'malloc'                            => 50,
  46     'signal'                            => 52,
  47     'substr'                            => 54,
  48     'syntax'                            => 56,
  49     'ambiguous'                         => 58,
  50     'bareword'                          => 60,
  51     'digit'                             => 62,
  52     'parenthesis'                       => 64,
  53     'precedence'                        => 66,
  54     'printf'                            => 68,
  55     'prototype'                         => 70,
  56     'qw'                                => 72,
  57     'reserved'                          => 74,
  58     'semicolon'                         => 76,
  59     'taint'                             => 78,
  60     'threads'                           => 80,
  61     'uninitialized'                     => 82,
  62     'unpack'                            => 84,
  63     'untie'                             => 86,
  64     'utf8'                              => 88,
  65     'void'                              => 90,
  66
  67     # Warnings Categories added in Perl 5.011
  68     'imprecision'                       => 92,
  69     'illegalproto'                      => 94,
  70
  71     # Warnings Categories added in Perl 5.013
  72     'non_unicode'                       => 96,
  73     'nonchar'                           => 98,
  74     'surrogate'                         => 100,
  75
  76     # Warnings Categories added in Perl 5.017
  77     'experimental'                      => 102,
  78     'experimental::lexical_subs'        => 104,
  79     'experimental::regex_sets'          => 106,
  80     'experimental::smartmatch'          => 108,
  81
  82     # Warnings Categories added in Perl 5.019
  83     'experimental::postderef'           => 110,
  84     'experimental::signatures'          => 112,
  85     'syscalls'                          => 114,
  86
  87     # Warnings Categories added in Perl 5.021
  88     'experimental::bitwise'             => 116,
  89     'experimental::const_attr'          => 118,
  90     'experimental::re_strict'           => 120,
  91     'experimental::refaliasing'         => 122,
  92     'experimental::win32_perlio'        => 124,
  93     'locale'                            => 126,
  94     'missing'                           => 128,
  95     'redundant'                         => 130,
  96
  97     # Warnings Categories added in Perl 5.025
  98     'experimental::declared_refs'       => 132,
  99 );
 100
 101 our %Bits = (
 102     'all'                               => "\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x15", # [0..66]
 103     'ambiguous'                         => "\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [29]
 104     'bareword'                          => "\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [30]
 105     'closed'                            => "\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [6]
 106     'closure'                           => "\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [1]
 107     'debugging'                         => "\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [22]
 108     'deprecated'                        => "\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [2]
 109     'digit'                             => "\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [31]
 110     'exec'                              => "\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [7]
 111     'exiting'                           => "\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [3]
 112     'experimental'                      => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x55\x51\x15\x10", # [51..56,58..62,66]
 113     'experimental::bitwise'             => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00", # [58]
 114     'experimental::const_attr'          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00", # [59]
 115     'experimental::declared_refs'       => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10", # [66]
 116     'experimental::lexical_subs'        => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00", # [52]
 117     'experimental::postderef'           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00", # [55]
 118     'experimental::re_strict'           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00", # [60]
 119     'experimental::refaliasing'         => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00", # [61]
 120     'experimental::regex_sets'          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00", # [53]
 121     'experimental::signatures'          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00", # [56]
 122     'experimental::smartmatch'          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00", # [54]
 123     'experimental::win32_perlio'        => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00", # [62]
 124     'glob'                              => "\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [4]
 125     'illegalproto'                      => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00", # [47]
 126     'imprecision'                       => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00", # [46]
 127     'inplace'                           => "\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [23]
 128     'internal'                          => "\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [24]
 129     'io'                                => "\x00\x54\x55\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00", # [5..11,57]
 130     'layer'                             => "\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [8]
 131     'locale'                            => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00", # [63]
 132     'malloc'                            => "\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [25]
 133     'misc'                              => "\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [12]
 134     'missing'                           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01", # [64]
 135     'newline'                           => "\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [9]
 136     'non_unicode'                       => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00", # [48]
 137     'nonchar'                           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00", # [49]
 138     'numeric'                           => "\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [13]
 139     'once'                              => "\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [14]
 140     'overflow'                          => "\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [15]
 141     'pack'                              => "\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [16]
 142     'parenthesis'                       => "\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00", # [32]
 143     'pipe'                              => "\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [10]
 144     'portable'                          => "\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [17]
 145     'precedence'                        => "\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00", # [33]
 146     'printf'                            => "\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00", # [34]
 147     'prototype'                         => "\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00", # [35]
 148     'qw'                                => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00", # [36]
 149     'recursion'                         => "\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [18]
 150     'redefine'                          => "\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [19]
 151     'redundant'                         => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04", # [65]
 152     'regexp'                            => "\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [20]
 153     'reserved'                          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00", # [37]
 154     'semicolon'                         => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00", # [38]
 155     'severe'                            => "\x00\x00\x00\x00\x00\x54\x05\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [21..25]
 156     'signal'                            => "\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [26]
 157     'substr'                            => "\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [27]
 158     'surrogate'                         => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00", # [50]
 159     'syntax'                            => "\x00\x00\x00\x00\x00\x00\x00\x55\x55\x15\x00\x40\x00\x00\x00\x00\x00", # [28..38,47]
 160     'syscalls'                          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00", # [57]
 161     'taint'                             => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00", # [39]
 162     'threads'                           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00", # [40]
 163     'uninitialized'                     => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00", # [41]
 164     'unopened'                          => "\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [11]
 165     'unpack'                            => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00", # [42]
 166     'untie'                             => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00", # [43]
 167     'utf8'                              => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x15\x00\x00\x00\x00", # [44,48..50]
 168     'void'                              => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00", # [45]
 169 );
 170
 171 our %DeadBits = (
 172     'all'                               => "\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\x2a", # [0..66]
 173     'ambiguous'                         => "\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [29]
 174     'bareword'                          => "\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [30]
 175     'closed'                            => "\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [6]
 176     'closure'                           => "\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [1]
 177     'debugging'                         => "\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [22]
 178     'deprecated'                        => "\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [2]
 179     'digit'                             => "\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [31]
 180     'exec'                              => "\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [7]
 181     'exiting'                           => "\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [3]
 182     'experimental'                      => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\xaa\xa2\x2a\x20", # [51..56,58..62,66]
 183     'experimental::bitwise'             => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00", # [58]
 184     'experimental::const_attr'          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00", # [59]
 185     'experimental::declared_refs'       => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20", # [66]
 186     'experimental::lexical_subs'        => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00", # [52]
 187     'experimental::postderef'           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00", # [55]
 188     'experimental::re_strict'           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00", # [60]
 189     'experimental::refaliasing'         => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00", # [61]
 190     'experimental::regex_sets'          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00", # [53]
 191     'experimental::signatures'          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00", # [56]
 192     'experimental::smartmatch'          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00", # [54]
 193     'experimental::win32_perlio'        => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00", # [62]
 194     'glob'                              => "\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [4]
 195     'illegalproto'                      => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00", # [47]
 196     'imprecision'                       => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00", # [46]
 197     'inplace'                           => "\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [23]
 198     'internal'                          => "\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [24]
 199     'io'                                => "\x00\xa8\xaa\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00", # [5..11,57]
 200     'layer'                             => "\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [8]
 201     'locale'                            => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00", # [63]
 202     'malloc'                            => "\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [25]
 203     'misc'                              => "\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [12]
 204     'missing'                           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02", # [64]
 205     'newline'                           => "\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [9]
 206     'non_unicode'                       => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00", # [48]
 207     'nonchar'                           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00", # [49]
 208     'numeric'                           => "\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [13]
 209     'once'                              => "\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [14]
 210     'overflow'                          => "\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [15]
 211     'pack'                              => "\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [16]
 212     'parenthesis'                       => "\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00", # [32]
 213     'pipe'                              => "\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [10]
 214     'portable'                          => "\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [17]
 215     'precedence'                        => "\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00", # [33]
 216     'printf'                            => "\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00", # [34]
 217     'prototype'                         => "\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00", # [35]
 218     'qw'                                => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00", # [36]
 219     'recursion'                         => "\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [18]
 220     'redefine'                          => "\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [19]
 221     'redundant'                         => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08", # [65]
 222     'regexp'                            => "\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [20]
 223     'reserved'                          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00", # [37]
 224     'semicolon'                         => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00", # [38]
 225     'severe'                            => "\x00\x00\x00\x00\x00\xa8\x0a\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [21..25]
 226     'signal'                            => "\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [26]
 227     'substr'                            => "\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [27]
 228     'surrogate'                         => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00", # [50]
 229     'syntax'                            => "\x00\x00\x00\x00\x00\x00\x00\xaa\xaa\x2a\x00\x80\x00\x00\x00\x00\x00", # [28..38,47]
 230     'syscalls'                          => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00", # [57]
 231     'taint'                             => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00", # [39]
 232     'threads'                           => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00", # [40]
 233     'uninitialized'                     => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00", # [41]
 234     'unopened'                          => "\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [11]
 235     'unpack'                            => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00", # [42]
 236     'untie'                             => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00", # [43]
 237     'utf8'                              => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x2a\x00\x00\x00\x00", # [44,48..50]
 238     'void'                              => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00", # [45]
 239 );
 240
 241 # These are used by various things, including our own tests
 242 our $NONE                               =  "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
 243 our $DEFAULT                            =  "\x10\x01\x00\x00\x00\x50\x04\x00\x00\x00\x00\x00\x00\x55\x51\x55\x10", # [2,4,22,23,25,52..56,58..63,66]
 244 our $LAST_BIT                           =  134 ;
 245 our $BYTES                              =  17 ;
 246
 247 our $All = "" ; vec($All, $Offsets{'all'}, 2) = 3 ;
 248
 249 sub Croaker
 250 {
 251     require Carp; # this initializes %CarpInternal
 252     local $Carp::CarpInternal{'warnings'};
 253     delete $Carp::CarpInternal{'warnings'};
 254     Carp::croak(@_);
 255 }
 256
 257 sub _bits {
 258     my $mask = shift ;
 259     my $catmask ;
 260     my $fatal = 0 ;
 261     my $no_fatal = 0 ;
 262
 263     foreach my $word ( @_ ) {
 264         if ($word eq 'FATAL') {
 265             $fatal = 1;
 266             $no_fatal = 0;
 267         }
 268         elsif ($word eq 'NONFATAL') {
 269             $fatal = 0;
 270             $no_fatal = 1;
 271         }
 272         elsif ($catmask = $Bits{$word}) {
 273             $mask |= $catmask ;
 274             $mask |= $DeadBits{$word} if $fatal ;
 275             $mask &= ~($DeadBits{$word}|$All) if $no_fatal ;
 276         }
 277         else
 278           { Croaker("Unknown warnings category '$word'")}
 279     }
 280
 281     return $mask ;
 282 }
 283
 284 sub bits
 285 {
 286     # called from B::Deparse.pm
 287     push @_, 'all' unless @_ ;
 288     return _bits(undef, @_) ;
 289 }
 290
 291 sub import
 292 {
 293     shift;
 294
 295     my $mask = ${^WARNING_BITS} // ($^W ? $Bits{all} : $DEFAULT) ;
 296
 297     if (vec($mask, $Offsets{'all'}, 1)) {
 298         $mask |= $Bits{'all'} ;
 299         $mask |= $DeadBits{'all'} if vec($mask, $Offsets{'all'}+1, 1);
 300     }
 301
 302     # append 'all' when implied (after a lone "FATAL" or "NONFATAL")
 303     push @_, 'all' if @_==1 && ( $_[0] eq 'FATAL' || $_[0] eq 'NONFATAL' );
 304
 305     # Empty @_ is equivalent to @_ = 'all' ;
 306     ${^WARNING_BITS} = @_ ? _bits($mask, @_) : $mask | $Bits{all} ;
 307 }
 308
 309 sub unimport
 310 {
 311     shift;
 312
 313     my $catmask ;
 314     my $mask = ${^WARNING_BITS} // ($^W ? $Bits{all} : $DEFAULT) ;
 315
 316     if (vec($mask, $Offsets{'all'}, 1)) {
 317         $mask |= $Bits{'all'} ;
 318         $mask |= $DeadBits{'all'} if vec($mask, $Offsets{'all'}+1, 1);
 319     }
 320
 321     # append 'all' when implied (empty import list or after a lone "FATAL")
 322     push @_, 'all' if !@_ || @_==1 && $_[0] eq 'FATAL';
 323
 324     foreach my $word ( @_ ) {
 325         if ($word eq 'FATAL') {
 326             next;
 327         }
 328         elsif ($catmask = $Bits{$word}) {
 329             $mask &= ~($catmask | $DeadBits{$word} | $All);
 330         }
 331         else
 332           { Croaker("Unknown warnings category '$word'")}
 333     }
 334
 335     ${^WARNING_BITS} = $mask ;
 336 }
 337
 338 my %builtin_type; @builtin_type{qw(SCALAR ARRAY HASH CODE REF GLOB LVALUE Regexp)} = ();
 339
 340 sub MESSAGE () { 4 };
 341 sub FATAL () { 2 };
 342 sub NORMAL () { 1 };
 343
 344 sub __chk
 345 {
 346     my $category ;
 347     my $offset ;
 348     my $isobj = 0 ;
 349     my $wanted = shift;
 350     my $has_message = $wanted & MESSAGE;
 351
 352     unless (@_ == 1 || @_ == ($has_message ? 2 : 0)) {
 353         my $sub = (caller 1)[3];
 354         my $syntax = $has_message ? "[category,] 'message'" : '[category]';
 355         Croaker("Usage: $sub($syntax)");
 356     }
 357
 358     my $message = pop if $has_message;
 359
 360     if (@_) {
 361         # check the category supplied.
 362         $category = shift ;
 363         if (my $type = ref $category) {
 364             Croaker("not an object")
 365                 if exists $builtin_type{$type};
 366             $category = $type;
 367             $isobj = 1 ;
 368         }
 369         $offset = $Offsets{$category};
 370         Croaker("Unknown warnings category '$category'")
 371             unless defined $offset;
 372     }
 373     else {
 374         $category = (caller(1))[0] ;
 375         $offset = $Offsets{$category};
 376         Croaker("package '$category' not registered for warnings")
 377             unless defined $offset ;
 378     }
 379
 380     my $i;
 381
 382     if ($isobj) {
 383         my $pkg;
 384         $i = 2;
 385         while (do { { package DB; $pkg = (caller($i++))[0] } } ) {
 386             last unless @DB::args && $DB::args[0] =~ /^$category=/ ;
 387         }
 388         $i -= 2 ;
 389     }
 390     else {
 391         $i = _error_loc(); # see where Carp will allocate the error
 392     }
 393
 394     # Default to 0 if caller returns nothing.  Default to $DEFAULT if it
 395     # explicitly returns undef.
 396     my(@callers_bitmask) = (caller($i))[9] ;
 397     my $callers_bitmask =
 398          @callers_bitmask ? $callers_bitmask[0] // $DEFAULT : 0 ;
 399
 400     my @results;
 401     foreach my $type (FATAL, NORMAL) {
 402         next unless $wanted & $type;
 403
 404         push @results, (vec($callers_bitmask, $offset + $type - 1, 1) ||
 405                         vec($callers_bitmask, $Offsets{'all'} + $type - 1, 1));
 406     }
 407
 408     # &enabled and &fatal_enabled
 409     return $results[0] unless $has_message;
 410
 411     # &warnif, and the category is neither enabled as warning nor as fatal
 412     return if $wanted == (NORMAL | FATAL | MESSAGE)
 413         && !($results[0] || $results[1]);
 414
 415     require Carp;
 416     Carp::croak($message) if $results[0];
 417     # will always get here for &warn. will only get here for &warnif if the
 418     # category is enabled
 419     Carp::carp($message);
 420 }
 421
 422 sub _mkMask
 423 {
 424     my ($bit) = @_;
 425     my $mask = "";
 426
 427     vec($mask, $bit, 1) = 1;
 428     return $mask;
 429 }
 430
 431 sub register_categories
 432 {
 433     my @names = @_;
 434
 435     for my $name (@names) {
 436         if (! defined $Bits{$name}) {
 437             $Bits{$name}     = _mkMask($LAST_BIT);
 438             vec($Bits{'all'}, $LAST_BIT, 1) = 1;
 439             $Offsets{$name}  = $LAST_BIT ++;
 440             foreach my $k (keys %Bits) {
 441                 vec($Bits{$k}, $LAST_BIT, 1) = 0;
 442             }
 443             $DeadBits{$name} = _mkMask($LAST_BIT);
 444             vec($DeadBits{'all'}, $LAST_BIT++, 1) = 1;
 445         }
 446     }
 447 }
 448
 449 sub _error_loc {
 450     require Carp;
 451     goto &Carp::short_error_loc; # don't introduce another stack frame
 452 }
 453
 454 sub enabled
 455 {
 456     return __chk(NORMAL, @_);
 457 }
 458
 459 sub fatal_enabled
 460 {
 461     return __chk(FATAL, @_);
 462 }
 463
 464 sub warn
 465 {
 466     return __chk(FATAL | MESSAGE, @_);
 467 }
 468
 469 sub warnif
 470 {
 471     return __chk(NORMAL | FATAL | MESSAGE, @_);
 472 }
 473
 474 # These are not part of any public interface, so we can delete them to save
 475 # space.
 476 delete @warnings::{qw(NORMAL FATAL MESSAGE)};
 477
 478 1;
 479 __END__
 480 =head1 NAME
 481
 482 warnings - Perl pragma to control optional warnings
 483
 484 =head1 SYNOPSIS
 485
 486     use warnings;
 487     no warnings;
 488
 489     use warnings "all";
 490     no warnings "all";
 491
 492     use warnings::register;
 493     if (warnings::enabled()) {
 494         warnings::warn("some warning");
 495     }
 496
 497     if (warnings::enabled("void")) {
 498         warnings::warn("void", "some warning");
 499     }
 500
 501     if (warnings::enabled($object)) {
 502         warnings::warn($object, "some warning");
 503     }
 504
 505     warnings::warnif("some warning");
 506     warnings::warnif("void", "some warning");
 507     warnings::warnif($object, "some warning");
 508
 509 =head1 DESCRIPTION
 510
 511 The C<warnings> pragma gives control over which warnings are enabled in
 512 which parts of a Perl program.  It's a more flexible alternative for
 513 both the command line flag B<-w> and the equivalent Perl variable,
 514 C<$^W>.
 515
 516 This pragma works just like the C<strict> pragma.
 517 This means that the scope of the warning pragma is limited to the
 518 enclosing block.  It also means that the pragma setting will not
 519 leak across files (via C<use>, C<require> or C<do>).  This allows
 520 authors to independently define the degree of warning checks that will
 521 be applied to their module.
 522
 523 By default, optional warnings are disabled, so any legacy code that
 524 doesn't attempt to control the warnings will work unchanged.
 525
 526 All warnings are enabled in a block by either of these:
 527
 528     use warnings;
 529     use warnings 'all';
 530
 531 Similarly all warnings are disabled in a block by either of these:
 532
 533     no warnings;
 534     no warnings 'all';
 535
 536 For example, consider the code below:
 537
 538     use warnings;
 539     my @a;
 540     {
 541         no warnings;
 542         my $b = @a[0];
 543     }
 544     my $c = @a[0];
 545
 546 The code in the enclosing block has warnings enabled, but the inner
 547 block has them disabled.  In this case that means the assignment to the
 548 scalar C<$c> will trip the C<"Scalar value @a[0] better written as $a[0]">
 549 warning, but the assignment to the scalar C<$b> will not.
 550
 551 =head2 Default Warnings and Optional Warnings
 552
 553 Before the introduction of lexical warnings, Perl had two classes of
 554 warnings: mandatory and optional.
 555
 556 As its name suggests, if your code tripped a mandatory warning, you
 557 would get a warning whether you wanted it or not.
 558 For example, the code below would always produce an C<"isn't numeric">
 559 warning about the "2:".
 560
 561     my $a = "2:" + 3;
 562
 563 With the introduction of lexical warnings, mandatory warnings now become
 564 I<default> warnings.  The difference is that although the previously
 565 mandatory warnings are still enabled by default, they can then be
 566 subsequently enabled or disabled with the lexical warning pragma.  For
 567 example, in the code below, an C<"isn't numeric"> warning will only
 568 be reported for the C<$a> variable.
 569
 570     my $a = "2:" + 3;
 571     no warnings;
 572     my $b = "2:" + 3;
 573
 574 Note that neither the B<-w> flag or the C<$^W> can be used to
 575 disable/enable default warnings.  They are still mandatory in this case.
 576
 577 =head2 What's wrong with B<-w> and C<$^W>
 578
 579 Although very useful, the big problem with using B<-w> on the command
 580 line to enable warnings is that it is all or nothing.  Take the typical
 581 scenario when you are writing a Perl program.  Parts of the code you
 582 will write yourself, but it's very likely that you will make use of
 583 pre-written Perl modules.  If you use the B<-w> flag in this case, you
 584 end up enabling warnings in pieces of code that you haven't written.
 585
 586 Similarly, using C<$^W> to either disable or enable blocks of code is
 587 fundamentally flawed.  For a start, say you want to disable warnings in
 588 a block of code.  You might expect this to be enough to do the trick:
 589
 590      {
 591          local ($^W) = 0;
 592          my $a =+ 2;
 593          my $b; chop $b;
 594      }
 595
 596 When this code is run with the B<-w> flag, a warning will be produced
 597 for the C<$a> line:  C<"Reversed += operator">.
 598
 599 The problem is that Perl has both compile-time and run-time warnings.  To
 600 disable compile-time warnings you need to rewrite the code like this:
 601
 602      {
 603          BEGIN { $^W = 0 }
 604          my $a =+ 2;
 605          my $b; chop $b;
 606      }
 607
 608 The other big problem with C<$^W> is the way you can inadvertently
 609 change the warning setting in unexpected places in your code.  For example,
 610 when the code below is run (without the B<-w> flag), the second call
 611 to C<doit> will trip a C<"Use of uninitialized value"> warning, whereas
 612 the first will not.
 613
 614     sub doit
 615     {
 616         my $b; chop $b;
 617     }
 618
 619     doit();
 620
 621     {
 622         local ($^W) = 1;
 623         doit()
 624     }
 625
 626 This is a side-effect of C<$^W> being dynamically scoped.
 627
 628 Lexical warnings get around these limitations by allowing finer control
 629 over where warnings can or can't be tripped.
 630
 631 =head2 Controlling Warnings from the Command Line
 632
 633 There are three Command Line flags that can be used to control when
 634 warnings are (or aren't) produced:
 635
 636 =over 5
 637
 638 =item B<-w>
 639 X<-w>
 640
 641 This is  the existing flag.  If the lexical warnings pragma is B<not>
 642 used in any of you code, or any of the modules that you use, this flag
 643 will enable warnings everywhere.  See L<Backward Compatibility> for
 644 details of how this flag interacts with lexical warnings.
 645
 646 =item B<-W>
 647 X<-W>
 648
 649 If the B<-W> flag is used on the command line, it will enable all warnings
 650 throughout the program regardless of whether warnings were disabled
 651 locally using C<no warnings> or C<$^W =0>.
 652 This includes all files that get
 653 included via C<use>, C<require> or C<do>.
 654 Think of it as the Perl equivalent of the "lint" command.
 655
 656 =item B<-X>
 657 X<-X>
 658
 659 Does the exact opposite to the B<-W> flag, i.e. it disables all warnings.
 660
 661 =back
 662
 663 =head2 Backward Compatibility
 664
 665 If you are used to working with a version of Perl prior to the
 666 introduction of lexically scoped warnings, or have code that uses both
 667 lexical warnings and C<$^W>, this section will describe how they interact.
 668
 669 How Lexical Warnings interact with B<-w>/C<$^W>:
 670
 671 =over 5
 672
 673 =item 1.
 674
 675 If none of the three command line flags (B<-w>, B<-W> or B<-X>) that
 676 control warnings is used and neither C<$^W> nor the C<warnings> pragma
 677 are used, then default warnings will be enabled and optional warnings
 678 disabled.
 679 This means that legacy code that doesn't attempt to control the warnings
 680 will work unchanged.
 681
 682 =item 2.
 683
 684 The B<-w> flag just sets the global C<$^W> variable as in 5.005.  This
 685 means that any legacy code that currently relies on manipulating C<$^W>
 686 to control warning behavior will still work as is.
 687
 688 =item 3.
 689
 690 Apart from now being a boolean, the C<$^W> variable operates in exactly
 691 the same horrible uncontrolled global way, except that it cannot
 692 disable/enable default warnings.
 693
 694 =item 4.
 695
 696 If a piece of code is under the control of the C<warnings> pragma,
 697 both the C<$^W> variable and the B<-w> flag will be ignored for the
 698 scope of the lexical warning.
 699
 700 =item 5.
 701
 702 The only way to override a lexical warnings setting is with the B<-W>
 703 or B<-X> command line flags.
 704
 705 =back
 706
 707 The combined effect of 3 & 4 is that it will allow code which uses
 708 the C<warnings> pragma to control the warning behavior of $^W-type
 709 code (using a C<local $^W=0>) if it really wants to, but not vice-versa.
 710
 711 =head2 Category Hierarchy
 712 X<warning, categories>
 713
 714 A hierarchy of "categories" have been defined to allow groups of warnings
 715 to be enabled/disabled in isolation.
 716
 717 The current hierarchy is:
 718
 719     all -+
 720          |
 721          +- closure
 722          |
 723          +- deprecated
 724          |
 725          +- exiting
 726          |
 727          +- experimental --+
 728          |                 |
 729          |                 +- experimental::bitwise
 730          |                 |
 731          |                 +- experimental::const_attr
 732          |                 |
 733          |                 +- experimental::declared_refs
 734          |                 |
 735          |                 +- experimental::lexical_subs
 736          |                 |
 737          |                 +- experimental::postderef
 738          |                 |
 739          |                 +- experimental::re_strict
 740          |                 |
 741          |                 +- experimental::refaliasing
 742          |                 |
 743          |                 +- experimental::regex_sets
 744          |                 |
 745          |                 +- experimental::signatures
 746          |                 |
 747          |                 +- experimental::smartmatch
 748          |                 |
 749          |                 +- experimental::win32_perlio
 750          |
 751          +- glob
 752          |
 753          +- imprecision
 754          |
 755          +- io ------------+
 756          |                 |
 757          |                 +- closed
 758          |                 |
 759          |                 +- exec
 760          |                 |
 761          |                 +- layer
 762          |                 |
 763          |                 +- newline
 764          |                 |
 765          |                 +- pipe
 766          |                 |
 767          |                 +- syscalls
 768          |                 |
 769          |                 +- unopened
 770          |
 771          +- locale
 772          |
 773          +- misc
 774          |
 775          +- missing
 776          |
 777          +- numeric
 778          |
 779          +- once
 780          |
 781          +- overflow
 782          |
 783          +- pack
 784          |
 785          +- portable
 786          |
 787          +- recursion
 788          |
 789          +- redefine
 790          |
 791          +- redundant
 792          |
 793          +- regexp
 794          |
 795          +- severe --------+
 796          |                 |
 797          |                 +- debugging
 798          |                 |
 799          |                 +- inplace
 800          |                 |
 801          |                 +- internal
 802          |                 |
 803          |                 +- malloc
 804          |
 805          +- signal
 806          |
 807          +- substr
 808          |
 809          +- syntax --------+
 810          |                 |
 811          |                 +- ambiguous
 812          |                 |
 813          |                 +- bareword
 814          |                 |
 815          |                 +- digit
 816          |                 |
 817          |                 +- illegalproto
 818          |                 |
 819          |                 +- parenthesis
 820          |                 |
 821          |                 +- precedence
 822          |                 |
 823          |                 +- printf
 824          |                 |
 825          |                 +- prototype
 826          |                 |
 827          |                 +- qw
 828          |                 |
 829          |                 +- reserved
 830          |                 |
 831          |                 +- semicolon
 832          |
 833          +- taint
 834          |
 835          +- threads
 836          |
 837          +- uninitialized
 838          |
 839          +- unpack
 840          |
 841          +- untie
 842          |
 843          +- utf8 ----------+
 844          |                 |
 845          |                 +- non_unicode
 846          |                 |
 847          |                 +- nonchar
 848          |                 |
 849          |                 +- surrogate
 850          |
 851          +- void
 852
 853 Just like the "strict" pragma any of these categories can be combined
 854
 855     use warnings qw(void redefine);
 856     no warnings qw(io syntax untie);
 857
 858 Also like the "strict" pragma, if there is more than one instance of the
 859 C<warnings> pragma in a given scope the cumulative effect is additive.
 860
 861     use warnings qw(void); # only "void" warnings enabled
 862     ...
 863     use warnings qw(io);   # only "void" & "io" warnings enabled
 864     ...
 865     no warnings qw(void);  # only "io" warnings enabled
 866
 867 To determine which category a specific warning has been assigned to see
 868 L<perldiag>.
 869
 870 Note: Before Perl 5.8.0, the lexical warnings category "deprecated" was a
 871 sub-category of the "syntax" category.  It is now a top-level category
 872 in its own right.
 873
 874 Note: Before 5.21.0, the "missing" lexical warnings category was
 875 internally defined to be the same as the "uninitialized" category. It
 876 is now a top-level category in its own right.
 877
 878 =head2 Fatal Warnings
 879 X<warning, fatal>
 880
 881 The presence of the word "FATAL" in the category list will escalate
 882 warnings in those categories into fatal errors in that lexical scope.
 883
 884 B<NOTE:> FATAL warnings should be used with care, particularly
 885 C<< FATAL => 'all' >>.
 886
 887 Libraries using L<warnings::warn|/FUNCTIONS> for custom warning categories
 888 generally don't expect L<warnings::warn|/FUNCTIONS> to be fatal and can wind up
 889 in an unexpected state as a result.  For XS modules issuing categorized
 890 warnings, such unanticipated exceptions could also expose memory leak bugs.
 891
 892 Moreover, the Perl interpreter itself has had serious bugs involving
 893 fatalized warnings.  For a summary of resolved and unresolved problems as
 894 of January 2015, please see
 895 L<this perl5-porters post|http://www.nntp.perl.org/group/perl.perl5.porters/2015/01/msg225235.html>.
 896
 897 While some developers find fatalizing some warnings to be a useful
 898 defensive programming technique, using C<< FATAL => 'all' >> to fatalize
 899 all possible warning categories -- including custom ones -- is particularly
 900 risky.  Therefore, the use of C<< FATAL => 'all' >> is
 901 L<discouraged|perlpolicy/discouraged>.
 902
 903 The L<strictures|strictures/VERSION-2> module on CPAN offers one example of
 904 a warnings subset that the module's authors believe is relatively safe to
 905 fatalize.
 906
 907 B<NOTE:> users of FATAL warnings, especially those using
 908 C<< FATAL => 'all' >>, should be fully aware that they are risking future
 909 portability of their programs by doing so.  Perl makes absolutely no
 910 commitments to not introduce new warnings or warnings categories in the
 911 future; indeed, we explicitly reserve the right to do so.  Code that may
 912 not warn now may warn in a future release of Perl if the Perl5 development
 913 team deems it in the best interests of the community to do so.  Should code
 914 using FATAL warnings break due to the introduction of a new warning we will
 915 NOT consider it an incompatible change.  Users of FATAL warnings should
 916 take special caution during upgrades to check to see if their code triggers
 917 any new warnings and should pay particular attention to the fine print of
 918 the documentation of the features they use to ensure they do not exploit
 919 features that are documented as risky, deprecated, or unspecified, or where
 920 the documentation says "so don't do that", or anything with the same sense
 921 and spirit.  Use of such features in combination with FATAL warnings is
 922 ENTIRELY AT THE USER'S RISK.
 923
 924 The following documentation describes how to use FATAL warnings but the
 925 perl5 porters strongly recommend that you understand the risks before doing
 926 so, especially for library code intended for use by others, as there is no
 927 way for downstream users to change the choice of fatal categories.
 928
 929 In the code below, the use of C<time>, C<length>
 930 and C<join> can all produce a C<"Useless use of xxx in void context">
 931 warning.
 932
 933     use warnings;
 934
 935     time;
 936
 937     {
 938         use warnings FATAL => qw(void);
 939         length "abc";
 940     }
 941
 942     join "", 1,2,3;
 943
 944     print "done\n";
 945
 946 When run it produces this output
 947
 948     Useless use of time in void context at fatal line 3.
 949     Useless use of length in void context at fatal line 7.
 950
 951 The scope where C<length> is used has escalated the C<void> warnings
 952 category into a fatal error, so the program terminates immediately when it
 953 encounters the warning.
 954
 955 To explicitly turn off a "FATAL" warning you just disable the warning
 956 it is associated with.  So, for example, to disable the "void" warning
 957 in the example above, either of these will do the trick:
 958
 959     no warnings qw(void);
 960     no warnings FATAL => qw(void);
 961
 962 If you want to downgrade a warning that has been escalated into a fatal
 963 error back to a normal warning, you can use the "NONFATAL" keyword.  For
 964 example, the code below will promote all warnings into fatal errors,
 965 except for those in the "syntax" category.
 966
 967     use warnings FATAL => 'all', NONFATAL => 'syntax';
 968
 969 As of Perl 5.20, instead of C<< use warnings FATAL => 'all'; >> you can
 970 use:
 971
 972    use v5.20;       # Perl 5.20 or greater is required for the following
 973    use warnings 'FATAL';  # short form of "use warnings FATAL => 'all';"
 974
 975 If you want your program to be compatible with versions of Perl before
 976 5.20, you must use C<< use warnings FATAL => 'all'; >> instead.  (In
 977 previous versions of Perl, the behavior of the statements
 978 C<< use warnings 'FATAL'; >>, C<< use warnings 'NONFATAL'; >> and
 979 C<< no warnings 'FATAL'; >> was unspecified; they did not behave as if
 980 they included the C<< => 'all' >> portion.  As of 5.20, they do.)
 981
 982 =head2 Reporting Warnings from a Module
 983 X<warning, reporting> X<warning, registering>
 984
 985 The C<warnings> pragma provides a number of functions that are useful for
 986 module authors.  These are used when you want to report a module-specific
 987 warning to a calling module has enabled warnings via the C<warnings>
 988 pragma.
 989
 990 Consider the module C<MyMod::Abc> below.
 991
 992     package MyMod::Abc;
 993
 994     use warnings::register;
 995
 996     sub open {
 997         my $path = shift;
 998         if ($path !~ m#^/#) {
 999             warnings::warn("changing relative path to /var/abc")
1000                 if warnings::enabled();
1001             $path = "/var/abc/$path";
1002         }
1003     }
1004
1005     1;
1006
1007 The call to C<warnings::register> will create a new warnings category
1008 called "MyMod::Abc", i.e. the new category name matches the current
1009 package name.  The C<open> function in the module will display a warning
1010 message if it gets given a relative path as a parameter.  This warnings
1011 will only be displayed if the code that uses C<MyMod::Abc> has actually
1012 enabled them with the C<warnings> pragma like below.
1013
1014     use MyMod::Abc;
1015     use warnings 'MyMod::Abc';
1016     ...
1017     abc::open("../fred.txt");
1018
1019 It is also possible to test whether the pre-defined warnings categories are
1020 set in the calling module with the C<warnings::enabled> function.  Consider
1021 this snippet of code:
1022
1023     package MyMod::Abc;
1024
1025     sub open {
1026         if (warnings::enabled("deprecated")) {
1027             warnings::warn("deprecated",
1028                            "open is deprecated, use new instead");
1029         }
1030         new(@_);
1031     }
1032
1033     sub new
1034     ...
1035     1;
1036
1037 The function C<open> has been deprecated, so code has been included to
1038 display a warning message whenever the calling module has (at least) the
1039 "deprecated" warnings category enabled.  Something like this, say.
1040
1041     use warnings 'deprecated';
1042     use MyMod::Abc;
1043     ...
1044     MyMod::Abc::open($filename);
1045
1046 Either the C<warnings::warn> or C<warnings::warnif> function should be
1047 used to actually display the warnings message.  This is because they can
1048 make use of the feature that allows warnings to be escalated into fatal
1049 errors.  So in this case
1050
1051     use MyMod::Abc;
1052     use warnings FATAL => 'MyMod::Abc';
1053     ...
1054     MyMod::Abc::open('../fred.txt');
1055
1056 the C<warnings::warnif> function will detect this and die after
1057 displaying the warning message.
1058
1059 The three warnings functions, C<warnings::warn>, C<warnings::warnif>
1060 and C<warnings::enabled> can optionally take an object reference in place
1061 of a category name.  In this case the functions will use the class name
1062 of the object as the warnings category.
1063
1064 Consider this example:
1065
1066     package Original;
1067
1068     no warnings;
1069     use warnings::register;
1070
1071     sub new
1072     {
1073         my $class = shift;
1074         bless [], $class;
1075     }
1076
1077     sub check
1078     {
1079         my $self = shift;
1080         my $value = shift;
1081
1082         if ($value % 2 && warnings::enabled($self))
1083           { warnings::warn($self, "Odd numbers are unsafe") }
1084     }
1085
1086     sub doit
1087     {
1088         my $self = shift;
1089         my $value = shift;
1090         $self->check($value);
1091         # ...
1092     }
1093
1094     1;
1095
1096     package Derived;
1097
1098     use warnings::register;
1099     use Original;
1100     our @ISA = qw( Original );
1101     sub new
1102     {
1103         my $class = shift;
1104         bless [], $class;
1105     }
1106
1107
1108     1;
1109
1110 The code below makes use of both modules, but it only enables warnings from
1111 C<Derived>.
1112
1113     use Original;
1114     use Derived;
1115     use warnings 'Derived';
1116     my $a = Original->new();
1117     $a->doit(1);
1118     my $b = Derived->new();
1119     $a->doit(1);
1120
1121 When this code is run only the C<Derived> object, C<$b>, will generate
1122 a warning.
1123
1124     Odd numbers are unsafe at main.pl line 7
1125
1126 Notice also that the warning is reported at the line where the object is first
1127 used.
1128
1129 When registering new categories of warning, you can supply more names to
1130 warnings::register like this:
1131
1132     package MyModule;
1133     use warnings::register qw(format precision);
1134
1135     ...
1136
1137     warnings::warnif('MyModule::format', '...');
1138
1139 =head1 FUNCTIONS
1140
1141 =over 4
1142
1143 =item use warnings::register
1144
1145 Creates a new warnings category with the same name as the package where
1146 the call to the pragma is used.
1147
1148 =item warnings::enabled()
1149
1150 Use the warnings category with the same name as the current package.
1151
1152 Return TRUE if that warnings category is enabled in the calling module.
1153 Otherwise returns FALSE.
1154
1155 =item warnings::enabled($category)
1156
1157 Return TRUE if the warnings category, C<$category>, is enabled in the
1158 calling module.
1159 Otherwise returns FALSE.
1160
1161 =item warnings::enabled($object)
1162
1163 Use the name of the class for the object reference, C<$object>, as the
1164 warnings category.
1165
1166 Return TRUE if that warnings category is enabled in the first scope
1167 where the object is used.
1168 Otherwise returns FALSE.
1169
1170 =item warnings::fatal_enabled()
1171
1172 Return TRUE if the warnings category with the same name as the current
1173 package has been set to FATAL in the calling module.
1174 Otherwise returns FALSE.
1175
1176 =item warnings::fatal_enabled($category)
1177
1178 Return TRUE if the warnings category C<$category> has been set to FATAL in
1179 the calling module.
1180 Otherwise returns FALSE.
1181
1182 =item warnings::fatal_enabled($object)
1183
1184 Use the name of the class for the object reference, C<$object>, as the
1185 warnings category.
1186
1187 Return TRUE if that warnings category has been set to FATAL in the first
1188 scope where the object is used.
1189 Otherwise returns FALSE.
1190
1191 =item warnings::warn($message)
1192
1193 Print C<$message> to STDERR.
1194
1195 Use the warnings category with the same name as the current package.
1196
1197 If that warnings category has been set to "FATAL" in the calling module
1198 then die. Otherwise return.
1199
1200 =item warnings::warn($category, $message)
1201
1202 Print C<$message> to STDERR.
1203
1204 If the warnings category, C<$category>, has been set to "FATAL" in the
1205 calling module then die. Otherwise return.
1206
1207 =item warnings::warn($object, $message)
1208
1209 Print C<$message> to STDERR.
1210
1211 Use the name of the class for the object reference, C<$object>, as the
1212 warnings category.
1213
1214 If that warnings category has been set to "FATAL" in the scope where C<$object>
1215 is first used then die. Otherwise return.
1216
1217
1218 =item warnings::warnif($message)
1219
1220 Equivalent to:
1221
1222     if (warnings::enabled())
1223       { warnings::warn($message) }
1224
1225 =item warnings::warnif($category, $message)
1226
1227 Equivalent to:
1228
1229     if (warnings::enabled($category))
1230       { warnings::warn($category, $message) }
1231
1232 =item warnings::warnif($object, $message)
1233
1234 Equivalent to:
1235
1236     if (warnings::enabled($object))
1237       { warnings::warn($object, $message) }
1238
1239 =item warnings::register_categories(@names)
1240
1241 This registers warning categories for the given names and is primarily for
1242 use by the warnings::register pragma.
1243
1244 =back
1245
1246 See also L<perlmodlib/Pragmatic Modules> and L<perldiag>.
1247
1248 =cut
1249
1250 # ex: set ro: