This page is a translated version of the page KDevelop5/Manual/Code generation with templates and the translation is 95% complete.

Other languages:
English • ‎dansk • ‎українська
Under construction.png
Under konstruktion
Dette er en ny side, som er ved at blive færdiggjort!


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 Opret fra skabelon.... Den samme dialog kan startes fra menuen ved at vælge Fil -> Ny fra skabelon..., men fordelen ved at bruge en projektmappe er, at basis-URL'en bliver sat for outputfilen. Vælg C++ i afsnittet "Sprog", og det framework og den skabelon der ønskes i de andre to felter. Nederst i dialoges ser du en forhåndsvisning af de filer, der vil blive genereret, og hvor du kan browse igennem disse filer. Efter at du har foretaget dine valg skal du angive detaljer om den nye klasse i dialogen "Basalt for klasse" efter at du har klikket på > Næste..

Kdevelop-new-from-template.png

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.

Kdevelop-class-basics1.png

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 ved siden af en metodesignatur for at implementere denne metode i den nye klasse.

Når du klikker på > Næste kommer du til dialogen "Medlemmer af klasse", 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 egenskaber med 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.Du har også mulighed for at ændre rækkefølgen af klassens medlemmer ved at vælge et medlem og så klikke på enten Flyt op eller Flyt ned. Når filen genereres, så bruges den rækkefølge, som du har valgt.

Kdevelop-class-members-template.png

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 Afslut, 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.

Kdevelop-class-gen-license-choices.png

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-underklasse, markeret nogle standardmetoder og tilføjede et par medlemsvariable, så skulle outputtet ligne det på billedet herunder. Alle de automatisk tilføjede dokumentationsheadere for hver klasse, funktion og dataelement er blevet fjernet for overskuelighedens skyld.

Kdevelop-after-class-generation-lessdoc.png

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. Hvis du vælger QObject pimpl subclass, så bliver en privat klasse 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 Opret fra skabelon.... I dialogen Sprog og skabelon vælger du (programmerings-) Sprog, dit Framework og Skabelon og klikker så Næste.

Kdevelop-test-selection.png

Du bliver nu spurgt om testens navn og en liste af testtilfælde. For testilfældene skal du blot angive en liste med navne. Nogle unittestsystemer 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å Næste skal du angive licens og outputplacering for de genererede filer; så bliver testen oprettet. Unittests, som oprettes på denne måde bliver ikke automatisk føjet til et mål.

Kdevelop-testcases.png

Tilføjer du unittests, og en CMakeLists.txt-fil for at tilføje unittestene til projektet Bus, så får du følgende CMakeLists.txt for projektet Bus, mappen src og mappen tests:

  • Projektet Bus:
     1 cmake_minimum_required(VERSION 3.0)
     2 
     3 project(Bus LANGUAGES CXX)
     4 
     5 set(QT_REQUIRED_VERSION "5.14.0")
     6 find_package(Qt5 ${QT_REQUIRED_VERSION} CONFIG REQUIRED COMPONENTS Core Test)
     7 
     8 set(CMAKE_AUTOUIC ON)
     9 set(CMAKE_AUTOMOC ON)
    10 set(CMAKE_AUTORCC ON)
    11 
    12 set(CMAKE_CXX_STANDARD 11)
    13 set(CMAKE_CXX_STANDARD_REQUIRED ON)
    14 
    15 # Docs only available if this is the main app
    16 find_package(Doxygen)
    17 if(Doxygen_FOUND)
    18 	add_subdirectory(docs)
    19 else()
    20 	message(STATUS "Doxygen not found, not building docs")
    21 endif()
    22 
    23 add_subdirectory(src)
    24 
    25 enable_testing()
    26 add_subdirectory(tests)
    
  • src folder:
    1 set(HEADER_LIST "bus.h")
    2 add_executable(bus main.cpp bus.cpp)
    3 
    4 target_link_libraries(bus PRIVATE Qt5::Core)
    
  • mappen tests:
    1 include_directories("../src")
    2 
    3 add_executable(TestBus testbus.cpp ../src/bus.cpp)
    4 
    5 add_test(NAME TestBus COMMAND TestBus)
    6 
    7 target_link_libraries(TestBus PRIVATE Qt5::Test)
    

I filen testbus.h ser du de testtilfælde, som blev angivet i dialogen; testprefikset er blevet tilføjet af skabelonen:

 1 class TestBus: public QObject
 2 {
 3     Q_OBJECT
 4 
 5 // each private slot is a test
 6 private slots:
 7     // -- tests to run on slots --
 8     void testNumberOfPassengers();
 9     void testNameOfDriver();
10     // -- tests to run on signals --
11     void testNumberOfPassengersChanged();
12     void testNameOfDriverChanged();
13 private:
14     Transportation::Bus m_bus;
15 };

