Perl (37) - Začínáme s moduly

Moduly umožňují rozdělovat programy do několika nezávislých souborů nebo sdílet tytéž zdrojové kódy mezi více programy.

10.7.2006 06:00 | Jiří Václavík | přečteno 22288×

Modul

Modul je soustavou datových struktur, které souvisejí s určitým problémem. Takový modul můžeme nazvat knihovnou. Modul je kód v separátním souboru, který lze použít ve více programech. Tímto způsobem lze zdrojový kód programu rozdělit na několik logických částí.

Modul si můžeme celkem jednoduše představit. Mějme modul Matematika, ve kterém jsou definovány matematické funkce, které nejsou v základní distribuci Perlu dostupné. Importujeme ho do našeho programu a tyto funkce v něm můžeme používat, aniž bychom se jakkoliv starali o jejich algoritmus. Takže můžeme psát příkazy jako print faktorial(7);. Získali jsme novou funkci, kterou standardní verze Perlu neobsahuje.

Balíky

Každý modul potřebuje svoji sadu jmen, aby názvy proměnných nekolidovaly s jiným kódem. K tomu slouží balíky. Předtím, než budeme v modulech pokračovat, se na ně musíme podívat blíže.

Zamýšleli jste se někdy trochu hlouběji nad významem chybových hlášek? Pokud ano museli jste si všimnout, že před názvem proměnné bylo vždy ještě připsáno main::.

Name "main::promenna" used only once: possible typo at soubor line 1.

main::promenna je totiž celý nebo-li plně kvalifikovaný název proměnné. main je název balíku a promenna jméno proměnné, která je v tomto balíku definována. Oddělují se čtyřtečkou, tedy znaky ::. Je to podobné, jako když voláme do České republiky ze zahraničí a vnitrostátně. Představme si, že každý stát je balíkem s názvem telefonní předvolby. Voláme-li ze zahraničí, musíte uvést předponu 00420. Stejně tak u modulů - z jednoho balíku do jiného musíme volat s předponou (main::promenna). U proměnné, volané z téhož balíku, předpona být nemusí (stačí psát promenna).

Každý balík má svoji vlastní sadu proměnných. V balíku jsou definované proměnné nezávisle na tom, které jsou mimo něj. To znamená, že lze definovat v jediném souboru více proměnných stejného jména. (Vytočením čísla 123456789 se v České republice také dovoláme jinam než třeba v Polsku. V celosvětovém kontextu ale musí být číslo jednoznačné.)

Výchozím balíkem je vždy balík main. Všechny proměnné, které jsme zatím v seriálu definovali, patřily právě sem.

Zápis identifikátoru tedy vypadá následovně.

<typ_proměnné><název_balíku>::<název_proměnné>

Typem proměnné je myšlen znak $ pro skalární proměnné, @ pro pole, % pro hashe a prázdný řetězec pro formáty a ovladače. Všimněme si, že se uvádí už před jméno balíku. Nikoliv až před lokálním názvem, jak by se mohlo čekat.

Příkaz package

K přepínání aktivního balíku uvnitř programu se používá příkaz package, za kterým je uveden název balíku. Platnost příkazu package končí uvedením jiného package nebo koncem bloku, ve kterém byl package použit.

Nutno podotknout, že to s příkazem package není vhodné v jednom souboru přehánět. Nejlepší a nejpřehlednější použití balíků spočívá v jejich vytvoření tak, aby každý byl v separátním souboru. Příkaz package je v tomto případě použít v každém souboru pouze jednou ihned na začátku zdrojového kódu programu.

Ukážeme si konkrétní úsek kódu, který se pokusí použití funkce package demonstrovat.

$prom = 1;
package JinyBalik;
$prom = 2;
package main;
print $prom;

Nejdříve je do proměnné $main::prom (main je implicitní balík) přiřazena hodnota 1, poté se přepne aktuální balík na JinyBalik (obvykle se počáteční písmeno balíku píše velkým písmenem. Výjimkou bývá výchozí balík main, který je vždy s malým m.) a do proměnné $JinyBalik::prom se přiřadí hodnota 2. Opět přepneme balík, tentokrát zpátky na main a tiskneme proměnnou $main::prom, která má hodnotu 1.

V případě, že je aktuálním balíkem balík JinyBalik, lze se dostat k hodnotě proměnné odjinud uvedením plně kvalifikovaného názvu.

$prom = 1;
package JinyBalik;
$prom = 2;
print $main::prom;

