The do-list package

[Tags:benchmark, bsd3, library, test]

Please see README.md


[Skip to Readme]

Properties

Versions 0.8.0, 0.8.1, 0.9.0, 0.9.1, 1.0.0, 1.0.1
Change log changelog.md
Dependencies base (<5) [details]
License BSD3
Copyright 2016 Taras Serduke
Author Taras Serduke
Maintainer taras.serduke@gmail.com
Category Data, List, Syntax
Home page https://github.com/tserduke/do-list#readme
Bug tracker https://github.com/tserduke/do-list/issues
Source repository head: git clone https://github.com/tserduke/do-list.git
Uploaded Mon Sep 19 10:11:19 UTC 2016 by TarasSerduke
Distributions LTSHaskell:1.0.1, NixOS:1.0.1, Stackage:1.0.1, Tumbleweed:1.0.1
Downloads 303 total (25 in the last 30 days)
Votes
0 []
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for do-list

Readme for do-list-1.0.1

do-list do-list do-list

Do notation for free.

Summary

do-list makes it easy to use do notation. You can construct lists or monoids using DoList or DoMonoid modules respectively. do-list is designed to work well with OverloadedStrings and OverloadedLists extensions. See examples.

As alternative there is a canonical Writer without overloading support.

Examples

Benchmarks

{-# LANGUAGE OverloadedLists #-}

module Main (main) where

import Criterion.Main
import Data.DoList (DoList, item, toList)

main :: IO ()
main = defaultMain $ toList $ do
  doBench "add"  $ whnf (2 +) (1 :: Int)
  doBench "sub" $ whnf (2 -) (1 :: Int)
  -- Regular criterion benchmarks are injected via list overloading
  [multBench, divBench]

multBench, divBench :: Benchmark
multBench = bench "mult" $ whnf (2 *) (2 :: Int)
divBench = bench "div" $ whnf (2 `div`) (2 :: Int)

-- Now we can define benchmarks with do notation.
doBench :: String -> Benchmarkable -> DoList Benchmark
doBench name = item . bench name

Multiline Text

{-# LANGUAGE OverloadedStrings #-}
{-# OPTIONS_GHC -fno-warn-unused-do-bind #-}

module Main (main) where

import Data.DoMonoid (runDoM)
import Data.Text.IO as T (putStr)

main :: IO ()
main = T.putStr $ runDoM $ do
  -- Lines are combined using Text.append
  "fib 0 = 0\n"
  "fib 1 = 1\n"
  "fib n = fib (n-1) + fib (n-2)\n"

Indentation

{-# LANGUAGE OverloadedStrings #-}
{-# OPTIONS_GHC -fno-warn-unused-do-bind #-}

module Main (main) where

import Data.DoList (DoList, fromList, toList)
import Data.Text as T (Text, append, unlines)
import Data.Text.IO as T (putStr)

main :: IO ()
main = T.putStr $ T.unlines $ toList $ do
  "Here goes indented list:"
  indent $ do
    "1. Item 1"
    indent $ do
      "* Item a"
      "* Item b"
    "2. Item 2"
    "3. Item 3"

indent :: DoList Text -> DoList Text
-- fromList and toList are no-ops
indent = fromList . map (append "  ") . toList