LibreVNA/Software/PC_Application/LibreVNA-GUI/scpi.cpp

#include "scpi.h"

#include <QDebug>

SCPI::SCPI() :
    SCPINode(""),
    semQueue(QSemaphore(1)),
    semProcessing(QSemaphore(1))
{
    WAIexecuting = false;
    OPCsetBitScheduled = false;
    OPCQueryScheduled = false;
    OCAS = false;
    SESR = 0x00;
    ESE = 0xFF;
    processing = false;

    add(new SCPICommand("*CLS", [=](QStringList) {
        SESR = 0x00;
        OCAS = false;
        OPCQueryScheduled = false;
        return SCPI::getResultName(SCPI::Result::Empty);
    }, nullptr));

    add(new SCPICommand("*ESE", [=](QStringList params){
        unsigned long long newval;
        if(!SCPI::paramToULongLong(params, 0, newval) || newval >= 256) {
            return SCPI::getResultName(SCPI::Result::Error);
        } else {
            ESE = newval;
            return SCPI::getResultName(SCPI::Result::Empty);
        }
    }, [=](QStringList){
        return QString::number(ESE);
    }));

    add(new SCPICommand("*ESR", nullptr, [=](QStringList){
        auto ret = QString::number(SESR);
        SESR = 0x00;
        return ret;
    }));

    add(new SCPICommand("*OPC", [=](QStringList){
        // OPC command
        if(isOperationPending()) {
            OPCsetBitScheduled = true;
            OCAS = true;
        } else {
            // operation already complete
            setFlag(Flag::OPC);
        }
        return SCPI::getResultName(SCPI::Result::Empty);
    }, [=](QStringList) -> QString {
        // OPC query
        if(isOperationPending()) {
            // operation pending
            OPCQueryScheduled = true;
            OCAS = true;
            return SCPI::getResultName(SCPI::Result::Empty);
        } else {
            // no operation, can return immediately
            OCAS = false;
            return "1";
        }
    }));

    add(new SCPICommand("*WAI", [=](QStringList){
        // WAI command
        if(isOperationPending()) {
            WAIexecuting = true;
        }
        return SCPI::getResultName(SCPI::Result::Empty);
    }, nullptr));

    add(new SCPICommand("*LST", nullptr, [=](QStringList){
        QString list;
        createCommandList("", list);
        return list.trimmed();
    }));
}

bool SCPI::match(QString s1, QString s2)
{
    if (s1.compare(s2, Qt::CaseInsensitive) == 0
     || s1.compare(alternateName(s2), Qt::CaseInsensitive) == 0
     || alternateName(s1).compare(s2, Qt::CaseInsensitive) == 0
     || alternateName(s1).compare(alternateName(s2), Qt::CaseInsensitive) == 0) {
        return true;
    } else {
        return false;
    }
}

QString SCPI::alternateName(QString name)
{
    while(name.size() > 0 && name[name.size()-1].isLower()) {
        name.chop(1);
    }
    return name;
}

bool SCPI::paramToDouble(QStringList params, int index, double &dest)
{
    if(index >= params.size()) {
        return false;
    }
    bool okay;
    dest = params[index].toDouble(&okay);
    return okay;
}

bool SCPI::paramToULongLong(QStringList params, int index, unsigned long long &dest)
{
    if(index >= params.size()) {
        return false;
    }
    double res;
    bool okay = paramToDouble(params, index, res);
    if(res > std::numeric_limits<unsigned long long>::max() || res < std::numeric_limits<unsigned long long>::min()) {
        okay = false;
    }
    if(okay) {
        dest = res;
    }
    return okay;
}

bool SCPI::paramToLong(QStringList params, int index, long &dest)
{
    if(index >= params.size()) {
        return false;
    }
    double res;
    bool okay = paramToDouble(params, index, res);
    if(res > std::numeric_limits<long>::max() || res < std::numeric_limits<long>::min()) {
        okay = false;
    }
    if(okay) {
        dest = res;
    }
    return okay;
}

bool SCPI::paramToBool(QStringList params, int index, bool &dest)
{
    if(index >= params.size()) {
        return false;
    }
    bool okay = false;
    if(params[index] == "TRUE" || params[index] == "ON" || params[index] == "1") {
        dest = true;
        okay = true;
    } else if(params[index] == "FALSE" || params[index] == "OFF" || params[index] == "0") {
        dest = false;
        okay = true;
    }
    return okay;
}

