Kwave::Parser Class Reference

#include <Parser.h>

Collaboration diagram for Kwave::Parser:

Public Member Functions
	Parser (const QString &init)
virtual	~Parser ()
QString	command ()
const QStringList &	params ()
bool	hasParams ()
bool	hasMultipleCommands ()
QStringList	commandList ()
bool	isDone () const
unsigned int	count () const
const QString &	firstParam ()
const QString &	nextParam ()
QStringList	remainingParams ()
void	skipParam ()
bool	toBool ()
int	toInt ()
unsigned int	toUInt ()
sample_index_t	toSampleIndex ()
double	toDouble ()

Static Public Member Functions
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 Member Functions
QStringList	splitCommands (QString &line)

Private Attributes
QString	m_command
QStringList	m_param
unsigned int	m_current
QStringList	m_commands

Detailed Description

Definition at line 34 of file Parser.h.

Constructor & Destructor Documentation

Parser()

Kwave::Parser::Parser

(

const QString &

init

)

Constructor. Parses the given string into an optional command part and a list of parameters.

Definition at line 31 of file Parser.cpp.

References DBG, m_command, m_commands, m_param, splitCommands(), and unescape().

    :m_command(_("")), m_param(), m_current(0), m_commands()
{
    QString line       = init.trimmed();
    unsigned int level = 0;
    bool escaped       = false;
    int pos;

    m_commands = splitCommands(line);
    line = m_commands.first();

    // --- parse the command ---
    pos = line.indexOf(QLatin1Char('('));
    if (pos >= 0) {
        // command present
        m_command = line.left(pos).simplified();
        line.remove(0, pos+1);
    } else {
        m_command.clear();
    }

    // --- parse the list of parameters ---
    QString param;
    while (line.length()) {
        QChar c = line[0];
        line.remove(0,1);

        // the next character is escaped
        if (!escaped && (c.toLatin1() == '\\')) {
            escaped = true;
            param += c;
            continue;
        }

        // escaped character
        if (escaped) {
            escaped = false;
            param += c;
            continue;
        }

        switch (c.toLatin1()) {
            case ',':
                if (!level) {
                    m_param.append(unescape(param.trimmed()));
                    param.clear();
                } else param += c;
                break;

            case '(':
                level++;
                param += c;
                break;
            case ')':
                if (!level) {
                    param = unescape(param.trimmed());
                    if (param.length())
                        m_param.append(param);
                    // break, belongs to command, end of line
                    line.clear();
                }
                else
                    level--;
                param += c;
                break;
            default:
                param += c;
        }
    }

    line = line.trimmed();
    if (line.length()) {
        qWarning("Parser: trailing garbage after command: '%s'", DBG(line));
    }
}

Here is the call graph for this function:

~Parser()

Kwave::Parser::~Parser ( )

virtual

Destructor.

Definition at line 108 of file Parser.cpp.

{
}

Member Function Documentation

command()

QString Kwave::Parser::command ( )

inline

Returns the command part of the line

Definition at line 47 of file Parser.h.

Referenced by Kwave::FileContext::delegateCommand(), Kwave::TopWidget::executeCommand(), Kwave::App::executeCommand(), Kwave::FileContext::executeCommand(), fromUrl(), Kwave::FileContext::parseCommands(), Kwave::MenuItem::specialCommand(), Kwave::MenuNode::specialCommand(), and toUrl().

                                 {
            return m_command;
        }

Here is the caller graph for this function:

commandList()

QStringList Kwave::Parser::commandList ( )

inline

Returns the list of commands

Definition at line 67 of file Parser.h.

Referenced by Kwave::FileContext::executeCommand().

{ return m_commands; }

Here is the caller graph for this function:

count()

unsigned int Kwave::Parser::count ( ) const

inline

Returns the number of parameters.

Definition at line 75 of file Parser.h.

References Kwave::toInt().

