// Copyright (c) 2006, Google Inc.

// All rights reserved.

//

// Redistribution and use in source and binary forms, with or without

// modification, are permitted provided that the following conditions are

// met:

//

//     * Redistributions of source code must retain the above copyright

// notice, this list of conditions and the following disclaimer.

//     * Redistributions in binary form must reproduce the above

// copyright notice, this list of conditions and the following disclaimer

// in the documentation and/or other materials provided with the

// distribution.

//     * Neither the name of Google Inc. nor the names of its

// contributors may be used to endorse or promote products derived from

// this software without specific prior written permission.

//

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//

// Author: Satoru Takabayashi

//

// Unit tests for functions in demangle.c.

#include "utilities.h"

#include <iostream>

#include <fstream>

#include <string>

#include "glog/logging.h"

#include "demangle.h"

#include "googletest.h"

#include "config.h"

#ifdef HAVE_LIB_GFLAGS

#include <gflags/gflags.h>

using namespace GFLAGS_NAMESPACE;

#endif

GLOG_DEFINE_bool(demangle_filter, false,

                 "Run demangle_unittest in filter mode");

using namespace std;

using namespace GOOGLE_NAMESPACE;

// A wrapper function for Demangle() to make the unit test simple.

static const char *DemangleIt(const char * const mangled) {

  static char demangled[4096];

  if (Demangle(mangled, demangled, sizeof(demangled))) {

    return demangled;

  } else {

    return mangled;

  }

}

// Test corner cases of bounary conditions.

TEST(Demangle, CornerCases) {

  char tmp[10];

  EXPECT_TRUE(Demangle("_Z6foobarv", tmp, sizeof(tmp)));

  // sizeof("foobar()") == 9

  EXPECT_STREQ("foobar()", tmp);

  EXPECT_TRUE(Demangle("_Z6foobarv", tmp, 9));

  EXPECT_STREQ("foobar()", tmp);

  EXPECT_FALSE(Demangle("_Z6foobarv", tmp, 8));  // Not enough.

  EXPECT_FALSE(Demangle("_Z6foobarv", tmp, 1));

  EXPECT_FALSE(Demangle("_Z6foobarv", tmp, 0));

  EXPECT_FALSE(Demangle("_Z6foobarv", NULL, 0));  // Should not cause SEGV.

}

// Test handling of functions suffixed with .clone.N, which is used by GCC

// 4.5.x, and .constprop.N and .isra.N, which are used by GCC 4.6.x.  These

// suffixes are used to indicate functions which have been cloned during

// optimization.  We ignore these suffixes.

TEST(Demangle, Clones) {

  char tmp[20];

  EXPECT_TRUE(Demangle("_ZL3Foov", tmp, sizeof(tmp)));

  EXPECT_STREQ("Foo()", tmp);

  EXPECT_TRUE(Demangle("_ZL3Foov.clone.3", tmp, sizeof(tmp)));

  EXPECT_STREQ("Foo()", tmp);

  EXPECT_TRUE(Demangle("_ZL3Foov.constprop.80", tmp, sizeof(tmp)));

  EXPECT_STREQ("Foo()", tmp);

  EXPECT_TRUE(Demangle("_ZL3Foov.isra.18", tmp, sizeof(tmp)));

  EXPECT_STREQ("Foo()", tmp);

  EXPECT_TRUE(Demangle("_ZL3Foov.isra.2.constprop.18", tmp, sizeof(tmp)));

  EXPECT_STREQ("Foo()", tmp);

  // Invalid (truncated), should not demangle.

  EXPECT_FALSE(Demangle("_ZL3Foov.clo", tmp, sizeof(tmp)));

  // Invalid (.clone. not followed by number), should not demangle.

  EXPECT_FALSE(Demangle("_ZL3Foov.clone.", tmp, sizeof(tmp)));

  // Invalid (.clone. followed by non-number), should not demangle.

  EXPECT_FALSE(Demangle("_ZL3Foov.clone.foo", tmp, sizeof(tmp)));

  // Invalid (.constprop. not followed by number), should not demangle.

  EXPECT_FALSE(Demangle("_ZL3Foov.isra.2.constprop.", tmp, sizeof(tmp)));

}

TEST(Demangle, FromFile) {

  string test_file = FLAGS_test_srcdir + "/src/demangle_unittest.txt";

  ifstream f(test_file.c_str());  // The file should exist.

  EXPECT_FALSE(f.fail());

  string line;

  while (getline(f, line)) {

    // Lines start with '#' are considered as comments.

    if (line.empty() || line[0] == '#') {

      continue;

    }

    // Each line should contain a mangled name and a demangled name

    // separated by '\t'.  Example: "_Z3foo\tfoo"

    string::size_type tab_pos = line.find('\t');

    EXPECT_NE(string::npos, tab_pos);

    string mangled = line.substr(0, tab_pos);

    string demangled = line.substr(tab_pos + 1);

    EXPECT_EQ(demangled, DemangleIt(mangled.c_str()));

  }

}

int main(int argc, char **argv) {

#ifdef HAVE_LIB_GFLAGS

  ParseCommandLineFlags(&argc, &argv, true);

#endif

  InitGoogleTest(&argc, argv);

  FLAGS_logtostderr = true;

  InitGoogleLogging(argv[0]);

  if (FLAGS_demangle_filter) {

    // Read from cin and write to cout.

    string line;

    while (getline(cin, line, '\n')) {

      cout << DemangleIt(line.c_str()) << endl;

    }

    return 0;

  } else if (argc > 1) {

    cout << DemangleIt(argv[1]) << endl;

    return 0;

  } else {

    return RUN_ALL_TESTS();

  }

}