annotate clang/lib/ARCMigrate/Internals.h @ 176:de4ac79aef9d

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 17:13:11 +0900
parents 1d019706d866
children c4bab56944e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===-- Internals.h - Implementation Details---------------------*- C++ -*-===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 #ifndef LLVM_CLANG_LIB_ARCMIGRATE_INTERNALS_H
anatofuz
parents:
diff changeset
10 #define LLVM_CLANG_LIB_ARCMIGRATE_INTERNALS_H
anatofuz
parents:
diff changeset
11
anatofuz
parents:
diff changeset
12 #include "clang/Basic/LangOptions.h"
anatofuz
parents:
diff changeset
13 #include "clang/Basic/Diagnostic.h"
anatofuz
parents:
diff changeset
14 #include "clang/Frontend/MigratorOptions.h"
anatofuz
parents:
diff changeset
15 #include "llvm/ADT/ArrayRef.h"
anatofuz
parents:
diff changeset
16 #include "llvm/ADT/Optional.h"
anatofuz
parents:
diff changeset
17 #include <list>
anatofuz
parents:
diff changeset
18
anatofuz
parents:
diff changeset
19 namespace clang {
anatofuz
parents:
diff changeset
20 class ASTContext;
anatofuz
parents:
diff changeset
21 class Sema;
anatofuz
parents:
diff changeset
22 class Stmt;
anatofuz
parents:
diff changeset
23
anatofuz
parents:
diff changeset
24 namespace arcmt {
anatofuz
parents:
diff changeset
25
anatofuz
parents:
diff changeset
26 class CapturedDiagList {
anatofuz
parents:
diff changeset
27 typedef std::list<StoredDiagnostic> ListTy;
anatofuz
parents:
diff changeset
28 ListTy List;
anatofuz
parents:
diff changeset
29
anatofuz
parents:
diff changeset
30 public:
anatofuz
parents:
diff changeset
31 void push_back(const StoredDiagnostic &diag) { List.push_back(diag); }
anatofuz
parents:
diff changeset
32
anatofuz
parents:
diff changeset
33 bool clearDiagnostic(ArrayRef<unsigned> IDs, SourceRange range);
anatofuz
parents:
diff changeset
34 bool hasDiagnostic(ArrayRef<unsigned> IDs, SourceRange range) const;
anatofuz
parents:
diff changeset
35
anatofuz
parents:
diff changeset
36 void reportDiagnostics(DiagnosticsEngine &diags) const;
anatofuz
parents:
diff changeset
37
anatofuz
parents:
diff changeset
38 bool hasErrors() const;
anatofuz
parents:
diff changeset
39
anatofuz
parents:
diff changeset
40 typedef ListTy::const_iterator iterator;
anatofuz
parents:
diff changeset
41 iterator begin() const { return List.begin(); }
anatofuz
parents:
diff changeset
42 iterator end() const { return List.end(); }
anatofuz
parents:
diff changeset
43 };
anatofuz
parents:
diff changeset
44
anatofuz
parents:
diff changeset
45 void writeARCDiagsToPlist(const std::string &outPath,
anatofuz
parents:
diff changeset
46 ArrayRef<StoredDiagnostic> diags,
anatofuz
parents:
diff changeset
47 SourceManager &SM, const LangOptions &LangOpts);
anatofuz
parents:
diff changeset
48
anatofuz
parents:
diff changeset
49 class TransformActions {
anatofuz
parents:
diff changeset
50 DiagnosticsEngine &Diags;
anatofuz
parents:
diff changeset
51 CapturedDiagList &CapturedDiags;
anatofuz
parents:
diff changeset
52 void *Impl; // TransformActionsImpl.
anatofuz
parents:
diff changeset
53
anatofuz
parents:
diff changeset
54 public:
anatofuz
parents:
diff changeset
55 TransformActions(DiagnosticsEngine &diag, CapturedDiagList &capturedDiags,
anatofuz
parents:
diff changeset
56 ASTContext &ctx, Preprocessor &PP);
anatofuz
parents:
diff changeset
57 ~TransformActions();
anatofuz
parents:
diff changeset
58
anatofuz
parents:
diff changeset
59 void startTransaction();
anatofuz
parents:
diff changeset
60 bool commitTransaction();
anatofuz
parents:
diff changeset
61 void abortTransaction();
anatofuz
parents:
diff changeset
62
anatofuz
parents:
diff changeset
63 void insert(SourceLocation loc, StringRef text);
anatofuz
parents:
diff changeset
64 void insertAfterToken(SourceLocation loc, StringRef text);
anatofuz
parents:
diff changeset
65 void remove(SourceRange range);
anatofuz
parents:
diff changeset
66 void removeStmt(Stmt *S);
anatofuz
parents:
diff changeset
67 void replace(SourceRange range, StringRef text);
anatofuz
parents:
diff changeset
68 void replace(SourceRange range, SourceRange replacementRange);
anatofuz
parents:
diff changeset
69 void replaceStmt(Stmt *S, StringRef text);
anatofuz
parents:
diff changeset
70 void replaceText(SourceLocation loc, StringRef text,
anatofuz
parents:
diff changeset
71 StringRef replacementText);
anatofuz
parents:
diff changeset
72 void increaseIndentation(SourceRange range,
anatofuz
parents:
diff changeset
73 SourceLocation parentIndent);
anatofuz
parents:
diff changeset
74
anatofuz
parents:
diff changeset
75 bool clearDiagnostic(ArrayRef<unsigned> IDs, SourceRange range);
anatofuz
parents:
diff changeset
76 bool clearAllDiagnostics(SourceRange range) {
anatofuz
parents:
diff changeset
77 return clearDiagnostic(None, range);
anatofuz
parents:
diff changeset
78 }
anatofuz
parents:
diff changeset
79 bool clearDiagnostic(unsigned ID1, unsigned ID2, SourceRange range) {
anatofuz
parents:
diff changeset
80 unsigned IDs[] = { ID1, ID2 };
anatofuz
parents:
diff changeset
81 return clearDiagnostic(IDs, range);
anatofuz
parents:
diff changeset
82 }
anatofuz
parents:
diff changeset
83 bool clearDiagnostic(unsigned ID1, unsigned ID2, unsigned ID3,
anatofuz
parents:
diff changeset
84 SourceRange range) {
anatofuz
parents:
diff changeset
85 unsigned IDs[] = { ID1, ID2, ID3 };
anatofuz
parents:
diff changeset
86 return clearDiagnostic(IDs, range);
anatofuz
parents:
diff changeset
87 }
anatofuz
parents:
diff changeset
88
anatofuz
parents:
diff changeset
89 bool hasDiagnostic(unsigned ID, SourceRange range) {
anatofuz
parents:
diff changeset
90 return CapturedDiags.hasDiagnostic(ID, range);
anatofuz
parents:
diff changeset
91 }
anatofuz
parents:
diff changeset
92
anatofuz
parents:
diff changeset
93 bool hasDiagnostic(unsigned ID1, unsigned ID2, SourceRange range) {
anatofuz
parents:
diff changeset
94 unsigned IDs[] = { ID1, ID2 };
anatofuz
parents:
diff changeset
95 return CapturedDiags.hasDiagnostic(IDs, range);
anatofuz
parents:
diff changeset
96 }
anatofuz
parents:
diff changeset
97
anatofuz
parents:
diff changeset
98 DiagnosticBuilder report(SourceLocation loc, unsigned diagId,
anatofuz
parents:
diff changeset
99 SourceRange range = SourceRange());
anatofuz
parents:
diff changeset
100 void reportError(StringRef error, SourceLocation loc,
anatofuz
parents:
diff changeset
101 SourceRange range = SourceRange());
anatofuz
parents:
diff changeset
102 void reportWarning(StringRef warning, SourceLocation loc,
anatofuz
parents:
diff changeset
103 SourceRange range = SourceRange());
anatofuz
parents:
diff changeset
104 void reportNote(StringRef note, SourceLocation loc,
anatofuz
parents:
diff changeset
105 SourceRange range = SourceRange());
anatofuz
parents:
diff changeset
106
anatofuz
parents:
diff changeset
107 bool hasReportedErrors() const {
anatofuz
parents:
diff changeset
108 return Diags.hasUnrecoverableErrorOccurred();
anatofuz
parents:
diff changeset
109 }
anatofuz
parents:
diff changeset
110
anatofuz
parents:
diff changeset
111 class RewriteReceiver {
anatofuz
parents:
diff changeset
112 public:
anatofuz
parents:
diff changeset
113 virtual ~RewriteReceiver();
anatofuz
parents:
diff changeset
114
anatofuz
parents:
diff changeset
115 virtual void insert(SourceLocation loc, StringRef text) = 0;
anatofuz
parents:
diff changeset
116 virtual void remove(CharSourceRange range) = 0;
anatofuz
parents:
diff changeset
117 virtual void increaseIndentation(CharSourceRange range,
anatofuz
parents:
diff changeset
118 SourceLocation parentIndent) = 0;
anatofuz
parents:
diff changeset
119 };
anatofuz
parents:
diff changeset
120
anatofuz
parents:
diff changeset
121 void applyRewrites(RewriteReceiver &receiver);
anatofuz
parents:
diff changeset
122 };
anatofuz
parents:
diff changeset
123
anatofuz
parents:
diff changeset
124 class Transaction {
anatofuz
parents:
diff changeset
125 TransformActions &TA;
anatofuz
parents:
diff changeset
126 bool Aborted;
anatofuz
parents:
diff changeset
127
anatofuz
parents:
diff changeset
128 public:
anatofuz
parents:
diff changeset
129 Transaction(TransformActions &TA) : TA(TA), Aborted(false) {
anatofuz
parents:
diff changeset
130 TA.startTransaction();
anatofuz
parents:
diff changeset
131 }
anatofuz
parents:
diff changeset
132
anatofuz
parents:
diff changeset
133 ~Transaction() {
anatofuz
parents:
diff changeset
134 if (!isAborted())
anatofuz
parents:
diff changeset
135 TA.commitTransaction();
anatofuz
parents:
diff changeset
136 }
anatofuz
parents:
diff changeset
137
anatofuz
parents:
diff changeset
138 void abort() {
anatofuz
parents:
diff changeset
139 TA.abortTransaction();
anatofuz
parents:
diff changeset
140 Aborted = true;
anatofuz
parents:
diff changeset
141 }
anatofuz
parents:
diff changeset
142
anatofuz
parents:
diff changeset
143 bool isAborted() const { return Aborted; }
anatofuz
parents:
diff changeset
144 };
anatofuz
parents:
diff changeset
145
anatofuz
parents:
diff changeset
146 class MigrationPass {
anatofuz
parents:
diff changeset
147 public:
anatofuz
parents:
diff changeset
148 ASTContext &Ctx;
anatofuz
parents:
diff changeset
149 LangOptions::GCMode OrigGCMode;
anatofuz
parents:
diff changeset
150 MigratorOptions MigOptions;
anatofuz
parents:
diff changeset
151 Sema &SemaRef;
anatofuz
parents:
diff changeset
152 TransformActions &TA;
anatofuz
parents:
diff changeset
153 const CapturedDiagList &CapturedDiags;
anatofuz
parents:
diff changeset
154 std::vector<SourceLocation> &ARCMTMacroLocs;
anatofuz
parents:
diff changeset
155 Optional<bool> EnableCFBridgeFns;
anatofuz
parents:
diff changeset
156
anatofuz
parents:
diff changeset
157 MigrationPass(ASTContext &Ctx, LangOptions::GCMode OrigGCMode,
anatofuz
parents:
diff changeset
158 Sema &sema, TransformActions &TA,
anatofuz
parents:
diff changeset
159 const CapturedDiagList &capturedDiags,
anatofuz
parents:
diff changeset
160 std::vector<SourceLocation> &ARCMTMacroLocs)
anatofuz
parents:
diff changeset
161 : Ctx(Ctx), OrigGCMode(OrigGCMode), MigOptions(),
anatofuz
parents:
diff changeset
162 SemaRef(sema), TA(TA), CapturedDiags(capturedDiags),
anatofuz
parents:
diff changeset
163 ARCMTMacroLocs(ARCMTMacroLocs) { }
anatofuz
parents:
diff changeset
164
anatofuz
parents:
diff changeset
165 const CapturedDiagList &getDiags() const { return CapturedDiags; }
anatofuz
parents:
diff changeset
166
anatofuz
parents:
diff changeset
167 bool isGCMigration() const { return OrigGCMode != LangOptions::NonGC; }
anatofuz
parents:
diff changeset
168 bool noFinalizeRemoval() const { return MigOptions.NoFinalizeRemoval; }
anatofuz
parents:
diff changeset
169 void setNoFinalizeRemoval(bool val) {MigOptions.NoFinalizeRemoval = val; }
anatofuz
parents:
diff changeset
170
anatofuz
parents:
diff changeset
171 bool CFBridgingFunctionsDefined();
anatofuz
parents:
diff changeset
172 };
anatofuz
parents:
diff changeset
173
anatofuz
parents:
diff changeset
174 static inline StringRef getARCMTMacroName() {
anatofuz
parents:
diff changeset
175 return "__IMPL_ARCMT_REMOVED_EXPR__";
anatofuz
parents:
diff changeset
176 }
anatofuz
parents:
diff changeset
177
anatofuz
parents:
diff changeset
178 } // end namespace arcmt
anatofuz
parents:
diff changeset
179
anatofuz
parents:
diff changeset
180 } // end namespace clang
anatofuz
parents:
diff changeset
181
anatofuz
parents:
diff changeset
182 #endif