string-combinators-0.1: Data/String/Combinators.hs

{-# LANGUAGE OverloadedStrings #-}

-----------------------------------------------------------------------------
-- |
-- Module      :  Data.String.Combinators
-- Copyright   :  (c) 2009 Bas van Dijk
-- License     :  BSD-style (see the file LICENSE)
--
-- Maintainer  :  Bas van Dijk <v.dijk.bas@gmail.com>
-- Stability   :  Stable
-- Portability :  Requires OverloadedStrings
--
-- Note that I am thinking about putting some of the combinators
-- (('<>'), ('<+>'), ('$$') and maybe more) in a type class. This
-- allows the \'pretty\' package to use this package.
--
-----------------------------------------------------------------------------

module Data.String.Combinators
    (
      -- * Combining
      (<>)
    , mid
    , (<+>)
    , ($$)
    , hcat
    , hsep
    , vcat
    , punctuate

     -- * Wrapping in delimiters
    , between

    , paren
    , brackets
    , braces
    , angleBrackets
    , quotes
    , doubleQuotes

      -- * From characters
    , char

    , semi
    , colon
    , comma
    , space
    , newline
    , equals
    , lparen
    , rparen
    , lbrack
    , rbrack
    , lbrace
    , rbrace
    , labrack
    , rabrack

      -- * From showable values
    , fromShow

    , int
    , integer
    , float
    , double
    , rational

    )
    where


import Data.String
import Data.Monoid


----------------------------------------------------------------------
-- Combining
----------------------------------------------------------------------

-- | Put two strings besides eachother.
-- Note that '<>' is just a synonym for 'mappend'.
(<>) :: Monoid s => s -> s -> s
(<>) = mappend

-- | @mid m x y@ Puts @x@ and @y@ around @m@.
-- Note that: @mid m x y =@ 'between' @x y m@
mid :: Monoid s => s -> (s -> s -> s)
mid m x y = between x y m

-- | Put two strings besides eachother separated by a space.
(<+>) :: (Monoid s, IsString s) => s -> s -> s
(<+>) = mid space

-- | Put two strings above eachother.
($$) :: (Monoid s, IsString s) => s -> s -> s
($$) = mid newline

infixl 6 <>
infixl 6 <+>
infixl 5 $$

-- | List version of '<>'
hcat :: Monoid s => [s] -> s
hcat = foldr (<>) mempty

-- | List version of '<+>'
hsep :: (Monoid s, IsString s) => [s] -> s
hsep = foldr (<+>) mempty

-- | List version of '$$'
vcat :: (Monoid s, IsString s) =>  [s] -> s
vcat = foldr ($$) mempty

-- | @punctuate p [d1, ... dn] = [d1 \<> p, d2 \<> p, ... dn-1 \<> p, dn]@

-- Shamelessly copied from 'pretty':
punctuate :: (Monoid s) => s -> [s] -> [s]
punctuate _ []     = []
punctuate p (d:ds) = go d ds
    where
      go d' []     = [d']
      go d' (e:es) = (d' <> p) : go e es


----------------------------------------------------------------------
-- Wrapping in delimiters
----------------------------------------------------------------------

-- | @between b c s@ wraps the string @s@ between @b@ and @c@
between :: (Monoid s) => s -> s -> (s -> s)
between open close x = open <> x <> close


-- | wrap a string in @(...)@
paren :: (Monoid s, IsString s) => s -> s
paren = between "(" ")"

-- | wrap a string in @[...]@
brackets :: (Monoid s, IsString s) => s -> s
brackets = between "[" "]"

-- | wrap a string in @{...}@
braces :: (Monoid s, IsString s) => s -> s
braces = between "{" "}"

-- | wrap a string in @\<...\>@
angleBrackets :: (Monoid s, IsString s) => s -> s
angleBrackets = between "<" ">"

-- | wrap a string in @\'...\'@
quotes :: (Monoid s, IsString s) => s -> s
quotes = between "'" "'"

-- | wrap a string in @\"...\"@
doubleQuotes :: (Monoid s, IsString s) => s -> s
doubleQuotes = between "\"" "\""


----------------------------------------------------------------------
-- From characters
----------------------------------------------------------------------

-- | convert a character to a string
char :: IsString s => Char -> s
char c = fromString [c]


-- | A ';' character
semi :: IsString s => s
semi = char ';'

-- | A ':' character
colon :: IsString s => s
colon = char ':'

-- | A ',' character
comma :: IsString s => s
comma = char ','

-- | A ' ' character
space :: IsString s => s
space = char ' '

-- | A '\n' character
newline :: IsString s => s
newline = char '\n'

-- | A '=' character
equals :: IsString s => s
equals = char '='

-- | A '(' character
lparen :: IsString s => s
lparen = char '('

-- | A ')' character
rparen :: IsString s => s
rparen = char ')'

-- | A '[' character
lbrack :: IsString s => s
lbrack = char '['

-- | A ']' character
rbrack :: IsString s => s
rbrack = char ']'

-- | A '{' character
lbrace :: IsString s => s
lbrace = char '{'

-- | A '}' character
rbrace :: IsString s => s
rbrace = char '}'

-- | A \'<\' character
labrack :: IsString s => s
labrack = char '<'

-- | A \'>\' character
rabrack :: IsString s => s
rabrack = char '>'


----------------------------------------------------------------------
-- From showable values
----------------------------------------------------------------------

-- | Convert a Show-able value to a string.
-- @fromShow = fromString . show@
fromShow :: (Show a, IsString s) => a -> s
fromShow = fromString . show


int :: IsString s => Int -> s
int = fromShow

integer :: IsString s => Integer -> s
integer = fromShow

float :: IsString s => Float -> s
float = fromShow

double :: IsString s => Double -> s
double = fromShow

rational :: IsString s => Rational -> s
rational = fromShow


-- The End -----------------------------------------------------------