/Window.php

<?php

/**
 * Hoa
 *
 *
 * @license
 *
 * New BSD License
 *
 * Copyright © 2007-2013, Ivan Enderlin. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Hoa nor the names of its contributors may be
 *       used to endorse or promote products derived from this software without
 *       specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

namespace {

from('Hoa')

/**
 * \Hoa\Console
 */
-> import('Console.~')

/**
 * \Hoa\Console\Processus
 */
-> import('Console.Processus');

}

namespace Hoa\Console {

/**
 * Class \Hoa\Console\Window.
 *
 * Allow to manipulate the window.
 *
 * We can listen the event channel hoa://Event/Console/Window:resize to detect
 * if the window has been resized. Please, see the constructor documentation to
 * get more informations.
 *
 * Please, see C0 and C1 control codes.
 *
 * @author     Ivan Enderlin <ivan.enderlin@hoa-project.net>
 * @copyright  Copyright © 2007-2013 Ivan Enderlin.
 * @license    New BSD License
 */

class Window implements \Hoa\Core\Event\Source {

    /**
     * Singleton (only for events).
     *
     * @var \Hoa\Console\Window object
     */
    private static $_instance = null;



    /**
     * Set the event channel.
     * We need to declare(ticks = 1) in the main script to ensure that the event
     * is fired. Also, we need the pcntl_signal() function enabled.
     *
     * @access  public
     * @return  void
     */
    public function __construct ( ) {

        \Hoa\Core\Event::register(
            'hoa://Event/Console/Window:resize',
            $this
        );

        return;
    }

    /**
     * Singleton.
     *
     * @access  public
     * @return  \Hoa\Console\Window
     */
    public static function getInstance ( ) {

        if(null === static::$_instance)
            static::$_instance = new static();

        return static::$_instance;
    }

    /**
     * Set size to X lines and Y columns.
     *
     * @access  public
     * @param   int  $x    X coordinate.
     * @param   int  $y    Y coordinate.
     * @return  void
     */
    public static function setSize ( $x, $y ) {

        if(OS_WIN)
            return;

        // DECSLPP.
        echo "\033[8;" . $y . ";" . $x . "t";

        return;
    }

    /**
     * Get current size (x and y) of the window.
     *
     * @access  public
     * @return  array
     */
    public static function getSize ( ) {

        if(OS_WIN) {

            $modecon = explode("\n", ltrim(Processus::execute('mode con')));

            $_y      = trim($modecon[2]);
            preg_match('#[^:]+:\s*([0-9]+)#', $_y, $matches);
            $y       = (int) $matches[1];

            $_x      = trim($modecon[3]);
            preg_match('#[^:]+:\s*([0-9]+)#', $_x, $matches);
            $x       = (int) $matches[1];

            return array(
                'x' => $x,
                'y' => $y
            );
        }

        // DECSLPP.
        echo "\033[18t";

        // Read \033[8;y;xt.
        fread(STDIN, 4); // skip \033, [, 8 and ;.

        $x      = null;
        $y      = null;
        $handle = &$y;

        do {

            $char = fread(STDIN, 1);

            switch($char) {

                case ';':
                    $handle = &$x;
                  break;

                case 't':
                    break 2;

                default:
                    $handle .= $char;
            }

        } while(true);

        return array(
            'x' => (int) $x,
            'y' => (int) $y
        );
    }

    /**
     * Move to X and Y (in pixels).
     *
     * @access  public
     * @param   int  $x    X coordinate.
     * @param   int  $y    Y coordinate.
     * @return  void
     */
    public static function moveTo ( $x, $y ) {

        if(OS_WIN)
            return;

        // DECSLPP.
        echo "\033[3;" . $y . ";" . $x . "t";

        return;
    }

    /**
     * Get current position (x and y) of the window (in pixels).
     *
     * @access  public
     * @return  array
     */
    public static function getPosition ( ) {

        if(OS_WIN)
            return;

        // DECSLPP.
        echo "\033[13t";

        // Read \033[3;x;yt.
        fread(STDIN, 4); // skip \033, [, 3 and ;.

        $x      = null;
        $y      = null;
        $handle = &$x;

        do {

            $char = fread(STDIN, 1);

            switch($char) {

                case ';':
                    $handle = &$y;
                  break;

                case 't':
                    break 2;

                default:
                    $handle .= $char;
            }

        } while(true);

        return array(
            'x' => (int) $x,
            'y' => (int) $y
        );
    }

