dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
gimp/plug-ins/pygimp/gimpfu.py

496 lines
16 KiB
Python
Raw Blame History

'''Simple interface to writing GIMP plugins in python.
Instead of worrying about all the user interaction, saving last used values
and everything, the gimpfu module can take care of it for you. It provides
a simple register() function that will register your plugin if needed, and
cause your plugin function to be called when needed.
Gimpfu will also handle showing a user interface for editing plugin parameters
if the plugin is called interactively, and will also save the last used
parameters, so the RUN_WITH_LAST_VALUES run_type will work correctly. It
will also make sure that the displays are flushed on completion if the plugin
was run interactively.
When registering the plugin, you do not need to worry about specifying
the run_type parameter. And if the plugin is an image plugin (the menu
path starts with <Image>/), the image and drawable parameters are also
automatically added.
A typical gimpfu plugin would look like this:
from gimpfu import *
def plugin_func(image, drawable, args):
#do what plugins do best
register(
"plugin_func",
"blurb",
"help message",
"author",
"copyright",
"year",
"<Image>/Somewhere/My plugin",
"*",
[(PF_STRING, "arg", "The argument", "default-value")],
[],
plugin_func)
main()
The call to "from gimpfu import *" will import all the gimp constants into
the plugin namespace, and also import the symbols gimp, pdb, register and
main. This should be just about all any plugin needs. You can use any
of the PF_* constants below as parameter types, and an appropriate user
interface element will be displayed when the plugin is run in interactive
mode. Note that the the PF_SPINNER and PF_SLIDER types expect a fifth
element in their description tuple -- a 3-tuple of the form (lower,upper,step),
which defines the limits for the slider or spinner.'''
import string; _string = string; del string
import gimp
from gimpenums import *
pdb = gimp.pdb
error = "gimpfu.error"
PF_INT8 = PARAM_INT8
PF_INT16 = PARAM_INT16
PF_INT32 = PARAM_INT32
PF_INT = PF_INT32
PF_FLOAT = PARAM_FLOAT
PF_STRING = PARAM_STRING
PF_VALUE = PF_STRING
PF_INT8ARRAY = PARAM_INT8ARRAY
PF_INT16ARRAY = PARAM_INT16ARRAY
PF_INT32ARRAY = PARAM_INT32ARRAY
PF_INTARRAY = PF_INT32ARRAY
PF_FLOATARRAY = PARAM_FLOATARRAY
PF_STRINGARRAY = PARAM_STRINGARRAY
PF_COLOR = PARAM_COLOR
PF_COLOUR = PF_COLOR
PF_REGION = PARAM_REGION
#PF_DISPLAY = PARAM_DISPLAY
PF_IMAGE = PARAM_IMAGE
PF_LAYER = PARAM_LAYER
PF_CHANNEL = PARAM_CHANNEL
PF_DRAWABLE = PARAM_DRAWABLE
#PF_SELECTION = PARAM_SELECTION
#PF_BOUNDARY = PARAM_BOUNDARY
#PF_PATH = PARAM_PATH
#PF_STATUS = PARAM_STATUS
PF_TOGGLE = 1000
PF_BOOL = PF_TOGGLE
PF_SLIDER = 1001
PF_SPINNER = 1002
PF_ADJUSTMENT = PF_SPINNER
PF_FONT = 1003
PF_FILE = 1004
PF_BRUSH = 1005
PF_PATTERN = 1006
PF_GRADIENT = 1007
_type_mapping = {
PF_INT8 : PARAM_INT8,
PF_INT16 : PARAM_INT16,
PF_INT32 : PARAM_INT32,
PF_FLOAT : PARAM_FLOAT,
PF_STRING : PARAM_STRING,
PF_INT8ARRAY : PARAM_INT8ARRAY,
PF_INT16ARRAY : PARAM_INT16ARRAY,
PF_INT32ARRAY : PARAM_INT32ARRAY,
PF_FLOATARRAY : PARAM_FLOATARRAY,
PF_STRINGARRAY : PARAM_STRINGARRAY,
PF_COLOUR : PARAM_COLOR,
PF_REGION : PARAM_REGION,
PF_IMAGE : PARAM_IMAGE,
PF_LAYER : PARAM_LAYER,
PF_CHANNEL : PARAM_CHANNEL,
PF_DRAWABLE : PARAM_DRAWABLE,
PF_TOGGLE : PARAM_INT32,
PF_SLIDER : PARAM_FLOAT,
PF_SPINNER : PARAM_INT32,
PF_FONT : PARAM_STRING,
PF_FILE : PARAM_STRING,
PF_BRUSH : PARAM_STRING,
PF_PATTERN : PARAM_STRING,
PF_GRADIENT : PARAM_STRING
}
_registered_plugins_ = {}
def register(func_name, blurb, help, author, copyright, date, menupath,
imagetypes, params, results, function):
'''This is called to register a new plugin.'''
# First perform some sanity checks on the data
def letterCheck(str):
allowed = _string.letters + _string.digits + '_'
for ch in str:
if not ch in allowed:
return 0
else:
return 1
if not letterCheck(func_name):
raise error, "function name contains ileagal characters"
for ent in params:
if len(ent) < 4:
raise error, "sequence not long enough for "+ent[0]
if type(ent[0]) != type(42):
raise error, "parameter types must be integers"
if not letterCheck(ent[1]):
raise error,"parameter name contains ilegal characters"
for ent in results:
if len(ent) < 3:
raise error, "sequence not long enough for "+ent[0]
if type(ent[0]) != type(42):
raise error, "result types must be integers"
if not letterCheck(ent[1]):
raise error,"result name contains ilegal characters"
if menupath[:8] == '<Image>/':
plugin_type = PROC_PLUG_IN
elif menupath[:10] == '<Toolbox>/':
plugin_type = PROC_EXTENSION
else:
raise error, "menu path must start with <Image> or <Toolbox>"
if not func_name[:7] == 'python_' and \
not func_name[:10] == 'extension_' and \
not func_name[:8] == 'plug_in_':
func_name = 'python_fu_' + func_name
_registered_plugins_[func_name] = (blurb, help, author, copyright,
date, menupath, imagetypes,
plugin_type, params, results,
function)
def _query():
for plugin in _registered_plugins_.keys():
(blurb, help, author, copyright, date,
menupath, imagetypes, plugin_type,
params, results, function) = _registered_plugins_[plugin]
fn = lambda x: (_type_mapping[x[0]], x[1], x[2])
params = map(fn, params)
# add the run mode argument ...
params.insert(0, (PARAM_INT32, "run_mode",
"Interactive, Non-Interactive"))
if plugin_type == PROC_PLUG_IN:
params.insert(1, (PARAM_IMAGE, "image",
"The image to work on"))
params.insert(2, (PARAM_DRAWABLE, "drawable",
"The drawable to work on"))
results = map(fn, results)
gimp.install_procedure(plugin, blurb, help, author, copyright,
date, menupath, imagetypes, plugin_type,
params, results)
def _get_defaults(func_name):
import gimpshelf
(blurb, help, author, copyright, date,
menupath, imagetypes, plugin_type,
params, results, function) = _registered_plugins_[func_name]
key = "python-fu-save--" + func_name
if gimpshelf.shelf.has_key(key):
return gimpshelf.shelf[key]
else:
# return the default values
return map(lambda x: x[3], params)
def _set_defaults(func_name, defaults):
import gimpshelf
key = "python-fu-save--" + func_name
gimpshelf.shelf[key] = defaults
def _interact(func_name):
(blurb, help, author, copyright, date,
menupath, imagetypes, plugin_type,
params, results, function) = _registered_plugins_[func_name]
# short circuit for no parameters ...
if len(params) == 0: return []
import gtk
import gimpui
gtk.rc_parse(gimp.gtkrc())
defaults = _get_defaults(func_name)
# define a mapping of param types to edit objects ...
class StringEntry(gtk.GtkEntry):
def __init__(self, default=''):
import gtk
gtk.GtkEntry.__init__(self)
self.set_text(str(default))
def get_value(self):
return self.get_text()
class IntEntry(StringEntry):
def get_value(self):
import string
return string.atoi(self.get_text())
class FloatEntry(StringEntry):
def get_value(self):
import string
return string.atof(self.get_text())
class ArrayEntry(StringEntry):
def get_value(self):
return eval(self.get_text())
class SliderEntry(gtk.GtkHScale):
# bounds is (upper, lower, step)
def __init__(self, default=0, bounds=(0, 100, 5)):
import gtk
self.adj = gtk.GtkAdjustment(default, bounds[0],
bounds[1], bounds[2],
bounds[2], bounds[2])
gtk.GtkHScale.__init__(self, self.adj)
def get_value(self):
return self.adj.value
class SpinnerEntry(gtk.GtkSpinButton):
# bounds is (upper, lower, step)
def __init__(self, default=0, bounds=(0, 100, 5)):
import gtk
self.adj = gtk.GtkAdjustment(default, bounds[0],
bounds[1], bounds[2],
bounds[2], bounds[2])
gtk.GtkSpinButton.__init__(self, self.adj, 1, 0)
def get_value(self):
return int(self.adj.value)
class ToggleEntry(gtk.GtkToggleButton):
def __init__(self, default=0):
import gtk
gtk.GtkToggleButton.__init__(self)
self.label = gtk.GtkLabel("No")
self.add(self.label)
self.label.show()
self.connect("toggled", self.changed)
self.set_active(default)
def changed(self, tog):
if tog.active:
self.label.set_text("Yes")
else:
self.label.set_text("No")
def get_value(self):
return self.get_active()
_edit_mapping = {
PF_INT8 : IntEntry,
PF_INT16 : IntEntry,
PF_INT32 : IntEntry,
PF_FLOAT : FloatEntry,
PF_STRING : StringEntry,
PF_INT8ARRAY : ArrayEntry,
PF_INT16ARRAY : ArrayEntry,
PF_INT32ARRAY : ArrayEntry,
PF_FLOATARRAY : ArrayEntry,
PF_STRINGARRAY : ArrayEntry,
PF_COLOUR : gimpui.ColourSelector,
PF_REGION : IntEntry, # should handle differently ...
PF_IMAGE : gimpui.ImageSelector,
PF_LAYER : gimpui.LayerSelector,
PF_CHANNEL : gimpui.ChannelSelector,
PF_DRAWABLE : gimpui.DrawableSelector,
PF_TOGGLE : ToggleEntry,
PF_SLIDER : SliderEntry,
PF_SPINNER : SpinnerEntry,
PF_FONT : gimpui.FontSelector,
PF_FILE : gimpui.FileSelector,
PF_BRUSH : gimpui.BrushSelector,
PF_PATTERN : gimpui.PatternSelector,
PF_GRADIENT : gimpui.GradientSelector,
}
tooltips = gtk.GtkTooltips()
dialog = gtk.GtkDialog()
dialog.set_title(func_name)
table = gtk.GtkTable(len(params), 3, gtk.FALSE)
table.set_border_width(5)
table.set_row_spacings(2)
table.set_col_spacings(10)
dialog.vbox.pack_start(table)
table.show()
vbox = gtk.GtkVBox(gtk.FALSE, 15)
table.attach(vbox, 0,1, 0,len(params), xoptions=gtk.FILL)
vbox.show()
pix = _get_logo(vbox.get_colormap())
vbox.pack_start(pix, expand=gtk.FALSE)
pix.show()
label = gtk.GtkLabel(blurb)
label.set_line_wrap(TRUE)
label.set_justify(gtk.JUSTIFY_LEFT)
label.set_usize(100, -1)
vbox.pack_start(label, expand=gtk.FALSE)
label.show()
edit_wids = []
for i in range(len(params)):
type = params[i][0]
name = params[i][1]
desc = params[i][2]
def_val = defaults[i]
label = gtk.GtkLabel(name)
label.set_alignment(1.0, 0.5)
table.attach(label, 1,2, i,i+1, xoptions=gtk.FILL)
label.show()
if type in (PF_SPINNER, PF_SLIDER):
wid = _edit_mapping[type](def_val, params[i][4])
else:
wid = _edit_mapping[type](def_val)
table.attach(wid, 2,3, i,i+1)
tooltips.set_tip(wid, desc, None)
wid.show()
edit_wids.append(wid)
def delete_event(win, event=None):
import gtk
win.hide()
gtk.mainquit()
return TRUE
# this is a hack ...
finished = [ 0 ]
def ok_clicked(button, win=dialog, finished=finished):
import gtk
win.hide()
finished[0] = 1
gtk.mainquit()
b = gtk.GtkButton("OK")
b.set_flags(gtk.CAN_DEFAULT)
dialog.action_area.pack_start(b)
b.grab_default()
b.connect("clicked", ok_clicked)
b.show()
b = gtk.GtkButton("Cancel")
b.set_flags(gtk.CAN_DEFAULT)
dialog.action_area.pack_start(b)
b.connect("clicked", delete_event)
b.show()
dialog.show()
tooltips.enable()
# run the main loop
gtk.mainloop()
ret = None
if finished[0]:
# OK was clicked
ret = map(lambda wid: wid.get_value(), edit_wids)
_set_defaults(func_name, ret)
dialog.destroy()
return ret
def _run(func_name, params):
run_mode = params[0]
plugin_type = _registered_plugins_[func_name][7]
func = _registered_plugins_[func_name][10]
if plugin_type == PROC_PLUG_IN:
start_params = params[1:3]
extra_params = params[3:]
else:
start_params = ()
extra_params = params[1:]
if run_mode == RUN_INTERACTIVE:
extra_params = _interact(func_name)
if extra_params == None:
return
elif run_mode == RUN_WITH_LAST_VALS:
extra_params = _get_defaults(func_name)
params = start_params + tuple(extra_params)
res = apply(func, params)
if run_mode != RUN_NONINTERACTIVE: gimp.displays_flush()
def main():
'''This should be called after registering the plugin.'''
gimp.main(None, None, _query, _run)
_python_image = [
"64 64 7 1",
" c #000000",
". c #00FF00",
"X c None",
"o c #FF0000",
"O c #FFFF00",
"+ c #808000",
"@ c #0000FF",
"XXXXXXXXXXXXXX XX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXXXXXX XX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXXXX ++++ ++++++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXXXX ++++ ++++++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX ++++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX ++++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX OOOO OOOOOO ++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX OOOO OOOOOO ++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX OO@@ OO@@@@ ++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX OO@@ OO@@@@ ++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX OO@@ OO@@@@ ++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX OO@@ OO@@@@ ++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX OOOO OOOOOO ++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXX OOOO OOOOOO ++ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXX ++ ++++++ XXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXX ++ ++++++ XXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXX ++++++++++++++++++++++ ++++++ XXXXXXXXXXXXXXXXXXXXXX",
"XXXX ++++++++++++++++++++++ ++++++ XXXXXXXXXXXXXXXXXXXXXX",
"XX ++++++++++++++++++++++++++++ ++++++++ XXXXXXXXXXXXXXXXXXXX",
"XX ++++++++++++++++++++++++++++ ++++++++ XXXXXXXXXXXXXXXXXXXX",
" ++++++++++++++++++++++++++++++++ ++++++++ XXXXXXXXXXXXXXXXXX",
" ++++++++++++++++++++++.+.+..++++ ++++++++ XXXXXXXXXXXXXXXXXX",
" ++ ++++ ++++++++++.+........++ ++++++++ XXXXXXXXXXXXXXXXXX",
" ++ ++++ ++++++++.+...........+ ++++++++ XXXXXXXXXXXXXXXXXX",
" ++++++++++++++++++.+.. ...... ++++++++++ XXXXXXXXXXXXXXXX",
" ++++++++++++++++.+... ...... ++++++++++ XXXXXXXXXXXXXXXX",
" .+.+.+.+.+.+.+.+.... ..++.. ..++++++++++ XXXXXXXXXXXXXXXX",
" .+.+.+.+.+.+.+..... ..++.. ...+++++++++ XXXXXXXXXXXXXXXX",
" ................ ++.... ......++++++++ XXXXXXXXXXXXXXXX",
" ............... +..... +......+++++++ XXXXXXXXXXXXXXXX",
"XX +.+.+.+.+..+ ++++.. ++++...+++++++ XXXXXXXXXXXXXXXX",
"XX ++++++++++++ +...... ++++...+++++++ XXXXXXXXXXXXXXXX",
"XXXX ooooo ++.... XX +......+++++++ XXXXXXXXXXXXXXXX",
"XXXX ooooo ++..... XX .......+++++++ XXXXXXXXXXXXXXXX",
"XXXX ooooo ++...... XXXX ++....++++++ XXXXXXXXXXXXXXXXXX",
"XXXX ooooo ++....... XXXX ++...+++++++ XXXXXXXXXXXXXXXXXX",
"XXXX ooooo.++...... XXXX +......+++++++ XXXXXXXXXXXXXXXXXX",
"XXXX ooooo..+....... XXXX ......++++++++ XXXXXXXXXXXXXXXXXX",
"XXXXooooo....... XXXX +++++....+++++++ XXXXXXXXXXXXXXXXXXXX",
"XXXooooo........ XXXX +++++..+++++++++ XXXXXXXXXXXXXXXXXXXX",
"XXoooo XXXXXX +.......++++++++ XXXXXXXXXXXXXXXXXXXXXX",
"Xooooo XXXXXX .......+++++++++ XXXXXXXXXXXXXXXXXXXXXX",
"oooXooXXXXXXXXXXXX +++++....+++++++++ XXXXXXXXXXXXXXXXXXXXXX ",
"ooXXooXXXXXXXXXXXX +++++...++++++++++ XXXXXXXXXXXXXXXXXXXXXX ",
"XXXXooXXXXXXXX ++.......+++++++++ XXXXXXXXXXXXXXXXXXXXXX ",
"XXXXooXXXXXXXX +.......++++++++++ XXXXXXXXXXXXXXXXXXXXXX ",
"XXXXXXXXXXXX ++++++.....+++++++++ XXXXXX XXXX ++ ",
"XXXXXXXXXXXX ++++++....++++++++++ XXXXXX XXXX ++ ",
"XXXXXXXXXXXX +........+++++++++ ++++++++ XX ++++++ ++++ ",
"XXXXXXXXXXXX ........++++++++++ ++++++++ XX ++++++ ++++ ",
"XXXXXXXXXX ..........++++++++ ++++++++++++ ++++++++++++++++ ",
"XXXXXXXXXX .........+++++++++ ++++++++++++ ++++++++++++++++ ",
"XXXXXXXXXX ++++....++++++++++++++++++++++++++++++++++++++++ XX",
"XXXXXXXXXX +++++...++++++++++++++++++++++++++++++++++++++++ XX",
"XXXXXXXXXX ++++....++++++++++++++++++++++++++++++ ..... XXXX",
"XXXXXXXXXX ........++++++++++++++++++++++++++++++ .... XXXX",
"XXXXXXXXXX .........+++++++++++..++++++++++++++ XXXX XXXXXX",
"XXXXXXXXXX .............+++++++..++++++++++++++ XXXX XXXXXX",
"XXXXXXXXXXXX +++++............ ............ XXXXXXXXXXXXXXXX",
"XXXXXXXXXXXX ++++++.......... .......... XXXXXXXXXXXXXXXX",
"XXXXXXXXXXXXXX +.....++.. XXXX XXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXXXXXX .....++++. XXXX XXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"XXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
]
def _get_logo(colormap):
import gtk
pix, mask = gtk.create_pixmap_from_xpm_d(colormap, None, _python_image)
return gtk.GtkPixmap(pix, mask)
Reference in New Issue View Git Blame Copy Permalink