dsf-gdb/org.eclipse.cdt.dsf.gdb.ui/src/org/eclipse/cdt/dsf/gdb/internal/ui/breakpoints/ToggleDynamicPrintfTargetFactory.java

/*******************************************************************************
 * Copyright (c) 2014 Ericsson and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Marc Khouzam (Ericsson) - initial API and implementation
 *******************************************************************************/
package org.eclipse.cdt.dsf.gdb.internal.ui.breakpoints;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import org.eclipse.cdt.debug.ui.CDebugUIPlugin;
import org.eclipse.cdt.dsf.debug.internal.ui.disassembly.provisional.IDisassemblyPart;
import org.eclipse.debug.ui.actions.IToggleBreakpointsTarget;
import org.eclipse.debug.ui.actions.IToggleBreakpointsTargetFactory;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.ui.IWorkbenchPart;

/**
 * Toggle DynamicPrintf target factory for disassembly parts.
 * We use a separate factory because the tracepoint factory is controlled
 * through an action set, while the breakpoint factory is down in DSF (not DSF-GDB).
 *
 * @since 2.4
 */
public class ToggleDynamicPrintfTargetFactory implements IToggleBreakpointsTargetFactory {

	/**
	 * Toggle DynamicPrintf target-id for normal C DynamicPrintf.
	 * Note: The id must be the same as in <code>ToggleCDynamicPrintfTargetFactory</code>
	 *       which is used for the editor.  We need the id to be the same so that when
	 *       the user goes from editor to DSF disassembly view, the choice of breakpoint
	 *       targets looks the same and is remembered.
	 *       To use the same id though, we must be careful not to have the two factories
	 *       return the same id for the same part, or else it may confuse things.
	 *       This is why this factory only returns this id for the DSF disassembly part,
	 *       leaving <code>ToggleCDynamicPrintfTargetFactory</code> to return the same id
	 *       for the editor.
	 */
	public static final String TOGGLE_C_DYNAMICPRINTF_TARGET_ID = CDebugUIPlugin.PLUGIN_ID
			+ ".toggleCDynamicPrintfTarget"; //$NON-NLS-1$

	private static final Set<String> TOGGLE_TARGET_IDS_ALL = new HashSet<>(1);
	static {
		TOGGLE_TARGET_IDS_ALL.add(TOGGLE_C_DYNAMICPRINTF_TARGET_ID);
	}

	private static final IToggleBreakpointsTarget fgDisassemblyToggleDynamicPrintfTarget = new DisassemblyToggleDynamicPrintfTarget();

	public ToggleDynamicPrintfTargetFactory() {
	}

	@Override
	public IToggleBreakpointsTarget createToggleTarget(String targetID) {
		if (TOGGLE_C_DYNAMICPRINTF_TARGET_ID.equals(targetID)) {
			return fgDisassemblyToggleDynamicPrintfTarget;
		}
		return null;
	}

	@Override
	public String getDefaultToggleTarget(IWorkbenchPart part, ISelection selection) {
		return null;
	}

	@Override
	public String getToggleTargetDescription(String targetID) {
		if (TOGGLE_C_DYNAMICPRINTF_TARGET_ID.equals(targetID)) {
			return Messages.ToggleDynamicPrintfTargetFactory_description;
		}
		return null;
	}

	@Override
	public String getToggleTargetName(String targetID) {
		if (TOGGLE_C_DYNAMICPRINTF_TARGET_ID.equals(targetID)) {
			return Messages.ToggleDynamicPrintfTargetFactory_name;
		}
		return null;
	}

	@Override
	public Set<String> getToggleTargets(IWorkbenchPart part, ISelection selection) {
		if (part instanceof IDisassemblyPart) {
			return TOGGLE_TARGET_IDS_ALL;
		}
		return Collections.emptySet();
	}

}