1 #// Usage: jjs find_nonfinals2.js -- <directory>
   2 
   3 /*
   4  * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  *   - Redistributions of source code must retain the above copyright
  11  *     notice, this list of conditions and the following disclaimer.
  12  *
  13  *   - Redistributions in binary form must reproduce the above copyright
  14  *     notice, this list of conditions and the following disclaimer in the
  15  *     documentation and/or other materials provided with the distribution.
  16  *
  17  *   - Neither the name of Oracle nor the names of its
  18  *     contributors may be used to endorse or promote products derived
  19  *     from this software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  22  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  23  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  25  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  26  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  27  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  28  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  29  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  30  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  31  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33 
  34 // This example demonstrates Java subclassing by Java.extend
  35 // and javac Compiler and Tree API. This example finds method
  36 // parameters without "final" keyword and prints info on those.
  37 
  38 if (arguments.length == 0) {
  39     print("Usage: jjs find_nonfinals2.js -- <directory>");
  40     exit(1);
  41 }
  42 
  43 // Java types used
  44 var File = Java.type("java.io.File");
  45 var Files = Java.type("java.nio.file.Files");
  46 var FileVisitOption = Java.type("java.nio.file.FileVisitOption");
  47 var StringArray = Java.type("java.lang.String[]");
  48 var ToolProvider = Java.type("javax.tools.ToolProvider");
  49 var Tree = Java.type("com.sun.source.tree.Tree");
  50 var TreeScanner = Java.type("com.sun.source.util.TreeScanner");
  51 var Modifier = Java.type("javax.lang.model.element.Modifier");
  52 
  53 function checkNonFinalParams(p) {
  54     // get the system compiler tool
  55     var compiler = ToolProvider.systemJavaCompiler;
  56     // get standard file manager
  57     var fileMgr = compiler.getStandardFileManager(null, null, null);
  58     // Using Java.to convert script array (arguments) to a Java String[]
  59     var compUnits = fileMgr.getJavaFileObjects(
  60         Java.to(arguments, StringArray));
  61     // create a new compilation task
  62     var task = compiler.getTask(null, fileMgr, null, null, null, compUnits);
  63     // subclass SimpleTreeVisitor - to find non-final method params
  64     var NonFinalsFinder = Java.extend(TreeScanner);
  65 
  66     function printMethod(method) {
  67         print(method.modifiers + " "+ method.returnType + " " +
  68             method.name + "(" + method.parameters + ")");
  69     }
  70 
  71     var pkgName, clsName, compUnitName, lineMap;
  72     var visitor = new NonFinalsFinder() {
  73         visitCompilationUnit: function(compUnit, p) {
  74             pkgName = compUnit.packageName;
  75             compUnitName = compUnit.sourceFile.name;
  76             lineMap = compUnit.lineMap;
  77             return Java.super(visitor).visitCompilationUnit(compUnit, p);
  78         },
  79 
  80         visitClass: function(clazz, p) {
  81             clsName = clazz.name;
  82             return Java.super(visitor).visitClass(clazz, p);
  83         },
  84 
  85         visitMethod: function (method, p) {
  86             var params = method.parameters;
  87             for each (var p in params) {
  88                 var modifiers = p.modifiers;
  89                 if (! modifiers.flags.contains(Modifier.FINAL)) {
  90                     print(compUnitName);
  91                     print(pkgName + "." + clsName);
  92                     printMethod(method);
  93                     print("->", p,
  94                      " @ " + lineMap.getLineNumber(p.pos) + ":" +
  95                            lineMap.getColumnNumber(p.pos));
  96                 }
  97             }
  98         }
  99     }
 100 
 101     for each (var cu in task.parse()) {
 102         cu.accept(visitor, null);
 103     }
 104 }
 105 
 106 // for each ".java" file in directory (recursively).
 107 function main(dir) {
 108     var totalCount = 0;
 109     Files.walk(dir.toPath(), FileVisitOption.FOLLOW_LINKS).
 110       forEach(function(p) {
 111         var name = p.toFile().absolutePath;
 112         if (name.endsWith(".java")) {
 113             checkNonFinalParams(p);
 114         }
 115       });
 116 }
 117 
 118 main(new File(arguments[0]));