All Downloads are FREE. Search and download functionalities are using the official Maven repository.

br.gov.lexml.renderer.docx.docxmodel.DocxDocument.scala Maven / Gradle / Ivy

Go to download

Renders LexML Brazil XML files to DOCX format.

There is a newer version: 1.1.4
Show newest version
package br.gov.lexml.renderer.docx.docxmodel

import scala.xml._
import java.io._
import org.apache.commons.io.IOUtils

import scala.language.existentials
import scala.reflect.runtime.universe.Type

object XmlUtils {
  def xmlToByteArray(e : Elem) = {
    val w = new StringWriter()
    XML.write(w,e,"utf-8",true,null,MinimizeMode.Always)
    w.close()
    w.toString().getBytes("utf-8")
  }
}

final case class HrefData(href : java.net.URI, id : String, tooltip : Option[String] = None, anchor : Option[String] = None,
    rPr : Option[RPr] = None) {
  def toRelationship = Relationship(id = id, target = href, targetMode = TM_External, typ = RT_Hyperlink)
}

abstract sealed class RelationshipType extends Product {
  val value : String
}

object RelationshipType {
  def apply(value : String) : RelationshipType = value match {
    case RT_Hyperlink.value => RT_Hyperlink
    case _ => RT_Other(value)
  }
}

case object RT_Hyperlink extends RelationshipType {
  override val value = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink"
}

case object RT_Footer extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/footer" // footer1.xml
}

case object RT_Settings extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/settings" // settings.xml
}

case object RT_Header extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/header" // header1.xml
}

case object RT_Styles extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/styles" // styles.xml
}

case object RT_Numbering extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/numbering" // numbering.xml
}

case object RT_Endnotes extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/endnotes" // endnotes.xml
}

case object RT_Footnotes extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/footnotes" // footnotes.xml
}

case object RT_Theme extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/theme" // theme/theme1.xml
}

case object RT_WebSettings extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/webSettings" // webSettings.xml
}

case object RT_FontTable extends RelationshipType {
  override val value = "http://purl.oclc.org/ooxml/officeDocument/relationships/fontTable" // fontTable.xml
}


final case class RT_Other(override val value : String) extends RelationshipType

abstract sealed class TargetMode(val isDefault : Boolean = false) extends Product {
  val value : String
  lazy val nonDefaultValue : String = if(isDefault) { null } else { value }
}

object TargetMode {
  def apply(value : Option[String]) : TargetMode = value match {
    case None => TM_Implicit
    case Some(TM_External.value) => TM_External
    case Some(TM_Implicit.value) => TM_Implicit
    case Some(x) => TM_Other(x)
  }
}

case object TM_External extends TargetMode(false) {
  override val value = "External"
}

case object TM_Implicit extends TargetMode(true) {
  override val value = "Implicit"
}

final case class TM_Other(override val value : String) extends TargetMode(value == TM_Implicit.value) 
    
final case class Relationship(id : String, typ : RelationshipType, target : java.net.URI, targetMode : TargetMode) extends XmlComponent {
  lazy val asXML : Elem = 
      (  
      
      )
  
}

final case class Relationships(relationships : Seq[Relationship] = Seq()) extends XmlComponent {
  lazy val asXML : Elem = (
    
      {NodeSeq.fromSeq(relationships.map(_.asXML))}
    		  
      )
}

object Relationships {
  def fromByteArray(data : Array[Byte]) : Relationships = {    
    def rel(id : String, targetStr : String, typStr : String, targetModeStr : Option[String]) : Relationship = {
      Relationship(id = id,
          target = new java.net.URI(targetStr),
          typ = RelationshipType(typStr),
          targetMode = TargetMode(targetModeStr))      
    }
    val root = XML.load(new java.io.ByteArrayInputStream(data))
    
    val rels = (root \\ "Relationship").to(Seq).collect {
      case e : Elem =>        
        rel(e.attribute("Id").get.head.text,
         e.attribute("Target").get.head.text,
         e.attribute("Type").get.head.text,
         e.attribute("TargetMode").flatMap(_.headOption.map(_.text)))
    }
    Relationships(relationships = rels)
  }
}
    
