# Copyright (C) 2011 The CentOS Project

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

# General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

#

# ------------------------------------------------------------------

# $Id$

# ------------------------------------------------------------------

"""This module provides support to XHTML construction.

XHTML construction, as set here, uses the Extensible HTML version 1.0

DTDs (/usr/share/sgml/xhtml1/xhtml1-20020801/DTD/) as reference. XHTML

construction is required by page module.

"""

class Strict:

    """Implements XHTML strict document type definition."""

    # Core attributes common to most elements.

    coreattrs = ['id',        # document-wide unique id

                 'class',     # space separated list of classes

                 'style',     # associated style info

                 'title'      # advisory title/amplification

                ]

    # Internationalization attributes.

    i18n = ['lang',          # language code (backwards compatible)

            'xml:lang',      # language code (as per XML 1.0 spec)

            'dir'            # direction for weak/neutral text

           ]

    # Attributes for common UI events.

    events = ['onclick',     # a pointer button was clicked

              'ondblclick',  # a pointer button was double clicked

              'onmousedown', # a pointer button was pressed down

              'onmouseup',   # a pointer button was released

              'onmousemove', # a pointer was moved onto the element

              'onmouseout',  # a pointer was moved away from the element

              'onkeypress',  # a key was pressed and released

              'onkeydown',   # a key was pressed down

              'onkeyup'      # a key was released

             ]

    # Attributes for elements that can get the focus.

    focus = ['accesskey',    # accessibility key character

             'tabindex',     # position in tabbing order

             'onfocus',      # the element got the focus

             'onblur'        # the element lost the focus

            ]

    # Attributes generic format.

    attrs = coreattrs + i18n + events

    def __init__(self):

        """Initialize class data."""

        pass

    def tag(self, name, attrs, indent=[8,1], content="", has_child=0):

        """Returns generic XHTML tag definition.

        Arguments:

        name: The XHTML tag's name. Notice that this function doesn't

            verify nor validate the XHTML tags you provide. It is up

            to you write them correctly considering the XHTML standard

            definition.

        attrs: The XHTML tag's attribute. Notice that this function

            doesn't verify the attributes assignation to tags. You

            need to know what attributes are considered valid to the

            tag you are creating in order to build a well-formed XHTML

            document. Such verification can be achived inside firefox

            browser through the `firebug' plugin.

        indent: The XHTML tag's indentation (Optional). This argument

            is a list of two numerical values. The first value in the

            list represents the amount of horizontal spaces between

            the beginning of line and the opening tag.  The second

            value in the list represents the amount of vertical spaces

            (new lines) between tags.

        content: The XHTML tag's content (Optional). This argument

            provides the information the tag encloses. When this

            argument is empty, tag is rendered without content.

        has_child: The XHTML tag has a child? (Optional). This

            argument is specifies whether a tag has another tag inside

            (1) or not (0).  When a tag has not a child tag,

            indentation is applied between the tag content and the

            closing tag provoking an unecessary spaces to be shown.

            Such kind of problems are prevented by setting this option

            to `0'. On the other hand, when a tag has a child tag

            inside, using the value `1' will keep the closing tag

            indentation aligned with the opening one.

        This function encapsulates the construction of XHTML tags.

        Use this function wherever you need to create XHTML tags. It

        helps to standardize tag constructions and their final output

        and. This function provides a consistent way of producing

        output for XHTML documents.

        """

        if indent[0] > 0:

            h_indent = ' '*indent[0]

        else:

            h_indent = ''

        if indent[1] > 0: 

            v_indent = "\n"*indent[1]

        else:

            v_indent = ''

        output = v_indent + h_indent + '<' + str(name)

        if len(attrs) > 0:

            attr_names = attrs.keys()

            attr_names.sort()

            for attr_name in attr_names:

                output += ' ' + str(attr_name) + '="' + str(attrs[attr_name]) + '"'

        if content == '':

            output += ' />'

        else:

            output += '>'

            output += str(content)

            if has_child == 1:

                output += h_indent + '</' + str(name) + '>'

            else:

                output += '</' + str(name) + '>'

        output += v_indent

        return output

    # ------------------------------------------------------------------ 

    # Document Type Definition

    # ------------------------------------------------------------------ 

    def doctype(self):

        """Return document type definition."""

        output = '' + "\n"

        output += '

        output += ' '*4 + 'PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"' + "\n"

        output += ' '*4 + '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' + "\n"

        return output

    # ------------------------------------------------------------------ 

    # Document Structure

    # ------------------------------------------------------------------ 

    def tag_html(self, attrs, indent, content, has_child=1):

        """Returns document structure definition.

            %i18n;

            id          ID             #IMPLIED

            xmlns       %URI;          #FIXED 'http://www.w3.org/1999/xhtml'

            >

        The namespace URI designates the document profile.

        """

        return self.tag('html', attrs, indent, content, has_child=1)

    # ------------------------------------------------------------------

    # Document Head

    # ------------------------------------------------------------------

    def tag_head(self, attrs, indent, content, has_child=1):

        """Returns document head definition.

            ((title, %head.misc;, (base, %head.misc;)?) |

            (base, %head.misc;, (title, %head.misc;))))>

            %i18n;

            id          ID             #IMPLIED

            profile     %URI;          #IMPLIED

            >

        Content model is %head.misc; combined with a single title and

        an optional base element in any order.

        """

        return self.tag('head', attrs, indent, content, has_child)

    def tag_title(self, attrs, indent, content, has_child=0):

        """Returns title definition.

            %i18n;

            id          ID             #IMPLIED

            >

        The title element is not considered part of the flow of text.

        It should be displayed, for example as the page header or

        window title. Exactly one title is required per document.

        """

        return self.tag('title', attrs, indent, content, has_child)

    def tag_base(self, attrs, indent):

        """Returns document base URI.

            href        %URI;          #REQUIRED

            id          ID             #IMPLIED

            >

        """

        return self.tag('base', attrs, indent)

    def tag_meta(self, attrs, indent):

        """Returns generic metainformation.

            %i18n;

            id          ID             #IMPLIED

            http-equiv  CDATA          #IMPLIED

            name        CDATA          #IMPLIED

            content     CDATA          #REQUIRED

            scheme      CDATA          #IMPLIED

            >

        """

        return self.tag('meta', attrs, indent)

    def tag_link(self, attrs, indent):

        """Returns relationship values.

            %attrs;

            charset     %Charset;      #IMPLIED

            href        %URI;          #IMPLIED

            hreflang    %LanguageCode; #IMPLIED

            type        %ContentType;  #IMPLIED

            rel         %LinkTypes;    #IMPLIED

            rev         %LinkTypes;    #IMPLIED

            media       %MediaDesc;    #IMPLIED

            >

        Relationship values can be used in principle:

            a) for document specific toolbars/menus when used with the

               link element in document head e.g.  start, contents,

               previous, next, index, end, help.

            b) to link to a separate style sheet (rel="stylesheet").

            c) to make a link to a script (rel="script").

            d) by stylesheets to control how collections of html nodes

               are rendered into printed documents.

            e) to make a link to a printable version of this document

               e.g.  a PostScript or PDF version (rel="alternate"

               media="print").

        """

        return self.tag('link', attrs, indent)

    def tag_style(self, attrs, indent, content, has_child=0):

        """Returns style info.

            %i18n;

            id          ID             #IMPLIED

            type        %ContentType;  #REQUIRED

            media       %MediaDesc;    #IMPLIED

            title       %Text;         #IMPLIED

            xml:space   (preserve)     #FIXED 'preserve'

            >

        """

        return self.tag('style', attrs, indent, content, has_child)

    def tag_script(self, attrs, indent, content, has_child=0):

        """Returns script statement.

            id          ID             #IMPLIED

            charset     %Charset;      #IMPLIED

            type        %ContentType;  #REQUIRED

            src         %URI;          #IMPLIED

            defer       (defer)        #IMPLIED

            xml:space   (preserve)     #FIXED 'preserve'

            >

        """

        return self.tag('script', attrs, indent, content, has_child)

    def tag_noscript(self, attrs, indent, content, has_child=1):

        """Returns alternate content container for non script-based

        rendering.

            %attrs;

            >

        """

        return self.tag(self, attrs, indent, content, has_child)

    # ------------------------------------------------------------------

    # Document Body

    # ------------------------------------------------------------------

    def tag_body(self, attrs, indent, content, has_child=1):

        """Returns document body definition.

            %attrs;

            onload          %Script;   #IMPLIED

            onunload        %Script;   #IMPLIED

            >

        """

        return self.tag('body', attrs, indent, content, has_child)

    def tag_div(self, attrs, indent, content, has_child=0):

        """Returns generic language/style container.

            %attrs;

            >

        """

        return self.tag('div', attrs, indent, content, has_child)

    # ------------------------------------------------------------------

    # Paragraphs

    # ------------------------------------------------------------------

    def tag_p(self, attrs, indent, content, has_child=0):

        """Returns paragraph definition.

            %attrs;

            >

        When content is introduced inside the database, it goes

        without any XHTML markup. This method transforms newline

        separated strings into XHTML paragraphs.

        """

        output = ''

        for line in content.splitlines():

            if line == '': continue

            output += self.tag('p', attrs, indent, line.strip(), has_child)

        return output

    # ------------------------------------------------------------------

    # Headings

    # ------------------------------------------------------------------

    # There are six levels of headings from h1 (the most important) to

    # h6 (the least important).

    # ------------------------------------------------------------------

    def tag_h1(self, attrs, indent, content, has_child=0):

        """Returns h1 definition.

            %attrs;

            >

        """

        return self.tag('h1', attrs, indent, content, has_child)

    def tag_h2(self, attrs, indent, content, has_child=0):

        """Returns h2 definition.

            %attrs;

            >

        """

        return self.tag('h2', attrs, indent, content, has_child)

    def tag_h3(self, attrs, indent, content, has_child):

        """Returns h3 definition.

            %attrs;

            >

        """

        return self.tag('h3', attrs, indent, content, has_child)

    def tag_h4(self, attrs, indent, content, has_child):

        """Returns h4 definition.

            %attrs;

            >

        """

        return self.tag('h4', attrs, indent, content, has_child)

    def tag_h5(self, attrs, indent, content, has_child=0):

        """Returns h5 definition.

            %attrs;

            >

        """

        return self.tag('h5', attrs, indent, content, has_child)

    def tag_h6(self, attrs, indent, content, has_child=0):

        """Returns h6 definition.

            %attrs;

            >

        """

        return self.tag('h6', attrs, indent, content, has_child)

    # ------------------------------------------------------------------

    # Lists

    # ------------------------------------------------------------------

    def tag_ul(self, attrs, indent, content, has_child=1):

        """Returns unordered list definition.

            %attrs;

            >

        """

        return self.tag('ul', attrs, indent, content, has_child)

    def tag_ol(self, attrs, indent, content, has_child=1):

        """Returns ordered (numbered) list definition.

            %attrs;

            >

        """

        return self.tag('ol', attrs, indent, content, has_child)

    def tag_li(self, attrs, indent, content, has_child=0):

        """Returns item definition for both ordered (ol) and unordered

        (ul) lists.

            %attrs;

            >

        """

        return self.tag('li', attrs, indent, content, has_child)

    def tag_dl(self, attrs, indent, content, has_child=1):

        """Returns definition list definition.

            %attrs;

            >

        """

        return self.tag('dl', attrs, indent, content, has_child)

    def tag_dt(self, attrs, indent, content, has_child=0):

        """Returns term of definition lists.

            %attrs;

            >

        """

        return self.tag('dt', attrs, indent, content, has_child)

    def tag_dd(self, attrs, indent, content, has_child=0):

        """Returns definition of definition lists.

            %attrs;

            >

        """

        return self.tag('dd', attrs, indent, content, has_child)

    # ------------------------------------------------------------------

    # Address

    # ------------------------------------------------------------------

    def tag_address(self, attrs, indent, content='', has_child=0):

        """Returns information on author.

            %attrs;

            >

        """

        return self.tag('address', attrs, indent, content)

    # ------------------------------------------------------------------

    # Horizontal Rule

    # ------------------------------------------------------------------

    def tag_hr(self, attrs, indent):

        """Returns horizontal rule.

            %attrs;

            >

        """

        return self.tag('hr', attrs, indent)

    # ------------------------------------------------------------------

    # Preformatted text

    # ------------------------------------------------------------------

    def tag_pre(self, attrs, indent, content):

        """Returns preformatted text.

            %attrs;

            xml:space (preserve) #FIXED 'preserve'

            >

        content is %Inline; excluding "img|object|big|small|sub|sup"

        """

        return self.tag('pre', attrs, indent, content)

    # ------------------------------------------------------------------

    # Block-line Quotes

    # ------------------------------------------------------------------

    def tag_blockquote(self, attrs, indent, content):

        """Returns block-line quote.

            %attrs;

            cite        %URI;          #IMPLIED

            >

        """

        return self.tag('blockquote', attrs, indent, content)

    # ------------------------------------------------------------------

    # Inserted/Deleted Text

    # ------------------------------------------------------------------

    def tag_ins(self, attrs, indent, content):

        """Returns inserted text.

            %attrs;

            cite        %URI;          #IMPLIED

            datetime    %Datetime;     #IMPLIED

            >

        Inserted texts are allowed in block and inline content, but

        its inappropriate to include block content within an ins

        element occurring in inline content.

        """

        return self.tag('ins', attrs, indent, content)

    def tag_del(self, attrs, indent, content):

        """Returns deleted text.

            %attrs;

            cite        %URI;          #IMPLIED

            datetime    %Datetime;     #IMPLIED

            >

        Deleted texts are allowed in block and inline content, but its

        inappropriate to include block content within an ins element

        occurring in inline content.

        """

        return self.tag('ins', attrs, indent, content)

    # ------------------------------------------------------------------

    # The Anchor Element

    # ------------------------------------------------------------------

    def tag_a(self, attrs, indent, content='', has_child=0):

        """Returns the anchor element.

            %attrs;

            %focus;

            charset     %Charset;      #IMPLIED

            type        %ContentType;  #IMPLIED

            name        NMTOKEN        #IMPLIED

            href        %URI;          #IMPLIED

            hreflang    %LanguageCode; #IMPLIED

            rel         %LinkTypes;    #IMPLIED

            rev         %LinkTypes;    #IMPLIED

            shape       %Shape;        "rect"

            coords      %Coords;       #IMPLIED

            >

        content is %Inline; except that anchors shouldn't be nested.

        """

        return self.tag('a', attrs, indent, content, has_child)

    # ------------------------------------------------------------------

    # Inline Elements

    # ------------------------------------------------------------------

    def tag_span(self, attrs, indent, content, has_child=0):

        """Returns span definition.

            %attrs;

            >

        """

        return self.tag('span', attrs, indent, content, has_child)

    def tag_dbo(self, attrs, indent, content, has_child=0):

        """Returns dbo definition.

            %coreattrs;

            %events;

            lang        %LanguageCode; #IMPLIED

            xml:lang    %LanguageCode; #IMPLIED

            dir         (ltr|rtl)      #REQUIRED

            >

        """

        return self.tag('dbo', attrs, indent, content, has_child)

    def tag_br(self, attrs, indent):

        """Returns break definition.

            %coreattrs;