* New version 2.26

[alpine.git] / pico / line.c

/*
 * ========================================================================
 * Copyright 2006-2007 University of Washington
 * Copyright 2013-2022 Eduardo Chappa
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * ========================================================================
 *
 * Program:     Line management routines
 */

/*
 * The functions in this file are a general set of line management utilities.
 * They are the only routines that touch the text. They also touch the buffer
 * and window structures, to make sure that the necessary updating gets done.
 * There are routines in this file that handle the kill buffer too. It isn't
 * here for any good reason.
 *
 * Note that this code only updates the dot and mark values in the window list.
 * Since all the code acts on the current window, the buffer that we are
 * editing must be being displayed, which means that "b_nwnd" is non zero,
 * which means that the dot and mark values in the buffer headers are nonsense.
 */

#include        "headers.h"

#define NBLOCK  16                      /* Line block chunk size        */
#define KBLOCK  1024                    /* Kill buffer block size       */


/*
 * Struct to manage the kill and justify buffers
 */
struct pkchunk {
    short  used;                /* # of characters used in this buffer */
    UCS    bufp[KBLOCK];        /* buffer containing text              */
    struct pkchunk *next;       /* pointer to next chunk               */
};

static struct pkbuf {
    long            total;              /* # of UCS characters used in buffer */
    struct pkchunk *first;              /* first one of these in the chain */
    struct pkchunk *last;               /* last one of these in the chain */
} *kbufp, *fbufp;


void  insspace(int, int);
int   ldelnewline(void);
void  pkbufdel(struct pkbuf **);
void  pkchunkdel(struct pkchunk **);
int   pkbufinsert(UCS, struct pkbuf **);
long  pkbufremove(int, struct pkbuf *);


/*
 * This routine allocates a block of memory large enough to hold a LINE
 * containing "used" characters. The block is always rounded up a bit. Return
 * a pointer to the new block, or NULL if there isn't any memory left. Print a
 * message in the message line if no space.
 */
LINE *
lalloc(int used)
{
    register LINE   *lp = NULL;
    register int    size;
    EML             eml;
    static int      displayed = 0;

    if((size = (used+NBLOCK-1) & ~(NBLOCK-1)) > NLINE)
      size *= 2;

    if (size == 0)                    /* Assume that an empty */
      size = NBLOCK;                  /* line is for type-in. */

    if (displayed == 0 && (lp = (LINE *) malloc(sizeof(LINE)+(size*sizeof(CELL)))) == NULL){
        eml.s = comatose(size);
        emlwrite("Cannot allocate %s bytes (read file incomplete)", &eml);
        displayed++;
        return (NULL);
    }

    lp->l_size = size;
    lp->l_used = used;
    lp->l_sig  = 0;                             /* assume it is not a signature line */
    memset((void *)lp->l_text, 0, size*sizeof(CELL));
    return (lp);
}

/*
 * Delete line "lp". Fix all of the links that might point at it (they are
 * moved to offset 0 of the next line. Unlink the line from whatever buffer it
 * might be in. Release the memory. The buffers are updated too; the magic
 * conditions described in the above comments don't hold here.
 */
void
lfree(LINE *lp)
{
    register BUFFER *bp;
    register WINDOW *wp;

    wp = wheadp;
    while (wp != NULL) {
        if (wp->w_linep == lp)
          wp->w_linep = lp->l_fp;

        if (wp->w_dotp  == lp) {
            wp->w_dotp  = lp->l_fp;
            wp->w_doto  = 0;
        }

        if (wp->w_markp == lp) {
            wp->w_markp = lp->l_fp;
            wp->w_marko = 0;
        }

        if (wp->w_imarkp == lp) {
            wp->w_imarkp = lp->l_fp;
            wp->w_imarko = 0;
        }

        wp = wp->w_wndp;
    }

    bp = bheadp;
    while (bp != NULL) {
        if (bp->b_nwnd == 0) {
            if (bp->b_dotp  == lp) {
                bp->b_dotp = lp->l_fp;
                bp->b_doto = 0;
            }

            if (bp->b_markp == lp) {
                bp->b_markp = lp->l_fp;
                bp->b_marko = 0;
            }
        }

        bp = bp->b_bufp;
    }

    lp->l_bp->l_fp = lp->l_fp;
    lp->l_fp->l_bp = lp->l_bp;
    free((char *) lp);
}


/*
 * This routine gets called when a character is changed in place in the current
 * buffer. It updates all of the required flags in the buffer and window
 * system. The flag used is passed as an argument; if the buffer is being
 * displayed in more than 1 window we change EDIT to HARD. Set MODE if the
 * mode line needs to be updated (the "*" has to be set).
 */
