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", "demangle.foo"),
        std::make_pair("_D8demangle3foo",
                       nullptr), // symbol without a type sequence.
        std::make_pair("_D8demangle3fooinvalidtypeseq",
                       nullptr), // invalid type sequence.
        std::make_pair(
            "_D8demangle3ABCQe1ai",
            "demangle.ABC.ABC.a"), // symbol back reference: `Qe` is a back
                                   // reference for position 5, counting from e
                                   // char, so decoding it points to `3`. Since
                                   // `3` is a number, 3 chars get read and it
                                   // succeeded.
        std::make_pair("_D8demangle3ABCQa1ai",
                       nullptr), // invalid symbol back reference (recursive).
        std::make_pair("_D8demangleQDXXXXXXXXXXXXx",
                       nullptr), // overflow back reference position.
        std::make_pair(
            "_D8demangle4ABCi1aQd",
            "demangle.ABCi.a"), // type back reference: `Qd` is a back reference
                                // for position 4, counting from `d` char, so
                                // decoding it points to `i`.
        std::make_pair("_D8demangle3fooQXXXx",
                       nullptr), // invalid type back reference position.
        std::make_pair("_D8demangle5recurQa",
                       nullptr))); // invalid type back reference (recursive).