QString SCPI::getResultName(SCPI::Result r)
{
    switch (r) {
    case Result::Empty:
        return "";
    case Result::Error:
    default:
        return "ERROR";
    case Result::CmdError:
        return "CMD_ERROR";
    case Result::QueryError:
        return "QUERY_ERROR";
    case Result::ExecError:
        return "EXEC_ERROR";
    case Result::False:
        return "FALSE";
    case Result::True:
        return "TRUE";
    }
}

void SCPI::input(QString line)
{
    semQueue.acquire();
    cmdQueue.append(line);
    semQueue.release();
    if(semProcessing.available()) {
        process();
    }
}

void SCPI::process()
{
    semProcessing.acquire();
    semQueue.acquire();
    auto queueBuf = cmdQueue;
    semQueue.release();
    while(!WAIexecuting && !queueBuf.isEmpty()) {
        semQueue.acquire();
        auto cmd = cmdQueue.front();
        cmdQueue.pop_front();
        queueBuf = cmdQueue;
        semQueue.release();
        auto cmds = cmd.split(";");
        SCPINode *lastNode = this;
        for(auto cmd : cmds) {
            if(cmd.size() > 0) {
                if(cmd[0] == ':' || cmd[0] == '*') {
                    // reset to root node
                    lastNode = this;
                }
                if(cmd[0] == ':') {
                    cmd.remove(0, 1);
                }
                auto response = lastNode->parse(cmd, lastNode);
                if(response == getResultName(Result::Error)) {
                    setFlag(Flag::CME);
                } else if(response == getResultName(Result::QueryError)) {
                    setFlag(Flag::CME);
                } else if(response == getResultName(Result::CmdError)) {
                    setFlag(Flag::CME);
                } else if(response == getResultName(Result::ExecError)) {
                    setFlag(Flag::EXE);
                } else if(response == getResultName(Result::Empty)) {
                    // do nothing
                } else {
                    emit output(response);
                }
            }
        }
    }
    semProcessing.release();
}

void SCPI::someOperationCompleted()
{
    if(!isOperationPending()) {
        // all operations are complete
        if(OCAS) {
            OCAS = false;
            if(OPCsetBitScheduled) {
                setFlag(Flag::OPC);
                OPCsetBitScheduled = false;
            }
            if(OPCQueryScheduled) {
                output("1");
                OPCQueryScheduled = false;
            }
        }
        if(WAIexecuting) {
            WAIexecuting = false;
            // process any queued commands
            process();
        }
    }
}

void SCPI::setFlag(Flag flag)
{
    SESR |= ((int) flag);
}

void SCPI::clearFlag(Flag flag)
{
    SESR &= ~((int) flag);
}

bool SCPI::getFlag(Flag flag)
{
    return SESR & (int) flag;
}

SCPINode::~SCPINode()
{
    if(parent) {
        parent->remove(this);
    }
    while(commands.size() > 0) {
        delete commands.front();
        commands.erase(commands.begin());
    }
    while(subnodes.size() > 0) {
        auto node = subnodes.front();
        remove(node);
        delete node;
    }
}

bool SCPINode::addDoubleParameter(QString name, double &param, bool gettable, bool settable, std::function<void(void)> setCallback)
{
    auto cmd = settable ? [&param, setCallback](QStringList params) -> QString {
        if(SCPI::paramToDouble(params, 0, param)) {
            if(setCallback) {
                setCallback();
            }
            return SCPI::getResultName(SCPI::Result::Empty);
        } else {
            return SCPI::getResultName(SCPI::Result::Error);
        }
    } : (std::function<QString(QStringList)>) nullptr;
    auto query = gettable ? [=](QStringList params) -> QString {
        Q_UNUSED(params)
        return QString::number(param);
    } : (std::function<QString(QStringList)>) nullptr;
    return add(new SCPICommand(name, cmd, query));
}

