012107980d2d7900959b277565c49b2431cf015f
[rust-101.git] / src / part13.rs
1 // Rust-101, Part 13: Slices, Arrays, External Dependencies
2 // =================
3
4 //@ To complete rgrep, there are two pieces we still need to implement: Sorting, and taking the job options
5 //@ as argument to the program, rather than hard-coding them. Let's start with sorting.
6
7 // ## Slices
8 //@ Again, we first have to think about the type we want to give to our sorting function. We may be inclined to
9 //@ pass it a `Vec<T>`. Now, sorting does not actually consume the argument, so we could make that a `&mut Vec<T>`.
10 //@ But there's a problem with that: If we want to implement some divide-and-conquer sorting algorithm (say,
11 //@ Quicksort), then we will have to *split* our argument at some point, and operate recursively on the two parts.
12 //@ But we can't split a `Vec`! We could now extend the function signature to also take some indices, marking the
13 //@ part of the vector we are supposed to sort, but that's all rather clumsy. Rust offers a nicer solution.
14 //@ 
15 //@ `[T]` is the type of an (unsized) *array*, with elements of type `T`. All this means is that there's a contiguous
16 //@ region of memory, where a bunch of `T` are stored. How many` We can't tell! This is an unsized type. Just like for
17 //@ trait objects, this means we can only operate on pointers to that type, and these pointers will containing the missing
18 //@ information - namely, the length. Such a pointer is called a *slice*. As we will see, a slice can be split!
19 //@ Our function can thus take a borrowed slice, and promise to sort all elements in there.
20 pub fn sort<T: PartialOrd>(data: &mut [T]) {
21     if data.len() < 2 { return; }
22
23     // We decide that the element at 0 is our pivot, and then we move our cursors through the rest of the slice,
24     // making sure that everything on the left is no larger than the pivot, and everything on the right is no smaller.
25     let mut lpos = 1;
26     let mut rpos = data.len();
27     /* Invariant: pivot is data[0]; everything with index (0,lpos) is <= pivot; [rpos,len) is >= pivot; lpos < rpos */
28     loop {
29         // **Exercise 13.1**: Complete this Quicksort loop. You can use `swap` on slices to swap two elements.
30         unimplemented!()
31     }
32
33     // Once our cursors met, we need to put the pivot in the right place.
34     data.swap(0, lpos-1);
35
36     // Finally, we split our slice to sort the two halves. The nice part about slices is that splitting them is cheap:
37     //@ They are just a pointer to a start address, and a length. We can thus get two pointers, one at the beginning and
38     //@ one in the middle, and set the lengths appropriately such that they don't overlap. This is what `split_at_mut` does.
39     //@ Since the two slices don't overlap, there is no aliasing and we can have them both mutably borrowed.
40     let (part1, part2) = data.split_at_mut(lpos);
41     //@ The index operation can not only be used to address certain elements, it can also be used for "slicing": Giving a range
42     //@ of indices, and obtaining an appropriate part of the slice we started with. Here, we remove the last element from
43     //@ `part1`, which is the pivot. This makes sure both recursive calls work on strictly smaller slices.
44     sort(&mut part1[..lpos-1]);                                     /*@*/
45     sort(part2);                                                    /*@*/
46 }
47
48 // **Exercise 13.2*: Since `String` implements `PartialEq`, you can now change the function `output_lines` in the previous part
49 // 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
50 // only, not by filename or line number!
51
52 // Now, we can sort, e.g., an vector of numbers.
53 fn sort_nums(data: &mut Vec<i32>) {
54     //@ Vectors support slicing, just like slices do. Here, `..` denotes the full range, which means we want to slice the entire vector.
55     //@ It is then passed to the `sort` function, which doesn't even know that it is working on data inside a vector.
56     sort(&mut data[..]);
57 }
58
59 // ## Arrays
60 //@ An *array* in Rust is given be the type `[T; n]`, where `n` is some *fixed* number. So, `[f64; 10]` is an array of 10 floating-point
61 //@ numbers, all one right next to the other in memory. Arrays are sized, and hence can be used like any other type. But we can also
62 //@ borrow them as slices, e.g., to sort them.
63 fn sort_array() {
64     let mut data: [f64; 5] = [1.0, 3.4, 12.7, -9.12, 0.1];
65     sort(&mut data);
66 }
67
68 // ## External Dependencies
69 //@ This leaves us with just one more piece to complete rgrep: Taking arguments from the command-line. We could now directly work on
70 //@ [`std::env::args`](http://doc.rust-lang.org/beta/std/env/fn.args.html) to gain access to those arguments, and this would become
71 //@ a pretty boring lesson in string manipulation. Instead, I want to use this opportunity to show how easy it is to benefit from
72 //@ other people's work in your program.
73 //@ 
74 //@ For sure, we are not the first to equip a Rust program with support for command-line arguments. Someone must have written a library
75 //@ for the job, right? Indeed, someone has. Rust has a central repository of published libraries, called [crates.io](https://crates.io/).
76 //@ It's a bit like [PyPI](https://pypi.python.org/pypi) or the [Ruby Gems](https://rubygems.org/): Everybody can upload their code,
77 //@ and there's tooling for importing that code into your project. This tooling is provided by `cargo`, the tool we are already using to
78 //@ build this tutorial. (`cargo` also has support for *publishing* your crate on crates.io, I refer you to [the documentation](http://doc.crates.io/crates-io.html) for more details.)
79 //@ In this case, we are going to use the [`docopt` crate](https://crates.io/crates/docopt), which creates a parser for command-line
80 //@ arguments based on the usage string. External dependencies are declared in the `Cargo.toml` file.
81
82 //@ I already prepared that file, but the declaration of the dependency is still commented out. So please open `Cargo.toml` of your workspace
83 //@ now, and enabled the two commented-out lines. Then do `cargo build`. Cargo will now download the crate from crates.io, compile it,
84 //@ and link it to your program. In the future, you can do `cargo update` to make it download new versions of crates you depend on.
85 //@ Note that crates.io is only the default location for dependencies, you can also give it the URL of a git repository or some local
86 //@ path. All of this is explained in the [Cargo Guide](http://doc.crates.io/guide.html).
87
88 // I disabled the following module (using a rather bad hack), because it only compiles if `docopt` is linked. However, before enabling it,
89 // you still have get the external library into the global namespace. This is done with `extern crate docopt;`, and that statement *has* to be
90 // in `main.rs`. So please go there, and enable this commented-out line. Then remove the attribute of the following module.
91 #[cfg(feature = "disabled")]
92 pub mod rgrep {
93     // Now that `docopt` is linked and declared in `main.rs`, we can import it with `use`. We also import some other pieces that we will need.
94     use docopt::Docopt;
95     use part12::{run, Options, OutputMode};
96     use std::process;
97
98     // The USAGE string documents how the program is to be called. It's written in a format that `docopt` can parse.
99     static USAGE: &'static str = "
100 Usage: rgrep [-c] [-s] <pattern> <file>...
101
102 Options:
103     -c, --count  Count number of matching lines (rather than printing them).
104     -s, --sort   Sort the lines before printing.
105 ";
106
107     // This function extracts the rgrep options from the command-line arguments.
108     fn get_options() -> Options {
109         // 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/).
110         let args = Docopt::new(USAGE).and_then(|d| d.parse()).unwrap_or_else(|e| e.exit());
111         // Now we can get all the values out.
112         let count = args.get_bool("-c");
113         let sort = args.get_bool("-s");
114         let pattern = args.get_str("<pattern>");
115         let files = args.get_vec("<file>");
116         if count && sort {
117             println!("Setting both '-c' and '-s' at the same time does not make any sense.");
118             process::exit(1);
119         }
120
121         // We need to make the strings owned to construct the `Options` instance.
122         //@ If you check all the type carefully, you will notice that `pattern` above if of type `&str`. `str` is the type of a UTF-8 encoded string, that is, a bunch of
123         //@ bytes in memory (`[u8]`) that are valid according of UTF-8. `str` is unsized. `&str` is a sliced string, and stores the address of the character data, and
124         //@ their length. String literals like "this one" are of type `&'static str`: They point right to the constant section of the binary, you you cannot claim you
125         //@ own them. However, the borrow is valid for as long as the program runs, hence it has lifetime `'static`. Calling `to_string` will copy the string data
126         //@ into an owned buffer on the heap, and thus convert it to `String`.
127         Options {
128             files: files.iter().map(|file| file.to_string()).collect(),
129             pattern: pattern.to_string(),
130             output_mode: if count { OutputMode::Count } else if sort { OutputMode::SortAndPrint } else { OutputMode::Print },
131         }
132     }
133
134     // 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.
135     // 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!
136     pub fn main() {
137         run(get_options());
138     }
139 }
140
141 // **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
142 // 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
143 // 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.
144
145 //@ [index](main.html) | [previous](part12.html) | [next](main.html)