/*
* Copyright 2000-2017 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.structuralsearch;
import com.intellij.structuralsearch.plugin.ui.Configuration;
import static com.intellij.structuralsearch.PredefinedConfigurationUtil.createSearchTemplateInfo;
import static com.intellij.structuralsearch.PredefinedConfigurationUtil.createSearchTemplateInfoSimple;
/**
* @author Bas Leijdekkers
*/
class JavaPredefinedConfigurations {
private static final String EXPRESSION_TYPE = SSRBundle.message("expressions.category");
private static final String INTERESTING_TYPE = SSRBundle.message("interesting.category");
private static final String J2EE_TYPE = SSRBundle.message("j2ee.category");
private static final String OPERATOR_TYPE = SSRBundle.message("operators.category");
private static final String CLASS_TYPE = SSRBundle.message("class.category");
private static final String METADATA_TYPE = SSRBundle.message("metadata.category");
private static final String MISC_TYPE = SSRBundle.message("misc.category");
private static final String GENERICS_TYPE = SSRBundle.message("generics.category");
public static Configuration[] createPredefinedTemplates() {
return new Configuration[] {
// Expression patterns
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.method.calls"), "'_Instance?.'MethodCall('_Parameter*)", EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.new.expressions"), "new 'Constructor('_Argument*)", EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.lambdas"), "('_Parameter*) -> {}", EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.field.selections"),"'_Instance?.'Field",EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.array.access"),"'_Field['_Index]",EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.assignments"),"'_Inst = '_Expr",EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.casts"),"('_Type)'_Expr",EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.instanceof"),"'_Expr instanceof '_Type",EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.string.literals"),"\"'_String\"",EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.all.expressions.of.some.type"),"'_Expression:[exprtype( SomeType )]",EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.sample.method.invokation.with.constant.argument"),"Integer.parseInt('_a:[script( \"com.intellij.psi.util.PsiUtil.isConstantExpression(__context__)\" )])",EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.method.references"), "'_Qualifier::'Method", EXPRESSION_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.string.concatenations"), "[exprtype( java\\.lang\\.String )]'_a + '_b+", EXPRESSION_TYPE),
// Operators
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.block.dcls"),"{\n '_Type 'Var+ = '_Init?;\n '_BlockStatements*;\n}",OPERATOR_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.trys"),"try {\n '_TryStatement+;\n} catch('_ExceptionType '_Exception) {\n '_CatchStatement*;\n}",OPERATOR_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.ifs"),"if ('_Condition) {\n '_ThenStatement*;\n} else {\n '_ElseStatement*;\n}",OPERATOR_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.switches"),"switch('_Condition) {\n '_Statement*;\n}",OPERATOR_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.foreaches"), "for ('_Type '_Variable : '_Expression) {\n '_Statement*;\n}", OPERATOR_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.logging.without.if"),"[!within( \"if('_a) { 'st*; }\" )]LOG.debug('_Argument*);",OPERATOR_TYPE),
// Class based
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.methods.of.the.class"),
"'_ReturnType '_Method('_ParameterType '_Parameter*);",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.fields.of.the.class"),
"class '_Class { \n '_FieldType 'Field+ = '_Init?;\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.all.methods.of.the.class.within.hierarchy"),
"class '_ { \n '_ReturnType 'Method+:* ('_ParameterType '_Parameter*);\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.all.fields.of.the.class"),
"class '_Class { \n '_FieldType 'Field+:* = '_Init?;\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.instance.fields.of.the.class"),
"class '_Class { \n @Modifier(\"Instance\") '_FieldType 'Field+ = '_Init?;\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.packagelocal.fields.of.the.class"),
"@Modifier(\"packageLocal\") '_FieldType 'Field = '_Init?;",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.constructors.of.the.class"),
"class 'Class {\n 'Class('_ParameterType '_Parameter*) {\n '_Statement*;\n }\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.classes"),
"class 'Class {}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.direct.subclasses"),
"class 'Class extends '_Parent {}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.implementors.of.interface.within.hierarchy"),
"class 'Class implements '_Interface:* {}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.interfaces"),
"interface 'Interface {}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.inner.classes"),
"class '_ {\n class 'InnerClass+ {}\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.all.inner.classes.within.hierarchy"),
"class '_Class {\n class 'InnerClass+:* {}\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.anonymous.classes"),
"new 'AnonymousClass() {}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.class.implements.two.interfaces"),
"class 'A implements '_Interface1:[regex( *java\\.lang\\.Cloneable )], '_Interface2:*java\\.io\\.Serializable {\n" +"}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.class.static.blocks"),
"class '_A {\n static {\n 'Statement*;\n }\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.class.instance.initialization.blocks"),
"@Modifier(\"Instance\") {\n '_Statement*;\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.class.any.initialization.blocks"),
"class '_A {\n {\n 'Statement*;\n }\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.enums"),
"enum 'Enum {}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.class.with.parameterless.constructors"),
"class 'Class {\n '_Method{0,0}:[ script( \"__context__.constructor\" ) ]('_ParameterType '_Parameter+);\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.static.fields.without.final"),
"class '_Class {\n static '_Type 'Variable+:[ script( \"!__context__.hasModifierProperty(\"final\")\" ) ] = '_Init?;\n}",
CLASS_TYPE
),
createSearchTemplateInfo(
SSRBundle.message("predefined.configuration.interfaces.having.no.descendants"),
"interface 'A:[script( \"com.intellij.psi.search.searches.ClassInheritorsSearch.search(__context__).findFirst() == null\" )] {}",
CLASS_TYPE
),
// Generics
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.generic.classes"),"class 'GenericClass<'_TypeParameter+> {} ", GENERICS_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.generic.methods"),"<'_TypeParameter+> '_Type '_Method('_ParameterType '_Parameter*);", GENERICS_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.typed.symbol"),"'Symbol <'_GenericArgument+>", GENERICS_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.generic.casts"),"( '_Type <'_GenericArgument+> ) '_Expr", GENERICS_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.type.var.substitutions.in.intanceof.with.generic.types"),"'_Expr instanceof '_Type <'Substitutions+> ", GENERICS_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.variables.of.generic.types"),"'_Type <'_GenericArgument+> 'Var = '_Init?;", GENERICS_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.diamond.operators"), "new 'Class<>('_Argument*)", GENERICS_TYPE),
// Add comments and metadata
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.comments"),"/* 'CommentContent */", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.javadoc.annotated.class"),"/** @'_Tag+ '_TagValue* */\nclass '_Class {\n}", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.javadoc.annotated.methods"),"/** @'_Tag+ '_TagValue* */\n'_Type '_Method('_ParameterType '_Parameter*);", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.javadoc.annotated.fields"),"class '_Class {\n /** @'_Tag+ '_TagValue* */\n '_Type+ 'Field+ = '_Init*;\n}", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.javadoc.tags"),"/** @'Tag+ '_TagValue* */", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.xdoclet.metadata"),"/** @'Tag \n '_Property+\n*/", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.annotations"), "@'_Annotation", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.annotated.class"),
"@'_Annotation( )\n" +
"class 'Class {}", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.annotated.fields"),
"class '_Class {\n" +
" @'_Annotation+( )\n" +
" '_FieldType 'Field+ = '_Init?;\n" +
"}", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.annotated.methods"),
"@'_Annotation+( )\n'_MethodType '_Method('_ParameterType '_Parameter*);", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.not.annotated.methods"),
"@'_Annotation{0,0}\n'_MethodType '_Method('_ParameterType '_Parameter*);", METADATA_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.annotation.declarations"),
"@interface 'Interface {}", METADATA_TYPE),
// J2EE templates
createSearchTemplateInfoSimple(SSRBundle.message("predefined.configuration.struts.1.1.actions"),"public class 'StrutsActionClass extends '_ParentClass*:Action {\n" +
" public ActionForward 'AnActionMethod:*execute (ActionMapping '_action,\n" +
" ActionForm '_form,\n" +
" HttpServletRequest '_request,\n" +
" HttpServletResponse '_response);\n" +
"}",J2EE_TYPE),
createSearchTemplateInfoSimple(SSRBundle.message("predefined.configuration.entity.ejb"),"class 'EntityBean implements EntityBean {\n" +
" EntityContext '_Context?;\n\n" +
" public void setEntityContext(EntityContext '_Context2);\n\n" +
" public '_RetType ejbCreate('_CreateType '_CreateDcl*);\n" +
" public void ejbActivate();\n\n" +
" public void ejbLoad();\n\n" +
" public void ejbPassivate();\n\n" +
" public void ejbRemove();\n\n" +
" public void ejbStore();\n" +
"}", J2EE_TYPE),
createSearchTemplateInfoSimple(SSRBundle.message("predefined.configuration.session.ejb"),"class 'SessionBean implements SessionBean {\n" +
" SessionContext '_Context?;\n\n" +
" public void '_setSessionContext(SessionContext '_Context2);\n\n" +
" public '_RetType ejbCreate('_CreateParameterType '_CreateParameterDcl*);\n" +
" public void ejbActivate();\n\n" +
" public void ejbPassivate();\n\n" +
" public void ejbRemove();\n" +
"}", J2EE_TYPE),
createSearchTemplateInfoSimple(SSRBundle.message("predefined.configuration.ejb.interface"),"interface 'EjbInterface extends EJBObject {\n" +
" '_Type '_Method+('_ParameterType '_Param*);\n" +
"}", J2EE_TYPE),
createSearchTemplateInfoSimple(SSRBundle.message("predefined.configuration.servlets"),"public class 'Servlet extends '_ParentClass:*HttpServlet {\n" +
" public void '_InitServletMethod?:init ();\n" +
" public void '_DestroyServletMethod?:destroy ();\n" +
" void '_ServiceMethod?:*service (HttpServletRequest '_request, HttpServletResponse '_response);\n" +
" void '_SpecificServiceMethod*:do.* (HttpServletRequest '_request2, HttpServletResponse '_response2); \n" +
"}", J2EE_TYPE),
createSearchTemplateInfoSimple(SSRBundle.message("predefined.configuration.filters"),"public class 'Filter implements Filter {\n" +
" public void '_DestroyFilterMethod?:*destroy ();\n" +
" public void '_InitFilterMethod?:*init ();\n" +
" public void '_FilteringMethod:*doFilter (ServletRequest '_request,\n" +
" ServletResponse '_response,FilterChain '_chain);\n" +
"}", J2EE_TYPE),
// Misc types
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.serializable.classes.and.their.serialization.implementation"),
"class 'Class implements '_Serializable:*Serializable {\n" +
" static final long '_VersionField?:serialVersionUID = '_VersionFieldInit?;\n" +
" private static final ObjectStreamField[] '_persistentFields?:serialPersistentFields = '_persistentFieldInitial?; \n" +
" private void '_SerializationWriteHandler?:writeObject (ObjectOutputStream '_stream) throws IOException;\n" +
" private void '_SerializationReadHandler?:readObject (ObjectInputStream '_stream2) throws IOException, ClassNotFoundException;\n" +
" Object '_SpecialSerializationReadHandler?:readResolve () throws ObjectStreamException;\n" +
" Object '_SpecialSerializationWriteHandler?:writeReplace () throws ObjectStreamException;\n" +
"}", MISC_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.cloneable.implementations"),
"class '_Class implements '_Interface:*Cloneable {\n" +
" Object 'CloningMethod:*clone ();\n" +
"}", MISC_TYPE),
createSearchTemplateInfoSimple(SSRBundle.message("predefined.configuration.]junit.test.cases"),
"public class 'TestCase extends '_TestCaseClazz:*TestCase {\n" +
" public void '_testMethod+:test.* ();\n" +
"}", MISC_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.singletons"),
"class 'Class {\n" +
" private 'Class('_ParameterType '_Parameter*) {\n" +
" '_ConstructorStatement*;\n" +
" }\n"+
" private static '_Class '_Instance;\n" +
" static '_Class '_GetInstance() {\n" +
" '_SomeStatement*;\n" +
" return '_Instance;\n" +
" }\n"+
"}", MISC_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.similar.methods.structure"),
"'_RetType '_Method('_ParameterType '_Parameter*) throws 'ExceptionType {\n" +
" try {\n" +
" '_OtherStatements+;\n" +
" } catch('_SomeException '_Exception) {\n" +
" '_CatchStatement*;\n" +
" throw new 'ExceptionType('_ExceptionConstructorArgs*);\n" +
" }\n" +
"}", MISC_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.bean.info.classes"),
"class 'A implements '_:*java\\.beans\\.BeanInfo {\n" +
"}", MISC_TYPE),
// interesting types
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.symbol"),"'Symbol",INTERESTING_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.fields.variables.read"),
"'Symbol:[ script( \"import com.intellij.psi.*\n" +
"import static com.intellij.psi.util.PsiUtil.*\n" +
"Symbol instanceof PsiReferenceExpression && isAccessedForReading(Symbol)\" ) ]", INTERESTING_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.fields_variables.with.given.name.pattern.updated"),
"'Symbol:[regex( name ) && script( \"import com.intellij.psi.*\n" +
"import static com.intellij.psi.util.PsiUtil.*\n" +
"Symbol instanceof PsiExpression && isAccessedForWriting(Symbol) ||\n" +
" Symbol instanceof PsiVariable && Symbol.getInitializer() != null\" )]", INTERESTING_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.usage.of.derived.type.in.cast"),"('CastType:*[regex( Base )]) '_Expr", INTERESTING_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.boxing.in.declarations"),"'_Type:Object|Integer|Boolean|Long|Character|Short|Byte 'Var = '_Value:[exprtype( int|boolean|long|char|short|byte )];", INTERESTING_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.unboxing.in.declarations"),"'_Type:int|boolean|long|char|short|byte 'Var = '_Value:[exprtype( Integer|Boolean|Long|Character|Short|Byte )];", INTERESTING_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.boxing.in.method.calls"),"'_Instance?.'Call('_BeforeParam*,'_Param:[ exprtype( int|boolean|long|char|short|byte ) && formal( Object|Integer|Boolean|Long|Character|Short|Byte )],'_AfterParam*)", INTERESTING_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.unboxing.in.method.calls"), "'_Instance?.'Call('_BeforeParam*,'_Param:[ formal( int|boolean|long|char|short|byte ) && exprtype( Integer|Boolean|Long|Character|Short|Byte )],'_AfterParam*)", INTERESTING_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.any.boxing"), "'_expression:[ exprtype( int|boolean|long|char|short|byte ) && formal( Object|Integer|Boolean|Long|Character|Short|Byte )]", INTERESTING_TYPE),
createSearchTemplateInfo(SSRBundle.message("predefined.configuration.any.unboxing"), "'_expression:[ formal( int|boolean|long|char|short|byte ) && exprtype( Integer|Boolean|Long|Character|Short|Byte )]", INTERESTING_TYPE),
//createSearchTemplateInfo("methods called","'_?.'_:[ref('Method)] ('_*)", INTERESTING_TYPE),
//createSearchTemplateInfo("fields selected","'_?.'_:[ref('Field)] ", INTERESTING_TYPE),
//createSearchTemplateInfo("symbols used","'_:[ref('Symbol)] ", INTERESTING_TYPE),
//createSearchTemplateInfo("types used","'_:[ref('Type)] '_;", INTERESTING_TYPE),
};
}
}