uifc.h 18.1 KB
Newer Older
1
/* uifc.h */
2
3
4

/* Rob Swindell's Text-mode User Interface Library */

5
6
7
8
9
10
/* $Id$ */

/****************************************************************************
 * @format.tab-size 4		(Plain Text/Source Code File Header)			*
 * @format.use-tabs true	(see http://www.synchro.net/ptsc_hdr.html)		*
 *																			*
11
 * Copyright 2005 Rob Swindell - http://www.synchro.net/copyright.html		*
12
 *																			*
rswindell's avatar
rswindell committed
13
14
 * This library is free software; you can redistribute it and/or			*
 * modify it under the terms of the GNU Lesser General Public License		*
15
16
 * as published by the Free Software Foundation; either version 2			*
 * of the License, or (at your option) any later version.					*
rswindell's avatar
rswindell committed
17
18
 * See the GNU Lesser General Public License for more details: lgpl.txt or	*
 * http://www.fsf.org/copyleft/lesser.html									*
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 *																			*
 * Anonymous FTP access to the most recent released source is available at	*
 * ftp://vert.synchro.net, ftp://cvs.synchro.net and ftp://ftp.synchro.net	*
 *																			*
 * Anonymous CVS access to the development source and modification history	*
 * is available at cvs.synchro.net:/cvsroot/sbbs, example:					*
 * cvs -d :pserver:anonymous@cvs.synchro.net:/cvsroot/sbbs login			*
 *     (just hit return, no password is necessary)							*
 * cvs -d :pserver:anonymous@cvs.synchro.net:/cvsroot/sbbs checkout src		*
 *																			*
 * For Synchronet coding style and modification guidelines, see				*
 * http://www.synchro.net/source.html										*
 *																			*
 * You are encouraged to submit any modifications (preferably in Unix diff	*
 * format) via e-mail to mods@synchro.net									*
 *																			*
 * Note: If this box doesn't appear square, then you need to fix your tabs.	*
 ****************************************************************************/
37

deuce's avatar
deuce committed
38
39
40
#ifndef _UIFC_H_
#define _UIFC_H_

41
42
43
44
45
46
47
#include <time.h>
#include <fcntl.h>
#include <ctype.h>
#include <stdio.h>
#include <string.h>
#include <stdarg.h>
#include <stdlib.h>
rswindell's avatar
rswindell committed
48
/* OS Specific */
49
50
51
#if defined(_WIN32)
    #include <windows.h>
#endif
52
53
#if defined(__unix__)
	#include <sys/param.h>	/* PATH_MAX */
54
#endif
55

rswindell's avatar
rswindell committed
56
57
#if defined(__unix__) && !defined(stricmp)
    #define stricmp strcasecmp
58
	#define strnicmp strncasecmp
rswindell's avatar
rswindell committed
59
#endif
60

deuce's avatar
deuce committed
61
#if !defined(FREE_AND_NULL)
deuce's avatar
deuce committed
62
	#define FREE_AND_NULL(x)			if(x!=NULL) { free(x); x=NULL; }
deuce's avatar
deuce committed
63
#endif
64

rswindell's avatar
rswindell committed
65
66
67
68
69
70
71
72
73
74
75
76
#if !defined(MAX_PATH)	/* maximum path length */
	#if defined MAXPATHLEN
		#define MAX_PATH MAXPATHLEN	/* clib.h */
	#elif defined PATH_MAX
		#define MAX_PATH PATH_MAX
	#elif defined _MAX_PATH
		#define MAX_PATH _MAX_PATH
	#else
		#define MAX_PATH 260		
	#endif
#endif

