Sestavení Kate ze zdrojových souborů v Linuxu

V současné době je zdrojový kód aplikace Kate uložen na instanci GitLabu invent.kde.org. Tento návod vysvětluje, jak sestavit aplikaci Kate, aniž byste zasahovali do své globální instalace.

Všechny úkony budou probíhat v samostatném vývojovém adresáři. Tím se vyhneme nutnosti mít práva správce a vždy budeme moci přejít na globálně nainstalovanou aplikaci Kate, pokud by aktuálně sestavená verze nefungovala správně.

Jelikož tento návod představí konfiguraci, která umožňuje vyvíjet i další části softwarové platformy KDE, budeme se v následujícím textu zabývat nastavením vývojového prostředí KDE. Kromě částí aplikace Kate budou zkompilovány i potřebné KDE Frameworks. To usnadňuje přispívání do všech úrovní softwarové platformy KDE.

Vyberte si vývojový adresář pro Kate & KDE

Vyberte si nějaký adresář, do kterého by měly směřovat všechny soubory související s vývojem Kate a KDE. Kromě lokálních konfiguračních souborů uživatelů nebude nic mimo tento adresář znečištěno. Tento adresář můžete znovu použít pro vývoj jakékoli části softwarové sady KDE.

Použijeme ve zbývající části tohoto popisu

~/projects/kde

Můžete si to klidně přizpůsobit podle sebe.

Instalace kdesrc-build

Instalace spočívá víceméně jen v naklonování aktuální verze

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

Pro snazší používání v budoucnu je nejlepší vytvořit symbolický odkaz na skript kdesrc-build do nějaké složky v cestě, např. pokud máte nějakou uživatelskou lokální složku bin:

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

Nastavení kdesrc-build

kdesrc-build obsahuje několik kroků nastavení, které za vás mohou provést konfiguraci; viz tento úvod.

Zde uvádíme pouze soubor ~/.config/kdesrc-buildrc, který je pro potřeby vývoje aplikace Kate zcela dostačující.

Stačí zkopírovat a vložit níže uvedenou variantu do svého domovského adresáře jako ~/.config/kdesrc-buildrc a upravit cesty podle svých potřeb. Pokud se budete držet cesty ~/projects/kde, kterou jsme zvolili výše, mělo by to fungovat beze změn.

global
    # používejte nejnovější software založený na KF6 a Qt6.
    branch-group kf6-qt6

    # používejte ninja pro rychlejší inkrementální kompilaci, vypněte některé funkce Qt 5, abyste
    # snížili počet závislostí
    cmake-options -G "Ninja" -DBUILD_WITH_QT6=ON -DQT_MAJOR_VERSION=6 -DPHONON_BUILD_QT5=OFF -DBUILD_QT5=OFF

    # nástroje clangd
    compile-commands-export yes
    compile-commands-linking yes

    # plochá struktura
    directory-layout flat

    # Instalační adresář pro software KDE
    install-dir ~/projects/kde/usr

    # Adresář pro stažený zdrojový kód
    source-dir ~/projects/kde/src

    # Adresář, do kterého se má KDE zkompilovat před instalací; ve výchozím nastavení je relativní k
    # adresáři se zdrojovými soubory
    build-dir ~/projects/kde/build
end global

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

Níže jsou podrobně popsány důležité kroky, které je třeba provést, abyste měli při vývoji v programu Kate (nebo jiných aplikacích KDE) s programem Kate co nejlepší zkušenosti.

Integrace LSP

# nástroje clangd
compile-commands-export yes
compile-commands-linking yes

Tyto řádky zajišťují, že CMake vygeneruje soubory compile_commands.json, které jsou nezbytné pro integraci LSP založenou na clangd. Kromě toho, že je CMake vygeneruje přímo do adresáře build, volba pro propojení vytvoří symbolické odkazy zpět do vašich zdrojových adresářů. To umožňuje používání modulu LSP v editoru Kate (a dalších editorech) bez nutnosti dalších nastavení.

Instalace potřebných závislostí (volitelné)

kdesrc-build nabízí režim počátečního nastavení, který nainstaluje balíčky potřebné pro zahájení vývoje v několika běžných distribucích. To se hodí, pokud si nejste jisti, zda jsou ve vašem systému nainstalovány všechny potřebné vývojové balíčky, a nechcete se o to starat ručně. Jelikož se tento nástroj pokusí nainstalovat balíčky pro vaši distribuci, bude pro tento krok zapotřebí oprávnění správce k instalaci balíčků. Stačí k tomu spustit:

kdesrc-build --initial-setup

Soubor .config/kdesrc-buildrc jsme již vytvořili a ten zůstane beze změn. Pro další používání nemusíte upravovat ani nastavení svého shellu.

