Files
swift-mirror/include/swift/IDE/CodeCompletionStringPrinter.h
Evan Wilde f3ff561c6f [NFC] add llvm namespace to Optional and None
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.
2023-06-27 09:03:52 -07:00

105 lines
3.1 KiB
C++

//===--- CodeCompletionStringPrinter.h ------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2022 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_CODECOMPLETIONRESULTSTRINGPRINTER_H
#define SWIFT_IDE_CODECOMPLETIONRESULTSTRINGPRINTER_H
#include "swift/AST/ASTPrinter.h"
#include "swift/IDE/CodeCompletionString.h"
namespace swift {
namespace ide {
/// 'ASTPrinter' printing to 'CodeCompletionString' with appropriate ChunkKind.
/// This is mainly used for printing types and override completions.
class CodeCompletionStringPrinter : public ASTPrinter {
protected:
using ChunkKind = CodeCompletionString::Chunk::ChunkKind;
private:
CodeCompletionResultBuilder &Builder;
SmallString<16> Buffer;
ChunkKind CurrChunkKind = ChunkKind::Text;
ChunkKind NextChunkKind = ChunkKind::Text;
SmallVector<PrintStructureKind, 2> StructureStack;
unsigned int TypeDepth = 0;
bool InPreamble = false;
bool isCurrentStructureKind(PrintStructureKind Kind) const {
return !StructureStack.empty() && StructureStack.back() == Kind;
}
bool isInType() const { return TypeDepth > 0; }
llvm::Optional<ChunkKind>
getChunkKindForPrintNameContext(PrintNameContext context) const;
llvm::Optional<ChunkKind>
getChunkKindForStructureKind(PrintStructureKind Kind) const;
void startNestedGroup(ChunkKind Kind);
void endNestedGroup();
protected:
void setNextChunkKind(ChunkKind Kind) { NextChunkKind = Kind; }
public:
CodeCompletionStringPrinter(CodeCompletionResultBuilder &Builder)
: Builder(Builder) {}
~CodeCompletionStringPrinter() {
// Flush the remainings.
flush();
}
void flush();
/// Start \c AttributeAndModifierListBegin group. This must be called before
/// any attributes/modifiers printed to the output when printing an override
/// compleion.
void startPreamble();
/// End the current \c AttributeAndModifierListBegin group if it's still open.
/// This is automatically called before the main part of the signature.
void endPremable();
/// Implement \c ASTPrinter .
public:
void printText(StringRef Text) override;
void printTypeRef(
Type T, const TypeDecl *TD, Identifier Name,
PrintNameContext NameContext = PrintNameContext::Normal) override;
void printDeclLoc(const Decl *D) override;
void printDeclNameEndLoc(const Decl *D) override;
void printNamePre(PrintNameContext context) override;
void printNamePost(PrintNameContext context) override;
void printTypePre(const TypeLoc &TL) override;
void printTypePost(const TypeLoc &TL) override;
void printStructurePre(PrintStructureKind Kind, const Decl *D) override;
void printStructurePost(PrintStructureKind Kind, const Decl *D) override;
};
} // end namespace ide
} // end namespace swift
#endif // SWIFT_IDE_CODECOMPLETIONRESULTSTRINGPRINTER_H