deuce's avatar
deuce committed
77
78
79
80
81
82
83
84
85
#define MAX_OPTS	10000
#define MSK_ON		0xf0000000
#define MSK_OFF 	0x0fffffff
#define MSK_INS 	0x10000000
#define MSK_DEL 	0x20000000
#define MSK_GET 	0x30000000
#define MSK_PUT 	0x40000000
#define MSK_EDIT 	0x50000000
/* Dont forget, negative return values are used for extended keys (if WIN_EXTKEYS used)! */
86
87
#define MAX_OPLN	75		/* Maximum length of each option per menu call */
#define MAX_BUFS	7		/* Maximum number of screen buffers to save */
88
#define MIN_LINES   14      /* Minimum number of screen lines supported */
89
90
#define MAX_LINES   60      /* Maximum number of screen rows supported */ 
#define MAX_BFLN	80*MAX_LINES*2	/* Maximum size of screen buffers */
91
92
93
94
95

#ifndef uint
#define uint unsigned int
#endif

96
							/**************************/
97
                            /* Bits in uifcapi_t.mode */
98
							/**************************/
99
100
101
102
#define UIFC_INMSG	(1<<0)	/* Currently in Message Routine non-recursive */
#define UIFC_MOUSE	(1<<1)	/* Mouse installed and available */
#define UIFC_MONO	(1<<2)	/* Force monochrome mode */
#define UIFC_COLOR	(1<<3)	/* Force color mode */
103
#define UIFC_IBM	(1<<4)	/* Force use of IBM charset	*/
104
105
106
#define UIFC_NOCTRL	(1<<5)	/* Don't allow useage of CTRL keys for movement 
							 * etc in menus (Still available in text boxes) */

107
108
109
							/*******************************/
                            /* Bits in uifcapi_t.list mode */
							/*******************************/
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
#define WIN_ORG 	(1<<0)	/* Original menu - destroy valid screen area */
#define WIN_SAV 	(1<<1)	/* Save existing text and replace when finished */
#define WIN_ACT 	(1<<2)	/* Menu remains active after a selection */
#define WIN_L2R 	(1<<3)	/* Center the window based on 'width'   */
#define WIN_T2B 	(1<<4)	/* Center the window based on 'height'  */
#define WIN_INS 	(1<<5)	/* Allows user to user insert key */
#define WIN_INSACT	(1<<6)	/* Remains active after insert key */
#define WIN_DEL 	(1<<7)	/* Allows user to use delete key */
#define WIN_DELACT	(1<<8)	/* Remains active after delete key */
#define WIN_ESC 	(1<<9)	/* Screen is active when escape is hit			 */
#define WIN_RHT 	(1<<10) /* Place window against right side of screen */
#define WIN_BOT 	(1<<11) /* Place window against botton of screen */
#define WIN_GET 	(1<<12) /* Allows F5 to Get a menu item */
#define WIN_PUT 	(1<<13) /* Allows F6 to Put a menu item */
#define WIN_CHE 	(1<<14) /* Stay active after escape if changes */
#define WIN_XTR 	(1<<15) /* Add extra line at end for inserting at end */
126
127
128
#define WIN_DYN 	(1<<16) /* Dynamic window - return at least every second */
#define WIN_HLP 	(1<<17) /* Parse 'Help codes' */
#define WIN_PACK 	(1<<18) /* Pack text in window (No padding) */
129
130
#define WIN_IMM 	(1<<19) /* Draw window and return immediately */
#define WIN_FAT		(1<<20)	/* Do not pad outside borders */
131
132
#define WIN_REDRAW	(1<<21) /* Force redraw on dynamic window */
#define WIN_NODRAW	(1<<22) /* Force not to redraw on dynamic window */
deuce's avatar
deuce committed
133
#define WIN_EXTKEYS	(1<<23) /* Return on any keypress... if it's not handled internally
134
135
							 * Return value is -2 - keyvalue */
#define WIN_NOBRDR	(1<<24)	/* Do not draw a border around the window */
136
#define WIN_FIXEDHEIGHT	(1<<25)	/* Use list_height from uifc struct */
137
138
#define WIN_UNGETMOUSE  (1<<26) /* If the mouse is clicked outside the window, */
								/* Put the mouse event back into the event queue */
