summaryrefslogtreecommitdiffstats
path: root/src/eval.h
blob: a1bbd2f764b3cf4d58827756fc15a3c21b457e22 (plain)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/****************************************************************************
 * bfs                                                                      *
 * Copyright (C) 2015-2022 Tavian Barnes <tavianator@tavianator.com>        *
 *                                                                          *
 * Permission to use, copy, modify, and/or distribute this software for any *
 * purpose with or without fee is hereby granted.                           *
 *                                                                          *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES *
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF         *
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR  *
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   *
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN    *
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF  *
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.           *
 ****************************************************************************/

/**
 * The evaluation functions that implement literal expressions like -name,
 * -print, etc.
 */

#ifndef BFS_EVAL_H
#define BFS_EVAL_H

#include <stdbool.h>

struct bfs_ctx;
struct bfs_expr;

/**
 * Ephemeral state for evaluating an expression.
 */
struct bfs_eval;

/**
 * Expression evaluation function.
 *
 * @param expr
 *         The current expression.
 * @param state
 *         The current evaluation state.
 * @return
 *         The result of the test.
 */
typedef bool bfs_eval_fn(const struct bfs_expr *expr, struct bfs_eval *state);

/**
 * Evaluate the command line.
 *
 * @param ctx
 *         The bfs context to evaluate.
 * @return
 *         EXIT_SUCCESS on success, otherwise on failure.
 */
int bfs_eval(const struct bfs_ctx *ctx);

// Predicate evaluation functions

bool eval_true(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_false(const struct bfs_expr *expr, struct bfs_eval *state);

bool eval_access(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_acl(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_capable(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_perm(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_xattr(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_xattrname(const struct bfs_expr *expr, struct bfs_eval *state);

bool eval_newer(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_time(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_used(const struct bfs_expr *expr, struct bfs_eval *state);

bool eval_gid(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_uid(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_nogroup(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_nouser(const struct bfs_expr *expr, struct bfs_eval *state);

bool eval_depth(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_empty(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_flags(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_fstype(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_hidden(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_inum(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_links(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_samefile(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_size(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_sparse(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_type(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_xtype(const struct bfs_expr *expr, struct bfs_eval *state);

bool eval_lname(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_name(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_path(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_regex(const struct bfs_expr *expr, struct bfs_eval *state);

bool eval_delete(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_exec(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_exit(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_fls(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_fprint(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_fprint0(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_fprintf(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_fprintx(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_prune(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_quit(const struct bfs_expr *expr, struct bfs_eval *state);

// Operator evaluation functions
bool eval_not(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_and(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_or(const struct bfs_expr *expr, struct bfs_eval *state);
bool eval_comma(const struct bfs_expr *expr, struct bfs_eval *state);

#endif // BFS_EVAL_H