sysinstall.h revision 8601 
1197138Shrs/*
2197138Shrs * The new sysinstall program.
3197138Shrs *
4197138Shrs * This is probably the last attempt in the `sysinstall' line, the next
5197138Shrs * generation being slated to essentially a complete rewrite.
6197138Shrs *
7197138Shrs * $Id: sysinstall.h,v 1.18 1995/05/17 14:39:56 jkh Exp $
8197138Shrs *
9197138Shrs * Copyright (c) 1995
10197138Shrs *	Jordan Hubbard.  All rights reserved.
11197138Shrs *
12197138Shrs * Redistribution and use in source and binary forms, with or without
13197138Shrs * modification, are permitted provided that the following conditions
14197138Shrs * are met:
15197138Shrs * 1. Redistributions of source code must retain the above copyright
16197138Shrs *    notice, this list of conditions and the following disclaimer,
17197138Shrs *    verbatim and that no modifications are made prior to this
18197138Shrs *    point in the file.
19197138Shrs * 2. Redistributions in binary form must reproduce the above copyright
20197138Shrs *    notice, this list of conditions and the following disclaimer in the
21197138Shrs *    documentation and/or other materials provided with the distribution.
22197138Shrs * 3. All advertising materials mentioning features or use of this software
23197138Shrs *    must display the following acknowledgement:
24197138Shrs *	This product includes software developed by Jordan Hubbard
25197138Shrs *	for the FreeBSD Project.
26197138Shrs * 4. The name of Jordan Hubbard or the FreeBSD project may not be used to
27197138Shrs *    endorse or promote products derived from this software without specific
28197138Shrs *    prior written permission.
29197138Shrs *
30197138Shrs * THIS SOFTWARE IS PROVIDED BY JORDAN HUBBARD ``AS IS'' AND
31197138Shrs * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32197138Shrs * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33197138Shrs * ARE DISCLAIMED.  IN NO EVENT SHALL JORDAN HUBBARD OR HIS PETS BE LIABLE
34197138Shrs * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35197138Shrs * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36197138Shrs * OR SERVICES; LOSS OF USE, DATA, LIFE OR PROFITS; OR BUSINESS INTERRUPTION)
37197138Shrs * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38197138Shrs * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39197138Shrs * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40197138Shrs * SUCH DAMAGE.
41197138Shrs *
42197138Shrs */
43197138Shrs
44197138Shrs#ifndef _SYSINSTALL_H_INCLUDE
45197138Shrs#define _SYSINSTALL_H_INCLUDE
46197138Shrs
47197138Shrs#include <stdio.h>
48197138Shrs#include <stdlib.h>
49197138Shrs#include <string.h>
50197138Shrs#include <unistd.h>
51197138Shrs#include <dialog.h>
52197138Shrs#include "libdisk.h"
53197138Shrs#include "dist.h"
54197138Shrs
55197138Shrs/*** Defines ***/
56197138Shrs
57197138Shrs/* Bitfields for menu options */
58197138Shrs#define DMENU_NORMAL_TYPE	0x1	/* Normal dialog menu		*/
59198006Shrs#define DMENU_RADIO_TYPE	0x2	/* Radio dialog menu		*/
60198006Shrs#define DMENU_MULTIPLE_TYPE	0x4	/* Multiple choice menu		*/
61282622Shiren#define DMENU_SELECTION_RETURNS	0x8	/* Select item then exit	*/
62282622Shiren#define DMENU_CALL_FIRST	0x10	/* In multiple, use one handler */
63197138Shrs
64197138Shrs/* variable limits */
65197138Shrs#define VAR_NAME_MAX		128
66197138Shrs#define VAR_VALUE_MAX		1024
67222711Shrs
68197138Shrs/* device limits */
69197138Shrs#define DEV_NAME_MAX		128	/* The maximum length of a device name	*/
70197138Shrs#define DEV_MAX			200	/* The maximum number of devices we'll deal with */
71197138Shrs#define INTERFACE_MAX		50	/* Maximum number of network interfaces we'll deal with */
72197138Shrs
73197138Shrs
74197138Shrs/* Internal flag variables */
75197138Shrs#define DISK_PARTITIONED	"_diskPartitioned"
76197138Shrs#define DISK_LABELLED		"_diskLabelled"
77197138Shrs#define TCP_CONFIGURED		"_tcpConfigured"
78197138Shrs#define NO_CONFIRMATION		"_noConfirmation"
79197138Shrs#define MEDIA_DEVICE		"mediaDevice"
80197138Shrs#define MEDIA_TYPE		"mediaType"
81197138Shrs
82197138Shrs#define VAR_HOSTNAME		"hostname"
83197138Shrs#define VAR_DOMAINNAME		"domainname"
84197138Shrs#define VAR_NAMESERVER		"nameserver"
85197138Shrs#define VAR_GATEWAY		"gateway"
86197138Shrs
87197138Shrs#define VAR_IFCONFIG		"ifconfig_"
88197138Shrs
89197138Shrs/* The help file for the TCP/IP setup screen */
90197138Shrs#define TCP_HELPFILE		"tcp.hlp"
91197138Shrs
92197138Shrs/*** Types ***/
93197138Shrstypedef unsigned int Boolean;
94197138Shrstypedef struct disk Disk;
95197138Shrstypedef struct chunk Chunk;
96197138Shrs
97197138Shrstypedef enum {
98197138Shrs    DMENU_SHELL_ESCAPE,			/* Fork a shell			*/
99197138Shrs    DMENU_DISPLAY_FILE,			/* Display a file's contents	*/
100197138Shrs    DMENU_SUBMENU,			/* Recurse into another menu	*/
101197138Shrs    DMENU_SYSTEM_COMMAND,		/* Run shell commmand		*/
102197138Shrs    DMENU_SYSTEM_COMMAND_BOX,		/* Same as above, but in prgbox	*/
103197138Shrs    DMENU_SET_VARIABLE,			/* Set an environment/system var */
104197138Shrs    DMENU_SET_FLAG,			/* Set flag in an unsigned int	*/
105197138Shrs    DMENU_CALL,				/* Call back a C function	*/
106197138Shrs    DMENU_CANCEL,			/* Cancel out of this menu	*/
107197138Shrs    DMENU_NOP,				/* Do nothing special for item	*/
108197138Shrs} DMenuItemType;
109197138Shrs
110197138Shrstypedef struct _dmenuItem {
111197138Shrs    char *title;			/* Our title			*/
112197138Shrs    char *prompt;			/* Our prompt			*/
113197138Shrs    DMenuItemType type;			/* What type of item we are	*/
114197138Shrs    void *ptr;				/* Generic data ptr		*/
115197138Shrs    u_long parm;			/* Parameter for above		*/
116197138Shrs    Boolean disabled;			/* Are we temporarily disabled?	*/
117197138Shrs} DMenuItem;
118197138Shrs
119197138Shrstypedef struct _dmenu {
120197138Shrs    unsigned int options;		/* What sort of menu we are	*/
121197138Shrs    char *title;			/* Our title			*/
122197138Shrs    char *prompt;			/* Our prompt			*/
123197138Shrs    char *helpline;			/* Line of help at bottom	*/
124197138Shrs    char *helpfile;			/* Help file for "F1"		*/
125197138Shrs    DMenuItem items[0];			/* Array of menu items		*/
126197138Shrs} DMenu;
127197138Shrs
128197138Shrs/* A sysconfig variable */
129197138Shrstypedef struct _variable {
130197138Shrs    struct _variable *next;
131197138Shrs    char name[VAR_NAME_MAX];
132197138Shrs    char value[VAR_VALUE_MAX];
133197138Shrs} Variable;
134197138Shrs
135197138Shrstypedef enum {
136197138Shrs    DEVICE_TYPE_NONE,
137197138Shrs    DEVICE_TYPE_DISK,
138197138Shrs    DEVICE_TYPE_FLOPPY,
139197138Shrs    DEVICE_TYPE_NETWORK,
140197138Shrs    DEVICE_TYPE_CDROM,
141222711Shrs    DEVICE_TYPE_TAPE,
142197138Shrs    DEVICE_TYPE_ANY,
143197138Shrs} DeviceType;
144197138Shrs
145197138Shrs/* A "device" from sysinstall's point of view */
146198006Shrstypedef struct _device {
147222711Shrs    char name[DEV_NAME_MAX];
148197138Shrs    char *description;
149197138Shrs    DeviceType type;
150197138Shrs    Boolean enabled;
151197138Shrs    Boolean (*init)(struct _device *);
152252557Shrs    Boolean (*get)(char *fname);
153235285Shrs    void (*close)(struct _device *);
154197138Shrs    void *private;
155197138Shrs} Device;
156197138Shrs
157197138Shrs/* Some internal representations of partitions */
158235285Shrstypedef enum {
159235285Shrs    PART_NONE,
160197138Shrs    PART_SLICE,
161197138Shrs    PART_SWAP,
162197138Shrs    PART_FILESYSTEM,
163197138Shrs    PART_FAT,
164197138Shrs} PartType;
165197138Shrs
166197138Shrs/* The longest newfs command we'll hand to system() */
167198006Shrs#define NEWFS_CMD_MAX	256
168198006Shrs
169198006Shrstypedef struct _part_info {
170197138Shrs    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 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);
233
234/* disks.c */
235extern int	diskPartitionEditor(char *unused);
236
237/* dist.c */
238extern int	distSetDeveloper(char *str);
239extern int	distSetXDeveloper(char *str);
240extern int	distSetUser(char *str);
241extern int	distSetXUser(char *str);
242extern int	distSetMinimum(char *str);
243extern int	distSetEverything(char *str);
244extern int	distSetSrc(char *str);
245extern void	distExtractAll(void);
246
247/* dmenu.c */
248extern void	dmenuOpen(DMenu *menu, int *choice, int *scroll,
249			  int *curr, int *max);
250extern void	dmenuOpenSimple(DMenu *menu);
251
252/* globals.c */
253extern void	globalsInit(void);
254
255/* install.c */
256extern int	installCommit(char *str);
257
258/* lang.c */
259extern void	lang_set_Danish(char *str);
260extern void	lang_set_Dutch(char *str);
261extern void	lang_set_English(char *str);
262extern void	lang_set_French(char *str);
263extern void	lang_set_German(char *str);
264extern void	lang_set_Italian(char *str);
265extern void	lang_set_Japanese(char *str);
266extern void	lang_set_Norwegian(char *str);
267extern void	lang_set_Russian(char *str);
268extern void	lang_set_Spanish(char *str);
269extern void	lang_set_Swedish(char *str);
270
271/* label.c */
272extern int	diskLabelEditor(char *str);
273
274/* makedevs.c (auto-generated) */
275extern const char	termcap_vt100[];
276extern const char	termcap_cons25[];
277extern const char	termcap_cons25_m[];
278extern const char	termcap_cons25r[];
279extern const char	termcap_cons25r_m[];
280extern const char	termcap_cons25l1[];
281extern const char	termcap_cons25l1_m[];
282extern const u_char	font_iso_8x16[];
283extern const u_char	font_cp850_8x16[];
284extern const u_char	font_koi8_r_8x16[];
285
286/* media.c */
287extern int	mediaSetCDROM(char *str);
288extern int	mediaSetFloppy(char *str);
289extern int	mediaSetDOS(char *str);
290extern int	mediaSetTape(char *str);
291extern int	mediaSetFTP(char *str);
292extern int	mediaSetFS(char *str);
293extern FILE	*mediaOpen(char *parent, char *me);
294extern Boolean	mediaGetType(void);
295extern Boolean	mediaExtractDist(FILE *fp);
296extern Boolean	mediaVerify(void);
297
298/* media_strategy.c */
299extern Boolean	mediaInitUFS(Device *dev);
300extern Boolean	mediaGetUFS(char *dist);
301extern Boolean	mediaInitCDROM(Device *dev);
302extern Boolean	mediaGetFloppy(char *dist);
303extern Boolean	mediaInitFloppy(Device *dev);
304extern Boolean	mediaGetCDROM(char *dist);
305extern Boolean	mediaInitTape(Device *dev);
306extern Boolean	mediaGetTape(char *dist);
307extern Boolean	mediaInitNetwork(Device *dev);
308extern Boolean	mediaGetNetwork(char *dist);
309extern void	mediaCloseTape(Device *dev);
310extern void	mediaCloseCDROM(Device *dev);
311extern void	mediaCloseNetwork(Device *dev);
312extern void	mediaCloseFloppy(Device *dev);
313
314/* misc.c */
315extern Boolean	file_readable(char *fname);
316extern Boolean	file_executable(char *fname);
317extern char	*string_concat(char *p1, char *p2);
318extern char	*string_prune(char *str);
319extern char	*string_skipwhite(char *str);
320extern void	safe_free(void *ptr);
321extern void	*safe_malloc(size_t size);
322extern void	*safe_realloc(void *orig, size_t size);
323extern char	**item_add(char **list, char *item, int *curr, int *max);
324extern char	**item_add_pair(char **list, char *item1, char *item2,
325				int *curr, int *max);
326extern void	items_free(char **list, int *curr, int *max);
327extern int	Mkdir(char *, void *data);
328extern int	Mount(char *, void *data);
329
330/* msg.c */
331extern void	msgInfo(char *fmt, ...);
332extern void	msgYap(char *fmt, ...);
333extern void	msgWarn(char *fmt, ...);
334extern void	msgDebug(char *fmt, ...);
335extern void	msgError(char *fmt, ...);
336extern void	msgFatal(char *fmt, ...);
337extern void	msgConfirm(char *fmt, ...);
338extern void	msgNotify(char *fmt, ...);
339extern int	msgYesNo(char *fmt, ...);
340extern char	*msgGetInput(char *buf, char *fmt, ...);
341
342/* system.c */
343extern void	systemInitialize(int argc, char **argv);
344extern void	systemShutdown(void);
345extern void	systemWelcome(void);
346extern int	systemExecute(char *cmd);
347extern int	systemShellEscape(void);
348extern int	systemDisplayFile(char *file);
349extern char	*systemHelpFile(char *file, char *buf);
350extern void	systemChangeFont(const u_char font[]);
351extern void	systemChangeLang(char *lang);
352extern void	systemChangeTerminal(char *color, const u_char c_termcap[],
353				     char *mono, const u_char m_termcap[]);
354extern void	systemChangeScreenmap(const u_char newmap[]);
355extern int	vsystem(char *fmt, ...);
356
357/* tcpip.c */
358extern int	tcpOpenDialog(char *);
359
360/* termcap.c */
361extern int	set_termcap(void);
362
363/* variables.c */
364extern void	variable_set(char *var);
365extern void	variable_set2(char *name, char *value);
366
367/* wizard.c */
368extern void	slice_wizard(Disk *d);
369
370#endif
371/* _SYSINSTALL_H_INCLUDE */
372