Introduce codegen arguments via -C flag

Author: rexim

Makefile

@@ -39,7 +39,8 @@ POSIX_OBJS=\
 	$(BUILD)/libc.posix.o \
 	$(BUILD)/arena.posix.o \
 	$(BUILD)/jim.posix.o \
-	$(BUILD)/jimp.posix.o
+	$(BUILD)/jimp.posix.o \
+	$(BUILD)/shlex.posix.o \
 
 MINGW32_OBJS=\
 	$(BUILD)/nob.mingw32.o \
@@ -48,7 +49,8 @@ MINGW32_OBJS=\
 	$(BUILD)/libc.mingw32.o \
 	$(BUILD)/arena.mingw32.o \
 	$(BUILD)/jim.mingw32.o \
-	$(BUILD)/jimp.mingw32.o
+	$(BUILD)/jimp.mingw32.o \
+	$(BUILD)/shlex.mingw32.o \
 
 .PHONY: all
 all: $(BUILD)/b $(BUILD)/btest

examples/game_of_b.b

@@ -1,5 +1,5 @@
 // To compile this example you need to pass appropriate linker flags to the b compiler:
-// $ b 65_game_of_b.b -L -lncurses -L -lpanel -run
+// $ b 65_game_of_b.b -C link-args='-lncurses -lpanel' -run
 
 TRUE;
 FALSE;

examples/raylib.b

@@ -4,10 +4,10 @@
 // Than pass appropriate linker flags to the b compiler.
 // # Linux
 //
-// $ b raylib.b -L -L/path/to/raylib-version_linux_amd64/lib/ -L -l:libraylib.a -L -lm -run
+// $ b raylib.b -C link-args='-L/path/to/raylib-version_linux_amd64/lib/ -l:libraylib.a -lm' -run
 //
 // # Windows mingw32-w64
-// > b -t gas-x86_64-windows raylib.b -L -L$HOME/opt/raylib-version_win64_mingw-w64/lib/ -L -l:libraylib.a -L -lwinmm -L -lgdi32 -run
+// > b -t gas-x86_64-windows raylib.b -C link-args='-L$HOME/opt/raylib-version_win64_mingw-w64/lib/ -l:libraylib.a -lwinmm -lgdi32' -run
 
 W;
 

src/b.rs

@@ -35,6 +35,7 @@ pub mod codegen;
 pub mod lexer;
 pub mod targets;
 pub mod ir;
+pub mod shlex;
 
 use core::ffi::*;
 use core::mem::zeroed;
@@ -49,6 +50,8 @@ use arena::Arena;
 use targets::*;
 use lexer::{Lexer, Loc, Token};
 use ir::*;
