Bernd
Pol
Ian
Wadham

# Bygga och projekthantering

Det här kapitlet behandlar bara kompilerade projekt, som projekt med C++, &Java; eller Fortran. Projekt för skriptspråk som Python och PHP, fungerar mycket annorlunda.

Här hittar du information om följande ämnen:

- Sammanfattning av Hantering av automake innehåller en översikt över Hantering av automake,

- Användning av Hantering av automake beskriver grunderna i hur man arbetar med Hantering av automake.

## Sammanfattning av Hantering av automake

I kapitlet Byggsystem har vi gett en grov översikt av de byggsystem som vanligen används på Unix-system. I följande avsnitt tittar vi på detta i mer detalj.

Det finns en viss förvirring angående hur sådana ting ska namnges. &GNU; kallar dem byggsystem när Automake, Autoconf och Libtool beskrivs. Qmake kallas ett verktyg att skriva Makefiles för olika kompilatorer och plattformar. I KDE används ofta uttrycket projekthanteringssystem. Vi använder det uttrycket i en vidare bemärkelse för att beskriva de inbyggda miljöer i &kdevelop; som används för att organisera och bygga projekt. I det här avsnittets sammanhang, talar vi dock i huvudsak om automatiserade byggsystem.

### Behovet av ett automatiserat byggsystem

Om du har ett enkelt program som skriver ut Hej allihop, skrivet i C, kan du kompilera och länka det med &gcc; `-o hej hej.c` och köra det med `./hej`, så du behöver inte ens en `Makefile`.

Om du har ett C-program med flera moduler och deklarationsfiler och du bara ska köra det på din dator (dvs. det är ett lokalt program), behöver du bara en vanlig `Makefile`, som är ganska enkel att skriva för hand (använd `info make` för att lära dig mer).

Komplikationerna börjar när:

- Din källkod, dokumentation, grafik, ljud, översättningar, datafiler etc. finns i mer än en katalog,

- Du har en hierarki av kataloger och underkataloger,

- Du använder bibliotek som inte är en del av den traditionella uppsättningen på &UNIX;, som &Qt;-objektbiblioteket eller &kde;-skrivbordsbibliotek,

- Du använder en preprocessor för att skapa en del av din källkod, som Qt:s MOC prekompilator,

- Du siktar på att distribuera programmet i hela världen, till personer som inte har samma &UNIX;- eller &Linux;-system, programvara och hårdvara som du,

- Du kräver en automatisk funktion för installation och avinstallation,

- Du siktar på att göra ditt program en del av &kde;:s uppsättning med skrivbordsprogram.

Om du befinner dig i några eller alla av ovanstående situationer, behöver du troligen ett byggsystem. I exemplet ovan använde vi &gcc; för att kompilera och bygga programmet Hej, men alla C-kompilatorer heter inte &gcc;. Så om du distribuerar programmet till någon som använder en annan C-kompilator, måste din Makefile på något sätt använda namnet på den personens kompilator, annars misslyckas kompileringen av programmet. Detta är bara ett av många exempel på vad som kan gå fel.

Ett byggsystem jämnar ut skillnaderna åt dig.

- Det kontrollerar att biblioteken som behövs finns på varje dator som tar emot programmet,

- avsöker automatiskt alla programkataloger efter filer att förbehandla, kompilera eller installera och

- installerar komponenterna som programmet består av i rätt kataloger, och försäkrar att

- katalogerna på datorn som tar emot programmet skapas efter behov.

I korthet erbjuder ett byggsystem säkra metoder för att kompilera och installera programmet på alla datorer som tar emot programmet. Som vi har visat tidigare i översikten Projekthanteringssystem, erbjuder &kdevelop; tre automatiserade byggsystem och möjlighet att skapa din egen Makefile. I korthet (klicka på projektnamnen för mer information):

- Automake-projekt som använder de vanliga utvecklingsverktygen för &GNU;.

