/**
 * Copyright (C) 2006-2019 Christopho, Solarus - http://www.solarus-games.org
 *
 * Solarus 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 3 of the License, or
 * (at your option) any later version.
 *
 * Solarus 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, see <http://www.gnu.org/licenses/>.
 */
#ifndef SOLARUS_HERO_SPRITES_H
#define SOLARUS_HERO_SPRITES_H

#include "solarus/core/Common.h"
#include "solarus/core/Rectangle.h"
#include "solarus/entities/Ground.h"
#include "solarus/graphics/SpritePtr.h"
#include "solarus/lua/ScopedLuaRef.h"
#include <memory>
#include <string>

namespace Solarus {

class CarriedObject;
class Equipment;
class Hero;
class LuaContext;
class Sprite;

/**
 * \brief Manages the animations of the hero's main sprites.
 *
 * This class handles the animations of the hero's main sprites: the tunic,
 * the sword, the sword stars, the shield, the shadow and the ground.
 * It also handles the sprite-dependent sounds such as the sword sound.
 *
 * This class does not know anything about the hero's internal state:
 * it is the role of the state to call this class to display the appropriate animation.
 */
class HeroSprites {

  public:

    HeroSprites(Hero& hero, Equipment& equipment);

    void update();
    void draw_on_map();
    void set_suspended(bool suspended);
    void rebuild_equipment();
    void notify_creating();
    void notify_tileset_changed();

    const std::string& get_tunic_sprite_id() const;
    void set_tunic_sprite_id(const std::string& sprite_id);
    const std::string& get_sword_sprite_id() const;
    void set_sword_sprite_id(const std::string& sprite_id);
    const std::string& get_sword_stars_sprite_id() const;
    void set_sword_stars_sprite_id(const std::string& sprite_id);
    const std::string& get_sword_sound_id() const;
    void set_sword_sound_id(const std::string& sound_id);
    const std::string& get_shield_sprite_id() const;
    void set_shield_sprite_id(const std::string& sprite_id);

    void blink(uint32_t duration);
    void stop_blinking();
    bool is_blinking() const;
    bool is_walking() const;
    void set_clipping_rectangle(
        const Rectangle& clipping_rectangle = Rectangle()
    );

    int get_animation_direction(
        int keys_direction, int real_movement_direction) const;
    int get_animation_direction() const;
    int get_animation_direction8() const;
    void set_animation_direction(int direction);
    void set_animation_direction8(int direction);
    void restart_animation();
    bool is_animation_finished() const;
    int get_current_frame() const;
    void save_animation_direction();
    void restore_animation_direction();
    void set_ignore_suspend(bool ignore_suspend);

    bool has_tunic_animation(const std::string& animation) const;
    const std::string& get_tunic_animation() const;

    void set_animation_stopped_common();
    void set_animation_stopped_normal();
    void set_animation_stopped_sword_loading();
    void set_animation_stopped_carrying();
    void set_animation_stopped_swimming();
    void set_animation_walking_common();
    void set_animation_walking_normal();
    void set_animation_walking_sword_loading();
    void set_animation_walking_carrying();
    void set_animation_swimming_slow();
    void set_animation_swimming_fast();
    void set_animation_walking_diagonal(int direction8);
    void set_animation_sword();
    void play_sword_sound();
    void set_animation_sword_tapping();
    void set_animation_spin_attack();
    void set_animation_super_spin_attack();
    void set_animation_grabbing();
    void set_animation_pulling();
    void set_animation_pushing();
    void set_animation_lifting();
    void set_animation_jumping();
    void set_animation_hurt();
    void set_animation_falling();
    void set_animation_brandish();
    void set_animation_victory();
    void set_animation_prepare_running();
    void set_animation_running();
    void set_animation_boomerang(const std::string& tunic_preparing_animation);
    void set_animation(const std::string& animation);
    void set_animation(
        const std::string& animation,
        const ScopedLuaRef& callback_ref
    );

