Better, I guess.

Deduce common base type from a list of types

haxelib.json

@@ -9,8 +9,8 @@
 	"contributors": [
 		"back2dos"
 	],
-	"version": "0.20.1",
-	"releasenote": "Avoid messing with typing order.",
+	"version": "0.22.0",
+	"releasenote": "Support Haxe 4.2",
 	"tags": [
 		"tink",
 		"macro",

src/tink/MacroApi.hx

@@ -54,9 +54,16 @@ class MacroApi {
 
   static public var completionPoint(default, null):Option<{
     var file(default, never):String;
+    var content(default, never):Null<String>;
     var pos(default, never):Int;
   }>;
 
+  static public function getBuildFields():Option<Array<haxe.macro.Expr.Field>>
+    return switch completionPoint {
+      case Some(v) if (v.content != null && (v.content.charAt(v.pos - 1) == '@' || (v.content.charAt(v.pos - 1) == ':' && v.content.charAt(v.pos - 2) == '@'))): None;
+      default: Some(haxe.macro.Context.getBuildFields());
+    }
+
   static public var args(default, null):Iterable<String>;
   static var initialized = initArgs();
 
@@ -73,12 +80,15 @@ class MacroApi {
             params:{
               file:String,
               offset:Int,
+              contents:String,
             }
           } = haxe.Json.parse(arg);
+
           switch payload {
             case { jsonrpc: '2.0', method: 'display/completion' }:
               Some({
                 file: payload.params.file,
+                content: payload.params.contents,
                 pos: payload.params.offset,
               });
             default: None;

src/tink/macro/BuildCache.hx

@@ -17,18 +17,18 @@ typedef BuildContextN = {
 
 
 typedef BuildContext = {
-  pos:Position,
-  type:Type,
-  usings:Array<TypePath>,
-  name:String,
+  var pos(default, never):Position;
+  var type(default, never):Type;
+  var usings(default, never):Array<TypePath>;
+  var name(default, never):String;
 }
 
 typedef BuildContext2 = {>BuildContext,
-  type2:Type,
+  var type2(default, never):Type;
 }
 
 typedef BuildContext3 = {>BuildContext2,
-  type3:Type,
+  var type3(default, never):Type;
 }
 
 class BuildCache {
@@ -36,29 +36,20 @@ class BuildCache {
   @:persistent static var cache = new Map();
 
   static public function getType3(name, ?types, ?pos:Position, build:BuildContext3->TypeDefinition, ?normalizer:Type->Type) {
-     if (types == null)
-      switch Context.getLocalType() {
-        case TInst(_.toString() == name => true, [t1, t2, t3]):
-          types = { t1: t1, t2: t2, t3: t3 };
-        default:
-          throw 'assert';
-      }
-
-    var t1 = types.t1.toComplexType(),
-        t2 = types.t2.toComplexType(),
-        t3 = types.t2.toComplexType();
-
-    return getType(name, (macro : { t1: $t1, t2: $t2, t3: $t3 } ).toType(), pos, function (ctx) return build({
-      type: types.t1,
-      type2: types.t2,
-      type3: types.t3,
+    return _getTypeN(name, 3, switch types {
+      case null: null;
+      case v: [types.t1, types.t2, types.t3];
+    }, pos, ctx -> build({
       pos: ctx.pos,
-      name: ctx.name,
-      usings: ctx.usings
+      type: ctx.types[0],
+      type2: ctx.types[1],
+      type3: ctx.types[2],
+      usings: ctx.usings,
+      name: ctx.name
     }), normalizer);
   }
 
-  static public function getTypeN(name, ?types, ?pos:Position, build:BuildContextN->TypeDefinition, ?normalizer:Type->Type) {
+  static function _getTypeN(name, length, ?types, ?pos:Position, build:BuildContextN->TypeDefinition, ?normalizer:Type->Type) {
 
     if (pos == null)
       pos = Context.currentPos();
@@ -67,50 +58,37 @@ class BuildCache {
       switch Context.getLocalType() {
         case TInst(_.toString() == name => true, params):
           types = params;
-        default:
-          throw 'assert';
+        case t:
+          pos.error('expected $name but found ${t.toString()}');
       }
 
-    var compound = ComplexType.TAnonymous([for (i in 0...types.length) {
-      name: 't$i',
-      pos: pos,
-      kind: FVar(switch types[i] {
-        case TInst(_.get().kind => KExpr(e), _):
-          TPath('tink.macro.ConstParam'.asTypePath([TPExpr(e)]));
-        case t: t.toComplex();
-      }),
-    }]).toType();
+    if (length != -1 && types.length != length)
+      pos.error('expected $length parameter${if (length == 1) '' else 's'}');
 
-    return getType(name, compound, pos, function (ctx) return build({
-      types: types,
-      pos: ctx.pos,
-      name: ctx.name,
-      usings: ctx.usings
-    }), normalizer);
-  }
-
-  static public function getType2(name, ?types, ?pos:Position, build:BuildContext2->TypeDefinition, ?normalizer:Type->Type) {
-    if (types == null)
-      switch Context.getLocalType() {
-        case TInst(_.toString() == name => true, [t1, t2]):
-          types = { t1: t1, t2: t2 };
-        default:
-          throw 'assert';
+    var forName =
+      switch cache[name] {
+        case null: cache[name] = new Group(name);
+        case v: v;
       }
 
-    var t1 = types.t1.toComplexType(),
-        t2 = types.t2.toComplexType();
-
-    return getType(name, (macro : { t1: $t1, t2: $t2 } ).toType(), pos, function (ctx) return build({
-      type: types.t1,
-      type2: types.t2,
-      pos: ctx.pos,
-      name: ctx.name,
-      usings: ctx.usings
-    }), normalizer);
+    var ret = forName.get(types, pos.sanitize(), build, normalizer);
+    ret.getFields();// workaround for https://github.com/HaxeFoundation/haxe/issues/7905
+    return ret;
   }
 
-  static public function getParams(name:String, ?pos:Position)
+  static public function getType2(name, ?types, ?pos:Position, build:BuildContext2->TypeDefinition, ?normalizer:Type->Type)
+    return _getTypeN(name, 2, switch types {
+      case null: null;
+      case v: [types.t1, types.t2];
+    }, pos, ctx -> build({
+      pos: ctx.pos,
+      type: ctx.types[0],
+      type2: ctx.types[1],
+      usings: ctx.usings,
+      name: ctx.name
+    }), normalizer);
+
+  static public function getParams(name:String, ?pos:Position, ?count:Int)
     return
       switch Context.getLocalType() {
         case TInst(_.toString() == name => true, v):
@@ -131,70 +109,50 @@ class BuildCache {
         });
 
   static public function getType(name, ?type, ?pos:Position, build:BuildContext->TypeDefinition, ?normalizer:Type->Type) {
-
-    if (type == null)
-      type = getParam(name, pos).sure();
-
-    var forName =
-      switch cache[name] {
-        case null: cache[name] = new Group(name, normalizer);
-        case v: v;
-      }
-
-    var ret = forName.get(type, pos.sanitize(), build);
-    ret.getFields();// workaround for https://github.com/HaxeFoundation/haxe/issues/7905
-    return ret;
+    return _getTypeN(name, 1, switch type {
+      case null: null;
+      case v: [v];
+    }, pos, ctx -> build({
+      pos: ctx.pos,
+      type: ctx.types[0],
+      usings: ctx.usings,
+      name: ctx.name
+    }), normalizer);
   }
 }
 
-private typedef Entry = {
-  name:String,
-}
-
-private class Group {
+private class Group {//TODO: this is somewhat obsolete
 
   var name:String;
-  var counter = 0;
-  var entries:TypeMap<Entry>;
 
-  public function new(name, ?normalizer) {
+  public function new(name) {
     this.name = name;
-    this.entries = new TypeMap(normalizer);
   }
 
-  public function get(type:Type, pos:Position, build:BuildContext->TypeDefinition):Type {
+  public function get(types:Array<Type>, pos:Position, build:BuildContextN->TypeDefinition, ?normalizer):Type {
 
-    function make(path:String) {
-      var usings = [];
-      var def = build({
-        pos: pos,
-        type: type,
-        usings: usings,
-        name: path.split('.').pop()
-      });
+    types = types.map(switch normalizer {
+      case null: function (t) return Context.follow(t);
+      case f: f;
+    });
 
-      entries.set(type, { name: path } );
-      Context.defineModule(path, [def], usings);
-      return Context.getType(path);
+    var retName = name + '_' + Context.signature(Sisyphus.exactParams(types));
+
+    return switch retName.definedType() {
+      case Some(v): v;
+      case None:
+        var usings = [];
+        var path = name.split('.');
+
+        var ret = build({
+          pos: pos,
+          types: types,
+          usings: usings,
+          name: retName.split('.').pop(),
+        });
+
+        Context.defineModule(retName, [ret], usings);
+        Context.getType(retName);
     }
-
-    function doMake()
-      while (true)
-        switch '$name${counter++}' {
-          case _.definedType() => Some(_):
-          case v:
-            return make(v);
-        }
-
-    return
-      switch entries.get(type) {
-        case null:
-          doMake();
-        case v:
-          switch v.name.definedType() {
-            case Some(v): v;
-            default: doMake();
-          }
-      }
   }
 }

src/tink/macro/ClassBuilder.hx

@@ -23,7 +23,10 @@ class ClassBuilder {
       target = Context.getLocalClass().get();
 
     if (fields == null)
-      fields = Context.getBuildFields();
+      fields = switch MacroApi.getBuildFields() {
+        case None: target.pos.error('Impossible to get builds fields now. Possible cause: https://github.com/HaxeFoundation/haxe/issues/9853');
+        case Some(v): v;
+      }
 
     this.initializeFrom = fields;
     this.target = target;
@@ -192,10 +195,14 @@ class ClassBuilder {
     return m;
   }
 
-  static public function run(plugins:Array<ClassBuilder->Void>, ?verbose) {
-    var builder = new ClassBuilder();
-    for (p in plugins)
-      p(builder);
-    return builder.export(verbose);
-  }
+  static public function run(plugins:Array<ClassBuilder->Void>, ?verbose)
+    return switch MacroApi.getBuildFields() {
+      case None: null;
+      case Some(fields):
+        var builder = new ClassBuilder(fields);
+        for (p in plugins)
+          p(builder);
+        return builder.export(verbose);
+
+    }
 }

src/tink/macro/Sisyphus.hx

@@ -2,6 +2,8 @@ package tink.macro;
 
 import haxe.macro.Expr;
 import haxe.macro.Type;
+using haxe.macro.Tools;
+using tink.MacroApi;
 
 class Sisyphus {
 
@@ -61,8 +63,7 @@ class Sisyphus {
     }
   }
 
-
-  public static function toComplexType(type : Null<Type>) : Null<ComplexType> return {
+  static public function toComplexType(type : Null<Type>) : Null<ComplexType> return {
     inline function direct()
       return Types.toComplex(type, { direct: true });
     switch (type) {
@@ -136,4 +137,91 @@ class Sisyphus {
       }],
     }
   }
+
+  static function exactBase<T:BaseType>(r:Ref<T>, params:Array<Type>) {
+    var t = r.get();
+    var isMain = !t.isPrivate && switch t.pack {
+      case []: t.module == t.name || t.module == 'StdTypes';
+      default: StringTools.endsWith(t.module, '.${t.name}');
+    }
+
+    return (
+      if (isMain) t.pack.concat([t.name]).join('.')
+      else t.module + '.' + t.name
+    ) + exactParams(params);
+  }
+
+  static inline function isFinal(c:ClassField)
+    return #if haxe4 c.isFinal #else false #end;
+
+  static function exactAnonField(c:ClassField) {
+    var kw =
+      switch c.kind {
+        case FMethod(_): 'function';
+        case FVar(_):
+          if (isFinal(c)) 'final' else 'var';
+      }
+
+    return [for (m in c.meta.get()) m.toString() + ' '].join('') + '$kw ${c.name}' + (switch c.kind {
+      case FVar(read, write):
+        (
+          if (isFinal(c) || (read == AccNormal && write == AccNormal)) ''
+          else '(${read.accessToName()}, ${read.accessToName(false)})'
+        ) + ':' + c.type.toExactString();
+      case FMethod(_):
+        switch haxe.macro.Context.follow(c.type) {
+          case TFun(arg, ret): exactSig(arg, ret, ':');
+          default: throw 'assert';
+        }
+    }) + ';';
+  }
+
+  static function exactSig(args:Array<{name:String, opt:Bool, t:Type}>, ret:Type, sep:String)
+    return '(${[for (a in args) (if (a.opt) '?' else '') + a.name + ':' + toExactString(a.t)].join(', ')})$sep${toExactString(ret)}';
+
+  static public function exactParams(params:Array<Type>)
+    return switch params {
+      case []: '';
+      case params:
+        '<${params.map(toExactString).join(', ')}>';
+    }
+  static public function toExactString(t:Type)
+    return switch t {
+      case TMono(t): t.toString();
+      case TEnum(r, params): exactBase(r, params);
+      case TInst(r, params): exactBase(r, params);
+      case TType(r, params): exactBase(r, params);
+      case TAbstract(r, params): exactBase(r, params);
+      case TFun(args, ret): exactSig(args, ret, '->');
+      case TAnonymous(a): '{ ${[for (f in a.get().fields) exactAnonField(f)].join(' ')} }';
+      case TDynamic(null): 'Dynamic';
+      case TDynamic(t): 'Dynamic<${toExactString(t)}>';
+      case TLazy(f): toExactString(f());
+    }
+
+    static function eager(t:Type)
+      return switch t {
+        case TLazy(f): eager(f());
+        default: t;
+      }
+
+    static public function compare(t1:Type, t2:Type, ?follow:Bool = true) {
+      if (follow) {
+        t1 = t1.reduce();
+        t2 = t2.reduce();
+      }
+      else {
+        t1 = eager(t1);
+        t2 = eager(t2);
+      }
+
+      return switch t1.getIndex() - t2.getIndex() {
+        case 0:
+          switch Reflect.compare(t1.toString(), t2.toString()) {
+            case 0: Reflect.compare(t1.toExactString(), t2.toExactString());
+            case v: v;
+          }
+        case v: v;
+      }
+    }
 }

src/tink/macro/Types.hx

@@ -10,9 +10,11 @@ using haxe.macro.Tools;
 using tink.MacroApi;
 using tink.CoreApi;
 
+import haxe.macro.Type.Ref;
+
 class Types {
 
-  static public function definedType(typeName:String)
+  static public function definedType(typeName:String):Option<Type>
     return
       try {
         Some(Context.getType(typeName));
@@ -172,6 +174,9 @@ class Types {
                 #if haxe4
                 isExtern: field.isExtern,
                 isFinal: field.isFinal,
+                #if (haxe >= version("4.2.0-rc.1"))
+                isAbstract: field.isAbstract,
+                #end
                 #end
               }:ClassField)
             ]);
@@ -205,7 +210,22 @@ class Types {
         default: Failure('type "$t" has no position');
       }
 
+  static public function deduceCommonType(types:Array<Type>):Outcome<Type, Error> {
+    var exprs = types.map(function(t) {
+      var ct = t.toComplex();
+      return macro (null:$ct);
+    });
 
+    return switch (macro $a{exprs}).typeof() {
+      case Success(TInst(_, [v])): Success(v);
+      case Success(_): throw 'unreachable';
+      case Failure(e): Failure(new Error('Unable to deduce common type among $types'));
+    }
+  }
+
+  /// like haxe.macro.TypeTools.toString, but not lossy
+  static public function toExactString(t:Type)
+    return Sisyphus.toExactString(t);
 
   static public function toString(t:ComplexType)
     return new Printer().printComplexType(t);
@@ -293,6 +313,9 @@ class Types {
 
     if (types.length == 1) return Success(types[1]);
 
+    #if haxe4
+    return Success(TIntersection(types));
+    #end
     var paths = [],
         fields = [];
 
@@ -334,18 +357,8 @@ class Types {
           throw 'assert';
       }
 
-  static public function compare(t1:Type, t2:Type, ?follow:Bool = true) {
-    if (follow) {
-      t1 = t1.reduce();
-      t2 = t2.reduce();
-    }
-
-    return switch t1.getIndex() - t2.getIndex() {
-      case 0:
-        Reflect.compare(t1.toString(), t2.toString());//much to my surprise, this actually seems to work (at least with 3.4)
-      case v: v;
-    }
-  }
+  static public function compare(t1:Type, t2:Type, ?follow:Bool = true)
+    return Sisyphus.compare(t1, t2, follow);
 
   static var SUGGESTIONS = ~/ \(Suggestions?: .*\)$/;
 

tests/Dummy.hx

@@ -0,0 +1,8 @@
+class Dummy {
+  public function new() {}
+  static public var p(default, never) = new Private();
+}
+
+private class Private {
+  public function new() {}
+}

tests/ExactStrings.hx

@@ -0,0 +1,21 @@
+import haxe.macro.Context.typeof;
+using tink.MacroApi;
+
+class ExactStrings extends Base {
+  function test() {
+    function expect(s:String, e, ?pos)
+      assertEquals(s, typeof(e).toExactString(), pos);
+
+    expect('Dummy', macro new Dummy());
+    expect('nested.Dummy', macro new nested.Dummy());
+    expect('Dummy.Private', macro Dummy.p);
+    expect('nested.Dummy.Private', macro nested.Dummy.p);
+    expect('{ @foo var x:Int; }', macro (null:{@foo var x:Int;}));
+    expect('{ @foo @bar var x:Int; }', macro (null:{@foo @bar var x:Int;}));
+    expect('{ @bar @foo var x:Int; }', macro (null:{@bar @foo var x:Int;}));// not 100% sure this is always the best choice, but let's roll with it
+    expect('{ @bar var x:Int; }', macro (null:{@bar var x:Int;}));
+    expect('{ var x:Int; var y:Int; }', macro (null:{x:Int,y:Int}));
+    expect('{ var x:Int; var y:Int; }', macro (null:{y:Int,x:Int}));
+    expect('{ function foo(x:Int, ?y:Int):Void; }', macro (null:{ function foo(x:Int, ?y:Int):Void; }));
+  }
+}

tests/Run.hx

@@ -1,6 +1,9 @@
 package ;
 
 import haxe.unit.*;
+#if macro
+using haxe.macro.Tools;
+#end
 
 class Run {
   #if !macro
@@ -14,6 +17,7 @@ class Run {
     new TypeMapTest(),
     new Functions(),
     new Misc(),
+    new ExactStrings(),
   ];
   #end
   macro static function test() {

tests/TypeMapTest.hx

@@ -11,6 +11,8 @@ class TypeMapTest extends TestCase {
     var t = new TypeMap();
     var t1 = (macro [{ foo: [{ bar: '5' }]}]).typeof().sure();
     var t2 = (macro [{ foo: [{ bar: 5 }]}]).typeof().sure();
+    var t3 = (macro [{ foo: [{ bar: 5 }]}]).typeof().sure();
+    var t4 = (macro [{ foo: [({ bar: 5 }:{ @foo var bar:Int; })]}]).typeof().sure();
 
     t.set(t1, 0);
     assertEquals(Lambda.count(t), 1);
@@ -19,7 +21,10 @@ class TypeMapTest extends TestCase {
     t.set(t1, 2);
     assertEquals(Lambda.count(t), 2);
     t.set(t2, 3);
+    t.set(t3, 3);
     assertEquals(Lambda.count(t), 2);
+    t.set(t4, 4);
+    assertEquals(Lambda.count(t), 3);
 
     assertEquals(t.get(t1), 2);
     assertEquals(t.get(t2), 3);

tests/Types.hx

@@ -10,36 +10,35 @@ using tink.MacroApi;
 class Types extends Base {
   function type(c:ComplexType)
     return c.toType().sure();
-    
+
   function resolve(type:String)
     return Context.getType(type);
-    
+
   inline function assertSuccess<S, F>(o:Outcome<S, F>)
     assertTrue(o.isSuccess());
-    
+
   inline function assertFailure<S, F>(o:Outcome<S, F>)
     assertFalse(o.isSuccess());
-    
+
   function testIs() {
-    
     assertSuccess(resolve('Int').isSubTypeOf(resolve('Float')));
     assertFailure(resolve('Float').isSubTypeOf(resolve('Int')));
-  }  
-  
+  }
+
   function testFields() {
     var expected = type(macro : Void -> Iterator<Arrayish>),
       iterator = type(macro : haxe.ds.StringMap<Arrayish>).getFields(true).sure().filter(function (c) return c.name == 'iterator')[0];
-    
+
     assertSuccess(iterator.type.isSubTypeOf(expected));
     assertSuccess(expected.isSubTypeOf(iterator.type));
   }
-  
+
   function testConvert() {
     assertSuccess((macro : Int).toType());
     assertFailure((macro : Tni).toType());
     function blank()
       return type(MacroApi.pos().makeBlankType());
-    
+
     var bool = type(macro : Bool);
     assertTrue(blank().isSubTypeOf(bool).isSuccess());
     assertTrue(bool.isSubTypeOf(blank()).isSuccess());
@@ -65,5 +64,20 @@ class Types extends Base {
     assertEquals('String', Context.getType('String').toComplex().toString());
     assertEquals('tink.CoreApi.Noise', Context.getType('tink.CoreApi.Noise').toComplex().toString());
   }
+
+  function testDeduceCommonType() {
+    function ct2t(ct:ComplexType) return ct.toType().sure();
+    assertEquals('StdTypes.Float', tink.macro.Types.deduceCommonType([(macro:Float), (macro:Int)].map(ct2t)).sure().toComplex().toString());
+    assertEquals('Types.CommonI1', tink.macro.Types.deduceCommonType([(macro:Types.CommonA), (macro:Types.CommonB), (macro:Types.CommonC)].map(ct2t)).sure().toComplex().toString());
+    assertEquals('Types.CommonI2', tink.macro.Types.deduceCommonType([(macro:Types.CommonB), (macro:Types.CommonC)].map(ct2t)).sure().toComplex().toString());
+    // assertEquals('Types.CommonI3', tink.macro.Types.deduceCommonType([(macro:Types.CommonC)].map(ct2t)).sure().toComplex().toString());
+  }
 }
-#end
+#end
+
+interface CommonI1 {}
+interface CommonI2 {}
+interface CommonI3 {}
+class CommonA implements CommonI1 {}
+class CommonB implements CommonI2 implements CommonI1 {}
+class CommonC implements CommonI3 implements CommonI2 implements CommonI1 {}

tests/nested/Dummy.hx

@@ -0,0 +1,10 @@
+package nested;
+
+class Dummy {
+  public function new() {}
+  static public var p(default, never) = new Private();
+}
+
+private class Private {
+  public function new() {}
+}