- Qmake-projekt som använder Trolltechs Qmake-projekthantering.

- ANT-projekt som använder Apaches ANT-projekthantering för &Java;-utveckling.

- Eget projekt som kräver att du underhåller din egen `Makefile`.

Ett av de fyra alternativen måste väljas när du skapar ett projekt, och valet är svårt att senare ändra, så du bör tänka efter innan du börjar.

### Handledningar om Autoconf, Automake och Libtool

Det finns flera handledningar tillgängliga om &GNU;:s byggsystem (`Autoconf`, `Automake` och `Libtool`) som Hantering av automake använder sig av.

- En kort handledning om autoconf, skriven av Christopher W. Curtis finns tillgänglig på &kdevelop;s hemsida. Den koncentrerar sig på några grundläggande steg för att ändra en `Makefile`.

- En mer detaljerad handledning finns som en del av en större uppsättning handledningar under Utveckla programvara med GNU.

- Den berömda getboken, som heter Autoconf, Automake, and Libtool, finns också. Den är en lättläst, men ändå kortfattad, introduktion till alla viktiga aspekter av &GNU;:s autoverktyg.

### Vad gör Hantering av automake?

Programguiden har skapat några ursprungliga `Makefile.am` filer när du skapade ett nytt projekt av en typ som använder &GNU;:s byggsystem, som C++ KDE Application framework. Under utvecklingen skapar Hantering av automake alla ytterligare `Makefile.am` filer för projekt som använder &GNU;:s byggsystem, och underhåller alla, både de som skapats med programguiden och Hantering av automake.

Det finns en `Makefile.am` i varje projektkatalog som innehåller filer som ska kompileras eller installeras. Den innehåller dina specifikationer för att kompilera, bygga och installera filer och en referens till alla underkataloger som också har en `Makefile.am` och möjligen några filer att kompilera, bygga och installera.

Projektets kataloger och källkodsfiler kan struktureras till vilket djup som helst, eller du kanske föredrar en platt projektstruktur med alla underkataloger på toppnivå.

Målet med &GNU;:s byggsystem är att skapa filstrukturer för källkod som kan kompileras, byggas och installeras på vilket &UNIX;- eller &Linux;-system som helst med de enkla kommandona:

    ./configure
    make
    make install    # Oftast som systemadministratör.

och kan avinstalleras med kommandot `make uninstall` (oftast som systemadministratör).

Hur fungerar det? Ja, `configure` är ett skript som:

- arbetar fram detaljinformation om systemet som det körs på, som vilken kompilator och vilka bibliotek som ska användas, var de finns, och därefter

- rekursivt skapar filerna `Makefile` genom att fylla i det som ska ersättas i motsvarande `Makefile.in`.

Filen `Makefile.am` är indata, en mall som ger grundläggande information för den `Makefile` som ska skapas, genom att fylla i viss systemberoende information. Den skapas av verktyget `Automake` från filen `Makefile.am`.

Processen att komma från en `Makefile.am` (där `.am` anger mallfiler för Automake) till `Makefile` hanteras automatiskt av &kdevelop;s Hantering av automake med verktyget `Autoconf`, `M4`-makron och andra mysterier vi inte behöver gå in på här.

Så när `make` kör, hämtar det automatiskt rätt information från den nuvarande miljön, som kompilatorer och bibliotek. På samma sätt, placerar `make install` delarna av programmet, som körbara filer, dokumentation och datafiler på rätt plats i den miljön.

Om du distribuerar programmet som ett tar-arkiv (en enda komprimerad fil som &kdevelop; kan skapa åt dig), innehåller den filerna `Makefile.in` och skriptfilen `configure`, så att mottagaren kan kompilera, bygga och installera programmet utan att ha `Automake`, `Autoconf` eller KDevelop på sin dator. Filerna `Makefile.am` ingår också, ifall mottagaren måste göra några ändringar i källkoden.

