uifc.h 18.7 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 2004 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
56
57
#if (defined(__unix__) || defined(_WIN32)) && !defined(__FLAT__)
    #define __FLAT__
#endif
58
59
60
61
62

#if defined(__FLAT__)
	#define far
#endif

63
#if !defined(__FLAT__)
64
65
66
    #include <bios.h>
#endif

rswindell's avatar
rswindell committed
67
68
#if defined(__unix__) && !defined(stricmp)
    #define stricmp strcasecmp
69
	#define strnicmp strncasecmp
rswindell's avatar
rswindell committed
70
#endif
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

/****************************************************************************/
/* MALLOC/FREE Macros for various compilers and environments				*/
/* MALLOC is used for allocations of 64k or less							*/
/* FREE is used to free buffers allocated with MALLOC						*/
/* LMALLOC is used for allocations of possibly larger than 64k				*/
/* LFREE is used to free buffers allocated with LMALLOC 					*/
/* REALLOC is used to re-size a previously MALLOCed or LMALLOCed buffer 	*/
/****************************************************************************/
#if defined(__COMPACT__) || defined(__LARGE__) || defined(__HUGE__)
	#if defined(__TURBOC__)
		#define REALLOC(x,y) farrealloc(x,y)
		#define LMALLOC(x) farmalloc(x)
		#define MALLOC(x) farmalloc(x)
		#define LFREE(x) farfree(x)
		#define FREE(x) farfree(x)
	#elif defined(__WATCOMC__)
		#define REALLOC realloc
		#define LMALLOC(x) halloc(x,1)	/* far heap, but slow */
		#define MALLOC malloc			/* far heap, but 64k max */
		#define LFREE hfree
		#define FREE free
	#else	/* Other 16-bit Compiler */
		#define REALLOC realloc
		#define LMALLOC malloc
		#define MALLOC malloc
		#define LFREE free
		#define FREE free
	#endif
#else		/* 32-bit Compiler or Small Memory Model */
	#define REALLOC realloc
	#define LMALLOC malloc
	#define MALLOC malloc
	#define LFREE free
	#define FREE free
#endif
deuce's avatar
deuce committed
107
108
109
#if !defined(FREE_AND_NULL)
	#define FREE_AND_NULL(x)			if(x!=NULL) { FREE(x); x=NULL; }
#endif
110

rswindell's avatar
rswindell committed
111
112
113
114
115
116
117
118
119
120
121
122
#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

123
124
125
126
127
128
129
#ifdef __DPMI32__
	#define INT_86(i,j,k) int386(i,j,k)
#else
	#define INT_86(i,j,k) int86(i,j,k)
#endif

#ifdef __FLAT__
130
	#define MAX_OPTS	10000
131
132
133
134
135
136
	#define MSK_ON		0xf0000000
	#define MSK_OFF 	0x0fffffff
	#define MSK_INS 	0x10000000
	#define MSK_DEL 	0x20000000
	#define MSK_GET 	0x30000000
	#define MSK_PUT 	0x40000000
137
	/* Dont forget, negative return values are used for extended keys (if WIN_EXTKEYS used)! */
138
139
140
141
142
143
144
145
146
147
148
#else
	#define MAX_OPTS	500 	/* Maximum number of options per menu call */
	#define MSK_ON		0xf000
	#define MSK_OFF 	0x0fff
	#define MSK_INS 	0x1000
	#define MSK_DEL 	0x2000
	#define MSK_GET 	0x3000
	#define MSK_PUT 	0x4000
#endif
#define MAX_OPLN	75		/* Maximum length of each option per menu call */
#define MAX_BUFS	7		/* Maximum number of screen buffers to save */
149
#define MIN_LINES   14      /* Minimum number of screen lines supported */
150
151
#define MAX_LINES   60      /* Maximum number of screen rows supported */ 
#define MAX_BFLN	80*MAX_LINES*2	/* Maximum size of screen buffers */
152
153
154
155
156

#ifndef uint
#define uint unsigned int
#endif

157
                            /* Bits in uifcapi_t.mode */
158
159
160
161
#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 */
162
#define UIFC_IBM	(1<<4)	/* Force use of IBM charset	*/
163
164
#define UIFC_NOCTRL	(1<<5)	/* Don't allow useage of CTRL keys for movement 
							 * etc in menus (Still available in text boxes) */
