GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — processing4/java/src/processing/mode/java/PreprocService.java at main · prithq/processing4 Expand file tree/ Copy pathPreprocService.javaMore file actions 982 lines (841 loc) · 31.8 KB / Copy pathPreprocService.javaFile metadata and controls982 lines (841 loc) · 31.8 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 /* -*- mode: java; c-basic-offset: 2; indent-tabs-mode: nil -*- */ /* Part of the Processing project - http://processing.org Copyright (c) 2012-23 The Processing Foundation This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ package processing.mode.java; import java.io.File; import java.io.IOException; import java.io.StringWriter; import java.nio.file.Files; import java.nio.file.Path; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.ArrayBlockingQueue; import java.util.concurrent.BlockingQueue; import java.util.concurrent.CompletableFuture; import java.util.concurrent.CopyOnWriteArraySet; import java.util.concurrent.ExecutionException; import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.function.Consumer; import java.util.stream.Collectors; import java.util.stream.StreamSupport; import javax.swing.text.BadLocationException; import org.eclipse.jdt.core.JavaCore; import org.eclipse.jdt.core.compiler.IProblem; import org.eclipse.jdt.core.dom.AST; import org.eclipse.jdt.core.dom.ASTParser; import org.eclipse.jdt.core.dom.CompilationUnit; import org.eclipse.jdt.core.dom.FileASTRequestor; import processing.app.Messages; import processing.app.Sketch; import processing.app.SketchCode; import processing.app.Util; import processing.mode.java.preproc.*; import processing.mode.java.preproc.TextTransform.OffsetMapper; import processing.data.IntList; import processing.data.StringList; import processing.utils.SketchException; /** * Service which preprocesses code to check for and report on issues. * <p> * Service running in a background thread which checks for grammatical issues * via ANTLR and performs code analysis via the JDT to check for other issues * and related development services. These are reported as {Problem} instances * via a callback registered by an {Editor}. */ public class PreprocService { private final static int TIMEOUT_MILLIS = 100; private final static int BLOCKING_TIMEOUT_SECONDS = 3000; protected final JavaMode javaMode; protected final Sketch sketch; protected final ASTParser parser = ASTParser.newParser(AST.JLS11); private final Thread preprocessingThread; private final BlockingQueue<Boolean> requestQueue = new ArrayBlockingQueue<>(1); private final Object requestLock = new Object(); private final AtomicBoolean codeFolderChanged = new AtomicBoolean(true); private final AtomicBoolean librariesChanged = new AtomicBoolean(true); private volatile boolean running; private CompletableFuture<PreprocSketch> preprocessingTask = new CompletableFuture<>(); private CompletableFuture<?> lastCallback = new CompletableFuture<>() {{ complete(null); // initialization block }}; /** * Create a new preprocessing service to support the language server. */ public PreprocService(JavaMode javaMode, Sketch sketch) { this.javaMode = javaMode; this.sketch = sketch; // Register listeners for first run whenDone(this::fireListeners); preprocessingThread = new Thread(this::mainLoop, "ECS"); preprocessingThread.start(); } /** * The "main loop" for the background thread that checks for code issues. */ private void mainLoop() { running = true; PreprocSketch prevResult = null; CompletableFuture<?> runningCallbacks = null; Messages.log("Hi!"); while (running) { try { try { requestQueue.take(); // blocking until requested } catch (InterruptedException e) { running = false; break; } Messages.log("Starting"); prevResult = preprocessSketch(prevResult); // Wait until callbacks finish before firing new wave // If new request arrives while waiting, break out and start preprocessing while (requestQueue.isEmpty() && runningCallbacks != null) { try { runningCallbacks.get(TIMEOUT_MILLIS, TimeUnit.MILLISECONDS); runningCallbacks = null; } catch (TimeoutException ignored) { } } synchronized (requestLock) { if (requestQueue.isEmpty()) { runningCallbacks = lastCallback; Messages.log("Done"); preprocessingTask.complete(prevResult); } } } catch (Exception e) { Messages.err("problem in preprocessor service loop", e); } } Messages.log("Bye!"); } /** * End and clean up the background preprocessing thread. */ public void dispose() { cancel(); running = false; preprocessingThread.interrupt(); } /** * Cancel any pending code checks. */ public void cancel() { requestQueue.clear(); } /** * Indicate to this service that the sketch code has changed. */ public void notifySketchChanged() { synchronized (requestLock) { if (preprocessingTask.isDone()) { preprocessingTask = new CompletableFuture<>(); // Register callback which executes all listeners whenDone(this::fireListeners); } requestQueue.offer(Boolean.TRUE); } } /** * Indicate to this service that the sketch libraries have changed. */ public void notifyLibrariesChanged() { Messages.log("notified libraries changed"); librariesChanged.set(true); notifySketchChanged(); } /** * Indicate to this service that the folder housing sketch code has changed. */ public void notifyCodeFolderChanged() { Messages.log("notified code folder changed"); codeFolderChanged.set(true); notifySketchChanged(); } /** * Register a callback to be fired when preprocessing is complete. * * @param callback The consumer to inform when preprocessing is complete which will provide a * {PreprocessedSketch} that has any {Problem} instances that were resultant. * @return A future that will be fulfilled when preprocessing is complete. */ private CompletableFuture<?> registerCallback(Consumer<PreprocSketch> callback) { synchronized (requestLock) { lastCallback = preprocessingTask // Run callback after both preprocessing task and previous callback .thenAcceptBothAsync(lastCallback, (ps, a) -> callback.accept(ps)) // Make sure exception in callback won't cancel whole callback chain .handleAsync((res, e) -> { if (e != null) Messages.err("exception in callback", e); return res; }); return lastCallback; } } /** * Register a callback to be fired when preprocessing is complete if the service is still running. * * <p> * Register a callback to be fired when preprocessing is complete if the service is still running, * turning this into a no-op if it is no longer running. Note that this callback will only be * executed once and it is distinct from registering a listener below which will receive all * future updates. * </p> * * @param callback The consumer to inform when preprocessing is complete which will provide a * {PreprocessedSketch} that has any {Problem} instances that were resultant. */ public void whenDone(Consumer<PreprocSketch> callback) { registerCallback(callback); } /** * Wait for preprocessing to complete. * * <p> * Register a callback to be fired when preprocessing is complete if the service is still running, * turning this into a no-op if it is no longer running. However, wait up to * BLOCKING_TIMEOUT_SECONDS in a blocking manner until preprocessing is complete. * Note that this callback will only be executed once and it is distinct from registering a * listener below which will receive all future updates. * </p> */ public void whenDoneBlocking(Consumer<PreprocSketch> callback) { try { registerCallback(callback).get(BLOCKING_TIMEOUT_SECONDS, TimeUnit.SECONDS); } catch (InterruptedException | ExecutionException | TimeoutException e) { // Don't care } } /// LISTENERS ---------------------------------------------------------------- private final Set<Consumer<PreprocSketch>> listeners = new CopyOnWriteArraySet<>(); /** * Register a consumer that will receive all {PreprocessedSketch}es * produced from this service. * @param listener The listener to receive all future {PreprocessedSketch}es. */ public void registerListener(Consumer<PreprocSketch> listener) { if (listener != null) listeners.add(listener); } /** * Remove a consumer previously registered. * * <p> * Remove a consumer previously registered that was receiving {PreprocessedSketch}es produced from * this service. * </p> * * @param listener The listener to remove. */ public void unregisterListener(Consumer<PreprocSketch> listener) { listeners.remove(listener); } /** * Inform consumers waiting for {PreprocessedSketch}es. * * <p> * Inform all consumers registered for receiving ongoing {PreprocessedSketch}es produced from * this service. * </p> * * @param ps The sketch to be sent out to consumers. */ private void fireListeners(PreprocSketch ps) { for (Consumer<PreprocSketch> listener : listeners) { try { listener.accept(ps); } catch (Exception e) { Messages.err("error when firing preprocessing listener", e); } } } /// -------------------------------------------------------------------------- /** * Transform and attempt compilation of a sketch. * * <p> * Transform a sketch via ANTLR first to detect and explain grammatical issues before executing a * build via the JDT to detect other non-grammatical compilation issues and to support developer * services in the editor. * </p> * * @param prevResult The last produced preprocessed sketch or null if never preprocessed * beforehand. * @return The newly generated preprocessed sketch. */ private PreprocSketch preprocessSketch(PreprocSketch prevResult) { boolean firstCheck = (prevResult == null); PreprocSketch.Builder result = new PreprocSketch.Builder(); List<ImportStatement> codeFolderImports = result.codeFolderImports; List<ImportStatement> programImports = result.programImports; result.sketch = this.sketch; String className = sketch.getMainName(); StringBuilder workBuffer = new StringBuilder(); // Combine code into one buffer int numLines = 1; IntList tabStartsList = new IntList(); List<JavaSketchCode> javaFiles = new ArrayList<>(); List<Integer> tabLineStarts = new ArrayList<>(); for (SketchCode sc : sketch.getCode()) { if (sc.isExtension("pde")) { tabStartsList.append(workBuffer.length()); tabLineStarts.add(numLines); String newPieceBuilt = getSketchTabContents(sc) + '\n'; numLines += SourceUtil.getCount(newPieceBuilt, "\n"); workBuffer.append(newPieceBuilt); } else if (sc.isExtension("java")) { tabStartsList.append(workBuffer.length()); tabLineStarts.add(numLines); javaFiles.add(new JavaSketchCode(sc, tabStartsList.size()-1)); String newPieceBuilt = String.format( "\n// Skip java file %s.\n", sc.getFileName() ); numLines += SourceUtil.getCount(newPieceBuilt, "\n"); workBuffer.append(newPieceBuilt); } } result.tabStartOffsets = tabStartsList.toArray(); String pdeStage = result.pdeCode = workBuffer.toString(); boolean reloadCodeFolder = firstCheck || codeFolderChanged.getAndSet(false); boolean reloadLibraries = firstCheck || librariesChanged.getAndSet(false); // Core and default imports PdePreprocessor preProcessor = PdePreprocessor.builderFor(this.sketch.getMainName()).build(); if (coreAndDefaultImports == null) { coreAndDefaultImports = buildCoreAndDefaultImports(preProcessor); } result.coreAndDefaultImports.addAll(coreAndDefaultImports); // Prepare code folder imports if (reloadCodeFolder) { codeFolderImports.addAll(buildCodeFolderImports(sketch)); } else { codeFolderImports.addAll(prevResult.codeFolderImports); } // TODO: convert unicode escapes to chars // TODO: This appears no longer to be needed. SourceUtil.scrubCommentsAndStrings(workBuffer); result.scrubbedPdeCode = workBuffer.toString(); PreprocessorResult preprocessorResult; try { preprocessorResult = preProcessor.write( new StringWriter(), result.scrubbedPdeCode, codeFolderImports.stream() .map(ImportStatement::getFullMemberName) .collect(Collectors.toList()) ); } catch (SketchException e) { throw new RuntimeException("Unexpected sketch exception in preprocessing: " + e); } final int endNumLines = numLines; if (preprocessorResult.getPreprocessIssues().size() > 0) { preprocessorResult.getPreprocessIssues().stream() .map((x) -> ProblemFactory.build(x, tabLineStarts)) .forEach(result.otherProblems::add); result.hasSyntaxErrors = true; } // Save off the imports programImports.addAll(preprocessorResult.getImportStatements()); result.programImports.addAll(preprocessorResult.getImportStatements()); // Prepare transforms to convert pde code into parsable code TextTransform toParsable = new TextTransform(pdeStage); toParsable.addAll(preprocessorResult.getEdits()); { // Refresh sketch classloader and classpath if imports changed if (reloadLibraries) { runtimePathBuilder.markLibrariesChanged(); } boolean rebuildLibraryClassPath = reloadLibraries || checkIfImportsChanged(programImports, prevResult.programImports); if (rebuildLibraryClassPath) { runtimePathBuilder.markLibraryImportsChanged(); } boolean rebuildClassPath = reloadCodeFolder || rebuildLibraryClassPath || prevResult.classLoader == null || prevResult.classPath == null || prevResult.classPathArray == null || prevResult.searchClassPathArray == null; if (reloadCodeFolder) { runtimePathBuilder.markCodeFolderChanged(); } if (rebuildClassPath) { runtimePathBuilder.prepareClassPath(result, javaMode); } else { result.classLoader = prevResult.classLoader; result.classPath = prevResult.classPath; result.searchClassPathArray = prevResult.searchClassPathArray; result.classPathArray = prevResult.classPathArray; } } // Transform code to parsable state String parsableStage = toParsable.apply(); OffsetMapper parsableMapper = toParsable.getMapper(); // Create intermediate AST for advanced preprocessing // Wait on .java tabs due to speed since they don't go through preproc. CompileResults parsableCompile = compileInMemory( parsableStage, className, result.classPathArray, false ); CompilationUnit parsableCU = parsableCompile.getCompilationUnit(); // Prepare advanced transforms which operate on AST TextTransform toCompilable = new TextTransform(parsableStage); toCompilable.addAll(SourceUtil.preprocessAST(parsableCU)); // Transform code to compilable state // Again, wait on .java tabs due to speed since they don't go through // the preprocessor. String compilableStage = toCompilable.apply(); OffsetMapper compilableMapper = toCompilable.getMapper(); // Create compilable AST to get syntax problems CompileResults compilableCompile = compileInMemory( compilableStage, className, result.classPathArray, false ); CompilationUnit compilableCU = compilableCompile.getCompilationUnit(); // Get syntax problems from compilable AST result.hasSyntaxErrors |= Arrays.stream(compilableCU.getProblems()).anyMatch(IProblem::isError); // Generate bindings after getting problems - avoids // 'missing type' errors when there are syntax problems. // Introduce .java tabs here for type resolution. CompileResults bindingsCompile; if (javaFiles.size() == 0) { bindingsCompile = compileInMemory( compilableStage, className, result.classPathArray, true ); } else { bindingsCompile = compileFromDisk( compilableStage, className, result.classPathArray, javaFiles ); } // Get compilation problems List<IProblem> bindingsProblems = bindingsCompile.getProblems(); result.hasCompilationErrors = bindingsProblems.stream().anyMatch(IProblem::isError); // Update builder result.offsetMapper = parsableMapper.thenMapping(compilableMapper); result.javaCode = compilableStage; result.compilationUnit = bindingsCompile.getCompilationUnit(); result.javaFileMapping = bindingsCompile.getJavaFileMapping(); result.iproblems = bindingsCompile.getProblems(); // Build it return result.build(); } /** * Get the updated (and possibly unsaved) code from a sketch tab. * * @param sketchCode The tab from which to content program contents. * @return Updated program contents. */ private String getSketchTabContents(SketchCode sketchCode) { String code = null; if (sketchCode.getDocument() != null) { try { code = sketchCode.getDocumentText(); } catch (BadLocationException e) { e.printStackTrace(); } } if (code == null) { code = sketchCode.getProgram(); } return code; } /// COMPILATION ----------------------------------------------------------- /** * Perform compilation on a transformed Processing sketch. * * <p> * Perform compilation with optional binding on a transformed Processing * sketch that is fully described in a single in a single in memory string. * </p> * * @param sketchSource Full processing sketch source code. * @param className The name of the class enclosing the sketch. * @param classPathArray List of classpath entries. * @param resolveBindings Flag indicating if compilation should happen with * binding resolution. * @return The results of compilation with binding. */ private CompileResults compileInMemory(String sketchSource, String className, String[] classPathArray, boolean resolveBindings) { // Prepare parser parser.setSource(sketchSource.toCharArray()); setupParser(resolveBindings, className, classPathArray); CompilationUnit compilationUnit = (CompilationUnit) parser.createAST(null); List<IProblem> problems = Arrays.asList(compilationUnit.getProblems()); return new CompileResults(compilationUnit, problems, new HashMap<>()); } /** * Perform compilation on a sketch with ".java" tabs. * * <p> * Perform compilation with optional binding on a transformed Processing sketch * containing Java files beyond the generated sketch after preprocessing. * </p> * * @param sketchSource Full processing sketch source code without the * ".java" tabs. * @param className The name of the class enclosing the sketch. * @param classPathArray List of classpath entries. * @param javaFiles Information about the java files. * @return The results of compilation with binding. */ private CompileResults compileFromDisk(String sketchSource, String className, String[] classPathArray, List<JavaSketchCode> javaFiles) { ProcessingASTRequester astRequester; List<Path> temporaryFilesList = new ArrayList<>(); Map<String, Integer> javaFileMapping = new HashMap<>(); // Prepare parser setupParser(true, className, classPathArray); // Write compilable processing file Path mainTemporaryFile = createTemporaryFile(sketchSource); final String mainSource = mainTemporaryFile.toString(); temporaryFilesList.add(mainTemporaryFile); // Write temporary java files as tab may be unsaved for (JavaSketchCode javaFile : javaFiles) { String tabContents = getSketchTabContents(javaFile.getSketchCode()); Path newPath = createTemporaryFile(tabContents); javaFileMapping.put(newPath.toString(), javaFile.getTabIndex()); temporaryFilesList.add(newPath); } // Convert paths int numFiles = temporaryFilesList.size(); String[] temporaryFilesArray = new String[numFiles]; for (int i = 0; i < numFiles; i++) { temporaryFilesArray[i] = temporaryFilesList.get(i).toString(); } // Compile astRequester = new ProcessingASTRequester(mainSource); parser.createASTs( temporaryFilesArray, null, new String[] {}, astRequester, null ); // Delete deleteTemporaryFiles(temporaryFilesList); // Return return new CompileResults( astRequester.getMainCompilationUnit(), astRequester.getProblems(), javaFileMapping ); } /** * Set up the parser compiler options and optionally bindings information. * * @param resolveBindings Flag indicating if bindings should be resolved / * checked for things like missing types. * @param className The name of the class enclosing the sketch. * @param classPathArray List of classpath entries. */ private void setupParser(boolean resolveBindings, String className, String[] classPathArray) { parser.setKind(ASTParser.K_COMPILATION_UNIT); parser.setCompilerOptions(COMPILER_OPTIONS); parser.setStatementsRecovery(true); if (resolveBindings) { parser.setUnitName(className); parser.setEnvironment(classPathArray, null, null, true); parser.setResolveBindings(true); } } /** * Create a temporary file for compilation with compileFromDisk. * * <p> * Create a temporary file for compilation with compileFromDisk where it may * be necessary to provide multiple files (like in the case of .java tabs) to * JDT. * </p> * * @param content The content to write to the temporary file. * @return Path to the newly created temporary file. */ private Path createTemporaryFile(String content) { try { Path tempFile = Files.createTempFile(null, null); Files.writeString(tempFile, content); return tempFile; } catch (IOException e) { throw new RuntimeException("Cannot write to temporary folder."); } } /** * Delete temporary files used for compileFromDisk. * * @param paths The temporary files to remove. */ private void deleteTemporaryFiles(List<Path> paths) { try { for (Path path : paths) { Files.delete(path); } } catch (IOException e) { throw new RuntimeException("Cannot delete from temporary folder."); } } /** * JDT AST requester for compileFromDisk. * * <p> * Abstract syntax tree requester for the JDT useful for compileFromDisk where * there may be ".java" tabs in addition to the single combined ".pde" source. * This requester will collect problems from all files but hold onto the AST * for the sketch's combined PDE code (not ".java" tabs). * </p> */ static private class ProcessingASTRequester extends FileASTRequestor { private final String mainSource; private final List<IProblem> problems; private CompilationUnit mainCompilationUnit; /** * Create a new requester filtering for a target file. * * @param newMainSource The file (likely temporary file) that contains the * PDE main sketch code. */ public ProcessingASTRequester(String newMainSource) { mainSource = newMainSource; problems = new ArrayList<>(); } /** * Callback for a new AST. * * @param source The file from which the AST was built. * @param ast The newly built AST as a compilation unit. */ public void acceptAST(String source, CompilationUnit ast) { if (source.equals(mainSource)) { mainCompilationUnit = ast; } Collections.addAll(problems, ast.getProblems()); } /** * Get problems found from all source files. * * @return Problems found across all files. */ public List<IProblem> getProblems() { return problems; } /** * Get the CompilationUnit (AST) associated with the combined PDE source. * * @return Compilation unit associated with the combined PDE source * (excludes ".java" tabs). */ public CompilationUnit getMainCompilationUnit() { return mainCompilationUnit; } } /** * Data structure holding the results of compilation. */ static private class CompileResults { private final CompilationUnit compilationUnit; private final List<IProblem> problems; private final Map<String, Integer> javaFileMapping; /** * Create a new record of compilation. * * @param newCompilationUnit The main compilation unit associated with the * combined PDE sources (excludes ".java" tabs). * @param newProblems The problems found across all tabs (PDS or .java). * @param newJavaFileMapping Mapping from java temporary file name to tab * number for ".java" tabs. */ public CompileResults(CompilationUnit newCompilationUnit, List<IProblem> newProblems, Map<String, Integer> newJavaFileMapping) { compilationUnit = newCompilationUnit; problems = newProblems; javaFileMapping = newJavaFileMapping; } /** * Get the main compilation unit. * * @return The main compilation unit for the combined PDE sources. This is * typically the entire sketch except if there are ".java" tabs which * are excluded from this compilation unit as they may be in different * packages. */ public CompilationUnit getCompilationUnit() { return compilationUnit; } /** * Get problems found in compilation. * * @return Problems found across all files (PDE or ".java" tabs). */ public List<IProblem> getProblems() { return problems; } /** * Get mapping from ".java" temporary file to tab index. * * @return To deal with unsaved ".java" file changes, this mapping indicates * into what temporary file a ".java" tab ended up to the tab index for * that file. */ public Map<String, Integer> getJavaFileMapping() { return javaFileMapping; } } /** * SketchCode (tab of sketch) which is a ".java" tab. */ static private class JavaSketchCode { private final SketchCode sketchCode; private final int tabIndex; /** * Create a new record of a ".java" tab inside a sketch. * * @param newSketchCode The SketchCode to be decorated. * @param newTabIndex The index of the tab. */ public JavaSketchCode(SketchCode newSketchCode, int newTabIndex) { sketchCode = newSketchCode; tabIndex = newTabIndex; } /** * Get the sketch tab. * * @return SketchCode The tab and its contents. */ public SketchCode getSketchCode() { return sketchCode; } /** * Get the index of the tab. * * @return The index of this ".java" tab within the sketch. */ public int getTabIndex() { return tabIndex; } } /// IMPORTS ----------------------------------------------------------------- private List<ImportStatement> coreAndDefaultImports; /** * Determine which imports need to be available for core processing services. * * @param preprocessor The preprocessor to operate on. * @return The import statements that need to be present. */ private static List<ImportStatement> buildCoreAndDefaultImports(PdePreprocessor preprocessor) { List<ImportStatement> result = new ArrayList<>(); for (String imp : preprocessor.getCoreImports()) { result.add(ImportStatement.parse(imp)); } for (String imp : preprocessor.getDefaultImports()) { result.add(ImportStatement.parse(imp)); } return result; } /** * Create import statements for items in the code folder itself. * * @param sketch The sketch for which the import statements should be created. * @return The new import statements. */ private static List<ImportStatement> buildCodeFolderImports(Sketch sketch) { if (sketch.hasCodeFolder()) { File codeFolder = sketch.getCodeFolder(); String codeFolderClassPath = Util.contentsToClassPath(codeFolder); StringList codeFolderPackages = Util.packageListFromClassPath(codeFolderClassPath); return StreamSupport.stream(codeFolderPackages.spliterator(), false) .map(ImportStatement::wholePackage) .collect(Collectors.toList()); } return Collections.emptyList(); } /** * Determine if imports have changed. * * @param prevImports The last iteration imports. * @param imports The current iterations imports. * @return True if the list of imports changed and false otherwise. * This includes change in order. */ private static boolean checkIfImportsChanged(List<ImportStatement> prevImports, List<ImportStatement> imports) { if (imports.size() != prevImports.size()) { return true; } else { int count = imports.size(); for (int i = 0; i < count; i++) { if (!imports.get(i).isSameAs(prevImports.get(i))) { return true; } } } return false; } /// CLASS PATHS -------------------------------------------------------------- private final RuntimePathBuilder runtimePathBuilder = new RuntimePathBuilder(); /// -------------------------------------------------------------------------- static private final Map<String, String> COMPILER_OPTIONS; static { Map<String, String> compilerOptions = new HashMap<>(); // TODO: VERSION_17 if using new language features. Requires new JDT. compilerOptions.put(JavaCore.COMPILER_COMPLIANCE, JavaCore.VERSION_11); compilerOptions.put(JavaCore.COMPILER_SOURCE, JavaCore.VERSION_11); compilerOptions.put(JavaCore.COMPILER_CODEGEN_TARGET_PLATFORM, JavaCore.VERSION_11); // See http://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Fguide%2Fjdt_api_options.htm&anchor=compiler final String[] generate = { JavaCore.COMPILER_LINE_NUMBER_ATTR, JavaCore.COMPILER_SOURCE_FILE_ATTR }; final String[] ignore = { JavaCore.COMPILER_PB_UNUSED_IMPORT, JavaCore.COMPILER_PB_MISSING_SERIAL_VERSION, JavaCore.COMPILER_PB_RAW_TYPE_REFERENCE, JavaCore.COMPILER_PB_REDUNDANT_TYPE_ARGUMENTS, JavaCore.COMPILER_PB_UNCHECKED_TYPE_OPERATION }; final String[] warn = { JavaCore.COMPILER_PB_NO_EFFECT_ASSIGNMENT, JavaCore.COMPILER_PB_NULL_REFERENCE, JavaCore.COMPILER_PB_POTENTIAL_NULL_REFERENCE, JavaCore.COMPILER_PB_REDUNDANT_NULL_CHECK, JavaCore.COMPILER_PB_POSSIBLE_ACCIDENTAL_BOOLEAN_ASSIGNMENT, JavaCore.COMPILER_PB_UNUSED_LABEL, JavaCore.COMPILER_PB_UNUSED_LOCAL, JavaCore.COMPILER_PB_UNUSED_OBJECT_ALLOCATION, JavaCore.COMPILER_PB_UNUSED_PARAMETER, JavaCore.COMPILER_PB_UNUSED_PRIVATE_MEMBER }; for (String s : generate) compilerOptions.put(s, JavaCore.GENERATE); for (String s : ignore) compilerOptions.put(s, JavaCore.IGNORE); for (String s : warn) compilerOptions.put(s, JavaCore.WARNING); COMPILER_OPTIONS = Collections.unmodifiableMap(compilerOptions); } } |
| You are visitor 01402503 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |