335 lines
8.2 KiB
C
335 lines
8.2 KiB
C
|
/* LIBPIKA - The PIKA Library
|
||
|
|
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
|
||
|
|
*
|
||
|
|
* This library is free software: you can redistribute it and/or
|
||
|
|
* modify it under the terms of the GNU Lesser General Public
|
||
|
|
* License as published by the Free Software Foundation; either
|
||
|
|
* version 3 of the License, or (at your option) any later version.
|
||
|
|
*
|
||
|
|
* This library 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
|
||
|
|
* Lesser General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Lesser General Public
|
||
|
|
* License along with this library. If not, see
|
||
|
|
* <https://www.gnu.org/licenses/>.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef __PIKA_PROTOCOL_H__
|
||
|
|
#define __PIKA_PROTOCOL_H__
|
||
|
|
|
||
|
|
G_BEGIN_DECLS
|
||
|
|
|
||
|
|
/* For information look into the C source or the html documentation */
|
||
|
|
|
||
|
|
|
||
|
|
/* Increment every time the protocol changes
|
||
|
|
*/
|
||
|
|
#define PIKA_PROTOCOL_VERSION 0x010F
|
||
|
|
|
||
|
|
|
||
|
|
enum
|
||
|
|
{
|
||
|
|
GP_QUIT,
|
||
|
|
GP_CONFIG,
|
||
|
|
GP_TILE_REQ,
|
||
|
|
GP_TILE_ACK,
|
||
|
|
GP_TILE_DATA,
|
||
|
|
GP_PROC_RUN,
|
||
|
|
GP_PROC_RETURN,
|
||
|
|
GP_TEMP_PROC_RUN,
|
||
|
|
GP_TEMP_PROC_RETURN,
|
||
|
|
GP_PROC_INSTALL,
|
||
|
|
GP_PROC_UNINSTALL,
|
||
|
|
GP_EXTENSION_ACK,
|
||
|
|
GP_HAS_INIT
|
||
|
|
};
|
||
|
|
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
GP_PARAM_DEF_TYPE_DEFAULT,
|
||
|
|
GP_PARAM_DEF_TYPE_INT,
|
||
|
|
GP_PARAM_DEF_TYPE_UNIT,
|
||
|
|
GP_PARAM_DEF_TYPE_ENUM,
|
||
|
|
GP_PARAM_DEF_TYPE_BOOLEAN,
|
||
|
|
GP_PARAM_DEF_TYPE_FLOAT,
|
||
|
|
GP_PARAM_DEF_TYPE_STRING,
|
||
|
|
GP_PARAM_DEF_TYPE_COLOR,
|
||
|
|
GP_PARAM_DEF_TYPE_ID,
|
||
|
|
GP_PARAM_DEF_TYPE_ID_ARRAY
|
||
|
|
} GPParamDefType;
|
||
|
|
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
GP_PARAM_TYPE_INT,
|
||
|
|
GP_PARAM_TYPE_FLOAT,
|
||
|
|
GP_PARAM_TYPE_STRING,
|
||
|
|
GP_PARAM_TYPE_STRV,
|
||
|
|
GP_PARAM_TYPE_BYTES,
|
||
|
|
GP_PARAM_TYPE_FILE,
|
||
|
|
GP_PARAM_TYPE_COLOR,
|
||
|
|
GP_PARAM_TYPE_PARASITE,
|
||
|
|
GP_PARAM_TYPE_ARRAY,
|
||
|
|
GP_PARAM_TYPE_ID_ARRAY,
|
||
|
|
GP_PARAM_TYPE_PARAM_DEF
|
||
|
|
} GPParamType;
|
||
|
|
|
||
|
|
|
||
|
|
typedef struct _GPConfig GPConfig;
|
||
|
|
typedef struct _GPTileReq GPTileReq;
|
||
|
|
typedef struct _GPTileAck GPTileAck;
|
||
|
|
typedef struct _GPTileData GPTileData;
|
||
|
|
typedef struct _GPParamDef GPParamDef;
|
||
|
|
typedef struct _GPParamDefInt GPParamDefInt;
|
||
|
|
typedef struct _GPParamDefUnit GPParamDefUnit;
|
||
|
|
typedef struct _GPParamDefEnum GPParamDefEnum;
|
||
|
|
typedef struct _GPParamDefBoolean GPParamDefBoolean;
|
||
|
|
typedef struct _GPParamDefFloat GPParamDefFloat;
|
||
|
|
typedef struct _GPParamDefString GPParamDefString;
|
||
|
|
typedef struct _GPParamStrv GPParamStrv;
|
||
|
|
typedef struct _GPParamDefColor GPParamDefColor;
|
||
|
|
typedef struct _GPParamDefID GPParamDefID;
|
||
|
|
typedef struct _GPParamDefIDArray GPParamDefIDArray;
|
||
|
|
typedef struct _GPParam GPParam;
|
||
|
|
typedef struct _GPParamArray GPParamArray;
|
||
|
|
typedef struct _GPParamIDArray GPParamIDArray;
|
||
|
|
typedef struct _GPProcRun GPProcRun;
|
||
|
|
typedef struct _GPProcReturn GPProcReturn;
|
||
|
|
typedef struct _GPProcInstall GPProcInstall;
|
||
|
|
typedef struct _GPProcUninstall GPProcUninstall;
|
||
|
|
|
||
|
|
|
||
|
|
struct _GPConfig
|
||
|
|
{
|
||
|
|
guint32 tile_width;
|
||
|
|
guint32 tile_height;
|
||
|
|
gint32 shm_id;
|
||
|
|
gint8 check_size;
|
||
|
|
gint8 check_type;
|
||
|
|
gint8 show_help_button;
|
||
|
|
gint8 use_cpu_accel;
|
||
|
|
gint8 use_opencl;
|
||
|
|
gint8 export_color_profile;
|
||
|
|
gint8 export_comment;
|
||
|
|
gint8 export_exif;
|
||
|
|
gint8 export_xmp;
|
||
|
|
gint8 export_iptc;
|
||
|
|
gint32 default_display_id;
|
||
|
|
gchar *app_name;
|
||
|
|
gchar *wm_class;
|
||
|
|
gchar *display_name;
|
||
|
|
gint32 monitor_number;
|
||
|
|
guint32 timestamp;
|
||
|
|
gchar *icon_theme_dir;
|
||
|
|
guint64 tile_cache_size;
|
||
|
|
gchar *swap_path;
|
||
|
|
gchar *swap_compression;
|
||
|
|
gint32 num_processors;
|
||
|
|
|
||
|
|
/* since protocol version 0x010F: */
|
||
|
|
PikaRGB check_custom_color1;
|
||
|
|
PikaRGB check_custom_color2;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPTileReq
|
||
|
|
{
|
||
|
|
gint32 drawable_id;
|
||
|
|
guint32 tile_num;
|
||
|
|
guint32 shadow;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPTileData
|
||
|
|
{
|
||
|
|
gint32 drawable_id;
|
||
|
|
guint32 tile_num;
|
||
|
|
guint32 shadow;
|
||
|
|
guint32 bpp;
|
||
|
|
guint32 width;
|
||
|
|
guint32 height;
|
||
|
|
guint32 use_shm;
|
||
|
|
guchar *data;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDefInt
|
||
|
|
{
|
||
|
|
gint64 min_val;
|
||
|
|
gint64 max_val;
|
||
|
|
gint64 default_val;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDefUnit
|
||
|
|
{
|
||
|
|
gint32 allow_pixels;
|
||
|
|
gint32 allow_percent;
|
||
|
|
gint32 default_val;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDefEnum
|
||
|
|
{
|
||
|
|
gint32 default_val;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDefBoolean
|
||
|
|
{
|
||
|
|
gint32 default_val;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDefFloat
|
||
|
|
{
|
||
|
|
gdouble min_val;
|
||
|
|
gdouble max_val;
|
||
|
|
gdouble default_val;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDefString
|
||
|
|
{
|
||
|
|
gchar *default_val;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDefColor
|
||
|
|
{
|
||
|
|
gint32 has_alpha;
|
||
|
|
PikaRGB default_val;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDefID
|
||
|
|
{
|
||
|
|
gint32 none_ok;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDefIDArray
|
||
|
|
{
|
||
|
|
gchar *type_name;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamDef
|
||
|
|
{
|
||
|
|
GPParamDefType param_def_type;
|
||
|
|
gchar *type_name;
|
||
|
|
gchar *value_type_name;
|
||
|
|
gchar *name;
|
||
|
|
gchar *nick;
|
||
|
|
gchar *blurb;
|
||
|
|
guint flags;
|
||
|
|
|
||
|
|
union
|
||
|
|
{
|
||
|
|
GPParamDefInt m_int;
|
||
|
|
GPParamDefUnit m_unit;
|
||
|
|
GPParamDefEnum m_enum;
|
||
|
|
GPParamDefBoolean m_boolean;
|
||
|
|
GPParamDefFloat m_float;
|
||
|
|
GPParamDefString m_string;
|
||
|
|
GPParamDefColor m_color;
|
||
|
|
GPParamDefID m_id;
|
||
|
|
GPParamDefIDArray m_id_array;
|
||
|
|
} meta;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamArray
|
||
|
|
{
|
||
|
|
guint32 size;
|
||
|
|
guint8 *data;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParamIDArray
|
||
|
|
{
|
||
|
|
gchar *type_name;
|
||
|
|
guint32 size;
|
||
|
|
gint32 *data;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPParam
|
||
|
|
{
|
||
|
|
GPParamType param_type;
|
||
|
|
gchar *type_name;
|
||
|
|
|
||
|
|
union
|
||
|
|
{
|
||
|
|
gint32 d_int;
|
||
|
|
gdouble d_float;
|
||
|
|
gchar *d_string;
|
||
|
|
gchar **d_strv;
|
||
|
|
GBytes *d_bytes;
|
||
|
|
PikaRGB d_color;
|
||
|
|
PikaParasite d_parasite;
|
||
|
|
GPParamArray d_array;
|
||
|
|
GPParamIDArray d_id_array;
|
||
|
|
GPParamDef d_param_def;
|
||
|
|
} data;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPProcRun
|
||
|
|
{
|
||
|
|
gchar *name;
|
||
|
|
guint32 n_params;
|
||
|
|
GPParam *params;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPProcReturn
|
||
|
|
{
|
||
|
|
gchar *name;
|
||
|
|
guint32 n_params;
|
||
|
|
GPParam *params;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPProcInstall
|
||
|
|
{
|
||
|
|
gchar *name;
|
||
|
|
guint32 type;
|
||
|
|
guint32 n_params;
|
||
|
|
guint32 n_return_vals;
|
||
|
|
GPParamDef *params;
|
||
|
|
GPParamDef *return_vals;
|
||
|
|
};
|
||
|
|
|
||
|
|
struct _GPProcUninstall
|
||
|
|
{
|
||
|
|
gchar *name;
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
void gp_init (void);
|
||
|
|
|
||
|
|
gboolean gp_quit_write (GIOChannel *channel,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_config_write (GIOChannel *channel,
|
||
|
|
GPConfig *config,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_tile_req_write (GIOChannel *channel,
|
||
|
|
GPTileReq *tile_req,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_tile_ack_write (GIOChannel *channel,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_tile_data_write (GIOChannel *channel,
|
||
|
|
GPTileData *tile_data,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_proc_run_write (GIOChannel *channel,
|
||
|
|
GPProcRun *proc_run,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_proc_return_write (GIOChannel *channel,
|
||
|
|
GPProcReturn *proc_return,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_temp_proc_run_write (GIOChannel *channel,
|
||
|
|
GPProcRun *proc_run,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_temp_proc_return_write (GIOChannel *channel,
|
||
|
|
GPProcReturn *proc_return,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_proc_install_write (GIOChannel *channel,
|
||
|
|
GPProcInstall *proc_install,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_proc_uninstall_write (GIOChannel *channel,
|
||
|
|
GPProcUninstall *proc_uninstall,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_extension_ack_write (GIOChannel *channel,
|
||
|
|
gpointer user_data);
|
||
|
|
gboolean gp_has_init_write (GIOChannel *channel,
|
||
|
|
gpointer user_data);
|
||
|
|
|
||
|
|
|
||
|
|
G_END_DECLS
|
||
|
|
|
||
|
|
#endif /* __PIKA_PROTOCOL_H__ */
|
