src/plugin.h

   1 /* Gnome Music Player Client (GMPC)
   2  * Copyright (C) 2004-2012 Qball Cow <qball@gmpclient.org>
   3  * Project homepage: http://gmpclient.org/
   4
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include <gtk/gtk.h>
  21 #include <libmpd/libmpd.h>
  22 #include "metadata.h"
  23 #include "config1.h"
  24 #include "gmpc-extras.h"
  25 #include "gmpc-mpddata-treeview.h"
  26
  27 //#include "gmpc-paned-size-group.h"
  28
  29 #ifndef __PLUGIN_H__
  30 #define __PLUGIN_H__
  31
  32 #define PLUGIN_ID_MARK 1024
  33 #define PLUGIN_ID_INTERNALL 2048
  34 /* Usefull signal objects. */
  35 extern config_obj *config;
  36 extern MpdObj *connection;
  37 extern GmpcProfiles *gmpc_profiles;
  38 extern GmpcConnection     *gmpcconn;
  39
  40
  41 typedef struct _gmpcPluginParent gmpcPluginParent;
  42 /* Plugin Type's */
  43 /* This is a bitmask.*/
  44 typedef enum {
  45     GMPC_PLUGIN_DUMMY         = 1,
  46     GMPC_PLUGIN_PL_BROWSER    = 2,
  47     GMPC_PLUGIN_NO_GUI        = 4,
  48     GMPC_INTERNALL            = 8,
  49     GMPC_DEPRECATED           = 16,
  50     GMPC_DEPRECATED2          = 32,
  51     /* Make compiler happy about GMPC_PLUGIN_PL_BROWSER|GMPC_PLUGIN_METADATA */
  52     GMPC_BROWSER_META         = 34
  53 } PluginType;
  54
  55 /* the gtk_tree_store row's */
  56 typedef enum
  57 {
  58     PL3_CAT_TYPE, /** Plugin id */
  59     PL3_CAT_TITLE, /** title that is showed */
  60     PL3_CAT_INT_ID, /* id */
  61     PL3_CAT_ICON_ID, /* icon id */
  62     PL3_CAT_ORDER, /* int for sorting the list */
  63     PL3_CAT_BOLD,
  64     PL3_CAT_STOCK_ID,
  65     PL3_CAT_SHOW_TEXT,
  66     PL3_CAT_NROWS
  67 } pl3_cat_store;
  68
  69 typedef enum
  70 {
  71     PL3_CAT_BROWSER_TOP             = 0,
  72     PL3_CAT_BROWSER_LIBRARY         = 1000,
  73     PL3_CAT_BROWSER_ONLINE_MEDIA    = 2000,
  74     PL3_CAT_BROWSER_MISC            = 3000
  75 } Pl3CatBrowserType;
  76 /* structures */
  77 /** gmpcPrefPlugin: need to be instant apply.
  78  * Plugin is expected to fill the container with it preferences widgets. (gtk_container_add)
  79  * if destroy is called, it needs to detacht it from the container (gtk_container_remove)
  80  */
  81 typedef struct {
  82     void (*construct)(GtkWidget *container);
  83     void (*destroy)(GtkWidget *container);
  84     /* Padding */
  85     void (*padding1)                (void);
  86     void (*padding2)                (void);
  87     void (*padding3)                (void);
  88 } gmpcPrefPlugin;
  89
  90 /** gmpcPlBrowserPlugin, functions needed for intergration with the playlist browser
  91  */
  92 typedef struct {
  93     /**
  94      * Adding to the left side tree */
  95     void (*add)                        (GtkWidget *cat_tree);
  96     /**
  97      * If selected,  you need to fill the right screen */
  98     void (*selected)                (GtkWidget *container);
  99     /**
 100      * if unselected, you need to remove youself from the container
 101      */
 102     void (*unselected)                (GtkWidget *container);
 103     int  (*cat_right_mouse_menu)    (GtkWidget *menu, int type, GtkWidget *tree,GdkEventButton *event);
 104     void (*cat_key_press)            (GtkWidget *tree, GdkEventKey *event, int selected_type) G_GNUC_DEPRECATED;
 105     /****** GO MENU ********/
 106     int  (*add_go_menu)                (GtkWidget *menu);
 107     /****** Key presses (in the whole window) **/
 108     int  (*key_press_event)            (GtkWidget *mw, GdkEventKey *event, int type);
 109     /** Song list right mouse menu intergration.
 110      * This is only called (And allowed to be called) if the treeview is a GmpcMpdDataTreeview with songs
 111      */
 112     int (*song_list_option_menu)    (GmpcMpdDataTreeview *tree, GtkMenu *menu);
 113     /* Padding */
 114     MpdData * (*integrate_search)   (const int search_field,const gchar *search_query,GError **error);
 115     gboolean  (*integrate_search_field_supported) (const int search_field);
 116     void (*padding3)                (void);
 117 } gmpcPlBrowserPlugin;
 118
 119 /* Unique number                */
 120 /* 16 == 0.14 release           */
 121 /* 17 == 0.15.5 release         */
 122 /* 18 ==       16 december      */
 123 /* 19 == 0.16*  24 december     */
 124 /* 20 == 0.16.5 release         */
 125 /* 21 == 0.17.0 release -> adding padding so abi wont break next time */
 126 #define PLUGIN_API_VERSION 21
 127
 128 /* sturcture */
 129 typedef struct {
 130     /* Name of the plugin */
 131     const char                        *name;
 132     /* Version number */
 133     const int                        version[3];
 134     /* Type of Plugin */
 135     PluginType                        plugin_type;
 136     /* unique plugin id */
 137     /* do not fill in, is done by gmpc */
 138     int                                id;
 139
 140     /* path where the plugin is (only directory) can be used to get location of f.e. glade/images
 141      * Don't use this anymore use: gmpc_get.*_path */
 142     /* Do not fill in, done by gmpc */
 143     char                            *path;
 144     /* function gets called on startup */
 145     void                            (*init)(void);
 146     /* Plugin should destroy all it's widgets and free all allocated space */
 147     void                            (*destroy)(void);
 148     /* Browser Plugins */
 149     gmpcPlBrowserPlugin                *browser;
 150     /* plugin with one signal for changes on Mpd */
 151     StatusChangedCallback            mpd_status_changed;
 152     /* (dis)connect signal */
 153     ConnectionChangedCallback         mpd_connection_changed;
 154     /* structure to let the plugin intergrate it's preferences */
 155     gmpcPrefPlugin                    *pref;
 156     /** Meta data, this is deprecated, do not use.*/
 157     void                                *padding;
 158
 159     /** Plugin control functions
 160      */
 161     int                                 (*get_enabled)(void);
 162     void                            (*set_enabled)(int enable);
 163     /* Function that is called when the plugin is going to be destroyed,
 164      * This is the place if you want to save settings
 165      */
 166     void                            (*save_yourself)(void);
 167
 168     /* Padding */
 169     gint    (*tool_menu_integration)    (GtkMenu *menu);
 170     const gchar*  (*get_translation_domain)   (void);
 171     void (*padding3)                (void);
 172 } gmpcPlugin;
 173
 174
 175 /**
 176  * Allows the plugin to access the EasyCommand
 177  */
 178 extern GmpcEasyCommand *gmpc_easy_command;
 179
 180 /**
 181  * Playlist function
 182  */
 183
 184 /**
 185  * Get the treeview and tree_store of the category list on the left.
 186  */
 187 GtkListStore *    playlist3_get_category_tree_store(void);
 188 GtkTreeView *    playlist3_get_category_tree_view(void);
 189
 190 /**
 191  * Get this GtkWindow of the playlist.
 192  * Use this to set parent and so
 193  */
 194 GtkWidget * playlist3_get_window(void);
 195 /**
 196  * indicates if the window is hidden to tray
 197  */
 198 gboolean    playlist3_window_is_hidden(void);
 199
 200 /** plugin functions */
 201 gmpcPluginParent *     plugin_get_from_id(int id);
 202
 203
 204 /**
 205  * Helper functions to get path to gmpc directory and metadata directory
 206  */
 207
 208 char  *         gmpc_get_full_glade_path(const char *filename);
 209 gchar *         gmpc_get_covers_path(const gchar *filename);
 210 gchar *         gmpc_get_user_path(const gchar *filename);
 211 gchar *         gmpc_get_cache_directory(const gchar *filename);
 212 void             playlist3_insert_browser(GtkTreeIter *iter, gint position);
 213
 214
 215 void pl3_option_menu_activate(void);
 216 /* Tell mpd to reload the go menu */
 217 void            pl3_update_go_menu(void);
 218
 219
 220 /* Used by plugins themself */
 221 gchar *         gmpc_plugin_get_data_path                   (gmpcPlugin *plug);
 222
 223 /**
 224  * Update parts of the gui
 225  */
 226 void pl3_tool_menu_update(void);
 227
 228
 229 /***/
 230
 231 const char *connection_get_music_directory(void);
 232 /* glue */
 233
 234 void info2_fill_song_view(mpd_Song *song);
 235 void info2_activate(void);
 236
 237 void info2_fill_artist_view(const gchar *artist);
 238 void info2_fill_album_view(const gchar *artist,const gchar *album);
 239
 240 extern GObject *paned_size_group;
 241
 242 /** Main window */
 243
 244
 245 /**
 246 * show the main window
 247 */
 248 void create_playlist3(void);
 249 /**
 250  * Get the state of the sidebar
 251  */
 252 GmpcPluginSidebarState playlist3_get_sidebar_state(void);
 253
 254 /**
 255 * hide the main window
 256 */
 257 int pl3_hide(void);
 258
 259 extern GmpcMetaWatcher *gmw;
 260 #endif