4.3.3 -- Docs, refactor, delete old manpages on install

micha · micha · commit 39a385ea81b5 · 2017-09-16T13:03:10.000-04:00
diff --git a/Makefile b/Makefile
@@ -51,6 +51,8 @@ install: jt jt.1
 	mkdir -p $(BINDIR) $(MANDIR)
 	cp jt $(BINDIR)
 	cp jt.1 $(MANDIR)
+	cat $(PREFIX)/man/man1/jt.1 2>&1 |grep -q 'micha\\\.niskin@gmail\\\.com' \
+		&& rm -f $(PREFIX)/man/man1/jt.1 || true
 
 jt.tar: jt jt.1
 	tar cf $@ --transform 's@^@bin/@' jt
diff --git a/README.md b/README.md
@@ -182,8 +182,13 @@ See the [man page][man] or `man jt` in your terminal.
 
 The [man page][man] has many examples.
 
+## SEE ALSO
+
+**Jt** is based on ideas from the excellent [jshon][jshon] tool.
+
 ## COPYRIGHT
 
 Copyright © 2017 Micha Niskin. Distributed under the Eclipse Public License.
 
 [man]: http://htmlpreview.github.io/?https://raw.githubusercontent.com/micha/json-table/master/jt.1.html
+[jshon]: http://kmkeen.com/jshon/
diff --git a/jt.1 b/jt.1
@@ -275,10 +275,51 @@ Otherwise, \fB@\fR prints the type of the item, or \fI[none]\fR if there is no v
 .
 .nf
 
-$ echo \'"hello world"\' | jt @
+$ echo \'["hello", "world"]\' | jt @
 [string]
+.
+.fi
+.
+.IP "" 0
+.
+.IP "" 4
+.
+.nf
+
+$ echo \'[1, 2]\' | jt @
+[number]
+.
+.fi
+.
+.IP "" 0
+.
+.IP "" 4
+.
+.nf
 
-$ echo {} | jt foo @
+$ echo \'[true, false]\' | jt @
+[boolean]
+.
+.fi
+.
+.IP "" 0
+.
+.IP "" 4
+.
+.nf
+
+$ echo \'[null, null]\' | jt @
+[null]
+.
+.fi
+.
+.IP "" 0
+.
+.IP "" 4
+.
+.nf
+
+$ echo \'[]\' | jt @
 [none]
 .
 .fi
@@ -391,7 +432,7 @@ $ jt foo bar % <<EOT
 .IP "" 0
 .
 .P
-The \fB%\fR command can be used multiple times\. The printed values will be delimited by tabs:
+The \fB%\fR command can be used multiple times\. The printed values will be separated by tabs:
 .
 .IP "" 4
 .
@@ -411,7 +452,10 @@ $ jt % foo % bar % <<EOT
 .IP "" 0
 .
 .SS "Save / Restore"
