Apinotes name spacing

Using Swift
1

I hope it's not out of line to ask about the .apinotes file - I've been using one to annotate an Objective-C framework that I don't control the headers for.

I've noticed that if I rename a class, like so:

---
Name: MyFramework
Class:
  - Name: NSSomeClass
    SwiftName: SomeClass

That if I try to use what I assume would be the fully-qualified name of the class MyFramework.SomeClass, it doesn't work. If I view the generated Swift header for the framework, I instead see:

import MyFramework.NSSomeClass

Am I missing something simple that will enable MyFramework.SomeClass to work?

2

You've renamed the class, but the header is still named "NSSomeClass.h", so the C-side submodule is named that too. (You can test that it's the name of the header and not the class by, well, renaming the header.)

I don't think we're likely to change this, even though it is kind of funny. You can manually control the names of submodules by writing your own module map for your framework, but that'll affect Objective-C as well.

(It's not really intended to use API notes on someone else's framework, because they might be incompatible with how another library is trying to use that framework. This could manifest itself as errors or as compiler crashes. But if everything compiles you won't see any weird problems at run time.)

1 Like
3

That makes perfect sense. Thanks for explaining it, Jordan.

I did note that I can make set the SwiftName of classes, tags, et al to MyFramework.SomeClass and it works fine (although it then requires the prefix). I should stop pretending this framework is in Swift and just get on with it :joy:

Thanks to whomever implemented the API notes code - it's really nicely documented and structured enough that I was able to easily infer the various options and their purpose :+1:t2:

1 Like
4

That doesn't excuse us from writing proper documentation at some point. ;-)