src/Tools/Code/code_namespace.ML
author haftmann
Sat Sep 04 21:13:13 2010 +0200 (2010-09-04)
changeset 39147 3c284a152bd6
parent 39055 81e0368812ad
child 39203 b2f9a6f4b84b
permissions -rw-r--r--
printing combinator for hierarchical programs
haftmann@38970
     1
(*  Title:      Tools/Code/code_namespace.ML
haftmann@38970
     2
    Author:     Florian Haftmann, TU Muenchen
haftmann@38970
     3
haftmann@38970
     4
Mastering target language namespaces.
haftmann@38970
     5
*)
haftmann@38970
     6
haftmann@38970
     7
signature CODE_NAMESPACE =
haftmann@38970
     8
sig
haftmann@39055
     9
  val dest_name: string -> string * string
haftmann@39017
    10
  datatype ('a, 'b) node =
haftmann@38970
    11
      Dummy
haftmann@39017
    12
    | Stmt of 'a
haftmann@39147
    13
    | Module of ('b * (string * ('a, 'b) node) Graph.T)
haftmann@39147
    14
  type ('a, 'b) hierarchical_program = (string * ('a, 'b) node) Graph.T
haftmann@38970
    15
  val hierarchical_program: (string -> string) -> { module_alias: string -> string option,
haftmann@39022
    16
    reserved: Name.context, empty_nsp: 'c, namify_module: string -> 'c -> string * 'c,
haftmann@39022
    17
    namify_stmt: Code_Thingol.stmt -> string -> 'c -> string * 'c,
haftmann@39022
    18
    cyclic_modules: bool, empty_data: 'b, memorize_data: string -> 'b -> 'b,
haftmann@39024
    19
    modify_stmts: (string * Code_Thingol.stmt) list -> 'a option list }
haftmann@38970
    20
      -> Code_Thingol.program
haftmann@38970
    21
      -> { deresolver: string list -> string -> string,
haftmann@39147
    22
           hierarchical_program: ('a, 'b) hierarchical_program }
haftmann@39147
    23
  val print_hierarchical: { print_module: string list -> string -> 'b -> 'c list -> 'c,
haftmann@39147
    24
    print_stmt: string list -> string * 'a -> 'c,
haftmann@39147
    25
    lift_markup: (Pretty.T -> Pretty.T) -> 'c -> 'c }
haftmann@39147
    26
      -> ('a, 'b) hierarchical_program -> 'c list
haftmann@38970
    27
end;
haftmann@38970
    28
haftmann@38970
    29
structure Code_Namespace : CODE_NAMESPACE =
haftmann@38970
    30
struct
haftmann@38970
    31
haftmann@39055
    32
(** splitting names in module and base part **)
haftmann@39055
    33
haftmann@39055
    34
val dest_name =
haftmann@39055
    35
  apfst Long_Name.implode o split_last o fst o split_last o Long_Name.explode;
haftmann@39055
    36
haftmann@39055
    37
haftmann@39055
    38
(** hierarchical program structure **)
haftmann@38970
    39
haftmann@39017
    40
datatype ('a, 'b) node =
haftmann@38970
    41
    Dummy
haftmann@39017
    42
  | Stmt of 'a
haftmann@39017
    43
  | Module of ('b * (string * ('a, 'b) node) Graph.T);
haftmann@38970
    44
haftmann@39147
    45
type ('a, 'b) hierarchical_program = (string * ('a, 'b) node) Graph.T;
haftmann@39147
    46
haftmann@39018
    47
fun map_module_content f (Module content) = Module (f content);
haftmann@39018
    48
haftmann@39018
    49
fun map_module [] = I
haftmann@39018
    50
  | map_module (name_fragment :: name_fragments) =
haftmann@39018
    51
      apsnd o Graph.map_node name_fragment o apsnd o map_module_content
haftmann@39018
    52
        o map_module name_fragments;
haftmann@39018
    53
haftmann@38970
    54
fun hierarchical_program labelled_name { module_alias, reserved, empty_nsp,
haftmann@39023
    55
      namify_module, namify_stmt, cyclic_modules, empty_data, memorize_data, modify_stmts } program =
haftmann@38970
    56
  let
haftmann@38970
    57
haftmann@38970
    58
    (* building module name hierarchy *)
haftmann@38970
    59
    fun alias_fragments name = case module_alias name
haftmann@38970
    60
     of SOME name' => Long_Name.explode name'
haftmann@38970
    61
      | NONE => map (fn name => fst (yield_singleton Name.variants name reserved))
haftmann@38970
    62
          (Long_Name.explode name);
haftmann@39055
    63
    val module_names = Graph.fold (insert (op =) o fst o dest_name o fst) program [];
haftmann@38970
    64
    val fragments_tab = fold (fn name => Symtab.update
haftmann@38970
    65
      (name, alias_fragments name)) module_names Symtab.empty;
haftmann@39055
    66
    val dest_name = dest_name #>> (the o Symtab.lookup fragments_tab);
haftmann@38970
    67
haftmann@38970
    68
    (* building empty module hierarchy *)
haftmann@38970
    69
    val empty_module = (empty_data, Graph.empty);
haftmann@38970
    70
    fun ensure_module name_fragment (data, nodes) =
haftmann@38970
    71
      if can (Graph.get_node nodes) name_fragment then (data, nodes)
haftmann@38970
    72
      else (data,
haftmann@38970
    73
        nodes |> Graph.new_node (name_fragment, (name_fragment, Module empty_module)));
haftmann@38970
    74
    fun allocate_module [] = I
haftmann@38970
    75
      | allocate_module (name_fragment :: name_fragments) =
haftmann@38970
    76
          ensure_module name_fragment
haftmann@39018
    77
          #> (apsnd o Graph.map_node name_fragment o apsnd o map_module_content o allocate_module) name_fragments;
haftmann@38970
    78
    val empty_program = Symtab.fold (fn (_, fragments) => allocate_module fragments)
haftmann@38970
    79
      fragments_tab empty_module;
haftmann@38970
    80
haftmann@38970
    81
    (* distribute statements over hierarchy *)
haftmann@38970
    82
    fun add_stmt name stmt =
haftmann@38970
    83
      let
haftmann@38970
    84
        val (name_fragments, base) = dest_name name;
haftmann@38970
    85
      in
haftmann@39018
    86
        (map_module name_fragments o apsnd) (Graph.new_node (name, (base, Stmt stmt)))
haftmann@38970
    87
      end;
haftmann@38970
    88
    fun add_dependency name name' =
haftmann@38970
    89
      let
haftmann@38970
    90
        val (name_fragments, base) = dest_name name;
haftmann@38970
    91
        val (name_fragments', base') = dest_name name';
haftmann@38970
    92
        val (name_fragments_common, (diff, diff')) =
haftmann@38970
    93
          chop_prefix (op =) (name_fragments, name_fragments');
haftmann@39023
    94
        val is_module = not (null diff andalso null diff');
haftmann@39023
    95
        val dep = pairself hd (diff @ [name], diff' @ [name']);
haftmann@38970
    96
        val add_edge = if is_module andalso not cyclic_modules
haftmann@38970
    97
          then (fn node => Graph.add_edge_acyclic dep node
haftmann@38970
    98
            handle Graph.CYCLES _ => error ("Dependency "
haftmann@38970
    99
              ^ quote name ^ " -> " ^ quote name'
haftmann@38970
   100
              ^ " would result in module dependency cycle"))
haftmann@38970
   101
          else Graph.add_edge dep
haftmann@39018
   102
      in (map_module name_fragments_common o apsnd) add_edge end;
haftmann@38970
   103
    val proto_program = empty_program
haftmann@38970
   104
      |> Graph.fold (fn (name, (stmt, _)) => add_stmt name stmt) program
haftmann@38970
   105
      |> Graph.fold (fn (name, (_, (_, names))) => fold (add_dependency name) names) program;
haftmann@38970
   106
haftmann@39022
   107
    (* name declarations, data and statement modifications *)
haftmann@38970
   108
    fun make_declarations nsps (data, nodes) =
haftmann@38970
   109
      let
haftmann@38970
   110
        val (module_fragments, stmt_names) = List.partition
haftmann@38970
   111
          (fn name_fragment => case Graph.get_node nodes name_fragment
haftmann@38970
   112
            of (_, Module _) => true | _ => false) (Graph.keys nodes);
haftmann@39022
   113
        fun declare namify name (nsps, nodes) =
haftmann@38970
   114
          let
haftmann@38970
   115
            val (base, node) = Graph.get_node nodes name;
haftmann@38970
   116
            val (base', nsps') = namify node base nsps;
haftmann@39022
   117
            val nodes' = Graph.map_node name (K (base', node)) nodes;
haftmann@38970
   118
          in (nsps', nodes') end;
haftmann@38970
   119
        val (nsps', nodes') = (nsps, nodes)
haftmann@39022
   120
          |> fold (declare (K namify_module)) module_fragments
haftmann@39022
   121
          |> fold (declare (namify_stmt o (fn Stmt stmt => stmt))) stmt_names;
haftmann@39029
   122
        fun zip_fillup xs ys = xs ~~ ys @ replicate (length xs - length ys) NONE;
haftmann@39029
   123
        fun select_names names = case filter (member (op =) stmt_names) names
haftmann@39029
   124
         of [] => NONE
haftmann@39029
   125
          | xs => SOME xs;
haftmann@39029
   126
        val modify_stmts' = AList.make (snd o Graph.get_node nodes)
haftmann@39023
   127
          #> split_list
haftmann@39023
   128
          ##> map (fn Stmt stmt => stmt)
haftmann@39029
   129
          #> (fn (names, stmts) => zip_fillup names (modify_stmts (names ~~ stmts)));
haftmann@39029
   130
        val stmtss' = (maps modify_stmts' o map_filter select_names o Graph.strong_conn) nodes;
haftmann@39023
   131
        val nodes'' = Graph.map (fn name => apsnd (fn Module content => Module (make_declarations nsps' content)
haftmann@39023
   132
            | _ => case AList.lookup (op =) stmtss' name of SOME (SOME stmt) => Stmt stmt | _ => Dummy)) nodes';
haftmann@39018
   133
        val data' = fold memorize_data stmt_names data;
haftmann@39018
   134
      in (data', nodes'') end;
haftmann@38970
   135
    val (_, hierarchical_program) = make_declarations empty_nsp proto_program;
haftmann@38970
   136
haftmann@38970
   137
    (* deresolving *)
haftmann@38970
   138
    fun deresolver prefix_fragments name =
haftmann@38970
   139
      let
haftmann@38970
   140
        val (name_fragments, _) = dest_name name;
haftmann@38970
   141
        val (_, (_, remainder)) = chop_prefix (op =) (prefix_fragments, name_fragments);
haftmann@38970
   142
        val nodes = fold (fn name_fragment => fn nodes => case Graph.get_node nodes name_fragment
haftmann@38970
   143
         of (_, Module (_, nodes)) => nodes) name_fragments hierarchical_program;
haftmann@38970
   144
        val (base', _) = Graph.get_node nodes name;
haftmann@38970
   145
      in Long_Name.implode (remainder @ [base']) end
haftmann@38970
   146
        handle Graph.UNDEF _ => error ("Unknown statement name: " ^ labelled_name name);
haftmann@38970
   147
haftmann@38970
   148
  in { deresolver = deresolver, hierarchical_program = hierarchical_program } end;
haftmann@38970
   149
haftmann@39147
   150
fun print_hierarchical { print_module, print_stmt, lift_markup } =
haftmann@39147
   151
  let
haftmann@39147
   152
    fun print_node _ (_, Dummy) =
haftmann@39147
   153
          NONE
haftmann@39147
   154
      | print_node prefix_fragments (name, Stmt stmt) =
haftmann@39147
   155
          SOME (lift_markup (Code_Printer.markup_stmt name)
haftmann@39147
   156
            (print_stmt prefix_fragments (name, stmt)))
haftmann@39147
   157
      | print_node prefix_fragments (name_fragment, Module (data, nodes)) =
haftmann@39147
   158
          let
haftmann@39147
   159
            val prefix_fragments' = prefix_fragments @ [name_fragment]
haftmann@39147
   160
          in
haftmann@39147
   161
            Option.map (print_module prefix_fragments'
haftmann@39147
   162
              name_fragment data) (print_nodes prefix_fragments' nodes)
haftmann@39147
   163
          end
haftmann@39147
   164
    and print_nodes prefix_fragments nodes =
haftmann@39147
   165
      let
haftmann@39147
   166
        val xs = (map_filter (fn name => print_node prefix_fragments
haftmann@39147
   167
          (name, snd (Graph.get_node nodes name))) o rev o flat o Graph.strong_conn) nodes
haftmann@39147
   168
      in if null xs then NONE else SOME xs end;
haftmann@39147
   169
  in these o print_nodes [] end;
haftmann@39147
   170
haftmann@38970
   171
end;