<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category  Zend

 * @package   Zend_Text_Figlet

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license   http://framework.zend.com/license/new-bsd     New BSD License

 * @version   $Id: Figlet.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * Zend_Text_Figlet is a PHP implementation of FIGlet

 *

 * @category  Zend

 * @package   Zend_Text_Figlet

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license   http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Text_Figlet

{

    /**

     * Smush2 layout modes

     */

    const SM_EQUAL     = 0x01;

    const SM_LOWLINE   = 0x02;

    const SM_HIERARCHY = 0x04;

    const SM_PAIR      = 0x08;

    const SM_BIGX      = 0x10;

    const SM_HARDBLANK = 0x20;

    const SM_KERN      = 0x40;

    const SM_SMUSH     = 0x80;

    /**

     * Smush mode override modes

     */

    const SMO_NO    = 0;

    const SMO_YES   = 1;

    const SMO_FORCE = 2;

    /**

     * Justifications

     */

    const JUSTIFICATION_LEFT   = 0;

    const JUSTIFICATION_CENTER = 1;

    const JUSTIFICATION_RIGHT  = 2;

    /**

     * Write directions

     */

    const DIRECTION_LEFT_TO_RIGHT = 0;

    const DIRECTION_RIGHT_TO_LEFT = 1;

    /**

     * Magic fontfile number

     */

    const FONTFILE_MAGIC_NUMBER = 'flf2';

    /**

     * Array containing all characters of the current font

     *

     * @var array

     */

    protected $_charList = array();

    /**

     * Indicates if a font was loaded yet

     *

     * @var boolean

     */

    protected $_fontLoaded = false;

    /**

     * Latin-1 codes for German letters, respectively:

     *

     * LATIN CAPITAL LETTER A WITH DIAERESIS = A-umlaut

     * LATIN CAPITAL LETTER O WITH DIAERESIS = O-umlaut

     * LATIN CAPITAL LETTER U WITH DIAERESIS = U-umlaut

     * LATIN SMALL LETTER A WITH DIAERESIS = a-umlaut

     * LATIN SMALL LETTER O WITH DIAERESIS = o-umlaut

     * LATIN SMALL LETTER U WITH DIAERESIS = u-umlaut

     * LATIN SMALL LETTER SHARP S = ess-zed

     *

     * @var array

     */

    protected $_germanChars = array(196, 214, 220, 228, 246, 252, 223);

    /**

     * Output width, defaults to 80.

     *

     * @var integer

     */

    protected $_outputWidth = 80;

    /**

     * Hard blank character

     *

     * @var string

     */

    protected $_hardBlank;

    /**

     * Height of the characters

     *

     * @var integer

     */

    protected $_charHeight;

    /**

     * Max length of any character

     *

     * @var integer

     */

    protected $_maxLength;

    /**

     * Smush mode

     *

     * @var integer

     */

    protected $_smushMode = 0;

    /**

     * Smush defined by the font

     *

     * @var integer

     */

    protected $_fontSmush = 0;

    /**

     * Smush defined by the user

     *

     * @var integer

     */

    protected $_userSmush = 0;

    /**

     * Wether to handle paragraphs || not

     *

     * @var boolean

     */

    protected $_handleParagraphs = false;

    /**

     * Justification for the text, according to $_outputWidth

     *

     * For using font default, this parameter should be null, else one of

     * the values of Zend_Text_Figlet::JUSTIFICATION_*

     *

     * @var integer

     */

    protected $_justification = null;

    /**

     * Direction of text-writing, namely right to left

     *

     * For using font default, this parameter should be null, else one of

     * the values of Zend_Text_Figlet::DIRECTION_*

     *

     * @var integer

     */

    protected $_rightToLeft = null;

    /**

     * Override font file smush layout

     *

     * @var integer

     */

    protected $_smushOverride = 0;

    /**

     * Options of the current font

     *

     * @var array

     */

    protected $_fontOptions = array();

    /**

     * Previous character width

     *

     * @var integer

     */

    protected $_previousCharWidth = 0;

    /**

     * Current character width

     *

     * @var integer

     */

    protected $_currentCharWidth = 0;

    /**

     * Current outline length

     *

     * @var integer

     */

    protected $_outlineLength = 0;

    /**

     * Maxmimum outline length

     *

     * @var integer

     */

    protected $_outlineLengthLimit = 0;

    /**

     * In character line

     *

     * @var string

     */

    protected $_inCharLine;

    /**

     * In character line length

     *

     * @var integer

     */

    protected $_inCharLineLength = 0;

    /**

     * Maximum in character line length

     *

     * @var integer

     */

    protected $_inCharLineLengthLimit = 0;

    /**

     * Current char

     *

     * @var array

     */

    protected $_currentChar = null;

    /**

     * Current output line

     *

     * @var array

     */

    protected $_outputLine;

    /**

     * Current output

     *

     * @var string

     */

    protected $_output;

    /**

     * Option keys to skip when calling setOptions()

     *

     * @var array

     */

    protected $_skipOptions = array(

        'options',

        'config',

    );

    /**

     * Instantiate the FIGlet with a specific font. If no font is given, the

     * standard font is used. You can also supply multiple options via

     * the $options variable, which can either be an array or an instance of

     * Zend_Config.

     *

     * @param array|Zend_Config $options Options for the output

     */

    public function __construct($options = null)

    {

        // Set options

        if (is_array($options)) {

            $this->setOptions($options);

        } else if ($options instanceof Zend_Config) {

            $this->setConfig($options);

        }

        // If no font was defined, load default font

        if (!$this->_fontLoaded) {

            $this->_loadFont(dirname(__FILE__) . '/Figlet/zend-framework.flf');

        }

    }

    /**

     * Set options from array

     *

     * @param  array $options Configuration for Zend_Text_Figlet

     * @return Zend_Text_Figlet

     */

    public function setOptions(array $options)

    {

        foreach ($options as $key => $value) {

            if (in_array(strtolower($key), $this->_skipOptions)) {

                continue;

            }

            $method = 'set' . ucfirst($key);

            if (method_exists($this, $method)) {

                $this->$method($value);

            }

        }

        return $this;

    }

    /**

     * Set options from config object

     *

     * @param  Zend_Config $config Configuration for Zend_Text_Figlet

     * @return Zend_Text_Figlet

     */

    public function setConfig(Zend_Config $config)

    {

        return $this->setOptions($config->toArray());

    }

    /**

     * Set a font to use

     *

     * @param  string $font Path to the font

     * @return Zend_Text_Figlet

     */

    public function setFont($font)

    {

        $this->_loadFont($font);

        return $this;

    }

    /**

     * Set handling of paragraphs

     *

     * @param  boolean $handleParagraphs Wether to handle paragraphs or not

     * @return Zend_Text_Figlet

     */

    public function setHandleParagraphs($handleParagraphs)

    {

        $this->_handleParagraphs = (bool) $handleParagraphs;

        return $this;

    }

    /**

     * Set the justification. 0 stands for left aligned, 1 for centered and 2

     * for right aligned.

     *

     * @param  integer $justification Justification of the output text

     * @return Zend_Text_Figlet

     */

    public function setJustification($justification)

    {

        $this->_justification = min(3, max(0, (int) $justification));

        return $this;

    }

    /**

     * Set the output width

     *

     * @param  integer $outputWidth Output with which should be used for word

     *                              wrapping and justification

     * @return Zend_Text_Figlet

     */

    public function setOutputWidth($outputWidth)

    {

        $this->_outputWidth = max(1, (int) $outputWidth);

        return $this;

    }

    /**

     * Set right to left mode. For writing from left to right, use

     * Zend_Text_Figlet::DIRECTION_LEFT_TO_RIGHT. For writing from right to left,

     * use Zend_Text_Figlet::DIRECTION_RIGHT_TO_LEFT.

     *

     * @param  integer $rightToLeft Right-to-left mode

     * @return Zend_Text_Figlet

     */

    public function setRightToLeft($rightToLeft)

    {

        $this->_rightToLeft = min(1, max(0, (int) $rightToLeft));

        return $this;

    }

    /**

     * Set the smush mode.

     *

     * Use one of the constants of Zend_Text_Figlet::SM_*, you may combine them.

     *

     * @param  integer $smushMode Smush mode to use for generating text

     * @return Zend_Text_Figlet

     */

    public function setSmushMode($smushMode)

    {

        $smushMode = (int) $smushMode;

        if ($smushMode < -1) {

            $this->_smushOverride = self::SMO_NO;

        } else {

            if ($smushMode === 0) {

                $this->_userSmush = self::SM_KERN;

            } else if ($smushMode === -1) {

                $this->_userSmush = 0;

            } else {

                $this->_userSmush = (($smushMode & 63) | self::SM_SMUSH);

            }

            $this->_smushOverride = self::SMO_YES;

        }

        $this->_setUsedSmush();

        return $this;

    }

    /**

     * Render a FIGlet text

     *

     * @param  string $text     Text to convert to a figlet text

     * @param  string $encoding Encoding of the input string

     * @throws InvalidArgumentException When $text is not a string

     * @throws Zend_Text_Figlet_Exception    When $text it not properly encoded

     * @return string

     */

    public function render($text, $encoding = 'UTF-8')

    {

        if (!is_string($text)) {

            throw new InvalidArgumentException('$text must be a string');

        }

        if ($encoding !== 'UTF-8') {

            $text = iconv($encoding, 'UTF-8', $text);

        }

        $this->_output     = '';

        $this->_outputLine = array();

        $this->_clearLine();

        $this->_outlineLengthLimit    = ($this->_outputWidth - 1);

        $this->_inCharLineLengthLimit = ($this->_outputWidth * 4 + 100);

        $wordBreakMode  = 0;

        $lastCharWasEol = false;

        $textLength     = @iconv_strlen($text, 'UTF-8');

        if ($textLength === false) {

            require_once 'Zend/Text/Figlet/Exception.php';

            throw new Zend_Text_Figlet_Exception('$text is not encoded with ' . $encoding);

        }

        for ($charNum = 0; $charNum < $textLength; $charNum++) {

            // Handle paragraphs

            $char = iconv_substr($text, $charNum, 1, 'UTF-8');

            if ($char === "\n" && $this->_handleParagraphs && !$lastCharWasEol) {

                $nextChar = iconv_substr($text, ($charNum + 1), 1, 'UTF-8');

                if (!$nextChar) {