.\" -*- 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 "B::Hooks::OP::Check 3pm"
.TH B::Hooks::OP::Check 3pm 2024-03-07 "perl v5.38.2" "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
B::Hooks::OP::Check \- Wrap OP check callbacks
.SH VERSION
.IX Header "VERSION"
version 0.22
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    # include "hook_op_check.h"
\&
\&    STATIC OP *my_const_check_op (pTHX_ OP *op, void *user_data) {
\&        /* ... */
\&        return op;
\&    }
\&
\&    STATIC hook_op_check_id my_hook_id = 0;
\&
\&    void
\&    setup ()
\&        CODE:
\&            my_hook_id = hook_op_check (OP_CONST, my_const_check_op, NULL);
\&
\&    void
\&    teardown ()
\&        CODE:
\&            hook_op_check_remove (OP_CONST, my_hook_id);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides a C API for XS modules to hook into the callbacks of
\&\f(CW\*(C`PL_check\*(C'\fR.
.PP
ExtUtils::Depends is used to export all functions for other XS modules to
use. Include the following in your Makefile.PL:
.PP
.Vb 5
\&    my $pkg = ExtUtils::Depends\->new(\*(AqYour::XSModule\*(Aq, \*(AqB::Hooks::OP::Check\*(Aq);
\&    WriteMakefile(
\&        ... # your normal makefile flags
\&        $pkg\->get_makefile_vars,
\&    );
.Ve
.PP
Your XS module can now include \f(CW\*(C`hook_op_check.h\*(C'\fR.
.SH TYPES
.IX Header "TYPES"
.SS "typedef OP *(*hook_op_check_cb) (pTHX_ OP *, void *);"
.IX Subsection "typedef OP *(*hook_op_check_cb) (pTHX_ OP *, void *);"
Type that callbacks need to implement.
.SS "typedef UV hook_op_check_id"
.IX Subsection "typedef UV hook_op_check_id"
Type to identify a callback.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.SS "hook_op_check_id hook_op_check (opcode type, hook_op_check_cb cb, void *user_data)"
.IX Subsection "hook_op_check_id hook_op_check (opcode type, hook_op_check_cb cb, void *user_data)"
Register the callback \f(CW\*(C`cb\*(C'\fR to be called after the \f(CW\*(C`PL_check\*(C'\fR function for
opcodes of the given \f(CW\*(C`type\*(C'\fR. \f(CW\*(C`user_data\*(C'\fR will be passed to the callback as
the last argument. Returns an id that can be used to remove the callback later
on.
.SS "void *hook_op_check_remove (opcode type, hook_op_check_id id)"
.IX Subsection "void *hook_op_check_remove (opcode type, hook_op_check_id id)"
Remove the callback identified by \f(CW\*(C`id\*(C'\fR. Returns the user_data that the callback had.
.SH SUPPORT
.IX Header "SUPPORT"
Bugs may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=B-Hooks-OP-Check>
(or bug\-B\-Hooks\-OP\-Check@rt.cpan.org <mailto:bug-B-Hooks-OP-Check@rt.cpan.org>).
.SH AUTHOR
.IX Header "AUTHOR"
Florian Ragwitz <rafl@debian.org>
.SH CONTRIBUTORS
.IX Header "CONTRIBUTORS"
.IP \(bu 4
Karen Etheridge <ether@cpan.org>
.IP \(bu 4
Zefram <zefram@fysh.org>
.IP \(bu 4
Alexandr Ciornii <alexchorny@gmail.com>
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2008 by Florian Ragwitz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.