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 use std::str;
  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 lines = slice::build(Some(height), |push| {
  66         for _ in range(0, height) { push(slice::from_elem(width, '.')); }
  67     });
  68
  69     // Rust code often returns values by omitting the trailing semi-colon
  70     // instead of using an explicit return statement.
  71     AsciiArt {width: width, height: height, fill: fill, lines: lines}
  72 }
  73
  74 // Methods particular to the AsciiArt struct.
  75 impl AsciiArt {
  76     fn add_pt(&mut self, x: int, y: int) {
  77         if x >= 0 && x < self.width as int {
  78             if y >= 0 && y < self.height as int {
  79                 // Note that numeric types don't implicitly convert to each other.
  80                 let v = y as uint;
  81                 let h = x as uint;
  82
  83                 // Vector subscripting will normally copy the element, but &v[i]
  84                 // will return a reference which is what we need because the
  85                 // element is:
  86                 // 1) potentially large
  87                 // 2) needs to be modified
  88                 let row = &mut self.lines[v];
  89                 row[h] = self.fill;
  90             }
  91         }
  92     }
  93 }
  94
  95 // Allows AsciiArt to be converted to a string using the libcore ToStr trait.
  96 // Note that the %s fmt! specifier will not call this automatically.
  97 impl fmt::Show for AsciiArt {
  98     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  99         // Convert each line into a string.
 100         let lines = self.lines.map(|line| str::from_chars(*line));
 101
 102         // Concatenate the lines together using a new-line.
 103         write!(f.buf, "{}", lines.connect("\n"))
 104     }
 105 }
 106
 107 // This is similar to an interface in other languages: it defines a protocol which
 108 // developers can implement for arbitrary concrete types.
 109 trait Canvas {
 110     fn add_point(&mut self, shape: Point);
 111     fn add_rect(&mut self, shape: Rect);
 112
 113     // Unlike interfaces traits support default implementations.
 114     // Got an ICE as soon as I added this method.
 115     fn add_points(&mut self, shapes: &[Point]) {
 116         for pt in shapes.iter() {self.add_point(*pt)};
 117     }
 118 }
 119
 120 // Here we provide an implementation of the Canvas methods for AsciiArt.
 121 // Other implementations could also be provided (e.g. for PDF or Apple's Quartz)
 122 // and code can use them polymorphically via the Canvas trait.
 123 impl Canvas for AsciiArt {
 124     fn add_point(&mut self, shape: Point) {
 125         self.add_pt(shape.x, shape.y);
 126     }
 127
 128     fn add_rect(&mut self, shape: Rect) {
 129         // Add the top and bottom lines.
 130         for x in range(shape.top_left.x, shape.top_left.x + shape.size.width) {
 131             self.add_pt(x, shape.top_left.y);
 132             self.add_pt(x, shape.top_left.y + shape.size.height - 1);
 133         }
 134
 135         // Add the left and right lines.
 136         for y in range(shape.top_left.y, shape.top_left.y + shape.size.height) {
 137             self.add_pt(shape.top_left.x, y);
 138             self.add_pt(shape.top_left.x + shape.size.width - 1, y);
 139         }
 140     }
 141 }
 142
 143 // Rust's unit testing framework is currently a bit under-developed so we'll use
 144 // this little helper.
 145 pub fn check_strs(actual: &str, expected: &str) -> bool {
 146     if actual != expected {
 147         println!("Found:\n{}\nbut expected\n{}", actual, expected);
 148         return false;
 149     }
 150     return true;
 151 }
 152
 153
 154 fn test_ascii_art_ctor() {
 155     let art = AsciiArt(3, 3, '*');
 156     assert!(check_strs(art.to_str(), "...\n...\n..."));
 157 }
 158
 159
 160 fn test_add_pt() {
 161     let mut art = AsciiArt(3, 3, '*');
 162     art.add_pt(0, 0);
 163     art.add_pt(0, -10);
 164     art.add_pt(1, 2);
 165     assert!(check_strs(art.to_str(), "*..\n...\n.*."));
 166 }
 167
 168
 169 fn test_shapes() {
 170     let mut art = AsciiArt(4, 4, '*');
 171     art.add_rect(Rect {top_left: Point {x: 0, y: 0}, size: Size {width: 4, height: 4}});
 172     art.add_point(Point {x: 2, y: 2});
 173     assert!(check_strs(art.to_str(), "****\n*..*\n*.**\n****"));
 174 }
 175
 176 pub fn main() {
 177     test_ascii_art_ctor();
 178     test_add_pt();
 179     test_shapes();
 180 }