From 6cb0d581a656d3b9ba427e5999ae4aae16f01aee Mon Sep 17 00:00:00 2001 From: Louis Gesbert Date: Wed, 4 May 2022 18:38:28 +0200 Subject: [PATCH] Workaround some ocamlformat crashes These files were not reformatted! --- Makefile | 2 +- build_system/ninja_utils.mli | 133 +++++++++++++++------------ compiler/lcalc/ast.ml | 18 ++-- compiler/lcalc/print.ml | 3 +- compiler/surface/.ocamlformat-ignore | 1 + 5 files changed, 90 insertions(+), 67 deletions(-) create mode 100644 compiler/surface/.ocamlformat-ignore diff --git a/Makefile b/Makefile index 6a788ea2..905cf269 100644 --- a/Makefile +++ b/Makefile @@ -41,7 +41,7 @@ COMPILER_DIR=compiler BUILD_SYSTEM_DIR=build_system format: - dune build @fmt --auto-promote 2> /dev/null | true + dune build @fmt --auto-promote #> build_dev : Builds the Catala compiler, without formatting code build_dev: diff --git a/build_system/ninja_utils.mli b/build_system/ninja_utils.mli index 75a35adb..2aa43f19 100644 --- a/build_system/ninja_utils.mli +++ b/build_system/ninja_utils.mli @@ -1,29 +1,32 @@ -(* This file is part of the Catala build system, a specification language for tax and social - benefits computation rules. Copyright (C) 2020 Inria, contributor: Emile Rolley - +(* This file is part of the Catala build system, a specification language for + tax and social benefits computation rules. Copyright (C) 2020 Inria, + contributor: 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 + 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 + 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 library contains the implementations of utility functions used to generate {{: - https://ninja-build.org}Ninja} build files in OCaml with almost no dependencies -- it only - depends on {{: https://v3.ocaml.org/p/re/1.10.3/doc/Re/index.html}Re}. It's currently developed - to be used by {{: {https://github.com/CatalaLang/catala/tree/master/build_system}Clerk}, the {{: - https://catala-lang.org}Catala} build system. Therefore, the library {b supports only very basic - features} required by Clerk. *) +(** {2 What (** This library contains the implementations of utility functions + used to generate {{:https://ninja-build.org} Ninja} build files in OCaml + with almost no dependencies -- it only depends on + {{:https://v3.ocaml.org/p/re/1.10.3/doc/Re/index.html} Re}. It's currently + developed to be used by + {{:https://github.com/CatalaLang/catala/tree/master/build_system} Clerk}, + the {{:https://catala-lang.org} Catala} build system. Therefore, the library + {b supports only very basic features} required by Clerk. *) is Ninja?} *) -(** {2 What is Ninja?} *) - -(** {{:https://ninja-build.org} Ninja} is a low-level build system. It's designed to have its input - files ({i build.ninja}) generated by a higher-level build system, and to run builds as fast as - possible by supporting native cross-platform (Windows and Unix) parallel builds. +(** {{:https://ninja-build.org} Ninja} is a low-level build system. It's + designed to have its input files ({i build.ninja}) generated by a + higher-level build system, and to run builds as fast as possible by + supporting native cross-platform (Windows and Unix) parallel builds. See the {{:https://ninja-build.org/manual.html} manual} for more details. *) @@ -31,24 +34,25 @@ (** Helper module to build ninja expressions. *) module Expr : sig - (** Represents a ninja expression. Which could be either a literal, a {{: - https://ninja-build.org/manual.html#_variables}variable references} ($_) or - a sequence of sub-expressions. + (** Represents a ninja expression. Which could be either a literal, a + {{:https://ninja-build.org/manual.html#_variables} variable references} + ($_) or a sequence of sub-expressions. - {b Note:} for now, there are no visible differences between an [Expr.Seq] - and a list of {!type: Expr.t}, indeed, in both cases, one space is added - between each expression -- resp. sub-expression. The difference only comes from the semantic: - an [Expr.Seq] is {b a unique} Ninja expression. *) + {b Note:} for now, there are no visible differences between an [Expr.Seq] + and a list of {!type: Expr.t}, indeed, in both cases, one space is added + between each expression -- resp. sub-expression. The difference only comes + from the semantic: an [Expr.Seq] is {b a unique} Ninja expression. *) type t = | Lit of string (* Literal string. *) | Var of string (* Variable reference. *) | Seq of t list - (* Sequence of sub-expressions. *) + (* Sequence of sub-expressions. *) val format : Format.formatter -> t -> unit - (** [format fmt exp] outputs in [fmt] the string representation of the ninja expression [exp]. *) + (** [format fmt exp] outputs in [fmt] the string representation of the ninja + expression [exp]. *) val format_list : Format.formatter -> t list -> unit (** [format fmt ls] outputs in [fmt] the string representation of a list [ls] @@ -57,30 +61,31 @@ end (** {1 Ninja rules} *) -(** Helper module to build {{:https://ninja-build.org/manual.html#_rules}ninja rules}. *) +(** Helper module to build {{:https://ninja-build.org/manual.html#_rules} ninja + rules}. *) module Rule : sig - type t = { - name : string; - command : Expr.t; - description : Expr.t option; - } + type t = { name : string; command : Expr.t; description : Expr.t option } (** Represents the minimal ninja rule representation for Clerk: + {[ -rule - command = - [description = ] + rule + command = + [description = ] ]} *) val make : string -> command:Expr.t -> description:Expr.t -> t - (** [make name ~command ~description] returns the corresponding ninja {!type: Rule.t}. *) + (** [make name ~command ~description] returns the corresponding ninja {!type: + Rule.t}. *) val format : Format.formatter -> t -> unit - (** [format fmt rule] outputs in [fmt] the string representation of the ninja [rule]. *) + (** [format fmt rule] outputs in [fmt] the string representation of the ninja + [rule]. *) end (** {1 Ninja builds} *) -(** Helper module to build ninja {{: https://ninja-build.org/manual.html#_build_statements}build statements}. *) +(** Helper module to build ninja + {{:https://ninja-build.org/manual.html#_build_statements} build statements}. *) module Build : sig type t = { outputs : Expr.t list; @@ -89,49 +94,63 @@ module Build : sig vars : (string * Expr.t) list; } (** Represents the minimal ninja build statement representation for Clerk: + {[ -build : [] - [] + build : [] + [] ]}*) val make : outputs:Expr.t list -> rule:string -> t - (** [make ~outputs ~rule] returns the corresponding ninja {!type: Build.t} with no {!field: inputs} - or {!field: vars}. *) + (** [make ~outputs ~rule] returns the corresponding ninja {!type: Build.t} + with no {!field: inputs} or {!field: vars}. *) - val make_with_vars : outputs:Expr.t list -> rule:string -> vars:(string * Expr.t) list -> t - (** [make_with_vars ~outputs ~rule ~vars] returns the corresponding ninja {!type: Build.t} with no {!field: inputs}. *) + val make_with_vars : + outputs:Expr.t list -> rule:string -> vars:(string * Expr.t) list -> t + (** [make_with_vars ~outputs ~rule ~vars] returns the corresponding ninja + {!type: Build.t} with no {!field: inputs}. *) - val make_with_inputs : outputs:Expr.t list -> rule:string -> inputs:Expr.t list -> t - (** [make_with_vars ~outputs ~rule ~inputs] returns the corresponding ninja {!type: Build.t} with no {!field: vars}. *) + val make_with_inputs : + outputs:Expr.t list -> rule:string -> inputs:Expr.t list -> t + (** [make_with_vars ~outputs ~rule ~inputs] returns the corresponding ninja + {!type: Build.t} with no {!field: vars}. *) val make_with_vars_and_inputs : - outputs:Expr.t list -> rule:string -> inputs:Expr.t list -> vars:(string * Expr.t) list -> t - (** [make_with_vars ~outputs ~rule ~inputs ~vars] returns the corresponding ninja {!type: Build.t}. *) + outputs:Expr.t list -> + rule:string -> + inputs:Expr.t list -> + vars:(string * Expr.t) list -> + t + (** [make_with_vars ~outputs ~rule ~inputs ~vars] returns the corresponding + ninja {!type: Build.t}. *) val empty : t - (** [empty] is the minimal ninja {!type: Build.t} with ["empty"] as {!field: outputs} and ["phony"] as {!field: rule}. *) + (** [empty] is the minimal ninja {!type: Build.t} with ["empty"] as {!field: + outputs} and ["phony"] as {!field: rule}. *) val unpath : ?sep:string -> string -> string - (** [unpath ~sep path] replaces all [/] occurences with [sep] in [path] to avoid ninja writing the - corresponding file and use it as sub command. By default, [sep] is set to ["-"]. *) + (** [unpath ~sep path] replaces all [/] occurences with [sep] in [path] to + avoid ninja writing the corresponding file and use it as sub command. By + default, [sep] is set to ["-"]. *) val format : Format.formatter -> t -> unit - (** [format fmt build] outputs in [fmt] the string representation of the ninja [build]. *) + (** [format fmt build] outputs in [fmt] the string representation of the ninja + [build]. *) end (** {1 Maps} *) module RuleMap : Map.S with type key = String.t - module BuildMap : Map.S with type key = String.t (** {1 Ninja} *) type ninja = { rules : Rule.t RuleMap.t; builds : Build.t BuildMap.t } -(** Represents the minimal ninja architecture (list of rule and build statements) needed for clerk. *) +(** Represents the minimal ninja architecture (list of rule and build + statements) needed for clerk. *) val empty : ninja (** [empty] returns the empty empty ninja structure. *) val format : Format.formatter -> ninja -> unit -(** [format fmt build] outputs in [fmt] the string representation of all [ninja.rules] and [ninja.builds]. *) +(** [format fmt build] outputs in [fmt] the string representation of all + [ninja.rules] and [ninja.builds]. *) diff --git a/compiler/lcalc/ast.ml b/compiler/lcalc/ast.ml index b0940673..d2a9f094 100644 --- a/compiler/lcalc/ast.ml +++ b/compiler/lcalc/ast.ml @@ -249,9 +249,10 @@ let make_none (pos : Pos.t) : expr Pos.marked Bindlib.box = let make_some (e : expr Pos.marked Bindlib.box) : expr Pos.marked Bindlib.box = let pos = Pos.get_position @@ Bindlib.unbox e in let mark : 'a -> 'a Pos.marked = Pos.mark pos in - let+ e = e [@ocamlformat "disable"] in - - mark @@ EInj (e, 1, option_enum, [ (D.TLit D.TUnit, pos); (D.TAny, pos) ]) + begin[@ocamlformat "disable"] + let+ e = e in + mark @@ EInj (e, 1, option_enum, [ (D.TLit D.TUnit, pos); (D.TAny, pos) ]) + end (** [make_matchopt_with_abs_arms arg e_none e_some] build an expression [match arg with |None -> e_none | Some -> e_some] and requires e_some and @@ -262,11 +263,12 @@ let make_matchopt_with_abs_arms (e_some : expr Pos.marked Bindlib.box) : expr Pos.marked Bindlib.box = let pos = Pos.get_position @@ Bindlib.unbox arg in let mark : 'a -> 'a Pos.marked = Pos.mark pos in - let+ arg = arg - and+ e_none = e_none - and+ e_some = e_some [@ocamlformat "disable"] in - - mark @@ EMatch (arg, [ e_none; e_some ], option_enum) + begin[@ocamlformat "disable"] + let+ arg = arg + and+ e_none = e_none + and+ e_some = e_some in + mark @@ EMatch (arg, [ e_none; e_some ], option_enum) + end (** [make_matchopt pos v tau arg e_none e_some] builds an expression [match arg with | None () -> e_none | Some v -> e_some]. It binds v to diff --git a/compiler/lcalc/print.ml b/compiler/lcalc/print.ml index 20572a00..7eb0c459 100644 --- a/compiler/lcalc/print.ml +++ b/compiler/lcalc/print.ml @@ -29,7 +29,8 @@ let begins_with_uppercase (s : string) : bool = let first_letter = CamomileLibraryDefault.Camomile.UTF8.get s 0 in is_uppercase first_letter -(** @note: (EmileRolley) seems to be factorizable with Dcalc.Print.format_lit. *) +(** {b Note:} (EmileRolley) seems to be factorizable with + Dcalc.Print.format_lit. *) let format_lit (fmt : Format.formatter) (l : lit Pos.marked) : unit = match Pos.unmark l with | LBool b -> Dcalc.Print.format_lit_style fmt (string_of_bool b) diff --git a/compiler/surface/.ocamlformat-ignore b/compiler/surface/.ocamlformat-ignore new file mode 100644 index 00000000..6787e6b8 --- /dev/null +++ b/compiler/surface/.ocamlformat-ignore @@ -0,0 +1 @@ +*.cppo.ml