rofi/include/xrmoptions.h

178 lines
4.9 KiB
C
Raw Normal View History

/*
* rofi
*
* MIT/X11 License
2020-01-01 11:23:12 +00:00
* Copyright © 2013-2020 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.
*
*/
2015-07-27 08:17:12 +00:00
#ifndef ROFI_XRMOPTIONS_H
#define ROFI_XRMOPTIONS_H
2016-03-01 17:11:55 +00:00
#include "xcb.h"
#include "theme.h"
2016-01-07 12:32:33 +00:00
// Big thanks to Sean Pringle for this code.
2014-05-22 19:56:57 +00:00
2016-01-07 07:54:24 +00:00
/**
2016-01-07 12:32:33 +00:00
* @defgroup CONFXResources XResources Configuration
* @ingroup CONFIGURATION
*
* Configuration described in Xresource format. This can be loaded from the X server or file.
*
* @defgroup CONFXServer XServer Configuration
* @ingroup CONFXResources
*
* Loads the configuration directly from the X server using the XResources system.
*
* @defgroup CONFCommandline Commandline Configuration
* @ingroup CONFIGURATION
*
* Modified the configuration based on commandline arguments
*
* @defgroup CONFFile File Configuration
* @ingroup CONFXResources
*
* Loads the configuration from a config file that uses the XResource file format.
*
2016-01-07 07:54:24 +00:00
* @defgroup CONFIGURATION Configuration
*
* This provides rofi configuration system, supports:
* * Compiled defaults.
* * XResource parsing
* * Config file parsing
* * Commandline options.
*
* @{
*/
/**
2016-10-14 14:46:54 +00:00
* Type of the config options.
*/
typedef enum
{
/** Config option is string */
xrm_String = 0,
/** Config option is an unsigned number */
xrm_Number = 1,
/** Config option is a signed number */
xrm_SNumber = 2,
/** Config option is a boolean (true/false) value*/
xrm_Boolean = 3,
/** Config option is a character */
xrm_Char = 4
} XrmOptionType;
2014-05-27 06:31:59 +00:00
/**
2016-07-29 06:32:34 +00:00
* @param xcb Handler object holding connection used to fetch the settings from.
2014-05-27 06:31:59 +00:00
*
* Parse the rofi related X resource options of the
* connected X server.
2016-01-07 12:32:33 +00:00
*
* @ingroup CONFXServer
2014-05-27 06:31:59 +00:00
*/
2016-03-01 17:11:55 +00:00
void config_parse_xresource_options ( xcb_stuff *xcb );
2016-01-07 12:32:33 +00:00
/**
2016-10-15 13:39:08 +00:00
* @param filename The xresources file to parse
*
* Parses filename and updates the config
2016-01-07 12:32:33 +00:00
* @ingroup CONFFile
*/
void config_parse_xresource_options_file ( const char *filename );
/**
* Parse commandline options.
2016-01-07 12:32:33 +00:00
* @ingroup CONFCommandline
*/
2015-03-11 17:32:37 +00:00
void config_parse_cmd_options ( void );
2016-01-07 12:32:33 +00:00
2014-05-27 06:31:59 +00:00
/**
* Free any allocated memory.
2016-01-07 12:32:33 +00:00
*
* @ingroup CONFXResources
2014-05-27 06:31:59 +00:00
*/
2015-02-03 07:21:59 +00:00
void config_xresource_free ( void );
2014-05-22 19:56:57 +00:00
2014-05-27 06:31:59 +00:00
/**
* Dump the settings in a Xresources compatible way to
* stdout.
2016-01-07 12:32:33 +00:00
*
* @ingroup CONFXResources
*/
void config_parse_xresource_dump ( void );
/**
2016-01-07 12:32:33 +00:00
* @param type The type of the value
2017-11-23 17:41:52 +00:00
* @param key The key referring to this configuration option
2016-01-07 12:32:33 +00:00
* @param value The value to update based [out][in]
2016-07-29 06:32:34 +00:00
* @param comment Description of this configuration option
2016-01-07 12:32:33 +00:00
*
* Add option (at runtime) to the dynamic option parser.
*/
2015-10-16 06:42:01 +00:00
void config_parser_add_option ( XrmOptionType type, const char *key, void **value, const char *comment );
2016-01-07 12:32:33 +00:00
/**
* Print the current configuration to stdout. Uses bold/italic when printing to terminal.
*/
void print_options ( void );
2016-01-07 12:32:33 +00:00
/**
* @param option The name of the option
* @param type String describing the type
* @param text Description of the option
* @param def Current value of the option
* @param isatty If printed to a terminal
*
* Function that does the markup for printing an configuration option to stdout.
*/
2015-11-14 18:59:56 +00:00
void print_help_msg ( const char *option, const char *type, const char*text, const char *def, int isatty );
2016-01-07 07:54:24 +00:00
/**
* @param length the length of the returned array
*
* Creates an array with a strings describing each keybinding.
*
* @returns an array of string with length elements
*/
char ** config_parser_return_display_help ( unsigned int *length );
/**
* @brief Set config option.
*
* Sets both the static as dynamic config option.
*
* @param p Property to set
* @param error Error msg when not found.
*
* @returns true when failed to set property.
*/
gboolean config_parse_set_property ( const Property *p, char **error );
2017-06-21 06:19:47 +00:00
/**
* @param out The destination.
* @param changes Only print the changed options.
*
2017-06-21 06:19:47 +00:00
* @brief Dump configuration in rasi format.
*/
void config_parse_dump_config_rasi_format ( FILE *out, gboolean changes );
2020-10-12 19:39:36 +00:00
/** @}*/
#endif