uifc.h 20.9 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 2010 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

deuce's avatar
deuce committed
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
#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
80
81
#if defined(__unix__) && !defined(stricmp)
    #define stricmp strcasecmp
82
	#define strnicmp strncasecmp
rswindell's avatar
rswindell committed
83
#endif
84

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

rswindell's avatar
rswindell committed
89
90
91
92
93
94
95
96
97
98
99
100
#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
101
102
103
104
105
106
107
108
109
#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)! */
110
111
#define MAX_OPLN	75		/* Maximum length of each option per menu call */
#define MAX_BUFS	7		/* Maximum number of screen buffers to save */
112
#define MIN_LINES   14      /* Minimum number of screen lines supported */
113
114
115
#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 */
116
117
118
119
120

#ifndef uint
#define uint unsigned int
#endif

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

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

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

#define SCRN_TOP	3
#define SCRN_LEFT	5
177
#define SCRN_RIGHT 	((int)api->scrn_width-4)
178
179
180
181
182
183
184
185
186
187
188
189
190

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

201
202
203
204
205
206
						/* 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 */
207
#define BL_HELP     (1<<5)  /* Help key */
208

209
210
211
						/* Extra exit flags */
#define UIFC_XF_QUIT	(1<<0)	/* Returned -1 due to CIO_KEY_QUIT */

212
213
#define HELPBUF_SIZE 4000

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

226
227
228
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
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
};

255
#endif
256
257
258
259
260
261
262
263
264
265
266

#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

267
268
#ifndef BOOL
#define BOOL    int
deuce's avatar
deuce committed
269
#ifndef TRUE
270
#define TRUE    1
deuce's avatar
deuce committed
271
272
#endif
#ifndef FALSE
273
274
#define FALSE   0
#endif
deuce's avatar
deuce committed
275
#endif
276
277

typedef struct {
278
	int		left,top,right,bot;
279
	int		*cur,*bar;
280
    uchar*	buf;
281
} win_t;
282

283
284
285
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
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;

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

/****************************************************************************/
/* Colours for the various bits												*/
/****************************************************************************/
395
	uchar	hclr,lclr,bclr,cclr,lbclr;
396

397
398
399
400
401
/****************************************************************************/
/* Have we initialized successfully?										*/
/****************************************************************************/
	BOOL	initialized;

402
403
404
405
406
/****************************************************************************/
/* UIFC_XF_* bits for extra exit status										*/
/****************************************************************************/
	uint	exit_flags;

407
408
409
410
411
/****************************************************************************/
/* Custom drawing characters												*/
/****************************************************************************/
	uifc_graphics_t	*chars;

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

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

477
478
479
480
/****************************************************************************/
/* Updates time in upper left corner of screen with current time in ASCII/  */
/* Unix format																*/
/****************************************************************************/
481
	void	(*timedisplay)(BOOL force);
482

483
484
485
/****************************************************************************/
/* Displays the bottom line using the BL_* macros							*/
/****************************************************************************/
486
    void	(*bottomline)(int line);
487

488
489
490
/****************************************************************************/
/* String input/exit box at a specified position							*/
/****************************************************************************/
491
492
	int		(*getstrxy)(int left, int top, int width, char *outstr, int max
							,long mode, int *lastkey);
493

494
495
496
/****************************************************************************/
/* Formatted print with attribute											*/
/****************************************************************************/
497
	int		(*printf)(int x, int y, unsigned attr, char *fmat, ...);
498

499
500
} uifcapi_t;

501
502
503
504
505
506
507
508
509
510
#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
511
UIFCEXPORTVAR char* uifcYesNoOpts[];
512

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

522
523
524
525
#ifdef __cplusplus
}
#endif

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