Xcode4: automatické doplňování v editoru - MujMAC.cz - Apple, Mac OS X, Apple iPod

Navigace:  » Úvodní stránka  » Rubriky  » Informace  

10. srpna 2011, 00.00 | Minule jsme přešli od nastavení projektů a cílů k editoru zdrojových textů: ukázali jsme si asistenta a vysvětlili, jak se s ním v pracuje a v čem se liší od podpory práce s více zdrojovými soubory v jediném okně v Xcode 3. Dnes se podíváme přímo do vlastního editoru.

Základní služby editoru se od dob Xcode 3 zásadně nezměnily; občas je trochu jinak některá klávesová zkratka, ale to můžeme snadno nastudovat a podle potřeby upravit v Předvolbách (Key Bindings). Změnil se však mechanismus automatického doplňování; jak jsme si řekli již v úvodním dílu, je v Xcode 4 funguje poměrně dobře, ale je daleko agresivnější než tomu bývalo v Xcode 3, a bohužel nelze nastavit nějakou "polovičatou" variantu, platí buď všechno nebo nic.

To je poměrně nepříjemné; agresivita doplňovacího systému je často otravná, když nám vnucuje věci, o něž naprosto nestojíme: kupříkladu deklaraci instančních proměnných v bloku @interface, jež – vyjma práce v projektech, jež budou nějakých důvodů překládány starým Objective C a vyžadují tedy zpětnou kompatibilitu – v současnosti nikdy nemá smysl. Dnes si proto ukážeme, jak tento problém vyřešit.

Textová makra

Xcode už dávno podporuje textová makra; jejich podpora byla v Xcode 3 poněkud viditelnější, ale podporována jsou i ve čtyřce. Jen se jejich formát změnil na XML a jejich název na "code snippets".

Zde není místo na detailní popis všech možností, jež "code snippets" nabízejí (a upřímně řečeno si ani nejsem jist, zda všechny detailně znám. Ukážeme si proto jen konkrétní možnost definice nového makra pro automatické doplňování.

Obsah makra

Obsah makra vypadá ve formátu XML zhruba takto – při vytváření nového je asi nejjednodušší prostě vytvořit textový soubor, obsahující níže uvedený text, a upravit v něm to, co je zapotřebí; přímou podporu pohodlné editace maker Xcode, aspoň nakolik je mi známo, nemá:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
  "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>IDECodeSnippetCompletionPrefix</key>
<string>prefix</string>
<key>IDECodeSnippetCompletionScopes</key>
<array>
<string>All</string>
</array>
<key>IDECodeSnippetContents</key>
<string>obsah</string>
<key>IDECodeSnippetIdentifier</key>
<string>kód</string>
<key>IDECodeSnippetLanguage</key>
<string>Xcode.SourceCodeLanguage.Objective-C</string>
<key>IDECodeSnippetTitle</key>
<string>popis</string>
<key>IDECodeSnippetUserSnippet</key>
<true/>
<key>IDECodeSnippetVersion</key>
<integer>2</integer>
</dict>
</plist>

Význam "proměnných", jež jsme označili kursivou, je následující:

• prefix je text, který Xcode rozpozná – zapíšeme-li jej (ne nutně celý, stačí několik úvodních znaků) do okna editoru –, a na jeho základě makro použije pro automatické doplňování;

• obsah je to, co se namísto prefixu do editoru fakticky vloží, pokud se doplnění rozhodneme použít. Zde je možné vkládat pojmenované "placeholdery", jež pak nahradíme konkrétním obsahem; ty mají formát "<#jméno#>", přičemž (jak je zvykem v XML), lomené závorky je nutno nahradit odpovídajícími entitami;

• kód je libovolný unikátní textový řetězec, který makro jednoznačně identifikuje;

• popis se zobrazí jako nápověda v nabídce automatického doplnění (a kromě toho také v paletce "Code Snippets" v pravém dolním rohu, zapneme-li ji).

Ostatní obvykle neměníme.

Uložení a aktivace makra

Zatímco Xcode 3 mělo poměrně přísné nároky na jméno souboru apod., v Xcode 4 je to velmi jednoduché – makro uložíme do složky

~/Library/Developer/Xcode/UserData/CodeSnippets

pod libovolným jménem a s příponou ".codesnippet". Pozn.: složka "UserData" obvykle standardně existuje (Xcode ji vytvoří pro jiné účely); složku "CodeSnippets" uvnitř ní ale většinou musíme vytvořit sami.

Pak stačí restartovat Xcode, a makro je nám k dispozici.

Pokud bychom např. do této složky uložili soubor "log.codesnippet" s obsahem

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
  "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>IDECodeSnippetCompletionPrefix</key>
<string>log</string>
<key>IDECodeSnippetCompletionScopes</key>
<array>
<string>All</string>
</array>
<key>IDECodeSnippetContents</key>
<string>NSLog(@"&lt;#formát#&gt;");</string>
<key>IDECodeSnippetIdentifier</key>
<string>cz.mujmac.nslogsnippet</string>
<key>IDECodeSnippetLanguage</key>
<string>Xcode.SourceCodeLanguage.Objective-C</string>
<key>IDECodeSnippetTitle</key>
<string>NSLog</string>
<key>IDECodeSnippetUserSnippet</key>
<true/>
<key>IDECodeSnippetVersion</key>
<integer>2</integer>
</dict>
</plist>

umožní nám Xcode zapsat do editoru jen text "log" (nebo "lo" nebo i "l") a pak z nabídky automatickéch doplnění vybrat to, co potřebujeme, asi takto – pro ilustraci jsme jednou doplnění použili, podruhé je zrovna zkoušíme:

Překrytí standardního makra

Pokud popsaným způsobem implementujeme vlastní makro pro doplnění direktivy @interface – jež by mohlo vypadat kupříkladu takto (ukazujeme jen podstatné řádky):

<key>IDECodeSnippetCompletionPrefix</key>
<string>@interface</string>
<string>@interface &lt;#class#&gt;:&lt;#superclass#&gt;
@end
</string>

zjistíme, že to sice funguje výtečně – ale původní nešikovné doplnění je stále k dispozici a v seznamu možností, jež Xcode nabídne, se nám darmo plete.

I zde řešení existuje: musíme najít identifikátor (IDECodeSnippetIdentifier) systémového makra, a použít přesně týž text v našem souboru: Xcode pak systémové makro tím naším překryje a nebude je nadále nabízet.

Poznámka: toto chování, nakolik vím, není explicitně zdokumentováno; nelze se proto na ně absolutně spolehnout za všech okolností nebo v budoucích versích Xcode. Zatím ale kdekoli jsem je vyzkoušel, fungovalo.

Identifikátory systémových maker Xcode veřejně k dispozici nejsou; snadno je ale nalezneme v souboru

/Developer/Library/Xcode/PrivatePlugIns/
  IDECodeSnippetLibrary.ideplugin/Contents/
  Resources/SystemCodeSnippets.codesnippets

– stačí jej otevřít v TextEditu (je přesně v témže formátu XML, který jsme si ukázali výše, jen obsahuje víc definic než jednu) a vyhledat si v něm makro, které nás zajímá. Konkrétně makro "@interface" má identifikátor "594E2E10-E61A-453E-9011-8B99A7DDBB9D" – stačí tento text použít ve vlastním makru pro IDECodeSnippetIdentifier a máme vyhráno.

Mimochodem – samozřejmě by bylo možné upravit definici požadovaným způsobem přímo v souboru "SystemCodeSnippets.codesnippets"; naše varianta je ale poněkud spolehlivější a dává daleko lepší šanci na "přežití" při upgrade Xcode.