ncursesp.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. This library
  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 Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

   File:       ncursesp.h

   Author:     Michael Andres <ma@suse.de>

/-*/

#ifndef _NCURSESP_H
#define _NCURSESP_H

#include <iosfwd>

#include "ncursesw.h"
#include <ncursesw/panel.h>

class NCursesPanel : public NCursesWindow
{
    friend std::ostream & operator<<( std::ostream & Stream, const NCursesPanel & Obj_Cv );
    friend std::ostream & operator<<( std::ostream & Stream, const NCursesPanel * Obj_Cv );

    friend class NCDialog;

protected:

    PANEL *p;
    static NCursesPanel *dummy;

private:
    typedef struct
    {
    void *          m_user;
    const NCursesPanel* m_back;
    const PANEL*        m_owner;
    } UserHook;

    void init();

protected:
    void set_user( void *user )
    {
    UserHook* uptr = ( UserHook* )::panel_userptr( p );
    assert( uptr && uptr->m_back == this && uptr->m_owner == p );
    uptr->m_user = user;
    }

    void *get_user() const
    {
    UserHook* uptr = ( UserHook* )::panel_userptr( p );
    assert( uptr && uptr->m_back == this && uptr->m_owner == p );
    return uptr->m_user;
    }

    static const NCursesPanel * get_Panel_of( const PANEL & pan )
    {
    UserHook* uptr = ( UserHook* )::panel_userptr( &pan );

    if ( uptr && uptr->m_owner == &pan
         && uptr->m_back && uptr->m_back->p == &pan )
    {
        return uptr->m_back;
    }

    return 0;
    }

    void OnError( int err ) const THROWS( NCursesPanelException )
    {
    if ( err == ERR )
        THROW( new NCursesPanelException( this, err ) );
    }

public:
    NCursesPanel( int lines,
          int cols,
          int begin_y = 0,
          int begin_x = 0 )
    : NCursesWindow( lines, cols, begin_y, begin_x ), p(0)
    {
    init();
    }

    NCursesPanel() : NCursesWindow( ::stdscr ), p(0) { init(); }

    virtual ~NCursesPanel();

    // basic manipulation

    virtual int resize( int lines, int columns )
    {
    ::wresize( w, lines, columns );
    return ::replace_panel( p, w );
    }

    inline void hide()
    {
    // [ma] hiding a hiden one should not abort.
    if ( !hidden() )
    {
        OnError( ::hide_panel( p ) );
    }
    }

    inline void show()
    {
    OnError( ::show_panel( p ) );
    }

    inline void top()
    {
    OnError( ::top_panel( p ) );
    }

    inline void bottom()
    {
    // warning FIX for broken bottom_panel (libpanel)
    // [ma] panel stack is messed up if the last panel is
    // moved to the bottom.
    if ( ::panel_above( 0 ) != p )
    {
        OnError( ::bottom_panel( p ) );
    }
    }

    inline int mvwin( int y, int x )
    {
    OnError( ::move_panel( p, y, x ) );
    return OK;
    }

    inline bool hidden() const
    {
    return ( ::panel_hidden( p ) );
    }

    inline NCursesPanel& above() const
    {
    OnError( ERR );
    return *dummy;
    }

    inline NCursesPanel& below() const
    {
    OnError( ERR );
    return *dummy;
    }

    inline PANEL * PANEL_above() const
    {
    return( p ? ::panel_above( p ) : 0 );
    }

    inline PANEL * PANEL_below() const
    {
    return( p ? ::panel_below( p ) : 0 );
    }

    int transparent( int y, int x );

    // Those two are rewrites of the corresponding virtual members of NCursesWindow

    virtual int refresh();

    virtual int noutrefresh();

    static void redraw();

    // decorations
    virtual void frame( const char* title = NULL,
            const char* btitle = NULL );

    virtual void boldframe( const char* title = NULL,
                const char* btitle = NULL );

    virtual void label( const char* topLabel,
            const char* bottomLabel );

    virtual void centertext( int row, const char* label );
};


template<class T> class NCursesUserPanel : public NCursesPanel
{

public:
    NCursesUserPanel( int lines,
              int cols,
              int begin_y = 0,
              int begin_x = 0,
              const T* p_UserData = ( T* )0 )
    : NCursesPanel( lines, cols, begin_y, begin_x )
    {
    if ( p )
        set_user(( void * )p_UserData );
    };

    NCursesUserPanel( const T* p_UserData = ( T* )0 ) : NCursesPanel()
    {
    if ( p )
        set_user(( void * )p_UserData );
    };

    virtual ~NCursesUserPanel() {};

    T* UserData( void ) const
    {
    return ( T* )get_user();
    };

    virtual void setUserData( const T* p_UserData )
    {
    if ( p )
        set_user(( void * )p_UserData );
    }

    static T* UserDataOf( const PANEL & pan )
    {
    const NCursesUserPanel<T> * p = dynamic_cast<const NCursesUserPanel<T>*>( get_Panel_of( pan ) );

    if ( p )
    {
        return p->UserData();
    }

    return ( T* )0;
    };
};

#endif // _NCURSESP_H