cea33304c0
* Add spec generation to offload-tblgen tool * This patch adds generation of Sphinx compatible reStructuedText utilizing the C domain to document the Offload API directly from the spec definition `.td` files. * Add Sphinx HTML documentation target * Introduces the `docs-offload-html` target when CMake is configured with `LLVM_ENABLE_SPHINX=ON` and `SPHINX_OUTPUT_HTML=ON`. Utilized `offload-tblgen -gen-spen` to generate Offload API specification docs.
73 lines
2.0 KiB
C++
73 lines
2.0 KiB
C++
//===- offload-tblgen/GenCommon.cpp - Common defs for Offload generators --===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#pragma once
|
|
|
|
#include "RecordTypes.hpp"
|
|
#include "llvm/Support/FormatVariadic.h"
|
|
|
|
// Having inline bits of tabbed code is hard to read, provide some definitions
|
|
// so we can keep things tidier
|
|
#define TAB_1 " "
|
|
#define TAB_2 " "
|
|
#define TAB_3 " "
|
|
#define TAB_4 " "
|
|
#define TAB_5 " "
|
|
|
|
constexpr auto GenericHeader =
|
|
R"(//===- Auto-generated file, part of the LLVM/Offload project --------------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
)";
|
|
|
|
constexpr auto FileHeader = R"(
|
|
// Auto-generated file, do not manually edit.
|
|
|
|
#pragma once
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
)";
|
|
|
|
constexpr auto FileFooter = R"(
|
|
#if defined(__cplusplus)
|
|
} // extern "C"
|
|
#endif
|
|
|
|
)";
|
|
|
|
constexpr auto CommentsHeader = R"(
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
)";
|
|
|
|
constexpr auto CommentsBreak = "///\n";
|
|
|
|
constexpr auto PrefixLower = "ol";
|
|
constexpr auto PrefixUpper = "OL";
|
|
|
|
inline std::string
|
|
MakeParamComment(const llvm::offload::tblgen::ParamRec &Param) {
|
|
return llvm::formatv("// {0}{1}{2} {3}", (Param.isIn() ? "[in]" : ""),
|
|
(Param.isOut() ? "[out]" : ""),
|
|
(Param.isOpt() ? "[optional]" : ""), Param.getDesc());
|
|
}
|
|
|
|
inline std::string
|
|
getHandleImplName(const llvm::offload::tblgen::HandleRec &H) {
|
|
return (H.getName().substr(0, H.getName().size() - 9) + "_impl_t").str();
|
|
}
|