src/Pure/Isar/toplevel.ML
author wenzelm
Tue Jul 04 18:39:59 2006 +0200 (2006-07-04)
changeset 19996 a4332e71c1de
parent 19841 f2fa72c13186
child 20128 8f0e07d7cf92
permissions -rw-r--r--
skip_proofs: do not skip proofs of schematic goals (warning);
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@5828
     5
The Isabelle/Isar toplevel.
wenzelm@5828
     6
*)
wenzelm@5828
     7
wenzelm@5828
     8
signature TOPLEVEL =
wenzelm@5828
     9
sig
wenzelm@19063
    10
  exception UNDEF
wenzelm@18589
    11
  type node
wenzelm@18589
    12
  val theory_node: node -> theory option
wenzelm@18589
    13
  val proof_node: node -> ProofHistory.T option
wenzelm@19063
    14
  val cases_node: (theory -> 'a) -> (Proof.state -> 'a) -> node -> 'a
wenzelm@19063
    15
  val body_context_node: node option -> xstring option -> Proof.context
wenzelm@5828
    16
  type state
wenzelm@5828
    17
  val toplevel: state
wenzelm@7732
    18
  val is_toplevel: state -> bool
wenzelm@18589
    19
  val is_theory: state -> bool
wenzelm@18589
    20
  val is_proof: state -> bool
wenzelm@17076
    21
  val level: state -> int
wenzelm@17266
    22
  val assert: bool -> unit
wenzelm@6689
    23
  val node_history_of: state -> node History.T
wenzelm@5828
    24
  val node_of: state -> node
wenzelm@6664
    25
  val node_case: (theory -> 'a) -> (Proof.state -> 'a) -> state -> 'a
wenzelm@18641
    26
  val context_of: state -> Context.generic
wenzelm@5828
    27
  val theory_of: state -> theory
wenzelm@5828
    28
  val proof_of: state -> Proof.state
wenzelm@18589
    29
  val proof_position_of: state -> int
wenzelm@9453
    30
  val enter_forward_proof: state -> Proof.state
wenzelm@16815
    31
  val prompt_state_default: state -> string
wenzelm@16815
    32
  val prompt_state_fn: (state -> string) ref
wenzelm@16815
    33
  val print_state_context: state -> unit
wenzelm@16815
    34
  val print_state_default: bool -> state -> unit
wenzelm@16815
    35
  val print_state_hook: (bool -> state -> unit) -> unit
wenzelm@16815
    36
  val print_state_fn: (bool -> state -> unit) ref
wenzelm@16815
    37
  val print_state: bool -> state -> unit
wenzelm@16815
    38
  val pretty_state: bool -> state -> Pretty.T list
wenzelm@16682
    39
  val quiet: bool ref
wenzelm@16682
    40
  val debug: bool ref
wenzelm@17321
    41
  val interact: bool ref
wenzelm@16682
    42
  val timing: bool ref
wenzelm@16682
    43
  val profiling: int ref
wenzelm@16815
    44
  val skip_proofs: bool ref
wenzelm@5828
    45
  exception TERMINATE
wenzelm@5990
    46
  exception RESTART
wenzelm@18589
    47
  val checkpoint: state -> state
wenzelm@18589
    48
  val copy: state -> state
wenzelm@16682
    49
  type transition
wenzelm@6689
    50
  val undo_limit: bool -> int option
wenzelm@5828
    51
  val empty: transition
wenzelm@14923
    52
  val name_of: transition -> string
wenzelm@14923
    53
  val source_of: transition -> OuterLex.token list option
wenzelm@5828
    54
  val name: string -> transition -> transition
wenzelm@5828
    55
  val position: Position.T -> transition -> transition
wenzelm@14923
    56
  val source: OuterLex.token list -> transition -> transition
wenzelm@5828
    57
  val interactive: bool -> transition -> transition
wenzelm@5828
    58
  val print: transition -> transition
wenzelm@16607
    59
  val print': string -> transition -> transition
wenzelm@17363
    60
  val three_buffersN: string
wenzelm@17363
    61
  val print3: transition -> transition
wenzelm@9010
    62
  val no_timing: transition -> transition
wenzelm@5828
    63
  val reset: transition -> transition
wenzelm@8465
    64
  val init: (bool -> node) -> (node -> unit) -> (node -> unit) -> transition -> transition
wenzelm@6689
    65
  val exit: transition -> transition
wenzelm@6689
    66
  val kill: transition -> transition
wenzelm@5828
    67
  val keep: (state -> unit) -> transition -> transition
wenzelm@7612
    68
  val keep': (bool -> state -> unit) -> transition -> transition
wenzelm@6689
    69
  val history: (node History.T -> node History.T) -> transition -> transition
wenzelm@5828
    70
  val imperative: (unit -> unit) -> transition -> transition
wenzelm@7105
    71
  val init_theory: (bool -> theory) -> (theory -> unit) -> (theory -> unit)
wenzelm@6689
    72
    -> transition -> transition
wenzelm@5828
    73
  val theory: (theory -> theory) -> transition -> transition
wenzelm@7612
    74
  val theory': (bool -> theory -> theory) -> transition -> transition
wenzelm@18811
    75
  val theory_context: (theory -> Proof.context * theory) -> transition -> transition
wenzelm@19063
    76
  val local_theory: xstring option -> (local_theory -> local_theory) ->
wenzelm@19063
    77
    transition -> transition
wenzelm@17363
    78
  val theory_to_proof: (theory -> Proof.state) -> transition -> transition
wenzelm@17904
    79
  val proof: (Proof.state -> Proof.state) -> transition -> transition
wenzelm@17904
    80
  val proofs: (Proof.state -> Proof.state Seq.seq) -> transition -> transition
wenzelm@17904
    81
  val proof': (bool -> Proof.state -> Proof.state) -> transition -> transition
wenzelm@17904
    82
  val proofs': (bool -> Proof.state -> Proof.state Seq.seq) -> 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 proof_to_theory: (Proof.state -> theory) -> transition -> transition
