LLVM  7.0.0svn
DebugStringTableSubsection.h
Go to the documentation of this file.
1 //===- DebugStringTableSubsection.h - CodeView String Table -----*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef LLVM_DEBUGINFO_CODEVIEW_DEBUGSTRINGTABLESUBSECTION_H
11 #define LLVM_DEBUGINFO_CODEVIEW_DEBUGSTRINGTABLESUBSECTION_H
12 
13 #include "llvm/ADT/DenseMap.h"
14 #include "llvm/ADT/StringMap.h"
15 #include "llvm/ADT/StringRef.h"
19 #include "llvm/Support/Error.h"
20 #include <cstdint>
21 
22 namespace llvm {
23 
24 class BinaryStreamReader;
25 
26 namespace codeview {
27 
28 /// Represents a read-only view of a CodeView string table. This is a very
29 /// simple flat buffer consisting of null-terminated strings, where strings
30 /// are retrieved by their offset in the buffer. DebugStringTableSubsectionRef
31 /// does not own the underlying storage for the buffer.
33 public:
35 
36  static bool classof(const DebugSubsectionRef *S) {
38  }
39 
42 
44 
45  bool valid() const { return Stream.valid(); }
46 
47  BinaryStreamRef getBuffer() const { return Stream; }
48 
49 private:
50  BinaryStreamRef Stream;
51 };
52 
53 /// Represents a read-write view of a CodeView string table.
54 /// DebugStringTableSubsection owns the underlying storage for the table, and is
55 /// capable of serializing the string table into a format understood by
56 /// DebugStringTableSubsectionRef.
58 public:
60 
61  static bool classof(const DebugSubsection *S) {
63  }
64 
65  // If string S does not exist in the string table, insert it.
66  // Returns the ID for S.
67  uint32_t insert(StringRef S);
68 
69  // Return the ID for string S. Assumes S exists in the table.
70  uint32_t getIdForString(StringRef S) const;
71 
72  StringRef getStringForId(uint32_t Id) const;
73 
74  uint32_t calculateSerializedSize() const override;
75  Error commit(BinaryStreamWriter &Writer) const override;
76 
77  uint32_t size() const;
78 
80  return StringToId.begin();
81  }
82 
83  StringMap<uint32_t>::const_iterator end() const { return StringToId.end(); }
84 
85  std::vector<uint32_t> sortedIds() const;
86 
87 private:
89  StringMap<uint32_t> StringToId;
90  uint32_t StringSize = 1;
91 };
92 
93 } // end namespace codeview
94 
95 } // end namespace llvm
96 
97 #endif // LLVM_DEBUGINFO_CODEVIEW_DEBUGSTRINGTABLESUBSECTION_H
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
Expected< StringRef > getString(uint32_t Offset) const
StringMap< uint32_t >::const_iterator end() const
Tagged union holding either a T or a Error.
Definition: CachePruning.h:23
StringMap< uint32_t >::const_iterator begin() const
Provides write only access to a subclass of WritableBinaryStream.
auto size(R &&Range, typename std::enable_if< std::is_same< typename std::iterator_traits< decltype(Range.begin())>::iterator_category, std::random_access_iterator_tag >::value, void >::type *=nullptr) -> decltype(std::distance(Range.begin(), Range.end()))
Get the size of a range.
Definition: STLExtras.h:1032
Represents a read-write view of a CodeView string table.
BinaryStreamRef is to BinaryStream what ArrayRef is to an Array.
static bool classof(const DebugSubsectionRef *S)
DebugSubsectionKind kind() const
Represents a read-only view of a CodeView string table.
StringMap - This is an unconventional map that is specialized for handling keys that are "strings"...
Definition: StringMap.h:222
iterator begin()
Definition: StringMap.h:317
static bool classof(const DebugSubsection *S)
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
Provides read only access to a subclass of BinaryStream.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
DebugSubsectionKind kind() const
iterator end()
Definition: StringMap.h:320