added -h and --help flags

Author: wgibbs-rs

CMakeLists.txt

@@ -1,10 +1,11 @@
 cmake_minimum_required(VERSION 3.10)
-project(blang C CXX)
+project(blang VERSION 0.1.0 LANGUAGES C CXX)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_C_STANDARD_REQUIRED ON)
 
+
 set(CMAKE_BUILD_TYPE Debug)
 
 if (APPLE)
@@ -13,7 +14,6 @@ if (APPLE)
     list(APPEND CMAKE_PREFIX_PATH "/opt/homebrew/opt/llvm")
 endif()
 
-
 find_package(FLEX REQUIRED)
 find_package(BISON REQUIRED)
 find_package(LLVM REQUIRED CONFIG)
@@ -69,6 +69,13 @@ add_executable(blang
     ${BISON_Parser_OUTPUTS}
 )
 
+target_compile_definitions(blang PRIVATE
+    BLANG_VERSION_MAJOR=${PROJECT_VERSION_MAJOR}
+    BLANG_VERSION_MINOR=${PROJECT_VERSION_MINOR}
+    BLANG_VERSION_PATCH=${PROJECT_VERSION_PATCH}
+    BLANG_VERSION_STRING="${PROJECT_VERSION}"
+)
+
 # Now target-specific commands
 target_include_directories(blang PRIVATE ${LLVM_INCLUDE_DIRS})
 target_include_directories(blang PRIVATE src ${CMAKE_CURRENT_BINARY_DIR})

src/binary.cpp

@@ -46,9 +46,6 @@
 
 #include <llvm/TargetParser/Host.h>
 
