2020-04-29 10:55:49 +03:00
|
|
|
(* This file is part of the Catala compiler, a specification language for tax
|
2021-05-27 19:56:47 +03:00
|
|
|
and social benefits computation rules. Copyright (C) 2020 Inria,
|
|
|
|
|
contributors: Denis Merigoux <denis.merigoux@inria.fr>, Emile Rolley
|
|
|
|
|
<emile.rolley@tuta.io>
|
2020-04-29 10:55:49 +03:00
|
|
|
|
|
|
|
|
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. *)
|
|
|
|
|
|
2022-11-21 12:46:17 +03:00
|
|
|
open Catala_utils
|
2021-05-26 22:39:40 +03:00
|
|
|
open Literate_common
|
2020-11-23 11:22:47 +03:00
|
|
|
module A = Surface.Ast
|
2020-04-29 10:55:49 +03:00
|
|
|
module P = Printf
|
|
|
|
|
module R = Re.Pcre
|
2024-03-15 16:23:30 +03:00
|
|
|
module C = Global
|
2020-04-29 10:55:49 +03:00
|
|
|
|
2020-12-14 20:09:38 +03:00
|
|
|
(** {1 Helpers} *)
|
|
|
|
|
|
|
|
|
|
(** Converts double lines into HTML newlines. *)
|
2022-05-26 20:05:06 +03:00
|
|
|
let pre_html (s : string) = String.trim (run_pandoc s `Html)
|
2020-04-29 10:55:49 +03:00
|
|
|
|
2021-06-04 14:36:21 +03:00
|
|
|
(** Partial application allowing to remove first code lines of
|
|
|
|
|
[<td class="code">] and [<td class="linenos">] generated HTML. Basically,
|
|
|
|
|
remove all code block first lines. *)
|
|
|
|
|
let remove_cb_first_lines : string -> string =
|
|
|
|
|
R.substitute ~rex:(R.regexp "<pre>.*\n") ~subst:(function _ -> "<pre>\n")
|
|
|
|
|
|
|
|
|
|
(** Partial application allowing to remove last code lines of
|
|
|
|
|
[<td class="code">] and [<td class="linenos">] generated HTML. Basically,
|
|
|
|
|
remove all code block last lines. *)
|
|
|
|
|
let remove_cb_last_lines : string -> string =
|
2021-06-05 17:54:11 +03:00
|
|
|
R.substitute ~rex:(R.regexp "<.*\n*</pre>") ~subst:(function _ -> "</pre>")
|
2021-06-04 13:00:59 +03:00
|
|
|
|
2020-12-14 20:09:38 +03:00
|
|
|
(** Usage: [wrap_html source_files custom_pygments language fmt wrapped]
|
|
|
|
|
|
|
|
|
|
Prints an HTML complete page structure around the [wrapped] content. *)
|
2021-03-02 20:27:39 +03:00
|
|
|
let wrap_html
|
|
|
|
|
(source_files : string list)
|
2024-03-15 16:23:30 +03:00
|
|
|
(language : Global.backend_lang)
|
2021-03-02 20:27:39 +03:00
|
|
|
(fmt : Format.formatter)
|
|
|
|
|
(wrapped : Format.formatter -> unit) : unit =
|
2023-03-13 20:33:15 +03:00
|
|
|
let css_as_string =
|
|
|
|
|
call_pygmentize ["-f"; "html"; "-S"; "default"; "-a"; ".catala-code"]
|
2020-04-29 12:10:56 +03:00
|
|
|
in
|
2020-10-04 02:25:37 +03:00
|
|
|
Format.fprintf fmt
|
2023-03-13 15:40:10 +03:00
|
|
|
"<!DOCTYPE html>\n\
|
|
|
|
|
<html>\n\
|
|
|
|
|
<head>\n\
|
2020-05-05 18:04:53 +03:00
|
|
|
<style>\n\
|
|
|
|
|
%s\n\
|
|
|
|
|
</style>\n\
|
2020-04-29 16:55:50 +03:00
|
|
|
<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>\n\
|
|
|
|
|
</head>\n\
|
2023-03-13 15:40:10 +03:00
|
|
|
<body>\n\
|
2020-04-29 12:10:56 +03:00
|
|
|
<h1>%s<br />\n\
|
2020-04-29 10:55:49 +03:00
|
|
|
<small>%s Catala version %s</small>\n\
|
|
|
|
|
</h1>\n\
|
|
|
|
|
%s\n\
|
2022-05-05 15:00:24 +03:00
|
|
|
<p>\n\
|
|
|
|
|
%s:\n\
|
2020-04-29 10:55:49 +03:00
|
|
|
</p>\n\
|
|
|
|
|
<ul>\n\
|
|
|
|
|
%s\n\
|
2020-10-04 02:25:37 +03:00
|
|
|
</ul>\n"
|
2021-05-26 22:39:40 +03:00
|
|
|
css_as_string (literal_title language)
|
|
|
|
|
(literal_generated_by language)
|
2022-11-21 12:46:17 +03:00
|
|
|
Cli.version
|
2022-05-05 15:00:24 +03:00
|
|
|
(pre_html (literal_disclaimer_and_link language))
|
2021-05-26 22:39:40 +03:00
|
|
|
(literal_source_files language)
|
2020-04-29 10:55:49 +03:00
|
|
|
(String.concat "\n"
|
|
|
|
|
(List.map
|
|
|
|
|
(fun filename ->
|
|
|
|
|
let mtime = (Unix.stat filename).Unix.st_mtime in
|
|
|
|
|
let ltime = Unix.localtime mtime in
|
|
|
|
|
let ftime =
|
2020-05-17 20:20:03 +03:00
|
|
|
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
|
2020-04-29 10:55:49 +03:00
|
|
|
in
|
2020-04-29 12:10:56 +03:00
|
|
|
Printf.sprintf "<li><tt>%s</tt>, %s %s</li>"
|
2022-05-05 15:00:24 +03:00
|
|
|
(Filename.basename filename)
|
2021-05-26 22:39:40 +03:00
|
|
|
(literal_last_modification language)
|
2020-04-29 10:55:49 +03:00
|
|
|
ftime)
|
2020-10-04 02:25:37 +03:00
|
|
|
source_files));
|
2023-03-13 15:40:10 +03:00
|
|
|
wrapped fmt;
|
|
|
|
|
Format.fprintf fmt "</body>\n</html>\n"
|
2020-04-29 10:55:49 +03:00
|
|
|
|
2020-12-14 20:09:38 +03:00
|
|
|
(** Performs syntax highlighting on a piece of code by using Pygments and the
|
|
|
|
|
special Catala lexer. *)
|
2023-05-17 16:44:57 +03:00
|
|
|
let pygmentize_code (c : string Mark.pos) (lang : C.backend_lang) : string =
|
2024-04-10 19:39:30 +03:00
|
|
|
Message.debug "Pygmenting the code chunk %s" (Pos.to_string (Mark.get c));
|
2023-03-13 20:33:15 +03:00
|
|
|
let output =
|
2023-05-17 16:44:57 +03:00
|
|
|
File.with_temp_file "catala_html_pygments" "in" ~contents:(Mark.remove c)
|
2023-03-13 20:33:15 +03:00
|
|
|
@@ fun temp_file_in ->
|
|
|
|
|
call_pygmentize ~lang
|
|
|
|
|
[
|
|
|
|
|
"-f";
|
|
|
|
|
"html";
|
|
|
|
|
"-O";
|
|
|
|
|
"anchorlinenos=True,lineanchors="
|
2023-05-17 16:44:57 +03:00
|
|
|
^ String.to_ascii (Pos.get_file (Mark.get c))
|
2023-03-13 20:33:15 +03:00
|
|
|
^ ",linenos=table,linenostart="
|
2023-05-17 16:44:57 +03:00
|
|
|
^ string_of_int (Pos.get_start_line (Mark.get c));
|
2023-03-13 20:33:15 +03:00
|
|
|
temp_file_in;
|
|
|
|
|
]
|
2020-10-04 02:25:37 +03:00
|
|
|
in
|
2021-06-04 14:36:21 +03:00
|
|
|
(* Remove code blocks delimiters needed by [Pygments]. *)
|
2021-10-25 11:12:42 +03:00
|
|
|
let trimmed_output =
|
|
|
|
|
output |> remove_cb_first_lines |> remove_cb_last_lines
|
|
|
|
|
in
|
|
|
|
|
trimmed_output
|
2020-04-29 12:10:56 +03:00
|
|
|
|
2020-12-14 20:09:38 +03:00
|
|
|
(** {1 Weaving} *)
|
2020-05-10 19:45:05 +03:00
|
|
|
|
2022-08-02 16:15:42 +03:00
|
|
|
let sanitize_html_href str =
|
|
|
|
|
str
|
2022-11-21 13:17:42 +03:00
|
|
|
|> String.to_ascii
|
2022-08-12 10:51:43 +03:00
|
|
|
|> R.substitute ~rex:(R.regexp "[' '°\"]") ~subst:(function _ -> "%20")
|
2022-08-02 16:15:42 +03:00
|
|
|
|
2021-05-15 02:16:08 +03:00
|
|
|
let rec law_structure_to_html
|
|
|
|
|
(language : C.backend_lang)
|
2022-05-26 20:05:06 +03:00
|
|
|
(print_only_law : bool)
|
2022-08-04 17:35:45 +03:00
|
|
|
(parents_headings : string list)
|
2021-05-15 02:16:08 +03:00
|
|
|
(fmt : Format.formatter)
|
|
|
|
|
(i : A.law_structure) : unit =
|
2020-10-04 02:25:37 +03:00
|
|
|
match i with
|
2020-11-30 12:55:27 +03:00
|
|
|
| A.LawText t ->
|
|
|
|
|
let t = pre_html t in
|
2022-05-05 15:00:24 +03:00
|
|
|
if t = "" then () else Format.fprintf fmt "<div class='law-text'>%s</div>" t
|
2022-05-26 20:05:06 +03:00
|
|
|
| A.CodeBlock (_, c, metadata) when not print_only_law ->
|
2024-03-06 16:15:07 +03:00
|
|
|
let start_line = Pos.get_start_line (Mark.get c) + 1 in
|
2023-05-17 16:44:57 +03:00
|
|
|
let filename = Pos.get_file (Mark.get c) in
|
|
|
|
|
let block_content = Mark.remove c in
|
2022-08-29 16:46:06 +03:00
|
|
|
check_exceeding_lines start_line filename block_content;
|
2021-05-15 20:50:06 +03:00
|
|
|
Format.fprintf fmt
|
2023-03-09 17:45:21 +03:00
|
|
|
"<div class='code-wrapper%s catala-code'>\n\
|
|
|
|
|
<div class='filename'>%s</div>\n\
|
|
|
|
|
%s\n\
|
|
|
|
|
</div>"
|
2021-05-15 20:50:06 +03:00
|
|
|
(if metadata then " code-metadata" else "")
|
2023-05-17 16:44:57 +03:00
|
|
|
(Pos.get_file (Mark.get c))
|
2021-11-29 12:36:33 +03:00
|
|
|
(pygmentize_code
|
2023-05-17 16:44:57 +03:00
|
|
|
(Mark.copy c ("```catala\n" ^ Mark.remove c ^ "```"))
|
2021-11-29 12:36:33 +03:00
|
|
|
language)
|
2022-05-26 20:05:06 +03:00
|
|
|
| A.CodeBlock _ -> ()
|
2020-10-04 02:25:37 +03:00
|
|
|
| A.LawHeading (heading, children) ->
|
2021-05-15 20:50:06 +03:00
|
|
|
let h_number = heading.law_heading_precedence + 1 in
|
2022-08-05 19:33:32 +03:00
|
|
|
let is_a_section_to_collapse =
|
|
|
|
|
(* Only 2 depth sections are collasped in a <details> 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
|
2023-05-17 16:44:57 +03:00
|
|
|
let h_name = Mark.remove heading.law_heading_name in
|
2022-08-04 17:35:45 +03:00
|
|
|
let complete_headings = parents_headings @ [h_name] in
|
|
|
|
|
let id = complete_headings |> String.concat "-" |> sanitize_html_href in
|
2022-08-02 16:15:42 +03:00
|
|
|
let fmt_details_open fmt () =
|
2022-08-05 19:33:32 +03:00
|
|
|
if is_a_section_to_collapse then
|
2022-08-02 16:15:42 +03:00
|
|
|
Format.fprintf fmt "<details><summary>%s</summary>" h_name
|
|
|
|
|
in
|
|
|
|
|
let fmt_details_close fmt () =
|
2022-08-05 19:33:32 +03:00
|
|
|
if is_a_section_to_collapse then Format.fprintf fmt "</details>"
|
2022-08-02 16:15:42 +03:00
|
|
|
in
|
|
|
|
|
Format.fprintf fmt
|
2022-08-04 17:35:45 +03:00
|
|
|
"<h%d class='law-heading' id=\"%s\"><a href=\"#%s\">%s</a>%s</h%d>@\n\
|
|
|
|
|
%a\n\
|
|
|
|
|
%a\n\
|
|
|
|
|
%a"
|
|
|
|
|
h_number id id h_name
|
2021-05-15 02:16:08 +03:00
|
|
|
(match heading.law_heading_id, language with
|
2022-08-10 11:52:46 +03:00
|
|
|
| Some id, Fr -> (
|
|
|
|
|
try
|
|
|
|
|
P.sprintf
|
|
|
|
|
"<a class=\"link-article\" \
|
|
|
|
|
href=\"https://legifrance.gouv.fr/%s/id/%s\" \
|
|
|
|
|
target=\"_blank\">Voir le texte sur Légifrance.gouv.fr</a>"
|
|
|
|
|
(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 -> "")
|
2022-08-04 17:35:45 +03:00
|
|
|
| _ -> "")
|
|
|
|
|
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 ()
|
2021-05-15 02:16:08 +03:00
|
|
|
| A.LawInclude _ -> ()
|
2023-09-05 16:00:55 +03:00
|
|
|
| A.ModuleDef _ | A.ModuleUse _ -> () (* TODO: show somehow ?*)
|
2020-10-04 02:25:37 +03:00
|
|
|
|
2022-08-04 17:35:45 +03:00
|
|
|
let rec fmt_toc
|
|
|
|
|
(parents_headings : string list)
|
|
|
|
|
fmt
|
|
|
|
|
(items : A.law_structure list) =
|
|
|
|
|
Format.fprintf fmt "@[<v 2><ol class=\"toc-%d\">@\n%a@\n@]</ol>"
|
|
|
|
|
(List.length parents_headings)
|
2022-08-02 16:15:42 +03:00
|
|
|
(Format.pp_print_list
|
|
|
|
|
~pp_sep:(fun fmt () -> Format.fprintf fmt "@\n")
|
|
|
|
|
(fun fmt item ->
|
|
|
|
|
match item with
|
2022-08-04 17:35:45 +03:00
|
|
|
| A.LawHeading (heading, childs) ->
|
2023-05-17 16:44:57 +03:00
|
|
|
let h_name = Mark.remove heading.law_heading_name in
|
2022-08-04 17:35:45 +03:00
|
|
|
let complete_headings = parents_headings @ [h_name] in
|
|
|
|
|
let id =
|
|
|
|
|
complete_headings |> String.concat "-" |> sanitize_html_href
|
|
|
|
|
in
|
2022-08-02 16:15:42 +03:00
|
|
|
Format.fprintf fmt
|
2022-08-04 17:35:45 +03:00
|
|
|
"@[<hov 2><li class=\"toc-item\">@\n\
|
|
|
|
|
@[<hov 2><div>@\n\
|
|
|
|
|
<a href=\"#%s\">%s</a>@\n\
|
|
|
|
|
%a@\n\
|
|
|
|
|
@]</div>@\n\
|
|
|
|
|
@]</li>"
|
|
|
|
|
id h_name
|
|
|
|
|
(fmt_toc complete_headings)
|
|
|
|
|
childs
|
2022-08-02 16:15:42 +03:00
|
|
|
| _ -> ()))
|
2022-08-04 17:35:45 +03:00
|
|
|
(items |> List.filter (function A.LawHeading (_, _) -> true | _ -> false))
|
2022-08-02 16:15:42 +03:00
|
|
|
|
2020-12-14 20:09:38 +03:00
|
|
|
(** {1 API} *)
|
|
|
|
|
|
2021-03-02 20:27:39 +03:00
|
|
|
let ast_to_html
|
|
|
|
|
(language : C.backend_lang)
|
2022-05-26 20:05:06 +03:00
|
|
|
~(print_only_law : bool)
|
2021-03-02 20:27:39 +03:00
|
|
|
(fmt : Format.formatter)
|
|
|
|
|
(program : A.program) : unit =
|
2022-08-02 16:15:42 +03:00
|
|
|
let toc =
|
|
|
|
|
match language with
|
|
|
|
|
| C.Fr -> "Sommaire"
|
|
|
|
|
| C.En -> "Table of contents"
|
|
|
|
|
| C.Pl -> "Spis treści."
|
|
|
|
|
in
|
|
|
|
|
|
2022-08-04 17:35:45 +03:00
|
|
|
Format.fprintf fmt
|
|
|
|
|
"@[<hov 2><details class=\"toc\">@\n\
|
|
|
|
|
<summary>%s</summary>@\n\
|
|
|
|
|
%a@\n\
|
|
|
|
|
@]</details>\n\
|
|
|
|
|
%a@\n"
|
|
|
|
|
toc (fmt_toc []) program.program_items
|
2022-08-02 16:15:42 +03:00
|
|
|
(Format.pp_print_list
|
|
|
|
|
~pp_sep:(fun fmt () -> Format.fprintf fmt "\n\n")
|
|
|
|
|
(fun fmt ->
|
2022-08-04 17:35:45 +03:00
|
|
|
Format.fprintf fmt "%a"
|
|
|
|
|
(law_structure_to_html language print_only_law [])))
|
2022-08-02 16:15:42 +03:00
|
|
|
program.program_items
|