139
140
#define WIN_EDIT	(1<<27)	/* Allow F2 to edit a menu item */
#define WIN_EDITACT	(1<<28)	/* Remain active after edit key */
141
#define WIN_INACT	(1<<29)	/* Draw window inactive... intended for use with WIN_IMM */
142
143
144
145
#define WIN_POP		(1<<30)	/* Exit the list. Act as though ESC was pressed. */
							/* Intended for use after a WIN_EXTKEYS or WIN_DYN */
#define WIN_SEL		(1<<31)	/* Exit the list. Act as though ENTER was pressed. */
							/* Intended for use after a WIN_EXTKEYS or WIN_DYN */
146
147
148
149
150

#define WIN_MID WIN_L2R|WIN_T2B  /* Place window in middle of screen */

#define SCRN_TOP	3
#define SCRN_LEFT	5
151
#define SCRN_RIGHT 	((int)api->scrn_width-4)
152
153
154
155
156
157
158
159
160
161
162
163
164

								/* Bits in 'mode' for getkey and getstr     */
#define K_UPPER 	(1L<<0) 	/* Converts all letters to upper case		*/
#define K_UPRLWR	(1L<<1) 	/* Upper/Lower case automatically			*/
#define K_NUMBER	(1L<<2) 	/* Allow numbers only						*/
#define K_WRAP		(1L<<3) 	/* Allows word wrap 						*/
#define K_MSG		(1L<<4) 	/* Allows ANSI, ^N ^A ^G					*/
#define K_SPIN		(1L<<5) 	/* Spinning cursor (same as SPIN)			*/
#define K_LINE		(1L<<6) 	/* Input line (inverse color)				*/
#define K_EDIT		(1L<<7) 	/* Edit string passed						*/
#define K_CHAT		(1L<<8) 	/* In chat multi-chat						*/
#define K_NOCRLF	(1L<<9) 	/* Don't print CRLF after string input      */
#define K_ALPHA 	(1L<<10)	/* Only allow alphabetic characters 		*/
165
#define K_SCANNING	(1L<<11)	/* UPC Scanner is active... return on '%'	*/
166
#define K_TABEXIT	(1L<<12)	/* Return on TAB or BACKTAB			    	*/
167
#define K_DECIMAL	(1L<<13)	/* Allow floating point numbers only		*/
168
169
#define K_DEUCEEXIT	(1L<<14)	/* Return whenever Deuce wants to exit		*/
								/* Returns on up/down/F2					*/
170
171
172
#define K_MOUSEEXIT	(1L<<15)	/* Returns when mouse is clicked outside of */
								/* Input area (NOT outside of window!)		*/
								/* And ungets the mouse event.				*/
173
#define K_PASSWORD	(1L<<16)	/* Does not display text while editing		*/
174

175
176
177
178
179
180
						/* Bottom line elements */
#define BL_INS      (1<<0)  /* INS key */
#define BL_DEL      (1<<1)  /* DEL key */
#define BL_GET      (1<<2)  /* Get key */
#define BL_PUT      (1<<3)  /* Put key */
#define BL_EDIT     (1<<4)  /* Edit key */
181
#define BL_HELP     (1<<5)  /* Help key */
182

183
184
#define HELPBUF_SIZE 4000

185
#ifndef _GEN_DEFS_H
186
187
188
									/* Control characters */
#define STX 	0x02				/* Start of text			^B	*/
#define ETX 	0x03				/* End of text				^C	*/
189
190
191
#define BS		'\b'				/* Back space				^H	*/
#define TAB 	'\t'				/* Horizontal tabulation	^I	*/
#define LF		'\n'				/* Line feed				^J	*/
192
#define FF		0x0c				/* Form feed				^L	*/
193
#define CR		'\r'				/* Carriage return			^M	*/
194
#define ESC 	0x1b				/* Escape					^[	*/
195
#define DEL     0x7f                /* Delete                   ^BS */
196

