mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
f3ff561c6f
This is phase-1 of switching from llvm::Optional to std::optional in the
next rebranch. llvm::Optional was removed from upstream LLVM, so we need
to migrate off rather soon. On Darwin, std::optional, and llvm::Optional
have the same layout, so we don't need to be as concerned about ABI
beyond the name mangling. `llvm::Optional` is only returned from one
function in
```
getStandardTypeSubst(StringRef TypeName,
bool allowConcurrencyManglings);
```
It's the return value, so it should not impact the mangling of the
function, and the layout is the same as `std::optional`, so it should be
mostly okay. This function doesn't appear to have users, and the ABI was
already broken 2 years ago for concurrency and no one seemed to notice
so this should be "okay".
I'm doing the migration incrementally so that folks working on main can
cherry-pick back to the release/5.9 branch. Once 5.9 is done and locked
away, then we can go through and finish the replacement. Since `None`
and `Optional` show up in contexts where they are not `llvm::None` and
`llvm::Optional`, I'm preparing the work now by going through and
removing the namespace unwrapping and making the `llvm` namespace
explicit. This should make it fairly mechanical to go through and
replace llvm::Optional with std::optional, and llvm::None with
std::nullopt. It's also a change that can be brought onto the
release/5.9 with minimal impact. This should be an NFC change.
147 lines
4.3 KiB
C++
147 lines
4.3 KiB
C++
//===--- Refactoring.h - APIs for refactoring --------*- C++ -*-===//
|
||
//
|
||
// This source file is part of the Swift.org open source project
|
||
//
|
||
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
|
||
// Licensed under Apache License v2.0 with Runtime Library Exception
|
||
//
|
||
// See https://swift.org/LICENSE.txt for license information
|
||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
||
//
|
||
//===----------------------------------------------------------------------===//
|
||
|
||
#ifndef SWIFT_IDE_REFACTORING_H
|
||
#define SWIFT_IDE_REFACTORING_H
|
||
|
||
#include "llvm/ADT/StringRef.h"
|
||
#include "swift/Basic/LLVM.h"
|
||
#include "swift/AST/DiagnosticConsumer.h"
|
||
#include "swift/IDE/Utils.h"
|
||
|
||
namespace swift {
|
||
class ModuleDecl;
|
||
class SourceLoc;
|
||
class SourceManager;
|
||
|
||
namespace ide {
|
||
struct ResolvedCursorInfo;
|
||
|
||
enum class RefactoringKind : int8_t {
|
||
None,
|
||
#define REFACTORING(KIND, NAME, ID) KIND,
|
||
#include "RefactoringKinds.def"
|
||
};
|
||
|
||
struct RangeConfig {
|
||
unsigned BufferID;
|
||
unsigned Line;
|
||
unsigned Column;
|
||
unsigned Length;
|
||
SourceLoc getStart(SourceManager &SM);
|
||
SourceLoc getEnd(SourceManager &SM);
|
||
};
|
||
|
||
enum class NameUsage {
|
||
Unknown,
|
||
Reference,
|
||
Definition,
|
||
Call
|
||
};
|
||
|
||
struct RenameLoc {
|
||
unsigned Line;
|
||
unsigned Column;
|
||
NameUsage Usage;
|
||
StringRef OldName;
|
||
StringRef NewName; // May be empty.
|
||
const bool IsFunctionLike;
|
||
const bool IsNonProtocolType;
|
||
};
|
||
|
||
struct RefactoringOptions {
|
||
RefactoringKind Kind;
|
||
RangeConfig Range;
|
||
std::string PreferredName;
|
||
RefactoringOptions(RefactoringKind Kind) : Kind(Kind) {}
|
||
};
|
||
|
||
// TODO: Merge with NoteRegion – range needs to change to start/end line/column
|
||
struct RenameRangeDetail {
|
||
CharSourceRange Range;
|
||
RefactoringRangeKind RangeKind;
|
||
llvm::Optional<unsigned> Index;
|
||
};
|
||
|
||
enum class RefactorAvailableKind {
|
||
Available,
|
||
Unavailable_system_symbol,
|
||
Unavailable_has_no_location,
|
||
Unavailable_has_no_name,
|
||
Unavailable_has_no_accessibility,
|
||
Unavailable_decl_from_clang,
|
||
Unavailable_decl_in_macro,
|
||
};
|
||
|
||
struct RefactorAvailabilityInfo {
|
||
RefactoringKind Kind;
|
||
RefactorAvailableKind AvailableKind;
|
||
RefactorAvailabilityInfo(RefactoringKind Kind,
|
||
RefactorAvailableKind AvailableKind)
|
||
: Kind(Kind), AvailableKind(AvailableKind) {}
|
||
RefactorAvailabilityInfo(RefactoringKind Kind)
|
||
: RefactorAvailabilityInfo(Kind, RefactorAvailableKind::Available) {}
|
||
};
|
||
|
||
class FindRenameRangesConsumer {
|
||
public:
|
||
virtual void accept(SourceManager &SM, RegionType RegionType,
|
||
ArrayRef<RenameRangeDetail> Ranges) = 0;
|
||
virtual ~FindRenameRangesConsumer() = default;
|
||
};
|
||
|
||
class FindRenameRangesAnnotatingConsumer : public FindRenameRangesConsumer {
|
||
struct Implementation;
|
||
Implementation &Impl;
|
||
|
||
public:
|
||
FindRenameRangesAnnotatingConsumer(SourceManager &SM, unsigned BufferId,
|
||
llvm::raw_ostream &OS);
|
||
~FindRenameRangesAnnotatingConsumer();
|
||
void accept(SourceManager &SM, RegionType RegionType,
|
||
ArrayRef<RenameRangeDetail> Ranges) override;
|
||
};
|
||
|
||
StringRef getDescriptiveRefactoringKindName(RefactoringKind Kind);
|
||
|
||
StringRef getDescriptiveRenameUnavailableReason(RefactorAvailableKind Kind);
|
||
|
||
bool refactorSwiftModule(ModuleDecl *M, RefactoringOptions Opts,
|
||
SourceEditConsumer &EditConsumer,
|
||
DiagnosticConsumer &DiagConsumer);
|
||
|
||
int syntacticRename(SourceFile *SF, llvm::ArrayRef<RenameLoc> RenameLocs,
|
||
SourceEditConsumer &EditConsumer,
|
||
DiagnosticConsumer &DiagConsumer);
|
||
|
||
int findSyntacticRenameRanges(SourceFile *SF,
|
||
llvm::ArrayRef<RenameLoc> RenameLocs,
|
||
FindRenameRangesConsumer &RenameConsumer,
|
||
DiagnosticConsumer &DiagConsumer);
|
||
|
||
int findLocalRenameRanges(SourceFile *SF, RangeConfig Range,
|
||
FindRenameRangesConsumer &RenameConsumer,
|
||
DiagnosticConsumer &DiagConsumer);
|
||
|
||
SmallVector<RefactorAvailabilityInfo, 0>
|
||
collectRefactorings(SourceFile *SF, RangeConfig Range,
|
||
bool &RangeStartMayNeedRename,
|
||
llvm::ArrayRef<DiagnosticConsumer *> DiagConsumers);
|
||
|
||
SmallVector<RefactorAvailabilityInfo, 0>
|
||
collectRefactorings(ResolvedCursorInfoPtr CursorInfo, bool ExcludeRename);
|
||
|
||
} // namespace ide
|
||
} // namespace swift
|
||
|
||
#endif // SWIFT_IDE_REFACTORING_H
|