Add gui to edit FeatureModels

.github/workflows/build.yml

@@ -56,7 +56,11 @@ jobs:
           sudo add-apt-repository -y 'deb http://apt.llvm.org/focal/ llvm-toolchain-focal-15 main'
           sudo apt-get update
           sudo apt-get -y install --no-install-recommends clang-${{ matrix.llvm-major }} llvm-${{ matrix.llvm-major }}-dev clang-tidy-14
-
+      - name: Install Tool Dependencies
+        shell: bash
+        run: |
+          sudo apt-get update
+          sudo apt-get install qtbase5-dev qtdeclarative5-dev
       - name: Workaround for sanitizer
         shell: bash
         run: |

.gitmodules

@@ -13,6 +13,9 @@
 [submodule "external/csv-parser"]
 	path = external/csv-parser
 	url = https://github.com/se-sic/csv-parser.git
+[submodule "external/qsourcehighlite"]
+	path = external/qsourcehighlite
+	url = [email protected]:Waqar144/QSourceHighlite.git
 [submodule "external/z3"]
 	path = external/z3
 	url = https://github.com/fabianbs96/z3.git

include/vara/Feature/FeatureModelTransaction.h

@@ -91,7 +91,7 @@ class FeatureModelTransaction
   /// \returns a pointer to the inserted Feature in CopyMode, otherwise,
   ///          nothing.
   decltype(auto) addFeature(std::unique_ptr<Feature> NewFeature,
-                            Feature *Parent = nullptr) {
+                            FeatureTreeNode *Parent = nullptr) {
     if constexpr (IsCopyMode) {
       return this->addFeatureImpl(std::move(NewFeature), Parent);
     } else {
@@ -321,11 +321,11 @@ class AddFeatureToModel : public FeatureModelModification {
 
 private:
   AddFeatureToModel(std::unique_ptr<Feature> NewFeature,
-                    Feature *Parent = nullptr)
+                    FeatureTreeNode *Parent = nullptr)
       : NewFeature(std::move(NewFeature)), Parent(Parent) {}
 
   std::unique_ptr<Feature> NewFeature;
-  Feature *Parent;
+  FeatureTreeNode *Parent;
 };
 
 //===----------------------------------------------------------------------===//
@@ -829,7 +829,7 @@ class FeatureModelCopyTransactionBase {
   // Modifications
 
   Result<FTErrorCode, Feature *>
-  addFeatureImpl(std::unique_ptr<Feature> NewFeature, Feature *Parent) {
+  addFeatureImpl(std::unique_ptr<Feature> NewFeature, FeatureTreeNode *Parent) {
     if (!FM) {
       return ERROR;
     }
@@ -968,6 +968,28 @@ class FeatureModelCopyTransactionBase {
     return FM->getFeature(F.getName());
   }
 
+  [[nodiscard]] FeatureTreeNode *translateFeature(FeatureTreeNode &F) {
+    if (F.getKind() == FeatureTreeNode::NodeKind::NK_RELATIONSHIP) {
+      FeatureTreeNode *Parent = F.getParent();
+      auto *ParentFeature = llvm::dyn_cast<Feature, FeatureTreeNode>(Parent);
+      if (ParentFeature == nullptr) {
+        // The Parent of a Relationship should always be a Feature
+        abort();
+      }
+      ParentFeature = FM->getFeature(ParentFeature->getName());
+      Relationship *Base = *ParentFeature->getChildren<Relationship>(0).begin();
+      Base = *Base->getChildren<Relationship>(0).begin();
+      return Base;
+    }
+    auto *CastF = llvm::dyn_cast<Feature, FeatureTreeNode>(&F);
+    if (CastF == nullptr) {
+      // There are only Features and Relationship nodes if F was not a
+      // Relationship it has to be a Feature
+      abort();
+    }
+    return FM->getFeature(CastF->getName());
+  }
+
   std::unique_ptr<FeatureModel> FM;
 };
 
@@ -1008,7 +1030,8 @@ class FeatureModelModifyTransactionBase {
   //===--------------------------------------------------------------------===//
   // Modifications
 
-  void addFeatureImpl(std::unique_ptr<Feature> NewFeature, Feature *Parent) {
+  void addFeatureImpl(std::unique_ptr<Feature> NewFeature,
+                      FeatureTreeNode *Parent) {
     assert(FM && "FeatureModel is null.");
 
     Modifications.push_back(

tools/CMakeLists.txt

@@ -2,3 +2,4 @@ if(VARA_FEATURE_USE_Z3_SOLVER)
   add_subdirectory(config-generator)
 endif()
 add_subdirectory(fm-viewer)
+add_subdirectory(fm-editor)

tools/fm-editor/CMakeLists.txt

@@ -0,0 +1,58 @@
+set(LLVM_LINK_COMPONENTS Support Demangle Core)
+set(CMAKE_AUTOMOC ON)
+set(CMAKE_AUTOUIC ON)
+find_package(
+  QT
+  NAMES
+  Qt6
+  Qt5
+  REQUIRED
+  COMPONENTS Widgets
+)
+find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Widgets)
+include_directories(../../external/qsourcehighlite)
+include_directories(.)
+
+add_vara_executable(
+  fm-editor
+  main.cpp
+  graph/FeatureModelGraph.h
+  graph/FeatureModelGraph.cpp
+  graph/FeatureNode.h
+  graph/FeatureNode.cpp
+  graph/FeatureEdge.h
+  graph/FeatureEdge.cpp
+  tree/FeatureTreeViewModel.h
+  tree/FeatureTreeViewModel.cpp
+  tree/FeatureTreeItem.h
+  tree/FeatureTreeItem.cpp
+  FeatureModelEditor.h
+  FeatureModelEditor.cpp
+  FeatureAddDialog.h
+  FeatureAddDialog.cpp
+  ../../external/qsourcehighlite/qsourcehighliter.h
+  ../../external/qsourcehighlite/qsourcehighliter.cpp
+  ../../external/qsourcehighlite/languagedata.h
+  ../../external/qsourcehighlite/languagedata.cpp
+  ../../external/qsourcehighlite/qsourcehighliterthemes.h
+  ../../external/qsourcehighlite/qsourcehighliterthemes.cpp
+)
+target_link_libraries(
+  fm-editor
+  LINK_PRIVATE
+  VaRAFeature
+  Qt${QT_VERSION_MAJOR}::Widgets
+  ${STD_FS_LIB}
+)
+
+add_custom_target(
+  check-vara-fm-editor
+  COMMAND fm-editor xml/test.xml -viewer cat | dot | grep . -q
+  COMMENT "Unittests"
+  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/../../unittests/resources
+)
+
+file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/fm-editor_autogen/.clang-tidy"
+     "Checks: '-*,llvm-twine-local'
+  "
+)

tools/fm-editor/FeatureAddDialog.cpp

@@ -0,0 +1,101 @@
+#include "FeatureAddDialog.h"
+#include "graph/FeatureModelGraph.h"
+#include "graph/FeatureNode.h"
+
+using vara::feature::Feature;
+FeatureAddDialog::FeatureAddDialog(FeatureModelGraph *Graph, QWidget *Parent,
+                                   Feature *ParentFeature)
+    : QDialog(Parent) {
+  setupUi(this);
+  NodeNames = QStringList();
+  if (ParentFeature) {
+    NodeNames.push_back(QString::fromStdString(ParentFeature->getName().str()));
+    Nodes->setEnabled(false);
+  } else {
+    for (const auto &Node : *Graph->getNodes()) {
+      NodeNames.push_back(Node->getQName());
+    }
+  }
+  this->Nodes->addItems(NodeNames);
+  this->FeatureKind->addItems(QStringList{"Binary", "Numeric"});
+  stepOperator->addItems(QStringList{"Add +", "Multiply *", "Exp ^"});
+  NumericFeature->setVisible(false);
+  connect(FeatureKind, QOverload<int>::of(&QComboBox::activated), this,
+          &FeatureAddDialog::featureType);
+}
+
+QString FeatureAddDialog::getName() const { return name->text(); }
+
+QString FeatureAddDialog::getParent() const { return Nodes->currentText(); }
+
+void FeatureAddDialog::featureType(int Index) {
+  if (Index == 1) {
+    NumericFeature->setVisible(true);
+  } else {
+    NumericFeature->setVisible(false);
+  }
+}
+
+vara::feature::Feature::FeatureKind FeatureAddDialog::getFeatureKind() {
+  return vara::feature::Feature::FeatureKind(FeatureKind->currentIndex());
+}
+
+bool FeatureAddDialog::isOptional() const { return optionalCheck->isChecked(); }
+
+QString FeatureAddDialog::getOutputString() const {
+  return outputString->text();
+}
+
+std::vector<int64_t> stringToIntVector(string &Input) {
+  std::stringstream InStream(Input);
+  std::vector<int64_t> Out{};
+
+  for (std::string Substring; std::getline(InStream, Substring, ',');) {
+    Out.push_back(std::stoi(Substring));
+  }
+  return Out;
+}
+
+/// Retrieve the Feature defined by the dialog this should only be called after
+/// the dialog was accepted
+std::unique_ptr<Feature> FeatureAddDialog::getFeature() {
+  const std::string Name = getName().toStdString();
+  const bool Optional = isOptional();
+  const std::string OutputString = getOutputString().toStdString();
+  switch (getFeatureKind()) {
+  case Feature::FeatureKind::FK_BINARY:
+    return std::make_unique<vara::feature::BinaryFeature>(
+        Name, Optional, std::vector<vara::feature::FeatureSourceRange>(),
+        OutputString);
+  case Feature::FeatureKind::FK_NUMERIC: {
+    return getNumericFeature();
+  }
+  default:
+    return std::make_unique<Feature>(Name);
+  }
+}
+
+std::unique_ptr<Feature> FeatureAddDialog::getNumericFeature() const {
+  const std::string Name = getName().toStdString();
+  const bool Optional = isOptional();
+  const std::string OutputString = getOutputString().toStdString();
+  std::unique_ptr<vara::feature::StepFunction> SF{};
+  vara::feature::NumericFeature::ValuesVariantType ValueRange;
+
+  if (range->isChecked()) {
+    ValueRange = vara::feature::NumericFeature::ValueRangeType(min->value(),
+                                                               max->value());
+    if (lhs->isChecked()) {
+      SF = std::make_unique<vara::feature::StepFunction>(
+          stepOperand->value(), vara::feature::StepFunction::StepOperation(
+                                    stepOperator->currentIndex()));
+    }
+  } else {
+    auto ValueString = values->text().toStdString();
+    ValueRange = stringToIntVector(ValueString);
+  }
+  return std::make_unique<vara::feature::NumericFeature>(
+      Name, ValueRange, Optional,
+      std::vector<vara::feature::FeatureSourceRange>(), OutputString,
+      std::move(SF));
+}

tools/fm-editor/FeatureAddDialog.h

@@ -0,0 +1,32 @@
+#ifndef VARA_FEATURE_FEATUREADDDIALOG_H
+#define VARA_FEATURE_FEATUREADDDIALOG_H
+
+#include "graph/FeatureModelGraph.h"
+#include "ui_FeatureAddDialog.h"
+
+#include <QDialog>
+#include <QInputDialog>
+
+class FeatureAddDialog : public QDialog, public Ui::Add {
+  Q_OBJECT
+
+public:
+  FeatureAddDialog(FeatureModelGraph *Graph, QWidget *Parent,
+                   vara::feature::Feature *ParentFeature = nullptr);
+  QString getName() const;
+  QString getParent() const;
+  QString getOutputString() const;
+  std::unique_ptr<vara::feature::Feature> getFeature();
+  vara::feature::Feature::FeatureKind getFeatureKind();
+  bool isOptional() const;
+
+public slots:
+  void featureType(int Index);
+
+private:
+  QStringList NodeNames;
+
+  std::unique_ptr<vara::feature::Feature> getNumericFeature() const;
+};
+
+#endif // VARA_FEATURE_FEATUREADDDIALOG_H