Cleanup

- Cleanup unneeded headers
- Fix helptext typos/bugs
- add noreturn to die(), and equiv

.github/workflows/c-cpp.yml

@@ -0,0 +1,21 @@
+name: Build
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: prep
+      run: make prep
+    - name: make
+      run: make
+    - name: test
+      run: ./build/lat -V

LICENSE

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

Makefile

@@ -22,7 +22,6 @@ $(ODIR)/%.o: %.c $(DEPS)
 	$(CC) -c -o $@ $< $(CFLAGS) $(LIB)
 
 $(NAME): $(OBJ)
-	@echo "--don't forget to set $(NAME)'s version--"
 	$(CC) -o $(BINDIR)/$@ $^ $(CFLAGS) $(LIB)
 
 .PHONY: prep

README.md

@@ -0,0 +1,146 @@
+# 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. 
+
+```bash
+git clone https://github.com/secondary-smiles/lat.git
+
+cd lat
+
+make prep
+make
+
+./build/lat -V
+
+# 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 [-cltbrpnVh] [file...]
+
+options:
+  -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/
+```
+
+

include/arg.h

@@ -2,7 +2,7 @@
 #define ARG_H
 #include <stdbool.h>
 
-#define LAT_VERSION "0.11.1"
+#define LAT_VERSION "0.12.1"
 
 struct config {
   bool stdin;
@@ -13,6 +13,7 @@ struct config {
   int force_binary;
   bool literal;
   bool pager;
+  char *name;
   bool has_read_stdin;
 };
 

social/binary.tape

@@ -0,0 +1,54 @@
+Require lat
+Output social/render/binary.gif
+
+Set Theme "Gruvbox Dark"
+Set WindowBar Rings
+Set BorderRadius 10
+Set Margin 10
+
+Set FontSize 32
+Set Width 2400
+Set Height 1200
+Set TypingSpeed 0.2
+
+Type "lat src/main.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Type "clear"
+Sleep 1s
+Enter
+
+Sleep 2s
+
+Type "lat -b src/main.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Type "clear"
+Sleep 1s
+Enter
+
+Sleep 2s
+
+Type "lat ./build/lat"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Type "clear"
+Sleep 1s
+Enter
+
+Sleep 2s
+
+Type "lat -bb ./build/lat"
+Sleep 2s
+Enter
+
+Sleep 5s

social/color.tape

@@ -0,0 +1,31 @@
+Require lat
+Output social/render/color.gif
+
+Set Theme "Gruvbox Dark"
+Set WindowBar Rings
+Set BorderRadius 10
+Set Margin 10
+
+Set FontSize 32
+Set Width 2400
+Set Height 1200
+Set TypingSpeed 0.2
+
+Type "lat src/main.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Type "clear"
+Sleep 1s
+Enter
+
+Sleep 2s
+
+Type "lat -c src/main.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+

social/fzf_embed.tape

@@ -0,0 +1,41 @@
+Require lat
+Output social/render/fzf_embed.gif
+
+Set Theme "Gruvbox Dark"
+Set WindowBar Rings
+Set BorderRadius 10
+Set Margin 10
+
+Set FontSize 32
+Set Width 2400
+Set Height 1200
+Set TypingSpeed 0.2
+
+Type "fzf --preview 'lat -r {}'"
+Sleep 1s
+
+Enter
+Sleep 2s
+
+Type "main.c"
+Sleep 2s
+Backspace 7
+Sleep 1s
+
+Type "types.h"
+Sleep 1s
+Backspace 8
+Sleep 2s
+
+Type "file.c"
+Sleep 3s
+Backspace 7
+Sleep 2s
+
+Up@3s 15
+
+Sleep 3s
+
+Enter
+
+Sleep 2s

social/headers.tape

@@ -0,0 +1,32 @@
+Require lat
+Output social/render/headers.gif
+
+Set Theme "Gruvbox Dark"
+Set WindowBar Rings
+Set BorderRadius 10
+Set Margin 10
+
+Set FontSize 32
+Set Width 2400
+Set Height 1200
+Set TypingSpeed 0.2
+
+Type "lat src/main.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Type "clear"
+Sleep 1s
+Enter
+
+Sleep 2s
+
+Type "lat -t src/main.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+

social/line_numbers.tape

@@ -0,0 +1,30 @@
+Require lat
+Output social/render/line_numbers.gif
+
+Set Theme "Gruvbox Dark"
+Set WindowBar Rings
+Set BorderRadius 10
+Set Margin 10
+
+Set FontSize 32
+Set Width 2400
+Set Height 1200
+Set TypingSpeed 0.2
+
+Type "lat src/main.c"
+Sleep 2s
+Enter
+
+Sleep 4s
+
+Type "clear"
+Sleep 1s
+Enter
+
+Sleep 2s
+
+Type "lat -n src/main.c"
+Sleep 2s
+Enter
+
+Sleep 4s

social/literal.tape

@@ -0,0 +1,46 @@
+Require lat
+Output social/render/literal.gif
+
+Set Theme "Gruvbox Dark"
+Set WindowBar Rings
+Set BorderRadius 10
+Set Margin 10
+
+Set FontSize 32
+Set Width 2400
+Set Height 1200
+Set TypingSpeed 0.2
+
+Type "lat src/main.c > example.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Type "cat example.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Type "clear"
+Sleep 1s
+Enter
+
+Sleep 2s
+
+Type "lat -r src/main.c > example.c"
+Sleep 2s
+Enter
+
+Sleep 3s
+
+Type "cat example.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Hide
+Type "rm example.c"
+Enter

social/name.tape

@@ -0,0 +1,37 @@
+Require lat
+Output social/render/name.gif
+
+Set Theme "Gruvbox Dark"
+Set WindowBar Rings
+Set BorderRadius 10
+Set Margin 10
+
+Set FontSize 32
+Set Width 2400
+Set Height 1200
+Set TypingSpeed 0.2
+
+Type "lat"
+Sleep 2s
+Enter
+
+Type "hello, world!"
+Enter
+Sleep 3s
+
+Ctrl+d
+
+Sleep 3s
+
+Type "lat -n "custom name" src/main.c"
+Sleep 2s
+Enter
+
+Type "hello, world!"
+Enter
+Sleep 3s
+
+Ctrl+d
+
+Sleep 4s
+

social/pager.tape

@@ -0,0 +1,40 @@
+Require lat
+Output social/render/pager.gif
+
+Set Theme "Gruvbox Dark"
+Set WindowBar Rings
+Set BorderRadius 10
+Set Margin 10
+
+Set FontSize 32
+Set Width 2400
+Set Height 1200
+Set TypingSpeed 0.2
+
+Type "lat src/main.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Type "clear"
+Sleep 1s
+Enter
+
+Sleep 2s
+
+Type "lat -p src/main.c"
+Sleep 2s
+Enter
+
+Sleep 5s
+
+Down 100
+
+Sleep 3s
+
+Type "q"
+Sleep 4s
+
+
+

src/lib/arg.c

@@ -1,125 +1,54 @@
 #include <stdio.h>
 #include <stdlib.h>
-#include <string.h>
+#include <unistd.h>
+#include <stdnoreturn.h>
 
 #include "arg.h"
 #include "util.h"
 
-#define LAT_USAGE "usage: lat [-cntblpVh] [file...]"
+#define LAT_SHORT_ARGS "cltbrpn:Vh"
+#define LAT_USAGE "usage: lat [-cltbrpnVh] [file...]"
+
+struct config conf;
 
 void help(void) {
   printf("lat | lazy cat - a cat clone with some quality-of-life "
          "embellishments\n\n");
 
   printf("%s\n\n", LAT_USAGE);
-  printf("options:\n"
-         "\t-c, --color\t toggle color\n"
-         "\t-n, --lines\t toggle line numbers\n"
-         "\t-t, --headers\t toggle file info headers\n"
-         "\t-b, --binary\t toggle binary mode, -b forces binary and -bb forces "
-         "NOT binary\n"
-         "\t-l, --literal\t print everything to stdout (or equivalent)\n"
-         "\t-p, --pager\t print file with the pager (uses less)\n"
-         "\t-V, --version\t show program version\n"
-         "\t-h, --help\t display this help text (--help shows additional "
-         "info)\n\n");
-  printf("environment:\n"
-         "\tNO_COLOR, see https://no-color.org/\n\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"
-  );
+      "options:\n"
+      "\t-c\t\t toggle color\n"
+      "\t-l\t\t toggle line numbers\n"
+      "\t-t\t\t toggle file info headers\n"
+      "\t-b\t\t set binary mode, -b forces binary and -bb forces NOT binary\n"
+      "\t-r\t\t print everything (headers, line numbers, etc.) to stdout (or equivalent)\n"
+      "\t-p\t\t print file with the pager (uses less)\n"
+      "\t-n <name>\t\t manually set the name of the file in the title\n"
+      "\t-V\t\t show program version\n"
+      "\t-h\t\t display this help text\n\n");
+  printf("environment:\n"
+         "\tNO_COLOR, see https://no-color.org/\n");
 }
 
 void version(void) {
   printf("lat - v%s built %s at %s\n", LAT_VERSION, __DATE__, __TIME__);
 }
 
