chromium/src

Fork 0

Files

android_webview

apps

ash

base

build

build_overrides

buildtools

chrome

chromecast

chromeos

clank

codelabs

components

content

crypto

dbus

device

docs

accessibility

autofill

chromeos

design

enterprise

experiments

fuchsia

gpu

graphics

images

infra

intl

ios

linux

mac

media

memory

memory-infra

patterns

privacy

privacy_budget

process

security

speed

speed_metrics

standards

telemetry_extension

testing

transcripts

updater

webapps

website

webui

workflow

DIR_METADATA

OWNERS

README.md

accessibility.md

ad_tagging.md

adding_to_third_party.md

android_accessing_cpp_enums_in_java.md

android_accessing_cpp_features_in_java.md

android_accessing_cpp_switches_in_java.md

android_build_instructions.md

android_cast_build_instructions.md

android_debugging_instructions.md

android_dynamic_feature_modules.md

android_emulator.md

android_isolated_splits.md

android_jni_ownership_best_practices.md

android_logging.md

android_native_libraries.md

android_studio.md

angle_in_chromium.md

api_keys.md

asan.md

atom.md

benchmark_performance_regressions.md

bfcache.md

bitmap_pipeline.md

branch_gardener.md

building_old_revisions.md

callback.md

ccache_mac.md

chrome_browser_design_principles.md

chrome_os_logging.md

chrome_settings.md

chromedriver_status.md

chromeos_build_instructions.md

chromeos_glossary.md

chromium_browser_vs_google_chrome.md

cipd_and_3pp.md

cl_respect.md

cl_tips.md

clang.md

clang_code_coverage_wrapper.md

clang_format.md

clang_gardening.md

clang_sheriffing.md

clang_static_analyzer.md

clang_tidy.md

clang_tool_refactoring.md

clangd.md

clion.md

closure_compilation.md

cocoa_tips_and_tricks.md

code_review_owners.md

code_reviews.md

commit_checklist.md

component_build.md

configuration.md

contributing.md

cq_fault_attribution.md

cr_respect.md

cr_user_manual.md

cross_platform_ui.md

cygwin_dll_remapping_failure.md

dangling_ptr.md

dangling_ptr_guide.md

dbus_mojo_connection_service.md

debugging_with_crash_keys.md

dependencies.md

deterministic_builds.md

disassemble_code.md

documentation_best_practices.md

documentation_guidelines.md

early-hints.md

eclipse.md

emacs.md

erc_irc.md

flag_expiry.md

flag_guarding_guidelines.md

flag_ownership.md

frame_trees.md

gardener.md

gcs_dependencies.md

gdbinit.md

gerrit_guide.md

get_the_code.md

git_cookbook.md

git_submodules.md

git_tips.md

google_chrome_branded_builds.md

google_play_services.md

graphical_debugging_aid_chromium_views.md

gwp_asan.md

history_manipulation_intervention.md

how_cc_works.md

how_to_add_your_feature_flag.md

how_to_extend_web_test_framework.md

idn.md

initialize_blink_features.md

inlined_stack_traces.md

installation_at_vmware.md

ios_build_instructions.md

ios_infra.md

ios_voiceover.md

kiosk_mode.md

life_of_a_frame.md

lldbinit.md

mac_arm64.md

mac_build_instructions.md

mac_lld.md

modifying_session_history_serialization.md

modules.md

mojo_and_services.md

mojo_ipc_conversion.md

mojo_testing.md

native_relocations.md

navbar.md

navigation-request-navigation-state.gv

navigation-request-navigation-state.png

navigation.md

navigation_concepts.md

network_traffic_annotations.md

no_sources_assignment_filter.md

orderfile.md

origin_trials_integration.md

ozone_overview.md

parsing_test_results.md

pgo.md

piranha_plant.md

process_model_and_site_isolation.md

profiling.md

profiling_content_shell_on_android.md

proxy_auto_config.md

qtcreator.md

release_branch_guidance.md

