ui_text.h

Go to the documentation of this file.

/*
    Copyright (c) 2006-2018, Alexis Royer, http://alexis.royer.free.fr/CLI

    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 CLI library project 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 OWNER OR
    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.
*/



#ifndef _CLI_UI_TEXT_H_
#define _CLI_UI_TEXT_H_

#include "cli/io_device.h"


CLI_NS_BEGIN(cli)

    CLI_NS_BEGIN(ui)

        // Forward declarations.
        class TextIterator;


        class Text : public OutputDevice
        {
        public:
            explicit Text(
                const unsigned int UI_MaxLines,     
                const unsigned int UI_MaxLineLength 
                );

            virtual ~Text(void);

        private:
            explicit Text(void);
            Text(const Text&);
            Text& operator=(const Text&);

        // cli::OutputDevice interface implementation.
        protected:
            virtual const bool OpenDevice(void);
            virtual const bool CloseDevice(void);
        public:
            // Inherit doxygen comments from cli::OutputDevice interface documentation.
            virtual void PutString(const char* const STR_Out) const;
            // Inherit doxygen comments from cli::OutputDevice interface documentation.
            virtual void Beep(void) const;
            // Inherit doxygen comments from cli::OutputDevice interface documentation.
            virtual void CleanScreen(void) const;
            // Inherit doxygen comments from cli::OutputDevice interface documentation.
            virtual const bool WouldOutput(const OutputDevice& CLI_Device) const;

        public:
            void Begin(
                TextIterator& it                                
                ) const;

            const bool PageUp(
                TextIterator& it                                
                ) const;

            const bool LineUp(
                TextIterator& it                                
                ) const;

            const bool LineDown(
                TextIterator& it,                               
                const OutputDevice* const PCLI_Out              
                ) const;

            const bool PageDown(
                TextIterator& it,                               
                const OutputDevice* const PCLI_Out              
                ) const;

            void End(
                TextIterator& it,                               
                const OutputDevice* const PCLI_Out              
                ) const;

        public:
            void PrintPage(
                TextIterator& it,                               
                const OutputDevice& CLI_Out,                    
                const bool B_FillPageWithBlankLines             
                ) const;

        private:
            void PrintBottomLine(
                TextIterator& it,                               
                const OutputDevice& CLI_Out                     
                ) const;

        private:
            mutable tk::Queue<tk::String> m_tkLines;            
            mutable bool m_bNewLineRequired;                    
            const unsigned int m_uiMaxLineLength;               
        };

        class TextIterator
        {
        private:
            explicit TextIterator(void);

        public:
            explicit TextIterator(
                const OutputDevice::ScreenInfo& CLI_ScreenInfo, 
                const unsigned int UI_PageHeight                
                );

            explicit TextIterator(
                const TextIterator& it                          
                );

            TextIterator& operator=(
                const TextIterator& it                          
                );

        private:
            const OutputDevice::ScreenInfo m_cliScreenInfo; 
            const unsigned int m_uiPageHeight;              

            tk::Queue<tk::String>::Iterator m_tkTopLine;    
            unsigned int m_uiTopChar;                       
            tk::Queue<tk::String>::Iterator m_tkBottomLine; 
            unsigned int m_uiBottomChar;                    
            bool m_bBottomIsUpToDate;                       

            friend class Text;
        };

    CLI_NS_END(ui)

CLI_NS_END(cli)

#endif // _CLI_UI_TEXT_H_