wenzelm@17904
    86
  val proof_to_theory': (bool -> Proof.state -> theory) -> transition -> transition
wenzelm@18811
    87
  val proof_to_theory_context: (bool -> Proof.state -> Proof.context * theory)
wenzelm@17076
    88
    -> transition -> transition
wenzelm@17904
    89
  val skip_proof_to_theory: (int -> bool) -> transition -> transition
wenzelm@18563
    90
  val forget_proof: transition -> transition
wenzelm@19063
    91
  val present_local_theory: xstring option -> (bool -> node -> unit) -> transition -> transition
wenzelm@19063
    92
  val present_proof: (bool -> node -> unit) -> transition -> transition
wenzelm@9512
    93
  val unknown_theory: transition -> transition
wenzelm@9512
    94
  val unknown_proof: transition -> transition
wenzelm@9512
    95
  val unknown_context: transition -> transition
wenzelm@5922
    96
  val exn_message: exn -> string
wenzelm@5828
    97
  val apply: bool -> transition -> state -> (state * (exn * string) option) option
wenzelm@17076
    98
  val present_excursion: (transition * (state -> state -> 'a -> 'a)) list -> 'a -> 'a
wenzelm@5828
    99
  val excursion: transition list -> unit
wenzelm@18685
   100
  val program: (unit -> 'a) -> 'a
wenzelm@5828
   101
  val set_state: state -> unit
wenzelm@5828
   102
  val get_state: unit -> state
wenzelm@5828
   103
  val exn: unit -> (exn * string) option
wenzelm@5828
   104
  val >> : transition -> bool
wenzelm@14985
   105
  val >>> : transition list -> unit
nipkow@14091
   106
  type 'a isar
nipkow@14091
   107
  val loop: 'a isar -> unit
wenzelm@5828
   108
end;
wenzelm@5828
   109
wenzelm@6965
   110
structure Toplevel: TOPLEVEL =
wenzelm@5828
   111
struct
wenzelm@5828
   112
wenzelm@5828
   113
wenzelm@5828
   114
(** toplevel state **)
wenzelm@5828
   115
wenzelm@19063
   116
exception UNDEF;
wenzelm@19063
   117
wenzelm@19063
   118
wenzelm@16815
   119
(* datatype state *)
wenzelm@5828
   120
wenzelm@5828
   121
datatype node =
wenzelm@18563
   122
  Theory of theory * Proof.context option |        (*theory with optional body context*)
wenzelm@18563
   123
  Proof of ProofHistory.T * theory |               (*history of proof states, original theory*)
wenzelm@18563
   124
  SkipProof of (int History.T * theory) * theory;
wenzelm@18563
   125
    (*history of proof depths, resulting theory, original theory*)
wenzelm@5828
   126
wenzelm@18589
   127
val theory_node = fn Theory (thy, _) => SOME thy | _ => NONE;
wenzelm@18589
   128
val proof_node = fn Proof (prf, _) => SOME prf | _ => NONE;
wenzelm@18589
   129
wenzelm@19063
   130
fun cases_node f _ (Theory (thy, _)) = f thy
wenzelm@19063
   131
  | cases_node _ g (Proof (prf, _)) = g (ProofHistory.current prf)
wenzelm@19063
   132
  | cases_node f _ (SkipProof ((_, thy), _)) = f thy;
wenzelm@19063
   133
wenzelm@19063
   134
fun body_context_node (SOME (Theory (_, SOME ctxt))) NONE = ctxt
wenzelm@19063
   135
  | body_context_node (SOME node) loc =
wenzelm@19063
   136
      node |> cases_node (LocalTheory.init loc)
wenzelm@19063
   137
       (if is_some loc then LocalTheory.init loc o Proof.theory_of
wenzelm@19063
   138
        else Proof.context_of)
wenzelm@19063
   139
  | body_context_node NONE _ = raise UNDEF;
wenzelm@19063
   140
wenzelm@8465
   141
datatype state = State of (node History.T * ((node -> unit) * (node -> unit))) option;
wenzelm@5828
   142
skalberg@15531
   143
val toplevel = State NONE;
wenzelm@5828
   144
skalberg@15531
   145
fun is_toplevel (State NONE) = true
wenzelm@7732
   146
  | is_toplevel _ = false;
wenzelm@7732
   147
wenzelm@17076
   148
fun level (State NONE) = 0
wenzelm@17076
   149
  | level (State (SOME (node, _))) =
wenzelm@17076
   150
      (case History.current node of
wenzelm@17076
   151
        Theory _ => 0
wenzelm@18563
   152
      | Proof (prf, _) => Proof.level (ProofHistory.current prf)
wenzelm@18563
   153
      | SkipProof ((h, _), _) => History.current h + 1);    (*different notion of proof depth!*)
wenzelm@17076
   154
skalberg@15531
   155
fun str_of_state (State NONE) = "at top level"
wenzelm@16815
   156
  | str_of_state (State (SOME (node, _))) =
wenzelm@16815
   157
      (case History.current node of
wenzelm@16815
   158
        Theory _ => "in theory mode"
wenzelm@16815
   159
      | Proof _ => "in proof mode"
wenzelm@16815
   160
      | SkipProof _ => "in skipped proof mode");
wenzelm@5946
   161
wenzelm@5946
   162
wenzelm@5828
   163
(* top node *)
wenzelm@5828
   164
wenzelm@17266
   165
fun assert true = ()
wenzelm@17266
   166
  | assert false = raise UNDEF;
wenzelm@17266
   167
skalberg@15531
   168
fun node_history_of (State NONE) = raise UNDEF
skalberg@15531
   169
  | node_history_of (State (SOME (node, _))) = node;
wenzelm@6689
   170
wenzelm@6689
   171
val node_of = History.current o node_history_of;
wenzelm@5828
   172
wenzelm@18589
   173
fun is_theory state = not (is_toplevel state) andalso is_some (theory_node (node_of state));
wenzelm@18589
   174
fun is_proof state = not (is_toplevel state) andalso is_some (proof_node (node_of state));
wenzelm@18589
   175
wenzelm@19063
   176
fun node_case f g state = cases_node f g (node_of state);
wenzelm@5828
   177
wenzelm@18641
   178
val context_of = node_case Context.Theory (Context.Proof o Proof.context_of);
wenzelm@6664
   179
val theory_of = node_case I Proof.theory_of;
wenzelm@18589
   180
val proof_of = node_case (fn _ => raise UNDEF) I;
wenzelm@17208
   181
wenzelm@18589
   182
fun proof_position_of state =
wenzelm@18589
   183
  (case node_of state of
wenzelm@18589
   184
    Proof (prf, _) => ProofHistory.position prf
wenzelm@18589
   185
  | _ => raise UNDEF);
wenzelm@6664
   186
wenzelm@17363
   187
val enter_forward_proof = node_case (Proof.init o ProofContext.init) Proof.enter_forward;
wenzelm@5828
   188
wenzelm@5828
   189
wenzelm@16815
   190
(* prompt state *)
wenzelm@16815
   191
wenzelm@16815
   192
fun prompt_state_default (State _) = Source.default_prompt;
wenzelm@16815
   193
wenzelm@16815
   194
val prompt_state_fn = ref prompt_state_default;
wenzelm@16815
   195
fun prompt_state state = ! prompt_state_fn state;
wenzelm@16815
   196
wenzelm@16815
   197
wenzelm@16815
   198
(* print state *)
wenzelm@16815
   199
wenzelm@16815
   200
fun pretty_context thy = [Pretty.block
wenzelm@16815
   201
  [Pretty.str "theory", Pretty.brk 1, Pretty.str (Context.theory_name thy),
wenzelm@16815
   202
    Pretty.str " =", Pretty.brk 1, ThyInfo.pretty_theory thy]];
wenzelm@16815
   203
wenzelm@16815
   204
fun pretty_state_context state =
wenzelm@16815
   205
  (case try theory_of state of NONE => []
wenzelm@16815
   206
  | SOME thy => pretty_context thy);
wenzelm@16815
   207
wenzelm@17076
   208
fun pretty_node prf_only (Theory (thy, _)) = if prf_only then [] else pretty_context thy
wenzelm@18563
   209
  | pretty_node _ (Proof (prf, _)) =
wenzelm@16815
   210
      Proof.pretty_state (ProofHistory.position prf) (ProofHistory.current prf)
wenzelm@18563
   211
  | pretty_node _ (SkipProof ((h, _), _)) =
wenzelm@16815
   212
      [Pretty.str ("skipped proof: depth " ^ string_of_int (History.current h))];
wenzelm@16815
   213
wenzelm@16815
   214
fun pretty_state prf_only state =
wenzelm@16815
   215
  let val ref (begin_state, end_state, _) = Display.current_goals_markers in
wenzelm@16815
   216
    (case try node_of state of NONE => []
wenzelm@16815
   217
    | SOME node =>
wenzelm@16815
   218
        (if begin_state = "" then [] else [Pretty.str begin_state]) @
wenzelm@16815
   219
        pretty_node prf_only node @
wenzelm@16815
   220
        (if end_state = "" then [] else [Pretty.str end_state]))
wenzelm@16815
   221
  end;
wenzelm@16815
   222
wenzelm@16815
   223
val print_state_context = Pretty.writelns o pretty_state_context;
wenzelm@16815
   224
fun print_state_default prf_only state = Pretty.writelns (pretty_state prf_only state);
wenzelm@16815
   225
wenzelm@16815
   226
val print_state_hooks = ref ([]: (bool -> state -> unit) list);
wenzelm@16815
   227
fun print_state_hook f = change print_state_hooks (cons f);
wenzelm@16815
   228
val print_state_fn = ref print_state_default;
wenzelm@16815
   229
wenzelm@16815
   230
fun print_state prf_only state =
wenzelm@16815
   231
 (List.app (fn f => (try (fn () => f prf_only state) (); ())) (! print_state_hooks);
wenzelm@16815
   232
  ! print_state_fn prf_only state);
wenzelm@16815
   233
wenzelm@16815
   234
wenzelm@15668
   235
wenzelm@5828
   236
(** toplevel transitions **)
wenzelm@5828
   237
wenzelm@16682
   238
val quiet = ref false;
wenzelm@16682
   239
val debug = ref false;
wenzelm@17321
   240
val interact = ref false;
wenzelm@16682
   241
val timing = Output.timing;
wenzelm@16682
   242
val profiling = ref 0;
wenzelm@16815
   243
val skip_proofs = ref false;
wenzelm@16682
   244
wenzelm@5828
   245
exception TERMINATE;
wenzelm@5990
   246
exception RESTART;
wenzelm@7022
   247
exception EXCURSION_FAIL of exn * string;
wenzelm@6689
   248
exception FAILURE of state * exn;
wenzelm@5828
   249
wenzelm@18685
   250
fun debugging f x =
wenzelm@18685
   251
  if ! debug then
wenzelm@18685
   252
    setmp Library.do_transform_failure false
wenzelm@18685
   253
      exception_trace (fn () => f x)
wenzelm@18685
   254
  else f x;
wenzelm@18685
   255
wenzelm@5828
   256
wenzelm@16815
   257
(* node transactions and recovery from stale theories *)
wenzelm@6689
   258
wenzelm@16815
   259
(*NB: proof commands should be non-destructive!*)
wenzelm@7022
   260
wenzelm@6689
   261
local
wenzelm@6689
   262
wenzelm@16452
   263
fun is_stale state = Context.is_stale (theory_of state) handle UNDEF => false;
wenzelm@6689
   264
wenzelm@18685
   265
val stale_theory = ERROR "Stale theory encountered after succesful execution!";
wenzelm@16815
   266
wenzelm@19101
   267
fun checkpoint_node (Theory (thy, _)) = Theory (Theory.checkpoint thy, NONE)
wenzelm@18592
   268
  | checkpoint_node node = node;
wenzelm@6689
   269
wenzelm@19101
   270
fun copy_node (Theory (thy, _)) = Theory (Theory.copy thy, NONE)
wenzelm@18592
   271
  | copy_node node = node;
wenzelm@6689
   272
skalberg@15531
   273
fun return (result, NONE) = result
skalberg@15531
   274
  | return (result, SOME exn) = raise FAILURE (result, exn);
wenzelm@7022
   275
wenzelm@16729
   276
fun interruptible f x =
wenzelm@16729
   277
  let val y = ref x
wenzelm@16729
   278
  in raise_interrupt (fn () => y := f x) (); ! y end;
wenzelm@16729
   279
wenzelm@6689
   280
in
wenzelm@6689
   281
wenzelm@18592
   282
fun transaction _ _ (State NONE) = raise UNDEF
wenzelm@18592
   283
  | transaction hist f (State (SOME (node, term))) =
wenzelm@6689
   284
      let
wenzelm@18592
   285
        val cont_node = History.map checkpoint_node node;
wenzelm@18592
   286
        val back_node = History.map copy_node cont_node;
wenzelm@16729
   287
        fun state nd = State (SOME (nd, term));
wenzelm@16729
   288
        fun normal_state nd = (state nd, NONE);
wenzelm@16729
   289
        fun error_state nd exn = (state nd, SOME exn);
wenzelm@6689
   290
wenzelm@16729
   291
        val (result, err) =
wenzelm@16729
   292
          cont_node
wenzelm@18563
   293
          |> (f
wenzelm@18592
   294
              |> (if hist then History.apply_copy copy_node else History.map)
wenzelm@18685
   295
              |> debugging
wenzelm@16729
   296
              |> interruptible
wenzelm@18685
   297
              |> setmp Output.do_toplevel_errors false)
wenzelm@16729
   298
          |> normal_state
wenzelm@16729
   299
          handle exn => error_state cont_node exn;
wenzelm@6689
   300
      in
wenzelm@16729
   301
        if is_stale result
wenzelm@18955
   302
        then return (error_state back_node (the_default stale_theory err))
wenzelm@16729
   303
        else return (result, err)
wenzelm@6689
   304
      end;
wenzelm@6689
   305
wenzelm@18589
   306
fun mapping f (State (SOME (node, term))) = State (SOME (History.map f node, term))
wenzelm@18589
   307
  | mapping _ state = state;
wenzelm@18589
   308
wenzelm@18592
   309
val checkpoint = mapping checkpoint_node;
wenzelm@18592
   310
val copy = mapping copy_node;
wenzelm@18589
   311
wenzelm@6689
   312
end;
wenzelm@6689
   313
wenzelm@6689
   314
wenzelm@6689
   315
(* primitive transitions *)
wenzelm@6689
   316
wenzelm@18563
   317
(*Note: Recovery from stale theories is provided only for theory-level
wenzelm@18589
   318
  operations via Transaction.  Other node or state operations should
wenzelm@18589
   319
  not touch theories at all.  Interrupts are enabled only for Keep and
wenzelm@18589
   320
  Transaction.*)
wenzelm@5828
   321
wenzelm@5828
   322
datatype trans =
wenzelm@18563
   323
  Reset |                                               (*empty toplevel*)
wenzelm@8465
   324
  Init of (bool -> node) * ((node -> unit) * (node -> unit)) |
wenzelm@18563
   325
                                                        (*init node; with exit/kill operation*)
wenzelm@18563
   326
  Exit |                                                (*conclude node*)
wenzelm@18563
   327
  Kill |                                                (*abort node*)
wenzelm@18563
   328
  Keep of bool -> state -> unit |                       (*peek at state*)
wenzelm@18563
   329
  History of node History.T -> node History.T |         (*history operation (undo etc.)*)
wenzelm@18592
   330
  Transaction of bool * (bool -> node -> node);         (*node transaction*)
wenzelm@6689
   331
skalberg@15531
   332
fun undo_limit int = if int then NONE else SOME 0;
wenzelm@6689
   333
wenzelm@6689
   334
local
wenzelm@5828
   335
wenzelm@6689
   336
fun apply_tr _ Reset _ = toplevel
skalberg@15531
   337
  | apply_tr int (Init (f, term)) (State NONE) =
skalberg@15531
   338
      State (SOME (History.init (undo_limit int) (f int), term))
skalberg@15531
   339
  | apply_tr _ (Init _ ) (State (SOME _)) = raise UNDEF
skalberg@15531
   340
  | apply_tr _ Exit (State NONE) = raise UNDEF
skalberg@15531
   341
  | apply_tr _ Exit (State (SOME (node, (exit, _)))) =
skalberg@15531
   342
      (exit (History.current node); State NONE)
skalberg@15531
   343
  | apply_tr _ Kill (State NONE) = raise UNDEF
skalberg@15531
   344
  | apply_tr _ Kill (State (SOME (node, (_, kill)))) =
skalberg@15531
   345
      (kill (History.current node); State NONE)
wenzelm@18718
   346
  | apply_tr int (Keep f) state =
wenzelm@18718
   347
      (setmp Output.do_toplevel_errors false (raise_interrupt (f int)) state; state)
skalberg@15531
   348
  | apply_tr _ (History _) (State NONE) = raise UNDEF
skalberg@15531
   349
  | apply_tr _ (History f) (State (SOME (node, term))) = State (SOME (f node, term))
wenzelm@18592
   350
  | apply_tr int (Transaction (hist, f)) state = transaction hist (fn x => f int x) state;
wenzelm@5828
   351
wenzelm@6689
   352
fun apply_union _ [] state = raise FAILURE (state, UNDEF)
wenzelm@6689
   353
  | apply_union int (tr :: trs) state =
wenzelm@18685
   354
      apply_tr int tr state
wenzelm@6689
   355
        handle UNDEF => apply_union int trs state
wenzelm@6689
   356
          | FAILURE (alt_state, UNDEF) => apply_union int trs alt_state
wenzelm@6689
   357
          | exn as FAILURE _ => raise exn
wenzelm@6689
   358
          | exn => raise FAILURE (state, exn);
wenzelm@6689
   359
wenzelm@6689
   360
in
wenzelm@6689
   361
skalberg@15531
   362
fun apply_trans int trs state = (apply_union int trs state, NONE)
skalberg@15531
   363
  handle FAILURE (alt_state, exn) => (alt_state, SOME exn) | exn => (state, SOME exn);
wenzelm@6689
   364
wenzelm@6689
   365
end;
wenzelm@5828
   366
wenzelm@5828
   367
wenzelm@5828
   368
(* datatype transition *)
wenzelm@5828
   369
wenzelm@5828
   370
datatype transition = Transition of
wenzelm@16815
   371
 {name: string,                        (*command name*)
wenzelm@16815
   372
  pos: Position.T,                     (*source position*)
wenzelm@16815
   373
  source: OuterLex.token list option,  (*source text*)
wenzelm@16815
   374
  int_only: bool,                      (*interactive-only*)
wenzelm@16815
   375
  print: string list,                  (*print modes (union)*)
wenzelm@16815
   376
  no_timing: bool,                     (*suppress timing*)
wenzelm@16815
   377
  trans: trans list};                  (*primitive transitions (union)*)
wenzelm@5828
   378
wenzelm@14923
   379
fun make_transition (name, pos, source, int_only, print, no_timing, trans) =
wenzelm@14923
   380
  Transition {name = name, pos = pos, source = source,
wenzelm@14923
   381
    int_only = int_only, print = print, no_timing = no_timing, trans = trans};
wenzelm@5828
   382
wenzelm@14923
   383
fun map_transition f (Transition {name, pos, source, int_only, print, no_timing, trans}) =
wenzelm@14923
   384
  make_transition (f (name, pos, source, int_only, print, no_timing, trans));
wenzelm@5828
   385
wenzelm@16607
   386
val empty = make_transition ("<unknown>", Position.none, NONE, false, [], false, []);
wenzelm@14923
   387
wenzelm@14923
   388
fun name_of (Transition {name, ...}) = name;
wenzelm@14923
   389
fun source_of (Transition {source, ...}) = source;
wenzelm@5828
   390
wenzelm@5828
   391
wenzelm@5828
   392
(* diagnostics *)
wenzelm@5828
   393
wenzelm@5828
   394
fun str_of_transition (Transition {name, pos, ...}) = quote name ^ Position.str_of pos;
wenzelm@5828
   395
wenzelm@5828
   396
fun command_msg msg tr = msg ^ "command " ^ str_of_transition tr;
wenzelm@5828
   397
fun at_command tr = command_msg "At " tr ^ ".";
wenzelm@5828
   398
wenzelm@5828
   399
fun type_error tr state =
wenzelm@18685
   400
  ERROR (command_msg "Illegal application of " tr ^ " " ^ str_of_state state);
wenzelm@5828
   401
wenzelm@5828
   402
wenzelm@5828
   403
(* modify transitions *)
wenzelm@5828
   404
wenzelm@14923
   405
fun name nm = map_transition (fn (_, pos, source, int_only, print, no_timing, trans) =>
wenzelm@14923
   406
  (nm, pos, source, int_only, print, no_timing, trans));
wenzelm@5828
   407
wenzelm@14923
   408
fun position pos = map_transition (fn (name, _, source, int_only, print, no_timing, trans) =>
wenzelm@14923
   409
  (name, pos, source, int_only, print, no_timing, trans));
wenzelm@9010
   410
wenzelm@14923
   411
fun source src = map_transition (fn (name, pos, _, int_only, print, no_timing, trans) =>
skalberg@15531
   412
  (name, pos, SOME src, int_only, print, no_timing, trans));
wenzelm@5828
   413
wenzelm@14923
   414
fun interactive int_only = map_transition (fn (name, pos, source, _, print, no_timing, trans) =>
wenzelm@14923
   415
  (name, pos, source, int_only, print, no_timing, trans));
wenzelm@14923
   416
wenzelm@17363
   417
val no_timing = map_transition (fn (name, pos, source, int_only, print, _, trans) =>
wenzelm@17363
   418
  (name, pos, source, int_only, print, true, trans));
wenzelm@17363
   419
wenzelm@17363
   420
fun add_trans tr = map_transition (fn (name, pos, source, int_only, print, no_timing, trans) =>
wenzelm@17363
   421
  (name, pos, source, int_only, print, no_timing, trans @ [tr]));
wenzelm@17363
   422
wenzelm@16607
   423
fun print' mode = map_transition (fn (name, pos, source, int_only, print, no_timing, trans) =>
wenzelm@16607
   424
  (name, pos, source, int_only, insert (op =) mode print, no_timing, trans));
