src/include/puffin/common.h

// Copyright 2017 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_INCLUDE_PUFFIN_COMMON_H_
#define SRC_INCLUDE_PUFFIN_COMMON_H_

#include <ostream>
#include <vector>

#ifndef DISALLOW_COPY_AND_ASSIGN
#define DISALLOW_COPY_AND_ASSIGN(TypeName) \
  TypeName(const TypeName&) = delete;      \
  void operator=(const TypeName&) = delete
#endif  // DISALLOW_COPY_AND_ASSIGN

#ifndef FALLTHROUGH_INTENDED
#ifdef __clang__
#define FALLTHROUGH_INTENDED [[clang::fallthrough]]
#else
#define FALLTHROUGH_INTENDED
#endif  // __clang__
#endif  // FALLTHROUGH_INTENDED

namespace puffin {

using Buffer = std::vector<uint8_t>;

// This class is similar to the protobuf generated for |ProtoByteExtent|. We
// defined an extra class so the users of puffin do not have to include
// puffin.pb.h and deal with its use.
struct ByteExtent {
  constexpr ByteExtent(uint64_t offset, uint64_t length)
      : offset(offset), length(length) {}

  constexpr bool operator==(const ByteExtent& other) const {
    return this->length == other.length && this->offset == other.offset;
  }

  constexpr bool operator<(const ByteExtent& other) const {
    if (offset != other.offset) {
      return offset < other.offset;
    }
    return length < other.length;
  }

  uint64_t offset;
  uint64_t length;
};

struct BitExtent {
  constexpr BitExtent(uint64_t offset, uint64_t length)
      : offset(offset), length(length) {}

  constexpr bool operator==(const BitExtent& other) const {
    return this->length == other.length && this->offset == other.offset;
  }
  constexpr bool operator<(const BitExtent& other) const {
    if (offset != other.offset) {
      return offset < other.offset;
    }
    return length < other.length;
  }

  uint64_t offset;
  uint64_t length;
};

}  // namespace puffin

#endif  // SRC_INCLUDE_PUFFIN_COMMON_H_