ncurses 6.1 - patch 20190406
[ncurses.git] / ncurses / base / lib_slk.c
index 9b9b09a4d064a2b0b11b748c7cbf593b821cfa08..84f17ae03705d6af7dd575f296f79f4a095ad6b2 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998 Free Software Foundation, Inc.                        *
+ * Copyright (c) 1998-2010,2011 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> 1992,1995               *
- *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *  Authors:                                                                *
+ *          Gerhard Fuernkranz                      1993 (original)         *
+ *          Zeyd M. Ben-Halim                       1992,1995 (sic)         *
+ *          Eric S. Raymond                                                 *
+ *          Juergen Pfeifer                         1996-on                 *
+ *          Thomas E. Dickey                                                *
  ****************************************************************************/
 
 /*
  */
 
 #include <curses.priv.h>
-
 #include <ctype.h>
-#include <term.h>      /* num_labels, label_*, plab_norm */
 
-MODULE_ID("$Id: lib_slk.c,v 1.16 1999/03/03 23:44:22 juergen Exp $")
+#ifndef CUR
+#define CUR SP_TERMTYPE
+#endif
 
-/*
- * We'd like to move these into the screen context structure, but cannot,
- * because slk_init() is called before initscr()/newterm().
- */
-int _nc_slk_format;  /* one more than format specified in slk_init() */
+MODULE_ID("$Id: lib_slk.c,v 1.48 2011/03/05 21:21:52 tom Exp $")
+
+#ifdef USE_TERM_DRIVER
+#define NumLabels    InfoOf(SP_PARM).numlabels
+#define NoColorVideo InfoOf(SP_PARM).nocolorvideo
+#define LabelWidth   InfoOf(SP_PARM).labelwidth
+#define LabelHeight  InfoOf(SP_PARM).labelheight
+#else
+#define NumLabels    num_labels
+#define NoColorVideo no_color_video
+#define LabelWidth   label_width
+#define LabelHeight  label_height
+#endif
 
 /*
- * Paint the info line for the PC style SLK emulation.
- *
+ * Free any memory related to soft labels, return an error.
  */
