path: root/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/newui/AbstractExportTab.java

/*******************************************************************************
 * Copyright (c) 2007, 2011 Intel Corporation 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:
 *     Intel Corporation - initial API and implementation
 *     James Blackburn (Broadcom Corp.)
 *******************************************************************************/
package org.eclipse.cdt.ui.newui;

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

import org.eclipse.cdt.core.model.ILanguage;
import org.eclipse.cdt.core.model.LanguageManager;
import org.eclipse.cdt.core.model.util.CDTListComparator;
import org.eclipse.cdt.core.settings.model.ICConfigurationDescription;
import org.eclipse.cdt.core.settings.model.ICExternalSetting;
import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry;
import org.eclipse.cdt.core.settings.model.ICResourceDescription;
import org.eclipse.cdt.core.settings.model.ICSettingEntry;
import org.eclipse.cdt.internal.ui.newui.Messages;
import org.eclipse.cdt.ui.CDTSharedImages;
import org.eclipse.cdt.ui.CUIPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.content.IContentType;
import org.eclipse.core.runtime.content.IContentTypeManager;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jface.viewers.IFontProvider;
import org.eclipse.jface.viewers.IStructuredContentProvider;
import org.eclipse.jface.viewers.ITableLabelProvider;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableColumn;
import org.eclipse.swt.widgets.TableItem;

public abstract class AbstractExportTab extends AbstractCPropertyTab {
	protected Table table;
	protected TableViewer tv;
	protected ICConfigurationDescription cfg;
	protected static final LanguageManager lm = LanguageManager.getInstance();
	protected static final IContentTypeManager ctm = Platform.getContentTypeManager();

	//	protected boolean showBI = false;
	//	boolean  savedShowBI  = false;
	//	List incs;

