Merge pull request #8006 from eeckstein/demangle-lib

demangler: put the demangler into a separate library

Author: eeckstein

include/swift/Basic/DemangleWrappers.h

@@ -13,7 +13,7 @@
 #ifndef SWIFT_BASIC_MANGLER_H
 #define SWIFT_BASIC_MANGLER_H
 
-#include "swift/Basic/ManglingUtils.h"
+#include "swift/Demangling/ManglingUtils.h"
 #include "llvm/ADT/DenseMap.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/StringMap.h"

include/swift/Basic/Mangler.h

@@ -16,16 +16,14 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef SWIFT_BASIC_DEMANGLE_H
-#define SWIFT_BASIC_DEMANGLE_H
+#ifndef SWIFT_DEMANGLING_DEMANGLE_H
+#define SWIFT_DEMANGLING_DEMANGLE_H
 
 #include <memory>
 #include <string>
-#include <vector>
 #include <cassert>
 #include <cstdint>
 #include "llvm/ADT/StringRef.h"
-#include "swift/Basic/Malloc.h"
 
 namespace llvm {
   class raw_ostream;
@@ -116,7 +114,7 @@ static inline char encodeSpecializationPass(SpecializationPass Pass) {
 enum class ValueWitnessKind {
 #define VALUE_WITNESS(MANGLING, NAME) \
   NAME,
-#include "swift/Basic/ValueWitnessMangling.def"
+#include "swift/Demangling/ValueWitnessMangling.def"
 };
 
 enum class Directness {
@@ -130,7 +128,7 @@ class Node {
 public:
   enum class Kind : uint16_t {
 #define NODE(ID) ID,
-#include "swift/Basic/DemangleNodes.def"
+#include "swift/Demangling/DemangleNodes.def"
   };
 
   typedef uint64_t IndexType;
@@ -203,13 +201,18 @@ class Node {
     return Children[index];
   }
 
-  void addChild(NodePointer Child, Context &Ctx);
+//  inline void addChild(NodePointer Child, Context &Ctx);
 
   // Only to be used by the demangler parsers.
   void addChild(NodePointer Child, NodeFactory &Factory);
 
   // Reverses the order of children.
   void reverseChildren(size_t StartingAt = 0);
+
+  /// Prints the whole node tree in readable form to stderr.
+  ///
+  /// Useful to be called from the debugger.
+  void dump();
 };
 
 /// Returns true if the mangledName starts with the swift mangling prefix.
@@ -311,24 +314,6 @@ class Context {
   /// The memory which is used for nodes is not freed but recycled for the next
   /// demangling operation.
   void clear();
-  
-  /// Creates a node of kind \p K.
-  ///
-  /// The lifetime of the returned node ends with the lifetime of the
-  /// context or with a call of clear().
-  NodePointer createNode(Node::Kind K);
-
-  /// Creates a node of kind \p K with an \p Index payload.
-  ///
-  /// The lifetime of the returned node ends with the lifetime of the
-  /// context or with a call of clear().
-  NodePointer createNode(Node::Kind K, Node::IndexType Index);
-
-  /// Creates a node of kind \p K with a \p Text payload.
-  ///
-  /// The lifetime of the returned node ends with the lifetime of the
-  /// context or with a call of clear().
-  NodePointer createNode(Node::Kind K, llvm::StringRef Text);
 };
 
 /// Standalong utility function to demangle the given symbol as string.
@@ -493,16 +478,17 @@ class DemanglerPrinter {
   std::string Stream;
 };
 
-bool isSpecialized(Node *node);
-NodePointer getUnspecialized(Node *node, NodeFactory &Factory);
+/// Returns a the node kind \p k as string.
+const char *getNodeKindString(swift::Demangle::Node::Kind k);
 
-/// Is a character considered a digit by the demangling grammar?
+/// Prints the whole node tree \p Root in readable form into a std::string.
 ///
-/// Yes, this is equivalent to the standard C isdigit(3), but some platforms
-/// give isdigit suboptimal implementations.
-static inline bool isDigit(int c) {
-  return c >= '0' && c <= '9';
-}
+/// Useful for debugging.
+std::string &&getNodeTreeAsString(NodePointer Root);
+
+bool isSpecialized(Node *node);
+NodePointer getUnspecialized(Node *node, NodeFactory &Factory);
+std::string archetypeName(Node::IndexType index, Node::IndexType depth);
 
 } // end namespace Demangle
 
@@ -515,4 +501,4 @@ bool useNewMangling(Demangle::NodePointer Node);
 
 } // end namespace swift
 
-#endif // SWIFT_BASIC_DEMANGLE_H
+#endif // SWIFT_DEMANGLING_DEMANGLE_H

include/swift/Basic/Demangle.h renamed to include/swift/Demangling/Demangle.h

@@ -16,11 +16,10 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef SWIFT_BASIC_DEMANGLER_H
-#define SWIFT_BASIC_DEMANGLER_H
+#ifndef SWIFT_DEMANGLING_DEMANGLER_H
+#define SWIFT_DEMANGLING_DEMANGLER_H
 
-#include "swift/Basic/Demangle.h"
-#include <vector>
+#include "swift/Demangling/Demangle.h"
 
 //#define NODE_FACTORY_DEBUGGING
 
@@ -490,7 +489,7 @@ NodePointer demangleOldSymbolAsNode(StringRef MangledName,
 NodePointer demangleOldTypeAsNode(StringRef MangledName,
                                   NodeFactory &Factory);
 
-} // end namespace NewMangling
+} // end namespace Demangle
 } // end namespace swift
 
