Bloky jsou i v AppKitu - MujMAC.cz - Apple, Mac OS X, Apple iPod

13. října 2009, 00.00 | Předminule jsme si vysvětlili, co to bloky jsou a jak se používají; minule jsme si ukázali nejdůležitější z nových „blokových“ služeb, s nimiž se setkáme ve Foundation Kitu, a dnes sérii zakončíme tím, že si ukážeme nové „blokové“ služby v aplikačních knihovnách.

Dnešní článek o novinkách v API, jež přinesl Irbis, je třetí a také poslední, které se věnuje asi nejvéznamnějšímu rozšíření Objective C za celou dobu jeho existence – totiž blokům. Předminule jsme si vysvětlili, co to bloky jsou a jak se používají; minule jsme si ukázali nejdůležitější z novéch „blokovéch“ služeb, s nimiž se setkáme ve Foundation Kitu, a dnes sérii zakončíme tím, že si ukážeme nové „blokové“ služby v aplikačních knihovnách.

Poznámka: samozřejmě, že jsme si neukázali všechny nové služby, založené na blocích; na to zde není ani vhodné místo, ani dostatek prostoru. O některéch dalších službách se ještě zmíníme v dalších článcích, zaměřenéch na jiné novinky Irbise – např. širokou podporu URL pro identifikaci souborů, kde uvidíme nové možnosti NSFileManageru, jež dovolují užití bloku jako chybového handleru; o jinéch se nezmiňujeme vůbec, a laskavého čtenáře, které by je snad potřeboval, odkazujeme na standardní dokumentaci.

Panely pro véběr souborů a složek

Ačkoli Irbis pro zpětnou kompatibilitu samozřejmě stále podporuje starší API tříd NSSavePanel a NSOpenPanel, doporučené služby se změnily poměrně zásadním způsobem: nemá patrně smysl přepisovat starší kód, přinejmenším tam, kde se v aplikaci nic jiného nemění; pro nové aplikace bychom ale nyní měli tyto třídy používat poměrně dost odlišném způsobem.

Mimochodem, poměrně dlouho jsem váhal, zda popsat nové služby zde, či zda se jim věnovat kompletně až později, kdy budeme popisovat změny v API související s přechodem od textovéch řetězců k URL pro identifikaci souborů (jež se samozřejmě panelů tékají také); nakonec jsem se ale rozhodl je uvést již zde, protože bloky jsou důležitější a znamenají véznamnější změny a zjednodušení kódu.

Hlavní problém s těmito panely – spolu obecně s libovolnémi lístky („sheets“), ale k těm se vrátíme později – spočíval v tom, že Apple velmi rozumně požaduje, aby např. otevřené panel pro uložení dokumentu do souboru neblokoval aplikaci jako celek, ale pouze a právě ten ukládané dokument. S ostatními však musí jít bez problémů pracovat. To samozřejmě znemožňuje triviální implementaci typu „zavolám službu, jež otevře panel, nechá uživatele vybrat soubor, a jeho jméno vrátí“: taková služba by totiž nutně hlavní vlákno aplikace (jež se stará o obsluhu GUI) blokovala jako celek.

Proto až do Leoparda včetně bylo nutné rozdělit funkčnost těchto panelů do nejméně dvou metod: prvá panel nastaví a otevře, a také mu předá selektor té druhé; ta pak je volána po uzavření panelu a dostane mj. jeho návratové kód (tj. informaci o tom, zda uživatel zvolil „Cancel“ nebo „Open“). Zároveň je ovšem nutné této službě předat kontext, v němž je soubor otevírán či zavírán; v praxi to pak vypadalo kupříkladu v hodně jednoduchém případě nějak takto:

-(void)showLicencePanelForAgent:(LicenceAgent*)licenceAgent {
  NSOpenPanel *op=[NSOpenPanel openPanel];
  [op beginSheetForDirectory:nil file:nil types:nil
    modalForWindow:mainWindow modalDelegate:self
    didEndSelector:@selector(licenceHasBeenChanged:rc:context:)
    contextInfo:[licenceAgent retain]];
}
-(void)licenceHasBeenChanged:(NSOpenPanel*)op rc:(int)rc context:(void*)ctxt {
  LicenceAgent *licenceAgent=[(LicenceAgent*)ctxt autorelease];
  if (rc)
    [licenceAgent setupLicenceFromFile:[op filename]];
}

Přitom je – zvláště v případech, kdy byla služba, otevírající panel, rozsáhlejší, a tedy druhá metoda, volaná po jeho uzavření, vzdálenější ve zdrojovém kódu – zvláště nebezpečná nutnost se starat o správu paměti: vzhledem k tomu, že retain a odpovídající autorelease jsou od sebe vzdáleny a dokonce odděleny do samostatnéch metod, je risiko přehlédnutí a chyby velmi značné.

Bloky tento problém odstraňují; s nimi by véše uvedené kód vypadal mnohem jednodušeji:

-(void)showLicencePanelForAgent:(LicenceAgent*)licenceAgent {
  NSOpenPanel *op=[NSOpenPanel openPanel];
  [op beginSheetModalForWindow:mainWindow completionHandler:^(NSInteger rc){
    if (rc)
      [licenceAgent setupLicenceFromFile:[op filename]]; // či op.URL
  }];
}

O to, aby uvnitř bloku byly korektně k dispozici objekty licenceAgent i op a o odpovídající správu paměti se automaticky postará systém bloků v Objective C; není třeba se tím zabévat explicitně. Navíc nyní kód, provedené při otevření souboru, je „tam kam patří“, totiž přímo v místě, kde se otvírá odpovídající panel.

