ARCHIV

Perl (103) - Rozšiřování Perlu pomocí SWIG

Alternativou k minule představenému nástroji XS je SWIG. Uvidíme jinou možnost, jak vytvářet moduly v jazyce C.

27.2.2010 06:00 | Jiří Václavík | Články autora | přečteno 10893×

SWIG má tu výhodu, že podporuje širší paletu skriptovacích jazyků (Perl, Tcl, Python, PHP, Ruby, Java, C# atd. - více na www.swig.org) - nejen Perl, jak je tomu v případě XS. My se však budeme zabývat pouze rozšířením Perlu. Nevýhodou je zejména menší rozšířenost, protože SWIG se narozdíl od XS nedodává se základní distribucí Perlu, ale je třeba ho doinstalovat. Využití obou nástrojů se příliš neliší a je tedy možné si vybrat.

SWIG byl stvořen v červenci roku 1995 Davem Beazleyem v americkém Los Alamos. Poslední verze se datuje na polovinu minulého roku.

Instalace

Již bylo řečeno, že SWIG obvykle mít nainstalovaný nebudeme. Ve většině velkých linuxových distribucí by měl existovat balíček swig, který stačí nainstalovat. Pokud ho nemáte, lze nejnovější verzi tohoto nástroje najít na www.swig.org.

Příklad - implementace prvočísel

Ukážeme si příklad, který bude dělat to samé, jako v minulém dílu a srovnáme oba postupy. Připomeňme si zde, že máme v jazyce C napsané dva soubory. První se jmenuje prvocislo.h a obsahuje hlavičku funkce prvocislo.

int je_prvocislo(int cislo);

V souboru prvocislo.c je tato funkce implementována.

#include <stdio.h>

int je_prvocislo(int cislo){
  int delitel, prvocislo=1;
  for(delitel=2; prvocislo!=0; delitel++){
    if (delitel<cislo){
      if (cislo%delitel!=0)
        prvocislo=1;
      else
        prvocislo=0;
    }else
        break;
  }
  if (prvocislo==0) return 0;
  else return 1;
}

Nástroj XS vyžadoval vytvoření nějakého souboru ve speciálním XS jazyce. SWIG od programátora zase vyžaduje vytvořit nějaký kód v jazyce svém. Tento soubor se nazývá rozhraní (interface) a skládá se z příkazů začínajících znakem %. Je-li na začátku řádku znak %, znamená to, že tento řádek bude zpracováván přímo nástrojem SWIG.

Podívejme se nejprve na náš SWIG soubor. Nazveme ho Prvocislo.i a bude obsahovat následující řádky.

%module Prvocislo
%{
#include "prvocislo.h"
%}
int je_prvocislo(int cislo);

Mezi %{ a %} je úsek kódu v jazyce C. Vše ostatní jsou příkazy pro SWIG. Na posledním řádku jsou deklarace použitých exportovaných funkcí a datových struktur. Syntaxe je stejná jako u deklarací v .h souboru a tedy deklarace můžeme nahradit SWIG příkazem %include. Soubor Prvocislo.i tedy může vypadat i takto.

%module Prvocislo
%{
#include "prvocislo.h"
%}
%include prvocislo.h

Nyní potřebujeme vytvořit pro soubor prvocislo.h vazebný kód. K tomu použijeme příkaz swig. Je třeba specifikovat skriptovací jazyk, pro který chceme vygenerovat modul. V našem případě je to Perl5. Zadejme tedy následující příkaz.

$ swig -perl5 Prvocislo.i

Nyní v aktuálním adresáři vzniklo několik souborů. Soubor Prvocislo.pm je samotná knihovna. Dále vznikl soubor Prvocislo_wrap.c, který pro každou exportovanou funkci funkce obsahuje funkci _wrap_funkce a stará se o zpětný překlad.

Nyní nám zbývá vytvořit z .c souborů knihovny. Toho docílíme překladem. Můžeme použít příkaz gcc.

$ gcc prvocislo.c Prvocislo_wrap.c -I /usr/lib/perl5/5.10.0/i586-linux-thread-multi/CORE
$ ld -shared prvocislo.o Prvocislo_wrap.o -o prvocislo.so

Lepší ale je vygenerovat makefile a postupovat klasicky. Makefile si necháme vytvořit modulem ExtUtils::MakeMaker. Vytvoříme tedy soubor Makefile.PL, který bude mít následující obsah.

use ExtUtils::MakeMaker;
WriteMakefile(
  "NAME"   => "Prv2",
  "LIBS"   => ["-L /usr/local/lib"],
  "OBJECT" => "Prvocislo_wrap.o prvocislo.o"
);

Poté nám již zbývá pouze nainstalovat modul.

$ perl Makefile.PL
$ make
# make install

Tento modul funguje stejně jako modul vytvořený v minulém dílu a tak nám opět bude fungovat následující program.

#!/usr/bin/env perl
use Prvocislo;
print $_.(Prvocislo::je_prvocislo($_)?" je ":" neni ")."prvocislo\n" for (1..10);

Verze pro tisk