nuttx-apps/graphics/pdcurs34/pdcurses/pdc_addstr.c

/****************************************************************************
 * apps/graphics/pdcurses/pdc_addstr.c
 * Public Domain Curses
 * RCSID("$Id: addstr.c,v 1.44 2008/07/13 16:08:17 wmcbrine Exp $")
 *
 *   Copyright (C) 2017 Gregory Nutt. All rights reserved.
 *   Adapted by: Gregory Nutt <gnutt@nuttx.org>
 *
 * Adapted from the original public domain pdcurses by Gregory Nutt and
 * released as part of NuttX under the 3-clause BSD license:
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name NuttX nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

/* Name: addstr
 *
 * Synopsis:
 *       int addstr(const char *str);
 *       int addnstr(const char *str, int n);
 *       int waddstr(WINDOW *win, const char *str);
 *       int waddnstr(WINDOW *win, const char *str, int n);
 *       int mvaddstr(int y, int x, const char *str);
 *       int mvaddnstr(int y, int x, const char *str, int n);
 *       int mvwaddstr(WINDOW *win, int y, int x, const char *str);
 *       int mvwaddnstr(WINDOW *win, int y, int x, const char *str, int n);
 *
 *       int addwstr(const wchar_t *wstr);
 *       int addnwstr(const wchar_t *wstr, int n);
 *       int waddwstr(WINDOW *win, const wchar_t *wstr);
 *       int waddnwstr(WINDOW *win, const wchar_t *wstr, int n);
 *       int mvaddwstr(int y, int x, const wchar_t *wstr);
 *       int mvaddnwstr(int y, int x, const wchar_t *wstr, int n);
 *       int mvwaddwstr(WINDOW *win, int y, int x, const wchar_t *wstr);
 *       int mvwaddnwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n);
 *
 * Description:
 *       These routines write all the characters of the null-terminated
 *       string str or wide-character string wstr to the given window.
 *       The functionality is similar to calling waddch() once for each
 *       character in the string; except that, when PDCurses is built
 *       with wide-character support enabled, the narrow-character
 *       functions treat the string as a multibyte string in the current
 *       locale, and convert it. The routines with n as the last
 *       argument write at most n characters; if n is negative, then the
 *       entire string will be added.
 *
 * Return Value:
 *       All functions return OK or ERR.
 *
 * Portability                                X/Open    BSD    SYS V
 *       addstr                                  Y       Y       Y
 *       waddstr                                 Y       Y       Y
 *       mvaddstr                                Y       Y       Y
 *       mvwaddstr                               Y       Y       Y
 *       addnstr                                 Y       -      4.0
 *       waddnstr                                Y       -      4.0
 *       mvaddnstr                               Y       -      4.0
 *       mvwaddnstr                              Y       -      4.0
 *       addwstr                                 Y
 *       waddwstr                                Y
 *       mvaddwstr                               Y
 *       mvwaddwstr                              Y
 *       addnwstr                                Y
 *       waddnwstr                               Y
 *       mvaddnwstr                              Y
 *       mvwaddnwstr                             Y
 */

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include "curspriv.h"

int waddnstr(WINDOW *win, const char *str, int n)
{
  int i = 0;

  PDC_LOG(("waddnstr() - called: string=\"%s\" n %d \n", str, n));

  if (!win || !str)
    {
      return ERR;
    }

  while (str[i] && (i < n || n < 0))
    {
#ifdef CONFIG_PDCURSES_WIDE
      wchar_t wch;
      int retval = PDC_mbtowc(&wch, str + i, n >= 0 ? n - i : 6);

      if (retval <= 0)
        {
          return OK;
        }

      i += retval;
#else
      chtype wch = (unsigned char)(str[i++]);
#endif
      if (waddch(win, wch) == ERR)
        {
          return ERR;
        }
    }

  return OK;
}

int addstr(const char *str)
{
#ifdef CONFIG_PDCURSES_MULTITHREAD
  FAR struct pdc_context_s *ctx = PDC_ctx();
#endif
  PDC_LOG(("addstr() - called: string=\"%s\"\n", str));

  return waddnstr(stdscr, str, -1);
}

int addnstr(const char *str, int n)
{
#ifdef CONFIG_PDCURSES_MULTITHREAD
  FAR struct pdc_context_s *ctx = PDC_ctx();
#endif
  PDC_LOG(("addnstr() - called: string=\"%s\" n %d \n", str, n));

  return waddnstr(stdscr, str, n);
}

