blob: e5d491e2a720b6c4ee77534d66e61aa437782af7 [file] [log] [blame]
//===--- SymbolGraphGen.h - Swift SymbolGraph Generator -------------------===//
//
// 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_SYMBOLGRAPHGEN_H
#define SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHGEN_H
#include "swift/AST/Module.h"
#include "swift/AST/Type.h"
#include "SymbolGraphOptions.h"
namespace swift {
class ValueDecl;
namespace symbolgraphgen {
/// Emit a Symbol Graph JSON file for a module.
int emitSymbolGraphForModule(ModuleDecl *M, const SymbolGraphOptions &Options);
/// Print a Symbol Graph containing a single node for the given decl.
///
/// \returns \c EXIT_SUCCESS if the kind of the provided node is supported and
/// its Symbo lGraph was printed, or \c EXIT_FAILURE otherwise.
int printSymbolGraphForDecl(const ValueDecl *D, Type BaseTy,
bool InSynthesizedExtensions,
const SymbolGraphOptions &Options,
llvm::raw_ostream &OS);
} // end namespace symbolgraphgen
} // end namespace swift
#endif // SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHGEN_H