uifc.h 21.1 KB
Newer Older
1
/* Text-mode User Interface Library (inspired by Novell SYSCON look & feel) */
2

3
4
5
6
7
8
/* $Id$ */

/****************************************************************************
 * @format.tab-size 4		(Plain Text/Source Code File Header)			*
 * @format.use-tabs true	(see http://www.synchro.net/ptsc_hdr.html)		*
 *																			*
9
 * Copyright Rob Swindell - http://www.synchro.net/copyright.html			*
10
 *																			*
rswindell's avatar
rswindell committed
11
12
 * This library is free software; you can redistribute it and/or			*
 * modify it under the terms of the GNU Lesser General Public License		*
13
14
 * 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
15
16
 * See the GNU Lesser General Public License for more details: lgpl.txt or	*
 * http://www.fsf.org/copyleft/lesser.html									*
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 *																			*
 * 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.	*
 ****************************************************************************/
35

deuce's avatar
deuce committed
36
37
38
#ifndef _UIFC_H_
#define _UIFC_H_

39
40
41
42
43
44
45
#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
46
/* OS Specific */
47
48
49
#if defined(_WIN32)
    #include <windows.h>
#endif
50
51
#if defined(__unix__)
	#include <sys/param.h>	/* PATH_MAX */
52
#endif
53

deuce's avatar
deuce committed
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
#ifdef _WIN32
        #ifdef __BORLANDC__
                #define UIFCCALL __stdcall
        #else
                #define UIFCCALL
        #endif
        #if defined(UIFC_IMPORTS) || defined(UIFC_EXPORTS)
                #if defined(UIFC_IMPORTS)
                        #define UIFCEXPORT __declspec( dllimport )
                        #define UIFCEXPORTVAR __declspec( dllimport )
                #else
                        #define UIFCEXPORT __declspec( dllexport )
                        #define UIFCEXPORTVAR __declspec( dllexport )
                #endif
        #else   /* self-contained executable */
                #define UIFCEXPORT
                #define UIFCEXPORTVAR	extern
        #endif
#else
        #define UIFCCALL
        #define UIFCEXPORT
        #define UIFCEXPORTVAR	extern
#endif

rswindell's avatar
rswindell committed
78
79
#if defined(__unix__) && !defined(stricmp)
    #define stricmp strcasecmp
80
	#define strnicmp strncasecmp
rswindell's avatar
rswindell committed
81
#endif
82

deuce's avatar
deuce committed
83
#if !defined(FREE_AND_NULL)
deuce's avatar
deuce committed
84
	#define FREE_AND_NULL(x)			if(x!=NULL) { free(x); x=NULL; }
deuce's avatar
deuce committed
85
#endif
86

rswindell's avatar
rswindell committed
87
88
89
90
91
92
93
94
95
96
97
98
#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
99
100
101
102
103
#define MAX_OPTS	10000
#define MSK_ON		0xf0000000
#define MSK_OFF 	0x0fffffff
#define MSK_INS 	0x10000000
#define MSK_DEL 	0x20000000
104
105
106
107
108
109
110
111
112
#define MSK_COPY 	0x30000000
#define MSK_CUT 	0x40000000
#define MSK_PASTE 	0x50000000
#define MSK_EDIT 	0x60000000

/* Legacy terms (get/put instead of copy/paste) */
#define MSK_GET		MSK_COPY
#define MSK_PUT		MSK_PASTE

113
/* Don't forget, negative return values are used for extended keys (if WIN_EXTKEYS used)! */
114
115
#define MAX_OPLN	75		/* Maximum length of each option per menu call */
#define MAX_BUFS	7		/* Maximum number of screen buffers to save */
116
#define MIN_LINES   14      /* Minimum number of screen lines supported */
117
118
119
#define MAX_LINES   255     /* Maximum number of screen lines supported (ciolib screenheight is a uchar) */ 
#define MAX_COLS	255		/* Maximum number of screen columns supported (ciolib screenwidth is a uchar) */ 
#define MAX_BFLN	(MAX_COLS*MAX_LINES*2)	/* Maximum size of screen buffers, char + attr */
120
121
122
123
124

