mlir/test/mlir-tblgen/gen-dialect-doc.td

   1 // RUN: mlir-tblgen -gen-dialect-doc -I %S/../../include -dialect=test %s | FileCheck %s
   2 // RUN: mlir-tblgen -gen-dialect-doc -I %S/../../include -dialect=test_toc %s | FileCheck %s --check-prefix=CHECK_TOC
   3
   4 include "mlir/IR/OpBase.td"
   5 include "mlir/IR/AttrTypeBase.td"
   6 include "mlir/IR/EnumAttr.td"
   7 include "mlir/Interfaces/SideEffectInterfaces.td"
   8
   9 def Test_Dialect : Dialect {
  10   let name = "test";
  11   let summary = "Dialect of ops to test";
  12   let description = [{
  13     Dialect without a [TOC] here.
  14     TOC added by tool.
  15   }];
  16   let cppNamespace = "NS";
  17 }
  18
  19 def OpGroupA : OpDocGroup {
  20   let summary = "Group of ops";
  21   let description = "Grouped for some reason.";
  22 }
  23
  24 let opDocGroup = OpGroupA in {
  25 def ADOp : Op<Test_Dialect, "d", [NoMemoryEffect, SingleBlockImplicitTerminator<"YieldOp">]>;
  26 def AAOp : Op<Test_Dialect, "a", [NoMemoryEffect, SingleBlockImplicitTerminator<"YieldOp">]>;
  27 }
  28
  29 def OpGroupB : OpDocGroup {
  30   let summary = "Other group of ops";
  31   let description = "Grouped for some other reason.";
  32 }
  33
  34 let opDocGroup = OpGroupB in {
  35 def ACOp : Op<Test_Dialect, "c", [NoMemoryEffect, SingleBlockImplicitTerminator<"YieldOp">]>;
  36 def ABOp : Op<Test_Dialect, "b", [NoMemoryEffect, SingleBlockImplicitTerminator<"YieldOp">]>;
  37 }
  38
  39 def AEOp : Op<Test_Dialect, "e", [NoMemoryEffect, SingleBlockImplicitTerminator<"YieldOp">]>;
  40
  41 def TestAttr : DialectAttr<Test_Dialect, CPred<"true">> {
  42   let summary = "attribute summary";
  43   let description = "attribute description";
  44 }
  45
  46 def TestType : DialectType<Test_Dialect, CPred<"true">> {
  47   let summary = "type summary";
  48   let description = "type description";
  49 }
  50
  51 def TestAttrDef : AttrDef<Test_Dialect, "TestAttrDef"> {
  52   let mnemonic = "test_attr_def";
  53 }
  54
  55 def TestAttrDefParams : AttrDef<Test_Dialect, "TestAttrDefParams"> {
  56   let mnemonic = "test_attr_def_params";
  57   let parameters = (ins "int":$value);
  58
  59   let assemblyFormat = "`<` $value `>`";
  60 }
  61
  62 def TestTypeDef : TypeDef<Test_Dialect, "TestTypeDef"> {
  63   let mnemonic = "test_type_def";
  64 }
  65
  66 def TestTypeDefParams : TypeDef<Test_Dialect, "TestTypeDefParams"> {
  67   let mnemonic = "test_type_def_params";
  68   let parameters = (ins "int":$value);
  69
  70   let assemblyFormat = "`<` $value `>`";
  71 }
  72
  73 def TestEnum :
  74     I32EnumAttr<"TestEnum",
  75         "enum summary", [
  76         I32EnumAttrCase<"First", 0, "first">,
  77         I32EnumAttrCase<"Second", 1, "second">,
  78         I32EnumAttrCase<"Third", 2, "third">]> {
  79   let genSpecializedAttr = 1;
  80   let cppNamespace = "NS";
  81 }
  82
  83 // CHECK: Dialect without a [TOC] here.
  84 // CHECK: TOC added by tool.
  85 // CHECK: [TOC]
  86
  87 // CHECK-NOT: [TOC]
  88 // CHECK: test.e
  89 // CHECK: Group of ops
  90 // CHECK: test.a
  91 // CHECK: test.d
  92 // CHECK: Other group
  93 // CHECK: test.b
  94 // CHECK: test.c
  95 // CHECK: Traits: `SingleBlockImplicitTerminator<YieldOp>`, `SingleBlock`
  96 // CHECK: Interfaces: `NoMemoryEffect (MemoryEffectOpInterface)`
  97 // CHECK: Effects: `MemoryEffects::Effect{}`
  98
  99 // CHECK: ## Attribute constraints
 100 // CHECK: ### attribute summary
 101 // CHECK: attribute description
 102
 103 // CHECK: TestAttrDefAttr
 104 // CHECK: Syntax:
 105 // CHECK: #test.test_attr_def
 106
 107 // CHECK: TestAttrDefParamsAttr
 108 // CHECK: Syntax:
 109 // CHECK: #test.test_attr_def_params
 110
 111 // CHECK: ## Type constraints
 112 // CHECK: ### type summary
 113 // CHECK: type description
 114
 115 // CHECK: TestTypeDefType
 116 // CHECK: Syntax:
 117 // CHECK: !test.test_type_def
 118
 119 // CHECK: TestTypeDefParamsType
 120 // CHECK: Syntax:
 121 // CHECK: !test.test_type_def_params
 122
 123 // CHECK: ## Enums
 124 // CHECK: ### TestEnum
 125 // CHECK: enum summary
 126 // CHECK: #### Cases:
 127 // CHECK: | Symbol | Value | String |
 128 // CHECK: | :----: | :---: | ------ |
 129 // CHECK: | First | `0` | first |
 130 // CHECK: | Second | `1` | second |
 131 // CHECK: | Third | `2` | third |
 132
 133 def Toc_Dialect : Dialect {
 134   let name = "test_toc";
 135   let summary = "Dialect of ops to test";
 136   let description = [{
 137     Dialect with
 138
 139     [TOC]
 140
 141     here.
 142   }];
 143   let cppNamespace = "NS";
 144 }
 145 def BOp : Op<Toc_Dialect, "b", []>;
 146
 147 // CHECK_TOC: Dialect with
 148 // CHECK_TOC: [TOC]
 149 // CHECK_TOC: here.