Home

KDevelop User Manual

1. 353 Col 0 INS NORM KDevelop IDEAI mode Click here to return to the modes overview 191 KDevelop User Manual Sapaeva op te Home devel kuesstGkaevelop sto malnwindowscpp KODEVE Eile Edit View Project Build Debug Bookmarks Window Tools Settings Help BQQU8EaS 3 85 i C3 3 A C amp LE al Namespace y Classes Jel Functions EA kii Qood E mainwindow cpp 3 mainwindow h savesettings e return true S Automake Manat KMainwindow Mainwindow main return this void Mainwindow createstatusBar void new statusBar this void Mainwindow createFramework t Partcontroller createInstance this setMenuForsDIModesysButtons menuBar void Mainwindow createactions ViewHenuactionPrivateData ViewactionData iewactionData holds the parameter for the acti ViewActionData eview Outputview T t BH es ee sama Lx DL j amp 5 0 9 8 slo Configure KDevelop Line 353 Col 0 INS NORM KDevelop IDEAI mode closed tabs This example screenshot demonstrates one of the main virtues of IDEA mode There is a maximum workspace available Yet any tool view is readily available by clicking on the according tab You will most probably need some time to get accustomed to the icons in the tab bar If you got lost just position the mouse over a tab and wait a few s
2. mx mainwndow cpp x mainwndomh E l KTextEditor FA malneindow cpp _ jesmalmmdndowsty v prMamwindowutis Mee s TEM S t plugincontroller 0 o Btipofday E gt BAPI 1 Btools 5 pBPltem KHainwindow Mainwindow main i ESiuimode 3 v Core Bt NE ESvalgrind b Di Debugger 1 rene thid Esipics z t DocumentationPart u t sre a a S EditorProxy profiles E PGeneralinfowidget void MainwWindow createstatusBar B cs t ES HistoryEntry Ht exiclearcase void new statusBar this 8 amp LangPluginitem Bc 4 s x LanguageSelectwidge Ir gt Mainwindow J mainwindowshar a i e callCommand cons void Mainwindow createFramework mainwindow cpp G checkandFixToo DI PartController createInstance this main cp r childwindowClosef setMenuForsDIModesysButtons menuBar ilBlanguageselectwi neralinfowidget neralinfowidget editorproxy cpp jdocumentationpa debuaaer coo P clearWindowMenu Q createActions D createFramework pf createGUI K Pai NT fers actioncollecticn of the base Postprocessing Makefile templates 9 Creating date time stamp Finished Dont forget to run configure If you haven t done so in a while run configure help O e Success messages h1 2 9 910 0 9 3 6 fois T
3. Edit Remove Setting up documentation collections 91 KDevelop User Manual 4 2 1 1 Common Documentation Setup Structure All configurations pages on the Documentation tab use a common layout You will find the currently available documentation items of this type listed on the open page to the left and a set of buttons to the right Buttons to Maintain Documentation List Contents There are three buttons avail able to maintain the contents of the documentation setup pages Add Opens a Documentation Catalog Properties dialog as shown below where you can select the source location of the documentation item to be added and name it Edit Opens a Documentation Catalog Properties dialog as shown below where you can change the source location of the documentation item previously selected in the list and rename it Remove Removes the selected documentation entry from the list NOTE The entry will be removed from the list only Actual documentation sources remain untouched You will have to remove them explicitely by other means 3 Documentation Catalog Properties Location CO 7 Type Qt Documentation Collection t Add or change a documentation item The button to the right of the Location field opens a directory dialog whose entries usually will be filtered according to the file type of the selected configuration page The Title field may not be accessible dependi
4. A 3 3 Non default Installation Directory A 4 How to Obtain a KDevelop API Documentation In a Nutshell Tips and Tricks Development on UNIX C 1 Some Historical Remarks 2 2 0 2 0 002000 C 2 Contemporary Scripting Languages C2 Perle e eese le Son ce e as kes kaar Ee aeons Ge C22 Python m ee KS ee lr e ace e Rma COS PHE ae neon ean ord m mios female vea ed C3 Higher level Scripting ocs co samem 00000002022 e C 3 1 The CORBA Protocol een C3 2 The DCOP Interface lens C4 Build Systems s edea ca koei teta naa a Ae e C 4 1 The Make Process 2 a C 5 GUIDevelopment 2 C 6 Integrating Concepts and Tools the IDE C 6 1 Basic Features of KDevelop 3 3 01 Configuration Files Used by KDevelop D 1 KDevelop Default Configuration less D 1 1 Default KDevelop Configuration D 1 2 Application Specific Defaults D 2 User Oriented Configuration llle D 2 1 Application Specific Configuration D 2 2 Resource Configuration Files D 3 Project Dependent Configuration 0 D 3 1 Persistent CodeStoreFiles i sss 164 165 168 168 169 169 169 169 169 170 170 170 171 172 172 173 KDevelop User Manual Plugin Tools KDevelop User Interface Mode Examples Bl JIDEALMode ueste d ok
5. Current Errors Fixme Todo Level Line Column Problem Fi 3 han The problem reporter listing lines which require attention in the currently edited file Note the other tabs in the Problem reporter tool view window especially Fixme and Todo If you open them you will find all FIXME and TODO marked lines KDevelop has found so far in this session For example the TODO alerts will currently look thus Current Errors Fixme Todo File Line Column Problem src hello cpp 33 12 check the user interface src main cpp58 18 do something with the command line args here The problem reporter has collected the TODO alerts The Errors tab will however not list every coding error you make This is the job of other tools in e g the build process But you will find here alerts of some common programming mistakes which would likely go unnoticed otherwise and probably be catched with difficulties during complex debugging session 37 KDevelop User Manual You will find the KDevelop problem reporter facility a very valuable tool so check the Problems tool view regularly in the development process 2 5 How to Compile a Project Compiling a project in KDevelop requires several setup steps and then build ing the application All these are available through the Build menu FA Build Project G Build Active Target Compile File Run Configure Run automake amp friends
6. Configuring the Toolview Tab Layout The Toolview Tab Layout configuration section will be available in IDEA mode only Use these radio buttons to set up the look of the toolview tabs which surround the main working area in this mode Icons Each tab will show an icon only If the associated toolview is dis played the tab will open and a descriptive text for this toolview be shown You may want to use this mode if you work on a monitor with limited resolution The icons are not very descriptive however If you want to find out which toolview is assigned to a given tab point at it with the mouse and wait a second A short tooltip will then pop up with the toolview name 73 KDevelop User Manual Text This is the default toolview tab display mode Each tab displays the name of its associated toolwiew Text and Icons If the standard text toolview display looks too flat to you and you are working on a high resolution monitor you may want to select this radio button It will cause the name of the associated toolview be displayed on each tab plus an icon to the left of it mak ing the tabs easier to distinguish See the Folded Toolview Tabs il lustration below for an example Folded Toolview Tabs If you selected the IDEA mode toolview tabs to dis play texts with or without accompanying icons you need not worry about them being hidden behind some toolview window If one of the bottom toolview windows occupies more space than is av
7. Unfortunately you cannot currently select all options from this dialog The g3 option e g used by the debug build configuration would have to be altered manually if ever needed 2 5 2 3 How Make Should Build the Program You can as well configure the way KDevelop will call the make tool in the project build Select Project Project Options and then the Make Options icon from the left dialog window side The Make Options dialog page will then be displayed to the right 51 KDevelop User Manual Make Options Abort on first error C Only display commands without actually executing them Make priority o B vj Run more than one job at a time Name of make executable Environment Variables Name Value Add Copy WANT AUTOCONF 2 5 1 WANT AUTOMAKE 1 6 1 Remove Detine how KDevelop will call the make tool There is not much to do here for now The only setting of interest in most cases will be the Abort on first error switch You will find it deactivated in most projects This corresponds to the k option in the gmake call we found in the initial build of our example Hello project This makes sense in an IDE like KDevelop which will protocol any error mes sage during the build After the build process you may easily navigate to any error message in the Messages tool window Use View Next Error and View Previous Error or respectively the F4 and Shift F4 key
8. Closing Selected Sets of Tabs The step by step approach of closing individ ual editor window tabs can become awkward if there are a great number of tabs from which you want to still keep several open Instead of searching and closing one editor window tab after another KDevelop provides a means to se lect the candidates from a list and close those and only those with one single mouse click Let us illustrate this on a simple example In our Hello example project let us assume there were several files open for edit hello cpp hello h helloui rc hello desktop and main cpp Now you want to close all of them except he llo cpp and hello h The easiest way to do so is with the File List tool view Because this list of open files is alphabetically ordered you can more easily find the ones you want to be closed Proceed as follows 29 KDevelop User Manual 1 Open File List and with the Ctrl key held down click the files you want to be closed in the list 2 Then keeping the mouse pointer on a file name in the list click the right mouse button 3 From the File List popup menu select Close Selected B main cpp 43 File List f File Selector Save Selected How to close selected editor windows in one step That was all KDevelop will have closed all editor windows at your wish and you are ready to proceed with a clean tab bar again 2 4 3 2 How to Rearrange Edit Window Tabs Even if you have only the re
9. LANGUAGE SPECIFIC PARTS kdevadasupport provides entries in the Tools menu and according tool bar icons needed to develop Ada applications kdevbashsupport provides entries in the Build menu and according tool bar icons needed to develop Bash scripts kdevcppsupport contains files used by the Application Wizard to build C applications newclass contains header and source templates from which the Ap plication Wizard builds the according source files subclassing contains templates which the Application Wizard uses to set up initial class declarations definitions in the source files templates contains templates from which the Application Wizard sets up the default header and source template files to be used by the New File Wizard configuration dummy template to add macros kdevcppsupport rc provides the Complete Text and Make Member entries fo the Edit menu the Switch Header Implementation entry for the View menu and the New Class entry for the Project menu as well as a New Class icon for the Browser Toolbar kdevfortransupport provides entries in the Build menu needed to de velop Fortran applications kdevhaskellsupport provides entries in the Build menu and accord ing tool bar icons needed to develop Haskell applications kdevjavasupport contains the UI definition needed to develop Java applications kdevpascalsupport contai
10. Long which will cause all message contents be fully shown You may probably want to change this to the far more convenient Very Short setting Just select this from the drop down box CAUTION Be aware that only most basic information will be shown in the Messages window this way In case of errors during e g a build run you will most likely want to see more if not all of the message texts They are not lost however Just right click into the Messages window and select e g Full Compiler Output from the popup menu 22 2 Initializing Documentation Search Indexes There is another not so obvious item which preferably should be initialized before you start actual development work This is because you will want to perform documentation search regularly during development KDevelop re quires some search indexes be created before such search operations can be performed So let s initialize them before we attempt our first steps toward actual KDevelop work Open the Documentation tool view at the right side of the KDevelop main window There open the Search dialog page 12 KDevelop User Manual Search Words to search Method and Sort by Score Search results Where to generate the search indexes Now press the Update Config button to make sure the basic search tools are properly set up A dialog should pop up telling Configuration file updated Click OK to make it dis
11. 2 6 5 Some Steps to Restructure a Project 55 Howto Debug i55 cat Bo 4 eee eek Ce ered 55 A Note on Your Project Documentation 95 Last But Not Least Keyboard Shortcuts 56 Where to go from here llle 56 2 10 1 Frequently Encountered Problems 56 240 2 Working With Projects llle 56 2 10 2 1 Using Existing KDevelop Projects 56 2 10 2 2 Importing External Projects 57 KDevelop User Manual 3 Overview of KDevelop Features 3 1 3 2 3 3 Available User Interface Modes 00 3 11 How to Switch User Interface Modes 3 1 2 How to Maximize the Work Space Area Elements of the User Interface 000004 3 241 The Workarea e 3 2 2 TheKDevelopTitlebar llle 3 23 The KDevelop Statusbar less 3 24 The menubar cres 3 25 TheToolbars ssa stea daeraad rewanda yia 3 2 6 The Tree Tool Views naaa aaa 3 2 7 The Output Tool Views leen Project Management Systems o an aaa 3 3 1 Automake Projects oaaao 332 QMake Projects ee 3 33 CMake Projects llle 3 3 4 ANT Projects Java Projects 04 6445 3 3 5 Custom Projects gt lt s ee esa e o o ee a 3 3 6 How to Distribute Your Application 4 Configuring KDevelop 4 1 General Configuration ee 411 General Setup sp cos ass gos ie cop
12. Previous Error Shift F4 Previous Error View Full Screen Mode Shift F Full Screen Mode View Switch Header Implementation Ctrl F12 Switch Header Implemen tation View Tool Views Tool Views View Tool Docks Tool Docks View Switch to Command Line F7 Switch to Command Line View Schema Schema View Dynamic Word Wrap F10 Dynamic Word Wrap View Dynamic Word Wrap Indicators Dynamic Word Wrap Indicators View Show Hide Static Word Wrap Marker Show Hide Static Word Wrap Marker View Show Hide Icon Border F6 Show Hide Icon Border View Show Hide Line Numbers F11 Show Hide Line Numbers View Show Hide Scrollbar Marks Show Hide Scrollbar Marks View Show Hide Folding Marks F9 Show Hide Folding Marks View Code Folding Code Folding View Set Encoding Set Encoding 198 KDevelop User Manual G 1 4 The Project Menu Project New Project New Project Project Open Project Open Project Project Open Recent Project Open Recent Project Project Active Language Active Language Project Import Existing Project Import Existing Project Project New Class New Class Project Class Inheritance Diagram Class Inheritance Diagram Project Add Translation Add Translation Project Build Configuration Build Configuration Project Distribution amp Publishing Distribution amp Publishing Project Project Options Projec
13. What to do to debug the application Some basic tools to build program or user documentation Last but not least keyboard shortcuts Before we start one important concept should be made clear What to expect As said KDevelop is an Integrated Development Environment That means in essence that KDevelop is no development tool by itself but rather a graphical front end to easily access a wide range of development tools many of which actually would require complex keyboard commands run from a text console While KDevelop eases many of those programming tasks much of the com plexity from this bundle of tools still remains which means that in order to fully understand the KDevelop IDE you will still need to comprehend these tools actually running beneath the surface KDevelop User Manual Hence we cannot teach you how to build software but rather introduce you to some of the ways KDevelop was designed to ease such a software building process If you want to learn more about what an Integrated Development Environment is meant for you might want to have a look at the Development on UNIX historical overview and there especially at the Integrating Concepts and Tools chapter NOTE The following discussions apply to the default case where KDevelop starts up in the Simplified IDEAI Window Mode If you already did switch to another user interface mode some items may not be there as described or will behave slightly different If in doub
14. File Close All Others Closes all files except the current one Very useful if you opened a lot of files and you want to concentrate on the current one Without this you would have to close them all and re open the current one Note there is a similar command in the Window menu File Quit Ctrl O Close KDevelop G 1 2 The Edit Menu Edit Undo Ctrl Z Undo Edit Redo Ctrl Shift Z Redo Edit Cut Ctrl X Cut Edit Copy Ctrl C Copy Edit Paste Ctrl V Paste Edit Select All Ctrl A Select All Edit Deselect Ctrl Shift A Deselect Edit Block Selection Mode Ctrl Shift B Block Selection Mode Edit Overwrite Mode Insert Overwrite Mode Edit Find Ctrl F Find Edit Find Next F3 Find Next Edit Find Previous Shift F3 Find Previous Edit Replace Ctrl R Replace 197 KDevelop User Manual Edit Go to Line Ctrl G Go to Line Edit Find in Files Alt Ctrl F Find in Files Edit Find Select Replace Shift R Find Select Replace Edit Reformat Source Reformat Source Edit Expand Text Ctrl J Expand Text Edit Expand Abbreviation Ctrl L Expand Abbreviation Edit Complete Text Ctrl Space Complete Text Edit Make Member F2 Make Member G 1 3 The View Menu View Back Back View Forward Forward View Switch to Ctrl Switch to View Raise Editor Alt C Raise Editor View Next Error F4 Next Error View
15. If you have a C application with several modules and header files and you are only going to run it on your own machine i e it is an in house application you will only need a simple Makefile which is fairly easy to write by hand use info make to find out more The complications begin when e Your source code documentation graphics sounds translations data files etc are located in more than one directory e You have a hierarchy of directories and sub directories e You are using libraries that are not part of the traditional UNIX set such as the Qt Object Library or the KDE Desktop libraries e You are using a pre processor to generate some of your source code such as Qt s MOC pre compiler e You aim to distribute your application worldwide to people who may not have the same UNIX Linux system software and hardware as you e You require an automated Install and Uninstall facility e You aim to make your application part of the KDE Desktop set If you have some or all of the above situations you probably need a build sys tem In the example above we used gcc to compile and build the Hello World program but not all C compilers are called gcc So if you distribute your ap plication to someone who is using some other C compiler your Makefile must somehow use the name of that person s compiler otherwise your application will fail to compile and that is just simple example of what can go wrong A
16. If you select a subproject in the overall view window the corresponding details will be shown in the detail view window 10 2 3 The Detail View Window The detail view contains a tree list of all the files in the subproject currently selected in the overall view as well as the compilation build and installation rules for this subproject Thus the two views together can give you access to all the components of your application and all the information on how to compile build and install it 139 KDevelop User Manual 10 2 3 1 Targets The tree list in the detail view has two levels The top level consists of so called Automake Manager targets and the next level contains lists of files that go to make up each target This concept of an Automake Manager target differs somewhat from what a Makefile target usually is In short e The definition of how a set of files is to be compiled built or installed is known as a target in Automake Manager but as a variable in Automake itself e A target in make is often something quite different being the parameter of a make command e g make install make clean However some Makefile am variables do represent an underlying sub target in make 10 2 4 Navigating in the Automake Manager In both the overall and the detail view you can left click on the or next to a subproject or target name to expand or contract the tree view If you do that with a subproject in the overall view it shows
17. The Application Wizard will take over and construct a series of initial files in the Final location directory you provided in step 2c above Once this file creation phase is finished KDevelop will open an editor window for the application main window implementation file which is hello cpp in our example so you can readily proceed 2 3 2 Initial Project Files Even if our sample Hello project is fairly simple the Application Wizard did create a whole bunch of source and project management files You will most easily list them if you open the File Tree tool view on the bottom left This will open a file list similar to the one below 17 KDevelop User Manual 35 file home devel projects hello src hello cpp KDevelop File Edit View Project Build Debug Scripts Bookmarks Window Tools Settings Help 4 iud Gm Ao a 1Ct E30 6 r9 QIRI S no function z Toogle E3file home devel projects hello hello cpp a a ee 3 ex i admin B pen m2 IOET UCOOGOHOOOOOOOEOEOEEOOOGHOERGOEO ac 2006 se doc hello kdevelop jen amp doc Jindex docbook Epo S Makefile am 5 Makefile am Bpo src E J euew exetuoyny 5 szaddius epo 3 uonezuawnog f hello cpp hello desktop Jhello h T hello lsm T helloui rc s hi16 app hello png SI hi32 app hello png 7 main cpp include hello h Sl Ma
18. You may want to select this mode if you work ona single document most of the time as this provides more vertical space Never Never show any document selection tab You may prefer this mode if you seldom use the mouse to switch between documents It provides more vertical space for all document windows To select another the document window or to close any use the KDevelop Window menu Setting Up to Close a Document by a Click On Its Tab When you configured KDevelop to display the documents tab bar either always or when more than one document is displayed in the main work area you may add more functionality to the tabs beyond their document selection capabil ity Use the Use Close On Hover coniguration section for this No This is standard behaviour No extra functionality is added to the tabs They may be used only to select document windows on left mouse button clicks Yes When you selected this radio button KDevelop will allow to close a document window by a left mouse button click Use the mouse to point at the small icon on the on the left tab border It will change to a close symbol Now click with the left mouse button on this changed symbol and KDevelop will close the according document window Yes Delayed After selecting this radio button KDevelop will allow to close a document window as shown in the Yes case above The icon will not change instantly however but there will be a short delay before the close icon shows up
19. s QEditor or others A class generator for creating new classes and integrating them into the cur rent project File management for sources headers documentation etc to be included in the project Assistance in creating application user manuals written with KDE tools Automatic HTML based API documentation for a project s classes with cross references to the used libraries Internationalization support allowing translators to add their target language to a project easily including support for KBabel Support for managing a project via one of several versioning systems e g CVS by providing an easy to use frontend for the most needed functions An integrated debugger frontend An integrated shell console emulator Syntax highlighting in source texts An auto code completion facility for class variables class methods function arguments and more Templates for creating various projects KControl modules Kicker panel ap plets KIOSlaves Konqueror plugins and desktop styles Four navigation tree views for easily switching between source files header files classes and documentation obviating the need for an external file man ager Cross compiling support with the ability to specify different compilers com piler flags target architecture etc Support for Qt Embedded projects such as the Zaurus and iPAQ Inclusion of any other program you need for development by adding it to the Tools menu accordi
20. Advanced Debugging Other Debug menu entries allow more sophisti cated program analysis Use Shift F1 to get more information about their purpose Scripts You can call various scripts from this menu to more easily accomplish tedious actions on the text in the currently selected editor window The available actions depend on the selected script however Window This is fairly standard You may select any open document window as well as close one or more documents windows in here You may even select a set of document windows to be closed in one single turn Depending on the editor plugin you use may there be other menu items as well So will the default Kate editor plugin additionally allow to split the editor window horizontally as well as vertically Tools KDevelop is highly customizable You may select a favorite editor for your documents as well as provide external and plugged in tools to ex tend the basic IDE capabilities The Tools menu reflects most of this setup Advanced Editing The upper set of Tools menu entries will be provided by the editor plugin which is in use You may select your favorite edi tor via Settings Configure KDevelop Editor Once an editable doc ument file is selected the upper part of the Tools menu will provide ad vanced editing commands specific to the editor part in use Web Side Handling In case the active document window contains a HTML page e g displayed from a Documentation selection the Tool
21. Bader eem E2 Child Frame Windows Mode E3 TabbedPagesMode lees E4 Toplevel WindowsMode llle Command Reference G 1 TheMenubar len G 11 TheFileMenu leen G 1 2 The Edit Menu s G 1 3 The View Menu leen G 14 The Project Menu llle G 15 The Project Menu eee G 1 6 The Project Men uo ene ea ek e ER G 1 7 The Bookmarks Menu G 1 8 The Window Menu G 1 9 The Tools Menu 0 0 0 000000048 G 1 10 The Settings Menu G 1 11 The HelpMenu 0 02 20 000 Further Information H 1 Getting Information 2 2 2 2 0 00000 02000 H2 Reporting Bugs 6 es FAD LACCNSING a shod qe UR Bak dae UE n ew ae gk Changes L1 Changes to This Document Bibliography J 0 0 0 0 1 Index 10 185 191 191 192 193 194 196 196 196 197 198 199 199 200 200 200 201 202 202 203 203 203 203 204 204 205 205 207 KDevelop User Manual List of Figures 7 1 8 1 9 1 A Screenshot of the File Tree 0 04 125 A Screenshot of the Class View less 127 A Screenshot of the Documentation Tree 130 A screenshot of the automake manager 146 11 KDevelop User Manual List of Tables E 2 Project Management Plugins in KDevelop E 4 Language Support Plugins in KDevelop 12 Abstract KDevelop is an Integrated De
22. DCOP Desktop Communication Protocol library API reference of the KDE dcop library C 4 Build Systems Except in very simple cases a programming project will consist of a lot of build ing blocks of source code each put into a separate file for easier maintenance To make this running one has to effectively translate all this stuff into a few machine language units in a suiting format which allows the operating system to load and execute the program To accomplish this the basic tools needed are 170 KDevelop User Manual a text editor to write the source code files a translating program usually a compiler to turn the source code into object files a librarian which collects object files into libraries to reuse them easily with out the need to recompile a linker which binds several object files and libraries together into one exe cutable a make system which provides some means to manage all this stuff and not to forget a debugger to hopefully find all errors in the program and possibly some other diagnostic tools to get everything running smoothly When you have a large project consisting of possibly hundreds of source code files the process of compiling may become quite laborsome You do not want to recompile all files each time you have changed only some of them Instead you only want to compile those files which are affected by the changes In general it is not always easily obvious which of the files have to be
23. Declarations and Definitions 25 2 4 2 2 Project Internal Declarations and Definitions 26 24 3 Arranging Editor Windows 29 2 4 3 1 Cleaning up the Tabs Row 29 2 4 3 2 How to Rearrange Edit Window Tabs 30 2 4 3 3 Viewing Several Files Simultaneously 31 2 4 3 4 Edit C Source and Header Files Simultaneously 32 2 4 3 5 Grouping Source Files Into Development Sessions 34 2 4 4 Keeping an Eye on Common Problems 36 How to Compile a Project eee 38 251 The Basic Build Cycle 39 2 5 1 1 Initialize the Project for the Build 39 2 5 1 2 Initial Hello Configuration 41 25 13 Build the Project 000 43 25 14 Run the Application 44 252 Configuring the Project sss 45 2 5 21 Build Configurations 45 2 5 2 2 Project Configure Options 47 2 5 22 1 General Configuration Settings 49 2 5 2 2 2 Compiler Specific Settings 49 2 5 2 3 How Make Should Build the Program 51 2 5 2 4 How to Run the Executable 52 How to Extend a Project the Automake Manager 54 2 61 A Short Look at the Automake Machinery 55 2 6 2 How to Place Icons in a Separate Directory 55 2 6 3 Howto Add New Classes sss 55 264 Whatisina Subproject 000 55 2 6 4 1 Concentrate on Your Work the Active Target 55
24. Difference Viewer Difference Viewer FileCreate FileCreate FullScreen FullScreen Tip of the Day Tip of the Day User Interface Selection Provides a dialog for UI mode selection VCSManager Version Control System Manager Scope Global Abbreviation Expansion Provides support for customizable abbreviations short words which expand into commonly needed code structures Documentation The Documentation plugin offers browsing and searching in local and online documentation with support for multiple documentation systems FileList Provides a list of all currently open files Handy when the tab bar is not quite wide enough File Selector Powerful network transparent file browser utility Shell Filtering and Insertion Provides a way of manipulating editor text using commandline tools Appears in the Tools menu Grep Frontend Integrates find grep in KDevelop allows fast searching of multiple files using patterns or regular expressions Embedded Konsole This plugin gives KDevelop an embedded konsole for quick and easy command line access 186 KDevelop User Manual Open with Menu Addon This plugin provides additional open alterna tives for various context menus in KDevelop Part Explorer Tool A Graphical tool for performing KTrader like queries about registered services Regular Expression Tester Tool to design and test regular expressions against common regexp syntaxes Replace Part This plugin is an interactive p
25. File New Ctrl N Create a new file The user is prompted to select the di rectory default the current project s source directory and enter a file name The file type can be selected from a list Also the user can choose whether the file is to be added to the project Then the Automake Man ager asks which target to add the new file to File Open Ctrl O Open an existing file in a simple dialog box File Open Recent Ctr1 O Displays a submenu showing the files recently opened Selecting one of these will make KDevelop open that file File Quick Open Alt Ctrl O Presents a list of files in the current project s source directory The user can select from this list or type a filename That file is then opened 196 KDevelop User Manual File Save Ctrl S Saves the current file File Save As Ctrl S Uses the Save As dialog box to let you save a copy under a new name File Save All Saves all open files File Reload F5 Reloads current file to show changes made by different programs Note that such changes are normally detected automatically and the user is prompted whether the file is to be reloaded File Revert all Reverts all changes in opened files Prompts to save changes so the reversion can be canceled for each modified file File Print Ctrl P Print File Export Export File Close Ctrl F4 Closes current file File Close All Closes all open files
26. Final location line to give you better control on what is going on Application Wizard will copy an initial value to the Location field on start up This is taken from what you have chosen in the Default projects directory field during the general configuration steps In our case we have KDevelop set up to use home devel projects as initial path for new projects Alter the Location field contents so that the application development directory shown in the Final location line will be unique NOTE Take care that the path you enter in the Location field already exists Otherwise you will not be able to continue to the next step The Application Wizard will warn you about non existing paths by appending invalid to the Final location line 109 KDevelop User Manual 15 Create New Project Project Options m General Options Author user Email Version 0 1 License GPL 7 c Custom Options Name Value Back Next Cancel Set new project up for CVS Personal Information The fields following this are not so critical Just supply your name i e the name of the person who is responsible for the application in the Author field and a valid e mail address in the Email field so that users can give you feedback on the application NOTE 1 The Application Wizard fills these fields with some default values taken from the Email presets in the KDE C
27. Find in Files Displays the list of items found by the global search oper ation started from the Edit Find in Files menu Clicking on a line here will automatically open that file at the specified position in an editor window Replace Lists the results of the global search and replace operation is sued from the Edit Find Select Replace menu In this view you can decide on every found item whether you really want it be replaced or not NOTE This global search and replace facility is actually available only after a project has been loaded into KDevelop Otherwise the global replace tool in the Edit Find Select Replace menu will in fact be be disabled KDevelop User Manual Konsole Opens a KDE Konsole like terminal emulator window where you can use keyboard commands in a traditional UNIX command line interface Documentation and Source Manipulation Documentation KDevelop provides access to a whole bunch of documentation through this tool You may here access document files usually online from remote locations in a structured way And there are several ways available to directly access valuable information from KDE or Qt manuals See the Documentation and Configuring the Documentation chapters for more details Code Snippets This tool allows you to permanently store selected texts for later use in other editing cycles It is a very flexible tool as any text snipped stored here may contain a set of va
28. They are grouped left bottom and right according to the services pro vided Editor and browser views will be stacked in a big sized tabbed window inmidst the mainframe area e Child Frame Windows All tool views are initially docked to the mainframe Editor and browser views will live like toplevel windows within a view area of the mainframe e Tabbed Pages All tool views are initially docked to the mainframe Editor and browser views will be stacked in a tabbed window e Toplevel Windows All editor browser and tool views will be toplevel windows directly on the desktop The main widget only contains the menu toolbars and statusbar 59 KDevelop User Manual 3 1 1 How to Switch User Interface Modes To switch the user interface mode select Settings Configure KDevelop from the menus The Customize KDevelop dialog will pop up where you have to select User Interface in the left hand tree This will display the settings page shown below 38 Configure KDevelop wo r Major User Interface Mode General Simplified IDEAI window mode IDEAI window mode User Interface Childframe window mode D User Interface Tabbed pages mode File Templates Toplevel window mode Z m Use Tabs Editor Always fa O When more than one Abbreviations O Never Ci Toolview Tab Layout Tabbed Browsing Scripting Icons
29. Wizard had the new project ready several additional tool views were provided These make sense during project development only and in short provide the following function ality NOTE The tool views actually visible depend on the plugins currently loaded into KDe velop There are ways to control this See the Plugin Tools chapter for instructions 21 KDevelop User Manual 2 3 3 1 Navigation and Selection Tools left side Bookmarks You can mark any text file line in order to quickly return to this position from everywhere KDevelop will remember all those bookmarks even if you close the editor window afterwards The Bookmarks tool view lists all those bookmarks by file name and line number You need only click such an entry to open the editor window accordingly and position the cursor on that line Classes Lists classes methods etc known in the project Clicking the entry opens the appropriate header or source file in an editor window and posi tions the cursor at the respective declaration or definition File Groups Sorts the files in the projects into various utility groups i e Sources User Interface Icons Translations and Others Clicking an entry opens that file in an editor window Variables This is used by the debugger tool to display evaluate and watch variables during debug runs 2 3 3 2 Messages bottom Valgrind Valgrind is a run time program analyzer This tool view lists the results of s
30. X Open new tab after current tab VA Text L Show icons on document tabs Tools Menu Text and icons X Show close button in tab bar Vi ES Note Changes will take effect after KDevelop is restarted External Tools v Select a user interface mode Older KDevelop versions provide the top mode selection section only In the Major User Interface Mode section select the radio button of the user interface mode you want to work in Dependent on the user interface mode you selected other configuration sec tions will become available where you can taylor more details of the look and feel to your preferences See the Selecting the User Interface chapter for more detail NOTE Do not forget to restart KDevelop in order to let your selections take effect 3 1 2 How to Maximize the Work Space Area To maximize space there is a full screen window mode available which ex pands the mainframe area to the screen borders Additional space can be re 60 KDevelop User Manual claimed by hiding the menubar And you can of course hide any toolbar as usual in KDE applications Full Screen Mode To switch to or from full screen mode select View Full Screen Mode from the menus or press Ctrl Shift F There is also a Full Screen Mode icon in the Browse Toolbar available Hide Unhide the Menubar To hide the menubar select Settings Show Menubar from the menus or press Ctrl M You may also i
31. a notion about where the executable it shall run re sides This notion can be widely configured See more about this in the Project Management chapter The hello line will most likely be followed by a warning message Ignore this for now It does not keep our Hello form running 44 KDevelop User Manual Hello Hello World Our initial Hello application Close the Hello application window as usual If no errors occurred KDe velop will report this as Exited normally in the Application tool view window 2 5 2 Configuring the Project In KDevelop there are numerous ways how you can manage your project This behavior is configurable on a per project basis and mostly of interest to the advanced developer Yet there are a few project specific settings you should know of right from the beginning Of what use are build configurations Where to the define the behavior of the configure script Some considerations how make should run Where should the executable be and how should it be called 2 5 2 1 Build Configurations When we did a first run of the configure script in the Initial Hello Configu ration section above we noted that KDevelop had set up a dedicated debug subdirectory for this purpose In this section we will briefly consider some consequences of this feature First of all KDevelop does not necessarily use dedicated build directories apart from the source The preparations to automatically use
32. a short guide to solve common problems when working with KDevelop Development on UNIX A historical overview of UNIX B program develop ment the main tools necessary and why you need an IDE Configuration Files Used by KDevelop Lists the files KDevelop uses to save its internal information This is particularly useful in case something went wrong with your setup Plugin Tools Lists the pluggable tools you can use to taylor the capabilities of KDevelop to your needs KDevelop User Interface Mode Examples Shows user interface modes Further Information Getting Information reporting Bugs etc Changelog Shows the history of this documentation Bibliography Bibliography KDevelop User Manual Chapter 2 Getting Started with KDevelop a Guided Tour Bernd Pol Now that you have got your new KDevelop IDE how are you going to make good use of it As this is a complex application the learning curve may be somewhat steep especially if you are not already used to this type of an Integrated Development Environment We will try to soften this learning curve a bit by stepping through the makings of a simple KDE C application Thereby we will have a cursory look at A first look the user interface elements of the KDevelop IDE Doing some initial configuration How to create a new project Some tips about dealing with documents How to compile the application in this project How to add classes and other detail to your project
33. a tooltip though You can decide to always display the fully scoped class name by choosing Full Identifier scopes from the context menu Clicking on a class or method in the class view brings you to its definition You can also jump to the declaration of a method by choosing Go to declaration from the context menu In the context menu for classes are also the items Add method and Add attribute This opens dialogs where you can generate 126 KDevelop User Manual E Abin 5 ree amp Calibration Je Configuration l 8 GinaGroupBox 8 GinaLabel 8 GinaMainDisplay S GinaNameLabel m S MyCellTelemetry J MyChannelConfig S MyEngineParams g interface amp test S Structs S Global Functions go main int argc char argv Global Variables GinaControl o dcopclient o dcopclient p dcopclient S Namespaces Figure 8 1 A ScreensHot of the Class View KDevelop User Manual new method and variable declaration in the respective class together with an empty implementation 8 2 Class Tools The class tool dialog is activated by right clicking on a class in the class view and choosing Class tool 8 3 Class Hierarchy to be written 128 KDevelop User Manual Chapter 9 Documentation Documention unfortunately belongs to the most overlooked programming is sues Yet once properly set up and maintained internal and external documen tation pr
34. and C KDevelop contains an internal debugger that is directly inte grated with the editor Technically it is implemented as a frontend that uses the portable GNU debugger gdb through a pipe The debugger can be started in several ways With Debug Start the main program of your project is loaded into the debugger Using Debug Start other Examine core file you load a core file into memory which is generated by the operating system kernel when the pro gram has crashed The generation of core files may be switched off on your system see ulimit 1 This is useful for a post mortem analysis of a program With Debug Start other Attach to process you invoke the debugger on an already running program You will be shown a process list where you can select the process which the debugger should take over Note that debugging is only possible if your project has been compiled with debugging information enabled It can be activated in the Compiler options dialog When this option is switched on the compiler generates additional data which allows the debugger to associate file names and line numbers with addresses in the executable The debugger frontend offers several views into the process If you try to debug a project without debugging information you get the mes sage No source in the status bar If you try to set a breakpoint it is shown asPending add in the breakpoint window see below Variables This wi
35. at the main cpp file you will find an entry similar to the one below int main int arge char argyv KAboutData about hello I18N_NOOP Hello version description KAboutData License GPL C 2006 Joe User 0 O0 Joe user com about addAuthor Joe User 0 joe user com This will put the main developer s name Joe User in our case and email address into the About copyright page in the display and list this name and address on the Authors page there as well IMPORTANT Whenever you make substantial changes to an existing project be sure to enter your name and email address to the copyright notices on every file you changed and to the run time copyright display as well Don t be shy you help the open source society considerably if you do so 2 3 22 Initial Source Files The Application Wizard did put the source files into the src sub directory of the project s directory You will find the main cpp hello h and hello cpp files there as you may have possibly expected There are some additional files you usually will find in a typical KDE applica tion namely 19 KDevelop User Manual e hello desktop contains some meta data used by KDevelop to maintain and start the application e hil6 app hello png and hi32 app hello png contain some initial default icons KDevelop will use for application display Finally helloui rc contains a description of the application
36. build configuration only you should of course use this one 5 2 Configuring Projects to be written 119 KDevelop User Manual Chapter 6 Editing Tools 6 1 Code Snippets FEATURES PRELIMINARY OVERVIEW SnippetPart adds a tool view which by default docks to the right Adding editing and removing of snippets is available via a popup menu Double clicking a snippet form the list inserts it into to the active view at the current cursor position Tool tips show the content of a snippet Snippets are stored in the users home directory so every user can have his own snippets Snippets can contain variables in the style of VARNAME On using the snip pet the user is prompted to enter replacement value for the variables 6 2 Keyboard Mapping In the following we will list the default keybindings of the default editor You can configure them as you like how Left Moves one character left Right Moves one character right Ctrl Left Moves one word left Ctrl Right Moves one word right Up Moves up one line 120 KDevelop User Manual Down Moves down one line Page Up Moves up one page Page Down Moves down one page Ctrl Page Down Moves to the beginning of the file Ctrl Page Down Moves to the end of the file Home Moves to the beginning of the line End Moves to the end of the line For all the keys above the Shift key can be
37. build system will iron out these differences for you It will check that the libraries you need are present on each receiving ma chine e will automatically scan all your application directories for files to pre process compile or install and will install the components of your application in the correct receiving direc tories making sure that the directories are created in the receiving machine as required 132 KDevelop User Manual In brief a build system offers safe and secure methods for your application to be compiled and installed correctly on any receiving machine As we have shown before in the Project Management Systems survey KDevelop offers three automated build systems and the option of creating your own Makefile in short click on the project names to get more information e Automake projects which use the GNU standard development tools e QMake projects which use the trolltech QMake project manager e ANT projects which use the Apache ANT project manager for Java devel opment e Custom projects which require you to maintain your own Makefiles IMPORTANT One of these four alternatives must be chosen when you create a project and the choice is difficult to change later so you should give it some thought before you start 10 1 2 Tutorials on Autoconf Automake Libtool There are several tutorials available on the GNU Build System Autoconf Au tomake and Libtool of which the Automake Mana
38. checkbox if you want to continue to work with the last project you worked on This will cause KDevelop to automatically load this project on start up It will usually be shown in the state you left work so you can readily proceed 67 KDevelop User Manual Default projects directory By default KDevelop uses a common parent di rectory for all new projects Enter the absolute path of this common di rectory in the box or select it from your directory structure KDevelop will place the any new project here as a subdirectory NOTE You may of course change the directory path of a new project at the time you set it up in the Application Wizard Window font The Application Output View window is used to display er ror and state information from applications which are run from inside KDevelop These are informations the applications usually sends to the console when run stand alone So you do not need to leave the IDE when testing the application you currently work on To select a font suitable for the Messages Output View window click the Window Font button showing the currently selected font it says Luxi Sans in the above illustration The KDE standard Select Font dialog will pop up from which you may select the font to be used NOTE On first start up KDevelop initializes this font setting to the standard font for which your KDE user has been configured This setting is fixed so if you alter Preferences Appearan
39. dis abled it has no effect on your program until you enable it again e Pending add a breakpoint is marked like this if no debugging information is available From GDB Info page If a specified breakpoint location cannot be found it may be due to the fact that the location is in a shared library that is yet to be loaded In sucha case you may want GDB to create a special breakpoint known as a pending break point that attempts to resolve itself in the future when an appropriate shared library gets loaded Pending clear Pending modify Location in the format filename linenumber Condition Ignore Count If this is a number COUNT greater than zero the next C OUNT times the breakpoint is reached your program s execution does not stop other than to decrement the ignore count gdb takes no action 9 Hits counts how many times a breakopint has been hit COND U A Disassemble to be written 151 KDevelop User Manual 121 Setting Breakpoints to be written 12 2 Options Display Mangled Names In C function names in the executable are man gled ie the function names include information about the argument types This is necessary in order to support overloading of functions The mangling algorithm is not standardized and differs even between different versions of the GNU C compiler In the disassembling window normally unmangled names are displayed so function signat
40. documentation he she needs Using these tools one can access almost any local or remote documentation in a structured fash ion even if the original is laid out flat or structured in another way All that is needed is access to files and or parts of files which are displayable by the Konqueror Such structured access is made possible through the use of special table of content files which are denoted by toc filename extensions Any such KDe velop TOC file contains an XML structured description of the document to be accessed Standard Directory of KDevelop TOC Files When KDevelop was installed usu ally a series of predefined toc files has been put into the KDEDIR s hare apps kdevdocumentation tocs directory These are fairly simple structured text files You may look at them using a text editor or other text display facility BASIC STRUCTURE OF KDEVELOP TOC FILES lt DOCTYPE kdeveloptoc gt lt kdeveloptoc gt title header base address content structure index structure kdeveloptoc This XML structure will be parsed by the KDevelop Documentation plugin to set up the documentation tree contents and to guide the user in navigating the documentation It contains all information necessary to display titles and access the documentation file contents title title some title string lt title gt This is the title KDevelop will display at the basic levels in the documen tation tree NOTE This dis
41. editing managing files and compilation processes debugging documentation and the like But once the projects grow the programming pro cesses will most likely become quite cumbersome Much repetitive work has to be done when designing compiling and debug ging a program A lot of such work can be saved through the use of templates and scripts And another lot by keeping these tools easily available and able to communicate with each other under a common GUI For example would it not be convenient if a debugger were able to open the source file in question in an editor and place the cursor directly at the position of that bug just found To more easily accomplish such a scheme Integrated Development Environments IDEs were devised Such an IDE integrates all templates tools and scripts which are commonly needed in the development process into one single envi ronment 172 KDevelop User Manual For the KDE platform KDevelop is such an IDE It provides a wide range of tools which ease program development and maintenance even for different programming languages and across platforms C 6 1 Basic Features of KDevelop 3 3 91 Manages all development tools needed for C programming such as com piler linker debugger and build system Provides an Application Wizard which generates complete ready to go sam ple applications Allows the user to select an integrated editor based on the KDE programmer s editor KWrite Trolltec
42. from the Open Session drop down box KDevelop will close all currently open editor windows and open the remembered ones hello cpp hello h and main cppin our example instead You can define as many sessions as you wish in the context of your project If you want to change the session s contents just update the remembered file list with a Save Session click And if you want get rid of a session select it in the drop down box then click the Delete Session icon in the toolbar right There is even more You can force KDevelop to open a given session by default when it loads the project Just select the session in the drop down box on the Projects Project Options File List project options configuration page 35 KDevelop User Manual File List Open this session after project load sources iz Let KDevelop open a specific session when the project is loaded 24 4 Keeping an Eye on Common Problems When you open an editor window containing a source file KDevelop will parse its contents This allows the built in problem reporter to scan the source text for some common errors it knows of And it can alert the user of different places which have been marked for special treatment Let us illustrate this facility with our Hello example project e Open an editor window with the main cpp source file e Make sure it still contains the following line somewhere towards the end todo do something with the command line ar
43. groups of KDevelop configuration files in the KDEHOME share config directory distiguished by their surrounding character sequences 181 KDevelop User Manual doc pluginrc denotes files used by the documentation plugin kdev rc denotes configuration files used by KDevelop itself and its available plugins CONFIGURATION FILES USED BY KDEVELOP kdevabbrevrc holds the current state of the Abbreviations configuration provided by the Abbreviation Expansion plugin NOTE This only records whether the abbreviations will be used or not The actual definitions of new abbreviations will go into the SKDEHOM E share apps kdevabbrev templates templates file kdevassistantrc holds some configuration states specific of the stand alone KDevelop Assistant documentation browser NOTE Most common configuration settings are shared with the KDevelop IDE kdevel oprc file kdevassistantuimode4rc holds the current MDI configuration states dock positions etc of the stand alone KDevelop Assistant documentation browser kdevclassviewrc holds the View Mode setting of the Classes class browser tab provided by the Class View project plugin NOTE This is a global setting although the Class View plugin may be disabled on a per project basis Any change in this setting will be globally updated whenever the current project is closed and thus affect all subsequently loaded projects kdevc
44. inserted 2 Select the action to be inserted in the left hand Available actions list 3 Click the right upper arrow between both lists The action will be removed from the Available actions list and inserted into the Se lected actions list below the selected item 1 Select the item to be removed in the right hand Selected actions list 2 Click the left lower arrow between both lists The selected item will be removed from the Selected actions list and put back into the Available actions list 1 Select the action to be moved in the right hand Selected actions list 2 Click the up or down arrow to the right of this list The selected item will be moved up or down the Selected actions list 87 KDevelop User Manual Defining When the Contents Should Change Updating the contents in the File Selector window takes time and resources esp when changing to an other directory Therefore File Selector is set up by default in such a way that its contents change only on demand i e when you select another directory or when you explicitely want to refresh its contents NOTE Click the Reload button in the toolbar to update the contents of the File Selec tor This toolbar button is not available by default however You must insert it there first You can configure the File Selector to immediately reflect certain changes in your work The settings in the Auto Synchronization group of the configuration dialog are respons
45. into an upper and a lower part In the upper part you can decide on the programming language and application type the lower part holds some general information 5 1 1 1 Select Programming Language and Application Type The left hand side of the upper part in this dialog is where you do the selection work When it shows up you ll find there a list of folders each labeled with a programming language as there are e Ada eC e C 107 KDevelop User Manual Database SQL Projects e Fortran e Haskell e Java e PHP e Pascal e Perl e Python e Ruby Shell Scripts for the Bash Shell To be precise these folders do not contain real programming tools actually They do lead to pre defined templates you can use as a starting point for de velopment in that language To get an idea of what is provided just open the folders one after the other There will be a series of subfolders on some one or more simple entries only on others The subfolders you see organize the avail able templates according to some tasks the simple entries name the templates you may select We cannot go into detail here on which tasks each template provides but it s easy to find out Whenever you select a template entry some information is displayed in the fields to the right In the lower field you will find a short description on what the template is supposed to do In the field above that a picture will be shown if available about the outcome of th
46. not do so enter a suitable directory name or select one from the directory list provided by the folder la beled button to the right If all went well the Final location line at the bottom will show the directory path your new project will use In case there was an invalid suffix appended try another name for your project and or make sure the top project directory in the Location text box really exists and is writable f Once everything is right the Next button in the bottom row of the dialog will be enabled Click it to proceed 3 This will lead you to the Project Options dialog page Make sure the Au thor and Email text boxes are properly filled in Usually they will default to your general KDE user settings as given in the Password amp User Ac 16 KDevelop User Manual count dialog of the KDE Control Center If not change them to some set Project Options General Options tings you prefer for your application Author Joe User Email joe user com Provide your name and optionally email address NOTE You must provide an Author name at least This is mandatory for the applica tion files setup If all is right the Next button will be enabled Click it to further proceed 4 The following Version Control System Template for h Files and Tem plate for cpp Files dialog pages are not of interest for now Skip them by clicking the Next buttons and finally the Finish button That was all
47. object oriented language your emphasis when working on a project is not on the source files and their names but on the classes and their relationships In order to help you navigating in the space of defined classes and symbols KDevelop includes various class browsers that visualize the class structure in different ways 8 1 Class View This view is shown on the left side of the main window and contains a linear list of all classes variables and functions in your project It is designed as a tree view If you open a class node by clicking on it a list with all methods and attributes of the respective class is shown The class view works in two different modes By default all symbols are grouped into Classes Structs Functions Variables and Namespaces In the context menu of the view you can choose List by Namespaces In this mode the namespace hierarchy is shown and the symbols grouped into the respective namespace where they are defined This may be more useful in projects which make heavy use of nested namespaces It is less useful in projects without namespaces You can also change the way in which class names are displayed Normally the names of the classes are shown without the namespace in which they are de fined This means you cannot immediately distinguish classes with the same name in different namespaces If you rest for a while with the mouse over an item the full scoped name is shown as
48. of any block will be put at the same indentation level as the block head statement namespace foospace int Foo if isBar bar return 1 else return 0 82 KDevelop User Manual Attach This will keep the opening brace of a block in line with the block head statement Closing braces will be on the same indentation level as the block head statement The else of an if statement will be kept in line with the closing brace of the preceding block namespace foospace int Foo f ais Bar 4 bar return 1 else return 0 Linux Style This is a compromise of the above listed styles Functional block delimiting braces will be put on extra lines Braces opening a block in a conditional or loop statement will be kept in line namespace foospace int Foo ai ass Bam bar return 1 else return 0 Controlling Extra Spaces By default KDevelop does minimize the use of spaces in source texts if isBar fooArg barValue You may enhance readability if you force the source formatter to insert extra spaces in special positions Add spaces around parentheses In fact what is meant is to add spaces around the text put in parentheses This enhances the readabilitiy of function arguments and conditionals if isBar fooArg barValue Add spaces around operators This will put spaces around assignment and comparison operator
49. predefined style This style is highly configurable NOTE The reformat source feature is currently available for C C and Java only Especially you cannot use it for scripting languages like e g PHP This is because KDevelop uses the astyle application to implement this feature 77 KDevelop User Manual To set up a specific format style select Settings Configure KDevelop from the menubar The Customize KDevelop dialog will pop up where you have to select Source Formatter in the left hand tree This will display a series of three settings dialog tabs to the right namely a General Formatting Setup a Indentation Style Setup and a Other Formatting Setup TIP Any style changes apply to newly entered text only If you want to change the formatting style of an already existing source text you will have to explicitely use the Edit Reformat Source command NOTE The exact outcome of these style formatting definitions depends on the editor you use Currently most settings are tailored to the Kate editor part the Embedded Advanced Text Editor Some other editors e g the Qt editor may rely on their own configuration settings You will have to experiment in this case to find out the exact effects of the style settings provided here WARNING There may be incompatibilities between the configuration style settings provided here and the editor you use up to the extent that in ex
50. s user interface currently the menus the application will provide 2 3 2 3 Initial Application Documentation In the doc en subdirectory of the project you will find the index docbook file This is a default template from where you can start to write a suitable user documentation 2 3 24 Project and Auxiliary Files You will have noted that the files we introduced so far are listed in boldface in the File Tree tool view while most of the other files are not This depicts the substantially different tasks these files are used for The contents of those bold listed files directly influence the application Source files will produce the code to be run others will provide necessary data or documentation These files must be maintained and orderly processed in the build stages by the project hence they are called project files If you have a look at the lower Automake Manager window to the right of the workspace area you will find all project files listed as well The Automake Manager tool uses this knowledge to take care of the build control as we shortly will see The other non bold listed files are of more auxiliary nature They belong to several distinctive classes as follows e Project Build Control These files control the compile install documentation building etc processes If the project utilizes the GNU autotools machinery as our example does you will find a Makefile am file in each project di rectory These are kind of basi
51. time you call up the shell NOTE The kbuildsycoca command does not run from within the root You must call it from a non root user But is not a very good idea after all to do software development from within the root 163 KDevelop User Manual A 4 How to Obtain a KDevelop API Documenta tion API is the short form of Application Program Interface Actually such an API cotains a series of descriptions i e calling conventions by which an ap plication program can access the operating system and other services In our context however a broader definition was adopted The API of a KDE or Qt application is an abstract of the classes and methods interfaces a synopsis to be used like a dictionary to navigate the sources There is a version of the most current API available at the KDevelop Home website It will be automatically updated every 24 hours so you can keep up Alas this version is best used read only over the internet If you do not always have internet access you may as well build your own API documentation from the KDevelop sources To do so you must tell the automake system where to find the KDELIBS API in your system This is accomplished by the special option with kdelibsdoxy dir in the configure command when you prepare to compile the KDevelop sources kde3src kdevelop configure options as usual V with kdelibsdoxy dir S KDEDIR share doc HTML en kdelibs apidocs make will replace th
52. used to filter out irrelevant files Furthermore you can decide to restrict the file tree to show only files which belong to the currently loaded project This can be toggled by clicking with the right mouse button on the root item of the tree File Groups This shows the files belonging to the project grouped by their file name extension As in the file tree you can edit a file by clicking on it with the left mouse button The groups shown in this view can be configured under File views in the Project options dialog In order to customize the view to your needs it is helpful to understand how files are distributed on the groups For each file KDevelop goes through all groups from top to bottom In each group it looks whether the file name matches one of the patterns If there is a match the file is shown in this group and the iteration is aborted This makes it clear that more general patterns should be put below more specific ones For example an asterisk for the Other group should be the last pattern 124 KDevelop User Manual amp file home caleb gina bin ginaglobal h Agr 5 atest 2 fuelrate cpp i EJ fuelrate h EJ testlimit cpp E testlimit h E testpoint cpp E testpoint h L testprofile cpp E testprofile h Ed testsection cpp EJ testsection h Figure 7 1 A Scredshot of the File Tree KDevelop User Manual Chapter 8 The Class Browsers When working on a project in an
53. when a project is actually open In this case it provides the following actions Compile Link Execute Allows to compile and link the whole project or parts of it as well as run the application from within the IDE Prepare Build Operations This actually depends on the make system you use for this project In the case of automake projects it allows to run Makefile cvs and configure on their own There are also provisions to remove translated files from the project in various stages of intensity Install the Application Allows to install the application both in local di rectories as well as in system directories only accessible to the root user API Documentation Build or remove a doxygen based API documenta tion of the project as defined in the project options Debug Although this menu will be filled once a project is active it of course is useful only if the actual project has been previously compiled with debugging information this is basically set up in Project Project Op tions There are the following actions available in this case Usual Debugger Actions The first section in the Debug provides a graph ical interface to the GDB GNU symbolic debugger It allows to start and stop your application in the debugger and step through it in various ways KDevelop User Manual Breakpoints KDevelop provides several means to set breakpoints in your application sources One is through the use of the Toggle Breakpoint menu entry
54. 145 10 4 Custom Makefiles and Build Scripts 147 10 5 Compiler Options 2 2 llle 147 10 6 Make Options secre so aaam ee ee 147 Advanced Build Management 148 11 1 Multiple Build Configurations 0 4 148 11 2 Cross Compiling s os hene mk e Ae ee 148 113 Qt Embedded 0 0 DE A A 149 The Debugger Interface 150 12 1 Setting Breakpoints aoaaa eee 152 122 ODBHODS e wh eera me SO ie ieg a Bo eee EE deber S 152 Using CVS 153 18 1 CVS Basics Roe aa Pek ee ee RE Ee xg ee RC ds 153 13 2 CVS Commands in KDevelop l l 154 13 3 Behind the Scenes 0000000 lens 154 13 3 1 What CVS Records in the Working Directory 154 Credits 155 141 Contributions lee 155 Installing KDevelop 156 AJ How to Obtain KDevelop cess 156 A 1 1 Get Daily KDevelop Snapshots from svn 156 A 1 1 1 Initial svn Checkout 157 A 1 1 2 Keeping Your svn Copy up to Date 157 A 2 KDevelop Requirements 00200000 158 KDevelop User Manual A 3 KDevelop Compilation and Installation A3 1 Preliminary Steps aaa ee A 3 1 1 Setting the Environment for the bash Shell A 3 1 2 Setting the Environment for the tcsh Shell A3 2 Compile KDevelop leen A 3 2 1 Special svn Compilation Considerations A 3 2 2 Basic make Command Sequence A3 3 Some Notes on configure Options
55. 2 Java 63 dialog create new project 106 directory project 108 disassemble 151 distribution 63 documentation tool 189 dot 159 Doxygen 189 doxygen 159 E email 108 embedded Ot 149 environment F features 173 filter 189 finding 121 flex requirements 158 Fortran new project 108 frame stack 151 framebuffer 149 full screen mode 60 G g requirements 158 gcc requirements 158 requirements 158 208 graphical user interface 172 GUI 172 H Haskell new project 108 hide menubar 60 history 168 I IDE 172 IDEAI 59 incremental search 121 indentation 190 installation 156 integrated development environment 172 isearch 121 Java new project 108 projects 63 K kbuildsycoca 163 KDE requirements 158 KDEDIR 160 KDEDIRS 163 KDevelop API 164 compilation 159 features 173 installation 159 non default directory 163 maximize work space 60 obtain 156 requirements 158 survey 58 svn checkout 157 update 157 user interface modes 59 work space 60 keybindings 120 L language 107 lazy breakpoints 152 LD LIBRARY PATH 160 LIBRARY PATH 160 libtool 145 license 108 local CVS 112 KDevelop User Manual M main cpp 108 make 171 KDevelop installation 160 requirements 158 Makefile 147 171 custom projects 63 Makefile in 145 mangling name 152 menubar hide unhide 60 Nime application 108 name manglin
56. 3 3 KDevelop s Automake Manager 10 3 4 Building and Installing Libraries e rpath e PIC e static e plugins no undefined 145 KDevelop User Manual 4 mykapplet kdevelop Ex doc Spo quaunaag t BiuBf A Data in mykapplet jHeader in noinst e mykapplet_panelapple lue apog 25 mykapplet cpp cexeuiony S Figure 10 1 A screenshot of the automake manager 146 KDevelop User Manual 10 4 Custom Makefiles and Build Scripts to be written 10 5 Compiler Options to be written 10 6 Make Options to be written 147 KDevelop User Manual Chapter 11 Advanced Build Management 11 1 Multiple Build Configurations to be written 11 2 Cross Compiling When you have suitable cross compilers available you can cross compile your programs for processors and operating systems different from the system where KDevelop and the compiler is running The GNU compiler collection gcc can be configured and compiled as a cross compiler if you compile it yourself Con sult the GCC info pages for more information Some Linux distributions also provide binary packages An automake based package can easily be cross compiled by specifying the host option to the configure script and setting the CC and CXX environment variables to the respective cross compiler binaries Often you want to switch between a the cross compiled version of your app
57. At first start of KDevelop this will most likely be preset to your home directory Most people however prefer a dedicated projects directory for software development Change the text box to your preferred parent development directory You may select it from the directory tree if you press the Open file dialog button labeled with a folder icon to the right of it In our examples we will assume a somewhat artificial user called devel Thus always replace this devel by your user name Our devel user will utilize the home devel projects parent directory for actual development Again replace projects with your development directory name KDevelop will by default set up an own subdirectory below this parent for every new project you create So will e g all files of a project named Hello in our case be located in the home devel projects hello directory You may of course temporarily override these directory settings if you need to See the Application Wizard chapter for more info on this Compiler output Whenever KDevelop compiles some source it will display the messages of the make etc build tools in the Messages window in the lower part of the workspace area Usually these messages will be overwhelmingly wordy To keep a better overview of what happens KDevelop has some means of shortening those messages built in 11 KDevelop User Manual Depending on the KDevelop version you use the Compiler output selection may be preset to
58. Copy lt guimenuitem gt lt menuchoice gt This is cumbersome so you d rather just write Edit Copy and let the com puter do the tagging Here is how you can do it You write a little shell script called mef you put e g in your home s bin directory sed s S lt menuchoice gt lt guimenu gt 1 lt e guimenu gt lt guimenuitem gt 2 lt guimenuitem gt lt menuchoice gt Don t forget to make it executable That s all Now in your documentation docbook source you write Edit Copy You select this text you just wrote choose Tools Filter selection through command and call bin mef In stantly Edit Copy is replaced by menuchoice guimenu Edit guimenu guimenuitem Copy guimenuitem gt lt menuchoice gt The Doxygen Plugin This one helps you to use the Doxygen API documen tation tool http www doxygen org You can select Project Run Doxy gen to generate API documentation for your current project based on the configuration given by the file Doxyfile in your project directory Furthermore you can configure Doxygen in the Project Project options dialog This dialog is very similar to the doxywizard tool The ctags Plugin Although the class browser gives you extensive insight into the symbols and classes of your project you may also want to use the ctags tool In particular this one supports a lot more language than the class browser
59. DE SA maximumSize 32767 3276 ati sizelncrement 0 0 baseSize 0 0 E Input KDE PIM Custom Widgets Create a new project form or source file KDevDesigner in its own window e Run Ot Designer Ot Designer from your Qt installation will be started externally when ever you click on a ui file in KDevelop Terminal Emulation You choose here which terminal you want to be inte grated within KDevelop e Use KDE setting This uses KDE setting as set in KControl in KDE component Compo nent Chooser tab which sets the default terminal emulator used by all KDE applications that need a terminal e Other Choose some other terminal different from the default one 4 1 2 Selecting the User Interface As already said in the Available User Interface Modes chapter there are five different ways the KDevelop work area may be set up namely e Simplified IDEA window mode This is a simplified version of the IDEA user interface It is designed to be simple and clean It also does not uses docked toolviews 70 KDevelop User Manual IDEAI window mode This is a clone of the IDEA user interface similar to the Tabbed pages mode and is default Childframe window mode All tool views are initially docked to the mainframe Editor and browser views will live like toplevel windows within a view area of the mainframe A typical example of this user inte
60. Index Search Title Remove Doxygen Documentation Collection KDevelopTOC Documentation Collection Devhelp Documentation Collection Custom Documentation Collection Setting up Microsoft CHM standard documentation files By default this configuration page will be empty as shown above You may add new entries using the buttons to the right of the list field KDevelop will filter chm files in the directory dialog associated to the Add and Edit buttons For more information on the format of Microsoft chm files see e g PHP Documentation Extended CHM Format at http de2 php net docs echm php 4 2 14 Documentation Generated by Doxygen On this configuration page all API documentation generated by Doxygen is set up 95 KDevelop User Manual Documentation Documentation Collections Full Text Search Other Qt Documentation Collection kak Add CHM Documentation Collection Edit Doxygen Documentation Collection ig TOC Index Search Title Remove EI El El The KDE API Reference The KDE KDevelopTOC Documentation Collection Devhelp Documentation Collection Custom Documentation Collection Setting up Doxygen generated API documentation In short such an API documents the interface to certain library functions The API documentation on this page should be produced by the externally pro vided Doxygen tool Doxygen generated API documentation
61. Install Install as root user Clean Project Distclean Make Messages amp Merge Execute Program Shift F9 Build API Documentation Clean API Documentation Building a project requires several steps We are interested for now in the upper section only of this menu The entries there are sorted in order of their importance Thus the most often needed com mand is on top the Build Project entry which will cause all of the project be initialized compiled and linked as needed Other entries are there to compile selected project portions or a single file only to perform several initialization sequences or to install the completed application binaries For now we will concentrate on several facilities which KDevelop provides for project setup initializing building and running an application In general this includes 38 KDevelop User Manual Looking briefly at the basic build cycle Looking at some basic means to configure a project 2 5 1 The Basic Build Cycle Once you created a new project you usually want to check if everything went right so far This implies a first build and test run of the application which we will do now In order to initially compile a project there are several steps to perform which we will briefly look at How to initialize the project for a first build How to do the initial configuration How to build the project How to run the application from within KDevelop NOTE This dis
62. KDevelop User Manual Bernd Gehrmann Caleb Tennis Bernd Pol and Volker Paul O KDevelop User Manual Contents 1 What This Manual Contains 2 Getting Started with KDevelop a Guided Tour 21 A Very First Look at KDevelop less 2 2 2 3 24 211 OntheSurface 2 2 see ee cae rt mss 212 How to Get Some Help ss 2 1 3 What is in the menus aaa aa aaa 2 1 4 What are those tool views for A Bit of Configuration 2 6 a 221 Some General Settings less 2 22 Initializing Documentation Search Indexes Starting a New Project clle 2 3 1 How to Create a New Project l l 2 3 2 2 3 8 Initial Project Files llle 2 3 2 1 CopyrightIssues 00 23 22 InitialSource Files 0 0 0 2 3 2 3 Initial Application Documentation 2 3 2 4 Project and Auxiliary Files Additional Tool Views llle 2 3 3 1 Navigation and Selection Tools left side 2 3 3 2 Messages bottom 00 2 8 3 Source Management right side Some Tips About Dealing With Documents 2 4 1 2 4 2 Switching Between Header and Implementation Files How to Access Declarations and Definitions aman uF A Q 10 12 14 15 17 18 19 20 20 21 22 22 22 29 29 2 5 2 6 2 7 2 8 2 9 2 10 KDevelop User Manual 2 4 2 1 External
63. KMainWindc o kdeui KXMLGUICII 2 kdeui Member Lis amp kdeui Member Lis 5 kparts Member Li a kparts Member Li E khtml Member Lis 8 kdeui Class Meml kdeui Class Meml kdecore KSessior Search in Documentation KMainWindow Grep KMainWindow Switch header implementation includ Toggle Breakpoint Evaluate KMainWindow Watch KMainWindow nWindow O Hello 20 x ge x gx ox Es How to look up an externally documented identifier You might as well select Find Documentation KMainWindow In this case the Finder sub page of the Documentation tool view will show up usually providing a selection of pages containing the search term In our example this will probably be the KMainWindow and KMainWindowInterface classes Select 25 KDevelop User Manual the one you are interested in and the corresponding documentation will be displayed in an editor window NOTE If this did not work then there is probably no documents index yet Did you initialize the indexes as shown above If not please do so then come back here and try again 2 4 2 2 Project Internal Declarations and Definitions Such search facilities in external documentation have their limitations how ever Of course one cannot look up an identifier externally if it is only defined and used inside the current project But there is help KDevelop can use in dexes built by the CTags application to search the sources in your pro
64. L en kdelibs apidocs was found at the first KDevelop startup If KDevelop did not find a valid Doxygen generated KDE Libraries API at its first start up the Doxygen Documentation Collection list will be empty You may add your own API documentation entries e g from your current projects by using the buttons to the right If you want to have them included in the indexed and or full text search mark the Index or Search check boxes in the setup table NOTE KDevelop uses the title information from the index html Hence the Title field in the Documentation Catalog Properties dialog is inaccessible 97 KDevelop User Manual TIP The KDE system provides more API documentation than the KDE Libraries API only You will need additional interfaces information if you want to e g include the Kate part into you programs For this Kate part API for example you should compile and install the KDE Base Libraries API from the sources using the make apidox and make install commands on the kdebase sources and then add an entry to the Doxygen Documentation Collection list like this 43 Documentation Catalog Properties Location r local kde3 5 share apps kdevdocumentation tocs kdev3api toc A OK Cancel Adding a KDE Base API to the list Of course you should replace the home dev mykde system directory in the Location field example with the path to your KDE installation NOTE You must put the A
65. Makefile located there A dedicated sub environment was set up again as before in the Initialization step in which then the gmake tool was called Note the k option in the gmake call It forces the build process to continue up to its very end even if errors will occur This makes sense as KDevelop will list all error messages in the Messages window If there are any use the virtues of 43 KDevelop User Manual an IDE Just click on the error message in the Messages window and KDevelop will take you to exactly the position where the error occurred in the source file And what did happen inside the Debug subtree Not very much A few files showed up on the doc en and src branches most notably the ne11o file in ho me devel projects hello debug src This finally is the application binary we were looking for All what is left to do in our initial project check is to run this hello 2 5 14 Run the Application There are no extra steps involved to run this new Hello application Either select Build Execute Program or press Shift F9 or use the Execute program button on the Build Toolbar shown below 5153 G Running an application form the Build Toolbar That was all KDevelop will now start the new application in the dedicated console window which opens as Application tool view on the bottom There the command KDevelop issued to execute the program will be shown in the top line hello showing that the IDE has
66. N 0596001320 206 KDevelop User Manual Appendix K Index host 148 ext 113 local 112 pserver 113 A abbrev 188 Ada new project 107 ant projects 63 I KDevelop 164 API documentation 189 application distribution 63 name 108 type 107 Application Wizard 105 Artistic Style 190 astyle 190 author 108 autoconf 145 circumvent version need 159 requirements 158 automake 145 148 circumvent version need 159 projects 62 requirements 158 autoproject 145 B Bash new project 108 binary packages 63 breakpoints 151 lazy 152 build configurations 207 default build warning 119 multiple 148 build xml 147 C C new project 107 C new project 107 checkout 157 Child Frame Windows 59 class browser 126 cmake projects 62 commands 171 communication CORBA 170 DCOP 170 compiling cross 148 KDevelop 160 API 164 config h in 145 config status script 145 configure KDevelop API 164 configure script 145 CORBA 170 cross compiling 148 ctags 158 189 custom projects 63 CVS 153 ext 113 local 112 113 pserver 113 local 112 new project 111 remote 112 repository 114 KDevelop User Manual root 112 D Database new project 108 database CVS 111 DCOP 170 debugger 150 debugger toolbar 152 debugging regular expressions 190 default build configuration warning 119 dependencies 171 development 168 IDE 17
67. Navi gate down to the end of this branch and click Simple KDE Applica tion A preview and short description of the application this project template will produce pops up in the two windows to the right 15 KDevelop User Manual 33 Create New Project General aerias Evers yum AHeUO eact ES CMake based projects Hello World B Embedded SGTK EKDE Application framework Application framework KParts A Control Center module A Kate plugin Wa Vata nlinia with reni nana Generates a simple KDE application with one widget O 3 Simple KDE Application lt p C Show all project templates r Properties Location home devel projects la Final location fhome devel projects hello 3 Next x Cancel Selecting a Hello World project template d Our application will need a name Find the Properties area on the dialog bottom and enter a suitable name into the Application name input field We use Hello in our example but you can use whatever you like provided the name consists of letters number digits and underlines only You will find that the Application Wizard rejects any other character e Make sure the Location text box below the input field shows the name of your top project directory as set up in the A Bit of Configu ration chapter above If it does
68. PI of your current project into this Doxygen Documentation Col lection as well Former KDevelop versions did put it into the documentation tree on a per project basis This is not provided any more 42 15 Handling Structured Documentation KDevelopTOC Files The main bulk of the KDevelop documentation facility provides immediate access to structured documentation local as well as remote ones You can con figure this on the KDevelopTOC Documentation Collection page 98 KDevelop User Manual Documentation Documentation Collections Full Text Search Other Qt Documentation Collection Y Add CHM Documentation Collection Edit Doxygen Documentation Collection aug KDevelopTOC Documentation Collection pn Remove Index Search Title wxWidgets bugs User Agent Accessibility Guideline SuperWaba 3 4 1 API Scalable Vector Graphics SVG 1 STL sgi com SDL Ruby bugs Desde DDOLDDLDERL 4 n JOOoOoOooo cry Devhelp Documentation Collection Custom Documentation Collection Providing KDevelopTOC structured documentation access KDevelop comes with a bunch of predefined KDevelopTOC files which are automatically entered in the table at installation time To keep the display manageable only the most often used will initially be marked for display If you want to see another documentation mark the TOC check box in the setup table KDevelopTOC files cannot be inde
69. Window 0 Hello Do a global search This is especially useful if you want to look up arbitrary text in your project source There are two possibilities to start a global search from within KDevelop Start a global search from the Edit Find in Files menu Or Directly make use of the context menu with a right mouse click in the editor window 27 KDevelop User Manual We will illustrate the second possibility on our Hello example project The outcome of the menu call will essentially be the same Let us assume you are studying the hello cpp source file and have the cursor positioned on the first Hello occurrence there Now you wonder where this one word Hello was used in the project source and how many occurrences there are This is a typical case where to use KDevelop s global search facilities Now still keeping the cursor somewhere on this Hello in the source text click the right mouse button The now well known context menu will pop up where you should select the Grep Hello line Find Documentation Hello Search in Documentation Hello Grep Hello Switch header implementation Initiating a global search from within an editor window This will pop up the following Find in Files dialog exactly the same as if you did use the Edit Find in Files menu 33 Find in Files Pattern z Template oes verbatim zx Files h hoc hpp hh h 4 H
70. You activate this plugin under Tools CTags When you start it the first time you will be asked to generate a search database first When you accept this the ctags program will be started and will create a file named tags in your project directory This is a text file containing all symbols of your source files 189 KDevelop User Manual You can search in the symbol database in two ways when the Regular ex pression match box is checked the text you enter will be interpreted as a regular expression POSIX flavor and matched with the existing symbols For example the text Widget will search for all symbols ending with wid get If the box is not checked the search will be verbatim When searching you will get a list of the matched symbols accompanied with the line numbers where they are defined You jump to the respective point by clicking on the list For some languages ctags distinguishes different kinds of symbols For ex ample Python has classes and functions You can selectively search only for classes by checking the respecting kinds in the dialog The symbol database is normally not updated when your sources change Consequently after a while the line numbers will not be correct anymore and newly added classes and functions will be missing Therefore you should update the tags file in regular intervals by pressing the button Regenerate The astyle Plugin Astyle is a plugin for formatting of sourcecode acc
71. You can then jump to the found items by clicking on them Note that grep scans the files as they stored in the file system If you have modi fied versions of them in your editor you may get some mismatches in the line number or some found items will be invalid You can avoid this by saving all files beforehand 6 5 Code Completion to be written 6 6 Creating New Files and Classes to be written 6 6 1 Editing the Templates to be written 123 KDevelop User Manual Chapter 7 The File Browsers On the left side of the main window KDevelop can display various kinds of lists and trees for the selection of files File Tree This shows a tree view of the file hierarchy below the project direc tory If you click on a file it is loaded into the editor For files which do not contain text KDevelop starts an application that can handle the respective MIME type The file tree is regularly updated whenever something changes in the file system For example if you create new files or directories even outside KDevelop this is immediately reflected in the file list On Linux this feature makes use of the FAM library On other operating systems or over NFS the directories shown are polled in small intervals The file tree hides files which are usually not interesting like object files In the Project options under File views you can configure as a comma separated list of wildcards which patterns are
72. ace split feature built into KDevelop It allows to automatically keep a cpp source and its accompa nying h header file side by side open in the workspace area And optionally it allows to work on both files synchronously such that if you select a decla ration in the header file KDevelop will navigate to the respective definition in the source file and vice versa 32 KDevelop User Manual This feature is however deactivated by default If you want to use it in your project you need to activate it Select Project Project Options The Project Options dialog will pop up In the left hand icon bar there select C Support and subsequently the Navigation tab on the dialog page which will display on the right side C Support Code Completion Mavigation Class Wiz Header Source split X Enable split of Header Source files X Automatic Synchronize Orientation Vertical 3 Horizontal Have C source and header files be displayed side by side Now check the Enable split of Header Source files box This will enable Au tomatic Synchronize and Vertical by default Keep these settings for now and press OK To illustrate this feature now close in our example Hello project both the hel lo cpp and hello h editor windows if necessary Then select hello cpp again from the src subdirectory of the project The editor window will open as usual But if you now open the hello h belonging to it KDevelop will auto
73. aces If you select this radio button the editor will enter a number of spaces for each indentation level Change the number from the default 2 to the indentation width you prefer Indented Entities This defines which of the C C entities will be formatted with an extra indent beyond the current indentation level By default only namespaces and labels will be extra indented You may want to experiment with various settings to tailor those extra indents to your liking Continuation The settings grouped here apply to those cases where the source formatter automatically wraps around long source lines It takes two spe cial cases in account namely that in deeply nested indents there should remain enough room for the source and that conditionals should get extra indent levels on continuation to make them stand out properly NOTE This applies to static word wrap cases only where a fixed maximum line width is used in the source text If you set up your editor to dynamically wrap around long lines in display only which is possible in the Kate editor part the effects of these settings usually will not show Maximum in statement This setting limits the maximum possible inden tation for the continuation lines so that enough space will remain to keep the text readable No continuation line will ever be indented beyond the number of columns you selected in this field The default is set to 40 character columns half a standard 80 colum
74. ages Global plugins are plugins which require only shell to be loaded and do not operate on KDevProject interface and or do not use project wide information For example the uimode plugin allows a developer to select which user inter face they wish to use Project plugins require a project to be loaded and are usually loaded unloaded along with the project If a plugin operates on project related information then it is a project plugin The Automake Manager for example only needs to be active when an Automake based project is currently loaded 185 KDevelop User Manual As stated above core plugins cannot be disabled Global plugins can be en abled disabled in Settings Configure KDevelop under Plugins Project plugins can be enabled disabled in Project Project Options under Plug ins Active plugins can have many effects on KDevelop Depending on their function they may add extra menus extra menu items extra tool buttons etc Plugins which are disabled do not clutter your menus and are not loaded into memory The following plugin list is generated by a small script listplugins sh written by Volker Paul All plugins have a desktop file where information such as name and comments are written If in the following these comments are not very useful it is because the plugin authors made them this way The plugins are grouped by scope Core Global Project Scope Core Application Wizard Application Wizard
75. ailable to dis play all vertical tabs they will fold around as this illustration shows JaBeue ayewony o sjeddius apop amp uoneju Toolview tabs fold to not be hidden behind another view window 74 KDevelop User Manual NOTE example The active toolview window must be shown fixed non overlap mode shar ing the work area with the other windows to force such tab folding Press the small square in the window border to accomplish this as shown in the 4 13 File Templates File Templates Global Types Type Extension Type Name Icon Description for fpp pl pm pp Blank File Python Ruby Qt Designer C Source C Source CiC Header PHP Java Source Ada Spec Ada Body Fortran Source Preprocesse Fortran77 So Fortran90 So Fortran95 So Preprocesse Fortran77 So Fortran Source Perl Script Perl Module Pascal Source source_py template sou widget doc source cpp source c source h php Source java Source ads source adb source f source f source f source f source f source f source f source f template sou template sou source p A new blank A new empt A new empt A new empt A new empt Anew empt Anew empt Anew empt Anew empt Anew empt Anew empt Anew empt Anew empt Anew empt Anew empt Anew empt Anew empt Anew empt Anew Perl A new perl E C
76. ally necessary editor windows open you may still want to have their tabs arranged in some logical way KDevelop provides some common means to do so in short Basic Setup Where to Position New Tabs By default when you open a new editor window its tab will be inserted to the right of the editor window tab currently in use This can be changed so that the new tab will open to the far right on the tab bar You must change a basic user interface setting in KDevelop to enable this be havior 1 Select Settings Configure KDevelop 2 In theleft hand icon bar on the dialog popup click the User Interface icon The User Interface dialog page will be now shown 3 In the left bottom corner there find the section labeled Tabbed Browsing Remove the check mark on the Open new tab after current tab line 4 Close KDevelop and restart it again Now the new editor window tabs will open at the far right end of the current tabs row Unfortunately this setting cannot be changed on the fly during a development session You must make up your mind which behavior you prefer in the long run and then stick to it at least until the next start of KDevelop 30 KDevelop User Manual How to Rearrange the Tabs As development tasks do vary over time the need to rearrange the tabbed editor windows will more or less often arise This is easily accomplished in KDevelop Just click the tab you want to move with the middle mouse button and move the m
77. anager 10 2 1 The Automake Manager Window 137 DU pa vane Vi UH eon data in kde icon B hi32 app myapp png KDevelop User Manual r dor K src Data in rc myappui rc Header in noinst B myappiface h B myappview h myapp h o Data in kdelnk a myapp desktop myapp_ client Prograrnare dens Jmyapp client cpp myapp Program in bind A pref cpp A myappview cpp A myappiface skel _ myapp cpp main cpp 3d i Borne nmn 138 Automake Manager AutomakeNf npger runs in a prede he top part is called the Overall View and the bottom part is called the Detail View Between them is a narrow bar that can be dragged with the mouse to adjust the sizes of the views In IDEA mode you can also drag the sidle of the split window amp j ge the width On top o ES iew there is a toolbar the bir pns in which will become activate he way you can ans provided for wnt The other are us hich pop up on ill buttons in the anager window Hl side amp 8211 a d right arrow On The arrow additional s Automake titlebar left of button on the ill keep the window ther KDevelop e n selected Automake lqw will dlose whenever gets the input other hand y Li KDevelop User Manual 10 2 2 The Overall View Window The overall view window contains a tree list of all the directories in your project that contain prog
78. annot be easily overcome Now why does one one want to use different build configurations at all when they even appear to be not compatible to each other The answer is it simpli fies edit compile debug cycles The extra debug instructions inserted into the binaries as well as all those subtle structure changes to the program code made during optimizations will effect the run time behavior of the resulting applica tion So in many cases when the logical structure of some routine appears to be correct you may want to test whether it still behaves correctly under more practical conditions This is where the build configurations of KDevelop step in Because the built object and executable files in each dedicated build directory and the build com mands are kept separately from each other only source changes need to be handled when you switch between these build configurations Thus instead of cleaning up and recompile everything from scratch with al ternate options you need only switch from the debug to the optimize build configuration have the source changes compiled in and then retest the appli cation under these circumstances If anything inappropriate shows up simply switch back to debug and immediately continue your work there A final note many build configuration settings are configurable You can even define your own build configurations if your development process re quires some We will briefly look at these pos
79. appear This done KDevelop will be ready to parse the documentation it knows of and build some useful search indexes from it Press the Update Index button to the right Now the Generating Search Index dialog will pop up showing the progress of the index build operations 13 KDevelop User Manual Generating Search Index 7 G ff Scanning far files Files processed 7552 O Extracting search terms ENS Generating index Cancel KDevelop is generating documentation search indexes This will take some time depending on the size of documentation and the speed of your machine But finally the Cancel will make place to OK Just press this button to proceed NOTE e This usually should work out of the box In some cases the htdig application KDevelop uses to perform its full text searches might not be properly set up Refer to the Setting Up Text Search Indexes chapter for more help in this case e To be able to look up KDE and Qt specific API documentation it is mandatory that the KDELibs Apidocs were present when KDevelop was installed If you ex perience problems building the indexes or perform the identifier lookup examples later in this chapter make sure that this documentation exists and is accessible to KDevelop See Installing KDevelop fore more detail 23 Starting a New Project Almost any application will consist of dozens hundreds even thousands of files which need kept structured and ma
80. appui rc AM CXXFLAGS DMY CFH PREPROCESSOR OPTION As you can see many of the items on the right hand side are symbols of the form xxx These are environment variables which are defined in the actual KDE environment and are substituted with real values when configure gen erates the final Makefile files in the receiving machine Also sometime after you have started with KDevelop it is a good idea to run the command configure help which will show you the range of things you can change at build and installation time such as for a test environment In particular the command configure prefix where you wish will re direct the entire installation to a directory structure of your choice by changing the internal variable prefix to value where you wish 10 2 Automake Manager Operation In this chapter you will find a basic description of the Automake Manager ele ments and how to use them This covers e The Automake Manager Window describes the basic structure of the Au tomake Manager main window e The Overall View Window describes the elements of the upper subwindow 136 KDevelop User Manual e The Detail View Window describes the elements of the lower subwindow e Navigating in the Automake Manager lists some basic operations you can perform in the Automake Manager e Popup Menus in the Automake Manager describes the windows which will pop up when you select an action in the Automake M
81. apter 10 Building and Project Management Bernd Pol and Ian Wadham This chapter deals only with compiled projects such as C Java or Fortran projects Projects for scripting languages like Python and PHP work very differently You will find here information on e Summary of Automake Manager containing an initial overall view of Au tomake Manager e Automake Manager Operation describing the basics of how to work with Automake Manager 10 1 Summary of Automake Manager In the Build systems chapter we have given a rough overview of the build systems commonly in use on UNIX systems In the following sections we will look at this in more detail There is some confusion about how to name such things GNU calls them build systems when it describes Automake Autoconf and Libtool QMake calls itself a tool to write Makefiles for different compilers and platforms In KDE often the term project management systems is used We will use this term in a broader sense to describe the built in environments in KDevelop which are used to organize and build your projects In the context of this sec tion however we will mostly talk about automated build systems 131 KDevelop User Manual 10 1 1 The Need for an Automated Build System If you have a simple Hello World program written in C you can compile and link it using gcc o hello hello cand execute it using the command hello so you do not even need a Makefile
82. ar Most of them get fully pop ulated once a project is open for actual work while others require at least one document be open in an editor window In short they will allow the following action types NOTE This is only a preliminary overview For a detailed menu description see the Com mand Reference File Usual Actions This is pretty standard It allows to create open save print and close document files as well as quitting the KDevelop applica tion as usual Revert All This allows to revert all recent yet unsaved changes by reload ing the file from the disk This works on any file you edit not only on those which are part of a project Edit This menu is useful only if a document is opened Usual Actions It provides the usual undo redo and cut copy paste ac tions Furthermore it allows to select text blocks in various ways Search and Replace There are two very powerful search facility avail able Edit Find in Files and Edit Find Select Replace These al low in addition to the usual search and replace actions limited to the the current document to conduct global search or search and replace actions in one single turn Advanced Text Edit There are provisions to reformat the current docu ment and to automatically complete partially typed texts in various ways View Like the Edit menu this menu is useful only if there is an open project I this case there will be the following actions available a
83. arious menu entries ceated by Tools Menu and External Tools Menu settings provided by the Tools Menu Addition plu gin kdevvalgrind provides the Valgrind Memory Leak Check and Profile with KCachegrind entries in the Debug menu used by the Valgrind Fron tend plugin PROJECT GENERATION PARTS kdevadaproject provides entries for the Build menu and according tool bar icons to build an Ada application kdevantproject provides entries for the Build menu when the Ant project generator is used kdevautoproject provides entries for the Build menu and according tool bar icons when working with the GNU Tools based automake project generator Additionally provides the Add Translation and Build Configu ration entries to the Project menu kdevcustomproject provides entries for the Build menu and according tool bar icons when the project is based on custom Makefils kdevgenericproject contains menu definitions for an experimental generic project generator Currently version 3 1 0 unused 177 KDevelop User Manual kdevhaskellproject provides entries for the Build menu and accord ing tool bar icons to build a Haskell application kdevpascalproject provides entries for the Build menu and according tool bar icons to build a Pascal application kdevtrollproject provides entries for the Build menu and according tool bar icons to build an application using the Qt QMake project man ager
84. at the Build menu there are three such compile options from which to select FA Build Project G Build Active Target F7 Compile File KDevelop commands to build binaries Going from bottom to top there are e Compile File This will compile the source file in the currently open editor window Mostly used for quick error checks e Build Active Target This is mainly used in conjunction with the Automake Manager which we will briefly look at below e Build Project Now this is what we currently are interested in It will iterate over the whole project compiling and linking all files as necessary It might be interesting to watch what happens to the Debug directory created in the former configure run So best keep it open with all subdirectories unfolded just as shown above Then select Build Build Project or press the F8 key to initiate the build sequence As before the Messages tool view window will open at the bottom and list the outcome of this build run And additionally some files will appear on the Debug subtree There are not many source files in our Hello example project so the Messages window will contain only a few lines On top of them again find the command line KDevelop issued to the underlying shell cd home devel projects hello debug amp amp WANT AUTOCONF 2 5 1 WANT AUTOMAKE 1 6 1 gmake k Not very surprisingly KDevelop switched to the Debug subtree root in order to run the
85. bbreviations into frequently used code snippets It is activated by pressing Ctrl Space For example when you enter ife into a C in the editor and press Ctrl Space you obtain an if else code template and save some key strokes The set of supported abbreviations depends on the programming language of the edited file For example for PHP you will obviously be interested in other code templates than for Java 188 KDevelop User Manual The set of code templates is configurable If the plugin is enabled you can see which ones are available in the Settings Configure KDevelop dialog under Abbreviations The filter Plugin This offers two features If you select Tools Execute com mand you can enter a shell command The output of this command is in serted into the editor buffer when you hit the Start button A related feature is available under Tools Filter selection through com mand In order to use this you must select a text area in the editor If you now enter a shell command and hit the Start button the command is started and the selection used as the standard input for it The standard output of the command is then inserted into the editor replacing the selection For example if you write documentation you frequently have to refer to menu items To do this correctly for e g the Copy command in the Edit menu you have to write lt menuchoice gt lt guimenu gt Edit lt guimenu gt lt guimenuitem gt
86. c make core files which contain build control commands and will be processed in conjunction with various configure files during the build stages Such a build produces a final Makefile in every di rectory And from these in turn the make utility will finally build the binaries of the application Those Makefile am files need to be maintained throughout the development process Luckily KDevelop relieves you of most of this burden by the Au tomake Manager tool which basically is a graphical front end to maintain Makefile am contents Other project build control files currently listed are configure in inand s ubdirs in the project root directory They will be processed by some of the files in the admin KDE specific administration directory to produce more c onfigure and Makefile type files and finally the application s binaries 20 e KDevelop Con data on its own KDevelop User Manual trol Files KDevelop needs some control and administration These are located in the project root directory in our exam ple hello kdevelop hello kdevelop pcs and hello kdevses Of particular importance in each project is the xxx kdevelop where xxx de notes the project name file It is the main KDevelop 3 Project File and needed if you later want load this project into the IDE WARNING Never do manu files The IDE will most likely not function properly on your project afterwards ally modify rename or even delete any of the
87. ces amp Themes Fonts in the Control Center this will not effect this KDevelop font selection You will have to explicitely reselect the Messages Output View window font Compiler Output KDevelop preprocesses the messages the Messages Output View window receives during the build processes in order to filter su perfluous information You can control the level of detail KDevelop will display using the dropdown box in this field Very Short Displays only warnings errors and the filenames which are compiled Short Suppresses all compiler flags and formats the output to be more readable Full Displays all output messages unmodified TIP There is an alternative way to switch the compiler output detail Just right click in the Messages Output View window and select the according detail level from the popup menu Line wrapping By default KDevelop will wrap long lines around in the Mes sages Output View window so that valuable information will not be eas ily overlooked In some cases this will clutter long message lists Remove the checkbox mark if you do not want the lines wrap around 68 KDevelop User Manual TIP There is an alternative way to switch the line wrapping Just right mouse button click in the Messages Output View window and mark unmark the Line Wrapping entry in the menu which will pop up Directory navigation messages The make tool usually will display messages like Entering d
88. ch stands for checkout gt cd kde3src kde3src cd kdevelop kde3src svn up 157 KDevelop User Manual NOTE Keep an eye on the messages svn produces during the update sequence The exact steps in the compilation sequence depend on this Now you can compile a new KDevelop version as shown in the Special svn compilation considerations chapter A 2 KDevelop Requirements In order to successfully compile and use KDevelop you need the following programs and libraries They are available on most platforms as distribution packages and thereby can be installed easily REQUIRED gcc g amp 8805 2 95 3 or compatible Available from gcc gnu org GNU make or compatible Available from www gnu org software make Perl 5 004 or higher Available from www perl com autoconf amp 8805 2 52 or higher Available from www gnu org software autoconf automake amp 8805 1 6 or higher Available from www gnu org software automake flex 2 5 4 or higher Available from www gnu org software flex Qt amp 8805 3 3 0 or higher Available from wwvw trolltech com products qt KDE amp 8805 3 4 0 or higher Available from www kde org OPTIONAL The ctags source navigation tool from http ctags sourceforge net which enables you fast access to declarations and definitions by a few simple clicks on a name in the editor 158 KDevelop User Manual dot a graphics language compiler from http w
89. chapter If you want to know more about the meaning of the various flags which can be set look up info make from the console or info make from within Konqueror and there the Implicit Rules Implicit Variables section There are several tabbed dialog setup windows from which the first one Gen eral refers to commonly used settings while the others are rather compiler specific In all cases however will the actual contents of those dialogs be gov erned by the given build configuration You select the build configuration whose configuration settings have to be de fined from the Configuration combo box on top of the Configure Options dia log 48 KDevelop User Manual Configuration debug Select the build configuration whose settings to define Now select another build configuration from this combo box and note how the contents of e g the Configure arguments and Build directory text boxes change according to the settings we mentioned in the build configurations list above 2 5 2 2 1 General Configuration Settings On the General dialog page these configuration options can be defined Configure arguments These are the options KDevelop assigns to the conf igure script call in the build process See the example in the Initial Hello Configuration section above Build directory This is the subdirectory in the current project root where KDevelop will put all files created in the build process Ideally this should corre
90. ckbox if you want to view the stored text in a tooltip window whenever you keep the mouse cursor over the title of that snippet Working with Snippet Variables The CodeSnippets tool allows for a variable text in predefined places any time you insert a snippet into a file To accomplish this Code Snippets provides its own variables mechanism You can set up it s behaviour in the Variables group 84 KDevelop User Manual Delimiter The Code Snippets tool distinguishes variables in the text by surrounding the variable name with special delimiter symbols To use your own delimiter symbol change the predefined character in the Delimiter field Input method for variables e Single dialog for each variable within a snippet will in turn pop up a separate dialog for each variable which the tool finds when inserting the selected code snippet e One dialog for all variables within a snippet will pop up a com mon dialog where the user has to fill in the values of all variables before the snippet will be inserted 4 1 11 File List to be written 4 1 12 Configuring the File Selector KDevelop provides a File Selector plugin which when loaded at start up al lows to navigate to any file or directory in the system 85 KDevelop User Manual n x tetrao E mometannmarsiocreater F i3 admin amp Makefile in autom4te cache NEWS debug d README doc y sigcreate kdevelop 4 sigcreate kdevelop pc 7 sigcreat
91. combobox You can configure the num ber of history entries as follows Remember locations Enter here the maximum number of directory se lections the upper combobox shall remember Remember filters Enter here the maximum number of filter definitions the lower combobox shall remember Controlling What Should be Remembered Between Sessions By default the File Selector is set up so that it shows the display of the most re cent session again at the next KDevelop start up You may change this behaviour in the Session configuration group 88 KDevelop User Manual NOTE If KDevelop was automatically restarted by the KDE session manager the changes in these settings will have no effect In this case loca tion and filter settings of the most recent KDE session will always be restored Restore location Remove the checkbox mark here if you don t want the displayed location be remembered between sessions NOTE If you selected one of the automatic update settings the displayed loca tion might automatically change regardless what has been remembered from the recent session Restore filters Remove the checkbox mark here if you don t want the filters applied to the display be remembered between sessions 4 1 13 C Class Generator to be written 4 1 14 Formatting to be written 4 1 15 C Parsing to be written 4 2 Configuring the Documentation KDevelop contains a very p
92. compiling and linking the application is done through the Build menu Call it up and select Run automake and friends G Build Project G Build Active Target Cornpile File Run Configure Run automake amp friends Initiating a basic initialization run KDevelop will now open the Messages tool view window at the bottom and list a series of messages produced by several make tools If everything went right the final line will read Success If you scroll back to the top you will find the command line KDevelop issued to call up the tools beneath the surface cd home devel projects hello amp amp WANT AUTOCONF 2 5 1 WANT AUTOMAKE 1 6 1 gmake f Makefile news This basically tells that KDevelop first switched to the root directory of our example project Then it set up a dedicated environment advising the make 40 KDevelop User Manual system of the autoconf and automake tool revisions used for this initialization And finally it instructed the make tool GNU gmake in this case to process the Makefile cvs make file This make file was automatically set up when you created the Hello project It contains all the commands necessary to properly initialize the project so the resulting application will run under KDE Especially this will create the conf igure skript file necessary to perform the next setup step 2 5 12 Initial Hello Configuration Configuring means to tailor the build proc
93. consists of a series of html files start ing with index html Additionally there may exist tag files which contain in formation to link to already existing API documentations Thus KDevelop will look for index html and tag files when seaching for Doxygen generated API documentation There are some structural constraints assumed when searching for Doxygen generated API documentation The directory in which the index html file re sides should contain subdirectories with separate documentation collections Each of these subdirectories is assumed to contain a tag file and a htm1 sub directory You may have a look at KDEDIR share doc HTML en kdelibs apidocs for an example of such a Doxygen API documentation layout 96 KDevelop User Manual NOTE The older KDE KDoc generated API format is not directly supported any more If you still want to use such documentation you may add it on the Custom Documen tation Collection page KDevelop will have filled in a link to the current KDE Libraries API provided it found one There are several ways for KDevelop to find out Either you provided the configure command with the with kdelibsdox y dir option when you compiled KDevelop see the How to Obtain a KDe velop API Documentation chapter e Or the configure command did automatically find a Doxygen generated KDE Libraries API in one of several standard locations it knows of e Or as a last resort the SKDEDIR share doc HTM
94. ction TOC Index Search Title El Custom Documentation Test Providing custom documentation Usually this collection will be empty at first KDevelop startup We have filled in a deliberate item to show the entry structure Handling is straightforward here Use the buttons to the right of the list field to add edit or remove the document items KDevelop will not filter anything in the directory dialog associated to the Add and Edit buttons You will have to explicitely select the items for display in the KDevelop docu mentation facility Mark the TOC check box of the entry in the setup table NOTE Custom documention cannot be indexed or searched Thus the Index and Search check boxes have no effect here as shown above 4 2 2 Setting Up Text Search Indexes to be written 103 KDevelop User Manual Documentation Tree General Full Text Search Bookmarks KDevelopTOC Documentation DevHelp Documentation Index Qt documentation Index kdelibs documentation generated by Doxygen Index other books OCOkkOo Index bookmarks htdig executable usr bin htdig htmerge executable rusr bin htmerge cee htsearch executable Isrvjwww cgi bin htsearch Database directory homej devel kde share apps kdevdoctreeview helpindex E Update Config Update Index Setting up text search indexes 4 2 3 Other Documentation Configuration Settings to be written 43 Advanced Confi
95. ction URL The tocsectn entry must have an url attribute whatsoever This final nested tocsectn does not come in pairs but will immediately be closed by a before the bracket NOTE Any address combined of base and section URL must point to some dis playable text file Usually this will be an HTML structured file It is possible to link to anchor marks within such an HTML file using the standard notation of the format base url section url anchor mark index index structure entry name index entry title url index section URL lt index gt Index is a plain list of index entries pairs of title and URL Index is not mandatory 42 17 DevHelp Documentation DevHelp documentation is another means of structured documentation access It uses structured table of content files denoted by a devhelp extension similar to KDevelop TOC files to access documentation for the GNOME 2 desktop 101 KDevelop User Manual You can control which DevHelp files should be accessible on the DevHelp Doc umentation Collection configuration page Documentation Documentation Collections Full Text Search Other Qt Documentation Collection ms Add CHM Documentation Collection E Edit Doxygen Documentation Collection uu teng KDevelopTOC Documentation Collection _ Remove Devhelp Documentation Collection Search Title gtkmm library Reference Manual The gdk pixbuf Lib
96. cussion implies that your project is based on the GNU autotools which en abled the Automake Manager tool in KDevelop as our example Hello project does If you created another type project e g for the Qt based QMake project man ager there will be other facilities available in the menus or perhaps even none of them You will have to consult the respective vendor documentation on project management and application building in these cases 2 5 1 1 Initialize the Project for the Build When the Application Wizard created our Hello example project it left it in a sort of raw virgin state The GNU autotools chain dictates several initializa tion steps to be performed before the application could be actually compiled and linked If you try to build a project in such a raw state e g by selecting the Build Build Project menu or pressing the F8 function key you will get the following warning 39 KDevelop User Manual El Question KDevelop There is no Makefile in this directory 7 and no configure script for this project Run automake amp friends and configure first Do Not Run Trying to build a raw automake based project You may press the Run Them button in which case KDevelop will try to auto matically run all required setup steps prior to compiling and linking the appli cation But we will look at those initial steps in sequence so cancel the dialog by pressing Do Not run As mentioned already
97. d project files in some sort of a database If you use CVS you can amongst others upload commit those files or load them back into your project directory checkout or update The special thing about this is that the files in the versioning database are stored in a structured way which allows you to always revert to an earlier development state if you need so And CVS allows multiple designers to fairly easily collaborate on a big project such as KDevelop without disturbing each others work CVS Root CVS needs to manage the versioning database it keeps from your project files To accomplish this it keeps some special database information in an own directory called the CVS root The first step on setting up CVS for your new project thus is to tell KDevelop where this root is located Local CVS root There are two basic possibilities Either you want to use a local CVS database or you use a database which is held on a remote server If you develop for your own you may want use the CVS database as some sort of a backup system on your own computer Usually this is set up in your home directory root and given the name cvsroot This may look as follows home devel cvsroot where devel simply denotes the developing user just for example 112 KDevelop User Manual NOTE In fact this is a short form Exactly the local CVS root should be addressed using the local prefix The short form is only allowed in cases where t
98. de menubar 60 UNIX development 168 history 168 pipe 168 shell 168 update 157 user interface full screen mode 60 GUI 172 KDevelop modes 59 menubar 60 switch modes 60 70 work space 60 V valgrind 159 version CVS 111 database 111 version need circumvent for autoconf automake 159 W warning default build configuration 119 watch variables 150 210
99. dedicated build config urations is done through templates the Application Wizard uses when creating a new project To find out which build configurations currently are available have a look at the Project Build Configuration menu 45 KDevelop User Manual Build Debug Scripts Bookmarks Window C New Project gj Open Project Open Recent Project gt 4 Import Existing Project amp New Class 1 Class Inheritance Diagram Add Translation Build Configuration default Distribution amp Publishing Project Options 3 Close Project optimized x debug There are various build configurations available for this project In this case like our Hello example project there are three different build con figurations available In other cases there may initially be only one such build configuration namely default The currently used build configuration has a check mark left to it In order to switch to another build configuration simply select its menu entry Now let us have a brief look at what these build configurations provide debug You should use this as the standard build configuration during the de velopment process The build occurs separately from the source direc tories in the dedicated debug subdirectory i e all object auxiliary and executable files will be put in the subdirectories there instead of their counterparts in the project root The con i
100. distributed modules For more information see the Comprehensive Perl Archive Network CPAN website C 2 2 Python Python shines by the elegance of its class system and the ease and flexibility with which external libraries can be wrapped in a way that they appear like standard Python classes and functions In contrast to Perl Python has a clear and concise embedding API which makes it the language of choice for making C and C programs scriptable C 2 5 PHP PHP was invented as a language directly embeddable into HTML pages and consequently has its main uses in delivering dynamic content on the web C 3 Higher level Scripting Higher level UNIX applications usually miss the speed and flexibility of the traditional character oriented shell scripting mechanisms This is especially true in the world of graphical user interfaces GUI such as e g KDE There have been attempts to provide similar mechanisms which will work on a higher application level most notably CORBA and in the KDE environment DCOP 169 KDevelop User Manual C 3 1 The CORBA Protocol CORBA Common Object Request Broker Architecture is an attempt to let com puter applications work together over networks It was devised by the private vendor independent OMG Object Management Group standards comittee CORBA based programs use the IIOP standard protocol to communicate Im plementations based on IIOP are available on a wide variety of operating sys t
101. dow They are meant for overall view only You will find detailed descriptions of most operations in a later chapter 10 2 5 1 The Popup Menu for a File When you right mouse button click on a file name in the detail view the fol lowing menu will pop up allowing you to select one of several operations to be performed on that file In the illustration below the hi 16app myapp pn g icon file was selected from the Icon data in myapp target of the myapp src subproject 141 KDevelop User Manual Data in re 0 Header in noinst G Data in kdelnk mvapp ciet emm wrbila guild or ingtall get sman m T t fe a rod gt c pref cpp e The CVS item offers a variet of m editors or with any application E maln CBp atal e g you can open the con d Ico on pun in KAE with KIcpn File Hil E x Remove CVS p Open With b Ferforce 10 2 5 2 The Popup Menu for a Target When you right click on a target in the detail view the following menu will pop up allowing you to select one of several operations to be performed on it In the illustration below the myapp Program in bin target of the myapp src subproject was selected 142 KDevelop User Manual EAEE e The Options item for a target only applies to source code files In the corresponding dialog box yottean specify tinker flags and paths on which to rea libraries and yeu ca ES h list ofa jed in Data in rc to y
102. e Hello identifier was used in our example project type an H into the Lookup input field KDevelop will immediately start working and present you a result like this Type File Hello class home devel projects hello src hello h Hello function home devel projects hello src hello cpp Hello prototype home devel projects hello src hello h Lookup Hits 3 2006 05 29 Regenerate How to look up an identifier in the CTags tool view Tag If you click one of the listed entries KDevelop will open an editor window with this file and position the cursor on the appropriate place Use a context menu in a source file This is handy while you are working on a certain source file Assume you are studying the main cpp file of our Hello example project There you find the following line Hello mainWin 0 and wonder whatever the Hello was used for in the program To find out simply right click on this Hello identifier A menu will pop up in response to this right mouse click featuring the following lines near the bottom CTags Go to Declaration Hello CTags Go to Definition Hello CTags Lookup Hello Getting CTags information on a project internal identifier Click what you are interested in say CTags Go to Definition Hello and KDevelop will immediately open the hello cpp editor window and position the cursor right in front of this class definition Hello Hello KMain
103. e vHelp documentation files as defined on the Devhelp Documentation Col lection configuration page e docdoxygenpluginrc holds information about the actual Doxygen gener ated API documentations as defined on the Doxygen Documentation Collec tion configuration page e dockdevtocpluginrc holds information about the actual KDevelopTOC structured documentation files as defined on the KDevelopTOC Documen tation Collection configuration page e docqtpluginrc holds information about the QT documentation files actu ally included on the Documentation CollectionQt configuration page D 3 Project Dependent Configuration Most project dependend configuration is kept in the lt project name gt kdeve lop and project name kdevses KDevelop project configuration files rather than in separate files as the other more global configuration settings In short those files are meant for project name kdevelop global project configuration information project name kdevses configuration information needed to restore the specific behaviours of the runr Both are XML coded files They can be viewed and cautiously altered using any text editor D 3 1 Persistent Code Store Files There is a third project dependend configuration file the project name kde velop pcs Persistant Code Store This is a binary coded file holding an internal parser cache for the most part in order to speed up the loading sequence of the pr
104. e Diagram entry in the Projects menu as well as the classes navigation combo box in the Browser Toolbar kdevcloser provides the Windows menu close entries kdevctags provides the CTags entry in the Tools menu for the CTags Frontend project plugin kdevcvsservice provides the icon used by the CvsService tab and a short shell script used to add a new entry to the CVS repository both used by the CVS Integration project plugin kdevdebugger provides the Debug menu entries for the Debugger Fron tend project plugin kdevdiff provides the Difference Viewer entry in the Tools menu kdevdistpart provides the Distribution amp Publishing entry in the Project menu for the Final Packaging Support project plugin kdevdocumentation contains files used by the Documentation plugin en and pics contain files used by the htdig search tool tocs contain the default KDevelop documentation content descrip tion files see the description in Basic Structure of KDevelop TOC Files kdevpart documentation rc provides the search related entries in the Help menu kdevdoxygen provides the menu entries for the Doxygen Support project plugin kdevfilecreate contains files used by the New File Wizard file templates provides the initial text contents to be put into the new source file of a given type kdevpart filecreate rc provides the New entry in the File menu temp
105. e The initial contents of this manual were witten by Bernd Gehrmann bernd kdevelop org and Caleb Tennis caleb aei tech com e The Summary of Automake Manager and Automake Manager Operation chapters were written by Ian Wadham ianw netspace net au 155 KDevelop User Manual Appendix A Installing KDevelop In this chapter we will discuss the steps necessary to compile and install the KDevelop IDE e How to obtain KDevelop mainly concentrates on downloading the most re cent KDevelop sources from svn e KDevelop requirements lists the programs and libraries which you need in stalled to successfully compile the IDE e KDevelop compilation and installation leads you through all the steps of compilation and installation of the application e How to obtain a KDevelop API documentation tells what an API is and how you get such a useful tool for navigating the KDevelop sources A 1 How to Obtain KDevelop KDevelop is available in binary form from many different Linux distribu tions such as SuSE RedHat and others These binaries are packed in some convenient format mostly RPM for easy installation To install follow the standard instructions given in your distribution You may as well obtain the KDevelop sources compile and install them by yourself These sources can be found via the project home page at http www kdevelop org or via the KDE ftp site A 1 1 Get Daily KDevelop Snapshots from svn If you want to be in fr
106. e application this template produces if you compile and run it unmodified Usually this is a screenshot of the main window the application will display Select the template which best fits your application s goals as a starting point Then enter the general properties information in the lower field as shown in the next chapter Selecting a Project Management System Each template is bound to a specific Project Management System Currently there is no direct means to freely select such a Project Management System You have to find a template which suits your needs or alter your project accordingly after creation 5 1 1 2 Provide General Information The lower part of the Create New Project dialog General page is a framed field labeled Properties You must provide some general information about your project here so that the Application Wizard knows how to build the initial structure Application Name Your application needs a name of course Enter this in the uppermost Properties field called Application Name We use MyApp as an example 108 KDevelop User Manual When you do so you will notice that the Application Wizard refuses to accept special characters of any kind The only characters accepted are e upper and lower case characters e numbers e the underline character One prominent cause of this restriction is that the Application Wizard will use this application name as the basis of some class names it will construct w
107. e configuration dialog to pop up consisting of a selection window to the left and the configuration dialog on the right hand side whose contents will vary upon the configuration item you did select 64 KDevelop User Manual 13 Configure KDevelop Sm General 19 General Project ix Lo User Interface Defal A Output File Templates 2 Wind x om Editor x Lir f 1 Di Abbreviations Ul Desi Cl e Us Scripting QR e d O Rt Tools Menu Termin A O Ug Frtarnal Taal e Ot Select a configuration item We will discuss these configurations in a different order split up into the main 65 KDevelop User Manual topics of General Configuration Configuring the Documentation and Advanced Configuration which makes for a more intuitive reading If you want directly look up a certain configuration item use one of the follow ing links General User Interface File Templates Editor Abbreviations Scripting Tools Menu External Tools Documentation Code Snippets File List File Selector C Class generator Formatting C Parsing 4 1 General Configuration General configuration concerns the more common tasks of tailoring KDevelop as there are e General Setup e Selecting the User Interface e SOURCE EDIT TASKS Selecting an Editor Selecting a Source Format Style Setting Up the Code Snippets Tool e Configuring the File Selector 4 1 1 General Setup The General configuration dialog allows y
108. e d 98 4 2 16 KDevelop TOC Files 100 42 17 DevHelp Documentation 101 4 2 1 8 Setting Up Custom Documentation Collections 102 4 2 2 Setting Up Text Search Indexes 103 42 3 Other Documentation Configuration Settings 104 43 Advanced Configuration 2 2 ee eee 104 43 1 Plugin Tools 222 84 be eee ER RE GS 104 5 Getting Started the Application Wizard 105 5 1 New Projects 34d a EAS AEE SSE EM wo 105 51 Initial Steps s e ca eee ER eas 106 5 1 1 1 Select Programming Language and Application JyDe oz aAR Se beh eee CR d eRe iUe 107 5 1 1 2 Provide General Information 108 5 1 2 Supply Version System Information 111 5 1 3 Supply Header Source Templates 115 5 1 3 1 How to Edit the Templates 116 5 1 4 Build the Initial Project Files sss 118 52 Configuring Projects eee 119 6 10 KDevelop User Manual Editing Tools 6 1 Code Snippets 226 osse eee ee eee eee ee 62 Keyboard Mapping llle 63 The Problem Reporter 0000000020004 6 4 Searching and Grepping 0 0 0 0 200000 8 641 Searching for Text 2 2 ee 6 42 ISeatchi iu ev Rum ae bos esc EA vet 6453 Grep e d bv ea doses ue eiui e E Ae eus 65 Code Completion 0000000008 6 6 Creating New Files and Classes llle 6 6 1 Editing the Templates leen The File Browsers The Class Br
109. e global KDEDIR variable with the actual KDE directory setting recorded therein Then issue a make command as usual After the KDevelop IDE has been built you have the option to build the API as well For this you must issue kde3src kdevelop make apidocs This will build a Doxyfile in your KDevelop base directory which in turn will be processed by the Doxygen application to build quite a lot of htm1 API files When this rather lengthy API building process may last more than an hour on a slow system finally comes to an end you must install the API just like you have to install the KDevelop IDE itself If necessary obtain superuser rights by kde3src kdevelop gt su and entering the root password Then install the API files kde3src kdevelop gt make install apidox Once this is done make will inform you about the directory where you can finally look at the API documentation s contents Note this address you can use it from Konqueror as well as from inside KDevelop in case you have set up the KDevelop sources themselves as a project to work on NOTE You will most probably see a lot of warning and or error messages during the API build run by Doxygen It is best to ignore them they are of interest to the KDevelop developers only If the API generation ever comes to a successful end the html API files will be usable 164 KDevelop User Manual Appendix B In a Nutshell Tips and Tricks The information in t
110. e kdevses 71 stamp h1 jJ stamp h in aclocal m4 subdirs J AUTHORS TODO ChangeLog amp Variables FileGroups Classes Xp Bookmarks lt 5 FileList ij File Selector NewFile Ij File Tree config h in config log config status configure 17 configure files 17 configure in configure in in The file selector IDEAI mode 86 KDevelop User Manual The behaviour of the File Selector can be highly configured Select Settings Configure KDevelop from the menubar The Customize KDevelop dialog will pop up where you have to select File Selector in the left hand tree This will show the following dialog in the right hand side File Selector Toolbar Available actions Selected actions Reload A Parent Folder a BS New Folder gt Back Id 4 Delete gt Forward Home Folder E Short View 4I Detailed View Auto Synchronization When a document becomes active When a document is opened When the file selector becomes visible Remember locations g Remember filters 9 B Session x Restore location Restore last filter Configuring the file selector Configuring the Toolbar There is a toolbar on top of the File Selector which can be configured as usual in the Toolbar group 1 Select an item in the right hand Selected actions list after which the new action should be
111. ebug build directory shown to the left mirrors the basic project structure and contains some set of build related files such as several configure based files and additionally a Makefile in each subdirectory In the Configuring the Project section shortly below we will have a brief look at the motivations why KDevelop uses separate build directories in cases like this one For the moment it is enough to know that KDevelop created this debug directory amp 8212 if necessary amp 8212 prior to the configure call and that the configure script did build the sub structure and all the Makefiles in there Next from within the debug build directory KDevelop called the configure script in the root directory of our project using a dedicated environment where the CXXFLAGS O0 g3 flags will later signal the gcc compiler that it should not optimize the resulting binaries and include full debugging information with them Finally the con igure script was called with the enable debug full option which instructs it to create each Makefile so that later compilation and linking will have all necessary debugging information be built in and usable KDevelop User Manual All these settings are configurable on a per project basis You will learn more about this in the Project Management chapter 2 5 13 Build the Project Once you got this far you will be ready to actually build i e compile and link the application Looking
112. econds A short tool tip description will pop up In this screenshot the Au tomake Manager tool tip is shown as an example It describes the lower tab in the right tab bar Click here to return to the modes overview E2 Child Frame Windows Mode Click here to return to the modes overview 192 KDevelop User Manual 3 KaeVelop tiles HOTTC VERIS STO MdPVETDD STC ITIHITTWITU DWICDD CORKDPVETOD Eile Edit View Project Build Debug Bookmarks Window Tools Settings Help BQQ1885 XV ES E3 A UR G0 amp 0 al Namespace sl Classes il lil Functions I j Los X mainwindow cpp mainwindow h Qood RX a E le n d di C li vokmarks GJ classes e p savesettings r T return true B Debugger f DocumentationPart fpEditorProxy 4 palin dae Mainwindow main BP Generallnfowidget BP HistoryEntry 89 LangPluginitem B9 LanguageSelectWidget e S Mainwindow void MainWindow createstatusBar c callCommand const return this void new statusBar this GP checkAndFixToolVi aal x clearwindowMenu plugincontroller cpp m i i i childwindowCloseR D createActions void mainwindow createrramework _Jpartselectwidget cpp i partcontroller cpp PartController createInstance this i m ainwindowshare PAcreateGUl kParts 1 setMenuForsDIModesysButt ons menuBar pence ce TM nate s i 2 createStatu
113. ems programming languages and networks and are thus highly portable The main drawback of CORBA is its rather low speed While this may be tol erable in networks it is a real hindrance for inter application communications in a non networked environment such as KDE running on a single computer C 3 2 The DCOP Interface Another evolution on UNIX like scripting is the DCOP protocol which was devised for communication between KDE applications to overcome the limita tions of CORBA DCOP stands for Desktop Communication Protocol and is implemented as a sim ple IPC RPC mechanism built to operate over sockets In effect this provides facilities similar to the traditional UNIX pipe mechanism Traditional shell scripting is based on fairly small tool programs which were designed to work on a strictly textual basis DCOP allows elaborate graphical programs to communicate with each other in a quite similar way This enables e g a KDE program to send messages to another KDE program or receive data from it for its own purposes There are drawbacks however To use DCOP a program must be designed to contain a special DCOP interface And the DCOP communication process runs somewhat slowly although a lot faster than CORBA But it returns much of the power and flexibility of UNIX scripting to high level programs which are based on a graphical user interface For more information see the DCOP Desktop COmmunications Protocol pa per or The
114. ends on the Plugin Tools being currently available to KDevelop You will find more on this topic in the Configuring KDevelop chapter Currently with no project open and the default number of plugin tools loaded you will find the following tool views Clicking on a tab will open respectively close its tool view window Navigation and Selection File Selector Provides a panel to navigate the direc tory tree and select files for work just like you do in the Konqueror Click ing a file will open it in an appropriate editor window in the workspace area A right click in the file selector area will pop up a navigation and file manipulation menu File List Lists the currently open files Clicking on a file will usually select its editor window in the workspace area Use this to quickly navigate in a large number of open files Furthermore this view provides a means to organize the open files into different sessions This is particularly useful in very large and complex projects to help the developer concentrate on different tasks Right clicking a file will pop up a file manipulation menu Messages Displays Application Displays the output from an application started from within KDevelop Diff Used to display patch file contents Displays the output from the dif ference viewer tool started from the Tools Difference Viewer menu Messages Displays messages produced by the build tools called from within KDevelop usually from the Build menu
115. eopen them one by one Or simply close the whole project and reopen it again The windows will then automatically open under the new text editor interface IMPORTANT KDevelop lets you use editor interfaces which have registered with KDE and that provide a KatePart interface If you miss one one of the selections shown above check your KDE installation if the corresponding KPart was correctly installed What to do if the file has been changed externally Do nothing The file will be marked as externally changed and the user will be asked to verify any attempt to overwrite it Alert the user A dialog will alert the user that a file has changed and offer the user to reload the file Automatically reload the file if safe alert the user if not Any files that are not modified in memory are reloaded and an alert is shown for any conflicts 76 KDevelop User Manual 4 1 5 Abbreviations for the Word Completion to be written 4 1 6 Scripting to be written 4 1 7 Adding KDE Standard Applications to the Tools Menu to be written 4 1 8 Adding External Applications to Menus to be written 4 1 8 1 Adding to the Tools Menu to be written 4 1 8 2 Adding to the File Context Menu to be written 4 1 8 3 Adding to the Directory Context Menu to be written 4 1 9 Selecting a Source Format Style KDevelop automatically formats a source text in a
116. er environment Compile KDevelop deals with obtaining the KDevelop sources from svn how to prepare them for the installation process and finally shows the steps necessary to compile and install KDevelop Some Notes on configure Options tells you how to run KDevelop if it has been installed in a location other than the KDE directory 159 KDevelop User Manual A 3 1 Preliminary Steps Before entering the compile sequence you must make sure all libraries and tools are available to the make system To accomplish this some environment variables need to be properly set The actual steps to be performed depend on the console shell you use NOTE To avoid typing in all the statements that set the necessary environment variables every time you want to compile you should put them into your bashrc or cshrc file This way the environment variables will be properly set every time you start the shell A 3 1 1 Setting the Environment for the bash Shell If you use the bash shell add the following lines export KDEDIR path to your KDE installation export QTDIR path to your Qt library export LD LIBRARY PATH QTDIR lib SKDEDIR lib LD LIBRARY PATH export LIBRARY PATH SQTDIR lib S KDEDIR lib SLIBRARY PATH export PATH SQTDIR bin KDEDIR bin PATH A 3 1 2 Setting the Environment for the tcsh Shell If you use the tcsh shell add the following lines setenv KDEDIR path to your KDE installation setenv QTDIR path to your Ot
117. er interface designer e TASK SPECIFIC PARTS kdevabbrev contains files used by the Abbreviation Expansion plugin sources contains keyword definition files used by the Expand Text command templates contains template definition files used by the Expand Ab breviation command kdevabbrev rc provides the Expand Text and Expand Abbreviation entries in the Edit menu kdevappwizard contains files used by the Application Wizard part 175 KDevelop User Manual importfiles contains kdevelop project files which control the ini tialization of a new project imports contains templates to set up project specific desktop files template common contains various files commonly included in the project source directories templates contains configuration files which describe the informa tion to be included in a given project source directory png project preview images used by the Application Wizard tar gz tarballs containing the source files to be included in a new generated project directory kdevastyle provides the Reformat Source entry in the Edit menu kdevautoproject provides most of the entries in the Build menu and the Build Toolbar KDevelop toolbar kdevclassview contains files used by the Class View project plugin pics contains the icons used in the Classes classview tree kdevclassview tc provides the Class Inheritanc
118. es Furthermore you specify a directory where the search is started If you check the Recursive box the search iterates through all directories in the hierarchy below this one The search term is in general a regular expression following POSIX syntax For example you can use the term lt k if you want to find all words which begin with the letter K The following characters are interpreted in a special way Matches any character Matches the beginning of a line 5 Matches the end of a line lt Matches the beginning of a word gt Matches the end of a word 5 The preceding item matches less than once The preceding item is matched Zero or more times The preceding item is matched once or more times The preceding item is matched exactly n times The preceding item is matched n or more times The preceding item matches less than n times The preceding item matches at least n times but less than m times Backreferences to bracketed subexpressions are also available by the notation Mn 122 KDevelop User Manual For C programmers as special bonus there are some search templates avail able for typical patterns These allow you to search for example all calls of member functions of a certain object Once you start the search by clicking on the Search button it will be performed by an external asynchronous process All found items will appear in the view called Grep
119. ess to the hardware and software peculiarities of your system This is a basic requirement in build processes based on the GNU autotools scheme as you probably will know You can command a configure sequence once the basic automake initialization has been successfully finished because only after this initial run the necessary configure files will be available This done select the Build Run Configure menu entry to initiate a configuration sequence KDevelop opened the Messages tool view window again if necessary and listed the messages of the configure run therein If all went right the final messages will be Good your configure finished Start make now which was is sued by configure followed by the KDevelop Success message On top of the Messages window you will again find the command line KDe velop used to initiate this configuration run mkdir home devel projects hello debug amp amp cd home devel projects hello debug amp amp CXXFLAGS 00 g3 home devel projects hello configure e enable debug full You can tell several interesting details from these commands 41 KDevelop User Manual a doc oen S Makefile amp Makefile po S Makefile o src S Makefile config h l config log config status libtool S Makefile 7 stamp hl e First KDevelop uses a dedicated subdirectory in the project directory tree for the build process This d
120. even find this template page empty If the page is used Application Wizard will fill in some common header com ment which for a C based application might look like Axx RR RR RK OR RK RR RK RO RK OK OR OR k ko k ck ko pK Ok Ok eK k xk xX Copyright C 2003 by Your Name gt you you com 115 KDevelop User Manual 4 5 a This program is free software you can redistribute it eoe and or modify ii i under the terms of the GNU General Public License as published by the Free Software Foundation either version 2 of the License or at your option any later version c B This program is distributed in the hope that it will be useful ui but WITHOUT ANY WARRANTY without even the implied lt warranty of bi MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the x GNU General Public Lacense for more details lt od c id You should have received a copy of the GNU General lt lt Public License along with this program if not write to the i Eree Software Foundation Inc lt D2 Temple Place Suter UT Boston MA 02S e MU SAC XOKCKCKCkCk kCk Ck KCk Ck Ck kCkCk Ck k Ck k Ck kCk Ck CkCk k k Ck k Ck k Ck Ck Ck k k k Ck k Ck k Ck k Ck kCk k k k k kc k ck kok kk sk k qoe k e kx e ke x kx x x x Other templates will provide similar information in a format according to the definitions of the programming language you
121. ew File Add existing files to a project Select the sub project in the upper half of the Automake Manager then right mouse button click in the lower half on the groups title you want to have the files added and select Add Existing Files Remove a file from a project Select the sub project in the upper half of the Au tomake Manager then in the lower half open the groups list you want to have the file removed from right mouse button click on the file in this list and select Remove 166 KDevelop User Manual COMPILE MAKE PROBLEMS Project does not build again after switching to from default target There isa problem with the automake autoconf machinery If Project Build Con figuration provides to select from three build directories default op timized and debug by all means stick to either the default or the de bug optimized targets e Once you configured your project with default it will no longer build with debug or optimzed e Once you configured your project with debug or optimzed it will no longer build with default Wrong autoconf version etc Error There are several error messages concern ing too old versions of autoconf etc prohibiting configure to work prop erly Run autoreconf in the directory tree where the configure in files in question are This command will try to update the information in the GNU Build System files See man autoreconf for more information OTHER TOPICS Configuration Files u
122. f KDE that you are running 202 KDevelop User Manual Appendix H Further Information H 1 Getting Information to be written H 2 Reporting Bugs to be written H 3 Licensing This documentation is licensed under the terms of the GNU Free Documenta tion License This program is licensed under the terms of the GNU General Public License 203 KDevelop User Manual Appendix I Changes I 1 Changes to This Document e 2003 01 03 Bernd Gehrmann Caleb Tennis initial manual layout many chapter contents sketched e 2004 08 01 Bernd Pol Ian Wadham manual slightly reorganized some missing chapters written e 2005 05 02 Volker Paul Many changes including split into one file per chapter appendix added command reference sorted by menu descriptions not yet complete AppWizard tutorial in getting started docbook reorganized chapters guided by Konqueror manual moved installation Unix development In a Nutshell to the appendix rewrote plugin appendix incl plugin list generator listplugins sh Still far from complete but a small step forward e 2006 05 20 Bernd Pol Filling in some more to be written holes 204 KDevelop User Manual Appendix J Bibliography to be written J 0 0 0 0 1 Bibliography 1 Richard M Stallman and Roland McGrath GNU Make Manual 2 David MacKenzie and Tom Tromey GNU Automake 1 2 3 David MacKenzie a
123. f you initiate another global search its results will display in another tabbed window in the Find in Files tool view window 2 4 3 Arranging Editor Windows When your work with large complex projects you will often end up with quite a lot of tabbed editor windows residing on the tab bar This makes specific facilities to clean up order and group all those editor tabs necessary KDevelop provides several means for this We will have a short look at some of them How to remove unneeded tabs How to rearrange the tabs How to view several files simultaneously in the workspace area How to edit C source and header files simultaneously How to group source files into development sessions 24 3 4 Cleaning up the Tabs Row If the vast amount of editor window tabs becomes badly arranged at all you usually may want to close all those tabs you really do not need any more KDe velop provides several facilities to do so the usual way of bulk closing open editor windows and a more specific approach where you can expressly com mand which ones to close and which to keep open Closing Several Tabs At Once This is kind of a bulk approach to close unnec essarily open tabs which you may find in other KDE applications as well You can use the Window menu or right click on a tab to either e close the currently selected editor window e close all other open editor windows or e close all editor windows at once available from the Window menu only
124. figure prefix where your kde3 is There is a caveat if you do so You must provide a means for KDevelop to access the needed tools and parts in the KDE directory when running You can still use the IDE without doing so but with very restrained capabilities Call up a shell and have the following commands executed before you start KDevelop at the shell prompt NOTE Take care to use the plural It is KDEDIRS not just KDEDIR export KDEDIRS usr local kde opt kde3 gt kbuildsycoca Now start KDevelop kdevelop NOTE The KDEDIRS environment variable must be set to the ist of active KDE directories in your system We use usr local kde opt kde3 as an example only The usr local kde directory may for instance contain an incomplete KDE version you compiled for debug purpose In a tcsh shell you must set the environment variables using setenv KDEDIRS usr local kde opt kde3 The kbuildsycoca command build system control cache looks around for libraries and caches their location and version so that KDevelop can find them The caveat is that it takes noticeable time and it has to be run any time you call up the shell to start KDevelop from a non default directory You may want to put the above commands into a shell script to reduce the typing effort You could as well put the lines in your bashrc or cshrc file but this is not advisable as kbuildsycoca will then be run any
125. file by default Thus kde3src kdevelop gt make suffices If necessary now gain root user rights using the command kde3src kdevelop gt su and entering the root password Then install the application kde3src kdevelop gt make install That s all If you installed KDevelop in the default KDE directory you may now run the IDE Otherwise some additional steps will be necessary as shown in the Non default installation directory section below NOTE In fact there usually will have been three KDevelop based applications in stalled e The KDevelop IDE this is the place where you will usually work e The stand alone KDevelop Assistant documentation browser isolates all the powerful documentation facilities of the KDevelop IDE in a separate tool This comes in handy when you want to look up some programming documentation but do not want to start the full IDE e The KDevelop Designer enhances the Qt User Interface Designer by KDE specific elements and integrates nicely in the KDevelop IDE 162 KDevelop User Manual A 3 3 Some Notes on configure Options A 3 3 1 Non default Installation Directory By default configure prepares the IDE to be installed in the default KDE direc tory This is necessary because KDevelop assumes direct access to some tools and parts which reside there If want to use your own installation directory you must tell configure this by the prefix option kde3src kdevelop con
126. for the primary e g myapp for SOURCES indicating that the source files listed after myapp SOURCES go into building myapp e A special prefix noinst short for no installation usually used to list pro gram header files h e Or the special prefix EXTRA for configuration dependent stuff For more information on Automake and Makefile amfiles look up info Automake Basically Automake Manager creates and updates the variable names and lists of files or parameters See the following example of a Makefile am for a typical application called nyapp Makefile am for myapp this is the program that gets installed it s name is used for alll of the other Makefile am variables bin PROGRAMS myapp set the include path for X qt and KDE NCLUDES all includes the library search path myapp LDFLAGS KDE RPATH all libraries 135 KDevelop User Manual the libraries to link against myapp_LDADD LIB_KFILE LIB_KDEPRINT which sources should be compiled for myapp myapp_SOURCES main cpp myapp cpp myappview cpp these are the headers for your project noinst_HEADERS myapp h myappview h let automoc handle all of the meta source files moc ETASOURCES AUTO KDE_ICON myapp this is where the kdelnk file will go kdelnkdir kde appsdir Utilities kdelnk DATA myapp desktop this is where the XML GUI resource file goes rcdir kde datadir myapp rc DATA my
127. g 152 non default directory 163 O obtain KDevelop 156 overall view 58 P Pascal new project 108 PATH 160 path new project 108 Perl 169 new project 108 requirements 158 PHP 169 new project 108 plugins 185 preliminaries KDevelop installation 160 programming language 107 project application type 107 author 108 create new project dialog 106 CVS 111 directory 108 email 108 initial build 118 language 107 license 108 main cpp 108 new 105 build 118 programming language 107 properties 108 209 templates 106 edit 116 project management 62 projects ant 63 automake 62 cmake 62 custom 63 Java 63 qmake 62 properties 108 Python 169 new project 108 qmake projects 62 Ot requirements 158 Qt Embedded 149 OTDIR 160 Otopia 149 R recompilations 171 regexptest 190 regular expressions debugging 190 remote CVS 113 repository CVS 114 requirements 158 revision control 153 root CVS 112 Ruby new project 108 rule 171 S scripting languages 168 CORBA 170 DCOP 170 Perl 169 PHP 169 Python 169 search in files 122 incremental 121 searching 121 shell new project 108 UNIX 168 SOL KDevelop User Manual new project 108 survey 58 svn 156 requirements 159 switch UI modes 60 70 T Tabbed Pages 59 target 171 templates project 106 edit 116 toolbar debugger 152 Toplevel Windows 59 U UI modes 59 unhi
128. ger context Clicking a subproject entry opens a suitable display of the project files in this subproject in the lower window The files listed there will be grouped according to their Makefile am functionality in this subproject The Automake Manager is a very powerful tool to manage the project and its subprojects as well as the roles project files play in building the application We will have a short look at a few major details below See the Building and Project Management chapter for a more extensive description 2 4 Some Tips About Dealing With Documents In our example project the Application Wizard did leave the hello cpp file open in an editor window so you can immediately start working Now we may well assume your are knowledgeable about using an editor so we do not need talk much about this here But there are some handy KDevelop specifics about dealing with such tabbed editor windows and the documents you are working on We will have a short look at some of them namely How to easily switch between header and implementation files How to quickly access declarations and definitions How to arrange editor windows to your current needs How to keep an eye on common problems 2 4 1 Switching Between Header and Implementation Files KDevelop provides a quick and easy way to switch from a given implementa tion cpp file to the corresponding header h file and vice versa Just right click into the editor window you want to sw
129. ger makes use e A short autoconf tutorial written by Christopher W Curtis available on the KDevelop home page It concentrates on some basic steps to modify a Mak efile e A more detailed tutorial can be found in a greater set of tutorials on Devel oping software with GNU e And there is the famous Goat Book titled Autoconf Automake and Libtool This is an easily readable yet concise introduction in all main aspects of the GNU Autotools 10 13 What does Automake Manager Do The Application Wizard will have set up some initial Makefile am files when you created a New Project of a type that uses the GNU Build System such as C KDE Application framework During development Automake Man ager creates any other Makefile am files for projects that use the GNU Build System and maintains them all Application Wizard and Automake Manager created alike There will be one Makefile am file in each directory of your project that con tains files to be compiled or installed It will contain your specifications for 133 KDevelop User Manual compiling building and installing files and a reference to any subdirectories that also have a Makefile am file and possibly some files to compile build and install NOTE Your project s directories and source files may be structured to any depth or you may prefer a flat project structure with all subdirectories at the top level The aim of the GNU Build System is to pr
130. gs heme This was inserted by the Application Wizard when you created the Hello project in the Starting a New Project chapter above e Now open the Problems tool view in the bottom tabs row If all went right it will currently report this todo main cpp ise else a 1 E cessio start KCmdLineArgs args KCmdLineArgs parsedArgs jaa File Selector todo do something with the command line args here __ mainWin new Hello y P ae ist Current Errors Fixme Todo Lookup evel Line Column Problem Todo 58 18 do something with the command line args here KDevelop is alerting a source code line containing a todo mark 36 KDevelop User Manual The format of the todo command is for special treatment by the Doxygen code documenter which we will look at briefly in the Documentation section below It is not mandatory that you use this format the more common TODO and FIXME comment marks will be recognized as well If you e g insert the following TODO and FIXME comment lines in our hello cpp example file Hello Hello KMainWindow 0 Hello set the shell s ui resource file TODO check the user interface setxMLELTle hellous ro FIXME change to a better suited greeting new QLabel Hello World this hello label you will find them listed in the Problems tool view as well
131. guration to be written 4 3 1 Plugin Tools to be written 104 KDevelop User Manual Chapter 5 Getting Started the Application Wizard Bernd Pol In KDevelop software development work is organized in projects Such a project keeps everything together which belongs to a complete pro gramming task source files additional data files any actually needed man agement facilities as the make system as well as access to all components and any additional tools needed to get the application up and running Organizing all development work in projects allows you to easily switch be tween the global tasks at hand This is quite handy if you e g work on several applications at the same time as is often the case Tell KDevelop to open the project you want to work at and you may proceed in the environment just where you left 5 1 New Projects Whenever you want to initiate a new programming project quite a lot of formal setup procedures need to be done An initial directory structure has to be set up initial header and source files must be provided the make system has to be initialized etc KDevelop provides an easy way to initiate a new programming project the Application Wizard You will find the Application Wizard at menu entry Project New Project Only a short series of steps is necessary to start a new programming project using the Application Wizard 1 Select the programming language you want to
132. gure script will be given the enable debug full option and the CXXFLAGS O0 g3 will signal the gcc compiler to not optimize the code and to insert extensive debug in formation into the resulting binaries optimized This is used to build a final C application The build occurs sep arately from the source directories in the dedicated optimized subdirec tory No specific arguments to the configure script will be preset yet the CXXFLAGS O2 g0 will signal the gcc compiler to optimize the code and to not insert debug information into the resulting binaries default The term default denotes the standard setup when you build an ap plication from the console using e g the GNU configure and make g make command line oriented build tools Other than debug or optimize 46 KDevelop User Manual no dedicated build directory will be used The application will by default be built in the sources directories instead There are no special configura tion switches predefined Building and running the application will use the default settings of the underlying tools e g gcc etc WARNING Think twice before you decide to use the default build environment It cannot be used in parallel to the dedicated debug or optimized ones Any build operation using default will render both of the other build environments unusable This is caused by some peculiarities of the Makefile construc tion process using the automake autoconf machinery which c
133. hange of the Search check box marks will thus effect the search runs only after you rebuilt the index on the Search page of the KDevelop Documentation facility Title This is the name of the Documentation item as it will be shown on the Contents page of the KDevelop Documentation facility NOTE Former KDevelop versions allowed to select the documentation items to be displayed on a per project basis This is not available any more 4 2 1 2 Qt Documentation Collections On this configuration page all Qt documentation is set up 93 KDevelop User Manual Documentation Documentation Collections Full Text Search Other Index Search Title Add Inm Ada E r Ada bugs GCC i Bash bugs Bash Reference Manual oO Bonobo Activation API Reference Manual C Annotations C bugs GCC Clanlib Document Object Model DOM Level 2 HT Fortran bugs GCC GConf Reference Manual GIMP Base Library Reference Manual GIMP Color Library Reference Manual GIMP Library Reference Manual GIMP Math Library Reference Manual GIMP Module Library Reference Manual GIMP Thumbnail Library Reference Manual GIMP Widgets Library Reference Manual GLib Reference Manual AMAMA N ANI Dafaranan TEST ESI ESL EST ESL ST EST ST EST EST ST EST ST EE ST EST ST ST S 2 O Remove P o0o0000000 JOOOOOOOOOOOO0O0Oo00000 oOo Setting up the Qt documentat
134. he project sources are listed too 2 3 2 1 Copyright Issues All GNU conformant applications must be copyrighted There are two levels which require copyright notices individual source files and run time application level The Application Wizard did already put appropriate copyright and li censing information into the project files Source File Level Copyrights Do you remember the Project Options dialog page in the new project setup You had to provide your the developer s name and optionally an email address there Now refer to the top of the hello cpp ed itor window currently displayed in the workspace area The Application Wiz ard did enter these statements on top of the licensing header of every source file it created 18 KDevelop User Manual BOR RK KR kk RR RR RR RR RK KOK OR KR OR k k k ko KK pK Ok Ok eK Ke x Copyright C 2006 by Joe User s 2i joe user com i WC vues x This program is free software you can redistribute it and or modify You will find exactly the same text headers in every source file you will create inside KDevelop provided you use the proper built in tools for file creation KDevelop remembers these settings in some template files you may find in the templates directory Application Run Time Copyrights Once your KDE application runs the user may display some About data usually from the Help menu The Application Wizard did also take care of this If you have a look
135. he Indentation tab of the Source Formatter dialog you will be presented with a series of indentation formatting choices grouped into three boxes as following 79 KDevelop User Manual Formatting Filling CQ Us e Us General Indentation Other Continuation e tabs Maximum in statement 40 E e spaces 2 Minimum in conditional Twice current Ia Indented Entities Indent switches Indentcases Indentclasses Indent brackets X Indent namespaces X Indent labels Source format indentation style setup Default Settings The preset format choices will cause the source text to resem ble the ANSI formatting style name aum space foospace t Foo if isBar bar return d else return 0 Defining Indentation Width and Characters The radio buttons grouped in the Filling group define how indents in the source text will be drawn Use tabs This will cause the editor to insert a tab character for each in dentation level The tab width is predefined in the editor settings 8 80 KDevelop User Manual or 4 character columns usually Use Settings Configure Editor to redefine it NOTE The actual tab width definition procedure depends on the editor you selected in the Selecting an Editor configuration step You will have to look up the corresponding editor help to find out Use sp
136. he filename starts with a slash The full name for our example local CVS root would exactly look like local home devel cvsroot Enter the name of the CVS root directory your system has been set up for in the CVS root field In principle you can select any name even use multiple CVS databases but it is advisable that you stick to the CVS root once set up Initialize a new CVS root If there does not exist a CVS root yet KDevelop can command the CVS system to create one for you in the given directory Just check the Init root checkbox below the CVS root field NOTE As said KDevelop only commands the CVS system to initialize a new CVS root It does nothing by itself to this directory Fortunately CVS is clever enough to check whether the CVS root directory already exists Hence it does no harm if you should have inadvertently checked Init root on an already existing CVS root directory Remote CVS root There are occasions where the CVS database is to be kept on a remote server especially when several developers work at the same project Then you must enter the CVS root URL of this server in the CVS root field For example if you want access to the KDE CVS server pserver mylogin cvs kde org home kde where mylogin denotes the lo gin name set up in your KDE CVS account Remote CVS Server Types Basically there are two widely used remote CVS server types the pserver which uses a password secured non encrypted
137. hen it sets up an initial project Thus the name of the application must stick to the rules of the programming language you use The Project Directory The other prominent cause of this restriction you can see at the bottom line of the Properties area It is labeled Final location and shows the directory where the Application Wizard will create the application As you type the application name you will notice that the Application Wizard repeats your input at the end of the Final location line using lower case only characters Thus you must select the name of your new application with care If you end up with an already used directory the Application Wizard will not allow you to continue to the next step keeping the Next gt button deactivated grayed Yet it will warn you in this case by appending dir file already exist to the Final location line The Starting Path There are two ways to select another path for your new application One is to select another name Yet this is not always feasible you might e g set up for another version of an already existing application As an alternative you may select another path to the application directory This is done in the second row input field of the Properties named Location What you enter here is the starting path of the new application development directory The Application Wizard appends the application name to this path when it initializes the new project The result is shown in the
138. his chapter is meant as a quick reference for a head start or if you momentarily forgot about some basic concept There are also short hints on how to solve some common problems when working with KDevelop If you want more information on a topic just follow the link in the title starting that advice Information on these topics is availabe Look and Feel Projects Compilation Automake Manager Compile Make Problems Other Topics LOOK AND FEEL Force smaller tool view tabs in IDEAI Mode By default KDevelop starts with large text based tool tip tabs around the work area You may change this look to e g save space in the KDevelop configuration dialog Settings Configure KDevelop User Interface If you use an older KDevelop 3 version this configuration dialog may not be available To change the toolview tabs display manually place a MDIStyle entry under the UI tag in your SKDEHOME share config kde veloprc configuration file as follows MDIStyle 0 icons only MDIStyle 1 text only default MDIStyle 3 icons and text 165 KDevelop User Manual Weird colored characters and or display style If you notice random colored letters everywhere i e on tabs on tool bars etc and the KDevelop window seemingly uses a wrong display style this may help e In your SKDEHOME share config kdeveloprc configuration file find the line containing Style Checked and remove it Then restart KDevelop This behaviour does somet
139. his is unchecked by default so KDevelop does start the program in a window of its own without console terminal I O capabilities 2 6 How to Extend a Project the Automake Man ager to be written 54 KDevelop User Manual 2 6 1 A Short Look at the Automake Machinery to be written 2 6 2 How to Place Icons in a Separate Directory to be written 2 605 How to Add New Classes to be written CAUTION Be careful when you select your class file names It is extremely difficult to change them later 2 6 4 What is in a Subproject to be written 2 6 4 1 Concentrate on Your Work the Active Target to be written 2 6 5 Some Steps to Restructure a Project to be written 24 How to Debug to be written 2 8 A Note on Your Project Documentation The KDE project uses docbook for generating your project handbook i e the user manual The user manual is available through your application menubar by choosing Help YourApplicat ion Handbook when your KDE GUI appli cation is running After building your project the user manual is displayed in 55 KDevelop User Manual KDE KHelpCenter It should explain to the user how your application works what are the main features and how to configure it It should also explain the advanced features if any All KDE based templates in KDevelop have a doc subdir which contains a i ndex docbook template in the en folde
140. hly flexible programming tool As time has gone by both worlds have evolved While C is still used mainly as a system programming language C as a variant of C enriched by object oriented and generic extensions has found its place for the development of complex applications in the 1990 s There are numerous other programming languages even older ones keep their place FORTRAN 77 and Ada e g still have their stronghold in numerical applications 168 KDevelop User Manual C 2 Contemporary Scripting Languages In the scripting area there has been a shift away from the shell which suf fers from portability concerns to languages which unify all commonly needed functionality in their standard libraries while still being able to interface to the outside through pipes when necessary All these scripting languages have in common that they are widely portable be tween UNIX variants Microsoft Windows Mac OS or even VMS Also they all have implementations that are freely distributable C 2 1 Perl Perl has become popular as a text processing and system administration lan guage In the beginning of the World Wide Web CGI scripts written in Perl were a widely used method to create dynamic web pages from databases To day this method has been replaced mostly by the mod_perl plugin for the Apache web server Among Perl s strengths are its built in support for ad vanced regular expression matching and its rich archive of freely
141. hod Tools Preview Doxygen Output Alt Ctrl P Preview Doxygen Output Tools Document Current Function Ctrl Shift S Document Current Func tion 201 KDevelop User Manual G 1 10 The Settings Menu Settings Show Hide Menubar Ctrl M Show Hide the menubar Settings Toolbars Opens asub menu where you can choose to show or hide the various Toolbars Settings Show Statusbar Show the Statusbar Settings Configure Shortcuts Configure Shortcuts Settings Configure Toolbar Configure Toolbar Settings Configure Notifications Configure Notifications Settings Configure Editor Configure Editor Settings Configure KDevelop Configure KDevelop G 1 11 The Help Menu Help KDevelop Handbook View this document Help What s This Shift F1 Draws a question mark beside the mouse pointer clicking on a window item such as the Stop button will then dis play a brief explanation Help Tip of the Day Tip of the Day Help Look in Documentation Index Alt Ctrl I Look in Documentation Index Help Search in Documentation Alt Ctrl S Search in Documentation Help Man Page Man Page Help Info Page Info Page Help Report Bug Report bug Help About KDevelop Display some brief information about KDevelop s version number authors and license agreement Help About KDE Show some information about the version o
142. ible for this When a document becomes active If you select this checkbox the con tents in the File Selector window will be updated whenever you go to another already open document e g when you click on the tab of the according edit window in IDEAI mode If necessary the File Selector will switch to the directory this file belongs to and update the display to show the actual contents in there When a document is opened If you select this checkbox the contents in the File Selector window will be updated whenever a document will be opened e g by the File Open menu If necessary the File Se lector will switch to the directory this file belongs to and update the display to show the actual contents in there When the file selector becomes visible If you select this checkbox the contents in the File Selector window will be updated whenever it gets visible again If necessary it will switch to the directory the ac tual document belongs to and update the display to show the actual contents in there You may freely combine these settings to tailor the actualization behaviour of the File Selector to your liking Controlling the History in the Comboboxes There are two comboboxes on top and bottom of the File Selector contents window which control the direc tory to be displayed top combobox and the filters to be applied to the file display bottom combobox A history of the most recent settings is kept in the selection field of each
143. ie s aue ee 412 Selecting the User Interface nonoa 413 Pile Templates sisia sieca m a ea a eo A a 414 Selecting an Editor aaau a 4 1 5 Abbreviations for the Word Completion 416 Scripting 999 er ee kr 41 7 Adding KDE Standard Applications to the Tools Menu 41 8 Adding External Applications to Menus 4 1 8 1 Adding tothe Tools Menu 41 82 Adding to the File Context Menu 4 1 8 3 Adding to the Directory Context Menu 4 1 9 Selecting a Source Format Style 58 59 60 60 61 61 61 61 61 61 61 62 62 62 62 62 63 63 63 KDevelop User Manual 41 9 1 General Formatting Setup 78 41 9 2 Indentation Style Setup 79 41 9 3 Other Formatting Setup 82 4 1 10 Setting Up the Code Snippets Tool 84 4 111 ile Fist Rien ERR estes 85 4 1 12 Configuring the File Selector 85 4113 C Class Generator llle 89 4114 Formatting 2 89 41 15 Tt arsine xo a ents irda e ae al one xm ES 89 42 Configuring the Documentation cles 89 42 1 Setting Up Documentation Collections 91 4 2 1 1 Common Documentation Setup Structure 92 42 12 Qt Documentation Collections 93 4 2 13 Setting Up the CHM Documentation Collection 95 42 14 Documentation Generated by Doxygen 95 4 2 1 5 Handling Structured Documentation KDevel OplOC Files umore Rer ele a
144. ig directory bookmarks maintains the entries in the Bookmarks tab of the KDevelop Documentation plugin index holds various cache files KDevelop uses to speed up indexed documentation searches in the Index tab of the Documentation plugin search contains files used by the htdig search tool which serves search calls from the Search tab of the Documentation plugin kdevpart documentation rc provides the search related entries in the Help menu kdevdoxygen provides the menu entries for the Doxygen Support project plugin kdevelop contains some actual settings KDevelop uses for its basic setup profiles provides actual plugin profile setting Initially there is only a FullIDE profile which defines a full set of initially active KDevelop plu gins kdevelopui rc provides the basic menu and tool bar entries KDevelop uses 180 KDevelop User Manual e kdevfilecreate contains files used by the New File Wizard file templates provides the actually used text contents to be put into the new source file of a given type More file templates are found in the default configuration files directory kdevpart_filecreate rc provides the New entry in the File menu template info xml contains descriptions of the available file types to be displayed in the New File tool view kdevfilter provides the Execute Command and Filter Selection Through Com
145. iguring and compiling your application with these options it will link with the 1ibqpe so library This version of your application will not nor mally run when you use X11 In order to test it run it under the control of the program qvfb Qt Virtual Frame Buffer This is done by starting qvfb and then starting your application with app qws display QVFb 0 Naturally when you have a working version of your application you will want to use it on the target processor For this it will probably be convenient to cre ate multiple build configurations as explained above so that you can quickly switch between the version running on your development system and the ver sion running on the target system Applications for Qt embedded normally run as single applications on the de vice they are designed for Trolltech also supports Otopia which is a collection of applications for PIM web browsing and various other areas that work to gether in a consistent manner It is the standard environment for instance on the Sharp Zaurus You can write applications that integrate into this environ ment by using the Otopia SDK This implies making your application class a subclass of QPEApplication and linking to the library libqpe so If you de velop your application with the autoproject project management you have to add enable qtopia to the configure options 149 KDevelop User Manual Chapter 12 The Debugger Interface For C
146. ile can thus grow very complex We cannot go into the details here However we recommend that you make yourself accustomed to the syntax of make Even if you do not normally use it directly an understanding of the fundamentals of the build system can be useful See the GNU Make Manual for more information For more KDevelop specific detail see the Building and Project Management chapter of this manual There are several tutorials available see the references in the Building and project management chapter C 5 GUI Development Application developers become even more encumbered by having not only to create program libraries and logic but also to provide an easy to use custom built user interface that is both intuitive and functional Most programmers receive little to no training in GUI development and as a result user interfaces often are poorly designed During the years some common design principles have evolved It is strongly advised to adhere to them This way your user interfaces will retain a common look and feel that the users of your application will gratefully appreciate For KDE GUI development there is a style guide available It is found in the KDE User Interface Guidelines on the KDE Developer s Corner page A short introduction to common GUI design principles can be found here C 6 Integrating Concepts and Tools the IDE There are separate tools available for almost any step in the programming pro cess planning
147. imes occur after you left clicked a ui file in one of the file navigators and KDevelop did load KUI Viewer to show the GUI which was produced from this file Full screen mode Select View Full Screen Mode from the menus or press Ctrl Shift F Hide Unhide the menubar To hide the menubar select Settings Show Menubar from the menus or press Ctrl M To redisplay the menubar only Ctrl M is available PROJECTS Create New Project Project New Project will start the Application Wiz ard Create a custom project There is no direct way to create a custom project i e a project which does use its own makefiles Use Project Import Existing Project instead Remember to set the appropriate Project Type labeled by an additional Custom Makefiles in the dialog Use project options early Whenever you start a new project do not forget to set the Project Project Options to your needs COMPILATION Missing detail in compilation messages If during compilations you notice some valuable information is missing in the Messages Output View window it may be that the level of message detail is set too low right mouse but ton click in the window and select another detail level from the context AUTOMAKE MANAGER Create new files in a project Select the sub project in the upper half of the Au tomake Manager then right mouse button click in the lower half on the groups title you want to have the files added and select Create N
148. in order to let any of these selections take effect When you selected either the Simplified IDEA window mode or the IDEAI window mode or the Tabbed pages mode two more configuration sections will become available Use Tabs and Use Close On Hover These allow to configure under which circumstances tabs will be shown on top of the document win dows and whether you may close the document by a click on the tab icon In Simplified IDEA window mode and in IDEA window mode only yet an other configuration section will be available Toolview Tab Layout which ef fectively allows to select between different sizes of the toolview tabs which surround the main working area in this mode Configuring the Documents Tab Bar Display In the IDEAI and tabbed pages modes there will be named tabs on top of the document windows by de 72 KDevelop User Manual fault so you can easily select different documents with a left mouse but ton click If you prefer to provide more space for the document windows in the KDevelop main work area you may change to another behaviour in the Use Tabs configuration section Always This is the default show a tab comprising an icon and the document name on top of any document window in the KDevelop main area display When more than one Do not show a tab when only one document is dis played If there is more than one document however KDevelop will display an according tab bar as in the Always selection above
149. include the Makefile in files and the co nfigure script file so the recipient can compile build and install your applica tion without having Automake Autoconf or KDevelop on their machine The Makefile am files are also included just in case the receiver needs to do any source code modifications NOTE The rules are rather different if you distribute via a web based source code reposi tory such as KDE CVS 134 KDevelop User Manual 10 1 4 Summary of What Automake Manager Does e Generates Makefile am files in subdirectories it knows as subprojects e Updates Makefile am files as the project structure changes e Updates Makefile am files as files are added to or removed from the project e Accepts definitions of how the various files are to be built or installed and modifies the Makefile am accordingly e Accepts parameters used in building or installing e g library names and ensures that they are used in the required compilation and build steps 10 1 5 Contents of Automake Files A Makefile am file has lines containing variable names followed by an equals sign and a list of files or parameter values The variables have two part names such as bin_PROGRAMS myapp_SOURCES or kdelnk_DATA The second part is called the primary and represents something from which to build or install The first part is called the prefix and represents e A directory in which to do installation e g bin e A qualifier
150. intainable To accomplish this KDe velop organizes software development tasks in projects Thus the first practical step to develop software in KDevelop usually is to create a new project Fortunately this is fairly easily accomplished KDevelop provides the so called Application Wizard tool for this See the Getting Started the Application Wizard chapter for more 14 KDevelop User Manual We will now start a simple KDE application project to illustrate how easily this is accomplished and which files and tools KDevelop will have provided Thereby we will have a short look at How to create a new project with the help of the Application Wizard Which files the Application Wizard initially did set up What about the additional tool view shown with the project 23 1 How to Create a New Project Let us create a rather simple Hello World KDE project Just follow these steps 1 To start the Application Wizard click the Project New Project menu 2 The Create New Project dialog will pop up In the upper left All Projects window there will be a number of programming languages listed a We want to build a KDE C application as usual thus click on the label left of the C label to open this branch b A series of possible application targets will be displayed We will build a KDE application thus open the next sub branch via the label next to KDE c Now you will be offered a series of possible project templates
151. ion collection Normally KDevelop will fill this in on its first start up It looks for standard xml or dcf documentation files in the Qt installation directory The table to the left lists the files KDevelop found by their standard titles If you have a non standard installation either there will be no information listed at all or the entries will possibly refer to improper locations e g to an other Ot M installation available in your system You may adjust the entries using the buttons to the right of the list field NOTE KDevelop will use the titles already provided by the installed Qt documentation Hence the Title field in the Documentation Catalog Properties dialog is inaccessible By default not all Qt documentation will be shown on the Contents page of the KDevelop Documentation facility Use the TOC check box in the setup table to select the documentation to be shown If you want to have some specific Qt documentation included in the search indexes or full text search use the Index and Searchcheck boxes in the setup table 94 KDevelop User Manual 4 2 13 Setting Up the CHM Documentation Collection On this configuration page you may collect documentation according to the MicrosoftR CHM help file standard Documentation Documentation Collections Full Text Search Other Qt Documentation Collection He Add CHM Documentation Collection Toc lindex ISeach Taa 000 Edit TOC
152. irectory or Leaving directory when it switches the di rectories it currently works in As this clutters the messages list in the Messages Output View window KDevelop suppresses those messages by default Mark the checkbox if you want to protocol which directories make worked in NOTE Changes in this setting effect the processing of new messages only Old di rectory navigation messages will be kept visible when you switch this feature off UI Designer Integration This let you choose the way you want ui files to be displayed in KDevelop KDevelop comes with its own UI designer called KDeveDesigner that can either be embedded or be run as a separate pro gram Qt Designer can also be used to edit ui files e Use KDevelop s embedded designer This uses KDevelop own designer embedded within KDevelop e Run KDevelop s designer as a separate application The KDevDesigner application will be run separately in its own win dow 69 KDevelop User Manual E KDevDesigner File Edit Project Layout Window Tools Settings Help Qa amp d 0 W mz i Rae Common Widgets Objects ek PushButton Name Class RadioButton Form QDialog If CheckBox Containers Database Properties Signal Handlers Display KDE Buttons KDE Property Value name Formi Input KDE enabled True Views KDE sizePolicy Preferred Pre Container KDE minimumSize 0 0 Graphics K
153. irectory src hello Browse Program arguments Environment Variables Name vw Value Add Copy Edit Remove C Start in external terminal X Automatically compile before execution Define where and how your program shall be run Now there is quite a lot which can be set up from this dialog Basically there are four groups of configuration items e Directory This tells KDevelop where it basically shall assume the executable to be called There are three possibilities you can select from Note however that only root directories are defined here KDevelop usually looks for the executable in some subdirectory given in the next configuration group Run from the directory where the executable was build the last time This is the default You can keep this for now 53 KDevelop User Manual Run from the build directory according to the currently selected build con figuration The name of this directory was set up on the General Configu ration dialog page This is the root where KDevelop will find the executable It changes auto matically with the selection you made in Project Build Configurations menu Try it Other than always running the most recently built executable according to the setting above this allows you to switch the program to be executed by simply selecting another build configuration from the Project menu Run the executable found in a fixed custom directory Again this is the roo
154. itch A menu similar to the follow ing will pop up 23 KDevelop User Manual Paste Ctrl V Select All Ctrl tA Bookmarks Split Horizontal Split Vertical Switch header implermentation Toggle Breakpoint How to switch between implementation and header files Find the Switch header implementation entry and select it KDevelop will look up the corresponding header or implementation file and open it in another editor window In our example if you did right click into the hello cpp source the hello h file will be displayed and the cursor positioned there There is even more If you do right click inside the text of a class implementa tion KDevelop will position the cursor on the corresponding declaration line in the header file And vice versa right clicking on a declaration line will bring you to the corresponding class implementation If the editor window with the file to be switched to already exists KDevelop will of course activate this one and reposition the cursor there if necessary 2 4 2 How to Access Declarations and Definitions But what if you are working on a source file and want to look up the declaration or definition of an identifier you just found there Well this is equally easily accomplished Basically all you need to do is to right click on the identifier in question There are two different cases to consider however namely Accessing externally defined identifiers and dealing with project i
155. itory Prepares the marked file for addition to the repository The file is transferred to the repository when you commit it or the containing directory the next time Remove from Repository Prepares a file for removal from the repository This also deletes the file on the local file system so use this feature with care Update Runs cvs update to merge any changes from other users into your working directory When you use this menu item over a directory the update normally happens recursively except if you have disabled this in the configuration file cvsrc Commit Runs cvs commit to upload any locally made changes to the repos itory Note that you should update before doing this Otherwise when another user has committed his own changes before CVS may give you an error message All these commands are invoked as subprocesses by KDevelop without any further command line options or environment variables This may be a prob lem when the connection with the CVS server goes through a ssh connection and requires that you enter your password each time you commit or update This is for instance necessary when your project is hosted on sourceforge net Workarounds for this problem are described on the CVS SSH FAQ which you can find in the SourceForge documentation 13 3 Behind the Scenes 13 3 1 What CVS Records in the Working Directory to be written 154 KDevelop User Manual Chapter 14 Credits 14 1 Contributions
156. ity and control of the custom project manager you should consider Automake Manager or one of the other project managers because they considerably ease the program building and distribution processes 3 3 6 How to Distribute Your Application The distribution of your applications does not require the end user to have anything different installed other than e an appropriate compiler e a linker and e the appropriate development libraries which at least for C applications is most often the case But you can as well distribute binary packages of your application In either way the end user of your product does not need KDevelop installed For giving away your sources we advise to include the project file of KDe velop as well This makes it very easy for other developers if they use KDe velop to work with your sources For projects where several developers maybe working on different places are involved this should be the case anyway So you can ensure consistency of the Makefiles to not run into trouble Especially on multi language applications translators won t actually work with the source code except in cases that require correction for enabling translation support 63 KDevelop User Manual Chapter 4 Configuring KDevelop Bernd Pol KDevelop is a very powerful and flexible IDE which offers many ways to tailor it to your needs To start configuration select Settings Configure KDevelop This will cause th
157. ject Before we can use this on our Hello example project we must however first generate a suitable index This is done by the CTags tool view at the bottom of the workspace area When you click the CTags tab a dialog window will open where you will find the following key in the lower right corner No CTags database found Regenerate ns 3 Breakpoints CTags Problems Build a CTags index with the Regenerate key Press the Regenerate button and wait a few seconds Then the No CTags Database Found will be replaced by the current date Now you are ready to perform some identifier look ups in your project source TIP The date next to the Regenerate button is there to remind you of possibly too old indexes Whenever you are obviously not able to look up some identifier in your project consider regenerating the index On large projects this might take consid erable time but you should make it a habit to regenerate the index regularly after extensive source file changes To look up an identifier in your project sources there are several possibilities e Use the CTags tool view This is easy Just start typing the identifier name you are interested in into the Lookup input field in the bottom left KDevelop will try to complete the word you have typed so far and show all occurrences of those identifiers which start with this character sequence 26 KDevelop User Manual If for example you want to know wherever th
158. k Ctrl B Add current selection to your bookmarks Bookmarks Clear All Bookmarks Clear All Bookmarks G 1 8 The Window Menu Window Close Selected Windows Alt W Close Selected Windows Window Close Ctrl F4 Close Window Close All Close All Window Close All Others Close All Others 200 KDevelop User Manual G 1 9 The Tools Menu Tools Read Only Mode Read Only Mode Tools Filetype Mode Filetype Mode Tools Highlight Mode Highlight Mode Tools End of Line End of Line Tools Spelling Spelling Tools Indent Ctrl I Indent Tools unindent Ctrl Shift I unindent Tools Clean Indentation Clean Indentation Tools Align Ctrl Tab Align Tools Comment Ctrl D Comment Tools Uncomment Ctrl Shift D Uncomment Tools Uppercase Ctrl U Uppercase Tools Lowercase Ctrl Shift U Lowercase Tools Capitalize Alt Ctrl U Capitalize Tools Join Lines Ctrl J Join Lines Tools Word Wrap Document Word Wrap Document Tools Difference Viewer Difference Viewer Tools Execute Command Execute Command Tools Filter Selection Through Command Filters selection through exter nal command using the Filter plugin Tools Debug Regular Expression Debug Regular Expression Tools Part Explorer Part Explorer Tools Quick Open Class Alt Ctrl C Quick Open Class Tools Quick Open Method Alt Ctrl M Quick Open Met
159. kefile am e Es templates Voopoopoopooopdoopeopgoper 3 include qlabel h o F Data in shelldesktop include kmainwindow h Ex hello desktop include lt klocale h gt E Data in shellrc Jhelloui re TI AUTHORS Hello Hello E KMainWindow O Hello E Header in noinst E f hello h configure in in set the shell s ui resource file COPYING setXMLFile helloui rc 5 LAUDE REMO hello cpp T Doxyfile new QLabel Hello World this hello label Z main cpp 4 H 5 hello kdevelop EKDE Icon data INSTALL Hello Hello SI Makefile am t Makefile cvs J o lo cvs p J 5 3 n E a 5 E T 1 5 E x o9 m x a m o 1 o a 2 o E A 3 E m S 5 gt amp v o E a a a Application Diff 9 Messages Find in Files 4 Replace i Konsole 4 Valgrind Security Problems 3 Breakpoints CTags 69 Problems Line 1 Col 1 INS NORM Initial files in our Hello World project To demonstrate the main bunch of files the Application Wizard produced we did open most of the directory branches in the left hand File Tree tool view window Just click the branch names in the tree to see for yourself Additionally just for demonstration we did as well open most of the branches the Automake Manager tool view window to the right where some of t
160. lass named ASimpleTest you will see the fol lowing lines in the asimpletest cpp file file asimpletest cpp brief put some short descripion here You will still have to provide the short description after the brief key word but part of the job is automatically done for you The License Text File As another example you could include an explicit hint to the license text you want to use into the template Use the LICENSEF ILES variable for this and add for example this line Hp See SLICENSEFILES for the full license text The Application Wizard will replace the SLICENSEFILES with the name of the file where the full license text is to be found namely See COPYING for the full license text for the GPL license or See LICENSE BSD for the full license text if you decided to put your application under the BSD license Thee are of course more variables KDevelop knows of See the Editing the templates section in the Editing tools chapter for what is possible 117 KDevelop User Manual NOTE The templates you define here will come in effect only after the Application Wizard has created the new project You will find this information on top of the files you created yourself in the development process When creating the initial files the Application Wizard will use some predefined standard templates You will have to manually adapt those initial fi
161. late info xml contains descriptions of the available file types to be displayed in the New File tool view 176 KDevelop User Manual kdevfilter provides the Execute Command and Filter Selection Through Command entries in the Tools menu used by the Shell Filtering and Insertion plugin kdevfullscreen provides the Full Screen Mode entry in the View menu and the according tool bar icon kdevgrepview provides the Find in Files entry in the Edit menu used by the Grep Frontend plugin kdevhistory provides the Back and Forward entries in the View menu kdevjavadebugger provides a Java Debug menu in order to debug a Java application kdevoutputviews provides the Next Error and Previous Error entries in the View menu kdevpartexplorer provides the Part Explorer entry in the Tools menu used by the Part Explorer Tool plugin kdevquickopen provides the Quick Open File entry in the File menu and the Quick Open Class and Quick Open Method entries in the Tools menu used by the Quick Open project plugin kdevregexptest provides the Debug Regular Expression entry in the Tools menu used by the Regular Expression Tester plugin kdevreplace provides the Find Select Replace entry in the Edit menu used by the Replace Part plugin kdevtipofday provides the Tip of the Day entry in the Help menu as well as a HTML File containing the available tips kdevtools controls v
162. layed if any at all however depends on the template initially selected in the Application Wizard Do not forget to initially check what the Application Wizard has provided For example you may want to change the initial heading informations according to your own templates Usually you will find these in a templates subdirectory in your project directory Some simple copy operations will mostly suffice Then it is advisable that you compile the initial project before you attempt to change any code In most cases this initial compilation should be possible Thus you can make up whether the project really was set up according to your needs If it was not simply remove the project directory in your local CVS root as well if you use one and start over again 118 KDevelop User Manual WARNING Before you compile your new project the first time have a look at Project Build Configuration If there are three selections displayed default optimized and de bug with debug selected by all means stick to this or use optimized instead Due to some limitations in the current autoconf automake setup you should by no means build in the default configuration This will corrupt some internal directory settings thus making configure complain when you try to use it in the optimized or debug build configuration afterwards This applies to these multiselection capabilities only If the application type you selected provides a default
163. lect the Split Horizontal entry This will split the current workspace area in 31 KDevelop User Manual the middle and move the tabbed editor window holding the hello h file into the lower part hella cpp Jo rococo EEEE ST Copyright C 200 joeguser com a cw A MERCHA a rmi GNU Ga 3 File List fa File Selector The workspace has been split horizontally Note the dotted separator line between both windows You can grab it with the mouse and adjust the heights of the editor windows according to your needs There are a few points to note e The split workspace areas are fully functional at their own This means new tabbed windows will open in the workspace which contains the currently active editor window And you can split any sub area again to your wish thus keeping as much windows open simultaneously as you need e Any split will move the currently active editor window into the new workspace sub area either downward or to the right The other tabbed windows all re main where they were You cannot directly move tabbed windows between split areas instead you need to explicitly close the window in one workspace area and reopen it in another to regroup e Also there is no direct way to close a split area again It closes automatically once the last tabbed window in it was closed 2 4 3 4 Edit C Source and Header Files Simultaneously There is a neat application of the above mentioned worksp
164. les to your needs 5 1 4 Build the Initial Project Files Almost everything is done now On the last templates page the Next gt button will have changed to read Finish now Think twice before you click on it You still have the option to revise everything by repeatedly using the lt Back button As the Application Wizard remembers all information you did input so far it may be advisable for you to take the time and look back once again In case you use local CVS do not forget to double check the CVS repository name there should be no subdirectory with that name in the CVS root directory already if it does try another repository name If ever you don t want the new project be built abort the Create New Project dialog by the Cancel button Otherwise click Finish and watch in the Messages window how the Application Wizard initiates the project If you want to use a versioning system CVS there will be two runs actually Application Wizard will first build the project directories and files and then call up the CVS program which restarts the Messages window with its own con tents If any error occurs in either of these runs the process will stop showing you an according error message in the window NOTE In many cases when your new project has been set up this way KDevelop will automatically load the source file s of one or more basically important modules so you can readily start work Which source modules will be disp
165. library setenv LD LIBRARY PATH SQTDIR lib SKDEDIR lib LD LIBRARY PATH setenv LIBRARY PATH QTDIR lib SKDEDIR lib LIBRARY PATH setenv PATH QTDIR bin SKDEDIR bin S PATH A 3 2 Compile KDevelop NOTE In the following discussion we assume that you have put your KDevelop sources in the kde3src kdevelop directory 160 KDevelop User Manual A 3 2 1 Special svn Compilation Considerations In case you use a KDevelop snapshot from svn the initial compilation steps de pend on whether you just did a complete checkout or only updated the source After a svn Checkout You must initialize the make system after a fresh checkout The same is true every time you need to start over from scratch Type kde3src kdevelop gt make f admin Makefile common svn clean and then all of the following steps NOTE You might need access to the svn repository for the clean up if any corrupted or missing files must be reconstructed IMPORTANT The svn clean command will remove every file not in svn from the directory Make sure to back up any valuable information before you issue this clean up command After a svn Update The next step depends on the output of the svn update sequence If you got something like there may be a U or a P marker in the leftmost column both denoting the file has been changed U some directory path Makefile am or if you just did a full checkout you must enter kde3src kde
166. lication and one compiled for your development system For this it is advantageous to use KDevelop capability of creating multiple build configurations as explained in Section 11 1 Once you have created a new build configuration for cross compiling in the Project Project Options dialog add the option host platform to the configure options The p1atformname is a tuple of the form cpu vendor os or 148 KDevelop User Manual cpu vendor kernel os For many combinations you can use a short form for instance i386 linux or arm elf 11 3 Ot Embedded Qt embedded is a version of the QtIM library that does not use the X win dow system but draws directly to the framebuffer on Linux systems It is therefore interesting for embedded systems which have tight restrictions on the memory usage of the whole system Its API is fully compatible with the one of the X11 version Developing an application for Qt embedded with KDevelop is not very differ ent from developing a program for the X11 version of Qt In fact you can use the same codebase for both versions If you use the autoproject project man agement you switch to the embedded version by passing the argument en able embedded to the configure script You can set this in the Project Project Options dialog under Configure Options With the option with qt dir DIR you set the directory in which Qt embedded is installed After conf
167. lop which lets you navigate through class dependencies and allows you to easily create and access the classes and methods you need Documentation Shows how to access the rich built in documentation KDe velop provides and tells you how to create documentation of your project concise and powerful API documentation providing you an overall view of all your project sources as well as docbook based user documentation KDevelop User Manual Building and Project Management Deals with the creation and management of your project describing the basics of autoconf and automake as well as how to set up custom make files and how to use compiler or make options to tailor your application to suit your needs Advanced Build Management Looks at ways to keep multiple build configu rations to cross compile for diverse platforms or to make an embedded system using the Ot embedded library The Debugger Interface Describes how to use the integrated gdb debugger interface so you can hunt down bugs without leaving KDevelop Using CVS Tells you how you can maintain your project using the CVS ver sioning system a must especially if many developers work on the same project Some commonly used information has been put into the appendix Amongst others this consists of Installing KDevelop Tells you where to obtain KDevelop and how to get it up and running In a Nutshell Tips and Tricks A quick reference to commonly used com mands and actions And
168. lopers who enjoy the flexibility and feel of Qt s qmake system KDe velop offers the ability to handle qmake based projects pro files within the GUI For more information on the QMake project manager see the qmake User Guide which should be included in your distribution or have a look at the TROLLTECH Documentation home page where you may find the QMake doc umentation of your Qt C GUI Application Development Toolkit version 3 3 3 CMake Projects CMake will be the KDE build system for KDE 4 and KDevelop already pro vides you some CMake based templates in C and C You only need the cmake program in your PATH to build them To set up a new C or C project in KDevelop select Project New Project C or C CMake based projects A shared library template or Hello world program 62 KDevelop User Manual 3 3 4 ANT Projects Java Projects Java developers may want to use the Apache ANT project manager for their projects To set up a new Ant project in KDevelop select Project New Project Java Ant Project Application For more information see The Apache Ant Project home page 3 3 5 Custom Projects If you prefer to maintain your own Makefiles for your project you may use the custom project option of KDevelop This may be feasible in unusually struc tured projects or if you want to retain full control over the make process Yet if you do not really need the extra flexibil
169. lopers work on the same piece of code resulting in a conflicting set of changes in practice this occurs seldom and is often a sign of a lack of communication In this case CVS rejects a commit only after all conflicts are resolved a file can be committed So far this has been a description of the basic features of CVS one usually has to cope with But CVS can provide a lot more One can maintain several branches of a project e g KDE 1 1 2 and KDE 2 were branches in KDE s development tree merge changes from one branch to another ask for differences between revisions the revision history of files etc CVS is implemented as a client server system As a user all communication with the repository goes through the command line program CVS A higher level user interface is available through frontends like Cervisia http cervisia sf net or TkCVS http tkcvs sf net In KDevelop only a small part of the CVS functionality which is important for your daily work can be used di rectly Basic knowledge of CVS usage is assumed In particular you should know how to checkout a given project from the repository We recommend the book Open Source Development With CVS by Karl Fogel which is freely distributed except for the non technical chapters See nttp cvsbook red bean com cvsbook html 153 KDevelop User Manual 13 2 CVS Commands in KDevelop In the file views the following context menu items are available Add to Repos
170. lts will be stored in several subdirectories of the SKDEDIR share apps installation directory There are quite a lot of default configuration subdirectories in KDEDIR share apps whose names all start with a kdev sequence Most of them are for KDevelop internal use only They might be deliberately grouped for readability as Stand alone Applications Task Specific Parts Project Generation Parts Language Specific Parts e STAND ALONE APPLICATIONS kdevelop contains files to configure the KDevelop IDE licenses contains various licenses texts pics contains the picture files used for the KDevelop KDevelop Assistant and KDevelop Designer splash screens profiles contains default plugin profile settings Currently there is only a tiny profile provided which defines a minimum set of active KDevelop plugins eventsrc holds a lot of Process successful localization strings kdevelopui rc provides the basic menu and tool bar entries KDe velop uses kdevhtml partui rc provides a Print entry in the File menu a Copy entry in the Edit menu and Back and Forward arrows in the Browser Toolbar in case a HTML file is browsed from the Documen tation plugin kdevassistant provides the menu and tool bars of the stand alone KDevelop Assistant documentation browser kdevdesigner and kdevdesignerpart provide menu bar and tool bars of the stand alone KDevelop us
171. mand entries in the Tools menu used by the Shell Filtering and Inser tion plugin e kdevfullscreen provides the Full Screen Mode entry in the View menu and the according tool bar icon e kdevgrepview provides the Find in Files entry in the Edit menu used by the Grep Frontend plugin e kdevoutputviews provides the Next Error and Previous Error entries in the View menu e kdevpartexplorer provides the Part Explorer entry in the Tools menu used by the Part Explorer Tool plugin e kdevquickopen provides the Quick Open File entry in the File menu and the Quick Open Class and Quick Open Method entries in the Tools menu used by the Quick Open project plugin e kdevregexptest provides the Debug Regular Expression entry in the Tools menu used by the Regular Expression Tester plugin kdevreplace provides the Find Select Replace entry in the Edit menu used by the Replace Part plugin kdevtipofday provides the Tip of the Day entry in the Help menu The HTML File containing the available tips is provided as a default configura tion file only kdevtools controls various menu entries ceated by Tools Menu and Ex ternal Tools Menu settings provided by the Tools Menu Addition plugin kdevvalgrind provides the Valgrind Memory Leak Check and Profile with KCachegrind entries in the Debug menu used by the Valgrind Frontend plugin D 2 2 Resource Configuration Files There are two
172. matically split the workspace and open this header file editor window just beneath the hello cpp window There is even more as we mentioned already In the hello cpp editor find e g this constructor definition line Hello Hello and put the cursor there Then look at the hello h window below and note how KDevelop did navigate to the corresponding default constructor declara tion line 33 KDevelop User Manual hello cpp include kmainwindow h include lt klocale h Hella Hellol KMainWindowi OG Hello L 1 Default Constructor x Hellol KDevelop automatically navigated to the constructor declaration This works vice versa as well Whenever you put the cursor somewhere into a construct in one editor window KDevelop will navigate to the corresponding construct in the other 24 3 5 Grouping Source Files Into Development Sessions When your project grows larger and the development tasks become more and more complex and force you to often switch between different even distinct sets of files it is about time to organize your development work into distinct sessions The File List tool view of KDevelop allows you do to just this On top of the File List tool view window there is a tool bar where you can create save select and remove such sessions Or alternatively use the View View Sessions sub menu We will illustrate this facility again with our Hello example project As
173. mongst others Navigation History Switch back and forth through the documents etc you visited KDevelop User Manual Error Tracking Navigate to the source lines of the errors encountered in the most recent compilation build process Editor Related Actions Some entries in the View menu control the look and view of the editor you use In case of the Kate Part Embedded Ad vanced Text Editor there will be the following controls available e Control the word wrap behavior in the document window e Show or hide several border displays in the document windows line numbers icons and additionally bookmark marks in the scroll bar e Control the display of folded temporarily hidden sections in a source text Project All work of KDevelop is based on projects which basically collect source files build management files and other information in one project direc tory In this menu you control which project to use which properties it has and some other managing actions In particular Open a Project Allows to create new projects open existing ones and import projects from other environments Project Options Allows to define a whole bunch of different project prop erties Classes Management Add new classes to the project and traverse the inheritance tree of a class Distribute Project Helps to build distribution packages of the project Build This menu is all about compiling and documenting the project Thus it is of use only
174. mpiler command CXX e 4 x Select the compiler and its working environment KDevelop shall use here This is what you can set up from here C compiler Select the C compiler KDevelop should regularly use from this combo box It however lists only those compilers KDevelop really knows of e Compiler command CXX Only for experts This is only needed if the C compiler is not standard Put the name by which it is called here Compiler flags CXXFLAGS Here you can enter any extra option KDevelop shall pass via the Makefile to the compiler Some option values will be pre set according to the build configuration selected in the Configuration combo box Note that many common compiler options can be selected from a dialog which will pop up when you press the button to the right of the text box 50 KDevelop User Manual 13 GNU C Compiler Options KDevelop General i Warnings safe Warnings unsafe Optimization Level Default No optimization Level 1 Level 2 ffloat store fforce addr fforce mem fno default inline fno defer pop no inline Li Li Li Li Li Li Li omit frame pointer Use this dialog to define the GNU C compiler behavior We deliberately selected the Optimization tab here Note how the No Opti mization option has been preselected according to the 00 option preset in the debug build configuration
175. n page You may want to increase this value to account for wider pa per e g if you use landscape printing for your sources Or decrease the value accordingly to take larger margin settings of your print outs into account Minimum in conditional Conditionals or source following e g an as signment operator should usually get an extra indent on continua tion lines in order to keep the text readable The amount of this extra indent is defined here The default is set to Twice current which means that continued con ditionals will get an extra indent level of the standard indentation size you selected in the Filling group You may change this extra indent to another fixed width including zero using the arrows or by entering the value directly 81 KDevelop User Manual 4 1 9 3 Other Formatting Setup Formatting General Indentation Other Brackets Break C Attach C Linux style Padding Add spaces around parentheses _ Add spaces around operators One Liners Keep one line statements Keep one line blocks Other source format style settings Controlling the position of braces The radio buttons the somewhat misnamed Brackets group control the position of block delimiting braces in a C C source text There are three possibilities from which you can select Break This inserts a line break before each opening brace Both delimit ing braces
176. nclude a Show Menubar icon in a suiting toolbar e g the Browse Toolbar for that purpose To un hide the menubar you must press Ctrl M or use the Show Menubar icon if available 3 2 Elements of the User Interface to be written 3 2 1 The Workarea to be written 3 2 2 The KDevelop Titlebar to be written 3 23 TheKDevelop Statusbar to be written 3 2 4 The menubar to be written 3 2 5 The Toolbars to be written 3 2 6 The Tree Tool Views to be written 61 KDevelop User Manual 3 2 7 The Output Tool Views to be written 3 3 Project Management Systems Globally a project will rely on some form of project management system KDe velop offers four project management systems the programmer can select from when creating a new project e Automake projects use the GNU standard development tools e OMake projects use the trolltech OMake project manager e ANT projects use the Apache ANT project manager for Java development e Custom projects require you to maintain your own Makefiles 3 3 1 Automake Projects Projects created with KDevelop s Automake Manager make it very easy for developers to use the GNU standard development tools They provide e a better way of Makefile generation and e a good and safe way for fast adaption towards different systems by autoconf generated configure scripts 3 3 2 QMake Projects For deve
177. nd Ben Elliston GNU Autoconf 4 Richard M Stallman Using the GNU Compiler Collection 5 5 Gordon Matzigkeit Alexandre Oliva Thomas Tanner and Gary V Vaughan GNU Libtool 6 Gary V Vaughan Ben Elliston Tom Tromey and Ian Lance Taylor GNU Autoconf Automake and Libtool 1st edition Octo ber 2000 New Riders Publishing ISBN 1578701902 7 W Richard Stevens Advanced Programming in the UNIX En vironment 1st edition June 1992 Addison Wesley Pub Co ISBN 0201563177 8 Bruce Eckel Thinking in C Volume 1 Introduction to Stan dard C 2nd Edition April 15 2000 Prentice Hall ISBN 0139798099 9 Karl Fogel and Moshe Bar Open Source Development with CVS 2nd Edition October 12 2001 The Coriolis Group ISBN 158880173X 10 Rasmus Lerdorf and Kevin Tatroe Programming PHP 1st edi tion March 2002 O Reilly amp Associates ISBN 1565926102 205 KDevelop User Manual 11 Mark Lutz Programming Python 2nd Edition March 2001 O Reilly amp Associates ISBN 0596000855 12 Boudewijn Rempt Gui Programming With Python Using the Qt Toolkit Bk amp Cd r edition January 2002 Opendocs Llc ISBN 0970033044 13 Larry Wall Tom Christiansen and Jon Orwant Programming Perl The Camel book 3rd Edition July 2000 O Reilly amp Asso ciates ISBN 0596000278 14 Randal L Schwartz and Tom Phoenix Learning Perl The Lama book 3rd Edition July 15 2001 O Reilly amp Associates ISB
178. ndow lists the values of all local variables at the current ex ecution point of the program It covers the variables in the complete call stack ie the function where the process was interrupted the function that called this function and so on up to main function 150 KDevelop User Manual Another branch in the variables contains watch variables You can con figure yourself which variables are shown here Both local and global variables can be watched You can add variables either by clicking on the Add button or pressing Return while the Watch item is selected They can be removed again via the context menu Frame Stack to be written Breakpoints This window allows you to see and manipulate the breakpoints Remember that KDevelop uses GDB so to fully understand the KDe velop debugging features you should know a little bit about the GDB If you want to look at the source code breakpoints are defined in kdeve lop languages cpp debugger breakpoint h At the left edge the window has buttons to e Add an empty breakpoint e Edit the selected breakpoint e Delete the selected breakpoint e Remove all breakpoints The main part of the window is a table with 7 columns Each line in the table is a breakpoint The columns are 1 Selection checkbox 2 Type one of Invalid File Line Watchpoint Address Function 3 Status Values are e Active e Disabled Each breakpoint may be enabled or disabled if
179. ng on the documentation type to be maintained Documentation List Structure Every documentation setup page shows the listed documentation items in a table with four columns 92 KDevelop User Manual TOC If this check box is marked this documentation item will show up on the Contents page of the KDevelop Documentation facility NOTE Unchecking the TOC check box will in turn disable the Index and Search check boxes see below Thus you cannot have documentation collec tion items indexed but not shown in the contents Index If this check box is marked an internal index will be built of this documentation item This provides fast access to the documenta tion by the use of the Index and optionally Finder pages of the KDevelop Documentation facility NOTE The internal index will be built the first time the user selects the Index page This will delay the first access noticeably because the index will be read from disk and then cached All subsequent indexed searches will however use this chache and thus work significally faster Search If this check box is marked the contents of this documentation item will be included in the full text search path of the Search page of the KDevelop Documentation facility NOTE KDevelop utilizes the htdig application collection to perform full text searches This search is done over an internal index the htdig ma chinery has to build before it can be used Any c
180. ng to your individual needs 173 KDevelop User Manual Appendix D Configuration Files Used by KDevelop KDevelop uses a series of configuration files which are distributed amongst several directories There are two main groups of configuration files to distin guish KDevelop Default Configuration files set up when KDevelop was installed User Oriented Configuration files which contain user modifications of the defaults as well as settings ma D 1 KDevelop Default Configuration On installation KDevelop writes some default information files for setup and configuration purposes into subdirectories of the KDEDIR installation directory usually something like opt kde usr local kde or some other user defined installation directory see Installing KDevelop D 1 1 Default KDevelop Configuration There is only one KDevelop specific default configuration file in the KDEDI R share config directory kdeveloprc This file contains the basic settings KDevelop needs to start It will be copied to the user s KDEHOME share config directory when KDe velop does not find a kdeveloprc file there on startup 174 KDevelop User Manual D 1 2 Application Specific Defaults Most KDevelop features are provided by KParts These are basically applica tions specially designed to run in the KDevelop framework see the overview in the Plugin Tools appendix Each KPart application has its own set of con figuration files whose defau
181. ns the UI definition needed to develop Pas cal applications kdevperlsupport provides Project and Help menu entries needed to develop Perl scripts kdevphpsupport contains UI and PHP function definition files needed to develop PHP scripts kdevpythonsupport provides Build and Help menu entries and ac cording tool bar icons needed to develop Python scripts kdevrubysupport provides Build menu entries and according tool bar icons needed to develop Ruby scripts kdevscriptproject provides th UI definitions needed to develop cus tom projects Currently version 3 1 0 unused kdevsqlsupport provides th UI definitions needed to develop SOL projects Currently version 3 1 0 unused 178 KDevelop User Manual D 2 User Oriented Configuration All information about user defined settings is kept in two subdirectories of K DEHOME namely Application Specific Configuration in the KDEHOME share apps directory and Resource Configuration File in the KDEHOME share config directory D 2 1 Application Specific Configuration Any user changes to the KDevelop Default Configuration settings as well as user specific settings which are not kept in any of the Resource Configuration rue are found in kdev subdirectories of the KDEHOME share apps direc ory Most of these configuration files are however used by various KDevelop plug ins in order to provide some specific menu and or
182. nternal text items 24 KDevelop User Manual 2 44 21 External Declarations and Definitions In a most common case you want to look up an identifier which was defined ex ternally to your project In KDE projects such identifiers are most likely docu mented in various KDE or Qt libraries If KDE and KDevelop were properly installed KDevelop will be able to access such so called API documentation and be able to search it for identifiers of this kind Let us look at an example In the he11o cpp editor window find the following lines Hello Hello KMainWindow 0 Hello Right click on KMainWindow A menu will pop up There select the Search in Documentation KMainWindow entry and release the mouse button Now the Documentation tool view will open showing the KMainWindow entry as search item on the Search sub page And a short while after another editor window will open in the workspace area showing the KDE API Reference page of the KMainWindow class This all will look like the following We deliberately opened the Documenta tion Search page already to illustrate the result of the menu selection hello cpp helloh Z Contents M P NER RM NS e rome Index Copyright C 2006 by Joe User 7 35 Paste Ctrl V Select All Ctrl A Score GN Bookmarks sjeddius epo uonejueuunooqg t a Split Horizontal zo _ Split Vertical Find Documentation KMainWindow kdeui
183. o eu saveSettings S DocumentationPa return true Bp EditorProxy S Generalinfowidget f HistoryEntry kKMainwindow MainWwindow main H 9 LangPluginitem B LanguageSelectw z Mainwindow return this void mainwindow createstatusBar duc usa l 18 X void new StatusBar this i B OT x d sa jl l utomake Manager afl Rx void MainWindow createFramework PartController createInstance this setMenuForSDIModeSysButtons menuBar i i i i i i i i i i i i i i Jplugincontroller cpp H i Postprocessing M Buck v Creating date time stamp E partcontroller cpp Finished C Jmainwindowshar Don t forget to run configure if you haven t done so in a while run configure help 9 e Success Jmain cpp ry D languageselectwi KDevelop toplevel windows mode Click here to return to the modes overview 195 KDevelop User Manual Appendix G Command Reference Volker Paul 2005 04 03 NOTE The shortcut key combinations shown in this chapter are the default ones They can be changed G 1 The Menubar Note that some menu entries only appear when they are applicable Especially some entries are linked to plugin functionality which is only available when the plugin is enabled G 1 1 The File Menu
184. o the Messages window of KDevelop when the project is created in the final setup step If anything was in error with CVS you will in most cases see an error message like this cd home devel test amp amp cvs d home devel mycvsroot import m new project vendor start amp amp sh opt kde3 share apps kdevcvs buildcvs sh home devel mycvsroot cvs import aborted home devel mycvsroot CVSROOT No such file or directory ere seed with status 1 x If this happens you will have to either manually set up CVS KDevelop should have successfully initialized your project files at this time or delete the project directory and start over again with New Project from the Project menu After you have entered all CVS related information click the Next gt to go on NOTE If you want to correct an error on the previous Create New Project page just press the lt Back button The Application Wizard will remember your settings on the current page so you can easily proceed when you come back 5 1 3 Supply Header Source Templates The next step brings you to a series of pages where you can set up common information you want to include in your source and header files if the task at hand allows Both header and source templates are provided for C and C applications each on its own page For other languages there may be source templates only And in some cases you will
185. oduce source code file structures that can be compiled built and installed on any UNIX or Linux system by using the simple commands configure make make install Usually as root and can be uninstalled by the command make uninstall usually as root How does this work Well configure is a script that e works out the details of whatever system it is in such as what compiler and libraries to use and where they are located and then e creates recursive Makefile files by filling in the substitutions in the corre sponding Makefile in files The Makefile in are input files templates which provide basic information for the Makefiles to be produced from them by filling in some system depen dent information They are generated by the Automake utility from the Make file am files The process of going from Makefile am am denotes Automake template files to Makefile files is handled automatically by the KDevelop Project Man ager using the Autoconf utility M4 macros and other arcana we need not go into here So when make runs it automatically picks up the correct pieces from the cur rent environment such as compilers and libraries Similarly make install puts your application components such as executables documentation and data files in the correct places for that environment If you distribute your application as a tarball a single compressed file that KDevelop can create for you it will
186. oject Additionally this Persistant Code Store keeps information use by the Code Completion facility of KDevelop 183 KDevelop User Manual NOTE There can be additional Persistant Code Store files be set up on the Code Completion tab of the C Specific project configuration page In formation about these additional pcs is kept globally in the SKDEHOM E share apps kdevcppsupport pcs directory 184 KDevelop User Manual Appendix E Plugin Tools KDevelop contains a large number of little tools that help you to perform cer tain task Most of them are realized as plugins That means if you do not need a plugin you can disable it That also means if you are looking for a functionality that should be there and isn t then maybe it s implemented in a plugin and that plugin is disabled For example in the file menu there is a Quick Open feature but only if it s enabled in the Project Project Options dialog Technically plugins are based on the KDevPlugin class defined in lib inter faces kdevplugin h The following is taken from a comment from there KDevPlugin is the base class for all KDevelop plugins A plugin is a compo nent which is loaded into KDevelop shell at startup or by request A plugin has a scope that can be either e Core e Global e Project Core plugins are global plugins which offer some important core functional ity and thus are not selectable by user in plugin configuration p
187. ommand consi E BP checkAndFixToolVi void new StatusBar this EDITUM L C clearWindowMenu createActions void Mainwindow createFramework Tplugincontroller cpp gt partselectwidget cpp Et partcontroller cpp i PartController createInstance this Jmainwindowshare cpp i setMenuForSDIModeSysButtons menuBar i xad GP createStatusBar rw E L i cf embedOutputView t main cpp i Td embedeara g languageselectwidget eid This Zaeneralinfowidaetbase R RI Messages Jill Application Difference Viewer Mcs Valgrind Subversion S Grep S CvsService Q Replace Konsole M t v Postprocessing Makefile templates Creating date time stamp w Finished Don t forget to run configure ey you haven t done so in a while run configure help O Success Configure KDevelop Line KDevelop tabbed pages mode Click here to return to the modes overview F4 Toplevel Windows Mode Click here to return to the modes overview 194 353 Col 0 INS NORM KDevelop User Manual Eile Edit View Project Build Debug Bookmarks Window Tools Settings Help mQoladgoe RRBSBBAQL O O amp al Namespace yel eee S Vall m Configure KDevelop A Tile HOMe APVE RAPS STG RUPVEIOp sic Main luc
188. onfigure File Templates 4 14 Selecting an Editor KDevelop allows you to select your favorite text editor tool Mark the Editor entry in the left hand side selections tree of the Configure KDevelop window The following dialog will be displayed to the right 75 New Type New Subtype Edit Type Remove Type Edit Template Move Up Move Down X Use side tab KDevelop User Manual r Embedded Editor Embedded Advanced Text Editor Embedded Advanced Text Editor Qt Designer Based Text Editor Select an editor To select a new editor click on the arrow on the drop down list field Depend ing on the editor parts interfaces your KDE version has compiled in you will be provided with a list of editors you may select from see the Important note below for this Click on the editor of your liking and click OK Currently there are two possibilities Embedded Advanced Text Editor This is the KDE standard Kate editor part Qt Designer Based Text Editor This is the editor Qt provides in its Designer component These editor interfaces are fully integrated in the KDevelop IDE concept Par ticularly the possibility to jump to the offending source code line by just click ing on an error message in the Messages Output View window has been pro vided NOTE Changing the editor will not effect already open files There are two possibilities to proceed Either close all open text windows and r
189. ont of current development anonymous svn repository snapshots are available 156 KDevelop User Manual The module name is kdevelop at svn co svn anonsvn kde org home kde b ranches KDE 3 5 kdevelop A 1 1 1 Initial svn Checkout To obtain an initial version of KDevelop you must download it from anony mous svn For this so called checkout operation follow these steps NOTE We assume you want to put your KDevelop copy into the kde3src subdirectory of your home directory Create the destination directory if necessary gt mkdir kde3src gt cd kde3src kde3src svn co svn anonsvn kde org home kde branches KDE 3 5 kdevelop kde3src cd kdevelop NOTE Once you have successfully checked out your KDevelop version you may keep up with the changes using the update procedure shown in the next section IMPORTANT Keep the server load low Please do not checkout every time you want to keep your KDevelop up to date Use svn update for this purpose Now you may compile your KDevelop version as shown in the KDevelop Compilation and Installation section A 1 1 2 Keeping Your svn Copy up to Date After you checked out and successfully compiled KDevelop from svn as shown above you ll want to keep it up to date in order to get all the patches Follow these steps We again assume you have put your KDevelop copy into the kd e3src directory Note the up update command instead of the co whi
190. ontrol Center If these defaults in the Create New Project Author and Email fields do not suit you may want to have a look at your mail configuration in the KDE Control Center 2 The Application Wizard will integrate this information into the starting program templates if applicable In KDE C programs for instance you will find it near the beginning of the main cpp source file 3 Of all fields the Email is optional reflecting the fact that not every developer may have access to the internet You may keep this field empty if you wish and proceed nevertheless 110 KDevelop User Manual Version and License Info Finally enter a starting version number for your new application in the Version field and select the license under which you want your application be put from the License tab If you select an application type for which the Application Wizard provides common source template texts e g C C you may view the license notifi cation text on the third page of this Create New Project dialog see the Supply header source templates chapter below If you selected Custom from the License tab you must provide a license text on your own NOTE Both version and license information will as well be integrated into the starting tem plates in a suiting format the application type you selected does provide Once you have correctly entered all this information stuff press the Next gt button to proceed as sho
191. or hides the subprojects at the next level down if any If you do it with a target in the detail view it shows or hides the list of files that go into that target Opening a file for Edit If you left mouse button click on a file name in the detail view the corresponding file opens up in KDevelop s editing window Activating the Automake Manager Toolbar Buttons If you left mouse button click on the name of a subproject in the overall view or target in the detail view the name is highlighted and some toolbar buttons become active in the top part of that view NOTE It is recommended that you use the right mouse button and popup menus rather than the toolbar buttons because it is then much easier to see and understand what you are doing Operations on subprojects and targets have far reaching effects on the struc ture compilation building and installation of your application Selecting Actions Popup Menus If you right mouse button click on the name of a subproject target or file a menu pops up and you can then select actions to perform on the subproject target or file such as add a target to the subproject add a file to a target or logically remove the selected file from its target 140 KDevelop User Manual 10 2 5 Popup Menus in the Automake Manager The following sections explain in short terms which operations the menus make available which will pop up on right mouse button clicks in the Au tomake Manager win
192. orce Reedit Clean Install Install as root user e The Options item for a subproject controls the way that the subproject will be compiled built and installed The dialog box that pops up has tabs for Compiler Includes Prefixes and Build Order e The Add Subproject item creates anew directory and skeleton Makefile am file 5 e Add Service tp be written e Add Application to be written e Add Existing Subprojects to be written project item in the popup menulfor a subproject is the proper way to necessary compile and make operations to build the code for this subproject only Force Reedit to be written Clean to be written Install to be written Install as root user to be 144 Written KDevelop User Manual 10 3 Automake Projects to be written 10 3 1 Autoconf Makefile in into 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 geb config h ininto 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 10 3 2 Automake to be written 10
193. ording to a specified set of rules The regexptest Plugin Designing with regular expressions can be hard work Often the first try at an expression matches too many strings In particular when working with a compiled language the turnaround times when de bugging a regular expression can be awkward The regexptest plugin allows you to directly explore the changes in a regular expression It is activated by choosing Tools Debug Regular Expression In the flavor group box you can choose the flavor of the regular expression engine used Currently supported is the flavor defined in the POSIX stan dard which is used by the grep program and the extended POSIX syntax used by the program egrep When you enter an expression you get immediate feedback about any syn tax errors in it By entering a text under Test string you can see whether the expression matches this string In particular if your regular expression includes groups such as a z the content of the matched subgroups will be shown in a list box 190 KDevelop User Manual Appendix F KDevelop User Interface Mode Examples E1 IDEAI Mode Click here to return to the modes overview Sapaeva op TIPJHOTICIH VEINS STO RUPVETDD STO ITIHITIWITIHDW CDD KODEVE Eile Edit View Project Build Debug Bookmarks Window Tools Settings Help Qood e 3 85 i C3 23 5 A C amp LE al Namespace w Classes Functions Fe aae Qood E
194. ork on your program texts various file browsers providing you different views on your file system various class browsers to aid you in maintaining the classes and their rela tionships of your object oriented programming project e a debugger interface to find and remove program errors from within KDe velop and several plugin tools extensible modules which can be loaded at runtime and on demand This allows you to only turn on those features you really need a set of other diagnosis documentation and optimization helper tools 58 KDevelop User Manual NOTE In fact there are three KDevelop based applications e The KDevelop IDE this is the place where you will usually work e The stand alone KDevelop Assistant documentation browser isolates all the powerful documentation facilities of the KDevelop IDE in a separate tool This comes in handy when you want to look up some programming documentation but do not want to start the full IDE e The KDevelop Designer enhances the Qt User Interface Designer by KDE specific elements and integrates nicely in the KDevelop IDE 3 1 Available User Interface Modes KDevelop offers developers four separate user interface modes click on the mode name to view an example e IDEAI This is a novel user interface approach optimizing both work space and in tuitive handling of the tools All tool views are docked in a tabbar fashion around the mainframe area
195. ou to define some basic KDevelop behaviour which seldom will change in everyday work This concerns General project options such as e defining a default parent directory KDevelop shall use for new projects 66 KDevelop User Manual e deciding whether you want KDevelop to automatically load the project you last worked on Selecting a font for the most commonly used output view windows namely e the Messages Output View KDevelop uses to communicate e g com pilation progresses and e the Application Output View which will show error and state informa tion concerning a running application Some common behaviour concerning the displayed lines in the Messages Output View window namely e whether long lines will wrap around and e if directory entry and exit messages issued by make will be shown The level of detail of messages concerning the compilation process shown in the Messages Output View window General Project Settings X Load last project on startup Default projects directory home devel projects rz Output View Settings Window font Sans Serif 10 Choose Compiler output X Line wrapping Directory navigation messages UI Designer Integration Use KDevelop s embedded designer Run KDevelop s designer as a separate application Run Qt Designer Terminal Emulation Use KDE setting D Other The general configuration dialog Load last project on startup Mark this
196. our application Header in noingte Create New File item brings l 5 IData in kdelnke a dialog in which you chn set i e file name and the Ban bf file e myapp client Haha Atel RHA myapp cliehiepcggyn list myapp Pro utamoanbbitre Files ite brings hip a dialog box in which Target myapp you cam add an already existing eR Options Create New File E Add Existing Files x Remove Make Target Active y Build Target file to this target The Remove item for a target allows you to logically renjove the target and all its files frpm the project structure The MakXd Target Active itq m only applies to targets containing source code fileg New files will always be added to suchjan active target The Build Target item callg all necessary compile and make operations to build the code for this target only 10 2 5 3 The Popup Menu for a Subproject When you right mouse button click on a subproject in the overall view window the following menu will pop up which allows you to make major changes to the structure of your project and the way it is compiled built and installed You can use it to expand or modify the basic project structure that the Application Wizard has created 143 KDevelop User Manual Subproject Options Add Subproject Add Target Add Service Add Application Add Existing Subprojegt amp e Remove Sub Remove Subproject Build F
197. ouse a short distance The cursor will change to a crossed arrow pattern You can now drag this tab holding the middle mouse button down until it did skip into the place where you want it to be 2 4 3 3 Viewing Several Files Simultaneously At first sight there is always at most one single editor window open to work on a source file Although you may fast switch the tabbed windows there are times where you want have several files open at once e g for reference pur poses or to keep complex tasks under better control To accomplish this KDe velop provides a way to split the workspace area into different simultaneously visible sections which each can hold their own series of tabbed windows There are two split commands which you can reach either through the Window menu or by right clicking either into a tabbed window or on the window tab itself We will illustrate this splitting behavior again with our Hello example project Assume there are two source files open on the tab bar hello cpp and hello h Now while working on the hello cpp source you often need to refer to the declarations in the hello h headers file so you want to keep both files open simultaneously To get this done right click on the tab of say hello h The following menu will then pop up hell amp o h Close Close All Others Split Horizontal Split Vertical Open as UTF 8 Open As Open With How to split the current workspace area into two parts Se
198. ovides most valuable help Documentation has multiple facets There is e project internal documentation mainly consisting of comments in header source files internal API documentation of your project generated from the program file by special tools e g Doxygen e project external documentation comprising among others external API documentation of e g common system libraries KDE QUIM etc any other documentation programming language manuals general sys tem information how to articles and the like All this documentation should be easily maintainable and ready at hand when ever you need it KDevelop has provisions for just this 9 1 The Documentation Browser 129 KDevelop User Manual B Qt KDE Libraries Gtk GNUstep STL Eg Python Eg libe QQ Introduction QQ Error Reporting x Memory Allocation x Character Handling xl String and Array Utilities xw Character Set Handling j 0 Locales and Internationali x Message Translation wf Searching and Sorting AQ Pattern Matching H A Input Output Overview H Q Input Output on Streams Low Level Input Output File System Interface QQ Pipes and FIFOs j 4 Sockets j 0 Low Level Terminal Interface j 0 Mathematics j H Q Arithmetic Functions ERU Date and Time j 0 Non Local Exits Signal Handling i i thro m a Figure 9 1 A Screenshot Pthe Documentation Tree KDevelop User Manual Ch
199. owerful documentation facility which provides ac cess to several kinds of extensive documentation In e g IDEA mode you find a Documentation tab at the right border of the work area 89 KDevelop User Manual Wh n Contents l EA Project API Documen IE Pango Reference Ma H ORBIt Reference Ma ES Libbonobo Referenc m ES GSF Reference Manual amp ES GObject Reference M 3 a GLib Reference Man ES GIMP Widgets Library a GIMP Thumbnail Libr eb a GIMP Module Library ES GIMP Math Library Re a 9 a GIMP Library Resten a Index a 5 E _ a in Bookmarks The KDevelop documentation window IDEAI mode NOTE KDevelop must have loaded the Documentation plugin in order to view the docu mentation tree See the Plugin Tools section for more info You may set up contents and behaviour of the various parts of this documenta tion window if you select Settings Configure KDevelop from the menubar The Customize KDevelop dialog will pop up where you have to select Docu mentation in the left hand window The thus displayed configuration page shows three tabbed configuration dia log pages namely Documentation Collections Full Text Search Other 90 KDevelop User Manual 4 2 1 Setting Up Documentation Collections The documentation configuration settings have been divided into a series of documentation collections each providing acce
200. owsers 8 1 Class VieW aort onac ipro diada eRe eee es 82 Class Tools iusso doo ko E 04 Pena Y ORO A 83 Class Hierarchy lle Documentation 9 1 The Documentation Browser c n Building and Project Management 10 1 Summary of Automake Manager 2 10 1 1 The Need for an Automated Build System 10 1 2 Tutorials on Autoconf Automake Libtool 10 1 3 What does Automake Manager Do 10 1 4 Summary of What Automake Manager Does 10 1 5 Contents of Automake Files ss 10 2 Automake Manager Operation llle 10 21 The Automake Manager Window 10 2 2 The Overall View Window 10 2 3 The Detail View Window 10 231 largets 2 em oed oue arm dex 10 2 4 Navigating in the Automake Manager 10 2 5 Popup Menus in the Automake Manager 120 120 120 121 121 121 121 122 123 123 123 124 126 126 128 128 129 129 133 11 12 13 14 KDevelop User Manual 10 2 5 1 The Popup Menu fora File 141 10 2 5 2 The Popup Menu fora Target 142 10 25 3 The Popup Menu for a Subproject 143 103 Automake Projects ataca Sarate a o aaa a E e a Aa 145 10 3 1 Autoconf 2 llle 145 10 3 2 Automake llle 145 10 3 3 KDevelop s Automake Manager 145 10 3 4 Building and Installing Libraries
201. played title cannot be changed by the user If you want another text be displayed you must manually change the t itle entry in the toc file 100 KDevelop User Manual base address base href base document URL gt This URL points to the location where all files of this documentation are located It will be prepended before each section URL in the following content structure list So if you e g downloaded a documentation from a remote server all you need to display the files from this new location is to change its base URL lt tocsectl name section title url section URL gt content structure lt tocsectn name section title url section URL gt lt tocsect1 gt All remaining navigation and access information is stored in a series of nested tocsecti lt tocsecti gt pairs Each i denotes a consecutive nesting level down to number n which will correspond to the finally dis played documentation section Any lt tocsecti gt entry must have a name xxx attribute associated with it the xxx denotes the actual title string This name will be displayed as level title in the documentation tree It should correspond to an actual documentation section There may be an url attribute associated with any 7 nesting level When the user clicks on a section title in the documentation tree KDe velop will try to access the file at the location pointed to by the combined base and se
202. ppsupportrc holds some settings used to set up CPP source files In particular you will find the settings made on the C Class Generator configuration dialog in here kdevdocumentationrc holds actual settings the Documentation plugin uses kdeveloprc holds the global settings the KDevelop IDE and the KDevelop Assistant stand alone documentation browser will use kdevelopuimode4rc holds the current MDI configuration states dock po sitions etc of the KDevelop IDE kdevfileselectorrc holds actual settings the File Selector plugin uses kdevfileviewrc holds the actual filename color settings the CVS Integra tion Cervisia project plugin uses for display kdevfilterrc holds actual settings the Shell Filtering and Insertion plugin uses 182 KDevelop User Manual e kdevgrepviewrc holds actual settings the Grep Frontend plugin uses e kdevsnippetrc holds actual settings the Code Snippets plugin uses e kdevtoolsrc holds actual settings the Tools Menu Addition plugin uses CONFIGURATION FILES USED BY THE DOCUMENTATION PLUGIN e docchmpluginrc holds information about the actual Microsoft CHM help files as defined on the CHM Documentation Collection configuration page e doccustompluginrc holds information about any custom documentation file defined on the Custom Documentation Collection configuration page e docdevhelppluginrc holds information about the actual GNOME 2 D
203. pressed additionally to mark from the current cursor position to the one afterwards Backspace Deletes one character left Deletes the character under the Delete cursor Ctrl C Copies the selected text to the clipboard Ctrl V Pastes the selected text from the clipboard Deletes the selected text and puts aca it into the clipboard Ctrl Z Undo Shift Ctrl Z Redo 6 3 The Problem Reporter to be written 6 4 Searching and Grepping 6 4 1 Searching for Text Ctrl F Find Ctrl R Replace 6 4 2 Search The conventional search with Edit Find requires you to specify the full search term before starting Most of the time it is much faster to search incrementally 121 KDevelop User Manual If you click into the edit field labeled Search in the toolbar the search is per formed as you type You will find that often the desired term is already found after typing in 3 or 4 letters 6 4 5 Grep Both search mechanisms described above are restricted to searching within one source file An additional tool which allows you to search through a possibly large number of files is available through the Search in Files item in the Edit menu It is basically a frontend for the grep 1 program In the dialog you can specify which files are searched There is a number of wildcard patterns available in a combobox In this way you can easily restrict the find mechanism to header fil
204. proto col and the ext server which uses an rsh or ssh encrypted data transfer They are distinguished by the URL prefix they use ipserver for the password protected server non encrypted type and ext for an rsh or ssh encrypted server type For example ext mylogin cvs cervisia sourceforge net cvsroot cervisia accesses the CVS root of the widely used Cervisia CVS management tool on the SourceForge server If you want to use an rsh or ssh encrypted server for CVS access you must tell KDevelop the encryption protocol to be used Just enter rsh or ssh in the CVS RSH field of the Create New Project Version Control System page 113 KDevelop User Manual NOTE There is a caveat if you use an encrypted server for CVS from within KDevelop See the Using CVS chapter for details The CVS Repository So far you have told KDevelop where the CVS root re sides which manages the versioning database and how to access it Now you need to tell KDevelop under which name you want CVS save your project files in that database Such a place your project files will be held in CVS is called a repository In principle you can use any name for the CVS repository of your project files as long as it adheres to the specifications of naming a file Yet most develop ers simply use the name of the application itself CVS will build a directory with this name in the CVS root hence it is more easily found if you keep the application name fo
205. r it Just enter the repository name you want to use in the CVS repository field of the Create New Project Version Control System page In our example this is MyApp WARNING Take care not to use a repository which already exists The CVS system does not warn about duplicate files but will shovel everything in which does not produce a formal conflict You will mess up everything The Remaining Fields There is not much work left to do Application Wizard has already set up the remaining fields for you In detail The Vendor field is used for compatibility reasons only You can stick to the vendor default the Application Wizard puts in here The Message field allows you to comment the initial CVS contents Use any text you like or just stick to the new project default the Application Wizard did put in The Release tag holds the name which tags the initial state of your project Such a tag names a certain point within the CVS repository by which you can later access this state of your development See more in the Using CVS chapter The Application Wizard has put a default start tag in here which is a worthy proposal Just stick to it 114 KDevelop User Manual NOTE When any information of all these is wrong KDevelop usually will not Know about until project construction time It is the CVS system which will figure out those errors when it tries to build the repository Hence you must keep an eye t
206. r to get you started in writing the user manual You should edit this index docbook in KDevelop and start changing personal details such as name email etc Look at the comments in this file and try following these indications to start your application documentation Rebuild your project to see the changes in KHelpCenter NOTE You need to install your project using Build Install or Install as root user in KDevelop to see the user manual in KHelpCenter You can find more about the docbook syntax on the KDE documentation web site 2 9 Last But Not Least Keyboard Shortcuts to be written 2 10 Where to go from here to be written 2 10 1 Frequently Encountered Problems The nutshell chapter FAQ pages Forum Mailing lists 2 10 2 Working With Projects to be written 2 10 2 1 Using Existing KDevelop Projects to be written 56 KDevelop User Manual 2 10 2 2 Importing External Projects to be written 57 KDevelop User Manual Chapter 3 Overview of KDevelop Features Bernd Pol KDevelop integrates a lot of tools scripts and templates in a com mon user interface Basically it consists of e several user interface modes from which you can select the look and feel of the workspace e an Application Wizard which aids you in setting up a new project several project management systems which aid in building and managing your project some editing tools to easily w
207. ram files documentation or data Each such directory con tains a Makefile am file and is known in Automake Manager as a subproject There are three typical subprojects in a KDE based project as shown in the above illustration e src source code files for your application e doc your user manual or Handbook e po extracts of strings in your source code files that require translation into other human languages e g window titles menu names button labels dia log box text and messages of various kinds Note that the doc subproject always has an en subproject which you can see if you click on the symbol next to the word doc That is because the base language of all documentation in KDE is United States English en If your ap plication becomes part of KDE the KDE translation teams may translate your documentation from United States English into other languages and the trans lations will go into other subprojects such as de German or r French The strings in the po subproject may also be translated and stored in other files in po thus allowing your application to be operated by people who do not know English NOTE The doc and po subprojects serve different purposes doc contains documentation like a user manual po contains translatable text strings of the user interface which is integrated in the source code of this application The overall view window serves amongst other things as a navigation tool
208. rary Libbonobo Reference Manual LibBonoboUl API Reference Manu GTK Reference Manual GObject Reference Manual GNOME Library Reference Manual ei JOOoOooo0o0 cry Custom Documentation Collection Providing DevHelp documentation DevHelp files originally were accessible on the LiDN website but this seems to be not maintained for some time now More recent DevHelp documentation is available at the DevHelp Books Download web page When KDevelop is installed it will attempt to find all devhelp files in some standard places in the system e g in the subdirectories of opt gnome share Initially these files will not be marked for display If you want to see another documentation mark the TOC check box in the setup table You may add new entries using the buttons to the right of the list field KDe velop will filter toc files in the directory dialog associated to the Add and Edit buttons 4 2 1 8 Setting Up Custom Documentation Collections This is for your own purpose You may add almost any documentation files here provided they can be displayed by the Konqueror plugins 102 KDevelop User Manual Documentation Documentation Collections Full Text Search Other Qt Documentation Collection uu Add CHM Documentation Collection D Edit Doxygen Documentation Collection e ss KDevelopTOC Documentation Collection v Remove Devhelp Documentation Collection Custom Documentation Colle
209. rations definitions and also a query dialog http ctags sourceforge net Final Packaging Support Aids in building and publishing the final project Only RPM package format is supported for now 187 KDevelop User Manual Doxygen Support The doxygen plugin provides a way to specify and control generation of documentation for a project based on source code content You need to have doxygen installed to be able to use this For more info goto http www doxygen org QuickOpen Provides an efficient way of finding opening files classes and methods in a large project Appears in the File and Tools menus when loaded Security Checker Code security checker So far the generated plugin list antproject ANT Project Manager Java applications autoproject Automake Project Manager customproject Custom Project Manager trollproject QMake based Project Manager Table E 2 Project Management Plugins in KDevelop The above plugins are currently May 2005 empty Maybe project manage ment support will be implemented as plugins in the future cppsupport Support for C C fortransupport Support for Fortran javasupport Support for Java perlsupport Support for Perl phpsupport Support for PHP pythonsupport Support for Python Table E 4 Language Support Plugins in KDevelop In the following some of the plugins will be discussed in detail The abbrev Plugin This plugin expands a
210. recompiled When you e g change a function prototype in a header file you need to com pile every file which includes this header file If your project contains many such files you may easily miss one or two of them if you have to do the job manually Thus some means of automization is necessary C 4 1 The Make Process A tool which takes care of recompilations is make It keeps track of all work using a set of rules which describe what to do in case some piece of information usually a source or object code file was changed All rules belonging to a certain project are stored in a so called Makefile which is processed by make any time you want to update your work Each rule consists of several building blocks namely e a target i e the file to be built e a set of dependencies basically the names of those files the target depends on e g the name of a source file where then the target will be the name of the object file to be built and e the commands which are to be executed to make the target i e to compile it or to link other object files together to build an executable progam file Basically the make command will read the rules one after another check each file in the dependency list of a given target and make this target anew if any one of these files has changed using the commands listed in that rule 171 KDevelop User Manual There are several additional possibilities to control such a make process and a Makef
211. rface mode is MS Visual Studio 6 0 Tabbed pages mode All tool views are initially docked to the mainframe Editor and browser views will be stacked in a tab window A typical example of this user inter face mode is KDEStudio our friend C IDE in the world of KDE Toplevel window mode All editor browser and tool views will be toplevel windows directly on desktop The main widget contains the menu toolbars and statusbar only A typical example of this user interface mode is Borland Delphi 6 0 To switch the user interface mode select Settings Configure KDevelop from the menus The Customize KDevelop dialog will pop up where you have to select User Interface in the left hand tree This will display the following set tings dialog to the right 71 KDevelop User Manual User Interface Major User Interface Mode Simplified IDEAI window mode IDEAI window made Childframe window mode Tabbed pages mode D Toplevel window mode Use Tabs Always J When mare than one D Never Toolview Tab Layout Tabbed Browsing Icons x Open new tab after current tab Text C Show icons on document tabs Text and icons xj Show close button in tab bar Note Changes will take effect after KDevelop is restarted Select a user interface mode Select the radio button of the user interface mode you want to switch to then click OK NOTE Do not forget to restart KDevelop
212. riables which will get their actual values at the time when you insert such a snippet in some other text More information on this is available in the Code Snippets and Setting Up the Code Snippets Tool chapters 22 A Bit of Configuration Before we actually start a first example project we should tailor the KDevelop behavior to our needs Although most of the default settings will be appropri ate for now there are a few places which better should be adjusted NOTE If you want to know more about KDevelop configuration have a look at the Config uring KDevelop chapter 2 2 1 Some General Settings To configure KDevelop click the Settings menu and select Configure KDe velop The Configure KDevelop dialog will pop up showing the following General settings page to the right 10 KDevelop User Manual General Project Settings X Load last project on startup Default projects directory fhome devel projects fe Output View Settings Window font Sans Serif 10 Choose Compiler output X Line wrapping Directory navigation messages UI Designer Integration D Use KDevelop s embedded designer Run KDevelop s designer as a separate application Run Qt Designer Terminal Emulation Use KDE setting D Other The KDevelop general configuration dialog Most of the defaults will be o k But you will probably want to change two of those settings Default projects directory
213. rojectwide Search and Replace tool Search using string or regexp matching and select the replacements to be made from a preview before the action is finalized When loaded it appears in the Edit menu Scripting The Scripting plugin offers KScript based scripting of the KDe velop application Code Snippets This plugin allows you to store code snippets and add them to your code Text Structure Provides a structure overview and navigation for HTML and TEX files e Tools Menu Addition This plugin provides an easy way to add external applications to the Tools menu and toolbar Valgrind Frontend Valgrind is a tool that helps you find memory manage ment problems in programs http developer kde org sewardj Scope Project e annotation Plugin annotation Description e Source Code Formatter A plugin for formatting of sourcecode according to a specified set of rules When loaded it is found in the Tools menu e Bookmarks Plugin that provides navigation and overview of active source bookmarks and persists them between sessions e Class View This plugin displays a graphical view of all the classes in the project complete with methods and attributes and provides a way of direct source navigation e CopyTo Simple file uploader plugin It does a file copy over any KIO sup ported protocol e CTags Frontend CTags is a source navigation tool with support for many languages When loaded it provides a context menu for finding type decla
214. s for this KDevelop will automatically activate the editor window of the source file in question and put the cursor on the error line If on the other hand you rather want the build be stopped on whenever an error occurs check the Abort on first error option in this dialog KDevelop will then call gmake without the k option 2 5 2 4 How to Run the Executable Once the build is complete you can easily run the application from within KDevelop Use either Build Execute Program the Shift F9 keys or the Exe cute program button in the Build Toolbar of KDevelop DE Run the program from here 52 KDevelop User Manual But where is the executable located which should be run How does one have KDevelop append options to the call Or how can I have the application exe cuted in a terminal by its own to test its console interactive behavior All this can be solved by configuring some project oriented run options in KDe velop Select Project Project Options and then the Run Options icon from the icon bar on the left dialog window side The Run Options dialog page will dis play to the right Run Options Directory Run from the directory where the executable is Run from the BUILD directory home devel projects hello debug Custom directory Program if empty automatically uses active target and active target s arguments Main program relative to BUILD d
215. s to enhance the readability if isBar fooArg barValue 83 KDevelop User Manual Controlling the formatting of one line constructs There are a few cases where you don t want the source formatter to split a long line apart For C C code this can be controlled here Keep one line statements This keeps single line statements together in some situations even if they exceed a fixed maximum line length Keep one line blocks This keeps single line blocks together in some sit uations even if they exceed a fixed maximum line length 4 1 10 Setting Up the Code Snippets Tool When editing in KDevelop you can store often used parts of code as Code Snippets To configure the capabilities of the code snippets part select Settings Configure KDevelop from the menubar The Customize KDevelop dialog will pop up where you have to select Code Snippets in the left hand tree This will show the following dialog in the right hand side Code Snippets Tooltips X Show snippet s text in tooltip Variables Delimiter Input Method for Variables Single dialog for each variable within a snippet One dialog for all variables within a snippet Automatically Open Groups The group s language is the project s primary language The group s language is supported by the project Configuring the Code Snippets tool Activate Snippet Preview Mark the Show snippet s text in tooltip che
216. s will show additional menu entries which provide various means to handle Web pages Other Tools Usually there will be a bunch of other entries according to the currently available tools Use Shift F1 to get more information about their purposes Settings This menu allows you to show and hide menubar toolbars and sta tusbar Also you can configure shortcuts toolbars notifications the edi tor and KDevelop s general behavior Help Here you can open this KDevelop manual look up terms in various doc umentation files open man pages the traditional UNIX manual format and info pages the GNU manual format Furthermore you can report bugs here or get some info about your current KDevelop version and its authors 2 1 4 What are those tool views for In the IDEAI user interface mode the workspace will be surrounded by three areas of buttons so called tool view tabs They provide access to tool view win dows which accomplish main tasks during software development Each of these three tool view areas serves a different main purpose KDevelop User Manual e Left Side Provides access to navigation and selection tools e Bottom These views display messages produced by various tools e Right Side Provides access to documentation and source management tools The number of tool view tabs shown will change once a project is open for ac tual work More tools to work on that project will be available then The actual number of tool views dep
217. sBar c embedOutputView t Jj main cpp Jlanguageselectwidget laeneralinfowidaetbase H Messages am Application lt 3 Difference viewer J evs Valgrind Subversion X Grep CvsService S Replace Ui Konsole I ew Postprocessing Makefile templates Creating date time stamp Finished Dont forget to run configure LI you haven t done so in a while run configure help we Success Line 353 Col 0 INS NORM KDevelop child frame windows mode Click here to return to the modes overview E3 Tabbed Pages Mode Click here to return to the modes overview 193 KDevelop User Manual ue fuu inel aeu uisu alu omgdeveikaesstokaevelop Eile Edit View Project Build Debug Bookmarks Window Tools Settings Help BQQj188S RRBABARY G00 amp l 3 al Namespace MK kal Classes ii Functions ijt dy x Qood E Rx E okmarks E Classes A mainwindow cpp Jj mainwindow h L3 saveSettings iB Detur return true H Q DocumentationPart g EL EditorProxy Generallnfowidget B HistoryEntry LangPluginitem e S LanguageSelectwidget n KMainwWindow Mainwindow main Et return this Sse a aeo RX S Automake Manager 4 t 5 MainWindow void Mainwindow createstatusBar t callC
218. se KDevelop control e GNU Project Description Files Some files in the project root directory are mandatory in any GNU conformant application These are AUTHORS Cha ngeLog INSTALI L COPYING which contains the GNU GENERAL PUBLIC LI CENSE INSTAI LL NEWS README and TODO e Other Files A few more files not mentioned yet are Doxyfile controls the creation of the project specific API internal program ming interface documentation The templates directory containes file templates the IDE uses as stubs to create new source files You may at any time edit these templates The new contents will be reflected in the next source files you create of the related types You may e g want to realign the right hand stars in the copyright lines the Application Wizard inserted into the cpp and h template files so the source files created from them will look less awkward The po directory will be used for localization purposes It is essentially part of the project files contains a Makefile am but will mainly be used in translation processing Not of main interest to the application developer however Finally the admin directory is specially needed in KDE oriented applica tions It provides a whole bunch of files necessary to maintain the appli cation s sources and binaries so they will integrate properly into the KDE environment 23 3 Additio nal Tool Views As you will have noticed as soon as the Application
219. sed by KDevelop Usually you should not need to care but this is very useful to know in case something went wrong with your setup 167 KDevelop User Manual Appendix C Development on UNIX C 1 Some Historical Remarks From the beginning UNIX has maintained two very different development paradigms One is the world of system and application programming languages where some source code is translated to machine code by a translation pro gram usually a compiler or an interpreter The programming language C is an example UNIX was the first operating system kernel to be written in such a high level language instead of tightly machine oriented assembler which was common before that time In fact the C language once even was invented to write the UNIX kernel and associated programs on a DEC PDP 11 com puter The other paradigm is the world of scripting languages This world evolved with the invention of the UNIX shell which was the user s interface to the operating system and at the same time a very high level programming lan guage A shell script is built from a set of small utility programs like e g grep sed or find Each such utility is designed for some tightly defined job The trick is that any such utility can be connected to another one via a simple trans port mechanism called a pipe which directs the output of the foregoing utility into the input of the next processed one This makes for a very powerful and hig
220. ser provides the Close Selected Windows entry in the Win dows menu kdevcppsupport holds the acual configuration used by the Application Wizard to build C applications The Application Wizard however uses its main bulk of configuration information directly from the default configura tion directory See there for more detail newclass contains the actual header and source templates from which the Application Wizard builds the according source files pcs contains database files KDevelop uses build the actual Persistent Code Store pcs file of a KDE C project kdevcppsupport rc provides the Complete Text and Make Member en tries fo the Edit menu the Switch Header Implementation entry for the View menu and the New Class entry for the Project menu as well as a New Class icon for the Browser Toolbar kdevctags provides the CTags entry in the Tools menu for the CTags Frontend project plugin kdevdebugger provides the Debug menu entries for the Debugger Fron tend project plugin kdevdiff provides the Difference Viewer entry in the Tools menu kdevdocumentation contains the actual files used by the Documentation plugin in addition to the default configuration files See there for more detail The directories in kdevdocumentation mainly hold actual bookkeeping in formation The actually set up documentation files are kept in doc pluginrc files in the KDEHOME share conf
221. sibilities in the next section 2 5 2 2 Project Configure Options Configuring the application properly is vital in the GNU autotools building chain This is usually guided by option definitions to the configure script and or specific flags settings in the environment prior to running configure as e g the CXXFLAGS in our previous discussions You may set most of the configuring options for a given project from within KDevelop GUI Select Project Project Options and then from the icon bar on the left of the dialog the Configure Options icon The Configure Options dialog featuring several tabbed windows will display on the right handed side 47 KDevelop User Manual Configure Options Configuration debug J General E c Fortran Configure arguments enable debug full Build directory must be different for every different configuration debug J g Top source directory C C preprocessor flags CPPFLAGS Linker flags LDFLAGS Environment Variables Name yw Value IL dd Copy Edit Edit Remove Remove lw OK Cancel Most configure options can be defined here As you see there are quite a lot of options you can set up in this dialog For now we will briefly look at only a few of them with regard to our Hello example project For detailed instructions see the Configuring Projects
222. spond to the name of the build configuration in use but you are free to use any name you like provided it is different from any other build config uration directory Top source directory You won t need this one often It defaults to the project root directory and needs only be redefined if your project sources are located in another place C C preprocessor flags CPPFLAGS Put specific instructions for the pre processor here KDevelop will use this to set up a temporary environment before it calls the actual build tool Again see the example in the Initial Hello Configuration section above how this is done Linker flags LDFLAGS This is extra information for the ld linker tool where it should look for additional libraries It is used to build the temporary build environment as well Environment Variables Here you may define additional variables to be set up in the temporal build environment KDevelop will set up before calling the respective build tool Again you must define these environment vari ables for every build configuration where they are to be used 2 5 2 2 2 Compiler Specific Settings The other tabs on the Configure Op tions dialog page are for compiler specific settings They are similarly struc tured so it suffices to have a brief look at the C page 49 KDevelop User Manual Configure Options Configuration debug General c c Fortran C compiler GNU C Compiler Y Co
223. ss to documentation files of some unique format and content type These setups control which documenta tion items will be listed on the Contents page of the KDevelop Documentation facility and how the user may access documentation details by indexed and full text searches The Documentation tab provides a series of configuration pages which are or dered vertically like a stack of index cards One page at a time will open after a click on its index card title Qt Documentation Collection CHM Documentation Collection Doxygen Documentation Collection KDevelop TOC Documentation Collection Devhelp Documentation Collection Custom Documentation Collection Documentation Documentation Collections Full Text Search Other TOC Index Search Title Add SES ESSE ES EST EST T S S ES EST EST ET S ST SE E EST ES JOOOOOOOOOoOoOoOo0Oo0o0o0o000 OoOooooooo Ada Ada bugs GCC Bash bugs Bash Reference Manual Bonobo Activation API Reference Manual C Annotations C bugs GCC Clanlib Document Object Model DOM Level 2 HT Fortran bugs GCC GConf Reference Manual GIMP Base Library Reference Manual GIMP Color Library Reference Manual GIMP Library Reference Manual GIMP Math Library Reference Manual GIMP Module Library Reference Manual GIMP Thumbnail Library Reference Manual GIMP Widgets Library Reference Manual GLib Reference Manual OMISIT 4 0 ANI NDafaranan iL
224. sume you want to always open the hello cpp hello h and main cpp files all in one step no matter what development task you just did perform in the project To accomplish this you first need to create a new development session named say sources 34 KDevelop User Manual main cpp hello cpp hello h cxoeoooooooorororerereeooororo Selector t Co ight C 2006 by J e 48 Save View Session As KDevelop Enter the name of the session E Clear w OK x Cancel marks 3 File List 4 Use development sessions to remember groups of files This is a multiple step approach as follows 1 Create a new session a Click the New Session icon top left in the File List tool view window b A dialog will pop up In the Enter the name of the session input field give your new session a name e g sources c Close the dialog with OK The new session will now be listed in the drop down box on the toolbar 2 This new session will initially be empty You must populate it with the files you want to be kept there a Open all files you want to be grouped in this development session In our example we decided to keep hello cpp hello h and main cpp there as planned b Once your file list is complete click the Save Session icon in the toolbar Do not skip this step KDevelop will forget the file list oth erwise That was it Whenever you select the sources session
225. t Options Project Close Project Close Project G 1 5 The Project Menu Build Build Project F8 Build Project Build Build Active Target F7 Build Active Target Build Compile File Compile File Build Run Configure Run Configure Build Run automake amp friends Run automake amp friends Build Install Install Build Install as root user Install as root user Build Clean project Clean project Build Distclean Distclean Build Make Messages amp Merge Shift F9 Make Messages amp Merge Build Execute Program Execute Program Build Build API Documentation Build API Documentation Build Clean API Documentation Clean API Documentation Build Stop Escape Stop 199 KDevelop User Manual G 1 6 The Project Menu Debug Start Start Debug Stop Stop Debug Interrupt Interrupt Debug Run to Cursor Run to Cursor Debug Step Over Step Over Debug Step over Instruction Step over Instruction Debug Step Into Step Into Debug Step into Instruction Step into Instruction Debug Step Out Step Out Debug Toggle Breakpoint Toggle Breakpoint Debug Viewers Viewers Debug Examine Core File Examine Core File Debug Attach to Process Attach to Process Debug Valgrind Memory Leak Check Valgrind Memory Leak Check Debug Profile with KCachegrind Profile with KCachegrind G 1 7 The Bookmarks Menu Bookmarks Set Bookmar
226. t only from where the actual executable is to be found Use this if you e g want to run the actually installed program instead of the version located in the project directories e Program This tells KDevelop the relative position and name of the program it shall actually call This is relative to the root directory defined in the config uration group above Furthermore you can define any argument KDevelop will pass to the program when it is actually called NOTE If leave the Main program text box empty the active target settings of the Au tomake Manager will be used Although this is an expert setting inadvertently leaving this input field blank is a common cause of problems Check this setting if KDevelop appears not to call the executable you wanted e Environment Variables KDevelop will set up a dedicated shell environment to run the program in Define any extra environment variable in this config uration group e Miscellaneous Two more check boxes are located at the bottom of this dialog page Automatically compile before execution comes in handy most of time KDevelop will check the project for changes and perform necessary config ure and build steps for you any time you command it to run the program Uncheck this in case you want to run the program version prior to the last change Start in external terminal is interesting if you want to test the input output behavior of non GUI programs in a console terminal T
227. t which user interface mode your KDevelop currently uses check with the Settings Configure KDevelop User Interface dialog 2 1 A Very First Look at KDevelop This is all about what you will see when you first started KDevelop You will find preliminary information about What is there on the surface How to get some help What is in the menus What are those tool views for 2 1 1 On the Surface When you start KDevelop for the first time you will get a display similar to this one KDevelop User Manual Edit View Project Build Debug Scripts Window Tools Settings Help 4 E309 m E o v Workspace Area E Tool View Tabs mc di o i o ES 7 u 2 iu E zi S uL sjeddius epo 75 uoneqjueuin2og e illl Application Diff Messages Find in Files 4 Replace ail Konsole The KDevelop initial layout Actually the initial KDevelop window will be larger but the elements you see are the same Workspace Area and Tool View Tabs In this initial case KDevelop uses the so called IDEAI user interface mode A workspace area of maximum possible size is surrounded left bottom and right by a series of buttons which act similar to tabs on a tabbed display If you click on one of those tabs a so called tool view window will open which allows you to work on a specific task Menu and Toolbars On top there is the usual menubar followed by several rows of toolbars some being initiall
228. tlh cpp cc C c4 ooc ocl inl idl c m mm M z Directory home devel projects hello Iz ra X Regular Expression X Recursive X Case sensitive X New view X Skip VCS dirs Ge Search J X Cancel A versatile graphical front end to perform global searches in the project As you see this is a very versatile tool to initiate find and grep searches throughout your project We won t delve further into details here but you may want to experiment with this facility on your own For the moment there should be our Hello be preselected in the Pattern field If it is not just type it in then press the Search button at the bottom right Now the Find in Files tool view will open at the bottom showing you file names and lines of all literal occurrences of Hello in our example project As usual if you click an entry KDevelop will get you to exactly that position in an editor window in the workspace area There are two lines of special interest in the tool view window Righton top you will find the command sequences KDevelop did actually use to perform the search This will be useful to more precisely control the search outcome 28 KDevelop User Manual On bottom the number of occurrences found in these search run wall be listed In our example this should read 11 matches found KDevelop will remember these search results throughout the currently run ning session I
229. toolbar entries Thus they are of interest only in case something went really wrong with the user interface NOTE In case the contents of these directories mirror those of the Default Configuration settings KDevelop will have copied them from KDEDIR apps into the KDEHOM E apps directory on its initial start Any subsequent changes will be made to these copies only The Default Configuration settings remain unchanged in any case e kdevabbrev contains files used by the Abbreviation Expansion plugin sources currently empty KDevelop uses the default keyword defini tion files for Expand Text commands templates contains the user modified template definition files used by the Expand Abbreviation command kdevabbrev rc provides the Expand Text and Expand Abbreviation en tries in the Edit menu e kdevappwizard only provides the New Project and Import Existing Project entries in the Projects menu The Application Wizard will use the default configuration settings for its actual works e kdevastyle provides the actual Reformat Source entry in the Edit menu e kdevautoproject provides the actual entries in the Build menu and the Build Toolbar KDevelop toolbar e kdevclassview provides the Class Inheritance Diagram entry in the Project menu and the class browser combo box in the Browser Toolbar by the Class View project plugin 179 KDevelop User Manual kdevclo
230. treme cases it even might destroy your files Make sure you have a backup of your source files before you try out these settings with an none KDE standard editor 4 1 9 1 General Formatting Setup The General tab of the Source Formatter dialog allows you to select one out of five predefined source format styles 78 KDevelop User Manual Formatting General Indentation Other Style Example e User defined namespace foospace class Bar public int E foot private int m foo int Bar foo ANSI switch G0 case 1 break default break eae if isBar bar return m_footi else return Kernighan amp Ritchie 0 Linux _ GNU JAVA Source format style general setup A formatted source example will be displayed in the field to the right If none of the predefined styles is to your liking you may click the top User defined radio button and define your own source formatting style preferences on the other two tabs which will become available then NOTE Currently only the predefined source formatting styles will be demonstrated by an example text If you decide to define your own style no example display will be available You have to experiment on an actual source text to tailor the settings to your liking 4 1 9 2 Indentation Style Setup Proper indentation is the main means to enhance readability of a source text I you selected t
231. uch an analyze run It is used e g to find memory leaks Security Problems There is a Security Checker plugin tool for KDevelop It analyzes the currently edited source file for several common security prob lems which may occur in the application and notifies the user in this tool view window Breakpoints This tool view allows to explicitly set clear and manage debug breakpoints in the application source files It is used in conjunction with the debugger CTags Allows to create a database of identifier indexes using the popular CTags application This tags database may then be used from out this tool view window to look up any needed identifier in the project sources Click ing a thus found item line will open an editor window and position the cur sor on the appropriate identifier there Problems KDevelop keeps track of common programming problems in the currently edited source file and notifies the user in this tool view window 2 3 3 3 Source Management right side Automake Manager The Automake Manager tool is basically a graphical front end to maintain the contents of the Makefile am files located in each project directory This tool view uses two windows to control its work The upper window mirrors part of the project subdirectories namely those 22 KDevelop User Manual which explicitly contain project files Each subdirectory of this kind must con tain a Makefile am file and is termed a subproject in the Automake Mana
232. ures appear in the similar way as in the source code so they are easily readable Alternatively you can decide to see mangled names Try Setting Breakpoints on Lib Load The debugger backend gdb does not al low to set breakpoints within code that is not currently loaded In a highly modular application where often code is only loaded on demand as a plugin using the libc function dlopen 3 this can be inconvenient Therefore KDevelop rolls its own support for breakpoints in shared li braries If you set this option it allows you to set breakpoints in li braries which are not loaded Then whenever gdb notifies that a library is loaded KDevelop tries to set the pending breakpoints Enable Floating Toolbar to be written 152 KDevelop User Manual Chapter 13 Using CVS 13 1 CVS Basics CVS is the revision control system which many open source projects including KDE are using It stores all sources codes in a central place called the repos itory From the repository developers can check out a current version of the project or snapshots of it at arbitrary points of time In contrast to some other revision control systems it is not necessary to lock files one wants to work on So development can be highly parallelized Whenever a developer has finished a task he commits his code accompanied by a log message CVS takes the job to merge the changes made by several developers It can of course happen that deve
233. use and the type of the application you want to build from a set of predefined templates 105 KDevelop User Manual 2 Supply some general information as application name directory where the application shall be built etc 3 Decide whether you want to use a version control system like e g CVS and supply the necessary data if needed 4 Set up some templates for initial header and source files if applicable 5 Finally tell Application Wizard to set up all initial stuff directory struc ture starting header source file templates and management tools like e g an initial make skeleton etc Voil that s all Application Wizard will have provided you with a primary functional set of programming files where you can readily start working Let s look at all this in more detail now 5 1 1 Initial Steps To create a new project in KDevelop select New Project from the Project menu The Create New Project dialog will pop up showing an initial General page 106 KDevelop User Manual Create New Project General al Projects Ada c Database Fortran Haskell Java Pascal Perl PHP Python Ruby Shell gi Show all project templates r Properties Application name Location home devel projects Final location home devel projects invalid X Cancel Initial dialog to set up a new project As you see this dialog is divided
234. velop make f Makefile svn before you proceed with all of the following steps A 3 2 2 Basic make Command Sequence Once the basic make system is set up you must decide which type of the KDe velop system you want to use This is done in the following configure step which builds the actual Makefiles the make command will use NOTE You may drop the prefix option in the following configure command lines if you want KDevelop be installed in the default KDE directory See the Some notes on configure options chapter for this 161 KDevelop User Manual A Debug Compiled Version If you want to keep track of what your KDevelop application does at run time you may build a debug compiled version Just command configure to do so kde3src kdevelop gt configure enable debug full prefix where your kde3 is A Release Compiled Version If you only want to use KDevelop as is a smaller and faster running release version suffices configure defaults to this kde3src kdevelop configure prefix where your kde3 is NOTE If you want to build your own API documentation for KDevelop you must in clude yet another option in the configure command kde3src kdevelop configure options as above V with kdelibsdoxy dir KDEDIR share doc HTML en kdelibs apidocs Make and Install KDevelop configure will check the system and build some Makefiles according to what it found The make command will use the main Make
235. velopment Environment to be used for a wide variety of programming tasks KDevelop User Manual Chapter 1 What This Manual Contains This user manual is intended to describe the contents and use of the KDevelop 3 3 91 Integrated Development Environment IDE from a user s point of view It is not a programming manual nor does it describe the development process in detail Its only aim is to guide you in the handling of the IDE Here you will find information on the following topics Getting Started with KDevelop a Guided Tour Gives youa quick start on the use of this IDE introducing the basic steps of how to work on a project Overview of the Features of KDevelop Extends the guided tour in the previ ous chapter giving an overall view of what is built in within KDevelop and gets you acquainted with the look and feel of this IDE Configuring KDevelop Shows how you can tailor the IDE to suit your needs Getting started the Application Wizard Describes the basics of how to set up anew project in KDevelop using the built in Application Wizard Editing tools All you need to write your source files using the editor search ing for text both locally and project wide up to integrating new files and classes into the project The File Browsers Demonstrates various tools to look at the structure of your project and how to access the files you want to work with The Class Browsers Describes one of the most powerful tools of KDeve
236. want to use As you might have noticed the applications manager did readily fill in some information you provided on the first General page of the Create New Project dialog namely the contents of the Author and Email fields Also proper license information will have been inserted according to your selection in the License tab 5 1 3 1 How to Edit the Templates The templates you set up in the Create New Project dialog will later be pro cessed whenever you command KDevelop to set up a new source and or 116 KDevelop User Manual header file The information you provided here will be included at top as a documentation header before the code parts begin You are not restricted to plain text however KDevelop knows of several vari ables which allow you to include actual information in the file The Applica tion Wizard did in fact use some such variables to insert the Author Email and License informations into the initial template text Include Doxygen File Information If for example you want the Doxygen built API documentation to display some further information about the file s contents in its filenames list you may include the following lines in the source file template file MODULE cpp brief put some short descripion here Whenever you create a new source file KDevelop will replace the MOD ULES variable by the name body of the newly created file For example if you created a new C c
237. wn in the following chapters 5 4 2 Supply Version System Information In a second step the Application Wizard will lead you to the Version Control System page where you can decide which version control system you want to use NOTE This discussion concentrates on the needs for project creation only For more infor mation on CVS see the Using CVS chapter below No Version Control System Wanted Initially there is None selected in the Version control system tab and the page will be empty otherwise If you don t want to use a version control system just click the Next gt button and go on Using CVS Otherwise you must reselect the version control system you want to use from the Version control system tab We use CVS for our example If you select this the Application Wizard will redisplay the page now showing a series of fields you must fill in 111 KDevelop User Manual 43 Create New Project Version Control System Version control system CVS X X Create module in the repository Repository pserver usen cvs project org 2401 home kde M Login to Repository Init Local Repository Module myapp Vendor tag vendor Release tag start Comment First Import l lt Back Next gt Cancel Set new project up for CVS A version control system such as CVS which means Concurrent Versions Sys tem stores copies of selecte
238. ww graphviz org This tool is needed in conjunction with Doxygen below if you want to have class rela tionships graphically displayed which is highly recommended The Doxygen documentation tool from http www doxygen org if you want to generate concise and powerful API documentation from your projects valerind from http developer kde org sewardj helps you to find mem ory management problems in your applications sun from http subversion tigris org if you want to use the svn versioning system Any other compiler and or tool in case you want to develop for another language platform than C KDE or use some special facility NOTE 1 You can to a certain extent circumvent the need for autoconf amp 8805 2 52 and automake amp 8805 1 6 Just remove the admin directory in your KDe velop installation directory and type your kdevelop directory ln s SKDEDIR share apps kdelibs admin admin at the console This causes KDevelop to use the standard settings in the KDE admin directory instead 2 Be careful not to mix Qt versions Always link KDevelop to the same Qt M version your KDE library was compiled Otherwise you will most likely expe rience very strange behaviours A 3 KDevelop Compilation and Installation Once all requirements are met you are ready to compile and install KDevelop This appendix will discuss the necessary steps to do so Preliminary Steps tells you about setting up a prop
239. xed to perform a full text search because they usually point to a remote location On the other hand such a toc file can have an index manually defined using the index tag Thus the Index check box will be enabled ony when KDevelop finds an index tag in the toc file For more detail see the description below in the KDevelop TOC Files section The Search check box in the setup table will alway be disabled You may add new entries using the buttons to the right of the list field KDe velop will filter toc files in the directory dialog associated to the Add and Edit buttons NOTE Other than former KDevelop versions will the Remove button not change the toc files on disk so the remove operation is safe now 99 KDevelop User Manual 4 2 1 6 KDevelop TOC Files There is a special feature associated with this To illustrate follow these steps In the documentation tree find an entry shortly below the Qt KDE docu mentation e g KDE2 Development Book kde org Click on the plus sign next to it A tree will open where you can quickly navigate to subsequent chap ters nested several levels deep all offline But if you finally select one of the chapters KDevelop will in many cases try to access a remote documentation file The rationale behind this is not only to locally navigate remote documenta tion without wasting net access ressources but to provide the developer with easy structured access to the
240. y empty They will get populated once there is a project open for actual work Status Bar Finally there is a status bar on the bottom of the window where short informations on several tasks will be shown 2 1 2 How to Get Some Help Besides the Help menu which offers answers to specific questions the status bar and two kinds of tool tips provide some quick information What Does This Menu Entry Do When you place the mouse cursor on a menu entry there will usually some short information be displayed in the sta tus bar While in most cases this repeats just the name of the selection in some cases it will provide additional information about the purpose of the menu command KDevelop User Manual What Is the Name of This Item On many items a short function name tool tip will pop up when you place the cursor on it for a few seconds This is useful for quick orientation on toolbar or tool view tabs in IDEA mode when the IDE has been set up to display icons only on these buttons What Does This Item Do More information is available through expanded tool tip help for many items on the IDE Select Help What s This or press Shift F1 then with the question mark cursor select the item you want to know more of You can as well open any menu this way and click on a specific menu entry active as well as greyed disabled ones to see if more information is available 2 1 3 What is in the menus There are ten menus selectable on the menub

KDevelop User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents