Package com.intellij.structuralsearch

Class StructuralSearchProfile

java.lang.Object

com.intellij.structuralsearch.StructuralSearchProfile

Direct Known Subclasses:

JavaStructuralSearchProfile, StructuralSearchProfileBase, XmlStructuralSearchProfile

public abstract class StructuralSearchProfile
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<StructuralSearchProfile>	EP_NAME
protected static java.lang.String	PATTERN_PLACEHOLDER

Constructor Summary

Constructors

Constructor and Description
StructuralSearchProfile()

Method Summary

Modifier and Type	Method and Description
boolean	canBeVarDelimiter(PsiElement element)
void	checkReplacementPattern(Project project, ReplaceOptions options)
void	checkSearchPattern(CompiledPattern pattern)
abstract void	compile(PsiElement[] elements, GlobalCompilingVisitor globalVisitor)
PsiCodeFragment	createCodeFragment(Project project, java.lang.String text, java.lang.String contextId)
abstract CompiledPattern	createCompiledPattern()
abstract PsiElementVisitor	createMatchingVisitor(GlobalMatchingVisitor globalVisitor)
PsiElement[]	createPatternTree(java.lang.String text, PatternContextInfo contextInfo, LanguageFileType fileType, Language language, Project project, boolean physical)
PsiElement[]	createPatternTree(java.lang.String text, PatternTreeContext context, LanguageFileType fileType, Language language, java.lang.String contextId, Project project, boolean physical)
LanguageFileType	detectFileType(PsiElement context)
PsiElement	extendMatchedByDownUp(PsiElement node)
PsiElement	extendMatchOnePsiFile(PsiElement file)
java.lang.String	getAlternativeText(PsiElement element, java.lang.String previousText)
java.lang.String	getCodeFragmentText(PsiFile fragment) This method is called while holding a read action.
protected java.lang.String	getContext(java.lang.String pattern, Language language, java.lang.String contextId)
java.util.List<MatchPredicate>	getCustomPredicates(MatchVariableConstraint constraint, java.lang.String name, MatchOptions options)
LanguageFileType	getDefaultFileType(LanguageFileType fileType)
abstract NodeFilter	getLexicalNodesFilter()
java.lang.String	getMeaningfulText(PsiElement element)
java.util.List<PatternContext>	getPatternContexts()
protected java.lang.String	getPlaceholderVarName()
Configuration[]	getPredefinedTemplates()
PsiElement	getPresentableElement(PsiElement element)
StructuralReplaceHandler	getReplaceHandler(Project project, ReplaceOptions replaceOptions)
java.util.Collection<java.lang.String>	getReservedWords()
abstract java.lang.Class<? extends TemplateContextType>	getTemplateContextTypeClass()
java.lang.String	getText(PsiElement match, int start, int end)
java.lang.String	getTypedVarString(PsiElement element)
void	handleNoSubstitution(ParameterInfo info, java.lang.StringBuilder result)
void	handleSubstitution(ParameterInfo info, MatchResult match, java.lang.StringBuilder result, ReplacementInfo replacementInfo)
boolean	isApplicableConstraint(java.lang.String constraintName, java.util.List<? extends PsiElement> nodes, boolean completePattern, boolean target)
boolean	isApplicableConstraint(java.lang.String constraintName, PsiElement variableNode, boolean completePattern, boolean target) Override this method to influence which UI controls are shown when editing the constraints of the specified variable.
boolean	isApplicableContextConfiguration(Configuration configuration)
boolean	isDocCommentOwner(PsiElement match)
boolean	isIdentifier(PsiElement element)
abstract boolean	isMyLanguage(Language language)
void	provideAdditionalReplaceOptions(PsiElement node, ReplaceOptions options, ReplacementBuilder builder)
boolean	shouldShowProblem(PsiErrorElement error)
PsiElement	updateCurrentNode(PsiElement node)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EP_NAME

public static final ExtensionPointName<StructuralSearchProfile> EP_NAME

PATTERN_PLACEHOLDER

protected static final java.lang.String PATTERN_PLACEHOLDER

See Also:

Constant Field Values

Constructor Detail

StructuralSearchProfile

public StructuralSearchProfile()

Method Detail

compile

public abstract void compile(PsiElement[] elements,
                             GlobalCompilingVisitor globalVisitor)

createMatchingVisitor

public abstract PsiElementVisitor createMatchingVisitor(GlobalMatchingVisitor globalVisitor)

getLexicalNodesFilter

public abstract NodeFilter getLexicalNodesFilter()

createCompiledPattern

