// Aseprite
// Copyright (C) 2001-2015  David Capello
//
// This program is distributed under the terms of
// the End-User License Agreement for Aseprite.

#ifndef APP_UI_EDITOR_STATES_HISTORY_H_INCLUDED
#define APP_UI_EDITOR_STATES_HISTORY_H_INCLUDED
#pragma once

#include "app/ui/editor/editor_state.h"

#include <vector>

namespace app {

  // Stack of states in the editor. The top state is the current state
  // of the editor.
  class EditorStatesHistory {
  public:
    EditorStatesHistory();
    ~EditorStatesHistory();

    // Gets the current state.
    EditorStatePtr top();

    // Adds a new state in the history.
    void push(const EditorStatePtr& state);

    // Removes a state from the history (you should keep a reference of
    // the state with top() if you want to keep it in memory).
    void pop();

    // Deletes all the history.
    void clear();

  private:
    // Stack of states (the back of the vector is the top of the stack).
    std::vector<EditorStatePtr> m_states;
  };

} // namespace app

#endif
