Compilando o Kate a partir do código-fonte no Linux

Atualmente, o código-fonte do Kate está localizado na instância do GitLab invent.kde.org. Este tutorial explica como compilar o Kate sem alterar sua instalação global.

Tudo acontecerá dentro de uma pasta de desenvolvimento extra. Isso evita a necessidade de direitos de administrador e permite sempre usar o Kate instalado globalmente caso a versão atual esteja corrompida.

Como este tutorial apresentará uma configuração que permite desenvolver outras partes da pilha de software do KDE, falaremos a seguir sobre a configuração de um ambiente de desenvolvimento KDE. Os Frameworks KDE necessários serão compilados além das partes do aplicativo Kate. Isso facilita as contribuições para todos os níveis da pilha de software do KDE.

Escolha sua pasta de desenvolvimento do Kate e do KDE

Escolha um caminho para onde todos os recursos de desenvolvimento do Kate e do KDE devem ser colocados. Além dos arquivos de configuração local do usuário, nada fora desta pasta será poluído. Você pode reutilizá-la para desenvolvimento em qualquer parte da pilha de software do KDE.

Para as partes restantes desta descrição usamos

~/projects/kde

Sinta-se à vontade para personalizar isso.

Instale o kdesrc-build

Instalar é mais ou menos apenas clonar a versão atual

mkdir -p ~/projects/kde/src
cd ~/projects/kde/src
git clone https://invent.kde.org/sdk/kdesrc-build.git

Para facilitar o uso posterior, é melhor criar um link simbólico do script kdesrc-build para alguma pasta dentro do seu caminho, por exemplo, se você tiver alguma pasta local do usuário:

ln -s ~/projects/kde/src/kdesrc-build/kdesrc-build ~/bin

Configurar o kdesrc-build

O kdesrc-build possui um passo de configuração que pode configurar algumas coisas para você. Veja esta introdução.

Aqui mostramos apenas um ~/.config/kdesrc-buildrc que é bom o suficiente para as necessidades de desenvolvimento do Kate.

Você pode simplesmente copiar e colar a variante abaixo na sua pasta pessoal como ~/.config/kdesrc-buildrc e adaptar os caminhos às suas necessidades. Se você mantiver o caminho ~/projects/kde que escolhemos acima, ele deverá ser utilizável 1:1.

global
    # use o software mais recente baseado em KF6 e Qt6.
    branch-group kf6-qt6

    # use o ninja para uma recompilação incremental mais rápida, desative algumas coisas do Qt 5
    # para ter menos dependências
    cmake-options -G "Ninja" -DBUILD_WITH_QT6=ON -DQT_MAJOR_VERSION=6 -DPHONON_BUILD_QT5=OFF -DBUILD_QT5=OFF

    # ferramentas clangd
    compile-commands-export yes
    compile-commands-linking yes

    # estrutura plana
    directory-layout flat

    # Pasta de instalação para software KDE
    install-dir ~/projects/kde/usr

    # Pasta para baixar o código-fonte
    source-dir ~/projects/kde/src

    # Pasta para compilar o KDE antes da instalação em relação à pasta de origem por padrão
    build-dir ~/projects/kde/build
end global

include ${module-definitions-dir}/kf6-qt6.ksb

As linhas importantes para ter uma boa experiência desenvolvendo o Kate (ou outras coisas do KDE) com o Kate são descritas abaixo em detalhes.

Integração LSP

# ferramentas clangd
compile-commands-export yes
compile-commands-linking yes

Essas linhas garantem que o CMake gerará os arquivos compile_commands.json necessários para a integração com LSP baseada em clangd. Além de gerá-los dentro da pasta de compilação, a opção de vinculação os vinculará simbolicamente às suas pastas de origem. Isso permite o uso do plugin LSP sem configuração dentro do Kate (e outros editores).

Instale as dependências necessárias (opcional)

O kdesrc-build fornece um modo de configuração inicial para instalar os pacotes necessários para várias distribuições comuns para iniciar o desenvolvimento. Isso é útil se você não tiver certeza se todos os pacotes de desenvolvimento necessários estão instalados no seu sistema e não quiser cuidar disso manualmente. Como isso tentará instalar pacotes para sua distribuição, esta etapa exigirá direitos de administrador para a instalação dos pacotes. Para fazer isso, basta acionar:

kdesrc-build --initial-setup