void
lchange(int flag)
{
    register WINDOW *wp;

    if (curbp->b_nwnd != 1)                 /* Ensure hard.         */
      flag = WFHARD;

    if ((curbp->b_flag&BFCHG) == 0) {       /* First change, so     */
        if(Pmaster == NULL)
          flag |= WFMODE;                 /* update mode lines.   */
        curbp->b_flag |= BFCHG;
    }

    wp = wheadp;
    while (wp != NULL) {
        if (wp->w_bufp == curbp)
          wp->w_flag |= flag;
        wp = wp->w_wndp;
    }
}


/*
 * insert spaces forward into text
 * default flag and numeric argument 
 */
void
insspace(int f, int n)  
{
    linsert(n, ' ');
    backchar(f, n);
}

/*
 * Insert "n" copies of the character "c" at the current location of dot. In
 * the easy case all that happens is the text is stored in the line. In the
 * hard case, the line has to be reallocated. When the window list is updated,
 * take special care; I screwed it up once. You always update dot in the
 * current window. You update mark, and a dot in another window, if it is
 * greater than the place where you did the insert. Return TRUE if all is
 * well, and FALSE on errors.
 */
int
linsert(int n, UCS c)
{
    register LINE   *dotp;
    register int     doto;
    register WINDOW *wp;

    if (curbp->b_mode&MDVIEW)   /* don't allow this command if  */
      return(rdonly()); /* we are in read only mode     */

    dotp = curwp->w_dotp;
    doto = curwp->w_doto;
    lchange(WFEDIT);

    if(!geninsert(&(curwp->w_dotp), &(curwp->w_doto), curbp->b_linep,
                  c, (curwp->w_markp) ? 1 : 0, n, &curbp->b_linecnt))
      return(FALSE);

    wp = wheadp;                                /* Update windows       */
    while (wp != NULL) {
        if (wp->w_linep == dotp)
          wp->w_linep = wp->w_dotp;

        if (wp->w_imarkp == dotp) {             /* added for internal mark */
            wp->w_imarkp = wp->w_dotp;
            if (wp->w_imarko > doto)
              wp->w_imarko += n;
        }

        if (wp->w_markp == dotp) {
            wp->w_markp = dotp;
            if (wp->w_marko > doto)
              wp->w_marko += n;
        }
        wp = wp->w_wndp;
    }

    return (TRUE);
}


/*
 * geninsert - do the actual work of inserting a character into
 *             the list of lines.
 */
int
geninsert(LINE **dotp, int *doto, LINE *linep, UCS c, int attb, int n, long *lines)
{
    register LINE  *lp1;
    register LINE  *lp2;
    register CELL  *cp1;
    register CELL  *cp2;
    CELL ac;

    ac.a = attb;
    if (*dotp == linep) {                       /* At the end: special  */
        if (*doto != 0) {
            emlwrite("Programmer botch: geninsert", NULL);
            return (FALSE);
        }

        if ((lp1=lalloc(n)) == NULL)            /* Allocate new line    */
          return (FALSE);

        lp2 = (*dotp)->l_bp;                /* Previous line        */
        lp2->l_fp = lp1;                /* Link in              */
        lp1->l_fp = *dotp;
        (*dotp)->l_bp = lp1;
        lp1->l_bp = lp2;
        *doto = n;
        *dotp = lp1;
        ac.c  = (c & CELLMASK);
        cp1   = &(*dotp)->l_text[0];
        while(n--)
          *cp1++ = ac;

        if(lines)
          (*lines)++;

        return (TRUE);
    }

    if ((*dotp)->l_used+n > (*dotp)->l_size) {      /* Hard: reallocate     */
        if ((lp1=lalloc((*dotp)->l_used+n)) == NULL)
          return (FALSE);

        cp1 = &(*dotp)->l_text[0];
        cp2 = &lp1->l_text[0];
        while (cp1 != &(*dotp)->l_text[*doto])
          *cp2++ = *cp1++;

        cp2 += n;
        while (cp1 != &(*dotp)->l_text[(*dotp)->l_used])
          *cp2++ = *cp1++;

        (*dotp)->l_bp->l_fp = lp1;
        lp1->l_fp = (*dotp)->l_fp;
        (*dotp)->l_fp->l_bp = lp1;
        lp1->l_bp = (*dotp)->l_bp;

        /* global may be keeping track of mark/imark */
        if(wheadp){
            if (wheadp->w_imarkp == *dotp)
              wheadp->w_imarkp = lp1;

            if (wheadp->w_markp == *dotp)
              wheadp->w_markp = lp1;
        }

        free((char *) (*dotp));
        *dotp = lp1;
    } else {                                /* Easy: in place       */
        (*dotp)->l_used += n;
        cp2 = &(*dotp)->l_text[(*dotp)->l_used];
        cp1 = cp2-n;
        while (cp1 != &(*dotp)->l_text[*doto])
          *--cp2 = *--cp1;
    }

    ac.c = (c & CELLMASK);
    while(n--)                                  /* add the chars */
      (*dotp)->l_text[(*doto)++] = ac;

    return(TRUE);
}


