turns out that one *can* use 'extern crate' in submodules
[rust-101.git] / workspace / src / part13.rs
1 // Rust-101, Part 13: Slices, Arrays, External Dependencies
2 // ========================================================
3
4
5 // ## Slices
6
7 pub fn sort<T: PartialOrd>(data: &mut [T]) {
8     if data.len() < 2 { return; }
9
10     // We decide that the element at 0 is our pivot, and then we move our cursors through the rest of the slice,
11     // making sure that everything on the left is no larger than the pivot, and everything on the right is no smaller.
12     let mut lpos = 1;
13     let mut rpos = data.len();
14     /* Invariant: pivot is data[0]; everything with index (0,lpos) is <= pivot;
15        [rpos,len) is >= pivot; lpos < rpos */
16     loop {
17         // **Exercise 13.1**: Complete this Quicksort loop. You can use `swap` on slices to swap two elements. Write a
18         // test function for `sort`.
19         unimplemented!()
20     }
21
22     // Once our cursors met, we need to put the pivot in the right place.
23     data.swap(0, lpos-1);
24
25     // Finally, we split our slice to sort the two halves. The nice part about slices is that splitting them is cheap:
26     let (part1, part2) = data.split_at_mut(lpos);
27     unimplemented!()
28 }
29
30 // **Exercise 13.2**: Since `String` implements `PartialEq`, you can now change the function `output_lines` in the previous part
31 // to call the sort function above. If you did exercise 12.1, you will have slightly more work. Make sure you sort by the matched line
32 // only, not by filename or line number!
33
34 // Now, we can sort, e.g., an vector of numbers.
35 fn sort_nums(data: &mut Vec<i32>) {
36     sort(&mut data[..]);
37 }
38
39 // ## Arrays
40 fn sort_array() {
41     let mut array_of_data: [f64; 5] = [1.0, 3.4, 12.7, -9.12, 0.1];
42     sort(&mut array_of_data);
43 }
44
45 // ## External Dependencies
46
47
48 // I disabled the following module (using a rather bad hack), because it only compiles if `docopt` is linked.
49 // Remove the attribute of the `rgrep` module to enable compilation.
50 #[cfg(feature = "disabled")]
51 pub mod rgrep {
52     // Now that `docopt` is linked, we can first root it in the namespace and then import it with `use`. We also import some other pieces that we will need.
53     extern crate docopt;
54     use self::docopt::Docopt;
55     use part12::{run, Options, OutputMode};
56     use std::process;
57
58     // The `USAGE` string documents how the program is to be called. It's written in a format that `docopt` can parse.
59     static USAGE: &'static str = "
60 Usage: rgrep [-c] [-s] <pattern> <file>...
61
62 Options:
63     -c, --count  Count number of matching lines (rather than printing them).
64     -s, --sort   Sort the lines before printing.
65 ";
66
67     // This function extracts the rgrep options from the command-line arguments.
68     fn get_options() -> Options {
69         // Parse `argv` and exit the program with an error message if it fails. This is taken from the [`docopt` documentation](http://burntsushi.net/rustdoc/docopt/).
70         let args = Docopt::new(USAGE).and_then(|d| d.parse()).unwrap_or_else(|e| e.exit());
71         // Now we can get all the values out.
72         let count = args.get_bool("-c");
73         let sort = args.get_bool("-s");
74         let pattern = args.get_str("<pattern>");
75         let files = args.get_vec("<file>");
76         if count && sort {
77             println!("Setting both '-c' and '-s' at the same time does not make any sense.");
78             process::exit(1);
79         }
80
81         // We need to make the strings owned to construct the `Options` instance.
82         let mode = if count {
83             OutputMode::Count
84         } else if sort {
85             OutputMode::SortAndPrint
86         } else {
87             OutputMode::Print
88         };
89         Options {
90             files: files.iter().map(|file| file.to_string()).collect(),
91             pattern: pattern.to_string(),
92             output_mode: mode,
93         }
94     }
95
96     // Finally, we can call the `run` function from the previous part on the options extracted using `get_options`. Edit `main.rs` to call this function.
97     // You can now use `cargo run -- <pattern> <files>` to call your program, and see the argument parser and the threads we wrote previously in action!
98     pub fn main() {
99         unimplemented!()
100     }
101 }
102
103 // **Exercise 13.3**: Wouldn't it be nice if rgrep supported regular expressions? There's already a crate that does all the parsing and matching on regular
104 // expression, it's called [regex](https://crates.io/crates/regex). Add this crate to the dependencies of your workspace, add an option ("-r") to switch
105 // the pattern to regular-expression mode, and change `filter_lines` to honor this option. The documentation of regex is available from its crates.io site.
106 // (You won't be able to use the `regex!` macro if you are on the stable or beta channel of Rust. But it wouldn't help for our use-case anyway.)
107