Safe Haskell	None
Language	Haskell2010

Tokstyle.C.Linter

Synopsis

analyse :: [Text] -> CTranslUnit -> [LinterError]
analyseText :: [Text] -> CTranslUnit -> [Text]
allWarnings :: [Text]
markdown :: Text
renderIO :: [LinterError] -> IO [Doc AnsiStyle]
renderPure :: Map FilePath [Text] -> [LinterError] -> [Doc AnsiStyle]
type LinterError = Diagnostic CPosition
data DiagnosticLevel
- = ErrorLevel
- | WarningLevel
- | NoteLevel
- | HelpLevel
data Doc ann
data AnsiStyle
diagToText :: IsPosition pos => Diagnostic pos -> Text

Documentation

analyse :: [Text] -> CTranslUnit -> [LinterError] Source #

analyseText :: [Text] -> CTranslUnit -> [Text] Source #

allWarnings :: [Text] Source #

markdown :: Text Source #

renderIO :: [LinterError] -> IO [Doc AnsiStyle] Source #

renderPure :: Map FilePath [Text] -> [LinterError] -> [Doc AnsiStyle] Source #

type LinterError = Diagnostic CPosition Source #

data DiagnosticLevel #

Constructors

ErrorLevel
WarningLevel
NoteLevel
HelpLevel

Instances

Instances details

Eq DiagnosticLevel
Instance details Defined in Language.Cimple.Diagnostics Methods (==) :: DiagnosticLevel -> DiagnosticLevel -> Bool # (/=) :: DiagnosticLevel -> DiagnosticLevel -> Bool #
Ord DiagnosticLevel
Instance details Defined in Language.Cimple.Diagnostics Methods compare :: DiagnosticLevel -> DiagnosticLevel -> Ordering # (<) :: DiagnosticLevel -> DiagnosticLevel -> Bool # (<=) :: DiagnosticLevel -> DiagnosticLevel -> Bool # (>) :: DiagnosticLevel -> DiagnosticLevel -> Bool # (>=) :: DiagnosticLevel -> DiagnosticLevel -> Bool # max :: DiagnosticLevel -> DiagnosticLevel -> DiagnosticLevel # min :: DiagnosticLevel -> DiagnosticLevel -> DiagnosticLevel #
Show DiagnosticLevel
Instance details Defined in Language.Cimple.Diagnostics Methods showsPrec :: Int -> DiagnosticLevel -> ShowS # show :: DiagnosticLevel -> String # showList :: [DiagnosticLevel] -> ShowS #

data Doc ann #

The abstract data type Doc ann represents pretty documents that have been annotated with data of type ann.

More specifically, a value of type Doc represents a non-empty set of possible layouts of a document. The layout functions select one of these possibilities, taking into account things like the width of the output document.

The annotation is an arbitrary piece of data associated with (part of) a document. Annotations may be used by the rendering backends in order to display output differently, such as

color information (e.g. when rendering to the terminal)
mouseover text (e.g. when rendering to rich HTML)
whether to show something or not (to allow simple or detailed versions)

The simplest way to display a Doc is via the Show class.

>>> putStrLn (show (vsep ["hello", "world"]))
hello
world

Instances

Instances details

