AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
637890517b
gtk2/gtk/gtkactionmuxerprivate.h

95 lines
4.3 KiB
C
Raw Normal View History

add GActionMuxer and observer interfaces These were destined for GLib, but they don't really make sense as a public API. Instead, we'll copy/paste them around between the various codebases that need to render menus.
2011-11-30 14:33:03 +00:00
/*
* Copyright © 2011 Canonical Limited
*
* 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 2 of the licence, 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
Change FSF Address
2012-02-27 13:01:10 +00:00
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
add GActionMuxer and observer interfaces These were destined for GLib, but they don't really make sense as a public API. Instead, we'll copy/paste them around between the various codebases that need to render menus.
2011-11-30 14:33:03 +00:00
*
* Author: Ryan Lortie <desrt@desrt.ca>
*/
action stuff: stop abusing GLib's namespace Rename our internal GActionMuxer, GActionObserver and GActionObservable classes and interfaces to have names in our own namespace. These classes were originally intended for GIO but turned out to be too special-purpose to be useful there, so we never made them public API but have just been copying them around (without bothering to properly rename them). Now that other people will be copying them out of Gtk, it's even more important to prevent this namespace abuse from spreading further.
2013-05-09 18:15:51 +00:00
#ifndef __GTK_ACTION_MUXER_H__
#define __GTK_ACTION_MUXER_H__
add GActionMuxer and observer interfaces These were destined for GLib, but they don't really make sense as a public API. Instead, we'll copy/paste them around between the various codebases that need to render menus.
2011-11-30 14:33:03 +00:00
#include <gio/gio.h>
Give the action muxer a widget This will be used in the future to obtain widget class actions.
2019-06-15 23:08:39 +00:00
#include "gtkwidget.h"
add GActionMuxer and observer interfaces These were destined for GLib, but they don't really make sense as a public API. Instead, we'll copy/paste them around between the various codebases that need to render menus.
2011-11-30 14:33:03 +00:00
G_BEGIN_DECLS
action stuff: stop abusing GLib's namespace Rename our internal GActionMuxer, GActionObserver and GActionObservable classes and interfaces to have names in our own namespace. These classes were originally intended for GIO but turned out to be too special-purpose to be useful there, so we never made them public API but have just been copying them around (without bothering to properly rename them). Now that other people will be copying them out of Gtk, it's even more important to prevent this namespace abuse from spreading further.
2013-05-09 18:15:51 +00:00
#define GTK_TYPE_ACTION_MUXER (gtk_action_muxer_get_type ())
#define GTK_ACTION_MUXER(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
GTK_TYPE_ACTION_MUXER, GtkActionMuxer))
#define GTK_IS_ACTION_MUXER(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
GTK_TYPE_ACTION_MUXER))
add GActionMuxer and observer interfaces These were destined for GLib, but they don't really make sense as a public API. Instead, we'll copy/paste them around between the various codebases that need to render menus.
2011-11-30 14:33:03 +00:00
widget: fix class private data usage to be _init() safe Before this commit, adding GtkWidgetAction to class private data would require copying the actions to each subclass as they were built or modified. This was convenient in that it is a sort of "copy on write" semantic. However, due to the way that GTypeInstance works with base _init() functions, the "g_class" pointer in GTypeInstance is updated as each _init() function is called. That means you cannot access the subclasses class private data, but only the parent class private data. If instead we use a singly linked list of GtkWidgetAction, each subclass has their own "head" yet all subclasses share the tail of the GtkWidgetAction chain. This creates one bit of complexity though. You need a stable way to know which "bit" is the "enabled" bit of the action so we can track enabled GAction state. That is easily solved by calculating the distance to the end of the chain for a given action so that base classes sort ahead of subclasses. Since the parent class always knows its parent's actions, the position is stable. A new dynamic bitarray helper also helps us avoid allocations in all the current cases (up to 64 actions per widget) and dynamically switches to malloc if that is to ever be exceeded.
2020-03-20 16:22:29 +00:00
typedef struct _GtkWidgetAction GtkWidgetAction;
typedef struct _GtkActionMuxer GtkActionMuxer;
struct _GtkWidgetAction
{
GtkWidgetAction *next;
Allow registering actions per-class Add a facility to register and install actions at class init time. The intended use for these actions is for a) context and other model-based menus b) key bindings Most of these actions are going to be stateless, so add separate apis for the simple and stateful cases. We avoid creating an action group for these by teaching the action muxer about these actions. The action muxer also maintains the enabled state for these actions.
2019-06-14 12:12:10 +00:00
char *name;
Add owner types for widget actions This lets us filter out actions from parent classes when introspecting.
2019-06-22 13:35:57 +00:00
GType owner;
Allow registering actions per-class Add a facility to register and install actions at class init time. The intended use for these actions is for a) context and other model-based menus b) key bindings Most of these actions are going to be stateless, so add separate apis for the simple and stateful cases. We avoid creating an action group for these by teaching the action muxer about these actions. The action muxer also maintains the enabled state for these actions.
2019-06-14 12:12:10 +00:00
Replace stateful actions by property actions The only cases of stateful actions we've seen so far have been boolean properties, and we don't really want to add much state handling API, so lets just go with property actions for now. Adapt the only user in GtkText.
2019-06-22 20:18:05 +00:00
const GVariantType *parameter_type;
Allow registering actions per-class Add a facility to register and install actions at class init time. The intended use for these actions is for a) context and other model-based menus b) key bindings Most of these actions are going to be stateless, so add separate apis for the simple and stateful cases. We avoid creating an action group for these by teaching the action muxer about these actions. The action muxer also maintains the enabled state for these actions.
2019-06-14 12:12:10 +00:00
GtkWidgetActionActivateFunc activate;
Replace stateful actions by property actions The only cases of stateful actions we've seen so far have been boolean properties, and we don't really want to add much state handling API, so lets just go with property actions for now. Adapt the only user in GtkText.
2019-06-22 20:18:05 +00:00
const GVariantType *state_type;
GParamSpec *pspec;
widget: fix class private data usage to be _init() safe Before this commit, adding GtkWidgetAction to class private data would require copying the actions to each subclass as they were built or modified. This was convenient in that it is a sort of "copy on write" semantic. However, due to the way that GTypeInstance works with base _init() functions, the "g_class" pointer in GTypeInstance is updated as each _init() function is called. That means you cannot access the subclasses class private data, but only the parent class private data. If instead we use a singly linked list of GtkWidgetAction, each subclass has their own "head" yet all subclasses share the tail of the GtkWidgetAction chain. This creates one bit of complexity though. You need a stable way to know which "bit" is the "enabled" bit of the action so we can track enabled GAction state. That is easily solved by calculating the distance to the end of the chain for a given action so that base classes sort ahead of subclasses. Since the parent class always knows its parent's actions, the position is stable. A new dynamic bitarray helper also helps us avoid allocations in all the current cases (up to 64 actions per widget) and dynamically switches to malloc if that is to ever be exceeded.
2020-03-20 16:22:29 +00:00
};
add GActionMuxer and observer interfaces These were destined for GLib, but they don't really make sense as a public API. Instead, we'll copy/paste them around between the various codebases that need to render menus.
2011-11-30 14:33:03 +00:00
action stuff: stop abusing GLib's namespace Rename our internal GActionMuxer, GActionObserver and GActionObservable classes and interfaces to have names in our own namespace. These classes were originally intended for GIO but turned out to be too special-purpose to be useful there, so we never made them public API but have just been copying them around (without bothering to properly rename them). Now that other people will be copying them out of Gtk, it's even more important to prevent this namespace abuse from spreading further.
2013-05-09 18:15:51 +00:00
GType gtk_action_muxer_get_type (void);
widget: fix class private data usage to be _init() safe Before this commit, adding GtkWidgetAction to class private data would require copying the actions to each subclass as they were built or modified. This was convenient in that it is a sort of "copy on write" semantic. However, due to the way that GTypeInstance works with base _init() functions, the "g_class" pointer in GTypeInstance is updated as each _init() function is called. That means you cannot access the subclasses class private data, but only the parent class private data. If instead we use a singly linked list of GtkWidgetAction, each subclass has their own "head" yet all subclasses share the tail of the GtkWidgetAction chain. This creates one bit of complexity though. You need a stable way to know which "bit" is the "enabled" bit of the action so we can track enabled GAction state. That is easily solved by calculating the distance to the end of the chain for a given action so that base classes sort ahead of subclasses. Since the parent class always knows its parent's actions, the position is stable. A new dynamic bitarray helper also helps us avoid allocations in all the current cases (up to 64 actions per widget) and dynamically switches to malloc if that is to ever be exceeded.
2020-03-20 16:22:29 +00:00
GtkActionMuxer * gtk_action_muxer_new (GtkWidget *widget);
add GActionMuxer and observer interfaces These were destined for GLib, but they don't really make sense as a public API. Instead, we'll copy/paste them around between the various codebases that need to render menus.
2011-11-30 14:33:03 +00:00
action stuff: stop abusing GLib's namespace Rename our internal GActionMuxer, GActionObserver and GActionObservable classes and interfaces to have names in our own namespace. These classes were originally intended for GIO but turned out to be too special-purpose to be useful there, so we never made them public API but have just been copying them around (without bothering to properly rename them). Now that other people will be copying them out of Gtk, it's even more important to prevent this namespace abuse from spreading further.
2013-05-09 18:15:51 +00:00
void gtk_action_muxer_insert (GtkActionMuxer *muxer,
const gchar *prefix,
action stuff: Introspection fixes
2013-05-09 19:28:57 +00:00
GActionGroup *action_group);
add GActionMuxer and observer interfaces These were destined for GLib, but they don't really make sense as a public API. Instead, we'll copy/paste them around between the various codebases that need to render menus.
2011-11-30 14:33:03 +00:00
action stuff: stop abusing GLib's namespace Rename our internal GActionMuxer, GActionObserver and GActionObservable classes and interfaces to have names in our own namespace. These classes were originally intended for GIO but turned out to be too special-purpose to be useful there, so we never made them public API but have just been copying them around (without bothering to properly rename them). Now that other people will be copying them out of Gtk, it's even more important to prevent this namespace abuse from spreading further.
2013-05-09 18:15:51 +00:00
void gtk_action_muxer_remove (GtkActionMuxer *muxer,
const gchar *prefix);
action muxer: Add some convenience api Instead of duplicating this code in multiple places, add an api to look up an action group for a prefixed name, and return the unprefixed name at the same time.
2019-06-14 17:41:45 +00:00
GActionGroup * gtk_action_muxer_find (GtkActionMuxer *muxer,
const char *action_name,
const char **unprefixed_name);
action stuff: stop abusing GLib's namespace Rename our internal GActionMuxer, GActionObserver and GActionObservable classes and interfaces to have names in our own namespace. These classes were originally intended for GIO but turned out to be too special-purpose to be useful there, so we never made them public API but have just been copying them around (without bothering to properly rename them). Now that other people will be copying them out of Gtk, it's even more important to prevent this namespace abuse from spreading further.
2013-05-09 18:15:51 +00:00
GtkActionMuxer * gtk_action_muxer_get_parent (GtkActionMuxer *muxer);
GActionMuxer: add support for parent muxers If a muxer does not contain an action group with the given prefix, chain up to the "parent" muxer to look for it. This initial implementation is rather inefficient. It will lead to changes on action groups associated with parent muxers being broadcast to all children (regardless of if anybody there is interested or not). An optimised version will follow soon.
2012-08-17 17:16:51 +00:00
action stuff: stop abusing GLib's namespace Rename our internal GActionMuxer, GActionObserver and GActionObservable classes and interfaces to have names in our own namespace. These classes were originally intended for GIO but turned out to be too special-purpose to be useful there, so we never made them public API but have just been copying them around (without bothering to properly rename them). Now that other people will be copying them out of Gtk, it's even more important to prevent this namespace abuse from spreading further.
2013-05-09 18:15:51 +00:00
void gtk_action_muxer_set_parent (GtkActionMuxer *muxer,
GtkActionMuxer *parent);
GActionMuxer: add support for parent muxers If a muxer does not contain an action group with the given prefix, chain up to the "parent" muxer to look for it. This initial implementation is rather inefficient. It will lead to changes on action groups associated with parent muxers being broadcast to all children (regardless of if anybody there is interested or not). An optimised version will follow soon.
2012-08-17 17:16:51 +00:00
GtkActionMuxer: store primary accels Reuse the existing infrastructure in GtkActionMuxer for propagation of accelerator information: in particular, what accel label ought to appear on menu items for a particular action and target. This is a good idea because we want accels to travel along with the actions that they're tied to and reusing GtkActionMuxer will allow us to do that without creating another hierarchy of a different class for the sole purpose of filling in accel labels on menu items. Doing it this ways also allows those who copy/paste GtkActionMuxer to insert the accels for themselves. Add a new method on the GtkActionObserver interface to report changes. This patch introduces a new concept: "action and target" notation for actions. This format looks like so: "'target'|app.action" or for non-targeted actions: "|app.action" and it is used over a number of possible alternative formats for some good reasons: - it's very easy to get a nul-terminated action name out of this format when we need it, by using strrchr('|') + 1 - we can also get the target out of it using g_variant_parse() because this function takes a pointer to a 'limit' character that is not parsed past: we use the '|' for this - it's extremely easy to hash on this format (just use a normal string hash) vs. attempting to hash on a string plus a GVariant A close contender was to use detailed action strings here, but these are not used for two reasons: - it's not possible to easily get the action name or target out of the strings without more work than the "action and target" format requires - we still intend to use detailed action strings on API (since they are a lot nicer to look at) but detailed action strings can be given in non-canonical forms (eg: 'foo::bar' and 'foo("bar")' are equivalent) so we'd have to go through a normalisation step anyway. Since we're doing that already, we may as well convert to a more convenient internal format. This new "action and target" format is going to start appearing in a lot more places as action descriptions are introduced. I suspect that nobody is using '|' in their action names, but in case I am proven wrong, we can always switch to using something more exotic as a separator character (such as '\x01' or '\xff' or the like).
2013-07-10 02:37:17 +00:00
void gtk_action_muxer_set_primary_accel (GtkActionMuxer *muxer,
const gchar *action_and_target,
const gchar *primary_accel);
const gchar * gtk_action_muxer_get_primary_accel (GtkActionMuxer *muxer,
const gchar *action_and_target);
Allow registering actions per-class Add a facility to register and install actions at class init time. The intended use for these actions is for a) context and other model-based menus b) key bindings Most of these actions are going to be stateless, so add separate apis for the simple and stateful cases. We avoid creating an action group for these by teaching the action muxer about these actions. The action muxer also maintains the enabled state for these actions.
2019-06-14 12:12:10 +00:00
void
gtk_action_muxer_action_enabled_changed (GtkActionMuxer *muxer,
const char *action_name,
gboolean enabled);
void
gtk_action_muxer_action_state_changed (GtkActionMuxer *muxer,
const gchar *action_name,
GVariant *state);
app: share function to normalise detailed action name Put the function in gtkactionmuxer.c, where gtk_print_action_and_target() is implemented. https://bugzilla.gnome.org/show_bug.cgi?id=764879
2016-04-20 15:13:26 +00:00
/* No better place for these... */
GtkActionMuxer: store primary accels Reuse the existing infrastructure in GtkActionMuxer for propagation of accelerator information: in particular, what accel label ought to appear on menu items for a particular action and target. This is a good idea because we want accels to travel along with the actions that they're tied to and reusing GtkActionMuxer will allow us to do that without creating another hierarchy of a different class for the sole purpose of filling in accel labels on menu items. Doing it this ways also allows those who copy/paste GtkActionMuxer to insert the accels for themselves. Add a new method on the GtkActionObserver interface to report changes. This patch introduces a new concept: "action and target" notation for actions. This format looks like so: "'target'|app.action" or for non-targeted actions: "|app.action" and it is used over a number of possible alternative formats for some good reasons: - it's very easy to get a nul-terminated action name out of this format when we need it, by using strrchr('|') + 1 - we can also get the target out of it using g_variant_parse() because this function takes a pointer to a 'limit' character that is not parsed past: we use the '|' for this - it's extremely easy to hash on this format (just use a normal string hash) vs. attempting to hash on a string plus a GVariant A close contender was to use detailed action strings here, but these are not used for two reasons: - it's not possible to easily get the action name or target out of the strings without more work than the "action and target" format requires - we still intend to use detailed action strings on API (since they are a lot nicer to look at) but detailed action strings can be given in non-canonical forms (eg: 'foo::bar' and 'foo("bar")' are equivalent) so we'd have to go through a normalisation step anyway. Since we're doing that already, we may as well convert to a more convenient internal format. This new "action and target" format is going to start appearing in a lot more places as action descriptions are introduced. I suspect that nobody is using '|' in their action names, but in case I am proven wrong, we can always switch to using something more exotic as a separator character (such as '\x01' or '\xff' or the like).
2013-07-10 02:37:17 +00:00
gchar * gtk_print_action_and_target (const gchar *action_namespace,
const gchar *action_name,
GVariant *target);
app: share function to normalise detailed action name Put the function in gtkactionmuxer.c, where gtk_print_action_and_target() is implemented. https://bugzilla.gnome.org/show_bug.cgi?id=764879
2016-04-20 15:13:26 +00:00
gchar * gtk_normalise_detailed_action_name (const gchar *detailed_action_name);
add GActionMuxer and observer interfaces These were destined for GLib, but they don't really make sense as a public API. Instead, we'll copy/paste them around between the various codebases that need to render menus.
2011-11-30 14:33:03 +00:00
G_END_DECLS
action stuff: stop abusing GLib's namespace Rename our internal GActionMuxer, GActionObserver and GActionObservable classes and interfaces to have names in our own namespace. These classes were originally intended for GIO but turned out to be too special-purpose to be useful there, so we never made them public API but have just been copying them around (without bothering to properly rename them). Now that other people will be copying them out of Gtk, it's even more important to prevent this namespace abuse from spreading further.
2013-05-09 18:15:51 +00:00
#endif /* __GTK_ACTION_MUXER_H__ */
Reference in New Issue Copy Permalink