mild refactoring, clean up windows properly upon exit

Reviewed-on: #2

.gitignore

@@ -1 +1,5 @@
 bbs
+build/
+
+# Machine generated files:
+src/version.c

Makefile

@@ -1,17 +1,46 @@
 # SPDX-License-Identifier: MIT
 
-CC=gcc
-CFLAGS=-std=c99 -pedantic -Wall -Wextra -O2 -ggdb
-LIBS=-lncursesw
-EXECUTABLE=bbs
+# Makefile for Amber's BBS Interface
+# Buildsys by Gale Faraday
 
-# .PHONY: all
-# all: make
+# `generate` must be called before `all` to build version information and other
+# machine generated files.
 
-make: bbs
+.PHONY: all clean run generate
+.SUFFIXES:
 
-bbs: bbs.c home.c home.h globals.h
-	$(CC) $(CFLAGS) $(LIBS) bbs.c home.c -o $(EXECUTABLE)
+.DEFAULT_GOAL := all
 
-run: bbs
+TARGET     := $(shell basename $(CURDIR))
+SOURCES    := src/
+BUILD      := build/
+GENABLES   := $(SOURCES)version.c
+OBJS       := $(patsubst $(SOURCES)%.c,$(BUILD)%.o,$(wildcard $(SOURCES)*.c))
+EXECUTABLE := $(TARGET)
+
+
+CC      := gcc
+LD      := gcc
+CFLAGS  := -std=c99 -pedantic -Wall -Wextra -Wno-unused-parameter -O2 -ggdb
+LDFLAGS := $(CFLAGS) -lncurses
+
+all: $(EXECUTABLE)
+
+run: $(EXECUTABLE)
 	./$(EXECUTABLE)
+
+.IGNORE: clean
+clean:
+	@rm -rvf $(BUILD) $(EXECUTABLE) $(GENABLES)
+
+generate: $(GENABLES)
+
+$(GENABLES): genver.sh
+	./genver.sh
+
+$(EXECUTABLE): $(OBJS)
+	$(LD) $(LDFLAGS) -o $@ $^
+
+$(OBJS): $(BUILD)%.o : $(SOURCES)%.c
+	-@mkdir -p $(BUILD)
+	$(CC) $(CFLAGS) -o $@ -c $<

README.md

@@ -4,13 +4,11 @@ This is a simple bbs program written in c. The way it is meant to work is that a
 
 ## Building
 
-The only dependency is `ncurses`. The makefile asks for `-lncursesw` but unicode is not yet used, so `-lncurses` should be fine. `ncurses` is almost guaranteed preinstalled on your system.
+`bbs` depends only upon `ncurses`. 
 
-The program is standardized on c99. It should run fine on c89, but there will be warnings. You'll have to edit the makefile to request c89 from `gcc`.
+Run `make generate` to generate `version.c`, then `make` to build. Build files will be in `build/` and the executable `bbs` will be in the root of the repo. 
 
-To build, run `make`. It will drop an executable named `bbs` in the current folder.
-
-The makefile has the additional command `make run`, which just launches the program after compilation.
+`make run` will build and run the program, and `make clean` will clean up the `build/` directory.
 
 ## License
 

bbs.c

