src/Doc/Isar_Ref/Outer_Syntax.thy
author wenzelm
Mon, 06 Jul 2015 20:13:51 +0200
changeset 60674 2f66099fb472
parent 60631 441fdbfbb2d3
child 61252 c165f0472d57
permissions -rw-r--r--
clarified sections;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
     1
theory Outer_Syntax
42651
e3fdb7c96be5 formal Base theory;
wenzelm
parents: 42596
diff changeset
     2
imports Base Main
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
     3
begin
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
     4
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
     5
chapter \<open>Outer syntax --- the theory language \label{ch:outer-syntax}\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
     6
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
     7
text \<open>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
     8
  The rather generic framework of Isabelle/Isar syntax emerges from
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
     9
  three main syntactic categories: \emph{commands} of the top-level
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    10
  Isar engine (covering theory and proof elements), \emph{methods} for
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    11
  general goal refinements (analogous to traditional ``tactics''), and
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    12
  \emph{attributes} for operations on facts (within a certain
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    13
  context).  Subsequently we give a reference of basic syntactic
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    14
  entities underlying Isabelle/Isar syntax in a bottom-up manner.
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    15
  Concrete theory and proof language elements will be introduced later
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    16
  on.
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    17
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    18
  \medskip In order to get started with writing well-formed
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    19
  Isabelle/Isar documents, the most important aspect to be noted is
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    20
  the difference of \emph{inner} versus \emph{outer} syntax.  Inner
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    21
  syntax is that of Isabelle types and terms of the logic, while outer
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    22
  syntax is that of Isabelle/Isar theory sources (specifications and
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    23
  proofs).  As a general rule, inner syntax entities may occur only as
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    24
  \emph{atomic entities} within outer syntax.  For example, the string
58724
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
    25
  @{verbatim \<open>"x + y"\<close>} and identifier @{verbatim z} are legal term
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    26
  specifications within a theory, while @{verbatim "x + y"} without
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    27
  quotes is not.
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    28
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    29
  Printed theory documents usually omit quotes to gain readability
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    30
  (this is a matter of {\LaTeX} macro setup, say via @{verbatim
60270
wenzelm
parents: 60131
diff changeset
    31
  "\\isabellestyle"}, see also @{cite "isabelle-system"}).  Experienced
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    32
  users of Isabelle/Isar may easily reconstruct the lost technical
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    33
  information, while mere readers need not care about quotes at all.
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
    34
\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    35
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    36
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
    37
section \<open>Commands\<close>
50213
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    38
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
    39
text \<open>
50213
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    40
  \begin{matharray}{rcl}
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    41
    @{command_def "print_commands"}@{text "\<^sup>*"} & : & @{text "any \<rightarrow>"} \\
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    42
    @{command_def "help"}@{text "\<^sup>*"} & : & @{text "any \<rightarrow>"} \\
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    43
  \end{matharray}
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    44
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
    45
  @{rail \<open>
50213
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    46
    @@{command help} (@{syntax name} * )
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
    47
  \<close>}
50213
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    48
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    49
  \begin{description}
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    50
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    51
  \item @{command "print_commands"} prints all outer syntax keywords
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    52
  and commands.
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    53
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    54
  \item @{command "help"}~@{text "pats"} retrieves outer syntax
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    55
  commands according to the specified name patterns.
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    56
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    57
  \end{description}
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
    58
\<close>
50213
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    59
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    60
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
    61
subsubsection \<open>Examples\<close>
50213
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    62
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
    63
text \<open>Some common diagnostic commands are retrieved like this
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
    64
  (according to usual naming conventions):\<close>
50213
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    65
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    66
help "print"
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    67
help "find"
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    68
7b73c0509835 refined outer syntax 'help' command;
wenzelm
parents: 48985
diff changeset
    69
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
    70
section \<open>Lexical matters \label{sec:outer-lex}\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    71
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
    72
text \<open>The outer lexical syntax consists of three main categories of
28776
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
    73
  syntax tokens:
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    74
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    75
  \begin{enumerate}
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    76
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    77
  \item \emph{major keywords} --- the command names that are available
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    78
  in the present logic session;
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    79
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    80
  \item \emph{minor keywords} --- additional literal tokens required
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    81
  by the syntax of commands;
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    82
28776
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
    83
  \item \emph{named tokens} --- various categories of identifiers etc.
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
    84
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    85
  \end{enumerate}
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    86
28776
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
    87
  Major keywords and minor keywords are guaranteed to be disjoint.
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    88
  This helps user-interfaces to determine the overall structure of a
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    89
  theory text, without knowing the full details of command syntax.
28776
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
    90
  Internally, there is some additional information about the kind of
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
    91
  major keywords, which approximates the command type (theory command,
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
    92
  proof command etc.).
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    93
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    94
  Keywords override named tokens.  For example, the presence of a
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    95
  command called @{verbatim term} inhibits the identifier @{verbatim
58724
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
    96
  term}, but the string @{verbatim \<open>"term"\<close>} can be used instead.
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    97
  By convention, the outer syntax always allows quoted strings in
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    98
  addition to identifiers, wherever a named entity is expected.
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
    99
