neat-interpolation-0.3.2.6/0000755000000000000000000000000013615313540013663 5ustar0000000000000000neat-interpolation-0.3.2.6/Setup.hs0000644000000000000000000000005613615313540015320 0ustar0000000000000000import Distribution.Simple main = defaultMain neat-interpolation-0.3.2.6/LICENSE0000644000000000000000000000204113615313540014665 0ustar0000000000000000Copyright (c) 2013, Nikita Volkov Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.neat-interpolation-0.3.2.6/neat-interpolation.cabal0000644000000000000000000000577213615313540020476 0ustar0000000000000000name: neat-interpolation version: 0.3.2.6 synopsis: A quasiquoter for neat and simple multiline text interpolation description: A quasiquoter for producing Text values with support for a simple interpolation of input values. It removes the excessive indentation from the input and accurately manages the indentation of all lines of the interpolated variables. category: String, QuasiQuotes license: MIT license-file: LICENSE copyright: (c) 2013, Nikita Volkov author: Nikita Volkov maintainer: Nikita Volkov homepage: https://github.com/nikita-volkov/neat-interpolation bug-reports: https://github.com/nikita-volkov/neat-interpolation/issues build-type: Simple cabal-version: >=1.10 source-repository head type: git location: git://github.com/nikita-volkov/neat-interpolation.git library hs-source-dirs: library default-extensions: BangPatterns, BinaryLiterals, BlockArguments, ConstraintKinds, DataKinds, DefaultSignatures, DeriveDataTypeable, DeriveFoldable, DeriveFunctor, DeriveGeneric, DeriveTraversable, DuplicateRecordFields, EmptyDataDecls, FlexibleContexts, FlexibleInstances, FunctionalDependencies, GADTs, GeneralizedNewtypeDeriving, HexFloatLiterals, LambdaCase, LiberalTypeSynonyms, MagicHash, MultiParamTypeClasses, MultiWayIf, NoImplicitPrelude, NoMonomorphismRestriction, NumericUnderscores, OverloadedLists, OverloadedStrings, PatternGuards, PatternSynonyms, ParallelListComp, QuasiQuotes, RankNTypes, RecordWildCards, ScopedTypeVariables, StandaloneDeriving, StrictData, TemplateHaskell, TupleSections, TypeApplications, TypeFamilies, TypeOperators, UnboxedTuples default-language: Haskell2010 exposed-modules: NeatInterpolation other-modules: NeatInterpolation.Parsing NeatInterpolation.Prelude NeatInterpolation.String build-depends: base >=4.9 && <5, megaparsec >=7 && <9, template-haskell >=2.8 && <3, text ==1.* test-suite test type: exitcode-stdio-1.0 hs-source-dirs: test default-extensions: BangPatterns, BinaryLiterals, BlockArguments, ConstraintKinds, DataKinds, DefaultSignatures, DeriveDataTypeable, DeriveFoldable, DeriveFunctor, DeriveGeneric, DeriveTraversable, DuplicateRecordFields, EmptyDataDecls, FlexibleContexts, FlexibleInstances, FunctionalDependencies, GADTs, GeneralizedNewtypeDeriving, HexFloatLiterals, LambdaCase, LiberalTypeSynonyms, MagicHash, MultiParamTypeClasses, MultiWayIf, NoImplicitPrelude, NoMonomorphismRestriction, NumericUnderscores, OverloadedLists, OverloadedStrings, PatternGuards, PatternSynonyms, ParallelListComp, QuasiQuotes, RankNTypes, RecordWildCards, ScopedTypeVariables, StandaloneDeriving, StrictData, TemplateHaskell, TupleSections, TypeApplications, TypeFamilies, TypeOperators, UnboxedTuples default-language: Haskell2010 main-is: Main.hs build-depends: neat-interpolation, QuickCheck >=2.13 && <3, quickcheck-instances >=0.3.22 && <0.4, rerebase <2, tasty >=1.2.3 && <2, tasty-hunit >=0.10.0.2 && <0.11, tasty-quickcheck >=0.10.1 && <0.11 neat-interpolation-0.3.2.6/test/0000755000000000000000000000000013615313540014642 5ustar0000000000000000neat-interpolation-0.3.2.6/test/Main.hs0000644000000000000000000000310413615313540016060 0ustar0000000000000000module Main where import Prelude hiding (choose) import Test.QuickCheck.Instances import Test.Tasty import Test.Tasty.Runners import Test.Tasty.HUnit import Test.Tasty.QuickCheck import NeatInterpolation import qualified Test.QuickCheck as QuickCheck import qualified Test.QuickCheck.Property as QuickCheck main = defaultMain $ testGroup "" $ [ testCase "Demo" $ let template a b = [text| function(){ function(){ $a } return $b } |] a = "{\n indented line\n indented line\n}" in assertEqual "" "function(){\n function(){\n {\n indented line\n indented line\n }\n }\n return {\n indented line\n indented line\n }\n}\n" (template a a) , testCase "Isolation" $ let isolated name = [text|this_could_be_${name}_long_identifier|] in assertEqual "" "this_could_be_one_long_identifier\n" (isolated "one") , testCase "Escaping" $ let template a b = [text| function(){ function(){ $a } return "$$b" } |] escaped name = [text|this_could_be_$$${name}$$_long_identifier|] a = "{\n indented line\n indented line\n}" in do assertEqual "" "function(){\n function(){\n {\n indented line\n indented line\n }\n }\n return \"$b\"\n}\n" (template a a) assertEqual "" "this_could_be_$one$_long_identifier\n" (escaped "one") ] neat-interpolation-0.3.2.6/library/0000755000000000000000000000000013615313540015327 5ustar0000000000000000neat-interpolation-0.3.2.6/library/NeatInterpolation.hs0000644000000000000000000000657013615313540021332 0ustar0000000000000000-- | -- NeatInterpolation provides a quasiquoter for producing strings -- with a simple interpolation of input values. -- It removes the excessive indentation from the input and -- accurately manages the indentation of all lines of interpolated variables. -- But enough words, the code shows it better. -- -- Consider the following declaration: -- -- > {-# LANGUAGE QuasiQuotes #-} -- > -- > import NeatInterpolation -- > import Data.Text (Text) -- > -- > f :: Text -> Text -> Text -- > f a b = -- > [text| -- > function(){ -- > function(){ -- > $a -- > } -- > return $b -- > } -- > |] -- -- Executing the following: -- -- > main = T.putStrLn $ f "1" "2" -- -- will produce this (notice the reduced indentation compared to how it was -- declared): -- -- > function(){ -- > function(){ -- > 1 -- > } -- > return 2 -- > } -- -- Now let's test it with multiline string parameters: -- -- > main = T.putStrLn $ f -- > "{\n indented line\n indented line\n}" -- > "{\n indented line\n indented line\n}" -- -- We get -- -- > function(){ -- > function(){ -- > { -- > indented line -- > indented line -- > } -- > } -- > return { -- > indented line -- > indented line -- > } -- > } -- -- See how it neatly preserved the indentation levels of lines the -- variable placeholders were at? -- -- If you need to separate variable placeholder from the following text to -- prevent treating the rest of line as variable name, use escaped variable: -- -- > f name = [text|this_could_be_${name}_long_identifier|] -- -- So -- -- > f "one" == "this_could_be_one_long_identifier" -- -- If you want to write something that looks like a variable but should be -- inserted as-is, escape it with another @$@: -- -- > f word = [text|$$my ${word} $${string}|] -- -- results in -- -- > f "funny" == "$my funny ${string}|] module NeatInterpolation (text) where import NeatInterpolation.Prelude import Language.Haskell.TH import Language.Haskell.TH.Quote hiding (quoteExp) import NeatInterpolation.String import NeatInterpolation.Parsing import Data.Text (Text) import qualified Data.Text as T -- | -- The quasiquoter. text :: QuasiQuoter text = QuasiQuoter quoteExp notSupported notSupported notSupported where notSupported _ = fail "Quotation in this context is not supported" indentQQPlaceholder :: Int -> Text -> Text indentQQPlaceholder indent text = case T.lines text of head:tail -> T.intercalate (T.singleton '\n') $ head : map (T.replicate indent (T.singleton ' ') <>) tail [] -> text quoteExp :: String -> Q Exp quoteExp input = case parseLines $ normalizeQQInput input of Left e -> fail $ show e Right lines -> sigE (appE [|T.unlines|] $ listE $ map lineExp lines) [t|Text|] lineExp :: Line -> Q Exp lineExp (Line indent contents) = case contents of [] -> [| T.empty |] [x] -> toExp x xs -> appE [|T.concat|] $ listE $ map toExp xs where toExp = contentExp (fromIntegral indent) contentExp :: Integer -> LineContent -> Q Exp contentExp _ (LineContentText text) = appE [|T.pack|] (stringE text) contentExp indent (LineContentIdentifier name) = do valueName <- lookupValueName name case valueName of Just valueName -> do appE (appE (varE 'indentQQPlaceholder) $ litE $ integerL indent) (varE valueName) Nothing -> fail $ "Value `" ++ name ++ "` is not in scope" neat-interpolation-0.3.2.6/library/NeatInterpolation/0000755000000000000000000000000013615313540020766 5ustar0000000000000000neat-interpolation-0.3.2.6/library/NeatInterpolation/Prelude.hs0000644000000000000000000000623213615313540022725 0ustar0000000000000000module NeatInterpolation.Prelude ( module Exports, ) where -- base ------------------------- import Control.Applicative as Exports import Control.Arrow as Exports hiding (first, second) import Control.Category as Exports import Control.Concurrent as Exports import Control.Exception as Exports import Control.Monad as Exports hiding (fail, mapM_, sequence_, forM_, msum, mapM, sequence, forM) import Control.Monad.IO.Class as Exports import Control.Monad.Fail as Exports import Control.Monad.Fix as Exports hiding (fix) import Control.Monad.ST as Exports import Data.Bifunctor as Exports import Data.Bits as Exports import Data.Bool as Exports import Data.Char as Exports import Data.Coerce as Exports import Data.Complex as Exports import Data.Data as Exports import Data.Dynamic as Exports import Data.Either as Exports import Data.Fixed as Exports import Data.Foldable as Exports hiding (toList) import Data.Function as Exports hiding (id, (.)) import Data.Functor as Exports import Data.Functor.Contravariant as Exports import Data.Functor.Identity as Exports import Data.Int as Exports import Data.IORef as Exports import Data.Ix as Exports import Data.List as Exports hiding (sortOn, isSubsequenceOf, uncons, concat, foldr, foldl1, maximum, minimum, product, sum, all, and, any, concatMap, elem, foldl, foldr1, notElem, or, find, maximumBy, minimumBy, mapAccumL, mapAccumR, foldl') import Data.Maybe as Exports import Data.Monoid as Exports hiding (Last(..), First(..), (<>)) import Data.Ord as Exports import Data.Proxy as Exports import Data.Ratio as Exports import Data.Semigroup as Exports import Data.STRef as Exports import Data.String as Exports import Data.Traversable as Exports import Data.Tuple as Exports import Data.Unique as Exports import Data.Version as Exports import Data.Void as Exports import Data.Word as Exports import Debug.Trace as Exports import Foreign.ForeignPtr as Exports import Foreign.Ptr as Exports import Foreign.StablePtr as Exports import Foreign.Storable as Exports hiding (sizeOf, alignment) import GHC.Conc as Exports hiding (withMVar, threadWaitWriteSTM, threadWaitWrite, threadWaitReadSTM, threadWaitRead) import GHC.Exts as Exports (lazy, inline, sortWith, groupWith, IsList(..)) import GHC.Generics as Exports (Generic, Generic1) import GHC.IO.Exception as Exports import Numeric as Exports import Prelude as Exports hiding (fail, concat, foldr, mapM_, sequence_, foldl1, maximum, minimum, product, sum, all, and, any, concatMap, elem, foldl, foldr1, notElem, or, mapM, sequence, id, (.)) import System.Environment as Exports import System.Exit as Exports import System.IO as Exports import System.IO.Error as Exports import System.IO.Unsafe as Exports import System.Mem as Exports import System.Mem.StableName as Exports import System.Timeout as Exports import Text.ParserCombinators.ReadP as Exports (ReadP, ReadS, readP_to_S, readS_to_P) import Text.ParserCombinators.ReadPrec as Exports (ReadPrec, readPrec_to_P, readP_to_Prec, readPrec_to_S, readS_to_Prec) import Text.Printf as Exports (printf, hPrintf) import Text.Read as Exports (Read(..), readMaybe, readEither) import Unsafe.Coerce as Exports -- text ------------------------- import Data.Text as Exports (Text) neat-interpolation-0.3.2.6/library/NeatInterpolation/String.hs0000644000000000000000000000253013615313540022570 0ustar0000000000000000module NeatInterpolation.String where import NeatInterpolation.Prelude normalizeQQInput :: [Char] -> [Char] normalizeQQInput = trim . unindent' . tabsToSpaces where unindent' :: [Char] -> [Char] unindent' s = case lines s of head:tail -> let unindentedHead = dropWhile (== ' ') head minimumTailIndent = minimumIndent . unlines $ tail unindentedTail = case minimumTailIndent of Just indent -> map (drop indent) tail Nothing -> tail in unlines $ unindentedHead : unindentedTail [] -> [] trim :: [Char] -> [Char] trim = dropWhileRev isSpace . dropWhile isSpace dropWhileRev :: (a -> Bool) -> [a] -> [a] dropWhileRev p = foldr (\x xs -> if p x && null xs then [] else x:xs) [] unindent :: [Char] -> [Char] unindent s = case minimumIndent s of Just indent -> unlines . map (drop indent) . lines $ s Nothing -> s tabsToSpaces :: [Char] -> [Char] tabsToSpaces ('\t':tail) = " " ++ tabsToSpaces tail tabsToSpaces (head:tail) = head : tabsToSpaces tail tabsToSpaces [] = [] minimumIndent :: [Char] -> Maybe Int minimumIndent = listToMaybe . sort . map lineIndent . filter (not . null . dropWhile isSpace) . lines -- | Amount of preceding spaces on first line lineIndent :: [Char] -> Int lineIndent = length . takeWhile (== ' ') neat-interpolation-0.3.2.6/library/NeatInterpolation/Parsing.hs0000644000000000000000000000315113615313540022725 0ustar0000000000000000module NeatInterpolation.Parsing where import NeatInterpolation.Prelude hiding (many, some, try, (<|>)) import Data.Text (Text, pack) import Text.Megaparsec hiding (Line) import Text.Megaparsec.Char data Line = Line {lineIndent :: Int, lineContents :: [LineContent]} deriving (Show) data LineContent = LineContentText [Char] | LineContentIdentifier [Char] deriving (Show) type Parser = Parsec Void String -- | Pretty parse exception for parsing lines. newtype ParseException = ParseException Text deriving (Show, Eq) parseLines :: [Char] -> Either ParseException [Line] parseLines input = case parse lines "NeatInterpolation.Parsing.parseLines" input of Left err -> Left $ ParseException $ pack $ errorBundlePretty err Right output -> Right output where lines :: Parser [Line] lines = sepBy line newline <* eof line = Line <$> countIndent <*> many content countIndent = fmap length $ try $ lookAhead $ many $ char ' ' content = try escapedDollar <|> try identifier <|> contentText identifier = fmap LineContentIdentifier $ char '$' *> (try identifier' <|> between (char '{') (char '}') identifier') escapedDollar = fmap LineContentText $ char '$' *> count 1 (char '$') identifier' = some (alphaNumChar <|> char '\'' <|> char '_') contentText = do text <- manyTill anySingle end if null text then fail "Empty text" else return $ LineContentText $ text where end = (void $ try $ lookAhead escapedDollar) <|> (void $ try $ lookAhead identifier) <|> (void $ try $ lookAhead newline) <|> eof