ncurses 5.9 - patch 20121222
[ncurses.git] / panel / panel.c
index c90ad4f558026691e08a51ffe949dfbc89a9d3d6..97bebca9c0694094f46a8c5753729b39582115c7 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998 Free Software Foundation, Inc.                        *
+ * Copyright (c) 1998-2010,2012 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
 /****************************************************************************
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1995                    *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *     and: Juergen Pfeifer                         1996-1999,2008          *
+ *     and: Thomas E. Dickey                                                *
  ****************************************************************************/
 
 /* panel.c -- implementation of panels library, some core routines */
 #include "panel.priv.h"
 
-MODULE_ID("$Id: panel.c,v 1.15 1998/02/11 12:14:01 tom Exp $")
+MODULE_ID("$Id: panel.c,v 1.26 2012/02/23 10:02:15 tom Exp $")
 
+/*+-------------------------------------------------------------------------
+       _nc_retrace_panel (pan)
+--------------------------------------------------------------------------*/
+#ifdef TRACE
+NCURSES_EXPORT(PANEL *)
+_nc_retrace_panel(PANEL * pan)
+{
+  T((T_RETURN("%p"), (void *)pan));
+  return pan;
+}
+#endif
+
+/*+-------------------------------------------------------------------------
+       _nc_my_visbuf(ptr)
+--------------------------------------------------------------------------*/
 #ifdef TRACE
 #ifndef TRACE_TXT
-const char *_nc_my_visbuf(const void *ptr)
+NCURSES_EXPORT(const char *)
+_nc_my_visbuf(const void *ptr)
 {
-       char temp[20];
-       if (ptr != 0)
-               sprintf(temp, "ptr:%p", ptr);
-       else
-               strcpy(temp, "<null>");
-       return _nc_visbuf(temp);
+  char temp[32];
+
+  if (ptr != 0)
+    _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp)) "ptr:%p", ptr);
+  else
+    _nc_STRCPY(temp, "<null>", sizeof(temp));
+  return _nc_visbuf(temp);
 }
 #endif
 #endif
 
-
 /*+-------------------------------------------------------------------------
        dPanel(text,pan)
 --------------------------------------------------------------------------*/
 #ifdef TRACE
-void
-_nc_dPanel(const char *text, const PANEL *pan)
+NCURSES_EXPORT(void)
+_nc_dPanel(const char *text, const PANEL * pan)
 {
-       _tracef("%s id=%s b=%s a=%s y=%d x=%d",
-               text, USER_PTR(pan->user),
-               (pan->below) ?  USER_PTR(pan->below->user) : "--",
-               (pan->above) ?  USER_PTR(pan->above->user) : "--",
-               pan->wstarty, pan->wstartx);
+  _tracef("%s id=%s b=%s a=%s y=%d x=%d",
+         text, USER_PTR(pan->user),
+         (pan->below) ? USER_PTR(pan->below->user) : "--",
+         (pan->above) ? USER_PTR(pan->above->user) : "--",
+         PSTARTY(pan), PSTARTX(pan));
 }
 #endif
 
@@ -70,21 +88,23 @@ _nc_dPanel(const char *text, const PANEL *pan)
        dStack(fmt,num,pan)
 --------------------------------------------------------------------------*/
 #ifdef TRACE
-void
-_nc_dStack(const char *fmt, int num, const PANEL *pan)
+NCURSES_EXPORT(void)
+_nc_dStack(const char *fmt, int num, const PANEL * pan)
 {
   char s80[80];
 
-  sprintf(s80,fmt,num,pan);
-  _tracef("%s b=%s t=%s",s80,
-         (_nc_bottom_panel) ?  USER_PTR(_nc_bottom_panel->user) : "--",
-         (_nc_top_panel)    ?  USER_PTR(_nc_top_panel->user)    : "--");
-  if(pan)
+  GetPanelHook(pan);
+
+  _nc_SPRINTF(s80, _nc_SLIMIT(sizeof(s80)) fmt, num, pan);
+  _tracef("%s b=%s t=%s", s80,
+         (_nc_bottom_panel) ? USER_PTR(_nc_bottom_panel->user) : "--",
+         (_nc_top_panel) ? USER_PTR(_nc_top_panel->user) : "--");
+  if (pan)
     _tracef("pan id=%s", USER_PTR(pan->user));
   pan = _nc_bottom_panel;
-  while(pan)
+  while (pan)
     {
-      dPanel("stk",pan);
+      dPanel("stk", pan);
       pan = pan->above;
     }
 }