public abstract CompiledPattern createCompiledPattern()

getCustomPredicates

public java.util.List<MatchPredicate> getCustomPredicates(MatchVariableConstraint constraint,
                                                          java.lang.String name,
                                                          MatchOptions options)

isMyLanguage

public abstract boolean isMyLanguage(Language language)

createPatternTree

public PsiElement[] createPatternTree(java.lang.String text,
                                      PatternTreeContext context,
                                      LanguageFileType fileType,
                                      Language language,
                                      java.lang.String contextId,
                                      Project project,
                                      boolean physical)

createPatternTree

public PsiElement[] createPatternTree(java.lang.String text,
                                      PatternContextInfo contextInfo,
                                      LanguageFileType fileType,
                                      Language language,
                                      Project project,
                                      boolean physical)

getPatternContexts

public java.util.List<PatternContext> getPatternContexts()

getPlaceholderVarName

protected java.lang.String getPlaceholderVarName()

getContext

protected java.lang.String getContext(java.lang.String pattern,
                                      Language language,
                                      java.lang.String contextId)

createCodeFragment

public PsiCodeFragment createCodeFragment(Project project,
                                          java.lang.String text,
                                          java.lang.String contextId)

getCodeFragmentText

public java.lang.String getCodeFragmentText(PsiFile fragment)

This method is called while holding a read action.

getTemplateContextTypeClass

public abstract java.lang.Class<? extends TemplateContextType> getTemplateContextTypeClass()

detectFileType

public LanguageFileType detectFileType(PsiElement context)

getReplaceHandler

public StructuralReplaceHandler getReplaceHandler(Project project,
                                                  ReplaceOptions replaceOptions)

checkSearchPattern

public void checkSearchPattern(CompiledPattern pattern)

checkReplacementPattern

public void checkReplacementPattern(Project project,
                                    ReplaceOptions options)

shouldShowProblem

public boolean shouldShowProblem(PsiErrorElement error)

canBeVarDelimiter

public boolean canBeVarDelimiter(PsiElement element)

getText

public java.lang.String getText(PsiElement match,
                                int start,
                                int end)

getTypedVarString

public java.lang.String getTypedVarString(PsiElement element)

getMeaningfulText

public java.lang.String getMeaningfulText(PsiElement element)

getAlternativeText

public java.lang.String getAlternativeText(PsiElement element,
                                           java.lang.String previousText)

updateCurrentNode

public PsiElement updateCurrentNode(PsiElement node)

extendMatchedByDownUp

public PsiElement extendMatchedByDownUp(PsiElement node)

extendMatchOnePsiFile

public PsiElement extendMatchOnePsiFile(PsiElement file)

getDefaultFileType

public LanguageFileType getDefaultFileType(LanguageFileType fileType)

getPredefinedTemplates

public Configuration[] getPredefinedTemplates()

provideAdditionalReplaceOptions

public void provideAdditionalReplaceOptions(PsiElement node,
                                            ReplaceOptions options,
                                            ReplacementBuilder builder)

handleSubstitution

public void handleSubstitution(ParameterInfo info,
                               MatchResult match,
                               java.lang.StringBuilder result,
                               ReplacementInfo replacementInfo)

handleNoSubstitution

public void handleNoSubstitution(ParameterInfo info,
                                 java.lang.StringBuilder result)

isIdentifier

public boolean isIdentifier(PsiElement element)

getReservedWords

public java.util.Collection<java.lang.String> getReservedWords()

isDocCommentOwner

public boolean isDocCommentOwner(PsiElement match)

getPresentableElement

public PsiElement getPresentableElement(PsiElement element)

isApplicableConstraint

public boolean isApplicableConstraint(java.lang.String constraintName,
                                      PsiElement variableNode,
                                      boolean completePattern,
                                      boolean target)

Override this method to influence which UI controls are shown when editing the constraints of the specified variable.

Parameters:

constraintName - the name of the constraint controls for which applicability is considered. See UIUtil for predefined constraint names

variableNode - the psi element corresponding to the current variable

completePattern - true, if the current variableNode encompasses the complete pattern. The variableNode can also be null in this case.

target - true, if the current variableNode is the target of the search

Returns:

true, if the requested constraint is applicable and the corresponding UI should be shown when editing the variable; false otherwise

isApplicableConstraint

public final boolean isApplicableConstraint(java.lang.String constraintName,
                                            java.util.List<? extends PsiElement> nodes,
                                            boolean completePattern,
                                            boolean target)

isApplicableContextConfiguration

public boolean isApplicableContextConfiguration(Configuration configuration)