De færdiggjorte funktioner i testbus.cpp vises herunder:

  • testNumberOfPassengers
    1 void TestBus::testNumberOfPassengers()
    2 {
    3     m_bus.setNumberOfPassengers(1);
    4     QVERIFY(m_bus.numberOfPassengers() == 1);
    5 }
    
  • testNameOfDriver
    1 void TestBus::testNameOfDriver()
    2 {
    3     m_bus.setNameOfDriver(QString("Billy"));
    4     QVERIFY(m_bus.nameOfDriver() == QString("Billy"));
    5 }
    
  • testNumberOfPassengersChanged
     1 void TestBus::testNumberOfPassengersChanged()
     2 {
     3     // create spy object
     4     QSignalSpy spy1(&m_bus,
     5                     &Transportation::Bus::numberOfPassengersChanged);
     6     // now change the number of passengers
     7     m_bus.setNumberOfPassengers(4);
     8     // verify the check was made
     9     QVERIFY(m_bus.numberOfPassengers() == 4);
    10     // verify the signal was sent
    11     QCOMPARE(spy1.count(), 1);
    12 }
    
  • testNameOfDriverChanged
     1 void TestBus::testNameOfDriverChanged()
     2 {
     3     // create spy object
     4     QSignalSpy spy1(&m_bus,
     5                     &Transportation::Bus::nameOfDriverChanged);
     6     // now change the name of driver
     7     m_bus.setNameOfDriver(QString("Jim"));
     8     // verify the check was made
     9     QVERIFY(m_bus.nameOfDriver() == QString("Jim"));
    10     // verify the signal was sent
    11     QCOMPARE(spy1.count(), 1);
    12     
    13 }
    

At this point, running build on the project also builds the tests. You can run Bus and TestBus separately. Right clicking on the TestBus target gives a pop-up menu where you can select Execute As ... then Compiled Binary. This opens the Run tool view with the following output:

********* Start testing of TestBus *********
Config: Using QtTest library 5.14.1, Qt 5.14.1 (x86_64-little_endian-lp64 shared (dynamic) release build; by GCC 7.4.0)
PASS   : TestBus::initTestCase()
PASS   : TestBus::testNumberOfPassengers()
PASS   : TestBus::testNameOfDriver()
PASS   : TestBus::testNumberOfPassengersChanged()
PASS   : TestBus::testNameOfDriverChanged()
PASS   : TestBus::cleanupTestCase()
Totals: 6 passed, 0 failed, 0 skipped, 0 blacklisted, 8ms
********* Finished testing of TestBus *********
*** Finished ***

Running the build, executable, and tests form the command line looks a little different. The tests are combined as one file test. Looking in build/Testing/Temporary you will find the LastTest.log that shows each test performed similar to above.

Kdevelop-bus-command-line.png

Hvis du bruger CTest eller et andet testsystem, så sørg for at føje de nye filer til et mål. KDevelop giver dig en værktøjsvisning til enhedstests, som integrerer med CTest.

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 Opret fra skabelon 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 Fil -> Ny fra skabelon kan du også downloade flere filskabeloner ved at klikke på knappen Hent flere skabeloner.... 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 Indstillinger -> Indstil KDevelop -> Skabeloner. Her kan du håndtere både filskabeloner (forklaret ovenfor) og projektskabeloner (som bruges til at oprette nye projekter).

Kdevelop-templatemanager.png

Du kan selvfølgelig altid oprette nye skabeloner, 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 Indstillinger -> Indstil KDevelop... -> Skabeloner, markerer den skabelon du vil kopiere og klikker på knappenExtract Template. Vælg en målmappe og klik på O.k., 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 Projektskabeloner eller Filskabeloner) og klikke på Indlæs skabelon. Åbn skabelonens beskrivelsesfil, som har filendelse .kdevtemplate eller .desktop. KDevelop vil komprimere filerne til et skabelonarkiv og importere skabelonen.

Note-box-icon.png
Note
Når du kopierer eksisterende skabeloner, så sørg for at omdøbe dem før du importerer dem igen. Ellers vil du enten overskrive den gamle skabelon eller vil ende med to skabeloner med samme navn. For at omdøbe en skabelon skal du omdøbe beskrivelsesfilen til noget, der ikke er brugt før (men bevar filendelsen) og ændre feltet Name i beskrivelsesfilen.


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.


This page was last edited on 7 April 2020, at 11:14. Content is available under Creative Commons License SA 4.0 unless otherwise noted.