package catala

  1. Overview
  2. Docs
Compiler and library for the literate programming language for tax code specification

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (13)

Authors

  1. V
    Vincent Botbol
  2. N
    Nicolas Chataing
  3. A
    Alain Delaët-Tixeuil
  4. L
    Louis Gesbert
  5. A
    Aymeric Fromherz
  6. D
    Denis Merigoux
  7. R
    Raphaël Monat
  8. R
    Romain Primet
  9. E
    Emile Rolley

Maintainers

  1. C
    contact@catala-lang.org

Sources

1.1.0.tar.gz
md5=ec7dda88c5f7f371d2a35874cdae2a10
sha512=7cedccfbe5330992d5730441d6ba7b97446237ff5bb4579498a167f2319ec03e8fae50b7f80e3abe96833744b61ffd10719ce0c3e4c144893a4b7adc77e91b56

doc/catala.shared_ast/Shared_ast/Coverage/index.html

Module Shared_ast.CoverageSource

More efficient File map module

Sourcemodule ScopeSet : sig ... end

More efficient ScopeName set module

Sourcetype cover =
  1. | Unreached
  2. | Reached_by of {
    1. scopes : ScopeSet.t;
    }

A position can either be Unreached or Reached_by a set of test scopes.

Sourceval format_cover : Format.formatter -> cover -> unit
Sourcetype itv = private {
  1. start_line : int;
  2. start_col : int;
  3. end_line : int;
  4. end_col : int;
}
Sourceval from_pos : Catala_utils.Pos.t -> itv
Sourceval format_itv : Format.formatter -> itv -> unit
Sourcetype coverage_map
Sourceval empty : coverage_map
Sourceval reached_pos : Catala_utils.Pos.t -> Shared_ast__.Definitions.ScopeName.t -> coverage_map -> coverage_map

reached_pos p s m marks the position p as reached by the scope s in the map m. Merge scopes if the position was already reached by another scope.

unreached_pos p m marks the position p as unreached in the map m. Does not overwrite the existing cover.

Sourceval reachable_positions : ((_, _, _) Shared_ast__.Definitions.base_gexpr, _ Shared_ast__.Definitions.mark) Catala_utils.Mark.ed Shared_ast__.Definitions.program -> coverage_map

reachable_positions prg iterates over the program p's expressions to build a Unreached only coverage_map.

Sourceval merge_with_reachable_positions : reachable:coverage_map -> reached:coverage_map -> coverage_map

merge_with_reachable_positions ~reachable ~reached computes the union between reachable and reached but filter out files that do not contain reached positions. When a conflict occurs, the cover are merged, i.e., scopes are merged together.

Sourceval filter_files : (Catala_utils.File.t -> bool) -> coverage_map -> coverage_map

filter_files p m removes the files from the coverage map that do not satisfy the predicate p. Used to filter out the stdlib.

Sourceval fold : ((Catala_utils.File.t * itv) -> cover -> 'a -> 'a) -> coverage_map -> 'a -> 'a
Sourceval format_coverage_hex_dump : Format.formatter -> coverage_map -> unit

Marshal the coverage map and prints it as hexadecimal.

Sourceval of_hex : string -> coverage_map

Unmarshal the coverage map from an hexadecimal string.

Sourcetype interval_tree = interval_node list

n-ary tree that modelize the coverage of a file. Every node's sub-trees are comprised in their parent wrt. their interval. This is the structure that should be exported.

Sourceand interval_node = {
  1. itv : itv;
  2. cover : cover;
  3. children : interval_tree;
}
Sourceval compute_interval_trees : coverage_map -> interval_tree FileMap.t

Build and normalize a coverage map into an interval tree.

Sourceval all_scopes : interval_tree -> ScopeSet.t

all_scopes itvt iterates over the interval tree itvt and returns the union of all scopes that produced a Reached_by cover.

Sourceval format_interval_tree : Format.formatter -> interval_tree -> unit