Include column number in parser and compiler error messages

[liviubobocu]

Suggestion for issue:
#3256

Open for improvements :)

Resolves #1027, resolves #2334, and resolves #3256.

[itchyny]

Please edit parser.y and use bison to generate parser.c.

[itchyny]

I think line and column should be 1-origin. Like JSON parse error.

 $ printf '[' | jq .
jq: parse error: Unfinished JSON term at EOF at line 1, column 1

[liviubobocu]

thank you! will do a followup with the changes

[liviubobocu]

hello, @itchyny, I have made an update, but I feel uneasy with the token removals that bison did upon generation. build succeeded and I have also changed tests. I'm not sure it is enough. Thank you!

[itchyny]

You have to use ./configure --enable-maintainer-mode flag and make to generate parser code.

[liviubobocu]

regenerated with maintainer mode

[itchyny]

Why?

[liviubobocu]

I thought initially that it was added by hand, I have changed it back

[itchyny]

Let's focus on adding just at line %d, column %d in this pull request for merging with fewer objections. I don't like long error messages like this, and don't like the existing platform-dependent shell quoting issue message, but such improvement can be done after adding the line position report.

[liviubobocu]

updated

[itchyny]

We shouldn't get the column number here, we should fix locfile_locate to include the column position in the message.

[itchyny]

I can't understand the intention behind %*s", ..., loc.start - offset, ""), but this looks like the column position. Fixing this message will give better error messages (I will submit aPR).

diff --git a/src/locfile.c b/src/locfile.c
index 2a4f18e..a3e0e36 100644
--- a/src/locfile.c
+++ b/src/locfile.c
@@ -82,10 +82,11 @@ void locfile_locate(struct locfile* l, location loc, const char* fmt, ...) {
     jv_free(m1);
     return;
   }
-  jv m2 = jv_string_fmt("%s at %s, line %d:\n%.*s%*s", jv_string_value(m1),
-                        jv_string_value(l->fname), startline + 1,
+  jv m2 = jv_string_fmt("%s at %s, line %d, column %d:\n    %.*s\n    %*s",
+      jv_string_value(m1), jv_string_value(l->fname),
+      startline + 1, loc.start - offset + 1,
       locfile_line_length(l, startline), l->data + offset,
-                        loc.start - offset, "");
+      loc.start - offset + 1, "^");
   jv_free(m1);
   jq_report_error(l->jq, m2);
   return;

 $ ./jq -n $'1 + 2,\n3 @ 4,\n5 * 6'
jq: error: syntax error, unexpected INVALID_CHARACTER, expecting end of file (Unix shell quoting issues?) at <top-level>, line 2, column 3:
    3 @ 4,
      ^

[liviubobocu]

@itchyny updated with changes to locfile

[itchyny]

Thanks for continued improvements to my infrequent comments. I'll improve the message reporting the position within a separate PR. Thanks anyway.