Remove requirement that include/applets.h must be sorted
[oweals/busybox.git] / include / busybox.h
index 1f9f9775f08eb3237f8ff4ea5fb6303d24b44114..48ce856ea37d0791f2ddafb32a0ce6bb90aec277 100644 (file)
@@ -4,72 +4,71 @@
  *
  * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
  */
-#ifndef        _BB_INTERNAL_H_
-#define        _BB_INTERNAL_H_    1
+#ifndef BUSYBOX_H
+#define BUSYBOX_H 1
 
-#include "bb_config.h"
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdarg.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-
-extern const char BB_BANNER[];
-
-/* Pull in the utility routines from libbb */
 #include "libbb.h"
 
-enum Location {
+PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
+
+/* order matters: used as index into "install_dir[]" in appletlib.c */
+typedef enum bb_install_loc_t {
        _BB_DIR_ROOT = 0,
        _BB_DIR_BIN,
        _BB_DIR_SBIN,
        _BB_DIR_USR_BIN,
        _BB_DIR_USR_SBIN
-};
+} bb_install_loc_t;
 
-enum SUIDRoot {
-       _BB_SUID_NEVER = 0,
+typedef enum bb_suid_t {
+       _BB_SUID_DROP = 0,
        _BB_SUID_MAYBE,
-       _BB_SUID_ALWAYS
-};
+       _BB_SUID_REQUIRE
+} bb_suid_t;
 
-struct BB_applet {
-       const char *name;
-       int (*main) (int argc, char **argv);
-       __extension__ enum Location location:4;
-       __extension__ enum SUIDRoot need_suid:4;
-};
 
-/* From busybox.c */
-extern const struct BB_applet applets[];
+/* Defined in appletlib.c (by including generated applet_tables.h) */
+/* Keep in sync with applets/applet_tables.c! */
+extern const char applet_names[];
+extern int (*const applet_main[])(int argc, char **argv);
+extern const uint16_t applet_nameofs[];
+extern const uint8_t applet_install_loc[];
 
-/* Automagically pull in all the applet function prototypes and
- * applet usage strings.  These are all of the form:
- *             extern int foo_main(int argc, char **argv);
- *             extern const char foo_usage[];
- * These are all autogenerated from the set of currently defined applets.
- */
-#define PROTOTYPES
-#include "applets.h"
-#undef PROTOTYPES
+#if ENABLE_FEATURE_SUID || ENABLE_FEATURE_PREFER_APPLETS
+#define APPLET_NAME(i) (applet_names + (applet_nameofs[i] & 0x0fff))
+#else
+#define APPLET_NAME(i) (applet_names + applet_nameofs[i])
+#endif
 
-#ifndef RB_POWER_OFF
-/* Stop system and switch power off if possible.  */
-#define RB_POWER_OFF   0x4321fedc
+#if ENABLE_FEATURE_PREFER_APPLETS
+#define APPLET_IS_NOFORK(i) (applet_nameofs[i] & (1 << 12))
+#define APPLET_IS_NOEXEC(i) (applet_nameofs[i] & (1 << 13))
 #endif
 
-/* Try to pull in PATH_MAX */
-#include <limits.h>
+#if ENABLE_FEATURE_SUID
+#define APPLET_SUID(i) ((applet_nameofs[i] >> 14) & 0x3)
+#endif
 
-/* for PATH_MAX on systems that don't have it in limits.h */
-#include <sys/param.h>
-#ifndef PATH_MAX
-#define  PATH_MAX         256
+#if ENABLE_FEATURE_INSTALLER
+#define APPLET_INSTALL_LOC(i) ({ \
+       unsigned v = (i); \
+       if (v & 1) v = applet_install_loc[v/2] >> 4; \
+       else v = applet_install_loc[v/2] & 0xf; \
+       v; })
 #endif
 
-#ifdef DMALLOC
-#include <dmalloc.h>
+
+/* Length of these names has effect on size of libbusybox
+ * and "individual" binaries. Keep them short.
+ */
+#if ENABLE_BUILD_LIBBUSYBOX
+#if ENABLE_FEATURE_SHARED_BUSYBOX
+int lbb_main(char **argv) EXTERNALLY_VISIBLE;
+#else
+int lbb_main(char **argv);
 #endif
+#endif
+
+POP_SAVED_FUNCTION_VISIBILITY
 
-#endif                                                 /* _BB_INTERNAL_H_ */
+#endif