tools::X11::base_session Class Reference

Inheritance diagram for tools::X11::base_session:

Public Member Functions
	base_session (std::ostream &a_out, unsigned int a_monitor=0)
virtual	~base_session ()
std::ostream &	out () const
Atom	WM_DELETE_WINDOW_atom () const
Atom	SESSION_EXIT_STEER_atom () const
bool	is_valid () const
Display *	display () const
bool	steer ()
bool	sync ()
bool	event_pending (bool &a_is)
bool	next_event (bool &a_to_exit)
bool	flush ()
Window	create_window (const char *a_title, int a_x, int a_y, unsigned int a_width, unsigned int a_height)
void	map_raise_window (Window a_window) const
void	show_window (Window a_window) const
void	hide_window (Window a_window) const
void	resize_window (Window a_window, unsigned int a_width, unsigned int a_height) const
bool	window_size (Window a_window, int &a_width, int &a_height) const
void	delete_window (Window a_window) const
void	set_override_redirect (Window a_window) const
void	set_wm_no_decorations (Window a_window) const
bool	post (Window a_win, long a_0=0, long a_1=0, long a_2=0, long a_3=0, long a_4=0) const
bool	post_EXIT_STEER (Window a_win)
void	add_dispatcher (dispatcher *a_dispatcher)
void	invalidate_dispatchers_with_window (Window a_win)
void	remove_dispatchers_with_window (Window a_win)
bool	dispatch (XEvent &a_event)

Protected Member Functions
	base_session (const base_session &a_from)
base_session &	operator= (const base_session &a_from)
void	clear_dispatchers ()

Static Protected Member Functions
static Bool	wait_map_notify (Display *, XEvent *a_event, char *a_arg)
static Bool	wait_unmap_notify (Display *, XEvent *a_event, char *a_arg)

Protected Attributes
std::ostream &	m_out
unsigned int	m_monitor
Display *	m_display
Atom	m_WM_DELETE_WINDOW_atom
Atom	m_SESSION_EXIT_STEER_atom
std::vector< dispatcher * >	m_dispatchers

Detailed Description

Definition at line 22 of file base_session.

Constructor & Destructor Documentation

base_session() [1/2]

tools::X11::base_session::base_session ( std::ostream &  a_out, unsigned int  a_monitor = 0  )

inline

Definition at line 33 of file base_session.

  :m_out(a_out)
  ,m_monitor(a_monitor)
  ,m_display(0)
  ,m_WM_DELETE_WINDOW_atom(None)
  ,m_SESSION_EXIT_STEER_atom(None)
  {
    //NOTE : macOS : XOpenDisplay leaks 128 bytes.
    m_display = ::XOpenDisplay(NULL);
    if(!m_display) {
      m_out << "tools::X11::base_session::base_session : can't open display." << std::endl;
      return;
    }
 
    int monitors = ::XScreenCount(m_display);
    if(int(m_monitor)>=monitors) {
      m_out << "tools::X11::base_session::base_session : bad monitor index "
            << m_monitor << ". (#monitors " << monitors << ")." << std::endl;
      ::XCloseDisplay(m_display);
      m_display = 0;
      return;
    }
 
    m_WM_DELETE_WINDOW_atom = ::XInternAtom(m_display,"WM_DELETE_WINDOW",False);
    if(m_WM_DELETE_WINDOW_atom==None) {
      m_out << "tools::X11::base_session::base_session : can't create WM_DELETE_WINDOW Atom." << std::endl;
      ::XCloseDisplay(m_display);
      m_display = 0;
      return;
    }
 
    m_SESSION_EXIT_STEER_atom = ::XInternAtom(m_display,"TOOLS_X11_SESSION_EXIT_STEER",False);
    if(m_SESSION_EXIT_STEER_atom==None) {
      m_out << "tools::X11::base_session::base_session :"
            << " can't create TOOLS_X11_SESSION_EXIT_STEER Atom." << std::endl;
      ::XCloseDisplay(m_display);
      m_display = 0;
      return;
    }
  }

~base_session()

virtual tools::X11::base_session::~base_session ( )

inlinevirtual

Definition at line 73 of file base_session.

                          {
    clear_dispatchers();
    if(m_display) ::XCloseDisplay(m_display);
    m_display = 0;
    //std::cout << "debug : ~base_session" << std::endl;
  }

base_session() [2/2]

tools::X11::base_session::base_session ( const base_session &  a_from )

inlineprotected