197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
enum {
	 CTRL_A=1
	,CTRL_B
	,CTRL_C
	,CTRL_D	
	,CTRL_E
	,CTRL_F
	,CTRL_G
	,CTRL_H
	,CTRL_I
	,CTRL_J
	,CTRL_K
	,CTRL_L
	,CTRL_M
	,CTRL_N
	,CTRL_O
	,CTRL_P
	,CTRL_Q
	,CTRL_R
	,CTRL_S
	,CTRL_T
	,CTRL_U
	,CTRL_V
	,CTRL_W
	,CTRL_X
	,CTRL_Y
	,CTRL_Z
};

226
#endif
227
228
229
230
231
232
233
234
235
236
237

#ifndef uchar				/* Short-hand for unsigned data types */
#define uchar unsigned char
#endif
#ifndef uint
#define uint unsigned int
#endif
#ifndef ulong
#define ulong unsigned long
#endif

238
239
#ifndef BOOL
#define BOOL    int
deuce's avatar
deuce committed
240
#ifndef TRUE
241
#define TRUE    1
deuce's avatar
deuce committed
242
243
#endif
#ifndef FALSE
244
245
#define FALSE   0
#endif
deuce's avatar
deuce committed
246
#endif
247
248

typedef struct {
249
	int		left,top,right,bot;
250
	int		*cur,*bar;
251
    uchar*	buf;
252
} win_t;
253

