lib/libcurses/inchstr.c

   1 /*      $NetBSD: inchstr.c,v 1.3 2009/07/22 16:57:14 roy Exp $  */
   2
   3 /*
   4  * Copyright 2001 Wasabi Systems, Inc.
   5  * All rights reserved.
   6  *
   7  * Written by Simon Burge for Wasabi Systems, Inc.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. All advertising materials mentioning features or use of this software
  18  *    must display the following acknowledgement:
  19  *      This product includes software developed for the NetBSD Project by
  20  *      Wasabi Systems, Inc.
  21  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
  22  *    or promote products derived from this software without specific prior
  23  *    written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND ANY
  26  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC. BE
  29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  35  * THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #include <sys/cdefs.h>
  39 #ifndef lint
  40 __RCSID("$NetBSD: inchstr.c,v 1.3 2009/07/22 16:57:14 roy Exp $");
  41 #endif                          /* not lint */
  42
  43 #include "curses.h"
  44 #include "curses_private.h"
  45
  46 #ifndef _CURSES_USE_MACROS
  47
  48 /*
  49  * inchstr, inchnstr --
  50  *      Return an array of characters at cursor position from stdscr.
  51  */
  52 __warn_references(inchstr,
  53     "warning: this program uses inchstr(), which is unsafe.")
  54 int
  55 inchstr(chtype *chstr)
  56 {
  57         return winchstr(stdscr, chstr);
  58 }
  59
  60 int
  61 inchnstr(chtype *chstr, int n)
  62 {
  63         return winchnstr(stdscr, chstr, n);
  64 }
  65
  66 /*
  67  * mvinchstr, mvinchnstr --
  68  *      Return an array of characters at position (y, x) from stdscr.
  69  */
  70 __warn_references(mvinchstr,
  71     "warning: this program uses mvinchstr(), which is unsafe.")
  72 int
  73 mvinchstr(int y, int x, chtype *chstr)
  74 {
  75         return mvwinchstr(stdscr, y, x, chstr);
  76 }
  77
  78 int
  79 mvinchnstr(int y, int x, chtype *chstr, int n)
  80 {
  81         return mvwinchnstr(stdscr, y, x, chstr, n);
  82 }
  83
  84 /*
  85  * mvwinchstr, mvwinchnstr --
  86  *      Return an array characters at position (y, x) from the given window.
  87  */
  88 __warn_references(mvwinchstr,
  89     "warning: this program uses mvwinchstr(), which is unsafe.")
  90 int
  91 mvwinchstr(WINDOW *win, int y, int x, chtype *chstr)
  92 {
  93         if (wmove(win, y, x) == ERR)
  94                 return ERR;
  95
  96         return winchstr(win, chstr);
  97 }
  98
  99 int
 100 mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n)
 101 {
 102         if (wmove(win, y, x) == ERR)
 103                 return ERR;
 104
 105         return winchnstr(win, chstr, n);
 106 }
 107
 108 #endif  /* _CURSES_USE_MACROS */
 109
 110 /*
 111  * winchstr, winchnstr --
 112  *      Return an array of characters at cursor position.
 113  */
 114 __warn_references(winchstr,
 115     "warning: this program uses winchstr(), which is unsafe.")
 116 int
 117 winchstr(WINDOW *win, chtype *chstr)
 118 {
 119
 120         return winchnstr(win, chstr, -1);
 121 }
 122
 123 /*
 124  * XXX: This should go in a manpage!
 125  * - SUSv2/xcurses doesn't document whether the trailing 0 is included
 126  *   in the length count or not.  For safety's sake it _is_ included.
 127  */
 128 int
 129 winchnstr(WINDOW *win, chtype *chstr, int n)
 130 {
 131         __LDATA *end, *start;
 132         int epos;
 133
 134         if (chstr == NULL)
 135                 return ERR;
 136
 137         start = &win->alines[win->cury]->line[win->curx];
 138         /* (n - 1) to leave room for the trailing 0 element */
 139         if (n < 0 || (n - 1) > win->maxx - win->curx - 1)
 140                 epos = win->maxx - 1;
 141         else
 142                 /* extra -1 for trailing NUL */
 143                 epos = win->curx + n -1 - 1;
 144         end = &win->alines[win->cury]->line[epos];
 145
 146         while (start <= end) {
 147                 *chstr = start->ch;
 148                 chstr++;
 149                 start++;
 150         }
 151         *chstr = 0;
 152
 153         return OK;
 154 }