Další podpora NSURL - MujMAC.cz - Apple, Mac OS X, Apple iPod

1. dubna 2010, 00.00 | Dnes si ukážeme několik z nejpodstatnějších doplňků a rozšíření ostatních tříd, jež nyní práci s odkazy na soubory prostřednictvím instancí třídy NSURL nabízejí.

V minulém dílu našeho seriálu, který se nyní zabývá novinkami, jež programátorům přinesl Irbis ("Snow Leopard" pro ty, kdo nemají rádi překlady jmen), jsme si ukázali, jak návrháři API v Apple sjednotili dosud poněkud nekonsistentní přístup k souborům v rámci služeb třídy NSURL. Dnes tuto část dokončíme – ukážeme si několik z nejpodstatnějších doplňků a rozšíření ostatních tříd, jež nyní práci s odkazy na soubory prostřednictvím instancí třídy NSURL nabízejí.

Služby třídy NSFileManager

Vzhledem k tomu, že pro valnou většinu základních operací nad soubory a složkami v prostředí Cocoa slouží třída NSFileManager, nepřekvapí, že v 10.6 je v souvislosti s konsistentním používáním instancí NSURL rozšířeno i její API.

Vedle starých služeb pro kopírování, přemísťování a rušení souborů, založených na jménech v podobě instancí třídy NSString – jež jsou samozřejmě pro zpětnou kompatibilitu podporovány i nadále – jsou nyní k dispozici nové zprávy

-(BOOL)copyItemAtURL:(NSURL*)src toURL:(NSURL*)dst
       error:(NSError**)error;
-(BOOL)moveItemAtURL:(NSURL*)src toURL:(NSURL*)dst
       error:(NSError**)error;
-(BOOL)linkItemAtURL:(NSURL*)src toURL:(NSURL*)dst
       error:(NSError**)error;
-(BOOL)removeItemAtURL:(NSURL*)URL
       error:(NSError**)error;

Jejich funkce je asi zřejmá a není zapotřebí ji podrobně popisovat.

Nové zprávy, založené na třídě NSURL, jsou nyní k dispozici i pro prohledávání disku; třída NSFileManager nabízí službu

-(NSArray*)contentsOfDirectoryAtURL:(NSURL*)folder
         includingPropertiesForKeys:(NSArray*)keys
    options:(NSDirectoryEnumerationOptions)options
                            error:(NSError**)error;

jež vrátí v poli seznam objektů, umístěných ve složce "folder". Zajímavým rozšířením je možnost přímo si vyžádat bez ztráty času načtení požadovaných informací o těchto objektech pomocí argumentu "keys": připomeňme službu getResourceValue:forKey:error:, s níž jsme se seznámili v minulém dílu našeho seriálu; pro objekty v poli, jež vrací zpráva contentsOfDirectoryAtURL:includingPropertiesForKeys:options:error:, budou prostřednictvím služby getResourceValue:forKey:error: k dispozici právě ty informace, jež jsme si vyžádali v "keys". Použijeme-li zde hodnotu nil, dostaneme standardní seznam atributů; nechceme-li žádné, můžeme zadat prázdné pole.

Argument "options" umožňuje předem určit, zda chceme nebo nechceme dostávat "neviditelné" soubory (tj. takové, jejich zobrazení je potlačeno na úrovni Finderu): standardně získáme kompletní seznam, ale zadáme-li zde hodnotu NSDirectoryEnumerationSkipsHiddenFiles, vrátí služba contentsOfDirectoryAtURL:includingPropertiesForKeys:options:error: pouze objekty viditelné.

Podobně je k dispozici i nová služba pro procházení celého podstromu složek a souborů:

-(NSDirectoryEnumerator*)enumeratorAtURL:(NSURL*)folder
              includingPropertiesForKeys:(NSArray*)keys
         options:(NSDirectoryEnumerationOptions)options
   errorHandler:(BOOL(^)(NSURL*url,NSError*err))handler;

Instance (nějaké skryté podtřídy) třídy NSDirectoryEnumerator, již vrací tato služba, samozřejmě vrací objekty jako instance třídy NSURL, nikoli NSString. Blok "handler" umožňuje pokračovat v prohledávání i v případě chyby. V argumentu "options" můžeme vedle NSDirectoryEnumerationSkipsHiddenFiles (jež má týž význam jako v minulé službě) navíc použít hodnoty

