Archive:Getting Started/Increased Productivity in KDE4 with Scripts (zh CN)

Getting_Started/Increased Productivity in KDE4 with Scripts

Increasing Your Productivity With Scripts

Tutorial Series	Getting Started
Previous	[[../Build/KDE4]]
What's Next	n/a
Further Reading	Original presentation by David Faure

Abstract

Time is precious. This tutorial shares David Faure's collected wisdom for how to get the most of our time and effort by saving on both using some simple scripts and techniques while developing KDE 4.

Setting Up the Environment

Why install as user and not as root?

a single command to compile+link+install (or even a single key in your editor), no su/sudo needed
no risk of root-owned files in the builddir, as can happen when some change forces make install to recompile some files
safer if something goes wrong (for instance, using the wrong prefix would overwrite the system kde3)
make install is faster than "make && sudo make install" since the Makefiles are parsed only once
no link errors during sudo make install due to root's environment missing entries in LD_LIBRARY_PATH. Really, setting up the environment once is hard enough, why do it for two users?

Set up for development

If you really want to use a separate account for development, see [[../Build/KDE4#Set_up_the_development_user_account|here]].

But to save time and avoid many problems, it is strongly recommended to do it all from your usual user. All you need is an easy way to switch between environments. You go to ~/kde/src/4, you want to be in the kde4 environment, right?

To do this, paste http://web.davidfaure.fr/scripts/cd_function into your .zshrc or .bashrc, and put http://web.davidfaure.fr/scripts/findup in your $PATH.

This way, whenever you enter a directory, it will look up a .my-setup file and source it (it also looks up in parent directories until it finds one, and it doesn't source the same one twice in a row).

Set up all the environment variables that are specific to kde4 (they will be detailed later on in this page) into that ~/kde/src/4/.my-setup file, and do the same for other environments (kde3, and anywhere you need project-specific environment variables...)

Example paths

Qt

For Qt, by habit from the Qt3 times and to save time by avoiding "make install" after a change, I recommend using one directory for source, builds and install. This is done by configuring Qt with --prefix=$PWD. This isn't mandatory though.

Qt-Path: ~/qt/4/qt-copy

KDE

It was convenient in kde3, it is mandatory in kde4: you need to use out-of-source builds, i.e. separate build and source directories. It makes it very easy to rebuild from scratch, removing all generated files - even old ones that "make clean" wouldn't remove. It is easier to look at the source files (grep, ls etc.). It allows multiple build trees with different settings, e.g. debug and release.

Source: ~/kde/src/[version]
Build: ~/kde/build/[version]

Thus source modules for kde4 are checked out in ~/kde/src/4/ and building happens in ~/kde/build/4/.

Environment Variables and other helpful functions

Bash

If you use bash, take a look at this .bashrc. It is an example bash config which sets all KDE4 environment variables and some helper functions.

The steps below describe some of these features as well as giving alternative and additional functions.

Read further about compiling a KDE module.

Directory navigation

To easily swap from build and source folder back and forth, you can use cs and cb functions that work like the following: pwd

~/kde/src/4/kdebase

cb && pwd

~/kde/build/4/kdebase
# note that this folder is created if it does not exist

cs && pwd

~/kde/src/4/kdebase

A number of kde-related scripts will have to be able to do the same. Simply do: export OBJ_REPLACEMENT='s#/kde/src/#/kde/build/#' This allows the makeobj script from kdesdk to switch from src to build. If you also do: alias make=makeobj then you can simply type make from the source dir and it will be able to build. This is also very useful in editors - if your vi or emacs uses makeobj as the make command, you can compile with a single key press.

In addition, for fast navigation to other directories, it is very convenient to be able to type "cs 4/kdelibs" in order to go to ~/src/4/kdelibs, from anywhere. For instance, you could be in ~/kde/src/4/kdebase/workspace/kcontrol and now you decide to look at kdecore... No need to type a long series of "../.." or to restart from the top. You can just type cs 4/kdelibs/kdecore.

This is doable via the two functions cs and cb defined in the .bashrc.

Alternative

The following code will enable you to use cd similar to cs described above: export CDPATH=.:~/kde/src The advantage, when using zsh, is that completion even works. Try cd 4/kdemul and press Tab, it will complete to 4/kdemultimedia, no matter where you currently are. Doesn't work in bash though - but surely you're using zsh by now, aren't you? :)

The minimal cs and cb aliases (same as above but without support for arguments) are: alias cb='cd `pwd | sed -e s,/kde/src/,/kde/build/,`' alias cs='cd `pwd | sed -e s,/kde/build/,/kde/src/,`'

Going back to the previous directory

Going back to the previous directory easily can be done with zsh. Set this in .zshrc: setopt AUTO_PUSHD alias p=popd and then you can type "p" to pop back to the directory where you were last, as many times as needed (type "dirs -v" to see the stack of previous directories).

CMake

CMake and subdirs

cd 4/kdelibs/kio/kio ; make => nothing happens, the Makefile is in the parent directory.

Make your editor use a wrapper script instead

!/bin/sh

if test "$1" = "-k"; then shift; fi
cmake_in_parent=0
if test -f CMakeLists.txt; then

   if ! grep -q kde4_add CMakeLists.txt; then
       cmake_in_parent=1
       cd ..
   fi

fi
if test $# -gt 0; then

   arg="$1"
   if test "$arg" != install -a $cmake_in_parent -eq 1; then
       arg=`basename $PWD`/"$arg"
   fi

fi

jvalue=1 echo "calling makeobj -j $jvalue $arg" makeobj -j $jvalue $arg

Get this script: http://web.davidfaure.fr/scripts/makefromemacs.

CMake and dependencies

touch kdecore/kapplication.h
cd kdeui ; make

=> recompiles kdecore first

touch kdecore/kapplication.h
cd kdeui ; make kdeui/fast

=> recompiles only kdeui

make install/fast

But note that the normal mode (without /fast) is also useful in other cases: For instance you edit

kdelibs/kio/kio/kdirmodel.cpp

and the unit test for it

kdelibs/kio/tests/kdirmodeltest.cpp

Then, to recompile both libkio and the unit test, simply do "make kdirmodeltest" from kdelibs/kio/tests.

List of KDE 4 environment variables

This lists all the environment variables you should set, for instance in $KDESRC/4/.my-setup

Qt

export QTDIR=/d/qt/4/qt-copy export PATH=$QTDIR/bin:$PATH export LD_LIBRARY_PATH=$QTDIR/lib:$LD_LIBRARY_PATH export PKG_CONFIG_PATH=$QTDIR/lib:$PKG_CONFIG_PATH

KDE

export KDEDIR=/d/kde/inst/kde4 export PATH=$KDEDIR/bin:$PATH export LD_LIBRARY_PATH=$KDEDIR/lib:$LD_LIBRARY_PATH export QT_PLUGIN_PATH=$KDEDIR/lib/kde4/plugins export KDEDIRS=$KDEDIR

User

export KDEHOME=$HOME/.kde4

Others

export QTEST_COLORED=1 export KDE_COLOR_DEBUG=1

Compiling a KDE module

Manually

If you use the aforementioned ~/.bashrc it is very convenient to compile a KDE module (it is required to already have aquired the source code, e.g. via SVN. see Using Subversion with KDE): cs KDE/kdebase cmakekde

Else you'll have to do the following: mkdir -p ~/build/KDE/kdebase && cd ~/build/KDE/kdebase cmake -DKDE4_BUILD_TESTS=TRUE -DCMAKE_BUILD_TYPE=debugfull \ -DCMAKE_INSTALL_PREFIX=~/kde ~/src/KDE/kdelibs make

Tip

Never delete CMakeCache.txt and then type make; always re-run cmake with the correct options after deleting CMakeCache.txt.

Using kdesvn-build

kdesvn-build is an all-in-one script: it handles the checking-out or updating from subversion, running cmake, make, make install, and storing all output in log files.

Copy kdesvn-buildrc-sample to $KDE_SRC/.kdesvn-buildrc, then edit it. Global options:

binpath - don't forget the path to icecream, the PATH env var doesn't count
qtdir, svn-server, source-dir, build-dir, kdedir

Per-module options:

module qt-copy
  # kdesvn-build sets the prefix to $qtdir
  configure-flags [....]
  apply-qt-patches true
  make-options -j3 sub-src sub-tools
end module

module kdelibs
  make-options -DKDE4_BUILD_TESTS=TRUE -DCMAKE_BUILD_TYPE=debugfull
end module

KDE4 programs in KDE3

Xephyr -screen 1240x768 -ac :4 &
export DISPLAY=:4
sh -x startkde 2>&1 | tee kde4.log

>./list-kde4-binaries
/d/kde/inst/kde4/bin/kwin, pid 6756
/d/kde/inst/kde4/bin/kpersonalizer, pid 6757

>./kill-kde4-binaries
Killing /d/kde/inst/kde4/bin/kwin, pid 6756
Killing /d/kde/inst/kde4/bin/kpersonalizer, pid 6757

You can get the scripts list-kde4-binaries and kill-kde4-binaries from http://web.davidfaure.fr/scripts/