Merge pull request #7244 from apple/egorzhdan/apinotes-namespaces-20221013

🍒[APINotes] Support C++ namespaces

Author: egorzhdan

clang/include/clang/APINotes/APINotesReader.h

@@ -175,14 +175,18 @@ class APINotesReader {
   /// \param name The name of the global variable.
   ///
   /// \returns information about the global variable, if known.
-  VersionedInfo<GlobalVariableInfo> lookupGlobalVariable(llvm::StringRef name);
+  VersionedInfo<GlobalVariableInfo>
+  lookupGlobalVariable(llvm::StringRef name,
+                       std::optional<Context> context = std::nullopt);
 
   /// Look for information regarding the given global function.
   ///
   /// \param name The name of the global function.
   ///
   /// \returns information about the global function, if known.
-  VersionedInfo<GlobalFunctionInfo> lookupGlobalFunction(llvm::StringRef name);
+  VersionedInfo<GlobalFunctionInfo>
+  lookupGlobalFunction(llvm::StringRef name,
+                       std::optional<Context> context = std::nullopt);
 
   /// Look for information regarding the given enumerator.
   ///
@@ -197,14 +201,27 @@ class APINotesReader {
   /// \param name The name of the tag.
   ///
   /// \returns information about the tag, if known.
-  VersionedInfo<TagInfo> lookupTag(llvm::StringRef name);
+  VersionedInfo<TagInfo>
+  lookupTag(llvm::StringRef name,
+            std::optional<Context> context = std::nullopt);
 
   /// Look for information regarding the given typedef.
   ///
   /// \param name The name of the typedef.
   ///
   /// \returns information about the typedef, if known.
-  VersionedInfo<TypedefInfo> lookupTypedef(llvm::StringRef name);
+  VersionedInfo<TypedefInfo>
+  lookupTypedef(llvm::StringRef name,
+                std::optional<Context> context = std::nullopt);
+
+  /// Look for the context ID of the given C++ namespace.
+  ///
+  /// \param name The name of the class we're looking for.
+  ///
+  /// \returns The ID, if known.
+  llvm::Optional<ContextID>
+  lookupNamespaceID(llvm::StringRef name,
+                    llvm::Optional<ContextID> parentNamespaceID = llvm::None);
 };
 
 } // end namespace api_notes

clang/include/clang/APINotes/APINotesWriter.h

