Filter.h

/*
    SPDX-FileCopyrightText: 2007-2008 Robert Knight <robertknight@gmail.com>
 
    SPDX-License-Identifier: GPL-2.0-or-later
 
    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., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301  USA.
*/
 
#ifndef FILTER_H
#define FILTER_H
 
// Qt
#include <QAction>
#include <QHash>
#include <QList>
#include <QObject>
#include <QRegExp>
#include <QStringList>
#include <span>
 
namespace Konsole
{
 
typedef unsigned char LineProperty;
class Character;
 
/**
 * A filter processes blocks of text looking for certain patterns (such as URLs or keywords from a list)
 * and marks the areas which match the filter's patterns as 'hotspots'.
 *
 * Each hotspot has a type identifier associated with it ( such as a link or a highlighted section ),
 * and an action.  When the user performs some activity such as a mouse-click in a hotspot area ( the exact
 * action will depend on what is displaying the block of text which the filter is processing ), the hotspot's
 * activate() method should be called.  Depending on the type of hotspot this will trigger a suitable response.
 *
 * For example, if a hotspot represents a URL then a suitable action would be opening that URL in a web browser.
 * Hotspots may have more than one action, in which case the list of actions can be obtained using the
 * actions() method.
 *
 * Different subclasses of filter will return different types of hotspot.
 * Subclasses must reimplement the process() method to examine a block of text and identify sections of interest.
 * When processing the text they should create instances of Filter::HotSpot subclasses for sections of interest
 * and add them to the filter's list of hotspots using addHotSpot()
 */
class Filter : public QObject
{
public:
    /**
     * Represents an area of text which matched the pattern a particular filter has been looking for.
     *
     * Each hotspot has a type identifier associated with it ( such as a link or a highlighted section ),
     * and an action.  When the user performs some activity such as a mouse-click in a hotspot area ( the exact
     * action will depend on what is displaying the block of text which the filter is processing ), the hotspot's
     * activate() method should be called.  Depending on the type of hotspot this will trigger a suitable response.
     *
     * For example, if a hotspot represents a URL then a suitable action would be opening that URL in a web browser.
     * Hotspots may have more than one action, in which case the list of actions can be obtained using the
     * actions() method.  These actions may then be displayed in a popup menu or toolbar for example.
     */
    class HotSpot
    {
    public:
        /**
         * Constructs a new hotspot which covers the area from (@p startLine,@p startColumn) to (@p endLine,@p endColumn)
         * in a block of text.
         */
        HotSpot(int startLine, int startColumn, int endLine, int endColumn);
        virtual ~HotSpot();
 
        enum Type {
            // the type of the hotspot is not specified
            NotSpecified,
            // this hotspot represents a clickable link
            Link,
            // this hotspot represents a marker
            Marker
        };
 
        /** Returns the line when the hotspot area starts */
        int startLine() const;
        /** Returns the line where the hotspot area ends */
        int endLine() const;
        /** Returns the column on startLine() where the hotspot area starts */
        int startColumn() const;
        /** Returns the column on endLine() where the hotspot area ends */
        int endColumn() const;
        /**
         * Returns the type of the hotspot.  This is usually used as a hint for views on how to represent
         * the hotspot graphically.  eg.  Link hotspots are typically underlined when the user mouses over them
         */
        Type type() const;
        /**
         * Causes the an action associated with a hotspot to be triggered.
         *
         * @param action The action to trigger.  This is
         * typically empty ( in which case the default action should be performed ) or
         * one of the object names from the actions() list.  In which case the associated
         * action should be performed.
         */
        virtual void activate(const QString &action = QString()) = 0;
        /**
         * Returns a list of actions associated with the hotspot which can be used in a
         * menu or toolbar
         */
        virtual QList<QAction *> actions();
 
    protected:
        /** Sets the type of a hotspot.  This should only be set once */
        void setType(Type type);
 
