update copyrights
[idea/community.git] / platform / lang-api / src / com / intellij / codeInsight / highlighting / ReadWriteAccessDetector.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package com.intellij.codeInsight.highlighting;
18
19 import com.intellij.openapi.extensions.ExtensionPointName;
20 import com.intellij.openapi.extensions.Extensions;
21 import com.intellij.psi.PsiElement;
22 import com.intellij.psi.PsiReference;
23 import org.jetbrains.annotations.Nullable;
24
25 /**
26  * @author yole
27  */
28 public abstract class ReadWriteAccessDetector {
29   public static final ExtensionPointName<ReadWriteAccessDetector> EP_NAME = ExtensionPointName.create("com.intellij.readWriteAccessDetector");
30
31   @Nullable
32   public static ReadWriteAccessDetector findDetector(final PsiElement element) {
33     ReadWriteAccessDetector detector = null;
34     for(ReadWriteAccessDetector accessDetector: Extensions.getExtensions(EP_NAME)) {
35       if (accessDetector.isReadWriteAccessible(element)) {
36         detector = accessDetector;
37         break;
38       }
39     }
40     return detector;
41   }
42
43   public enum Access { Read, Write, ReadWrite }
44
45   public abstract boolean isReadWriteAccessible(PsiElement element);
46   public abstract boolean isDeclarationWriteAccess(PsiElement element);
47   public abstract Access getReferenceAccess(final PsiElement referencedElement, PsiReference reference);
48   public abstract Access getExpressionAccess(PsiElement expression);
49 }