165
                            /* Bits in uifcapi_t.list mode */
166

167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
#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 */
183
184
185
#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) */
186
187
#define WIN_IMM 	(1<<19) /* Draw window and return immediately */
#define WIN_FAT		(1<<20)	/* Do not pad outside borders */
188
189
#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
190
#define WIN_EXTKEYS	(1<<23) /* Return on any keypress... if it's not handled internally
191
192
							 * Return value is -2 - keyvalue */
#define WIN_NOBRDR	(1<<24)	/* Do not draw a border around the window */
193
#define WIN_FIXEDHEIGHT	(1<<25)	/* Use list_height from uifc struct */
194
195
196
197
198

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

#define SCRN_TOP	3
#define SCRN_LEFT	5
199
#define SCRN_RIGHT 	((int)api->scrn_width-4)
200
201
202
203
204
205
206
207
208
209
210
211
212

								/* 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 		*/
213
#define K_SCANNING	(1L<<11)	/* UPC Scanner is active... return on '%'	*/
214
#define K_TABEXIT	(1L<<12)	/* Return on TAB or BACKTAB			    	*/
215
#define K_DECIMAL	(1L<<13)	/* Allow floating point numbers only		*/
216
217
#define K_DEUCEEXIT	(1L<<13)	/* Return whenever Deuce wants to exit		*/
								/* Define this behaviour better - ToDo		*/
218
219
220

#define HELPBUF_SIZE 4000

221
#ifndef _GEN_DEFS_H
222
223
224
									/* Control characters */
#define STX 	0x02				/* Start of text			^B	*/
#define ETX 	0x03				/* End of text				^C	*/
225
226
227
#define BS		'\b'				/* Back space				^H	*/
#define TAB 	'\t'				/* Horizontal tabulation	^I	*/
#define LF		'\n'				/* Line feed				^J	*/
228
#define FF		0x0c				/* Form feed				^L	*/
229
#define CR		'\r'				/* Carriage return			^M	*/
230
#define ESC 	0x1b				/* Escape					^[	*/
231
#define DEL     0x7f                /* Delete                   ^BS */
232

233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
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
};

262
#endif
263
264
265
266
267
268
269
270
271
272
273

#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

274
275
#ifndef BOOL
#define BOOL    int
deuce's avatar
deuce committed
276
#ifndef TRUE
277
#define TRUE    1
deuce's avatar
deuce committed
278
279
#endif
#ifndef FALSE
280
281
#define FALSE   0
#endif
deuce's avatar
deuce committed
282
#endif
283
284

typedef struct {
285
286
287
	uint    left,top,right,bot;
    uchar   *buf;
} win_t;
288

289
290
291
292
293
294
295
296
297
298
#if !defined(__FLAT__)
    /* LCLOLL.ASM */
    int lclini(int);
    void lclxy(int,int);
    int lclwx(void);
    int lclwy(void);
    int lclatr(int);
    void lputc(int);
    long lputs(char far *);
#endif    
299
300
301
302
303
304

#if defined(__OS2__) || !defined(__FLAT__)
void mswait(int msecs);
extern mswtyp;
#endif

