mirror of
https://github.com/CatalaLang/catala.git
synced 2024-11-08 07:51:43 +03:00
b9156bb60e
Previously we had some heuristics in the backends trying to achieve this with a lot of holes ; this should be much more solid, relying on `Bindlib` to do the correct renamings. **Note1**: it's not plugged into the backends other than OCaml at the moment. **Note2**: the related, obsolete heuristics haven't been cleaned out yet **Note3**: we conservatively suppose a single namespace at the moment. This is required for e.g. Python, but it forces vars named like struct fields to be renamed, which is more verbose in e.g. OCaml. The renaming engine could be improved to support different namespaces, with a way to select how to route the different kinds of identifiers into them. Similarly, customisation for what needs to be uppercase or lowercase is not available yet. **Note4**: besides excluding keywords, we should also be careful to exclude (or namespace): - the idents used in the runtime (e.g. `o_add_int_int`) - the dynamically generated idents (e.g. `embed_*`) **Note5**: module names themselves aren't handled yet. The reason is that they must be discoverable by the user, and even need to match the filenames, etc. In other words, imagine that `Mod` is a keyword in the target language. You can't rename a module called `Mod` to `Mod1` without knowing the whole module context, because that would destroy the mapping for a module already called `Mod1`. A reliable solution would be to translate all module names to e.g. `CatalaModule_*`, which we can assume will never conflict with any built-in, and forbid idents starting with that prefix. We may also want to restrict their names to ASCII ? Currently we use a projection, but what if I have two modules called `Là` and `La` ?
74 lines
2.8 KiB
OCaml
74 lines
2.8 KiB
OCaml
(* This file is part of the Catala compiler, a specification language for tax
|
|
and social benefits computation rules. Copyright (C) 2020-2022 Inria,
|
|
contributor: Denis Merigoux <denis.merigoux@inria.fr>, Alain Delaët-Tixeuil
|
|
<alain.delaet--tixeuil@inria.fr>, 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. *)
|
|
|
|
open Definitions
|
|
|
|
(** {2 Program declaration context helpers} *)
|
|
|
|
val empty_ctx : decl_ctx
|
|
|
|
(** {2 Transformations} *)
|
|
|
|
val map_decl_ctx : f:(typ -> typ) -> decl_ctx -> decl_ctx
|
|
|
|
val map_exprs :
|
|
?typ:(typ -> typ) ->
|
|
f:('expr1 -> 'expr2 boxed) ->
|
|
varf:('expr1 Var.t -> 'expr2 Var.t) ->
|
|
'expr1 program ->
|
|
'expr2 program
|
|
(** If [typ] is specified, definitions in [decl_ctx] are also processed *)
|
|
|
|
val fold_left :
|
|
f:('a -> 'expr code_item -> 'a) -> init:'a -> 'expr program -> 'a
|
|
|
|
val fold_exprs : f:('a -> 'expr -> typ -> 'a) -> init:'a -> 'expr program -> 'a
|
|
|
|
val fold_right :
|
|
f:('expr code_item -> 'a -> 'a) -> init:'a -> 'expr program -> 'a
|
|
|
|
val get_scope_body :
|
|
((_ any, 't) gexpr as 'e) program -> ScopeName.t -> 'e scope_body
|
|
|
|
val untype : ('a any, _) gexpr program -> ('a, untyped) gexpr program
|
|
|
|
val to_expr : ((_ any, _) gexpr as 'e) program -> ScopeName.t -> 'e boxed
|
|
(** Usage: [build_whole_program_expr program main_scope] builds an expression
|
|
corresponding to the main program and returning the main scope as a
|
|
function. *)
|
|
|
|
val find_scope : ScopeName.t -> 'e code_item_list -> 'e scope_body
|
|
|
|
val modules_to_list : module_tree -> (ModuleName.t * module_intf_id) list
|
|
(** Returns a list of used modules, in topological order ; the boolean indicates
|
|
if the module is external *)
|
|
|
|
val rename_ids :
|
|
reserved:string list ->
|
|
reset_context_for_closed_terms:bool ->
|
|
skip_constant_binders:bool ->
|
|
constant_binder_name:string option ->
|
|
('a, 't) gexpr program ->
|
|
('a, 't) gexpr program * Expr.Renaming.context
|
|
(** Renames all idents (variables, types, struct and enum names, fields and
|
|
constructors) to dispel ambiguities in the target language. Names in
|
|
[reserved], typically keywords and built-ins, will be avoided ; the meaning
|
|
of the flags is described in [Bindlib.Renaming].
|
|
|
|
In the returned program, it is safe to directly use `Bindlib.name_of` on
|
|
variables for printing. The same is true for `StructName.get_info` etc. *)
|