rofi/include/helper.h

162 lines
4.1 KiB
C

#ifndef ROFI_HELPER_H
#define ROFI_HELPER_H
#include "rofi.h"
#include <pango/pango.h>
/**
* @defgroup HELPERS Helpers
*/
/**
* @defgroup HELPER Helper
* @ingroup HELPERS
*
* @{
*/
/**
* @param string The input string.
* @param output Pointer to 2 dimensional array with parsed string.
* @param length Length of 2 dimensional array.
* @param ... Key, value parse. Replaces the string Key with value.
*
* Parses a string into arguments. While replacing keys with values.
*
* @returns TRUE when successful, FALSE when failed.
*/
int helper_parse_setup ( char * string, char ***output, int *length, ... );
/**
* @param input The input string.
* @param case_sensitive Whether case is significant.
*
* Tokenize the string on spaces.
*
* @returns a newly allocated 2 dimensional array of strings.
*/
GRegex **tokenize ( const char *input, int case_sensitive );
void tokenize_free ( GRegex ** tokens );
/**
* @param key The key to search for
* @param val Pointer to the string to set to the key value (if found)
*
* Parse command line argument 'key' to character.
* This one supports character escaping.
*
* @returns TRUE if key was found and val was set.
*/
int find_arg_char ( const char * const key, char *val );
/**
* @param key The key to search for
* @param val Pointer to the string to set to the key value (if found)
*
* Parse command line argument 'key' to unsigned int.
*
* @returns TRUE if key was found and val was set.
*/
int find_arg_uint ( const char * const key, unsigned int *val );
/**
* @param key The key to search for
* @param val Pointer to the string to set to the key value (if found)
*
* Parse command line argument 'key' to int.
*
* @returns TRUE if key was found and val was set.
*/
int find_arg_int ( const char * const key, int *val );
/**
* @param key The key to search for
* @param val Pointer to the string to set to the key value (if found)
*
* Parse command line argument 'key' to string.
*
* @returns TRUE if key was found and val was set.
*/
int find_arg_str ( const char * const key, char** val );
/**
* @param key The key to search for
*
* Check if key is passed as argument.
*
* @returns return position of string or -1 if not found.
*/
int find_arg ( const char * const key );
/**
* @param tokens List of (input) tokens to match.
* @param input The entry to match against.
*
* Tokenized match, match tokens to line input.
*
* @returns TRUE when matches, FALSE otherwise
*/
int token_match ( GRegex * const *tokens, const char *input );
/**
* @param cmd The command to execute.
*
* Execute cmd using config.run_command and outputs the result (stdout) to the opened file
* descriptor.
*
* @returns a valid file descriptor on success, or -1 on failure.
*/
int execute_generator ( const char * cmd ) __attribute__( ( nonnull ) );
/**
* @param pidfile The pidfile to create.
*
* returns file descriptor (or -1 when failed)
*/
int create_pid_file ( const char *pidfile );
/**
* Remove pid file
*/
void remove_pid_file ( int fd );
/**
* Do some input validation, especially the first few could break things.
* It is good to catch them beforehand.
*
* This functions exits the program with 1 when it finds an invalid configuration.
*/
int config_sanity_check ( void );
/**
* @param arg string to parse.
*
* Parses a string into an character.
*
* @returns character.
*/
char helper_parse_char ( const char *arg );
/**
* @param argc number of arguments.
* @param argv Array of arguments.
*
* Set the application arguments.
*/
void cmd_set_arguments ( int argc, char **argv );
/**
* @param input The path to expand
*
* Expand path, both `~` and `~<user>`
*
* @returns path
*/
char *rofi_expand_path ( const char *input );
unsigned int levenshtein ( const char *needle, const char *haystack );
/**
* Convert string to valid utf-8, replacing invalid parts with replacement character.
*/
char * rofi_force_utf8 ( gchar *data, ssize_t length );
char * rofi_latin_to_utf8_strdup ( const char *input, gssize length );
PangoAttrList *token_match_get_pango_attr ( GRegex **tokens, const char *input, PangoAttrList *retv );
/*@}*/
#endif // ROFI_HELPER_H