]> git.wincent.com - docvim.git/blob - lib/Docvim/Visitor/Commands.hs
Initial cut at @mapping, @command, @option, @function
[docvim.git] / lib / Docvim / Visitor / Commands.hs
1 module Docvim.Visitor.Commands (extractCommands) where
2
3 import Control.Applicative (Alternative)
4 import Docvim.AST (Node(CommandsAnnotation))
5 import Docvim.Visitor (endSection, extractBlocks)
6
7 -- | Extracts a list of nodes (if any exist) from the `@commands` section(s) of
8 -- the source code.
9 --
10 -- It is not recommended to have multiple `@commands` sections in a project. If
11 -- multiple such sections (potentially across multiple translation units) exist,
12 -- there are no guarantees about order; they just get concatenated in the order
13 -- we see them.
14 extractCommands :: Alternative f => [Node] -> (f [Node], [Node])
15 extractCommands = extractBlocks f
16   where
17     f x = if x == CommandsAnnotation
18           then Just endSection
19           else Nothing