render-frame-host-lifecycle-state.gv

render-frame-host-lifecycle-state.png

render_document.md

rust-ffi.md

rust.md

seccomp_sandbox_crash_dumping.md

servicification.md

session_history.md

sheriff.md

shutdown.md

special_case_urls.md

static_initializers.md

sublime_ide.md

system_hardening_features.md

tab_helpers.md

threading_and_tasks.md

threading_and_tasks_faq.md

threading_and_tasks_testing.md

toolchain_support.md

tour_of_luci_ui.md

tpm_quick_ref.md

translation_screenshots.md

unretained_dangling_ptr_guide.md

unsafe_buffers.md

updating_clang.md

updating_clang_format_binaries.md

use_counter_wiki.md

useful_urls.md

user_data_dir.md

user_data_storage.md

user_handle_mapping.md

vanilla_msysgit_workflow.md

vscode.md

vscode_python.md

webview_policies.md

win_cross.md

win_order_files.md

windows_build_instructions.md

windows_native_window_occlusion_tracking.md

windows_pwa_integration.md

windows_shortcut_and_taskbar_handling.md

windows_split_dll.md

windows_virtual_desktop_handling.md

wmax_tokens.md

working_remotely_with_android.md

writing_clang_plugins.md

extensions

fuchsia_web

gin

google_apis

gpu

headless

infra

internal

ios

ios_internal

ipc

media

mojo

native_client

native_client_sdk

net

pdf

ppapi

printing

remoting

rlz

sandbox

services

signing_keys

skia

sql

storage

styleguide

testing

third_party

tools

url

webkit

.clang-format

.clang-tidy

.clangd

.git-blame-ignore-revs

.gitallowed

.gitattributes

.gitignore

.gitmodules

.gn

.mailmap

.rustfmt.toml

.vpython3

.yapfignore

ATL_OWNERS

AUTHORS

BUILD.gn

CODE_OF_CONDUCT.md

CPPLINT.cfg

CRYPTO_OWNERS

DEPS

DIR_METADATA

LICENSE

LICENSE.chromium_os

OWNERS

PRESUBMIT.py

PRESUBMIT_test.py

PRESUBMIT_test_mocks.py

README.md

WATCHLISTS

codereview.settings

John Palmer 046f987e02 [COIL] Change chromium code search type links to use main rather than master for docs

See this doc: go/chromium-coil-change for more info
    BUG=1210385

