mirror of
https://github.com/apple/swift.git
synced 2026-03-04 18:24:35 +01:00
388052b6ab
Adds a new 'key.retrieve_symbol_graph' option to the request. When set to 1 it includes the JSON for a SymbolGraph containing a single node for the symbol at the requested position. This also extends the SymbolGraph library with a new entry point to get a graph for a single symbol, and to additionally support type substitution to match the existing CursorInfo behavior (e.g. so that when invoked on `first` in `Array<Int>().first`, the type is given as `Int?` rather than `Element?`). Resolves rdar://problem/70551509
70 lines
2.4 KiB
C++
70 lines
2.4 KiB
C++
//===--- JSON.h - Symbol Graph JSON Helpers -------------------------------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
// Adds Symbol Graph JSON serialization to other types.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_SYMBOLGRAPHGEN_JSON_H
|
|
#define SWIFT_SYMBOLGRAPHGEN_JSON_H
|
|
|
|
#include "llvm/ADT/Triple.h"
|
|
#include "llvm/Support/JSON.h"
|
|
#include "llvm/Support/VersionTuple.h"
|
|
#include "swift/AST/GenericSignature.h"
|
|
#include "swift/AST/SubstitutionMap.h"
|
|
#include "swift/AST/Type.h"
|
|
|
|
namespace swift {
|
|
namespace symbolgraphgen {
|
|
|
|
struct AttributeRAII {
|
|
StringRef Key;
|
|
llvm::json::OStream &OS;
|
|
AttributeRAII(StringRef Key, llvm::json::OStream &OS)
|
|
: Key(Key), OS(OS) {
|
|
OS.attributeBegin(Key);
|
|
}
|
|
|
|
~AttributeRAII() {
|
|
OS.attributeEnd();
|
|
}
|
|
};
|
|
|
|
void serialize(const llvm::VersionTuple &VT, llvm::json::OStream &OS);
|
|
void serialize(const llvm::Triple &T, llvm::json::OStream &OS);
|
|
void serialize(const ExtensionDecl *Extension, llvm::json::OStream &OS);
|
|
void serialize(const Requirement &Req, llvm::json::OStream &OS);
|
|
void serialize(const swift::GenericTypeParamType *Param, llvm::json::OStream &OS);
|
|
|
|
void filterGenericParams(
|
|
TypeArrayView<GenericTypeParamType> GenericParams,
|
|
SmallVectorImpl<const GenericTypeParamType*> &FilteredParams,
|
|
SubstitutionMap SubMap = {});
|
|
|
|
/// Filter generic requirements on an extension that aren't relevant
|
|
/// for documentation.
|
|
void filterGenericRequirements(
|
|
ArrayRef<Requirement> Requirements, const NominalTypeDecl *Self,
|
|
SmallVectorImpl<Requirement> &FilteredRequirements,
|
|
SubstitutionMap SubMap = {},
|
|
ArrayRef<const GenericTypeParamType *> FilteredParams = {});
|
|
|
|
/// Filter generic requirements on an extension that aren't relevant
|
|
/// for documentation.
|
|
void
|
|
filterGenericRequirements(const ExtensionDecl *Extension,
|
|
SmallVectorImpl<Requirement> &FilteredRequirements);
|
|
|
|
} // end namespace symbolgraphgen
|
|
} // end namespace swift
|
|
|
|
#endif // SWIFT_SYMBOLGRAPHGEN_JSON_H
|