mirror/stedolan-jq
1
0
Fork 0
mirror of https://github.com/stedolan/jq.git synced 2024-05-11 05:55:39 +00:00
Code Issues Releases Activity
Files
stedolan-jq/jq.h

61 lines
2.1 KiB
C
Raw Normal View History

Fix header guards (fix #770)
2015-04-28 10:36:21 -05:00
#ifndef JQ_H
#define JQ_H
Separate the tests and the main program.
2012-09-18 22:17:13 +01:00
Add callback interface for errors Printing to stderr is not the right answer for a library.
2013-11-30 02:05:42 -06:00
#include <stdio.h>
Add libjq autoconf goo
2013-06-16 08:25:12 -05:00
#include <jv.h>
Add a --arg option to allow variables to be passed from the cmdline. Closes #107
2013-05-06 14:21:00 +01:00
Remove JQ_DEBUG #define and jq_test binary, simplifying build. The debugging features previously available via JQ_DEBUG are now command-line options.
2013-05-05 23:12:10 +01:00
enum {JQ_DEBUG_TRACE = 1};
Remove globals/make jq_init/next/teardown() an API
2013-04-28 18:33:45 -05:00
Add libjq autoconf goo
2013-06-16 08:25:12 -05:00
typedef struct jq_state jq_state;
Reduce number of msg callback typedefs
2015-02-13 15:28:30 -06:00
typedef void (*jq_msg_cb)(void *, jv);
Add callback interface for errors Printing to stderr is not the right answer for a library.
2013-11-30 02:05:42 -06:00
Fixup API to get closer to a libjq
2013-06-06 17:26:15 -05:00
jq_state *jq_init(void);
Reduce number of msg callback typedefs
2015-02-13 15:28:30 -06:00
void jq_set_error_cb(jq_state *, jq_msg_cb, void *);
void jq_get_error_cb(jq_state *, jq_msg_cb *, void **);
Fixup API to get closer to a libjq
2013-06-06 17:26:15 -05:00
void jq_set_nomem_handler(jq_state *, void (*)(void *), void *);
Add jq_report_error() function; use it Put a stop to fprintf(stderr, ...) where we shouldn't.
2014-08-11 17:25:09 -05:00
jv jq_format_error(jv msg);
void jq_report_error(jq_state *, jv);
Add `module` directive, `modulemeta` builtin Fix #425.
2014-08-10 16:52:03 -05:00
int jq_compile(jq_state *, const char*);
int jq_compile_args(jq_state *, const char*, jv);
Add libjq autoconf goo
2013-06-16 08:25:12 -05:00
void jq_dump_disassembly(jq_state *, int);
Add `module` directive, `modulemeta` builtin Fix #425.
2014-08-10 16:52:03 -05:00
void jq_start(jq_state *, jv value, int);
Remove globals/make jq_init/next/teardown() an API
2013-04-28 18:33:45 -05:00
jv jq_next(jq_state *);
void jq_teardown(jq_state **);
Separate the tests and the main program.
2012-09-18 22:17:13 +01:00
Add Streaming parser (--stream) Streaming means that outputs are produced as soon as possible. With the `foreach` syntax one can write programs which reduce portions of the streaming parse of a large input (reduce into proper JSON values, for example), and discard the rest, processing incrementally. This: $ jq -c --stream . should produce the same output as this: $ jq -c '. as $dot | path(..) as $p | $dot | getpath($p) | [$p,.]' The output of `jq --stream .` should be a sequence of`[[<path>],<leaf>]` and `[[<path>]]` values. The latter indicate that the array/object at that path ended. Scalars and empty arrays and objects are leaf values for this purpose. For example, a truncated input produces a path as soon as possible, then later the error: $ printf '[0,\n'|./jq -c --stream . [[0],0] parse error: Unfinished JSON term at EOF at line 3, column 0 $
2014-12-22 23:06:27 -06:00
typedef jv (*jq_input_cb)(jq_state *, void *);
void jq_set_input_cb(jq_state *, jq_input_cb, void *);
void jq_get_input_cb(jq_state *, jq_input_cb *, void **);
Reduce number of msg callback typedefs
2015-02-13 15:28:30 -06:00
void jq_set_debug_cb(jq_state *, jq_msg_cb, void *);
void jq_get_debug_cb(jq_state *, jq_msg_cb *, void **);
Add `debug` builtin And refactor setup of jv dump flags.
2014-12-27 17:15:56 -06:00
Add `module` directive, `modulemeta` builtin Fix #425.
2014-08-10 16:52:03 -05:00
void jq_set_attrs(jq_state *, jv);
jv jq_get_attrs(jq_state *);
Module search revamp for pkg managers The search path listed in an import directive can now be an array. The top-level search path is appended. Null and empty strings in the path terminate any search. The "." in "." and "./*" is replaced with the directory containing the file doing the import (for command-line programs this is the current directory, though that may be a bad idea). No version numbers or anything of the sort are gratuitously added to the search paths. All this makes external package managers possible by allowing dependencies to be installed local to dependents.
2014-11-24 17:58:34 -06:00
jv jq_get_jq_origin(jq_state *);
jv jq_get_prog_origin(jq_state *);
Added library system with -l, -L, and JQ_LIBRARY_PATH Created util.[ch] to hold common utilities.
2014-07-09 00:55:20 -04:00
jv jq_get_lib_dirs(jq_state *);
Add `module` directive, `modulemeta` builtin Fix #425.
2014-08-10 16:52:03 -05:00
void jq_set_attr(jq_state *, jv, jv);
jv jq_get_attr(jq_state *, jv);
Refactor moar: move parts of main.c into libjq This adds utility functions for reading and parsing files that should be easy to use by other apps, together with jq_start()/jq_next().
2015-02-01 18:35:42 -06:00
argv[] may not be UTF-8 (fix #811)
2015-06-18 21:24:41 -05:00
/*
* We use char * instead of jf for filenames here because filenames
* should be in the process' locale's codeset, which may not be UTF-8,
* whereas jv string values must be in UTF-8. This way the caller
* doesn't have to perform any codeset conversions.
*/
Make jq.h usable from C++ Previously, with clang++: jq.h:46:37: error: typedef redefinition with different types ('struct jq_util_input_state *' vs 'jq_util_input_state') With g++: jq.h:46:37: error: conflicting declaration ‘typedef struct jq_util_input_state* jq_util_input_state’ This typedef was added to libjq by commit 0d41447 which was after the 1.4 release, so although it is a public API, this is not a backcompat break because it has never been in a release. Specifying the "*" at all uses of jq_util_input_state is slightly tedious, but jq_state already works that way, so at least it will be consistent.
2015-07-04 14:56:07 -07:00
typedef struct jq_util_input_state jq_util_input_state;
argv[] may not be UTF-8 (fix #811)
2015-06-18 21:24:41 -05:00
typedef void (*jq_util_msg_cb)(void *, const char *);
Refactor moar: move parts of main.c into libjq This adds utility functions for reading and parsing files that should be easy to use by other apps, together with jq_start()/jq_next().
2015-02-01 18:35:42 -06:00
Make jq.h usable from C++ Previously, with clang++: jq.h:46:37: error: typedef redefinition with different types ('struct jq_util_input_state *' vs 'jq_util_input_state') With g++: jq.h:46:37: error: conflicting declaration ‘typedef struct jq_util_input_state* jq_util_input_state’ This typedef was added to libjq by commit 0d41447 which was after the 1.4 release, so although it is a public API, this is not a backcompat break because it has never been in a release. Specifying the "*" at all uses of jq_util_input_state is slightly tedious, but jq_state already works that way, so at least it will be consistent.
2015-07-04 14:56:07 -07:00
jq_util_input_state *jq_util_input_init(jq_util_msg_cb, void *);
void jq_util_input_set_parser(jq_util_input_state *, jv_parser *, int);
void jq_util_input_free(jq_util_input_state **);
void jq_util_input_add_input(jq_util_input_state *, const char *);
int jq_util_input_errors(jq_util_input_state *);
jv jq_util_input_next_input(jq_util_input_state *);
Refactor moar: move parts of main.c into libjq This adds utility functions for reading and parsing files that should be easy to use by other apps, together with jq_start()/jq_next().
2015-02-01 18:35:42 -06:00
jv jq_util_input_next_input_cb(jq_state *, void *);
Report filename:line on runtime errors (fix #752) With this patch, jq run-time errors printed to stderr will contain the filename and line of the offending input. But note that the JSON text parser does (yet) print the input filename on parse error. A jq run-time error is a jq program error, not including syntax errors nor JSON text input format errors. Examples: With stdin and multiple lines: $ printf '{"a":43}\n{"a":{"b":66}}\n' | ./jq '.a+1' 44 jq: error (at stdin:2): object and number cannot be added With multiple files: $ printf '{"a":43}' > 1.json $ printf '{"a":"hello"}\n' > 2.json $ printf '{"a":{"b":66}}\n' > 3.json $ ./jq '[.a]|@tsv' 1.json 2.json 3.json "43" "hello" jq: error (at 3.json:1): object is not valid in a csv row With very long lines (spanning multiple `fgets` calls): $ ( printf '{"a":43}\n' ; printf '{"a":{"b":[' ; seq 10000 | paste -d, -s | tr -d '\n' ; printf ']}}\n' ; printf '{"a":"hello"}\n' ) | ./jq '[.a] | @tsv' "43" jq: error (at stdin:2): object is not valid in a csv row "hello" With raw input: $ seq 1000 | ./jq --raw-input 'select(.=="700") | . + 10' jq: error (at stdin:700): string and number cannot be added Caveat: The reported line will be the last line of the (valid) parsed JSON data. Example: $ printf '{\n"a":\n"hello"\n\n\n}\n' | ./jq '.a+4' jq: error (at stdin:6): string and number cannot be added
2015-04-17 15:28:00 -04:00
jv jq_util_input_get_position(jq_state*);
Add filename/line functions to jq (fix #753) This adds `input_filename` and `input_line_number` built-in functions for use in, for example, `error` messages. Example: $ printf '{"a":1}\n{"a":2}\n' > 4.json $ printf '{"a":"hello"}\n' > 5.json $ ./jq '{ "file":input_filename, "line":input_line_number, "value":.a }' 4.json 5.json { "file": "4.json", "line": 1, "value": 1 } { "file": "4.json", "line": 2, "value": 2 } { "file": "5.json", "line": 1, "value": "hello" }
2015-04-17 16:08:10 -04:00
jv jq_util_input_get_current_filename(jq_state*);
jv jq_util_input_get_current_line(jq_state*);
Refactor moar: move parts of main.c into libjq This adds utility functions for reading and parsing files that should be easy to use by other apps, together with jq_start()/jq_next().
2015-02-01 18:35:42 -06:00
Fix header guards (fix #770)
2015-04-28 10:36:21 -05:00
#endif /* !JQ_H */
Copy Permalink