main/editline/hist.h

   1 /*      $NetBSD: hist.h,v 1.7 2002/03/18 16:00:53 christos Exp $        */
   2
   3 /*-
   4  * Copyright (c) 1992, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Christos Zoulas of Cornell University.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)hist.h      8.1 (Berkeley) 6/4/93
  39  */
  40
  41 /*
  42  * el.hist.c: History functions
  43  */
  44 #ifndef _h_el_hist
  45 #define _h_el_hist
  46
  47 #include "histedit.h"
  48
  49 typedef int (*hist_fun_t)(ptr_t, HistEvent *, int, ...);
  50
  51 typedef struct el_history_t {
  52         char            *buf;           /* The history buffer           */
  53         size_t          sz;             /* Size of history buffer       */
  54         char            *last;          /* The last character           */
  55         int              eventno;       /* Event we are looking for     */
  56         ptr_t            ref;           /* Argument for history fcns    */
  57         hist_fun_t       fun;           /* Event access                 */
  58         HistEvent        ev;            /* Event cookie                 */
  59 } el_history_t;
  60
  61 #define HIST_FUN(el, fn, arg)   \
  62     ((((*(el)->el_history.fun) ((el)->el_history.ref, &(el)->el_history.ev, \
  63         fn, arg)) == -1) ? NULL : (el)->el_history.ev.str)
  64
  65 #define HIST_NEXT(el)           HIST_FUN(el, H_NEXT, NULL)
  66 #define HIST_FIRST(el)          HIST_FUN(el, H_FIRST, NULL)
  67 #define HIST_LAST(el)           HIST_FUN(el, H_LAST, NULL)
  68 #define HIST_PREV(el)           HIST_FUN(el, H_PREV, NULL)
  69 #define HIST_EVENT(el, num)     HIST_FUN(el, H_EVENT, num)
  70 #define HIST_LOAD(el, fname)    HIST_FUN(el, H_LOAD fname)
  71 #define HIST_SAVE(el, fname)    HIST_FUN(el, H_SAVE fname)
  72
  73 protected int           hist_init(EditLine *);
  74 protected void          hist_end(EditLine *);
  75 protected el_action_t   hist_get(EditLine *);
  76 protected int           hist_set(EditLine *, hist_fun_t, ptr_t);
  77 protected int           hist_list(EditLine *, int, const char **);
  78 protected int           hist_enlargebuf(EditLine *, size_t, size_t);
  79
  80 #endif /* _h_el_hist */