BNFC.Utils

Documentation

type ModuleName = String

The name of a module, e.g. Foo.Abs, Foo.Print etc.

when :: Monoid m => Bool -> m -> m

Generalization of when.

unless :: Monoid m => Bool -> m -> m

Generalization of unless.

unlessNull :: Monoid m => [a] -> ([a] -> m) -> m

Invoke continuation for non-empty list.

unlessNull' :: Monoid m => [a] -> (a -> [a] -> m) -> m

Invoke continuation for non-empty list.

applyWhen :: Bool -> (a -> a) -> a -> a

when for the monoid of endofunctions 'a -> a'.

applyUnless :: Bool -> (a -> a) -> a -> a

unless for the monoid of endofunctions 'a -> a'.

for :: [a] -> (a -> b) -> [b]

Non-monadic forM.

whenJust :: Monoid m => Maybe a -> (a -> m) -> m

Generalization of forM to Monoid.

caseMaybe :: Maybe a -> b -> (a -> b) -> b

Rotation of maybe.

(>.>) :: (a -> b) -> (b -> c) -> a -> c infixr 8

Diagrammatic composition.

curry3 :: ((a, b, c) -> d) -> a -> b -> c -> d

Converts an uncurried function to a curried function.

uncurry3 :: (a -> b -> c -> d) -> (a, b, c) -> d

Converts a curried function to a function on a triple.

singleton :: a -> [a]

Give a telling name to the electric monkey.

headWithDefault :: a -> [a] -> a

Get the first element of a list, fallback for empty list.

mapHead :: (a -> a) -> [a] -> [a]

Apply a function to the head of a list.

spanEnd :: (a -> Bool) -> [a] -> ([a], [a])

spanEnd p l == reverse (span p (reverse l)).

Invariant: l == front ++ end where (end, front) = spanEnd p l

(From package ghc, module Util.)

duplicatesOn :: (Foldable t, Ord b) => (a -> b) -> t a -> [List1 a]

Returns lists of elements whose normal form appears more than once.

>>> duplicatesOn id  [5,1,2,5,1]
[1 :| [1],5 :| [5]]
>>> duplicatesOn abs [5,-5,1]
[5 :| [-5]]

groupOn :: Eq b => (a -> b) -> [a] -> [List1 a]

Group consecutive elements that have the same normalform.

uniqOn :: Eq b => (a -> b) -> [a] -> [a]

Keep only the first of consecutive elements that have the same normalform.

hasNumericSuffix :: String -> Maybe (String, Integer)

Get a numeric suffix if it exists.

>>> hasNumericSuffix "hello world"
Nothing
>>> hasNumericSuffix "a1b2"
Just ("a1b",2)
>>> hasNumericSuffix "1234"
Just ("",1234)

(+++) :: String -> String -> String infixr 5

Concatenate strings by a space.

(++++) :: String -> String -> String infixr 5

Concatenate strings by a newline.

(+-+) :: String -> String -> String infixr 5

Concatenate strings by an underscore.

(+.+) :: String -> String -> String infixr 5

Concatenate strings by a dot.

parensIf :: Bool -> String -> String

Wrap in parentheses if condition holds.

pad :: Int -> String -> String

Pad a string on the right by spaces to reach the desired length.

table :: String -> [[String]] -> [String]

Make a list of rows with left-aligned columns from a matrix.

mkName :: [String] -> NameStyle -> String -> String

Generate a name in the given case style taking into account the reserved word of the language. Note that despite the fact that those name are mainly to be used in code rendering (type Doc), we return a String here to allow further manipulation of the name (like disambiguation) which is not possible in the Doc type.

Examples:

>>> mkName [] LowerCase "FooBAR"
"foobar"

>>> mkName [] UpperCase "FooBAR"
"FOOBAR"

>>> mkName [] SnakeCase "FooBAR"
"foo_bar"

>>> mkName [] CamelCase "FooBAR"
"FooBAR"

>>> mkName [] CamelCase "Foo_bar"
"FooBar"

>>> mkName [] MixedCase "FooBAR"
"fooBAR"

>>> mkName ["foobar"] LowerCase "FooBAR"
"foobar_"

>>> mkName ["foobar", "foobar_"] LowerCase "FooBAR"
"foobar__"

mkNames :: [String] -> NameStyle -> [String] -> [String]

Same as above but accept a list as argument and make sure that the names generated are uniques.

>>> mkNames ["c"] LowerCase ["A", "b_", "a_", "c"]
["a1","b","a2","c_"]

data NameStyle

Different case style

Constructors

LowerCase

e.g. lowercase

UpperCase

e.g. UPPERCASE

SnakeCase

e.g. snake_case

CamelCase

e.g. CamelCase

MixedCase

e.g. mixedCase

OrigCase

Keep original capitalization and form.

Instances

Show NameStyle

Defined in BNFC.Utils

Methods

showsPrec :: Int -> NameStyle -> ShowS

show :: NameStyle -> String

showList :: [NameStyle] -> ShowS

Eq NameStyle

Defined in BNFC.Utils

Methods

(==) :: NameStyle -> NameStyle -> Bool

(/=) :: NameStyle -> NameStyle -> Bool

capitalize :: String -> String

Make first letter uppercase.

lowerCase :: String -> Doc

Ident to lower case. >>> lowerCase MyIdent myident

upperCase :: String -> Doc

Ident to upper case. >>> upperCase MyIdent MYIDENT

mixedCase :: String -> Doc

To mixed case. >>> mixedCase "my_ident" myIdent

camelCase :: String -> Doc

Ident to camel case. >>> camelCase "my_ident" MyIdent

camelCase_ :: String -> String

snakeCase :: String -> Doc

To snake case. >>> snakeCase MyIdent my_ident

snakeCase_ :: String -> String

replace

Arguments

:: Eq a

=> a

Value to replace

-> a

Value to replace it with

-> [a]

-> [a]

Replace all occurences of a value by another value

writeFileRep :: FilePath -> String -> IO ()

Write a file, after making a backup of an existing file with the same name. If an old version of the file exist and the new version is the same, keep the old file and don't create a .bak file. / New version by TH, 2010-09-23

cstring :: String -> Doc

A function that renders a c-like string with escaped characters. Note that although it's called cstring, this can be used with most (all) backend as they seem to mostly share escaping conventions. The c in the name is barely an homage for C being the oldest language in the lot.

>>> cstring "foobar"
"foobar"

>>> cstring "foobar\""
"foobar\""

getZonedTimeTruncatedToSeconds :: IO ZonedTime

symbolToName :: String -> Maybe String

Print a symbol as typical token name, like "(" as LPAREN.