src/Pure/Isar/toplevel.ML
author wenzelm
Wed, 03 Sep 2008 11:26:59 +0200
changeset 28105 44054657ea56
parent 28103 b79e61861f0f
child 28394 b9c8e3a12a98
permissions -rw-r--r--
added pos_of;
wenzelm@5828
     1
(*  Title:      Pure/Isar/toplevel.ML
wenzelm@5828
     2
    ID:         $Id$
wenzelm@5828
     3
    Author:     Markus Wenzel, TU Muenchen
wenzelm@5828
     4
wenzelm@26602
     5
Isabelle/Isar toplevel transactions.
wenzelm@5828
     6
*)
wenzelm@5828
     7
wenzelm@5828
     8
signature TOPLEVEL =
wenzelm@5828
     9
sig
wenzelm@19063
    10
  exception UNDEF
wenzelm@20963
    11
  type generic_theory
wenzelm@18589
    12
  type node
wenzelm@20963
    13
  val theory_node: node -> generic_theory option
wenzelm@27564
    14
  val proof_node: node -> ProofNode.T option
wenzelm@20963
    15
  val cases_node: (generic_theory -> 'a) -> (Proof.state -> 'a) -> node -> 'a
wenzelm@20963
    16
  val presentation_context: node option -> xstring option -> Proof.context
wenzelm@5828
    17
  type state
wenzelm@26602
    18
  val toplevel: state
wenzelm@7732
    19
  val is_toplevel: state -> bool
wenzelm@18589
    20
  val is_theory: state -> bool
wenzelm@18589
    21
  val is_proof: state -> bool
wenzelm@17076
    22
  val level: state -> int
wenzelm@27576
    23
  val previous_node_of: state -> node option
wenzelm@5828
    24
  val node_of: state -> node
wenzelm@20963
    25
  val node_case: (generic_theory -> 'a) -> (Proof.state -> 'a) -> state -> 'a
wenzelm@21506
    26
  val context_of: state -> Proof.context
wenzelm@22089
    27
  val generic_theory_of: state -> generic_theory
wenzelm@5828
    28
  val theory_of: state -> theory
wenzelm@5828
    29
  val proof_of: state -> Proof.state
wenzelm@18589
    30
  val proof_position_of: state -> int
wenzelm@21007
    31
  val enter_proof_body: state -> Proof.state
wenzelm@16815
    32
  val print_state_context: state -> unit
wenzelm@16815
    33
  val print_state: bool -> state -> unit
wenzelm@16682
    34
  val quiet: bool ref
wenzelm@16682
    35
  val debug: bool ref
wenzelm@17321
    36
  val interact: bool ref
wenzelm@16682
    37
  val timing: bool ref
wenzelm@16682
    38
  val profiling: int ref
wenzelm@16815
    39
  val skip_proofs: bool ref
wenzelm@5828
    40
  exception TERMINATE
wenzelm@27583
    41
  exception TOPLEVEL_ERROR
wenzelm@26256
    42
  exception CONTEXT of Proof.context * exn
wenzelm@20128
    43
  val exn_message: exn -> string
