xref: /freebsd/contrib/llvm-project/clang/lib/AST/DeclFriend.cpp (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1*0b57cec5SDimitry Andric //===- DeclFriend.cpp - C++ Friend Declaration AST Node Implementation ----===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric //
9*0b57cec5SDimitry Andric // This file implements the AST classes related to C++ friend
10*0b57cec5SDimitry Andric // declarations.
11*0b57cec5SDimitry Andric //
12*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
13*0b57cec5SDimitry Andric 
14*0b57cec5SDimitry Andric #include "clang/AST/DeclFriend.h"
15*0b57cec5SDimitry Andric #include "clang/AST/Decl.h"
16*0b57cec5SDimitry Andric #include "clang/AST/DeclBase.h"
17*0b57cec5SDimitry Andric #include "clang/AST/DeclCXX.h"
18*0b57cec5SDimitry Andric #include "clang/AST/ASTContext.h"
19*0b57cec5SDimitry Andric #include "clang/AST/DeclTemplate.h"
20*0b57cec5SDimitry Andric #include "clang/Basic/LLVM.h"
21*0b57cec5SDimitry Andric #include "llvm/Support/Casting.h"
22*0b57cec5SDimitry Andric #include <cassert>
23*0b57cec5SDimitry Andric #include <cstddef>
24*0b57cec5SDimitry Andric 
25*0b57cec5SDimitry Andric using namespace clang;
26*0b57cec5SDimitry Andric 
27*0b57cec5SDimitry Andric void FriendDecl::anchor() {}
28*0b57cec5SDimitry Andric 
29*0b57cec5SDimitry Andric FriendDecl *FriendDecl::getNextFriendSlowCase() {
30*0b57cec5SDimitry Andric   return cast_or_null<FriendDecl>(
31*0b57cec5SDimitry Andric                            NextFriend.get(getASTContext().getExternalSource()));
32*0b57cec5SDimitry Andric }
33*0b57cec5SDimitry Andric 
34*0b57cec5SDimitry Andric FriendDecl *FriendDecl::Create(ASTContext &C, DeclContext *DC,
35*0b57cec5SDimitry Andric                                SourceLocation L,
36*0b57cec5SDimitry Andric                                FriendUnion Friend,
37*0b57cec5SDimitry Andric                                SourceLocation FriendL,
38*0b57cec5SDimitry Andric                           ArrayRef<TemplateParameterList *> FriendTypeTPLists) {
39*0b57cec5SDimitry Andric #ifndef NDEBUG
40*0b57cec5SDimitry Andric   if (Friend.is<NamedDecl *>()) {
41*0b57cec5SDimitry Andric     const auto *D = Friend.get<NamedDecl*>();
42*0b57cec5SDimitry Andric     assert(isa<FunctionDecl>(D) ||
43*0b57cec5SDimitry Andric            isa<CXXRecordDecl>(D) ||
44*0b57cec5SDimitry Andric            isa<FunctionTemplateDecl>(D) ||
45*0b57cec5SDimitry Andric            isa<ClassTemplateDecl>(D));
46*0b57cec5SDimitry Andric 
47*0b57cec5SDimitry Andric     // As a temporary hack, we permit template instantiation to point
48*0b57cec5SDimitry Andric     // to the original declaration when instantiating members.
49*0b57cec5SDimitry Andric     assert(D->getFriendObjectKind() ||
50*0b57cec5SDimitry Andric            (cast<CXXRecordDecl>(DC)->getTemplateSpecializationKind()));
51*0b57cec5SDimitry Andric     // These template parameters are for friend types only.
52*0b57cec5SDimitry Andric     assert(FriendTypeTPLists.empty());
53*0b57cec5SDimitry Andric   }
54*0b57cec5SDimitry Andric #endif
55*0b57cec5SDimitry Andric 
56*0b57cec5SDimitry Andric   std::size_t Extra =
57*0b57cec5SDimitry Andric       FriendDecl::additionalSizeToAlloc<TemplateParameterList *>(
58*0b57cec5SDimitry Andric           FriendTypeTPLists.size());
59*0b57cec5SDimitry Andric   auto *FD = new (C, DC, Extra) FriendDecl(DC, L, Friend, FriendL,
60*0b57cec5SDimitry Andric                                            FriendTypeTPLists);
61*0b57cec5SDimitry Andric   cast<CXXRecordDecl>(DC)->pushFriendDecl(FD);
62*0b57cec5SDimitry Andric   return FD;
63*0b57cec5SDimitry Andric }
64*0b57cec5SDimitry Andric 
65*0b57cec5SDimitry Andric FriendDecl *FriendDecl::CreateDeserialized(ASTContext &C, unsigned ID,
66*0b57cec5SDimitry Andric                                            unsigned FriendTypeNumTPLists) {
67*0b57cec5SDimitry Andric   std::size_t Extra =
68*0b57cec5SDimitry Andric       additionalSizeToAlloc<TemplateParameterList *>(FriendTypeNumTPLists);
69*0b57cec5SDimitry Andric   return new (C, ID, Extra) FriendDecl(EmptyShell(), FriendTypeNumTPLists);
70*0b57cec5SDimitry Andric }
71*0b57cec5SDimitry Andric 
72*0b57cec5SDimitry Andric FriendDecl *CXXRecordDecl::getFirstFriend() const {
73*0b57cec5SDimitry Andric   ExternalASTSource *Source = getParentASTContext().getExternalSource();
74*0b57cec5SDimitry Andric   Decl *First = data().FirstFriend.get(Source);
75*0b57cec5SDimitry Andric   return First ? cast<FriendDecl>(First) : nullptr;
76*0b57cec5SDimitry Andric }
77