tools/SourceKit/include/SourceKit/Core/LangSupport.h - third_party/swift - Git at Google

 //===--- LangSupport.h - ----------------------------------------*- 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 LLVM_SOURCEKIT_CORE_LANGSUPPORT_H
 #define LLVM_SOURCEKIT_CORE_LANGSUPPORT_H

 #include "SourceKit/Core/LLVM.h"
 #include "SourceKit/Support/UIdent.h"
 #include "clang/Basic/VersionTuple.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/SmallString.h"
 #include "swift/AST/Type.h"
 #include <functional>
 #include <memory>

 namespace llvm {
   class MemoryBuffer;
 }
 namespace SourceKit {

 struct EntityInfo {
   UIdent Kind;
   StringRef Name;
   StringRef USR;
   StringRef Group;
   StringRef ReceiverUSR;
   bool IsDynamic = false;
   bool IsTestCandidate = false;
   unsigned Line = 0;
   unsigned Column = 0;
   ArrayRef<UIdent> Attrs;

   EntityInfo() = default;
 };

 class IndexingConsumer {
   virtual void anchor();

 public:
   virtual ~IndexingConsumer() { }

   virtual void failed(StringRef ErrDescription) = 0;

   virtual bool recordHash(StringRef Hash, bool isKnown) = 0;

   virtual bool startDependency(UIdent Kind,
                                StringRef Name,
                                StringRef Path,
                                bool IsSystem,
                                StringRef Hash) = 0;

   virtual bool finishDependency(UIdent Kind) = 0;

   virtual bool startSourceEntity(const EntityInfo &Info) = 0;

   virtual bool recordRelatedEntity(const EntityInfo &Info) = 0;

   virtual bool finishSourceEntity(UIdent Kind) = 0;
 };

 struct CodeCompletionInfo {
   UIdent Kind;
   // We need a separate field to passthrough custom kinds that originally came
   // from the client, because we can't safely construct a UIdent for them.
   void *CustomKind = nullptr;
   StringRef Name;
   StringRef Description;
   StringRef SourceText;
   StringRef TypeName;
   StringRef ModuleName;
   StringRef DocBrief;
   StringRef AssocUSRs;
   UIdent SemanticContext;
   Optional<uint8_t> ModuleImportDepth;
   bool NotRecommended;
   unsigned NumBytesToErase;

   struct IndexRange {
     unsigned begin = 0;
     unsigned end = 0;
     IndexRange() = default;
     IndexRange(unsigned begin, unsigned end) : begin(begin), end(end) {}
     unsigned length() const { return end - begin; }
     bool empty() const { return end == begin; }
   };

   struct ParameterStructure {
     IndexRange name;
     IndexRange afterColon;
     bool isLocalName = false;
     IndexRange range() const {
       if (!name.empty()) // if we have both, name comes before afterColon.
         return {name.begin, afterColon.empty() ? name.end : afterColon.end};
       return afterColon;
     }
   };

   struct DescriptionStructure {
     IndexRange baseName;
     IndexRange parameterRange;
     IndexRange throwsRange;
   };

   Optional<DescriptionStructure> descriptionStructure;
   Optional<ArrayRef<ParameterStructure>> parametersStructure;
 };

 class CodeCompletionConsumer {
   virtual void anchor();

 public:
   virtual ~CodeCompletionConsumer() { }

   virtual void failed(StringRef ErrDescription) = 0;

   virtual bool handleResult(const CodeCompletionInfo &Info) = 0;
 };

 class GroupedCodeCompletionConsumer : public CodeCompletionConsumer {
 public:
   virtual void startGroup(UIdent kind, StringRef name) = 0;
   virtual void endGroup() = 0;
   virtual void setNextRequestStart(unsigned offset) = 0;
 };

 struct CustomCompletionInfo {
   std::string Name;
   void *Kind;

   enum Context {
     Stmt = 1 << 0,
     Expr = 1 << 1,
     Type = 1 << 2,
   };
   swift::OptionSet<Context> Contexts;
 };

 struct FilterRule {
   enum Kind {
     Everything,
     Module,
     Keyword,
     Literal,
     CustomCompletion,
     Identifier,
     Description,
   };
   Kind kind;
   bool hide;
   std::vector<StringRef> names; ///< Must be null-terminated.
   std::vector<UIdent> uids;
 };

 enum class DiagnosticSeverityKind {
   Warning,
   Error
 };

 struct DiagnosticEntryInfoBase {
   struct Fixit {
     unsigned Offset;
     unsigned Length;
     std::string Text;
   };

   std::string Description;
   unsigned Offset = 0;
   unsigned Line = 0;
   unsigned Column = 0;
   std::string Filename;
   SmallVector<std::pair<unsigned, unsigned>, 2> Ranges;
   SmallVector<Fixit, 2> Fixits;
 };

 struct DiagnosticEntryInfo : DiagnosticEntryInfoBase {
   DiagnosticSeverityKind Severity = DiagnosticSeverityKind::Error;
   SmallVector<DiagnosticEntryInfoBase, 1> Notes;
 };

 class EditorConsumer {
   virtual void anchor();

 public:
   virtual ~EditorConsumer() { }

   virtual bool needsSemanticInfo() { return true; }

   virtual void handleRequestError(const char *Description) = 0;

   virtual bool handleSyntaxMap(unsigned Offset, unsigned Length,
                                UIdent Kind) = 0;

   virtual bool handleSemanticAnnotation(unsigned Offset, unsigned Length,
                                         UIdent Kind, bool isSystem) = 0;

   virtual bool beginDocumentSubStructure(unsigned Offset, unsigned Length,
                                          UIdent Kind, UIdent AccessLevel,
                                          UIdent SetterAccessLevel,
                                          unsigned NameOffset,
                                          unsigned NameLength,
                                          unsigned BodyOffset,
                                          unsigned BodyLength,
                                          StringRef DisplayName,
                                          StringRef TypeName,
                                          StringRef RuntimeName,
                                          StringRef SelectorName,
                                          ArrayRef<StringRef> InheritedTypes,
                                          ArrayRef<UIdent> Attrs) = 0;

   virtual bool endDocumentSubStructure() = 0;

   virtual bool handleDocumentSubStructureElement(UIdent Kind,
                                                  unsigned Offset,
                                                  unsigned Length) = 0;

   virtual bool recordAffectedRange(unsigned Offset, unsigned Length) = 0;

   virtual bool recordAffectedLineRange(unsigned Line, unsigned Length) = 0;

   virtual bool recordFormattedText(StringRef Text) = 0;

   virtual bool setDiagnosticStage(UIdent DiagStage) = 0;
   virtual bool handleDiagnostic(const DiagnosticEntryInfo &Info,
                                 UIdent DiagStage) = 0;

   virtual bool handleSourceText(StringRef Text) = 0;

   virtual void finished() {}
 };

 class OptionsDictionary {
   virtual void anchor();
 public:
   virtual ~OptionsDictionary() {}

   virtual bool valueForOption(UIdent Key, unsigned &Val) = 0;
   virtual bool valueForOption(UIdent Key, bool &Val) = 0;
   virtual bool valueForOption(UIdent Key, StringRef &Val) = 0;
 };

 struct CursorInfo {
   bool IsCancelled = false;
   UIdent Kind;
   StringRef Name;
   StringRef USR;
   StringRef TypeName;
   StringRef TypeUSR;
   StringRef ContainerTypeUSR;
   StringRef DocComment;
   StringRef TypeInterface;
   StringRef GroupName;
   /// A key for documentation comment localization, if it exists in the doc
   /// comment for the declaration.
   StringRef LocalizationKey;
   /// Annotated XML pretty printed declaration.
   StringRef AnnotatedDeclaration;
   /// Fully annotated XML pretty printed declaration.
   /// FIXME: this should eventually replace \c AnnotatedDeclaration.
   StringRef FullyAnnotatedDeclaration;
   /// Non-empty if the symbol was imported from a clang module.
   StringRef ModuleName;
   /// Non-empty if a generated interface editor document has previously been
   /// opened for the module the symbol came from.
   StringRef ModuleInterfaceName;
   /// This is an (offset,length) pair.
   /// It is set only if the declaration has a source location.
   llvm::Optional<std::pair<unsigned, unsigned>> DeclarationLoc;
   /// Set only if the declaration has a source location.
   StringRef Filename;
   /// For methods this lists the USRs of the overrides in the class hierarchy.
   ArrayRef<StringRef> OverrideUSRs;
   /// Related declarations, overloaded functions etc., in annotated XML form.
   ArrayRef<StringRef> AnnotatedRelatedDeclarations;
   /// All groups of the module name under cursor.
   ArrayRef<StringRef> ModuleGroupArray;
   /// All available actions on the code under cursor.
   ArrayRef<StringRef> AvailableActions;
   bool IsSystem = false;
   llvm::Optional<unsigned> ParentNameOffset;
 };

 struct RangeInfo {
   bool IsCancelled = false;
   UIdent RangeKind;
   StringRef ExprType;
   StringRef RangeContent;
 };

 struct NameTranslatingInfo {
   bool IsCancelled = false;
   UIdent NameKind;
   StringRef BaseName;
   std::vector<StringRef> ArgNames;
   bool IsZeroArgSelector = false;
 };

 struct RelatedIdentsInfo {
   bool IsCancelled = false;
   /// (Offset,Length) pairs.
   ArrayRef<std::pair<unsigned, unsigned>> Ranges;
 };

 /// Filled out by LangSupport::findInterfaceDocument().
 struct InterfaceDocInfo {
   /// Non-empty if an error occurred.
   StringRef Error;
   /// Non-empty if a generated interface editor document has previously been
   /// opened for the requested module name.
   StringRef ModuleInterfaceName;
   /// The subset of compiler arguments that are relevant for the interface
   /// generation.
   ArrayRef<StringRef> CompilerArgs;
 };

 struct DocGenericParam {
   std::string Name;
   std::string Inherits;
 };

 struct DocEntityInfo {
   UIdent Kind;
   llvm::SmallString<32> Name;
   llvm::SmallString<32> SubModuleName;
   llvm::SmallString<32> Argument;
   llvm::SmallString<64> USR;
   llvm::SmallString<64> OriginalUSR;
   llvm::SmallString<64> ProvideImplementationOfUSR;
   llvm::SmallString<64> DocComment;
   llvm::SmallString<64> FullyAnnotatedDecl;
   llvm::SmallString<64> LocalizationKey;
   std::vector<DocGenericParam> GenericParams;
   std::vector<std::string> GenericRequirements;
   unsigned Offset = 0;
   unsigned Length = 0;
   bool IsUnavailable = false;
   bool IsDeprecated = false;
   bool IsOptional = false;
   swift::Type Ty;
 };

 struct AvailableAttrInfo {
   UIdent AttrKind;
   bool IsUnavailable = false;
   bool IsDeprecated = false;
   UIdent Platform;
   llvm::SmallString<32> Message;
   llvm::Optional<clang::VersionTuple> Introduced;
   llvm::Optional<clang::VersionTuple> Deprecated;
   llvm::Optional<clang::VersionTuple> Obsoleted;
 };

 class DocInfoConsumer {
   virtual void anchor();

 public:
   virtual ~DocInfoConsumer() { }

   virtual void failed(StringRef ErrDescription) = 0;

   virtual bool handleSourceText(StringRef Text) = 0;

   virtual bool handleAnnotation(const DocEntityInfo &Info) = 0;

   virtual bool startSourceEntity(const DocEntityInfo &Info) = 0;

   virtual bool handleInheritsEntity(const DocEntityInfo &Info) = 0;
   virtual bool handleConformsToEntity(const DocEntityInfo &Info) = 0;
   virtual bool handleExtendsEntity(const DocEntityInfo &Info) = 0;

   virtual bool handleAvailableAttribute(const AvailableAttrInfo &Info) = 0;

   virtual bool finishSourceEntity(UIdent Kind) = 0;

   virtual bool handleDiagnostic(const DiagnosticEntryInfo &Info) = 0;
 };

 class LangSupport {
   virtual void anchor();

 public:
   /// A separator between parts in a synthesized usr.
   const static std::string SynthesizedUSRSeparator;

   virtual ~LangSupport() { }

   virtual void indexSource(StringRef Filename,
                            IndexingConsumer &Consumer,
                            ArrayRef<const char *> Args,
                            StringRef Hash) = 0;

   virtual void codeComplete(llvm::MemoryBuffer *InputBuf, unsigned Offset,
                             CodeCompletionConsumer &Consumer,
                             ArrayRef<const char *> Args) = 0;

   virtual void codeCompleteOpen(StringRef name, llvm::MemoryBuffer *inputBuf,
                                 unsigned offset, OptionsDictionary *options,
                                 ArrayRef<FilterRule> filterRules,
                                 GroupedCodeCompletionConsumer &consumer,
                                 ArrayRef<const char *> args) = 0;

   virtual void codeCompleteClose(StringRef name, unsigned offset,
                                  GroupedCodeCompletionConsumer &consumer) = 0;

   virtual void codeCompleteUpdate(StringRef name, unsigned offset,
                                   OptionsDictionary *options,
                                   GroupedCodeCompletionConsumer &consumer) = 0;

   virtual void codeCompleteCacheOnDisk(StringRef path) = 0;

   virtual void
   codeCompleteSetPopularAPI(ArrayRef<const char *> popularAPI,
                             ArrayRef<const char *> unpopularAPI) = 0;

   virtual void
   codeCompleteSetCustom(ArrayRef<CustomCompletionInfo> completions) = 0;

   virtual void editorOpen(StringRef Name, llvm::MemoryBuffer *Buf,
                           bool EnableSyntaxMap,
                           EditorConsumer &Consumer,
                           ArrayRef<const char *> Args) = 0;

   virtual void editorOpenInterface(EditorConsumer &Consumer,
                                    StringRef Name,
                                    StringRef ModuleName,
                                    Optional<StringRef> Group,
                                    ArrayRef<const char *> Args,
                                    bool SynthesizedExtensions,
                                    Optional<StringRef> InterestedUSR) = 0;

   virtual void editorOpenTypeInterface(EditorConsumer &Consumer,
                                        ArrayRef<const char *> Args,
                                        StringRef TypeUSR) = 0;

   virtual void editorOpenHeaderInterface(EditorConsumer &Consumer,
                                          StringRef Name,
                                          StringRef HeaderName,
                                          ArrayRef<const char *> Args,
                                          bool SynthesizedExtensions,
                                          Optional<unsigned> swiftVersion) = 0;

   virtual void editorOpenSwiftSourceInterface(StringRef Name,
                                               StringRef SourceName,
                                               ArrayRef<const char *> Args,
                                               std::shared_ptr<EditorConsumer> Consumer) = 0;

   virtual void editorClose(StringRef Name, bool RemoveCache) = 0;

   virtual void editorReplaceText(StringRef Name, llvm::MemoryBuffer *Buf,
                                  unsigned Offset, unsigned Length,
                                  EditorConsumer &Consumer) = 0;

   virtual void editorApplyFormatOptions(StringRef Name,
                                         OptionsDictionary &FmtOptions) = 0;

   virtual void editorFormatText(StringRef Name, unsigned Line, unsigned Length,
                                 EditorConsumer &Consumer) = 0;

   virtual void editorExtractTextFromComment(StringRef Source,
                                             EditorConsumer &Consumer) = 0;

   virtual void editorConvertMarkupToXML(StringRef Source,
                                         EditorConsumer &Consumer) = 0;

   virtual void editorExpandPlaceholder(StringRef Name, unsigned Offset,
                                        unsigned Length,
                                        EditorConsumer &Consumer) = 0;

   virtual void getCursorInfo(StringRef Filename, unsigned Offset,
                              unsigned Length, bool Actionables,
                              bool CancelOnSubsequentRequest,
                              ArrayRef<const char *> Args,
                           std::function<void(const CursorInfo &)> Receiver) = 0;


   virtual void getNameInfo(StringRef Filename, unsigned Offset,
                            NameTranslatingInfo &Input,
                            ArrayRef<const char *> Args,
                 std::function<void(const NameTranslatingInfo &)> Receiver) = 0;

   virtual void getRangeInfo(StringRef Filename, unsigned Offset, unsigned Length,
                             bool CancelOnSubsequentRequest,
                             ArrayRef<const char *> Args,
                             std::function<void(const RangeInfo&)> Receiver) = 0;

   virtual void
   getCursorInfoFromUSR(StringRef Filename, StringRef USR,
                        bool CancelOnSubsequentRequest,
                        ArrayRef<const char *> Args,
                        std::function<void(const CursorInfo &)> Receiver) = 0;

   virtual void findRelatedIdentifiersInFile(StringRef Filename,
                                             unsigned Offset,
                                             bool CancelOnSubsequentRequest,
                                             ArrayRef<const char *> Args,
                    std::function<void(const RelatedIdentsInfo &)> Receiver) = 0;

   virtual llvm::Optional<std::pair<unsigned, unsigned>>
       findUSRRange(StringRef DocumentName, StringRef USR) = 0;

   virtual void findInterfaceDocument(StringRef ModuleName,
                                      ArrayRef<const char *> Args,
                     std::function<void(const InterfaceDocInfo &)> Receiver) = 0;

   virtual void findModuleGroups(StringRef ModuleName,
                                 ArrayRef<const char *> Args,
                                 std::function<void(ArrayRef<StringRef>,
                                                    StringRef Error)> Receiver) = 0;

   virtual void getDocInfo(llvm::MemoryBuffer *InputBuf,
                           StringRef ModuleName,
                           ArrayRef<const char *> Args,
                           DocInfoConsumer &Consumer) = 0;
 };

 } // namespace SourceKit

 #endif
	//===--- LangSupport.h - ----------------------------------------- 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 LLVM_SOURCEKIT_CORE_LANGSUPPORT_H
	#define LLVM_SOURCEKIT_CORE_LANGSUPPORT_H

	#include "SourceKit/Core/LLVM.h"
	#include "SourceKit/Support/UIdent.h"
	#include "clang/Basic/VersionTuple.h"
	#include "llvm/ADT/ArrayRef.h"
	#include "llvm/ADT/Optional.h"
	#include "llvm/ADT/SmallString.h"
	#include "swift/AST/Type.h"
	#include <functional>
	#include <memory>

	namespace llvm {
	class MemoryBuffer;
	}
	namespace SourceKit {

	struct EntityInfo {
	UIdent Kind;
	StringRef Name;
	StringRef USR;
	StringRef Group;
	StringRef ReceiverUSR;
	bool IsDynamic = false;
	bool IsTestCandidate = false;
	unsigned Line = 0;
	unsigned Column = 0;
	ArrayRef<UIdent> Attrs;

	EntityInfo() = default;
	};

	class IndexingConsumer {
	virtual void anchor();

	public:
	virtual ~IndexingConsumer() { }

	virtual void failed(StringRef ErrDescription) = 0;

	virtual bool recordHash(StringRef Hash, bool isKnown) = 0;

	virtual bool startDependency(UIdent Kind,
	StringRef Name,
	StringRef Path,
	bool IsSystem,
	StringRef Hash) = 0;

	virtual bool finishDependency(UIdent Kind) = 0;

	virtual bool startSourceEntity(const EntityInfo &Info) = 0;

	virtual bool recordRelatedEntity(const EntityInfo &Info) = 0;

	virtual bool finishSourceEntity(UIdent Kind) = 0;
	};

	struct CodeCompletionInfo {
	UIdent Kind;
	// We need a separate field to passthrough custom kinds that originally came
	// from the client, because we can't safely construct a UIdent for them.
	void *CustomKind = nullptr;
	StringRef Name;
	StringRef Description;
	StringRef SourceText;
	StringRef TypeName;
	StringRef ModuleName;
	StringRef DocBrief;
	StringRef AssocUSRs;
	UIdent SemanticContext;
	Optional<uint8_t> ModuleImportDepth;
	bool NotRecommended;
	unsigned NumBytesToErase;

	struct IndexRange {
	unsigned begin = 0;
	unsigned end = 0;
	IndexRange() = default;
	IndexRange(unsigned begin, unsigned end) : begin(begin), end(end) {}
	unsigned length() const { return end - begin; }
	bool empty() const { return end == begin; }
	};

	struct ParameterStructure {
	IndexRange name;
	IndexRange afterColon;
	bool isLocalName = false;
	IndexRange range() const {
	if (!name.empty()) // if we have both, name comes before afterColon.
	return {name.begin, afterColon.empty() ? name.end : afterColon.end};
	return afterColon;
	}
	};

	struct DescriptionStructure {
	IndexRange baseName;
	IndexRange parameterRange;
	IndexRange throwsRange;
	};

	Optional<DescriptionStructure> descriptionStructure;
	Optional<ArrayRef<ParameterStructure>> parametersStructure;
	};

	class CodeCompletionConsumer {
	virtual void anchor();

	public:
	virtual ~CodeCompletionConsumer() { }

	virtual void failed(StringRef ErrDescription) = 0;

	virtual bool handleResult(const CodeCompletionInfo &Info) = 0;
	};

	class GroupedCodeCompletionConsumer : public CodeCompletionConsumer {
	public:
	virtual void startGroup(UIdent kind, StringRef name) = 0;
	virtual void endGroup() = 0;
	virtual void setNextRequestStart(unsigned offset) = 0;
	};

	struct CustomCompletionInfo {
	std::string Name;
	void *Kind;

	enum Context {
	Stmt = 1 << 0,
	Expr = 1 << 1,
	Type = 1 << 2,
	};
	swift::OptionSet<Context> Contexts;
	};

	struct FilterRule {
	enum Kind {
	Everything,
	Module,
	Keyword,
	Literal,
	CustomCompletion,
	Identifier,
	Description,
	};
	Kind kind;
	bool hide;
	std::vector<StringRef> names; ///< Must be null-terminated.
	std::vector<UIdent> uids;
	};

	enum class DiagnosticSeverityKind {
	Warning,
	Error
	};

	struct DiagnosticEntryInfoBase {
	struct Fixit {
	unsigned Offset;
	unsigned Length;
	std::string Text;
	};

	std::string Description;
	unsigned Offset = 0;
	unsigned Line = 0;
	unsigned Column = 0;
	std::string Filename;
	SmallVector<std::pair<unsigned, unsigned>, 2> Ranges;
	SmallVector<Fixit, 2> Fixits;
	};

	struct DiagnosticEntryInfo : DiagnosticEntryInfoBase {
	DiagnosticSeverityKind Severity = DiagnosticSeverityKind::Error;
	SmallVector<DiagnosticEntryInfoBase, 1> Notes;
	};

	class EditorConsumer {
	virtual void anchor();

	public:
	virtual ~EditorConsumer() { }

	virtual bool needsSemanticInfo() { return true; }

	virtual void handleRequestError(const char *Description) = 0;

	virtual bool handleSyntaxMap(unsigned Offset, unsigned Length,
	UIdent Kind) = 0;

	virtual bool handleSemanticAnnotation(unsigned Offset, unsigned Length,
	UIdent Kind, bool isSystem) = 0;

	virtual bool beginDocumentSubStructure(unsigned Offset, unsigned Length,
	UIdent Kind, UIdent AccessLevel,
	UIdent SetterAccessLevel,
	unsigned NameOffset,
	unsigned NameLength,
	unsigned BodyOffset,
	unsigned BodyLength,
	StringRef DisplayName,
	StringRef TypeName,
	StringRef RuntimeName,
	StringRef SelectorName,
	ArrayRef<StringRef> InheritedTypes,
	ArrayRef<UIdent> Attrs) = 0;

	virtual bool endDocumentSubStructure() = 0;

	virtual bool handleDocumentSubStructureElement(UIdent Kind,
	unsigned Offset,
	unsigned Length) = 0;

	virtual bool recordAffectedRange(unsigned Offset, unsigned Length) = 0;

	virtual bool recordAffectedLineRange(unsigned Line, unsigned Length) = 0;

	virtual bool recordFormattedText(StringRef Text) = 0;

	virtual bool setDiagnosticStage(UIdent DiagStage) = 0;
	virtual bool handleDiagnostic(const DiagnosticEntryInfo &Info,
	UIdent DiagStage) = 0;

	virtual bool handleSourceText(StringRef Text) = 0;

	virtual void finished() {}
	};

	class OptionsDictionary {
	virtual void anchor();
	public:
	virtual ~OptionsDictionary() {}

	virtual bool valueForOption(UIdent Key, unsigned &Val) = 0;
	virtual bool valueForOption(UIdent Key, bool &Val) = 0;
	virtual bool valueForOption(UIdent Key, StringRef &Val) = 0;
	};

	struct CursorInfo {
	bool IsCancelled = false;
	UIdent Kind;
	StringRef Name;
	StringRef USR;
	StringRef TypeName;
	StringRef TypeUSR;
	StringRef ContainerTypeUSR;
	StringRef DocComment;
	StringRef TypeInterface;
	StringRef GroupName;
	/// A key for documentation comment localization, if it exists in the doc
	/// comment for the declaration.
	StringRef LocalizationKey;
	/// Annotated XML pretty printed declaration.
	StringRef AnnotatedDeclaration;
	/// Fully annotated XML pretty printed declaration.
	/// FIXME: this should eventually replace \c AnnotatedDeclaration.
	StringRef FullyAnnotatedDeclaration;
	/// Non-empty if the symbol was imported from a clang module.
	StringRef ModuleName;
	/// Non-empty if a generated interface editor document has previously been
	/// opened for the module the symbol came from.
	StringRef ModuleInterfaceName;
	/// This is an (offset,length) pair.
	/// It is set only if the declaration has a source location.
	llvm::Optional<std::pair<unsigned, unsigned>> DeclarationLoc;
	/// Set only if the declaration has a source location.
	StringRef Filename;
	/// For methods this lists the USRs of the overrides in the class hierarchy.
	ArrayRef<StringRef> OverrideUSRs;
	/// Related declarations, overloaded functions etc., in annotated XML form.
	ArrayRef<StringRef> AnnotatedRelatedDeclarations;
	/// All groups of the module name under cursor.
	ArrayRef<StringRef> ModuleGroupArray;
	/// All available actions on the code under cursor.
	ArrayRef<StringRef> AvailableActions;
	bool IsSystem = false;
	llvm::Optional<unsigned> ParentNameOffset;
	};

	struct RangeInfo {
	bool IsCancelled = false;
	UIdent RangeKind;
	StringRef ExprType;
	StringRef RangeContent;
	};

	struct NameTranslatingInfo {
	bool IsCancelled = false;
	UIdent NameKind;
	StringRef BaseName;
	std::vector<StringRef> ArgNames;
	bool IsZeroArgSelector = false;
	};

	struct RelatedIdentsInfo {
	bool IsCancelled = false;
	/// (Offset,Length) pairs.
	ArrayRef<std::pair<unsigned, unsigned>> Ranges;
	};

	/// Filled out by LangSupport::findInterfaceDocument().
	struct InterfaceDocInfo {
	/// Non-empty if an error occurred.
	StringRef Error;
	/// Non-empty if a generated interface editor document has previously been
	/// opened for the requested module name.
	StringRef ModuleInterfaceName;
	/// The subset of compiler arguments that are relevant for the interface
	/// generation.
	ArrayRef<StringRef> CompilerArgs;
	};

	struct DocGenericParam {
	std::string Name;
	std::string Inherits;
	};

	struct DocEntityInfo {
	UIdent Kind;
	llvm::SmallString<32> Name;
	llvm::SmallString<32> SubModuleName;
	llvm::SmallString<32> Argument;
	llvm::SmallString<64> USR;
	llvm::SmallString<64> OriginalUSR;
	llvm::SmallString<64> ProvideImplementationOfUSR;
	llvm::SmallString<64> DocComment;
	llvm::SmallString<64> FullyAnnotatedDecl;
	llvm::SmallString<64> LocalizationKey;
	std::vector<DocGenericParam> GenericParams;
	std::vector<std::string> GenericRequirements;
	unsigned Offset = 0;
	unsigned Length = 0;
	bool IsUnavailable = false;
	bool IsDeprecated = false;
	bool IsOptional = false;
	swift::Type Ty;
	};

	struct AvailableAttrInfo {
	UIdent AttrKind;
	bool IsUnavailable = false;
	bool IsDeprecated = false;
	UIdent Platform;
	llvm::SmallString<32> Message;
	llvm::Optional<clang::VersionTuple> Introduced;
	llvm::Optional<clang::VersionTuple> Deprecated;
	llvm::Optional<clang::VersionTuple> Obsoleted;
	};

	class DocInfoConsumer {
	virtual void anchor();

	public:
	virtual ~DocInfoConsumer() { }

	virtual void failed(StringRef ErrDescription) = 0;

	virtual bool handleSourceText(StringRef Text) = 0;

	virtual bool handleAnnotation(const DocEntityInfo &Info) = 0;

	virtual bool startSourceEntity(const DocEntityInfo &Info) = 0;

	virtual bool handleInheritsEntity(const DocEntityInfo &Info) = 0;
	virtual bool handleConformsToEntity(const DocEntityInfo &Info) = 0;
	virtual bool handleExtendsEntity(const DocEntityInfo &Info) = 0;

	virtual bool handleAvailableAttribute(const AvailableAttrInfo &Info) = 0;

	virtual bool finishSourceEntity(UIdent Kind) = 0;

	virtual bool handleDiagnostic(const DiagnosticEntryInfo &Info) = 0;
	};

	class LangSupport {
	virtual void anchor();

	public:
	/// A separator between parts in a synthesized usr.
	const static std::string SynthesizedUSRSeparator;

	virtual ~LangSupport() { }

	virtual void indexSource(StringRef Filename,
	IndexingConsumer &Consumer,
	ArrayRef<const char *> Args,
	StringRef Hash) = 0;

	virtual void codeComplete(llvm::MemoryBuffer *InputBuf, unsigned Offset,
	CodeCompletionConsumer &Consumer,
	ArrayRef<const char *> Args) = 0;

	virtual void codeCompleteOpen(StringRef name, llvm::MemoryBuffer *inputBuf,
	unsigned offset, OptionsDictionary *options,
	ArrayRef<FilterRule> filterRules,
	GroupedCodeCompletionConsumer &consumer,
	ArrayRef<const char *> args) = 0;

	virtual void codeCompleteClose(StringRef name, unsigned offset,
	GroupedCodeCompletionConsumer &consumer) = 0;

	virtual void codeCompleteUpdate(StringRef name, unsigned offset,
	OptionsDictionary *options,
	GroupedCodeCompletionConsumer &consumer) = 0;

	virtual void codeCompleteCacheOnDisk(StringRef path) = 0;

	virtual void
	codeCompleteSetPopularAPI(ArrayRef<const char *> popularAPI,
	ArrayRef<const char *> unpopularAPI) = 0;

	virtual void
	codeCompleteSetCustom(ArrayRef<CustomCompletionInfo> completions) = 0;

	virtual void editorOpen(StringRef Name, llvm::MemoryBuffer *Buf,
	bool EnableSyntaxMap,
	EditorConsumer &Consumer,
	ArrayRef<const char *> Args) = 0;

	virtual void editorOpenInterface(EditorConsumer &Consumer,
	StringRef Name,
	StringRef ModuleName,
	Optional<StringRef> Group,
	ArrayRef<const char *> Args,
	bool SynthesizedExtensions,
	Optional<StringRef> InterestedUSR) = 0;

	virtual void editorOpenTypeInterface(EditorConsumer &Consumer,
	ArrayRef<const char *> Args,
	StringRef TypeUSR) = 0;

	virtual void editorOpenHeaderInterface(EditorConsumer &Consumer,
	StringRef Name,
	StringRef HeaderName,
	ArrayRef<const char *> Args,
	bool SynthesizedExtensions,
	Optional<unsigned> swiftVersion) = 0;

	virtual void editorOpenSwiftSourceInterface(StringRef Name,
	StringRef SourceName,
	ArrayRef<const char *> Args,
	std::shared_ptr<EditorConsumer> Consumer) = 0;

	virtual void editorClose(StringRef Name, bool RemoveCache) = 0;

	virtual void editorReplaceText(StringRef Name, llvm::MemoryBuffer *Buf,
	unsigned Offset, unsigned Length,
	EditorConsumer &Consumer) = 0;

	virtual void editorApplyFormatOptions(StringRef Name,
	OptionsDictionary &FmtOptions) = 0;

	virtual void editorFormatText(StringRef Name, unsigned Line, unsigned Length,
	EditorConsumer &Consumer) = 0;

	virtual void editorExtractTextFromComment(StringRef Source,
	EditorConsumer &Consumer) = 0;

	virtual void editorConvertMarkupToXML(StringRef Source,
	EditorConsumer &Consumer) = 0;

	virtual void editorExpandPlaceholder(StringRef Name, unsigned Offset,
	unsigned Length,
	EditorConsumer &Consumer) = 0;

	virtual void getCursorInfo(StringRef Filename, unsigned Offset,
	unsigned Length, bool Actionables,
	bool CancelOnSubsequentRequest,
	ArrayRef<const char *> Args,
	std::function<void(const CursorInfo &)> Receiver) = 0;


	virtual void getNameInfo(StringRef Filename, unsigned Offset,
	NameTranslatingInfo &Input,
	ArrayRef<const char *> Args,
	std::function<void(const NameTranslatingInfo &)> Receiver) = 0;

	virtual void getRangeInfo(StringRef Filename, unsigned Offset, unsigned Length,
	bool CancelOnSubsequentRequest,
	ArrayRef<const char *> Args,
	std::function<void(const RangeInfo&)> Receiver) = 0;

	virtual void
	getCursorInfoFromUSR(StringRef Filename, StringRef USR,
	bool CancelOnSubsequentRequest,
	ArrayRef<const char *> Args,
	std::function<void(const CursorInfo &)> Receiver) = 0;

	virtual void findRelatedIdentifiersInFile(StringRef Filename,
	unsigned Offset,
	bool CancelOnSubsequentRequest,
	ArrayRef<const char *> Args,
	std::function<void(const RelatedIdentsInfo &)> Receiver) = 0;

	virtual llvm::Optional<std::pair<unsigned, unsigned>>
	findUSRRange(StringRef DocumentName, StringRef USR) = 0;

	virtual void findInterfaceDocument(StringRef ModuleName,
	ArrayRef<const char *> Args,
	std::function<void(const InterfaceDocInfo &)> Receiver) = 0;

	virtual void findModuleGroups(StringRef ModuleName,
	ArrayRef<const char *> Args,
	std::function<void(ArrayRef<StringRef>,
	StringRef Error)> Receiver) = 0;

	virtual void getDocInfo(llvm::MemoryBuffer *InputBuf,
	StringRef ModuleName,
	ArrayRef<const char *> Args,
	DocInfoConsumer &Consumer) = 0;
	};

	} // namespace SourceKit

	#endif