Για να μπορέσουμε να προσπελάσουμε στις συναρτήσεις GIMP, ξεκινάμε με το import gi. Αυτή η ενότητα μπορεί να καταλάβει ποιες συναρτήσεις είναι διαθέσιμες σε κάθε ενότητα που ορίζεται μέσω της «ενδοσκόπησης αντικειμένου (object introspection)». Αυτό σημαίνει για εμάς, είναι ότι εισάγουμε όλες τις ενότητες που σχετίζονται με το GIMP που μπορεί να χρειαστούμε μέσω κλήσεων στο gi.repository.

Για βασική λειτουργικότητα, μόνο οι λειτουργικές μονάδες Gimp και GimpUi μπορεί να είναι αρκετές. Εάν θέλετε να τρέξετε το πρόσθετό σας από τη γραμμή εντολών, δεν χρειάζεστε καν το GimpUi. Ας ξεκινήσουμε με ένα παράδειγμα.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
#   GIMP - The GNU Image Manipulation Program
#   Copyright (C) 1995 Spencer Kimball and Peter Mattis
#
#   gimp-tutorial-plug-in.py
#   sample plug-in to illustrate the Python plug-in writing tutorial
#   Copyright (C) 2023 Jacob Boerema
#
#   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 3 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, see <https://www.gnu.org/licenses/>.

import sys

import gi
gi.require_version('Gimp', '3.0')
from gi.repository import Gimp
gi.require_version('GimpUi', '3.0')
from gi.repository import GimpUi
from gi.repository import GLib
      

Ξεκινάμε με την εισαγωγή sys, την οποία χρειαζόμαστε στο τέλος για πρόσβαση στο sys.argv, ακολουθώντας ότι η import gi λέει στην Python ότι πρέπει να φορτώσει τη λειτουργική μονάδα gi. Αυτή η λειτουργική μονάδα χρησιμοποιείται για να ενεργοποιήσει την πρόσβαση σε συγκεκριμένες συναρτήσεις του GIMP μέσω «ενδοσκόπησης αντικειμένων».

Στην επόμενη γραμμή λέμε στη gi ότι απαιτούμε η έκδοση API του GIMP να είναι η έκδοση 3.0. (Αυτό το πρόσθετο δεν θα λειτουργεί με παλαιότερες εκδόσεις του GIMP.) Η ακόλουθη γραμμή ζητά την εισαγωγή όλων των συναρτήσεων, των κλάσεων κ.λπ. από τη λειτουργική μονάδα Gimp.

Για τις επόμενες δύο γραμμές, κάντε το ίδιο πράγμα για το GimpUi. Το GimpUi περιέχει όλα τα στοιχεία που σχετίζονται με τη διεπαφή για το GIMP. Εάν σκοπεύετε να δημιουργήσετε ένα πρόσθετο που θα καλείται μόνο από τη γραμμή εντολών, τότε δεν θα το χρειαστείτε. Ολοκληρώνουμε με την εισαγωγή του GLib, το οποίο χρειαζόμαστε αργότερα για πρόσβαση στο GLib.Error.

Υπάρχουν και άλλες προαιρετικές λειτουργικές μονάδες που μπορείτε να χρησιμοποιήσετε, όπως το Gegl και το Glib μεταξύ πολλών άλλων, αλλά δεν θα αναφερθούμε σε αυτές εδώ.

Το GIMP πρέπει να γνωρίζει ποιες συναρτήσεις είναι διαθέσιμες, ποιες λειτουργίες υποστηρίζει και ποια θέση μενού να χρησιμοποιήσει. Για αυτό ορίζουμε μια κλάση που προέρχεται από την κλάση Gimp.PlugIn.

Ένα ελάχιστο πρόσθετο χρειάζεται τουλάχιστον τις ακόλουθες λειτουργίες που ορίζονται σε αυτήν την κλάση:

Θα μπούμε σε λίγο περισσότερες λεπτομέρειες τώρα. Δεν περιλαμβάνεται παρακάτω το πρώτο μέρος του κώδικα Python που παρουσιάστηκε παραπάνω. Αυτό δείχνει μόνο τη βασική διάταξη της κλάσης σας.

class MyFirstPlugin (Gimp.PlugIn):
    def do_query_procedures(self):
        return [ "jb-plug-in-first-try" ]

    def do_set_i18n (self, name):
        return False

    def do_create_procedure(self, name):
        procedure = Gimp.ImageProcedure.new(self, name,
                                            Gimp.PDBProcType.PLUGIN,
                                            self.run, None)

        procedure.set_image_types("*")

        procedure.set_menu_label("My first Python plug-in")
        procedure.add_menu_path('<Image>/Filters/Tutorial/')

        procedure.set_documentation("My first Python plug-in tryout",
                                    "My first Python 3 plug-in for GIMP 3",
                                    name)
        procedure.set_attribution("Your name", "Your name", "2023")

        return procedure

    def run(self, procedure, run_mode, image, n_drawables, drawables, config, run_data):
        Gimp.message("Hello world!")
        # do what you want to do, then, in case of success, return:
        return procedure.new_return_values(Gimp.PDBStatusType.SUCCESS, GLib.Error())
      

