src/Tools/Code/code_namespace.ML
author haftmann
Thu Sep 05 18:05:03 2013 +0200 (2013-09-05)
changeset 53414 dd64696d267a
parent 52138 e21426f244aa
child 55147 bce3dbc11f95
permissions -rw-r--r--
explicit module names have precedence over identifier declarations
     1 (*  Title:      Tools/Code/code_namespace.ML
     2     Author:     Florian Haftmann, TU Muenchen
     3 
     4 Mastering target language namespaces.
     5 *)
     6 
     7 signature CODE_NAMESPACE =
     8 sig
     9   type flat_program
    10   val flat_program: Proof.context -> (string -> Code_Symbol.symbol)
    11     -> { module_prefix: string, module_name: string,
    12     reserved: Name.context, identifiers: Code_Target.identifier_data, empty_nsp: 'a,
    13     namify_stmt: Code_Thingol.stmt -> string -> 'a -> string * 'a,
    14     modify_stmt: Code_Thingol.stmt -> Code_Thingol.stmt option }
    15       -> Code_Thingol.program
    16       -> { deresolver: string -> string -> string,
    17            flat_program: flat_program }
    18 
    19   datatype ('a, 'b) node =
    20       Dummy
    21     | Stmt of 'a
    22     | Module of ('b * (string * ('a, 'b) node) Graph.T)
    23   type ('a, 'b) hierarchical_program
    24   val hierarchical_program: Proof.context -> (string -> Code_Symbol.symbol)
    25     -> { module_name: string,
    26     reserved: Name.context, identifiers: Code_Target.identifier_data,
    27     empty_nsp: 'c, namify_module: string -> 'c -> string * 'c,
    28     namify_stmt: Code_Thingol.stmt -> string -> 'c -> string * 'c,
    29     cyclic_modules: bool, empty_data: 'b, memorize_data: string -> 'b -> 'b,
    30     modify_stmts: (string * Code_Thingol.stmt) list -> 'a option list }
    31       -> Code_Thingol.program
    32       -> { deresolver: string list -> string -> string,
    33            hierarchical_program: ('a, 'b) hierarchical_program }
    34   val print_hierarchical: { print_module: string list -> string -> 'b -> 'c list -> 'c,
    35     print_stmt: string list -> string * 'a -> 'c,
    36     lift_markup: (Pretty.T -> Pretty.T) -> 'c -> 'c }
    37       -> ('a, 'b) hierarchical_program -> 'c list
    38 end;
    39 
    40 structure Code_Namespace : CODE_NAMESPACE =
    41 struct
    42 
    43 (** fundamental module name hierarchy **)
    44 
    45 val split_name = apfst Long_Name.implode o split_last o fst o split_last o Long_Name.explode;
    46 
    47 fun lookup_identifier symbol_of identifiers name =
    48   Code_Symbol.lookup identifiers (symbol_of name)
    49   |> Option.map (split_last o Long_Name.explode);
    50 
    51 fun force_identifier symbol_of fragments_tab force_module identifiers name =
    52   case lookup_identifier symbol_of identifiers name of
    53       NONE => (apfst (the o Symtab.lookup fragments_tab) o split_name) name
    54     | SOME prefix_name => if null force_module then prefix_name
    55         else (force_module, snd prefix_name);
    56 
    57 fun build_module_namespace { module_prefix, module_identifiers, reserved } program =
    58   let
    59     fun alias_fragments name = case module_identifiers name
    60      of SOME name' => Long_Name.explode name'
    61       | NONE => map (fn name => fst (Name.variant name reserved)) (Long_Name.explode name);
    62     val module_names = Graph.fold (insert (op =) o fst o split_name o fst) program [];
    63   in
    64     fold (fn name => Symtab.update (name, Long_Name.explode module_prefix @ alias_fragments name))
    65       module_names Symtab.empty
    66   end;
    67 
    68 
    69 (** flat program structure **)
    70 
    71 type flat_program = ((string * Code_Thingol.stmt option) Graph.T * (string * string list) list) Graph.T;
    72 
    73 fun flat_program ctxt symbol_of { module_prefix, module_name, reserved,
    74     identifiers, empty_nsp, namify_stmt, modify_stmt } program =
    75   let
    76 
    77     (* building module name hierarchy *)
    78     val module_identifiers = if module_name = ""
    79       then Code_Symbol.lookup_module_data identifiers
    80       else K (SOME module_name);
    81     val fragments_tab = build_module_namespace { module_prefix = module_prefix,
    82       module_identifiers = module_identifiers, reserved = reserved } program;
    83     val prep_name = force_identifier symbol_of fragments_tab (Long_Name.explode module_name) identifiers
    84       #>> Long_Name.implode;
    85 
    86     (* distribute statements over hierarchy *)
    87     fun add_stmt name stmt =
    88       let
    89         val (module_name, base) = prep_name name;
    90       in
    91         Graph.default_node (module_name, (Graph.empty, []))
    92         #> (Graph.map_node module_name o apfst) (Graph.new_node (name, (base, stmt)))
    93       end;
    94     fun add_dependency name name' =
    95       let
    96         val (module_name, _) = prep_name name;
    97         val (module_name', _) = prep_name name';
    98       in if module_name = module_name'
    99         then (Graph.map_node module_name o apfst) (Graph.add_edge (name, name'))
   100         else (Graph.map_node module_name o apsnd) (AList.map_default (op =) (module_name', []) (insert (op =) name'))
   101       end;
   102     val proto_program = Graph.empty
   103       |> Graph.fold (fn (name, (stmt, _)) => add_stmt name stmt) program
   104       |> Graph.fold (fn (name, (_, (_, names))) =>
   105           Graph.Keys.fold (add_dependency name) names) program;
   106 
   107     (* name declarations and statement modifications *)
   108     fun declare name (base, stmt) (gr, nsp) = 
   109       let
   110         val (base', nsp') = namify_stmt stmt base nsp;
   111         val gr' = (Graph.map_node name o apfst) (K base') gr;
   112       in (gr', nsp') end;
   113     fun declarations gr = (gr, empty_nsp)
   114       |> fold (fn name => declare name (Graph.get_node gr name)) (Graph.keys gr) 
   115       |> fst
   116       |> (Graph.map o K o apsnd) modify_stmt;
   117     val flat_program = proto_program
   118       |> (Graph.map o K o apfst) declarations;
   119 
   120     (* qualified and unqualified imports, deresolving *)
   121     fun base_deresolver name = fst (Graph.get_node
   122       (fst (Graph.get_node flat_program (fst (prep_name name)))) name);
   123     fun classify_names gr imports =
   124       let
   125         val import_tab = maps
   126           (fn (module_name, names) => map (rpair module_name) names) imports;
   127         val imported_names = map fst import_tab;
   128         val here_names = Graph.keys gr;
   129       in
   130         Symtab.empty
   131         |> fold (fn name => Symtab.update (name, base_deresolver name)) here_names
   132         |> fold (fn name => Symtab.update (name,
   133             Long_Name.append (the (AList.lookup (op =) import_tab name))
   134               (base_deresolver name))) imported_names
   135       end;
   136     val deresolver_tab = Symtab.make (AList.make
   137       (uncurry classify_names o Graph.get_node flat_program)
   138         (Graph.keys flat_program));
   139     fun deresolver "" name =
   140           Long_Name.append (fst (prep_name name)) (base_deresolver name)
   141       | deresolver module_name name =
   142           the (Symtab.lookup (the (Symtab.lookup deresolver_tab module_name)) name)
   143           handle Option.Option => error ("Unknown statement name: "
   144             ^ (Code_Symbol.quote_symbol ctxt o symbol_of) name);
   145 
   146   in { deresolver = deresolver, flat_program = flat_program } end;
   147 
   148 
   149 (** hierarchical program structure **)
   150 
   151 datatype ('a, 'b) node =
   152     Dummy
   153   | Stmt of 'a
   154   | Module of ('b * (string * ('a, 'b) node) Graph.T);
   155 
   156 type ('a, 'b) hierarchical_program = (string * ('a, 'b) node) Graph.T;
   157 
   158 fun map_module_content f (Module content) = Module (f content);
   159 
   160 fun map_module [] = I
   161   | map_module (name_fragment :: name_fragments) =
   162       apsnd o Graph.map_node name_fragment o apsnd o map_module_content
   163         o map_module name_fragments;
   164 
   165 fun hierarchical_program ctxt symbol_of { module_name, reserved, identifiers, empty_nsp,
   166       namify_module, namify_stmt, cyclic_modules, empty_data, memorize_data, modify_stmts } program =
   167   let
   168 
   169     (* building module name hierarchy *)
   170     val module_identifiers = if module_name = ""
   171       then Code_Symbol.lookup_module_data identifiers
   172       else K (SOME module_name);
   173     val fragments_tab = build_module_namespace { module_prefix = "",
   174       module_identifiers = module_identifiers, reserved = reserved } program;
   175     val prep_name = force_identifier symbol_of fragments_tab (Long_Name.explode module_name) identifiers;
   176 
   177     (* building empty module hierarchy *)
   178     val empty_module = (empty_data, Graph.empty);
   179     fun ensure_module name_fragment (data, nodes) =
   180       if can (Graph.get_node nodes) name_fragment then (data, nodes)
   181       else (data,
   182         nodes |> Graph.new_node (name_fragment, (name_fragment, Module empty_module)));
   183     fun allocate_module [] = I
   184       | allocate_module (name_fragment :: name_fragments) =
   185           ensure_module name_fragment
   186           #> (apsnd o Graph.map_node name_fragment o apsnd o map_module_content o allocate_module) name_fragments;
   187     val empty_program =
   188       empty_module
   189       |> Symtab.fold (fn (_, fragments) => allocate_module fragments) fragments_tab
   190       |> Graph.fold (allocate_module o these o Option.map fst
   191           o lookup_identifier symbol_of identifiers o fst) program;
   192 
   193     (* distribute statements over hierarchy *)
   194     fun add_stmt name stmt =
   195       let
   196         val (name_fragments, base) = prep_name name;
   197       in
   198         (map_module name_fragments o apsnd) (Graph.new_node (name, (base, Stmt stmt)))
   199       end;
   200     fun add_dependency name name' =
   201       let
   202         val (name_fragments, _) = prep_name name;
   203         val (name_fragments', _) = prep_name name';
   204         val (name_fragments_common, (diff, diff')) =
   205           chop_prefix (op =) (name_fragments, name_fragments');
   206         val is_module = not (null diff andalso null diff');
   207         val dep = pairself hd (diff @ [name], diff' @ [name']);
   208         val add_edge = if is_module andalso not cyclic_modules
   209           then (fn node => Graph.add_edge_acyclic dep node
   210             handle Graph.CYCLES _ => error ("Dependency "
   211               ^ (Code_Symbol.quote_symbol ctxt o symbol_of) name ^ " -> "
   212               ^ (Code_Symbol.quote_symbol ctxt o symbol_of) name'
   213               ^ " would result in module dependency cycle"))
   214           else Graph.add_edge dep
   215       in (map_module name_fragments_common o apsnd) add_edge end;
   216     val proto_program = empty_program
   217       |> Graph.fold (fn (name, (stmt, _)) => add_stmt name stmt) program
   218       |> Graph.fold (fn (name, (_, (_, names))) =>
   219           Graph.Keys.fold (add_dependency name) names) program;
   220 
   221     (* name declarations, data and statement modifications *)
   222     fun make_declarations nsps (data, nodes) =
   223       let
   224         val (module_fragments, stmt_names) = List.partition
   225           (fn name_fragment => case Graph.get_node nodes name_fragment
   226             of (_, Module _) => true | _ => false) (Graph.keys nodes);
   227         fun declare namify name (nsps, nodes) =
   228           let
   229             val (base, node) = Graph.get_node nodes name;
   230             val (base', nsps') = namify node base nsps;
   231             val nodes' = Graph.map_node name (K (base', node)) nodes;
   232           in (nsps', nodes') end;
   233         val (nsps', nodes') = (nsps, nodes)
   234           |> fold (declare (K namify_module)) module_fragments
   235           |> fold (declare (namify_stmt o (fn Stmt stmt => stmt))) stmt_names;
   236         fun zip_fillup xs ys = xs ~~ ys @ replicate (length xs - length ys) NONE;
   237         fun select_names names = case filter (member (op =) stmt_names) names
   238          of [] => NONE
   239           | xs => SOME xs;
   240         val modify_stmts' = AList.make (snd o Graph.get_node nodes)
   241           #> split_list
   242           ##> map (fn Stmt stmt => stmt)
   243           #> (fn (names, stmts) => zip_fillup names (modify_stmts (names ~~ stmts)));
   244         val stmtss' = (maps modify_stmts' o map_filter select_names o Graph.strong_conn) nodes;
   245         val nodes'' = Graph.map (fn name => apsnd (fn Module content => Module (make_declarations nsps' content)
   246             | _ => case AList.lookup (op =) stmtss' name of SOME (SOME stmt) => Stmt stmt | _ => Dummy)) nodes';
   247         val data' = fold memorize_data stmt_names data;
   248       in (data', nodes'') end;
   249     val (_, hierarchical_program) = make_declarations empty_nsp proto_program;
   250 
   251     (* deresolving *)
   252     fun deresolver prefix_fragments name =
   253       let
   254         val (name_fragments, _) = prep_name name;
   255         val (_, (_, remainder)) = chop_prefix (op =) (prefix_fragments, name_fragments);
   256         val nodes = fold (fn name_fragment => fn nodes => case Graph.get_node nodes name_fragment
   257          of (_, Module (_, nodes)) => nodes) name_fragments hierarchical_program;
   258         val (base', _) = Graph.get_node nodes name;
   259       in Long_Name.implode (remainder @ [base']) end
   260         handle Graph.UNDEF _ => error ("Unknown statement name: "
   261           ^ (Code_Symbol.quote_symbol ctxt o symbol_of) name);
   262 
   263   in { deresolver = deresolver, hierarchical_program = hierarchical_program } end;
   264 
   265 fun print_hierarchical { print_module, print_stmt, lift_markup } =
   266   let
   267     fun print_node _ (_, Dummy) =
   268           NONE
   269       | print_node prefix_fragments (name, Stmt stmt) =
   270           SOME (lift_markup (Code_Printer.markup_stmt name)
   271             (print_stmt prefix_fragments (name, stmt)))
   272       | print_node prefix_fragments (name_fragment, Module (data, nodes)) =
   273           let
   274             val prefix_fragments' = prefix_fragments @ [name_fragment]
   275           in
   276             Option.map (print_module prefix_fragments'
   277               name_fragment data) (print_nodes prefix_fragments' nodes)
   278           end
   279     and print_nodes prefix_fragments nodes =
   280       let
   281         val xs = (map_filter (fn name => print_node prefix_fragments
   282           (name, snd (Graph.get_node nodes name))) o rev o flat o Graph.strong_conn) nodes
   283       in if null xs then NONE else SOME xs end;
   284   in these o print_nodes [] end;
   285 
   286 end;