-static void
-slk_paint_info(WINDOW *win)
+static int
+slk_failed(NCURSES_SP_DCL0)
 {
-  if (win && SP->slk_format==4)
-    {
-      int i;
-
-      mvwhline (win,0,0,0,getmaxx(win));
-      wmove (win,0,0);
-
-      for (i = 0; i < SP->_slk->maxlab; i++) {
-       if (win && SP->slk_format==4)
-         {
-           mvwaddch(win,0,SP->_slk->ent[i].x,'F');
-           if (i<9)
-             waddch(win,'1'+i);
-           else
-             {
-               waddch(win,'1');
-               waddch(win,'0' + (i-9));
-             }
-         }
-      }
+    if ((0 != SP_PARM) && SP_PARM->_slk) {
+       FreeIfNeeded(SP_PARM->_slk->ent);
+       free(SP_PARM->_slk);
+       SP_PARM->_slk = (SLK *) 0;
     }
+    return ERR;
 }
 
-/*
- * Initialize soft labels.
- * Called from newterm()
- */
-int
-_nc_slk_initialize(WINDOW *stwin, int cols)
+NCURSES_EXPORT(int)
+_nc_format_slks(NCURSES_SP_DCLx int cols)
 {
-int i, x;
-int res = OK;
-char *p;
-
-       T(("slk_initialize()"));
-
-       if (SP->_slk)
-         { /* we did this already, so simply return */
-           return(OK);
-         }
-       else
-         if ((SP->_slk = typeCalloc(SLK, 1)) == 0)
-           return(ERR);
-
-       SP->_slk->ent    = NULL;
-       SP->_slk->buffer = NULL;
-       SP->_slk->attr   = A_STANDOUT;
-
-       SP->_slk->maxlab = (num_labels > 0) ?
-         num_labels : MAX_SKEY(_nc_slk_format);
-       SP->_slk->maxlen = (num_labels > 0) ?
-         label_width * label_height : MAX_SKEY_LEN(_nc_slk_format);
-       SP->_slk->labcnt = (SP->_slk->maxlab < MAX_SKEY(_nc_slk_format)) ? 
-         MAX_SKEY(_nc_slk_format) : SP->_slk->maxlab;
-
-       SP->_slk->ent = typeCalloc(slk_ent, SP->_slk->labcnt);
-       if (SP->_slk->ent == NULL)
-         goto exception;
-
-       p = SP->_slk->buffer = (char*) calloc(2*SP->_slk->labcnt,(1+SP->_slk->maxlen));
-       if (SP->_slk->buffer == NULL)
-         goto exception;
-
-       for (i = 0; i < SP->_slk->labcnt; i++) {
-               SP->_slk->ent[i].text = p;
-               p += (1 + SP->_slk->maxlen);
-               SP->_slk->ent[i].form_text = p;
-               p += (1 + SP->_slk->maxlen);
-               memset(SP->_slk->ent[i].form_text, ' ', (unsigned)(SP->_slk->maxlen));
-               SP->_slk->ent[i].visible = (i < SP->_slk->maxlab);
-       }
-       if (_nc_slk_format >= 3) /* PC style */
-         {
-           int gap = (cols - 3 * (3 + 4*SP->_slk->maxlen))/2;
+    int gap, i, x;
+    int max_length;
 
-           if (gap < 1)
-             gap = 1;
+    if (!SP_PARM || !SP_PARM->_slk)
+       return ERR;
 
-           for (i = x = 0; i < SP->_slk->maxlab; i++) {
-             SP->_slk->ent[i].x = x;
-             x += SP->_slk->maxlen;
-             x += (i==3 || i==7) ? gap : 1;
-           }
-           if (_nc_slk_format == 4)
-             slk_paint_info (stwin);
-         }
-       else {
-         if (_nc_slk_format == 2) {    /* 4-4 */
-           int gap = cols - (SP->_slk->maxlab * SP->_slk->maxlen) - 6;
+    max_length = SP_PARM->_slk->maxlen;
+    if (SP_PARM->slk_format >= 3) {    /* PC style */
+       gap = (cols - 3 * (3 + 4 * max_length)) / 2;
+
+       if (gap < 1)
+           gap = 1;
+
+       for (i = x = 0; i < SP_PARM->_slk->maxlab; i++) {
+           SP_PARM->_slk->ent[i].ent_x = x;
+           x += max_length;
+           x += (i == 3 || i == 7) ? gap : 1;
+       }
+    } else {
+       if (SP_PARM->slk_format == 2) {         /* 4-4 */
+           gap = cols - (int) (SP_PARM->_slk->maxlab * max_length) - 6;
 
            if (gap < 1)
-                       gap = 1;
-           for (i = x = 0; i < SP->_slk->maxlab; i++) {
-             SP->_slk->ent[i].x = x;
-             x += SP->_slk->maxlen;
-             x += (i == 3) ? gap : 1;
+               gap = 1;
+           for (i = x = 0; i < SP_PARM->_slk->maxlab; i++) {
+               SP_PARM->_slk->ent[i].ent_x = x;
+               x += max_length;
+               x += (i == 3) ? gap : 1;
            }
-         }
-         else
-           {
-             if (_nc_slk_format == 1) { /* 1 -> 3-2-3 */
-               int gap = (cols - (SP->_slk->maxlab * SP->_slk->maxlen) - 5) / 2;
+       } else {
+           if (SP_PARM->slk_format == 1) {     /* 1 -> 3-2-3 */
+               gap = (cols - (SP_PARM->_slk->maxlab * max_length) - 5)
+                   / 2;
 
                if (gap < 1)
-                 gap = 1;
-               for (i = x = 0; i < SP->_slk->maxlab; i++) {
-                 SP->_slk->ent[i].x = x;
-                 x += SP->_slk->maxlen;
-                 x += (i == 2 || i == 4) ? gap : 1;
+                   gap = 1;
+               for (i = x = 0; i < SP_PARM->_slk->maxlab; i++) {
+                   SP_PARM->_slk->ent[i].ent_x = x;
+                   x += max_length;
+                   x += (i == 2 || i == 4) ? gap : 1;
                }
-             }
-             else
-               goto exception;
+           } else {
+               return slk_failed(NCURSES_SP_ARG);
            }
        }
-       SP->_slk->dirty = TRUE;
-       if ((SP->_slk->win = stwin) == NULL)
-       {
-       exception:
-               if (SP->_slk)
-               {
-                  FreeIfNeeded(SP->_slk->buffer);
-                  FreeIfNeeded(SP->_slk->ent);
-                  free(SP->_slk);
-                  SP->_slk = (SLK*)0;
-                  res = (ERR);
-               }
-       }
+    }
+    SP_PARM->_slk->dirty = TRUE;
 
-       /* We now reset the format so that the next newterm has again
-        * per default no SLK keys and may call slk_init again to
-        * define a new layout. (juergen 03-Mar-1999)
-        */
-       SP->slk_format = _nc_slk_format;
-       _nc_slk_format = 0;
-       return(res);
+    return OK;
 }
 
+/*
+ * Initialize soft labels.
+ * Called from newterm()
+ */
+NCURSES_EXPORT(int)
+_nc_slk_initialize(WINDOW *stwin, int cols)
+{
+    int i;
+    int res = OK;
+    size_t max_length;
+    SCREEN *sp;
+    int numlab;
+
+    T((T_CALLED("_nc_slk_initialize()")));
+
+    assert(stwin);
+
+    sp = _nc_screen_of(stwin);
+    if (0 == sp)
+       returnCode(ERR);
+
+    assert(TerminalOf(SP_PARM));
+
+    numlab = NumLabels;
+
+    if (SP_PARM->_slk) {       /* we did this already, so simply return */
+       returnCode(OK);
+    } else if ((SP_PARM->_slk = typeCalloc(SLK, 1)) == 0)
+       returnCode(ERR);
+
+    if (!SP_PARM->slk_format)
+       SP_PARM->slk_format = _nc_globals.slk_format;
+
+    /*
+     * If we use colors, vidputs() will suppress video attributes that conflict
+     * with colors.  In that case, we're still guaranteed that "reverse" would
+     * work.
+     */
+    if ((NoColorVideo & 1) == 0)
+       SetAttr(SP_PARM->_slk->attr, A_STANDOUT);
+    else
+       SetAttr(SP_PARM->_slk->attr, A_REVERSE);
+
+    SP_PARM->_slk->maxlab = (short) ((numlab > 0)
+                                    ? numlab
+                                    : MAX_SKEY(SP_PARM->slk_format));
+    SP_PARM->_slk->maxlen = (short) ((numlab > 0)
+                                    ? LabelWidth * LabelHeight
+                                    : MAX_SKEY_LEN(SP_PARM->slk_format));
+    SP_PARM->_slk->labcnt = (short) ((SP_PARM->_slk->maxlab < MAX_SKEY(SP_PARM->slk_format))
+                                    ? MAX_SKEY(SP_PARM->slk_format)
+                                    : SP_PARM->_slk->maxlab);
+
+    if (SP_PARM->_slk->maxlen <= 0
+       || SP_PARM->_slk->labcnt <= 0
+       || (SP_PARM->_slk->ent = typeCalloc(slk_ent,
+                                           (size_t) SP_PARM->_slk->labcnt))
+       == NULL)
+       returnCode(slk_failed(NCURSES_SP_ARG));
+
+    max_length = (size_t) SP_PARM->_slk->maxlen;
+    for (i = 0; i < SP_PARM->_slk->labcnt; i++) {
+       size_t used = max_length + 1;
+
+       SP_PARM->_slk->ent[i].ent_text = (char *) _nc_doalloc(0, used);
+       if (SP_PARM->_slk->ent[i].ent_text == 0)
+           returnCode(slk_failed(NCURSES_SP_ARG));
+       memset(SP_PARM->_slk->ent[i].ent_text, 0, used);
+
+       SP_PARM->_slk->ent[i].form_text = (char *) _nc_doalloc(0, used);
+       if (SP_PARM->_slk->ent[i].form_text == 0)
+           returnCode(slk_failed(NCURSES_SP_ARG));
+
+       if (used > 1) {
+           memset(SP_PARM->_slk->ent[i].form_text, ' ', used - 1);
+       }
+       SP_PARM->_slk->ent[i].form_text[used - 1] = '\0';
+
+       SP_PARM->_slk->ent[i].visible = (char) (i < SP_PARM->_slk->maxlab);
+    }
+
+    res = _nc_format_slks(NCURSES_SP_ARGx cols);
+
+    if ((SP_PARM->_slk->win = stwin) == NULL) {
+       returnCode(slk_failed(NCURSES_SP_ARG));
+    }
+
+    /* We now reset the format so that the next newterm has again
+     * per default no SLK keys and may call slk_init again to
+     * define a new layout. (juergen 03-Mar-1999)
+     */
+    _nc_globals.slk_format = 0;
+    returnCode(res);
+}
 
 /*
  * Restore the soft labels on the screen.
  */
-int
-slk_restore(void)
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(slk_restore) (NCURSES_SP_DCL0)
 {
-       T((T_CALLED("slk_restore()")));
+    T((T_CALLED("slk_restore(%p)"), (void *) SP_PARM));
 
-       if (SP->_slk == NULL)
-               return(ERR);
-       SP->_slk->hidden = FALSE;
-       SP->_slk->dirty = TRUE;
-       /* we have to repaint info line eventually */
-       slk_paint_info(SP->_slk->win);
+    if (0 == SP_PARM)
+       returnCode(ERR);
+    if (SP_PARM->_slk == NULL)
+       returnCode(ERR);
+    SP_PARM->_slk->hidden = FALSE;
+    SP_PARM->_slk->dirty = TRUE;
 
-       returnCode(slk_refresh());
+    returnCode(NCURSES_SP_NAME(slk_refresh) (NCURSES_SP_ARG));
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+slk_restore(void)
+{
+    return NCURSES_SP_NAME(slk_restore) (CURRENT_SCREEN);
 }
+#endif