Headroom.FileSupport.Types

Data types for Headroom.FileSupport module in separated module (to avoid cyclic dependencies).

Data Types

data FileSupport

Set of functions that every file support needs to implement.

Constructors

FileSupport

Fields

• fsSyntaxAnalysis :: SyntaxAnalysis
• fsExtractTemplateData :: ExtractTemplateDataFn
• fsExtractVariables :: ExtractVariablesFn
• fsFileType :: FileType

data SyntaxAnalysis

Set of functions used to analyze source code.

Constructors

SyntaxAnalysis

Fields

• saIsCommentStart :: Text -> Bool
• saIsCommentEnd :: Text -> Bool

Smart Constructors

defaultFileSupport

Arguments

:: FileType

type of the source code file

-> SyntaxAnalysis

function that analyzes source code

-> FileSupport

resulting FileSupport

Default implementation of FileSupport that doesn't extract any variables or template data.

Function Type Aliases

type ExtractTemplateDataFn

Arguments

 = forall a. Template a

=> a

template to use for extraction

-> HeaderSyntax

copyright header syntax

-> TemplateData

extracted template data

Type of a function that extracts additional template data from template.

type ExtractVariablesFn

Arguments

 = HeaderTemplate

header template

-> Maybe (Int, Int)

header position as (startLine, endLine)

-> SourceCode

analyzed source code file

-> Variables

extracted variables

Type of a function that extracts variables from analyzed source code file.