/* $Id$ */

/*
 * Copyright (C) 2006 Richard Braun
 * 
 * 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 _MTXHISTORY_H
#define _MTXHISTORY_H

#include <string>
#include <vector>

/**
 * Object implementing history support.
 * 
 * Mainly used for command line history.
 */
class MtxHistory
{
  private:
    /**
     * Vector of strings handled.
     */
    std::vector<std::string> strings;

    /**
     * Iterator pointing to the current string.
     */
    std::vector<std::string>::iterator offset;

  public:
    /**
     * Default constructor.
     */
    MtxHistory();

    /**
     * Add a string at the end of the vector of strings.
     * 
     * The offset is automatically set to this string.
     */
    void addString(const std::string &string);

    /**
     * Return string at current offset.
     * 
     * Return an empty string if offset points at the end of the vector.
     */
    std::string getString() const;

    /**
     * Decrement offset.
     * 
     * If offset is already set to the first string, nothing is done.
     */
    void previousString();

    /**
     * Increment offset.
     * 
     * If offset is already set to the end of the vector, nothing is done.
     */
    void nextString();
};

#endif /* _MTXHISTORY_H */