@@ -1,126 +0,0 @@
-/* SPDX-License-Identifier: MIT */
-
-#include <curses.h>
-#include <string.h>
-#include <locale.h>
-
-#include "globals.h"
-#include "home.h"
-
-const unsigned int GETCH_TIMEOUT = 10; /* in ms */
-const char* LOCALE = "en_US.UTF-8";    /* enable unicode support, set to "ANSI_X3.4-1968" for ascii */
-
-char error_message[MAX_ERROR_MESSAGE_SIZE];
-
-static void draw_error(struct Screen *screen, __attribute__((unused)) char *input)  {
-    mvwprintw(screen->win, 1, 2, "%s", error_message);
-}
-
-static void draw_screen (struct Screen *screen, char *input) {
-    screen->draw_screen(screen, input);
-    box(screen->win, 0, 0);
-    /* wattron(screen->win, A_STANDOUT); */
-    mvwprintw(screen->win, 0, 1, " %s ", screen->name);
-    /* wattroff(screen->win, A_STANDOUT); */
-}
-
-int main() {
-
-    initscr();                   /* start ncurses */
-    noecho();                    /* hide keyboard input */
-    curs_set(0);                 /* disable cursor */
-    timeout(GETCH_TIMEOUT);      /* set timeout for getch() */
-    setlocale(LC_CTYPE, LOCALE); /* set locale, UTF8 support is enabled here */
-
-    unsigned int terminal_width;
-    unsigned int terminal_height;
-    unsigned int old_terminal_width = 0;
-    unsigned int old_terminal_height = 0;
-
-    enum Status status = STATUS_NEED_REFRESH; /* refresh screens[active_screen].window on first loop */
-    char input = ' ';
-
-    strcpy(error_message, "");
-
-    getmaxyx(stdscr, terminal_height, terminal_width);
-
-    unsigned int screen_before_error = HOME;
-
-    enum ActiveScreen active_screen = HOME;
-
-    struct Screen screens[] = {
-        {
-            "home",
-            newwin(terminal_height, terminal_width, 0, 0),
-            draw_home
-        },
-        {
-            "error",
-            newwin(terminal_height, terminal_width, 0, 0),
-            draw_error
-        }
-    };
-
-    // struct Screen home = {
-    //     "home",
-    //     newwin(terminal_height, terminal_width, start_y, start_x),
-    //     draw_home
-    // };
-    // screens[HOME] = home;
-    // struct Screen error = {
-    //     "error",
-    //     newwin(terminal_height, terminal_width, start_y, start_x),
-    //     draw_error
-    // };
-    // screens[ERROR] = error;
-
-    /* main event loop */
-    while (status != STATUS_QUIT) {
-        if ((input = getch())) { /* if any input was read */
-            /* TODO: factor out input to another function */
-            if (input == 'q') {
-                status = STATUS_QUIT;
-            } else {
-                status = STATUS_NEED_REFRESH;
-            };
-        };
-        getmaxyx(stdscr, terminal_height, terminal_width);
-
-        /* resize active screen's window */
-        if (old_terminal_width != terminal_width || old_terminal_height != terminal_height) {
-            wclear(screens[active_screen].win);
-            wresize(screens[active_screen].win, terminal_height, terminal_width);
-            mvwin(screens[active_screen].win, 0, 0);
-            wrefresh(screens[active_screen].win);
-            old_terminal_width = terminal_width;
-            old_terminal_height = terminal_height;
-
-            if (terminal_width < 80 || terminal_height < 24) {
-                if (active_screen != ERROR) {
-                    strcpy(error_message, "This program expects at least 80 rows by 24 columns.");
-                    screen_before_error = active_screen;
-                };
-                active_screen = ERROR;
-            } else if (active_screen != screen_before_error) {
-                active_screen = screen_before_error;
-            };
-            status = STATUS_NEED_REFRESH;
-        };
-
-        /* refresh active screen's window */
-        if (status == STATUS_NEED_REFRESH) {
-            draw_screen(&screens[active_screen], &input);
-            wrefresh(screens[active_screen].win);
-            status = STATUS_WAITING;
-        }
-
-    };
-
-    /* clean up */
-    delwin(screens[active_screen].win); /* TODO: delete all windows in screens[] */
-    nocbreak();
-    endwin();   /* ends curses mode */
-    curs_set(1);
-    echo();
-    return 0;
-}

genver.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+# Script to generate version information file
+
+# Current git hash
+HASH="$(git describe --always --dirty)"
+
+# Current git tag
+TAG="$(git describe --always --dirty --tags)"
+
+# Output filename
+OUTFILE='src/version.c'
+
+sed -e "s/<HASH>/$HASH/g" -e "s/<TAG>/$TAG/g" <<EOF > "$OUTFILE"
+/* Build version information. This file generated by genver.sh */
+
+const char GIT_HASH[] = "<HASH>";
+const char GIT_TAG[] = "<TAG>";
+const char CC_VERSION[] = __VERSION__;
+const char BUILD_DATE[] = __DATE__;
+EOF