/*
 * Insert a newline into the buffer at the current location of dot in the
 * current window. The funny ass-backwards way it does things is not a botch;
 * it just makes the last line in the file not a special case. Return TRUE if
 * everything works out and FALSE on error (memory allocation failure). The
 * update of dot and mark is a bit easier than in the above case, because the
 * split forces more updating.
 */
int
lnewline(void)
{
    register CELL   *cp1;
    register CELL   *cp2;
    register LINE   *lp1;
    register LINE   *lp2;
    register int    doto;
    register WINDOW *wp;

    if (curbp->b_mode&MDVIEW)   /* don't allow this command if  */
      return(rdonly()); /* we are in read only mode     */

    lchange(WFHARD);
    lp1  = curwp->w_dotp;                   /* Get the address and  */
    doto = curwp->w_doto;                   /* offset of "."        */
    if ((lp2=lalloc(doto)) == NULL)         /* New first half line  */
      return (FALSE);

    cp1 = &lp1->l_text[0];                  /* Shuffle text around  */
    cp2 = &lp2->l_text[0];
    while (cp1 != &lp1->l_text[doto])
      *cp2++ = *cp1++;

    cp2 = &lp1->l_text[0];
    while (cp1 != &lp1->l_text[lp1->l_used])
      *cp2++ = *cp1++;

    lp1->l_used -= doto;
    lp2->l_bp = lp1->l_bp;
    lp1->l_bp = lp2;
    lp2->l_bp->l_fp = lp2;
    lp2->l_fp = lp1;
    wp = wheadp;                            /* Windows              */
    while (wp != NULL) {
        if (wp->w_linep == lp1)
          wp->w_linep = lp2;

        if (wp->w_dotp == lp1) {
            if (wp->w_doto < doto)
              wp->w_dotp = lp2;
            else
              wp->w_doto -= doto;
        }

        if (wp->w_imarkp == lp1) {           /* ADDED for internal mark */
            if (wp->w_imarko < doto)
              wp->w_imarkp = lp2;
            else
              wp->w_imarko -= doto;
        }

        if (wp->w_markp == lp1) {
            if (wp->w_marko < doto)
              wp->w_markp = lp2;
            else
              wp->w_marko -= doto;
        }
        wp = wp->w_wndp;
    }

    /*
     * Keep track of the number of lines in the buffer.
     */
    ++curbp->b_linecnt;
    return (TRUE);
}


/*
 * This function deletes "n" characters, starting at dot. It understands how do deal
 * with end of lines, etc. It returns TRUE if all of the characters were
 * deleted, and FALSE if they were not (because dot ran into the end of the
 * buffer. The "preserve" function is used to save what was deleted.
 */
