Pomocné skripty pro Kate a KWrite

18.3.2007 13:00 | Přečteno: 1752× | Jen tak | | poslední úprava: 18.3.2007 13:04

Na mém oblíbeném textovém editoru KWrite (a pro některé situace Kate) mi vždy vadilo, že neumožňuje snadné přidání pomocných editačních skriptů/maker do menu a do nástrojové lišty. Našel jsem si tedy berličku, která tuto vlastnost docela dobře supluje (nemusíte se namáhat... na Vim nepřejdu :-)).

Kate má několik možností, jak s textem manipulovat pomocí externích nástrojů:

Nástroje -> Externí nástroje

Tohle se hodí na činnosti, které sice pracují s textem z právě otevřeného dokumentu, ale nesnaží se už výsledek své práce nacpat zpátky do editoru. Jinými slovy: chcete-li mít v menu (nebo v nástrojové liště) příkaz, který vezme právě editovaný text a odešle ho emailem, je to ideální. Stejně tak se to dá použít například pro jednoduché vyhledání označeného slova ve slovníku na webu a podobně.

Daleko méně vhodné je používání "Externích nástrojů" k provádění editačních změn přímo v rámci editoru. Ačkoliv to je možné, není to zrovna šikovné - výjimkou jsou akce, které pracují s celým souborem a jejichž výsledkem je hodně jiný text. Důvodem je to, že ta operace se skládá z následujících (samozřejmě automatizovaných) kroků: ulož editovaný soubor, předej jeho obsah externímu nástroji, přepiš původní soubor výstupem daného nástroje (a uživatel pak musí odsouhlasit znovunačtení upraveného souboru v editoru). Tj. chcete-li provést změny v jediném řádku nebo odstavci, je lepší hledat jiné řešení. Ale pokud chcete vzít celý soubor, prohnat ho přes nějaký jiný program a výsledek pak dále editovat, stojí to za zvážení.

Pluginy

Kate umožňuje začlenění nových pluginů. Znamená to ovšem, že si takový plugin musíte naprogramovat. Pro uživatele, kteří umí C++, by to neměl být problém. Zvláště s pomocí ukázkového pluginu "Hello World", který je s Kate dodáván.

Má to však dvě zásadní nevýhody: jednak už zmíněná podmínka (znalost C++), ale především komplikovanost celého procesu. Dejme tomu, že bych chtěl nástroj, který vezme právě označený text a prohodí v něm malá a velká písmena. (Jde to sice provést pomocí regulárních výrazů v Úpravy -> Nahradit, ale protože není možné nahrávat makra, muselo by se to pokaždé zadávat znovu.) Plugin by to sice mohl vyřešit (včetně třeba ikonky v toolbaru), ale to bych musel nejprve (napsat a) zkompilovat a nainstalovat knihovnu, která by takovou funkci poskytovala. Kvůli takové prkotině je to kanón na vrabce.

On je to ostatně kanón na vrabce i v případě pluginů, které jsou s Kate přibaleny. Například dialogový boxík, do kterého lze zadat písmeno, ze kterého bude vytvořen uzavřený HTML tag (zadám b a do textu se vloží <b></b>). Potýkat se kvůli takové věci s .cpp, .h, .la, .so, Makefile atd. - to je fakt přehnané, když by na to stačilo deset řádků nějakého skriptu.

Náznak rozumnějšího řešení jsem nalezl na stránkách KJSEmbed, které se věnují možnosti skriptování KPart aplikací pomocí JavaScript/ECMAScript enginu zabudovaného přímo do KDE: KJS. Mezi příklady uvedenými na těch stránkách je dokonce i jeden, který přidává jednoduchou javascriptovou funkci do KWrite prostřednictvím KPart::Plugin (html2text). Bohužel se mi tento příklad nepodařilo rozchodit. Pokud s tím někdo máte zkušenosti, podělte se, prosím.