@@ -46,15 +46,17 @@ class APINotesWriter {
   /// Write the API notes data to the given stream.
   void writeToStream(llvm::raw_ostream &os);
 
-  /// Add information about a specific Objective-C class or protocol.
+  /// Add information about a specific Objective-C class or protocol or a C++
+  /// namespace.
   ///
-  /// \param name The name of this class/protocol.
-  /// \param isClass Whether this is a class (vs. a protocol).
-  /// \param info Information about this class/protocol.
+  /// \param name The name of this class/protocol/namespace.
+  /// \param contextKind Whether this is a class, a protocol, or a namespace.
+  /// \param info Information about this class/protocol/namespace.
   ///
-  /// \returns the ID of the class or protocol, which can be used to add
-  /// properties and methods to the class/protocol.
-  ContextID addObjCContext(llvm::StringRef name, bool isClass,
+  /// \returns the ID of the class, protocol, or namespace, which can be used to
+  /// add properties and methods to the class/protocol/namespace.
+  ContextID addObjCContext(std::optional<ContextID> parentContextID,
+                           llvm::StringRef name, ContextKind contextKind,
                            const ObjCContextInfo &info,
                            llvm::VersionTuple swiftVersion);
 
@@ -83,14 +85,16 @@ class APINotesWriter {
   ///
   /// \param name The name of this global variable.
   /// \param info Information about this global variable.
-  void addGlobalVariable(llvm::StringRef name, const GlobalVariableInfo &info,
+  void addGlobalVariable(std::optional<Context> context, llvm::StringRef name,
+                         const GlobalVariableInfo &info,
                          llvm::VersionTuple swiftVersion);
 
   /// Add information about a global function.
   ///
   /// \param name The name of this global function.
   /// \param info Information about this global function.
-  void addGlobalFunction(llvm::StringRef name, const GlobalFunctionInfo &info,
+  void addGlobalFunction(std::optional<Context> context, llvm::StringRef name,
+                         const GlobalFunctionInfo &info,
                          llvm::VersionTuple swiftVersion);
 
   /// Add information about an enumerator.
@@ -104,15 +108,15 @@ class APINotesWriter {
   ///
   /// \param name The name of this tag.
   /// \param info Information about this tag.
-  void addTag(llvm::StringRef name, const TagInfo &info,
-              llvm::VersionTuple swiftVersion);
+  void addTag(std::optional<Context> context, llvm::StringRef name,
+              const TagInfo &info, llvm::VersionTuple swiftVersion);
 
   /// Add information about a typedef.
   ///
   /// \param name The name of this typedef.
   /// \param info Information about this typedef.
-  void addTypedef(llvm::StringRef name, const TypedefInfo &info,
-                  llvm::VersionTuple swiftVersion);
+  void addTypedef(std::optional<Context> context, llvm::StringRef name,
+                  const TypedefInfo &info, llvm::VersionTuple swiftVersion);
 
   /// Add module options
   void addModuleOptions(ModuleOptions opts);

clang/include/clang/APINotes/Types.h

@@ -735,14 +735,28 @@ namespace api_notes {
 /// The file extension used for the source representation of API notes.
 static const char SOURCE_APINOTES_EXTENSION[] = "apinotes";
 
-/// Opaque context ID used to refer to an Objective-C class or protocol.
+/// Opaque context ID used to refer to an Objective-C class or protocol or a C++
+/// namespace.
 class ContextID {
 public:
   unsigned Value;
 
   explicit ContextID(unsigned value) : Value(value) { }
 };
 
+enum class ContextKind : uint8_t {
+  ObjCClass = 0,
+  ObjCProtocol = 1,
+  Namespace = 2
+};
+
+struct Context {
+  ContextID id;
+  ContextKind kind;
+
+  Context(ContextID id, ContextKind kind) : id(id), kind(kind) {}
+};
+
 /// A temporary reference to an Objective-C selector, suitable for
 /// referencing selector data on the stack.
 ///

clang/lib/APINotes/APINotesFormat.h

@@ -249,6 +249,38 @@ struct StoredObjCSelector {
   unsigned NumPieces;
   llvm::SmallVector<IdentifierID, 2> Identifiers;
 };
+
+/// A stored Objective-C or C++ context, represented by the ID of its parent
+/// context, the kind of this context (Objective-C class / C++ namespace / etc),
+/// and the ID of this context.
+struct ContextTableKey {
+  uint32_t parentContextID;
+  uint8_t contextKind;
+  uint32_t contextID;
+
+  ContextTableKey() : parentContextID(-1), contextKind(-1), contextID(-1) {}
+
+  ContextTableKey(uint32_t parentContextID, uint8_t contextKind,
+                  uint32_t contextID)
+      : parentContextID(parentContextID), contextKind(contextKind),
+        contextID(contextID) {}
+
+  ContextTableKey(std::optional<Context> context, IdentifierID nameID)
+      : parentContextID(context ? context->id.Value : (uint32_t)-1),
+        contextKind(context ? (uint8_t)context->kind : (uint8_t)-1),
+        contextID(nameID) {}
+
+  llvm::hash_code hashValue() const {
+    return llvm::hash_value(
+        std::tuple{parentContextID, contextKind, contextID});
+  }
+};
+
+inline bool operator==(const ContextTableKey &lhs, const ContextTableKey &rhs) {
+  return lhs.parentContextID == rhs.parentContextID &&
+         lhs.contextKind == rhs.contextKind && lhs.contextID == rhs.contextID;
+}
+
 } // namespace api_notes
 } // namespace clang
 
@@ -284,6 +316,29 @@ namespace llvm {
              lhs.Identifiers == rhs.Identifiers;
     }
   };
-}
+
+  template <> struct DenseMapInfo<clang::api_notes::ContextTableKey> {
+    static inline clang::api_notes::ContextTableKey getEmptyKey() {
+      return clang::api_notes::ContextTableKey();
+    }
+
+    static inline clang::api_notes::ContextTableKey getTombstoneKey() {
+      return clang::api_notes::ContextTableKey{
+          DenseMapInfo<uint32_t>::getTombstoneKey(),
+          DenseMapInfo<uint8_t>::getTombstoneKey(),
+          DenseMapInfo<uint32_t>::getTombstoneKey()};
+    }
+
+    static unsigned
+    getHashValue(const clang::api_notes::ContextTableKey &value) {
+      return value.hashValue();
+    }
+
+    static bool isEqual(const clang::api_notes::ContextTableKey &lhs,
+                        const clang::api_notes::ContextTableKey &rhs) {
+      return lhs == rhs;
+    }
+  };
+} // namespace llvm
 
 #endif