#include <apr.h>
#include <apr_pools.h>
#include <apr_getopt.h>
#include "svn_types.h"
#include "svn_error.h"
Go to the source code of this file.
Data Structures | |
struct | svn_opt_revision_t |
A revision, specified in one of svn_opt_revision_kind ways. More... | |
struct | svn_opt_subcommand_desc_t |
One element of a subcommand dispatch table. More... | |
Defines | |
#define | SVN_OPT_MAX_ALIASES 3 |
The maximum number of aliases a subcommand can have. | |
#define | SVN_OPT_MAX_OPTIONS 50 |
The maximum number of options that can be accepted by a subcommand. | |
#define | SVN_OPT_FIRST_LONGOPT_ID 256 |
Options that have no short option char should use an identifying integer equal to or greater than this. | |
Typedefs | |
typedef svn_error_t *( | svn_opt_subcommand_t )(apr_getopt_t *os, void *baton, apr_pool_t *pool) |
All subcommand procedures in Subversion conform to this prototype. | |
typedef svn_opt_subcommand_desc_t | svn_opt_subcommand_desc_t |
One element of a subcommand dispatch table. | |
typedef svn_opt_revision_t | svn_opt_revision_t |
A revision, specified in one of svn_opt_revision_kind ways. | |
Enumerations | |
enum | svn_opt_revision_kind { svn_opt_revision_unspecified, svn_opt_revision_number, svn_opt_revision_date, svn_opt_revision_committed, svn_opt_revision_previous, svn_opt_revision_base, svn_opt_revision_working, svn_opt_revision_head } |
Various ways of specifying revisions. More... | |
Functions | |
const svn_opt_subcommand_desc_t * | svn_opt_get_canonical_subcommand (const svn_opt_subcommand_desc_t *table, const char *cmd_name) |
Return the entry in table whose name matches cmd_name, or NULL if none. | |
const apr_getopt_option_t * | svn_opt_get_option_from_code (int code, const apr_getopt_option_t *option_table) |
Return the first entry from option_table whose option code is code, or NULL if no match. | |
svn_boolean_t | svn_opt_subcommand_takes_option (const svn_opt_subcommand_desc_t *command, int option_code) |
Return TRUE iff subcommand command supports option option_code, else return FALSE . | |
void | svn_opt_print_generic_help (const char *header, const svn_opt_subcommand_desc_t *cmd_table, const apr_getopt_option_t *opt_table, const char *footer, apr_pool_t *pool, FILE *stream) |
Print a generic (not command-specific) usage message to stream. | |
void | svn_opt_format_option (const char **string, const apr_getopt_option_t *opt, svn_boolean_t doc, apr_pool_t *pool) |
Print an option opt nicely into a string allocated in pool. | |
void | svn_opt_subcommand_help (const char *subcommand, const svn_opt_subcommand_desc_t *table, const apr_getopt_option_t *options_table, apr_pool_t *pool) |
Get subcommand's usage from table, and print it to stdout . | |
int | svn_opt_parse_revision (svn_opt_revision_t *start_revision, svn_opt_revision_t *end_revision, const char *arg, apr_pool_t *pool) |
Set *start_revision and/or *end_revision according to arg, where arg is "N" or "N:M", like so:. | |
svn_error_t * | svn_opt_args_to_target_array (apr_array_header_t **targets_p, apr_getopt_t *os, apr_array_header_t *known_targets, svn_opt_revision_t *start_revision, svn_opt_revision_t *end_revision, svn_boolean_t extract_revisions, apr_pool_t *pool) |
Pull remaining target arguments from os into *targets_p, including targets stored in known_targets (which might come from, for example, the "--targets" command line option), converting them to UTF-8. | |
void | svn_opt_push_implicit_dot_target (apr_array_header_t *targets, apr_pool_t *pool) |
If no targets exist in *targets, add `.' as the lone target. | |
svn_error_t * | svn_opt_parse_num_args (apr_array_header_t **args_p, apr_getopt_t *os, int num_args, apr_pool_t *pool) |
Parse num_args non-target arguments from the list of arguments in os->argv, return them as const char * in *args_p, without doing any UTF-8 conversion. | |
svn_error_t * | svn_opt_parse_all_args (apr_array_header_t **args_p, apr_getopt_t *os, apr_pool_t *pool) |
Parse all remaining arguments from os->argv, return them as const char * in *args_p, without doing any UTF-8 conversion. | |
svn_error_t * | svn_opt_print_help (apr_getopt_t *os, const char *pgm_name, svn_boolean_t print_version, svn_boolean_t quiet, const char *version_footer, const char *header, const svn_opt_subcommand_desc_t *cmd_table, const apr_getopt_option_t *option_table, const char *footer, apr_pool_t *pool) |
Print either generic help, or command-specific help for pgm_name. |
Definition in file svn_opt.h.
|
All subcommand procedures in Subversion conform to this prototype. os is the apr option state after getopt processing has been run; in other words, it still contains the non-option arguments following the subcommand. See os->argv and os->ind. baton is anything you need it to be. pool is used for allocating errors, and for any other allocation unless the instance is explicitly documented to allocate from a pool in baton. |
|
|
Pull remaining target arguments from os into *targets_p, including targets stored in known_targets (which might come from, for example, the "--targets" command line option), converting them to UTF-8. Allocate *targets_p and its elements in pool. If extract_revisions is set, then this function will attempt to look for trailing "@rev" syntax on the paths. If an @rev is found for the first target in *TARGETS_P, it will overwrite the value of *start_revision. If an @rev is found for the second target in *TARGETS_P, it will overwrite *end_revision. (Extra revisions beyond that are ignored.) |
|
Print an option opt nicely into a string allocated in pool. If doc is set, include the generic documentation string of option. |
|
Return the entry in table whose name matches cmd_name, or cmd_name may be an alias. |
|
Return the first entry from option_table whose option code is code, or option_table must end with an element whose every field is zero. |
|
Parse all remaining arguments from os->argv, return them as Allocate *args_p and its values in pool. |
|
Parse num_args non-target arguments from the list of arguments in os->argv, return them as Allocate *args_p and its values in pool. |
|
Set *start_revision and/or *end_revision according to arg, where arg is "N" or "N:M", like so:.
revision_from_word() .
If arg is invalid, return -1; else return 0. It is invalid to omit a revision (as in, ":", "N:" or ":M"). Note:
It is typical, though not required, for *start_revision and *end_revision to be |
|
Print a generic (not command-specific) usage message to stream. (### todo: why is stream a stdio file instead of an svn stream?) If header is non-null, print header followed by a newline. Then loop over cmd_table printing the usage for each command (getting option usages from opt_table). Then if footer is non-null, print footer followed by a newline. Use pool for temporary allocation. |
|
Print either generic help, or command-specific help for pgm_name. If there are arguments in os, then try printing help for them as though they are subcommands, using cmd_table and option_table for option information.
If os is
Notes: The reason this function handles both version printing and general usage help is that a confused user might put both the --version flag *and* subcommand arguments on a help command line. The logic for handling such a situation should be in one place. |
|
If no targets exist in *targets, add `.' as the lone target. (Some commands take an implicit "." string argument when invoked with no arguments. Those commands make use of this function to add "." to the target array if the user passes no args.) |
|
Get subcommand's usage from table, and print it to
Obtain option usage from options_table. Use pool for temporary allocation. subcommand may be a canonical command name or an alias. (### todo: why does this only print to |