305
typedef struct {
306
307
308
/****************************************************************************/
/* Size of the structure (for version compatibility verification).			*/
/****************************************************************************/
309
    size_t  size;
310
311
312
/****************************************************************************/
/* Controls general UIFC library behavior.									*/
/****************************************************************************/
313
    long    mode;
314
315
316
/****************************************************************************/
/* Set to TRUE when changes to data have been made by input function.		*/ 
/****************************************************************************/
317
    BOOL    changes;
318
319
320
/****************************************************************************/
/* The overlapped-window save buffer number.								*/
/****************************************************************************/
321
    uint    savnum;
322
323
324
325
326
327
328
/****************************************************************************/
/* The current overlapped-window save buffer depth.							*/
/****************************************************************************/
    uint    savdepth;
/****************************************************************************/
/* Screen length															*/
/****************************************************************************/
329
    uint    scrn_len;
330
/****************************************************************************/
331
332
333
334
/* Screen Width 															*/
/****************************************************************************/
    uint    scrn_width;
/****************************************************************************/
335
336
337
338
/* ESC key delay for curses													*/
/****************************************************************************/
    uint    esc_delay;
/****************************************************************************/
339
340
/* Alternative method of setting current help text.							*/
/****************************************************************************/
341
    char*   helpbuf;
342
343
344
/****************************************************************************/
/* Location of the help data and index files.								*/
/****************************************************************************/
345
346
    char    helpdatfile[MAX_PATH+1];
    char    helpixbfile[MAX_PATH+1];
347
/****************************************************************************/
348
349
350
351
352
353
354
355
/* Help and exit button locations for current/last window					*/
/****************************************************************************/
	int		buttony;
	int		exitstart;
	int		exitend;
	int		helpstart;
	int		helpend;
/****************************************************************************/
356
357
358
/* List height for WIN_FIXEDHEIGHT lists.									*/
/****************************************************************************/
	int		list_height;
359
360
361
362
363
364

/****************************************************************************/
/* Colours for the various bits												*/
/****************************************************************************/
	char	hclr,lclr,bclr,cclr,lbclr;

365
/****************************************************************************/
366
367
/* Exit/uninitialize function.												*/
/****************************************************************************/
368
    void    (*bail) (void);
369
370
371
372
373
/****************************************************************************/
/* Fill the screen with the appropriate background attribute.				*/
/* str is the title for the application banner.								*/
/* Returns 0 on success, non-zero on failure.								*/
/****************************************************************************/
374
    int     (*scrn) (char* str);
375
376
377
/****************************************************************************/
/* Popup a message, maybe wait for the user to hit a key or click button.	*/
/****************************************************************************/
378
    void    (*msg)  (char* str);
379
380
381
382
383
/****************************************************************************/
/* 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).			*/
/****************************************************************************/
384
    void    (*pop)  (char* str);
385
386
387
388
389
390
391
392
/****************************************************************************/
/* 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.		*/
393
/* mode bits are set with macros WIN_*.										*/
394
395
396
397
398
/* 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	*/
/* option number OR'd with MSK_INS, MSK_DEL, MSK_GET, or MSK_PUT.			*/
/****************************************************************************/
399
    int     (*list) (int mode, int left, int top, int width, int* dflt
400
                        ,int* bar, char *title, char** option);
401
402
403
404
405
406
/****************************************************************************/
/* 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.										*/
407
408
409
/* 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.	*/
410
411
/* Returns the length of the string or -1 on escape/abort.					*/
/****************************************************************************/
412
413
    int     (*input)(int mode, int left, int top, char* prompt, char* str
            	        ,int len, int kmode);
414
415
416
/****************************************************************************/
/* Sets the current help index by source code file and line number.			*/
/****************************************************************************/
417
    void    (*sethelp)(int line, char* file);
418
419
420
421
422

/****************************************************************************/
/* Shows the current help text												*/
/****************************************************************************/
    void    (*showhelp)(void);
423
424
	
/****************************************************************************/
425
/* Shows a scrollable text buffer - optionally parsing "help markup codes"	*/
426
/****************************************************************************/
427
	void (*showbuf)(int mode, int left, int top, int width, int height, char *title, char *hbuf, int *curp, int *barp);
428

429
430
431
432
433
434
/****************************************************************************/
/* Updates time in upper left corner of screen with current time in ASCII/  */
/* Unix format																*/
/****************************************************************************/
	void (*timedisplay)(void);

435
436
437
/****************************************************************************/
/* String input/exit box at a specified position							*/
/****************************************************************************/
438
	int (*getstrxy)(int left, int top, int width, char *outstr, int max, long mode, int *lastkey);
439

440
441
442
443
/****************************************************************************/
/* Formatted print with attribute											*/
/****************************************************************************/
	int (*printf)(int x, int y, unsigned char attr, char *fmat, ...);
444
445
} uifcapi_t;

446
447
448
449
450
451
/****************************************************************************/
/* 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					*/
rswindell's avatar
rswindell committed
452
int uifcinic(uifcapi_t*);	/* Unix curses implementation (by Deuce)		*/
453
int uifcinid(uifcapi_t*);	/* Unix libdialog implementation (by Deuce)		*/
deuce's avatar
deuce committed
454
int uifcini32(uifcapi_t*);	/* conio/curses implementation					*/
455
456
457
458
#ifdef __cplusplus
extern "C"
#endif
int uifcinifltk(uifcapi_t*);	/* FLTK implementation (by Deuce)			*/
459
/****************************************************************************/
deuce's avatar
deuce committed
460
461

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