Ας ρίξουμε μια πιο προσεκτική ματιά στο do_create_procedures. Στη γραμμή return [ "jb-plug-in-first-try" ] λέμε στο GIMP ποιο είναι το όνομα της διαδικασίας μας: την ονομάζουμε "jb-plug-in-first-try". Αυτό είναι το όνομα που θα εμφανίζεται στο Πρόγραμμα περιήγησης διαδικασίας του GIMP.

Μπορείτε να ορίσετε περισσότερες από μία διαδικασίες σε ένα πρόσθετο. Σε αυτήν την περίπτωση, θα αναφέρετε όλα τα ονόματα, χωρισμένα με κόμμα.

Είναι καλή πρακτική να ξεκινάτε όλες τις διαδικασίες σας με τα αρχικά σας, ή κάποια άλλη αναγνωρίσιμη και μοναδική ετικέτα. Με αυτόν τον τρόπο, είναι λιγότερο πιθανό το όνομά σας να είναι ίδιο με το πρόσθετο κάποιου άλλου, γεγονός που μπορεί να προκαλέσει σύγχυση στο GIMP. Εκτός αυτού, μπορείτε να το ονομάσετε όπως θέλετε.

Στη συνέχεια, λέμε στο GIMP ότι δεν υποστηρίζουμε μεταφράσεις επιστρέφοντας το False στην κλήση στο do_set_i18n. Το τι πρέπει να κάνετε όταν θέλετε να μεταφραστεί το πρόσθετό σας δεν εμπίπτει στον σκοπό αυτού του σεμιναρίου.

Η μέθοδος do_create_procedure είναι εκεί που γίνεται το μεγαλύτερο μέρος της προετοιμασίας για το GIMP.

Κάθε πρόσθετο ξεκινά με μια κλήση στο Gimp.main.

        Gimp.main(MyFirstPlugin.__gtype__, sys.argv)
      

Το μόνο πράγμα που πρέπει να αλλάξετε σε αυτήν τη γραμμή για το πρόσθετό σας, είναι το όνομα της κλάσης του προσθέτου σας, που εδώ ονομάζεται «MyFirstPlugin».

Παρακάτω παρουσιάζουμε ολόκληρο το σενάριο python, το οποίο θα πρέπει να εκτελείται, με την προϋπόθεση ότι θα του δοθεί το σωστό όνομα σε έναν κατάλογο με το ίδιο όνομα σε μια τοποθεσία που γνωρίζει το GIMP. Θα εμφανίσει το μήνυμα «Hello world!» στην κονσόλα σφαλμάτων, ή σε ένα αναδυόμενο παράθυρο διαλόγου.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
#   GIMP - The GNU Image Manipulation Program
#   Copyright (C) 1995 Spencer Kimball and Peter Mattis
#
#   gimp-tutorial-plug-in.py
#   sample plug-in to illustrate the Python plug-in writing tutorial
#   Copyright (C) 2023 Jacob Boerema
#
#   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 3 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, see <https://www.gnu.org/licenses/>.

import sys

import gi
gi.require_version('Gimp', '3.0')
from gi.repository import Gimp
gi.require_version('GimpUi', '3.0')
from gi.repository import GimpUi

from gi.repository import GLib

class MyFirstPlugin (Gimp.PlugIn):
    def do_query_procedures(self):
        return [ "jb-plug-in-first-try" ]

    def do_set_i18n (self, name):
        return False

    def do_create_procedure(self, name):
        procedure = Gimp.ImageProcedure.new(self, name,
                                            Gimp.PDBProcType.PLUGIN,
                                            self.run, None)

        procedure.set_image_types("*")

        procedure.set_menu_label("My first Python plug-in")
        procedure.add_menu_path('<Image>/Filters/Tutorial/')

        procedure.set_documentation("My first Python plug-in tryout",
                                    "My first Python 3 plug-in for GIMP 3.0",
                                    name)
        procedure.set_attribution("Your name", "Your name", "2023")

        return procedure

    def run(self, procedure, run_mode, image, n_drawables, drawables, config, run_data):
        Gimp.message("Hello world!")
        # do what you want to do, then, in case of success, return:
        return procedure.new_return_values(Gimp.PDBStatusType.SUCCESS, GLib.Error())

Gimp.main(MyFirstPlugin.__gtype__, sys.argv)