catala/build_system/clerk_scan.mli
Louis Gesbert 4cec981f62 Move global options of Cli to their own module
This resolves a dependency cycle that would forbid `Cli` from using the modue
`File`, which was annoying.
2024-03-19 15:18:35 +01:00

62 lines
2.4 KiB
OCaml

(* This file is part of the Catala build system, a specification language for
tax and social benefits computation rules. Copyright (C) 2020 Inria,
contributors: Louis Gesbert <louis.gesbert@inria.fr>
Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License. *)
(** This module is responsible for scanning Catala files, extracting dependency
and test information. It is based on the lightweight "line-parser"
([Surface.Parser_driver.line]) *)
open Catala_utils
type expected_output_descr = {
tested_filename : string; (** Name of the file that's being tested *)
output_dir : string;
(** Name of the output directory where all expected outputs are stored *)
id : string;
(** Id of this precise unit test that will be associated to an expected
output *)
cmd : string list;
(** Catala command to launch to run the test, excluding "catala" at the
begin, and the name of the file to test *)
}
(** Structure describing a single "legacy test", ie test with a separate output
file *)
type item = {
file_name : File.t;
module_def : string option;
extrnal : bool;
used_modules : string list;
included_files : File.t list;
legacy_tests : expected_output_descr list;
has_inline_tests : bool;
}
(** Contains all the data extracted from a single Catala file. Lists are in
reverse file order. *)
val get_lang : File.t -> Global.backend_lang option
(** Guesses Catala dialect from file-name and global options *)
val catala_file : File.t -> Global.backend_lang -> item
(** Scans a single Catala file into an item *)
val tree : File.t -> (File.t * File.t list * item list) Seq.t
(** Recursively scans a directory, and returns the corresponding subdirectories
and items in sequence, by directory. *)
val test_command_args : string -> string option
(** Parses a test command-line (in the form "$ catala <args>") and returns the
arguments as a string, or [None] if there is no match *)