Commit 21982cd2 authored by Paolo Borelli's avatar Paolo Borelli

Remove outdated tool to generate a plugin scheleton

parent 0d78f779
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# generate-plugin.py - gedit plugin skeletton generator
# This file is part of gedit
#
# Copyright (C) 2006 - Steve Frécinaux
#
# gedit 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.
#
# gedit 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 gedit; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor,
# Boston, MA 02110-1301 USA
import re
import os
import sys
import getopt
from datetime import date
import preprocessor
# Default values of command line options
options = {
'language' : 'python',
'description' : 'Type here a short description of your plugin',
'author' : os.getenv('USERNAME'),
'email' : os.getenv('LOGNAME') + '@email.com',
'standalone' : False,
'with-side-panel' : False,
'with-bottom-panel' : False,
'with-menu' : False,
'with-window-helper': True,
'with-config-dlg' : False
}
USAGE = """Usage:
%s [OPTIONS...] pluginname
""" % os.path.basename(sys.argv[0])
HELP = USAGE + """
generate skeleton source tree for a new gedit plugin.
Options:
--author Set the author name
--email Set the author email
--description Set the description you want for your new plugin
--standalone Is this plugin intended to be distributed as a
standalone package ? (N/A)
--language / -l Set the language (python/C) [default: %(language)s]
--with-$feature Enable $feature
--without-$feature Disable $feature
--help / -h Show this message and exits
Features:
window-helper Create a window helper object (python only)
config-dlg Plugin configuration dialog
menu Plugin menu entries
side-panel Side panel item (N/A)
bottom-panel Bottom panel item (N/A)
""" % options
TEMPLATE_DIR = os.path.join(os.path.dirname(sys.argv[0]), "plugin_template")
# Parsing command line options
try:
opts, args = getopt.getopt(sys.argv[1:],
'l:h',
['language=',
'description=',
'author=',
'email=',
'standalone',
'with-menu' , 'without-menu',
'with-side-panel' , 'without-side-panel',
'with-bottom-panel' , 'without-bottom-panel',
'with-window-helper', 'without-window-helper',
'with-config-dlg' , 'without-config-dlg',
'help'])
except getopt.error, exc:
print >>sys.stderr, '%s: %s' % (sys.argv[0], str(exc))
print >>sys.stderr, USAGE
sys.exit(1)
for opt, arg in opts:
if opt in ('-h', '--help'):
print >>sys.stderr, HELP
sys.exit(0)
elif opt in ('--description', '--author', '--email'):
options[opt[2:]] = arg
elif opt in ('-l', '--language'):
options['language'] = arg.lower()
elif opt == '--standalone':
options['standalone'] = True
elif opt[0:7] == '--with-':
options['with-' + opt[7:]] = True
elif opt[0:10] == '--without-':
options['with-' + opt[10:]] = False
# What's the new plugin name ?
if len(args) < 1:
print >>sys.stderr, USAGE
sys.exit(1)
plugin_name = args[0]
plugin_id = re.sub('[^a-z0-9_]', '', plugin_name.lower().replace(' ', '_'))
if options['language'] == 'python':
plugin_module = plugin_id.replace('_', '')
else:
plugin_module = plugin_id.replace('_', '-')
directives = {
'PLUGIN_NAME' : plugin_name,
'PLUGIN_MODULE' : plugin_module,
'PLUGIN_ID' : plugin_id,
'AUTHOR_FULLNAME' : options['author'],
'AUTHOR_EMAIL' : options['email'],
'DATE_YEAR' : date.today().year,
'DESCRIPTION' : options['description'],
}
# Files to be generated by the preprocessor, in the form "template : outfile"
output_files = {
'Makefile.am': '%s/Makefile.am' % plugin_module,
'gedit-plugin.desktop.in': '%s/%s.gedit-plugin.desktop.in' % (plugin_module, plugin_module)
}
if options['language'] == 'c':
output_files['gedit-plugin.c'] = '%s/%s-plugin.c' % (plugin_module, plugin_module)
output_files['gedit-plugin.h'] = '%s/%s-plugin.h' % (plugin_module, plugin_module)
elif options['language'] == 'python':
if options['with-window-helper']:
output_files['gedit-plugin-helper.py'] = '%s/%s.py' % (plugin_module, plugin_module)
else:
output_files['gedit-plugin-nohelper.py'] = '%s/%s.py' % (plugin_module, plugin_module)
directives['WITH_PYTHON'] = True
else:
print >>sys.stderr, 'Value of --language should be C or Python'
print >>sys.stderr, USAGE
sys.exit(1)
if options['standalone']:
output_files['configure.ac'] = 'configure.ac'
if options['with-side-panel']:
directives['WITH_SIDE_panel'] = True
if options['with-bottom-panel']:
directives['WITH_BOTTOM_panel'] = True
if options['with-menu']:
directives['WITH_MENU'] = True
if options['with-config-dlg']:
directives['WITH_CONFIGURE_DIALOG'] = True
# Generate the plugin base
for infile, outfile in output_files.iteritems():
print 'Processing %s\n' \
' into %s...' % (infile, outfile)
infile = os.path.join(TEMPLATE_DIR, infile)
outfile = os.path.join(os.getcwd(), outfile)
if not os.path.isfile(infile):
print >>sys.stderr, 'Input file does not exist : %s.' % os.path.basename(infile)
continue
# Make sure the destination directory exists
if not os.path.isdir(os.path.split(outfile)[0]):
os.makedirs(os.path.split(outfile)[0])
# Variables relative to the generated file
directives['DIRNAME'], directives['FILENAME'] = os.path.split(outfile)
# Generate the file
preprocessor.process(infile, outfile, directives.copy())
print 'Done.'
# ex:ts=4:et:
# ##(PLUGIN_NAME)
plugindir = $(libdir)/gedit-2/plugins
##ifdef WITH_PYTHON
plugin_PYTHON = \
##(PLUGIN_MODULE).py
##else
INCLUDES = \
-I$(top_srcdir) \
$(GEDIT_CFLAGS) \
$(WARN_CFLAGS) \
$(DISABLE_DEPRECATED_CFLAGS) \
-DGEDIT_LOCALEDIR=\""$(prefix)/$(DATADIRNAME)/locale"\"
plugin_LTLIBRARIES = lib##(PLUGIN_MODULE).la
lib##(PLUGIN_MODULE)_la_SOURCES = \
##(PLUGIN_MODULE)-plugin.h \
##(PLUGIN_MODULE)-plugin.c
lib##(PLUGIN_MODULE)_la_LDFLAGS = $(PLUGIN_LIBTOOL_FLAGS)
##endif
# Glade files (if you use glade for your plugin, list those files here)
gladedir = $(datadir)/gedit-2/glade
glade_DATA =
plugin_in_files = ##(PLUGIN_MODULE).gedit-plugin.desktop.in
%.gedit-plugin: %.gedit-plugin.desktop.in $(INTLTOOL_MERGE) $(wildcard $(top_srcdir)/po/*po) ; $(INTLTOOL_MERGE) $(top_srcdir)/po $< $@ -d -u -c $(top_builddir)/po/.intltool-merge-cache
plugin_DATA = $(plugin_in_files:.gedit-plugin.desktop.in=.gedit-plugin)
EXTRA_DIST = $(plugin_in_files)
CLEANFILES = $(plugin_DATA) $(glade_DATA)
DISTCLEANFILES = $(plugin_DATA) $(glade_DATA)
-include $(top_srcdir)/git.mk
# -*- coding: utf-8 -*-
# ##(FILENAME) - ##(DESCRIPTION)
#
# Copyright (C) ##(DATE_YEAR) - ##(AUTHOR_FULLNAME)
#
# 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., 59 Temple Place, Suite 330,
# Boston, MA 02111-1307, USA.
import gtk
import gedit
from gettext import gettext as _
##ifdef WITH_MENU
ui_str = """
<ui>
<menubar name="MenuBar">
<!-- Put your menu entries here -->
</menubar>
</ui>
"""
##endif
class ##(PLUGIN_ID.camel)WindowHelper:
def __init__(self, plugin, window):
self._window = window
self._plugin = plugin
##ifdef WITH_MENU
self.insert_menu()
##endif
def __del__(self):
self._window = None
self._plugin = None
def deactivate(self):
##ifdef WITH_MENU
self.remove_menu()
##else
pass
##endif
def update_ui(self):
pass
##ifdef WITH_MENU
def insert_menu(self):
manager = self._window.get_ui_manager()
self._action_group = gtk.ActionGroup("##(PLUGIN_ID.camel)PluginActions")
self._action_group.add_actions([
# Put your actions here
])
manager.insert_action_group(self._action_group, -1)
self._ui_id = manager.add_ui_from_string(ui_str)
def remove_menu(self):
manager = self._window.get_ui_manager()
manager.remove_ui(self._ui_id)
manager.remove_action_group(self._action_group)
manager.ensure_update()
##endif
class ##(PLUGIN_ID.camel)Plugin(gedit.Plugin):
WINDOW_DATA_KEY = "##(PLUGIN_ID.camel)PluginWindowData"
def __init__(self):
gedit.Plugin.__init__(self)
def activate(self, window):
helper = ##(PLUGIN_ID.camel)WindowHelper(self, window)
window.set_data(self.WINDOW_DATA_KEY, helper)
def deactivate(self, window):
window.get_data(self.WINDOW_DATA_KEY).deactivate()
window.set_data(self.WINDOW_DATA_KEY, None)
def update_ui(self, window):
window.get_data(self.WINDOW_DATA_KEY).update_ui()
##ifdef WITH_CONFIGURE_DIALOG
def create_configure_dialog(self):
pass
##endif
# ex:ts=4:et:
# -*- coding: utf-8 -*-
# ##(FILENAME) - ##(DESCRIPTION)
#
# Copyright (C) ##(DATE_YEAR) - ##(AUTHOR_FULLNAME)
#
# 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., 59 Temple Place, Suite 330,
# Boston, MA 02111-1307, USA.
import gtk
import gedit
from gettext import gettext as _
##ifdef WITH_MENU
ui_str = """
<ui>
<menubar name="MenuBar">
<!-- Put your menu entries here -->
</menubar>
</ui>
"""
##endif
class ##(PLUGIN_ID.camel)Plugin(gedit.Plugin):
WINDOW_DATA_KEY = "##(PLUGIN_ID.camel)PluginWindowData"
def __init__(self):
gedit.Plugin.__init__(self)
def activate(self, window):
##ifdef WITH_MENU
window.set_data(self.WINDOW_DATA_KEY, dict())
self.insert_menu(window)
##else
pass
##endif
def deactivate(self, window):
##ifdef WITH_MENU
self.remove_menu(window)
window.set_data(self.WINDOW_DATA_KEY, None)
##else
pass
##endif
def update_ui(self, window):
pass
##ifdef WITH_CONFIGURE_DIALOG
def create_configure_dialog(self):
pass
##endif
##ifdef WITH_MENU
def insert_menu(self, window):
data = window.get_data(self.WINDOW_DATA_KEY)
manager = window.get_ui_manager()
data['action_group'] = gtk.ActionGroup("##(PLUGIN_ID.camel)PluginActions")
data['action_group'].add_actions([
# Put your actions here
])
manager.insert_action_group(data['action_group'], -1)
data['ui_id'] = manager.add_ui_from_string(ui_str)
def remove_menu(self, window):
data = window.get_data(self.WINDOW_DATA_KEY)
manager = window.get_ui_manager()
manager.remove_ui(data['ui_id'])
manager.remove_action_group(data['action_group'])
manager.ensure_update()
##endif
# ex:ts=4:et:
/*
* ##(FILENAME) - ##(DESCRIPTION)
*
* Copyright (C) ##(DATE_YEAR) - ##(AUTHOR_FULLNAME)
*
* 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, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "##(PLUGIN_MODULE)-plugin.h"
#include <glib/gi18n-lib.h>
#include <gedit/gedit-debug.h>
#define WINDOW_DATA_KEY "##(PLUGIN_ID.camel)PluginWindowData"
#define ##(PLUGIN_ID.upper)_PLUGIN_GET_PRIVATE(object) (G_TYPE_INSTANCE_GET_PRIVATE ((object), TYPE_##(PLUGIN_ID.upper)_PLUGIN, ##(PLUGIN_ID.camel)PluginPrivate))
struct _##(PLUGIN_ID.camel)PluginPrivate
{
gpointer dummy;
};
GEDIT_PLUGIN_REGISTER_TYPE (##(PLUGIN_ID.camel)Plugin, ##(PLUGIN_ID.lower)_plugin)
##ifdef WITH_MENU
/* UI string. See gedit-ui.xml for reference */
static const gchar ui_str =
"<ui>"
" <menubar name='MenuBar'>"
" <!-- Put your menu entries here -->"
" </menubar>"
"</ui>";
/* UI actions */
static const GtkActionEntry action_entries[] =
{
/* Put your actions here */
};
typedef struct
{
GtkActionGroup *action_group;
guint ui_id;
} WindowData;
##endif
static void
##(PLUGIN_ID.lower)_plugin_init (##(PLUGIN_ID.camel)Plugin *plugin)
{
plugin->priv = ##(PLUGIN_ID.upper)_PLUGIN_GET_PRIVATE (plugin);
gedit_debug_message (DEBUG_PLUGINS,
"##(PLUGIN_ID.camel)Plugin initializing");
}
static void
##(PLUGIN_ID.lower)_plugin_finalize (GObject *object)
{
gedit_debug_message (DEBUG_PLUGINS,
"##(PLUGIN_ID.camel)Plugin finalizing");
G_OBJECT_CLASS (##(PLUGIN_ID.lower)_plugin_parent_class)->finalize (object);
}
##ifdef WITH_MENU
static void
free_window_data (WindowData *data)
{
g_return_if_fail (data != NULL);
g_object_unref (data->action_group);
g_free (data);
}
##endif
static void
impl_activate (GeditPlugin *plugin,
GeditWindow *window)
{
##ifdef WITH_MENU
GtkUIManager *manager;
WindowData *data;
##endif
gedit_debug (DEBUG_PLUGINS);
##ifdef WITH_MENU
data = g_new (WindowData, 1);
manager = gedit_window_get_ui_manager (window);
data->action_group = gtk_action_group_new ("##(PLUGIN_ID.camel)PluginActions");
gtk_action_group_set_translation_domain (data->action_group,
GETTEXT_PACKAGE);
gtk_action_group_add_actions (data->action_group,
action_entries,
G_N_ELEMENTS (action_entries),
window);
gtk_ui_manager_insert_action_group (manager, data->action_group, -1);
data->ui_id = gtk_ui_manager_add_ui_from_string (manager, ui_str,
-1, NULL);
g_object_set_data_full (G_OBJECT (window),
WINDOW_DATA_KEY,
data,
(GDestroyNotify) free_window_data);
##endif
}
static void
impl_deactivate (GeditPlugin *plugin,
GeditWindow *window)
{
##ifdef WITH_MENU
GtkUIManager *manager;
WindowData *data;
##endif
gedit_debug (DEBUG_PLUGINS);
##ifdef WITH_MENU
manager = gedit_window_get_ui_manager (window);
data = (WindowData *) g_object_get_data (G_OBJECT (window),
WINDOW_DATA_KEY);
g_return_if_fail (data != NULL);
gtk_ui_manager_remove_ui (manager, data->ui_id);
gtk_ui_manager_remove_action_group (manager, data->action_group);
g_object_set_data (G_OBJECT (window), WINDOW_DATA_KEY, NULL);
##endif
}
static void
impl_update_ui (GeditPlugin *plugin,
GeditWindow *window)
{
gedit_debug (DEBUG_PLUGINS);
}
##ifdef WITH_CONFIGURE_DIALOG
static GtkWidget *
impl_create_configure_dialog (GeditPlugin *plugin)
{
gedit_debug (DEBUG_PLUGINS);
}
##endif
static void
##(PLUGIN_ID.lower)_plugin_class_init (##(PLUGIN_ID.camel)PluginClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GeditPluginClass *plugin_class = GEDIT_PLUGIN_CLASS (klass);
object_class->finalize = ##(PLUGIN_ID.lower)_plugin_finalize;
plugin_class->activate = impl_activate;
plugin_class->deactivate = impl_deactivate;
plugin_class->update_ui = impl_update_ui;
##ifdef WITH_CONFIGURE_DIALOG
plugin_class->create_configure_dialog = impl_create_configure_dialog;
##endif
g_type_class_add_private (object_class,
sizeof (##(PLUGIN_ID.camel)PluginPrivate));
}
/* ex:ts=8:noet: */
[Gedit Plugin]
##ifdef WITH_PYTHON
Loader=python
##endif
Module=##(PLUGIN_MODULE)
IAge=2
_Name=##(PLUGIN_NAME)
_Description=##(DESCRIPTION)
Icon=gedit-plugin
Authors=##(AUTHOR_FULLNAME) <##(AUTHOR_EMAIL.lower)>
Copyright=Copyright © ##(DATE_YEAR) ##(AUTHOR_FULLNAME)
Website=http://www.gedit.org
/*
* ##(FILENAME) - ##(DESCRIPTION)
*
* Copyright (C) ##(DATE_YEAR) - ##(AUTHOR_FULLNAME)
*
* 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, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifndef __##(PLUGIN_ID.upper)_PLUGIN_H__
#define __##(PLUGIN_ID.upper)_PLUGIN_H__
#include <glib.h>
#include <glib-object.h>
#include <gedit/gedit-plugin.h>
G_BEGIN_DECLS
/*
* Type checking and casting macros
*/
#define TYPE_##(PLUGIN_ID.upper)_PLUGIN (##(PLUGIN_ID.lower)_plugin_get_type ())
#define ##(PLUGIN_ID.upper)_PLUGIN(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), TYPE_##(PLUGIN_ID.upper)_PLUGIN, ##(PLUGIN_ID.camel)Plugin))
#define ##(PLUGIN_ID.upper)_PLUGIN_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), TYPE_##(PLUGIN_ID.upper)_PLUGIN, ##(PLUGIN_ID.camel)PluginClass))
#define IS_##(PLUGIN_ID.upper)_PLUGIN(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), TYPE_##(PLUGIN_ID.upper)_PLUGIN))
#define IS_##(PLUGIN_ID.upper)_PLUGIN_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), TYPE_##(PLUGIN_ID.upper)_PLUGIN))
#define ##(PLUGIN_ID.upper)_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), TYPE_##(PLUGIN_ID.upper)_PLUGIN, ##(PLUGIN_ID.camel)PluginClass))
/* Private structure type */
typedef struct _##(PLUGIN_ID.camel)PluginPrivate ##(PLUGIN_ID.camel)PluginPrivate;
/*
* Main object structure
*/
typedef struct _##(PLUGIN_ID.camel)Plugin ##(PLUGIN_ID.camel)Plugin;
struct _##(PLUGIN_ID.camel)Plugin
{
GeditPlugin parent_instance;
/*< private >*/
##(PLUGIN_ID.camel)PluginPrivate *priv;
};
/*
* Class definition
*/
typedef struct _##(PLUGIN_ID.camel)PluginClass ##(PLUGIN_ID.camel)PluginClass;
struct _##(PLUGIN_ID.camel)PluginClass
{
GeditPluginClass parent_class;
};
/*
* Public methods
*/
GType ##(PLUGIN_ID.lower)_plugin_get_type (void) G_GNUC_CONST;
/* All the plugins must implement this function */
G_MODULE_EXPORT GType register_gedit_plugin (GTypeModule *module);
G_END_DECLS
#endif /* __##(PLUGIN_ID.upper)_PLUGIN_H__ */
/* ex:ts=8:noet: */
# -*- coding: utf-8 -*-
# preprocessor.py - simple preprocessor for plugin template files
# This file is part of gedit
#
# Copyright (C) 2006 - Steve Frécinaux
#
# gedit 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.
#
# gedit 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 gedit; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor,
# Boston, MA 02110-1301 USA
import sys
import re
class DeepnessException(Exception):
def __init__(self):
Exception.__init__(self)
statements = [re.compile("^##\s*%s\s*$" % pattern) for pattern in
['(?P<stmt>ifdef|ifndef)\s+(?P<key>[^\s]+)',
'(?P<stmt>elif|if)\s+(?P<expr>.+)',
'(?P<stmt>else|endif)',
'(?P<stmt>define)\s+(?P<key>[^\s]+)(\s+(?P<val>.+))?',
'(?P<stmt>undef)\s+(?P<key>[^\s]+)']]
variable = re.compile("##\