    private:
        int _startLine;
        int _startColumn;
        int _endLine;
        int _endColumn;
        Type _type;
    };
 
    /** Constructs a new filter. */
    Filter();
    ~Filter() override;
 
    /** Causes the filter to process the block of text currently in its internal buffer */
    virtual void process() = 0;
 
    /**
     * Empties the filters internal buffer and resets the line count back to 0.
     * All hotspots are deleted.
     */
    void reset();
 
    /** Adds a new line of text to the filter and increments the line count */
    // void addLine(const QString& string);
 
    /** Returns the hotspot which covers the given @p line and @p column, or 0 if no hotspot covers that area */
    HotSpot *hotSpotAt(int line, int column) const;
 
    /** Returns the list of hotspots identified by the filter */
    const std::vector<std::unique_ptr<HotSpot>> &hotSpots() const;
 
    /** Returns the list of hotspots identified by the filter which occur on a given line */
    QList<HotSpot *> hotSpotsAtLine(int line) const;
 
    /**
     * TODO: Document me
     */
    void setBuffer(const QString *buffer, const QList<int> *linePositions);
 
protected:
    /** Adds a new hotspot to the list */
    void addHotSpot(std::unique_ptr<HotSpot> &&);
    /** Returns the internal buffer */
    const QString *buffer();
    /** Converts a character position within buffer() to a line and column */
    void getLineColumn(int position, int &startLine, int &startColumn);
 
private:
    std::multimap<int, std::unique_ptr<HotSpot>> _hotspots;
    std::vector<std::unique_ptr<HotSpot>> _hotspotList;
 
    const QList<int> *_linePositions;
    const QString *_buffer;
};
 
/**
 * A filter which searches for sections of text matching a regular expression and creates a new RegExpFilter::HotSpot
 * instance for them.
 *
 * Subclasses can reimplement newHotSpot() to return custom hotspot types when matches for the regular expression
 * are found.
 */
class RegExpFilter : public Filter
{
public:
    /**
     * Type of hotspot created by RegExpFilter.  The capturedTexts() method can be used to find the text
     * matched by the filter's regular expression.
     */
    class HotSpot : public Filter::HotSpot
    {
    public:
        HotSpot(int startLine, int startColumn, int endLine, int endColumn);
        void activate(const QString &action = QString()) override;
 
        /** Sets the captured texts associated with this hotspot */
        void setCapturedTexts(const QStringList &texts);
        /** Returns the texts found by the filter when matching the filter's regular expression */
        QStringList capturedTexts() const;
 
    private:
        QStringList _capturedTexts;
    };
 
    /** Constructs a new regular expression filter */
    RegExpFilter();
 
    /**
     * Sets the regular expression which the filter searches for in blocks of text.
     *
     * Regular expressions which match the empty string are treated as not matching
     * anything.
     */
    void setRegExp(const QRegExp &text);
    /** Returns the regular expression which the filter searches for in blocks of text */
    QRegExp regExp() const;
 
    /**
     * Reimplemented to search the filter's text buffer for text matching regExp()
     *
     * If regexp matches the empty string, then process() will return immediately
     * without finding results.
     */
    void process() override;
 
protected:
    /**
     * Called when a match for the regular expression is encountered.  Subclasses should reimplement this
     * to return custom hotspot types
     */
    virtual std::unique_ptr<HotSpot> newHotSpot(int startLine, int startColumn, int endLine, int endColumn);
 
private:
    QRegExp _searchText;
};
 
class FilterObject;
 
/** A filter which matches URLs in blocks of text */
class UrlFilter : public RegExpFilter
{
    Q_OBJECT
public:
    /**
     * Hotspot type created by UrlFilter instances.  The activate() method opens a web browser
     * at the given URL when called.
     */
    class HotSpot : public RegExpFilter::HotSpot
    {
    public:
        HotSpot(int startLine, int startColumn, int endLine, int endColumn);
        ~HotSpot() override;
 