	public static final Image IMG_FS = CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_FILESYSTEM);
	public static final Image IMG_WS = CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_WORKSPACE);
	public static final Image IMG_MK = CDTSharedImages.getImage(CDTSharedImages.IMG_OBJS_MACRO);
	private static final String ALL = Messages.AbstractExportTab_0;
	private static final String LIST = Messages.AbstractExportTab_1;
	private static Map<String, String> names_l = new HashMap<>();
	private static Map<String, String> names_t = new HashMap<>();
	private static String[] names_ls;
	private static String[] names_ts;
	private List<String> namesList;

	static {
		ILanguage[] ls = lm.getRegisteredLanguages();
		names_ls = new String[ls.length];
		for (int i = 0; i < ls.length; i++) {
			names_l.put(ls[i].getName(), ls[i].getId());
			names_ls[i] = ls[i].getName();
		}
		String[] ids = lm.getRegisteredContentTypeIds();
		names_ts = new String[ids.length];
		for (int i = 0; i < ids.length; i++) {
			IContentType ct = ctm.getContentType(ids[i]);
			names_t.put(ct.getName(), ct.getId());
			names_ts[i] = ct.getName();
		}

	}

	@Override
	public void createControls(Composite parent) {
		super.createControls(parent);
		usercomp.setLayout(new GridLayout(2, false));
		table = new Table(usercomp, SWT.BORDER | SWT.MULTI | SWT.V_SCROLL | SWT.FULL_SELECTION);
		GridData gd = new GridData(GridData.FILL_BOTH);
		gd.minimumWidth = 255;
		table.setLayoutData(gd);
		table.setHeaderVisible(true);
		table.setLinesVisible(true);

		tv = new TableViewer(table);

		tv.setContentProvider(new IStructuredContentProvider() {
			@Override
			public Object[] getElements(Object inputElement) {
				return (Object[]) inputElement;
			}

			@Override
			public void dispose() {
			}

			@Override
			public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {
			}
		});

		tv.setLabelProvider(new RichLabelProvider());

		table.addSelectionListener(new SelectionAdapter() {
			@Override
			public void widgetSelected(SelectionEvent e) {
				updateButtons();
			}

			@Override
			public void widgetDefaultSelected(SelectionEvent e) {
				if (buttonIsEnabled(1) && table.getSelectionIndex() != -1)
					buttonPressed(1);
			}
		});
		TableColumn c = new TableColumn(table, SWT.NONE);
		c.setWidth(hasValues() ? 100 : 200);
		c.setText(Messages.EnvDialog_0);
		c = new TableColumn(table, SWT.NONE);
		c.setWidth(hasValues() ? 100 : 0);
		c.setText(Messages.EnvDialog_1);
		c = new TableColumn(table, SWT.NONE);
		c.setWidth(100);
		c.setText(Messages.LanguagesTab_1);
		c = new TableColumn(table, SWT.NONE);
		c.setWidth(100);
		c.setText(Messages.LanguagesTab_0);

		initButtons(new String[] { ADD_STR, EDIT_STR, DEL_STR });
		updateData(getResDesc());
	}

	/**
	 * Updates state of add/edit/delete buttons
	 * Called when table selection changes.
	 */
	@Override
	protected void updateButtons() {
		int i = table.getSelectionIndex();
		boolean x = i != -1;
		boolean y = x;
		if (x) {
			ICSettingEntry ent = ((ExtData) (table.getItem(i).getData())).entry;
			if (ent.isReadOnly())
				x = false;
			if (ent.isBuiltIn() || ent.isReadOnly())
				y = false;
		}
		buttonSetEnabled(1, x);
		buttonSetEnabled(2, y);
	}

	/*
	 * Methods to be implemented in descendants
	 */
	public abstract int getKind();

	public abstract ICLanguageSettingEntry doAdd(String s1, String s2, boolean isWsp);

	public abstract ICLanguageSettingEntry doEdit(String s1, String s2, boolean isWsp);

	public abstract boolean hasValues();

	/**
	 * Called when item added/edited/removed or Tab is changed.
	 * Refreshes whole table contents
	 */
	protected void update() {
		int x = table.getSelectionIndex();
		if (x == -1)
			x = 0;

		namesList = new ArrayList<>();
		ArrayList<ExtData> lst = new ArrayList<>();
		ICExternalSetting[] vals = cfg.getExternalSettings();
		if (vals == null || vals.length == 0) {
			tv.setInput(null);
			updateButtons();
			return;
		}
		for (ICExternalSetting v : vals) {
			ICSettingEntry[] ents = v.getEntries(getKind());
			if (ents == null || ents.length == 0)
				continue;
			for (ICSettingEntry se : ents) {
				lst.add(new ExtData(v, se));
				namesList.add(se.getName());
			}
		}
		Collections.sort(lst, CDTListComparator.getInstance());
		tv.setInput(lst.toArray(new Object[lst.size()]));
		if (table.getItemCount() > x)
			table.select(x);
		else if (table.getItemCount() > 0)
			table.select(0);
		updateButtons();
	}

	/**
	 * Called when configuration changed
	 * Refreshes languages list and calls table refresh.
	 */
	@Override
	public void updateData(ICResourceDescription rcfg) {
		if (rcfg == null)
			return;
		if (page.isMultiCfg()) {
			setAllVisible(false, null);
		} else {
			if (!usercomp.isVisible())
				setAllVisible(true, null);
			cfg = rcfg.getConfiguration();
			update();
		}
	}

	/**
	 * Unified "Add/Edit/Delete" buttons handler
	 */
	@Override
	public void buttonPressed(int i) {
		ICLanguageSettingEntry[] ent = new ICLanguageSettingEntry[1];
		ExtData old;
		ExpDialog dlg;
		int n = table.getSelectionIndex();

		switch (i) {
		case 0: // add
			dlg = new ExpDialog(usercomp.getShell(), true, Messages.AbstractExportTab_2, EMPTY_STR, EMPTY_STR, cfg,
					null, null, getKind(), names_ls, names_ts, namesList, false);
			if (dlg.open()) {
				ent[0] = doAdd(dlg.text1.trim(), dlg.text2.trim(), dlg.check2);
				if (ent[0] != null)
					if (dlg.check1) { // apply to all ?
						ICConfigurationDescription[] cfgs = page.getCfgsEditable();
						for (ICConfigurationDescription cfg2 : cfgs)
							cfg2.createExternalSetting(name2id(dlg.sel_langs, names_l), name2id(dlg.sel_types, names_t),
									null, ent);
					} else {
						cfg.createExternalSetting(name2id(dlg.sel_langs, names_l), name2id(dlg.sel_types, names_t),
								null, ent);
					}
				update();
			}
			break;
		case 1: // edit
			if (n == -1)
				return;
			old = (ExtData) (table.getItem(n).getData());
			if (old.entry.isReadOnly())
				return;
			String s1, s2;
			if (getKind() == ICSettingEntry.MACRO) {
				s1 = old.getName();
				s2 = old.getValue();
			} else
				s1 = s2 = old.getName();
			boolean isWsp = (old.entry.getFlags() & ICSettingEntry.VALUE_WORKSPACE_PATH) != 0;
			dlg = new ExpDialog(usercomp.getShell(), false, Messages.AbstractExportTab_3, s1, s2, cfg,
					id2name(old.setting.getCompatibleLanguageIds(), names_l),
					id2name(old.setting.getCompatibleContentTypeIds(), names_t), getKind(), names_ls, names_ts, null,
					isWsp);
			if (dlg.open()) {
				ent[0] = doEdit(dlg.text1.trim(), dlg.text2.trim(), dlg.check2);
				ICSettingEntry[] ls = old.setting.getEntries();
				ICSettingEntry[] ls2 = new ICLanguageSettingEntry[ls.length];
				for (int x = 0; x < ls.length; x++)
					if (ls[x].equals(old.entry))
						ls2[x] = ent[0];
					else
						ls2[x] = ls[x];
				cfg.removeExternalSetting(old.setting);
				cfg.createExternalSetting(name2id(dlg.sel_langs, names_l), name2id(dlg.sel_types, names_t), null, ls2);
				update();
			}
			break;
		case 2: // delete
			if (n == -1)
				return;
			TableItem[] its = table.getSelection();
			boolean checked[] = new boolean[its.length];
			for (int t = 0; t < its.length; t++) {
				if (checked[t] || its[t] == null)
					continue;
				old = (ExtData) (its[t].getData());
				if (old.entry.isReadOnly() || old.entry.isBuiltIn())
					continue;
				ICSettingEntry[] ls = old.setting.getEntries(getKind());
				ArrayList<ICSettingEntry> lst = new ArrayList<>();
				outer: for (ICSettingEntry se : ls) {
					for (int y = t; y < its.length; y++) {
						if (its[y] == null)
							break;
						Object ob = its[y].getData();
						if (ob != null && (ob instanceof ExtData)) {
							ExtData ex = (ExtData) ob;
							if (se.equals(ex.entry)) {
								checked[y] = true;
								continue outer;
							}
						}
					}
					lst.add(se);
				}
				// Ensure we don't lose external settings we know nothing about
				for (ICSettingEntry e : old.setting.getEntries())
					if (e.getKind() != getKind())
						lst.add(e);
				// Remove and re-add the particular setting entry
				cfg.removeExternalSetting(old.setting);
				cfg.createExternalSetting(old.setting.getCompatibleLanguageIds(),
						old.setting.getCompatibleContentTypeIds(), old.setting.getCompatibleExtensions(),
						lst.toArray(new ICSettingEntry[lst.size()]));
			}
			update();
			break;

		default:
			break;
		}
	}

	public static String[] name2id(String[] ein, Map<String, String> names) {
		if (ein != null)
			for (int k = 0; k < ein.length; k++)
				ein[k] = names.get(ein[k]);
		return ein;
	}

	public static String[] id2name(String[] ein, Map<String, String> names) {
		if (ein != null)
			for (int i = 0; i < ein.length; i++) {
				Iterator<String> it = names.keySet().iterator();
				while (it.hasNext()) {
					String s = it.next();
					if (ein[i].equals(names.get(s))) {
						ein[i] = s;
						break;
					}
				}
			}
		return ein;
	}

	@Override
	protected void performApply(ICResourceDescription src, ICResourceDescription dst) {
		ICConfigurationDescription c1 = src.getConfiguration();
		ICConfigurationDescription c2 = dst.getConfiguration();
		c2.removeExternalSettings();
		ICExternalSetting[] v = c1.getExternalSettings();
		for (ICExternalSetting element : v)
			c2.createExternalSetting(element.getCompatibleLanguageIds(), element.getCompatibleContentTypeIds(),
					element.getCompatibleExtensions(), element.getEntries());
	}

	@Override
	protected void performDefaults() {
		cfg.removeExternalSettings();
		// Bug 295602 Add any resources which are exported by 'default' in this configuration
		// There's no hook on the Build system to do this, but
		//            setSourceEntries -> ... -> Configuration#setSourceEntries(...) -> Configuration#exportArtifactInfo()
		try {
			cfg.setSourceEntries(cfg.getSourceEntries());
		} catch (CoreException e) {
			CUIPlugin.log(e);
		}
		updateData(this.getResDesc());
	}

	// Extended label provider
	private class RichLabelProvider extends LabelProvider
			implements IFontProvider, ITableLabelProvider /*, IColorProvider*/ {
		public RichLabelProvider() {
		}

		@Override
		public Image getImage(Object element) {
			return getColumnImage(element, 0);
		}

		@Override
		public Image getColumnImage(Object element, int columnIndex) {
			if (columnIndex > 0)
				return null;
			ExtData data = (ExtData) element;
			if (data.entry.getKind() == ICSettingEntry.MACRO)
				return IMG_MK;
			if ((data.entry.getFlags() & ICSettingEntry.VALUE_WORKSPACE_PATH) != 0)
				return IMG_WS;
			return IMG_FS;
		}

		@Override
		public String getText(Object element) {
			return getColumnText(element, 0);
		}

		@Override
		public String getColumnText(Object element, int columnIndex) {
			ExtData data = (ExtData) element;
			switch (columnIndex) {
			case 0:
				return data.getName();
			case 1:
				return data.getValue();
			case 2:
				return data.getLangStr();
			case 3:
				return data.getTypeStr();
			default:
				return EMPTY_STR;
			}
		}

		@Override
		public Font getFont(Object element) {
			ExtData data = (ExtData) element;
			if (data.entry.isBuiltIn())
				return null; // built in
			if (data.entry.isReadOnly()) // read only
				return JFaceResources.getFontRegistry().getItalic(JFaceResources.DIALOG_FONT);
			return JFaceResources.getFontRegistry().getBold(JFaceResources.DIALOG_FONT);
		}
	}

	@Override
	public boolean canBeVisible() {
		if (!page.isForProject())
			return false;
		return true;
	}

	/**
	 *
	 */
	static class ExtData {
		ICExternalSetting setting;
		ICSettingEntry entry;

		ExtData(ICExternalSetting _s, ICSettingEntry _e) {
			setting = _s;
			entry = _e;
		}

		protected String getName() {
			return entry.getName();
		}

		protected String getValue() {
			if (entry.getKind() == ICSettingEntry.MACRO)
				return entry.getValue();
			return EMPTY_STR;
		}

		protected String getLangStr() {
			return getLabel(setting.getCompatibleLanguageIds(), names_l);
		}

		protected String getTypeStr() {
			return getLabel(setting.getCompatibleContentTypeIds(), names_t);
		}

		@Override
		public String toString() {
			return getName();
		}
	}

	static protected String getLabel(String[] lst, Map<String, String> names) {
		if (lst == null || lst.length == 0)
			return ALL;
		if (lst.length > 1)
			return LIST;
		Iterator<String> it = names.keySet().iterator();
		while (it.hasNext()) {
			String s = it.next();
			if (names.get(s).equals(lst[0]))
				return s;
		}
		return lst[0];
	}

	static protected String getList(String[] lst) {
		String s = EMPTY_STR;
		for (String element : lst)
			s = s + element + '\n';
		return s;
	}

	static public Image getWspImage(boolean isWsp) {
		return isWsp ? AbstractExportTab.IMG_WS : AbstractExportTab.IMG_FS;
	}

}