-// Optimize TheModule with the provided optimization flags (-O3, -Os, etc)
-void optimize();
-
 extern "C" void initialize_llvm() {
    TheContext = std::make_unique<llvm::LLVMContext>();
    Builder = std::unique_ptr<llvm::IRBuilder<>>(new llvm::IRBuilder<>(*TheContext));
@@ -69,8 +66,6 @@ extern "C" void initialize_llvm() {
 }
 
 extern "C" void export_asm() {
-   optimize(); // Apply any optimizations (will return if -O0)
-
    std::basic_string<char> targetTriple = llvm::sys::getDefaultTargetTriple();
    TheModule->setTargetTriple(targetTriple);
 
@@ -117,8 +112,6 @@ extern "C" void export_asm() {
 }
 
 extern "C" void export_ir() {
-   optimize(); // Apply any optimizations (will return if -O0)
-
    std::error_code EC;
    llvm::raw_fd_ostream dest("output.ll", EC, llvm::sys::fs::OF_None);
 
@@ -129,8 +122,6 @@ extern "C" void export_ir() {
 }
 
 extern "C" void generate_binary() {
-   optimize(); // Apply any optimizations (will return if -O0)
-
    std::basic_string<char> targetTriple = llvm::sys::getDefaultTargetTriple();
    TheModule->setTargetTriple(targetTriple);
 
@@ -176,7 +167,7 @@ extern "C" void generate_binary() {
    dest.flush();
 }
 
-inline void optimize() {
+extern "C" void optimize() {
    if (GCC_LIKELY(!ctx.optimization)) return;
 
    // Create analysis managers

src/context.h

@@ -30,6 +30,7 @@ extern "C" {
 typedef struct CompilerContext {
    bool emitAssembly;
    bool emitLLVM;
+   bool dumpAST;
    char* outputFilename;
    char* inputFile;
    char* sourceText;

src/error.c

@@ -31,7 +31,7 @@
 GCC_COLD void error(const char *text, ...) {
    va_list args;
    va_start(args, text);
-   printf("bcc: " RED "error: " RESET);
+   printf("blang: " RED "error: " RESET);
    vprintf(text, args);
    printf("\n");
    va_end(args);
@@ -40,9 +40,9 @@ GCC_COLD void error(const char *text, ...) {
 GCC_NORETURN GCC_COLD void fatal_error(const char *text, ...) {
    va_list args;
    va_start(args, text);
-   printf("bcc: " RED "error: " RESET);
+   printf("blang: " RED "error: " RESET);
    vprintf(text, args);
    va_end(args);
-   printf("\nbcc: " RED "error: " RESET "compilation failed\n");
+   printf("\nblang: " RED "error: " RESET "compilation failed\n");
    exit(EXIT_FAILURE);
 }

src/llvm.h

@@ -39,9 +39,11 @@ extern "C" {
 
 void generate_llvm_ir();
 void initialize_llvm();
+
 void generate_binary();
 void export_ir();
 void export_asm();
+void optimize();
 
 #ifdef __cplusplus
 }

src/llvm_ir.cpp

@@ -301,18 +301,16 @@ static void add_function(ASTNode* node) {
    // Create the function type, including arguments if any.
    llvm::FunctionType *funcType;
    if (list.size() == 0 ) 
-   {
       funcType = llvm::FunctionType::get(
          llvm::Type::getInt64Ty(*TheContext),
          false
       );
-   } else {
+   else 
       funcType = llvm::FunctionType::get(
          llvm::Type::getInt64Ty(*TheContext),
          list,
          false
       );
-   }
 
    llvm::Function *function = llvm::Function::Create(
       funcType,

src/main.c

@@ -34,25 +34,30 @@ extern int yyparse(void);                       // declare Bison parser function
 extern int yy_scan_string(const char *str);     // lex the file for keywords
 void parse_arguments(int argc, char **argv);    // parse the arguments provided to BLang
 char* read_file(const char *filename);          // Read an input file into a char*.
+void print_help();
 
 CompilerContext ctx = (CompilerContext){
    .emitAssembly = false,
    .emitLLVM = false,
+   .dumpAST = false,
    .outputFilename = "a.out",
    .optimization = 0,
 };
 
 int main(int argc, char *argv[]) {
    parse_arguments(argc, argv);
-   initialize_llvm();
 
    yy_scan_string(ctx.sourceText);           // Feed input
    yyparse();                                // Start parsing
 
-   print_ast();
+   if (ctx.dumpAST) print_ast();
+
+   initialize_llvm();
 
    generate_llvm_ir();
 
+   optimize();
+
    if (ctx.emitLLVM) 
       export_ir();
    else if (ctx.emitAssembly) 
@@ -65,15 +70,15 @@ int main(int argc, char *argv[]) {
 
 
 void parse_arguments(int argc, char *argv[]) {
-   if (argc == 0)
-      printf("--help function should print here. TODO.");
+   if (argc == 1)
+      print_help();
 
    for (int i = 1; i < argc; ++i) {
-      // If "-S" is passed, the program will return assembly instead of machine code.
       if (strcmp(argv[i], "-S") == 0) { ctx.emitAssembly = true; }
-
-      // If "-emit-llvm" is passed, the program will return LLVM IR instead of machine code.
-      else if (strcmp(argv[i], "--emit-llvm") == 0) { ctx.emitLLVM = true; }
+      else if (strcmp(argv[i], "-emit-llvm") == 0) { ctx.emitLLVM = true; }
+      else if (strcmp(argv[i], "-ast-dump") == 0) { ctx.dumpAST = true; }
+      
+      else if (strcmp(argv[i], "-h") == 0 || strcmp(argv[i], "--help") == 0) { print_help(); }
 
       else if (strcmp(argv[i], "-o") == 0) {
          ctx.outputFilename = argv[i + 1];
@@ -94,7 +99,7 @@ void parse_arguments(int argc, char *argv[]) {
          ctx.optimization = 5;
 
       else { 
-         if (argv[i][0] == '-') { fatal_error("unknown argument: \'%s\'\n", argv[i]); }
+         if (argv[i][0] == '-') { fatal_error("unknown argument: \'%s\'", argv[i]); }
          else { 
             ctx.inputFile = argv[i];
             ctx.sourceText = read_file(argv[i]); 
@@ -119,3 +124,27 @@ char* read_file(const char *filename) {
    fclose(f);
    return buf;
 }
+
+void print_help() {
+    printf(
+      "Usage: blang [options] <source files>\n"
+      "\n"
+      "Blang Compiler " BLANG_VERSION_STRING "\n"
+      "A simple compiler for the B programming language.\n"
+      "\n"
+      "Options:\n"
+      "  -h, --help            Show this help message and exit\n"
+      // "  -v, --version         Show compiler version\n"
+      "  -o <file>             Specify output file name (default: a.out)\n"
+      "  -S                    Compile to assembly code only\n"
+      "  -emit-llvm           Emit LLVM IR instead of machine code\n"
+      "  -dump-ast            Output the abstract syntax tree (AST)\n"
+      "  -O0, -O1, -O2, -O3    Optimization level (default: -O0)\n"
+      "\n"
+      "Examples:\n"
+      "  blang main.b            Compile and link main.b to a.out\n"
+      "  blang -S main.b         Generate assembly code from main.b\n"
+      "  blang -O2 -o prog main.b  Compile main.b with optimization level 2 to prog\n"
+    );
+    exit(0);
+}