mlir/tools/mlir-tblgen/DocGenUtilities.h

   1 //===- DocGenUtilities.h - MLIR doc gen utilities ---------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This file defines common utilities for generating documents from tablegen
  10 // structures.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef MLIR_TOOLS_MLIRTBLGEN_DOCGENUTILITIES_H_
  15 #define MLIR_TOOLS_MLIRTBLGEN_DOCGENUTILITIES_H_
  16
  17 #include "llvm/ADT/StringRef.h"
  18
  19 namespace llvm {
  20 class raw_ostream;
  21 } // namespace llvm
  22
  23 namespace mlir {
  24 namespace tblgen {
  25
  26 // Emit the summary. To avoid confusion, the summary is styled differently from
  27 // the description.
  28 void emitSummary(llvm::StringRef summary, llvm::raw_ostream &os);
  29
  30 // Emit the description by aligning the text to the left per line (e.g.
  31 // removing the minimum indentation across the block).
  32 //
  33 // This expects that the description in the tablegen file is already formatted
  34 // in a way the user wanted but has some additional indenting due to being
  35 // nested.
  36 void emitDescription(llvm::StringRef description, llvm::raw_ostream &os);
  37
  38 // Emit the description as a C++ comment while realigning it.
  39 void emitDescriptionComment(llvm::StringRef description, llvm::raw_ostream &os,
  40                             llvm::StringRef prefix = "");
  41
  42 } // namespace tblgen
  43 } // namespace mlir
  44
  45 #endif // MLIR_TOOLS_MLIRTBLGEN_DOCGENUTILITIES_H_