FrontendAction.h

Go to the documentation of this file.

//===- FrontendAction.h -----------------------------------------*- 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
//
//===----------------------------------------------------------------------===//
//===----------------------------------------------------------------------===//
//
// Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
//
//===----------------------------------------------------------------------===//
 
#ifndef FORTRAN_FRONTEND_FRONTENDACTION_H
#define FORTRAN_FRONTEND_FRONTENDACTION_H
 
#include "flang/Frontend/FrontendOptions.h"
#include "llvm/Support/Error.h"
 
namespace Fortran::frontend {
class CompilerInstance;
 
class FrontendAction {
  FrontendInputFile currentInput;
  CompilerInstance *instance;
 
protected:
 
  virtual void executeAction() = 0;
 
  virtual bool shouldEraseOutputFiles();
 
  virtual bool beginSourceFileAction() { return true; }
 
 
public:
  FrontendAction() : instance(nullptr) {}
  virtual ~FrontendAction() = default;
 
 
  CompilerInstance &getInstance() const {
    assert(instance && "Compiler instance not registered!");
    return *instance;
  }
 
  void setInstance(CompilerInstance *value) { instance = value; }
 
 
  const FrontendInputFile &getCurrentInput() const { return currentInput; }
 
  llvm::StringRef getCurrentFile() const {
    assert(!currentInput.isEmpty() && "No current file!");
    return currentInput.getFile();
  }
 
  llvm::StringRef getCurrentFileOrBufferName() const {
    assert(!currentInput.isEmpty() && "No current file!");
    return currentInput.isFile()
               ? currentInput.getFile()
               : currentInput.getBuffer()->getBufferIdentifier();
  }
  void setCurrentInput(const FrontendInputFile &currentIntput);
 
 
  bool beginSourceFile(CompilerInstance &ci, const FrontendInputFile &input);
 
  llvm::Error execute();
 
  void endSourceFile();
 
protected:
  // Prescan the current input file. Return False if fatal errors are reported,
  // True otherwise.
  bool runPrescan();
  // Parse the current input file. Return False if fatal errors are reported,
  // True otherwise.
  bool runParse(bool emitMessages);
  // Run semantic checks for the current input file. Return False if fatal
  // errors are reported, True otherwise.
  bool runSemanticChecks();
  // Generate run-time type information for derived types. This may lead to new
  // semantic errors. Return False if fatal errors are reported, True
  // otherwise.
  bool generateRtTypeTables();
 
  // Report fatal semantic errors. Return True if present, false otherwise.
  bool reportFatalSemanticErrors();
 
  // Report fatal scanning errors. Return True if present, false otherwise.
  inline bool reportFatalScanningErrors() {
    return reportFatalErrors("Could not scan %0");
  }
 
  // Report fatal parsing errors. Return True if present, false otherwise
  inline bool reportFatalParsingErrors() {
    return reportFatalErrors("Could not parse %0");
  }
 
private:
  template <unsigned N>
  bool reportFatalErrors(const char (&message)[N]);
};
 
} // namespace Fortran::frontend
 
#endif // FORTRAN_FRONTEND_FRONTENDACTION_H