X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=lib%2Fwhenexpr.mli;h=c84f0919631dba572bf6770428b9b142c658340b;hb=1d0b030e3a62a905dce16d05e8816cb3da8c49eb;hp=c0c6fb2a9440fab77ef3e36f66d2aee8062b1b32;hpb=108dd86b36e82df2a2029dbd12700f9c83e501c1;p=whenjobs.git diff --git a/lib/whenexpr.mli b/lib/whenexpr.mli index c0c6fb2..c84f091 100644 --- a/lib/whenexpr.mli +++ b/lib/whenexpr.mli @@ -33,12 +33,14 @@ type whenexpr = | Expr_eq of whenexpr * whenexpr (** == *) | Expr_ge of whenexpr * whenexpr (** >= *) | Expr_gt of whenexpr * whenexpr (** > *) + | Expr_ne of whenexpr * whenexpr (** != *) | Expr_not of whenexpr (** boolean not *) | Expr_add of whenexpr * whenexpr (** arithmetic addition or string cat *) | Expr_sub of whenexpr * whenexpr (** arithmetic subtraction *) | Expr_mul of whenexpr * whenexpr (** arithmetic multiplication *) | Expr_div of whenexpr * whenexpr (** arithmetic division *) | Expr_mod of whenexpr * whenexpr (** arithmetic modulo *) + | Expr_len of whenexpr (** length *) | Expr_changes of string (** changes var *) | Expr_increases of string (** increases var *) | Expr_decreases of string (** decreases var *) @@ -75,6 +77,34 @@ val rpc_of_variable : variable -> Whenproto_aux.variable type variables = variable Whenutils.StringMap.t (** A set of variables. *) +type preinfo = { + pi_job_name : string; (** Job name. *) + pi_serial : Big_int.big_int; (** Job serial number. *) + pi_variables : (string * variable) list; (** Variables set in job. *) + pi_running : preinfo_running_job list; (** List of running jobs. *) +} +and preinfo_running_job = { + pirun_job_name : string; (** Running job name. *) + pirun_serial : Big_int.big_int; (** Running job serial number. *) + pirun_start_time : float; (** Running job start time. *) + pirun_pid : int; (** Running job process ID. *) +} +(** Information available to pre function before the job runs. *) + +type result = { + res_job_name : string; (** Job name. *) + res_serial : Big_int.big_int; (** Job serial number. *) + res_code : int; (** Return code from the script. *) + res_tmpdir : string; (** Temporary directory. *) + res_output : string; (** Filename of output from job. *) + res_start_time : float; (** When the job started. *) +} +(** Result of the run of a job. *) + +type pre = preinfo -> bool +type post = result -> unit +(** Pre and post functions. *) + type job_cond = | When_job of whenexpr (** when ... : << >> *) | Every_job of periodexpr (** every ... : << >> *) @@ -82,6 +112,8 @@ type job_cond = type job = { job_loc : Camlp4.PreCast.Loc.t; job_name : string; + job_pre : pre option; + job_post : post option; job_cond : job_cond; job_script : shell_script; } @@ -160,3 +192,7 @@ val next_periodexpr : float -> periodexpr -> float midnight UTC on the 1st day of the year when [(y - 1970) mod i == 0]. This returns midnight on the 1st day of the next year > t. *) + +val check_valid_variable_name : string -> unit +(** Check that [name] is a valid variable name that users are permitted + to set, and raise [Failure] if it is not. *)