Definition at line 80 of file base_session.

  :m_out(a_from.m_out)
  ,m_monitor(a_from.m_monitor)
  ,m_display(0)
  ,m_WM_DELETE_WINDOW_atom(None)
  ,m_SESSION_EXIT_STEER_atom(None)
  {}

Member Function Documentation

add_dispatcher()

void tools::X11::base_session::add_dispatcher ( dispatcher *  a_dispatcher )

inline

Definition at line 313 of file base_session.

                                                {
    m_dispatchers.push_back(a_dispatcher); //take ownership.
  }

clear_dispatchers()

void tools::X11::base_session::clear_dispatchers ( )

inlineprotected

Definition at line 382 of file base_session.

                           {
    tools_vforit_npp(dispatcher*,m_dispatchers,it) {
      dispatcher* obj = *it;
      it = m_dispatchers.erase(it);
      delete obj;
    }
    m_dispatchers.clear();
  }

create_window()

Window tools::X11::base_session::create_window ( const char *  a_title, int  a_x, int  a_y, unsigned int  a_width, unsigned int  a_height  )

inline

Definition at line 166 of file base_session.

                                                                                                       {
    if(!m_display) return 0L;
 
    XSetWindowAttributes swa;
    swa.event_mask = StructureNotifyMask | ExposureMask
       | ButtonPressMask | ButtonReleaseMask | ButtonMotionMask
       | PointerMotionMask
       | KeyPressMask;
 
    swa.background_pixel = ::XWhitePixel(m_display,m_monitor);
 
    Window window = ::XCreateWindow(m_display,
                                    ::XRootWindow(m_display,m_monitor),
                                    a_x,a_y,a_width,a_height,
                    0,
                                    (int)CopyFromParent,
                                    InputOutput,
                                    (Visual*)CopyFromParent,
                    CWEventMask|CWBackPixel,&swa);
    if(window==0L) {
      m_out << "tools::X11::base_session::create_window : can't create a X11 window." << std::endl;
      return 0L;
    }
 
    XTextProperty tp;
    ::XStringListToTextProperty((char**)&a_title,1,&tp);
    XSizeHints sh;
    sh.flags = USPosition | USSize;
    ::XSetWMProperties(m_display,window,&tp,&tp,0,0,&sh,0,0);
    ::XFree(tp.value);
 
    ::XSetWMProtocols(m_display,window,&m_WM_DELETE_WINDOW_atom,1);
    return window;
  }

delete_window()

void tools::X11::base_session::delete_window ( Window  a_window ) const

inline

Definition at line 242 of file base_session.

                                            {
    if(!m_display) return;
    ::XDestroyWindow(m_display,a_window);
  }

dispatch()

bool tools::X11::base_session::dispatch ( XEvent &  a_event )

inline

Definition at line 335 of file base_session.

                                 {
   {tools_vforit_npp(dispatcher*,m_dispatchers,it) {
      if(!(*it)->is_valid()) {
        dispatcher* obj = *it;
        it = m_dispatchers.erase(it);
        delete obj;
      } else {
        it++;
      }
    }}
    tools_vforit(dispatcher*,m_dispatchers,it) {
      if((*it)->is_valid()) {
        if((*it)->dispatch(a_event)) return true;
      }
    }
    return false;
  }

display()

Display* tools::X11::base_session::display ( ) const

inline

Definition at line 99 of file base_session.

{return m_display;}

event_pending()

bool tools::X11::base_session::event_pending ( bool &  a_is )

inline

Definition at line 135 of file base_session.

                                 {
    if(!m_display) {a_is = false;return false;}
    a_is = ::XPending(m_display)?true:false;
    return true;
  }

flush()

bool tools::X11::base_session::flush ( )

inline

Definition at line 156 of file base_session.

               {
    if(!m_display) return false;
    ::XFlush(m_display);
    return true;
  }

hide_window()

void tools::X11::base_session::hide_window ( Window  a_window ) const

inline

Definition at line 216 of file base_session.

                                          {
    if(!m_display) return;
    ::XUnmapWindow(m_display,a_window);
   {XEvent event;
    ::XIfEvent(m_display,&event,wait_unmap_notify,(char*)a_window);}
  }

invalidate_dispatchers_with_window()

void tools::X11::base_session::invalidate_dispatchers_with_window ( Window  a_win )

inline

Definition at line 317 of file base_session.

                                                       {
    tools_vforit(dispatcher*,m_dispatchers,it) {
      if((*it)->window()==a_win) (*it)->invalidate();
    }
  }

is_valid()

bool tools::X11::base_session::is_valid ( ) const

inline