    void create_ground(Ground grond);
    void destroy_ground();
    void play_ground_sound();

    void set_lifted_item(const std::shared_ptr<CarriedObject>& lifted_item);

  private:

    bool is_visible() const;
    bool is_sword_visible() const;
    bool is_sword_stars_visible() const;
    bool is_shield_visible() const;
    bool is_trail_visible() const;
    bool is_ground_visible() const;

    std::string get_default_tunic_sprite_id() const;
    std::string get_default_sword_sprite_id() const;
    std::string get_default_sword_sound_id() const;
    std::string get_default_shield_sprite_id() const;

    void stop_displaying_sword();
    void stop_displaying_sword_stars();
    void stop_displaying_shield();
    void stop_displaying_trail();

    void set_tunic_animation(const std::string& animation);
    void set_tunic_animation(const std::string& animation, const ScopedLuaRef& callback_ref);

    LuaContext& get_lua_context();

    Hero& hero;                             /**< The hero. */
    Equipment& equipment;                   /**< Equipment of the player. */

    // Tunic.
    std::string tunic_sprite_id;            /**< Animation set used for the tunic.
                                             * By default, "hero/tunicX" where X is the tunic level. */
    bool has_default_tunic_sprite;          /**< Whether tunic_sprite_id has the defaut value. */
    SpritePtr tunic_sprite;                 /**< sprite of the current tunic */

    // Sword.
    std::string sword_sprite_id;            /**< Animation set used for the sword.
                                             * An empty string means no sword sprite.
                                             * By default, "hero/swordX" where X is the sword level. */
    bool has_default_sword_sprite;          /**< Whether sword_sprite_id has the defaut value. */
    SpritePtr sword_sprite;                 /**< Current sword sprite. */
    std::string sword_stars_sprite_id;      /**< Animation set used for the sword stars.
                                             * An empty string means no sword stars sprite. */
    SpritePtr sword_stars_sprite;           /**< Stars running along the sword when the sword is loading. */

    std::string sword_sound_id;             /**< Sound played when using the sword.
                                             * By default, "swordX" where X is the sword level. */
    bool has_default_sword_sound;           /**< Whether sword_sound_id has the defaut value. */

    // Shield.
    std::string shield_sprite_id;           /**< Animation set used for the shield.
                                             * An empty string means no shield sprite.
                                             * By default, "hero/shieldX" where X is the shield level. */
    bool has_default_shield_sprite;         /**< Whether shield_sprite_id has the defaut value. */
    SpritePtr shield_sprite;                /**< Current shield sprite. */

    // Other sprites.
    SpritePtr shadow_sprite;                /**< shadow of the hero, only in specific states (most of the time
                                             * the shadow is with the tunic sprite) */
    SpritePtr ground_sprite;                /**< ground displayed under the hero (e.g. grass or shallow water) */
    SpritePtr trail_sprite;                 /**< trail of dust that the hero lets behind him (e.g. when running) */

    std::string ground_sound_id;            /**< sound id of the current ground displayed under the hero */

    // State.
    static const int
        animation_directions[8][2];         /**< possible directions of the animation for each movement direction */

    int animation_direction_saved;          /**< direction of the hero's sprites, saved before
                                              * showing a sprite animation having only one direction */
    uint32_t when_suspended;                /**< date when the game was suspended */

    bool blinking;                          /**< Whether the hero's sprites are blinking. */
    uint32_t end_blink_date;                /**< When the hero's sprites stop blinking.
                                             * 0 means infinite. */
    bool walking;                           /**< stopped or walking? */
    Rectangle clipping_rectangle;           /**< when drawing the sprites onto a map, indicates an area of the map to be restricted to
                                             * (usually, the whole map is considered and this rectangle's values are all 0) */
    std::shared_ptr<CarriedObject>
        lifted_item;                        /**< if not nullptr, an item to display above the hero */

    ScopedLuaRef animation_callback_ref;    /**< Lua ref of a function to call when a custom animation ends. */
};

}

#endif

