lib/libedit/hist.h

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