Change-Id: I6cd8548301e360bae8e71384dbd8ef11aa6c985f
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2902904
Reviewed-by: My Nguyen <myy@chromium.org>
Commit-Queue: My Nguyen <myy@chromium.org>
Auto-Submit: John Palmer <jopalmer@chromium.org>
Cr-Commit-Position: refs/heads/master@{#885851}

2021-05-24 01:24:56 +00:00

5.1 KiB

Raw Blame History

Use Qt Creator as an IDE or debugger UI

Qt Creator (Wiki) is a cross-platform C++ IDE.

You can use Qt Creator as a daily IDE on Linux or Mac, or just as a GDB/LLDB frontend (which does not require project configuration).

[TOC]

IDE

Workflow features

Built-in code completion.
Navigate to classes, files, or symbols with ctrl+k or cmd+k (macOS).
Switch between declaration and definition with F2.
Build with ctrl+shift+b or shift+cmd+b (macOS).
Build and run with ctrl+r or cmd+r (macOS), or debug with F5.
Switch between the header file and cpp file with F4.

Setup

Install the latest Qt Creator.
Under chromium/src gn gen out/Default --ide=qtcreator.
Start it with qtcreator out/Default/qtcreator_project/all.creator.
Help - Plugins - check ClangCodeModel to enable std completion.

It takes 3 minutes to parse all of chromium's C++ files on my workstation!!! And it does not block while parsing.

Code Style

Help - About Plugins (or app menu on macOS), enable Beautifier.
Tools - Options (Preferences on macOS) - Beautifier Make sure to tick - Enable auto format on file save" Select ClangFormat as the tool Go to Clang Format tab Change the Clang format command to: $chromium_checkout_dir/src/buildtools/$os/clang-format, and set Use predefined style: file. You can also set a keyboard shortcut for it.
Tools - Options - C++ - Code Style, import this xml file.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE QtCreatorCodeStyle>
<!-- Written by QtCreator 4.2.1, 2017-02-08T19:07:34. -->
<qtcreator>
 <data>
  <variable>CodeStyleData</variable>
  <valuemap type="QVariantMap">
   <value type="bool" key="AlignAssignments">true</value>
   <value type="bool" key="AutoSpacesForTabs">false</value>
   <value type="bool" key="BindStarToIdentifier">false</value>
   <value type="bool" key="BindStarToLeftSpecifier">false</value>
   <value type="bool" key="BindStarToRightSpecifier">false</value>
   <value type="bool" key="BindStarToTypeName">true</value>
   <value type="bool"
     key="ExtraPaddingForConditionsIfConfusingAlign">true</value>
   <value type="bool" key="IndentAccessSpecifiers">true</value>
   <value type="bool" key="IndentBlockBody">true</value>
   <value type="bool" key="IndentBlockBraces">false</value>
   <value type="bool" key="IndentBlocksRelativeToSwitchLabels">false</value>
   <value type="bool" key="IndentClassBraces">false</value>
   <value type="bool" key="IndentControlFlowRelativeToSwitchLabels">true</value>
   <value type="bool"
     key="IndentDeclarationsRelativeToAccessSpecifiers">false</value>
   <value type="bool" key="IndentEnumBraces">false</value>
   <value type="bool" key="IndentFunctionBody">true</value>
   <value type="bool" key="IndentFunctionBraces">false</value>
   <value type="bool" key="IndentNamespaceBody">false</value>
   <value type="bool" key="IndentNamespaceBraces">false</value>
   <value type="int" key="IndentSize">2</value>
   <value type="bool" key="IndentStatementsRelativeToSwitchLabels">true</value>
   <value type="bool" key="IndentSwitchLabels">false</value>
   <value type="int" key="PaddingMode">2</value>
   <value type="bool" key="ShortGetterName">true</value>
   <value type="bool" key="SpacesForTabs">true</value>
   <value type="int" key="TabSize">2</value>
  </valuemap>
 </data>
 <data>
  <variable>DisplayName</variable>
  <value type="QString">chrome</value>
 </data>
</qtcreator>

Build & Run

(Optional) Enable the issues pane for easy navigation to the location of compiler errors. qtcreator expects to find compiler errors on stderr, but ninja forwards all subcommand output to stdout. So use the following wrapper script to forward it to stderr instead.

#!/bin/sh
/path/to/depot_tools/ninja "$@" >&2

In the left panel - Projects, set up the ninja command in the build and clean steps, and add the path to chrome in the run configuration.

Debugger

You can skip the project settings and use QtCreator as a single file standalone GDB or LLDB (macOS) frontend.

For macOS :

Open the file you want to debug.
Debug - Start Debugging - Attach to running Application, you may need to open chromium's task manager to find the process id.

For Linux :

Tools - Options - Build & Run - Debuggers, make sure GDB is set.
Tools - Options - Kits, change the Desktop kit to GDB (LLDB doesn't work on Linux).
Open the file you want to debug.
Debug - Start Debugging - Attach to running Application, you may need to open chromium's task manager to find the process id.

Tips, tricks, and troubleshooting

[Linux] The debugger exits immediately

Ensure yama allows you to attach to another process:

$ echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope

[Linux] The debugger does not stop on breakpoints

Ensure you are using GDB on Linux, not LLDB.

Linux : See https://chromium.googlesource.com/chromium/src/+/main/docs/linux/debugging.md

macOS : https://chromium.googlesource.com/chromium/src/+/main/docs/mac/debugging.md

5.1 KiB Raw Blame History