620b544ddf
Add a third parameter to {AsHex} which specifies whether the prefix
"0x" should be printed. Also, add the {AsHexBytes} helper which
outputs the hex number as individual bytes separated by a whitespace.
Also add unit tests for both helpers.
Both helper will be used in an upcoming refactoring of wasm error
messages:
https://chromium-review.googlesource.com/c/565282
R=titzer@chromium.org
Change-Id: I42d5ace9841ffb918cb4d6803b6347229e446097
Reviewed-on: https://chromium-review.googlesource.com/583448
Commit-Queue: Clemens Hammacher <clemensh@chromium.org>
Reviewed-by: Ben Titzer <titzer@chromium.org>
Cr-Commit-Position: refs/heads/master@{#46859}
120 lines
3.3 KiB
C++
120 lines
3.3 KiB
C++
// Copyright 2014 the V8 project authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#ifndef V8_OSTREAMS_H_
|
|
#define V8_OSTREAMS_H_
|
|
|
|
#include <cstddef>
|
|
#include <cstdio>
|
|
#include <cstring>
|
|
#include <ostream> // NOLINT
|
|
#include <streambuf>
|
|
|
|
#include "include/v8config.h"
|
|
#include "src/base/macros.h"
|
|
#include "src/globals.h"
|
|
|
|
namespace v8 {
|
|
namespace internal {
|
|
|
|
|
|
class OFStreamBase : public std::streambuf {
|
|
public:
|
|
explicit OFStreamBase(FILE* f);
|
|
virtual ~OFStreamBase();
|
|
|
|
protected:
|
|
FILE* const f_;
|
|
|
|
virtual int sync();
|
|
virtual int_type overflow(int_type c);
|
|
virtual std::streamsize xsputn(const char* s, std::streamsize n);
|
|
};
|
|
|
|
|
|
// An output stream writing to a file.
|
|
class V8_EXPORT_PRIVATE OFStream : public std::ostream {
|
|
public:
|
|
explicit OFStream(FILE* f);
|
|
virtual ~OFStream();
|
|
|
|
private:
|
|
OFStreamBase buf_;
|
|
};
|
|
|
|
|
|
// Wrappers to disambiguate uint16_t and uc16.
|
|
struct AsUC16 {
|
|
explicit AsUC16(uint16_t v) : value(v) {}
|
|
uint16_t value;
|
|
};
|
|
|
|
|
|
struct AsUC32 {
|
|
explicit AsUC32(int32_t v) : value(v) {}
|
|
int32_t value;
|
|
};
|
|
|
|
|
|
struct AsReversiblyEscapedUC16 {
|
|
explicit AsReversiblyEscapedUC16(uint16_t v) : value(v) {}
|
|
uint16_t value;
|
|
};
|
|
|
|
struct AsEscapedUC16ForJSON {
|
|
explicit AsEscapedUC16ForJSON(uint16_t v) : value(v) {}
|
|
uint16_t value;
|
|
};
|
|
|
|
// Output the given value as hex, with a minimum width and optional prefix (0x).
|
|
// E.g. AsHex(23, 3, true) produces "0x017". Produces an empty string if both
|
|
// {min_width} and the value are 0.
|
|
struct AsHex {
|
|
explicit AsHex(uint64_t v, uint8_t min_width = 1, bool with_prefix = false)
|
|
: value(v), min_width(min_width), with_prefix(with_prefix) {}
|
|
uint64_t value;
|
|
uint8_t min_width;
|
|
bool with_prefix;
|
|
};
|
|
|
|
// Output the given value as hex, separated in individual bytes.
|
|
// E.g. AsHexBytes(0x231712, 4) produces "12 17 23 00" if output as little
|
|
// endian (default), and "00 23 17 12" as big endian. Produces an empty string
|
|
// if both {min_bytes} and the value are 0.
|
|
struct AsHexBytes {
|
|
enum ByteOrder { kLittleEndian, kBigEndian };
|
|
explicit AsHexBytes(uint64_t v, uint8_t min_bytes = 1,
|
|
ByteOrder byte_order = kLittleEndian)
|
|
: value(v), min_bytes(min_bytes), byte_order(byte_order) {}
|
|
uint64_t value;
|
|
uint8_t min_bytes;
|
|
ByteOrder byte_order;
|
|
};
|
|
|
|
// Writes the given character to the output escaping everything outside of
|
|
// printable/space ASCII range. Additionally escapes '\' making escaping
|
|
// reversible.
|
|
std::ostream& operator<<(std::ostream& os, const AsReversiblyEscapedUC16& c);
|
|
|
|
// Same as AsReversiblyEscapedUC16 with additional escaping of \n, \r, " and '.
|
|
V8_EXPORT_PRIVATE std::ostream& operator<<(std::ostream& os,
|
|
const AsEscapedUC16ForJSON& c);
|
|
|
|
// Writes the given character to the output escaping everything outside
|
|
// of printable ASCII range.
|
|
std::ostream& operator<<(std::ostream& os, const AsUC16& c);
|
|
|
|
// Writes the given character to the output escaping everything outside
|
|
// of printable ASCII range.
|
|
std::ostream& operator<<(std::ostream& os, const AsUC32& c);
|
|
|
|
V8_EXPORT_PRIVATE std::ostream& operator<<(std::ostream& os, const AsHex& v);
|
|
V8_EXPORT_PRIVATE std::ostream& operator<<(std::ostream& os,
|
|
const AsHexBytes& v);
|
|
|
|
} // namespace internal
|
|
} // namespace v8
|
|
|
|
#endif // V8_OSTREAMS_H_
|