Skip to content

Commit 9721fbf

Browse files
plotfiplotfi
committed
[NFC] Refactoring PropertyAttributeKind for ObjCPropertyDecl and ObjCDeclSpec.
This is a code clean up of the PropertyAttributeKind and ObjCPropertyAttributeKind enums in ObjCPropertyDecl and ObjCDeclSpec that are exactly identical. This non-functional change consolidates these enums into one. The changes are to many files across clang (and comments in LLVM) so that everything refers to the new consolidated enum in DeclObjCCommon.h. 2nd Landing Attempt... Differential Revision: https://reviews.llvm.org/D77233
1 parent b53fd70 commit 9721fbf

File tree

27 files changed

+590
-567
lines changed

27 files changed

+590
-567
lines changed

‎clang/include/clang/AST/DeclObjC.h‎

Lines changed: 32 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
#include "clang/AST/Decl.h"
1717
#include "clang/AST/DeclBase.h"
18+
#include "clang/AST/DeclObjCCommon.h"
1819
#include "clang/AST/ExternalASTSource.h"
1920
#include "clang/AST/Redeclarable.h"
2021
#include "clang/AST/SelectorLocationsKind.h"
@@ -742,34 +743,6 @@ class ObjCPropertyDecl : public NamedDecl {
742743
void anchor() override;
743744

744745
public:
745-
enum PropertyAttributeKind {
746-
OBJC_PR_noattr = 0x00,
747-
OBJC_PR_readonly = 0x01,
748-
OBJC_PR_getter = 0x02,
749-
OBJC_PR_assign = 0x04,
750-
OBJC_PR_readwrite = 0x08,
751-
OBJC_PR_retain = 0x10,
752-
OBJC_PR_copy = 0x20,
753-
OBJC_PR_nonatomic = 0x40,
754-
OBJC_PR_setter = 0x80,
755-
OBJC_PR_atomic = 0x100,
756-
OBJC_PR_weak = 0x200,
757-
OBJC_PR_strong = 0x400,
758-
OBJC_PR_unsafe_unretained = 0x800,
759-
/// Indicates that the nullability of the type was spelled with a
760-
/// property attribute rather than a type qualifier.
761-
OBJC_PR_nullability = 0x1000,
762-
OBJC_PR_null_resettable = 0x2000,
763-
OBJC_PR_class = 0x4000,
764-
OBJC_PR_direct = 0x8000
765-
// Adding a property should change NumPropertyAttrsBits
766-
};
767-
768-
enum {
769-
/// Number of bits fitting all the property attributes.
770-
NumPropertyAttrsBits = 16
771-
};
772-
773746
enum SetterKind { Assign, Retain, Copy, Weak };
774747
enum PropertyControl { None, Required, Optional };
775748

@@ -782,8 +755,8 @@ class ObjCPropertyDecl : public NamedDecl {
782755

783756
QualType DeclType;
784757
TypeSourceInfo *DeclTypeSourceInfo;
785-
unsigned PropertyAttributes : NumPropertyAttrsBits;
786-
unsigned PropertyAttributesAsWritten : NumPropertyAttrsBits;
758+
unsigned PropertyAttributes : NumObjCPropertyAttrsBits;
759+
unsigned PropertyAttributesAsWritten : NumObjCPropertyAttrsBits;
787760

788761
// \@required/\@optional
789762
unsigned PropertyImplementation : 2;
@@ -810,15 +783,14 @@ class ObjCPropertyDecl : public NamedDecl {
810783
ObjCIvarDecl *PropertyIvarDecl = nullptr;
811784

812785
ObjCPropertyDecl(DeclContext *DC, SourceLocation L, IdentifierInfo *Id,
813-
SourceLocation AtLocation, SourceLocation LParenLocation,
814-
QualType T, TypeSourceInfo *TSI,
815-
PropertyControl propControl)
816-
: NamedDecl(ObjCProperty, DC, L, Id), AtLoc(AtLocation),
817-
LParenLoc(LParenLocation), DeclType(T), DeclTypeSourceInfo(TSI),
818-
PropertyAttributes(OBJC_PR_noattr),
819-
PropertyAttributesAsWritten(OBJC_PR_noattr),
820-
PropertyImplementation(propControl), GetterName(Selector()),
821-
SetterName(Selector()) {}
786+
SourceLocation AtLocation, SourceLocation LParenLocation,
787+
QualType T, TypeSourceInfo *TSI, PropertyControl propControl)
788+
: NamedDecl(ObjCProperty, DC, L, Id), AtLoc(AtLocation),
789+
LParenLoc(LParenLocation), DeclType(T), DeclTypeSourceInfo(TSI),
790+
PropertyAttributes(ObjCPropertyAttribute::kind_noattr),
791+
PropertyAttributesAsWritten(ObjCPropertyAttribute::kind_noattr),
792+
PropertyImplementation(propControl), GetterName(Selector()),
793+
SetterName(Selector()) {}
822794

823795
public:
824796
static ObjCPropertyDecl *Create(ASTContext &C, DeclContext *DC,
@@ -850,47 +822,52 @@ class ObjCPropertyDecl : public NamedDecl {
850822
/// type.
851823
QualType getUsageType(QualType objectType) const;
852824

853-
PropertyAttributeKind getPropertyAttributes() const {
854-
return PropertyAttributeKind(PropertyAttributes);
825+
ObjCPropertyAttribute::Kind getPropertyAttributes() const {
826+
return ObjCPropertyAttribute::Kind(PropertyAttributes);
855827
}
856828

857-
void setPropertyAttributes(PropertyAttributeKind PRVal) {
829+
void setPropertyAttributes(ObjCPropertyAttribute::Kind PRVal) {
858830
PropertyAttributes |= PRVal;
859831
}
860832

861833
void overwritePropertyAttributes(unsigned PRVal) {
862834
PropertyAttributes = PRVal;
863835
}
864836

865-
PropertyAttributeKind getPropertyAttributesAsWritten() const {
866-
return PropertyAttributeKind(PropertyAttributesAsWritten);
837+
ObjCPropertyAttribute::Kind getPropertyAttributesAsWritten() const {
838+
return ObjCPropertyAttribute::Kind(PropertyAttributesAsWritten);
867839
}
868840

869-
void setPropertyAttributesAsWritten(PropertyAttributeKind PRVal) {
841+
void setPropertyAttributesAsWritten(ObjCPropertyAttribute::Kind PRVal) {
870842
PropertyAttributesAsWritten = PRVal;
871843
}
872844

873845
// Helper methods for accessing attributes.
874846

875847
/// isReadOnly - Return true iff the property has a setter.
876848
bool isReadOnly() const {
877-
return (PropertyAttributes & OBJC_PR_readonly);
849+
return (PropertyAttributes & ObjCPropertyAttribute::kind_readonly);
878850
}
879851

880852
/// isAtomic - Return true if the property is atomic.
881853
bool isAtomic() const {
882-
return (PropertyAttributes & OBJC_PR_atomic);
854+
return (PropertyAttributes & ObjCPropertyAttribute::kind_atomic);
883855
}
884856

885857
/// isRetaining - Return true if the property retains its value.
886858
bool isRetaining() const {
887-
return (PropertyAttributes &
888-
(OBJC_PR_retain | OBJC_PR_strong | OBJC_PR_copy));
859+
return (PropertyAttributes & (ObjCPropertyAttribute::kind_retain |
860+
ObjCPropertyAttribute::kind_strong |
861+
ObjCPropertyAttribute::kind_copy));
889862
}
890863

891864
bool isInstanceProperty() const { return !isClassProperty(); }
892-
bool isClassProperty() const { return PropertyAttributes & OBJC_PR_class; }
893-
bool isDirectProperty() const { return PropertyAttributes & OBJC_PR_direct; }
865+
bool isClassProperty() const {
866+
return PropertyAttributes & ObjCPropertyAttribute::kind_class;
867+
}
868+
bool isDirectProperty() const {
869+
return PropertyAttributes & ObjCPropertyAttribute::kind_direct;
870+
}
894871

895872
ObjCPropertyQueryKind getQueryKind() const {
896873
return isClassProperty() ? ObjCPropertyQueryKind::OBJC_PR_query_class :
@@ -906,13 +883,13 @@ class ObjCPropertyDecl : public NamedDecl {
906883
/// the property setter. This is only valid if the property has been
907884
/// defined to have a setter.
908885
SetterKind getSetterKind() const {
909-
if (PropertyAttributes & OBJC_PR_strong)
886+
if (PropertyAttributes & ObjCPropertyAttribute::kind_strong)
910887
return getType()->isBlockPointerType() ? Copy : Retain;
911-
if (PropertyAttributes & OBJC_PR_retain)
888+
if (PropertyAttributes & ObjCPropertyAttribute::kind_retain)
912889
return Retain;
913-
if (PropertyAttributes & OBJC_PR_copy)
890+
if (PropertyAttributes & ObjCPropertyAttribute::kind_copy)
914891
return Copy;
915-
if (PropertyAttributes & OBJC_PR_weak)
892+
if (PropertyAttributes & ObjCPropertyAttribute::kind_weak)
916893
return Weak;
917894
return Assign;
918895
}

‎clang/include/clang/AST/DeclObjCCommon.h‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
//===- DeclObjCCommon.h - Classes for representing declarations -*- 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+
//
9+
// This file contains common ObjC enums and classes used in AST and
10+
// Sema.
11+
//
12+
//===----------------------------------------------------------------------===//
13+
14+
#ifndef LLVM_CLANG_AST_DECLOBJC_COMMON_H
15+
#define LLVM_CLANG_AST_DECLOBJC_COMMON_H
16+
17+
namespace clang {
18+
19+
/// ObjCPropertyAttribute::Kind - list of property attributes.
20+
/// Keep this list in sync with LLVM's Dwarf.h ApplePropertyAttributes.s
21+
namespace ObjCPropertyAttribute {
22+
enum Kind {
23+
kind_noattr = 0x00,
24+
kind_readonly = 0x01,
25+
kind_getter = 0x02,
26+
kind_assign = 0x04,
27+
kind_readwrite = 0x08,
28+
kind_retain = 0x10,
29+
kind_copy = 0x20,
30+
kind_nonatomic = 0x40,
31+
kind_setter = 0x80,
32+
kind_atomic = 0x100,
33+
kind_weak = 0x200,
34+
kind_strong = 0x400,
35+
kind_unsafe_unretained = 0x800,
36+
/// Indicates that the nullability of the type was spelled with a
37+
/// property attribute rather than a type qualifier.
38+
kind_nullability = 0x1000,
39+
kind_null_resettable = 0x2000,
40+
kind_class = 0x4000,
41+
kind_direct = 0x8000,
42+
// Adding a property should change NumObjCPropertyAttrsBits
43+
// Also, don't forget to update the Clang C API at CXObjCPropertyAttrKind and
44+
// clang_Cursor_getObjCPropertyAttributes.
45+
};
46+
} // namespace ObjCPropertyAttribute::Kind
47+
48+
enum {
49+
/// Number of bits fitting all the property attributes.
50+
NumObjCPropertyAttrsBits = 16
51+
};
52+
53+
} // namespace clang
54+
55+
#endif // LLVM_CLANG_AST_DECLOBJC_COMMON_H

‎clang/include/clang/Sema/DeclSpec.h‎

Lines changed: 22 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
#define LLVM_CLANG_SEMA_DECLSPEC_H
2424

2525
#include "clang/AST/DeclCXX.h"
26+
#include "clang/AST/DeclObjCCommon.h"
2627
#include "clang/AST/NestedNameSpecifier.h"
2728
#include "clang/Basic/ExceptionSpecificationType.h"
2829
#include "clang/Basic/Lambda.h"
@@ -841,31 +842,10 @@ class ObjCDeclSpec {
841842
DQ_CSNullability = 0x40
842843
};
843844

844-
/// PropertyAttributeKind - list of property attributes.
845-
/// Keep this list in sync with LLVM's Dwarf.h ApplePropertyAttributes.
846-
enum ObjCPropertyAttributeKind {
847-
DQ_PR_noattr = 0x0,
848-
DQ_PR_readonly = 0x01,
849-
DQ_PR_getter = 0x02,
850-
DQ_PR_assign = 0x04,
851-
DQ_PR_readwrite = 0x08,
852-
DQ_PR_retain = 0x10,
853-
DQ_PR_copy = 0x20,
854-
DQ_PR_nonatomic = 0x40,
855-
DQ_PR_setter = 0x80,
856-
DQ_PR_atomic = 0x100,
857-
DQ_PR_weak = 0x200,
858-
DQ_PR_strong = 0x400,
859-
DQ_PR_unsafe_unretained = 0x800,
860-
DQ_PR_nullability = 0x1000,
861-
DQ_PR_null_resettable = 0x2000,
862-
DQ_PR_class = 0x4000,
863-
DQ_PR_direct = 0x8000,
864-
};
865-
866845
ObjCDeclSpec()
867-
: objcDeclQualifier(DQ_None), PropertyAttributes(DQ_PR_noattr),
868-
Nullability(0), GetterName(nullptr), SetterName(nullptr) { }
846+
: objcDeclQualifier(DQ_None),
847+
PropertyAttributes(ObjCPropertyAttribute::kind_noattr), Nullability(0),
848+
GetterName(nullptr), SetterName(nullptr) {}
869849

870850
ObjCDeclQualifier getObjCDeclQualifier() const {
871851
return (ObjCDeclQualifier)objcDeclQualifier;
@@ -877,32 +857,35 @@ class ObjCDeclSpec {
877857
objcDeclQualifier = (ObjCDeclQualifier) (objcDeclQualifier & ~DQVal);
878858
}
879859

880-
ObjCPropertyAttributeKind getPropertyAttributes() const {
881-
return ObjCPropertyAttributeKind(PropertyAttributes);
860+
ObjCPropertyAttribute::Kind getPropertyAttributes() const {
861+
return ObjCPropertyAttribute::Kind(PropertyAttributes);
882862
}
883-
void setPropertyAttributes(ObjCPropertyAttributeKind PRVal) {
863+
void setPropertyAttributes(ObjCPropertyAttribute::Kind PRVal) {
884864
PropertyAttributes =
885-
(ObjCPropertyAttributeKind)(PropertyAttributes | PRVal);
865+
(ObjCPropertyAttribute::Kind)(PropertyAttributes | PRVal);
886866
}
887867

888868
NullabilityKind getNullability() const {
889-
assert(((getObjCDeclQualifier() & DQ_CSNullability) ||
890-
(getPropertyAttributes() & DQ_PR_nullability)) &&
891-
"Objective-C declspec doesn't have nullability");
869+
assert(
870+
((getObjCDeclQualifier() & DQ_CSNullability) ||
871+
(getPropertyAttributes() & ObjCPropertyAttribute::kind_nullability)) &&
872+
"Objective-C declspec doesn't have nullability");
892873
return static_cast<NullabilityKind>(Nullability);
893874
}
894875

895876
SourceLocation getNullabilityLoc() const {
896-
assert(((getObjCDeclQualifier() & DQ_CSNullability) ||
897-
(getPropertyAttributes() & DQ_PR_nullability)) &&
898-
"Objective-C declspec doesn't have nullability");
877+
assert(
878+
((getObjCDeclQualifier() & DQ_CSNullability) ||
879+
(getPropertyAttributes() & ObjCPropertyAttribute::kind_nullability)) &&
880+
"Objective-C declspec doesn't have nullability");
899881
return NullabilityLoc;
900882
}
901883

902884
void setNullability(SourceLocation loc, NullabilityKind kind) {
903-
assert(((getObjCDeclQualifier() & DQ_CSNullability) ||
904-
(getPropertyAttributes() & DQ_PR_nullability)) &&
905-
"Set the nullability declspec or property attribute first");
885+
assert(
886+
((getObjCDeclQualifier() & DQ_CSNullability) ||
887+
(getPropertyAttributes() & ObjCPropertyAttribute::kind_nullability)) &&
888+
"Set the nullability declspec or property attribute first");
906889
Nullability = static_cast<unsigned>(kind);
907890
NullabilityLoc = loc;
908891
}
@@ -929,8 +912,8 @@ class ObjCDeclSpec {
929912
// (space saving is negligible).
930913
unsigned objcDeclQualifier : 7;
931914

932-
// NOTE: VC++ treats enums as signed, avoid using ObjCPropertyAttributeKind
933-
unsigned PropertyAttributes : 16;
915+
// NOTE: VC++ treats enums as signed, avoid using ObjCPropertyAttribute::Kind
916+
unsigned PropertyAttributes : NumObjCPropertyAttrsBits;
934917

935918
unsigned Nullability : 2;
936919

‎clang/lib/ARCMigrate/TransGCAttrs.cpp‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,7 @@ static void checkAllAtProps(MigrationContext &MigrateCtx,
231231

232232
SmallVector<std::pair<AttributedTypeLoc, ObjCPropertyDecl *>, 4> ATLs;
233233
bool hasWeak = false, hasStrong = false;
234-
ObjCPropertyDecl::PropertyAttributeKind
235-
Attrs = ObjCPropertyDecl::OBJC_PR_noattr;
234+
ObjCPropertyAttribute::Kind Attrs = ObjCPropertyAttribute::kind_noattr;
236235
for (IndivPropsTy::iterator
237236
PI = IndProps.begin(), PE = IndProps.end(); PI != PE; ++PI) {
238237
ObjCPropertyDecl *PD = *PI;
@@ -274,7 +273,7 @@ static void checkAllAtProps(MigrationContext &MigrateCtx,
274273
else
275274
toAttr = "unsafe_unretained";
276275
}
277-
if (Attrs & ObjCPropertyDecl::OBJC_PR_assign)
276+
if (Attrs & ObjCPropertyAttribute::kind_assign)
278277
MigrateCtx.rewritePropertyAttribute("assign", toAttr, AtLoc);
279278
else
280279
MigrateCtx.addPropertyAttribute(toAttr, AtLoc);
@@ -302,8 +301,8 @@ static void checkAllProps(MigrationContext &MigrateCtx,
302301
for (unsigned i = 0, e = AllProps.size(); i != e; ++i) {
303302
ObjCPropertyDecl *PD = AllProps[i];
304303
if (PD->getPropertyAttributesAsWritten() &
305-
(ObjCPropertyDecl::OBJC_PR_assign |
306-
ObjCPropertyDecl::OBJC_PR_readonly)) {
304+
(ObjCPropertyAttribute::kind_assign |
305+
ObjCPropertyAttribute::kind_readonly)) {
307306
SourceLocation AtLoc = PD->getAtLoc();
308307
if (AtLoc.isInvalid())
309308
continue;

‎clang/lib/ARCMigrate/TransProperties.cpp‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -168,22 +168,22 @@ class PropertiesRewriter {
168168
}
169169

170170
void rewriteProperty(PropsTy &props, SourceLocation atLoc) {
171-
ObjCPropertyDecl::PropertyAttributeKind propAttrs = getPropertyAttrs(props);
171+
ObjCPropertyAttribute::Kind propAttrs = getPropertyAttrs(props);
172172

173-
if (propAttrs & (ObjCPropertyDecl::OBJC_PR_copy |
174-
ObjCPropertyDecl::OBJC_PR_unsafe_unretained |
175-
ObjCPropertyDecl::OBJC_PR_strong |
176-
ObjCPropertyDecl::OBJC_PR_weak))
173+
if (propAttrs &
174+
(ObjCPropertyAttribute::kind_copy |
175+
ObjCPropertyAttribute::kind_unsafe_unretained |
176+
ObjCPropertyAttribute::kind_strong | ObjCPropertyAttribute::kind_weak))
177177
return;
178178

179-
if (propAttrs & ObjCPropertyDecl::OBJC_PR_retain) {
179+
if (propAttrs & ObjCPropertyAttribute::kind_retain) {
180180
// strong is the default.
181181
return doPropAction(PropAction_RetainReplacedWithStrong, props, atLoc);
182182
}
183183

184184
bool HasIvarAssignedAPlusOneObject = hasIvarAssignedAPlusOneObject(props);
185185

186-
if (propAttrs & ObjCPropertyDecl::OBJC_PR_assign) {
186+
if (propAttrs & ObjCPropertyAttribute::kind_assign) {
187187
if (HasIvarAssignedAPlusOneObject)
188188
return doPropAction(PropAction_AssignRemoved, props, atLoc);
189189
return doPropAction(PropAction_AssignRewritten, props, atLoc);
@@ -354,11 +354,10 @@ class PropertiesRewriter {
354354
return ty;
355355
}
356356

357-
ObjCPropertyDecl::PropertyAttributeKind
358-
getPropertyAttrs(PropsTy &props) const {
357+
ObjCPropertyAttribute::Kind getPropertyAttrs(PropsTy &props) const {
359358
assert(!props.empty());
360-
ObjCPropertyDecl::PropertyAttributeKind
361-
attrs = props[0].PropD->getPropertyAttributesAsWritten();
359+
ObjCPropertyAttribute::Kind attrs =
360+
props[0].PropD->getPropertyAttributesAsWritten();
362361

363362
#ifndef NDEBUG
364363
for (PropsTy::iterator I = props.begin(), E = props.end(); I != E; ++I)

0 commit comments

Comments
 (0)