clt 0.0.6

// Core types.
// Copyright (c) 2015 by Shipeng Feng.
// Licensed under the BSD License, see LICENSE for more details.


use std::env;
use std::path::Path;

use getopts;

use types::{Params, CommandCallback};
use types::{Options, Argument};
use formatting::HelpFormatter;

/// The command is the basic type of command line applications in clt.  This
/// handles command line parsing.
pub struct Command {
    name: String,  // The name of the command to use
    callback: CommandCallback,  // The callback to execute
    options: Vec<Options>,  // The options to register with this command
    arguments: Vec<Argument>,  // The arguments to register with this command
    help: String,  // The help message to use for this command
    epilog: String,  // Printed at the end of the help page
    short_help: String,  // The short help to use for this command, this is shown on the command listing of the parent command
}


impl Command {
    pub fn new(name: &str, callback: CommandCallback) -> Command {
        Command {
            name: name.to_string(),
            callback: callback,
            options: Vec::new(),
            arguments: Vec::new(),
            help: String::new(),
            epilog: String::new(),
            short_help: String::new(),
        }
    }

    /// Attaches an option to the command.
    pub fn option(&mut self, 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>) {
        let option = Options::new(short_name, long_name, help, is_flag,
                                  is_bool_flag, multiple, required, default);
        self.options.push(option);
    }

    /// Attaches an argument to the command.
    pub fn argument(&mut self, name: &'static str, required: bool, default: Option<&'static str>) {
        let argument = Argument::new(name, required, default);
        self.arguments.push(argument);
    }

    fn make_formatter(&self) -> HelpFormatter {
        HelpFormatter::new(80, 2)
    }

    fn format_usage(&self, formatter: &mut HelpFormatter) {
        let mut pieces: Vec<String> = Vec::new();
        pieces.push("[OPTIONS]".to_string());
        for argument in self.arguments.iter() {
            pieces.push(argument.get_usage_piece());
        }
        formatter.write_usage(&self.name, pieces.concat(), "Usage: ")
    }

    pub fn get_usage(&self) -> String {
        let mut formatter = self.make_formatter();
        self.format_usage(&mut formatter);
        formatter.getvalue()
    }

    fn format_help_text(&self, formatter: &mut HelpFormatter) {
        if !self.help.is_empty() {
            formatter.write_paragraph();
            formatter.indent();
            formatter.write_text(self.help.clone());
            formatter.dedent();
        }
    }

    fn format_options(&self, formatter: &mut HelpFormatter) {
        let mut opts: Vec<(String, String)> = Vec::new();
        for option in self.get_options().iter() {
            opts.push(option.get_help_record());
        }
        if !opts.is_empty() {
            formatter.enter_section("Options");
            formatter.write_dl(opts);
            formatter.exit_section();
        }
    }

    fn format_epilog(&self, formatter: &mut HelpFormatter) {
        if !self.epilog.is_empty() {
            formatter.write_paragraph();
            formatter.indent();
            formatter.write_text(self.epilog.clone());
            formatter.dedent();
        }
    }

    fn format_help(&self, formatter: &mut HelpFormatter) {
        self.format_usage(formatter);
        self.format_help_text(formatter);
        self.format_options(formatter);
        self.format_epilog(formatter);
    }

    pub fn get_help(&self) -> String {
        let mut formatter = self.make_formatter();
        self.format_help(&mut formatter);
        formatter.getvalue()
    }

    /// Returns the help option.
    fn get_help_option(&self) -> Options {
        let help_option_names = vec!["h", "help"];
        let show_help = |params: Params| {
            print!("{}", self.get_help());
        };
        return Options::new(help_option_names[0], help_option_names[1],
                            "Show this message and exit.", true, true, false, false, None);
    }

    /// This invokes the command with given arguments.
    pub fn invoke(&self, pragram_name: String, args: Vec<String>) {
        let args = self.parse_args(args);
        let callback = self.callback;
        callback(args);
    }

    /// Get all options plus help option.
    fn get_options(&self) -> Vec<Options> {
        let mut options: Vec<Options> = Vec::new();
        for option in self.options.iter() {
            options.push(option.clone());
        }
        let help_option = self.get_help_option();
        options.push(help_option);
        return options;
    }

    /// Creates the underlying option parser for this command.
    fn make_parser(&self) -> getopts::Options {
        let mut parser = getopts::Options::new();
        for option in self.get_options().iter() {
            option.add_to_parser(&mut parser);
        }
        return parser;
    }

    /// Create the parser and parses the arguments.
    fn parse_args(&self, args: Vec<String>) -> Vec<String> {
        args
    }

    /// This is the way to run one command application.
    pub fn run(&self) {
        let mut args = env::args();
        let program = args.nth(0).unwrap();
        let program_path = Path::new(&program);
        let program_name = program_path.file_name().unwrap().to_str().unwrap();
        // Hook for the Bash completion.
        // bashcomplete(self, program_name);
        self.invoke(program_name.to_string(), args.collect());
    }
}