llvm-project/lldb/source/Plugins/Language/CPlusPlus/CPlusPlusLanguage.h

//===-- CPlusPlusLanguage.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
//
//===----------------------------------------------------------------------===//

#ifndef LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H
#define LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H

#include <set>
#include <vector>

#include "llvm/ADT/StringRef.h"

#include "Plugins/Language/ClangCommon/ClangHighlighter.h"
#include "lldb/Target/Language.h"
#include "lldb/Utility/ConstString.h"
#include "lldb/lldb-private.h"

namespace lldb_private {

class CPlusPlusLanguage : public Language {
  ClangHighlighter m_highlighter;

public:
  class CxxMethodName : public Language::MethodName {
  public:
    CxxMethodName(ConstString s) : Language::MethodName(s) {}

    bool ContainsPath(llvm::StringRef path);

  private:
    /// Returns the Basename of this method without a template parameter
    /// list, if any.
    ///
    // Examples:
    //
    //   +--------------------------------+---------+
    //   | MethodName                     | Returns |
    //   +--------------------------------+---------+
    //   | void func()                    | func    |
    //   | void func<int>()               | func    |
    //   | void func<std::vector<int>>()  | func    |
    //   +--------------------------------+---------+
    llvm::StringRef GetBasenameNoTemplateParameters();

  protected:
    void Parse() override;
    bool TrySimplifiedParse();
  };

  CPlusPlusLanguage() = default;

  ~CPlusPlusLanguage() override = default;

  virtual std::unique_ptr<Language::MethodName>
  GetMethodName(ConstString name) const override;

  std::pair<lldb::FunctionNameType, std::optional<ConstString>>
  GetFunctionNameInfo(ConstString name) const override;

  lldb::LanguageType GetLanguageType() const override {
    return lldb::eLanguageTypeC_plus_plus;
  }

  llvm::StringRef GetUserEntryPointName() const override { return "main"; }

  std::unique_ptr<TypeScavenger> GetTypeScavenger() override;
  lldb::TypeCategoryImplSP GetFormatters() override;

  HardcodedFormatters::HardcodedSummaryFinder GetHardcodedSummaries() override;

  HardcodedFormatters::HardcodedSyntheticFinder
  GetHardcodedSynthetics() override;

  bool IsNilReference(ValueObject &valobj) override;

  llvm::StringRef GetNilReferenceSummaryString() override { return "nullptr"; }

  bool IsSourceFile(llvm::StringRef file_path) const override;

  const Highlighter *GetHighlighter() const override { return &m_highlighter; }

  // Static Functions
  static void Initialize();

  static void Terminate();

  static lldb_private::Language *CreateInstance(lldb::LanguageType language);

  static llvm::StringRef GetPluginNameStatic() { return "cplusplus"; }

  bool SymbolNameFitsToLanguage(const Mangled &mangled) const override;

  bool DemangledNameContainsPath(llvm::StringRef path,
                                 ConstString demangled) const override;

  ConstString
  GetDemangledFunctionNameWithoutArguments(Mangled mangled) const override;

  bool GetFunctionDisplayName(const SymbolContext &sc,
                              const ExecutionContext *exe_ctx,
                              FunctionNameRepresentation representation,
                              Stream &s) override;

  bool HandleFrameFormatVariable(const SymbolContext &sc,
                                 const ExecutionContext *exe_ctx,
                                 FormatEntity::Entry::Type type,
                                 Stream &s) override;

  static bool IsCPPMangledName(llvm::StringRef name);

  static llvm::StringRef GetDemangledBasename(llvm::StringRef demangled,
                                              const DemangledNameInfo &info);

  static llvm::Expected<llvm::StringRef>
  GetDemangledTemplateArguments(llvm::StringRef demangled,
                                const DemangledNameInfo &info);

  static llvm::Expected<llvm::StringRef>
  GetDemangledReturnTypeLHS(llvm::StringRef demangled,
                            const DemangledNameInfo &info);

  static llvm::Expected<llvm::StringRef>
  GetDemangledFunctionQualifiers(llvm::StringRef demangled,
                                 const DemangledNameInfo &info);

  static llvm::Expected<llvm::StringRef>
  GetDemangledScope(llvm::StringRef demangled, const DemangledNameInfo &info);

  static llvm::Expected<llvm::StringRef>
  GetDemangledReturnTypeRHS(llvm::StringRef demangled,
                            const DemangledNameInfo &info);

  static llvm::Expected<llvm::StringRef>
  GetDemangledFunctionArguments(llvm::StringRef demangled,
                                const DemangledNameInfo &info);

