KDevelop4/Manual/Kodegenering med skabeloner
Kodegenering med skabeloner
KDevelop bruger skabeloner til at generere kildekodefiler og for at undgå at skrive kode som gentages.
Opret en ny klasse
Den mest almindelige anvendelse af kodegenerering er formentlig at skrive en ny klasse. For at oprettet en ny klasse i et eksisterende projekt skal du højreklikke på projektmappen og vælge . Den samme dialog kan startes fra menuen ved at vælge , men at bruge en projektmappe har den fordel, at basis-URL'en bliver sat for outputfilen. Vælg Klasse i afsnittet kategori og det sprog og den skabelon der ønskes i de andre to felter. Efter at du har valgt en klasseskabelon skal du angive detaljer om den nye klasse.
Først skal du angive en identifikator for klassen. Dette kan være en simpelt navn (som Bus) eller en komplet identifikator men navnerum (som Transportation::Bus). I det sidste tilfælde vil KDevelop fortolke identifikatoren og separere navnerummet fra det egentlige navn. I det samme vindue kan du tilføje den nye klasses basisklasser. Du bemærker måske, at nogle skabeloner selv vælger en basisklasse, men du kan frit fjerne den og du kan tilføje andre basisklasser. Du bør skrive hele nedarvningserklæringen her, hvilket afhænger af sproget, fx public QObject for C++, extends SomeClass for PHP og blot klassens navn for Python.
I det næste vindue kan du vælge bland de virtuelle metoder fra alle nedarvede klasser samt nogle standard konstruktorer, destruktorer og operatorer. Markér afkrydsningsfeltet vedsiden af en metodesignatur for at implementere denne metode i den nye klasse.
Når du klikker på kommer du til et vindue, hvor du kan tilføje medlemmer til klassen. Afhængigt af den valgte skabelon vil de optræde som medlemsvariable i den nye klasse eller skabelonen vil oprette settere og gettere for dem. I sprog som C++, hvor variable skal erklæres skal du angive både type og navn for medlemmet som fx int number eller QString name. I andre sprog behøver du ikke at angive typen, men det er god praksis at have den med alligevel, for den valgte skabelon kan stadig drage nytte af det.
I de følgende vinduer kan du vælge licensen for din nye klasse, angive særlige oplysninger, som den valgte skabelon skal bruge og angive, hvor de genererede filer skal placeres. Du afslutter guiden ved at klikke , hvorefter den nye klasse genereres. De genererede filer vil blive åbnet i editoren, sådan at du kan begynde at arbejde med dem med det samme.
Efter at have oprettet en ny C++-klasse vil du få mulighed for at føje den til et projektmål. Vælg et mål i dialogvinduet eller annulér vinduet og føj filen til et mål manuelt.
Hvis du valgte skabelonen Qt Objekt, markerede nogle standardmetoder og tilføjede et par medlemsvariable, så skulle outputtet ligne det på billedet herunder.
Du kan se, at datamedlemmerne er blevet lavet om til Qt egenskaber med tilgangsfunktioner og Q_PROPERTY-makroer. Argumenter til setterfunktioner overgives endda ved const-reference, hvor det er passende. Desuden er en privat klasse blevet erklæret og en privat pointer oprettet med Q_DECLARE_PRIVATE. Alt dette gøres af skabelonen. Havde du valgt en anden skabelon, så havde resultatet nok set helt anderledes ud.
Opret en ny unittest
Selv om de fleste testsystemer kræver, at hver test også er en klasse, så har KDevelop en metode til at forenkle oprettelsen af enhedstest. For at oprette en ny test skal du højreklikke på en projektmappe og vælge . I skabelonvalgsvinduet vælger du Test som kategori og derefter dit programmeringssprog og din skabelon og klikker så .
Du bliver nu spurgt om testens navn og en liste af testtilfælde. For testilfældene skal du blot angive el liste med navne. Nogle enhedstestsystemer så som PyUnit og PHPUnit kræver, at testtilfældene starter med et specielt præfiks. I KDevelop er skabelonen ansvarlig for at tilføje præfikset, så du skal ikke føje det til testtilfældene her. Efter at have klikket på skal du angive licens og outputplacering for de genererede filer; så bliver testen oprettet.
Enhedstest oprettet på denne måde vil ikke automatisk blive føjet til noget mål. Hvis du bruger CTest eller et andet testsystem, så sørg for at føje de nye filer til et mål.
Andre filer
Selv om klasser og enhedstest får særlig opmærksomhed ved kodegenerering fra skabeloner, så kan samme metode bruges til enhver slags kildekodefiler. Du kan for eksempel bruge en skabelon til et Find-modul til CMake eller til en .desktop-fil. Dette kan gøres ved at vælge og vælge den ønskede kategori og skabelon. Hvis du vælger en anden kategori end Klasse eller Test, så vil du kun få mulighed for at vælge licens, særlige oplysninger krævet af skabelonen samt placering af outputfiler. Som med klasser og test bliver filerne genereret og åbnet i editoren når du afslutter guiden.
Håndtering af skabeloner
I guiden kan du også downloade flere filskabeloner ved at klikke på knappen . Dette åbner en Hent smarte nye ting-dialog, hvor du kan installere flere skabeloner samt opdatere eller fjerne dem. Der er også et konfigurationsmodul for skabeloner, som åbnes med menuen . Her kan du håndtere både filskabeloner (forklaret ovenfor) og projektskabeloner (som bruges til at oprette nye projekter).
Du kan selvfølgelig altid oprette nye skabelober, hvis ingen af de tilgængelige skabeloner passer til dit projekt. Den nemmeste måde er nok at kopiere og modificere en eksisterende skabelon; du kan finde hjælp i den korte vejledning og det længere specifikationsdokument. For at kopiere en installeret skabelon åbner du skabelonhåndteringen ved , markerer den skabelon du vil kopiere og klikker på knappen. Vælg en målmappe og klik på , så bliver indholdet af skabelonen overført til den valgte mappe. Du kan nu redigere skabelonen ved at åben de overførte filer og modificere dem. Når du er færdig kan du importere dine nye skabeloner i KDevelop ved at åbne skabelonhåndteringen, gå til de relevante faneblad (enten eller ) og klikke på . Åbn skabelonens beskrivelsesfil, som har filendelse .kdevtemplate eller .desktop. KDevelop vil komprimere filerne til et skabelonarkiv og importere skabelonen.
Hvis du ønsker at skrive en skabelon fra grunde, så kan du starte med et eksempel på en skabelon for C++-klasser ved at oprette et nyt projekt og vælge projektet C++Class Template i kategorien KDevelop.