src/Pure/Thy/export.ML
author wenzelm
Mon, 25 Mar 2019 17:21:26 +0100
changeset 69981 3dced198b9ec
parent 69788 c175499a7537
child 70009 435fb018e8ee
permissions -rw-r--r--
more strict AFP properties;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
68090
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
     1
(*  Title:      Pure/Thy/export.ML
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
     3
68102
813b5d0904c6 clarified signature;
wenzelm
parents: 68101
diff changeset
     4
Manage theory exports: compressed blobs.
68090
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
     5
*)
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
     6
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
     7
signature EXPORT =
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
     8
sig
69788
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
     9
  type params = {theory: theory, path: Path.T, executable: bool, compress: bool}
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    10
  val export_params: params -> string list -> unit
69784
24bbc4e30e5b clarified signature: Path.T as in Generated_Files;
wenzelm
parents: 69650
diff changeset
    11
  val export: theory -> Path.T -> string list -> unit
69788
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    12
  val export_executable: theory -> Path.T -> string list -> unit
69650
c95edf19133b clarified message;
wenzelm
parents: 69648
diff changeset
    13
  val markup: theory -> string -> Markup.T
c95edf19133b clarified message;
wenzelm
parents: 69648
diff changeset
    14
  val message: theory -> string -> string
68090
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    15
end;
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    16
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    17
structure Export: EXPORT =
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    18
struct
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    19
69648
97ddaec3e2ae support hyperlink to theory exports;
wenzelm
parents: 69627
diff changeset
    20
(* export *)
97ddaec3e2ae support hyperlink to theory exports;
wenzelm
parents: 69627
diff changeset
    21
69784
24bbc4e30e5b clarified signature: Path.T as in Generated_Files;
wenzelm
parents: 69650
diff changeset
    22
fun check_name path =
68105
577072a0ceed more checks;
wenzelm
parents: 68102
diff changeset
    23
  let
69784
24bbc4e30e5b clarified signature: Path.T as in Generated_Files;
wenzelm
parents: 69650
diff changeset
    24
    val name = Path.implode path;
69627
3e26471d6d01 clarified Path.check_elem;
wenzelm
parents: 68167
diff changeset
    25
    val _ =
69784
24bbc4e30e5b clarified signature: Path.T as in Generated_Files;
wenzelm
parents: 69650
diff changeset
    26
      if not (Path.is_current path) andalso Path.all_basic path then ()
24bbc4e30e5b clarified signature: Path.T as in Generated_Files;
wenzelm
parents: 69650
diff changeset
    27
      else error ("Bad export name: " ^ quote name);
68105
577072a0ceed more checks;
wenzelm
parents: 68102
diff changeset
    28
  in name end;
577072a0ceed more checks;
wenzelm
parents: 68102
diff changeset
    29
69788
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    30
type params = {theory: theory, path: Path.T, executable: bool, compress: bool};
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    31
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    32
fun export_params ({theory, path, executable, compress}: params) blob =
68090
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    33
  (Output.try_protocol_message o Markup.export)
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    34
   {id = Position.get_id (Position.thread_data ()),
68101
0699a0bacc50 store exports within PIDE command state;
wenzelm
parents: 68090
diff changeset
    35
    serial = serial (),
69788
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    36
    theory_name = Context.theory_long_name theory,
69784
24bbc4e30e5b clarified signature: Path.T as in Generated_Files;
wenzelm
parents: 69650
diff changeset
    37
    name = check_name path,
69788
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    38
    executable = executable,
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    39
    compress = compress} blob;
68090
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    40
69788
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    41
fun export theory path blob =
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    42
  export_params {theory = theory, path = path, executable = false, compress = true} blob;
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    43
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    44
fun export_executable theory path blob =
c175499a7537 added executable flag for exports;
wenzelm
parents: 69784
diff changeset
    45
  export_params {theory = theory, path = path, executable = true, compress = true} blob;
68090
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    46
69648
97ddaec3e2ae support hyperlink to theory exports;
wenzelm
parents: 69627
diff changeset
    47
97ddaec3e2ae support hyperlink to theory exports;
wenzelm
parents: 69627
diff changeset
    48
(* information message *)
97ddaec3e2ae support hyperlink to theory exports;
wenzelm
parents: 69627
diff changeset
    49
69650
c95edf19133b clarified message;
wenzelm
parents: 69648
diff changeset
    50
fun markup thy s =
c95edf19133b clarified message;
wenzelm
parents: 69648
diff changeset
    51
  let val name = (Markup.nameN, Context.theory_long_name thy ^ (if s = "" then "" else "/" ^ s))
c95edf19133b clarified message;
wenzelm
parents: 69648
diff changeset
    52
  in Active.make_markup Markup.theory_exportsN {implicit = false, properties = [name]} end;
69648
97ddaec3e2ae support hyperlink to theory exports;
wenzelm
parents: 69627
diff changeset
    53
69650
c95edf19133b clarified message;
wenzelm
parents: 69648
diff changeset
    54
fun message thy s =
c95edf19133b clarified message;
wenzelm
parents: 69648
diff changeset
    55
  "See " ^ Markup.markup (markup thy s) "theory exports";
69648
97ddaec3e2ae support hyperlink to theory exports;
wenzelm
parents: 69627
diff changeset
    56
68090
7c8ed28dd40a tuned signature;
wenzelm
parents:
diff changeset
    57
end;