src/bbs.c

@@ -0,0 +1,101 @@
+/* SPDX-License-Identifier: MIT */
+
+#include <curses.h>
+#include <string.h>
+#include <locale.h>
+#include "globals.h"
+#include "screens.h"
+
+char error_message[MAX_ERROR_MESSAGE_SIZE];
+
+unsigned int terminal_width;
+unsigned int terminal_height;
+unsigned int old_terminal_width = 0;
+unsigned int old_terminal_height = 0;
+
+enum Status status = STATUS_NEED_REFRESH; /* refresh screens[active_screen].window on first loop */
+char input = ' ';
+
+unsigned int screen_before_error = HOME;
+enum ActiveScreen active_screen = HOME;
+
+static void draw_screen (struct Screen *screen, char *input) {
+    screen->draw_screen(screen, input);
+    wattron(screen->win, A_STANDOUT);
+    mvwprintw(screen->win, 0, 1, " %s ", screen->name);
+    wattroff(screen->win, A_STANDOUT);
+}
+
+static void resize_active_screen() {
+    wclear(screens[active_screen].win);
+    wresize(screens[active_screen].win, terminal_height, terminal_width);
+    mvwin(screens[active_screen].win, 0, 0);
+    wrefresh(screens[active_screen].win);
+    old_terminal_width = terminal_width;
+    old_terminal_height = terminal_height;
+
+    if (terminal_width < 80 || terminal_height < 24) {
+        if (active_screen != ERROR) {
+            strcpy(error_message, "This program expects at least 80 rows by 24 columns.");
+            screen_before_error = active_screen;
+        };
+        active_screen = ERROR;
+    } else if (active_screen != screen_before_error) {
+        active_screen = screen_before_error;
+    };
+    status = STATUS_NEED_REFRESH;
+}
+
+int main() {
+
+    initscr();                   /* start ncurses */
+    noecho();                    /* hide keyboard input */
+    curs_set(0);                 /* disable cursor */
+    keypad(stdscr, TRUE);        /* enable extra keys */
+    timeout(GETCH_TIMEOUT);      /* set timeout for getch() */
+    setlocale(LC_CTYPE, "");     /* set locale to current locale */
+
+    strcpy(error_message, "");
+
+    getmaxyx(stdscr, terminal_height, terminal_width);
+
+
+
+    /* could be it's own init func within the screen's file. */
+    screens[HOME].win = newwin(terminal_height, terminal_width, 0, 0);
+    screens[ERROR].win = newwin(terminal_height, terminal_width, 0, 0);
+
+    /* main event loop */
+    while (status != STATUS_QUIT) {
+        if ((input = getch())) { /* if any input was read */
+            /* TODO: factor out input to another function */
+            if (input == 'q') {
+                status = STATUS_QUIT;
+            } else {
+                status = STATUS_NEED_REFRESH;
+            };
+        };
+
+        getmaxyx(stdscr, terminal_height, terminal_width);
+        if (old_terminal_width != terminal_width || old_terminal_height != terminal_height) {
+            resize_active_screen();
+        };
+
+        /* refresh active screen's window */
+        if (status == STATUS_NEED_REFRESH) {
+            draw_screen(&screens[active_screen], &input);
+            wrefresh(screens[active_screen].win);
+            status = STATUS_WAITING;
+        }
+
+    };
+
+    /* clean up */
+    delwin(screens[0].win); /* could be in a destructor function in the screen's file */
+    delwin(screens[1].win);
+    nocbreak();
+    endwin();   /* ends curses mode */
+    curs_set(1);
+    echo();
+    return 0;
+}

src/error.c

@@ -0,0 +1,10 @@
+/* SPDX-License-Identifier: MIT */
+
+#include <curses.h>
+#include "screens.h"
+
+/* char *input is unused */
+void draw_error(struct Screen *screen, char *input) {
+    box(screen->win, 0, 0);
+    mvwprintw(screen->win, 1, 2, "%s", error_message);
+}

src/error.h

@@ -0,0 +1,10 @@
+/* SPDX-License-Identifier: MIT */
+
+#ifndef ERROR_H /* header guard */
+#define ERROR_H
+
+#include "screens.h"
+
+void draw_error(struct Screen *screen, char *input);
+
+#endif

