Free Pascal (6.) - FCL a XML (1.)

Osobně za jednu z nejužitečnějších částí FCL považuji podporu značkovacího jazyka XML, která, ač není dokonalá, jistě usnadní tvorbu mnoha programů. Dnes bych začal v podstatě nejvyšší úrovní, podporou konfiguračních XML souborů v jednotce

19.5.2004 08:00 | Aleš Hakl | Články autora | přečteno 4802×

FCL nám mimo jiného umožňuje jednoduše používat XML soubory pro ukládání konfigurace, a právě tímto tématem bych začal naše vyprávění o XML ve Free Pascalu. Bohužel není FCL příliš kvalitně dokumentována a nejlepším zdrojem informací jsou tedy přímo zdrojové kódy. Vězte tedy, že většina tříd týkajících se XML se nachází v jednotkách ležících v adresáři fcl/xml/ zdrojových kódů Free Pascal Compileru (které instalátor implicitně nainstaluje do /usr/local/src/fpc-číslo-verze).

My se dnes budeme zabývat třídou TXMLConfig z jednotky xmlcfg. Ta nám velmi jednoduše umožní mít hierarchickou konfiguraci v dokumentu XML (což vlastně není podstatné). Vlastní dokument vypadá tak, že v kořenovém elementu <CONFIG /> jsou jednotlivé tagy v závislosti na názvech našich konfiguračních parametrů. Může to vypadat například takto:

<?xml version="1.0"?>
<CONFIG>
  <xmlconfig name-prompt="Name:" value-prompt="New value:"/>
  <editor default-extension="txt">
    <auto-save enabled="true" interval="5"/>
    <assembler-mode default-style="Microchip" name-regexp="^.*\.s$"/>
  </editor>
  <environment temp-dir="/var/tmp/"/>
</CONFIG>

Podívej me se nyní, jaké metody a vlastnosti nám vůbec třída TXmlConfig nabízí:

V první řadě je to konstruktor Create:

constructor Create(const AFilename: String);

Dále je zde metoda Flush, která nemá žádné parametry. Voláním této metody zajistíme okamžité zapsaní konfiguračního souboru na disk.

Dále jsou zde tři varianty přetížené metody GetValue, kterými se (překvapivě) dotazujeme na nastavení dané položky v souboru:

function GetValue(const APath, ADefault: String): String;
function GetValue(const APath: String; ADefault: Integer): Integer;
function GetValue(const APath: String; ADefault: Boolean): Boolean;

A když máme metody pro zjištění nastavení, chtělo by to i metody pro jeho změnu:

procedure SetValue(const APath, AValue: String);
procedure SetValue(const APath: String; AValue: Integer);
procedure SetValue(const APath: String; AValue: Boolean);

Možná se divíte, že neexistuje způsob jak položku smazat. Pravdou je, že mazání v takovéto struktuře je poněkud složitější úkol a autoři nejspíše necítíli potřebu tuto možnost implementovat.

Třída TXMLConfig disponuje dvěma vlastnostmi. Jednak vlastností pouze pro čtení Modified, která indikuje, zda-li byla reprezentace konfigurace v paměti změněna (a tudíž potřebuje zapsat na disk). Druhou vlastností je FileName. Čtením zjistíme název odpovídajícího souboru s konfigurací a zápisem můžeme tento soubor změnit. Změna způsobí uložení aktuálního souboru a nové načtení konfigurace z nového souboru, není to tedy cesta, jak načíst konfiguraci ze souboru A a uložit do B, na to již musíme použít jiné prostředky.

I tentokráte jsem si připravil jednoduchou ukázku použití této třidy:

uses xmlcfg;
var
  pName : string;
  pValue : string;
  cfg : TXMLConfig;
begin
  cfg := TXMLConfig.Create('xmlconfig.xml');
  repeat
    write(cfg.GetValue('xmlconfig/name-prompt','Jmeno:'));
    readln(pName);
    if pName=#27 then break;
    writeln(pName,' = ',cfg.GetValue(pName,'< nic >'));
    write(cfg.GetValue('xmlconfig/value-prompt','Nova hodnota:'));
    readln(pValue);
    if pValue=#27 then continue;
    cfg.SetValue(pName,pValue);
  until false;
  cfg.Flush;
  cfg.Free;
end.

Tento program načte soubor xmlconfig.xml a v cyklu se ptá na cestu k položce, kterou si přejeme zobrazit nebo změnit, položku zobrazí a zeptá se na její novou hodnotu, pokud zadáme pouze Escape a odřádkujeme, položka zůstane nezměněna.Stejně tak program ukončíme zadáním Escape místo cesty. (Ano, hodnota #27 znamená Escape)

Zdrojový kód třídy TXmlConfig může mimo jiného sloužit jako pěkná ukázka využítí podpory DOM ve Free Pascalu, které se budeme věnovat v dalších dílech. Skoro bych i řekl, že tak byla třída hlavně myšlena, jelikož její možnosti jsou značně omezené. Dále budeme v našem vyprávění pokračovat z poněkud jiného konce. Podíváme se totiž na vrstvu pod touto třídou, vlastní Document Object Model.

Verze pro tisk

DISKUZE vyjimky 28.5.2004 08:58 Radek Cervinka   Re: vyjimky 1.6.2004 00:33 Aleš Hakl Zobrazit označené Zobrazit vše Příspívat do diskuze mohou pouze registrovaní uživatelé.