Reglerna är väsentligt annorlunda om du distribuerar via ett webbaserat källkodsarkiv som &kde;:s &cvs;.

### Sammanfattning av vad Hantering av automake gör

- Skapar filerna `Makefile.am` i underkatalogerna som det känner till som delprojekt.

- Uppdaterar filerna `Makefile.am` när projektstrukturen ändras.

- Uppdaterar filerna `Makefile.am` när filer läggs till i eller tas bort från projekt.

- Accepterar definitioner om hur de olika filerna ska byggas eller installeras, och ändrar `Makefile.am` enligt dem.

- Accepterar parametrar som används vid byggning eller installation (t.ex. biblioteksnamn), och försäkrar att de används i de nödvändiga kompilerings- och byggstegen.

### Innehåll i automake-filer

Filen `Makefile.am` har rader som innehåller variabelnamn följda av ett likhetstecken och en lista med filer eller parametervärden. Variabler har tvådelade namn, som `bin_PROGRAMS`, `mittpgm_SOURCES` eller `kdelnk_DATA`. Den andra delen kallas den primära och representerar något som ska byggas eller installeras. Den första delen kallas prefix och representerar:

- En katalog där installationen ska göras (t.ex. `bin`),

- En kvalifikation för den primära delen (t.ex. mittpgm för `SOURCES`, som anger att källkodsfiler som listas efter `mittpgm_SOURCES` ingår i att bygga `mittpgm`.

- Ett särskilt prefix `noinst` (kort för ingen installation), som oftast används för att lista programmets deklarationsfiler (`.h`),

- Eller det speciella prefixet `EXTRA`, för konfigurationsberoende saker.

För mer information om `Automake` och filerna `Makefile.am`, slå upp den med `info Automake`.

I huvudsak skapar och uppdaterar Hantering av automake variabelnamn och fillistor eller parametrar. Se följande exempel på en `Makefile.am` för ett typiskt program, som kallas `mittpgm`.

    ## Makefile.am för mittpgm

    # det här är programmet som installeras. dess namn används för alla
    # andra Makefile.am variablerna
    bin_PROGRAMS = mittpgm

    # ställ in sökvägen för deklarationsfiler till X, Qt och KDE
    INCLUDES = $(all_includes)

    # bibliotekssökvägen.
    mittpgm_LDFLAGS = $(KDE_RPATH) $(all_libraries)

    # biblioteken att länka med.
    mittpgm_LDADD   = $(LIB_KFILE) $(LIB_KDEPRINT)

    # vilka källkodsfiler ska kompileras för mittpgm
    mittpgm_SOURCES = main.cpp mittpgm.cpp mittpgmvy.cpp

    # det här är deklarationsfilerna för projektet
    noinst_HEADERS = mittpgm.h mittpgmvy.h

    # låt automoc hantera alla metakällfiler (moc)
    METASOURCES = AUTO

    KDE_ICON = mittpgm

    # det är här kdelnk-filen hamnar
    kdelnkdir = $(kde_appsdir)/Utilities
    kdelnk_DATA = mittpgm.desktop

    # det är här XML-GUI resursfilen hamnar
    rcdir = $(kde_datadir)/mittpgm
    rc_DATA = mittpgm_ui.rc

    AM_CXXFLAGS = -DMITT_C++_PREPROCESSOR_ALTERNATIV

Som du kan se är många av objekten på högersidan symboler på formen `$(xxxx)`. De är miljövariabler som definieras i själva &kde;-miljön och ersätts med riktiga värden när `./configure` skapar de slutliga filerna `Makefile` på datorn som tar emot programmet.

Det är också en god idé att köra kommandot `./configure --help` någon gång efter du har börjat med &kdevelop;, som visar dig de olika saker du kan ändra vid bygg- och installationstid, såsom en testmiljö. I synnerhet kommandot:

    ./configure --prefix=/var/du/vill

flyttar hela installationen till en katalogstruktur som du väljer, genom att ändra den interna variabeln `$(prefix)` till värdet `/var/du/vill`.

## Användning av Hantering av automake

I det här kapitlet hittar du en grundläggande beskrivning av elementen i Hantering av automake, och hur de används. Det täcker:

- Fönstret Hantering av automake beskriver den grundläggande strukturen hos huvudfönstret i Hantering av automake.

- Översiktsfönstret beskriver elementen i det övre delfönstret.

- Detaljfönstret beskriver elementen i det undre delfönstret.

- Navigera i Hantering av automake listar några grundläggande åtgärder du kan utföra i Hantering av automake.

- Sammanhangsberoende menyer i Hantering av automake beskriver menyerna som dyker upp när du väljer en åtgärd i Hantering av automake.

### Fönstret Hantering av automake

- Hantering av automake använder ett delat fönster. Den övre delen kallas Översiktsfönstret och den undre delen kallas Detaljfönstret. Mellan dem finns en smal rad som kan dras med musen för att justera fönsterstorlekarna. I IDEA-fönsterläge kan du också dra sidokanten på det delade fönstret för att ändra bredden.

- Ovanför varje fönster finns en verktygsrad, där knapparna blir aktiva när ett element i fönstret markeras. Det här erbjuder ett sätt som du kan komma åt åtgärderna som tillhandahålls för det elementet. Det andra sättet är sammanhangsberoende menyer, som dyker upp vid klick med höger musknapp som beskrivs nedan.

- I IDEA-fönsterläge finns det ytterligare två små knappar till vänster i namnlisten på fönstret Hantering av automake: en triangelformat högerpil, och en knapp med en punkt. Pilknappen används för att stänga fönstret. Å andra sidan, behåller punktknappen fönstret öppet även om ett annat fönster väljs i &kdevelop;. (Annars stängs fönstret Hantering av automake automatiskt så fort ett annat fönster får inmatningsfokus.)

### Översiktsfönstret

Översiktsfönstret innehåller en trädlista med alla kataloger i projektet som innehåller programfiler, dokumentation eller data. Varje sådan katalog innehåller en fil `Makefile.am` och är känd som ett delprojekt i Hantering av automake. Det finns tre typiska delprojekt i ett &kde;-baserat projekt, som visas på bilden ovan:

- `src`: källkodsfiler för programmet,

- `doc`: användarmanualen eller handboken,

- `po`: utdrag av strängar i dina källkodsfiler som kräver översättning till andra mänskliga språk (t.ex. fönsterrubriker, menynamn, namn på knappar, text i dialogrutor och meddelanden av olika slag).

Observera att delprojektet `doc` alltid har ett delprojekt som heter `en`, som du kan se om du klickar på symbolen + intill ordet `doc`. Det beror på att grundspråket för all dokumentation i KDE är engelska (en). Om programmet blir en del av KDE, kan KDE:s översättningsgrupper översätta din dokumentation från engelska till andra språk, och översättningarna hamnar då i andra delprojekt, som `sv` (svenska), `de` (tyska) eller `fr` (franska). Strängarna i delprojektet `po` kan också översättas och lagras i andra filer under `po`, för att på så sätt låta programmet hanteras av personer som inte kan engelska.

Delprojekten `doc` och `po` tjänar olika syften. `doc` innehåller dokumentation, som en användarhandbok, medan `po` innehåller textsträngar som kan översättas från användargränssnittet som ingår i programmets källkod.

Översiktsfönstret fungerar bland annat som ett navigeringsverktyg. Om du väljer ett delprojekt i översiktsfönstret, visas motsvarande detaljinformation i detaljfönstret.

### Detaljfönstret

Detaljfönstret innehåller en lista med alla filer i delprojektet som för närvarande är markerat i översiktsfönstret, samt kompilerings-, bygg- och installationsreglerna för delprojektet. På så sätt kan fönstren tillsammans ge dig möjlighet att komma åt alla komponenter i programmet, och all information om hur det ska kompileras, byggas och installeras.

#### Mål

Trädlistan i detaljfönstret har två nivåer. Den översta nivån består av så kallade mål i Hantering av automake, och nästa nivå innehåller listor med filer som används för att skapa varje mål.

Det här konceptet med ett mål i Hantering av automake, skiljer sig något från vad ett mål i en `Makefile` oftast är. I korthet:

- Definitionen av hur ett antal filer ska kompileras, byggas eller installeras är känt som ett mål i Hantering av automake, men som en variabel i själva `Automake`.

- Ett mål i `make` är ofta något helt annat, eftersom det kan vara en väljare till kommandot `make` (t.ex. `make install`, `make clean`).

  Vissa av variablerna i `Makefile.am` representerar dock ett underliggande delmål för `make`.

### Navigera i Hantering av automake

Både i översiktsfönstret och detaljfönstret kan du vänsterklicka på + eller - intill ett delprojekt eller målnamn för att expandera eller dra ihop trädvyn. Om du gör det med ett delprojekt i översiktsfönstret, visas eller döljs delprojektets nästa underliggande nivå (om det finns någon). Om du gör det med ett mål i detaljfönstret, visas eller döljs listan med filer som ingår i målet.

Öppna en fil för redigering

  Om du vänsterklickar på ett filnamn i detaljfönstret, öppnas motsvarande fil i &kdevelop;s redigeringsfönster.

Aktivera verktygsradsknapparna i Hantering av automake

  Om du vänsterklickar på ett delprojektnamn i översiktsfönstret eller ett mål i detaljfönstret, markeras namnet och vissa knappar i verktygsraden blir aktiva längst upp i fönstret.

  Du rekommenderas använda höger musknapp och sammanhangsberoende menyer, istället för knapparna i verktygsraden, eftersom det är då mycket enklare att se och förstå vad du gör.

  Åtgärder för delprojekt och mål har långtgående effekter för struktur, kompilering, byggning och installation av programmet.

Välja åtgärder och sammanhangsberoende menyer

  Om du högerklickar på ett delprojektnamn, mål eller fil, dyker en meny upp och du kan därefter välja åtgärder att utföra för delprojektet, målet eller filen, som att lägga till ett mål i delprojektet, lägga till en fil i målet eller logiskt ta bort den markerade filen från sitt mål.

### Sammanhangsberoende menyer i Hantering av automake

Följande avsnitt förklarar kortfattat vilka åtgärder som menyerna gör tillgängliga, som dyker upp vid klick med höger musknapp i fönstret Hantering av automake. Avsnitten är bara avsedda som en översikt. Du hittar detaljerade beskrivningar av de flesta åtgärderna i ett senare kapitel.

#### Sammanhangsberoende menyn för en fil

När du högerklickar på ett filnamn i detaljfönstret, dyker följande meny upp som låter dig välja en av flera åtgärder att utföra med filen. I bilden nedan, markerades ikonfilen `hi-16app-mittpgm.png` i målet Ikondata i kde_icon från delprojektet mittpgm/src.

- Det huvudsakliga alternativet i den sammanhangsberoende menyn är att Ta bort filen från målet (dvs. den kommer inte längre att användas för att kompilera, bygga eller installera det målet).

- Alternativet CVS erbjuder en hel del olika CVS-åtgärder för filen.

- Alternativet Öppna med låter dig öppna filen med ett antal editorer eller med vilket program som helst (t.ex. kan du öppna ikonfilen i vårt exempel med Kicon).

- Alternativet Perforce används för liknande åtgärder som i CVS, men med det kommersiella versionshanteringssystemet Perforce.

#### Sammanhangsberoende menyn för ett mål

När du högerklickar på ett mål i detaljfönstret, dyker följande meny upp som låter dig välja en av flera åtgärder att utföra med det. I bilden nedan, markerades målet mittpgm (Program i bin) i delprojektet mittpgm/src.

- Alternativet Inställningar för ett mål gäller bara källkodsfiler. I motsvarande dialogruta kan du ange länkargument och sökvägar där bibliotek kan hittas, och du kan ange en lista med verkliga bibliotek som ska länkas med i programmet.

- Alternativet Skapa ny fil visar en dialogruta där du kan ange filnamnet och filtypen som ska skapas (i en kombinationsruta).

- Alternativet Lägg till befintliga filer visar en dialogruta där du kan lägga till en befintlig fil till målet.

- Alternativet Ta bort för ett mål låter dig logiskt ta bort målet och alla dess filer från projektstrukturen.

- Alternativet Gör mål aktivt gäller bara för mål som innehåller källkodsfiler. Nya filer läggs alltid till i ett sådant aktivt mål.

- Alternativet Bygg mål anropar alla nödvändiga kompilerings- och byggåtgärder för att bygga koden enbart för detta mål.

#### Sammanhangsberoende menyn för ett delprojekt

När du högerklickar på ett delprojekt i översiktsfönstret, dyker följande meny upp som låter dig göra större ändringar i projektets struktur och sättet det kompileras, byggs och installeras. Du kan använda den för att utöka eller ändra den grundläggande projektstrukturen som programguiden har skapat.

- Alternativet Inställningar för ett delprojekt styr sättet som delprojektet kompileras, byggs och installeras. Dialogrutan som dyker upp har flikar för Kompilator, Deklarationsfiler, Prefix och Byggordning.

- Alternativet Lägg till delprojekt skapar en ny katalog och Makefile.am skelettfil.

- Alternativet Lägg till mål visar en dialogruta, där du kan ställa in regler för kompilering, byggning eller installation för en filgrupp inne i delprojektet.

- Lägg till tjänst (... ännu inte skrivet ...)

- Lägg till program (... ännu inte skrivet ...)

- Lägg till befintliga delprojekt (... ännu inte skrivet ...)

- Alternativet Ta bort delprojekt i den sammanhangsberoende menyn för ett delprojekt är det riktiga sättet att ta bort ett delprojekt. Det justerar filerna `Makefile.am` på motsvarande sätt. Du erbjuds också möjlighet att ta bort alla filer (eller länkar) i motsvarande underkatalog. Uppenbarligen ska funktionen användas med försiktighet.

- Alternativet Bygg anropar alla nödvändiga kompilerings- och byggåtgärder för att bygga koden för enbart detta delprojekt.

- Tvinga omredigering (... ännu inte skrivet ...)

- Rensa (... ännu inte skrivet ...)

- Installera (... ännu inte skrivet ...)

- Installera (som systemadministratör) (... ännu inte skrivet ...)

## Automake-projekt

(... ännu inte skrivet ...)

### Autoconf

#### Effekten av configure-skriptet

`Makefile.in` till `Makefile`

    prefix = @prefix@
    INSTALL = @INSTALL@
    build_triplet = @build@
    CXX = @CXX@

    prefix = /home/bernd/kde3
    INSTALL = /usr/bin/ginstall -c -p
    build_triplet = i686-pc-linux-gnu
    CXX = g++

`config.h.in` till `config.h`

    /* Define if you have libz */
    #undef HAVE_LIBZ
    /* The size of a `int', as computed by sizeof. */
    #undef SIZEOF_INT

    /* Define if you have libz */
    #define HAVE_LIBZ 1
    /* The size of a `int', as computed by sizeof. */
    #define SIZEOF_INT 4

### Automake

(... ännu inte skrivet ...)

### &kdevelop;s Hantering av automake

#### En skärmbild av Hantering av automake

### Bygga och installera bibliotek

- -rpath

- PIC

- static

- insticksprogram: no-undefined

## Egna byggfiler och byggskript

(... ännu inte skrivet ...)

## Kompilatorinställningar

(... ännu inte skrivet ...)

## Byggalternativ

(... ännu inte skrivet ...)