Skip to content

Fix formatting and clean up comments in window.ts #322047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Zubad2 wants to merge 2 commits into from
+3 −49
Closed

Fix formatting and clean up comments in window.ts #322047

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e98240b
Fix formatting and clean up comments in window.ts
Zubad2 Jun 19, 2026
ed4c02d
Potential fix for pull request finding
Zubad2 Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 3 additions & 49 deletions src/vs/platform/window/common/window.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

import { VSBuffer } from '../../../base/common/buffer.js';
Expand Down Expand Up @@ -36,12 +36,10 @@ export interface IRectangle extends IPoint {
}

export interface IBaseOpenWindowsOptions {

/**
* Whether to reuse the window or open a new one.
*/
readonly forceReuseWindow?: boolean;

/**
* The remote authority to use when windows are opened with either
* - no workspace (empty window)
Expand All @@ -50,24 +48,19 @@ export interface IBaseOpenWindowsOptions {
* If not set, defaults to the remote authority of the current window.
*/
readonly remoteAuthority?: string | null;

readonly forceProfile?: string;
readonly forceTempProfile?: boolean;
}

export interface IOpenWindowOptions extends IBaseOpenWindowsOptions {
readonly forceNewWindow?: boolean;
readonly preferNewWindow?: boolean;

readonly noRecentEntry?: boolean;

readonly addMode?: boolean;
readonly removeMode?: boolean;

readonly diffMode?: boolean;
readonly mergeMode?: boolean;
readonly gotoLineMode?: boolean;

readonly waitMarkerFileURI?: URI;
}

Expand Down Expand Up @@ -142,42 +135,35 @@ export function hasNativeContextMenu(configurationService: IConfigurationService
if (isWeb) {
return false;
}

const nativeTitle = hasNativeTitlebar(configurationService, titleBarStyle);
const windowConfigurations = configurationService.getValue<IWindowSettings | undefined>('window');

if (windowConfigurations?.menuStyle === MenuStyleConfiguration.NATIVE) {
// Do not support native menu with custom title bar
if (!isMacintosh && !nativeTitle) {
return false;
}
return true;
}

if (windowConfigurations?.menuStyle === MenuStyleConfiguration.CUSTOM) {
return false;
}

return nativeTitle; // Default to inherit from title bar style
}

export function hasNativeMenu(configurationService: IConfigurationService, titleBarStyle?: TitlebarStyle): boolean {
if (isWeb) {
return false;
}

if (isMacintosh) {
return true;
}

return hasNativeContextMenu(configurationService, titleBarStyle);
}

export type MenuBarVisibility = 'classic' | 'visible' | 'toggle' | 'hidden' | 'compact';

