1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-10-20 03:23:01 +02:00
llvm-mirror/include/llvm/Support/ItaniumManglingCanonicalizer.h
Chandler Carruth ae65e281f3 Update the file headers across all of the LLVM projects in the monorepo
to reflect the new license.

We understand that people may be surprised that we're moving the header
entirely to discuss the new license. We checked this carefully with the
Foundation's lawyer and we believe this is the correct approach.

Essentially, all code in the project is now made available by the LLVM
project under our new license, so you will see that the license headers
include that license only. Some of our contributors have contributed
code under our old license, and accordingly, we have retained a copy of
our old license notice in the top-level files in each project and
repository.

llvm-svn: 351636
2019-01-19 08:50:56 +00:00

93 lines
3.2 KiB
C++

//===--- ItaniumManglingCanonicalizer.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
//
//===----------------------------------------------------------------------===//
//
// This file defines a class for computing equivalence classes of mangled names
// given a set of equivalences between name fragments.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_SUPPORT_ITANIUMMANGLINGCANONICALIZER_H
#define LLVM_SUPPORT_ITANIUMMANGLINGCANONICALIZER_H
#include "llvm/ADT/StringRef.h"
#include <cstddef>
namespace llvm {
/// Canonicalizer for mangled names.
///
/// This class allows specifying a list of "equivalent" manglings. For example,
/// you can specify that Ss is equivalent to
/// NSt3__112basic_stringIcNS_11char_traitsIcEENS_9allocatorIcEEEE
/// and then manglings that refer to libstdc++'s 'std::string' will be
/// considered equivalent to manglings that are the same except that they refer
/// to libc++'s 'std::string'.
///
/// This can be used when data (eg, profiling data) is available for a version
/// of a program built in a different configuration, with correspondingly
/// different manglings.
class ItaniumManglingCanonicalizer {
public:
ItaniumManglingCanonicalizer();
ItaniumManglingCanonicalizer(const ItaniumManglingCanonicalizer &) = delete;
void operator=(const ItaniumManglingCanonicalizer &) = delete;
~ItaniumManglingCanonicalizer();
enum class EquivalenceError {
Success,
/// Both the equivalent manglings have already been used as components of
/// some other mangling we've looked at. It's too late to add this
/// equivalence.
ManglingAlreadyUsed,
/// The first equivalent mangling is invalid.
InvalidFirstMangling,
/// The second equivalent mangling is invalid.
InvalidSecondMangling,
};
enum class FragmentKind {
/// The mangling fragment is a <name> (or a predefined <substitution>).
Name,
/// The mangling fragment is a <type>.
Type,
/// The mangling fragment is an <encoding>.
Encoding,
};
/// Add an equivalence between \p First and \p Second. Both manglings must
/// live at least as long as the canonicalizer.
EquivalenceError addEquivalence(FragmentKind Kind, StringRef First,
StringRef Second);
using Key = uintptr_t;
/// Form a canonical key for the specified mangling. They key will be the
/// same for all equivalent manglings, and different for any two
/// non-equivalent manglings, but is otherwise unspecified.
///
/// Returns Key() if (and only if) the mangling is not a valid Itanium C++
/// ABI mangling.
///
/// The string denoted by Mangling must live as long as the canonicalizer.
Key canonicalize(StringRef Mangling);
/// Find a canonical key for the specified mangling, if one has already been
/// formed. Otherwise returns Key().
Key lookup(StringRef Mangling);
private:
struct Impl;
Impl *P;
};
} // namespace llvm
#endif // LLVM_SUPPORT_ITANIUMMANGLINGCANONICALIZER_H