wenzelm@16607
   425
wenzelm@16607
   426
val print = print' "";
wenzelm@5828
   427
wenzelm@17363
   428
val three_buffersN = "three_buffers";
wenzelm@17363
   429
val print3 = print' three_buffersN;
wenzelm@5828
   430
wenzelm@5828
   431
wenzelm@5828
   432
(* build transitions *)
wenzelm@5828
   433
wenzelm@5828
   434
val reset = add_trans Reset;
wenzelm@6689
   435
fun init f exit kill = add_trans (Init (f, (exit, kill)));
wenzelm@6689
   436
val exit = add_trans Exit;
wenzelm@6689
   437
val kill = add_trans Kill;
wenzelm@7612
   438
val keep' = add_trans o Keep;
wenzelm@6689
   439
val history = add_trans o History;
wenzelm@18592
   440
fun map_current f = add_trans (Transaction (false, f));
wenzelm@18592
   441
fun app_current f = add_trans (Transaction (true, f));
wenzelm@5828
   442
wenzelm@7612
   443
fun keep f = add_trans (Keep (fn _ => f));
wenzelm@5828
   444
fun imperative f = keep (fn _ => f ());
wenzelm@5828
   445
wenzelm@6689
   446
fun init_theory f exit kill =
wenzelm@17076
   447
  init (fn int => Theory (f int, NONE))
