mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
453fd2231b
This includes: - bumping the SWIFT_SYMBOLGRAPH_FORMAT_MINOR version - introduction of the "swift.extension" symbol and "extensionTo" relationship - adding support for ExtensionDecl to the Symbol class - adding a "typeKind" field to the symbol's extension mixin which indicates what kind of symbol was extended - intoduction of the -emit-extension-block-symbols flag, which enables the behavior outlined below - adaptions to SymbolGraphASTWalker that ensure a swift.extension symbol is emitted for each extension to a type that does not exist in the local symbol graph - adaptions to SymbolGraph and SymbolGraphASTWalker that ensure member and conformance relationships are correctly associated with the swift.extension symbol instead of the original type declaration's (extended nominal's) symbol where applicable - adaptions to SymbolGraphASTWalker that ensure swift.extension symbols are connected to their respective extended nominal's symbol using an extensionTo relationship Testing: - adds SymbolGraph tests that test behavior only relevant in -emit-extension-block-symbols mode - adapts some SymbolGraph tests to additionally test similar behavior for extensions to external types in -emit-extension-block-symbols mode - adapts some SymbolGraph tests to (additionally or exclusively) test the behavior with -emit-extension-block-symbols mode enabled Bugfixes: - fixes a bug where some conformsTo relationships implicated by the conformances declared on an extension to an external type were not emitted (see test/SymbolGraph/Relationships/ConformsTo/Indirect.swift) Further changes: - documents the strategy for naming and associating children declared in extensions to typealiases (see test/SymbolGraph/Relationships/MemberOf/Typealias.swift, test/SymbolGraph/Symbols/Names.swift)
62 lines
2.1 KiB
C++
62 lines
2.1 KiB
C++
//===--- SymbolGraphOptions.h - Swift SymbolGraph Options -----------------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/ADT/Triple.h"
|
|
#include "swift/AST/AttrKind.h"
|
|
|
|
#ifndef SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHOPTIONS_H
|
|
#define SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHOPTIONS_H
|
|
|
|
namespace swift {
|
|
namespace symbolgraphgen {
|
|
|
|
struct SymbolGraphOptions {
|
|
/// The directory to output the symbol graph JSON files.
|
|
StringRef OutputDir = {};
|
|
|
|
/// The target of the module.
|
|
llvm::Triple Target = {};
|
|
/// Pretty-print the JSON with newlines and indentation.
|
|
bool PrettyPrint = false;
|
|
|
|
/// The minimum access level that symbols must have in order to be
|
|
/// included in the graph.
|
|
AccessLevel MinimumAccessLevel = AccessLevel::Public;
|
|
|
|
/// Emit members gotten through class inheritance or protocol default
|
|
/// implementations with compound, "SYNTHESIZED" USRs.
|
|
bool EmitSynthesizedMembers = false;
|
|
|
|
/// Whether to print informational messages when rendering
|
|
/// a symbol graph.
|
|
bool PrintMessages = false;
|
|
|
|
/// Whether to skip docs for symbols with compound, "SYNTHESIZED" USRs.
|
|
bool SkipInheritedDocs = false;
|
|
|
|
/// Whether to emit symbols with SPI information.
|
|
bool IncludeSPISymbols = false;
|
|
|
|
/// Whether to include documentation for clang nodes or not.
|
|
bool IncludeClangDocs = false;
|
|
|
|
/// Whether to emit "swift.extension" symbols for extensions to external types
|
|
/// along with "extensionTo" relationships instead of directly associating
|
|
/// members and conformances with the extended nominal.
|
|
bool EmitExtensionBlockSymbols = false;
|
|
};
|
|
|
|
} // end namespace symbolgraphgen
|
|
} // end namespace swift
|
|
|
|
#endif // SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHOPTIONS_H
|