@@ -94,10 +114,10 @@ _nc_dStack(const char *fmt, int num, const PANEL *pan)
        Wnoutrefresh(pan) - debugging hook for wnoutrefresh
 --------------------------------------------------------------------------*/
 #ifdef TRACE
-void
-_nc_Wnoutrefresh(const PANEL *pan)
+NCURSES_EXPORT(void)
+_nc_Wnoutrefresh(const PANEL * pan)
 {
-  dPanel("wnoutrefresh",pan);
+  dPanel("wnoutrefresh", pan);
   wnoutrefresh(pan->win);
 }
 #endif
@@ -106,10 +126,10 @@ _nc_Wnoutrefresh(const PANEL *pan)
        Touchpan(pan)
 --------------------------------------------------------------------------*/
 #ifdef TRACE
-void
-_nc_Touchpan(const PANEL *pan)
+NCURSES_EXPORT(void)
+_nc_Touchpan(const PANEL * pan)
 {
-  dPanel("Touchpan",pan);
+  dPanel("Touchpan", pan);
   touchwin(pan->win);
 }
 #endif
@@ -118,191 +138,24 @@ _nc_Touchpan(const PANEL *pan)
        Touchline(pan,start,count)
 --------------------------------------------------------------------------*/
 #ifdef TRACE
-void
-_nc_Touchline(const PANEL *pan, int start, int count)
+NCURSES_EXPORT(void)
+_nc_Touchline(const PANEL * pan, int start, int count)
 {
   char s80[80];
-  sprintf(s80,"Touchline s=%d c=%d",start,count);
-  dPanel(s80,pan);
-  touchline(pan->win,start,count);
-}
-#endif
-
-/*+-------------------------------------------------------------------------
-       __panels_overlapped(pan1,pan2) - check panel overlapped
---------------------------------------------------------------------------*/
-static INLINE bool
-__panels_overlapped(register const PANEL *pan1, register const PANEL *pan2)
-{
-  if(!pan1 || !pan2)
-    return(FALSE);
-
-  dBug(("__panels_overlapped %s %s", USER_PTR(pan1->user), USER_PTR(pan2->user)));
-  /* pan1 intersects with pan2 ? */
-  if( (((pan1->wstarty >= pan2->wstarty) && (pan1->wstarty < pan2->wendy)) ||
-       ((pan2->wstarty >= pan1->wstarty) && (pan2->wstarty < pan1->wendy))) &&
-      (((pan1->wstartx >= pan2->wstartx) && (pan1->wstartx < pan2->wendx)) ||
-       ((pan2->wstartx >= pan1->wstartx) && (pan2->wstartx < pan1->wendx)))
-      ) return(TRUE);
-  else {
-    dBug(("  no"));
-    return(FALSE);
-  }
-}
-
-/*+-------------------------------------------------------------------------
-       _nc_free_obscure(pan)
---------------------------------------------------------------------------*/
-void
-_nc_free_obscure(PANEL *pan)
-{
-  PANELCONS *tobs = pan->obscure;                      /* "this" one */
-  PANELCONS *nobs;                                     /* "next" one */
-
-  while(tobs)
-    {
-      nobs = tobs->above;
-      free((char *)tobs);
-      tobs = nobs;
-    }
-  pan->obscure = (PANELCONS *)0;
-}
 
