//===--- 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"
#include "PathComponent.h"
#include "FragmentInfo.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 to \p OS.
/// The \p ParentContexts out parameter will also be populated with information
/// about each parent context of the given decl, from outermost to innermost.
///
/// \returns \c EXIT_SUCCESS if the kind of the provided node is supported or
/// \c EXIT_FAILURE otherwise.
int printSymbolGraphForDecl(const ValueDecl *D, Type BaseTy,
                            bool InSynthesizedExtension,
                            const SymbolGraphOptions &Options,
                            llvm::raw_ostream &OS,
                            SmallVectorImpl<PathComponent> &ParentContexts,
                            SmallVectorImpl<FragmentInfo> &FragmentInfo);

} // end namespace symbolgraphgen
} // end namespace swift

#endif // SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHGEN_H