Já criamos um arquivo .config/kdesrc-buildrc, que permanecerá inalterado. Para uso posterior, você também não precisa modificar as configurações do seu shell.

Compile o Kate e suas dependências

Para iniciar a compilação do Kate e de todas as dependências necessárias do KDE, basta digitar:

kdesrc-build --include-dependencies kate

Isso leva alguns minutos em uma máquina recente. Hora de tomar um café ou pensar no que você realmente quer implementar.

Contanto que a versão KF 6 de nossas dependências não esteja incluída na sua distribuição, pode fazer sentido construir mais algumas partes para ter um estilo melhor e uma integração de terminal:

kdesrc-build --include-dependencies breeze plasma-integration kwayland-integration konsole kate

Se você deseja apenas compilar o Kate sem as dependências porque tem certeza de que possui material recente o suficiente no seu sistema, você pode tentar:

kdesrc-build --no-include-dependencies kate

Mas, considerando que em máquinas modernas os tempos de compilação são baixos, é mais conveniente simplesmente compilar tudo, o que garante que você tenha, por exemplo, os melhores e mais recentes frameworks KSyntaxHighlighting e KTextEditor disponíveis também!

Dada essa configuração, você está livre para construir todas as partes do software KDE com um simples:

kdesrc-build

Lembre-se: isso levará algum tempo (e espaço em disco).

Se durante a compilação você vir alguma falha exibida em fonte vermelha, siga este guia - Como resolver problemas de compilação

Como usar o material compilado?

Para iniciar sua versão local do Kate, você precisa primeiro configurar o ambiente corretamente para garantir que os plugins e recursos corretos sejam carregados. Felizmente, isso é muito simples:

source ~/projects/kde/build/kate/prefix.sh
kate

Uma maneira bacana de fazer isso é, por exemplo, criar um pequeno script wrapper para iniciar sua versão do branch master do Kate dentro da sua pasta bin local:

#!/bin/bash
source ~/projects/kde/build/kate/prefix.sh
exec kate "$@"

Mantenha suas coisas atualizadas

Para manter sua versão local atualizada, você pode simplesmente usar os comandos acima novamente. Eles se encarregarão de extrair as novas alterações dos repositórios do KDE e compilá-las/instalá-las no seu prefixo local.

Desenvolva!

Agora, a questão que resta é: como desenvolver melhor?

Naturalmente, se você quiser hackear o Kate, pode fazer sentido usar o Kate para isso.

Dadas as preparações acima, isso é fácil de fazer: basta iniciar sua nova versão master do Kate e passar a ela a pasta de compilação:

kate ~/projects/kde/build/kate

Alternativamente, você pode navegar até lá no seu terminal e iniciar o Kate a partir daí, ele será aberto automaticamente:

cd ~/projects/kde/build/kate
kate

Para ter a melhor experiência possível, certifique-se de ter pelo menos o projeto e o plugin LSP habilitados. Se você quiser ter alguma integração de compilação com a interface gráfica, ative o plugin de compilação também.

Você terminará com uma nova janela do Kate como mostrado abaixo.

Na visualização inferior da ferramenta "Projeto Atual", você tem, por padrão, dois terminais. O primeiro terminal está dentro da sua pasta de compilação, onde você pode, por exemplo, executar seus comandos ninja e ninja install e similares. O segundo terminal está dentro da sua pasta de origem, perfeito para, por exemplo, chamadas de linha de comando do git.

Dada a configuração acima, o plugin LSP (se você tiver o clangd instalado) deve funcionar imediatamente.

Outras coisas interessantes, como abertura rápida do projeto, busca e substituição, e alvos de compilação corretos, também devem ser configurados.

Contribua!

Sinta-se à vontade para criar uma solicitação de mesclagem em invent.kde.org. Para mais informações, consulte [Junte-se a nós](/join-us /).

Precisa de suporte?

Se tiver dúvidas, você pode perguntar na nossa seção Kate no servidor de discussão do KDE e/ou participar do nosso canal Matrix do Kate (mais informações gerais sobre Matrix e KDE aqui).

Para mais informações, consulte Obter ajuda.

Compilando o Kate a partir do código-fonte no Windows

Para compilar o Kate/KWrite baseado no KF5, você pode seguir o guia em KDE no Windows.

Compilando o Kate a partir do código-fonte no macOS

Para compilar o Kate/KWrite baseado no KF5, você pode seguir o guia em KDE no macOS.