Bump version

- QOL for *.tape files

.gitignore

@@ -130,3 +130,4 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.toptal.com/developers/gitignore/api/c,macos,windows,linux,c
+

Makefile

@@ -6,11 +6,7 @@ ODIR:=obj
 BINDIR:=build
 
 CC:=cc
-# OMG SO FAST (see https://www.shlomifish.org/humour/by-others/funroll-loops/Gentoo-is-Rice.html)
-# CFLAGS:=-I$(IDIR) -Wall -Wextra -pedantic -Ofast -faggressive-loop-optimizations -funroll-all-loops  -march=native
-# For a stable experience
-CFLAGS:=-I$(IDIR) -Wall -Wextra -pedantic -O2 -march=native
-
+CFLAGS:=-I$(IDIR) -Wall -Wextra -pedantic -Ofast
 LIB:=
 
 DEPS:=$($(IDIR)/%.h)
@@ -34,6 +30,7 @@ prep:
 	-@mkdir -p $(IDIR)
 	-@mkdir -p $(ODIR)
 	-@mkdir -p $(BINDIR)
+	@echo $(BINDIR)/ >> .gitignore
 
 .PHONY: clean
 clean:

README.md

@@ -1,12 +1,41 @@
 # lat
 > lat | lazy cat - a cat clone with some quality-of-life embellishments
 
