Rename lib files to and prefix lib function names

khatus_lib --> khlib
foo        --> khlib_foo

diff --git a/x5/Makefile b/x5/Makefile
index e1c4287..d8fcc23 100644 (file)
--- a/x5/Makefile
+++ b/x5/Makefile
@@ -10,18 +10,18 @@ build: \
     khatus_sensor_time
 
 khatus: \
-       khatus_lib_log.o \
-       khatus_lib_time.o
+       khlib_log.o \
+       khlib_time.o
 
 khatus_sensor_battery: \
-       khatus_lib_log.o \
-       khatus_lib_time.o
+       khlib_log.o \
+       khlib_time.o
 
 khatus_sensor_time: \
-       khatus_lib_log.o \
-       khatus_lib_time.o
+       khlib_log.o \
+       khlib_time.o
 
-khatus_lib_time.o: khatus_lib_log.o
+khlib_time.o: khlib_log.o
 
 clean:
        @find . -type f -executable -delete

diff --git a/x5/khatus.c b/x5/khatus.c
index 4dd42da..5ba94d3 100644 (file)
--- a/x5/khatus.c
+++ b/x5/khatus.c
@@ -14,8 +14,8 @@
 #include <X11/Xlib.h>
 
 #include "bsdtimespec.h"
-#include "khatus_lib_log.h"
-#include "khatus_lib_time.h"
+#include "khlib_log.h"
+#include "khlib_time.h"
 
 #define usage(...) { \
        print_usage(); \
