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