wenzelm@38479: /*  Title:      Pure/PIDE/markup_tree.scala
wenzelm@45673:     Module:     PIDE
wenzelm@36676:     Author:     Fabian Immler, TU Munich
wenzelm@36676:     Author:     Makarius
wenzelm@36676: 
wenzelm@38479: Markup trees over nested / non-overlapping text ranges.
wenzelm@36676: */
immler@34393: 
wenzelm@34871: package isabelle
immler@34393: 
wenzelm@43520: import java.lang.System
wenzelm@34701: import javax.swing.tree.DefaultMutableTreeNode
wenzelm@34701: 
wenzelm@38479: import scala.collection.immutable.SortedMap
wenzelm@49467: import scala.annotation.tailrec
wenzelm@38479: 
wenzelm@38479: 
wenzelm@38479: object Markup_Tree
wenzelm@38479: {
wenzelm@45456:   val empty: Markup_Tree = new Markup_Tree(Branches.empty)
wenzelm@38479: 
wenzelm@49467:   def merge_disjoint(trees: List[Markup_Tree]): Markup_Tree =
wenzelm@49467:     trees match {
wenzelm@49467:       case Nil => empty
wenzelm@49467:       case head :: tail =>
wenzelm@49467:         new Markup_Tree(
wenzelm@49467:           (head.branches /: tail) {
wenzelm@49467:             case (branches, tree) =>
wenzelm@49467:               (branches /: tree.branches) {
wenzelm@49467:                 case (bs, (r, entry)) =>
wenzelm@49467:                   require(!bs.isDefinedAt(r))
wenzelm@49467:                   bs + (r -> entry)
wenzelm@49467:               }
wenzelm@49467:           })
wenzelm@49467:     }
wenzelm@49467: 
wenzelm@45473:   object Entry
wenzelm@45473:   {
wenzelm@45473:     def apply(markup: Text.Markup, subtree: Markup_Tree): Entry =
wenzelm@45474:       Entry(markup.range, List(markup.info), Set(markup.info.markup.name), subtree)
wenzelm@45473:   }
wenzelm@45473: 
wenzelm@45474:   sealed case class Entry(
wenzelm@45474:     range: Text.Range,
wenzelm@45474:     rev_markup: List[XML.Elem],
wenzelm@45474:     elements: Set[String],
wenzelm@45474:     subtree: Markup_Tree)
wenzelm@45469:   {
wenzelm@45474:     def + (info: XML.Elem): Entry =
wenzelm@45474:       if (elements(info.markup.name)) copy(rev_markup = info :: rev_markup)
wenzelm@45474:       else copy(rev_markup = info :: rev_markup, elements = elements + info.markup.name)
wenzelm@45474: 
wenzelm@45470:     def markup: List[XML.Elem] = rev_markup.reverse
wenzelm@45469:   }
wenzelm@45469: 
wenzelm@38479:   object Branches
wenzelm@38479:   {
wenzelm@38578:     type T = SortedMap[Text.Range, Entry]
wenzelm@45456:     val empty: T = SortedMap.empty(Text.Range.Ordering)
wenzelm@38479:   }
wenzelm@49466: 
wenzelm@49466: 
wenzelm@49466:   /* XML representation */
wenzelm@49466: 
wenzelm@49467:   @tailrec private def strip_elems(markups: List[Markup], body: XML.Body): (List[Markup], XML.Body) =
wenzelm@49467:     body match {
wenzelm@49467:       case List(XML.Elem(markup1, body1)) => strip_elems(markup1 :: markups, body1)
wenzelm@49467:       case _ => (markups, body)
wenzelm@49467:     }
wenzelm@49467: 
wenzelm@49467:   private def make_trees(acc: (Int, List[Markup_Tree]), tree: XML.Tree): (Int, List[Markup_Tree]) =
wenzelm@49467:     {
wenzelm@49467:       val (offset, markup_trees) = acc
wenzelm@49467: 
wenzelm@49467:       strip_elems(Nil, List(tree)) match {
wenzelm@49467:         case (Nil, body) =>
wenzelm@49467:           (offset + XML.text_length(body), markup_trees)
wenzelm@49466: 
wenzelm@49467:         case (markups, body) =>
wenzelm@49467:           val (end_offset, markup_trees1) = (acc /: body)(make_trees)
wenzelm@49467:           val range = Text.Range(offset, end_offset)
wenzelm@49467:           val new_markup_tree =
wenzelm@49467:             (merge_disjoint(markup_trees1) /: markups) {
wenzelm@49467:               case (markup_tree, markup) =>
wenzelm@49467:                 markup_tree + Text.Info(range, XML.Elem(markup, Nil))
wenzelm@49467:             }
wenzelm@49467:           (end_offset, List(new_markup_tree))
wenzelm@49466:       }
wenzelm@49467:     }
wenzelm@49466: 
wenzelm@49467:   def from_XML(body: XML.Body): Markup_Tree =
wenzelm@49467:     merge_disjoint(((0, Nil: List[Markup_Tree]) /: body)(make_trees)._2)
wenzelm@38479: }
immler@34554: 
immler@34393: 
wenzelm@49467: final class Markup_Tree private(private val branches: Markup_Tree.Branches.T)
wenzelm@34717: {
wenzelm@49417:   import Markup_Tree._
wenzelm@49417: 
wenzelm@45469:   private def this(branches: Markup_Tree.Branches.T, entry: Markup_Tree.Entry) =
wenzelm@45469:     this(branches + (entry.range -> entry))
wenzelm@45469: 
wenzelm@38563:   override def toString =
wenzelm@38563:     branches.toList.map(_._2) match {
wenzelm@38563:       case Nil => "Empty"
wenzelm@38563:       case list => list.mkString("Tree(", ",", ")")
wenzelm@38563:     }
wenzelm@38563: 
wenzelm@45469:   private def overlapping(range: Text.Range): Branches.T =
wenzelm@45457:   {
wenzelm@45457:     val start = Text.Range(range.start)
wenzelm@45457:     val stop = Text.Range(range.stop)
wenzelm@45457:     val bs = branches.range(start, stop)
wenzelm@45457:     // FIXME check after Scala 2.8.x
wenzelm@45457:     branches.get(stop) match {
wenzelm@45469:       case Some(end) if range overlaps end.range => bs + (end.range -> end)
wenzelm@45457:       case _ => bs
wenzelm@45457:     }
wenzelm@45457:   }
wenzelm@45457: 
wenzelm@45469:   def + (new_markup: Text.Markup): Markup_Tree =
wenzelm@34703:   {
wenzelm@45469:     val new_range = new_markup.range
wenzelm@45469: 
wenzelm@38578:     branches.get(new_range) match {
wenzelm@45473:       case None => new Markup_Tree(branches, Entry(new_markup, empty))
wenzelm@45469:       case Some(entry) =>
wenzelm@45469:         if (entry.range == new_range)
wenzelm@45473:           new Markup_Tree(branches, entry + new_markup.info)
wenzelm@45469:         else if (entry.range.contains(new_range))
wenzelm@45469:           new Markup_Tree(branches, entry.copy(subtree = entry.subtree + new_markup))
wenzelm@38578:         else if (new_range.contains(branches.head._1) && new_range.contains(branches.last._1))
wenzelm@45473:           new Markup_Tree(Branches.empty, Entry(new_markup, this))
wenzelm@38482:         else {
wenzelm@45457:           val body = overlapping(new_range)
wenzelm@38578:           if (body.forall(e => new_range.contains(e._1))) {
wenzelm@45469:             val rest = // branches -- body, modulo workarounds for Redblack in Scala 2.8.0 FIXME
wenzelm@38657:               if (body.size > 1)
wenzelm@38657:                 (Branches.empty /: branches)((rest, entry) =>
wenzelm@38657:                   if (body.isDefinedAt(entry._1)) rest else rest + entry)
wenzelm@38657:               else branches
wenzelm@45473:             new Markup_Tree(rest, Entry(new_markup, new Markup_Tree(body)))
wenzelm@38482:           }
wenzelm@38482:           else { // FIXME split markup!?
wenzelm@48762:             System.err.println("Ignored overlapping markup information: " + new_markup +
wenzelm@48762:               body.filter(e => !new_range.contains(e._1)).mkString("\n"))
wenzelm@38482:             this
wenzelm@38482:           }
wenzelm@38482:         }
wenzelm@34703:     }
wenzelm@34703:   }
wenzelm@34703: 
wenzelm@46178:   def cumulate[A](root_range: Text.Range, root_info: A, result_elements: Option[Set[String]],
wenzelm@46178:     result: PartialFunction[(A, Text.Markup), A]): Stream[Text.Info[A]] =
wenzelm@45459:   {
wenzelm@46178:     def results(x: A, entry: Entry): Option[A] =
wenzelm@46178:       if (result_elements match { case Some(es) => es.exists(entry.elements) case None => true }) {
wenzelm@45474:         val (y, changed) =
wenzelm@45474:           (entry.markup :\ (x, false))((info, res) =>
wenzelm@45474:             {
wenzelm@45474:               val (y, changed) = res
wenzelm@46165:               val arg = (y, Text.Info(entry.range, info))
wenzelm@46178:               if (result.isDefinedAt(arg)) (result(arg), true)
wenzelm@45474:               else res
wenzelm@45474:             })
wenzelm@45474:         if (changed) Some(y) else None
wenzelm@45474:       }
wenzelm@45474:       else None
wenzelm@45467: 
wenzelm@45459:     def stream(
wenzelm@45459:       last: Text.Offset,
wenzelm@45469:       stack: List[(Text.Info[A], Stream[(Text.Range, Entry)])]): Stream[Text.Info[A]] =
wenzelm@45459:     {
wenzelm@45459:       stack match {
wenzelm@45469:         case (parent, (range, entry) #:: more) :: rest =>
wenzelm@45467:           val subrange = range.restrict(root_range)
wenzelm@45469:           val subtree = entry.subtree.overlapping(subrange).toStream
wenzelm@45459:           val start = subrange.start
wenzelm@45459: 
wenzelm@46178:           results(parent.info, entry) match {
wenzelm@45469:             case Some(res) =>
wenzelm@45469:               val next = Text.Info(subrange, res)
wenzelm@45469:               val nexts = stream(start, (next, subtree) :: (parent, more) :: rest)
wenzelm@45469:               if (last < start) parent.restrict(Text.Range(last, start)) #:: nexts
wenzelm@45469:               else nexts
wenzelm@45469:             case None => stream(last, (parent, subtree #::: more) :: rest)
wenzelm@45459:           }
wenzelm@45459: 
wenzelm@45459:         case (parent, Stream.Empty) :: rest =>
wenzelm@45459:           val stop = parent.range.stop
wenzelm@45459:           val nexts = stream(stop, rest)
wenzelm@45459:           if (last < stop) parent.restrict(Text.Range(last, stop)) #:: nexts
wenzelm@45459:           else nexts
wenzelm@45459: 
wenzelm@45459:         case Nil =>
wenzelm@45467:           val stop = root_range.stop
wenzelm@45467:           if (last < stop) Stream(Text.Info(Text.Range(last, stop), root_info))
wenzelm@45459:           else Stream.empty
wenzelm@45459:       }
wenzelm@45459:     }
wenzelm@45467:     stream(root_range.start,
wenzelm@45467:       List((Text.Info(root_range, root_info), overlapping(root_range).toStream)))
wenzelm@45459:   }
wenzelm@45459: 
wenzelm@49465:   def swing_tree(parent: DefaultMutableTreeNode,
wenzelm@49465:     swing_node: Text.Info[List[XML.Elem]] => DefaultMutableTreeNode)
wenzelm@38479:   {
wenzelm@45469:     for ((_, entry) <- branches) {
wenzelm@47539:       val node = swing_node(Text.Info(entry.range, entry.markup))
wenzelm@49465:       entry.subtree.swing_tree(node, swing_node)
wenzelm@49465:       parent.add(node)
immler@34514:     }
immler@34514:   }
wenzelm@34717: }
immler@34514: