Safe Haskell	Safe
Language	Haskell2010

FreeC.IR.Syntax.Pragma

Description

This module contains the definition of comments and pragmas for our intermediate language.

Synopsis

data Comment
- = BlockComment {
  - commentSrcSpan :: SrcSpan
  - commentText :: String
  }
- | LineComment {
  - commentSrcSpan :: SrcSpan
  - commentText :: String
  }
customPragmaPrefix :: String
data Pragma = DecArgPragma {
- pragmaSrcSpan :: SrcSpan
- decArgPragmaFuncName :: QName
- decArgPragmaArg :: Either String Int
}
prettyPragma :: Doc -> Doc

Documentation

data Comment Source #

A comment.

Comments are collected during parsing. However, the final AST contains no comments. Pragmas (see DecArgPragma) are extracted from comments by the front end.

A single-line comment (i.e., -- ...).

Constructors

BlockComment	A multi-line comment (i.e., `{- ... -}`).
Fields commentSrcSpan :: SrcSpan commentText :: String
LineComment
Fields commentSrcSpan :: SrcSpan commentText :: String

Instances

Pretty Comment Source #	Pretty instance for comments.
Instance details Defined in FreeC.IR.Syntax.Pragma Methods pretty :: Comment -> Doc # prettyList :: [Comment] -> Doc #

customPragmaPrefix :: String Source #

All custom pragmas of the compiler start with FreeC.

data Pragma Source #

Data type for custom {-# FreeC ... #-} pragmas.

Constructors

DecArgPragma	A `{-# FreeC function DECREASES ON argument #-}` or `{-# FreeC function DECREASES ON ARGUMENT index #-}` pragma.
Fields pragmaSrcSpan :: SrcSpan decArgPragmaFuncName :: QName decArgPragmaArg :: Either String Int

Instances

Eq Pragma Source #
Instance details Defined in FreeC.IR.Syntax.Pragma Methods (==) :: Pragma -> Pragma -> Bool Source # (/=) :: Pragma -> Pragma -> Bool Source #
Show Pragma Source #
Instance details Defined in FreeC.IR.Syntax.Pragma Methods showsPrec :: Int -> Pragma -> ShowS Source # show :: Pragma -> String Source # showList :: [Pragma] -> ShowS Source #
Pretty Pragma Source #	Pretty instance for custom `{-# FreeC ... #-}` pragmas.
Instance details Defined in FreeC.IR.Syntax.Pragma Methods pretty :: Pragma -> Doc # prettyList :: [Pragma] -> Doc #
Similar Pragma Source #	Two pragmas are similar if they are equal except for the source span.
Instance details Defined in FreeC.IR.Similar Methods similar' :: Pragma -> Pragma -> Renaming -> Bool

prettyPragma :: Doc -> Doc Source #

Pretty prints a custom {-# FreeC ... #-} pragma with the given contents.