xed/pluma/pluma-plugin-info.c

397 lines
8.6 KiB
C

/*
* pluma-plugin-info.c
* This file is part of pluma
*
* Copyright (C) 2002-2005 - Paolo Maggi
* Copyright (C) 2007 - Paolo Maggi, Steve Frécinaux
*
* 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., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
/*
* Modified by the pluma Team, 2002-2007. See the AUTHORS file for a
* list of people on the pluma Team.
* See the ChangeLog files for a list of changes.
*
* $Id$
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string.h>
#include <glib/gi18n.h>
#include <glib.h>
#include "pluma-plugin-info.h"
#include "pluma-plugin-info-priv.h"
#include "pluma-debug.h"
#include "pluma-plugin.h"
void
_pluma_plugin_info_ref (PlumaPluginInfo *info)
{
g_atomic_int_inc (&info->refcount);
}
static PlumaPluginInfo *
pluma_plugin_info_copy (PlumaPluginInfo *info)
{
_pluma_plugin_info_ref (info);
return info;
}
void
_pluma_plugin_info_unref (PlumaPluginInfo *info)
{
if (!g_atomic_int_dec_and_test (&info->refcount))
return;
if (info->plugin != NULL)
{
pluma_debug_message (DEBUG_PLUGINS, "Unref plugin %s", info->name);
g_object_unref (info->plugin);
}
g_free (info->file);
g_free (info->module_name);
g_strfreev (info->dependencies);
g_free (info->name);
g_free (info->desc);
g_free (info->icon_name);
g_free (info->website);
g_free (info->copyright);
g_free (info->loader);
g_free (info->version);
g_strfreev (info->authors);
g_free (info);
}
/**
* pluma_plugin_info_get_type:
*
* Retrieves the #GType object which is associated with the #PlumaPluginInfo
* class.
*
* Return value: the GType associated with #PlumaPluginInfo.
**/
GType
pluma_plugin_info_get_type (void)
{
static GType the_type = 0;
if (G_UNLIKELY (!the_type))
the_type = g_boxed_type_register_static (
"PlumaPluginInfo",
(GBoxedCopyFunc) pluma_plugin_info_copy,
(GBoxedFreeFunc) _pluma_plugin_info_unref);
return the_type;
}
/**
* pluma_plugin_info_new:
* @filename: the filename where to read the plugin information
*
* Creates a new #PlumaPluginInfo from a file on the disk.
*
* Return value: a newly created #PlumaPluginInfo.
*/
PlumaPluginInfo *
_pluma_plugin_info_new (const gchar *file)
{
PlumaPluginInfo *info;
GKeyFile *plugin_file = NULL;
gchar *str;
g_return_val_if_fail (file != NULL, NULL);
pluma_debug_message (DEBUG_PLUGINS, "Loading plugin: %s", file);
info = g_new0 (PlumaPluginInfo, 1);
info->refcount = 1;
info->file = g_strdup (file);
plugin_file = g_key_file_new ();
if (!g_key_file_load_from_file (plugin_file, file, G_KEY_FILE_NONE, NULL))
{
g_warning ("Bad plugin file: %s", file);
goto error;
}
if (!g_key_file_has_key (plugin_file,
"Pluma Plugin",
"IAge",
NULL))
{
pluma_debug_message (DEBUG_PLUGINS,
"IAge key does not exist in file: %s", file);
goto error;
}
/* Check IAge=2 */
if (g_key_file_get_integer (plugin_file,
"Pluma Plugin",
"IAge",
NULL) != 2)
{
pluma_debug_message (DEBUG_PLUGINS,
"Wrong IAge in file: %s", file);
goto error;
}
/* Get module name */
str = g_key_file_get_string (plugin_file,
"Pluma Plugin",
"Module",
NULL);
if ((str != NULL) && (*str != '\0'))
{
info->module_name = str;
}
else
{
g_warning ("Could not find 'Module' in %s", file);
g_free (str);
goto error;
}
/* Get the dependency list */
info->dependencies = g_key_file_get_string_list (plugin_file,
"Pluma Plugin",
"Depends",
NULL,
NULL);
if (info->dependencies == NULL)
{
pluma_debug_message (DEBUG_PLUGINS, "Could not find 'Depends' in %s", file);
info->dependencies = g_new0 (gchar *, 1);
}
/* Get the loader for this plugin */
str = g_key_file_get_string (plugin_file,
"Pluma Plugin",
"Loader",
NULL);
if ((str != NULL) && (*str != '\0'))
{
info->loader = str;
}
else
{
/* default to the C loader */
info->loader = g_strdup("c");
g_free (str);
}
/* Get Name */
str = g_key_file_get_locale_string (plugin_file,
"Pluma Plugin",
"Name",
NULL, NULL);
if (str)
info->name = str;
else
{
g_warning ("Could not find 'Name' in %s", file);
goto error;
}
/* Get Description */
str = g_key_file_get_locale_string (plugin_file,
"Pluma Plugin",
"Description",
NULL, NULL);
if (str)
info->desc = str;
else
pluma_debug_message (DEBUG_PLUGINS, "Could not find 'Description' in %s", file);
/* Get Icon */
str = g_key_file_get_locale_string (plugin_file,
"Pluma Plugin",
"Icon",
NULL, NULL);
if (str)
info->icon_name = str;
else
pluma_debug_message (DEBUG_PLUGINS, "Could not find 'Icon' in %s, using 'pluma-plugin'", file);
/* Get Authors */
info->authors = g_key_file_get_string_list (plugin_file,
"Pluma Plugin",
"Authors",
NULL,
NULL);
if (info->authors == NULL)
pluma_debug_message (DEBUG_PLUGINS, "Could not find 'Authors' in %s", file);
/* Get Copyright */
str = g_key_file_get_string (plugin_file,
"Pluma Plugin",
"Copyright",
NULL);
if (str)
info->copyright = str;
else
pluma_debug_message (DEBUG_PLUGINS, "Could not find 'Copyright' in %s", file);
/* Get Website */
str = g_key_file_get_string (plugin_file,
"Pluma Plugin",
"Website",
NULL);
if (str)
info->website = str;
else
pluma_debug_message (DEBUG_PLUGINS, "Could not find 'Website' in %s", file);
/* Get Version */
str = g_key_file_get_string (plugin_file,
"Pluma Plugin",
"Version",
NULL);
if (str)
info->version = str;
else
pluma_debug_message (DEBUG_PLUGINS, "Could not find 'Version' in %s", file);
g_key_file_free (plugin_file);
/* If we know nothing about the availability of the plugin,
set it as available */
info->available = TRUE;
return info;
error:
g_free (info->file);
g_free (info->module_name);
g_free (info->name);
g_free (info->loader);
g_free (info);
g_key_file_free (plugin_file);
return NULL;
}
gboolean
pluma_plugin_info_is_active (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, FALSE);
return info->available && info->plugin != NULL;
}
gboolean
pluma_plugin_info_is_available (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, FALSE);
return info->available != FALSE;
}
gboolean
pluma_plugin_info_is_configurable (PlumaPluginInfo *info)
{
pluma_debug_message (DEBUG_PLUGINS, "Is '%s' configurable?", info->name);
g_return_val_if_fail (info != NULL, FALSE);
if (info->plugin == NULL || !info->available)
return FALSE;
return pluma_plugin_is_configurable (info->plugin);
}
const gchar *
pluma_plugin_info_get_module_name (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, NULL);
return info->module_name;
}
const gchar *
pluma_plugin_info_get_name (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, NULL);
return info->name;
}
const gchar *
pluma_plugin_info_get_description (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, NULL);
return info->desc;
}
const gchar *
pluma_plugin_info_get_icon_name (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, NULL);
/* use the pluma-plugin icon as a default if the plugin does not
have its own */
if (info->icon_name != NULL &&
gtk_icon_theme_has_icon (gtk_icon_theme_get_default (),
info->icon_name))
return info->icon_name;
else
return "pluma-plugin";
}
const gchar **
pluma_plugin_info_get_authors (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, (const gchar **)NULL);
return (const gchar **) info->authors;
}
const gchar *
pluma_plugin_info_get_website (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, NULL);
return info->website;
}
const gchar *
pluma_plugin_info_get_copyright (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, NULL);
return info->copyright;
}
const gchar *
pluma_plugin_info_get_version (PlumaPluginInfo *info)
{
g_return_val_if_fail (info != NULL, NULL);
return info->version;
}