kiss-lang/tink_macro
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update doc. Bump version.

Browse Source
This commit is contained in:
back2dos
2013-10-21 22:31:56 +02:00
parent 70f2c9ba40
commit c9d530a02c
2 changed files with 393 additions and 391 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -336,7 +336,7 @@ class Constructor {
function addStatement(e:Expr, ?prepend = false):Void; function addStatement(e:Expr, ?prepend = false):Void;
function addArg(name:String, ?t:ComplexType, ?e:Expr, ?opt = false) function addArg(name:String, ?t:ComplexType, ?e:Expr, ?opt = false)
function init(name:String, pos:Position, with:FieldInit, ?options:{ ?prepend:Bool, ?bypass:Bool }):Void; function init(name:String, pos:Position, with:FieldInit, ?options:{ ?prepend:Bool, ?bypass:Bool }):Void;
function onGenerate(hook:Expr->Expr):Void; function onGenerate(hook:Function->Void):Void;
} }
``` ```
@@ -352,7 +352,7 @@ The constructor starts out without `private` or `public`. Use `isPublic` and `pu
### Initial super call ### Initial super call
If the first statement in a constructor is a `super` call (which is true for automatically generated ones), then modification of the constructor through this API will maintain that property. Generally, that's also the suggested way to go. If you *need* to execute things *before* that's a symptom of a [fragile base class](http://en.wikipedia.org/wiki/Fragile_base_class). Still, if *absolutely* want to do it, the slightest modification can be used to not match the `super` call detection. If the first statement is `@later super(...)`, then it will not be detected as a super call and will not be treated specially. If the first statement in a constructor is a `super` call (which is true for automatically generated ones), then modification of the constructor through this API will maintain that property. Generally, that's also the suggested way to go. If you *need* to execute things *before* that's a symptom of a [fragile base class](http://en.wikipedia.org/wiki/Fragile_base_class). Still, if *absolutely* want to do it, the slightest modification can be used to not match the `super` call detection. If the first statement is `@later super(...)` or `(super(...))` or whatever that is not an immediate call to super, then it will not be detected as a super call and will not be treated specially.
### Simple modifications ### Simple modifications
@@ -368,7 +368,9 @@ The `init` method is the swiss army knife of initializing fields. The `options.p
It is important to know that when you initialize a field with `options.bypass` set to true, existing setters will by bypassed. That's particularly helpful if your setter triggers a side effect that you don't want triggered. This is achieved by generating the assignment as `(untyped this).$name = $value`. To make the code typesafe again, this is prefixed with `if (false) { var __tmp = this.$name; __tmp = $value; }`. This code is later thrown out by the compiler. Its role is to ensure type safety without interfering with the normal typing order. It is important to know that when you initialize a field with `options.bypass` set to true, existing setters will by bypassed. That's particularly helpful if your setter triggers a side effect that you don't want triggered. This is achieved by generating the assignment as `(untyped this).$name = $value`. To make the code typesafe again, this is prefixed with `if (false) { var __tmp = this.$name; __tmp = $value; }`. This code is later thrown out by the compiler. Its role is to ensure type safety without interfering with the normal typing order.
Please do note, that the value will be in the generated code twice, therefore if it is an expression that calls a macro, the macro will be called twice. Setter bypass also causes the field to gain an `@:isVar`. And currently, with `-dce full`, additional code will be generated to avoid the field to be eliminated.
Please do note, that `value` will be in the generated code twice, therefore if it is an expression that calls a macro, the macro will be called twice.
#### Initialization options #### Initialization options

4
haxelib.json
View File

@@ -4,8 +4,8 @@
"license": "MIT", "license": "MIT",
"tags": ["tink", "macro", "utility"], "tags": ["tink", "macro", "utility"],
"description": "The macro toolkit ;)", "description": "The macro toolkit ;)",
"version": "0.0.2-beta", "version": "0.0.3-beta",
"releasenote": "Support haxe/java oddities.", "releasenote": "Sidestep dce issues.",
"contributors": ["back2dos"], "contributors": ["back2dos"],
"dependencies": { "dependencies": {
"tink_core": "1.0.0-beta.4" "tink_core": "1.0.0-beta.4"