Podobně tomu je i s třídou NSSavePanel. Obě třídy nyní nabízejí vérazně jednodušší API – vlastně jen dvě metody, jedu pro otevření jako lístek u okna, druhou jako samostatné panel (třetí pak je modální běh, ale ten není příliš vhodné využívat, pokud k tomu není speciální důvod):

-(void)beginSheetModalForWindow:(NSWindow*)window
  completionHandler:(void (^)(NSInteger result))handler;
-(void)beginWithCompletionHandler: (void (^)(NSInteger result))handler;

Pro určení způsobu, jímž se panely mají chovat, pak slouží jejich atributy a případně delegát; oba nabízejí některé novinky, ale na ty se už blíže podíváme až později, neboť s bloky nesouvisí.

A co ostatní lístky?

Kromě panelů Mac OS X ovšem obsahuje i řadu dalších lístků – ať již jde o standardní varovné panely („alert“), representované prostřednictvím třídy NSAlert a jejích služeb, nebo zcela obecné lístky, jež můžeme přiřadit k oknu pomocí služby beginSheet:modalForWindow:modalDelegate:didEndSelector:contextInfo: třídy NSApplication. Na ty, zdá se, prozatím v Apple nějak zapomněli – API založené na blocích zde nenalezneme, ačkoli by bylo stejně praktické, jako tomu je u panelů.

Ukážeme si proto jako další příklad práce s bloky naopak způsob, jak možnost práce s bloky k obecném lístkům doplnit – jak uvidíme, je to velmi jednoduché. Příklad uvedeme třeba pro třídu NSAlert, jež se používá častěji; u obecnéch služeb třídy NSApplication by samozřejmě princip byl též.

Stávající standardní služba, již třída NSAlert pro zobrazení varovného lístku nabízí, vypadá takto:

-(void)beginSheetModalForWindow:(NSWindow*)window modalDelegate:modalDelegate
  didEndSelector:(SEL)selector contextInfo:(void*)context;

Z pohledu uživatele bloků je to ukrutně složité a zbytečně komplikované; daleko vhodnější by namísto toho bylo užívat zhruba téže služby, již nabízejí třídy NSSavePanel a NSOpenPanel. Její implementace by mohla vypadat kupříkladu takto:

@implementation NSAlert (BlockSupport)
-(void)beginSheetModalForWindow:(NSWindow*)window
 completionHandler:(void(^)(NSInteger result))handler {
 [self beginSheetModalForWindow:window modalDelegate:self
  didEndSelector:@selector (__ocs_alertDidEnd:returnCode:contextInfo:)
  contextInfo:[handler copy]]; //1
}
-(void)__ocs_alertDidEnd:(NSAlert*)alert returnCode:(NSInteger)rc
  contextInfo:(void(^)(NSInteger rc))handler {
  handler(rc);
  [handler release]; //2
}
@end

Jak vidíme, implementace požadované funkčnosti je poměrně přímočará; jen si musíme dát pozor na to, že blok může bét za jistéch podmínek uložen kompletně na zásobníku (tím se liší od běžnéch objektů Objective C, ačkoli jinak s ním lze zacházet jako s objektem bez omezení: z hlediska objektového systému jsou všechny bloky objekty třídy NSBlock, resp. některé její konkrétní podtřídy). Proto je bezpodmínečně nutné v takovéchto kontextech vytvořit kopii bloku („//1“), a po jejím použití paměť uvolnit („//2“) – pozor, právě kvůli možnosti, že blok je umístěn na zásobníku, by pouhé retain nestačilo!

Máme-li hotovu véše uvedenou kategorii, můžeme pro „alerty“ používat stejné „blokové“ API, jako pro souborové panely – kupříkladu tedy takto:

-(void)checkLicenceWithAgent:(LicenceAgent*)licenceAgent {
  if (![licenceAgent checkLicenceForCurrentUser])
    [[NSAlert alertWithMessageText:@"Licence expired"
      defaultButton:@"Load new..." alternateButton:@"Quit" otherButton:nil
      informativeTextWithFormat:@"%@", [licenceAgent lastResultDisplayString]]
      beginSheetModalForWindow:mainWindow completionHandler:^(NSInteger rc){
        if (rc) [self showLicencePanelForAgent:licenceAgent];
        else [NSApp terminate:self];
  }];
}

Mimochodem, samozřejmě nejsme nijak vázáni jen véše uvedeném API; zrovna u třídy NSAlert se může jako velmi praktická ukázat třeba zpráva

-(void)beginSheetModalForWindow:(NSWindow*)window
  completionHandlerForDefaultButton:(void(^)(void))handler;

jež provede zadané blok pouze po potvrzení standardního tlačítka lístku, a po stisknutí jiného neudělá nic. Ještě poněkud flexibilnější varianta by mohla bét třeba

-(void)beginSheetModalForWindow:(NSWindow*)window
  completionHandlers:(void(^)(void))handler,...;

jejímiž argumenty by mohlo bét tolik bloků, kolik má lístek tlačítek, a zpráva by zavolala blok v pořadí odpovídajícím pořadí stisknutého tlačítka...

Implementace kterékoli z těchto metod je velmi jednoduchou modifikací véše uvedeného příkladu; nebudeme si je proto ukazovat, ale ponecháme je jako jednoduché cvičení laskavém čtenářům :)