export function getMenuBarVisibility(configurationService: IConfigurationService): MenuBarVisibility {
const menuBarVisibility = configurationService.getValue<MenuBarVisibility | 'default'>(MenuSettings.MenuBarVisibility);

if (menuBarVisibility === 'default' || (menuBarVisibility === 'compact' && hasNativeMenu(configurationService)) || (isMacintosh && isNative)) {
return 'classic';
} else {
Expand Down Expand Up @@ -249,47 +235,40 @@ export function hasNativeTitlebar(configurationService: IConfigurationService, t
if (!titleBarStyle) {
titleBarStyle = getTitleBarStyle(configurationService);
}

return titleBarStyle === TitlebarStyle.NATIVE;
}

export function getTitleBarStyle(configurationService: IConfigurationService): TitlebarStyle {
if (isWeb) {
return TitlebarStyle.CUSTOM;
}

const configuration = configurationService.getValue<IWindowSettings | undefined>('window');
if (configuration) {
const useNativeTabs = isMacintosh && configuration.nativeTabs === true;
if (useNativeTabs) {
return TitlebarStyle.NATIVE; // native tabs on macOS do not work with custom title style
}

const useSimpleFullScreen = isMacintosh && configuration.nativeFullScreen === false;
if (useSimpleFullScreen) {
return TitlebarStyle.NATIVE; // simple fullscreen does not work well with custom title style (https://github.com/microsoft/vscode/issues/63291)
return TitlebarStyle.NATIVE; // simple fullscreen does not work well with custom title style[](https://github.com/microsoft/vscode/issues/63291)
}

const style = configuration.titleBarStyle;
if (style === TitlebarStyle.NATIVE || style === TitlebarStyle.CUSTOM) {
return style;
}
}

return TitlebarStyle.CUSTOM; // default to custom on all OS
}

export function getWindowControlsStyle(configurationService: IConfigurationService): WindowControlsStyle {
if (isWeb || isMacintosh || getTitleBarStyle(configurationService) === TitlebarStyle.NATIVE) {
return WindowControlsStyle.NATIVE; // only supported on Windows/Linux desktop with custom titlebar
}

const configuration = configurationService.getValue<IWindowSettings | undefined>('window');
const style = configuration?.controlsStyle;
if (style === WindowControlsStyle.CUSTOM || style === WindowControlsStyle.HIDDEN) {
return style;
}

return WindowControlsStyle.NATIVE; // default to native on all OS
}

Expand All @@ -299,18 +278,15 @@ export function useWindowControlsOverlay(configurationService: IConfigurationSer
if (isWeb) {
return false; // only supported on desktop instances
}

if (hasNativeTitlebar(configurationService)) {
return false; // only supported when title bar is custom
}

if (!isMacintosh) {
const setting = getWindowControlsStyle(configurationService);
if (setting === WindowControlsStyle.CUSTOM || setting === WindowControlsStyle.HIDDEN) {
return false; // explicitly disabled by choice
}
}

return true; // default
}

Expand All @@ -319,48 +295,39 @@ export function useNativeFullScreen(configurationService: IConfigurationService)
if (!windowConfig || typeof windowConfig.nativeFullScreen !== 'boolean') {
return true; // default
}

if (windowConfig.nativeTabs) {
return true; // https://github.com/electron/electron/issues/16142
}

return windowConfig.nativeFullScreen !== false;
}


export interface IPath<T = IEditorOptions> extends IPathData<T> {

/**
* The file path to open within the instance
*/
fileUri?: URI;
}

export interface IPathData<T = IEditorOptions> {

/**
* The file path to open within the instance
*/
readonly fileUri?: UriComponents;

/**
* Optional editor options to apply in the file
*/
readonly options?: T;

/**
* A hint that the file exists. if true, the
* file exists, if false it does not. with
* `undefined` the state is unknown.
*/
readonly exists?: boolean;

/**
* A hint about the file type of this path.
* with `undefined` the type is unknown.
*/
readonly type?: FileType;

/**
* Specifies if the file should be only be opened
* if it exists.
Expand Down Expand Up @@ -409,7 +376,6 @@ export interface IColorScheme {

export interface IWindowConfiguration {
remoteAuthority?: string;

filesToOpenOrCreate?: IPath[];
filesToDiff?: IPath[];
filesToMerge?: IPath[];
Expand All @@ -424,48 +390,36 @@ export interface IOSConfiguration {
export interface INativeWindowConfiguration extends IWindowConfiguration, NativeParsedArgs, ISandboxConfiguration {
mainPid: number;
handle?: VSBuffer;

machineId: string;
sqmId: string;
devDeviceId: string;
isPortable: boolean;

execPath: string;
backupPath?: string;

profiles: {
home: UriComponents;
all: readonly UriDto<IUserDataProfile>[];
profile: UriDto<IUserDataProfile>;
};

homeDir: string;
tmpDir: string;
userDataDir: string;

partsSplash?: IPartsSplash;

workspace?: IWorkspaceIdentifier | ISingleFolderWorkspaceIdentifier;

isInitialStartup?: boolean;
logLevel: LogLevel;
loggers: UriDto<ILoggerResource>[];

fullscreen?: boolean;
maximized?: boolean;
accessibilitySupport?: boolean;
colorScheme: IColorScheme;
autoDetectHighContrast?: boolean;
autoDetectColorScheme?: boolean;
isCustomZoomLevel?: boolean;

perfMarks: PerformanceMark[];

filesToWait?: IPathsToWaitFor;

os: IOSConfiguration;
policiesData?: IStringDictionary<{ definition: PolicyDefinition; value: PolicyValue }>;

isSessionsWindow?: boolean;
}

Expand Down