final case class Docx(
    mainDoc : DocxMainDocument = DocxMainDocument(),
    baseRelationships : Relationships = Relationships(),    
    hyperlinks : Seq[HrefData] = Seq(),
    endnotes : Seq[(String,Seq[DocxTextComponent])]= Seq(),
    footnotes : Seq[(String,Seq[DocxTextComponent])] = Seq()) {    
  def mainDocFile = XmlUtils.xmlToByteArray(mainDoc.asXML)
  
  def relationshipsFile = XmlUtils.xmlToByteArray(relationships.asXML)
  
  def files : Map[String,Array[Byte]] = Map(
    "word/document.xml" -> mainDocFile,
    "word/_rels/document.xml.rels" -> relationshipsFile,
    "word/footnotes.xml" -> makeNotesFile("footnotes","footnote",footnotes),
    "word/endnotes.xml" -> makeNotesFile("endnotes","endnote",endnotes)
  )
    
  def makeNotesFile(rootLabel : String, childLabel : String, notes : Seq[(String,Seq[DocxTextComponent])]) : Array[Byte] = {    
      val innerElems1 = Seq(
        
    			
      			
        			
      			
    		 	
  			,
        
    		  
      		 	
        			
      			
    			
  			)        
    val refHead = Seq(
        R(rPr = Some(RPr(rStyle = Some("Refdenotadefim"))),Seq(T("("),EndnoteRef,T(")"))),
        R(rPr = None,Seq(T(" ",true)))
        )
        
    val innerElems2 = notes.map { case (id,contents) =>      
      val first = contents.head match {
        case p : P =>
          p.replaceParElements(refHead ++ p.parElements)
      }
      val contents2 = first +: contents.tail
            
      
								
          {NodeSeq.fromSeq(contents2.map(_.asXML))}
       
    }
    val innerElems = (innerElems1 ++ innerElems2).map(_.copy(label = childLabel))    
    val rootElem = (
      
			{ NodeSeq fromSeq (innerElems)
			}
			
			).copy(label = rootLabel)
	  XmlUtils.xmlToByteArray(rootElem)
  }    
  
  def relationships : Relationships = {    
    val rels = baseRelationships.relationships ++ hyperlinks.map(_.toRelationship)        
    baseRelationships.copy(relationships = rels)
  }            
}

final case class DocxMainDocument(contents : Seq[DocxTextComponent] = Seq())
    extends XmlComponent with DocxTextComponentContainer[DocxMainDocument]  {
  override def asXML : Elem = (

  
    {NodeSeq.fromSeq(contents.map(_.asXML))}
    
      
				
			
      
      
			      
            
      
    
  

   )
   def flatMap(f : DocxTextComponent => Seq[DocxTextComponent]) : DocxMainDocument = 
     DocxMainDocument(contents = contents.flatMap(f))
}

sealed trait DocxTextComponent extends Product with XmlComponent {
  def isEmpty : Boolean
}

trait DocxTextComponentContainer[T] {
  def flatMap(f : DocxTextComponent => Seq[DocxTextComponent]) : T
}

final case class P(runs : Seq[ParElement] = Seq(),pPr : Option[PPr] = None) extends DocxTextComponent with ParElementContainer[P] {
  lazy val asXML = (

  {pPr.elem(_.asXML)}
  {runs.eachElem(_.asXML)}

  )
  def insertFirst(els : ParElement*) =
    copy(runs = els ++ runs)
  def insertLast(els : ParElement*) =
    copy(runs = runs ++ els)
  def isEmpty = runs.forall(_.isEmpty)
  
  def replaceParElements(pl : Seq[ParElement]) = copy (runs = pl)    

  override val parElements = runs
}

final case class TblPr() extends XmlComponent {
  lazy val asXML : Elem = ???
}
final case class GridCol() extends XmlComponent {
  lazy val asXML : Elem = ???
}

final case class TblGrid(gridCols : Seq[GridCol] = Seq()) extends XmlComponent {
  lazy val asXML : Elem = ???
}
final case class TR(trPr : Option[TrPr] = None,
                    cols : Seq[TC] = Seq()) extends XmlComponent {
  lazy val asXML : Elem = ???
}

final case class TrPr() extends XmlComponent {
  lazy val asXML : Elem = ???
}

final case class TC(tcPr : Option[TcPr] = None, contents : Seq[DocxTextComponent]) extends XmlComponent {
  lazy val asXML : Elem = ???
}

final case class TcPr() extends XmlComponent {
  lazy val asXML : Elem = ???
}

final case class Table(tblPr : Option[TblPr] = None,
                       tblGrid : Option[TblGrid] = None,
                       rows : Seq[TR] = Seq()) extends DocxTextComponent with XmlComponent {
  lazy val asXML =
    
      {tblPr.elem(_.asXML)}
      {tblGrid.elem(_.asXML)}
      {rows.eachElem(_.asXML)}
    

  override def isEmpty: Boolean = rows.isEmpty
}

