/src/main/scala/de/lecturedoc/parser/Decorator.scala

/*
 * (c) 2013 Michael Eichberg et al.
 * https://bitbucket.org/delors/lecturedoc
 * 
 * See LICENSE and Actuarius-LICENSE for license details.
 */
package de.lecturedoc
package parser

/**
  * This trait influences the behavior of the LectureDoc output of inline and block parsers
  * and the complete transformer.
  *
  * Mix in this trait and override methods to change the behavior and override the "decorateXXX()" method
  * in the respective parser/transformer to return your modified instances to change the output they create.
  *
  * Inline element decoration methods always get passed the spanned text, so you have to
  * prepend and append the opening/closing tags. For block elements there is always a method
  * for the opening and closing tags. This is to make block
  * processing more efficient to prevent unnecessary String building of whole blocks just to
  * add tags. (The block building uses a StringBuilder internally and just appends the returned tags)
  *
  * If you want line breaks after opening/closing block level tags, you have to add the newline yourself.
  */
trait Decorator {
    /**
      * The string used to indent one level. Defaults to the empty string.
      */
    def indentation() = ""

    /**
      * If true, inline xml tags and verbatim xml blocks are allowed,
      * otherwise they are escaped and included as plain text.
      */
    def allowVerbatimXml(): Boolean = true

    /**
      * Used to print out manual line breaks (default: <br />).
      */
    def decorateBreak(): String = "<br />"

    /**
      * Used to print out inline code (default: <code>...</code>).
      */

    def decorateCode(code: String): String = {
        "<code>" + code + "</code>"
    }

    /**
      * Used to print out emphasized text (default <em>...</em>).
      */
    def decorateEmphasis(text: String): String = "<em>"+text+"</em>"

    /**
      * Used to print out strong text (default: <strong>...</strong>).
      */
    def decorateStrong(text: String): String = "<strong>"+text+"</strong>"

    /**
      * Used to print link elements (default: <a href...).
      */
    def decorateLink(text: String, url: String, title: Option[String]): String = title match {
        case None    ⇒ "<a href=\""+url+"\">"+text+"</a>"
        case Some(t) ⇒ "<a href=\""+url+"\" title=\""+t+"\">"+text+"</a>"
    }

    /**
      * Used to print image elements (default: <img ...)
      */
    def decorateImg(alt: String, src: String, title: Option[String]): String = title match {
        case None    ⇒ "<img src=\""+src+"\" alt=\""+alt+"\" />"
        case Some(t) ⇒ "<img src=\""+src+"\" alt=\""+alt+"\" title=\""+t+"\" />"
    }

    /**
      * Used to print a horizontal ruler (default: to "<hr />\n").
      */
    def decorateRuler(): String = "<hr />\n"

    /**
      *  Used to print the beginning of a header (default: "<h[HEADER_NO]>").
      */
    def decorateHeaderOpen(headerNo: Int, customDataAttributes: Option[List[CustomDataAttribute]]): String = {
        "<h" +
        headerNo +
        customDataAttributes.map(cdas ⇒ " "+cdas.map(_.toHTML5DataAttribute).mkString(" ")).getOrElse("") +
        ">"
        }

    /**
      *  Used to print the end of a header (default: "</h[HEADER_NO]\n>").
      */
    def decorateHeaderClose(headerNo: Int): String = "</h"+headerNo+">\n"

    /**
      *  Used to print the beginning of a code block (default: "<pre><code[ class="LANGUAGE"]>").
      */
    def decorateCodeBlockOpen(language: Option[String], customDataAttributes: Option[List[CustomDataAttribute]]): String = {
        language match {
        case Some(language) ⇒ {
            "<pre" +
            customDataAttributes.map(cdas ⇒ " "+cdas.map(_.toHTML5DataAttribute).mkString(" ")).getOrElse("") +
            "><code class=\""+language+"\">"
            }
        case None           ⇒ {
            "<pre" +
            customDataAttributes.map(cdas ⇒ " "+cdas.map(_.toHTML5DataAttribute).mkString(" ")).getOrElse("") +
            "><code>"
            }
        }
    }

    /**
      *  Used to print the end of a code block (default: "</code></pre>\n").
      */
    def decorateCodeBlockClose(): String = "</code></pre>\n"

    /**
      * Used to print the beginning of a section.
      */
    def decorateSectionOpen(
        sectionType: String,
        sectionTitle: Option[String],
        sectionClass: Option[String],
        customDataAttributes: Option[List[CustomDataAttribute]]): String = {
        "<"+sectionType +
            sectionClass.map(" class=\""+_+"\"").getOrElse("") +
            sectionTitle.map(" data-title=\""+_+"\"").getOrElse("") +
            customDataAttributes.map(cdas ⇒ " "+cdas.map(_.toHTML5DataAttribute).mkString(" ")).getOrElse("") +
            "><div class=\""+sectionType+"-body\">"
    }

    /** used to print the end of a section */
    def decorateSectionClose(sectionType: String): String = "</div></"+sectionType+">\n"

    /** used to print the beginning of a paragraph, defaults to "<p>" */
    def decorateParagraphOpen(customDataAttributes: Option[List[CustomDataAttribute]]): String = {
        "<p" +
        customDataAttributes.map(cdas ⇒ " "+cdas.map(_.toHTML5DataAttribute).mkString(" ")).getOrElse("") +
        ">"
    }

    /** used to print the end of a paragraph, defaults to "</p>\n" */
    def decorateParagraphClose(): String = "</p>\n"

    /** used to print the beginning of a statement, defaults to "<div>" */
    def decorateStatementOpen(customDataAttributes: Option[List[CustomDataAttribute]]): String = {
        "<div class=\"statement\"" +
        customDataAttributes.map(cdas ⇒ " "+cdas.map(_.toHTML5DataAttribute).mkString(" ")).getOrElse("") +
        ">"
    }

    /** used to print the end of a statement, defaults to "</div>\n" */
    def decorateStatementClose(): String = "</div>\n"

    /** used to print the beginning of a blockquote, defaults to "<blockquote>" */
    def decorateBlockQuoteOpen(customDataAttributes: Option[List[CustomDataAttribute]]): String = {
        "<blockquote" +
        customDataAttributes.map(cdas ⇒ " "+cdas.map(_.toHTML5DataAttribute).mkString(" ")).getOrElse("") +
        ">"
    }

    /** used to print the end of a blockquote, defaults to "</blockquote>\n" */
    def decorateBlockQuoteClose(): String = "</blockquote>\n"

    /** used to print the beginning of a list item, defaults to "<li>" */
    def decorateItemOpen(customDataAttributes: Option[List[CustomDataAttribute]]): String = {
        "<li" +
        customDataAttributes.map(cdas ⇒ " "+cdas.map(_.toHTML5DataAttribute).mkString(" ")).getOrElse("") +
        ">"
    }

    /** used to print the end of a list item, defaults to "</li>" */
    def decorateItemClose(): String = "</li>\n"

    /** used to print the beginning of an unordered list, defaults to "<ul>\n" */
    def decorateUListOpen(): String = "<ul>\n"

    /** used to print the end of an unordered list, defaults to "</ul>\n" */
    def decorateUListClose(): String = "</ul>\n"

    /** used to print the beginning of an ordered list, defaults to <ol>\n */
    def decorateOListOpen(): String = "<ol>\n"

    /** used to print the end of an ordered list, defaults to </ol>\n */
    def decorateOListClose(): String = "</ol>\n"

}

/**
  * Default instance of Decorator with the standard Markdown behavior.
  */
object Decorator extends Decorator