src/rustbook/subcommand.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Common API for all rustbook subcommands.
  12
  13 use error::CliResult;
  14 use error::CommandResult;
  15 use term::Term;
  16
  17 use help;
  18 use build;
  19 use serve;
  20 use test;
  21
  22 pub trait Subcommand {
  23     /// Mutate the subcommand by parsing its arguments.
  24     ///
  25     /// Returns `Err` on a parsing error.
  26     fn parse_args(&mut self, args: &[String]) -> CliResult<()>;
  27     /// Print the CLI usage information.
  28     fn usage(&self);
  29     /// Actually execute the subcommand.
  30     fn execute(&mut self, term: &mut Term) -> CommandResult<()>;
  31 }
  32
  33 /// Create a Subcommand object based on its name.
  34 pub fn parse_name(name: &str) -> Option<Box<Subcommand>> {
  35     let cmds: [fn(&str) -> Option<Box<Subcommand>>; 4] = [help::parse_cmd,
  36                                                           build::parse_cmd,
  37                                                           serve::parse_cmd,
  38                                                           test::parse_cmd];
  39     for parser in &cmds {
  40         let parsed = (*parser)(name);
  41         if parsed.is_some() { return parsed }
  42     }
  43     None
  44 }