sealed trait ParElement extends Product with XmlComponent {
  def isEmpty : Boolean = false
}

trait ParElementContainer[T <: ParElementContainer[T]] {  
  final def flatMap(f : (Option[ParElement],ParElement,Option[ParElement]) => Seq[ParElement]) : T = {
    val t = parElements.zipAll(None +: parElements.init.map(Some(_)), null, None).
            zipAll(parElements.tail.map(Some(_)), null, None).collect {
      case ((a,b),c) => (b,a,c)
    }
    replaceParElements(t.flatMap(f.tupled))    
  }
  def replaceParElements(pl : Seq[ParElement]) : T
  def parElements : Seq[ParElement]
}

abstract sealed class CapsMode extends Product {
  def asXML : NodeSeq
}

case object CM_Caps extends CapsMode {
  def asXML = ()
}
case object CM_SmallCaps extends CapsMode {
  def asXML = ()
}
case object CM_Normal extends CapsMode {
  def asXML = NodeSeq.fromSeq(Seq(
      ,
      
      ))
}

final case class RGB(red : Double, green : Double, blue : Double) {
  lazy val value = f"${r}%02X${g}%02X${b}%02X"
  private val r = norm(red)
  private val g = norm(green)
  private val b = norm(blue)
  private def norm(v : Double) = math.floor(255.0*v).toInt
}

final case class Fonts(
    ascii : Option[String] = None,
    cs : Option[String] = None,
    hAnsi : Option[String] = None) extends XmlComponent {
  lazy val asXML = (

      )
}

abstract sealed class UnderlineOption extends Product with XmlComponent

case object UO_NoUnderline extends UnderlineOption {
  val asXML = 
}

abstract sealed class UnderlineStyle(val value : String) extends Product

case object US_Dash extends UnderlineStyle("dash")
case object US_DashDotDotHeavy extends UnderlineStyle("dashDotDotHeavy")
case object US_DashDotHeavy extends UnderlineStyle("dashDotHeavy")
case object US_DashedHeavy extends UnderlineStyle("dashedHeavy")
case object US_DashLong extends UnderlineStyle("dashLong")
case object US_DashLongHeavy extends UnderlineStyle("dashLongHeavy")
case object US_DotDash extends UnderlineStyle("dotDash")
case object US_DotDotDash extends UnderlineStyle("dotDotDash")
case object US_Dotted extends UnderlineStyle("dotted")
case object US_DottedHeavy extends UnderlineStyle("dottedHeavy")
case object US_Double extends UnderlineStyle("double")
case object US_None extends UnderlineStyle("none")
case object US_Single extends UnderlineStyle("single")
case object US_Thick extends UnderlineStyle("thick")
case object US_Wave extends UnderlineStyle("wave")
case object US_WavyDouble extends UnderlineStyle("wavyDouble")
case object US_WavyHeavy extends UnderlineStyle("wavyHeavy")
case object US_Words extends UnderlineStyle("words")

final case class UO_Underline(color : Option[RGB] = None) extends UnderlineOption {
  val asXML = ()
}

abstract sealed class VertAlignment(val value : String) extends Product

case object VA_Superscript extends VertAlignment("superscript")
case object VA_Subscript extends VertAlignment("subscript")
case object VA_Baseline extends VertAlignment("baseline")

final case class RPr(
    bold : Option[Boolean] = None,
    boldCs : Option[Boolean] = None,
    italics : Option[Boolean] = None,
    italicsCs : Option[Boolean] = None,
    capsMode : Option[CapsMode] = None,
    color : Option[RGB] = None,
    lang : Option[String] = None,
    fonts : Option[Fonts] = None,
    rStyle : Option[String] = None,
    strike : Option[Boolean] = None,
    sz : Option[Int] = None,
    kern : Option[Int] = None,
    szCs : Option[Int] = None,
    underline : Option[UnderlineOption] = None,
    vertAlign : Option[VertAlignment] = None
    ) extends XmlComponent {
  lazy val asXML = (

{bold.elem(x => )}
{italics.elem(x => )}
{boldCs.elem(x => )}
{italicsCs.elem(x => )}
{capsMode.map(_.asXML).getOrElse(NodeSeq.Empty)}
{color.elem(v => )}
{lang.elem(x => )}
{fonts.elem(_.asXML)}
{rStyle.elem(x => )}
{strike.elem(x => )}
{sz.elem(x => )}
{szCs.elem(x => )}
{kern.elem(x => )}
{underline.elem(_.asXML)}

      )
  def +(x : RPr) = RPr(
      bold = x.bold orElse bold,
      italics = x.italics orElse italics,
      boldCs = x.boldCs orElse boldCs,
      italicsCs = x.italicsCs orElse italicsCs,
      capsMode = x.capsMode orElse capsMode,
      color = x.color orElse color,
      lang = x.lang orElse lang,
      fonts = x.fonts orElse fonts,
      rStyle = x.rStyle orElse rStyle,
      strike = x.strike orElse strike,
      sz = x.sz orElse sz,
      szCs = x.szCs orElse szCs,
      underline = x.underline orElse underline,
      vertAlign = x.vertAlign orElse vertAlign)

}

