neat-interpolation-0.5.1.4/0000755000000000000000000000000007346545000013664 5ustar0000000000000000neat-interpolation-0.5.1.4/CHANGELOG.md0000644000000000000000000000051507346545000015476 0ustar0000000000000000## Version 0.5.1.4 - Support GHC 9.8. ## Version 0.5 - Isolated the `trimming` and `untrimming` variations of quasi-quoter. ## Version 0.4 - Changed the behaviour of the quasi-quoter in regards to trailing whitespace. Before it was always adding newline in the end, now it always completely removes all the trailing whitespace. neat-interpolation-0.5.1.4/LICENSE0000644000000000000000000000204107346545000014666 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.5.1.4/library/0000755000000000000000000000000007346545000015330 5ustar0000000000000000neat-interpolation-0.5.1.4/library/NeatInterpolation.hs0000644000000000000000000001002307346545000021317 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 = -- > [trimming| -- > function(){ -- > function(){ -- > $a -- > } -- > return $b -- > } -- > |] -- -- Executing the following: -- -- > main = Text.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 = Text.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 = [trimming|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 = [trimming|$$my ${word} $${string}|] -- -- results in -- -- > f "funny" == "$my funny ${string}" module NeatInterpolation (trimming, untrimming, text) where import qualified Data.Text as Text import Language.Haskell.TH import Language.Haskell.TH.Quote hiding (quoteExp) import qualified NeatInterpolation.Parsing as Parsing import NeatInterpolation.Prelude import qualified NeatInterpolation.String as String expQQ :: (String -> Q Exp) -> QuasiQuoter expQQ quoteExp = QuasiQuoter quoteExp notSupported notSupported notSupported where notSupported _ = fail "Quotation in this context is not supported" -- | -- An alias to `trimming` for backward-compatibility. text :: QuasiQuoter text = trimming -- | -- Trimmed quasiquoter variation. -- Same as `untrimming`, but also -- removes the leading and trailing whitespace. trimming :: QuasiQuoter trimming = expQQ (quoteExp . String.trim . String.unindent . String.tabsToSpaces) -- | -- Untrimmed quasiquoter variation. -- Unindents the quoted template and converts tabs to spaces. untrimming :: QuasiQuoter untrimming = expQQ (quoteExp . String.unindent . String.tabsToSpaces) indentQQPlaceholder :: Int -> Text -> Text indentQQPlaceholder indent text = case Text.lines text of head : tail -> Text.intercalate (Text.singleton '\n') $ head : map (Text.replicate indent (Text.singleton ' ') <>) tail [] -> text quoteExp :: String -> Q Exp quoteExp input = case Parsing.parseLines input of Left e -> fail $ show e Right lines -> sigE (appE [|Text.intercalate (Text.singleton '\n')|] $ listE $ map lineExp lines) [t|Text|] lineExp :: Parsing.Line -> Q Exp lineExp (Parsing.Line indent contents) = case contents of [] -> [|Text.empty|] [x] -> toExp x xs -> appE [|Text.concat|] $ listE $ map toExp xs where toExp = contentExp (fromIntegral indent) contentExp :: Integer -> Parsing.LineContent -> Q Exp contentExp _ (Parsing.LineContentText text) = appE [|Text.pack|] (stringE text) contentExp indent (Parsing.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.5.1.4/library/NeatInterpolation/0000755000000000000000000000000007346545000020767 5ustar0000000000000000neat-interpolation-0.5.1.4/library/NeatInterpolation/Parsing.hs0000644000000000000000000000313307346545000022726 0ustar0000000000000000module NeatInterpolation.Parsing where import Data.Text (pack) import NeatInterpolation.Prelude hiding (many, some, try, (<|>)) import Text.Megaparsec 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 neat-interpolation-0.5.1.4/library/NeatInterpolation/Prelude.hs0000644000000000000000000000571407346545000022732 0ustar0000000000000000{-# LANGUAGE CPP #-} module NeatInterpolation.Prelude ( module Exports, ) where 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, forM, forM_, mapM, mapM_, msum, sequence, sequence_) import Control.Monad.Fail as Exports import Control.Monad.Fix as Exports hiding (fix) import Control.Monad.IO.Class as Exports 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, (.)) #if MIN_VERSION_base(4,19,0) import Data.Functor as Exports hiding (unzip) #else import Data.Functor as Exports #endif import Data.Functor.Identity as Exports import Data.IORef as Exports import Data.Int as Exports import Data.Ix as Exports import Data.List as Exports hiding (all, and, any, concat, concatMap, elem, find, foldl, foldl', foldl1, foldr, foldr1, isSubsequenceOf, mapAccumL, mapAccumR, maximum, maximumBy, minimum, minimumBy, notElem, or, product, sortOn, sum, uncons) import Data.Maybe as Exports import Data.Monoid as Exports hiding (First (..), Last (..), (<>)) import Data.Ord as Exports import Data.Proxy as Exports import Data.Ratio as Exports import Data.STRef as Exports import Data.Semigroup as Exports import Data.String as Exports import Data.Text as Exports (Text) 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 (alignment, sizeOf) import GHC.Conc as Exports hiding (threadWaitRead, threadWaitReadSTM, threadWaitWrite, threadWaitWriteSTM, withMVar) import GHC.Exts as Exports (IsList (..), groupWith, inline, lazy, sortWith) import GHC.Generics as Exports (Generic, Generic1) import GHC.IO.Exception as Exports import Numeric as Exports 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.Printf as Exports (hPrintf, printf) import Text.Read as Exports (Read (..), readEither, readMaybe) import Unsafe.Coerce as Exports import Prelude as Exports hiding (all, and, any, concat, concatMap, elem, fail, foldl, foldl1, foldr, foldr1, id, mapM, mapM_, maximum, minimum, notElem, or, product, sequence, sequence_, sum, (.)) neat-interpolation-0.5.1.4/library/NeatInterpolation/String.hs0000644000000000000000000000210407346545000022566 0ustar0000000000000000module NeatInterpolation.String where import NeatInterpolation.Prelude 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) [] 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.5.1.4/neat-interpolation.cabal0000644000000000000000000000633507346545000020473 0ustar0000000000000000cabal-version: 3.0 name: neat-interpolation version: 0.5.1.4 synopsis: Quasiquoter for neat and simple multiline text interpolation description: 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 extra-source-files: CHANGELOG.md source-repository head type: git location: git://github.com/nikita-volkov/neat-interpolation.git library hs-source-dirs: library default-extensions: NoImplicitPrelude NoMonomorphismRestriction BangPatterns BinaryLiterals ConstraintKinds DataKinds DefaultSignatures DeriveDataTypeable DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable DuplicateRecordFields EmptyDataDecls FlexibleContexts FlexibleInstances FunctionalDependencies GADTs GeneralizedNewtypeDeriving LambdaCase LiberalTypeSynonyms MagicHash MultiParamTypeClasses MultiWayIf OverloadedLists OverloadedStrings ParallelListComp PatternGuards PatternSynonyms 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 && <10 , template-haskell >=2.8 && <3 , text >=1 && <3 test-suite test type: exitcode-stdio-1.0 hs-source-dirs: test default-extensions: NoImplicitPrelude NoMonomorphismRestriction BangPatterns BinaryLiterals ConstraintKinds DataKinds DefaultSignatures DeriveDataTypeable DeriveFoldable DeriveFunctor DeriveGeneric DeriveTraversable DuplicateRecordFields EmptyDataDecls FlexibleContexts FlexibleInstances FunctionalDependencies GADTs GeneralizedNewtypeDeriving LambdaCase LiberalTypeSynonyms MagicHash MultiParamTypeClasses MultiWayIf OverloadedLists OverloadedStrings ParallelListComp PatternGuards PatternSynonyms QuasiQuotes RankNTypes RecordWildCards ScopedTypeVariables StandaloneDeriving StrictData TemplateHaskell TupleSections TypeApplications TypeFamilies TypeOperators UnboxedTuples default-language: Haskell2010 main-is: Main.hs build-depends: , neat-interpolation , rerebase <2 , tasty >=1.2.3 && <2 , tasty-hunit >=0.10.0.2 && <0.11 neat-interpolation-0.5.1.4/test/0000755000000000000000000000000007346545000014643 5ustar0000000000000000neat-interpolation-0.5.1.4/test/Main.hs0000644000000000000000000000401607346545000016064 0ustar0000000000000000module Main where import NeatInterpolation import Test.Tasty import Test.Tasty.HUnit import Prelude hiding (choose) main :: IO () main = defaultMain $ testGroup "" $ [ testCase "Demo" $ let template a b = [trimming| 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}" (template a a), testCase "Isolation" $ let isolated name = [trimming|this_could_be_${name}_long_identifier|] in assertEqual "" "this_could_be_one_long_identifier" (isolated "one"), testCase "Escaping 1" $ let template a b = [trimming| 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 \"$b\"\n}" (template a a), testCase "Escaping 2" $ let escaped name = [trimming|this_could_be_$$${name}$$_long_identifier|] in assertEqual "" "this_could_be_$one$_long_identifier" (escaped "one"), testCase "Deindentation" $ let template fieldName className = [trimming| * @param $fieldName value of the {@code $fieldName} property of the {@code $className} case |] in assertEqual "" "* @param a value of the {@code a} property of\n the {@code b} case" (template "a" "b") ]