+use codegen::*;
+use shlex::*;
 
 pub unsafe fn expect_tokens(l: *mut Lexer, tokens: *const [Token]) -> Option<()> {
     for i in 0..tokens.len() {
@@ -1191,9 +1194,13 @@ pub unsafe fn main(mut argc: i32, mut argv: *mut*mut c_char) -> Option<()> {
     let target_name = flag_str(c!("t"), default_target_name, c!("Compilation target. Pass \"list\" to get the list of available targets."));
     let output_path = flag_str(c!("o"), ptr::null(), c!("Output path"));
     let run         = flag_bool(c!("run"), false, c!("Run the compiled program (if applicable for the target)"));
-    let nobuild  = flag_bool(c!("nobuild"), false, strdup(temp_sprintf(c!("Skip the build step. Useful in conjunction with the -%s flag when you already have a built program and just want to run it on the specified target without rebuilding it."), flag_name(run)))); // memory leak
+    let nobuild  = flag_bool(c!("nobuild"), false, temp_sprintf(c!("Skip the build step. Useful in conjunction with the -%s flag when you already have a built program and just want to run it on the specified target without rebuilding it."), flag_name(run)));
     let help        = flag_bool(c!("help"), false, c!("Print this help message"));
-    let linker      = flag_list(c!("L"), c!("Append a flag to the linker of the target platform"));
+    let codegen_args = flag_list(CODEGEN_FLAG_NAME, temp_sprintf(c!("Pass an argument to the codegen of the current target selected by the -%s flag. Pass argument `-%s help` to learn more about what current codegen provides. All sorts of linker flag parameters are probably there."), flag_name(target_name), CODEGEN_FLAG_NAME));
+    let linker = {
+        let name = c!("L");
+        flag_list(name, temp_sprintf(c!("DEPRECATED! Append a flag to the linker of the target platform. But not every target even has a linker! For backward compatibility we transform `-%s foo -%s bar -%s ...` into `-%s link-args='foo bar ...'` but do not expect every codegen to support that. Use `-%s help` to learn more about what your current codegen supports. Expect this flag to be removed entirely in the future"), name, name, name, CODEGEN_FLAG_NAME, CODEGEN_FLAG_NAME))
+    };
     let nostdlib    = flag_bool(c!("nostdlib"), false, c!("Do not link with standard libraries like libb and/or libc on some platforms"));
     let ir          = flag_bool(c!("ir"), false, c!("Instead of compiling, dump the IR of the program to stdout"));
     let historical  = flag_bool(c!("hist"), false, c!("Makes the compiler strictly follow the description of the B language from the \"Users' Reference to B\" by Ken Thompson as much as possible"));
@@ -1354,12 +1361,23 @@ pub unsafe fn main(mut argc: i32, mut argv: *mut*mut c_char) -> Option<()> {
     // to that object should be computed as `temp_sprintf("%s.o", garbase_base)`.
     let garbage_base = get_garbage_base(program_path, target)?;
 
+    if (*linker).count > 0 {
+        let mut s: Shlex = zeroed();
+        for i in 0..(*linker).count {
+            shlex_append_quoted(&mut s, *(*linker).items.add(i));
+        }
+        let codegen_arg = temp_sprintf(c!("link-args=%s"), shlex_join(&mut s));
+        da_append(codegen_args, codegen_arg);
+        shlex_free(&mut s);
+        log(Log_Level::WARNING, c!("Flag -%s is DEPRECATED! Interpreting it as `-%s %s` instead."), flag_name(linker), CODEGEN_FLAG_NAME, codegen_arg);
+    }
+
     match target {
         Target::Gas_AArch64_Linux => {
             codegen::gas_aarch64::generate_program(
                 // Inputs
                 &c.program, program_path, garbage_base,
-                da_slice(*linker), da_slice(run_args), targets::Os::Linux,
+                da_slice(*codegen_args), da_slice(run_args), targets::Os::Linux,
                 *nostdlib, *debug, *nobuild, *run,
                 // Temporaries
                 &mut output, &mut cmd,
@@ -1369,7 +1387,7 @@ pub unsafe fn main(mut argc: i32, mut argv: *mut*mut c_char) -> Option<()> {
             codegen::gas_aarch64::generate_program(
                 // Inputs
                 &c.program, program_path, garbage_base,
-                da_slice(*linker), da_slice(run_args), targets::Os::Darwin,
+                da_slice(*codegen_args), da_slice(run_args), targets::Os::Darwin,
                 *nostdlib, *debug, *nobuild, *run,
                 // Temporaries
                 &mut output, &mut cmd,
@@ -1379,7 +1397,7 @@ pub unsafe fn main(mut argc: i32, mut argv: *mut*mut c_char) -> Option<()> {
             codegen::gas_x86_64::generate_program(
                 // Inputs
                 &c.program, program_path, garbage_base,
-                da_slice(*linker), da_slice(run_args), targets::Os::Linux,
+                da_slice(*codegen_args), da_slice(run_args), targets::Os::Linux,
                 *nostdlib, *debug, *nobuild, *run,
                 // Temporaries
                 &mut output, &mut cmd,
@@ -1389,7 +1407,7 @@ pub unsafe fn main(mut argc: i32, mut argv: *mut*mut c_char) -> Option<()> {
             codegen::gas_x86_64::generate_program(
                 // Inputs
                 &c.program, program_path, garbage_base,
-                da_slice(*linker), da_slice(run_args), targets::Os::Windows,
+                da_slice(*codegen_args), da_slice(run_args), targets::Os::Windows,
                 *nostdlib, *debug, *nobuild, *run,
                 // Temporaries
                 &mut output, &mut cmd,
@@ -1399,7 +1417,7 @@ pub unsafe fn main(mut argc: i32, mut argv: *mut*mut c_char) -> Option<()> {
             codegen::gas_x86_64::generate_program(
                 // Inputs
                 &c.program, program_path, garbage_base,
-                da_slice(*linker), da_slice(run_args), targets::Os::Darwin,
+                da_slice(*codegen_args), da_slice(run_args), targets::Os::Darwin,
                 *nostdlib, *debug, *nobuild, *run,
                 // Temporaries
                 &mut output, &mut cmd,
@@ -1409,7 +1427,7 @@ pub unsafe fn main(mut argc: i32, mut argv: *mut*mut c_char) -> Option<()> {
             codegen::uxn::generate_program(
                 // Inputs
                 &c.program, program_path, garbage_base,
-                da_slice(*linker), da_slice(run_args),
+                da_slice(*codegen_args), da_slice(run_args),
                 *nostdlib, *debug, *nobuild, *run,
                 // Temporaries
                 &mut output, &mut cmd,
@@ -1419,7 +1437,7 @@ pub unsafe fn main(mut argc: i32, mut argv: *mut*mut c_char) -> Option<()> {
             codegen::mos6502::generate_program(
                 // Inputs
                 &c.program, program_path, garbage_base,
-                da_slice(*linker), da_slice(run_args),
+                da_slice(*codegen_args), da_slice(run_args),
                 *nostdlib, *debug, *nobuild, *run,
                 // Temporaries
                 &mut output, &mut cmd,
@@ -1429,7 +1447,7 @@ pub unsafe fn main(mut argc: i32, mut argv: *mut*mut c_char) -> Option<()> {
             codegen::ilasm_mono::generate_program(
                 // Inputs
                 &c.program, program_path, garbage_base,
-                da_slice(*linker), da_slice(run_args),
+                da_slice(*codegen_args), da_slice(run_args),
                 *nostdlib, *debug, *nobuild, *run,
                 // Temporaries
                 &mut output, &mut cmd,

src/codegen/gas_aarch64.rs

@@ -7,6 +7,8 @@ use crate::ir::*;
 use crate::lexer::*;
 use crate::missingf;
 use crate::targets::Os;
+use crate::codegen::*;
+use crate::shlex::*;
 
 pub unsafe fn align_bytes(bytes: usize, alignment: usize) -> usize {
     let rem = bytes%alignment;
@@ -489,14 +491,46 @@ pub unsafe fn generate_asm_funcs(output: *mut String_Builder, asm_funcs: *const
     }
 }
 
+pub unsafe fn usage(params: *const [Param]) {
+    fprintf(stderr(), c!("gas_aarch64 codegen for the B compiler\n"));
+    fprintf(stderr(), c!("OPTIONS:\n"));
+    print_params_help(params);
+}
+
 pub unsafe fn generate_program(
     // Inputs
     p: *const Program, program_path: *const c_char, garbage_base: *const c_char,
-    linker: *const [*const c_char], run_args: *const [*const c_char], os: Os,
+    codegen_args: *const [*const c_char], run_args: *const [*const c_char], os: Os,
     nostdlib: bool, debug: bool, nobuild: bool, run: bool,
     // Temporaries
     output: *mut String_Builder, cmd: *mut Cmd,
 ) -> Option<()> {
+    let mut help = false;
+    let mut link_args = c!("");
+    let params = &[
+        Param {
+            name:        c!("help"),
+            description: c!("Print this help message"),
+            value:       ParamValue::Flag { var: &mut help },
+        },
+        Param {
+            name:        c!("link-args"),
+            description: c!("Additional linker arguments"),
+            value:       ParamValue::String { var: &mut link_args, default: c!("") },
+        },
+    ];
+
+    if let Err(message) = parse_args(params, codegen_args) {
+        usage(params);
+        log(Log_Level::ERROR, c!("%s"), message);
+        return None;
+    }
+
+    if help {
+        usage(params);
+        return Some(());
+    }
+
     if !nobuild {
         if debug { todo!("Debug information for aarch64") }
 
@@ -538,7 +572,12 @@ pub unsafe fn generate_program(
                 if nostdlib {
                     cmd_append!(cmd, c!("-nostdlib"));
                 }
-                da_append_many(cmd, linker);
+                let mut s: Shlex = zeroed();
+                shlex_init(&mut s, link_args, link_args.add(strlen(link_args)));
+                while !shlex_next(&mut s).is_null() {
+                    da_append(cmd, temp_strdup(s.string));
+                }
+                shlex_free(&mut s);
                 if !cmd_run_sync_and_reset(cmd) { return None; }
             }
             Os::Darwin => {
@@ -565,7 +604,12 @@ pub unsafe fn generate_program(
                         c!("-nostdlib"),
                     }
                 }
-                da_append_many(cmd, linker);
+                let mut s: Shlex = zeroed();
+                shlex_init(&mut s, link_args, link_args.add(strlen(link_args)));
+                while !shlex_next(&mut s).is_null() {
+                    da_append(cmd, temp_strdup(s.string));
+                }
+                shlex_free(&mut s);
                 if !cmd_run_sync_and_reset(cmd) { return None; }
             }
             Os::Windows => todo!(),
@@ -624,4 +668,4 @@ pub unsafe fn generate_program(
         }
     }
     Some(())
-}
+}

src/codegen/gas_x86_64.rs

@@ -1,10 +1,13 @@
 use core::ffi::*;
+use core::mem::zeroed;
 use core::cmp;
 use crate::ir::*;
 use crate::nob::*;
 use crate::targets::Os;
 use crate::crust::libc::*;
 use crate::lexer::Loc;
+use crate::codegen::*;
+use crate::shlex::*;
 
 pub unsafe fn align_bytes(bytes: usize, alignment: usize) -> usize {
     let rem = bytes%alignment;
@@ -366,14 +369,46 @@ pub unsafe fn generate_data_section(output: *mut String_Builder, data: *const [u
     }
 }
 
+pub unsafe fn usage(params: *const [Param]) {
+    fprintf(stderr(), c!("gas_x86_64 codegen for the B compiler\n"));
+    fprintf(stderr(), c!("OPTIONS:\n"));
+    print_params_help(params);
+}
+
 pub unsafe fn generate_program(
     // Inputs
     p: *const Program, program_path: *const c_char, garbage_base: *const c_char,
-    linker: *const [*const c_char], run_args: *const [*const c_char], os: Os,
+    codegen_args: *const [*const c_char], run_args: *const [*const c_char], os: Os,
     nostdlib: bool, debug: bool, nobuild: bool, run: bool,
     // Temporaries
     output: *mut String_Builder, cmd: *mut Cmd,
 ) -> Option<()> {
+    let mut help = false;
+    let mut link_args = c!("");
+    let params = &[
+        Param {
+            name:        c!("help"),
+            description: c!("Print this help message"),
+            value:       ParamValue::Flag { var: &mut help },
+        },
+        Param {
+            name:        c!("link-args"),
+            description: c!("Additional linker arguments"),
+            value:       ParamValue::String { var: &mut link_args, default: c!("") },
+        },
+    ];
+
+    if let Err(message) = parse_args(params, codegen_args) {
+        usage(params);
+        log(Log_Level::ERROR, c!("%s"), message);
+        return None;
+    }
+
+    if help {
+        usage(params);
+        return Some(());
+    }
+
     if !nobuild {
         match os {
             Os::Darwin => sb_appendf(output, c!(".text\n")),
@@ -416,7 +451,12 @@ pub unsafe fn generate_program(
                 if nostdlib {
                     cmd_append!(cmd, c!("-nostdlib"));
                 }
-                da_append_many(cmd, linker);
+                let mut s: Shlex = zeroed();
+                shlex_init(&mut s, link_args, link_args.add(strlen(link_args)));
+                while !shlex_next(&mut s).is_null() {
+                    da_append(cmd, temp_strdup(s.string));
+                }
+                shlex_free(&mut s);
                 if !cmd_run_sync_and_reset(cmd) { return None; }
             }
             Os::Linux => {
@@ -440,7 +480,12 @@ pub unsafe fn generate_program(
                 if nostdlib {
                     cmd_append!(cmd, c!("-nostdlib"));
                 }
-                da_append_many(cmd, linker);
+                let mut s: Shlex = zeroed();
+                shlex_init(&mut s, link_args, link_args.add(strlen(link_args)));
+                while !shlex_next(&mut s).is_null() {
+                    da_append(cmd, temp_strdup(s.string));
+                }
+                shlex_free(&mut s);
                 if !cmd_run_sync_and_reset(cmd) { return None; }
             }
             Os::Windows => {
@@ -458,7 +503,12 @@ pub unsafe fn generate_program(
                 if nostdlib {
                     cmd_append!(cmd, c!("-nostdlib"));
                 }
-                da_append_many(cmd, linker);
+                let mut s: Shlex = zeroed();
+                shlex_init(&mut s, link_args, link_args.add(strlen(link_args)));
+                while !shlex_next(&mut s).is_null() {
+                    da_append(cmd, temp_strdup(s.string));
+                }
+                shlex_free(&mut s);
                 if !cmd_run_sync_and_reset(cmd) { return None; }
             }
         }
@@ -514,4 +564,4 @@ pub unsafe fn generate_program(
     }
 
     Some(())
-}
+}