final case class R(
    rPr : Option[RPr] = None,
    contents : Seq[RunContent] = Seq()) extends ParElement with RunContentContainer[R] {
  lazy val asXML = (

{rPr.onSome(_.asXML)}
{contents.map(_.asXML)}

      )
  def insertFirst(els : RunContent*) = copy(contents = els ++ contents)
  def insertLast(els : RunContent*) = copy(contents = contents ++ els)
  override def isEmpty = contents.forall(_.isEmpty)
  def flatMap(f : RunContent => Seq[RunContent]) : R = 
    copy(contents = contents.flatMap(f))
}

abstract sealed class RunContent extends Product with XmlComponent {
  def isEmpty : Boolean = false
}

trait RunContentContainer[+T] {
  def flatMap(f : RunContent => Seq[RunContent]) : T
  def contents : Seq[RunContent]
}

case object Br extends RunContent {
  val asXML = 
}

final case class DelText(text : String, preserveSpace : Boolean = false) extends RunContent {
  lazy val asXML = (
      {text}
      )
}

final case class Del(id : String, content : Seq[ParElement] = Seq(), author : Option[String] = None, date : Option[java.time.ZonedDateTime] = None
    ) extends RunContent with ParElementContainer[Del] {
  lazy val asXML = (
      
    {NodeSeq.fromSeq(content.map(_.asXML))}
    
      )
  def replaceParElements(pl : Seq[ParElement]) = copy (content = pl)        
   
  override val parElements = content
}

final case class Ins(id : String, content : Seq[ParElement] = Seq(), author : Option[String] = None, date : Option[java.time.ZonedDateTime] = None
    ) extends RunContent with ParElementContainer[Ins] {
  lazy val asXML = (
      
    {NodeSeq.fromSeq(content.map(_.asXML))}
    
      )
  def replaceParElements(pl : Seq[ParElement]) = copy (content = pl)    
  override val parElements = content
}

final case class Hyperlink(
    content : Seq[ParElement] = Seq(), 
    anchor : Option[String] = None, 
    id : Option[String] = None, 
    tooltip : Option[String] = None) extends ParElement 
  with ParElementContainer[Hyperlink] {
  lazy val asXML = (
   
   {NodeSeq.fromSeq(content.map(_.asXML))}
  
      )
    
  def replaceParElements(pl : Seq[ParElement]) = copy (content = pl)      
    
  override val parElements = content
}

case object NoBreakHyphen extends RunContent {
  val asXML = 
}

case class Sym(font : String, char : String) extends RunContent {
  val asXML = 
}

case class T(text : String, preserveSpace : Boolean = false) extends RunContent {
  lazy val asXML = {text}

  override val isEmpty = text.trim.size == 0
}

case object EndnoteRef extends RunContent {
  val asXML = 
}

case object FootnoteRef extends RunContent {
  val asXML = 
}

abstract sealed class PTabAlignment(val value : String) extends Product 

case object PTA_Left extends PTabAlignment("left")
case object PTA_Center extends PTabAlignment("center")
case object PTA_Right extends PTabAlignment("right")

abstract sealed class PTabBase(val value : String) extends Product

case object PTB_Indent extends PTabBase("indent")
case object PTB_Margin extends PTabBase("margin")

case class PTab(
    alignment : PTabAlignment,
    leader : Option[TabLeader] = None,
    relativeTo : PTabBase) extends RunContent {
  val asXML = 
}

/**
 *
 * 
...

...

 *
 */
final case class ContentPart(id : String) extends RunContent {
  val asXML = 
}

final case class Ind(
      start : Pts20 = Pts20(0), 
      end : Pts20 = Pts20(0),
      hanging : Pts20 = Pts20(0),
      firstLine : Pts20 = Pts20(0)//twentieths of a point
      ) extends XmlComponent {  
  lazy val asXML_1 = (

    )
  lazy val asXML = (

    )
}

