diff --git a/Data/EasyTpl.hs b/Data/EasyTpl.hs new file mode 100644 --- /dev/null +++ b/Data/EasyTpl.hs @@ -0,0 +1,1060 @@ +{-# OPTIONS_HADDOCK -ignore-exports #-} +{-| +Module : Data.EasyTpl +Description : Easy Template compiler and renderer. +Copyright : (c) Kayo, 2014 +License : GPL-3 +Maintainer : kayo@illumium.org +Stability : experimental +Portability : POSIX + +This module implements compiler and renderer for easy runtime templates. +It can be used for advanced code preprocessing or simple substitution of some variables in string. + +Since template engine uses /Aeson's/ 'Value' type, you must use types, which have 'ToJSON' instances, for rendering it. +Also you can use 'Object' with variables as fields. + +-} + +module Data.EasyTpl ( + -- * Usage example + -- $usageExample + + -- * Template format + -- $docFormat + + -- ** Statements + -- $docStatements + + -- ** Expressions + -- $docExpressions + + -- * Template examples + + -- ** Assets json + -- $exampleStr + + -- ** EJS-like template + -- $exampleEjs + + -- * Types + Template + , TemplateToken + -- ** Json types + , Value(..) + , ByteString + , HashMap + , Vector + -- * Functions + -- ** Compile and render + , compile + , render + , compile' + , render' + -- ** Parsers + , parseTemplate + , parseTemplate' + , parseExpression + -- ** Utily + , defaultData + ) where + +import Data.Aeson (Value(..), ToJSON) +import qualified Data.Aeson as J +import qualified Data.Aeson.Parser as JP +import qualified Data.Aeson.Encode as JE +import Data.ByteString (ByteString) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Char8 as BSC +import Data.Text (Text) +import qualified Data.Text as T +import qualified Data.Text.Lazy as LT +import qualified Data.Text.Lazy.Builder as LTB +import qualified Data.Text.Encoding as TE +import Data.HashMap.Strict (HashMap) +import qualified Data.HashMap.Strict as H +import Data.Vector (Vector) +import qualified Data.Vector as V + +import Data.Attoparsec.ByteString.Char8 +import Data.Attoparsec.Expr +import qualified Data.Attoparsec.Text as AT + +#ifdef WITH_REGEX +import Text.Regex (Regex) +import qualified Text.Regex as RE +#endif + +import Data.Tuple (swap) +import Data.Fixed (mod') + +import Prelude hiding (takeWhile) + +import Control.Applicative ((<$>), (<*>), (<*), (*>), (<|>)) + +-- | Compiled template. +newtype Template = Template [TemplateToken] -- ^ Template consists of tokens + deriving (Show, Eq) + +-- | Template token. +data TemplateToken = ContentToken ByteString -- ^ Chunk or raw content as is + | LiteralToken Expression -- ^ Computable expression for substitution + | ControlToken Control Template -- ^ Control block structure with sub-template + deriving (Show, Eq) + +-- | Control structure. +data Control = Condition Expression -- ^ Conditional statement with expression + | Iteration (Text, Text) Expression -- ^ Iterational statement with variables and expression + deriving (Show, Eq) + +-- | Expression. +data Expression = Constant Value -- + | Variable Text + | Range Expression Expression Expression +#ifdef WITH_REGEX + | Regexp ByteString Bool Bool +#endif + | UnaryOperation UnaryOperator Expression + | BinaryOperation BinaryOperator Expression Expression + deriving (Show, Eq) + +-- | Unary operator +data UnaryOperator = GetLength -- ^ Length operator `#` (#value) + | Stringify -- ^ Stringify operator `\@` (\@value) + | Evaluate -- ^ Evaluate operator `=` (value=) + | LogicNot -- ^ Logical not operator `!` (!value) + | Negate -- ^ Numeric negate operator `-` (-value) + | ToNumber -- ^ Numeric cast operator `+` (+value) + | NotNull -- ^ Not null test operator `?` (value?) + deriving (Show, Eq) + +-- | Binary operator +data BinaryOperator = LogicOr -- ^ Logical or operator `||` + | LogicAnd -- ^ Logical and operator `&&` + | Equal -- ^ Generic equality operator `==` + | NotEqual -- ^ Generic non-equality operator `!=` + | LessThan -- ^ Lesser than operator `<` + | GreatThan -- ^ Greater than operator `>` + | LessEqual -- ^ Lesser or equal operator `<=` + | GreatEqual -- ^ Greater or equal operator `>=` + | Substract -- ^ Numeric substract operator `-` + | Append -- ^ Generic append operator `+` + | Multiply -- ^ Generic multiply operator `*` + | Divide -- ^ Generic divide operator `/` + | IntDivide -- ^ Generic integral divide operator `:` + | Module -- ^ Numeric module operator `%` + | Power -- ^ Numeric power operator `^` + | GetField -- ^ Container get field operator `.` | `[` `]` (object.field, object[field_name], array[index]) +#ifdef WITH_REGEX + | RegexTest -- ^ Regular expression test operator `~` (string ~ /regex/ => bool) + | RegexMatch -- ^ Regular expression match operator `~>` (string ~> /regex/ => null | [matches]) + | RegexSplit -- ^ Regular expression split operator `~:` (string ~: /regex/ => [pieces]) +#endif + deriving (Show, Eq) + +-- | Default data for render. +-- Empty data for using with standalone render. +defaultData :: Value +defaultData = Object H.empty + +-- | Compile template from string. +compile' :: String -> Either String Template +compile' = compile . BSC.pack + +-- | Compile template from ByteString. +compile :: ByteString -> Either String Template +compile = parseOnly parseTemplate + +-- | Render template to string. +render' :: (ToJSON e) => Template -> e -> String +render' tpl = BSC.unpack . render tpl + +-- | Render template to ByteString. +render :: (ToJSON e) => Template -> e -> ByteString +render tpl env = renderTemplate tpl $ J.toJSON env + +-- | Internal render template using hash with variables. +renderTemplate' :: Template -> HashMap Text Value -> ByteString +renderTemplate' tpl env = renderTemplate tpl $ Object env + +-- | Internal render template using value as variables. +renderTemplate :: Template -> Value -> ByteString +renderTemplate (Template tokens) env = BS.concat $ map (flip renderToken env) tokens + +-- | Internal render token. +renderToken :: TemplateToken -> Value -> ByteString + +renderToken (ContentToken text) _ = text + +renderToken (LiteralToken expr) env = getString $ toString $ evalExpression expr env + where + getString (String text) = TE.encodeUtf8 text + getString _ = "" + +renderToken (ControlToken ctl tpl) env = renderControl ctl tpl env + +renderControl :: Control -> Template -> Value -> ByteString + +renderControl (Condition expr) tpl env@(Object _) = applyCondition $ toBoolean $ evalExpression expr env + where + applyCondition :: Value -> ByteString + applyCondition (Bool True) = renderTemplate tpl env + applyCondition _ = "" + +renderControl (Iteration (keyVar, valVar) expr) tpl env'@(Object henv) = BS.concat $ applyIteration $ evalExpression expr env' + where + applyIteration :: Value -> [ByteString] + applyIteration (Array list) = V.toList $ V.imap applyIndex list + applyIteration (Object hash) = map applyField $ H.toList hash + applyIteration _ = [] + + addLocal :: Text -> Value -> HashMap Text Value -> HashMap Text Value + addLocal var val env = if T.null var then env else H.insert var val env + + applyElement :: Value -> Value -> ByteString + applyElement key val = renderTemplate' tpl $ addLocal keyVar key $ addLocal valVar val henv + + applyIndex :: Int -> Value -> ByteString + applyIndex key val = applyElement (Number (fromIntegral key)) val + + applyField :: (Text, Value) -> ByteString + applyField (key, val) = applyElement (String key) val + +renderControl _ _ _ = "" + +-- | Internal evaluate expression. +evalExpression :: Expression -> Value -> Value + +evalExpression (Constant val) _ = val + +evalExpression (Variable var) (Object henv) = maybe Null id $ H.lookup var henv +evalExpression (Variable _) _ = Null + +evalExpression (Range from' to' step') env = genRange (toNumber $ evalExpression from' env) + (toNumber $ evalExpression to' env) + (toNumber $ evalExpression step' env) + where + genRange :: Value -> Value -> Value -> Value + genRange (Number from) (Number to) (Number step) = + Array $ V.fromList $ range from to step + genRange _ _ _ = Null + + range from to step | from > to = [] + | otherwise = Number from : range (from + step) to step + +evalExpression (UnaryOperation op' a') env = unary op' (evalExpression a' env) + where + unary :: UnaryOperator -> Value -> Value + + unary GetLength = getLength + unary Stringify = stringify + unary Evaluate = either (String . T.pack . ("Error: " ++)) (flip evalExpression env) . parseOnly parseExpression . toByteString + unary LogicNot = booleanOp not + unary Negate = numericOp (0 -) + unary ToNumber = numericOp id + unary NotNull = Bool . notNull + + notNull :: Value -> Bool + notNull Null = False + notNull _ = True + + booleanOp :: (Bool -> Bool) -> Value -> Value + booleanOp op a = case toBoolean a of + Bool b -> Bool $ op b + _ -> Null + + numericOp op a = case toNumber a of + Number n -> Number $ op n + _ -> Null + + toByteString a = case toString a of + String s -> TE.encodeUtf8 s + _ -> "" + +#ifdef WITH_REGEX +evalExpression (BinaryOperation op' a' (Regexp re ml cs)) env = apply op' $ toString $ evalExpression a' env + where + apply RegexTest (String s) = Bool $ maybe False (\_ -> True) $ match s + apply RegexMatch (String s) = maybe Null (Array . V.fromList . map (String . T.pack)) $ match s + apply RegexSplit (String s) = Array $ V.fromList $ map String $ split s + apply _ _ = Null + + match :: Text -> Maybe [String] + match = RE.matchRegex regex . T.unpack + + split :: Text -> [Text] + split = map T.pack . RE.splitRegex regex . T.unpack + + regex :: Regex + regex = RE.mkRegexWithOpts (BSC.unpack re) ml cs + +-- regexps is non-evaluatable +evalExpression (Regexp _ _ _) _ = Null +#endif + +evalExpression (BinaryOperation op' a' b') env = binary op' (evalExpression a' env) (evalExpression b' env) + where + binary :: BinaryOperator -> Value -> Value -> Value + + binary Equal a = Bool . (a ==) + binary NotEqual a = Bool . (a /=) + + binary Append (String a) = applyToString $ String . T.append a + binary Multiply (String a) = applyToInteger $ String . flip T.replicate a + binary IntDivide (String a) = applyToString $ Array . V.fromList . map String . flip T.splitOn a + binary LessThan (String a) = applyToString $ Bool . (a <) + binary GreatThan (String a) = applyToString $ Bool . (a >) + binary LessEqual (String a) = applyToString $ Bool . (a <=) + binary GreatEqual (String a) = applyToString $ Bool . (a >=) + + binary GetField (String s) = applyToInteger (\i -> if i >= 0 && i < T.length s then String $ T.singleton $ T.index s i else Null) + + binary LessThan (Number a) = applyToNumber $ Bool . (a <) + binary GreatThan (Number a) = applyToNumber $ Bool . (a >) + binary LessEqual (Number a) = applyToNumber $ Bool . (a <=) + binary GreatEqual (Number a) = applyToNumber $ Bool . (a >=) + + binary GetField (Array a) = applyToInteger (maybe Null id . (V.!?) a) + binary GetField (Object a) = applyToString (maybe Null id . flip H.lookup a) + + binary op a = binary' op a + + binary' LogicOr = booleanOp (||) + binary' LogicAnd = booleanOp (&&) + + binary' Substract = numericOp (-) + binary' Append = numericOp (+) + binary' Multiply = numericOp (*) + binary' Divide = numericOp (/) + binary' IntDivide = numericOp' (/) + binary' Module = numericOp mod' + --binary' Power = numericOp pow + binary' _ = \_ _ -> Null + + numericOp op a b = case (toNumber a, toNumber b) of + (Number na, Number nb) -> Number $ op na nb + _ -> Null + + numericOp' op a b = case (toNumber a, toNumber b) of + (Number na, Number nb) -> Number $ fromIntegral ((round $ op na nb) :: Integer) + _ -> Null + + booleanOp op a b = case (toBoolean a, toBoolean b) of + (Bool ba, Bool bb) -> Bool $ op ba bb + _ -> Null + + applyToString fn v = case toString v of + String s -> fn s + _ -> Null + + applyToNumber fn v = case toNumber v of + Number n -> fn $ n + _ -> Null + + applyToInteger fn = applyToNumber (fn . round) + +-- | Generic get length. +getLength :: Value -> Value +getLength (String text) = Number $ fromIntegral $ T.length text +getLength (Array list) = Number $ fromIntegral $ V.length list +getLength (Object hash) = Number $ fromIntegral $ H.size hash +getLength _ = Null + +-- | Cast value to boolean. +toBoolean :: Value -> Value +toBoolean bool@(Bool _) = bool +toBoolean (Number val) = Bool $ val /= I 0 +toBoolean (String text) = Bool $ not $ T.null text +toBoolean Null = Bool False +toBoolean (Object hash) = Bool $ not $ H.null hash +toBoolean (Array list) = Bool $ not $ V.null list + +-- | Cast any value to number. +-- Returns null if non-castable. +toNumber :: Value -> Value +toNumber val@(Number _) = val +toNumber (Bool bool) = Number $ if bool then 1 else 0 +toNumber (String text) = getNumber' $ AT.parse AT.number text + where + getNumber' (AT.Done _ val) = Number val + getNumber' _ = Null +toNumber _ = Null + +-- | Cast any value to string. +toString :: Value -> Value +toString text@(String _) = text +toString (Number val) = String $ T.pack $ show val +toString Null = String "[null]" +toString (Bool _) = String "[bool]" +toString (Object _) = String "[object]" +toString (Array _) = String "[array]" + +-- | Stringify value to JSON. +-- Stringify any value using JSON format by AESON encode. +stringify :: Value -> Value +stringify = String . LT.toStrict . LTB.toLazyText . JE.fromValue + +-- <% for key, value of iterable %> +-- <% if condition %> +-- <%= literal =%> +-- <% end %> +-- <% end %> + +-- | Template parser function. +-- Use this for parsing templates. +parseTemplate :: Parser Template +parseTemplate = Template <$> parseTokens + where + parseTokens = do + end <- atEnd + case end of + True -> return [] + _ -> (:) <$> parseToken <*> parseTokens + +-- | Less template parser. +-- Used internally for parsing subtemplates. +parseTemplate' :: Parser Template +parseTemplate' = Template <$> many' parseToken + +-- | Template token parser. +parseToken :: Parser TemplateToken +parseToken = parseControl <|> parseLiteral <|> parseContent + +-- | Control token parser. +parseControl :: Parser TemplateToken +parseControl = ControlToken <$> blockOpen <*> parseTemplate' <* blockClose + where + blockOpen = "<%" *> spaces *> parseAction <* spaces <* "%>" + blockClose = "<%" >> spaces >> "end" >> spaces >> "%>" + + parseAction = parseCondition <|> parseIteration + +-- | Literal token parser. +parseLiteral :: Parser TemplateToken +parseLiteral = LiteralToken <$> ("<%=" *> parseExpression <* "%>") "Invalid literal" + +-- | Content token parser. +parseContent :: Parser TemplateToken +parseContent = many1' getChunk >>= return . ContentToken . BS.concat + where + getChunk :: Parser ByteString + getChunk = (takeWhile1 (/= '<')) <|> + ((cat2 <$> char '<' <*> notChar '%') <|> + (cat2 <$> char '<' <* char '\\' <*> char '%') >>= + return . BSC.pack) + + cat2 a b = a:[b] + +-- | Condition control parser. +-- `if ` expression => Condition expression +parseCondition :: Parser Control +parseCondition = Condition <$> ("if" *> spaces1 *> parseExpression) + +-- | Iteration control parser. +-- `for ` ( value [`,` index] ` in` | field [`,` value] ` of` ) +parseIteration :: Parser Control +parseIteration = Iteration <$> ("for" *> spaces1 *> (valueIndex <|> fieldValue)) + <*> (spaces1 *> parseExpression) + where + valueIndex = swap <$> pair <* spaces1 <* "in" + fieldValue = pair <* spaces1 <* "of" + + pair = (,) <$> option "" parseIdentifier + <*> option "" (spaces *> char ',' *> spaces *> parseIdentifier) + +-- | Expression parser. +-- Use this for parsing expressions. +parseExpression :: Parser Expression +parseExpression = spaces *> buildExpressionParser operatorTable parsePrimary <* spaces + where + operatorTable :: OperatorTable ByteString Expression + operatorTable = [ {-[ field '.' parseFieldName GetField + , block '[' ']' parseExpression GetField + ] + , -} + [ unary '?' True NotNull + ] + , [ unary '#' False GetLength + , unary '!' False LogicNot + , unary '-' False Negate + , unary '+' False ToNumber + ] + , [ binary '^' AssocRight Power + ] + , [ binary '*' AssocLeft Multiply + , binary '/' AssocLeft Divide + , binary ':' AssocLeft IntDivide + , binary '%' AssocLeft Module + ] + , [ binary '-' AssocLeft Substract + , binary '+' AssocLeft Append + ] + , [ binary' "~>" AssocNone RegexMatch -- !important: before ~ + , binary' "~:" AssocNone RegexSplit -- !important: before ~ + , binary '~' AssocNone RegexTest + ] + , [ binary' "==" AssocLeft Equal + , binary' "!=" AssocLeft NotEqual + , binary' "<=" AssocLeft LessEqual -- !important: before < + , binary' ">=" AssocLeft GreatEqual -- !important: before > + , binary '<' AssocLeft LessThan + , binary '>' AssocLeft GreatThan + ] + , [ binary' "||" AssocLeft LogicOr + , binary' "&&" AssocLeft LogicAnd + ] + , [ unary '=' True Evaluate + ] + , [ unary '@' False Stringify + ] + ] + {- + parseFieldName :: Parser Expression + parseFieldName = (Constant . String) <$> parseIdentifier + + field :: Char -> Parser Expression -> BinaryOperator -> Operator ByteString Expression + field op ex tp = Postfix (spaces *> char op *> spaces *> ex <* spaces >>= + return . flip (BinaryOperation tp)) + + block :: Char -> Char -> Parser Expression -> BinaryOperator -> Operator ByteString Expression + block op cl ex tp = Postfix (spaces *> char op *> ex <* char cl <* spaces >>= + return . flip (BinaryOperation tp)) + -} + unary :: Char -> Bool -> UnaryOperator -> Operator ByteString Expression + unary op po tp = (if po then Postfix else Prefix) + (spaces >> char op >> spaces >> + return (UnaryOperation tp)) + + binary :: Char -> Assoc -> BinaryOperator -> Operator ByteString Expression + binary op ac tp = Infix (spaces >> char op >> spaces >> + return (BinaryOperation tp)) ac + + binary' :: Parser ByteString -> Assoc -> BinaryOperator -> Operator ByteString Expression + binary' op ac tp = Infix (spaces >> op >> spaces >> + return (BinaryOperation tp)) ac + +-- | Primary expression parser. +-- A sequence of .field/[index] operations can be applied to primary expressions (excluding regular expressions). +parsePrimary :: Parser Expression +parsePrimary = ((parseParens + <|> parseVariable + <|> parseRange + <|> parseConstant) >>= parseFields) +#ifdef WITH_REGEX + <|> parseRegex +#endif + +-- | Parens primary expression. +-- `(` expression `)` => expression +parseParens :: Parser Expression +parseParens = char '(' *> parseExpression <* char ')' + +-- | Variable primary expression. +-- identifier => Variable identifier +parseVariable :: Parser Expression +parseVariable = Variable <$> parseIdentifier + +-- | Sequence of field/index operations +-- `.` key@identifier | `[` key@expression `]` => BinaryOperation GetField topexpr key +parseFields :: Expression -> Parser Expression +parseFields prev = option prev ((parseField <|> parseIndex) >>= parseFields . BinaryOperation GetField prev) + where + parseField :: Parser Expression + parseField = spaces *> char '.' *> parseIdentifier <* spaces >>= return . Constant . String + + parseIndex :: Parser Expression + parseIndex = spaces *> char '[' *> parseExpression <* char ']' <* spaces + +-- | Range expression (array generator). +-- `[` [from] `..` to [`,` step] `]` => Range from to step +parseRange :: Parser Expression +parseRange = char '[' *> (Range <$> option defaultFrom parseExpression <* ".." <*> + parseExpression <*> option defaultStep (char ',' *> parseExpression)) <* char ']' + where + defaultFrom = Constant $ Number 0 + defaultStep = Constant $ Number 1 + +#ifdef WITH_REGEX +-- | Regular expression (posix regex). +-- `/` regex `/` [caseInsensitive@`i`] [multiLine@`m`] => Regexp regex !caseInsensitive multiLine +parseRegex :: Parser Expression +parseRegex = Regexp <$> (char '/' *> regexpBody <* char '/') <*> caseSensitive <*> multiLine + where + regexpBody :: Parser ByteString + regexpBody = many1' getChunk >>= return . BS.concat + + getChunk :: Parser ByteString + getChunk = (takeWhile1 (\c -> c /= '/' && c /= '\\')) <|> + (char '\\' >> char '/' >> return "/") <|> + (char '\\' >> return "\\") + + caseSensitive :: Parser Bool + caseSensitive = option True $ char 'i' >> return False + + multiLine :: Parser Bool + multiLine = option False $ char 'm' >> return True +#endif + +-- | Constant expression (environment independent). +-- It's just a JSON value parsed by AESON. +parseConstant :: Parser Expression +parseConstant = Constant <$> JP.value' + +-- | Identifier +-- Identifiers starts from `a-zA-Z` (alphabetic character), `_` (underscore) or `$` (dollar) and consists of `a-zA-Z0-9`, `_` or `$`. +parseIdentifier :: Parser Text +parseIdentifier = do + first <- firstChar + rest <- many' otherChar + return $ T.pack $ first : rest + where + firstChar = satisfy isAlpha_ascii <|> satisfy (inClass "_$") + otherChar = firstChar <|> satisfy isDigit + +-- | Skip zero or more spaces +-- `space`* +spaces :: Parser () +spaces = skipWhile isSpace + +-- | Skip one or more spaces +-- `space`+ +spaces1 :: Parser () +spaces1 = skipSpace >> spaces + +{- $usageExample + +> import Data.Aeson +> import Data.EasyTpl (compile, render) +> import Data.ByteString (readFile, writeFile) +> +> data TplVars = TplVars { ... } +> +> instance ToJSON TplVars +> ... +> +> main = do +> +> template <- readFile "template.tpl" >>= +> either error return . compile +> +> let result = render Template $ TplVars { ... } +> +> writeFile "output.txt" result + +-} + +{- $docFormat + +Templates consists of: + + [Control structures] Entities, enclosed by @\<%@ and @%\>@. + + [Substitution expressions] Entities, enclosed by @\<%=@ and @%\>@. + + [Raw content] Anything not controls and literals, interprets as is. + +-} + +{- $docStatements + +Control structures: + + [@/if/@ control] + + @ + \<% if /expression/ %\> + The content, which will be displayed, if result of /expression/ evaluation is /true/. + \<% end %\> + @ + + [@/for/@ control] + + Basic form: + + @ + \<% for /value/ /[,/ /index/ /]/ in /expression/ %\> + The content, which will be displayed for each entry in result of /expression/ evaluation. + Variables /value/ and (optional) /index/ contains entry value and number respectively. + \<% end %\> + @ + + Alternative form: + + @ + \<% for /field/ /[,/ /value/ /]/ in /expression/ %\> + The content, which will be displayed for each entry in result of /expression/ evaluation. + Variables /field/ and (optional) /value/ contains entry key and value respectively. + \<% end %\> + @ + + The /expression/ must be iteratable, like /Array/ or /Object/. + +-} + +{- $docExpressions + +Expressions is: + + [Constants] Json Values, like /string/, /number/, /object/, /array/, /true/, /false/, /null/ + + [Variables] Text entities, identified by name + + [Ranges] Generated arrays of integers + + [Regexps] Regular expressions, enclosed by @\/@ and @\/@ with @i@ and @m@ options. + + [Unary operators] Applied to single expression + + [Binary operators] Applied to twin expressions + +/Prefix unary operations/: + + [Get length @#@] Applied to /string/, /object/, /array/. For anything other gives /null/. + + [Stringify @\@@] Converts value to /JSON/ string. + + [Logical not @!@] Inverts boolean value. + + [Numeric negate @-@] Negates numeric value. + + [To number @+@] Forces value to be a numeric. + +/Postfix unary operations/: + + [Evaluate @=@] Evaluates string as expression. + + [Not null @?@] Tests value to not be a /null/. + +/Generic binary operations/: + + [Equal @==@, Not equal @!=@] Tests values to be an equal. + + [Compare @\<@, @\>@, @\<=@, @\>=@] Compares values. + +/Numeric binary operations/: + + [Arithmetic @+@, @-@, @*@, @/@] Simple calculations. + + [Integer division @:@, Extract module @\%@] + +/String binary operations/: + + [Concat @+@] Concatenates two strings. + + [Split @:@] Splits string to array of strings by sepatator. + + [Repeat @*@] Repeats string N times. + + [Regex test @~@] Tests string to match regex. + + [Regex match @~\>@] Extract matches from string by appling regex. + + [Regex split @~:@] Split string to array of strings by regex. + +/Logical binary operations/: + + [Logical and @&&@] + + [Logical or @||@] + +/Container indexing operations/: + + [Get field @.@ /fieldName/] Extracts field, which identified by name. + + [Get index @\[@ /expression/ @\]@] Extracts field by number or evaluated name. + + This operations applyed sequentially to container types, like /string/, /array/, /object/. + +/Range expressions/: + + @\[@ \[/from/\] @..@ /to/ \[, /step/\] @\]@ + + This expressins generates arrays of numeric values in range /from/ including /to/ by /step/. + + By default /from/ is /0/, and /step/ is /1/. + +/Regular expressions/: + + @\/@ /expression/ @\/@ \[/i/\] \[/m/\] + + Posix regular expressions are supported. + + * @i@-modifier forses case-insensitive mode. + + * @m@-modifier forces multiline mode. + +-} + +{- $exampleStr + +* Template: + +> {<% +> for res, num in assets +> %> +> "<%= +> res.name +> %>": "<% +> if #root>0 +> %><%= +> root +> %>/<% +> end +> %><%= +> prefix[res.type] +> %><%= +> res.name +> %><% +> if suffix[res.type]? +> %><%= +> suffix[res.type] +> %><% +> end +> %>"<% +> if num+1<#assets +> %>,<% +> end +> %><% +> end +> %> +> } + +* Compiled template: + +> (Template [ +> ContentToken "{", +> ControlToken +> (Iteration ("num","res") (Variable "assets")) +> (Template [ +> ContentToken "\n \"", +> LiteralToken +> (BinaryOperation GetField +> (Variable "res") +> (Constant (String "name"))), +> ContentToken "\": \"", +> ControlToken +> (Condition +> (BinaryOperation GreatThan +> (UnaryOperation GetLength +> (Variable "root")) +> (Constant (Number 0)))) +> (Template [ +> LiteralToken +> (Variable "root"), +> ContentToken "/" +> ]), +> LiteralToken +> (BinaryOperation GetField +> (Variable "prefix") +> (BinaryOperation GetField +> (Variable "res") +> (Constant (String "type")))), +> LiteralToken +> (BinaryOperation GetField +> (Variable "res") +> (Constant (String "name"))), +> ControlToken +> (Condition +> (UnaryOperation NotNull +> (BinaryOperation GetField +> (Variable "suffix") +> (BinaryOperation GetField +> (Variable "res") +> (Constant (String "type")))))) +> (Template [ +> LiteralToken +> (BinaryOperation GetField +> (Variable "suffix") +> (BinaryOperation GetField +> (Variable "res") +> (Constant (String "type"))))]), +> ContentToken "\"", +> ControlToken +> (Condition +> (BinaryOperation LessThan +> (BinaryOperation Append +> (Variable "num") +> (Constant (Number 1))) +> (UnaryOperation GetLength +> (Variable "assets")))) +> (Template [ +> ContentToken "," +> ]) +> ]), +> ContentToken "\n}\n" +> ]) + +* Yaml Dataset: + +> prefix: +> script: js/ +> style: css/ +> image: gfx/ +> suffix: +> script: .min.js +> style: .min.css +> assets: +> - type: script +> name: client +> - type: style +> name: styles +> - type: style +> name: bootstrap +> - type: script +> name: react +> - type: image +> name: icons.png +> - type: image +> name: photo.jpg + +* Render result: + +> { +> "client": "js/client.min.js", +> "styles": "css/styles.min.css", +> "bootstrap": "css/bootstrap.min.css", +> "react": "js/react.min.js", +> "icons.png": "gfx/icons.png", +> "photo.jpg": "gfx/photo.jpg" +> } + +-} + +{- $exampleEjs + +* Template: + +> + +* Compiled template: + +> (Template [ +> ContentToken "\n" +> ]) + +* Yaml Dataset: + +> items: +> - url: / +> title: Front page +> - url: http://example.org/ +> title: Example site +> - url: https://example.com/example.html +> description: External link +> - url: /about +> title: About + +* Render result: + +> +-} diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Main.hs b/Main.hs new file mode 100644 --- /dev/null +++ b/Main.hs @@ -0,0 +1,168 @@ +import Paths_ert(version) +import Data.Version(showVersion) + +import System.Console.GetOpt(getOpt, usageInfo, ArgOrder(Permute), ArgDescr(..), OptDescr(..)) +import System.Environment(getArgs, getProgName) +import System.IO (hPutStrLn, stdin, stdout, stderr) +import System.Exit(exitWith, ExitCode(ExitSuccess, ExitFailure)) + +import Data.ByteString (ByteString) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Char8 as BSC +import qualified Data.EasyTpl as ET +import qualified Data.Attoparsec.ByteString as AP +import qualified Data.Aeson as J +#ifdef WITH_YAML +import qualified Data.Yaml as Y +#endif + +data Action = ShowUsage + | ShowVersion + | ProcessTemplate + deriving (Show, Eq) + +data DataFile = NullData + | JsonFile FilePath +#ifdef WITH_YAML + | YamlFile FilePath +#endif + | NoneData + deriving (Show, Eq) + +debugLog :: (Show s) => String -> s -> IO () +#ifdef WITH_DEBUG +debugLog key val = hPutStrLn stderr $ "\n" ++ key ++ ">> " ++ show val +#else +debugLog _ _ = return () +#endif + +data Options = + Options + { optTemplate :: FilePath + , optOutput :: FilePath + , optDataFile :: DataFile + , optAction :: Action + } deriving (Show, Eq) + +defaults :: Options +defaults = + Options + { optTemplate = "" + , optOutput = "" + , optDataFile = NoneData + , optAction = ShowUsage + } + +options :: [OptDescr (Options -> Options)] +options = + [ Option ['h', '?'] ["help"] + (NoArg (\opts -> opts { optAction = ShowUsage })) + "This usage hint." + , Option ['V'] ["version"] + (NoArg (\opts -> opts { optAction = ShowVersion })) + "Version information." + , Option ['i', 't'] ["input", "template"] + (OptArg (\val opts -> opts { optTemplate = maybe "" id val + , optAction = ProcessTemplate }) "FILE") + ("Read input template from FILE (default: " ++ (optTemplate defaults) ++ ", empty means stdin).") + , Option ['o', 'r'] ["output", "render-to"] + (OptArg (\val opts -> opts { optOutput = maybe "" id val + , optAction = ProcessTemplate }) "FILE") + ("Output render result to FILE (default: " ++ (optOutput defaults) ++ ", empty means stdout).") + , Option ['s'] ["standalone"] + (NoArg (\opts -> opts { optDataFile = NullData + , optAction = ProcessTemplate })) + "Render template without data." + , Option ['j'] ["json", "json-data"] + (OptArg (\val opts -> opts { optDataFile = JsonFile $ maybe "" id val + , optAction = ProcessTemplate }) "FILE") + ("Render template with JSON data from FILE (default: compile template only, empty means stdin).") +#ifdef WITH_YAML + , Option ['y'] ["yaml", "yaml-data"] + (OptArg (\val opts -> opts { optDataFile = YamlFile $ maybe "" id val + , optAction = ProcessTemplate }) "FILE") + ("Render template with YAML data from FILE (default: compile template only, empty means stdin).") +#endif + ] + +parseArgs :: [String] -> String -> IO Options +parseArgs argv program = + case getOpt Permute options argv of + (args, fs, []) -> do + doAction' $ foldl (flip id) defaults + $ concat [ args + , map (\val opts -> opts { optTemplate = val + , optAction = ProcessTemplate }) fs + ] + (_, _, errs) -> do + hPutStrLn stderr (concat errs ++ usageInfo usage options) + exitWith $ ExitFailure 1 + where + -- usage :: String + usage = "Usage: " ++ program ++ " [options]" + + -- verst :: String + verst = program ++ " " ++ showVersion version + + -- doAction :: Options -> IO () + doAction' opts = do + debugLog "CommandOptions" opts + case optAction opts of + ShowUsage -> do + hPutStrLn stderr (usageInfo usage options) + exitWith ExitSuccess + ShowVersion -> do + hPutStrLn stderr verst + exitWith ExitSuccess + _ -> return opts + +doAction :: Options -> IO () +doAction Options { optTemplate = template + , optOutput = output + , optDataFile = NoneData + } = + --BS.readFile template >>= AP.parseTest ET.parseTemplate + inputFile template >>= return . AP.parseOnly ET.parseTemplate >>= outputFile output . BSC.pack . (++ "\n") . show + +doAction Options { optTemplate = template + , optOutput = output + , optDataFile = input + } = do + + envData <- case input of + NullData -> return $ ET.defaultData + _ -> inputFile (dataFile input) >>= either error return . dataParse input + + debugLog "InputData" envData + + inputFile template >>= + either error return . ET.compile >>= + outputFile output . (flip ET.render envData) + + where + dataFile :: DataFile -> FilePath + dataFile (JsonFile file) = file +#ifdef WITH_YAML + dataFile (YamlFile file) = file +#endif + dataFile _ = "" + + dataParse :: DataFile -> BS.ByteString -> Either String ET.Value + dataParse (JsonFile _) = AP.parseOnly J.json' +#ifdef WITH_YAML + dataParse (YamlFile _) = Y.decodeEither +#endif + dataParse _ = \_ -> Left "Unknown data type" + +inputFile :: FilePath -> IO ByteString +inputFile "" = BS.hGetContents stdin +inputFile path = BS.readFile path + +outputFile :: FilePath -> ByteString -> IO () +outputFile "" = BS.hPutStr stdout +outputFile path = BS.writeFile path + +main :: IO () +main = getArgs >>= parseArgs' >>= doAction + where + parseArgs' argv = getProgName >>= parseArgs argv diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/ert.cabal b/ert.cabal new file mode 100644 --- /dev/null +++ b/ert.cabal @@ -0,0 +1,91 @@ +-- Initial ert.cabal generated by cabal init. For further documentation, +-- see http://haskell.org/cabal/users-guide/ + +name: ert +version: 0.0.1.0 +synopsis: Easy Runtime Templates +description: EJS-like template engine for Haskell. +license: GPL-3 +license-file: LICENSE +author: K. +maintainer: kayo@illumium.org +-- copyright: +category: Text +build-type: Simple +-- extra-source-files: +cabal-version: >=1.10 + +Flag dev + Description: Turn on development settings. + Default: False + +Flag util + Description: Compiles console utily for testing and rendering templates. + Default: True + +Flag yaml + Description: Compiles console utily with Yaml support. + Default: True + +Flag regex + Description: Adds support of regex matching in expressions. + Default: True + +library + exposed-modules: Data.EasyTpl + -- other-modules: + default-extensions: OverloadedStrings + CPP + -- other-extensions: + build-depends: base >=4.6 && <4.7 + , bytestring >= 0.10.0.2 && < 0.11 + , text >= 0.11.3.1 && < 0.12 + , vector >= 0.10.0.1 && < 0.11 + , unordered-containers >= 0.2.3.0 && < 0.3 + , aeson >= 0.6.2.1 && < 0.7 + , attoparsec >= 0.10.4.0 && < 0.11 + , attoparsec-expr >= 0.1.1.1 && < 0.2 + if flag(regex) + build-depends: regex-compat >= 0.95.1 && < 0.96 + cpp-options: -DWITH_REGEX + + if flag(dev) + ghc-options: -Wall -O0 + cpp-options: -DWITH_DEBUG + else + ghc-options: -O2 + + default-language: Haskell2010 + +executable ert + if flag(util) + Buildable: True + + main-is: Main.hs + default-extensions: OverloadedStrings + CPP + build-depends: base + , ert + , attoparsec >= 0.10.4.0 && < 0.11 + , attoparsec-expr >= 0.1.1.1 && < 0.2 + , bytestring >= 0.10.0.2 && < 0.11 + , text >= 0.11.3.1 && < 0.12 + , vector >= 0.10.0.1 && < 0.11 + , unordered-containers >= 0.2.3.0 && < 0.3 + , aeson >= 0.6.2.1 && < 0.7 + + if flag(regex) + build-depends: regex-compat >= 0.95.1 && < 0.96 + cpp-options: -DWITH_REGEX + + if flag(yaml) + build-depends: yaml >= 0.8.9.1 && < 0.9 + cpp-options: -DWITH_YAML + + if flag(dev) + ghc-options: -Wall -O0 + cpp-options: -DWITH_DEBUG + else + ghc-options: -O2 + + default-language: Haskell2010