ut.h

Go to the documentation of this file.

/*
   Copyright (c) 1994, 2018, Oracle and/or its affiliates. All Rights Reserved.





















   The lines above are intentionally left blank
*/

/** @file ut/ut.h
 Various utilities

 Created 1/20/1994 Heikki Tuuri
 ***********************************************************************/

/** NOTE: The functions in this file should only use functions from
other files in library. The code in this file is used to make a library for
external tools. */

#ifndef ut_ut_h
#define ut_ut_h

#include "univ.i"
/** Prints the contents of a memory buffer in hex and ascii. */
void ut_print_buf(FILE *file,      /*!< in: file where to print */
                  const void *buf, /*!< in: memory buffer */
                  ulint len);      /*!< in: length of the buffer */

/** Prints a timestamp to a file. */
void ut_print_timestamp(FILE *file) /*!< in: file where to print */
    UNIV_COLD;
/** Sprintfs a timestamp to a buffer, 13..14 chars plus terminating NUL. */
void ut_sprintf_timestamp(char *buf); /*!< in: buffer where to sprintf */
/** Prints the contents of a memory buffer in hex. */
void ut_print_buf_hex(std::ostream &o, /*!< in/out: output stream */
                      const void *buf, /*!< in: memory buffer */
                      ulint len);      /*!< in: length of the buffer */
/** Prints the contents of a memory buffer in hex and ascii. */
void ut_print_buf(std::ostream &o, /*!< in/out: output stream */
                  const void *buf, /*!< in: memory buffer */
                  ulint len);      /*!< in: length of the buffer */
/** Like ut_strlcpy, but if src doesn't fit in dst completely, copies the last
 (size - 1) bytes of src, not the first.
 @return strlen(src) */
ulint ut_strlcpy_rev(char *dst,       /*!< in: destination buffer */
                     const char *src, /*!< in: source buffer */
                     ulint size);     /*!< in: size of destination buffer */

struct PrintBuffer {
  PrintBuffer(const void *buf, ulint len) : m_buf(buf), m_len(len) {}

  std::ostream &print(std::ostream &out) const {
    if (m_buf != nullptr) {
      ut_print_buf(out, m_buf, m_len);
    }
    return (out);
  }

 private:
  const void *m_buf;
  ulint m_len;
};

inline std::ostream &operator<<(std::ostream &out, const PrintBuffer &obj) {
  return (obj.print(out));
}

#endif