plugins/org.eclipse.objectteams.otequinox/src/org/eclipse/objectteams/internal/osgi/weaving/AspectBinding.java

/**********************************************************************
 * This file is part of "Object Teams Development Tooling"-Software
 * 
 * Copyright 2009, 2013 Germany and Technical University Berlin, Germany and others.
 * 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Please visit http://www.eclipse.org/objectteams for updates and contact.
 * 
 * Contributors:
 * 		Technical University Berlin - Initial API and implementation
 * 		Stephan Herrmann - Initial API and implementation
 **********************************************************************/
package org.eclipse.objectteams.internal.osgi.weaving;

import static org.eclipse.objectteams.otequinox.TransformerPlugin.log;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.objectteams.otequinox.ActivationKind;
import org.osgi.framework.Bundle;

/** 
 * A simple record representing the information read from an extension to org.eclipse.objectteams.otequinox.aspectBindings.
 * @author stephan
 * @since 1.3.0 (was a nested class before that) 
 */
@NonNullByDefault
public class AspectBinding {
	enum State { Initial, TeamsScanned, TeamsActivated };
	
	public String aspectPlugin;
	public String basePlugin;
	public @Nullable IConfigurationElement[] forcedExports;
	// the following three are filled in lock-step:
	public String[]         teamClasses;
	public ActivationKind[] activations; 
	public List<String>[]   subTeamClasses;
	public boolean[]		 isActivated;

	public State 			 state = State.Initial;
	
	/** Dispenser for team classes indexed by base classes that should trigger activating the team. */
	private HashMap<String, Set<String>> teamsPerBase = new HashMap<>();
	
	/** Lookup to find base classes affected by a team (need to be available before instantiate/activate). */
	HashMap<String, Collection<String>> basesPerTeam = new HashMap<>();
	
	Set<String> teamsInProgress = new HashSet<>(); // TODO cleanup teams that are done
	
	@SuppressWarnings("unchecked")
	public AspectBinding(String aspectId, String baseId, @Nullable IConfigurationElement[] forcedExportsConfs, int count) {
		this.aspectPlugin= aspectId;
		this.basePlugin= baseId;
		this.forcedExports= forcedExportsConfs;
		this.teamClasses    = new String[count];
		this.subTeamClasses = new List[count]; // new List<String>[count] is illegal!
		this.activations    = new ActivationKind[count];
		this.isActivated    = new boolean[count]; 
	}
	
	public void setActivation(int i, @Nullable String specifier) {
		if (specifier == null)
			this.activations[i] = ActivationKind.NONE;
		else
			this.activations[i] = ActivationKind.valueOf(specifier);
	}

	public String toString() {
		String result = "\tbase plugin "+basePlugin+"\n\tadapted by aspect pluging "+aspectPlugin;
		for (String teamClass : teamClasses) {
			result += "\n\t\t + team "+teamClass;
		}
		return result;
	}

	public List<String> getAllTeams() {
		List<String> all = Arrays.asList(this.teamClasses);
		if (subTeamClasses != null) {
			all = new ArrayList<>(all);
			for (int i = 0; i < subTeamClasses.length; i++)
				if (subTeamClasses[i] != null)
					all.addAll(subTeamClasses[i]);
		}
		return all;
	}

	public void addBaseClassNames(String teamName, Collection<String> baseClassNames) {
		basesPerTeam.put(teamName, baseClassNames);
		for (String baseClassName : baseClassNames) {
			Set<String> teams = teamsPerBase.get(baseClassName);
			if (teams == null)
				teamsPerBase.put(baseClassName, teams = new HashSet<>());
			teams.add(teamName);
		}
	}

	/** Destructively read the names of teams to load for a given base class. */
	public synchronized @Nullable Collection<String> getTeamsForBase(String baseClassName) {
		Set<String> teamNames = teamsPerBase.remove(baseClassName);
		if (teamNames != null) {
			teamNames.removeAll(teamsInProgress);
			teamsInProgress.addAll(teamNames);
		}
		return teamNames;		
	}

	public ActivationKind getActivation(String teamClassName) {
		for (int i=0; i<teamClasses.length; i++) {
			if (teamClasses[i].equals(teamClassName))
				return activations[i]; // cannot declare array elements as nonnull
		}
		return ActivationKind.NONE;
	}

	/** Read OT attributes of all teams in aspectBinding and collect affected base classes. */
	public synchronized void scanTeamClasses(Bundle bundle) {
		ClassScanner scanner = new ClassScanner();
		for (@SuppressWarnings("null")@NonNull String teamName : getAllTeams()) {
			try {
				teamName = scanner.readOTAttributes(bundle, teamName);
				Collection<String> baseClassNames = scanner.getCollectedBaseClassNames();
				if (!basesPerTeam.containsKey(teamName))
					addBaseClassNames(teamName, baseClassNames);
				log(IStatus.INFO, "Scanned team class "+teamName+", found "+baseClassNames.size()+" base classes");
			} catch (Exception e) {
				log(e, "Failed to scan team class "+teamName);
			}
		}
		this.state = State.TeamsScanned;
	}

	public void markAsActivated(String teamName) {
		for (int i = 0; i < this.teamClasses.length; i++) {
			if (this.teamClasses[i].equals(teamName)) {
				this.isActivated[i] = true;
				return;
			}
		}
	}
	
	public boolean isActivated(String teamName) {
		for (int i = 0; i < this.teamClasses.length; i++)
			if (this.teamClasses[i].equals(teamName))
				return this.isActivated[i];
		return false;
	}
}