mutter/src/meta/util.h

229 lines
6.3 KiB
C
Raw Normal View History

/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
/* Mutter utilities */
2001-05-30 15:36:31 +00:00
2014-05-02 13:34:02 +00:00
/*
2001-05-30 15:36:31 +00:00
* Copyright (C) 2001 Havoc Pennington
* Copyright (C) 2005 Elijah Newren
2014-05-02 13:34:02 +00:00
*
2001-05-30 15:36:31 +00:00
* 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.
2014-05-02 13:34:02 +00:00
*
2001-05-30 15:36:31 +00:00
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <http://www.gnu.org/licenses/>.
2001-05-30 15:36:31 +00:00
*/
#ifndef META_UTIL_H
#define META_UTIL_H
#include <glib.h>
#include <glib-object.h>
2001-05-30 15:36:31 +00:00
#include <meta/common.h>
#include <meta/meta-later.h>
META_EXPORT
2001-05-30 15:36:31 +00:00
gboolean meta_is_verbose (void);
META_EXPORT
2001-05-31 06:42:58 +00:00
gboolean meta_is_syncing (void);
META_EXPORT
gboolean meta_is_wayland_compositor (void);
2001-05-30 15:36:31 +00:00
META_EXPORT
void meta_verbose_real (const char *format,
...) G_GNUC_PRINTF (1, 2);
META_EXPORT
2001-05-31 03:30:58 +00:00
void meta_bug (const char *format,
...) G_GNUC_PRINTF (1, 2);
META_EXPORT
2001-05-30 15:36:31 +00:00
void meta_warning (const char *format,
...) G_GNUC_PRINTF (1, 2);
META_EXPORT
2001-05-30 15:36:31 +00:00
void meta_fatal (const char *format,
...) G_GNUC_PRINTF (1, 2) G_GNUC_NORETURN G_ANALYZER_NORETURN;
2001-05-30 15:36:31 +00:00
/**
* MetaDebugTopic:
* @META_DEBUG_VERBOSE: verbose logging
* @META_DEBUG_FOCUS: focus
* @META_DEBUG_WORKAREA: workarea
* @META_DEBUG_STACK: stack
* @META_DEBUG_SM: session management
* @META_DEBUG_EVENTS: events
* @META_DEBUG_WINDOW_STATE: window state
* @META_DEBUG_WINDOW_OPS: window operations
* @META_DEBUG_GEOMETRY: geometry
* @META_DEBUG_PLACEMENT: window placement
* @META_DEBUG_PING: ping
* @META_DEBUG_KEYBINDINGS: keybindings
* @META_DEBUG_SYNC: sync
* @META_DEBUG_STARTUP: startup
* @META_DEBUG_PREFS: preferences
* @META_DEBUG_GROUPS: groups
* @META_DEBUG_RESIZING: resizing
* @META_DEBUG_SHAPES: shapes
* @META_DEBUG_EDGE_RESISTANCE: edge resistance
* @META_DEBUG_WAYLAND: Wayland
*/
typedef enum
{
META_DEBUG_VERBOSE = -1,
META_DEBUG_FOCUS = 1 << 0,
META_DEBUG_WORKAREA = 1 << 1,
META_DEBUG_STACK = 1 << 2,
META_DEBUG_SM = 1 << 3,
META_DEBUG_EVENTS = 1 << 4,
META_DEBUG_WINDOW_STATE = 1 << 5,
META_DEBUG_WINDOW_OPS = 1 << 6,
META_DEBUG_GEOMETRY = 1 << 7,
META_DEBUG_PLACEMENT = 1 << 8,
META_DEBUG_PING = 1 << 9,
META_DEBUG_KEYBINDINGS = 1 << 10,
META_DEBUG_SYNC = 1 << 11,
META_DEBUG_STARTUP = 1 << 12,
META_DEBUG_PREFS = 1 << 13,
META_DEBUG_GROUPS = 1 << 14,
META_DEBUG_RESIZING = 1 << 15,
META_DEBUG_SHAPES = 1 << 16,
META_DEBUG_EDGE_RESISTANCE = 1 << 17,
META_DEBUG_DBUS = 1 << 18,
META_DEBUG_INPUT = 1 << 19,
META_DEBUG_WAYLAND = 1 << 20,
} MetaDebugTopic;
/**
* MetaDebugPaintFlag:
* @META_DEBUG_PAINT_NONE: default
* @META_DEBUG_PAINT_OPAQUE_REGION: paint opaque regions
*/
typedef enum
{
META_DEBUG_PAINT_NONE = 0,
META_DEBUG_PAINT_OPAQUE_REGION = 1 << 0,
} MetaDebugPaintFlag;
META_EXPORT
gboolean meta_is_topic_enabled (MetaDebugTopic topic);
META_EXPORT
void meta_topic_real (MetaDebugTopic topic,
const char *format,
...) G_GNUC_PRINTF (2, 3);
META_EXPORT
void meta_add_verbose_topic (MetaDebugTopic topic);
META_EXPORT
void meta_remove_verbose_topic (MetaDebugTopic topic);
META_EXPORT
2001-06-10 19:23:28 +00:00
void meta_push_no_msg_prefix (void);
META_EXPORT
2001-06-10 19:23:28 +00:00
void meta_pop_no_msg_prefix (void);
META_EXPORT
gint meta_unsigned_long_equal (gconstpointer v1,
gconstpointer v2);
META_EXPORT
guint meta_unsigned_long_hash (gconstpointer v);
META_EXPORT
const char* meta_frame_type_to_string (MetaFrameType type);
META_EXPORT
const char* meta_gravity_to_string (MetaGravity gravity);
Merge of all the changes on the constraints_experiments branch. This is 2005-11-18 Elijah Newren <newren@gmail.com> Merge of all the changes on the constraints_experiments branch. This is just a summary, to get the full ChangeLog of those changes (approx. 2000 lines): cvs -q -z3 update -Pd -r constraints_experiments cvs -q -z3 diff -pu -r CONSTRAINTS_EXPERIMENTS_BRANCHPOINT ChangeLog Bugs fixed: unfiled - constraints.c is overly complicated[1] unfiled - constraints.c is not robust when all constraints cannot simultaneously be met (constraints need to be prioritized) unfiled - keep-titlebar-onscreen constraint is decoration unaware (since get_outermost_onscreen_positions() forgets to include decorations) unfiled - keyboard snap-moving and snap-resizing snap to hidden edges 109553 - gravity w/ simultaneous move & resize doesn't work 113601 - maximize vertical and horizontal should toggle and be constrained 122196 - windows show up under vertical panels 122670 - jerky/random resizing of window via keyboard[2] 124582 - keyboard and mouse snap-resizing and snap-moving erroneously moves the window multidimensionally 136307 - don't allow apps to resize themselves off the screen (*cough* filechooser *cough*) 142016, 143784 - windows should not span multiple xineramas unless placed there by the user 143145 - clamp new windows to screensize and force them onscreen, if they'll fit 144126 - Handle pathological strut lists sanely[3] 149867 - fixed aspect ratio windows are difficult to resize[4] 152898 - make screen edges consistent; allow easy slamming of windows into the left, right, and bottom edges of the screen too. 154706 - bouncing weirdness at screen edge with keyboard moving or resizing 156699 - avoid struts when placing windows, if possible (nasty a11y blocker) 302456 - dragging offscreen too restrictive 304857 - wireframe moving off the top of the screen is misleading 308521 - make uni-directional resizing easier with alt-middle-drag and prevent the occasional super annoying resize-the-wrong-side(s) behavior 312007 - snap-resize moves windows with a minimum size constraint 312104 - resizing the top of a window can cause the bottom to grow 319351 - don't instantly snap on mouse-move-snapping, remove braindeadedness of having order of releasing shift and releasing button press matter so much [1] fixed in my opinion, anyway. [2] Actually, it's not totally fixed--it's just annoying instead of almost completely unusable. Matthias had a suggestion that may fix the remainder of the problems (see http://tinyurl.com/bwzuu). [3] This bug was originally about not-quite-so-pathological cases but was left open for the worse cases. The code from the branch handles the remainder of the cases mentioned in this bug. [4] Actually, although it's far better there's still some minor issues left: a slight drift that's only noticeable after lots of resizing, and potential problems with partially onscreen constraints due to not clearing any fixed_directions flags (aspect ratio windows get resized in both directions and thus aren't fixed in one of them) New feature: 81704 - edge resistance for user move and resize operations; in particular 3 different kinds of resistance are implemented: Pixel-Distance: window movement is resisted when it aligns with an edge unless the movement is greater than a threshold number of pixels Timeout: window movement past an edge is prevented until a certain amount of time has elapsed during the operation since the first request to move it past that edge Keyboard-Buildup: when moving or resizing with the keyboard, once a window is aligned with a certain edge it cannot move past until the correct direction has been pressed enough times (e.g. 2 or 3 times) Major changes: - constraints.c has been rewritten; very few lines of code from the old version remain. There is a comment near the top of the function explaining the basics of how the new framework works. A more detailed explanation can be found in doc/how-constraints-works.txt - edge-resistance.[ch] are new files implementing edge-resistance. - boxes.[ch] are new files containing low-level error-prone functions used heavily in constraints.c and edge-resistance.c, among various places throughout the code. testboxes.c contains a thorough testsuite for the boxes.[ch] functions compiled into a program, testboxes. - meta_window_move_resize_internal() *must* be told the gravity of the associated operation (if it's just a move operation, the gravity will be ignored, but for resize and move+resize the correct value is needed) - the craziness of different values that meta_window_move_resize_internal() accepts has been documented in a large comment at the beginning of the function. It may be possible to clean this up some, but until then things will remain as they were before--caller beware. - screen and xinerama usable areas (i.e. places not covered by e.g. panels) are cached in the workspace now, as are the screen and xinerama edges. These get updated with the workarea in src/workspace.c:ensure_work_areas_validated()
2005-11-19 14:58:50 +00:00
META_EXPORT
char* meta_external_binding_name_for_action (guint keybinding_action);
META_EXPORT
char* meta_g_utf8_strndup (const gchar *src, gsize n);
META_EXPORT
GPid meta_show_dialog (const char *type,
const char *message,
const char *timeout,
const char *display,
const char *ok_text,
const char *cancel_text,
const char *icon_name,
const int transient_for,
GSList *columns,
GSList *entries);
/* To disable verbose mode, we make these functions into no-ops */
#ifdef WITH_VERBOSE_MODE
#define meta_verbose(...) \
G_STMT_START \
{ \
if (meta_is_topic_enabled (META_DEBUG_VERBOSE)) \
meta_verbose_real (__VA_ARGS__); \
} \
G_STMT_END
#define meta_topic(debug_topic,...) \
G_STMT_START \
{ \
if (meta_is_topic_enabled (debug_topic)) \
meta_topic_real (debug_topic, __VA_ARGS__); \
} \
G_STMT_END
#else
# ifdef G_HAVE_ISO_VARARGS
# define meta_verbose(...)
# define meta_topic(...)
# elif defined(G_HAVE_GNUC_VARARGS)
# define meta_verbose(format...)
# define meta_topic(format...)
# else
# error "This compiler does not support varargs macros and thus verbose mode can't be disabled meaningfully"
# endif
#endif /* !WITH_VERBOSE_MODE */
typedef enum
{
META_LOCALE_DIRECTION_LTR,
META_LOCALE_DIRECTION_RTL,
} MetaLocaleDirection;
META_EXPORT
MetaLocaleDirection meta_get_locale_direction (void);
META_EXPORT
void meta_add_clutter_debug_flags (ClutterDebugFlag debug_flags,
ClutterDrawDebugFlag draw_flags,
ClutterPickDebugFlag pick_flags);
META_EXPORT
void meta_remove_clutter_debug_flags (ClutterDebugFlag debug_flags,
ClutterDrawDebugFlag draw_flags,
ClutterPickDebugFlag pick_flags);
META_EXPORT
void meta_add_debug_paint_flag (MetaDebugPaintFlag flag);
META_EXPORT
void meta_remove_debug_paint_flag (MetaDebugPaintFlag flag);
META_EXPORT
MetaDebugPaintFlag meta_get_debug_paint_flags (void);
#endif /* META_UTIL_H */