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