ziglings/exercises/047_methods.zig
Arya-Elfren 18f69f5634 Clarify the methods syntax sugar & a bit more
I think it's a bit clearer to show exactly what the syntax sugar of methods is, because that's all it is. Every function in Zig is in a struct (files are structs after all) and methods just simplify their use.

I also thought we might use the explicit saturating subtraction as that is why the feature is in Zig.
2023-04-26 22:47:03 +01:00

107 lines
3.2 KiB
Zig

//
// Help! Evil alien creatures have hidden eggs all over the Earth
// and they're starting to hatch!
//
// Before you jump into battle, you'll need to know three things:
//
// 1. You can attach functions to structs (and other "type definitions"):
//
// const Foo = struct{
// pub fn hello() void {
// std.debug.print("Foo says hello!\n", .{});
// }
// };
//
// 2. A function that is a member of a struct is "namespaced" within
// that struct and is called by specifying the "namespace" and then
// using the "dot syntax":
//
// Foo.hello();
//
// 3. The NEAT feature of these functions is that if they take either
// an instance of the struct or a pointer to an instance of the struct
// then they have some syntax sugar:
//
// const Bar = struct{
// pub fn a(self: Bar) void { _ = self; }
// pub fn b(this: *Bar, other: u8) void { _ = this; _ = other; }
// pub fn c(bar: *const Bar) void { _ = bar; }
// };
//
// var bar = Bar{};
// bar.a() // is equivalent to Bar.a(bar)
// bar.b(3) // is equivalent to Bar.b(&bar, 3)
// bar.c() // is equivalent to Bar.c(&bar)
//
// Notice that the name of the parameter doesn't matter. Some use
// self, others use a lowercase version of the type name, but feel
// free to use whatever is most appropriate.
//
// Effectively, the method syntax sugar just does this transformation:
// thing.function(args);
// @TypeOf(thing).function(thing, args);
//
// Okay, you're armed.
//
// Now, please zap the alien structs until they're all gone or
// Earth will be doomed!
//
const std = @import("std");
// Look at this hideous Alien struct. Know your enemy!
const Alien = struct {
health: u8,
// We hate this method:
pub fn hatch(strength: u8) Alien {
return Alien{
.health = strength * 5,
};
}
};
// Your trusty weapon. Zap those aliens!
const HeatRay = struct {
damage: u8,
// We love this method:
pub fn zap(self: HeatRay, alien: *Alien) void {
alien.health -|= self.damage; // Saturating inplace substraction
// It subtracts but doesn't go below the
// lowest value for our type (in this case 0)
}
};
pub fn main() void {
// Look at all of these aliens of various strengths!
var aliens = [_]Alien{
Alien.hatch(2),
Alien.hatch(1),
Alien.hatch(3),
Alien.hatch(3),
Alien.hatch(5),
Alien.hatch(3),
};
var aliens_alive = aliens.len;
var heat_ray = HeatRay{ .damage = 7 }; // We've been given a heat ray weapon.
// We'll keep checking to see if we've killed all the aliens yet.
while (aliens_alive > 0) {
aliens_alive = 0;
// Loop through every alien by reference (* makes a pointer capture value)
for (&aliens) |*alien| {
// *** Zap the alien with the heat ray here! ***
???.zap(???);
// If the alien's health is still above 0, it's still alive.
if (alien.health > 0) aliens_alive += 1;
}
std.debug.print("{} aliens. ", .{aliens_alive});
}
std.debug.print("Earth is saved!\n", .{});
}