Gimp/plug-ins/script-fu/libscriptfu
Jehan 57ca3f4807 libgimp, plug-ins: move gimp_pdb_run_procedure*() to gimp_procedure_run*().
The gimp_procedure_run() already existed, though it was with an ordered
GimpValueArray array of arguments. Its usage feels redundant to the series of
gimp_pdb_run_procedure*() functions (which is confusing), but
gimp_procedure_run() was actually a bit more generic, because it does not
necessarily calls GimpProcedure-s through the PDB! For instance, it can runs a
local GimpProcedure, such as the case of one procedure which would want to call
another procedure in the same plug-in, but without having to go through PDB. Of
course, for local code, you may as well run relevant functions directly, yet it
makes sense that if one of the redundant-looking function is removed, it should
be the more specific one. Also gimp_procedure_run() feels a lot simpler and
logical, API wise.

A main difference in usage is that now, plug-in developers have to first
explicitly look up the GimpPdbProcedure with gimp_pdb_lookup_procedure() when
they wish to call PDB procedures on the wire. This was done anyway in the
gimp_pdb_run_procedure*() code, now it's explicit (rather than calling by name
directly).

Concretely:

* gimp_pdb_run_procedure(), gimp_pdb_run_procedure_config() and
  gimp_pdb_run_procedure_valist() are removed.
* gimp_procedure_run() API is modified to use a variable args list instead of a
  GimpValueArray.
* gimp_procedure_run_config() and gimp_procedure_run_valist() are added.
* gimp_procedure_run_config() in particular will be the one used in bindings
  which don't have variable args support through a (rename-to
  gimp_procedure_run) annotation.
2023-10-18 17:11:20 +02:00
..
ftx Remove autotools 2023-05-27 00:03:52 +02:00
tinyscheme tinyscheme: enhance: rearrange error msg so error kind is stable prefix 2023-09-06 06:37:29 -04:00
meson.build ScriptFu: Extract function marshal_returned_PDB_value 2023-09-12 15:02:15 +00:00
README
scheme-marshal-return.c ScriptFu: change binding of resource from string to int 2023-09-15 11:02:46 +00:00
scheme-marshal-return.h ScriptFu: extract function marshall_pdb_return 2023-09-12 15:02:15 +00:00
scheme-marshal.c Introduce a global ID space for GimpData/GimpResource objects 2023-05-31 16:12:04 +02:00
scheme-marshal.h
scheme-wrapper.c libgimp, plug-ins: move gimp_pdb_run_procedure*() to gimp_procedure_run*(). 2023-10-18 17:11:20 +02:00
scheme-wrapper.h ScriptFu: script-fu-register-filter for GimpImageProcedure. 2022-08-02 07:45:35 +00:00
script-fu-arg.c script-fu: fix out-of-bounds array access 2023-07-11 12:04:24 -04:00
script-fu-arg.h ScriptFu: Extract informal class SFArg from script-fu-script.c 2022-07-04 08:28:19 +00:00
script-fu-command.c libgimp, plug-ins: gimp_procedure_config_[gs]et_values() not public anymore. 2023-10-15 22:10:38 +02:00
script-fu-command.h plug-ins: port script-fu-script.c to gimp_image_procedure_new2(). 2023-10-01 21:02:33 +02:00
script-fu-compat.c plug-ins: gimp-plug-in-domain-register PDB procedure doesn't exist… 2022-07-06 16:14:03 +02:00
script-fu-compat.h
script-fu-dialog.c libgimp, plug-ins: gimp_procedure_config_[gs]et_values() not public anymore. 2023-10-15 22:10:38 +02:00
script-fu-dialog.h plug-ins: port script-fu-script.c to gimp_image_procedure_new2(). 2023-10-01 21:02:33 +02:00
script-fu-enums.h ScriptFu: script-fu-register-filter for GimpImageProcedure. 2022-08-02 07:45:35 +00:00
script-fu-errors.c Fix for 2.99 only #6157 2023-09-28 13:26:23 +00:00
script-fu-errors.h Fix for 2.99 only #6157 2023-09-28 13:26:23 +00:00
script-fu-interface.c libgimp, plug-ins: let's just call gegl_init() in gimp_ui_init(). 2023-10-05 22:36:40 +02:00
script-fu-interface.h
script-fu-intl.h
script-fu-lib.c Issue #8744: refactor overdependence on gimpui.h 2022-10-15 15:17:08 +00:00
script-fu-lib.h ScriptFu: Add script-fu-interpreter akin to other interpreters 2022-06-30 13:39:45 +00:00
script-fu-proc-factory.c Issue #8744: refactor overdependence on gimpui.h 2022-10-15 15:17:08 +00:00
script-fu-proc-factory.h ScriptFu: Add script-fu-interpreter akin to other interpreters 2022-06-30 13:39:45 +00:00
script-fu-regex.c
script-fu-regex.h
script-fu-register.c Fix for 2.99 only #6157 2023-09-28 13:26:23 +00:00
script-fu-register.h ScriptFu: script-fu-register-filter for GimpImageProcedure. 2022-08-02 07:45:35 +00:00
script-fu-run-func.c Fix #10127 2023-10-07 06:04:00 -04:00
script-fu-run-func.h plug-ins: port script-fu-script.c to gimp_image_procedure_new2(). 2023-10-01 21:02:33 +02:00
script-fu-script.c libgimp, plug-ins: gimp_procedure_config_[gs]et_values() not public anymore. 2023-10-15 22:10:38 +02:00
script-fu-script.h libgimp, plug-ins: gimp_procedure_config_[gs]et_values() not public anymore. 2023-10-15 22:10:38 +02:00
script-fu-scripts.c Issue #9994: do not call g_file_info_get_is_hidden() (and others) directly. 2023-09-19 15:34:48 +02:00
script-fu-scripts.h ScriptFu: script-fu-register-filter for GimpImageProcedure. 2022-08-02 07:45:35 +00:00
script-fu-types.h Fix plugins to use new GimpResource. 2023-01-14 17:43:26 +01:00
script-fu-utils.c
script-fu-utils.h
script-fu.def ScriptFu: Add script-fu-interpreter akin to other interpreters 2022-06-30 13:39:45 +00:00