wenzelm@20128
    44
  val program: (unit -> 'a) -> 'a
wenzelm@16682
    45
  type transition
wenzelm@5828
    46
  val empty: transition
wenzelm@27441
    47
  val init_of: transition -> string option
wenzelm@27427
    48
  val name_of: transition -> string
wenzelm@28105
    49
  val pos_of: transition -> Position.T
wenzelm@27500
    50
  val str_of: transition -> string
wenzelm@5828
    51
  val name: string -> transition -> transition
wenzelm@5828
    52
  val position: Position.T -> transition -> transition
wenzelm@5828
    53
  val interactive: bool -> transition -> transition
wenzelm@5828
    54
  val print: transition -> transition
wenzelm@9010
    55
  val no_timing: transition -> transition
wenzelm@27576
    56
  val init_theory: string -> (bool -> theory) -> (theory -> unit) -> transition -> transition
wenzelm@6689
    57
  val exit: transition -> transition
wenzelm@5828
    58
  val keep: (state -> unit) -> transition -> transition
wenzelm@7612
    59
  val keep': (bool -> state -> unit) -> transition -> transition
wenzelm@5828
    60
  val imperative: (unit -> unit) -> transition -> transition
wenzelm@27840
    61
  val ignored: Position.T -> transition
wenzelm@27840
    62
  val malformed: Position.T -> string -> transition
wenzelm@5828
    63
  val theory: (theory -> theory) -> transition -> transition
wenzelm@26491
    64
  val generic_theory: (generic_theory -> generic_theory) -> transition -> transition
wenzelm@7612
    65
  val theory': (bool -> theory -> theory) -> transition -> transition
wenzelm@20985
    66
  val begin_local_theory: bool -> (theory -> local_theory) -> transition -> transition
wenzelm@21007
    67
  val end_local_theory: transition -> transition
wenzelm@20963
    68
  val local_theory: xstring option -> (local_theory -> local_theory) -> transition -> transition
wenzelm@27859
    69
  val present_local_theory: xstring option -> (node -> unit) -> transition -> transition
berghofe@24453
    70
  val local_theory_to_proof': xstring option -> (bool -> local_theory -> Proof.state) ->
berghofe@24453
    71
    transition -> transition
wenzelm@21007
    72
  val local_theory_to_proof: xstring option -> (local_theory -> Proof.state) ->
wenzelm@21007
    73
    transition -> transition
wenzelm@17363
    74
  val theory_to_proof: (theory -> Proof.state) -> transition -> transition
wenzelm@21007
    75
  val end_proof: (bool -> Proof.state -> Proof.context) -> transition -> transition
wenzelm@21007
    76
  val forget_proof: transition -> transition
wenzelm@27859
    77
  val present_proof: (node -> unit) -> transition -> transition
wenzelm@21177
    78
  val proofs': (bool -> Proof.state -> Proof.state Seq.seq) -> transition -> transition
wenzelm@21177
    79
  val proof': (bool -> Proof.state -> Proof.state) -> transition -> transition
wenzelm@21177
    80
  val proofs: (Proof.state -> Proof.state Seq.seq) -> transition -> transition
wenzelm@17904
    81
  val proof: (Proof.state -> Proof.state) -> transition -> transition
wenzelm@27564
    82
  val actual_proof: (ProofNode.T -> ProofNode.T) -> transition -> transition
wenzelm@27564
    83
  val skip_proof: (int -> int) -> transition -> transition
wenzelm@17904
    84
  val skip_proof_to_theory: (int -> bool) -> transition -> transition
wenzelm@27427
    85
  val get_id: transition -> string option
wenzelm@27427
    86
  val put_id: string -> transition -> transition
wenzelm@9512
    87
  val unknown_theory: transition -> transition
wenzelm@9512
    88
  val unknown_proof: transition -> transition
wenzelm@9512
    89
  val unknown_context: transition -> transition
wenzelm@27606
    90
  val status: transition -> Markup.T -> unit
wenzelm@26602
    91
  val error_msg: transition -> exn * string -> unit
wenzelm@28103
    92
  val add_hook: (transition -> state -> state -> unit) -> unit
wenzelm@26602
    93
  val transition: bool -> transition -> state -> (state * (exn * string) option) option
wenzelm@27601
    94
  val commit_exit: transition
wenzelm@27601
    95
  val excursion: transition list -> unit
wenzelm@17076
    96
  val present_excursion: (transition * (state -> state -> 'a -> 'a)) list -> 'a -> 'a
wenzelm@5828
    97
end;
wenzelm@5828
    98
wenzelm@6965
    99
structure Toplevel: TOPLEVEL =
wenzelm@5828
   100
struct
wenzelm@5828
   101
wenzelm@5828
   102
(** toplevel state **)
wenzelm@5828
   103
wenzelm@19063
   104
exception UNDEF;
wenzelm@19063
   105
wenzelm@19063
   106
wenzelm@21294
   107
(* local theory wrappers *)
wenzelm@5828
   108
wenzelm@20963
   109
type generic_theory = Context.generic;    (*theory or local_theory*)
wenzelm@20963
   110
wenzelm@25292
   111
val loc_init = TheoryTarget.context;
wenzelm@21294
   112
val loc_exit = ProofContext.theory_of o LocalTheory.exit;
wenzelm@21294
   113
wenzelm@25292
   114
fun loc_begin loc (Context.Theory thy) = loc_init (the_default "-" loc) thy
wenzelm@21294
   115
  | loc_begin NONE (Context.Proof lthy) = lthy
haftmann@25269
   116
  | loc_begin (SOME loc) (Context.Proof lthy) = loc_init loc (loc_exit lthy);
wenzelm@21294
   117
wenzelm@21294
   118
fun loc_finish _ (Context.Theory _) = Context.Theory o loc_exit
wenzelm@21294
   119
  | loc_finish NONE (Context.Proof _) = Context.Proof o LocalTheory.restore
wenzelm@25292
   120
  | loc_finish (SOME _) (Context.Proof lthy) = fn lthy' =>
wenzelm@25292
   121
      Context.Proof (LocalTheory.reinit (LocalTheory.raw_theory (K (loc_exit lthy')) lthy));
wenzelm@21294
   122
wenzelm@21294
   123
wenzelm@21958
   124
(* datatype node *)
wenzelm@21294
   125
wenzelm@5828
   126
datatype node =
wenzelm@27576
   127
  Theory of generic_theory * Proof.context option
wenzelm@27576
   128
    (*theory with presentation context*) |
wenzelm@27576
   129
  Proof of ProofNode.T * ((Proof.context -> generic_theory) * generic_theory)
wenzelm@27576
   130
    (*proof node, finish, original theory*) |
wenzelm@27564
   131
  SkipProof of int * (generic_theory * generic_theory);
wenzelm@27564
   132
    (*proof depth, resulting theory, original theory*)
wenzelm@5828
   133
wenzelm@22056
   134
val the_global_theory = fn Theory (Context.Theory thy, _) => thy | _ => raise UNDEF;
wenzelm@20963
   135
val theory_node = fn Theory (gthy, _) => SOME gthy | _ => NONE;
wenzelm@18589
   136
val proof_node = fn Proof (prf, _) => SOME prf | _ => NONE;
wenzelm@18589
   137
wenzelm@20963
   138
fun cases_node f _ (Theory (gthy, _)) = f gthy
wenzelm@27564
   139
  | cases_node _ g (Proof (prf, _)) = g (ProofNode.current prf)
wenzelm@21007
   140
  | cases_node f _ (SkipProof (_, (gthy, _))) = f gthy;
wenzelm@19063
   141
wenzelm@20963
   142
fun presentation_context (SOME (Theory (_, SOME ctxt))) NONE = ctxt
wenzelm@20963
   143
  | presentation_context (SOME node) NONE = cases_node Context.proof_of Proof.context_of node
wenzelm@20963
   144
  | presentation_context (SOME node) (SOME loc) =
haftmann@25269
   145
      loc_init loc (cases_node Context.theory_of Proof.theory_of node)
wenzelm@20963
   146
  | presentation_context NONE _ = raise UNDEF;
wenzelm@19063
   147
wenzelm@26624
   148
fun reset_presentation (Theory (gthy, _)) = Theory (gthy, NONE)
wenzelm@26624
   149
  | reset_presentation node = node;
wenzelm@26624
   150
wenzelm@5828
   151
wenzelm@21958
   152
(* datatype state *)
wenzelm@5828
   153
wenzelm@27601
   154
type node_info = node * (theory -> unit);  (*node with exit operation*)
wenzelm@27601
   155
datatype state = State of node_info option * node_info option;  (*current, previous*)
wenzelm@21958
   156
wenzelm@27576
   157
val toplevel = State (NONE, NONE);
wenzelm@21958
   158
wenzelm@27576
   159
fun is_toplevel (State (NONE, _)) = true
wenzelm@7732
   160
  | is_toplevel _ = false;
wenzelm@7732
   161
wenzelm@27576
   162
fun level (State (NONE, _)) = 0
wenzelm@27576
   163
  | level (State (SOME (Theory _, _), _)) = 0
wenzelm@27576
   164
  | level (State (SOME (Proof (prf, _), _), _)) = Proof.level (ProofNode.current prf)
wenzelm@27576
   165
  | level (State (SOME (SkipProof (d, _), _), _)) = d + 1;   (*different notion of proof depth!*)
wenzelm@17076
   166
wenzelm@27576
   167
fun str_of_state (State (NONE, _)) = "at top level"
wenzelm@27576
   168
  | str_of_state (State (SOME (Theory (Context.Theory _, _), _), _)) = "in theory mode"
wenzelm@27576
   169
  | str_of_state (State (SOME (Theory (Context.Proof _, _), _), _)) = "in local theory mode"
wenzelm@27576
   170
  | str_of_state (State (SOME (Proof _, _), _)) = "in proof mode"
wenzelm@27576
   171
  | str_of_state (State (SOME (SkipProof _, _), _)) = "in skipped proof mode";
wenzelm@5946
   172
wenzelm@5946
   173
wenzelm@27576
   174
(* current node *)
wenzelm@5828
   175
wenzelm@27603
   176
fun previous_node_of (State (_, prev)) = Option.map #1 prev;
wenzelm@6689
   177
wenzelm@27576
   178
fun node_of (State (NONE, _)) = raise UNDEF
wenzelm@27576
   179
  | node_of (State (SOME (node, _), _)) = node;
wenzelm@5828
   180
wenzelm@18589
   181
fun is_theory state = not (is_toplevel state) andalso is_some (theory_node (node_of state));
wenzelm@18589
   182
fun is_proof state = not (is_toplevel state) andalso is_some (proof_node (node_of state));
wenzelm@18589
   183
wenzelm@19063
   184
fun node_case f g state = cases_node f g (node_of state);
wenzelm@5828
   185
wenzelm@21506
   186
val context_of = node_case Context.proof_of Proof.context_of;
wenzelm@22089
   187
val generic_theory_of = node_case I (Context.Proof o Proof.context_of);
wenzelm@20963
   188
val theory_of = node_case Context.theory_of Proof.theory_of;
wenzelm@18589
   189
val proof_of = node_case (fn _ => raise UNDEF) I;
wenzelm@17208
   190
wenzelm@18589
   191
fun proof_position_of state =
wenzelm@18589
   192
  (case node_of state of
wenzelm@27564
   193
    Proof (prf, _) => ProofNode.position prf
wenzelm@18589
   194
  | _ => raise UNDEF);
wenzelm@6664
   195
wenzelm@21007
   196
val enter_proof_body = node_case (Proof.init o Context.proof_of) Proof.enter_forward;
wenzelm@5828
   197
wenzelm@5828
   198
wenzelm@16815
   199
(* print state *)
wenzelm@16815
   200
wenzelm@25292
   201
val pretty_context = LocalTheory.pretty o Context.cases (TheoryTarget.init NONE) I;
wenzelm@16815
   202
wenzelm@23640
   203
fun print_state_context state =
wenzelm@24795
   204
  (case try node_of state of
wenzelm@21506
   205
    NONE => []
wenzelm@24795
   206
  | SOME (Theory (gthy, _)) => pretty_context gthy
wenzelm@24795
   207
  | SOME (Proof (_, (_, gthy))) => pretty_context gthy
wenzelm@24795
   208
  | SOME (SkipProof (_, (gthy, _))) => pretty_context gthy)
wenzelm@23640
   209
  |> Pretty.chunks |> Pretty.writeln;
wenzelm@16815
   210
wenzelm@23640
   211
fun print_state prf_only state =
wenzelm@23701
   212
  (case try node_of state of
wenzelm@23701
   213
    NONE => []
wenzelm@23701
   214
  | SOME (Theory (gthy, _)) => if prf_only then [] else pretty_context gthy
wenzelm@23701
   215
  | SOME (Proof (prf, _)) =>
wenzelm@27564
   216
      Proof.pretty_state (ProofNode.position prf) (ProofNode.current prf)
wenzelm@27564
   217
  | SOME (SkipProof (d, _)) => [Pretty.str ("skipped proof: depth " ^ string_of_int d)])
wenzelm@23701
   218
  |> Pretty.markup_chunks Markup.state |> Pretty.writeln;
wenzelm@16815
   219
wenzelm@16815
   220
wenzelm@15668
   221
wenzelm@5828
   222
(** toplevel transitions **)
wenzelm@5828
   223
wenzelm@16682
   224
val quiet = ref false;
wenzelm@22135
   225
val debug = Output.debugging;
wenzelm@17321
   226
val interact = ref false;
wenzelm@16682
   227
val timing = Output.timing;
wenzelm@16682
   228
val profiling = ref 0;
wenzelm@16815
   229
val skip_proofs = ref false;
wenzelm@16682
   230
wenzelm@5828
   231
exception TERMINATE;
wenzelm@7022
   232
exception EXCURSION_FAIL of exn * string;
wenzelm@6689
   233
exception FAILURE of state * exn;
wenzelm@24055
   234
exception TOPLEVEL_ERROR;
wenzelm@5828
   235
wenzelm@20128
   236
wenzelm@20128
   237
(* print exceptions *)
wenzelm@20128
   238
wenzelm@26256
   239
exception CONTEXT of Proof.context * exn;
wenzelm@26256
   240
wenzelm@26256
   241
fun exn_context NONE exn = exn
wenzelm@26256
   242
  | exn_context (SOME ctxt) exn = CONTEXT (ctxt, exn);
wenzelm@26256
   243
wenzelm@20128
   244
local
wenzelm@20128
   245
wenzelm@26256
   246
fun if_context NONE _ _ = []
wenzelm@26256
   247
  | if_context (SOME ctxt) f xs = map (f ctxt) xs;
wenzelm@20128
   248
wenzelm@20128
   249
fun raised name [] = "exception " ^ name ^ " raised"
wenzelm@20128
   250
  | raised name [msg] = "exception " ^ name ^ " raised: " ^ msg
wenzelm@20128
   251
  | raised name msgs = cat_lines (("exception " ^ name ^ " raised:") :: msgs);
wenzelm@20128
   252
wenzelm@20128
   253
in
wenzelm@20128
   254
wenzelm@26256
   255
fun exn_message e =
wenzelm@26256
   256
  let
wenzelm@26256
   257
    val detailed = ! debug;
wenzelm@26256
   258
wenzelm@26256
   259
    fun exn_msg _ (CONTEXT (ctxt, exn)) = exn_msg (SOME ctxt) exn
wenzelm@26256
   260
      | exn_msg ctxt (Exn.EXCEPTIONS (exns, "")) = cat_lines (map (exn_msg ctxt) exns)
wenzelm@26256
   261
      | exn_msg ctxt (Exn.EXCEPTIONS (exns, msg)) = cat_lines (map (exn_msg ctxt) exns @ [msg])
wenzelm@26293
   262
      | exn_msg ctxt (EXCURSION_FAIL (exn, loc)) =
wenzelm@26293
   263
          exn_msg ctxt exn ^ Markup.markup Markup.location ("\n" ^ loc)
wenzelm@26256
   264
      | exn_msg _ TERMINATE = "Exit."
wenzelm@26256
   265
      | exn_msg _ Interrupt = "Interrupt."
wenzelm@26256
   266
      | exn_msg _ TimeLimit.TimeOut = "Timeout."
wenzelm@26256
   267
      | exn_msg _ TOPLEVEL_ERROR = "Error."
wenzelm@26256
   268
      | exn_msg _ (SYS_ERROR msg) = "## SYSTEM ERROR ##\n" ^ msg
wenzelm@26256
   269
      | exn_msg _ (ERROR msg) = msg
wenzelm@26256
   270
      | exn_msg _ (Fail msg) = raised "Fail" [msg]
wenzelm@26256
   271
      | exn_msg _ (THEORY (msg, thys)) =
wenzelm@26256
   272
          raised "THEORY" (msg :: (if detailed then map Context.str_of_thy thys else []))
wenzelm@26256
   273
      | exn_msg _ (Syntax.AST (msg, asts)) = raised "AST" (msg ::
wenzelm@26256
   274
            (if detailed then map (Pretty.string_of o Syntax.pretty_ast) asts else []))
wenzelm@26256
   275
      | exn_msg ctxt (TYPE (msg, Ts, ts)) = raised "TYPE" (msg ::
wenzelm@26256
   276
            (if detailed then
wenzelm@26256
   277
              if_context ctxt Syntax.string_of_typ Ts @ if_context ctxt Syntax.string_of_term ts
wenzelm@26256
   278
             else []))
wenzelm@26256
   279
      | exn_msg ctxt (TERM (msg, ts)) = raised "TERM" (msg ::
wenzelm@26256
   280
            (if detailed then if_context ctxt Syntax.string_of_term ts else []))
wenzelm@26256
   281
      | exn_msg ctxt (THM (msg, i, thms)) = raised ("THM " ^ string_of_int i) (msg ::
wenzelm@26256
   282
            (if detailed then if_context ctxt ProofContext.string_of_thm thms else []))
wenzelm@26256
   283
      | exn_msg _ exn = raised (General.exnMessage exn) []
wenzelm@26256
   284
  in exn_msg NONE e end;
wenzelm@26256
   285
wenzelm@20128
   286
end;
wenzelm@20128
   287
wenzelm@20128
   288
wenzelm@20128
   289
(* controlled execution *)
wenzelm@20128
   290
wenzelm@20128
   291
local
wenzelm@20128
   292
wenzelm@18685
   293
fun debugging f x =
wenzelm@23940
   294
  if ! debug then exception_trace (fn () => f x)
wenzelm@18685
   295
  else f x;
wenzelm@18685
   296
wenzelm@26256
   297
fun toplevel_error f x =
wenzelm@26256
   298
  let val ctxt = try ML_Context.the_local_context () in
wenzelm@26256
   299
    f x handle exn =>
wenzelm@26256
   300
      (Output.error_msg (exn_message (exn_context ctxt exn)); raise TOPLEVEL_ERROR)
wenzelm@26256
   301
  end;
wenzelm@24055
   302
wenzelm@20128
   303
in
wenzelm@20128
   304
wenzelm@20128
   305
fun controlled_execution f =
wenzelm@20128
   306
  f
wenzelm@20128
   307
  |> debugging
wenzelm@24055
   308
  |> interruptible;
wenzelm@20128
   309
wenzelm@20128
   310
fun program f =
wenzelm@24055
   311
 (f
wenzelm@24055
   312
  |> debugging
wenzelm@24055
   313
  |> toplevel_error) ();
wenzelm@20128
   314
wenzelm@20128
   315
end;
wenzelm@20128
   316
wenzelm@5828
   317
wenzelm@27601
   318
(* node transactions -- maintaining stable checkpoints *)
wenzelm@7022
   319
wenzelm@6689
   320
local
wenzelm@6689
   321
wenzelm@26624
   322
fun is_draft_theory (Theory (gthy, _)) = Context.is_draft (Context.theory_of gthy)
wenzelm@26624
   323
  | is_draft_theory _ = false;
wenzelm@26624
   324
wenzelm@27601
   325
fun is_stale state = Context.is_stale (theory_of state) handle UNDEF => false;
wenzelm@27601
   326
wenzelm@26624
   327
fun stale_error NONE = SOME (ERROR "Stale theory encountered after successful execution!")
wenzelm@26624
   328
  | stale_error some = some;
wenzelm@16815
   329
wenzelm@27576
   330
fun map_theory f (Theory (gthy, ctxt)) =
wenzelm@27576
   331
      Theory (Context.mapping f (LocalTheory.raw_theory f) gthy, ctxt)
wenzelm@27576
   332
  | map_theory _ node = node;
wenzelm@6689
   333
wenzelm@6689
   334
in
wenzelm@6689
   335
wenzelm@27601
   336
fun apply_transaction pos f (node, exit) =
wenzelm@20128
   337
  let
wenzelm@27576
   338
    val _ = is_draft_theory node andalso error "Illegal draft theory in toplevel state";
wenzelm@27576
   339
    val cont_node = reset_presentation node;
wenzelm@27576
   340
    val back_node = map_theory (Theory.checkpoint o Theory.copy) cont_node;
wenzelm@27601
   341
    fun state_error e nd = (State (SOME (nd, exit), SOME (node, exit)), e);
wenzelm@6689
   342
wenzelm@20128
   343
    val (result, err) =
wenzelm@20128
   344
      cont_node
wenzelm@27576
   345
      |> controlled_execution f
wenzelm@26624
   346
      |> map_theory Theory.checkpoint
wenzelm@26624
   347
      |> state_error NONE
wenzelm@26624
   348
      handle exn => state_error (SOME exn) cont_node;
wenzelm@26624
   349
wenzelm@26624
   350
    val (result', err') =
wenzelm@26624
   351
      if is_stale result then state_error (stale_error err) back_node
wenzelm@26624
   352
      else (result, err);
wenzelm@20128
   353
  in
wenzelm@26624
   354
    (case err' of
wenzelm@26624
   355
      NONE => result'
wenzelm@26624
   356
    | SOME exn => raise FAILURE (result', exn))
wenzelm@20128
   357
  end;
wenzelm@6689
   358
wenzelm@6689
   359
end;
wenzelm@6689
   360
wenzelm@6689
   361
wenzelm@6689
   362
(* primitive transitions *)
wenzelm@6689
   363
wenzelm@5828
   364
datatype trans =
wenzelm@27576
   365
  Init of string * (bool -> theory) * (theory -> unit) | (*theory name, init, exit*)
wenzelm@27576
   366
  Exit |                                         (*formal exit of theory -- without committing*)
wenzelm@27576
   367
  CommitExit |                                   (*exit and commit final theory*)
wenzelm@27576
   368
  Keep of bool -> state -> unit |                (*peek at state*)
wenzelm@27576
   369
  Transaction of bool -> node -> node;           (*node transaction*)
wenzelm@21958
   370
wenzelm@6689
   371
local
wenzelm@6689
   372
wenzelm@27576
   373
fun apply_tr int _ (Init (_, f, exit)) (State (NONE, _)) =
wenzelm@27576
   374
      State (SOME (Theory (Context.Theory (Theory.checkpoint (f int)), NONE), exit), NONE)
wenzelm@27603
   375
  | apply_tr _ _ Exit (State (prev as SOME (Theory (Context.Theory _, _), _), _)) =
wenzelm@27603
   376
      State (NONE, prev)
wenzelm@27601
   377
  | apply_tr _ _ CommitExit (State (NONE, SOME (Theory (Context.Theory thy, _), exit))) =
wenzelm@27576
   378
      (controlled_execution exit thy; toplevel)
wenzelm@27576
   379
  | apply_tr int _ (Keep f) state =
wenzelm@27576
   380
      controlled_execution (fn x => tap (f int) x) state
wenzelm@27576
   381
  | apply_tr int pos (Transaction f) (State (SOME state, _)) =
wenzelm@27601
   382
      apply_transaction pos (fn x => f int x) state
wenzelm@23363
   383
  | apply_tr _ _ _ _ = raise UNDEF;
wenzelm@6689
   384
wenzelm@23363
   385
fun apply_union _ _ [] state = raise FAILURE (state, UNDEF)
wenzelm@23363
   386
  | apply_union int pos (tr :: trs) state =
wenzelm@23363
   387
      apply_tr int pos tr state
wenzelm@23363
   388
        handle UNDEF => apply_union int pos trs state
wenzelm@23363
   389
          | FAILURE (alt_state, UNDEF) => apply_union int pos trs alt_state
wenzelm@6689
   390
          | exn as FAILURE _ => raise exn
wenzelm@6689
   391
          | exn => raise FAILURE (state, exn);
wenzelm@6689
   392
wenzelm@6689
   393
in
wenzelm@6689
   394
wenzelm@23363
   395
fun apply_trans int pos trs state = (apply_union int pos trs state, NONE)
skalberg@15531
   396
  handle FAILURE (alt_state, exn) => (alt_state, SOME exn) | exn => (state, SOME exn);
wenzelm@6689
   397
wenzelm@6689
   398
end;
wenzelm@5828
   399
wenzelm@5828
   400
wenzelm@5828
   401
(* datatype transition *)
wenzelm@5828
   402
wenzelm@5828
   403
datatype transition = Transition of
wenzelm@26621
   404
 {name: string,              (*command name*)
wenzelm@26621
   405
  pos: Position.T,           (*source position*)
wenzelm@26621
   406
  int_only: bool,            (*interactive-only*)
wenzelm@26621
   407
  print: bool,               (*print result state*)
wenzelm@26621
   408
  no_timing: bool,           (*suppress timing*)
wenzelm@26621
   409
  trans: trans list};        (*primitive transitions (union)*)
wenzelm@5828
   410
wenzelm@26621
   411
fun make_transition (name, pos, int_only, print, no_timing, trans) =
wenzelm@26621
   412
  Transition {name = name, pos = pos, int_only = int_only, print = print, no_timing = no_timing,
wenzelm@26621
   413
    trans = trans};
wenzelm@5828
   414
wenzelm@26621
   415
fun map_transition f (Transition {name, pos, int_only, print, no_timing, trans}) =
wenzelm@26621
   416
  make_transition (f (name, pos, int_only, print, no_timing, trans));
wenzelm@5828
   417
wenzelm@27441
   418
val empty = make_transition ("", Position.none, false, false, false, []);
wenzelm@5828
   419
wenzelm@5828
   420
wenzelm@5828
   421
(* diagnostics *)
wenzelm@5828
   422
wenzelm@27441
   423
fun init_of (Transition {trans = [Init (name, _, _)], ...}) = SOME name
wenzelm@27441
   424
  | init_of _ = NONE;
wenzelm@27441
   425
wenzelm@27427
   426
fun name_of (Transition {name, ...}) = name;
wenzelm@28105
   427
fun pos_of (Transition {pos, ...}) = pos;
wenzelm@28105
   428
fun str_of tr = quote (name_of tr) ^ Position.str_of (pos_of tr);
wenzelm@5828
   429
wenzelm@27427
   430
fun command_msg msg tr = msg ^ "command " ^ str_of tr;
wenzelm@5828
   431
fun at_command tr = command_msg "At " tr ^ ".";
wenzelm@5828
   432
wenzelm@5828
   433
fun type_error tr state =
wenzelm@18685
   434
  ERROR (command_msg "Illegal application of " tr ^ " " ^ str_of_state state);
wenzelm@5828
   435
wenzelm@5828
   436
wenzelm@5828
   437
(* modify transitions *)
wenzelm@5828
   438
wenzelm@26621
   439
fun name nm = map_transition (fn (_, pos, int_only, print, no_timing, trans) =>
wenzelm@26621
   440
  (nm, pos, int_only, print, no_timing, trans));
wenzelm@5828
   441
wenzelm@26621
   442
fun position pos = map_transition (fn (name, _, int_only, print, no_timing, trans) =>
wenzelm@26621
   443
  (name, pos, int_only, print, no_timing, trans));
wenzelm@5828
   444
wenzelm@26621
   445
fun interactive int_only = map_transition (fn (name, pos, _, print, no_timing, trans) =>
wenzelm@26621
   446
  (name, pos, int_only, print, no_timing, trans));
wenzelm@5828
   447
wenzelm@26621
   448
val no_timing = map_transition (fn (name, pos, int_only, print, _, trans) =>
wenzelm@26621
   449
  (name, pos, int_only, print, true, trans));
wenzelm@5828
   450
wenzelm@26621
   451
fun add_trans tr = map_transition (fn (name, pos, int_only, print, no_timing, trans) =>
wenzelm@26621
   452
  (name, pos, int_only, print, no_timing, trans @ [tr]));
wenzelm@17363
   453
wenzelm@26621
   454
val print = map_transition (fn (name, pos, int_only, _, no_timing, trans) =>
wenzelm@26621
   455
  (name, pos, int_only, true, no_timing, trans));
wenzelm@5828
   456
wenzelm@5828
   457
wenzelm@21007
   458
(* basic transitions *)
wenzelm@5828
   459
wenzelm@27576
   460
fun init_theory name f exit = add_trans (Init (name, f, exit));
wenzelm@6689
   461
val exit = add_trans Exit;
wenzelm@7612
   462
val keep' = add_trans o Keep;
wenzelm@27601
   463
fun transaction f = add_trans (Transaction f);
wenzelm@5828
   464
wenzelm@7612
   465
fun keep f = add_trans (Keep (fn _ => f));
wenzelm@5828
   466
fun imperative f = keep (fn _ => f ());
wenzelm@5828
   467
wenzelm@27840
   468
fun ignored pos = empty |> name "<ignored>" |> position pos |> imperative I;
wenzelm@27840
   469
fun malformed pos msg =
wenzelm@27840
   470
  empty |> name "<malformed>" |> position pos |> imperative (fn () => error msg);
wenzelm@27840
   471
wenzelm@21007
   472
val unknown_theory = imperative (fn () => warning "Unknown theory context");
wenzelm@21007
   473
val unknown_proof = imperative (fn () => warning "Unknown proof context");
wenzelm@21007
   474
val unknown_context = imperative (fn () => warning "Unknown context");
wenzelm@15668
   475
wenzelm@21007
   476
wenzelm@21007
   477
(* theory transitions *)
wenzelm@15668
   478
wenzelm@27601
   479
fun generic_theory f = transaction (fn _ =>
wenzelm@26491
   480
  (fn Theory (gthy, _) => Theory (f gthy, NONE)
wenzelm@26491
   481
    | _ => raise UNDEF));
wenzelm@26491
   482
wenzelm@27601
   483
fun theory' f = transaction (fn int =>
wenzelm@20963
   484
  (fn Theory (Context.Theory thy, _) => Theory (Context.Theory (f int thy), NONE)
wenzelm@20963
   485
    | _ => raise UNDEF));
wenzelm@18563
   486
wenzelm@20963
   487
fun theory f = theory' (K f);
wenzelm@17076
   488
wenzelm@27601
   489
fun begin_local_theory begin f = transaction (fn _ =>
wenzelm@20963
   490
  (fn Theory (Context.Theory thy, _) =>
wenzelm@20963
   491
        let
wenzelm@20985
   492
          val lthy = f thy;
wenzelm@21294
   493
          val gthy = if begin then Context.Proof lthy else Context.Theory (loc_exit lthy);
wenzelm@21294
   494
        in Theory (gthy, SOME lthy) end
wenzelm@20963
   495
    | _ => raise UNDEF));
wenzelm@20963
   496
wenzelm@27601
   497
val end_local_theory = transaction (fn _ =>
wenzelm@21294
   498
  (fn Theory (Context.Proof lthy, _) => Theory (Context.Theory (loc_exit lthy), SOME lthy)
wenzelm@21007
   499
    | _ => raise UNDEF));
wenzelm@21007
   500
wenzelm@21007
   501
local
wenzelm@21007
   502
wenzelm@27601
   503
fun local_theory_presentation loc f g = transaction (fn int =>
wenzelm@21294
   504
  (fn Theory (gthy, _) =>
wenzelm@21294
   505
        let
wenzelm@21294
   506
          val finish = loc_finish loc gthy;
wenzelm@25960
   507
          val lthy' = f (loc_begin loc gthy);
wenzelm@21294
   508
        in Theory (finish lthy', SOME lthy') end
wenzelm@27859
   509
    | _ => raise UNDEF) #> tap g);
wenzelm@20963
   510
wenzelm@21007
   511
in
wenzelm@21007
   512
wenzelm@20963
   513
fun local_theory loc f = local_theory_presentation loc f (K I);
wenzelm@20963
   514
fun present_local_theory loc g = local_theory_presentation loc I g;
wenzelm@18955
   515
wenzelm@21007
   516
end;
wenzelm@21007
   517
wenzelm@21007
   518
wenzelm@21007
   519
(* proof transitions *)
wenzelm@21007
   520
wenzelm@27601
   521
fun end_proof f = transaction (fn int =>
wenzelm@24795
   522
  (fn Proof (prf, (finish, _)) =>
wenzelm@27564
   523
        let val state = ProofNode.current prf in
wenzelm@21007
   524
          if can (Proof.assert_bottom true) state then
wenzelm@21007
   525
            let
wenzelm@21007
   526
              val ctxt' = f int state;
wenzelm@21007
   527
              val gthy' = finish ctxt';
wenzelm@21007
   528
            in Theory (gthy', SOME ctxt') end
wenzelm@21007
   529
          else raise UNDEF
wenzelm@21007
   530
        end
wenzelm@27564
   531
    | SkipProof (0, (gthy, _)) => Theory (gthy, NONE)
wenzelm@21007
   532
    | _ => raise UNDEF));
wenzelm@21007
   533
wenzelm@21294
   534
local
wenzelm@21294
   535
wenzelm@27601
   536
fun begin_proof init finish = transaction (fn int =>
wenzelm@21294
   537
  (fn Theory (gthy, _) =>
wenzelm@21294
   538
    let
berghofe@24453
   539
      val prf = init int gthy;
wenzelm@21294
   540
      val schematic = Proof.schematic_goal prf;
wenzelm@21294
   541
    in
wenzelm@21294
   542
      if ! skip_proofs andalso schematic then
wenzelm@21294
   543
        warning "Cannot skip proof of schematic goal statement"
wenzelm@21294
   544
      else ();
wenzelm@21294
   545
      if ! skip_proofs andalso not schematic then
wenzelm@27564
   546
        SkipProof (0, (finish gthy (Proof.global_skip_proof int prf), gthy))
wenzelm@27564
   547
      else Proof (ProofNode.init prf, (finish gthy, gthy))
wenzelm@21294
   548
    end
wenzelm@21294
   549
  | _ => raise UNDEF));
wenzelm@21294
   550
wenzelm@21294
   551
in
wenzelm@21294
   552
wenzelm@24780
   553
fun local_theory_to_proof' loc f = begin_proof
wenzelm@25960
   554
  (fn int => fn gthy => f int (loc_begin loc gthy))
wenzelm@24780
   555
  (loc_finish loc);
wenzelm@24780
   556
berghofe@24453
   557
fun local_theory_to_proof loc f = local_theory_to_proof' loc (K f);
wenzelm@21294
   558
wenzelm@21294
   559
fun theory_to_proof f = begin_proof
wenzelm@24780
   560
  (K (fn Context.Theory thy => f thy | _ => raise UNDEF))
wenzelm@24780
   561
  (K (Context.Theory o ProofContext.theory_of));
wenzelm@21294
   562
wenzelm@21294
   563
end;
wenzelm@21294
   564
wenzelm@27601
   565
val forget_proof = transaction (fn _ =>
wenzelm@21007
   566
  (fn Proof (_, (_, orig_gthy)) => Theory (orig_gthy, NONE)
wenzelm@21007
   567
    | SkipProof (_, (_, orig_gthy)) => Theory (orig_gthy, NONE)
wenzelm@21007
   568
    | _ => raise UNDEF));
wenzelm@21007
   569
wenzelm@27859
   570
fun present_proof f = transaction (fn _ =>
wenzelm@27564
   571
  (fn Proof (prf, x) => Proof (ProofNode.apply I prf, x)
wenzelm@27564
   572
    | skip as SkipProof _ => skip
wenzelm@27859
   573
    | _ => raise UNDEF) #> tap f);
wenzelm@21177
   574
wenzelm@27601
   575
fun proofs' f = transaction (fn int =>
wenzelm@27564
   576
  (fn Proof (prf, x) => Proof (ProofNode.applys (f int) prf, x)
wenzelm@27564
   577
    | skip as SkipProof _ => skip
wenzelm@16815
   578
    | _ => raise UNDEF));
wenzelm@15668
   579
wenzelm@17904
   580
fun proof' f = proofs' (Seq.single oo f);
wenzelm@17904
   581
val proofs = proofs' o K;
wenzelm@6689
   582
val proof = proof' o K;
wenzelm@16815
   583
wenzelm@27601
   584
fun actual_proof f = transaction (fn _ =>
wenzelm@21007
   585
  (fn Proof (prf, x) => Proof (f prf, x)
wenzelm@20963
   586
    | _ => raise UNDEF));
wenzelm@16815
   587
wenzelm@27601
   588
fun skip_proof f = transaction (fn _ =>
wenzelm@21007
   589
  (fn SkipProof (h, x) => SkipProof (f h, x)
wenzelm@18563
   590
    | _ => raise UNDEF));
wenzelm@18563
   591
wenzelm@27601
   592
fun skip_proof_to_theory pred = transaction (fn _ =>
wenzelm@27564
   593
  (fn SkipProof (d, (gthy, _)) => if pred d then Theory (gthy, NONE) else raise UNDEF
wenzelm@17904
   594
  | _ => raise UNDEF));
wenzelm@5828
   595
wenzelm@5828
   596
wenzelm@5828
   597
wenzelm@5828
   598
(** toplevel transactions **)
wenzelm@5828
   599
wenzelm@27427
   600
(* identification *)
wenzelm@27427
   601
wenzelm@27427
   602
fun get_id (Transition {pos, ...}) = Position.get_id pos;
wenzelm@27427
   603
fun put_id id (tr as Transition {pos, ...}) = position (Position.put_id id pos) tr;
wenzelm@27427
   604
wenzelm@27427
   605
wenzelm@25960
   606
(* thread position *)
wenzelm@25799
   607
wenzelm@25960
   608
fun setmp_thread_position (Transition {pos, ...}) f x =
wenzelm@25819
   609
  Position.setmp_thread_data pos f x;
wenzelm@25799
   610
wenzelm@27606
   611
fun status tr m =
wenzelm@27606
   612
  setmp_thread_position tr (fn () => Output.status (Markup.markup m "")) ();
wenzelm@27606
   613
wenzelm@26602
   614
fun error_msg tr exn_info =
wenzelm@26602
   615
  setmp_thread_position tr (fn () => Output.error_msg (exn_message (EXCURSION_FAIL exn_info))) ();
wenzelm@26602
   616
wenzelm@25799
   617
wenzelm@28095
   618
(* post-transition hooks *)
wenzelm@28095
   619
wenzelm@28103
   620
local val hooks = ref ([]: (transition -> state -> state -> unit) list) in
wenzelm@28095
   621
wenzelm@28095
   622
fun add_hook f = CRITICAL (fn () => change hooks (cons f));
wenzelm@28095
   623
fun get_hooks () = CRITICAL (fn () => ! hooks);
wenzelm@28095
   624
wenzelm@28095
   625
end;
wenzelm@28095
   626
wenzelm@28095
   627
wenzelm@5828
   628
(* apply transitions *)
wenzelm@5828
   629
wenzelm@6664
   630
local
wenzelm@6664
   631
wenzelm@25799
   632
fun app int (tr as Transition {trans, pos, int_only, print, no_timing, ...}) =
wenzelm@25819
   633
  setmp_thread_position tr (fn state =>
wenzelm@25799
   634
    let
wenzelm@26621
   635
      val _ = if not int andalso int_only then warning (command_msg "Interactive-only " tr) else ();
wenzelm@16682
   636
wenzelm@25799
   637
      fun do_timing f x = (warning (command_msg "" tr); timeap f x);
wenzelm@25799
   638
      fun do_profiling f x = profile (! profiling) f x;
wenzelm@16682
   639
wenzelm@26256
   640
      val (result, status) =
wenzelm@25799
   641
         state |> (apply_trans int pos trans
wenzelm@25799
   642
          |> (if ! profiling > 0 andalso not no_timing then do_profiling else I)
wenzelm@25799
   643
          |> (if ! profiling > 0 orelse ! timing andalso not no_timing then do_timing else I));
wenzelm@26256
   644
wenzelm@26621
   645
      val _ = if int andalso not (! quiet) andalso print then print_state false result else ();
wenzelm@26256
   646
    in (result, Option.map (fn UNDEF => type_error tr state | exn => exn) status) end);
wenzelm@6664
   647
wenzelm@6664
   648
in
wenzelm@5828
   649
wenzelm@26602
   650
fun transition int tr st =
wenzelm@28095
   651
  let
wenzelm@28095
   652
    val hooks = get_hooks ();
wenzelm@28103
   653
    fun apply_hooks st' = hooks |> List.app (fn f => (try (fn () => f tr st st') (); ()));
wenzelm@28095
   654
wenzelm@28095
   655
    val ctxt = try context_of st;
wenzelm@28095
   656
    val res =
wenzelm@28095
   657
      (case app int tr st of
wenzelm@28095
   658
        (_, SOME TERMINATE) => NONE
wenzelm@28103
   659
      | (st', SOME (EXCURSION_FAIL exn_info)) => SOME (st', SOME exn_info)
wenzelm@28103
   660
      | (st', SOME exn) => SOME (st', SOME (exn_context ctxt exn, at_command tr))
wenzelm@28103
   661
      | (st', NONE) => SOME (st', NONE));
wenzelm@28103
   662
    val _ = (case res of SOME (st', NONE) => apply_hooks st' | _ => ());
wenzelm@28095
   663
  in res end;
wenzelm@6664
   664
wenzelm@6664
   665
end;
wenzelm@5828
   666
wenzelm@5828
   667
wenzelm@27601
   668
(* commit final exit *)
wenzelm@27601
   669
wenzelm@27601
   670
val commit_exit =
wenzelm@27601
   671
  name "end" empty
wenzelm@27601
   672
  |> add_trans CommitExit
wenzelm@27601
   673
  |> imperative (fn () => warning "Expected to find finished theory");
wenzelm@27601
   674
wenzelm@27601
   675
wenzelm@17076
   676
(* excursion: toplevel -- apply transformers/presentation -- toplevel *)
wenzelm@5828
   677
wenzelm@6664
   678
local
wenzelm@6664
   679
wenzelm@27576
   680
fun no_pr _ _ _ = ();
wenzelm@5828
   681
wenzelm@27601
   682
fun excur (tr, pr) (st, res) =
wenzelm@27576
   683
  (case transition (! interact) tr st of
wenzelm@27576
   684
    SOME (st', NONE) =>
wenzelm@27601
   685
      (st', setmp_thread_position tr (fn () => pr st st' res) () handle exn =>
wenzelm@27576
   686
        raise EXCURSION_FAIL (exn, "Presentation failed\n" ^ at_command tr))
wenzelm@27576
   687
  | SOME (st', SOME exn_info) => raise EXCURSION_FAIL exn_info
wenzelm@27576
   688
  | NONE => raise EXCURSION_FAIL (TERMINATE, at_command tr));
wenzelm@27576
   689
wenzelm@27601
   690
fun excurs trs st_res =
wenzelm@27601
   691
  let val (st', res') = fold excur trs st_res in
wenzelm@27601
   692
    if is_toplevel st' then (excur (commit_exit, no_pr) (st', ()); res')
wenzelm@27601
   693
    else error "Unfinished development at end of input"
wenzelm@27601
   694
  end;
wenzelm@17076
   695
wenzelm@6664
   696
in
wenzelm@6664
   697
wenzelm@17076
   698
fun present_excursion trs res =
wenzelm@27601
   699
  excurs trs (toplevel, res) handle exn => error (exn_message exn);
wenzelm@9134
   700
wenzelm@17076
   701
fun excursion trs = present_excursion (map (rpair no_pr) trs) ();
wenzelm@7062
   702
wenzelm@6664
   703
end;
wenzelm@6664
   704
wenzelm@5828
   705
end;