d36d218a9b745e682584abb6373fc4c6533322e2
[oweals/busybox.git] / internal.h
1 /*
2  * Busybox main header file
3  *
4  * Copyright (C) 1998 by Erik Andersen <andersee@debian.org>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell 
21  * Permission has been granted to redistribute this code under the GPL.
22  *
23  */
24 #ifndef _INTERNAL_H_
25 #define _INTERNAL_H_
26
27 #include "busybox.def.h"
28
29 #include <stdlib.h>
30 #include <string.h>
31 #include <unistd.h>
32 #include <sys/stat.h>
33
34
35 /* Some useful definitions */
36 #define STDIN   0
37 #define STDOUT  1
38 #define FALSE   ((int) 1)
39 #define TRUE    ((int) 0)
40
41 #define PATH_LEN        1024
42 #define BUF_SIZE        8192
43 #define EXPAND_ALLOC    1024
44
45 #define isBlank(ch)     (((ch) == ' ') || ((ch) == '\t'))
46 #define isDecimal(ch)   (((ch) >= '0') && ((ch) <= '9'))
47 #define isOctal(ch)     (((ch) >= '0') && ((ch) <= '7'))
48 #define isWildCard(ch)  (((ch) == '*') || ((ch) == '?') || ((ch) == '['))
49
50
51
52 struct FileInfo {
53         unsigned int    complainInPostProcess:1;
54         unsigned int    changeUserID:1;
55         unsigned int    changeGroupID:1;
56         unsigned int    changeMode:1;
57         unsigned int    create:1;
58         unsigned int    force:1;
59         unsigned int    recursive:1;
60         unsigned int    processDirectoriesAfterTheirContents;
61         unsigned int    makeParentDirectories:1;
62         unsigned int    didOperation:1;
63         unsigned int    isSymbolicLink:1;
64         unsigned int    makeSymbolicLink:1;
65         unsigned int    dyadic:1;
66         const char*     source;
67         const char*     destination;
68         int                             directoryLength;
69         uid_t                   userID;
70         gid_t                   groupID;
71         mode_t                  andWithMode;
72         mode_t                  orWithMode;
73         struct stat             stat;
74         const struct Applet *
75                                         applet;
76 };
77
78 struct Applet {
79         const   char*   name;
80         int     (*main)(int argc, char** argv);
81 };
82
83 extern void     name_and_error(const char*);
84 extern int      is_a_directory(const char*);
85 extern char*    join_paths(char *, const char *, const char *);
86
87 extern int      descend(
88                  struct FileInfo *o
89                 ,int            (*function)(const struct FileInfo * i));
90
91 extern struct mntent *
92                 findMountPoint(const char*, const char *);
93
94 extern void usage(const char*);
95 extern int busybox_main(int argc, char** argv);
96 extern int block_device_main(int argc, char** argv);
97 extern int cat_more_main(int argc, char** argv);
98 extern int more_main(int argc, char** argv);
99 extern int cp_main(int argc, char** argv);
100 extern int chgrp_main(int argc, char** argv);
101 extern int chmod_main(int argc, char** argv);
102 extern int chown_main(int argc, char** argv);
103 extern int chroot_main(int argc, char** argv);
104 extern int clear_main(int argc, char** argv);
105 extern int date_main(int argc, char** argv);
106 extern int dd_main(int argc, char** argv);
107 extern int df_main(int argc, char** argv);
108 extern int dmesg_main(int argc, char** argv);
109 extern int dyadic_main(int argc, char** argv);
110 extern int false_main(int argc, char** argv);
111 extern int fdisk_main(int argc, char** argv);
112 extern int find_main(int argc, char** argv);
113 extern int grep_main(int argc, char** argv);
114 extern int halt_main(int argc, char** argv);
115 extern int init_main(int argc, char** argv);
116 extern int kill_main(int argc, char** argv);
117 extern int length_main(int argc, char** argv);
118 extern int ln_main(int argc, char** argv);
119 extern int loadkmap_main(int argc, char** argv);
120 extern int losetup_main(int argc, char** argv);
121 extern int ls_main(int argc, char** argv);
122 extern int makedevs_main(int argc, char** argv);
123 extern int math_main(int argc, char** argv);
124 extern int mknod_main(int argc, char** argv);
125 extern int mkswap_main(int argc, char** argv);
126 extern int mnc_main(int argc, char** argv);
127 extern int monadic_main(int argc, char** argv);
128 extern int mount_main(int argc, char** argv);
129 extern int mt_main(int argc, char** argv);
130 extern int mv_main(int argc, char** argv);
131 extern int printf_main(int argc, char** argv);
132 extern int pwd_main(int argc, char** argv);
133 extern int reboot_main(int argc, char** argv);
134 extern int rm_main(int argc, char** argv);
135 extern int scan_partitions_main(int argc, char** argv);
136 extern int sh_main(int argc, char** argv);
137 extern int sleep_main(int argc, char** argv);
138 extern int tar_main(int argc, char** argv);
139 extern int touch_main(int argc, char** argv);
140 extern int sync_main(int argc, char** argv);
141 extern int tput_main(int argc, char** argv);
142 extern int true_main(int argc, char** argv);
143 extern int tryopen_main(int argc, char** argv);
144 extern int umount_main(int argc, char** argv);
145 extern int update_main(int argc, char** argv);
146 extern int zcat_main(int argc, char** argv);
147 extern int gzip_main(int argc, char** argv);
148
149 extern int
150 parse_mode(
151  const char*    s
152 ,mode_t *               or
153 ,mode_t *               and
154 ,int *                  group_execute);
155
156 extern int              parse_user_name(const char* string, struct FileInfo * i);
157
158
159 /*
160  * A chunk of data.
161  * Chunks contain data which is allocated as needed, but which is
162  * not freed until all of the data needs freeing, such as at
163  * the beginning of the next command.
164  */
165 typedef struct chunk CHUNK;
166 #define CHUNK_INIT_SIZE 4
167
168 struct chunk {
169     CHUNK *next;
170     char data[CHUNK_INIT_SIZE]; /* actually of varying length */
171 };
172
173 const char *modeString(int mode);
174 const char *timeString(time_t timeVal);
175 int isDirectory(const char *name);
176 int isDevice(const char *name);
177 int copyFile(const char *srcName, const char *destName, int setModes,
178                 int followLinks);
179 char *buildName(const char *dirName, const char *fileName);
180 int makeString(int argc, const char **argv, char *buf, int bufLen);
181 char *getChunk(int size);
182 char *chunkstrdup(const char *str);
183 void freeChunks(void);
184 int fullWrite(int fd, const char *buf, int len);
185 int fullRead(int fd, char *buf, int len);
186 int recursiveAction(const char *fileName, int recurse, int followLinks,
187           int (*fileAction) (const char *fileName),
188           int (*dirAction) (const char *fileName));
189 int match(const char* text, const char * pattern);
190 const char* timeString(time_t timeVal);
191
192
193 #endif
194