-/*+-------------------------------------------------------------------------
-       __override(pan,show)
---------------------------------------------------------------------------*/
-void
-_nc_override(const PANEL *pan, int show)
-{
-  int y;
-  PANEL *pan2;
-  PANELCONS *tobs = pan->obscure;                         /* "this" one */
-
-  dBug(("_nc_override %s,%d", USER_PTR(pan->user),show));
-
-  switch (show)
-    {
-    case P_TOUCH:
-      Touchpan(pan);
-      /* The following while loop will now mark all panel window lines
-       * obscured by use or obscuring us as touched, so they will be
-       * updated.
-       */
-      break;
-    case P_UPDATE:
-      while(tobs && (tobs->pan != pan))
-       tobs = tobs->above;
-      /* The next loop will now only go through the panels obscuring pan;
-       * it updates all the lines in the obscuring panels in sync. with
-       * the lines touched in pan itself. This is called in update_panels()
-       * in a loop from the bottom_panel to the top_panel, resulting in
-       * the desired update effect.
-       */
-      break;
-    default:
-      return;
-    }
-
-  while(tobs)
-    {
-      if((pan2 = tobs->pan) != pan) {
-       dBug(("test obs pan=%s pan2=%s", USER_PTR(pan->user), USER_PTR(pan2->user)));
-       for(y = pan->wstarty; y < pan->wendy; y++) {
-         if( (y >= pan2->wstarty) && (y < pan2->wendy) &&
-             ((is_linetouched(pan->win,y - pan->wstarty) == TRUE)) )
-           Touchline(pan2,y - pan2->wstarty,1);
-       }
-      }
-      tobs = tobs->above;
-    }
+  _nc_SPRINTF(s80, _nc_SLIMIT(sizeof(s80)) "Touchline s=%d c=%d", start, count);
+  dPanel(s80, pan);
+  touchline(pan->win, start, count);
 }
+#endif
 
-/*+-------------------------------------------------------------------------
-       __calculate_obscure()
---------------------------------------------------------------------------*/
+#ifndef TRACE
+#  ifndef __GNUC__
+     /* Some C compilers need something defined in a source file */
+extern void _nc_dummy_panel(void);
 void
-_nc_calculate_obscure(void)
+_nc_dummy_panel(void)
 {
-  PANEL *pan;
-  PANEL *pan2;
-  PANELCONS *tobs;                     /* "this" one */
-  PANELCONS *lobs = (PANELCONS *)0;    /* last one */
-
-  pan = _nc_bottom_panel;
-  while(pan)
-    {
-      if(pan->obscure)
-       _nc_free_obscure(pan);
-      dBug(("--> __calculate_obscure %s", USER_PTR(pan->user)));
-      lobs = (PANELCONS *)0;           /* last one */
-      pan2 = _nc_bottom_panel;
-      /* This loop builds a list of panels obsured by pan or obscuring
-        pan; pan itself is in the list; all panels before pan are
-        obscured by pan, all panels after pan are obscuring pan. */
-      while(pan2)
-       {
-         if(__panels_overlapped(pan,pan2))
-           {
-             if(!(tobs = (PANELCONS *)malloc(sizeof(PANELCONS))))
-               return;
-             tobs->pan = pan2;
-             dPanel("obscured",pan2);
-             tobs->above = (PANELCONS *)0;
-             if(lobs)
-               lobs->above = tobs;
-             else
-               pan->obscure = tobs;
-             lobs  = tobs;
-           }
-         pan2 = pan2->above;
-       }
-      _nc_override(pan,P_TOUCH);
-      pan = pan->above;
-    }
 }
-
-/*+-------------------------------------------------------------------------
-       _nc_panel_is_linked(pan) - check to see if panel is in the stack
---------------------------------------------------------------------------*/
-bool
-_nc_panel_is_linked(const PANEL *pan)
-{
-  /* This works! The only case where it would fail is, when the list has
-     only one element. But this could only be the pseudo panel at the bottom */
-  return ( ((pan->above!=(PANEL *)0) ||
-           (pan->below!=(PANEL *)0) ||
-           (pan==_nc_bottom_panel)) ? TRUE : FALSE );
-}
-
-
-/*+-------------------------------------------------------------------------
-       __panel_link_bottom(pan) - link panel into stack at bottom
---------------------------------------------------------------------------*/
-void
-_nc_panel_link_bottom(PANEL *pan)
-{
-#ifdef TRACE
-  dStack("<lb%d>",1,pan);
-  if(_nc_panel_is_linked(pan))
-    return;
+#  endif
 #endif
-
-  pan->above = (PANEL *)0;
-  pan->below = (PANEL *)0;
-  if(_nc_bottom_panel)
-    { /* the stdscr pseudo panel always stays real bottom;
-         so we insert after bottom panel*/
-      pan->below = _nc_bottom_panel;
-      pan->above = _nc_bottom_panel->above;
-      if (pan->above)
-       pan->above->below = pan;
-      _nc_bottom_panel->above = pan;
-    }
-  else
-    _nc_bottom_panel = pan;
-  if(!_nc_top_panel)
-    _nc_top_panel = pan;
-  assert(_nc_bottom_panel == _nc_stdscr_pseudo_panel);
-  _nc_calculate_obscure();
-  dStack("<lb%d>",9,pan);
-}