log_bytes.h

// Copyright 2024 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 <array>
#include <cstddef>
 
#include "pw_bytes/span.h"
#include "pw_hex_dump/hex_dump.h"
#include "pw_log/log.h"
#include "pw_log/options.h"
 
namespace pw::dump {
 
 
template <std::size_t kBytesPerLine = 16>
inline void LogBytes(int log_level, pw::ConstByteSpan bytes) {
  // An input byte uses 3 bytes for the hex representation plus 1 for ASCII.
  // 8 bytes go to offset, padding, and string termination.
  const std::size_t kMaxLogLineLength = 8 + 4 * kBytesPerLine;
 
  if (kBytesPerLine == 0) {
    return;
  }
 
  std::array<char, kMaxLogLineLength> temp{};
  const auto flags = pw::dump::FormattedHexDumper::Flags{
      .bytes_per_line = kBytesPerLine,
      .group_every = 1,
      .show_ascii = true,
      .show_header = false,
      .prefix_mode = pw::dump::FormattedHexDumper::AddressMode::kOffset};
  pw::dump::FormattedHexDumper hex_dumper(temp, flags);
  if (hex_dumper.BeginDump(bytes).ok()) {
    while (hex_dumper.DumpLine().ok()) {
      PW_LOG(log_level,
             PW_LOG_LEVEL,
             PW_LOG_MODULE_NAME,
             PW_LOG_FLAGS,
             "%s",
             temp.data());
    }
  }
}
 
}  // namespace pw::dump