src/Pure/Isar/toplevel.ML
author wenzelm
Thu Apr 10 17:01:40 2008 +0200 (2008-04-10)
changeset 26621 78b3ad7af5d5
parent 26602 5534b6a6b810
child 26624 770265032999
permissions -rw-r--r--
eliminated unused name_of, source, source_of, print', print3, three_buffersN;
tuned;
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@18589
    14
  val proof_node: node -> ProofHistory.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@6689
    23
  val node_history_of: state -> node History.T
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@5990
    41
  exception RESTART
wenzelm@26256
    42
  exception CONTEXT of Proof.context * exn
wenzelm@24055
    43
  exception TOPLEVEL_ERROR
wenzelm@20128
    44
  val exn_message: exn -> string
wenzelm@20128
    45
  val program: (unit -> 'a) -> 'a
wenzelm@16682
    46
  type transition
wenzelm@6689
    47
  val undo_limit: bool -> int option
wenzelm@5828
    48
  val empty: transition
wenzelm@5828
    49
  val name: string -> transition -> transition
wenzelm@5828
    50
  val position: Position.T -> transition -> transition
wenzelm@5828
    51
  val interactive: bool -> transition -> transition
wenzelm@5828
    52
  val print: transition -> transition
wenzelm@9010
    53
  val no_timing: transition -> transition
wenzelm@22056
    54
  val init_theory: (bool -> theory) -> (theory -> unit) -> (theory -> unit) ->
wenzelm@22056
    55
    transition -> transition
wenzelm@25441
    56
  val init_empty: (state -> bool) -> (unit -> unit) -> transition -> transition
wenzelm@6689
    57
  val exit: transition -> transition
wenzelm@21958
    58
  val undo_exit: transition -> transition
wenzelm@6689
    59
  val kill: transition -> transition
wenzelm@20128
    60
  val history: (node History.T -> node History.T) -> transition -> transition
wenzelm@5828
    61
  val keep: (state -> unit) -> transition -> transition
wenzelm@7612
    62
  val keep': (bool -> state -> unit) -> transition -> transition
wenzelm@5828
    63
  val imperative: (unit -> unit) -> transition -> transition
wenzelm@5828
    64
  val theory: (theory -> theory) -> transition -> transition
wenzelm@26491
    65
  val generic_theory: (generic_theory -> generic_theory) -> transition -> transition
wenzelm@7612
    66
  val theory': (bool -> theory -> theory) -> transition -> transition
wenzelm@20985
    67
  val begin_local_theory: bool -> (theory -> local_theory) -> transition -> transition
wenzelm@21007
    68
  val end_local_theory: transition -> transition
wenzelm@20963
    69
  val local_theory: xstring option -> (local_theory -> local_theory) -> transition -> transition
wenzelm@20963
    70
  val present_local_theory: xstring option -> (bool -> node -> unit) -> transition -> transition
berghofe@24453
    71
  val local_theory_to_proof': xstring option -> (bool -> local_theory -> Proof.state) ->
berghofe@24453
    72
    transition -> transition
wenzelm@21007
    73
  val local_theory_to_proof: xstring option -> (local_theory -> Proof.state) ->
wenzelm@21007
    74
    transition -> transition
wenzelm@17363
    75
  val theory_to_proof: (theory -> Proof.state) -> transition -> transition
wenzelm@21007
    76
  val end_proof: (bool -> Proof.state -> Proof.context) -> transition -> transition
wenzelm@21007
    77
  val forget_proof: transition -> transition
wenzelm@21177
    78
  val present_proof: (bool -> node -> unit) -> transition -> transition
wenzelm@21177
    79
  val proofs': (bool -> Proof.state -> Proof.state Seq.seq) -> transition -> transition
wenzelm@17904
    80
  val proof': (bool -> Proof.state -> Proof.state) -> transition -> transition
wenzelm@21177
    81
  val proofs: (Proof.state -> Proof.state Seq.seq) -> transition -> transition
wenzelm@21177
    82
  val proof: (Proof.state -> Proof.state) -> transition -> transition
wenzelm@16815
    83
  val actual_proof: (ProofHistory.T -> ProofHistory.T) -> transition -> transition
wenzelm@16815
    84
  val skip_proof: (int History.T -> int History.T) -> transition -> transition
wenzelm@17904
    85
  val skip_proof_to_theory: (int -> bool) -> transition -> transition
wenzelm@9512
    86
  val unknown_theory: transition -> transition
wenzelm@9512
    87
  val unknown_proof: transition -> transition
wenzelm@9512
    88
  val unknown_context: transition -> transition
wenzelm@26602
    89
  val error_msg: transition -> exn * string -> unit
wenzelm@26602
    90
  val transition: bool -> transition -> state -> (state * (exn * string) option) option
wenzelm@17076
    91
  val present_excursion: (transition * (state -> state -> 'a -> 'a)) list -> 'a -> 'a
wenzelm@5828
    92
  val excursion: transition list -> unit
wenzelm@5828
    93
end;
wenzelm@5828
    94
wenzelm@6965
    95
structure Toplevel: TOPLEVEL =
wenzelm@5828
    96
struct
wenzelm@5828
    97
wenzelm@21958
    98
wenzelm@5828
    99
(** toplevel state **)
wenzelm@5828
   100
wenzelm@19063
   101
exception UNDEF;
wenzelm@19063
   102
wenzelm@19063
   103
wenzelm@21294
   104
(* local theory wrappers *)
wenzelm@5828
   105
wenzelm@20963
   106
type generic_theory = Context.generic;    (*theory or local_theory*)
wenzelm@20963
   107
wenzelm@25292
   108
val loc_init = TheoryTarget.context;
wenzelm@21294
   109
val loc_exit = ProofContext.theory_of o LocalTheory.exit;
wenzelm@21294
   110
wenzelm@25292
   111
fun loc_begin loc (Context.Theory thy) = loc_init (the_default "-" loc) thy
wenzelm@21294
   112
  | loc_begin NONE (Context.Proof lthy) = lthy
haftmann@25269
   113
  | loc_begin (SOME loc) (Context.Proof lthy) = loc_init loc (loc_exit lthy);
wenzelm@21294
   114
wenzelm@21294
   115
fun loc_finish _ (Context.Theory _) = Context.Theory o loc_exit
wenzelm@21294
   116
  | loc_finish NONE (Context.Proof _) = Context.Proof o LocalTheory.restore
wenzelm@25292
   117
  | loc_finish (SOME _) (Context.Proof lthy) = fn lthy' =>
wenzelm@25292
   118
      Context.Proof (LocalTheory.reinit (LocalTheory.raw_theory (K (loc_exit lthy')) lthy));
wenzelm@21294
   119
wenzelm@21294
   120
wenzelm@21958
   121
(* datatype node *)
wenzelm@21294
   122
wenzelm@5828
   123
datatype node =
wenzelm@20963
   124
  Theory of generic_theory * Proof.context option | (*theory with presentation context*)
wenzelm@21007
   125
  Proof of ProofHistory.T * ((Proof.context -> generic_theory) * generic_theory) |
wenzelm@21007
   126
    (*history of proof states, finish, original theory*)
wenzelm@21007
   127
  SkipProof of int History.T * (generic_theory * generic_theory);
wenzelm@18563
   128
    (*history of proof depths, resulting theory, original theory*)
wenzelm@5828
   129
wenzelm@22056
   130
val the_global_theory = fn Theory (Context.Theory thy, _) => thy | _ => raise UNDEF;
wenzelm@20963
   131
val theory_node = fn Theory (gthy, _) => SOME gthy | _ => NONE;
wenzelm@18589
   132
val proof_node = fn Proof (prf, _) => SOME prf | _ => NONE;
wenzelm@18589
   133
wenzelm@20963
   134
fun cases_node f _ (Theory (gthy, _)) = f gthy
wenzelm@19063
   135
  | cases_node _ g (Proof (prf, _)) = g (ProofHistory.current prf)
wenzelm@21007
   136
  | cases_node f _ (SkipProof (_, (gthy, _))) = f gthy;
wenzelm@19063
   137
wenzelm@20963
   138
fun presentation_context (SOME (Theory (_, SOME ctxt))) NONE = ctxt
wenzelm@20963
   139
  | presentation_context (SOME node) NONE = cases_node Context.proof_of Proof.context_of node
wenzelm@20963
   140
  | presentation_context (SOME node) (SOME loc) =
haftmann@25269
   141
      loc_init loc (cases_node Context.theory_of Proof.theory_of node)
wenzelm@20963
   142
  | presentation_context NONE _ = raise UNDEF;
wenzelm@19063
   143
wenzelm@21958
   144
wenzelm@21958
   145
(* datatype state *)
wenzelm@21958
   146
wenzelm@22056
   147
type state_info = node History.T * ((theory -> unit) * (theory -> unit));
wenzelm@5828
   148
wenzelm@21958
   149
datatype state =
wenzelm@21958
   150
  Toplevel of state_info option |  (*outer toplevel, leftover end state*)
wenzelm@21958
   151
  State of state_info;
wenzelm@5828
   152
wenzelm@21958
   153
val toplevel = Toplevel NONE;
wenzelm@21958
   154
wenzelm@21958
   155
fun is_toplevel (Toplevel _) = true
wenzelm@7732
   156
  | is_toplevel _ = false;
wenzelm@7732
   157
wenzelm@21958
   158
fun level (Toplevel _) = 0
wenzelm@21958
   159
  | level (State (node, _)) =
wenzelm@17076
   160
      (case History.current node of
wenzelm@21310
   161
        Theory _ => 0
wenzelm@21310
   162
      | Proof (prf, _) => Proof.level (ProofHistory.current prf)
wenzelm@21310
   163
      | SkipProof (h, _) => History.current h + 1);   (*different notion of proof depth!*)
wenzelm@17076
   164
wenzelm@21958
   165
fun str_of_state (Toplevel _) = "at top level"
wenzelm@21958
   166
  | str_of_state (State (node, _)) =
wenzelm@16815
   167
      (case History.current node of
wenzelm@20963
   168
        Theory (Context.Theory _, _) => "in theory mode"
wenzelm@20963
   169
      | Theory (Context.Proof _, _) => "in local theory mode"
wenzelm@16815
   170
      | Proof _ => "in proof mode"
wenzelm@16815
   171
      | SkipProof _ => "in skipped proof mode");
wenzelm@5946
   172
wenzelm@5946
   173
wenzelm@5828
   174
(* top node *)
wenzelm@5828
   175
wenzelm@21958
   176
fun node_history_of (Toplevel _) = raise UNDEF
wenzelm@21958
   177
  | node_history_of (State (node, _)) = node;
wenzelm@6689
   178
wenzelm@6689
   179
val node_of = History.current o node_history_of;
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@18589
   193
    Proof (prf, _) => ProofHistory.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@23701
   216
      Proof.pretty_state (ProofHistory.position prf) (ProofHistory.current prf)
wenzelm@23701
   217
  | SOME (SkipProof (h, _)) =>
wenzelm@23701
   218
      [Pretty.str ("skipped proof: depth " ^ string_of_int (History.current h))])
wenzelm@23701
   219
  |> Pretty.markup_chunks Markup.state |> Pretty.writeln;
wenzelm@16815
   220
wenzelm@16815
   221
wenzelm@15668
   222
wenzelm@5828
   223
(** toplevel transitions **)
wenzelm@5828
   224
wenzelm@16682
   225
val quiet = ref false;
wenzelm@22135
   226
val debug = Output.debugging;
wenzelm@17321
   227
val interact = ref false;
wenzelm@16682
   228
val timing = Output.timing;
wenzelm@16682
   229
val profiling = ref 0;
wenzelm@16815
   230
val skip_proofs = ref false;
wenzelm@16682
   231
wenzelm@5828
   232
exception TERMINATE;
wenzelm@5990
   233
exception RESTART;
wenzelm@7022
   234
exception EXCURSION_FAIL of exn * string;
wenzelm@6689
   235
exception FAILURE of state * exn;
wenzelm@24055
   236
exception TOPLEVEL_ERROR;
wenzelm@5828
   237
wenzelm@20128
   238
wenzelm@20128
   239
(* print exceptions *)
wenzelm@20128
   240
wenzelm@26256
   241
exception CONTEXT of Proof.context * exn;
wenzelm@26256
   242
wenzelm@26256
   243
fun exn_context NONE exn = exn
wenzelm@26256
   244
  | exn_context (SOME ctxt) exn = CONTEXT (ctxt, exn);
wenzelm@26256
   245
wenzelm@20128
   246
local
wenzelm@20128
   247
wenzelm@26256
   248
fun if_context NONE _ _ = []
wenzelm@26256
   249
  | if_context (SOME ctxt) f xs = map (f ctxt) xs;
wenzelm@20128
   250
wenzelm@20128
   251
fun raised name [] = "exception " ^ name ^ " raised"
wenzelm@20128
   252
  | raised name [msg] = "exception " ^ name ^ " raised: " ^ msg
wenzelm@20128
   253
  | raised name msgs = cat_lines (("exception " ^ name ^ " raised:") :: msgs);
wenzelm@20128
   254
wenzelm@20128
   255
in
wenzelm@20128
   256
wenzelm@26256
   257
fun exn_message e =
wenzelm@26256
   258
  let
wenzelm@26256
   259
    val detailed = ! debug;
wenzelm@26256
   260
wenzelm@26256
   261
    fun exn_msg _ (CONTEXT (ctxt, exn)) = exn_msg (SOME ctxt) exn
wenzelm@26256
   262
      | exn_msg ctxt (Exn.EXCEPTIONS (exns, "")) = cat_lines (map (exn_msg ctxt) exns)
wenzelm@26256
   263
      | exn_msg ctxt (Exn.EXCEPTIONS (exns, msg)) = cat_lines (map (exn_msg ctxt) exns @ [msg])
wenzelm@26293
   264
      | exn_msg ctxt (EXCURSION_FAIL (exn, loc)) =
wenzelm@26293
   265
          exn_msg ctxt exn ^ Markup.markup Markup.location ("\n" ^ loc)
wenzelm@26256
   266
      | exn_msg _ TERMINATE = "Exit."
wenzelm@26256
   267
      | exn_msg _ RESTART = "Restart."
wenzelm@26256
   268
      | exn_msg _ Interrupt = "Interrupt."
wenzelm@26256
   269
      | exn_msg _ TimeLimit.TimeOut = "Timeout."
wenzelm@26256
   270
      | exn_msg _ TOPLEVEL_ERROR = "Error."
wenzelm@26256
   271
      | exn_msg _ (SYS_ERROR msg) = "## SYSTEM ERROR ##\n" ^ msg
wenzelm@26256
   272
      | exn_msg _ (ERROR msg) = msg
wenzelm@26256
   273
      | exn_msg _ (Fail msg) = raised "Fail" [msg]
wenzelm@26256
   274
      | exn_msg _ (THEORY (msg, thys)) =
wenzelm@26256
   275
          raised "THEORY" (msg :: (if detailed then map Context.str_of_thy thys else []))
wenzelm@26256
   276
      | exn_msg _ (Syntax.AST (msg, asts)) = raised "AST" (msg ::
wenzelm@26256
   277
            (if detailed then map (Pretty.string_of o Syntax.pretty_ast) asts else []))
wenzelm@26256
   278
      | exn_msg ctxt (TYPE (msg, Ts, ts)) = raised "TYPE" (msg ::
wenzelm@26256
   279
            (if detailed then
wenzelm@26256
   280
              if_context ctxt Syntax.string_of_typ Ts @ if_context ctxt Syntax.string_of_term ts
wenzelm@26256
   281
             else []))
wenzelm@26256
   282
      | exn_msg ctxt (TERM (msg, ts)) = raised "TERM" (msg ::
wenzelm@26256
   283
            (if detailed then if_context ctxt Syntax.string_of_term ts else []))
wenzelm@26256
   284
      | exn_msg ctxt (THM (msg, i, thms)) = raised ("THM " ^ string_of_int i) (msg ::
wenzelm@26256
   285
            (if detailed then if_context ctxt ProofContext.string_of_thm thms else []))
wenzelm@26256
   286
      | exn_msg _ exn = raised (General.exnMessage exn) []
wenzelm@26256
   287
  in exn_msg NONE e end;
wenzelm@26256
   288
wenzelm@20128
   289
end;
wenzelm@20128
   290
wenzelm@20128
   291
wenzelm@20128
   292
(* controlled execution *)
wenzelm@20128
   293
wenzelm@20128
   294
local
wenzelm@20128
   295
wenzelm@18685
   296
fun debugging f x =
wenzelm@23940
   297
  if ! debug then exception_trace (fn () => f x)
wenzelm@18685
   298
  else f x;
wenzelm@18685
   299
wenzelm@26256
   300
fun toplevel_error f x =
wenzelm@26256
   301
  let val ctxt = try ML_Context.the_local_context () in
wenzelm@26256
   302
    f x handle exn =>
wenzelm@26256
   303
      (Output.error_msg (exn_message (exn_context ctxt exn)); raise TOPLEVEL_ERROR)
wenzelm@26256
   304
  end;
wenzelm@24055
   305
wenzelm@20128
   306
in
wenzelm@20128
   307
wenzelm@20128
   308
fun controlled_execution f =
wenzelm@20128
   309
  f
wenzelm@20128
   310
  |> debugging
wenzelm@24055
   311
  |> interruptible;
wenzelm@20128
   312
wenzelm@20128
   313
fun program f =
wenzelm@24055
   314
 (f
wenzelm@24055
   315
  |> debugging
wenzelm@24055
   316
  |> toplevel_error) ();
wenzelm@20128
   317
wenzelm@20128
   318
end;
wenzelm@20128
   319
wenzelm@5828
   320
wenzelm@16815
   321
(* node transactions and recovery from stale theories *)
wenzelm@6689
   322
wenzelm@16815
   323
(*NB: proof commands should be non-destructive!*)
wenzelm@7022
   324
wenzelm@6689
   325
local
wenzelm@6689
   326
wenzelm@16452
   327
fun is_stale state = Context.is_stale (theory_of state) handle UNDEF => false;
wenzelm@6689
   328
wenzelm@26256
   329
val stale_theory = ERROR "Stale theory encountered after successful execution!";
wenzelm@16815
   330
wenzelm@23363
   331
fun map_theory f = History.map_current
wenzelm@21177
   332
  (fn Theory (gthy, _) => Theory (Context.mapping f (LocalTheory.raw_theory f) gthy, NONE)
wenzelm@21177
   333
    | node => node);
wenzelm@6689
   334
skalberg@15531
   335
fun return (result, NONE) = result
skalberg@15531
   336
  | return (result, SOME exn) = raise FAILURE (result, exn);
wenzelm@7022
   337
wenzelm@6689
   338
in
wenzelm@6689
   339
wenzelm@23363
   340
fun transaction hist pos f (node, term) =
wenzelm@20128
   341
  let
wenzelm@21177
   342
    val cont_node = map_theory Theory.checkpoint node;
wenzelm@21177
   343
    val back_node = map_theory Theory.copy cont_node;
wenzelm@21958
   344
    fun state nd = State (nd, term);
wenzelm@20128
   345
    fun normal_state nd = (state nd, NONE);
wenzelm@20128
   346
    fun error_state nd exn = (state nd, SOME exn);
wenzelm@6689
   347
wenzelm@20128
   348
    val (result, err) =
wenzelm@20128
   349
      cont_node
wenzelm@20128
   350
      |> (f
wenzelm@23363
   351
          |> (if hist then History.apply' (History.current back_node) else History.map_current)
wenzelm@20128
   352
          |> controlled_execution)
wenzelm@20128
   353
      |> normal_state
wenzelm@20128
   354
      handle exn => error_state cont_node exn;
wenzelm@20128
   355
  in
wenzelm@20128
   356
    if is_stale result
wenzelm@20128
   357
    then return (error_state back_node (the_default stale_theory err))
wenzelm@20128
   358
    else return (result, err)
wenzelm@20128
   359
  end;
wenzelm@6689
   360
wenzelm@6689
   361
end;
wenzelm@6689
   362
wenzelm@6689
   363
wenzelm@6689
   364
(* primitive transitions *)
wenzelm@6689
   365
wenzelm@18563
   366
(*Note: Recovery from stale theories is provided only for theory-level
wenzelm@18589
   367
  operations via Transaction.  Other node or state operations should
wenzelm@18589
   368
  not touch theories at all.  Interrupts are enabled only for Keep and
wenzelm@18589
   369
  Transaction.*)
wenzelm@5828
   370
wenzelm@5828
   371
datatype trans =
wenzelm@22056
   372
  Init of (bool -> theory) * ((theory -> unit) * (theory -> unit)) |
wenzelm@21958
   373
                                                    (*init node; with exit/kill operation*)
wenzelm@25441
   374
  InitEmpty of (state -> bool) * (unit -> unit) |   (*init empty toplevel*)
wenzelm@21958
   375
  Exit |                                            (*conclude node -- deferred until init*)
wenzelm@21958
   376
  UndoExit |                                        (*continue after conclusion*)
wenzelm@21958
   377
  Kill |                                            (*abort node*)
wenzelm@21958
   378
  History of node History.T -> node History.T |     (*history operation (undo etc.)*)
wenzelm@21958
   379
  Keep of bool -> state -> unit |                   (*peek at state*)
wenzelm@21958
   380
  Transaction of bool * (bool -> node -> node);     (*node transaction*)
wenzelm@6689
   381
skalberg@15531
   382
fun undo_limit int = if int then NONE else SOME 0;
wenzelm@6689
   383
wenzelm@22056
   384
fun safe_exit (Toplevel (SOME (node, (exit, _)))) =
wenzelm@22056
   385
    (case try the_global_theory (History.current node) of
wenzelm@25219
   386
      SOME thy => controlled_execution exit thy
wenzelm@22056
   387
    | NONE => ())
wenzelm@22056
   388
  | safe_exit _ = ();
wenzelm@21958
   389
wenzelm@6689
   390
local
wenzelm@5828
   391
wenzelm@21958
   392
fun keep_state int f = controlled_execution (fn x => tap (f int) x);
wenzelm@21958
   393
wenzelm@23363
   394
fun apply_tr int _ (Init (f, term)) (state as Toplevel _) =
wenzelm@22056
   395
      let val node = Theory (Context.Theory (f int), NONE)
wenzelm@22056
   396
      in safe_exit state; State (History.init (undo_limit int) node, term) end
wenzelm@25441
   397
  | apply_tr int _ (InitEmpty (check, f)) (state as Toplevel _) =
wenzelm@25441
   398
      if check state then (safe_exit state; keep_state int (fn _ => fn _ => f ()) toplevel)
wenzelm@25441
   399
      else raise UNDEF
wenzelm@23363
   400
  | apply_tr _ _ Exit (State (node, term)) =
wenzelm@22056
   401
      (the_global_theory (History.current node); Toplevel (SOME (node, term)))
wenzelm@23363
   402
  | apply_tr _ _ UndoExit (Toplevel (SOME state_info)) = State state_info
wenzelm@23363
   403
  | apply_tr _ _ Kill (State (node, (_, kill))) =
wenzelm@22056
   404
      (kill (the_global_theory (History.current node)); toplevel)
wenzelm@23363
   405
  | apply_tr _ _ (History f) (State (node, term)) = State (f node, term)
wenzelm@23363
   406
  | apply_tr int _ (Keep f) state = keep_state int f state
wenzelm@23363
   407
  | apply_tr int pos (Transaction (hist, f)) (State state) =
wenzelm@23363
   408
      transaction hist pos (fn x => f int x) state
wenzelm@23363
   409
  | apply_tr _ _ _ _ = raise UNDEF;
wenzelm@5828
   410
wenzelm@23363
   411
fun apply_union _ _ [] state = raise FAILURE (state, UNDEF)
wenzelm@23363
   412
  | apply_union int pos (tr :: trs) state =
wenzelm@23363
   413
      apply_tr int pos tr state
wenzelm@23363
   414
        handle UNDEF => apply_union int pos trs state
wenzelm@23363
   415
          | FAILURE (alt_state, UNDEF) => apply_union int pos trs alt_state
wenzelm@6689
   416
          | exn as FAILURE _ => raise exn
wenzelm@6689
   417
          | exn => raise FAILURE (state, exn);
wenzelm@6689
   418
wenzelm@6689
   419
in
wenzelm@6689
   420
wenzelm@23363
   421
fun apply_trans int pos trs state = (apply_union int pos trs state, NONE)
skalberg@15531
   422
  handle FAILURE (alt_state, exn) => (alt_state, SOME exn) | exn => (state, SOME exn);
wenzelm@6689
   423
wenzelm@6689
   424
end;
wenzelm@5828
   425
wenzelm@5828
   426
wenzelm@5828
   427
(* datatype transition *)
wenzelm@5828
   428
wenzelm@5828
   429
datatype transition = Transition of
wenzelm@26621
   430
 {name: string,              (*command name*)
wenzelm@26621
   431
  pos: Position.T,           (*source position*)
wenzelm@26621
   432
  int_only: bool,            (*interactive-only*)
wenzelm@26621
   433
  print: bool,               (*print result state*)
wenzelm@26621
   434
  no_timing: bool,           (*suppress timing*)
wenzelm@26621
   435
  trans: trans list};        (*primitive transitions (union)*)
wenzelm@5828
   436
wenzelm@26621
   437
fun make_transition (name, pos, int_only, print, no_timing, trans) =
wenzelm@26621
   438
  Transition {name = name, pos = pos, int_only = int_only, print = print, no_timing = no_timing,
wenzelm@26621
   439
    trans = trans};
wenzelm@5828
   440
wenzelm@26621
   441
fun map_transition f (Transition {name, pos, int_only, print, no_timing, trans}) =
wenzelm@26621
   442
  make_transition (f (name, pos, int_only, print, no_timing, trans));
wenzelm@5828
   443
wenzelm@26621
   444
val empty = make_transition ("<unknown>", Position.none, false, false, false, []);
wenzelm@5828
   445
wenzelm@5828
   446
wenzelm@5828
   447
(* diagnostics *)
wenzelm@5828
   448
wenzelm@5828
   449
fun str_of_transition (Transition {name, pos, ...}) = quote name ^ Position.str_of pos;
wenzelm@5828
   450
wenzelm@5828
   451
fun command_msg msg tr = msg ^ "command " ^ str_of_transition tr;
wenzelm@5828
   452
fun at_command tr = command_msg "At " tr ^ ".";
wenzelm@5828
   453
wenzelm@5828
   454
fun type_error tr state =
wenzelm@18685
   455
  ERROR (command_msg "Illegal application of " tr ^ " " ^ str_of_state state);
wenzelm@5828
   456
wenzelm@5828
   457
wenzelm@5828
   458
(* modify transitions *)
wenzelm@5828
   459
wenzelm@26621
   460
fun name nm = map_transition (fn (_, pos, int_only, print, no_timing, trans) =>
wenzelm@26621
   461
  (nm, pos, int_only, print, no_timing, trans));
wenzelm@9010
   462
wenzelm@26621
   463
fun position pos = map_transition (fn (name, _, int_only, print, no_timing, trans) =>
wenzelm@26621
   464
  (name, pos, int_only, print, no_timing, trans));
wenzelm@5828
   465
wenzelm@26621
   466
fun interactive int_only = map_transition (fn (name, pos, _, print, no_timing, trans) =>
wenzelm@26621
   467
  (name, pos, int_only, print, no_timing, trans));
wenzelm@14923
   468
wenzelm@26621
   469
val no_timing = map_transition (fn (name, pos, int_only, print, _, trans) =>
wenzelm@26621
   470
  (name, pos, int_only, print, true, trans));
wenzelm@17363
   471
wenzelm@26621
   472
fun add_trans tr = map_transition (fn (name, pos, int_only, print, no_timing, trans) =>
wenzelm@26621
   473
  (name, pos, int_only, print, no_timing, trans @ [tr]));
wenzelm@16607
   474
wenzelm@26621
   475
val print = map_transition (fn (name, pos, int_only, _, no_timing, trans) =>
wenzelm@26621
   476
  (name, pos, int_only, true, no_timing, trans));
wenzelm@5828
   477
wenzelm@5828
   478
wenzelm@21007
   479
(* basic transitions *)
wenzelm@5828
   480
wenzelm@22056
   481
fun init_theory f exit kill = add_trans (Init (f, (exit, kill)));
wenzelm@25441
   482
fun init_empty check f = add_trans (InitEmpty (check, f));
wenzelm@6689
   483
val exit = add_trans Exit;
wenzelm@21958
   484
val undo_exit = add_trans UndoExit;
wenzelm@6689
   485
val kill = add_trans Kill;
wenzelm@20128
   486
val history = add_trans o History;
wenzelm@7612
   487
val keep' = add_trans o Keep;
wenzelm@18592
   488
fun map_current f = add_trans (Transaction (false, f));
wenzelm@18592
   489
fun app_current f = add_trans (Transaction (true, f));
wenzelm@5828
   490
wenzelm@7612
   491
fun keep f = add_trans (Keep (fn _ => f));
wenzelm@5828
   492
fun imperative f = keep (fn _ => f ());
wenzelm@5828
   493
wenzelm@21007
   494
val unknown_theory = imperative (fn () => warning "Unknown theory context");
wenzelm@21007
   495
val unknown_proof = imperative (fn () => warning "Unknown proof context");
wenzelm@21007
   496
val unknown_context = imperative (fn () => warning "Unknown context");
wenzelm@15668
   497
wenzelm@21007
   498
wenzelm@21007
   499
(* theory transitions *)
wenzelm@15668
   500
wenzelm@26491
   501
fun generic_theory f = app_current (fn _ =>
wenzelm@26491
   502
  (fn Theory (gthy, _) => Theory (f gthy, NONE)
wenzelm@26491
   503
    | _ => raise UNDEF));
wenzelm@26491
   504
wenzelm@20963
   505
fun theory' f = app_current (fn int =>
wenzelm@20963
   506
  (fn Theory (Context.Theory thy, _) => Theory (Context.Theory (f int thy), NONE)
wenzelm@20963
   507
    | _ => raise UNDEF));
wenzelm@20963
   508
wenzelm@20963
   509
fun theory f = theory' (K f);
wenzelm@20963
   510
wenzelm@21294
   511
fun begin_local_theory begin f = app_current (fn _ =>
wenzelm@20963
   512
  (fn Theory (Context.Theory thy, _) =>
wenzelm@20963
   513
        let
wenzelm@20985
   514
          val lthy = f thy;
wenzelm@21294
   515
          val gthy = if begin then Context.Proof lthy else Context.Theory (loc_exit lthy);
wenzelm@21294
   516
        in Theory (gthy, SOME lthy) end
wenzelm@20963
   517
    | _ => raise UNDEF));
wenzelm@17076
   518
wenzelm@21294
   519
val end_local_theory = app_current (fn _ =>
wenzelm@21294
   520
  (fn Theory (Context.Proof lthy, _) => Theory (Context.Theory (loc_exit lthy), SOME lthy)
wenzelm@21007
   521
    | _ => raise UNDEF));
wenzelm@21007
   522
wenzelm@21007
   523
local
wenzelm@21007
   524
wenzelm@20963
   525
fun local_theory_presentation loc f g = app_current (fn int =>
wenzelm@21294
   526
  (fn Theory (gthy, _) =>
wenzelm@21294
   527
        let
wenzelm@21294
   528
          val finish = loc_finish loc gthy;
wenzelm@25960
   529
          val lthy' = f (loc_begin loc gthy);
wenzelm@21294
   530
        in Theory (finish lthy', SOME lthy') end
wenzelm@20963
   531
    | _ => raise UNDEF) #> tap (g int));
wenzelm@15668
   532
wenzelm@21007
   533
in
wenzelm@21007
   534
wenzelm@20963
   535
fun local_theory loc f = local_theory_presentation loc f (K I);
wenzelm@20963
   536
fun present_local_theory loc g = local_theory_presentation loc I g;
wenzelm@18955
   537
wenzelm@21007
   538
end;
wenzelm@21007
   539
wenzelm@21007
   540
wenzelm@21007
   541
(* proof transitions *)
wenzelm@21007
   542
wenzelm@21007
   543
fun end_proof f = map_current (fn int =>
wenzelm@24795
   544
  (fn Proof (prf, (finish, _)) =>
wenzelm@21007
   545
        let val state = ProofHistory.current prf in
wenzelm@21007
   546
          if can (Proof.assert_bottom true) state then
wenzelm@21007
   547
            let
wenzelm@21007
   548
              val ctxt' = f int state;
wenzelm@21007
   549
              val gthy' = finish ctxt';
wenzelm@21007
   550
            in Theory (gthy', SOME ctxt') end
wenzelm@21007
   551
          else raise UNDEF
wenzelm@21007
   552
        end
wenzelm@21007
   553
    | SkipProof (h, (gthy, _)) =>
wenzelm@21007
   554
        if History.current h = 0 then Theory (gthy, NONE) else raise UNDEF
wenzelm@21007
   555
    | _ => raise UNDEF));
wenzelm@21007
   556
wenzelm@21294
   557
local
wenzelm@21294
   558
wenzelm@21294
   559
fun begin_proof init finish = app_current (fn int =>
wenzelm@21294
   560
  (fn Theory (gthy, _) =>
wenzelm@21294
   561
    let
berghofe@24453
   562
      val prf = init int gthy;
wenzelm@21294
   563
      val schematic = Proof.schematic_goal prf;
wenzelm@21294
   564
    in
wenzelm@21294
   565
      if ! skip_proofs andalso schematic then
wenzelm@21294
   566
        warning "Cannot skip proof of schematic goal statement"
wenzelm@21294
   567
      else ();
wenzelm@21294
   568
      if ! skip_proofs andalso not schematic then
wenzelm@21294
   569
        SkipProof
wenzelm@21294
   570
          (History.init (undo_limit int) 0, (finish gthy (Proof.global_skip_proof int prf), gthy))
wenzelm@21294
   571
      else Proof (ProofHistory.init (undo_limit int) prf, (finish gthy, gthy))
wenzelm@21294
   572
    end
wenzelm@21294
   573
  | _ => raise UNDEF));
wenzelm@21294
   574
wenzelm@21294
   575
in
wenzelm@21294
   576
wenzelm@24780
   577
fun local_theory_to_proof' loc f = begin_proof
wenzelm@25960
   578
  (fn int => fn gthy => f int (loc_begin loc gthy))
wenzelm@24780
   579
  (loc_finish loc);
wenzelm@24780
   580
berghofe@24453
   581
fun local_theory_to_proof loc f = local_theory_to_proof' loc (K f);
wenzelm@21294
   582
wenzelm@21294
   583
fun theory_to_proof f = begin_proof
wenzelm@24780
   584
  (K (fn Context.Theory thy => f thy | _ => raise UNDEF))
wenzelm@24780
   585
  (K (Context.Theory o ProofContext.theory_of));
wenzelm@21294
   586
wenzelm@21294
   587
end;
wenzelm@21294
   588
wenzelm@21007
   589
val forget_proof = map_current (fn _ =>
wenzelm@21007
   590
  (fn Proof (_, (_, orig_gthy)) => Theory (orig_gthy, NONE)
wenzelm@21007
   591
    | SkipProof (_, (_, orig_gthy)) => Theory (orig_gthy, NONE)
wenzelm@21007
   592
    | _ => raise UNDEF));
wenzelm@21007
   593
wenzelm@21177
   594
fun present_proof f = map_current (fn int =>
wenzelm@21177
   595
  (fn Proof (prf, x) => Proof (ProofHistory.apply I prf, x)
wenzelm@21177
   596
    | SkipProof (h, x) => SkipProof (History.apply I h, x)
wenzelm@21177
   597
    | _ => raise UNDEF) #> tap (f int));
wenzelm@21177
   598
wenzelm@17904
   599
fun proofs' f = map_current (fn int =>
wenzelm@21007
   600
  (fn Proof (prf, x) => Proof (ProofHistory.applys (f int) prf, x)
wenzelm@21007
   601
    | SkipProof (h, x) => SkipProof (History.apply I h, x)
wenzelm@16815
   602
    | _ => raise UNDEF));
wenzelm@15668
   603
wenzelm@17904
   604
fun proof' f = proofs' (Seq.single oo f);
wenzelm@17904
   605
val proofs = proofs' o K;
wenzelm@6689
   606
val proof = proof' o K;
wenzelm@16815
   607
wenzelm@16815
   608
fun actual_proof f = map_current (fn _ =>
wenzelm@21007
   609
  (fn Proof (prf, x) => Proof (f prf, x)
wenzelm@20963
   610
    | _ => raise UNDEF));
wenzelm@16815
   611
wenzelm@16815
   612
fun skip_proof f = map_current (fn _ =>
wenzelm@21007
   613
  (fn SkipProof (h, x) => SkipProof (f h, x)
wenzelm@18563
   614
    | _ => raise UNDEF));
wenzelm@18563
   615
wenzelm@16815
   616
fun skip_proof_to_theory p = map_current (fn _ =>
wenzelm@21007
   617
  (fn SkipProof (h, (gthy, _)) =>
wenzelm@21007
   618
    if p (History.current h) then Theory (gthy, NONE)
wenzelm@17904
   619
    else raise UNDEF
wenzelm@17904
   620
  | _ => raise UNDEF));
wenzelm@5828
   621
wenzelm@5828
   622
wenzelm@5828
   623
wenzelm@5828
   624
(** toplevel transactions **)
wenzelm@5828
   625
wenzelm@25960
   626
(* thread position *)
wenzelm@25799
   627
wenzelm@25960
   628
fun setmp_thread_position (Transition {pos, ...}) f x =
wenzelm@25819
   629
  Position.setmp_thread_data pos f x;
wenzelm@25799
   630
wenzelm@26602
   631
fun error_msg tr exn_info =
wenzelm@26602
   632
  setmp_thread_position tr (fn () => Output.error_msg (exn_message (EXCURSION_FAIL exn_info))) ();
wenzelm@26602
   633
wenzelm@25799
   634
wenzelm@5828
   635
(* apply transitions *)
wenzelm@5828
   636
wenzelm@6664
   637
local
wenzelm@6664
   638
wenzelm@25799
   639
fun app int (tr as Transition {trans, pos, int_only, print, no_timing, ...}) =
wenzelm@25819
   640
  setmp_thread_position tr (fn state =>
wenzelm@25799
   641
    let
wenzelm@26621
   642
      val _ = if not int andalso int_only then warning (command_msg "Interactive-only " tr) else ();
wenzelm@16682
   643
wenzelm@25799
   644
      fun do_timing f x = (warning (command_msg "" tr); timeap f x);
wenzelm@25799
   645
      fun do_profiling f x = profile (! profiling) f x;
wenzelm@25799
   646
wenzelm@26256
   647
      val (result, status) =
wenzelm@25799
   648
         state |> (apply_trans int pos trans
wenzelm@25799
   649
          |> (if ! profiling > 0 andalso not no_timing then do_profiling else I)
wenzelm@25799
   650
          |> (if ! profiling > 0 orelse ! timing andalso not no_timing then do_timing else I));
wenzelm@26256
   651
wenzelm@26621
   652
      val _ = if int andalso not (! quiet) andalso print then print_state false result else ();
wenzelm@26256
   653
    in (result, Option.map (fn UNDEF => type_error tr state | exn => exn) status) end);
wenzelm@6664
   654
wenzelm@6664
   655
in
wenzelm@5828
   656
wenzelm@26602
   657
fun transition int tr st =
wenzelm@26256
   658
  let val ctxt = try context_of st in
wenzelm@26256
   659
    (case app int tr st of
wenzelm@26256
   660
      (_, SOME TERMINATE) => NONE
wenzelm@26256
   661
    | (_, SOME RESTART) => SOME (toplevel, NONE)
wenzelm@26256
   662
    | (state', SOME (EXCURSION_FAIL exn_info)) => SOME (state', SOME exn_info)
wenzelm@26256
   663
    | (state', SOME exn) => SOME (state', SOME (exn_context ctxt exn, at_command tr))
wenzelm@26256
   664
    | (state', NONE) => SOME (state', NONE))
wenzelm@26256
   665
  end;
wenzelm@6664
   666
wenzelm@6664
   667
end;
wenzelm@5828
   668
wenzelm@5828
   669
wenzelm@17076
   670
(* excursion: toplevel -- apply transformers/presentation -- toplevel *)
wenzelm@5828
   671
wenzelm@6664
   672
local
wenzelm@6664
   673
wenzelm@5828
   674
fun excur [] x = x
wenzelm@17076
   675
  | excur ((tr, pr) :: trs) (st, res) =
wenzelm@26602
   676
      (case transition (! interact) tr st of
skalberg@15531
   677
        SOME (st', NONE) =>
wenzelm@18685
   678
          excur trs (st', pr st st' res handle exn =>
wenzelm@10324
   679
            raise EXCURSION_FAIL (exn, "Presentation failed\n" ^ at_command tr))
skalberg@15531
   680
      | SOME (st', SOME exn_info) => raise EXCURSION_FAIL exn_info
skalberg@15531
   681
      | NONE => raise EXCURSION_FAIL (TERMINATE, at_command tr));
wenzelm@5828
   682
wenzelm@17076
   683
fun no_pr _ _ _ = ();
wenzelm@17076
   684
wenzelm@6664
   685
in
wenzelm@6664
   686
wenzelm@17076
   687
fun present_excursion trs res =
wenzelm@21958
   688
  (case excur trs (toplevel, res) of
wenzelm@22056
   689
    (state as Toplevel _, res') => (safe_exit state; res')
wenzelm@18685
   690
  | _ => error "Unfinished development at end of input")
wenzelm@9134
   691
  handle exn => error (exn_message exn);
wenzelm@9134
   692
wenzelm@17076
   693
fun excursion trs = present_excursion (map (rpair no_pr) trs) ();
wenzelm@7062
   694
wenzelm@6664
   695
end;
wenzelm@6664
   696
wenzelm@5828
   697
end;