procedural_db.h 5.92 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/* The GIMP -- an image manipulation program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * 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
16
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
17
 */
18

Elliot Lee's avatar
Elliot Lee committed
19 20 21 22 23 24
#ifndef __PROCEDURAL_DB_H__
#define __PROCEDURAL_DB_H__


struct _Argument
{
25
  GimpPDBArgType  arg_type;       /*  argument type        */
Elliot Lee's avatar
Elliot Lee committed
26 27 28

  union _ArgValue
  {
29
    gint32      pdb_int;        /*  Integer type         */
Elliot Lee's avatar
Elliot Lee committed
30
    gdouble     pdb_float;      /*  Floating point type  */
31 32
    gpointer    pdb_pointer;    /*  Pointer type         */
    GimpRGB     pdb_color;      /*  Color type           */
Elliot Lee's avatar
Elliot Lee committed
33 34 35 36 37
  } value;
};


/*  Argument marshalling procedures  */
38 39 40 41
typedef Argument * (* ArgMarshal) (Gimp         *gimp,
                                   GimpContext  *context,
                                   GimpProgress *progress,
				   Argument     *args);
Elliot Lee's avatar
Elliot Lee committed
42 43 44


/*  Execution types  */
45
typedef struct _IntExec    IntExec;
Elliot Lee's avatar
Elliot Lee committed
46
typedef struct _PlugInExec PlugInExec;
47 48 49
typedef struct _ExtExec    ExtExec;
typedef struct _TempExec   TempExec;
typedef struct _NetExec    NetExec;
Elliot Lee's avatar
Elliot Lee committed
50

51

Elliot Lee's avatar
Elliot Lee committed
52 53 54 55 56 57 58
struct _IntExec
{
  ArgMarshal  marshal_func;   /*  Function called to marshal arguments  */
};

struct _PlugInExec
{
59
  gchar      *filename;       /*  Where is the executable on disk?  */
Elliot Lee's avatar
Elliot Lee committed
60 61 62 63
};

struct _ExtExec
{
64
  gchar      *filename;       /*  Where is the executable on disk?  */
Elliot Lee's avatar
Elliot Lee committed
65 66 67 68
};

struct _TempExec
{
69
  void       *plug_in;        /*  Plug-in that registered this temp proc  */
Elliot Lee's avatar
Elliot Lee committed
70 71 72 73
};

struct _NetExec
{
74
  gchar      *host;           /*  Host responsible for procedure execution  */
Elliot Lee's avatar
Elliot Lee committed
75 76 77 78 79 80 81 82
  gint32      port;           /*  Port on host to send data to  */
};


/*  Structure for a procedure argument  */

struct _ProcArg
{
83 84 85
  GimpPDBArgType  arg_type;    /*  Argument type (int, char, char *, etc)  */
  gchar          *name;        /*  Argument name  */
  gchar          *description; /*  Argument description  */
Elliot Lee's avatar
Elliot Lee committed
86 87 88 89 90 91 92 93
};


/*  Structure for a procedure  */

struct _ProcRecord
{
  /*  Procedure information  */
94
  gchar       *name;          /*  Procedure name  */
95
  gchar       *original_name; /*  Procedure name before canonicalization  */
96 97 98 99 100
  gchar       *blurb;         /*  Short procedure description  */
  gchar       *help;          /*  Detailed help instructions  */
  gchar       *author;        /*  Author field  */
  gchar       *copyright;     /*  Copyright field  */
  gchar       *date;          /*  Date field  */
Elliot Lee's avatar
Elliot Lee committed
101

102
  gchar       *deprecated;    /*  Replacement if the procedure is deprecated  */
103

Elliot Lee's avatar
Elliot Lee committed
104
  /*  Procedure type  */
105
  GimpPDBProcType  proc_type; /*  Type of procedure--Internal, Plug-In, Extension  */
Elliot Lee's avatar
Elliot Lee committed
106 107

  /*  Input arguments  */
108 109
  gint32       num_args;      /*  Number of procedure arguments  */
  ProcArg     *args;          /*  Array of procedure arguments  */
Elliot Lee's avatar
Elliot Lee committed
110 111

  /*  Output values  */
112 113
  gint32       num_values;    /*  Number of return values  */
  ProcArg     *values;        /*  Array of return values  */
Elliot Lee's avatar
Elliot Lee committed
114 115 116 117 118 119 120 121 122 123 124

  /*  Method of procedure execution  */
  union _ExecMethod
  {
    IntExec     internal;     /*  Execution information for internal procs  */
    PlugInExec  plug_in;      /*  ..................... for plug-ins  */
    ExtExec     extension;    /*  ..................... for extensions  */
    TempExec    temporary;    /*  ..................... for temp procs  */
  } exec_method;
};

125

Elliot Lee's avatar
Elliot Lee committed
126
/*  Functions  */
Michael Natterer's avatar
Michael Natterer committed
127

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
void           procedural_db_init          (Gimp         *gimp);
void           procedural_db_free          (Gimp         *gimp);

void           procedural_db_init_procs    (Gimp         *gimp);

void           procedural_db_register      (Gimp         *gimp,
                                            ProcRecord   *procedure);
void           procedural_db_unregister    (Gimp         *gimp,
                                            const gchar  *name);
ProcRecord   * procedural_db_lookup        (Gimp         *gimp,
                                            const gchar  *name);

Argument     * procedural_db_execute       (Gimp         *gimp,
                                            GimpContext  *context,
                                            GimpProgress *progress,
                                            const gchar  *name,
                                            Argument     *args);
Argument     * procedural_db_run_proc      (Gimp         *gimp,
                                            GimpContext  *context,
                                            GimpProgress *progress,
                                            const gchar  *name,
                                            gint         *nreturn_vals,
Michael Natterer's avatar
Michael Natterer committed
150 151
                                            ...);

152 153 154 155 156 157 158 159 160 161 162 163 164
Argument     * procedural_db_return_args   (ProcRecord   *procedure,
                                            gboolean      success);
void           procedural_db_destroy_args  (Argument     *args,
                                            gint          nargs);

void           procedural_db_free_data     (Gimp         *gimp);
void           procedural_db_set_data      (Gimp         *gimp,
                                            const gchar  *identifier,
                                            gint32        bytes,
                                            const guint8 *data);
const guint8 * procedural_db_get_data      (Gimp         *gimp,
                                            const gchar  *identifier,
                                            gint32       *bytes);
Michael Natterer's avatar
Michael Natterer committed
165

166

Elliot Lee's avatar
Elliot Lee committed
167
#endif  /*  __PROCEDURAL_DB_H__  */