#ifndef uint
#define uint unsigned int
#endif

125
							/**************************/
126
                            /* Bits in uifcapi_t.mode */
127
							/**************************/
128
129
130
131
#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 */
132
#define UIFC_IBM	(1<<4)	/* Force use of IBM charset	*/
133
#define UIFC_NOCTRL	(1<<5)	/* Don't allow usage of CTRL keys for movement 
134
							 * etc in menus (Still available in text boxes) */
135
#define UIFC_NHM	(1<<6)	/* Don't hide the mouse pointer */
136

137
138
139
							/*******************************/
                            /* Bits in uifcapi_t.list mode */
							/*******************************/
140
141
142
143
144
145
146
147
148
149
150
#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 */
151
152
153
#define WIN_BOT 	(1<<11) /* Place window against bottom of screen */
#define WIN_GET 	(1<<12) /* Allows F5 to Get (copy) a menu item */
#define WIN_PUT 	(1<<13) /* Allows F6 to Put (paste) a menu item */
154
155
#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 */
156
157
158
#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) */
159
160
#define WIN_IMM 	(1<<19) /* Draw window and return immediately */
#define WIN_FAT		(1<<20)	/* Do not pad outside borders */
161
162
#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
163
#define WIN_EXTKEYS	(1<<23) /* Return on any keypress... if it's not handled internally
164
165
							 * Return value is -2 - keyvalue */
#define WIN_NOBRDR	(1<<24)	/* Do not draw a border around the window */
166
#define WIN_FIXEDHEIGHT	(1<<25)	/* Use list_height from uifc struct */
167
168
#define WIN_UNGETMOUSE  (1<<26) /* If the mouse is clicked outside the window, */
								/* Put the mouse event back into the event queue */
169
#define WIN_EDIT	(1<<27)	/* Allow F2 to edit a menu item */
170
#define WIN_PUTXTR	(1<<28)	/* Allow paste into extra (blank) item */
171
#define WIN_INACT	(1<<29)	/* Draw window inactive... intended for use with WIN_IMM */
172
173
174
175
#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 */
176
177
178
179
180

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

#define SCRN_TOP	3
#define SCRN_LEFT	5
181
#define SCRN_RIGHT 	((int)api->scrn_width-4)
182
183
184
185
186
187
188
189
190
191
192
193
194

								/* 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 		*/
195
#define K_SCANNING	(1L<<11)	/* UPC Scanner is active... return on '%'	*/
196
#define K_TABEXIT	(1L<<12)	/* Return on TAB or BACKTAB			    	*/
197
#define K_DECIMAL	(1L<<13)	/* Allow floating point numbers only		*/
198
199
#define K_DEUCEEXIT	(1L<<14)	/* Return whenever Deuce wants to exit		*/
								/* Returns on up/down/F2					*/
200
201
202
#define K_MOUSEEXIT	(1L<<15)	/* Returns when mouse is clicked outside of */
								/* Input area (NOT outside of window!)		*/
								/* And ungets the mouse event.				*/
203
#define K_PASSWORD	(1L<<16)	/* Does not display text while editing		*/
204

205
206
207
208
209
210
						/* 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 */
211
#define BL_HELP     (1<<5)  /* Help key */
212

213
214
215
						/* Extra exit flags */
#define UIFC_XF_QUIT	(1<<0)	/* Returned -1 due to CIO_KEY_QUIT */

216
217
#define HELPBUF_SIZE 4000

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

230
231
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
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
};

259
#endif
260
261
262
263
264
265
266
267
268
269
270

#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

271
272
#ifndef BOOL
#define BOOL    int
deuce's avatar
deuce committed
273
#ifndef TRUE
274
#define TRUE    1
deuce's avatar
deuce committed
275
276
#endif
#ifndef FALSE
277
278
#define FALSE   0
#endif
deuce's avatar
deuce committed
279
#endif
280
281

