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. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * @(#)hist.h   8.1 (Berkeley) 6/4/93
  33  * $NetBSD: hist.h,v 1.10 2003/08/07 16:44:31 agc Exp $
  34  * $DragonFly: src/lib/libedit/hist.h,v 1.4 2005/11/13 12:58:30 corecode Exp $
  35  */
  36
  37 /*
  38  * el.hist.c: History functions
  39  */
  40 #ifndef _h_el_hist
  41 #define _h_el_hist
  42
  43 #include "histedit.h"
  44
  45 typedef int (*hist_fun_t)(ptr_t, HistEvent *, int, ...);
  46
  47 typedef struct el_history_t {
  48         char            *buf;           /* The history buffer           */
  49         size_t          sz;             /* Size of history buffer       */
  50         char            *last;          /* The last character           */
  51         int              eventno;       /* Event we are looking for     */
  52         ptr_t            ref;           /* Argument for history fcns    */
  53         hist_fun_t       fun;           /* Event access                 */
  54         HistEvent        ev;            /* Event cookie                 */
  55 } el_history_t;
  56
  57 #define HIST_FUN(el, fn, arg)   \
  58     ((((*(el)->el_history.fun) ((el)->el_history.ref, &(el)->el_history.ev, \
  59         fn, arg)) == -1) ? NULL : (el)->el_history.ev.str)
  60
  61 #define HIST_NEXT(el)           HIST_FUN(el, H_NEXT, NULL)
  62 #define HIST_FIRST(el)          HIST_FUN(el, H_FIRST, NULL)
  63 #define HIST_LAST(el)           HIST_FUN(el, H_LAST, NULL)
  64 #define HIST_PREV(el)           HIST_FUN(el, H_PREV, NULL)
  65 #define HIST_SET(el, num)       HIST_FUN(el, H_SET, num)
  66 #define HIST_LOAD(el, fname)    HIST_FUN(el, H_LOAD fname)
  67 #define HIST_SAVE(el, fname)    HIST_FUN(el, H_SAVE fname)
  68
  69 protected int           hist_init(EditLine *);
  70 protected void          hist_end(EditLine *);
  71 protected el_action_t   hist_get(EditLine *);
  72 protected int           hist_set(EditLine *, hist_fun_t, ptr_t);
  73 protected int           hist_command(EditLine *, int, const char **);
  74 protected int           hist_enlargebuf(EditLine *, size_t, size_t);
  75
  76 #endif /* _h_el_hist */