-
-
Notifications
You must be signed in to change notification settings - Fork 7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reloads sketch content if the Editor is not in foreground and isomething happens in the backing storage files. Note that no confirmation dialog is displayed (same behaviour as SublimeText, differs from other IDEs) Fixes #4551 and #5345
- Loading branch information
Showing
3 changed files
with
256 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,198 @@ | ||
/* | ||
* Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved. | ||
* | ||
* Redistribution and use in source and binary forms, with or without | ||
* modification, are permitted provided that the following conditions | ||
* are met: | ||
* | ||
* - Redistributions of source code must retain the above copyright | ||
* notice, this list of conditions and the following disclaimer. | ||
* | ||
* - Redistributions in binary form must reproduce the above copyright | ||
* notice, this list of conditions and the following disclaimer in the | ||
* documentation and/or other materials provided with the distribution. | ||
* | ||
* - Neither the name of Oracle nor the names of its | ||
* contributors may be used to endorse or promote products derived | ||
* from this software without specific prior written permission. | ||
* | ||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS | ||
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, | ||
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR | ||
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | ||
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | ||
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
*/ | ||
|
||
package processing.app.tools; | ||
|
||
import java.nio.file.*; | ||
import static java.nio.file.StandardWatchEventKinds.*; | ||
import static java.nio.file.LinkOption.*; | ||
import java.nio.file.attribute.*; | ||
import java.io.*; | ||
import java.util.*; | ||
import processing.app.Editor; | ||
import processing.app.EditorTab; | ||
import processing.app.Sketch; | ||
import processing.app.SketchFile; | ||
import processing.app.helpers.FileUtils; | ||
|
||
/** | ||
* Example to watch a directory (or tree) for changes to files. | ||
*/ | ||
|
||
public class WatchDir { | ||
|
||
private final WatchService watcher; | ||
private final Map<WatchKey,Path> keys; | ||
private final boolean recursive; | ||
private boolean trace = false; | ||
|
||
@SuppressWarnings("unchecked") | ||
static <T> WatchEvent<T> cast(WatchEvent<?> event) { | ||
return (WatchEvent<T>)event; | ||
} | ||
|
||
/** | ||
* Register the given directory with the WatchService | ||
*/ | ||
private void register(Path dir) throws IOException { | ||
WatchKey key = dir.register(watcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY); | ||
if (trace) { | ||
Path prev = keys.get(key); | ||
if (prev == null) { | ||
} else { | ||
if (!dir.equals(prev)) { | ||
} | ||
} | ||
} | ||
keys.put(key, dir); | ||
} | ||
|
||
/** | ||
* Register the given directory, and all its sub-directories, with the | ||
* WatchService. | ||
*/ | ||
private void registerAll(final Path start) throws IOException { | ||
// register directory and sub-directories | ||
Files.walkFileTree(start, new SimpleFileVisitor<Path>() { | ||
@Override | ||
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) | ||
throws IOException | ||
{ | ||
register(dir); | ||
return FileVisitResult.CONTINUE; | ||
} | ||
}); | ||
} | ||
|
||
/** | ||
* Creates a WatchService and registers the given directory | ||
*/ | ||
public WatchDir(Path dir, boolean recursive) throws IOException { | ||
this.watcher = FileSystems.getDefault().newWatchService(); | ||
this.keys = new HashMap<WatchKey,Path>(); | ||
this.recursive = recursive; | ||
|
||
if (recursive) { | ||
registerAll(dir); | ||
} else { | ||
register(dir); | ||
} | ||
|
||
// enable trace after initial registration | ||
this.trace = true; | ||
} | ||
|
||
/** | ||
* Process all events for keys queued to the watcher | ||
*/ | ||
public void processEvents(Editor editor) { | ||
for (;;) { | ||
|
||
// wait for key to be signalled | ||
WatchKey key; | ||
try { | ||
key = watcher.take(); | ||
} catch (InterruptedException x) { | ||
return; | ||
} | ||
|
||
Path dir = keys.get(key); | ||
if (dir == null) { | ||
continue; | ||
} | ||
|
||
for (WatchEvent<?> event: key.pollEvents()) { | ||
WatchEvent.Kind kind = event.kind(); | ||
|
||
// TBD - provide example of how OVERFLOW event is handled | ||
if (kind == OVERFLOW) { | ||
continue; | ||
} | ||
|
||
// Context for directory entry event is the file name of entry | ||
WatchEvent<Path> ev = cast(event); | ||
Path name = ev.context(); | ||
Path child = dir.resolve(name); | ||
|
||
// reload the tab content | ||
if (kind == ENTRY_CREATE) { | ||
try { | ||
String filename = name.toString(); | ||
FileUtils.SplitFile split = FileUtils.splitFilename(filename); | ||
if (Sketch.EXTENSIONS.contains(split.extension.toLowerCase())) { | ||
SketchFile sketch = editor.getSketch().addFile(filename); | ||
editor.addTab(sketch, null); | ||
} | ||
} catch (Exception e) { | ||
return; | ||
} | ||
} else if (kind == ENTRY_DELETE) { | ||
try { | ||
Thread.sleep(100); | ||
int index = editor.getSketch().findFileIndex(child.toAbsolutePath().toFile()); | ||
editor.removeTab(editor.getSketch().getFile(index)); | ||
} catch (Exception e1) { | ||
// Totally fine, if the sleep gets interrupted it means that | ||
// the action was executed in the UI, not externally | ||
return; | ||
} | ||
} | ||
editor.getTabs().forEach(tab -> { | ||
if (!tab.isModified()) { | ||
tab.reload(); | ||
} | ||
}); | ||
// if directory is created, and watching recursively, then | ||
// register it and its sub-directories | ||
if (recursive && (kind == ENTRY_CREATE)) { | ||
try { | ||
if (Files.isDirectory(child, NOFOLLOW_LINKS)) { | ||
registerAll(child); | ||
} | ||
} catch (IOException x) { | ||
// ignore to keep sample readbale | ||
} | ||
} | ||
} | ||
|
||
// reset key and remove from set if directory no longer accessible | ||
boolean valid = key.reset(); | ||
if (!valid) { | ||
keys.remove(key); | ||
|
||
// all directories are inaccessible | ||
if (keys.isEmpty()) { | ||
break; | ||
} | ||
} | ||
} | ||
} | ||
} |