KateCommands::SedReplace Class Reference

#include <katesedcmd.h>

Inheritance diagram for KateCommands::SedReplace:

Public Member Functions
bool	exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg, const KTextEditor::Range &r) override
bool	help (class KTextEditor::View *, const QString &, QString &) override
bool	supportsRange (const QString &) override
Public Member Functions inherited from KTextEditor::Command
	Command (const QStringList &cmds, QObject *parent=nullptr)
	~Command () override
const QStringList &	cmds () const
virtual KCompletion *	completionObject (KTextEditor::View *view, const QString &cmdname)
virtual void	processText (KTextEditor::View *view, const QString &text)
virtual bool	wantsToProcessText (const QString &cmdname)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static bool	parse (const QString &sedReplaceString, QString &destDelim, int &destFindBeginPos, int &destFindEndPos, int &destReplaceBeginPos, int &destReplaceEndPos)
static SedReplace *	self ()
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
virtual bool	interactiveSedReplace (KTextEditor::ViewPrivate *kateView, std::shared_ptr< InteractiveSedReplacer > interactiveSedReplace)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName

Detailed Description

Support vim/sed style search and replace.

Author

Charles Samuels charl.nosp@m.es@k.nosp@m.de.or.nosp@m.g

Definition at line 33 of file katesedcmd.h.

Constructor & Destructor Documentation

SedReplace()

KateCommands::SedReplace::SedReplace ( )

inlineprotected

Definition at line 38 of file katesedcmd.h.

~SedReplace()

KateCommands::SedReplace::~SedReplace ( )

inlineoverride

Definition at line 44 of file katesedcmd.h.

Member Function Documentation

exec()

bool KateCommands::SedReplace::exec ( class KTextEditor::View * view, const QString & cmd, QString & errorMsg, const KTextEditor::Range & r )

overridevirtual

Execute command.

Valid command strings are:

• s/search/replace/ find search, replace it with replace on this line
• %s/search/replace/ do the same to the whole file
• s/search/replace/i do the search and replace case insensitively
• $s/search/replace/ do the search are replacement to the selection only

Note

$s/// is currently unsupported

Parameters

view	view to use for execution
cmd	cmd string
errorMsg	error to return if no success

Returns

success

Implements KTextEditor::Command.

Definition at line 65 of file katesedcmd.cpp.

help()

bool KateCommands::SedReplace::help ( class KTextEditor::View * , const QString & , QString &  )

inlineoverridevirtual

This command does not have help.

See also

KTextEditor::Command::help

Implements KTextEditor::Command.

Definition at line 72 of file katesedcmd.h.

interactiveSedReplace()

bool KateCommands::SedReplace::interactiveSedReplace ( KTextEditor::ViewPrivate * kateView, std::shared_ptr< InteractiveSedReplacer > interactiveSedReplace )

protectedvirtual

Definition at line 131 of file katesedcmd.cpp.

parse()

bool KateCommands::SedReplace::parse ( const QString & sedReplaceString, QString & destDelim, int & destFindBeginPos, int & destFindEndPos, int & destReplaceBeginPos, int & destReplaceEndPos )

static

Parses sedReplaceString to see if it is a valid sed replace expression (e.g.

"s/find/replace/gi"). If it is, returns true and sets delimiter to the delimiter used in the expression; destFindBeginPos and destFindEndPos to the positions in * sedReplaceString of the begin and end of the "find" term; and destReplaceBeginPos and destReplaceEndPos to the begin and end positions of the "replace" term.

Definition at line 137 of file katesedcmd.cpp.

self()

static SedReplace * KateCommands::SedReplace::self ( )

inlinestatic

Definition at line 77 of file katesedcmd.h.

supportsRange()

bool KateCommands::SedReplace::supportsRange ( const QString & cmd )

inlineoverridevirtual

Find out if a given command can act on a range.

This is used for checking if a command should be called when the user also gave a range or if an error should be raised.

Returns

true if command supports acting on a range of lines, false not. The default implementation returns false.

Reimplemented from KTextEditor::Command.

Definition at line 66 of file katesedcmd.h.

---

The documentation for this class was generated from the following files:

• katesedcmd.h
• katesedcmd.cpp