// Aseprite
// Copyright (C) 2019-2023  Igara Studio S.A.
// Copyright (C) 2001-2018  David Capello
//
// This program is distributed under the terms of
// the End-User License Agreement for Aseprite.

#ifndef APP_FILE_FILE_FORMAT_H_INCLUDED
#define APP_FILE_FILE_FORMAT_H_INCLUDED
#pragma once

#include "app/file/format_options.h"
#include "base/paths.h"
#include "dio/file_format.h"

#include <vector>

#define FILE_SUPPORT_LOAD               0x00000001
#define FILE_SUPPORT_SAVE               0x00000002
#define FILE_SUPPORT_RGB                0x00000004
#define FILE_SUPPORT_RGBA               0x00000008
#define FILE_SUPPORT_GRAY               0x00000010
#define FILE_SUPPORT_GRAYA              0x00000020
#define FILE_SUPPORT_INDEXED            0x00000040
#define FILE_SUPPORT_LAYERS             0x00000080
#define FILE_SUPPORT_FRAMES             0x00000100
#define FILE_SUPPORT_PALETTES           0x00000200
#define FILE_SUPPORT_SEQUENCES          0x00000400
#define FILE_SUPPORT_GET_FORMAT_OPTIONS 0x00000800
#define FILE_SUPPORT_TAGS               0x00001000
#define FILE_SUPPORT_BIG_PALETTES       0x00002000 // Palettes w/more than 256 colors
#define FILE_SUPPORT_PALETTE_WITH_ALPHA 0x00004000
#define FILE_ENCODE_ABSTRACT_IMAGE      0x00008000 // Use the new FileAbstractImage
#define FILE_GIF_ANI_LIMITATIONS        0x00010000

namespace app {

class FormatOptions;
class FileFormat;
class FileOp;

// A file format supported by ASE. It is the base class to extend if
// you want to add support to load and/or save a new kind of
// image/animation format.
class FileFormat {
public:
  FileFormat();
  virtual ~FileFormat();

  const char* name() const; // File format name

  // Fill "exts" variable with the supported extensions (e.g. "jpeg" and "jpg")
  void getExtensions(base::paths& exts) const;

  dio::FileFormat dioFormat() const;

  bool load(FileOp* fop);
#ifdef ENABLE_SAVE
  bool save(FileOp* fop);
#endif

  // Does post-load operation which require user intervention.
  // Returns false cancelled the operation.
  bool postLoad(FileOp* fop);

  // Returns extra options for this format. It can return != NULL
  // only if flags() returns FILE_SUPPORT_GET_FORMAT_OPTIONS.
  FormatOptionsPtr askUserForFormatOptions(FileOp* fop) { return onAskUserForFormatOptions(fop); }

  // Returns true if this file format supports the given flag.
  bool support(int f) const { return ((onGetFlags() & f) == f); }

protected:
  virtual const char* onGetName() const = 0;
  virtual void onGetExtensions(base::paths& exts) const = 0;
  virtual dio::FileFormat onGetDioFormat() const = 0;
  virtual int onGetFlags() const = 0;

  virtual bool onLoad(FileOp* fop) = 0;
  virtual bool onPostLoad(FileOp* fop) { return true; }
#ifdef ENABLE_SAVE
  virtual bool onSave(FileOp* fop) = 0;
#endif

  virtual FormatOptionsPtr onAskUserForFormatOptions(FileOp* fop)
  {
    return FormatOptionsPtr(nullptr);
  }
};

} // namespace app

#endif
