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