SCons se používá poměrně dost i ve světě komečního software. Hlavním důvodem pro jeho použití je jeho bezproblémová činnost pod Windows. Použití GNU autotools pod Windows je lépe se vyhnout a klikací easy-to-use buildovací nástroje integrované v různých IDE prostředích neposkytují potřebnou flexibilitu, pokud vůbec nějakou poskytují.

Některé projekty se vydaly cestou ručně psaných Makefile, které se velice rychle stanou neudržovatelnými. I když pomineme občasné přestavby buildovacího systému, rutinní úlohy, jako je např. správa závislostí, je lépe přenechat počítači. Pokud nám projekt nabobtná a máme stovky ručně psaných makefiles, tak nejenže přestavba takového systému vyžaduje značné usilí, ale díky lidským chybám závislosti nebudou správné a korektní rebuildy vyžadují buďto make clean nebo speciální workaroundy.

V dnešním díle si už poprvé ukážeme praktickou aplikaci nástroje SCons v praxi. Pro následující příklady budeme potřebovat tento software:

1. Python
2. SCons 0.96.91
3. FSPlib

První dva balíčky je vlastní SCons + Python Runtime, třetí balíček je knihovna, kterou budeme s pomocí SCons sestavovat. Knihovna je jednoduchá, ale obsahuje několik kompilačních voleb, přičemž některé lze autodetekovat před vlastní kompilací. Knihovna již s pomocí SCons buildována je, takže si můžete již nyní prohléhnout použití SCons v praxi nespadající do kategorie hello world.

Ahoj SCons

Balíček FSPlib obsahuje tři zdrojové soubory v jazyku C: fsplib.c, lock.c a test.c. První dva tvoří knihovnu, třetí je testovací program. FSP knihovna je komerční produkt a v komerčním světě platí "Co je doma, to se počítá", což v prostředí software engineeringu znamená "Linkuj staticky, nikdy nevíš, co uživatel při údržbě systému vyvede".

Sestavení statické knihovny fsp je jednoduchý oneliner. Do souboru SConstruct stačí dát:

StaticLibrary(target = 'fsp', source = ['fsplib.c','lock.c'])

Jak jsem již zmínil, soubory SConstruct/SConscript jsou vlastně programy v jazyce Python. Ačkoliv znalost programování v tomto jazyce není pro použití SCons nezbytná, je naprosto nutné znát alespoň základní syntax tohoto jazyka.

Po spuštění scons na výše uvedení oneliner zjistíme, že by možná pro úplný začátek byl hello.c vhodnější:

(hsn@ttyv3):/tmp/2% scons
scons: Reading SConscript files ...
scons: done reading SConscript files.
scons: Building targets ...
gcc -o fsplib.o -c fsplib.c
In file included from fsplib.c:33:
lock.h:34:2: #error "No locking type specified"
In file included from fsplib.c:33:
lock.h:39: error: syntax error before '*' token

Abychom prozatím nezabíhali do zbytečných detailů přidáme do lock.h řádek #define FSP_NOLOCKING 1

Pokud jste výše uvedený řádek umístili syntakticky správně, překlad se povede:

(hsn@ttyv3):/tmp/2% scons
scons: Reading SConscript files ...
scons: done reading SConscript files.
scons: Building targets ...
gcc -o fsplib.o -c fsplib.c
gcc -o lock.o -c lock.c
ar r libfsp.a fsplib.o lock.o
ar: creating libfsp.a
ranlib libfsp.a
scons: done building targets.

Dalším krokem je přeložení programu test.c a jeho slinkování s knihovnou. Toho lze v prostředí SCons dosáhnout různými zbůsoby, například uvedením nově vytvořené knihovny mezi ostatní zdrojové kódy programu. To, že je možné dosáhnout stejného výsledku různým způsobem, nepovažuji za nevýhodu, ale naopak za výhodu. Abychom snížili náklady na údržbu kódu, doporučuje se v rámci projektu používat preferovaný postup, specifikovaný Coding Style Guide příslušného projektu.

knihovna=StaticLibrary(target = 'fsp', source = ['fsplib.c','lock.c'])
Program(target = 'test', source = ['test.c', knihovna])

(hsn@ttyv3):/tmp/2% scons
scons: Reading SConscript files ...
scons: done reading SConscript files.
scons: Building targets ...
gcc -o test.o -c test.c
gcc -o test test.o libfsp.a
scons: done building targets.

Podle očekávání došlo pouze ke kompilaci a linkování programu test, nikoliv k rekompilaci celé knihovny. Jednou ze sympatických vlastností Scons je automatické generování cleanup pravidel místo obvyklého make clean se používá:

(hsn@ttyv3):/tmp/2% scons -c
scons: Reading SConscript files ...
scons: done reading SConscript files.
scons: Cleaning targets ...
Removed fsplib.o
Removed lock.o
Removed libfsp.a
Removed test.o
Removed test
scons: done cleaning targets.

Pokud se knihovna nebo program skládá z více zdrojových souborů, je jejich zápis pomocí Python syntaxe ['fsplib.c','lock.c'] dost nepraktický. V prostředí Scons je definována funkce Split(), která rozdělí řetězec podle whitechar a vrátí seznam. Tato funkce je užitečná zejména v kombinaci s další vlastností Pythonu - víceřádkovým řetězcem, jelikož se takto dá využít výstup z programu ls:

sources= Split("""
lbuffer.c    ldelay.c     lmacro.c     lprompt.c    lshell.c     ltimeout.c
lburst.c     lecho.c      lmaxdelay.c  lpwd.c       lsince.c     ltrace.c
lclose.c     lflush.c     lopen.c      lquit.c      lskipto.c    util.c
ldatestamp.c lif.c        lpager.c     lreadme.c    lsource.c
ldebug.c     llcd.c       lport.c      lrehash.c    lstat.c
""")