Definition at line 97 of file base_session.

{return m_display?true:false;}

map_raise_window()

void tools::X11::base_session::map_raise_window ( Window  a_window ) const

inline

Definition at line 201 of file base_session.

                                               {
    if(!m_display) return;
    ::XMapWindow(m_display,a_window);
    ::XRaiseWindow(m_display,a_window);
  }

next_event()

bool tools::X11::base_session::next_event ( bool &  a_to_exit )

inline

Definition at line 141 of file base_session.

                                   {
    if(!m_display) {a_to_exit = false;return false;}
    XEvent xevent;
    ::XNextEvent(m_display,&xevent);
    if(xevent.type==ClientMessage) {
      if(xevent.xclient.data.l[0]==(long)m_SESSION_EXIT_STEER_atom) {
        a_to_exit = true;
        return true;
      }
    }
    dispatch(xevent);
    a_to_exit = false;
    return true;
  }

operator=()

base_session& tools::X11::base_session::operator= ( const base_session &  a_from )

inlineprotected

Definition at line 87 of file base_session.

                                                     {
    if(&a_from==this) return *this;
    return *this;
  }

out()

std::ostream& tools::X11::base_session::out ( ) const

inline

Definition at line 92 of file base_session.

{return m_out;}

post()

bool tools::X11::base_session::post ( Window  a_win, long  a_0 = 0, long  a_1 = 0, long  a_2 = 0, long  a_3 = 0, long  a_4 = 0  ) const

inline

Definition at line 283 of file base_session.

                                {
    if(!m_display) return false;
    XEvent event;
    event.type = ClientMessage;
    event.xclient.display = m_display;
    event.xclient.window = a_win;
    event.xclient.message_type = XA_INTEGER;
    event.xclient.format = 8;    /* put 8 because bug with 32 on VMCMS */
    event.xclient.data.l[0] = a_0;
    event.xclient.data.l[1] = a_1;
    event.xclient.data.l[2] = a_2;
    event.xclient.data.l[3] = a_3;
    event.xclient.data.l[4] = a_4;
    //lock();
    Status stat = ::XSendEvent(m_display,a_win,False,0L,&event);
    ::XFlush(m_display);
    //unlock();
    return (stat==0?false:true);
  }

post_EXIT_STEER()

bool tools::X11::base_session::post_EXIT_STEER ( Window  a_win )

inline

Definition at line 306 of file base_session.

                                     {
    return post(a_win,SESSION_EXIT_STEER_atom());
  }

remove_dispatchers_with_window()

void tools::X11::base_session::remove_dispatchers_with_window ( Window  a_win )

inline

Definition at line 323 of file base_session.

                                                   {
    tools_vforit_npp(dispatcher*,m_dispatchers,it) {
      if((*it)->window()==a_win) {
        dispatcher* obj = *it;
        it = m_dispatchers.erase(it);
        delete obj;
      } else {
        it++;
      }
    }
  }

resize_window()

void tools::X11::base_session::resize_window ( Window  a_window, unsigned int  a_width, unsigned int  a_height  ) const

inline

Definition at line 223 of file base_session.

                                                                                       {
    if(!m_display) return;
    unsigned int mask = CWWidth | CWHeight | CWBorderWidth;
    XWindowChanges changes;
    changes.border_width = 0;
    changes.width = a_width;
    changes.height = a_height;
    ::XConfigureWindow(m_display,a_window,mask,&changes);
  }

SESSION_EXIT_STEER_atom()

Atom tools::X11::base_session::SESSION_EXIT_STEER_atom ( ) const

inline

Definition at line 95 of file base_session.

{return m_SESSION_EXIT_STEER_atom;}

set_override_redirect()

void tools::X11::base_session::set_override_redirect ( Window  a_window ) const

inline

Definition at line 247 of file base_session.

                                                    {
    //must be executed before window is mapped.
    if(!m_display) return;
    XSetWindowAttributes swa;
    swa.override_redirect = True;
    ::XChangeWindowAttributes(m_display,a_window,CWOverrideRedirect,&swa);
  }

set_wm_no_decorations()

void tools::X11::base_session::set_wm_no_decorations ( Window  a_window ) const

inline

