.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Policy::InputOutput::RequireCheckedSyscalls 3pm"
.TH Perl::Critic::Policy::InputOutput::RequireCheckedSyscalls 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::Policy::InputOutput::RequireCheckedSyscalls \- Return value of flagged function ignored.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This performs identically to InputOutput::RequireCheckedOpen/Close
except that this is configurable to apply to any function, whether
core or user-defined.
.PP
If your module uses Fatal,
Fatal::Exception, or autodie then any functions
wrapped by those modules will not trigger this policy.  For example:
.PP
.Vb 3
\&    use Fatal qw(open);
\&    open my $fh, $filename;  # no violation
\&    close $fh;               # yes violation
\&
\&    use autodie;
\&    open $filehandle, $mode, $filename;   # no violation
.Ve
.PP
Currently, autodie is not properly treated as a pragma; its
lexical effects aren't taken into account.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
This policy watches for a configurable list of function names.  By
default, it applies to \f(CW\*(C`open\*(C'\fR, \f(CW\*(C`print\*(C'\fR, \f(CW\*(C`say\*(C'\fR and \f(CW\*(C`close\*(C'\fR.  You can
override this to set it to a different list of functions with the
\&\f(CW\*(C`functions\*(C'\fR and \f(CW\*(C`exclude_functions\*(C'\fR settings.  To do this, put
entries in a \fI.perlcriticrc\fR file like this:
.PP
.Vb 2
\&    [InputOutput::RequireCheckedSyscalls]
\&    functions = open opendir read readline readdir close closedir
.Ve
.PP
We have defined a few shortcuts for creating this list
.PP
.Vb 2
\&    [InputOutput::RequireCheckedSyscalls]
\&    functions = :defaults opendir readdir closedir
\&
\&    [InputOutput::RequireCheckedSyscalls]
\&    functions = :builtins
\&
\&    [InputOutput::RequireCheckedSyscalls]
\&    functions = :all
.Ve
.PP
The \f(CW\*(C`:builtins\*(C'\fR shortcut above represents all of the builtin
functions that have error conditions (about 65 of them, many of them
rather obscure).
.PP
You can require checking all builtins except \f(CW\*(C`print\*(C'\fR by combining
the \f(CW\*(C`functions\*(C'\fR and \f(CW\*(C`exclude_functions\*(C'\fR:
.PP
.Vb 3
\&    [InputOutput::RequireCheckedSyscalls]
\&    functions = :builtins
\&    exclude_functions = print
.Ve
.PP
This is a lot easier to read than the alternative.
.PP
The \f(CW\*(C`:all\*(C'\fR is the insane case: you must check the return value of
EVERY function call, even \f(CW\*(C`return\*(C'\fR and \f(CW\*(C`exit\*(C'\fR.  Yes, this "feature"
is overkill and is wasting CPU cycles on your computer by just
existing.  Nyah nyah.  I shouldn't code after midnight.
.PP
If you create a module that exports \f(CW\*(C`autodie\*(C'\fR you can tell this policy about
it with the \f(CW\*(C`autodie_modules\*(C'\fR setting:
.PP
.Vb 2
\&    [InputOutput::RequireCheckedSyscalls]
\&    autodie_modules = My::Thing
.Ve
.SH CREDITS
.IX Header "CREDITS"
Initial development of this policy was supported by a grant from the
Perl Foundation.
.PP
This policy module is based heavily on policies written by Andrew
Moore <amoore@mooresystems.com>.
.SH AUTHOR
.IX Header "AUTHOR"
Chris Dolan <cdolan@cpan.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2007\-2011 Chris Dolan.  Many rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.  The full text of this license
can be found in the LICENSE file included with this module.