2021-02-12 04:04:36 +00:00
const std = @import ( " std " ) ;
2021-10-09 15:19:34 +01:00
const builtin = @import ( " builtin " ) ;
2021-02-12 04:04:36 +00:00
const Builder = std . build . Builder ;
const Step = std . build . Step ;
const assert = std . debug . assert ;
const print = std . debug . print ;
2021-04-23 17:40:20 +01:00
// When changing this version, be sure to also update README.md in two places:
// 1) Getting Started
// 2) Version Changes
2023-03-18 23:59:42 +00:00
const needed_version = std . SemanticVersion . parse ( " 0.11.0-dev.2157 " ) catch unreachable ;
2021-04-23 17:40:20 +01:00
2021-02-12 04:04:36 +00:00
const Exercise = struct {
/// main_file must have the format key_name.zig.
/// The key will be used as a shorthand to build
/// just one example.
main_file : [ ] const u8 ,
/// This is the desired output of the program.
/// A program passes if its output ends with this string.
output : [ ] const u8 ,
/// This is an optional hint to give if the program does not succeed.
hint : [ ] const u8 = " " ,
/// By default, we verify output against stderr.
/// Set this to true to check stdout instead.
check_stdout : bool = false ,
2022-08-29 08:17:42 +01:00
/// This exercise makes use of the async feature.
/// We need to keep track of this, so we compile without the self hosted compiler
@ " async " : bool = false ,
2023-02-15 21:55:44 +00:00
/// This exercise makes use of C functions
/// We need to keep track of this, so we compile with libc
C : bool = false ,
2021-02-12 04:04:36 +00:00
/// Returns the name of the main file with .zig stripped.
pub fn baseName ( self : Exercise ) [ ] const u8 {
assert ( std . mem . endsWith ( u8 , self . main_file , " .zig " ) ) ;
return self . main_file [ 0 . . self . main_file . len - 4 ] ;
}
2021-03-12 23:59:46 +00:00
/// Returns the key of the main file, the string before the '_' with
/// "zero padding" removed.
/// For example, "001_hello.zig" has the key "1".
2021-02-12 04:04:36 +00:00
pub fn key ( self : Exercise ) [ ] const u8 {
const end_index = std . mem . indexOfScalar ( u8 , self . main_file , '_' ) ;
assert ( end_index ! = null ) ; // main file must be key_description.zig
2021-03-12 23:59:46 +00:00
// remove zero padding by advancing index past '0's
var start_index : usize = 0 ;
while ( self . main_file [ start_index ] = = '0' ) start_index + = 1 ;
return self . main_file [ start_index . . end_index . ? ] ;
2021-02-12 04:04:36 +00:00
}
} ;
const exercises = [ _ ] Exercise {
. {
2021-03-12 23:59:46 +00:00
. main_file = " 001_hello.zig " ,
2022-11-16 12:00:36 +00:00
. output = " Hello world! " ,
2021-02-27 21:52:57 +00:00
. hint = " DON'T PANIC! \n Read the error above. \n See how it has something to do with 'main'? \n Open up the source file as noted and read the comments. \n You can do this! " ,
2021-02-12 04:04:36 +00:00
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 002_std.zig " ,
2022-11-16 12:00:36 +00:00
. output = " Standard Library. " ,
2021-02-12 04:04:36 +00:00
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 003_assignment.zig " ,
2021-02-12 04:04:36 +00:00
. output = " 55 314159 -11 " ,
. hint = " There are three mistakes in this one! " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 004_arrays.zig " ,
2022-06-11 13:27:11 +01:00
. output = " First: 2, Fourth: 7, Length: 8 " ,
2021-02-12 04:04:36 +00:00
. hint = " There are two things to complete here. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 005_arrays2.zig " ,
2021-02-12 04:04:36 +00:00
. output = " LEET: 1337, Bits: 100110011001 " ,
. hint = " Fill in the two arrays. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 006_strings.zig " ,
2021-02-12 04:04:36 +00:00
. output = " d=d ha ha ha Major Tom " ,
. hint = " Each '???' needs something filled in. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 007_strings2.zig " ,
2021-04-04 21:23:27 +01:00
. output = " Ziggy played guitar \n Jamming good with Andrew Kelley \n And the Spiders from Mars " ,
2021-02-12 04:04:36 +00:00
. hint = " Please fix the lyrics! " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 008_quiz.zig " ,
2021-04-04 21:23:27 +01:00
. output = " Program in Zig! " ,
2021-02-12 04:04:36 +00:00
. hint = " See if you can fix the program! " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 009_if.zig " ,
2021-02-12 04:04:36 +00:00
. output = " Foo is 1! " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 010_if2.zig " ,
2021-04-04 21:23:27 +01:00
. output = " With the discount, the price is $17. " ,
2021-02-12 04:04:36 +00:00
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 011_while.zig " ,
2021-04-04 21:23:27 +01:00
. output = " 2 4 8 16 32 64 128 256 512 n=1024 " ,
2021-02-12 04:04:36 +00:00
. hint = " You probably want a 'less than' condition. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 012_while2.zig " ,
2021-04-04 21:23:27 +01:00
. output = " 2 4 8 16 32 64 128 256 512 n=1024 " ,
2021-02-12 04:04:36 +00:00
. hint = " It might help to look back at the previous exercise. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 013_while3.zig " ,
2021-02-12 04:04:36 +00:00
. output = " 1 2 4 7 8 11 13 14 16 17 19 " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 014_while4.zig " ,
2021-02-12 04:04:36 +00:00
. output = " n=4 " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 015_for.zig " ,
2021-02-12 04:04:36 +00:00
. output = " A Dramatic Story: :-) :-) :-( :-| :-) The End. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 016_for2.zig " ,
2022-11-16 12:43:34 +00:00
. output = " The value of bits '1101': 13. " ,
2021-02-12 04:04:36 +00:00
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 017_quiz2.zig " ,
2021-04-04 21:23:27 +01:00
. output = " 1, 2, Fizz, 4, Buzz, Fizz, 7, 8, Fizz, Buzz, 11, Fizz, 13, 14, FizzBuzz, 16, " ,
2021-02-12 04:04:36 +00:00
. hint = " This is a famous game! " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 018_functions.zig " ,
2021-04-04 21:23:27 +01:00
. output = " Answer to the Ultimate Question: 42 " ,
2021-02-12 04:04:36 +00:00
. hint = " Can you help write the function? " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 019_functions2.zig " ,
2022-11-16 12:43:34 +00:00
. output = " Powers of two: 2 4 8 16 " ,
2021-02-12 04:04:36 +00:00
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 020_quiz3.zig " ,
2021-02-12 04:04:36 +00:00
. output = " 32 64 128 256 " ,
. hint = " Unexpected pop quiz! Help! " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 021_errors.zig " ,
2021-02-12 04:04:36 +00:00
. output = " 2<4. 3<4. 4=4. 5>4. 6>4. " ,
. hint = " What's the deal with fours? " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 022_errors2.zig " ,
2022-11-16 12:43:34 +00:00
. output = " I compiled! " ,
2021-02-12 04:04:36 +00:00
. hint = " Get the error union type right to allow this to compile. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 023_errors3.zig " ,
2021-02-12 04:04:36 +00:00
. output = " a=64, b=22 " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 024_errors4.zig " ,
2021-02-12 04:04:36 +00:00
. output = " a=20, b=14, c=10 " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 025_errors5.zig " ,
2021-02-12 04:04:36 +00:00
. output = " a=0, b=19, c=0 " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 026_hello2.zig " ,
2021-04-04 21:23:27 +01:00
. output = " Hello world! " ,
2021-02-12 04:04:36 +00:00
. hint = " Try using a try! " ,
. check_stdout = true ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 027_defer.zig " ,
2021-02-12 04:04:36 +00:00
. output = " One Two " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 028_defer2.zig " ,
2021-02-12 04:04:36 +00:00
. output = " (Goat) (Cat) (Dog) (Dog) (Goat) (Unknown) done. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 029_errdefer.zig " ,
2021-02-12 04:04:36 +00:00
. output = " Getting number...got 5. Getting number...failed! " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 030_switch.zig " ,
2021-02-12 04:04:36 +00:00
. output = " ZIG? " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 031_switch2.zig " ,
2021-02-12 04:04:36 +00:00
. output = " ZIG! " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 032_unreachable.zig " ,
2021-02-12 04:04:36 +00:00
. output = " 1 2 3 9 8 7 " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 033_iferror.zig " ,
2021-02-12 04:04:36 +00:00
. output = " 2<4. 3<4. 4=4. 5>4. 6>4. " ,
. hint = " Seriously, what's the deal with fours? " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 034_quiz4.zig " ,
2021-02-12 04:04:36 +00:00
. output = " my_num=42 " ,
. hint = " Can you make this work? " ,
. check_stdout = true ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 035_enums.zig " ,
2021-02-12 04:04:36 +00:00
. output = " 1 2 3 9 8 7 " ,
. hint = " This problem seems familiar... " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 036_enums2.zig " ,
2021-04-04 21:23:27 +01:00
. output = " <p> \n <span style= \" color: #ff0000 \" >Red</span> \n <span style= \" color: #00ff00 \" >Green</span> \n <span style= \" color: #0000ff \" >Blue</span> \n </p> " ,
2021-02-12 04:04:36 +00:00
. hint = " I'm feeling blue about this. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 037_structs.zig " ,
2021-02-12 04:04:36 +00:00
. output = " Your wizard has 90 health and 25 gold. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 038_structs2.zig " ,
2021-04-04 21:23:27 +01:00
. output = " Character 1 - G:20 H:100 XP:10 \n Character 2 - G:10 H:100 XP:20 " ,
2021-02-12 04:04:36 +00:00
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 039_pointers.zig " ,
2021-02-12 04:04:36 +00:00
. output = " num1: 5, num2: 5 " ,
. hint = " Pointers aren't so bad. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 040_pointers2.zig " ,
2021-02-12 04:04:36 +00:00
. output = " a: 12, b: 12 " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 041_pointers3.zig " ,
2021-02-12 04:04:36 +00:00
. output = " foo=6, bar=11 " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 042_pointers4.zig " ,
2021-02-12 04:04:36 +00:00
. output = " num: 5, more_nums: 1 1 5 1 " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 043_pointers5.zig " ,
2022-07-31 20:57:20 +01:00
. output = " Wizard (G:10 H:100 XP:20) \n Mentor: Wizard (G:10000 H:100 XP:2340) " ,
2021-02-12 04:04:36 +00:00
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 044_quiz5.zig " ,
2021-02-12 04:04:36 +00:00
. output = " Elephant A. Elephant B. Elephant C. " ,
. hint = " Oh no! We forgot Elephant B! " ,
} ,
2021-02-14 15:49:09 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 045_optionals.zig " ,
2021-02-14 15:49:09 +00:00
. output = " The Ultimate Answer: 42. " ,
} ,
2021-02-17 01:21:32 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 046_optionals2.zig " ,
2021-02-17 01:21:32 +00:00
. output = " Elephant A. Elephant B. Elephant C. " ,
2021-02-27 21:52:57 +00:00
. hint = " Elephants again! " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 047_methods.zig " ,
2021-02-27 21:52:57 +00:00
. output = " 5 aliens. 4 aliens. 1 aliens. 0 aliens. Earth is saved! " ,
. hint = " Use the heat ray. And the method! " ,
2021-02-17 01:21:32 +00:00
} ,
2021-02-28 18:23:22 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 048_methods2.zig " ,
2021-02-28 18:51:33 +00:00
. output = " A B C " ,
. hint = " This just needs one little fix. " ,
} ,
. {
2021-03-12 23:59:46 +00:00
. main_file = " 049_quiz6.zig " ,
2021-02-28 18:51:33 +00:00
. output = " A B C Cv Bv Av " ,
2021-04-25 02:07:58 +01:00
. hint = " Now you're writing Zig! " ,
2021-02-28 18:23:22 +00:00
} ,
2021-02-28 23:36:38 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 050_no_value.zig " ,
2021-02-28 23:36:38 +00:00
. output = " That is not dead which can eternal lie / And with strange aeons even death may die. " ,
} ,
2021-03-05 16:01:12 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 051_values.zig " ,
2021-03-05 16:01:12 +00:00
. output = " 1:false!. 2:true!. 3:true!. XP before:0, after:200. " ,
} ,
2021-03-06 23:20:50 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 052_slices.zig " ,
2021-07-21 11:04:52 +01:00
. output = " Hand1: A 4 K 8 \n Hand2: 5 2 Q J " ,
2021-03-06 23:20:50 +00:00
} ,
2021-03-07 00:16:28 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 053_slices2.zig " ,
2021-03-07 00:16:28 +00:00
. output = " 'all your base are belong to us.' 'for great justice.' " ,
} ,
2021-03-07 02:31:02 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 054_manypointers.zig " ,
2021-03-07 02:31:02 +00:00
. output = " Memory is a resource. " ,
} ,
2021-03-10 01:04:43 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 055_unions.zig " ,
2021-03-10 01:04:43 +00:00
. output = " Insect report! Ant alive is: true. Bee visited 15 flowers. " ,
} ,
2021-03-10 01:51:00 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 056_unions2.zig " ,
2021-03-10 01:51:00 +00:00
. output = " Insect report! Ant alive is: true. Bee visited 16 flowers. " ,
} ,
2021-03-11 01:14:25 +00:00
. {
2021-03-12 23:59:46 +00:00
. main_file = " 057_unions3.zig " ,
. output = " Insect report! Ant alive is: true. Bee visited 17 flowers. " ,
2021-03-11 01:14:25 +00:00
} ,
2021-07-21 16:33:32 +01:00
. {
. main_file = " 058_quiz7.zig " ,
. output = " Archer's Point--2->Bridge--1->Dogwood Grove--3->Cottage--2->East Pond--1->Fox Pond " ,
. hint = " This is the biggest program we've seen yet. But you can do it! " ,
2021-07-21 15:02:13 +01:00
} ,
2021-04-08 23:42:19 +01:00
. {
. main_file = " 059_integers.zig " ,
. output = " Zig is cool. " ,
} ,
2021-04-09 18:02:36 +01:00
. {
. main_file = " 060_floats.zig " ,
. output = " Shuttle liftoff weight: 1995796kg " ,
} ,
2021-04-09 19:41:25 +01:00
. {
. main_file = " 061_coercions.zig " ,
. output = " Letter: A " ,
} ,
2021-04-10 00:24:59 +01:00
. {
. main_file = " 062_loop_expressions.zig " ,
. output = " Current language: Zig " ,
2021-04-11 16:19:58 +01:00
. hint = " Surely the current language is 'Zig'! " ,
2021-04-10 00:24:59 +01:00
} ,
2021-04-10 16:39:11 +01:00
. {
. main_file = " 063_labels.zig " ,
. output = " Enjoy your Cheesy Chili! " ,
} ,
2021-04-11 01:26:17 +01:00
. {
. main_file = " 064_builtins.zig " ,
2022-04-21 06:09:21 +01:00
. output = " 1101 + 0101 = 0010 (true). Without overflow: 00010010. Furthermore, 11110000 backwards is 00001111. " ,
2021-04-11 01:26:17 +01:00
} ,
2021-04-11 16:19:58 +01:00
. {
. main_file = " 065_builtins2.zig " ,
. output = " A Narcissus loves all Narcissuses. He has room in his heart for: me myself. " ,
} ,
2021-07-21 16:33:32 +01:00
. {
. main_file = " 066_comptime.zig " ,
. output = " Immutable: 12345, 987.654; Mutable: 54321, 456.789; Types: comptime_int, comptime_float, u32, f32 " ,
. hint = " It may help to read this one out loud to your favorite stuffed animal until it sinks in completely. " ,
2021-07-21 15:03:44 +01:00
} ,
2021-04-16 01:58:12 +01:00
. {
. main_file = " 067_comptime2.zig " ,
. output = " A BB CCC DDDD " ,
} ,
2021-04-18 23:05:36 +01:00
. {
. main_file = " 068_comptime3.zig " ,
. output = " Minnow (1:32, 4 x 2) \n Shark (1:16, 8 x 5) \n Whale (1:1, 143 x 95) \n " ,
} ,
2021-04-21 14:47:16 +01:00
. {
. main_file = " 069_comptime4.zig " ,
. output = " s1={ 1, 2, 3 }, s2={ 1, 2, 3, 4, 5 }, s3={ 1, 2, 3, 4, 5, 6, 7 } " ,
} ,
2021-04-22 01:08:34 +01:00
. {
. main_file = " 070_comptime5.zig " ,
. output = " \" Quack. \" ducky1: true, \" Squeek! \" ducky2: true, ducky3: false " ,
. hint = " Have you kept the wizard hat on? " ,
} ,
2021-04-22 22:17:25 +01:00
. {
. main_file = " 071_comptime6.zig " ,
. output = " Narcissus has room in his heart for: me myself. " ,
} ,
2021-04-24 19:34:46 +01:00
. {
. main_file = " 072_comptime7.zig " ,
. output = " 26 " ,
} ,
2021-04-27 01:01:54 +01:00
. {
. main_file = " 073_comptime8.zig " ,
. output = " My llama value is 25. " ,
} ,
2021-05-01 02:35:56 +01:00
. {
. main_file = " 074_comptime9.zig " ,
. output = " My llama value is 2. " ,
} ,
. {
. main_file = " 075_quiz8.zig " ,
. output = " Archer's Point--2->Bridge--1->Dogwood Grove--3->Cottage--2->East Pond--1->Fox Pond " ,
. hint = " Roll up those sleeves. You get to WRITE some code for this one. " ,
} ,
2021-05-07 01:32:36 +01:00
. {
. main_file = " 076_sentinels.zig " ,
2021-05-08 23:51:08 +01:00
. output = " Array:123056. Many-item pointer:123. " ,
} ,
. {
. main_file = " 077_sentinels2.zig " ,
. output = " Weird Data! " ,
} ,
. {
. main_file = " 078_sentinels3.zig " ,
. output = " Weird Data! " ,
2021-05-07 01:32:36 +01:00
} ,
2021-05-09 18:10:09 +01:00
. {
. main_file = " 079_quoted_identifiers.zig " ,
. output = " Sweet freedom: 55, false. " ,
. hint = " Help us, Zig Programmer, you're our only hope! " ,
} ,
2021-05-09 18:24:25 +01:00
. {
. main_file = " 080_anonymous_structs.zig " ,
. output = " [Circle(i32): 25,70,15] [Circle(f32): 25.2,71.0,15.7] " ,
} ,
2021-05-09 19:25:51 +01:00
. {
. main_file = " 081_anonymous_structs2.zig " ,
. output = " x:205 y:187 radius:12 " ,
} ,
2021-05-09 23:58:56 +01:00
. {
. main_file = " 082_anonymous_structs3.zig " ,
. output = " \" 0 \" (bool):true \" 1 \" (bool):false \" 2 \" (i32):42 \" 3 \" (f32):3.14159202e+00 " ,
2021-05-13 01:35:29 +01:00
. hint = " This one is a challenge! But you have everything you need. " ,
2021-05-09 23:58:56 +01:00
} ,
2021-05-10 00:53:14 +01:00
. {
. main_file = " 083_anonymous_lists.zig " ,
. output = " I say hello! " ,
} ,
2023-01-21 12:57:32 +00:00
// disabled because of https://github.com/ratfactor/ziglings/issues/163
2023-02-12 16:10:40 +00:00
// direct link: https://github.com/ziglang/zig/issues/6025
2023-01-21 12:57:32 +00:00
// .{
// .main_file = "084_async.zig",
// .output = "foo() A",
// .hint = "Read the facts. Use the facts.",
// .@"async" = true,
// },
// .{
// .main_file = "085_async2.zig",
// .output = "Hello async!",
// .@"async" = true,
// },
// .{
// .main_file = "086_async3.zig",
// .output = "5 4 3 2 1",
// .@"async" = true,
// },
// .{
// .main_file = "087_async4.zig",
// .output = "1 2 3 4 5",
// .@"async" = true,
// },
// .{
// .main_file = "088_async5.zig",
// .output = "Example Title.",
// .@"async" = true,
// },
// .{
// .main_file = "089_async6.zig",
// .output = ".com: Example Title, .org: Example Title.",
// .@"async" = true,
// },
// .{
// .main_file = "090_async7.zig",
// .output = "beef? BEEF!",
// .@"async" = true,
// },
// .{
// .main_file = "091_async8.zig",
// .output = "ABCDEF",
// .@"async" = true,
// },
2023-02-16 18:28:10 +00:00
. {
. main_file = " 092_interfaces.zig " ,
. output = " Daily Insect Report: \n Ant is alive. \n Bee visited 17 flowers. \n Grasshopper hopped 32 meters. " ,
} ,
2023-02-15 21:55:44 +00:00
. {
. main_file = " 093_hello_c.zig " ,
2023-02-27 22:22:51 +00:00
. output = " Hello C from Zig! - C result is 17 chars written. " ,
2023-02-18 22:39:21 +00:00
. C = true ,
} ,
. {
. main_file = " 094_c_math.zig " ,
. output = " The normalized angle of 765.2 degrees is 45.2 degrees. " ,
2023-02-15 21:55:44 +00:00
. C = true ,
} ,
2023-03-04 15:07:53 +00:00
. {
. main_file = " 095_for_loops.zig " ,
. output = " 1 2 4 7 8 11 13 14 16 17 19 " ,
} ,
2023-03-08 17:51:07 +00:00
. {
. main_file = " 096_memory_allocation.zig " ,
. output = " Running Average: 0.30 0.25 0.20 0.18 0.22 " ,
} ,
2023-01-21 22:26:53 +00:00
. {
2023-01-22 12:12:53 +00:00
. main_file = " 999_the_end.zig " ,
2023-02-02 09:38:02 +00:00
. output = " \n This is the end for now! \n We hope you had fun and were able to learn a lot, so visit us again when the next exercises are available. " ,
2023-01-21 22:26:53 +00:00
} ,
2021-02-12 04:04:36 +00:00
} ;
/// Check the zig version to make sure it can compile the examples properly.
/// This will compile with Zig 0.6.0 and later.
fn checkVersion ( ) bool {
2021-10-09 15:19:34 +01:00
if ( ! @hasDecl ( builtin , " zig_version " ) ) {
2021-02-12 04:04:36 +00:00
return false ;
}
2021-10-09 15:19:34 +01:00
const version = builtin . zig_version ;
2021-02-12 04:04:36 +00:00
const order = version . order ( needed_version ) ;
return order ! = . lt ;
}
2023-03-18 23:59:42 +00:00
pub fn build ( b : * Builder ) ! void {
2021-02-12 04:04:36 +00:00
// Use a comptime branch for the version check.
// If this fails, code after this block is not compiled.
// It is parsed though, so versions of zig from before 0.6.0
// cannot do the version check and will just fail to compile.
// We could fix this by moving the ziglings code to a separate file,
// but 0.5.0 was a long time ago, it is unlikely that anyone who
// attempts these exercises is still using it.
if ( comptime ! checkVersion ( ) ) {
// very old versions of Zig used warn instead of print.
const stderrPrintFn = if ( @hasDecl ( std . debug , " print " ) ) std . debug . print else std . debug . warn ;
stderrPrintFn (
2021-02-15 00:25:35 +00:00
\\ERROR: Sorry, it looks like your version of zig is too old. :-(
\\
2021-02-16 01:13:50 +00:00
\\Ziglings requires development build
2021-02-15 00:25:35 +00:00
\\
2021-04-23 17:40:20 +01:00
\\ {}
2021-02-16 01:04:18 +00:00
\\
2021-02-16 01:13:50 +00:00
\\or higher. Please download a development ("master") build from
2021-02-12 04:04:36 +00:00
\\
2021-04-23 17:40:20 +01:00
\\ https://ziglang.org/download/
\\
\\
, . { needed_version } ) ;
2021-02-16 23:10:02 +00:00
std . os . exit ( 0 ) ;
2021-02-12 04:04:36 +00:00
}
use_color_escapes = false ;
2023-03-18 23:59:42 +00:00
if ( std . io . getStdErr ( ) . supportsAnsiEscapeCodes ( ) ) {
use_color_escapes = true ;
} else if ( builtin . os . tag = = . windows ) {
const w32 = struct {
const WINAPI = std . os . windows . WINAPI ;
const DWORD = std . os . windows . DWORD ;
const ENABLE_VIRTUAL_TERMINAL_PROCESSING = 0x0004 ;
const STD_ERROR_HANDLE = @bitCast ( DWORD , @as ( i32 , - 12 ) ) ;
extern " kernel32 " fn GetStdHandle ( id : DWORD ) callconv ( WINAPI ) ? * anyopaque ;
extern " kernel32 " fn GetConsoleMode ( console : ? * anyopaque , out_mode : * DWORD ) callconv ( WINAPI ) u32 ;
extern " kernel32 " fn SetConsoleMode ( console : ? * anyopaque , mode : DWORD ) callconv ( WINAPI ) u32 ;
} ;
const handle = w32 . GetStdHandle ( w32 . STD_ERROR_HANDLE ) ;
var mode : w32 . DWORD = 0 ;
if ( w32 . GetConsoleMode ( handle , & mode ) ! = 0 ) {
mode | = w32 . ENABLE_VIRTUAL_TERMINAL_PROCESSING ;
use_color_escapes = w32 . SetConsoleMode ( handle , mode ) ! = 0 ;
}
2021-02-12 04:04:36 +00:00
}
if ( use_color_escapes ) {
red_text = " \x1b [31m " ;
green_text = " \x1b [32m " ;
bold_text = " \x1b [1m " ;
reset_text = " \x1b [0m " ;
}
2023-03-18 23:59:42 +00:00
const logo =
2021-02-12 04:04:36 +00:00
\\
\\ _ _ _
\\ ___(_) __ _| (_)_ __ __ _ ___
\\ |_ | |/ _' | | | '_ \ / _' / __|
2021-03-03 04:06:09 +00:00
\\ / /| | (_| | | | | | | (_| \__ \
2021-02-12 04:04:36 +00:00
\\ /___|_|\__, |_|_|_| |_|\__, |___/
\\ |___/ |___/
\\
\\
2023-03-18 23:59:42 +00:00
;
2023-03-19 17:23:35 +00:00
const header_step = b . step ( " info " , logo ) ;
2023-04-02 13:59:22 +01:00
const logo_step = PrintStep . create ( b , logo , std . io . getStdErr ( ) ) ;
logo_step . step . dependOn ( header_step ) ;
2021-02-12 04:04:36 +00:00
2021-02-14 21:42:42 +00:00
const verify_all = b . step ( " ziglings " , " Check all ziglings " ) ;
2023-03-18 23:59:42 +00:00
verify_all . dependOn ( header_step ) ;
2021-02-12 04:04:36 +00:00
b . default_step = verify_all ;
var prev_chain_verify = verify_all ;
2021-02-14 23:36:09 +00:00
const use_healed = b . option ( bool , " healed " , " Run exercises from patches/healed " ) orelse false ;
2023-03-19 17:23:35 +00:00
for ( exercises ) | ex | {
const base_name = ex . baseName ( ) ;
const file_path = std . fs . path . join ( b . allocator , & [ _ ] [ ] const u8 {
if ( use_healed ) " patches/healed " else " exercises " , ex . main_file ,
} ) catch unreachable ;
const build_step = b . addExecutable ( . { . name = base_name , . root_source_file = . { . path = file_path } } ) ;
2023-02-02 03:51:47 +00:00
2023-03-19 17:23:35 +00:00
build_step . install ( ) ;
2021-02-12 04:04:36 +00:00
2023-03-19 17:23:35 +00:00
const verify_step = ZiglingStep . create ( b , ex , use_healed ) ;
2021-02-12 04:04:36 +00:00
2023-03-19 17:23:35 +00:00
const key = ex . key ( ) ;
2021-02-12 04:04:36 +00:00
2023-03-19 17:23:35 +00:00
const named_test = b . step ( b . fmt ( " {s}_test " , . { key } ) , b . fmt ( " Run {s} without checking output " , . { ex . main_file } ) ) ;
const run_step = build_step . run ( ) ;
named_test . dependOn ( & run_step . step ) ;
2021-02-12 04:04:36 +00:00
2023-03-19 17:23:35 +00:00
const named_install = b . step ( b . fmt ( " {s}_install " , . { key } ) , b . fmt ( " Install {s} to zig-cache/bin " , . { ex . main_file } ) ) ;
named_install . dependOn ( & build_step . install_step . ? . step ) ;
2021-02-12 04:04:36 +00:00
2023-03-19 17:23:35 +00:00
const named_verify = b . step ( key , b . fmt ( " Check {s} only " , . { ex . main_file } ) ) ;
named_verify . dependOn ( & verify_step . step ) ;
2021-02-12 04:04:36 +00:00
2023-03-19 17:23:35 +00:00
const chain_verify = b . allocator . create ( Step ) catch unreachable ;
chain_verify . * = Step . init ( Step . Options { . id = . custom , . name = b . fmt ( " chain {s} " , . { key } ) , . owner = b } ) ;
chain_verify . dependOn ( & verify_step . step ) ;
2021-02-12 04:04:36 +00:00
2023-03-19 17:23:35 +00:00
const named_chain = b . step ( b . fmt ( " {s}_start " , . { key } ) , b . fmt ( " Check all solutions starting at {s} " , . { ex . main_file } ) ) ;
named_chain . dependOn ( header_step ) ;
named_chain . dependOn ( chain_verify ) ;
2021-02-12 04:04:36 +00:00
2023-03-19 17:23:35 +00:00
prev_chain_verify . dependOn ( chain_verify ) ;
prev_chain_verify = chain_verify ;
}
2021-02-12 04:04:36 +00:00
}
var use_color_escapes = false ;
var red_text : [ ] const u8 = " " ;
var green_text : [ ] const u8 = " " ;
var bold_text : [ ] const u8 = " " ;
var reset_text : [ ] const u8 = " " ;
const ZiglingStep = struct {
step : Step ,
exercise : Exercise ,
builder : * Builder ,
2021-02-14 23:36:09 +00:00
use_healed : bool ,
2021-02-12 04:04:36 +00:00
2021-02-14 23:36:09 +00:00
pub fn create ( builder : * Builder , exercise : Exercise , use_healed : bool ) * @This ( ) {
2021-02-12 04:04:36 +00:00
const self = builder . allocator . create ( @This ( ) ) catch unreachable ;
self . * = . {
2023-03-18 23:59:42 +00:00
. step = Step . init ( Step . Options { . id = . custom , . name = exercise . main_file , . owner = builder , . makeFn = make } ) ,
2021-02-12 04:04:36 +00:00
. exercise = exercise ,
. builder = builder ,
2021-02-14 23:36:09 +00:00
. use_healed = use_healed ,
2021-02-12 04:04:36 +00:00
} ;
return self ;
}
2023-03-18 23:59:42 +00:00
fn make ( step : * Step , prog_node : * std . Progress . Node ) anyerror ! void {
_ = prog_node ;
2021-02-12 04:04:36 +00:00
const self = @fieldParentPtr ( @This ( ) , " step " , step ) ;
self . makeInternal ( ) catch {
if ( self . exercise . hint . len > 0 ) {
2021-02-14 21:42:42 +00:00
print ( " \n {s}HINT: {s}{s} " , . { bold_text , self . exercise . hint , reset_text } ) ;
2021-02-12 04:04:36 +00:00
}
print ( " \n {s}Edit exercises/{s} and run this again.{s} " , . { red_text , self . exercise . main_file , reset_text } ) ;
print ( " \n {s}To continue from this zigling, use this command:{s} \n {s}zig build {s}{s} \n " , . { red_text , reset_text , bold_text , self . exercise . key ( ) , reset_text } ) ;
2022-11-16 12:05:25 +00:00
std . os . exit ( 1 ) ;
2021-02-12 04:04:36 +00:00
} ;
}
fn makeInternal ( self : * @This ( ) ) ! void {
print ( " Compiling {s}... \n " , . { self . exercise . main_file } ) ;
const exe_file = try self . doCompile ( ) ;
2021-02-14 21:42:42 +00:00
print ( " Checking {s}... \n " , . { self . exercise . main_file } ) ;
2021-02-12 04:04:36 +00:00
2023-02-15 18:28:27 +00:00
const cwd = self . builder . build_root . path . ? ;
2021-02-12 04:04:36 +00:00
const argv = [ _ ] [ ] const u8 { exe_file } ;
2022-05-02 01:19:37 +01:00
var child = std . ChildProcess . init ( & argv , self . builder . allocator ) ;
2021-02-12 04:04:36 +00:00
child . cwd = cwd ;
child . env_map = self . builder . env_map ;
child . stdin_behavior = . Inherit ;
if ( self . exercise . check_stdout ) {
child . stdout_behavior = . Pipe ;
child . stderr_behavior = . Inherit ;
} else {
child . stdout_behavior = . Inherit ;
child . stderr_behavior = . Pipe ;
}
child . spawn ( ) catch | err | {
print ( " {s}Unable to spawn {s}: {s}{s} \n " , . { red_text , argv [ 0 ] , @errorName ( err ) , reset_text } ) ;
return err ;
} ;
// Allow up to 1 MB of stdout capture
const max_output_len = 1 * 1024 * 1024 ;
const output = if ( self . exercise . check_stdout )
try child . stdout . ? . reader ( ) . readAllAlloc ( self . builder . allocator , max_output_len )
else
try child . stderr . ? . reader ( ) . readAllAlloc ( self . builder . allocator , max_output_len ) ;
// at this point stdout is closed, wait for the process to terminate
const term = child . wait ( ) catch | err | {
print ( " {s}Unable to spawn {s}: {s}{s} \n " , . { red_text , argv [ 0 ] , @errorName ( err ) , reset_text } ) ;
return err ;
} ;
// make sure it exited cleanly.
switch ( term ) {
. Exited = > | code | {
if ( code ! = 0 ) {
print ( " {s}{s} exited with error code {d} (expected {d}){s} \n " , . { red_text , self . exercise . main_file , code , 0 , reset_text } ) ;
return error . BadExitCode ;
}
} ,
else = > {
print ( " {s}{s} terminated unexpectedly{s} \n " , . { red_text , self . exercise . main_file , reset_text } ) ;
return error . UnexpectedTermination ;
} ,
}
// validate the output
2023-02-02 09:38:02 +00:00
const trimOutput = std . mem . trimRight ( u8 , output , " \r \n " ) ;
const trimExerciseOutput = std . mem . trimRight ( u8 , self . exercise . output , " \r \n " ) ;
2022-11-16 12:00:36 +00:00
if ( std . mem . indexOf ( u8 , trimOutput , trimExerciseOutput ) = = null or trimOutput . len ! = trimExerciseOutput . len ) {
2021-02-12 04:04:36 +00:00
print (
\\
\\{s}----------- Expected this output -----------{s}
2022-11-16 12:00:36 +00:00
\\"{s}"
2021-02-12 04:04:36 +00:00
\\{s}----------- but found -----------{s}
2022-11-16 12:00:36 +00:00
\\"{s}"
2021-02-12 04:04:36 +00:00
\\{s}-----------{s}
\\
2022-11-16 12:00:36 +00:00
, . { red_text , reset_text , trimExerciseOutput , red_text , reset_text , trimOutput , red_text , reset_text } ) ;
2021-02-12 04:04:36 +00:00
return error . InvalidOutput ;
}
2021-07-21 16:30:51 +01:00
print ( " {s}PASSED: \n {s}{s} \n " , . { green_text , output , reset_text } ) ;
2021-02-12 04:04:36 +00:00
}
// The normal compile step calls os.exit, so we can't use it as a library :(
// This is a stripped down copy of std.build.LibExeObjStep.make.
fn doCompile ( self : * @This ( ) ) ! [ ] const u8 {
const builder = self . builder ;
var zig_args = std . ArrayList ( [ ] const u8 ) . init ( builder . allocator ) ;
defer zig_args . deinit ( ) ;
zig_args . append ( builder . zig_exe ) catch unreachable ;
zig_args . append ( " build-exe " ) catch unreachable ;
2022-08-29 08:17:42 +01:00
// Enable the stage 1 compiler if using the async feature
2023-01-21 12:57:32 +00:00
// disabled because of https://github.com/ratfactor/ziglings/issues/163
// if (self.exercise.@"async") {
// zig_args.append("-fstage1") catch unreachable;
// }
2022-08-29 08:17:42 +01:00
2023-02-15 21:55:44 +00:00
// Enable C support for exercises that use C functions
if ( self . exercise . C ) {
zig_args . append ( " -lc " ) catch unreachable ;
}
2021-03-12 23:59:46 +00:00
const zig_file = std . fs . path . join ( builder . allocator , & [ _ ] [ ] const u8 { if ( self . use_healed ) " patches/healed " else " exercises " , self . exercise . main_file } ) catch unreachable ;
2021-02-12 04:04:36 +00:00
zig_args . append ( builder . pathFromRoot ( zig_file ) ) catch unreachable ;
zig_args . append ( " --cache-dir " ) catch unreachable ;
2023-02-15 18:28:27 +00:00
zig_args . append ( builder . pathFromRoot ( builder . cache_root . path . ? ) ) catch unreachable ;
2021-02-12 04:04:36 +00:00
zig_args . append ( " --enable-cache " ) catch unreachable ;
const argv = zig_args . items ;
var code : u8 = undefined ;
const output_dir_nl = builder . execAllowFail ( argv , & code , . Inherit ) catch | err | {
switch ( err ) {
error . FileNotFound = > {
print ( " {s}{s}: Unable to spawn the following command: file not found{s} \n " , . { red_text , self . exercise . main_file , reset_text } ) ;
for ( argv ) | v | print ( " {s} " , . { v } ) ;
print ( " \n " , . { } ) ;
} ,
error . ExitCodeFailure = > {
print ( " {s}{s}: The following command exited with error code {}:{s} \n " , . { red_text , self . exercise . main_file , code , reset_text } ) ;
for ( argv ) | v | print ( " {s} " , . { v } ) ;
print ( " \n " , . { } ) ;
} ,
error . ProcessTerminated = > {
print ( " {s}{s}: The following command terminated unexpectedly:{s} \n " , . { red_text , self . exercise . main_file , reset_text } ) ;
for ( argv ) | v | print ( " {s} " , . { v } ) ;
print ( " \n " , . { } ) ;
} ,
else = > { } ,
}
return err ;
} ;
const build_output_dir = std . mem . trimRight ( u8 , output_dir_nl , " \r \n " ) ;
const target_info = std . zig . system . NativeTargetInfo . detect (
. { } ,
) catch unreachable ;
const target = target_info . target ;
const file_name = std . zig . binNameAlloc ( builder . allocator , . {
. root_name = self . exercise . baseName ( ) ,
. target = target ,
. output_mode = . Exe ,
. link_mode = . Static ,
. version = null ,
} ) catch unreachable ;
return std . fs . path . join ( builder . allocator , & [ _ ] [ ] const u8 {
build_output_dir , file_name ,
} ) ;
}
} ;
2023-04-02 13:59:22 +01:00
// Print a message to a file.
const PrintStep = struct {
step : Step ,
message : [ ] const u8 ,
file : std . fs . File ,
pub fn create ( owner : * std . Build , message : [ ] const u8 , file : std . fs . File ) * PrintStep {
const self = owner . allocator . create ( PrintStep ) catch @panic ( " OOM " ) ;
self . * = . {
. step = Step . init ( . {
. id = . custom ,
. name = " Print " ,
. owner = owner ,
. makeFn = make ,
} ) ,
. message = message ,
. file = file ,
} ;
return self ;
}
fn make ( step : * Step , prog_node : * std . Progress . Node ) ! void {
_ = prog_node ;
const p = @fieldParentPtr ( PrintStep , " step " , step ) ;
try p . file . writeAll ( p . message ) ;
}
} ;