src/globals.h

@@ -1,11 +1,22 @@
 /* SPDX-License-Identifier: MIT */
 
-#define MAX_ERROR_MESSAGE_SIZE 60 /* size of error_message array */
+#define GETCH_TIMEOUT 10          /* in ms */
 #define MAX_SCREEN_NAME_SIZE 20   /* size of the screen name array */
+#define MAX_ERROR_MESSAGE_SIZE 60 /* size of error_message array */
 
 #ifndef GLOBALS_H /* header guard */
 #define GLOBALS_H
 
+#include <curses.h>
+
+extern char error_message[];
+
+struct Screen {
+    char name[MAX_SCREEN_NAME_SIZE];
+    WINDOW *win;
+    void (*draw_screen)(struct Screen *, char *input); /* GETCH_TIMEOUT determines how often this is run, in ms */
+};
+
 enum Status {
     STATUS_QUIT,
     STATUS_WAITING,
@@ -17,14 +28,4 @@ enum ActiveScreen {
     ERROR
 };
 
-struct Screen {
-    char name[MAX_SCREEN_NAME_SIZE];
-    WINDOW *win;
-    void (*draw_screen)(struct Screen *, char *input); /* GETCH_TIMEOUT determines how often this is run, in ms */
-};
-
-/* TODO: put this in a screens.c file and include all screens there, that way the array can be initialized at compile
- * time */
-extern struct Screen screens[];
-
 #endif

src/home.c

@@ -1,7 +1,8 @@
 /* SPDX-License-Identifier: MIT */
 
 #include <curses.h>
-#include "globals.h"
+#include "screens.h"
+#include "version.h"
 
 void draw_home(struct Screen *screen, char *input)  {
     static char* banner = ""
@@ -13,8 +14,13 @@ void draw_home(struct Screen *screen, char *input)  {
     "  \\__,_|_| |_| |_|_.__/ \\___|_|  |___/ .__/|_|\\__,_|\\___\\___(_)_| |_|\\___|\\__|\n"
     "                                     | |                                      \n"
     "                                     |_|                                      \n";
-
     mvwprintw(screen->win, 1, 2, "Thank you for visiting:");
     mvwprintw(screen->win, 2, 1, "%s", banner);
     mvwprintw(screen->win, 10, 1, "Your current input is: %s", input);
+    wclrtoeol(screen->win); /* clear rest of line to prevent longer inputs from sticking around */
+    mvwprintw(screen->win, 11, 1, "Git hash: %s", GIT_HASH);
+    mvwprintw(screen->win, 12, 1, "Git tag: %s", GIT_TAG);
+    mvwprintw(screen->win, 13, 1, "CC version: %s", CC_VERSION);
+    mvwprintw(screen->win, 14, 1, "Build date: %s", BUILD_DATE);
+    box(screen->win, 0, 0);
 }

src/home.h

@@ -3,7 +3,7 @@
 #ifndef HOME_H /* header guard */
 #define HOME_H
 
-#include "globals.h"
+#include "screens.h"
 
 void draw_home(struct Screen *screen, char *input);
 

src/screens.c

@@ -0,0 +1,19 @@
+/* SPDX-License-Identifier: MIT */
+
+#include "globals.h"
+#include "home.h"
+#include "error.h"
+
+/* NOTE: this should be compile time */
+struct Screen screens[] = {
+    {
+        "home",
+        NULL,
+        draw_home
+    },
+    {
+        "error",
+        NULL,
+        draw_error
+    }
+};

src/screens.h

@@ -0,0 +1,10 @@
+/* SPDX-License-Identifier: MIT */
+
+#ifndef SCREENS_H /* header guard */
+#define SCREENS_H
+
+#include "globals.h"
+
+extern struct Screen screens[];
+
+#endif

src/version.h

@@ -0,0 +1,6 @@
+/* Header for version information constants */
+
+extern const char GIT_HASH[];
+extern const char GIT_TAG[];
+extern const char CC_VERSION[];
+extern const char BUILD_DATE[];