readline.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMON_READLINE_H
#define COMMON_READLINE_H

#include <vector>
#include <list>
#include <set>
#include <map>

#include "src/common/types.h"
#include "src/common/ustring.h"

#include "src/events/types.h"

namespace Common {

class ReadLine {
public:
    ReadLine(size_t historySize);
    ~ReadLine();

    void historyIgnoreSpace(bool ignoreSpace);
    void historyIgnoreDups (bool ignoreDups);
    void historyEraseDups  (bool eraseDups);

    void clearHistory();

    void addCommand(const UString &command);

    void setArguments(const UString &command, const std::vector<UString> &arguments);
    void setArguments(const UString &command);

    const UString &getCurrentLine() const;

    size_t getCursorPosition() const;

    bool getOverwrite() const;

    const std::vector<UString> &getCompleteHint(size_t &maxSize) const;

    void addInput(uint32 c);
    void addInput(const UString &str);

    bool processEvent(const Events::Event &event, UString &command);


private:
    struct HistorySave {
        std::list<UString>::iterator position;
        UString line;
    };

    typedef std::set<UString> CommandSet;
    typedef std::map<UString, CommandSet> ArgumentSets;


    size_t _historySizeMax;     
    size_t _historySizeCurrent; 

    bool _historyIgnoreSpace; 
    bool _historyIgnoreDups;  
    bool _historyEraseDups;   

    size_t _cursorPosition; 

    bool _overwrite; 

    UString _currentLine;    
    UString _currentLineBak; 

    std::list<UString> _history;
    std::list<UString>::iterator _historyPosition;

    std::list<HistorySave> _historySave;

    CommandSet _commands;
    ArgumentSets _arguments;

    std::vector<UString> _completeHint;
    size_t _maxHintSize;


    std::list<HistorySave>::iterator findHistorySave();

    void addCurrentLineToHistory();

    void updateHistory();

    void browseUp();
    void browseDown();
    void browseTop();
    void browseBottom();

    bool processKeyDown(const Events::Event &event, UString &command);
    bool processTextInput(const Events::Event &event, UString &command);

    void tabComplete();
    void tabComplete(const UString &prefix, const UString &input,
                     const CommandSet &commands);

    UString::iterator getCurrentPosition() const;

    size_t findLastWordStart(bool onlySpace = false) const;
    size_t findNextWordEnd(bool onlySpace = false) const;

    static bool isWordCharacter(uint32 c, bool onlySpace = false);
    static UString findCommonSubstring(const std::list<UString> &strings);
};

} // End of namespace Common

#endif // COMMON_READLINE_H