int
ldelete(long n, int (*preserve)(UCS))
{
    register CELL   *cp1;
    register CELL   *cp2;
    register LINE   *dotp;
    register int    doto;
    register int    chunk;
    register WINDOW *wp;

    if (curbp->b_mode&MDVIEW)   /* don't allow this command if  */
      return(rdonly()); /* we are in read only mode     */

    while (n != 0) {
        dotp = curwp->w_dotp;
        doto = curwp->w_doto;
        if (dotp == curbp->b_linep)     /* Hit end of buffer.   */
          return (FALSE);
        chunk = dotp->l_used-doto;      /* Size of chunk.       */
        if (chunk > n)
          chunk = n;
        if (chunk == 0) {               /* End of line, merge.  */
            lchange(WFHARD);
            if (ldelnewline() == FALSE
                || (preserve ? (*preserve)('\n') == FALSE : 0))
              return (FALSE);
            --n;
            continue;
        }

        lchange(WFEDIT);
        cp1 = &dotp->l_text[doto];      /* Scrunch text.        */
        cp2 = cp1 + chunk;
        if (preserve) {           /* Kill?                */
            while (cp1 != cp2) {
                if ((*preserve)(cp1->c) == FALSE)
                  return (FALSE);
                ++cp1;
            }
            cp1 = &dotp->l_text[doto];
        }

        while (cp2 != &dotp->l_text[dotp->l_used])
          *cp1++ = *cp2++;

        dotp->l_used -= chunk;
        wp = wheadp;                    /* Fix windows          */
        while (wp != NULL) {
            if (wp->w_dotp==dotp && wp->w_doto>=doto) {
                wp->w_doto -= chunk;
                if (wp->w_doto < doto)
                  wp->w_doto = doto;
            }

            if (wp->w_markp==dotp && wp->w_marko>=doto) {
                wp->w_marko -= chunk;
                if (wp->w_marko < doto)
                  wp->w_marko = doto;
            }

            if (wp->w_imarkp==dotp && wp->w_imarko>=doto) {
                wp->w_imarko -= chunk;
                if (wp->w_imarko < doto)
                  wp->w_imarko = doto;
            }

            wp = wp->w_wndp;
        }
        n -= chunk;
    }

#ifdef _WINDOWS
    if (preserve == kinsert && ksize() > 0)
      mswin_killbuftoclip (kremove);
#endif

    return (TRUE);
}

/*
 * Delete a newline. Join the current line with the next line. If the next line
 * is the magic header line always return TRUE; merging the last line with the
 * header line can be thought of as always being a successful operation, even
 * if nothing is done, and this makes the kill buffer work "right". Easy cases
 * can be done by shuffling data around. Hard cases require that lines be moved
 * about in memory. Return FALSE on error and TRUE if all looks ok. Called by
 * "ldelete" only.
 */
int
ldelnewline(void)
{
    register CELL   *cp1;
    register CELL   *cp2;
    register LINE   *lp1;
    register LINE   *lp2;
    register LINE   *lp3;
    register WINDOW *wp;

    if (curbp->b_mode&MDVIEW)   /* don't allow this command if  */
      return(rdonly()); /* we are in read only mode     */

    lp1 = curwp->w_dotp;
    lp2 = lp1->l_fp;
    if (lp2 == curbp->b_linep) {            /* At the buffer end.   */
        if (lp1->l_used == 0) {             /* Blank line.          */
            lfree(lp1);
            --curbp->b_linecnt;
        }

        return (TRUE);
    }

    if (lp2->l_used <= lp1->l_size-lp1->l_used) {
        cp1 = &lp1->l_text[lp1->l_used];
        cp2 = &lp2->l_text[0];
        while (cp2 != &lp2->l_text[lp2->l_used])
          *cp1++ = *cp2++;

        wp = wheadp;
        while (wp != NULL) {
            if (wp->w_linep == lp2)
              wp->w_linep = lp1;
            if (wp->w_dotp == lp2) {
                wp->w_dotp  = lp1;
                wp->w_doto += lp1->l_used;
            }
            if (wp->w_markp == lp2) {
                wp->w_markp  = lp1;
                wp->w_marko += lp1->l_used;
            }
            if (wp->w_imarkp == lp2) {
                wp->w_imarkp  = lp1;
                wp->w_imarko += lp1->l_used;
            }
            wp = wp->w_wndp;
        }
        lp1->l_used += lp2->l_used;
        lp1->l_fp = lp2->l_fp;
        lp2->l_fp->l_bp = lp1;
        free((char *) lp2);
        --curbp->b_linecnt;
        return (TRUE);
    }

    if ((lp3=lalloc(lp1->l_used+lp2->l_used)) == NULL)
      return (FALSE);

    cp1 = &lp1->l_text[0];
    cp2 = &lp3->l_text[0];
    while (cp1 != &lp1->l_text[lp1->l_used])
      *cp2++ = *cp1++;

    cp1 = &lp2->l_text[0];
    while (cp1 != &lp2->l_text[lp2->l_used])
      *cp2++ = *cp1++;

    lp1->l_bp->l_fp = lp3;
    lp3->l_fp = lp2->l_fp;
    lp2->l_fp->l_bp = lp3;
    lp3->l_bp = lp1->l_bp;
    wp = wheadp;
    while (wp != NULL) {
        if (wp->w_linep==lp1 || wp->w_linep==lp2)
          wp->w_linep = lp3;
        if (wp->w_dotp == lp1)
          wp->w_dotp  = lp3;
        else if (wp->w_dotp == lp2) {
            wp->w_dotp  = lp3;
            wp->w_doto += lp1->l_used;
        }
        if (wp->w_markp == lp1)
          wp->w_markp  = lp3;
        else if (wp->w_markp == lp2) {
            wp->w_markp  = lp3;
            wp->w_marko += lp1->l_used;
        }
        if (wp->w_imarkp == lp1)
          wp->w_imarkp  = lp3;
        else if (wp->w_imarkp == lp2) {
            wp->w_imarkp  = lp3;
            wp->w_imarko += lp1->l_used;
        }
        wp = wp->w_wndp;
    }

    free((char *) lp1);
    free((char *) lp2);
    --curbp->b_linecnt;
    return (TRUE);
}


