File: | build/source/clang-tools-extra/clangd/ClangdServer.cpp |
Warning: | line 87, column 5 Potential leak of memory pointed to by field '_M_head_impl' |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
1 | //===--- ClangdServer.cpp - Main clangd server code --------------*- 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 | #include "ClangdServer.h" | |||
10 | #include "CodeComplete.h" | |||
11 | #include "Config.h" | |||
12 | #include "Diagnostics.h" | |||
13 | #include "DumpAST.h" | |||
14 | #include "FindSymbols.h" | |||
15 | #include "Format.h" | |||
16 | #include "HeaderSourceSwitch.h" | |||
17 | #include "InlayHints.h" | |||
18 | #include "ParsedAST.h" | |||
19 | #include "Preamble.h" | |||
20 | #include "Protocol.h" | |||
21 | #include "SemanticHighlighting.h" | |||
22 | #include "SemanticSelection.h" | |||
23 | #include "SourceCode.h" | |||
24 | #include "TUScheduler.h" | |||
25 | #include "XRefs.h" | |||
26 | #include "index/CanonicalIncludes.h" | |||
27 | #include "index/FileIndex.h" | |||
28 | #include "index/Merge.h" | |||
29 | #include "index/StdLib.h" | |||
30 | #include "refactor/Rename.h" | |||
31 | #include "refactor/Tweak.h" | |||
32 | #include "support/Cancellation.h" | |||
33 | #include "support/Logger.h" | |||
34 | #include "support/MemoryTree.h" | |||
35 | #include "support/ThreadsafeFS.h" | |||
36 | #include "support/Trace.h" | |||
37 | #include "clang/Format/Format.h" | |||
38 | #include "clang/Lex/Preprocessor.h" | |||
39 | #include "clang/Tooling/CompilationDatabase.h" | |||
40 | #include "clang/Tooling/Core/Replacement.h" | |||
41 | #include "llvm/ADT/ArrayRef.h" | |||
42 | #include "llvm/ADT/STLExtras.h" | |||
43 | #include "llvm/ADT/StringRef.h" | |||
44 | #include "llvm/Support/Error.h" | |||
45 | #include "llvm/Support/Path.h" | |||
46 | #include "llvm/Support/raw_ostream.h" | |||
47 | #include <algorithm> | |||
48 | #include <chrono> | |||
49 | #include <future> | |||
50 | #include <memory> | |||
51 | #include <mutex> | |||
52 | #include <optional> | |||
53 | #include <string> | |||
54 | #include <type_traits> | |||
55 | ||||
56 | namespace clang { | |||
57 | namespace clangd { | |||
58 | namespace { | |||
59 | ||||
60 | // Update the FileIndex with new ASTs and plumb the diagnostics responses. | |||
61 | struct UpdateIndexCallbacks : public ParsingCallbacks { | |||
62 | UpdateIndexCallbacks(FileIndex *FIndex, | |||
63 | ClangdServer::Callbacks *ServerCallbacks, | |||
64 | const ThreadsafeFS &TFS, AsyncTaskRunner *Tasks, | |||
65 | bool CollectInactiveRegions) | |||
66 | : FIndex(FIndex), ServerCallbacks(ServerCallbacks), TFS(TFS), | |||
67 | Stdlib{std::make_shared<StdLibSet>()}, Tasks(Tasks), | |||
68 | CollectInactiveRegions(CollectInactiveRegions) {} | |||
69 | ||||
70 | void onPreambleAST(PathRef Path, llvm::StringRef Version, | |||
71 | const CompilerInvocation &CI, ASTContext &Ctx, | |||
72 | Preprocessor &PP, | |||
73 | const CanonicalIncludes &CanonIncludes) override { | |||
74 | // If this preamble uses a standard library we haven't seen yet, index it. | |||
75 | if (FIndex) | |||
| ||||
76 | if (auto Loc = Stdlib->add(*CI.getLangOpts(), PP.getHeaderSearchInfo())) | |||
77 | indexStdlib(CI, std::move(*Loc)); | |||
78 | ||||
79 | if (FIndex) | |||
80 | FIndex->updatePreamble(Path, Version, Ctx, PP, CanonIncludes); | |||
81 | } | |||
82 | ||||
83 | void indexStdlib(const CompilerInvocation &CI, StdLibLocation Loc) { | |||
84 | // This task is owned by Tasks, which outlives the TUScheduler and | |||
85 | // therefore the UpdateIndexCallbacks. | |||
86 | // We must be careful that the references we capture outlive TUScheduler. | |||
87 | auto Task = [LO(*CI.getLangOpts()), Loc(std::move(Loc)), | |||
| ||||
88 | CI(std::make_unique<CompilerInvocation>(CI)), | |||
89 | // External values that outlive ClangdServer | |||
90 | TFS(&TFS), | |||
91 | // Index outlives TUScheduler (declared first) | |||
92 | FIndex(FIndex), | |||
93 | // shared_ptr extends lifetime | |||
94 | Stdlib(Stdlib)]() mutable { | |||
95 | IndexFileIn IF; | |||
96 | IF.Symbols = indexStandardLibrary(std::move(CI), Loc, *TFS); | |||
97 | if (Stdlib->isBest(LO)) | |||
98 | FIndex->updatePreamble(std::move(IF)); | |||
99 | }; | |||
100 | if (Tasks) | |||
101 | // This doesn't have a semaphore to enforce -j, but it's rare. | |||
102 | Tasks->runAsync("IndexStdlib", std::move(Task)); | |||
103 | else | |||
104 | Task(); | |||
105 | } | |||
106 | ||||
107 | void onMainAST(PathRef Path, ParsedAST &AST, PublishFn Publish) override { | |||
108 | if (FIndex) | |||
109 | FIndex->updateMain(Path, AST); | |||
110 | ||||
111 | assert(AST.getDiagnostics() &&(static_cast <bool> (AST.getDiagnostics() && "We issue callback only with fresh preambles" ) ? void (0) : __assert_fail ("AST.getDiagnostics() && \"We issue callback only with fresh preambles\"" , "clang-tools-extra/clangd/ClangdServer.cpp", 112, __extension__ __PRETTY_FUNCTION__)) | |||
112 | "We issue callback only with fresh preambles")(static_cast <bool> (AST.getDiagnostics() && "We issue callback only with fresh preambles" ) ? void (0) : __assert_fail ("AST.getDiagnostics() && \"We issue callback only with fresh preambles\"" , "clang-tools-extra/clangd/ClangdServer.cpp", 112, __extension__ __PRETTY_FUNCTION__)); | |||
113 | std::vector<Diag> Diagnostics = *AST.getDiagnostics(); | |||
114 | if (ServerCallbacks) | |||
115 | Publish([&]() { | |||
116 | ServerCallbacks->onDiagnosticsReady(Path, AST.version(), | |||
117 | std::move(Diagnostics)); | |||
118 | if (CollectInactiveRegions) { | |||
119 | ServerCallbacks->onInactiveRegionsReady( | |||
120 | Path, std::move(AST.getMacros().SkippedRanges)); | |||
121 | } | |||
122 | }); | |||
123 | } | |||
124 | ||||
125 | void onFailedAST(PathRef Path, llvm::StringRef Version, | |||
126 | std::vector<Diag> Diags, PublishFn Publish) override { | |||
127 | if (ServerCallbacks) | |||
128 | Publish( | |||
129 | [&]() { ServerCallbacks->onDiagnosticsReady(Path, Version, Diags); }); | |||
130 | } | |||
131 | ||||
132 | void onFileUpdated(PathRef File, const TUStatus &Status) override { | |||
133 | if (ServerCallbacks) | |||
134 | ServerCallbacks->onFileUpdated(File, Status); | |||
135 | } | |||
136 | ||||
137 | void onPreamblePublished(PathRef File) override { | |||
138 | if (ServerCallbacks) | |||
139 | ServerCallbacks->onSemanticsMaybeChanged(File); | |||
140 | } | |||
141 | ||||
142 | private: | |||
143 | FileIndex *FIndex; | |||
144 | ClangdServer::Callbacks *ServerCallbacks; | |||
145 | const ThreadsafeFS &TFS; | |||
146 | std::shared_ptr<StdLibSet> Stdlib; | |||
147 | AsyncTaskRunner *Tasks; | |||
148 | bool CollectInactiveRegions; | |||
149 | }; | |||
150 | ||||
151 | class DraftStoreFS : public ThreadsafeFS { | |||
152 | public: | |||
153 | DraftStoreFS(const ThreadsafeFS &Base, const DraftStore &Drafts) | |||
154 | : Base(Base), DirtyFiles(Drafts) {} | |||
155 | ||||
156 | private: | |||
157 | llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> viewImpl() const override { | |||
158 | auto OFS = llvm::makeIntrusiveRefCnt<llvm::vfs::OverlayFileSystem>( | |||
159 | Base.view(std::nullopt)); | |||
160 | OFS->pushOverlay(DirtyFiles.asVFS()); | |||
161 | return OFS; | |||
162 | } | |||
163 | ||||
164 | const ThreadsafeFS &Base; | |||
165 | const DraftStore &DirtyFiles; | |||
166 | }; | |||
167 | ||||
168 | } // namespace | |||
169 | ||||
170 | ClangdServer::Options ClangdServer::optsForTest() { | |||
171 | ClangdServer::Options Opts; | |||
172 | Opts.UpdateDebounce = DebouncePolicy::fixed(/*zero*/ {}); | |||
173 | Opts.StorePreamblesInMemory = true; | |||
174 | Opts.AsyncThreadsCount = 4; // Consistent! | |||
175 | return Opts; | |||
176 | } | |||
177 | ||||
178 | ClangdServer::Options::operator TUScheduler::Options() const { | |||
179 | TUScheduler::Options Opts; | |||
180 | Opts.AsyncThreadsCount = AsyncThreadsCount; | |||
181 | Opts.RetentionPolicy = RetentionPolicy; | |||
182 | Opts.StorePreamblesInMemory = StorePreamblesInMemory; | |||
183 | Opts.UpdateDebounce = UpdateDebounce; | |||
184 | Opts.ContextProvider = ContextProvider; | |||
185 | Opts.PreambleThrottler = PreambleThrottler; | |||
186 | return Opts; | |||
187 | } | |||
188 | ||||
189 | ClangdServer::ClangdServer(const GlobalCompilationDatabase &CDB, | |||
190 | const ThreadsafeFS &TFS, const Options &Opts, | |||
191 | Callbacks *Callbacks) | |||
192 | : FeatureModules(Opts.FeatureModules), CDB(CDB), TFS(TFS), | |||
193 | DynamicIdx(Opts.BuildDynamicSymbolIndex ? new FileIndex() : nullptr), | |||
194 | ClangTidyProvider(Opts.ClangTidyProvider), | |||
195 | UseDirtyHeaders(Opts.UseDirtyHeaders), | |||
196 | LineFoldingOnly(Opts.LineFoldingOnly), | |||
197 | PreambleParseForwardingFunctions(Opts.PreambleParseForwardingFunctions), | |||
198 | ImportInsertions(Opts.ImportInsertions), | |||
199 | PublishInactiveRegions(Opts.PublishInactiveRegions), | |||
200 | WorkspaceRoot(Opts.WorkspaceRoot), | |||
201 | Transient(Opts.ImplicitCancellation ? TUScheduler::InvalidateOnUpdate | |||
202 | : TUScheduler::NoInvalidation), | |||
203 | DirtyFS(std::make_unique<DraftStoreFS>(TFS, DraftMgr)) { | |||
204 | if (Opts.AsyncThreadsCount != 0) | |||
205 | IndexTasks.emplace(); | |||
206 | // Pass a callback into `WorkScheduler` to extract symbols from a newly | |||
207 | // parsed file and rebuild the file index synchronously each time an AST | |||
208 | // is parsed. | |||
209 | WorkScheduler.emplace(CDB, TUScheduler::Options(Opts), | |||
210 | std::make_unique<UpdateIndexCallbacks>( | |||
211 | DynamicIdx.get(), Callbacks, TFS, | |||
212 | IndexTasks ? &*IndexTasks : nullptr, | |||
213 | PublishInactiveRegions)); | |||
214 | // Adds an index to the stack, at higher priority than existing indexes. | |||
215 | auto AddIndex = [&](SymbolIndex *Idx) { | |||
216 | if (this->Index != nullptr) { | |||
217 | MergedIdx.push_back(std::make_unique<MergedIndex>(Idx, this->Index)); | |||
218 | this->Index = MergedIdx.back().get(); | |||
219 | } else { | |||
220 | this->Index = Idx; | |||
221 | } | |||
222 | }; | |||
223 | if (Opts.StaticIndex) | |||
224 | AddIndex(Opts.StaticIndex); | |||
225 | if (Opts.BackgroundIndex) { | |||
226 | BackgroundIndex::Options BGOpts; | |||
227 | BGOpts.ThreadPoolSize = std::max(Opts.AsyncThreadsCount, 1u); | |||
228 | BGOpts.OnProgress = [Callbacks](BackgroundQueue::Stats S) { | |||
229 | if (Callbacks) | |||
230 | Callbacks->onBackgroundIndexProgress(S); | |||
231 | }; | |||
232 | BGOpts.ContextProvider = Opts.ContextProvider; | |||
233 | BackgroundIdx = std::make_unique<BackgroundIndex>( | |||
234 | TFS, CDB, | |||
235 | BackgroundIndexStorage::createDiskBackedStorageFactory( | |||
236 | [&CDB](llvm::StringRef File) { return CDB.getProjectInfo(File); }), | |||
237 | std::move(BGOpts)); | |||
238 | AddIndex(BackgroundIdx.get()); | |||
239 | } | |||
240 | if (DynamicIdx) | |||
241 | AddIndex(DynamicIdx.get()); | |||
242 | ||||
243 | if (Opts.FeatureModules) { | |||
244 | FeatureModule::Facilities F{ | |||
245 | *this->WorkScheduler, | |||
246 | this->Index, | |||
247 | this->TFS, | |||
248 | }; | |||
249 | for (auto &Mod : *Opts.FeatureModules) | |||
250 | Mod.initialize(F); | |||
251 | } | |||
252 | } | |||
253 | ||||
254 | ClangdServer::~ClangdServer() { | |||
255 | // Destroying TUScheduler first shuts down request threads that might | |||
256 | // otherwise access members concurrently. | |||
257 | // (Nobody can be using TUScheduler because we're on the main thread). | |||
258 | WorkScheduler.reset(); | |||
259 | // Now requests have stopped, we can shut down feature modules. | |||
260 | if (FeatureModules) { | |||
261 | for (auto &Mod : *FeatureModules) | |||
262 | Mod.stop(); | |||
263 | for (auto &Mod : *FeatureModules) | |||
264 | Mod.blockUntilIdle(Deadline::infinity()); | |||
265 | } | |||
266 | } | |||
267 | ||||
268 | void ClangdServer::addDocument(PathRef File, llvm::StringRef Contents, | |||
269 | llvm::StringRef Version, | |||
270 | WantDiagnostics WantDiags, bool ForceRebuild) { | |||
271 | std::string ActualVersion = DraftMgr.addDraft(File, Version, Contents); | |||
272 | ParseOptions Opts; | |||
273 | Opts.PreambleParseForwardingFunctions = PreambleParseForwardingFunctions; | |||
274 | Opts.ImportInsertions = ImportInsertions; | |||
275 | ||||
276 | // Compile command is set asynchronously during update, as it can be slow. | |||
277 | ParseInputs Inputs; | |||
278 | Inputs.TFS = &getHeaderFS(); | |||
279 | Inputs.Contents = std::string(Contents); | |||
280 | Inputs.Version = std::move(ActualVersion); | |||
281 | Inputs.ForceRebuild = ForceRebuild; | |||
282 | Inputs.Opts = std::move(Opts); | |||
283 | Inputs.Index = Index; | |||
284 | Inputs.ClangTidyProvider = ClangTidyProvider; | |||
285 | Inputs.FeatureModules = FeatureModules; | |||
286 | bool NewFile = WorkScheduler->update(File, Inputs, WantDiags); | |||
287 | // If we loaded Foo.h, we want to make sure Foo.cpp is indexed. | |||
288 | if (NewFile && BackgroundIdx) | |||
289 | BackgroundIdx->boostRelated(File); | |||
290 | } | |||
291 | ||||
292 | void ClangdServer::reparseOpenFilesIfNeeded( | |||
293 | llvm::function_ref<bool(llvm::StringRef File)> Filter) { | |||
294 | // Reparse only opened files that were modified. | |||
295 | for (const Path &FilePath : DraftMgr.getActiveFiles()) | |||
296 | if (Filter(FilePath)) | |||
297 | if (auto Draft = DraftMgr.getDraft(FilePath)) // else disappeared in race? | |||
298 | addDocument(FilePath, *Draft->Contents, Draft->Version, | |||
299 | WantDiagnostics::Auto); | |||
300 | } | |||
301 | ||||
302 | std::shared_ptr<const std::string> ClangdServer::getDraft(PathRef File) const { | |||
303 | auto Draft = DraftMgr.getDraft(File); | |||
304 | if (!Draft) | |||
305 | return nullptr; | |||
306 | return std::move(Draft->Contents); | |||
307 | } | |||
308 | ||||
309 | std::function<Context(PathRef)> | |||
310 | ClangdServer::createConfiguredContextProvider(const config::Provider *Provider, | |||
311 | Callbacks *Publish) { | |||
312 | if (!Provider) | |||
313 | return [](llvm::StringRef) { return Context::current().clone(); }; | |||
314 | ||||
315 | struct Impl { | |||
316 | const config::Provider *Provider; | |||
317 | ClangdServer::Callbacks *Publish; | |||
318 | std::mutex PublishMu; | |||
319 | ||||
320 | Impl(const config::Provider *Provider, ClangdServer::Callbacks *Publish) | |||
321 | : Provider(Provider), Publish(Publish) {} | |||
322 | ||||
323 | Context operator()(llvm::StringRef File) { | |||
324 | config::Params Params; | |||
325 | // Don't reread config files excessively often. | |||
326 | // FIXME: when we see a config file change event, use the event timestamp? | |||
327 | Params.FreshTime = | |||
328 | std::chrono::steady_clock::now() - std::chrono::seconds(5); | |||
329 | llvm::SmallString<256> PosixPath; | |||
330 | if (!File.empty()) { | |||
331 | assert(llvm::sys::path::is_absolute(File))(static_cast <bool> (llvm::sys::path::is_absolute(File) ) ? void (0) : __assert_fail ("llvm::sys::path::is_absolute(File)" , "clang-tools-extra/clangd/ClangdServer.cpp", 331, __extension__ __PRETTY_FUNCTION__)); | |||
332 | llvm::sys::path::native(File, PosixPath, llvm::sys::path::Style::posix); | |||
333 | Params.Path = PosixPath.str(); | |||
334 | } | |||
335 | ||||
336 | llvm::StringMap<std::vector<Diag>> ReportableDiagnostics; | |||
337 | Config C = Provider->getConfig(Params, [&](const llvm::SMDiagnostic &D) { | |||
338 | // Create the map entry even for note diagnostics we don't report. | |||
339 | // This means that when the file is parsed with no warnings, we | |||
340 | // publish an empty set of diagnostics, clearing any the client has. | |||
341 | handleDiagnostic(D, !Publish || D.getFilename().empty() | |||
342 | ? nullptr | |||
343 | : &ReportableDiagnostics[D.getFilename()]); | |||
344 | }); | |||
345 | // Blindly publish diagnostics for the (unopened) parsed config files. | |||
346 | // We must avoid reporting diagnostics for *the same file* concurrently. | |||
347 | // Source diags are published elsewhere, but those are different files. | |||
348 | if (!ReportableDiagnostics.empty()) { | |||
349 | std::lock_guard<std::mutex> Lock(PublishMu); | |||
350 | for (auto &Entry : ReportableDiagnostics) | |||
351 | Publish->onDiagnosticsReady(Entry.first(), /*Version=*/"", | |||
352 | std::move(Entry.second)); | |||
353 | } | |||
354 | return Context::current().derive(Config::Key, std::move(C)); | |||
355 | } | |||
356 | ||||
357 | void handleDiagnostic(const llvm::SMDiagnostic &D, | |||
358 | std::vector<Diag> *ClientDiagnostics) { | |||
359 | switch (D.getKind()) { | |||
360 | case llvm::SourceMgr::DK_Error: | |||
361 | elog("config error at {0}:{1}:{2}: {3}", D.getFilename(), D.getLineNo(), | |||
362 | D.getColumnNo(), D.getMessage()); | |||
363 | break; | |||
364 | case llvm::SourceMgr::DK_Warning: | |||
365 | log("config warning at {0}:{1}:{2}: {3}", D.getFilename(), | |||
366 | D.getLineNo(), D.getColumnNo(), D.getMessage()); | |||
367 | break; | |||
368 | case llvm::SourceMgr::DK_Note: | |||
369 | case llvm::SourceMgr::DK_Remark: | |||
370 | vlog("config note at {0}:{1}:{2}: {3}", D.getFilename(), D.getLineNo(), | |||
371 | D.getColumnNo(), D.getMessage()); | |||
372 | ClientDiagnostics = nullptr; // Don't emit notes as LSP diagnostics. | |||
373 | break; | |||
374 | } | |||
375 | if (ClientDiagnostics) | |||
376 | ClientDiagnostics->push_back(toDiag(D, Diag::ClangdConfig)); | |||
377 | } | |||
378 | }; | |||
379 | ||||
380 | // Copyable wrapper. | |||
381 | return [I(std::make_shared<Impl>(Provider, Publish))](llvm::StringRef Path) { | |||
382 | return (*I)(Path); | |||
383 | }; | |||
384 | } | |||
385 | ||||
386 | void ClangdServer::removeDocument(PathRef File) { | |||
387 | DraftMgr.removeDraft(File); | |||
388 | WorkScheduler->remove(File); | |||
389 | } | |||
390 | ||||
391 | void ClangdServer::codeComplete(PathRef File, Position Pos, | |||
392 | const clangd::CodeCompleteOptions &Opts, | |||
393 | Callback<CodeCompleteResult> CB) { | |||
394 | // Copy completion options for passing them to async task handler. | |||
395 | auto CodeCompleteOpts = Opts; | |||
396 | if (!CodeCompleteOpts.Index) // Respect overridden index. | |||
397 | CodeCompleteOpts.Index = Index; | |||
398 | ||||
399 | auto Task = [Pos, CodeCompleteOpts, File = File.str(), CB = std::move(CB), | |||
400 | this](llvm::Expected<InputsAndPreamble> IP) mutable { | |||
401 | if (!IP) | |||
402 | return CB(IP.takeError()); | |||
403 | if (auto Reason = isCancelled()) | |||
404 | return CB(llvm::make_error<CancelledError>(Reason)); | |||
405 | ||||
406 | std::optional<SpeculativeFuzzyFind> SpecFuzzyFind; | |||
407 | if (!IP->Preamble) { | |||
408 | // No speculation in Fallback mode, as it's supposed to be much faster | |||
409 | // without compiling. | |||
410 | vlog("Build for file {0} is not ready. Enter fallback mode.", File); | |||
411 | } else if (CodeCompleteOpts.Index) { | |||
412 | SpecFuzzyFind.emplace(); | |||
413 | { | |||
414 | std::lock_guard<std::mutex> Lock(CachedCompletionFuzzyFindRequestMutex); | |||
415 | SpecFuzzyFind->CachedReq = CachedCompletionFuzzyFindRequestByFile[File]; | |||
416 | } | |||
417 | } | |||
418 | ParseInputs ParseInput{IP->Command, &getHeaderFS(), IP->Contents.str()}; | |||
419 | // FIXME: Add traling new line if there is none at eof, workaround a crash, | |||
420 | // see https://github.com/clangd/clangd/issues/332 | |||
421 | if (!IP->Contents.endswith("\n")) | |||
422 | ParseInput.Contents.append("\n"); | |||
423 | ParseInput.Index = Index; | |||
424 | ||||
425 | CodeCompleteOpts.MainFileSignals = IP->Signals; | |||
426 | CodeCompleteOpts.AllScopes = Config::current().Completion.AllScopes; | |||
427 | // FIXME(ibiryukov): even if Preamble is non-null, we may want to check | |||
428 | // both the old and the new version in case only one of them matches. | |||
429 | CodeCompleteResult Result = clangd::codeComplete( | |||
430 | File, Pos, IP->Preamble, ParseInput, CodeCompleteOpts, | |||
431 | SpecFuzzyFind ? &*SpecFuzzyFind : nullptr); | |||
432 | { | |||
433 | clang::clangd::trace::Span Tracer("Completion results callback"); | |||
434 | CB(std::move(Result)); | |||
435 | } | |||
436 | if (SpecFuzzyFind && SpecFuzzyFind->NewReq) { | |||
437 | std::lock_guard<std::mutex> Lock(CachedCompletionFuzzyFindRequestMutex); | |||
438 | CachedCompletionFuzzyFindRequestByFile[File] = *SpecFuzzyFind->NewReq; | |||
439 | } | |||
440 | // SpecFuzzyFind is only destroyed after speculative fuzzy find finishes. | |||
441 | // We don't want `codeComplete` to wait for the async call if it doesn't use | |||
442 | // the result (e.g. non-index completion, speculation fails), so that `CB` | |||
443 | // is called as soon as results are available. | |||
444 | }; | |||
445 | ||||
446 | // We use a potentially-stale preamble because latency is critical here. | |||
447 | WorkScheduler->runWithPreamble( | |||
448 | "CodeComplete", File, | |||
449 | (Opts.RunParser == CodeCompleteOptions::AlwaysParse) | |||
450 | ? TUScheduler::Stale | |||
451 | : TUScheduler::StaleOrAbsent, | |||
452 | std::move(Task)); | |||
453 | } | |||
454 | ||||
455 | void ClangdServer::signatureHelp(PathRef File, Position Pos, | |||
456 | MarkupKind DocumentationFormat, | |||
457 | Callback<SignatureHelp> CB) { | |||
458 | ||||
459 | auto Action = [Pos, File = File.str(), CB = std::move(CB), | |||
460 | DocumentationFormat, | |||
461 | this](llvm::Expected<InputsAndPreamble> IP) mutable { | |||
462 | if (!IP) | |||
463 | return CB(IP.takeError()); | |||
464 | ||||
465 | const auto *PreambleData = IP->Preamble; | |||
466 | if (!PreambleData) | |||
467 | return CB(error("Failed to parse includes")); | |||
468 | ||||
469 | ParseInputs ParseInput{IP->Command, &getHeaderFS(), IP->Contents.str()}; | |||
470 | // FIXME: Add traling new line if there is none at eof, workaround a crash, | |||
471 | // see https://github.com/clangd/clangd/issues/332 | |||
472 | if (!IP->Contents.endswith("\n")) | |||
473 | ParseInput.Contents.append("\n"); | |||
474 | ParseInput.Index = Index; | |||
475 | CB(clangd::signatureHelp(File, Pos, *PreambleData, ParseInput, | |||
476 | DocumentationFormat)); | |||
477 | }; | |||
478 | ||||
479 | // Unlike code completion, we wait for a preamble here. | |||
480 | WorkScheduler->runWithPreamble("SignatureHelp", File, TUScheduler::Stale, | |||
481 | std::move(Action)); | |||
482 | } | |||
483 | ||||
484 | void ClangdServer::formatFile(PathRef File, std::optional<Range> Rng, | |||
485 | Callback<tooling::Replacements> CB) { | |||
486 | auto Code = getDraft(File); | |||
487 | if (!Code) | |||
488 | return CB(llvm::make_error<LSPError>("trying to format non-added document", | |||
489 | ErrorCode::InvalidParams)); | |||
490 | tooling::Range RequestedRange; | |||
491 | if (Rng) { | |||
492 | llvm::Expected<size_t> Begin = positionToOffset(*Code, Rng->start); | |||
493 | if (!Begin) | |||
494 | return CB(Begin.takeError()); | |||
495 | llvm::Expected<size_t> End = positionToOffset(*Code, Rng->end); | |||
496 | if (!End) | |||
497 | return CB(End.takeError()); | |||
498 | RequestedRange = tooling::Range(*Begin, *End - *Begin); | |||
499 | } else { | |||
500 | RequestedRange = tooling::Range(0, Code->size()); | |||
501 | } | |||
502 | ||||
503 | // Call clang-format. | |||
504 | auto Action = [File = File.str(), Code = std::move(*Code), | |||
505 | Ranges = std::vector<tooling::Range>{RequestedRange}, | |||
506 | CB = std::move(CB), this]() mutable { | |||
507 | format::FormatStyle Style = getFormatStyleForFile(File, Code, TFS); | |||
508 | tooling::Replacements IncludeReplaces = | |||
509 | format::sortIncludes(Style, Code, Ranges, File); | |||
510 | auto Changed = tooling::applyAllReplacements(Code, IncludeReplaces); | |||
511 | if (!Changed) | |||
512 | return CB(Changed.takeError()); | |||
513 | ||||
514 | CB(IncludeReplaces.merge(format::reformat( | |||
515 | Style, *Changed, | |||
516 | tooling::calculateRangesAfterReplacements(IncludeReplaces, Ranges), | |||
517 | File))); | |||
518 | }; | |||
519 | WorkScheduler->runQuick("Format", File, std::move(Action)); | |||
520 | } | |||
521 | ||||
522 | void ClangdServer::formatOnType(PathRef File, Position Pos, | |||
523 | StringRef TriggerText, | |||
524 | Callback<std::vector<TextEdit>> CB) { | |||
525 | auto Code = getDraft(File); | |||
526 | if (!Code) | |||
527 | return CB(llvm::make_error<LSPError>("trying to format non-added document", | |||
528 | ErrorCode::InvalidParams)); | |||
529 | llvm::Expected<size_t> CursorPos = positionToOffset(*Code, Pos); | |||
530 | if (!CursorPos) | |||
531 | return CB(CursorPos.takeError()); | |||
532 | auto Action = [File = File.str(), Code = std::move(*Code), | |||
533 | TriggerText = TriggerText.str(), CursorPos = *CursorPos, | |||
534 | CB = std::move(CB), this]() mutable { | |||
535 | auto Style = format::getStyle(format::DefaultFormatStyle, File, | |||
536 | format::DefaultFallbackStyle, Code, | |||
537 | TFS.view(/*CWD=*/std::nullopt).get()); | |||
538 | if (!Style) | |||
539 | return CB(Style.takeError()); | |||
540 | ||||
541 | std::vector<TextEdit> Result; | |||
542 | for (const tooling::Replacement &R : | |||
543 | formatIncremental(Code, CursorPos, TriggerText, *Style)) | |||
544 | Result.push_back(replacementToEdit(Code, R)); | |||
545 | return CB(Result); | |||
546 | }; | |||
547 | WorkScheduler->runQuick("FormatOnType", File, std::move(Action)); | |||
548 | } | |||
549 | ||||
550 | void ClangdServer::prepareRename(PathRef File, Position Pos, | |||
551 | std::optional<std::string> NewName, | |||
552 | const RenameOptions &RenameOpts, | |||
553 | Callback<RenameResult> CB) { | |||
554 | auto Action = [Pos, File = File.str(), CB = std::move(CB), | |||
555 | NewName = std::move(NewName), | |||
556 | RenameOpts](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
557 | if (!InpAST) | |||
558 | return CB(InpAST.takeError()); | |||
559 | // prepareRename is latency-sensitive: we don't query the index, as we | |||
560 | // only need main-file references | |||
561 | auto Results = | |||
562 | clangd::rename({Pos, NewName.value_or("__clangd_rename_placeholder"), | |||
563 | InpAST->AST, File, /*FS=*/nullptr, | |||
564 | /*Index=*/nullptr, RenameOpts}); | |||
565 | if (!Results) { | |||
566 | // LSP says to return null on failure, but that will result in a generic | |||
567 | // failure message. If we send an LSP error response, clients can surface | |||
568 | // the message to users (VSCode does). | |||
569 | return CB(Results.takeError()); | |||
570 | } | |||
571 | return CB(*Results); | |||
572 | }; | |||
573 | WorkScheduler->runWithAST("PrepareRename", File, std::move(Action)); | |||
574 | } | |||
575 | ||||
576 | void ClangdServer::rename(PathRef File, Position Pos, llvm::StringRef NewName, | |||
577 | const RenameOptions &Opts, | |||
578 | Callback<RenameResult> CB) { | |||
579 | auto Action = [File = File.str(), NewName = NewName.str(), Pos, Opts, | |||
580 | CB = std::move(CB), | |||
581 | this](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
582 | // Tracks number of files edited per invocation. | |||
583 | static constexpr trace::Metric RenameFiles("rename_files", | |||
584 | trace::Metric::Distribution); | |||
585 | if (!InpAST) | |||
586 | return CB(InpAST.takeError()); | |||
587 | auto R = clangd::rename({Pos, NewName, InpAST->AST, File, | |||
588 | DirtyFS->view(std::nullopt), Index, Opts}); | |||
589 | if (!R) | |||
590 | return CB(R.takeError()); | |||
591 | ||||
592 | if (Opts.WantFormat) { | |||
593 | auto Style = getFormatStyleForFile(File, InpAST->Inputs.Contents, | |||
594 | *InpAST->Inputs.TFS); | |||
595 | llvm::Error Err = llvm::Error::success(); | |||
596 | for (auto &E : R->GlobalChanges) | |||
597 | Err = | |||
598 | llvm::joinErrors(reformatEdit(E.getValue(), Style), std::move(Err)); | |||
599 | ||||
600 | if (Err) | |||
601 | return CB(std::move(Err)); | |||
602 | } | |||
603 | RenameFiles.record(R->GlobalChanges.size()); | |||
604 | return CB(*R); | |||
605 | }; | |||
606 | WorkScheduler->runWithAST("Rename", File, std::move(Action)); | |||
607 | } | |||
608 | ||||
609 | // May generate several candidate selections, due to SelectionTree ambiguity. | |||
610 | // vector of pointers because GCC doesn't like non-copyable Selection. | |||
611 | static llvm::Expected<std::vector<std::unique_ptr<Tweak::Selection>>> | |||
612 | tweakSelection(const Range &Sel, const InputsAndAST &AST, | |||
613 | llvm::vfs::FileSystem *FS) { | |||
614 | auto Begin = positionToOffset(AST.Inputs.Contents, Sel.start); | |||
615 | if (!Begin) | |||
616 | return Begin.takeError(); | |||
617 | auto End = positionToOffset(AST.Inputs.Contents, Sel.end); | |||
618 | if (!End) | |||
619 | return End.takeError(); | |||
620 | std::vector<std::unique_ptr<Tweak::Selection>> Result; | |||
621 | SelectionTree::createEach( | |||
622 | AST.AST.getASTContext(), AST.AST.getTokens(), *Begin, *End, | |||
623 | [&](SelectionTree T) { | |||
624 | Result.push_back(std::make_unique<Tweak::Selection>( | |||
625 | AST.Inputs.Index, AST.AST, *Begin, *End, std::move(T), FS)); | |||
626 | return false; | |||
627 | }); | |||
628 | assert(!Result.empty() && "Expected at least one SelectionTree")(static_cast <bool> (!Result.empty() && "Expected at least one SelectionTree" ) ? void (0) : __assert_fail ("!Result.empty() && \"Expected at least one SelectionTree\"" , "clang-tools-extra/clangd/ClangdServer.cpp", 628, __extension__ __PRETTY_FUNCTION__)); | |||
629 | return std::move(Result); | |||
630 | } | |||
631 | ||||
632 | void ClangdServer::enumerateTweaks( | |||
633 | PathRef File, Range Sel, llvm::unique_function<bool(const Tweak &)> Filter, | |||
634 | Callback<std::vector<TweakRef>> CB) { | |||
635 | // Tracks number of times a tweak has been offered. | |||
636 | static constexpr trace::Metric TweakAvailable( | |||
637 | "tweak_available", trace::Metric::Counter, "tweak_id"); | |||
638 | auto Action = [Sel, CB = std::move(CB), Filter = std::move(Filter), | |||
639 | FeatureModules(this->FeatureModules)]( | |||
640 | Expected<InputsAndAST> InpAST) mutable { | |||
641 | if (!InpAST) | |||
642 | return CB(InpAST.takeError()); | |||
643 | auto Selections = tweakSelection(Sel, *InpAST, /*FS=*/nullptr); | |||
644 | if (!Selections) | |||
645 | return CB(Selections.takeError()); | |||
646 | std::vector<TweakRef> Res; | |||
647 | // Don't allow a tweak to fire more than once across ambiguous selections. | |||
648 | llvm::DenseSet<llvm::StringRef> PreparedTweaks; | |||
649 | auto DeduplicatingFilter = [&](const Tweak &T) { | |||
650 | return Filter(T) && !PreparedTweaks.count(T.id()); | |||
651 | }; | |||
652 | for (const auto &Sel : *Selections) { | |||
653 | for (auto &T : prepareTweaks(*Sel, DeduplicatingFilter, FeatureModules)) { | |||
654 | Res.push_back({T->id(), T->title(), T->kind()}); | |||
655 | PreparedTweaks.insert(T->id()); | |||
656 | TweakAvailable.record(1, T->id()); | |||
657 | } | |||
658 | } | |||
659 | ||||
660 | CB(std::move(Res)); | |||
661 | }; | |||
662 | ||||
663 | WorkScheduler->runWithAST("EnumerateTweaks", File, std::move(Action), | |||
664 | Transient); | |||
665 | } | |||
666 | ||||
667 | void ClangdServer::applyTweak(PathRef File, Range Sel, StringRef TweakID, | |||
668 | Callback<Tweak::Effect> CB) { | |||
669 | // Tracks number of times a tweak has been attempted. | |||
670 | static constexpr trace::Metric TweakAttempt( | |||
671 | "tweak_attempt", trace::Metric::Counter, "tweak_id"); | |||
672 | // Tracks number of times a tweak has failed to produce edits. | |||
673 | static constexpr trace::Metric TweakFailed( | |||
674 | "tweak_failed", trace::Metric::Counter, "tweak_id"); | |||
675 | TweakAttempt.record(1, TweakID); | |||
676 | auto Action = [File = File.str(), Sel, TweakID = TweakID.str(), | |||
677 | CB = std::move(CB), | |||
678 | this](Expected<InputsAndAST> InpAST) mutable { | |||
679 | if (!InpAST) | |||
680 | return CB(InpAST.takeError()); | |||
681 | auto FS = DirtyFS->view(std::nullopt); | |||
682 | auto Selections = tweakSelection(Sel, *InpAST, FS.get()); | |||
683 | if (!Selections) | |||
684 | return CB(Selections.takeError()); | |||
685 | std::optional<llvm::Expected<Tweak::Effect>> Effect; | |||
686 | // Try each selection, take the first one that prepare()s. | |||
687 | // If they all fail, Effect will hold get the last error. | |||
688 | for (const auto &Selection : *Selections) { | |||
689 | auto T = prepareTweak(TweakID, *Selection, FeatureModules); | |||
690 | if (T) { | |||
691 | Effect = (*T)->apply(*Selection); | |||
692 | break; | |||
693 | } | |||
694 | Effect = T.takeError(); | |||
695 | } | |||
696 | assert(Effect && "Expected at least one selection")(static_cast <bool> (Effect && "Expected at least one selection" ) ? void (0) : __assert_fail ("Effect && \"Expected at least one selection\"" , "clang-tools-extra/clangd/ClangdServer.cpp", 696, __extension__ __PRETTY_FUNCTION__)); | |||
697 | if (*Effect && (*Effect)->FormatEdits) { | |||
698 | // Format tweaks that require it centrally here. | |||
699 | for (auto &It : (*Effect)->ApplyEdits) { | |||
700 | Edit &E = It.second; | |||
701 | format::FormatStyle Style = | |||
702 | getFormatStyleForFile(File, E.InitialCode, TFS); | |||
703 | if (llvm::Error Err = reformatEdit(E, Style)) | |||
704 | elog("Failed to format {0}: {1}", It.first(), std::move(Err)); | |||
705 | } | |||
706 | } else { | |||
707 | TweakFailed.record(1, TweakID); | |||
708 | } | |||
709 | return CB(std::move(*Effect)); | |||
710 | }; | |||
711 | WorkScheduler->runWithAST("ApplyTweak", File, std::move(Action)); | |||
712 | } | |||
713 | ||||
714 | void ClangdServer::locateSymbolAt(PathRef File, Position Pos, | |||
715 | Callback<std::vector<LocatedSymbol>> CB) { | |||
716 | auto Action = [Pos, CB = std::move(CB), | |||
717 | this](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
718 | if (!InpAST) | |||
719 | return CB(InpAST.takeError()); | |||
720 | CB(clangd::locateSymbolAt(InpAST->AST, Pos, Index)); | |||
721 | }; | |||
722 | ||||
723 | WorkScheduler->runWithAST("Definitions", File, std::move(Action)); | |||
724 | } | |||
725 | ||||
726 | void ClangdServer::switchSourceHeader( | |||
727 | PathRef Path, Callback<std::optional<clangd::Path>> CB) { | |||
728 | // We want to return the result as fast as possible, strategy is: | |||
729 | // 1) use the file-only heuristic, it requires some IO but it is much | |||
730 | // faster than building AST, but it only works when .h/.cc files are in | |||
731 | // the same directory. | |||
732 | // 2) if 1) fails, we use the AST&Index approach, it is slower but supports | |||
733 | // different code layout. | |||
734 | if (auto CorrespondingFile = | |||
735 | getCorrespondingHeaderOrSource(Path, TFS.view(std::nullopt))) | |||
736 | return CB(std::move(CorrespondingFile)); | |||
737 | auto Action = [Path = Path.str(), CB = std::move(CB), | |||
738 | this](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
739 | if (!InpAST) | |||
740 | return CB(InpAST.takeError()); | |||
741 | CB(getCorrespondingHeaderOrSource(Path, InpAST->AST, Index)); | |||
742 | }; | |||
743 | WorkScheduler->runWithAST("SwitchHeaderSource", Path, std::move(Action)); | |||
744 | } | |||
745 | ||||
746 | void ClangdServer::findDocumentHighlights( | |||
747 | PathRef File, Position Pos, Callback<std::vector<DocumentHighlight>> CB) { | |||
748 | auto Action = | |||
749 | [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
750 | if (!InpAST) | |||
751 | return CB(InpAST.takeError()); | |||
752 | CB(clangd::findDocumentHighlights(InpAST->AST, Pos)); | |||
753 | }; | |||
754 | ||||
755 | WorkScheduler->runWithAST("Highlights", File, std::move(Action), Transient); | |||
756 | } | |||
757 | ||||
758 | void ClangdServer::findHover(PathRef File, Position Pos, | |||
759 | Callback<std::optional<HoverInfo>> CB) { | |||
760 | auto Action = [File = File.str(), Pos, CB = std::move(CB), | |||
761 | this](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
762 | if (!InpAST) | |||
763 | return CB(InpAST.takeError()); | |||
764 | format::FormatStyle Style = getFormatStyleForFile( | |||
765 | File, InpAST->Inputs.Contents, *InpAST->Inputs.TFS); | |||
766 | CB(clangd::getHover(InpAST->AST, Pos, std::move(Style), Index)); | |||
767 | }; | |||
768 | ||||
769 | WorkScheduler->runWithAST("Hover", File, std::move(Action), Transient); | |||
770 | } | |||
771 | ||||
772 | void ClangdServer::typeHierarchy(PathRef File, Position Pos, int Resolve, | |||
773 | TypeHierarchyDirection Direction, | |||
774 | Callback<std::vector<TypeHierarchyItem>> CB) { | |||
775 | auto Action = [File = File.str(), Pos, Resolve, Direction, CB = std::move(CB), | |||
776 | this](Expected<InputsAndAST> InpAST) mutable { | |||
777 | if (!InpAST) | |||
778 | return CB(InpAST.takeError()); | |||
779 | CB(clangd::getTypeHierarchy(InpAST->AST, Pos, Resolve, Direction, Index, | |||
780 | File)); | |||
781 | }; | |||
782 | ||||
783 | WorkScheduler->runWithAST("TypeHierarchy", File, std::move(Action)); | |||
784 | } | |||
785 | ||||
786 | void ClangdServer::superTypes( | |||
787 | const TypeHierarchyItem &Item, | |||
788 | Callback<std::optional<std::vector<TypeHierarchyItem>>> CB) { | |||
789 | WorkScheduler->run("typeHierarchy/superTypes", /*Path=*/"", | |||
790 | [=, CB = std::move(CB)]() mutable { | |||
791 | CB(clangd::superTypes(Item, Index)); | |||
792 | }); | |||
793 | } | |||
794 | ||||
795 | void ClangdServer::subTypes(const TypeHierarchyItem &Item, | |||
796 | Callback<std::vector<TypeHierarchyItem>> CB) { | |||
797 | WorkScheduler->run( | |||
798 | "typeHierarchy/subTypes", /*Path=*/"", | |||
799 | [=, CB = std::move(CB)]() mutable { CB(clangd::subTypes(Item, Index)); }); | |||
800 | } | |||
801 | ||||
802 | void ClangdServer::resolveTypeHierarchy( | |||
803 | TypeHierarchyItem Item, int Resolve, TypeHierarchyDirection Direction, | |||
804 | Callback<std::optional<TypeHierarchyItem>> CB) { | |||
805 | WorkScheduler->run( | |||
806 | "Resolve Type Hierarchy", "", [=, CB = std::move(CB)]() mutable { | |||
807 | clangd::resolveTypeHierarchy(Item, Resolve, Direction, Index); | |||
808 | CB(Item); | |||
809 | }); | |||
810 | } | |||
811 | ||||
812 | void ClangdServer::prepareCallHierarchy( | |||
813 | PathRef File, Position Pos, Callback<std::vector<CallHierarchyItem>> CB) { | |||
814 | auto Action = [File = File.str(), Pos, | |||
815 | CB = std::move(CB)](Expected<InputsAndAST> InpAST) mutable { | |||
816 | if (!InpAST) | |||
817 | return CB(InpAST.takeError()); | |||
818 | CB(clangd::prepareCallHierarchy(InpAST->AST, Pos, File)); | |||
819 | }; | |||
820 | WorkScheduler->runWithAST("CallHierarchy", File, std::move(Action)); | |||
821 | } | |||
822 | ||||
823 | void ClangdServer::incomingCalls( | |||
824 | const CallHierarchyItem &Item, | |||
825 | Callback<std::vector<CallHierarchyIncomingCall>> CB) { | |||
826 | WorkScheduler->run("Incoming Calls", "", | |||
827 | [CB = std::move(CB), Item, this]() mutable { | |||
828 | CB(clangd::incomingCalls(Item, Index)); | |||
829 | }); | |||
830 | } | |||
831 | ||||
832 | void ClangdServer::inlayHints(PathRef File, std::optional<Range> RestrictRange, | |||
833 | Callback<std::vector<InlayHint>> CB) { | |||
834 | auto Action = [RestrictRange(std::move(RestrictRange)), | |||
835 | CB = std::move(CB)](Expected<InputsAndAST> InpAST) mutable { | |||
836 | if (!InpAST) | |||
837 | return CB(InpAST.takeError()); | |||
838 | CB(clangd::inlayHints(InpAST->AST, std::move(RestrictRange))); | |||
839 | }; | |||
840 | WorkScheduler->runWithAST("InlayHints", File, std::move(Action), Transient); | |||
841 | } | |||
842 | ||||
843 | void ClangdServer::onFileEvent(const DidChangeWatchedFilesParams &Params) { | |||
844 | // FIXME: Do nothing for now. This will be used for indexing and potentially | |||
845 | // invalidating other caches. | |||
846 | } | |||
847 | ||||
848 | void ClangdServer::workspaceSymbols( | |||
849 | llvm::StringRef Query, int Limit, | |||
850 | Callback<std::vector<SymbolInformation>> CB) { | |||
851 | WorkScheduler->run( | |||
852 | "getWorkspaceSymbols", /*Path=*/"", | |||
853 | [Query = Query.str(), Limit, CB = std::move(CB), this]() mutable { | |||
854 | CB(clangd::getWorkspaceSymbols(Query, Limit, Index, | |||
855 | WorkspaceRoot.value_or(""))); | |||
856 | }); | |||
857 | } | |||
858 | ||||
859 | void ClangdServer::documentSymbols(llvm::StringRef File, | |||
860 | Callback<std::vector<DocumentSymbol>> CB) { | |||
861 | auto Action = | |||
862 | [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
863 | if (!InpAST) | |||
864 | return CB(InpAST.takeError()); | |||
865 | CB(clangd::getDocumentSymbols(InpAST->AST)); | |||
866 | }; | |||
867 | WorkScheduler->runWithAST("DocumentSymbols", File, std::move(Action), | |||
868 | Transient); | |||
869 | } | |||
870 | ||||
871 | void ClangdServer::foldingRanges(llvm::StringRef File, | |||
872 | Callback<std::vector<FoldingRange>> CB) { | |||
873 | auto Code = getDraft(File); | |||
874 | if (!Code) | |||
875 | return CB(llvm::make_error<LSPError>( | |||
876 | "trying to compute folding ranges for non-added document", | |||
877 | ErrorCode::InvalidParams)); | |||
878 | auto Action = [LineFoldingOnly = LineFoldingOnly, CB = std::move(CB), | |||
879 | Code = std::move(*Code)]() mutable { | |||
880 | CB(clangd::getFoldingRanges(Code, LineFoldingOnly)); | |||
881 | }; | |||
882 | // We want to make sure folding ranges are always available for all the open | |||
883 | // files, hence prefer runQuick to not wait for operations on other files. | |||
884 | WorkScheduler->runQuick("FoldingRanges", File, std::move(Action)); | |||
885 | } | |||
886 | ||||
887 | void ClangdServer::findType(llvm::StringRef File, Position Pos, | |||
888 | Callback<std::vector<LocatedSymbol>> CB) { | |||
889 | auto Action = | |||
890 | [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
891 | if (!InpAST) | |||
892 | return CB(InpAST.takeError()); | |||
893 | CB(clangd::findType(InpAST->AST, Pos)); | |||
894 | }; | |||
895 | WorkScheduler->runWithAST("FindType", File, std::move(Action)); | |||
896 | } | |||
897 | ||||
898 | void ClangdServer::findImplementations( | |||
899 | PathRef File, Position Pos, Callback<std::vector<LocatedSymbol>> CB) { | |||
900 | auto Action = [Pos, CB = std::move(CB), | |||
901 | this](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
902 | if (!InpAST) | |||
903 | return CB(InpAST.takeError()); | |||
904 | CB(clangd::findImplementations(InpAST->AST, Pos, Index)); | |||
905 | }; | |||
906 | ||||
907 | WorkScheduler->runWithAST("Implementations", File, std::move(Action)); | |||
908 | } | |||
909 | ||||
910 | void ClangdServer::findReferences(PathRef File, Position Pos, uint32_t Limit, | |||
911 | bool AddContainer, | |||
912 | Callback<ReferencesResult> CB) { | |||
913 | auto Action = [Pos, Limit, AddContainer, CB = std::move(CB), | |||
914 | this](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
915 | if (!InpAST) | |||
916 | return CB(InpAST.takeError()); | |||
917 | CB(clangd::findReferences(InpAST->AST, Pos, Limit, Index, AddContainer)); | |||
918 | }; | |||
919 | ||||
920 | WorkScheduler->runWithAST("References", File, std::move(Action)); | |||
921 | } | |||
922 | ||||
923 | void ClangdServer::symbolInfo(PathRef File, Position Pos, | |||
924 | Callback<std::vector<SymbolDetails>> CB) { | |||
925 | auto Action = | |||
926 | [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
927 | if (!InpAST) | |||
928 | return CB(InpAST.takeError()); | |||
929 | CB(clangd::getSymbolInfo(InpAST->AST, Pos)); | |||
930 | }; | |||
931 | ||||
932 | WorkScheduler->runWithAST("SymbolInfo", File, std::move(Action)); | |||
933 | } | |||
934 | ||||
935 | void ClangdServer::semanticRanges(PathRef File, | |||
936 | const std::vector<Position> &Positions, | |||
937 | Callback<std::vector<SelectionRange>> CB) { | |||
938 | auto Action = [Positions, CB = std::move(CB)]( | |||
939 | llvm::Expected<InputsAndAST> InpAST) mutable { | |||
940 | if (!InpAST) | |||
941 | return CB(InpAST.takeError()); | |||
942 | std::vector<SelectionRange> Result; | |||
943 | for (const auto &Pos : Positions) { | |||
944 | if (auto Range = clangd::getSemanticRanges(InpAST->AST, Pos)) | |||
945 | Result.push_back(std::move(*Range)); | |||
946 | else | |||
947 | return CB(Range.takeError()); | |||
948 | } | |||
949 | CB(std::move(Result)); | |||
950 | }; | |||
951 | WorkScheduler->runWithAST("SemanticRanges", File, std::move(Action)); | |||
952 | } | |||
953 | ||||
954 | void ClangdServer::documentLinks(PathRef File, | |||
955 | Callback<std::vector<DocumentLink>> CB) { | |||
956 | auto Action = | |||
957 | [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
958 | if (!InpAST) | |||
959 | return CB(InpAST.takeError()); | |||
960 | CB(clangd::getDocumentLinks(InpAST->AST)); | |||
961 | }; | |||
962 | WorkScheduler->runWithAST("DocumentLinks", File, std::move(Action), | |||
963 | Transient); | |||
964 | } | |||
965 | ||||
966 | void ClangdServer::semanticHighlights( | |||
967 | PathRef File, Callback<std::vector<HighlightingToken>> CB) { | |||
968 | ||||
969 | auto Action = [CB = std::move(CB), | |||
970 | PublishInactiveRegions = PublishInactiveRegions]( | |||
971 | llvm::Expected<InputsAndAST> InpAST) mutable { | |||
972 | if (!InpAST) | |||
973 | return CB(InpAST.takeError()); | |||
974 | // Include inactive regions in semantic highlighting tokens only if the | |||
975 | // client doesn't support a dedicated protocol for being informed about | |||
976 | // them. | |||
977 | CB(clangd::getSemanticHighlightings(InpAST->AST, !PublishInactiveRegions)); | |||
978 | }; | |||
979 | WorkScheduler->runWithAST("SemanticHighlights", File, std::move(Action), | |||
980 | Transient); | |||
981 | } | |||
982 | ||||
983 | void ClangdServer::getAST(PathRef File, std::optional<Range> R, | |||
984 | Callback<std::optional<ASTNode>> CB) { | |||
985 | auto Action = | |||
986 | [R, CB(std::move(CB))](llvm::Expected<InputsAndAST> Inputs) mutable { | |||
987 | if (!Inputs) | |||
988 | return CB(Inputs.takeError()); | |||
989 | if (!R) { | |||
990 | // It's safe to pass in the TU, as dumpAST() does not | |||
991 | // deserialize the preamble. | |||
992 | auto Node = DynTypedNode::create( | |||
993 | *Inputs->AST.getASTContext().getTranslationUnitDecl()); | |||
994 | return CB(dumpAST(Node, Inputs->AST.getTokens(), | |||
995 | Inputs->AST.getASTContext())); | |||
996 | } | |||
997 | unsigned Start, End; | |||
998 | if (auto Offset = positionToOffset(Inputs->Inputs.Contents, R->start)) | |||
999 | Start = *Offset; | |||
1000 | else | |||
1001 | return CB(Offset.takeError()); | |||
1002 | if (auto Offset = positionToOffset(Inputs->Inputs.Contents, R->end)) | |||
1003 | End = *Offset; | |||
1004 | else | |||
1005 | return CB(Offset.takeError()); | |||
1006 | bool Success = SelectionTree::createEach( | |||
1007 | Inputs->AST.getASTContext(), Inputs->AST.getTokens(), Start, End, | |||
1008 | [&](SelectionTree T) { | |||
1009 | if (const SelectionTree::Node *N = T.commonAncestor()) { | |||
1010 | CB(dumpAST(N->ASTNode, Inputs->AST.getTokens(), | |||
1011 | Inputs->AST.getASTContext())); | |||
1012 | return true; | |||
1013 | } | |||
1014 | return false; | |||
1015 | }); | |||
1016 | if (!Success) | |||
1017 | CB(std::nullopt); | |||
1018 | }; | |||
1019 | WorkScheduler->runWithAST("GetAST", File, std::move(Action)); | |||
1020 | } | |||
1021 | ||||
1022 | void ClangdServer::customAction(PathRef File, llvm::StringRef Name, | |||
1023 | Callback<InputsAndAST> Action) { | |||
1024 | WorkScheduler->runWithAST(Name, File, std::move(Action)); | |||
1025 | } | |||
1026 | ||||
1027 | void ClangdServer::diagnostics(PathRef File, Callback<std::vector<Diag>> CB) { | |||
1028 | auto Action = | |||
1029 | [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable { | |||
1030 | if (!InpAST) | |||
1031 | return CB(InpAST.takeError()); | |||
1032 | if (auto Diags = InpAST->AST.getDiagnostics()) | |||
1033 | return CB(*Diags); | |||
1034 | // FIXME: Use ServerCancelled error once it is settled in LSP-3.17. | |||
1035 | return CB(llvm::make_error<LSPError>("server is busy parsing includes", | |||
1036 | ErrorCode::InternalError)); | |||
1037 | }; | |||
1038 | ||||
1039 | WorkScheduler->runWithAST("Diagnostics", File, std::move(Action)); | |||
1040 | } | |||
1041 | ||||
1042 | llvm::StringMap<TUScheduler::FileStats> ClangdServer::fileStats() const { | |||
1043 | return WorkScheduler->fileStats(); | |||
1044 | } | |||
1045 | ||||
1046 | [[nodiscard]] bool | |||
1047 | ClangdServer::blockUntilIdleForTest(std::optional<double> TimeoutSeconds) { | |||
1048 | // Order is important here: we don't want to block on A and then B, | |||
1049 | // if B might schedule work on A. | |||
1050 | ||||
1051 | #if defined(__has_feature)0 && \ | |||
1052 | (__has_feature(address_sanitizer)0 || __has_feature(hwaddress_sanitizer)0 || \ | |||
1053 | __has_feature(memory_sanitizer)0 || __has_feature(thread_sanitizer)0) | |||
1054 | (*TimeoutSeconds) *= 10; | |||
1055 | #endif | |||
1056 | ||||
1057 | // Nothing else can schedule work on TUScheduler, because it's not threadsafe | |||
1058 | // and we're blocking the main thread. | |||
1059 | if (!WorkScheduler->blockUntilIdle(timeoutSeconds(TimeoutSeconds))) | |||
1060 | return false; | |||
1061 | // TUScheduler is the only thing that starts background indexing work. | |||
1062 | if (IndexTasks && !IndexTasks->wait(timeoutSeconds(TimeoutSeconds))) | |||
1063 | return false; | |||
1064 | ||||
1065 | // Unfortunately we don't have strict topological order between the rest of | |||
1066 | // the components. E.g. CDB broadcast triggers backrgound indexing. | |||
1067 | // This queries the CDB which may discover new work if disk has changed. | |||
1068 | // | |||
1069 | // So try each one a few times in a loop. | |||
1070 | // If there are no tricky interactions then all after the first are no-ops. | |||
1071 | // Then on the last iteration, verify they're idle without waiting. | |||
1072 | // | |||
1073 | // There's a small chance they're juggling work and we didn't catch them :-( | |||
1074 | for (std::optional<double> Timeout : | |||
1075 | {TimeoutSeconds, TimeoutSeconds, std::optional<double>(0)}) { | |||
1076 | if (!CDB.blockUntilIdle(timeoutSeconds(Timeout))) | |||
1077 | return false; | |||
1078 | if (BackgroundIdx && !BackgroundIdx->blockUntilIdleForTest(Timeout)) | |||
1079 | return false; | |||
1080 | if (FeatureModules && llvm::any_of(*FeatureModules, [&](FeatureModule &M) { | |||
1081 | return !M.blockUntilIdle(timeoutSeconds(Timeout)); | |||
1082 | })) | |||
1083 | return false; | |||
1084 | } | |||
1085 | ||||
1086 | assert(WorkScheduler->blockUntilIdle(Deadline::zero()) &&(static_cast <bool> (WorkScheduler->blockUntilIdle(Deadline ::zero()) && "Something scheduled work while we're blocking the main thread!" ) ? void (0) : __assert_fail ("WorkScheduler->blockUntilIdle(Deadline::zero()) && \"Something scheduled work while we're blocking the main thread!\"" , "clang-tools-extra/clangd/ClangdServer.cpp", 1087, __extension__ __PRETTY_FUNCTION__)) | |||
1087 | "Something scheduled work while we're blocking the main thread!")(static_cast <bool> (WorkScheduler->blockUntilIdle(Deadline ::zero()) && "Something scheduled work while we're blocking the main thread!" ) ? void (0) : __assert_fail ("WorkScheduler->blockUntilIdle(Deadline::zero()) && \"Something scheduled work while we're blocking the main thread!\"" , "clang-tools-extra/clangd/ClangdServer.cpp", 1087, __extension__ __PRETTY_FUNCTION__)); | |||
1088 | return true; | |||
1089 | } | |||
1090 | ||||
1091 | void ClangdServer::profile(MemoryTree &MT) const { | |||
1092 | if (DynamicIdx) | |||
1093 | DynamicIdx->profile(MT.child("dynamic_index")); | |||
1094 | if (BackgroundIdx) | |||
1095 | BackgroundIdx->profile(MT.child("background_index")); | |||
1096 | WorkScheduler->profile(MT.child("tuscheduler")); | |||
1097 | } | |||
1098 | } // namespace clangd | |||
1099 | } // namespace clang |
1 | // unique_ptr implementation -*- C++ -*- |
2 | |
3 | // Copyright (C) 2008-2020 Free Software Foundation, Inc. |
4 | // |
5 | // This file is part of the GNU ISO C++ Library. This library is free |
6 | // software; you can redistribute it and/or modify it under the |
7 | // terms of the GNU General Public License as published by the |
8 | // Free Software Foundation; either version 3, or (at your option) |
9 | // any later version. |
10 | |
11 | // This library is distributed in the hope that it will be useful, |
12 | // but WITHOUT ANY WARRANTY; without even the implied warranty of |
13 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
14 | // GNU General Public License for more details. |
15 | |
16 | // Under Section 7 of GPL version 3, you are granted additional |
17 | // permissions described in the GCC Runtime Library Exception, version |
18 | // 3.1, as published by the Free Software Foundation. |
19 | |
20 | // You should have received a copy of the GNU General Public License and |
21 | // a copy of the GCC Runtime Library Exception along with this program; |
22 | // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see |
23 | // <http://www.gnu.org/licenses/>. |
24 | |
25 | /** @file bits/unique_ptr.h |
26 | * This is an internal header file, included by other library headers. |
27 | * Do not attempt to use it directly. @headername{memory} |
28 | */ |
29 | |
30 | #ifndef _UNIQUE_PTR_H1 |
31 | #define _UNIQUE_PTR_H1 1 |
32 | |
33 | #include <bits/c++config.h> |
34 | #include <debug/assertions.h> |
35 | #include <type_traits> |
36 | #include <utility> |
37 | #include <tuple> |
38 | #include <bits/stl_function.h> |
39 | #include <bits/functional_hash.h> |
40 | #if __cplusplus201703L > 201703L |
41 | # include <compare> |
42 | # include <ostream> |
43 | #endif |
44 | |
45 | namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default"))) |
46 | { |
47 | _GLIBCXX_BEGIN_NAMESPACE_VERSION |
48 | |
49 | /** |
50 | * @addtogroup pointer_abstractions |
51 | * @{ |
52 | */ |
53 | |
54 | #if _GLIBCXX_USE_DEPRECATED1 |
55 | #pragma GCC diagnostic push |
56 | #pragma GCC diagnostic ignored "-Wdeprecated-declarations" |
57 | template<typename> class auto_ptr; |
58 | #pragma GCC diagnostic pop |
59 | #endif |
60 | |
61 | /// Primary template of default_delete, used by unique_ptr for single objects |
62 | template<typename _Tp> |
63 | struct default_delete |
64 | { |
65 | /// Default constructor |
66 | constexpr default_delete() noexcept = default; |
67 | |
68 | /** @brief Converting constructor. |
69 | * |
70 | * Allows conversion from a deleter for objects of another type, `_Up`, |
71 | * only if `_Up*` is convertible to `_Tp*`. |
72 | */ |
73 | template<typename _Up, |
74 | typename = _Require<is_convertible<_Up*, _Tp*>>> |
75 | default_delete(const default_delete<_Up>&) noexcept { } |
76 | |
77 | /// Calls `delete __ptr` |
78 | void |
79 | operator()(_Tp* __ptr) const |
80 | { |
81 | static_assert(!is_void<_Tp>::value, |
82 | "can't delete pointer to incomplete type"); |
83 | static_assert(sizeof(_Tp)>0, |
84 | "can't delete pointer to incomplete type"); |
85 | delete __ptr; |
86 | } |
87 | }; |
88 | |
89 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
90 | // DR 740 - omit specialization for array objects with a compile time length |
91 | |
92 | /// Specialization of default_delete for arrays, used by `unique_ptr<T[]>` |
93 | template<typename _Tp> |
94 | struct default_delete<_Tp[]> |
95 | { |
96 | public: |
97 | /// Default constructor |
98 | constexpr default_delete() noexcept = default; |
99 | |
100 | /** @brief Converting constructor. |
101 | * |
102 | * Allows conversion from a deleter for arrays of another type, such as |
103 | * a const-qualified version of `_Tp`. |
104 | * |
105 | * Conversions from types derived from `_Tp` are not allowed because |
106 | * it is undefined to `delete[]` an array of derived types through a |
107 | * pointer to the base type. |
108 | */ |
109 | template<typename _Up, |
110 | typename = _Require<is_convertible<_Up(*)[], _Tp(*)[]>>> |
111 | default_delete(const default_delete<_Up[]>&) noexcept { } |
112 | |
113 | /// Calls `delete[] __ptr` |
114 | template<typename _Up> |
115 | typename enable_if<is_convertible<_Up(*)[], _Tp(*)[]>::value>::type |
116 | operator()(_Up* __ptr) const |
117 | { |
118 | static_assert(sizeof(_Tp)>0, |
119 | "can't delete pointer to incomplete type"); |
120 | delete [] __ptr; |
121 | } |
122 | }; |
123 | |
124 | /// @cond undocumented |
125 | |
126 | // Manages the pointer and deleter of a unique_ptr |
127 | template <typename _Tp, typename _Dp> |
128 | class __uniq_ptr_impl |
129 | { |
130 | template <typename _Up, typename _Ep, typename = void> |
131 | struct _Ptr |
132 | { |
133 | using type = _Up*; |
134 | }; |
135 | |
136 | template <typename _Up, typename _Ep> |
137 | struct |
138 | _Ptr<_Up, _Ep, __void_t<typename remove_reference<_Ep>::type::pointer>> |
139 | { |
140 | using type = typename remove_reference<_Ep>::type::pointer; |
141 | }; |
142 | |
143 | public: |
144 | using _DeleterConstraint = enable_if< |
145 | __and_<__not_<is_pointer<_Dp>>, |
146 | is_default_constructible<_Dp>>::value>; |
147 | |
148 | using pointer = typename _Ptr<_Tp, _Dp>::type; |
149 | |
150 | static_assert( !is_rvalue_reference<_Dp>::value, |
151 | "unique_ptr's deleter type must be a function object type" |
152 | " or an lvalue reference type" ); |
153 | |
154 | __uniq_ptr_impl() = default; |
155 | __uniq_ptr_impl(pointer __p) : _M_t() { _M_ptr() = __p; } |
156 | |
157 | template<typename _Del> |
158 | __uniq_ptr_impl(pointer __p, _Del&& __d) |
159 | : _M_t(__p, std::forward<_Del>(__d)) { } |
160 | |
161 | __uniq_ptr_impl(__uniq_ptr_impl&& __u) noexcept |
162 | : _M_t(std::move(__u._M_t)) |
163 | { __u._M_ptr() = nullptr; } |
164 | |
165 | __uniq_ptr_impl& operator=(__uniq_ptr_impl&& __u) noexcept |
166 | { |
167 | reset(__u.release()); |
168 | _M_deleter() = std::forward<_Dp>(__u._M_deleter()); |
169 | return *this; |
170 | } |
171 | |
172 | pointer& _M_ptr() { return std::get<0>(_M_t); } |
173 | pointer _M_ptr() const { return std::get<0>(_M_t); } |
174 | _Dp& _M_deleter() { return std::get<1>(_M_t); } |
175 | const _Dp& _M_deleter() const { return std::get<1>(_M_t); } |
176 | |
177 | void reset(pointer __p) noexcept |
178 | { |
179 | const pointer __old_p = _M_ptr(); |
180 | _M_ptr() = __p; |
181 | if (__old_p) |
182 | _M_deleter()(__old_p); |
183 | } |
184 | |
185 | pointer release() noexcept |
186 | { |
187 | pointer __p = _M_ptr(); |
188 | _M_ptr() = nullptr; |
189 | return __p; |
190 | } |
191 | |
192 | void |
193 | swap(__uniq_ptr_impl& __rhs) noexcept |
194 | { |
195 | using std::swap; |
196 | swap(this->_M_ptr(), __rhs._M_ptr()); |
197 | swap(this->_M_deleter(), __rhs._M_deleter()); |
198 | } |
199 | |
200 | private: |
201 | tuple<pointer, _Dp> _M_t; |
202 | }; |
203 | |
204 | // Defines move construction + assignment as either defaulted or deleted. |
205 | template <typename _Tp, typename _Dp, |
206 | bool = is_move_constructible<_Dp>::value, |
207 | bool = is_move_assignable<_Dp>::value> |
208 | struct __uniq_ptr_data : __uniq_ptr_impl<_Tp, _Dp> |
209 | { |
210 | using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl; |
211 | __uniq_ptr_data(__uniq_ptr_data&&) = default; |
212 | __uniq_ptr_data& operator=(__uniq_ptr_data&&) = default; |
213 | }; |
214 | |
215 | template <typename _Tp, typename _Dp> |
216 | struct __uniq_ptr_data<_Tp, _Dp, true, false> : __uniq_ptr_impl<_Tp, _Dp> |
217 | { |
218 | using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl; |
219 | __uniq_ptr_data(__uniq_ptr_data&&) = default; |
220 | __uniq_ptr_data& operator=(__uniq_ptr_data&&) = delete; |
221 | }; |
222 | |
223 | template <typename _Tp, typename _Dp> |
224 | struct __uniq_ptr_data<_Tp, _Dp, false, true> : __uniq_ptr_impl<_Tp, _Dp> |
225 | { |
226 | using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl; |
227 | __uniq_ptr_data(__uniq_ptr_data&&) = delete; |
228 | __uniq_ptr_data& operator=(__uniq_ptr_data&&) = default; |
229 | }; |
230 | |
231 | template <typename _Tp, typename _Dp> |
232 | struct __uniq_ptr_data<_Tp, _Dp, false, false> : __uniq_ptr_impl<_Tp, _Dp> |
233 | { |
234 | using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl; |
235 | __uniq_ptr_data(__uniq_ptr_data&&) = delete; |
236 | __uniq_ptr_data& operator=(__uniq_ptr_data&&) = delete; |
237 | }; |
238 | /// @endcond |
239 | |
240 | /// 20.7.1.2 unique_ptr for single objects. |
241 | template <typename _Tp, typename _Dp = default_delete<_Tp>> |
242 | class unique_ptr |
243 | { |
244 | template <typename _Up> |
245 | using _DeleterConstraint = |
246 | typename __uniq_ptr_impl<_Tp, _Up>::_DeleterConstraint::type; |
247 | |
248 | __uniq_ptr_data<_Tp, _Dp> _M_t; |
249 | |
250 | public: |
251 | using pointer = typename __uniq_ptr_impl<_Tp, _Dp>::pointer; |
252 | using element_type = _Tp; |
253 | using deleter_type = _Dp; |
254 | |
255 | private: |
256 | // helper template for detecting a safe conversion from another |
257 | // unique_ptr |
258 | template<typename _Up, typename _Ep> |
259 | using __safe_conversion_up = __and_< |
260 | is_convertible<typename unique_ptr<_Up, _Ep>::pointer, pointer>, |
261 | __not_<is_array<_Up>> |
262 | >; |
263 | |
264 | public: |
265 | // Constructors. |
266 | |
267 | /// Default constructor, creates a unique_ptr that owns nothing. |
268 | template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>> |
269 | constexpr unique_ptr() noexcept |
270 | : _M_t() |
271 | { } |
272 | |
273 | /** Takes ownership of a pointer. |
274 | * |
275 | * @param __p A pointer to an object of @c element_type |
276 | * |
277 | * The deleter will be value-initialized. |
278 | */ |
279 | template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>> |
280 | explicit |
281 | unique_ptr(pointer __p) noexcept |
282 | : _M_t(__p) |
283 | { } |
284 | |
285 | /** Takes ownership of a pointer. |
286 | * |
287 | * @param __p A pointer to an object of @c element_type |
288 | * @param __d A reference to a deleter. |
289 | * |
290 | * The deleter will be initialized with @p __d |
291 | */ |
292 | template<typename _Del = deleter_type, |
293 | typename = _Require<is_copy_constructible<_Del>>> |
294 | unique_ptr(pointer __p, const deleter_type& __d) noexcept |
295 | : _M_t(__p, __d) { } |
296 | |
297 | /** Takes ownership of a pointer. |
298 | * |
299 | * @param __p A pointer to an object of @c element_type |
300 | * @param __d An rvalue reference to a (non-reference) deleter. |
301 | * |
302 | * The deleter will be initialized with @p std::move(__d) |
303 | */ |
304 | template<typename _Del = deleter_type, |
305 | typename = _Require<is_move_constructible<_Del>>> |
306 | unique_ptr(pointer __p, |
307 | __enable_if_t<!is_lvalue_reference<_Del>::value, |
308 | _Del&&> __d) noexcept |
309 | : _M_t(__p, std::move(__d)) |
310 | { } |
311 | |
312 | template<typename _Del = deleter_type, |
313 | typename _DelUnref = typename remove_reference<_Del>::type> |
314 | unique_ptr(pointer, |
315 | __enable_if_t<is_lvalue_reference<_Del>::value, |
316 | _DelUnref&&>) = delete; |
317 | |
318 | /// Creates a unique_ptr that owns nothing. |
319 | template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>> |
320 | constexpr unique_ptr(nullptr_t) noexcept |
321 | : _M_t() |
322 | { } |
323 | |
324 | // Move constructors. |
325 | |
326 | /// Move constructor. |
327 | unique_ptr(unique_ptr&&) = default; |
328 | |
329 | /** @brief Converting constructor from another type |
330 | * |
331 | * Requires that the pointer owned by @p __u is convertible to the |
332 | * type of pointer owned by this object, @p __u does not own an array, |
333 | * and @p __u has a compatible deleter type. |
334 | */ |
335 | template<typename _Up, typename _Ep, typename = _Require< |
336 | __safe_conversion_up<_Up, _Ep>, |
337 | typename conditional<is_reference<_Dp>::value, |
338 | is_same<_Ep, _Dp>, |
339 | is_convertible<_Ep, _Dp>>::type>> |
340 | unique_ptr(unique_ptr<_Up, _Ep>&& __u) noexcept |
341 | : _M_t(__u.release(), std::forward<_Ep>(__u.get_deleter())) |
342 | { } |
343 | |
344 | #if _GLIBCXX_USE_DEPRECATED1 |
345 | #pragma GCC diagnostic push |
346 | #pragma GCC diagnostic ignored "-Wdeprecated-declarations" |
347 | /// Converting constructor from @c auto_ptr |
348 | template<typename _Up, typename = _Require< |
349 | is_convertible<_Up*, _Tp*>, is_same<_Dp, default_delete<_Tp>>>> |
350 | unique_ptr(auto_ptr<_Up>&& __u) noexcept; |
351 | #pragma GCC diagnostic pop |
352 | #endif |
353 | |
354 | /// Destructor, invokes the deleter if the stored pointer is not null. |
355 | ~unique_ptr() noexcept |
356 | { |
357 | static_assert(__is_invocable<deleter_type&, pointer>::value, |
358 | "unique_ptr's deleter must be invocable with a pointer"); |
359 | auto& __ptr = _M_t._M_ptr(); |
360 | if (__ptr != nullptr) |
361 | get_deleter()(std::move(__ptr)); |
362 | __ptr = pointer(); |
363 | } |
364 | |
365 | // Assignment. |
366 | |
367 | /** @brief Move assignment operator. |
368 | * |
369 | * Invokes the deleter if this object owns a pointer. |
370 | */ |
371 | unique_ptr& operator=(unique_ptr&&) = default; |
372 | |
373 | /** @brief Assignment from another type. |
374 | * |
375 | * @param __u The object to transfer ownership from, which owns a |
376 | * convertible pointer to a non-array object. |
377 | * |
378 | * Invokes the deleter if this object owns a pointer. |
379 | */ |
380 | template<typename _Up, typename _Ep> |
381 | typename enable_if< __and_< |
382 | __safe_conversion_up<_Up, _Ep>, |
383 | is_assignable<deleter_type&, _Ep&&> |
384 | >::value, |
385 | unique_ptr&>::type |
386 | operator=(unique_ptr<_Up, _Ep>&& __u) noexcept |
387 | { |
388 | reset(__u.release()); |
389 | get_deleter() = std::forward<_Ep>(__u.get_deleter()); |
390 | return *this; |
391 | } |
392 | |
393 | /// Reset the %unique_ptr to empty, invoking the deleter if necessary. |
394 | unique_ptr& |
395 | operator=(nullptr_t) noexcept |
396 | { |
397 | reset(); |
398 | return *this; |
399 | } |
400 | |
401 | // Observers. |
402 | |
403 | /// Dereference the stored pointer. |
404 | typename add_lvalue_reference<element_type>::type |
405 | operator*() const |
406 | { |
407 | __glibcxx_assert(get() != pointer())do { if (! (get() != pointer())) std::__replacement_assert("/usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/bits/unique_ptr.h" , 407, __PRETTY_FUNCTION__, "get() != pointer()"); } while (false ); |
408 | return *get(); |
409 | } |
410 | |
411 | /// Return the stored pointer. |
412 | pointer |
413 | operator->() const noexcept |
414 | { |
415 | _GLIBCXX_DEBUG_PEDASSERT(get() != pointer()); |
416 | return get(); |
417 | } |
418 | |
419 | /// Return the stored pointer. |
420 | pointer |
421 | get() const noexcept |
422 | { return _M_t._M_ptr(); } |
423 | |
424 | /// Return a reference to the stored deleter. |
425 | deleter_type& |
426 | get_deleter() noexcept |
427 | { return _M_t._M_deleter(); } |
428 | |
429 | /// Return a reference to the stored deleter. |
430 | const deleter_type& |
431 | get_deleter() const noexcept |
432 | { return _M_t._M_deleter(); } |
433 | |
434 | /// Return @c true if the stored pointer is not null. |
435 | explicit operator bool() const noexcept |
436 | { return get() == pointer() ? false : true; } |
437 | |
438 | // Modifiers. |
439 | |
440 | /// Release ownership of any stored pointer. |
441 | pointer |
442 | release() noexcept |
443 | { return _M_t.release(); } |
444 | |
445 | /** @brief Replace the stored pointer. |
446 | * |
447 | * @param __p The new pointer to store. |
448 | * |
449 | * The deleter will be invoked if a pointer is already owned. |
450 | */ |
451 | void |
452 | reset(pointer __p = pointer()) noexcept |
453 | { |
454 | static_assert(__is_invocable<deleter_type&, pointer>::value, |
455 | "unique_ptr's deleter must be invocable with a pointer"); |
456 | _M_t.reset(std::move(__p)); |
457 | } |
458 | |
459 | /// Exchange the pointer and deleter with another object. |
460 | void |
461 | swap(unique_ptr& __u) noexcept |
462 | { |
463 | static_assert(__is_swappable<_Dp>::value, "deleter must be swappable"); |
464 | _M_t.swap(__u._M_t); |
465 | } |
466 | |
467 | // Disable copy from lvalue. |
468 | unique_ptr(const unique_ptr&) = delete; |
469 | unique_ptr& operator=(const unique_ptr&) = delete; |
470 | }; |
471 | |
472 | /// 20.7.1.3 unique_ptr for array objects with a runtime length |
473 | // [unique.ptr.runtime] |
474 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
475 | // DR 740 - omit specialization for array objects with a compile time length |
476 | template<typename _Tp, typename _Dp> |
477 | class unique_ptr<_Tp[], _Dp> |
478 | { |
479 | template <typename _Up> |
480 | using _DeleterConstraint = |
481 | typename __uniq_ptr_impl<_Tp, _Up>::_DeleterConstraint::type; |
482 | |
483 | __uniq_ptr_data<_Tp, _Dp> _M_t; |
484 | |
485 | template<typename _Up> |
486 | using __remove_cv = typename remove_cv<_Up>::type; |
487 | |
488 | // like is_base_of<_Tp, _Up> but false if unqualified types are the same |
489 | template<typename _Up> |
490 | using __is_derived_Tp |
491 | = __and_< is_base_of<_Tp, _Up>, |
492 | __not_<is_same<__remove_cv<_Tp>, __remove_cv<_Up>>> >; |
493 | |
494 | public: |
495 | using pointer = typename __uniq_ptr_impl<_Tp, _Dp>::pointer; |
496 | using element_type = _Tp; |
497 | using deleter_type = _Dp; |
498 | |
499 | // helper template for detecting a safe conversion from another |
500 | // unique_ptr |
501 | template<typename _Up, typename _Ep, |
502 | typename _UPtr = unique_ptr<_Up, _Ep>, |
503 | typename _UP_pointer = typename _UPtr::pointer, |
504 | typename _UP_element_type = typename _UPtr::element_type> |
505 | using __safe_conversion_up = __and_< |
506 | is_array<_Up>, |
507 | is_same<pointer, element_type*>, |
508 | is_same<_UP_pointer, _UP_element_type*>, |
509 | is_convertible<_UP_element_type(*)[], element_type(*)[]> |
510 | >; |
511 | |
512 | // helper template for detecting a safe conversion from a raw pointer |
513 | template<typename _Up> |
514 | using __safe_conversion_raw = __and_< |
515 | __or_<__or_<is_same<_Up, pointer>, |
516 | is_same<_Up, nullptr_t>>, |
517 | __and_<is_pointer<_Up>, |
518 | is_same<pointer, element_type*>, |
519 | is_convertible< |
520 | typename remove_pointer<_Up>::type(*)[], |
521 | element_type(*)[]> |
522 | > |
523 | > |
524 | >; |
525 | |
526 | // Constructors. |
527 | |
528 | /// Default constructor, creates a unique_ptr that owns nothing. |
529 | template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>> |
530 | constexpr unique_ptr() noexcept |
531 | : _M_t() |
532 | { } |
533 | |
534 | /** Takes ownership of a pointer. |
535 | * |
536 | * @param __p A pointer to an array of a type safely convertible |
537 | * to an array of @c element_type |
538 | * |
539 | * The deleter will be value-initialized. |
540 | */ |
541 | template<typename _Up, |
542 | typename _Vp = _Dp, |
543 | typename = _DeleterConstraint<_Vp>, |
544 | typename = typename enable_if< |
545 | __safe_conversion_raw<_Up>::value, bool>::type> |
546 | explicit |
547 | unique_ptr(_Up __p) noexcept |
548 | : _M_t(__p) |
549 | { } |
550 | |
551 | /** Takes ownership of a pointer. |
552 | * |
553 | * @param __p A pointer to an array of a type safely convertible |
554 | * to an array of @c element_type |
555 | * @param __d A reference to a deleter. |
556 | * |
557 | * The deleter will be initialized with @p __d |
558 | */ |
559 | template<typename _Up, typename _Del = deleter_type, |
560 | typename = _Require<__safe_conversion_raw<_Up>, |
561 | is_copy_constructible<_Del>>> |
562 | unique_ptr(_Up __p, const deleter_type& __d) noexcept |
563 | : _M_t(__p, __d) { } |
564 | |
565 | /** Takes ownership of a pointer. |
566 | * |
567 | * @param __p A pointer to an array of a type safely convertible |
568 | * to an array of @c element_type |
569 | * @param __d A reference to a deleter. |
570 | * |
571 | * The deleter will be initialized with @p std::move(__d) |
572 | */ |
573 | template<typename _Up, typename _Del = deleter_type, |
574 | typename = _Require<__safe_conversion_raw<_Up>, |
575 | is_move_constructible<_Del>>> |
576 | unique_ptr(_Up __p, |
577 | __enable_if_t<!is_lvalue_reference<_Del>::value, |
578 | _Del&&> __d) noexcept |
579 | : _M_t(std::move(__p), std::move(__d)) |
580 | { } |
581 | |
582 | template<typename _Up, typename _Del = deleter_type, |
583 | typename _DelUnref = typename remove_reference<_Del>::type, |
584 | typename = _Require<__safe_conversion_raw<_Up>>> |
585 | unique_ptr(_Up, |
586 | __enable_if_t<is_lvalue_reference<_Del>::value, |
587 | _DelUnref&&>) = delete; |
588 | |
589 | /// Move constructor. |
590 | unique_ptr(unique_ptr&&) = default; |
591 | |
592 | /// Creates a unique_ptr that owns nothing. |
593 | template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>> |
594 | constexpr unique_ptr(nullptr_t) noexcept |
595 | : _M_t() |
596 | { } |
597 | |
598 | template<typename _Up, typename _Ep, typename = _Require< |
599 | __safe_conversion_up<_Up, _Ep>, |
600 | typename conditional<is_reference<_Dp>::value, |
601 | is_same<_Ep, _Dp>, |
602 | is_convertible<_Ep, _Dp>>::type>> |
603 | unique_ptr(unique_ptr<_Up, _Ep>&& __u) noexcept |
604 | : _M_t(__u.release(), std::forward<_Ep>(__u.get_deleter())) |
605 | { } |
606 | |
607 | /// Destructor, invokes the deleter if the stored pointer is not null. |
608 | ~unique_ptr() |
609 | { |
610 | auto& __ptr = _M_t._M_ptr(); |
611 | if (__ptr != nullptr) |
612 | get_deleter()(__ptr); |
613 | __ptr = pointer(); |
614 | } |
615 | |
616 | // Assignment. |
617 | |
618 | /** @brief Move assignment operator. |
619 | * |
620 | * Invokes the deleter if this object owns a pointer. |
621 | */ |
622 | unique_ptr& |
623 | operator=(unique_ptr&&) = default; |
624 | |
625 | /** @brief Assignment from another type. |
626 | * |
627 | * @param __u The object to transfer ownership from, which owns a |
628 | * convertible pointer to an array object. |
629 | * |
630 | * Invokes the deleter if this object owns a pointer. |
631 | */ |
632 | template<typename _Up, typename _Ep> |
633 | typename |
634 | enable_if<__and_<__safe_conversion_up<_Up, _Ep>, |
635 | is_assignable<deleter_type&, _Ep&&> |
636 | >::value, |
637 | unique_ptr&>::type |
638 | operator=(unique_ptr<_Up, _Ep>&& __u) noexcept |
639 | { |
640 | reset(__u.release()); |
641 | get_deleter() = std::forward<_Ep>(__u.get_deleter()); |
642 | return *this; |
643 | } |
644 | |
645 | /// Reset the %unique_ptr to empty, invoking the deleter if necessary. |
646 | unique_ptr& |
647 | operator=(nullptr_t) noexcept |
648 | { |
649 | reset(); |
650 | return *this; |
651 | } |
652 | |
653 | // Observers. |
654 | |
655 | /// Access an element of owned array. |
656 | typename std::add_lvalue_reference<element_type>::type |
657 | operator[](size_t __i) const |
658 | { |
659 | __glibcxx_assert(get() != pointer())do { if (! (get() != pointer())) std::__replacement_assert("/usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/bits/unique_ptr.h" , 659, __PRETTY_FUNCTION__, "get() != pointer()"); } while (false ); |
660 | return get()[__i]; |
661 | } |
662 | |
663 | /// Return the stored pointer. |
664 | pointer |
665 | get() const noexcept |
666 | { return _M_t._M_ptr(); } |
667 | |
668 | /// Return a reference to the stored deleter. |
669 | deleter_type& |
670 | get_deleter() noexcept |
671 | { return _M_t._M_deleter(); } |
672 | |
673 | /// Return a reference to the stored deleter. |
674 | const deleter_type& |
675 | get_deleter() const noexcept |
676 | { return _M_t._M_deleter(); } |
677 | |
678 | /// Return @c true if the stored pointer is not null. |
679 | explicit operator bool() const noexcept |
680 | { return get() == pointer() ? false : true; } |
681 | |
682 | // Modifiers. |
683 | |
684 | /// Release ownership of any stored pointer. |
685 | pointer |
686 | release() noexcept |
687 | { return _M_t.release(); } |
688 | |
689 | /** @brief Replace the stored pointer. |
690 | * |
691 | * @param __p The new pointer to store. |
692 | * |
693 | * The deleter will be invoked if a pointer is already owned. |
694 | */ |
695 | template <typename _Up, |
696 | typename = _Require< |
697 | __or_<is_same<_Up, pointer>, |
698 | __and_<is_same<pointer, element_type*>, |
699 | is_pointer<_Up>, |
700 | is_convertible< |
701 | typename remove_pointer<_Up>::type(*)[], |
702 | element_type(*)[] |
703 | > |
704 | > |
705 | > |
706 | >> |
707 | void |
708 | reset(_Up __p) noexcept |
709 | { _M_t.reset(std::move(__p)); } |
710 | |
711 | void reset(nullptr_t = nullptr) noexcept |
712 | { reset(pointer()); } |
713 | |
714 | /// Exchange the pointer and deleter with another object. |
715 | void |
716 | swap(unique_ptr& __u) noexcept |
717 | { |
718 | static_assert(__is_swappable<_Dp>::value, "deleter must be swappable"); |
719 | _M_t.swap(__u._M_t); |
720 | } |
721 | |
722 | // Disable copy from lvalue. |
723 | unique_ptr(const unique_ptr&) = delete; |
724 | unique_ptr& operator=(const unique_ptr&) = delete; |
725 | }; |
726 | |
727 | /// @relates unique_ptr @{ |
728 | |
729 | /// Swap overload for unique_ptr |
730 | template<typename _Tp, typename _Dp> |
731 | inline |
732 | #if __cplusplus201703L > 201402L || !defined(__STRICT_ANSI__1) // c++1z or gnu++11 |
733 | // Constrained free swap overload, see p0185r1 |
734 | typename enable_if<__is_swappable<_Dp>::value>::type |
735 | #else |
736 | void |
737 | #endif |
738 | swap(unique_ptr<_Tp, _Dp>& __x, |
739 | unique_ptr<_Tp, _Dp>& __y) noexcept |
740 | { __x.swap(__y); } |
741 | |
742 | #if __cplusplus201703L > 201402L || !defined(__STRICT_ANSI__1) // c++1z or gnu++11 |
743 | template<typename _Tp, typename _Dp> |
744 | typename enable_if<!__is_swappable<_Dp>::value>::type |
745 | swap(unique_ptr<_Tp, _Dp>&, |
746 | unique_ptr<_Tp, _Dp>&) = delete; |
747 | #endif |
748 | |
749 | /// Equality operator for unique_ptr objects, compares the owned pointers |
750 | template<typename _Tp, typename _Dp, |
751 | typename _Up, typename _Ep> |
752 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
753 | operator==(const unique_ptr<_Tp, _Dp>& __x, |
754 | const unique_ptr<_Up, _Ep>& __y) |
755 | { return __x.get() == __y.get(); } |
756 | |
757 | /// unique_ptr comparison with nullptr |
758 | template<typename _Tp, typename _Dp> |
759 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
760 | operator==(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) noexcept |
761 | { return !__x; } |
762 | |
763 | #ifndef __cpp_lib_three_way_comparison |
764 | /// unique_ptr comparison with nullptr |
765 | template<typename _Tp, typename _Dp> |
766 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
767 | operator==(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) noexcept |
768 | { return !__x; } |
769 | |
770 | /// Inequality operator for unique_ptr objects, compares the owned pointers |
771 | template<typename _Tp, typename _Dp, |
772 | typename _Up, typename _Ep> |
773 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
774 | operator!=(const unique_ptr<_Tp, _Dp>& __x, |
775 | const unique_ptr<_Up, _Ep>& __y) |
776 | { return __x.get() != __y.get(); } |
777 | |
778 | /// unique_ptr comparison with nullptr |
779 | template<typename _Tp, typename _Dp> |
780 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
781 | operator!=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) noexcept |
782 | { return (bool)__x; } |
783 | |
784 | /// unique_ptr comparison with nullptr |
785 | template<typename _Tp, typename _Dp> |
786 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
787 | operator!=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) noexcept |
788 | { return (bool)__x; } |
789 | #endif // three way comparison |
790 | |
791 | /// Relational operator for unique_ptr objects, compares the owned pointers |
792 | template<typename _Tp, typename _Dp, |
793 | typename _Up, typename _Ep> |
794 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
795 | operator<(const unique_ptr<_Tp, _Dp>& __x, |
796 | const unique_ptr<_Up, _Ep>& __y) |
797 | { |
798 | typedef typename |
799 | std::common_type<typename unique_ptr<_Tp, _Dp>::pointer, |
800 | typename unique_ptr<_Up, _Ep>::pointer>::type _CT; |
801 | return std::less<_CT>()(__x.get(), __y.get()); |
802 | } |
803 | |
804 | /// unique_ptr comparison with nullptr |
805 | template<typename _Tp, typename _Dp> |
806 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
807 | operator<(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) |
808 | { |
809 | return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(__x.get(), |
810 | nullptr); |
811 | } |
812 | |
813 | /// unique_ptr comparison with nullptr |
814 | template<typename _Tp, typename _Dp> |
815 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
816 | operator<(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) |
817 | { |
818 | return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(nullptr, |
819 | __x.get()); |
820 | } |
821 | |
822 | /// Relational operator for unique_ptr objects, compares the owned pointers |
823 | template<typename _Tp, typename _Dp, |
824 | typename _Up, typename _Ep> |
825 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
826 | operator<=(const unique_ptr<_Tp, _Dp>& __x, |
827 | const unique_ptr<_Up, _Ep>& __y) |
828 | { return !(__y < __x); } |
829 | |
830 | /// unique_ptr comparison with nullptr |
831 | template<typename _Tp, typename _Dp> |
832 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
833 | operator<=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) |
834 | { return !(nullptr < __x); } |
835 | |
836 | /// unique_ptr comparison with nullptr |
837 | template<typename _Tp, typename _Dp> |
838 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
839 | operator<=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) |
840 | { return !(__x < nullptr); } |
841 | |
842 | /// Relational operator for unique_ptr objects, compares the owned pointers |
843 | template<typename _Tp, typename _Dp, |
844 | typename _Up, typename _Ep> |
845 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
846 | operator>(const unique_ptr<_Tp, _Dp>& __x, |
847 | const unique_ptr<_Up, _Ep>& __y) |
848 | { return (__y < __x); } |
849 | |
850 | /// unique_ptr comparison with nullptr |
851 | template<typename _Tp, typename _Dp> |
852 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
853 | operator>(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) |
854 | { |
855 | return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(nullptr, |
856 | __x.get()); |
857 | } |
858 | |
859 | /// unique_ptr comparison with nullptr |
860 | template<typename _Tp, typename _Dp> |
861 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
862 | operator>(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) |
863 | { |
864 | return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(__x.get(), |
865 | nullptr); |
866 | } |
867 | |
868 | /// Relational operator for unique_ptr objects, compares the owned pointers |
869 | template<typename _Tp, typename _Dp, |
870 | typename _Up, typename _Ep> |
871 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
872 | operator>=(const unique_ptr<_Tp, _Dp>& __x, |
873 | const unique_ptr<_Up, _Ep>& __y) |
874 | { return !(__x < __y); } |
875 | |
876 | /// unique_ptr comparison with nullptr |
877 | template<typename _Tp, typename _Dp> |
878 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
879 | operator>=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) |
880 | { return !(__x < nullptr); } |
881 | |
882 | /// unique_ptr comparison with nullptr |
883 | template<typename _Tp, typename _Dp> |
884 | _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool |
885 | operator>=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) |
886 | { return !(nullptr < __x); } |
887 | |
888 | #ifdef __cpp_lib_three_way_comparison |
889 | template<typename _Tp, typename _Dp, typename _Up, typename _Ep> |
890 | requires three_way_comparable_with<typename unique_ptr<_Tp, _Dp>::pointer, |
891 | typename unique_ptr<_Up, _Ep>::pointer> |
892 | inline |
893 | compare_three_way_result_t<typename unique_ptr<_Tp, _Dp>::pointer, |
894 | typename unique_ptr<_Up, _Ep>::pointer> |
895 | operator<=>(const unique_ptr<_Tp, _Dp>& __x, |
896 | const unique_ptr<_Up, _Ep>& __y) |
897 | { return compare_three_way()(__x.get(), __y.get()); } |
898 | |
899 | template<typename _Tp, typename _Dp> |
900 | requires three_way_comparable<typename unique_ptr<_Tp, _Dp>::pointer> |
901 | inline |
902 | compare_three_way_result_t<typename unique_ptr<_Tp, _Dp>::pointer> |
903 | operator<=>(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) |
904 | { |
905 | using pointer = typename unique_ptr<_Tp, _Dp>::pointer; |
906 | return compare_three_way()(__x.get(), static_cast<pointer>(nullptr)); |
907 | } |
908 | #endif |
909 | // @} relates unique_ptr |
910 | |
911 | /// @cond undocumented |
912 | template<typename _Up, typename _Ptr = typename _Up::pointer, |
913 | bool = __poison_hash<_Ptr>::__enable_hash_call> |
914 | struct __uniq_ptr_hash |
915 | #if ! _GLIBCXX_INLINE_VERSION0 |
916 | : private __poison_hash<_Ptr> |
917 | #endif |
918 | { |
919 | size_t |
920 | operator()(const _Up& __u) const |
921 | noexcept(noexcept(std::declval<hash<_Ptr>>()(std::declval<_Ptr>()))) |
922 | { return hash<_Ptr>()(__u.get()); } |
923 | }; |
924 | |
925 | template<typename _Up, typename _Ptr> |
926 | struct __uniq_ptr_hash<_Up, _Ptr, false> |
927 | : private __poison_hash<_Ptr> |
928 | { }; |
929 | /// @endcond |
930 | |
931 | /// std::hash specialization for unique_ptr. |
932 | template<typename _Tp, typename _Dp> |
933 | struct hash<unique_ptr<_Tp, _Dp>> |
934 | : public __hash_base<size_t, unique_ptr<_Tp, _Dp>>, |
935 | public __uniq_ptr_hash<unique_ptr<_Tp, _Dp>> |
936 | { }; |
937 | |
938 | #if __cplusplus201703L >= 201402L |
939 | /// @relates unique_ptr @{ |
940 | #define __cpp_lib_make_unique201304 201304 |
941 | |
942 | /// @cond undocumented |
943 | |
944 | template<typename _Tp> |
945 | struct _MakeUniq |
946 | { typedef unique_ptr<_Tp> __single_object; }; |
947 | |
948 | template<typename _Tp> |
949 | struct _MakeUniq<_Tp[]> |
950 | { typedef unique_ptr<_Tp[]> __array; }; |
951 | |
952 | template<typename _Tp, size_t _Bound> |
953 | struct _MakeUniq<_Tp[_Bound]> |
954 | { struct __invalid_type { }; }; |
955 | |
956 | /// @endcond |
957 | |
958 | /// std::make_unique for single objects |
959 | template<typename _Tp, typename... _Args> |
960 | inline typename _MakeUniq<_Tp>::__single_object |
961 | make_unique(_Args&&... __args) |
962 | { return unique_ptr<_Tp>(new _Tp(std::forward<_Args>(__args)...)); } |
963 | |
964 | /// std::make_unique for arrays of unknown bound |
965 | template<typename _Tp> |
966 | inline typename _MakeUniq<_Tp>::__array |
967 | make_unique(size_t __num) |
968 | { return unique_ptr<_Tp>(new remove_extent_t<_Tp>[__num]()); } |
969 | |
970 | /// Disable std::make_unique for arrays of known bound |
971 | template<typename _Tp, typename... _Args> |
972 | inline typename _MakeUniq<_Tp>::__invalid_type |
973 | make_unique(_Args&&...) = delete; |
974 | // @} relates unique_ptr |
975 | #endif // C++14 |
976 | |
977 | #if __cplusplus201703L > 201703L && __cpp_concepts |
978 | // _GLIBCXX_RESOLVE_LIB_DEFECTS |
979 | // 2948. unique_ptr does not define operator<< for stream output |
980 | /// Stream output operator for unique_ptr |
981 | template<typename _CharT, typename _Traits, typename _Tp, typename _Dp> |
982 | inline basic_ostream<_CharT, _Traits>& |
983 | operator<<(basic_ostream<_CharT, _Traits>& __os, |
984 | const unique_ptr<_Tp, _Dp>& __p) |
985 | requires requires { __os << __p.get(); } |
986 | { |
987 | __os << __p.get(); |
988 | return __os; |
989 | } |
990 | #endif // C++20 |
991 | |
992 | // @} group pointer_abstractions |
993 | |
994 | #if __cplusplus201703L >= 201703L |
995 | namespace __detail::__variant |
996 | { |
997 | template<typename> struct _Never_valueless_alt; // see <variant> |
998 | |
999 | // Provide the strong exception-safety guarantee when emplacing a |
1000 | // unique_ptr into a variant. |
1001 | template<typename _Tp, typename _Del> |
1002 | struct _Never_valueless_alt<std::unique_ptr<_Tp, _Del>> |
1003 | : std::true_type |
1004 | { }; |
1005 | } // namespace __detail::__variant |
1006 | #endif // C++17 |
1007 | |
1008 | _GLIBCXX_END_NAMESPACE_VERSION |
1009 | } // namespace |
1010 | |
1011 | #endif /* _UNIQUE_PTR_H */ |