        FilterObject *getUrlObject() const;
 
        QList<QAction *> actions() override;
 
        /**
         * Open a web browser at the current URL.  The url itself can be determined using
         * the capturedTexts() method.
         */
        void activate(const QString &action = QString()) override;
 
    private:
        enum UrlType { StandardUrl, Email, Unknown };
        UrlType urlType() const;
 
        FilterObject *_urlObject;
    };
 
    UrlFilter();
 
protected:
    std::unique_ptr<RegExpFilter::HotSpot> newHotSpot(int, int, int, int) override;
 
private:
    static const QRegExp FullUrlRegExp;
    static const QRegExp EmailAddressRegExp;
 
    // combined OR of FullUrlRegExp and EmailAddressRegExp
    static const QRegExp CompleteUrlRegExp;
Q_SIGNALS:
    void activated(const QUrl &url, bool fromContextMenu);
};
 
class FilterObject : public QObject
{
    Q_OBJECT
public:
    FilterObject(Filter::HotSpot *filter)
        : _filter(filter)
    {
    }
 
    void emitActivated(const QUrl &url, bool fromContextMenu);
public Q_SLOTS:
    void activate();
 
private:
    Filter::HotSpot *_filter;
Q_SIGNALS:
    void activated(const QUrl &url, bool fromContextMenu);
};
 
/**
 * A chain which allows a group of filters to be processed as one.
 * The chain owns the filters added to it and deletes them when the chain itself is destroyed.
 *
 * Use addFilter() to add a new filter to the chain.
 * When new text to be filtered arrives, use addLine() to add each additional
 * line of text which needs to be processed and then after adding the last line, use
 * process() to cause each filter in the chain to process the text.
 *
 * After processing a block of text, the reset() method can be used to set the filter chain's
 * internal cursor back to the first line.
 *
 * The hotSpotAt() method will return the first hotspot which covers a given position.
 *
 * The hotSpots() and hotSpotsAtLine() method return all of the hotspots in the text and on
 * a given line respectively.
 */
class FilterChain : protected std::vector<std::unique_ptr<Filter>>
{
public:
    virtual ~FilterChain();
 
    /** Adds a new filter to the chain.  The chain will delete this filter when it is destroyed */
    void addFilter(std::unique_ptr<Filter> &&filter);
    /** Removes a filter from the chain.  The chain will no longer delete the filter when destroyed */
    void removeFilter(Filter *filter);
    /** Returns true if the chain contains @p filter */
    bool containsFilter(Filter *filter);
 
    /** Resets each filter in the chain */
    void reset();
    /**
     * Processes each filter in the chain
     */
    void process();
 
    /** Sets the buffer for each filter in the chain to process. */
    void setBuffer(const QString *buffer, const QList<int> *linePositions);
 
    /** Returns the first hotspot which occurs at @p line, @p column or 0 if no hotspot was found */
    Filter::HotSpot *hotSpotAt(int line, int column) const;
    /** Returns a list of all the hotspots in all the chain's filters */
    QList<Filter::HotSpot *> hotSpots() const;
    /** Returns a list of all hotspots at the given line in all the chain's filters */
    QList<Filter::HotSpot> hotSpotsAtLine(int line) const;
};
 
/** A filter chain which processes character images from terminal displays */
class TerminalImageFilterChain : public FilterChain
{
public:
    TerminalImageFilterChain();
    ~TerminalImageFilterChain() override;
 
    /**
     * Set the current terminal image to @p image.
     *
     * @param image The terminal image
     * @param lines The number of lines in the terminal image
     * @param columns The number of columns in the terminal image
     * @param lineProperties The line properties to set for image
     */
    void setImage(std::span<const Character> image, int lines, int columns, const QVector<LineProperty> &lineProperties);
 
private:
    QString *_buffer;
    QList<int> *_linePositions;
};
 
}
 
typedef Konsole::Filter Filter;
 
#endif // FILTER_H