src/Pure/Tools/doc.scala
author wenzelm
Fri May 02 20:01:45 2014 +0200 (2014-05-02)
changeset 56831 e3ccf0809d51
parent 56784 776890e0cf71
child 61157 13f4056c42d7
permissions -rw-r--r--
prefer scala.Console with its support for thread-local redirection;
     1 /*  Title:      Pure/Tools/doc.scala
     2     Author:     Makarius
     3 
     4 Access to Isabelle documentation.
     5 */
     6 
     7 package isabelle
     8 
     9 
    10 import scala.util.matching.Regex
    11 
    12 
    13 object Doc
    14 {
    15   /* dirs */
    16 
    17   def dirs(): List[Path] =
    18     Path.split(Isabelle_System.getenv("ISABELLE_DOCS")).map(dir =>
    19       if (dir.is_dir) dir
    20       else error("Bad documentation directory: " + dir))
    21 
    22 
    23   /* contents */
    24 
    25   private def contents_lines(): List[(Path, String)] =
    26     for {
    27       dir <- dirs()
    28       catalog = dir + Path.basic("Contents")
    29       if catalog.is_file
    30       line <- split_lines(Library.trim_line(File.read(catalog)))
    31     } yield (dir, line)
    32 
    33   sealed abstract class Entry
    34   case class Section(text: String, important: Boolean) extends Entry
    35   case class Doc(name: String, title: String, path: Path) extends Entry
    36   case class Text_File(name: String, path: Path) extends Entry
    37 
    38   def text_file(name: Path): Option[Text_File] =
    39   {
    40     val path = Path.variable("ISABELLE_HOME") + name
    41     if (path.is_file) Some(Text_File(name.implode, path))
    42     else None
    43   }
    44 
    45   private val Section_Entry = new Regex("""^(\S.*)\s*$""")
    46   private val Doc_Entry = new Regex("""^\s+(\S+)\s+(.+)\s*$""")
    47 
    48   private def release_notes(): List[Entry] =
    49     Section("Release notes", true) ::
    50       Path.split(Isabelle_System.getenv_strict("ISABELLE_DOCS_RELEASE_NOTES")).flatMap(text_file(_))
    51 
    52   private def examples(): List[Entry] =
    53     Section("Examples", true) ::
    54       Path.split(Isabelle_System.getenv_strict("ISABELLE_DOCS_EXAMPLES")).map(file =>
    55         text_file(file) match {
    56           case Some(entry) => entry
    57           case None => error("Bad entry in ISABELLE_DOCS_EXAMPLES: " + file)
    58         })
    59 
    60   def contents(): List[Entry] =
    61     (for {
    62       (dir, line) <- contents_lines()
    63       entry <-
    64         line match {
    65           case Section_Entry(text) =>
    66             Library.try_unsuffix("!", text) match {
    67               case None => Some(Section(text, false))
    68               case Some(txt) => Some(Section(txt, true))
    69             }
    70           case Doc_Entry(name, title) => Some(Doc(name, title, dir + Path.basic(name)))
    71           case _ => None
    72         }
    73     } yield entry) ::: release_notes() ::: examples()
    74 
    75 
    76   /* view */
    77 
    78   def view(path: Path)
    79   {
    80     if (path.is_file) Console.println(Library.trim_line(File.read(path)))
    81     else {
    82       val pdf = path.ext("pdf")
    83       if (pdf.is_file) Isabelle_System.pdf_viewer(pdf)
    84       else error("Bad Isabelle documentation file: " + pdf)
    85     }
    86   }
    87 
    88 
    89   /* command line entry point */
    90 
    91   def main(args: Array[String])
    92   {
    93     Command_Line.tool0 {
    94       val entries = contents()
    95       if (args.isEmpty) Console.println(cat_lines(contents_lines().map(_._2)))
    96       else {
    97         args.foreach(arg =>
    98           entries.collectFirst { case Doc(name, _, path) if arg == name => path } match {
    99             case Some(path) => view(path)
   100             case None => error("No Isabelle documentation entry: " + quote(arg))
   101           }
   102         )
   103       }
   104     }
   105   }
   106 }
   107