File: README

package info (click to toggle)
libb-hooks-op-check-perl 0.19-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 336 kB
  • ctags: 831
  • sloc: perl: 1,321; ansic: 10; makefile: 3
file content (66 lines) | stat: -rw-r--r-- 1,893 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
NAME
    B::Hooks::OP::Check - Wrap OP check callbacks

SYNOPSIS
        # 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);

DESCRIPTION
    This module provides a c api for XS modules to hook into the callbacks
    of "PL_check".

    ExtUtils::Depends is used to export all functions for other XS modules
    to use. Include the following in your Makefile.PL:

        my $pkg = ExtUtils::Depends->new('Your::XSModule', 'B::Hooks::OP::Check');
        WriteMakefile(
            ... # your normal makefile flags
            $pkg->get_makefile_vars,
        );

    Your XS module can now include "hook_op_check.h".

TYPES
  typedef OP *(*hook_op_check_cb) (pTHX_ OP *, void *);
    Type that callbacks need to implement.

  typedef UV hook_op_check_id
    Type to identify a callback.

FUNCTIONS
  hook_op_check_id hook_op_check (opcode type, hook_op_check_cb cb, void *user_data)
    Register the callback "cb" to be called after the "PL_check" function
    for opcodes of the given "type". "user_data" will be passed to the
    callback as the last argument. Returns an id that can be used to remove
    the callback later on.

  void *hook_op_check_remove (opcode type, hook_op_check_id id)
    Remove the callback identified by "id". Returns the userdata the
    callback had.

AUTHOR
    Florian Ragwitz <rafl@debian.org>

COPYRIGHT AND LICENSE
    Copyright (c) 2008 Florian Ragwitz

    This module is free software.

    You may distribute this code under the same terms as Perl itself.