histedit.h

Go to the documentation of this file.

// @(#)root/editline:$Id: histedit.h 30194 2009-09-16 12:19:46Z axel $
// Author: Mary-Louise Gill, 2009

/*************************************************************************
 * Copyright (C) 1995-2009, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/

/*      $NetBSD: histedit.fH,v 1.16 2000/09/04 22:06:30 lukem Exp $     */

/*-
 * Copyright (c) 1992, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Christos Zoulas of Cornell University.
 *
 * 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.
 */

/*
 * histedit.fH: Line editor and history interface.
 */
#ifndef _HISTEDIT_H_
#define _HISTEDIT_H_

#include <sys/types.h>
#include <stdio.h>

/*
 * ==== Editing ====
 */
struct EditLine_t;

/*
 * For user-defined function interface
 */
struct LineInfo_t {
   const char* fBuffer;
   const char* fCursor;
   const char* fLastChar;
};


/*
 * EditLine_t editor function return codes.
 * For user-defined function interface
 */
#define CC_NORM 0
#define CC_NEWLINE 1
#define CC_EOF 2
#define CC_ARGHACK 3
#define CC_REFRESH 4
#define CC_CURSOR 5
#define CC_ERROR 6
#define CC_FATAL 7
#define CC_REDISPLAY 8
#define CC_REFRESH_BEEP 9

/*
 * Initialization, cleanup, and resetting
 */


EditLine_t* el_init(const char*, FILE*, FILE*, FILE*);
void el_reset(EditLine_t*);
void el_end(EditLine_t*);


/*
 * Get a line, a character or push a string back in the input queue
 *
 * Note that el_gets() returns the trailing newline!
 */
const char* el_gets(EditLine_t*, int*);
const char* el_gets_newline(EditLine_t*, int*);
bool el_eof(EditLine_t*);
int el_getc(EditLine_t*, char*);
void el_push(EditLine_t*, const char*);

/*
 * Beep!
 */
void el_beep(EditLine_t*);

/*
 * High level function internals control
 * Parses argc, argv array and executes builtin editline commands
 */
int el_parse(EditLine_t*, int, const char**);

/*
 * Low level editline access functions
 */
int el_set(EditLine_t*, int, ...);
int el_get(EditLine_t*, int, void*);

/*
 * el_set/el_get parameters
 */
#define EL_PROMPT 0             /* , ElPFunc_t);                */
#define EL_TERMINAL 1           /* , const char *);             */
#define EL_EDITOR 2             /* , const char *);             */
#define EL_SIGNAL 3             /* , int);                      */
#define EL_BIND 4               /* , const char *, ..., NULL);  */
#define EL_TELLTC 5             /* , const char *, ..., NULL);  */
#define EL_SETTC 6              /* , const char *, ..., NULL);  */
#define EL_ECHOTC 7             /* , const char *, ..., NULL);  */
#define EL_SETTY 8              /* , const char *, ..., NULL);  */
#define EL_ADDFN 9              /* , const char *, const char * */
                                /* , ElFunc_t);         */
#define EL_HIST 10              /* , HistFun_t, const char *);  */
#define EL_EDITMODE 11          /* , int);                      */
#define EL_RPROMPT 12           /* , ElPFunc_t);                */

/*
 * Source named file or $PWD/.editrc or $HOME/.editrc
 */
int el_source(EditLine_t*, const char*);

/*
 * Must be called when the terminal changes size; If EL_SIGNAL
 * is set this is done automatically otherwise it is the responsibility
 * of the application
 */
void el_resize(EditLine_t*);


/*
 * User-defined function interface.
 */
const LineInfo_t* el_line(EditLine_t*);
int el_insertstr(EditLine_t*, const char*);
void el_deletestr(EditLine_t*, int);

/*
 * ==== HistoryFcns_t ====
 */

struct HistoryFcns_t;

struct HistEvent_t {
   int fNum;
   const char* fStr;
};

/*
 * HistoryFcns_t access functions.
 */
HistoryFcns_t* history_init(void);
void history_end(HistoryFcns_t*);

int history(HistoryFcns_t*, HistEvent_t*, int, ...);

#define H_FUNC 0                /* , UTSL               */
#define H_SETSIZE 1             /* , const int);        */
#define H_GETSIZE 2             /* , void);             */
#define H_FIRST 3               /* , void);             */
#define H_LAST 4                /* , void);             */
#define H_PREV 5                /* , void);             */
#define H_NEXT 6                /* , void);             */
#define H_CURR 8                /* , const int);        */
#define H_SET 7                 /* , void);             */
#define H_ADD 9                 /* , const char *);     */
#define H_ENTER 10              /* , const char *);     */
#define H_APPEND 11             /* , const char *);     */
#define H_END 12                /* , void);             */
#define H_NEXT_STR 13           /* , const char *);     */
#define H_PREV_STR 14           /* , const char *);     */
#define H_NEXT_EVENT 15         /* , const int);        */
#define H_PREV_EVENT 16         /* , const int);        */
#define H_LOAD 17               /* , const char *);     */
#define H_SAVE 18               /* , const char *);     */
#define H_CLEAR 19              /* , void);             */

#endif /* _HISTEDIT_H_ */

---