mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
tools: Add VSCode setup (fixes #3906)
Add tooling to set up a Visual Studio Code development environment for CEF. See script output for usage. Run: python3 tools/setup_vscode.py
This commit is contained in:
Marshall Greenblatt
@ -7,7 +7,7 @@ from subprocess import Popen, PIPE
|
||||
import sys
|
||||
|
||||
|
||||
def exec_cmd(cmd, path, input_string=None):
|
||||
def exec_cmd(cmd, path, input_string=None, output_file=None):
|
||||
""" Execute the specified command and return the result. """
|
||||
out = ''
|
||||
err = ''
|
||||
@ -18,7 +18,7 @@ def exec_cmd(cmd, path, input_string=None):
|
||||
process = Popen(
|
||||
parts,
|
||||
cwd=path,
|
||||
stdout=PIPE,
|
||||
stdout=PIPE if output_file is None else output_file,
|
||||
stderr=PIPE,
|
||||
shell=(sys.platform == 'win32'))
|
||||
out, err = process.communicate()
|
||||
@ -28,10 +28,14 @@ def exec_cmd(cmd, path, input_string=None):
|
||||
parts,
|
||||
cwd=path,
|
||||
stdin=PIPE,
|
||||
stdout=PIPE,
|
||||
stdout=PIPE if output_file is None else output_file,
|
||||
stderr=PIPE,
|
||||
shell=(sys.platform == 'win32'))
|
||||
out, err = process.communicate(input=input_string)
|
||||
ret = process.returncode
|
||||
|
||||
return {'out': out.decode('utf-8'), 'err': err.decode('utf-8'), 'ret': ret}
|
||||
return {
|
||||
'out': out.decode('utf-8') if output_file is None else None,
|
||||
'err': err.decode('utf-8'),
|
||||
'ret': ret
|
||||
}
|
||||
|
||||
@ -38,7 +38,7 @@ def write_file(path, data, overwrite=True, quiet=True):
|
||||
return False
|
||||
|
||||
if not quiet:
|
||||
print('Writing file %s' % path)
|
||||
print('Writing %s file.' % path)
|
||||
|
||||
try:
|
||||
with open(path, 'w', encoding='utf-8', newline='\n') as f:
|
||||
|
||||
@ -10,6 +10,7 @@ from gclient_util import *
|
||||
from gn_args import GetAllPlatformConfigs, GetConfigFileContents
|
||||
import issue_1999
|
||||
import os
|
||||
from setup_vscode import GetPreferredOutputDirectory, UpdateCompileCommandsJSON
|
||||
import sys
|
||||
|
||||
# The CEF directory is the parent directory of _this_ script.
|
||||
@ -26,7 +27,7 @@ elif sys.platform.startswith('linux'):
|
||||
platform = 'linux'
|
||||
else:
|
||||
print('Unknown operating system platform')
|
||||
sys.exit()
|
||||
sys.exit(1)
|
||||
|
||||
print("\nGenerating CEF translated files...")
|
||||
cmd = [sys.executable, 'tools/version_manager.py', '-u', '--fast-check']
|
||||
@ -134,6 +135,10 @@ if platform == 'windows':
|
||||
gn_args['windows_sdk_version'] = os.environ['SDK_VERSION']
|
||||
|
||||
configs = GetAllPlatformConfigs(gn_args)
|
||||
|
||||
# Returns the preferred output directory for VSCode, or None.
|
||||
preferred_dir = GetPreferredOutputDirectory(configs.keys())
|
||||
|
||||
for dir, config in configs.items():
|
||||
# Create out directories and write the args.gn file.
|
||||
out_path = os.path.join(src_dir, 'out', dir)
|
||||
@ -149,3 +154,7 @@ for dir, config in configs.items():
|
||||
RunAction(src_dir, cmd)
|
||||
if platform == 'windows':
|
||||
issue_1999.apply(out_path)
|
||||
|
||||
if dir == preferred_dir and not UpdateCompileCommandsJSON(
|
||||
src_dir, out_path, create=False):
|
||||
sys.exit(1)
|
||||
|
||||
292
tools/setup_vscode.py
Normal file
292
tools/setup_vscode.py
Normal file
@ -0,0 +1,292 @@
|
||||
# Copyright (c) 2025 The Chromium Embedded Framework Authors. All rights
|
||||
# reserved. Use of this source code is governed by a BSD-style license that
|
||||
# can be found in the LICENSE file.
|
||||
|
||||
from __future__ import absolute_import
|
||||
from __future__ import print_function
|
||||
from exec_util import exec_cmd
|
||||
from file_util import backup_file, copy_file, make_dir, read_file, write_file
|
||||
import os
|
||||
import platform as python_platform
|
||||
import sys
|
||||
|
||||
COMPILE_COMMANDS_JSON = 'compile_commands.json'
|
||||
LLDBINIT = '.lldbinit'
|
||||
|
||||
|
||||
def UpdateCompileCommandsJSON(src_dir, out_dir, create):
|
||||
out_path = os.path.join(src_dir, COMPILE_COMMANDS_JSON)
|
||||
if not create and not os.path.isfile(out_path):
|
||||
return True
|
||||
|
||||
print(f'Writing {COMPILE_COMMANDS_JSON} for clangd...')
|
||||
with open(out_path, 'w') as f:
|
||||
result = exec_cmd(
|
||||
sys.executable +
|
||||
f' tools/clang/scripts/generate_compdb.py -p {out_dir}',
|
||||
src_dir,
|
||||
output_file=f)
|
||||
if result['err']:
|
||||
print('ERROR: generate_compdb.py failed: %s' % result['err'])
|
||||
return False
|
||||
return True
|
||||
|
||||
|
||||
def GetPreferredOutputDirectory(all_dirs):
|
||||
if sys.platform == 'win32':
|
||||
# Windows machines report 'ARM64' or 'AMD64'.
|
||||
machine = 'arm64' if python_platform.machine() == 'ARM64' else 'x64'
|
||||
elif sys.platform == 'darwin':
|
||||
# Mac machines report 'arm64' or 'x86_64'.
|
||||
machine = 'arm64' if python_platform.machine() == 'arm64' else 'x64'
|
||||
elif sys.platform.startswith('linux'):
|
||||
# Linux machines report 'aarch64', 'armv7l', 'x86_64', 'i386', etc.
|
||||
machine = 'arm64' if python_platform.machine() == 'aarch64' else 'x64'
|
||||
|
||||
# Return the preferred directory that matches the host architecture.
|
||||
for dir in (f'Debug_GN_{machine}', f'Release_GN_{machine}'):
|
||||
if dir in all_dirs:
|
||||
return dir
|
||||
|
||||
return None
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
from optparse import OptionParser
|
||||
|
||||
desc = """
|
||||
This utility sets up Visual Studio Code (VSCode) integration for CEF.
|
||||
"""
|
||||
|
||||
epilog = """
|
||||
This utility sets up Visual Studio Code (VSCode) integration for an existing
|
||||
CEF/Chromium development environment. See
|
||||
https://bitbucket.org/chromiumembedded/cef/wiki/MasterBuildQuickStart.md for
|
||||
prerequisite environment setup instructions.
|
||||
|
||||
The VSCode application and recommended extensions should be installed manually
|
||||
upon completion of this setup. Instructions for this will be provided.
|
||||
|
||||
This setup is an automation and customization of the Chromium setup documented
|
||||
at https://chromium.googlesource.com/chromium/src/+/main/docs/vscode.md. After
|
||||
completion of this setup the VSCode configuration can be further customized by
|
||||
modifying JSON files in the src/.vscode directory (either directly or via the
|
||||
VSCode interface).
|
||||
|
||||
This setup includes configuration of clangd for improved C/C++ IntelliSense.
|
||||
This functionality depends on a src/compile_commands.json file that will
|
||||
be created by this utility and then regenerated each time cef_create_projects
|
||||
is called in the future. Delete this json file manually if you do not wish to
|
||||
utilize clangd with VSCode.
|
||||
"""
|
||||
|
||||
class CustomParser(OptionParser):
|
||||
|
||||
def format_epilog(self, formatter):
|
||||
return self.epilog
|
||||
|
||||
parser = CustomParser(description=desc, epilog=epilog + '\n')
|
||||
parser.add_option(
|
||||
'-v',
|
||||
'--verbose',
|
||||
action='store_true',
|
||||
dest='verbose',
|
||||
default=False,
|
||||
help='output detailed status information')
|
||||
parser.add_option(
|
||||
'--headless',
|
||||
action='store_true',
|
||||
dest='headless',
|
||||
default=False,
|
||||
help='run without requiring user interaction')
|
||||
parser.add_option(
|
||||
'--force-update',
|
||||
action='store_true',
|
||||
dest='force_update',
|
||||
default=False,
|
||||
help='force update all JSON configuration files')
|
||||
(options, args) = parser.parse_args()
|
||||
|
||||
print(epilog)
|
||||
|
||||
if not options.headless:
|
||||
input("Press Enter to proceed with setup...")
|
||||
|
||||
quiet = not options.verbose
|
||||
|
||||
script_dir = os.path.dirname(__file__)
|
||||
cef_dir = os.path.abspath(os.path.join(script_dir, os.pardir))
|
||||
src_dir = os.path.abspath(os.path.join(cef_dir, os.pardir))
|
||||
chromium_dir = os.path.abspath(os.path.join(src_dir, os.pardir))
|
||||
in_dir = os.path.join(cef_dir, 'tools', 'vscode')
|
||||
|
||||
print('Running setup for VSCode environment...\n')
|
||||
|
||||
# Determine the platform and architecture.
|
||||
# Chromium development only supports ARM64 and x64 host systems. All other
|
||||
# configurations will be cross-compiled.
|
||||
if sys.platform == 'win32':
|
||||
platform = 'windows'
|
||||
# Windows machines report 'ARM64' or 'AMD64'.
|
||||
machine = 'arm64' if python_platform.machine() == 'ARM64' else 'x64'
|
||||
sampleapp = 'cefclient.exe'
|
||||
testsapp = 'ceftests.exe'
|
||||
elif sys.platform == 'darwin':
|
||||
platform = 'mac'
|
||||
# Mac machines report 'arm64' or 'x86_64'.
|
||||
machine = 'arm64' if python_platform.machine() == 'arm64' else 'x64'
|
||||
sampleapp = 'cefclient.app/Contents/MacOS/cefclient'
|
||||
testsapp = 'ceftests.app/Contents/MacOS/ceftests'
|
||||
elif sys.platform.startswith('linux'):
|
||||
platform = 'linux'
|
||||
# Linux machines report 'aarch64', 'armv7l', 'x86_64', 'i386', etc.
|
||||
machine = 'arm64' if python_platform.machine() == 'aarch64' else 'x64'
|
||||
sampleapp = 'cefclient'
|
||||
testsapp = 'ceftests'
|
||||
else:
|
||||
print('ERROR: Unknown operating system platform.')
|
||||
sys.exit(1)
|
||||
|
||||
debug_out_dir = os.path.join(src_dir, 'out', 'Debug_GN_' + machine)
|
||||
debug_out_dir_exists = os.path.isdir(debug_out_dir)
|
||||
release_out_dir = os.path.join(src_dir, 'out', 'Release_GN_' + machine)
|
||||
release_out_dir_exists = os.path.isdir(release_out_dir)
|
||||
|
||||
if not debug_out_dir_exists and not release_out_dir_exists:
|
||||
print(
|
||||
f'ERROR: Output directories matching your host architecture ({machine}) do not exist.\n'
|
||||
'Check your GN_OUT_CONFIGS environment variable and re-run cef_create_projects before proceeding.'
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
out_dir = debug_out_dir if debug_out_dir_exists else release_out_dir
|
||||
|
||||
print(
|
||||
f'Configuring VSCode project files for your host architecture ({machine})...\n'
|
||||
)
|
||||
|
||||
variables = {
|
||||
'ARCH': machine,
|
||||
'DEFAULT': 'Debug' if debug_out_dir_exists else 'Release',
|
||||
'DEBUGGER': 'cppvsdbg' if platform == 'windows' else 'cppdbg',
|
||||
'EXEEXT': '.exe' if platform == 'windows' else '',
|
||||
'SAMPLEAPP': sampleapp,
|
||||
'TESTSAPP': testsapp,
|
||||
}
|
||||
|
||||
vscode_dir = os.path.join(src_dir, '.vscode')
|
||||
if not os.path.isdir(vscode_dir):
|
||||
make_dir(vscode_dir, quiet)
|
||||
|
||||
change_ct = 0
|
||||
|
||||
# Update JSON files if necessary.
|
||||
for json_name in ('cpp.code-snippets', 'extensions.json', 'keybindings.json',
|
||||
'settings.json', 'launch.json', 'tasks.json'):
|
||||
out_path = os.path.join(vscode_dir, json_name)
|
||||
if os.path.isfile(out_path):
|
||||
if not options.force_update:
|
||||
print(f'Skipping existing file {json_name}')
|
||||
continue
|
||||
else:
|
||||
print(f'Backing up existing file {json_name}')
|
||||
backup_file(out_path)
|
||||
|
||||
in_path = os.path.join(in_dir, json_name)
|
||||
if os.path.isfile(in_path):
|
||||
# Copying a CEF file as-is.
|
||||
copy_file(in_path, out_path, quiet)
|
||||
change_ct += 1
|
||||
continue
|
||||
|
||||
in_path += '.in'
|
||||
if os.path.isfile(in_path):
|
||||
# Copying a CEF file with variable substitution.
|
||||
content = read_file(in_path)
|
||||
for name, val in variables.items():
|
||||
content = content.replace('{{' + name + '}}', val)
|
||||
write_file(out_path, content, quiet=quiet)
|
||||
change_ct += 1
|
||||
continue
|
||||
|
||||
in_path = os.path.join(src_dir, 'tools', 'vscode', json_name)
|
||||
if os.path.isfile(in_path):
|
||||
# Copying a Chromium file as-is.
|
||||
copy_file(in_path, out_path, quiet)
|
||||
change_ct += 1
|
||||
continue
|
||||
|
||||
print(f'ERROR: Required input file {json_name} does not exist.')
|
||||
sys.exit(1)
|
||||
|
||||
gclient_path = os.path.join(chromium_dir, '.gclient')
|
||||
if not os.path.isfile(gclient_path):
|
||||
print(f'ERROR: Required input file {gclient_path} does not exist.')
|
||||
sys.exit(1)
|
||||
|
||||
# Setup for clangd.
|
||||
# https://chromium.googlesource.com/chromium/src/+/main/docs/clangd.md
|
||||
content = read_file(gclient_path)
|
||||
if content.find('checkout_clangd') < 0:
|
||||
insert = "'custom_vars': {"
|
||||
content = content.replace(insert, insert + "'checkout_clangd': True, ")
|
||||
write_file(gclient_path, content, quiet=quiet)
|
||||
change_ct += 1
|
||||
|
||||
print('Downloading clangd...')
|
||||
result = exec_cmd('gclient sync --with_branch_heads --nohooks', src_dir)
|
||||
if len(result['err']) > 0:
|
||||
print('ERROR: gclient sync failed: %s' % result['err'])
|
||||
sys.exit(1)
|
||||
|
||||
if not os.path.isfile(os.path.join(src_dir, COMPILE_COMMANDS_JSON)):
|
||||
if UpdateCompileCommandsJSON(src_dir, out_dir, create=True):
|
||||
change_ct += 1
|
||||
else:
|
||||
sys.exit(1)
|
||||
|
||||
if platform == 'mac':
|
||||
# Setup for lldb.
|
||||
# https://chromium.googlesource.com/chromium/src/+/main/docs/lldbinit.md
|
||||
lldbinit_path = os.path.join(src_dir, LLDBINIT)
|
||||
if os.path.isfile(lldbinit_path):
|
||||
if not options.force_update:
|
||||
print(f'Skipping existing file {LLDBINIT}')
|
||||
else:
|
||||
print(f'Backing up existing file {LLDBINIT}')
|
||||
backup_file(lldbinit_path)
|
||||
|
||||
if not os.path.isfile(lldbinit_path):
|
||||
content = "# So that lldbinit.py takes precedence.\n" \
|
||||
f"script sys.path[:0] = ['{src_dir}/tools/lldb']\n" \
|
||||
"script import lldbinit"
|
||||
write_file(lldbinit_path, content, quiet=quiet)
|
||||
change_ct += 1
|
||||
|
||||
if change_ct == 0:
|
||||
print('No work performed.')
|
||||
else:
|
||||
print(f'Updated {change_ct} files.')
|
||||
|
||||
missing_dirs = []
|
||||
if not debug_out_dir_exists:
|
||||
missing_dirs.append('Debug')
|
||||
if not release_out_dir_exists:
|
||||
missing_dirs.append('Release')
|
||||
|
||||
for dir in missing_dirs:
|
||||
print(
|
||||
f'\nWARNING: A {dir} output directory matching your host architecture ({machine}) does\n'
|
||||
f'not exist. You will not be able to build or run {dir} builds with VSCode.'
|
||||
)
|
||||
|
||||
print(
|
||||
'\nFIRST TIME USAGE INSTRUCTIONS\n\n'
|
||||
'1. Install VSCode (including command-line integration) by following the instructions at'
|
||||
'\n https://code.visualstudio.com/docs/setup/setup-overview'
|
||||
'\n\n2. Launch VSCode with the following console commands:\n\n'
|
||||
f' $ cd {src_dir}\n'
|
||||
' $ code .\n'
|
||||
'\n3. Install recommended VSCode extensions when prompted or by following the instructions at'
|
||||
'\n https://chromium.googlesource.com/chromium/src/+/main/docs/vscode.md#Install-Recommended-Extensions\n'
|
||||
)
|
||||
122
tools/vscode/launch.json.in
Normal file
122
tools/vscode/launch.json.in
Normal file
@ -0,0 +1,122 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "CEF Debug",
|
||||
"type": "{{DEBUGGER}}", // "cppdbg" for GDB/LLDB, "cppvsdbg" for Windows Visual Studio debugger
|
||||
"request": "launch",
|
||||
"program": "${config:cef.outputDirDebug}/${config:cef.launchSampleApp}",
|
||||
"args": [], // Optional command line args
|
||||
"preLaunchTask": "1-build_cef_debug",
|
||||
"stopAtEntry": false,
|
||||
"cwd": "${config:cef.outputDirDebug}/",
|
||||
"environment": [],
|
||||
"console": false,
|
||||
"linux": {
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Enable pretty printing for gdb",
|
||||
"text": "-enable-pretty-printing"
|
||||
},
|
||||
{
|
||||
"description": "Load Chromium gdb configuration",
|
||||
"text": "-interpreter-exec console \"source -v ${workspaceFolder}/tools/gdb/gdbinit\""
|
||||
},
|
||||
{
|
||||
"description": "Load Blink gdb configuration",
|
||||
"text": "-interpreter-exec console \"python import sys; sys.path.insert(0, '${workspaceFolder}/third_party/blink/tools/gdb'); import blink\""
|
||||
}
|
||||
]
|
||||
},
|
||||
"osx": {
|
||||
"MIMode": "lldb",
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Load lldbinit file",
|
||||
"text": "command source ${workspaceFolder}/.lldbinit",
|
||||
"ignoreFailures": false
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "CEF Release",
|
||||
"type": "{{DEBUGGER}}", // "cppdbg" for GDB/LLDB, "cppvsdbg" for Windows Visual Studio debugger
|
||||
"request": "launch",
|
||||
"program": "${config:cef.outputDirRelease}/${config:cef.launchSampleApp}",
|
||||
"args": [], // Optional command line args
|
||||
"preLaunchTask": "2-build_cef_release",
|
||||
"stopAtEntry": false,
|
||||
"cwd": "${config:cef.outputDirRelease}/",
|
||||
"environment": [],
|
||||
"console": false,
|
||||
"linux": {
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Enable pretty printing for gdb",
|
||||
"text": "-enable-pretty-printing"
|
||||
},
|
||||
{
|
||||
"description": "Load Chromium gdb configuration",
|
||||
"text": "-interpreter-exec console \"source -v ${workspaceFolder}/tools/gdb/gdbinit\""
|
||||
},
|
||||
{
|
||||
"description": "Load Blink gdb configuration",
|
||||
"text": "-interpreter-exec console \"python import sys; sys.path.insert(0, '${workspaceFolder}/third_party/blink/tools/gdb'); import blink\""
|
||||
}
|
||||
]
|
||||
},
|
||||
"osx": {
|
||||
"MIMode": "lldb",
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Load lldbinit file",
|
||||
"text": "command source ${workspaceFolder}/.lldbinit",
|
||||
"ignoreFailures": false
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Custom Tests Debug",
|
||||
"type": "{{DEBUGGER}}", // "cppdbg" for GDB/LLDB, "cppvsdbg" for Windows Visual Studio debugger
|
||||
"request": "launch",
|
||||
"program": "${config:cef.outputDirDebug}/${config:cef.launchTestsApp}",
|
||||
"args": [
|
||||
"--use-views",
|
||||
"--gtest_filter=*"
|
||||
],
|
||||
"preLaunchTask": "5-build_tests_debug",
|
||||
"stopAtEntry": false,
|
||||
"cwd": "${config:cef.outputDirDebug}/",
|
||||
"environment": [],
|
||||
"console": true,
|
||||
"linux": {
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Enable pretty printing for gdb",
|
||||
"text": "-enable-pretty-printing"
|
||||
},
|
||||
{
|
||||
"description": "Load Chromium gdb configuration",
|
||||
"text": "-interpreter-exec console \"source -v ${workspaceFolder}/tools/gdb/gdbinit\""
|
||||
},
|
||||
{
|
||||
"description": "Load Blink gdb configuration",
|
||||
"text": "-interpreter-exec console \"python import sys; sys.path.insert(0, '${workspaceFolder}/third_party/blink/tools/gdb'); import blink\""
|
||||
}
|
||||
]
|
||||
},
|
||||
"osx": {
|
||||
"MIMode": "lldb",
|
||||
"setupCommands": [
|
||||
{
|
||||
"description": "Load lldbinit file",
|
||||
"text": "command source ${workspaceFolder}/.lldbinit",
|
||||
"ignoreFailures": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
99
tools/vscode/settings.json.in
Normal file
99
tools/vscode/settings.json.in
Normal file
@ -0,0 +1,99 @@
|
||||
{
|
||||
// Suggested vscode default settings for simplifying initial setup. These
|
||||
// settings are hoped to be convenient and helpful for those beginning to use
|
||||
// vscode with Chrome. Please modify and change as necessary.
|
||||
// All settings are optional, but some more "optional" settings at the end
|
||||
// are disabled by default. Feel free to enable them.
|
||||
// Default tab size of 2, for consistency with internal codebase.
|
||||
"editor.tabSize": 2,
|
||||
// Do not figure out tab size from opening a file.
|
||||
"editor.detectIndentation": false,
|
||||
// Add a line at 80 characters.
|
||||
"editor.rulers": [
|
||||
80
|
||||
],
|
||||
// Except for Java where we add a line at 100 characters per that style guide
|
||||
// and the tab width should be 4 spaces.
|
||||
// The chrome java style guide:
|
||||
// https://chromium.googlesource.com/chromium/src/+/main/styleguide/java/java.md
|
||||
// does not override this and defers to the android style guide:
|
||||
// https://source.android.com/docs/setup/contribute/code-style
|
||||
"[java]": {
|
||||
"editor.rulers": [
|
||||
100
|
||||
],
|
||||
"editor.tabSize": 4
|
||||
},
|
||||
// Forces LF instead of "auto" which uses CRLF on Windows.
|
||||
"files.eol": "\n",
|
||||
// Trim tailing whitespace on save.
|
||||
"files.trimTrailingWhitespace": true,
|
||||
// Insert trimmed final new line.
|
||||
"files.insertFinalNewline": true,
|
||||
"files.trimFinalNewlines": true,
|
||||
"files.associations": {
|
||||
// Adds xml syntax highlighting for grd files.
|
||||
"*.grd": "xml"
|
||||
},
|
||||
"files.exclude": {
|
||||
// Ignore build output folders.
|
||||
"out*/**": true
|
||||
},
|
||||
"files.watcherExclude": {
|
||||
// Don't watch out*/ and third_party/ for changes to fix an issue
|
||||
// where vscode doesn't notice that files have changed.
|
||||
// https://github.com/Microsoft/vscode/issues/3998
|
||||
// There is currently another issue that requires a leading **/ for
|
||||
// watcherExlude. Beware that this pattern might affect other out* folders
|
||||
// like src/cc/output/.
|
||||
"**/out*/**": true,
|
||||
"**/third_party/**": true
|
||||
},
|
||||
// C++ clang format settings. |workspaceFolder| is assumed to be Chromium's
|
||||
// src/ directory.
|
||||
"C_Cpp.clang_format_path": "${workspaceFolder}/third_party/depot_tools/clang-format",
|
||||
"C_Cpp.clang_format_sortIncludes": true,
|
||||
// Avoid conflicts with vscode-clangd extension.
|
||||
"C_Cpp.intelliSenseEngine": "disabled",
|
||||
"editor.formatOnSave": true,
|
||||
"editor.formatOnSaveMode": "modifications",
|
||||
// Don't format HTML files automatically on save, as VSCode's default
|
||||
// formatter doesn't deal well with Chromium Polymer files.
|
||||
"[html]": {
|
||||
"editor.formatOnSave": false
|
||||
},
|
||||
// Disable automatic task detection to speed up opening the task menu.
|
||||
"task.autoDetect": "off",
|
||||
// Used by launch.json and tasks.json for integration with CEF tests and builds.
|
||||
"cef.outputDirDebug": "${workspaceFolder}/out/Debug_GN_{{ARCH}}",
|
||||
"cef.outputDirDebugRelative": "out/Debug_GN_{{ARCH}}",
|
||||
"cef.outputDirRelease": "${workspaceFolder}/out/Release_GN_{{ARCH}}",
|
||||
"cef.outputDirReleaseRelative": "out/Release_GN_{{ARCH}}",
|
||||
// Used by tasks.json for discovery of generated files.
|
||||
"cef.outputDirDefault": "${workspaceFolder}/out/{{DEFAULT}}_GN_{{ARCH}}",
|
||||
// Used by launch.json for launching apps.
|
||||
"cef.launchSampleApp": "{{SAMPLEAPP}}",
|
||||
"cef.launchTestsApp": "{{TESTSAPP}}",
|
||||
// Path installed by Chromium.
|
||||
"clangd.path": "${workspaceFolder}/third_party/llvm-build/Release+Asserts/bin/clangd{{EXEEXT}}",
|
||||
// Optional: Wider author column for annotator extension.
|
||||
// https://marketplace.visualstudio.com/items?itemName=ryu1kn.annotator
|
||||
// "annotator.annotationColumnWidth": "24em",
|
||||
// Optional: Highlight current line at the left of the editor.
|
||||
// "editor.renderLineHighlight": "gutter",
|
||||
// Optional: Don't automatically add closing brackets. It gets in the way.
|
||||
// "editor.autoClosingBrackets": "never",
|
||||
// Optional: Enable a tiny 30k feet view of your doc.
|
||||
// "editor.minimap.enabled": true,
|
||||
// "editor.minimap.maxColumn": 80,
|
||||
// "editor.minimap.renderCharacters": false,
|
||||
// Optional: Don't continuously fetch remote changes.
|
||||
"git.autofetch": false
|
||||
// Optional: Do not open files in 'preview' mode. Opening a new file in can
|
||||
// replace an existing one in preview mode, which can be confusing.
|
||||
//"workbench.editor.enablePreview": false,
|
||||
// Optional: Same for files opened from quick open (Ctrl+P).
|
||||
//"workbench.editor.enablePreviewFromQuickOpen": false,
|
||||
// Optional: Enable Python type checking.
|
||||
//"python.analysis.typeCheckingMode": "basic"
|
||||
}
|
||||
175
tools/vscode/tasks.json
Normal file
175
tools/vscode/tasks.json
Normal file
@ -0,0 +1,175 @@
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"runner": "terminal",
|
||||
// The default problem matcher matches build output, which is useful for most tasks.
|
||||
"problemMatcher": [
|
||||
// Matches output from clang.
|
||||
{
|
||||
"owner": "cpp",
|
||||
"fileLocation": ["relative", "${config:cef.outputDirDefault}"],
|
||||
"pattern": {
|
||||
"regexp": "^(gen/.*):(\\d+):(\\d+):\\s+(warning|\\w*\\s?error):\\s+(.*)$",
|
||||
"file": 1, "line": 2, "column": 3, "severity": 4, "message": 5
|
||||
}
|
||||
},
|
||||
{
|
||||
"owner": "cpp",
|
||||
"fileLocation": ["relative", "${workspaceFolder}"],
|
||||
"pattern": {
|
||||
"regexp": "^../../(.*):(\\d+):(\\d+):\\s+(warning|\\w*\\s?error):\\s+(.*)$",
|
||||
"file": 1, "line": 2, "column": 3, "severity": 4, "message": 5
|
||||
}
|
||||
},
|
||||
// Matches output from clang-cl / msvc.
|
||||
{
|
||||
"owner": "cpp",
|
||||
"fileLocation": [
|
||||
"relative",
|
||||
"${config:cef.outputDirDefault}"
|
||||
],
|
||||
"pattern": {
|
||||
"regexp": "^(gen/.*)\\((\\d+),(\\d+)\\):\\s+(warning|\\w*\\s?error):\\s+(.*)$",
|
||||
"file": 1,
|
||||
"line": 2,
|
||||
"column": 3,
|
||||
"severity": 4,
|
||||
"message": 5
|
||||
}
|
||||
},
|
||||
{
|
||||
"owner": "cpp",
|
||||
"fileLocation": [
|
||||
"relative",
|
||||
"${workspaceFolder}"
|
||||
],
|
||||
"pattern": {
|
||||
"regexp": "^../../(.*)\\((\\d+),(\\d+)\\):\\s+(warning|\\w*\\s?error):\\s+(.*)$",
|
||||
"file": 1,
|
||||
"line": 2,
|
||||
"column": 3,
|
||||
"severity": 4,
|
||||
"message": 5
|
||||
}
|
||||
},
|
||||
{
|
||||
"owner": "cpp",
|
||||
"fileLocation": ["relative", "${config:cef.outputDirDefault}"],
|
||||
"pattern": {
|
||||
"regexp": "^(gen/.*?):(.*):\\s+(warning|\\w*\\s?error):\\s+(.*)$",
|
||||
"file": 1, "severity": 3, "message": 4
|
||||
}
|
||||
},
|
||||
{
|
||||
"owner": "cpp",
|
||||
"fileLocation": ["relative", "${workspaceFolder}"],
|
||||
"pattern": {
|
||||
"regexp": "^../../(.*?):(.*):\\s+(warning|\\w*\\s?error):\\s+(.*)$",
|
||||
"file": 1, "severity": 3, "message": 4
|
||||
}
|
||||
}
|
||||
],
|
||||
"options": {
|
||||
// It's important to set the CWD to the output directory so that file paths
|
||||
// are linked correctly in the terminal output.
|
||||
"cwd": "${config:cef.outputDirDefault}",
|
||||
"env": {
|
||||
// If depot_tools aren't already available in the PATH provided to vscode,
|
||||
// you can configure it in the next line.
|
||||
// "PATH": "<DEPOT_TOOLS_LOCATION>:${env:PATH}"
|
||||
// Alternatively, if you have configured depot_tools for ChromiumIDE, you
|
||||
// can just uncomment the following line:
|
||||
// "PATH": "${config:chromiumide.paths.depotTools}:${env:PATH}"
|
||||
}
|
||||
},
|
||||
|
||||
"inputs": [
|
||||
{
|
||||
"type": "pickString",
|
||||
"id": "cefOutputDir",
|
||||
"description": "CEF output directory:",
|
||||
// Configure this to point to all the output directories you use (as a
|
||||
// relative path from ${workspaceFolder}).
|
||||
"options": [
|
||||
"${config:cef.outputDirDebugRelative}",
|
||||
"${config:cef.outputDirReleaseRelative}"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tasks": [
|
||||
// * If you want to be prompted for the output directory each
|
||||
// time you run a command, replace
|
||||
// ${config:cef.outputDir[Debug|Release]}
|
||||
// with
|
||||
// ${input:cefOutputDir}
|
||||
//
|
||||
// * If you want to have different tasks for different output directories,
|
||||
// just create duplicate tasks and hard-code the output directory used.
|
||||
{
|
||||
"label": "1-build_cef_debug",
|
||||
"type": "shell",
|
||||
"command": "autoninja",
|
||||
"args": [
|
||||
"-C",
|
||||
"${config:cef.outputDirDebug}",
|
||||
"cef"
|
||||
],
|
||||
"group": {
|
||||
"kind": "build",
|
||||
"isDefault": true
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "2-build_cef_release",
|
||||
"type": "shell",
|
||||
"command": "autoninja",
|
||||
"args": [
|
||||
"-C",
|
||||
"${config:cef.outputDirRelease}",
|
||||
"cef"
|
||||
],
|
||||
"group": {
|
||||
"kind": "build"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "3-build_current_file_debug",
|
||||
"type": "shell",
|
||||
"command": "compile_single_file",
|
||||
"args": [
|
||||
"--build-dir=${config:cef.outputDirDebug}",
|
||||
"--file-path=${file}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "4-build_current_file_release",
|
||||
"type": "shell",
|
||||
"command": "compile_single_file",
|
||||
"args": [
|
||||
"--build-dir=${config:cef.outputDirRelease}",
|
||||
"--file-path=${file}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "5-build_tests_debug",
|
||||
"type": "shell",
|
||||
"command": "autoninja",
|
||||
"args": [
|
||||
"-C",
|
||||
"${config:cef.outputDirDebug}",
|
||||
"ceftests",
|
||||
"libcef_static_unittests"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "6-build_tests_release",
|
||||
"type": "shell",
|
||||
"command": "autoninja",
|
||||
"args": [
|
||||
"-C",
|
||||
"${config:cef.outputDirRelease}",
|
||||
"ceftests",
|
||||
"libcef_static_unittests"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user