Add completions for mkvextract #3492

occivink · 2016-10-25T23:03:48Z

Mostly useful for the dynamic tracks and attachments completions.

Much like mkvextract, mkvmerge is part of mkvtoolnix so it should be okay to rely on it for completions.

I only did mkvextract because the others are much more complicated to provide useful completions for, but I might try to do them in the future.

occivink · 2016-10-26T08:19:40Z

Is that just a spurious error? I can't make sense of the message

line 2165: autosuggest_suggest_special() failed for command cd ~haha
Error: Test failed on line 2045: !comps.empty()

faho · 2016-10-26T12:23:55Z

@occivink: Yes, we've been having some trouble with travis lately. That test has nothing to do with your changes. Just ignore it for now.

faho · 2016-10-26T12:28:36Z

share/completions/mkvextract.fish

+complete -f -c mkvextract -n "test (count (commandline -opc)) -lt 2"    -s V -l "version" -d "Show version information"
+complete -f -c mkvextract -n "test (count (commandline -opc)) -lt 2"    -s h -l "help"    -d "Show help"
+# commands
+complete -f -c mkvextract -n "test (count (commandline -opc)) -lt 2" -a "tracks"       -d "Extract tracks to external files"


Most of the time, commands support options also before subcommands, i.e. something like mkvextract --parse-fully tags would also work. If that is the case here, just counting the number of tokens would break.

Can you confirm if it is?

I can confirm it doesn't accept options before subcommands.

faho · 2016-10-26T12:29:25Z

share/completions/mkvextract.fish

@@ -0,0 +1,47 @@
+# Sample output of 'mkvmerge -i file.mkv'


Thank you for this.

Well, thank you for working on fish.

faho · 2016-10-26T12:30:27Z

share/completions/mkvextract.fish

+# Chapters: 7 entires
+
+function __fish_print_mkvextract_attachments
+    mkvmerge -i $argv | string match 'Attachment ID*' | string replace -r '.*?(\d+).*? type \'(.*?)\'.*?file name \'(.*?)\'' '$1:\t$3 ($2)'


If I'm reading this correctly, the completion itself has a trailing ":". Is that correct? Is "1:" really the expected argument?

Yes, how it works is you actually specify
mkvextract tracks file.mkv 2:audio.aac 3:subtitles.ass
And the files audio.aac and subtitles.ass will be created. The name of the output file is up to the user, the completion only proposes available streams.

It's actually rather convenient that it doesn't automatically add a space if the completion ends in : but that's not configurable, right? I would need that with completions ending in = to make useful dynamic ones for mkvpropedit

faho · 2016-10-26T12:31:23Z

share/completions/mkvextract.fish

+complete -f -c mkvextract -n "test (count (commandline -opc)) -ge 3" -r      -l "output-charset"       -d "Outputs messages in specified charset"
+complete -f -c mkvextract -n "test (count (commandline -opc)) -ge 3" -r -s r -l "redirect-output"      -d "Redirect all messages into a file"
+# command-specific options
+complete -f -c mkvextract -n "test (count (commandline -opc)) -ge 3; and contains -- (commandline -opc)[2] tracks"   -r -s c                      -d "Convert text subtitles to a charset"


We'd usually write this test as __fish_seen_subcommand_from tracks - that will also skip all options.

I'll fix that

occivink · 2016-10-26T14:54:49Z

Somewhat offtopic, but do you know if ffmpeg completions have ever been considered? It's a popular application so I would expect so, but then it has a rather unconventional interface so it might not be possible. Because auto-completing streams from the input file would be pretty nice.

occivink · 2016-10-30T14:15:01Z

Okay I realized that generic options can be specified before the mkv file (contrary to what the help says), which breaks the assumption made by:
(__fish_print_mkvextract_tracks (commandline -opc)[3])
What would be a fishy way to iterate through arguments and check if they're actually a file?

Tangentially, do you know of some non-trivial completions that are well implemented and that I could draw inspiration from?

faho · 2016-10-31T09:03:45Z