Ještě se krátce zmiňme o speciálním symbolu __PACKAGE__. Ten obsahuje vždy jméno aktuálního balíku. Lze ho použít podobně jako klasickou proměnnou. Podmínkou je, aby se nedostal do uvozovek, protože pak by nešlo o symbol a Perl by ho identifikoval jako část řetězce.

print __PACKAGE__;

Moduly v Perlu

Moduly se obvykle ukládají do samostatných souborů s příponou .pm (zkratka Perl Module). Přípona je oproti obyčejným .pl programům důležitá, protože ji předpokládá příkaz use sloužící k zavedení modulu do programu. Část názvu souboru před příponou je shodná s názvem modulu. Modul Data tak bude uložen v souboru Data.pm.

Uvedeme si první a značně nedokonalý příklad konkrétního modulu. Do souboru Zeme.pm uložíme hodnoty, které popisují fyzikální vlastnosti Země.

$polomer = 6378000;
$hustota = 5515;
#apod.
1;

Poslední řádek je návratovou hodnotou zavedení modulu a obsahuje ji každý modul. Podle této hodnoty se zachová příkaz pro načtení modulu do programu. Pokud je vrácena pravdivá hodnota, bylo načtení úspěšné.

Teď modul Zeme zavedeme do nějakého programu. K tomu slouží příkaz use. V adresáři, ve kterém je Zeme.pm vytvoříme další soubor - samotný program.

use Zeme;
print "Hodnota rovníkového poloměru Země je ". $polomer/1000 ." km.";

Nyní nám však nastal problém, který by mohl zejména v rozsáhlejších programech nadělat pořádnou neplechu. Co když budeme chtít definovat nějakou proměnnou, která má shodný název jako jiná proměnná v importovaném modulu? Zákonitě dojde ke kolizi názvů proměnných. Modulová hodnota se jednoduše přepíše. Této kolizi je třeba nějakým způsobem předcházet.

Právě z důvodu, že mechanizmus modulů sám o sobě neodděluje jmenné prostory, jsme si zmiňovali balíky. Pomocí nich si jmenné prostory vytvoříme sami.

Dělá se to tak, že v samotném modulu definujeme balík, který bude mít pro přehlednost stejné jméno jako název celého modulu. V souboru Zeme.pm přidáme na první řádek název balíku.

package Zeme;
$polomer = 6378000;
$hustota = 5515;
1;

Prostory pro proměnné jsou nyní odděleny. Modul používá jmenný prostor Zeme:: a proměnné v programu jsou v main::. Jeden problém jsme vyřešili a v důsledku se nám objevil další. Spusťme teď samotný program. Proměnná $polomer nebude definovaná. Je to však správné - modul (a tedy i proměnnou $polomer) jsme definovali v balíku Zeme (je definováno $Zeme::polomer), ale proměnné voláme z balíku main (voláme $main::polomer). To jsou dvě různé proměnné.

Musíme tedy změnit program a místo $polomer volat $Zeme::polomer.

use Zeme;
print "Hodnota rovníkového poloměru Země je ". $Zeme::polomer/1000 ." km.";

Moduly nejsou obvykle takto jednoduché (to však neznamená, že by se moduly uchovávající konstanty nepoužívaly). Ve většině modulů jsou definovány i nějaké složitější struktury než obyčejné proměnné. Na závěr si uveďme definici modulu Mat, který bude sčítat, odčítat, násobit a dělit. To znamená definici čtyř podprogramů.

package Mat;
use strict;

#vstup: n sčítanců
#vystup: součet
sub soucet {
    my $soucet = 0;
    $soucet += $_ while $_ = shift @_;
    return $soucet;
}

#vstup: n činitelů
#vystup: součin
sub soucin {
    my $soucin = 1;
    return undef if !@_;
    $soucin *= $_ while $_ = shift @_;
    return $soucin;
}

#vstup: menšenec, menšitel
#vystup: rozdíl
sub rozdil {
    return $_[0] - $_[1];
}

#vstup: dělenec, dělitel
#vystup: podíl
sub podil {
    return undef if $_[1] == 0;
    return $_[0] / $_[1];
}

1;

Teď můžeme modul importovat a používat v něm definované funkce. Systém je stále tentýž.

use Mat;
print Mat::soucin(10, 8, 6, 3);
print Mat::rozdil(7, 2);

Příště se podíváme na speciální modul Exporter, který otevírá dveře k dalším možnostem v importu modulů.

Online verze článku: http://www.linuxsoft.cz/article.php?id_article=1266