typedef struct {
282
	int		left,top,right,bot;
283
	int		*cur,*bar;
284
    uchar*	buf;
285
} win_t;
286

287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
typedef struct {
	char	background;
	char	help_char;
	char	close_char;
	char	up_arrow;
	char	down_arrow;
	char	button_left;
	char	button_right;

	char	list_top_left;
	char	list_top;
	char	list_top_right;
	char	list_separator_left;
	char	list_separator_right;
	char	list_horizontal_separator;
	char	list_left;
	char	list_right;
	char	list_bottom_left;
	char	list_bottom_right;
	char	list_bottom;
	char	list_scrollbar_separator;

	char	input_top_left;
	char	input_top;
	char	input_top_right;
	char	input_left;
	char	input_right;
	char	input_bottom_left;
	char	input_bottom_right;
	char	input_bottom;

	char	popup_top_left;
	char	popup_top;
	char	popup_top_right;
	char	popup_left;
	char	popup_right;
	char	popup_bottom_left;
	char	popup_bottom_right;
	char	popup_bottom;

	char	help_top_left;
	char	help_top;
	char	help_top_right;
	char	help_left;
	char	help_right;
	char	help_bottom_left;
	char	help_bottom_right;
	char	help_bottom;
	char	help_titlebreak_left;
	char	help_titlebreak_right;
	char	help_hitanykey_left;
	char	help_hitanykey_right;
} uifc_graphics_t;

