geany/src/keybindings.h

/*
 *      keybindings.h - this file is part of Geany, a fast and lightweight IDE
 *
 *      Copyright 2006-2008 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
 *      Copyright 2006-2008 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
 *
 *      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
 *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $Id$
 */

/**
 * @file keybindings.h
 * Configurable keyboard shortcuts.
 **/


#ifndef GEANY_KEYBINDINGS_H
#define GEANY_KEYBINDINGS_H 1

/* allowed modifier keys (especially NOT Caps lock, no Num lock) */
#if GTK_CHECK_VERSION(2, 10, 0)
# define GEANY_KEYS_MODIFIER_MASK (GDK_SHIFT_MASK | GDK_CONTROL_MASK | GDK_MOD1_MASK | \
								   GDK_META_MASK | GDK_SUPER_MASK | GDK_HYPER_MASK)
#else
# define GEANY_KEYS_MODIFIER_MASK (GDK_SHIFT_MASK | GDK_CONTROL_MASK | GDK_MOD1_MASK)
#endif


typedef void (*KeyCallback) (guint key_id);

/** Represents a single keybinding action */
typedef struct KeyBinding
{
	guint key;				/**< Key value in lower-case, such as @c GDK_a */
	GdkModifierType mods;	/**< Modifier keys, such as @c GDK_CONTROL_MASK */
	const gchar *name;		/**< Key name for the configuration file, such as @c "menu_new" */
	const gchar *label;		/**< Label used in the preferences dialog keybindings tab */
	KeyCallback callback;	/**< Callback function called when the key combination is pressed */
	GtkWidget *menu_item;	/**< Menu item widget for setting the menu accelerator */
} KeyBinding;


/** A collection of keybindings grouped together. */
typedef struct KeyBindingGroup
{
	const gchar *name;		/**< Group name used in the configuration file, such as @c "html_chars" */
	const gchar *label;		/**< Group label used in the preferences dialog keybindings tab */
	gsize count;			/**< Count of KeyBinding structs in @a keys */
	KeyBinding *keys;		/**< Fixed array of KeyBinding structs */
}
KeyBindingGroup;

extern GPtrArray *keybinding_groups;	/* array of KeyBindingGroup pointers */


/* Plugin API enums - append only to maintain plugin ABI */
enum
{
	GEANY_KEYGROUP_FILE,
	GEANY_KEYGROUP_EDIT,
	GEANY_KEYGROUP_SEARCH,
	GEANY_KEYGROUP_VIEW,
	GEANY_KEYGROUP_DOCUMENT,
	GEANY_KEYGROUP_BUILD,
	GEANY_KEYGROUP_TOOLS,
	GEANY_KEYGROUP_HELP,
	GEANY_KEYGROUP_FOCUS,
	GEANY_KEYGROUP_NOTEBOOK,
	GEANY_KEYGROUP_EDITING,
	GEANY_KEYGROUP_TAGS,
	GEANY_KEYGROUP_OTHER,
	GEANY_KEYGROUP_COUNT
};

enum
{
	GEANY_KEYS_MENU_NEW,
	GEANY_KEYS_MENU_OPEN,
	GEANY_KEYS_MENU_OPENSELECTED,
	GEANY_KEYS_MENU_SAVE,
	GEANY_KEYS_MENU_SAVEAS,
	GEANY_KEYS_MENU_SAVEALL,
	GEANY_KEYS_MENU_PRINT,
	GEANY_KEYS_MENU_CLOSE,
	GEANY_KEYS_MENU_CLOSEALL,
	GEANY_KEYS_MENU_RELOADFILE,
	GEANY_KEYS_MENU_PROJECTPROPERTIES,
	GEANY_KEYS_FILE_COUNT
};

enum
{
	GEANY_KEYS_MENU_UNDO,
	GEANY_KEYS_MENU_REDO,
	GEANY_KEYS_MENU_CUT,
	GEANY_KEYS_MENU_COPY,
	GEANY_KEYS_MENU_PASTE,
	GEANY_KEYS_MENU_SELECTALL,
	GEANY_KEYS_MENU_INSERTDATE,
	GEANY_KEYS_MENU_PREFERENCES,
	GEANY_KEYS_EDIT_COUNT
};

enum
{
	GEANY_KEYS_MENU_FIND,
	GEANY_KEYS_MENU_FINDNEXT,
	GEANY_KEYS_MENU_FINDPREVIOUS,
	GEANY_KEYS_MENU_FINDINFILES,
	GEANY_KEYS_MENU_REPLACE,
	GEANY_KEYS_MENU_FINDNEXTSEL,
	GEANY_KEYS_MENU_FINDPREVSEL,
	GEANY_KEYS_MENU_NEXTMESSAGE,
	GEANY_KEYS_MENU_GOTOLINE,
	GEANY_KEYS_SEARCH_COUNT
};

enum
{
	GEANY_KEYS_MENU_TOGGLEALL,
	GEANY_KEYS_MENU_FULLSCREEN,
	GEANY_KEYS_MENU_MESSAGEWINDOW,
	GEANY_KEYS_MENU_SIDEBAR,
	GEANY_KEYS_MENU_ZOOMIN,
	GEANY_KEYS_MENU_ZOOMOUT,
	GEANY_KEYS_VIEW_COUNT
};

enum
{
	GEANY_KEYS_MENU_REPLACETABS,
	GEANY_KEYS_MENU_FOLDALL,
	GEANY_KEYS_MENU_UNFOLDALL,
	GEANY_KEYS_RELOADTAGLIST,
	GEANY_KEYS_DOCUMENT_COUNT
};

