bundles/org.eclipse.e4.core.macros/src/org/eclipse/e4/core/macros/internal/MacroServiceImplementation.java - e4/org.eclipse.e4.ui - Git at Google

 /*******************************************************************************
  * Copyright (c) 2017 Fabio Zadrozny 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:
  *     Fabio Zadrozny - initial API and implementation - http://eclip.se/8519
  *******************************************************************************/
 package org.eclipse.e4.core.macros.internal;

 import java.io.File;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.function.Predicate;
 import javax.inject.Inject;
 import org.eclipse.core.runtime.Assert;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IConfigurationElement;
 import org.eclipse.core.runtime.IExtensionRegistry;
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.e4.core.contexts.ContextInjectionFactory;
 import org.eclipse.e4.core.contexts.IEclipseContext;
 import org.eclipse.e4.core.macros.Activator;
 import org.eclipse.e4.core.macros.CancelMacroRecordingException;
 import org.eclipse.e4.core.macros.EMacroService;
 import org.eclipse.e4.core.macros.IMacroInstruction;
 import org.eclipse.e4.core.macros.IMacroInstructionFactory;
 import org.eclipse.e4.core.macros.IMacroInstructionsListener;
 import org.eclipse.e4.core.macros.IMacroPlaybackContext;
 import org.eclipse.e4.core.macros.IMacroRecordContext;
 import org.eclipse.e4.core.macros.IMacroStateListener;
 import org.eclipse.e4.core.macros.MacroPlaybackException;

 /**
  * An implementation of the public API for dealing with macros (mostly passes
  * things to an internal MacroManager instance and sets it up properly, dealing
  * with the eclipse context and extension points).
  */
 public class MacroServiceImplementation implements EMacroService {
 	private static final String MACRO_COMMAND_HANDLING_EXTENSION_POINT = "org.eclipse.e4.core.macros.commandHandling"; //$NON-NLS-1$
 	private static final String MACRO_COMMAND_HANDLING_ELEMENT = "command"; //$NON-NLS-1$
 	private static final String MACRO_COMMAND_HANDLING_ID = "id"; //$NON-NLS-1$
 	private static final String MACRO_COMMAND_HANDLING_RECORDING = "recordMacroInstruction"; //$NON-NLS-1$

 	public static final String MACRO_INSTRUCTION_FACTORY_EXTENSION_POINT = "org.eclipse.e4.core.macros.macroInstructionsFactory"; //$NON-NLS-1$
 	public static final String MACRO_INSTRUCTION_ID = "macroInstructionId"; //$NON-NLS-1$
 	public static final String MACRO_INSTRUCTION_FACTORY_CLASS = "class"; //$NON-NLS-1$

 	public static final String MACRO_LISTENERS_EXTENSION_POINT = "org.eclipse.e4.core.macros.macroStateListeners"; //$NON-NLS-1$
 	public static final String MACRO_LISTENER_CLASS = "class"; //$NON-NLS-1$

 	// id to factory used in instance
 	private Map<String, IMacroInstructionFactory> fMacroInstructionIdToFactory;

 	private boolean fLoadedExtensionListeners = false;

 	private IEclipseContext fEclipseContext;

 	private IExtensionRegistry fExtensionRegistry;

 	/**
 	 * The instance of the macro manager.
 	 */
 	private MacroManager fMacroManager;

 	/**
 	 * A filter which allows blacklisting registered macro listeners. Note that it is
 	 * private and has no setters because it is meant only to be used in tests
 	 * (through reflection).
 	 */
 	private Predicate<IConfigurationElement> fFilterMacroListeners;

 	@Inject
 	public MacroServiceImplementation(IEclipseContext eclipseContext, IExtensionRegistry extensionRegistry) {
 		Assert.isNotNull(eclipseContext);
 		Assert.isNotNull(extensionRegistry);
 		fEclipseContext = eclipseContext;
 		fExtensionRegistry = extensionRegistry;
 	}

 	/**
 	 * Gets the macro manager (lazily creates it if needed).
 	 *
 	 * @return the macro manager responsible for managing macros.
 	 */
 	public MacroManager getMacroManager() {
 		if (fMacroManager == null) {
 			// user.home/.eclipse is already used by oomph and recommenders, so,
 			// it seems a good place to read additional macros which should be
 			// persisted for the user who wants to store macros across
 			// workspaces.
 			Activator plugin = Activator.getDefault();
 			File[] macrosDirectory;
 			if (plugin != null) {
 				IPath stateLocation = plugin.getStateLocation();
 				stateLocation.append("macros"); //$NON-NLS-1$
 				File userHome = new File(System.getProperty("user.home")); //$NON-NLS-1$
 				File eclipseUserHome = new File(userHome, ".eclipse"); //$NON-NLS-1$
 				File eclipseUserHomeMacros = new File(eclipseUserHome, "org.eclipse.e4.core.macros"); //$NON-NLS-1$
 				File eclipseUserHomeMacrosLoadDir = new File(eclipseUserHomeMacros, "macros"); //$NON-NLS-1$
 				if (!eclipseUserHomeMacrosLoadDir.exists()) {
 					eclipseUserHomeMacrosLoadDir.mkdirs();
 				}
 				macrosDirectory = new File[] { stateLocation.toFile(), eclipseUserHomeMacrosLoadDir };
 				// By default macros are saved/loaded under the workspace, but
 				// can also be loaded from the
 				//
 				// user.home/.eclipse/org.eclipse.e4.macros/macros
 				//
 				// directory.
 			} else {
 				macrosDirectory = new File[] {};
 			}
 			fMacroManager = new MacroManager(macrosDirectory);
 		}
 		return fMacroManager;
 	}

 	/**
 	 * Loads the macro listeners provided through extension points.
 	 */
 	private void loadExtensionPointsmacroStateListeners() {
 		if (!fLoadedExtensionListeners) {
 			fLoadedExtensionListeners = true;

 			MacroManager macroManager = getMacroManager();
 			IConfigurationElement[] macroListenersConfigurationElements = fExtensionRegistry
 					.getConfigurationElementsFor(MACRO_LISTENERS_EXTENSION_POINT);

 			if (fFilterMacroListeners != null) {
 				macroListenersConfigurationElements = Arrays.asList(macroListenersConfigurationElements).stream()
 						.filter(fFilterMacroListeners).toArray(IConfigurationElement[]::new);
 			}

 			for (IConfigurationElement ce : macroListenersConfigurationElements) {
 				String macroStateListenerClass = ce.getAttribute(MACRO_LISTENER_CLASS);
 				if (macroStateListenerClass != null) {
 					try {
 						IMacroStateListener macroStateListener = (IMacroStateListener) ce
 								.createExecutableExtension(MACRO_LISTENER_CLASS);
 						// Make sure that it has the proper eclipse context.
 						ContextInjectionFactory.inject(macroStateListener, fEclipseContext);
 						macroManager.addMacroStateListener(macroStateListener);
 					} catch (CoreException e) {
 						Activator.log(e);
 					}
 				} else {
 					Activator.log(new RuntimeException(
 							"Wrong definition for extension: " + MACRO_LISTENERS_EXTENSION_POINT + ": " + ce)); //$NON-NLS-1$ //$NON-NLS-2$
 				}
 			}
 		}
 	}

 	/**
 	 * Provides a map which maps macro instruction ids to the factory used to
 	 * recreate the related instruction.
 	 *
 	 * @return a map with macro instruction id to the related factory (creates it
 	 *         lazily if it still wasn't created).
 	 */
 	private Map<String, IMacroInstructionFactory> getMacroInstructionIdToFactory() {
 		if (fMacroInstructionIdToFactory == null) {
 			Map<String, IMacroInstructionFactory> validMacroInstructionIds = new HashMap<>();
 			for (IConfigurationElement ce : fExtensionRegistry
 					.getConfigurationElementsFor(MACRO_INSTRUCTION_FACTORY_EXTENSION_POINT)) {
 				String macroInstructionId = ce.getAttribute(MACRO_INSTRUCTION_ID);
 				String macroInstructionFactoryClass = ce.getAttribute(MACRO_INSTRUCTION_FACTORY_CLASS);
 				if (macroInstructionId != null && macroInstructionFactoryClass != null) {
 					try {
 						IMacroInstructionFactory macroInstructionFactory = (IMacroInstructionFactory) ce
 								.createExecutableExtension(MACRO_INSTRUCTION_FACTORY_CLASS);

 						// Make sure that it has the proper eclipse context.
 						ContextInjectionFactory.inject(macroInstructionFactory, fEclipseContext);
 						validMacroInstructionIds.put(macroInstructionId, macroInstructionFactory);
 					} catch (CoreException e) {
 						Activator.log(e);
 					}
 				} else {
 					Activator.log(new RuntimeException("Wrong definition for extension: " //$NON-NLS-1$
 							+ MACRO_INSTRUCTION_FACTORY_EXTENSION_POINT + ": " + ce)); //$NON-NLS-1$
 				}
 			}
 			fMacroInstructionIdToFactory = Collections.unmodifiableMap(validMacroInstructionIds);
 		}
 		return fMacroInstructionIdToFactory;
 	}

 	@Override
 	public boolean isRecording() {
 		if (fMacroManager == null) {
 			// Avoid creating if possible
 			return false;
 		}
 		return getMacroManager().isRecording();
 	}

 	@Override
 	public boolean isPlayingBack() {
 		if (fMacroManager == null) {
 			// Avoid creating if possible
 			return false;
 		}
 		return getMacroManager().isPlayingBack();
 	}

 	@Override
 	public void addMacroInstruction(IMacroInstruction macroInstruction) {
 		if (isRecording()) {
 			try {
 				getMacroManager().addMacroInstruction(macroInstruction);
 			} catch (CancelMacroRecordingException e) {
 				stopMacroRecording();
 			}
 		}
 	}

 	@Override
 	public void addMacroInstruction(IMacroInstruction macroInstruction, Object event, int priority) {
 		if (isRecording()) {
 			try {
 				getMacroManager().addMacroInstruction(macroInstruction, event, priority);
 			} catch (CancelMacroRecordingException e) {
 				stopMacroRecording();
 			}
 		}
 	}

 	/**
 	 * Stops the macro recording.
 	 */
 	private void stopMacroRecording() {
 		if (isRecording()) {
 			toggleMacroRecord();
 		}
 	}

 	@Override
 	public void toggleMacroRecord() {
 		loadExtensionPointsmacroStateListeners();
 		getMacroManager().toggleMacroRecord(this, getMacroInstructionIdToFactory());
 	}

 	@Override
 	public void playbackLastMacro() throws MacroPlaybackException {
 		loadExtensionPointsmacroStateListeners();
 		Map<String, IMacroInstructionFactory> macroInstructionIdToFactory = getMacroInstructionIdToFactory();
 		IMacroPlaybackContext macroPlaybackContext = new MacroPlaybackContextImpl();
 		getMacroManager().playbackLastMacro(this, macroPlaybackContext, macroInstructionIdToFactory);
 	}

 	@Override
 	public void addMacroStateListener(IMacroStateListener listener) {
 		getMacroManager().addMacroStateListener(listener);
 	}

 	@Override
 	public void removeMacroStateListener(IMacroStateListener listener) {
 		getMacroManager().removeMacroStateListener(listener);
 	}

 	@Override
 	public IMacroRecordContext getMacroRecordContext() {
 		return getMacroManager().getMacroRecordContext();
 	}

 	@Override
 	public IMacroPlaybackContext getMacroPlaybackContext() {
 		return getMacroManager().getMacroPlaybackContext();
 	}

 	/**
 	 * Note that this is only available in this implementation, not on the public
 	 * API (EMacroService). Needed for testing.
 	 *
 	 * @return the currently registered listeners.
 	 */
 	public IMacroStateListener[] getMacroStateListeners() {
 		return getMacroManager().getMacroStateListeners();
 	}

 	/**
 	 * A map which maps accepted command ids when recording a macro to whether they
 	 * should be recorded as a macro instruction to be played back later on.
 	 */
 	private Map<String, Boolean> fCommandIdToRecordFlag;

 	private Map<String, Boolean> getCommandIdToRecordFlag() {
 		if (fCommandIdToRecordFlag == null) {
 			fCommandIdToRecordFlag = new HashMap<>();
 			for (IConfigurationElement ce : fExtensionRegistry
 					.getConfigurationElementsFor(MACRO_COMMAND_HANDLING_EXTENSION_POINT)) {
 				if (MACRO_COMMAND_HANDLING_ELEMENT.equals(ce.getName())
 						&& ce.getAttribute(MACRO_COMMAND_HANDLING_ID) != null
 						&& ce.getAttribute(MACRO_COMMAND_HANDLING_RECORDING) != null) {
 					Boolean recordMacroInstruction = Boolean
 							.parseBoolean(ce.getAttribute(MACRO_COMMAND_HANDLING_RECORDING));
 					fCommandIdToRecordFlag.put(ce.getAttribute(MACRO_COMMAND_HANDLING_ID), recordMacroInstruction);
 				}
 			}
 		}
 		return fCommandIdToRecordFlag;
 	}

 	@Override
 	public boolean getRecordCommandInMacro(String commandId) {
 		Map<String, Boolean> macrocommandHandling = getCommandIdToRecordFlag();
 		return macrocommandHandling.getOrDefault(commandId, true);
 	}

 	@Override
 	public void setRecordCommandInMacro(String commandId, boolean recordMacroInstruction) {
 		getCommandIdToRecordFlag().put(commandId, recordMacroInstruction);
 	}

 	@Override
 	public void addMacroInstructionsListener(IMacroInstructionsListener macroInstructionsListener) {
 		getMacroManager().addMacroInstructionsListener(macroInstructionsListener);
 	}

 	@Override
 	public void removeMacroInstructionsListener(IMacroInstructionsListener macroInstructionsListener) {
 		getMacroManager().removeMacroInstructionsListener(macroInstructionsListener);
 	}

 }
	/*******************************************************************************
	* Copyright (c) 2017 Fabio Zadrozny 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:
	* Fabio Zadrozny - initial API and implementation - http://eclip.se/8519
	*******************************************************************************/
	package org.eclipse.e4.core.macros.internal;

	import java.io.File;
	import java.util.Arrays;
	import java.util.Collections;
	import java.util.HashMap;
	import java.util.Map;
	import java.util.function.Predicate;
	import javax.inject.Inject;
	import org.eclipse.core.runtime.Assert;
	import org.eclipse.core.runtime.CoreException;
	import org.eclipse.core.runtime.IConfigurationElement;
	import org.eclipse.core.runtime.IExtensionRegistry;
	import org.eclipse.core.runtime.IPath;
	import org.eclipse.e4.core.contexts.ContextInjectionFactory;
	import org.eclipse.e4.core.contexts.IEclipseContext;
	import org.eclipse.e4.core.macros.Activator;
	import org.eclipse.e4.core.macros.CancelMacroRecordingException;
	import org.eclipse.e4.core.macros.EMacroService;
	import org.eclipse.e4.core.macros.IMacroInstruction;
	import org.eclipse.e4.core.macros.IMacroInstructionFactory;
	import org.eclipse.e4.core.macros.IMacroInstructionsListener;
	import org.eclipse.e4.core.macros.IMacroPlaybackContext;
	import org.eclipse.e4.core.macros.IMacroRecordContext;
	import org.eclipse.e4.core.macros.IMacroStateListener;
	import org.eclipse.e4.core.macros.MacroPlaybackException;

	/**
	* An implementation of the public API for dealing with macros (mostly passes
	* things to an internal MacroManager instance and sets it up properly, dealing
	* with the eclipse context and extension points).
	*/
	public class MacroServiceImplementation implements EMacroService {
	private static final String MACRO_COMMAND_HANDLING_EXTENSION_POINT = "org.eclipse.e4.core.macros.commandHandling"; //$NON-NLS-1$
	private static final String MACRO_COMMAND_HANDLING_ELEMENT = "command"; //$NON-NLS-1$
	private static final String MACRO_COMMAND_HANDLING_ID = "id"; //$NON-NLS-1$
	private static final String MACRO_COMMAND_HANDLING_RECORDING = "recordMacroInstruction"; //$NON-NLS-1$

	public static final String MACRO_INSTRUCTION_FACTORY_EXTENSION_POINT = "org.eclipse.e4.core.macros.macroInstructionsFactory"; //$NON-NLS-1$
	public static final String MACRO_INSTRUCTION_ID = "macroInstructionId"; //$NON-NLS-1$
	public static final String MACRO_INSTRUCTION_FACTORY_CLASS = "class"; //$NON-NLS-1$

	public static final String MACRO_LISTENERS_EXTENSION_POINT = "org.eclipse.e4.core.macros.macroStateListeners"; //$NON-NLS-1$
	public static final String MACRO_LISTENER_CLASS = "class"; //$NON-NLS-1$

	// id to factory used in instance
	private Map<String, IMacroInstructionFactory> fMacroInstructionIdToFactory;

	private boolean fLoadedExtensionListeners = false;

	private IEclipseContext fEclipseContext;

	private IExtensionRegistry fExtensionRegistry;

	/**
	* The instance of the macro manager.
	*/
	private MacroManager fMacroManager;

	/**
	* A filter which allows blacklisting registered macro listeners. Note that it is
	* private and has no setters because it is meant only to be used in tests
	* (through reflection).
	*/
	private Predicate<IConfigurationElement> fFilterMacroListeners;

	@Inject
	public MacroServiceImplementation(IEclipseContext eclipseContext, IExtensionRegistry extensionRegistry) {
	Assert.isNotNull(eclipseContext);
	Assert.isNotNull(extensionRegistry);
	fEclipseContext = eclipseContext;
	fExtensionRegistry = extensionRegistry;
	}

	/**
	* Gets the macro manager (lazily creates it if needed).
	*
	* @return the macro manager responsible for managing macros.
	*/
	public MacroManager getMacroManager() {
	if (fMacroManager == null) {
	// user.home/.eclipse is already used by oomph and recommenders, so,
	// it seems a good place to read additional macros which should be
	// persisted for the user who wants to store macros across
	// workspaces.
	Activator plugin = Activator.getDefault();
	File[] macrosDirectory;
	if (plugin != null) {
	IPath stateLocation = plugin.getStateLocation();
	stateLocation.append("macros"); //$NON-NLS-1$
	File userHome = new File(System.getProperty("user.home")); //$NON-NLS-1$
	File eclipseUserHome = new File(userHome, ".eclipse"); //$NON-NLS-1$
	File eclipseUserHomeMacros = new File(eclipseUserHome, "org.eclipse.e4.core.macros"); //$NON-NLS-1$
	File eclipseUserHomeMacrosLoadDir = new File(eclipseUserHomeMacros, "macros"); //$NON-NLS-1$
	if (!eclipseUserHomeMacrosLoadDir.exists()) {
	eclipseUserHomeMacrosLoadDir.mkdirs();
	}
	macrosDirectory = new File[] { stateLocation.toFile(), eclipseUserHomeMacrosLoadDir };
	// By default macros are saved/loaded under the workspace, but
	// can also be loaded from the
	//
	// user.home/.eclipse/org.eclipse.e4.macros/macros
	//
	// directory.
	} else {
	macrosDirectory = new File[] {};
	}
	fMacroManager = new MacroManager(macrosDirectory);
	}
	return fMacroManager;
	}

	/**
	* Loads the macro listeners provided through extension points.
	*/
	private void loadExtensionPointsmacroStateListeners() {
	if (!fLoadedExtensionListeners) {
	fLoadedExtensionListeners = true;

	MacroManager macroManager = getMacroManager();
	IConfigurationElement[] macroListenersConfigurationElements = fExtensionRegistry
	.getConfigurationElementsFor(MACRO_LISTENERS_EXTENSION_POINT);

	if (fFilterMacroListeners != null) {
	macroListenersConfigurationElements = Arrays.asList(macroListenersConfigurationElements).stream()
	.filter(fFilterMacroListeners).toArray(IConfigurationElement[]::new);
	}

	for (IConfigurationElement ce : macroListenersConfigurationElements) {
	String macroStateListenerClass = ce.getAttribute(MACRO_LISTENER_CLASS);
	if (macroStateListenerClass != null) {
	try {
	IMacroStateListener macroStateListener = (IMacroStateListener) ce
	.createExecutableExtension(MACRO_LISTENER_CLASS);
	// Make sure that it has the proper eclipse context.
	ContextInjectionFactory.inject(macroStateListener, fEclipseContext);
	macroManager.addMacroStateListener(macroStateListener);
	} catch (CoreException e) {
	Activator.log(e);
	}
	} else {
	Activator.log(new RuntimeException(
	"Wrong definition for extension: " + MACRO_LISTENERS_EXTENSION_POINT + ": " + ce)); //$NON-NLS-1$ //$NON-NLS-2$
	}
	}
	}
	}

	/**
	* Provides a map which maps macro instruction ids to the factory used to
	* recreate the related instruction.
	*
	* @return a map with macro instruction id to the related factory (creates it
	* lazily if it still wasn't created).
	*/
	private Map<String, IMacroInstructionFactory> getMacroInstructionIdToFactory() {
	if (fMacroInstructionIdToFactory == null) {
	Map<String, IMacroInstructionFactory> validMacroInstructionIds = new HashMap<>();
	for (IConfigurationElement ce : fExtensionRegistry
	.getConfigurationElementsFor(MACRO_INSTRUCTION_FACTORY_EXTENSION_POINT)) {
	String macroInstructionId = ce.getAttribute(MACRO_INSTRUCTION_ID);
	String macroInstructionFactoryClass = ce.getAttribute(MACRO_INSTRUCTION_FACTORY_CLASS);
	if (macroInstructionId != null && macroInstructionFactoryClass != null) {
	try {
	IMacroInstructionFactory macroInstructionFactory = (IMacroInstructionFactory) ce
	.createExecutableExtension(MACRO_INSTRUCTION_FACTORY_CLASS);

	// Make sure that it has the proper eclipse context.
	ContextInjectionFactory.inject(macroInstructionFactory, fEclipseContext);
	validMacroInstructionIds.put(macroInstructionId, macroInstructionFactory);
	} catch (CoreException e) {
	Activator.log(e);
	}
	} else {
	Activator.log(new RuntimeException("Wrong definition for extension: " //$NON-NLS-1$
	+ MACRO_INSTRUCTION_FACTORY_EXTENSION_POINT + ": " + ce)); //$NON-NLS-1$
	}
	}
	fMacroInstructionIdToFactory = Collections.unmodifiableMap(validMacroInstructionIds);
	}
	return fMacroInstructionIdToFactory;
	}

	@Override
	public boolean isRecording() {
	if (fMacroManager == null) {
	// Avoid creating if possible
	return false;
	}
	return getMacroManager().isRecording();
	}

	@Override
	public boolean isPlayingBack() {
	if (fMacroManager == null) {
	// Avoid creating if possible
	return false;
	}
	return getMacroManager().isPlayingBack();
	}

	@Override
	public void addMacroInstruction(IMacroInstruction macroInstruction) {
	if (isRecording()) {
	try {
	getMacroManager().addMacroInstruction(macroInstruction);
	} catch (CancelMacroRecordingException e) {
	stopMacroRecording();
	}
	}
	}

	@Override
	public void addMacroInstruction(IMacroInstruction macroInstruction, Object event, int priority) {
	if (isRecording()) {
	try {
	getMacroManager().addMacroInstruction(macroInstruction, event, priority);
	} catch (CancelMacroRecordingException e) {
	stopMacroRecording();
	}
	}
	}

	/**
	* Stops the macro recording.
	*/
	private void stopMacroRecording() {
	if (isRecording()) {
	toggleMacroRecord();
	}
	}

	@Override
	public void toggleMacroRecord() {
	loadExtensionPointsmacroStateListeners();
	getMacroManager().toggleMacroRecord(this, getMacroInstructionIdToFactory());
	}

	@Override
	public void playbackLastMacro() throws MacroPlaybackException {
	loadExtensionPointsmacroStateListeners();
	Map<String, IMacroInstructionFactory> macroInstructionIdToFactory = getMacroInstructionIdToFactory();
	IMacroPlaybackContext macroPlaybackContext = new MacroPlaybackContextImpl();
	getMacroManager().playbackLastMacro(this, macroPlaybackContext, macroInstructionIdToFactory);
	}

	@Override
	public void addMacroStateListener(IMacroStateListener listener) {
	getMacroManager().addMacroStateListener(listener);
	}

	@Override
	public void removeMacroStateListener(IMacroStateListener listener) {
	getMacroManager().removeMacroStateListener(listener);
	}

	@Override
	public IMacroRecordContext getMacroRecordContext() {
	return getMacroManager().getMacroRecordContext();
	}

	@Override
	public IMacroPlaybackContext getMacroPlaybackContext() {
	return getMacroManager().getMacroPlaybackContext();
	}

	/**
	* Note that this is only available in this implementation, not on the public
	* API (EMacroService). Needed for testing.
	*
	* @return the currently registered listeners.
	*/
	public IMacroStateListener[] getMacroStateListeners() {
	return getMacroManager().getMacroStateListeners();
	}

	/**
	* A map which maps accepted command ids when recording a macro to whether they
	* should be recorded as a macro instruction to be played back later on.
	*/
	private Map<String, Boolean> fCommandIdToRecordFlag;

	private Map<String, Boolean> getCommandIdToRecordFlag() {
	if (fCommandIdToRecordFlag == null) {
	fCommandIdToRecordFlag = new HashMap<>();
	for (IConfigurationElement ce : fExtensionRegistry
	.getConfigurationElementsFor(MACRO_COMMAND_HANDLING_EXTENSION_POINT)) {
	if (MACRO_COMMAND_HANDLING_ELEMENT.equals(ce.getName())
	&& ce.getAttribute(MACRO_COMMAND_HANDLING_ID) != null
	&& ce.getAttribute(MACRO_COMMAND_HANDLING_RECORDING) != null) {
	Boolean recordMacroInstruction = Boolean
	.parseBoolean(ce.getAttribute(MACRO_COMMAND_HANDLING_RECORDING));
	fCommandIdToRecordFlag.put(ce.getAttribute(MACRO_COMMAND_HANDLING_ID), recordMacroInstruction);
	}
	}
	}
	return fCommandIdToRecordFlag;
	}

	@Override
	public boolean getRecordCommandInMacro(String commandId) {
	Map<String, Boolean> macrocommandHandling = getCommandIdToRecordFlag();
	return macrocommandHandling.getOrDefault(commandId, true);
	}

	@Override
	public void setRecordCommandInMacro(String commandId, boolean recordMacroInstruction) {
	getCommandIdToRecordFlag().put(commandId, recordMacroInstruction);
	}

	@Override
	public void addMacroInstructionsListener(IMacroInstructionsListener macroInstructionsListener) {
	getMacroManager().addMacroInstructionsListener(macroInstructionsListener);
	}

	@Override
	public void removeMacroInstructionsListener(IMacroInstructionsListener macroInstructionsListener) {
	getMacroManager().removeMacroInstructionsListener(macroInstructionsListener);
	}

	}