App: split tokenizer handling of ExpressionCompleter to its own class

This commit is contained in:
wmayer
2023-02-24 14:37:51 +01:00
committed by wwmayer
parent aa04870ea9
commit 972329be99
5 changed files with 214 additions and 118 deletions

View File

@@ -140,6 +140,7 @@ SET(Document_CPP_SRCS
DocumentObserverPython.cpp
DocumentPyImp.cpp
Expression.cpp
ExpressionTokenizer.cpp
FeaturePython.cpp
FeatureTest.cpp
GeoFeature.cpp
@@ -182,6 +183,7 @@ SET(Document_HPP_SRCS
DocumentObserverPython.h
Expression.h
ExpressionParser.h
ExpressionTokenizer.h
ExpressionVisitors.h
FeatureCustom.h
FeaturePython.h

View File

@@ -0,0 +1,150 @@
/***************************************************************************
* Copyright (c) 2015 Eivind Kvedalen <eivind@kvedalen.name> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* 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., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#include "PreCompiled.h"
#ifndef _PreComp_
#include <string>
#include <tuple>
#endif
#include "ExpressionParser.h"
#include "ExpressionTokenizer.h"
using namespace App;
// Code below inspired by blog entry:
// https://john.nachtimwald.com/2009/07/04/qcompleter-and-comma-separated-tags/
QString ExpressionTokenizer::perform(const QString& prefix, int pos)
{
// ExpressionParser::tokenize() only supports std::string but we need a tuple QString
// because due to UTF-8 encoding a std::string may be longer than a QString
// See https://forum.freecadweb.org/viewtopic.php?f=3&t=69931
auto tokenizeExpression = [](const QString& expr) {
std::vector<std::tuple<int, int, std::string>> result =
ExpressionParser::tokenize(expr.toStdString());
std::vector<std::tuple<int, int, QString>> tokens;
std::transform(result.cbegin(),
result.cend(),
std::back_inserter(tokens),
[&](const std::tuple<int, int, std::string>& item) {
return std::make_tuple(
std::get<0>(item),
QString::fromStdString(expr.toStdString().substr(0, std::get<1>(item))).size(),
QString::fromStdString(std::get<2>(item))
);
});
return tokens;
};
QString completionPrefix;
// Compute start; if prefix starts with =, start parsing from offset 1.
int start = (prefix.size() > 0 && prefix.at(0) == QChar::fromLatin1('=')) ? 1 : 0;
// Tokenize prefix
std::vector<std::tuple<int, int, QString> > tokens = tokenizeExpression(prefix.mid(start));
// No tokens
if (tokens.empty()) {
return QString();
}
prefixEnd = prefix.size();
// Pop those trailing tokens depending on the given position, which may be
// in the middle of a token, and we shall include that token.
for (auto it = tokens.begin(); it != tokens.end(); ++it) {
if (std::get<1>(*it) >= pos) {
// Include the immediately followed '.' or '#', because we'll be
// inserting these separators too, in ExpressionCompleteModel::pathFromIndex()
if (it != tokens.begin() && std::get<0>(*it) != '.' && std::get<0>(*it) != '#')
it = it - 1;
tokens.resize(it - tokens.begin() + 1);
prefixEnd = start + std::get<1>(*it) + (int)std::get<2>(*it).size();
break;
}
}
int trim = 0;
if (prefixEnd > pos)
trim = prefixEnd - pos;
// Extract last tokens that can be rebuilt to a variable
long i = static_cast<long>(tokens.size()) - 1;
// First, check if we have unclosing string starting from the end
bool stringing = false;
for (; i >= 0; --i) {
int token = std::get<0>(tokens[i]);
if (token == ExpressionParser::STRING) {
stringing = false;
break;
}
if (token == ExpressionParser::LT && i > 0
&& std::get<0>(tokens[i - 1]) == ExpressionParser::LT) {
--i;
stringing = true;
break;
}
}
// Not an unclosed string and the last character is a space
if (!stringing && !prefix.isEmpty() &&
prefixEnd > 0 && prefixEnd <= prefix.size() &&
prefix[prefixEnd-1] == QChar(32)) {
return QString();
}
if (!stringing) {
i = static_cast<long>(tokens.size()) - 1;
for (; i >= 0; --i) {
int token = std::get<0>(tokens[i]);
if (token != '.' &&
token != '#' &&
token != ExpressionParser::IDENTIFIER &&
token != ExpressionParser::STRING &&
token != ExpressionParser::UNIT)
break;
}
++i;
}
// Set prefix start for use when replacing later
if (i == static_cast<long>(tokens.size()))
prefixStart = prefixEnd;
else
prefixStart = start + std::get<1>(tokens[i]);
// Build prefix from tokens
while (i < static_cast<long>(tokens.size())) {
completionPrefix += std::get<2>(tokens[i]);
++i;
}
if (trim && trim < int(completionPrefix.size()))
completionPrefix.resize(completionPrefix.size() - trim);
return completionPrefix;
}

View File

@@ -0,0 +1,53 @@
/***************************************************************************
* Copyright (c) 2015 Eivind Kvedalen <eivind@kvedalen.name> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* 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., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#ifndef EXPRESSIONTOKENIZER_H
#define EXPRESSIONTOKENIZER_H
#include <QString>
#include <FCGlobal.h>
namespace App
{
class AppExport ExpressionTokenizer
{
public:
QString perform(const QString& text, int pos);
void getPrefixRange(int &start, int &end) const {
start = prefixStart;
end = prefixEnd;
}
void updatePrefixEnd(int end) {
prefixEnd = end;
}
private:
int prefixStart = 0;
int prefixEnd = 0;
};
}
#endif //EXPRESSIONTOKENIZER_H

View File

@@ -810,132 +810,25 @@ void ExpressionCompleter::slotUpdate(const QString & prefix, int pos)
init();
// ExpressionParser::tokenize() only supports std::string but we need a tuple QString
// because due to UTF-8 encoding a std::string may be longer than a QString
// See https://forum.freecadweb.org/viewtopic.php?f=3&t=69931
auto tokenizeExpression = [](const QString& expr) {
std::vector<std::tuple<int, int, std::string>> result =
ExpressionParser::tokenize(expr.toStdString());
std::vector<std::tuple<int, int, QString>> tokens;
std::transform(result.cbegin(),
result.cend(),
std::back_inserter(tokens),
[&](const std::tuple<int, int, std::string>& item) {
return std::make_tuple(
get<0>(item),
QString::fromStdString(expr.toStdString().substr(0,get<1>(item))).size(),
QString::fromStdString(get<2>(item))
);
});
return tokens;
};
QString completionPrefix;
// Compute start; if prefix starts with =, start parsing from offset 1.
int start = (prefix.size() > 0 && prefix.at(0) == QChar::fromLatin1('=')) ? 1 : 0;
// Tokenize prefix
std::vector<std::tuple<int, int, QString> > tokens = tokenizeExpression(prefix.mid(start));
// No tokens
if (tokens.empty()) {
QString completionPrefix = tokenizer.perform(prefix, pos);
if (completionPrefix.isEmpty()) {
if (auto itemView = popup())
itemView->setVisible(false);
return;
}
prefixEnd = prefix.size();
// Pop those trailing tokens depending on the given position, which may be
// in the middle of a token, and we shall include that token.
for (auto it = tokens.begin(); it != tokens.end(); ++it) {
if (get<1>(*it) >= pos) {
// Include the immediately followed '.' or '#', because we'll be
// inserting these separators too, in ExpressionCompleteModel::pathFromIndex()
if (it != tokens.begin() && get<0>(*it) != '.' && get<0>(*it) != '#')
it = it - 1;
tokens.resize(it - tokens.begin() + 1);
prefixEnd = start + get<1>(*it) + (int)get<2>(*it).size();
break;
}
}
int trim = 0;
if (prefixEnd > pos)
trim = prefixEnd - pos;
// Extract last tokens that can be rebuilt to a variable
long i = static_cast<long>(tokens.size()) - 1;
// First, check if we have unclosing string starting from the end
bool stringing = false;
for (; i >= 0; --i) {
int token = get<0>(tokens[i]);
if (token == ExpressionParser::STRING) {
stringing = false;
break;
}
if (token == ExpressionParser::LT && i > 0
&& get<0>(tokens[i - 1]) == ExpressionParser::LT) {
--i;
stringing = true;
break;
}
}
// Not an unclosed string and the last character is a space
if (!stringing && !prefix.isEmpty() &&
prefixEnd > 0 && prefixEnd <= prefix.size() &&
prefix[prefixEnd-1] == QChar(32)) {
if (auto itemView = popup())
itemView->setVisible(false);
return;
}
if (!stringing) {
i = static_cast<long>(tokens.size()) - 1;
for (; i >= 0; --i) {
int token = get<0>(tokens[i]);
if (token != '.' &&
token != '#' &&
token != ExpressionParser::IDENTIFIER &&
token != ExpressionParser::STRING &&
token != ExpressionParser::UNIT)
break;
}
++i;
}
// Set prefix start for use when replacing later
if (i == static_cast<long>(tokens.size()))
prefixStart = prefixEnd;
else
prefixStart = start + get<1>(tokens[i]);
// Build prefix from tokens
while (i < static_cast<long>(tokens.size())) {
completionPrefix += get<2>(tokens[i]);
++i;
}
if (trim && trim < int(completionPrefix.size()))
completionPrefix.resize(completionPrefix.size() - trim);
FC_TRACE("Completion Prefix:" << completionPrefix.toUtf8().constData());
// Set completion prefix
setCompletionPrefix(completionPrefix);
if (!completionPrefix.isEmpty() && widget()->hasFocus()) {
if (widget()->hasFocus()) {
FC_TRACE("Complete on Prefix" << completionPrefix.toUtf8().constData());
complete();
FC_TRACE("Complete Done");
}
else {
if (auto itemView = popup())
itemView->setVisible(false);
else if (auto itemView = popup()) {
itemView->setVisible(false);
}
}

View File

@@ -28,6 +28,7 @@
#include <QObject>
#include <QPlainTextEdit>
#include <App/DocumentObserver.h>
#include <App/ExpressionTokenizer.h>
class QStandardItem;
@@ -52,12 +53,11 @@ public:
QObject *parent = nullptr, bool noProperty = false, bool checkInList = true);
void getPrefixRange(int &start, int &end) const {
start = prefixStart;
end = prefixEnd;
tokenizer.getPrefixRange(start, end);
}
void updatePrefixEnd(int end) {
prefixEnd = end;
tokenizer.updatePrefixEnd(end);
}
void setDocumentObject(const App::DocumentObject*, bool checkInList=true);
@@ -72,10 +72,8 @@ private:
QString pathFromIndex ( const QModelIndex & index ) const override;
QStringList splitPath ( const QString & input ) const override;
int prefixStart = 0;
int prefixEnd = 0;
App::DocumentObjectT currentObj;
App::ExpressionTokenizer tokenizer;
bool noProperty;
bool checkInList;
};