-#endif // SWIFT_BASIC_DEMANGLER_H
+#endif // SWIFT_DEMANGLING_DEMANGLER_H

include/swift/Basic/DemangleNodes.def renamed to include/swift/Demangling/DemangleNodes.def

@@ -10,8 +10,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef SWIFT_BASIC_MANGLING_MACROS_H
-#define SWIFT_BASIC_MANGLING_MACROS_H
+#ifndef SWIFT_DEMANGLING_MANGLING_MACROS_H
+#define SWIFT_DEMANGLING_MANGLING_MACROS_H
 
 // The following macro enables the "new" mangling, which has an _S prefix rather
 // then the original _T prefix.
@@ -107,5 +107,5 @@
 #define OBJC_PARTIAL_APPLY_THUNK_SYM \
           MANGLE_SYM(OBJC_PARTIAL_APPLY_THUNK_MANGLING)
 
-#endif // SWIFT_BASIC_MANGLING_MACROS_H
+#endif // SWIFT_DEMANGLING_MANGLING_MACROS_H
 

include/swift/Basic/Demangler.h renamed to include/swift/Demangling/Demangler.h

@@ -10,16 +10,17 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef SWIFT_BASIC_MANGLINGUTILS_H
-#define SWIFT_BASIC_MANGLINGUTILS_H
+#ifndef SWIFT_DEMANGLING_MANGLINGUTILS_H
+#define SWIFT_DEMANGLING_MANGLINGUTILS_H
 
 #include "llvm/ADT/StringRef.h"
