docmlet/org.eclipse.statet.docmlet.base.ui/src/org/eclipse/statet/docmlet/base/ui/processing/DocProcessingConfigMainTab.java

/*=============================================================================#
 # Copyright (c) 2015, 2019 Stephan Wahlbrink and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 # which is available at https://www.apache.org/licenses/LICENSE-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 # 
 # Contributors:
 #     Stephan Wahlbrink <sw@wahlbrink.eu> - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.docmlet.base.ui.processing;

import static org.eclipse.statet.docmlet.base.ui.processing.DocProcessingConfig.WORKING_DIRECTORY_ATTR_NAME;
import static org.eclipse.statet.ecommons.databinding.core.observable.ObservableUtils.typed;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.eclipse.core.databinding.DataBindingContext;
import org.eclipse.core.databinding.UpdateValueStrategy;
import org.eclipse.core.databinding.observable.Realm;
import org.eclipse.core.databinding.observable.value.IObservableValue;
import org.eclipse.core.databinding.observable.value.IValueChangeListener;
import org.eclipse.core.databinding.observable.value.ValueChangeEvent;
import org.eclipse.core.databinding.observable.value.WritableValue;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.variables.IStringVariable;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
import org.eclipse.debug.ui.ILaunchConfigurationDialog;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.PaintEvent;
import org.eclipse.swt.events.PaintListener;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;

import org.eclipse.statet.jcommons.lang.NonNullByDefault;
import org.eclipse.statet.jcommons.lang.Nullable;

import org.eclipse.statet.ecommons.databinding.core.observable.WritableEqualityValue;
import org.eclipse.statet.ecommons.databinding.core.validation.UpdateableErrorValidator;
import org.eclipse.statet.ecommons.debug.ui.config.LaunchConfigPresets;
import org.eclipse.statet.ecommons.debug.ui.config.LaunchConfigTabWithPresets;
import org.eclipse.statet.ecommons.resources.core.variables.ResourceVariableResolver;
import org.eclipse.statet.ecommons.resources.core.variables.ResourceVariables;
import org.eclipse.statet.ecommons.ui.util.LayoutUtils;
import org.eclipse.statet.ecommons.ui.util.MessageUtils;
import org.eclipse.statet.ecommons.ui.util.UIAccess;
import org.eclipse.statet.ecommons.ui.util.VariableFilterUtils;
import org.eclipse.statet.ecommons.ui.workbench.ResourceInputComposite;
import org.eclipse.statet.ecommons.ui.workbench.workspace.ResourceVariableUtil;
import org.eclipse.statet.ecommons.variables.core.ObservableValueVariable;
import org.eclipse.statet.ecommons.variables.core.VariableText2;
import org.eclipse.statet.ecommons.variables.core.VariableUtils;

import org.eclipse.statet.internal.docmlet.base.ui.processing.Messages;


@NonNullByDefault
public class DocProcessingConfigMainTab extends LaunchConfigTabWithPresets
		implements IValueChangeListener<Object> {
	
	
	private static final String WORKING_DIRECTORY_DEFAULT_VALUE=
			"${" + ResourceVariables.CONTAINER_PATH_VAR_NAME + "}"; //$NON-NLS-1$ //$NON-NLS-2$
	
	
	private class StepItem implements DocProcessingConfigStepTab.Listener {
		
		private final DocProcessingConfigStepTab tab;
		
		private Button enabledControl;
		private Label infoControl;
		
		
		public StepItem(final DocProcessingConfigStepTab tab) {
			this.tab= tab;
			
			tab.addListener(this);
		}
		
		
		private void updateInfo() {
			if (!UIAccess.isOkToUse(getControl())) {
				return;
			}
			this.enabledControl.setSelection(this.tab.isEnabled());
			this.infoControl.setText(this.tab.getInfo());
		}
		
		@Override
		public void changed(final DocProcessingConfigStepTab source) {
			updateInfo();
		}
		
	}
	
	
	private final List<StepItem> stepItems;
	
	private final IObservableValue<String> workingDirectoryValue;
	
	private final ResourceVariableUtil resolvedSourceFileVariableUtil;
	private final Map<String, IStringVariable> resolvedSourceFileVariables= new HashMap<>();
	private IObservableValue<@Nullable IResource> resolvedWorkingDirectoryResourceValue;
	private final ObservableValueVariable<@Nullable String> resolvedWorkingDirectoryPathVariable;
	
	private ResourceInputComposite workingDirectoryControl;
	
	
	public DocProcessingConfigMainTab(final LaunchConfigPresets presets) {
		this.stepItems= new ArrayList<>();
		
		final Realm realm= getRealm();
		this.workingDirectoryValue= new WritableValue<>(realm, null, String.class);
		
		setPresets(presets);
		
		this.resolvedSourceFileVariableUtil= new ResourceVariableUtil() {
			@Override
			protected @Nullable IResource fetchResource() {
				final IResource resource= super.fetchResource();
				return (resource instanceof IFile) ? resource : null;
			}
		};
		
		this.resolvedWorkingDirectoryPathVariable= new ObservableValueVariable<>(
				DocProcessingConfig.WD_PATH_VAR_NAME, null,
				new WritableEqualityValue<>(realm, null, String.class) );
	}
	
	
	int addStep(final DocProcessingConfigStepTab stepTab) {
		final StepItem item= new StepItem(stepTab);
		this.stepItems.add(item);
		return this.stepItems.size(); // 1-based
	}
	
	protected DocProcessingConfigStepTab getStepTab(final int num) {
		return this.stepItems.get(num - 1).tab;
	}
	
	
	@Override
	public String getName() {
		return Messages.MainTab_name;
	}
	
	
	@Override
	public void setLaunchConfigurationDialog(final ILaunchConfigurationDialog dialog) {
		super.setLaunchConfigurationDialog(dialog);
		
		initVariables(this.resolvedSourceFileVariables);
	}
	
	protected void initVariables(final Map<String, IStringVariable> variables) {
		VariableUtils.add(variables,
				ResourceVariables.getSingleResourceVariables(),
				new ResourceVariableResolver(this.resolvedSourceFileVariableUtil) );
		VariableUtils.add(variables,
				VariableUtils.toStaticVariable(DocProcessingConfig.SOURCE_FILE_PATH_VAR,
						VariableUtils.getChecked(variables, ResourceVariables.RESOURCE_PATH_VAR_NAME) ));
	}
	
	public @Nullable IFile getSourceFile() {
		return (IFile)this.resolvedSourceFileVariableUtil.getResource();
	}
	
	public ResourceVariableUtil getSourceFileVariableUtil() {
		return this.resolvedSourceFileVariableUtil;
	}
	
	public Map<String, IStringVariable> getSourceFileVariables() {
		return this.resolvedSourceFileVariables;
	}
	
	public ObservableValueVariable<@Nullable String> getWorkingDirectoryPathVariable() {
		return this.resolvedWorkingDirectoryPathVariable;
	}
	
	@Override
	public void handleValueChange(final ValueChangeEvent<?> event) {
		if (event.getObservable() == this.resolvedWorkingDirectoryResourceValue) {
			final IResource resource= typed(event, this.resolvedWorkingDirectoryResourceValue)
					.diff.getNewValue();
			this.resolvedWorkingDirectoryPathVariable.getObservable().setValue(
					(resource != null) ? resource.getFullPath().toString() : null );
			return;
		}
	}
	
	
	@Override
	public void createControl(final Composite parent) {
		final Composite mainComposite= new Composite(parent, SWT.NONE);
		setControl(mainComposite);
		mainComposite.setLayout(LayoutUtils.newTabGrid(1));
		
		addPresetsButton(mainComposite);
		
		{	final Composite composite= createOverviewGroup(mainComposite);
			composite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
		}
		{	final Composite composite= createWorkingDirectoryGroup(mainComposite);
			composite.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, false));
		}
		
		Dialog.applyDialogFont(parent);
		
		initBindings();
	}
	
	protected Composite createOverviewGroup(final Composite parent) {
		final Group group= new Group(parent, SWT.NONE);
		group.setLayout(LayoutUtils.newGroupGrid(3));
		group.setText(Messages.MainTab_Overview_label);
		
		{	final Label label= new Label(group, SWT.NONE);
			label.setText(Messages.MainTab_Overview_Step_header);
			label.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false, false));
		}
		{	final Label label= new Label(group, SWT.NONE);
			label.setText(Messages.MainTab_Overview_Run_header);
			label.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false, false));
		}
		{	final Label label= new Label(group, SWT.NONE);
			label.setText(Messages.MainTab_Overview_Detail_header);
			label.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, false, false));
		}
		{	final Label filler= new Label(group, SWT.NONE);
			filler.addPaintListener(new PaintListener() {
				@Override
				public void paintControl(final PaintEvent e) {
					final GC gc= e.gc;
					gc.setForeground(gc.getDevice().getSystemColor(SWT.COLOR_WIDGET_LIGHT_SHADOW));
					gc.drawLine(e.x, 0, e.width, 0);
				}
			});
			final GridData gd= new GridData(SWT.FILL, SWT.FILL, false, false);
			gd.horizontalSpan= 3;
			gd.heightHint= LayoutUtils.defaultVSpacing() / 2;
			filler.setLayoutData(gd);
		}
		
		for (final StepItem stepItem : this.stepItems) {
			final Label label= new Label(group, SWT.NONE);
			label.setText(stepItem.tab.getNum() + ")\u2002" + stepItem.tab.getLabel()); //$NON-NLS-1$
			label.setLayoutData(new GridData(SWT.FILL, SWT.TOP, false, false));
			
			final Button button= new Button(group, SWT.CHECK);
			button.setEnabled(false);
			button.setLayoutData(new GridData(SWT.CENTER, SWT.TOP, false, false));
			stepItem.enabledControl= button;
			
			final Label info= new Label(group, SWT.NONE);
			info.setLayoutData(new GridData(SWT.FILL, SWT.TOP, true, false));
			stepItem.infoControl= info;
			
			stepItem.updateInfo();
			
			LayoutUtils.addSmallFiller(group, false);
		}
		
		return group;
	}
	
	protected Composite createWorkingDirectoryGroup(final Composite parent) {
		final ResourceInputComposite pathInput= new ResourceInputComposite(parent,
				ResourceInputComposite.STYLE_GROUP | ResourceInputComposite.STYLE_TEXT,
				ResourceInputComposite.MODE_DIRECTORY | ResourceInputComposite.MODE_OPEN | ResourceInputComposite.MODE_WS_ONLY,
				Messages.MainTab_WorkingDir_label + " (workspace path)");
		pathInput.getValidator().setResourceLabel(
				MessageUtils.removeMnemonics(Messages.MainTab_WorkingDir_label) );
		pathInput.setShowInsertVariable(true, VariableFilterUtils.DEFAULT_INTERACTIVE_RESOURCE_FILTERS, null);
		
		final Map<String, IStringVariable> variables= new HashMap<>();
		variables.putAll(getSourceFileVariables());
		pathInput.getValidator().setVariableResolver(new VariableText2(variables));
		this.workingDirectoryControl= pathInput;
		
		this.resolvedWorkingDirectoryResourceValue= pathInput.getValidator().getWorkspaceResourceObservable();
		this.resolvedWorkingDirectoryResourceValue.addValueChangeListener(this);
		
		return pathInput;
	}
	
	
	@Override
	public void setDefaults(final ILaunchConfigurationWorkingCopy configuration) {
		configuration.setAttribute(WORKING_DIRECTORY_ATTR_NAME, WORKING_DIRECTORY_DEFAULT_VALUE);
	}
	
	@Override
	protected void addBindings(final DataBindingContext dbc) {
		dbc.bindValue(
				this.workingDirectoryControl.getObservable(),
				this.workingDirectoryValue,
				new UpdateValueStrategy<String, String>()
						.setAfterGetValidator(new UpdateableErrorValidator<>(
								this.workingDirectoryControl.getValidator() )),
				null );
	}
	
	@Override
	protected void doInitialize(final ILaunchConfiguration configuration) {
		this.workingDirectoryValue.setValue(readAttribute(configuration,
				WORKING_DIRECTORY_ATTR_NAME,
				WORKING_DIRECTORY_DEFAULT_VALUE ));
	}
	
	@Override
	protected void doSave(final ILaunchConfigurationWorkingCopy configuration) {
		configuration.setAttribute(WORKING_DIRECTORY_ATTR_NAME,
				this.workingDirectoryValue.getValue() );
	}
	
}