Pro KDE4 se připravuje systém Kross (tutoriál), který by měl umožňovat jednoduché přidávání skriptů do aplikací. Zatím je připravena podpora pro Ruby, Python a JavaScript (opět přes KJS). Ale to je budoucnost, já potřebuji pracovat teď.

The Kate JavaScript API

Poslední možnost. A zdálo by se, že ideální. Jediná chybka je, že skripty, které si pro Kate připravíte, je možné spouštět pouze v interní příkazové řádce editoru. Nejde je vložit do menu a tím pádem ani do nástrojové lišty. Nejde jim dokonce ani přiřadit klávesovou zkratku. Chcete-li skript spustit, musíte prostě napsat jeho název (nebo určený příkaz) do příkazové řádky. Autoři k tomu v nápovědě píší:

We know that many of you will be disappointed because you can't add your scripts to the menu or assign shortcuts to them. Sorry, sometime in the future that will likely be possible.

To zamrzí. Poskytované API sice není nějak extra rozsáhlé, ale pro základní operace bohatě stačí. Je tedy nutné toto omezení nějak obejít, aby bylo možné skripty snadno používat. Řešení je jednoduché, i když mi dost dlouho trvalo, než jsem si uvědomil, že by šlo použít.

Na interní příkazovou řádku se přepíná klávesou F7 - objeví se jednořádkové vstupní pole, do kterého je možné zadávat příkazy. Naštěstí se po (úspěšném) provedení příkazu (tedy v tomto případě skriptu) vrátí "focus" zase do editačního pole s dokumentem, takže není nutné se tam ručně přepínat. Zbývá tedy přiřadit nejdůležitějším skriptům jednopísmenné názvy. Soubory se skripty naštěstí mohou být pojmenovány nějak normálně, protože název příkazu se určuje v souboru .desktop.

Příklad (podobný příklad je i v nápovědě ke Kate, kde jsou i vysvětleny použité vlastnosti a funkce):

~/.kde/share/apps/katepart/scripts/bold.js

// enclose selection in <b></b>

if ( view.hasSelection() ) {
  column = view.selectionStartColumn;
  line = view.selectionStartLine;
  endcolumn = view.selectionEndColumn + 7;

  vysledek = view.selection().bold();
}
else {
  column = view.cursorColumn();
  var endcolumn;
  endcolumn = column + 3;
  line = view.cursorLine();

  nic = ""
  vysledek = nic.bold();
}

document.editBegin();
if ( view.hasSelection() ) {
  view.removeSelectedText();
}
document.insertText( line, column, vysledek );
view.setCursorPosition( line, endcolumn );
document.editEnd();

~/.kde/share/apps/katepart/scripts/bold.desktop

[Desktop Entry]
Encoding=UTF-8
Name=HTML tag <b>
Comment=Enclose selection in <b>
X-Kate-Command=b
X-Kate-Help=<p>Usage: <code>b</code></p>

Skript se provede postupným stiskem tří kláves: F7 - b - Enter. Je to primitivní akce, ale čas to šetří velmi. Protože je ten skript načten do "katepart", tak ho lze využívat v Kate i KWrite.

       

Komentáře

[disorder]

nemusíte se namáhat... na Vim nepřejdu

uf, kto by prechadzal na vim, ked existuje emacs? :P

[David Watzke]

Co má společného textový editor s operačním systémem bez textového editoru?

[Lu-Tze]

I chytří lidé mohou psát hloupé komentáře...

[Michal Vyskočil]

Gentoo Linux causes global warming! Hug a tree, use Debian!

Ne vždy - viz dfs

[disorder]

co "ne vzdy"?

[Michal Vyskočil]

No, že při použití zmiňovaného Debian From Scratch na tom budou stromy, o kterých píšeš v patičce, úplně stejně, jako v případě použití Gentoo

[disorder]

1) ved to nikto nepouziva

2) nie je tam "use DFS" :P

[Lu-Tze]

