CliCommand Class Reference

Command line widget. More...

#include <clicommand.h>

Inheritance diagram for CliCommand:

Collaboration diagram for CliCommand:

Public Slots
void	onReturnPressed ()
	Parse entered text. Check if the text is a number, a coordinate or a command and emit the right signal. This is a slot to allow getting key press events from other widgets. More...
void	onKeyPressed (QKeyEvent *event)
	Process key events. Browse history if up or down key is pressed. This is a slot to allow getting key press events from other widgets. More...

Signals
void	commandEntered (QString command)
void	coordinateEntered (lc::geo::Coordinate coordinate)
void	relativeCoordinateEntered (lc::geo::Coordinate coordinate)
void	numberEntered (double number)
void	textEntered (QString text)

Public Member Functions
	CliCommand (QWidget *parent=0)
	Create widget. More...
	~CliCommand ()
void	keyPressEvent (QKeyEvent *event)
bool	addCommand (std::string name)
	Add a new command. More...
void	write (QString message)
	Write a message in the logs. More...
void	setText (QString text)
	Write text in input. More...
void	returnText (bool returnText)
	Return raw text to Lua. More...

Private Member Functions
bool	checkParam (QString command)
void	enterCommand (QString command)
void	enterCoordinate (QString coordinate)
void	enterNumber (double number)

Private Attributes
Ui::CliCommand *	ui
std::shared_ptr< QCompleter >	_completer
std::shared_ptr< QStringListModel >	_commands
bool	_returnText
QStringList	_history
int	_historySize
int	_historyIndex

Detailed Description

Command line widget.

Definition at line 20 of file clicommand.h.

Constructor & Destructor Documentation

CliCommand::CliCommand ( QWidget *  parent = 0 )

explicit

Create widget.

Parameters

parent

Pointer to parent widget

Definition at line 8 of file clicommand.cpp.

                                      :
    QDockWidget(parent),
    ui(new Ui::CliCommand),
    _returnText(false),
    _historySize(10),
    _historyIndex(-1)
{
    ui->setupUi(this);

    connect(ui->command, SIGNAL(returnPressed()), this, SLOT(onReturnPressed()));

    _commands = std::make_shared<QStringListModel>();
    _completer = std::make_shared<QCompleter>();

    _completer->setCaseSensitivity(Qt::CaseInsensitive);
    _completer->setCompletionMode(QCompleter::InlineCompletion);
    _completer->setModel(_commands.get());

    ui->command->setCompleter(_completer.get());
}

CliCommand::~CliCommand

(

)

Definition at line 29 of file clicommand.cpp.

                        {
    delete ui;
}

Member Function Documentation

bool CliCommand::addCommand

(

std::string

name

)

Add a new command.

Definition at line 33 of file clicommand.cpp.

                                          {
    if(_commands->stringList().indexOf(name.c_str()) == -1) {
        auto newList = _commands->stringList();
        newList << QString(name.c_str());
        _commands->setStringList(newList);
        return true;
    }
    else {
        return false;
    }
}

bool CliCommand::checkParam ( QString  command )

private

Definition at line 122 of file clicommand.cpp.

                                           {
    return Settings::exists(command.toStdString());
}

void CliCommand::commandEntered ( QString  command )

signal

void CliCommand::coordinateEntered ( lc::geo::Coordinate  coordinate )

signal

void CliCommand::enterCommand ( QString  command )

private

Definition at line 103 of file clicommand.cpp.

                                             {
    auto completion = _completer->currentCompletion();

    if(command.compare(completion, Qt::CaseInsensitive) == 0) {
        write("Command: " + completion);
        emit commandEntered(completion);
    }
    else {
        if(checkParam(command)) {
            write(QString("Value of %1=%2").arg(command).arg(Settings::val(command.toStdString())));
        }
        else
        {
            write("Command " + command + " not found");
            ui->history->item(ui->history->count() - 1)->setForeground(Qt::red);
        }
    }
}

void CliCommand::enterCoordinate ( QString  coordinate )

private

Definition at line 126 of file clicommand.cpp.

                                                   {
    lc::geo::Coordinate point;
    QStringList numbers;
    bool isRelative = false;

    if(coordinate.indexOf("@") != -1) {
        isRelative = true;
        coordinate.remove("@");
    }

    if(coordinate.indexOf(";") != -1) {
        numbers = coordinate.split(";");
    }
    else {
        numbers = coordinate.split(",");
    }


    if(numbers.size() > 2) {
        point = lc::geo::Coordinate(numbers[0].toFloat(), numbers[1].toFloat(), numbers[2].toFloat());
    }
    else {
        point = lc::geo::Coordinate(numbers[0].toFloat(), numbers[1].toFloat());
    }

    auto message = QString("Coordinate: x=%1; y=%2; z=%3").arg(point.x()).arg(point.y()).arg(point.z());
    write(message);

    if(isRelative) {
        emit relativeCoordinateEntered(point);
    }
    else {
        emit coordinateEntered(point);
    }
}

