Lines Matching +full:build +full:- +full:docs
6 [LSP](https://microsoft.github.io/language-server-protocol/) IDE language
7 extensions for various MLIR-related languages. An LSP language extension is
14 ## MLIR LSP Language Server : `mlir-lsp-server`
17 in the form of the `mlir-lsp-server` tool. This tool interacts with the MLIR C++
22 `mlir-lsp-server`, like many other MLIR based tools, relies on having the
24 formats used in the textual .mlir files. The `mlir-lsp-server` found within the
26 Downstream and out-of-tree users will need to provide a custom
27 `mlir-lsp-server` executable that registers the entities that they are
28 interested in. The implementation of `mlir-lsp-server` is provided as a library,
33 #include "mlir/Tools/mlir-lsp-server/MlirLspServerMain.h"
42 See the [Editor Plugins](#editor-plugins) section below for details on how to
56 any generated diagnostics in-place.
58 
60 ##### Automatically insert `expected-` diagnostic checks
63 [infrastructure](https://mlir.llvm.org/docs/Diagnostics/#sourcemgr-diagnostic-verifier-handler)
68 
76 
78 #### Cross-references
89 - SSA Values
91 
93 - Symbol References
95 
101 
107 
115 
123 
131 
133 ## PDLL LSP Language Server : `mlir-pdll-lsp-server`
136 in the form of the `mlir-pdll-lsp-server` tool. This tool interacts with the
143 [`clangd`](https://clang.llvm.org/docs/JSONCompilationDatabase.html), and
145 server relies on a compilation database to provide build-system information for
159 --- !FileInfo:
164 - filepath: <string> - Absolute file path of the file.
165 - includes: <string> - Semi-colon delimited list of absolute include
168 #### Build System Integration
171 `pdll_compile_commands.yml` and placed at the top of the build directory. When
186 generated diagnostics in-place.
188 
197 
199 #### Cross-references
207 
212 
218 
225 
230 
237 
246 
251 Editors usually render this using read-only virtual text snippets interspersed
254 - types of local variables
255 - names of operand and result groups
256 - constraint and rewrite arguments
258 
260 ## TableGen LSP Language Server : `tblgen-lsp-server`
263 in the form of the `tblgen-lsp-server` tool. This tool interacts with the
269 [`clangd`](https://clang.llvm.org/docs/JSONCompilationDatabase.html), and
271 server relies on a compilation database to provide build-system information for
285 --- !FileInfo:
290 - filepath: <string> - Absolute file path of the file.
291 - includes: <string> - Semi-colon delimited list of absolute include
294 #### Build System Integration
297 `tablegen_compile_commands.yml` and placed at the top of the build directory.
312 generated diagnostics in-place.
314 
316 #### Cross-references
324 
330 
337 
342 
349 - Communication and Transport (via JSON-RPC)
350 - Language Server Protocol
351 - Language-Specific Server
353 
357 The language server, such as `mlir-lsp-server`, communicates with the language
358 client via JSON-RPC over stdin/stdout. In the code, this is the `JSONTransport`
360 knows that JSON-RPC messages are coming in and JSON-RPC messages are going out.
372 [`Language-Specific Server`](#language-specific-server) for processing. The
374 from the LSP world to the language-specific world (e.g. MLIR, PDLL, etc.). In
376 `Language-Specific Server`. In some cases, however, the impedance mismatch
379 ### Language-Specific Server
395 …extension](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-mlir)
397 languages: [MLIR](#mlir---mlir-textual-assembly-format),
398 [PDLL](#pdll---mlir-pdll-pattern-files), and [TableGen](#td---tablegen-files)
400 #### `.mlir` - MLIR textual assembly format:
403 [MLIR textual assembly format](https://mlir.llvm.org/docs/LangRef/):
407 - Syntax highlighting for `.mlir` files and `mlir` markdown blocks
408 - go-to-definition and cross references
409 - Detailed information when hovering over IR entities
410 - Outline and navigation of symbols and symbol tables
411 - Code completion
412 - Live parser and verifier diagnostics
414 [mlir-vscode features]: #
418 ###### `mlir-lsp-server`
421 [`mlir-lsp-server` language server](https://mlir.llvm.org/docs/Tools/MLIRLSP/#mlir-lsp-language-ser…
422 If `mlir-lsp-server` is not found within your workspace path, you must specify
426 #### `.pdll` - MLIR PDLL pattern files:
429 [PDLL pattern language](https://mlir.llvm.org/docs/PDLL/).
433 - Syntax highlighting for `.pdll` files and `pdll` markdown blocks
434 - go-to-definition and cross references
435 - Types and documentation on hover
436 - Code completion and signature help
437 - View intermediate AST, MLIR, or C++ output
439 [pdll-vscode features]: #
443 ###### `mlir-pdll-lsp-server`
446 [`mlir-pdll-lsp-server` language server](https://mlir.llvm.org/docs/Tools/MLIRLSP/#pdll-lsp-languag…
447 If `mlir-pdll-lsp-server` is not found within your workspace path, you must
455 [`pdll_compile_commands.yml` files](https://mlir.llvm.org/docs/Tools/MLIRLSP/#compilation-database)
457 processed. These files can usually be generated by the build system, and the
458 server will attempt to find them within your `build/` directory. If not
463 #### `.td` - TableGen files:
466 [TableGen language](https://llvm.org/docs/TableGen/ProgRef.html).
470 - Syntax highlighting for `.td` files and `tablegen` markdown blocks
471 - go-to-definition and cross references
472 - Types and documentation on hover
474 [tablegen-vscode features]: #
478 ###### `tblgen-lsp-server`
481 [`tblgen-lsp-server` language server](https://mlir.llvm.org/docs/Tools/MLIRLSP/#tablegen-lsp-langua…
482 If `tblgen-lsp-server` is not found within your workspace path, you must specify
490 …egen_compile_commands.yml` files](https://mlir.llvm.org/docs/Tools/MLIRLSP/#compilation-database-1)
492 processed. These files can usually be generated by the build system, and the
493 server will attempt to find them within your `build/` directory. If not
501 [LLVM monorepo](https://github.com/llvm/llvm-project), at
502 [`mlir/utils/vscode`](https://github.com/llvm/llvm-project/tree/main/mlir/utils/vscode).
504 [normal LLVM guidelines](https://llvm.org/docs/Contributing.html), with code
506 [GitHub](https://llvm.org/docs/Contributing.html#how-to-submit-a-patch).
511 - Copy `mlir/utils/textmate/mlir.json` to the extension directory and rename to
513 - Copy `llvm/utils/textmate/tablegen.json` to the extension directory and rename
514 to `tablegen-grammar.json`.
515 - Copy
516 `https://mlir.llvm.org//LogoAssets/logo/PNG/full_color/mlir-identity-03.png`