2014-02-20 17:00:34 +00:00
{- git - annex command
-
2015-01-21 16:50:09 +00:00
- Copyright 2014 Joey Hess < id @ joeyh . name >
2014-02-20 17:00:34 +00:00
-
2019-03-13 19:48:14 +00:00
- Licensed under the GNU AGPL version 3 or higher .
2014-02-20 17:00:34 +00:00
- }
module Command.VFilter where
import Command
import Annex.View
2014-03-02 18:53:19 +00:00
import Command.View ( paramView , checkoutViewBranch )
2014-02-20 17:00:34 +00:00
2015-07-08 16:33:27 +00:00
cmd :: Command
2019-08-26 19:52:19 +00:00
cmd = notBareRepo $
2015-07-08 19:08:02 +00:00
command " vfilter " SectionMetaData " filter current view "
paramView ( withParams seek )
2014-02-20 17:00:34 +00:00
2015-07-08 19:08:02 +00:00
seek :: CmdParams -> CommandSeek
2018-10-01 18:12:06 +00:00
seek = withWords ( commandAction . start )
2014-02-20 17:00:34 +00:00
start :: [ String ] -> CommandStart
2020-09-14 20:49:33 +00:00
start params = starting " vfilter " ( ActionItemOther Nothing ) ( SeekInput params ) $
2014-02-20 17:00:34 +00:00
withCurrentView $ \ view -> do
let view' = filterView view $
map parseViewParam $ reverse params
make CommandStart return a StartMessage
The goal is to be able to run CommandStart in the main thread when -J is
used, rather than unncessarily passing it off to a worker thread, which
incurs overhead that is signficant when the CommandStart is going to
quickly decide to stop.
To do that, the message it displays needs to be displayed in the worker
thread, after the CommandStart has run.
Also, the change will mean that CommandStart will no longer necessarily
run with the same Annex state as CommandPerform. While its docs already
said it should avoid modifying Annex state, I audited all the
CommandStart code as part of the conversion. (Note that CommandSeek
already sometimes runs with a different Annex state, and that has not been
a source of any problems, so I am not too worried that this change will
lead to breakage going forward.)
The only modification of Annex state I found was it calling
allowMessages in some Commands that default to noMessages. Dealt with
that by adding a startCustomOutput and a startingUsualMessages.
This lets a command start with noMessages and then select the output it
wants for each CommandStart.
One bit of breakage: onlyActionOn has been removed from commands that used it.
The plan is that, since a StartMessage contains an ActionItem,
when a Key can be extracted from that, the parallel job runner can
run onlyActionOn' automatically. Then commands won't need to worry about
this detail. Future work.
Otherwise, this was a fairly straightforward process of making each
CommandStart compile again. Hopefully other behavior changes were mostly
avoided.
In a few cases, a command had a CommandStart that called a CommandPerform
that then called showStart multiple times. I have collapsed those
down to a single start action. The main command to perhaps suffer from it
is Command.Direct, which used to show a start for each file, and no
longer does.
Another minor behavior change is that some commands used showStart
before, but had an associated file and a Key available, so were changed
to ShowStart with an ActionItemAssociatedFile. That will not change the
normal output or behavior, but --json output will now include the key.
This should not break it for anyone using a real json parser.
2019-06-06 19:42:30 +00:00
next $ if visibleViewSize view' > visibleViewSize view
2016-11-16 01:29:54 +00:00
then giveup " That would add an additional level of directory structure to the view, rather than filtering it. If you want to do that, use vadd instead of vfilter. "
2014-02-20 17:00:34 +00:00
else checkoutViewBranch view' narrowView
