sade.h revision 8642
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.23 1995/05/20 10:33:11 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_DOS,
141    DEVICE_TYPE_ANY,
142} DeviceType;
143
144/* A "device" from sysinstall's point of view */
145typedef struct _device {
146    char name[DEV_NAME_MAX];
147    char *description;
148    char *devname;
149    DeviceType type;
150    Boolean enabled;
151    Boolean (*init)(struct _device *);
152    Boolean (*get)(char *fname);
153    void (*close)(struct _device *);
154    void *private;
155} Device;
156
157/* Some internal representations of partitions */
158typedef enum {
159    PART_NONE,
160    PART_SLICE,
161    PART_SWAP,
162    PART_FILESYSTEM,
163    PART_FAT,
164} PartType;
165
166/* The longest newfs command we'll hand to system() */
167#define NEWFS_CMD_MAX	256
168
169typedef struct _part_info {
170    Boolean newfs;
171    char mountpoint[FILENAME_MAX];
172    char newfs_cmd[NEWFS_CMD_MAX];
173} PartInfo;
174
175typedef int (*commandFunc)(char *key, void *data);
176
177
178/*** Externs ***/
179extern int		CpioFD;			/* The file descriptor for our CPIO floppy	*/
180extern int		DebugFD;		/* Where diagnostic output goes			*/
181extern Boolean		OnCDROM;		/* Are we running off of a CDROM?		*/
182extern Boolean		OnSerial;		/* Are we on a serial console?			*/
183extern Boolean		SystemWasInstalled;	/* Did we install it?				*/
184extern Boolean		DialogActive;		/* Is the dialog() stuff up?			*/
185extern Boolean		ColorDisplay;		/* Are we on a color display?			*/
186extern Boolean		OnVTY;			/* On a syscons VTY?				*/
187extern Variable		*VarHead;		/* The head of the variable chain		*/
188extern Device		*mediaDevice;		/* Where we're getting our distribution from	*/
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
195extern DMenu		MenuInitial;		/* Initial installation menu			*/
196extern DMenu		MenuDocumentation;	/* Documentation menu				*/
197extern DMenu		MenuOptions;		/* Installation options				*/
198extern DMenu		MenuOptionsLanguage;	/* Language options menu			*/
199extern DMenu		MenuOptionsFTP;		/* FTP options menu				*/
200extern DMenu		MenuMedia;		/* Media type menu				*/
201extern DMenu		MenuMediaCDROM;		/* CDROM media menu				*/
202extern DMenu		MenuMediaFloppy;	/* Floppy media menu				*/
203extern DMenu		MenuMediaFTP;		/* FTP media menu				*/
204extern DMenu		MenuInstall;		/* Installation menu				*/
205extern DMenu		MenuInstallType;	/* Installation type menu			*/
206extern DMenu		MenuDistributions;	/* Distribution menu				*/
207extern DMenu		MenuSrcDistributions;	/* Source distribution menu			*/
208extern DMenu		MenuXF86;		/* XFree86 main menu				*/
209extern DMenu		MenuXF86Select;		/* XFree86 distribution selection menu		*/
210extern DMenu		MenuXF86SelectCore;	/* XFree86 core distribution menu		*/
211extern DMenu		MenuXF86SelectServer;	/* XFree86 server distribution menu		*/
212extern DMenu		MenuXF86SelectFonts;	/* XFree86 font selection menu			*/
213extern DMenu		MenuDiskDevices;	/* Disk devices menu				*/
214
215
216/*** Prototypes ***/
217
218/* command.c */
219extern void	command_clear(void);
220extern void	command_sort(void);
221extern void	command_execute(void);
222extern void	command_shell_add(char *key, char *fmt, ...);
223extern void	command_func_add(char *key, commandFunc func, void *data);
224
225/* decode.c */
226extern DMenuItem *decode(DMenu *menu, char *name);
227extern Boolean	dispatch(DMenuItem *tmp, char *name);
228extern Boolean	decode_and_dispatch_multiple(DMenu *menu, char *names);
229
230/* devices.c */
231extern DMenu	*deviceCreateMenu(DMenu *menu, DeviceType type, int (*hook)());
232extern void	deviceGetAll(void);
233extern Device	**deviceFind(char *name, DeviceType type);
234extern int	deviceCount(Device **devs);
235extern Device	*new_device(char *name);
236extern Device	*deviceRegister(char *name, char *desc, char *devname, DeviceType type, Boolean enabled,
237				Boolean (*init)(Device *mediadev), Boolean (*get)(char *distname),
238				void (*close)(Device *mediadev), void *private);
239
240/* disks.c */
241extern int	diskPartitionEditor(char *unused);
242
243/* dist.c */
244extern int	distSetDeveloper(char *str);
245extern int	distSetXDeveloper(char *str);
246extern int	distSetUser(char *str);
247extern int	distSetXUser(char *str);
248extern int	distSetMinimum(char *str);
249extern int	distSetEverything(char *str);
250extern int	distSetSrc(char *str);
251extern void	distExtractAll(void);
252
253/* dmenu.c */
254extern void	dmenuOpen(DMenu *menu, int *choice, int *scroll,
255			  int *curr, int *max);
256extern void	dmenuOpenSimple(DMenu *menu);
257
258/* globals.c */
259extern void	globalsInit(void);
260
261/* install.c */
262extern int	installCommit(char *str);
263
264/* lang.c */
265extern void	lang_set_Danish(char *str);
266extern void	lang_set_Dutch(char *str);
267extern void	lang_set_English(char *str);
268extern void	lang_set_French(char *str);
269extern void	lang_set_German(char *str);
270extern void	lang_set_Italian(char *str);
271extern void	lang_set_Japanese(char *str);
272extern void	lang_set_Norwegian(char *str);
273extern void	lang_set_Russian(char *str);
274extern void	lang_set_Spanish(char *str);
275extern void	lang_set_Swedish(char *str);
276
277/* label.c */
278extern int	diskLabelEditor(char *str);
279
280/* makedevs.c (auto-generated) */
281extern const char	termcap_vt100[];
282extern const char	termcap_cons25[];
283extern const char	termcap_cons25_m[];
284extern const char	termcap_cons25r[];
285extern const char	termcap_cons25r_m[];
286extern const char	termcap_cons25l1[];
287extern const char	termcap_cons25l1_m[];
288extern const u_char	font_iso_8x16[];
289extern const u_char	font_cp850_8x16[];
290extern const u_char	font_cp866_8x16[];
291extern const u_char	koi8_r2cp866[];
292extern u_char		default_scrnmap[];
293
294/* media.c */
295extern int	mediaSetCDROM(char *str);
296extern int	mediaSetFloppy(char *str);
297extern int	mediaSetDOS(char *str);
298extern int	mediaSetTape(char *str);
299extern int	mediaSetFTP(char *str);
300extern int	mediaSetFS(char *str);
301extern FILE	*mediaOpen(char *parent, char *me);
302extern Boolean	mediaGetType(void);
303extern Boolean	mediaExtractDist(FILE *fp);
304extern Boolean	mediaVerify(void);
305extern void	mediaClose(void);
306
307/* media_strategy.c */
308extern Boolean	mediaInitUFS(Device *dev);
309extern Boolean	mediaGetUFS(char *dist);
310extern Boolean	mediaInitCDROM(Device *dev);
311extern Boolean	mediaInitDOS(Device *dev);
312extern Boolean	mediaGetFloppy(char *dist);
313extern Boolean	mediaInitFloppy(Device *dev);
314extern Boolean	mediaGetCDROM(char *dist);
315extern Boolean	mediaGetDOS(char *dist);
316extern Boolean	mediaInitTape(Device *dev);
317extern Boolean	mediaGetTape(char *dist);
318extern Boolean	mediaInitNetwork(Device *dev);
319extern Boolean	mediaGetNetwork(char *dist);
320extern void	mediaCloseTape(Device *dev);
321extern void	mediaCloseCDROM(Device *dev);
322extern void	mediaCloseDOS(Device *dev);
323extern void	mediaCloseNetwork(Device *dev);
324extern void	mediaCloseFloppy(Device *dev);
325
326/* misc.c */
327extern Boolean	file_readable(char *fname);
328extern Boolean	file_executable(char *fname);
329extern char	*string_concat(char *p1, char *p2);
330extern char	*string_prune(char *str);
331extern char	*string_skipwhite(char *str);
332extern void	safe_free(void *ptr);
333extern void	*safe_malloc(size_t size);
334extern void	*safe_realloc(void *orig, size_t size);
335extern char	**item_add(char **list, char *item, int *curr, int *max);
336extern char	**item_add_pair(char **list, char *item1, char *item2,
337				int *curr, int *max);
338extern void	items_free(char **list, int *curr, int *max);
339extern int	Mkdir(char *, void *data);
340extern int	Mount(char *, void *data);
341
342/* msg.c */
343extern void	msgInfo(char *fmt, ...);
344extern void	msgYap(char *fmt, ...);
345extern void	msgWarn(char *fmt, ...);
346extern void	msgDebug(char *fmt, ...);
347extern void	msgError(char *fmt, ...);
348extern void	msgFatal(char *fmt, ...);
349extern void	msgConfirm(char *fmt, ...);
350extern void	msgNotify(char *fmt, ...);
351extern int	msgYesNo(char *fmt, ...);
352extern char	*msgGetInput(char *buf, char *fmt, ...);
353
354/* system.c */
355extern void	systemInitialize(int argc, char **argv);
356extern void	systemShutdown(void);
357extern void	systemWelcome(void);
358extern int	systemExecute(char *cmd);
359extern int	systemShellEscape(void);
360extern int	systemDisplayFile(char *file);
361extern char	*systemHelpFile(char *file, char *buf);
362extern void	systemChangeFont(const u_char font[]);
363extern void	systemChangeLang(char *lang);
364extern void	systemChangeTerminal(char *color, const u_char c_termcap[],
365				     char *mono, const u_char m_termcap[]);
366extern void	systemChangeScreenmap(const u_char newmap[]);
367extern int	vsystem(char *fmt, ...);
368
369/* tcpip.c */
370extern int	tcpOpenDialog(char *);
371
372/* termcap.c */
373extern int	set_termcap(void);
374
375/* variables.c */
376extern void	variable_set(char *var);
377extern void	variable_set2(char *name, char *value);
378
379/* wizard.c */
380extern void	slice_wizard(Disk *d);
381
382#endif
383/* _SYSINSTALL_H_INCLUDE */
384