Mangler.h

//===-- Lower/Mangler.h -- name mangling ------------------------*- 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_LOWER_MANGLER_H
#define FORTRAN_LOWER_MANGLER_H
 
#include "flang/Evaluate/expression.h"
#include "flang/Optimizer/Dialect/FIRType.h"
#include "llvm/ADT/StringRef.h"
#include <string>
 
namespace Fortran {
namespace common {
template <typename>
class Reference;
}
 
namespace semantics {
class Scope;
class Symbol;
class DerivedTypeSpec;
} // namespace semantics
 
namespace lower::mangle {
 
using ScopeBlockIdMap =
    llvm::DenseMap<Fortran::semantics::Scope *, std::int64_t>;

std::string mangleName(const semantics::Symbol &, ScopeBlockIdMap &,
                       bool keepExternalInScope = false,
                       bool underscoring = true);
std::string mangleName(const semantics::Symbol &,
                       bool keepExternalInScope = false,
                       bool underscoring = true);

std::string mangleName(const semantics::DerivedTypeSpec &, ScopeBlockIdMap &);

std::string mangleName(std::string &, const Fortran::semantics::Scope &,
                       ScopeBlockIdMap &);

std::string demangleName(llvm::StringRef name);
 
std::string
mangleArrayLiteral(size_t size,
                   const Fortran::evaluate::ConstantSubscripts &shape,
                   Fortran::common::TypeCategory cat, int kind = 0,
                   Fortran::common::ConstantSubscript charLen = -1,
                   llvm::StringRef derivedName = {});
 
template <Fortran::common::TypeCategory TC>
std::string mangleArrayLiteral(
    mlir::Type,
    const Fortran::evaluate::Constant<Fortran::evaluate::Type<TC>> &x) {
  const int kind{x.kind()};
  return mangleArrayLiteral(x.values().size() * sizeof(x.values()[0]),
                            x.shape(), TC, kind);
}
 
inline std::string mangleArrayLiteral(
    mlir::Type,
    const Fortran::evaluate::Constant<
        Fortran::evaluate::Type<Fortran::common::TypeCategory::Character>> &x) {
  const int kind{x.kind()};
  return mangleArrayLiteral(x.values().size() * sizeof(x.values()[0]),
                            x.shape(), Fortran::common::TypeCategory::Character,
                            kind, x.LEN());
}
 
inline std::string mangleArrayLiteral(
    mlir::Type eleTy,
    const Fortran::evaluate::Constant<Fortran::evaluate::SomeDerived> &x) {
  return mangleArrayLiteral(x.values().size() * sizeof(x.values()[0]),
                            x.shape(), Fortran::common::TypeCategory::Derived,
                            /*kind=*/0, /*charLen=*/-1,
                            mlir::cast<fir::RecordType>(eleTy).getName());
}

std::string globalNamelistDescriptorName(const Fortran::semantics::Symbol &sym);

std::string getRecordTypeFieldName(const Fortran::semantics::Symbol &component,
                                   ScopeBlockIdMap &);
 
} // namespace lower::mangle
} // namespace Fortran
 
#endif // FORTRAN_LOWER_MANGLER_H