Parser.h

Go to the documentation of this file.

//===- Parser.h - MLIR PDLL Frontend Parser ---------------------*- 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
//
//===----------------------------------------------------------------------===//
 
#ifndef MLIR_TOOLS_PDLL_PARSER_PARSER_H_
#define MLIR_TOOLS_PDLL_PARSER_PARSER_H_
 
#include <memory>
 
#include "mlir/Support/LogicalResult.h"
 
namespace llvm {
class SourceMgr;
} // namespace llvm
 
namespace mlir {
namespace pdll {
class CodeCompleteContext;
 
namespace ast {
class Context;
class Module;
} // namespace ast
 
/// Parse an AST module from the main file of the given source manager.
/// `enableDocumentation` is an optional flag that, when set, indicates that the
/// parser should also include documentation when building the AST when
/// possible. `codeCompleteContext` is an optional code completion context that
/// may be provided to receive code completion suggestions. If a completion is
/// hit, this method returns a failure.
FailureOr<ast::Module *>
parsePDLLAST(ast::Context &ctx, llvm::SourceMgr &sourceMgr,
             bool enableDocumentation = false,
             CodeCompleteContext *codeCompleteContext = nullptr);
} // namespace pdll
} // namespace mlir
 
#endif // MLIR_TOOLS_PDLL_PARSER_PARSER_H_