xref: /freebsd/usr.sbin/ppp/command.h (revision b3e7694832e81d7a904a10f525f8797b753bf0d3)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 
31 struct cmdtab;
32 struct bundle;
33 struct datalink;
34 struct prompt;
35 
36 struct cmdargs {
37   struct cmdtab const *cmdtab;		/* The entire command table */
38   struct cmdtab const *cmd;		/* This command entry */
39   int argc;				/* Number of arguments (excluding cmd */
40   int argn;				/* Argument to start processing from */
41   char const *const *argv;		/* Arguments */
42   struct bundle *bundle;		/* Our bundle */
43   struct datalink *cx;			/* Our context */
44   struct prompt *prompt;		/* Who executed us */
45 };
46 
47 struct cmdtab {
48   const char *name;
49   const char *alias;
50   int (*func) (struct cmdargs const *);
51   u_char lauth;
52   const char *helpmes;
53   const char *syntax;
54   const void *args;
55 };
56 
57 #define NEG_ACCEPTED (1)
58 #define NEG_ENABLED (2)
59 #define IsAccepted(x) ((x) & NEG_ACCEPTED)
60 #define IsEnabled(x) ((x) & NEG_ENABLED)
61 
62 extern const char Version[];
63 
64 extern void command_Expand(char **, int, char const *const *, struct bundle *,
65                            int, pid_t);
66 extern void command_Free(int, char **);
67 extern int command_Expand_Interpret(char *, int, char *vector[MAXARGS], int);
68 extern int command_Interpret(char *, int, char *vector[MAXARGS]);
69 extern void command_Run(struct bundle *, int, char const *const *,
70                         struct prompt *, const char *, struct datalink *);
71 extern int command_Decode(struct bundle *, char *, int, struct prompt *,
72                            const char *);
73 extern struct link *command_ChooseLink(struct cmdargs const *);
74 extern const char *command_ShowNegval(unsigned);
75 
76