-#include "llvm/ADT/ArrayRef.h"
-#include "swift/Basic/Punycode.h"
+#include "swift/Demangling/Punycode.h"
 
 namespace swift {
 namespace NewMangling {
 
+using llvm::StringRef;
+
 inline bool isLowerLetter(char ch) {
   return ch >= 'a' && ch <= 'z';
 }
@@ -313,5 +314,5 @@ class SubstitutionMerging {
 } // end namespace Mangle
 } // end namespace swift
 
-#endif // SWIFT_BASIC_MANGLINGUTILS_H
+#endif // SWIFT_DEMANGLING_MANGLINGUTILS_H
 

include/swift/Basic/ManglingMacros.h renamed to include/swift/Demangling/ManglingMacros.h

@@ -24,18 +24,18 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef SWIFT_BASIC_PUNYCODE_H
-#define SWIFT_BASIC_PUNYCODE_H
+#ifndef SWIFT_DEMANGLING_PUNYCODE_H
+#define SWIFT_DEMANGLING_PUNYCODE_H
 
-#include "swift/Basic/LLVM.h"
 #include "llvm/ADT/StringRef.h"
-#include "llvm/ADT/SmallVector.h"
 #include <vector>
 #include <cstdint>
 
 namespace swift {
 namespace Punycode {
 
+using llvm::StringRef;
+
 /// Encodes a sequence of code points into Punycode.
 ///
 /// Returns false if input contains surrogate code points.
@@ -61,5 +61,5 @@ bool decodePunycodeUTF8(StringRef InputPunycode, std::string &OutUTF8);
 } // end namespace Punycode
 } // end namespace swift
 
-#endif // SWIFT_BASIC_PUNYCODE_H
+#endif // SWIFT_DEMANGLING_PUNYCODE_H
 

include/swift/Basic/ManglingUtils.h renamed to include/swift/Demangling/ManglingUtils.h

@@ -19,8 +19,7 @@
 
 #include "swift/Runtime/Metadata.h"
 #include "swift/Remote/MemoryReader.h"
-#include "swift/Basic/Demangler.h"
-#include "swift/Basic/Demangle.h"
+#include "swift/Demangling/Demangler.h"
 #include "swift/Basic/LLVM.h"
 #include "swift/Runtime/Unreachable.h"
 

include/swift/Basic/Punycode.h renamed to include/swift/Demangling/Punycode.h

@@ -32,7 +32,7 @@
 #include "swift/Basic/Malloc.h"
 #include "swift/Basic/FlaggedPointer.h"
 #include "swift/Basic/RelativePointer.h"
-#include "swift/Basic/ManglingMacros.h"
+#include "swift/Demangling/ManglingMacros.h"
 #include "swift/Runtime/Unreachable.h"
 #include "../../../stdlib/public/SwiftShims/HeapObject.h"
 

include/swift/Basic/StandardTypesMangling.def renamed to include/swift/Demangling/StandardTypesMangling.def

@@ -13,7 +13,7 @@
 #ifndef SWIFT_SIL_MANGLE_H
 #define SWIFT_SIL_MANGLE_H
 
-#include "swift/Basic/Demangle.h"
+#include "swift/Demangling/Demangle.h"
 #include "swift/Basic/NullablePtr.h"
 #include "swift/AST/Decl.h"
 #include "swift/AST/Mangle.h"

include/swift/Basic/ValueWitnessMangling.def renamed to include/swift/Demangling/ValueWitnessMangling.def

@@ -13,7 +13,7 @@
 #ifndef SWIFT_SILOPTIMIZER_UTILS_SPECIALIZATIONMANGLER_H
 #define SWIFT_SILOPTIMIZER_UTILS_SPECIALIZATIONMANGLER_H
 
-#include "swift/Basic/Demangler.h"
+#include "swift/Demangling/Demangler.h"
 #include "swift/Basic/NullablePtr.h"
 #include "swift/AST/ASTMangler.h"
 #include "swift/SIL/SILLinkage.h"

include/swift/Remote/MetadataReader.h

@@ -21,7 +21,7 @@
 #include "swift/AST/Module.h"
 #include "swift/AST/ProtocolConformance.h"
 #include "swift/AST/Mangle.h"
-#include "swift/Basic/ManglingUtils.h"
+#include "swift/Demangling/ManglingUtils.h"
 #include "swift/Strings.h"
 #include "clang/Basic/CharInfo.h"
 #include "clang/AST/Attr.h"

include/swift/Runtime/Metadata.h

@@ -20,8 +20,8 @@
 #include "swift/AST/Initializer.h"
 #include "swift/AST/Module.h"
 #include "swift/AST/ProtocolConformance.h"
-#include "swift/Basic/Demangle.h"
-#include "swift/Basic/Punycode.h"
+#include "swift/Demangling/Demangle.h"
+#include "swift/Demangling/Punycode.h"
 #include "clang/Basic/CharInfo.h"
 #include "clang/AST/Attr.h"
 #include "clang/AST/Decl.h"

include/swift/SIL/Mangle.h

@@ -67,9 +67,6 @@ set(version_inc_files
 add_swift_library(swiftBasic STATIC
   Cache.cpp
   ClusteredBitVector.cpp
-  Demangle.cpp
-  Demangler.cpp
-  DemangleWrappers.cpp
   DiagnosticConsumer.cpp
   DiverseStack.cpp
   Edit.cpp
@@ -79,17 +76,12 @@ add_swift_library(swiftBasic STATIC
   LangOptions.cpp
   LLVMContext.cpp
   Mangler.cpp
-  ManglingUtils.cpp
   Platform.cpp
   PrefixMap.cpp
   PrettyStackTrace.cpp
   PrimitiveParsing.cpp
   Program.cpp
-  Punycode.cpp
-  PunycodeUTF8.cpp
   QuotedString.cpp
-  Remangle.cpp
-  Remangler.cpp
   SourceLoc.cpp
   StringExtras.cpp
   TaskQueue.cpp
@@ -109,7 +101,9 @@ add_swift_library(swiftBasic STATIC
   UnicodeExtendedGraphemeClusters.cpp.gyb
 
   C_COMPILE_FLAGS ${UUID_INCLUDE}
-  LINK_LIBRARIES ${UUID_LIBRARIES}
+  LINK_LIBRARIES
+    swiftDemangling
+    ${UUID_LIBRARIES}
   LLVM_COMPONENT_DEPENDS support)
 
 message(STATUS "Swift version: ${SWIFT_VERSION}")