MetadataGenerator name collisions

[PanayotCankov]

From to-do in Meta/IdentifierFactory.cpp#L9
Reproduced with the KontaktSDK

In the metadata generator there are some static maps that contains hardcoded symbol names from the iOS SDK for which we know there is conflict in their JS name and must be renamed. Maybe there is better way to pass this map to the IdentifierGenerator. For third-party libraries the map may be parsed from file or something more flexible.

The most easy to consume way is if they can be generated from the decls, this won't involve manual setup. However it also involves some magic. Developers should be notified for such collisions and the way they are resolved. e.g. trace that: the TKTRegion interface collides with the TKTRegion protocol and the protocol is renamed to TKTRegionProtocol.

[ivanbuhov]

We have workaround for KontaktIO (0f67a2b), but it is dirty solution. We just hardcode the names of the protocols which are in collision in our metadata generator. The solution is temporary until we find a better one.

[jasssonpet]

It seems that Swift has similar problems:

Case 1

char *timezone(int, int);
extern long timezone;

print(timezone) // Ambiguous use of 'timezone'`

Case 2

@protocol MyName
+ (void)method;
@end

@protocol MyNameProtocol
+ (void)method1;
@end

@interface MyName : NSObject
@end

In this case the MyName protocol isn't visible in swift.

So for this issue I suggest that we automatically append only one Protocol suffix at the end, if there is collision between an interface and a protocol and print errors for all other cases, to avoid the ambiguity.

[fealebenpae]

Sounds fine to me.

[jasssonpet]

What do you think to report errors at runtime, instead of build time. Because we may sometimes fail the build, but if the user doesn't access this API, he wouldn't be able to use the other 99% of the library.

[fealebenpae]

How would we know at runtime that there has been a name collision at build time?

[jasssonpet]

We could mark the name in the metadata that it is ambiguous or something.

[fealebenpae]

With a flag, perhaps? Alright, I think this will work.

[jasssonpet]

Those are some implementation details. Lets clear the use case first :)

[fealebenpae]

Fixed in #299