procedural_db.h 4.56 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
typedef Argument * (* ArgMarshal) (Gimp     *gimp,
				   Argument *args);
Elliot Lee's avatar
Elliot Lee committed
40 41 42


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

49

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

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

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

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

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


/*  Structure for a procedure argument  */

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


/*  Structure for a procedure  */

struct _ProcRecord
{
  /*  Procedure information  */
92 93 94 95 96 97
  gchar       *name;          /*  Procedure name  */
  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
98 99

  /*  Procedure type  */
100
  GimpPDBProcType  proc_type; /*  Type of procedure--Internal, Plug-In, Extension  */
Elliot Lee's avatar
Elliot Lee committed
101 102

  /*  Input arguments  */
103 104
  gint32       num_args;      /*  Number of procedure arguments  */
  ProcArg     *args;          /*  Array of procedure arguments  */
Elliot Lee's avatar
Elliot Lee committed
105 106

  /*  Output values  */
107 108
  gint32       num_values;    /*  Number of return values  */
  ProcArg     *values;        /*  Array of return values  */
Elliot Lee's avatar
Elliot Lee committed
109 110 111 112 113 114 115 116 117 118 119

  /*  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;
};

120

Elliot Lee's avatar
Elliot Lee committed
121
/*  Functions  */
122 123 124 125 126 127 128 129 130 131
void          procedural_db_init         (Gimp        *gimp);
void          procedural_db_free         (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,
					  const gchar *name,
132
					  Argument    *args);
133 134
Argument    * procedural_db_run_proc     (Gimp        *gimp,
					  const gchar *name,
135
					  gint        *nreturn_vals,
Elliot Lee's avatar
Elliot Lee committed
136
					  ...);
137 138 139 140
Argument    * procedural_db_return_args  (ProcRecord  *procedure,
					  gboolean     success);
void          procedural_db_destroy_args (Argument    *args,
					  gint         nargs);
141

142
/* "type" should really be a GimpPDBArgType, but we can cope with
143 144
 *  out-of-range values.
 */
145
const gchar * pdb_type_name (gint type); /* really exists in _cmds.c file */
Elliot Lee's avatar
Elliot Lee committed
146 147

#endif  /*  __PROCEDURAL_DB_H__  */