  static llvm::Expected<llvm::StringRef>
  GetDemangledFunctionSuffix(llvm::StringRef demangled,
                             const DemangledNameInfo &info);

  // Extract C++ context and identifier from a string using heuristic matching
  // (as opposed to
  // CPlusPlusLanguage::CxxMethodName which has to have a fully qualified C++
  // name with parens and arguments.
  // If the name is a lone C identifier (e.g. C) or a qualified C identifier
  // (e.g. A::B::C) it will return true,
  // and identifier will be the identifier (C and C respectively) and the
  // context will be "" and "A::B" respectively.
  // If the name fails the heuristic matching for a qualified or unqualified
  // C/C++ identifier, then it will return false
  // and identifier and context will be unchanged.

  static bool ExtractContextAndIdentifier(llvm::StringRef name,
                                          llvm::StringRef &context,
                                          llvm::StringRef &identifier);

  std::vector<ConstString>
  GenerateAlternateFunctionManglings(const ConstString mangled) const override;

  ConstString FindBestAlternateFunctionMangledName(
      const Mangled mangled, const SymbolContext &sym_ctx) const override;

  /// Substitutes Itanium type encoding substrings given by \c subst_from
  /// in \c mangled_name with \c subst_to.
  ///
  /// This function will only replace Itanium type encodings (i.e., <type>
  /// productions in the Itanium ABI mangling grammar). However, no verifiction
  /// is done on whether \c subst_from or \c subst_to is a valid type encoding.
  ///
  /// \param[in] mangled_name Mangled name to perform the substitutions in.
  /// This function only supports Itanium ABI mangling.
  ///
  /// \param[in] subst_from The substring to substitute.
  ///
  /// \param[in] subst_to The substring to insert.
  ///
  /// \returns The mangled string with substitutions. If no substitutions
  /// have been made, returns an empty \c ConstString (even if the string
  /// already contained the substitutions). If an error occurred, this function
  /// returns the error.
  ///
  static llvm::Expected<ConstString>
  SubstituteType_ItaniumMangle(llvm::StringRef mangled_name,
                               llvm::StringRef subst_from,
                               llvm::StringRef subst_to);

  /// Substitutes Itanium structor encoding substrings given by \c subst_from
  /// in \c mangled_name with \c subst_to.
  ///
  /// This function will only replace Itanium structor encodings (i.e.,
  /// <ctor-dtor-name> productions in the Itanium ABI mangling grammar).
  /// However, no verifiction is done on whether \c subst_from or \c subst_to is
  /// a valid structor encoding.
  ///
  /// \param[in] mangled_name Mangled name to perform the substitutions in.
  /// This function only supports Itanium ABI mangling.
  ///
  /// \param[in] subst_from The substring to substitute.
  ///
  /// \param[in] subst_to The substring to insert.
  ///
  /// \returns The mangled string with substitutions. If no substitutions
  /// have been made, returns an empty \c ConstString (even if the string
  /// already contained the substitutions). If an error occurred, this function
  /// returns the error.
  ///
  static llvm::Expected<ConstString>
  SubstituteStructor_ItaniumMangle(llvm::StringRef mangled_name,
                                   llvm::StringRef subst_from,
                                   llvm::StringRef subst_to);

  /// Tries replacing Itanium structor encoding substrings in \c mangled_name
  /// with potential aliases.j
  ///
  /// This function will only replace Itanium structor encodings (i.e.,
  /// <ctor-dtor-name> productions in the Itanium ABI mangling grammar).
  ///
  /// E.g., on some platforms, the C1/D1 variants are aliased to the C2/D2
  /// variants. This function will try to replace occurrences of C1/D1 with
  /// C2/D2.
  ///
  /// \param[in] mangled_name Mangled name to perform the substitutions in.
  /// This function only supports Itanium ABI mangling.
  ///
  /// \returns The mangled string with substitutions. If no substitutions
  /// have been made, returns an empty \c ConstString (even if the string
  /// already contained the substitutions). If an error occurred, this function
  /// returns the error.
  ///
  static llvm::Expected<ConstString>
  SubstituteStructorAliases_ItaniumMangle(llvm::StringRef mangled_name);

  llvm::StringRef GetInstanceVariableName() override { return "this"; }

  FormatEntity::Entry GetFunctionNameFormat() const override;

  // PluginInterface protocol
  llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }

private:
  static void DebuggerInitialize(Debugger &);
};

} // namespace lldb_private

#endif // LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H