TeaMacro (0.1.2)
Using TeaMacro in your Javascript (and CoffeeScript, PHP, Java, C/C++) project, you could optimize code, support cross browser and support cross platform very easily. TeaMacro is macro language. This language works on ECMAScript(Javascript), CoffeeScript, PHP, Java and C/C++.
Usage
Document sample
(code.js)
{ // #teaos:if == DEPLOYMENT CLIENTSIDE var logTag=; logTaginnerHTML+=; /* #teaos:else console.log(s); #teaos:endif */ } { //#teaos:if (== MODE DEBUG) if!cond ; //#teaos:endif } { // #teaos:if ! (defined DISABLE_MULTIPLE_COMMAND) var cmds; var length; cmds=cmd; length=cmdslength; forvar i=0;i<length;i++ ; /* #teaos:else execute(cmd); #teaos:endif */ } { /*#teaos:if (== SCREEN_SIZE SMALL_SIZE) return 'small'; #teaos:elseif (== SCREEN_SIZE NORMAL_SIZE) return 'normal'; #teaos:elseif (== SCREEN_SIZE BIG_SIZE) return 'big'; #teaos:else */ var sz=; ifszwidth>contextparamslongWidth return 'big'; else ifszwidth<contextparamsshortWidth return 'small'; else return 'normal'; //#teaos:endif }
See also,
History
- version 0.1.2 -- Support "namespace" statement -- Support -[s]etting option and -[t]arget option -- Support "include"/"include_once" statement
Command Line
You can test your code without TeaMacro pre-processsor, because TeaMacro is described as the comment of ECMAScript. Having node.js environment, you can compile TeaMacro by using console command. The console command is described by the following form.
> node app.js -p <file path>
After installing TeaMacro in npm global scope, you can use teamacro command.
> npm install tea-macro -g
> teamacro -p <file path>
Using pipeline, you can compile multiple file as a composited file, and store output data in file.
> npm install tea-macro
> cat tests/before.js tests/setting1.js tests/after.js tests/code.js | teamacro > tests/results/result1.js
You can set a setting file, using '-s' option. See "Setting file".
> teamacro -s <setting file path>
> teamacro -s <setting file path> -t <target scope>
Propose
Switch debug/release mode
(before.js)
// #teaos:define DEBUG 1
// #teaos:define RELEASE 2
(setting.js)
// #teaos:define MODE RELEASE
(after.js)
// #teaos:if (!defined MODE)
// #teaos:define MODE DEBUG
// #teaos:endif
(code.js)
{ //#teaos:if (== MODE DEBUG) var log=; loginnerHTML+=; //#teaos:endif }
Switch Serverside/Clientside javascript
(before.js)
// #teaos:define SERVERSIDE 1
// #teaos:define CLIENTSIDE 2
(setting.js) user setting file
// #teaos:define DEPLOYMENT CLIENTSIDE
(after.js)
// #teaos:if (!defined DEPLOYMENT)
// #teaos:define DEPLOYMENT CLIENTSIDE
// #teaos:endif
(code.js)
{ //#teaos:if (== DEPLOYMENT CLIENTSIDE) var log=; loginnerHTML+=; /*#teaos:else console.log(s); #teaos:endif */ }
Switch Optimized code/General code
(setting.js) user setting file
// #teaos:define DISABLE_MULTIPLE_COMMAND
(code.js)
{ // #teaos:if defined DISABLE_MULTIPLE_COMMAND var cmds; var length; cmds=cmd; length=cmdslength; forvar i=0;i<length;i++ ; /* #teaos:else execute(cmd); #teaos:endif */ }
Support cross platform
(before.js)
// #teaos:define ANY_DEVICE 0
// #teaos:define IPHONE 1
// #teaos:define ANDROID 2
// #teaos:define CHROME 3
// #teaos:define IPAD 4
// #teaos:define WINDOWSPC 5
// #teaos:define LINUXPC 6
// #teaos:define MACPC 7
// #teaos:define DEVICE ANY_DEVICE
//
// #teaos:define ANY_SIZE 0
// #teaos:define SMALL_SIZE 1
// #teaos:define NORMAL_SIZE 2
// #teaos:define BIG_SIZE 3
// #teaos:define SCREEN_SIZE ANY_SIZE
(setting.js)
// #teaos:define DEVICE IPAD
(after.js)
// #teaos:if (|| (== DEVICE IPHONE) (== DEVICE ANDROID))
// #teaos:define SCREEN_SIZE SMALL_SIZE
// #teaos:elseif (== DEVICE IPAD)
// #teaos:define SCREEN_SIZE NORMAL_SIZE
// #teaos:elseif (|| (== DEVICE WINDOWSPC) (== DEVICE LINUXPC) (== DEVICE MACPC))
// #teaos:define SCREEN_SIZE BIG_SIZE
// #teaos:else
// #teaos:define SCREEN_SIZE ANY_SIZE
// #teaos:endif
(code.js)
{ /*#teaos:if (== SCREEN_SIZE SMALL_SIZE) return 'short'; #teaos:elseif (== SCREEN_SIZE NORMAL_SIZE) return 'normal'; #teaos:elseif (== SCREEN_SIZE BIG_SIZE) return 'long'; #teaos:else */ var sz=; ifszwidth>contextparamslongWidth return 'long'; else ifszwidth<contextparamslongWidth return 'small'; else return 'short'; //#endif }
TeaMacro Syntax
Statement
"define" statement
"define" statement defines the parameter which is refered in another statement.
// #teaos:define DEBUG 1
// #teaos:define RELEASE 2
// #teaos:define MODE DEBUG
"namespace" statement
"namespace" statement defines the namespace of macro statement. default namespace is "teaos".
// #teaos:namespace
// #:define PARAM1 1
// #:define PARAM2 2
// #:namespace teaos
include/include_once/include_code[TBD]/include_code_once[TBD] statement
"include" statement imports the specified file in the current document.
// #teaos:include <filepath>
"include_once" statement imports the specified file in the current document at once.
// #teaos:include_once <filepath>
"include_code" statement imports the specified file in the current document. The difference between "include_code" and "include" is to strip the top of comment.
// #teaos:include_code <filepath>
if/elseif(or elif)/endif statement
pattern:1
// #teaos:if <expression>
<active code>
/* #teaos:elseif <expression>
<inactive code>
#teaos:else
<inactive code>
#teaos:endif */
pattern:2
/* #teaos:if <expression>
<inactive code>
#teaos:else */
<active code>
// #teaos:endif
pattern:3
/* #teaos:if <expression>
<inactive code>
#teaos:else */
<active code>
// #teaos:endif
Expression
TeaMacro expression is like LISP.
'defined' expression
'defined' expression checks if the specified parameter is defined.
(defined <parameter name> <parameter name> ...)
'append' expression
'append' expression append string.
(append <expression> <expression> ...)
expression for composition (logical and / logical or / logical not)
'&&' expression caluculates logical and. '||' expression caluculates logical or.
(&& <expression> <expression> ...)
(|| <expression> <expression> ...)
(! <expression>)
expression for comparison
'==' expression check if left expression equals right expression. '!=' expression check if left expression doesn't equal right expression.
(== <expression> <expression>)
(!= <expression> <expression>)
Replacement macro in document
'$teaos:{}' keyword in document is replaced to macro variable.
mode is #teaos:{MODE}.
deployment is #teaos:{DEPLOYMENT}.
Setting file
The format of setting file is JSON, as follows. The key of hash table is target scope, and the value of hash table is the setting of compiling and compressing.
{
"setting1":{
"before":["before.js","settings/1.js","after.js"],
"inputs":["code.hpp","code.java","code.js","code.php","code2.coffee"],
"outputs":"results/result1.${extension}"
},
"setting2":{
"before":["before.js","settings/2.js","after.js"],
"inputs":["code.hpp","code.java","code.js","code.php","code2.coffee"],
"outputs":"results/result2.${extension}"
},
"setting3":{
"before":["before.js","settings/3.js","after.js"],
"inputs":["code.hpp","code.java","code.js","code.php","code2.coffee"],
"outputs":"results/result3.${extension}"
},
"setting4":{
"before":["before.js","settings/4.js","after.js"],
"inputs":["code.hpp","code.java","code.js","code.php","code2.coffee"],
"outputs":"results/result4.${extension}"
},
"input_g":{
"inputs":["input.js"],
"outputs":"results/output1.js"
},
"input_c":{
"inputs":["input.js"],
"outputs":"results/output2.js",
"compress":{"js":"js"}
},
"input_co":{
"inputs":["input.coffee"],
"outputs":"results/output3.js",
"compile":{"coffee":"coffee"}
},
"input":{
"targets":["input_g","input_c","input_co"]
}
}
The setting attributes of compiling and compressing are as fellow.
- "before" attribute: Array of config file. These files are loaded, before input file loaded.
- "inputs" attribute: Array of input file.
- "after" attribute: Array of config file. These files are loaded after input file loaded.
- "outputs" attribute: output file descriptor. ${path}, ${extension}, ${name} are avairable. -- ${path}: path of input file. -- ${extension}: extension of input file. -- ${name}: name of input file.
- "compile" attribute: Compiler setting. Hash pattern. ex) {"coffee":"coffee"}
- "compress" attribute: Compressor setting. Hash pattern. ex) {"js":"js"}
- "targets" attribute: grouping targets.
License
Copyright © 2012-2012 Toru Nomakuchi Distributed under the MIT License.