]> git.sesse.net Git - vlc/blobdiff - src/modules/modules.h
Missing error check
[vlc] / src / modules / modules.h
index c0772a8e9dff1e0c454c20fcc61a3ce9cf425520..a87056083e79e25ef62194f0698ca51623225a14 100644 (file)
@@ -1,58 +1,30 @@
 /*****************************************************************************
  * modules.h : Module management functions.
  *****************************************************************************
- * Copyright (C) 2001 the VideoLAN team
+ * Copyright (C) 2001 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.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
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 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.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
-# error This header file can only be included from LibVLC.
-#endif
-
 #ifndef LIBVLC_MODULES_H
 # define LIBVLC_MODULES_H 1
 
-
-/* Number of tries before we unload an unused module */
-#define MODULE_HIDE_DELAY 50
-
-/*****************************************************************************
- * module_bank_t: the module bank
- *****************************************************************************
- * This variable is accessed by any function using modules.
- *****************************************************************************/
-struct module_bank_t
-{
-    unsigned         i_usage;
-
-    /* Plugins cache */
-    bool             b_cache;
-    bool             b_cache_dirty;
-
-    int            i_cache;
-    module_cache_t **pp_cache;
-
-    int            i_loaded_cache;
-    module_cache_t **pp_loaded_cache;
-
-    module_t       *head;
-};
+typedef struct module_cache_t module_cache_t;
 
 /*****************************************************************************
  * Module cache description structure
@@ -60,9 +32,9 @@ struct module_bank_t
 struct module_cache_t
 {
     /* Mandatory cache entry header */
-    char       *psz_file;
-    int64_t    i_time;
-    int64_t    i_size;
+    char  *path;
+    time_t mtime;
+    off_t  size;
 
     /* Optional extra data */
     module_t *p_module;
@@ -71,33 +43,28 @@ struct module_cache_t
 
 #define MODULE_SHORTCUT_MAX 20
 
-/* The module handle type. */
-#if defined(HAVE_DL_DYLD) && !defined(__x86_64__)
-#   if defined (HAVE_MACH_O_DYLD_H)
-#       include <mach-o/dyld.h>
-#   endif
-typedef NSModule module_handle_t;
-#elif defined(HAVE_IMAGE_H)
-typedef int module_handle_t;
-#elif defined(WIN32) || defined(UNDER_CE)
-typedef void * module_handle_t;
-#elif defined(HAVE_DL_DLOPEN)
-typedef void * module_handle_t;
-#elif defined(HAVE_DL_SHL_LOAD)
-typedef shl_t module_handle_t;
-#endif
+/** The module handle type */
+typedef void *module_handle_t;
+
+/** Plugin entry point prototype */
+typedef int (*vlc_plugin_cb) (int (*)(void *, void *, int, ...), void *);
+
+/** Main module */
+int vlc_entry__main (int (*)(void *, void *, int, ...), void *);
 
 /**
  * Internal module descriptor
  */
 struct module_t
 {
-    char       *psz_object_name;
     module_t   *next;
-    module_t   *submodule;
     module_t   *parent;
+    module_t   *submodule;
     unsigned    submodule_count;
-    gc_object_t vlc_gc_data;
+
+    /** Shortcuts to the module */
+    unsigned    i_shortcuts;
+    char        **pp_shortcuts;
 
     /*
      * Variables set by the module to identify itself
@@ -106,19 +73,15 @@ struct module_t
     char *psz_longname;                   /**< Module descriptive name */
     char *psz_help;        /**< Long help string for "special" modules */
 
-    /** Shortcuts to the module */
-    char **pp_shortcuts;
-    int    i_shortcuts;
-
     char    *psz_capability;                                 /**< Capability */
     int      i_score;                          /**< Score for the capability */
 
+    bool          b_loaded;        /* Set to true if the dll is loaded */
     bool b_unloadable;                        /**< Can we be dlclosed? */
-    bool b_submodule;                        /**< Is this a submodule? */
 
     /* Callbacks */
-    int  ( * pf_activate )   ( vlc_object_t * );
-    void ( * pf_deactivate ) ( vlc_object_t * );
+    void *pf_activate;
+    void *pf_deactivate;
 
     /*
      * Variables set by the module to store its config options
@@ -135,33 +98,36 @@ struct module_t
     module_handle_t     handle;                             /* Unique handle */
     char *              psz_filename;                     /* Module filename */
     char *              domain;                            /* gettext domain */
-
-    bool          b_builtin;  /* Set to true if the module is built in */
-    bool          b_loaded;        /* Set to true if the dll is loaded */
 };
 
-module_t *vlc_module_create (vlc_object_t *);
-module_t *vlc_submodule_create (module_t *module);
+module_t *vlc_plugin_describe (vlc_plugin_cb);
+module_t *vlc_module_create (module_t *);
+void vlc_module_destroy (module_t *);
 
-void  module_InitBank( vlc_object_t * );
-#define module_InitBank(a) module_InitBank(VLC_OBJECT(a))
-void module_LoadPlugins( vlc_object_t * );
+void module_InitBank (void);
+size_t module_LoadPlugins( vlc_object_t * );
 #define module_LoadPlugins(a) module_LoadPlugins(VLC_OBJECT(a))
-void module_EndBank( vlc_object_t *, bool );
-#define module_EndBank(a,b) module_EndBank(VLC_OBJECT(a), b)
+void module_EndBank (bool);
+int module_Map (vlc_object_t *, module_t *);
 
 int vlc_bindtextdomain (const char *);
 
 /* Low-level OS-dependent handler */
-int  module_Load   (vlc_object_t *, const char *, module_handle_t *);
-int  module_Call   (vlc_object_t *obj, module_t *);
+int module_Load (vlc_object_t *, const char *, module_handle_t *, bool);
+void *module_Lookup (module_handle_t, const char *);
 void module_Unload (module_handle_t);
 
 /* Plugins cache */
 void   CacheMerge (vlc_object_t *, module_t *, module_t *);
 void   CacheDelete(vlc_object_t *, const char *);
-void   CacheLoad  (vlc_object_t *, module_bank_t *, const char *);
-void   CacheSave  (vlc_object_t *, const char *, module_cache_t *const *, size_t);
-module_cache_t * CacheFind (module_bank_t *, const char *, int64_t, int64_t);
+size_t CacheLoad  (vlc_object_t *, const char *, module_cache_t **);
+
+struct stat;
+
+int CacheAdd (module_cache_t **, size_t *,
+              const char *, const struct stat *, module_t *);
+void CacheSave  (vlc_object_t *, const char *, module_cache_t *, size_t);
+module_t *CacheFind (module_cache_t *, size_t,
+                     const char *, const struct stat *);
 
 #endif /* !LIBVLC_MODULES_H */