+[![Build](https://github.com/secondary-smiles/lat/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/secondary-smiles/lat/actions/workflows/c-cpp.yml)
+
 ## About
 
 `lat` is a solution to a problem that doesn't exist. It's the awkward middle child in-between `cat` and `bat`. It was created because the author didn't want to have to configure `bat` just to get decent file printing, but wanted a little more control than `cat` offered.
 
 `lat` does not expect to be used. `lat` expects to be forgotten and shunted into a corner because it does not belong in the slightest.
 
+`lat` is fast. Here are the hyperfine results comparing `cat`, `lat`, and `bat` on a ~24MB text file:
+
+```test
+❯ hyperfine "cat log.log" "lat log.log" "bat log.log" -N --warmup 200
+  Benchmark 1: cat log.log
+    Time (mean ± σ):       3.6 ms ±   0.3 ms    [User: 0.4 ms, System: 2.3 ms]
+    Range (min … max):     3.1 ms …   5.0 ms    851 runs
+
+  Benchmark 2: lat log.log
+    Time (mean ± σ):       6.2 ms ±   0.7 ms    [User: 0.4 ms, System: 4.2 ms]
+    Range (min … max):     5.5 ms …  14.5 ms    496 runs
+
+    Warning: Statistical outliers were detected. Consider re-running this benchmark on a quiet system without any interferences from other programs. It might help to use the '--warmup' or '--prepare' options.
+
+  Benchmark 3: bat log.log
+    Time (mean ± σ):     103.9 ms ±   0.5 ms    [User: 37.5 ms, System: 65.6 ms]
+    Range (min … max):   103.2 ms … 104.8 ms    28 runs
+
+  Summary
+    'cat log.log' ran
+    1.74 ± 0.26 times faster than 'lat log.log'
+    29.10 ± 2.85 times faster than 'bat log.log'
+```
+> tested on a 2020 M1 MacBook Pro 16GB
+
+as you can see, the extra features do take their toll on performance, but overall, `lat` is generally nearly on-par with `cat`, and *far* faster than `bat`.
+
 ## Install
 `lat` is not yet at a stable version (`v1.0.0`), so it is not on any package managers. 
 
@@ -15,6 +44,7 @@ git clone https://github.com/secondary-smiles/lat.git
 
 cd lat
 
+make prep
 make
 
 ./build/lat -V
@@ -22,26 +52,95 @@ make
 # now add lat to your $PATH/do whatever you want with the binary
 ```
 
+## Use
+
+`lat` can, for the most part, be a direct drop in for `cat`. However it really shines when embedded into another program. For example, in `fzf`, `lat` makes an excellent viewer with the command `fzf --command lat -r {}`.
+
+![Using lat in fzf](social/render/fzf_embed.gif)
+
+Soon, I plan to add the ability to live-write to `lat`. That means that `lat` can become yet another output stream.
+
+For example, this should be possible in a future version of `lat`
+
+```c
+int main(void) {
+  FILE *st = popen("lat -r", "w");
+  if (st == NULL)
+  	exit(1);
+
+  fprintf(st, "look ma, i'm formatted!")
+
+  pclose(st);
+}
+```
+> UPDATE: this feature is possible, however the data is only printed upon `pclose`.
+
+### Features and Flags
+
+#### `-c` color
+Completely disables or enables all colored output from `lat`.
+##### Example
+![Color in lat](social/render/color.gif)
+> `lat` also respects [NO_COLOR](https://no-color.org/), but `-c` overrides it
+
+#### `-l` line numbers
+Print numbers for each line of the file.
+##### Example
+![Line numbers in lat](social/render/line_numbers.gif)
+
+#### `-t` file title
+Shows or hides formatted file data headers.
+##### Example
+![Headers in lat](social/render/headers.gif)
+
+#### `-b` binary mode
+By default, `lat` will attempt to detect if the file is printable or not. If the file isn't (e.g. you ran `lat file.pdf`) then lat will enter *`binary mode`*. In *`binary mode`*, `lat` will skip a lot of processing in favor of speed.
+You can force *`binary mode`* to be `on` or `off` with the flags `-b` and `-bb` respectively.
+##### Example
+![Binary Mode in lat](social/render/binary.gif)
+
+#### `-r` raw output
+`lat` is smart enough to print all non-file characters to a separate filestream. That way, the output of `lat` can be used to con**cat**enate files, the way it was originally meant to be (with `>` or `|`).
+However, sometimes you want those extra symbols.
+`-r` prints everything out to the primary filestream (usually `stdout`)
+##### Example
+![Literal output in lat](social/render/raw.gif)
+
+#### `-p` pager
+`lat` comes with out-of-the-box support for paging in `less`. If you don't want your file messing up your terminal, just `-p` it.
+
+### `-n` name
+`lat` allows you to customize the name of the file shown. This can be useful in demonstrations or when `lat` is embedded in another program.
+#### Example
+![Custom filename in lat](social/render/name.gif)
+
+##### Example
+![Paging in lat](social/render/pager.gif)
+
+#### If there is a feature you'd like to see, feel free to make an issue (1x points). If you're feeling especially savvy, make a PR with the feature (10x points).
+
+ 
 ## Helptext
 > `lat -h`
 
 ```text
 lat | lazy cat - a cat clone with some quality-of-life embellishments
 
-usage: lat [-cltbrpneVh] [file...]
+usage: lat [-cltbrpnVh] [file...]
 
 options:
-	-c           toggle color
-	-l           toggle line numbers
-	-t           toggle file info headers
-	-b           set binary mode, -b forces binary and -bb forces NOT binary
-	-r           print everything (headers, line numbers, etc.) to stdout (or equivalent)
-	-p           print file with the pager (uses less)
-	-n <name>    manually set the name of the file shown in the title
-	-e <program> link extension to lat
-	-V           show program version
-	-h           display this help text
+  -c	 toggle color
+  -l	 toggle line numbers
+  -t	 toggle file info headers
+  -b	 toggle binary mode, -b forces binary and -bb forces NOT binary
+  -r	 print everything to stdout (or equivalent)
+  -p	 print file with the pager (uses less)
+  -n	 set the name of the file in the title
+  -V	 show program version
+  -h	 display this help text
 
 environment:
-	NO_COLOR, see https://no-color.org/
+  NO_COLOR, see https://no-color.org/
 ```
+
+

include/arg.h

@@ -2,10 +2,10 @@
 #define ARG_H
 #include <stdbool.h>
 
-#define LAT_VERSION "0.13.0"
+#define LAT_VERSION "0.12.0"
 
 struct config {
-  bool isstdin;
+  bool stdin;
   bool process;
   bool color;
   bool lines;
@@ -14,7 +14,6 @@ struct config {
   bool literal;
   bool pager;
   char *name;
-  char *extension;
   bool has_read_stdin;
 };
 

social/lat_demo.tape

@@ -1,24 +0,0 @@
-Require lat
-Output social/render/lat_demo.gif
-
-Set Theme "Gruvbox Dark"
-Set WindowBar Rings
-Set BorderRadius 10
-Set Margin 10
-
-Set FontSize 32
-Set Width 2400
-Set Height 2000
-Set TypingSpeed 0.2
-
-Type "lat Makefile"
-Sleep 2s
-Enter
-
-Sleep 4s
-
-Type "lat -h"
-Sleep 2s
-Enter
-
-Sleep 4s

src/lib/arg.c

@@ -1,14 +1,13 @@
 #include <stdio.h>
 #include <stdlib.h>
-#include <stdnoreturn.h>
-#include <sys/ioctl.h>
+#include <string.h>
 #include <unistd.h>
 
 #include "arg.h"
 #include "util.h"
 
-#define LAT_SHORT_ARGS "cltbrpn:e:Vh"
-#define LAT_USAGE "usage: lat [-cltbrpneVh] [file...]"
+#define LAT_SHORT_ARGS "cltbrpn:Vh"
+#define LAT_USAGE "usage: lat [-cltbrpnVh] [file...]"
 
 struct config conf;
 
@@ -17,31 +16,48 @@ void help(void) {
          "embellishments\n\n");
 
   printf("%s\n\n", LAT_USAGE);
-  printf("options:\n"
-         "\t-c           toggle color\n"
-         "\t-l           toggle line numbers\n"
-         "\t-t           toggle file info headers\n"
-         "\t-b           set binary mode, -b forces binary and -bb forces NOT "
-         "binary\n"
-         "\t-r           print everything (headers, line numbers, etc.) to "
-         "stdout (or equivalent)\n"
-         "\t-p           disable or enable pager (uses less)\n"
-         "\t-n <name>    manually set the name of the file shown in the title\n"
-         // "\t-e <program> NONFUNCTIONAL (will be added soon)  link extension
-         // to lat\n"
-         "\t-V           show program version\n"
-         "\t-h           display this help text\n\n");
+  printf(
+      "options:\n"
+      "\t-c\t toggle color\n"
+      "\t-l\t toggle line numbers\n"
+      "\t-t\t toggle file info headers\n"
+      "\t-b\t toggle binary mode, -b forces binary and -bb forces NOT binary\n"
+      "\t-r\t print everything to stdout (or equivalent)\n"
+      "\t-p\t print file with the pager (uses less)\n"
+      "\t-n\t set the name of the file in the title\n"
+      "\t-V\t show program version\n"
+      "\t-h\t display this help text\n\n");
   printf("environment:\n"
          "\tNO_COLOR, see https://no-color.org/\n");
 }
 
+void examples(void) {
+  printf(
+      "examples:\n"
+      "\tlat file1\n\t\t print the contents of file1 with the default "
+      "formatting\n"
+      "\tlat - file1\n\t\t read from stdin (the '-' flag reads from "
+      "stdin) "
+      "and then print the contents of stdin and file1\n"
+      "\tlat -nc file1 file2\n\t\t print the contents of file1 and "
+      "file2 "
+      "without printing line numbers or colors\n"
+      "\tlat --binary file.txt\n\t\t force file.txt to be treated as a binary "
+      "file\n"
+      "\tlat -bb --pager file.txt\n\t\t force file.txt to NOT be treated "
+      "as a binary file and print it in the pager\n"
+      "\tcurl example.com | lat\n\t\t pipe the results of 'curl example.com' "
+      "into lat\n"
+      "\tfzf --preview 'lat -l {}'\n\t\t use lat as the file viewer in fzf\n");
+}
+
 void version(void) {
   printf("lat - v%s built %s at %s\n", LAT_VERSION, __DATE__, __TIME__);
 }
 
-noreturn void argerr(void) {
+void argerr(void) {
   printf("\n%s\n", LAT_USAGE);
-  printf("run '-h' for more information\n");
+  printf("run '--help' for more information\n");
   exit(EXIT_FAILURE);
 }
 
@@ -73,9 +89,6 @@ int parseargs(int argc, char *argv[]) {
     case 'n':
       conf.name = optarg;
       break;
-    case 'e':
-      conf.extension = optarg;
-      break;
     case 'V':
       version();
       exit(EXIT_SUCCESS);

src/lib/file.c

@@ -4,7 +4,6 @@
 
 #include "types.h"
 #include "util.h"
-#include "arg.h"
 
 bool isbinary(struct filedata *f) {
 
@@ -23,7 +22,7 @@ bool isbinary(struct filedata *f) {
   }
 }
 
-struct filedata readfile(FILE *fp) {
+struct filedata readfile(FILE *fp, bool isstdin) {
   struct filedata f;
 
   f.lc = 0;
@@ -33,7 +32,7 @@ struct filedata readfile(FILE *fp) {
   f.buf = NULL;
   f.lines = NULL;
 
-  if (conf.isstdin) {
+  if (isstdin) {
     size_t bufsize = 1024;
     f.buf = malloc(bufsize);
     if (f.buf == NULL)
@@ -43,6 +42,7 @@ struct filedata readfile(FILE *fp) {
     while (fread(&c, 1, 1, fp) > 0) {
       if (f.buflen == bufsize - 1) {
         bufsize *= 2;
+
         char *new_buf = realloc(f.buf, bufsize);
         if (new_buf == NULL)
           die("realloc");

src/lib/process.c

@@ -1,15 +1,12 @@
+#include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
-#include <stdio.h>
-
 #include "types.h"
 #include "util.h"
 
 void appendline(struct filedata *f, char *data, size_t len) {
   f->lines = realloc(f->lines, sizeof(struct line) * (f->lc + 1));
-  if (f->lines == NULL)
-    die("realloc");
 
   size_t loc = f->lc;
 
@@ -23,7 +20,7 @@ void loadlines(struct filedata *f) {
   f->lc = 0;
 
   size_t offset = 0;
-  size_t linelen = 1024;
+  size_t linelen = 4096;
   char *line = malloc(linelen);
   if (line == NULL)
     die("malloc");
@@ -31,11 +28,10 @@ void loadlines(struct filedata *f) {
   for (size_t i = 0; i < f->buflen; i++) {
     char c = f->buf[i];
     if (c == '\n') {
-      if (offset >= 1 && offset < linelen) { // shrink to fit
+      if (offset < linelen) { // shrink
         char *new_line = realloc(line, offset);
         if (new_line == NULL)
           die("realloc");
-
         line = new_line;
       }
 
@@ -63,7 +59,7 @@ void loadlines(struct filedata *f) {
   }
 
   // capture last line
-  if (offset >= 1 && offset < linelen) { // shrink
+  if (offset < linelen) { // shrink
     char *new_line = realloc(line, offset);
     if (new_line == NULL)
       die("realloc");

src/lib/util.c

@@ -1,8 +1,8 @@
 #include <stdio.h>
 #include <stdlib.h>
-#include <stdnoreturn.h>
+#include <sys/ioctl.h>
 
-noreturn void die(const char *message) {
+void die(const char *message) {
   perror(message);
   exit(EXIT_FAILURE);
 }

src/main.c

@@ -1,6 +1,5 @@
 #include <stdio.h>
 #include <stdlib.h>
-#include <sys/ioctl.h>
 #include <unistd.h>
 
 #include "arg.h"
@@ -17,60 +16,13 @@
 FILE *st;
 FILE *err;
 
-struct colors {
-  char *invert_t;
-  char *grey;
-  char *reset;
-};
-
-struct colors c;
-
-void initcolor(void) {
-  c.invert_t = conf.color ? INVERT_T : "";
-  c.grey = conf.color ? GREY : "";
-  c.reset = conf.color ? RESET : "";
-}
-
-void printheadertop(char *filename, bool binary) {
-  char *name = conf.name == NULL ? filename : conf.name;
-  char *addon = binary ? "<binary>" : "";
-  if (conf.isstdin && !conf.pager)
-    fprintf(err, "\x1b[2K\r%s%s%s%s\n", c.invert_t, name, addon, c.reset);
-  else
-    fprintf(err, "%s%s%s%s\n", c.invert_t, name, addon, c.reset);
-}
-
-void printheaderbottom(size_t buflen) {
-  float rounded;
-  char *format = formatbytes(buflen, &rounded);
-
-  fprintf(err, "%s%.2f %s%s\n", c.invert_t, rounded, format, c.reset);
-}
-
 void run(FILE *fp, char *filename, bool tty) {
-  initcolor();
+  const char *invert_t = conf.color ? INVERT_T : "";
+  const char *grey = conf.color ? GREY : "";
+  const char *reset = conf.color ? RESET : "";
 
   struct filedata f;
-  f = readfile(fp, conf.isstdin);
-
-  // any/all processing to be done
-  // TODO: maybe multithread?
-  conf.process = (tty && !f.binary);
-  if (conf.process) { // file display processing
-    loadlines(&f);
-  }
-
-  if (conf.extension != NULL) {
-    // TODO
-  }
-
-  struct winsize w;
-
-  if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &w) != -1 || w.ws_col != 0) {
-    if (w.ws_row <= f.lc + 5) {
-      conf.pager = !conf.pager;
-    }
-  }
+  f = readfile(fp, conf.stdin);
 
   if (conf.pager) {
     st = popen("less", "w");
@@ -90,22 +42,29 @@ void run(FILE *fp, char *filename, bool tty) {
     f.binary = false;
   }
 
+  char *name = conf.name == NULL ? filename : conf.name;
   if (conf.headers) {
-    printheadertop(filename, f.binary);
+    char *addon = f.binary ? "<binary>" : "";
+    if (conf.stdin && !conf.pager)
+      fprintf(err, "\x1b[2K\r%s%s%s%s\n", invert_t, name, addon, reset);
+    else
+      fprintf(err, "%s%s%s%s\n", invert_t, name, addon, reset);
+  }
+
+  conf.process = (tty && !f.binary);
+  if (conf.process) { // file display processing
+    loadlines(&f);
   }
 
   if (conf.process) {
     int linecount = 1;
     for (int i = 0; i < f.lc; i++) {
       if (conf.lines) {
-        { // line numbers
-          char *padding = linepad(linecount, f.lc);
-          fprintf(err, "%s%s%d│%s ", c.grey, padding, i + 1, c.reset);
-          free(padding);
-        }
-
+        char *padding = linepad(linecount, f.lc);
+        fprintf(st, "%s%s%d│%s ", grey, padding, i + 1, reset);
         fwrite(f.lines[i].buf, 1, f.lines[i].len, st);
         fprintf(st, "\n");
+        free(padding);
         linecount++;
       } else {
         fprintf(st, "%s\n", f.lines[i].buf);
@@ -115,17 +74,18 @@ void run(FILE *fp, char *filename, bool tty) {
   } else {
     fwrite(f.buf, 1, f.buflen, st);
     fflush(st);
-    if (tty)
-      fwrite("\n", 1, 1, err);
+    fwrite("\n", 1, 1, err);
   }
   free(f.buf);
-  free(f.lines);
 
   fflush(st); // prevent timing inconsistencies between st and err
   fflush(err);
 
   if (conf.headers) {
-    printheaderbottom(f.buflen);
+    float rounded;
+    char *format = formatbytes(f.buflen, &rounded);
+
+    fprintf(err, "%s%.2f %s%s\n", invert_t, rounded, format, reset);
   }
 
   if (conf.pager) {
@@ -135,7 +95,7 @@ void run(FILE *fp, char *filename, bool tty) {
 
 void initconf(void) {
   conf.force_binary = -1;
-  conf.isstdin = false;
+  conf.stdin = false;
   conf.has_read_stdin = false;
   conf.pager = false;
   conf.literal = false;
@@ -146,7 +106,6 @@ void initconf(void) {
   conf.lines = true;
 
   conf.name = NULL;
-  conf.extension = NULL;
 }
 
 void clearstdin(void) {
@@ -170,20 +129,18 @@ int main(int argc, char *argv[]) {
 
   bool tty = isatty(STDOUT_FILENO);
 
-  int offset = parseargs(argc, argv);
-
-  conf.headers = conf.headers && tty;
-
   if (argc > 1) {
-
+    int offset = parseargs(argc, argv);
     tty = tty || conf.literal;
+    conf.headers = conf.headers && tty; // tty still overrides user
+    conf.pager = conf.pager && tty;
 
     for (int i = offset; i < argc; i++) {
       if (*argv[i] == '-') {
         if (conf.has_read_stdin)
           clearstdin();
         conf.has_read_stdin = true;
-        conf.isstdin = true;
+        conf.stdin = true;
         run(stdin, "stdin", tty);
         if (tty && (i + 1 != argc)) {
           fprintf(err, "\n"); // separate concurrent files in tty
@@ -192,7 +149,7 @@ int main(int argc, char *argv[]) {
         continue;
       }
 
-      conf.isstdin = false;
+      conf.stdin = false;
       FILE *fp = fopen(argv[i], "rb");
       if (fp == NULL)
         die(argv[i]);
@@ -204,11 +161,11 @@ int main(int argc, char *argv[]) {
     }
 
     if (offset == argc) {
-      conf.isstdin = true;
+      conf.stdin = true;
       run(stdin, "stdin", tty);
     }
   } else {
-    conf.isstdin = true;
+    conf.stdin = true;
     run(stdin, "stdin", tty); // for piped-input or repl-like behavior
   }