wenzelm@17076
   448
    (fn Theory (thy, _) => exit thy | _ => raise UNDEF)
wenzelm@17076
   449
    (fn Theory (thy, _) => kill thy | _ => raise UNDEF);
wenzelm@5828
   450
wenzelm@15668
   451
wenzelm@15668
   452
(* typed transitions *)
wenzelm@15668
   453
wenzelm@18592
   454
fun theory f = app_current
wenzelm@18563
   455
  (K (fn Theory (thy, _) => Theory (f thy, NONE) | _ => raise UNDEF));
wenzelm@18563
   456
wenzelm@18592
   457
fun theory' f = app_current (fn int =>
wenzelm@17076
   458
  (fn Theory (thy, _) => Theory (f int thy, NONE) | _ => raise UNDEF));
wenzelm@17076
   459
wenzelm@18592
   460
fun theory_context f = app_current
wenzelm@18811
   461
  (K (fn Theory (thy, _) => Theory (swap (apfst SOME (f thy))) | _ => raise UNDEF));
wenzelm@15668
   462
wenzelm@19063
   463
fun local_theory loc f = theory_context (LocalTheory.mapping loc f);
wenzelm@18955
   464
wenzelm@18592
   465
fun theory_to_proof f = app_current (fn int =>
wenzelm@17076
   466
  (fn Theory (thy, _) =>
wenzelm@19996
   467
    let
wenzelm@19996
   468
      val prf = f thy;
wenzelm@19996
   469
      val schematic = Proof.schematic_goal prf;
wenzelm@19996
   470
    in
wenzelm@19996
   471
      if ! skip_proofs andalso schematic then
wenzelm@19996
   472
        warning "Cannot skip proof of schematic goal statement"
wenzelm@19996
   473
      else ();
wenzelm@19996
   474
      if ! skip_proofs andalso not schematic then
wenzelm@19996
   475
        SkipProof ((History.init (undo_limit int) 0, #2 (Proof.global_skip_proof int prf)), thy)
wenzelm@19996
   476
      else Proof (ProofHistory.init (undo_limit int) prf, thy)
wenzelm@19996
   477
    end
wenzelm@18592
   478
  | _ => raise UNDEF));
wenzelm@18563
   479
wenzelm@17904
   480
fun proofs' f = map_current (fn int =>
wenzelm@18563
   481
  (fn Proof (prf, orig_thy) => Proof (ProofHistory.applys (f int) prf, orig_thy)
wenzelm@18563
   482
    | SkipProof ((h, thy), orig_thy) => SkipProof ((History.apply I h, thy), orig_thy)
wenzelm@16815
   483
    | _ => raise UNDEF));
wenzelm@15668
   484
wenzelm@17904
   485
fun proof' f = proofs' (Seq.single oo f);
wenzelm@17904
   486
val proofs = proofs' o K;
wenzelm@6689
   487
val proof = proof' o K;
wenzelm@16815
   488
wenzelm@16815
   489
fun actual_proof f = map_current (fn _ =>
wenzelm@18563
   490
  (fn Proof (prf, orig_thy) => Proof (f prf, orig_thy) | _ => raise UNDEF));
wenzelm@16815
   491
wenzelm@16815
   492
fun skip_proof f = map_current (fn _ =>
wenzelm@18563
   493
  (fn SkipProof ((h, thy), orig_thy) => SkipProof ((f h, thy), orig_thy) | _ => raise UNDEF));
wenzelm@15668
   494
wenzelm@17904
   495
fun end_proof f = map_current (fn int =>
wenzelm@18563
   496
  (fn Proof (prf, _) => Theory (f int (ProofHistory.current prf))
wenzelm@18563
   497
    | SkipProof ((h, thy), _) => if History.current h = 0 then Theory (thy, NONE) else raise UNDEF
wenzelm@18563
   498
    | _ => raise UNDEF));
wenzelm@18563
   499
wenzelm@18563
   500
val forget_proof = map_current (fn _ =>
wenzelm@18563
   501
  (fn Proof (_, orig_thy) => Theory (orig_thy, NONE)
wenzelm@18563
   502
    | SkipProof (_, orig_thy) => Theory (orig_thy, NONE)
berghofe@15237
   503
    | _ => raise UNDEF));
wenzelm@15668
   504
wenzelm@17076
   505
fun proof_to_theory' f = end_proof (rpair NONE oo f);
wenzelm@17076
   506
fun proof_to_theory f = proof_to_theory' (K f);
wenzelm@18811
   507
fun proof_to_theory_context f = end_proof ((swap o apfst SOME) oo f);
wenzelm@15668
   508
wenzelm@16815
   509
fun skip_proof_to_theory p = map_current (fn _ =>
wenzelm@18563
   510
  (fn SkipProof ((h, thy), _) =>
wenzelm@17904
   511
    if p (History.current h) then Theory (thy, NONE)
wenzelm@17904
   512
    else raise UNDEF
wenzelm@17904
   513
  | _ => raise UNDEF));
wenzelm@5828
   514
wenzelm@19063
   515
fun present_local_theory loc f = app_current (fn int =>
wenzelm@19063
   516
  (fn Theory (thy, _) => Theory (swap (apfst SOME (LocalTheory.mapping loc I thy)))
wenzelm@19063
   517
    | _ => raise UNDEF) #> tap (f int));
wenzelm@19063
   518
wenzelm@19063
   519
fun present_proof f = map_current (fn int =>
wenzelm@19063
   520
  (fn node as Proof _ => node | _ => raise UNDEF) #> tap (f int));
wenzelm@19063
   521
wenzelm@9512
   522
val unknown_theory = imperative (fn () => warning "Unknown theory context");
wenzelm@9512
   523
val unknown_proof = imperative (fn () => warning "Unknown proof context");
wenzelm@9512
   524
val unknown_context = imperative (fn () => warning "Unknown context");
wenzelm@9512
   525
wenzelm@5828
   526
wenzelm@5828
   527
wenzelm@5828
   528
(** toplevel transactions **)
wenzelm@5828
   529
wenzelm@5828
   530
(* print exceptions *)
wenzelm@5828
   531
wenzelm@15668
   532
local
wenzelm@15668
   533
wenzelm@15668
   534
fun with_context f xs =
wenzelm@15668
   535
  (case Context.get_context () of NONE => []
wenzelm@16452
   536
  | SOME thy => map (f thy) xs);
wenzelm@15668
   537
wenzelm@15668
   538
fun raised name [] = "exception " ^ name ^ " raised"
wenzelm@15668
   539
  | raised name [msg] = "exception " ^ name ^ " raised: " ^ msg
wenzelm@15668
   540
  | raised name msgs = cat_lines (("exception " ^ name ^ " raised:") :: msgs);
wenzelm@5828
   541
wenzelm@15668
   542
fun exn_msg _ TERMINATE = "Exit."
wenzelm@15668
   543
  | exn_msg _ RESTART = "Restart."
wenzelm@15668
   544
  | exn_msg _ Interrupt = "Interrupt."
wenzelm@18685
   545
  | exn_msg _ Output.TOPLEVEL_ERROR = "Error."
wenzelm@19545
   546
  | exn_msg _ (SYS_ERROR msg) = "## SYSTEM ERROR ##\n" ^ msg
wenzelm@18685
   547
  | exn_msg _ (ERROR msg) = msg
wenzelm@17363
   548
  | exn_msg detailed (EXCEPTION (exn, msg)) = cat_lines [exn_msg detailed exn, msg]
wenzelm@16452
   549
  | exn_msg detailed (EXCURSION_FAIL (exn, msg)) = cat_lines [exn_msg detailed exn, msg]
wenzelm@15668
   550
  | exn_msg false (THEORY (msg, _)) = msg
wenzelm@16452
   551
  | exn_msg true (THEORY (msg, thys)) = raised "THEORY" (msg :: map Context.str_of_thy thys)
wenzelm@15668
   552
  | exn_msg detailed (MetaSimplifier.SIMPROC_FAIL (name, exn)) =
wenzelm@15668
   553
      fail_msg detailed "simproc" ((name, Position.none), exn)
wenzelm@15668
   554
  | exn_msg detailed (Attrib.ATTRIB_FAIL info) = fail_msg detailed "attribute" info
wenzelm@15668
   555
  | exn_msg detailed (Method.METHOD_FAIL info) = fail_msg detailed "method" info
wenzelm@15668
   556
  | exn_msg detailed (Antiquote.ANTIQUOTE_FAIL info) = fail_msg detailed "antiquotation" info
wenzelm@15668
   557
  | exn_msg false (Syntax.AST (msg, _)) = raised "AST" [msg]
wenzelm@15668
   558
  | exn_msg true (Syntax.AST (msg, asts)) =
wenzelm@15668
   559
      raised "AST" (msg :: map (Pretty.string_of o Syntax.pretty_ast) asts)
wenzelm@15668
   560
  | exn_msg false (TYPE (msg, _, _)) = raised "TYPE" [msg]
wenzelm@15668
   561
  | exn_msg true (TYPE (msg, Ts, ts)) = raised "TYPE" (msg ::
wenzelm@15668
   562
        with_context Sign.string_of_typ Ts @ with_context Sign.string_of_term ts)
wenzelm@15668
   563
  | exn_msg false (TERM (msg, _)) = raised "TERM" [msg]
wenzelm@15668
   564
  | exn_msg true (TERM (msg, ts)) = raised "TERM" (msg :: with_context Sign.string_of_term ts)
wenzelm@15668
   565
  | exn_msg false (THM (msg, _, _)) = raised "THM" [msg]
wenzelm@15668
   566
  | exn_msg true (THM (msg, i, thms)) =
wenzelm@15668
   567
      raised ("THM " ^ string_of_int i) (msg :: map Display.string_of_thm thms)
wenzelm@19841
   568
  | exn_msg _ Option.Option = raised "Option" []
wenzelm@19841
   569
  | exn_msg _ Library.UnequalLengths = raised "UnequalLengths" []
wenzelm@15668
   570
  | exn_msg _ Empty = raised "Empty" []
wenzelm@15668
   571
  | exn_msg _ Subscript = raised "Subscript" []
wenzelm@16197
   572
  | exn_msg _ (Fail msg) = raised "Fail" [msg]
wenzelm@15668
   573
  | exn_msg _ exn = General.exnMessage exn
wenzelm@15668
   574
and fail_msg detailed kind ((name, pos), exn) =
wenzelm@15668
   575
  "Error in " ^ kind ^ " " ^ quote name ^ Position.str_of pos ^ ":\n" ^ exn_msg detailed exn;
ballarin@15519
   576
wenzelm@15668
   577
in
wenzelm@15668
   578
wenzelm@15668
   579
fun exn_message exn = exn_msg (! debug) exn;
wenzelm@5828
   580
skalberg@15531
   581
fun print_exn NONE = ()
wenzelm@18685
   582
  | print_exn (SOME (exn, s)) = Output.error_msg (cat_lines [exn_message exn, s]);
wenzelm@5828
   583
wenzelm@15668
   584
end;
wenzelm@15668
   585
wenzelm@5828
   586
wenzelm@5828
   587
(* apply transitions *)
wenzelm@5828
   588
wenzelm@6664
   589
local
wenzelm@6664
   590
wenzelm@9010
   591
fun app int (tr as Transition {trans, int_only, print, no_timing, ...}) state =
wenzelm@5828
   592
  let
wenzelm@16682
   593
    val _ = conditional (not int andalso int_only) (fn () =>
wenzelm@16682
   594
      warning (command_msg "Interactive-only " tr));
wenzelm@16682
   595
wenzelm@18685
   596
    fun do_timing f x = (Output.info (command_msg "" tr); timeap f x);
wenzelm@16682
   597
    fun do_profiling f x = profile (! profiling) f x;
wenzelm@16682
   598
wenzelm@6689
   599
    val (result, opt_exn) =
wenzelm@16729
   600
       state |> (apply_trans int trans
wenzelm@16729
   601
        |> (if ! profiling > 0 then do_profiling else I)
wenzelm@16729
   602
        |> (if ! profiling > 0 orelse ! timing andalso not no_timing then do_timing else I));
wenzelm@16607
   603
    val _ = conditional (int andalso not (! quiet) andalso
wenzelm@16607
   604
        exists (fn m => m mem_string print) ("" :: ! print_mode))
wenzelm@16607
   605
      (fn () => print_state false result);
skalberg@15570
   606
  in (result, Option.map (fn UNDEF => type_error tr state | exn => exn) opt_exn) end;
wenzelm@6664
   607
wenzelm@6664
   608
in
wenzelm@5828
   609
wenzelm@6689
   610
fun apply int tr st =
wenzelm@6965
   611
  (case app int tr st of
skalberg@15531
   612
    (_, SOME TERMINATE) => NONE
skalberg@15531
   613
  | (_, SOME RESTART) => SOME (toplevel, NONE)
skalberg@15531
   614
  | (state', SOME (EXCURSION_FAIL exn_info)) => SOME (state', SOME exn_info)
skalberg@15531
   615
  | (state', SOME exn) => SOME (state', SOME (exn, at_command tr))
skalberg@15531
   616
  | (state', NONE) => SOME (state', NONE));
wenzelm@6664
   617
wenzelm@6664
   618
end;
wenzelm@5828
   619
wenzelm@5828
   620
wenzelm@17076
   621
(* excursion: toplevel -- apply transformers/presentation -- toplevel *)
wenzelm@5828
   622
wenzelm@6664
   623
local
wenzelm@6664
   624
wenzelm@5828
   625
fun excur [] x = x
wenzelm@17076
   626
  | excur ((tr, pr) :: trs) (st, res) =
wenzelm@17321
   627
      (case apply (! interact) tr st of
skalberg@15531
   628
        SOME (st', NONE) =>
wenzelm@18685
   629
          excur trs (st', pr st st' res handle exn =>
wenzelm@10324
   630
            raise EXCURSION_FAIL (exn, "Presentation failed\n" ^ at_command tr))
skalberg@15531
   631
      | SOME (st', SOME exn_info) => raise EXCURSION_FAIL exn_info
skalberg@15531
   632
      | NONE => raise EXCURSION_FAIL (TERMINATE, at_command tr));
wenzelm@5828
   633
wenzelm@17076
   634
fun no_pr _ _ _ = ();
wenzelm@17076
   635
wenzelm@6664
   636
in
wenzelm@6664
   637
wenzelm@17076
   638
fun present_excursion trs res =
skalberg@15531
   639
  (case excur trs (State NONE, res) of
skalberg@15531
   640
    (State NONE, res') => res'
wenzelm@18685
   641
  | _ => error "Unfinished development at end of input")
wenzelm@9134
   642
  handle exn => error (exn_message exn);
wenzelm@9134
   643
wenzelm@17076
   644
fun excursion trs = present_excursion (map (rpair no_pr) trs) ();
wenzelm@7062
   645
wenzelm@6664
   646
end;
wenzelm@6664
   647
wenzelm@5828
   648
wenzelm@18718
   649
(* toplevel program: independent of state *)
wenzelm@18685
   650
wenzelm@18685
   651
fun program f =
wenzelm@18718
   652
  Output.ML_errors (fn () => debugging f () handle exn => error (exn_message exn)) ();
wenzelm@18685
   653
wenzelm@18685
   654
wenzelm@5828
   655
wenzelm@5828
   656
(** interactive transformations **)
wenzelm@5828
   657
wenzelm@5828
   658
(* the global state reference *)
wenzelm@5828
   659
skalberg@15531
   660
val global_state = ref (toplevel, NONE: (exn * string) option);
wenzelm@5828
   661
skalberg@15531
   662
fun set_state state = global_state := (state, NONE);
wenzelm@5828
   663
fun get_state () = fst (! global_state);
wenzelm@5828
   664
fun exn () = snd (! global_state);
wenzelm@5828
   665
wenzelm@5828
   666
wenzelm@6965
   667
(* the Isar source of transitions *)
wenzelm@6965
   668
nipkow@14091
   669
type 'a isar =
wenzelm@6965
   670
  (transition, (transition option,
wenzelm@12881
   671
    (OuterLex.token, (OuterLex.token option, (OuterLex.token, (OuterLex.token,
nipkow@14091
   672
      Position.T * (Symbol.symbol, (string, 'a) Source.source) Source.source)
wenzelm@12881
   673
          Source.source) Source.source) Source.source) Source.source) Source.source) Source.source;
wenzelm@6965
   674
wenzelm@6965
   675
wenzelm@5828
   676
(* apply transformers to global state *)
wenzelm@5828
   677
wenzelm@14985
   678
nonfix >> >>>;
wenzelm@5828
   679
wenzelm@5828
   680
fun >> tr =
wenzelm@5828
   681
  (case apply true tr (get_state ()) of
skalberg@15531
   682
    NONE => false
skalberg@15531
   683
  | SOME (state', exn_info) =>
wenzelm@5828
   684
      (global_state := (state', exn_info);
wenzelm@16729
   685
        print_exn exn_info;
wenzelm@5828
   686
        true));
wenzelm@5828
   687
wenzelm@14985
   688
fun >>> [] = ()
wenzelm@14985
   689
  | >>> (tr :: trs) = if >> tr then >>> trs else ();
wenzelm@14985
   690
wenzelm@17513
   691
(*Spurious interrupts ahead!  Race condition?*)
wenzelm@17513
   692
fun get_interrupt src = SOME (Source.get_single src) handle Interrupt => NONE;
wenzelm@7602
   693
wenzelm@5828
   694
fun raw_loop src =
wenzelm@7602
   695
  (case get_interrupt (Source.set_prompt (prompt_state (get_state ())) src) of
skalberg@15531
   696
    NONE => (writeln "\nInterrupt."; raw_loop src)
skalberg@15531
   697
  | SOME NONE => ()
skalberg@15531
   698
  | SOME (SOME (tr, src')) => if >> tr then raw_loop src' else ());
wenzelm@5828
   699
wenzelm@12987
   700
fun loop src = ignore_interrupt raw_loop src;
wenzelm@5828
   701
wenzelm@5828
   702
end;