clang 20.0.0git
APINotesTypes.cpp
Go to the documentation of this file.
1//===-- APINotesTypes.cpp - API Notes Data Types ----------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
10#include "llvm/Support/raw_ostream.h"
11
12namespace clang {
13namespace api_notes {
14LLVM_DUMP_METHOD void CommonEntityInfo::dump(llvm::raw_ostream &OS) const {
15 if (Unavailable)
16 OS << "[Unavailable] (" << UnavailableMsg << ")" << ' ';
18 OS << "[UnavailableInSwift] ";
19 if (SwiftPrivateSpecified)
20 OS << (SwiftPrivate ? "[SwiftPrivate] " : "");
21 if (!SwiftName.empty())
22 OS << "Swift Name: " << SwiftName << ' ';
23 OS << '\n';
24}
25
26LLVM_DUMP_METHOD void CommonTypeInfo::dump(llvm::raw_ostream &OS) const {
27 static_cast<const CommonEntityInfo &>(*this).dump(OS);
28 if (SwiftBridge)
29 OS << "Swift Briged Type: " << *SwiftBridge << ' ';
30 if (NSErrorDomain)
31 OS << "NSError Domain: " << *NSErrorDomain << ' ';
32 OS << '\n';
33}
34
35LLVM_DUMP_METHOD void ContextInfo::dump(llvm::raw_ostream &OS) {
36 static_cast<CommonTypeInfo &>(*this).dump(OS);
37 if (HasDefaultNullability)
38 OS << "DefaultNullability: " << DefaultNullability << ' ';
39 if (HasDesignatedInits)
40 OS << "[HasDesignatedInits] ";
41 if (SwiftImportAsNonGenericSpecified)
42 OS << (SwiftImportAsNonGeneric ? "[SwiftImportAsNonGeneric] " : "");
43 if (SwiftObjCMembersSpecified)
44 OS << (SwiftObjCMembers ? "[SwiftObjCMembers] " : "");
45 OS << '\n';
46}
47
48LLVM_DUMP_METHOD void VariableInfo::dump(llvm::raw_ostream &OS) const {
49 static_cast<const CommonEntityInfo &>(*this).dump(OS);
50 if (NullabilityAudited)
51 OS << "Audited Nullability: " << Nullable << ' ';
52 if (!Type.empty())
53 OS << "C Type: " << Type << ' ';
54 OS << '\n';
55}
56
57LLVM_DUMP_METHOD void ObjCPropertyInfo::dump(llvm::raw_ostream &OS) const {
58 static_cast<const VariableInfo &>(*this).dump(OS);
59 if (SwiftImportAsAccessorsSpecified)
60 OS << (SwiftImportAsAccessors ? "[SwiftImportAsAccessors] " : "");
61 OS << '\n';
62}
63
64LLVM_DUMP_METHOD void ParamInfo::dump(llvm::raw_ostream &OS) const {
65 static_cast<const VariableInfo &>(*this).dump(OS);
66 if (NoEscapeSpecified)
67 OS << (NoEscape ? "[NoEscape] " : "");
68 OS << "RawRetainCountConvention: " << RawRetainCountConvention << ' ';
69 OS << '\n';
70}
71
72LLVM_DUMP_METHOD void FunctionInfo::dump(llvm::raw_ostream &OS) const {
73 static_cast<const CommonEntityInfo &>(*this).dump(OS);
74 OS << (NullabilityAudited ? "[NullabilityAudited] " : "")
75 << "RawRetainCountConvention: " << RawRetainCountConvention << ' ';
76 if (!ResultType.empty())
77 OS << "Result Type: " << ResultType << ' ';
78 if (!Params.empty())
79 OS << '\n';
80 for (auto &PI : Params)
81 PI.dump(OS);
82}
83
84LLVM_DUMP_METHOD void ObjCMethodInfo::dump(llvm::raw_ostream &OS) {
85 static_cast<FunctionInfo &>(*this).dump(OS);
86 OS << (DesignatedInit ? "[DesignatedInit] " : "")
87 << (RequiredInit ? "[RequiredInit] " : "") << '\n';
88}
89
90LLVM_DUMP_METHOD void TagInfo::dump(llvm::raw_ostream &OS) {
91 static_cast<CommonTypeInfo &>(*this).dump(OS);
92 if (HasFlagEnum)
93 OS << (IsFlagEnum ? "[FlagEnum] " : "");
95 OS << "Enum Extensibility: " << static_cast<long>(*EnumExtensibility)
96 << ' ';
97 OS << '\n';
98}
99
100LLVM_DUMP_METHOD void TypedefInfo::dump(llvm::raw_ostream &OS) const {
101 static_cast<const CommonTypeInfo &>(*this).dump(OS);
102 if (SwiftWrapper)
103 OS << "Swift Type: " << static_cast<long>(*SwiftWrapper) << ' ';
104 OS << '\n';
105}
106} // namespace api_notes
107} // namespace clang
The base class of the type hierarchy.
Definition: Type.h:1829
Describes API notes data for any entity.
Definition: Types.h:52
unsigned UnavailableInSwift
Whether this entity is marked unavailable in Swift.
Definition: Types.h:63
unsigned Unavailable
Whether this entity is marked unavailable.
Definition: Types.h:59
std::string SwiftName
Swift name of this entity.
Definition: Types.h:76
std::string UnavailableMsg
Message to use when this entity is unavailable.
Definition: Types.h:55
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS) const
Describes API notes for types.
Definition: Types.h:135
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS) const
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS)
API notes for a function or method.
Definition: Types.h:489
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS) const
unsigned RawRetainCountConvention
A biased RetainCountConventionKind, where 0 means "unspecified".
Definition: Types.h:509
std::vector< ParamInfo > Params
The function parameters.
Definition: Types.h:522
std::string ResultType
The result type of this function, as a C type.
Definition: Types.h:519
unsigned NullabilityAudited
Whether the signature has been audited with respect to nullability.
Definition: Types.h:503
unsigned DesignatedInit
Whether this is a designated initializer of its class.
Definition: Types.h:613
unsigned RequiredInit
Whether this is a required initializer.
Definition: Types.h:617
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS)
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS) const
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS) const
std::optional< EnumExtensibilityKind > EnumExtensibility
Definition: Types.h:697
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS)
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS) const
std::optional< SwiftNewTypeKind > SwiftWrapper
Definition: Types.h:770
API notes for a variable/property.
Definition: Types.h:304
LLVM_DUMP_METHOD void dump(llvm::raw_ostream &OS) const
The JSON file list parser is used to communicate input to InstallAPI.