1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252 |
- # -*- buffer-read-only: t -*-
- # !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
- # This file is built by regen/warnings.pl.
- # Any changes made here will be lost!
- package warnings;
- our $VERSION = "1.34";
- # Verify that we're called correctly so that warnings will work.
- # see also strict.pm.
- unless ( __FILE__ =~ /(^|[\/\\])\Q${\__PACKAGE__}\E\.pmc?$/ ) {
- my (undef, $f, $l) = caller;
- die("Incorrect use of pragma '${\__PACKAGE__}' at $f line $l.\n");
- }
- our %Offsets = (
- # Warnings Categories added in Perl 5.008
- 'all' => 0,
- 'closure' => 2,
- 'deprecated' => 4,
- 'exiting' => 6,
- 'glob' => 8,
- 'io' => 10,
- 'closed' => 12,
- 'exec' => 14,
- 'layer' => 16,
- 'newline' => 18,
- 'pipe' => 20,
- 'unopened' => 22,
- 'misc' => 24,
- 'numeric' => 26,
- 'once' => 28,
- 'overflow' => 30,
- 'pack' => 32,
- 'portable' => 34,
- 'recursion' => 36,
- 'redefine' => 38,
- 'regexp' => 40,
- 'severe' => 42,
- 'debugging' => 44,
- 'inplace' => 46,
- 'internal' => 48,
- 'malloc' => 50,
- 'signal' => 52,
- 'substr' => 54,
- 'syntax' => 56,
- 'ambiguous' => 58,
- 'bareword' => 60,
- 'digit' => 62,
- 'parenthesis' => 64,
- 'precedence' => 66,
- 'printf' => 68,
- 'prototype' => 70,
- 'qw' => 72,
- 'reserved' => 74,
- 'semicolon' => 76,
- 'taint' => 78,
- 'threads' => 80,
- 'uninitialized' => 82,
- 'unpack' => 84,
- 'untie' => 86,
- 'utf8' => 88,
- 'void' => 90,
- # Warnings Categories added in Perl 5.011
- 'imprecision' => 92,
- 'illegalproto' => 94,
- # Warnings Categories added in Perl 5.013
- 'non_unicode' => 96,
- 'nonchar' => 98,
- 'surrogate' => 100,
- # Warnings Categories added in Perl 5.017
- 'experimental' => 102,
- 'experimental::lexical_subs' => 104,
- 'experimental::lexical_topic' => 106,
- 'experimental::regex_sets' => 108,
- 'experimental::smartmatch' => 110,
- # Warnings Categories added in Perl 5.019
- 'experimental::autoderef' => 112,
- 'experimental::postderef' => 114,
- 'experimental::signatures' => 116,
- 'syscalls' => 118,
- # Warnings Categories added in Perl 5.021
- 'experimental::bitwise' => 120,
- 'experimental::const_attr' => 122,
- 'experimental::re_strict' => 124,
- 'experimental::refaliasing' => 126,
- 'experimental::win32_perlio' => 128,
- 'locale' => 130,
- 'missing' => 132,
- 'redundant' => 134,
- );
- our %Bits = (
- 'all' => "\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55\x55", # [0..67]
- 'ambiguous' => "\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [29]
- 'bareword' => "\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [30]
- 'closed' => "\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [6]
- 'closure' => "\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [1]
- 'debugging' => "\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [22]
- 'deprecated' => "\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [2]
- 'digit' => "\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [31]
- 'exec' => "\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [7]
- 'exiting' => "\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [3]
- 'experimental' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x55\x15\x55\x01", # [51..58,60..64]
- 'experimental::autoderef' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00", # [56]
- 'experimental::bitwise' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00", # [60]
- 'experimental::const_attr' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00", # [61]
- 'experimental::lexical_subs' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00", # [52]
- 'experimental::lexical_topic' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00", # [53]
- 'experimental::postderef' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00", # [57]
- 'experimental::re_strict' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00", # [62]
- 'experimental::refaliasing' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00", # [63]
- 'experimental::regex_sets' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00", # [54]
- 'experimental::signatures' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00", # [58]
- 'experimental::smartmatch' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00", # [55]
- 'experimental::win32_perlio' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01", # [64]
- 'glob' => "\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [4]
- 'illegalproto' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00", # [47]
- 'imprecision' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00", # [46]
- 'inplace' => "\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [23]
- 'internal' => "\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [24]
- 'io' => "\x00\x54\x55\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00", # [5..11,59]
- 'layer' => "\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [8]
- 'locale' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04", # [65]
- 'malloc' => "\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [25]
- 'misc' => "\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [12]
- 'missing' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10", # [66]
- 'newline' => "\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [9]
- 'non_unicode' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00", # [48]
- 'nonchar' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00", # [49]
- 'numeric' => "\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [13]
- 'once' => "\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [14]
- 'overflow' => "\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [15]
- 'pack' => "\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [16]
- 'parenthesis' => "\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00", # [32]
- 'pipe' => "\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [10]
- 'portable' => "\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [17]
- 'precedence' => "\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x00", # [33]
- 'printf' => "\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00", # [34]
- 'prototype' => "\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00", # [35]
- 'qw' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00", # [36]
- 'recursion' => "\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [18]
- 'redefine' => "\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [19]
- 'redundant' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40", # [67]
- 'regexp' => "\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [20]
- 'reserved' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00", # [37]
- 'semicolon' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00", # [38]
- 'severe' => "\x00\x00\x00\x00\x00\x54\x05\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [21..25]
- 'signal' => "\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [26]
- 'substr' => "\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [27]
- 'surrogate' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00", # [50]
- 'syntax' => "\x00\x00\x00\x00\x00\x00\x00\x55\x55\x15\x00\x40\x00\x00\x00\x00\x00", # [28..38,47]
- 'syscalls' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00", # [59]
- 'taint' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00", # [39]
- 'threads' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00", # [40]
- 'uninitialized' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00", # [41]
- 'unopened' => "\x00\x00\x40\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [11]
- 'unpack' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00\x00\x00\x00", # [42]
- 'untie' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x40\x00\x00\x00\x00\x00\x00", # [43]
- 'utf8' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x15\x00\x00\x00\x00", # [44,48..50]
- 'void' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00\x00\x00\x00\x00", # [45]
- );
- our %DeadBits = (
- 'all' => "\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa\xaa", # [0..67]
- 'ambiguous' => "\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [29]
- 'bareword' => "\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [30]
- 'closed' => "\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [6]
- 'closure' => "\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [1]
- 'debugging' => "\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [22]
- 'deprecated' => "\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [2]
- 'digit' => "\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [31]
- 'exec' => "\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [7]
- 'exiting' => "\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [3]
- 'experimental' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\xaa\x2a\xaa\x02", # [51..58,60..64]
- 'experimental::autoderef' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00", # [56]
- 'experimental::bitwise' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00", # [60]
- 'experimental::const_attr' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00", # [61]
- 'experimental::lexical_subs' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00", # [52]
- 'experimental::lexical_topic' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00", # [53]
- 'experimental::postderef' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00", # [57]
- 'experimental::re_strict' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00", # [62]
- 'experimental::refaliasing' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00", # [63]
- 'experimental::regex_sets' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00", # [54]
- 'experimental::signatures' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00", # [58]
- 'experimental::smartmatch' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00", # [55]
- 'experimental::win32_perlio' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02", # [64]
- 'glob' => "\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [4]
- 'illegalproto' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00", # [47]
- 'imprecision' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00", # [46]
- 'inplace' => "\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [23]
- 'internal' => "\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [24]
- 'io' => "\x00\xa8\xaa\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00", # [5..11,59]
- 'layer' => "\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [8]
- 'locale' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08", # [65]
- 'malloc' => "\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [25]
- 'misc' => "\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [12]
- 'missing' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20", # [66]
- 'newline' => "\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [9]
- 'non_unicode' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00", # [48]
- 'nonchar' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00", # [49]
- 'numeric' => "\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [13]
- 'once' => "\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [14]
- 'overflow' => "\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [15]
- 'pack' => "\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [16]
- 'parenthesis' => "\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00", # [32]
- 'pipe' => "\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [10]
- 'portable' => "\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [17]
- 'precedence' => "\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00\x00", # [33]
- 'printf' => "\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00", # [34]
- 'prototype' => "\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00", # [35]
- 'qw' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00", # [36]
- 'recursion' => "\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [18]
- 'redefine' => "\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [19]
- 'redundant' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80", # [67]
- 'regexp' => "\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [20]
- 'reserved' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00\x00", # [37]
- 'semicolon' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00", # [38]
- 'severe' => "\x00\x00\x00\x00\x00\xa8\x0a\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [21..25]
- 'signal' => "\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [26]
- 'substr' => "\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [27]
- 'surrogate' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00", # [50]
- 'syntax' => "\x00\x00\x00\x00\x00\x00\x00\xaa\xaa\x2a\x00\x80\x00\x00\x00\x00\x00", # [28..38,47]
- 'syscalls' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00", # [59]
- 'taint' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00", # [39]
- 'threads' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00", # [40]
- 'uninitialized' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00\x00", # [41]
- 'unopened' => "\x00\x00\x80\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00", # [11]
- 'unpack' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x20\x00\x00\x00\x00\x00\x00", # [42]
- 'untie' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00\x00\x00\x00", # [43]
- 'utf8' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x2a\x00\x00\x00\x00", # [44,48..50]
- 'void' => "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x08\x00\x00\x00\x00\x00", # [45]
- );
- # These are used by various things, including our own tests
- our $NONE = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
- our $DEFAULT = "\x10\x01\x00\x00\x00\x50\x04\x00\x00\x00\x00\x00\x00\x55\x15\x55\x05", # [2,56,60,61,52,53,57,62,63,54,58,55,64,4,65,22,23,25]
- our $LAST_BIT = 136 ;
- our $BYTES = 17 ;
- our $All = "" ; vec($All, $Offsets{'all'}, 2) = 3 ;
- sub Croaker
- {
- require Carp; # this initializes %CarpInternal
- local $Carp::CarpInternal{'warnings'};
- delete $Carp::CarpInternal{'warnings'};
- Carp::croak(@_);
- }
- sub _bits {
- my $mask = shift ;
- my $catmask ;
- my $fatal = 0 ;
- my $no_fatal = 0 ;
- foreach my $word ( @_ ) {
- if ($word eq 'FATAL') {
- $fatal = 1;
- $no_fatal = 0;
- }
- elsif ($word eq 'NONFATAL') {
- $fatal = 0;
- $no_fatal = 1;
- }
- elsif ($catmask = $Bits{$word}) {
- $mask |= $catmask ;
- $mask |= $DeadBits{$word} if $fatal ;
- $mask &= ~($DeadBits{$word}|$All) if $no_fatal ;
- }
- else
- { Croaker("Unknown warnings category '$word'")}
- }
- return $mask ;
- }
- sub bits
- {
- # called from B::Deparse.pm
- push @_, 'all' unless @_ ;
- return _bits(undef, @_) ;
- }
- sub import
- {
- shift;
- my $mask = ${^WARNING_BITS} // ($^W ? $Bits{all} : $DEFAULT) ;
- if (vec($mask, $Offsets{'all'}, 1)) {
- $mask |= $Bits{'all'} ;
- $mask |= $DeadBits{'all'} if vec($mask, $Offsets{'all'}+1, 1);
- }
- # append 'all' when implied (after a lone "FATAL" or "NONFATAL")
- push @_, 'all' if @_==1 && ( $_[0] eq 'FATAL' || $_[0] eq 'NONFATAL' );
- # Empty @_ is equivalent to @_ = 'all' ;
- ${^WARNING_BITS} = @_ ? _bits($mask, @_) : $mask | $Bits{all} ;
- }
- sub unimport
- {
- shift;
- my $catmask ;
- my $mask = ${^WARNING_BITS} // ($^W ? $Bits{all} : $DEFAULT) ;
- if (vec($mask, $Offsets{'all'}, 1)) {
- $mask |= $Bits{'all'} ;
- $mask |= $DeadBits{'all'} if vec($mask, $Offsets{'all'}+1, 1);
- }
- # append 'all' when implied (empty import list or after a lone "FATAL")
- push @_, 'all' if !@_ || @_==1 && $_[0] eq 'FATAL';
- foreach my $word ( @_ ) {
- if ($word eq 'FATAL') {
- next;
- }
- elsif ($catmask = $Bits{$word}) {
- $mask &= ~($catmask | $DeadBits{$word} | $All);
- }
- else
- { Croaker("Unknown warnings category '$word'")}
- }
- ${^WARNING_BITS} = $mask ;
- }
- my %builtin_type; @builtin_type{qw(SCALAR ARRAY HASH CODE REF GLOB LVALUE Regexp)} = ();
- sub MESSAGE () { 4 };
- sub FATAL () { 2 };
- sub NORMAL () { 1 };
- sub __chk
- {
- my $category ;
- my $offset ;
- my $isobj = 0 ;
- my $wanted = shift;
- my $has_message = $wanted & MESSAGE;
- unless (@_ == 1 || @_ == ($has_message ? 2 : 0)) {
- my $sub = (caller 1)[3];
- my $syntax = $has_message ? "[category,] 'message'" : '[category]';
- Croaker("Usage: $sub($syntax)");
- }
- my $message = pop if $has_message;
- if (@_) {
- # check the category supplied.
- $category = shift ;
- if (my $type = ref $category) {
- Croaker("not an object")
- if exists $builtin_type{$type};
- $category = $type;
- $isobj = 1 ;
- }
- $offset = $Offsets{$category};
- Croaker("Unknown warnings category '$category'")
- unless defined $offset;
- }
- else {
- $category = (caller(1))[0] ;
- $offset = $Offsets{$category};
- Croaker("package '$category' not registered for warnings")
- unless defined $offset ;
- }
- my $i;
- if ($isobj) {
- my $pkg;
- $i = 2;
- while (do { { package DB; $pkg = (caller($i++))[0] } } ) {
- last unless @DB::args && $DB::args[0] =~ /^$category=/ ;
- }
- $i -= 2 ;
- }
- else {
- $i = _error_loc(); # see where Carp will allocate the error
- }
- # Default to 0 if caller returns nothing. Default to $DEFAULT if it
- # explicitly returns undef.
- my(@callers_bitmask) = (caller($i))[9] ;
- my $callers_bitmask =
- @callers_bitmask ? $callers_bitmask[0] // $DEFAULT : 0 ;
- my @results;
- foreach my $type (FATAL, NORMAL) {
- next unless $wanted & $type;
- push @results, (vec($callers_bitmask, $offset + $type - 1, 1) ||
- vec($callers_bitmask, $Offsets{'all'} + $type - 1, 1));
- }
- # &enabled and &fatal_enabled
- return $results[0] unless $has_message;
- # &warnif, and the category is neither enabled as warning nor as fatal
- return if $wanted == (NORMAL | FATAL | MESSAGE)
- && !($results[0] || $results[1]);
- require Carp;
- Carp::croak($message) if $results[0];
- # will always get here for &warn. will only get here for &warnif if the
- # category is enabled
- Carp::carp($message);
- }
- sub _mkMask
- {
- my ($bit) = @_;
- my $mask = "";
- vec($mask, $bit, 1) = 1;
- return $mask;
- }
- sub register_categories
- {
- my @names = @_;
- for my $name (@names) {
- if (! defined $Bits{$name}) {
- $Bits{$name} = _mkMask($LAST_BIT);
- vec($Bits{'all'}, $LAST_BIT, 1) = 1;
- $Offsets{$name} = $LAST_BIT ++;
- foreach my $k (keys %Bits) {
- vec($Bits{$k}, $LAST_BIT, 1) = 0;
- }
- $DeadBits{$name} = _mkMask($LAST_BIT);
- vec($DeadBits{'all'}, $LAST_BIT++, 1) = 1;
- }
- }
- }
- sub _error_loc {
- require Carp;
- goto &Carp::short_error_loc; # don't introduce another stack frame
- }
- sub enabled
- {
- return __chk(NORMAL, @_);
- }
- sub fatal_enabled
- {
- return __chk(FATAL, @_);
- }
- sub warn
- {
- return __chk(FATAL | MESSAGE, @_);
- }
- sub warnif
- {
- return __chk(NORMAL | FATAL | MESSAGE, @_);
- }
- # These are not part of any public interface, so we can delete them to save
- # space.
- delete @warnings::{qw(NORMAL FATAL MESSAGE)};
- 1;
- __END__
- =head1 NAME
- warnings - Perl pragma to control optional warnings
- =head1 SYNOPSIS
- use warnings;
- no warnings;
- use warnings "all";
- no warnings "all";
- use warnings::register;
- if (warnings::enabled()) {
- warnings::warn("some warning");
- }
- if (warnings::enabled("void")) {
- warnings::warn("void", "some warning");
- }
- if (warnings::enabled($object)) {
- warnings::warn($object, "some warning");
- }
- warnings::warnif("some warning");
- warnings::warnif("void", "some warning");
- warnings::warnif($object, "some warning");
- =head1 DESCRIPTION
- The C<warnings> pragma gives control over which warnings are enabled in
- which parts of a Perl program. It's a more flexible alternative for
- both the command line flag B<-w> and the equivalent Perl variable,
- C<$^W>.
- This pragma works just like the C<strict> pragma.
- This means that the scope of the warning pragma is limited to the
- enclosing block. It also means that the pragma setting will not
- leak across files (via C<use>, C<require> or C<do>). This allows
- authors to independently define the degree of warning checks that will
- be applied to their module.
- By default, optional warnings are disabled, so any legacy code that
- doesn't attempt to control the warnings will work unchanged.
- All warnings are enabled in a block by either of these:
- use warnings;
- use warnings 'all';
- Similarly all warnings are disabled in a block by either of these:
- no warnings;
- no warnings 'all';
- For example, consider the code below:
- use warnings;
- my @a;
- {
- no warnings;
- my $b = @a[0];
- }
- my $c = @a[0];
- The code in the enclosing block has warnings enabled, but the inner
- block has them disabled. In this case that means the assignment to the
- scalar C<$c> will trip the C<"Scalar value @a[0] better written as $a[0]">
- warning, but the assignment to the scalar C<$b> will not.
- =head2 Default Warnings and Optional Warnings
- Before the introduction of lexical warnings, Perl had two classes of
- warnings: mandatory and optional.
- As its name suggests, if your code tripped a mandatory warning, you
- would get a warning whether you wanted it or not.
- For example, the code below would always produce an C<"isn't numeric">
- warning about the "2:".
- my $a = "2:" + 3;
- With the introduction of lexical warnings, mandatory warnings now become
- I<default> warnings. The difference is that although the previously
- mandatory warnings are still enabled by default, they can then be
- subsequently enabled or disabled with the lexical warning pragma. For
- example, in the code below, an C<"isn't numeric"> warning will only
- be reported for the C<$a> variable.
- my $a = "2:" + 3;
- no warnings;
- my $b = "2:" + 3;
- Note that neither the B<-w> flag or the C<$^W> can be used to
- disable/enable default warnings. They are still mandatory in this case.
- =head2 What's wrong with B<-w> and C<$^W>
- Although very useful, the big problem with using B<-w> on the command
- line to enable warnings is that it is all or nothing. Take the typical
- scenario when you are writing a Perl program. Parts of the code you
- will write yourself, but it's very likely that you will make use of
- pre-written Perl modules. If you use the B<-w> flag in this case, you
- end up enabling warnings in pieces of code that you haven't written.
- Similarly, using C<$^W> to either disable or enable blocks of code is
- fundamentally flawed. For a start, say you want to disable warnings in
- a block of code. You might expect this to be enough to do the trick:
- {
- local ($^W) = 0;
- my $a =+ 2;
- my $b; chop $b;
- }
- When this code is run with the B<-w> flag, a warning will be produced
- for the C<$a> line: C<"Reversed += operator">.
- The problem is that Perl has both compile-time and run-time warnings. To
- disable compile-time warnings you need to rewrite the code like this:
- {
- BEGIN { $^W = 0 }
- my $a =+ 2;
- my $b; chop $b;
- }
- The other big problem with C<$^W> is the way you can inadvertently
- change the warning setting in unexpected places in your code. For example,
- when the code below is run (without the B<-w> flag), the second call
- to C<doit> will trip a C<"Use of uninitialized value"> warning, whereas
- the first will not.
- sub doit
- {
- my $b; chop $b;
- }
- doit();
- {
- local ($^W) = 1;
- doit()
- }
- This is a side-effect of C<$^W> being dynamically scoped.
- Lexical warnings get around these limitations by allowing finer control
- over where warnings can or can't be tripped.
- =head2 Controlling Warnings from the Command Line
- There are three Command Line flags that can be used to control when
- warnings are (or aren't) produced:
- =over 5
- =item B<-w>
- X<-w>
- This is the existing flag. If the lexical warnings pragma is B<not>
- used in any of you code, or any of the modules that you use, this flag
- will enable warnings everywhere. See L<Backward Compatibility> for
- details of how this flag interacts with lexical warnings.
- =item B<-W>
- X<-W>
- If the B<-W> flag is used on the command line, it will enable all warnings
- throughout the program regardless of whether warnings were disabled
- locally using C<no warnings> or C<$^W =0>.
- This includes all files that get
- included via C<use>, C<require> or C<do>.
- Think of it as the Perl equivalent of the "lint" command.
- =item B<-X>
- X<-X>
- Does the exact opposite to the B<-W> flag, i.e. it disables all warnings.
- =back
- =head2 Backward Compatibility
- If you are used to working with a version of Perl prior to the
- introduction of lexically scoped warnings, or have code that uses both
- lexical warnings and C<$^W>, this section will describe how they interact.
- How Lexical Warnings interact with B<-w>/C<$^W>:
- =over 5
- =item 1.
- If none of the three command line flags (B<-w>, B<-W> or B<-X>) that
- control warnings is used and neither C<$^W> nor the C<warnings> pragma
- are used, then default warnings will be enabled and optional warnings
- disabled.
- This means that legacy code that doesn't attempt to control the warnings
- will work unchanged.
- =item 2.
- The B<-w> flag just sets the global C<$^W> variable as in 5.005. This
- means that any legacy code that currently relies on manipulating C<$^W>
- to control warning behavior will still work as is.
- =item 3.
- Apart from now being a boolean, the C<$^W> variable operates in exactly
- the same horrible uncontrolled global way, except that it cannot
- disable/enable default warnings.
- =item 4.
- If a piece of code is under the control of the C<warnings> pragma,
- both the C<$^W> variable and the B<-w> flag will be ignored for the
- scope of the lexical warning.
- =item 5.
- The only way to override a lexical warnings setting is with the B<-W>
- or B<-X> command line flags.
- =back
- The combined effect of 3 & 4 is that it will allow code which uses
- the C<warnings> pragma to control the warning behavior of $^W-type
- code (using a C<local $^W=0>) if it really wants to, but not vice-versa.
- =head2 Category Hierarchy
- X<warning, categories>
- A hierarchy of "categories" have been defined to allow groups of warnings
- to be enabled/disabled in isolation.
- The current hierarchy is:
- all -+
- |
- +- closure
- |
- +- deprecated
- |
- +- exiting
- |
- +- experimental --+
- | |
- | +- experimental::autoderef
- | |
- | +- experimental::bitwise
- | |
- | +- experimental::const_attr
- | |
- | +- experimental::lexical_subs
- | |
- | +- experimental::lexical_topic
- | |
- | +- experimental::postderef
- | |
- | +- experimental::re_strict
- | |
- | +- experimental::refaliasing
- | |
- | +- experimental::regex_sets
- | |
- | +- experimental::signatures
- | |
- | +- experimental::smartmatch
- | |
- | +- experimental::win32_perlio
- |
- +- glob
- |
- +- imprecision
- |
- +- io ------------+
- | |
- | +- closed
- | |
- | +- exec
- | |
- | +- layer
- | |
- | +- newline
- | |
- | +- pipe
- | |
- | +- syscalls
- | |
- | +- unopened
- |
- +- locale
- |
- +- misc
- |
- +- missing
- |
- +- numeric
- |
- +- once
- |
- +- overflow
- |
- +- pack
- |
- +- portable
- |
- +- recursion
- |
- +- redefine
- |
- +- redundant
- |
- +- regexp
- |
- +- severe --------+
- | |
- | +- debugging
- | |
- | +- inplace
- | |
- | +- internal
- | |
- | +- malloc
- |
- +- signal
- |
- +- substr
- |
- +- syntax --------+
- | |
- | +- ambiguous
- | |
- | +- bareword
- | |
- | +- digit
- | |
- | +- illegalproto
- | |
- | +- parenthesis
- | |
- | +- precedence
- | |
- | +- printf
- | |
- | +- prototype
- | |
- | +- qw
- | |
- | +- reserved
- | |
- | +- semicolon
- |
- +- taint
- |
- +- threads
- |
- +- uninitialized
- |
- +- unpack
- |
- +- untie
- |
- +- utf8 ----------+
- | |
- | +- non_unicode
- | |
- | +- nonchar
- | |
- | +- surrogate
- |
- +- void
- Just like the "strict" pragma any of these categories can be combined
- use warnings qw(void redefine);
- no warnings qw(io syntax untie);
- Also like the "strict" pragma, if there is more than one instance of the
- C<warnings> pragma in a given scope the cumulative effect is additive.
- use warnings qw(void); # only "void" warnings enabled
- ...
- use warnings qw(io); # only "void" & "io" warnings enabled
- ...
- no warnings qw(void); # only "io" warnings enabled
- To determine which category a specific warning has been assigned to see
- L<perldiag>.
- Note: Before Perl 5.8.0, the lexical warnings category "deprecated" was a
- sub-category of the "syntax" category. It is now a top-level category
- in its own right.
- Note: Before 5.21.0, the "missing" lexical warnings category was
- internally defined to be the same as the "uninitialized" category. It
- is now a top-level category in its own right.
- =head2 Fatal Warnings
- X<warning, fatal>
- The presence of the word "FATAL" in the category list will escalate
- warnings in those categories into fatal errors in that lexical scope.
- B<NOTE:> FATAL warnings should be used with care, particularly
- C<< FATAL => 'all' >>.
- Libraries using L<warnings::warn|/FUNCTIONS> for custom warning categories
- generally don't expect L<warnings::warn|/FUNCTIONS> to be fatal and can wind up
- in an unexpected state as a result. For XS modules issuing categorized
- warnings, such unanticipated exceptions could also expose memory leak bugs.
- Moreover, the Perl interpreter itself has had serious bugs involving
- fatalized warnings. For a summary of resolved and unresolved problems as
- of January 2015, please see
- L<this perl5-porters post|http://www.nntp.perl.org/group/perl.perl5.porters/2015/01/msg225235.html>.
- While some developers find fatalizing some warnings to be a useful
- defensive programming technique, using C<< FATAL => 'all' >> to fatalize
- all possible warning categories -- including custom ones -- is particularly
- risky. Therefore, the use of C<< FATAL => 'all' >> is
- L<discouraged|perlpolicy/discouraged>.
- The L<strictures|strictures/VERSION-2> module on CPAN offers one example of
- a warnings subset that the module's authors believe is relatively safe to
- fatalize.
- B<NOTE:> users of FATAL warnings, especially those using
- C<< FATAL => 'all' >>, should be fully aware that they are risking future
- portability of their programs by doing so. Perl makes absolutely no
- commitments to not introduce new warnings or warnings categories in the
- future; indeed, we explicitly reserve the right to do so. Code that may
- not warn now may warn in a future release of Perl if the Perl5 development
- team deems it in the best interests of the community to do so. Should code
- using FATAL warnings break due to the introduction of a new warning we will
- NOT consider it an incompatible change. Users of FATAL warnings should
- take special caution during upgrades to check to see if their code triggers
- any new warnings and should pay particular attention to the fine print of
- the documentation of the features they use to ensure they do not exploit
- features that are documented as risky, deprecated, or unspecified, or where
- the documentation says "so don't do that", or anything with the same sense
- and spirit. Use of such features in combination with FATAL warnings is
- ENTIRELY AT THE USER'S RISK.
- The following documentation describes how to use FATAL warnings but the
- perl5 porters strongly recommend that you understand the risks before doing
- so, especially for library code intended for use by others, as there is no
- way for downstream users to change the choice of fatal categories.
- In the code below, the use of C<time>, C<length>
- and C<join> can all produce a C<"Useless use of xxx in void context">
- warning.
- use warnings;
- time;
- {
- use warnings FATAL => qw(void);
- length "abc";
- }
- join "", 1,2,3;
- print "done\n";
- When run it produces this output
- Useless use of time in void context at fatal line 3.
- Useless use of length in void context at fatal line 7.
- The scope where C<length> is used has escalated the C<void> warnings
- category into a fatal error, so the program terminates immediately when it
- encounters the warning.
- To explicitly turn off a "FATAL" warning you just disable the warning
- it is associated with. So, for example, to disable the "void" warning
- in the example above, either of these will do the trick:
- no warnings qw(void);
- no warnings FATAL => qw(void);
- If you want to downgrade a warning that has been escalated into a fatal
- error back to a normal warning, you can use the "NONFATAL" keyword. For
- example, the code below will promote all warnings into fatal errors,
- except for those in the "syntax" category.
- use warnings FATAL => 'all', NONFATAL => 'syntax';
- As of Perl 5.20, instead of C<< use warnings FATAL => 'all'; >> you can
- use:
- use v5.20; # Perl 5.20 or greater is required for the following
- use warnings 'FATAL'; # short form of "use warnings FATAL => 'all';"
- If you want your program to be compatible with versions of Perl before
- 5.20, you must use C<< use warnings FATAL => 'all'; >> instead. (In
- previous versions of Perl, the behavior of the statements
- C<< use warnings 'FATAL'; >>, C<< use warnings 'NONFATAL'; >> and
- C<< no warnings 'FATAL'; >> was unspecified; they did not behave as if
- they included the C<< => 'all' >> portion. As of 5.20, they do.)
- =head2 Reporting Warnings from a Module
- X<warning, reporting> X<warning, registering>
- The C<warnings> pragma provides a number of functions that are useful for
- module authors. These are used when you want to report a module-specific
- warning to a calling module has enabled warnings via the C<warnings>
- pragma.
- Consider the module C<MyMod::Abc> below.
- package MyMod::Abc;
- use warnings::register;
- sub open {
- my $path = shift;
- if ($path !~ m#^/#) {
- warnings::warn("changing relative path to /var/abc")
- if warnings::enabled();
- $path = "/var/abc/$path";
- }
- }
- 1;
- The call to C<warnings::register> will create a new warnings category
- called "MyMod::Abc", i.e. the new category name matches the current
- package name. The C<open> function in the module will display a warning
- message if it gets given a relative path as a parameter. This warnings
- will only be displayed if the code that uses C<MyMod::Abc> has actually
- enabled them with the C<warnings> pragma like below.
- use MyMod::Abc;
- use warnings 'MyMod::Abc';
- ...
- abc::open("../fred.txt");
- It is also possible to test whether the pre-defined warnings categories are
- set in the calling module with the C<warnings::enabled> function. Consider
- this snippet of code:
- package MyMod::Abc;
- sub open {
- if (warnings::enabled("deprecated")) {
- warnings::warn("deprecated",
- "open is deprecated, use new instead");
- }
- new(@_);
- }
- sub new
- ...
- 1;
- The function C<open> has been deprecated, so code has been included to
- display a warning message whenever the calling module has (at least) the
- "deprecated" warnings category enabled. Something like this, say.
- use warnings 'deprecated';
- use MyMod::Abc;
- ...
- MyMod::Abc::open($filename);
- Either the C<warnings::warn> or C<warnings::warnif> function should be
- used to actually display the warnings message. This is because they can
- make use of the feature that allows warnings to be escalated into fatal
- errors. So in this case
- use MyMod::Abc;
- use warnings FATAL => 'MyMod::Abc';
- ...
- MyMod::Abc::open('../fred.txt');
- the C<warnings::warnif> function will detect this and die after
- displaying the warning message.
- The three warnings functions, C<warnings::warn>, C<warnings::warnif>
- and C<warnings::enabled> can optionally take an object reference in place
- of a category name. In this case the functions will use the class name
- of the object as the warnings category.
- Consider this example:
- package Original;
- no warnings;
- use warnings::register;
- sub new
- {
- my $class = shift;
- bless [], $class;
- }
- sub check
- {
- my $self = shift;
- my $value = shift;
- if ($value % 2 && warnings::enabled($self))
- { warnings::warn($self, "Odd numbers are unsafe") }
- }
- sub doit
- {
- my $self = shift;
- my $value = shift;
- $self->check($value);
- # ...
- }
- 1;
- package Derived;
- use warnings::register;
- use Original;
- our @ISA = qw( Original );
- sub new
- {
- my $class = shift;
- bless [], $class;
- }
- 1;
- The code below makes use of both modules, but it only enables warnings from
- C<Derived>.
- use Original;
- use Derived;
- use warnings 'Derived';
- my $a = Original->new();
- $a->doit(1);
- my $b = Derived->new();
- $a->doit(1);
- When this code is run only the C<Derived> object, C<$b>, will generate
- a warning.
- Odd numbers are unsafe at main.pl line 7
- Notice also that the warning is reported at the line where the object is first
- used.
- When registering new categories of warning, you can supply more names to
- warnings::register like this:
- package MyModule;
- use warnings::register qw(format precision);
- ...
- warnings::warnif('MyModule::format', '...');
- =head1 FUNCTIONS
- =over 4
- =item use warnings::register
- Creates a new warnings category with the same name as the package where
- the call to the pragma is used.
- =item warnings::enabled()
- Use the warnings category with the same name as the current package.
- Return TRUE if that warnings category is enabled in the calling module.
- Otherwise returns FALSE.
- =item warnings::enabled($category)
- Return TRUE if the warnings category, C<$category>, is enabled in the
- calling module.
- Otherwise returns FALSE.
- =item warnings::enabled($object)
- Use the name of the class for the object reference, C<$object>, as the
- warnings category.
- Return TRUE if that warnings category is enabled in the first scope
- where the object is used.
- Otherwise returns FALSE.
- =item warnings::fatal_enabled()
- Return TRUE if the warnings category with the same name as the current
- package has been set to FATAL in the calling module.
- Otherwise returns FALSE.
- =item warnings::fatal_enabled($category)
- Return TRUE if the warnings category C<$category> has been set to FATAL in
- the calling module.
- Otherwise returns FALSE.
- =item warnings::fatal_enabled($object)
- Use the name of the class for the object reference, C<$object>, as the
- warnings category.
- Return TRUE if that warnings category has been set to FATAL in the first
- scope where the object is used.
- Otherwise returns FALSE.
- =item warnings::warn($message)
- Print C<$message> to STDERR.
- Use the warnings category with the same name as the current package.
- If that warnings category has been set to "FATAL" in the calling module
- then die. Otherwise return.
- =item warnings::warn($category, $message)
- Print C<$message> to STDERR.
- If the warnings category, C<$category>, has been set to "FATAL" in the
- calling module then die. Otherwise return.
- =item warnings::warn($object, $message)
- Print C<$message> to STDERR.
- Use the name of the class for the object reference, C<$object>, as the
- warnings category.
- If that warnings category has been set to "FATAL" in the scope where C<$object>
- is first used then die. Otherwise return.
- =item warnings::warnif($message)
- Equivalent to:
- if (warnings::enabled())
- { warnings::warn($message) }
- =item warnings::warnif($category, $message)
- Equivalent to:
- if (warnings::enabled($category))
- { warnings::warn($category, $message) }
- =item warnings::warnif($object, $message)
- Equivalent to:
- if (warnings::enabled($object))
- { warnings::warn($object, $message) }
- =item warnings::register_categories(@names)
- This registers warning categories for the given names and is primarily for
- use by the warnings::register pragma.
- =back
- See also L<perlmodlib/Pragmatic Modules> and L<perldiag>.
- =cut
- # ex: set ro:
|