kmacroexpander.h

Go to the documentation of this file.

/*
    This file is part of the KDE libraries

    Copyright (c) 2002-2003 Oswald Buddenhagen <ossi@kde.org>
    Copyright (c) 2003 Waldo Bastian <bastian@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 KMACROEXPANDER_H
#define KMACROEXPANDER_H

#include <kdecore_export.h>
#include <QtCore/QChar>

class QString;
class QStringList;
template <typename KT, typename VT> class QHash;
class KMacroExpanderBasePrivate;

class KDECORE_EXPORT KMacroExpanderBase {

public:
    explicit KMacroExpanderBase( QChar c = QLatin1Char('%') );

    virtual ~KMacroExpanderBase();

    void expandMacros( QString &str );

    // TODO: This documentation is relevant for end-users. Where to put it?
    bool expandMacrosShellQuote( QString &str, int &pos );

    bool expandMacrosShellQuote( QString &str );

    void setEscapeChar( QChar c );

    QChar escapeChar() const;

protected:
    virtual int expandPlainMacro( const QString &str, int pos, QStringList &ret );

    virtual int expandEscapedMacro( const QString &str, int pos, QStringList &ret );

private:
    KMacroExpanderBasePrivate * const d;
};

class KDECORE_EXPORT KWordMacroExpander : public KMacroExpanderBase {

public:
    explicit KWordMacroExpander( QChar c = QLatin1Char('%') ) : KMacroExpanderBase( c ) {}

protected:
    virtual int expandPlainMacro( const QString &str, int pos, QStringList &ret );
    virtual int expandEscapedMacro( const QString &str, int pos, QStringList &ret );

    virtual bool expandMacro( const QString &str, QStringList &ret ) = 0;
};

class KDECORE_EXPORT KCharMacroExpander : public KMacroExpanderBase {

public:
    explicit KCharMacroExpander( QChar c = QLatin1Char('%') ) : KMacroExpanderBase( c ) {}

protected:
    virtual int expandPlainMacro( const QString &str, int pos, QStringList &ret );
    virtual int expandEscapedMacro( const QString &str, int pos, QStringList &ret );

    virtual bool expandMacro( QChar chr, QStringList &ret ) = 0;
};

namespace KMacroExpander {
    KDECORE_EXPORT QString expandMacros( const QString &str, const QHash<QChar,QString> &map, QChar c = QLatin1Char('%') );

    KDECORE_EXPORT QString expandMacrosShellQuote( const QString &str, const QHash<QChar,QString> &map,
                                                   QChar c = QLatin1Char('%') );

    KDECORE_EXPORT QString expandMacros( const QString &str, const QHash<QString,QString> &map,
                                         QChar c = QLatin1Char('%') );

    KDECORE_EXPORT QString expandMacrosShellQuote( const QString &str, const QHash<QString,QString> &map,
                                                   QChar c = QLatin1Char('%') );

    KDECORE_EXPORT QString expandMacros( const QString &str, const QHash<QChar,QStringList> &map,
                                         QChar c = QLatin1Char('%') );
    KDECORE_EXPORT QString expandMacros( const QString &str, const QHash<QString,QStringList> &map,
                                         QChar c = QLatin1Char('%') );

    KDECORE_EXPORT QString expandMacrosShellQuote( const QString &str, const QHash<QChar,QStringList> &map,
                                                   QChar c = QLatin1Char('%') );
    KDECORE_EXPORT QString expandMacrosShellQuote( const QString &str, const QHash<QString,QStringList> &map, 
                                                   QChar c = QLatin1Char('%') );
}

#endif /* KMACROEXPANDER_H */