Sestavení Kate a závislosti

Chcete-li spustit kompilaci programu Kate a všech potřebných závislostí KDE, stačí nyní zadat:

kdesrc-build --include-dependencies kate

Na novějším počítači to trvá pár minut. Máte čas si dojít pro kávu nebo se zamyslet nad tím, co vlastně chcete realizovat.

Pokud verze KF 6 našich závislostí není součástí vaší distribuce, může být vhodné zkompilovat některé další součásti, abyste dosáhli lepšího vzhledu a integrace s terminálem:

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

Pokud chcete sestavit pouze Kate bez závislostí, protože jste si jisti, že máte v systému dostatečně aktuální verze, můžete zkusit:

kdesrc-build --no-include-dependencies kate

Vzhledem k tomu, že na moderních počítačích jsou doby kompilace krátké, je však pohodlnější prostě vše zkompilovat – tím si zajistíte, že budete mít k dispozici například i nejnovější a nejlepší frameworky KSyntaxHighlighting a KTextEditor!

V tomto nastavení můžete všechny součásti softwaru KDE zkompilovat jednoduchým příkazem:

kdesrc-build

Mějte na paměti, že to bude chvíli trvat (a zabere to místo na disku).

Pokud se během sestavování objeví nějaké chyby zobrazené červeným písmem, postupujte podle tohoto návodu – Jak řešit problémy při sestavování

Jak se používají nástroje pro sestavení?

Chcete-li spustit lokální verzi Kate, musíte nejprve správně nastavit prostředí, aby se zajistilo načtení správných modulů a dalších komponent. Naštěstí je to velmi jednoduché:

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

Šikovným způsobem, jak to vyřešit, je například vytvořit si malý skript, který spustí verzi programu Kate z hlavní větve (master branch) ve vašem lokálním adresáři bin:

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

Udržujte své věci v aktuálním stavu

Chcete-li udržovat svou lokální verzi aktuální, stačí znovu použít výše uvedené příkazy. Ty se postarají o stažení nových změn z repozitářů KDE a o jejich kompilaci a instalaci do vašeho lokálního prefixu.

Vyvíjejte!

Nyní zbývá zodpovědět otázku: Jak se nejlépe rozvíjet?

Samozřejmě, pokud chcete na Kate něco programovat, možná by dávalo smysl použít k tomu právě Kate.

Vzhledem k výše uvedeným přípravám je to snadné – stačí spustit novou hlavní verzi programu Kate a zadat jí adresář sestavení:

kate ~/projects/kde/build/kate

Případně se tam můžete přesunout v terminálu a spustit odtud Kate – soubor se otevře automaticky:

cd ~/projects/kde/build/kate
kate

Abyste mohli tuto funkci využívat co nejlépe, ujistěte se, že máte povoleny alespoň modul pro projekty a modul LSP. Pokud chcete využít integraci sestavování do grafického uživatelského rozhraní, aktivujte také modul pro sestavování.

Zobrazí se vám nové okno Kate, jak je znázorněno níže.

Ve spodním panelu nástrojů "Aktuální projekt" máte ve výchozím nastavení k dispozici dva terminály. První terminál se nachází ve vašem adresáři build, kde můžete například spouštět příkazy ninja a ninja install a podobně. Druhý terminál se nachází ve vašem adresáři se zdrojovými kódy a je ideální například pro příkazy git z příkazového řádku.

Vzhledem k výše uvedenému nastavení by měl modul LSP (pokud máte nainstalovaný clangd) fungovat ihned po instalaci.

Měly by být nastaveny i další užitečné funkce, jako je rychlé otevření v rámci celého projektu, vyhledávání a nahrazování a oprava cílů sestavení.

Přispívejte!

Neváhejte a vytvořte žádost o sloučení na invent.kde.org. Další informace najdete na stránce Připojte se k nám.

Potřebujete pomoci?

Pokud máte nějaké dotazy, můžete je položit v naší sekci Kate na serveru KDE Discourse a/nebo se připojit k našemu [kanálu Kate na Matrixu](https://go.kde.org/matrix/#/# kate:kde.org) (více obecných informací o Matrixu a KDE zde).

Pro více informací klepněte na Získat nápovědu.

Sestavení Kate ze zdrojových souborů ve Windows

Chcete-li zkompilovat Kate/KWrite založené na KF5, můžete postupovat podle návodu na stránce KDE ve Windows.

Sestavení Kate ze zdrojových souborů v macOS

Chcete-li zkompilovat Kate/KWrite založené na KF5, můžete postupovat podle návodu na stránce KDE na macOS.