void CliCommand::enterNumber ( double  number )

private

Definition at line 162 of file clicommand.cpp.

                                          {
    write(QString("Number: %1").arg(number));
    emit numberEntered(number); 
}

void CliCommand::keyPressEvent

(

QKeyEvent *

event

)

Definition at line 99 of file clicommand.cpp.

                                               {
    onKeyPressed(event);
}

void CliCommand::numberEntered ( double  number )

signal

void CliCommand::onKeyPressed ( QKeyEvent *  event )

slot

Process key events. Browse history if up or down key is pressed. This is a slot to allow getting key press events from other widgets.

Definition at line 167 of file clicommand.cpp.

                                              {
    switch(event->key()) {
        case Qt::Key_Up:

            if(_historyIndex + 1 < _history.size()) {
                _historyIndex++;
                ui->command->setText(_history[_historyIndex]);
            }
            break;

        case Qt::Key_Down:
            if(_historyIndex > 0) {
                _historyIndex--;
                ui->command->setText(_history[_historyIndex]);
            }
            else {
                _historyIndex = -1;
                ui->command->clear();
            }
            break;

        default:
            ui->command->event(event);
            break;
    }
}

void CliCommand::onReturnPressed ( )

slot

Parse entered text. Check if the text is a number, a coordinate or a command and emit the right signal. This is a slot to allow getting key press events from other widgets.

Definition at line 52 of file clicommand.cpp.

                                 {
    auto text = ui->command->text();
    bool isNumber;
    QStringList varFind;
    QRegularExpression re("^([a-zA-Z]{1,10}+)=([0-9]{1,50}.[0-9]{1,50})|([0-9]{1,50})$");
    QRegularExpressionMatch match = re.match(text, 0, QRegularExpression::PartialPreferCompleteMatch);
    bool hasMatch = match.hasMatch();

    if(_returnText) {
        emit textEntered(text);
    }
    else if(text != "") {
        _history.push_front(text);

        if (_history.size() > _historySize) {
            _history.pop_back();
        }

        auto number = text.toDouble(&isNumber);
        if (isNumber) {
            enterNumber(number);
        }
        else if (text.indexOf(";") != -1 || text.indexOf(",") != -1) {
            enterCoordinate(text);
        }
        else if(hasMatch) {
            varFind = text.split("=");
            Settings::inst = Settings::instance();
            std::unordered_map<std::string, double>::iterator it1;

            if(checkParam(varFind[0])) {
                write(QString("Value of %1 = %2").arg(varFind[0]).arg(varFind[1].toFloat()));
                Settings::setVal(varFind[0].toStdString(),varFind[1].toFloat());    
            }
            else {
                write(QString("No such variable."));
            }
        }
        else {
            enterCommand(text);
        }
    }

    _historyIndex = -1;
    ui->command->clear();
}

void CliCommand::relativeCoordinateEntered ( lc::geo::Coordinate  coordinate )

signal

void CliCommand::returnText

(

bool

returnText

)

Return raw text to Lua.

Parameters

returnText

true to return raw text, false to parse text Disables text parsing.

Definition at line 198 of file clicommand.cpp.

                                           {
    _returnText = returnText;
}

void CliCommand::setText

(

QString

text

)

Write text in input.

Parameters

text	QString It's only used in unit tests for the moment. Maybe that can be moved to a new test class.

Definition at line 194 of file clicommand.cpp.

                                     {
    ui->command->setText(text);
}

void CliCommand::textEntered ( QString  text )

signal

void CliCommand::write

(

QString

message

)

Write a message in the logs.

Parameters

message

QString

Definition at line 45 of file clicommand.cpp.

                                      {
    ui->history->addItem(message);
    if(ui->history->count() > _historySize) {
        delete ui->history->takeItem(0);
    }
}

Member Data Documentation

std::shared_ptr<QStringListModel> CliCommand::_commands

private

Definition at line 88 of file clicommand.h.

std::shared_ptr<QCompleter> CliCommand::_completer

private

Definition at line 87 of file clicommand.h.

QStringList CliCommand::_history

private

Definition at line 91 of file clicommand.h.

int CliCommand::_historyIndex

private

Definition at line 93 of file clicommand.h.

int CliCommand::_historySize

private

Definition at line 92 of file clicommand.h.

bool CliCommand::_returnText

private

Definition at line 89 of file clicommand.h.

Ui::CliCommand* CliCommand::ui

private

Definition at line 86 of file clicommand.h.

---

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

• lcUI/widgets/clicommand.h
• lcUI/widgets/clicommand.cpp