mirror of
https://github.com/openvswitch/ovs
synced 2025-10-13 14:07:02 +00:00
1636c76112
I started working on a new command line utility that used this shared code. I wanted the ability to pass some data from common initialization code to all of the commands. You can find a similar pattern in ovs-vsctl. This patch updates the command handler to take a new struct, ovs_cmdl_context, instead of argc and argv directly. It includes argc and argv, but also includes an opaque type (void *), where the user of this API can attach its custom data it wants passed along to command handlers. This patch affected the ovstest sub-programs, as well. The patch includes a bit of an odd hack to OVSTEST_REGISTER() to avoid making the main() function of the sub-programs take a ovs_cmdl_context. The test main() functions still receive argc and argv directly, as that seems more natural. The test-subprograms themselves are able to make use of a context internally, though. Signed-off-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
61 lines
1.7 KiB
C
61 lines
1.7 KiB
C
/*
|
|
* Copyright (c) 2008, 2009, 2010 Nicira, Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef COMMAND_LINE_H
|
|
#define COMMAND_LINE_H 1
|
|
|
|
/* Utilities for command-line parsing. */
|
|
|
|
#include "compiler.h"
|
|
|
|
struct option;
|
|
|
|
/* Command handler context */
|
|
struct ovs_cmdl_context {
|
|
/* number of command line arguments */
|
|
int argc;
|
|
/* array of command line arguments */
|
|
char **argv;
|
|
/* private context data defined by the API user */
|
|
void *pvt;
|
|
};
|
|
|
|
typedef void (*ovs_cmdl_handler)(struct ovs_cmdl_context *);
|
|
|
|
struct ovs_cmdl_command {
|
|
const char *name;
|
|
const char *usage;
|
|
int min_args;
|
|
int max_args;
|
|
ovs_cmdl_handler handler;
|
|
};
|
|
|
|
char *ovs_cmdl_long_options_to_short_options(const struct option *options);
|
|
void ovs_cmdl_print_options(const struct option *options);
|
|
void ovs_cmdl_print_commands(const struct ovs_cmdl_command *commands);
|
|
void ovs_cmdl_run_command(struct ovs_cmdl_context *, const struct ovs_cmdl_command[]);
|
|
|
|
void ovs_cmdl_proctitle_init(int argc, char **argv);
|
|
#if defined(__FreeBSD__) || defined(__NetBSD__)
|
|
#define ovs_cmdl_proctitle_set setproctitle
|
|
#else
|
|
void ovs_cmdl_proctitle_set(const char *, ...)
|
|
OVS_PRINTF_FORMAT(1, 2);
|
|
#endif
|
|
void ovs_cmdl_proctitle_restore(void);
|
|
|
|
#endif /* command-line.h */
|