src/Pure/Thy/thy_header.scala
author wenzelm
Wed, 29 Aug 2018 12:44:17 +0200
changeset 68841 252b43600737
parent 67722 012f1e8a1209
child 69255 800b1ce96fce
permissions -rw-r--r--
clarified signature;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
28495
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Thy/thy_header.scala
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
     3
46939
5b67ac48b384 allow multiple 'keywords' as in 'fixes';
wenzelm
parents: 46938
diff changeset
     4
Static theory header information.
28495
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
     5
*/
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
     6
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
     7
package isabelle
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
     8
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
     9
43611
21a57a0c5f25 more general theory header parsing;
wenzelm
parents: 41535
diff changeset
    10
import scala.annotation.tailrec
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
    11
import scala.collection.mutable
64824
330ec9bc4b75 tuned signature;
wenzelm
parents: 64777
diff changeset
    12
import scala.util.parsing.input.Reader
38149
3c380380beac somewhat uniform Thy_Header.split_thy_path in ML and Scala;
wenzelm
parents: 36956
diff changeset
    13
import scala.util.matching.Regex
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
    14
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
    15
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
    16
object Thy_Header
32450
375db037f4d2 misc tuning;
wenzelm
parents: 29140
diff changeset
    17
{
58928
23d0ffd48006 plain value Keywords.keywords, which might be used outside theory for bootstrap purposes;
wenzelm
parents: 58908
diff changeset
    18
  /* bootstrap keywords */
23d0ffd48006 plain value Keywords.keywords, which might be used outside theory for bootstrap purposes;
wenzelm
parents: 58908
diff changeset
    19
63579
73939a9b70a3 support 'abbrevs' within theory header;
wenzelm
parents: 63449
diff changeset
    20
  type Keywords = List[(String, Keyword.Spec)]
73939a9b70a3 support 'abbrevs' within theory header;
wenzelm
parents: 63449
diff changeset
    21
  type Abbrevs = List[(String, String)]
58928
23d0ffd48006 plain value Keywords.keywords, which might be used outside theory for bootstrap purposes;
wenzelm
parents: 58908
diff changeset
    22
58868
c5e1cce7ace3 uniform heading commands work in any context, even in theory header;
wenzelm
parents: 58861
diff changeset
    23
  val CHAPTER = "chapter"
c5e1cce7ace3 uniform heading commands work in any context, even in theory header;
wenzelm
parents: 58861
diff changeset
    24
  val SECTION = "section"
c5e1cce7ace3 uniform heading commands work in any context, even in theory header;
wenzelm
parents: 58861
diff changeset
    25
  val SUBSECTION = "subsection"
c5e1cce7ace3 uniform heading commands work in any context, even in theory header;
wenzelm
parents: 58861
diff changeset
    26
  val SUBSUBSECTION = "subsubsection"
61463
8e46cea6a45a added 'paragraph', 'subparagraph';
wenzelm
parents: 60957
diff changeset
    27
  val PARAGRAPH = "paragraph"
8e46cea6a45a added 'paragraph', 'subparagraph';
wenzelm
parents: 60957
diff changeset
    28
  val SUBPARAGRAPH = "subparagraph"
58999
ed09ae4ea2d8 uniform treatment of all document markup commands: 'text' and 'txt' merely differ in LaTeX style;
wenzelm
parents: 58928
diff changeset
    29
  val TEXT = "text"
ed09ae4ea2d8 uniform treatment of all document markup commands: 'text' and 'txt' merely differ in LaTeX style;
wenzelm
parents: 58928
diff changeset
    30
  val TXT = "txt"
ed09ae4ea2d8 uniform treatment of all document markup commands: 'text' and 'txt' merely differ in LaTeX style;
wenzelm
parents: 58928
diff changeset
    31
  val TEXT_RAW = "text_raw"
58868
c5e1cce7ace3 uniform heading commands work in any context, even in theory header;
wenzelm
parents: 58861
diff changeset
    32
28495
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
    33
  val THEORY = "theory"
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
    34
  val IMPORTS = "imports"
46938
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46737
diff changeset
    35
  val KEYWORDS = "keywords"
63579
73939a9b70a3 support 'abbrevs' within theory header;
wenzelm
parents: 63449
diff changeset
    36
  val ABBREVS = "abbrevs"
46938
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46737
diff changeset
    37
  val AND = "and"
28495
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
    38
  val BEGIN = "begin"
c5f86d04743b Theory header keywords.
wenzelm
parents:
diff changeset
    39
64854
f5aa712e6250 tuned signature;
wenzelm
parents: 64825
diff changeset
    40
  val bootstrap_header: Keywords =
58928
23d0ffd48006 plain value Keywords.keywords, which might be used outside theory for bootstrap purposes;
wenzelm
parents: 58908
diff changeset
    41
    List(
65384
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    42
      ("%", Keyword.Spec.none),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    43
      ("(", Keyword.Spec.none),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    44
      (")", Keyword.Spec.none),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    45
      (",", Keyword.Spec.none),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    46
      ("::", Keyword.Spec.none),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    47
      ("=", Keyword.Spec.none),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    48
      (AND, Keyword.Spec.none),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    49
      (BEGIN, Keyword.Spec(Keyword.QUASI_COMMAND)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    50
      (IMPORTS, Keyword.Spec(Keyword.QUASI_COMMAND)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    51
      (KEYWORDS, Keyword.Spec(Keyword.QUASI_COMMAND)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    52
      (ABBREVS, Keyword.Spec(Keyword.QUASI_COMMAND)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    53
      (CHAPTER, Keyword.Spec(Keyword.DOCUMENT_HEADING)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    54
      (SECTION, Keyword.Spec(Keyword.DOCUMENT_HEADING)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    55
      (SUBSECTION, Keyword.Spec(Keyword.DOCUMENT_HEADING)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    56
      (SUBSUBSECTION, Keyword.Spec(Keyword.DOCUMENT_HEADING)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    57
      (PARAGRAPH, Keyword.Spec(Keyword.DOCUMENT_HEADING)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    58
      (SUBPARAGRAPH, Keyword.Spec(Keyword.DOCUMENT_HEADING)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    59
      (TEXT, Keyword.Spec(Keyword.DOCUMENT_BODY)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    60
      (TXT, Keyword.Spec(Keyword.DOCUMENT_BODY)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    61
      (TEXT_RAW, Keyword.Spec(Keyword.DOCUMENT_RAW)),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    62
      (THEORY, Keyword.Spec(Keyword.THY_BEGIN, tags = List("theory"))),
36255c43c64c more explicit types;
wenzelm
parents: 65362
diff changeset
    63
      ("ML", Keyword.Spec(Keyword.THY_DECL, tags = List("ML"))))
58928
23d0ffd48006 plain value Keywords.keywords, which might be used outside theory for bootstrap purposes;
wenzelm
parents: 58908
diff changeset
    64
23d0ffd48006 plain value Keywords.keywords, which might be used outside theory for bootstrap purposes;
wenzelm
parents: 58908
diff changeset
    65
  private val bootstrap_keywords =
23d0ffd48006 plain value Keywords.keywords, which might be used outside theory for bootstrap purposes;
wenzelm
parents: 58908
diff changeset
    66
    Keyword.Keywords.empty.add_keywords(bootstrap_header)
23d0ffd48006 plain value Keywords.keywords, which might be used outside theory for bootstrap purposes;
wenzelm
parents: 58908
diff changeset
    67
67004
af72fa58f71b clarified lazy Completion within Outer_Syntax: measurable speedup of Sessions.deps;
wenzelm
parents: 66984
diff changeset
    68
  val bootstrap_syntax: Outer_Syntax =
af72fa58f71b clarified lazy Completion within Outer_Syntax: measurable speedup of Sessions.deps;
wenzelm
parents: 66984
diff changeset
    69
    Outer_Syntax.empty.add_keywords(bootstrap_header)
34190
dfcf667bbfed read header by scanning/parsing file;
wenzelm
parents: 34188
diff changeset
    70
38149
3c380380beac somewhat uniform Thy_Header.split_thy_path in ML and Scala;
wenzelm
parents: 36956
diff changeset
    71
64673
b5965890e54d more uniform treatment of file name vs. theory name and special header;
wenzelm
parents: 64671
diff changeset
    72
  /* file name vs. theory name */
62895
54c2abe7e9a4 treat ROOT.ML as theory with header "theory ML_Root imports ML_Bootstrap begin";
wenzelm
parents: 62849
diff changeset
    73
63022
785a59235a15 more IDE support for Isabelle/Pure bootstrap;
wenzelm
parents: 62969
diff changeset
    74
  val PURE = "Pure"
62895
54c2abe7e9a4 treat ROOT.ML as theory with header "theory ML_Root imports ML_Bootstrap begin";
wenzelm
parents: 62849
diff changeset
    75
  val ML_BOOTSTRAP = "ML_Bootstrap"
65490
571a3ce3cc17 special theories are always global;
wenzelm
parents: 65452
diff changeset
    76
  val ml_roots = List("ROOT0.ML" -> "ML_Root0", "ROOT.ML" -> "ML_Root")
63022
785a59235a15 more IDE support for Isabelle/Pure bootstrap;
wenzelm
parents: 62969
diff changeset
    77
  val bootstrap_thys = List(PURE, ML_BOOTSTRAP).map(a => a -> ("Bootstrap_" + a))
44160
8848867501fb clarified document model header: master_dir (native wrt. editor, potentially URL) and node_name (full canonical path);
wenzelm
parents: 44159
diff changeset
    78
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents: 67212
diff changeset
    79
  val bootstrap_global_theories =
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents: 67212
diff changeset
    80
    (Sessions.root_name :: (ml_roots ::: bootstrap_thys).map(_._2)).map(_ -> PURE)
65490
571a3ce3cc17 special theories are always global;
wenzelm
parents: 65452
diff changeset
    81
65452
9e9750a7932c clarified signature;
wenzelm
parents: 65392
diff changeset
    82
  private val Thy_File_Name = new Regex(""".*?([^/\\:]+)\.thy""")
67212
wenzelm
parents: 67164
diff changeset
    83
  private val File_Name = new Regex(""".*?([^/\\:]+)""")
44160
8848867501fb clarified document model header: master_dir (native wrt. editor, potentially URL) and node_name (full canonical path);
wenzelm
parents: 44159
diff changeset
    84
65526
41dda3a292e6 actual update_imports operations;
wenzelm
parents: 65490
diff changeset
    85
  def is_base_name(s: String): Boolean =
41dda3a292e6 actual update_imports operations;
wenzelm
parents: 65490
diff changeset
    86
    s != "" && !s.exists("/\\:".contains(_))
41dda3a292e6 actual update_imports operations;
wenzelm
parents: 65490
diff changeset
    87
67290
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67215
diff changeset
    88
  def file_name(s: String): Option[String] =
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67215
diff changeset
    89
    s match {
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67215
diff changeset
    90
      case File_Name(s) => Some(s)
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67215
diff changeset
    91
      case _ => None
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67215
diff changeset
    92
    }
98b6cd12f963 implicit thy_load context for bibtex files;
wenzelm
parents: 67215
diff changeset
    93
65452
9e9750a7932c clarified signature;
wenzelm
parents: 65392
diff changeset
    94
  def import_name(s: String): String =
67164
39f57f0757f1 clarified error;
wenzelm
parents: 67013
diff changeset
    95
    s match {
67212
wenzelm
parents: 67164
diff changeset
    96
      case File_Name(name) if !name.endsWith(".thy") => name
67164
39f57f0757f1 clarified error;
wenzelm
parents: 67013
diff changeset
    97
      case _ => error("Malformed theory import: " + quote(s))
39f57f0757f1 clarified error;
wenzelm
parents: 67013
diff changeset
    98
    }
44225
a8f921e6484f more robust Thy_Header.base_name, with minimal assumptions about path syntax;
wenzelm
parents: 44222
diff changeset
    99
65452
9e9750a7932c clarified signature;
wenzelm
parents: 65392
diff changeset
   100
  def theory_name(s: String): String =
62895
54c2abe7e9a4 treat ROOT.ML as theory with header "theory ML_Root imports ML_Bootstrap begin";
wenzelm
parents: 62849
diff changeset
   101
    s match {
66195
bb886f13623a proper bootstrap_name (amending b42743f5b595);
wenzelm
parents: 65539
diff changeset
   102
      case Thy_File_Name(name) => bootstrap_name(name)
67212
wenzelm
parents: 67164
diff changeset
   103
      case File_Name(name) =>
67215
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents: 67212
diff changeset
   104
        if (name == Sessions.root_name) name
03d0c958d65a PIDE markup for session ROOT files;
wenzelm
parents: 67212
diff changeset
   105
        else ml_roots.collectFirst({ case (a, b) if a == name => b }).getOrElse("")
65452
9e9750a7932c clarified signature;
wenzelm
parents: 65392
diff changeset
   106
      case _ => ""
62895
54c2abe7e9a4 treat ROOT.ML as theory with header "theory ML_Root imports ML_Bootstrap begin";
wenzelm
parents: 62849
diff changeset
   107
    }
38149
3c380380beac somewhat uniform Thy_Header.split_thy_path in ML and Scala;
wenzelm
parents: 36956
diff changeset
   108
64673
b5965890e54d more uniform treatment of file name vs. theory name and special header;
wenzelm
parents: 64671
diff changeset
   109
  def is_ml_root(theory: String): Boolean =
b5965890e54d more uniform treatment of file name vs. theory name and special header;
wenzelm
parents: 64671
diff changeset
   110
    ml_roots.exists({ case (_, b) => b == theory })
b5965890e54d more uniform treatment of file name vs. theory name and special header;
wenzelm
parents: 64671
diff changeset
   111
b5965890e54d more uniform treatment of file name vs. theory name and special header;
wenzelm
parents: 64671
diff changeset
   112
  def is_bootstrap(theory: String): Boolean =
b5965890e54d more uniform treatment of file name vs. theory name and special header;
wenzelm
parents: 64671
diff changeset
   113
    bootstrap_thys.exists({ case (_, b) => b == theory })
b5965890e54d more uniform treatment of file name vs. theory name and special header;
wenzelm
parents: 64671
diff changeset
   114
66195
bb886f13623a proper bootstrap_name (amending b42743f5b595);
wenzelm
parents: 65539
diff changeset
   115
  def bootstrap_name(theory: String): String =
bb886f13623a proper bootstrap_name (amending b42743f5b595);
wenzelm
parents: 65539
diff changeset
   116
    bootstrap_thys.collectFirst({ case (a, b) if a == theory => b }).getOrElse(theory)
bb886f13623a proper bootstrap_name (amending b42743f5b595);
wenzelm
parents: 65539
diff changeset
   117
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   118
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   119
  /* parser */
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   120
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   121
  trait Parser extends Parse.Parser
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   122
  {
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   123
    val header: Parser[Thy_Header] =
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   124
    {
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   125
      val opt_files =
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   126
        $$$("(") ~! (rep1sep(name, $$$(",")) <~ $$$(")")) ^^ { case _ ~ x => x } |
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   127
        success(Nil)
48864
3ee314ae1e0a added keyword kind "thy_load" (with optional list of file extensions);
wenzelm
parents: 48706
diff changeset
   128
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   129
      val keyword_spec =
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   130
        atom("outer syntax keyword specification", _.is_name) ~ opt_files ~ tags ^^
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   131
        { case x ~ y ~ z => Keyword.Spec(x, y, z) }
59694
d2bb4b5ed862 misc tuning -- more uniform ML vs. Scala;
wenzelm
parents: 58999
diff changeset
   132
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   133
      val keyword_decl =
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   134
        rep1(string) ~
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   135
        opt($$$("::") ~! keyword_spec ^^ { case _ ~ x => x }) ^^
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   136
        { case xs ~ y => xs.map((_, y.getOrElse(Keyword.Spec.none))) }
46938
cda018294515 some support for outer syntax keyword declarations within theory header;
wenzelm
parents: 46737
diff changeset
   137
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   138
      val keyword_decls =
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   139
        keyword_decl ~ rep($$$(AND) ~! keyword_decl ^^ { case _ ~ x => x }) ^^
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   140
        { case xs ~ yss => (xs :: yss).flatten }
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   141
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   142
      val abbrevs =
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   143
        rep1sep(rep1(text) ~ ($$$("=") ~! rep1(text)), $$$("and")) ^^
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   144
          { case res => for ((as ~ (_ ~ bs)) <- res; a <- as; b <- bs) yield (a, b) }
63579
73939a9b70a3 support 'abbrevs' within theory header;
wenzelm
parents: 63449
diff changeset
   145
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   146
      val args =
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   147
        position(theory_name) ~
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   148
        (opt($$$(IMPORTS) ~! rep1(position(theory_name))) ^^
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   149
          { case None => Nil case Some(_ ~ xs) => xs }) ~
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   150
        (opt($$$(KEYWORDS) ~! keyword_decls) ^^
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   151
          { case None => Nil case Some(_ ~ xs) => xs }) ~
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   152
        (opt($$$(ABBREVS) ~! abbrevs) ^^
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   153
          { case None => Nil case Some(_ ~ xs) => xs }) ~
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   154
        $$$(BEGIN) ^^
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   155
        { case (name, pos) ~ imports ~ keywords ~ abbrevs ~ _ =>
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   156
            val f = Symbol.decode _
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   157
            Thy_Header((f(name), pos),
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   158
              imports.map({ case (a, b) => (f(a), b) }),
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   159
              keywords.map({ case (a, Keyword.Spec(b, c, d)) =>
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   160
                (f(a), Keyword.Spec(f(b), c.map(f), d.map(f))) }),
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   161
              abbrevs.map({ case (a, b) => (f(a), f(b)) }))
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   162
        }
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   163
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   164
      val heading =
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   165
        (command(CHAPTER) |
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   166
          command(SECTION) |
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   167
          command(SUBSECTION) |
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   168
          command(SUBSUBSECTION) |
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   169
          command(PARAGRAPH) |
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   170
          command(SUBPARAGRAPH) |
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   171
          command(TEXT) |
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   172
          command(TXT) |
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   173
          command(TEXT_RAW)) ~
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   174
        tags ~! document_source
58868
c5e1cce7ace3 uniform heading commands work in any context, even in theory header;
wenzelm
parents: 58861
diff changeset
   175
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   176
      (rep(heading) ~ command(THEORY) ~ tags) ~! args ^^ { case _ ~ x => x }
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   177
    }
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   178
  }
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   179
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   180
34190
dfcf667bbfed read header by scanning/parsing file;
wenzelm
parents: 34188
diff changeset
   181
  /* read -- lazy scanning */
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   182
65539
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   183
  private def read_tokens(reader: Reader[Char], strict: Boolean): (List[Token], List[Token]) =
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   184
  {
58928
23d0ffd48006 plain value Keywords.keywords, which might be used outside theory for bootstrap purposes;
wenzelm
parents: 58908
diff changeset
   185
    val token = Token.Parsers.token(bootstrap_keywords)
64825
e78b62c289bb more uniform node_header (non-strict);
wenzelm
parents: 64824
diff changeset
   186
    def make_tokens(in: Reader[Char]): Stream[Token] =
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   187
      token(in) match {
64825
e78b62c289bb more uniform node_header (non-strict);
wenzelm
parents: 64824
diff changeset
   188
        case Token.Parsers.Success(tok, rest) => tok #:: make_tokens(rest)
e78b62c289bb more uniform node_header (non-strict);
wenzelm
parents: 64824
diff changeset
   189
        case _ => Stream.empty
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   190
      }
64825
e78b62c289bb more uniform node_header (non-strict);
wenzelm
parents: 64824
diff changeset
   191
65539
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   192
    val all_tokens = make_tokens(reader)
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   193
    val drop_tokens =
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   194
      if (strict) Nil
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   195
      else all_tokens.takeWhile(tok => !tok.is_command(Thy_Header.THEORY)).toList
34190
dfcf667bbfed read header by scanning/parsing file;
wenzelm
parents: 34188
diff changeset
   196
65539
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   197
    val tokens = all_tokens.drop(drop_tokens.length)
64825
e78b62c289bb more uniform node_header (non-strict);
wenzelm
parents: 64824
diff changeset
   198
    val tokens1 = tokens.takeWhile(tok => !tok.is_begin).toList
e78b62c289bb more uniform node_header (non-strict);
wenzelm
parents: 64824
diff changeset
   199
    val tokens2 = tokens.dropWhile(tok => !tok.is_begin).headOption.toList
e78b62c289bb more uniform node_header (non-strict);
wenzelm
parents: 64824
diff changeset
   200
65539
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   201
    (drop_tokens, tokens1 ::: tokens2)
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   202
  }
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   203
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   204
  private object Parser extends Parser
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   205
  {
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   206
    def parse_header(tokens: List[Token], pos: Token.Pos): Thy_Header =
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   207
      parse(commit(header), Token.reader(tokens, pos)) match {
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   208
        case Success(result, _) => result
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   209
        case bad => error(bad.toString)
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   210
      }
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   211
  }
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   212
65539
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   213
  def read(reader: Reader[Char], start: Token.Pos, strict: Boolean = true): Thy_Header =
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   214
  {
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   215
    val (_, tokens0) = read_tokens(reader, true)
66918
ec2b50aeb0dd more robust treatment of UTF8 in raw byte sources;
wenzelm
parents: 66713
diff changeset
   216
    val text = Scan.reader_decode_utf8(reader, Token.implode(tokens0))
65539
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   217
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   218
    val (drop_tokens, tokens) = read_tokens(Scan.char_reader(text), strict)
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   219
    val pos = (start /: drop_tokens)(_.advance(_))
dbcd9b3e1b49 more precise position information;
wenzelm
parents: 65526
diff changeset
   220
68841
252b43600737 clarified signature;
wenzelm
parents: 67722
diff changeset
   221
    Parser.parse_header(tokens, pos)
34169
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   222
  }
7501b2910900 basic setup for header scanning/parsing;
wenzelm
parents: 32466
diff changeset
   223
}
44159
9a35e88d9dc9 simplified class Thy_Header;
wenzelm
parents: 44157
diff changeset
   224
44185
05641edb5d30 provide node header via Scala layer;
wenzelm
parents: 44163
diff changeset
   225
sealed case class Thy_Header(
59694
d2bb4b5ed862 misc tuning -- more uniform ML vs. Scala;
wenzelm
parents: 58999
diff changeset
   226
  name: (String, Position.T),
d2bb4b5ed862 misc tuning -- more uniform ML vs. Scala;
wenzelm
parents: 58999
diff changeset
   227
  imports: List[(String, Position.T)],
63579
73939a9b70a3 support 'abbrevs' within theory header;
wenzelm
parents: 63449
diff changeset
   228
  keywords: Thy_Header.Keywords,
73939a9b70a3 support 'abbrevs' within theory header;
wenzelm
parents: 63449
diff changeset
   229
  abbrevs: Thy_Header.Abbrevs)