usr.sbin/ppp/command.h

   1 /*-
   2  * Copyright (c) 1996 - 2001 Brian Somers <brian@Awfulhak.org>
   3  *          based on work by Toshiharu OHNO <tony-o@iij.ad.jp>
   4  *                           Internet Initiative Japan, Inc (IIJ)
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/usr.sbin/ppp/command.h,v 1.20.2.3 2002/09/01 02:12:26 brian Exp $
  29  * $DragonFly: src/usr.sbin/ppp/command.h,v 1.2 2003/06/17 04:30:00 dillon Exp $
  30  */
  31
  32 struct cmdtab;
  33 struct bundle;
  34 struct datalink;
  35 struct prompt;
  36
  37 struct cmdargs {
  38   struct cmdtab const *cmdtab;          /* The entire command table */
  39   struct cmdtab const *cmd;             /* This command entry */
  40   int argc;                             /* Number of arguments (excluding cmd */
  41   int argn;                             /* Argument to start processing from */
  42   char const *const *argv;              /* Arguments */
  43   struct bundle *bundle;                /* Our bundle */
  44   struct datalink *cx;                  /* Our context */
  45   struct prompt *prompt;                /* Who executed us */
  46 };
  47
  48 struct cmdtab {
  49   const char *name;
  50   const char *alias;
  51   int (*func) (struct cmdargs const *);
  52   u_char lauth;
  53   const char *helpmes;
  54   const char *syntax;
  55   const void *args;
  56 };
  57
  58 #define NEG_ACCEPTED (1)
  59 #define NEG_ENABLED (2)
  60 #define IsAccepted(x) ((x) & NEG_ACCEPTED)
  61 #define IsEnabled(x) ((x) & NEG_ENABLED)
  62
  63 extern const char Version[];
  64
  65 extern void command_Expand(char **, int, char const *const *, struct bundle *,
  66                            int, pid_t);
  67 extern void command_Free(int, char **);
  68 extern int command_Expand_Interpret(char *, int, char *vector[MAXARGS], int);
  69 extern int command_Interpret(char *, int, char *vector[MAXARGS]);
  70 extern void command_Run(struct bundle *, int, char const *const *,
  71                         struct prompt *, const char *, struct datalink *);
  72 extern int command_Decode(struct bundle *, char *, int, struct prompt *,
  73                            const char *);
  74 extern struct link *command_ChooseLink(struct cmdargs const *);
  75 extern const char *command_ShowNegval(unsigned);
  76