mirror of
https://github.com/lbonn/rofi
synced 2024-11-13 23:57:10 +00:00
263 lines
7 KiB
C
263 lines
7 KiB
C
/*
|
|
* rofi
|
|
*
|
|
* MIT/X11 License
|
|
* Copyright © 2013-2023 Qball Cow <qball@gmpclient.org>
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
*/
|
|
|
|
#ifndef ROFI_MODE_PRIVATE_H
|
|
#define ROFI_MODE_PRIVATE_H
|
|
#include "mode.h"
|
|
#include <gmodule.h>
|
|
G_BEGIN_DECLS
|
|
|
|
/** ABI version to check if loaded plugin is compatible. */
|
|
#define ABI_VERSION 7u
|
|
|
|
/**
|
|
* Indicator what type of mode this is.
|
|
* For now it can be the classic switcher, or also implement a completer.
|
|
*/
|
|
typedef enum {
|
|
/** Mode type is not set */
|
|
MODE_TYPE_UNSET = 0x0,
|
|
/** A normal mode. */
|
|
MODE_TYPE_SWITCHER = 0x1,
|
|
/** A mode that can be used to completer */
|
|
MODE_TYPE_COMPLETER = 0x2,
|
|
/** DMenu mode. */
|
|
MODE_TYPE_DMENU = 0x4,
|
|
} ModeType;
|
|
|
|
/**
|
|
* @param data Pointer to #Mode object.
|
|
*
|
|
* Mode free function.
|
|
*/
|
|
typedef void (*_mode_free)(Mode *data);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
* @param selected_line The selected line
|
|
* @param state The state to display [out]
|
|
* @param attribute_list List of extra (pango) attribute to apply when
|
|
* displaying. [out][null]
|
|
* @param get_entry if it should only return the state
|
|
*
|
|
* Get the value for displaying.
|
|
*
|
|
* @return the string and state for displaying.
|
|
*/
|
|
typedef char *(*_mode_get_display_value)(const Mode *sw,
|
|
unsigned int selected_line, int *state,
|
|
GList **attribute_list, int get_entry);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
* @param selected_line The selected line
|
|
* @param height The height of the icon
|
|
*
|
|
* Obtains the icon if available
|
|
*
|
|
* @return Get the icon
|
|
*/
|
|
typedef cairo_surface_t *(*_mode_get_icon)(const Mode *sw,
|
|
unsigned int selected_line,
|
|
unsigned int height);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
* @param selected_line The selected line
|
|
*
|
|
* Obtains the string to complete.
|
|
*
|
|
* @return Get the completion string
|
|
*/
|
|
typedef char *(*_mode_get_completion)(const Mode *sw,
|
|
unsigned int selected_line);
|
|
|
|
/**
|
|
* @param data The #Mode pointer
|
|
* @param tokens List of (input) tokens to match.
|
|
* @param index The current selected index.
|
|
*
|
|
* Function prototype for the matching algorithm.
|
|
*
|
|
* @returns 1 when it matches, 0 if not.
|
|
*/
|
|
typedef int (*_mode_token_match)(const Mode *data, rofi_int_matcher **tokens,
|
|
unsigned int index);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
*
|
|
* Initialize the mode.
|
|
*
|
|
* @returns TRUE is successful
|
|
*/
|
|
typedef int (*__mode_init)(Mode *sw);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
*
|
|
* Get the number of entries.
|
|
*
|
|
* @returns the number of entries
|
|
*/
|
|
typedef unsigned int (*__mode_get_num_entries)(const Mode *sw);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
*
|
|
* Destroy the current mode. Still ready to restart.
|
|
*
|
|
*/
|
|
typedef void (*__mode_destroy)(Mode *sw);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
* @param menu_retv The return value
|
|
* @param input The input string
|
|
* @param selected_line The selected line
|
|
*
|
|
* Handle the user accepting an entry.
|
|
*
|
|
* @returns the next action to take
|
|
*/
|
|
typedef ModeMode (*_mode_result)(Mode *sw, int menu_retv, char **input,
|
|
unsigned int selected_line);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
* @param input The input string
|
|
*
|
|
* Preprocess the input for sorting.
|
|
*
|
|
* @returns Entry stripped from markup for sorting
|
|
*/
|
|
typedef char *(*_mode_preprocess_input)(Mode *sw, const char *input);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
*
|
|
* Message to show in the message bar.
|
|
*
|
|
* @returns the (valid pango markup) message to display.
|
|
*/
|
|
typedef char *(*_mode_get_message)(const Mode *sw);
|
|
|
|
/**
|
|
* Create a new instance of this mode.
|
|
* Free (free) result after use, after using mode_destroy.
|
|
*
|
|
* @returns Instantiate a new instance of this mode.
|
|
*/
|
|
typedef Mode *(*_mode_create)(void);
|
|
|
|
/**
|
|
* @param sw The #Mode pointer
|
|
* @param menu_retv The return value
|
|
* @param input The input string
|
|
* @param selected_line The selected line
|
|
* @param path the path that was completed
|
|
*
|
|
* Handle the user accepting an entry in completion mode.
|
|
*
|
|
* @returns the next action to take
|
|
*/
|
|
typedef ModeMode (*_mode_completer_result)(Mode *sw, int menu_retv,
|
|
char **input,
|
|
unsigned int selected_line,
|
|
char **path);
|
|
/**
|
|
* Structure defining a switcher.
|
|
* It consists of a name, callback and if enabled
|
|
* a textbox for the sidebar-mode.
|
|
*/
|
|
struct rofi_mode {
|
|
/** Used for external plugins. */
|
|
unsigned int abi_version;
|
|
/** Name (max 31 char long) */
|
|
char *name;
|
|
char cfg_name_key[128];
|
|
char *display_name;
|
|
|
|
/**
|
|
* A switcher normally consists of the following parts:
|
|
*/
|
|
/** Initialize the Mode */
|
|
__mode_init _init;
|
|
/** Destroy the switcher, e.g. free all its memory. */
|
|
__mode_destroy _destroy;
|
|
/** Get number of entries to display. (unfiltered). */
|
|
__mode_get_num_entries _get_num_entries;
|
|
/** Process the result of the user selection. */
|
|
_mode_result _result;
|
|
/** Token match. */
|
|
_mode_token_match _token_match;
|
|
/** Get the string to display for the entry. */
|
|
_mode_get_display_value _get_display_value;
|
|
/** Get the icon for the entry. */
|
|
_mode_get_icon _get_icon;
|
|
/** Get the 'completed' entry. */
|
|
_mode_get_completion _get_completion;
|
|
|
|
_mode_preprocess_input _preprocess_input;
|
|
|
|
_mode_get_message _get_message;
|
|
|
|
/** Pointer to private data. */
|
|
void *private_data;
|
|
|
|
/**
|
|
* Free SWitcher
|
|
* Only to be used when the switcher object itself is dynamic.
|
|
* And has data in `ed`
|
|
*/
|
|
_mode_free free;
|
|
|
|
/**
|
|
* Create mode.
|
|
*/
|
|
_mode_create _create;
|
|
|
|
/**
|
|
* If this mode is used as completer.
|
|
*/
|
|
_mode_completer_result _completer_result;
|
|
|
|
/** Extra fields for script */
|
|
void *ed;
|
|
|
|
/** Module */
|
|
GModule *module;
|
|
|
|
/** Fallack icon.*/
|
|
uint32_t fallback_icon_fetch_uid;
|
|
uint32_t fallback_icon_not_found;
|
|
|
|
/** type */
|
|
ModeType type;
|
|
};
|
|
G_END_DECLS
|
|
#endif // ROFI_MODE_PRIVATE_H
|