Functor Doc	Alter the document’s annotations. This instance makes `Doc` more flexible (because it can be used in `Functor`-polymorphic values), but `fmap` is much less readable compared to using `reAnnotate` in code that only works for `Doc` anyway. Consider using the latter when the type does not matter.
Instance details Defined in Prettyprinter.Internal Methods fmap :: (a -> b) -> Doc a -> Doc b # (<$) :: a -> Doc b -> Doc a #
Show (Doc ann)	`(show doc)` prettyprints document `doc` with `defaultLayoutOptions`, ignoring all annotations.
Instance details Defined in Prettyprinter.Internal Methods showsPrec :: Int -> Doc ann -> ShowS # show :: Doc ann -> String # showList :: [Doc ann] -> ShowS #
IsString (Doc ann)	`>>>` `pretty ("hello\nworld")`hello world This instance uses the `Pretty` `Text` instance, and uses the same newline to `line` conversion.
Instance details Defined in Prettyprinter.Internal Methods fromString :: String -> Doc ann #
Generic (Doc ann)
Instance details Defined in Prettyprinter.Internal Associated Types type Rep (Doc ann) :: Type -> Type # Methods from :: Doc ann -> Rep (Doc ann) x # to :: Rep (Doc ann) x -> Doc ann #
Semigroup (Doc ann)	x `<>` y = `hcat` [x, y] `>>>` `"hello" <> "world" :: Doc ann`helloworld
Instance details Defined in Prettyprinter.Internal Methods (<>) :: Doc ann -> Doc ann -> Doc ann # sconcat :: NonEmpty (Doc ann) -> Doc ann # stimes :: Integral b => b -> Doc ann -> Doc ann #
Monoid (Doc ann)	`mempty` = `emptyDoc` `mconcat` = `hcat` `>>>` `mappend "hello" "world" :: Doc ann`helloworld
Instance details Defined in Prettyprinter.Internal Methods mempty :: Doc ann # mappend :: Doc ann -> Doc ann -> Doc ann # mconcat :: [Doc ann] -> Doc ann #
type Rep (Doc ann)
Instance details Defined in Prettyprinter.Internal type Rep (Doc ann) = D1 ('MetaData "Doc" "Prettyprinter.Internal" "prettyprinter-1.7.1-d967ca11eb55b59e3d0598391d0dde25f09a835b0f0e872c80ac6346f0a62806" 'False) (((C1 ('MetaCons "Fail" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Empty" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Char" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Char)))) :+: (C1 ('MetaCons "Text" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "Line" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FlatAlt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)))))) :+: ((C1 ('MetaCons "Cat" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann))) :+: (C1 ('MetaCons "Nest" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Int) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann))) :+: C1 ('MetaCons "Union" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann))))) :+: ((C1 ('MetaCons "Column" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Int -> Doc ann))) :+: C1 ('MetaCons "WithPageWidth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PageWidth -> Doc ann)))) :+: (C1 ('MetaCons "Nesting" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Int -> Doc ann))) :+: C1 ('MetaCons "Annotated" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ann) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ann)))))))

data AnsiStyle #

Render the annotated document in a certain style. Styles not set in the annotation will use the style of the surrounding document, or the terminal’s default if none has been set yet.

style = color Green <> bold
styledDoc = annotate style "hello world"

Instances

Instances details

Eq AnsiStyle
Instance details Defined in Prettyprinter.Render.Terminal.Internal Methods (==) :: AnsiStyle -> AnsiStyle -> Bool # (/=) :: AnsiStyle -> AnsiStyle -> Bool #
Ord AnsiStyle
Instance details Defined in Prettyprinter.Render.Terminal.Internal Methods compare :: AnsiStyle -> AnsiStyle -> Ordering # (<) :: AnsiStyle -> AnsiStyle -> Bool # (<=) :: AnsiStyle -> AnsiStyle -> Bool # (>) :: AnsiStyle -> AnsiStyle -> Bool # (>=) :: AnsiStyle -> AnsiStyle -> Bool # max :: AnsiStyle -> AnsiStyle -> AnsiStyle # min :: AnsiStyle -> AnsiStyle -> AnsiStyle #
Show AnsiStyle
Instance details Defined in Prettyprinter.Render.Terminal.Internal Methods showsPrec :: Int -> AnsiStyle -> ShowS # show :: AnsiStyle -> String # showList :: [AnsiStyle] -> ShowS #
Semigroup AnsiStyle	Keep the first decision for each of foreground color, background color, boldness, italication, and underlining. If a certain style is not set, the terminal’s default will be used. Example: `color` `Red` `<>` `color` `Green` is red because the first color wins, and not bold because (or if) that’s the terminal’s default.
Instance details Defined in Prettyprinter.Render.Terminal.Internal Methods (<>) :: AnsiStyle -> AnsiStyle -> AnsiStyle # sconcat :: NonEmpty AnsiStyle -> AnsiStyle # stimes :: Integral b => b -> AnsiStyle -> AnsiStyle #
Monoid AnsiStyle	`mempty` does nothing, which is equivalent to inheriting the style of the surrounding doc, or the terminal’s default if no style has been set yet.
Instance details Defined in Prettyprinter.Render.Terminal.Internal Methods mempty :: AnsiStyle # mappend :: AnsiStyle -> AnsiStyle -> AnsiStyle # mconcat :: [AnsiStyle] -> AnsiStyle #

diagToText :: IsPosition pos => Diagnostic pos -> Text #