SExp

Object Hierarchy:

[ CCode ( type_id = "camel_sexp_get_type ()" ) ]
[ Version ( since = "3.4" ) ]
public class SExp : Object

S-expression matching functions for message filtering.

SExp implements the s-expression matching functions used by FilterDriver to evaluate filter rules against messages.

Match expressions operate on a single message and return a boolean. Available matching functions include:

`(body-contains string …)` — matches if the message body contains any of the given strings (searches text/… parts with tag-stripping for HTML).
`(header-contains header string …)` / `(header-matches …)` / `(header-starts-with …)` / `(header-ends-with …)` — header matching.
`(header-exists header)` — tests whether a header is present.
`(match-all expression)` — evaluates a boolean against all messages.
`(user-flag flag)` / `(user-tag tag value)` — user metadata matching.
`(system-flag flag)` — system flag matching (seen, deleted, flagged, etc.).
`(pipe-message cmd)` — runs the message through an external program whose exit code determines the match result.

list = (and list*) perform an intersection of a number of lists, and return that.

bool = (and bool*) perform a boolean AND of boolean values.

list = (or list*) perform a union of a number of lists, returning the new list.

bool = (or bool*) perform a boolean OR of boolean values.

gint = (+ int*) Add integers.

string = (+ string*) Concat strings.

time_t = (+ time_t*) Add time_t values.

gint = (- gint int*) Subtract integers from the first.

time_t = (- time_t*) Subtract time_t values from the first.

gint = (cast-int string|int|bool) Cast to an integer value.

string = (cast-string string|int|bool) Cast to a string value.

bool = (< gint gint) bool = (> gint gint) bool = (= gint gint)

bool = (< string string) bool = (> string string) bool = (= string string)

bool = (< time_t time_t) bool = (> time_t time_t) bool = (= time_t time_t) Perform a comparison of 2 integers, 2 string values, or 2 time values.

type = (if bool function) type = (if bool function function) Choose a flow path based on a boolean value

type = (begin func func func) Execute a sequence. The last function return is the return type.

Namespace: Camel

Package: camel-1.2

public static void encode_bool (StringBuilder string, bool v_bool)
Encode a bool into an s-expression string.
public static void encode_string (StringBuilder string, string v_string)
Add a c string v_string to the s-expression stored in the gstring s.

public void add_function (uint scope, string name, SExpFunc func)
Adds a function symbol which can not perform short evaluation.
public void add_ifunction (uint scope, string name, SExpIFunc ifunc)
Adds a function symbol which can perform short evaluation, or doesn't execute everything.
public void add_variable (uint scope, string name, SExpTerm value)
Adds a variable named name to the given scope, set to the given value.
public unowned string? error ()
public unowned SExpResult? eval ()
public bool evaluate_occur_times (time_t start, time_t end)
public void fatal_error (string why, ...)
Sets an error from the given format and stops execution.
public void input_file (int fd)
Prepares to scan a file.
public void input_text (string text, int len)
Prepares to scan a text buffer.
public int parse ()
public unowned SExpTerm? parse_value ()
public void remove_symbol (uint scope, string name)
Revoes a symbol from a scope.
public void result_free (SExpResult? result)
Frees the result and its internal data.
public SExpResult? result_new (int type)
public void resultv_free (SExpResult[] argv)
Frees an array of results.
public int set_scope (uint scope)
sets the current scope for the scanner.
public SExpResult? term_eval (SExpTerm term)
Evaluates a part of the expression.

All known members inherited from class GLib.Object