pidgin/plugins/perl/common/Pidgin.pm

Thu, 30 Oct 2008 22:40:49 +0000

author
Richard Laager <rlaager@pidgin.im>
date
Thu, 30 Oct 2008 22:40:49 +0000
changeset 24569
5dbd0617a27d
parent 16623
5d685c111d7b
child 16661
f3d9a3646735
child 18068
b6554e3c8224
child 33955
55aa58076485
permissions
-rw-r--r--

Build everything with the *_DISABLE_DEPRECATED flags set. This allows us
to detect when we're still using deprecated functions internally (and by
extension, when we've deprecated something we shouldn't have). In the
course of developing this changeset, I fixed a few such cases.

Given that the plan is to switch from PURPLE_HIDE_STRUCTS to
PURPLE_DISABLE_DEPRECATED as each struct is fully dealt with, this will
also ensure we have no regressions on the struct hiding work.

Deprecated functions are still available to the respective .c file, to
avoid missing prototype errors. Also, Perl and DBus undef the
*_DISABLE_DEPRECATED defines as appropriate so that deprecated functions
will still be exported to Perl plugins and via DBus. (Otherwise, we'd
be breaking backwards compatibility.)

package Pidgin;

use 5.008;
use strict;
use warnings;
use Carp;

our $VERSION = '0.01';

use Purple;

require XSLoader;
XSLoader::load('Pidgin', $VERSION);

1;
__END__

=head1 NAME

Pidgin - Perl extension for the Pidgin instant messenger.

=head1 SYNOPSIS

    use Pidgin;

=head1 ABSTRACT

    This module provides the interface for using perl scripts as plugins in
    Pidgin, with access to the Pidgin Gtk interface functions.

=head1 DESCRIPTION

This module provides the interface for using perl scripts as plugins in Pidgin,
with access to the Pidgin Gtk interface functions. With this, developers can
write perl scripts that can be loaded in Pidgin as plugins. The script can
interact with IMs, chats, accounts, the buddy list, pidgin signals, and more.

The API for the perl interface is very similar to that of the Pidgin C API,
which can be viewed at http://developer.pidgin.im/doxygen/ or in the header files
in the Pidgin source tree.

=head1 FUNCTIONS

=over

=back

=head1 SEE ALSO
Pidgin C API documentation - http://developer.pidgin.im/doxygen/

The Pidgin perl module.

Pidgin website - http://pidgin.im/

=head1 AUTHOR

Etan Reisner, E<lt>deryni@gmail.comE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright 2006 by Etan Reisner

mercurial