PIKApp/app/widgets/pikadeviceinfo.c

1403 lines
44 KiB
C

/* PIKA - Photo and Image Kooker Application
* a rebranding of The GNU Image Manipulation Program (created with heckimp)
* A derived work which may be trivial. However, any changes may be (C)2023 by Aldercone Studio
*
* Original copyright, applying to most contents (license remains unchanged):
* 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 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/>.
*/
#include "config.h"
#include <string.h>
#include <gegl.h>
#include <gtk/gtk.h>
#include "libpikabase/pikabase.h"
#include "libpikaconfig/pikaconfig.h"
#include "libpikawidgets/pikawidgets.h"
#include "widgets-types.h"
#include "core/pika.h"
#include "core/pikacontext.h"
#include "core/pikacontainer.h"
#include "core/pikacurve.h"
#include "core/pikacurve-map.h"
#include "core/pikadatafactory.h"
#include "core/pikaparamspecs.h"
#include "core/pikatoolinfo.h"
#include "pikadeviceinfo.h"
#include "pika-intl.h"
#define PIKA_DEVICE_INFO_DATA_KEY "pika-device-info"
/**
* Some default names for axis. We will only use them when the device is
* not plugged (in which case, we would use names returned by GDK).
*/
static const gchar *const axis_use_strings[] =
{
N_("X"),
N_("Y"),
N_("Pressure"),
N_("X tilt"),
N_("Y tilt"),
/* Wheel as in mouse or input device wheel.
* Some pens would use the same axis for their rotation feature.
* See bug 791455.
* Yet GTK+ has a different axis since v. 3.22.
* TODO: this should be actually tested with a device having such
* feature.
*/
N_("Wheel"),
N_("Distance"),
N_("Rotation"),
N_("Slider")
};
enum
{
PROP_0,
PROP_DEVICE,
PROP_DISPLAY,
PROP_MODE,
PROP_SOURCE,
PROP_VENDOR_ID,
PROP_PRODUCT_ID,
PROP_TOOL_TYPE,
PROP_TOOL_SERIAL,
PROP_TOOL_HARDWARE_ID,
PROP_AXES,
PROP_KEYS,
PROP_PRESSURE_CURVE
};
struct _PikaDeviceInfoPrivate
{
GdkDevice *device;
GdkDisplay *display;
/* either "device" or the options below are set */
GdkInputMode mode;
gint n_axes;
GdkAxisUse *axes_uses;
gchar **axes_names;
gint n_keys;
PikaDeviceKey *keys;
/* curves */
PikaCurve *pressure_curve;
};
/* local function prototypes */
static void pika_device_info_constructed (GObject *object);
static void pika_device_info_finalize (GObject *object);
static void pika_device_info_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec);
static void pika_device_info_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec);
static void pika_device_info_guess_icon (PikaDeviceInfo *info);
static void pika_device_info_tool_changed (GdkDevice *device,
GdkDeviceTool *tool,
PikaDeviceInfo *info);
static void pika_device_info_device_changed (GdkDevice *device,
PikaDeviceInfo *info);
static void pika_device_info_updated (PikaDeviceInfo *info);
G_DEFINE_TYPE_WITH_PRIVATE (PikaDeviceInfo, pika_device_info, PIKA_TYPE_TOOL_PRESET)
#define parent_class pika_device_info_parent_class
static void
pika_device_info_class_init (PikaDeviceInfoClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
PikaViewableClass *viewable_class = PIKA_VIEWABLE_CLASS (klass);
GParamSpec *param_spec;
object_class->constructed = pika_device_info_constructed;
object_class->finalize = pika_device_info_finalize;
object_class->set_property = pika_device_info_set_property;
object_class->get_property = pika_device_info_get_property;
viewable_class->default_icon_name = PIKA_ICON_INPUT_DEVICE;
g_object_class_install_property (object_class, PROP_DEVICE,
g_param_spec_object ("device",
NULL, NULL,
GDK_TYPE_DEVICE,
PIKA_PARAM_STATIC_STRINGS |
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_EXPLICIT_NOTIFY));
g_object_class_install_property (object_class, PROP_DISPLAY,
g_param_spec_object ("display",
NULL, NULL,
GDK_TYPE_DISPLAY,
PIKA_PARAM_STATIC_STRINGS |
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_EXPLICIT_NOTIFY));
PIKA_CONFIG_PROP_ENUM (object_class, PROP_MODE,
"mode",
_("Mode"),
NULL,
GDK_TYPE_INPUT_MODE,
GDK_MODE_DISABLED,
PIKA_PARAM_STATIC_STRINGS);
g_object_class_install_property (object_class, PROP_SOURCE,
g_param_spec_enum ("source",
NULL, NULL,
GDK_TYPE_INPUT_SOURCE,
GDK_SOURCE_MOUSE,
PIKA_PARAM_STATIC_STRINGS |
G_PARAM_READABLE));
g_object_class_install_property (object_class, PROP_VENDOR_ID,
g_param_spec_string ("vendor-id",
NULL, NULL,
NULL,
PIKA_PARAM_STATIC_STRINGS |
G_PARAM_READABLE));
g_object_class_install_property (object_class, PROP_PRODUCT_ID,
g_param_spec_string ("product-id",
NULL, NULL,
NULL,
PIKA_PARAM_STATIC_STRINGS |
G_PARAM_READABLE));
g_object_class_install_property (object_class, PROP_TOOL_TYPE,
g_param_spec_enum ("tool-type",
NULL, NULL,
GDK_TYPE_DEVICE_TOOL_TYPE,
GDK_DEVICE_TOOL_TYPE_UNKNOWN,
PIKA_PARAM_STATIC_STRINGS |
G_PARAM_READABLE));
g_object_class_install_property (object_class, PROP_TOOL_SERIAL,
g_param_spec_uint64 ("tool-serial",
NULL, NULL,
0, G_MAXUINT64, 0,
PIKA_PARAM_STATIC_STRINGS |
G_PARAM_READABLE));
g_object_class_install_property (object_class, PROP_TOOL_HARDWARE_ID,
g_param_spec_uint64 ("tool-hardware-id",
NULL, NULL,
0, G_MAXUINT64, 0,
PIKA_PARAM_STATIC_STRINGS |
G_PARAM_READABLE));
param_spec = g_param_spec_enum ("axis",
NULL, NULL,
GDK_TYPE_AXIS_USE,
GDK_AXIS_IGNORE,
PIKA_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_AXES,
pika_param_spec_value_array ("axes",
NULL, NULL,
param_spec,
PIKA_PARAM_STATIC_STRINGS |
PIKA_CONFIG_PARAM_FLAGS));
param_spec = g_param_spec_string ("key",
NULL, NULL,
NULL,
PIKA_PARAM_READWRITE);
g_object_class_install_property (object_class, PROP_KEYS,
pika_param_spec_value_array ("keys",
NULL, NULL,
param_spec,
PIKA_PARAM_STATIC_STRINGS |
PIKA_CONFIG_PARAM_FLAGS));
PIKA_CONFIG_PROP_OBJECT (object_class, PROP_PRESSURE_CURVE,
"pressure-curve",
_("Pressure curve"),
NULL,
PIKA_TYPE_CURVE,
PIKA_CONFIG_PARAM_AGGREGATE);
}
static void
pika_device_info_init (PikaDeviceInfo *info)
{
pika_data_make_internal (PIKA_DATA (info), NULL);
info->priv = pika_device_info_get_instance_private (info);
info->priv->mode = GDK_MODE_DISABLED;
info->priv->pressure_curve = PIKA_CURVE (pika_curve_new ("pressure curve"));
info->priv->axes_names = NULL;
g_signal_connect (info, "notify::name",
G_CALLBACK (pika_device_info_guess_icon),
NULL);
}
static void
pika_device_info_constructed (GObject *object)
{
PikaDeviceInfo *info = PIKA_DEVICE_INFO (object);
G_OBJECT_CLASS (parent_class)->constructed (object);
pika_device_info_updated (info);
pika_assert ((info->priv->device == NULL && info->priv->display == NULL) ||
(GDK_IS_DEVICE (info->priv->device) && GDK_IS_DISPLAY (info->priv->display)));
}
static void
pika_device_info_finalize (GObject *object)
{
PikaDeviceInfo *info = PIKA_DEVICE_INFO (object);
g_clear_pointer (&info->priv->axes_uses, g_free);
g_clear_pointer (&info->priv->keys, g_free);
g_strfreev (info->priv->axes_names);
g_clear_object (&info->priv->pressure_curve);
G_OBJECT_CLASS (parent_class)->finalize (object);
}
static void
pika_device_info_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
PikaDeviceInfo *info = PIKA_DEVICE_INFO (object);
GdkDevice *device = info->priv->device;
PikaCurve *src_curve = NULL;
PikaCurve *dest_curve = NULL;
switch (property_id)
{
case PROP_DEVICE:
/* Nothing to disconnect, it's G_PARAM_CONSTRUCT_ONLY. */
info->priv->device = g_value_get_object (value);
if (info->priv->device)
{
g_signal_connect_object (info->priv->device, "tool-changed",
G_CALLBACK (pika_device_info_tool_changed),
G_OBJECT (info), 0);
g_signal_connect_object (info->priv->device, "changed",
G_CALLBACK (pika_device_info_device_changed),
G_OBJECT (info), 0);
}
break;
case PROP_DISPLAY:
info->priv->display = g_value_get_object (value);
break;
case PROP_MODE:
pika_device_info_set_mode (info, g_value_get_enum (value));
break;
case PROP_AXES:
{
/* Axes information as stored in devicerc. */
PikaValueArray *array = g_value_get_boxed (value);
if (array)
{
gint i;
gint n_device_values = pika_value_array_length (array);
if (device)
{
if (info->priv->n_axes != 0 &&
gdk_device_get_device_type (device) != GDK_DEVICE_TYPE_MASTER &&
info->priv->n_axes != n_device_values)
g_printerr ("%s: stored 'num-axes' for device '%s' doesn't match "
"number of axes present in device\n",
G_STRFUNC, gdk_device_get_name (device));
n_device_values = MIN (n_device_values,
gdk_device_get_n_axes (device));
}
else if (! info->priv->n_axes && n_device_values > 0)
{
info->priv->n_axes = n_device_values;
info->priv->axes_uses = g_new0 (GdkAxisUse, info->priv->n_axes);
info->priv->axes_names = g_new0 (gchar *, info->priv->n_axes + 1);
}
for (i = 0; i < n_device_values; i++)
{
GdkAxisUse axis_use;
axis_use = g_value_get_enum (pika_value_array_index (array, i));
pika_device_info_set_axis_use (info, i, axis_use);
}
}
}
break;
case PROP_KEYS:
{
PikaValueArray *array = g_value_get_boxed (value);
if (array)
{
gint i;
gint n_device_values = pika_value_array_length (array);
if (device)
n_device_values = MIN (n_device_values,
gdk_device_get_n_keys (device));
info->priv->n_keys = n_device_values;
info->priv->keys = g_renew (PikaDeviceKey, info->priv->keys, info->priv->n_keys);
if (info->priv->n_keys > 0)
memset (info->priv->keys, 0, info->priv->n_keys * sizeof (PikaDeviceKey));
for (i = 0; i < n_device_values; i++)
{
const gchar *accel;
guint keyval;
GdkModifierType modifiers;
accel = g_value_get_string (pika_value_array_index (array, i));
gtk_accelerator_parse (accel, &keyval, &modifiers);
pika_device_info_set_key (info, i, keyval, modifiers);
}
}
}
break;
case PROP_PRESSURE_CURVE:
src_curve = g_value_get_object (value);
dest_curve = info->priv->pressure_curve;
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
if (src_curve && dest_curve)
{
pika_config_copy (PIKA_CONFIG (src_curve),
PIKA_CONFIG (dest_curve),
PIKA_CONFIG_PARAM_SERIALIZE);
}
}
static void
pika_device_info_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
PikaDeviceInfo *info = PIKA_DEVICE_INFO (object);
switch (property_id)
{
case PROP_DEVICE:
g_value_set_object (value, info->priv->device);
break;
case PROP_DISPLAY:
g_value_set_object (value, info->priv->display);
break;
case PROP_MODE:
g_value_set_enum (value, pika_device_info_get_mode (info));
break;
case PROP_SOURCE:
g_value_set_enum (value, pika_device_info_get_source (info));
break;
case PROP_VENDOR_ID:
g_value_set_string (value, pika_device_info_get_vendor_id (info));
break;
case PROP_PRODUCT_ID:
g_value_set_string (value, pika_device_info_get_product_id (info));
break;
case PROP_TOOL_TYPE:
g_value_set_enum (value, pika_device_info_get_tool_type (info));
break;
case PROP_TOOL_SERIAL:
g_value_set_uint64 (value, pika_device_info_get_tool_serial (info));
break;
case PROP_TOOL_HARDWARE_ID:
g_value_set_uint64 (value, pika_device_info_get_tool_hardware_id (info));
break;
case PROP_AXES:
{
PikaValueArray *array;
GValue enum_value = G_VALUE_INIT;
gint n_axes;
gint i;
array = pika_value_array_new (6);
g_value_init (&enum_value, GDK_TYPE_AXIS_USE);
n_axes = pika_device_info_get_n_axes (info);
for (i = 0; i < n_axes; i++)
{
g_value_set_enum (&enum_value,
pika_device_info_get_axis_use (info, i));
pika_value_array_append (array, &enum_value);
}
g_value_unset (&enum_value);
g_value_take_boxed (value, array);
}
break;
case PROP_KEYS:
{
PikaValueArray *array;
GValue string_value = G_VALUE_INIT;
gint n_keys;
gint i;
array = pika_value_array_new (32);
g_value_init (&string_value, G_TYPE_STRING);
n_keys = pika_device_info_get_n_keys (info);
for (i = 0; i < n_keys; i++)
{
guint keyval;
GdkModifierType modifiers;
pika_device_info_get_key (info, i, &keyval, &modifiers);
if (keyval)
{
gchar *accel;
gchar *escaped;
accel = gtk_accelerator_name (keyval, modifiers);
escaped = g_strescape (accel, NULL);
g_free (accel);
g_value_set_string (&string_value, escaped);
g_free (escaped);
}
else
{
g_value_set_string (&string_value, "");
}
pika_value_array_append (array, &string_value);
}
g_value_unset (&string_value);
g_value_take_boxed (value, array);
}
break;
case PROP_PRESSURE_CURVE:
g_value_set_object (value, info->priv->pressure_curve);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
pika_device_info_guess_icon (PikaDeviceInfo *info)
{
PikaViewable *viewable = PIKA_VIEWABLE (info);
if (pika_object_get_name (viewable) &&
! strcmp (pika_viewable_get_icon_name (viewable),
PIKA_VIEWABLE_GET_CLASS (viewable)->default_icon_name))
{
const gchar *icon_name = NULL;
gchar *down = g_ascii_strdown (pika_object_get_name (viewable),
-1);
if (strstr (down, "eraser"))
{
icon_name = PIKA_ICON_TOOL_ERASER;
}
else if (strstr (down, "pen"))
{
icon_name = PIKA_ICON_TOOL_PAINTBRUSH;
}
else if (strstr (down, "airbrush"))
{
icon_name = PIKA_ICON_TOOL_AIRBRUSH;
}
else if (strstr (down, "cursor") ||
strstr (down, "mouse") ||
strstr (down, "pointer") ||
strstr (down, "touchpad") ||
strstr (down, "trackpoint"))
{
icon_name = PIKA_ICON_CURSOR;
}
g_free (down);
if (icon_name)
pika_viewable_set_icon_name (viewable, icon_name);
}
}
static void
pika_device_info_tool_changed (GdkDevice *device,
GdkDeviceTool *tool,
PikaDeviceInfo *info)
{
g_object_freeze_notify (G_OBJECT (info));
/* GDK docs says that the number of axes can change on "changed"
* signal for virtual devices only, but here, I encounter a change of
* number of axes on a physical device, the first time when a stylus
* approached then moved away from the active surface. When the tool
* became then a GDK_DEVICE_TOOL_TYPE_UNKNOWN, I had one more axis
* (which created criticals later).
* So let's check specifically for such case.
*/
if (info->priv->n_axes != gdk_device_get_n_axes (device))
{
gint n_axes = gdk_device_get_n_axes (device);
gint old_n_axes = info->priv->n_axes;
gint i;
for (i = n_axes; i < info->priv->n_axes; i++)
g_free (info->priv->axes_names[i]);
info->priv->axes_names = g_renew (gchar *, info->priv->axes_names, n_axes + 1);
for (i = info->priv->n_axes; i < n_axes + 1; i++)
info->priv->axes_names[i] = NULL;
info->priv->axes_uses = g_renew (GdkAxisUse, info->priv->axes_uses, n_axes);
info->priv->n_axes = n_axes;
for (i = old_n_axes; i < n_axes; i++)
{
GdkAxisUse axis_use;
axis_use = gdk_device_get_axis_use (info->priv->device, i);
pika_device_info_set_axis_use (info, i, axis_use);
}
}
g_object_notify (G_OBJECT (info), "tool-type");
g_object_notify (G_OBJECT (info), "tool-serial");
g_object_notify (G_OBJECT (info), "tool-hardware-id");
g_object_thaw_notify (G_OBJECT (info));
}
static void
pika_device_info_device_changed (GdkDevice *device,
PikaDeviceInfo *info)
{
/* Number of axes or keys can change on virtual devices when the
* physical device changes.
*/
pika_device_info_updated (info);
}
static void
pika_device_info_updated (PikaDeviceInfo *info)
{
g_return_if_fail (PIKA_IS_DEVICE_INFO (info));
g_return_if_fail ((info->priv->device == NULL && info->priv->display == NULL) ||
(GDK_IS_DEVICE (info->priv->device) && GDK_IS_DISPLAY (info->priv->display)));
g_object_freeze_notify (G_OBJECT (info));
if (info->priv->device)
{
GdkAxisUse *old_uses;
GList *axes;
GList *iter;
gint old_n_axes;
gint i;
PikaDeviceKey *old_keys;
gint old_n_keys;
g_object_set_data (G_OBJECT (info->priv->device), PIKA_DEVICE_INFO_DATA_KEY, info);
pika_object_set_name (PIKA_OBJECT (info),
gdk_device_get_name (info->priv->device));
pika_device_info_set_mode (info, gdk_device_get_mode (info->priv->device));
old_n_axes = info->priv->n_axes;
old_uses = info->priv->axes_uses;
g_strfreev (info->priv->axes_names);
axes = gdk_device_list_axes (info->priv->device);
info->priv->n_axes = g_list_length (axes);
info->priv->axes_uses = g_new0 (GdkAxisUse, info->priv->n_axes);
info->priv->axes_names = g_new0 (gchar *, info->priv->n_axes + 1);
for (i = 0, iter = axes; i < info->priv->n_axes; i++, iter = iter->next)
{
GdkAxisUse use;
/* Virtual devices are special and just reproduce their actual
* physical device at a given moment. We should never try to
* reuse the data because we risk to pass device configuration
* from one physical device to another.
*/
if (gdk_device_get_device_type (info->priv->device) == GDK_DEVICE_TYPE_MASTER ||
i >= old_n_axes)
use = gdk_device_get_axis_use (info->priv->device, i);
else
use = old_uses[i];
pika_device_info_set_axis_use (info, i, use);
if (iter->data != GDK_NONE)
info->priv->axes_names[i] = gdk_atom_name (iter->data);
else
info->priv->axes_names[i] = NULL;
}
g_list_free (axes);
g_clear_pointer (&old_uses, g_free);
old_n_keys = info->priv->n_keys;
old_keys = info->priv->keys;
info->priv->n_keys = gdk_device_get_n_keys (info->priv->device);
info->priv->keys = g_new0 (PikaDeviceKey, info->priv->n_keys);
for (i = 0; i < info->priv->n_keys; i++)
{
PikaDeviceKey key;
if (gdk_device_get_device_type (info->priv->device) == GDK_DEVICE_TYPE_MASTER ||
i >= old_n_keys)
gdk_device_get_key (info->priv->device, i, &key.keyval, &key.modifiers);
else
key = old_keys[i];
pika_device_info_set_key (info, i, key.keyval, key.modifiers);
}
g_clear_pointer (&old_keys, g_free);
}
/* sort order depends on device presence */
pika_object_name_changed (PIKA_OBJECT (info));
g_object_notify (G_OBJECT (info), "source");
g_object_notify (G_OBJECT (info), "vendor-id");
g_object_notify (G_OBJECT (info), "product-id");
g_object_notify (G_OBJECT (info), "tool-type");
g_object_notify (G_OBJECT (info), "tool-serial");
g_object_notify (G_OBJECT (info), "tool-hardware-id");
g_object_notify (G_OBJECT (info), "device");
g_object_notify (G_OBJECT (info), "display");
g_object_thaw_notify (G_OBJECT (info));
}
/* public functions */
PikaDeviceInfo *
pika_device_info_new (Pika *pika,
GdkDevice *device,
GdkDisplay *display)
{
PikaContext *context;
PikaToolInfo *tool_info;
g_return_val_if_fail (PIKA_IS_PIKA (pika), NULL);
g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
context = pika_get_user_context (pika);
tool_info = pika_context_get_tool (context);
g_return_val_if_fail (tool_info != NULL, NULL);
return g_object_new (PIKA_TYPE_DEVICE_INFO,
"pika", pika,
"device", device,
"display", display,
"mode", gdk_device_get_mode (device),
"tool-options", tool_info->tool_options,
NULL);
}
GdkDevice *
pika_device_info_get_device (PikaDeviceInfo *info,
GdkDisplay **display)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), NULL);
if (display)
*display = info->priv->display;
return info->priv->device;
}
gboolean
pika_device_info_set_device (PikaDeviceInfo *info,
GdkDevice *device,
GdkDisplay *display)
{
GdkInputMode mode;
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), FALSE);
g_return_val_if_fail ((device == NULL && display == NULL) ||
(GDK_IS_DEVICE (device) && GDK_IS_DISPLAY (display)),
FALSE);
g_return_val_if_fail (device == NULL ||
strcmp (gdk_device_get_name (device),
pika_object_get_name (info)) == 0, FALSE);
if (device && info->priv->device)
{
g_printerr ("%s: trying to set GdkDevice '%s' on PikaDeviceInfo "
"which already has a device\n",
G_STRFUNC, gdk_device_get_name (device));
#ifdef G_OS_WIN32
/* This is a very weird/dirty difference we make between Win32 and
* Linux. On Linux, we had breakage because of duplicate devices,
* fixed by overwriting the info's old device (assuming it to be
* dead) with the new one. Unfortunately doing this on Windows
* too broke a lot of devices (which used to work with the old
* way). See the regression bug #2495.
*
* NOTE that this only happens if something is wrong on the USB
* or udev or libinput or whatever side and the same device is
* present multiple times. Therefore there doesn't seem to be an
* absolute single "solution" to this problem (well there is, but
* probably not in PIKA, where we can only react). This is more
* of an experimenting-in-real-life kind of bug.
* Also we had no clear report on macOS or BSD (AFAIK) of broken
* tablets with any of the version of the code. So let's keep
* these similar to Linux for now.
*/
return FALSE;
#endif /* G_OS_WIN32 */
}
else if (! device && ! info->priv->device)
{
g_printerr ("%s: trying to unset GdkDevice of PikaDeviceInfo '%s'"
"which has no device\n",
G_STRFUNC, pika_object_get_name (info));
/* bail out, unsetting twice makes no sense */
return FALSE;
}
else if (info->priv->device)
{
if (info->priv->n_axes != gdk_device_get_n_axes (info->priv->device))
g_printerr ("%s: stored 'num-axes' for device '%s' doesn't match "
"number of axes present in device\n",
G_STRFUNC, gdk_device_get_name (info->priv->device));
if (info->priv->n_keys != gdk_device_get_n_keys (info->priv->device))
g_printerr ("%s: stored 'num-keys' for device '%s' doesn't match "
"number of keys present in device\n",
G_STRFUNC, gdk_device_get_name (info->priv->device));
}
if (info->priv->device)
{
g_object_set_data (G_OBJECT (info->priv->device),
PIKA_DEVICE_INFO_DATA_KEY, NULL);
g_signal_handlers_disconnect_by_func (info->priv->device,
pika_device_info_tool_changed,
info);
g_signal_handlers_disconnect_by_func (info->priv->device,
pika_device_info_device_changed,
info);
}
mode = pika_device_info_get_mode (info);
info->priv->device = device;
info->priv->display = display;
if (info->priv->device)
{
g_signal_connect_object (info->priv->device, "tool-changed",
G_CALLBACK (pika_device_info_tool_changed),
G_OBJECT (info), 0);
g_signal_connect_object (info->priv->device, "changed",
G_CALLBACK (pika_device_info_device_changed),
G_OBJECT (info), 0);
}
pika_device_info_updated (info);
/* The info existed from a previous run. Restore its mode. */
pika_device_info_set_mode (info, mode);
return TRUE;
}
void
pika_device_info_set_default_tool (PikaDeviceInfo *info)
{
PikaContainer *tools;
PikaToolInfo *tool_info = NULL;
g_return_if_fail (PIKA_IS_DEVICE_INFO (info));
tools = PIKA_TOOL_PRESET (info)->pika->tool_info_list;
tool_info =
PIKA_TOOL_INFO (pika_container_get_child_by_name (tools,
"pika-paintbrush-tool"));
if (info->priv->device)
{
switch (gdk_device_get_source (info->priv->device))
{
case GDK_SOURCE_ERASER:
tool_info =
PIKA_TOOL_INFO (pika_container_get_child_by_name (tools,
"pika-eraser-tool"));
break;
case GDK_SOURCE_PEN:
tool_info =
PIKA_TOOL_INFO (pika_container_get_child_by_name (tools,
"pika-paintbrush-tool"));
break;
case GDK_SOURCE_TOUCHSCREEN:
tool_info =
PIKA_TOOL_INFO (pika_container_get_child_by_name (tools,
"pika-smudge-tool"));
break;
default:
break;
}
}
if (tool_info)
{
g_object_set (info,
"tool-options", tool_info->tool_options,
NULL);
}
}
void
pika_device_info_save_tool (PikaDeviceInfo *info)
{
PikaToolPreset *preset = PIKA_TOOL_PRESET (info);
PikaContext *user_context;
PikaToolInfo *tool_info;
PikaContextPropMask serialize_props;
g_return_if_fail (PIKA_IS_DEVICE_INFO (info));
user_context = pika_get_user_context (PIKA_TOOL_PRESET (info)->pika);
tool_info = pika_context_get_tool (user_context);
g_object_set (info,
"tool-options", tool_info->tool_options,
NULL);
serialize_props =
pika_context_get_serialize_properties (PIKA_CONTEXT (preset->tool_options));
g_object_set (preset,
"use-fg-bg",
(serialize_props & PIKA_CONTEXT_PROP_MASK_FOREGROUND) ||
(serialize_props & PIKA_CONTEXT_PROP_MASK_BACKGROUND),
"use-brush",
(serialize_props & PIKA_CONTEXT_PROP_MASK_BRUSH) != 0,
"use-dynamics",
(serialize_props & PIKA_CONTEXT_PROP_MASK_DYNAMICS) != 0,
"use-mypaint-brush",
(serialize_props & PIKA_CONTEXT_PROP_MASK_MYBRUSH) != 0,
"use-gradient",
(serialize_props & PIKA_CONTEXT_PROP_MASK_GRADIENT) != 0,
"use-pattern",
(serialize_props & PIKA_CONTEXT_PROP_MASK_PATTERN) != 0,
"use-palette",
(serialize_props & PIKA_CONTEXT_PROP_MASK_PALETTE) != 0,
"use-font",
(serialize_props & PIKA_CONTEXT_PROP_MASK_FONT) != 0,
NULL);
}
void
pika_device_info_restore_tool (PikaDeviceInfo *info)
{
PikaToolPreset *preset;
PikaContext *user_context;
g_return_if_fail (PIKA_IS_DEVICE_INFO (info));
preset = PIKA_TOOL_PRESET (info);
user_context = pika_get_user_context (PIKA_TOOL_PRESET (info)->pika);
if (preset->tool_options)
{
if (pika_context_get_tool_preset (user_context) != preset)
{
pika_context_set_tool_preset (user_context, preset);
}
else
{
pika_context_tool_preset_changed (user_context);
}
}
}
GdkInputMode
pika_device_info_get_mode (PikaDeviceInfo *info)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), GDK_MODE_DISABLED);
if (info->priv->device)
return gdk_device_get_mode (info->priv->device);
else
return info->priv->mode;
}
void
pika_device_info_set_mode (PikaDeviceInfo *info,
GdkInputMode mode)
{
g_return_if_fail (PIKA_IS_DEVICE_INFO (info));
if (mode != pika_device_info_get_mode (info))
{
if (info->priv->device)
gdk_device_set_mode (info->priv->device, mode);
else
info->priv->mode = mode;
g_object_notify (G_OBJECT (info), "mode");
}
}
gboolean
pika_device_info_has_cursor (PikaDeviceInfo *info)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), FALSE);
if (info->priv->device)
{
/* this should really be
*
* "is slave, *and* the associated master is gdk_seat_get_pointer()"
*
* but who knows if future multiple masters will all have their
* own visible pointer or not, and what the API for figuring
* that will be, so for now let's simply assume that all
* devices except floating ones move the pointer on screen.
*/
return gdk_device_get_device_type (info->priv->device) !=
GDK_DEVICE_TYPE_FLOATING;
}
return FALSE;
}
GdkInputSource
pika_device_info_get_source (PikaDeviceInfo *info)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), GDK_SOURCE_MOUSE);
if (info->priv->device)
return gdk_device_get_source (info->priv->device);
return GDK_SOURCE_MOUSE;
}
const gchar *
pika_device_info_get_vendor_id (PikaDeviceInfo *info)
{
const gchar *id = _("(Device not present)");
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), NULL);
if (info->priv->device)
{
if (gdk_device_get_device_type (info->priv->device) == GDK_DEVICE_TYPE_MASTER)
{
id = _("(Virtual device)");
}
else
{
id = gdk_device_get_vendor_id (info->priv->device);
if (! (id && strlen (id)))
id = _("(none)");
}
}
return id;
}
const gchar *
pika_device_info_get_product_id (PikaDeviceInfo *info)
{
const gchar *id = _("(Device not present)");
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), NULL);
if (info->priv->device)
{
if (gdk_device_get_device_type (info->priv->device) == GDK_DEVICE_TYPE_MASTER)
{
return _("(Virtual device)");
}
else
{
id = gdk_device_get_product_id (info->priv->device);
if (! (id && strlen (id)))
id = _("(none)");
}
}
return id;
}
GdkDeviceToolType
pika_device_info_get_tool_type (PikaDeviceInfo *info)
{
GdkDeviceToolType type = GDK_DEVICE_TOOL_TYPE_UNKNOWN;
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), type);
if (info->priv->device)
{
GdkDeviceTool *tool;
g_object_get (info->priv->device, "tool", &tool, NULL);
if (tool)
{
type = gdk_device_tool_get_tool_type (tool);
g_object_unref (tool);
}
}
return type;
}
guint64
pika_device_info_get_tool_serial (PikaDeviceInfo *info)
{
guint64 serial = 0;
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), serial);
if (info->priv->device)
{
GdkDeviceTool *tool;
g_object_get (info->priv->device, "tool", &tool, NULL);
if (tool)
{
serial = gdk_device_tool_get_serial (tool);
g_object_unref (tool);
}
}
return serial;
}
guint64
pika_device_info_get_tool_hardware_id (PikaDeviceInfo *info)
{
guint64 id = 0;
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), id);
if (info->priv->device)
{
GdkDeviceTool *tool;
g_object_get (info->priv->device, "tool", &tool, NULL);
if (tool)
{
id = gdk_device_tool_get_hardware_id (tool);
g_object_unref (tool);
}
}
return id;
}
gint
pika_device_info_get_n_axes (PikaDeviceInfo *info)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), 0);
if (info->priv->device)
return gdk_device_get_n_axes (info->priv->device);
else
return info->priv->n_axes;
}
gboolean
pika_device_info_ignore_axis (PikaDeviceInfo *info,
gint axis)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), TRUE);
g_return_val_if_fail (axis >= 0 && axis < info->priv->n_axes, TRUE);
return (info->priv->axes_names[axis] == NULL);
}
const gchar *
pika_device_info_get_axis_name (PikaDeviceInfo *info,
gint axis)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), NULL);
g_return_val_if_fail (axis >= 0 && axis < GDK_AXIS_LAST, NULL);
if (info->priv->device && axis < info->priv->n_axes &&
info->priv->axes_names[axis] != NULL)
return info->priv->axes_names[axis];
else
return axis_use_strings[axis];
}
GdkAxisUse
pika_device_info_get_axis_use (PikaDeviceInfo *info,
gint axis)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), GDK_AXIS_IGNORE);
g_return_val_if_fail (axis >= 0 && axis < pika_device_info_get_n_axes (info),
GDK_AXIS_IGNORE);
if (info->priv->device)
return gdk_device_get_axis_use (info->priv->device, axis);
else
return info->priv->axes_uses[axis];
}
void
pika_device_info_set_axis_use (PikaDeviceInfo *info,
gint axis,
GdkAxisUse use)
{
g_return_if_fail (PIKA_IS_DEVICE_INFO (info));
g_return_if_fail (axis >= 0 && axis < pika_device_info_get_n_axes (info));
if (use != pika_device_info_get_axis_use (info, axis))
{
if (info->priv->device)
gdk_device_set_axis_use (info->priv->device, axis, use);
info->priv->axes_uses[axis] = use;
g_object_notify (G_OBJECT (info), "axes");
}
}
gint
pika_device_info_get_n_keys (PikaDeviceInfo *info)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), 0);
if (info->priv->device)
return gdk_device_get_n_keys (info->priv->device);
else
return info->priv->n_keys;
}
void
pika_device_info_get_key (PikaDeviceInfo *info,
gint key,
guint *keyval,
GdkModifierType *modifiers)
{
g_return_if_fail (PIKA_IS_DEVICE_INFO (info));
g_return_if_fail (key >= 0 && key < pika_device_info_get_n_keys (info));
g_return_if_fail (keyval != NULL);
g_return_if_fail (modifiers != NULL);
if (info->priv->device)
{
*keyval = 0;
*modifiers = 0;
gdk_device_get_key (info->priv->device, key,
keyval,
modifiers);
}
else
{
*keyval = info->priv->keys[key].keyval;
*modifiers = info->priv->keys[key].modifiers;
}
}
void
pika_device_info_set_key (PikaDeviceInfo *info,
gint key,
guint keyval,
GdkModifierType modifiers)
{
guint old_keyval;
GdkModifierType old_modifiers;
g_return_if_fail (PIKA_IS_DEVICE_INFO (info));
g_return_if_fail (key >= 0 && key < pika_device_info_get_n_keys (info));
pika_device_info_get_key (info, key, &old_keyval, &old_modifiers);
if (keyval != old_keyval ||
modifiers != old_modifiers)
{
if (info->priv->device)
gdk_device_set_key (info->priv->device, key, keyval, modifiers);
info->priv->keys[key].keyval = keyval;
info->priv->keys[key].modifiers = modifiers;
g_object_notify (G_OBJECT (info), "keys");
}
}
PikaCurve *
pika_device_info_get_curve (PikaDeviceInfo *info,
GdkAxisUse use)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), NULL);
switch (use)
{
case GDK_AXIS_PRESSURE:
return info->priv->pressure_curve;
break;
default:
return NULL;
}
}
gdouble
pika_device_info_map_axis (PikaDeviceInfo *info,
GdkAxisUse use,
gdouble value)
{
g_return_val_if_fail (PIKA_IS_DEVICE_INFO (info), value);
/* CLAMP() the return values be safe against buggy XInput drivers */
switch (use)
{
case GDK_AXIS_PRESSURE:
return pika_curve_map_value (info->priv->pressure_curve, value);
case GDK_AXIS_XTILT:
return CLAMP (value, PIKA_COORDS_MIN_TILT, PIKA_COORDS_MAX_TILT);
case GDK_AXIS_YTILT:
return CLAMP (value, PIKA_COORDS_MIN_TILT, PIKA_COORDS_MAX_TILT);
case GDK_AXIS_WHEEL:
return CLAMP (value, PIKA_COORDS_MIN_WHEEL, PIKA_COORDS_MAX_WHEEL);
default:
break;
}
return value;
}
PikaDeviceInfo *
pika_device_info_get_by_device (GdkDevice *device)
{
g_return_val_if_fail (GDK_IS_DEVICE (device), NULL);
return g_object_get_data (G_OBJECT (device), PIKA_DEVICE_INFO_DATA_KEY);
}
gint
pika_device_info_compare (PikaDeviceInfo *a,
PikaDeviceInfo *b)
{
GdkSeat *seat;
if (a->priv->device && a->priv->display &&
(seat = gdk_display_get_default_seat (a->priv->display)) &&
a->priv->device == gdk_seat_get_pointer (seat))
{
return -1;
}
else if (b->priv->device && b->priv->display &&
(seat = gdk_display_get_default_seat (b->priv->display)) &&
b->priv->device == gdk_seat_get_pointer (seat))
{
return 1;
}
else if (a->priv->device && ! b->priv->device)
{
return -1;
}
else if (! a->priv->device && b->priv->device)
{
return 1;
}
else
{
return pika_object_name_collate ((PikaObject *) a,
(PikaObject *) b);
}
}