SwiftInterfaceGenContext.h

//===--- SwiftInterfaceGenContext.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_LIB_SWIFTLANG_SWIFTINTERFACEGENCONTEXT_H
#defineLLVM_SOURCEKIT_LIB_SWIFTLANG_SWIFTINTERFACEGENCONTEXT_H

#include"SourceKit/Core/LLVM.h"
#include"swift/AST/Module.h"
#include"swift/Basic/ThreadSafeRefCounted.h"
#include<string>

namespaceswift {
classCompilerInvocation;
classValueDecl;
classModuleDecl;
}

namespaceSourceKit {
classEditorConsumer;
classSwiftInterfaceGenContext;
typedef RefPtr<SwiftInterfaceGenContext> SwiftInterfaceGenContextRef;
classASTUnit;
typedef IntrusiveRefCntPtr<ASTUnit> ASTUnitRef;

classSwiftInterfaceGenContext :
 public llvm::ThreadSafeRefCountedBase<SwiftInterfaceGenContext> {
public:
static SwiftInterfaceGenContextRef
create(StringRef DocumentName, bool IsModule, StringRef ModuleOrHeaderName,
 std::optional<StringRef> Group, swift::CompilerInvocation Invocation,
 std::string &ErrorMsg, bool SynthesizedExtensions,
 std::optional<StringRef> InterestedUSR);

static SwiftInterfaceGenContextRef
createForTypeInterface(swift::CompilerInvocation Invocation,
 StringRef TypeUSR,
 std::string &ErrorMsg);

static SwiftInterfaceGenContextRef createForSwiftSource(StringRef DocumentName,
 StringRef SourceFileName,
 ASTUnitRef AstUnit,
 swift::CompilerInvocation Invocation,
 std::string &ErrMsg);

~SwiftInterfaceGenContext();

 StringRef getDocumentName() const;
 StringRef getModuleOrHeaderName() const;
boolisModule() const;
 swift::ModuleDecl *getModuleDecl() const;

boolmatches(StringRef ModuleName, const swift::CompilerInvocation &Invok);

/// Note: requires exclusive access to the underlying AST.
voidreportEditorInfo(EditorConsumer &Consumer) const;

structResolvedEntity {
const swift::ValueDecl *Dcl = nullptr;
 swift::ModuleEntity Mod;
bool IsRef = false;

ResolvedEntity() = default;
ResolvedEntity(const swift::ValueDecl *Dcl, bool IsRef)
 : Dcl(Dcl), IsRef(IsRef) {}
ResolvedEntity(const swift::ModuleEntity Mod, bool IsRef)
 : Mod(Mod), IsRef(IsRef) {}

boolisResolved() const { return Dcl || Mod; }
 };

/// Provides exclusive access to the underlying AST.
voidaccessASTAsync(std::function<void()> Fn);

/// Returns the resolved entity along with a boolean indicating if it is a
/// reference or not.
/// Note: requires exclusive access to the underlying AST. See accessASTAsync.
 ResolvedEntity resolveEntityForOffset(unsigned Offset) const;

/// Searches for a declaration with the given USR and returns the
/// (offset,length) pair into the interface source if it finds one.
 std::optional<std::pair<unsigned, unsigned>>
findUSRRange(StringRef USR) const;

voidapplyTo(swift::CompilerInvocation &CompInvok) const;

classImplementation;

private:
 Implementation &Impl;

SwiftInterfaceGenContext();
};

} // namespace SourceKit

#endif