plugin.h

Go to the documentation of this file.

/*
  PLUGIN.h  -  Plugin loader

  Copyright (C)         Lumiera.org
    2008,               Christian Thaeter <ct@pipapo.org>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/


#ifndef COMMON_PLUGIN_H
#define COMMON_PLUGIN_H

#include "lib/psplay.h"
#include "lib/error.h"

#include "common/interface.h"

#include <stdlib.h>
#include <nobug.h>


LUMIERA_ERROR_DECLARE(PLUGIN_INIT);
LUMIERA_ERROR_DECLARE(PLUGIN_OPEN);
LUMIERA_ERROR_DECLARE(PLUGIN_WTF);
LUMIERA_ERROR_DECLARE(PLUGIN_REGISTER);
LUMIERA_ERROR_DECLARE(PLUGIN_VERSION);




struct lumiera_plugin_struct;
typedef struct lumiera_plugin_struct lumiera_plugin;
typedef lumiera_plugin* LumieraPlugin;


LumieraPlugin
lumiera_plugin_new (const char* name);

LumieraPlugin
lumiera_plugin_init (LumieraPlugin self, void* handle, LumieraInterface plugin);


LumieraPlugin
lumiera_plugin_load (const char* plugin);


int
lumiera_plugin_register (LumieraPlugin self);


lumiera_err
lumiera_plugin_error (LumieraPlugin self);

void*
lumiera_plugin_handle (LumieraPlugin self);


const char*
lumiera_plugin_name (LumieraPlugin self);


void
lumiera_plugin_refinc (LumieraPlugin self);


void
lumiera_plugin_refdec (LumieraPlugin self);


unsigned
lumiera_plugin_unload (LumieraPlugin self);


LumieraPlugin
lumiera_plugin_lookup (const char* name);


int
lumiera_plugin_discover (LumieraPlugin (*callback_load)(const char* plugin),
                         int (*callback_register) (LumieraPlugin));


/* === psplay support functions === */

int
lumiera_plugin_cmp_fn (const void* keya, const void* keyb);

const void*
lumiera_plugin_key_fn (const PSplaynode node);

void
lumiera_plugin_delete_fn (PSplaynode node);



#endif /*COMMON_PLUGIN_H*/