// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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
//
//   http://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 "arrow/extension_type.h"

namespace arrow::extension {

/// \brief UuidArray stores array of UUIDs. Underlying storage type is
/// FixedSizeBinary(16).
class ARROW_EXPORT UuidArray : public ExtensionArray {
 public:
  using ExtensionArray::ExtensionArray;
};

/// \brief UuidType is a canonical arrow extension type for UUIDs.
/// UUIDs are stored as FixedSizeBinary(16) with big-endian notation and this
/// does not interpret the bytes in any way. Specific UUID version is not
/// required or guaranteed.
class ARROW_EXPORT UuidType : public ExtensionType {
 public:
  /// \brief Construct a UuidType.
  UuidType() : ExtensionType(fixed_size_binary(16)) {}

  std::string extension_name() const override { return "arrow.uuid"; }
  std::string ToString(bool show_metadata = false) const override;

  bool ExtensionEquals(const ExtensionType& other) const override;

  /// Create a UuidArray from ArrayData
  std::shared_ptr<Array> MakeArray(std::shared_ptr<ArrayData> data) const override;

  Result<std::shared_ptr<DataType>> Deserialize(
      std::shared_ptr<DataType> storage_type,
      const std::string& serialized) const override;

  std::string Serialize() const override { return ""; }

  /// \brief Create a UuidType instance
  static Result<std::shared_ptr<DataType>> Make() { return std::make_shared<UuidType>(); }

  static bool IsSupportedStorageType(const std::shared_ptr<DataType>& storage_type);
};

/// \brief Return a UuidType instance.
ARROW_EXPORT std::shared_ptr<DataType> uuid();

}  // namespace arrow::extension
