settingsEditor2.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import * as DOM from 'vs/base/browser/dom';
import { Button } from 'vs/base/browser/ui/button/button';
import { InputBox } from 'vs/base/browser/ui/inputbox/inputBox';
import { IDelegate, IRenderer } from 'vs/base/browser/ui/list/list';
import { List } from 'vs/base/browser/ui/list/listWidget';
import { SelectBox } from 'vs/base/browser/ui/selectBox/selectBox';
import { IAction } from 'vs/base/common/actions';
import * as arrays from 'vs/base/common/arrays';
import { Delayer, ThrottledDelayer } from 'vs/base/common/async';
import { Color } from 'vs/base/common/color';
import { getErrorMessage, isPromiseCanceledError } from 'vs/base/common/errors';
import { Emitter, Event } from 'vs/base/common/event';
import { IDisposable, dispose } from 'vs/base/common/lifecycle';
import * as objects from 'vs/base/common/objects';
import { TPromise } from 'vs/base/common/winjs.base';
import 'vs/css!./media/settingsEditor2';
import { localize } from 'vs/nls';
import { ConfigurationTarget, IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { IContextKey } from 'vs/platform/contextkey/common/contextkey';
import { IContextMenuService, IContextViewService } from 'vs/platform/contextview/browser/contextView';
import { IEditor } from 'vs/platform/editor/common/editor';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { WorkbenchList } from 'vs/platform/list/browser/listService';
import { ILogService } from 'vs/platform/log/common/log';
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
import { registerColor } from 'vs/platform/theme/common/colorRegistry';
import { attachButtonStyler, attachInputBoxStyler, attachSelectBoxStyler } from 'vs/platform/theme/common/styler';
import { IThemeService, registerThemingParticipant, ICssStyleCollector, ITheme } from 'vs/platform/theme/common/themeService';
import { BaseEditor } from 'vs/workbench/browser/parts/editor/baseEditor';
import { EditorOptions } from 'vs/workbench/common/editor';
import { SearchWidget, SettingsTarget, SettingsTargetsWidget } from 'vs/workbench/parts/preferences/browser/preferencesWidgets';
import { IPreferencesService, ISearchResult, ISetting, ISettingsEditorModel } from 'vs/workbench/services/preferences/common/preferences';
import { SettingsEditor2Input } from 'vs/workbench/services/preferences/common/preferencesEditorInput';
import { DefaultSettingsEditorModel } from 'vs/workbench/services/preferences/common/preferencesModels';
import { IPreferencesSearchService, ISearchProvider } from 'vs/workbench/parts/preferences/common/preferences';
import { KeyCode } from 'vs/base/common/keyCodes';

const SETTINGS_ENTRY_TEMPLATE_ID = 'settings.entry.template';
const SETTINGS_GROUP_ENTRY_TEMPLATE_ID = 'settings.group.template';
const BUTTON_ROW_ENTRY_TEMPLATE = 'settings.buttonRow.template';

const ALL_SETTINGS_BUTTON_ID = 'allSettings';

interface IListEntry {
	id: string;
	templateId: string;
}

interface ISettingItemEntry extends IListEntry {
	templateId: typeof SETTINGS_ENTRY_TEMPLATE_ID;
	key: string;
	value: any;
	isConfigured: boolean;
	description: string;
	overriddenScopeList: string[];
	isExpanded: boolean;
	isExpandable?: boolean;
	isFocused?: boolean;
	type?: string | string[];
	enum?: string[];
}

enum ExpandState {
	Expanded,
	Collapsed,
	NA
}

interface IGroupTitleEntry extends IListEntry {
	templateId: typeof SETTINGS_GROUP_ENTRY_TEMPLATE_ID;
	title: string;
	expandState: ExpandState;
}

interface IButtonRowEntry extends IListEntry {
	templateId: typeof BUTTON_ROW_ENTRY_TEMPLATE;
	label: string;
}

type ListEntry = ISettingItemEntry | IGroupTitleEntry | IButtonRowEntry;

enum SearchResultIdx {
	Local = 0,
	Remote = 1
}

const $ = DOM.$;

export const modifiedItemForeground = registerColor('settings.modifiedItemForeground', {
	light: '#019001',
	dark: '#73C991',
	hc: '#73C991'
}, localize('modifiedItemForeground', "The foreground color for a modified setting."));

export class SettingsEditor2 extends BaseEditor {

	public static readonly ID: string = 'workbench.editor.settings2';

	private defaultSettingsEditorModel: DefaultSettingsEditorModel;

	private headerContainer: HTMLElement;
	private searchWidget: SearchWidget;
	private settingsTargetsWidget: SettingsTargetsWidget;

	private showConfiguredSettingsOnlyCheckbox: HTMLInputElement;

	private settingsListContainer: HTMLElement;
	private settingsList: List<ListEntry>;

	private dimension: DOM.Dimension;
	private searchFocusContextKey: IContextKey<boolean>;

	private delayedModifyLogging: Delayer<void>;
	private delayedFilterLogging: Delayer<void>;
	private localSearchDelayer: Delayer<void>;
	private remoteSearchThrottle: ThrottledDelayer<void>;

	private currentLocalSearchProvider: ISearchProvider;
	private currentRemoteSearchProvider: ISearchProvider;

	private pendingSettingModifiedReport: { key: string, value: any };

	// <TODO@roblou> factor out tree/list viewmodel to somewhere outside this class
	private searchResultModel: SearchResultModel;
	private groupExpanded = new Map<string, boolean>();
	private itemExpanded = new Map<string, boolean>();
	private showConfiguredSettingsOnly = false;
	private showAllSettings = false;
	private inRender = false;
	// </TODO>

	constructor(
		@ITelemetryService telemetryService: ITelemetryService,
		@IConfigurationService private configurationService: IConfigurationService,
		@IThemeService themeService: IThemeService,
		@IContextMenuService contextMenuService: IContextMenuService,
		@IPreferencesService private preferencesService: IPreferencesService,
		@IInstantiationService private instantiationService: IInstantiationService,
		@IPreferencesSearchService private preferencesSearchService: IPreferencesSearchService,
		@ILogService private logService: ILogService
	) {
		super(SettingsEditor2.ID, telemetryService, themeService);
		this.delayedModifyLogging = new Delayer<void>(1000);
		this.delayedFilterLogging = new Delayer<void>(1000);
		this.localSearchDelayer = new Delayer(100);
		this.remoteSearchThrottle = new ThrottledDelayer(200);
		this.searchResultModel = new SearchResultModel();

		this._register(configurationService.onDidChangeConfiguration(() => this.renderEntries()));
	}

	createEditor(parent: HTMLElement): void {
		const prefsEditorElement = DOM.append(parent, $('div', { class: 'settings-editor' }));

		this.createHeader(prefsEditorElement);
		this.createBody(prefsEditorElement);
	}

	setInput(input: SettingsEditor2Input, options: EditorOptions): TPromise<void> {
		const oldInput = this.input;
		return super.setInput(input)
			.then(() => {
				if (!input.matches(oldInput)) {
					this.render();
				}
			});
	}

	clearInput(): void {
		super.clearInput();
	}

	layout(dimension: DOM.Dimension): void {
		this.dimension = dimension;
		this.searchWidget.layout(dimension);

		this.layoutSettingsList();
		this.render();
	}

	focus(): void {
		this.searchWidget.focus();
	}

	getSecondaryActions(): IAction[] {
		return <IAction[]>[
		];
	}

	search(filter: string): void {
		this.searchWidget.focus();
	}

	clearSearchResults(): void {
		this.searchWidget.clear();
	}

	private createHeader(parent: HTMLElement): void {
		this.headerContainer = DOM.append(parent, $('.settings-header'));

		const previewHeader = DOM.append(this.headerContainer, $('.settings-preview-header'));

		const previewAlert = DOM.append(previewHeader, $('span.settings-preview-warning'));
		previewAlert.textContent = localize('previewWarning', "Preview");

		const previewTextLabel = DOM.append(previewHeader, $('span.settings-preview-label'));
		previewTextLabel.textContent = localize('previewLabel', "This is a preview of our new settings editor. You can also ");
		const openSettingsButton = this._register(new Button(previewHeader, { title: true, buttonBackground: null, buttonHoverBackground: null }));
		this._register(attachButtonStyler(openSettingsButton, this.themeService, {
			buttonBackground: Color.transparent.toString(),
			buttonHoverBackground: Color.transparent.toString(),
			buttonForeground: 'foreground'
		}));
		openSettingsButton.label = localize('openSettingsLabel', "open the original editor.");
		openSettingsButton.element.classList.add('open-settings-button');

		this._register(openSettingsButton.onDidClick(() => this.openSettingsFile()));

		const searchContainer = DOM.append(this.headerContainer, $('.search-container'));
		this.searchWidget = this._register(this.instantiationService.createInstance(SearchWidget, searchContainer, {
			ariaLabel: localize('SearchSettings.AriaLabel', "Search settings"),
			placeholder: localize('SearchSettings.Placeholder', "Search settings"),
			focusKey: this.searchFocusContextKey
		}));
		this._register(this.searchWidget.onDidChange(() => this.onInputChanged()));
		this._register(DOM.addStandardDisposableListener(this.searchWidget.domNode, 'keydown', e => {
			if (e.keyCode === KeyCode.DownArrow) {
				this.settingsList.focusFirst();
				this.settingsList.domFocus();
			}
		}));

		const headerControlsContainer = DOM.append(this.headerContainer, $('.settings-header-controls'));
		const targetWidgetContainer = DOM.append(headerControlsContainer, $('.settings-target-container'));
		this.settingsTargetsWidget = this._register(this.instantiationService.createInstance(SettingsTargetsWidget, targetWidgetContainer));
		this.settingsTargetsWidget.settingsTarget = ConfigurationTarget.USER;
		this.settingsTargetsWidget.onDidTargetChange(e => this.renderEntries());

		this.createHeaderControls(headerControlsContainer);
	}

	private createHeaderControls(parent: HTMLElement): void {
		const headerControlsContainerRight = DOM.append(parent, $('.settings-header-controls-right'));

		this.showConfiguredSettingsOnlyCheckbox = DOM.append(headerControlsContainerRight, $('input#configured-only-checkbox'));
		this.showConfiguredSettingsOnlyCheckbox.type = 'checkbox';
		const showConfiguredSettingsOnlyLabel = <HTMLLabelElement>DOM.append(headerControlsContainerRight, $('label.configured-only-label'));
		showConfiguredSettingsOnlyLabel.textContent = localize('showOverriddenOnly', "Show modified only");
		showConfiguredSettingsOnlyLabel.htmlFor = 'configured-only-checkbox';

		this._register(DOM.addDisposableListener(this.showConfiguredSettingsOnlyCheckbox, 'change', e => this.onShowConfiguredOnlyClicked()));
	}

	private openSettingsFile(): TPromise<IEditor> {
		const currentSettingsTarget = this.settingsTargetsWidget.settingsTarget;

		if (currentSettingsTarget === ConfigurationTarget.USER) {
			return this.preferencesService.openGlobalSettings();
		} else if (currentSettingsTarget === ConfigurationTarget.WORKSPACE) {
			return this.preferencesService.openWorkspaceSettings();
		} else {
			return this.preferencesService.openFolderSettings(currentSettingsTarget);
		}
	}

	private createBody(parent: HTMLElement): void {
		const bodyContainer = DOM.append(parent, $('.settings-body'));

		this.createList(bodyContainer);
	}

	private createList(parent: HTMLElement): void {
		this.settingsListContainer = DOM.append(parent, $('.settings-list-container'));

		const settingItemRenderer = this.instantiationService.createInstance(SettingItemRenderer, this.settingsListContainer);
		this._register(settingItemRenderer.onDidChangeSetting(e => this.onDidChangeSetting(e.key, e.value)));
		this._register(settingItemRenderer.onDidOpenSettings(() => this.openSettingsFile()));
		this._register(settingItemRenderer.onDidToggleExpandSetting(e => this.toggleSettingExpanded(e)));

		const buttonItemRenderer = new ButtonRowRenderer();
		this._register(buttonItemRenderer.onDidClick(e => this.onShowAllSettingsToggled()));

		const groupTitleRenderer = new GroupTitleRenderer();
		this._register(groupTitleRenderer.onDidClickGroup(id => this.toggleGroupExpanded(id)));

		this.settingsList = this._register(this.instantiationService.createInstance(
			WorkbenchList,
			this.settingsListContainer,
			new SettingItemDelegate(this.settingsListContainer),
			[settingItemRenderer, groupTitleRenderer, buttonItemRenderer],
			{
				identityProvider: e => e.id,
				ariaLabel: localize('settingsListLabel', "Settings")
			})
		) as WorkbenchList<ListEntry>;

		this._register(this.settingsList.onDidFocus(() => {
			DOM.addClass(this.settingsList.getHTMLElement(), 'focused');
		}));
		this._register(this.settingsList.onDidBlur(() => {
			DOM.removeClass(this.settingsList.getHTMLElement(), 'focused');
		}));

		this.settingsList.onOpen(e => {
			const entry = e.elements[0];
			if (!entry) {
				return;
			}

			if (entry.templateId === SETTINGS_GROUP_ENTRY_TEMPLATE_ID) {
				this.toggleGroupExpanded(entry.id);
			} else if (entry.templateId === SETTINGS_ENTRY_TEMPLATE_ID) {
				this.toggleSettingExpanded(entry);
			} else if (entry.templateId === BUTTON_ROW_ENTRY_TEMPLATE) {
				this.onShowAllSettingsToggled();
			}
		});

		this._register(this.settingsList.onFocusChange(e => {
			if (!this.inRender) {
				this.renderEntries();
			}
		}));
	}

	private toggleGroupExpanded(id: string): void {
		const isExpanded = !!this.groupExpanded.get(id);
		this.groupExpanded.set(id, !isExpanded);
		this.renderEntries();
	}

	private toggleSettingExpanded(entry: ISettingItemEntry): void {
		if (entry.isExpandable) {
			this.itemExpanded.set(entry.key, !entry.isExpanded);
			this.renderEntries();
		}
	}

	private onShowAllSettingsToggled(): void {
		this.showAllSettings = !this.showAllSettings;
		this.render();
	}

	private onShowConfiguredOnlyClicked(): void {
		this.showConfiguredSettingsOnly = this.showConfiguredSettingsOnlyCheckbox.checked;
		this.render();
	}

	private onDidChangeSetting(key: string, value: any): void {
		// ConfigurationService displays the error if this fails.
		// Force a render afterwards because onDidConfigurationUpdate doesn't fire if the update doesn't result in an effective setting value change
		this.configurationService.updateValue(key, value, <ConfigurationTarget>this.settingsTargetsWidget.settingsTarget)
			.then(() => this.renderEntries());

		const reportModifiedProps = {
			key,
			query: this.searchWidget.getValue(),
			searchResults: this.searchResultModel.getUniqueResults(),
			rawResults: this.searchResultModel.getRawResults(),
			showConfiguredOnly: this.showConfiguredSettingsOnly,
			isReset: typeof value === 'undefined',
			settingsTarget: this.settingsTargetsWidget.settingsTarget as SettingsTarget
		};

		if (this.pendingSettingModifiedReport && key !== this.pendingSettingModifiedReport.key) {
			this.reportModifiedSetting(reportModifiedProps);
		}

		this.pendingSettingModifiedReport = { key, value };
		this.delayedModifyLogging.trigger(() => this.reportModifiedSetting(reportModifiedProps));
	}

	private reportModifiedSetting(props: { key: string, query: string, searchResults: ISearchResult[], rawResults: ISearchResult[], showConfiguredOnly: boolean, isReset: boolean, settingsTarget: SettingsTarget }): void {
		this.pendingSettingModifiedReport = null;

		const remoteResult = props.searchResults && props.searchResults[SearchResultIdx.Remote];
		const localResult = props.searchResults && props.searchResults[SearchResultIdx.Local];

		let groupId = undefined;
		let nlpIndex = undefined;
		let displayIndex = undefined;
		if (props.searchResults) {
			const localIndex = arrays.firstIndex(localResult.filterMatches, m => m.setting.key === props.key);
			groupId = localIndex >= 0 ?
				'local' :
				'remote';

			displayIndex = localIndex >= 0 ?
				localIndex :
				remoteResult && (arrays.firstIndex(remoteResult.filterMatches, m => m.setting.key === props.key) + localResult.filterMatches.length);

			const rawResults = this.searchResultModel.getRawResults();
			if (rawResults[SearchResultIdx.Remote]) {
				const _nlpIndex = arrays.firstIndex(rawResults[SearchResultIdx.Remote].filterMatches, m => m.setting.key === props.key);
				nlpIndex = _nlpIndex >= 0 ? _nlpIndex : undefined;
			}
		}

		const reportedTarget = props.settingsTarget === ConfigurationTarget.USER ? 'user' :
			props.settingsTarget === ConfigurationTarget.WORKSPACE ? 'workspace' :
				'folder';

		const data = {
			key: props.key,
			query: props.query,
			groupId,
			nlpIndex,
			displayIndex,
			showConfiguredOnly: props.showConfiguredOnly,
			isReset: props.isReset,
			target: reportedTarget
		};

		/* __GDPR__
			"settingsEditor.settingModified" : {
				"key" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
				"query" : { "classification": "CustomerContent", "purpose": "FeatureInsight" },
				"groupId" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
				"nlpIndex" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"displayIndex" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"showConfiguredOnly" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
				"isReset" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" },
				"target" : { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
			}
		*/
		this.telemetryService.publicLog('settingsEditor.settingModified', data);
	}

	private render(): TPromise<any> {
		if (this.input) {
			return this.input.resolve()
				.then((model: DefaultSettingsEditorModel) => this.defaultSettingsEditorModel = model)
				.then(() => this.renderEntries());
		}
		return TPromise.as(null);
	}

	private onInputChanged(): void {
		const query = this.searchWidget.getValue().trim();
		this.delayedFilterLogging.cancel();
		this.triggerSearch(query).then(() => {
			if (query && this.searchResultModel.hasResults()) {
				this.delayedFilterLogging.trigger(() => this.reportFilteringUsed(query, this.searchResultModel.getUniqueResults()));
			}
		});
	}

	private triggerSearch(query: string): TPromise<void> {
		if (query) {
			return TPromise.join([
				this.localSearchDelayer.trigger(() => this.localFilterPreferences(query)),
				this.remoteSearchThrottle.trigger(() => this.remoteSearchPreferences(query), 500)
			]) as TPromise;
		} else {
			// When clearing the input, update immediately to clear it
			this.localSearchDelayer.cancel();
			this.remoteSearchThrottle.cancel();

			this.searchResultModel.clear();
			this.renderEntries();
			return TPromise.wrap(null);
		}
	}

	private reportFilteringUsed(query: string, results: ISearchResult[]): void {
		const nlpResult = results[SearchResultIdx.Remote];
		const nlpMetadata = nlpResult && nlpResult.metadata;

		const durations = {};
		durations['nlpResult'] = nlpMetadata && nlpMetadata.duration;

		// Count unique results
		const counts = {};
		const filterResult = results[SearchResultIdx.Local];
		counts['filterResult'] = filterResult.filterMatches.length;
		if (nlpResult) {
			counts['nlpResult'] = nlpResult.filterMatches.length;
		}

		const requestCount = nlpMetadata && nlpMetadata.requestCount;

		const data = {
			query,
			durations,
			counts,
			requestCount
		};

		/* __GDPR__
			"settingsEditor.filter" : {
				"query": { "classification": "CustomerContent", "purpose": "FeatureInsight" },
				"durations.nlpResult" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"counts.nlpResult" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"counts.filterResult" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true },
				"requestCount" : { "classification": "SystemMetaData", "purpose": "FeatureInsight", "isMeasurement": true }
			}
		*/
		this.telemetryService.publicLog('settingsEditor.filter', data);
	}

	private localFilterPreferences(query: string): TPromise<void> {
		this.currentLocalSearchProvider = this.preferencesSearchService.getLocalSearchProvider(query);
		return this.filterOrSearchPreferences(query, SearchResultIdx.Local, this.currentLocalSearchProvider);
	}

	private remoteSearchPreferences(query: string): TPromise<void> {
		this.currentRemoteSearchProvider = this.preferencesSearchService.getRemoteSearchProvider(query);
		return this.filterOrSearchPreferences(query, SearchResultIdx.Remote, this.currentRemoteSearchProvider);
	}

	private filterOrSearchPreferences(query: string, type: SearchResultIdx, searchProvider: ISearchProvider): TPromise<void> {
		const filterPs: TPromise<ISearchResult>[] = [this._filterOrSearchPreferencesModel(query, this.defaultSettingsEditorModel, searchProvider)];

		return TPromise.join(filterPs).then(results => {
			const [result] = results;
			this.searchResultModel.setResult(type, result);
			return this.render();
		});
	}

	private _filterOrSearchPreferencesModel(filter: string, model: ISettingsEditorModel, provider: ISearchProvider): TPromise<ISearchResult> {
		const searchP = provider ? provider.searchModel(model) : TPromise.wrap(null);
		return searchP
			.then<ISearchResult>(null, err => {
				if (isPromiseCanceledError(err)) {
					return TPromise.wrapError(err);
				} else {
					/* __GDPR__
						"settingsEditor.searchError" : {
							"message": { "classification": "CallstackOrException", "purpose": "FeatureInsight" },
							"filter": { "classification": "SystemMetaData", "purpose": "FeatureInsight" }
						}
					*/
					const message = getErrorMessage(err).trim();
					if (message && message !== 'Error') {
						// "Error" = any generic network error
						this.telemetryService.publicLog('settingsEditor.searchError', { message, filter });
						this.logService.info('Setting search error: ' + message);
					}
					return null;
				}
			});
	}

	private getEntriesFromSearch(searchResults: ISearchResult[]): ListEntry[] {
		const entries: ISettingItemEntry[] = [];
		const seenSettings = new Set<string>();

		const focusedElement = this.settingsList.getFocusedElements()[0];
		const focusedId = focusedElement && focusedElement.id;
		for (let result of searchResults) {
			if (!result) {
				continue;
			}

			for (let match of result.filterMatches) {
				if (!seenSettings.has(match.setting.key)) {
					const entry = this.settingToEntry(match.setting, 'search');
					entry.isFocused = entry.id === focusedId;

					if (!this.showConfiguredSettingsOnly || entry.isConfigured) {
						seenSettings.add(entry.key);
						entries.push(entry);
					}
				}
			}
		}

		return entries;
	}

	private renderEntries(): void {
		this.inRender = true;
		if (!this.defaultSettingsEditorModel) {
			return;
		}

		const focusedRowItem = DOM.findParentWithClass(<HTMLElement>document.activeElement, 'monaco-list-row');
		const focusedRowId = focusedRowItem && focusedRowItem.id;

		const entries = this.searchResultModel.hasResults() ?
			this.getEntriesFromSearch(this.searchResultModel.getUniqueResults()) :
			this.getEntriesFromModel();

		this.settingsList.splice(0, this.settingsList.length, entries);

		// Hack to restore the same focused element after editing.
		// TODO@roblou figure out the whole keyboard navigation story
		if (focusedRowId) {
			const rowSelector = `.monaco-list-row#${focusedRowId}`;
			const inputElementToFocus: HTMLElement = this.settingsListContainer.querySelector(`${rowSelector} input, ${rowSelector} select`);
			if (inputElementToFocus) {
				inputElementToFocus.focus();
			}
		}

		this.inRender = false;
	}

	private getEntriesFromModel(): ListEntry[] {
		const entries: ListEntry[] = [];
		const focusedElement = this.settingsList.getFocusedElements()[0];
		const focusedId = focusedElement && focusedElement.id;

		for (let groupIdx = 0; groupIdx < this.defaultSettingsEditorModel.settingsGroups.length; groupIdx++) {
			if (groupIdx > 0 && !this.showAllSettings && !this.showConfiguredSettingsOnly) {
				break;
			}

			const group = this.defaultSettingsEditorModel.settingsGroups[groupIdx];
			const isExpanded = groupIdx === 0 || this.groupExpanded.get(group.id);

			const groupEntries = [];
			if (isExpanded) {
				for (const section of group.sections) {
					for (const setting of section.settings) {
						const entry = this.settingToEntry(setting, group.id);
						entry.isFocused = entry.id === focusedId;

						if (!this.showConfiguredSettingsOnly || entry.isConfigured) {
							groupEntries.push(entry);
						}
					}
				}
			}

			if (!isExpanded || groupEntries.length) {
				const expandState = groupIdx === 0 ? ExpandState.NA :
					isExpanded ? ExpandState.Expanded :
						ExpandState.Collapsed;

				entries.push(<IGroupTitleEntry>{
					id: group.id,
					templateId: SETTINGS_GROUP_ENTRY_TEMPLATE_ID,
					title: group.title,
					expandState
				});

				entries.push(...groupEntries);
			}

			if (groupIdx === 0 && !this.showConfiguredSettingsOnly) {
				const showAllSettingsLabel = this.showAllSettings ?
					localize('showFewerSettingsLabel', "Show Fewer Settings") :
					localize('showAllSettingsLabel', "Show All Settings");
				entries.push(<IButtonRowEntry>{
					id: ALL_SETTINGS_BUTTON_ID,
					label: showAllSettingsLabel,
					templateId: BUTTON_ROW_ENTRY_TEMPLATE
				});
			}
		}

		return entries;
	}

	private settingToEntry(s: ISetting, groupId: string): ISettingItemEntry {
		const targetSelector = this.settingsTargetsWidget.settingsTarget === ConfigurationTarget.USER ? 'user' : 'workspace';
		const inspected = this.configurationService.inspect(s.key);
		const isConfigured = typeof inspected[targetSelector] !== 'undefined';
		const displayValue = isConfigured ? inspected[targetSelector] : inspected.default;
		const overriddenScopeList = [];
		if (targetSelector === 'user' && typeof inspected.workspace !== 'undefined') {
			overriddenScopeList.push('Workspace');
		}

		if (targetSelector === 'workspace' && typeof inspected.user !== 'undefined') {
			overriddenScopeList.push('User');
		}

		const isExpanded = !!this.itemExpanded.get(s.key);

		return <ISettingItemEntry>{
			id: `${groupId}_${s.key}`,
			key: s.key,
			value: displayValue,
			isConfigured,
			overriddenScopeList,
			description: s.description.join('\n'),
			enum: s.enum,
			type: s.type,
			templateId: SETTINGS_ENTRY_TEMPLATE_ID,
			isExpanded
		};
	}

	private layoutSettingsList(): void {
		const listHeight = this.dimension.height - (DOM.getDomNodePagePosition(this.headerContainer).height + 12 /*padding*/);
		this.settingsListContainer.style.height = `${listHeight}px`;
		this.settingsList.layout(listHeight);
	}
}

class SettingItemDelegate implements IDelegate<ListEntry> {

	constructor(private measureContainer: HTMLElement) {

	}

	getHeight(entry: ListEntry) {
		if (entry.templateId === SETTINGS_GROUP_ENTRY_TEMPLATE_ID) {
			return 30;
		}

		if (entry.templateId === SETTINGS_ENTRY_TEMPLATE_ID) {
			if (entry.isExpanded) {
				return this.getDynamicHeight(entry);
			} else {
				return 68;
			}
		}

		if (entry.templateId === BUTTON_ROW_ENTRY_TEMPLATE) {
			return 60;
		}

		return 0;
	}

	getTemplateId(element: ListEntry) {
		return element.templateId;
	}

	private getDynamicHeight(entry: ISettingItemEntry): number {
		return measureSettingItemEntry(entry, this.measureContainer);
	}
}

function measureSettingItemEntry(entry: ISettingItemEntry, measureContainer: HTMLElement): number {
	const measureHelper = DOM.append(measureContainer, $('.setting-item-measure-helper.monaco-list-row'));

	const template = SettingItemRenderer.renderTemplate(measureHelper);
	SettingItemRenderer.renderElement(entry, 0, template);

	const height = measureHelper.offsetHeight;
	measureContainer.removeChild(measureHelper);
	return height;
}

interface IDisposableTemplate {
	toDispose: IDisposable[];
}

interface ISettingItemTemplate extends IDisposableTemplate {
	parent: HTMLElement;

	context?: ISettingItemEntry;
	containerElement: HTMLElement;
	categoryElement: HTMLElement;
	labelElement: HTMLElement;
	descriptionElement: HTMLElement;
	showMoreElement: HTMLElement;
	valueElement: HTMLElement;
	overridesElement: HTMLElement;
}

interface IGroupTitleTemplate extends IDisposableTemplate {
	context?: IGroupTitleEntry;
	parent: HTMLElement;
	labelElement: HTMLElement;
}

interface IButtonRowTemplate extends IDisposableTemplate {
	parent: HTMLElement;

	button: Button;
	entry?: IButtonRowEntry;
}

interface ISettingChangeEvent {
	key: string;
	value: any; // undefined => reset unconfigure
}

class SettingItemRenderer implements IRenderer<ISettingItemEntry, ISettingItemTemplate> {

	private readonly _onDidChangeSetting: Emitter<ISettingChangeEvent> = new Emitter<ISettingChangeEvent>();
	public readonly onDidChangeSetting: Event<ISettingChangeEvent> = this._onDidChangeSetting.event;

	private readonly _onDidOpenSettings: Emitter<void> = new Emitter<void>();
	public readonly onDidOpenSettings: Event<void> = this._onDidOpenSettings.event;

	private readonly _onDidToggleExpandSetting: Emitter<ISettingItemEntry> = new Emitter<ISettingItemEntry>();
	public readonly onDidToggleExpandSetting: Event<ISettingItemEntry> = this._onDidToggleExpandSetting.event;

	get templateId(): string { return SETTINGS_ENTRY_TEMPLATE_ID; }

	constructor(
		private measureContainer: HTMLElement,
		@IContextViewService private contextViewService: IContextViewService,
		@IThemeService private themeService: IThemeService
	) { }

	renderTemplate(parent: HTMLElement): ISettingItemTemplate {
		return SettingItemRenderer.renderTemplate(parent, this);
	}

	static renderTemplate(parent: HTMLElement, that?: SettingItemRenderer): ISettingItemTemplate {
		DOM.addClass(parent, 'setting-item');

		const itemContainer = DOM.append(parent, $('.setting-item-container'));
		const leftElement = DOM.append(itemContainer, $('.setting-item-left'));
		const rightElement = DOM.append(itemContainer, $('.setting-item-right'));

		const titleElement = DOM.append(leftElement, $('.setting-item-title'));
		const categoryElement = DOM.append(titleElement, $('span.setting-item-category'));
		const labelElement = DOM.append(titleElement, $('span.setting-item-label'));
		const overridesElement = DOM.append(titleElement, $('span.setting-item-overrides'));
		const descriptionElement = DOM.append(leftElement, $('.setting-item-description'));
		const showMoreElement = DOM.append(leftElement, $('.setting-show-more'));

		const valueElement = DOM.append(rightElement, $('.setting-item-value'));

		const toDispose = [];
		const template: ISettingItemTemplate = {
			parent: parent,
			toDispose,

			containerElement: itemContainer,
			categoryElement,
			labelElement,
			descriptionElement,
			showMoreElement,
			valueElement,
			overridesElement
		};

		if (that) {
			toDispose.push(DOM.addDisposableListener(descriptionElement, 'click', () => {
				const entry = template.context;
				if (entry && entry.isExpandable) {
					that._onDidToggleExpandSetting.fire(entry);
				}
			}));
		}

		return template;
	}

	renderElement(entry: ISettingItemEntry, index: number, template: ISettingItemTemplate): void {
		return SettingItemRenderer.renderElement(entry, index, template, this);
	}

	static renderElement(entry: ISettingItemEntry, index: number, template: ISettingItemTemplate, that?: SettingItemRenderer): void {
		template.context = entry;
		DOM.toggleClass(template.parent, 'odd', index % 2 === 1);
		DOM.toggleClass(template.parent, 'is-configured', entry.isConfigured);
		DOM.toggleClass(template.parent, 'is-expanded', entry.isExpanded);

		const titleTooltip = entry.key;
		const settingKeyDisplay = settingKeyToDisplayFormat(entry.key);
		template.categoryElement.textContent = settingKeyDisplay.category + ': ';
		template.categoryElement.title = titleTooltip;

		template.labelElement.textContent = settingKeyDisplay.label;
		template.labelElement.title = titleTooltip;
		template.descriptionElement.textContent = entry.description;
		template.descriptionElement.title = entry.description;

		if (that) {
			const expandedHeight = measureSettingItemEntry(entry, that.measureContainer);
			entry.isExpandable = expandedHeight > 68;
			DOM.toggleClass(template.parent, 'is-expandable', entry.isExpandable);
		}

		if (that) {
			that.renderValue(entry, template);
		}

		const resetButton = new Button(template.valueElement);
		resetButton.element.title = localize('resetButtonTitle', "Reset");
		resetButton.element.classList.add('setting-reset-button');
		resetButton.element.tabIndex = entry.isFocused ? 0 : -1;

		if (that) {
			attachButtonStyler(resetButton, that.themeService, {
				buttonBackground: Color.transparent.toString(),
				buttonHoverBackground: Color.transparent.toString()
			});
		}

		if (that) {
			template.toDispose.push(resetButton.onDidClick(e => {
				that._onDidChangeSetting.fire({ key: entry.key, value: undefined });
			}));
		}
		template.toDispose.push(resetButton);

		const alsoConfiguredInLabel = localize('alsoConfiguredIn', "Also modified in:");
		let overridesElementText = entry.isConfigured ? 'Modified ' : '';

		if (entry.overriddenScopeList.length) {
			overridesElementText = overridesElementText + `(${alsoConfiguredInLabel} ${entry.overriddenScopeList.join(', ')})`;
		}

		template.overridesElement.textContent = overridesElementText;
	}

	private renderValue(entry: ISettingItemEntry, template: ISettingItemTemplate): void {
		const onChange = value => this._onDidChangeSetting.fire({ key: entry.key, value });
		template.valueElement.innerHTML = '';
		if (entry.type === 'string' && entry.enum) {
			this.renderEnum(entry, template, onChange);
		} else if (entry.type === 'boolean') {
			this.renderBool(entry, template, onChange);
		} else if (entry.type === 'string') {
			this.renderText(entry, template, onChange);
		} else if (entry.type === 'number') {
			this.renderText(entry, template, value => onChange(parseInt(value)));
		} else {
			this.renderEditInSettingsJson(entry, template);
		}
	}

	private renderBool(entry: ISettingItemEntry, template: ISettingItemTemplate, onChange: (value: boolean) => void): void {
		const checkboxElement = <HTMLInputElement>DOM.append(template.valueElement, $('input.setting-value-checkbox.setting-value-input'));
		checkboxElement.type = 'checkbox';
		checkboxElement.checked = entry.value;
		checkboxElement.tabIndex = entry.isFocused ? 0 : -1;

		template.toDispose.push(DOM.addDisposableListener(checkboxElement, 'change', e => onChange(checkboxElement.checked)));
	}

	private renderEnum(entry: ISettingItemEntry, template: ISettingItemTemplate, onChange: (value: string) => void): void {
		const idx = entry.enum.indexOf(entry.value);
		const selectBox = new SelectBox(entry.enum, idx, this.contextViewService);
		template.toDispose.push(selectBox);
		template.toDispose.push(attachSelectBoxStyler(selectBox, this.themeService));
		selectBox.render(template.valueElement);
		if (template.valueElement.firstElementChild) {
			template.valueElement.firstElementChild.setAttribute('tabindex', entry.isFocused ? '0' : '-1');
		}

		template.toDispose.push(
			selectBox.onDidSelect(e => onChange(entry.enum[e.index])));
	}

	private renderText(entry: ISettingItemEntry, template: ISettingItemTemplate, onChange: (value: string) => void): void {
		const inputBox = new InputBox(template.valueElement, this.contextViewService);
		template.toDispose.push(attachInputBoxStyler(inputBox, this.themeService));
		template.toDispose.push(inputBox);
		inputBox.value = entry.value;
		inputBox.inputElement.tabIndex = entry.isFocused ? 0 : -1;

		template.toDispose.push(
			inputBox.onDidChange(e => onChange(e)));
	}

	private renderEditInSettingsJson(entry: ISettingItemEntry, template: ISettingItemTemplate): void {
		const openSettingsButton = new Button(template.valueElement, { title: true, buttonBackground: null, buttonHoverBackground: null });
		openSettingsButton.onDidClick(() => this._onDidOpenSettings.fire());
		openSettingsButton.label = localize('editInSettingsJson', "Edit in settings.json");
		openSettingsButton.element.classList.add('edit-in-settings-button');
		openSettingsButton.element.tabIndex = entry.isFocused ? 0 : -1;

		template.toDispose.push(openSettingsButton);
		template.toDispose.push(attachButtonStyler(openSettingsButton, this.themeService, {
			buttonBackground: Color.transparent.toString(),
			buttonHoverBackground: Color.transparent.toString(),
			buttonForeground: 'foreground'
		}));
	}

	disposeTemplate(template: ISettingItemTemplate): void {
		dispose(template.toDispose);
	}
}

registerThemingParticipant((theme: ITheme, collector: ICssStyleCollector) => {
	const modifiedItemForegroundColor = theme.getColor(modifiedItemForeground);
	if (modifiedItemForegroundColor) {
		collector.addRule(`.settings-editor > .settings-body > .settings-list-container .monaco-list-row.is-configured .setting-item-title { color: ${modifiedItemForegroundColor}; }`);
	}
});

class GroupTitleRenderer implements IRenderer<IGroupTitleEntry, IGroupTitleTemplate> {

	private static readonly EXPANDED_CLASS = 'settings-group-title-expanded';
	private static readonly COLLAPSED_CLASS = 'settings-group-title-collapsed';

	private readonly _onDidClickGroup: Emitter<string> = new Emitter<string>();
	public readonly onDidClickGroup: Event<string> = this._onDidClickGroup.event;

	get templateId(): string { return SETTINGS_GROUP_ENTRY_TEMPLATE_ID; }

	renderTemplate(parent: HTMLElement): IGroupTitleTemplate {
		DOM.addClass(parent, 'group-title');

		const labelElement = DOM.append(parent, $('h3.settings-group-title-label'));

		const toDispose = [];
		const template: IGroupTitleTemplate = {
			parent: parent,
			labelElement,
			toDispose
		};

		toDispose.push(DOM.addDisposableListener(labelElement, 'click', () => {
			if (template.context) {
				this._onDidClickGroup.fire(template.context.id);
			}
		}));

		return template;
	}

	renderElement(entry: IGroupTitleEntry, index: number, template: IGroupTitleTemplate): void {
		template.context = entry;
		template.labelElement.textContent = entry.title;

		template.labelElement.classList.remove(GroupTitleRenderer.EXPANDED_CLASS);
		template.labelElement.classList.remove(GroupTitleRenderer.COLLAPSED_CLASS);

		if (entry.expandState === ExpandState.Expanded) {
			template.labelElement.classList.add(GroupTitleRenderer.EXPANDED_CLASS);
		} else if (entry.expandState === ExpandState.Collapsed) {
			template.labelElement.classList.add(GroupTitleRenderer.COLLAPSED_CLASS);
		}
	}

	disposeTemplate(template: IGroupTitleTemplate): void {
		dispose(template.toDispose);
	}
}

class ButtonRowRenderer implements IRenderer<IButtonRowEntry, IButtonRowTemplate> {

	private readonly _onDidClick: Emitter<string> = new Emitter<string>();
	public readonly onDidClick: Event<string> = this._onDidClick.event;

	get templateId(): string { return BUTTON_ROW_ENTRY_TEMPLATE; }

	renderTemplate(parent: HTMLElement): IButtonRowTemplate {
		DOM.addClass(parent, 'all-settings');

		const buttonElement = DOM.append(parent, $('.all-settings-button'));

		const button = new Button(buttonElement);
		const toDispose: IDisposable[] = [button];

		const template: IButtonRowTemplate = {
			parent: parent,
			toDispose,

			button
		};
		toDispose.push(button.onDidClick(e => this._onDidClick.fire(template.entry && template.entry.label)));

		return template;
	}

	renderElement(entry: IButtonRowEntry, index: number, template: IButtonRowTemplate): void {
		template.button.label = entry.label;
		template.entry = entry;
	}

	disposeTemplate(template: IButtonRowTemplate): void {
		dispose(template.toDispose);
	}
}

export function settingKeyToDisplayFormat(key: string): { category: string, label: string } {
	let label = key
		.replace(/\.([a-z])/g, (match, p1) => `.${p1.toUpperCase()}`)
		.replace(/([a-z])([A-Z])/g, '$1 $2') // fooBar => foo Bar
		.replace(/^[a-z]/g, match => match.toUpperCase()); // foo => Foo

	const lastDotIdx = label.lastIndexOf('.');
	let category = '';
	if (lastDotIdx >= 0) {
		category = label.substr(0, lastDotIdx);
		label = label.substr(lastDotIdx + 1);
	}

	return { category, label };
}

class SearchResultModel {
	private rawSearchResults: ISearchResult[];
	private cachedUniqueSearchResults: ISearchResult[];

	getUniqueResults(): ISearchResult[] {
		if (this.cachedUniqueSearchResults) {
			return this.cachedUniqueSearchResults;
		}

		if (!this.rawSearchResults) {
			return null;
		}

		const localMatchKeys = new Set();
		const localResult = objects.deepClone(this.rawSearchResults[SearchResultIdx.Local]);
		if (localResult) {
			localResult.filterMatches.forEach(m => localMatchKeys.add(m.setting.key));
		}

		const remoteResult = objects.deepClone(this.rawSearchResults[SearchResultIdx.Remote]);
		if (remoteResult) {
			remoteResult.filterMatches = remoteResult.filterMatches.filter(m => !localMatchKeys.has(m.setting.key));
		}

		this.cachedUniqueSearchResults = [localResult, remoteResult];
		return this.cachedUniqueSearchResults;
	}

	getRawResults(): ISearchResult[] {
		return this.rawSearchResults;
	}

	hasResults(): boolean {
		return !!this.rawSearchResults;
	}

	clear(): void {
		this.cachedUniqueSearchResults = null;
		this.rawSearchResults = null;
	}

	setResult(type: SearchResultIdx, result: ISearchResult): void {
		this.cachedUniqueSearchResults = null;
		this.rawSearchResults = this.rawSearchResults || [];
		this.rawSearchResults[type] = result;
	}
}