Referenced by Kwave::FileContext::delegateCommand(), Kwave::FileContext::executeCommand(), nextParam(), and toUrl().

                                          {
            return m_param.count();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

escape()

QString Kwave::Parser::escape ( const QString &  text )

static

Escapes all characters that might be critical when parsing

Parameters

text	a unicode text to escape

Returns

text with certain characters escaped

Definition at line 277 of file Parser.cpp.

References _.

Referenced by Kwave::MenuManager::addNumberedMenuEntry(), Kwave::K3BExportPlugin::detectBlockMetaData(), Kwave::TopWidget::dropEvent(), Kwave::SignalView::dropEvent(), Kwave::AsciiEncoder::encode(), escapeForFileName(), Kwave::K3BExportPlugin::saveBlocks(), Kwave::MainWidget::saveLabels(), Kwave::SaveBlocksPlugin::setup(), and Kwave::K3BExportPlugin::setup().

{
    static const QString special = _(":;<=>?[\\]^`");
    QString escaped;

    for (QString::ConstIterator it = text.begin(); it != text.end(); ++it) {
        const QChar c(*it);

        if ((c.toLatin1() < '.') || (c.toLatin1() > 'z') || special.contains(c))
            escaped += _("\\");

        escaped += c;
    }

    return escaped;
}

Here is the caller graph for this function:

escapeForFileName()

QString Kwave::Parser::escapeForFileName ( const QString &  text )

static

Escape all parts of a string that might be dangerous for using within a file name, like "/" and similar.

Parameters

text	a unicode text to escape

Returns

escaped string, which should be safe to use in a file name

Definition at line 295 of file Parser.cpp.

References _, and escape().

Referenced by Kwave::SaveBlocksPlugin::createFileName(), and Kwave::K3BExportPlugin::saveBlocks().

{
    QString result = text;

    // convert all kinds of (multiple) whitespaces, including tabs
    // and newlines into single spaces
    QRegExp rx(_("[\\s\\\t\\\r\\\n]+"));
    result.replace(rx, QChar(0x0020));

    // NOTE: this escapes any kind of special chars, but not a slash "/"
    result = escape(result);

    // special handling for slashes "/" -> replace with unicode FRACTION SLASH
    result.replace(QChar(0x002F), QChar(0x2044));

    return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

firstParam()

const QString & Kwave::Parser::firstParam

(

)

Returns the first parameter and sets the current position to the next.

Definition at line 168 of file Parser.cpp.

References m_current, and nextParam().

Referenced by Kwave::MenuManager::executeCommand(), Kwave::SignalManager::executeCommand(), Kwave::TopWidget::executeCommand(), Kwave::FileContext::executeCommand(), Kwave::Curve::fromCommand(), Kwave::TopWidget::openRecent(), Kwave::FileContext::parseCommands(), Kwave::MenuItem::specialCommand(), and Kwave::MenuNode::specialCommand().

{
    m_current = 0;
    return nextParam();
}

Here is the call graph for this function:

Here is the caller graph for this function:

fromUrl()

QString Kwave::Parser::fromUrl ( const QUrl &  url )

static

Converts a kwave:// URL into a string command

Parameters

url	a URL using the kwave:// scheme

Returns

a Kwave string command parsed from the URL

Definition at line 360 of file Parser.cpp.

References _, command(), params(), and Kwave::urlScheme().

Referenced by Kwave::TopWidget::loadFile().

{
    if (url.scheme().toLower() != Kwave::urlScheme()) return QString();

    // get the command name (path)
    QString command = QUrl::fromPercentEncoding(url.path().toLatin1());

    // get the parameter list
    command += _("(");
    QStringList params = url.query().split(_(","));
    if (!params.isEmpty()) {
        bool first = true;
        foreach (const QString &param, params) {
            if (!first) command += _(",");
            command += QUrl::fromPercentEncoding(param.toLatin1());
            first = false;
        }
    }
    command += _(")");

    return command;
}

Here is the call graph for this function:

Here is the caller graph for this function:

hasMultipleCommands()

bool Kwave::Parser::hasMultipleCommands ( )

inline

Returns true if a list of commands was parsed

Definition at line 62 of file Parser.h.

Referenced by Kwave::FileContext::executeCommand().

                                          {
            return (m_commands.count() > 1);
        }

Here is the caller graph for this function:

hasParams()

bool Kwave::Parser::hasParams ( )

inline

Returns true if the parameter list is not empty.

Definition at line 57 of file Parser.h.

Referenced by Kwave::App::executeCommand(), and Kwave::MainWidget::executeCommand().

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

Here is the caller graph for this function:

isDone()

bool Kwave::Parser::isDone ( ) const

inline

Returns true if the end of the parameter list has been reached.

Definition at line 70 of file Parser.h.

Referenced by Kwave::MainWidget::executeCommand(), Kwave::Curve::fromCommand(), remainingParams(), and Kwave::AmplifyFreePlugin::setup().

                                    {
            return (static_cast<int>(m_current) >= m_param.count());
        }

Here is the caller graph for this function:

nextParam()

const QString & Kwave::Parser::nextParam

(

)

Returns the next parameter and increases the current position if not already at the end of the parameter list. If the end of the parameter list has been reached, the return value will be a zero-length string.

Definition at line 175 of file Parser.cpp.

References _, count(), m_current, and m_param.

Referenced by Kwave::MenuManager::executeCommand(), Kwave::SignalManager::executeCommand(), Kwave::TopWidget::executeCommand(), Kwave::MainWidget::executeCommand(), Kwave::FileContext::executeCommand(), Kwave::Filter::Filter(), firstParam(), remainingParams(), Kwave::AmplifyFreePlugin::setup(), skipParam(), Kwave::MenuItem::specialCommand(), Kwave::MenuNode::specialCommand(), toBool(), toDouble(), toInt(), toSampleIndex(), toUInt(), and toUrl().

{
    static const QString empty = _("");
    if (m_current >= count()) return empty;
    return m_param[m_current++];
}

Here is the call graph for this function:

Here is the caller graph for this function:

params()

const QStringList& Kwave::Parser::params ( )

inline

Returns the complete list of parameters

Definition at line 52 of file Parser.h.

Referenced by Kwave::App::executeCommand(), fromUrl(), and toUrl().

                                           {
            return m_param;
        }

Here is the caller graph for this function:

remainingParams()

QStringList Kwave::Parser::remainingParams

(

)

Returns all remaining parameters in a string list

Definition at line 189 of file Parser.cpp.

References isDone(), and nextParam().

Referenced by Kwave::FileContext::delegateCommand(), and Kwave::FileContext::executeCommand().

{
    QStringList list;
    while (!isDone())
        list.append(nextParam());
    return list;
}

Here is the call graph for this function:

Here is the caller graph for this function:

skipParam()

void Kwave::Parser::skipParam

(

)

Skips a parameter and advances the current position by one if the end has not already been reached.

Definition at line 183 of file Parser.cpp.

References nextParam().

{
    nextParam();
}

Here is the call graph for this function:

splitCommands()

QStringList Kwave::Parser::splitCommands ( QString &  line )

protected

Splits a line into a list of commands

Definition at line 113 of file Parser.cpp.

References _.

Referenced by Parser().

{
    // split a line into commands
    unsigned int level = 0;
    QString cmd = _("");
    QStringList commands;
    bool escaped = false;

    while (line.length()) {
        QChar c = line[0];
        line.remove(0,1);

        // the next character is escaped
        if (!escaped && (c.toLatin1() == '\\')) {
            escaped = true;
            cmd += c;
            continue;
        }

        // escaped character
        if (escaped) {
            escaped = false;
            cmd += c;
            continue;
        }

        switch (c.toLatin1()) {
            case ';':
                if (!level) {
                    // next command in the list
                    commands.append(cmd.trimmed());
                    cmd = _("");
                } else cmd += c;
                break;
            case '(':
                level++;
                cmd += c;
                break;
            case ')':
                level--;
                cmd += c;
                break;
            default:
                cmd += c;
        }
    }

    if (cmd.length()) {
        commands.append(cmd.trimmed());
    }

    return commands;
}

Here is the caller graph for this function:

toBool()

bool Kwave::Parser::toBool

(

)

Gets the next parameter through calling nextParam() and interpretes it as a "bool" value. It will recognize the strings "true" and "false" (not case-sensitive) and numeric values (true means not zero). On errors the return value will be false.

Definition at line 198 of file Parser.cpp.

References _, DBG, and nextParam().

{
    const QString &p = nextParam();

    // first test for "true" and "false"
    if (p.toLower() == _("true")) return true;
    if (p.toLower() == _("false")) return false;

    // maybe numeric ?
    bool ok;
    int value = p.toInt(&ok);
    if (ok) return (value != 0);

    qWarning("Parser: invalid bool format: '%s'", DBG(p));
    return false;
}

Here is the call graph for this function:

toDouble()

double Kwave::Parser::toDouble

(

)

Gets the next parameter through calling nextParam() and interpretes it as a "double" value. On errors the return value will be zero.

Definition at line 262 of file Parser.cpp.

References DBG, and nextParam().

Referenced by Kwave::TopWidget::executeCommand(), Kwave::Filter::Filter(), and Kwave::Curve::fromCommand().

{
    const QString &p = nextParam();
    bool ok;
    double value = p.toDouble(&ok);

    if (!ok) {
        qWarning("Parser: unable to parse double from '%s'", DBG(p));
        value = 0.0;
    }

    return value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

toInt()

int Kwave::Parser::toInt

(

)

Gets the next parameter through calling nextParam() and interpretes it as an "int" value. On errors the return value will be zero.

Definition at line 216 of file Parser.cpp.

References DBG, and nextParam().

Referenced by Kwave::SignalManager::executeCommand(), Kwave::MainWidget::executeCommand(), and Kwave::Filter::Filter().

{
    const QString &p = nextParam();
    bool ok;
    int value = p.toInt(&ok);

    if (!ok) {
        qWarning("Parser: unable to parse int from '%s'", DBG(p));
        value = 0;
    }

    return value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

toSampleIndex()

sample_index_t Kwave::Parser::toSampleIndex

(

)

Gets the next parameter through calling nextParam() and interpretes it as a "sample_index_t" value. On errors the return value will be zero.

Definition at line 246 of file Parser.cpp.

References DBG, and nextParam().

Referenced by Kwave::SignalManager::executeCommand(), Kwave::TopWidget::executeCommand(), and Kwave::MainWidget::executeCommand().

{
    const QString &p = nextParam();
    bool ok;
    sample_index_t value = p.toULongLong(&ok);

    if (!ok) {
        qWarning("Parser: unable to parse unsigned int from '%s'", DBG(p));
        value = 0;
    }

    return value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

toUInt()

unsigned int Kwave::Parser::toUInt

(

)

Gets the next parameter through calling nextParam() and interpretes it as an "unsigned int" value. On errors the return value will be zero.

Definition at line 231 of file Parser.cpp.

References DBG, and nextParam().

Referenced by Kwave::SignalManager::executeCommand(), and Kwave::TopWidget::executeCommand().

{
    const QString &p = nextParam();
    bool ok;
    unsigned int value = p.toUInt(&ok);

    if (!ok) {
        qWarning("Parser: unable to parse unsigned int from '%s'", DBG(p));
        value = 0;
    }

    return value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

toUrl()

QUrl Kwave::Parser::toUrl ( const QString &  command )

static

Converts a string command into a URL suitable for passing to Kwave as command line parameter

Parameters

command

the string command to encode as URL

Returns

a QUrl with the kwave:// scheme

Definition at line 336 of file Parser.cpp.

References command(), count(), nextParam(), params(), and Kwave::urlScheme().

Referenced by Kwave::TopWidget::newSignal().

{
    QUrl url;

    url.setScheme(Kwave::urlScheme());
    Parser parser(command);

    // encode the command as "path"
    url.setPath(QString::fromLatin1(QUrl::toPercentEncoding(parser.command())));

    // encode the parameter list into a comma separated string
    unsigned int count = parser.count();
    QByteArray params;
    for (unsigned int i = 0; i < count; ++i) {
        QString param = parser.nextParam();
        if (params.length()) params += ',';
        params += QUrl::toPercentEncoding(param);
    }
    url.setQuery(QString::fromLatin1(params));

    return url;
}

Here is the call graph for this function:

Here is the caller graph for this function:

unescape()

QString Kwave::Parser::unescape ( const QString &  text )

static

Un-escapes all characters in a string previously escaped with escape()

Parameters

text	a unicode text to un-escape

Returns

the original text without escaped characters

Definition at line 314 of file Parser.cpp.

Referenced by Kwave::SaveBlocksPlugin::interpreteParameters(), Kwave::K3BExportPlugin::interpreteParameters(), Kwave::AsciiDecoder::open(), Parser(), Kwave::SaveBlocksPlugin::start(), and Kwave::SaveBlocksPlugin::updateExample().

{
    QString unescaped;

    bool esc = false;
    for (QString::ConstIterator it = text.begin(); it != text.end(); ++it) {
        const QChar c(*it);

        if (!esc && (c.toLatin1() == '\\')) {
            // this is the leading escape character -> skip it
            esc = true;
            continue;
        }

        esc = false;
        unescaped += c;
    }

    return unescaped;
}

Here is the caller graph for this function:

Member Data Documentation

m_command

QString Kwave::Parser::m_command

private

the command part of the line

Definition at line 187 of file Parser.h.

Referenced by Parser().

m_commands

QStringList Kwave::Parser::m_commands

private

if it has multiple commands, the list of command strings

Definition at line 196 of file Parser.h.

Referenced by Parser().

m_current

unsigned int Kwave::Parser::m_current

private

number of the "current" parameter

Definition at line 193 of file Parser.h.

Referenced by firstParam(), and nextParam().

m_param

QStringList Kwave::Parser::m_param

private

list of parsed parameters

Definition at line 190 of file Parser.h.

Referenced by nextParam(), and Parser().

---

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

• libkwave/Parser.h
• libkwave/Parser.cpp