llvm/unittests/Demangle/DLangDemangleTest.cpp

//===------------------ DLangDemangleTest.cpp -----------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//

#include "llvm/Demangle/Demangle.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"

#include <cstdlib>
#include <string_view>
#include <utility>

struct DLangDemangleTestFixture
    : public testing::TestWithParam<std::pair<std::string_view, const char *>> {
  char *Demangled;

  void SetUp() override { Demangled = llvm::dlangDemangle(GetParam().first); }

  void TearDown() override { std::free(Demangled); }
};

TEST_P(DLangDemangleTestFixture, DLangDemangleTest) {
  EXPECT_STREQ(Demangled, GetParam().second);
}

INSTANTIATE_TEST_SUITE_P(
    DLangDemangleTest, DLangDemangleTestFixture,
    testing::Values(
        std::make_pair("_Dmain", "D main"), std::make_pair("_Z", nullptr),
        std::make_pair("_DDD", nullptr), std::make_pair("_D88", nullptr),
        std::make_pair("_D8demangleZ", "demangle"),
        std::make_pair("_D8demangle4testZ", "demangle.test"),
        std::make_pair("_D8demangle4test5test2Z", "demangle.test.test2"),
        std::make_pair("_D8demangle4test0Z", "demangle.test"),
        std::make_pair("_D8demangle4test03fooZ", "demangle.test.foo"),
        std::make_pair("_D8demangle4test6__initZ",
                       "initializer for demangle.test"),
        std::make_pair("_D8demangle4test6__vtblZ", "vtable for demangle.test"),
        std::make_pair("_D8demangle4test7__ClassZ",
                       "ClassInfo for demangle.test"),
        std::make_pair("_D8demangle4test11__InterfaceZ",
                       "Interface for demangle.test"),
        std::make_pair("_D8demangle4test12__ModuleInfoZ",
                       "ModuleInfo for demangle.test"),
        std::make_pair("_D8demangle4__S14testZ", "demangle.test"),
        std::make_pair("_D8demangle4__Sd4testZ", "demangle.__Sd.test"),
        std::make_pair("_D8demangle3fooi", "int demangle.foo"),
        std::make_pair("_D8demangle3foov", "void demangle.foo"),
        std::make_pair("_D8demangle3foo",
                       nullptr), // symbol without a type sequence.
        std::make_pair("_D8demangle3fooinvalidtypeseq",
                       nullptr), // invalid type sequence.
        std::make_pair(
            "_D8demangle3ABCQe1ai",
            "int demangle.ABC.ABC.a"), // symbol back reference: `Qe` is a back
        std::make_pair("_D8demangle3ABCQa1ai",
                       nullptr), // invalid symbol back reference (recursive).
        std::make_pair("_D8demangleQDXXXXXXXXXXXXx",
                       nullptr), // overflow back reference position.
        std::make_pair("_D8demangle4ABCi1aQd",
                       "int demangle.ABCi.a"), // type back reference: `Qd` is a
                                               // back reference
        std::make_pair("_D8demangle3fooQXXXx",
                       nullptr), // invalid type back reference position.
        std::make_pair("_D8demangle5recurQa",
                       nullptr), // invalid type back reference (recursive).
        // Basic types.
        std::make_pair("_D8demangle3fooa", "char demangle.foo"),
        std::make_pair("_D8demangle3foob", "bool demangle.foo"),
        std::make_pair("_D8demangle3fooc", "creal demangle.foo"),
        std::make_pair("_D8demangle3food", "double demangle.foo"),
        std::make_pair("_D8demangle3fooe", "real demangle.foo"),
        std::make_pair("_D8demangle3foof", "float demangle.foo"),
        std::make_pair("_D8demangle3foog", "byte demangle.foo"),
        std::make_pair("_D8demangle3fooh", "ubyte demangle.foo"),
        std::make_pair("_D8demangle3fooj", "ireal demangle.foo"),
        std::make_pair("_D8demangle3fook", "uint demangle.foo"),
        std::make_pair("_D8demangle3fool", "long demangle.foo"),
        std::make_pair("_D8demangle3foom", "ulong demangle.foo"),
        std::make_pair("_D8demangle3foon", "demangle.foo"),
        std::make_pair("_D8demangle3fooo", "ifloat demangle.foo"),
        std::make_pair("_D8demangle3foop", "idouble demangle.foo"),
        std::make_pair("_D8demangle3fooq", "cfloat demangle.foo"),
        std::make_pair("_D8demangle3foor", "cdouble demangle.foo"),
        std::make_pair("_D8demangle3foos", "short demangle.foo"),
        std::make_pair("_D8demangle3foot", "ushort demangle.foo"),
        std::make_pair("_D8demangle3foou", "wchar demangle.foo"),
        std::make_pair("_D8demangle3foow", "dchar demangle.foo"),
        std::make_pair("_D8demangle3foozi", "cent demangle.foo"),
        std::make_pair("_D8demangle3foozk", "ucent demangle.foo"),
        std::make_pair("_D8demangle3fooNn", "noreturn demangle.foo"),
        // Garbage suffix failures.
        std::make_pair("_D8demangle3fooiabc", nullptr),
        std::make_pair("_D8demangle3foovxxx", nullptr),
        std::make_pair("_D8demangle3fooza", nullptr),
        std::make_pair("_D8demangle3fooNx", nullptr)));