Start adding egs_view editor definition blocks

nrc-cnrc · Xuan-Zheng05 · Aug 3, 2019 · Dec 13, 2019 · Aug 3, 2019 · Dec 13, 2019
commit b7da362269eddc830bfc900e5f3d08dc629b749d
@@ -76,6 +76,7 @@ class label {
 
 static shared_ptr<EGS_BlockInput> blockInput = make_shared<EGS_BlockInput>("geometry");
 static void setBaseGeometryInputs(bool includeMediaBlock = true) {
+    blockInput->addSingleInput("library", true, "The type of geometry, loaded by shared library in egs++/dso.");
     blockInput->addSingleInput("name", true, "The user-declared unique name of this geometry. This is the name you may refer to elsewhere in the input file");
 
     if(includeMediaBlock) {

@@ -42,7 +42,13 @@ EGS_InputStruct::EGS_InputStruct() {}
 
 EGS_InputStruct::~EGS_InputStruct() {}
 
-void EGS_InputStruct::addBlockInput(shared_ptr<EGS_BlockInput> block) {
+shared_ptr<EGS_BlockInput> EGS_InputStruct::addBlockInput(string blockTit, bool isReq) {
+    blockInputs.push_back(make_shared<EGS_BlockInput>(blockTit, isReq, nullptr));
+
+    return blockInputs.back();
+}
+
+shared_ptr<EGS_BlockInput> EGS_InputStruct::addBlockInput(shared_ptr<EGS_BlockInput> block) {
     blockInputs.push_back(block);
 }
 
@@ -54,6 +60,16 @@ vector<shared_ptr<EGS_BlockInput>> EGS_InputStruct::getBlockInputs() {
     return blockInputs;
 }
 
+shared_ptr<EGS_BlockInput> EGS_InputStruct::getBlockInput(string title) {
+    for(auto &block: blockInputs) {
+        if(egsEquivStr(block->getTitle(), title)) {
+            return block;
+        }
+    }
+
+    return nullptr;
+}
+
 shared_ptr<EGS_BlockInput> EGS_InputStruct::getLibraryBlock(string blockTitle, string libraryName) {
     // Loop through each input block in the structure to find the library with
     // the matching name
@@ -112,6 +128,13 @@ shared_ptr<EGS_BlockInput> EGS_BlockInput::addBlockInput(string blockTit, bool i
     return blockInputs.back();
 }
 
+shared_ptr<EGS_BlockInput> EGS_BlockInput::addBlockInput(shared_ptr<EGS_BlockInput> block) {
+    block->setParent(shared_from_this());
+    blockInputs.push_back(block);
+
+    return blockInputs.back();
+}
+
 vector<shared_ptr<EGS_SingleInput>> EGS_BlockInput::getSingleInputs() {
     return singleInputs;
 }
@@ -299,6 +322,10 @@ const vector<string> EGS_SingleInput::getValues() {
     return values;
 }
 
+void EGS_SingleInput::setValues(const vector<string> vals) {
+    values = vals;
+}
+
 string EGS_SingleInput::getDescription() {
     return description;
 }

@@ -58,12 +58,13 @@ class EGS_EXPORT EGS_SingleInput {
 
     string getTag();
     bool getRequired();
-    const vector<string> getValues();
-    string getDescription();
     void addDependency(shared_ptr<EGS_SingleInput> inp, string val="", bool isAntiDependency = false);
     vector<shared_ptr<EGS_SingleInput>> getDependencyInp();
     vector<string> getDependencyVal();
     vector<bool> getDependencyAnti();
+    const vector<string> getValues();
+    void setValues(const vector<string> vals);
+    string getDescription();
 
 private:
 
@@ -88,6 +89,7 @@ class EGS_EXPORT EGS_BlockInput
     string getTitle();
     shared_ptr<EGS_SingleInput> addSingleInput(string inputTag, bool isReq, const string desc, const vector<string> vals = vector<string>());
     shared_ptr<EGS_BlockInput> addBlockInput(string blockTit, bool isReq = false);
+    shared_ptr<EGS_BlockInput> addBlockInput(shared_ptr<EGS_BlockInput> block);
     vector<shared_ptr<EGS_SingleInput>> getSingleInputs();
     vector<shared_ptr<EGS_SingleInput>> getSingleInputs(string title);
     vector<shared_ptr<EGS_BlockInput>> getBlockInputs();
@@ -121,10 +123,11 @@ class EGS_EXPORT EGS_InputStruct {
     EGS_InputStruct();
     ~EGS_InputStruct();
 
-    void addBlockInput(shared_ptr<EGS_BlockInput> block);
-    //void addBlockInput(string blockTit, bool isReq);
+    shared_ptr<EGS_BlockInput> addBlockInput(string blockTit, bool isReq = false);
+    shared_ptr<EGS_BlockInput> addBlockInput(shared_ptr<EGS_BlockInput> block);
     void addBlockInputs(vector<shared_ptr<EGS_BlockInput>> blocks);
     vector<shared_ptr<EGS_BlockInput>> getBlockInputs();
+    shared_ptr<EGS_BlockInput> getBlockInput(string title);
     shared_ptr<EGS_BlockInput> getLibraryBlock(string blockTitle, string libraryName);
     vector<string> getLibraryOptions(string blockTitle);
 

@@ -81,8 +81,9 @@ extern "C" {
 
         setBaseGeometryInputs();
 
+        blockInput->getSingleInput("library")->setValues(vector<string>(1, typeStr));
+
         // Format: name, isRequired, description, vector string of allowed values
-        blockInput->addSingleInput("library", true, "The type of geometry, loaded by shared library in egs++/dso.", vector<string>(1, typeStr));
         blockInput->addSingleInput("box size", true, "1 number defining the side-length of a cube, or 3 numbers defining the x, y, and z side-lengths.");
     }
 

@@ -120,9 +120,9 @@ extern "C" {
 
         setBaseGeometryInputs(false);
 
-        // Format: name, isRequired, description, vector string of allowed values
-        blockInput->addSingleInput("library", true, "The type of geometry, loaded by shared library in egs++/dso.", vector<string>(1, typeStr));
+        blockInput->getSingleInput("library")->setValues(vector<string>(1, typeStr));
 
+        // Format: name, isRequired, description, vector string of allowed values
         blockInput->addSingleInput("base geometry", true, "The name of the geometry that defines regions for this 'cutting device'. It is within these regions that other geometries will be placed to create a composite geometry.");
         blockInput->addSingleInput("set geometry", true, "The region number in the base geometry, followed by the name of the geometry to place in that region. If this geometry extends beyond the region boundaries, it will be cut to size.");
         blockInput->addSingleInput("new indexing style", false, "Set to 1 to use a new region numbering algorithm. Defaults to 0, to use the original indexing style.");

@@ -255,8 +255,9 @@ extern "C" {
 
         setBaseGeometryInputs(false);
 
+        blockInput->getSingleInput("library")->setValues({"EGS_Cones"});
+
         // Format: name, isRequired, description, vector string of allowed values
-        blockInput->addSingleInput("library", true, "The type of geometry, loaded by shared library in egs++/dso.", {"EGS_Cones"});
         auto typePtr = blockInput->addSingleInput("type", true, "The type of cone.", {"EGS_ConeStack", "EGS_SimpleCone", "EGS_ParallelCones", "EGS_ConeSet"});
 
         blockInput->addSingleInput("axis", false, "The unit vector defining the axis along the length of the cones. Layers or cones are added sequentially in the vector direction.");

@@ -371,8 +371,14 @@ void EGS_Editor::autoComplete() {
                 itemList << QString((inp->getTag() + " = ").c_str());
             }
         }
+
+        // Store the block titles in a set to remove duplicates
+        QSet<QString> blockTitles;
         for(auto &block: blockInputs) {
-            itemList << QString((":start " + block->getTitle() + ":").c_str());
+            blockTitles << QString((":start " + block->getTitle() + ":").c_str());
+        }
+        for(auto &title: blockTitles) {
+            itemList << title;
         }
         if(itemList.size() > 0) {
             model->setStringList(itemList);
@@ -416,12 +422,12 @@ void EGS_Editor::autoComplete() {
         if(inputBlockTemplate) {
 
             // Get the block title
-            QString blockTitle;
+            QString blockTit;
             int pos = selectedText.lastIndexOf(":start ");
             pos += 7;
             int endPos = selectedText.indexOf(":",pos);
             if(endPos > 0) {
-                blockTitle = selectedText.mid(pos, endPos-pos);
+                blockTit = selectedText.mid(pos, endPos-pos);
             }
 
             QList<QTextEdit::ExtraSelection> extraSelections = this->extraSelections();
@@ -437,7 +443,7 @@ void EGS_Editor::autoComplete() {
             QTextCharFormat format;
             format.setUnderlineStyle(QTextCharFormat::NoUnderline);
 
-            auto inputPtr = inputBlockTemplate->getBlockInput(blockTitle.toStdString());
+            auto inputPtr = inputBlockTemplate->getBlockInput(blockTit.toStdString());
             if(!inputPtr) {
                 // Red underline the input tag
                 // Select the input tag
@@ -464,6 +470,47 @@ void EGS_Editor::autoComplete() {
             extraSelections.append(selection);
             setExtraSelections(extraSelections);
         }
+
+    // For geometry and source blocks that don't contain a library line,
+    // add 'library =' as an option in the popup
+    } else if(egsEquivStr(blockTitle, "geometry")) {
+
+        // Populate the popup list
+        QStringList itemList;
+        itemList << "library";
+        if(itemList.size() > 0) {
+            model->setStringList(itemList);
+        }
+
+        popup->setModel(model);
+        popup->setFont(this->font());
+
+        // Get max string length
+        int strLength = 0;
+        for (auto &item: itemList) {
+            if (item.size() > strLength) {
+                strLength = item.size();
+            }
+        }
+
+        // Create a selection popup
+        int maxVisibleItems = 6;
+        int h = (popup->sizeHintForRow(0) * qMin(maxVisibleItems, popup->model()->rowCount()) + 3) + 3;
+        QScrollBar *hsb = popup->horizontalScrollBar();
+        if (hsb && hsb->isVisible()) {
+            h += popup->horizontalScrollBar()->sizeHint().height();
+        }
+
+        QPoint pos = this->viewport()->mapToGlobal(this->cursorRect().bottomRight());
+        QFontMetrics fm(popup->font());
+        int w = 20 + strLength * fm.horizontalAdvance('9');
+
+        popup->setGeometry(pos.x(), pos.y(), w, h);
+
+        // Show the popup
+        if (!popup->isVisible()) {
+            popup->show();
+        }
     }
 }
 
@@ -512,7 +559,11 @@ shared_ptr<EGS_BlockInput> EGS_Editor::getBlockInput(QString &blockTitle) {
         }
     }
 
-    return nullptr;
+    // If we didn't get the library tag, we might be in a top-level block
+    // like a geometry definition. Just return the block with the matching title
+    shared_ptr<EGS_BlockInput> inputBlock = inputStruct->getBlockInput(blockTitle.toStdString());
+
+    return inputBlock;
 }
 
 QString EGS_Editor::getBlockTitle() {

@@ -248,7 +248,16 @@ GeometryViewControl::GeometryViewControl(QWidget *parent, const char *name)
     QStringList libraries = directory.entryList(QStringList() << (lib_prefix+"*"+lib_suffix).c_str(), QDir::Files);
     QStringList geomLibs, sourceLibs;
 
-    shared_ptr<EGS_InputStruct> inputStruct(new EGS_InputStruct);
+    // The input template structure
+    inputStruct = make_shared<EGS_InputStruct>();
+
+    // Geometry definition block
+    auto geomDefPtr = inputStruct->addBlockInput("geometry definition");
+    geomDefPtr->addSingleInput("simulation geometry", true, "The name of the geometry that will be used in the simulation, or to be viewed in egs_view. If you have created a composite geometry using many other geometries, name the final composite geometry here. Note that in some applications, the calculation geometry input block overrides this input, but it is still required.");
+
+    // Source definition block
+    auto srcDefPtr = inputStruct->addBlockInput("source definition");
+    srcDefPtr->addSingleInput("simulation source", true, "The name of the source that will be used in the simulation. If you have created a composite source using many other sources, name the final composite source here.");
 
     // For each library, try to load it and determine if it is geometry or source
     for (const auto &lib : libraries) {
@@ -273,7 +282,7 @@ GeometryViewControl::GeometryViewControl(QWidget *parent, const char *name)
 
                 shared_ptr<EGS_BlockInput> geom = getInputs();
                 if (geom) {
-                    geomTemplates.push_back(geom);
+                    geomDefPtr->addBlockInput(geom);
 
                     vector<shared_ptr<EGS_SingleInput>> singleInputs = geom->getSingleInputs();
                     for (auto &inp : singleInputs) {
@@ -315,7 +324,6 @@ GeometryViewControl::GeometryViewControl(QWidget *parent, const char *name)
         }
     }
 
-    inputStruct->addBlockInputs(geomTemplates);
     egsinpEdit->setInputStruct(inputStruct);
 
     // Populate the geometry and simulation template lists