/*
 * Tell the caller if the given line is blank or not.
 */
int
lisblank(LINE *line)
{
    int n = 0;
    UCS qstr[NLINE];

    n = (glo_quote_str
         && quote_match(glo_quote_str, line, qstr, NLINE))
          ? ucs4_strlen(qstr) : 0;

    for(; n < llength(line); n++)
      if(!ucs4_isspace(lgetc(line, n).c) 
          || lgetc(line, n).c >= 0xff 
          || (unsigned char) lgetc(line,n).c != (unsigned char) NBSPC)
        return(FALSE);

    return(TRUE);
}


/*
 * Delete all of the text saved in the kill buffer. Called by commands when a
 * new kill context is being created. The kill buffer array is released, just
 * in case the buffer has grown to immense size. No errors.
 */
void
kdelete(void)
{
    pkbufdel(&kbufp);
}

void
fdelete(void)
{
    pkbufdel(&fbufp);
}

void
pkbufdel(struct pkbuf **buf)
{
    if (*buf) {
        pkchunkdel(&(*buf)->first);
        free((char *) *buf);
        *buf = NULL;
    }
}


void
pkchunkdel(struct pkchunk **chunk)
{
    if(chunk){
        if((*chunk)->next)
          pkchunkdel(&(*chunk)->next);

        free((char *) *chunk);
        *chunk = NULL;
    }
}


/*
 * Insert a character to the kill buffer, enlarging the buffer if there isn't
 * any room. Always grow the buffer in chunks, on the assumption that if you
 * put something in the kill buffer you are going to put more stuff there too
 * later. Return TRUE if all is well, and FALSE on errors.
 */
int
kinsert(UCS c)
{
    return(pkbufinsert(c, &kbufp));
}

int
finsert(UCS c)
{
    return(pkbufinsert(c, &fbufp));
}

int
pkbufinsert(UCS c, struct pkbuf **buf)
{
    if(!*buf){
        if((*buf = (struct pkbuf *) malloc(sizeof(struct pkbuf))) != NULL)
          memset(*buf, 0, sizeof(struct pkbuf));
        else
          return(FALSE);
    }

    if((*buf)->total % KBLOCK == 0){
        struct pkchunk *p = (*buf)->last;
        if(((*buf)->last = (struct pkchunk *) malloc(sizeof(struct pkchunk))) != NULL){
            memset((*buf)->last, 0, sizeof(struct pkchunk));
            if(p)
              p->next = (*buf)->last;
            else
              (*buf)->first = (*buf)->last;
        }
        else
          return(FALSE);
    }

    (*buf)->last->bufp[(*buf)->last->used++] = c;
    (*buf)->total++;
    return (TRUE);
}


/*
 * These functions get characters from the requested buffer. If the
 * character index "n" is off the end, it returns "-1". This lets the
 * caller just scan along until it gets a "-1" back.
 */
long
kremove(int n)
{
    return(pkbufremove(n, kbufp));
}

long
fremove(int n)
{
    return(pkbufremove(n, fbufp));
}


/*
 * This would be type UCS except that it needs to return -1.
 */
long
pkbufremove(int n, struct pkbuf *buf)
{
    if(n >= 0 && buf && n < buf->total){
        register struct pkchunk *p = buf->first;
        int                      block = n / KBLOCK;

        while(block--)
          if(!(p = p->next))
            return(-1);

        return(p->bufp[n % KBLOCK]);
    }
    else
      return(-1);
}


/*
 * This function just returns the current size of the kill buffer
 */
int
ksize(void)
{
    return(kbufp ? (int) kbufp->total : 0);
}


static REGION last_region_added;

void
set_last_region_added(REGION *region)
{
    if(region)
      last_region_added = (*region);
    else
      memset(&last_region_added, 0, sizeof(last_region_added));
}


REGION *
get_last_region_added(void)
{
    return(&last_region_added);
}