marks.h 1.43 KB
Newer Older
1
/* SPDX-License-Identifier: Zlib */
Moritz Lipp's avatar
Moritz Lipp committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

#ifndef MARKS_H
#define MARKS_H

#include <girara/types.h>

#include "zathura.h"

typedef struct zathura_mark_s zathura_mark_t;

/**
 * Saves a mark
 *
 * @param session The used girara session
 * @param argument The used argument
 * @param event Girara event
 * @param t Number of executions
19
 * @return true if no error occurred otherwise false
Moritz Lipp's avatar
Moritz Lipp committed
20 21 22 23 24 25 26 27 28 29 30
 */
bool sc_mark_add(girara_session_t* session, girara_argument_t* argument,
    girara_event_t* event, unsigned int t);

/**
 * Evaluates a mark
 *
 * @param session The used girara session
 * @param argument The used argument
 * @param event Girara event
 * @param t Number of executions
31
 * @return true if no error occurred otherwise false
Moritz Lipp's avatar
Moritz Lipp committed
32 33 34 35 36 37 38 39 40
 */
bool sc_mark_evaluate(girara_session_t* session, girara_argument_t* argument,
    girara_event_t* event, unsigned int t);

/**
 * Mark current location within the web page
 *
 * @param session The girara session
 * @param argument_list Argument list
41
 * @return true if no error occurred otherwise false
Moritz Lipp's avatar
Moritz Lipp committed
42 43 44 45 46 47 48 49
 */
bool cmd_marks_add(girara_session_t* session, girara_list_t* argument_list);

/**
 * Delete the specified marks
 *
 * @param session The girara session
 * @param argument_list Argument list
50
 * @return true if no error occurred otherwise false
Moritz Lipp's avatar
Moritz Lipp committed
51 52 53 54 55 56 57 58 59 60 61
 */
bool cmd_marks_delete(girara_session_t* session, girara_list_t* argument_list);

/**
 * Free function vor marks
 *
 * @param data
 */
void mark_free(void* data);

#endif // MARKS_H