commands.h 4.41 KB
Newer Older
Moritz Lipp's avatar
Moritz Lipp committed
1 2
/* See LICENSE file for license and copyright information */

3 4 5
#ifndef COMMANDS_H
#define COMMANDS_H

Moritz Lipp's avatar
Moritz Lipp committed
6
#include <stdbool.h>
7
#include <girara/types.h>
Moritz Lipp's avatar
Moritz Lipp committed
8

Moritz Lipp's avatar
Moritz Lipp committed
9 10 11 12
/**
 * Create a bookmark
 *
 * @param session The used girara session
Moritz Lipp's avatar
Moritz Lipp committed
13
 * @param argument_list List of passed arguments
Moritz Lipp's avatar
Moritz Lipp committed
14 15
 * @return true if no error occured
 */
Moritz Lipp's avatar
Moritz Lipp committed
16
bool cmd_bookmark_create(girara_session_t* session, girara_list_t* argument_list);
Moritz Lipp's avatar
Moritz Lipp committed
17 18 19 20 21

/**
 * Delete a bookmark
 *
 * @param session The used girara session
Moritz Lipp's avatar
Moritz Lipp committed
22
 * @param argument_list List of passed arguments
Moritz Lipp's avatar
Moritz Lipp committed
23 24
 * @return true if no error occured
 */
Moritz Lipp's avatar
Moritz Lipp committed
25
bool cmd_bookmark_delete(girara_session_t* session, girara_list_t* argument_list);
Moritz Lipp's avatar
Moritz Lipp committed
26 27 28 29 30

/**
 * Open a bookmark
 *
 * @param session The used girara session
Moritz Lipp's avatar
Moritz Lipp committed
31
 * @param argument_list List of passed arguments
Moritz Lipp's avatar
Moritz Lipp committed
32 33
 * @return true if no error occured
 */
Moritz Lipp's avatar
Moritz Lipp committed
34
bool cmd_bookmark_open(girara_session_t* session, girara_list_t* argument_list);
Moritz Lipp's avatar
Moritz Lipp committed
35 36 37 38 39

/**
 * Close zathura
 *
 * @param session The used girara session
Moritz Lipp's avatar
Moritz Lipp committed
40
 * @param argument_list List of passed arguments
Moritz Lipp's avatar
Moritz Lipp committed
41 42
 * @return true if no error occured
 */
Moritz Lipp's avatar
Moritz Lipp committed
43
bool cmd_close(girara_session_t* session, girara_list_t* argument_list);
Moritz Lipp's avatar
Moritz Lipp committed
44 45 46 47 48

/**
 * Display document information
 *
 * @param session The used girara session
Moritz Lipp's avatar
Moritz Lipp committed
49
 * @param argument_list List of passed arguments
Moritz Lipp's avatar
Moritz Lipp committed
50 51
 * @return true if no error occured
 */
Moritz Lipp's avatar
Moritz Lipp committed
52
bool cmd_info(girara_session_t* session, girara_list_t* argument_list);
53 54 55 56 57 58 59 60 61

/**
 * Display help
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_help(girara_session_t* session, girara_list_t* argument_list);
Moritz Lipp's avatar
Moritz Lipp committed
62

63 64 65 66 67 68 69 70 71
/**
 * Shows current search results
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_hlsearch(girara_session_t* session, girara_list_t* argument_list);

72 73 74 75 76 77 78 79 80
/**
 * Opens a document file
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_open(girara_session_t* session, girara_list_t* argument_list);

Moritz Lipp's avatar
Moritz Lipp committed
81 82 83 84
/**
 * Print the current file
 *
 * @param session The used girara session
Moritz Lipp's avatar
Moritz Lipp committed
85
 * @param argument_list List of passed arguments
Moritz Lipp's avatar
Moritz Lipp committed
86 87
 * @return true if no error occured
 */
Moritz Lipp's avatar
Moritz Lipp committed
88
bool cmd_print(girara_session_t* session, girara_list_t* argument_list);
Moritz Lipp's avatar
Moritz Lipp committed
89

90 91 92 93 94 95 96 97 98
/**
 * Hides current search results
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_nohlsearch(girara_session_t* session, girara_list_t* argument_list);

Moritz Lipp's avatar
Moritz Lipp committed
99 100 101 102 103 104 105 106 107
/**
 * Close zathura
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_quit(girara_session_t* session, girara_list_t* argument_list);

Moritz Lipp's avatar
Moritz Lipp committed
108 109 110 111
/**
 * Save the current file
 *
 * @param session The used girara session
Moritz Lipp's avatar
Moritz Lipp committed
112
 * @param argument_list List of passed arguments
Moritz Lipp's avatar
Moritz Lipp committed
113 114
 * @return true if no error occured
 */
Moritz Lipp's avatar
Moritz Lipp committed
115
bool cmd_save(girara_session_t* session, girara_list_t* argument_list);
116

117 118 119 120 121 122 123 124 125
/**
 * Save the current file and overwrite existing files
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_savef(girara_session_t* session, girara_list_t* argument_list);

Moritz Lipp's avatar
Moritz Lipp committed
126 127 128 129 130 131 132 133
/**
 * Search the current file
 *
 * @param session The used girara session
 * @param input The current input
 * @param argument Passed argument
 * @return true if no error occured
 */
Sebastian Ramacher's avatar
Sebastian Ramacher committed
134
bool cmd_search(girara_session_t* session, const char* input, girara_argument_t* argument);
135

Sebastian Ramacher's avatar
Sebastian Ramacher committed
136 137 138 139 140 141 142 143 144
/**
 * Save attachment to a file
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_export(girara_session_t* session, girara_list_t* argument_list);

Moritz Lipp's avatar
Moritz Lipp committed
145 146 147 148 149 150 151 152 153
/**
 * Execute command
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_exec(girara_session_t* session, girara_list_t* argument_list);

154 155 156 157 158 159 160 161 162
/**
 * Set page offset
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_offset(girara_session_t* session, girara_list_t* argument_list);

Moritz Lipp's avatar
Moritz Lipp committed
163 164 165 166 167 168 169 170 171
/**
 * Shows version information
 *
 * @param session The used girara session
 * @param argument_list List of passed arguments
 * @return true if no error occured
 */
bool cmd_version(girara_session_t* session, girara_list_t* argument_list);

172
#endif // COMMANDS_H