About libscriptfu

libscriptfu is part of GIMP.
It is not generally useful except by GIMP.

The libscriptfu library is used by plugin executables,
and the PDB procedures they create,
all part of the "ScriptFu" machinery.

The libscriptfu library is not intended for third-party developers,
only for core GIMP developers.
Headers for libscriptfu might not be installed.

This directory contains three libraries: libscriptfu, tinyscheme, and ftx.
The tinyscheme library contains a TinyScheme interpreter.
The ftx library extends the TinyScheme interpreter,
adding file functions to the Scheme language.
The libscriptfu library contains both the tinyscheme and ftx libraries.
The libscriptfu library wraps the TinyScheme interpreter,
specializing it for GIMP.
The script-fu executable uses the libscriptfu library,
to interpret Scheme scripts that GIMP users refer to as "plug-ins."

These libraries depend on other libraries, e.g. math, libgimp, glib, etc.

Coupling between the executables and the libraries should be in one direction:
source for the inner libs should not include headers from the outer executables.
This lets you more easily update the inner libraries
(which originated elsewhere and might be maintained elsewhere),
and change the outer executables
(which are subject to change by GIMP developers.)

Example (which may change):
The script-fu executable is a plugin file that implements PDB procedures:
extension-script-fu, script-fu-console, script-fu-text-console, script-fu-eval,
and script-fu-server.
Each of those PDB procedures runs as a separate process.
Each of those processes uses libscriptfu.
The main PDB procedure is extension-script-fu, which is a long-lived process.
It is a PDB procedure of PDBProcedureType EXTENSION.
It interprets the Scheme scripts that user's call "plug-ins."

Rarely two of the PDB procedure processes run concurrently.
When they do, and libscriptfu is built as a shared library,
the read-only, code portion of the library is only loaded in memory once.