-struct config conf;
-void argerr(char *r, char *arg) {
-  printf("lat: %s '%s'\n\n", r, arg);
-
-  printf("%s\n", LAT_USAGE);
-  printf("run '--help' for more information\n");
+noreturn void argerr(void) {
+  printf("\n%s\n", LAT_USAGE);
+  printf("run '-h' for more information\n");
   exit(EXIT_FAILURE);
 }
 
-void parselongarg(char *arg) {
-  if (strcmp(arg, "--color") == 0) {
-    conf.color = !conf.color;
-    return;
-  }
-
-  if (strcmp(arg, "--lines") == 0) {
-    conf.lines = !conf.lines;
-    return;
-  }
-
-  if (strcmp(arg, "--headers") == 0) {
-    conf.headers = !conf.headers;
-    return;
-  }
-
-  if (strcmp(arg, "--binary") == 0) {
-    if (conf.force_binary < 0)
-      conf.force_binary = 1;
-    else
-      conf.force_binary = !conf.force_binary;
-    return;
-  }
-
-  if (strcmp(arg, "--literal") == 0) {
-    conf.literal = !conf.literal;
-    return;
-  }
-
-  if (strcmp(arg, "--pager") == 0) {
-    conf.pager = !conf.pager;
-    return;
-  }
-
-  if (strcmp(arg, "--help") == 0) {
-    help();
-    examples();
-    exit(EXIT_SUCCESS);
-    return;
-  }
-
-  if (strcmp(arg, "--version") == 0) {
-    version();
-    exit(EXIT_SUCCESS);
-    return;
-  }
-
-  argerr("unrecognized arg", arg);
-}
-
-void parseshortarg(char *arg) {
-  size_t i = 1;
-  while (arg[i] != '\0') {
-    char c = arg[i];
-    switch (c) {
+int parseargs(int argc, char *argv[]) {
+  char opt;
+  while ((opt = getopt(argc, argv, LAT_SHORT_ARGS)) != -1) {
+    switch (opt) {
     case 'c':
       conf.color = !conf.color;
       break;
-    case 'n':
+    case 'l':
       conf.lines = !conf.lines;
       break;
     case 't':
@@ -131,12 +60,15 @@ void parseshortarg(char *arg) {
       else
         conf.force_binary = !conf.force_binary;
       break;
-    case 'l':
+    case 'r':
       conf.literal = !conf.literal;
       break;
     case 'p':
       conf.pager = !conf.pager;
       break;
+    case 'n':
+      conf.name = optarg;
+      break;
     case 'V':
       version();
       exit(EXIT_SUCCESS);
@@ -145,39 +77,10 @@ void parseshortarg(char *arg) {
       help();
       exit(EXIT_SUCCESS);
       break;
-    default: {
-      char *str = malloc(2);
-      str[0] = c;
-      str[1] = '\0';
-      argerr("unrecognized flag", str);
-      free(str);
+    default:
+      argerr();
       break;
     }
-    }
-    i++;
   }
-}
-
-int parseargs(int argc, char *argv[]) {
-  int i;
-  for (i = 1; i < argc; i++) { // offset for argv[0]
-    char *arg = argv[i];
-
-    if (arg[0] == '-' && arg[1] == '\0') {
-      return i;
-    }
-
-    if (arg[0] == '-') {
-      if (arg[1] == '-') {
-        parselongarg(arg);
-        continue;
-      }
-
-      parseshortarg(arg);
-    } else {
-      return i;
-    }
-  }
-
-  return i;
+  return optind;
 }

src/lib/process.c

@@ -1,4 +1,3 @@
-#include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 

src/lib/util.c

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

src/main.c

@@ -1,7 +1,5 @@
-#include <libgen.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include <string.h>
 #include <unistd.h>
 
 #include "arg.h"
@@ -44,13 +42,13 @@ void run(FILE *fp, char *filename, bool tty) {
     f.binary = false;
   }
 
+  char *name = conf.name == NULL ? filename : conf.name;
   if (conf.headers) {
     char *addon = f.binary ? "<binary>" : "";
     if (conf.stdin && !conf.pager)
-      fprintf(err, "\x1b[2K\r%s%s%s%s\n", invert_t, basename(filename), addon,
-              reset);
+      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, basename(filename), addon, reset);
+      fprintf(err, "%s%s%s%s\n", invert_t, name, addon, reset);
   }
 
   conf.process = (tty && !f.binary);
@@ -101,10 +99,13 @@ void initconf(void) {
   conf.has_read_stdin = false;
   conf.pager = false;
   conf.literal = false;
+
   conf.process = true;
   conf.headers = true;
   conf.color = true;
   conf.lines = true;
+
+  conf.name = NULL;
 }
 
 void clearstdin(void) {
@@ -141,6 +142,10 @@ int main(int argc, char *argv[]) {
         conf.has_read_stdin = true;
         conf.stdin = true;
         run(stdin, "stdin", tty);
+        if (tty && (i + 1 != argc)) {
+          fprintf(err, "\n"); // separate concurrent files in tty
+        }
+
         continue;
       }
 
@@ -151,7 +156,6 @@ int main(int argc, char *argv[]) {
       run(fp, argv[i], tty);
       fclose(fp);
       if (tty && (i + 1 != argc)) {
-        printf("offset: %d argc: %d\n", i, argc);
         fprintf(err, "\n"); // separate concurrent files in tty
       }
     }