/*
 * Copyright 2013-2017 consulo.io
 *
 * 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 consulo.csharp.lang.psi.resolve;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import com.intellij.openapi.util.UserDataHolder;
import com.intellij.psi.PsiElement;
import com.intellij.psi.tree.IElementType;
import com.intellij.util.ArrayFactory;
import com.intellij.util.Processor;
import consulo.annotations.RequiredReadAction;
import consulo.csharp.lang.CSharpCastType;
import consulo.csharp.lang.psi.CSharpConstructorDeclaration;
import consulo.csharp.lang.psi.CSharpConversionMethodDeclaration;
import consulo.csharp.lang.psi.CSharpIndexMethodDeclaration;
import consulo.csharp.lang.psi.CSharpMethodDeclaration;

/**
 * @author VISTALL
 * @since 29.09.14
 */
public interface CSharpResolveContext
{
	public static final CSharpResolveContext[] EMPTY_ARRAY = new CSharpResolveContext[0];

	public static ArrayFactory<CSharpResolveContext> ARRAY_FACTORY = new ArrayFactory<CSharpResolveContext>()
	{
		@NotNull
		@Override
		public CSharpResolveContext[] create(int count)
		{
			return count == 0 ? EMPTY_ARRAY : new CSharpResolveContext[count];
		}
	};

	CSharpResolveContext EMPTY = new CSharpResolveContextAdapter();

	@Nullable
	@RequiredReadAction
	CSharpElementGroup<CSharpIndexMethodDeclaration> indexMethodGroup(boolean deep);

	@Nullable
	@RequiredReadAction
	CSharpElementGroup<CSharpConstructorDeclaration> constructorGroup();

	@Nullable
	@RequiredReadAction
	CSharpElementGroup<CSharpConstructorDeclaration> deConstructorGroup();

	@Nullable
	@RequiredReadAction
	CSharpElementGroup<CSharpMethodDeclaration> findOperatorGroupByTokenType(@NotNull IElementType type, boolean deep);

	@Nullable
	@RequiredReadAction
	CSharpElementGroup<CSharpConversionMethodDeclaration> findConversionMethodGroup(@NotNull CSharpCastType castType, boolean deep);

	@Nullable
	@RequiredReadAction
	CSharpElementGroup<CSharpMethodDeclaration> findExtensionMethodGroupByName(@NotNull String name);

	@RequiredReadAction
	boolean processExtensionMethodGroups(@NotNull Processor<CSharpElementGroup<CSharpMethodDeclaration>> processor);

	@NotNull
	@RequiredReadAction
	PsiElement[] findByName(@NotNull String name, boolean deep, @NotNull UserDataHolder holder);

	@RequiredReadAction
	boolean processElements(@NotNull Processor<PsiElement> processor, boolean deep);

	@NotNull
	PsiElement getElement();
}