]> git.wincent.com - docvim.git/blob - lib/Docvim/Visitor/Functions.hs
90ac33a576d9e7e00f0c39c1f6273ccb44cab1b2
[docvim.git] / lib / Docvim / Visitor / Functions.hs
1 module Docvim.Visitor.Functions (extractFunctions) where
2
3 import Control.Applicative (Alternative)
4 import Docvim.AST (Node(FunctionsAnnotation))
5 import Docvim.Visitor (endBlock, extractBlocks)
6
7 -- | Extracts a list of nodes (if any exist) from the `@functions` section(s) of
8 -- the source code.
9 --
10 -- It is not recommended to have multiple `@functions` 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 extractFunctions :: Alternative f => [Node] -> (f [Node], [Node])
15 extractFunctions = extractBlocks f
16   where
17     f x = if x == FunctionsAnnotation
18           then Just endBlock
19           else Nothing