KindMapping.h

//===-- Optimizer/Support/KindMapping.h -- support kind mapping -*- 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_OPTIMIZER_SUPPORT_KINDMAPPING_H
#define FORTRAN_OPTIMIZER_SUPPORT_KINDMAPPING_H
 
#include "mlir/IR/OpDefinition.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/IR/Type.h"
 
namespace llvm {
struct fltSemantics;
} // namespace llvm
 
namespace fir {
 
class KindMapping {
public:
  using KindTy = unsigned;
  using Bitsize = unsigned;
  using LLVMTypeID = llvm::Type::TypeID;
  using MatchResult = mlir::ParseResult;
 
  explicit KindMapping(mlir::MLIRContext *context);
  explicit KindMapping(mlir::MLIRContext *context, llvm::ArrayRef<KindTy> defs);
  explicit KindMapping(mlir::MLIRContext *context, llvm::StringRef map,
                       llvm::ArrayRef<KindTy> defs = std::nullopt);
  explicit KindMapping(mlir::MLIRContext *context, llvm::StringRef map,
                       llvm::StringRef defs)
      : KindMapping{context, map, toDefaultKinds(defs)} {}
 
  Bitsize getCharacterBitsize(KindTy kind) const;
 
  Bitsize getIntegerBitsize(KindTy kind) const;
 
  Bitsize getLogicalBitsize(KindTy kind) const;
 
  Bitsize getRealBitsize(KindTy kind) const;
 
  LLVMTypeID getRealTypeID(KindTy kind) const;
 
  LLVMTypeID getComplexTypeID(KindTy kind) const;
 
  mlir::MLIRContext *getContext() const { return context; }
 
  const llvm::fltSemantics &getFloatSemantics(KindTy kind) const;
 
  static constexpr const char *getDefaultMap() { return ""; }
 
  std::string mapToString() const;
 
  //===--------------------------------------------------------------------===//
  // Default kinds of intrinsic types
  //===--------------------------------------------------------------------===//
 
  KindTy defaultCharacterKind() const;
  KindTy defaultComplexKind() const;
  KindTy defaultDoubleKind() const;
  KindTy defaultIntegerKind() const;
  KindTy defaultLogicalKind() const;
  KindTy defaultRealKind() const;
 
  static constexpr const char *getDefaultKinds() { return "a1c4d8i4l4r4"; }
 
  std::string defaultsToString() const;
 
  static std::vector<KindTy> toDefaultKinds(llvm::StringRef defs);
 
private:
  MatchResult badMapString(const llvm::Twine &ptr);
  MatchResult parse(llvm::StringRef kindMap);
  llvm::LogicalResult setDefaultKinds(llvm::ArrayRef<KindTy> defs);
 
  mlir::MLIRContext *context;
  llvm::DenseMap<std::pair<char, KindTy>, Bitsize> intMap;
  llvm::DenseMap<std::pair<char, KindTy>, LLVMTypeID> floatMap;
  llvm::DenseMap<char, KindTy> defaultMap;
};
 
} // namespace fir
 
#endif // FORTRAN_OPTIMIZER_SUPPORT_KINDMAPPING_H