Document/src/converters/element_visitor/docbook/odt/text_processor.php

<?php
/**
 * File containing the ezcDocumentOdtTextProcessor class.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 * @package Document
 * @version //autogen//
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @access private
 */

/**
 * Processes text nodes with significant whitespaces.
 *
 * An instance of this class is used to process DOMText nodes with significant 
 * whitespaces (such as literallayout).
 *
 * @package Document
 * @access private
 * @version //autogen//
 */
class ezcDocumentOdtTextProcessor
{
    /**
     * Checks if whitespaces need additional processing and returns the 
     * corresponding DOMText for the ODT.
     *
     * This method checks if the given $textNode is descendant of a 
     * <literallayout /> tag. In this case, whitespaces are processed according 
     * to the ODT specs:
     *
     * - More than 2 simple spaces are replaced by a single space and <text:s 
     *   /> with the text:c attribute set to the number of spaces - 1.
     * - One or more tabs / line breaks are replaced by a <text:tab/> / 
     *   <text:line-break/> tag, with the text:c attribute set to the number of 
     *   whitespaces replaced.
     * 
     * @param DOMText $textNode 
     * @param DOMElement $newRoot 
     * @return array(DOMNode)
     */
    public function processText( DOMText $textNode, DOMElement $newRoot )
    {
        $parent = $this->getParent( $textNode );

        if ( strpos( $parent->getLocationId(), '/literallayout' ) === false )
        {
            return array( new DOMText( $textNode->data ) );
        }
        return $this->processSpaces( $textNode, $newRoot );
    }

    /**
     * Processes whitespaces in $textNode and returns a fragment for the ODT.
     *
     * Processes whitespaces in $textNode according to the rules described at 
     * {@link processText()}. Returns a new DOMDocumentFragment, containing the 
     * processed nodes.
     * 
     * @param DOMText $textNode 
     * @param DOMElement $newRoot 
     * @return array(DOMNode)
     */
    protected function processSpaces( DOMText $textNode, DOMElement $newRoot )
    {
        $res = array();

        // Match more than 2 spaces and tabs and line breaks
        preg_match_all(
            '((?: ){2,}|\\t+|\\n+)',
            $textNode->data,
            $matches,
            PREG_OFFSET_CAPTURE
        );

        $startOffset = 0;
        foreach ( $matches[0] as $match )
        {
            $matchType   = $this->getMatchType( $match[0] );
            $matchLength = iconv_strlen( $match[0] );

            // Append text prepending the current match
            $res[] = new DOMText(
                iconv_substr(
                    $textNode->data,
                    $startOffset,
                    $match[1] - $startOffset
                )
                // Append 1 normal space, if spaces matched (ODT specs)
                . ( $matchType === 's' ? ' ' : '' )
            );

            $res = array_merge(
                $res,
                $this->repeatSpace( $matchType, $matchLength, $newRoot )
            );

            $startOffset = $match[1] + $matchLength;
        }
        // Append rest of the text after the last match
        if ( $startOffset < iconv_strlen( $textNode->data ) )
        {
            $res[] = new DOMText(
                iconv_substr( $textNode->data, $startOffset )
            );
        }

        return $res;
    }

    /**
     * Generates whitespace elements.
     *
     * Retruns an array of DOMElement objects, representing $length number of 
     * whitespaces of type $spaceType.
     * 
     * @param string $spaceType 
     * @param int $length 
     * @param DOMElement $root 
     * @return array(DOMNode)
     */
    protected function repeatSpace( $spaceType, $length, DOMElement $root )
    {
        $spaces = array();
        if ( $spaceType === 's' )
        {
            // Simple spaces use the count attribute
            $spaceElement = $root->ownerDocument->createElementNS(
                ezcDocumentOdt::NS_ODT_TEXT,
                "text:{$spaceType}"
            );
            $spaceElement->setAttributeNS(
                ezcDocumentOdt::NS_ODT_TEXT,
                'text:c',
                // For normal spaces, a single one is kept in tact (ODT specs)
                $length - 1
            );
            $spaces[] = $spaceElement;
        }
        else
        {
            // Tabs and new-lines are simply repeated
            for ( $i = 0; $i < $length; ++$i )
            {
                $spaces[] = $root->ownerDocument->createElementNS(
                    ezcDocumentOdt::NS_ODT_TEXT,
                    "text:{$spaceType}"
                );
            }
        }
        return $spaces;
    }

    /**
     * Returns what type of whitespace was matched.
     *
     * Returns a string indicating what type of whitespaces has been matched. 
     * This string is also the name of the text:* tag used to reflect the 
     * whitespace in ODT:
     *
     * - 's' for spaces
     * - 'tab' for tabs
     * - 'line-break' for line breaks
     * 
     * @param string $string 
     * @return string
     */
    protected function getMatchType( $string )
    {
        switch ( iconv_substr( $string, 0, 1 ) )
        {
            case ' ':
                return 's';
            case "\t":
                return 'tab';
            case "\n":
                return 'line-break';
        }
    }

    /**
     * Returns the ancestor DOMElement for $node.
     *
     * Returns the next ancestor DOMElement for $node.
     * 
     * @param DOMNode $node 
     * @return DOMElement
     */
    protected function getParent( DOMNode $node )
    {
        if ( $node->parentNode->nodeType === XML_ELEMENT_NODE )
        {
            return $node->parentNode;
        }
        return $this->getParent( $node );
    }
}

?>