src/test/run-pass/issue-3563-3.rs

   1 // Copyright 2012 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 // ASCII art shape renderer.
  12 // Demonstrates traits, impls, operator overloading, non-copyable struct, unit testing.
  13 // To run execute: rustc --test shapes.rs && ./shapes
  14
  15 // Rust's std library is tightly bound to the language itself so it is automatically linked in.
  16 // However the extra library is designed to be optional (for code that must run on constrained
  17 //  environments like embedded devices or special environments like kernel code) so it must
  18 // be explicitly linked in.
  19
  20 // Extern mod controls linkage. Use controls the visibility of names to modules that are
  21 // already linked in. Using WriterUtil allows us to use the write_line method.
  22
  23 use std::slice;
  24 use std::fmt;
  25
  26 // Represents a position on a canvas.
  27 struct Point {
  28     x: int,
  29     y: int,
  30 }
  31
  32 // Represents an offset on a canvas. (This has the same structure as a Point.
  33 // but different semantics).
  34 struct Size {
  35     width: int,
  36     height: int,
  37 }
  38
  39 struct Rect {
  40     top_left: Point,
  41     size: Size,
  42 }
  43
  44 // Contains the information needed to do shape rendering via ASCII art.
  45 struct AsciiArt {
  46     width: uint,
  47     height: uint,
  48     fill: char,
  49     lines: Vec<Vec<char> > ,
  50
  51     // This struct can be quite large so we'll disable copying: developers need
  52     // to either pass these structs around via references or move them.
  53 }
  54
  55 impl Drop for AsciiArt {
  56     fn drop(&mut self) {}
  57 }
  58
  59 // It's common to define a constructor sort of function to create struct instances.
  60 // If there is a canonical constructor it is typically named the same as the type.
  61 // Other constructor sort of functions are typically named from_foo, from_bar, etc.
  62 fn AsciiArt(width: uint, height: uint, fill: char) -> AsciiArt {
  63     // Use an anonymous function to build a vector of vectors containing
  64     // blank characters for each position in our canvas.
  65     let mut lines = Vec::new();
  66     for _ in range(0, height) {
  67         lines.push(Vec::from_elem(width, '.'));
  68     }
  69
  70     // Rust code often returns values by omitting the trailing semi-colon
  71     // instead of using an explicit return statement.
  72     AsciiArt {width: width, height: height, fill: fill, lines: lines}
  73 }
  74
  75 // Methods particular to the AsciiArt struct.
  76 impl AsciiArt {
  77     fn add_pt(&mut self, x: int, y: int) {
  78         if x >= 0 && x < self.width as int {
  79             if y >= 0 && y < self.height as int {
  80                 // Note that numeric types don't implicitly convert to each other.
  81                 let v = y as uint;
  82                 let h = x as uint;
  83
  84                 // Vector subscripting will normally copy the element, but &v[i]
  85                 // will return a reference which is what we need because the
  86                 // element is:
  87                 // 1) potentially large
  88                 // 2) needs to be modified
  89                 let row = &mut self.lines[v];
  90                 row[h] = self.fill;
  91             }
  92         }
  93     }
  94 }
  95
  96 // Allows AsciiArt to be converted to a string using the libcore ToString trait.
  97 // Note that the %s fmt! specifier will not call this automatically.
  98 impl fmt::Show for AsciiArt {
  99     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 100         // Convert each line into a string.
 101         let lines = self.lines.iter()
 102                               .map(|line| String::from_chars(line.as_slice()))
 103                               .collect::<Vec<String>>();
 104
 105         // Concatenate the lines together using a new-line.
 106         write!(f, "{}", lines.connect("\n"))
 107     }
 108 }
 109
 110 // This is similar to an interface in other languages: it defines a protocol which
 111 // developers can implement for arbitrary concrete types.
 112 trait Canvas {
 113     fn add_point(&mut self, shape: Point);
 114     fn add_rect(&mut self, shape: Rect);
 115
 116     // Unlike interfaces traits support default implementations.
 117     // Got an ICE as soon as I added this method.
 118     fn add_points(&mut self, shapes: &[Point]) {
 119         for pt in shapes.iter() {self.add_point(*pt)};
 120     }
 121 }
 122
 123 // Here we provide an implementation of the Canvas methods for AsciiArt.
 124 // Other implementations could also be provided (e.g. for PDF or Apple's Quartz)
 125 // and code can use them polymorphically via the Canvas trait.
 126 impl Canvas for AsciiArt {
 127     fn add_point(&mut self, shape: Point) {
 128         self.add_pt(shape.x, shape.y);
 129     }
 130
 131     fn add_rect(&mut self, shape: Rect) {
 132         // Add the top and bottom lines.
 133         for x in range(shape.top_left.x, shape.top_left.x + shape.size.width) {
 134             self.add_pt(x, shape.top_left.y);
 135             self.add_pt(x, shape.top_left.y + shape.size.height - 1);
 136         }
 137
 138         // Add the left and right lines.
 139         for y in range(shape.top_left.y, shape.top_left.y + shape.size.height) {
 140             self.add_pt(shape.top_left.x, y);
 141             self.add_pt(shape.top_left.x + shape.size.width - 1, y);
 142         }
 143     }
 144 }
 145
 146 // Rust's unit testing framework is currently a bit under-developed so we'll use
 147 // this little helper.
 148 pub fn check_strs(actual: &str, expected: &str) -> bool {
 149     if actual != expected {
 150         println!("Found:\n{}\nbut expected\n{}", actual, expected);
 151         return false;
 152     }
 153     return true;
 154 }
 155
 156
 157 fn test_ascii_art_ctor() {
 158     let art = AsciiArt(3, 3, '*');
 159     assert!(check_strs(art.to_string().as_slice(), "...\n...\n..."));
 160 }
 161
 162
 163 fn test_add_pt() {
 164     let mut art = AsciiArt(3, 3, '*');
 165     art.add_pt(0, 0);
 166     art.add_pt(0, -10);
 167     art.add_pt(1, 2);
 168     assert!(check_strs(art.to_string().as_slice(), "*..\n...\n.*."));
 169 }
 170
 171
 172 fn test_shapes() {
 173     let mut art = AsciiArt(4, 4, '*');
 174     art.add_rect(Rect {top_left: Point {x: 0, y: 0}, size: Size {width: 4, height: 4}});
 175     art.add_point(Point {x: 2, y: 2});
 176     assert!(check_strs(art.to_string().as_slice(), "****\n*..*\n*.**\n****"));
 177 }
 178
 179 pub fn main() {
 180     test_ascii_art_ctor();
 181     test_add_pt();
 182     test_shapes();
 183 }