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 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
|
/****************************************************************************
* bfs *
* Copyright (C) 2015-2018 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 expression tree representation.
*/
#ifndef BFS_EXPR_H
#define BFS_EXPR_H
#include "color.h"
#include "exec.h"
#include "printf.h"
#include "stat.h"
#include <regex.h>
#include <stdbool.h>
#include <stddef.h>
#include <sys/types.h>
#include <time.h>
/**
* A command line expression.
*/
struct expr;
/**
* Ephemeral state for evaluating an expression.
*/
struct eval_state;
/**
* Expression evaluation function.
*
* @param expr
* The current expression.
* @param state
* The current evaluation state.
* @return
* The result of the test.
*/
typedef bool eval_fn(const struct expr *expr, struct eval_state *state);
/**
* Possible types of numeric comparison.
*/
enum cmp_flag {
/** Exactly n. */
CMP_EXACT,
/** Less than n. */
CMP_LESS,
/** Greater than n. */
CMP_GREATER,
};
/**
* Possible types of mode comparison.
*/
enum mode_cmp {
/** Mode is an exact match (MODE). */
MODE_EXACT,
/** Mode has all these bits (-MODE). */
MODE_ALL,
/** Mode has any of these bits (/MODE). */
MODE_ANY,
};
/**
* Possible time units.
*/
enum time_unit {
/** Minutes. */
MINUTES,
/** Days. */
DAYS,
};
/**
* Possible file size units.
*/
enum size_unit {
/** 512-byte blocks. */
SIZE_BLOCKS,
/** Single bytes. */
SIZE_BYTES,
/** Two-byte words. */
SIZE_WORDS,
/** Kibibytes. */
SIZE_KB,
/** Mebibytes. */
SIZE_MB,
/** Gibibytes. */
SIZE_GB,
/** Tebibytes. */
SIZE_TB,
/** Pebibytes. */
SIZE_PB,
};
struct expr {
/** The function that evaluates this expression. */
eval_fn *eval;
/** The left hand side of the expression. */
struct expr *lhs;
/** The right hand side of the expression. */
struct expr *rhs;
/** Whether this expression has no side effects. */
bool pure;
/** Whether this expression always evaluates to true. */
bool always_true;
/** Whether this expression always evaluates to false. */
bool always_false;
/** Estimated cost. */
double cost;
/** Estimated probability of success. */
double probability;
/** Number of times this predicate was executed. */
size_t evaluations;
/** Number of times this predicate succeeded. */
size_t successes;
/** Total time spent running this predicate. */
struct timespec elapsed;
/** The number of command line arguments for this expression. */
size_t argc;
/** The command line arguments comprising this expression. */
char **argv;
/** The optional comparison flag. */
enum cmp_flag cmp_flag;
/** The mode comparison flag. */
enum mode_cmp mode_cmp;
/** Mode to use for files. */
mode_t file_mode;
/** Mode to use for directories (different due to X). */
mode_t dir_mode;
/** The optional stat field to look at. */
enum bfs_stat_field stat_field;
/** The optional reference time. */
struct timespec reftime;
/** The optional time unit. */
enum time_unit time_unit;
/** The optional size unit. */
enum size_unit size_unit;
/** Optional device number for a target file. */
dev_t dev;
/** Optional inode number for a target file. */
ino_t ino;
/** File to output to. */
CFILE *cfile;
/** Optional compiled regex. */
regex_t *regex;
/** Optional exec command. */
struct bfs_exec *execbuf;
/** Optional printf command. */
struct bfs_printf *printf;
/** Optional integer data for this expression. */
long long idata;
/** Optional string data for this expression. */
const char *sdata;
/** The number of files this expression keeps open between evaluations. */
int persistent_fds;
/** The number of files this expression opens during evaluation. */
int ephemeral_fds;
};
/** Singleton true expression instance. */
extern struct expr expr_true;
/** Singleton false expression instance. */
extern struct expr expr_false;
/**
* Create a new expression.
*/
struct expr *new_expr(eval_fn *eval, size_t argc, char **argv);
/**
* @return Whether expr is known to always quit.
*/
bool expr_never_returns(const struct expr *expr);
/**
* @return The result of the comparison for this expression.
*/
bool expr_cmp(const struct expr *expr, long long n);
/**
* Dump a parsed expression.
*/
void dump_expr(CFILE *cfile, const struct expr *expr, bool verbose);
/**
* Free an expression tree.
*/
void free_expr(struct expr *expr);
#endif // BFS_EXPR_H
|