28776
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
   100
  When tokenizing a given input sequence, the lexer repeatedly takes
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
   101
  the longest prefix of the input that forms a valid token.  Spaces,
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
   102
  tabs, newlines and formfeeds between tokens serve as explicit
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
   103
  separators.
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
   104
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   105
  \medskip The categories for named tokens are defined once and for
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   106
  all as follows.
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   107
28776
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
   108
  \begin{center}
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   109
  \begin{supertabular}{rcl}
53059
f4811f3628dc updated identifier syntax;
wenzelm
parents: 53015
diff changeset
   110
    @{syntax_def ident} & = & @{text "letter (subscript\<^sup>? quasiletter)\<^sup>*"} \\
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   111
    @{syntax_def longident} & = & @{text "ident("}@{verbatim "."}@{text "ident)\<^sup>+"} \\
58724
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
   112
    @{syntax_def symident} & = & @{text "sym\<^sup>+  |  "}@{verbatim \<open>\\<close>}@{verbatim "<"}@{text ident}@{verbatim ">"} \\
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   113
    @{syntax_def nat} & = & @{text "digit\<^sup>+"} \\
40290
47f572aff50a support for floating-point tokens in outer syntax (coinciding with inner syntax version);
wenzelm
parents: 35841
diff changeset
   114
    @{syntax_def float} & = & @{syntax_ref nat}@{verbatim "."}@{syntax_ref nat}@{text "  |  "}@{verbatim "-"}@{syntax_ref nat}@{verbatim "."}@{syntax_ref nat} \\
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   115
    @{syntax_def var} & = & @{verbatim "?"}@{text "ident  |  "}@{verbatim "?"}@{text ident}@{verbatim "."}@{text nat} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   116
    @{syntax_def typefree} & = & @{verbatim "'"}@{text ident} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   117
    @{syntax_def typevar} & = & @{verbatim "?"}@{text "typefree  |  "}@{verbatim "?"}@{text typefree}@{verbatim "."}@{text nat} \\
58724
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
   118
    @{syntax_def string} & = & @{verbatim \<open>"\<close>} @{text "\<dots>"} @{verbatim \<open>"\<close>} \\
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   119
    @{syntax_def altstring} & = & @{verbatim "`"} @{text "\<dots>"} @{verbatim "`"} \\
55033
8e8243975860 support for nested text cartouches;
wenzelm
parents: 53059
diff changeset
   120
    @{syntax_def cartouche} & = & @{verbatim "\<open>"} @{text "\<dots>"} @{verbatim "\<close>"} \\
58725
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   121
    @{syntax_def verbatim} & = & @{verbatim "{*"} @{text "\<dots>"} @{verbatim "*}"} \\[1ex]
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   122
58724
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
   123
    @{text letter} & = & @{text "latin  |  "}@{verbatim \<open>\\<close>}@{verbatim "<"}@{text latin}@{verbatim ">"}@{text "  |  "}@{verbatim \<open>\\<close>}@{verbatim "<"}@{text "latin latin"}@{verbatim ">"}@{text "  |  greek  |"} \\
53059
f4811f3628dc updated identifier syntax;
wenzelm
parents: 53015
diff changeset
   124
    @{text subscript} & = & @{verbatim "\<^sub>"} \\