abstract sealed class ST_Jc(val v : String) extends Product

case object JC_Both extends ST_Jc("both")
case object JC_Center extends ST_Jc("center")
case object JC_Distribute extends ST_Jc("distribute")
case object JC_End extends ST_Jc("end")
case object JC_NumTab extends ST_Jc("numTab")
case object JC_Start extends ST_Jc("start")

abstract sealed class TabLeader(val value : String) extends Product

case object TL_Dot extends TabLeader("dot")
case object TL_Heavy extends TabLeader("heavy")
case object TL_Hyphen extends TabLeader("hyphen")
case object TL_MiddleDot extends TabLeader("middleDot")
case object TL_None extends TabLeader("none")
case object TL_Underscore extends TabLeader("underscore")

abstract sealed class TabStopType(val value : String) extends Product

/**
 * Specifies that the current tab stop shall result in a
location in the document where all following text is
aligned to its trailing edge (i.e. all text runs following
this tab stop and preceding the next tab stop shall be
aligned against the trailing edge with respect to the
tab stop location). [Example: In an RTL paragraph, the
trailing edge is the left edge, so text aligns to that
edge, extending to the right. end example]
 */
case object TST_End extends TabStopType("end")

/*
 * Specifies that the current tab stop shall result in a
location in the document where all following text is
aligned to its leading edge (i.e. all text runs following
this tab stop and preceding the next tab stop shall be
aligned against the leading edge with respect to the
tab stop location).
 */
case object TST_Start extends TabStopType("start")

final case class Tab(
    pos : Pts20 = Pts20(0),
    tabType : TabStopType = TST_Start,
    leader : TabLeader = TL_None
    ) extends Product {
  lazy val asXML = (

      )
}

final case object TAB extends RunContent {
  def asXML = 
}

final case class FootnoteReference(id : String) extends RunContent {
  def asXML = 
}

final case class EndnoteReference(id : String) extends RunContent {
  def asXML = 
}

abstract sealed class SpacingLineRule(val value : String) extends Product

case object SLR_AtLeast extends SpacingLineRule("atLeast")
case object SLR_Exactly extends SpacingLineRule("exactly")
case object SLR_Auto extends SpacingLineRule("auto")

abstract sealed class Measure[T <: Measure[T]](ratio : Double) extends Product {
  val v : Double  
  val rounded = math.round(ratio*v).toInt
  val value = rounded.toString   
  val nzValue = if (rounded > 0) { value } else { null }
}

abstract sealed class Pts[T <: Pts[T]](ratio : Double) extends Measure[T](ratio)

final case class Pts20(v : Double) extends Pts[Pts20](20) 

abstract sealed class Lines[T <: Lines[T]](ratio : Double) extends Measure[T](ratio)

final case class Lines100(v : Double) extends Lines[Lines100](100)

final case class Lines240(v : Double) extends Lines[Lines240](240)

final case class Spacing(
    after : Option[Pts20] = None, // 1/20 pt
    afterLines : Option[Lines100] = None, // 1/100 line
    before : Option[Pts20] = None, // 1/20 pt
    beforeLines : Option[Lines100] = None, // 1/100 line
    line : Option[Either[Pts20,Lines240]] = None, // 1/20 pt (for lineRule = atLeast or exactly) or 1/240 line if (auto)
    lineRule : Option[SpacingLineRule] = None
    ) extends XmlComponent {
  def r(x : Option[Measure[_]]) : String = x.map(_.value).getOrElse(null) 
  def asXML = (
       x,x => x)))}
        w:lineRule={lineRule.map(_.value).optAttr}/>
      )
}

final case class PPr(
    divId : Option[String] = None,
    ind : Option[Ind] = None,
    jc : Option[ST_Jc] = None,    
    tabs : Seq[Tab] = Seq(),
    spacing : Option[Spacing] = None,
    widowControl : Boolean = true,
    qFormat : Boolean = true,
    pStyle : Option[String] = None
    ) extends XmlComponent {
  lazy val asXML = (

  {pStyle.elem(n => )}
  {if(widowControl) {  } else { NodeSeq.Empty }}
  {cond(!tabs.isEmpty)({tabs.eachElem(_.asXML)})}
  {spacing.elem(_.asXML)}
  {ind.elem(_.asXML)}
  {jc.elem(x => )}
  {divId.elem(n => )}  

  )
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy