PDBStringTableBuilder.h

Go to the documentation of this file.

//===- PDBStringTableBuilder.h - PDB String Table Builder -------*- 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 creates the "/names" stream.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_DEBUGINFO_PDB_NATIVE_PDBSTRINGTABLEBUILDER_H
#define LLVM_DEBUGINFO_PDB_NATIVE_PDBSTRINGTABLEBUILDER_H
 
#include "llvm/ADT/StringRef.h"
#include "llvm/DebugInfo/CodeView/DebugStringTableSubsection.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/Error.h"
#include <cstdint>
 
namespace llvm {
class BinaryStreamWriter;
class WritableBinaryStreamRef;
 
namespace msf {
struct MSFLayout;
}
 
namespace pdb {
 
class PDBFileBuilder;
class PDBStringTableBuilder;
 
struct StringTableHashTraits {
  PDBStringTableBuilder *Table;
 
  LLVM_ABI StringTableHashTraits() = default;
  LLVM_ABI explicit StringTableHashTraits(PDBStringTableBuilder &Table);
  LLVM_ABI uint32_t hashLookupKey(StringRef S) const;
  LLVM_ABI StringRef storageKeyToLookupKey(uint32_t Offset) const;
  LLVM_ABI uint32_t lookupKeyToStorageKey(StringRef S);
};
 
class PDBStringTableBuilder {
public:
  // If string S does not exist in the string table, insert it.
  // Returns the ID for S.
  LLVM_ABI uint32_t insert(StringRef S);
 
  LLVM_ABI uint32_t getIdForString(StringRef S) const;
  LLVM_ABI StringRef getStringForId(uint32_t Id) const;
 
  LLVM_ABI uint32_t calculateSerializedSize() const;
  LLVM_ABI Error commit(BinaryStreamWriter &Writer) const;
 
  LLVM_ABI void setStrings(const codeview::DebugStringTableSubsection &Strings);
 
private:
  uint32_t calculateHashTableSize() const;
  Error writeHeader(BinaryStreamWriter &Writer) const;
  Error writeStrings(BinaryStreamWriter &Writer) const;
  Error writeHashTable(BinaryStreamWriter &Writer) const;
  Error writeEpilogue(BinaryStreamWriter &Writer) const;
 
  codeview::DebugStringTableSubsection Strings;
};
 
} // end namespace pdb
} // end namespace llvm
 
#endif // LLVM_DEBUGINFO_PDB_NATIVE_PDBSTRINGTABLEBUILDER_H