File: script.h

package info (click to toggle)
rofi 2.0.0-0.2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,472 kB
  • sloc: ansic: 36,245; lex: 957; yacc: 920; xml: 858; sh: 384; makefile: 17
file content (74 lines) | stat: -rw-r--r-- 2,177 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*
 * rofi
 *
 * MIT/X11 License
 * Copyright © 2013-2017 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_SCRIPT_H
#define ROFI_MODE_SCRIPT_H

#include "mode.h"

/**
 * @defgroup SCRIPTMode Script
 * @ingroup MODES
 *
 * @{
 */
/**
 * @param str   The input string to parse
 *
 * Parse an argument string into the right ScriptOptions data object.
 * This is off format: \<Name\>:\<Script\>
 *
 * @returns NULL when it fails, a newly allocated ScriptOptions when successful.
 */
Mode *script_mode_parse_setup(const char *str);

/**
 * @param token The modes str to check
 *
 * Check if token could be a valid script modes.
 *
 * @returns true when valid.
 */
gboolean script_mode_is_valid(const char *token);

/**
 * Gather the users scripts from `~/.config/rofi/scripts/`
 */
void script_mode_gather_user_scripts(void);

/**
 * Cleanup memory allocated by `script_mode_gather_user_scripts`
 */
void script_mode_cleanup(void);
/**
 * @param is_term if printed to terminal
 *
 * List the user scripts found.
 */
void script_user_list(gboolean is_term);
/**@}*/
#endif // ROFI_MODE_SCRIPT_H