src/Pure/General/comment.scala
author wenzelm
Mon, 03 Dec 2018 14:59:42 +0100
changeset 69393 ed0824ef337e
parent 67449 1caeb087d957
child 69891 def3ec9cdb7e
permissions -rw-r--r--
static type for Library.using: avoid Java 11 warnings on "Illegal reflective access"; more uses of "using";
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
67438
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/General/comment.scala
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
     3
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
     4
Formal comments.
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
     5
*/
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
     6
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
     7
package isabelle
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
     8
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
     9
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    10
object Comment
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    11
{
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    12
  object Kind extends Enumeration
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    13
  {
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    14
    val COMMENT = Value("formal comment")
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    15
    val CANCEL = Value("canceled text")
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    16
    val LATEX = Value("embedded LaTeX")
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    17
  }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    18
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    19
  lazy val symbols: Set[Symbol.Symbol] =
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    20
    Set(Symbol.comment, Symbol.comment_decoded,
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    21
      Symbol.cancel, Symbol.cancel_decoded,
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    22
      Symbol.latex, Symbol.latex_decoded)
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    23
67449
1caeb087d957 tuned signature;
wenzelm
parents: 67438
diff changeset
    24
  lazy val symbols_blanks: Set[Symbol.Symbol] =
1caeb087d957 tuned signature;
wenzelm
parents: 67438
diff changeset
    25
    Set(Symbol.comment, Symbol.comment_decoded)
67438
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    26
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    27
  def content(source: String): String =
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    28
  {
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    29
    def err(): Nothing = error("Malformed formal comment: " + quote(source))
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    30
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    31
    Symbol.explode(source) match {
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    32
      case sym :: rest if symbols_blanks(sym) =>
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    33
        val body = if (symbols_blanks(sym)) rest.dropWhile(Symbol.is_blank) else rest
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    34
        try { Scan.Parsers.cartouche_content(body.mkString) }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    35
        catch { case ERROR(_) => err() }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    36
      case _ => err()
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    37
    }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    38
  }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    39
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    40
  trait Parsers extends Scan.Parsers
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    41
  {
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    42
   def comment_prefix: Parser[String] =
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    43
     one(symbols_blanks) ~ many(Symbol.is_blank) ^^ { case a ~ b => a + b.mkString } |
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    44
     one(symbols)
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    45
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    46
   def comment_cartouche: Parser[String] =
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    47
      comment_prefix ~ cartouche ^^ { case a ~ b => a + b }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    48
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    49
    def comment_cartouche_line(ctxt: Scan.Line_Context): Parser[(String, Scan.Line_Context)] =
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    50
    {
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    51
      def cartouche_context(d: Int): Scan.Line_Context =
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    52
        if (d == 0) Scan.Finished else Scan.Cartouche_Comment(d)
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    53
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    54
      ctxt match {
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    55
        case Scan.Finished =>
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    56
          comment_prefix ~ opt(cartouche_depth(0)) ^^ {
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    57
            case a ~ None => (a, Scan.Comment_Prefix(a))
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    58
            case a ~ Some((c, d)) => (a + c, cartouche_context(d)) }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    59
        case Scan.Comment_Prefix(a) if symbols_blanks(a) =>
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    60
          many1(Symbol.is_blank) ~ opt(cartouche_depth(0)) ^^ {
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    61
            case b ~ None => (b.mkString, Scan.Comment_Prefix(a))
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    62
            case b ~ Some((c, d)) => (b.mkString + c, cartouche_context(d)) } |
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    63
          cartouche_depth(0) ^^ { case (c, d) => (c, cartouche_context(d)) }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    64
        case Scan.Comment_Prefix(_) =>
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    65
          cartouche_depth(0) ^^ { case (c, d) => (c, cartouche_context(d)) }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    66
        case Scan.Cartouche_Comment(depth) =>
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    67
          cartouche_depth(depth) ^^ { case (c, d) => (c, cartouche_context(d)) }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    68
        case _ => failure("")
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    69
      }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    70
    }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    71
  }
fdb7b995974d clarified modules;
wenzelm
parents:
diff changeset
    72
}