src/Pure/Tools/build_doc.scala
author wenzelm
Sat, 05 Apr 2014 23:17:30 +0200
changeset 56429 bc61161a5bd0
child 56430 92fb6be9a460
permissions -rw-r--r--
re-implemented build_doc in Isabelle/Scala; clarified command-line: specify documentation files (via document_variants) instead of sessions;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56429
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Tools/build_doc.scala
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
     3
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
     4
Build Isabelle documentation.
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
     5
*/
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
     6
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
     7
package isabelle
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
     8
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
     9
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    10
import java.io.{File => JFile}
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    11
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    12
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    13
object Build_Doc
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    14
{
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    15
  /* build_doc */
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    16
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    17
  def build_doc(
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    18
    options: Options,
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    19
    progress: Build.Progress = Build.Ignore_Progress,
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    20
    all_docs: Boolean = false,
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    21
    max_jobs: Int = 1,
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    22
    system_mode: Boolean = false,
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    23
    docs: List[String] = Nil): Int =
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    24
  {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    25
    val selection =
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    26
      for {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    27
        (name, info) <- Build.find_sessions(options, Nil).topological_order
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    28
        if info.groups.contains("doc")
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    29
        doc = info.options.string("document_variants")
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    30
        if all_docs || docs.contains(doc)
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    31
      } yield (doc, name)
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    32
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    33
    val selected_docs = selection.map(_._1)
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    34
    val sessions = selection.map(_._2)
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    35
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    36
    docs.filter(doc => !selected_docs.contains(doc)) match {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    37
      case Nil =>
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    38
      case bad => error("No doc session for " + commas_quote(bad))
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    39
    }
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    40
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    41
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    42
    progress.echo("Build started for documentation " + commas_quote(selected_docs))
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    43
    val rc1 =
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    44
      Build.build(options, progress, requirements = true, build_heap = true,
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    45
        max_jobs = max_jobs, system_mode = system_mode, sessions = sessions)
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    46
    if (rc1 == 0) {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    47
      Isabelle_System.with_tmp_dir("document_output")(output =>
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    48
        {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    49
          val rc2 =
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    50
            Build.build(
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    51
              options.bool.update("browser_info", false).
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    52
                string.update("document", "pdf").
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    53
                string.update("document_output", Isabelle_System.posix_path(output)),
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    54
              progress, clean_build = true, sessions = sessions)
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    55
          if (rc2 == 0) {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    56
            val doc_dir = Path.explode("$ISABELLE_HOME/doc").file
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    57
            for (doc <- selected_docs) {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    58
              val name = doc + ".pdf"
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    59
              File.copy(new JFile(output, name), new JFile(doc_dir, name))
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    60
            }
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    61
          }
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    62
          rc2
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    63
        })
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    64
    }
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    65
    else rc1
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    66
  }
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    67
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    68
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    69
  /* command line entry point */
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    70
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    71
  def main(args: Array[String])
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    72
  {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    73
    Command_Line.tool {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    74
      args.toList match {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    75
        case
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    76
          Properties.Value.Boolean(all_docs) ::
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    77
          Properties.Value.Int(max_jobs) ::
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    78
          Properties.Value.Boolean(system_mode) ::
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    79
          Command_Line.Chunks(docs) =>
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    80
            val options = Options.init()
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    81
            val progress = new Build.Console_Progress(false)
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    82
            progress.interrupt_handler {
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    83
              build_doc(options, progress, all_docs, max_jobs, system_mode, docs)
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    84
            }
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    85
        case _ => error("Bad arguments:\n" + cat_lines(args))
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    86
      }
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    87
    }
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    88
  }
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    89
}
bc61161a5bd0 re-implemented build_doc in Isabelle/Scala;
wenzelm
parents:
diff changeset
    90