254
typedef struct {
255
256
257
/****************************************************************************/
/* Size of the structure (for version compatibility verification).			*/
/****************************************************************************/
258
    size_t  size;
259
260
261
/****************************************************************************/
/* Controls general UIFC library behavior.									*/
/****************************************************************************/
262
    long    mode;
263
264
265
/****************************************************************************/
/* Set to TRUE when changes to data have been made by input function.		*/ 
/****************************************************************************/
266
    BOOL    changes;
267
268
269
/****************************************************************************/
/* The overlapped-window save buffer number.								*/
/****************************************************************************/
270
    uint    savnum;
271
272
273
274
275
276
277
/****************************************************************************/
/* The current overlapped-window save buffer depth.							*/
/****************************************************************************/
    uint    savdepth;
/****************************************************************************/
/* Screen length															*/
/****************************************************************************/
278
    uint    scrn_len;
279
/****************************************************************************/
280
281
282
283
/* Screen Width 															*/
/****************************************************************************/
    uint    scrn_width;
/****************************************************************************/
284
285
286
287
/* ESC key delay for curses													*/
/****************************************************************************/
    uint    esc_delay;
/****************************************************************************/
288
289
/* Alternative method of setting current help text.							*/
/****************************************************************************/
290
    char*   helpbuf;
291
292
293
/****************************************************************************/
/* Location of the help data and index files.								*/
/****************************************************************************/
294
295
    char    helpdatfile[MAX_PATH+1];
    char    helpixbfile[MAX_PATH+1];
296
/****************************************************************************/
297
298
299
300
301
302
303
304
/* Help and exit button locations for current/last window					*/
/****************************************************************************/
	int		buttony;
	int		exitstart;
	int		exitend;
	int		helpstart;
	int		helpend;
/****************************************************************************/
305
306
307
/* List height for WIN_FIXEDHEIGHT lists.									*/
/****************************************************************************/
	int		list_height;
308
309
310
311

/****************************************************************************/
/* Colours for the various bits												*/
/****************************************************************************/
312
	uchar	hclr,lclr,bclr,cclr,lbclr;
313

314
315
316
317
318
/****************************************************************************/
/* Have we initialized successfully?										*/
/****************************************************************************/
	BOOL	initialized;

319
/****************************************************************************/
320
321
/* Exit/uninitialize function.												*/
/****************************************************************************/
322
    void    (*bail) (void);
323
324
325
326
327
/****************************************************************************/
/* Fill the screen with the appropriate background attribute.				*/
/* str is the title for the application banner.								*/
/* Returns 0 on success, non-zero on failure.								*/
/****************************************************************************/
328
    int     (*scrn) (char* str);
329
330
331
/****************************************************************************/
/* Popup a message, maybe wait for the user to hit a key or click button.	*/
/****************************************************************************/
332
    void    (*msg)  (char* str);
333
334
335
336
337
/****************************************************************************/
/* Popup/down a status message.												*/
/* str is the message to display on popup.									*/
/* if str==NULL, then the the status is to be cleared (popdown).			*/
/****************************************************************************/
338
    void    (*pop)  (char* str);
339
340
341
342
343
344
345
346
/****************************************************************************/
/* General menu function.													*/
/* mode contains WIN_* flags to control display and functionality.			*/
/* left, top and width specify desired screen locations and window size.	*/
/* cur is a pointer to the current (default) option.						*/
/* bar is a pointer to the current location of the lightbar (which used).	*/
/* title is the caption for the menu.										*/
/* Menus can centered left to right and top to bottom automatically.		*/
347
/* mode bits are set with macros WIN_*.										*/
348
349
350
/* option is an array of char arrays, first element of last char array		*/
/* must be NULL.															*/
/* Returns the 0-based selected option number, -1 for ESC, or the selected	*/
351
/* option number OR'd with MSK_INS, MSK_DEL, MSK_GET, MSK_PUT, or MSK_EDIT.	*/
352
/****************************************************************************/
353
    int     (*list) (int mode, int left, int top, int width, int* dflt
354
                        ,int* bar, char *title, char** option);
355
356
357
358
359
360
/****************************************************************************/
/* Windowed string input routine.											*/
/* mode contains WIN_* flags to control display and functionality.			*/
/* left and top specify desired screen location.							*/
/* prompt is displayed before the input is requested.						*/
/* str is the string to input or edit.										*/
361
362
363
/* len is the maximum length of the string.									*/
/* kmode contains flags that control the string input (K_* macros).			*/
/* This function sets uifcapi_t.changes to TRUE if the string is modified.	*/
364
365
/* Returns the length of the string or -1 on escape/abort.					*/
/****************************************************************************/
366
367
    int     (*input)(int mode, int left, int top, char* prompt, char* str
            	        ,int len, int kmode);
368
369
370
/****************************************************************************/
/* Sets the current help index by source code file and line number.			*/
/****************************************************************************/
371
    void    (*sethelp)(int line, char* file);
372
373
374
375
376

/****************************************************************************/
/* Shows the current help text												*/
/****************************************************************************/
    void    (*showhelp)(void);
377
378
	
/****************************************************************************/
379
/* Shows a scrollable text buffer - optionally parsing "help markup codes"	*/
380
/****************************************************************************/
381
382
	void	(*showbuf)(int mode, int left, int top, int width, int height
							,char *title, char *hbuf, int *curp, int *barp);
383

384
385
386
387
/****************************************************************************/
/* Updates time in upper left corner of screen with current time in ASCII/  */
/* Unix format																*/
/****************************************************************************/
388
	void	(*timedisplay)(BOOL force);
389

390
391
392
/****************************************************************************/
/* Displays the bottom line using the BL_* macros							*/
/****************************************************************************/
393
    void	(*bottomline)(int line);
394

395
396
397
/****************************************************************************/
/* String input/exit box at a specified position							*/
/****************************************************************************/
398
399
	int		(*getstrxy)(int left, int top, int width, char *outstr, int max
							,long mode, int *lastkey);
400

401
402
403
/****************************************************************************/
/* Formatted print with attribute											*/
/****************************************************************************/
404
	int		(*printf)(int x, int y, unsigned attr, char *fmat, ...);
405

406
407
} uifcapi_t;

408
409
410
411
412
413
/****************************************************************************/
/* Initialization routines for each UIFC implementation.					*/
/* Returns 0 on success, non-zero on failure.								*/
/****************************************************************************/
int uifcini(uifcapi_t*);	/* Original implementation based on conio		*/
int uifcinix(uifcapi_t*);	/* Standard I/O implementation					*/
deuce's avatar
deuce committed
414
int uifcini32(uifcapi_t*);	/* conio/curses implementation					*/
415
/****************************************************************************/
deuce's avatar
deuce committed
416
417

#endif /* Don't add anything after this line! */