    /**
     * Scroll whole page.
     * Directions can be:
     *     • u, up,    ↑ : scroll whole page up;
     *     • d, down,  ↓ : scroll whole page down.
     * Directions can be concatenated by a single space.
     *
     * @access  public
     * @param   string  $directions    Directions.
     * @param   int     $repeat        How many times do we scroll?
     * @reutrn  void
     */
    public static function scroll ( $directions, $repeat = 1 ) {

        if(OS_WIN)
            return;

        if(1 > $repeat)
            return;
        elseif(1 === $repeat)
            $handle = explode(' ', $directions);
        else
            $handle = explode(' ', $directions, 1);

        $count = array('up' => 0, 'down' => 0);

        foreach($handle as $direction)
            switch($direction) {

                case 'u':
                case 'up':
                case '↑':
                    ++$count['up'];
                  break;

                case 'd':
                case 'down':
                case '↓':
                    ++$count['down'];
                  break;
            }

        if(0 < $count['up']) {

            // SU.
            $up = $count['up'] * $repeat;
            echo "\033[" . $up . "S";
        }

        if(0 < $count['down']) {

            // SD.
            $down = $count['down'] * $repeat;
            echo "\033[" . $down . "T";
        }

        return;
    }

    /**
     * Minimize the window.
     *
     * @access  public
     * @return  void
     */
    public static function minimize ( ) {

        if(OS_WIN)
            return;

        // DECSLPP.
        echo "\033[2t";

        return;
    }

    /**
     * Set title.
     *
     * @access  public
     * @param   string  $title    Title.
     * @return  void
     */
    public static function setTitle ( $title ) {

        if(OS_WIN)
            return;

        // DECSLPP.
        echo "\033]0;" . $title . "\033\\";

        return;
    }

    /**
     * Get title.
     *
     * @access  public
     * @return  string
     */
    public static function getTitle ( ) {

        if(OS_WIN)
            return;

        // DECSLPP.
        echo "\033[21t";

        // Read \033]l<title>\033\
        fread(STDIN, 3); // skip \033, ] and l.
        $out = null;

        do {

            $char = fread(STDIN, 1);

            if("\033" === $char) {

                $chaar = fread(STDIN, 1);

                if('\\' === $chaar)
                    break;

                $char .= $chaar;
            }

            $out .= $char;

        } while(true);

        return $out;
    }

    /**
     * Get label.
     *
     * @access  public
     * @return  string
     */
    public static function getLabel ( ) {

        if(OS_WIN)
            return;

        // DECSLPP.
        echo "\033[20t";

        // Read \033]L<label>\033\
        fread(STDIN, 3); // skip \033, ] and L.
        $out = null;

        do {

            $char = fread(STDIN, 1);

            if("\033" === $char) {

                $chaar = fread(STDIN, 1);

                if('\\' === $chaar)
                    break;

                $char .= $chaar;
            }

            $out .= $char;

        } while(true);

        return $out;
    }

    /**
     * Refresh the window.
     *
     * @access  public
     * @return  void
     */
    public static function refresh ( ) {

        if(OS_WIN)
            return;

        // DECSLPP.
        echo "\033[7t";

        return;
    }

    /**
     * Set clipboard value.
     *
     * @access  public
     * @param   string  $data    Data to copy.
     * @return  void
     */
    public static function copy ( $data ) {

        if(OS_WIN)
            return;

        echo "\033]52;;" . base64_encode($data) . "\033\\";

        return;
    }
}

}

namespace {

/**
 * Advanced interaction.
 */
\Hoa\Console::advancedInteraction();

/**
 * Event.
 */
if(ƒ('pcntl_signal')) {

    \Hoa\Console\Window::getInstance();
    pcntl_signal(SIGWINCH, function ( ) {

        static $_window = null;

        if(null === $_window)
            $_window = \Hoa\Console\Window::getInstance();

        \Hoa\Core\Event::notify(
            'hoa://Event/Console/Window:resize',
            $_window,
            new \Hoa\Core\Event\Bucket(array(
                'size' => \Hoa\Console\Window::getSize()
            ))
        );
    });
}

}