rofi/include/mode-private.h

209 lines
5.6 KiB
C
Raw Normal View History

/*
* rofi
*
* MIT/X11 License
2022-02-07 22:16:46 +00:00
* Copyright © 2013-2022 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.
*
*/
2016-01-07 18:47:37 +00:00
#ifndef ROFI_MODE_PRIVATE_H
#define ROFI_MODE_PRIVATE_H
2022-03-15 00:00:56 +00:00
#include "mode.h"
2017-03-04 11:00:59 +00:00
#include <gmodule.h>
G_BEGIN_DECLS
2017-03-11 12:20:46 +00:00
/** ABI version to check if loaded plugin is compatible. */
2021-09-02 14:38:34 +00:00
#define ABI_VERSION 6u
2017-02-14 17:12:07 +00:00
2016-10-14 16:56:09 +00:00
/**
2016-11-15 20:54:31 +00:00
* @param data Pointer to #Mode object.
2016-10-14 16:56:09 +00:00
*
* Mode free function.
*/
typedef void (*_mode_free)(Mode *data);
2016-01-07 18:47:37 +00:00
2016-10-14 16:56:09 +00:00
/**
* @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]
2016-10-14 16:56:09 +00:00
* @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);
2016-01-07 18:47:37 +00:00
2017-04-12 15:58:32 +00:00
/**
* @param sw The #Mode pointer
* @param selected_line The selected line
*
* Obtains the icon if available
*
* @return Get the icon
*/
typedef cairo_surface_t *(*_mode_get_icon)(const Mode *sw,
unsigned int selected_line,
int height);
2017-04-12 15:58:32 +00:00
2016-10-14 16:56:09 +00:00
/**
* @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);
2016-10-14 16:56:09 +00:00
2016-01-07 18:47:37 +00:00
/**
* @param tokens List of (input) tokens to match.
* @param input The entry to match against.
* @param case_sensitive Whether case is significant.
* @param index The current selected index.
* @param data User data.
*
* 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);
2016-01-07 18:47:37 +00:00
2016-10-14 16:56:09 +00:00
/**
* @param sw The #Mode pointer
*
* Initialize the mode.
*
2017-11-23 17:41:52 +00:00
* @returns TRUE is successful
2016-10-14 16:56:09 +00:00
*/
typedef int (*__mode_init)(Mode *sw);
2016-01-07 18:47:37 +00:00
2016-10-14 16:56:09 +00:00
/**
* @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);
2016-01-07 18:47:37 +00:00
2016-10-14 16:56:09 +00:00
/**
* @param sw The #Mode pointer
*
* Destroy the current mode. Still ready to restart.
*
*/
typedef void (*__mode_destroy)(Mode *sw);
2016-01-07 18:47:37 +00:00
2016-10-14 16:56:09 +00:00
/**
* @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);
2016-01-07 18:47:37 +00:00
2016-10-14 16:56:09 +00:00
/**
* @param sw The #Mode pointer
* @param input The input string
*
* Preprocess the input for sorting.
*
2016-10-15 13:39:08 +00:00
* @returns Entry stripped from markup for sorting
2016-10-14 16:56:09 +00:00
*/
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);
2016-01-07 18:47:37 +00:00
/**
* 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;
/** Extra fields for script */
void *ed;
/** Module */
GModule *module;
2016-01-07 18:47:37 +00:00
};
G_END_DECLS
2016-01-07 18:47:37 +00:00
#endif // ROFI_MODE_PRIVATE_H