Revision ac4b68fbf45853ba4b9e327cb42f93f42a8fa252 authored by Ellie Shin on 17 March 2023, 04:14:20 UTC, committed by Ellie Shin on 17 March 2023, 04:14:20 UTC
1 parent f2c68fb
SymbolGraphASTWalker.h
//===--- SymbolGraphASTWalker.h - Symbol Graph AST Walker -----------------===//
//
// 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 SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHASTWALKER_H
#define SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHASTWALKER_H
#include "llvm/ADT/DenseMap.h"
#include "swift/AST/Module.h"
#include "swift/Basic/LLVM.h"
#include "swift/IDE/SourceEntityWalker.h"
#include "swift/Markup/Markup.h"
#include "SymbolGraph.h"
namespace swift {
class Decl;
class Type;
class ValueDecl;
namespace symbolgraphgen {
struct SymbolGraph;
struct SymbolGraphOptions;
/**
The `SymbolGraphASTWalker` is the core implementation that builds a
symbol graph. It walks a module for declarations, recording facts about
symbols and relationships between them.
*/
struct SymbolGraphASTWalker : public SourceEntityWalker {
/// Options for collecting and serialization.
const SymbolGraphOptions &Options;
/// A context for allocations.
markup::MarkupContext Ctx;
/// The module that this symbol graph will represent.
const ModuleDecl &M;
// FIXME: these should be tracked per-graph, rather than at the top level
const SmallPtrSet<ModuleDecl *, 4> ExportedImportedModules;
const llvm::SmallDenseMap<ModuleDecl *, SmallPtrSet<Decl *, 4>, 4> QualifiedExportedImports;
/// The symbol graph for the main module of interest.
SymbolGraph MainGraph;
/// A map of modules whose types were extended by the main module of interest `M`.
llvm::StringMap<SymbolGraph *> ExtendedModuleGraphs;
// MARK: - Initialization
SymbolGraphASTWalker(ModuleDecl &M,
const SmallPtrSet<ModuleDecl *, 4> ExportedImportedModules,
const llvm::SmallDenseMap<ModuleDecl *, SmallPtrSet<Decl *, 4>, 4> QualifiedExportedImports,
const SymbolGraphOptions &Options);
virtual ~SymbolGraphASTWalker() {}
// MARK: - Utilities
/// Get a "sub" symbol graph for the appropriate module concerning a declaration.
///
/// This will get the "rootmost" module responsible for a declaration's
/// documentation. For example:
///
/// Module A:
///
/// ```swift
/// public struct AStruct {}
/// ```
///
/// Module B:
///
/// ```swift
/// import A
/// extension AStruct {
/// public struct BStruct {}
/// }
///
/// `BStruct` will go in module A's extension symbol graph, because `BStruct`
/// is a member of `AStruct`, and module A owns `AStruct`, and so on for
/// further nestings.
SymbolGraph *getModuleSymbolGraph(const Decl *D);
// MARK: - SourceEntityWalker
virtual bool walkToDeclPre(Decl *D, CharSourceRange Range) override;
// MARK: - Utilities
/// Returns whether the given declaration was itself imported via an `@_exported import`
/// statement, or if it is an extension or child symbol of something else that was.
virtual bool isConsideredExportedImported(const Decl *D) const;
/// Returns whether the given declaration comes from an `@_exported import` module.
virtual bool isFromExportedImportedModule(const Decl *D) const;
/// Returns whether the given declaration was imported via an `@_exported import <type>` declaration.
virtual bool isQualifiedExportedImport(const Decl *D) const;
/// Returns whether the given module is an `@_exported import` module.
virtual bool isExportedImportedModule(const ModuleDecl *M) const;
/// Returns whether the given module is the main module, or is an `@_exported import` module.
virtual bool isOurModule(const ModuleDecl *M) const;
public:
/// Returns whether the given ExtensionDecl is to be recorded as an extra
/// extension block symbol, or if its members should be directly associated
/// with its extended nominal.
virtual bool shouldBeRecordedAsExtension(const ExtensionDecl *ED) const;
};
} // end namespace symbolgraphgen
} // end namespace swift
#endif // SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHASTWALKER_H
Computing file changes ...