• NSDirectoryEnumerationSkipsSubdirectoryDescendants, nechceme-li procházet celý podstrom;

• NSDirectoryEnumerationSkipsPackageDescendants, nechceme-li procházet obsah "packages" (tj. složek, jež jsou na úrovni Finderu presentovány jako soubory).

Více hodnot samozřejmě můžeme spojit pomocí bitového "or" (operátor "|"). Chceme-li začít "od nuly" a získat pro začátek seznam jednotek, jež jsou k systému připojeny, není pro spolehlivou kompatibilitu s budoucími versemi úplně vhodné prohledávat složku "/Volumes"; namísto toho máme k dispozici službu

-(NSArray*)mountedVolumeURLsIncludingResourceValuesForKeys:
                                            (NSArray*)keys
               options:(NSVolumeEnumerationOptions)options;

která zjistí a vrátí seznam všech dosažitelných jednotek; argument "keys" funguje stejně jako ve výše popsaných službách, "options" mohou být

• NSVolumeEnumerationSkipHiddenVolumes, nemá-li služba vracet skryté jednotky;

• NSVolumeEnumerationProduceFileReferenceURLs, mají-li URL, jež služba vrátí v poli, být odkazy (tj. "file-ids", nikoli jmény).

Poslední z novinek, kterou si zde ukážeme, se týká náhrady jedné položky v systému souborů jinou. Typickým příkladem je standardní ukládání dokumentů: až na výjimky je korektní postup nejprve uložit nový dokument do dočasné složky, a teprve po úspěšném uložení všech dat a uzavření dokumentu jím nahradit starou versi. Přitom ale tato náhrada není triviální, má-li korektně podporovat funkce "aliasů" a podobně. Proto je na úrovni třídy NSFileManager k dispozici služba, jež to udělá za nás.

Pozn.: používáme-li dokumentový systém založený na třídách NSDocument/NSDocumentController, samozřejmě se o to starat nemusíme; vyřeší to automaticky standardní knihovny.

Potřebujeme-li však ukládat dokumenty explicitně, je postup následující:

• nejprve uložíme nový dokument do pomocné složky (tu zjistíme pomocí standardní služby třídy NSFileManager pro hledání různých složek, URLForDirectory:inDomain:appropriateForURL:create:error:, jíž předáme jako požadovanou doménu NSItemReplacementDirectory);

• pak použijeme službu replaceItemAtURL:withItemAtURL:backupItemName:options:resultingItemURL:error: pro náhradu starého dokumentu novým:

-(BOOL)replaceItemAtURL:(NSURL*)originalItemURL
          withItemAtURL:(NSURL*)newItemURL
         backupItemName:(NSString*)backupItemName
options:(NSFileManagerItemReplacementOptions)options
       resultingItemURL:(NSURL**)resultingURL
                  error:(NSError**)error;

kde "originalItemURL" je původní dokument, a "newItemURL" ten nový, který jsme právě vytvořili. Argument "backupItemName" můžeme vynechat; použijeme-li jej, služba automaticky uchová originální dokument (v téže složce) pod zadaným jménem jako záložní kopii (existuje-li starší záložní kopie, smaže ji). Argument "resultingURL" vrátí referencí nový dokument; často půjde o "originalItemURL", ale nemusí tomu tak být vždy (typickou situací, kdy se "originalItemURL" a "resultingURL" budou lišit, je náhrada starého dokumentu typu RTF novým dokumentem typu RTFD po přidání obrázku). Argument "options" obvykle není zapotřebí používat (téměř vždy stačí 0).

Novinky třídy NSBundle

Vzhledem k tomu, že hlavním úkolem třídy NSBundle je pracovat se složkami v systému souborů, není divu, že se zkonsistentnění odkazů na soubory a složky do třídy NSURL dotklo jejího API velmi značně (pochopitelně opět kompletní staré API zůstává pro zpětnou kompatibilitu). Naproti tomu zde ale nenalezneme žádné zásadně nové služby; namísto detailního popisu si proto jen projdeme postupně nové zprávy a u každé uvedeme odkaz na zprávu, již ta nová nahrazuje (pro nově psané programy):

