/* ASE - Allegro Sprite Editor
 * Copyright (C) 2001-2009  David Capello
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef RASTER_SPRITE_H_INCLUDED
#define RASTER_SPRITE_H_INCLUDED

#include "jinete/jbase.h"
#include "raster/gfxobj.h"

struct FormatOptions;
class Image;
class Layer;
class LayerFolder;
class LayerImage;
class Mask;
class Palette;
class Path;
class Stock;
class Undo;
class Sprite;

Sprite* sprite_new_copy(const Sprite* src_sprite);

/**
 * The main structure used in the whole program to handle a sprite.
 */
class Sprite : public GfxObj
{
  friend Sprite* sprite_new_copy(const Sprite* src_sprite);

public:
  char filename[512];		/* sprite's file name */
  bool associated_to_file;	/* true if this sprite is associated
				   to a file in the file-system */
  int imgtype;			/* image type */
  int w, h;			/* image width/height size (in pixels) */
  int frames;			/* how many frames has this sprite */
  int *frlens;			/* duration per frame */
  int frame;			/* current frame, range [0,frames) */
  JList palettes;		/* list of palettes */
  Stock *stock;			/* stock to get images */
private:
  LayerFolder *m_folder;	/* main folder of layers */
public:
  Layer *layer;			/* current layer */
  Path *path;			/* working path */
  Mask *mask;			/* selected mask region */
  Undo *undo;			/* undo stack */
  struct {
    JList paths;		/* paths */
    JList masks;		/* masks */
  } repository;

  /**
   * Selected mask region boundaries
   */
  struct {
    int nseg;
    struct _BoundSeg *seg;
  } bound;
  struct {
    int scroll_x;
    int scroll_y;
    int zoom;
  } preferred;

private:

  /**
   * Mutex to modify the 'locked' flag.
   */
  JMutex m_mutex;

  /**
   * True if some thread is writing the sprite.
   */
  bool m_write_lock;

  /**
   * Greater than zero when one or more threads are reading the sprite.
   */
  int m_read_locks;

public:

  /**
   * Data to save the file in the same format that it was loaded
   */
  FormatOptions *format_options;

  Sprite(int imgtype, int w, int h);
  virtual ~Sprite();

  bool lock(bool write);
  bool lock_to_write();
  void unlock_to_read();
  void unlock();

  LayerFolder* get_folder() const { return m_folder; }
};

Sprite* sprite_new(int imgtype, int w, int h);
Sprite* sprite_new_flatten_copy(const Sprite* src_sprite);
Sprite* sprite_new_with_layer(int imgtype, int w, int h);

bool sprite_is_modified(const Sprite* sprite);
bool sprite_is_associated_to_file(const Sprite* sprite);
void sprite_mark_as_saved(Sprite* sprite);

bool sprite_need_alpha(const Sprite* sprite);

Palette* sprite_get_palette(const Sprite* sprite, int frame);
void sprite_set_palette(Sprite* sprite, Palette* pal, bool truncate);
void sprite_reset_palettes(Sprite* sprite);
void sprite_delete_palette(Sprite* sprite, Palette* pal);

void sprite_set_filename(Sprite* sprite, const char* filename);
void sprite_set_format_options(Sprite* sprite, FormatOptions* format_options);
void sprite_set_size(Sprite* sprite, int w, int h);
void sprite_set_frames(Sprite* sprite, int frames);
void sprite_set_frlen(Sprite* sprite, int frame, int msecs);
int sprite_get_frlen(const Sprite* sprite, int frame);
void sprite_set_speed(Sprite* sprite, int msecs);
void sprite_set_path(Sprite* sprite, const Path* path);
void sprite_set_mask(Sprite* sprite, const Mask* mask);
void sprite_set_layer(Sprite* sprite, Layer* layer);
void sprite_set_frame(Sprite* sprite, int frame);

LayerImage* sprite_get_background_layer(const Sprite* sprite);

void sprite_add_path(Sprite* sprite, Path* path);
void sprite_remove_path(Sprite* sprite, Path* path);

void sprite_add_mask(Sprite* sprite, Mask* mask);
void sprite_remove_mask(Sprite* sprite, Mask* mask);
Mask* sprite_request_mask(const Sprite* sprite, const char *name);

void sprite_render(const Sprite* sprite, Image* image, int x, int y);
void sprite_generate_mask_boundaries(Sprite* sprite);

Layer* sprite_index2layer(const Sprite* sprite, int index);
int sprite_layer2index(const Sprite* sprite, const Layer* layer);
int sprite_count_layers(const Sprite* sprite);
void sprite_get_cels(const Sprite* sprite, CelList& cels);

int sprite_getpixel(const Sprite* sprite, int x, int y);

int sprite_get_memsize(const Sprite* sprite);

#endif