sade.h revision 8637 
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.21 1995/05/20 00:13:14 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
80#define VAR_HOSTNAME		"hostname"
81#define VAR_DOMAINNAME		"domainname"
82#define VAR_NAMESERVER		"nameserver"
83#define VAR_GATEWAY		"gateway"
84
85#define VAR_IFCONFIG		"ifconfig_"
86
87/* The help file for the TCP/IP setup screen */
88#define TCP_HELPFILE		"tcp.hlp"
89
90/*** Types ***/
91typedef unsigned int Boolean;
92typedef struct disk Disk;
93typedef struct chunk Chunk;
94
95typedef enum {
96    DMENU_SHELL_ESCAPE,			/* Fork a shell			*/
97    DMENU_DISPLAY_FILE,			/* Display a file's contents	*/
98    DMENU_SUBMENU,			/* Recurse into another menu	*/
99    DMENU_SYSTEM_COMMAND,		/* Run shell commmand		*/
100    DMENU_SYSTEM_COMMAND_BOX,		/* Same as above, but in prgbox	*/
101    DMENU_SET_VARIABLE,			/* Set an environment/system var */
102    DMENU_SET_FLAG,			/* Set flag in an unsigned int	*/
103    DMENU_CALL,				/* Call back a C function	*/
104    DMENU_CANCEL,			/* Cancel out of this menu	*/
105    DMENU_NOP,				/* Do nothing special for item	*/
106} DMenuItemType;
107
108typedef struct _dmenuItem {
109    char *title;			/* Our title			*/
110    char *prompt;			/* Our prompt			*/
111    DMenuItemType type;			/* What type of item we are	*/
112    void *ptr;				/* Generic data ptr		*/
113    u_long parm;			/* Parameter for above		*/
114    Boolean disabled;			/* Are we temporarily disabled?	*/
115} DMenuItem;
116
117typedef struct _dmenu {
118    unsigned int options;		/* What sort of menu we are	*/
119    char *title;			/* Our title			*/
120    char *prompt;			/* Our prompt			*/
121    char *helpline;			/* Line of help at bottom	*/
122    char *helpfile;			/* Help file for "F1"		*/
123    DMenuItem items[0];			/* Array of menu items		*/
124} DMenu;
125
126/* A sysconfig variable */
127typedef struct _variable {
128    struct _variable *next;
129    char name[VAR_NAME_MAX];
130    char value[VAR_VALUE_MAX];
131} Variable;
132
133typedef enum {
134    DEVICE_TYPE_NONE,
135    DEVICE_TYPE_DISK,
136    DEVICE_TYPE_FLOPPY,
137    DEVICE_TYPE_NETWORK,
138    DEVICE_TYPE_CDROM,
139    DEVICE_TYPE_TAPE,
140    DEVICE_TYPE_ANY,
141} DeviceType;
142
143/* A "device" from sysinstall's point of view */
144typedef struct _device {
145    char name[DEV_NAME_MAX];
146    char *description;
147    char *devname;
148    DeviceType type;
149    Boolean enabled;
150    Boolean (*init)(struct _device *);
151    Boolean (*get)(char *fname);
152    void (*close)(struct _device *);
153    void *private;
154} Device;
155
156/* Some internal representations of partitions */
157typedef enum {
158    PART_NONE,
159    PART_SLICE,
160    PART_SWAP,
161    PART_FILESYSTEM,
162    PART_FAT,
163} PartType;
164
165/* The longest newfs command we'll hand to system() */
166#define NEWFS_CMD_MAX	256
167
168typedef struct _part_info {
169    Boolean newfs;
170    char mountpoint[FILENAME_MAX];
171    char newfs_cmd[NEWFS_CMD_MAX];
172} PartInfo;
173
174typedef int (*commandFunc)(char *key, void *data);
175
176
177/*** Externs ***/
178extern int		CpioFD;			/* The file descriptor for our CPIO floppy	*/
179extern int		DebugFD;		/* Where diagnostic output goes			*/
180extern Boolean		OnCDROM;		/* Are we running off of a CDROM?		*/
181extern Boolean		OnSerial;		/* Are we on a serial console?			*/
182extern Boolean		SystemWasInstalled;	/* Did we install it?				*/
183extern Boolean		DialogActive;		/* Is the dialog() stuff up?			*/
184extern Boolean		ColorDisplay;		/* Are we on a color display?			*/
185extern Boolean		OnVTY;			/* On a syscons VTY?				*/
186extern Variable		*VarHead;		/* The head of the variable chain		*/
187extern Device		*mediaDevice;		/* Where we're getting our distribution from	*/
188extern unsigned int	Dists;			/* Which distributions we want			*/
189extern unsigned int	SrcDists;		/* Which src distributions we want		*/
190extern unsigned int	XF86Dists;		/* Which XFree86 dists we want			*/
191extern unsigned int	XF86ServerDists;	/* The XFree86 servers we want			*/
192extern unsigned int	XF86FontDists;		/* The XFree86 fonts we want			*/
193
194extern DMenu		MenuInitial;		/* Initial installation menu			*/
195extern DMenu		MenuDocumentation;	/* Documentation menu				*/
196extern DMenu		MenuOptions;		/* Installation options				*/
197extern DMenu		MenuOptionsLanguage;	/* Language options menu			*/
198extern DMenu		MenuOptionsFTP;		/* FTP options menu				*/
199extern DMenu		MenuMedia;		/* Media type menu				*/
200extern DMenu		MenuMediaCDROM;		/* CDROM media menu				*/
201extern DMenu		MenuMediaFloppy;	/* Floppy media menu				*/
202extern DMenu		MenuMediaFTP;		/* FTP media menu				*/
203extern DMenu		MenuInstall;		/* Installation menu				*/
204extern DMenu		MenuInstallType;	/* Installation type menu			*/
205extern DMenu		MenuDistributions;	/* Distribution menu				*/
206extern DMenu		MenuSrcDistributions;	/* Source distribution menu			*/
207extern DMenu		MenuXF86;		/* XFree86 main menu				*/
208extern DMenu		MenuXF86Select;		/* XFree86 distribution selection menu		*/
209extern DMenu		MenuXF86SelectCore;	/* XFree86 core distribution menu		*/
210extern DMenu		MenuXF86SelectServer;	/* XFree86 server distribution menu		*/
211extern DMenu		MenuXF86SelectFonts;	/* XFree86 font selection menu			*/
212extern DMenu		MenuDiskDevices;	/* Disk devices menu				*/
213
214
215/*** Prototypes ***/
216
217/* command.c */
218extern void	command_clear(void);
219extern void	command_sort(void);
220extern void	command_execute(void);
221extern void	command_shell_add(char *key, char *fmt, ...);
222extern void	command_func_add(char *key, commandFunc func, void *data);
223
224/* decode.c */
225extern DMenuItem *decode(DMenu *menu, char *name);
226extern Boolean	dispatch(DMenuItem *tmp, char *name);
227extern Boolean	decode_and_dispatch_multiple(DMenu *menu, char *names);
228
229/* devices.c */
230extern DMenu	*deviceCreateMenu(DMenu *menu, DeviceType type, int (*hook)());
231extern void	deviceGetAll(void);
232extern Device	**deviceFind(char *name, DeviceType type);
233extern int	deviceCount(Device **devs);
234
235/* disks.c */
236extern int	diskPartitionEditor(char *unused);
237
238/* dist.c */
239extern int	distSetDeveloper(char *str);
240extern int	distSetXDeveloper(char *str);
241extern int	distSetUser(char *str);
242extern int	distSetXUser(char *str);
243extern int	distSetMinimum(char *str);
244extern int	distSetEverything(char *str);
245extern int	distSetSrc(char *str);
246extern void	distExtractAll(void);
247
248/* dmenu.c */
249extern void	dmenuOpen(DMenu *menu, int *choice, int *scroll,
250			  int *curr, int *max);
251extern void	dmenuOpenSimple(DMenu *menu);
252
253/* globals.c */
254extern void	globalsInit(void);
255
256/* install.c */
257extern int	installCommit(char *str);
258
259/* lang.c */
260extern void	lang_set_Danish(char *str);
261extern void	lang_set_Dutch(char *str);
262extern void	lang_set_English(char *str);
263extern void	lang_set_French(char *str);
264extern void	lang_set_German(char *str);
265extern void	lang_set_Italian(char *str);
266extern void	lang_set_Japanese(char *str);
267extern void	lang_set_Norwegian(char *str);
268extern void	lang_set_Russian(char *str);
269extern void	lang_set_Spanish(char *str);
270extern void	lang_set_Swedish(char *str);
271
272/* label.c */
273extern int	diskLabelEditor(char *str);
274
275/* makedevs.c (auto-generated) */
276extern const char	termcap_vt100[];
277extern const char	termcap_cons25[];
278extern const char	termcap_cons25_m[];
279extern const char	termcap_cons25r[];
280extern const char	termcap_cons25r_m[];
281extern const char	termcap_cons25l1[];
282extern const char	termcap_cons25l1_m[];
283extern const u_char	font_iso_8x16[];
284extern const u_char	font_cp850_8x16[];
285extern const u_char	font_cp866_8x16[];
286extern const u_char	koi8_r2cp866[];
287extern u_char		default_scrnmap[];
288
289/* media.c */
290extern int	mediaSetCDROM(char *str);
291extern int	mediaSetFloppy(char *str);
292extern int	mediaSetDOS(char *str);
293extern int	mediaSetTape(char *str);
294extern int	mediaSetFTP(char *str);
295extern int	mediaSetFS(char *str);
296extern FILE	*mediaOpen(char *parent, char *me);
297extern Boolean	mediaGetType(void);
298extern Boolean	mediaExtractDist(FILE *fp);
299extern Boolean	mediaVerify(void);
300extern void	mediaClose(void);
301
302/* media_strategy.c */
303extern Boolean	mediaInitUFS(Device *dev);
304extern Boolean	mediaGetUFS(char *dist);
305extern Boolean	mediaInitCDROM(Device *dev);
306extern Boolean	mediaGetFloppy(char *dist);
307extern Boolean	mediaInitFloppy(Device *dev);
308extern Boolean	mediaGetCDROM(char *dist);
309extern Boolean	mediaInitTape(Device *dev);
310extern Boolean	mediaGetTape(char *dist);
311extern Boolean	mediaInitNetwork(Device *dev);
312extern Boolean	mediaGetNetwork(char *dist);
313extern void	mediaCloseTape(Device *dev);
314extern void	mediaCloseCDROM(Device *dev);
315extern void	mediaCloseNetwork(Device *dev);
316extern void	mediaCloseFloppy(Device *dev);
317
318/* misc.c */
319extern Boolean	file_readable(char *fname);
320extern Boolean	file_executable(char *fname);
321extern char	*string_concat(char *p1, char *p2);
322extern char	*string_prune(char *str);
323extern char	*string_skipwhite(char *str);
324extern void	safe_free(void *ptr);
325extern void	*safe_malloc(size_t size);
326extern void	*safe_realloc(void *orig, size_t size);
327extern char	**item_add(char **list, char *item, int *curr, int *max);
328extern char	**item_add_pair(char **list, char *item1, char *item2,
329				int *curr, int *max);
330extern void	items_free(char **list, int *curr, int *max);
331extern int	Mkdir(char *, void *data);
332extern int	Mount(char *, void *data);
333
334/* msg.c */
335extern void	msgInfo(char *fmt, ...);
336extern void	msgYap(char *fmt, ...);
337extern void	msgWarn(char *fmt, ...);
338extern void	msgDebug(char *fmt, ...);
339extern void	msgError(char *fmt, ...);
340extern void	msgFatal(char *fmt, ...);
341extern void	msgConfirm(char *fmt, ...);
342extern void	msgNotify(char *fmt, ...);
343extern int	msgYesNo(char *fmt, ...);
344extern char	*msgGetInput(char *buf, char *fmt, ...);
345
346/* system.c */
347extern void	systemInitialize(int argc, char **argv);
348extern void	systemShutdown(void);
349extern void	systemWelcome(void);
350extern int	systemExecute(char *cmd);
351extern int	systemShellEscape(void);
352extern int	systemDisplayFile(char *file);
353extern char	*systemHelpFile(char *file, char *buf);
354extern void	systemChangeFont(const u_char font[]);
355extern void	systemChangeLang(char *lang);
356extern void	systemChangeTerminal(char *color, const u_char c_termcap[],
357				     char *mono, const u_char m_termcap[]);
358extern void	systemChangeScreenmap(const u_char newmap[]);
359extern int	vsystem(char *fmt, ...);
360
361/* tcpip.c */
362extern int	tcpOpenDialog(char *);
363
364/* termcap.c */
365extern int	set_termcap(void);
366
367/* variables.c */
368extern void	variable_set(char *var);
369extern void	variable_set2(char *name, char *value);
370
371/* wizard.c */
372extern void	slice_wizard(Disk *d);
373
374#endif
375/* _SYSINSTALL_H_INCLUDE */
376