llvm-6502/include/llvm/Object/YAML.h
Sean Silva 2b1068952a Comment BinaryRef::Data.
Also, state an invariant.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@183348 91177308-0d34-0410-b5e6-96231b3b80d8
2013-06-05 23:32:23 +00:00

72 lines
2.1 KiB
C++

//===- YAML.h - YAMLIO utilities for object files ---------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file declares utility classes for handling the YAML representation of
// object files.
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_OBJECT_YAML_H
#define LLVM_OBJECT_YAML_H
#include "llvm/Support/YAMLTraits.h"
namespace llvm {
namespace object {
namespace yaml {
/// In an object file this is just a binary blob. In an yaml file it is an hex
/// string. Using this avoid having to allocate temporary strings.
class BinaryRef {
/// \brief Either raw binary data, or a string of hex bytes (must always
/// be an even number of characters).
ArrayRef<uint8_t> Data;
bool isBinary;
public:
BinaryRef(ArrayRef<uint8_t> Data) : Data(Data), isBinary(true) {}
BinaryRef(StringRef Data)
: Data(reinterpret_cast<const uint8_t *>(Data.data()), Data.size()),
isBinary(false) {}
BinaryRef() : isBinary(false) {}
StringRef getHex() const {
assert(!isBinary);
return StringRef(reinterpret_cast<const char *>(Data.data()), Data.size());
}
ArrayRef<uint8_t> getBinary() const {
assert(isBinary);
return Data;
}
bool operator==(const BinaryRef &Ref) {
// Special case for default constructed BinaryRef.
if (Ref.Data.empty() && Data.empty())
return true;
return Ref.isBinary == isBinary && Ref.Data == Data;
}
/// \brief Write the contents (regardless of whether it is binary or a
/// hex string) as binary to the given raw_ostream.
void writeAsBinary(raw_ostream &OS) const;
};
}
}
namespace yaml {
template <> struct ScalarTraits<object::yaml::BinaryRef> {
static void output(const object::yaml::BinaryRef &, void *,
llvm::raw_ostream &);
static StringRef input(StringRef, void *, object::yaml::BinaryRef &);
};
}
}
#endif