clt 0.0.6

Rust crate for efficiently creating command line applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

// This module implements a number of types..
// Copyright (c) 2015 by Shipeng Feng.
// Licensed under the BSD License, see LICENSE for more details.

use getopts;


/// Command params type.
pub type Params = Vec<String>;


/// Command callback func type.
pub type CommandCallback = fn(Params);


/// Options are usually optional values on the command line.
#[derive(Clone)]
pub struct Options {
    short_name: &'static str,
    long_name: &'static str,
    help: &'static str,
    is_flag: bool,
    is_bool_flag: bool,
    multiple: bool,
    required: bool,
    default: Option<&'static str>,
}

impl Options {
    pub fn new(s_name: &'static str, l_name: &'static str, help: &'static str, is_flag: bool, is_bool_flag: bool,
               multiple: bool, required: bool, default: Option<&'static str>) -> Options {
        Options {
            short_name: s_name,
            long_name: l_name,
            help: help,
            is_flag: is_flag,
            is_bool_flag: is_bool_flag,
            multiple: multiple,
            required: required,
            default: default,
        }
    }

    pub fn add_to_parser(&self, parser: &mut getopts::Options) {
        if self.is_flag {
            if !self.is_bool_flag {
                parser.optflagopt(self.short_name, self.long_name, self.help, self.long_name);
            } else if self.multiple {
                parser.optflagmulti(self.short_name, self.long_name, self.help);
            } else {
                parser.optflag(self.short_name, self.long_name, self.help);
            }
        } else {
            if self.required {
                parser.reqopt(self.short_name, self.long_name, self.help, self.long_name);
            } else if self.multiple {
                parser.optmulti(self.short_name, self.long_name, self.help, self.long_name);
            } else {
                parser.optopt(self.short_name, self.long_name, self.help, self.long_name);
            }
        }
    }

    pub fn get_help_record(&self) -> (String, String) {
        let mut options = String::new();
        options.push_str("-");
        options.push_str(self.short_name);
        options.push_str(", ");
        options.push_str("--");
        options.push_str(self.long_name);

        let mut extra = String::new();
        if self.default.is_some() {
            extra.push_str("default: ");
            extra.push_str(self.default.unwrap());
        }
        if self.required {
            if extra.is_empty() {
                extra.push_str("required");
            } else {
                extra.push_str("; required");
            }
        }
        let mut help: String = self.help.to_string();
        if self.help.len() != 0 {
            help.push_str("  ");
        }
        if !extra.is_empty() {
            help = format!("{}[{}]", help, extra);
        }

        return (options, help);
    }
}


/// Arguments are positional parameters to a command.
pub struct Argument {
    name: &'static str,
    required: bool,
    default: Option<&'static str>,
}

impl Argument {
    pub fn new(name: &'static str, required: bool, default: Option<&'static str>) -> Argument {
        Argument {
            name: name,
            required: required,
            default: default,
        }
    }

    pub fn add_to_parser(&self, parser: &mut getopts::Options) {
    }

    pub fn get_usage_piece(&self) -> String {
        match self.required {
            true => format!("{}", self.name),
            false => format!("[{}]", self.name),
        }
    }
}