sade.h revision 8556 
1/*
2 * The new sysinstall program.
3 *
4 * This is probably the last attempt in the `sysinstall' line, the next
5 * generation being slated to essentially a complete rewrite.
6 *
7 * $Id: sysinstall.h,v 1.16 1995/05/16 02:53:26 jkh Exp $
8 *
9 * Copyright (c) 1995
10 *	Jordan Hubbard.  All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 *    notice, this list of conditions and the following disclaimer,
17 *    verbatim and that no modifications are made prior to this
18 *    point in the file.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 *    notice, this list of conditions and the following disclaimer in the
21 *    documentation and/or other materials provided with the distribution.
22 * 3. All advertising materials mentioning features or use of this software
23 *    must display the following acknowledgement:
24 *	This product includes software developed by Jordan Hubbard
25 *	for the FreeBSD Project.
26 * 4. The name of Jordan Hubbard or the FreeBSD project may not be used to
27 *    endorse or promote products derived from this software without specific
28 *    prior written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY JORDAN HUBBARD ``AS IS'' AND
31 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED.  IN NO EVENT SHALL JORDAN HUBBARD OR HIS PETS BE LIABLE
34 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36 * OR SERVICES; LOSS OF USE, DATA, LIFE OR PROFITS; OR BUSINESS INTERRUPTION)
37 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 * SUCH DAMAGE.
41 *
42 */
43
44#ifndef _SYSINSTALL_H_INCLUDE
45#define _SYSINSTALL_H_INCLUDE
46
47#include <stdio.h>
48#include <stdlib.h>
49#include <string.h>
50#include <unistd.h>
51#include <dialog.h>
52#include "libdisk.h"
53#include "dist.h"
54
55/*** Defines ***/
56
57/* Bitfields for menu options */
58#define DMENU_NORMAL_TYPE	0x1	/* Normal dialog menu		*/
59#define DMENU_RADIO_TYPE	0x2	/* Radio dialog menu		*/
60#define DMENU_MULTIPLE_TYPE	0x4	/* Multiple choice menu		*/
61#define DMENU_SELECTION_RETURNS	0x8	/* Select item then exit	*/
62#define DMENU_CALL_FIRST	0x10	/* In multiple, use one handler */
63
64/* variable limits */
65#define VAR_NAME_MAX		128
66#define VAR_VALUE_MAX		1024
67
68/* device limits */
69#define DEV_NAME_MAX		128	/* The maximum length of a device name	*/
70#define DEV_MAX			200	/* The maximum number of devices we'll deal with */
71#define INTERFACE_MAX		50	/* Maximum number of network interfaces we'll deal with */
72
73
74/* Internal flag variables */
75#define DISK_PARTITIONED	"_diskPartitioned"
76#define DISK_LABELLED		"_diskLabelled"
77#define TCP_CONFIGURED		"_tcpConfigured"
78#define NO_CONFIRMATION		"_noConfirmation"
79#define MEDIA_DEVICE		"mediaDevice"
80#define MEDIA_TYPE		"mediaType"
81
82#define VAR_HOSTNAME		"hostname"
83#define VAR_DOMAINNAME		"domainname"
84#define VAR_NAMESERVER		"nameserver"
85#define VAR_GATEWAY		"gateway"
86
87/* per-interface flags */
88#define VAR_IFCONFIG_ARGS	"if_flags"
89#define VAR_NETMASK		"netmask"
90#define VAR_IPADDR		"ip_addr"
91
92
93/*** Types ***/
94typedef unsigned int Boolean;
95typedef struct disk Disk;
96typedef struct chunk Chunk;
97
98typedef enum {
99    DMENU_SHELL_ESCAPE,			/* Fork a shell			*/
100    DMENU_DISPLAY_FILE,			/* Display a file's contents	*/
101    DMENU_SUBMENU,			/* Recurse into another menu	*/
102    DMENU_SYSTEM_COMMAND,		/* Run shell commmand		*/
103    DMENU_SYSTEM_COMMAND_BOX,		/* Same as above, but in prgbox	*/
104    DMENU_SET_VARIABLE,			/* Set an environment/system var */
105    DMENU_SET_FLAG,			/* Set flag in an unsigned int	*/
106    DMENU_CALL,				/* Call back a C function	*/
107    DMENU_CANCEL,			/* Cancel out of this menu	*/
108    DMENU_NOP,				/* Do nothing special for item	*/
109} DMenuItemType;
110
111typedef struct _dmenuItem {
112    char *title;			/* Our title			*/
113    char *prompt;			/* Our prompt			*/
114    DMenuItemType type;			/* What type of item we are	*/
115    void *ptr;				/* Generic data ptr		*/
116    u_long parm;			/* Parameter for above		*/
117    Boolean disabled;			/* Are we temporarily disabled?	*/
118} DMenuItem;
119
120typedef struct _dmenu {
121    unsigned int options;		/* What sort of menu we are	*/
122    char *title;			/* Our title			*/
123    char *prompt;			/* Our prompt			*/
124    char *helpline;			/* Line of help at bottom	*/
125    char *helpfile;			/* Help file for "F1"		*/
126    DMenuItem items[0];			/* Array of menu items		*/
127} DMenu;
128
129/* A sysconfig variable */
130typedef struct _variable {
131    struct _variable *next;
132    char name[VAR_NAME_MAX];
133    char value[VAR_VALUE_MAX];
134} Variable;
135
136typedef enum {
137    DEVICE_TYPE_NONE,
138    DEVICE_TYPE_DISK,
139    DEVICE_TYPE_FLOPPY,
140    DEVICE_TYPE_NETWORK,
141    DEVICE_TYPE_CDROM,
142    DEVICE_TYPE_TAPE,
143    DEVICE_TYPE_ANY,
144} DeviceType;
145
146/* A "device" from sysinstall's point of view */
147typedef struct _device {
148    char name[DEV_NAME_MAX];
149    char *description;
150    DeviceType type;
151    Boolean enabled;
152    Boolean (*init)(struct _device *);
153    Boolean (*get)(char *fname);
154    void (*close)(struct _device *);
155    void *private;
156} Device;
157
158/* Some internal representations of partitions */
159typedef enum {
160    PART_NONE,
161    PART_SLICE,
162    PART_SWAP,
163    PART_FILESYSTEM,
164    PART_FAT,
165} PartType;
166
167/* The longest newfs command we'll hand to system() */
168#define NEWFS_CMD_MAX	256
169
170typedef struct _part_info {
171    Boolean newfs;
172    char mountpoint[FILENAME_MAX];
173    char newfs_cmd[NEWFS_CMD_MAX];
174} PartInfo;
175
176typedef int (*commandFunc)(char *key, void *data);
177
178
179/*** Externs ***/
180extern int		CpioFD;	  /* The file descriptor for our CPIO floppy */
181extern int		DebugFD;  /* Where diagnostic output goes	*/
182extern Boolean		OnCDROM;  /* Are we running off of a CDROM?	*/
183extern Boolean		OnSerial; /* Are we on a serial console?	*/
184extern Boolean		SystemWasInstalled; /* Did we install it?       */
185extern Boolean		DialogActive; /* Is the dialog() stuff up?	*/
186extern Boolean		ColorDisplay; /* Are we on a color display?     */
187extern Boolean		OnVTY;    /* On a syscons VTY?			*/
188extern Variable		*VarHead; /* The head of the variable chain	*/
189extern unsigned int	Dists;    /* Which distributions we want        */
190extern unsigned int	SrcDists; /* Which src distributions we want    */
191extern unsigned int	XF86Dists;/* Which XFree86 dists we want	*/
192extern unsigned int	XF86ServerDists; /* The XFree86 servers we want */
193extern unsigned int	XF86FontDists; /* The XFree86 fonts we want     */
194
195/*** Prototypes ***/
196
197/* command.c */
198extern void	command_clear(void);
199extern void	command_sort(void);
200extern void	command_execute(void);
201extern void	command_shell_add(char *key, char *fmt, ...);
202extern void	command_func_add(char *key, commandFunc func, void *data);
203
204/* decode.c */
205extern DMenuItem *decode(DMenu *menu, char *name);
206extern Boolean	dispatch(DMenuItem *tmp, char *name);
207extern Boolean	decode_and_dispatch_multiple(DMenu *menu, char *names);
208
209/* devices.c */
210extern DMenu	*deviceCreateMenu(DMenu *menu, DeviceType type, int (*hook)());
211extern void	deviceGetAll(void);
212extern Device	**deviceFind(char *name, DeviceType type);
213
214/* disks.c */
215extern int	diskPartitionEditor(char *unused);
216
217/* dist.c */
218extern int	distSetDeveloper(char *str);
219extern int	distSetXDeveloper(char *str);
220extern int	distSetUser(char *str);
221extern int	distSetXUser(char *str);
222extern int	distSetMinimum(char *str);
223extern int	distSetEverything(char *str);
224extern int	distSetSrc(char *str);
225extern void	distExtractAll(void);
226
227/* dmenu.c */
228extern void	dmenuOpen(DMenu *menu, int *choice, int *scroll,
229			  int *curr, int *max);
230extern void	dmenuOpenSimple(DMenu *menu);
231
232/* globals.c */
233extern void	globalsInit(void);
234
235/* install.c */
236extern int	installCommit(char *str);
237
238/* lang.c */
239extern void	lang_set_Danish(char *str);
240extern void	lang_set_Dutch(char *str);
241extern void	lang_set_English(char *str);
242extern void	lang_set_French(char *str);
243extern void	lang_set_German(char *str);
244extern void	lang_set_Italian(char *str);
245extern void	lang_set_Japanese(char *str);
246extern void	lang_set_Norwegian(char *str);
247extern void	lang_set_Russian(char *str);
248extern void	lang_set_Spanish(char *str);
249extern void	lang_set_Swedish(char *str);
250
251/* label.c */
252extern void	diskLabelEditor(char *str);
253
254/* makedevs.c (auto-generated) */
255extern const char	termcap_vt100[];
256extern const char	termcap_cons25[];
257extern const char	termcap_cons25_m[];
258extern const char	termcap_cons25r[];
259extern const char	termcap_cons25r_m[];
260extern const char	termcap_cons25l1[];
261extern const char	termcap_cons25l1_m[];
262extern const u_char	font_iso_8x14[];
263extern const u_char	font_cp850_8x14[];
264extern const u_char	font_koi8_r_8x14[];
265extern const u_char	koi8_r2cp866[];
266
267/* media.c */
268extern int	mediaSetCDROM(char *str);
269extern int	mediaSetFloppy(char *str);
270extern int	mediaSetDOS(char *str);
271extern int	mediaSetTape(char *str);
272extern int	mediaSetFTP(char *str);
273extern int	mediaSetFS(char *str);
274extern FILE	*mediaOpen(char *parent, char *me);
275extern Boolean	mediaGetType(void);
276extern Boolean	mediaExtractDist(FILE *fp);
277extern Boolean	mediaVerify(void);
278extern Boolean	mediaInitUFS(Device *dev);
279extern Boolean	mediaGetUFS(char *dist);
280extern Boolean	mediaInitCDROM(Device *dev);
281extern Boolean	mediaGetCDROM(char *dist);
282extern Boolean	mediaInitTape(Device *dev);
283extern Boolean	mediaGetTape(char *dist);
284extern Boolean	mediaInitNetwork(Device *dev);
285extern Boolean	mediaGetNetwork(char *dist);
286extern void	mediaCloseTape(Device *dev);
287extern void	mediaCloseCDROM(Device *dev);
288extern void	mediaCloseNetwork(Device *dev);
289
290
291/* misc.c */
292extern Boolean	file_readable(char *fname);
293extern Boolean	file_executable(char *fname);
294extern char	*string_concat(char *p1, char *p2);
295extern char	*string_prune(char *str);
296extern char	*string_skipwhite(char *str);
297extern void	safe_free(void *ptr);
298extern void	*safe_malloc(size_t size);
299extern void	*safe_realloc(void *orig, size_t size);
300extern char	**item_add(char **list, char *item, int *curr, int *max);
301extern char	**item_add_pair(char **list, char *item1, char *item2,
302				int *curr, int *max);
303extern void	items_free(char **list, int *curr, int *max);
304extern int	Mkdir(char *, void *data);
305extern int	Mount(char *, void *data);
306
307/* msg.c */
308extern void	msgInfo(char *fmt, ...);
309extern void	msgYap(char *fmt, ...);
310extern void	msgWarn(char *fmt, ...);
311extern void	msgDebug(char *fmt, ...);
312extern void	msgError(char *fmt, ...);
313extern void	msgFatal(char *fmt, ...);
314extern void	msgConfirm(char *fmt, ...);
315extern void	msgNotify(char *fmt, ...);
316extern int	msgYesNo(char *fmt, ...);
317extern char	*msgGetInput(char *buf, char *fmt, ...);
318
319/* system.c */
320extern void	systemInitialize(int argc, char **argv);
321extern void	systemShutdown(void);
322extern void	systemWelcome(void);
323extern int	systemExecute(char *cmd);
324extern int	systemShellEscape(void);
325extern int	systemDisplayFile(char *file);
326extern char	*systemHelpFile(char *file, char *buf);
327extern void	systemChangeFont(const u_char font[]);
328extern void	systemChangeLang(char *lang);
329extern void	systemChangeTerminal(char *color, const u_char c_termcap[],
330				     char *mono, const u_char m_termcap[]);
331extern void	systemChangeScreenmap(const u_char newmap[]);
332extern int	vsystem(char *fmt, ...);
333
334/* tcpip.c */
335extern int	tcpOpenDialog(char *);
336
337/* termcap.c */
338extern int	set_termcap(void);
339
340/* variables.c */
341extern void	variable_set(char *var);
342extern void	variable_set2(char *name, char *value);
343
344/* wizard.c */
345extern void	slice_wizard(Disk *d);
346
347#endif
348/* _SYSINSTALL_H_INCLUDE */
349