/*******************************************************************************
* Copyright (c) 2000, 2006 IBM Corporation 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
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jface.text.link;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.link.LinkedModeModel;
import org.eclipse.jface.text.link.LinkedPosition;
import org.eclipse.jface.text.link.LinkedPositionGroup;
import org.eclipse.jface.text.source.Annotation;
import org.eclipse.jface.text.source.AnnotationModel;
/**
* Internal class.
*
* @since 3.0
*/
final class LinkedPositionAnnotations extends AnnotationModel {
/* annotation types */
private static final String TARGET_ANNOTATION_TYPE= "org.eclipse.ui.internal.workbench.texteditor.link.target"; //$NON-NLS-1$
private static final String SLAVE_ANNOTATION_TYPE= "org.eclipse.ui.internal.workbench.texteditor.link.slave"; //$NON-NLS-1$
private static final String FOCUS_ANNOTATION_TYPE= "org.eclipse.ui.internal.workbench.texteditor.link.master"; //$NON-NLS-1$
private static final String EXIT_ANNOTATION_TYPE= "org.eclipse.ui.internal.workbench.texteditor.link.exit"; //$NON-NLS-1$
/* configuration */
private boolean fMarkTargets= true;
private boolean fMarkSlaves= true;
private boolean fMarkFocus= true;
private boolean fMarkExitTarget= true;
private Annotation fFocusAnnotation= null;
private Annotation fExitAnnotation= null;
private final Map fGroupAnnotations= new HashMap();
private final Map fTargetAnnotations= new HashMap();
private Position[] fTargets= new Position[0];
private LinkedPosition fExitPosition= null;
/**
* Sets the position that should be highlighted as the focus position, i.e.
* as the position whose changes are propagated to all its linked positions
* by the linked environment.
*
* @param position the new focus position, or <code>null</code> if no focus is set.
* @throws BadLocationException if <code>position</code> is invalid
*/
private void setFocusPosition(Position position) throws BadLocationException {
if (fMarkFocus && getPosition(fFocusAnnotation) != position) {
removeAnnotation(fFocusAnnotation, false);
if (position != null) {
fFocusAnnotation= new Annotation(FOCUS_ANNOTATION_TYPE, false, ""); //$NON-NLS-1$
addAnnotation(fFocusAnnotation, position, false);
} else
fFocusAnnotation= null;
}
}
/**
* Sets the position that should be highlighted as the exit position, i.e.
* as the position whose changes are propagated to all its linked positions
* by the linked environment.
*
* @param position the new exit position, or <code>null</code> if no focus is set.
* @throws BadLocationException in case <code>position</code> is invalid
*/
private void setExitPosition(Position position) throws BadLocationException {
if (fMarkExitTarget && getPosition(fExitAnnotation) != position) {
removeAnnotation(fExitAnnotation, false);
if (position != null) {
fExitAnnotation= new Annotation(EXIT_ANNOTATION_TYPE, false, ""); //$NON-NLS-1$
addAnnotation(fExitAnnotation, position, false);
} else
fExitAnnotation= null;
}
}
/**
* Sets the positions that should be highlighted as the slave positions, i.e.
* as the positions that are linked to the focus position.
*
* @param positions the new slave positions, or <code>null</code> if no slave positions are to be set
* @throws BadLocationException in case any of the given positions is invalid
*/
private void setGroupPositions(List positions) throws BadLocationException {
if (!fMarkSlaves)
return;
// remove all positions which are already there
// Algorithm: toRemove contains all mappings at first, but all that are in
// positions get removed -> toRemove contains the difference set of previous - new
// toAdd are the new positions, which don't exist in previous = new - previous
List toRemove= new ArrayList(fGroupAnnotations.values());
Map toAdd= new HashMap();
if (positions != null) {
for (Iterator iter= positions.iterator(); iter.hasNext();) {
Position p= (Position) iter.next();
if (fGroupAnnotations.containsKey(p)) {
toRemove.remove(fGroupAnnotations.get(p));
} else {
Annotation a= new Annotation(SLAVE_ANNOTATION_TYPE, false, ""); //$NON-NLS-1$
toAdd.put(a, p);
fGroupAnnotations.put(p, a);
}
}
}
fGroupAnnotations.values().removeAll(toRemove);
replaceAnnotations((Annotation[]) toRemove.toArray(new Annotation[0]), toAdd, false);
}
/**
* Sets the positions that should be highlighted as the target positions, i.e.
* as the positions that can be jumped to in a linked set up.
*
* @param positions the new target positions, or <code>null</code> if no target positions are to be set
* @throws BadLocationException in case any of the given positions is invalid
*/
private void setTargetPositions(List positions) throws BadLocationException {
if (!fMarkTargets)
return;
// remove all positions which are already there
// Algorithm: toRemove contains all mappings at first, but all that are in
// positions get removed -> toRemove contains the difference set of previous - new
// toAdd are the new positions, which don't exist in previous = new - previous
List toRemove= new ArrayList(fTargetAnnotations.values());
Map toAdd= new HashMap();
if (positions != null) {
for (Iterator iter= positions.iterator(); iter.hasNext();) {
Position p= (Position) iter.next();
if (fTargetAnnotations.containsKey(p)) {
toRemove.remove(fTargetAnnotations.get(p));
} else {
Annotation a= new Annotation(TARGET_ANNOTATION_TYPE, false, ""); //$NON-NLS-1$
toAdd.put(a, p);
fTargetAnnotations.put(p, a);
}
}
}
fTargetAnnotations.values().removeAll(toRemove);
replaceAnnotations((Annotation[]) toRemove.toArray(new Annotation[0]), toAdd, false);
}
/**
* Switches the focus position to <code>position</code> given the
* <code>LinkedModeModel env</code>. The slave positions for <code>position</code>
* is extracted from the environment and set accordingly, the target positions
* are updated as well.
*
* @param env
* @param position
*/
public void switchToPosition(LinkedModeModel env, LinkedPosition position) {
if (fDocument == null ||
(position != null && getPosition(fFocusAnnotation) == position) ||
(position == null && fFocusAnnotation == null))
return;
LinkedPositionGroup linkedGroup= null;
if (position != null)
linkedGroup= env.getGroupForPosition(position);
List targets= new ArrayList();
targets.addAll(Arrays.asList(fTargets));
List group;
if (linkedGroup != null)
group= new ArrayList(Arrays.asList(linkedGroup.getPositions()));
else
group= new ArrayList();
if (position == null || !fDocument.equals(position.getDocument()))
// position is not valid if not in this document
position= null;
LinkedPosition exit= fExitPosition;
if (exit == null || !fDocument.equals(exit.getDocument()))
// position is not valid if not in this document
exit= null;
if (exit != null) {
group.remove(exit);
targets.remove(exit);
}
group.removeAll(targets);
targets.remove(position);
group.remove(position);
prune(targets);
prune(group);
try {
setFocusPosition(position);
setExitPosition(exit);
setGroupPositions(group);
setTargetPositions(targets);
} catch (BadLocationException e) {
// will never happen as we don't actually add/remove positions from the document
// see the addPosition / removePosition methods
Assert.isTrue(false);
}
fireModelChanged();
}
/**
* Prune <code>list</code> of all <code>LinkedPosition</code>s that
* do not belong to this model's <code>IDocument</code>.
*
* @param list the list of positions to prune
*/
private void prune(List list) {
for (Iterator iter= list.iterator(); iter.hasNext();) {
LinkedPosition pos= (LinkedPosition) iter.next();
if (!pos.getDocument().equals(fDocument))
iter.remove();
}
}
/**
* Sets the target positions
* @param positions
*/
public void setTargets(Position[] positions) {
fTargets= positions;
}
/**
* Sets the exit position.
*
* @param position the new exit position, or <code>null</code> if no exit position should be set
*/
public void setExitTarget(LinkedPosition position) {
fExitPosition = position;
}
/*
* @see org.eclipse.jface.text.source.AnnotationModel#addPosition(org.eclipse.jface.text.IDocument, org.eclipse.jface.text.Position)
*/
protected void addPosition(IDocument document, Position position) {
// don't to anything as our positions are managed by custom
// position updaters
}
/*
* @see org.eclipse.jface.text.source.AnnotationModel#removePosition(org.eclipse.jface.text.IDocument, org.eclipse.jface.text.Position)
*/
protected void removePosition(IDocument document, Position pos) {
// don't to anything as our positions are managed by custom
// position updaters
}
/*
* @see org.eclipse.jface.text.source.AnnotationModel#fireModelChanged()
*/
public void fireModelChanged() {
super.fireModelChanged();
}
/**
* Sets the drawing state for the exit target. Default is <code>true</code>.
*
* @param markExitTargets the new drawing state for exit targets
*/
public void markExitTarget(boolean markExitTargets) {
fMarkExitTarget= markExitTargets;
}
/**
* Sets the drawing state for the focus position. Default is <code>true</code>.
*
* @param markFocus the new drawing state for exit targets
*/
public void markFocus(boolean markFocus) {
fMarkFocus= markFocus;
}
/**
* Sets the drawing state for slave positions. Default is <code>true</code>.
*
* @param markSlaves the new drawing state for slaves
*/
public void markSlaves(boolean markSlaves) {
fMarkSlaves= markSlaves;
}
/**
* Sets the drawing state for targets. Default is <code>true</code>.
*
* @param markTargets the new drawing state for targets
*/
public void markTargets(boolean markTargets) {
fMarkTargets= markTargets;
}
}