/*      $NetBSD: cr_put.c,v 1.40 2022/10/19 06:09:27 blymn Exp $        */

/*
* Copyright (c) 1981, 1993, 1994
*      The Regents of the University of California.  All rights reserved.
*
* 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 of the University 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 REGENTS 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 REGENTS 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.
*/

#include <sys/cdefs.h>
#include <limits.h>
#include <stdlib.h>
#ifndef lint
#if 0
static char sccsid[] = "@(#)cr_put.c    8.3 (Berkeley) 5/4/94";
#else
__RCSID("$NetBSD: cr_put.c,v 1.40 2022/10/19 06:09:27 blymn Exp $");
#endif
#endif                          /* not lint */

#include <string.h>

#include "curses.h"
#include "curses_private.h"

#define HARDTABS        8

/*
* Terminal driving and line formatting routines.  Basic motion optimizations
* are done here as well as formatting lines (printing of control characters,
* line numbering and the like).
*/

/* Stub function for the users. */
int
mvcur(int ly, int lx, int y, int x)
{
       return (__mvcur(ly, lx, y, x, 0));
}

static void fgoto(int);
static int plod(int, int);
static int plodput(int);
static int tabcol(int, int);

static int outcol, outline, destcol, destline;

/*
* Sync the position of the output cursor.  Most work here is rounding for
* terminal boundaries getting the column position implied by wraparound or
* the lack thereof and rolling up the screen to get destline on the screen.
*/
int
__mvcur(int ly, int lx, int y, int x, int in_refresh)
{
       __CTRACE(__CTRACE_OUTPUT,
           "mvcur: moving cursor from (%d, %d) to (%d, %d) in refresh %d\n",
           ly, lx, y, x, in_refresh);
       destcol = x;
       destline = y;
       outcol = lx;
       outline = ly;
       fgoto(in_refresh);
       return (OK);
}

static void
fgoto(int in_refresh)
{
       int      c, l;
       char    *cgp;

       __CTRACE(__CTRACE_OUTPUT, "fgoto: in_refresh=%d\n", in_refresh);
       __CTRACE(__CTRACE_OUTPUT,
           "fgoto: outcol=%d, outline=%d, destcol=%d, destline=%d\n",
           outcol, outline, destcol, destline);
       if (destcol >= COLS) {
               destline += destcol / COLS;
               destcol %= COLS;
       }
       if (outcol >= COLS) {
               l = (outcol + 1) / COLS;
               outline += l;
               outcol %= COLS;
               if (auto_left_margin == 0) {
                       while (l > 0) {
                               if (__pfast) {
                                       if (carriage_return)
                                               tputs(carriage_return,
                                                       0, __cputchar);
                                       else
                                               __cputchar('\r');
                               }
                               if (cursor_down)
                                       tputs(cursor_down, 0, __cputchar);
                               else
                                       __cputchar('\n');
                               l--;
                       }
                       outcol = 0;
               }
               if (outline > LINES - 1) {
                       destline -= outline - (LINES - 1);
                       outline = LINES - 1;
               }
       }
       if (destline >= LINES) {
               l = destline;
               destline = LINES - 1;
               if (outline < LINES - 1) {
                       c = destcol;
                       if (__pfast == 0 && !cursor_address)
                               destcol = 0;
                       fgoto(in_refresh);
                       destcol = c;
               }
               while (l >= LINES) {
                       /* The following linefeed (or simulation thereof) is
                        * supposed to scroll up the screen, since we are on
                        * the bottom line.  We make the assumption that
                        * linefeed will scroll.  If ns is in the capability
                        * list this won't work.  We should probably have an
                        * sc capability but sf will generally take the place
                        * if it works.
                        *
                        * Superbee glitch: in the middle of the screen have to
                        * use esc B (down) because linefeed screws up in
                        * "Efficient Paging" (what a joke) mode (which is
                        * essential in some SB's because CRLF mode puts
                        * garbage in at end of memory), but you must use
                        * linefeed to scroll since down arrow won't go past
                        * memory end. I turned this off after receiving Paul
                        * Eggert's Superbee description which wins better. */
                       if (cursor_down /* && !__tc_xb */ && __pfast)
                               tputs(cursor_down, 0, __cputchar);
                       else
                               __cputchar('\n');
                       l--;
                       if (__pfast == 0)
                               outcol = 0;
               }
       }
       if (destline < outline && !(cursor_address || cursor_up))
               destline = outline;

       if (cursor_address &&
           (cgp = tiparm(cursor_address, destline, destcol)))
       {
               /*
                * Need this condition due to inconsistent behavior
                * of backspace on the last column.
                */
               __CTRACE(__CTRACE_OUTPUT, "fgoto: cgp=%s\n", cgp);
               if (outcol != COLS - 1 &&
                   plod((int) strlen(cgp), in_refresh) > 0)
                       plod(0, in_refresh);
               else
                       tputs(cgp, 0, __cputchar);
       } else
               plod(0, in_refresh);
       outline = destline;
       outcol = destcol;
}