bool SCPINode::addUnsignedIntParameter(QString name, unsigned int &param, bool gettable, bool settable, std::function<void(void)> setCallback)
{
    auto cmd = settable ? [&param, setCallback](QStringList params) -> QString {
        unsigned long long value;
        if(SCPI::paramToULongLong(params, 0, value)) {
            param = value;
            if(setCallback) {
                setCallback();
            }
            return SCPI::getResultName(SCPI::Result::Empty);
        } else {
            return SCPI::getResultName(SCPI::Result::Error);
        }
    } : (std::function<QString(QStringList)>) nullptr;
    auto query = gettable ? [=](QStringList params) -> QString {
        Q_UNUSED(params)
        return QString::number(param);
    } : (std::function<QString(QStringList)>) nullptr;
    return add(new SCPICommand(name, cmd, query));
}

bool SCPINode::addBoolParameter(QString name, bool &param, bool gettable, bool settable, std::function<void(void)> setCallback)
{
    auto cmd = settable ? [&param, setCallback](QStringList params) -> QString {
        if(SCPI::paramToBool(params, 0, param)) {
            if(setCallback) {
                setCallback();
            }
            return SCPI::getResultName(SCPI::Result::Empty);
        } else {
            return SCPI::getResultName(SCPI::Result::Error);
        }
    } : (std::function<QString(QStringList)>) nullptr;
    auto query = gettable ? [=](QStringList params) -> QString {
        Q_UNUSED(params)
        return param ? SCPI::getResultName(SCPI::Result::True) : SCPI::getResultName(SCPI::Result::False);
    } : (std::function<QString(QStringList)>) nullptr;
    return add(new SCPICommand(name, cmd, query));
}

bool SCPINode::changeName(QString newname)
{
    if(newname == name) {
        return true;
    }
    if(parent) {
        if(parent->nameCollision(newname)) {
            // new name would result in a collision
            return false;
        }
    }
    name = newname;
    return true;
}

void SCPINode::setOperationPending(bool pending)
{
    if(operationPending != pending) {
        operationPending = pending;
        if(!operationPending) {
            // operation completed, needs to perform check if all operations are complete
            auto root = this;
            while(root->parent) {
                root = root->parent;
            }
            auto scpi = dynamic_cast<SCPI*>(root);
            if(!scpi) {
                // dynamic cast failed, this is not actually a root node. The SCPI node likely
                // has no valid parent configured
            } else {
                scpi->someOperationCompleted();
            }
        }
    }
}

bool SCPINode::isOperationPending()
{
    if(operationPending) {
        return true;
    }
    for(auto node : subnodes) {
        if(node->isOperationPending()) {
            return true;
        }
    }
    // no node has any pending operations
    return false;
}

bool SCPINode::nameCollision(QString name)
{
    for(auto n : subnodes) {
        if(SCPI::match(n->name, name)) {
            return  true;
        }
    }
    for(auto c : commands) {
        if(SCPI::match(c->name(), name)) {
            return  true;
        }
    }
    return false;
}

void SCPINode::createCommandList(QString prefix, QString &list)
{
    for(auto c : commands) {
        if(c->queryable()) {
            list += prefix + c->leafName() + "?\n";
        }
        if(c->executable()) {
            list += prefix + c->leafName() + '\n';
        }
    }
    for(auto n : subnodes) {
        n->createCommandList(prefix + n->leafName() + ":", list);
    }
}

SCPINode *SCPINode::findSubnode(QString name)
{
    for(auto n : subnodes) {
        if(n->name == name) {
            return n;
        }
    }
    return nullptr;
}

bool SCPINode::addInternal(SCPINode *node, int depth)
{
    QStringList parts = node->name.split(":");
    if(depth == parts.size()-1) {
        // add to this node
        if(nameCollision(parts[depth])) {
            qWarning() << "Unable to add SCPI node, name collision: " << node->name;
            return false;
        }
        subnodes.push_back(node);
        node->parent = this;
        return true;
    } else {
        // add to subnode
        auto subNode = findSubnode(parts[depth]);
        if(!subNode) {
            // does not exist, create first
            subNode = new SCPINode(parts[depth]);
            add(subNode);
        }
        return subNode->addInternal(node, depth+1);
    }
}

bool SCPINode::removeInternal(SCPINode *node, int depth)
{
    QStringList parts = node->name.split(":");
    if(depth == parts.size()-1) {
        // remove from this node
        auto it = std::find(subnodes.begin(), subnodes.end(), node);
        if(it != subnodes.end()) {
            subnodes.erase(it);
            node->parent = nullptr;
            return true;
        } else {
            return false;
        }
    } else {
        // remove from subnode
        auto subNode = findSubnode(parts[depth]);
        if(!subNode) {
            // does not exist
            return false;
        }
        return subNode->removeInternal(node, depth+1);
    }
}

