Header file reorganization and cleaning up the public API for pppd version 2.5.0...

[ppp.git] / pppd / options.h

diff --git a/pppd/options.h b/pppd/options.h
new file mode 100644 (file)
index 0000000..61d2bab
--- /dev/null
+++ b/pppd/options.h
@@ -0,0 +1,114 @@
+/*
+ * options.h - header declarations for option processing for PPP.
+ *
+ * Copyright (c) 2000-2002 Paul Mackerras. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. The name(s) of the authors of this software must not be used to
+ *    endorse or promote products derived from this software without
+ *    prior written permission.
+ *
+ * 3. Redistributions of any form whatsoever must retain the following
+ *    acknowledgment:
+ *    "This product includes software developed by Paul Mackerras
+ *     <paulus@samba.org>".
+ *
+ * THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO
+ * THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
+ * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+ * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
+ * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#ifndef PPP_OPTIONS_H
+#define PPP_OPTIONS_H
+
+enum opt_type {
+       o_special_noarg,
+       o_special,
+       o_bool,
+       o_int,
+       o_uint32,
+       o_string,
+       o_wild
+};
+
+struct option {
+       char    *name;          /* name of the option */
+       enum opt_type type;
+       void    *addr;
+       char    *description;
+       unsigned int flags;
+       void    *addr2;
+       int     upper_limit;
+       int     lower_limit;
+       const char *source;
+       short int priority;
+       short int winner;
+};
+
+typedef struct option option_t;
+
+/* Values for flags */
+#define OPT_VALUE      0xff    /* mask for presupplied value */
+#define OPT_HEX                0x100   /* int option is in hex */
+#define OPT_NOARG      0x200   /* option doesn't take argument */
+#define OPT_OR         0x400   /* for u32, OR in argument to value */
+#define OPT_INC                0x400   /* for o_int, increment value */
+#define OPT_A2OR       0x800   /* for o_bool, OR arg to *(u_char *)addr2 */
+#define OPT_PRIV       0x1000  /* privileged option */
+#define OPT_STATIC     0x2000  /* string option goes into static array */
+#define OPT_NOINCR     0x2000  /* for o_int, value mustn't be increased */
+#define OPT_LLIMIT     0x4000  /* check value against lower limit */
+#define OPT_ULIMIT     0x8000  /* check value against upper limit */
+#define OPT_LIMITS     (OPT_LLIMIT|OPT_ULIMIT)
+#define OPT_ZEROOK     0x10000 /* 0 value is OK even if not within limits */
+#define OPT_HIDE       0x10000 /* for o_string, print value as ?????? */
+#define OPT_A2LIST     0x20000 /* for o_special, keep list of values */
+#define OPT_A2CLRB     0x20000 /* o_bool, clr val bits in *(u_char *)addr2 */
+#define OPT_ZEROINF    0x40000 /* with OPT_NOINCR, 0 == infinity */
+#define OPT_PRIO       0x80000 /* process option priorities for this option */
+#define OPT_PRIOSUB    0x100000 /* subsidiary member of priority group */
+#define OPT_ALIAS      0x200000 /* option is alias for previous option */
+#define OPT_A2COPY     0x400000 /* addr2 -> second location to rcv value */
+#define OPT_ENABLE     0x800000 /* use *addr2 as enable for option */
+#define OPT_A2CLR      0x1000000 /* clear *(bool *)addr2 */
+#define OPT_PRIVFIX    0x2000000 /* user can't override if set by root */
+#define OPT_INITONLY   0x4000000 /* option can only be set in init phase */
+#define OPT_DEVEQUIV   0x8000000 /* equiv to device name */
+#define OPT_DEVNAM     (OPT_INITONLY | OPT_DEVEQUIV)
+#define OPT_A2PRINTER  0x10000000 /* *addr2 printer_func to print option */
+#define OPT_A2STRVAL   0x20000000 /* *addr2 points to current string value */
+#define OPT_NOPRINT    0x40000000 /* don't print this option at all */
+
+#define OPT_VAL(x)     ((x) & OPT_VALUE)
+
+/* Values for priority */
+#define OPRIO_DEFAULT   0      /* a default value */
+#define OPRIO_CFGFILE   1      /* value from a configuration file */
+#define OPRIO_CMDLINE   2      /* value from the command line */
+#define OPRIO_SECFILE   3      /* value from options in a secrets file */
+#define OPRIO_ROOT      100    /* added to priority if OPT_PRIVFIX && root */
+
+/* Add additional supported options by e.g. plug-in */
+void ppp_add_options(struct option *options);
+
+/* Parse options from an options file */
+int ppp_options_from_file(char *filename, int must_exist, int check_prot,
+                      int privileged);
+
+/* Simplified number_option for decimal ints */
+int ppp_int_option(char *name, int *value);
+
+/* Print an error message about an option */
+void ppp_option_error(char *fmt, ...);
+
+#endif