Merge pull request #1182 from fesch/bugfix

Version 3.32-24 candidate

Author: fesch

Structorizer.1

@@ -70,6 +70,7 @@ file.
 Write generated program code directly to StdOut instead of eporting it to the default
 output file (if \fB-o\fP is also used then the code will be written both to standard
 output and to the specified output file). (For export mode.)
+.TP
 .BI \-\-export " generator"
 Same as \-x " generator"
 This option must be the first argument.
@@ -157,7 +158,7 @@ Accepted names (case-insensitive) of parsers are:
 .br
 .B COBOLParser
 .br
-.B Java-SE8
+.B "Java-SE8"
 .br
 .B JavaParser
 .br

buildapp.xml

@@ -15,8 +15,8 @@
 	        name="Structorizer"
 	        displayname="Structorizer"
 	        identifier="lu.fisch.Structorizer"
-	        shortversion="3.32-23"
-	        version="3.32-23"
+	        shortversion="3.32-24"
+	        version="3.32-24"
 	        icon="icons/Structorizer.icns"
 	        mainclassname="Structorizer"
 	        copyright="Bob Fisch"

src/lu/fisch/structorizer/archivar/IRoutinePool.java

@@ -178,6 +178,7 @@ public default Set<Root> findIncludingRoots(String includableName, boolean recur
 	/**
 	 * Retrieves a set of all {@link Root} objects parked in this diagram pool.
 	 * @return the {@link Root} set
+	 * 
 	 * @see #findDiagramsByName(String)
 	 * @see #findIncludingRoots(String, boolean)
 	 */

src/lu/fisch/structorizer/arranger/Arranger.java

@@ -1877,6 +1877,10 @@ public void clearExecutionStatus() {
         surface.clearExecutionStatus();
     }
 
+    /**
+     * Updates the visibility or accessibility of the buttons held in the button bar,
+     * menus etc. depending on the current state.
+     */
     public void doButtons() {
         btnSetCovered.setEnabled(Element.E_COLLECTRUNTIMEDATA);
         // START KGU#624/KGU#626 2018-12-27: Enh. #655, #657
@@ -1924,6 +1928,7 @@ public static void addToChangeListeners(IRoutinePoolListener _listener)
 	/**
 	 * Statically removes the given {@code _listener} from the set of {@link IRoutinePoolListener}s
 	 * @param _listener - the listener to be unregistered.
+	 * 
 	 * @see #removeChangeListener(IRoutinePoolListener)
 	 * @see #addToChangeListeners(IRoutinePoolListener)
 	 */

src/lu/fisch/structorizer/arranger/ArrangerIndex.java

@@ -48,6 +48,7 @@
  *      Kay Gürtzig     2021-01-11      Enh. #910: Menu items disabled if only DiagramController proxies are selected
  *      Kay Gürtzig     2021-02-23      Issue #901: WAIT_CURSOR now also set on group saving
  *      Kay Gürtzig     2022-08-17      Issue #1065: Right-click now overrides a previous single selection
+ *      Kay Gürtzig     2024-11-25      Issue #1180: Test coverage display inconsistency fixed
  *
  ******************************************************************************************************
  *
@@ -300,7 +301,10 @@ public Component getTreeCellRendererComponent(JTree tree, Object value, boolean
 				boolean withQualifiers = !showQualifiers.containsKey(tree) || showQualifiers.get(tree);
 				String s = root.getSignatureString(true, withQualifiers);
 				// END KGU#408 2021-02-26
-				boolean covered = Element.E_COLLECTRUNTIMEDATA && root.deeplyCovered; 
+				// START KGU#1036 2024-11-25: Bugfix #1180 We must accept both kinds of markings
+				//boolean covered = Element.E_COLLECTRUNTIMEDATA && root.deeplyCovered;
+				boolean covered = Element.E_COLLECTRUNTIMEDATA && root.isTestCovered(true);
+				// END KGU#1036 2024-11-25
 				setText(s);
 				// Enh. #319, #389: show coverage status of (imported) main diagrams
 				if (root.isProgram()) {

src/lu/fisch/structorizer/arranger/Surface.java

@@ -136,6 +136,7 @@
  *      Kay Gürtzig     2024-03-16      Issue #1138: Provide a better and more usable diagram collision information
  *      Kay Gürtzig     2024-10-10      Issue #1176: More sensible addition to recent file list after loading an arrz file
  *                                      from Arranger button
+ *      Kay Gürtzig     2024-11-25      Issue #1180: deep test coverage consistency defects mended.
  *
  ******************************************************************************************************
  *
@@ -2920,7 +2921,7 @@ private void removeDiagram(Diagram diagr)
 		notifyChangeListeners(IRoutinePoolListener.RPC_POOL_CHANGED | IRoutinePoolListener.RPC_SELECTION_CHANGED);
 		Vector<Mainform> mainforms = activeMainforms();
 		if (form != null) {
-			if (!mainforms.contains(form) && !form.isStandalone() && (!ask || form.diagram.saveNSD(true))) {
+			if (!mainforms.contains(form) && !form.isApplicationMain() && (!ask || form.diagram.saveNSD(true))) {
 				// Form doesn't seem necessary any longer
 				form.dispose();
 				removeChangeListener(form);
@@ -3028,8 +3029,12 @@ public void togglePinned()
 	/**
 	 * Toggles the "covered" status of the subroutine or includable diagrams among the
 	 * selected diagrams.<br/>
-	 * If the "covered" flag the selected diagrams differs then all diagrams will be set
-	 * "covered". Before unsetting the "covered" flag a confirmation dialog will pop up.
+	 * If the "deeplyCovered" flag of the selected diagrams differs then all diagrams
+	 * will be set "covered". Before unsetting the "covered" flag a confirmation dialog
+	 * will pop up.<br/>
+	 * The coverage changes will be considered across all Roots that contain calls to the
+	 * affected subroutines.
+	 * 
 	 * @param frame - the owner for the dialog box.
 	 */
 	public void setCovered(Frame frame)
@@ -3053,7 +3058,10 @@ public void setCovered(Frame frame)
 			boolean someUncovered = false;
 			for (Diagram diagr: this.diagramsSelected) {
 				if (diagr.root != null && !diagr.root.isProgram()) {
-					if (!diagr.root.deeplyCovered) {
+					// START KGU#1036 2024-11-25: Bugfix #1180 Inconsistency mended
+					//if (!diagr.root.deeplyCovered) {
+					if (!diagr.root.isTestCovered(true)) {
+					// END KGU#1036 2024-11-25
 						someUncovered = true;
 						break;
 					}
@@ -3063,7 +3071,11 @@ public void setCovered(Frame frame)
 			{
 				for (Diagram diagr: this.diagramsSelected) {
 					if (diagr.root != null && !diagr.root.isProgram()) {
+						// Note that this cannot suppress a coverage acquired by execution (children.deeplyCovered)
 						diagr.root.deeplyCovered = someUncovered;
+						// START KGU#1036 2024-11-25: Bugfix #1180 We must propagate the status change to make sense
+						diagr.root.propagateTestCoverage();
+						// END KGU#1036 2024-11-25
 					}
 				}
 				// FIXME This is of no good anymore with a multiple selection because selection cannot easily be restored
@@ -3336,7 +3348,7 @@ else if (diagram.root.hasChanged())
 			// chance to save their currently maintained Root even if this was not arranged here.
 			if (goingToClose) {
 				for (Mainform form: mainforms) {
-					if (!form.isStandalone() && !handledRoots.contains(form.getRoot())) {
+					if (!form.isApplicationMain() && !handledRoots.contains(form.getRoot())) {
 						form.diagram.saveNSD(!(goingToClose && Element.E_AUTO_SAVE_ON_CLOSE));
 					}
 				}
@@ -4558,7 +4570,7 @@ public Set<Root> getAllRoots()
 				Diagram diagram = this.diagrams.get(d);
 				roots.add(diagram.root);
 			}
-		}    
+		}
 		return roots;
 	}
 	// END KGU#258 2016-09-26

src/lu/fisch/structorizer/elements/Call.java

@@ -367,15 +367,55 @@ public String getSignatureString()
 	}
 	// END #178 2016-07-19
 
+//	// START KGU#1036 2024-11-22: Workaround for bug #1180 (alternative approach, withdrawn 2024-11-24)
+//	/**
+//	 * Detects shallow or deep test coverage of this element according to the
+//	 * argument _deeply
+//	 * @param _deeply if exhaustive coverage (including subroutines is requested)
+//	 * @return true iff element and all its sub-structure is test-covered
+//	 */
+//	@Override
+//	public boolean isTestCovered(boolean _deeply)
+//	{
+//		if (_deeply && this.simplyCovered && !this.deeplyCovered && Arranger.hasInstance()) {
+//			// We have to check if called routine(s) may have turned completely covered meanwhile
+//			StringList sl = this.getUnbrokenText();
+//			if (sl.count() > 1) {
+//				Root myRoot = getRoot(this);
+//				for (int i = 0; i < sl.count(); i++) {
+//					Function called = getCalledRoutine(i);
+//					if (called != null) {
+//						// The retrieval is restricted to the Arranger pool, which may not be consistent with Executor
+//						Vector<Root> candidates = Arranger.getInstance()
+//								.findRoutinesBySignature(called.getName(), called.paramCount(), myRoot, true);
+//						// If unique then update the deeplyCovered attribute accordingly
+//						if (candidates.size() != 1 || !candidates.get(0).isTestCovered(true)) {
+//							return false;	// No further check needed
+//						}
+//					}
+//				}
+//				this.deeplyCovered = true;
+//				if (this.parent != null) {
+//					this.parent.checkTestCoverage(true);
+//				}
+//			}
+//		}
+//		// The following ought to be identical with super
+//		return _deeply ? this.deeplyCovered : this.simplyCovered;
+//	}
+//	// END KGU#1036 2024-11-22
+	
 	// START KGU#408 2021-02-26: Enh. #410 Differing behaviour in case of a method reference
 	/**
 	 * Returns a {@link Function} object describing the signature of
 	 * <ul>
 	 * <li> the referred method declaration (in case this obect represents a method reference),</li>
 	 * <li> the called routine if the text complies to the call syntax described in the user guide,</li>
-	 * <li> {@code null} otherwise.</li>
+	 * <li> {@code null} otherwise. (Note that this may be the case if the element consists of more than
+	 *     one line!)</li>
 	 * </ul>
 	 * @return Function object or {@code null}.
+	 * 
 	 * @see #isFunctionCall(boolean)
 	 * @see #isProcedureCall(boolean)
 	 */

src/lu/fisch/structorizer/elements/Element.java

@@ -312,7 +312,7 @@ public String toString()
 	public static final long E_HELP_FILE_SIZE = 12300000;
 	public static final String E_DOWNLOAD_PAGE = "https://www.fisch.lu/Php/download.php";
 	// END KGU#791 2020-01-20
-	public static final String E_VERSION = "3.32-23";
+	public static final String E_VERSION = "3.32-24";
 	public static final String E_THANKS =
 	"Developed and maintained by\n"+
 	" - Robert Fisch <robert.fisch@education.lu>\n"+
@@ -1817,9 +1817,9 @@ public void addToExecTotalCount(int _growth, boolean _directly)
 	/**
 	 * In test coverage mode, sets the local tested flag if element is fully covered
 	 * and then recursively checks test coverage upwards all ancestry if
-	 * _propagateUpwards is true (otherwise it would be postponed to the termination
-	 * of the superstructure).
-	 * @param _propagateUpwards if true then the change is immediately propagated  
+	 * {@code _propagateUpwards} is {@code true} (otherwise it would be postponed to
+	 * the termination of the superstructure).
+	 * @param _propagateUpwards if {@code true} then the change is immediately propagated  
 	 */
 	public void checkTestCoverage(boolean _propagateUpwards)
 	{

src/lu/fisch/structorizer/elements/Root.java

@@ -188,6 +188,7 @@
  *      Kay Gürtzig     2024-03-14      Bugfix #1139: NullPointerException in analyse_5_7_13() with empty Try
  *      Kay Gürtzig     2024-04-17      Issues #161, #1161: Improved reachability check (via mayPassControl())
  *      Kay Gürtzig     2024-10-09      Bugfix #1174: Precaution against NullpPointerException in fetchAuthorDates()
+ *      Kay Gürtzig     2024-11-25      Bugfix #1180: Deep test coverage change on undo/redo propagated
  *
  ******************************************************************************************************
  *
@@ -266,6 +267,7 @@
 import lu.fisch.structorizer.locales.Locales;
 import lu.fisch.structorizer.archivar.IRoutinePool;
 import lu.fisch.structorizer.arranger.Arranger;
+import lu.fisch.structorizer.executor.Executor;
 import lu.fisch.structorizer.executor.Function;
 import lu.fisch.structorizer.generators.GeneratorSyntaxChecker;
 import lu.fisch.structorizer.gui.*;
@@ -2296,6 +2298,9 @@ public void undo(boolean redoable)
             // START KGU#365 2017-03-19: Enh. #380
             }
             // END KGU#365 2017-03-19
+            // START KGU#1036 2024-11-25: Bugfix #1180 Special handling of deep coverage
+            boolean wasDeeplyCovered = this.isTestCovered(true);
+            // END KGU#1036 2024-11-25
             children = undoList.pop();
             children.parent = this;
             // START KGU#120 2016-01-02: Bugfix #85 - restore my StringList attributes from stack
@@ -2345,6 +2350,12 @@ public void undo(boolean redoable)
                 }
             }
             // END KGU#703 2019-03-30
+            // START KGU#1036 2024-11-25: Bugfix #1180 Special handling of deep coverage
+            this.deeplyCovered = this.children.deeplyCovered;
+            if (Element.E_COLLECTRUNTIMEDATA && wasDeeplyCovered != this.isTestCovered(true)) {
+                propagateTestCoverage();
+            }
+            // END KGU#1036 2024-11-25
         }
     }
 
@@ -2370,11 +2381,14 @@ public void adoptAttributes(RootAttributes attributes) {
      */
     public void redo()
     {
-        if (redoList.size()>0)
+        if (redoList.size() > 0)
         {
             // START KGU#137 2016-01-11: Bugfix #103 - rely on undoList level comparison 
             //this.hasChanged=true;
             // END KGU#137 2016-01-11
+            // START KGU#1036 2024-11-25: Bugfix #1180 Special handling of deep coverage
+            boolean wasDeeplyCovered = this.isTestCovered(true);
+            // END KGU#1036 2024-11-25
             undoList.add((Subqueue)children.copy());
             // START KGU#120 2016-01-02: Bugfix #85 - park my StringList attributes on the stack top
             undoList.peek().setText(this.text.copy());
@@ -2426,6 +2440,28 @@ public void redo()
                 }
             }
             // END KGU#703 2019-03-30
+            // START KGU#1036 2024-11-25: Bugfix #1180 Special handling of deep coverage
+            this.deeplyCovered = this.children.deeplyCovered;
+            if (Element.E_COLLECTRUNTIMEDATA && wasDeeplyCovered != this.isTestCovered(true)) {
+                // Restore the test coverage status of possibly referring Calls and Roots
+                propagateTestCoverage();
+            }
+            // END KGU#1036 2024-11-25
+        }
+    }
+    
+    // START KGU#1036 2024-11-25: Bugfix #1180 auxiliary method
+    /**
+     * Propagates a change of deep test coverage state among potentially referring
+     * Roots if this is a subroutine. Will only work if there is an {@link Executor}
+     * instance already.
+     */
+    public void propagateTestCoverage() {
+        if (this.isSubroutine()) {
+            Executor exec = Executor.getInstance();
+            if (exec != null) {
+                exec.propagateSubCoverage(this, null);
+            }
         }
     }
 
@@ -3596,6 +3632,17 @@ public void updateTypeMap(HashMap<String, TypeMapEntry> typeMap)
 		}
 	}
 	// END KGU#261/KGU#332 2017-02-01
+	
+	// START KGU#1036 2024-11-25: Bugfix #1180 Propagate this to potential callers
+	@Override
+	public void clearRuntimeData()
+	{
+		super.clearRuntimeData();
+		if (Element.E_COLLECTRUNTIMEDATA && this.isSubroutine()) {
+			propagateTestCoverage();
+		}
+	}
+	// END KGU#1036 2024-11-25
 
 	// START BFI 2015-12-10
 	/**
@@ -6471,12 +6518,12 @@ public int getMinParameterCount()
 
     /**
      * Checks whether a call with {@code nArgs} arguments may use this routine diagram. If so,
-     * returns the number of default values needed to fill all parameters (0 in case o an exact
+     * returns the number of default values needed to fill all parameters (0 in case of an exact
      * match), otherwise returns a negative number.
      * 
      * @param nArgs - the number of given argument values
      * @return number of available defaults to be used in order to satisfy all parameters, or a
-     * negative number
+     *    negative number
      * 
      * @see #getMinParameterCount()
      * @see #getParameterNames()