small improvements

Author: lbalazscs

src/main/java/pixelitor/Composition.java

@@ -67,10 +67,10 @@
 import static pixelitor.io.FileUtils.removeExtension;
 import static pixelitor.layers.LayerAdder.Position.ABOVE_ACTIVE;
 import static pixelitor.layers.LayerAdder.Position.BELOW_ACTIVE;
+import static pixelitor.utils.Threads.callInfo;
 import static pixelitor.utils.Threads.calledOnEDT;
 import static pixelitor.utils.Threads.onEDT;
 import static pixelitor.utils.Threads.onIOThread;
-import static pixelitor.utils.Threads.threadInfo;
 import static pixelitor.utils.Utils.createCopyName;
 import static pixelitor.utils.debug.DebugNodes.createBufferedImageNode;
 
@@ -88,7 +88,7 @@ public class Composition implements Serializable, ImageSource, LayerHolder {
 
     private final List<Layer> layerList = new ArrayList<>();
 
-    // The currently selected layer, potentially nested within groups or smart objects.
+    // the currently selected layer, potentially nested within groups or smart objects
     private Layer activeLayer;
 
     // The top-level ancestor layer of the activeLayer.
@@ -131,8 +131,8 @@ public class Composition implements Serializable, ImageSource, LayerHolder {
 
     private transient Selection selection;
 
-    // A temporary selection that is currently being created
-    // by dragging, but it's not finalized yet.
+    // a temporary selection that is currently being created
+    // by dragging, but it's not finalized yet
     private transient Selection draftSelection;
 
     /**
@@ -208,7 +208,7 @@ private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundE
 
         activeTopLevelLayer = activeLayer.getTopLevelLayer();
 
-        // Perform actions that need a full canvas and also
+        // perform actions that need a full canvas and also
         // (re)load the contents of linked smart objects
         forEachNestedLayerOfType(CompositeLayer.class, CompositeLayer::afterDeserialization);
 
@@ -375,8 +375,8 @@ public void addOwner(SmartObject newOwner) {
      * Checks if this {@link Composition} is the content of any {@link SmartObject}.
      */
     public boolean isSmartObjectContent() {
-        // If a content file is opened independently of its parent,
-        // then this will return false, even for PXC files!
+        // if a content file is opened independently of its parent,
+        // then this will return false, even for PXC files
         return owners != null;
     }
 
@@ -509,8 +509,7 @@ public void setName(String name) {
     }
 
     /**
-     * Create a file name that will be suggested as the default
-     * file name in the save dialog.
+     * Creates a file name to suggest in the save dialog.
      */
     public String suggestFileName(String extension) {
         if (file == null) {
@@ -546,7 +545,7 @@ public void rename(String oldName, String newName) {
             return;
         }
         setName(newName);
-        History.add(new CompositionRenamedEdit(this, oldName, newName));
+        History.add(new CompositionRenameEdit(this, oldName, newName));
     }
 
     public String getDebugName() {
@@ -660,6 +659,7 @@ public void flattenImage() {
             return;
         }
 
+        // create the new flattened layer from the composite of visible layers
         BufferedImage flattenedImg = getCompositeImage();
         Layer flattenedLayer = new ImageLayer(this, flattenedImg, "flattened");
 
@@ -865,8 +865,8 @@ public void setActiveLayer(Layer layer, boolean addToHistory, String editName) {
         Layer prevActiveLayer = this.activeLayer;
         this.activeLayer = layer;
 
-        // After ungrouping a group with a single active layer,
-        // the active layer could change without a change in the target.
+        // after ungrouping a group with a single active layer,
+        // the active layer could change without a change in the target
         setActiveTopLevelLayer(layer.getTopLevelLayer());
 
         if (this.activeLayer == prevActiveLayer) {
@@ -1015,8 +1015,7 @@ public void forEachNestedLayerAndMask(Consumer<Layer> action) {
     }
 
     /**
-     * Applies an action to all nested layers.
-     * Traverses both layer group hierarchy and smart object content hierarchy.
+     * Applies an action to all nested layers, traversing groups and smart objects.
      */
     public void forEachNestedLayer(Consumer<Layer> action, boolean includeMasks) {
         for (Layer layer : layerList) {
@@ -1054,7 +1053,7 @@ public Layer findLayerAtPoint(Point2D p) {
 
         Point pixelLoc = new Point((int) p.getX(), (int) p.getY());
 
-        // iterate in reverse order (we need to search layers from top to bottom)
+        // iterate in reverse order to search layers from top to bottom
         ListIterator<Layer> li = layerList.listIterator(layerList.size());
         while (li.hasPrevious()) {
             Layer layer = li.previous();
@@ -1099,7 +1098,7 @@ private Layer getActiveTarget() {
     }
 
     /**
-     * Returns the active mask or image layer or null
+     * Returns the active {@link Drawable} (layer or mask), or null if none is active.
      */
     public Drawable getActiveDrawable() {
         assert checkInvariants();
@@ -1112,6 +1111,9 @@ public Drawable getActiveDrawable() {
         }
     }
 
+    /**
+     * Returns the active {@link Filterable} (layer or mask), or null if none is active.
+     */
     public Filterable getActiveFilterable() {
         assert checkInvariants();
         if (activeLayer.isMaskEditing()) {
@@ -1124,8 +1126,7 @@ public Filterable getActiveFilterable() {
     }
 
     /**
-     * Returns the active mask or image layer.
-     * Calling this method assumes that the active layer is a {@link Drawable}.
+     * Returns the active {@link Drawable} (layer or mask), or throws an exception if none is active.
      */
     public Drawable getActiveDrawableOrThrow() {
         Drawable dr = getActiveDrawable();
@@ -1503,15 +1504,13 @@ public void intersectSelectionWith(Rectangle2D rect) {
      * might not be open in a view.
      */
     public void imCoordsChanged(AffineTransform at, boolean isUndoRedo, View view) {
-        // The selection is explicitly reset to a backup shape
-        // when something is undone/redone.
+        // the selection is explicitly reset to a backup shape
+        // when something is undone/redone
         if (selection != null && !isUndoRedo) {
             selection.transform(at);
         }
-        // The paths and the tool widgets are transformed even for undo/redo.
-        // The advantage is simpler code, the disadvantage is that
-        // rounding errors could accumulate if the same operation is
-        // undone/redone many times.
+
+        // the paths and the tool widgets are transformed even for undo/redo
         if (paths != null) {
             paths.imCoordsChanged(at);
         }
@@ -1616,9 +1615,7 @@ public void activeLayerToCanvasSize() {
     }
 
     /**
-     * Fits the canvas to the combined bounds of all content layers.
-     * If any content layer is larger than the current canvas, the
-     * canvas will be enlarged to fully contain all content layers.
+     * Enlarges the canvas to fit the content of all layers.
      */
     public void fitCanvasToLayers() {
         Outsets enlargement = Outsets.createZero();
@@ -1747,7 +1744,7 @@ public boolean checkInvariants() {
      */
     public CompletableFuture<Void> saveAsync(SaveSettings saveSettings,
                                              boolean addToRecentFiles) {
-        assert calledOnEDT() : threadInfo();
+        assert calledOnEDT() : callInfo();
 
         // prevent concurrent processing of the same file path
         File targetFile = saveSettings.file();
@@ -1759,7 +1756,7 @@ public CompletableFuture<Void> saveAsync(SaveSettings saveSettings,
         }
         IOTasks.markPathForWriting(filePath);
 
-        // Set to not dirty already at the beginning of the saving process,
+        // set to not dirty already at the beginning of the saving process,
         // so that subsequent closing doesn't trigger another save.
         boolean wasDirty = isDirty();
         clearDirtyFlagsRecursively();
@@ -1786,7 +1783,7 @@ public CompletableFuture<Void> saveAsync(SaveSettings saveSettings,
      * Actions to perform on the EDT after a successful save.
      */
     public void handleSuccessfulSave(File file, boolean addToRecentFiles) {
-        assert calledOnEDT() : threadInfo();
+        assert calledOnEDT() : callInfo();
 
         setFile(file);
         if (addToRecentFiles) {
@@ -1796,8 +1793,8 @@ public void handleSuccessfulSave(File file, boolean addToRecentFiles) {
         Messages.showFileSavedMessage(file);
 
         if (isSmartObjectContent()) {
-            // Otherwise the changes might not be propagated when deactivating,
-            // because this isn't dirty after saving even if it's changed.
+            // otherwise the changes might not be propagated when deactivating,
+            // because this isn't dirty after saving even if it's changed
             for (SmartObject owner : owners) {
                 owner.propagateContentChanges(this, true);
 
@@ -1914,7 +1911,7 @@ public ImageMode getMode() {
      * need to be reloaded due to external file modifications.
      */
     public CompletableFuture<Composition> checkForExternalModifications() {
-        // check only the open compositions here - hidden
+        // check only the open compositions here; hidden
         // smart object contents will be checked later
         if (file != null && isOpen()) {
             long currentFileTimestamp = file.lastModified();

src/main/java/pixelitor/ConsistencyChecks.java

@@ -23,7 +23,6 @@
 import pixelitor.selection.SelectionActions;
 import pixelitor.utils.Threads;
 import pixelitor.utils.debug.Debug;
-import pixelitor.utils.test.Events;
 
 import java.awt.Rectangle;
 import java.awt.image.BufferedImage;
@@ -95,8 +94,6 @@ private static boolean isSizeDifferent(BufferedImage a, BufferedImage b) {
     }
 
     private static void differentSizeForFade(BufferedImage currentImg, BufferedImage previousImg, Composition comp) {
-        Events.postProgramError("fade would not work", comp, null);
-
         Debug.debugImage(currentImg, "current");
         Debug.debugImage(previousImg, "previous");
 

src/main/java/pixelitor/Pixelitor.java

@@ -47,10 +47,10 @@
 import java.util.concurrent.TimeUnit;
 
 import static java.lang.String.format;
+import static pixelitor.utils.Threads.callInfo;
 import static pixelitor.utils.Threads.calledOnEDT;
 import static pixelitor.utils.Threads.onEDT;
 import static pixelitor.utils.Threads.onIOThread;
-import static pixelitor.utils.Threads.threadInfo;
 
 /**
  * The main enty point for the app.
@@ -128,7 +128,7 @@ private static void launchGUI(String[] args) {
     }
 
     private static void createAndShowGUI(String[] args) {
-        assert calledOnEDT() : threadInfo();
+        assert calledOnEDT() : callInfo();
 
         Messages.setHandler(new GUIMessageHandler());
 
@@ -141,8 +141,8 @@ private static void createAndShowGUI(String[] args) {
         PixelitorWindow mainWindow = PixelitorWindow.get();
         Dialogs.setMainWindowInitialized(true);
 
-        // ensure the main window has focus after GUI initialization
-        // so that keyboard shortcuts work properly
+        // ensure that after GUI initialization the focus isn't grabbed
+        // by a textfield, and keyboard shortcuts work properly
         FgBgColors.getGUI().requestFocus();
 
         TipsOfTheDay.showTips(mainWindow, false);
@@ -158,12 +158,11 @@ private static void createAndShowGUI(String[] args) {
             .exceptionally(Messages::showExceptionOnEDT);
     }
 
-    // less urgent initializations on the main thread
+    // less urgent initializations on the main thread after starting the GUI on the EDT
     private static void mainThreadInit() {
         MeasurementOverlay.initializeFont();
 
-        // force look-up table initialization now
-        // to prevent unexpected delays later
+        // force look-up table initialization now to prevent unexpected delays later
         FastMath.initTables();
     }
 
@@ -218,7 +217,7 @@ private static CompletableFuture<Void> openCommandLineFilesAsync(String[] args)
     }
 
     public static void exitApp(PixelitorWindow mainWindow) {
-        assert calledOnEDT() : threadInfo();
+        assert calledOnEDT() : callInfo();
 
         if (isExitBlockedByOngoingWrites(mainWindow)) {
             return;

src/main/java/pixelitor/automate/AutoPaint.java

@@ -30,7 +30,6 @@
 import pixelitor.utils.Lazy;
 import pixelitor.utils.Messages;
 import pixelitor.utils.ProgressHandler;
-import pixelitor.utils.Rnd;
 
 import java.awt.Color;
 import java.awt.geom.Path2D;
@@ -47,20 +46,20 @@
 import static pixelitor.tools.Tools.ERASER;
 import static pixelitor.tools.Tools.SMUDGE;
 import static pixelitor.utils.Texts.i18n;
+import static pixelitor.utils.Threads.callInfo;
 import static pixelitor.utils.Threads.calledOnEDT;
-import static pixelitor.utils.Threads.threadInfo;
 
 /**
  * The "Auto Paint" functionality.
  */
 public class AutoPaint {
-    public static final Tool[] SUPPORTED_TOOLS = {SMUDGE, BRUSH, CLONE, ERASER};
+    public static final AbstractBrushTool[] SUPPORTED_TOOLS = {SMUDGE, BRUSH, CLONE, ERASER};
     private static Color origFg;
     private static Color origBg;
     private static final Lazy<AutoPaintPanel> CONFIG_PANEL_FACTORY = Lazy.of(AutoPaintPanel::new);
 
     private AutoPaint() {
-        // Utility class, no instantiation
+        // utility class, no instantiation
     }
 
     public static void showDialog(Drawable dr) {
@@ -74,7 +73,7 @@ public static void showDialog(Drawable dr) {
     }
 
     private static void autoPaint(Drawable dr, AutoPaintSettings settings) {
-        assert calledOnEDT() : threadInfo();
+        assert calledOnEDT() : callInfo();
 
         BufferedImage backupImage = dr.getSelectedSubImage(true);
         String statusBarMessage = "Auto Paint with " + settings.getTool().getName();
@@ -102,7 +101,7 @@ private static void autoPaint(Drawable dr, AutoPaintSettings settings) {
     private static void generateStrokes(AutoPaintSettings settings,
                                         Drawable dr,
                                         ProgressHandler progressHandler) {
-        assert calledOnEDT() : threadInfo();
+        assert calledOnEDT() : callInfo();
 
         var random = new SplittableRandom();
         var comp = dr.getComp();
@@ -120,19 +119,14 @@ private static void generateSingleStroke(Drawable dr,
                                              AutoPaintSettings settings,
                                              Composition comp,
                                              SplittableRandom rand) {
-        assert calledOnEDT() : threadInfo();
+        assert calledOnEDT() : callInfo();
 
         setColors(settings, rand);
         PPoint start = comp.genRandomPointInCanvas();
         PPoint end = settings.genRandomEndPoint(start, comp, rand);
+        Path2D strokePath = createStrokePath(start, end, settings, rand);
 
-        Tool tool = settings.getTool();
-        if (tool instanceof AbstractBrushTool abt) {
-            Path2D strokePath = createStrokePath(start, end, settings);
-            abt.trace(dr, strokePath);
-        } else {
-            throw new IllegalStateException("tool = " + tool.getClass().getName());
-        }
+        settings.getTool().trace(dr, strokePath);
     }
 
     private static void setColors(AutoPaintSettings settings, SplittableRandom rand) {
@@ -143,24 +137,28 @@ private static void setColors(AutoPaintSettings settings, SplittableRandom rand)
         }
     }
 
-    private static Path2D createStrokePath(PPoint start, PPoint end, AutoPaintSettings settings) {
+    private static Path2D createStrokePath(PPoint start, PPoint end, AutoPaintSettings settings, SplittableRandom rand) {
         Path2D path = new Path2D.Double();
         path.moveTo(start.getImX(), start.getImY());
 
         double controlX = (start.getImX() + end.getImX()) / 2.0;
         double controlY = (start.getImY() + end.getImY()) / 2.0;
 
-        double curvature = settings.getMaxCurvature();
-        if (curvature > 0) {
-            double maxShift = start.imDist(end) * curvature;
-            controlX += (Rnd.nextDouble() - 0.5) * maxShift;
-            controlY += (Rnd.nextDouble() - 0.5) * maxShift;
+        double maxCurvature = settings.getMaxCurvature();
+        if (maxCurvature > 0) {
+            double maxShift = start.imDist(end) * maxCurvature;
+            controlX += (rand.nextDouble() - 0.5) * maxShift;
+            controlY += (rand.nextDouble() - 0.5) * maxShift;
         }
 
         path.quadTo(controlX, controlY, end.getImX(), end.getImY());
         return path;
     }
 
+    static boolean useColors(Tool selectedTool) {
+        return selectedTool == BRUSH;
+    }
+
     private static void rememberOriginalColors() {
         origFg = getFGColor();
         origBg = getBGColor();