|
| 1 | +/* |
| 2 | + * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * |
| 4 | + * Redistribution and use in source and binary forms, with or without |
| 5 | + * modification, are permitted provided that the following conditions |
| 6 | + * are met: |
| 7 | + * |
| 8 | + * - Redistributions of source code must retain the above copyright |
| 9 | + * notice, this list of conditions and the following disclaimer. |
| 10 | + * |
| 11 | + * - Redistributions in binary form must reproduce the above copyright |
| 12 | + * notice, this list of conditions and the following disclaimer in the |
| 13 | + * documentation and/or other materials provided with the distribution. |
| 14 | + * |
| 15 | + * - Neither the name of Oracle nor the names of its |
| 16 | + * contributors may be used to endorse or promote products derived |
| 17 | + * from this software without specific prior written permission. |
| 18 | + * |
| 19 | + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS |
| 20 | + * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, |
| 21 | + * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| 22 | + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| 23 | + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| 24 | + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| 25 | + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
| 26 | + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
| 27 | + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| 28 | + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| 29 | + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 30 | + */ |
| 31 | + |
| 32 | +package processing.app.tools; |
| 33 | + |
| 34 | +import java.nio.file.*; |
| 35 | +import static java.nio.file.StandardWatchEventKinds.*; |
| 36 | +import static java.nio.file.LinkOption.*; |
| 37 | +import java.nio.file.attribute.*; |
| 38 | +import java.io.*; |
| 39 | +import java.util.*; |
| 40 | +import processing.app.Editor; |
| 41 | +import processing.app.EditorTab; |
| 42 | +import processing.app.Sketch; |
| 43 | +import processing.app.SketchFile; |
| 44 | +import processing.app.helpers.FileUtils; |
| 45 | + |
| 46 | +/** |
| 47 | + * Example to watch a directory (or tree) for changes to files. |
| 48 | + */ |
| 49 | + |
| 50 | +public class WatchDir { |
| 51 | + |
| 52 | + private final WatchService watcher; |
| 53 | + private final Map<WatchKey,Path> keys; |
| 54 | + private final boolean recursive; |
| 55 | + private boolean trace = false; |
| 56 | + |
| 57 | + @SuppressWarnings("unchecked") |
| 58 | + static <T> WatchEvent<T> cast(WatchEvent<?> event) { |
| 59 | + return (WatchEvent<T>)event; |
| 60 | + } |
| 61 | + |
| 62 | + /** |
| 63 | + * Register the given directory with the WatchService |
| 64 | + */ |
| 65 | + private void register(Path dir) throws IOException { |
| 66 | + WatchKey key = dir.register(watcher, ENTRY_CREATE, ENTRY_DELETE, ENTRY_MODIFY); |
| 67 | + if (trace) { |
| 68 | + Path prev = keys.get(key); |
| 69 | + if (prev == null) { |
| 70 | + } else { |
| 71 | + if (!dir.equals(prev)) { |
| 72 | + } |
| 73 | + } |
| 74 | + } |
| 75 | + keys.put(key, dir); |
| 76 | + } |
| 77 | + |
| 78 | + /** |
| 79 | + * Register the given directory, and all its sub-directories, with the |
| 80 | + * WatchService. |
| 81 | + */ |
| 82 | + private void registerAll(final Path start) throws IOException { |
| 83 | + // register directory and sub-directories |
| 84 | + Files.walkFileTree(start, new SimpleFileVisitor<Path>() { |
| 85 | + @Override |
| 86 | + public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) |
| 87 | + throws IOException |
| 88 | + { |
| 89 | + register(dir); |
| 90 | + return FileVisitResult.CONTINUE; |
| 91 | + } |
| 92 | + }); |
| 93 | + } |
| 94 | + |
| 95 | + /** |
| 96 | + * Creates a WatchService and registers the given directory |
| 97 | + */ |
| 98 | + public WatchDir(Path dir, boolean recursive) throws IOException { |
| 99 | + this.watcher = FileSystems.getDefault().newWatchService(); |
| 100 | + this.keys = new HashMap<WatchKey,Path>(); |
| 101 | + this.recursive = recursive; |
| 102 | + |
| 103 | + if (recursive) { |
| 104 | + registerAll(dir); |
| 105 | + } else { |
| 106 | + register(dir); |
| 107 | + } |
| 108 | + |
| 109 | + // enable trace after initial registration |
| 110 | + this.trace = true; |
| 111 | + } |
| 112 | + |
| 113 | + /** |
| 114 | + * Process all events for keys queued to the watcher |
| 115 | + */ |
| 116 | + public void processEvents(Editor editor) { |
| 117 | + for (;;) { |
| 118 | + |
| 119 | + // wait for key to be signalled |
| 120 | + WatchKey key; |
| 121 | + try { |
| 122 | + key = watcher.take(); |
| 123 | + } catch (InterruptedException x) { |
| 124 | + return; |
| 125 | + } |
| 126 | + |
| 127 | + Path dir = keys.get(key); |
| 128 | + if (dir == null) { |
| 129 | + continue; |
| 130 | + } |
| 131 | + |
| 132 | + for (WatchEvent<?> event: key.pollEvents()) { |
| 133 | + WatchEvent.Kind kind = event.kind(); |
| 134 | + |
| 135 | + // TBD - provide example of how OVERFLOW event is handled |
| 136 | + if (kind == OVERFLOW) { |
| 137 | + continue; |
| 138 | + } |
| 139 | + |
| 140 | + // Context for directory entry event is the file name of entry |
| 141 | + WatchEvent<Path> ev = cast(event); |
| 142 | + Path name = ev.context(); |
| 143 | + Path child = dir.resolve(name); |
| 144 | + |
| 145 | + // reload the tab content |
| 146 | + if (kind == ENTRY_CREATE) { |
| 147 | + try { |
| 148 | + String filename = name.toString(); |
| 149 | + FileUtils.SplitFile split = FileUtils.splitFilename(filename); |
| 150 | + if (Sketch.EXTENSIONS.contains(split.extension.toLowerCase())) { |
| 151 | + SketchFile sketch = editor.getSketch().addFile(filename); |
| 152 | + editor.addTab(sketch, null); |
| 153 | + } |
| 154 | + } catch (IOException e) {} |
| 155 | + } else if (kind == ENTRY_DELETE) { |
| 156 | + List<EditorTab> tabs = editor.getTabs(); |
| 157 | + Iterator<EditorTab> iter = tabs.iterator(); |
| 158 | + while (iter.hasNext()) { |
| 159 | + EditorTab tab = iter.next(); |
| 160 | + if (name.getFileName().toString().equals(tab.getSketchFile().getFileName())) { |
| 161 | + try { |
| 162 | + editor.removeTab(tab.getSketchFile()); |
| 163 | + } catch (IOException e) {} |
| 164 | + } |
| 165 | + } |
| 166 | + } |
| 167 | + editor.getTabs().forEach(tab -> tab.reload()); |
| 168 | + |
| 169 | + // if directory is created, and watching recursively, then |
| 170 | + // register it and its sub-directories |
| 171 | + if (recursive && (kind == ENTRY_CREATE)) { |
| 172 | + try { |
| 173 | + if (Files.isDirectory(child, NOFOLLOW_LINKS)) { |
| 174 | + registerAll(child); |
| 175 | + } |
| 176 | + } catch (IOException x) { |
| 177 | + // ignore to keep sample readbale |
| 178 | + } |
| 179 | + } |
| 180 | + } |
| 181 | + |
| 182 | + // reset key and remove from set if directory no longer accessible |
| 183 | + boolean valid = key.reset(); |
| 184 | + if (!valid) { |
| 185 | + keys.remove(key); |
| 186 | + |
| 187 | + // all directories are inaccessible |
| 188 | + if (keys.isEmpty()) { |
| 189 | + break; |
| 190 | + } |
| 191 | + } |
| 192 | + } |
| 193 | + } |
| 194 | +} |
0 commit comments