]> git.proxmox.com Git - mirror_ovs.git/blob - lib/command-line.h
command-line: add ovs_cmdl_context
[mirror_ovs.git] / lib / command-line.h
1 /*
2 * Copyright (c) 2008, 2009, 2010 Nicira, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #ifndef COMMAND_LINE_H
18 #define COMMAND_LINE_H 1
19
20 /* Utilities for command-line parsing. */
21
22 #include "compiler.h"
23
24 struct option;
25
26 /* Command handler context */
27 struct ovs_cmdl_context {
28 /* number of command line arguments */
29 int argc;
30 /* array of command line arguments */
31 char **argv;
32 /* private context data defined by the API user */
33 void *pvt;
34 };
35
36 typedef void (*ovs_cmdl_handler)(struct ovs_cmdl_context *);
37
38 struct ovs_cmdl_command {
39 const char *name;
40 const char *usage;
41 int min_args;
42 int max_args;
43 ovs_cmdl_handler handler;
44 };
45
46 char *ovs_cmdl_long_options_to_short_options(const struct option *options);
47 void ovs_cmdl_print_options(const struct option *options);
48 void ovs_cmdl_print_commands(const struct ovs_cmdl_command *commands);
49 void ovs_cmdl_run_command(struct ovs_cmdl_context *, const struct ovs_cmdl_command[]);
50
51 void ovs_cmdl_proctitle_init(int argc, char **argv);
52 #if defined(__FreeBSD__) || defined(__NetBSD__)
53 #define ovs_cmdl_proctitle_set setproctitle
54 #else
55 void ovs_cmdl_proctitle_set(const char *, ...)
56 OVS_PRINTF_FORMAT(1, 2);
57 #endif
58 void ovs_cmdl_proctitle_restore(void);
59
60 #endif /* command-line.h */