kde-workspace/kate/part/utils/katecmd.h
Ivailo Monev f68295ea28 generic: move sub-projects from kde-baseapps [ci reset]
Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
2022-05-14 21:56:54 +03:00

107 lines
3.3 KiB
C++

/* This file is part of the KDE libraries and the Kate part.
*
* Copyright (C) 2001-2010 Christoph Cullmann <cullmann@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KATE_CMD_H
#define KATE_CMD_H
#include "katepartinterfaces_export.h"
#include <ktexteditor/commandinterface.h>
#include <kcompletion.h>
#include <QtCore/QHash>
#include <QtCore/QStringList>
class KATEPARTINTERFACES_EXPORT KateCmd
{
public:
KateCmd ();
~KateCmd ();
static KateCmd *self ();
bool registerCommand (KTextEditor::Command *cmd);
bool unregisterCommand (KTextEditor::Command *cmd);
KTextEditor::Command *queryCommand (const QString &cmd) const;
QList<KTextEditor::Command*> commands() const;
QStringList commandList() const;
QStringList cmds ();
void appendHistory( const QString &cmd );
const QString fromHistory( int i ) const;
uint historyLength() const { return m_history.count(); }
KCompletion* commandCompletionObject();
private:
QHash<QString, KTextEditor::Command *> m_dict;
QStringList m_cmds;
QStringList m_history;
KCompletion m_cmdCompletion; // shared completion object for all KateCmdLineEdits in each KTE::View
};
/**
* A KCompletion object that completes last ?unquoted? word in the string
* passed. Do not mistake "shell" for anything related to quoting, this
* simply mimics shell tab completion by completing the last word in the
* provided text.
*/
class KateCmdShellCompletion : public KCompletion
{
public:
KateCmdShellCompletion();
/**
* Finds completions to the given text.
* The first match is returned and emitted in the signal match().
* @param text the text to complete
* @return the first match, or QString() if not found
*/
QString makeCompletion(const QString &text);
protected:
// Called by KCompletion
void postProcessMatch( QString *match ) const;
void postProcessMatches( QStringList *matches ) const;
void postProcessMatches( KCompletionMatches *matches ) const;
private:
/**
* Split text at the last unquoted space
*
* @param text_start will be set to the text at the left, including the space
* @param text_compl Will be set to the text at the right. This is the text to complete.
*/
void splitText( const QString &text, QString &text_start, QString &text_compl ) const;
QChar m_word_break_char;
QChar m_quote_char1;
QChar m_quote_char2;
QChar m_escape_char;
QString m_text_start;
QString m_text_compl;
};
#endif
// kate: space-indent on; indent-width 2; replace-tabs on;