int waddstr(WINDOW *win, const char *str)
{
  PDC_LOG(("waddstr() - called: string=\"%s\"\n", str));

  return waddnstr(win, str, -1);
}

int mvaddstr(int y, int x, const char *str)
{
#ifdef CONFIG_PDCURSES_MULTITHREAD
  FAR struct pdc_context_s *ctx = PDC_ctx();
#endif
  PDC_LOG(("mvaddstr() - called: y %d x %d string=\"%s\"\n", y, x, str));

  if (move(y, x) == ERR)
    {
      return ERR;
    }

  return waddnstr(stdscr, str, -1);
}

int mvaddnstr(int y, int x, const char *str, int n)
{
#ifdef CONFIG_PDCURSES_MULTITHREAD
  FAR struct pdc_context_s *ctx = PDC_ctx();
#endif
  PDC_LOG(("mvaddnstr() - called: y %d x %d string=\"%s\" n %d \n",
           y, x, str, n));

  if (move(y, x) == ERR)
    {
      return ERR;
    }

  return waddnstr(stdscr, str, n);
}

int mvwaddstr(WINDOW *win, int y, int x, const char *str)
{
  PDC_LOG(("mvwaddstr() - called: string=\"%s\"\n", str));

  if (wmove(win, y, x) == ERR)
    {
      return ERR;
    }

  return waddnstr(win, str, -1);
}

int mvwaddnstr(WINDOW *win, int y, int x, const char *str, int n)
{
  PDC_LOG(("mvwaddnstr() - called: y %d x %d string=\"%s\" n %d \n",
           y, x, str, n));

  if (wmove(win, y, x) == ERR)
    {
      return ERR;
    }

  return waddnstr(win, str, n);
}

#ifdef CONFIG_PDCURSES_WIDE
int waddnwstr(WINDOW *win, const wchar_t *wstr, int n)
{
  int i = 0;

  PDC_LOG(("waddnwstr() - called\n"));

  if (!win || !wstr)
    {
      return ERR;
    }

  while (wstr[i] && (i < n || n < 0))
    {
      chtype wch = wstr[i++];

      if (waddch(win, wch) == ERR)
        {
          return ERR;
        }
    }

  return OK;
}

int addwstr(const wchar_t *wstr)
{
#ifdef CONFIG_PDCURSES_MULTITHREAD
  FAR struct pdc_context_s *ctx = PDC_ctx();
#endif
  PDC_LOG(("addwstr() - called\n"));

  return waddnwstr(stdscr, wstr, -1);
}

int addnwstr(const wchar_t *wstr, int n)
{
#ifdef CONFIG_PDCURSES_MULTITHREAD
  FAR struct pdc_context_s *ctx = PDC_ctx();
#endif
  PDC_LOG(("addnwstr() - called\n"));

  return waddnwstr(stdscr, wstr, n);
}

int waddwstr(WINDOW *win, const wchar_t *wstr)
{
  PDC_LOG(("waddwstr() - called\n"));

  return waddnwstr(win, wstr, -1);
}

int mvaddwstr(int y, int x, const wchar_t *wstr)
{
#ifdef CONFIG_PDCURSES_MULTITHREAD
  FAR struct pdc_context_s *ctx = PDC_ctx();
#endif
  PDC_LOG(("mvaddstr() - called\n"));

  if (move(y, x) == ERR)
    {
      return ERR;
    }

  return waddnwstr(stdscr, wstr, -1);
}

int mvaddnwstr(int y, int x, const wchar_t *wstr, int n)
{
#ifdef CONFIG_PDCURSES_MULTITHREAD
  FAR struct pdc_context_s *ctx = PDC_ctx();
#endif
  PDC_LOG(("mvaddnstr() - called\n"));

  if (move(y, x) == ERR)
    {
      return ERR;
    }

  return waddnwstr(stdscr, wstr, n);
}

int mvwaddwstr(WINDOW *win, int y, int x, const wchar_t *wstr)
{
  PDC_LOG(("mvwaddstr() - called\n"));

  if (wmove(win, y, x) == ERR)
    {
      return ERR;
    }

  return waddnwstr(win, wstr, -1);
}

int mvwaddnwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n)
{
  PDC_LOG(("mvwaddnstr() - called\n"));

  if (wmove(win, y, x) == ERR)
    {
      return ERR;
    }

  return waddnwstr(win, wstr, n);
}
#endif