(* This file is part of the Catala compiler, a specification language for tax and social benefits computation rules. Copyright (C) 2020 Inria, contributors: Denis Merigoux , Emile Rolley 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 modules weaves the source code and the legislative text together into a document that law professionals can understand. *) open Catala_utils open Literate_common module A = Surface.Ast module P = Printf module R = Re.Pcre module C = Global (** {1 Helpers} *) (** Converts double lines into HTML newlines. *) let pre_html (s : string) = String.trim (run_pandoc s `Html) (** Partial application allowing to remove first code lines of [] and [] generated HTML. Basically, remove all code block first lines. *) let remove_cb_first_lines : string -> string = R.substitute ~rex:(R.regexp "
.*\n") ~subst:(function _ -> "
\n")

(** Partial application allowing to remove last code lines of
    [] and [] generated HTML. Basically,
    remove all code block last lines. *)
let remove_cb_last_lines : string -> string =
  R.substitute ~rex:(R.regexp "<.*\n*
") ~subst:(function _ -> "
") (** Usage: [wrap_html source_files custom_pygments language fmt wrapped] Prints an HTML complete page structure around the [wrapped] content. *) let wrap_html (source_files : string list) (language : Global.backend_lang) (fmt : Format.formatter) (wrapped : Format.formatter -> unit) : unit = let css_as_string = call_pygmentize ["-f"; "html"; "-S"; "default"; "-a"; ".catala-code"] in Format.fprintf fmt "\n\ \n\ \n\ \n\ \n\ \n\ \n\

%s
\n\ %s Catala version %s\n\

\n\ %s\n\

\n\ %s:\n\

\n\ \n" css_as_string (literal_title language) (literal_generated_by language) Cli.version (pre_html (literal_disclaimer_and_link language)) (literal_source_files language) (String.concat "\n" (List.map (fun filename -> let mtime = (Unix.stat filename).Unix.st_mtime in let ltime = Unix.localtime mtime in let ftime = Printf.sprintf "%d-%02d-%02d, %d:%02d" (1900 + ltime.Unix.tm_year) (ltime.Unix.tm_mon + 1) ltime.Unix.tm_mday ltime.Unix.tm_hour ltime.Unix.tm_min in Printf.sprintf "
  • %s, %s %s
    • " (Filename.basename filename) (literal_last_modification language) ftime) source_files)); wrapped fmt; Format.fprintf fmt "\n\n" (** Performs syntax highlighting on a piece of code by using Pygments and the special Catala lexer. *) let pygmentize_code (c : string Mark.pos) (lang : C.backend_lang) : string = Message.debug "Pygmenting the code chunk %s" (Pos.to_string (Mark.get c)); let output = File.with_temp_file "catala_html_pygments" "in" ~contents:(Mark.remove c) @@ fun temp_file_in -> call_pygmentize ~lang [ "-f"; "html"; "-O"; "anchorlinenos=True,lineanchors=" ^ String.to_ascii (Pos.get_file (Mark.get c)) ^ ",linenos=table,linenostart=" ^ string_of_int (Pos.get_start_line (Mark.get c)); temp_file_in; ] in (* Remove code blocks delimiters needed by [Pygments]. *) let trimmed_output = output |> remove_cb_first_lines |> remove_cb_last_lines in trimmed_output (** {1 Weaving} *) let sanitize_html_href str = str |> String.to_ascii |> R.substitute ~rex:(R.regexp "[' '°\"]") ~subst:(function _ -> "%20") let rec law_structure_to_html (language : C.backend_lang) (print_only_law : bool) (parents_headings : string list) (fmt : Format.formatter) (i : A.law_structure) : unit = match i with | A.LawText t -> let t = pre_html t in if t = "" then () else Format.fprintf fmt "
    %s
    " t | A.CodeBlock (_, c, metadata) when not print_only_law -> let start_line = Pos.get_start_line (Mark.get c) + 1 in let filename = Pos.get_file (Mark.get c) in let block_content = Mark.remove c in check_exceeding_lines start_line filename block_content; Format.fprintf fmt "
    \n\
    %s
    \n\ %s\n\
    " (if metadata then " code-metadata" else "") (Pos.get_file (Mark.get c)) (pygmentize_code (Mark.copy c ("```catala\n" ^ Mark.remove c ^ "```")) language) | A.CodeBlock _ -> () | A.LawHeading (heading, children) -> let h_number = heading.law_heading_precedence + 1 in let is_a_section_to_collapse = (* Only 2 depth sections are collasped in a
    tag. Indeed, this allow to significantly reduce rendering time (~= 100x for the [aides_logement] example in the catala-website), while remaining practicable. *) h_number = 2 in let h_name = Mark.remove heading.law_heading_name in let complete_headings = parents_headings @ [h_name] in let id = complete_headings |> String.concat "-" |> sanitize_html_href in let fmt_details_open fmt () = if is_a_section_to_collapse then Format.fprintf fmt "
    %s" h_name in let fmt_details_close fmt () = if is_a_section_to_collapse then Format.fprintf fmt "
    " in Format.fprintf fmt "%s%s@\n\ %a\n\ %a\n\ %a" h_number id id h_name (match heading.law_heading_id, language with | Some id, Fr -> ( try P.sprintf "Voir le texte sur Légifrance.gouv.fr" (if String.starts_with ~prefix:"LEGIARTI" id then "codes" else if String.starts_with ~prefix:"JORFARTI" id then "jorf" else if String.starts_with ~prefix:"CETATEXT" id then "ceta" else raise Not_found) id with Not_found -> "") | _ -> "") h_number fmt_details_open () (Format.pp_print_list ~pp_sep:(fun fmt () -> Format.fprintf fmt "\n") (law_structure_to_html language print_only_law complete_headings)) children fmt_details_close () | A.LawInclude _ -> () | A.ModuleDef _ | A.ModuleUse _ -> () (* TODO: show somehow ?*) let rec fmt_toc (parents_headings : string list) fmt (items : A.law_structure list) = Format.fprintf fmt "@[
      @\n%a@\n@]
    " (List.length parents_headings) (Format.pp_print_list ~pp_sep:(fun fmt () -> Format.fprintf fmt "@\n") (fun fmt item -> match item with | A.LawHeading (heading, childs) -> let h_name = Mark.remove heading.law_heading_name in let complete_headings = parents_headings @ [h_name] in let id = complete_headings |> String.concat "-" |> sanitize_html_href in Format.fprintf fmt "@[
  • @\n\ @[
    @\n\ %s@\n\ %a@\n\ @]
    @\n\ @]
    • " id h_name (fmt_toc complete_headings) childs | _ -> ())) (items |> List.filter (function A.LawHeading (_, _) -> true | _ -> false)) (** {1 API} *) let ast_to_html (language : C.backend_lang) ~(print_only_law : bool) (fmt : Format.formatter) (program : A.program) : unit = let toc = match language with | C.Fr -> "Sommaire" | C.En -> "Table of contents" | C.Pl -> "Spis treści." in Format.fprintf fmt "@[
    @\n\ %s@\n\ %a@\n\ @]
    \n\ %a@\n" toc (fmt_toc []) program.program_items (Format.pp_print_list ~pp_sep:(fun fmt () -> Format.fprintf fmt "\n\n") (fun fmt -> Format.fprintf fmt "%a" (law_structure_to_html language print_only_law []))) program.program_items