enum
{
	GEANY_KEYS_BUILD_COMPILE,
	GEANY_KEYS_BUILD_LINK,
	GEANY_KEYS_BUILD_MAKE,
	GEANY_KEYS_BUILD_MAKEOWNTARGET,
	GEANY_KEYS_BUILD_MAKEOBJECT,
	GEANY_KEYS_BUILD_NEXTERROR,
	GEANY_KEYS_BUILD_RUN,
	GEANY_KEYS_BUILD_RUN2,
	GEANY_KEYS_BUILD_OPTIONS,
	GEANY_KEYS_BUILD_COUNT
};

enum
{
	GEANY_KEYS_MENU_OPENCOLORCHOOSER,
	GEANY_KEYS_TOOLS_COUNT
};

enum
{
	GEANY_KEYS_MENU_HELP,
	GEANY_KEYS_HELP_COUNT
};

enum
{
	GEANY_KEYS_SWITCH_EDITOR,
	GEANY_KEYS_SWITCH_SCRIBBLE,
	GEANY_KEYS_SWITCH_VTE,
	GEANY_KEYS_SWITCH_SEARCH_BAR,
	GEANY_KEYS_FOCUS_COUNT
};

enum
{
	GEANY_KEYS_SWITCH_TABLEFT,
	GEANY_KEYS_SWITCH_TABRIGHT,
	GEANY_KEYS_SWITCH_TABLASTUSED,
	GEANY_KEYS_MOVE_TABLEFT,
	GEANY_KEYS_MOVE_TABRIGHT,
	GEANY_KEYS_MOVE_TABFIRST,
	GEANY_KEYS_MOVE_TABLAST,
	GEANY_KEYS_NOTEBOOK_COUNT
};

enum
{
	GEANY_KEYS_EDIT_TOGGLECASE,
	GEANY_KEYS_EDIT_DUPLICATELINE,
	GEANY_KEYS_EDIT_DELETELINE,
	GEANY_KEYS_EDIT_COPYLINE,
	GEANY_KEYS_EDIT_CUTLINE,
	GEANY_KEYS_EDIT_TRANSPOSELINE,
	GEANY_KEYS_EDIT_COMMENTLINETOGGLE,
	GEANY_KEYS_EDIT_COMMENTLINE,
	GEANY_KEYS_EDIT_UNCOMMENTLINE,
	GEANY_KEYS_EDIT_INCREASEINDENT,
	GEANY_KEYS_EDIT_DECREASEINDENT,
	GEANY_KEYS_EDIT_INCREASEINDENTBYSPACE,
	GEANY_KEYS_EDIT_DECREASEINDENTBYSPACE,
	GEANY_KEYS_EDIT_AUTOINDENT,
	GEANY_KEYS_EDIT_SENDTOCMD1,
	GEANY_KEYS_EDIT_SENDTOCMD2,
	GEANY_KEYS_EDIT_SENDTOCMD3,
	GEANY_KEYS_EDIT_GOTOMATCHINGBRACE,
	GEANY_KEYS_EDIT_TOGGLEMARKER,
	GEANY_KEYS_EDIT_GOTONEXTMARKER,
	GEANY_KEYS_EDIT_GOTOPREVIOUSMARKER,
	GEANY_KEYS_EDIT_SELECTWORD,
	GEANY_KEYS_EDIT_SELECTLINE,
	GEANY_KEYS_EDIT_SELECTPARAGRAPH,
	GEANY_KEYS_EDIT_SCROLLTOLINE,
	GEANY_KEYS_EDIT_SCROLLLINEUP,
	GEANY_KEYS_EDIT_SCROLLLINEDOWN,
	GEANY_KEYS_EDIT_INSERTALTWHITESPACE,
	GEANY_KEYS_POPUP_FINDUSAGE,
	GEANY_KEYS_POPUP_CONTEXTACTION,
	GEANY_KEYS_EDITING_COUNT
};

enum
{
	GEANY_KEYS_EDIT_AUTOCOMPLETE,
	GEANY_KEYS_EDIT_CALLTIP,
	GEANY_KEYS_EDIT_MACROLIST,
	GEANY_KEYS_EDIT_COMPLETESNIPPET,
	GEANY_KEYS_EDIT_SUPPRESSSNIPPETCOMPLETION,
	GEANY_KEYS_POPUP_GOTOTAGDEFINITION,
	GEANY_KEYS_POPUP_GOTOTAGDECLARATION,
	GEANY_KEYS_TAGS_COUNT
};

enum
{
	GEANY_KEYS_NAV_FORWARD,
	GEANY_KEYS_NAV_BACK,
	GEANY_KEYS_OTHER_COUNT
};


void keybindings_init(void);

void keybindings_load_keyfile(void);

void keybindings_free(void);

void keybindings_set_item(KeyBindingGroup *group, gsize key_id,
		KeyCallback callback, guint key, GdkModifierType mod,
		const gchar *name, const gchar *label, GtkWidget *menu_item);

void keybindings_send_command(guint group_id, guint key_id);

KeyBinding *keybindings_lookup_item(guint group_id, guint key_id);

/* just write the content of the keys array to the config file */
void keybindings_write_to_file(void);

void keybindings_show_shortcuts(void);

/* central keypress event handler, almost all keypress events go to this function */
gboolean keybindings_got_event(GtkWidget *widget, GdkEventKey *event, gpointer user_data);

#endif