Parser.h

Go to the documentation of this file.

/***************************************************************************
                Parser.h -  parser for Kwave's internal commands
                             -------------------
    begin                : Sat Feb  3 2001
    copyright            : (C) 2001 by Thomas Eschenbacher
    email                : Thomas Eschenbacher <thomas.eschenbacher@gmx.de>

 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program 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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef PARSER_H
#define PARSER_H

#include "config.h"

#include <QtGlobal>
#include <QString>
#include <QStringList>
#include <QUrl>

#include "libkwave/Sample.h" // for sample_index_t

//*****************************************************************************
namespace Kwave
{
    class Q_DECL_EXPORT Parser
    {
    public:
        Parser(const QString &init);

        virtual ~Parser();

        inline QString command() {
            return m_command;
        }

        inline const QStringList &params() {
            return m_param;
        }

        inline bool hasParams() {
            return (m_param.count() != 0);
        }

        inline bool hasMultipleCommands() {
            return (m_commands.count() > 1);
        }

        inline QStringList commandList() { return m_commands; }

        inline bool isDone () const {
            return (static_cast<int>(m_current) >= m_param.count());
        }

        inline unsigned int count() const {
            return m_param.count();
        }

        const QString &firstParam();

        const QString &nextParam();

        QStringList remainingParams();

        void skipParam();

        bool toBool();

        int toInt();

        unsigned int toUInt();

        sample_index_t toSampleIndex();

        double toDouble();

        static QString escape(const QString &text);

        static QString escapeForFileName(const QString &text);

        static QString unescape(const QString &text);

        static QUrl toUrl(const QString &command);

        static QString fromUrl(const QUrl &url);

    protected:

        QStringList splitCommands(QString &line);

    private:
        QString m_command;

        QStringList m_param;

        unsigned int m_current;

        QStringList m_commands;

    };
}

#endif /* PARSER_H */

//***************************************************************************
//***************************************************************************