/*
* Move (slowly) to destination.
* Hard thing here is using home cursor on really deficient terminals.
* Otherwise just use cursor motions, hacking use of tabs and overtabbing
* and backspace.
*
*/

static int plodcnt, plodflg;
#ifdef HAVE_WCHAR
static char s[MB_LEN_MAX];
#endif

static int
plodput(int c)
{
       if (plodflg) {
               int cw;

#ifdef HAVE_WCHAR
               cw = wctomb(s, c);
               if (cw < 0)
                       cw = 1;
#else
               cw = 1;
#endif /* HAVE_WCHAR */

               plodcnt -= cw;
       } else
               __cputchar(c);
       return 0;
}

static int
plod(int cnt, int in_refresh)
{
       int      i, j, k, soutcol, soutline;
       __LDATA  *csp;

       __CTRACE(__CTRACE_OUTPUT, "plod: cnt=%d, in_refresh=%d\n",
           cnt, in_refresh);
       __CTRACE(__CTRACE_OUTPUT,
           "plod: plodding from col %d, row %d to col %d, row %d\n",
           outcol, outline, destcol, destline);
       plodcnt = plodflg = cnt;
       soutcol = outcol;
       soutline = outline;

       /*
        * Consider homing and moving down/right from there, vs. moving
        * directly with local motions to the right spot.
        */
       if (cursor_home) {
               /*
                * i is the cost to home and tab/space to the right to get to
                * the proper column.  This assumes nd space costs 1 char.  So
                * i + destcol is cost of motion with home.
                */
               if (__GT)
                       i = (destcol / HARDTABS) + (destcol % HARDTABS);
               else
                       i = destcol;

               /* j is cost to move locally without homing. */
               if (destcol >= outcol) {        /* if motion is to the right */
                       j = destcol / HARDTABS - outcol / HARDTABS;
                       if (__GT && j)
                               j += destcol % HARDTABS;
                       else
                               j = destcol - outcol;
               } else
                       /* leftward motion only works if we can backspace. */
                       if (outcol - destcol <= i)
                               /* Cheaper to backspace. */
                               i = j = outcol - destcol;
                       else
                               /* Impossibly expensive. */
                               j = i + 1;

               /* k is the absolute value of vertical distance. */
               k = outline - destline;
               if (k < 0)
                       k = -k;
               j += k;

               /* Decision.  We may not have a choice if no up. */
               if (i + destline < j || (!cursor_up && destline < outline)) {
                       /*
                        * Cheaper to home.  Do it now and pretend it's a
                        * regular local motion.
                        */
                       tputs(cursor_home, 0, plodput);
                       outcol = outline = 0;
               } else
                       if (cursor_to_ll) {
                               /*
                                * Quickly consider homing down and moving from
                                * there.  Assume cost of ll is 2.
                                */
                               k = (LINES - 1) - destline;
                               if (i + k + 2 < j && (k <= 0 || cursor_up)) {
                                       tputs(cursor_to_ll, 0, plodput);
                                       outcol = 0;
                                       outline = LINES - 1;
                               }
                       }
       } else
               /* No home and no up means it's impossible. */
               if (!cursor_up && destline < outline)
                       return (-1);
       if (__GT)
               i = destcol % HARDTABS + destcol / HARDTABS;
       else
               i = destcol;
#ifdef notdef
       if (back_tab && outcol > destcol &&
           (j = (((outcol + 7) & ~7) - destcol - 1) >> 3)) {
               j *= (k = strlen(back_tab));
               if ((k += (destcol & 7)) > 4)
                       j += 8 - (destcol & 7);
               else
                       j += k;
       } else
#endif
               j = outcol - destcol;

       /*
        * If we will later need a \n which will turn into a \r\n by the
        * system or the terminal, then don't bother to try to \r.
        */
       if ((__NONL || !__pfast) && outline < destline)
               goto dontcr;

       /*
        * If the terminal will do a \r\n and there isn't room for it, then
        * we can't afford a \r.
        */
       if (!carriage_return && outline >= destline)
               goto dontcr;

       /*
        * If it will be cheaper, or if we can't back up, then send a return
        * preliminarily.
        */
       if (j > i + 1 || outcol > destcol) {
               /*
                * BUG: this doesn't take the (possibly long) length of cr
                * into account.
                */
               if (carriage_return)
                       tputs(carriage_return, 0, plodput);
               else
                       plodput('\r');
               if (!carriage_return) {
                       if (cursor_down)
                               tputs(cursor_down, 0, plodput);
                       else
                               plodput('\n');
                       outline++;
               }

               outcol = 0;
       }
dontcr:while (outline < destline) {
               outline++;
               if (cursor_down)
                       tputs(cursor_down, 0, plodput);
               else
                       plodput('\n');
               if (plodcnt < 0)
                       goto out;
               /*
                * If the terminal does a CR with NL or we are in
                * a mode where a \n will result in an implicit \r
                * then adjust the outcol to match iff we actually
                * emitted said \n.
                */
               if ((__NONL || __pfast == 0) &&
                   (!cursor_down || (*cursor_down == '\n')))
                       outcol = 0;
       }
#ifdef notdef
       if (back_tab)
               k = (int) strlen(back_tab);
#endif
       while (outcol > destcol) {
               if (plodcnt < 0)
                       goto out;
#ifdef notdef
               if (back_tab && outcol - destcol > k + 4) {
                       tputs(back_tab, 0, plodput);
                       outcol--;
                       outcol &= ~7;
                       continue;
               }
#endif
               outcol--;
               if (cursor_left)
                       tputs(cursor_left, 0, plodput);
               else
                       plodput('\b');
       }
       while (outline > destline) {
               outline--;
               tputs(cursor_up, 0, plodput);
               if (plodcnt < 0)
                       goto out;
       }
       if (__GT && destcol - outcol > 1) {
               for (;;) {
                       i = tabcol(outcol, HARDTABS);
                       if (i > destcol)
                               break;
                       if (tab)
                               tputs(tab, 0, plodput);
                       else
                               plodput('\t');
                       outcol = i;
               }
               if (destcol - outcol > 4 && i < COLS) {
                       if (tab)
                               tputs(tab, 0, plodput);
                       else
                               plodput('\t');
                       outcol = i;
                       while (outcol > destcol) {
                               outcol--;
                               if (cursor_left)
                                       tputs(cursor_left, 0, plodput);
                               else
                                       plodput('\b');
                       }
               }
       }

#ifdef HAVE_WCHAR
       /*
        * If destcol is halfway through a multicolumn
        * wide char, we have no chance of plodding.
        */
       if (curscr->alines[outline]->line[outcol].cflags & CA_CONTINUATION) {
               plodcnt = -1;
               goto out;
       }
#endif /* HAVE_WCHAR */

       while (outcol < destcol) {
               int chw;

               csp = &curscr->alines[outline]->line[outcol];
#ifdef HAVE_WCHAR
               chw = csp->wcols;
#else
               chw = 1;
#endif /* HAVE_WCHAR */


               /*
                * Move one char to the right.  We don't use nd space because
                * it's better to just print the char we are moving over.
                */
               if (in_refresh)
                       if (plodflg)    /* Avoid a complex calculation. */
                               plodcnt--;
                       else {
#ifndef HAVE_WCHAR
                               i = csp->ch & __CHARTEXT;
                               if (csp->attr == curscr->wattr)
                                       __cputchar(i);
#else
                               if ((csp->attr & WA_ATTRIBUTES)
                                   == curscr->wattr) {
                                       if (csp->cflags & CA_CONTINUATION)
                                               goto nondes;

                                       if (csp->wcols >= 1) {
                                               __cputwchar(csp->ch);
                                               __cursesi_putnsp(csp->nsp,
                                                               outline,
                                                               outcol);
                                               __CTRACE(__CTRACE_OUTPUT,
                                                   "plod: (%d,%d)wcols(%d), "
                                                   "putwchar(%x)\n",
                                                   outline, outcol,
                                                   csp->wcols, csp->ch);
                                       }

                                       if (csp->wcols == 0)
                                               break;
                               }
#endif /* HAVE_WCHAR */
                               else
                                       goto nondes;
                       }
               else {
               nondes: if (cursor_right)
                               tputs(cursor_right, 0, plodput);
                       else
                               plodput(' ');
               }

               outcol += chw;
               if (plodcnt < 0)
                       goto out;
       }

out:    if (plodflg) {
               outcol = soutcol;
               outline = soutline;
       }
       __CTRACE(__CTRACE_OUTPUT, "plod: returns %d\n", plodcnt);
       return plodcnt;
}

/*
* Return the column number that results from being in column col and
* hitting a tab, where tabs are set every ts columns.  Work right for
* the case where col > COLS, even if ts does not divide COLS.
*/
static int
tabcol(int col, int ts)
{
       int      offset;

       if (col >= COLS) {
               offset = COLS * (col / COLS);
               col -= offset;
       } else
               offset = 0;
       return (col + ts - (col % ts) + offset);
}