Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct EnumValueMap implementation #9670

Open
wants to merge 7 commits into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
correct EnumValueMap implementation
  • Loading branch information
RealyUniqueName committed Jun 30, 2020
commit 9aeee4126122d3e5b400fd03b11e881fe845fab1
152 changes: 119 additions & 33 deletions std/haxe/ds/EnumValueMap.hx
Original file line number Diff line number Diff line change
Expand Up @@ -22,49 +22,135 @@

package haxe.ds;

import haxe.Constraints.IMap;
import Type.ValueType;

/**
EnumValueMap allows mapping of enum value keys to arbitrary values.

Keys are compared by value and recursively over their parameters. If any
parameter is not an enum value, `Reflect.compare` is used to compare them.
**/
class EnumValueMap<K:EnumValue, V> extends haxe.ds.BalancedTree<K, V> implements haxe.Constraints.IMap<K, V> {
override function compare(k1:EnumValue, k2:EnumValue):Int {
var d = k1.getIndex() - k2.getIndex();
if (d != 0)
return d;
var p1 = k1.getParameters();
var p2 = k2.getParameters();
if (p1.length == 0 && p2.length == 0)
return 0;
return compareArgs(p1, p2);
class EnumValueMap<K:EnumValue, V> implements IMap<K, V> {
var enums:Array<K> = [];
var values:Array<V> = [];

public function new() {}

public function get(k:K):Null<V> {
for(index => e in enums) {
if(equalEnums(e, k)) {
return values[index];
}
}
return null;
}

function compareArgs(a1:Array<Dynamic>, a2:Array<Dynamic>):Int {
var ld = a1.length - a2.length;
if (ld != 0)
return ld;
for (i in 0...a1.length) {
var d = compareArg(a1[i], a2[i]);
if (d != 0)
return d;
public function set(k:K, v:V):Void {
for(index => e in enums) {
if(equalEnums(e, k)) {
values[index] = v;
return;
}
}
return 0;
enums.push(k);
values.push(v);
}

function compareArg(v1:Dynamic, v2:Dynamic):Int {
return if (Reflect.isEnumValue(v1) && Reflect.isEnumValue(v2)) {
compare(v1, v2);
} else if (Std.isOfType(v1, Array) && Std.isOfType(v2, Array)) {
compareArgs(v1, v2);
} else {
Reflect.compare(v1, v2);
public function exists(k:K):Bool {
for(e in enums) {
if(equalEnums(e, k)) {
return true;
}
}
return false;
}

public function remove(k:K):Bool {
for(index => e in enums) {
if(equalEnums(e, k)) {
enums.splice(index, 1);
values.splice(index, 1);
return true;
}
}
return false;
}

public inline function keys():Iterator<K> {
return enums.iterator();
}

public inline function iterator():Iterator<V> {
return values.iterator();
}

public inline function keyValueIterator():KeyValueIterator<K, V> {
return new haxe.iterators.MapKeyValueIterator(this);
}

public function copy():IMap<K, V> {
var result = new EnumValueMap();
result.enums = enums.copy();
result.values = values.copy();
return result;
}

public function toString():String {
var pairs = [for(i => e in enums) Std.string(e) + ' => ' + Std.string(values[i])];
return '[' + pairs.join(', ') + ']';
}

override function copy():EnumValueMap<K, V> {
var copied = new EnumValueMap<K, V>();
copied.root = root;
return copied;
public function clear():Void {
enums.resize(0);
values.resize(0);
}

static function equal(v1:Dynamic, v2:Dynamic):Bool {
if(v1 == v2)
return true;

return switch [Type.typeof(v1), Type.typeof(v2)] {
case [TClass(Array), TClass(Array)]:
equalArrays(v1, v2);
case [TEnum(_), TEnum(_)]:
equalEnums(v1, v2);
case _:
false;
}
}

static function equalEnums(e1:EnumValue, e2:EnumValue) {
if(e1 == e2)
return true;

if(Type.enumIndex(e1) != Type.enumIndex(e2))
return false;

if(Type.getEnum(e1) != Type.getEnum(e2))
return false;

var params1 = Type.enumParameters(e1);
var params2 = Type.enumParameters(e2);
if(params1.length != params2.length)
return false;

for(i => v1 in params1) {
if(!equal(v1, params2[i]))
return false;
}

return true;
}

static function equalArrays(a1:Array<Dynamic>, a2:Array<Dynamic>):Bool {
if(a1 == a2)
return false;
RealyUniqueName marked this conversation as resolved.
Show resolved Hide resolved

if(a1.length != a2.length)
return false;

for(i => v1 in a1) {
if(!equal(v1, a2[i]))
return false;
}
return true;
}
}
28 changes: 28 additions & 0 deletions tests/unit/src/unit/issues/Issue2479.hx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
package unit.issues;

class Issue2479 extends unit.Test {
function test() {
var map:Map<EFoo, Int> = [];
var k1 = new FooParam();
var k2 = new FooParam();
var k3 = new FooParam();
var k4 = new FooParam();
map[Foo(k1)] = 1;
map[Foo(k2)] = 2;
map[Foo(k3)] = 3;
map[Foo(k4)] = 4;
eq(1, map[Foo(k1)]);
eq(2, map[Foo(k2)]);
eq(3, map[Foo(k3)]);
eq(4, map[Foo(k4)]);
}
}

private class FooParam {
public function new() {
}
}

private enum EFoo {
Foo(a: FooParam);
}