hex_dump.h

// Copyright 2020 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
 
#pragma once
 
#include <cstdint>
 
#include "pw_bytes/span.h"
#include "pw_span/span.h"
#include "pw_status/status.h"
 
namespace pw::dump {
 
inline constexpr const size_t kHexAddrStringSize = sizeof(uintptr_t) * 2 + 2;
 
class FormattedHexDumper {
 public:
  enum AddressMode {
    kDisabled = 0,
    kOffset = 1,
    kAbsolute = 2,
  };
 
  struct Flags {
    uint8_t bytes_per_line : 8;
 
    uint8_t group_every : 8;
 
    bool show_ascii : 1;
 
    bool show_header : 1;
 
    AddressMode prefix_mode : 2;
  };
 
  Flags flags = {.bytes_per_line = 16,
                 .group_every = 1,
                 .show_ascii = true,
                 .show_header = true,
                 .prefix_mode = AddressMode::kOffset};
 
  FormattedHexDumper() = default;
  FormattedHexDumper(span<char> dest) {
    SetLineBuffer(dest)
        .IgnoreError();  // TODO: b/242598609 - Handle Status properly
  }
  FormattedHexDumper(span<char> dest, Flags config_flags)
      : flags(config_flags) {
    SetLineBuffer(dest)
        .IgnoreError();  // TODO: b/242598609 - Handle Status properly
  }
 
  // TODO: b/234892215 - Add iterator support.
 
  Status SetLineBuffer(span<char> dest);
 
  Status BeginDump(ConstByteSpan data);
 
  Status DumpLine();
 
 private:
  Status ValidateBufferSize();
  Status PrintFormatHeader();
 
  size_t current_offset_;
  span<char> dest_;
  ConstByteSpan source_data_;
};
 
Status DumpAddr(span<char> dest, uintptr_t addr);
inline Status DumpAddr(span<char> dest, const void* ptr) {
  uintptr_t addr = reinterpret_cast<uintptr_t>(ptr);
  return DumpAddr(dest, addr);
}
 
}  // namespace pw::dump