Definition at line 255 of file base_session.

                                                    {
    //must be executed before window is mapped.
    if(!m_display) return;
 
    // struct, mwm_hints_decorations taken from OpenMotif MwmUtils.h.
    struct{
      unsigned long flags;
      unsigned long functions;
      unsigned long decorations;
      long          inputMode;
      unsigned long status;
    } prop;
 
    //unsigned long mwm_hints_functions = 1L << 0;
    unsigned long mwm_hints_decorations  = 1L << 1;
 
    Atom atom = ::XInternAtom(m_display,"_MOTIF_WM_HINTS",False);
    if(atom==None) {
      m_out << "tools::X11::base_session::set_wm_no_decorations : can't create/get _MOTIF_WM_HINTS Atom." << std::endl;
      return;
    }
    prop.flags = mwm_hints_decorations;
    prop.functions = 0;
    prop.decorations = 0;
 
    ::XChangeProperty(m_display,a_window,atom,atom,32,PropModeReplace,(unsigned char*)&prop,5);
  }

show_window()

void tools::X11::base_session::show_window ( Window  a_window ) const

inline

Definition at line 207 of file base_session.

                                          {
    if(!m_display) return;
    // we should test if already mapped ! Else we are going to forever wait in the below XIfEvent.
    ::XMapWindow(m_display,a_window);
    ::XRaiseWindow(m_display,a_window);
   {XEvent event;
    ::XIfEvent(m_display,&event,wait_map_notify,(char*)a_window);}
  }

steer()

bool tools::X11::base_session::steer ( )

inline

Definition at line 101 of file base_session.

               {
    if(!m_display) return false;
 
    while(true) {
      XEvent xevent;
      ::XNextEvent(m_display,&xevent);
      if(xevent.type==ClientMessage) {
        if(xevent.xclient.data.l[0]==(long)m_SESSION_EXIT_STEER_atom) break;
      }
      dispatch(xevent);
    }
 
    return true;
  }

sync()

bool tools::X11::base_session::sync ( )

inline

Definition at line 116 of file base_session.

              {
    if(!m_display) return false;
  //::glXWaitX();
    ::XSync(m_display,False);
    while(true) {
      XEvent xevent;
      if(::XPending(m_display)) {
        ::XNextEvent(m_display,&xevent);
        if(xevent.type==ClientMessage) {
          if(xevent.xclient.data.l[0]==(long)m_SESSION_EXIT_STEER_atom) return false;
        }
        dispatch(xevent);
      } else {
        break;
      }
    }
    return true;
  }

wait_map_notify()

static Bool tools::X11::base_session::wait_map_notify ( Display *  , XEvent *  a_event, char *  a_arg  )

inlinestaticprotected

Definition at line 353 of file base_session.

                                                                   {
    return (a_event->type == MapNotify) && (a_event->xmap.window == (Window)a_arg);
  }

wait_unmap_notify()

static Bool tools::X11::base_session::wait_unmap_notify ( Display *  , XEvent *  a_event, char *  a_arg  )

inlinestaticprotected

Definition at line 356 of file base_session.

                                                                     {
    return (a_event->type == UnmapNotify) && (a_event->xmap.window == (Window)a_arg);
  }

window_size()

bool tools::X11::base_session::window_size ( Window  a_window, int &  a_width, int &  a_height  ) const

inline

Definition at line 233 of file base_session.

                                                                     {
    if(!m_display) {a_width = 0;a_height = 0;return false;}
    XWindowAttributes watbs;
    if(!XGetWindowAttributes(m_display,a_window,&watbs)) {a_width = 0;a_height = 0;return false;}
    a_width  = watbs.width;
    a_height = watbs.height;
    return true;
  }

WM_DELETE_WINDOW_atom()

Atom tools::X11::base_session::WM_DELETE_WINDOW_atom ( ) const

inline

Definition at line 94 of file base_session.

{return m_WM_DELETE_WINDOW_atom;}

Member Data Documentation

m_dispatchers

std::vector<dispatcher*> tools::X11::base_session::m_dispatchers

protected

Definition at line 397 of file base_session.

m_display

Display* tools::X11::base_session::m_display

protected

Definition at line 394 of file base_session.

m_monitor

unsigned int tools::X11::base_session::m_monitor

protected

Definition at line 393 of file base_session.

m_out

std::ostream& tools::X11::base_session::m_out

protected

Definition at line 392 of file base_session.

m_SESSION_EXIT_STEER_atom

Atom tools::X11::base_session::m_SESSION_EXIT_STEER_atom

protected

Definition at line 396 of file base_session.

m_WM_DELETE_WINDOW_atom

Atom tools::X11::base_session::m_WM_DELETE_WINDOW_atom

protected

Definition at line 395 of file base_session.

---

The documentation for this class was generated from the following file:

• /Users/barrand/private/dev/softinex/g4tools/g4tools/tools/X11/base_session