Qt Creator terminal integration

[cristianadam]

Qt Creator 11 will get terminal integration. I would like to have the best clink support out of the box.

Currently there are two issues:

1. The light theming is not working nicely with clink
2. The shell integration (mostly getting current directory) is missing

See the screencast below:

The shell integration we took (MIT licensed) from VS Code https://github.com/microsoft/vscode/tree/main/src/vs/workbench/contrib/terminal/browser/media

How should Qt Creator change the environment where cmd.exe is launched? So that the user wouldn't have to change the clink configuration by him/herself.

[chrisant996]

Re: "light theme" -- see the (long) discussion in #256.

Re: "shell integration so the user doesn't have to configure Clink" -- I think you mean you want a default "shell integration" in case the user hasn't configured Clink at all yet. I don't think you should try to override/replace user configuration.

Can you describe what kinds of shell integration are desired?

If you just want to set a default prompt string, that's not a Clink question, it's a CMD question. Run prompt /? for some info.

[cristianadam]

Qt Creator just reacts on the OSC codes when they come. I think the timing is not important.

Also the console output is not affected by this information. When the OSC codes are received then the appropriate UI elements would be updated.

[chrisant996]

The Qt Creator shell integration part is done at https://github.com/qt-creator/qt-creator/blob/master/src/plugins/terminal/shellintegration.cpp#L70 and it covers the current directory / current command line.

Ah, interesting. Most of the escape codes from the vscode shell integration scripts are ignored (e.g. ESC]633; followed by A, B, F, G, H, or I) -- those are the codes where the "timing vs position" question is relevant, but none of them are handled by Qt Creator, so the question ends up moot. 😎

That simplifies things. So it's really just the D and P;Cwd= codes. See the example scripts I shared in my previous reply. And the other codes could even be removed from the scripts.

[cristianadam]

I'll try it out next days and provide feedback. Thank you for the support!

[chrisant996]

@cristianadam Oh! It's even easier! Since Qt Creator only wants exit code and cwd, that's already fully possible with Clink as-is, for probably at least a year.

Instead of using a prompt filter, just use onbeginedit:

local function send_codes()
    local codes = ""
    codes = codes .. "\027]633;D;" .. os.geterrorlevel() .. "\a" -- send command exit code
    codes = codes .. "\027]633;P;Cwd=" .. os.getcwd() .. "\a" -- send cwd as title
    clink.print(codes, NONL)
end

clink.onbeginedit(send_codes)

And use the example .cmd script from the earlier reply to load the Lua script.

[chrisant996]

I've made a script for vscode shell integration, which I'll publish in the clink-gizmos repo soon.

Here it is. Presumably Qt Creator will set %TERM_PROGRAM% to something else, so you could model a script after this, checking for something other than "vscode".

Important: Be sure to rename the gizmo_vscode_shell_integration variable, so that your script doesn't collide with this one.

-- luacheck: globals gizmo_vscode_shell_integration NONL
if gizmo_vscode_shell_integration == nil then
    gizmo_vscode_shell_integration = true
end

if not gizmo_vscode_shell_integration then
    return
end

local function is_vscode()
    local term_program = os.getenv("term_program") or ""
    if term_program:lower() == "vscode" then
        return true
    end
end

local function send_context()
    if is_vscode() then
        local codes = ""
        codes = codes .. "\027]633;D;" .. os.geterrorlevel() .. "\a" -- send command exit code
        codes = codes .. "\027]633;P;Cwd=" .. os.getcwd() .. "\a" -- send cwd as title
        clink.print(codes, NONL)
    end
end

local p = clink.promptfilter(-999)

function p:filter() -- luacheck: no unused
    -- Nothing to do here, but the filter function must be defined.
end

function p:surround() -- luacheck: no unused
    if is_vscode() then
        local pre, suf
        local rpre, rsuf

        -- ESC codes surrounding prompt string
        pre = "\027]633;A\a" -- copied from shellIntegration-rc.zsh
        suf = "\027]633;B\a" -- copied from shellIntegration-rc.zsh

        -- ESC codes surrounding right side prompt string
        rpre = "\027]633;H\a" -- copied from shellIntegration-rc.zsh
        rsuf = "\027]633;I\a" -- copied from shellIntegration-rc.zsh

        return pre, suf, rpre, rsuf
    end
end

clink.onbeginedit(send_context)

[cristianadam]

[chrisant996]

Glad you got it working.