bool SCPINode::addInternal(SCPICommand *cmd, int depth)
{
    QStringList parts = cmd->name().split(":");
    if(depth == parts.size()-1) {
        // add to this node
        if(nameCollision(parts[depth])) {
            qWarning() << "Unable to add SCPI command, name collision: " << cmd->name();
            return false;
        }
        commands.push_back(cmd);
        return true;
    } else {
        // add to subnode
        auto subNode = findSubnode(parts[depth]);
        if(!subNode) {
            // does not exist, create first
            subNode = new SCPINode(parts[depth]);
            add(subNode);
        }
        return subNode->addInternal(cmd, depth+1);
    }
}

bool SCPINode::removeInternal(SCPICommand *cmd, int depth)
{
    QStringList parts = cmd->name().split(":");
    if(depth == parts.size()-1) {
        // remove from this node
        auto it = std::find(commands.begin(), commands.end(), cmd);
        if(it != commands.end()) {
            commands.erase(it);
            return true;
        } else {
            return false;
        }
    } else {
        // remove from subnode
        auto subNode = findSubnode(parts[depth]);
        if(!subNode) {
            // does not exist
            return false;
        }
        return subNode->removeInternal(cmd, depth+1);
    }
}

QString SCPINode::parse(QString cmd, SCPINode* &lastNode)
{
    if(cmd.isEmpty()) {
        return "";
    }
    auto cmdName = cmd.split(" ").front();
    auto splitPos = cmdName.indexOf(':');
    if(splitPos > 0) {
        // have not reached a leaf, find next subnode
        auto subnode = cmd.left(splitPos);
        for(auto n : subnodes) {
            if(SCPI::match(n->leafName(), subnode.toUpper())) {
                // pass on to next level
                return n->parse(cmd.right(cmd.size() - splitPos - 1), lastNode);
            }
        }
        // unable to find subnode
        return SCPI::getResultName(SCPI::Result::Error);
    } else {
        // no more levels, search for command
        QStringList params;
        params.append("");
        bool inQuotes = false;
        for(unsigned int i=0;i<cmd.length();i++) {
            if(cmd[i] == '\\') {
                // escape character, ignore
                continue;
            }
            // check if we are starting/stopping quotes
            if(cmd[i] == '"' || cmd[i] == '\'') {
                // check whether quotes are escaped
                if(i == 0 || cmd[i-1] != '\\') {
                    inQuotes = !inQuotes;
                    continue;
                }
            }
            if(inQuotes) {
                params.back().append(cmd[i]);
            } else {
                // not in quotes, handle splitting by space
                if(cmd[i] == " ") {
                    if(params.back().length() > 0)
                    params.append("");
                } else {
                    params.back().append(cmd[i]);
                }
            }
        }
        // remove command name
        params.pop_front();
        bool isQuery = false;
        if (cmdName[cmdName.size()-1]=='?') {
            isQuery = true;
            cmdName.chop(1);
        }
        for(auto c : commands) {
            if(SCPI::match(c->leafName(), cmdName.toUpper())) {
                // save current node in case of non-root for the next command
                lastNode = this;
                if(c->convertToUppercase()) {
                    for(auto &p : params) {
                        p = p.toUpper();
                    }
                }
                if(isQuery) {
                    return c->query(params);
                } else {
                    return c->execute(params);
                }
            }
        }
        // couldn't find command
        return SCPI::getResultName(SCPI::Result::Error);
    }
}

QString SCPICommand::execute(QStringList params)
{
    if(fn_cmd == nullptr) {
        return SCPI::getResultName(SCPI::Result::CmdError);
    } else {
        auto ret = fn_cmd(params);
        if(ret == SCPI::getResultName(SCPI::Result::Error)) {
            ret = SCPI::getResultName(SCPI::Result::CmdError);
        }
        return ret;
    }
}

QString SCPICommand::query(QStringList params)
{
    if(fn_query == nullptr) {
        return SCPI::getResultName(SCPI::Result::QueryError);
    } else {
        auto ret = fn_query(params);
        if(ret == SCPI::getResultName(SCPI::Result::Error)) {
            ret = SCPI::getResultName(SCPI::Result::QueryError);
        }
        return ret;
    }
}