mirror of
https://github.com/wader/fq.git
synced 2024-11-23 18:56:52 +03:00
692 lines
20 KiB
Plaintext
692 lines
20 KiB
Plaintext
include "internal";
|
|
include "funcs";
|
|
include "args";
|
|
include "query";
|
|
|
|
# will include all per format specific function etc
|
|
include "@format/decode";
|
|
include "@format/all";
|
|
|
|
# optional user init
|
|
include "@config/init?";
|
|
|
|
|
|
# def readline: #:: [a]| => string
|
|
# Read a line.
|
|
|
|
# def readline($prompt): #:: [a]|(string) => string
|
|
# Read a line with prompt.
|
|
|
|
# def readline($prompt; $completion): #:: [a]|(string;string) => string
|
|
# $prompt is prompt to show.
|
|
# $completion name of completion function [a](string) => [string],
|
|
# it will be called with same input as readline and a string argument being the
|
|
# current line from start to current cursor position. Should return possible completions.
|
|
|
|
# try to be same exit codes as jq
|
|
# TODO: jq seems to halt processing inputs on JSON decode error but not IO errors,
|
|
# seems strange.
|
|
# jq '(' <(echo 1) <(echo 2) ; echo $? => 3 and no inputs processed
|
|
# jq '.' missing <(echo 2) ; echo $? => 2 and continues process inputs
|
|
# jq '.' <(echo 'a') <(echo 123) ; echo $? => 4 and stops process inputs
|
|
# jq '.' missing <(echo 'a') <(echo 123) ; echo $? => 2 ???
|
|
# jq '"a"+.' <(echo '"a"') <(echo 1) ; echo $? => 5
|
|
# jq '"a"+.' <(echo 1) <(echo '"a"') ; echo $? => 0
|
|
def _exit_code_args_error: 2;
|
|
def _exit_code_input_io_error: 2;
|
|
def _exit_code_compile_error: 3;
|
|
def _exit_code_input_decode_error: 4;
|
|
def _exit_code_expr_error: 5;
|
|
|
|
|
|
# . will have additional array of options taking priority
|
|
# NOTE: is called from go *interp.Interp Options()
|
|
def options($opts):
|
|
[_default_options] + _options_stack + $opts | add;
|
|
def options: options([{}]);
|
|
|
|
def _obj_to_csv_kv:
|
|
[to_entries[] | [.key, .value] | join("=")] | join(",");
|
|
|
|
def _build_default_options:
|
|
( (null | stdout) as $stdout
|
|
| {
|
|
addrbase: 16,
|
|
arraytruncate: 50,
|
|
bitsformat: "snippet",
|
|
bytecolors: "0-0xff=brightwhite,0=brightblack,32-126:9-13=white",
|
|
color: ($stdout.is_terminal and env.CLICOLOR != null),
|
|
colors: (
|
|
{
|
|
null: "brightblack",
|
|
false: "yellow",
|
|
true: "yellow",
|
|
number: "cyan",
|
|
string: "green",
|
|
objectkey: "brightblue",
|
|
array: "white",
|
|
object: "white",
|
|
index: "white",
|
|
value: "white",
|
|
error: "brightred",
|
|
dumpheader: "yellow+underline",
|
|
dumpaddr: "yellow"
|
|
} | _obj_to_csv_kv
|
|
),
|
|
compact: false,
|
|
decode_format: "probe",
|
|
decode_progress: (env.NODECODEPROGRESS == null),
|
|
depth: 0,
|
|
# TODO: intdiv 2 * 2 to get even number, nice or maybe not needed?
|
|
displaybytes: (if $stdout.is_terminal then [intdiv(intdiv($stdout.width; 8); 2) * 2, 4] | max else 16 end),
|
|
expr: ".",
|
|
expr_file: null,
|
|
expr_eval_path: "arg",
|
|
filenames: ["-"],
|
|
include_path: null,
|
|
join_string: "\n",
|
|
linebytes: (if $stdout.is_terminal then [intdiv(intdiv($stdout.width; 8); 2) * 2, 4] | max else 16 end),
|
|
null_input: false,
|
|
raw_output: ($stdout.is_terminal | not),
|
|
raw_string: false,
|
|
repl: false,
|
|
sizebase: 10,
|
|
show_formats: false,
|
|
show_help: false,
|
|
show_options: false,
|
|
slurp: false,
|
|
string_input: false,
|
|
unicode: ($stdout.is_terminal and env.CLIUNICODE != null),
|
|
verbose: false,
|
|
}
|
|
);
|
|
|
|
def _toboolean:
|
|
try
|
|
if . == "true" then true
|
|
elif . == "false" then false
|
|
else tonumber != 0
|
|
end
|
|
catch
|
|
null;
|
|
|
|
def _tonumber:
|
|
try tonumber catch null;
|
|
|
|
def _tostring:
|
|
if . != null then "\"\(.)\"" | fromjson end;
|
|
|
|
def _toarray:
|
|
if . != null then
|
|
( fromjson
|
|
| if type != "array" then null end
|
|
)
|
|
end;
|
|
|
|
def _to_options:
|
|
( {
|
|
addrbase: (.addrbase | _tonumber),
|
|
arraytruncate: (.arraytruncate | _tonumber),
|
|
bitsformat: (.bitsformat | _tostring),
|
|
bytecolors: (.bytecolors | _tostring),
|
|
color: (.color | _toboolean),
|
|
colors: (.colors | _tostring),
|
|
compact: (.compact | _toboolean),
|
|
decode_format: (.decode_format | _tostring),
|
|
decode_progress: (.decode_progress | _toboolean),
|
|
depth: (.depth | _tonumber),
|
|
displaybytes: (.displaybytes | _tonumber),
|
|
expr: (.expr | _tostring),
|
|
expr_file: (.expr_file | _tostring),
|
|
filename: (.filenames | _toarray),
|
|
include_path: (.include_path | _tostring),
|
|
join_string: (.join_string | _tostring),
|
|
linebytes: (.linebytes | _tonumber),
|
|
null_input: (.null_input | _toboolean),
|
|
raw_output: (.raw_output | _toboolean),
|
|
raw_string: (.raw_string | _toboolean),
|
|
repl: (.repl | _toboolean),
|
|
sizebase: (.sizebase | _tonumber),
|
|
show_formats: (.show_formats | _toboolean),
|
|
show_help: (.show_help | _toboolean),
|
|
show_options: (.show_options | _toboolean),
|
|
slurp: (.slurp | _toboolean),
|
|
string_input: (.string_input | _toboolean),
|
|
unicode: (.unicode | _toboolean),
|
|
verbose: (.verbose | _toboolean),
|
|
}
|
|
| with_entries(select(.value != null))
|
|
);
|
|
|
|
|
|
# TODO: refactor this
|
|
# TODO: completionMode
|
|
# TODO: return escaped identifier, not sure current readline implementation supports
|
|
# completions that needs to change previous input, ex: .a\t -> ."a \" b" etc
|
|
def _complete($e; $cursor_pos):
|
|
def _is_internal: startswith("_") or startswith("$_");
|
|
def _query_index_or_key($q):
|
|
( ([.[] | eval($q) | type]) as $n
|
|
| if ($n | all(. == "object")) then "."
|
|
elif ($n | all(. == "array")) then "[]"
|
|
else null
|
|
end
|
|
);
|
|
# only complete if at end of there is a whitespace for now
|
|
if ($e[$cursor_pos] | . == "" or . == " ") then
|
|
( . as $c
|
|
| ( $e[0:$cursor_pos] | _complete_query) as {$type, $query, $prefix}
|
|
| {
|
|
prefix: $prefix,
|
|
names: (
|
|
if $type == "none" then
|
|
( $c
|
|
| _query_index_or_key($query)
|
|
| if . then [.] else [] end
|
|
)
|
|
else
|
|
( $c
|
|
| eval($query)
|
|
| ($prefix | _is_internal) as $prefix_is_internal
|
|
| map(
|
|
select(
|
|
strings and
|
|
(_is_ident or $type == "variable") and
|
|
((_is_internal | not) or $prefix_is_internal or $type == "index") and
|
|
startswith($prefix)
|
|
)
|
|
)
|
|
| unique
|
|
| sort
|
|
| if length == 1 and .[0] == $prefix then
|
|
( $c
|
|
| _query_index_or_key($e)
|
|
| if . then [$prefix+.] else [$prefix] end
|
|
)
|
|
end
|
|
)
|
|
end
|
|
)
|
|
}
|
|
)
|
|
else
|
|
{prefix: "", names: []}
|
|
end;
|
|
def _complete($e): _complete($e; $e | length);
|
|
|
|
|
|
def _prompt:
|
|
def _type_name_error:
|
|
( . as $c
|
|
| try
|
|
( _display_name
|
|
, if ._error then "!" else empty end
|
|
)
|
|
catch ($c | type)
|
|
);
|
|
def _path_prefix:
|
|
(._path? // []) | if . == [] then "" else path_to_expr + " " end;
|
|
def _preview:
|
|
if format != null or type != "array" then
|
|
_type_name_error
|
|
else
|
|
( "["
|
|
, if length > 0 then (.[0] | _type_name_error) else empty end
|
|
, if length > 1 then ", ..." else empty end
|
|
, "]"
|
|
, if length > 1 then "[\(length)]" else empty end
|
|
)
|
|
end;
|
|
( [ (_options_stack | length | if . > 2 then ((.-2) * ">") + " " else empty end)
|
|
, if length == 0 then
|
|
"empty"
|
|
else
|
|
( .[0]
|
|
| _path_prefix
|
|
, _preview
|
|
)
|
|
end
|
|
, if length > 1 then ", [\(length)]" else empty end
|
|
, "> "
|
|
]
|
|
) | join("");
|
|
|
|
|
|
# TODO: better way? what about nested eval errors?
|
|
def _eval_is_compile_error: type == "object" and .error != null and .what != null;
|
|
def _eval_compile_error_tostring:
|
|
"\(.filename // "src"):\(.line):\(.column): \(.error)";
|
|
|
|
def _eval($e; $filename; f; on_error; on_compile_error):
|
|
( _default_options(_build_default_options) as $_
|
|
| try eval($e; $filename) | f
|
|
catch
|
|
if _eval_is_compile_error then on_compile_error
|
|
else on_error
|
|
end
|
|
);
|
|
|
|
def _repl_display: display({depth: 1});
|
|
def _repl_on_error:
|
|
( if _eval_is_compile_error then _eval_compile_error_tostring end
|
|
| (_error_str | println)
|
|
);
|
|
def _repl_on_compile_error: _repl_on_error;
|
|
def _repl_eval($e): _eval($e; "repl"; _repl_display; _repl_on_error; _repl_on_compile_error);
|
|
|
|
# run read-eval-print-loop
|
|
def _repl($opts): #:: a|(Opts) => @
|
|
def _read_expr:
|
|
# both _prompt and _complete want arrays
|
|
( . as $c
|
|
| readline(_prompt; "_complete")
|
|
| if trim == "" then
|
|
$c | _read_expr
|
|
end
|
|
);
|
|
|
|
def _repl_loop:
|
|
( . as $c
|
|
| try
|
|
( _read_expr as $expr
|
|
# TODO: catch error here?
|
|
| $expr
|
|
| try _query_fromstring
|
|
# TODO: nicer way to set filename
|
|
catch (. | .filename = "repl")
|
|
| if _query_pipe_last | _query_is_func("repl") then
|
|
( _query_slurp_wrap(_query_func_rename("_repl_iter"))
|
|
| _query_tostring as $wrap_expr
|
|
| $c
|
|
| _repl_eval($wrap_expr)
|
|
)
|
|
else
|
|
( $c
|
|
| .[]
|
|
| _repl_eval($expr)
|
|
)
|
|
end
|
|
)
|
|
catch
|
|
if . == "interrupt" then empty
|
|
elif . == "eof" then error("break")
|
|
elif _eval_is_compile_error then _repl_on_error
|
|
else error(.)
|
|
end
|
|
);
|
|
( _options_stack(. + [$opts]) as $_
|
|
| _finally(
|
|
_repeat_break(_repl_loop);
|
|
_options_stack(.[:-1])
|
|
)
|
|
);
|
|
|
|
def _repl_iter($opts): _repl($opts);
|
|
def _repl_iter: _repl({});
|
|
|
|
# just gives error, call appearing last will be renamed to _repl_iter
|
|
def repl($_): error("repl must be last");
|
|
def repl: error("repl must be last");
|
|
|
|
|
|
def _cli_expr_on_error:
|
|
( . as $err
|
|
| _cli_last_expr_error($err) as $_
|
|
| (_error_str | _errorln)
|
|
);
|
|
def _cli_expr_on_compile_error:
|
|
( _eval_compile_error_tostring
|
|
| halt_error(_exit_code_compile_error)
|
|
);
|
|
# _cli_expr_eval halts on compile errors
|
|
def _cli_expr_eval($e; $filename; f): _eval($e; $filename; f; _cli_expr_on_error; _cli_expr_on_compile_error);
|
|
def _cli_expr_eval($e; $filename): _eval($e; $filename; .; _cli_expr_on_error; _cli_expr_on_compile_error);
|
|
|
|
# next valid input
|
|
def input:
|
|
def _input($opts; f):
|
|
( _input_filenames
|
|
| if length == 0 then error("break") end
|
|
| [.[0], .[1:]] as [$h, $t]
|
|
| _input_filenames($t)
|
|
| _input_filename(null) as $_
|
|
| $h
|
|
| try
|
|
( open
|
|
| _input_filename($h) as $_
|
|
| .
|
|
)
|
|
catch
|
|
( . as $err
|
|
| _input_io_errors(. += {($h): $err}) as $_
|
|
| $err
|
|
| (_error_str | _errorln)
|
|
, _input($opts; f)
|
|
)
|
|
| try f
|
|
catch
|
|
( . as $err
|
|
| _input_decode_errors(. += {($h): $err}) as $_
|
|
| "\($h): failed to decode (\($opts.decode_format)), try -d FORMAT to force"
|
|
| (_error_str | _errorln)
|
|
, _input($opts; f)
|
|
)
|
|
);
|
|
# TODO: don't rebuild options each time
|
|
( options as $opts
|
|
# TODO: refactor into def
|
|
# this is a bit strange as jq for --raw-string can return string instead
|
|
# with data from multiple inputs
|
|
| if $opts.string_input then
|
|
( _input_strings_lines
|
|
| if . then
|
|
# we're already iterating lines
|
|
if length == 0 then error("break")
|
|
else
|
|
( [.[0], .[1:]] as [$h, $t]
|
|
| _input_strings_lines($t)
|
|
| $h
|
|
)
|
|
end
|
|
else
|
|
( [_repeat_break(_input($opts; tobytes | tostring))]
|
|
| join("") as $all
|
|
| if $opts.slurp then
|
|
# jq --raw-input combined with --slurp reads all inputs into a string
|
|
# make next input break
|
|
( _input_strings_lines([]) as $_
|
|
| $all
|
|
)
|
|
else
|
|
# TODO: different line endings?
|
|
# jq strips last newline, "a\nb" and "a\nb\n" behaves the same
|
|
# also jq -R . <(echo -ne 'a\nb') <(echo c) produces "a" and "bc"
|
|
( _input_strings_lines(
|
|
( $all
|
|
| rtrimstr("\n")
|
|
| split("\n")
|
|
)
|
|
) as $_
|
|
| input
|
|
)
|
|
end
|
|
)
|
|
end
|
|
)
|
|
else _input($opts; decode($opts.decode_format))
|
|
end
|
|
);
|
|
|
|
# iterate all valid inputs
|
|
def inputs: _repeat_break(input);
|
|
|
|
def input_filename: _input_filename;
|
|
|
|
def var: _variables;
|
|
def var($k; f):
|
|
( . as $c
|
|
| if ($k | _is_ident | not) then error("invalid variable name: \($k)") end
|
|
| _variables(.[$k] |= f)
|
|
| empty
|
|
);
|
|
def var($k): . as $c | var($k; $c);
|
|
|
|
# TODO: introspect and show doc, reflection somehow?
|
|
def help:
|
|
( "Type jq expression to evaluate"
|
|
, "\\t Auto completion"
|
|
, "Up/Down History"
|
|
, "^C Interrupt execution"
|
|
, "^D Exit REPL"
|
|
) | println;
|
|
|
|
def _main:
|
|
def _formats_list:
|
|
[ ( formats
|
|
| to_entries[]
|
|
| [(.key+" "), .value.description]
|
|
)
|
|
]
|
|
| table(
|
|
.;
|
|
map(
|
|
( . as $rc
|
|
| .string
|
|
| if $rc.column != 1 then rpad(" "; $rc.maxwidth) end
|
|
)
|
|
) | join("")
|
|
);
|
|
def _opts($version):
|
|
{
|
|
"compact": {
|
|
short: "-c",
|
|
long: "--compact-output",
|
|
description: "Compact output",
|
|
bool: true
|
|
},
|
|
"decode_format": {
|
|
short: "-d",
|
|
long: "--decode",
|
|
description: "Decode format (probe)",
|
|
string: "NAME"
|
|
},
|
|
"expr_file": {
|
|
short: "-f",
|
|
long: "--from-file",
|
|
description: "Read EXPR from file",
|
|
string: "PATH"
|
|
},
|
|
"show_formats": {
|
|
long: "--formats",
|
|
description: "Show supported formats",
|
|
bool: true
|
|
},
|
|
"show_help": {
|
|
short: "-h",
|
|
long: "--help",
|
|
description: "Show help",
|
|
bool: true
|
|
},
|
|
"join_output": {
|
|
short: "-j",
|
|
long: "--join-output",
|
|
description: "No newline between outputs",
|
|
bool: true
|
|
},
|
|
# TODO: multiple paths
|
|
"include_path": {
|
|
short: "-L",
|
|
long: "--include-path",
|
|
description: "Include search path",
|
|
array: "PATH"
|
|
},
|
|
"null_output": {
|
|
short: "-0",
|
|
long: "--null-output",
|
|
# for jq compatibility
|
|
aliases: ["--nul-output"],
|
|
description: "Null byte between outputs",
|
|
bool: true
|
|
},
|
|
"null_input": {
|
|
short: "-n",
|
|
long: "--null-input",
|
|
description: "Null input (use input/0 and inputs/0 to read input)",
|
|
bool: true
|
|
},
|
|
"option": {
|
|
short: "-o",
|
|
long: "--option",
|
|
description: "Set option, eg: color=true",
|
|
object: "KEY=VALUE",
|
|
},
|
|
"show_options": {
|
|
long: "--options",
|
|
description: "Show all options",
|
|
bool: true
|
|
},
|
|
"string_input": {
|
|
short: "-R",
|
|
long: "--raw-input",
|
|
description: "Read raw input strings (don't decode)",
|
|
bool: true
|
|
},
|
|
"raw_string": {
|
|
short: "-r",
|
|
# for jq compat, is called raw string internally, "raw output" is if
|
|
# we can output raw bytes or not
|
|
long: "--raw-output",
|
|
description: "Raw string output (without quotes)",
|
|
bool: true
|
|
},
|
|
"repl": {
|
|
short: "-i",
|
|
long: "--repl",
|
|
description: "Interactive REPL",
|
|
bool: true
|
|
},
|
|
"slurp": {
|
|
short: "-s",
|
|
long: "--slurp",
|
|
description: "Read (slurp) all inputs into an array",
|
|
bool: true
|
|
},
|
|
"show_version": {
|
|
short: "-v",
|
|
long: "--version",
|
|
description: "Show version (\($version))",
|
|
bool: true
|
|
},
|
|
};
|
|
def _banner:
|
|
( "fq - jq for files"
|
|
, "Tool, language and decoders for exploring binary data."
|
|
, "For more information see https://github.com/wader/fq"
|
|
);
|
|
def _usage($arg0; $version):
|
|
"Usage: \($arg0) [OPTIONS] [--] [EXPR] [FILE...]";
|
|
( . as {$version, $args, args: [$arg0]}
|
|
| (null | [stdin, stdout]) as [$stdin, $stdout]
|
|
# make sure we don't unintentionally use . to make things clearer
|
|
| null
|
|
| ( try args_parse($args[1:]; _opts($version))
|
|
catch halt_error(_exit_code_args_error)
|
|
) as {parsed: $parsed_args, $rest}
|
|
| _default_options(_build_default_options) as $_
|
|
# combine --args and -o key=value args
|
|
| ( ($parsed_args.option | _to_options)
|
|
+ $parsed_args
|
|
) as $args_opts
|
|
| _options_stack(
|
|
[ $args_opts
|
|
+ ( {
|
|
expr: (
|
|
( $args_opts.expr_file
|
|
| if . then
|
|
try (open | tobytes | tostring)
|
|
catch halt_error(_exit_code_args_error)
|
|
else $rest[0] // null
|
|
end
|
|
)
|
|
),
|
|
expr_eval_path: $args_opts.expr_file,
|
|
filenames: (
|
|
( if $args_opts.expr_file then $rest
|
|
else $rest[1:]
|
|
end
|
|
| if . == [] then null end
|
|
)
|
|
),
|
|
join_string: (
|
|
if $args_opts.join_output then ""
|
|
elif $args_opts.null_output then "\u0000"
|
|
else null
|
|
end
|
|
),
|
|
null_input: (
|
|
( if $args_opts.expr_file then $rest
|
|
else $rest[1:]
|
|
end
|
|
| if . == [] and $args_opts.repl then true
|
|
else null
|
|
end
|
|
)
|
|
),
|
|
raw_string: (
|
|
if $args_opts.raw_string
|
|
or $args_opts.join_output
|
|
or $args_opts.null_output
|
|
then true
|
|
else null
|
|
end
|
|
)
|
|
}
|
|
| with_entries(select(.value != null))
|
|
)
|
|
]
|
|
) as $_
|
|
| options as $opts
|
|
| if $opts.show_help then
|
|
( _banner
|
|
, ""
|
|
, _usage($arg0; $version)
|
|
, args_help_text(_opts($version))
|
|
) | println
|
|
elif $opts.show_version then
|
|
$version | println
|
|
elif $opts.show_formats then
|
|
_formats_list | println
|
|
elif $opts.show_options then
|
|
$opts | display
|
|
elif
|
|
( ($rest | length) == 0 and
|
|
($opts.repl | not) and
|
|
($opts.expr_file | not) and
|
|
$stdin.is_terminal and $stdout.is_terminal
|
|
) then
|
|
( (( _usage($arg0; $version), "\n") | stderr)
|
|
, null | halt_error(_exit_code_args_error)
|
|
)
|
|
else
|
|
# use _finally as display etc prints and results in empty
|
|
_finally(
|
|
( _include_paths($opts.include_path) as $_
|
|
| _input_filenames($opts.filenames) as $_ # store inputs
|
|
| ( def _inputs:
|
|
( if $opts.null_input then null
|
|
# note jq --slurp --raw-string is special, will be just
|
|
# a string not an array
|
|
elif $opts.string_input then inputs
|
|
elif $opts.slurp then [inputs]
|
|
else inputs
|
|
end
|
|
);
|
|
if $opts.repl then
|
|
( [_inputs]
|
|
| map(_cli_expr_eval($opts.expr; $opts.expr_eval_path))
|
|
| _repl({})
|
|
)
|
|
else
|
|
( _inputs
|
|
# iterate all inputs
|
|
| _cli_last_expr_error(null) as $_
|
|
| _cli_expr_eval($opts.expr; $opts.expr_eval_path; _repl_display)
|
|
)
|
|
end
|
|
)
|
|
)
|
|
; # finally
|
|
( if _input_io_errors then
|
|
null | halt_error(_exit_code_input_io_error)
|
|
end
|
|
| if _input_decode_errors then
|
|
null | halt_error(_exit_code_input_decode_error)
|
|
end
|
|
| if _cli_last_expr_error then
|
|
null | halt_error(_exit_code_expr_error)
|
|
end
|
|
)
|
|
)
|
|
end
|
|
);
|