mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
2a860100a5
This patch allows SourceKit to generate the interface for a given type specified by its mangled name. Type interface is refined decl printing with type parameters localized and unusable members hidden. Required field: "key.request": "source.request.editor.open.interface.swifttype" "key.usr": the mangled name of the given type.
86 lines
3.0 KiB
C++
86 lines
3.0 KiB
C++
//===--- ModuleInterfacePrinting.h - Routines to print module interface ---===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See http://swift.org/LICENSE.txt for license information
|
|
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_IDE_MODULE_INTERFACE_PRINTING_H
|
|
#define SWIFT_IDE_MODULE_INTERFACE_PRINTING_H
|
|
|
|
#include "swift/Basic/LLVM.h"
|
|
#include "swift/Basic/OptionSet.h"
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace swift {
|
|
class ASTContext;
|
|
class ASTPrinter;
|
|
class ModuleDecl;
|
|
class SourceFile;
|
|
class Type;
|
|
struct PrintOptions;
|
|
|
|
namespace ide {
|
|
|
|
/// Flags used when traversing a module for printing.
|
|
enum class ModuleTraversal : unsigned {
|
|
/// Visit modules even if their contents wouldn't be visible to name lookup.
|
|
VisitHidden = 0x01,
|
|
/// Visit submodules.
|
|
VisitSubmodules = 0x02,
|
|
/// Skip the declarations in a Swift overlay module.
|
|
SkipOverlay = 0x04,
|
|
};
|
|
|
|
/// Options used to describe the traversal of a module for printing.
|
|
typedef OptionSet<ModuleTraversal> ModuleTraversalOptions;
|
|
|
|
ArrayRef<StringRef> collectModuleGroups(ModuleDecl *M,
|
|
std::vector<StringRef> &Scratch);
|
|
|
|
Optional<StringRef>
|
|
findGroupNameForUSR(ModuleDecl *M, StringRef USR);
|
|
|
|
bool printTypeInterface(ModuleDecl *M, Type Ty, ASTPrinter &Printer,
|
|
std::string &TypeName, std::string &Error);
|
|
|
|
bool printTypeInterface(ModuleDecl *M, StringRef TypeUSR, ASTPrinter &Printer,
|
|
std::string &TyepName, std::string &Error);
|
|
|
|
void printModuleInterface(ModuleDecl *M, Optional<StringRef> Group,
|
|
ModuleTraversalOptions TraversalOptions,
|
|
ASTPrinter &Printer, const PrintOptions &Options,
|
|
const bool PrintSynthesizedExtensions);
|
|
|
|
// FIXME: this API should go away when Swift can represent Clang submodules as
|
|
// 'swift::Module *' objects.
|
|
void printSubmoduleInterface(ModuleDecl *M, ArrayRef<StringRef> FullModuleName,
|
|
ArrayRef<StringRef> GroupNames,
|
|
ModuleTraversalOptions TraversalOptions,
|
|
ASTPrinter &Printer, const PrintOptions &Options,
|
|
const bool PrintSynthesizedExtensions);
|
|
|
|
/// Print the interface for a header that has been imported via the implicit
|
|
/// objc header importing feature.
|
|
void printHeaderInterface(StringRef Filename, ASTContext &Ctx,
|
|
ASTPrinter &Printer, const PrintOptions &Options);
|
|
|
|
|
|
/// Print the interface for a given swift source file.
|
|
void printSwiftSourceInterface(SourceFile &File, ASTPrinter &Printer,
|
|
const PrintOptions &Options);
|
|
|
|
} // namespace ide
|
|
|
|
} // namespace swift
|
|
|
|
#endif // SWIFT_IDE_MODULE_INTERFACE_PRINTING_H
|
|
|