Add GNU LGPL headers to all .c .C and .h files
[oweals/cde.git] / cde / programs / dtksh / ksh93 / src / cmd / ksh93 / include / history.h
1 /*
2  * CDE - Common Desktop Environment
3  *
4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
5  *
6  * These libraries and programs are free software; you can
7  * redistribute them and/or modify them under the terms of the GNU
8  * Lesser General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * These libraries and programs are distributed in the hope that
13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15  * PURPOSE. See the GNU Lesser General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with these librararies and programs; if not, write
20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
21  * Floor, Boston, MA 02110-1301 USA
22  */
23 /* $XConsortium: history.h /main/3 1995/11/01 16:40:17 rswiston $ */
24 /***************************************************************
25 *                                                              *
26 *                      AT&T - PROPRIETARY                      *
27 *                                                              *
28 *        THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF        *
29 *                    AT&T BELL LABORATORIES                    *
30 *         AND IS NOT TO BE DISCLOSED OR USED EXCEPT IN         *
31 *            ACCORDANCE WITH APPLICABLE AGREEMENTS             *
32 *                                                              *
33 *                Copyright (c) 1995 AT&T Corp.                 *
34 *              Unpublished & Not for Publication               *
35 *                     All Rights Reserved                      *
36 *                                                              *
37 *       The copyright notice above does not evidence any       *
38 *      actual or intended publication of such source code      *
39 *                                                              *
40 *               This software was created by the               *
41 *           Advanced Software Technology Department            *
42 *                    AT&T Bell Laboratories                    *
43 *                                                              *
44 *               For further information contact                *
45 *                    {research,attmail}!dgk                    *
46 *                                                              *
47 ***************************************************************/
48
49 /* : : generated by proto : : */
50                   
51 #ifndef HIST_VERSION
52 #if !defined(__PROTO__)
53 #if defined(__STDC__) || defined(__cplusplus) || defined(_proto) || defined(c_plusplus)
54 #if defined(__cplusplus)
55 #define __MANGLE__      "C"
56 #else
57 #define __MANGLE__
58 #endif
59 #define __STDARG__
60 #define __PROTO__(x)    x
61 #define __OTORP__(x)
62 #define __PARAM__(n,o)  n
63 #if !defined(__STDC__) && !defined(__cplusplus)
64 #if !defined(c_plusplus)
65 #define const
66 #endif
67 #define signed
68 #define void            int
69 #define volatile
70 #define __V_            char
71 #else
72 #define __V_            void
73 #endif
74 #else
75 #define __PROTO__(x)    ()
76 #define __OTORP__(x)    x
77 #define __PARAM__(n,o)  o
78 #define __MANGLE__
79 #define __V_            char
80 #define const
81 #define signed
82 #define void            int
83 #define volatile
84 #endif
85 #if defined(__cplusplus) || defined(c_plusplus)
86 #define __VARARG__      ...
87 #else
88 #define __VARARG__
89 #endif
90 #if defined(__STDARG__)
91 #define __VA_START__(p,a)       va_start(p,a)
92 #else
93 #define __VA_START__(p,a)       va_start(p)
94 #endif
95 #endif
96
97 /*
98  *      Interface for history mechanism
99  *      written by David Korn
100  *
101  */
102
103 #include        <ast.h>
104 #include        <sfio.h>
105
106 #define HIST_CHAR       '!'
107 #define HIST_VERSION    1               /* history file format version no. */
108
109 typedef struct 
110 {
111         Sfdisc_t        histdisc;       /* discipline for history */
112         Sfio_t          *histfp;        /* history file stream pointer */
113         char            *histname;      /* name of history file */
114         long            histind;        /* current command number index */
115         int             histsize;       /* number of accessible history lines */
116 #ifdef _HIST_PRIVATE
117         _HIST_PRIVATE
118 #endif /* _HIST_PRIVATE */
119 } History_t;
120
121 typedef struct
122 {
123         int hist_command;
124         int hist_line;
125         int hist_char;
126 } Histloc_t;
127
128 /* the following are readonly */
129 extern __MANGLE__ const char    hist_fname[];
130
131 extern __MANGLE__ int _Hist;
132 #define hist_min(hp)    ((_Hist=((int)((hp)->histind-(hp)->histsize)))>=0?_Hist:0)
133 #define hist_max(hp)    ((int)((hp)->histind))
134 /* these are the history interface routines */
135 extern __MANGLE__ int           sh_histinit __PROTO__((void));
136 extern __MANGLE__ void          hist_cancel __PROTO__((History_t*));
137 extern __MANGLE__ void          hist_close __PROTO__((History_t*));
138 extern __MANGLE__ int           hist_copy __PROTO__((char*, int, int, int));
139 extern __MANGLE__ void          hist_eof __PROTO__((History_t*));
140 extern __MANGLE__ Histloc_t     hist_find __PROTO__((History_t*,char*,int, int, int));
141 extern __MANGLE__ void          hist_flush __PROTO__((History_t*));
142 extern __MANGLE__ void          hist_list __PROTO__((History_t*,Sfio_t*, off_t, int, char*));
143 extern __MANGLE__ int           hist_match __PROTO__((History_t*,off_t, char*, int*));
144 extern __MANGLE__ off_t         hist_tell __PROTO__((History_t*,int));
145 extern __MANGLE__ off_t         hist_seek __PROTO__((History_t*,int));
146 extern __MANGLE__ char          *hist_word __PROTO__((char*, int, int));
147 #ifdef SHOPT_ESH
148     extern __MANGLE__ Histloc_t hist_locate __PROTO__((History_t*,int, int, int));
149 #endif  /* SHOPT_ESH */
150
151 #endif /* HIST_VERSION */