+(NSURL*)URLForResource:(NSString*)name
          withExtension:(NSString*)ext
           subdirectory:(NSString*)subpath
        inBundleWithURL:(NSURL*)bundleURL;
+(NSArray*)URLsForResourcesWithExtension:(NSString*)ext
           subdirectory:(NSString*)subpath
        inBundleWithURL:(NSURL*)bundleURL;

v zásadě odpovídají pathForResource:ofType:inDirectory: a pathsForResourcesOfType:inDirectory: s mírným a celkem zřejmým rozšířením;

+(NSBundle*)bundleWithURL:(NSURL*)url;

namísto bundleWithPath:;

-(NSURL*)bundleURL;
-(NSURL*)resourceURL;
-(NSURL*)executableURL;
-(NSURL*)URLForAuxiliaryExecutable:(NSString*)executable;
-(NSURL*)privateFrameworksURL;
-(NSURL*)sharedFrameworksURL;
-(NSURL*)sharedSupportURL;
-(NSURL*)builtInPlugInsURL;

namísto bundlePath, resourcePath, executablePath, pathForAuxiliaryExecutable:, privateFrameworksPath, sharedFrameworksPath, sharedSupportPath a builtInPlugInsPath;

-(NSURL*)URLForResource:(NSString*)name
          withExtension:(NSString*)ext;
-(NSURL*)URLForResource:(NSString*)name
          withExtension:(NSString*)ext
           subdirectory:(NSString*)subpath;
-(NSURL*)URLForResource:(NSString*)name
          withExtension:(NSString*)ext
           subdirectory:(NSString*)subpath
           localization:(NSString*)localizationName;
-(NSArray*)URLsForResourcesWithExtension:(NSString*)ext
           subdirectory:(NSString*)subpath;
-(NSArray*)URLsForResourcesWithExtension:(NSString*)ext
           subdirectory:(NSString*)subpath
           localization:(NSString*)localizationName;

namísto celé původní plejády služeb pathForResource... a pathsForResources...

Podpora ve třídě NSUserDefaults

Třída NSUserDefaults, jež zajišťuje standardní přístup k uživatelským nastavením aplikací, celkem samozřejmě nyní podporuje i instance třídy NSURL, máme tedy k dispozici služby

-(void)setURL:(NSURL*)url forKey:(NSString*)key;
-(NSURL*)URLForKey:(NSString*)key;

z nichž prvá zadané URL do databáze nastavení uloží, druhá opět načte.

Služby navíc dělají poměrně rozsáhlé úpravy, jejichž účelem je zajistit co největší spolehlivost a přenositelnost údajů; speciálně tedy při ukládání URL do databáze pomocí zprávy setURL:forKey:

• jakékoli URL, jež nerepresentuje soubor nebo složku, se ukládá jako archivovaná data;

• stejně se zpracuje URL, jež obsahuje odkaz ("file-id"); nejprve se ale automaticky doplní "bookmark" (vizte minulý díl), a také informace, jež umožní zpětnou kompatibilitu při načtení dat v systému 10.5;

• u zbývajících URL (obsahujících tedy nutně cestu k souboru nebo složce) se nejprve ověří, zda jsou součástí domovské složky aktuálního uživatele, a je-li tomu tak, tato složka se nahradí tildou. Pak se zapíší jako textový řetězec.

Podobně při načítání pomocí služby URLForKey:

• vrátí-li databáze instanci třídy NSData, služba ji automaticky dearchivuje, a získaný objekt (je-li třídy NSURL, samozřejmě) vrátí;

• pokud je získaným objektem NSString, aplikuje se na něj nejprve služba stringByExpandingTildeInPath, a pak se pro něj vytvoří NSURL.

Díky tomuto mechanismu je možné většinu uložených URL bez problémů předávat mezi aplikacemi na systémech starších a 10.6, s tím, že starší systémy prostě ukládají cesty pomocí příkazu "[NSUserDefaults setString:[path stringByAbbreviatingWithTildeInPath] forKey:...]" a podobně načítají příkazem "path=[[NSUserDefaults stringForKey:...] stringByExpandingTildeInPath]". Aplikace od verse 10.6 výše samozřejmě využijí právě popsaných služeb.