VSCode extension: unreal-clangd v3.0.0 Fast code completion

Development Programming & Scripting C++
,
1
    1. v3.0.0 changes
    1. Quick start link
    1. Documentation links
    1. How it works

https://github.com/boocs/unreal-clangd

Note: v3.0.0 has breaking change from previous versions. See here

v3.0.0 changes

  • Big code organization, new yeoman extension skeleton, strict eslint
  • Adds toggle button bottom right(UC) for code completion modes
    • UC⚡(fast) = Non-macro completions and the most popular macro completions
    • UC⌚(slow) = Non-macro completions and almost all macro completions
  • Removed extension’s completion file, completionHelper.cpp, loading at startup
  • command: Set custom system includes (Windows only)
    • Allows you to set Windows SDK and C++ library versions that clang uses
    • Also autoruns command when creating extension project
    • On VSCode start, detects and shows warning if not set
      • Setting: “unreal-clangd.systemIncludes.showMissingWarning” to false to remove warning
  • command: Show Project Info
  • command: Open 'Add Completions' Files
    • Allows you to customize code completions that aren’t added by default
    • addCompletions.h
      • Can add headers to add non-macro completion
      • Doesn’t affect code completion file loading speed
    • addMacroCompletions.h
      • Can add headers to add non-macro and macro completions
      • Will affect code completion file loading speed
  • Warns, on startup, when project was not refreshed correctly
  • Note: Unreal source file support status is changed to partial
    • Looking at future updates for better support (hopefully)

Quick start

Documentation

Both contain useful info:

How it works

Toggle completion modes

  • Button on the bottom right called UC
  • UC⚡(fast) = Non-macro completions and the most popular macro completions
  • UC⌚(slow) = Non-macro completions and almost all macro completions

Unreal project code completion

  • Unreal creates code completion by creating a huge header file and pre-parse including it
  • Pre-parse include just means to include a header indirectly
  • When formed into a PCH file this file is ~2 GB
  • This is why code completion file loading is slow
  • This supports non-macro and macro code completions

Native clangd code completion

  • Fast
  • Doesn’t support macro code completions*
    • All completions are supported when you include a file directly or indirectly with pre-parse includes
      • Any completions in the header chain will be added

Extension code completion

  • Fast mode - Use Native clangd completions for most non-macro code completions and also includes the most popular macro completions using pre-parse includes.

  • Slow mode - All pre-parse includes enabled so most non-macro and macros will work

Configure

  • You can add additional completions using the files:
    • addCompletions.h
    • addMacroCompletions.h
  • Use the command: Open 'Add Completions' Files (regular and macro)
    • This will open both files

https://github.com/boocs/unreal-clangd