/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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.txt
 *
 *  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.
 *
 *=========================================================================*/
#ifndef itkRawImageIO_h
#define itkRawImageIO_h

#include "itkImageIOBase.h"
#include "itkImageRegion.h"
#include "itkPixelTraits.h"
#include "itkByteSwapper.h"
#include "itkVersion.h"
#include <string>
#include <fstream>

namespace itk
{
/**
 * \class RawImageIO
 *
 * \brief Read and write raw binary images.
 *
 * This class reads and writes 2D or 3D images. Because raw data has
 * little useful information built into the format,
 * the user is responsible for specifying pixel type,
 * dimensions, spacing, origin, header type, and so on. (Note: the
 * pixel type and image dimension is defined via the template parameter.)
 *
 * \sa ImageFileReader
 *
 * \ingroup IOFilters
 * \ingroup ITKIORAW
 */

template <typename TPixel, unsigned int VImageDimension = 2>
class ITK_TEMPLATE_EXPORT RawImageIO : public ImageIOBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RawImageIO);

  /** Standard class type aliases. */
  using Self = RawImageIO;
  using Superclass = ImageIOBase;
  using Pointer = SmartPointer<Self>;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(RawImageIO);

  /** Pixel type alias support Used to declare pixel type in filters
   * or other operations. */
  using PixelType = TPixel;

  /** Type used for counting elements. */
  using SizeValueType = Superclass::SizeValueType;

  /** this type is used in case the pixel has several components */
  using ComponentType = typename PixelTraits<PixelType>::ValueType;

  /** Helper class to swap bytes when necessary */
  using ByteSwapperType = ByteSwapper<ComponentType>;

  /** If the data is in the tail end of the file, you want to
   * explicitly set the header size. */
  void
  SetHeaderSize(SizeValueType size);

  SizeValueType
  GetHeaderSize();

  /** The number of dimensions stored in a file. Defaults to two. If two,
   * each file contains one "slice". If three, each file will contain one
   * "volume". */
  /** @ITKStartGrouping */
  itkSetMacro(FileDimensionality, unsigned long);
  itkGetConstMacro(FileDimensionality, unsigned long);
  /** @ITKEndGrouping */
  /** The different types of ImageIO's can support data of varying
   * dimensionality. For example, some file formats are strictly 2D
   * while others can support 2D, 3D, or even n-D. This method returns
   * true/false as to whether the ImageIO can support the dimension
   * indicated. */
  bool
  SupportsDimension(unsigned long dim) override
  {
    return dim == m_FileDimensionality;
  }

  /*-------- This part of the interface deals with reading data. ------ */

  /** Determine the file type. Returns true if this ImageIOBase can read the
   * file specified. Always returns false because we don't want to use
   * this reader unless absolutely sure (i.e., manual ImageIO creation). */
  bool
  CanReadFile(const char *) override
  {
    return false;
  }

  /** Binary files have no image information to read. This must be set by the
   * user of the class. */
  void
  ReadImageInformation() override
  {
    return;
  }

  /** Reads the data from disk into the memory buffer provided. */
  void
  Read(void * buffer) override;

  /** Set/Get the Data mask. */
  /** @ITKStartGrouping */
  itkGetConstReferenceMacro(ImageMask, unsigned short);
  void
  SetImageMask(unsigned long val)
  {
    if (val == m_ImageMask)
    {
      return;
    }
    m_ImageMask = (static_cast<unsigned short>(val));
    this->Modified();
  }
  /** @ITKEndGrouping */
  /** Read a file's header to determine image dimensions, etc. */
  virtual void
  ReadHeader(const std::string = std::string())
  {}

  /*-------- This part of the interfaces deals with writing data. ----- */

  /** Returns true if this ImageIO can write the specified file.
   * False is only returned when the file name is not specified. Otherwise
   * true is always returned. */
  bool
  CanWriteFile(const char *) override;

  /** Binary files have no image information to read.  */
  void
  WriteImageInformation() override
  {
    return;
  }

  /** Writes the data to disk from the memory buffer provided. */
  void
  Write(const void * buffer) override;

protected:
  RawImageIO();
  ~RawImageIO() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  // void ComputeInternalFileName(unsigned long slice);

private:
  std::string m_InternalFileName{};

  unsigned long  m_FileDimensionality{};
  bool           m_ManualHeaderSize{};
  SizeValueType  m_HeaderSize{};
  unsigned short m_ImageMask{};
};

template <typename TPixel, unsigned int VImageDimension>
class ITK_TEMPLATE_EXPORT RawImageIOFactory : public ObjectFactoryBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RawImageIOFactory);

  /** Standard class type aliases. */
  using Self = RawImageIOFactory<TPixel, VImageDimension>;
  using Superclass = ObjectFactoryBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  /** Class methods used to interface with the registered factories. */
  const char *
  GetITKSourceVersion() const override
  {
    return ITK_SOURCE_VERSION;
  }

  const char *
  GetDescription() const override
  {
    return "Raw ImageIO Factory, allows the loading of Raw images into insight";
  }

  /** Method for class instantiation. */
  itkFactorylessNewMacro(Self);

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(RawImageIOFactory);

  /** Register one factory of this type  */
  static void
  RegisterOneFactory()
  {
    ObjectFactoryBase::RegisterFactory(Self::New());
  }

protected:
  RawImageIOFactory() = default;
  ~RawImageIOFactory() override = default;
};
} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkRawImageIO.hxx"
#endif

#endif