What would be a fishy way to iterate through arguments and check if they're actually a file?

You don't want "actually a file". You want "a non-option after the command".

Tangentially, do you know of some non-trivial completions that are well implemented and that I could draw inspiration from?

Our biggest and possibly best completion script is the one for git, and it does this:

function __fish_git_needs_command
    set cmd (commandline -opc)
    if [ (count $cmd) -eq 1 ]
        return 0
    else
        set -l skip_next 1
        # Skip first word because it's "git" or a wrapper
        for c in $cmd[2..-1]
            test $skip_next -eq 0
            and set skip_next 1
            and continue
            # git can only take a few options before a command, these are the ones mentioned in the "git" man page
            # e.g. `git --follow log` is wrong, `git --help log` is okay (and `git --help log $branch` is superfluous but works)
            # In case any other option is used before a command, we'll fail, but that's okay since it's invalid anyway
            switch $c
                # General options that can still take a command
                case "--help" "-p" "--paginate" "--no-pager" "--bare" "--no-replace-objects" --{literal,glob,noglob,icase}-pathspecs --{exec-path,git-dir,work-tree,namespace}"=*"
                    continue
                    # General options with an argument we need to skip. The option=value versions have already been handled above
                case --{exec-path,git-dir,work-tree,namespace}
                    set skip_next 0
                    continue
                    # General options that cause git to do something and exit - these behave like commands and everything after them is ignored
                case "--version" --{html,man,info}-path
                    return 1
                    # We assume that any other token that's not an argument to a general option is a command
                case "*"
                    echo $c
                    return 1
            end
        end
        return 0
    end
    return 1
end

to determine if a command has been given. As you can see, this also handles options that take arguments (--work-tree /some/path).

occivink · 2016-11-06T14:46:32Z

Okay that should fix all edge cases I was aware of.
Other question, is there a way to get both the output and the return code of a command into two variables?

For example, I do

set -l matroska (__fish_mkvextract_find_matroska_in_args)
if test -n '$matroska'

but it'd be nicer to just use the return code of the command. I couldn't find how to do that though.

faho · 2016-11-06T16:04:54Z

Other question, is there a way to get both the output and the return code of a command into two variables?

set won't alter $status, so you can just use that.

set -l matroska (__fish_mkvextract_find_matroska_in_args)
if test $status -eq 0

or even

if set -l matroska (__fish_mkvextract_find_matroska_in_args)

(of course, if you'd like to use it later, you'll need to save it to another variable)

faho · 2016-11-06T16:08:05Z

share/completions/mkvextract.fish

-function __fish_print_mkvextract_attachments
-    mkvmerge -i $argv | string match 'Attachment ID*' | string replace -r '.*?(\d+).*? type \'(.*?)\'.*?file name \'(.*?)\'' '$1:\t$3 ($2)'
+function __fish_mkvextract_find_matroska_in_args
+    for c in (commandline -opc)[2..-1]


Of note is that this will fail if there is no second token (because of our annoying habit of failing invalid array indices).

This doesn't occur here because this is only ever called if there is already a subcommand, so there's no pressing need to change it.

occivink · 2016-11-06T18:00:14Z

Yet another question, it seems like paths starting with ~ (or containing a variable) are not working properly because they're not expanded by the shell. How can I handle that?

faho · 2016-11-06T18:17:26Z

@occivink: Don't. We need a helper function to do that, because a few completions currently try via eval (btw, please don't do that).

occivink · 2016-11-06T18:24:30Z

Okay thanks, I thought that there might have been a function to do that.

faho · 2016-11-10T19:23:21Z

share/completions/mkvextract.fish

@@ -8,7 +8,11 @@
 # Chapters: 7 entires

 function __fish_mkvextract_find_matroska_in_args
-    for c in (commandline -opc)[2..-1]
+    set -l cmd (commandline -opc)
+    if test (count $cmd) -lt 3


if not set -q cmd[3]

faho · 2016-11-10T19:24:42Z

share/completions/mkvextract.fish