28775
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   125
    @{text quasiletter} & = & @{text "letter  |  digit  |  "}@{verbatim "_"}@{text "  |  "}@{verbatim "'"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   126
    @{text latin} & = & @{verbatim a}@{text "  | \<dots> |  "}@{verbatim z}@{text "  |  "}@{verbatim A}@{text "  |  \<dots> |  "}@{verbatim Z} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   127
    @{text digit} & = & @{verbatim "0"}@{text "  |  \<dots> |  "}@{verbatim "9"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   128
    @{text sym} & = & @{verbatim "!"}@{text "  |  "}@{verbatim "#"}@{text "  |  "}@{verbatim "$"}@{text "  |  "}@{verbatim "%"}@{text "  |  "}@{verbatim "&"}@{text "  |  "}@{verbatim "*"}@{text "  |  "}@{verbatim "+"}@{text "  |  "}@{verbatim "-"}@{text "  |  "}@{verbatim "/"}@{text "  |"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   129
    & & @{verbatim "<"}@{text "  |  "}@{verbatim "="}@{text "  |  "}@{verbatim ">"}@{text "  |  "}@{verbatim "?"}@{text "  |  "}@{verbatim "@"}@{text "  |  "}@{verbatim "^"}@{text "  |  "}@{verbatim "_"}@{text "  |  "}@{verbatim "|"}@{text "  |  "}@{verbatim "~"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   130
    @{text greek} & = & @{verbatim "\<alpha>"}@{text "  |  "}@{verbatim "\<beta>"}@{text "  |  "}@{verbatim "\<gamma>"}@{text "  |  "}@{verbatim "\<delta>"}@{text "  |"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   131
          &   & @{verbatim "\<epsilon>"}@{text "  |  "}@{verbatim "\<zeta>"}@{text "  |  "}@{verbatim "\<eta>"}@{text "  |  "}@{verbatim "\<theta>"}@{text "  |"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   132
          &   & @{verbatim "\<iota>"}@{text "  |  "}@{verbatim "\<kappa>"}@{text "  |  "}@{verbatim "\<mu>"}@{text "  |  "}@{verbatim "\<nu>"}@{text "  |"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   133
          &   & @{verbatim "\<xi>"}@{text "  |  "}@{verbatim "\<pi>"}@{text "  |  "}@{verbatim "\<rho>"}@{text "  |  "}@{verbatim "\<sigma>"}@{text "  |  "}@{verbatim "\<tau>"}@{text "  |"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   134
          &   & @{verbatim "\<upsilon>"}@{text "  |  "}@{verbatim "\<phi>"}@{text "  |  "}@{verbatim "\<chi>"}@{text "  |  "}@{verbatim "\<psi>"}@{text "  |"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   135
          &   & @{verbatim "\<omega>"}@{text "  |  "}@{verbatim "\<Gamma>"}@{text "  |  "}@{verbatim "\<Delta>"}@{text "  |  "}@{verbatim "\<Theta>"}@{text "  |"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   136
          &   & @{verbatim "\<Lambda>"}@{text "  |  "}@{verbatim "\<Xi>"}@{text "  |  "}@{verbatim "\<Pi>"}@{text "  |  "}@{verbatim "\<Sigma>"}@{text "  |"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   137
          &   & @{verbatim "\<Upsilon>"}@{text "  |  "}@{verbatim "\<Phi>"}@{text "  |  "}@{verbatim "\<Psi>"}@{text "  |  "}@{verbatim "\<Omega>"} \\
d25fe9601dbd tuned outer lexical syntax; fixed var/tvar: really need question marks here;
wenzelm
parents: 28774
diff changeset
   138
  \end{supertabular}
28776
e4090e51b8b9 misc tuning;
wenzelm
parents: 28775
diff changeset
   139
  \end{center}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   140
28778
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   141
  A @{syntax_ref var} or @{syntax_ref typevar} describes an unknown,
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   142
  which is internally a pair of base name and index (ML type @{ML_type
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   143
  indexname}).  These components are either separated by a dot as in
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   144
  @{text "?x.1"} or @{text "?x7.3"} or run together as in @{text
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   145
  "?x1"}.  The latter form is possible if the base name does not end
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   146
  with digits.  If the index is 0, it may be dropped altogether:
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   147
  @{text "?x"} and @{text "?x0"} and @{text "?x.0"} all refer to the
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   148
  same unknown, with basename @{text "x"} and index 0.
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   149
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   150
  The syntax of @{syntax_ref string} admits any characters, including
58724
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
   151
  newlines; ``@{verbatim \<open>"\<close>}'' (double-quote) and ``@{verbatim \<open>\\<close>}''
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
   152
  (backslash) need to be escaped by a backslash; arbitrary
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
   153
  character codes may be specified as ``@{verbatim \<open>\\<close>}@{text ddd}'',
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   154
  with three decimal digits.  Alternative strings according to
28778
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   155
  @{syntax_ref altstring} are analogous, using single back-quotes
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   156
  instead.
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   157
58725
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   158
  The body of @{syntax_ref verbatim} may consist of any text not containing
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   159
  ``@{verbatim "*}"}''; this allows to include quotes without further
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   160
  escapes, but there is no way to escape ``@{verbatim "*}"}''. Cartouches
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   161
  do not have this limitation.
28778
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   162
55033
8e8243975860 support for nested text cartouches;
wenzelm
parents: 53059
diff changeset
   163
  A @{syntax_ref cartouche} consists of arbitrary text, with properly
8e8243975860 support for nested text cartouches;
wenzelm
parents: 53059
diff changeset
   164
  balanced blocks of ``@{verbatim "\<open>"}~@{text "\<dots>"}~@{verbatim
8e8243975860 support for nested text cartouches;
wenzelm
parents: 53059
diff changeset
   165
  "\<close>"}''.  Note that the rendering of cartouche delimiters is
8e8243975860 support for nested text cartouches;
wenzelm
parents: 53059
diff changeset
   166
  usually like this: ``@{text "\<open> \<dots> \<close>"}''.
8e8243975860 support for nested text cartouches;
wenzelm
parents: 53059
diff changeset
   167
28778
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   168
  Source comments take the form @{verbatim "(*"}~@{text
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   169
  "\<dots>"}~@{verbatim "*)"} and may be nested, although the user-interface
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   170
  might prevent this.  Note that this form indicates source comments
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   171
  only, which are stripped after lexical analysis of the input.  The
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   172
  Isar syntax also provides proper \emph{document comments} that are
a25630deacaf misc tuning of inner syntax;
wenzelm
parents: 28776
diff changeset
   173
  considered as part of the text (see \secref{sec:comments}).
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   174
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   175
  Common mathematical symbols such as @{text \<forall>} are represented in
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   176
  Isabelle as @{verbatim \<forall>}.  There are infinitely many Isabelle
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   177
  symbols like this, although proper presentation is left to front-end
58842
22b87ab47d3b discontinued Proof General;
wenzelm
parents: 58725
diff changeset
   178
  tools such as {\LaTeX} or Isabelle/jEdit.  A list of
47822
34b44d28fc4b some updates concerning current Proof General 4.x, which lacks X-Symbol mode of 3.x;
wenzelm
parents: 47114
diff changeset
   179
  predefined Isabelle symbols that work well with these tools is given
34b44d28fc4b some updates concerning current Proof General 4.x, which lacks X-Symbol mode of 3.x;
wenzelm
parents: 47114
diff changeset
   180
  in \appref{app:symbols}.  Note that @{verbatim "\<lambda>"} does not belong
34b44d28fc4b some updates concerning current Proof General 4.x, which lacks X-Symbol mode of 3.x;
wenzelm
parents: 47114
diff changeset
   181
  to the @{text letter} category, since it is already used differently
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   182
  in the Pure term language.\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   183
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   184
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   185
section \<open>Common syntax entities\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   186
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   187
text \<open>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   188
  We now introduce several basic syntactic entities, such as names,
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   189
  terms, and theorem specifications, which are factored out of the
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   190
  actual Isar language elements to be described later.
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   191
\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   192
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   193
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   194
subsection \<open>Names\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   195
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   196
text \<open>Entity @{syntax name} usually refers to any name of types,
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   197
  constants, theorems etc.\ that are to be \emph{declared} or
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   198
  \emph{defined} (so qualified identifiers are excluded here).  Quoted
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   199
  strings provide an escape for non-identifier names or those ruled
58724
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
   200
  out by outer syntax keywords (e.g.\ quoted @{verbatim \<open>"let"\<close>}).
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   201
  Already existing objects are usually referenced by @{syntax
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   202
  nameref}.
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   203
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   204
  @{rail \<open>
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   205
    @{syntax_def name}: @{syntax ident} | @{syntax symident} |
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   206
      @{syntax string} | @{syntax nat}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   207
    ;
60131
wenzelm
parents: 59853
diff changeset
   208
    @{syntax_def par_name}: '(' @{syntax name} ')'
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   209
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   210
    @{syntax_def nameref}: @{syntax name} | @{syntax longident}
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   211
  \<close>}
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   212
\<close>
40296
ac4d75f86d97 syntax category "real" subsumes plain "int";
wenzelm
parents: 40291
diff changeset
   213
ac4d75f86d97 syntax category "real" subsumes plain "int";
wenzelm
parents: 40291
diff changeset
   214
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   215
subsection \<open>Numbers\<close>
40296
ac4d75f86d97 syntax category "real" subsumes plain "int";
wenzelm
parents: 40291
diff changeset
   216
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   217
text \<open>The outer lexical syntax (\secref{sec:outer-lex}) admits
40296
ac4d75f86d97 syntax category "real" subsumes plain "int";
wenzelm
parents: 40291
diff changeset
   218
  natural numbers and floating point numbers.  These are combined as
ac4d75f86d97 syntax category "real" subsumes plain "int";
wenzelm
parents: 40291
diff changeset
   219
  @{syntax int} and @{syntax real} as follows.
ac4d75f86d97 syntax category "real" subsumes plain "int";
wenzelm
parents: 40291
diff changeset
   220
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   221
  @{rail \<open>
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   222
    @{syntax_def int}: @{syntax nat} | '-' @{syntax nat}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   223
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   224
    @{syntax_def real}: @{syntax float} | @{syntax int}
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   225
  \<close>}
40296
ac4d75f86d97 syntax category "real" subsumes plain "int";
wenzelm
parents: 40291
diff changeset
   226
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   227
  Note that there is an overlap with the category @{syntax name},
40296
ac4d75f86d97 syntax category "real" subsumes plain "int";
wenzelm
parents: 40291
diff changeset
   228
  which also includes @{syntax nat}.
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   229
\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   230
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   231
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   232
subsection \<open>Comments \label{sec:comments}\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   233
58725
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   234
text \<open>Large chunks of plain @{syntax text} are usually given @{syntax
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   235
  verbatim}, i.e.\ enclosed in @{verbatim "{*"}~@{text "\<dots>"}~@{verbatim "*}"},
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   236
  or as @{syntax cartouche} @{text "\<open>\<dots>\<close>"}. For convenience, any of the
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   237
  smaller text units conforming to @{syntax nameref} are admitted as well. A
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   238
  marginal @{syntax comment} is of the form @{verbatim "--"}~@{syntax text}.
9402a7f15ed5 tuned exposition of {* ... *};
wenzelm
parents: 58724
diff changeset
   239
  Any number of these may occur within Isabelle/Isar commands.
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   240
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   241
  @{rail \<open>
56499
7e0178c84994 allow text cartouches in regular outer syntax categories "text" and "altstring";
wenzelm
parents: 56451
diff changeset
   242
    @{syntax_def text}: @{syntax verbatim} | @{syntax cartouche} | @{syntax nameref}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   243
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   244
    @{syntax_def comment}: '--' @{syntax text}
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   245
  \<close>}
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   246
\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   247
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   248
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   249
subsection \<open>Type classes, sorts and arities\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   250
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   251
text \<open>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   252
  Classes are specified by plain names.  Sorts have a very simple
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   253
  inner syntax, which is either a single class name @{text c} or a
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   254
  list @{text "{c\<^sub>1, \<dots>, c\<^sub>n}"} referring to the
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   255
  intersection of these classes.  The syntax of type arities is given
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   256
  directly at the outer level.
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   257
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   258
  @{rail \<open>
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   259
    @{syntax_def classdecl}: @{syntax name} (('<' | '\<subseteq>') (@{syntax nameref} + ','))?
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   260
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   261
    @{syntax_def sort}: @{syntax nameref}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   262
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   263
    @{syntax_def arity}: ('(' (@{syntax sort} + ',') ')')? @{syntax sort}
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   264
  \<close>}
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   265
\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   266
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   267
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   268
subsection \<open>Types and terms \label{sec:types-terms}\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   269
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   270
text \<open>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   271
  The actual inner Isabelle syntax, that of types and terms of the
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   272
  logic, is far too sophisticated in order to be modelled explicitly
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   273
  at the outer theory level.  Basically, any such entity has to be
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   274
  quoted to turn it into a single token (the parsing and type-checking
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   275
  is performed internally later).  For convenience, a slightly more
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   276
  liberal convention is adopted: quotes may be omitted for any type or
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   277
  term that is already atomic at the outer level.  For example, one
58724
e5f809f52f26 more antiquotations;
wenzelm
parents: 58618
diff changeset
   278
  may just write @{verbatim x} instead of quoted @{verbatim \<open>"x"\<close>}.
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   279
  Note that symbolic identifiers (e.g.\ @{verbatim "++"} or @{text
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   280
  "\<forall>"} are available as well, provided these have not been superseded
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   281
  by commands or other keywords already (such as @{verbatim "="} or
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   282
  @{verbatim "+"}).
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   283
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   284
  @{rail \<open>
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   285
    @{syntax_def type}: @{syntax nameref} | @{syntax typefree} |
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   286
      @{syntax typevar}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   287
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   288
    @{syntax_def term}: @{syntax nameref} | @{syntax var}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   289
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   290
    @{syntax_def prop}: @{syntax term}
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   291
  \<close>}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   292
59853
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   293
  Positional instantiations are specified as a sequence of terms, or the
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   294
  placeholder ``@{text _}'' (underscore), which means to skip a position.
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   295
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   296
  @{rail \<open>
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   297
    @{syntax_def inst}: '_' | @{syntax term}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   298
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   299
    @{syntax_def insts}: (@{syntax inst} *)
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   300
  \<close>}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   301
59853
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   302
  Named instantiations are specified as pairs of assignments @{text "v =
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   303
  t"}, which refer to schematic variables in some theorem that is
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   304
  instantiated. Both type and terms instantiations are admitted, and
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   305
  distinguished by the usual syntax of variable names.
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   306
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   307
  @{rail \<open>
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   308
    @{syntax_def named_inst}: variable '=' (type | term)
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   309
    ;
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   310
    @{syntax_def named_insts}: (named_inst @'and' +)
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   311
    ;
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   312
    variable: @{syntax name} | @{syntax var} | @{syntax typefree} | @{syntax typevar}
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   313
  \<close>}
4039d8aecda4 more uniform syntax for named instantiations;
wenzelm
parents: 59785
diff changeset
   314
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   315
  Type declarations and definitions usually refer to @{syntax
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   316
  typespec} on the left-hand side.  This models basic type constructor
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   317
  application at the outer syntax level.  Note that only plain postfix
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   318
  notation is available here, but no infixes.
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   319
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   320
  @{rail \<open>
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   321
    @{syntax_def typespec}:
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   322
      (() | @{syntax typefree} | '(' ( @{syntax typefree} + ',' ) ')') @{syntax name}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   323
    ;
42705
528a2ba8fa74 tuned some syntax names;
wenzelm
parents: 42651
diff changeset
   324
    @{syntax_def typespec_sorts}:
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   325
      (() | (@{syntax typefree} ('::' @{syntax sort})?) |
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   326
        '(' ( (@{syntax typefree} ('::' @{syntax sort})?) + ',' ) ')') @{syntax name}
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   327
  \<close>}
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   328
\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   329
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   330
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   331
subsection \<open>Term patterns and declarations \label{sec:term-decls}\<close>
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   332
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   333
text \<open>Wherever explicit propositions (or term fragments) occur in a
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   334
  proof text, casual binding of schematic term variables may be given
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   335
  specified via patterns of the form ``@{text "(\<IS> p\<^sub>1 \<dots> p\<^sub>n)"}''.
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   336
  This works both for @{syntax term} and @{syntax prop}.
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   337
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   338
  @{rail \<open>
42705
528a2ba8fa74 tuned some syntax names;
wenzelm
parents: 42651
diff changeset
   339
    @{syntax_def term_pat}: '(' (@'is' @{syntax term} +) ')'
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   340
    ;
42705
528a2ba8fa74 tuned some syntax names;
wenzelm
parents: 42651
diff changeset
   341
    @{syntax_def prop_pat}: '(' (@'is' @{syntax prop} +) ')'
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   342
  \<close>}
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   343
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   344
  \medskip Declarations of local variables @{text "x :: \<tau>"} and
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   345
  logical propositions @{text "a : \<phi>"} represent different views on
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   346
  the same principle of introducing a local scope.  In practice, one
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   347
  may usually omit the typing of @{syntax vars} (due to
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   348
  type-inference), and the naming of propositions (due to implicit
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   349
  references of current facts).  In any case, Isar proof elements
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   350
  usually admit to introduce multiple such items simultaneously.
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   351
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   352
  @{rail \<open>
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   353
    @{syntax_def vars}: (@{syntax name} +) ('::' @{syntax type})?
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   354
    ;
42705
528a2ba8fa74 tuned some syntax names;
wenzelm
parents: 42651
diff changeset
   355
    @{syntax_def props}: @{syntax thmdecl}? (@{syntax prop} @{syntax prop_pat}? +)
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   356
  \<close>}
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   357
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   358
  The treatment of multiple declarations corresponds to the
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   359
  complementary focus of @{syntax vars} versus @{syntax props}.  In
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   360
  ``@{text "x\<^sub>1 \<dots> x\<^sub>n :: \<tau>"}'' the typing refers to all variables, while
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   361
  in @{text "a: \<phi>\<^sub>1 \<dots> \<phi>\<^sub>n"} the naming refers to all propositions
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   362
  collectively.  Isar language elements that refer to @{syntax vars}
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   363
  or @{syntax props} typically admit separate typings or namings via
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   364
  another level of iteration, with explicit @{keyword_ref "and"}
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   365
  separators; e.g.\ see @{command "fix"} and @{command "assume"} in
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   366
  \secref{sec:proof-context}.
59785
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   367
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   368
  @{rail \<open>
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   369
    @{syntax_def "fixes"}:
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   370
      ((@{syntax name} ('::' @{syntax type})? @{syntax mixfix}? | @{syntax vars}) + @'and')
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   371
    ;
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   372
    @{syntax_def "for_fixes"}: (@'for' @{syntax "fixes"})?
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   373
  \<close>}
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   374
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   375
  The category @{syntax "fixes"} is a richer variant of @{syntax vars}: it
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   376
  admits specification of mixfix syntax for the entities that are introduced
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   377
  into the context. An optional suffix ``@{keyword "for"}~@{text "fixes"}''
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   378
  is admitted in many situations to indicate a so-called ``eigen-context''
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   379
  of a formal element: the result will be exported and thus generalized over
4e6ab5831cc0 clarified syntax category "fixes";
wenzelm
parents: 58861
diff changeset
   380
  the given variables.\<close>
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   381
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   382
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   383
subsection \<open>Attributes and theorems \label{sec:syn-att}\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   384
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   385
text \<open>Attributes have their own ``semi-inner'' syntax, in the sense
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   386
  that input conforming to @{syntax args} below is parsed by the
28754
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   387
  attribute a second time.  The attribute argument specifications may
6f2e67a3dfaa moved section "Proof method expressions" to proof chapter;
wenzelm
parents: 28753
diff changeset
   388
  be any sequence of atomic entities (identifiers, strings etc.), or
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   389
  properly bracketed argument lists.  Below @{syntax atom} refers to
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   390
  any atomic entity, including any @{syntax keyword} conforming to
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   391
  @{syntax symident}.
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   392
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   393
  @{rail \<open>
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   394
    @{syntax_def atom}: @{syntax nameref} | @{syntax typefree} |
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   395
      @{syntax typevar} | @{syntax var} | @{syntax nat} | @{syntax float} |
55045
99056d23e05b cartouche within nested args (attributes, methods, etc.);
wenzelm
parents: 55033
diff changeset
   396
      @{syntax keyword} | @{syntax cartouche}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   397
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   398
    arg: @{syntax atom} | '(' @{syntax args} ')' | '[' @{syntax args} ']'
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   399
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   400
    @{syntax_def args}: arg *
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   401
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   402
    @{syntax_def attributes}: '[' (@{syntax nameref} @{syntax args} * ',') ']'
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   403
  \<close>}
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   404
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   405
  Theorem specifications come in several flavors: @{syntax axmdecl}
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   406
  and @{syntax thmdecl} usually refer to axioms, assumptions or
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   407
  results of goal statements, while @{syntax thmdef} collects lists of
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   408
  existing theorems.  Existing theorems are given by @{syntax thmref}
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   409
  and @{syntax thmrefs}, the former requires an actual singleton
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   410
  result.
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   411
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   412
  There are three forms of theorem references:
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   413
  \begin{enumerate}
60674
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   414
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   415
  \item named facts @{text "a"},
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   416
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   417
  \item selections from named facts @{text "a(i)"} or @{text "a(j - k)"},
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   418
56499
7e0178c84994 allow text cartouches in regular outer syntax categories "text" and "altstring";
wenzelm
parents: 56451
diff changeset
   419
  \item literal fact propositions using token syntax @{syntax_ref altstring}
7e0178c84994 allow text cartouches in regular outer syntax categories "text" and "altstring";
wenzelm
parents: 56451
diff changeset
   420
  @{verbatim "`"}@{text "\<phi>"}@{verbatim "`"} or @{syntax_ref cartouche}
7e0178c84994 allow text cartouches in regular outer syntax categories "text" and "altstring";
wenzelm
parents: 56451
diff changeset
   421
  @{text "\<open>\<phi>\<close>"} (see also method @{method_ref fact}).
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   422
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   423
  \end{enumerate}
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   424
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   425
  Any kind of theorem specification may include lists of attributes
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   426
  both on the left and right hand sides; attributes are applied to any
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   427
  immediately preceding fact.  If names are omitted, the theorems are
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   428
  not stored within the theorem database of the theory or proof
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   429
  context, but any given attributes are applied nonetheless.
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   430
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   431
  An extra pair of brackets around attributes (like ``@{text
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   432
  "[[simproc a]]"}'') abbreviates a theorem reference involving an
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   433
  internal dummy fact, which will be ignored later on.  So only the
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   434
  effect of the attribute on the background context will persist.
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   435
  This form of in-place declarations is particularly useful with
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   436
  commands like @{command "declare"} and @{command "using"}.
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   437
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   438
  @{rail \<open>
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   439
    @{syntax_def axmdecl}: @{syntax name} @{syntax attributes}? ':'
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   440
    ;
60631
441fdbfbb2d3 documentation for 'subgoal' command;
wenzelm
parents: 60270
diff changeset
   441
    @{syntax_def thmbind}:
441fdbfbb2d3 documentation for 'subgoal' command;
wenzelm
parents: 60270
diff changeset
   442
      @{syntax name} @{syntax attributes} | @{syntax name} | @{syntax attributes}
441fdbfbb2d3 documentation for 'subgoal' command;
wenzelm
parents: 60270
diff changeset
   443
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   444
    @{syntax_def thmdecl}: thmbind ':'
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   445
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   446
    @{syntax_def thmdef}: thmbind '='
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   447
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   448
    @{syntax_def thmref}:
56499
7e0178c84994 allow text cartouches in regular outer syntax categories "text" and "altstring";
wenzelm
parents: 56451
diff changeset
   449
      (@{syntax nameref} selection? | @{syntax altstring} | @{syntax cartouche})
7e0178c84994 allow text cartouches in regular outer syntax categories "text" and "altstring";
wenzelm
parents: 56451
diff changeset
   450
        @{syntax attributes}? |
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   451
      '[' @{syntax attributes} ']'
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   452
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   453
    @{syntax_def thmrefs}: @{syntax thmref} +
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   454
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 40296
diff changeset
   455
    selection: '(' ((@{syntax nat} | @{syntax nat} '-' @{syntax nat}?) + ',') ')'
55112
b1a5d603fd12 prefer rail cartouche -- avoid back-slashed quotes;
wenzelm
parents: 55045
diff changeset
   456
  \<close>}
58618
782f0b662cae more cartouches;
wenzelm
parents: 58552
diff changeset
   457
\<close>
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   458
60674
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   459
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   460
section \<open>Diagnostic commands\<close>
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   461
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   462
text \<open>
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   463
  \begin{matharray}{rcl}
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   464
    @{command_def "print_theory"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   465
    @{command_def "print_methods"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   466
    @{command_def "print_attributes"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   467
    @{command_def "print_theorems"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   468
    @{command_def "find_theorems"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   469
    @{command_def "find_consts"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   470
    @{command_def "thm_deps"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   471
    @{command_def "unused_thms"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   472
    @{command_def "print_facts"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   473
    @{command_def "print_term_bindings"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   474
  \end{matharray}
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   475
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   476
  @{rail \<open>
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   477
    (@@{command print_theory} |
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   478
      @@{command print_methods} |
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   479
      @@{command print_attributes} |
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   480
      @@{command print_theorems} |
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   481
      @@{command print_facts}) ('!'?)
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   482
    ;
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   483
    @@{command find_theorems} ('(' @{syntax nat}? 'with_dups'? ')')? \<newline> (thm_criterion*)
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   484
    ;
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   485
    thm_criterion: ('-'?) ('name' ':' @{syntax nameref} | 'intro' | 'elim' | 'dest' |
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   486
      'solves' | 'simp' ':' @{syntax term} | @{syntax term})
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   487
    ;
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   488
    @@{command find_consts} (const_criterion*)
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   489
    ;
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   490
    const_criterion: ('-'?)
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   491
      ('name' ':' @{syntax nameref} | 'strict' ':' @{syntax type} | @{syntax type})
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   492
    ;
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   493
    @@{command thm_deps} @{syntax thmrefs}
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   494
    ;
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   495
    @@{command unused_thms} ((@{syntax name} +) '-' (@{syntax name} * ))?
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   496
  \<close>}
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   497
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   498
  These commands print certain parts of the theory and proof context.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   499
  Note that there are some further ones available, such as for the set
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   500
  of rules declared for simplifications.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   501
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   502
  \begin{description}
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   503
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   504
  \item @{command "print_theory"} prints the main logical content of the
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   505
  background theory; the ``@{text "!"}'' option indicates extra verbosity.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   506
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   507
  \item @{command "print_methods"} prints all proof methods available in the
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   508
  current theory context; the ``@{text "!"}'' option indicates extra
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   509
  verbosity.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   510
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   511
  \item @{command "print_attributes"} prints all attributes available in the
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   512
  current theory context; the ``@{text "!"}'' option indicates extra
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   513
  verbosity.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   514
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   515
  \item @{command "print_theorems"} prints theorems of the background theory
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   516
  resulting from the last command; the ``@{text "!"}'' option indicates
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   517
  extra verbosity.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   518
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   519
  \item @{command "print_facts"} prints all local facts of the current
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   520
  context, both named and unnamed ones; the ``@{text "!"}'' option indicates
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   521
  extra verbosity.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   522
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   523
  \item @{command "print_term_bindings"} prints all term bindings that
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   524
  are present in the context.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   525
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   526
  \item @{command "find_theorems"}~@{text criteria} retrieves facts
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   527
  from the theory or proof context matching all of given search
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   528
  criteria.  The criterion @{text "name: p"} selects all theorems
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   529
  whose fully qualified name matches pattern @{text p}, which may
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   530
  contain ``@{text "*"}'' wildcards.  The criteria @{text intro},
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   531
  @{text elim}, and @{text dest} select theorems that match the
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   532
  current goal as introduction, elimination or destruction rules,
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   533
  respectively.  The criterion @{text "solves"} returns all rules
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   534
  that would directly solve the current goal.  The criterion
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   535
  @{text "simp: t"} selects all rewrite rules whose left-hand side
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   536
  matches the given term.  The criterion term @{text t} selects all
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   537
  theorems that contain the pattern @{text t} -- as usual, patterns
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   538
  may contain occurrences of the dummy ``@{text _}'', schematic
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   539
  variables, and type constraints.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   540
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   541
  Criteria can be preceded by ``@{text "-"}'' to select theorems that
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   542
  do \emph{not} match. Note that giving the empty list of criteria
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   543
  yields \emph{all} currently known facts.  An optional limit for the
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   544
  number of printed facts may be given; the default is 40.  By
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   545
  default, duplicates are removed from the search result. Use
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   546
  @{text with_dups} to display duplicates.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   547
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   548
  \item @{command "find_consts"}~@{text criteria} prints all constants
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   549
  whose type meets all of the given criteria. The criterion @{text
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   550
  "strict: ty"} is met by any type that matches the type pattern
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   551
  @{text ty}.  Patterns may contain both the dummy type ``@{text _}''
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   552
  and sort constraints. The criterion @{text ty} is similar, but it
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   553
  also matches against subtypes. The criterion @{text "name: p"} and
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   554
  the prefix ``@{text "-"}'' function as described for @{command
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   555
  "find_theorems"}.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   556
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   557
  \item @{command "thm_deps"}~@{text "a\<^sub>1 \<dots> a\<^sub>n"}
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   558
  visualizes dependencies of facts, using Isabelle's graph browser
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   559
  tool (see also @{cite "isabelle-system"}).
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   560
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   561
  \item @{command "unused_thms"}~@{text "A\<^sub>1 \<dots> A\<^sub>m - B\<^sub>1 \<dots> B\<^sub>n"}
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   562
  displays all theorems that are proved in theories @{text "B\<^sub>1 \<dots> B\<^sub>n"}
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   563
  or their parents but not in @{text "A\<^sub>1 \<dots> A\<^sub>m"} or their parents and
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   564
  that are never used.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   565
  If @{text n} is @{text 0}, the end of the range of theories
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   566
  defaults to the current theory. If no range is specified,
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   567
  only the unused theorems in the current theory are displayed.
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   568
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   569
  \end{description}
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   570
\<close>
2f66099fb472 clarified sections;
wenzelm
parents: 60631
diff changeset
   571
27037
33d95687514e renamed theory "syntax" to "Outer_Syntax";
wenzelm
parents:
diff changeset
   572
end