1c3320cdde
Adds a JSON generator backend to emit mapped information as JSON. This will enable a better testing format for upcoming changes. It can also potentially serve to feed our other backend generators in the future, like Mustache which already serializes information to JSON before emitting as HTML. This patch contains functionality to emit classes and provides most of the basis of the generator.
71 lines
2.5 KiB
C++
71 lines
2.5 KiB
C++
//===-- Generators.h - ClangDoc Generator ----------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
// Generator classes for converting declaration information into documentation
|
|
// in a specified format.
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_GENERATOR_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_GENERATOR_H
|
|
|
|
#include "Representation.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/Registry.h"
|
|
|
|
namespace clang {
|
|
namespace doc {
|
|
|
|
// Abstract base class for generators.
|
|
// This is expected to be implemented and exposed via the GeneratorRegistry.
|
|
class Generator {
|
|
public:
|
|
virtual ~Generator() = default;
|
|
|
|
// Write out the decl info for the objects in the given map in the specified
|
|
// format.
|
|
virtual llvm::Error
|
|
generateDocs(StringRef RootDir,
|
|
llvm::StringMap<std::unique_ptr<doc::Info>> Infos,
|
|
const ClangDocContext &CDCtx) = 0;
|
|
|
|
// This function writes a file with the index previously constructed.
|
|
// It can be overwritten by any of the inherited generators.
|
|
// If the override method wants to run this it should call
|
|
// Generator::createResources(CDCtx);
|
|
virtual llvm::Error createResources(ClangDocContext &CDCtx);
|
|
|
|
// Write out one specific decl info to the destination stream.
|
|
virtual llvm::Error generateDocForInfo(Info *I, llvm::raw_ostream &OS,
|
|
const ClangDocContext &CDCtx) = 0;
|
|
|
|
static void addInfoToIndex(Index &Idx, const doc::Info *Info);
|
|
};
|
|
|
|
typedef llvm::Registry<Generator> GeneratorRegistry;
|
|
|
|
llvm::Expected<std::unique_ptr<Generator>>
|
|
findGeneratorByName(llvm::StringRef Format);
|
|
|
|
std::string getTagType(TagTypeKind AS);
|
|
|
|
// This anchor is used to force the linker to link in the generated object file
|
|
// and thus register the generators.
|
|
extern volatile int YAMLGeneratorAnchorSource;
|
|
extern volatile int MDGeneratorAnchorSource;
|
|
extern volatile int HTMLGeneratorAnchorSource;
|
|
extern volatile int MHTMLGeneratorAnchorSource;
|
|
extern volatile int JSONGeneratorAnchorSource;
|
|
|
|
} // namespace doc
|
|
} // namespace clang
|
|
|
|
namespace llvm {
|
|
extern template class Registry<clang::doc::Generator>;
|
|
} // namespace llvm
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_DOC_GENERATOR_H
|