[
{
"path": ".github/ISSUE_TEMPLATE/------.md",
"content": "---\nname: 规约问题模板\nabout: 规约问题请使用该模板\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n## 规约原文\n\n## 问题描述\n\n## 修改建议\n"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**To Reproduce**\nSteps to reproduce the behavior:\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Screenshots**\nIf applicable, add screenshots to help explain your problem.\n\n**Desktop (please complete the following information):**\n - OS: [e.g. iOS]\n - Browser [e.g. chrome, safari]\n - Version [e.g. 22]\n\n**Smartphone (please complete the following information):**\n - Device: [e.g. iPhone6]\n - OS: [e.g. iOS8.1]\n - Browser [e.g. stock browser, safari]\n - Version [e.g. 22]\n\n**Additional context**\nAdd any other context about the problem here.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Describe alternatives you've considered**\nA clear and concise description of any alternative solutions or features you've considered.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n"
},
{
"path": ".github/ISSUE_TEMPLATE/rule-issue-template.md",
"content": "---\nname: Rule issue template\nabout: Rule issue please use this template.\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n## Rule content\n\n## Problem description\n\n## Advice\n"
},
{
"path": ".gitignore",
"content": "# Gradle\nbuild\n.gradle\n\ntestdata/\n# Java gitignore #\n.class\n.log\n\n# Package Files #\n\n*.war\n*.ear\n\n#hsf files\nconfiguration\n\n# maven gitignore#\ntarget/**\n\n.svn/\n\n# intelliJ.gitignore #\n.idea\n*.iml\n*.ipr\n*.iws\n\n\n# Eclipse git ignore#\n*.pydevproject\n.project\n.metadata\nbin/**\n*/bin/**\ntmp/**\ntmp/**/*\nconfiguration/**\n*.tmp\n*.bak\n*.orig\n*.swp\n*~.nib\n.classpath\n.settings/\n.loadpath\n.fileTable*\n.cache\n\n# External tool builders\n.externalToolBuilders/\n\n# Locally stored \"Eclipse launch configurations\"\n*.launch\n\n# CDT-specific\n.cproject\n\n# PDT-specific\n.buildpath\n\n#log\n*.log\n*.log.*\n\n# Windows Thumbs.db\n*.db\n\n# OSX\n.DS_Store\n\n# sass gitignore#\n.sass-cache\n.idea\n\n# tcc_coverage\ncoverage.ec\n\n\n\nconfig.client.*\n\ntemp/\n*.pid\n*.orig\n\nhsf.configuration/\n\n# code coverage report\n*.ec\n\n#hsf test\n*.instance\nout\n!/p3c-idea/src/main/kotlin/com/alibaba/smartfox/work/tools/aone/ui/AoneBranchView.kt\n"
},
{
"path": "README.md",
"content": "# P3C\n\n最新版本：黄山版（2022.2.3发布）\n\n[](https://www.apache.org/licenses/LICENSE-2.0.html)\n\n## Preface\n> We are pleased to present Alibaba Java Coding Guidelines which consolidates the best programming practices over the years from Alibaba Group's technical teams. A vast number of Java programming teams impose demanding requirements on code quality across projects as we encourage reuse and better understanding of each other's programs. We have seen many programming problems in the past. For example, defective database table structures and index designs may cause software architecture flaws and performance risks. Another example is confusing code structures being difficult to maintain. Furthermore, vulnerable code without authentication is prone to hackers’ attacks. To address these kinds of problems, we developed this document for Java developers at Alibaba.\n \nFor more information please refer the *Alibaba Java Coding Guidelines*:\n- 中文版: 直接下载上方的PDF文件（黄山版）\n- English Version: *[Alibaba Java Coding Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines)*\n\n## Introduction\nThe project consists of 3 parts: \n- [PMD implementations](p3c-pmd) \n- [IntelliJ IDEA plugin](idea-plugin) \n- [Eclipse plugin](eclipse-plugin) \n\n## Rules\nForty-nine rules are realized based on PMD, please refer the P3C-PMD documentation for more detailed information. Four rules are implemented within IDE plugins (IDEA and Eclipse) as follows: \n\n- ``[Mandatory]`` Using a deprecated class or method is prohibited. \n Note: For example, decode(String source, String encode) should be used instead of the deprecated method decode(String encodeStr). Once an interface has been deprecated, the interface provider has the obligation to provide a new one. At the same time, client programmers have the obligation to check out what its new implementation is.\n \n- ``[Mandatory]`` An overridden method from an interface or abstract class must be marked with @Override annotation.\n Counter example: For getObject() and get0bject(), the first one has a letter 'O', and the second one has a number '0'. To accurately determine whether the overriding is successful, an @Override annotation is necessary. Meanwhile, once the method signature in the abstract class is changed, the implementation class will report a compile-time error immediately.\n \n- ``[Mandatory]`` A static field or method should be directly referred by its class name instead of its corresponding object name.\n\n- ``[Mandatory]`` The usage of hashCode and equals should follow:\n 1. Override hashCode if equals is overridden.\n 2. These two methods must be overridden for Set since they are used to ensure that no duplicate object will be inserted in Set.\n 3. These two methods must be overridden if self-defined object is used as the key of Map.\n Note: String can be used as the key of Map since these two methods have been rewritten.\n\n"
},
{
"path": "eclipse-plugin/.gitignore",
"content": "# Gradle\nbuild\n.gradle\n\ntestdata/\n# Java gitignore #\n.class\n.log\n\n# Package Files #\n\n*.war\n*.ear\n*.gradle\n\n#hsf files\nconfiguration\n\n# maven gitignore#\ntarget/**\n\n.svn/\n\n# intelliJ.gitignore #\n.idea\n*.iml\n*.ipr\n*.iws\n*.bat\n\n# Eclipse git ignore#\n*.pydevproject\n.project\n.metadata\nbin/**\n*/bin/**\ntmp/**\ntmp/**/*\nconfiguration/**\n*.tmp\n*.bak\n*.orig\n*.swp\n*~.nib\n.classpath\n.settings/\n.loadpath\n.fileTable*\n.cache\n\n# External tool builders\n.externalToolBuilders/\n\n# Locally stored \"Eclipse launch configurations\"\n*.launch\n\n# CDT-specific\n.cproject\n\n# PDT-specific\n.buildpath\n\n#log\n*.log\n*.log.*\n\n# Windows Thumbs.db\n*.db\n\n# OSX\n.DS_Store\n\n# sass gitignore#\n.sass-cache\n.idea\n\n# tcc_coverage\ncoverage.ec\n\n\n\nconfig.client.*\n\ntemp/\n*.pid\n*.orig\n\nhsf.configuration/\n\n# code coverage report\n*.ec\n\n#hsf test\n*.instance\n**/target\n.pmd\n**/.pmd\n"
},
{
"path": "eclipse-plugin/README.md",
"content": "# Eclipse Plugin\n---\n## Prepare\n- Eclipse Juno+ \n- maven3.+\n- JDK 1.7+\n\n## Build\n```\nmvn -U clean install\n```\n## [中文使用手册](README_cn.md)\n## Install\n1. Help >> Install New Software\nthen enter this update site URL [https://p3c.alibaba.com/plugin/eclipse/update](https://p3c.alibaba.com/plugin/eclipse/update)\n\n \n\n2. Follow the wizard, restart Eclipse to take effect after install success.\n\n## Use\n1. Switch language\n\n\t \n\n2. Code Analyze \n\n  \n \n  \n \n"
},
{
"path": "eclipse-plugin/README_cn.md",
"content": "> 首先非常感谢大家对插件的支持与意见，Eclipse的功能相对来说比较简单，希望有更多的同学加入进来一起完善。\n\n## 插件安装\n环境：JDK1.8，Eclipse4+。有同学遇到过这样的情况，安装插件重启后，发现没有对应的菜单项，从日志上也看不到相关的异常信息，最后把JDK从1.6升级到1.8解决问题。\n\nHelp -> Install New Software...\n\n\n\n输入Update Site地址：https://p3c.alibaba.com/plugin/eclipse/update 回车，然后勾选Ali-CodeAnalysis，再一直点Next Next...按提示走下去就好。 然后就是提示重启了，安装完毕。\n\n\n\n注意：有同学反映插件扫描会触发很多 \"JPA Java Change Event Handler (Waiting)\" 的任务，这个是Eclipse的一个[bug](https://bugs.eclipse.org/bugs/show_bug.cgi?id=387455)，因为插件在扫描的时候会对文件进行标记，所以触发了JPA的任务。卸载JPA插件，或者尝试升级到最新版的Eclipse。附：[JPA project Change Event Handler问题解决](https://my.oschina.net/cimu/blog/278724)\n\n\n## 插件使用\n\n目前插件实现了开发手册中的53条规则，大部分基于PMD实现，其中有4条规则基于Eclipse实现，支持4条规则的QuickFix功能。\n\n\t* 所有的覆写方法，必须加@Override注解， \n \t* if/for/while/switch/do等保留字与左右括号之间都必须加空格,\n \t* long或者Long初始赋值时，必须使用大写的L，不能是小写的l）\n \t* Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。\n \t\n目前不支持代码实时检测，需要手动触发，希望更多的人加入进来一起把咱们的插件做得越来越好，尽量提升研发的使用体验。\n\n \n### 代码扫描\n可以通过右键菜单、Toolbar按钮两种方式手动触发代码检测。同时结果面板中可以对部分实现了QuickFix功能的规则进行快速修复。\n\n#### 触发扫描\n在当前编辑的文件中点击右键，可以在弹出的菜单中触发对该文件的检测。\n\n\n\n\n在左侧的Project目录树种点击右键，可以触发对整个工程或者选择的某个目录、文件进行检测。 \n\n\n\n \n也可以通过Toolbar中的按钮来触发检测，目前Toolbar的按钮触发的检测范围与您IDE当时的焦点有关，如当前编辑的文件或者是Project目录树选中的项，是不是感觉与右键菜单的检测范围类似呢。 \n\n \n\n \n#### 扫描结果 \n简洁的结果面板，按规则等级分类，等级->规则->文件->违规项。同时还提供一个查看规则详情的界面。\n\n清除结果标记更方便，支持上面提到的4条规则QuickFix。\n\n\n\n#### 查看所有规则\n\n\n\n#### 国际化\n\n \n\n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.feature/build.properties",
"content": "bin.includes = feature.xml,\\\n feature.properties,\\\n smartfox.png\nsrc.includes = build.properties,\\\n feature.properties,\\\n feature.xml,\\\n smartfox.png\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.feature/feature.properties",
"content": "feature.label = Ali-CodeAnalysis\nfeature.provider_name = Alibaba\nfeature.update_site_name = Alibaba IDE Portal\n\ndescription.text = Alibaba Java Coding Guidelines\ndescription.url = https://github.com/alibaba/p3c\n\ncopyright.text =\\\nCopyright 2017 Alibaba Java Coding Guidelines\n\nlicense.url = https://github.com/alibaba/p3c\nlicense.text =\\\n Copyright 1999-2017 Alibaba Group. \\n\\\n \\n\\\n Licensed under the Apache License, Version 2.0 (the \"License\"); \\n\\\n you may not use this file except in compliance with the License. \\n\\\n You may obtain a copy of the License at \\n\\\n \\n\\\n http://www.apache.org/licenses/LICENSE-2.0 \\n\\\n \\n\\\n Unless required by applicable law or agreed to in writing, software \\n\\\n distributed under the License is distributed on an \"AS IS\" BASIS, \\n\\\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. \\n\\\n See the License for the specific language governing permissions and \\n\\\n limitations under the License. \\n\\\n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.feature/feature.xml",
"content": "\n\n\n \n Alibaba Java Coding Guidelines\n \n\n \n %copyright.text\n \n\n \n %license.text\n \n\n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.feature/pom.xml",
"content": "\n\n 4.0.0\n \n com.alibaba.smartfox.eclipse\n smartfox-eclipse\n 2.0.1-SNAPSHOT\n \n com.alibaba.smartfox.eclipse.feature\n eclipse-feature\n 2017\n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/META-INF/MANIFEST.MF",
"content": "Manifest-Version: 1.0\nBundle-ManifestVersion: 2\nBundle-Name: com.alibaba.smartfox.eclipse.plugin\nBundle-SymbolicName: com.alibaba.smartfox.eclipse.plugin;singleton:=true\nBundle-Version: 2.0.1.qualifier\nBundle-Activator: com.alibaba.smartfox.eclipse.SmartfoxActivator\nBundle-Vendor: Alibaba\nRequire-Bundle: org.eclipse.ui,\n org.eclipse.core.runtime,\n org.eclipse.jdt.core,\n org.eclipse.ui.ide,\n org.eclipse.ui.views,\n org.eclipse.core.resources,\n org.eclipse.jface.text,\n org.eclipse.ui.workbench.texteditor,\n org.eclipse.ltk.core.refactoring,\n org.eclipse.jdt.ui,\n org.eclipse.core.filebuffers,\n org.eclipse.equinox.p2.core,\n org.eclipse.equinox.p2.engine,\n org.eclipse.equinox.p2.operations,\n org.eclipse.equinox.p2.metadata.repository,\n org.eclipse.equinox.p2.ui,\n org.eclipse.equinox.p2.metadata\nBundle-RequiredExecutionEnvironment: JavaSE-1.8\nBundle-ActivationPolicy: lazy\nBundle-ClassPath: target/lib/antlr-runtime.jar,\n target/lib/antlr4-runtime.jar,\n target/lib/asm.jar,\n target/lib/commons-io.jar,\n target/lib/commons-lang3.jar,\n target/lib/gson.jar,\n target/lib/javacc.jar,\n target/lib/jaxen.jar,\n target/lib/jcommander.jar,\n target/lib/log4j.jar,\n target/lib/pmd-core.jar,\n target/lib/pmd-java.jar,\n target/lib/pmd-javascript.jar,\n target/lib/pmd-vm.jar,\n target/lib/rhino.jar,\n target/lib/saxon-dom.jar,\n target/lib/saxon.jar,\n target/lib/p3c-pmd.jar,\n target/lib/kotlin-stdlib.jar,\n target/lib/statistics-client.jar,\n target/lib/guava.jar,\n target/classes/,\n .\nBundle-Localization: plugin\nExport-Package: com.alibaba.smartfox.eclipse,\n com.alibaba.smartfox.eclipse.handler,\n com.alibaba.smartfox.eclipse.job,\n com.alibaba.smartfox.eclipse.marker,\n com.alibaba.smartfox.eclipse.pmd,\n com.alibaba.smartfox.eclipse.pmd.rule,\n com.alibaba.smartfox.eclipse.ui,\n com.alibaba.smartfox.eclipse.ui.pmd,\n com.alibaba.smartfox.eclipse.util\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/build.properties",
"content": "bin.includes = .,\\\n META-INF/,\\\n plugin.xml,\\\n icons/,\\\n target/lib/\nsrc.includes = icons/,\\\n META-INF/,\\\n plugin.xml,\\\n messages.properties,\\\n target/lib/,\\\n src/main/kotlin,\\\n pom.xml\nsource.. = src/main/java/,src/main/resources\noutput.. = target/classes/\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/plugin.xml",
"content": "\n\n\n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/pom.xml",
"content": "\n\n 4.0.0\n \n com.alibaba.smartfox.eclipse\n smartfox-eclipse\n 2.0.1-SNAPSHOT\n \n com.alibaba.smartfox.eclipse.plugin\n eclipse-plugin\n 2017\n \n false\n \n \n \n log4j\n log4j\n 1.2.17\n \n \n com.alibaba.p3c\n p3c-pmd\n 2.0.1\n \n \n org.jetbrains.kotlin\n kotlin-stdlib-jdk8\n \n \n com.google.guava\n guava\n 20.0\n \n \n \n src/main/kotlin\n \n \n org.jetbrains.kotlin\n kotlin-maven-plugin\n ${kotlin.version}\n\n \n \n compile\n compile\n \n compile\n \n \n\n \n test-compile\n test-compile\n \n test-compile\n \n \n \n \n \n org.apache.maven.plugins\n maven-dependency-plugin\n 3.1.1\n \n true\n false\n ${project.build.directory}/lib\n \n p2.eclipse-plugin,apex\n com.alibaba.smartfox.eclipse.plugin\n \n false\n \n \n \n get-dependencies\n process-sources\n \n copy-dependencies\n \n \n \n \n \n \n \n \n \n org.eclipse.m2e\n lifecycle-mapping\n 1.0.0\n \n \n \n \n \n \n org.apache.maven.plugins\n \n \n maven-dependency-plugin\n \n [0,)\n \n copy-dependencies\n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/QuickFix.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse\n\nimport com.alibaba.p3c.pmd.lang.java.rule.constant.UpperEllRule\nimport com.alibaba.p3c.pmd.lang.java.rule.oop.EqualsAvoidNullRule\nimport com.alibaba.smartfox.eclipse.ui.InspectionResults\nimport com.alibaba.smartfox.eclipse.util.getRule\nimport com.google.common.io.Files\nimport org.eclipse.core.resources.IFile\nimport org.eclipse.core.resources.IMarker\nimport org.eclipse.core.runtime.NullProgressMonitor\nimport org.eclipse.ltk.core.refactoring.TextFileChange\nimport org.eclipse.text.edits.ReplaceEdit\nimport org.eclipse.ui.IMarkerResolution\nimport org.eclipse.ui.IMarkerResolutionGenerator\nimport java.nio.charset.Charset\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/14\n */\nclass QuickFixGenerator : IMarkerResolutionGenerator {\n override fun getResolutions(marker: IMarker): Array {\n if (!marker.exists()) {\n return emptyArray()\n }\n val rule = marker.getRule()\n val quickFix = quickFixes[rule.name] ?: return emptyArray()\n return arrayOf(quickFix)\n }\n\n companion object {\n val quickFixes = mapOf(UpperEllRule::class.java.simpleName to UpperEllQuickFix,\n EqualsAvoidNullRule::class.java.simpleName to EqualsAvoidNullQuickFix)\n }\n}\n\ninterface RunWithoutViewRefresh : IMarkerResolution {\n fun run(marker: IMarker, refresh: Boolean)\n\n override fun run(marker: IMarker) {\n run(marker, true)\n }\n}\n\nabstract class BaseQuickFix : RunWithoutViewRefresh {\n override fun run(marker: IMarker, refresh: Boolean) {\n if (!marker.exists()) {\n return\n }\n val file = marker.resource as IFile\n doRun(marker, file)\n marker.delete()\n if (refresh) {\n InspectionResults.removeMarker(marker)\n }\n }\n\n abstract fun doRun(marker: IMarker, file: IFile)\n}\n\nobject UpperEllQuickFix : BaseQuickFix() {\n override fun doRun(marker: IMarker, file: IFile) {\n val offset = marker.getAttribute(IMarker.CHAR_START, 0)\n val end = marker.getAttribute(IMarker.CHAR_END, 0)\n val content = Files.toString(file.rawLocation.toFile(), Charset.forName(file.charset))\n val replaceString = content.substring(offset, end + 1).replace(\"l\", \"L\")\n val edit = ReplaceEdit(offset, replaceString.length, replaceString)\n val change = TextFileChange(\"\", file)\n change.edit = edit\n change.perform(NullProgressMonitor())\n }\n\n override fun getLabel(): String {\n return \"Replace 'l' to 'L'.\"\n }\n\n}\n\nobject EqualsAvoidNullQuickFix : BaseQuickFix() {\n val equalsName = \".equals(\"\n\n override fun doRun(marker: IMarker, file: IFile) {\n val offset = marker.getAttribute(IMarker.CHAR_START, 0)\n val end = marker.getAttribute(IMarker.CHAR_END, 0)\n val content = Files.toString(file.rawLocation.toFile(), Charset.forName(file.charset))\n val string = content.substring(offset, end)\n val list = string.split(equalsName).filterNotNull()\n if (list.size != 2) {\n return\n }\n val replace = \"${list[1].substringBeforeLast(')')}$equalsName${list[0]})\"\n val edit = ReplaceEdit(offset, string.length, replace)\n val change = TextFileChange(\"\", file)\n change.edit = edit\n change.perform(NullProgressMonitor())\n }\n\n override fun getLabel(): String {\n return \"Flip equals.\"\n }\n\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/SmartfoxActivator.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse\n\nimport com.alibaba.p3c.pmd.I18nResources\nimport net.sourceforge.pmd.Rule\nimport net.sourceforge.pmd.RuleSetFactory\nimport net.sourceforge.pmd.RuleSets\nimport org.apache.log4j.Logger\nimport org.eclipse.core.runtime.IStatus\nimport org.eclipse.core.runtime.Status\nimport org.eclipse.jface.dialogs.MessageDialog\nimport org.eclipse.jface.resource.ImageDescriptor\nimport org.eclipse.swt.graphics.Image\nimport org.eclipse.swt.widgets.Display\nimport org.eclipse.ui.plugin.AbstractUIPlugin\nimport org.osgi.framework.BundleContext\nimport java.util.Locale\n\n/**\n * @author caikang\n * @date 2017/06/14\n */\nclass SmartfoxActivator : AbstractUIPlugin() {\n\n init {\n aDefault = this\n }\n\n private val logger = Logger.getLogger(javaClass)!!\n lateinit var ruleSets: RuleSets\n private val localeKey = \"p3c.locale\"\n\n lateinit var ruleMap: Map\n\n @Throws(Exception::class) override fun start(context: BundleContext) {\n super.start(context)\n I18nResources.changeLanguage(locale)\n ruleSets = createRuleSets()\n ruleMap = ruleSets.allRules.associateBy {\n it.name\n }\n }\n\n @Throws(Exception::class) override fun stop(context: BundleContext?) {\n aDefault = null\n super.stop(context)\n }\n\n\n fun getImage(key: String, iconPath: String = key): Image {\n val registry = imageRegistry\n var image: Image? = registry.get(key)\n if (image == null) {\n val descriptor = getImageDescriptor(iconPath)\n registry.put(key, descriptor)\n image = registry.get(key)\n }\n\n return image!!\n }\n\n val locale: String\n get() {\n val language = preferenceStore.getString(localeKey)\n if (language.isNullOrBlank()) {\n val lang = Locale.getDefault().language\n return if (lang != Locale.ENGLISH.language && lang != Locale.CHINESE.language) {\n Locale.ENGLISH.language\n } else Locale.getDefault().language\n }\n\n return language\n }\n\n fun toggleLocale() {\n val lang = if (Locale.ENGLISH.language == locale) Locale.CHINESE.language else Locale.ENGLISH.language\n preferenceStore.setValue(localeKey, lang)\n }\n\n fun getRule(rule: String): Rule {\n return ruleMap[rule]!!\n }\n\n fun showError(message: String, t: Throwable) {\n logError(message, t)\n Display.getDefault().syncExec {\n MessageDialog.openError(Display.getCurrent().activeShell, \"错误\", message + \"\\n\" + t.toString())\n }\n }\n\n fun logError(message: String, t: Throwable) {\n log.log(Status(IStatus.ERROR, bundle.symbolicName, 0, message + t.message, t))\n logger.error(message, t)\n }\n\n fun logError(status: IStatus) {\n log.log(status)\n logger.error(status.message, status.exception)\n }\n\n fun logInformation(message: String) {\n log.log(Status(IStatus.INFO, bundle.symbolicName, 0, message, null))\n }\n\n fun logWarn(message: String) {\n log.log(Status(IStatus.WARNING, bundle.symbolicName, 0, message, null))\n }\n\n companion object {\n // The plug-in ID\n val PLUGIN_ID = \"com.alibaba.smartfox.eclipse.plugin\"\n\n var aDefault: SmartfoxActivator? = null\n private set\n\n val instance: SmartfoxActivator get() = aDefault!!\n\n fun getImageDescriptor(path: String): ImageDescriptor {\n return AbstractUIPlugin.imageDescriptorFromPlugin(PLUGIN_ID, path)\n }\n\n fun createRuleSets(): RuleSets {\n val ruleSetFactory = RuleSetFactory()\n return ruleSetFactory.createRuleSets(\"java-ali-pmd,vm-ali-other\")\n }\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/handler/CodeAnalysisHandler.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.handler\n\nimport com.alibaba.smartfox.eclipse.job.CodeAnalysis.processResources\nimport com.alibaba.smartfox.eclipse.message.P3cBundle\nimport com.google.common.collect.Sets\nimport org.apache.log4j.Logger\nimport org.eclipse.core.commands.AbstractHandler\nimport org.eclipse.core.commands.ExecutionEvent\nimport org.eclipse.core.commands.ExecutionException\nimport org.eclipse.core.resources.IFile\nimport org.eclipse.core.resources.IResource\nimport org.eclipse.core.resources.IResourceVisitor\nimport org.eclipse.core.runtime.IAdaptable\nimport org.eclipse.jface.viewers.IStructuredSelection\nimport org.eclipse.ui.IFileEditorInput\nimport org.eclipse.ui.IWorkingSet\nimport org.eclipse.ui.commands.IElementUpdater\nimport org.eclipse.ui.handlers.HandlerUtil\nimport org.eclipse.ui.menus.UIElement\nimport org.eclipse.ui.part.EditorPart\nimport org.eclipse.ui.part.ViewPart\n\n/**\n * @author caikang\n * @date 2016/12/27\n */\nopen class CodeAnalysisHandler : AbstractHandler(), IElementUpdater {\n override fun updateElement(element: UIElement, parameters: MutableMap?) {\n val text = P3cBundle.getMessage(\"com.alibaba.smartfox.eclipse.handler.CodeAnalysisHandler\")\n element.setText(text)\n element.setTooltip(text)\n }\n\n @Throws(ExecutionException::class)\n override fun execute(executionEvent: ExecutionEvent): Any? {\n val selection = HandlerUtil.getCurrentSelectionChecked(executionEvent)\n val part = HandlerUtil.getActivePart(executionEvent)\n if (part is ViewPart) {\n if (selection is IStructuredSelection) {\n processForMutiFiles(selection)\n }\n } else if (part is EditorPart) {\n val editorInput = HandlerUtil.getActiveEditorInput(executionEvent)\n if (editorInput is IFileEditorInput) {\n processResources(setOf(editorInput.file))\n }\n }\n return null\n }\n\n private fun processForMutiFiles(selection: IStructuredSelection) {\n val resources = getSelectionResources(selection)\n processResources(resources)\n }\n\n private fun getSelectionResources(selection: IStructuredSelection): MutableSet {\n val resources = mutableSetOf()\n selection.toList().forEach {\n when (it) {\n is IWorkingSet -> it.elements.mapTo(resources) { it.getAdapter(IResource::class.java) as IResource }\n is IAdaptable -> {\n val file = it.getAdapter(IResource::class.java) as? IResource ?: return@forEach\n resources.add(file)\n }\n else -> log.warn(\"The selected object is not adaptable : ${it.toString()}\")\n }\n }\n return resources\n }\n\n\n companion object {\n private val log = Logger.getLogger(CodeAnalysisHandler::class.java)\n }\n}\n\nclass FileCollectVisitor : IResourceVisitor {\n val fileSet = Sets.newLinkedHashSet()!!\n\n override fun visit(resource: IResource?): Boolean {\n if (resource == null) {\n return false\n }\n val file = resource.getAdapter(IFile::class.java) as? IFile ?: return true\n if (file.exists() && (file.fileExtension == \"java\" || file.fileExtension == \"vm\")) {\n fileSet.add(file)\n }\n return false\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/handler/SwitchLanguageHandler.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.handler\n\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport com.alibaba.smartfox.eclipse.message.P3cBundle\nimport org.eclipse.core.commands.AbstractHandler\nimport org.eclipse.core.commands.ExecutionEvent\nimport org.eclipse.jface.dialogs.MessageDialog\nimport org.eclipse.ui.PlatformUI\nimport org.eclipse.ui.commands.IElementUpdater\nimport org.eclipse.ui.menus.UIElement\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/21\n */\nclass SwitchLanguageHandler : AbstractHandler(), IElementUpdater {\n val handlerKey = \"com.alibaba.smartfox.eclipse.handler.SwitchLanguageHandler\"\n val textKey = \"$handlerKey.text.cur_\"\n\n override fun execute(executionEvent: ExecutionEvent): Any? {\n SmartfoxActivator.instance.toggleLocale()\n if (!MessageDialog.openConfirm(null, \"Tips\",\n P3cBundle.getMessage(\"$handlerKey.success.${SmartfoxActivator.instance.locale}\"))) {\n return null\n }\n PlatformUI.getWorkbench().restart()\n return null\n }\n\n override fun updateElement(element: UIElement, parameters: MutableMap?) {\n val text = P3cBundle.getMessage(\"$textKey${SmartfoxActivator.instance.locale}\")\n element.setText(text)\n element.setTooltip(text)\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/job/CodeAnalysis.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.job\n\nimport com.alibaba.p3c.pmd.lang.java.util.GeneratedCodeUtils\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport com.alibaba.smartfox.eclipse.handler.CodeAnalysisHandler\nimport com.alibaba.smartfox.eclipse.handler.FileCollectVisitor\nimport com.alibaba.smartfox.eclipse.ui.InspectionResultView\nimport com.alibaba.smartfox.eclipse.ui.InspectionResults\nimport com.alibaba.smartfox.eclipse.ui.MarkerViolation\nimport com.alibaba.smartfox.eclipse.util.MarkerUtil\nimport com.google.common.io.Files\nimport net.sourceforge.pmd.PMDConfiguration\nimport net.sourceforge.pmd.PMDException\nimport net.sourceforge.pmd.Report\nimport net.sourceforge.pmd.RuleContext\nimport net.sourceforge.pmd.RuleViolation\nimport net.sourceforge.pmd.SourceCodeProcessor\nimport org.apache.log4j.Logger\nimport org.eclipse.core.resources.IFile\nimport org.eclipse.core.resources.IResource\nimport org.eclipse.core.runtime.IProgressMonitor\nimport org.eclipse.core.runtime.IStatus\nimport org.eclipse.core.runtime.Status\nimport org.eclipse.core.runtime.SubMonitor\nimport org.eclipse.core.runtime.jobs.Job\nimport java.io.IOException\nimport java.io.StringReader\nimport java.nio.charset.Charset\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/14\n */\nobject CodeAnalysis {\n private val log = Logger.getLogger(CodeAnalysisHandler::class.java)\n\n fun processResources(resources: Set) {\n InspectionResultView.activeViews()\n val job = object : Job(\"P3C Code Analysis\") {\n override fun run(monitor: IProgressMonitor): IStatus {\n val fileVisitor = FileCollectVisitor()\n monitor.setTaskName(\"Collect files\")\n resources.forEach {\n if (monitor.isCanceled) {\n return@run Status.CANCEL_STATUS\n }\n if (it.isAccessible) {\n it.accept(fileVisitor)\n }\n }\n if (monitor.isCanceled) {\n return Status.CANCEL_STATUS\n }\n val subMonitor = SubMonitor.convert(monitor, \"Analysis files\", fileVisitor.fileSet.size)\n monitor.setTaskName(\"Analysis files\")\n fileVisitor.fileSet.forEach { iFile ->\n if (monitor.isCanceled) {\n return@run Status.CANCEL_STATUS\n }\n MarkerUtil.removeAllMarkers(iFile)\n monitor.subTask(iFile.fullPath.toPortableString())\n val markers = processFileToMakers(iFile, monitor)\n subMonitor.newChild(1)\n InspectionResults.updateFileViolations(iFile, markers)\n }\n return Status.OK_STATUS\n }\n }\n job.apply {\n isUser = true\n isSystem = false\n priority = Job.INTERACTIVE\n rule = P3cMutex\n schedule()\n }\n }\n\n fun processFileToMakers(file: IFile, monitor: IProgressMonitor): List {\n file.refreshLocal(IResource.DEPTH_ZERO, monitor)\n val ruleViolations = processFile(file)\n\n MarkerUtil.removeAllMarkers(file)\n return ruleViolations.map {\n MarkerViolation(MarkerUtil.addMarker(file, it), it)\n }\n }\n\n private fun processFile(file: IFile): List {\n val configuration = PMDConfiguration()\n configuration.setSourceEncoding(file.charset ?: Charsets.UTF_8.name())\n configuration.inputPaths = file.fullPath.toPortableString()\n val ctx = RuleContext()\n ctx.setAttribute(\"eclipseFile\", file)\n val niceFileName = configuration.inputPaths\n val report = Report.createReport(ctx, niceFileName)\n SmartfoxActivator.instance.ruleSets.start(ctx)\n val processor = SourceCodeProcessor(configuration)\n try {\n ctx.languageVersion = null\n val content = Files.toString(file.rawLocation.toFile(), Charset.forName(file.charset))\n if (!GeneratedCodeUtils.isGenerated(content)) {\n processor.processSourceCode(StringReader(content), SmartfoxActivator.instance.ruleSets, ctx)\n }\n } catch (pmde: PMDException) {\n log.debug(\"Error while processing file: \" + niceFileName, pmde.cause)\n report.addError(Report.ProcessingError(pmde, niceFileName))\n } catch (ioe: IOException) {\n log.error(\"Unable to read source file: \" + niceFileName, ioe)\n } catch (re: RuntimeException) {\n log.error(\"RuntimeException while processing file: \" + niceFileName, re)\n } finally {\n SmartfoxActivator.instance.ruleSets.end(ctx)\n }\n return report.toList()\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/job/P3cMutex.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.job\n\nimport org.eclipse.core.runtime.jobs.ISchedulingRule\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/14\n */\nobject P3cMutex : ISchedulingRule {\n override fun contains(rule: ISchedulingRule?): Boolean {\n return isConflicting(rule)\n }\n\n override fun isConflicting(rule: ISchedulingRule?): Boolean {\n return rule == this\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/message/P3cBundle.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.message\n\n\nimport com.alibaba.p3c.pmd.I18nResources\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport java.util.Locale\nimport java.util.ResourceBundle\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/20\n */\nobject P3cBundle {\n private val resourceBundle = ResourceBundle.getBundle(\"messages.P3cBundle\",\n Locale(SmartfoxActivator.instance.locale), I18nResources.XmlControl())\n\n fun getMessage(key: String): String {\n return resourceBundle.getString(key)\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/pmd/RulePriority.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.pmd\n\nenum class RulePriority(val priority: Int, val title: String) {\n\n Blocker(1, \"Blocker\"), Critical(2, \"Critical\"), Major(3, \"Major\");\n\n override fun toString(): String {\n return title\n }\n\n companion object {\n fun valueOf(priority: Int): RulePriority {\n try {\n return RulePriority.values()[priority - 1]\n } catch (e: ArrayIndexOutOfBoundsException) {\n return Major\n }\n }\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/pmd/rule/AbstractEclipseRule.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.pmd.rule\n\nimport com.alibaba.smartfox.eclipse.message.P3cBundle\nimport net.sourceforge.pmd.Rule\nimport net.sourceforge.pmd.RuleContext\nimport net.sourceforge.pmd.RuleViolation\nimport net.sourceforge.pmd.lang.java.ast.ASTCompilationUnit\nimport net.sourceforge.pmd.lang.java.rule.AbstractJavaRule\nimport org.eclipse.core.resources.IFile\nimport org.eclipse.core.runtime.NullProgressMonitor\nimport org.eclipse.jdt.core.ICompilationUnit\nimport org.eclipse.jdt.core.IProblemRequestor\nimport org.eclipse.jdt.core.JavaCore\nimport org.eclipse.jdt.core.JavaModelException\nimport org.eclipse.jdt.core.WorkingCopyOwner\nimport org.eclipse.jdt.core.compiler.IProblem\nimport org.eclipse.jdt.core.dom.ASTNode\nimport org.eclipse.jdt.core.dom.ASTVisitor\nimport org.eclipse.jdt.core.dom.CompilationUnit\nimport java.util.MissingResourceException\n\n/**\n * @author caikang\n * @date 2016/12/26\n */\nabstract class AbstractEclipseRule : AbstractJavaRule() {\n\n open fun getErrorMessage(): String {\n return message\n }\n\n override fun visit(node: ASTCompilationUnit, data: Any): Any? {\n val result = super.visit(node, data)\n val ruleContext = data as RuleContext\n val file = ruleContext.getAttribute(\"eclipseFile\") as? IFile ?: return result\n val compilationUnit = JavaCore.createCompilationUnitFrom(file) ?: return data\n try {\n val requestor = object : IProblemRequestor {\n override fun acceptProblem(problem: IProblem) {}\n\n override fun beginReporting() {}\n\n override fun endReporting() {}\n\n override fun isActive(): Boolean {\n return true\n }\n }\n val workingCopy = compilationUnit.getWorkingCopy(null)\n val ast = workingCopy.reconcile(JLS8, ICompilationUnit.FORCE_PROBLEM_DETECTION\n or ICompilationUnit.ENABLE_BINDINGS_RECOVERY or ICompilationUnit.ENABLE_STATEMENTS_RECOVERY,\n object : WorkingCopyOwner() {\n override fun getProblemRequestor(workingCopy: ICompilationUnit?): IProblemRequestor {\n return requestor\n }\n }, NullProgressMonitor()) ?: return data\n ast.accept(getVisitor(ast, ruleContext))\n\n } catch (e: JavaModelException) {\n throw RuntimeException(e)\n }\n\n return data\n }\n\n override fun setDescription(description: String?) {\n try {\n super.setDescription(P3cBundle.getMessage(description ?: \"\"))\n } catch (e: MissingResourceException) {\n super.setMessage(description)\n }\n\n }\n\n override fun setMessage(message: String) {\n try {\n super.setMessage(P3cBundle.getMessage(message))\n } catch (e: MissingResourceException) {\n super.setMessage(message)\n }\n\n }\n\n\n protected abstract fun getVisitor(ast: CompilationUnit, ruleContext: RuleContext): ASTVisitor\n\n internal fun addRuleViolation(ruleContext: RuleContext, ast: CompilationUnit, nodeInfo: NodeInfo) {\n val rule = this\n val ruleViolation = object : RuleViolation {\n override fun getRule(): Rule {\n return rule\n }\n\n override fun getDescription(): String {\n return getErrorMessage().trim { it <= ' ' }\n }\n\n override fun isSuppressed(): Boolean {\n return false\n }\n\n override fun getFilename(): String {\n return ruleContext.sourceCodeFilename\n }\n\n override fun getBeginLine(): Int {\n return ast.getLineNumber(nodeInfo.startPosition)\n }\n\n override fun getBeginColumn(): Int {\n return ast.getColumnNumber(nodeInfo.startPosition)\n }\n\n override fun getEndLine(): Int {\n return ast.getLineNumber(nodeInfo.endPosition)\n }\n\n override fun getEndColumn(): Int {\n return ast.getColumnNumber(nodeInfo.endPosition)\n }\n\n override fun getPackageName(): String? {\n return nodeInfo.packageName\n }\n\n override fun getClassName(): String? {\n return nodeInfo.className\n }\n\n override fun getMethodName(): String? {\n return nodeInfo.methodName\n }\n\n override fun getVariableName(): String? {\n return nodeInfo.variableName\n }\n\n override fun toString(): String {\n return rule.toString()\n }\n\n\n }\n\n ruleContext.report.addRuleViolation(ruleViolation)\n }\n\n protected fun violation(rc: RuleContext, node: ASTNode, ast: CompilationUnit) {\n val nodeInfo = NodeInfo()\n nodeInfo.className = ast.javaElement.elementName\n nodeInfo.packageName = ast.`package`.name.fullyQualifiedName\n nodeInfo.startPosition = node.startPosition\n nodeInfo.endPosition = node.startPosition + node.length\n\n addRuleViolation(rc, ast, nodeInfo)\n }\n\n inner class NodeInfo {\n internal var packageName: String? = null\n internal var className: String? = null\n internal var methodName: String? = null\n internal var variableName: String? = null\n internal var startPosition: Int = 0\n internal var endPosition: Int = 0\n }\n\n companion object {\n val JLS8 = 8\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/pmd/rule/AvoidAccessStaticViaInstanceRule.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.pmd.rule\n\nimport net.sourceforge.pmd.RuleContext\nimport org.eclipse.jdt.core.dom.ASTVisitor\nimport org.eclipse.jdt.core.dom.ClassInstanceCreation\nimport org.eclipse.jdt.core.dom.CompilationUnit\nimport org.eclipse.jdt.core.dom.FieldAccess\nimport org.eclipse.jdt.core.dom.IVariableBinding\nimport org.eclipse.jdt.core.dom.MethodInvocation\nimport org.eclipse.jdt.core.dom.Modifier\nimport org.eclipse.jdt.core.dom.QualifiedName\nimport org.eclipse.jdt.core.dom.SimpleName\nimport org.eclipse.jdt.core.dom.VariableDeclarationFragment\n\n/**\n * @author caikang\n * @date 2016/12/27\n */\nclass AvoidAccessStaticViaInstanceRule : AbstractEclipseRule() {\n override fun getVisitor(ast: CompilationUnit, ruleContext: RuleContext): ASTVisitor {\n return object : ASTVisitor() {\n override fun visit(node: QualifiedName?): Boolean {\n val parent = node!!.parent\n if (parent !is MethodInvocation && parent !is VariableDeclarationFragment) {\n return false\n }\n val name = node.name\n val binding = name.resolveBinding()\n if (binding !is IVariableBinding || binding.getModifiers() and Modifier.STATIC == 0) {\n return true\n }\n val qualifier = node.qualifier\n val typeBinding = qualifier.resolveTypeBinding()\n if (qualifier.isSimpleName) {\n when (parent) {\n is MethodInvocation -> {\n val methodBinding = parent.resolveMethodBinding()\n val methodTypeBinding = methodBinding.declaringClass\n if (methodBinding.modifiers and Modifier.STATIC != 0\n && qualifier.fullyQualifiedName != methodTypeBinding.name\n && methodTypeBinding == typeBinding && binding.name != typeBinding.name) {\n violation(ruleContext, parent, ast)\n return false\n }\n }\n else -> {\n }\n }\n if (typeBinding.name != qualifier.fullyQualifiedName) {\n violation(ruleContext, node, ast)\n return false\n }\n }\n if (qualifier.isQualifiedName) {\n val qualifiedName = qualifier as QualifiedName\n if (typeBinding.name != qualifiedName.name.identifier) {\n violation(ruleContext, node, ast)\n return false\n }\n }\n return true\n }\n\n override fun visit(node: FieldAccess): Boolean {\n val variableBinding = node.resolveFieldBinding() ?: return false\n if (variableBinding.modifiers and Modifier.STATIC == 0) {\n return true\n }\n if (node.expression is ClassInstanceCreation) {\n violation(ruleContext, node, ast)\n return true\n }\n return true\n }\n\n override fun visit(node: MethodInvocation?): Boolean {\n val methodBinding = node?.resolveMethodBinding() ?: return false\n if (methodBinding.modifiers and Modifier.STATIC == 0) {\n return true\n }\n if (node.expression is ClassInstanceCreation) {\n violation(ruleContext, node, ast)\n return true\n }\n val expression = node.expression\n if (expression is SimpleName && expression.identifier != expression.resolveTypeBinding().name) {\n violation(ruleContext, node, ast)\n return true\n }\n return true\n }\n }\n }\n\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/pmd/rule/AvoidUseDeprecationRule.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.pmd.rule\n\nimport net.sourceforge.pmd.RuleContext\nimport org.eclipse.jdt.core.dom.ASTVisitor\nimport org.eclipse.jdt.core.dom.ClassInstanceCreation\nimport org.eclipse.jdt.core.dom.CompilationUnit\nimport org.eclipse.jdt.core.dom.FieldAccess\nimport org.eclipse.jdt.core.dom.IVariableBinding\nimport org.eclipse.jdt.core.dom.ImportDeclaration\nimport org.eclipse.jdt.core.dom.MethodInvocation\nimport org.eclipse.jdt.core.dom.Modifier\nimport org.eclipse.jdt.core.dom.QualifiedName\nimport org.eclipse.jdt.core.dom.TypeDeclaration\nimport org.eclipse.jdt.core.dom.VariableDeclarationFragment\n\n/**\n * @author caikang\n * @date 2016/12/27\n */\nclass AvoidUseDeprecationRule : AbstractEclipseRule() {\n override fun getVisitor(ast: CompilationUnit, ruleContext: RuleContext): ASTVisitor {\n return object : ASTVisitor() {\n override fun visit(node: ImportDeclaration?): Boolean {\n if (node!!.resolveBinding() != null && node.resolveBinding().isDeprecated) {\n violation(ruleContext, node, ast)\n }\n return true\n }\n\n override fun visit(node: QualifiedName?): Boolean {\n if (node!!.parent !is MethodInvocation && node.parent !is VariableDeclarationFragment) {\n return false\n }\n val name = node.name\n val binding = name.resolveBinding()\n if (binding !is IVariableBinding || binding.getModifiers() and Modifier.STATIC == 0) {\n return true\n }\n if (binding.isDeprecated()) {\n violation(ruleContext, node, ast)\n return false\n }\n val qualifier = node.qualifier\n val typeBinding = qualifier.resolveTypeBinding()\n if (typeBinding.isDeprecated) {\n violation(ruleContext, node, ast)\n return false\n }\n return true\n }\n\n override fun visit(node: TypeDeclaration?): Boolean {\n val superClass = node!!.superclassType\n if (superClass != null && superClass.resolveBinding().isDeprecated) {\n violation(ruleContext, node, ast)\n return true\n }\n val interfaces = node.resolveBinding().interfaces\n for (tb in interfaces) {\n if (tb.isDeprecated) {\n violation(ruleContext, node, ast)\n return true\n }\n }\n return true\n }\n\n override fun visit(node: FieldAccess?): Boolean {\n val variableBinding = node!!.resolveFieldBinding() ?: return false\n if (variableBinding.isDeprecated) {\n violation(ruleContext, node, ast)\n }\n return true\n }\n\n override fun visit(node: MethodInvocation): Boolean {\n val methodBinding = node.resolveMethodBinding() ?: return false\n if (methodBinding.isDeprecated) {\n violation(ruleContext, node, ast)\n }\n return true\n }\n\n override fun visit(node: ClassInstanceCreation?): Boolean {\n if (node!!.resolveTypeBinding().isDeprecated) {\n violation(ruleContext, node, ast)\n }\n return true\n }\n }\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/pmd/rule/MapOrSetKeyShouldOverrideHashCodeEqualsRule.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.pmd.rule\n\nimport net.sourceforge.pmd.RuleContext\nimport org.eclipse.jdt.core.dom.ASTVisitor\nimport org.eclipse.jdt.core.dom.CompilationUnit\nimport org.eclipse.jdt.core.dom.ITypeBinding\nimport org.eclipse.jdt.core.dom.MethodInvocation\nimport org.eclipse.jdt.core.dom.VariableDeclarationStatement\n\n/**\n * @author zenghou.fw\n * @date 2016/12/27\n */\nclass MapOrSetKeyShouldOverrideHashCodeEqualsRule : AbstractEclipseRule() {\n\n val methodEquals = \"equals\"\n val methodHashCode = \"hashCode\"\n val methodAdd = \"add\"\n val methodPut = \"put\"\n\n private val skipJdkPackageJava = \"java.\"\n private val skipJdkPackageJavax = \"javax.\"\n\n override fun getVisitor(ast: CompilationUnit, ruleContext: RuleContext): ASTVisitor {\n return object : ASTVisitor() {\n\n override fun visit(node: VariableDeclarationStatement): Boolean {\n if (!node.type.isParameterizedType) {\n return true\n }\n val typeBinding = node.type.resolveBinding()\n if (isSet(typeBinding) || isMap(typeBinding)) {\n val argumentTypes = typeBinding.typeArguments\n if (argumentTypes != null && argumentTypes.isNotEmpty()) {\n if (!isOverrideEqualsAndHashCode(argumentTypes[0])) {\n violation(ruleContext, node, ast)\n return false\n }\n }\n }\n return true\n }\n\n override fun visit(node: MethodInvocation): Boolean {\n val methodBinding = node.resolveMethodBinding() ?: return false\n val callerType = methodBinding.declaringClass\n\n if (methodAdd == methodBinding.name) {\n if (!isSet(callerType)) {\n return true\n }\n val parameterTypes = methodBinding.parameterTypes\n if (parameterTypes != null && parameterTypes.isNotEmpty()) {\n if (!isOverrideEqualsAndHashCode(parameterTypes[0])) {\n violation(ruleContext, node, ast)\n return false\n }\n }\n return true\n }\n if (methodPut == methodBinding.name) {\n if (!isMap(callerType)) {\n return true\n }\n val parameterTypes = methodBinding.parameterTypes\n if (parameterTypes != null && parameterTypes.isNotEmpty()) {\n if (!isOverrideEqualsAndHashCode(parameterTypes[0])) {\n violation(ruleContext, node, ast)\n return false\n }\n }\n }\n return true\n }\n\n private fun isOverrideEqualsAndHashCode(genericType: ITypeBinding): Boolean {\n val skip = genericType.isEnum || genericType.isInterface || genericType.isArray\n || genericType.isTypeVariable || genericType.isWildcardType\n || genericType.qualifiedName?.startsWith(skipJdkPackageJava) ?: false\n || genericType.qualifiedName?.startsWith(skipJdkPackageJavax) ?: false\n // skip\n if (skip) {\n return true\n }\n\n val methodBindings = genericType.declaredMethods ?: return false\n\n val overrideCount = methodBindings.asSequence().filter {\n //find equals(Object o) and hashCode() with @Override\n methodEquals == it.name || methodHashCode == it.name\n }.filter {\n when (it.name) {\n methodEquals -> {\n val parameterTypes = it.parameterTypes\n parameterTypes != null && parameterTypes.isNotEmpty()\n && Object::class.java.name == parameterTypes[0].qualifiedName\n }\n methodHashCode -> {\n val parameterTypes = it.parameterTypes\n parameterTypes == null || parameterTypes.isEmpty()\n }\n else -> false\n }\n }.count()\n return overrideCount == 2\n }\n\n private fun isSet(typeBinding: ITypeBinding): Boolean {\n return java.util.Set::class.java.name == typeBinding.binaryName\n }\n\n private fun isMap(typeBinding: ITypeBinding): Boolean {\n return java.util.Map::class.java.name == typeBinding.binaryName\n }\n }\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/pmd/rule/MissingOverrideAnnotationRule.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.pmd.rule\n\nimport com.alibaba.smartfox.eclipse.message.P3cBundle\nimport net.sourceforge.pmd.RuleContext\nimport org.eclipse.jdt.core.dom.ASTVisitor\nimport org.eclipse.jdt.core.dom.CompilationUnit\nimport org.eclipse.jdt.core.dom.MethodDeclaration\nimport org.eclipse.jdt.internal.compiler.lookup.MethodBinding\nimport java.util.Arrays\nimport javax.annotation.Generated\n\n/**\n * @author caikang\n * @date 2016/12/24\n */\nclass MissingOverrideAnnotationRule : AbstractEclipseRule() {\n override fun getErrorMessage(): String {\n return P3cBundle.getMessage(\"rule.standalone.MissingOverrideAnnotationRule.error\")\n }\n\n override fun getVisitor(ast: CompilationUnit, ruleContext: RuleContext): ASTVisitor {\n return MissingOverrideVisitor(ast, ruleContext)\n }\n\n private inner class MissingOverrideVisitor(private val ast: CompilationUnit,\n private val ruleContext: RuleContext) : ASTVisitor() {\n\n override fun visit(node: MethodDeclaration?): Boolean {\n val methodBinding = node!!.resolveBinding()\n val declaringClass = methodBinding.declaringClass ?: return super.visit(node)\n if (declaringClass.isInterface) {\n return super.visit(node)\n }\n val abs = methodBinding.annotations\n if (abs.any {\n Override::class.java.canonicalName == it.annotationType.binaryName\n }) {\n return super.visit(node)\n }\n try {\n val field = methodBinding.javaClass.getDeclaredField(\"binding\")\n field.isAccessible = true\n val internalBinding = field.get(methodBinding) as MethodBinding\n if (internalBinding.isStatic || !(internalBinding.isImplementing || internalBinding.isOverriding)\n || isGenerated(internalBinding)) {\n return super.visit(node)\n }\n violation(ruleContext, node, ast)\n } catch (e: Exception) {\n e.printStackTrace()\n }\n\n return super.visit(node)\n }\n\n /**\n * skip @Override check for generated code by lombok\n * @param internalBinding\n * @return\n */\n private fun isGenerated(internalBinding: MethodBinding): Boolean {\n val annotationBindings = internalBinding.annotations ?: return false\n return annotationBindings.any {\n it.annotationType != null && Arrays.equals(Generated::class.java.name.toCharArray(),\n it.annotationType.readableName())\n }\n }\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/AllRulesPreferencePage.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport org.eclipse.jface.preference.PreferencePage\nimport org.eclipse.swt.widgets.Composite\nimport org.eclipse.swt.widgets.Control\nimport org.eclipse.ui.IWorkbench\nimport org.eclipse.ui.IWorkbenchPreferencePage\n\n/**\n *\n * @author caikang\n * @date 2017/09/01\n */\nclass AllRulesPreferencePage : PreferencePage(), IWorkbenchPreferencePage {\n override fun init(parent: IWorkbench?) {\n }\n\n override fun createContents(parent: Composite): Control {\n return AllRulesView(parent).content\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/AllRulesView.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport org.eclipse.swt.SWT\nimport org.eclipse.swt.layout.FillLayout\nimport org.eclipse.swt.widgets.Composite\nimport org.eclipse.swt.widgets.List\n\n\n/**\n *\n * @author caikang\n * @date 2017/09/01\n */\nclass AllRulesView(parent: Composite) {\n val content = Composite(parent, SWT.NONE)\n\n private val ruleList = SmartfoxActivator.instance.ruleSets.allRules.toList()\n\n init {\n content.layout = FillLayout()\n val list = List(content, SWT.BORDER or SWT.SINGLE or SWT.V_SCROLL or SWT.PUSH or SWT.H_SCROLL)\n ruleList.forEach {\n list.add(it.message)\n }\n val ruleDetail = RuleDetailComposite(content, SWT.PUSH)\n list.addListener(SWT.Selection) {\n val index = list.selectionIndex\n val rule = ruleList.getOrNull(index) ?: return@addListener\n ruleDetail.refresh(rule)\n }\n list.select(0)\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/InspectionResultTreeContentProvider.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport org.eclipse.jface.viewers.ITreeContentProvider\nimport org.eclipse.jface.viewers.Viewer\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/08\n */\nobject InspectionResultTreeContentProvider : ITreeContentProvider {\n private lateinit var input: InspectionResults\n\n override fun getParent(element: Any?): Any {\n return input\n }\n\n override fun hasChildren(element: Any?): Boolean {\n return element is InspectionResults || element is LevelViolations || element is RuleViolations\n || element is FileMarkers\n }\n\n override fun getChildren(parentElement: Any?): Array {\n if (parentElement is InspectionResults) {\n return parentElement.errors.toTypedArray()\n }\n if (parentElement is LevelViolations) {\n return parentElement.rules.toTypedArray()\n }\n if (parentElement is RuleViolations) {\n return parentElement.files.toTypedArray()\n }\n if (parentElement is FileMarkers) {\n return parentElement.markers.toTypedArray()\n }\n return emptyArray()\n }\n\n override fun getElements(inputElement: Any?): Array {\n return input.errors.toTypedArray()\n }\n\n override fun inputChanged(viewer: Viewer?, oldInput: Any?, newInput: Any?) {\n if (newInput == null) {\n return\n }\n this.input = newInput as InspectionResults\n }\n\n override fun dispose() {\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/InspectionResultTreeLabelProvider.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport com.alibaba.smartfox.eclipse.pmd.RulePriority\nimport org.eclipse.jface.viewers.LabelProvider\nimport org.eclipse.swt.graphics.Image\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/08\n */\nobject InspectionResultTreeLabelProvider : LabelProvider() {\n override fun getImage(element: Any?): Image? {\n if (element is LevelViolations) {\n val imageName = when (element.level) {\n RulePriority.Blocker.title, RulePriority.Critical.title -> \"${element.level}.gif\".toLowerCase()\n else -> \"${element.level}.png\".toLowerCase()\n }\n return SmartfoxActivator.instance.getImage(\"icons/view/$imageName\")\n }\n if (element is FileMarkers) {\n if (element.file.fullPath.toPortableString().endsWith(\"java\")) {\n return SmartfoxActivator.instance.getImage(\"icons/view/class_obj.png\")\n }\n return SmartfoxActivator.instance.getImage(\"icons/view/file_obj.png\")\n }\n return null\n }\n\n override fun getText(element: Any?): String {\n if (element is LevelViolations) {\n return \"${element.level} (${element.count} Violations)\"\n }\n if (element is RuleViolations) {\n val rule = SmartfoxActivator.instance.getRule(element.rule)\n return \"${rule.message} (${element.count} Violations)\"\n }\n if (element is FileMarkers) {\n return element.file.fullPath.toPortableString().substringAfterLast(\"/\") +\n \" (${element.markers.size} Violations)\"\n }\n if (element is MarkerViolation) {\n val desc = element.violation.description\n return \"$desc (at line ${element.violation.beginLine})\"\n }\n return element.toString()\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/InspectionResultView.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport com.alibaba.smartfox.eclipse.job.P3cMutex\nimport com.alibaba.smartfox.eclipse.util.MarkerUtil\nimport org.eclipse.core.resources.IFile\nimport org.eclipse.core.resources.IMarker\nimport org.eclipse.core.runtime.IProgressMonitor\nimport org.eclipse.core.runtime.IStatus\nimport org.eclipse.core.runtime.Status\nimport org.eclipse.core.runtime.jobs.Job\nimport org.eclipse.jface.action.Action\nimport org.eclipse.jface.action.Separator\nimport org.eclipse.jface.util.OpenStrategy\nimport org.eclipse.jface.viewers.ISelection\nimport org.eclipse.jface.viewers.IStructuredSelection\nimport org.eclipse.jface.viewers.ITreeSelection\nimport org.eclipse.jface.viewers.TreeViewer\nimport org.eclipse.swt.SWT\nimport org.eclipse.swt.layout.FillLayout\nimport org.eclipse.swt.widgets.Composite\nimport org.eclipse.swt.widgets.Display\nimport org.eclipse.ui.IWorkbenchPage\nimport org.eclipse.ui.OpenAndLinkWithEditorHelper\nimport org.eclipse.ui.PartInitException\nimport org.eclipse.ui.PlatformUI\nimport org.eclipse.ui.ide.IDE\nimport org.eclipse.ui.ide.ResourceUtil\nimport org.eclipse.ui.internal.views.markers.MarkerSupportInternalUtilities\nimport org.eclipse.ui.part.ViewPart\nimport org.eclipse.ui.texteditor.ITextEditor\nimport java.util.HashSet\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/08\n */\nclass InspectionResultView : ViewPart() {\n lateinit var treeViewer: TreeViewer\n\n private val quickFixAction = QuickFixAction(this)\n\n override fun setFocus() {\n treeViewer.control.setFocus()\n }\n\n override fun createPartControl(parent: Composite) {\n parent.layout = FillLayout()\n treeViewer = TreeViewer(parent, SWT.MULTI or SWT.H_SCROLL or SWT.V_SCROLL)\n treeViewer.setUseHashlookup(true)\n treeViewer.contentProvider = InspectionResultTreeContentProvider\n treeViewer.labelProvider = InspectionResultTreeLabelProvider\n treeViewer.input = InspectionResults\n\n InspectionResults.view = this\n\n addDoubleClickListener()\n\n addSelectionChangedListener()\n\n initToolBar()\n\n addLinkWithEditorSupport()\n site.selectionProvider = treeViewer\n }\n\n fun clear() {\n InspectionResults.clear()\n refreshView(InspectionResults)\n }\n\n fun refreshView(input: InspectionResults) {\n Display.getDefault().asyncExec {\n treeViewer.refresh(input, true)\n contentDescription = input.contentDescription\n }\n }\n\n private fun addSelectionChangedListener() {\n treeViewer.addSelectionChangedListener inner@ {\n val selection = it.selection as? IStructuredSelection ?: return@inner\n val item = selection.firstElement ?: return@inner\n val ruleDetailView = RuleDetailView.showAndGetView()\n when (item) {\n is MarkerViolation -> {\n ruleDetailView.refresh(item.violation.rule)\n quickFixAction.updateFileMarkers(listOf(FileMarkers(item.marker.resource as IFile, listOf(item))))\n }\n is FileMarkers -> {\n ruleDetailView.refresh(item.markers.first().violation.rule)\n quickFixAction.updateFileMarkers(listOf(item))\n }\n is RuleViolations -> {\n ruleDetailView.refresh(SmartfoxActivator.instance.getRule(item.rule))\n quickFixAction.updateFileMarkers(item.files)\n }\n else -> {\n quickFixAction.updateFileMarkers(emptyList())\n }\n }\n }\n }\n\n private fun initToolBar() {\n val bars = viewSite.actionBars\n val tm = bars.toolBarManager\n\n val clearAction = object : Action(\"Clear Markers\") {\n override fun run() {\n val job = object : Job(\"Clear Markers\") {\n override fun run(monitor: IProgressMonitor): IStatus {\n if (monitor.isCanceled) {\n Status.CANCEL_STATUS\n }\n clear()\n return Status.OK_STATUS\n }\n }\n job.rule = P3cMutex\n job.schedule()\n }\n }\n\n clearAction.imageDescriptor = SmartfoxActivator.getImageDescriptor(\"icons/actions/clear.png\")\n\n tm.add(Separator(\"Markers\"))\n tm.add(clearAction)\n\n tm.add(Separator(\"FilterGroup\"))\n tm.add(quickFixAction)\n }\n\n private fun addLinkWithEditorSupport() {\n object : OpenAndLinkWithEditorHelper(treeViewer) {\n override fun activate(selection: ISelection) {\n val currentMode = OpenStrategy.getOpenMethod()\n try {\n OpenStrategy.setOpenMethod(OpenStrategy.DOUBLE_CLICK)\n openSelectedMarkers()\n } finally {\n OpenStrategy.setOpenMethod(currentMode)\n }\n }\n\n override fun linkToEditor(selection: ISelection?) {\n }\n\n override fun open(selection: ISelection, activate: Boolean) {\n val structured = selection as ITreeSelection\n val element = structured.firstElement as? MarkerViolation ?: return\n val page = site.page\n if (element.marker.exists()) {\n openMarkerInEditor(element.marker, page)\n return\n }\n val file = element.marker.resource as IFile\n val editor = IDE.openEditor(page, file) as ITextEditor\n editor.selectAndReveal(MarkerUtil.getAbsoluteRange(file, element.violation).start, 0)\n }\n }\n }\n\n internal fun openSelectedMarkers() {\n val markers = getOpenableMarkers()\n for (marker in markers) {\n val page = site.page\n openMarkerInEditor(marker, page)\n }\n }\n\n private fun getOpenableMarkers(): Array {\n val structured = treeViewer.selection as ITreeSelection\n val elements = structured.iterator()\n val result = HashSet()\n\n while (elements.hasNext()) {\n val marker = elements.next() as? IMarker ?: return emptyArray()\n result.add(marker)\n }\n return result.toTypedArray()\n }\n\n\n fun openMarkerInEditor(marker: IMarker?, page: IWorkbenchPage) {\n val editor = page.activeEditor\n if (editor != null) {\n val input = editor.editorInput\n val file = ResourceUtil.getFile(input)\n if (file != null) {\n if (marker!!.resource == file && OpenStrategy.activateOnOpen()) {\n page.activate(editor)\n }\n }\n }\n\n if (marker != null && marker.resource is IFile) {\n try {\n IDE.openEditor(page, marker, OpenStrategy.activateOnOpen())\n } catch (e: PartInitException) {\n MarkerSupportInternalUtilities.showViewError(e)\n }\n\n }\n }\n\n private fun addDoubleClickListener() {\n treeViewer.addDoubleClickListener({ event ->\n val selection = event.selection\n if (selection !is ITreeSelection || selection.size() != 1) {\n return@addDoubleClickListener\n }\n val obj = selection.firstElement\n if (treeViewer.isExpandable(obj)) {\n treeViewer.setExpandedState(obj, !treeViewer.getExpandedState(obj))\n }\n })\n }\n\n companion object {\n val viewId = \"com.alibaba.smartfox.eclipse.ui.InspectionResultView\"\n\n fun activeViews() {\n PlatformUI.getWorkbench().activeWorkbenchWindow.activePage.showView(viewId)\n RuleDetailView.showAndGetView()\n }\n\n fun getView(): InspectionResultView {\n return PlatformUI.getWorkbench().activeWorkbenchWindow.activePage.findView(viewId) as InspectionResultView\n }\n }\n}\n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/InspectionResults.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport com.alibaba.smartfox.eclipse.pmd.RulePriority\nimport com.alibaba.smartfox.eclipse.util.MarkerUtil\nimport org.eclipse.core.resources.IFile\nimport org.eclipse.core.resources.IMarker\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/13\n */\nobject InspectionResults {\n private val fileViolations = linkedMapOf>()\n\n var contentDescription = \"\"\n\n val errors: List\n get() {\n val result = toLevelViolationList(fileViolations.values.flatten())\n contentDescription = getContentDescription(result)\n return result\n }\n\n lateinit var view: InspectionResultView\n\n\n fun clear() {\n fileViolations.forEach {\n MarkerUtil.removeAllMarkers(it.key)\n }\n fileViolations.clear()\n // update contentDescription\n errors\n }\n\n private fun toLevelViolationList(markers: Collection): List {\n return markers.groupBy {\n it.violation.rule.priority.priority\n }.mapValues {\n it.value.groupBy {\n it.violation.rule.name\n }.mapValues {\n it.value.groupBy {\n it.marker.resource as IFile\n }.map {\n FileMarkers(it.key, it.value)\n }\n }.map {\n RuleViolations(it.key, it.value)\n }\n }.toSortedMap().map {\n val level = RulePriority.valueOf(it.key).title\n LevelViolations(level, it.value)\n }\n }\n\n fun updateFileViolations(file: IFile, markers: List) {\n if (markers.isEmpty()) {\n fileViolations.remove(file)\n } else {\n fileViolations[file] = markers\n }\n view.refreshView(this)\n }\n\n fun removeMarker(marker: IMarker) {\n val file = marker.resource as IFile\n val list = fileViolations[file] ?: return\n val result = list.filter {\n it.marker != marker\n }\n fileViolations[file] = result\n marker.delete()\n view.refreshView(this)\n }\n\n fun getContentDescription(errors: List): String {\n val map = errors.associateBy {\n it.level\n }\n\n return \"${map[RulePriority.Blocker.title]?.count ?: 0} Blockers,\" +\n \"${map[RulePriority.Critical.title]?.count ?: 0} Criticals,\" +\n \"${map[RulePriority.Major.title]?.count ?: 0} Majors\"\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/QuickFixAction.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport com.alibaba.p3c.pmd.lang.java.rule.flowcontrol.NeedBraceRule\nimport com.alibaba.smartfox.eclipse.RunWithoutViewRefresh\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport com.alibaba.smartfox.eclipse.job.CodeAnalysis\nimport com.alibaba.smartfox.eclipse.job.P3cMutex\nimport com.alibaba.smartfox.eclipse.pmd.rule.MissingOverrideAnnotationRule\nimport com.alibaba.smartfox.eclipse.util.CleanUps\nimport com.alibaba.smartfox.eclipse.util.getResolution\nimport org.eclipse.core.runtime.IProgressMonitor\nimport org.eclipse.core.runtime.IStatus\nimport org.eclipse.core.runtime.Status\nimport org.eclipse.core.runtime.SubMonitor\nimport org.eclipse.core.runtime.jobs.Job\nimport org.eclipse.jface.action.Action\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/14\n */\nclass QuickFixAction(val view: InspectionResultView) : Action(\"Quick Fix\") {\n init {\n imageDescriptor = SmartfoxActivator.getImageDescriptor(\"icons/actions/quickfixBulb.png\")\n isEnabled = false\n }\n\n var markers = listOf()\n\n fun updateFileMarkers(markers: List) {\n this.markers = markers\n isEnabled = enabled()\n }\n\n override fun run() {\n if (markers.isEmpty()) {\n return\n }\n runJob()\n }\n\n private fun runJob() {\n val job = object : Job(\"Perform P3C Quick Fix\") {\n override fun run(monitor: IProgressMonitor): IStatus {\n val subMonitor = SubMonitor.convert(monitor, markers.size)\n monitor.setTaskName(\"Process File\")\n markers.forEach {\n if (monitor.isCanceled) {\n return@run Status.CANCEL_STATUS\n }\n monitor.subTask(it.file.name)\n val childMonitor = subMonitor.newChild(1)\n if (useCleanUpRefactoring()) {\n CleanUps.fix(it.file, childMonitor)\n } else {\n it.markers.filter { it.marker.exists() }.forEach {\n (it.marker.getResolution() as RunWithoutViewRefresh).run(it.marker, true)\n }\n }\n val markers = CodeAnalysis.processFileToMakers(it.file, monitor)\n InspectionResults.updateFileViolations(it.file, markers)\n }\n\n return Status.OK_STATUS\n }\n }\n val outJob = object:Job(\"P3C Quick Fix Wait analysis finish\"){\n override fun run(monitor: IProgressMonitor?): IStatus {\n job.schedule()\n return Status.OK_STATUS\n }\n }\n outJob.rule = P3cMutex\n outJob.schedule()\n\n }\n\n fun enabled(): Boolean {\n if (useCleanUpRefactoring()) {\n return true\n }\n if (markers.isEmpty()) {\n return false\n }\n val marker = markers.first().markers.first().marker\n return marker.exists() && marker.getResolution() != null\n }\n\n private fun useCleanUpRefactoring(): Boolean {\n if (markers.isEmpty()) {\n return false\n }\n val ruleName = markers.first().markers.first().violation.rule.name\n return ruleName == MissingOverrideAnnotationRule::class.java.simpleName\n || ruleName == NeedBraceRule::class.java.simpleName\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/RuleDetailComposite.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport com.alibaba.smartfox.eclipse.pmd.RulePriority\nimport com.alibaba.smartfox.eclipse.ui.pmd.ContentBuilder\nimport com.alibaba.smartfox.eclipse.ui.pmd.StringArranger\nimport net.sourceforge.pmd.Rule\nimport org.eclipse.swt.SWT\nimport org.eclipse.swt.custom.StyledText\nimport org.eclipse.swt.layout.FillLayout\nimport org.eclipse.swt.widgets.Composite\n\n/**\n *\n * @author caikang\n * @date 2017/09/01\n */\nclass RuleDetailComposite(parent: Composite, style: Int = SWT.NONE) {\n private val viewField: StyledText\n private val contentBuilder = ContentBuilder()\n private val arranger = StringArranger(\" \")\n private val panel = Composite(parent, style)\n\n init {\n panel.layout = FillLayout()\n\n viewField = StyledText(panel, SWT.BORDER or SWT.H_SCROLL or SWT.V_SCROLL)\n viewField.wordWrap = true\n viewField.tabs = 20\n viewField.text = \"Select a result item to show rule detail.\"\n viewField.editable = false\n }\n\n fun refresh(rule: Rule) {\n contentBuilder.clear()\n viewField.text = \"\"\n contentBuilder.addHeading(\"Name\")\n contentBuilder.addText(rule.name)\n contentBuilder.addHeading(\"Severity\")\n contentBuilder.addText(RulePriority.valueOf(rule.priority.priority).title)\n contentBuilder.addHeading(\"Message\")\n contentBuilder.addText(rule.message)\n if (!rule.description.isNullOrBlank()) {\n contentBuilder.addHeading(\"Description\")\n contentBuilder.addRawText(arranger.format(rule.description).toString())\n }\n\n val examples = rule.examples\n if (examples.isEmpty()) {\n contentBuilder.showOn(viewField)\n return\n }\n\n contentBuilder.setLanguage(rule.language)\n\n contentBuilder.addHeading(\"Examples\")\n contentBuilder.addText(\"\")\n for (example in rule.examples) {\n contentBuilder.addCode(example.trim { it <= ' ' })\n contentBuilder.addText(\"\")\n }\n contentBuilder.showOn(viewField)\n\n if (contentBuilder.hasLinks()) {\n contentBuilder.addLinkHandler(viewField)\n }\n viewField.update()\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/RuleDetailView.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport net.sourceforge.pmd.Rule\nimport org.eclipse.jface.action.Action\nimport org.eclipse.jface.action.Separator\nimport org.eclipse.swt.SWT\nimport org.eclipse.swt.custom.ScrolledComposite\nimport org.eclipse.swt.layout.FillLayout\nimport org.eclipse.swt.widgets.Composite\nimport org.eclipse.swt.widgets.Display\nimport org.eclipse.swt.widgets.Shell\nimport org.eclipse.ui.IWorkbenchPage\nimport org.eclipse.ui.PlatformUI\nimport org.eclipse.ui.part.ViewPart\n\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/12\n */\nopen class RuleDetailView : ViewPart() {\n\n private lateinit var ruleDetailComposite: RuleDetailComposite\n\n override fun setFocus() {\n }\n\n override fun createPartControl(parent: Composite) {\n ruleDetailComposite = RuleDetailComposite(parent)\n initToolBar()\n }\n\n fun refresh(rule: Rule) {\n ruleDetailComposite.refresh(rule)\n }\n\n\n private fun initToolBar() {\n val bars = viewSite.actionBars\n val tm = bars.toolBarManager\n\n val rulesAction = object : Action(\"Show Rules\") {\n override fun run() {\n val shell = Shell(Display.getDefault())\n shell.text = \"All Rules\"\n shell.layout = FillLayout()\n\n val sc = ScrolledComposite(shell, SWT.V_SCROLL or SWT.H_SCROLL)\n\n val rulesView = AllRulesView(sc)\n\n sc.expandHorizontal = true\n sc.expandVertical = true\n\n sc.content = rulesView.content\n\n shell.open()\n }\n }\n\n rulesAction.imageDescriptor = SmartfoxActivator.getImageDescriptor(\"icons/actions/rules.png\")\n\n tm.add(Separator(\"Markers\"))\n tm.add(rulesAction)\n }\n\n companion object {\n fun showAndGetView(): RuleDetailView {\n return PlatformUI.getWorkbench().activeWorkbenchWindow.activePage.showView(\n \"com.alibaba.smartfox.eclipse.ui.RuleDetailView\", null,\n IWorkbenchPage.VIEW_VISIBLE) as RuleDetailView\n }\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/Violations.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.eclipse.ui\n\nimport com.alibaba.smartfox.eclipse.util.MarkerUtil\nimport net.sourceforge.pmd.RuleViolation\nimport org.eclipse.core.resources.IFile\nimport org.eclipse.core.resources.IMarker\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/13\n */\ndata class LevelViolations(var level: String, var rules: List,\n var count: Int = rules.sumBy { it.count }) {\n fun removeMarkers() {\n rules.forEach {\n it.removeMarkers()\n }\n }\n\n override fun equals(other: Any?): Boolean {\n if (other !is LevelViolations) {\n return false\n }\n return level == other.level\n }\n\n override fun hashCode(): Int {\n return level.hashCode()\n }\n}\n\ndata class RuleViolations(var rule: String, var files: List,\n var count: Int = files.sumBy { it.markers.size }) {\n fun removeMarkers() {\n files.forEach {\n it.removeMarkers()\n }\n }\n\n override fun equals(other: Any?): Boolean {\n if (other !is RuleViolations) {\n return false\n }\n return rule == other.rule\n }\n\n override fun hashCode(): Int {\n return rule.hashCode()\n }\n}\n\ndata class FileMarkers(var file: IFile, var markers: List) {\n fun removeMarkers() {\n MarkerUtil.removeAllMarkers(file)\n }\n\n override fun equals(other: Any?): Boolean {\n if (other !is FileMarkers) {\n return false\n }\n return file == other.file\n }\n\n override fun hashCode(): Int {\n return file.hashCode()\n }\n}\n\ndata class MarkerViolation(val marker: IMarker, val violation: RuleViolation)\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/pmd/BasicLineStyleListener.kt",
"content": "package com.alibaba.smartfox.eclipse.ui.pmd\n\nimport org.eclipse.swt.custom.LineStyleEvent\nimport org.eclipse.swt.custom.LineStyleListener\n\n/**\n * This class performs the syntax highlighting and styling for Pmpe\n * * PmpeLineStyleListener constructor\n\n * @param theSyntaxData the syntax data to use\n */\nclass BasicLineStyleListener(theSyntaxData: SyntaxData) : StyleExtractor(theSyntaxData), LineStyleListener {\n /**\n * Called by StyledText to get styles for a line\n */\n override fun lineGetStyle(event: LineStyleEvent) {\n val styles = lineStylesFor(event.lineText, event.lineOffset, event.lineText.length)\n event.styles = styles.toTypedArray()\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/pmd/ContentBuilder.kt",
"content": "package com.alibaba.smartfox.eclipse.ui.pmd\n\nimport net.sourceforge.pmd.lang.Language\nimport org.eclipse.swt.SWT\nimport org.eclipse.swt.custom.StyleRange\nimport org.eclipse.swt.custom.StyledText\nimport org.eclipse.swt.graphics.Point\nimport org.eclipse.swt.widgets.Display\nimport org.eclipse.ui.PlatformUI\nimport java.net.URL\nimport java.util.ArrayList\nimport java.util.Arrays\nimport java.util.HashMap\n\n/**\n *\n * @author caikang\n * @date 2017/07/20\n */\nclass ContentBuilder {\n private val CR = '\\n'\n private val buffer = StringBuilder()\n private val headingSpans = ArrayList()\n private val codeSpans = ArrayList()\n private val linksBySpan = HashMap()\n\n private val indentDepth: Int = 3\n\n private val codeStyleExtractor = StyleExtractor(SyntaxManager.getSyntaxData(\"java\"))\n\n private val background = Display.getCurrent().getSystemColor(SWT.COLOR_WHITE)\n\n private val headingColor = Display.getCurrent().getSystemColor(SWT.COLOR_BLUE)\n\n private val codeStyle = FontBuilder(\"Courier\", 11, SWT.NORMAL).style(Display.getCurrent())\n\n fun clear() {\n buffer.setLength(0)\n headingSpans.clear()\n codeSpans.clear()\n linksBySpan.clear()\n }\n\n fun addHeading(heading: String) {\n var length = buffer.length\n if (length > 0) {\n buffer.append(CR)\n length += 1\n }\n\n headingSpans.add(intArrayOf(length, length + heading.length))\n buffer.append(heading).append(CR)\n }\n\n fun addText(text: String) {\n for (i in 0 until indentDepth) {\n buffer.append(' ')\n }\n buffer.append(text).append(CR)\n }\n\n fun addRawText(text: String) {\n buffer.append(text)\n }\n\n fun addCode(code: String) {\n val length = buffer.length\n codeSpans.add(intArrayOf(length, length + code.length))\n buffer.append(code)\n }\n\n fun setLanguage(language: Language) {\n val syntax = SyntaxManager.getSyntaxData(language.terseName)\n codeStyleExtractor.syntax(syntax)\n }\n\n fun hasLinks(): Boolean {\n return linksBySpan.isNotEmpty()\n }\n\n fun addLinkHandler(widget: StyledText) {\n\n widget.addListener(SWT.MouseDown) { event ->\n // It is up to the application to determine when and how a link\n // should be activated.\n // In this snippet links are activated on mouse down when the\n // control key is held down\n // if ((event.stateMask & SWT.MOD1) != 0) {\n try {\n val offset = widget.getOffsetAtLocation(Point(event.x, event.y))\n val link = linkAt(offset)\n if (link != null) {\n launchBrowser(link)\n }\n\n } catch (e: IllegalArgumentException) {\n // no character under event.x, event.y\n }\n }\n }\n\n private fun linkAt(textIndex: Int): String? {\n var span: IntArray\n for ((key, value) in linksBySpan) {\n span = key\n if (span[0] <= textIndex && textIndex <= span[1]) {\n return value\n }\n }\n return null\n }\n\n private fun launchBrowser(link: String) {\n try {\n val browser = PlatformUI.getWorkbench().browserSupport.externalBrowser\n browser.openURL(URL(link))\n } catch (ex: Exception) {\n ex.printStackTrace()\n }\n }\n\n fun showOn(widget: StyledText) {\n val text = buffer.toString()\n widget.text = text\n val ranges = ArrayList()\n var span: IntArray\n for (i in headingSpans.indices) {\n span = headingSpans[i]\n ranges.add(StyleRange(span[0], span[1] - span[0], headingColor, background, SWT.BOLD))\n }\n for (spn in linksBySpan.keys) {\n val style = StyleRange(spn[0], spn[1] - spn[0], headingColor, background, SWT.UNDERLINE_LINK)\n style.underline = true\n ranges.add(style)\n }\n val crStr = Character.toString(CR)\n var sr: StyleRange\n\n for (i in codeSpans.indices) {\n span = codeSpans[i]\n sr = StyleRange(codeStyle)\n sr.start = span[0]\n sr.length = span[1] - span[0]\n\n val colorRanges = codeStyleExtractor.stylesFor(text, sr.start, sr.length, crStr)\n ranges += colorRanges\n }\n // must be in order!\n val styles = sort(ranges)\n widget.styleRanges = styles\n }\n\n private fun sort(ranges: List): Array {\n val styles = ranges.toTypedArray()\n Arrays.sort(styles) { sr1, sr2 -> sr1.start - sr2.start }\n return styles\n }\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/pmd/FontBuilder.kt",
"content": "package com.alibaba.smartfox.eclipse.ui.pmd\n\nimport org.eclipse.swt.graphics.Font\nimport org.eclipse.swt.graphics.TextStyle\nimport org.eclipse.swt.widgets.Display\n\n/**\n * @author Brian Remedios\n */\nclass FontBuilder(val name: String, val size: Int, val style: Int, val colorIdx: Int = -1) {\n\n fun build(display: Display): Font {\n return Font(display, name, size, style)\n }\n\n fun style(display: Display): TextStyle {\n return TextStyle(build(display), if (colorIdx < 0) null else display.getSystemColor(colorIdx), null)\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/pmd/StringArranger.kt",
"content": "package com.alibaba.smartfox.eclipse.ui.pmd\n\nimport net.sourceforge.pmd.util.StringUtil\nimport java.util.ArrayList\n\n/**\n * @author Brian Remedios\n */\nclass StringArranger(private val indentString: String) {\n\n fun withIndent(rawText: String): String {\n return indentString + rawText\n }\n\n fun format(rawText: String): StringBuilder {\n\n val sb = StringBuilder()\n for (line in trimmedLinesIn(rawText)) {\n sb.append(indentString)\n sb.append(line).append(CR)\n }\n\n return sb\n }\n\n fun trimmedLinesIn(text: String): List {\n\n val lines = text.split(\"\\n\".toRegex()).dropLastWhile { it.isEmpty() }.toTypedArray()\n if (lines.isEmpty()) {\n return emptyList()\n }\n\n val lineSet = ArrayList(lines.size)\n\n var startLine = 0\n while (startLine < lines.size && StringUtil.isEmpty(lines[startLine])) {\n startLine++\n }\n\n var endLine = lines.size - 1\n while (endLine >= 0 && StringUtil.isEmpty(lines[endLine])) {\n endLine--\n }\n\n lines.mapTo(lineSet) {\n it.trim { it <= ' ' }\n }\n return lineSet\n }\n\n companion object {\n private val CR = '\\n'\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/pmd/StyleExtractor.kt",
"content": "package com.alibaba.smartfox.eclipse.ui.pmd\n\nimport net.sourceforge.pmd.util.StringUtil\nimport org.eclipse.swt.SWT\nimport org.eclipse.swt.custom.StyleRange\nimport org.eclipse.swt.widgets.Display\nimport java.util.ArrayList\nimport java.util.LinkedList\n\n/**\n * @author Brian Remedios\n */\nopen class StyleExtractor(private var syntaxData: SyntaxData?) {\n private val commentOffsets: MutableList\n\n init {\n commentOffsets = LinkedList()\n }\n\n fun syntax(theSyntax: SyntaxData?) {\n syntaxData = theSyntax\n }\n\n /**\n * Refreshes the offsets for all multiline comments in the parent\n * StyledText. The parent StyledText should call this whenever its text is\n * modified. Note that this code doesn't ignore comment markers inside\n * strings.\n\n * @param text the text from the StyledText\n */\n fun refreshMultilineComments(text: String) {\n // Clear any stored offsets\n commentOffsets.clear()\n\n if (syntaxData != null) {\n // Go through all the instances of COMMENT_START\n var pos = text.indexOf(syntaxData!!.multiLineCommentStart!!)\n while (pos > -1) {\n // offsets[0] holds the COMMENT_START offset\n // and COMMENT_END holds the ending offset\n val offsets = IntArray(2)\n offsets[0] = pos\n\n // Find the corresponding end comment.\n pos = text.indexOf(syntaxData!!.multiLineCommentEnd!!, pos)\n\n // If no corresponding end comment, use the end of the text\n offsets[1] = if (pos == -1) text.length - 1 else pos + syntaxData!!.multiLineCommentEnd!!.length - 1\n pos = offsets[1]\n // Add the offsets to the collection\n commentOffsets.add(offsets)\n pos = text.indexOf(syntaxData!!.multiLineCommentStart!!, pos)\n }\n }\n }\n\n /**\n * Checks to see if the specified section of text begins inside a multiline\n * comment. Returns the index of the closing comment, or the end of the line\n * if the whole line is inside the comment. Returns -1 if the line doesn't\n * begin inside a comment.\n\n * @param start the starting offset of the text\n * @param length the length of the text\n * @return int\n */\n private fun getBeginsInsideComment(start: Int, length: Int): Int {\n // Assume section doesn't being inside a comment\n var index = -1\n\n // Go through the multiline comment ranges\n var i = 0\n val n = commentOffsets.size\n while (i < n) {\n val offsets = commentOffsets[i]\n\n // If starting offset is past range, quit\n if (offsets[0] > start + length) {\n break\n }\n // Check to see if section begins inside a comment\n if (offsets[0] <= start && offsets[1] >= start) {\n // It does; determine if the closing comment marker is inside\n // this section\n index = if (offsets[1] > start + length) start + length\n else offsets[1] + syntaxData!!.multiLineCommentEnd!!.length - 1\n }\n i++\n }\n return index\n }\n\n private fun isDefinedVariable(text: String): Boolean {\n return StringUtil.isNotEmpty(text)\n }\n\n private fun atMultiLineCommentStart(text: String, position: Int): Boolean {\n return text.indexOf(syntaxData!!.multiLineCommentStart!!, position) == position\n }\n\n private fun atStringStart(text: String, position: Int): Boolean {\n return text.indexOf(syntaxData!!.stringStart!!, position) == position\n }\n\n private fun atVarnameReference(text: String, position: Int): Boolean {\n return syntaxData!!.varnameReference != null && text.indexOf(syntaxData!!.varnameReference!!,\n position) == position\n }\n\n private fun atSingleLineComment(text: String, position: Int): Boolean {\n return syntaxData!!.comment != null && text.indexOf(syntaxData!!.comment!!, position) == position\n }\n\n private fun getKeywordEnd(lineText: String, start: Int): Int {\n\n val length = lineText.length\n\n val buf = StringBuilder(length)\n var i = start\n\n // Call any consecutive letters a word\n while (i < length && Character.isLetter(lineText[i])) {\n buf.append(lineText[i])\n i++\n }\n\n return if (syntaxData!!.isKeyword(buf.toString())) i else 0 - i\n }\n\n /**\n * Chop up the text into individual lines starting from offset and then\n * determine the required styles for each. Ensures the offset is properly\n * accounted for in each.\n\n * @param text\n * @param offset\n * @param length\n * @return\n */\n fun stylesFor(text: String, offset: Int, length: Int, lineSeparator: String): List {\n\n if (syntaxData == null) {\n return emptyList()\n }\n\n val content = text.substring(offset, offset + length)\n val lines = content.split(lineSeparator.toRegex()).dropLastWhile { it.isEmpty() }.toTypedArray()\n\n val styles = ArrayList()\n\n val separatorLength = lineSeparator.length\n\n var currentOffset = offset\n\n for (line in lines) {\n val lineLength = line.length\n val lineStyles = lineStylesFor(line, 0, lineLength)\n\n for (sr in lineStyles) {\n sr.start += currentOffset\n }\n styles.addAll(lineStyles)\n currentOffset += lineLength + separatorLength\n }\n\n return styles\n }\n\n fun lineStylesFor(lineText: String, lineOffset: Int, length: Int): List {\n\n val styles = ArrayList()\n\n var start = 0\n\n // Check if line begins inside a multiline comment\n val mlIndex = getBeginsInsideComment(lineOffset, lineText.length)\n if (mlIndex > -1) {\n // Line begins inside multiline comment; create the range\n styles.add(StyleRange(lineOffset, mlIndex - lineOffset, COMMENT_COLOR, COMMENT_BACKGROUND))\n start = mlIndex\n }\n // Do punctuation, single-line comments, and keywords\n while (start < length) {\n // Check for multiline comments that begin inside this line\n if (atMultiLineCommentStart(lineText, start)) {\n // Determine where comment ends\n var endComment = lineText.indexOf(syntaxData!!.multiLineCommentEnd!!, start)\n\n // If comment doesn't end on this line, extend range to end of\n // line\n if (endComment == -1) {\n endComment = length\n } else {\n endComment += syntaxData!!.multiLineCommentEnd!!.length\n }\n styles.add(StyleRange(lineOffset + start, endComment - start, COMMENT_COLOR, COMMENT_BACKGROUND))\n\n start = endComment\n } else if (atStringStart(lineText, start)) {\n // Determine where comment ends\n var endString = lineText.indexOf(syntaxData!!.stringEnd!!, start + 1)\n\n // If string doesn't end on this line, extend range to end of\n // line\n if (endString == -1) {\n endString = length\n } else {\n endString += syntaxData!!.stringEnd!!.length\n }\n styles.add(StyleRange(lineOffset + start, endString - start, STRING_COLOR, COMMENT_BACKGROUND))\n\n start = endString\n } else if (atSingleLineComment(lineText, start)) {\n // line comments\n\n styles.add(StyleRange(lineOffset + start, length - start, COMMENT_COLOR, COMMENT_BACKGROUND))\n start = length\n } else if (atVarnameReference(lineText, start)) {\n // variable\n // references\n\n val buf = StringBuilder()\n var i = start + syntaxData!!.varnameReference!!.length\n // Call any consecutive letters a word\n while (i < length && Character.isLetter(lineText[i])) {\n buf.append(lineText[i])\n i++\n }\n\n // See if the word is a variable\n if (isDefinedVariable(buf.toString())) {\n // It's a keyword; create the StyleRange\n styles.add(StyleRange(lineOffset + start, i - start, REFERENCED_VAR_COLOR, null, SWT.BOLD))\n }\n // Move the marker to the last char (the one that wasn't a\n // letter)\n // so it can be retested in the next iteration through the loop\n start = i\n } else if (syntaxData!!.isPunctuation(lineText[start])) {\n // Add range for punctuation\n styles.add(StyleRange(lineOffset + start, 1, PUNCTUATION_COLOR, null))\n ++start\n } else if (Character.isLetter(lineText[start])) {\n\n val kwEnd = getKeywordEnd(lineText, start)\n // is a keyword\n\n if (kwEnd > start) {\n styles.add(StyleRange(lineOffset + start, kwEnd - start, KEYWORD_COLOR, null))\n }\n\n // Move the marker to the last char (the one that wasn't a\n // letter)\n // so it can be retested in the next iteration through the loop\n start = Math.abs(kwEnd)\n } else {\n ++start // It's nothing we're interested in; advance the marker\n }// Check for punctuation\n }\n\n return styles\n }\n\n companion object {\n\n private val COMMENT_COLOR = Display.getCurrent().getSystemColor(SWT.COLOR_DARK_GREEN)\n private val REFERENCED_VAR_COLOR = Display.getCurrent().getSystemColor(SWT.COLOR_DARK_GREEN)\n private val UNREFERENCED_VAR_COLOR = Display.getCurrent().getSystemColor(SWT.COLOR_YELLOW)\n private val COMMENT_BACKGROUND = Display.getCurrent().getSystemColor(SWT.COLOR_WHITE)\n private val PUNCTUATION_COLOR = Display.getCurrent().getSystemColor(SWT.COLOR_BLACK)\n private val KEYWORD_COLOR = Display.getCurrent().getSystemColor(SWT.COLOR_DARK_MAGENTA)\n private val STRING_COLOR = Display.getCurrent().getSystemColor(SWT.COLOR_BLUE)\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/pmd/SyntaxData.kt",
"content": "package com.alibaba.smartfox.eclipse.ui.pmd\n\n/**\n * This class contains information for syntax coloring and styling for an\n * extension\n */\nclass SyntaxData(val extension: String) {\n\n var varnameReference: String? = null\n var stringStart: String? = null\n var stringEnd: String? = null\n private var keywords: Collection? = null\n private var punctuation: String? = null\n var comment: String? = null\n var multiLineCommentStart: String? = null\n var multiLineCommentEnd: String? = null\n\n fun matches(otherExtension: String): Boolean {\n return extension == otherExtension\n }\n\n fun isKeyword(word: String): Boolean {\n return keywords != null && keywords!!.contains(word)\n }\n\n fun isPunctuation(ch: Char): Boolean {\n return punctuation != null && punctuation!!.indexOf(ch) >= 0\n }\n\n fun setKeywords(keywords: Collection) {\n this.keywords = keywords\n }\n\n fun setPunctuation(thePunctuationChars: String) {\n punctuation = thePunctuationChars\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/ui/pmd/SyntaxManager.kt",
"content": "package com.alibaba.smartfox.eclipse.ui.pmd\n\nimport org.eclipse.swt.custom.StyledText\nimport org.eclipse.swt.events.ModifyListener\nimport java.util.HashSet\nimport java.util.Hashtable\nimport java.util.MissingResourceException\nimport java.util.ResourceBundle\nimport java.util.StringTokenizer\n\n/**\n * This class manages the syntax coloring and styling data\n */\nobject SyntaxManager {\n\n private val syntaxByExtension = Hashtable()\n\n fun adapt(codeField: StyledText, languageCode: String, oldListener: ModifyListener?): ModifyListener? {\n\n if (oldListener != null) {\n codeField.removeModifyListener(oldListener)\n }\n\n val sd = SyntaxManager.getSyntaxData(languageCode) ?: return null\n\n val blsl = BasicLineStyleListener(sd)\n codeField.addLineStyleListener(blsl)\n\n val ml = ModifyListener {\n blsl.refreshMultilineComments(codeField.text)\n codeField.redraw()\n }\n codeField.addModifyListener(ml)\n\n return ml\n }\n\n /**\n * Gets the syntax data for an extension\n */\n @Synchronized fun getSyntaxData(extension: String): SyntaxData? {\n // Check in cache\n var sd: SyntaxData? = syntaxByExtension[extension]\n if (sd == null) {\n // Not in cache; load it and put in cache\n sd = loadSyntaxData(extension)\n if (sd != null) {\n syntaxByExtension.put(sd.extension, sd)\n }\n }\n return sd\n }\n\n /**\n * Loads the syntax data for an extension\n * @return SyntaxData\n */\n private fun loadSyntaxData(filename: String): SyntaxData? {\n var sd: SyntaxData? = null\n try {\n val rb = ResourceBundle.getBundle(\"/syntax/$filename\")\n sd = SyntaxData(filename)\n\n sd.stringStart = rb.getString(\"stringstart\")\n sd.stringEnd = rb.getString(\"stringend\")\n sd.multiLineCommentStart = rb.getString(\"multilinecommentstart\")\n sd.multiLineCommentEnd = rb.getString(\"multilinecommentend\")\n\n // Load the keywords\n val keywords = HashSet()\n val st = StringTokenizer(rb.getString(\"keywords\"), \" \")\n while (st.hasMoreTokens()) {\n keywords.add(st.nextToken())\n }\n sd.setKeywords(keywords)\n\n // Load the punctuation\n sd.setPunctuation(rb.getString(\"punctuation\"))\n\n if (rb.containsKey(\"comment\")) {\n sd.comment = rb.getString(\"comment\")\n }\n\n if (rb.containsKey(\"varnamedelimiter\")) {\n sd.varnameReference = rb.getString(\"varnamedelimiter\")\n }\n\n } catch (e: MissingResourceException) {\n // Ignore\n }\n\n return sd\n }\n}\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/util/CleanUps.kt",
"content": "// =====================================================================\n//\n// Copyright (C) 2012 - 2016, Philip Graf\n//\n// All rights reserved. This program and the accompanying materials\n// are made available under the terms of the Eclipse Public License v1.0\n// which accompanies this distribution, and is available at\n// http://www.eclipse.org/legal/epl-v10.html\n//\n// =====================================================================\npackage com.alibaba.smartfox.eclipse.util\n\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport org.eclipse.core.filebuffers.FileBuffers\nimport org.eclipse.core.filebuffers.ITextFileBuffer\nimport org.eclipse.core.filebuffers.LocationKind\nimport org.eclipse.core.resources.IFile\nimport org.eclipse.core.runtime.Assert\nimport org.eclipse.core.runtime.CoreException\nimport org.eclipse.core.runtime.IProgressMonitor\nimport org.eclipse.core.runtime.IStatus\nimport org.eclipse.core.runtime.NullProgressMonitor\nimport org.eclipse.core.runtime.Status\nimport org.eclipse.jdt.core.ICompilationUnit\nimport org.eclipse.jdt.core.IJavaProject\nimport org.eclipse.jdt.core.JavaCore\nimport org.eclipse.jdt.core.dom.CompilationUnit\nimport org.eclipse.jdt.internal.corext.fix.CleanUpConstants\nimport org.eclipse.jdt.internal.corext.fix.CleanUpRefactoring\nimport org.eclipse.jdt.internal.corext.fix.FixMessages\nimport org.eclipse.jdt.internal.corext.refactoring.util.RefactoringASTParser\nimport org.eclipse.jdt.internal.ui.JavaPlugin\nimport org.eclipse.jdt.internal.ui.actions.ActionUtil\nimport org.eclipse.jdt.internal.ui.fix.MapCleanUpOptions\nimport org.eclipse.jdt.ui.SharedASTProvider\nimport org.eclipse.jdt.ui.cleanup.CleanUpContext\nimport org.eclipse.jdt.ui.cleanup.CleanUpOptions\nimport org.eclipse.jdt.ui.cleanup.ICleanUp\nimport org.eclipse.jface.text.BadLocationException\nimport org.eclipse.jface.text.IDocument\nimport org.eclipse.jface.text.IDocumentExtension4\nimport org.eclipse.jface.window.Window\nimport org.eclipse.ltk.core.refactoring.Change\nimport org.eclipse.ltk.core.refactoring.CompositeChange\nimport org.eclipse.ltk.core.refactoring.IRefactoringCoreStatusCodes\nimport org.eclipse.ltk.core.refactoring.NullChange\nimport org.eclipse.ltk.core.refactoring.PerformChangeOperation\nimport org.eclipse.ltk.core.refactoring.RefactoringCore\nimport org.eclipse.ltk.core.refactoring.RefactoringStatus\nimport org.eclipse.ltk.core.refactoring.TextFileChange\nimport org.eclipse.ltk.ui.refactoring.RefactoringUI\nimport org.eclipse.text.edits.MalformedTreeException\nimport org.eclipse.text.edits.TextEdit\nimport org.eclipse.text.edits.UndoEdit\nimport org.eclipse.ui.PlatformUI\nimport java.util.ArrayList\nimport java.util.HashMap\nimport java.util.LinkedList\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/15\n */\nobject CleanUps {\n\n private val WARNING_VALUE = \"warning\"\n private val ERROR_VALUE = \"error\"\n\n val cleanUpSettings = mapOf(CleanUpConstants.ADD_MISSING_ANNOTATIONS to CleanUpOptions.TRUE,\n CleanUpConstants.CONTROL_STATMENTS_USE_BLOCKS_ALWAYS to CleanUpOptions.TRUE,\n CleanUpConstants.ADD_MISSING_ANNOTATIONS_OVERRIDE to CleanUpOptions.TRUE,\n CleanUpConstants.CONTROL_STATEMENTS_USE_BLOCKS to CleanUpOptions.TRUE,\n CleanUpConstants.ADD_MISSING_ANNOTATIONS_OVERRIDE_FOR_INTERFACE_METHOD_IMPLEMENTATION to\n CleanUpOptions.TRUE)\n\n fun fix(file: IFile, monitor: IProgressMonitor) {\n val compilationUnit = JavaCore.createCompilationUnitFrom(file) ?: return\n doCleanUp(compilationUnit, monitor)\n }\n\n @Throws(CoreException::class) fun doCleanUp(unit: ICompilationUnit, monitor: IProgressMonitor) {\n\n monitor.beginTask(\"Fix\", IProgressMonitor.UNKNOWN)\n\n if (!ActionUtil.isOnBuildPath(unit)) return\n val result = CompositeChange(FixMessages.CleanUpPostSaveListener_SaveAction_ChangeName)\n val undoEdits = LinkedList()\n val oldFileValue = unit.resource.modificationStamp\n val oldDocValue = getDocumentStamp(unit.resource as IFile, monitor)\n val manager = RefactoringCore.getUndoManager()\n var success = false\n\n try {\n manager.aboutToPerformChange(result)\n success = doCleanUp(unit, monitor, result, undoEdits)\n } finally {\n manager.changePerformed(result, success)\n }\n\n if (undoEdits.size > 0) {\n val undoEditArray = undoEdits.toTypedArray()\n val undo = CleanUpSaveUndo(result.name, unit.resource as IFile, undoEditArray, oldDocValue, oldFileValue)\n undo.initializeValidationData(NullProgressMonitor())\n manager.addUndo(result.name, undo)\n }\n }\n\n @Throws(CoreException::class) private fun getDocumentStamp(file: IFile, monitor: IProgressMonitor): Long {\n val manager = FileBuffers.getTextFileBufferManager()\n val path = file.fullPath\n\n monitor.beginTask(\"\", 2)\n\n var buffer: ITextFileBuffer? = null\n try {\n manager.connect(path, LocationKind.IFILE, monitor)\n buffer = manager.getTextFileBuffer(path, LocationKind.IFILE)\n val document = buffer!!.document\n\n if (document is IDocumentExtension4) {\n return document.modificationStamp\n } else {\n return file.modificationStamp\n }\n } finally {\n if (buffer != null) manager.disconnect(path, LocationKind.IFILE, monitor)\n monitor.done()\n }\n }\n\n private fun doCleanUp(unit: ICompilationUnit, monitor: IProgressMonitor, result: CompositeChange,\n undoEdits: LinkedList): Boolean {\n val cleanUps = JavaPlugin.getDefault().cleanUpRegistry.createCleanUps(\n setOf(\"org.eclipse.jdt.ui.cleanup.java50\", \"org.eclipse.jdt.ui.cleanup.control_statements\"))\n val preCondition = RefactoringStatus()\n val postCondition = RefactoringStatus()\n cleanUps.forEach { cleanUp ->\n cleanUp.setOptions(MapCleanUpOptions(cleanUpSettings))\n\n preCondition.merge(cleanUp.checkPreConditions(unit.javaProject, arrayOf(unit), monitor))\n\n val options = HashMap(cleanUp.requirements.compilerOptions ?: emptyMap())\n\n var ast = CleanUps.createAst(unit, options, monitor)\n if (cleanUp.requirements.requiresAST()) {\n ast = createAst(unit, options, monitor)\n }\n\n val context = CleanUpContext(unit, ast)\n\n val undoneCleanUps = ArrayList()\n val change = CleanUpRefactoring.calculateChange(context, arrayOf(cleanUp), undoneCleanUps, null)\n\n postCondition.merge(cleanUp.checkPostConditions(monitor))\n if (showStatus(postCondition) != Window.OK) {\n return@doCleanUp false\n }\n\n if (change == null) {\n return@forEach\n }\n result.add(change)\n\n change.initializeValidationData(NullProgressMonitor())\n\n val performChangeOperation = PerformChangeOperation(change)\n performChangeOperation.setSchedulingRule(unit.schedulingRule)\n performChangeOperation.run(monitor)\n performChangeOperation.undoChange\n undoEdits.addFirst(change.undoEdit)\n }\n\n return true\n }\n\n private fun showStatus(status: RefactoringStatus): Int {\n if (!status.hasError()) return Window.OK\n\n val shell = PlatformUI.getWorkbench().activeWorkbenchWindow.shell\n\n val dialog = RefactoringUI.createRefactoringStatusDialog(status, shell, \"\", false)\n return dialog.open()\n }\n\n private fun createAst(unit: ICompilationUnit, cleanUpOptions: Map,\n monitor: IProgressMonitor): CompilationUnit {\n val project = unit.javaProject\n if (compatibleOptions(project, cleanUpOptions)) {\n val ast = SharedASTProvider.getAST(unit, SharedASTProvider.WAIT_NO, monitor)\n if (ast != null) return ast\n }\n\n val parser = CleanUpRefactoring.createCleanUpASTParser()\n parser.setSource(unit)\n\n val compilerOptions = RefactoringASTParser.getCompilerOptions(unit.javaProject)\n compilerOptions.putAll(cleanUpOptions)\n parser.setCompilerOptions(compilerOptions)\n\n return parser.createAST(monitor) as CompilationUnit\n }\n\n private fun compatibleOptions(project: IJavaProject, cleanUpOptions: Map): Boolean {\n if (cleanUpOptions.isEmpty()) {\n return true\n }\n\n val projectOptions = project.getOptions(true)\n\n return !cleanUpOptions.keys.any {\n val projectOption = projectOptions[it]?.toString()\n val cleanUpOption = cleanUpOptions[it]?.toString()\n !strongerEquals(projectOption, cleanUpOption)\n }\n }\n\n private fun strongerEquals(projectOption: String?, cleanUpOption: String?): Boolean {\n if (projectOption == null) return false\n\n if (ERROR_VALUE == cleanUpOption) {\n return ERROR_VALUE == projectOption\n } else if (WARNING_VALUE == cleanUpOption) {\n return ERROR_VALUE == projectOption || WARNING_VALUE == projectOption\n }\n\n return false\n }\n\n private class CleanUpSaveUndo(name: String, private val fFile: IFile, private val fUndos: Array,\n private val fDocumentStamp: Long, private val fFileStamp: Long) : TextFileChange(name,\n fFile) {\n\n init {\n Assert.isNotNull(fUndos)\n }\n\n public override fun needsSaving(): Boolean {\n return true\n }\n\n @Throws(CoreException::class) override fun perform(monitor: IProgressMonitor?): Change {\n val pm = monitor ?: NullProgressMonitor()\n if (isValid(pm).hasFatalError()) return NullChange()\n\n val manager = FileBuffers.getTextFileBufferManager()\n pm.beginTask(\"\", 2)\n var buffer: ITextFileBuffer? = null\n\n try {\n manager.connect(fFile.fullPath, LocationKind.IFILE, pm)\n buffer = manager.getTextFileBuffer(fFile.fullPath, LocationKind.IFILE)\n\n val document = buffer!!.document\n val oldFileValue = fFile.modificationStamp\n val undoEditCollector = LinkedList()\n val oldDocValue = LongArray(1)\n val setContentStampSuccess = booleanArrayOf(false)\n\n if (!buffer.isSynchronizationContextRequested) {\n performEdit(document, oldFileValue, undoEditCollector, oldDocValue, setContentStampSuccess)\n\n } else {\n val fileBufferManager = FileBuffers.getTextFileBufferManager()\n\n class UIRunnable : Runnable {\n var fDone: Boolean = false\n var fException: Exception? = null\n\n override fun run() {\n synchronized(this) {\n try {\n performEdit(document, oldFileValue, undoEditCollector, oldDocValue,\n setContentStampSuccess)\n } catch (e: BadLocationException) {\n fException = e\n } catch (e: MalformedTreeException) {\n fException = e\n } catch (e: CoreException) {\n fException = e\n } finally {\n fDone = true\n (this as Object).notifyAll()\n }\n }\n }\n }\n\n val runnable = UIRunnable()\n\n synchronized(runnable) {\n fileBufferManager.execute(runnable)\n while (!runnable.fDone) {\n try {\n (runnable as Object).wait(500)\n } catch (x: InterruptedException) {\n }\n\n }\n }\n\n if (runnable.fException != null) {\n if (runnable.fException is BadLocationException) {\n throw runnable.fException as BadLocationException\n } else if (runnable.fException is MalformedTreeException) {\n throw runnable.fException as MalformedTreeException\n } else if (runnable.fException is CoreException) {\n throw runnable.fException as CoreException\n }\n }\n }\n\n buffer.commit(pm, false)\n if (!setContentStampSuccess[0]) {\n fFile.revertModificationStamp(fFileStamp)\n }\n\n return CleanUpSaveUndo(name, fFile, undoEditCollector.toTypedArray(), oldDocValue[0], oldFileValue)\n } catch (e: BadLocationException) {\n throw wrapBadLocationException(e)\n } finally {\n if (buffer != null) manager.disconnect(fFile.fullPath, LocationKind.IFILE, pm)\n }\n }\n\n @Throws(MalformedTreeException::class, BadLocationException::class,\n CoreException::class) private fun performEdit(document: IDocument, oldFileValue: Long,\n editCollector: LinkedList,\n oldDocValue: LongArray,\n setContentStampSuccess: BooleanArray) {\n if (document is IDocumentExtension4) {\n oldDocValue[0] = document.modificationStamp\n } else {\n oldDocValue[0] = oldFileValue\n }\n\n // perform the changes\n fUndos.map { it.apply(document, TextEdit.CREATE_UNDO) }.forEach { editCollector.addFirst(it) }\n\n if (document is IDocumentExtension4 && fDocumentStamp != IDocumentExtension4.UNKNOWN_MODIFICATION_STAMP) {\n try {\n document.replace(0, 0, \"\", fDocumentStamp)\n setContentStampSuccess[0] = true\n } catch (e: BadLocationException) {\n throw wrapBadLocationException(e)\n }\n\n }\n }\n }\n\n private fun wrapBadLocationException(e: BadLocationException): CoreException {\n var message: String? = e.message\n if (message == null) message = \"BadLocationException\"\n return CoreException(\n Status(IStatus.ERROR, SmartfoxActivator.PLUGIN_ID, IRefactoringCoreStatusCodes.BAD_LOCATION, message,\n e))\n }\n\n}"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/kotlin/com/alibaba/smartfox/eclipse/util/MarkerUtil.kt",
"content": "// =====================================================================\n//\n// Copyright (C) 2012 - 2016, Philip Graf\n//\n// All rights reserved. This program and the accompanying materials\n// are made available under the terms of the Eclipse Public License v1.0\n// which accompanies this distribution, and is available at\n// http://www.eclipse.org/legal/epl-v10.html\n//\n// =====================================================================\npackage com.alibaba.smartfox.eclipse.util\n\nimport com.alibaba.smartfox.eclipse.QuickFixGenerator\nimport com.alibaba.smartfox.eclipse.SmartfoxActivator\nimport com.google.common.io.Files\nimport net.sourceforge.pmd.Rule\nimport net.sourceforge.pmd.RulePriority\nimport net.sourceforge.pmd.RuleViolation\nimport org.eclipse.core.resources.IFile\nimport org.eclipse.core.resources.IMarker\nimport org.eclipse.core.resources.IProject\nimport org.eclipse.core.resources.IResource\nimport org.eclipse.core.runtime.CoreException\nimport org.eclipse.jface.text.BadLocationException\nimport org.eclipse.jface.text.Document\nimport org.eclipse.ui.IMarkerResolution\nimport java.nio.charset.Charset\n\n/**\n * @author caikang\n * @date 2017/06/08\n */\nobject MarkerUtil {\n\n private val PMD_TAB_SIZE = 8\n\n private val MARKER_TYPE = \"${SmartfoxActivator.PLUGIN_ID}.p3cMarker\"\n\n @Throws(CoreException::class)\n fun removeAllMarkers(file: IFile) {\n try {\n if (file.exists()) {\n file.deleteMarkers(MARKER_TYPE, true, IResource.DEPTH_ZERO)\n }\n } catch (e: Exception) {\n SmartfoxActivator.instance.logError(e.message ?: \"\", e)\n }\n }\n\n @Throws(CoreException::class)\n fun removeAllMarkers(project: IProject) {\n project.deleteMarkers(MARKER_TYPE, true, IResource.DEPTH_INFINITE)\n }\n\n @Throws(CoreException::class)\n fun addMarker(file: IFile, violation: RuleViolation): IMarker {\n val marker = file.createMarker(MARKER_TYPE)\n marker.setAttribute(IMarker.MESSAGE, violation.description)\n val severity = when (violation.rule.priority) {\n RulePriority.HIGH -> IMarker.SEVERITY_ERROR\n RulePriority.MEDIUM_HIGH -> IMarker.SEVERITY_WARNING\n else -> IMarker.SEVERITY_INFO\n }\n marker.setRule(violation.rule.name)\n marker.setAttribute(IMarker.SEVERITY, severity)\n marker.setAttribute(IMarker.LINE_NUMBER, Math.max(violation.beginLine, 0))\n val range = getAbsoluteRange(file, violation)\n val start = Math.max(range.start, 0)\n marker.setAttribute(IMarker.CHAR_START, start)\n val end = Math.max(range.end, 0)\n marker.setAttribute(IMarker.CHAR_END, end)\n return marker\n }\n\n\n fun getAbsoluteRange(file: IFile, violation: RuleViolation): Range {\n val content = Files.toString(file.rawLocation.toFile(), Charset.forName(file.charset))\n try {\n return calculateAbsoluteRange(content, violation)\n } catch (e: BadLocationException) {\n return Range(0, 0)\n }\n }\n\n @Throws(BadLocationException::class) private fun calculateAbsoluteRange(content: String,\n violation: RuleViolation): Range {\n val document = Document(content)\n\n // violation line and column start at one, the marker's start and end positions at zero\n val start = getAbsolutePosition(content, document.getLineOffset(violation.beginLine - 1), violation.beginColumn)\n val end = getAbsolutePosition(content, document.getLineOffset(violation.endLine - 1), violation.endColumn)\n\n // for some rules PMD creates violations with the end position before the start position\n val range = if (start <= end) {\n Range(start - 1, end)\n } else {\n Range(end - 1, start)\n }\n\n return range\n }\n\n private fun getAbsolutePosition(content: String, lineOffset: Int, pmdCharOffset: Int): Int {\n var pmdCharCounter = 0\n var absoluteOffset = lineOffset\n while (pmdCharCounter < pmdCharOffset) {\n if (absoluteOffset < content.length) {\n val c = content[absoluteOffset]\n if (c == '\\t') {\n pmdCharCounter = (pmdCharCounter / PMD_TAB_SIZE + 1) * PMD_TAB_SIZE\n } else {\n pmdCharCounter++\n }\n } else {\n break\n }\n absoluteOffset++\n }\n return absoluteOffset\n }\n}\n\nfun IMarker.setRule(rule: String) {\n this.setAttribute(\"rule\", rule)\n}\n\nfun IMarker.getRule(): Rule {\n return SmartfoxActivator.instance.getRule(this.getAttribute(\"rule\") as String)\n}\n\nfun IMarker.getResolution(): IMarkerResolution? {\n return QuickFixGenerator.quickFixes[getRule().name]\n}\n\ndata class Range(val start: Int, val end: Int)\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/resources/messages/P3cBundle.xml",
"content": "\n\n\n 阿里编码规约扫描\n\n 切换语言至英文(English)\n 切换语言至中文\n 切换到English成功，是否重启\n 切换到中文成功，是否重启\n\n\n \n \n \n \n \n \n \n \n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/resources/messages/P3cBundle_en.xml",
"content": "\n\n\n Alibaba Coding Guidelines Analyze\n Switch language to English\n Switch language to Chinese\n\n Switch language to English success，restart?\n Switch language to Chinese success，restart?\n\n \n \n \n \n\n \n \n \n \n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/resources/rulesets/java/ali-pmd.xml",
"content": "\n\n\n \n \n \n \n \n \n \n \n \n \n \n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/resources/rulesets/java/ali-ruleOnEclipse.xml",
"content": "\n\n\n\n \n rule.standalone.MissingOverrideAnnotationRule.desc\n 1\n\n \n \n \n \n \n 1\n \n \n rule.standalone.AvoidUseDeprecationRule.desc\n 2\n \n\n \n rule.standalone.MapOrSetKeyShouldOverrideHashCodeEqualsRule.desc\n 2\n \n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.plugin/src/main/resources/syntax/java.properties",
"content": "# This file contains the syntax data for .java files\ncomment=//\nstringstart=\"\nstringend=\"\nmultilinecommentstart=/*\nmultilinecommentend=*/\npunctuation=(){};:?<>=+-*/&|~!%.[]\nkeywords=abstract assert boolean break byte case catch char class const continue do double else enum extends false final finally for if implements import int interface native new null package protected public private return static strictfp super switch synchronized this throws true try void volatile while\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.updatesite/category.xml",
"content": "\n\n \n Alibaba Java Coding Guidelines\n \n \n \n \n \n\n"
},
{
"path": "eclipse-plugin/com.alibaba.smartfox.eclipse.updatesite/pom.xml",
"content": "\n\n 4.0.0\n \n com.alibaba.smartfox.eclipse\n smartfox-eclipse\n 2.0.1-SNAPSHOT\n \n com.alibaba.smartfox.eclipse.updatesite\n eclipse-repository\n 2017\n\n"
},
{
"path": "eclipse-plugin/pom.xml",
"content": "\n\n 4.0.0\n com.alibaba.smartfox.eclipse\n smartfox-eclipse\n 2.0.1-SNAPSHOT\n pom\n 2017\n \n 1.0.0\n ${tycho.version}\n http://download.eclipse.org/releases/neon\n UTF-8\n http://download.eclipse.org/tools/ajdt/46/dev/update\n 1.3.30\n juno\n \n \n com.alibaba.smartfox.eclipse.plugin\n com.alibaba.smartfox.eclipse.feature\n com.alibaba.smartfox.eclipse.updatesite\n \n \n \n junit\n junit\n 4.11\n test\n \n \n \n \n \n org.jetbrains.kotlin\n kotlin-stdlib-jdk8\n ${kotlin.version}\n compile\n \n \n \n \n \n juno\n p2\n http://mirrors.ustc.edu.cn/eclipse/releases/juno/\n \n \n sonatype-nexus-snapshots\n Sonatype Nexus Snapshots\n https://oss.sonatype.org/content/repositories/snapshots\n \n false\n \n \n true\n \n \n \n \n \n \n org.eclipse.tycho\n tycho-maven-plugin\n ${tycho.version}\n true\n \n \n org.eclipse.tycho\n target-platform-configuration\n \n \n \n linux\n gtk\n x86\n \n \n linux\n gtk\n x86_64\n \n \n win32\n win32\n x86\n \n \n win32\n win32\n x86_64\n \n \n macosx\n cocoa\n x86_64\n \n \n \n \n \n\n \n \n \n org.eclipse.tycho\n target-platform-configuration\n ${tycho.version}\n \n \n org.eclipse.tycho\n tycho-compiler-plugin\n ${tycho.version}\n \n 1.8\n \n \n \n UTF-8\n \n -err:-forbidden\n \n \n \n org.codehaus.mojo\n aspectj-maven-plugin\n ${aspectj.plugin.version}\n \n \n org.aspectj\n aspectjtools\n ${aspectj.version}\n \n \n \n \n org.eclipse.tycho\n tycho-packaging-plugin\n ${tycho.version}\n \n \n org.eclipse.tycho\n tycho-surefire-plugin\n ${tycho.version}\n \n true\n \n \n \n org.eclipse.tycho\n tycho-source-plugin\n ${tycho.version}\n \n false\n \n \n \n org.eclipse.tycho\n tycho-p2-director-plugin\n ${tycho.version}\n \n \n org.eclipse.tycho\n tycho-p2-repository-plugin\n ${tycho.version}\n \n smartfox-eclipse-plugin\n \n \n \n org.eclipse.tycho.extras\n tycho-source-feature-plugin\n ${tycho-extras.version}\n \n \n org.eclipse.tycho.extras\n tycho-custom-bundle-plugin\n ${tycho-extras.version}\n \n \n org.eclipse.tycho\n tycho-p2-plugin\n ${tycho.version}\n \n warn\n none\n \n \n http://download.eclipse.org/eclipse/updates/4.4\n \n \n \n \n \n \n \n\n"
},
{
"path": "idea-plugin/.gitignore",
"content": "# Gradle\nbuild\n.gradle\n\ntestdata/\n# Java gitignore #\n.class\n.log\n\n# Package Files #\n\n*.war\n*.ear\n\n#hsf files\nconfiguration\n\n# maven gitignore#\ntarget/**\n\n.svn/\n\n# intelliJ.gitignore #\n.idea\n*.iml\n*.ipr\n*.iws\n\n# Eclipse git ignore#\n*.pydevproject\n.project\n.metadata\nbin/**\n*/bin/**\ntmp/**\ntmp/**/*\nconfiguration/**\n*.tmp\n*.bak\n*.orig\n*.swp\n*~.nib\n.classpath\n.settings/\n.loadpath\n.fileTable*\n.cache\n\n# External tool builders\n.externalToolBuilders/\n\n# Locally stored \"Eclipse launch configurations\"\n*.launch\n\n# CDT-specific\n.cproject\n\n# PDT-specific\n.buildpath\n\n#log\n*.log\n*.log.*\n\n# Windows Thumbs.db\n*.db\n\n# OSX\n.DS_Store\n\n# sass gitignore#\n.sass-cache\n.idea\n\n# tcc_coverage\ncoverage.ec\n\n\n\nconfig.client.*\n\ntemp/\n*.pid\n*.orig\n\nhsf.configuration/\n\n# code coverage report\n*.ec\n\n#hsf test\n*.instance\nout\n**/idea-sandbox"
},
{
"path": "idea-plugin/README.md",
"content": "# Idea Plugin \n---\n## Prepare\n- Project JDK: 1.7+\n- Gradle: 3.0+（Require JDK1.8+ for gradle）\n\n## Build\n```\ncd p3c-idea\n../gradlew clean buildPlugin\n```\n\n## Run plugin\n\n```\ncd p3c-idea\n../gradlew runIde\n# run specific IDEA\n../gradlew runIde -Pidea_version=2018.3\n```\n\n## Use p3c-common as your plugin dependency\n```groovy\ncompile 'com.alibaba.p3c.idea:p3c-common:1.0.0'\n```\n## [中文使用手册](README_cn.md)\n## Install\n### Install from repositories\n1. Settings >> Plugins >> Browse repositories... \n\n  \n\n2. Search plugin by keyword 'alibaba' then install 'Alibaba Java Coding Guidelines' plugin \n\n  \n\n3. Restart to take effect. \n### Install from local zip file.\n1. Open https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines and download the latest version zip file.\n \n2. Settings >> Plugins >> Install plugin from disk...,select the downloaded zip file in previous step then restart your idea\n \n\n## Use\n\n1. Switch language\n\n\t \n\n2. Inspections \n\n\t \n\t\n\t \n\n3. Code Analyze \n\n\t \n\t\n\tWe use the idea standard Inspection Results to show our violations. \n\t \n\t \n\t\n\tWe can also analyze file which is modified before vcs checkin. \n\t\n\t \n\n## Other\n1. [中文乱码解决方法](https://github.com/alibaba/p3c/issues/32#issuecomment-336762512)\n\n\t* Appearance&Behavior -> Appearance -> UI Options -> Name 里面设置成微软雅黑（microsoft yahei light）\n\n\t  \n \n\t* Switch Language to English and restart.\n\n\t  \n\n"
},
{
"path": "idea-plugin/README_cn.md",
"content": "> 首先非常感谢大家对插件的支持与意见，英文版的文档还是略为简单，这里详细介绍一下插件的安装使用。\n\n## 插件安装\n### 通过Jetbrains官方仓库安装\n1. 打开 Settings >> Plugins >> Browse repositories...\n\n \n \n2. 在搜索框输入alibaba即可看到Alibaba Java Code Guidelines插件，点击Install进行安装，然后重启IDE生效 `注意：因为插件zip包托管在Jetbrains官方CDN上，所以是从国外的服务器进行下载，可能会出现超时的情况`\n\n \n\n### 通过下载安装包进行安装\n1. 打开[插件](https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines)页面\n\n\n\n2. Settings >> Plugins >> Install plugin from disk...，选择刚刚下载的zip包安装，然后重启IDE\n\n \n\n\n### 注意\n\n最低支持IDEA版本为14.1（buildNumber 141.0，可以在About Intellij IDEA中查看版本信息），使用IDEA14的同学最好升级到14.1.7(历史版本传送门)\n\n插件基于JDK1.7打包，所以IDEA启动时使用的JDK版本如果是1.6的话就会报Unsupported major.minor version 51.0异常，建议大家都升级一下。\n\n### [中文乱码解决方法](https://github.com/alibaba/p3c/issues/32#issuecomment-336762512)\n\n1. 修改字体——Appearance&Behavior -> Appearance -> UI Options -> Name 里面设置成中文字体——如微软雅黑（microsoft yahei light）、文泉驿(linux)\n\n\t \n\n2. Switch Language to English and restart.\n\n\t \n\t \n\n## 插件使用\n\n目前插件实现了开发手册中的的53条规则，大部分基于PMD实现，其中有4条规则基于IDEA实现，并且基于IDEA Inspection实现了实时检测功能。部分规则实现了Quick Fix功能，对于可以提供Quick Fix但没有提供的，我们会尽快实现，也欢迎有兴趣的同学加入进来一起努力。\n目前插件检测有两种模式：实时检测、手动触发。\n\n### 实时检测\n实时检测功能会在开发过程中对当前文件进行检测，并以高亮的形式提示出来，同时也可以支持Quick Fix，该功能默认开启，可以通过配置关闭。 \n\n#### 结果高亮提示\n\n检测结果高亮提示，并且鼠标放上去会弹出提示信息。
\n\n \n\n \n\n#### Intention QuickFix功能\n\nAlt+Enter键可呼出Intention菜单，不同的规则会提示不同信息的Quick Fix按钮\n\n \n\n#### 关闭实时检测 \n在某些情况下，我们不希望对代码提示违规信息，比如我们在阅读Github开源项目代码的时候，如果界面出现一堆红色、黄色的提示，此时心里肯定是飘过一万只草泥马。这个时候我们可以通过Inspection的设置关闭实时检测功能。\n1. 通过右键快速关闭（打开）所有规则的实时检测功能\n\n \n2. 通过Settings >> Editor >> Inspections 进行手动设置 \n\n \n\n也可以关闭某条规则的实时检测功能或者修改提示级别。\n \n### 代码扫描\n\n可以通过右键菜单、Toolbar按钮、快捷键三种方式手动触发代码检测。同时结果面板中可以对部分实现了QuickFix功能的规则进行快速修复。 \n\n#### 触发扫描\n在当前编辑的文件中点击右键，可以在弹出的菜单中触发对该文件的检测。\n\n \n \n在左侧的Project目录树种点击右键，可以触发对整个工程或者选择的某个目录、文件进行检测。\n\n \n \n 如果您打开了IDE的Toolbar，也可以通过Toolbar中的按钮来触发检测，目前Toolbar的按钮触发的检测范围与您IDE当时的焦点有关，如当前编辑的文件或者是Project目录树选中的项，是不是感觉与右键菜单的检测范围类似呢。\n\n \n 使用快捷键（Ctrl+Shift+Alt+J）触发弹出窗口，选择检测范围；您也可自定义快捷键。\n\n  \n \n \n \n#### 扫描结果 \n检测结果直接使用IDEA Run Inspection By Name功能的结果界面，插件的检测结果分级为Blocker、Critical、Major。默认按等级分组，方便统计每个级别错误的数量。\n\n\n\n \n默认情况我们在结果面板需要双击具体违规项才能打开对应的源文件，开启Autoscroll To Source选项，单击面板中的文件名、或者是具体的违规项的时候IDEA会自动打开对应的源文件。\n\n \n \n#### QuickFix\n对于实现Quick Fix的规则，在结果面板中可以直接一键修复 `注意：IDEA14、15可以通过左下角的灯泡进行一键修复操作。`\n\n \n \n \n \n#### 其他\n面板中其他按钮的功能大家自行探索吧，就不一一赘述了\n\n### 代码提交时检测\n1. 在提交代码框勾选Alibaba Code Guidelines选项\n \n2. 如果有违反手册的地方会提示是否继续提交，选择取消后会自动对修改的代码进行扫描\n \n"
},
{
"path": "idea-plugin/build.gradle",
"content": "buildscript {\n repositories {\n maven {\n url \"https://oss.sonatype.org/content/repositories/snapshots/\"\n }\n maven {\n url 'http://dl.bintray.com/jetbrains/intellij-plugin-service'\n }\n mavenCentral()\n\n }\n dependencies {\n classpath \"org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version\"\n }\n}\n\nallprojects {\n group 'com.alibaba.p3c.idea'\n apply plugin: 'java'\n apply plugin: 'kotlin'\n apply plugin: 'maven-publish'\n\n sourceCompatibility = 1.8\n compileJava.options.encoding = 'UTF-8'\n configurations.all {\n resolutionStrategy.cacheChangingModulesFor 0, 'seconds'\n }\n repositories {\n jcenter()\n mavenCentral()\n }\n\n dependencies {\n compile \"org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version\"\n testCompile group: 'junit', name: 'junit', version: '4.11'\n }\n}\n\n"
},
{
"path": "idea-plugin/gradle/wrapper/gradle-wrapper.properties",
"content": "distributionBase=GRADLE_USER_HOME\ndistributionPath=wrapper/dists\ndistributionUrl=https\\://services.gradle.org/distributions/gradle-6.6-bin.zip\nzipStoreBase=GRADLE_USER_HOME\nzipStorePath=wrapper/dists\n"
},
{
"path": "idea-plugin/gradle.properties",
"content": "kotlin_version=1.3.72\nidea_version=2018.3\nplugin_name=Alibaba Java Coding Guidelines\ngradle_jetbrains_version=0.4.5\nsystemProp.file.encoding=UTF-8\n\nplugin_version=2.1.0\n"
},
{
"path": "idea-plugin/gradlew",
"content": "#!/usr/bin/env sh\n\n#\n# Copyright 2015 the original author or authors.\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# https://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n#\n\n##############################################################################\n##\n## Gradle start up script for UN*X\n##\n##############################################################################\n\n# Attempt to set APP_HOME\n# Resolve links: $0 may be a link\nPRG=\"$0\"\n# Need this for relative symlinks.\nwhile [ -h \"$PRG\" ] ; do\n ls=`ls -ld \"$PRG\"`\n link=`expr \"$ls\" : '.*-> \\(.*\\)$'`\n if expr \"$link\" : '/.*' > /dev/null; then\n PRG=\"$link\"\n else\n PRG=`dirname \"$PRG\"`\"/$link\"\n fi\ndone\nSAVED=\"`pwd`\"\ncd \"`dirname \\\"$PRG\\\"`/\" >/dev/null\nAPP_HOME=\"`pwd -P`\"\ncd \"$SAVED\" >/dev/null\n\nAPP_NAME=\"Gradle\"\nAPP_BASE_NAME=`basename \"$0\"`\n\n# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.\nDEFAULT_JVM_OPTS='\"-Xmx64m\" \"-Xms64m\"'\n\n# Use the maximum available, or set MAX_FD != -1 to use that value.\nMAX_FD=\"maximum\"\n\nwarn () {\n echo \"$*\"\n}\n\ndie () {\n echo\n echo \"$*\"\n echo\n exit 1\n}\n\n# OS specific support (must be 'true' or 'false').\ncygwin=false\nmsys=false\ndarwin=false\nnonstop=false\ncase \"`uname`\" in\n CYGWIN* )\n cygwin=true\n ;;\n Darwin* )\n darwin=true\n ;;\n MINGW* )\n msys=true\n ;;\n NONSTOP* )\n nonstop=true\n ;;\nesac\n\nCLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar\n\n\n# Determine the Java command to use to start the JVM.\nif [ -n \"$JAVA_HOME\" ] ; then\n if [ -x \"$JAVA_HOME/jre/sh/java\" ] ; then\n # IBM's JDK on AIX uses strange locations for the executables\n JAVACMD=\"$JAVA_HOME/jre/sh/java\"\n else\n JAVACMD=\"$JAVA_HOME/bin/java\"\n fi\n if [ ! -x \"$JAVACMD\" ] ; then\n die \"ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME\n\nPlease set the JAVA_HOME variable in your environment to match the\nlocation of your Java installation.\"\n fi\nelse\n JAVACMD=\"java\"\n which java >/dev/null 2>&1 || die \"ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.\n\nPlease set the JAVA_HOME variable in your environment to match the\nlocation of your Java installation.\"\nfi\n\n# Increase the maximum file descriptors if we can.\nif [ \"$cygwin\" = \"false\" -a \"$darwin\" = \"false\" -a \"$nonstop\" = \"false\" ] ; then\n MAX_FD_LIMIT=`ulimit -H -n`\n if [ $? -eq 0 ] ; then\n if [ \"$MAX_FD\" = \"maximum\" -o \"$MAX_FD\" = \"max\" ] ; then\n MAX_FD=\"$MAX_FD_LIMIT\"\n fi\n ulimit -n $MAX_FD\n if [ $? -ne 0 ] ; then\n warn \"Could not set maximum file descriptor limit: $MAX_FD\"\n fi\n else\n warn \"Could not query maximum file descriptor limit: $MAX_FD_LIMIT\"\n fi\nfi\n\n# For Darwin, add options to specify how the application appears in the dock\nif $darwin; then\n GRADLE_OPTS=\"$GRADLE_OPTS \\\"-Xdock:name=$APP_NAME\\\" \\\"-Xdock:icon=$APP_HOME/media/gradle.icns\\\"\"\nfi\n\n# For Cygwin or MSYS, switch paths to Windows format before running java\nif [ \"$cygwin\" = \"true\" -o \"$msys\" = \"true\" ] ; then\n APP_HOME=`cygpath --path --mixed \"$APP_HOME\"`\n CLASSPATH=`cygpath --path --mixed \"$CLASSPATH\"`\n \n JAVACMD=`cygpath --unix \"$JAVACMD\"`\n\n # We build the pattern for arguments to be converted via cygpath\n ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`\n SEP=\"\"\n for dir in $ROOTDIRSRAW ; do\n ROOTDIRS=\"$ROOTDIRS$SEP$dir\"\n SEP=\"|\"\n done\n OURCYGPATTERN=\"(^($ROOTDIRS))\"\n # Add a user-defined pattern to the cygpath arguments\n if [ \"$GRADLE_CYGPATTERN\" != \"\" ] ; then\n OURCYGPATTERN=\"$OURCYGPATTERN|($GRADLE_CYGPATTERN)\"\n fi\n # Now convert the arguments - kludge to limit ourselves to /bin/sh\n i=0\n for arg in \"$@\" ; do\n CHECK=`echo \"$arg\"|egrep -c \"$OURCYGPATTERN\" -`\n CHECK2=`echo \"$arg\"|egrep -c \"^-\"` ### Determine if an option\n\n if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition\n eval `echo args$i`=`cygpath --path --ignore --mixed \"$arg\"`\n else\n eval `echo args$i`=\"\\\"$arg\\\"\"\n fi\n i=`expr $i + 1`\n done\n case $i in\n 0) set -- ;;\n 1) set -- \"$args0\" ;;\n 2) set -- \"$args0\" \"$args1\" ;;\n 3) set -- \"$args0\" \"$args1\" \"$args2\" ;;\n 4) set -- \"$args0\" \"$args1\" \"$args2\" \"$args3\" ;;\n 5) set -- \"$args0\" \"$args1\" \"$args2\" \"$args3\" \"$args4\" ;;\n 6) set -- \"$args0\" \"$args1\" \"$args2\" \"$args3\" \"$args4\" \"$args5\" ;;\n 7) set -- \"$args0\" \"$args1\" \"$args2\" \"$args3\" \"$args4\" \"$args5\" \"$args6\" ;;\n 8) set -- \"$args0\" \"$args1\" \"$args2\" \"$args3\" \"$args4\" \"$args5\" \"$args6\" \"$args7\" ;;\n 9) set -- \"$args0\" \"$args1\" \"$args2\" \"$args3\" \"$args4\" \"$args5\" \"$args6\" \"$args7\" \"$args8\" ;;\n esac\nfi\n\n# Escape application args\nsave () {\n for i do printf %s\\\\n \"$i\" | sed \"s/'/'\\\\\\\\''/g;1s/^/'/;\\$s/\\$/' \\\\\\\\/\" ; done\n echo \" \"\n}\nAPP_ARGS=`save \"$@\"`\n\n# Collect all arguments for the java command, following the shell quoting and substitution rules\neval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS \"\\\"-Dorg.gradle.appname=$APP_BASE_NAME\\\"\" -classpath \"\\\"$CLASSPATH\\\"\" org.gradle.wrapper.GradleWrapperMain \"$APP_ARGS\"\n\nexec \"$JAVACMD\" \"$@\"\n"
},
{
"path": "idea-plugin/gradlew.bat",
"content": "@rem\n@rem Copyright 2015 the original author or authors.\n@rem\n@rem Licensed under the Apache License, Version 2.0 (the \"License\");\n@rem you may not use this file except in compliance with the License.\n@rem You may obtain a copy of the License at\n@rem\n@rem https://www.apache.org/licenses/LICENSE-2.0\n@rem\n@rem Unless required by applicable law or agreed to in writing, software\n@rem distributed under the License is distributed on an \"AS IS\" BASIS,\n@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n@rem See the License for the specific language governing permissions and\n@rem limitations under the License.\n@rem\n\n@if \"%DEBUG%\" == \"\" @echo off\n@rem ##########################################################################\n@rem\n@rem Gradle startup script for Windows\n@rem\n@rem ##########################################################################\n\n@rem Set local scope for the variables with windows NT shell\nif \"%OS%\"==\"Windows_NT\" setlocal\n\nset DIRNAME=%~dp0\nif \"%DIRNAME%\" == \"\" set DIRNAME=.\nset APP_BASE_NAME=%~n0\nset APP_HOME=%DIRNAME%\n\n@rem Resolve any \".\" and \"..\" in APP_HOME to make it shorter.\nfor %%i in (\"%APP_HOME%\") do set APP_HOME=%%~fi\n\n@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.\nset DEFAULT_JVM_OPTS=\"-Xmx64m\" \"-Xms64m\"\n\n@rem Find java.exe\nif defined JAVA_HOME goto findJavaFromJavaHome\n\nset JAVA_EXE=java.exe\n%JAVA_EXE% -version >NUL 2>&1\nif \"%ERRORLEVEL%\" == \"0\" goto init\n\necho.\necho ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.\necho.\necho Please set the JAVA_HOME variable in your environment to match the\necho location of your Java installation.\n\ngoto fail\n\n:findJavaFromJavaHome\nset JAVA_HOME=%JAVA_HOME:\"=%\nset JAVA_EXE=%JAVA_HOME%/bin/java.exe\n\nif exist \"%JAVA_EXE%\" goto init\n\necho.\necho ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%\necho.\necho Please set the JAVA_HOME variable in your environment to match the\necho location of your Java installation.\n\ngoto fail\n\n:init\n@rem Get command-line arguments, handling Windows variants\n\nif not \"%OS%\" == \"Windows_NT\" goto win9xME_args\n\n:win9xME_args\n@rem Slurp the command line arguments.\nset CMD_LINE_ARGS=\nset _SKIP=2\n\n:win9xME_args_slurp\nif \"x%~1\" == \"x\" goto execute\n\nset CMD_LINE_ARGS=%*\n\n:execute\n@rem Setup the command line\n\nset CLASSPATH=%APP_HOME%\\gradle\\wrapper\\gradle-wrapper.jar\n\n\n@rem Execute Gradle\n\"%JAVA_EXE%\" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% \"-Dorg.gradle.appname=%APP_BASE_NAME%\" -classpath \"%CLASSPATH%\" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%\n\n:end\n@rem End local scope for the variables with windows NT shell\nif \"%ERRORLEVEL%\"==\"0\" goto mainEnd\n\n:fail\nrem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of\nrem the _cmd.exe /c_ return code!\nif not \"\" == \"%GRADLE_EXIT_CONSOLE%\" exit 1\nexit /b 1\n\n:mainEnd\nif \"%OS%\"==\"Windows_NT\" endlocal\n\n:omega\n"
},
{
"path": "idea-plugin/p3c-common/build.gradle",
"content": "plugins {\n id \"org.jetbrains.intellij\" version '0.4.5'\n}\napply plugin: 'kotlin'\napply plugin: 'idea'\napply plugin: 'maven'\napply plugin: 'signing'\n\njavadoc {\n options.tags = [\"date\"]\n}\n\ntask javadocJar(type: Jar, dependsOn: javadoc) {\n classifier = 'javadoc'\n from 'build/docs/javadoc'\n}\n\ntask sourcesJar(type: Jar) {\n classifier = 'sources'\n from sourceSets.main.allSource\n}\n\nartifacts {\n archives jar\n archives javadocJar\n archives sourcesJar\n}\n\ndef myPlugins = []\ndef versionDotIndex = idea_version.indexOf('.')\ndef intVersion = versionDotIndex == -1 ? Integer.parseInt(idea_version) : Integer.parseInt(idea_version.substring(0, versionDotIndex))\nif (intVersion >= 2019 || (intVersion < 1000 && intVersion >= 193)) {\n myPlugins = ['java']\n}\n\nintellij {\n version idea_version\n plugins = myPlugins\n pluginName plugin_name\n updateSinceUntilBuild false\n sandboxDirectory \"$project.buildDir/idea-sandbox/$idea_version\"\n}\nversion '2.0.1'\n\next.isReleaseVersion = !version.endsWith(\"SNAPSHOT\")\n\ndependencies {\n compile group: 'org.freemarker', name: 'freemarker', version: '2.3.25-incubating'\n compile 'com.alibaba.p3c:p3c-pmd:2.1.0'\n compile group: 'org.javassist', name: 'javassist', version: '3.21.0-GA'\n}\n\nuploadArchives {\n repositories {\n mavenDeployer {\n beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }\n\n repository(url: \"https://oss.sonatype.org/service/local/staging/deploy/maven2/\") {\n authentication(userName: findProperty('ossrhUsername'), password: findProperty('ossrhPassword'))\n }\n\n snapshotRepository(url: \"https://oss.sonatype.org/content/repositories/snapshots/\") {\n authentication(userName: findProperty('ossrhUsername'), password: findProperty('ossrhPassword'))\n }\n\n pom.project {\n name 'p3c-common'\n packaging 'jar'\n description 'P3c Idea Plugin Common.'\n url 'https://github.com/alibaba/p3c'\n\n scm {\n url 'https://github.com/alibaba/p3c'\n connection 'scm:git:https://git@github.com/alibaba/p3c.git'\n }\n\n licenses {\n license {\n name 'The Apache Software License, Version 2.0'\n url 'http://www.apache.org/licenses/LICENSE-2.0.txt'\n distribution 'repo'\n }\n }\n\n developers {\n developer {\n id 'junlie'\n name 'Junlie'\n email 'sean.caikang@gmail.com'\n }\n developer {\n id 'ZengHou'\n name 'ZengHou'\n email 'fengwei1983@gmail.com'\n }\n }\n }\n }\n }\n}\n\nsigning {\n required {\n isReleaseVersion && gradle.taskGraph.hasTask(\"uploadArchives\")\n }\n sign configurations.archives\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/java/icons/P3cIcons.java",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage icons;\n\nimport javax.swing.Icon;\n\nimport com.intellij.openapi.util.IconLoader;\n\n/**\n * @author caikang\n * @date 2016/12/28\n */\npublic final class P3cIcons {\n private P3cIcons() {\n throw new AssertionError(\"icons.P3cIcons\"\n + \" instances for you!\");\n }\n\n public static final Icon ANALYSIS_ACTION = IconLoader.getIcon(\"/icons/ali-ide-run.png\");\n\n public static final Icon PROJECT_INSPECTION_ON = IconLoader.getIcon(\"/icons/qiyong.png\");\n public static final Icon PROJECT_INSPECTION_OFF = IconLoader.getIcon(\"/icons/tingyong.png\");\n public static final Icon LANGUAGE = IconLoader.getIcon(\"/icons/language.png\");\n public static final Icon ALIBABA = IconLoader.getIcon(\"/icons/alibaba.png\");\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/action/AliInspectionAction.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.action\n\nimport com.alibaba.p3c.idea.compatible.inspection.InspectionProfileService\nimport com.alibaba.p3c.idea.compatible.inspection.Inspections\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.inspection.AliBaseInspection\nimport com.alibaba.p3c.idea.util.NumberConstants\nimport com.google.common.collect.Lists\nimport com.intellij.analysis.AnalysisScope\nimport com.intellij.analysis.AnalysisUIOptions\nimport com.intellij.analysis.BaseAnalysisActionDialog\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.InspectionsBundle\nimport com.intellij.codeInspection.ex.GlobalInspectionContextImpl\nimport com.intellij.codeInspection.ex.InspectionManagerEx\nimport com.intellij.codeInspection.ex.InspectionToolWrapper\nimport com.intellij.openapi.actionSystem.AnAction\nimport com.intellij.openapi.actionSystem.AnActionEvent\nimport com.intellij.openapi.actionSystem.CommonDataKeys\nimport com.intellij.openapi.components.ServiceManager\nimport com.intellij.openapi.diagnostic.Logger\nimport com.intellij.openapi.module.Module\nimport com.intellij.openapi.module.ModuleUtilCore\nimport com.intellij.openapi.project.Project\nimport com.intellij.openapi.vfs.VfsUtilCore\nimport com.intellij.openapi.vfs.VirtualFile\nimport com.intellij.openapi.wm.ToolWindowId\nimport com.intellij.openapi.wm.ToolWindowManager\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiFile\nimport com.intellij.psi.PsiFileSystemItem\nimport com.intellij.psi.PsiManager\nimport java.awt.event.KeyEvent\n\n/**\n * @author caikang\n * @date 2016/12/11\n */\nclass AliInspectionAction : AnAction() {\n\n override fun actionPerformed(e: AnActionEvent) {\n val project = e.project ?: return\n val analysisUIOptions = ServiceManager.getService(project, AnalysisUIOptions::class.java)!!\n analysisUIOptions.GROUP_BY_SEVERITY = true\n\n val managerEx = InspectionManager.getInstance(project) as InspectionManagerEx\n val toolWrappers = Inspections.aliInspections(project) {\n it.tool is AliBaseInspection\n }\n val psiElement = e.getData(CommonDataKeys.PSI_ELEMENT)\n val psiFile = e.getData(CommonDataKeys.PSI_FILE)\n val virtualFile = e.getData(CommonDataKeys.VIRTUAL_FILE)\n val virtualFiles = e.getData>(CommonDataKeys.VIRTUAL_FILE_ARRAY)\n var analysisScope: AnalysisScope? = null\n var projectDir = false\n if (psiFile != null) {\n analysisScope = AnalysisScope(psiFile)\n projectDir = isBaseDir(psiFile.virtualFile, project)\n } else if (virtualFiles != null && virtualFiles.size > NumberConstants.INTEGER_SIZE_OR_LENGTH_0) {\n analysisScope = AnalysisScope(project, Lists.newArrayList(*virtualFiles))\n projectDir = virtualFiles.any {\n isBaseDir(it, project)\n }\n } else {\n if (virtualFile != null && virtualFile.isDirectory) {\n val psiDirectory = PsiManager.getInstance(project).findDirectory(virtualFile)\n if (psiDirectory != null) {\n analysisScope = AnalysisScope(psiDirectory)\n projectDir = isBaseDir(virtualFile, project)\n }\n }\n if (analysisScope == null && virtualFile != null) {\n analysisScope = AnalysisScope(project, listOf(virtualFile))\n projectDir = isBaseDir(virtualFile, project)\n }\n if (analysisScope == null) {\n projectDir = true\n analysisScope = AnalysisScope(project)\n }\n }\n if (e.inputEvent is KeyEvent) {\n inspectForKeyEvent(project, managerEx, toolWrappers, psiElement, psiFile, virtualFile, analysisScope)\n return\n }\n val element = psiFile ?: psiElement\n analysisScope.isIncludeTestSource = false\n analysisScope.setSearchInLibraries(true)\n createContext(\n toolWrappers, managerEx, element,\n projectDir, analysisScope\n ).doInspections(analysisScope)\n }\n\n private fun isBaseDir(file: VirtualFile, project: Project): Boolean {\n if (file.canonicalPath == null || project.basePath == null) {\n return false\n }\n return project.basePath == file.canonicalPath\n }\n\n private fun inspectForKeyEvent(\n project: Project, managerEx: InspectionManagerEx,\n toolWrappers: List>, psiElement: PsiElement?, psiFile: PsiFile?,\n virtualFile: VirtualFile?, analysisScope: AnalysisScope\n ) {\n var module: Module? = null\n if (virtualFile != null && project.baseDir != virtualFile) {\n module = ModuleUtilCore.findModuleForFile(virtualFile, project)\n }\n\n val uiOptions = AnalysisUIOptions.getInstance(project)\n uiOptions.ANALYZE_TEST_SOURCES = false\n val dialog = BaseAnalysisActionDialog(\n \"Select Analyze Scope\", \"Analyze Scope\", project, analysisScope,\n module?.name, true, uiOptions, psiElement\n )\n\n if (!dialog.showAndGet()) {\n return\n }\n val scope = dialog.getScope(uiOptions, analysisScope, project, module)\n scope.setSearchInLibraries(true)\n val element = psiFile ?: psiElement\n createContext(\n toolWrappers, managerEx, element,\n dialog.isProjectScopeSelected, scope\n ).doInspections(scope)\n }\n\n override fun update(e: AnActionEvent) {\n e.presentation.text = P3cBundle.getMessage(\"com.alibaba.p3c.idea.action.AliInspectionAction.text\")\n }\n\n companion object {\n private val logger = Logger.getInstance(AliInspectionAction::class.java)\n\n private fun getTitle(element: PsiElement?, isProjectScopeSelected: Boolean): String? {\n if (element == null) {\n return null\n }\n if (isProjectScopeSelected) {\n return \"Project\"\n }\n if (element is PsiFileSystemItem) {\n return VfsUtilCore.getRelativePath(element.virtualFile, element.project.baseDir)\n }\n return null\n }\n\n fun createContext(\n toolWrapperList: List>,\n managerEx: InspectionManagerEx, psiElement: PsiElement?,\n projectScopeSelected: Boolean, scope: AnalysisScope\n ):\n GlobalInspectionContextImpl {\n // remove last same scope content\n val project = managerEx.project\n val title = getTitle(psiElement, projectScopeSelected)\n val model = InspectionProfileService.createSimpleProfile(toolWrapperList, managerEx, psiElement)\n title?.let {\n model.name = it\n }\n\n val inspectionContext = createNewGlobalContext(\n managerEx, projectScopeSelected\n )\n InspectionProfileService.setExternalProfile(model, inspectionContext)\n\n val toolWindow = ToolWindowManager.getInstance(project).getToolWindow(ToolWindowId.INSPECTION)\n\n if (toolWindow != null) {\n val contentManager = toolWindow.contentManager\n val contentTitle = title?.let {\n InspectionsBundle.message(\"inspection.results.for.profile.toolwindow.title\", it, scope.shortenName)\n }\n val content = contentManager.contents.firstOrNull {\n contentTitle != null && (it.tabName == contentTitle || it.tabName.endsWith(contentTitle))\n }\n content?.let {\n contentManager.removeContent(content, true)\n }\n }\n\n return inspectionContext\n }\n\n private fun createNewGlobalContext(\n managerEx: InspectionManagerEx,\n projectScopeSelected: Boolean\n ): GlobalInspectionContextImpl {\n return PmdGlobalInspectionContextImpl(managerEx.project, managerEx.contentManager, projectScopeSelected)\n }\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/action/PmdGlobalInspectionContextImpl.kt",
"content": "package com.alibaba.p3c.idea.action\n\nimport com.alibaba.p3c.idea.component.AliProjectComponent\nimport com.alibaba.p3c.idea.ep.InspectionActionExtensionPoint\nimport com.alibaba.p3c.idea.inspection.AliLocalInspectionToolProvider\nimport com.alibaba.p3c.idea.inspection.PmdRuleInspectionIdentify\nimport com.alibaba.p3c.idea.pmd.AliPmdProcessor\nimport com.intellij.analysis.AnalysisScope\nimport com.intellij.codeInsight.daemon.ProblemHighlightFilter\nimport com.intellij.codeInsight.daemon.impl.DaemonProgressIndicator\nimport com.intellij.codeInspection.ex.GlobalInspectionContextImpl\nimport com.intellij.codeInspection.ui.InspectionResultsView\nimport com.intellij.concurrency.JobLauncher\nimport com.intellij.concurrency.JobLauncherImpl\nimport com.intellij.concurrency.SensitiveProgressWrapper\nimport com.intellij.diagnostic.ThreadDumper\nimport com.intellij.openapi.application.ApplicationManager\nimport com.intellij.openapi.application.ReadAction\nimport com.intellij.openapi.application.ex.ApplicationManagerEx\nimport com.intellij.openapi.diagnostic.Logger\nimport com.intellij.openapi.editor.Document\nimport com.intellij.openapi.progress.ProcessCanceledException\nimport com.intellij.openapi.progress.ProgressIndicator\nimport com.intellij.openapi.progress.ProgressIndicatorProvider\nimport com.intellij.openapi.progress.ProgressManager\nimport com.intellij.openapi.progress.Task.Backgroundable\nimport com.intellij.openapi.progress.impl.CoreProgressManager\nimport com.intellij.openapi.progress.util.ProgressIndicatorUtils\nimport com.intellij.openapi.project.DumbService\nimport com.intellij.openapi.project.Project\nimport com.intellij.openapi.project.displayUrlRelativeToProject\nimport com.intellij.openapi.project.isProjectOrWorkspaceFile\nimport com.intellij.openapi.roots.FileIndex\nimport com.intellij.openapi.roots.ProjectRootManager\nimport com.intellij.openapi.util.Disposer\nimport com.intellij.openapi.util.EmptyRunnable\nimport com.intellij.openapi.util.NotNullLazyValue\nimport com.intellij.openapi.vfs.VirtualFile\nimport com.intellij.psi.PsiBinaryFile\nimport com.intellij.psi.PsiDocumentManager\nimport com.intellij.psi.PsiFile\nimport com.intellij.psi.PsiManager\nimport com.intellij.psi.SingleRootFileViewProvider\nimport com.intellij.psi.search.LocalSearchScope\nimport com.intellij.psi.search.SearchScope\nimport com.intellij.psi.util.PsiUtilCore\nimport com.intellij.ui.content.ContentManager\nimport com.intellij.util.ExceptionUtil\nimport com.intellij.util.IncorrectOperationException\nimport com.intellij.util.Processor\nimport com.intellij.util.ReflectionUtil\nimport com.intellij.util.containers.ContainerUtil\nimport gnu.trove.THashSet\nimport net.sourceforge.pmd.RuleViolation\nimport java.util.Queue\nimport java.util.concurrent.ArrayBlockingQueue\nimport java.util.concurrent.BlockingQueue\nimport java.util.concurrent.Future\nimport java.util.concurrent.LinkedBlockingQueue\nimport java.util.concurrent.TimeUnit.SECONDS\n\n/**\n * @date 2020/06/19\n * @author caikang\n */\nclass PmdGlobalInspectionContextImpl(\n project: Project,\n contentManager: NotNullLazyValue,\n private val projectScopeSelected: Boolean\n) :\n GlobalInspectionContextImpl(project, contentManager) {\n\n private val logger = Logger.getInstance(PmdGlobalInspectionContextImpl::class.java)\n\n override fun runTools(scope: AnalysisScope, runGlobalToolsOnly: Boolean, isOfflineInspections: Boolean) {\n val usedTools = usedTools\n val hasPmdTools = usedTools.any {\n it.tool.tool is PmdRuleInspectionIdentify\n }\n if (hasPmdTools) {\n val progressIndicator =\n ProgressIndicatorProvider.getGlobalProgressIndicator()\n ?: throw IncorrectOperationException(\"Must be run under progress\")\n pmdNodeWarmUp(scope, progressIndicator, isOfflineInspections)\n }\n super.runTools(scope, runGlobalToolsOnly, isOfflineInspections)\n if (myProgressIndicator.isCanceled) {\n return\n }\n InspectionActionExtensionPoint.extension.extensions.forEach {\n try {\n it.doOnInspectionFinished(this, projectScopeSelected)\n } catch (e: Exception) {\n logger.warn(e)\n }\n }\n }\n\n private fun pmdNodeWarmUp(\n scope: AnalysisScope,\n progressIndicator: ProgressIndicator,\n isOfflineInspections: Boolean\n ) {\n val aliProjectComponent = project.getComponent(AliProjectComponent::class.java)\n // run pmd inspection\n val processor = Processor { file: PsiFile ->\n ProgressManager.checkCanceled()\n val readActionSuccess =\n DumbService.getInstance(project).tryRunReadActionInSmartMode(\n {\n if (!file.isValid) {\n return@tryRunReadActionInSmartMode true\n }\n val virtualFile = file.virtualFile\n if (!scope.contains(virtualFile)) {\n logger.info(file.name + \"; scope: \" + scope + \"; \" + virtualFile)\n return@tryRunReadActionInSmartMode true\n }\n val path = virtualFile.canonicalPath?.toLowerCase() ?: \"\"\n if (!path.endsWith(\".java\") && !path.endsWith(\".vm\")) {\n return@tryRunReadActionInSmartMode true\n }\n doPmdProcess(file, aliProjectComponent, virtualFile)\n true\n }, \"Inspect code is not available until indices are ready\"\n )\n if (readActionSuccess == null || !readActionSuccess) {\n throw ProcessCanceledException()\n }\n true\n }\n val headlessEnvironment = ApplicationManager.getApplication().isHeadlessEnvironment\n val searchScope =\n ApplicationManager.getApplication().runReadAction { scope.toSearchScope() }\n val localScopeFiles: MutableSet? = if (searchScope is LocalSearchScope) THashSet() else null\n val filesToInspect: BlockingQueue = ArrayBlockingQueue(1000)\n val iteratingIndicator: ProgressIndicator = SensitiveProgressWrapper(progressIndicator)\n val future: Future<*> = startIterateScopeInBackground(\n scope,\n localScopeFiles,\n headlessEnvironment,\n filesToInspect,\n iteratingIndicator\n ) as Future<*>\n val dependentIndicators =\n ReflectionUtil.getField(javaClass, this, List::class.java, \"dependentIndicators\")?.map {\n it as ProgressIndicator\n }?.toMutableList()\n try {\n val filesFailedToInspect: Queue = LinkedBlockingQueue()\n while (true) {\n val disposable = Disposer.newDisposable()\n val wrapper: ProgressIndicator = DaemonProgressIndicator()\n dependentIndicators?.let {\n it.add(wrapper)\n }\n try {\n // avoid \"attach listener\"/\"write action\" race\n ApplicationManager.getApplication().runReadAction {\n wrapper.start()\n ProgressIndicatorUtils.forceWriteActionPriority(wrapper, disposable)\n // there is a chance we are racing with write action, in which case just registered listener might not be called, retry.\n if (ApplicationManagerEx.getApplicationEx().isWriteActionPending) {\n throw ProcessCanceledException()\n }\n }\n // use wrapper here to cancel early when write action start but do not affect the original indicator\n (JobLauncher.getInstance() as JobLauncherImpl).processQueue(\n filesToInspect,\n filesFailedToInspect,\n wrapper,\n PsiUtilCore.NULL_PSI_FILE,\n processor\n )\n break\n } catch (e: ProcessCanceledException) {\n progressIndicator.checkCanceled()\n assert(\n isOfflineInspections || !ApplicationManager.getApplication().isReadAccessAllowed\n ) {\n \"\"\"\n Must be outside read action. PCE=\n ${ExceptionUtil.getThrowableText(e)}\n \"\"\".trimIndent()\n }\n assert(\n isOfflineInspections || !ApplicationManager.getApplication().isDispatchThread\n ) {\n \"\"\"\n Must be outside EDT. PCE=\n ${ExceptionUtil.getThrowableText(e)}\n \"\"\".trimIndent()\n }\n\n // wait for write action to complete\n ApplicationManager.getApplication().runReadAction(EmptyRunnable.getInstance())\n } finally {\n dependentIndicators?.let {\n it.remove(wrapper)\n }\n Disposer.dispose(disposable)\n }\n }\n } finally {\n iteratingIndicator.cancel() // tell file scanning thread to stop\n filesToInspect.clear() // let file scanning thread a chance to put TOMBSTONE and complete\n try {\n future[30, SECONDS]\n } catch (e: java.lang.Exception) {\n logger.error(\n \"\"\"\n Thread dump: \n ${ThreadDumper.dumpThreadsToString()}\n \"\"\".trimIndent(), e\n )\n }\n }\n ProgressManager.checkCanceled()\n }\n\n private fun startIterateScopeInBackground(\n scope: AnalysisScope,\n localScopeFiles: MutableCollection?,\n headlessEnvironment: Boolean,\n outFilesToInspect: BlockingQueue,\n progressIndicator: ProgressIndicator\n ): Future<*>? {\n val task: Backgroundable = object : Backgroundable(project, \"Scanning Files to Inspect\") {\n override fun run(indicator: ProgressIndicator) {\n try {\n val fileIndex: FileIndex = ProjectRootManager.getInstance(project).fileIndex\n scope.accept { file: VirtualFile? ->\n ProgressManager.checkCanceled()\n if (isProjectOrWorkspaceFile(file!!) || !fileIndex.isInContent(file)) return@accept true\n val psiFile =\n ReadAction.compute {\n if (project.isDisposed) throw ProcessCanceledException()\n val psi = PsiManager.getInstance(project).findFile(file)\n val document =\n psi?.let { shouldProcess(it, headlessEnvironment, localScopeFiles) }\n if (document != null) {\n return@compute psi\n }\n null\n }\n // do not inspect binary files\n if (psiFile != null) {\n try {\n check(!ApplicationManager.getApplication().isReadAccessAllowed) { \"Must not have read action\" }\n outFilesToInspect.put(psiFile)\n } catch (e: InterruptedException) {\n logger.error(e)\n }\n }\n ProgressManager.checkCanceled()\n true\n }\n } catch (e: ProcessCanceledException) {\n // ignore, but put tombstone\n } finally {\n try {\n outFilesToInspect.put(PsiUtilCore.NULL_PSI_FILE)\n } catch (e: InterruptedException) {\n logger.error(e)\n }\n }\n }\n }\n return (ProgressManager.getInstance() as CoreProgressManager).runProcessWithProgressAsynchronously(\n task,\n progressIndicator,\n null\n )\n }\n\n private fun shouldProcess(\n file: PsiFile,\n headlessEnvironment: Boolean,\n localScopeFiles: MutableCollection?\n ): Document? {\n val virtualFile = file.virtualFile ?: return null\n if (isBinary(file)) return null //do not inspect binary files\n if (isViewClosed && !headlessEnvironment) {\n throw ProcessCanceledException()\n }\n if (logger.isDebugEnabled) {\n logger.debug(\"Running local inspections on \" + virtualFile.path)\n }\n if (SingleRootFileViewProvider.isTooLargeForIntelligence(virtualFile)) return null\n if (localScopeFiles != null && !localScopeFiles.add(virtualFile)) return null\n return if (!ProblemHighlightFilter.shouldProcessFileInBatch(file)) null else PsiDocumentManager.getInstance(\n project\n ).getDocument(file)\n }\n\n private fun isBinary(file: PsiFile): Boolean {\n return file is PsiBinaryFile || file.fileType.isBinary\n }\n\n private fun doPmdProcess(\n file: PsiFile,\n aliProjectComponent: AliProjectComponent,\n virtualFile: VirtualFile\n ) {\n val url: String = displayUrlRelativeToProject(\n virtualFile,\n virtualFile.presentableUrl,\n project,\n true,\n false\n )\n myProgressIndicator.text = \"PMD Process in $url\"\n val violations =\n AliPmdProcessor(AliLocalInspectionToolProvider.getRuleSets()).processFile(\n file,\n false\n )\n val fileContext = aliProjectComponent.getFileContext(virtualFile)\n fileContext?.let { fc ->\n val ruleViolations = ContainerUtil.createConcurrentSoftValueMap>()\n for (entry in violations.groupBy {\n it.rule.name\n }) {\n ruleViolations[entry.key] = entry.value\n }\n fc.ruleViolations = ruleViolations\n }\n }\n\n override fun close(noSuspiciousCodeFound: Boolean) {\n super.close(noSuspiciousCodeFound)\n InspectionActionExtensionPoint.extension.extensions.forEach {\n try {\n it.doOnClose(noSuspiciousCodeFound, project)\n } catch (e: Exception) {\n logger.warn(e)\n }\n }\n }\n\n override fun addView(view: InspectionResultsView) {\n super.addView(view)\n InspectionActionExtensionPoint.extension.extensions.forEach {\n try {\n it.doOnView(view)\n } catch (e: Exception) {\n logger.warn(e)\n }\n }\n }\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/action/SwitchLanguageAction.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.action\n\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.smartfox.idea.common.util.BalloonNotifications\nimport com.alibaba.smartfox.idea.common.util.getService\nimport com.intellij.notification.NotificationListener\nimport com.intellij.openapi.actionSystem.AnAction\nimport com.intellij.openapi.actionSystem.AnActionEvent\nimport com.intellij.openapi.application.ex.ApplicationManagerEx\nimport com.intellij.openapi.project.DumbAware\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/20\n */\nclass SwitchLanguageAction : AnAction(), DumbAware {\n private val p3cConfig = P3cConfig::class.java.getService()\n\n private val textKey = \"com.alibaba.p3c.action.switch_language.text\"\n\n override fun actionPerformed(e: AnActionEvent) {\n p3cConfig.toggleLanguage()\n BalloonNotifications.showSuccessNotification(P3cBundle.getMessage(\"$textKey.success\"), e.project,\n NotificationListener { notification, _ ->\n notification.expire()\n ApplicationManagerEx.getApplicationEx().restart(false)\n }, sticky = true)\n }\n\n override fun update(e: AnActionEvent) {\n e.presentation.text = P3cBundle.getMessage(\"$textKey.cur_${p3cConfig.locale}\")\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/action/ToggleProjectInspectionAction.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.action\n\nimport com.alibaba.p3c.idea.compatible.inspection.InspectionProfileService\nimport com.alibaba.p3c.idea.compatible.inspection.Inspections\nimport com.alibaba.p3c.idea.config.SmartFoxProjectConfig\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.inspection.AliBaseInspection\nimport com.intellij.openapi.actionSystem.AnAction\nimport com.intellij.openapi.actionSystem.AnActionEvent\nimport com.intellij.openapi.components.ServiceManager\nimport icons.P3cIcons\n\n/**\n *\n * Open or close inspections\n * @author caikang\n * @date 2017/03/14\n4\n */\nclass ToggleProjectInspectionAction : AnAction() {\n val textKey = \"com.alibaba.p3c.idea.action.ToggleProjectInspectionAction.text\"\n\n override fun actionPerformed(e: AnActionEvent) {\n val project = e.project ?: return\n val smartFoxConfig = ServiceManager.getService(project, SmartFoxProjectConfig::class.java)\n val tools = Inspections.aliInspections(project) {\n it.tool is AliBaseInspection\n }\n InspectionProfileService.toggleInspection(project, tools, smartFoxConfig.projectInspectionClosed)\n smartFoxConfig.projectInspectionClosed = !smartFoxConfig.projectInspectionClosed\n }\n\n override fun update(e: AnActionEvent) {\n val project = e.project ?: return\n val smartFoxConfig = ServiceManager.getService(project, SmartFoxProjectConfig::class.java)\n e.presentation.text = if (smartFoxConfig.projectInspectionClosed) {\n e.presentation.icon = P3cIcons.PROJECT_INSPECTION_ON\n P3cBundle.getMessage(\"$textKey.open\")\n } else {\n e.presentation.icon = P3cIcons.PROJECT_INSPECTION_OFF\n P3cBundle.getMessage(\"$textKey.close\")\n }\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/compatible/inspection/InspectionProfileService.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.compatible.inspection\n\nimport com.alibaba.smartfox.idea.common.util.PluginVersions\nimport com.google.common.collect.Sets\nimport com.intellij.codeInspection.ex.GlobalInspectionContextImpl\nimport com.intellij.codeInspection.ex.InspectionManagerEx\nimport com.intellij.codeInspection.ex.InspectionProfileImpl\nimport com.intellij.codeInspection.ex.InspectionToolWrapper\nimport com.intellij.openapi.project.Project\nimport com.intellij.openapi.util.InvalidDataException\nimport com.intellij.openapi.util.WriteExternalException\nimport com.intellij.profile.codeInspection.InspectionProjectProfileManager\nimport com.intellij.psi.PsiElement\nimport org.jdom.Element\nimport java.util.LinkedHashSet\n\n/**\n *\n *\n * @author caikang\n * @date 2017/03/01\n */\nobject InspectionProfileService {\n fun createSimpleProfile(toolWrapperList: List>,\n managerEx: InspectionManagerEx, psiElement: PsiElement?): InspectionProfileImpl {\n val profile = getProjectInspectionProfile(managerEx.project)\n val allWrappers: LinkedHashSet> = Sets.newLinkedHashSet()\n allWrappers.addAll(toolWrapperList)\n val forCompile = allWrappers\n for (toolWrapper in allWrappers) {\n profile.collectDependentInspections(toolWrapper, forCompile, managerEx.project)\n }\n val model = when (PluginVersions.baseVersion) {\n in PluginVersions.baseVersion171..Int.MAX_VALUE -> {\n val clz = Class.forName(\"com.intellij.codeInspection.ex.InspectionProfileKt\")\n val method = clz.methods.first { it.name == \"createSimple\" }\n method.invoke(null, \"Alibaba Coding Guidelines\", managerEx.project, allWrappers.toList())\n as InspectionProfileImpl\n }\n PluginVersions.baseVersion163 -> {\n val method = profile.javaClass.methods.first {\n it.name == \"createSimple\"\n }\n method.invoke(null, \"Alibaba Coding Guidelines\", managerEx.project, allWrappers.toList())\n as InspectionProfileImpl\n }\n else -> {\n val method = profile.javaClass.methods.first {\n it.name == \"createSimple\"\n }\n method.invoke(null, \"Alibaba Coding Guidelines\", managerEx.project, allWrappers.toTypedArray())\n as InspectionProfileImpl\n }\n }\n try {\n val element = Element(\"toCopy\")\n for (wrapper in allWrappers) {\n wrapper.tool.writeSettings(element)\n val tw = if (psiElement == null) {\n model.getInspectionTool(wrapper.shortName, managerEx.project)\n } else {\n model.getInspectionTool(wrapper.shortName, psiElement)\n }\n tw!!.tool.readSettings(element)\n }\n } catch (ignored: WriteExternalException) {\n } catch (ignored: InvalidDataException) {\n }\n return model\n }\n\n fun toggleInspection(project: Project, aliInspections: List>, closed: Boolean) {\n val profile = getProjectInspectionProfile(project)\n val shortNames = aliInspections.map {\n it.tool.shortName\n }\n profile.removeScopes(shortNames, \"AlibabaCodeAnalysis\", project)\n val method = profile.javaClass.methods.first {\n it.name == if (closed) {\n \"enableToolsByDefault\"\n } else {\n \"disableToolByDefault\"\n }\n }\n method.invoke(profile, shortNames, project)\n profile.profileChanged()\n profile.scopesChanged()\n }\n\n fun setExternalProfile(profile: InspectionProfileImpl,\n inspectionContext: GlobalInspectionContextImpl) {\n val method = inspectionContext.javaClass.methods.first {\n it.name == \"setExternalProfile\" && it.parameterTypes.size == 1 && it.parameterTypes.first().isAssignableFrom(InspectionProfileImpl::class.java)\n }\n method.invoke(inspectionContext, profile)\n }\n\n fun getProjectInspectionProfile(project: Project): InspectionProfileImpl {\n return InspectionProjectProfileManager.getInstance(project).inspectionProfile as InspectionProfileImpl\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/compatible/inspection/Inspections.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.compatible.inspection\n\nimport com.google.common.base.Splitter\nimport com.intellij.codeInspection.ex.InspectionProfileImpl\nimport com.intellij.codeInspection.ex.InspectionToolWrapper\nimport com.intellij.codeInspection.ex.ScopeToolState\nimport com.intellij.codeInspection.javaDoc.JavaDocLocalInspection\nimport com.intellij.openapi.project.Project\n\n/**\n *\n *\n * @author caikang\n * @date 2017/03/01\n */\nobject Inspections {\n fun aliInspections(project: Project, filter: (InspectionToolWrapper<*, *>) -> Boolean): List> {\n val profile = InspectionProfileService.getProjectInspectionProfile(project)\n return getAllTools(project, profile).filter(filter)\n }\n\n fun addCustomTag(project: Project, tag: String) {\n val profile = InspectionProfileService.getProjectInspectionProfile(project)\n val javaDocLocalInspection = profile.getInspectionTool(\"JavaDoc\", project)?.tool\n as? JavaDocLocalInspection ?: return\n if (javaDocLocalInspection.myAdditionalJavadocTags.isEmpty()) {\n javaDocLocalInspection.myAdditionalJavadocTags = tag\n return\n }\n\n val tags = Splitter.on(',').splitToList(javaDocLocalInspection.myAdditionalJavadocTags)\n if (tags.contains(tag)) {\n return\n }\n javaDocLocalInspection.myAdditionalJavadocTags += \",\" + tag\n profile.profileChanged()\n profile.scopesChanged()\n }\n\n private fun getAllTools(project: Project, profile: InspectionProfileImpl): List> {\n val method = InspectionProfileImpl::class.java.methods.first {\n it.name == \"getAllTools\"\n }\n\n val result = if (method.parameterTypes.isNotEmpty()) {\n method.invoke(profile, project)\n } else {\n method.invoke(profile)\n }\n return (result as List).map { it.tool }\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/component/AliProjectComponent.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.component\n\nimport com.alibaba.p3c.idea.compatible.inspection.Inspections\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.inspection.AliPmdInspectionInvoker\nimport com.alibaba.p3c.idea.pmd.SourceCodeProcessor\nimport com.alibaba.p3c.idea.util.withLockNotInline\nimport com.alibaba.p3c.pmd.I18nResources\nimport com.alibaba.smartfox.idea.common.component.AliBaseProjectComponent\nimport com.intellij.openapi.actionSystem.ActionManager\nimport com.intellij.openapi.project.Project\nimport com.intellij.openapi.vfs.VirtualFile\nimport com.intellij.openapi.vfs.VirtualFileAdapter\nimport com.intellij.openapi.vfs.VirtualFileEvent\nimport com.intellij.openapi.vfs.VirtualFileListener\nimport com.intellij.openapi.vfs.VirtualFileManager\nimport com.intellij.openapi.vfs.VirtualFileMoveEvent\nimport com.intellij.psi.PsiManager\nimport net.sourceforge.pmd.RuleViolation\nimport java.util.concurrent.ConcurrentHashMap\nimport java.util.concurrent.locks.ReentrantReadWriteLock\n\n/**\n * @author caikang\n * @date 2016/12/13\n */\nclass AliProjectComponent(\n private val project: Project,\n val p3cConfig: P3cConfig\n) : AliBaseProjectComponent {\n private val listener: VirtualFileListener\n private val javaExtension = \".java\"\n private val velocityExtension = \".vm\"\n\n private val lock = ReentrantReadWriteLock()\n private val readLock = lock.readLock()\n private val writeLock = lock.writeLock()\n\n private val fileContexts = ConcurrentHashMap()\n\n init {\n listener = object : VirtualFileAdapter() {\n override fun contentsChanged(event: VirtualFileEvent) {\n val path = getFilePath(event) ?: return\n PsiManager.getInstance(project).findFile(event.file) ?: return\n if (!p3cConfig.ruleCacheEnable) {\n AliPmdInspectionInvoker.refreshFileViolationsCache(event.file)\n }\n if (!p3cConfig.astCacheEnable) {\n SourceCodeProcessor.invalidateCache(path)\n }\n SourceCodeProcessor.invalidUserTrigger(path)\n fileContexts[path]?.ruleViolations = null\n }\n\n override fun fileDeleted(event: VirtualFileEvent) {\n val path = getFilePath(event)\n path?.let {\n SourceCodeProcessor.invalidateCache(it)\n removeFileContext(it)\n }\n super.fileDeleted(event)\n }\n\n override fun fileMoved(event: VirtualFileMoveEvent) {\n val path = getFilePath(event)\n path?.let {\n SourceCodeProcessor.invalidateCache(it)\n removeFileContext(it)\n }\n super.fileMoved(event)\n }\n\n private fun getFilePath(event: VirtualFileEvent): String? {\n val path = event.file.canonicalPath\n if (path == null || !(path.endsWith(javaExtension) || path.endsWith(velocityExtension))) {\n return null\n }\n return path\n }\n }\n }\n\n override fun initComponent() {\n I18nResources.changeLanguage(p3cConfig.locale)\n val analyticsGroup = ActionManager.getInstance().getAction(analyticsGroupId)\n analyticsGroup.templatePresentation.text = P3cBundle.getMessage(analyticsGroupText)\n }\n\n override fun projectOpened() {\n Inspections.addCustomTag(project, \"date\")\n VirtualFileManager.getInstance().addVirtualFileListener(listener)\n }\n\n override fun projectClosed() {\n VirtualFileManager.getInstance().removeVirtualFileListener(listener)\n }\n\n companion object {\n val analyticsGroupId = \"com.alibaba.p3c.analytics.action_group\"\n val analyticsGroupText = \"$analyticsGroupId.text\"\n }\n\n data class FileContext(\n val lock: ReentrantReadWriteLock,\n var ruleViolations: Map>? = null\n )\n\n fun removeFileContext(path: String) {\n fileContexts.remove(path)\n }\n\n fun getFileContext(virtualFile: VirtualFile?): FileContext? {\n val file = virtualFile?.canonicalPath ?: return null\n val result = readLock.withLockNotInline {\n fileContexts[file]\n }\n if (result != null) {\n return result\n }\n return writeLock.withLockNotInline {\n val finalContext = fileContexts[file]\n if (finalContext != null) {\n return@withLockNotInline finalContext\n }\n val lock = ReentrantReadWriteLock()\n FileContext(\n lock = lock\n ).also {\n fileContexts[file] = it\n }\n }\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/component/CommonSettingsApplicationComponent.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.component\n\nimport com.alibaba.p3c.idea.util.HighlightInfoTypes\nimport com.alibaba.p3c.idea.util.HighlightSeverities\nimport com.alibaba.smartfox.idea.common.component.AliBaseApplicationComponent\nimport com.intellij.codeInsight.daemon.impl.SeverityRegistrar\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/19\n */\nclass CommonSettingsApplicationComponent : AliBaseApplicationComponent {\n override fun initComponent() {\n SeverityRegistrar.registerStandard(HighlightInfoTypes.BLOCKER, HighlightSeverities.BLOCKER)\n SeverityRegistrar.registerStandard(HighlightInfoTypes.CRITICAL, HighlightSeverities.CRITICAL)\n SeverityRegistrar.registerStandard(HighlightInfoTypes.MAJOR, HighlightSeverities.MAJOR)\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/config/P3cConfig.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.config\n\nimport com.intellij.openapi.components.PersistentStateComponent\nimport com.intellij.openapi.components.State\nimport com.intellij.openapi.components.Storage\nimport com.intellij.util.xmlb.XmlSerializerUtil\nimport java.util.Locale\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/19\n */\n@State(name = \"P3cConfig\", storages = [Storage(file = \"smartfox/p3c.xml\")])\nclass P3cConfig : PersistentStateComponent {\n var astCacheTime = 1000L\n var astCacheEnable = true\n\n var ruleCacheTime = 1000L\n var ruleCacheEnable = false\n\n var analysisBeforeCheckin = false\n\n var locale: String = \"\"\n get() {\n if (field.isEmpty()) {\n val lang = Locale.getDefault().language\n return if (lang != Locale.ENGLISH.language && lang != Locale.CHINESE.language) {\n Locale.ENGLISH.language\n } else Locale.getDefault().language\n }\n\n return field\n }\n\n fun toggleLanguage() {\n locale = if (localeEn == locale) localeZh else localeEn\n }\n\n override fun getState(): P3cConfig {\n return this\n }\n\n override fun loadState(state: P3cConfig) {\n XmlSerializerUtil.copyBean(state, this)\n }\n\n companion object {\n val localeEn = Locale.ENGLISH.language!!\n val localeZh = Locale.CHINESE.language!!\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/config/SmartFoxProjectConfig.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.config\n\nimport com.intellij.openapi.components.PersistentStateComponent\nimport com.intellij.openapi.components.State\nimport com.intellij.util.xmlb.XmlSerializerUtil\n\n/**\n *\n *\n * @author caikang\n * @date 2017/03/01\n */\n@State(name = \"SmartFoxProjectConfig\", storages = [com.intellij.openapi.components.Storage(file = \"smartfox_info.xml\")])\nclass SmartFoxProjectConfig : PersistentStateComponent {\n var projectInspectionClosed = false\n\n override fun getState(): SmartFoxProjectConfig? {\n return this\n }\n\n override fun loadState(state: SmartFoxProjectConfig) {\n XmlSerializerUtil.copyBean(state, this)\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/ep/InspectionActionExtensionPoint.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.ep\n\nimport com.alibaba.smartfox.idea.common.util.PluginVersions\nimport com.intellij.codeInspection.ex.GlobalInspectionContextImpl\nimport com.intellij.codeInspection.ui.InspectionResultsView\nimport com.intellij.openapi.extensions.ExtensionPointName\nimport com.intellij.openapi.project.Project\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/19\n */\ninterface InspectionActionExtensionPoint {\n fun doOnInspectionFinished(context: GlobalInspectionContextImpl, projectScopeSelected: Boolean) {}\n fun doOnClose(noSuspiciousCodeFound: Boolean, project: Project?) {}\n fun doOnView(view: InspectionResultsView) {}\n\n companion object {\n val extension = ExtensionPointName.create(\n \"${PluginVersions.pluginId.idString}.inspectionAction\")!!\n }\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/ep/package-info.java",
"content": "/**\n * extension point\n *\n * @author caikang\n * @date 2017/06/19\n */\npackage com.alibaba.p3c.idea.ep;"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/i18n/P3cBundle.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.i18n\n\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.pmd.I18nResources\nimport com.alibaba.smartfox.idea.common.util.getService\nimport com.intellij.CommonBundle\nimport java.util.Locale\nimport java.util.ResourceBundle\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/20\n */\nobject P3cBundle {\n private val p3cConfig = P3cConfig::class.java.getService()\n private val resourceBundle = ResourceBundle.getBundle(\"messages.P3cBundle\",\n Locale(p3cConfig.locale), I18nResources.XmlControl())\n\n fun getMessage(key: String): String {\n return resourceBundle.getString(key).trim()\n }\n\n fun message(key: String, vararg params: Any): String {\n return CommonBundle.message(resourceBundle, key, *params).trim()\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliAccessToNonThreadSafeStaticFieldFromInstanceInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.siyeh.ig.threading.AccessToNonThreadSafeStaticFieldFromInstanceInspection\n\n/**\n * @author caikang\n * @date 2016/12/08\n */\nclass AliAccessToNonThreadSafeStaticFieldFromInstanceInspection\n : AccessToNonThreadSafeStaticFieldFromInstanceInspection,\n AliBaseInspection {\n constructor()\n /**\n * For Javassist\n */\n constructor(any: Any?) : this()\n\n init {\n nonThreadSafeClasses.clear()\n nonThreadSafeClasses.add(\"java.text.SimpleDateFormat\")\n }\n\n override fun ruleName(): String {\n return \"AvoidCallStaticSimpleDateFormatRule\"\n }\n\n override fun getDisplayName(): String {\n return RuleInspectionUtils.getRuleMessage(ruleName())\n }\n\n override fun buildErrorString(vararg infos: Any): String {\n return P3cBundle.getMessage(\"com.alibaba.p3c.idea.inspection.rule.AvoidCallStaticSimpleDateFormatRule.errMsg\")\n }\n\n override fun getStaticDescription(): String? {\n return RuleInspectionUtils.getRuleStaticDescription(ruleName())\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return RuleInspectionUtils.getHighlightDisplayLevel(ruleName())\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliArrayNamingShouldHaveBracketInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.quickfix.DecorateInspectionGadgetsFix\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiField\nimport com.intellij.psi.PsiMethod\nimport com.intellij.psi.PsiParameter\nimport com.siyeh.ig.InspectionGadgetsFix\nimport com.siyeh.ig.style.CStyleArrayDeclarationInspection\nimport javax.swing.JComponent\n\n/**\n *\n * Batch QuickFix Supported\n * @author caikang\n * @date 2017/02/26\n */\nclass AliArrayNamingShouldHaveBracketInspection : CStyleArrayDeclarationInspection, AliBaseInspection {\n constructor()\n /**\n * ForJavassist\n */\n constructor(any: Any?) : this()\n\n override fun ruleName(): String {\n return \"ArrayNamingShouldHaveBracketRule\"\n }\n\n override fun getDisplayName(): String {\n return RuleInspectionUtils.getRuleMessage(ruleName())\n }\n\n override fun getShortName(): String {\n return \"AliArrayNamingShouldHaveBracket\"\n }\n\n override fun getStaticDescription(): String? {\n return RuleInspectionUtils.getRuleStaticDescription(ruleName())\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return RuleInspectionUtils.getHighlightDisplayLevel(ruleName())\n }\n\n override fun createOptionsPanel(): JComponent? {\n return null\n }\n\n override fun buildErrorString(vararg infos: Any?): String {\n val info = infos[0]\n if (info is PsiMethod) {\n return displayName\n }\n val choice = if (info is PsiField) 1 else if (info is PsiParameter) 2 else 3\n return P3cBundle.message(\"com.alibaba.p3c.idea.inspection.rule.ArrayNamingShouldHaveBracketRule.errMsg\", choice)\n }\n\n override fun buildFix(vararg infos: Any): InspectionGadgetsFix? {\n val fix = super.buildFix(*infos) ?: return null\n return DecorateInspectionGadgetsFix(fix,\n P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.ArrayNamingShouldHaveBracketRule\"))\n }\n\n override fun manualBuildFix(psiElement: PsiElement, isOnTheFly: Boolean): LocalQuickFix? {\n return buildFix(psiElement)\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliBaseInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiFile\n\n/**\n * @author caikang\n * @date 2016/12/08\n */\ninterface AliBaseInspection {\n\n /**\n * ruleName\n\n * @return ruleName\n */\n fun ruleName(): String\n\n /**\n * display info for inspection\n\n * @return display\n */\n fun getDisplayName(): String\n\n /**\n * group display info for inspection\n\n * @return group display\n */\n fun getGroupDisplayName(): String\n\n /**\n * inspection enable by default\n\n * @return true -> enable\n */\n fun isEnabledByDefault(): Boolean\n\n /**\n * default inspection level\n\n * @return level\n */\n fun getDefaultLevel(): HighlightDisplayLevel\n\n /**\n * inspection short name\n\n * @return shor name\n */\n fun getShortName(): String\n\n fun manualBuildFix(psiElement: PsiElement, isOnTheFly: Boolean): LocalQuickFix? = null\n\n fun manualParsePsiElement(psiFile: PsiFile, manager: InspectionManager,\n start: Int, end: Int): PsiElement {\n return psiFile.findElementAt(start)!!\n }\n\n companion object {\n val GROUP_NAME = \"Ali-Check\"\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliControlFlowStatementWithoutBracesInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.quickfix.DecorateInspectionGadgetsFix\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.psi.PsiElement\nimport com.siyeh.ig.InspectionGadgetsFix\nimport com.siyeh.ig.style.ControlFlowStatementWithoutBracesInspection\n\n/**\n * Batch QuickFix Supported\n * @author caikang\n * @date 2016/12/15\n */\nclass AliControlFlowStatementWithoutBracesInspection\n : ControlFlowStatementWithoutBracesInspection,\n AliBaseInspection {\n constructor()\n /**\n * For Javassist\n */\n constructor(any: Any?) : this()\n\n override fun ruleName(): String {\n return \"NeedBraceRule\"\n }\n\n override fun getDisplayName(): String {\n return RuleInspectionUtils.getRuleMessage(ruleName())\n }\n\n override fun buildErrorString(vararg infos: Any): String {\n return P3cBundle.getMessage(\"com.alibaba.p3c.idea.inspection.rule.NeedBraceRule.errMsg\")\n }\n\n override fun getStaticDescription(): String? {\n return RuleInspectionUtils.getRuleStaticDescription(ruleName())\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return RuleInspectionUtils.getHighlightDisplayLevel(ruleName())\n }\n\n override fun buildFix(vararg infos: Any): InspectionGadgetsFix? {\n val fix = super.buildFix(*infos) ?: return null\n return DecorateInspectionGadgetsFix(fix, P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.NeedBraceRule\"))\n }\n\n override fun manualBuildFix(psiElement: PsiElement, isOnTheFly: Boolean): LocalQuickFix? {\n return buildFix(psiElement)\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliEqualsAvoidNullInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.quickfix.DecorateInspectionGadgetsFix\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiExpression\nimport com.intellij.psi.PsiField\nimport com.intellij.psi.PsiFile\nimport com.intellij.psi.PsiLiteralExpression\nimport com.intellij.psi.PsiMethodCallExpression\nimport com.intellij.psi.PsiReferenceExpression\nimport com.siyeh.HardcodedMethodConstants\nimport com.siyeh.ig.BaseInspectionVisitor\nimport com.siyeh.ig.InspectionGadgetsFix\nimport com.siyeh.ig.psiutils.TypeUtils\nimport com.siyeh.ig.style.LiteralAsArgToStringEqualsInspection\nimport org.jetbrains.annotations.NonNls\n\n/**\n *\n * Batch QuickFix Supported\n * @author caikang\n * @date 2017/02/27\n */\nclass AliEqualsAvoidNullInspection : LiteralAsArgToStringEqualsInspection, AliBaseInspection {\n constructor()\n /**\n * For Javassist\n */\n constructor(any: Any?) : this()\n\n override fun ruleName(): String {\n return \"EqualsAvoidNullRule\"\n }\n\n override fun getDisplayName(): String {\n return RuleInspectionUtils.getRuleMessage(ruleName())\n }\n\n override fun buildErrorString(vararg infos: Any?): String {\n val methodName = infos[0] as String\n return String.format(P3cBundle.getMessage(\"com.alibaba.p3c.idea.inspection.rule.AliEqualsAvoidNull.errMsg\"),\n methodName)\n }\n\n override fun getShortName(): String {\n return \"AliEqualsAvoidNull\"\n }\n\n override fun getStaticDescription(): String? {\n return RuleInspectionUtils.getRuleStaticDescription(ruleName())\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return RuleInspectionUtils.getHighlightDisplayLevel(ruleName())\n }\n\n override fun buildVisitor(): BaseInspectionVisitor {\n return LiteralAsArgToEqualsVisitor()\n }\n\n private class LiteralAsArgToEqualsVisitor : BaseInspectionVisitor() {\n\n override fun visitMethodCallExpression(\n expression: PsiMethodCallExpression) {\n super.visitMethodCallExpression(expression)\n val methodExpression = expression.methodExpression\n @NonNls val methodName = methodExpression.referenceName\n if (HardcodedMethodConstants.EQUALS != methodName && HardcodedMethodConstants.EQUALS_IGNORE_CASE != methodName) {\n return\n }\n val argList = expression.argumentList\n val args = argList.expressions\n if (args.size != 1) {\n return\n }\n val argument = args[0]\n val argumentType = argument.type ?: return\n if (argument !is PsiLiteralExpression && !isConstantField(argument)) {\n return\n }\n if (!TypeUtils.isJavaLangString(argumentType)) {\n return\n }\n val target = methodExpression.qualifierExpression\n if (target is PsiLiteralExpression || isConstantField(argument)) {\n return\n }\n registerError(argument, methodName)\n }\n\n private fun isConstantField(argument: PsiExpression): Boolean {\n if (argument !is PsiReferenceExpression) {\n return false\n }\n val psiField = argument.resolve() as? PsiField ?: return false\n val modifierList = psiField.modifierList ?: return false\n return modifierList.hasModifierProperty(\"final\") && modifierList.hasModifierProperty(\"static\")\n }\n }\n\n override fun buildFix(vararg infos: Any): InspectionGadgetsFix? {\n val fix = super.buildFix(*infos) ?: return null\n return DecorateInspectionGadgetsFix(fix,\n P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.AliEqualsAvoidNull\"))\n }\n\n override fun manualBuildFix(psiElement: PsiElement, isOnTheFly: Boolean): LocalQuickFix? {\n return buildFix(psiElement)\n }\n\n override fun manualParsePsiElement(psiFile: PsiFile, manager: InspectionManager, start: Int, end: Int): PsiElement {\n return psiFile.findElementAt(start)!!.parent.parent\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliLocalInspectionToolProvider.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.idea.inspection.standalone.AliAccessStaticViaInstanceInspection\nimport com.alibaba.p3c.idea.inspection.standalone.AliDeprecationInspection\nimport com.alibaba.p3c.idea.inspection.standalone.AliMissingOverrideAnnotationInspection\nimport com.alibaba.p3c.idea.inspection.standalone.MapOrSetKeyShouldOverrideHashCodeEqualsInspection\nimport com.alibaba.p3c.pmd.I18nResources\nimport com.alibaba.smartfox.idea.common.util.getService\nimport com.beust.jcommander.internal.Lists\nimport com.beust.jcommander.internal.Maps\nimport com.intellij.codeInspection.InspectionToolProvider\nimport com.intellij.codeInspection.LocalInspectionTool\nimport com.intellij.openapi.diagnostic.Logger\nimport com.intellij.openapi.roots.ProjectRootManager\nimport com.intellij.psi.PsiCompiledFile\nimport com.intellij.psi.PsiFile\nimport com.intellij.psi.PsiImportList\nimport com.intellij.psi.PsiJavaFile\nimport javassist.CannotCompileException\nimport javassist.ClassClassPath\nimport javassist.ClassPool\nimport javassist.CtField\nimport javassist.NotFoundException\nimport net.sourceforge.pmd.Rule\nimport net.sourceforge.pmd.RuleSet\nimport net.sourceforge.pmd.RuleSetFactory\nimport net.sourceforge.pmd.RuleSetNotFoundException\nimport net.sourceforge.pmd.RuleSets\nimport javax.annotation.Generated\n\n/**\n * @author caikang\n * @date 2016/12/16\n */\nclass AliLocalInspectionToolProvider : InspectionToolProvider {\n\n override fun getInspectionClasses(): Array> {\n return CLASS_LIST.toTypedArray()\n }\n\n interface ShouldInspectChecker {\n /**\n * check inspect whether or not\n\n * @param file file to inspect\n * @return true or false\n */\n fun shouldInspect(file: PsiFile): Boolean\n }\n\n class RuleInfo(var rule: Rule, var shouldInspectChecker: ShouldInspectChecker)\n\n companion object {\n val ruleInfoMap: MutableMap = Maps.newHashMap()\n private val LOGGER = Logger.getInstance(AliLocalInspectionToolProvider::class.java)\n val ruleNames: MutableList = Lists.newArrayList()!!\n private val CLASS_LIST = Lists.newArrayList>()\n private val nativeInspectionToolClass = arrayListOf>(\n AliMissingOverrideAnnotationInspection::class.java,\n AliAccessStaticViaInstanceInspection::class.java,\n AliDeprecationInspection::class.java,\n MapOrSetKeyShouldOverrideHashCodeEqualsInspection::class.java,\n AliArrayNamingShouldHaveBracketInspection::class.java,\n AliControlFlowStatementWithoutBracesInspection::class.java,\n AliEqualsAvoidNullInspection::class.java,\n AliLongLiteralsEndingWithLowercaseLInspection::class.java,\n AliWrapperTypeEqualityInspection::class.java\n )\n val javaShouldInspectChecker = object : ShouldInspectChecker {\n override fun shouldInspect(file: PsiFile): Boolean {\n val basicInspect = file is PsiJavaFile && file !is PsiCompiledFile\n if (!basicInspect) {\n return false\n }\n\n if (!validScope(file)) {\n return false\n }\n\n val importList = file.children.firstOrNull {\n it is PsiImportList\n } as? PsiImportList ?: return true\n\n return !importList.allImportStatements.any {\n it.text.contains(Generated::class.java.name)\n }\n }\n\n private fun validScope(file: PsiFile): Boolean {\n val virtualFile = file.virtualFile\n val index = ProjectRootManager.getInstance(file.project).fileIndex\n return index.isInSource(virtualFile)\n && !index.isInTestSourceContent(virtualFile)\n && !index.isInLibraryClasses(virtualFile)\n && !index.isInLibrarySource(virtualFile)\n }\n }\n\n init {\n I18nResources.changeLanguage(P3cConfig::class.java.getService().locale)\n Thread.currentThread().contextClassLoader = AliLocalInspectionToolProvider::class.java.classLoader\n initPmdInspection()\n initNativeInspection()\n }\n\n private fun initNativeInspection() {\n val pool = ClassPool.getDefault()\n pool.insertClassPath(ClassClassPath(DelegateLocalInspectionTool::class.java))\n nativeInspectionToolClass.forEach {\n pool.insertClassPath(ClassClassPath(it))\n val cc = pool.get(DelegateLocalInspectionTool::class.java.name)\n cc.name = \"Delegate${it.simpleName}\"\n val ctField = cc.getField(\"forJavassist\")\n cc.removeField(ctField)\n val itClass = pool.get(it.name)\n val toolClass = pool.get(LocalInspectionTool::class.java.name)\n val newField = CtField(toolClass, \"forJavassist\", cc)\n cc.addField(newField, CtField.Initializer.byNew(itClass))\n CLASS_LIST.add(cc.toClass() as Class)\n }\n }\n\n private fun initPmdInspection() {\n for (ri in newRuleInfos()) {\n this.ruleNames.add(ri.rule.name)\n ruleInfoMap.put(ri.rule.name, ri)\n }\n val pool = ClassPool.getDefault()\n pool.insertClassPath(ClassClassPath(DelegatePmdInspection::class.java))\n try {\n for (ruleInfo in ruleInfoMap.values) {\n val cc = pool.get(DelegatePmdInspection::class.java.name)\n cc.name = ruleInfo.rule.name + \"Inspection\"\n val ctField = cc.getField(\"ruleName\")\n cc.removeField(ctField)\n val value = \"\\\"\" + ruleInfo.rule.name + \"\\\"\"\n val newField = CtField.make(\"private String ruleName = $value;\", cc)\n cc.addField(newField, value)\n CLASS_LIST.add(cc.toClass() as Class)\n }\n\n } catch (e: NotFoundException) {\n LOGGER.error(e)\n } catch (e: CannotCompileException) {\n LOGGER.error(e)\n }\n }\n\n private fun newRuleInfos(): List {\n val result = Lists.newArrayList()\n result.addAll(processForRuleSet(\"java/ali-pmd\", javaShouldInspectChecker))\n result.addAll(processForRuleSet(\"vm/ali-other\", object : ShouldInspectChecker {\n override fun shouldInspect(file: PsiFile): Boolean {\n val virtualFile = file.virtualFile ?: return false\n val path = virtualFile.canonicalPath\n return path != null && path.endsWith(\".vm\")\n }\n }))\n return result\n }\n\n fun getRuleSet(ruleSetName: String): RuleSet {\n val factory = RuleSetFactory()\n return factory.createRuleSet(ruleSetName.replace(\"/\", \"-\"))\n }\n\n fun getRuleSetList(): List {\n return listOf(getRuleSet(\"java/ali-pmd\"), getRuleSet(\"vm/ali-other\"))\n }\n\n fun getRuleSets(): RuleSets {\n return RuleSets().also { rs ->\n for (ruleSet in getRuleSetList()) {\n rs.addRuleSet(ruleSet)\n }\n }\n }\n\n private fun processForRuleSet(ruleSetName: String, shouldInspectChecker: ShouldInspectChecker): List {\n val result = Lists.newArrayList()\n try {\n val ruleSet = getRuleSet(ruleSetName)\n ruleSet.rules.mapTo(result) {\n RuleInfo(it, shouldInspectChecker)\n }\n } catch (e: RuleSetNotFoundException) {\n LOGGER.error(String.format(\"rule set %s not found for\", ruleSetName))\n }\n\n return result\n }\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliLongLiteralsEndingWithLowercaseLInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.quickfix.DecorateInspectionGadgetsFix\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiFile\nimport com.siyeh.ig.InspectionGadgetsFix\nimport com.siyeh.ig.numeric.LongLiteralsEndingWithLowercaseLInspection\n\n/**\n *\n * Batch QuickFix Supported\n * @author caikang\n * @date 2017/01/20\n */\nclass AliLongLiteralsEndingWithLowercaseLInspection : LongLiteralsEndingWithLowercaseLInspection, AliBaseInspection {\n constructor()\n /**\n * For Javassist\n */\n constructor(any: Any?) : this()\n\n override fun ruleName(): String {\n return \"UpperEllRule\"\n }\n\n override fun getDisplayName(): String {\n return RuleInspectionUtils.getRuleMessage(ruleName())\n }\n\n override fun buildErrorString(vararg infos: Any?): String {\n return P3cBundle.getMessage(\"com.alibaba.p3c.idea.inspection.rule.AliLongLiteralsEndingWithLowercaseL.errMsg\")\n }\n\n override fun getShortName(): String {\n return \"AliLongLiteralsEndingWithLowercaseL\"\n }\n\n override fun getStaticDescription(): String? {\n return RuleInspectionUtils.getRuleStaticDescription(ruleName())\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return RuleInspectionUtils.getHighlightDisplayLevel(ruleName())\n }\n\n override fun buildFix(vararg infos: Any): InspectionGadgetsFix? {\n val fix = super.buildFix(*infos) ?: return null\n return DecorateInspectionGadgetsFix(fix,\n P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.AliLongLiteralsEndingWithLowercaseL\"))\n }\n\n override fun manualBuildFix(psiElement: PsiElement, isOnTheFly: Boolean): LocalQuickFix? {\n return buildFix(psiElement)\n }\n\n override fun manualParsePsiElement(psiFile: PsiFile, manager: InspectionManager, start: Int, end: Int): PsiElement {\n return psiFile.findElementAt(start)!!.parent\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliPmdInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.inspection.AliLocalInspectionToolProvider.ShouldInspectChecker\nimport com.alibaba.p3c.idea.util.NumberConstants\nimport com.alibaba.p3c.idea.util.QuickFixes\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.LocalInspectionTool\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiFile\nimport net.sourceforge.pmd.Rule\nimport org.jetbrains.annotations.Nls\n\n/**\n * @author caikang\n * @date 2016/12/16\n */\nclass AliPmdInspection(private val ruleName: String) : LocalInspectionTool(),\n AliBaseInspection,\n PmdRuleInspectionIdentify {\n override fun manualBuildFix(psiElement: PsiElement, isOnTheFly: Boolean): LocalQuickFix? {\n return QuickFixes.getQuickFix(ruleName, isOnTheFly)\n }\n\n private val staticDescription: String = RuleInspectionUtils.getRuleStaticDescription(ruleName)\n\n private val displayName: String\n\n private val shouldInspectChecker: ShouldInspectChecker\n\n private val defaultLevel: HighlightDisplayLevel\n\n private val rule: Rule\n\n init {\n val ruleInfo = AliLocalInspectionToolProvider.ruleInfoMap[ruleName]!!\n shouldInspectChecker = ruleInfo.shouldInspectChecker\n rule = ruleInfo.rule\n displayName = rule.message\n defaultLevel = RuleInspectionUtils.getHighlightDisplayLevel(rule.priority)\n }\n\n override fun runForWholeFile(): Boolean {\n return true\n }\n\n override fun checkFile(\n file: PsiFile, manager: InspectionManager,\n isOnTheFly: Boolean\n ): Array? {\n if (!shouldInspectChecker.shouldInspect(file)) {\n return null\n }\n return AliPmdInspectionInvoker.invokeInspection(file, manager, rule, isOnTheFly)\n }\n\n override fun getStaticDescription(): String? {\n return staticDescription\n }\n\n override fun ruleName(): String {\n return ruleName\n }\n\n @Nls\n override fun getDisplayName(): String {\n return displayName\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return defaultLevel\n }\n\n @Nls\n override fun getGroupDisplayName(): String {\n return AliBaseInspection.GROUP_NAME\n }\n\n override fun isEnabledByDefault(): Boolean {\n return true\n }\n\n override fun getShortName(): String {\n\n var shortName = \"Alibaba\" + ruleName\n val index = shortName.lastIndexOf(\"Rule\")\n if (index > NumberConstants.INDEX_0) {\n shortName = shortName.substring(NumberConstants.INDEX_0, index)\n }\n return shortName\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliPmdInspectionInvoker.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.component.AliProjectComponent\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.idea.pmd.AliPmdProcessor\nimport com.alibaba.p3c.idea.util.DocumentUtils.calculateLineStart\nimport com.alibaba.p3c.idea.util.DocumentUtils.calculateRealOffset\nimport com.alibaba.p3c.idea.util.ProblemsUtils\nimport com.alibaba.p3c.pmd.lang.java.rule.comment.RemoveCommentedCodeRule\nimport com.beust.jcommander.internal.Lists\nimport com.google.common.cache.Cache\nimport com.google.common.cache.CacheBuilder\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.openapi.components.ServiceManager\nimport com.intellij.openapi.diagnostic.Logger\nimport com.intellij.openapi.fileEditor.FileDocumentManager\nimport com.intellij.openapi.vfs.LocalFileSystem\nimport com.intellij.openapi.vfs.VirtualFile\nimport com.intellij.psi.PsiFile\nimport com.intellij.psi.PsiManager\nimport net.sourceforge.pmd.Rule\nimport net.sourceforge.pmd.RuleViolation\nimport java.util.concurrent.TimeUnit\n\n/**\n * @author caikang\n * @date 2016/12/13\n */\nclass AliPmdInspectionInvoker(\n private val psiFile: PsiFile,\n private val manager: InspectionManager,\n private val rule: Rule\n) {\n private val logger = Logger.getInstance(javaClass)\n\n private var violations: List = emptyList()\n\n fun doInvoke(isOnTheFly: Boolean) {\n Thread.currentThread().contextClassLoader = javaClass.classLoader\n val processor = AliPmdProcessor(rule)\n val start = System.currentTimeMillis()\n val aliProjectComponent = manager.project.getComponent(AliProjectComponent::class.java)\n val fileContext = aliProjectComponent.getFileContext(psiFile.virtualFile)\n val ruleViolations = fileContext?.ruleViolations\n violations = if (isOnTheFly || ruleViolations == null) {\n processor.processFile(psiFile, isOnTheFly)\n } else {\n ruleViolations[rule.name] ?: emptyList()\n }\n logger.debug(\n \"elapsed ${System.currentTimeMillis() - start}ms to\" +\n \" to apply rule ${rule.name} for file ${psiFile.virtualFile.canonicalPath}\"\n )\n }\n\n fun getRuleProblems(isOnTheFly: Boolean): Array? {\n if (violations.isEmpty()) {\n return null\n }\n val problemDescriptors = Lists.newArrayList(violations.size)\n for (rv in violations) {\n val virtualFile = LocalFileSystem.getInstance().findFileByPath(rv.filename) ?: continue\n val psiFile = PsiManager.getInstance(manager.project).findFile(virtualFile) ?: continue\n val document = FileDocumentManager.getInstance().getDocument(virtualFile) ?: continue\n\n val offsets = if (rv.rule.name == RemoveCommentedCodeRule::class.java.simpleName) {\n Offsets(\n calculateLineStart(document, rv.beginLine),\n calculateLineStart(document, rv.endLine + 1) - 1\n )\n } else {\n Offsets(\n calculateRealOffset(document, rv.beginLine, rv.beginColumn),\n calculateRealOffset(document, rv.endLine, rv.endColumn)\n )\n }\n val errorMessage = if (isOnTheFly) {\n rv.description\n } else {\n \"${rv.description} (line ${rv.beginLine})\"\n }\n val problemDescriptor = ProblemsUtils.createProblemDescriptorForPmdRule(\n psiFile, manager,\n isOnTheFly, rv.rule.name, errorMessage, offsets.start, offsets.end, rv.beginLine\n ) ?: continue\n problemDescriptors.add(problemDescriptor)\n }\n return problemDescriptors.toTypedArray()\n }\n\n companion object {\n private lateinit var invokers: Cache\n val smartFoxConfig = ServiceManager.getService(P3cConfig::class.java)!!\n\n init {\n reInitInvokers(smartFoxConfig.ruleCacheTime)\n }\n\n fun invokeInspection(\n psiFile: PsiFile?, manager: InspectionManager, rule: Rule,\n isOnTheFly: Boolean\n ): Array? {\n if (psiFile == null) {\n return null\n }\n val virtualFile = psiFile.virtualFile ?: return null\n if (!smartFoxConfig.ruleCacheEnable) {\n val invoker = AliPmdInspectionInvoker(psiFile, manager, rule)\n invoker.doInvoke(isOnTheFly)\n return invoker.getRuleProblems(isOnTheFly)\n }\n var invoker = invokers.getIfPresent(FileRule(virtualFile.canonicalPath!!, rule.name))\n if (invoker == null) {\n synchronized(virtualFile) {\n invoker = invokers.getIfPresent(virtualFile.canonicalPath!!)\n if (invoker == null) {\n invoker = AliPmdInspectionInvoker(psiFile, manager, rule)\n invoker!!.doInvoke(isOnTheFly)\n invokers.put(FileRule(virtualFile.canonicalPath!!, rule.name), invoker!!)\n }\n }\n }\n return invoker!!.getRuleProblems(isOnTheFly)\n }\n\n private fun doInvokeIfPresent(filePath: String, rule: String, isOnTheFly: Boolean) {\n invokers.getIfPresent(FileRule(filePath, rule))?.doInvoke(isOnTheFly)\n }\n\n fun refreshFileViolationsCache(file: VirtualFile) {\n AliLocalInspectionToolProvider.ruleNames.forEach {\n doInvokeIfPresent(file.canonicalPath!!, it, false)\n }\n }\n\n fun reInitInvokers(expireTime: Long) {\n invokers = CacheBuilder.newBuilder().maximumSize(500).expireAfterWrite(\n expireTime,\n TimeUnit.MILLISECONDS\n ).build()!!\n }\n }\n}\n\ndata class FileRule(val filePath: String, val ruleName: String)\ndata class Offsets(val start: Int, val end: Int)\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/AliWrapperTypeEqualityInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.quickfix.DecorateInspectionGadgetsFix\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.openapi.project.Project\nimport com.intellij.psi.CommonClassNames\nimport com.intellij.psi.JavaTokenType\nimport com.intellij.psi.PsiArrayType\nimport com.intellij.psi.PsiBinaryExpression\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiExpression\nimport com.intellij.util.IncorrectOperationException\nimport com.siyeh.ig.BaseInspection\nimport com.siyeh.ig.BaseInspectionVisitor\nimport com.siyeh.ig.InspectionGadgetsFix\nimport com.siyeh.ig.PsiReplacementUtil\nimport com.siyeh.ig.fixes.EqualityToEqualsFix\nimport com.siyeh.ig.psiutils.ComparisonUtils\nimport com.siyeh.ig.psiutils.TypeUtils\nimport org.jetbrains.annotations.NonNls\n\n/**\n *\n * Batch QuickFix Supported\n * @author caikang\n * @date 2017/02/27\n */\nclass AliWrapperTypeEqualityInspection : BaseInspection, AliBaseInspection {\n constructor()\n\n /**\n * For Javassist\n */\n constructor(any: Any?) : this()\n\n val familyName = \"$replaceWith equals\"\n\n override fun buildErrorString(vararg infos: Any?): String {\n return P3cBundle.getMessage(\"com.alibaba.p3c.idea.inspection.rule.WrapperTypeEqualityRule.errMsg\")\n }\n\n override fun buildVisitor(): BaseInspectionVisitor {\n return ObjectComparisonVisitor()\n }\n\n override fun ruleName(): String {\n return \"WrapperTypeEqualityRule\"\n }\n\n override fun getDisplayName(): String {\n return RuleInspectionUtils.getRuleMessage(ruleName())\n }\n\n override fun getShortName(): String {\n return \"AliWrapperTypeEquality\"\n }\n\n override fun getStaticDescription(): String? {\n return RuleInspectionUtils.getRuleStaticDescription(ruleName())\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return RuleInspectionUtils.getHighlightDisplayLevel(ruleName())\n }\n\n public override fun buildFix(vararg infos: Any): InspectionGadgetsFix? {\n if (infos.isEmpty()) {\n return DecorateInspectionGadgetsFix(EqualityToEqualsFix(), familyName)\n }\n val type = infos[0] as PsiArrayType\n val componentType = type.componentType\n val fix = ArrayEqualityFix(componentType is PsiArrayType, familyName)\n return DecorateInspectionGadgetsFix(fix, fix.name, familyName)\n }\n\n private inner class ObjectComparisonVisitor : BaseInspectionVisitor() {\n override fun visitBinaryExpression(expression: PsiBinaryExpression) {\n if (!ComparisonUtils.isEqualityComparison(expression)) {\n return\n }\n checkForWrapper(expression)\n }\n\n private fun checkForWrapper(expression: PsiBinaryExpression) {\n val rhs = expression.rOperand ?: return\n val lhs = expression.lOperand\n if (!isWrapperType(lhs) || !isWrapperType(rhs)) {\n return\n }\n registerError(expression.operationSign)\n }\n\n private fun isWrapperType(expression: PsiExpression): Boolean {\n if (hasNumberType(expression)) {\n return true\n }\n return TypeUtils.expressionHasTypeOrSubtype(expression, CommonClassNames.JAVA_LANG_BOOLEAN)\n || TypeUtils.expressionHasTypeOrSubtype(expression, CommonClassNames.JAVA_LANG_CHARACTER)\n }\n\n private fun hasNumberType(expression: PsiExpression): Boolean {\n return TypeUtils.expressionHasTypeOrSubtype(expression, CommonClassNames.JAVA_LANG_NUMBER)\n }\n /**\n * checkForNumber end\n */\n\n }\n\n private class ArrayEqualityFix(private val deepEquals: Boolean, private val familyName: String) :\n InspectionGadgetsFix() {\n\n override fun getName(): String {\n if (deepEquals) {\n return \"$replaceWith 'Arrays.deepEquals()'\"\n } else {\n return \"$replaceWith 'Arrays.equals()'\"\n }\n }\n\n override fun getFamilyName(): String {\n return familyName\n }\n\n @Throws(IncorrectOperationException::class)\n override fun doFix(project: Project, descriptor: ProblemDescriptor) {\n val element = descriptor.psiElement\n val parent = element.parent as? PsiBinaryExpression ?: return\n val tokenType = parent.operationTokenType\n @NonNls\n val newExpressionText = StringBuilder()\n if (JavaTokenType.NE == tokenType) {\n newExpressionText.append('!')\n } else if (JavaTokenType.EQEQ != tokenType) {\n return\n }\n if (deepEquals) {\n newExpressionText.append(\"java.util.Arrays.deepEquals(\")\n } else {\n newExpressionText.append(\"java.util.Arrays.equals(\")\n }\n newExpressionText.append(parent.lOperand.text)\n newExpressionText.append(',')\n val rhs = parent.rOperand ?: return\n newExpressionText.append(rhs.text)\n newExpressionText.append(')')\n PsiReplacementUtil.replaceExpressionAndShorten(\n parent,\n newExpressionText.toString()\n )\n }\n }\n\n override fun manualBuildFix(psiElement: PsiElement, isOnTheFly: Boolean): LocalQuickFix? {\n val expression = psiElement.parent as? PsiBinaryExpression ?: return null\n val rhs = expression.rOperand ?: return null\n val lhs = expression.lOperand\n val lhsType = lhs.type\n if (lhsType !is PsiArrayType || rhs.type !is PsiArrayType) {\n return buildFix()\n }\n return buildFix(lhsType)\n }\n\n companion object {\n val replaceWith = P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.replace.with\")\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/DelegateLocalInspectionTool.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.LocalInspectionTool\nimport com.intellij.codeInspection.LocalInspectionToolSession\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.codeInspection.ProblemsHolder\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiElementVisitor\nimport com.intellij.psi.PsiFile\nimport org.jetbrains.annotations.Nls\n\n/**\n *\n * @author caikang\n * @date 2017/07/19\n */\nclass DelegateLocalInspectionTool : LocalInspectionTool(), AliBaseInspection {\n\n private val forJavassist: LocalInspectionTool? = null\n\n private val localInspectionTool: LocalInspectionTool\n\n init {\n localInspectionTool = forJavassist ?: throw IllegalStateException()\n }\n\n override fun runForWholeFile(): Boolean {\n return localInspectionTool.runForWholeFile()\n }\n\n override fun checkFile(\n file: PsiFile, manager: InspectionManager,\n isOnTheFly: Boolean\n ): Array? {\n return localInspectionTool.checkFile(file, manager, isOnTheFly)\n }\n\n override fun getStaticDescription(): String? {\n return localInspectionTool.staticDescription\n }\n\n override fun ruleName(): String {\n return (localInspectionTool as AliBaseInspection).ruleName()\n }\n\n @Nls\n override fun getDisplayName(): String {\n return localInspectionTool.displayName\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return localInspectionTool.defaultLevel\n }\n\n @Nls\n override fun getGroupDisplayName(): String {\n return AliBaseInspection.GROUP_NAME\n }\n\n override fun isEnabledByDefault(): Boolean {\n return true\n }\n\n override fun getShortName(): String {\n return localInspectionTool.shortName\n }\n\n override fun isSuppressedFor(element: PsiElement): Boolean {\n return localInspectionTool.isSuppressedFor(element)\n }\n\n override fun buildVisitor(\n holder: ProblemsHolder, isOnTheFly: Boolean,\n session: LocalInspectionToolSession\n ): PsiElementVisitor {\n if (!AliLocalInspectionToolProvider.javaShouldInspectChecker.shouldInspect(holder.file)) {\n return PsiElementVisitor.EMPTY_VISITOR\n }\n return localInspectionTool.buildVisitor(holder, isOnTheFly, session)\n }\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/DelegatePmdInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.LocalInspectionTool\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiFile\n\nimport org.jetbrains.annotations.Nls\n\n/**\n * @author caikang\n * @date 2017/02/28\n */\nclass DelegatePmdInspection : LocalInspectionTool(), AliBaseInspection, PmdRuleInspectionIdentify {\n\n private val ruleName: String? = null\n\n private val aliPmdInspection: AliPmdInspection\n\n init {\n aliPmdInspection = AliPmdInspection(ruleName!!)\n }\n\n override fun runForWholeFile(): Boolean {\n return aliPmdInspection.runForWholeFile()\n }\n\n override fun checkFile(file: PsiFile, manager: InspectionManager,\n isOnTheFly: Boolean): Array? {\n return aliPmdInspection.checkFile(file, manager, isOnTheFly)\n }\n\n override fun getStaticDescription(): String? {\n return aliPmdInspection.staticDescription\n }\n\n override fun ruleName(): String {\n return ruleName!!\n }\n\n @Nls\n override fun getDisplayName(): String {\n return aliPmdInspection.displayName\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return aliPmdInspection.defaultLevel\n }\n\n @Nls\n override fun getGroupDisplayName(): String {\n return aliPmdInspection.groupDisplayName\n }\n\n override fun isEnabledByDefault(): Boolean {\n return aliPmdInspection.isEnabledByDefault\n }\n\n override fun getShortName(): String {\n return aliPmdInspection.shortName\n }\n\n override fun isSuppressedFor(element: PsiElement): Boolean {\n return aliPmdInspection.isSuppressedFor(element)\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/PmdRuleInspectionIdentify.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\n/**\n *\n *\n * @author caikang\n * @date 2017/03/16\n6\n */\ninterface PmdRuleInspectionIdentify {\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/RuleInspectionUtils.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection\n\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.idea.util.HighlightDisplayLevels\nimport com.alibaba.p3c.idea.util.NumberConstants\nimport com.alibaba.p3c.pmd.I18nResources\nimport com.alibaba.smartfox.idea.common.util.getService\nimport com.google.common.base.Joiner\nimport com.google.common.collect.ImmutableMap\nimport com.google.common.collect.Lists\nimport com.google.common.collect.Maps\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.openapi.diagnostic.Logger\nimport com.intellij.openapi.util.io.FileUtil\nimport com.intellij.util.io.URLUtil\nimport freemarker.template.Configuration\nimport freemarker.template.TemplateException\nimport net.sourceforge.pmd.Rule\nimport net.sourceforge.pmd.RulePriority\nimport net.sourceforge.pmd.RuleSetFactory\nimport net.sourceforge.pmd.RuleSetNotFoundException\nimport org.apache.commons.lang3.StringUtils\nimport java.io.File\nimport java.io.IOException\nimport java.io.StringWriter\nimport java.net.URL\nimport java.net.URLDecoder\nimport java.nio.charset.StandardCharsets\nimport java.util.jar.JarFile\nimport java.util.regex.Pattern\n\n/**\n * @author caikang\n * @date 2016/12/16\n */\nobject RuleInspectionUtils {\n\n private val logger = Logger.getInstance(RuleInspectionUtils::class.java)\n private val ruleSetFilePattern = Pattern.compile(\"(java|vm)/ali-.*?\\\\.xml\")\n private val staticDescriptionTemplate = run {\n val cfg = Configuration(Configuration.VERSION_2_3_25)\n cfg.setClassForTemplateLoading(RuleInspectionUtils::class.java, \"/tpl\")\n cfg.defaultEncoding = \"UTF-8\"\n cfg.getTemplate(\"StaticDescriptionTemplate.ftl\")\n }\n\n private val ruleSetsPrefix = \"rulesets/\"\n\n private val ruleStaticDescriptions: Map\n private val ruleMessages: Map\n private val displayLevelMap: Map\n\n init {\n I18nResources.changeLanguage(P3cConfig::class.java.getService().locale)\n val builder = ImmutableMap.builder()\n val messageBuilder = ImmutableMap.builder()\n val displayLevelBuilder = ImmutableMap.builder()\n val rules = loadAllAlibabaRule()\n for (rule in rules) {\n builder.put(rule.name, parseStaticDescription(rule))\n messageBuilder.put(rule.name, rule.message)\n displayLevelBuilder.put(rule.name, getHighlightDisplayLevel(rule.priority))\n }\n ruleStaticDescriptions = builder.build()\n ruleMessages = messageBuilder.build()\n displayLevelMap = displayLevelBuilder.build()\n }\n\n fun getRuleStaticDescription(ruleName: String): String {\n return ruleStaticDescriptions[ruleName]!!\n }\n\n fun getHighlightDisplayLevel(ruleName: String): HighlightDisplayLevel {\n val level = displayLevelMap[ruleName]\n\n return level ?: HighlightDisplayLevel.WEAK_WARNING\n }\n\n fun getHighlightDisplayLevel(rulePriority: RulePriority): HighlightDisplayLevel {\n when (rulePriority) {\n RulePriority.HIGH -> return HighlightDisplayLevels.BLOCKER\n RulePriority.MEDIUM_HIGH -> return HighlightDisplayLevels.CRITICAL\n else -> return HighlightDisplayLevels.MAJOR\n }\n }\n\n fun getRuleMessage(ruleName: String): String {\n return ruleMessages[ruleName]!!\n }\n\n private fun parseStaticDescription(rule: Rule): String {\n val writer = StringWriter()\n try {\n val map = Maps.newHashMap()\n map.put(\"message\", StringUtils.trimToEmpty(rule.message))\n map.put(\"description\", StringUtils.trimToEmpty(rule.description))\n val examples = rule.examples.map {\n it?.trim {\n c ->\n c == '\\n'\n }\n }\n map.put(\"examples\", examples)\n staticDescriptionTemplate.process(map, writer)\n } catch (e: TemplateException) {\n logger.error(e)\n } catch (e: IOException) {\n logger.error(e)\n }\n return writer.toString()\n }\n\n private fun loadAllAlibabaRule(): List {\n try {\n Thread.currentThread().contextClassLoader = RuleInspectionUtils::class.java.classLoader\n val ruleSetConfigs = findRuleSetConfigs()\n val ruleSetFactory = RuleSetFactory()\n val ruleSets = ruleSetFactory.createRuleSets(\n Joiner.on(\",\").join(ruleSetConfigs).replace(\"/\".toRegex(), \"-\"))\n val map = Maps.newHashMap()\n ruleSets.allRuleSets\n .asSequence()\n .flatMap { it.rules.asSequence() }\n .forEach { map.put(it.name, it) }\n return Lists.newArrayList(map.values)\n } catch (e: IOException) {\n logger.warn(\"no available alibaba rules\")\n return emptyList()\n } catch (e: RuleSetNotFoundException) {\n logger.error(\"rule sets not found\", e)\n return emptyList()\n }\n\n }\n\n @Throws(IOException::class)\n private fun findRuleSetConfigs(): List {\n val ruleSets = Lists.newArrayList()\n val enumeration = RuleInspectionUtils::class.java.classLoader.getResources(ruleSetsPrefix)\n while (enumeration.hasMoreElements()) {\n val url = enumeration.nextElement()\n if (URLUtil.JAR_PROTOCOL == url.protocol) {\n findRuleSetsFromJar(ruleSets, url)\n } else if (URLUtil.FILE_PROTOCOL == url.protocol) {\n findRuleSetsFromDirectory(ruleSets, url)\n }\n }\n return ruleSets\n }\n\n @Throws(IOException::class)\n private fun findRuleSetsFromDirectory(ruleSets: MutableList, url: URL) {\n val file = File(url.path)\n if (file.exists() && file.isDirectory) {\n val files = Lists.newArrayList()\n FileUtil.collectMatchedFiles(file, ruleSetFilePattern, files)\n files.mapTo(ruleSets) { it.canonicalPath.replace(url.path, \"\").replace(\".xml\", \"\") }\n }\n }\n\n @Throws(IOException::class)\n private fun findRuleSetsFromJar(ruleSets: MutableList, url: URL) {\n logger.info(\"start to find rule sets from jar \" + url)\n var path = URLDecoder.decode(url.path, StandardCharsets.UTF_8.name())\n val index = path.lastIndexOf(URLUtil.JAR_SEPARATOR)\n if (index > NumberConstants.INDEX_0) {\n path = path.substring(\"file:\".length, index)\n }\n val jarFile = JarFile(path)\n logger.info(\"create jarFile for path \" + path)\n val jarEntries = jarFile.entries()\n while (jarEntries.hasMoreElements()) {\n val jarEntry = jarEntries.nextElement()\n val subPath = jarEntry.name.replace(ruleSetsPrefix, \"\")\n if (ruleSetFilePattern.matcher(subPath).find()) {\n val resultPath = subPath.replace(\".xml\", \"\")\n logger.info(\"get result rule set \" + resultPath)\n ruleSets.add(resultPath)\n }\n }\n logger.info(\"find rule sets from jar $url finished\")\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/standalone/AliAccessStaticViaInstanceInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection.standalone\n\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.inspection.AliBaseInspection\nimport com.alibaba.p3c.idea.util.HighlightDisplayLevels\nimport com.alibaba.smartfox.idea.common.util.getService\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInsight.daemon.impl.analysis.HighlightMessageUtil\nimport com.intellij.codeInsight.daemon.impl.analysis.HighlightUtil\nimport com.intellij.codeInsight.daemon.impl.analysis.JavaHighlightUtil\nimport com.intellij.codeInsight.daemon.impl.quickfix.AccessStaticViaInstanceFix\nimport com.intellij.codeInsight.daemon.impl.quickfix.RemoveUnusedVariableUtil\nimport com.intellij.codeInspection.ProblemsHolder\nimport com.intellij.codeInspection.accessStaticViaInstance.AccessStaticViaInstance\nimport com.intellij.psi.JavaElementVisitor\nimport com.intellij.psi.JavaResolveResult\nimport com.intellij.psi.PsiClass\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiElementVisitor\nimport com.intellij.psi.PsiMember\nimport com.intellij.psi.PsiModifier\nimport com.intellij.psi.PsiPackage\nimport com.intellij.psi.PsiReferenceExpression\nimport com.intellij.psi.PsiSubstitutor\nimport java.util.ArrayList\n\n/**\n * @author caikang\n * @date 2016/12/08\n */\nclass AliAccessStaticViaInstanceInspection : AccessStaticViaInstance, AliBaseInspection {\n val messageKey = \"com.alibaba.p3c.idea.inspection.standalone.AliAccessStaticViaInstanceInspection\"\n\n constructor()\n /**\n * For Javassist\n */\n constructor(any: Any?) : this()\n\n override fun getDisplayName(): String {\n return P3cBundle.getMessage(\"$messageKey.message\")\n }\n\n override fun getStaticDescription(): String? {\n return P3cBundle.getMessage(\"$messageKey.desc\")\n }\n\n override fun ruleName(): String {\n return \"AvoidAccessStaticViaInstanceRule\"\n }\n\n override fun getShortName(): String {\n return \"AliAccessStaticViaInstance\"\n }\n\n override fun createAccessStaticViaInstanceFix(expr: PsiReferenceExpression,\n onTheFly: Boolean,\n result: JavaResolveResult): AccessStaticViaInstanceFix {\n return object : AccessStaticViaInstanceFix(expr, result, onTheFly) {\n val fixKey = \"com.alibaba.p3c.idea.quickfix.standalone.AliAccessStaticViaInstanceInspection\"\n internal val text = calcText(result.element as PsiMember, result.substitutor)\n\n override fun getText(): String {\n return text\n }\n\n private fun calcText(member: PsiMember, substitutor: PsiSubstitutor): String {\n val aClass = member.containingClass ?: return \"\"\n val p3cConfig = P3cConfig::class.java.getService()\n return when (p3cConfig.locale) {\n P3cConfig.localeZh -> String.format(P3cBundle.getMessage(fixKey),\n HighlightUtil.formatClass(aClass, false),\n HighlightUtil.formatClass(aClass), HighlightMessageUtil.getSymbolName(member, substitutor))\n else -> String.format(P3cBundle.getMessage(fixKey), HighlightUtil.formatClass(aClass),\n HighlightMessageUtil.getSymbolName(member, substitutor),\n HighlightUtil.formatClass(aClass, false))\n }\n }\n }\n }\n\n override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {\n return object : JavaElementVisitor() {\n override fun visitReferenceExpression(expression: PsiReferenceExpression) {\n checkAccessStaticMemberViaInstanceReference(expression, holder, isOnTheFly)\n }\n }\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return HighlightDisplayLevels.BLOCKER\n }\n\n private fun checkAccessStaticMemberViaInstanceReference(expr: PsiReferenceExpression, holder: ProblemsHolder,\n onTheFly: Boolean) {\n val result = expr.advancedResolve(false)\n val resolved = result.element as? PsiMember ?: return\n\n val qualifierExpression = expr.qualifierExpression ?: return\n\n if (qualifierExpression is PsiReferenceExpression) {\n val qualifierResolved = qualifierExpression.resolve()\n if (qualifierResolved is PsiClass || qualifierResolved is PsiPackage) {\n return\n }\n }\n if (!resolved.hasModifierProperty(PsiModifier.STATIC)) {\n return\n }\n\n val description = String.format(P3cBundle.getMessage(\n \"$messageKey.errMsg\"),\n \"${JavaHighlightUtil.formatType(qualifierExpression.type)}.${HighlightMessageUtil.getSymbolName(\n resolved, result.substitutor)}\")\n if (!onTheFly) {\n if (RemoveUnusedVariableUtil.checkSideEffects(qualifierExpression, null, ArrayList())) {\n holder.registerProblem(expr, description)\n return\n }\n }\n holder.registerProblem(expr, description, createAccessStaticViaInstanceFix(expr, onTheFly, result))\n }\n\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/standalone/AliDeprecationInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection.standalone\n\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.inspection.AliBaseInspection\nimport com.alibaba.p3c.idea.util.HighlightDisplayLevels\nimport com.alibaba.smartfox.idea.common.util.getService\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.codeInspection.ProblemHighlightType\nimport com.intellij.codeInspection.ProblemsHolder\nimport com.intellij.codeInspection.deprecation.DeprecationInspection\nimport com.intellij.openapi.util.TextRange\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiElementVisitor\nimport com.intellij.psi.PsiReference\nimport org.jetbrains.annotations.Nls\nimport javax.swing.JComponent\n\n/**\n * @author caikang\n * @date 2016/12/08\n */\nclass AliDeprecationInspection : DeprecationInspection, AliBaseInspection {\n private val messageKey = \"com.alibaba.p3c.idea.inspection.standalone.AliDeprecationInspection\"\n\n constructor()\n /**\n * For Javassist\n */\n constructor(any: Any?) : this()\n\n init {\n IGNORE_INSIDE_DEPRECATED = true\n IGNORE_ABSTRACT_DEPRECATED_OVERRIDES = false\n IGNORE_IMPORT_STATEMENTS = false\n IGNORE_METHODS_OF_DEPRECATED = false\n }\n\n override fun getDisplayName(): String {\n return P3cBundle.getMessage(\"$messageKey.message\")\n }\n\n override fun ruleName(): String {\n return \"AvoidUseDeprecationApiRule\"\n }\n\n override fun getShortName(): String {\n return \"AliDeprecation\"\n }\n\n override fun getStaticDescription(): String? {\n return P3cBundle.getMessage(\"$messageKey.desc\")\n }\n\n override fun createOptionsPanel(): JComponent? {\n return null\n }\n\n override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {\n val p3cConfig = P3cConfig::class.java.getService()\n return when (p3cConfig.locale) {\n P3cConfig.localeEn -> super.buildVisitor(holder, isOnTheFly)\n else -> super.buildVisitor(DeprecationInspectionProblemsHolder(holder, isOnTheFly), isOnTheFly)\n }\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return HighlightDisplayLevels.CRITICAL\n }\n\n class DeprecationInspectionProblemsHolder(private val holder: ProblemsHolder, onTheFly: Boolean) : ProblemsHolder(\n holder.manager, holder.file, onTheFly) {\n\n override fun registerProblem(psiElement: PsiElement,\n @Nls descriptionTemplate: String,\n fixes: Array?) {\n holder.registerProblem(psiElement, getMessage(descriptionTemplate), *(fixes ?: emptyArray()))\n }\n\n override fun registerProblem(psiElement: PsiElement,\n @Nls descriptionTemplate: String,\n highlightType: ProblemHighlightType, fixes: Array?) {\n holder.registerProblem(psiElement, getMessage(descriptionTemplate), highlightType, *(fixes ?: emptyArray()))\n }\n\n override fun registerProblem(reference: PsiReference, descriptionTemplate: String,\n highlightType: ProblemHighlightType) {\n holder.registerProblem(reference, getMessage(descriptionTemplate), highlightType)\n }\n\n override fun registerProblemForReference(reference: PsiReference,\n highlightType: ProblemHighlightType, descriptionTemplate: String,\n fixes: Array?) {\n holder.registerProblemForReference(reference, highlightType, getMessage(descriptionTemplate),\n *(fixes ?: emptyArray()))\n }\n\n override fun registerProblem(psiElement: PsiElement, rangeInElement: TextRange?,\n message: String, fixes: Array?) {\n holder.registerProblem(psiElement, rangeInElement, getMessage(message), *(fixes ?: emptyArray()))\n }\n\n override fun registerProblem(psiElement: PsiElement, message: String,\n highlightType: ProblemHighlightType, rangeInElement: TextRange?,\n fixes: Array?) {\n holder.registerProblem(psiElement, getMessage(message), highlightType, rangeInElement,\n *(fixes ?: emptyArray()))\n }\n\n private fun getMessage(msg: String): String {\n return msg.replace(\"is deprecated\", \"已经过时了\").replace(\"Default constructor in\", \"默认构造函数\")\n .replace(\"Overrides deprecated method in\", \"重写了过时的方法\") + \" #loc\"\n }\n }\n\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/standalone/AliMissingOverrideAnnotationInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection.standalone\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.inspection.AliBaseInspection\nimport com.alibaba.p3c.idea.quickfix.DecorateInspectionGadgetsFix\nimport com.alibaba.p3c.idea.util.HighlightDisplayLevels\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.psi.CommonClassNames\nimport com.intellij.psi.PsiAnonymousClass\nimport com.intellij.psi.PsiClass\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiMethod\nimport com.intellij.psi.PsiModifier\nimport com.intellij.psi.PsiModifierListOwner\nimport com.intellij.psi.util.InheritanceUtil\nimport com.siyeh.ig.BaseInspectionVisitor\nimport com.siyeh.ig.InspectionGadgetsFix\nimport com.siyeh.ig.inheritance.MissingOverrideAnnotationInspection\nimport com.siyeh.ig.psiutils.MethodUtils\nimport javax.swing.JComponent\n\n/**\n * Batch QuickFix Supported\n * @author caikang\n * @date 2016/12/08\n */\nclass AliMissingOverrideAnnotationInspection : MissingOverrideAnnotationInspection, AliBaseInspection {\n private val messageKey = \"com.alibaba.p3c.idea.inspection.standalone.AliMissingOverrideAnnotationInspection\"\n\n constructor()\n /**\n * For Javassist\n */\n constructor(any: Any?) : this()\n\n init {\n ignoreAnonymousClassMethods = false\n ignoreObjectMethods = false\n }\n\n override fun getDisplayName(): String = P3cBundle.getMessage(\"$messageKey.message\")\n\n override fun getStaticDescription(): String? = P3cBundle.getMessage(\"$messageKey.desc\")\n\n override fun ruleName(): String = \"MissingOverrideAnnotationRule\"\n\n override fun buildErrorString(vararg infos: Any): String = P3cBundle.getMessage(\"$messageKey.errMsg\")\n\n override fun createOptionsPanel(): JComponent? = null\n\n override fun buildFix(vararg infos: Any): InspectionGadgetsFix? {\n val fix = super.buildFix(*infos) ?: return null\n return DecorateInspectionGadgetsFix(fix,\n P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.standalone.AliMissingOverrideAnnotationInspection\"))\n }\n\n override fun manualBuildFix(psiElement: PsiElement, isOnTheFly: Boolean): LocalQuickFix? = buildFix(psiElement)\n\n override fun getDefaultLevel(): HighlightDisplayLevel = HighlightDisplayLevels.BLOCKER\n\n override fun buildVisitor(): BaseInspectionVisitor = MissingOverrideAnnotationVisitor()\n\n private inner class MissingOverrideAnnotationVisitor : BaseInspectionVisitor() {\n\n override fun visitMethod(method: PsiMethod) {\n if (method.nameIdentifier == null) {\n return\n }\n if (method.isConstructor) {\n return\n }\n if (method.hasModifierProperty(PsiModifier.PRIVATE) || method.hasModifierProperty(PsiModifier.STATIC)) {\n return\n }\n val methodClass = method.containingClass ?: return\n if (ignoreAnonymousClassMethods && methodClass is PsiAnonymousClass) {\n return\n }\n if (hasOverrideAnnotation(method)) {\n return\n }\n if (!isJdk6Override(method, methodClass) && !isJdk5Override(method, methodClass)) {\n return\n }\n if (ignoreObjectMethods && (MethodUtils.isHashCode(method) ||\n MethodUtils.isEquals(method) ||\n MethodUtils.isToString(method))) {\n return\n }\n registerMethodError(method)\n }\n\n private fun hasOverrideAnnotation(element: PsiModifierListOwner): Boolean {\n val modifierList = element.modifierList\n return modifierList?.findAnnotation(CommonClassNames.JAVA_LANG_OVERRIDE) != null\n }\n\n private fun isJdk6Override(method: PsiMethod, methodClass: PsiClass): Boolean {\n val superMethods = method.findSuperMethods()\n var hasSupers = false\n for (superMethod in superMethods) {\n val superClass = superMethod.containingClass\n if (!InheritanceUtil.isInheritorOrSelf(methodClass, superClass, true)) {\n continue\n }\n hasSupers = true\n if (!superMethod.hasModifierProperty(PsiModifier.PROTECTED)) {\n return true\n }\n }\n // is override except if this is an interface method\n // overriding a protected method in java.lang.Object\n // http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6501053\n return hasSupers && !methodClass.isInterface\n }\n\n private fun isJdk5Override(method: PsiMethod, methodClass: PsiClass): Boolean {\n val superMethods = method.findSuperMethods()\n for (superMethod in superMethods) {\n val superClass = superMethod.containingClass\n if (superClass == null || !InheritanceUtil.isInheritorOrSelf(methodClass, superClass, true)) {\n continue\n }\n if (superClass.isInterface) {\n continue\n }\n if (methodClass.isInterface && superMethod.hasModifierProperty(PsiModifier.PROTECTED)) {\n // only true for J2SE java.lang.Object.clone(), but might\n // be different on other/newer java platforms\n continue\n }\n return true\n }\n return false\n }\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/inspection/standalone/MapOrSetKeyShouldOverrideHashCodeEqualsInspection.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.inspection.standalone\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.alibaba.p3c.idea.inspection.AliBaseInspection\nimport com.alibaba.p3c.idea.util.HighlightDisplayLevels\nimport com.alibaba.p3c.idea.util.NumberConstants\nimport com.alibaba.p3c.idea.util.ObjectConstants\nimport com.google.common.collect.Sets\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\nimport com.intellij.ide.highlighter.JavaFileType\nimport com.intellij.psi.CommonClassNames\nimport com.intellij.psi.PsiClass\nimport com.intellij.psi.PsiClassType\nimport com.intellij.psi.PsiMethodCallExpression\nimport com.intellij.psi.PsiType\nimport com.intellij.psi.PsiTypeParameter\nimport com.intellij.psi.PsiVariable\nimport com.siyeh.ig.BaseInspection\nimport com.siyeh.ig.BaseInspectionVisitor\nimport org.jetbrains.annotations.NonNls\n\n/**\n * @author caikang\n * @date 2017/03/01\n */\nclass MapOrSetKeyShouldOverrideHashCodeEqualsInspection : BaseInspection, AliBaseInspection {\n val messageKey = \"com.alibaba.p3c.idea.inspection.standalone.MapOrSetKeyShouldOverrideHashCodeEqualsInspection\"\n\n constructor()\n /**\n * For Javassist\n */\n constructor(any: Any?) : this()\n\n override fun getDisplayName(): String {\n return P3cBundle.getMessage(\"$messageKey.message\")\n }\n\n override fun getStaticDescription(): String? {\n return P3cBundle.getMessage(\"$messageKey.desc\")\n }\n\n override fun buildErrorString(vararg infos: Any): String {\n val type = infos[0] as PsiClassType\n return String.format(P3cBundle.getMessage(\"$messageKey.errMsg\"), type.className)\n }\n\n override fun buildVisitor(): BaseInspectionVisitor {\n return MapOrSetKeyVisitor()\n }\n\n override fun ruleName(): String {\n return \"MapOrSetKeyShouldOverrideHashCodeEqualsRule\"\n }\n\n override fun getDefaultLevel(): HighlightDisplayLevel {\n return HighlightDisplayLevels.CRITICAL\n }\n\n internal enum class ClassType {\n /**\n * parameter type is Set\n */\n SET,\n MAP, OTHER;\n\n override fun toString(): String {\n val string = super.toString()\n return string[0] + string.substring(1).toLowerCase()\n }\n }\n\n private class MapOrSetKeyVisitor : BaseInspectionVisitor() {\n\n private fun getClassType(aClass: PsiClass?): ClassType {\n return isMapOrSet(aClass, Sets.newHashSet())\n }\n\n private fun isMapOrSet(aClass: PsiClass?, visitedClasses: MutableSet): ClassType {\n if (aClass == null) {\n return ClassType.OTHER\n }\n if (!visitedClasses.add(aClass)) {\n return ClassType.OTHER\n }\n @NonNls\n val className = aClass.qualifiedName\n if (CommonClassNames.JAVA_UTIL_SET == className) {\n return ClassType.SET\n }\n if (CommonClassNames.JAVA_UTIL_MAP == className) {\n return ClassType.MAP\n }\n val supers = aClass.supers\n return supers\n .map { isMapOrSet(it, visitedClasses) }\n .firstOrNull { it != ClassType.OTHER }\n ?: ClassType.OTHER\n }\n\n override fun visitVariable(variable: PsiVariable) {\n super.visitVariable(variable)\n val typeElement = variable.typeElement ?: return\n val type = typeElement.type as? PsiClassType ?: return\n val referenceElement = typeElement.innermostComponentReferenceElement ?: return\n val aClass = type.resolve()\n\n val collectionType = getClassType(aClass)\n if (collectionType == ClassType.OTHER) {\n return\n }\n val parameterList = referenceElement.parameterList\n if (parameterList == null || parameterList.typeParameterElements.size == NumberConstants.INTEGER_SIZE_OR_LENGTH_0) {\n return\n }\n val psiType = parameterList.typeArguments[0]\n if (!redefineHashCodeEquals(psiType)) {\n registerError(parameterList.typeParameterElements[0], psiType)\n }\n }\n\n override fun visitMethodCallExpression(expression: PsiMethodCallExpression) {\n val methodExpression = expression.methodExpression\n val qualifierExpression = methodExpression.qualifierExpression ?: return\n val type = qualifierExpression.type as? PsiClassType ?: return\n val aClass = type.resolve()\n\n val collectionType = getClassType(aClass)\n if (collectionType == ClassType.OTHER) {\n return\n }\n @NonNls\n val methodName = methodExpression.referenceName\n if (collectionType == ClassType.SET && ObjectConstants.METHOD_NAME_ADD != methodName) {\n return\n }\n if (collectionType == ClassType.MAP && ObjectConstants.METHOD_NAME_PUT != methodName) {\n return\n }\n val argumentList = expression.argumentList\n val arguments = argumentList.expressions\n if (collectionType == ClassType.SET && arguments.size != NumberConstants.INTEGER_SIZE_OR_LENGTH_1) {\n return\n }\n if (collectionType == ClassType.MAP && arguments.size != NumberConstants.INTEGER_SIZE_OR_LENGTH_2) {\n return\n }\n val argument = arguments[0]\n val argumentType = argument.type\n if (argumentType == null || redefineHashCodeEquals(argumentType)) {\n return\n }\n registerMethodCallError(expression, argumentType)\n }\n }\n\n companion object {\n\n private val skipJdkPackageJava = \"java.\"\n private val skipJdkPackageJavax = \"javax.\"\n\n private fun redefineHashCodeEquals(psiType: PsiType): Boolean {\n if (psiType !is PsiClassType) {\n return true\n }\n val psiClass = psiType.resolve() ?: return false\n val skip = psiClass.containingFile == null || psiClass is PsiTypeParameter\n || psiClass.isEnum || psiClass.isInterface\n || psiClass.containingFile.fileType !is JavaFileType\n || psiClass.qualifiedName?.startsWith(skipJdkPackageJava) ?: false\n || psiClass.qualifiedName?.startsWith(skipJdkPackageJavax) ?: false\n if (skip) {\n return true\n }\n val hashCodeMethods = psiClass.findMethodsByName(ObjectConstants.METHOD_NAME_HASHCODE, false)\n if (hashCodeMethods.size == NumberConstants.INTEGER_SIZE_OR_LENGTH_0) {\n return false\n }\n val equalsMethods = psiClass.findMethodsByName(ObjectConstants.METHOD_NAME_EQUALS, false)\n return equalsMethods.size > NumberConstants.INTEGER_SIZE_OR_LENGTH_0\n }\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/pmd/AliPmdProcessor.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.pmd\n\nimport com.alibaba.p3c.idea.component.AliProjectComponent\nimport com.google.common.base.Throwables\nimport com.intellij.openapi.application.ex.ApplicationUtil\nimport com.intellij.openapi.diagnostic.Logger\nimport com.intellij.openapi.fileEditor.FileDocumentManager\nimport com.intellij.openapi.progress.ProcessCanceledException\nimport com.intellij.psi.PsiFile\nimport net.sourceforge.pmd.PMDConfiguration\nimport net.sourceforge.pmd.PMDException\nimport net.sourceforge.pmd.Report\nimport net.sourceforge.pmd.Rule\nimport net.sourceforge.pmd.RuleContext\nimport net.sourceforge.pmd.RuleSetFactory\nimport net.sourceforge.pmd.RuleSets\nimport net.sourceforge.pmd.RuleViolation\nimport net.sourceforge.pmd.RulesetsFactoryUtils\nimport net.sourceforge.pmd.util.ResourceLoader\nimport java.io.IOException\nimport java.io.StringReader\nimport net.sourceforge.pmd.SourceCodeProcessor as PmdSourceCodeProcessor\n\n/**\n * @author caikang\n * @date 2016/12/11\n */\nclass AliPmdProcessor private constructor(val rule: Rule? = null, val ruleSets: RuleSets? = null) {\n constructor(rule: Rule) : this(rule, null)\n constructor(ruleSets: RuleSets) : this(null, ruleSets)\n\n private val ruleSetFactory: RuleSetFactory\n private val configuration = PMDConfiguration()\n\n init {\n ruleSetFactory = RulesetsFactoryUtils.getRulesetFactory(configuration, ResourceLoader())\n }\n\n fun processFile(psiFile: PsiFile, isOnTheFly: Boolean): List {\n configuration.setSourceEncoding(psiFile.virtualFile.charset.name())\n configuration.inputPaths = psiFile.virtualFile.canonicalPath\n val document = FileDocumentManager.getInstance().getDocument(psiFile.virtualFile) ?: return emptyList()\n val project = psiFile.project\n val aliProjectComponent = project.getComponent(AliProjectComponent::class.java)\n val fileContext = aliProjectComponent.getFileContext(psiFile.virtualFile) ?: return emptyList()\n val ctx = RuleContext()\n val niceFileName = psiFile.virtualFile.canonicalPath!!\n val report = Report.createReport(ctx, niceFileName)\n val processRuleSets = ruleSets ?: RuleSets().also { rs ->\n val ruleSet = ruleSetFactory.createSingleRuleRuleSet(rule)\n rs.addRuleSet(ruleSet)\n }\n\n\n LOG.debug(\"Processing \" + ctx.sourceCodeFilename)\n try {\n val reader = StringReader(document.text)\n ctx.languageVersion = null\n if (isOnTheFly) {\n SourceCodeProcessor(configuration, document, fileContext, isOnTheFly).processSourceCode(\n reader,\n processRuleSets,\n ctx\n )\n } else {\n PmdSourceCodeProcessor(configuration).processSourceCode(reader, processRuleSets, ctx)\n }\n } catch (pmde: PMDException) {\n LOG.debug(\"Error while processing file: $niceFileName\", pmde.cause)\n report.addError(Report.ProcessingError(pmde, niceFileName))\n } catch (ioe: IOException) {\n LOG.error(\"Unable to read source file: $niceFileName\", ioe)\n } catch (pce: ProcessCanceledException) {\n throw pce\n } catch (re: RuntimeException) {\n val root = Throwables.getRootCause(re)\n if (root !is ApplicationUtil.CannotRunReadActionException) {\n LOG.error(\"RuntimeException while processing file: $niceFileName\", re)\n }\n }\n return ctx.report.toList()\n }\n\n companion object {\n private val LOG = Logger.getInstance(AliPmdProcessor::class.java)\n }\n\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/pmd/SourceCodeProcessor.kt",
"content": "/**\n * BSD-style license; for more info see http://pmd.sourceforge.net/license.html\n */\n\npackage com.alibaba.p3c.idea.pmd\n\nimport com.alibaba.p3c.idea.component.AliProjectComponent.FileContext\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.idea.util.withLockNotInline\nimport com.alibaba.p3c.idea.util.withTryLock\nimport com.google.common.cache.Cache\nimport com.google.common.cache.CacheBuilder\nimport com.intellij.openapi.components.ServiceManager\nimport com.intellij.openapi.diagnostic.Logger\nimport com.intellij.openapi.editor.Document\nimport net.sourceforge.pmd.PMD\nimport net.sourceforge.pmd.PMDConfiguration\nimport net.sourceforge.pmd.PMDException\nimport net.sourceforge.pmd.RuleContext\nimport net.sourceforge.pmd.RuleSets\nimport net.sourceforge.pmd.benchmark.TimeTracker\nimport net.sourceforge.pmd.benchmark.TimedOperationCategory\nimport net.sourceforge.pmd.lang.Language\nimport net.sourceforge.pmd.lang.LanguageVersion\nimport net.sourceforge.pmd.lang.LanguageVersionHandler\nimport net.sourceforge.pmd.lang.Parser\nimport net.sourceforge.pmd.lang.ast.Node\nimport net.sourceforge.pmd.lang.ast.ParseException\nimport java.io.Reader\nimport java.util.concurrent.TimeUnit\nimport java.util.concurrent.TimeUnit.MILLISECONDS\n\nclass SourceCodeProcessor(\n private val configuration: PMDConfiguration,\n private val document: Document,\n private val fileContext: FileContext,\n private val isOnTheFly: Boolean\n) {\n\n /**\n * Processes the input stream against a rule set using the given input\n * encoding. If the LanguageVersion is `null` on the RuleContext,\n * it will be automatically determined. Any code which wishes to process\n * files for different Languages, will need to be sure to either properly\n * set the Language on the RuleContext, or set it to `null`\n * first.\n *\n * @see RuleContext.setLanguageVersion\n * @see PMDConfiguration.getLanguageVersionOfFile\n * @param sourceCode\n * The Reader to analyze.\n * @param ruleSets\n * The collection of rules to process against the file.\n * @param ctx\n * The context in which PMD is operating.\n * @throws PMDException\n * if the input encoding is unsupported, the input stream could\n * not be parsed, or other error is encountered.\n */\n @Throws(PMDException::class)\n fun processSourceCode(sourceCode: Reader, ruleSets: RuleSets, ctx: RuleContext) {\n determineLanguage(ctx)\n try {\n ruleSets.start(ctx)\n processSource(sourceCode, ruleSets, ctx)\n } catch (pe: ParseException) {\n configuration.analysisCache.analysisFailed(ctx.sourceCodeFile)\n throw PMDException(\"Error while parsing \" + ctx.sourceCodeFilename, pe)\n } catch (e: Exception) {\n configuration.analysisCache.analysisFailed(ctx.sourceCodeFile)\n throw PMDException(\"Error while processing \" + ctx.sourceCodeFilename, e)\n } finally {\n ruleSets.end(ctx)\n }\n }\n\n private fun parse(ctx: RuleContext, sourceCode: Reader, parser: Parser): Node {\n TimeTracker.startOperation(TimedOperationCategory.PARSER).use {\n val rootNode = parser.parse(ctx.sourceCodeFilename, sourceCode)\n ctx.report.suppress(parser.suppressMap)\n return rootNode\n }\n }\n\n private fun getRootNode(sourceCode: Reader, ruleSets: RuleSets, ctx: RuleContext): Node? {\n if (!smartFoxConfig.astCacheEnable) {\n return parseNode(ctx, ruleSets, sourceCode)\n }\n val node = getNode(ctx.sourceCodeFilename, isOnTheFly)\n if (node != null) {\n return node\n }\n if (document.lineCount > 3000 && isOnTheFly) {\n return null\n }\n val lock = fileContext.lock\n val readLock = lock.readLock()\n val writeLock = lock.writeLock()\n val ruleName = ruleSets.allRules.joinToString(\",\") { it.name }\n val fileName = ctx.sourceCodeFilename\n val readAction = {\n getNode(ctx.sourceCodeFilename, isOnTheFly)\n }\n val cacheNode = if (isOnTheFly) {\n readLock.withTryLock(50, MILLISECONDS, readAction)\n } else {\n val start = System.currentTimeMillis()\n LOG.info(\"rule:$ruleName,file:$fileName require read lock\")\n readLock.withLockNotInline(readAction).also {\n LOG.info(\"rule:$ruleName,file:$fileName get result $it with read lock ,elapsed ${System.currentTimeMillis() - start}\")\n }\n }\n if (cacheNode != null) {\n return cacheNode\n }\n val writeAction = {\n val finalNode = getNode(ctx.sourceCodeFilename, isOnTheFly)\n if (finalNode == null) {\n val start = System.currentTimeMillis()\n if (!isOnTheFly) {\n LOG.info(\"rule:$ruleName,file:$fileName parse with write lock\")\n }\n parseNode(ctx, ruleSets, sourceCode).also {\n if (!isOnTheFly) {\n LOG.info(\"rule:$ruleName,file:$fileName get result $it parse with write lock ,elapsed ${System.currentTimeMillis() - start}\")\n }\n }\n } else {\n finalNode\n }\n }\n return if (isOnTheFly) {\n writeLock.withTryLock(50, MILLISECONDS, writeAction)!!\n } else {\n writeLock.withLockNotInline(\n writeAction\n )!!\n }\n }\n\n private fun parseNode(ctx: RuleContext, ruleSets: RuleSets, sourceCode: Reader): Node {\n val languageVersion = ctx.languageVersion\n val languageVersionHandler = languageVersion.languageVersionHandler\n val parser = PMD.parserFor(languageVersion, configuration)\n val rootNode = parse(ctx, sourceCode, parser)\n symbolFacade(rootNode, languageVersionHandler)\n val language = languageVersion.language\n usesDFA(languageVersion, rootNode, ruleSets, language)\n usesTypeResolution(languageVersion, rootNode, ruleSets, language)\n onlyTheFlyCache.put(ctx.sourceCodeFilename, rootNode)\n userTriggerNodeCache.put(ctx.sourceCodeFilename, rootNode)\n return rootNode\n }\n\n private fun symbolFacade(rootNode: Node, languageVersionHandler: LanguageVersionHandler) {\n TimeTracker.startOperation(TimedOperationCategory.SYMBOL_TABLE)\n .use { languageVersionHandler.getSymbolFacade(configuration.classLoader).start(rootNode) }\n }\n\n private fun resolveQualifiedNames(rootNode: Node, handler: LanguageVersionHandler) {\n TimeTracker.startOperation(TimedOperationCategory.QUALIFIED_NAME_RESOLUTION)\n .use { handler.getQualifiedNameResolutionFacade(configuration.classLoader).start(rootNode) }\n }\n\n // private ParserOptions getParserOptions(final LanguageVersionHandler\n // languageVersionHandler) {\n // // TODO Handle Rules having different parser options.\n // ParserOptions parserOptions =\n // languageVersionHandler.getDefaultParserOptions();\n // parserOptions.setSuppressMarker(configuration.getSuppressMarker());\n // return parserOptions;\n // }\n\n private fun usesDFA(languageVersion: LanguageVersion, rootNode: Node, ruleSets: RuleSets, language: Language) {\n if (ruleSets.usesDFA(language)) {\n TimeTracker.startOperation(TimedOperationCategory.DFA).use { to ->\n val dataFlowFacade = languageVersion.languageVersionHandler.dataFlowFacade\n dataFlowFacade.start(rootNode)\n }\n }\n }\n\n private fun usesTypeResolution(\n languageVersion: LanguageVersion, rootNode: Node, ruleSets: RuleSets,\n language: Language\n ) {\n\n if (ruleSets.usesTypeResolution(language)) {\n TimeTracker.startOperation(TimedOperationCategory.TYPE_RESOLUTION).use { to ->\n languageVersion.languageVersionHandler.getTypeResolutionFacade(configuration.classLoader)\n .start(rootNode)\n }\n }\n }\n\n private fun usesMultifile(\n rootNode: Node, languageVersionHandler: LanguageVersionHandler, ruleSets: RuleSets,\n language: Language\n ) {\n\n if (ruleSets.usesMultifile(language)) {\n TimeTracker.startOperation(TimedOperationCategory.MULTIFILE_ANALYSIS)\n .use { languageVersionHandler.multifileFacade.start(rootNode) }\n }\n }\n\n private fun processSource(sourceCode: Reader, ruleSets: RuleSets, ctx: RuleContext) {\n val languageVersion = ctx.languageVersion\n val languageVersionHandler = languageVersion.languageVersionHandler\n\n val rootNode = getRootNode(sourceCode, ruleSets, ctx) ?: return\n resolveQualifiedNames(rootNode, languageVersionHandler)\n symbolFacade(rootNode, languageVersionHandler)\n val language = languageVersion.language\n usesDFA(languageVersion, rootNode, ruleSets, language)\n usesTypeResolution(languageVersion, rootNode, ruleSets, language)\n usesMultifile(rootNode, languageVersionHandler, ruleSets, language)\n\n val acus = listOf(rootNode)\n ruleSets.apply(acus, ctx, language)\n }\n\n private fun determineLanguage(ctx: RuleContext) {\n // If LanguageVersion of the source file is not known, make a\n // determination\n if (ctx.languageVersion == null) {\n val languageVersion = configuration.getLanguageVersionOfFile(ctx.sourceCodeFilename)\n ctx.languageVersion = languageVersion\n }\n }\n\n companion object {\n val smartFoxConfig = ServiceManager.getService(P3cConfig::class.java)!!\n private lateinit var onlyTheFlyCache: Cache\n private lateinit var userTriggerNodeCache: Cache\n private val LOG = Logger.getInstance(SourceCodeProcessor::class.java)\n\n init {\n reInitNodeCache(smartFoxConfig.astCacheTime)\n }\n\n fun reInitNodeCache(expireTime: Long) {\n onlyTheFlyCache = CacheBuilder.newBuilder().concurrencyLevel(16)\n .expireAfterWrite(expireTime, TimeUnit.MILLISECONDS)\n .maximumSize(300)\n .build()!!\n\n userTriggerNodeCache = CacheBuilder.newBuilder().concurrencyLevel(16)\n .expireAfterWrite(10, TimeUnit.MINUTES)\n .maximumSize(300)\n .build()!!\n }\n\n fun invalidateCache(file: String) {\n onlyTheFlyCache.invalidate(file)\n userTriggerNodeCache.invalidate(file)\n }\n\n fun invalidUserTrigger(file: String) {\n userTriggerNodeCache.invalidate(file)\n }\n\n fun invalidateAll() {\n onlyTheFlyCache.invalidateAll()\n userTriggerNodeCache.invalidateAll()\n }\n\n fun getNode(file: String, isOnTheFly: Boolean): Node? {\n return if (isOnTheFly) onlyTheFlyCache.getIfPresent(file) else userTriggerNodeCache.getIfPresent(file)\n }\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/pmd/index/InspectionDataSource.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.pmd.index\n\nimport com.intellij.util.indexing.FileContent\nimport net.sourceforge.pmd.util.datasource.DataSource\nimport java.io.ByteArrayInputStream\nimport java.io.IOException\nimport java.io.InputStream\n\n/**\n * @author caikang\n * @date 2016/12/11\n */\nclass InspectionDataSource(private val fileContent: FileContent) : DataSource {\n\n @Throws(IOException::class)\n override fun getInputStream(): InputStream {\n return ByteArrayInputStream(fileContent.content)\n }\n\n override fun getNiceFileName(shortNames: Boolean, inputFileName: String?): String {\n return fileContent.fileName\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/pmd/index/InspectionRenderer.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.pmd.index\n\nimport net.sourceforge.pmd.Report\nimport net.sourceforge.pmd.RuleViolation\nimport net.sourceforge.pmd.renderers.AbstractRenderer\nimport net.sourceforge.pmd.renderers.Renderer\nimport net.sourceforge.pmd.util.datasource.DataSource\nimport java.io.IOException\n\n/**\n * @author caikang\n * @date 2016/12/11\n */\nclass InspectionRenderer : AbstractRenderer(\"InspectionRenderer\", \"Idea Inspection for pmd result\"), Renderer {\n private lateinit var ruleProblems: List\n\n override fun defaultFileExtension(): String? {\n return null\n }\n\n @Throws(IOException::class)\n override fun start() {\n }\n\n override fun startFileAnalysis(dataSource: DataSource) {\n }\n\n @Throws(IOException::class)\n override fun renderFileReport(report: Report) {\n ruleProblems = report.map { it }\n }\n\n @Throws(IOException::class)\n override fun end() {\n }\n\n fun getViolations(): List {\n return ruleProblems\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/quickfix/AliQuickFix.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.quickfix\n\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.openapi.actionSystem.ActionManager\nimport com.intellij.openapi.actionSystem.AnActionEvent\nimport com.intellij.openapi.actionSystem.CommonDataKeys\nimport com.intellij.openapi.fileEditor.FileEditorManager\nimport com.intellij.openapi.project.Project\nimport com.intellij.psi.JavaPsiFacade\nimport com.intellij.psi.PsiDocumentManager\nimport com.intellij.psi.PsiFile\nimport com.intellij.psi.PsiIdentifier\nimport com.intellij.psi.PsiLocalVariable\nimport com.intellij.psi.PsiMember\nimport com.intellij.psi.PsiParameter\n\n/**\n *\n *\n * @author caikang\n * @date 2017/02/27\n */\ninterface AliQuickFix : LocalQuickFix {\n\n val ruleName: String\n val onlyOnThFly: Boolean\n\n override fun getFamilyName(): String {\n return groupName\n }\n\n companion object {\n const val groupName = \"Ali QuickFix\"\n\n fun doQuickFix(newIdentifier: String, project: Project, psiIdentifier: PsiIdentifier) {\n val offset = psiIdentifier.textOffset\n val cannotFix = psiIdentifier.parent !is PsiMember\n && !(psiIdentifier.parent is PsiLocalVariable || psiIdentifier.parent is PsiParameter)\n if (cannotFix) {\n return\n }\n\n val editor = FileEditorManager.getInstance(project).selectedTextEditor ?: return\n editor.caretModel.moveToOffset(psiIdentifier.textOffset)\n val anAction = ActionManager.getInstance().getAction(\"RenameElement\")\n val psiFile = psiIdentifier.containingFile\n commitDocumentIfNeeded(psiFile, project)\n val event = AnActionEvent.createFromDataContext(\"MainMenu\", anAction.templatePresentation) {\n when (it) {\n CommonDataKeys.PROJECT.name -> project\n CommonDataKeys.EDITOR.name -> editor\n CommonDataKeys.PSI_FILE.name -> psiFile\n CommonDataKeys.PSI_ELEMENT.name -> psiIdentifier.parent\n else -> null\n }\n }\n val psiFacade = JavaPsiFacade.getInstance(project)\n val factory = psiFacade.elementFactory\n\n anAction.actionPerformed(event)\n\n // origin PsiIdentifier is unavailable\n psiFile.findElementAt(offset)?.replace(factory.createIdentifier(newIdentifier))\n }\n\n private fun commitDocumentIfNeeded(file: PsiFile?, project: Project) {\n if (file == null) {\n return\n }\n val manager = PsiDocumentManager.getInstance(project)\n val cachedDocument = manager.getCachedDocument(file) ?: return\n manager.commitDocument(cachedDocument)\n }\n\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/quickfix/AvoidStartWithDollarAndUnderLineNamingQuickFix.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.quickfix\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.openapi.project.Project\nimport com.intellij.psi.PsiIdentifier\nimport org.apache.commons.lang3.StringUtils\n\n/**\n *\n *\n * @author caikang\n * @date 2017/02/28\n */\nobject AvoidStartWithDollarAndUnderLineNamingQuickFix : AliQuickFix {\n override val ruleName: String\n get() = \"AvoidStartWithDollarAndUnderLineNamingRule\"\n override val onlyOnThFly: Boolean\n get() = true\n\n override fun getName(): String {\n return P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.delete_$\")\n }\n\n override fun applyFix(project: Project, descriptor: ProblemDescriptor) {\n val psiIdentifier = descriptor.psiElement as? PsiIdentifier ?: return\n val identifier = psiIdentifier.text\n val resultName = StringUtils.replacePattern(identifier, \"^[\\$_]+\", \"\")\n if (resultName.toLongOrNull() != null) {\n return\n }\n AliQuickFix.doQuickFix(resultName, project, psiIdentifier)\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/quickfix/ClassMustHaveAuthorQuickFix.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.quickfix\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.openapi.project.Project\nimport com.intellij.psi.JavaPsiFacade\nimport com.intellij.psi.PsiClass\nimport com.intellij.psi.javadoc.PsiDocToken\nimport com.siyeh.ig.InspectionGadgetsFix\n\n/**\n *\n *\n * @author caikang\n * @date 2017/02/27\n */\nobject ClassMustHaveAuthorQuickFix : InspectionGadgetsFix(), AliQuickFix {\n\n val tag = \"@author ${System.getProperty(\"user.name\") ?: System.getenv(\"USER\")}\"\n\n override fun doFix(project: Project?, descriptor: ProblemDescriptor?) {\n descriptor ?: return\n val psiClass = descriptor.psiElement as? PsiClass ?: descriptor.psiElement?.parent as? PsiClass ?: return\n\n val document = psiClass.docComment\n val psiFacade = JavaPsiFacade.getInstance(project)\n val factory = psiFacade.elementFactory\n if (document == null) {\n val doc = factory.createDocCommentFromText(\"\"\"\n/**\n * $tag\n */\n\"\"\")\n if (psiClass.isEnum) {\n psiClass.containingFile.addAfter(doc, psiClass.prevSibling)\n } else {\n psiClass.addBefore(doc, psiClass.firstChild)\n }\n return\n }\n\n val regex = Regex(\"Created by (.*) on (.*)\\\\.\")\n for (line in document.descriptionElements) {\n if (line is PsiDocToken && line.text.contains(regex)) {\n val groups = regex.find(line.text)?.groups ?: continue\n val author = groups[1]?.value ?: continue\n val date = groups[2]?.value ?: continue\n document.addBefore(factory.createDocTagFromText(\"@date $date\"), line)\n document.addBefore(factory.createDocTagFromText(\"@author $author\"), line)\n line.delete()\n return\n }\n }\n\n if (document.tags.isNotEmpty()) {\n document.addBefore(factory.createDocTagFromText(tag), document.tags[0])\n return\n }\n\n document.add(factory.createDocTagFromText(tag))\n }\n\n override val ruleName: String\n get() = \"ClassMustHaveAuthorRule\"\n override val onlyOnThFly: Boolean\n get() = true\n\n override fun getName(): String {\n return P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.generate.author\")\n }\n\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/quickfix/ConstantFieldShouldBeUpperCaseQuickFix.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.quickfix\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.google.common.base.Splitter\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.openapi.project.Project\nimport com.intellij.psi.PsiIdentifier\n\n/**\n *\n *\n * @author caikang\n * @date 2017/02/28\n */\nobject ConstantFieldShouldBeUpperCaseQuickFix : AliQuickFix {\n val separator = '_'\n\n override fun getName(): String {\n return P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.field.to.upperCaseWithUnderscore\")\n }\n\n override fun applyFix(project: Project, descriptor: ProblemDescriptor) {\n val psiIdentifier = descriptor.psiElement as? PsiIdentifier ?: return\n val identifier = psiIdentifier.text\n val list = Splitter.on(separator).trimResults().omitEmptyStrings().splitToList(identifier)\n\n val resultName = list.joinToString(separator.toString()) {\n separateCamelCase(it).toUpperCase()\n }\n\n AliQuickFix.doQuickFix(resultName, project, psiIdentifier)\n }\n\n private fun separateCamelCase(name: String): String {\n val translation = StringBuilder()\n\n\n for (i in 0 until name.length - 1) {\n val character = name[i]\n val next = name[i + 1]\n if (Character.isUpperCase(character) && !next.isUpperCase() && translation.isNotEmpty()) {\n translation.append(separator)\n }\n if (character != separator) {\n translation.append(character)\n }\n }\n val last = name.last()\n if (last != separator) {\n translation.append(last)\n }\n return translation.toString()\n }\n\n override val ruleName: String\n get() = \"ConstantFieldShouldBeUpperCaseRule\"\n override val onlyOnThFly: Boolean\n get() = true\n\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/quickfix/DecorateInspectionFix.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.quickfix\n\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.openapi.project.Project\nimport com.siyeh.ig.InspectionGadgetsFix\n\n/**\n *\n *\n * @author caikang\n * @date 2017/03/02\n */\nclass DecorateInspectionGadgetsFix(val fix: InspectionGadgetsFix,\n internal val name: String,\n internal val familyName: String = name) : InspectionGadgetsFix() {\n override fun getName(): String {\n return name\n }\n\n override fun doFix(project: Project, descriptor: ProblemDescriptor) {\n fix.applyFix(project, descriptor)\n }\n\n\n override fun getFamilyName(): String {\n return familyName\n }\n\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/quickfix/LowerCamelCaseVariableNamingQuickFix.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.quickfix\n\nimport com.alibaba.p3c.idea.i18n.P3cBundle\nimport com.google.common.base.Splitter\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.openapi.project.Project\nimport com.intellij.psi.PsiIdentifier\n\n/**\n *\n *\n * @author caikang\n * @date 2017/02/28\n */\nobject LowerCamelCaseVariableNamingQuickFix : AliQuickFix {\n override val ruleName: String\n get() = \"LowerCamelCaseVariableNamingRule\"\n override val onlyOnThFly: Boolean\n get() = true\n\n override fun getName(): String {\n return P3cBundle.getMessage(\"com.alibaba.p3c.idea.quickfix.variable.lowerCamelCase\")\n }\n\n override fun applyFix(project: Project, descriptor: ProblemDescriptor) {\n val psiIdentifier = descriptor.psiElement as? PsiIdentifier ?: return\n val identifier = psiIdentifier.text\n val resultName = toLowerCamelCase(identifier)\n AliQuickFix.doQuickFix(resultName, project, psiIdentifier)\n }\n\n private fun toLowerCamelCase(identifier: String): String {\n val list = Splitter.onPattern(\"[^a-z0-9A-Z]+\").trimResults()\n .omitEmptyStrings().split(identifier).toList()\n val result = list.mapIndexed { i, s ->\n val charArray = s.toCharArray()\n charArray[0] = if (i == 0) charArray[0].toLowerCase() else charArray[0].toUpperCase()\n String(charArray)\n }\n return result.joinToString(\"\")\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/quickfix/VmQuietReferenceQuickFix.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.quickfix\n\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.openapi.fileEditor.FileDocumentManager\nimport com.intellij.openapi.project.Project\n\n/**\n *\n *\n * @author caikang\n * @date 2017/01/26\n */\nobject VmQuietReferenceQuickFix : AliQuickFix {\n override val onlyOnThFly: Boolean\n get() = true\n\n override fun applyFix(project: Project, descriptor: ProblemDescriptor) {\n val textRange = descriptor.textRangeInElement ?: return\n val document = FileDocumentManager.getInstance().getDocument(\n descriptor.startElement.containingFile.virtualFile) ?: return\n document.insertString(textRange.startOffset + 1, \"!\")\n }\n\n override val ruleName = \"UseQuietReferenceNotationRule\"\n\n override fun getName(): String {\n return \"为变量添加!\"\n }\n\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/util/DocumentUtils.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.util\n\nimport com.intellij.openapi.editor.Document\nimport com.intellij.openapi.util.TextRange\n\n/**\n *\n *\n * @author caikang\n * @date 2017/03/16\n6\n */\nobject DocumentUtils {\n private val PMD_TAB_SIZE = 8\n fun calculateRealOffset(document: Document, line: Int, pmdColumn: Int): Int {\n val maxLine = document.lineCount\n if (maxLine < line) {\n return -1\n }\n val lineOffset = document.getLineStartOffset(line - 1)\n return lineOffset + calculateRealColumn(document, line, pmdColumn)\n }\n\n fun calculateLineStart(document: Document, line: Int): Int {\n val maxLine = document.lineCount\n if (maxLine < line) {\n return -1\n }\n return document.getLineStartOffset(line - 1)\n }\n\n fun calculateRealColumn(document: Document, line: Int, pmdColumn: Int): Int {\n var realColumn = pmdColumn - 1\n val minusSize = PMD_TAB_SIZE - 1\n val docLine = line - 1\n val lineStartOffset = document.getLineStartOffset(docLine)\n val lineEndOffset = document.getLineEndOffset(docLine)\n val text = document.getText(TextRange(lineStartOffset, lineEndOffset))\n\n text.forEachIndexed { i, c ->\n if (c == '\\t') {\n realColumn -= minusSize\n }\n if (i >= realColumn) {\n return@forEachIndexed\n }\n }\n\n return realColumn\n }\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/util/HighlightDisplayLevels.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.util\n\nimport com.intellij.codeHighlighting.HighlightDisplayLevel\n\n/**\n *\n *\n * @author caikang\n * @date 2017/02/04\n */\nobject HighlightDisplayLevels {\n val BLOCKER = HighlightDisplayLevel(HighlightSeverities.BLOCKER, HighlightDisplayLevel.ERROR.icon)\n val CRITICAL = HighlightDisplayLevel(HighlightSeverities.CRITICAL, HighlightDisplayLevel.WARNING.icon)\n val MAJOR = HighlightDisplayLevel(HighlightSeverities.MAJOR, HighlightDisplayLevel.WEAK_WARNING.icon)\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/util/HighlightInfoTypes.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.util\n\nimport com.intellij.codeInsight.daemon.impl.HighlightInfoType\nimport com.intellij.openapi.editor.colors.CodeInsightColors\n\n/**\n *\n *\n * @author caikang\n * @date 2017/02/04\n */\nobject HighlightInfoTypes {\n val BLOCKER: HighlightInfoType = HighlightInfoType.HighlightInfoTypeImpl(HighlightSeverities.BLOCKER,\n CodeInsightColors.ERRORS_ATTRIBUTES)\n val CRITICAL: HighlightInfoType = HighlightInfoType.HighlightInfoTypeImpl(HighlightSeverities.CRITICAL,\n CodeInsightColors.WARNINGS_ATTRIBUTES)\n val MAJOR: HighlightInfoType = HighlightInfoType.HighlightInfoTypeImpl(HighlightSeverities.MAJOR,\n CodeInsightColors.WEAK_WARNING_ATTRIBUTES)\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/util/HighlightSeverities.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.util\n\nimport com.intellij.lang.annotation.HighlightSeverity\n\n/**\n *\n *\n * @author caikang\n * @date 2017/02/04\n */\nobject HighlightSeverities {\n val MAJOR = HighlightSeverity(\"MAJOR\", 397)\n\n\n /**\n * The standard severity level for warning annotations.\n */\n val CRITICAL = HighlightSeverity(\"CRITICAL\", 398)\n\n /**\n * The standard severity level for error annotations.\n */\n val BLOCKER = HighlightSeverity(\"BLOCKER\", 399)\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/util/NumberConstants.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.util\n\n/**\n * @author caikang\n * @date 2016/12/28\n */\nobject NumberConstants {\n val INTEGER_SIZE_OR_LENGTH_0 = 0\n val INTEGER_SIZE_OR_LENGTH_1 = 1\n val INTEGER_SIZE_OR_LENGTH_2 = 2\n\n val INDEX_0 = 0\n val INDEX_1 = 1\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/util/ObjectConstants.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.util\n\n/**\n * @author caikang\n * @date 2016/12/28\n */\nobject ObjectConstants {\n val METHOD_NAME_EQUALS = \"equals\"\n val METHOD_NAME_HASHCODE = \"hashCode\"\n val METHOD_NAME_ADD = \"add\"\n val METHOD_NAME_PUT = \"put\"\n val CLASS_LITERAL = \"class\"\n val INTERFACE_LITERAL = \"interface\"\n val ENUM_LITERAL = \"enum\"\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/util/ProblemsUtils.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.util\n\nimport com.alibaba.p3c.pmd.lang.java.rule.comment.AvoidCommentBehindStatementRule\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.LocalQuickFix\nimport com.intellij.codeInspection.ProblemDescriptor\nimport com.intellij.codeInspection.ProblemHighlightType\nimport com.intellij.openapi.fileEditor.FileDocumentManager\nimport com.intellij.openapi.util.TextRange\nimport com.intellij.psi.PsiClass\nimport com.intellij.psi.PsiElement\nimport com.intellij.psi.PsiField\nimport com.intellij.psi.PsiFile\nimport com.intellij.psi.PsiIdentifier\nimport com.intellij.psi.PsiJavaToken\nimport com.intellij.psi.PsiKeyword\nimport com.intellij.psi.PsiWhiteSpace\nimport com.intellij.psi.impl.source.tree.ElementType\n\n/**\n *\n *\n * @author caikang\n * @date 2017/03/16\n6\n */\nobject ProblemsUtils {\n private val highlightLineRules = setOf(AvoidCommentBehindStatementRule::class.java.simpleName)\n\n fun createProblemDescriptorForPmdRule(psiFile: PsiFile, manager: InspectionManager, isOnTheFly: Boolean,\n ruleName: String, desc: String, start: Int, end: Int,\n checkLine: Int = 0,\n quickFix: (PsiElement) -> LocalQuickFix? = {\n QuickFixes.getQuickFix(ruleName, isOnTheFly)\n }): ProblemDescriptor? {\n val document = FileDocumentManager.getInstance().getDocument(psiFile.virtualFile) ?: return null\n if (highlightLineRules.contains(ruleName) && checkLine <= document.lineCount) {\n val lineNumber = if (start >= document.textLength) {\n document.lineCount - 1\n } else {\n document.getLineNumber(start)\n }\n val textRange = TextRange(document.getLineStartOffset(lineNumber), document.getLineEndOffset(lineNumber))\n return createTextRangeProblem(manager, textRange, isOnTheFly, psiFile, ruleName, desc)\n }\n if (psiFile.virtualFile.canonicalPath!!.endsWith(\".vm\")) {\n return createTextRangeProblem(manager, TextRange(start, end), isOnTheFly, psiFile, ruleName, desc)\n }\n var psiElement = psiFile.findElementAt(start) ?: return null\n\n psiElement = transform(psiElement) ?: return null\n var endElement = if (start == end) psiElement else getEndElement(psiFile, psiElement, end)\n if (psiElement != endElement && endElement.parent is PsiField) {\n psiElement = endElement\n }\n if (endElement is PsiWhiteSpace) {\n endElement = psiElement\n }\n if (psiElement is PsiWhiteSpace) {\n val textRange = TextRange(start, end)\n return createTextRangeProblem(manager, textRange, isOnTheFly, psiFile, ruleName, desc)\n }\n\n if (psiElement.textRange.startOffset >= endElement.textRange.endOffset) {\n if (!(psiElement is PsiFile && endElement is PsiFile)) {\n return null\n }\n endElement = psiElement\n }\n return manager.createProblemDescriptor(psiElement, endElement,\n desc, ProblemHighlightType.GENERIC_ERROR_OR_WARNING, isOnTheFly,\n quickFix(psiElement))\n }\n\n private fun getEndElement(psiFile: PsiFile, psiElement: PsiElement, endOffset: Int): PsiElement {\n var endElement = psiFile.findElementAt(endOffset)\n if (endElement is PsiJavaToken && endElement.tokenType === ElementType.SEMICOLON) {\n endElement = psiFile.findElementAt(endOffset - 1)\n }\n if (endElement is PsiIdentifier) {\n return endElement\n }\n if (psiElement is PsiIdentifier) {\n return psiElement\n }\n if (endElement == null || endElement is PsiWhiteSpace\n || psiElement.textRange.startOffset >= endElement.textRange.endOffset) {\n endElement = psiElement\n }\n return endElement\n }\n\n private fun transform(element: PsiElement): PsiElement? {\n var psiElement: PsiElement? = element\n while (psiElement is PsiWhiteSpace) {\n psiElement = psiElement.getNextSibling()\n }\n if (psiElement == null) {\n return null\n }\n if (psiElement is PsiKeyword && psiElement.text != null && (ObjectConstants.CLASS_LITERAL == psiElement.text\n || ObjectConstants.INTERFACE_LITERAL == psiElement.text\n || ObjectConstants.ENUM_LITERAL == psiElement.text) && psiElement.parent is PsiClass) {\n val parent = psiElement.parent as PsiClass\n val identifier = parent.nameIdentifier\n return identifier ?: psiElement\n }\n return psiElement\n }\n\n private fun createTextRangeProblem(manager: InspectionManager, textRange: TextRange, isOnTheFly: Boolean,\n psiFile: PsiFile, ruleName: String, desc: String,\n quickFix: () -> LocalQuickFix? = {\n QuickFixes.getQuickFix(ruleName, isOnTheFly)\n }): ProblemDescriptor {\n\n return manager.createProblemDescriptor(psiFile, textRange,\n desc, ProblemHighlightType.GENERIC_ERROR_OR_WARNING,\n isOnTheFly, quickFix())\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/util/QuickFixes.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.util\n\nimport com.alibaba.p3c.idea.quickfix.AvoidStartWithDollarAndUnderLineNamingQuickFix\nimport com.alibaba.p3c.idea.quickfix.ClassMustHaveAuthorQuickFix\nimport com.alibaba.p3c.idea.quickfix.ConstantFieldShouldBeUpperCaseQuickFix\nimport com.alibaba.p3c.idea.quickfix.LowerCamelCaseVariableNamingQuickFix\nimport com.alibaba.p3c.idea.quickfix.VmQuietReferenceQuickFix\nimport com.intellij.codeInspection.LocalQuickFix\n\n/**\n *\n *\n * @author caikang\n * @date 2017/02/06\n */\nobject QuickFixes {\n val quickFixes = mutableMapOf(VmQuietReferenceQuickFix.ruleName to VmQuietReferenceQuickFix,\n ClassMustHaveAuthorQuickFix.ruleName to ClassMustHaveAuthorQuickFix,\n ConstantFieldShouldBeUpperCaseQuickFix.ruleName to ConstantFieldShouldBeUpperCaseQuickFix,\n AvoidStartWithDollarAndUnderLineNamingQuickFix.ruleName to AvoidStartWithDollarAndUnderLineNamingQuickFix,\n LowerCamelCaseVariableNamingQuickFix.ruleName to LowerCamelCaseVariableNamingQuickFix)\n\n fun getQuickFix(rule: String, isOnTheFly: Boolean): LocalQuickFix? {\n val quickFix = quickFixes[rule] ?: return null\n if (!quickFix.onlyOnThFly) {\n return quickFix\n }\n if (!isOnTheFly && quickFix.onlyOnThFly) {\n return null\n }\n return quickFix\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/util/withLockNotInline.kt",
"content": "package com.alibaba.p3c.idea.util\n\nimport com.intellij.openapi.progress.ProcessCanceledException\nimport java.util.concurrent.Semaphore\nimport java.util.concurrent.TimeUnit\nimport java.util.concurrent.locks.Lock\n\n/**\n * @date 2020/06/14\n * @author caikang\n */\n\nfun Lock.withLockNotInline(action: () -> T?): T? {\n lock()\n try {\n return action()\n } finally {\n unlock()\n }\n}\n\nfun Semaphore.withAcquire(action: () -> T?): T? {\n acquire()\n try {\n return action()\n } finally {\n release()\n }\n}\n\nfun Lock.withTryLock(time: Long, timeUnit: TimeUnit, action: () -> T?): T? {\n if (!tryLock(time, timeUnit)) {\n throw ProcessCanceledException()\n }\n try {\n return action()\n } finally {\n unlock()\n }\n}\n\nfun Semaphore.withTryAcquire(time: Long, timeUnit: TimeUnit, action: () -> T?): T? {\n if (!tryAcquire(time, timeUnit)) {\n throw ProcessCanceledException()\n }\n try {\n return action()\n } finally {\n release()\n }\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/vcs/AliCodeAnalysisCheckinHandler.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.vcs\n\nimport com.alibaba.p3c.idea.action.AliInspectionAction\nimport com.alibaba.p3c.idea.compatible.inspection.Inspections\nimport com.alibaba.p3c.idea.config.P3cConfig\nimport com.alibaba.p3c.idea.inspection.AliBaseInspection\nimport com.alibaba.smartfox.idea.common.util.BalloonNotifications\nimport com.intellij.analysis.AnalysisScope\nimport com.intellij.codeInspection.InspectionManager\nimport com.intellij.codeInspection.LocalInspectionTool\nimport com.intellij.codeInspection.ex.InspectionManagerEx\nimport com.intellij.openapi.application.ApplicationManager\nimport com.intellij.openapi.components.ServiceManager\nimport com.intellij.openapi.diagnostic.Logger\nimport com.intellij.openapi.progress.ProcessCanceledException\nimport com.intellij.openapi.progress.ProgressIndicator\nimport com.intellij.openapi.progress.ProgressManager\nimport com.intellij.openapi.progress.Task\nimport com.intellij.openapi.project.DumbService\nimport com.intellij.openapi.project.Project\nimport com.intellij.openapi.ui.Messages\nimport com.intellij.openapi.util.Computable\nimport com.intellij.openapi.util.Ref\nimport com.intellij.openapi.vcs.CheckinProjectPanel\nimport com.intellij.openapi.vcs.VcsBundle\nimport com.intellij.openapi.vcs.changes.CommitExecutor\nimport com.intellij.openapi.vcs.checkin.CheckinHandler\nimport com.intellij.openapi.vcs.checkin.CheckinHandlerUtil\nimport com.intellij.openapi.vcs.ui.RefreshableOnComponent\nimport com.intellij.openapi.vfs.VirtualFile\nimport com.intellij.psi.PsiDocumentManager\nimport com.intellij.psi.PsiManager\nimport com.intellij.ui.NonFocusableCheckBox\nimport com.intellij.util.ExceptionUtil\nimport com.intellij.util.PairConsumer\nimport java.awt.BorderLayout\nimport java.util.ArrayList\nimport java.util.Arrays\nimport java.util.concurrent.atomic.AtomicBoolean\nimport java.util.concurrent.atomic.AtomicInteger\nimport javax.swing.JComponent\nimport javax.swing.JPanel\n\n/**\n *\n * @author yaohui.wyh\n * @date 2017/03/21\n * @author caikang\n * @date 2017/05/04\n */\nclass AliCodeAnalysisCheckinHandler(\n private val myProject: Project,\n private val myCheckinPanel: CheckinProjectPanel\n) : CheckinHandler() {\n private val dialogTitle = \"Alibaba Code Analyze\"\n private val cancelText = \"&Cancel\"\n private val commitText = \"&Commit Anyway\"\n private val waitingText = \"Wait\"\n\n val log = Logger.getInstance(javaClass)\n\n override fun getBeforeCheckinConfigurationPanel(): RefreshableOnComponent? {\n val checkBox = NonFocusableCheckBox(\"Alibaba Code Guidelines\")\n return object : RefreshableOnComponent {\n override fun getComponent(): JComponent {\n val panel = JPanel(BorderLayout())\n panel.add(checkBox)\n val dumb = DumbService.isDumb(myProject)\n checkBox.isEnabled = !dumb\n checkBox.toolTipText = if (dumb) {\n \"Code analysis is impossible until indices are up-to-date\"\n } else {\n \"\"\n }\n return panel\n }\n\n override fun refresh() {}\n\n override fun saveState() {\n getSettings().analysisBeforeCheckin = checkBox.isSelected\n }\n\n override fun restoreState() {\n checkBox.isSelected = getSettings().analysisBeforeCheckin\n }\n }\n }\n\n private fun getSettings(): P3cConfig {\n return ServiceManager.getService(P3cConfig::class.java)\n }\n\n override fun beforeCheckin(\n executor: CommitExecutor?,\n additionalDataConsumer: PairConsumer\n ): CheckinHandler.ReturnResult {\n if (!getSettings().analysisBeforeCheckin) {\n return CheckinHandler.ReturnResult.COMMIT\n }\n if (DumbService.getInstance(myProject).isDumb) {\n if (Messages.showOkCancelDialog(\n myProject,\n \"Code analysis is impossible until indices are up-to-date\", dialogTitle,\n waitingText, commitText, null\n ) == Messages.OK\n ) {\n return CheckinHandler.ReturnResult.CANCEL\n }\n return CheckinHandler.ReturnResult.COMMIT\n }\n\n val virtualFiles = CheckinHandlerUtil.filterOutGeneratedAndExcludedFiles(myCheckinPanel.virtualFiles, myProject)\n val hasViolation = hasViolation(virtualFiles, myProject)\n if (!hasViolation) {\n BalloonNotifications.showSuccessNotification(\n \"No suspicious code found！\",\n myProject, \"Analyze Finished\"\n )\n return CheckinHandler.ReturnResult.COMMIT\n }\n if (Messages.showOkCancelDialog(\n myProject, \"Found suspicious code,continue commit？\",\n dialogTitle, commitText, cancelText, null\n ) == Messages.OK\n ) {\n return CheckinHandler.ReturnResult.COMMIT\n } else {\n doAnalysis(myProject, virtualFiles.toTypedArray())\n return CheckinHandler.ReturnResult.CLOSE_WINDOW\n }\n }\n\n fun doAnalysis(project: Project, virtualFiles: Array) {\n val managerEx = InspectionManager.getInstance(project) as InspectionManagerEx\n val analysisScope = AnalysisScope(\n project,\n ArrayList(Arrays.asList(*virtualFiles))\n )\n val tools = Inspections.aliInspections(project) { it.tool is AliBaseInspection }\n AliInspectionAction.createContext(tools, managerEx, null, false, analysisScope)\n .doInspections(analysisScope)\n }\n\n private fun hasViolation(virtualFiles: List, project: Project): Boolean {\n ApplicationManager.getApplication().assertIsDispatchThread()\n PsiDocumentManager.getInstance(myProject).commitAllDocuments()\n if (ApplicationManager.getApplication().isWriteAccessAllowed) throw RuntimeException(\n \"Must not run under write action\"\n )\n val result = AtomicBoolean(false)\n val exception = Ref.create()\n ProgressManager.getInstance().run(\n object : Task.Modal(myProject, VcsBundle.message(\"checking.code.smells.progress.title\"), true) {\n override fun run(progress: ProgressIndicator) {\n try {\n val tools = Inspections.aliInspections(project) { it.tool is AliBaseInspection }\n val inspectionManager = InspectionManager.getInstance(project)\n val psiManager = PsiManager.getInstance(project)\n val count = AtomicInteger(0)\n val hasViolation = virtualFiles.asSequence().any { file ->\n ApplicationManager.getApplication().runReadAction(Computable {\n val psiFile = psiManager.findFile(file) ?: return@Computable false\n val curCount = count.incrementAndGet()\n progress.text = file.canonicalPath\n progress.fraction = curCount.toDouble() / virtualFiles.size.toDouble()\n return@Computable tools.any {\n progress.checkCanceled()\n val tool = it.tool as LocalInspectionTool\n val aliTool = tool as AliBaseInspection\n progress.text2 = aliTool.ruleName()\n val problems = tool.processFile(psiFile, inspectionManager)\n problems.size > 0\n }\n })\n\n }\n result.set(hasViolation)\n } catch (e: ProcessCanceledException) {\n result.set(false)\n } catch (e: Exception) {\n log.error(e)\n exception.set(e)\n }\n }\n })\n if (!exception.isNull) {\n val t = exception.get()\n ExceptionUtil.rethrowAllAsUnchecked(t)\n }\n\n return result.get()\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/p3c/idea/vcs/AliCodeAnalysisCheckinHandlerFactory.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.p3c.idea.vcs\n\nimport com.intellij.openapi.vcs.CheckinProjectPanel\nimport com.intellij.openapi.vcs.changes.CommitContext\nimport com.intellij.openapi.vcs.checkin.CheckinHandler\nimport com.intellij.openapi.vcs.checkin.CheckinHandlerFactory\n\n/**\n *\n *\n * @author caikang\n * @date 2017/05/04\n */\nclass AliCodeAnalysisCheckinHandlerFactory : CheckinHandlerFactory() {\n override fun createHandler(panel: CheckinProjectPanel, commitContext: CommitContext): CheckinHandler {\n return AliCodeAnalysisCheckinHandler(panel.project, panel)\n }\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/smartfox/idea/common/component/AliBaseApplicationComponent.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.idea.common.component\n\nimport com.alibaba.smartfox.idea.common.util.PluginVersions\nimport com.intellij.openapi.components.ApplicationComponent\n\n/**\n *\n *\n * @author caikang\n * @date 2017/05/11\n */\ninterface AliBaseApplicationComponent : ApplicationComponent {\n override fun getComponentName(): String {\n return \"${PluginVersions.pluginId.idString}-${javaClass.name}\"\n }\n\n override fun disposeComponent() {\n }\n\n override fun initComponent() {\n }\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/smartfox/idea/common/component/AliBaseProjectComponent.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.idea.common.component\n\nimport com.alibaba.smartfox.idea.common.util.PluginVersions\nimport com.intellij.openapi.components.ProjectComponent\n\n/**\n *\n *\n * @author caikang\n * @date 2017/04/28\n */\ninterface AliBaseProjectComponent : ProjectComponent {\n override fun getComponentName(): String {\n return \"${PluginVersions.pluginId.idString}-${javaClass.name}\"\n }\n\n override fun disposeComponent() {\n }\n\n override fun projectClosed() {\n }\n\n override fun initComponent() {\n }\n\n override fun projectOpened() {\n }\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/smartfox/idea/common/util/BalloonNotifications.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.idea.common.util\n\nimport com.intellij.notification.NotificationDisplayType\nimport com.intellij.notification.NotificationGroup\nimport com.intellij.notification.NotificationListener\nimport com.intellij.notification.NotificationType\nimport com.intellij.openapi.progress.ProcessCanceledException\nimport com.intellij.openapi.project.Project\nimport com.intellij.openapi.project.ProjectManager\nimport com.intellij.openapi.ui.Messages\nimport java.awt.Component\nimport java.net.UnknownHostException\n\n/**\n *\n *\n * @author caikang\n * @date 2017/05/08\n */\nobject BalloonNotifications {\n val displayId = \"SmartFox Intellij IDEA Balloon Notification\"\n val balloonGroup = NotificationGroup(displayId, NotificationDisplayType.BALLOON, true)\n\n val stickyBalloonDisplayId = \"SmartFox Intellij IDEA Notification\"\n val stickyBalloonGroup = NotificationGroup(stickyBalloonDisplayId, NotificationDisplayType.STICKY_BALLOON, true)\n val TITLE = \"SmartFox Intellij IDEA Plugin\"\n\n fun showInfoDialog(component: Component, title: String, message: String) {\n Messages.showInfoMessage(component, message, title)\n }\n\n fun showErrorDialog(component: Component, title: String, errorMessage: String) {\n Messages.showErrorDialog(component, errorMessage, title)\n }\n\n fun showErrorDialog(component: Component, title: String, e: Exception) {\n if (isOperationCanceled(e)) {\n return\n }\n Messages.showErrorDialog(component, getErrorTextFromException(e), title)\n }\n\n fun showSuccessNotification(message: String, project: Project? = ProjectManager.getInstance().defaultProject,\n title: String = TITLE, sticky: Boolean = false) {\n showNotification(message, project, title, NotificationType.INFORMATION, null, sticky)\n }\n\n fun showWarnNotification(message: String, project: Project? = ProjectManager.getInstance().defaultProject,\n title: String = TITLE, sticky: Boolean = false) {\n showNotification(message, project, title, NotificationType.WARNING, null, sticky)\n }\n\n fun showErrorNotification(message: String, project: Project? = ProjectManager.getInstance().defaultProject,\n title: String = TITLE, sticky: Boolean = false) {\n showNotification(message, project, title, NotificationType.ERROR, null, sticky)\n }\n\n fun showSuccessNotification(message: String, project: Project?,\n notificationListener: NotificationListener, title: String = TITLE, sticky: Boolean = false) {\n showNotification(message, project, title, NotificationType.INFORMATION, notificationListener, sticky)\n }\n\n fun showNotification(message: String, project: Project? = ProjectManager.getInstance().defaultProject,\n title: String = TITLE,\n notificationType: NotificationType = NotificationType.INFORMATION,\n notificationListener: NotificationListener? = null, sticky: Boolean = false) {\n val group = if (sticky) {\n stickyBalloonGroup\n } else {\n balloonGroup\n }\n group.createNotification(title, message, notificationType, notificationListener).notify(project)\n }\n\n private fun isOperationCanceled(e: Exception): Boolean {\n return e is ProcessCanceledException\n }\n\n fun getErrorTextFromException(e: Exception): String {\n if (e is UnknownHostException) {\n return \"Unknown host: \" + e.message\n }\n return e.message ?: \"\"\n }\n}\n\nobject LogNotifications {\n val group = NotificationGroup(BalloonNotifications.displayId, NotificationDisplayType.NONE, true)\n\n fun log(message: String, project: Project? = ProjectManager.getInstance().defaultProject,\n title: String = BalloonNotifications.TITLE,\n notificationType: NotificationType = NotificationType.INFORMATION,\n notificationListener: NotificationListener? = null) {\n group.createNotification(title, message, notificationType, notificationListener).notify(project)\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/smartfox/idea/common/util/CommonExtensions.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.idea.common.util\n\nimport com.intellij.openapi.components.ServiceManager\nimport com.intellij.openapi.project.Project\n\n/**\n *\n *\n * @author caikang\n * @date 2017/06/19\n */\nfun Class.getService(): T {\n return ServiceManager.getService(this)\n}\n\nfun Class.getService(project: Project): T {\n return ServiceManager.getService(project, this)\n}"
},
{
"path": "idea-plugin/p3c-common/src/main/kotlin/com/alibaba/smartfox/idea/common/util/PluginVersions.kt",
"content": "/*\n * Copyright 1999-2017 Alibaba Group.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\npackage com.alibaba.smartfox.idea.common.util\n\nimport com.intellij.ide.plugins.IdeaPluginDescriptor\nimport com.intellij.ide.plugins.PluginManager\nimport com.intellij.ide.plugins.cl.PluginClassLoader\nimport com.intellij.openapi.application.ApplicationInfo\nimport com.intellij.openapi.extensions.PluginId\n\n/**\n * @author caikang\n */\nobject PluginVersions {\n val baseVersion141 = 141\n val baseVersion143 = 143\n val baseVersion145 = 145\n val baseVersion162 = 162\n val baseVersion163 = 163\n val baseVersion171 = 171\n\n val pluginId: PluginId = (javaClass.classLoader as PluginClassLoader).pluginId\n val pluginDescriptor: IdeaPluginDescriptor = PluginManager.getPlugin(pluginId)!!\n\n /**\n * 获取当前安装的 plugin版本\n */\n val pluginVersion: String\n get() = pluginDescriptor.version\n\n /**\n * 获取当前使用的IDE版本\n */\n val ideVersion: String\n get() {\n val applicationInfo = ApplicationInfo.getInstance()\n return applicationInfo.fullVersion + \"_\" + applicationInfo.build\n }\n\n\n val baseVersion: Int\n get() {\n val applicationInfo = ApplicationInfo.getInstance()\n return applicationInfo.build.baselineVersion\n }\n}\n"
},
{
"path": "idea-plugin/p3c-common/src/main/resources/messages/P3cBundle.xml",
"content": "\n\n\n 阿里编码规约\n 切换语言至英文(English)\n 切换语言至中文\n \n 重启后生效]]>\n 编码规约扫描\n 关闭实时检测功能\n 打开实时检测功能\n 删除开头的 $ 或者 _\n 添加/提取 @author\n 修正为以下划线分隔大写模式\n 修改为小写驼峰命名（lowerCamelCase）\n 为变量添加!\n 替换为\n 通过类 '%s' 直接访问静态成员\n '%s.%s'\n \n 添加 @Override 注解\n 为语句加上大括号\n 翻转 equals 调用\n 修改为 String[] str 模式\n 'l' 替换为 'L'\n\n \n #ref #loc]]>\n \n 避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。\n \n 不应该通过类实例访问静态成员\n %s #loc\n \n\n 不能使用过时的类或方法。\n \n 所有的覆写方法，必须加@Override注解。\n \n \n #ref()缺少 '@Override' 注解 #loc]]>\n \n Map/Set的key为自定义对象时，必须重写hashCode和equals。\n \n \n 参数类型 %s 没有重写hashCode和equals #loc\n \n \n #ref 是非线程安全的，请加锁或者使用局部变量 #loc]]>\n \n #ref 没有加大括号 #loc]]>\n \n #ref 应该作为方法 \"%s()\"的调用方，而不是参数 #loc]]>\n \n #ref 数组定义格式错误 #loc]]>\n \n #ref 应该以大写L结尾 #loc]]>\n \n #ref #loc]]>\n\n \n\n避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。\n\n