Šlo by i přes dcop, ne? Přes SelectionInterface získám označený text, přes SelectionInterfaceExt zjistím jeho pozici (souřadnice: řádek, sloupec), pak ten text mohu prohnat libovolným filtrem, výběr smažu (SelectionInterface.removeSelectedTest()) a na uloženou pozici vložím výstup filtru (EditInterface.insertText(..)).

[Robert Krátký]

No jo, ale jak takovou akci zakomponovat do UI?

[Lu-Tze]

Např. přes ty external tools, přičemž v dialogu pro přidání nástroje nastavit save na none, aby to nepožadovalo uložení dokumentu. A přidat si external tools jako buttonek do toolbaru.

Při spuštění toho skriptu by se jako první věc muselo zjistit, který dokument se právě edituje, nejspíš pomocí KateDocumentManager.activeDocument() a pak použít ty fce, jak jsem psal.

Takový skript je stačí samozřejmě jenom jeden, jako parametr bych mu dával filrt, který se má použít.

[Lu-Tze]

Důvodem je to, že ta operace se skládá z následujících (samozřejmě automatizovaných) kroků: ulož editovaný soubor, předej jeho obsah externímu nástroji, přepiš původní soubor výstupem daného nástroje (a uživatel pak musí odsouhlasit znovunačtení upraveného souboru v editoru).

Ono totiž tohle není obecně pravda...

Je tam např. i nástroj google selection, je jasné, že ten takhle nepracuje.

[Robert Krátký]

Je tam např. i nástroj google selection, je jasné, že ten takhle nepracuje.

To bylo míněno k druhu akce, která vrací výsledek zpět do editovaného souboru. Google selection jen vezme řetězec a šoupne ho Konqueroru, ať si s ním poradí. Není tam to vrácení výsledku zpět do otevřeného dokumentu.

[Robert Krátký]

Např. přes ty external tools, přičemž v dialogu pro přidání nástroje nastavit save na none, aby to nepožadovalo uložení dokumentu.

To je pravda. Nenapadlo mě, že při použití DCOP není nutné dokument ukládat a znovu načítat. Dík.

[Robert Krátký]

Tak jsem to vyzkoušel a funguje to pěkně. Jediná (ale zato podstatná) nevýhoda je, že je to pomalé jak šnek. Příšerně pomalé. Na rozdíl od JavaScriptu, který je bleskový, jsou DCOP volání líné herky.

[trekker.dk]

Jde to sice provést pomocí regulárních výrazů v Úpravy -> Nahradit, ale protože není možné nahrávat makra, muselo by se to pokaždé zadávat znovu.

V Kate je možné regulární výraz uložit a poté znovupoužít, takže místo zadávání by mělo stačit pár kliknutí.

[Robert Krátký]

Tak to nevím, jak uložit regexp (tedy kromě rozbalovacího seznamu naposled použitých výrazů)...

[trekker.dk]

V Kate v tom dialogu "Nahradit", když zaškrtneš "Regulární výraz", tak se ti povolí tlačítko "Upravit". Po kliknutí se objeví "Editor regulárních výrazů", ve kterém zapíšeš regulární výraz a pomocí jednoho z tlačítek na nástrojové liště ho uložíš - objeví se ti pod "Složené regulární výrazy" - "Definováno uživatelem"

[Robert Krátký]

V Kate v tom dialogu "Nahradit", když zaškrtneš "Regulární výraz", tak se ti povolí tlačítko "Upravit". Po kliknutí se objeví "Editor regulárních výrazů",

No, to se mi právě neobjevoval. Bylo to jen drop-down menu zkratek pro rychlé zadání regexpů.

Až teprve když jsem četl tento tvůj komentář, tak mi svitlo, že by to mohlo být propojeno s kregexpeditor - prográmek, pro který jsem nikdy neměl užití, protože samostatně je na nic... Tak jsem si ho teď znovu nainstaloval. Díky za postrčení.