341
typedef struct {
342
343
344
/****************************************************************************/
/* Size of the structure (for version compatibility verification).			*/
/****************************************************************************/
345
    size_t  size;
346
347
348
/****************************************************************************/
/* Controls general UIFC library behavior.									*/
/****************************************************************************/
349
    long    mode;
350
351
352
/****************************************************************************/
/* Set to TRUE when changes to data have been made by input function.		*/ 
/****************************************************************************/
353
    BOOL    changes;
354
355
356
/****************************************************************************/
/* The overlapped-window save buffer number.								*/
/****************************************************************************/
357
    uint    savnum;
358
359
360
361
362
363
364
/****************************************************************************/
/* The current overlapped-window save buffer depth.							*/
/****************************************************************************/
    uint    savdepth;
/****************************************************************************/
/* Screen length															*/
/****************************************************************************/
365
    uint    scrn_len;
366
/****************************************************************************/
367
368
369
370
/* Screen Width 															*/
/****************************************************************************/
    uint    scrn_width;
/****************************************************************************/
371
372
373
374
/* ESC key delay for curses													*/
/****************************************************************************/
    uint    esc_delay;
/****************************************************************************/
375
376
/* Alternative method of setting current help text.							*/
/****************************************************************************/
377
    char*   helpbuf;
378
379
380
/****************************************************************************/
/* Location of the help data and index files.								*/
/****************************************************************************/
381
382
    char    helpdatfile[MAX_PATH+1];
    char    helpixbfile[MAX_PATH+1];
383
/****************************************************************************/
384
385
386
387
388
389
390
391
/* Help and exit button locations for current/last window					*/
/****************************************************************************/
	int		buttony;
	int		exitstart;
	int		exitend;
	int		helpstart;
	int		helpend;
/****************************************************************************/
392
393
394
/* List height for WIN_FIXEDHEIGHT lists.									*/
/****************************************************************************/
	int		list_height;
395
396
397
398

/****************************************************************************/
/* Colours for the various bits												*/
/****************************************************************************/
399
	uchar	hclr,lclr,bclr,cclr,lbclr;
400

401
402
403
404
405
/****************************************************************************/
/* Have we initialized successfully?										*/
/****************************************************************************/
	BOOL	initialized;

406
407
408
409
410
/****************************************************************************/
/* UIFC_XF_* bits for extra exit status										*/
/****************************************************************************/
	uint	exit_flags;

411
412
413
414
415
/****************************************************************************/
/* Custom drawing characters												*/
/****************************************************************************/
	uifc_graphics_t	*chars;

416
/****************************************************************************/
417
418
/* Exit/uninitialize function.												*/
/****************************************************************************/
419
    void    (*bail) (void);
420
421
422
423
424
/****************************************************************************/
/* Fill the screen with the appropriate background attribute.				*/
/* str is the title for the application banner.								*/
/* Returns 0 on success, non-zero on failure.								*/
/****************************************************************************/
425
    int     (*scrn) (char* str);
426
427
428
/****************************************************************************/
/* Popup a message, maybe wait for the user to hit a key or click button.	*/
/****************************************************************************/
429
    void    (*msg)  (char* str);
430
431
432
433
434
/****************************************************************************/
/* 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).			*/
/****************************************************************************/
435
    void    (*pop)  (char* str);
436
437
438
439
440
441
442
443
/****************************************************************************/
/* 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.		*/
444
/* mode bits are set with macros WIN_*.										*/
445
446
447
/* 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	*/
448
/* option number OR'd with MSK_INS, MSK_DEL, MSK_GET, MSK_PUT, or MSK_EDIT.	*/
449
/****************************************************************************/
450
    int     (*list) (int mode, int left, int top, int width, int* dflt
451
                        ,int* bar, char *title, char** option);
452
453
454
455
456
457
/****************************************************************************/
/* 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.										*/
458
459
460
/* 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.	*/
461
462
/* Returns the length of the string or -1 on escape/abort.					*/
/****************************************************************************/
463
464
    int     (*input)(int mode, int left, int top, char* prompt, char* str
            	        ,int len, int kmode);
465
466
467
/****************************************************************************/
/* Sets the current help index by source code file and line number.			*/
/****************************************************************************/
468
    void    (*sethelp)(int line, char* file);
469
470
471
472
473

/****************************************************************************/
/* Shows the current help text												*/
/****************************************************************************/
    void    (*showhelp)(void);
474
475
	
/****************************************************************************/
476
/* Shows a scrollable text buffer - optionally parsing "help markup codes"	*/
477
/****************************************************************************/
478
479
	void	(*showbuf)(int mode, int left, int top, int width, int height
							,char *title, char *hbuf, int *curp, int *barp);
480

481
482
483
484
/****************************************************************************/
/* Updates time in upper left corner of screen with current time in ASCII/  */
/* Unix format																*/
/****************************************************************************/
485
	void	(*timedisplay)(BOOL force);
486

487
488
489
/****************************************************************************/
/* Displays the bottom line using the BL_* macros							*/
/****************************************************************************/
490
    void	(*bottomline)(int line);
491

492
493
494
/****************************************************************************/
/* String input/exit box at a specified position							*/
/****************************************************************************/
495
496
	int		(*getstrxy)(int left, int top, int width, char *outstr, int max
							,long mode, int *lastkey);
497

498
499
500
/****************************************************************************/
/* Formatted print with attribute											*/
/****************************************************************************/
501
	int		(*printf)(int x, int y, unsigned attr, char *fmat, ...);
502

503
504
} uifcapi_t;

505
506
507
508
509
510
511
512
513
514
#ifdef __cplusplus
extern "C" {
#endif

/* Return value from uifc_api.list() when uifcYesNoOpts is used */
enum {
	uifcYes=0,
	uifcNo=1
};

deuce's avatar
deuce committed
515
UIFCEXPORTVAR char* uifcYesNoOpts[];
516

517
518
519
520
521
/****************************************************************************/
/* Initialization routines for each UIFC implementation.					*/
/* Returns 0 on success, non-zero on failure.								*/
/****************************************************************************/
int uifcini(uifcapi_t*);	/* Original implementation based on conio		*/
522
UIFCEXPORT int UIFCCALL uifcinix(uifcapi_t*);	/* Standard I/O implementation					*/
deuce's avatar
deuce committed
523
UIFCEXPORT int UIFCCALL uifcini32(uifcapi_t*);	/* modern implementation	*/
524
/****************************************************************************/
deuce's avatar
deuce committed
525

526
527
528
529
#ifdef __cplusplus
}
#endif

deuce's avatar
deuce committed
530
#endif /* Don't add anything after this line! */