add experimental 'asciidoc' generator

[pve-common.git] / src / PVE / CLIHandler.pm

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 61434cc87206ce21f7569b2f40a890ccb3904636..21fb916da9d50e02a20b0ab44113c9a7a211208e 100644 (file)
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -110,6 +110,46 @@ __PACKAGE__->register_method ({
 
     }});
 
+sub print_simple_asciidoc_synopsys {
+    my ($class, $name, $arg_param, $uri_param) = @_;
+
+    die "not initialized" if !$cli_handler_class;
+
+    my $pwcallback = $cli_handler_class->can('read_password');
+
+    my $synopsis = "*${name}* `help`\n\n";
+
+    $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param, 'asciidoc', $pwcallback);
+
+    return $synopsis;
+}
+
+sub print_asciidoc_synopsys {
+
+    die "not initialized" if !($cmddef && $exename && $cli_handler_class);
+
+    my $pwcallback = $cli_handler_class->can('read_password');
+
+    my $synopsis = "";
+
+    $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
+
+    my $oldclass;
+    foreach my $cmd (sort keys %$cmddef) {
+       my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
+       my $str = $class->usage_str($name, "$exename $cmd", $arg_param,
+                                   $uri_param, 'asciidoc', $pwcallback);
+       $synopsis .= "\n" if $oldclass && $oldclass ne $class;
+
+       $synopsis .= "$str\n\n";
+       $oldclass = $class;
+    }
+
+    $synopsis .= "\n";
+
+    return $synopsis;
+}
+
 sub print_simple_pod_manpage {
     my ($podfn, $class, $name, $arg_param, $uri_param) = @_;
 
@@ -337,7 +377,7 @@ sub generate_bash_completions {
 # this modifies global var, but I found no better way
 COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
 
-complete -C '$exename bashcomplete' $exename
+complete -o default -C '$exename bashcomplete' $exename
 __EOD__
 }
 
@@ -389,6 +429,27 @@ sub generate_pod_manpage {
     }
 }
 
+sub generate_asciidoc_synopsys {
+    my ($class) = @_;
+
+    $cli_handler_class = $class;
+
+    $exename = &$get_exe_name($class);
+
+    no strict 'refs';
+    my $def = ${"${class}::cmddef"};
+
+    if (ref($def) eq 'ARRAY') {
+       print_simple_asciidoc_synopsys(@$def);
+    } else {
+       $cmddef = $def;
+
+       $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+
+       print_asciidoc_synopsys();
+    }
+}
+
 my $handle_cmd  = sub {
     my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_;
 
@@ -469,7 +530,7 @@ sub run_cli {
     
     die "password callback is no longer supported" if $pwcallback;
 
-    run_cli_handler($class, podfn => $podfn, preparefunc => $preparefunc);
+    run_cli_handler($class, podfn => $podfn, prepare => $preparefunc);
 }
 
 sub run_cli_handler {
@@ -481,12 +542,14 @@ sub run_cli_handler {
 
     foreach my $key (keys %params) {
        next if $key eq 'podfn';
-       next if $key eq 'preparefunc';
+       next if $key eq 'prepare';
+       next if $key eq 'no_init'; # used by lxc hooks
        die "unknown parameter '$key'";
     }
 
     my $podfn = $params{podfn};
-    my $preparefunc = $params{preparefunc};
+    my $preparefunc = $params{prepare};
+    my $no_init = $params{no_init};
 
     my $pwcallback = $class->can('read_password');
 
@@ -497,10 +560,10 @@ sub run_cli_handler {
     if ($class !~ m/^PVE::Service::/) {
        die "please run as root\n" if $> != 0;
 
-       PVE::INotify::inotify_init();
+       PVE::INotify::inotify_init() if !$no_init;
 
        my $rpcenv = PVE::RPCEnvironment->init('cli');
-       $rpcenv->init_request();
+       $rpcenv->init_request() if !$no_init;
        $rpcenv->set_language($ENV{LANG});
        $rpcenv->set_user('root@pam');
     }