-        mkvmerge -i $matroska | string match 'Attachment ID*' | string replace -r '.*?(\d+).*? type \'(.*?)\'.*?file name \'(.*?)\'' '$1:\t$3 ($2)'
+    if set -l matroska (__fish_mkvextract_find_matroska_in_args)
+        if set -l info (mkvmerge -i $matroska)
+            string match 'Attachment ID*' $info | string replace -r '.*?(\d+).*? type \'(.*?)\'.*?file name \'(.*?)\'' '$1:\t$3 ($2)'


Ideally, you'd guard the "$info" from being interpreted as options: string match 'Attachment ID*' -- $info. Otherwise if a line is e.g. -r, string will go into regex mode.

faho · 2016-11-10T19:24:57Z

share/completions/mkvextract.fish

-        mkvmerge -i $matroska | string match 'Track ID*' | string replace -r '.*?(\d+): (.*)' '$1:\t$2'
+    if set -l matroska (__fish_mkvextract_find_matroska_in_args)
+        if set -l info (mkvmerge -i $matroska)
+            string match 'Track ID*' $info | string replace -r '.*?(\d+): (.*)' '$1:\t$2'


occivink · 2016-11-10T21:02:57Z

Happy to comply, thanks for the tips.

faho · 2016-11-18T11:28:01Z

@occivink: Are you done here?

occivink · 2016-11-18T12:39:46Z

Yes I am.

faho · 2016-11-18T13:39:29Z

Merged, thanks!

occivink · 2016-11-18T15:58:01Z

Thanks for all the feedback.

add completions for mkvextract

4066e67

faho reviewed Oct 26, 2016

View reviewed changes

faho added enhancement completions labels Oct 26, 2016

fix edge cases with option placement in mkvextract.fish

b1e03ae

faho reviewed Nov 6, 2016

View reviewed changes

improve resiliency to errors in mkvextract.fish

f4104db

faho requested changes Nov 10, 2016

View reviewed changes

minor fixes in mkvextract.fish

d577424

faho approved these changes Nov 17, 2016

View reviewed changes

faho added this to the fish 2.5.0 milestone Nov 17, 2016

faho merged commit 8423345 into fish-shell:master Nov 18, 2016

github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2020

Add completions for mkvextract #3492

Add completions for mkvextract #3492

occivink commented Oct 25, 2016

occivink commented Oct 26, 2016

faho commented Oct 26, 2016

faho Oct 26, 2016

occivink Oct 26, 2016

faho Oct 26, 2016

occivink Oct 26, 2016

faho Oct 26, 2016

occivink Oct 26, 2016 •

edited

faho Oct 26, 2016

occivink Oct 26, 2016

occivink commented Oct 26, 2016

occivink commented Oct 30, 2016

faho commented Oct 31, 2016

occivink commented Nov 6, 2016 •

edited

faho commented Nov 6, 2016

faho Nov 6, 2016

occivink commented Nov 6, 2016

faho commented Nov 6, 2016

occivink commented Nov 6, 2016

faho Nov 10, 2016

faho Nov 10, 2016

faho Nov 10, 2016

occivink commented Nov 10, 2016

faho commented Nov 18, 2016

occivink commented Nov 18, 2016

faho commented Nov 18, 2016

occivink commented Nov 18, 2016

Add completions for mkvextract #3492

Add completions for mkvextract #3492

Conversation

occivink commented Oct 25, 2016

occivink commented Oct 26, 2016

faho commented Oct 26, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

occivink Oct 26, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

occivink commented Oct 26, 2016

occivink commented Oct 30, 2016

faho commented Oct 31, 2016

occivink commented Nov 6, 2016 • edited

faho commented Nov 6, 2016

Choose a reason for hiding this comment

occivink commented Nov 6, 2016

faho commented Nov 6, 2016

occivink commented Nov 6, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

occivink commented Nov 10, 2016

faho commented Nov 18, 2016

occivink commented Nov 18, 2016

faho commented Nov 18, 2016

occivink commented Nov 18, 2016

occivink Oct 26, 2016 •

edited

occivink commented Nov 6, 2016 •

edited