NAME

XS::Assert - Provides assertion macros for XS modules

VERSION

This document describes XS::Assert version 0.002.

SYNOPSIS

    # in your Makefile.PL
    requires_xs 'XS::Assert'; # done by M::X::XSUtil

    /* in MyModule.xs */
        #include "xs_assert.h"

        /* and later */

        assert_sv_ok(sv);
        assert_sv_is_av(sv);

DESCRIPTION

XS::Assert provides various assertion macros for XS modules, which are enabled only if XS_ASSERT macro is defined.

MACROS

assert(expr)

assert_not_null(ptr)

assert_sv_type_is(sv, svtype)

assert_sv_is_av(sv)

assert_sv_is_hv(sv)

assert_sv_is_cv(sv)

assert_sv_is_gv(sv)

assert_sv_is_avref(sv)

assert_sv_is_hvref(sv)

assert_sv_is_cvref(sv)

assert_sv_is_gvref(sv)

assert_sv_is_object(sv)

assert_sv_ok(sv)

assert_sv_pok(sv)

assert_sv_iok(sv)

assert_sv_nok(sv)

assert_sv_rok(sv)

DEPENDENCIES

Perl 5.5.3 or later, and a C compiler.

BUGS

No bugs have been reported.

Please report any bugs or feature requests to the author.

SEE ALSO

Module::Install::XSUtil.

AUTHOR

Goro Fuji (gfx) <gfuji(at)cpan.org>

LICENSE AND COPYRIGHT

Copyright (c) 2009, Goro Fuji (gfx). Some rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm XS::Assert

perl -MCPAN -e shell
install XS::Assert