-The \fB[\fR and \fB]\fR commands provide a sort of \fBGOSUB\fR facility\. Use \fB[\fR to save the data stack\'s state on the gosub stack\. Then drill down and print a value\. The \fB]\fR command pops the gosub stack and restores the data stack to that state\. Now it is possible to drill down into a different path to print another value:
+The \fB[\fR and \fB]\fR commands provide a way to save the data stack\'s state before performing some operations and restore it afterwards\. This makes it possible to drill down into one part of an object and then "rewind" to drill down into another part of the same object\.
+.
+.P
+The \fB[\fR command saves the state of the data stack and the \fB]\fR command restores the data stack to the corresponding saved state\. It is an error to use the \fB]\fR command without a corresponding \fB[\fR command\.
 .
 .IP "" 4
 .
@@ -877,5 +921,11 @@ foo     1       bar     200
 .
 .IP "" 0
 .
+.SH "SEE ALSO"
+\fBJt\fR is based on ideas from the excellent \fBjshon\fR tool, which can be found at \fIhttp://kmkeen\.com/jshon/\fR\. Source code for \fBjt\fR is available at \fIhttps://github\.com/micha/json\-table\fR\.
+.
+.SH "BUGS"
+Please open an issue here: \fIhttps://github\.com/micha/json\-table/issues\fR\.
+.
 .SH "COPYRIGHT"
 Copyright © 2017 Micha Niskin \fB<micha\.niskin@gmail\.com>\fR, distributed under the Eclipse Public License, version 1\.0\. This is free software: you are free to change and redistribute it\. There is NO WARRANTY, to the extent permitted by law\.
diff --git a/jt.1.html b/jt.1.html
diff --git a/jt.1.ronn b/jt.1.ronn
@@ -237,10 +237,27 @@ bar
 Otherwise, `@` prints the type of the item, or <[none]> if there is no value:
 
 ```bash
-$ echo '"hello world"' | jt @
+$ echo '["hello", "world"]' | jt @
 [string]
+```
+
+```bash
+$ echo '[1, 2]' | jt @
+[number]
+```
+
+```bash
+$ echo '[true, false]' | jt @
+[boolean]
+```
+
+```bash
+$ echo '[null, null]' | jt @
+[null]
+```
 
-$ echo {} | jt foo @
+```bash
+$ echo '[]' | jt @
 [none]
 ```
 
@@ -324,7 +341,7 @@ $ jt foo bar % <<EOT
 100
 ```
 
-The `%` command can be used multiple times. The printed values will be delimited
+The `%` command can be used multiple times. The printed values will be separated
 by tabs:
 
 ```bash
@@ -340,10 +357,14 @@ $ jt % foo % bar % <<EOT
 
 ### Save / Restore
 
-The `[` and `]` commands provide a sort of `GOSUB` facility. Use `[` to save
-the data stack's state on the gosub stack. Then drill down and print a value.
-The `]` command pops the gosub stack and restores the data stack to that state.
-Now it is possible to drill down into a different path to print another value:
+The `[` and `]` commands provide a way to save the data stack's state before
+performing some operations and restore it afterwards. This makes it possible
+to drill down into one part of an object and then "rewind" to drill down into
+another part of the same object.
+
+The `[` command saves the state of the data stack and the `]` command restores
+the data stack to the corresponding saved state. It is an error to use the `]`
+command without a corresponding `[` command.
 
 ```bash
 $ jt [ foo % ] bar % <<EOT
@@ -687,6 +708,16 @@ foo     0       bar     100
 foo     1       bar     200
 ```
 
+## SEE ALSO
+
+**Jt** is based on ideas from the excellent **jshon** tool, which can be found
+at <http://kmkeen.com/jshon/>. Source code for **jt** is available at
+<https://github.com/micha/json-table>.
+
+## BUGS
+
+Please open an issue here: <https://github.com/micha/json-table/issues>.
+
 ## COPYRIGHT
 
 Copyright © 2017 Micha Niskin `<micha.niskin@gmail.com>`, distributed under
diff --git a/jt.c b/jt.c
@@ -11,7 +11,7 @@
 #define JT_STACKSIZE 256
 #endif
 
-#define JT_VERSION "4.3.2"
+#define JT_VERSION "4.3.3"
 
 int opt_join = 0;
 int opt_iter = 0;
@@ -42,8 +42,11 @@ int run(int wordc, word_t *wordv) {
 
   if (wordc <= 0) return 0;
 
-  if (d && ((js_is_array(js_tok(p, d)) && !opt_iter) || (e = (wordv[0].cmd == '.')))) {
-    if (!js_is_collection(js_tok(p, d)) || js_is_empty(js_tok(p, d))) {
+  if ((e = (wordv[0].cmd == '.')) || (d && js_is_array(js_tok(p, d)) && !opt_iter)) {
+    if (!d) {
+      stack_push(DAT, 0);
+      if (opt_join) cols = -JT_STACKSIZE;
+    } else if (!js_is_collection(js_tok(p, d)) || js_is_empty(js_tok(p, d))) {
       stack_push(DAT, 0);
       run(wordc - e, wordv + e);
       if (opt_join) cols = -JT_STACKSIZE;
@@ -67,11 +70,6 @@ int run(int wordc, word_t *wordv) {
     return cols;
   } else {
     switch (wordv[0].cmd) {
-      case '.':
-        // can only get here if top of stack is null
-        if (opt_join) return -JT_STACKSIZE;
-        stack_push(DAT, 0);
-        break;
       case '^':
         cols = 1;
         stack_push(OUT, stack_head(IDX));
@@ -213,7 +211,7 @@ void version() {
   printf("jt %s\n", JT_VERSION);
 #endif
   printf("\n");
-  printf("Copyright © 2017 Micha Niskin <micha.niskin@gmail.com>, distributed under\n");
+  printf("Copyright © 2017 by Micha Niskin <micha.niskin@gmail.com>, distributed under\n");
   printf("the Eclipse Public License, version 1.0. This is free software: you are free\n");
   printf("to change and redistribute it. There is NO WARRANTY, to the extent permitted\n");
   printf("by law.\n");
diff --git a/jt.tar.gz b/jt.tar.gz
diff --git a/test/test-jt.sh b/test/test-jt.sh
@@ -211,4 +211,8 @@ assert $LINENO \
 EOT
 )"
 
+assert $LINENO \
+  "$(echo '{}' |$jt . % && echo OK)" \
+  OK
+
 [[ $fails == 0 ]] || exit 1