@@ -63,7 +63,7 @@ enum read_status {
 void
 fifo_print_one(Fifo *f)
 {
-       info("Fifo "
+       khlib_info("Fifo "
            "{"
            " name = %s,"
            " fd = %d,"
@@ -100,7 +100,7 @@ fifo_print_all(Fifo *head)
 void
 config_print(Config *cfg)
 {
-       info(
+       khlib_info(
            "Config "
            "{"
            " interval = %f,"
@@ -220,7 +220,7 @@ parse_opts_opt_l(Config *cfg, int argc, char *argv[], int i)
                    log_level,
                    Debug
                );
-       _khatus_lib_log_level = log_level;
+       _khlib_log_level = log_level;
        opts_parse_any(cfg, argc, argv, i);
 }
 
@@ -275,7 +275,7 @@ parse_opts_spec(Config *cfg, int argc, char *argv[], int i)
                f->name      = n;
                f->fd        = -1;
                f->width     = atoi(w);
-               f->ttl       = timespec_of_float(atof(t));
+               f->ttl       = khlib_timespec_of_float(atof(t));
                f->last_read = last_read;
                f->pos_init  = cfg->total_width;
                f->pos_curr  = f->pos_init;
@@ -286,7 +286,7 @@ parse_opts_spec(Config *cfg, int argc, char *argv[], int i)
                cfg->total_width += f->width;
                cfg->fifo_count++;
        } else {
-               fatal("[memory] Allocation failure.");
+               khlib_fatal("[memory] Allocation failure.");
        }
        opts_parse_any(cfg, argc, argv, i);
 }
@@ -329,7 +329,7 @@ fifo_expire(Fifo *f, struct timespec t, char *buf)
        if (timespeccmp(&td, &(f->ttl), >=)) {
                /* TODO: Maybe configurable expiry character. */
                memset(buf + f->pos_init, '_', f->pos_final - f->pos_init);
-               warn("Data source expired: \"%s\"\n", f->name);
+               khlib_warn("Data source expired: \"%s\"\n", f->name);
        }
 }
 
@@ -358,8 +358,10 @@ fifo_read_one(Fifo *f, struct timespec t, char *buf)
        for (;;) {
                switch (read(f->fd, &c, 1)) {
                case -1:
-                       error("Failed to read: \"%s\". errno: %d, msg: %s\n",
-                           f->name, errno, strerror(errno));
+                       khlib_error(
+                           "Failed to read: \"%s\". errno: %d, msg: %s\n",
+                           f->name, errno, strerror(errno)
+                       );
                        switch (errno) {
                        case EINTR:
                        case EAGAIN:
@@ -368,7 +370,7 @@ fifo_read_one(Fifo *f, struct timespec t, char *buf)
                                return FAILURE;
                        }
                case  0:
-                       debug("%s: End of FILE\n", f->name);
+                       khlib_debug("%s: End of FILE\n", f->name);
                        f->pos_curr = f->pos_init;
                        return END_OF_FILE;
                case  1:
@@ -410,7 +412,7 @@ fifo_read_all(Config *cfg, struct timespec *ti, char *buf)
        for (Fifo *f = cfg->fifos; f; f = f->next) {
                /* TODO: Create the FIFO if it doesn't already exist. */
                if (lstat(f->name, &st) < 0) {
-                       error(
+                       khlib_error(
                            "Cannot stat \"%s\". Error: %s\n",
                            f->name,
                            strerror(errno)
@@ -419,48 +421,64 @@ fifo_read_all(Config *cfg, struct timespec *ti, char *buf)
                        continue;
                }
                if (!(st.st_mode & S_IFIFO)) {
-                       error("\"%s\" is not a FIFO\n", f->name);
+                       khlib_error("\"%s\" is not a FIFO\n", f->name);
                        fifo_read_error(f, buf);
                        continue;
                }
                if (f->fd < 0) {
-                       debug("%s: closed. opening. fd: %d\n", f->name, f->fd);
+                       khlib_debug(
+                           "%s: closed. opening. fd: %d\n",
+                           f->name,
+                           f->fd
+                       );
                        f->fd = open(f->name, O_RDONLY | O_NONBLOCK);
                } else {
-                       debug("%s: already openned. fd: %d\n", f->name, f->fd);
+                       khlib_debug(
+                           "%s: already openned. fd: %d\n",
+                           f->name,
+                           f->fd
+                       );
                }
                if (f->fd == -1) {
                        /* TODO Consider backing off retries for failed fifos */
-                       error("Failed to open \"%s\"\n", f->name);
+                       khlib_error("Failed to open \"%s\"\n", f->name);
                        fifo_read_error(f, buf);
                        continue;
                }
-               debug("%s: open. fd: %d\n", f->name, f->fd);
+               khlib_debug("%s: open. fd: %d\n", f->name, f->fd);
                if (f->fd > maxfd)
                        maxfd = f->fd;
                FD_SET(f->fd, &fds);
        }
-       debug("selecting...\n");
+       khlib_debug("selecting...\n");
        ready = pselect(maxfd + 1, &fds, NULL, NULL, ti, NULL);
-       debug("ready: %d\n", ready);
+       khlib_debug("ready: %d\n", ready);
        clock_gettime(CLOCK_MONOTONIC, &t);
        if (ready == -1) {
                switch (errno) {
                case EINTR:
-                       error("pselect temp failure: %d, errno: %d, msg: %s\n",
-                           ready, errno, strerror(errno));
+                       khlib_error(
+                           "pselect temp failure: %d, errno: %d, msg: %s\n",
+                           ready,
+                           errno,
+                           strerror(errno)
+                       );
                        /* TODO: Reconsider what to do here. */
                        return;
                default:
-                       fatal("pselect failed: %d, errno: %d, msg: %s\n",
-                           ready, errno, strerror(errno));
+                       khlib_fatal(
+                           "pselect failed: %d, errno: %d, msg: %s\n",
+                           ready,
+                           errno,
+                           strerror(errno)
+                       );
                }
        }
        /* At-least-once ensures that expiries are still checked on timeouts. */
        do {
                for (Fifo *f = cfg->fifos; f; f = f->next) {
                        if (FD_ISSET(f->fd, &fds)) {
-                               debug("reading: %s\n", f->name);
+                               khlib_debug("reading: %s\n", f->name);
                                switch (fifo_read_one(f, t, buf)) {
                                /*
                                 * ### MESSAGE LOSS ###
@@ -526,10 +544,10 @@ main(int argc, char *argv[])
        argv0 = argv[0];
 
        opts_parse(&cfg, argc, argv);
-       debug("argv0 = %s\n", argv0);
+       khlib_debug("argv0 = %s\n", argv0);
        config_print(&cfg);
 
-       ti = timespec_of_float(cfg.interval);
+       ti = khlib_timespec_of_float(cfg.interval);
 
        if (cfg.fifos == NULL)
                usage("No fifo specs were given!\n");
@@ -537,7 +555,7 @@ main(int argc, char *argv[])
        /* 1st pass to check file existence and type */
        for (Fifo *f = cfg.fifos; f; f = f->next) {
                if (lstat(f->name, &st) < 0) {
-                       error(
+                       khlib_error(
                            "Cannot stat \"%s\". Error: %s\n",
                            f->name,
                            strerror(errno)
@@ -546,13 +564,15 @@ main(int argc, char *argv[])
                        continue;
                }
                if (!(st.st_mode & S_IFIFO)) {
-                       error("\"%s\" is not a FIFO\n", f->name);
+                       khlib_error("\"%s\" is not a FIFO\n", f->name);
                        errors++;
                        continue;
                }
        }
        if (errors)
-               fatal("Encountered errors with given file paths. See log.\n");
+               khlib_fatal(
+                   "Encountered errors with given file paths. See log.\n"
+               );
 
        width  = cfg.total_width;
        seplen = strlen(cfg.separator);
@@ -568,7 +588,10 @@ main(int argc, char *argv[])
        width += (seplen * (nfifos - 1));
        buf = calloc(1, width + 1);
        if (buf == NULL)
-               fatal("[memory] Failed to allocate buffer of %d bytes", width);
+               khlib_fatal(
+                   "[memory] Failed to allocate buffer of %d bytes",
+                   width
+               );
        memset(buf, ' ', width);
        buf[width] = '\0';
        /* 3rd pass to set the separators */
@@ -584,14 +607,14 @@ main(int argc, char *argv[])
        }
 
        if (cfg.output_to_x_root_window && !(d = XOpenDisplay(NULL)))
-               fatal("XOpenDisplay failed with: %p\n", d);
+               khlib_fatal("XOpenDisplay failed with: %p\n", d);
        /* TODO: Handle signals */
        for (;;) {
                clock_gettime(CLOCK_MONOTONIC, &t0); // FIXME: check errors
                fifo_read_all(&cfg, &ti, buf);
                if (cfg.output_to_x_root_window) {
                        if (XStoreName(d, DefaultRootWindow(d), buf) < 0)
-                               fatal("XStoreName failed.\n");
+                               khlib_fatal("XStoreName failed.\n");
                        XFlush(d);
                } else {
                        puts(buf);
@@ -599,7 +622,7 @@ main(int argc, char *argv[])
                }
                clock_gettime(CLOCK_MONOTONIC, &t1); // FIXME: check errors
                timespecsub(&t1, &t0, &td);
-               debug(
+               khlib_debug(
                    "td {tv_sec = %ld, tv_nsec = %ld}\n",
                    td.tv_sec,
                    td.tv_nsec
@@ -609,10 +632,10 @@ main(int argc, char *argv[])
                         * pipe more frequently than the interval.
                         */
                        timespecsub(&ti, &td, &tc);
-                       debug("snooze YES\n");
-                       snooze(&tc);
+                       khlib_debug("khlib_sleep YES\n");
+                       khlib_sleep(&tc);
                } else {
-                       debug("snooze NO\n");
+                       khlib_debug("khlib_sleep NO\n");
                }
        }
 

diff --git a/x5/khatus_lib_log.c b/x5/khatus_lib_log.c
deleted file mode 100644 (file)
index ce172e4..0000000
--- a/x5/khatus_lib_log.c
+++ /dev/null
@@ -1,7 +0,0 @@
-#include <stdarg.h>
-#include <stdio.h>
-#include <stdlib.h>
-
-#include "khatus_lib_log.h"
-
-LogLevel _khatus_lib_log_level = Debug;

diff --git a/x5/khatus_lib_log.h b/x5/khatus_lib_log.h
deleted file mode 100644 (file)
index f2cf46b..0000000
--- a/x5/khatus_lib_log.h
+++ /dev/null
@@ -1,15 +0,0 @@
-#define debug(...) if (_khatus_lib_log_level >= Debug) {fprintf(stderr, "[debug] " __VA_ARGS__); fflush(stderr);}
-#define info(...)  if (_khatus_lib_log_level >= Info ) {fprintf(stderr, "[info] "  __VA_ARGS__); fflush(stderr);}
-#define warn(...)  if (_khatus_lib_log_level >= Warn ) {fprintf(stderr, "[warn] "  __VA_ARGS__); fflush(stderr);}
-#define error(...) if (_khatus_lib_log_level >= Error) {fprintf(stderr, "[error] " __VA_ARGS__); fflush(stderr);}
-#define fatal(...)                                     {fprintf(stderr, "[fatal] " __VA_ARGS__); exit(EXIT_FAILURE);}
-
-typedef enum LogLevel {
-       Nothing,
-       Error,
-       Warn,
-       Info,
-       Debug
-} LogLevel;
-
-LogLevel _khatus_lib_log_level;

diff --git a/x5/khatus_lib_time.h b/x5/khatus_lib_time.h
deleted file mode 100644 (file)
index 1d4bb44..0000000
--- a/x5/khatus_lib_time.h
+++ /dev/null
@@ -1,3 +0,0 @@
-struct timespec timespec_of_float(double);
-
-void snooze(struct timespec *);

diff --git a/x5/khatus_sensor_battery.c b/x5/khatus_sensor_battery.c
index e6c7fe8..9923b34 100644 (file)
--- a/x5/khatus_sensor_battery.c
+++ b/x5/khatus_sensor_battery.c
@@ -10,8 +10,8 @@
 #include <time.h>
 #include <unistd.h>
 
-#include "khatus_lib_log.h"
-#include "khatus_lib_time.h"
+#include "khlib_log.h"
+#include "khlib_time.h"
 
 #define usage(...) {print_usage(); fprintf(stderr, "Error:\n    " __VA_ARGS__); exit(EXIT_FAILURE);}
 
@@ -77,12 +77,16 @@ get_capacity(char *buf, char *path)
        int cap;
 
        if (!(fp = fopen(path, "r")))
-               fatal("Failed to open %s. errno: %d, msg: %s\n",
-                   path, errno, strerror(errno));
+               khlib_fatal(
+                   "Failed to open %s. errno: %d, msg: %s\n",
+                   path,
+                   errno,
+                   strerror(errno)
+               );
 
        switch (fscanf(fp, "%d", &cap)) {
-       case -1: fatal("EOF\n");
-       case  0: fatal("Read 0\n");
+       case -1: khlib_fatal("EOF\n");
+       case  0: khlib_fatal("Read 0\n");
        case  1: break;
        default: assert(0);
        }
@@ -101,10 +105,10 @@ main(int argc, char **argv)
        struct timespec ti;
 
        opt_parse(argc, argv);
-       ti = timespec_of_float(opt_interval);
-       debug("opt_battery: \"%s\"\n", opt_battery);
-       debug("opt_interval: %f\n", opt_interval);
-       debug("ti: {tv_sec = %ld, tv_nsec = %ld}\n", ti.tv_sec, ti.tv_nsec);
+       ti = khlib_timespec_of_float(opt_interval);
+       khlib_debug("opt_battery: \"%s\"\n", opt_battery);
+       khlib_debug("opt_interval: %f\n", opt_interval);
+       khlib_debug("ti: {tv_sec = %ld, tv_nsec = %ld}\n",ti.tv_sec,ti.tv_nsec);
        memset(path, '\0', PATH_MAX);
        snprintf(path, PATH_MAX, path_fmt, opt_battery);
        signal(SIGPIPE, SIG_IGN);
@@ -113,7 +117,7 @@ main(int argc, char **argv)
                get_capacity(buf, path);
                puts(buf);
                fflush(stdout);
-               snooze(&ti);
+               khlib_sleep(&ti);
        }
        return EXIT_SUCCESS;
 }

diff --git a/x5/khatus_sensor_time.c b/x5/khatus_sensor_time.c
index 01483b9..7e16aac 100644 (file)
--- a/x5/khatus_sensor_time.c
+++ b/x5/khatus_sensor_time.c
@@ -8,8 +8,8 @@
 #include <time.h>
 #include <unistd.h>
 
-#include "khatus_lib_log.h"
-#include "khatus_lib_time.h"
+#include "khlib_log.h"
+#include "khlib_time.h"
 
 #define usage(...) {print_usage(); fprintf(stderr, "Error:\n    " __VA_ARGS__); exit(EXIT_FAILURE);}
 
@@ -79,10 +79,10 @@ main(int argc, char **argv)
        char buf[MAX_LEN];
 
        opt_parse(argc, argv);
-       ti = timespec_of_float(opt_interval);
-       debug("opt_fmt: \"%s\"\n", opt_fmt);
-       debug("opt_interval: %f\n", opt_interval);
-       debug("ti: {tv_sec = %ld, tv_nsec = %ld}\n", ti.tv_sec, ti.tv_nsec);
+       ti = khlib_timespec_of_float(opt_interval);
+       khlib_debug("opt_fmt: \"%s\"\n", opt_fmt);
+       khlib_debug("opt_interval: %f\n", opt_interval);
+       khlib_debug("ti: {tv_sec = %ld, tv_nsec = %ld}\n",ti.tv_sec,ti.tv_nsec);
        memset(buf, '\0', MAX_LEN);
        signal(SIGPIPE, SIG_IGN);
 
@@ -91,7 +91,7 @@ main(int argc, char **argv)
                strftime(buf, MAX_LEN, opt_fmt, localtime(&t));
                puts(buf);
                fflush(stdout);
-               snooze(&ti);
+               khlib_sleep(&ti);
        }
        return EXIT_SUCCESS;
 }

diff --git a/x5/khlib_log.c b/x5/khlib_log.c
new file mode 100644 (file)
index 0000000..a7eec52
--- /dev/null
+++ b/x5/khlib_log.c
@@ -0,0 +1,7 @@
+#include <stdarg.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "khlib_log.h"
+
+LogLevel _khlib_log_level = Debug;

diff --git a/x5/khlib_log.h b/x5/khlib_log.h
new file mode 100644 (file)
index 0000000..ef2a8b6
--- /dev/null
+++ b/x5/khlib_log.h
@@ -0,0 +1,15 @@
+#define khlib_debug(...) if (_khlib_log_level >= Debug) {fprintf(stderr, "[debug] " __VA_ARGS__); fflush(stderr);}
+#define khlib_info(...)  if (_khlib_log_level >= Info ) {fprintf(stderr, "[info] "  __VA_ARGS__); fflush(stderr);}
+#define khlib_warn(...)  if (_khlib_log_level >= Warn ) {fprintf(stderr, "[warn] "  __VA_ARGS__); fflush(stderr);}
+#define khlib_error(...) if (_khlib_log_level >= Error) {fprintf(stderr, "[error] " __VA_ARGS__); fflush(stderr);}
+#define khlib_fatal(...)                                {fprintf(stderr, "[fatal] " __VA_ARGS__); exit(EXIT_FAILURE);}
+
+typedef enum khlib_LogLevel {
+       Nothing,
+       Error,
+       Warn,
+       Info,
+       Debug
+} LogLevel;
+
+LogLevel _khlib_log_level;

diff --git a/x5/khatus_lib_time.c b/x5/khlib_time.c
similarity index 72%
rename from x5/khatus_lib_time.c
rename to x5/khlib_time.c
index d13f689..c55e0af 100644 (file)
--- a/x5/khatus_lib_time.c
+++ b/x5/khlib_time.c
@@ -5,11 +5,11 @@
 #include <string.h>
 #include <time.h>
 
-#include "khatus_lib_log.h"
-#include "khatus_lib_time.h"
+#include "khlib_log.h"
+#include "khlib_time.h"
 
 struct timespec
-timespec_of_float(double n)
+khlib_timespec_of_float(double n)
 {
        double integral;
        double fractional;
@@ -23,16 +23,13 @@ timespec_of_float(double n)
 }
 
 void
-snooze(struct timespec *t)
+khlib_sleep(struct timespec *t)
 {
        struct timespec remainder;
-       int result;
 
-       result = nanosleep(t, &remainder);
-
-       if (result < 0) {
+       if (nanosleep(t, &remainder) < 0) {
                if (errno == EINTR) {
-                       warn(
+                       khlib_warn(
                            "nanosleep interrupted. Remainder: "
                            "{ tv_sec = %ld, tv_nsec = %ld }",
                            remainder.tv_sec, remainder.tv_nsec);
@@ -40,7 +37,7 @@ snooze(struct timespec *t)
                         * so not attempting to correct after an interruption.
                         */
                } else {
-                       fatal("nanosleep: %s\n", strerror(errno));
+                       khlib_fatal("nanosleep: %s\n", strerror(errno));
                }
        }
 }

diff --git a/x5/khlib_time.h b/x5/khlib_time.h
new file mode 100644 (file)
index 0000000..572e5ee
--- /dev/null
+++ b/x5/khlib_time.h
@@ -0,0 +1,3 @@
+struct timespec khlib_timespec_of_float(double);
+
+void khlib_sleep(struct timespec *);