src/Tools/Code/code_namespace.ML
author haftmann
Sun Feb 23 10:33:43 2014 +0100 (2014-02-23)
changeset 55679 59244fc1a7ca
parent 55605 b1b363e81c87
child 55680 bc5edc5dbf18
permissions -rw-r--r--
formal markup for public ingredients
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@39208
     9
  type flat_program
haftmann@55147
    10
  val flat_program: Proof.context
haftmann@52138
    11
    -> { module_prefix: string, module_name: string,
haftmann@52138
    12
    reserved: Name.context, identifiers: Code_Target.identifier_data, empty_nsp: 'a,
haftmann@39208
    13
    namify_stmt: Code_Thingol.stmt -> string -> 'a -> string * 'a,
haftmann@39208
    14
    modify_stmt: Code_Thingol.stmt -> Code_Thingol.stmt option }
haftmann@39208
    15
      -> Code_Thingol.program
haftmann@55150
    16
      -> { deresolver: string -> Code_Symbol.T -> string,
haftmann@39208
    17
           flat_program: flat_program }
haftmann@39208
    18
haftmann@39017
    19
  datatype ('a, 'b) node =
haftmann@38970
    20
      Dummy
haftmann@55679
    21
    | Stmt of bool * 'a
haftmann@55147
    22
    | Module of ('b * (string * ('a, 'b) node) Code_Symbol.Graph.T)
haftmann@39208
    23
  type ('a, 'b) hierarchical_program
haftmann@55147
    24
  val hierarchical_program: Proof.context
haftmann@52138
    25
    -> { module_name: string,
haftmann@52138
    26
    reserved: Name.context, identifiers: Code_Target.identifier_data,
haftmann@52138
    27
    empty_nsp: 'c, namify_module: string -> 'c -> string * 'c,
haftmann@39022
    28
    namify_stmt: Code_Thingol.stmt -> string -> 'c -> string * 'c,
haftmann@55150
    29
    cyclic_modules: bool, empty_data: 'b, memorize_data: Code_Symbol.T -> 'b -> 'b,
haftmann@55150
    30
    modify_stmts: (Code_Symbol.T * Code_Thingol.stmt) list -> 'a option list }
haftmann@38970
    31
      -> Code_Thingol.program
haftmann@55150
    32
      -> { deresolver: string list -> Code_Symbol.T -> string,
haftmann@39147
    33
           hierarchical_program: ('a, 'b) hierarchical_program }
haftmann@39147
    34
  val print_hierarchical: { print_module: string list -> string -> 'b -> 'c list -> 'c,
haftmann@55679
    35
    print_stmt: string list -> Code_Symbol.T * (bool * 'a) -> 'c,
haftmann@39147
    36
    lift_markup: (Pretty.T -> Pretty.T) -> 'c -> 'c }
haftmann@39147
    37
      -> ('a, 'b) hierarchical_program -> 'c list
haftmann@38970
    38
end;
haftmann@38970
    39
haftmann@38970
    40
structure Code_Namespace : CODE_NAMESPACE =
haftmann@38970
    41
struct
haftmann@38970
    42
haftmann@52138
    43
(** fundamental module name hierarchy **)
haftmann@52138
    44
haftmann@55291
    45
fun module_fragments' { identifiers, reserved } name =
haftmann@55291
    46
  case Code_Symbol.lookup_module_data identifiers name of
haftmann@55291
    47
      SOME (fragments, _) => fragments
haftmann@55291
    48
    | NONE => map (fn fragment => fst (Name.variant fragment reserved)) (Long_Name.explode name);
haftmann@55291
    49
haftmann@55291
    50
fun module_fragments { module_name, identifiers, reserved } =
haftmann@55291
    51
  if module_name = ""
haftmann@55291
    52
  then module_fragments' { identifiers = identifiers, reserved = reserved }
haftmann@55291
    53
  else K (Long_Name.explode module_name);
haftmann@39055
    54
haftmann@55291
    55
fun build_module_namespace ctxt { module_prefix, module_name, identifiers, reserved } program =
haftmann@55291
    56
  let
haftmann@55291
    57
    val module_names = Code_Symbol.Graph.fold (insert (op =) o Code_Symbol.default_prefix ctxt o fst) program [];
haftmann@55291
    58
    val module_fragments' = module_fragments
haftmann@55291
    59
      { module_name = module_name, identifiers = identifiers, reserved = reserved };
haftmann@55291
    60
  in
haftmann@55291
    61
    fold (fn name => Symtab.update (name, Long_Name.explode module_prefix @ module_fragments' name))
haftmann@55291
    62
      module_names Symtab.empty
haftmann@55291
    63
  end;
haftmann@55291
    64
haftmann@55292
    65
fun prep_symbol ctxt { module_namespace, force_module, identifiers } sym =
haftmann@55291
    66
  case Code_Symbol.lookup identifiers sym of
haftmann@55292
    67
      NONE => ((the o Symtab.lookup module_namespace o Code_Symbol.default_prefix ctxt) sym,
haftmann@55292
    68
        Code_Symbol.default_base sym)
haftmann@53414
    69
    | SOME prefix_name => if null force_module then prefix_name
haftmann@53414
    70
        else (force_module, snd prefix_name);
haftmann@39055
    71
haftmann@55293
    72
fun has_priority identifiers = is_some o Code_Symbol.lookup identifiers;
haftmann@55293
    73
haftmann@55292
    74
fun build_proto_program { empty, add_stmt, add_dep } program =
haftmann@55292
    75
  empty
haftmann@55292
    76
  |> Code_Symbol.Graph.fold (fn (sym, (stmt, _)) => add_stmt sym stmt) program
haftmann@55292
    77
  |> Code_Symbol.Graph.fold (fn (sym, (_, (_, syms))) =>
haftmann@55292
    78
      Code_Symbol.Graph.Keys.fold (add_dep sym) syms) program;
haftmann@55292
    79
haftmann@55293
    80
fun prioritize has_priority = uncurry append o List.partition has_priority;
haftmann@55293
    81
haftmann@39055
    82
haftmann@39208
    83
(** flat program structure **)
haftmann@39208
    84
haftmann@55679
    85
type flat_program = ((string * (bool * Code_Thingol.stmt) option) Code_Symbol.Graph.T * (string * Code_Symbol.T list) list) Graph.T;
haftmann@39208
    86
haftmann@55147
    87
fun flat_program ctxt { module_prefix, module_name, reserved,
haftmann@52138
    88
    identifiers, empty_nsp, namify_stmt, modify_stmt } program =
haftmann@39208
    89
  let
haftmann@39208
    90
haftmann@39208
    91
    (* building module name hierarchy *)
haftmann@55291
    92
    val module_namespace = build_module_namespace ctxt { module_prefix = module_prefix,
haftmann@55291
    93
      module_name = module_name, identifiers = identifiers, reserved = reserved } program;
haftmann@55292
    94
    val prep_sym = prep_symbol ctxt { module_namespace = module_namespace,
haftmann@55292
    95
      force_module = Long_Name.explode module_name, identifiers = identifiers }
haftmann@52138
    96
      #>> Long_Name.implode;
haftmann@55293
    97
    val sym_priority = has_priority identifiers;
haftmann@39208
    98
haftmann@39208
    99
    (* distribute statements over hierarchy *)
haftmann@55147
   100
    fun add_stmt sym stmt =
haftmann@39208
   101
      let
haftmann@55147
   102
        val (module_name, base) = prep_sym sym;
haftmann@39208
   103
      in
haftmann@55147
   104
        Graph.default_node (module_name, (Code_Symbol.Graph.empty, []))
haftmann@55679
   105
        #> (Graph.map_node module_name o apfst) (Code_Symbol.Graph.new_node (sym, (base, (true, stmt))))
haftmann@39208
   106
      end;
haftmann@55292
   107
    fun add_dep sym sym' =
haftmann@39208
   108
      let
haftmann@55147
   109
        val (module_name, _) = prep_sym sym;
haftmann@55147
   110
        val (module_name', _) = prep_sym sym';
haftmann@39208
   111
      in if module_name = module_name'
haftmann@55147
   112
        then (Graph.map_node module_name o apfst) (Code_Symbol.Graph.add_edge (sym, sym'))
haftmann@55147
   113
        else (Graph.map_node module_name o apsnd) (AList.map_default (op =) (module_name', []) (insert (op =) sym'))
haftmann@39208
   114
      end;
haftmann@55292
   115
    val proto_program = build_proto_program
haftmann@55292
   116
      { empty = Graph.empty, add_stmt = add_stmt, add_dep = add_dep } program;
haftmann@39208
   117
haftmann@39208
   118
    (* name declarations and statement modifications *)
haftmann@55679
   119
    fun declare sym (base, (_, stmt)) (gr, nsp) = 
haftmann@39208
   120
      let
haftmann@39208
   121
        val (base', nsp') = namify_stmt stmt base nsp;
haftmann@55147
   122
        val gr' = (Code_Symbol.Graph.map_node sym o apfst) (K base') gr;
haftmann@39208
   123
      in (gr', nsp') end;
haftmann@39208
   124
    fun declarations gr = (gr, empty_nsp)
haftmann@55293
   125
      |> fold (fn sym => declare sym (Code_Symbol.Graph.get_node gr sym))
haftmann@55293
   126
          (prioritize sym_priority (Code_Symbol.Graph.keys gr))
haftmann@39208
   127
      |> fst
haftmann@55679
   128
      |> (Code_Symbol.Graph.map o K o apsnd)
haftmann@55679
   129
        (fn (export, stmt) => Option.map (pair export) (modify_stmt stmt));
haftmann@39208
   130
    val flat_program = proto_program
haftmann@39208
   131
      |> (Graph.map o K o apfst) declarations;
haftmann@39208
   132
haftmann@39208
   133
    (* qualified and unqualified imports, deresolving *)
haftmann@55147
   134
    fun base_deresolver sym = fst (Code_Symbol.Graph.get_node
haftmann@55147
   135
      (fst (Graph.get_node flat_program (fst (prep_sym sym)))) sym);
haftmann@39208
   136
    fun classify_names gr imports =
haftmann@39208
   137
      let
haftmann@39208
   138
        val import_tab = maps
haftmann@55147
   139
          (fn (module_name, syms) => map (rpair module_name) syms) imports;
haftmann@55147
   140
        val imported_syms = map fst import_tab;
haftmann@55147
   141
        val here_syms = Code_Symbol.Graph.keys gr;
haftmann@39208
   142
      in
haftmann@55147
   143
        Code_Symbol.Table.empty
haftmann@55147
   144
        |> fold (fn sym => Code_Symbol.Table.update (sym, base_deresolver sym)) here_syms
haftmann@55147
   145
        |> fold (fn sym => Code_Symbol.Table.update (sym,
haftmann@55147
   146
            Long_Name.append (the (AList.lookup (op =) import_tab sym))
haftmann@55147
   147
              (base_deresolver sym))) imported_syms
haftmann@39208
   148
      end;
haftmann@40630
   149
    val deresolver_tab = Symtab.make (AList.make
haftmann@40630
   150
      (uncurry classify_names o Graph.get_node flat_program)
haftmann@40630
   151
        (Graph.keys flat_program));
haftmann@55147
   152
    fun deresolver "" sym =
haftmann@55147
   153
          Long_Name.append (fst (prep_sym sym)) (base_deresolver sym)
haftmann@55147
   154
      | deresolver module_name sym =
haftmann@55147
   155
          the (Code_Symbol.Table.lookup (the (Symtab.lookup deresolver_tab module_name)) sym)
haftmann@52138
   156
          handle Option.Option => error ("Unknown statement name: "
haftmann@55147
   157
            ^ Code_Symbol.quote ctxt sym);
haftmann@39208
   158
haftmann@39208
   159
  in { deresolver = deresolver, flat_program = flat_program } end;
haftmann@39208
   160
haftmann@39208
   161
haftmann@39055
   162
(** hierarchical program structure **)
haftmann@38970
   163
haftmann@39017
   164
datatype ('a, 'b) node =
haftmann@38970
   165
    Dummy
haftmann@55679
   166
  | Stmt of bool * 'a
haftmann@55147
   167
  | Module of ('b * (string * ('a, 'b) node) Code_Symbol.Graph.T);
haftmann@38970
   168
haftmann@55147
   169
type ('a, 'b) hierarchical_program = (string * ('a, 'b) node) Code_Symbol.Graph.T;
haftmann@39147
   170
haftmann@55679
   171
fun the_stmt (Stmt (export, stmt)) = (export, stmt);
haftmann@55679
   172
haftmann@39018
   173
fun map_module_content f (Module content) = Module (f content);
haftmann@39018
   174
haftmann@39018
   175
fun map_module [] = I
haftmann@39018
   176
  | map_module (name_fragment :: name_fragments) =
haftmann@55147
   177
      apsnd o Code_Symbol.Graph.map_node (Code_Symbol.Module name_fragment) o apsnd o map_module_content
haftmann@39018
   178
        o map_module name_fragments;
haftmann@39018
   179
haftmann@55147
   180
fun hierarchical_program ctxt { module_name, reserved, identifiers, empty_nsp,
haftmann@39023
   181
      namify_module, namify_stmt, cyclic_modules, empty_data, memorize_data, modify_stmts } program =
haftmann@38970
   182
  let
haftmann@38970
   183
haftmann@38970
   184
    (* building module name hierarchy *)
haftmann@55291
   185
    val module_namespace = build_module_namespace ctxt { module_prefix = "",
haftmann@55291
   186
      module_name = module_name, identifiers = identifiers, reserved = reserved } program;
haftmann@55292
   187
    val prep_sym = prep_symbol ctxt { module_namespace = module_namespace,
haftmann@55293
   188
      force_module = Long_Name.explode module_name, identifiers = identifiers }
haftmann@55293
   189
    val sym_priority = has_priority identifiers;
haftmann@38970
   190
haftmann@38970
   191
    (* building empty module hierarchy *)
haftmann@55147
   192
    val empty_module = (empty_data, Code_Symbol.Graph.empty);
haftmann@38970
   193
    fun ensure_module name_fragment (data, nodes) =
haftmann@55147
   194
      if can (Code_Symbol.Graph.get_node nodes) (Code_Symbol.Module name_fragment) then (data, nodes)
haftmann@38970
   195
      else (data,
haftmann@55147
   196
        nodes |> Code_Symbol.Graph.new_node (Code_Symbol.Module name_fragment, (name_fragment, Module empty_module)));
haftmann@38970
   197
    fun allocate_module [] = I
haftmann@38970
   198
      | allocate_module (name_fragment :: name_fragments) =
haftmann@38970
   199
          ensure_module name_fragment
haftmann@55147
   200
          #> (apsnd o Code_Symbol.Graph.map_node (Code_Symbol.Module name_fragment) o apsnd o map_module_content o allocate_module) name_fragments;
haftmann@52138
   201
    val empty_program =
haftmann@52138
   202
      empty_module
haftmann@55291
   203
      |> Symtab.fold (fn (_, fragments) => allocate_module fragments) module_namespace
haftmann@55147
   204
      |> Code_Symbol.Graph.fold (allocate_module o these o Option.map fst
haftmann@55291
   205
          o Code_Symbol.lookup identifiers o fst) program;
haftmann@38970
   206
haftmann@38970
   207
    (* distribute statements over hierarchy *)
haftmann@55147
   208
    fun add_stmt sym stmt =
haftmann@38970
   209
      let
haftmann@55147
   210
        val (name_fragments, base) = prep_sym sym;
haftmann@38970
   211
      in
haftmann@55679
   212
        (map_module name_fragments o apsnd) (Code_Symbol.Graph.new_node (sym, (base, Stmt (true, stmt))))
haftmann@38970
   213
      end;
haftmann@55292
   214
    fun add_dep sym sym' =
haftmann@38970
   215
      let
haftmann@55147
   216
        val (name_fragments, _) = prep_sym sym;
haftmann@55147
   217
        val (name_fragments', _) = prep_sym sym';
haftmann@38970
   218
        val (name_fragments_common, (diff, diff')) =
haftmann@38970
   219
          chop_prefix (op =) (name_fragments, name_fragments');
haftmann@39023
   220
        val is_module = not (null diff andalso null diff');
haftmann@55147
   221
        val dep = pairself hd (map Code_Symbol.Module diff @ [sym], map Code_Symbol.Module diff' @ [sym']);
haftmann@38970
   222
        val add_edge = if is_module andalso not cyclic_modules
haftmann@55147
   223
          then (fn node => Code_Symbol.Graph.add_edge_acyclic dep node
haftmann@38970
   224
            handle Graph.CYCLES _ => error ("Dependency "
haftmann@55147
   225
              ^ Code_Symbol.quote ctxt sym ^ " -> "
haftmann@55147
   226
              ^ Code_Symbol.quote ctxt sym'
haftmann@38970
   227
              ^ " would result in module dependency cycle"))
haftmann@55147
   228
          else Code_Symbol.Graph.add_edge dep
haftmann@39018
   229
      in (map_module name_fragments_common o apsnd) add_edge end;
haftmann@55292
   230
    val proto_program = build_proto_program
haftmann@55292
   231
      { empty = empty_program, add_stmt = add_stmt, add_dep = add_dep } program;
haftmann@38970
   232
haftmann@39022
   233
    (* name declarations, data and statement modifications *)
haftmann@38970
   234
    fun make_declarations nsps (data, nodes) =
haftmann@38970
   235
      let
haftmann@55293
   236
        val (module_fragments, stmt_syms) =
haftmann@55293
   237
          Code_Symbol.Graph.keys nodes
haftmann@55293
   238
          |> List.partition
haftmann@55293
   239
              (fn sym => case Code_Symbol.Graph.get_node nodes sym
haftmann@55293
   240
                of (_, Module _) => true | _ => false)
haftmann@55293
   241
          |> pairself (prioritize sym_priority)
haftmann@55147
   242
        fun declare namify sym (nsps, nodes) =
haftmann@38970
   243
          let
haftmann@55147
   244
            val (base, node) = Code_Symbol.Graph.get_node nodes sym;
haftmann@38970
   245
            val (base', nsps') = namify node base nsps;
haftmann@55147
   246
            val nodes' = Code_Symbol.Graph.map_node sym (K (base', node)) nodes;
haftmann@38970
   247
          in (nsps', nodes') end;
haftmann@38970
   248
        val (nsps', nodes') = (nsps, nodes)
haftmann@39022
   249
          |> fold (declare (K namify_module)) module_fragments
haftmann@55679
   250
          |> fold (declare (namify_stmt o snd o the_stmt)) stmt_syms;
haftmann@55147
   251
        fun select_syms syms = case filter (member (op =) stmt_syms) syms
haftmann@39029
   252
         of [] => NONE
haftmann@55147
   253
          | syms => SOME syms;
haftmann@55679
   254
        fun select_stmt (sym, (export, SOME stmt)) = SOME (sym, (export, stmt))
haftmann@55605
   255
          | select_stmt _ = NONE;
haftmann@55605
   256
        fun modify_stmts' syms =
haftmann@55605
   257
          let
haftmann@55679
   258
            val (exports, stmts) = map_split (the_stmt o snd o Code_Symbol.Graph.get_node nodes) syms;
haftmann@55605
   259
            val stmts' = modify_stmts (syms ~~ stmts);
haftmann@55605
   260
            val stmts'' = stmts' @ replicate (length syms - length stmts') NONE;
haftmann@55679
   261
          in map_filter select_stmt (syms ~~ (exports ~~ stmts'')) end;
haftmann@55147
   262
        val stmtss' = (maps modify_stmts' o map_filter select_syms o Code_Symbol.Graph.strong_conn) nodes;
haftmann@55147
   263
        val nodes'' = Code_Symbol.Graph.map (fn sym => apsnd (fn Module content => Module (make_declarations nsps' content)
haftmann@55605
   264
            | _ => case AList.lookup (op =) stmtss' sym of SOME stmt => Stmt stmt | _ => Dummy)) nodes';
haftmann@55147
   265
        val data' = fold memorize_data stmt_syms data;
haftmann@39018
   266
      in (data', nodes'') end;
haftmann@38970
   267
    val (_, hierarchical_program) = make_declarations empty_nsp proto_program;
haftmann@38970
   268
haftmann@38970
   269
    (* deresolving *)
haftmann@55147
   270
    fun deresolver prefix_fragments sym =
haftmann@38970
   271
      let
haftmann@55147
   272
        val (name_fragments, _) = prep_sym sym;
haftmann@38970
   273
        val (_, (_, remainder)) = chop_prefix (op =) (prefix_fragments, name_fragments);
haftmann@55147
   274
        val nodes = fold (fn name_fragment => fn nodes => case Code_Symbol.Graph.get_node nodes (Code_Symbol.Module name_fragment)
haftmann@38970
   275
         of (_, Module (_, nodes)) => nodes) name_fragments hierarchical_program;
haftmann@55147
   276
        val (base', _) = Code_Symbol.Graph.get_node nodes sym;
haftmann@38970
   277
      in Long_Name.implode (remainder @ [base']) end
haftmann@55147
   278
        handle Code_Symbol.Graph.UNDEF _ => error ("Unknown statement name: "
haftmann@55147
   279
          ^ Code_Symbol.quote ctxt sym);
haftmann@38970
   280
haftmann@38970
   281
  in { deresolver = deresolver, hierarchical_program = hierarchical_program } end;
haftmann@38970
   282
haftmann@39147
   283
fun print_hierarchical { print_module, print_stmt, lift_markup } =
haftmann@39147
   284
  let
haftmann@39147
   285
    fun print_node _ (_, Dummy) =
haftmann@39147
   286
          NONE
haftmann@55147
   287
      | print_node prefix_fragments (sym, Stmt stmt) =
haftmann@55147
   288
          SOME (lift_markup (Code_Printer.markup_stmt sym)
haftmann@55147
   289
            (print_stmt prefix_fragments (sym, stmt)))
haftmann@55147
   290
      | print_node prefix_fragments (Code_Symbol.Module name_fragment, Module (data, nodes)) =
haftmann@39147
   291
          let
haftmann@39147
   292
            val prefix_fragments' = prefix_fragments @ [name_fragment]
haftmann@39147
   293
          in
haftmann@39147
   294
            Option.map (print_module prefix_fragments'
haftmann@39147
   295
              name_fragment data) (print_nodes prefix_fragments' nodes)
haftmann@39147
   296
          end
haftmann@39147
   297
    and print_nodes prefix_fragments nodes =
haftmann@39147
   298
      let
haftmann@55147
   299
        val xs = (map_filter (fn sym => print_node prefix_fragments
haftmann@55147
   300
          (sym, snd (Code_Symbol.Graph.get_node nodes sym))) o rev o flat o Code_Symbol.Graph.strong_conn) nodes
haftmann@39147
   301
      in if null xs then NONE else SOME xs end;
haftmann@39147
   302
  in these o print_nodes [] end;
haftmann@39147
   303
haftmann@55147
   304
end;