KDE TechBase - User contributions [en]

Getting Started/Build/KDE4/Windows

2013-02-12T20:27:56Z

Jstaniek: Redirected page to Getting Started/Build/Windows/emerge

#REDIRECT [[Getting_Started/Build/Windows/emerge]]

Getting Started/Build/Windows

2013-02-12T20:26:44Z

Jstaniek: Redirected page to Getting Started/Build/Windows/emerge

#REDIRECT [[Getting_Started/Build/Windows/emerge]]

Policies/Library Code Policy

2012-12-05T19:51:13Z

Jstaniek: update link to http://wiki.qt-project.org/index.php?title=API_Design_Principles

This document describes some of the recommended conventions that should be applied in the KDE libraries (not applications). Respecting these guidelines helps create a consistant API and also may help ease maintainence of the libraries later. While these conventions are not mandatory, they are important guidelines, and should be respected unless you have a good reason to disregard them.

As an introduction, you should read the document [http://wiki.qt-project.org/index.php?title=API_Design_Principles Qt-Style C++ API Design Principles].

For kdelibs, it is recommended to follow the [[Policies/Kdelibs_Coding_Style | Kdelibs Coding Style]].

== Naming Conventions ==
In KDE, we basically follow the same naming conventions as Qt.

Class names starts with a capital K. The rest is in camel case. Function names starts with a lower case, but the first letter of each successive word is capitalized.

Unless dealing with central libraries (kdecore, kdeui), classes should be in the library namespace. In that case, it is the namespace which starts with K and the classes inside may not start with it. New libraries should choose their namespace.

The prefix 'set' is used for setters, but the prefix ''''get'''' is not used for accessors. Accessors are simply named with the name of the property they access. The exception is for accessors of a boolean which may start with the prefix ''''is''''.

Acronyms are lowercased too. Example:
<tt>KUrl</tt> instead of <tt>KURL</tt> and <tt>isNssEnabled()</tt> instead of <tt>isNSSEnabled()</tt>

Accessors should usually be <tt>const</tt>.

This example shows some possible functions names
<source lang="cpp-qt">
public:
void setColor(const QColor& c);
QColor color() const;
void setDirty(bool b);
bool isDirty() const;

private Q_SLOTS:
void slotParentChanged();
</source>
Make one public class for every .h file. Add the <tt>_EXPORT</tt> macro related to the library they are in.
Private classes should be declared in the .cpp file, or in a _p.h file.

== D-Pointers ==
In order to more easily maintain binary compatibility, there shouldn't be private members in a public class. For more information about binary compatibility, read [[Policies/Binary_Compatibility_Issues_With_C++|Binary Compatibility Issues With C++]].

By convention, the private class will be named the same as the public class, with <tt>Private</tt> appended to the name.
<source lang="cpp-qt">
class KFooPrivate;
class KFoo
{
public:
/* public members */
private:
const QScopedPointer<KFooPrivate> d;
};
</source>
In the .cpp file:
<source lang="cpp-qt">
class KFooPrivate
{
public:
int someInteger;
};

KFoo::KFoo() : d(new KFooPrivate)
{
/* ... */
}

KFoo::~KFoo()
{
// You must define a non-inline destructor in the .cpp file, even if it is empty
// else, a default one will be built in placed where KFooPrivate is only forward
// declare, leading to error in the destructor of QScopedPointer
}
</source>
Notice that the member d is <tt>const</tt> to avoid modifying it by mistake.

If you are implementing an implicitly shared class, you should consider using {{qt|QSharedData}} and {{qt|QSharedDataPointer}} for d.

Sometimes, complex code may be moved to a member method of the Private class itself. Doing this may give the compiler an extra register to optimize the code, since you won't be using "d" all the time. Also, remember to '''inline''' such methods if they are called only from one place.

=== Shared D-Pointers ===

If your class hierarchy is large and/or deep, you may want to try the concept of shared d-pointers. You'll be trading the added complexity for a smaller memory footprint in the main object (there will be only one "d" variable in it). Other advantages include:

:* direct access to the private data of the whole hierarchy (in other words, the Private classes are in fact "protected", not "private")
:* access to the parent's d-pointer methods

The latter advantage is especially useful if your class has moved the code from the main class to the Private class. If that's the case, you should be calling the Private methods instead: since they are not exported, they will create simpler relocations in the final library (or none at all). By simply calling the Private method instead of the public one, you contribute to a faster load-time of your library.

To implement a "shared d-pointer", you need to:
:# define a '''protected''' variable (d_ptr) in the least derived class of your hierarchy
:# in each class of the hierarchy, define a '''private''' function called d_func() that reinterpret_casts that d_ptr to the current class's Private class
:# use Q_D(Foo) at the beginning of the functions to have access to a variable "d"
:# the private classes derive from one another just like the public hierarchy; they also have virtual destructors
:# add one extra, protected constructor that takes the private class as a parameter
:# in each constructor for all derived classes, call the parent's constructor that takes the d pointer as a parameter

There's an example of such a construct in a [[/Shared_D-Pointer_Example|separate page]].

=== Q_DECLARE_PRIVATE ===

This is a handy macro that hides the ugly stuff for you. It creates the <tt>d_func()</tt> function for you, using the variable called <tt>d_ptr</tt>. If yours has that name, you can use this macro. If it has another name, maybe you should create a macro to make your code look nicer.

=== Q-Pointers ===

Q-pointers are like d-pointers, but work in the reverse direction: they are in the Private class and they point to the public class. Needless to say, this is only possible for classes that don't share their d-pointers. Examples of classes that might benefit from q-pointers are all those derived from QObject, while classes with implicit sharing are those that potentially can't use it.

Q-pointers are especially useful if your class has moved most of the code to the Private class as recommended. In that case, you may need to emit signals from the Private class. You would do it as:

<source lang="cpp-qt">
emit q->signalName();
</source>
(You need to declare the Private class a friend of your public one; Q_DECLARE_PRIVATE does that for you)

Q-pointers may also use the a shared q-pointer technique just like [[#Shared D-Pointers|d-pointers]] can. What's more, Qt also provides a macro called <tt>Q_DECLARE_PUBLIC</tt> and one <tt>Q_Q</tt> to hide the ugly parts of the implementation.

== Inline Code ==
For binary compatibility reasons, try to avoid inline code in headers. Specifically no inline constructor or destructor.

If ever you add inline code please note the following:
* Installed headers should compile with the following preprocessor defines: <tt>QT_NO_CAST_FROM_ASCII</tt>, <tt>QT_NO_CAST_TO_ASCII</tt>, <tt>QT_NO_KEYWORD</tt>. So don't forget {{qt|QLatin1String}}.
* No C casts in the header. Use <tt>static_cast</tt> if types are known. Use <tt>qobject_cast</tt> instead of <tt>dynamic_cast</tt> if types are QObject based. dynamic_cast is not only slower, but is also unreliable across shared libraries.
* In general, check your code for [[Development/Tutorials/Common_Programming_Mistakes|common mistakes]].

These recommendations are also true for code that are not in headers.

== Flags ==
Try to avoid meaningless boolean parameters in functions. Example of a bad boolean argument:
<source lang="cpp-qt">
static QString KApplication::makeStdCaption( const QString &caption,
bool withAppName,
bool modified);
</source>

Because when you read code that uses the above function, you can't easily know the significance of the parameters

<source lang="cpp-qt">
window->setCaption(KApplication::makeStdCaption( "Document Foo",
true, true));
</source>

The solution is to use {{qt|QFlags}}. If the options only apply to one function, call the <tt>enum FunctionNameOption</tt> and the QFlags typedef <tt>FunctionNameOptions</tt>. Do that even if there is only one option, this will allow you to add more options later and keep the binary compatibility.

So a better API would be:
<source lang="cpp-qt">
class KApplication
{
public:
/* [...] */
enum StandardCaptionOption {
/**
* Indicates to include the application name
*/
WithApplicationName = 0x01,
/**
* Note in the caption that there is unsaved data
*/
Modified = 0x02
};
Q_DECLARE_FLAGS(StandardCaptionOptions,
StandardCaptionOption)

/**
* Builds a caption using a standard layout.
*
* @param userCaption The caption string you want to display
* @param options a set of flags from MakeStandartCaptionOption
*/
static QString makeStandardCaption(const QString& userCaption,
const StandardCaptionOptions& options = WithApplicationName);
/* [...] */
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KApplication::StandardCaptionOptions)
</source>

== Const References ==
Each object parameter that is not a basic type (int, float, bool, enum, or pointers) should be passed by reference-to-const. This is faster, because it is not required to do a copy of the object. Do that even for object that are already implicitly shared, like QString:

<source lang="cpp-qt">
QString myMethod( const QString& foo,
const QPixmap& bar,
int number );
</source>

'''Note:''' Avoid const references for return types though. Returning for example
<source lang="cpp-qt">
const QList<int> &someProperty() const;
</source>
means exposing the internal data structure for someProperty() and it's very difficult to change it in the future while preserving binary compatibility. Especially for implicitly shared objects the one refcount that one avoids by returning a const reference is often not worth it the exposure of implementation.

There are cases where it makes sense, where performance is absolutely critical and the implementation is very fixed. So think twice about it and consider returning a value instead:
<source lang="cpp-qt">
QList<int> someProperty() const;
</source>

== Signals and Slots ==
In the libraries, use <tt>Q_SIGNALS</tt> and <tt>Q_SLOTS</tt> instead of <tt>signals</tt> and <tt>slots</tt>. They are syntactically equivalent and should be used to avoid conflicts with boost signals, and with python's use of "slots" in its headers.

== Properties ==
Consider using <tt>Q_PROPERTY</tt> for properties. The reason is that properties (especially those marked <tt>SCRIPTABLE</tt>) will be accessible through the javascript interface.

If you follow the propname / setPropname naming scheme, moc sets a special flag for the {{qt|QMetaProperty}}.

== Explicit Constructors ==
For each constructor (other than the copy constructor), check if you should make the constructor <tt>explicit</tt> in order to minimize wrong use of the constructor.

Basically, each constructor that may take only one argument should be marked <tt>explicit</tt> unless the whole point of the constructor is to allow implicit casting.

== Avoid including other headers in headers ==
Try to reduce as much as possible the number of includes in header files. This will generally help reduce the compilation time, especially for developers when just one header has been modified. It may also avoid errors that can be caused by conflicts between headers.

If an object in the class is only used by pointer or by reference, it is not required to include the header for that object. Instead, just add a forward declaration before the class.

In this example, the class KFoo uses KBar by reference, so we do not need to include KBar's header:
<source lang="cpp-qt">
#include <kfoobase.h>
class KBar;
class KFoo : public KFooBase
{
public:
/* [...] */
void myMethod(const KBar& bar);
};
</source>

== Getting #includes right ==

There are two types of #include statements: <tt>#include <foo.h></tt> and <tt>#include "foo.h"</tt>.

Say we have the file <tt>xyz.h</tt> in <tt>/usr/include/mylib/</tt> that contains the following:
<source lang="cpp-qt">
#include <header1.h>
#include "header2.h"
</source>

The preprocessor will search for the file <tt>header1.h</tt> in all the paths given as <tt>-I</tt> arguments and then replace the line with the contents of that file.

For line 2 the preprocessor tries to use the file /usr/include/mylib/header2.h first and if it does not exist search for the file like it did for <tt>header1.h</tt>. The important part to note here is that the preprocessor does not look in the directory of the source file that includes <tt>xyz.h</tt> but in the directory where <tt>xyz.h</tt> resides.

Now, which include statement is the one to use? After all you can specify every directory you want using <tt>-I</tt> (or rather CMake's <tt>include_directories()</tt>) and thus could use <tt>#include <...></tt> everywhere.

=== As application developer ===
* Include headers from '''external''' libraries using '''angle brackets'''.
<source lang="cpp-qt">
#include <iostream>
#include <QtCore/QDate>
#include <zlib.h>
</source>
* Include headers from your '''own project''' using '''double quotes'''.
<source lang="cpp-qt">
#include "myclass.h"
</source>
Rationale: ''The header files of external libraries are obviously not in the same directory as your source files. So you need to use angle brackets.''

''Headers of your own application have a defined relative location to the source files of your application. Using KDE4's cmake macros your source directory is the first include switch to the compiler and therefore there's no difference in using angle brackets or double quotes. If you work with a different buildsystem that does not include the current source directory or disable CMAKE_INCLUDE_CURRENT_DIR then all includes (inside your application) using angle brackets will break.''

''Ideally the buildsystem would not need to specify <tt>-I<source directory></tt> though as that can break with library headers that have the same filename as a header of your project (i.e.: If a library has the header file <tt>foo.h</tt> and your project has a different file with the same filename the compiler will always pick the header from your project instead of the one from the library because the source directory of the project is specified first.)''

=== As library developer ===
* Include headers from '''external''' libraries using '''angle brackets'''.
<source lang="cpp-qt">
#include <iostream>
#include <QtCore/QDate>
#include <zlib.h>
</source>
* Include headers of your '''own library''' and libraries that belong to it using '''double quotes'''.
<source lang="cpp-qt">
#include "xyz.h" // same library and same directory
</source>

Rationale: ''The header files of external libraries are obviously not in a fixed location relative to your source files. So you need to use angle brackets.''

''Headers of your own libraries have a fixed relative location in the filesystem. Therefore you'' can ''use double quotes. You should use double quotes because otherwise the include statement could include a different header file than expected. An example how angle brackets can break the build:''

''<tt>/usr/include/libxyz/xyz.h</tt> includes <tt>foo.h</tt> using angle brackets and expects to have it replaced with the contents of the file <tt>/usr/include/libzyx/foo.h</tt>. Assuming there's another library that also ships a <tt>foo.h</tt> file in the directory <tt>/usr/include/anotherlib/</tt>. If the application that uses both libraries compiles with "<tt>g++ -I/usr/include/libxyz -I/usr/include/anotherlib ...</tt>" libxyz will work as expected. If the application compiles with "<tt>g++ -I/usr/include/anotherlib -I/usr/include/libxyz ...</tt>" the header <tt>xyz.h</tt> will include the file <tt>/usr/include/anotherlib/foo.h</tt> instead of the file that is shipped with libxyz. The same problem can appear if an application has a header file of the same name as a library and specifies <tt>-I./</tt> as the first include directory.''

=== Include order ===

Another important aspect of include management is the include order. Typically, you have a class named Foo, a file foo.h and a file foo.cpp . The rule is :

: ''In your file foo.cpp, you should include "foo.h" as the first include, before the system includes.''

The rationale behind that is to make your header standalone.

Let's imagine that your foo.h looks like this:
<source lang="cpp-qt">
class Foo
{
public:
Bar getBar();

};
</source>

And your foo.cpp looks like this:
<source lang="cpp-qt">
#include "bar.h"
#include "foo.h"
</source>

Your foo.cpp file will compile, but it will not compile for other people using foo.h without including bar.h . Including "foo.h" first makes sure that your foo.h header works for others.

=== Include guards ===
Header files should use guards to protect against possible multiple inclusion.
Your myfoo.h header should look like this:
<source lang="cpp-qt">
#ifndef MYFOO_H
#define MYFOO_H
... <stuff>...
#endif /* MYFOO_H */
</source>

To be even more careful, you may want to encode a namespace or subdirectory name (e.g. KFOO) into the guard macro name, for example: MYFOO_H, KFOO_MYFOO_H, or _KFOO_MYFOO_H_ are all acceptable macro names. By convention, the macro name should be all uppercase; but that is not a firm requirement.

== Static Objects ==
Global static objects in libraries should be avoided. You never know when the constructor will be run or if it will be run at all.
; Wrong
<source lang="cpp-qt">
static QString foo; // wrong - object might not be constructed
static QString bar("hello"); // as above
static int foo = myInitializer(); // myInitializer() might not be called
</source>
In particular, never construct QObject-derived objects this way. On Windows (MS Visual C++) the object's internals will be left uninitialized within a library and will lead to crashes ([http://www.kdedevelopers.org/node/2889 more info]).
<source lang="cpp-qt">
static QFile myFile("abc"); // QFile inherits QObject
</source>
; Correct
<source lang="cpp-qt">
static const int i = 42;
static const int ii[3] = {1, 2, 3};
static const char myString[] = "hello";
static const MyStruct s = {3, 4.4, "hello"};
K_GLOBAL_STATIC(QFile, myFile);
</source>

You can use [http://api.kde.org/4.0-api/kdelibs-apidocs/kdecore/html/group__KDEMacros.html#g75ca0c60b03dc5e4f9427263bf4043c7 <tt>K_GLOBAL_STATIC</tt>] macro (and for QObject-derived objects you should) to create global static objects which will be initialized the first time you use them.

== Signal and Slot Normalization ==
Since <tt>QObject::connect</tt> uses a string-based comparison
of the function signature, it requires some normalization to take
place. It does that automatically for you, but it takes some CPU
time, so, if it doesn't hurt your code's readability, normalize
manually your SIGNAL and SLOT entries.

For example, you may have the following code:
<source lang="cpp-qt">
QObject::connect(this, SIGNAL( newValue(const QString&,
const MyNamespace::Type&) ),
other, SLOT( value(const QString &) ));
</source>
It would be preferable to write as follows:
<source lang="cpp-qt">
QObject::connect(this, SIGNAL(newValue(QString,MyNamespace::Type)),
other, SLOT(value(QString)));
</source>

Note the absence of extra whitespace and the
reduction of pass-by-reference-to-const parameters to simple
pass-by-value ones. The normalization may involve other
transformations, but these are the most common ones. Also note that
types in namespaces should always use the full qualified name.
To be sure what the proper normalization is, read the {{path|.moc}} file
generated for the class.

'''Note''': If you are unsure about the normalization, don't do it. Let
QObject do it for you (the performance penalty is negligible in most cases).

== External Dependencies ==
When a library pulls in a new external dependency due to a new feature or a change in implementation, it is highly preferred to make that dependency optional if at all possible. For some core features in a library this may not be possible, but usually it is even if the cost is a degradation in features when built without that dependency.

All dependencies should be adequately documented in the build system so that they appear in the summary post-configure.

For libraries in the '''kdelibs module''', this is a hard requirement: '''no new non-optional dependencies may be added, all new dependencies must be made optional at configure time'''. Exceptions may be granted for unusual circumstances by sending a request to the kde-core-devel at kde.org mailing list and getting a consensus decision to grant an exception there.

== Documentation ==
Every class and method should be well documented. Read the [[Policies/Library Documentation Policy|KDE Library Documentation Policy]] for the guidelines to follow when documenting your code.

Also don't forget the license headers and copyrights in each file. As stated in the [[Policies/Licensing Policy|Licensing Policy]], kdelibs code must be licensed under the LGPL, BSD, or X11 license.

Author: [mailto:ogoffart@kde.org Olivier Goffart] March 2006

[[Category:Policies]]

Development/CMake/DashboardBuilds

2012-06-27T12:46:59Z

Jstaniek: /* For which modules/packages are there dashboards ? */ KOffice -> Calligra (KOffice does not seem to exist there)

= What is a dashboard ? =

A dashboard can show the results of Nightly and Continuous builds of a software package. This includes warnings and errors from the configure and build process as well as the results of the executed tests belonging to the software package. This is not only displayed for one machine, but ideally for all supported operating systems such results are submitted, also with different configurations, e.g. one for a minimal system with most optional features disabled and one for a full featured system.

For KDE [http://www.cdash.org CDash-based] dashboards are set up at http://my.cdash.org, a service provided by [http://www.kitware.com Kitware]. CDash only displays the results, the actual building and testing is done decentral on other machines.
When failures occur, like build errors or failed tests, notification emails can be sent by CDash.
So by building and testing KDE each day on the supported platforms and collecting the results in a central place, we can make sure that KDE stays compiling and also working on all supported platforms.

You can help too to increase the quality by setting up a Nightly build and submitting the results to http://my.cdash.org.

= For which modules/packages are there dashboards ?=

Currently there are dashboards set up for all modules of KDE, and one for kdesupport. There are not yet dashboards for extragear.
If you are interested in setting dashboards up for these too, just go to http://my.cdash.org and do it, or ask on the kde-buildsystem mailing list if you have any questions.

So, here comes the list of currently existing KDE dashboards:

* kdesupport
** [http://my.cdash.org/index.php?project=kdesupport kdesupport]
** [http://my.cdash.org/index.php?project=automoc4 automoc4]
** [http://my.cdash.org/index.php?project=akonadi Akonadi]

* KDE
** [http://my.cdash.org/index.php?project=kdeaccessibility kdeaccessibility]
** [http://my.cdash.org/index.php?project=kdeadmin kdeadmin]
** [http://my.cdash.org/index.php?project=kdeartwork kdeartwork]
** [http://my.cdash.org/index.php?project=kdebase-apps kdebase/apps]
** [http://my.cdash.org/index.php?project=kdebase-runtime kdebase/runtime]
** [http://my.cdash.org/index.php?project=kdebase-workspace kdebase/workspace]
** [http://my.cdash.org/index.php?project=kdebindings kdebindings]
** [http://my.cdash.org/index.php?project=kdeedu kdeedu]
** [http://my.cdash.org/index.php?project=kdeexamples kdeexamples]
** [http://my.cdash.org/index.php?project=kdegames kdegames]
** [http://my.cdash.org/index.php?project=kdegraphics kdegraphics]
** [http://my.cdash.org/index.php?project=kdelibs kdelibs]
** [http://my.cdash.org/index.php?project=kdemultimedia kdemultimedia]
** [http://my.cdash.org/index.php?project=kdenetwork kdenetwork]
** [http://my.cdash.org/index.php?project=kdepim kdepim]
** [http://my.cdash.org/index.php?project=kdepimlibs kdepimlibs]
** [http://my.cdash.org/index.php?project=kdeplasma-addons kdeplasma-addons]
** [http://my.cdash.org/index.php?project=kdesdk kdesdk]
** [http://my.cdash.org/index.php?project=kdetoys kdetoys]
** [http://my.cdash.org/index.php?project=kdeutils kdeutils]
** [http://my.cdash.org/index.php?project=kdewebdev kdewebdev]
** [http://my.cdash.org/index.php?project=Calligra Calligra]

= How to set up a Nightly build =

Setting up a Nightly build and this way contributing to keep KDE working is not hard.

You need:
* A computer. It should be running the Nightly build ''every day'', at some time after 20:00 CET (for the Nightly builds the state of the repository at 20:00 CET is used).
* A KDE development environment installed on this computer, i.e.
** CMake >= 2.6.2, >= 2.8.0 is recommended for the Nightly builds (better warning and error reporting)
** Compiler etc.
** Subversion client
** Qt4 and the other required libraries for building KDE4
* Some time to maintain the Nightly build, i.e. to upgrade the required libraries, e.g. Qt4 when necessary, to install new required libraries etc.

== Under Unix ==

This applies to Linux, FreeBSD and other Unixes. It should also apply to Mac OSX, but this hasn't been tested yet.
You can figure out how to set up the Nightly builds yourself, but we have also something prepared to make it really easy. Let's assume you want to contribute a Nightly build for the kdeutils modules. That's how you do it:

* Go to http://my.cdash.org and register
* Once registered, subscribe to the kdeutils project
* Checkout trunk/quality/nightly-support/ from KDE svn. There, in the KDE/ subdirectory is a ctest-script ready to use for each KDE module.
* Write a shell script which sets the CMAKE_PREFIX_PATH environment variable so that CMake will find everything required and then execute ctest with the KDEUtilsNightly.cmake script. This will look something like the following:

<tt>
CMAKE_PREFIX_PATH=/opt/kde-qt:/opt/phonon:/what/ever/else/you/need
ctest -V -S /where/you/checked/out/KDE/KDEUtilsNightly.cmake,KDE_CTEST_BUILD_SUFFIX=gcc-4.2.3
</tt>

That's it basically. The -V option for ctest makes ctest verbose, so you can see what it's doing. The KDE_CTEST_BUILD_SUFFIX will be appended to the buildname displayed at http://my.cdash.org/index.php?project=kdeutils. Setting it to the used compiler is a sensible choice.

* Set up a cron job which runs this script every day:
<tt>
$ crontab -e
00 22 * * * /where/is/my/script/run_kdeutils_nightly.sh
</tt>

That's it. Probably you first want to run the script manually a few times until everything works, but after that you can just have it executed via cron.
The next day you should then see your results on http://my.cdash.org.

If you want to contribute Nightly builds for more than one KDE module, it gets a little bit more complicated. You have to make sure that the modules are built in the right order, and that the modules are installed correctly, if other modules depend on them. For examples see kdesdk/cmake/nightly-support/example-scripts/, e.g. [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/cmake/nightly-support/example-scripts/Nightlys-2.6.2 Nightlys-2.6.2] is the shell script I use on my machine to build (and install where necessary) all KDE modules on my Linux machine.

== Under Windows ==

Nobody has done this yet for KDE AFAIK, but it should be quite similar. If you intend to do this, please contact the kde-buildsystem mailing list, we will do our best to get it working quickly.

= How to get notification emails =

So, you don't want to/cannot submit a Nightly build, but you want to receive notification emails from CDash if the compilation of one of the projects fails or if test cases fail.

If that's the case, you need to
* Go to http://my.cdash.org and register. You will get a confirmation email.
* Once you have a valid login at http://my.cdash.org, go there
** Login
** Click the "My CDash" link in the top left corner
** Then, click "Show public projects"
** Search the project you are interested in and click "Subscribe"
** Go to the "Email preference" and "Email category" tabs and configure what emails you want to receive.

That's all. Now you should receive notification emails whenever problems in this project occur.

= TODO =

== More fine grained email notifications ==

In order to be really useful for KDE, we need more fine grained email notifications. CDash supports "subprojects", and users can register to get emails just for subprojects. Setting up these subprojects currently needs quite some manual work: http://www.kitware.com/products/html/CDashSubprojects.html

It would be nice to have a CMake command which takes a list of project()-names and generates the CDash-subproject files, with correct dependencies etc. for them. This needs work in CMake itself.

== Extended viewing methods in CDash ==

Currently in CDash you can see everything for one project at once.
For KDE we need an additional mode: see everything for one operating system or submitted by one host, also to multiple projects, at once. This way e.g. our Windows contributors would have a quick way to get an overview how KDE is doing on Windows today. This needs work in CDash.

== Dependent builds ==

Building of some modules should be triggered when other modules have changed, e.g. when kdelibs has been built all other modules should be built. This needs work on the CTest-scripts which drive the Nightly builds.

= How to get help=

If you have any questions regarding Nightly or Continuous builds for KDE or about CDash or CTest in general, please ask on the [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem] or [https://mail.kde.org/mailman/listinfo/kde-core-devel kde-core-devel] KDE mailing lists, or also on the [http://public.kitware.com/cgi-bin/mailman/listinfo/cdash CDash mailing list].

Development/Git/Configuration

2012-06-18T19:53:43Z

Jstaniek: /* Multiple Work Branches */

== Git Configuration ==

How to set up Git for use in KDE.

=== Quick Start ===

To quickly set up git to just build a copy of KDE you do not need to perform any git configuration, however the following steps will simplify using Git:

* [[../Configuration#URL_Renaming|URL Renaming]]

If you plan to commit to a KDE repository using Git then you should follow all the steps on this page.

=== Configuration Levels ===

Your Git configuration operates at 3 levels:
* System
* User
* Repository

The System Level sets up global Git configuration defaults for every User and Repository on your system. We will ignore these for our purposes as they are usually blank.

The User Level (aka Global) sets up the default configuration for a particular User to apply to all repositories used by that User. Settings made at this level will always override any matching System Level settings. The User Configuration is stored in your ~/.gitconfig file.

The Repository Level sets up the configuration for a particular Repository clone. Settings made at this level will always override any matching User or System Level settings. The Repository Configuration is stored in the repository .git/config file.

The recommended KDE Git Configuration will set some settings at a user level and some at a repository level. You may wish to change the level some settings apply at however as we will assume you only or mostly use Git for developing KDE.

You can set Git settings either by directly editing the config files, but it is far safer to use the ''git config'' command.

To set a Git setting at User level (i.e. in ~/.gitconfig):

git config --global <key> <value>

To set a Git setting at repo level (i.e in <repo>/.git/config):

cd <repo>
git config <key> <value>

=== Basic Settings ===

If you plan to commit to KDE Git, then you will need to set up git to use your identity.kde.org name and details to help identify your work:

git config --global user.name <Your Real Name>
git config --global user.email <Your identity.kde.org email>

The name and email address you configure will be used as the author information for every commit you make. Note that in order for commit message keywords such as BUG and CCBUG to work, your Bugzilla account email address has to match the email address used in your commits.

To enable colored output when using git:

git config --global color.ui true

=== Commit Template ===

The Commit Template is a standard layout for commit messages, usually containing instructions for how a project expects messages to formatted and what details are to be included. You can choose to set a User Level template as a default, then use any project level variations at a repo level.

It is recommended to use the kdelibs template as your default. Once you have cloned kdelibs then set as follows to ensure you use the latest available version:

git config --global commit.template <path/to/kdelibs/>.commit-template

If you don't plan to have kdelibs cloned then download the kdelibs template from [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/raw/.commit-template here], save as ~/.commit-template, and configure to use that copy:

git config --global commit.template ~/.commit-template

When cloning other KDE repositories, you should check to see if they have a project specific commit template, and if so you should set that at a repo level:

cd <repo>
git config commit.template .commit-template

=== Exclusion rules ===
It's often necessary or desirable to limit the types of files that git will consider when commands like 'git status' and 'git add' or 'git add --all' are run. There are 2 types of exclusion rules.

 

The first, is a .gitignore in the repository. This text file will contain a list of wildcard expressions to ignore files and/or dirs. It can also contain bash-like comments (#) in addition to new lines.

 

The second method is similar to the first, except it is specified globally and will override (and add to) settings specified on a per-repository basis. This file can be named whatever, wherever, as long as it is specified in your ~/.gitconfig file.
 

An example .gitexcludes file can be found in kdelibs from [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/raw/.gitexcludes here], save as ~/.gitexcludes, and configure to use that copy using:

git config --global core.excludesfile ~/.gitexcludes

 

or alternatively, edit ~/.gitconfig manually and specify:
 

[core]
excludesfile = ~/.gitexcludes
 

Remember that this file is meant to be a global exclusion rule, so you probably shouldn't use it on a per-repo basis unless you really feel the need. The file excludes archive files (tar, gz, 7z, rar, etc.) as well as .directory, thumbs.db(Microsoft Windows file), .swp (swap file, used for vim and kate), as well as many many others.

=== Push Default ===

It is recommended for new Git users to set the push default to nothing:

git config --global push.default nothing

This option forces you to ''always'' enter the name of the remote branch you wish to push to, rather than using a default value. This is good practice as it ensures you push to the correct remote branch and avoid accidentally pushing all local branches to the remote.

More experienced users may wish to set the option to tracking:

git config --global push.default tracking

This will default to push to the remote branch your local branch is tracking, but if you setup your local branch incorrectly you may still accidentally push to the wrong remote.

=== URL Renaming ===

Instead of having to remember and type in the different full git addresses for pulling and pushing, we recommend you manually add the following to your Git User Configuration (~/.gitconfig):

<nowiki>[url "git://anongit.kde.org/"]</nowiki>
insteadOf = kde:
[url "git@git.kde.org:"]
pushInsteadOf = kde:

=== Bash Auto-Completion ===

Bash auto-completion for Git commands and branches may or may not work out-of-the-box for you depending on how Git is installed on your system. To see if you have auto-completion already working type ''git'' on your command line followed by a space and hit the ''tab'' key twice. If you see a list of available git commands then you have Git auto-completion enabled.

If auto-completion does not work for you then you can download the [http://git.kernel.org/?p=git/git.git;a=blob_plain;f=contrib/completion/git-completion.bash;hb=HEAD git-completion.bash] script and follow the instructions inside it.

=== Bash Prompt ===

If you have git-completion.bash installed, you can also add details like the branch name and dirty status to your command prompt, which will save repeated uses of ''git branch'' and ''git status''.

To activate this, you need to add the following to your $PS1 environment variable:

$(__git_ps1 " (%s)")

Note that in the " (%s)" part the %s variable is replaced with the branch name, the rest of the text between the quotes is up to you.

If you have not set a PS1 value yourself, then you are likely to be using your distro default value which you can find out by typing:

echo $PS1

To change this for your user, edit your .bashrc and copy the result of the echo command into there, then change it to add the Git branch.

For example, if ''echo $PS1'' shows:

$(ppwd \l)\u@\h:\w>

then add the following to your .bashrc:

PS1='$(ppwd \l)\u@\h:\w$(__git_ps1 " (%s)")> '

which will show your prompt as follows:

odysseus@argo:~/kde/src/trunk/KDE/kdelibs (master + u+2)>

You can learn more about customizing your bash prompt at http://www.tldp.org/HOWTO/Bash-Prompt-HOWTO/.

You can also have the prompt show the 'dirty' status of your repo, i.e. if you have uncommited changes, and whether your branch differs from upstream HEAD:

* * = unstaged changes
* + = staged changes
* $ = stashed changes
* % = untracked files
* u-1 = behind upstream by 1 commit
* u+2 = ahead of upstream by 2 commits
* u= = same as upstream

To enable showing the dirty (unstaged/staged) state, add the following line to your .bashrc 'before' your PS1 setting:

export GIT_PS1_SHOWDIRTYSTATE=1

To enable showing the stashed state, add the following line to your .bashrc ''before'' your PS1 setting:

export GIT_PS1_SHOWSTASHSTATE=1

To enable showing the untracked state, add the following line to your .bashrc ''before'' your PS1 setting:

export GIT_PS1_SHOWUNTRACKEDFILES=1

To enable showing the upstream state, add the following line to your .bashrc ''before'' your PS1 setting:

export GIT_PS1_SHOWUPSTREAM="auto verbose"

To not show the number of commits ahead or behind remove the "verbose" flag.

To disable showing the dirty state for any one repo:

cd <repo>
git config bash.showDirtyState false

To disable showing the upstream state for any one repo:

cd <repo>
git config bash.showUpstream false

=== Multiple Work Branches ===

You will often want to have more than one build environment in parallel, for example if you want to work on both stable and unstable branches at the same time.

With Git you can easily have many work branches in your repository and easily switch between them. The problem here however is that you can only work on the one branch at a time, and switching branches will usually trigger a massive rebuild of the entire repository.

One solution would be to have a separate repository clone for each branch you wish to work on in parallel, but this takes up more disk space, the clones and branches can easily get out-of-sync, and it makes forward/back porting bug fixes between branches more difficult. If choosing this method then you should make each new clone from your initial local clone rather than from the main repo as this will be quicker.

The ideal solution is for a single git repository clone to provide separate source directories for each branch you wish to work on, without performing full clone (what consumes disk space and requires fetching each clone separately). This can be achieved using the '''git-new-workdir''' script provided in the Git contrib directory. This script uses symbolic links to create what appears as a new clone in a separate folder but actually uses the same local clone.

The git-new-workdir script may be installed as part of your system git. If not download the script from [https://github.com/git/git/raw/master/contrib/workdir/git-new-workdir the git repo] and install in your ~/.bin.

For example, assuming your have a kdelibs.git clone living in ~/kde/src/master/kdelibs, then the following command will create a 4.6 work branch in ~/kde/src/4.6/kdelibs:

git-new-workdir ~/kde/src/master/kdelibs ~/kde/src/4.6/kdelibs KDE/4.6

== RSA Key fingerprint for git.kde.org==
c8:45:ba:89:85:11:78:b5:a4:09:d9:31:f6:7f:7c:79

Projects/Oxygen/Missing Icons

2012-05-09T19:45:20Z

Jstaniek:

The page will help Oxygen team to track and produce icons that are currently missing in KDE4. Additionally it will help developers to make requests for icons that they need for KDE4 related projects.

{{warning|This page is '''deprecated''', the artists don't look here. Icon requests have to go to OpenDocument spreadsheets in SVN at [http://websvn.kde.org/trunk/playground/artwork/Oxygen/docs/ trunk/playground/artwork/Oxygen/docs.]
}}

= Instructions to fill out the request =

* This page, being a wiki, obviously does not validate your request. Please take care when providing information about the icons. Note that this page is mainly for the team to know where is mostly needed the work, we'll do our best to fullfill your requests for 4.0 but however we can't guarantee that. =)

* When providing icon names please try to make them compatible with the actual naming scheme.

* Please provide clear but short descriptions about the icons, it needs to help the artists in imagining a good metaphore to make your icon. '''This point is extremely important'''. You may obviously also link your description if it's going to be lengthy. This will help us to manage icon requests, and check if there are any possible duplicates. The most descriptive you are, the best it is for us.

* Screenshots are sometimes a better way to easily show the usage of the icon. Provide metaphores when possible this will help the artist to visualize our reqest faster and give a better understanding of the reqest.

* As someone already noted, this is not the right page to complain or make suggestions about existing icon, this is just to know the remaining work.

* Please sort by module/application/priority

= Missing Icons Table =

== General purpose icons ==
For icons like the folder, or the desktop.

{|rules="all" cellpadding="2" cellspacing="0" align=center style="border:1px solid #999; border-right:2px solid #999; border-bottom:2px solid #999;" width="100%"
|+
! style="background:#efefef;" | Icon Name
! style="background:#efefef;" | Description / Where can be found?
! style="background:#efefef;" | Done?
! style="background:#efefef;" | Assigned To
|-----
|| mimetypes/application-x-chm || Icon for *.chm (HTML Help files). || No ||
|-----
|| mimetypes/application-x-dvi || Icon for *.dvi (files produced by LaTeX). || No ||
|-----
|| mimetypes/application-x-fictionbook || Icon for *.fb2 (FictionBook document, opens in Okular) and soon *.fb3 (not sure if it will have the same mimetype). || No ||
|-----
|| mimetypes/image-x-nikon-nef || Icon for *.nef (Nikon raw image file). || No ||
|-----
|| Question mark in message box || || No||
|-----
|| Warning icon in message box || || No||
|-----
|}

== KDE main modules ==
For apps in trunk/KDE/

{|rules="all" cellpadding="2" cellspacing="0" align=center style="border:1px solid #999; border-right:2px solid #999; border-bottom:2px solid #999;" width="100%"
|+
! style="background:#efefef;" | Module
! style="background:#efefef;" | Application
! style="background:#efefef;" | Icon Name
! style="background:#efefef;" | Description / Where can be found?
! style="background:#efefef;" | Done?
! style="background:#efefef;" | Assigned To
|-----
|| kdebase || kInfoCenter || devices/button || Icon for the device button found from Solid || No ||
|-----
|| kdebase || kInfoCenter || apps/dma || Icon for the DMA KCM || No ||
|-----
|| kdebase || kInfoCenter || apps/interrupts || Icon for the Interrupts KCM || No ||
|-----
|| kdebase || kInfoCenter || apps/ioports || Icon for the ioports KCM || No ||
|-----
|| kdebase || kInfoCenter || apps/scsi || Icon for the SCSI KCM || No ||
|-----
|| kdebase || kInfoCenter || apps/pci || Icon for the PCI Kcm || No ||
|-----
|| kdebase || kInfoCenter || apps/infosummary || Icon for the InfoSummary KCM || No ||
|-----
|| kdebase || kInfoCenter || apps/view1394 || Icon for the View1394 KCM || No ||
|-----
|| kdebase || khelpcenter || actions/help-contents-alternate || help-contents as open book (used in the glossary tab for example) || No ||
|-----
|| kdebase || konqueror || actions/edit-undo-close-tab || konqueror undo closed tab [jpetso says: low priority, has a fallback to edit-undo] || No ||
|-----
|| kdebase || konqueror || apps/preferences-system-network-proxy || konqueror configuration dialog Proxy || Yes || Pinheiro
|-----
|| kdebase || kwin|| apps/preferences-system-windows-effect || Generic effect icon || In Progress || Pinheiro
|-----
|| kdebase || kwin|| apps/preferences-desktop-effect || Desktop effects config module || No ||
|-----
|| kdebase || kwin|| apps/preferences-system-windows-effect-boxswitch || Boxswitch (alt-tab) effect (low priority) || No ||
|-----
|| kdebase || kwin|| apps/preferences-system-windows-effect-desktop-grid || Desktopgrid (desktop switcher) effect (low priority) || No ||
|-----
|| kdebase || kwin|| apps/preferences-system-windows-effect-presentwindows || Presentwindows effect (low priority) || No || Leeo
|-----
|| kdebase || kwin|| apps/preferences-system-windows-effect-shadow || Shadow effect (low priority) || No ||
|-----
|| kdebase || kwrite || apps/preferences-plugin-word-completion-ktexteditor || KWrite word completion plugin || Yes || swalko
|-----
|| kdebase || drkonqi || apps/drkonqi || icon for the kde crash manager ||Yes || pinheiro
|-----
|| kdebase || powerdevil || workspace/powerdevil/kcmodule || I miss an icon for "Do nothing". This could be useful also for other apps. I'd also like to have a "dynamic" icon , and a "conservative" one (for CPU governors) || ||
|-----
|| kdebase || systemsettings || apps/preferences-desktop-screen-edges || Screen edges desktop config module || ||
|-----
|| extragear || show dashboard || places/user-dashboard || icon for the show dashboard plasmoid ||Yes || pinheiro
|-----
|| kdenetwork || kopete (misc) || (various) || Emoticons for Kopete, See [[../Missing_Emoticons]] || In Progress in the emoticons sub dir in trunk || dmiller
|-----
|| kdenetwork || kopete || systray icons || Systray icons indicating status other than online are based on the old kopete icon. Proposal for an update: http://dev.gentoo.org/~earthwings/misc/kopete_icons/ [jpetso says: hm... maybe we could get rid of these special icons by programmatically combining the application icon with the user status icons as emblems? That would be pretty flexible in communicating information (up to four different states shown at once) and would avoid other themes having an inconsistent look if they draw the Kopete icon but not the systray variants.] [Earthwings replies: Good idea, doesn't work for the "all-away" variant but that is more or less superfluous anyway. I'll look at implementing this. Edit: Done]
|| Yes ||
|-----
||plasma||networkmanager|| network-wireless.svg || panel "icon" for plasma, shows a wireless connection, and 3 - 4 steps of signal strength, 3 steps for connection stages, ad-hoc connection mode ||No||
|-----
||plasma||networkmanager|| network-wired.svg || panel "icon" for plasma, shows a connected or disconnected wired network device, 3 steps for connection stages||No||
|-----
||plasma||networkmanager|| network-mobile.svg || panel "icon" for plasma, shows a connected or disconnected mobile broadband device and 3 - 4 steps of signal strength, 3 steps for connection stages ||No||
|-----
||plasma||networkmanager|| network-VPN.svg || panel "icon" for plasma, shows a connected or disconnected VPN connection, 3 steps for connection stages ||No||
|-----
||plasma||networkmanager|| actions/network-connect || icon to be used on "connect to this network" buttons ||No||
|-----
||plasma||networkmanager|| actions/network-disconnect || icon to be used on "disconnect from this network" buttons ||No||
|-----
|| koffice || koffice icons || (various) See http://wiki.koffice.org/index.php?title=Icons || various. icon names listed there are badly broken at the moment, take that wiki with a grain of salt. ||No ||
|-----
|| koffice || Chart shape || || icons for pie chart, ring chart and scatter chart. And nicer icons for bar, line, area and polar charts :-) And the bars, lines and area are needed in 3 variations: normal, stacked and percent || In Progress ||Pinheiro
|-----
|| koffice || Karbon || || icon for zoom to selection, icon for zoom to document content; both icons appear in the status bar beside the zoom slider ||No ||
|-----
|| kdeedu || kalgebra || apps/kalgebra || Application Icon kdeedu/kalgebra/icons || No ||
|-----
|| kdeedu || klettres || klettres_kids & klettres_grownup || Application Icon for Klettres [http://edu.kde.org/klettres/], a letter learning program. my idea was this: http://www.bdgraue.de/files/images/klettres_kids.svg http://www.bdgraue.de/files/images/klettres_grownup.svg i think, someone can do it better . here is a screenshot from klettres where you can see the old icons for 'mode kids' and mode 'grown up': http://edu.kde.org/klettres/ || No ||
|-----
|| kdeedu || parley || action/insert-row & action/insert-column || Add a new entry in parley || In Progress (jpetso: done already?) || Leeo
|----
|| kdeedu || step || icons for physical objects in Step||Screenshots of current (quite ugly) icons is available on [http://edu.kde.org/step step homepage]. ||||
|-----
|| kdepim || kjots || apps/kjots or view-pim-notebooks || Icon for note taking application kjots. ||No ||
|-----
|| kdepim || korganizer || actions/task-new || The icon for the "New Todo" action. || No ||
|-----
|| kdepim || korganizer || actions/journal-new || The icon for the "New Journal" action. I guess view-pim-journal overlayed with the plus icon should do. || No ||
|-----
|| kdepim || korganizer || actions/address-book-open || An icon for viewing, opening or selecting from an address book. Also used somewhere else (KAlarm, I believe), and combined with a plus icon it would be possible to get the specified address-book-new icon. [jpetso: Should we just use (copy) mimetypes/x-office-address-book?] || No ||
|-----
|| kdepim || korganizer || apps/preferences-calendar-freebusy || An icon for configuring free/busy time. || No ||
|-----
|| kdepim || korganizer || status/appointment-recurring || An icon to show a recurring event. || No ||
|-----
|| kdepim || korganizer || status/task-recurring || An icon to show a recurring incidence (event, to-do or journal). || No ||
|-----
|| kdepim || korganizer || status/task-complete || An icon to show a completed incidence (event, to-do or journal). || No ||
|-----
|| kdepim || korganizer || status/task-inprogress || An icon to show an incidence (event, to-do or journal) is in-progress to being completed. || No ||
|-----
|| kdepim || korganizer || status/task-needsattention || An icon to show incidence (event, to-do or journal) needs attention or action. || No ||
|-----
|| kdepim || korganizer || status/appointment-reminder || An icon for an event with a reminder. See the note for status/task-reminder below.|| No ||
|-----
|| kdepim || korganizer || status/task-reminder || An icon to show an incidence (event, to-do or journal) with a reminder. Perhaps could be similar or identical to apps/preferences-desktop-notification-bell - we're using this one for now as a temporary replacement ([[User:Jstaniek|jstaniek]] 16:52, 12 March 2008 (CET)). || No ||
|-----
|| kdepim || korganizer || actions/meeting-attending || An icon to show that you will attend a meeting || No ||
|-----
|| kdepim || korganizer || actions/meeting-attending-tentative || An icon to show that you are tentatively scheduled to attend a meeting || No ||
|-----
|| kdepim || korganizer || status/meeting-organizer || An icon to show that you are the person who organized and is in charge of a meeting || Yes ||
|-----
|| kdepim || korgac || actions/reminder-suspend || suspend a calendar reminder(s) || No ||
|-----
|| kdepim || korgac || actions/reminder-dismiss || dismiss calendar reminder(s) || No ||
|-----
|| kdepim || korgac || actions/reminder-enable || enable calendar reminder(s) || No ||
|-----
|| kdepim || kontact || status/event-birthday || maybe a cake with candles to represent someone's birthday || No ||
|-----
|| kdepim || kontact || status/event-anniversary || to represent a wedding anniversary || No ||
|-----
|| kdepim || kontact || planner || to represent a daily planner (show your appointments, stuff to-do, meetings, etc in an organized way) || [jpetso: I think view-pim-summary (already in Oxygen) is the right icon for this.] ||
|-----
|| kdepim || kontact || status/event-special || to represent a general special occassion. examples: holidays, birthdays, graduation, etc || No ||
|-----
|| kdepim || kontact || status/event-holiday || a non-religious holiday. examples: independence day, new years, etc || No ||
|-----
|| kdepim || kitchensync || actions/sync-start || The action to initiate a synchronization between to devices. || No ||
|-----
|| kdepim || akregator || actions/feed-fetch || The action to fetch a newsfeed (RSS, Atom, ...), quite similar to fetching mails actually. [jpetso says: low priority, probably post-4.0 stuff - they're already using icons that are not too far off) || No ||
|-----
|| kdepim || akregator || actions/feed-fetch-all || The action to fetch all newsfeeds (RSS, Atom, ...). [jpetso says: low priority, probably post-4.0 stuff - they're already using icons that are not too far off) || No ||
|-----
|| kdepim || knode || actions/??? || knode has two buttons with arrows, one with an arrow pointing right (go to the next unread article), the other one used to have a double-arrow pointing right (go to the next unread thread). The former is go-next, the latter is what is needed. Unfortunately I don't know how it could be called. ||
|-----
|| kdegames || kbattleship || kbattleship || Apps main icon || No ||
|-----
|| kdegames || kblackbox || kblackbox || Apps main icon || No ||
|-----
|| kdegames || killbots || randomteleport || The action teleports the player to a randomly selected location where they may be saved or may die. ||
|-----
|| kdegames || killbots || safeteleport || The action teleports the player to a randomly selected location where they are guarenteed to be safe for at least one turn. ||
|-----
|| kdegames || killbots || waitoutround || The action causes the player to stay in place for the remainder of the round. ||
|-----
|| kdegames || kmahjongg || kmahjongg || Apps main icon || No ||
|-----
|| kdegames || kmines || kmines || Apps main icon || No ||
|-----
|| kdegames || knetwalk || knetwalk || Apps main icon || Yes || johann_ol & trouvnez
|-----
|| kdegames || konquest || konquest || Apps main icon || No ||
|-----
|| kdegames || kpat || kpat || Apps main icon || No ||
|-----
|| kdegames || kreversi || kreversi || Apps main icon || No ||
|-----
|| kdegames || ksame || ksame || Apps main icon || No ||
|-----
|| kdegames || kshisen || kshisen || Apps main icon || No ||
|-----
|| kdegames || kspaceduel || kspaceduel || Apps main icon || No ||
|-----
|| kdegames || ksquares || ksquares || Apps main icon || No ||
|-----
|| kdegames || ktuberling || ktuberling || Apps main icon || No ||
|-----
|| kdegames || kfourinline || kfourinline || Apps main icon || No ||
|-----
|| kdegames || lskat || lskat || Apps main icon || No ||
|-----
|| kdegames || palapeli || palapeli || Apps main icon || No ||
|-----
|| kdenetwork || kget || status/network-connecting || Shown while trying to connect to a server. --[[User:Uwolfer|Uwolfer]] 21:05, 29 October 2007 (CET) || No ||
|-----
|| kdenetwork || kopete || apps/im-aim || Icon for the AIM instant messaging protocol || No || johann_ol
|-----
|| kdenetwork || kopete || apps/im-icq || Icon for the ICQ instant messaging protocol || No || johann_ol
|-----
|| kdenetwork || kopete || apps/im-jabber || Icon for the XMPP/Jabber instant messaging protocol || Yes || johann_ol
|-----
|| kdenetwork || kopete || apps/im-msn || Icon for the MSN instant messaging protocol || Yes || johann_ol
|-----
|| kdenetwork || kopete || apps/im-yahoo || Icon for the Yahoo! instant messaging protocol || No || johann_ol
|-----
|| kdenetwork || kopete || more protocol icons [jpetso: no time for retrieving the whole list right now] || Icon for the [blah blah blah] instant messaging protocol || No || johann_ol
|-----
|| kdenetwork || kopete || apps/preferences-desktop-user-privacy || Configuring privacy settings || No || davigno
|-----
|| kdenetwork || kopete || apps/preferences-plugin-text-effect-kopete || Configuring text formatting special effects || No || davigno
|-----
|| kdenetwork || kopete || apps/preferences-text-autocorrection || Configuring text autocorrect rules || No || davigno
|-----
|| kdenetwork || kopete || apps/preferences-text-highlighting || Configuring text highlighting - icon exists but only in a low resolution || No || davigno
|-----
|| kdenetwork || kopete || apps/preferences-pipes-kopete || Configuring piping settings - Probably like the old 'pipe' icon || No ||
|-----
|| kdenetwork || kopete || status/dock-kopete-flashing || icon flashed in system tray when new messages are received || No || davigno
|-----
|| kdenetwork || kopete || apps/preferences-status-manager-kopete || Icon for Status Manager || No ||
|-----
|| kdesdk || kapptemplate || apps/kapptemplate || generates KDE 4 templates to start programming || No ||
|-----
|| kdebase || plasma || plasma's toolbox || Toolbox icon to replace the wrench icon. The toolbox (on the top right of the desktop, remember all the screenshots) will allow users to zoom in and out of the desktop, add widgets, configure the desktop, lock the desktop, run commands, etc. From what I understand it's a replacement of the right click menu. Several plasma developers suggested a 2D palette similar to plasma's techbase icon. ~Craig || No ||
|-----
|| kdebase || plasma || battery.svg || Battery applet uses battery to present different types of batteries. We would need overlay's in svg, similar as existing AC adaptor indicator, that could be used to present different types of icons. We need indicators for following types: primary/notebook (no indicator is OK), mouse, keyboard, mouse+keyboard (not sure if used), pda. ||||
|-----
|| kdeaccessibility || ktts || apps/ktts(d?).png || App icon for ktts is needed, and will be used for kttsmgr in menus, and for "Speak Page" icon in konq toolbar. Will probably also likely be used for ktts settings in accessibility system-settings page. Old icon was a parrot which fits I think. ||
|-----
|| kdeaccessibility || kmousetool || apps/kmousetool.png || App icon for kmousetool is needed, and will be used for the application itselfs as well as it's systray. Kmousetool causes a click event when moving the mouse over click-able object and leaving it there for a certain amount of time. || ||
|-----
||kdeutils||Okteta||readonly/readwrite status icon||The loaded file can be set to readonly, by a toggle. Readonly would be the exception, so the icon could be a striked pen, a pen in a prohibition sign (round white with red border) or similar. || No ||
|-----
||kdeutils||Okteta||actions/bookmark-remove icon|| remove the bookmark from the current location || No ||
|-----
||kdeutils||Okteta||actions/bookmark-remove-all icon|| remove all bookmarks || No ||
|-----
||kdeutils||Okteta||actions/bookmark-go-next or go-next-bookmark icon|| go to the next bookmarked location || No ||
|-----
||kdeutils||Okteta||actions/bookmark-go-previous or go-previous-bookmark icon|| go to the previous bookmarked location || No ||
|-----
|| kreview || autostart || autostart || Apps main icon || ||
|-----
|| kdeutils || kdf || program icon || kdf is a small application that shows the amount of free space on your mounts (like 'df'). || ||
|-----
|| kdeutils || kfloppy || program icon || kfloppy can be used to format floppy disks with various filesystems. || ||
|-----
|| kdeutils || kgpg || program icon || a graphical frontend for gpg. you can use it to generate new keys, manage existing keys/trust (including communicating with keyservers) and for encrypting files. ||Yes ||
|-----
|| kdeutils || ktimer || program icon || used to launch scripts/programs at certain times. it's basically like a miniature-cron for your desktop. || ||
|-----
|| kdeutils || superkaramba || program icon || a piece of software that allows you to create interactive eye-candy for your desktop. || ||
|-----
|| kdebase || context || plasmoid icon || a containment for the Amarok Context || ||
|-----
|| kdebase || pager || plasmoid icon || switch between desktops || ||
|-----
|| kdebase || system tray || plasmoid icon || system section for the panel || ||
|-----
|| kdebase || window list || plasmoid icon || show a list for application windows || ||
|-----
|| kdebase || digital clock || plasmoid icon || the digital clock plasmoid. || ||
|-----
|| kdebase || analog clock || plasmoid icon || the analog clock plasmoid. || ||
|-----
|| kdeplasma-addons || binary clock || plasmoid icon || a binary clock plasmoid. || ||
|-----
|| kdeplasma-addons || file watcher || plasmoid icon || a plasmoid that works like "tail -f" || ||
|-----
|| kdeplasma-addons || fuzzy clock || plasmoid icon || a fuzzy clock plasmoid || ||
|-----
|| kdeplasma-addons || luna || plasmoid icon || a plasmoid that shows current lunar phase || ||
|-----
|| kdeplasma-addons || nowplaying || plasmoid icon || a plasmoid that displays what the player is playing || ||
|-----
|| kdeplasma-addons || timer || plasmoid icon || a count down timer || ||
|-----
|| kdeplasma-addons || KDE twitter || plasmoid icon || twitter plasmoid || ||
|-----
|| kdeplasma-addons || frame || plasmoid icon || a picture frame plasmoid || ||
|-----
|| kdeplasma-addons || 3D world || plasmoid icon || a 3D model for the earth globe || ||
|-----
|| kdeplasma-addons || weather forecast || status icon || Modify thunderstorm icon to show sun || ||
|-----
|| kdeplasma-addons || weather forecast || status icon || Modify thunderstorm icon to show moon || ||
|-----
|| kdesdk, kdevplatform, kdeutils || Kate, KDevelop, Okteta || go to folder of current document (current name: dirsync or curfiledir), || The icon is on a button which can be used to set the currently viewed folder in the embedded filesystem browser to the one of the currenly focused document (e.g. a text file in Kate) || No ||
|-----
|| kdevelop || miscellaneous || KDevelop Icons || Icons for the KDevelop IDE, as set out in the [http://websvn.kde.org/trunk/playground/artwork/Oxygen/docs/kdevelop-icons.txt?view=markup plan document] || No ||
|-----
|| kdegraphics || okular || single page, facing pages, trim margins || The single/facing pages icons existed in KDE3. Maybe the trim margins could show a page with a pair of scissors trimming it? || ||
|}

== Applications in Playground ==
For apps in trunk/playground/

{|rules="all" cellpadding="2" cellspacing="0" align=center style="border:1px solid #999; border-right:2px solid #999; border-bottom:2px solid #999;" width="100%"
|+
! style="background:#efefef;" | Module
! style="background:#efefef;" | Application
! style="background:#efefef;" | Icon Name
! style="background:#efefef;" | Description / Where can be found?
! style="background:#efefef;" | Done?
! style="background:#efefef;" | Assigned To
|-----
||network||kopete-bonjour||bonjour_protocol||The icons to be replaced are here: playground/network/kopete/protocols/bonjour/icons.||||
|-----
||base||emoticonskcm|| ||You can found it in kdereview, for now i'm using the face-smile icon but it's too small, i think it would be enough to have a bigger version||||
|-----
||utils||filelight|| || Application to display disk usage in a graphical manner, using concentric circles. Currently it uses an icon made by mxcl (I think), made for the KDE 3 version. ||||
|-----
|}

== Other 3rd party Application Icons ==
For all the other applications

{|rules="all" cellpadding="2" cellspacing="0" align=center style="border:1px solid #999; border-right:2px solid #999; border-bottom:2px solid #999;" width="100%"
|+
! style="background:#efefef;" | Application
! style="background:#efefef;" | Icon Name
! style="background:#efefef;" | Description / Where can be found?
! style="background:#efefef;" | Done?
! style="background:#efefef;" | Assigned To
|-----
|| (unnamed sports and activity tracker) || to be determined || Application app for http://blog.volker-lanz.de/2010/07/28/sports-activity-tracking-app-the-baby-needs-a-name/ || No ||
|-----
|| Opale || opale.svgz ?
|| [http://www.freehackers.org/Opale Opale] is a small though stable/maintained account planning application that can be compiled either as a Qt-only or a KDE application. I can be found as 'orzel' on irc.
|| No ||
|-----
|| Amarok || status/media-track-repeat || An icon for the "repeat the current track" state. || No ||
|-----
|| KPlayer, Amarok || status/media-playlist-repeat ||
Option to [http://kplayer.sourceforge.net/manual/configuration-playlist.html loop] through the current playlist. See [http://kplayer.sourceforge.net/manual/parts.html screenshot], it's the next-to-last button in the second row.
|| No (...jpetso: used an interim copy of the playlist icon, but without nice "repeat" arrows) ||
|-----
|| KPlayer, Amarok || status/media-playlist-shuffle ||
Option to [http://kplayer.sourceforge.net/manual/configuration-playlist.html shuffle] the current playlist. See [http://kplayer.sourceforge.net/manual/parts.html screenshot], it's the last button in the second row.
|| Kind of... copied the "roll" icon to that location ||
|-----
|| KPlayer, Dragon Player || video-contrast ||
Button that pops up the slider that lets you change the video contrast. See [http://kplayer.sourceforge.net/manual/parts.html screenshot], it's the fourth-to-last button in the first row.
|| No ||
|-----
|| KPlayer, Dragon Player || video-brightness ||
Button that pops up the slider that lets you change the video brightness. See [http://kplayer.sourceforge.net/manual/parts.html screenshot], it's the third-to-last button in the first row.
|| No ||
|-----
|| Firefox || apps/firefox || [http://en.www.mozilla.com/img/products/firefox-title.jpg Firefox logo] || No ||
|-----
|| KMuddy || apps/kmuddy || [http://img177.imageshack.us/img177/4840/hi32appkmuddylq5.png current KMuddy logo] (we don't have the original sources anymore, so we're very inflexible in our logo usage. Just a 16x16 and a 32x32 icon is all we got). KMuddy is a MUD client, so it's a program that allows you to play the fantasy RPGs, run around as elves and dwarves and such. (http://en.wikipedia.org/wiki/Mud_client). #kmuddy on freenode is available || No ||
|-----
|| GIMP || apps/gimp || [http://upload.wikimedia.org/wikipedia/commons/5/55/GIMP_Icon.png GIMP logo] || No ||
|-----
|| ktorrent || media-playback-all-start and media-playback-all-stop || For starting and stopping torrents we want to use media-playback-start and media-playback-stop, so we would like some matching icons to start and stop all torrents. || No || Leeo
|-----
|| ktorrent || apps/preferences-system-network-ip-filter-ktorrent || Icon for KTorrent's IP Filter plugin. This is a blocklist for bad peers. || No (jpetso says: hmmm... have i replaced this with view-filter already? ...) || Leeo
|-----
|| ktorrent || apps/preferences-plugin-scan-folder-ktorrent || Icon for KTorrent's folder scanner plugin. This plugin monitors directories for torrent files, and when a new one is detected, it is loaded into ktorrent. || No || Leeo
|-----
|| ktorrent || apps/preferences-system-network-upnp-ktorrent || Icon for KTorrent's UPnP plugin. || No || Leeo
|-----
|| ktorrent || apps/preferences-system-network-discovery || Icon for KTorrent's zeroconf (DNSSD) plugin, also used by the "Network Discovery" page in the System Settings (which makes for the slightly different icon name). || No || Leeo
|-----
||LyX || apps/lyx || Icon for LyX (http://www.lyx.org). || No ||
|-----
|| Minirok (and other media players?) || actions/list-clear || An icon for the "clear (play)list" action. Previously used "view_remove" from crystalsvg, which is now gone. || please use edit-clear - [[User:Djmdave|Djmdave]] 15:07, 10 February 2008 (CET) ||
|-----
|| [http://qlandkarte.sourceforge.net/ QLandkarte] || apps/qlandkarte || QLandkarte application (Garmin GPS tool for mapping/tracks/waypoints...) currently uses 16x16 world icon from Nuvola and author would be interested to get nice SVG icon for application. || ||
|-----
|| [http://www.kmess.org/ KMess] || MSN Status icons || If possible, oxygenized msn status icons.. it shouldn't be very long since they could be all color variants of just one image: [http://trac.kmess.org/browser/trunk/kmess/kmess/pics/online.png Online], or with very little changes: [http://trac.kmess.org/browser/trunk/kmess/kmess/pics/lunch.png Lunch] || please see user-* icons in status. if there are others that are needed, then please state them individually - [[User:Djmdave|Djmdave]] 15:07, 10 February 2008 (CET) ||
|-----
|| [http://www.kmess.org/ KMess] || "Unknown avatar" picture || KMess has been using [http://trac.kmess.org/browser/trunk/kmess/data/pics/unknown.png this picture] to indicate no picture is available. This is however [http://files.dazjorz.com/cache/kmess_baghead.png quite confusing], especially for new users. Therefore, we'd like a new image for this - the size should be 96x96, please. :-) ||||
|-----
|| [http://www.kde-apps.org/content/show.php/KGrab?content=74086 KGrab] || Main Icon || Its a extragear fork of KSnapshot. At the moment i use the old Ksnapshot icon. We need a new oxygen Icon for KGrab. Tanks ||||
|-----
|| [http://shaman.iskrembilen.com Shaman] || status-installed, status-notinstalled status-upgradeable action-update || We would are using the Oxygen-Icons in our program, but we can't find any status-icons which fit good :( (Currently using online/offline icons)|| No ||
|-----
|| [http://www.ggzgamingzone.org/clients/kde4/ Vencedor] || Standard online gaming actions for use with kdegames: We need "launch a game" vs. "join a game" vs. "watch/spectate a game" || Used in toolbar buttons of Vencedor, the new KDE 4.3 online games launcher || No ||
|----
|| [http://www.ggzgamingzone.org/clients/kde4/ Vencedor] || Application icon || Currently it lacks an app icon, too || No ||
|----
|| [http://mame.mindkiller.com/ mameexecutor] || Application icon || Currently lacks an app icon. Talked to pinheiro on IRC and he came up with an idea of an icon with a arcademachine, as the mameexecutor is a frontend for an arcade-emulator. ||in progress||pinheiro
|----
|| [http://extragear.kde.org/apps/kiosktool Kiosktool]|| Application icon || Currently lacks an app icon. Kiosktool is a systems administration application that can tune and configure KDE desktop settings. ||||
|-----
|| Amarok || apps/amarok ||
[http://websvn.kde.org/trunk/extragear/multimedia/amarok/src/images/amarok_icon.svg App icon]. Needs Oxygen colors, we don't really want to change design.
|| Yes - Jul 24 2007||
|-----
|| [http://www.kmess.org/ KMess] || Main Icon || We are porting our MSN client for KDE and we'd appreciate a lot an oxygenized version of [http://trac.kmess.org/browser/trunk/kmess/kmess/hi128-app-kmess.png our hummingbird logo] || Yes - Feb 28 2008||
|-----
|| Kaffeine || Icons for (unencrypted) radio and encrypted radio / tv channels || Digital Video Broadcasting (DVB) includes radio and tv channels (devices/video-television is used for tv channels), which may be encrypted. See [http://techbase.kde.org/Projects/Oxygen/KDE4_Missing_Icons here] for context screenshots (I've copied&hacked some oxygen icons as an intermediate solution till an oxygen variant is ready) || ||
|----
|| [http://rekonq.sourceforge.net/ Rekonq] || Main/Application Icon || Rekonq needs a (new) application icon, as the current one is not "so good" (If you are able to call it "icon" ;-)) ||||
|-----
|| [http://k3b.org K3b] || mimetypes/application-x-k3b || K3b project file MIME type icon || No ||
|-----
|| [http://k3b.org K3b] || actions/tools-rip-audio-cd || Ripping CD Audio disc into audio files || No ||
|-----
|| [http://k3b.org K3b] || actions/tools-rip-video-cd || Ripping VCD disc into video files || No ||
|-----
|| [http://k3b.org K3b] || actions/tools-rip-video-dvd || Ripping Video DVD disc into video files (maybe the icon should be the same as the previous one?) || No ||
|-----
|| [http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html Apps using XDG icons ] || emblems/emblem-default || indicate default selection, eg default printer || No ||
|}

= Misc Icon Requests =
* Please see my request on http://www.nabble.com/Suggestion-for-Oxygen:-Highlight-difference-between-Kate-and-KWrite-t4447769.html and the bug report to help you track this wish at: https://bugs.kde.org/show_bug.cgi?id=138170.
Update:Thanks Djmdave, for moving this here. Now the KWrite icon is totally missing. See: http://websvn.kde.org/trunk/KDE/kdebase/runtime/pics/oxygen/128x128/apps/kwrite.png?view=markup and other corresponding directories (scalable 64x64 etc). My request for two distinct icons for Kate and KWrite stands. Please see bug for more details and discussion.

* Partly fixed in svn commit r733637 (fabo), missing all unmount icons and some others (MO Device and ZIP Device) used in *.desktop files:
http://websvn.kde.org/trunk/KDE/kdebase/apps/lib/konq/Templates/

= List of missing icons with screenshot =

List of missing icons from applications with related screenshot:

[[Projects/Oxygen/KDE4_Missing_Icons]]

ISV/Roadmap

2011-12-02T22:51:28Z

Jstaniek: /* Sub-projects */ koffice inactive for now

{{Template:I18n/Language Navigation Bar|ISV/Roadmap}}
This page intends to help '''Independent Software Vendors''' (ISVs) understanding the background of the KDE Roadmap.

== KDE development ==

The current KDE development concentrates on KDE 4, which will be a major release. It will include several new features as well as new APIs and frameworks and therefore will break the API compatibility. However, at the same time there are several efforts in the community making porting apps to KDE 4 quite easy.

The Roadmap of KDE 4 is divided into the [[Schedules/KDE4/4.5_Release_Schedule|Release Schedule]] and the [[Schedules/KDE4/4.5_Feature_Plan|Feature Plan]].

== Sub-projects ==

Some KDE sub-projects have their own roadmaps:
* [http://multimedia.kde.org/roadmap.php KDE Multimedia project] - supported by [http://phonon.kde.org/ Phonon], a new multimedia API.
* [http://calligra.org Calligra] - a free, integrated office suite for KDE

[[Category:ISV]]

Projects

2011-12-02T22:50:41Z

Jstaniek: /* Suites */

{{Template:I18n/Language Navigation Bar|Projects}}
{{note|KDE TechBase Translators: The Projects part is rather a scratchpad for arbitrary projects. It contains texts like IRC logs and rough ideas. ''It probably does not make sense to translate this''. If, however, you wish some part to be translated please either email kde-www@kde.org or comment on #kde-www.}}

{{note|These pages are intended for providing technical documentation for external users of various KDE Projects. For internal project documentation, such as feature plans and meeting minutes please use http://community.kde.org/.}}

= Infrastructure =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/MovetoGit|KDE migration to git]]
:KDE is moving from svn to git, find progress, todo list, etc. here.
|-
|}

= Organisational =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[http://www.kde.org/community/getinvolved Get Involved with KDE]
:General information for getting involved with KDE projects. Includes a mentor directory for many projects.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/Release_Team|KDE Release Team]]
:The KDE Release Team.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/Documentation|KDE Documentation Project]]
:Creating and maintaining KDE documentation.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/kde.org|kde.org]]
:Information around the *.kde.org websites.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/Promo|KDE Promotion]]
:Promoting KDE and conference organization.
|-
|[[Image:Action_world.svg|noframe|left|40px]] ||
;[[/Partners|Partner Program]]
:KDE partner program targetting ISVs.
|-
| ||
;[[/Usability | KDE Usability project]]
: The KDE Usability Project is an initiative to apply usability principles and practices to the K Desktop Environment.
|-
| [[Image:Bugweeks ladybug.png|noframe|left|40px]]||
;[[Contribute/Bugsquad|KDE BugSquad]]
:The KDE BugSquad keeps track of incoming bugs in KDE software, and goes through old bugs.
|-
| ||
;[[/Summer_of_Code|Summer of Code Projects]]
:Information on Summer of Code projects and prospects related to KDE
|-
| ||
;[[/English Breakfast Network|KDE Code Quality (EBN)]]
: The English Breakfast Network and associated tools dedicated to KDE Quality, including: KDE API Documentation Validation, User Documentation Validation, Source Code Checking, ...
|-
| ||
;[[/KDE Research|KDE Research]]
: Project and community for everyone who is interested in contributing to (funded) research projects with(in) the KDE community.
|-
|}

= Frameworks =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:logo_oxygen.png|noframe|left|40px]] ||
;[[/Oxygen|The Oxygen Project]]
:Artwork for KDE4.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/kdelibs|KDE Core Libraries]]
:For the core developers working on the kdelibs module.
|-
|[[Image:Decibel.png|noframe|left|40px]] ||
;[[/Decibel|Decibel]]
:Decibel - Realtime communications framework
|-
| ||
;[[/KGLEngine2D | KGLEngine2D]]
: KGLEngine2D is a framework designed to greatly simplify the development of reach multimedia applications on KDE enabled platforms.
|-
| ||
;[[/KioFuse|KioFuse]]
: Insert KIO resources (remote, archived or compressed files) into the root filesystem hierarchy.
|-
|[[Image:Nepomuk_logo.png|noframe|left|40px]] ||
;[[/Nepomuk|Nepomuk]]
:Nepomuk Semantic Desktop project - Annotation/Indexing/Search/Linking
|-
|[[Image:Action_filequickprint.svg|noframe|left|40px]] ||
;[[/KDEPrint|KDEPrint]]
:Printing related information for KDE.
|-
|[[Image:knetworkmanager.png|noframe|left|40px]] ||
;[[/Network_Management|Network Management]]
: Development on Solid Networking, KNetworkManager applet and configuration tool.
|-
| ||
;[[/D-Bus-WS|D-Bus Web Service Proxy]]
: Fusion of D-Bus services and web services.
|-
| ||
;[[/Silk | Silk]]
: Project Silk - Deep integration of the web
|-
| ||
;[[/Solid | Solid]]
: Solid - The KDE Hardware Library
|-
| ||
;[[/Kbluetooth | Kbluetooth]]
: Kbluetooth - The KDE Bluetooth Library (deprecated)
|-
| ||
;[[/kdesu|kdesu]]
: Considerations and coordination to make kdesu work well with several backends.
|-
| ||
;[[/Telepathy|Telepathy]]
:Telepathy Realtime Communication Framework - Instant Messaging, VoIP and Collaboration.
|-
| ||
;[[/WebKit|WebKit (webkitkde)]]
: Project which aims to integrate WebKit (QtWebKit) into KDE.
|-
| ||
;[[/Widgets and Classes|Widgets & Classes]]
:Widgets and classes that are not in kdelibs but which you may find useful.
|-
| ||
;[[/KSecretsService|KSecretsService - managing KDE application's secrets]]
:Secrets management infrastructure for KDE applications and a collection of related tools, superseding KWallet.
|-
| ||
;[[/Related|Related Projects]]
: Projects which are related to KDE in any way, as dependencies or build tools.
|-
|}

= Programs =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
| [[Image:Aki128.png|noframe|left|40px]]||
;[[/Aki | Aki]]
: Aki - Extensive IRC Client
|-
|||
;[[/Digikam|Digikam]]
:Digikam - Photo Management Software.
|-
| [[Image:Hisc-apps-kget.svg|noframe|left|40px]]||
;[[/KGet|KGet]]
: KGet, a KDE Downloader
|-
| ||
;[[/Gwenview|Gwenview]]
:Gwenview, the image viewer.
|-
|[[Image:K3b.png|noframe|left|40px]] ||
;[[/K3b|K3b]]
:K3B, optical disc writer
|-
| ||
;[[/KDevelop4|KDevelop4]]
:KDevelop4, the KDE IDE.
|-
|[[Image:Kopete.svg|noframe|left|40px]] ||
;[[/Kopete|Kopete]]
:Kopete, the KDE Instant Messaging program.
|-
|[[Image:Marble.png|noframe|left|40px]] ||
;[[/Marble|Marble]]
:Marble Desktop Globe - Can You Feel The Earth Spinning?
|-
| ||
;[[/Okular|Okular]]
:Okular, the unified document viewer.
|-
| ||
;[[/rekonq | rekonq]]
: rekonq - A lightweight Web Browser for KDE based on WebKit
|-
|[[Image:Ktimetracker.png|noframe|left|40px]] ||
;[[KTimeTracker]]
:Time management within the KDE PIM.
|-
| ||
;[[/SystemSettings|System Settings]]
: Development on the System Settings configuration tool.
|-
|[[Image:superkaramba.png|noframe|left|40px]] ||
;[[/SuperKaramba|SuperKaramba]]
:SuperKaramba is a tool that allows you to easily create interactive eye-candy on your KDE desktop.
|-
| ||
;[[/KWin|KWin]]
: The KDE Window Manager.
|-
|}

= Suites =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:Action_book2.svg|noframe|left|40px]] ||
;[[/Edu|KDE Education Project]]
:Developing educational software for KDE.
|-
| ||
;[[/extragearReleases|Extragear Releases]]
: A current list of what extragear apps are to be released in sync with the core KDE release schedule.
|-
| ||
;[[/KdeFinance | KDE Finance]]
: KDE Finance is a group of KDE-related financial applications
|-
|[[Image:Kdegameslogo_40.png|noframe|left|40px]] ||
;[[/Games|KDE Games Project]]
:Developing desktop's games for KDE.
|-
|[[Image:Action_pencil.svg|noframe|left|40px]] ||
;[[/KOffice|KOffice]] and [http://wiki.koffice.org KOffice.org]
:Developing an Office suite based on KDE.
|-
|[[Image:Action_pencil.svg|noframe|left|40px]] ||
;[[/Calligra/]] and [http://calligra.org Calligra.org]
:Developing an Office suite for KDE.
|-
|[[Image:Action_mail_generic.svg|noframe|left|40px]] ||
;[[/PIM|KDE PIM Project]]
:KDE Personal Information Management.
|-
|[[Image:Plasma_logo.jpg|noframe|left|40px]] ||
;[[/Plasma|Plasma]]
:Quick and easy creation of widgets. Interactive application launchers, window and task managers, weather checkers; they are all made with plasma.
|-
| ||
;[[/Kdetoys | Kdetoys]]
: The Kdetoys project
|-
|[[Image:kdeutils-logo.svg|noframe|left|40px]] ||
;[[/Utils|KDE Utilities Team]]
:For the developers working on the kdeutils module.
|-
| ||
;[[/Necessitas | Necessitas]]
: Necessitas project
|-
|}

= Platforms =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:KDE-Mac.png|noframe|left|40px]] ||
;[[/KDE on Mac OS X|KDE on Mac OS X]]
: KDE libraries and applications on Mac OS X.
|-
|[[Image:Konqi-win.png|38px]] ||
;[[/KDE on Windows|KDE on Windows]]
: KDE libraries and applications on MS Windows.
|-
| ||
;[[/KDE on Solaris|KDE on Solaris]]
: KDE libraries and applications on Sun Microsystems Solaris and OpenSolaris.
|-
| ||
;[[/KDE on FreeBSD|KDE on FreeBSD]]
: KDE libraries and applications on FreeBSD and other BSDs.
|-
| ||
;[[Projects/Mobile|Mobile]]
: Project for porting KDE to the Mobile.
|-
|}

__NOTOC__

ISV/Why use KDE

2011-12-02T22:48:18Z

Jstaniek: /* Sub-Projects */ ->calligra, koffice inactive

{{Template:I18n/Language Navigation Bar|ISV/Why use KDE}}
This page intends to help '''Independent Software Vendors (ISVs)''' getting into KDE related topics. This includes companies developing commercial applications as well as other Open Source Projects.

== The KDE Community ==
The KDE project attracts many people with different backgrounds. As such, the day-by-day growing KDE community includes many '''developers''', '''translators''', '''artists''' as well as '''usability and accessibility experts''' and - of course - '''lots of users'''. For several years now all those people are welcome to meet at the '''annual KDE Conference [http://akademy.kde.org/ aKademy]''' to discuss KDE related topics and shape the ''roadmap'' for future development.

== KDE e.V. ==
The non-profit organization [http://ev.kde.org KDE e.V.] helps in creating and distributing KDE by securing cash, hardware, and other donations, then using donations to aid KDE development and promotion. All its members are part of the KDE community which means the KDE e.V. plays an important role in the KDE project. Members of the KDE e.V. form several '''working groups''' like the [http://www.spreadkde.org/handbook/mwg/charter Marketing Working Group (MWG)] and the [http://ev.kde.org/workinggroups/hci.php Human-Computer Interaction (HCI) Working Group] to help realize KDE's vision.

== Adoption of KDE ==
KDE is one of the biggest Open Source projects making the Linux/UNIX desktop's experience much more user friendly. As such, distributions strongly support KDE by actively taking part in its development process and ship KDE as their default desktop environment. Many companies use KDE for production use.

== Development ==
The KDE development process takes place in steady release cycles. '''[http://developer.kde.org/development-versions/release.html Release schedules]''' and '''feature plans''' help the KDE project coordinating a KDE release by introducing several ''phases'' like ''feature freeze'' and ''message freeze''. This phases make sure that developers concentrate on polishing the release and the translation teams have time enough to translate all the KDE software into many different languages. Further information about KDE development tools can be found on the [[Development|development pages]].

=== Documentation ===
The KDE project provides excellent documentation about its API and its technologies, such as KParts or KXmlGui. There are many '''Tutorials and HOWTOs''' which help getting into KDE development. An overview can be found at the [[Development|development pages]].

=== Technologies ===
KDE provides a wide range of '''powerful technologies''' such as [http://khtml.info KHTML and KJS] which are adopted by other companies like Apple (Safari browsers) and Nokia. Additionally there are several '''development frameworks''' like KParts (KDE's component technology), KIO (network/protocol architecture) or KXmlGui (build GUIs based on XML definitions).

KDE uses '''well-known standards''' like [http://en.wikipedia.org/wiki/Udev UDev]) and [http://dbus.freedesktop.org D-Bus] (interprocess communication).

=== Compatibility & Integration ===
The last major KDE release was KDE 4.0. All KDE 4.x versions are '''binary compatible''', i.e. software written for KDE 4.0 will be compatible with KDE 4.5 years later. As KDE is based on standards it is, for instance, easy to integrate applications with plain [http://todo-link-to-howto .desktop files].

==== Freedesktop.org & Portland ====
As an ISV, your target is probably not only KDE but all Linux/UNIX desktops. This is made possible due to '''strong collaboration between KDE and other projects''' like [http://freedesktop.org freedesktop.org] which defines standards and software that helps integrating applications in all standard conform desktop environments.

One of those projects is the [http://developer.kde.org/portland/ Portland project], which intends to develop a common set of Linux Desktop Programming Interfaces and Tools to allow applications to '''easily integrate''' with the free desktop configuration an end user has chosen to work with.

=== Sub-Projects ===
KDE has many sub-projects to more specifically coordinate unique project goals of major supporting applications. Several of these significant projects are noted below:

; KDE Pim
: The goal of [http://pim.kde.org KDE Pim] (Personal information management) is to provide an application suite to manage personal information. This includes applications like an email client, a calender etc. The main result is '''KDE Kontact''', our personal information manager.

; Calligra
: [http://calligra.org KOffice] is an '''integrated office suite''' using KDE-technology and features a full set of applications which work together seamlessly to provide the best user experience possible. The office suite contains applications like Words, Tables, Stage, Krita, Kexi and many more.

; KDevelop
: [http://kdevelop.kde.org KDevelop] is an '''Integrated Development Environment''' (IDE) for KDE. It supports language like C/C++ and Java and helps with rapid application development.

== Roadmap ==
KDE development follows a release schedule in order to coordinate releases. These usually cover for minor releases the last 10 weeks and for major releases the last 20 weeks before the official release. The features planned for a release are usually published at the same time as the schedule.

Further details can be found in the [[../Roadmap|roadmap page]].

[[Category:ISV]]

Contribute/Send Patches

2011-12-02T22:45:56Z

Jstaniek: /* Preparing The Email */

{{Template:I18n/Language Navigation Bar|Contribute/Send Patches}}
This tutorial shows how to send modifications of code in the right way: '''by using patches'''.

== Notation ==

The word ''developer'' is used here for someone having a KDE SVN account.

== Preliminaries ==

We suppose that you have modified some code in KDE and that you are ready to share it. First a few important points:
* You must allow that the modification will have the license of the file where the modification is made.
* Please make sure that the code compiles correctly on a (fairly) recent version of the software.

== What Is a Patch? ==

Now you have the modification as a source file. Sending the source file will not be helpful, as probably someone else has done other modifications to the original file in the meantime. So your modified file could not replace it.

That is why patches exist. Patches list the modifications, the line numbers and a few other useful information to be able to put that patch back into the existing code. (This process is called "patching" or also "applying a patch.")

The main tool for creating patches is a tool called '''diff''', which makes the difference between two files. This tool has a mode called ''unified diff'', which KDE developers use. Unified diffs have not just the difference between the file but also the ''neighborhood'' around the differences. That allows to patch even if the line numbers are not the same anymore.

== Creating a Simple File Patch ==

The most simple patch is created between the modified file (here called {{path|source.cpp}}) and the non-modified version of the file (here called {{path|source.cpp.orig}}.)
diff -u -p source.cpp.orig source.cpp

That lists the difference between the two files in the unified diff format (and with function name information if possible.) However it only displays it to screen, which is of course not the goal. So you need to redirect the output.
diff -u -p source.cpp.orig source.cpp > ~/patch.diff

{{path|~/patch.diff}} is here an example and you can create the file where you prefer with the name that you prefer. (You will soon find out that it is probably not a good idea to create a patch where the source is.)

== The More Common Case ==

But normally, you do not just change one file and you do not keep the original version around to be able to make the difference later. But here too, there is a solution.

The program svn, which is used on the command line interact with the SVN server, has a diff function too: '''svn diff'''.

You can run it like this and it will give you the difference of the current directory and all sub-directories below it. Of course, here too, you want to redirect the output.

svn diff > ~/patch.diff

There are useful variants too (shown here without redirection)
* For just one file: '''svn diff source.cpp'''
* For the current directory only: '''svn diff -N'''

'''Note''': even if svn can make the difference of another directory (svn diff mydirectory), it is not recommended to do it for a patch that should be applied again. (The problem is that the person that will apply the patch will have to be more careful about how he applies it.)

'''Note''': for simple diff, like those shown in the examples above, '''svn diff''' can be used offline, therefore without an active connection to the KDE SVN server. This is possible, as svn keeps a copy of the original files locally. (This feature is part of the design of SVN.)

By default, svn diff does not have a feature like the <tt>-p</tt> parameter of diff. But svn allows that an external diff program is called, so you can call diff:
svn diff --diff-cmd diff --extensions "-u -p"

== Non-Text Files ==

The procedures described above work very well with text files, for example C++ source code. However they do not work with binary files, as diff is not made to handle them. And even if SVN can internally store binary differences, svn diff is not prepared to do anything similar yet, mainly because it currently uses the unified diff format only, which is not meant for binary data.

Therefore, unfortunately, there is little choice but to attach binary files separately from the patch, of course attached in the same email.

== New Files ==

First, you need to make svn aware of files you have added.
svn add path/to/new/file /path/to/another/new/file

Then run '''svn diff''' as before.

Note that if you do '''svn revert''', for example, the files you created will NOT be deleted by svn - but svn will no longer care about them (so they won't show up when you do '''svn diff''', for example). You will have to '''rm''' them manually.

(TODO: are there any other issues with adding new files if you don't have commit access?)

== How To Share the Patch? ==

Now you are ready to share the patch. If your patch fixes a bug from [http://bugs.kde.org KDE Bugs], then the easiest way is to attach it there, see next section.

The main way of sharing a patch is to email to a mailing list. But be careful not to send big patches to a mailing list, a few 10KB is the limit.

Some projects use [[Development/Review_Board|KDE's Review Board]] for patch submitting. If a project is using the Review Board, that is usually their preferred way of receiving patches. See the [[Contribute/Send_Patches#Reviewboard|section below]] for details.

If you find that the patch is too big to send to a mailing list, the best is to create a bug report in [http://bugs.kde.org KDE Bugs] and to attach the patch there, after having created the bug report.

Another possibility, however seldom used, is to post the patch on a public Web server (be it by HTTP or FTP) and to send an email to the mailing list, telling that the patch is waiting there.

Another variant is to ask on the mailing list which developer is ready to get a big patch. (Try to give its size and ask if you should send it compressed, for example by bzip2.)

A last variant, if you know exactly which developer will process the patch and that you know or that you suppose that he currently has time, is to send the patch to a developer directly. (But here too, be careful if your patch is big. Some KDE developers still have analog modems.)

=== Patches for KDE Bugs ===

In this section we assume that you have chosen to add your patch to an existing KDE bug or that you have created a bug report just for your patch.

Even if this tutorial is more meant to send patches to a mailing list, most of it can be applied to adding a patch to [http://bugs.kde.org KDE Bugs].

You have two ways to do it:
* online, by selecting the bug report and using the web interface to add attachments.
* offline, by emailing to the bug report.

To send an email to a bug report, you can use an email address of the form '''12345@bugs.kde.org''' where 12345 is the bug number. Please be sure to attach your patch and not to have it inlined in your text. (If it is inlined, it would be corrupted by KDE Bugs, as HTML does not respect spaces.)

'''Note''': if you send an email to KDE Bugs, be careful to use as sender the same email address as your login email address in KDE Bugs. Otherwise KDE Bugs will reject your email.

'''Note''': if you create a new bug report just for your patch, be careful that you cannot attach a patch directly when creating a new bug. However as soon as the new bug is created, you can then attach files, one-by-one, therefore also patches.

'''Warning''': sometimes your patch will be forgotten because the developers do not always closely monitor the bug database. In this case, try sending your patch by email as described below. If that also does not help, you can always talk to the developers on [[Development/Further_Information#IRC_Channels|IRC]]

=== Which Mailing List? ===

Assuming that you have chosen to send the patch to a mailing list, you might ask yourself: to which one?

The best destination for patches is the [http://www.kde.org/mailinglists/ corresponding developer mailing list].

In case of doubt, you can send any patch for KDE to the [mailto:kde-devel@kde.org kde-devel mailing list]. (However with an increased risk that you would miss the right developer.)

Of course, if you know exactly which developer will process the patch and that you know or that you suppose that he currently has time, then you can send the patch to him directly.

=== Preparing The Email ===

Now you have a patch redirected into a file (for this example called patch.diff), you are ready to send it by email. But the first question: where?

Now that you have entered an email address, a good practice is to attach the patch to your file before writing anything else in the email. So you will not forget to attach it.

A little note here: yes, in KDE (unlike for the Linux Kernel for example), we prefer to have the patches sent as attachments.

Now you are ready to write the rest of the email. Please think of a title that matches your patch. (Think of having to find it again in [http://lists.kde.org the archives] in a few months or even years.) A good habit is to precede the title by <nowiki>[PATCH]</nowiki>. So for example a title could be <nowiki>[PATCH] Fix backup files</nowiki>.

As for the body of the email, please tell to which file or directory your patch applies. For example for a file: ''The attached patch applies to the file words/part/KWDocument.cpp'' or for a directory: ''The attached patch applies to the directory calligra/words''. This help the developers to have an overview of which code has been modified. Also tell for which branch it is meant, for example for trunk.

Then tell what your patch does. If it fixes a bug, then please give the bug number too. If the bug was not registered in [http://bugs.kde.org KDE Bugs], then please describe instead the bug that is fixed. Similarly, if you know that the patch fixes a bug introduced from a precise SVN revision, please add the revision number.

Tell also what could be useful to the developers, for example if you could not completely test the patch (and why), if you need help to finish fixing the code or if it is a quick&dirty solution that should be fixed better in long-term.

Now check the email again to see if you have not forgotten anything (especially to attach the patch) and you can send the email.

=== Reviewboard ===

One popular way of submitting patches is [[Development/Review_Board|KDE's Review Board]]. Here you can upload a patch and request the KDE project team or individual maintainer review your code. The Review Board provides tools for viewing diffs online, noting comments against code that needs changes, and granting approval to commit. It is far easier to manage patches using Review Board than using e-mail or Bugzilla, so it is the recommended method to use.

=== And Now? ===

Now you have to wait that a developer reacts on your patch. (If you are not subscribed to the mailing lists where you have sent the patch, then monitor [http://lists.kde.org the mailing list archives]] for such a message.)

The reaction is normally one of the following:
* No developer answers. (That is unfortunately happening from time to time.)
* The developer does not want your patch, as he is working on the same code.
* The developer does not like your patch.
* The developer finds that you should change a few things.
* The developer finds the patch good and tells that he will work on it.
* The developer accepts your patch as it is.

The first case is when nobody has answered. That perhaps means that you have chosen the wrong mailing list. Perhaps you have not explained correctly what the patch fixes or you have given a title that is not precise enough. If this happens, the developer might have overlooked the patch. Perhaps the developer that should have answered has not any time currently. (That too happens unfortunately.) The best is to try to work a little more on the patch, make a better description and try again a second time, perhaps to another mailing list or to use [http://bugs.kde.org KDE Bugs] instead.

If the developer tells you that your patch conflicts with changes that he is currently doing, you could probably not do much against it. Maybe you can discuss with him how you can effectively work with him on this piece of code.

If your patch was not accepted, you could work further on it. Probably you should discuss the problem on the mailing list to know in which direction you should work further.

If a developer wants a few changes, then work on the code to make the changes according to the critic. If you need help because you do not understand how to do the needed change, then ask it on the mailing list.

If your patch was accepted, congratulations! :)

Projects/KDE on Windows/Porting Guidelines

2011-11-25T20:24:26Z

Jstaniek: /* Templates */

This document contains rules useful when you are porting a KDE library to win32. Most of these rules are also valid for porting external libraries code, like application's libraries and even application's private code.

==Before you start==
* Make sure (ask KDElibs/win32 maintainer) that the library you selected for porting is not ported, but just not committed yet.
* You can ask the maintainer for proposals, what can be useful for porting.
* You will need KDE svn account for your work.
* Download most current (HEAD) of the KDE libraries.

==Absolute directory checking==
Look for '/' and "/" and change every single code like:

<syntaxhighlight lang="c">
if (path[0]=='/')
</syntaxhighlight>
or:

<syntaxhighlight lang="cpp-qt">
if (path.startsWith('/'))
</syntaxhighlight>
with:

<syntaxhighlight lang="cpp-qt">
if (!QDir::isRelativePath(path))
</syntaxhighlight>
(or "QDir::isRelativePath(path)" if there was used path[[0]!='/').

==Ifdefs==

===C++ code===

Macros for C++ code are defined in qglobal.h file. If you've got included at least one Qt header, you probably have qglobal.h included already, otherwise, include it explicity.

Use
<syntaxhighlight lang="c">
#ifdef Q_WS_X11
....
#endif
</syntaxhighlight>
for any C++ code that looks like X11-only.

Use
<syntaxhighlight lang="c">
#ifdef Q_OS_UNIX
....
#endif
</syntaxhighlight>
for any C++ code that looks like UNIX-only, for example uses UNIX-specific OS features.

Use
<syntaxhighlight lang="c">
#ifdef Q_WS_WIN
....
#endif
</syntaxhighlight>
for any C++ code that is MSWindows-only.

===C code===
Note that qglobal.h is C++-only, so instead use
<syntaxhighlight lang="c">
#ifdef _WIN32
....
#endif
</syntaxhighlight>

for any C code that is MSWindows-only (regardless to compiler type).

=== Rare cases: How to check in Windows-only code which compiler is used?===

====MS Visual C++ - Qt-independent code (especially, C code)====
<syntaxhighlight lang="cpp">
#ifdef _MSC_VER
....//msvc code
#endif
</syntaxhighlight>

====MS Visual C++ - Qt code====
<syntaxhighlight lang="cpp">
#ifdef Q_CC_MSVC
....//msvc code
#endif
</syntaxhighlight>

====Borland C++ - Qt-independent code (especially, C code)====
<syntaxhighlight lang="cpp">
#ifdef __BORLANDC__
....//borland code
#endif
</syntaxhighlight>

====Borland C++ - Qt code====
<syntaxhighlight lang="cpp">
#ifdef Q_CC_BOR
....//borland code
#endif
</syntaxhighlight>

===General notes===
In many places using #ifdef Q_OS_UNIX / #else / #endif is more readable than separate #ifdefs.

'''NOTE!!!''' if you must ifdef parts of the code, which contain complete features, please file a bug report against kde-windows target, component porting, in kde's bugzilla, so that those can be fixed later.

===Related links===
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclang/html/_predir_predefined_macros.asp| msvc++ Predefined Macros]

==Header files==
===Common header file===
Unless there is are any header file from kdelibs included in your header file, you need to add:
<syntaxhighlight lang="c">
#include <kdemacros.h>
</syntaxhighlight>
or
<syntaxhighlight lang="c">
#include <kdecore_export.h>
</syntaxhighlight>
at the beginning of your header file to have some necessary system-independent macros defined.

===Export macros===
For win32 world, symbols are "hidden by default" (not visible by default as e.g. on unix). This has already been [http://lists.kde.org/?l=kde-core-devel&m=105154800130902&w=2|discussed] on the kde mailing list.

For every library's code (not for standalone code), you need to make symbols exported for win32.
Do this by adding ***_EXPORT macro (win32 export macro) after "class" keyword within any public class (and structure) declaration. You may also decide to put this macro even for non-public class, if you think that the class could be used somewhere outside your library.

Example:

<syntaxhighlight lang="cpp">
class KDEFOO_EXPORT FooClass {
...
};
</syntaxhighlight>

'''Note''': For kdelibs, ***_EXPORT macros for are defined in kdelibs_export_win.h file (in kdelibs/win/ directory). You can study this file to see how the macros are defined. This file is simply included by kdelibs_export.h, for win32 target.

'''Note2''': Recently we're prepared to gcc's export capatibilities, probably in versions newer than 3.4, just like these in win32's msvc compiler. In kdemacros.h file (included by kdelibs_export.h) there are defines prepared for this functionality:

<syntaxhighlight lang="cpp">
#define KDE_NO_EXPORT __attribute__ ((visibility("hidden")))
#define KDE_EXPORT __attribute__ ((visibility("default")))
</syntaxhighlight>

For gcc <= 3.4, KDE_EXPORT and KDE_NO_EXPORT macros are just empty. Note that we're not using KDE_NO_EXPORT for non-public symbols: in the future probably it will be better to use command line switch to turn hidding by default (as win32 compiler has).

'''Note3''': *_EXPORT macros depend on MAKE_{LIBRARYNAME}_LIB macro. In KDE4 buildsystem (cmake) the latter is defined automatically by reusing {LIBRARYNAME}, for example MAKE_KATEINTERFACES_LIB is constructed when KATEINTERFACES library is compiled. The logic behind it is implemented in kdelibs/cmake/modules/KDE4Macros.cmake:
<syntaxhighlight lang="cpp">
if (WIN32)
# for shared libraries/plugins a -DMAKE_target_LIB is required
string(TOUPPER ${_target_NAME} _symbol)
set(_symbol "MAKE_${_symbol}_LIB")
set_target_properties(${_target_NAME} PROPERTIES DEFINE_SYMBOL ${_symbol})
endif (WIN32)
</syntaxhighlight>

===Exporting global functions===
Also add the same ***_EXPORT at the beginning of public functions' declaration and definition (just before function's type). This also includes functions defined within a namespace.

Example:
<syntaxhighlight lang="cpp">
namespace Foo {
KDEFOO_EXPORT int publicFunction();
}
</syntaxhighlight>

===What not to export?===
* methods inside classes (no matter static or not)
* inline functions
* template classes, e.g.:

<syntaxhighlight lang="cpp">
template <class T>
class KGenericFactoryBase
</syntaxhighlight>

===Visibility===
There are classes or functions that are made "internal", by design. If you really decided anybody could neven need to link against these classes/functions, you don't need to add **_EXPORT macro for them.

===Deprecated classes===
Before porting KDElibs to win32, I realized that deprecated classes already use KDE_DEPRECATED macro. We're unable to add another macro like this:

<syntaxhighlight lang="cpp">
class KDEFOO_EXPORT KDE_DEPRECATED FooClass { //< - bad for moc!
...
};
</syntaxhighlight>

..because moc'ing will fail for sure. We've defined special macros like that in kdelibs_export.h file (fell free to add your own if needed):

<syntaxhighlight lang="cpp">
# ifndef KABC_EXPORT_DEPRECATED
# define KABC_EXPORT_DEPRECATED KDE_DEPRECATED KABC_EXPORT
# endif
</syntaxhighlight>

So, we have following example of deprecated class:

<syntaxhighlight lang="cpp">
class KABC_EXPORT_DEPRECATED FooClass { //<- ok for moc
...
};
</syntaxhighlight>

.. which is ok for __moc__. Note that sometimes KDE_DEPRECATED is also used at the end of functions. You don't need to change it for win32 in any way.

==Loadable KDE modules/plugins==

{{TODO|This is deprecated section; we should use K_PLUGIN_FACTORY and K_EXPORT_PLUGIN macros}}

===K_EXPORT_COMPONENT_FACTORY macro===

Use K_EXPORT_COMPONENT_FACTORY( libname, factory ), defined in klibloader.h, instead of hardcoding:
<syntaxhighlight lang="cpp">
extern "C" {void *init_libname() { return new factory; } };
</syntaxhighlight>
...because the former way is more portable (contains proper export macro, which ensures visiblility of "init_libname" symbol).

Examples:
<syntaxhighlight lang="cpp">
K_EXPORT_COMPONENT_FACTORY( ktexteditor_insertfile,
GenericFactory<InsertFilePlugin>( "ktexteditor_insertfile" ) )
K_EXPORT_COMPONENT_FACTORY( libkatepart, KateFactoryPublic )
</syntaxhighlight>

===More complex case===

Sometimes you need to declare a factory which defined as a template with multiple arguments, eg.:

<syntaxhighlight lang="cpp">
extern "C"
{
void* init_resourcecalendarexchange()
{
return new KRES::PluginFactory<ResourceExchange,ResourceExchangeConfig>();
}
}
</syntaxhighlight>

... but compiler complains about too many arguments passed to K_EXPORT_COMPONENT_FACTORY. To avoid this, you can use __typedef__:

<syntaxhighlight lang="bash">
typedef KRES::PluginFactory<ResourceExchange,ResourceExchangeConfig> MyFactory;
K_EXPORT_COMPONENT_FACTORY(resourcecalendarexchange, MyFactory)
</syntaxhighlight>

The same trick can be used if the constructor of the factory takes multiple arguments.

==Templates==
MSVC 6 templates support was heavily broker. Since then the situation has improved a lot. However some specific cases do exist and these are explained in this section.

===Template arguments need to be defined in header files===
This won't work with forward declaration:
<syntaxhighlight lang="cpp-qt">
class QColor;
#include <QList>
QList<QColor> foo; // error
</syntaxhighlight>

You need to include full QColor declaration too:
<syntaxhighlight lang="cpp-qt">
#include <QColor>
#include <QList>
QList<QColor> foo; // ok
</syntaxhighlight>
So this is different when compared to GCC.

===“non-class type as already been declared as a class type” errors===
Code like this breaks in MSVC 2008/2010 (works under GCC and standard says it should work):
<syntaxhighlight lang="cpp-qt">
template <typename T>
void foo(struct bar & b);

struct bar {};
int main() {}
</syntaxhighlight>
This causes ''“non-class type as already been declared as a class type”'' error. The example is quoted after this [http://stackoverflow.com/questions/5995774/forward-declared-type-and-non-class-type-as-already-been-declared-as-a-class-ty stackoverflow entry]. See also a [https://connect.microsoft.com/VisualStudio/feedback/details/668430/forward-declared-type-and-non-class-type-as-already-been-declared-as-a-class-type bug report] sent to MS, when the vendor rejects request for fixing this bug.

A fix exists under MSVC 2008/2010: "struct bar;" should be added before the template function declaration
<syntaxhighlight lang="cpp-qt">
struct bar {};

template <typename T>
void foo(struct bar & b);

int main() {}
</syntaxhighlight>
In practice, if our templated declaration is a class like QList<>, we have to add the ''struct bar {};'' declaration before #include <QList>.
<syntaxhighlight lang="cpp-qt">
struct bar {};

#include <QList>
QList<bar> myFunction();

int main() {}
</syntaxhighlight>

MSVC 2008/2010 changed its behaviour what can be perceived as broken, with regression compared to 2005.

==Application icons==
Windows keeps icon data within .exe binaries. For KDE applications use CMake's KDE4_ADD_APP_ICON(appsources pattern) macro in automatically assign to add .png images for .exe files. [[Development/CMake/Addons for KDE#Macros|More information on KDE4_ADD_APP_ICON() macro...]]

Projects/KDE on Windows/Porting Guidelines

2011-11-25T20:10:38Z

Jstaniek: /* Application icons */

This document contains rules useful when you are porting a KDE library to win32. Most of these rules are also valid for porting external libraries code, like application's libraries and even application's private code.

==Before you start==
* Make sure (ask KDElibs/win32 maintainer) that the library you selected for porting is not ported, but just not committed yet.
* You can ask the maintainer for proposals, what can be useful for porting.
* You will need KDE svn account for your work.
* Download most current (HEAD) of the KDE libraries.

==Absolute directory checking==
Look for '/' and "/" and change every single code like:

<syntaxhighlight lang="c">
if (path[0]=='/')
</syntaxhighlight>
or:

<syntaxhighlight lang="cpp-qt">
if (path.startsWith('/'))
</syntaxhighlight>
with:

<syntaxhighlight lang="cpp-qt">
if (!QDir::isRelativePath(path))
</syntaxhighlight>
(or "QDir::isRelativePath(path)" if there was used path[[0]!='/').

==Ifdefs==

===C++ code===

Macros for C++ code are defined in qglobal.h file. If you've got included at least one Qt header, you probably have qglobal.h included already, otherwise, include it explicity.

Use
<syntaxhighlight lang="c">
#ifdef Q_WS_X11
....
#endif
</syntaxhighlight>
for any C++ code that looks like X11-only.

Use
<syntaxhighlight lang="c">
#ifdef Q_OS_UNIX
....
#endif
</syntaxhighlight>
for any C++ code that looks like UNIX-only, for example uses UNIX-specific OS features.

Use
<syntaxhighlight lang="c">
#ifdef Q_WS_WIN
....
#endif
</syntaxhighlight>
for any C++ code that is MSWindows-only.

===C code===
Note that qglobal.h is C++-only, so instead use
<syntaxhighlight lang="c">
#ifdef _WIN32
....
#endif
</syntaxhighlight>

for any C code that is MSWindows-only (regardless to compiler type).

=== Rare cases: How to check in Windows-only code which compiler is used?===

====MS Visual C++ - Qt-independent code (especially, C code)====
<syntaxhighlight lang="cpp">
#ifdef _MSC_VER
....//msvc code
#endif
</syntaxhighlight>

====MS Visual C++ - Qt code====
<syntaxhighlight lang="cpp">
#ifdef Q_CC_MSVC
....//msvc code
#endif
</syntaxhighlight>

====Borland C++ - Qt-independent code (especially, C code)====
<syntaxhighlight lang="cpp">
#ifdef __BORLANDC__
....//borland code
#endif
</syntaxhighlight>

====Borland C++ - Qt code====
<syntaxhighlight lang="cpp">
#ifdef Q_CC_BOR
....//borland code
#endif
</syntaxhighlight>

===General notes===
In many places using #ifdef Q_OS_UNIX / #else / #endif is more readable than separate #ifdefs.

'''NOTE!!!''' if you must ifdef parts of the code, which contain complete features, please file a bug report against kde-windows target, component porting, in kde's bugzilla, so that those can be fixed later.

===Related links===
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclang/html/_predir_predefined_macros.asp| msvc++ Predefined Macros]

==Header files==
===Common header file===
Unless there is are any header file from kdelibs included in your header file, you need to add:
<syntaxhighlight lang="c">
#include <kdemacros.h>
</syntaxhighlight>
or
<syntaxhighlight lang="c">
#include <kdecore_export.h>
</syntaxhighlight>
at the beginning of your header file to have some necessary system-independent macros defined.

===Export macros===
For win32 world, symbols are "hidden by default" (not visible by default as e.g. on unix). This has already been [http://lists.kde.org/?l=kde-core-devel&m=105154800130902&w=2|discussed] on the kde mailing list.

For every library's code (not for standalone code), you need to make symbols exported for win32.
Do this by adding ***_EXPORT macro (win32 export macro) after "class" keyword within any public class (and structure) declaration. You may also decide to put this macro even for non-public class, if you think that the class could be used somewhere outside your library.

Example:

<syntaxhighlight lang="cpp">
class KDEFOO_EXPORT FooClass {
...
};
</syntaxhighlight>

'''Note''': For kdelibs, ***_EXPORT macros for are defined in kdelibs_export_win.h file (in kdelibs/win/ directory). You can study this file to see how the macros are defined. This file is simply included by kdelibs_export.h, for win32 target.

'''Note2''': Recently we're prepared to gcc's export capatibilities, probably in versions newer than 3.4, just like these in win32's msvc compiler. In kdemacros.h file (included by kdelibs_export.h) there are defines prepared for this functionality:

<syntaxhighlight lang="cpp">
#define KDE_NO_EXPORT __attribute__ ((visibility("hidden")))
#define KDE_EXPORT __attribute__ ((visibility("default")))
</syntaxhighlight>

For gcc <= 3.4, KDE_EXPORT and KDE_NO_EXPORT macros are just empty. Note that we're not using KDE_NO_EXPORT for non-public symbols: in the future probably it will be better to use command line switch to turn hidding by default (as win32 compiler has).

'''Note3''': *_EXPORT macros depend on MAKE_{LIBRARYNAME}_LIB macro. In KDE4 buildsystem (cmake) the latter is defined automatically by reusing {LIBRARYNAME}, for example MAKE_KATEINTERFACES_LIB is constructed when KATEINTERFACES library is compiled. The logic behind it is implemented in kdelibs/cmake/modules/KDE4Macros.cmake:
<syntaxhighlight lang="cpp">
if (WIN32)
# for shared libraries/plugins a -DMAKE_target_LIB is required
string(TOUPPER ${_target_NAME} _symbol)
set(_symbol "MAKE_${_symbol}_LIB")
set_target_properties(${_target_NAME} PROPERTIES DEFINE_SYMBOL ${_symbol})
endif (WIN32)
</syntaxhighlight>

===Exporting global functions===
Also add the same ***_EXPORT at the beginning of public functions' declaration and definition (just before function's type). This also includes functions defined within a namespace.

Example:
<syntaxhighlight lang="cpp">
namespace Foo {
KDEFOO_EXPORT int publicFunction();
}
</syntaxhighlight>

===What not to export?===
* methods inside classes (no matter static or not)
* inline functions
* template classes, e.g.:

<syntaxhighlight lang="cpp">
template <class T>
class KGenericFactoryBase
</syntaxhighlight>

===Visibility===
There are classes or functions that are made "internal", by design. If you really decided anybody could neven need to link against these classes/functions, you don't need to add **_EXPORT macro for them.

===Deprecated classes===
Before porting KDElibs to win32, I realized that deprecated classes already use KDE_DEPRECATED macro. We're unable to add another macro like this:

<syntaxhighlight lang="cpp">
class KDEFOO_EXPORT KDE_DEPRECATED FooClass { //< - bad for moc!
...
};
</syntaxhighlight>

..because moc'ing will fail for sure. We've defined special macros like that in kdelibs_export.h file (fell free to add your own if needed):

<syntaxhighlight lang="cpp">
# ifndef KABC_EXPORT_DEPRECATED
# define KABC_EXPORT_DEPRECATED KDE_DEPRECATED KABC_EXPORT
# endif
</syntaxhighlight>

So, we have following example of deprecated class:

<syntaxhighlight lang="cpp">
class KABC_EXPORT_DEPRECATED FooClass { //<- ok for moc
...
};
</syntaxhighlight>

.. which is ok for __moc__. Note that sometimes KDE_DEPRECATED is also used at the end of functions. You don't need to change it for win32 in any way.

==Loadable KDE modules/plugins==

{{TODO|This is deprecated section; we should use K_PLUGIN_FACTORY and K_EXPORT_PLUGIN macros}}

===K_EXPORT_COMPONENT_FACTORY macro===

Use K_EXPORT_COMPONENT_FACTORY( libname, factory ), defined in klibloader.h, instead of hardcoding:
<syntaxhighlight lang="cpp">
extern "C" {void *init_libname() { return new factory; } };
</syntaxhighlight>
...because the former way is more portable (contains proper export macro, which ensures visiblility of "init_libname" symbol).

Examples:
<syntaxhighlight lang="cpp">
K_EXPORT_COMPONENT_FACTORY( ktexteditor_insertfile,
GenericFactory<InsertFilePlugin>( "ktexteditor_insertfile" ) )
K_EXPORT_COMPONENT_FACTORY( libkatepart, KateFactoryPublic )
</syntaxhighlight>

===More complex case===

Sometimes you need to declare a factory which defined as a template with multiple arguments, eg.:

<syntaxhighlight lang="cpp">
extern "C"
{
void* init_resourcecalendarexchange()
{
return new KRES::PluginFactory<ResourceExchange,ResourceExchangeConfig>();
}
}
</syntaxhighlight>

... but compiler complains about too many arguments passed to K_EXPORT_COMPONENT_FACTORY. To avoid this, you can use __typedef__:

<syntaxhighlight lang="bash">
typedef KRES::PluginFactory<ResourceExchange,ResourceExchangeConfig> MyFactory;
K_EXPORT_COMPONENT_FACTORY(resourcecalendarexchange, MyFactory)
</syntaxhighlight>

The same trick can be used if the constructor of the factory takes multiple arguments.

==Templates==
MSVC 6 templates support was heavily broker. Since then the situation has improved a lot. However some specific cases do exist and these are explained in this section.
===Template arguments need to be defined in header files===
This won't work with forward declaration:
<syntaxhighlight lang="cpp-qt">
class QColor;
#include <QList>
QList<QColor> foo; // error
</syntaxhighlight>

You need to include full QColor declaration too:
<syntaxhighlight lang="cpp-qt">
#include <QColor>
#include <QList>
QList<QColor> foo; // ok
</syntaxhighlight>
So this is different when compared to GCC.

==Application icons==
Windows keeps icon data within .exe binaries. For KDE applications use CMake's KDE4_ADD_APP_ICON(appsources pattern) macro in automatically assign to add .png images for .exe files. [[Development/CMake/Addons for KDE#Macros|More information on KDE4_ADD_APP_ICON() macro...]]

Policies/Library Code Policy

2011-11-21T20:12:13Z

Jstaniek:

This document describes some of the recommended conventions that should be applied in the KDE libraries (not applications). Respecting these guidelines helps create a consistant API and also may help ease maintainence of the libraries later. While these conventions are not mandatory, they are important guidelines, and should be respected unless you have a good reason to disregard them.

As an introduction, you should read the document [http://wiki.qt-project.org/API_Design_Principles Qt-Style C++ API Design Principles].

For kdelibs, it is recommended to follow the [[Policies/Kdelibs_Coding_Style | Kdelibs Coding Style]].

== Naming Conventions ==
In KDE, we basically follow the same naming conventions as Qt.

Class names starts with a capital K. The rest is in camel case. Function names starts with a lower case, but the first letter of each successive word is capitalized.

Unless dealing with central libraries (kdecore, kdeui), classes should be in the library namespace. In that case, it is the namespace which starts with K and the classes inside may not start with it. New libraries should choose their namespace.

The prefix 'set' is used for setters, but the prefix ''''get'''' is not used for accessors. Accessors are simply named with the name of the property they access. The exception is for accessors of a boolean which may start with the prefix ''''is''''.

Acronyms are lowercased too. Example:
<tt>KUrl</tt> instead of <tt>KURL</tt> and <tt>isNssEnabled()</tt> instead of <tt>isNSSEnabled()</tt>

Accessors should usually be <tt>const</tt>.

This example shows some possible functions names
<source lang="cpp-qt">
public:
void setColor(const QColor& c);
QColor color() const;
void setDirty(bool b);
bool isDirty() const;

private Q_SLOTS:
void slotParentChanged();
</source>
Make one public class for every .h file. Add the <tt>_EXPORT</tt> macro related to the library they are in.
Private classes should be declared in the .cpp file, or in a _p.h file.

== D-Pointers ==
In order to more easily maintain binary compatibility, there shouldn't be private members in a public class. For more information about binary compatibility, read [[Policies/Binary_Compatibility_Issues_With_C++|Binary Compatibility Issues With C++]].

By convention, the private class will be named the same as the public class, with <tt>Private</tt> appended to the name.
<source lang="cpp-qt">
class KFooPrivate;
class KFoo
{
public:
/* public members */
private:
KFooPrivate * const d;
};
</source>
In the .cpp file:
<source lang="cpp-qt">
class KFooPrivate
{
public:
int someInteger;
};

KFoo::KFoo() : d(new KFooPrivate)
{
/* ... */
}

KFoo::~KFoo()
{
delete d;
}
</source>
Notice that the member d is <tt>const</tt> to avoid modifying it by mistake.

If you are implementing an implicitly shared class, you should consider using {{qt|QSharedData}} and {{qt|QSharedDataPointer}} for d.

Sometimes, complex code may be moved to a member method of the Private class itself. Doing this may give the compiler an extra register to optimize the code, since you won't be using "d" all the time. Also, remember to '''inline''' such methods if they are called only from one place.

=== Shared D-Pointers ===

If your class hierarchy is large and/or deep, you may want to try the concept of shared d-pointers. You'll be trading the added complexity for a smaller memory footprint in the main object (there will be only one "d" variable in it). Other advantages include:

:* direct access to the private data of the whole hierarchy (in other words, the Private classes are in fact "protected", not "private")
:* access to the parent's d-pointer methods

The latter advantage is especially useful if your class has moved the code from the main class to the Private class. If that's the case, you should be calling the Private methods instead: since they are not exported, they will create simpler relocations in the final library (or none at all). By simply calling the Private method instead of the public one, you contribute to a faster load-time of your library.

To implement a "shared d-pointer", you need to:
:# define a '''protected''' variable (d_ptr) in the least derived class of your hierarchy
:# in each class of the hierarchy, define a '''private''' function called d_func() that reinterpret_casts that d_ptr to the current class's Private class
:# use Q_D(Foo) at the beginning of the functions to have access to a variable "d"
:# the private classes derive from one another just like the public hierarchy; they also have virtual destructors
:# add one extra, protected constructor that takes the private class as a parameter
:# in each constructor for all derived classes, call the parent's constructor that takes the d pointer as a parameter

There's an example of such a construct in a [[/Shared_D-Pointer_Example|separate page]].

=== Q_DECLARE_PRIVATE ===

This is a handy macro that hides the ugly stuff for you. It creates the <tt>d_func()</tt> function for you, using the variable called <tt>d_ptr</tt>. If yours has that name, you can use this macro. If it has another name, maybe you should create a macro to make your code look nicer.

=== Q-Pointers ===

Q-pointers are like d-pointers, but work in the reverse direction: they are in the Private class and they point to the public class. Needless to say, this is only possible for classes that don't share their d-pointers. Examples of classes that might benefit from q-pointers are all those derived from QObject, while classes with implicit sharing are those that potentially can't use it.

Q-pointers are especially useful if your class has moved most of the code to the Private class as recommended. In that case, you may need to emit signals from the Private class. You would do it as:

<source lang="cpp-qt">
emit q->signalName();
</source>
(You need to declare the Private class a friend of your public one; Q_DECLARE_PRIVATE does that for you)

Q-pointers may also use the a shared q-pointer technique just like [[#Shared D-Pointers|d-pointers]] can. What's more, Qt also provides a macro called <tt>Q_DECLARE_PUBLIC</tt> and one <tt>Q_Q</tt> to hide the ugly parts of the implementation.

== Inline Code ==
For binary compatibility reasons, try to avoid inline code in headers. Specifically no inline constructor or destructor.

If ever you add inline code please note the following:
* Installed headers should compile with the following preprocessor defines: <tt>QT_NO_CAST_FROM_ASCII</tt>, <tt>QT_NO_CAST_TO_ASCII</tt>, <tt>QT_NO_KEYWORD</tt>. So don't forget {{qt|QLatin1String}}.
* No C casts in the header. Use <tt>static_cast</tt> if types are known. Use <tt>qobject_cast</tt> instead of <tt>dynamic_cast</tt> if types are QObject based. dynamic_cast is not only slower, but is also unreliable across shared libraries.
* In general, check your code for [[Development/Tutorials/Common_Programming_Mistakes|common mistakes]].

These recommendations are also true for code that are not in headers.

== Flags ==
Try to avoid meaningless boolean parameters in functions. Example of a bad boolean argument:
<source lang="cpp-qt">
static QString KApplication::makeStdCaption( const QString &caption,
bool withAppName,
bool modified);
</source>

Because when you read code that uses the above function, you can't easily know the significance of the parameters

<source lang="cpp-qt">
window->setCaption(KApplication::makeStdCaption( "Document Foo",
true, true));
</source>

The solution is to use {{qt|QFlags}}. If the options only apply to one function, call the <tt>enum FunctionNameOption</tt> and the QFlags typedef <tt>FunctionNameOptions</tt>. Do that even if there is only one option, this will allow you to add more options later and keep the binary compatibility.

So a better API would be:
<source lang="cpp-qt">
class KApplication
{
public:
/* [...] */
enum StandardCaptionOption {
/**
* Indicates to include the application name
*/
WithApplicationName = 0x01,
/**
* Note in the caption that there is unsaved data
*/
Modified = 0x02
};
Q_DECLARE_FLAGS(StandardCaptionOptions,
StandardCaptionOption)

/**
* Builds a caption using a standard layout.
*
* @param userCaption The caption string you want to display
* @param options a set of flags from MakeStandartCaptionOption
*/
static QString makeStandardCaption(const QString& userCaption,
const StandardCaptionOptions& options = WithApplicationName);
/* [...] */
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KApplication::StandardCaptionOptions)
</source>

== Const References ==
Each object parameter that is not a basic type (int, float, bool, enum, or pointers) should be passed by reference-to-const. This is faster, because it is not required to do a copy of the object. Do that even for object that are already implicitly shared, like QString:

<source lang="cpp-qt">
QString myMethod( const QString& foo,
const QPixmap& bar,
int number );
</source>

'''Note:''' Avoid const references for return types though. Returning for example
<source lang="cpp-qt">
const QList<int> &someProperty() const;
</source>
means exposing the internal data structure for someProperty() and it's very difficult to change it in the future while preserving binary compatibility. Especially for implicitly shared objects the one refcount that one avoids by returning a const reference is often not worth it the exposure of implementation.

There are cases where it makes sense, where performance is absolutely critical and the implementation is very fixed. So think twice about it and consider returning a value instead:
<source lang="cpp-qt">
QList<int> someProperty() const;
</source>

== Signals and Slots ==
In the libraries, use <tt>Q_SIGNALS</tt> and <tt>Q_SLOTS</tt> instead of <tt>signals</tt> and <tt>slots</tt>. They are syntactically equivalent and should be used to avoid conflicts with boost signals, and with python's use of "slots" in its headers.

== Properties ==
Consider using <tt>Q_PROPERTY</tt> for properties. The reason is that properties (especially those marked <tt>SCRIPTABLE</tt>) will be accessible through the javascript interface.

If you follow the propname / setPropname naming scheme, moc sets a special flag for the {{qt|QMetaProperty}}.

== Explicit Constructors ==
For each constructor (other than the copy constructor), check if you should make the constructor <tt>explicit</tt> in order to minimize wrong use of the constructor.

Basically, each constructor that may take only one argument should be marked <tt>explicit</tt> unless the whole point of the constructor is to allow implicit casting.

== Avoid including other headers in headers ==
Try to reduce as much as possible the number of includes in header files. This will generally help reduce the compilation time, especially for developers when just one header has been modified. It may also avoid errors that can be caused by conflicts between headers.

If an object in the class is only used by pointer or by reference, it is not required to include the header for that object. Instead, just add a forward declaration before the class.

In this example, the class KFoo uses KBar by reference, so we do not need to include KBar's header:
<source lang="cpp-qt">
#include <kfoobase.h>
class KBar;
class KFoo : public KFooBase
{
public:
/* [...] */
void myMethod(const KBar& bar);
};
</source>

== Getting #includes right ==

There are two types of #include statements: <tt>#include <foo.h></tt> and <tt>#include "foo.h"</tt>.

Say we have the file <tt>xyz.h</tt> in <tt>/usr/include/mylib/</tt> that contains the following:
<source lang="cpp-qt">
#include <header1.h>
#include "header2.h"
</source>

The preprocessor will search for the file <tt>header1.h</tt> in all the paths given as <tt>-I</tt> arguments and then replace the line with the contents of that file.

For line 2 the preprocessor tries to use the file /usr/include/mylib/header2.h first and if it does not exist search for the file like it did for <tt>header1.h</tt>. The important part to note here is that the preprocessor does not look in the directory of the source file that includes <tt>xyz.h</tt> but in the directory where <tt>xyz.h</tt> resides.

Now, which include statement is the one to use? After all you can specify every directory you want using <tt>-I</tt> (or rather CMake's <tt>include_directories()</tt>) and thus could use <tt>#include <...></tt> everywhere.

=== As application developer ===
* Include headers from '''external''' libraries using '''angle brackets'''.
<source lang="cpp-qt">
#include <iostream>
#include <QtCore/QDate>
#include <zlib.h>
</source>
* Include headers from your '''own project''' using '''double quotes'''.
<source lang="cpp-qt">
#include "myclass.h"
</source>
Rationale: ''The header files of external libraries are obviously not in the same directory as your source files. So you need to use angle brackets.''

''Headers of your own application have a defined relative location to the source files of your application. Using KDE4's cmake macros your source directory is the first include switch to the compiler and therefore there's no difference in using angle brackets or double quotes. If you work with a different buildsystem that does not include the current source directory or disable CMAKE_INCLUDE_CURRENT_DIR then all includes (inside your application) using angle brackets will break.''

''Ideally the buildsystem would not need to specify <tt>-I<source directory></tt> though as that can break with library headers that have the same filename as a header of your project (i.e.: If a library has the header file <tt>foo.h</tt> and your project has a different file with the same filename the compiler will always pick the header from your project instead of the one from the library because the source directory of the project is specified first.)''

=== As library developer ===
* Include headers from '''external''' libraries using '''angle brackets'''.
<source lang="cpp-qt">
#include <iostream>
#include <QtCore/QDate>
#include <zlib.h>
</source>
* Include headers of your '''own library''' and libraries that belong to it using '''double quotes'''.
<source lang="cpp-qt">
#include "xyz.h" // same library and same directory
</source>

Rationale: ''The header files of external libraries are obviously not in a fixed location relative to your source files. So you need to use angle brackets.''

''Headers of your own libraries have a fixed relative location in the filesystem. Therefore you'' can ''use double quotes. You should use double quotes because otherwise the include statement could include a different header file than expected. An example how angle brackets can break the build:''

''<tt>/usr/include/libxyz/xyz.h</tt> includes <tt>foo.h</tt> using angle brackets and expects to have it replaced with the contents of the file <tt>/usr/include/libzyx/foo.h</tt>. Assuming there's another library that also ships a <tt>foo.h</tt> file in the directory <tt>/usr/include/anotherlib/</tt>. If the application that uses both libraries compiles with "<tt>g++ -I/usr/include/libxyz -I/usr/include/anotherlib ...</tt>" libxyz will work as expected. If the application compiles with "<tt>g++ -I/usr/include/anotherlib -I/usr/include/libxyz ...</tt>" the header <tt>xyz.h</tt> will include the file <tt>/usr/include/anotherlib/foo.h</tt> instead of the file that is shipped with libxyz. The same problem can appear if an application has a header file of the same name as a library and specifies <tt>-I./</tt> as the first include directory.''

=== Include order ===

Another important aspect of include management is the include order. Typically, you have a class named Foo, a file foo.h and a file foo.cpp . The rule is :

: ''In your file foo.cpp, you should include "foo.h" as the first include, before the system includes.''

The rationale behind that is to make your header standalone.

Let's imagine that your foo.h looks like this:
<source lang="cpp-qt">
class Foo
{
public:
Bar getBar();

};
</source>

And your foo.cpp looks like this:
<source lang="cpp-qt">
#include "bar.h"
#include "foo.h"
</source>

Your foo.cpp file will compile, but it will not compile for other people using foo.h without including bar.h . Including "foo.h" first makes sure that your foo.h header works for others.

=== Include guards ===
Header files should use guards to protect against possible multiple inclusion.
Your myfoo.h header should look like this:
<source lang="cpp-qt">
#ifndef MYFOO_H
#define MYFOO_H
... <stuff>...
#endif /* MYFOO_H */
</source>

To be even more careful, you may want to encode a namespace or subdirectory name (e.g. KFOO) into the guard macro name, for example: MYFOO_H, KFOO_MYFOO_H, or _KFOO_MYFOO_H_ are all acceptable macro names. By convention, the macro name should be all uppercase; but that is not a firm requirement.

== Static Objects ==
Global static objects in libraries should be avoided. You never know when the constructor will be run or if it will be run at all.
; Wrong
<source lang="cpp-qt">
static QString foo; // wrong - object might not be constructed
static QString bar("hello"); // as above
static int foo = myInitializer(); // myInitializer() might not be called
</source>
In particular, never construct QObject-derived objects this way. On Windows (MS Visual C++) the object's internals will be left uninitialized within a library and will lead to crashes ([http://www.kdedevelopers.org/node/2889 more info]).
<source lang="cpp-qt">
static QFile myFile("abc"); // QFile inherits QObject
</source>
; Correct
<source lang="cpp-qt">
static const int i = 42;
static const int ii[3] = {1, 2, 3};
static const char myString[] = "hello";
static const MyStruct s = {3, 4.4, "hello"};
K_GLOBAL_STATIC(QFile, myFile);
</source>

You can use [http://api.kde.org/4.0-api/kdelibs-apidocs/kdecore/html/group__KDEMacros.html#g75ca0c60b03dc5e4f9427263bf4043c7 <tt>K_GLOBAL_STATIC</tt>] macro (and for QObject-derived objects you should) to create global static objects which will be initialized the first time you use them.

== Signal and Slot Normalization ==
Since <tt>QObject::connect</tt> uses a string-based comparison
of the function signature, it requires some normalization to take
place. It does that automatically for you, but it takes some CPU
time, so, if it doesn't hurt your code's readability, normalize
manually your SIGNAL and SLOT entries.

For example, you may have the following code:
<source lang="cpp-qt">
QObject::connect(this, SIGNAL( newValue(const QString&,
const MyNamespace::Type&) ),
other, SLOT( value(const QString &) ));
</source>
It would be preferable to write as follows:
<source lang="cpp-qt">
QObject::connect(this, SIGNAL(newValue(QString,MyNamespace::Type)),
other, SLOT(value(QString)));
</source>

Note the absence of extra whitespace and the
reduction of pass-by-reference-to-const parameters to simple
pass-by-value ones. The normalization may involve other
transformations, but these are the most common ones. Also note that
types in namespaces should always use the full qualified name.
To be sure what the proper normalization is, read the {{path|.moc}} file
generated for the class.

'''Note''': If you are unsure about the normalization, don't do it. Let
QObject do it for you (the performance penalty is negligible in most cases).

== External Dependencies ==
When a library pulls in a new external dependency due to a new feature or a change in implementation, it is highly preferred to make that dependency optional if at all possible. For some core features in a library this may not be possible, but usually it is even if the cost is a degradation in features when built without that dependency.

All dependencies should be adequately documented in the build system so that they appear in the summary post-configure.

For libraries in the '''kdelibs module''', this is a hard requirement: '''no new non-optional dependencies may be added, all new dependencies must be made optional at configure time'''. Exceptions may be granted for unusual circumstances by sending a request to the kde-core-devel at kde.org mailing list and getting a consensus decision to grant an exception there.

== Documentation ==
Every class and method should be well documented. Read the [[Policies/Library Documentation Policy|KDE Library Documentation Policy]] for the guidelines to follow when documenting your code.

Also don't forget the license headers and copyrights in each file. As stated in the [[Policies/Licensing Policy|Licensing Policy]], kdelibs code must be licensed under the LGPL, BSD, or X11 license.

Author: [mailto:ogoffart@kde.org Olivier Goffart] March 2006

[[Category:Policies]]

Policies/Kdelibs Coding Style

2011-09-25T17:24:49Z

Jstaniek: /* Artistic Style (astyle) automatic code formatting */ --unpad and --pad (new syntax)

<languages />
<translate>

This document describes the recommended coding style for kdelibs. Nobody is forced to use this style, but to have consistent formatting of the source code files it is recommended to make use of it.


'''In short: Kdelibs coding style follows the Qt 4 coding style.'''

== Indentation == 
* No tabs
* 4 Spaces instead of one tab

== Variable declaration == 
* Each variable declaration on a new line
* Each new word in a variable name starts with a capital letter (so-called camelCase)
* Avoid abbreviations
* Take useful names. No short names, except:
** Single character variable names can denote counters and temporary variables whose purpose is obvious
** Variables and functions start with a lowercase letter


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
KProgressBar *prbar;
QString prtxt, errstr;

<translate>
// correct</translate>
KProgressBar *downloadProgressBar;
QString progressText;
QString errorString;
</syntaxhighlight>

<translate>
== Whitespace == 
* Use blank lines to group statements
* Use only one empty line
* Use one space after each keyword
* For pointers or references, use a single space before '*' or '&', but not after
* No space after a cast


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
QString* myString;
if(true){
}

<translate>
// correct</translate>
QString *myString;
if (true) {
}
</syntaxhighlight>

<translate>
== Braces == 
As a base rule, the left curly brace goes on the same line as the start of the statement.


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
if (true)
{
}

<translate>
// correct</translate>
if (true) {
}
</syntaxhighlight>

<translate>

Exception: Function implementations, class, struct and namespace declarations always have the opening brace on the start of a line.


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
void debug(int i)
{
qDebug("foo: %i", i);
}

class Debug
{
};
</syntaxhighlight>

<translate>

Use curly braces even when the body of a conditional statement contains only one line.


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
if (true)
return true;

for (int i = 0; i < 10; ++i)
qDebug("%i", i);

<translate>
// correct</translate>
if (true) {
return true;
}

for (int i = 0; i < 10; ++i) {
qDebug("%i", i);
}
</syntaxhighlight>

<translate>
== Switch statements == 
Case labels are on the same column as the switch


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
switch (myEnum) {
case Value1:
doSomething();
break;
case Value2:
doSomethingElse();
// fall through
default:
defaultHandling();
break;
}
</syntaxhighlight>

<translate>
== Line breaks == 
Try to keep lines shorter than 100 characters, inserting line breaks as necessary.

== Qt Includes == 
* If you add #includes for Qt classes, use both the module and class name. This allows library code to be used by applications without excessive compiler include paths.


Example:
</translate>
<syntaxhighlight lang="cpp-qt">
<translate>
// wrong</translate>
#include <QString>

<translate>
// correct</translate>
#include <QtCore/QString>
</syntaxhighlight>

<translate>
== Artistic Style (astyle) automatic code formatting == 
You can use [http://astyle.sourceforge.net/ astyle] (>=1.23) to format code or to test if you have followed this document. Run the following command:
</translate>
<syntaxhighlight lang="text">
astyle --indent=spaces=4 --brackets=linux \
--indent-labels --pad=oper --unpad=paren \
--one-line=keep-statements --convert-tabs \
--indent-preprocessor \
`find -type f -name '*.cpp'` `find -type f -name '*.cc'` `find -type f -name '*.h'`
</syntaxhighlight>

<translate>

With astyle (>=2.01) you need to run the following command:
</translate>
<syntaxhighlight lang="text">
astyle --indent=spaces=4 --brackets=linux \
--indent-labels --pad-oper --unpad-paren --pad-header \
--keep-one-line-statements --convert-tabs \
--indent-preprocessor \
`find -type f -name '*.cpp'` `find -type f -name '*.cc'` `find -type f -name '*.h'`
</syntaxhighlight>

<translate>

A related shell script could be found for unix in [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/astyle-kdelibs kdesdk/scripts/astyle-kdelibs] and for windows in [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/astyle-kdelibs.bat kdesdk/scripts/astyle-kdelibs.bat].

== Emacs and Vim scripts == 
The "scripts" directory in the kdesdk module contains, among other useful things, some useful additions to the Emacs and Vim text editors that make it easier to edit KDE code with them.

=== Emacs ===
The [http://websvn.kde.org/trunk/KDE/kdesdk/scripts/kde-emacs kde-emacs] directory contains a set of key bindings, macros and general useful code. It is compatible with both GNU Emacs and XEmacs.


To start using kde-emacs, add the following to your .emacs:
</translate>

<syntaxhighlight lang="text">
(add-to-list 'load-path "/path/to/kde-emacs")
(require 'kde-emacs)
</syntaxhighlight>

<translate>

Many settings can be changed by editing the "kde-emacs" group via <tt>M-x customize-group</tt>.


For more information, including what the key bindings are and what additional settings you could add to your .emacs, please check <tt>kde-emacs.el</tt> itself.

=== Vim === 
You can find a vim script in [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/kde-devel-vim.vim kdesdk/scripts/kde-devel-vim.vim] that helps you to keep the coding style correct. In addition to defaulting to the kdelibs coding style it will automatically use the correct style for Solid and kdepim code. If you want to add rules for other projects feel free to add them in the SetCodingStyle function.


To use the script, include it in your {{path|~/.vimrc}} like this:
</translate>
<syntaxhighlight lang="text">
source /path/to/kde/sources/kdesdk/scripts/kde-devel-vim.vim
</syntaxhighlight>

<translate>

Document started by Urs Wolfer. Some parts of this document have been adopted from the Qt Coding Style document posted by Zack Rusin on kde-core-devel.


[[Category:Policies]] [[Category:C++]]
</translate>

Projects/Oxygen/Style

2011-09-17T19:52:21Z

Jstaniek: /* Color Usage */ fix palettes path

=Oxygen Icon Style Guide=
{{warning|'''The Oxygen Icon Style is currently a work in progress:''' This is the newest version, but several sections need expanding.}}

== Oxygen's Approach to Icon Sizes ==
Oxygen icons are all scalable vector graphics (SVG) documents, which is the default format used by [http://inkscape.org Inkscape]. These SVG files are used to render bitmap images (PNG) at various sizes.

Oxygen uses the 128x128 'pixel' SVG files to produce icons at 5 different sizes: 128x128, 64x64, 48x48, 32x32 and 16x16 pixel images. 88x88 'pixel' SVG files are used to render at 22x22 pixels. Optionally, 16x16 pixel icons can be created in a 64x64 'pixel' SVG file.

For icons that are designed to be rendered at 32x32, 22x22 and 16x16 it is crucial that icons elements align to pixel boundaries of the rendered icon to improve legibility. After rendering to 22x22 and 16x16, icons will probably need some hand optimization using the GIMP. There is little point in making a 22x22 and 16x16 PNG icon if all that was done was to export a PNG from the 128 pixel SVG.

Various templates are provided to assist you in creating Oxygen icons. They are linked to below.

{{note|Only action icons ''require'' the shadow at the bottom of the icon. For all other types you may remove this shadow.}}

=== 16x16 ===
'''Either:'''

*Use the [http://websvn.kde.org/*checkout*/trunk/playground/artwork/Oxygen/templates/action_32x32.template.svg 32x32 template]
*Set the grid to 8 pixels
*Preview the icon by zooming out to 13%
**Quickly tap the minus key six times

'''Or:'''

*Use an Inkscape document with dimensions of 64x64 pixels
*Set the grid to 4 pixels
*Preview the icon by zooming out to 25%
**Quickly tap the minus key four times

=== 22x22 ===
*Use the [http://websvn.kde.org/*checkout*/trunk/playground/artwork/Oxygen/templates/action_22x22.template.svg 22x22 template].
*Set the grid to 4 pixels
*Preview the icon by zooming out to 25%
**Quickly tap the minus key four times

=== 32x32 ===
*Use the [http://websvn.kde.org/*checkout*/trunk/playground/artwork/Oxygen/templates/action_32x32.template.svg 32x32 template]
*Set the grid to 4 pixels
*Preview the icon by zooming out to 25%
**Quickly tap the minus key four times

=== 48x48 ===
*Use the [http://websvn.kde.org/*checkout*/trunk/playground/artwork/Oxygen/templates/action_32x32.template.svg 32x32 template]

=== 64x64 ===
*Use the [http://websvn.kde.org/*checkout*/trunk/playground/artwork/Oxygen/templates/action_32x32.template.svg 32x32 template]
*Set the grid to 4 pixels
*Preview the icon by zooming out to 50%
**Press the '2' key

=== 128x128 ===
*Use the [http://websvn.kde.org/*checkout*/trunk/playground/artwork/Oxygen/templates/action_32x32.template.svg 32x32 template]
*Set the grid to 1 pixel
*Preview the icon by zoom to 100%
**Press the '1' key

== Color Usage ==
Oxygen has a distinct, defined palette which should '''always''' be adhered to.

[[Image:figure4.png]]

{{Note|
The Oxygen color palette is released under the [http://creativecommons.org/licenses/by-nc-nd/2.5/ Creative Commons Attribution-NonCommercial-NoDerivs 2.5 License].}}

You can easily use the Oxygen Colour scheme in Inkscape by downloading the palette. To download the Oxygen Palette [http://websvn.kde.org/*checkout*/trunk/playground/artwork/Oxygen/utils/oxygen.gpl Click here]

#Close Inkscape, if you have it running
#Place [http://websvn.kde.org/*checkout*/trunk/playground/artwork/Oxygen/utils/oxygen.gpl 'oxygen.gpl'] in this folder: {{path|~/.config/inkscape/palettes/}}
#Start Inkscape
#Select the Oxygen palette in the Swatches dialog (Ctrl+Shift+W).

== Metaphors/Styles for different icon types ==
=== Actions ===

Action icons require a distinctive 1 pixel solid outline. Action icons are drawn to appear as they are on a shelf. This means that a small shadow is drawn directly beneath the icon.

The templates linked above include this shadow, therefore consistancy is ensured.

=== Applications ===

Application icons vary the most in style from cartoonish logos to photo-realistic (example and explanation needed)

=== Mimetypes ===

Mimetypes all use the same paper sheet template (example and explanation needed)

=== Devices ===

Devices are the most realistic of all icons (example and explanation needed)

=== Places ===

Places icons vary in style depending on whether the subject at hand can be defined by a physical object.

=== Emblems ===

Emblems are icons overlaid on top of other icons. Examples of Emblems are the "'link arrow' and the 'mounted star' symbol. These icons should be noticeable but not detract and cover too much of the icon beneath them.

{{Box|Mounted Emblem|[[Image:Oxygen-128-emblem-mounted.png|center]]

''The mounted emblem uses the vibrant colours from the Oxygen palette. The form of the icon itself is very simple and clear.''}}

=== Exporting the PNG bitmaps ===
You can use inkscape to create PNG bitmap images of your icon.

#Press <tt><Ctrl> + <Shift> + E</tt>, or select 'Export Bitmap' from the File menu.
#Select the 'Page' button to export everything inside the page's borders
#Enter the width of the icon you wish to output to. If you press the 'Return/Enter' key, Inkscape will fill the height and resolution/dpi boxes for you
#Enter the path filename of your Icon. Don't forget to use the [http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html Icon Naming Specification]. Also refer to the KDE TechBase article here - [[Projects/Oxygen/namingSpec]]

[[Category:Artwork]][[Category:Oxygen]]

=== Making the final SVG icon to commit/submit ===
Make a copy of the icon with Inkscape.

#Choose "File -> Save As" and select "Plain SVG". This will remove Inkscape specific information which is not necessary to render the image.
#After saving the file, choose "File -> Vacuum Defs", to remove unused definitions, and then save again.

Icons made with Adobe Illustrator.

#When making an icon with AI, be careful not to include Adobe extensions to SVG.
#All Adobe stuff should be removed from the final SVG. It will probably be necessary to use a text editor (such as KWrite) to do this.
#To check for a proper SVG file, open the icon in the Squiggle SVG viewer.

Development/Git/Configuration

2011-07-29T21:18:17Z

Jstaniek: /* URL Renaming */

== Git Configuration ==

How to set up Git for use in KDE.

=== Quick Start ===

To quickly set up git to just build a copy of KDE you do not need to perform any git configuration, however the following steps will simplify using Git:

* [[../Configuration#URL_Renaming|URL Renaming]]

If you plan to commit to a KDE repository using Git then you should follow all the steps on this page.

=== Configuration Levels ===

Your Git configuration operates at 3 levels:
* System
* User
* Repository

The System Level sets up global Git configuration defaults for every User and Repository on your system. We will ignore these for our purposes as they are usually blank.

The User Level (aka Global) sets up the default configuration for a particular User to apply to all repositories used by that User. Settings made at this level will always override any matching System Level settings. The User Configuration is stored in your ~/.gitconfig file.

The Repository Level sets up the configuration for a particular Repository clone. Settings made at this level will always override any matching User or System Level settings. The Repository Configuration is stored in the repository .git/config file.

The recommended KDE Git Configuration will set some settings at a user level and some at a repository level. You may wish to change the level some settings apply at however as we will assume you only or mostly use Git for developing KDE.

You can set Git settings either by directly editing the config files, but it is far safer to use the ''git config'' command.

To set a Git setting at User level (i.e. in ~/.gitconfig):

git config --global <key> <value>

To set a Git setting at repo level (i.e in <repo>/.git/config):

cd <repo>
git config <key> <value>

=== Basic Settings ===

If you plan to commit to KDE Git, then you will need to set up git to use your identity.kde.org name and details to help identify your work:

git config --global user.name <Your Real Name>
git config --global user.email <Your identity.kde.org email>

The name and email address you configure will be used as the author information for every commit you make. Note that in order for commit message keywords such as BUG and CCBUG to work, your Bugzilla account email address has to match the email address used in your commits.

To enable colored output when using git:

git config --global color.ui true

=== Commit Template ===

The Commit Template is a standard layout for commit messages, usually containing instructions for how a project expects messages to formatted and what details are to be included. You can choose to set a User Level template as a default, then use any project level variations at a repo level.

It is recommended to use the kdelibs template as your default. Once you have cloned kdelibs then set as follows to ensure you use the latest available version:

git config --global commit.template <path/to/kdelibs/>.commit-template

If you don't plan to have kdelibs cloned then download the kdelibs template from [https://projects.kde.org/projects/kde/kdelibs/repository/revisions/master/raw/.commit-template here], save as ~/.commit-template, and configure to use that copy:

git config --global commit.template ~/.commit-template

When cloning other KDE repositories, you should check to see if they have a project specific commit template, and if so you should set that at a repo level:

cd <repo>
git config commit.template .commit-template

=== Push Default ===

It is recommended for new Git users to set the push default to nothing:

git config --global push.default nothing

This option forces you to ''always'' enter the name of the remote branch you wish to push to, rather than using a default value. This is good practice as it ensures you push to the correct remote branch and avoid accidentally pushing all local branches to the remote.

More experienced users may wish to set the option to tracking:

git config --global push.default tracking

This will default to push to the remote branch your local branch is tracking, but if you setup your local branch incorrectly you may still accidentally push to the wrong remote.

=== URL Renaming ===

Instead of having to remember and type in the different full git addresses for pulling and pushing, we recommend you manually add the following to your Git User Configuration (~/.gitconfig):

<nowiki>[url "git://anongit.kde.org/"]</nowiki>
insteadOf = kde:
[url "git@git.kde.org:"]
pushInsteadOf = kde:

=== Bash Auto-Completion ===

Bash auto-completion for Git commands and branches may or may not work out-of-the-box for you depending on how Git is installed on your system. To see if you have auto-completion already working type ''git'' on your command line followed by a space and hit the ''tab'' key twice. If you see a list of available git commands then you have Git auto-completion enabled.

If auto-completion does not work for you then you can download the [http://git.kernel.org/?p=git/git.git;a=blob_plain;f=contrib/completion/git-completion.bash;hb=HEAD git-completion.bash] script and follow the instructions inside it.

=== Bash Prompt ===

If you have git-completion.bash installed, you can also add details like the branch name and dirty status to your command prompt, which will save repeated uses of ''git branch'' and ''git status''.

To activate this, you need to add the following to your $PS1 environment variable:

$(__git_ps1 " (%s)")

Note that in the " (%s)" part the %s variable is replaced with the branch name, the rest of the text between the quotes is up to you.

If you have not set a PS1 value yourself, then you are likely to be using your distro default value which you can find out by typing:

echo $PS1

To change this for your user, edit your .bashrc and copy the result of the echo command into there, then change it to add the Git branch.

For example, if ''echo $PS1'' shows:

$(ppwd \l)\u@\h:\w>

then add the following to your .bashrc:

PS1='$(ppwd \l)\u@\h:\w$(__git_ps1 " (%s)")> '

which will show your prompt as follows:

odysseus@argo:~/kde/src/trunk/KDE/kdelibs (master + u+2)>

You can learn more about customizing your bash prompt at http://www.tldp.org/HOWTO/Bash-Prompt-HOWTO/.

You can also have the prompt show the 'dirty' status of your repo, i.e. if you have uncommited changes, and whether your branch differs from upstream HEAD:

* * = unstaged changes
* + = staged changes
* $ = stashed changes
* % = untracked files
* u-1 = behind upstream by 1 commit
* u+2 = ahead of upstream by 2 commits
* u= = same as upstream

To enable showing the dirty (unstaged/staged) state, add the following line to your .bashrc 'before' your PS1 setting:

export GIT_PS1_SHOWDIRTYSTATE=1

To enable showing the stashed state, add the following line to your .bashrc ''before'' your PS1 setting:

export GIT_PS1_SHOWSTASHSTATE=1

To enable showing the untracked state, add the following line to your .bashrc ''before'' your PS1 setting:

export GIT_PS1_SHOWUNTRACKEDFILES=1

To enable showing the upstream state, add the following line to your .bashrc ''before'' your PS1 setting:

export GIT_PS1_SHOWUPSTREAM="auto verbose"

To not show the number of commits ahead or behind remove the "verbose" flag.

To disable showing the dirty state for any one repo:

cd <repo>
git config bash.showDirtyState false

To disable showing the upstream state for any one repo:

cd <repo>
git config bash.showUpstream false

=== Multiple Work Branches ===

You will often want to have more than one build environment in parallel, for example if you want to work on both stable and unstable branches at the same time.

With Git you can easily have many work branches in your repository and easily switch between them. The problem here however is that you can only work on the one branch at a time, and switching branches will usually trigger a massive rebuild of the entire repository.

One solution would be to have a separate repository clone for each branch you wish to work on in parallel, but this takes up more disk space, the clones and branches can easily get out-of-sync, and it makes forward/back porting bug fixes between branches more difficult. If choosing this method then you should make each new clone from your initial local clone rather than from the main repo as this will be quicker.

The ideal solution is for a single git repository clone to provide separate source directories for each branch you wish to work on. This can be achieved using the git-new-workdir script provided in the Git contrib directory. This script uses sym-links to create what appears as a new clone in a separate folder but actually uses the same local clone.

The git-new-workdir script may be installed as part of your system git. If not download the script from [https://github.com/git/git/raw/master/contrib/workdir/git-new-workdir the git repo] and install in your ~/.bin.

For example, assuming your have a kdelibs.git clone living in ~/kde/src/master/kdelibs, then the following command will create a 4.6 work branch in ~/kde/src/4.6/kdelibs:

git-new-workdir ~/kde/src/master/kdelibs ~/kde/src/4.6/kdelibs KDE/4.6

== RSA Key fingerprint for git.kde.org==
c8:45:ba:89:85:11:78:b5:a4:09:d9:31:f6:7f:7c:79

Contribute/Get a Contributor Account

2011-05-01T19:17:12Z

Jstaniek: I learn that reading old text is a bit devastating for newcomers, striked out...

{{warning|This page is yet to be reviewed for changes required by the migration to Git. Information and commands on this page may no longer be valid and should be used with care. Please see the [[Development/Git|KDE Git hub page]] for more details. }}

{{Template:I18n/Language Navigation Bar|Contribute/Get a SVN Account}}
This tutorial is about how to apply for a SVN account for KDE.

<strike>
== Notations ==

* The word ''SVN'' applies to all SVN servers.
* The phrase ''KDE SVN'' refers only to KDE's SVN server.
* The phrase ''anonymous SVN'' means KDE's anonymous SVN mirrors.

== What is KDE SVN? ==

To have write access to KDE SVN, you have to use the main SVN server of KDE. (Anonymous SVN uses mirrors of this server. SVN does not allow you to read from one server and write to another.)

To be able to use the main KDE SVN server, you need an account there. An account is made up of a ''username'' (normally your family name), a password and an email address. The username is for getting in, the password for authenticating and the email address for knowing who to contact if another developer wants to contact the account holder. (The username is sometimes known also as the ''login''.)

A KDE SVN account allows you to write to nearly anywhere in the KDE SVN. However, there are exceptions:
* the KDE SVN internals
* the www module (exceptions can be made for this.)

'''Note''': you can see the accounts in [http://websvn.kde.org/trunk/kde-common/accounts kde-common/accounts]. That is the list of all accounts. Yes, '''the account list is public''', for example on [http://websvn.kde.org WebSVN].

== Who Can Apply For a KDE SVN Account? ==

Normally, any developer who has done some work on KDE can apply for a KDE SVN account.

Translators should get approval from their team leader so that they can organize how the work is being done in his/her team. Please mention the approval from the team leader when requesting the account.

Please also [[Policies/SVN Commit Policy|read the KDE SVN commit policy]]. You must accept these rules when using your future KDE SVN account. Please also familiarize yourself with the [http://www.kde.org/code-of-conduct/ KDE Code of Conduct] which describes the social foundations within KDE.

Also please apply for an account only if you think that you will work on KDE for a somewhat longer time. If you know that you will only work for a couple of weeks and then never again, please consider not applying for a KDE SVN account but still, do continue to send patches.

The limitations are not there to exclude anyone - they are there to ensure that the maintenance of accounts remains reasonable.

Of course, to be clear: ''the KDE's sysadmins have the last word about whether or not to create a KDE SVN account for somebody''.

== SSH ==

You need a SSH public key in order to access your KDE SVN account. If you already have one, you can skip the next subsection and go to [[#Setting up the SVN+SSH protocol|Setting up the SVN+SSH protocol]].

=== Generating the SSH keys ===

To be able to use your KDE SVN account with SSH, you need a SSH public key. Please notice that it is '''not''' a GPG (OpenPGP) key, which is completely unrelated!

The password in the sense of this documentation is the '''public key''' that you are creating.

For more information on how to create a pair o SSH keys, please refer to a [http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-keygen SSH documentation] or book.

In short, the command to create a pair of keys is '''ssh-keygen''' and it requires the type of key you will create, either DSA or RSA - both are fine.

To create a new pair of keys, use <code bash>ssh-keygen -t dsa</code> or <code bash>ssh-keygen -t rsa</code>

There is also a type called RSA1 which was used in version 1 of the SSH protocol. See the [http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-keygen ssh documentation] for more details.

You can then accept the default filename for your key (either {{path|$HOME/.ssh/id_dsa}} or {{path|$HOME/.ssh/id_rsa}}, depending on the type of key you have chosen). After that, a passphrase is asked. It is recommended that you do not leave it blank.

Now that you are finished generating your key pair, you will have two files: a private key and a public key. If you have accepted the default filename, they will be respectively {{path|$HOME/.ssh/id_dsa}} and {{path|$HOME/.ssh/id_dsa.pub}} or {{path|$HOME/.ssh/id_rsa}} and {{path|$HOME/.ssh/id_rsa.pub}}, depending on the type of key you have specified.

The private key '''must''' remain secret, do not publish it to anyone under any circumstance.

The public key can be published and shall be sent when you are applying for a KDE SVN account.

You should also set up <tt>ssh-agent</tt> so you do not have to type the password every time you connect via SSH. There are several tutorials available explaining how to do this, for example [http://mah.everybody.org/docs/ssh this one]. [http://www.gentoo.org/proj/en/keychain Keychain] is a program that makes this task easier.

'''Note''': if you already have an ssh key, you can just use the existing key instead of creating a new one.

{{tip|
If you want to use SVN with SSH with another user than the one who created the keys, you need to copy <tt>$HOME/.ssh/id_dsa.pub</tt> and <tt>$HOME/.ssh/id_dsa</tt> or <tt>$HOME/.ssh/id_rsa.pub</tt> and <tt>$HOME/.ssh/id_rsa</tt> to the other user's <tt>$HOME/.ssh</tt> directory.

You should probably also backup those files.
}}

=== Setting up the SVN+SSH protocol ===

Once you created your key, you'll have to tell SSH that this one should be used for all connections to KDE sites. Add the following lines to the <tt>~/.ssh/config</tt> file. Replace USERNAME with yours.

<pre>
Host *.kde.org
User USERNAME
IdentityFile ~/.ssh/id_dsa
</pre>

The linked IdentityFile must belong to the public key you send in when applying for the SVN account. But it is ''not'' the public key (<tt>*.pub</tt>).

== Apply for an account ==

Now you are ready to apply for for a KDE SVN account. Go to [https://identity.kde.org/ https://identity.kde.org/svnaccount/] and create an account if you don't have one already. If you already have an account, you can use that. After you entered the site you will find a form which you can fill in to apply for an account.

When you register on identity.kde.org, you will need to enter your name and an e-mail address, which has to be your own (a normal address or a KDE Mail address). Of course, do not forget that '''this email address becomes public''' (at least by [http://websvn.kde.org WebSVN]) so you will unfortunately get spam.

Also note that this email address should be the same one that you use on [http://bugs.kde.org bugs.kde.org]. If you don't have an account in [http://bugs.kde.org bugs.kde.org], please create one so that it can be given usual developer rights. Closing bug reports with keywords in commit comments only works if the email address of your Subversion and [http://bugs.kde.org bugs.kde.org] accounts match.

After that, you must choose a username for your KDE SVN account between the suggestions presented to you. Please notice it is not possible to propose something else such as a nickname, as the username must be as close as possible to someone's real name.

If you ask for a KDE email address one day, this will be the base for your address. For example: <tt>username@kde.org</tt>. (Note, however, that KDE email addresses are not granted so easily anymore, as too many people have ranted with a KDE address and other people thought that it was the official position of the KDE Team. In the meantime, [http://www.kdemail.net KDE Mail] was created for if you need a permanent address.)

When applying for developer access you have to provide your public key. This key will be added to your profile. You can always add more keys, delete keys you don't use anymore from your profile page on identity.kde.org.

The form also holds a field ''Why do you want an account?'', where you can explain what you want to do with your future KDE SVN account, like for example developing a certain application, making documentations or being the team leader of a translation.

Also note that the form will ask you who has encouraged you to apply. He or she will also get an email to verify your request.

== Updating Existing Account ==

If you already have a KDE SVN account but want to update the ssh key, you should go to [https://identity.kde.org/ identity.kde.org] and change the keys in your profile.

== And Now? ==

After having sent the form and clicking the link in the email, you have to wait for the answer (typically within two or three days).

Once you have confirmation that your account has been created, you need to adapt your local copy to the new server. See the [[Contribute/First Steps with your KDE SVN Account|next tutorial]] for your first steps with your new account.

Please add your geographical location (what country are you in?) and other details at the [http://commit-digest.org/data/ Commit Digest data page] so that the Commit Digest can accurately reflect who is working where.
</strike>

Development

2011-05-01T19:14:58Z

Jstaniek:

__NOEDITSECTION__ __NOTOC__ {{Template:I18n/Language Navigation Bar|Development}}
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|colspan=2|[[Image:Discover.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_launch.svg|noframe|left|40px]] ||
;[[Development/Architecture|KDE Architecture]]
:Architectural design documents explaining KDE technologies.
:''Related'': [http://api.kde.org API Documentation]
|-
| style="padding-left: 50px;"|[[Image:Action_configure.svg|noframe|left|40px]] ||
;[[Development/Tutorials|Programming Tutorials]]
:Step by step tutorials for KDE development.
:''Related:'' [[Development/Tools|Development Tools]] | [[Development/FAQs|FAQs]]
|-
| style="padding-left: 50px;"|[[Image:Action_rebuild.svg|noframe|left|40px]] ||
;[[Development/Languages|Programming Languages]]
:Supported programming languages for KDE development.
|-
| style="padding-left: 50px;"|[[Image:CMake-logo-48.png|noframe|left|48px]] ||
;[[Development/CMake|CMake]]
:CMake related information.
|-
| style="padding-left: 50px;"|[[Image:Git-logo.svg|noframe|left|48px]] ||
;[[Development/Git|Version-control System - Git]]
:Git related information.
|-
| style="padding-left: 50px;" |[[Image:Action_note.svg|noframe|left|40px]] ||
;[[Development/Guidelines|Standards & Guidelines]]
:Developer guidelines and technical standards KDE uses.
:''Related:'' [[Policies|Code Contribution and Development Policies]] | [[Development/Further Information|Further Information]] (links, books, blogs, etc.)
|-
| style="padding-left: 50px;" |[[Image:Action_tool.svg|noframe|left|40px]] ||
;[[Development/Software Engineering Framework|Software Engineering Framework]]
:Software Engineering tools and processes used by KDE.
|-
| style="padding-left: 50px;" |[[Image:Action_help.svg|noframe|left|40px]] ||
;[[Development/Getting Help|Getting Help]]
:Resources for finding help with KDE development.
|-
|}

Projects/Kexi/Build

2010-02-08T23:28:38Z

Jstaniek:

Started by [[User:Jstaniek|Jstaniek]], 8 February 2010

__TOC__

==Packaging==
===SQLite packaging===
See [http://kdedevelopers.org/node/4156] and [http://www.piggz.co.uk/?page=blogentry&id=53] for background.

'''Goal for Kexi 2.2''': compile with at least SQLITE_SECURE_DELETE support enabled, SQLITE_ENABLE_FTS3 recommended.

Status of SQLite support by distribution:

*Mandriva [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/sqlite3/current/SPECS/sqlite3.spec?view=markup]
**SQLITE_SECURE_DELETE enabled on 2009-02-08
**flags: -DSQLITE_ENABLE_COLUMN_METADATA=1 -DSQLITE_ENABLE_FTS3=3 -DSQLITE_ENABLE_RTREE=1 -Wall -DNDEBUG=1 -DSQLITE_SECURE_DELETE=1
*Debian: ....
**SQLITE_SECURE_DELETE enabled
*Ubuntu: ....
*Fedora: ....
*KDE on Mac: ...
*KDE on Windows: ...
*...

*All distributions:
**SQLITE_SECURE_DELETE cannot be disabled, e.g. at runtime
***contacted the SQLite.org team for solution

Projects/Kexi/Build

2010-02-08T23:28:24Z

Jstaniek:

Started by [[User:Jstaniek|Jstaniek]], 8 February 2010

==Packaging==
===SQLite packaging===
See [http://kdedevelopers.org/node/4156] and [http://www.piggz.co.uk/?page=blogentry&id=53] for background.

'''Goal for Kexi 2.2''': compile with at least SQLITE_SECURE_DELETE support enabled, SQLITE_ENABLE_FTS3 recommended.

Status of SQLite support by distribution:

*Mandriva [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/sqlite3/current/SPECS/sqlite3.spec?view=markup]
**SQLITE_SECURE_DELETE enabled on 2009-02-08
**flags: -DSQLITE_ENABLE_COLUMN_METADATA=1 -DSQLITE_ENABLE_FTS3=3 -DSQLITE_ENABLE_RTREE=1 -Wall -DNDEBUG=1 -DSQLITE_SECURE_DELETE=1
*Debian: ....
**SQLITE_SECURE_DELETE enabled
*Ubuntu: ....
*Fedora: ....
*KDE on Mac: ...
*KDE on Windows: ...
*...

*All distributions:
**SQLITE_SECURE_DELETE cannot be disabled, e.g. at runtime
***contacted the SQLite.org team for solution

Projects/Kexi/Build

2010-02-08T23:28:13Z

Jstaniek:

Started at: [[User:Jstaniek|Jstaniek]], 8 February 2010

==Packaging==
===SQLite packaging===
See [http://kdedevelopers.org/node/4156] and [http://www.piggz.co.uk/?page=blogentry&id=53] for background.

'''Goal for Kexi 2.2''': compile with at least SQLITE_SECURE_DELETE support enabled, SQLITE_ENABLE_FTS3 recommended.

Status of SQLite support by distribution:

*Mandriva [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/sqlite3/current/SPECS/sqlite3.spec?view=markup]
**SQLITE_SECURE_DELETE enabled on 2009-02-08
**flags: -DSQLITE_ENABLE_COLUMN_METADATA=1 -DSQLITE_ENABLE_FTS3=3 -DSQLITE_ENABLE_RTREE=1 -Wall -DNDEBUG=1 -DSQLITE_SECURE_DELETE=1
*Debian: ....
**SQLITE_SECURE_DELETE enabled
*Ubuntu: ....
*Fedora: ....
*KDE on Mac: ...
*KDE on Windows: ...
*...

*All distributions:
**SQLITE_SECURE_DELETE cannot be disabled, e.g. at runtime
***contacted the SQLite.org team for solution

Projects/Kexi/Build

2010-02-08T23:27:53Z

Jstaniek:

[[User:Jstaniek|Jstaniek]] 23:27, 8 February 2010 (UTC)

==Packaging==
===SQLite packaging===
See [http://kdedevelopers.org/node/4156] and [http://www.piggz.co.uk/?page=blogentry&id=53] for background.

'''Goal for Kexi 2.2''': compile with at least SQLITE_SECURE_DELETE support enabled, SQLITE_ENABLE_FTS3 recommended.

Status of SQLite support by distribution:

*Mandriva [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/sqlite3/current/SPECS/sqlite3.spec?view=markup]
**SQLITE_SECURE_DELETE enabled on 2009-02-08
**flags: -DSQLITE_ENABLE_COLUMN_METADATA=1 -DSQLITE_ENABLE_FTS3=3 -DSQLITE_ENABLE_RTREE=1 -Wall -DNDEBUG=1 -DSQLITE_SECURE_DELETE=1
*Debian: ....
**SQLITE_SECURE_DELETE enabled
*Ubuntu: ....
*Fedora: ....
*KDE on Mac: ...
*KDE on Windows: ...
*...

*All distributions:
**SQLITE_SECURE_DELETE cannot be disabled, e.g. at runtime
***contacted the SQLite.org team for solution

Projects/Kexi/Build

2010-02-08T23:27:44Z

Jstaniek:

[[User:Jstaniek|Jstaniek]]

==Packaging==
===SQLite packaging===
See [http://kdedevelopers.org/node/4156] and [http://www.piggz.co.uk/?page=blogentry&id=53] for background.

'''Goal for Kexi 2.2''': compile with at least SQLITE_SECURE_DELETE support enabled, SQLITE_ENABLE_FTS3 recommended.

Status of SQLite support by distribution:

*Mandriva [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/sqlite3/current/SPECS/sqlite3.spec?view=markup]
**SQLITE_SECURE_DELETE enabled on 2009-02-08
**flags: -DSQLITE_ENABLE_COLUMN_METADATA=1 -DSQLITE_ENABLE_FTS3=3 -DSQLITE_ENABLE_RTREE=1 -Wall -DNDEBUG=1 -DSQLITE_SECURE_DELETE=1
*Debian: ....
**SQLITE_SECURE_DELETE enabled
*Ubuntu: ....
*Fedora: ....
*KDE on Mac: ...
*KDE on Windows: ...
*...

*All distributions:
**SQLITE_SECURE_DELETE cannot be disabled, e.g. at runtime
***contacted the SQLite.org team for solution

Projects/Kexi/Build

2010-02-08T23:27:10Z

Jstaniek: Created page with '==Packaging== ===SQLite packaging=== See [http://kdedevelopers.org/node/4156] and [http://www.piggz.co.uk/?page=blogentry&id=53] for background. '''Goal for Kexi 2.2''': compile...'

==Packaging==
===SQLite packaging===
See [http://kdedevelopers.org/node/4156] and [http://www.piggz.co.uk/?page=blogentry&id=53] for background.

'''Goal for Kexi 2.2''': compile with at least SQLITE_SECURE_DELETE support enabled, SQLITE_ENABLE_FTS3 recommended.

Status of SQLite support by distribution:

*Mandriva [http://svn.mandriva.com/cgi-bin/viewvc.cgi/packages/cooker/sqlite3/current/SPECS/sqlite3.spec?view=markup]
**SQLITE_SECURE_DELETE enabled on 2009-02-08
**flags: -DSQLITE_ENABLE_COLUMN_METADATA=1 -DSQLITE_ENABLE_FTS3=3 -DSQLITE_ENABLE_RTREE=1 -Wall -DNDEBUG=1 -DSQLITE_SECURE_DELETE=1
*Debian: ....
**SQLITE_SECURE_DELETE enabled
*Ubuntu: ....
*Fedora: ....
*KDE on Mac: ...
*KDE on Windows: ...
*...

*All distributions:
**SQLITE_SECURE_DELETE cannot be disabled, e.g. at runtime
***contacted the SQLite.org team for solution

Projects/Mobile

2009-10-27T16:21:09Z

Jstaniek: /* Overview */

== Overview ==
* [http://maemo.org/intro/platform/ '''maemo'''] is the core software stack that runs on mobile devices like Nokia's N810 or N900
* [https://garage.maemo.org/ '''garage'''] is where the projects for maemo are hosted, somewhat compareable to Sourceforge.
* [http://en.wikipedia.org/wiki/Maemo#Diablo '''Diablo'''] is the version (feature upgrade 2008) of maemo. Compare it with Debian's Lenny.
* [http://www.scratchbox.org/ '''Scratchbox'''] is a cross-compiling environment to enable you to create software for maemo on an i386.
* [http://www.busybox.net/ '''Busybox'''] is a single binary that allows you to run commands like ls, cat and bunzip2
* [http://en.wikipedia.org/wiki/Hildon '''Hildon'''] is an application framework and desktop shell for maemo, compare it to the role that Plasma plays in KDE 4

There is a [https://mail.kde.org/mailman/listinfo/kde-maemo kde-maemo mailinglist].

== KDE on Maemo ==

This page is for collecting information about getting KDE running on the Maemo platform used by the Nokia mobile devices N800, N810 and N900.

* Instructions on getting a Maemo development environment on openSuSE http://en.opensuse.org/Maemo
* There is also a KDE on maemo project at http://kde.garage.maemo.org/
* [http://www.forwardbias.in/data/articles/qt_on_maemo.txt Tutorial how to get Qt installed on maemo]
* [[Projects/Maemo/kdepim|Tutorial how to compile KDEPIM on maemo]]
* [[Projects/Maemo/KDE4_on_n810|Tutorial how to get KDE installed on Maemo]]
* [[Projects/Maemo/KDE4_on_Mer|Tutorial how to get KDE installed on Mer]]

=== Some blogs entries about KDE on Maemo ===

''Most recent on top''

* [http://www.kdedevelopers.org/node/3672 Marijn Kruisselbrink: Having fun with qemu]
* [http://www.kdedevelopers.org/node/3662 Marijn Kruisselbrink: KOffice on Maemo]
* [http://blog.forwardbias.in/2008/08/n810-is-awesome.html Girish Ramakrishnan: N810 is awesome]
* [http://www.kdedevelopers.org/node/3628 Fredrik Gladhorn: Various Qt apps]
* [http://www.kdedevelopers.org/node/3624 Marijn Kruisselbrink: KDE packages for maemo]
* [http://www.notmart.org/index.php/Software/Misc_plasmoids_on_n810 Marco Martin: Misc plasmoids on n810]
* [http://www.notmart.org/index.php/BlaBla/Akademy,_810_and_stuffs Marco Martin: Akademy, 810 and stuffs]
* [http://www.kdedevelopers.org/node/3623 Richard Dale: Building Ruby on the N810]
* [http://www.fredemmott.co.uk/blog_156 Fred Emmott: Ogg/Vorbis on N810]
* [http://www.omat.nl/drupal/content/N810-and-OpenStreetMap-and-toma Tom Albers: N810 and OpenStreetMap and toma]
* [http://tsdgeos.blogspot.com/2008/08/maemo-scratchbox-on-amd64.html Albert Astals Cid: Maemo scratchbox on amd64]
* [http://blogs.forum.nokia.com/blog/kate-alholas-forum-nokia-blog/maemo/2008/08/13/akademy-2008-embedded-day Kate Alhola: Akademy 2008 Embedded day]
* [http://www.gnuton.org/blog/2008/07/qt-4-maemo-the-new-experience/ Antonio Aloisio: Qt 4 Maemo: the new experience.]
* [http://www.kdedevelopers.org/node/3605 Marijn Kruisselbrink: Getting KDE on an n810.]
* [http://www.kdedevelopers.org/node/3575 Marijn Kruisselbrink: Sound on Maemo]
* [http://www.kdedevelopers.org/node/3546 Marijn Kruisselbrink: Plasma on Maemo]

Projects/Mobile

2009-10-27T16:19:43Z

Jstaniek: /* Overview */ fix

== Overview ==
* [http://maemo.org/intro/platform/ '''maemo'''] is the core software stack that runs on mobile devices like Nokia's N810 or N900
* [https://garage.maemo.org/ '''garage'''] is where the projects for maemo are hosted, somewhat compareable to Sourceforge.
* ''Diablo'' is the version (release) of maemo. Compare it with Debian's Lenny.
* [http://www.scratchbox.org/ '''scratchbox'''] is a cross-compiling environment to enable you to create software for maemo on an i386.
* [http://www.busybox.net/ '''Busybox'''] is a single binary that allows you to run commands like ls, cat and bunzip2
* [http://en.wikipedia.org/wiki/Hildon '''Hildon'''] is an application framework and desktop shell for maemo, compare it to the role that Plasma plays in KDE 4

There is a [https://mail.kde.org/mailman/listinfo/kde-maemo kde-maemo mailinglist].

== KDE on Maemo ==

This page is for collecting information about getting KDE running on the Maemo platform used by the Nokia mobile devices N800, N810 and N900.

* Instructions on getting a Maemo development environment on openSuSE http://en.opensuse.org/Maemo
* There is also a KDE on maemo project at http://kde.garage.maemo.org/
* [http://www.forwardbias.in/data/articles/qt_on_maemo.txt Tutorial how to get Qt installed on maemo]
* [[Projects/Maemo/kdepim|Tutorial how to compile KDEPIM on maemo]]
* [[Projects/Maemo/KDE4_on_n810|Tutorial how to get KDE installed on Maemo]]
* [[Projects/Maemo/KDE4_on_Mer|Tutorial how to get KDE installed on Mer]]

=== Some blogs entries about KDE on Maemo ===

''Most recent on top''

* [http://www.kdedevelopers.org/node/3672 Marijn Kruisselbrink: Having fun with qemu]
* [http://www.kdedevelopers.org/node/3662 Marijn Kruisselbrink: KOffice on Maemo]
* [http://blog.forwardbias.in/2008/08/n810-is-awesome.html Girish Ramakrishnan: N810 is awesome]
* [http://www.kdedevelopers.org/node/3628 Fredrik Gladhorn: Various Qt apps]
* [http://www.kdedevelopers.org/node/3624 Marijn Kruisselbrink: KDE packages for maemo]
* [http://www.notmart.org/index.php/Software/Misc_plasmoids_on_n810 Marco Martin: Misc plasmoids on n810]
* [http://www.notmart.org/index.php/BlaBla/Akademy,_810_and_stuffs Marco Martin: Akademy, 810 and stuffs]
* [http://www.kdedevelopers.org/node/3623 Richard Dale: Building Ruby on the N810]
* [http://www.fredemmott.co.uk/blog_156 Fred Emmott: Ogg/Vorbis on N810]
* [http://www.omat.nl/drupal/content/N810-and-OpenStreetMap-and-toma Tom Albers: N810 and OpenStreetMap and toma]
* [http://tsdgeos.blogspot.com/2008/08/maemo-scratchbox-on-amd64.html Albert Astals Cid: Maemo scratchbox on amd64]
* [http://blogs.forum.nokia.com/blog/kate-alholas-forum-nokia-blog/maemo/2008/08/13/akademy-2008-embedded-day Kate Alhola: Akademy 2008 Embedded day]
* [http://www.gnuton.org/blog/2008/07/qt-4-maemo-the-new-experience/ Antonio Aloisio: Qt 4 Maemo: the new experience.]
* [http://www.kdedevelopers.org/node/3605 Marijn Kruisselbrink: Getting KDE on an n810.]
* [http://www.kdedevelopers.org/node/3575 Marijn Kruisselbrink: Sound on Maemo]
* [http://www.kdedevelopers.org/node/3546 Marijn Kruisselbrink: Plasma on Maemo]

Projects/Mobile

2009-10-27T16:19:20Z

Jstaniek: /* Overview */ more links and sort them

== Overview ==
* [http://maemo.org/intro/platform/ '''maemo'''] is the core software stack that runs on mobile devices like Nokia's N810 or N900
* [https://garage.maemo.org/ '''garage'''] is where the projects for maemo are hosted, somewhat compareable to Sourceforge.
* ''Diablo'' is the version (release) of maemo. Compare it with Debian's Lenny.
* [http://www.scratchbox.org/ '''scratchbox'''] is a cross-compiling environment to enable you to create software for maemo on an i386.
* [http://www.busybox.net/ '''Busybox'''] is a single binary that allows you to run commands like ls, cat and bunzip2
* [http://en.wikin pedia.org/wiki/Hildon '''Hildon'''] is an application framework and desktop shell for maemo, compare it to the role that Plasma plays in KDE 4

There is a [https://mail.kde.org/mailman/listinfo/kde-maemo kde-maemo mailinglist].

== KDE on Maemo ==

This page is for collecting information about getting KDE running on the Maemo platform used by the Nokia mobile devices N800, N810 and N900.

* Instructions on getting a Maemo development environment on openSuSE http://en.opensuse.org/Maemo
* There is also a KDE on maemo project at http://kde.garage.maemo.org/
* [http://www.forwardbias.in/data/articles/qt_on_maemo.txt Tutorial how to get Qt installed on maemo]
* [[Projects/Maemo/kdepim|Tutorial how to compile KDEPIM on maemo]]
* [[Projects/Maemo/KDE4_on_n810|Tutorial how to get KDE installed on Maemo]]
* [[Projects/Maemo/KDE4_on_Mer|Tutorial how to get KDE installed on Mer]]

=== Some blogs entries about KDE on Maemo ===

''Most recent on top''

* [http://www.kdedevelopers.org/node/3672 Marijn Kruisselbrink: Having fun with qemu]
* [http://www.kdedevelopers.org/node/3662 Marijn Kruisselbrink: KOffice on Maemo]
* [http://blog.forwardbias.in/2008/08/n810-is-awesome.html Girish Ramakrishnan: N810 is awesome]
* [http://www.kdedevelopers.org/node/3628 Fredrik Gladhorn: Various Qt apps]
* [http://www.kdedevelopers.org/node/3624 Marijn Kruisselbrink: KDE packages for maemo]
* [http://www.notmart.org/index.php/Software/Misc_plasmoids_on_n810 Marco Martin: Misc plasmoids on n810]
* [http://www.notmart.org/index.php/BlaBla/Akademy,_810_and_stuffs Marco Martin: Akademy, 810 and stuffs]
* [http://www.kdedevelopers.org/node/3623 Richard Dale: Building Ruby on the N810]
* [http://www.fredemmott.co.uk/blog_156 Fred Emmott: Ogg/Vorbis on N810]
* [http://www.omat.nl/drupal/content/N810-and-OpenStreetMap-and-toma Tom Albers: N810 and OpenStreetMap and toma]
* [http://tsdgeos.blogspot.com/2008/08/maemo-scratchbox-on-amd64.html Albert Astals Cid: Maemo scratchbox on amd64]
* [http://blogs.forum.nokia.com/blog/kate-alholas-forum-nokia-blog/maemo/2008/08/13/akademy-2008-embedded-day Kate Alhola: Akademy 2008 Embedded day]
* [http://www.gnuton.org/blog/2008/07/qt-4-maemo-the-new-experience/ Antonio Aloisio: Qt 4 Maemo: the new experience.]
* [http://www.kdedevelopers.org/node/3605 Marijn Kruisselbrink: Getting KDE on an n810.]
* [http://www.kdedevelopers.org/node/3575 Marijn Kruisselbrink: Sound on Maemo]
* [http://www.kdedevelopers.org/node/3546 Marijn Kruisselbrink: Plasma on Maemo]

Projects/KDE on Windows/Installation

2009-08-28T10:15:40Z

Jstaniek: /* Download needed packages */ prev change sucked on oygen style; use br

{{Template:I18n/Language Navigation Bar|Projects/KDE_on_Windows/Installation}}

{{note|Perhaps actual developers should summarize status of KDE4 on Windows here, while we encourage users to describe their experiences on the [[Talk:{{PAGENAME}}|Talk page?]]}}

== KDE Installer for Windows ==
You can use this installer to download and install the
various binary packages that you need to run KDE applications on MS Windows.
KDE is free and open source so you can build all the applications "from scratch" from their source code;
but as a convenience for others,
volunteers create these pre-compiled packages and make them available on the Internet.

'''Disclaimer''' These are early days for KDE4 on Windows,
some programs work better than others and some fail to run altogether.

'''If you experience any problems please have a look into our [http://lists.kde.org/?l=kde-windows&r=1&w=2| mailing list].'''

You can also use the KDE Installer for Windows to install source code and the packages that you need to ''build'' KDE4 on Windows
(although if you are building KDE4 on Windows you may prefer to use the emerge system to build KDE and its requirements from latest source);
see [[Getting Started/Build/KDE4/Windows]].

=== Summary of Steps ===
* Download and save the latest version of the installer from [http://www.winkde.org/pub/kde/ports/win32/installer/kdewin-installer-gui-latest.exe here] to a directory, e.g. <tt>C:\KDE4</tt>
* Run the installer, download and install what you need (see [[#Download needed packages|Download needed packages]] below).
* Try to run a KDE application from the windows start menu (see for KDE x.x.x Release entry)

=== Download needed packages ===
 
 
[[File:installer-001.png|600px]]
 
When you run KDE-installer for the first time, you'll see the welcome screen. Since it's your first launch leave the checkbox below unchecked.
 
 
[[File:installer-002.png|600px]]
 
Proceed to the next screen, where you choose the KDE4 installation directory. It can be anything you prefer, e.g. C:\KDE4.
 
 
[[File:installer-003.png|600px]]
 
On the next screen, define who you are: End User or Developer. The End User installation installs only binary packages and libraries needed to run KDE application. Package Manager mode provides you also with the source code for all packages needed to build KDE from scratch. Then you need to decide what compiler to use - MinGW or MSVC.
 
 
[[File:installer-004.png|600px]]
 
Proceed to the next screen and there choose the directory where all the downloaded packages will be stored. Let it be something like C:\KDE4-tmp or C:\KDE4-packages.
 
 
[[File:installer-005.png|600px]]
 
The next screen will ask you to choose your internet connection type, particularly whether or not you're using a proxy. If you don't use a proxy server, just click 'Next'. If you are unsure of whether you're using proxy or if you have web browser configured to work with it properly, choose the second or the third option, according to your favourite web-browser. If you'd like to set all the settings manually - choose the last option and go ahead.
 
 
[[File:installer-006.png|600px]]
 
When you click the 'Next' button the (currently, rather short) list of available servers will be loaded and you could choose the one closest to you.
 
 
[[File:installer-007.png|600px]]
 
When you click 'Next', a list of available releases on the selected server will be shown. Depending on the server there may be stable and/or unstable release available. Some unstable releases may only be available from www.winkde.org because the kde mirrors provides only a limited range of unstable releases.
 
 
[[File:installer-008.png|600px]]
 
After selecting a release an a click on the 'Next' button, the list of all available packages will be loaded and processed, providing you with the list of package groups you can select for further installation. The short description next to each group of packages should make your choice easier. Select the packages you need. Proceed to the next screen.
 
 
[[File:installer-009.png|600px]]
 
Here you can see all the required dependencies, or software necessary to support the choices you've made. Click 'Next' to download them all.
 
 
[[File:installer-0010.png|600px]]
 
[[File:installer-011.png|600px]]
 
After all the packages are downloaded they'll be unpacked and processed by the installer.
 
 
[[File:installer-012.png|600px]]
 
The final window will tell that your KDE installation for Windows is complete.
 

=== Issues with KDE Installer for Windows ===
If something goes wrong during installation, for example a file can't be replaced because it is still in use, the installer may still report successful completion. If you see any alert or failure message from the installer, when it completes, quit and re-run it. 
If that didn't help and you think it's a bug, please report to [mailto:kde-windows@kde.org]

== Testing your installation ==
Navigate to the <tt>bin</tt> directory.

See if you can run the Qt program assistant.exe.
Qt programs have fewer dependencies than a full-blown KDE application.

If that works, try running a simple KDE application, such as lskat.exe from the kdegames package.

Look into your start menu: there will be a new entry KDE 4.XX.XX Release. Below that folder you can find all the apps you installed.

=== Startup, shutdown, and diagnosing problems ===
The first KDE program you run should automatically invoke <tt>kdeinit4.exe</tt>, the KDE initialization app,
which starts background KDE applications and services like dbus-daemon, klauncher and kded4.

The first time you save or open, another background application, kioslave, will start.

These background KDE applications and services remain running after you close KDE applications. If you want you can shut them down by running <tt>kdeinit4 --terminate</tt> from a command prompt.

You can run <tt>kdeinit4 --list</tt> from a command prompt to see what processes are running. <tt>kdeinit4</tt> has other useful options documented elsewhere.

== Fine-tuning ==
=== Common step: editing the kdeglobals file ===
Unless otherwise stated you make all the setting changes below by editing the <tt>kdeglobals</tt> file in the directory <tt>%APPDATA%\.kde\share\config\</tt> with any text editor (such as kwrite).
(Note that for versions older than 4.0.85 the file is in <tt>%USERPROFILE%\.kde\share\config\kdeglobals</tt>.)
%APPDATA% (and %USERPROFILE%) is different for different Windows users/versions/locales; in a command prompt, entering the command <tt>cd %APPDATA%</tt> will switch to it, effectively telling you what it is.

===Set Oxygen style for widgets===
The default KDE widget style on Windows is the native one. The Oxygen style installs with basic KDE installation (as a plugin library %KDEROOT%\lib\kde4\plugins\styles\oxygen.dll), so it can be used as well. To set it for a single user:
# edit kdeglobals
#locate the General section (a line containing the text "[General]"). If there is no General section, create one.
#Within the General section ([General]), edit the line containing <tt>widgetStyle=....</tt> so that it reads <tt>widgetStyle=oxygen</tt>. If there is no such <tt>widgetStyle=...</tt> line, create it.
Newly started applications should be displayed with the Oxygen style now.

===Set Tahoma (Windows default font) for widgets===
To set it for a single user:
# edit kdeglobals
#locate the General section (a line containing the text "[General]"). If there is no General section, create one.
#Within the General section ([General]), add these two lines:
<tt>font=Tahoma 
menuFont=Tahoma</tt>

Newly started applications should use this font now.
Note: this works for any font you have installed.

===Change the mouse to Double Click===
To change the mouse to use double click:
#Add a new section with a line: 
<tt>[KDE] 
SingleClick=false</tt> 
Newly started applications (Dolphin and Konqueror) should use double click now.
===Change locale and country settings===
To change locale setting:
#Add a new section with the line: 
<tt>[Locale] 
Country=** 
Language=**</tt> 
Replace ** with your lowercase [http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 alpha-2 country code], e.g. pl for Poland; of course, you need to install your language localization package.
===Change native/KDE file dialogs===
To chose native or KDE file dialog:
#Add a new section with the lines: 
<tt> [KFileDialog Settings] 
Native=false</tt> 
Either set Native to true or false.

== Status ==
Using kdewin-installer-gui-0.9.3.exe to install 4.1.3 packages:
* starting a KDE program correctly starts dbus-daemon.exe
* many games run
* choosing File > Open correctly starts klauncher.exe, kioslave.exe and kded4.exe, and runs kbuildsycoca4.exe as needed.
* Full-text search in khelpcenter does not work because Perl scripts are disabled.
* Many applications have a generic icon in Windows Explorer.
* Multimedia support should work, although video support might be missing (from the backend)

General notes:
* There are many other KDE programs that are not part of KDE 4.0.0 and are not currently packaged for MS Windows.
* By design, KDE-windows does not provide the full-blown KDE desktop, a preview on the plasma shell replacement will be available in 4.1.2 - Nevertheless this does not rely on kwin/X11 which means that desktop effects are not available
* Some KDE programs use UNIX-specific features, such as konsole's use of pseudo-terminals, and thus are difficult (read: currently impossible) to port to MS Windows.

=== Package status and contents ===
{| border="0" cellpadding="2"
|-valign="top"
!package
!status
!contains applications
|-valign="top"
|amarok
|packaged
|Amarok music player
|-valign="top"
|Digikam
|packaged
|Photo management
|-valign="top"
|kdebase-apps
|packaged
|Konqueror, Dolphin, KWrite, folderview etc.
|-valign="top"
|kdebase-workspace
|packaged
|Plasma, Wallpapers, Solid, etc.
|-valign="top"
|kdeedu
|packaged
|Marble, Parley, KStars, KHangman, etc.
|-valign="top"
|kdegames
|packaged
|Kgoldrunner, Kpat, KMahjongg, etc.
|-valign="top"
|kdegraphics
|packaged
|Okular, kolourpaint, gwenview, etc.
|-valign="top"
|kdemultimedia
|packaged
|JuK, etc.
|-valign="top"
|kdenetwork
|packaged
|Kopete, KGet, etc.
|-valign="top"
|kdepim
|not packaged
|KMail, AKregator, etc.
|-valign="top"
|kdesdk
|packaged
|Kate, Umbrello, etc.
|-valign="top"
|kdetoys
|packaged
|KTeatime, etc.
|-valign="top"
|kdeutils
|packaged
|KGpg, KWallet, Okteta, etc.
|-valign="top"
|koffice
|packaged
|KWord, Krita, Karbon, etc. (Beta 3)
|-valign="top"
|ktorrent
|packaged
|the KTorrent utility
|-valign="top"
|konversation
|packaged
|the KDE IRC client (alpha 3)
|}

[[Category: MS Windows]]

Projects/KDE on Windows/Installation

2009-08-28T10:10:00Z

Jstaniek: /* Download needed packages */ put all that into a table, so is better layed out

{{Template:I18n/Language Navigation Bar|Projects/KDE_on_Windows/Installation}}

{{note|Perhaps actual developers should summarize status of KDE4 on Windows here, while we encourage users to describe their experiences on the [[Talk:{{PAGENAME}}|Talk page?]]}}

== KDE Installer for Windows ==
You can use this installer to download and install the
various binary packages that you need to run KDE applications on MS Windows.
KDE is free and open source so you can build all the applications "from scratch" from their source code;
but as a convenience for others,
volunteers create these pre-compiled packages and make them available on the Internet.

'''Disclaimer''' These are early days for KDE4 on Windows,
some programs work better than others and some fail to run altogether.

'''If you experience any problems please have a look into our [http://lists.kde.org/?l=kde-windows&r=1&w=2| mailing list].'''

You can also use the KDE Installer for Windows to install source code and the packages that you need to ''build'' KDE4 on Windows
(although if you are building KDE4 on Windows you may prefer to use the emerge system to build KDE and its requirements from latest source);
see [[Getting Started/Build/KDE4/Windows]].

=== Summary of Steps ===
* Download and save the latest version of the installer from [http://www.winkde.org/pub/kde/ports/win32/installer/kdewin-installer-gui-latest.exe here] to a directory, e.g. <tt>C:\KDE4</tt>
* Run the installer, download and install what you need (see [[#Download needed packages|Download needed packages]] below).
* Try to run a KDE application from the windows start menu (see for KDE x.x.x Release entry)

=== Download needed packages ===
{| width="100%"
|- valign="top"
|[[File:installer-001.png|600px|left|]]
|When you run KDE-installer for the first time, you'll see the welcome screen. Since it's your first launch leave the checkbox below unchecked.
|- valign="top"
|[[File:installer-002.png|600px|left|]]
|Proceed to the next screen, where you choose the KDE4 installation directory. It can be anything you prefer, e.g. C:\KDE4.
|- valign="top"
|[[File:installer-003.png|600px|left|]]
|On the next screen, define who you are: End User or Developer. The End User installation installs only binary packages and libraries needed to run KDE application. Package Manager mode provides you also with the source code for all packages needed to build KDE from scratch. Then you need to decide what compiler to use - MinGW or MSVC.
|- valign="top"
|[[File:installer-004.png|600px|left|]]
|Proceed to the next screen and there choose the directory where all the downloaded packages will be stored. Let it be something like C:\KDE4-tmp or C:\KDE4-packages.
|- valign="top"
|[[File:installer-005.png|600px|left|]]
|The next screen will ask you to choose your internet connection type, particularly whether or not you're using a proxy. If you don't use a proxy server, just click 'Next'. If you are unsure of whether you're using proxy or if you have web browser configured to work with it properly, choose the second or the third option, according to your favourite web-browser. If you'd like to set all the settings manually - choose the last option and go ahead.
|- valign="top"
|[[File:installer-006.png|600px|left|]]
|When you click the 'Next' button the (currently, rather short) list of available servers will be loaded and you could choose the one closest to you.
|- valign="top"
|[[File:installer-007.png|600px|left|]]
|When you click 'Next', a list of available releases on the selected server will be shown. Depending on the server there may be stable and/or unstable release available. Some unstable releases may only be available from www.winkde.org because the kde mirrors provides only a limited range of unstable releases.
|- valign="top"
|[[File:installer-008.png|600px|left|]]
|After selecting a release an a click on the 'Next' button, the list of all available packages will be loaded and processed, providing you with the list of package groups you can select for further installation. The short description next to each group of packages should make your choice easier. Select the packages you need. Proceed to the next screen.
|- valign="top"
|[[File:installer-009.png|600px|left|]]
|Here you can see all the required dependencies, or software necessary to support the choices you've made. Click 'Next' to download them all.
|- valign="top"
|[[File:installer-0010.png|600px|left|]]\
|
|- valign="top"
|[[File:installer-011.png|600px|left|]]
|After all the packages are downloaded they'll be unpacked and processed by the installer.
|- valign="top"
|[[File:installer-012.png|600px|left|]]
|The final window will tell that your KDE installation for Windows is complete.
|-
|}

=== Issues with KDE Installer for Windows ===
If something goes wrong during installation, for example a file can't be replaced because it is still in use, the installer may still report successful completion. If you see any alert or failure message from the installer, when it completes, quit and re-run it. 
If that didn't help and you think it's a bug, please report to [mailto:kde-windows@kde.org]

== Testing your installation ==
Navigate to the <tt>bin</tt> directory.

See if you can run the Qt program assistant.exe.
Qt programs have fewer dependencies than a full-blown KDE application.

If that works, try running a simple KDE application, such as lskat.exe from the kdegames package.

Look into your start menu: there will be a new entry KDE 4.XX.XX Release. Below that folder you can find all the apps you installed.

=== Startup, shutdown, and diagnosing problems ===
The first KDE program you run should automatically invoke <tt>kdeinit4.exe</tt>, the KDE initialization app,
which starts background KDE applications and services like dbus-daemon, klauncher and kded4.

The first time you save or open, another background application, kioslave, will start.

These background KDE applications and services remain running after you close KDE applications. If you want you can shut them down by running <tt>kdeinit4 --terminate</tt> from a command prompt.

You can run <tt>kdeinit4 --list</tt> from a command prompt to see what processes are running. <tt>kdeinit4</tt> has other useful options documented elsewhere.

== Fine-tuning ==
=== Common step: editing the kdeglobals file ===
Unless otherwise stated you make all the setting changes below by editing the <tt>kdeglobals</tt> file in the directory <tt>%APPDATA%\.kde\share\config\</tt> with any text editor (such as kwrite).
(Note that for versions older than 4.0.85 the file is in <tt>%USERPROFILE%\.kde\share\config\kdeglobals</tt>.)
%APPDATA% (and %USERPROFILE%) is different for different Windows users/versions/locales; in a command prompt, entering the command <tt>cd %APPDATA%</tt> will switch to it, effectively telling you what it is.

===Set Oxygen style for widgets===
The default KDE widget style on Windows is the native one. The Oxygen style installs with basic KDE installation (as a plugin library %KDEROOT%\lib\kde4\plugins\styles\oxygen.dll), so it can be used as well. To set it for a single user:
# edit kdeglobals
#locate the General section (a line containing the text "[General]"). If there is no General section, create one.
#Within the General section ([General]), edit the line containing <tt>widgetStyle=....</tt> so that it reads <tt>widgetStyle=oxygen</tt>. If there is no such <tt>widgetStyle=...</tt> line, create it.
Newly started applications should be displayed with the Oxygen style now.

===Set Tahoma (Windows default font) for widgets===
To set it for a single user:
# edit kdeglobals
#locate the General section (a line containing the text "[General]"). If there is no General section, create one.
#Within the General section ([General]), add these two lines:
<tt>font=Tahoma 
menuFont=Tahoma</tt>

Newly started applications should use this font now.
Note: this works for any font you have installed.

===Change the mouse to Double Click===
To change the mouse to use double click:
#Add a new section with a line: 
<tt>[KDE] 
SingleClick=false</tt> 
Newly started applications (Dolphin and Konqueror) should use double click now.
===Change locale and country settings===
To change locale setting:
#Add a new section with the line: 
<tt>[Locale] 
Country=** 
Language=**</tt> 
Replace ** with your lowercase [http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 alpha-2 country code], e.g. pl for Poland; of course, you need to install your language localization package.
===Change native/KDE file dialogs===
To chose native or KDE file dialog:
#Add a new section with the lines: 
<tt> [KFileDialog Settings] 
Native=false</tt> 
Either set Native to true or false.

== Status ==
Using kdewin-installer-gui-0.9.3.exe to install 4.1.3 packages:
* starting a KDE program correctly starts dbus-daemon.exe
* many games run
* choosing File > Open correctly starts klauncher.exe, kioslave.exe and kded4.exe, and runs kbuildsycoca4.exe as needed.
* Full-text search in khelpcenter does not work because Perl scripts are disabled.
* Many applications have a generic icon in Windows Explorer.
* Multimedia support should work, although video support might be missing (from the backend)

General notes:
* There are many other KDE programs that are not part of KDE 4.0.0 and are not currently packaged for MS Windows.
* By design, KDE-windows does not provide the full-blown KDE desktop, a preview on the plasma shell replacement will be available in 4.1.2 - Nevertheless this does not rely on kwin/X11 which means that desktop effects are not available
* Some KDE programs use UNIX-specific features, such as konsole's use of pseudo-terminals, and thus are difficult (read: currently impossible) to port to MS Windows.

=== Package status and contents ===
{| border="0" cellpadding="2"
|-valign="top"
!package
!status
!contains applications
|-valign="top"
|amarok
|packaged
|Amarok music player
|-valign="top"
|Digikam
|packaged
|Photo management
|-valign="top"
|kdebase-apps
|packaged
|Konqueror, Dolphin, KWrite, folderview etc.
|-valign="top"
|kdebase-workspace
|packaged
|Plasma, Wallpapers, Solid, etc.
|-valign="top"
|kdeedu
|packaged
|Marble, Parley, KStars, KHangman, etc.
|-valign="top"
|kdegames
|packaged
|Kgoldrunner, Kpat, KMahjongg, etc.
|-valign="top"
|kdegraphics
|packaged
|Okular, kolourpaint, gwenview, etc.
|-valign="top"
|kdemultimedia
|packaged
|JuK, etc.
|-valign="top"
|kdenetwork
|packaged
|Kopete, KGet, etc.
|-valign="top"
|kdepim
|not packaged
|KMail, AKregator, etc.
|-valign="top"
|kdesdk
|packaged
|Kate, Umbrello, etc.
|-valign="top"
|kdetoys
|packaged
|KTeatime, etc.
|-valign="top"
|kdeutils
|packaged
|KGpg, KWallet, Okteta, etc.
|-valign="top"
|koffice
|packaged
|KWord, Krita, Karbon, etc. (Beta 3)
|-valign="top"
|ktorrent
|packaged
|the KTorrent utility
|-valign="top"
|konversation
|packaged
|the KDE IRC client (alpha 3)
|}

[[Category: MS Windows]]

Development/Tutorials/Debugging/Debugging on MS Windows

2009-08-22T11:37:49Z

Jstaniek: /* One-step attaching to running application */

=General Hints=
==Debugging with WinDbg==
WinDbg, distributed as a part of ''Debugging Tools for Windows'', is a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps. It uses the Microsoft Visual Studio debug symbol formats for source-level debugging. [[Projects/KDE_on_Windows/Tools#WinDbg|more...]]

==Debugging with DebugView==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool, coming from SysInternals (currently acquired by Microsoft). [[Projects/KDE_on_Windows/Tools#DebugView|more...]]

==Debugging kioslaves==
kioslaves on windows are started by klauncher (or kio) as separate kioslave processes. The kioslave executable then loads the related kioslave dll dynamically.

=== Using KDE_SLAVE_DEBUG_WAIT variable ===
To debug kioslaves:
#Set the KDE_SLAVE_DEBUG_WAIT environment variable in a current cmd.exe shell to the name of the kioslave's protocol (the first parameter of KIO::SlaveBase() constructor), e.g.<pre>set KDE_SLAVE_DEBUG_WAIT=file</pre>
#Terminate <tt>klauncher</tt> process so it can be restarted.
#Any application you want to debug at kioslave level have to be executed within the scope of the current environment (cmd.exe), what also means that if you want to use development environment, you have to do that in the environment as well, e.g. for MSVC Express, by typing <tt>vcexpress</tt>.

If the kioslave is requested the next time, a debugger will be started and attached to the kioslave process immediatly before the kioslave's kdemain() function.

On mingw platform gdb is launched and connected to the kioslave process. On msvc platforms the currently installed just-in-time debugger is used. This may be msvc's IDE or the [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg debugger]]. The latter could be set as jit-debugger by running 'windbg -I' command (capital -I like ICE, see [http://msdn2.microsoft.com/en-us/library/cc266343.aspx]).

=== Using KDE_SLAVE_DEBUG_POPUP variable ===
Alternatively, you can set <tt>KDE_SLAVE_DEBUG_POPUP</tt> variable instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. This will display a native message box so developer you can attach the debugger to the KIO slave process and click OK. No DebugBreak() is invoked. Just click OK without attaching to continue using the KIO slave without debugging.

=== Notes ===
*You can set, say, the variable to 'file' for the kio_file slave, '''but''' set it to 'smtps' for the kio_smtp is you want to debug smtp protocol secured with SSL.
*(Vista only): ''kioslave.exe has stopped working'' message dialog can appear instead of offer for starting the debugger. Reason: Just-In-Time (JIT) Debugging of an elevated process will fail ([http://msdn2.microsoft.com/en-us/vstudio/aa964140.aspx#question20a msdn link]) apparently for security reasons. Either:
**Use <tt>KDE_SLAVE_DEBUG_POPUP</tt> instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. See the [[#Using_KDE_SLAVE_DEBUG_POPUP_variable|Using KDE_SLAVE_DEBUG_POPUP variable]] above for more info.
**(not possible under msvc 2005): start applications and klauncher without administration permissions or attach the debugger manually before the debugger catches unhandled exceptions or an user-defined breakpoint (DebugBreak()).
*You may want to inspect kioslave sources [http://lxr.kde.org/source/KDE/kdelibs/kinit/kioslave.cpp] for more informations.

== Checking dependency of shared libraries ==
Dependency Walker is a free utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. [[Projects/KDE_on_Windows/Tools#Dependency_Walker|more...]]

= MS Visual Studio hints =

== Using MS Visual Studio environment for just debugging ==

Let's assume you're using command line tools (typically CMake) and want to use MS Visual Studio environment for just debugging. You don't need to create msvc project for your KDE application to be able to start debugging.

* compile and working executable version of your appliation (compiled in debug mode)
* run msvc environment
* execute ''File->Open Project/Solution''
* pick your exe file in the file window
* you can set command line arguments as usual, by pick ''Project->...Properties'' command and enter all of them it in ''Command Arguments'' field
* if you have libraries placed in other directories than your application's .exe file, and you want to step into these libraries' source code while debugging, pick ''Project->...Properties'' command and enter paths to these directories in ''Symbol Path'' field
* hit F5 to run the application start the application or F10 to start step by step
* all debugging functions like setting breakpoints will be available, so you can open source code in the integrated editor and press F9 where needed
* you can even edit your source code but to compile it, do it with your external, command line tools. You cannot compile the application in the msvc environment because you have not defined a project file
* before compiling your application, stop debugging session to unlock binaries; no need to close msvc window
* after compilation you can start debugging again
* on exit you will be asked to save .sln file (so-called ''solution file'') with your debugging session -- do it and you will be able just to click the .sln file to start your debugging again
* it's recommended to save the .sln file in the same directory where the .exe file sits
*hints on reopening the debugging session:
**Next time you will run msvc environment, you can see name of your application's .sln file in ''File->Recent Projects'' submenu - you can click it to load your debugging session.
**On command line you can type "cd path-to-your-sln-file; <yourfilename>.sln".
**You can also use "vcexpress /debugexe <myapplication> <args>".

== Attaching to running application ==

If you have your application is already running, you can attach to it and then start debugging.

* run the msvc development environment
* execute ''Debug->Atach to Process''
* select your from the processes list and click "Attach..."
* msvc environment will load your .sln file if it exists in the same directory as the .exe file, so your breakpoints set in previous session will be active again
* your program will stop on any breakpoint you have set

== One-step attaching to running application ==
*You can create a macro that automates the task. See [http://blogs.msdn.com/jimgries/archive/2005/11/30/498264.aspx].
*MSVC 2008 or later can always attach to the running process when you execute "Start Debugging" command (F5). Just set the "Attach" option to "Yes" in the "Project->[yourapp] Properties" window. Note that in this case if the process is not present, you will experience "Unable to attach error" message, so you need to start the process intependently of the development environment first. The advantage of this is faster startup of your application.

== Memory Values ==
If you are using the debug heap, memory is initialized and cleared with special values. Most interesting values are:
* 0xCDCDCDCD - Allocated in heap, but not initialized
* 0xDDDDDDDD - Released heap memory.
* 0xFDFDFDFD - "NoMansLand" fences automatically placed at boundary of heap memory. Should never be overwritten. If you do overwrite one, you're probably walking off the end of an array.
* 0xCCCCCCCC - Allocated on stack, but not initialized
See also: [http://www.samblackburn.com/wfc/technotes/WTN006.htm]

==How to Not Step Into Functions in the Debugger==
You'll probably want to avoind stepping into lower-level functions like QString constructors or operators while debugging step-by-step. Here's the detailed (unofficial) [http://blogs.msdn.com/andypennell/archive/2004/02/06/69004.aspx instruction] for various msvc versions.

==Enable automatic expanding of Qt data structures==
From the msvc docs: "While debugging, Data Tips and items in the Watch and Variable windows are automatically expanded to show their most important elements. The expansion follows the format given by the rules in this file. You can add rules for your types or change the predefined rules." ([http://www.thedatafarm.com/blog/content/binary/datatips2.jpg example screen])

MSVC 2005: To add support for expanding Qt data structures like QString of QRect, edit {msvc_installation_directory}\Common7\Packages\Debugger\autoexp.dat file and paste [[/Automatic expanding of Qt data structures|definitions]] after [AutoExpand] line.

MSVC 2008: You can improve:
*Debugger support for Qt datatypes using autoexp.dat
*IntelliSense behaviour by adding Qt include directories
For details read http://eecs.vanderbilt.edu/research/hmtl/wiki/pmwiki.php?n=Knowledge.Qt

==WINDOWS and CONSOLE subsystems==
CONSOLE subsystem is the one that displays console window (used for standard output and error streams) in addition to application's windows. WINDOWS subsystem redirects standard output and error streams to system debugging subsystem that can be displayed if needed in [[Projects/KDE_on_Windows/Tools#DebugView|DebugView]] or debuggers like msvc or [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg]].
Hint: To remove CONSOLE subsystem from already built .exe file, type <code>editbin /subsystem:windows file.exe</code>
Note: Qt's qmake syntax supports ''console'' and ''windows'' parameters of the ''CONFIG'' variable, so CONSOLE subsystem can be enabled by specifying <tt>CONFIG += console</tt> in the .pro file, windows subsystem can be enabled with <tt>CONFIG += windows</tt>.

==Deployment==
Running a VC++2005 SP1 app on another computer: manifest files are needed. See [http://www.codeproject.com/KB/cpp/vcredists_x86.aspx] and [http://blogs.msdn.com/nikolad/archive/2005/09/02/460368.aspx].

===Note on debug builds===
The hints above are for release builds (or ReleaseWithDebugInfo). Moving Debug versions of binaries to other computers is only allowed (and technicallu possible) if you have Express Edition installed there, as there is no redistributable package for Debug versions provided and even the license disallows distribution of any debug binaries (even your own).

= MinGW debugging hints =

There are gdb binaries you can directly run after unpacking them, e.g. from
[http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=20507 mingw's gdb downloads on sourceforge].

To get a backtrace for a crash you can reproduce: Start the gdb binary with the full path to the executable on the command line, for example like
<code>..\gdb\gdb.exe c:\programme\kontact\bin\kontact.exe</code>. When getting
the command prompt use the run command with the arguments for your application, e.g <code>run --nofork</code>. Now wait until your applications starts and go on reproducing the crash. Once you encounter the crash, gdb will be in control
in the command line again. <code>bt</code> will get you the backtrace.

Instead of running gdb from the beginning, you can also attach to a running process. Use the regular "task-manager" to see which process. Enable the process id columns so you can see the number. Now you can start gdb (still give it the path to the application executable if you can) and use the <code>attach</code> command with the process id you want to attach to from the
gdb prompt. Gdb will stop the process it attached to, so you can say <code>continue</code> and then try to produce the crash.

* Dr. Mingw - Just in Time Debugger [http://jrfonseca.planetaclix.pt/projects/gnu-win32/software/drmingw/]
* Debugging Qt programs on Windows [http://lists.trolltech.com/qt-interest/2005-08/thread01124-0.html]

'''''WARNING''''': If you are having crashes when starting applications via gdb beware of certain applications (mostly anti-virus software) that could cause problems like "Embassy Trust Suite", for example. See this [http://www.cygwin.com/ml/cygwin/2007-06/msg00405.html post].

[[Category:MS Windows]]

Development/Tutorials/Debugging/Debugging on MS Windows

2009-08-22T11:34:44Z

Jstaniek: /* Attaching to running application */

=General Hints=
==Debugging with WinDbg==
WinDbg, distributed as a part of ''Debugging Tools for Windows'', is a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps. It uses the Microsoft Visual Studio debug symbol formats for source-level debugging. [[Projects/KDE_on_Windows/Tools#WinDbg|more...]]

==Debugging with DebugView==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool, coming from SysInternals (currently acquired by Microsoft). [[Projects/KDE_on_Windows/Tools#DebugView|more...]]

==Debugging kioslaves==
kioslaves on windows are started by klauncher (or kio) as separate kioslave processes. The kioslave executable then loads the related kioslave dll dynamically.

=== Using KDE_SLAVE_DEBUG_WAIT variable ===
To debug kioslaves:
#Set the KDE_SLAVE_DEBUG_WAIT environment variable in a current cmd.exe shell to the name of the kioslave's protocol (the first parameter of KIO::SlaveBase() constructor), e.g.<pre>set KDE_SLAVE_DEBUG_WAIT=file</pre>
#Terminate <tt>klauncher</tt> process so it can be restarted.
#Any application you want to debug at kioslave level have to be executed within the scope of the current environment (cmd.exe), what also means that if you want to use development environment, you have to do that in the environment as well, e.g. for MSVC Express, by typing <tt>vcexpress</tt>.

If the kioslave is requested the next time, a debugger will be started and attached to the kioslave process immediatly before the kioslave's kdemain() function.

On mingw platform gdb is launched and connected to the kioslave process. On msvc platforms the currently installed just-in-time debugger is used. This may be msvc's IDE or the [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg debugger]]. The latter could be set as jit-debugger by running 'windbg -I' command (capital -I like ICE, see [http://msdn2.microsoft.com/en-us/library/cc266343.aspx]).

=== Using KDE_SLAVE_DEBUG_POPUP variable ===
Alternatively, you can set <tt>KDE_SLAVE_DEBUG_POPUP</tt> variable instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. This will display a native message box so developer you can attach the debugger to the KIO slave process and click OK. No DebugBreak() is invoked. Just click OK without attaching to continue using the KIO slave without debugging.

=== Notes ===
*You can set, say, the variable to 'file' for the kio_file slave, '''but''' set it to 'smtps' for the kio_smtp is you want to debug smtp protocol secured with SSL.
*(Vista only): ''kioslave.exe has stopped working'' message dialog can appear instead of offer for starting the debugger. Reason: Just-In-Time (JIT) Debugging of an elevated process will fail ([http://msdn2.microsoft.com/en-us/vstudio/aa964140.aspx#question20a msdn link]) apparently for security reasons. Either:
**Use <tt>KDE_SLAVE_DEBUG_POPUP</tt> instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. See the [[#Using_KDE_SLAVE_DEBUG_POPUP_variable|Using KDE_SLAVE_DEBUG_POPUP variable]] above for more info.
**(not possible under msvc 2005): start applications and klauncher without administration permissions or attach the debugger manually before the debugger catches unhandled exceptions or an user-defined breakpoint (DebugBreak()).
*You may want to inspect kioslave sources [http://lxr.kde.org/source/KDE/kdelibs/kinit/kioslave.cpp] for more informations.

== Checking dependency of shared libraries ==
Dependency Walker is a free utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. [[Projects/KDE_on_Windows/Tools#Dependency_Walker|more...]]

= MS Visual Studio hints =

== Using MS Visual Studio environment for just debugging ==

Let's assume you're using command line tools (typically CMake) and want to use MS Visual Studio environment for just debugging. You don't need to create msvc project for your KDE application to be able to start debugging.

* compile and working executable version of your appliation (compiled in debug mode)
* run msvc environment
* execute ''File->Open Project/Solution''
* pick your exe file in the file window
* you can set command line arguments as usual, by pick ''Project->...Properties'' command and enter all of them it in ''Command Arguments'' field
* if you have libraries placed in other directories than your application's .exe file, and you want to step into these libraries' source code while debugging, pick ''Project->...Properties'' command and enter paths to these directories in ''Symbol Path'' field
* hit F5 to run the application start the application or F10 to start step by step
* all debugging functions like setting breakpoints will be available, so you can open source code in the integrated editor and press F9 where needed
* you can even edit your source code but to compile it, do it with your external, command line tools. You cannot compile the application in the msvc environment because you have not defined a project file
* before compiling your application, stop debugging session to unlock binaries; no need to close msvc window
* after compilation you can start debugging again
* on exit you will be asked to save .sln file (so-called ''solution file'') with your debugging session -- do it and you will be able just to click the .sln file to start your debugging again
* it's recommended to save the .sln file in the same directory where the .exe file sits
*hints on reopening the debugging session:
**Next time you will run msvc environment, you can see name of your application's .sln file in ''File->Recent Projects'' submenu - you can click it to load your debugging session.
**On command line you can type "cd path-to-your-sln-file; <yourfilename>.sln".
**You can also use "vcexpress /debugexe <myapplication> <args>".

== Attaching to running application ==

If you have your application is already running, you can attach to it and then start debugging.

* run the msvc development environment
* execute ''Debug->Atach to Process''
* select your from the processes list and click "Attach..."
* msvc environment will load your .sln file if it exists in the same directory as the .exe file, so your breakpoints set in previous session will be active again
* your program will stop on any breakpoint you have set

== One-step attaching to running application ==
*You can create a macro that automates the task. See [http://blogs.msdn.com/jimgries/archive/2005/11/30/498264.aspx].
*MSVC 2008 or later can always attach to the running process (if exists) when you execute "Start Debugging" command (F5). Just set the "Attach" option to "Yes" in the "Project->[yourapp] Properties" window.

== Memory Values ==
If you are using the debug heap, memory is initialized and cleared with special values. Most interesting values are:
* 0xCDCDCDCD - Allocated in heap, but not initialized
* 0xDDDDDDDD - Released heap memory.
* 0xFDFDFDFD - "NoMansLand" fences automatically placed at boundary of heap memory. Should never be overwritten. If you do overwrite one, you're probably walking off the end of an array.
* 0xCCCCCCCC - Allocated on stack, but not initialized
See also: [http://www.samblackburn.com/wfc/technotes/WTN006.htm]

==How to Not Step Into Functions in the Debugger==
You'll probably want to avoind stepping into lower-level functions like QString constructors or operators while debugging step-by-step. Here's the detailed (unofficial) [http://blogs.msdn.com/andypennell/archive/2004/02/06/69004.aspx instruction] for various msvc versions.

==Enable automatic expanding of Qt data structures==
From the msvc docs: "While debugging, Data Tips and items in the Watch and Variable windows are automatically expanded to show their most important elements. The expansion follows the format given by the rules in this file. You can add rules for your types or change the predefined rules." ([http://www.thedatafarm.com/blog/content/binary/datatips2.jpg example screen])

MSVC 2005: To add support for expanding Qt data structures like QString of QRect, edit {msvc_installation_directory}\Common7\Packages\Debugger\autoexp.dat file and paste [[/Automatic expanding of Qt data structures|definitions]] after [AutoExpand] line.

MSVC 2008: You can improve:
*Debugger support for Qt datatypes using autoexp.dat
*IntelliSense behaviour by adding Qt include directories
For details read http://eecs.vanderbilt.edu/research/hmtl/wiki/pmwiki.php?n=Knowledge.Qt

==WINDOWS and CONSOLE subsystems==
CONSOLE subsystem is the one that displays console window (used for standard output and error streams) in addition to application's windows. WINDOWS subsystem redirects standard output and error streams to system debugging subsystem that can be displayed if needed in [[Projects/KDE_on_Windows/Tools#DebugView|DebugView]] or debuggers like msvc or [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg]].
Hint: To remove CONSOLE subsystem from already built .exe file, type <code>editbin /subsystem:windows file.exe</code>
Note: Qt's qmake syntax supports ''console'' and ''windows'' parameters of the ''CONFIG'' variable, so CONSOLE subsystem can be enabled by specifying <tt>CONFIG += console</tt> in the .pro file, windows subsystem can be enabled with <tt>CONFIG += windows</tt>.

==Deployment==
Running a VC++2005 SP1 app on another computer: manifest files are needed. See [http://www.codeproject.com/KB/cpp/vcredists_x86.aspx] and [http://blogs.msdn.com/nikolad/archive/2005/09/02/460368.aspx].

===Note on debug builds===
The hints above are for release builds (or ReleaseWithDebugInfo). Moving Debug versions of binaries to other computers is only allowed (and technicallu possible) if you have Express Edition installed there, as there is no redistributable package for Debug versions provided and even the license disallows distribution of any debug binaries (even your own).

= MinGW debugging hints =

There are gdb binaries you can directly run after unpacking them, e.g. from
[http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=20507 mingw's gdb downloads on sourceforge].

To get a backtrace for a crash you can reproduce: Start the gdb binary with the full path to the executable on the command line, for example like
<code>..\gdb\gdb.exe c:\programme\kontact\bin\kontact.exe</code>. When getting
the command prompt use the run command with the arguments for your application, e.g <code>run --nofork</code>. Now wait until your applications starts and go on reproducing the crash. Once you encounter the crash, gdb will be in control
in the command line again. <code>bt</code> will get you the backtrace.

Instead of running gdb from the beginning, you can also attach to a running process. Use the regular "task-manager" to see which process. Enable the process id columns so you can see the number. Now you can start gdb (still give it the path to the application executable if you can) and use the <code>attach</code> command with the process id you want to attach to from the
gdb prompt. Gdb will stop the process it attached to, so you can say <code>continue</code> and then try to produce the crash.

* Dr. Mingw - Just in Time Debugger [http://jrfonseca.planetaclix.pt/projects/gnu-win32/software/drmingw/]
* Debugging Qt programs on Windows [http://lists.trolltech.com/qt-interest/2005-08/thread01124-0.html]

'''''WARNING''''': If you are having crashes when starting applications via gdb beware of certain applications (mostly anti-virus software) that could cause problems like "Embassy Trust Suite", for example. See this [http://www.cygwin.com/ml/cygwin/2007-06/msg00405.html post].

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-22T11:05:33Z

Jstaniek: /* Improve Integration with the Visual Studio Environment */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
** [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
** [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]
{{Note|It is recommended to install Visual studio into a path not containing spaces. To do this, change the installation path from the proposed ..\Program Files\ to something like c:\vc9.}}

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvarsall.bat</tt> to set your environment variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK. It is installed into %PROGRAMFILES%\Microsoft SDKs\Windows.
Only version 6.0a is installed by the Visual Studio 2008 Express installer, while 6.1 is required to compile KDE components. So also download and install [http://www.microsoft.com/downloads/details.aspx?FamilyID=e6e1c3df-a74f-4207-8586-711ebe331cdc&displaylang=en version 6.1, i.e. Windows SDK for Windows Server 2008] by hand. See also the [http://msdn.microsoft.com/en-us/windowsserver/dd146047.aspx Which SDK is Right for Me?] document.

=== Improve Integration with the Visual Studio Environment ===
-> [[Development/Tutorials/Debugging/Debugging_on_MS_Windows#Enable_automatic_expanding_of_Qt_data_structures|Enable automatic expanding of Qt data structures]]

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Development/Tutorials/Debugging/Debugging on MS Windows

2009-08-22T11:04:35Z

Jstaniek: /* Enable automatic expanding of Qt data structures */

=General Hints=
==Debugging with WinDbg==
WinDbg, distributed as a part of ''Debugging Tools for Windows'', is a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps. It uses the Microsoft Visual Studio debug symbol formats for source-level debugging. [[Projects/KDE_on_Windows/Tools#WinDbg|more...]]

==Debugging with DebugView==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool, coming from SysInternals (currently acquired by Microsoft). [[Projects/KDE_on_Windows/Tools#DebugView|more...]]

==Debugging kioslaves==
kioslaves on windows are started by klauncher (or kio) as separate kioslave processes. The kioslave executable then loads the related kioslave dll dynamically.

=== Using KDE_SLAVE_DEBUG_WAIT variable ===
To debug kioslaves:
#Set the KDE_SLAVE_DEBUG_WAIT environment variable in a current cmd.exe shell to the name of the kioslave's protocol (the first parameter of KIO::SlaveBase() constructor), e.g.<pre>set KDE_SLAVE_DEBUG_WAIT=file</pre>
#Terminate <tt>klauncher</tt> process so it can be restarted.
#Any application you want to debug at kioslave level have to be executed within the scope of the current environment (cmd.exe), what also means that if you want to use development environment, you have to do that in the environment as well, e.g. for MSVC Express, by typing <tt>vcexpress</tt>.

If the kioslave is requested the next time, a debugger will be started and attached to the kioslave process immediatly before the kioslave's kdemain() function.

On mingw platform gdb is launched and connected to the kioslave process. On msvc platforms the currently installed just-in-time debugger is used. This may be msvc's IDE or the [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg debugger]]. The latter could be set as jit-debugger by running 'windbg -I' command (capital -I like ICE, see [http://msdn2.microsoft.com/en-us/library/cc266343.aspx]).

=== Using KDE_SLAVE_DEBUG_POPUP variable ===
Alternatively, you can set <tt>KDE_SLAVE_DEBUG_POPUP</tt> variable instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. This will display a native message box so developer you can attach the debugger to the KIO slave process and click OK. No DebugBreak() is invoked. Just click OK without attaching to continue using the KIO slave without debugging.

=== Notes ===
*You can set, say, the variable to 'file' for the kio_file slave, '''but''' set it to 'smtps' for the kio_smtp is you want to debug smtp protocol secured with SSL.
*(Vista only): ''kioslave.exe has stopped working'' message dialog can appear instead of offer for starting the debugger. Reason: Just-In-Time (JIT) Debugging of an elevated process will fail ([http://msdn2.microsoft.com/en-us/vstudio/aa964140.aspx#question20a msdn link]) apparently for security reasons. Either:
**Use <tt>KDE_SLAVE_DEBUG_POPUP</tt> instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. See the [[#Using_KDE_SLAVE_DEBUG_POPUP_variable|Using KDE_SLAVE_DEBUG_POPUP variable]] above for more info.
**(not possible under msvc 2005): start applications and klauncher without administration permissions or attach the debugger manually before the debugger catches unhandled exceptions or an user-defined breakpoint (DebugBreak()).
*You may want to inspect kioslave sources [http://lxr.kde.org/source/KDE/kdelibs/kinit/kioslave.cpp] for more informations.

== Checking dependency of shared libraries ==
Dependency Walker is a free utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. [[Projects/KDE_on_Windows/Tools#Dependency_Walker|more...]]

= MS Visual Studio hints =

== Using MS Visual Studio environment for just debugging ==

Let's assume you're using command line tools (typically CMake) and want to use MS Visual Studio environment for just debugging. You don't need to create msvc project for your KDE application to be able to start debugging.

* compile and working executable version of your appliation (compiled in debug mode)
* run msvc environment
* execute ''File->Open Project/Solution''
* pick your exe file in the file window
* you can set command line arguments as usual, by pick ''Project->...Properties'' command and enter all of them it in ''Command Arguments'' field
* if you have libraries placed in other directories than your application's .exe file, and you want to step into these libraries' source code while debugging, pick ''Project->...Properties'' command and enter paths to these directories in ''Symbol Path'' field
* hit F5 to run the application start the application or F10 to start step by step
* all debugging functions like setting breakpoints will be available, so you can open source code in the integrated editor and press F9 where needed
* you can even edit your source code but to compile it, do it with your external, command line tools. You cannot compile the application in the msvc environment because you have not defined a project file
* before compiling your application, stop debugging session to unlock binaries; no need to close msvc window
* after compilation you can start debugging again
* on exit you will be asked to save .sln file (so-called ''solution file'') with your debugging session -- do it and you will be able just to click the .sln file to start your debugging again
* it's recommended to save the .sln file in the same directory where the .exe file sits
*hints on reopening the debugging session:
**Next time you will run msvc environment, you can see name of your application's .sln file in ''File->Recent Projects'' submenu - you can click it to load your debugging session.
**On command line you can type "cd path-to-your-sln-file; <yourfilename>.sln".
**You can also use "vcexpress /debugexe <myapplication> <args>".

== Attaching to running application ==

If you have your application is already running, you can attach to it and then start debugging.

* run msvc environment
* execute ''Debug->processes''
* select your from the processes list and click "Attach..."
* msvc environment will load your .sln file if it exists in the same directory as the .exe file, so your breakpoints set in previous session will be active again
* your program will stop on any breakpoint you have set

== One-step attaching to running application ==
*You can create a macro that automates the task. See [http://blogs.msdn.com/jimgries/archive/2005/11/30/498264.aspx].
*MSVC 2008 or later can always attach to the running process (if exists) when you execute "Start Debugging" command (F5). Just set the "Attach" option to "Yes" in the "Project->[yourapp] Properties" window.

== Memory Values ==
If you are using the debug heap, memory is initialized and cleared with special values. Most interesting values are:
* 0xCDCDCDCD - Allocated in heap, but not initialized
* 0xDDDDDDDD - Released heap memory.
* 0xFDFDFDFD - "NoMansLand" fences automatically placed at boundary of heap memory. Should never be overwritten. If you do overwrite one, you're probably walking off the end of an array.
* 0xCCCCCCCC - Allocated on stack, but not initialized
See also: [http://www.samblackburn.com/wfc/technotes/WTN006.htm]

==How to Not Step Into Functions in the Debugger==
You'll probably want to avoind stepping into lower-level functions like QString constructors or operators while debugging step-by-step. Here's the detailed (unofficial) [http://blogs.msdn.com/andypennell/archive/2004/02/06/69004.aspx instruction] for various msvc versions.

==Enable automatic expanding of Qt data structures==
From the msvc docs: "While debugging, Data Tips and items in the Watch and Variable windows are automatically expanded to show their most important elements. The expansion follows the format given by the rules in this file. You can add rules for your types or change the predefined rules." ([http://www.thedatafarm.com/blog/content/binary/datatips2.jpg example screen])

MSVC 2005: To add support for expanding Qt data structures like QString of QRect, edit {msvc_installation_directory}\Common7\Packages\Debugger\autoexp.dat file and paste [[/Automatic expanding of Qt data structures|definitions]] after [AutoExpand] line.

MSVC 2008: You can improve:
*Debugger support for Qt datatypes using autoexp.dat
*IntelliSense behaviour by adding Qt include directories
For details read http://eecs.vanderbilt.edu/research/hmtl/wiki/pmwiki.php?n=Knowledge.Qt

==WINDOWS and CONSOLE subsystems==
CONSOLE subsystem is the one that displays console window (used for standard output and error streams) in addition to application's windows. WINDOWS subsystem redirects standard output and error streams to system debugging subsystem that can be displayed if needed in [[Projects/KDE_on_Windows/Tools#DebugView|DebugView]] or debuggers like msvc or [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg]].
Hint: To remove CONSOLE subsystem from already built .exe file, type <code>editbin /subsystem:windows file.exe</code>
Note: Qt's qmake syntax supports ''console'' and ''windows'' parameters of the ''CONFIG'' variable, so CONSOLE subsystem can be enabled by specifying <tt>CONFIG += console</tt> in the .pro file, windows subsystem can be enabled with <tt>CONFIG += windows</tt>.

==Deployment==
Running a VC++2005 SP1 app on another computer: manifest files are needed. See [http://www.codeproject.com/KB/cpp/vcredists_x86.aspx] and [http://blogs.msdn.com/nikolad/archive/2005/09/02/460368.aspx].

===Note on debug builds===
The hints above are for release builds (or ReleaseWithDebugInfo). Moving Debug versions of binaries to other computers is only allowed (and technicallu possible) if you have Express Edition installed there, as there is no redistributable package for Debug versions provided and even the license disallows distribution of any debug binaries (even your own).

= MinGW debugging hints =

There are gdb binaries you can directly run after unpacking them, e.g. from
[http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=20507 mingw's gdb downloads on sourceforge].

To get a backtrace for a crash you can reproduce: Start the gdb binary with the full path to the executable on the command line, for example like
<code>..\gdb\gdb.exe c:\programme\kontact\bin\kontact.exe</code>. When getting
the command prompt use the run command with the arguments for your application, e.g <code>run --nofork</code>. Now wait until your applications starts and go on reproducing the crash. Once you encounter the crash, gdb will be in control
in the command line again. <code>bt</code> will get you the backtrace.

Instead of running gdb from the beginning, you can also attach to a running process. Use the regular "task-manager" to see which process. Enable the process id columns so you can see the number. Now you can start gdb (still give it the path to the application executable if you can) and use the <code>attach</code> command with the process id you want to attach to from the
gdb prompt. Gdb will stop the process it attached to, so you can say <code>continue</code> and then try to produce the crash.

* Dr. Mingw - Just in Time Debugger [http://jrfonseca.planetaclix.pt/projects/gnu-win32/software/drmingw/]
* Debugging Qt programs on Windows [http://lists.trolltech.com/qt-interest/2005-08/thread01124-0.html]

'''''WARNING''''': If you are having crashes when starting applications via gdb beware of certain applications (mostly anti-virus software) that could cause problems like "Embassy Trust Suite", for example. See this [http://www.cygwin.com/ml/cygwin/2007-06/msg00405.html post].

[[Category:MS Windows]]

Development/Tutorials/Debugging/Debugging on MS Windows

2009-08-22T11:02:34Z

Jstaniek: /* One-step attaching to running application */

=General Hints=
==Debugging with WinDbg==
WinDbg, distributed as a part of ''Debugging Tools for Windows'', is a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps. It uses the Microsoft Visual Studio debug symbol formats for source-level debugging. [[Projects/KDE_on_Windows/Tools#WinDbg|more...]]

==Debugging with DebugView==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool, coming from SysInternals (currently acquired by Microsoft). [[Projects/KDE_on_Windows/Tools#DebugView|more...]]

==Debugging kioslaves==
kioslaves on windows are started by klauncher (or kio) as separate kioslave processes. The kioslave executable then loads the related kioslave dll dynamically.

=== Using KDE_SLAVE_DEBUG_WAIT variable ===
To debug kioslaves:
#Set the KDE_SLAVE_DEBUG_WAIT environment variable in a current cmd.exe shell to the name of the kioslave's protocol (the first parameter of KIO::SlaveBase() constructor), e.g.<pre>set KDE_SLAVE_DEBUG_WAIT=file</pre>
#Terminate <tt>klauncher</tt> process so it can be restarted.
#Any application you want to debug at kioslave level have to be executed within the scope of the current environment (cmd.exe), what also means that if you want to use development environment, you have to do that in the environment as well, e.g. for MSVC Express, by typing <tt>vcexpress</tt>.

If the kioslave is requested the next time, a debugger will be started and attached to the kioslave process immediatly before the kioslave's kdemain() function.

On mingw platform gdb is launched and connected to the kioslave process. On msvc platforms the currently installed just-in-time debugger is used. This may be msvc's IDE or the [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg debugger]]. The latter could be set as jit-debugger by running 'windbg -I' command (capital -I like ICE, see [http://msdn2.microsoft.com/en-us/library/cc266343.aspx]).

=== Using KDE_SLAVE_DEBUG_POPUP variable ===
Alternatively, you can set <tt>KDE_SLAVE_DEBUG_POPUP</tt> variable instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. This will display a native message box so developer you can attach the debugger to the KIO slave process and click OK. No DebugBreak() is invoked. Just click OK without attaching to continue using the KIO slave without debugging.

=== Notes ===
*You can set, say, the variable to 'file' for the kio_file slave, '''but''' set it to 'smtps' for the kio_smtp is you want to debug smtp protocol secured with SSL.
*(Vista only): ''kioslave.exe has stopped working'' message dialog can appear instead of offer for starting the debugger. Reason: Just-In-Time (JIT) Debugging of an elevated process will fail ([http://msdn2.microsoft.com/en-us/vstudio/aa964140.aspx#question20a msdn link]) apparently for security reasons. Either:
**Use <tt>KDE_SLAVE_DEBUG_POPUP</tt> instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. See the [[#Using_KDE_SLAVE_DEBUG_POPUP_variable|Using KDE_SLAVE_DEBUG_POPUP variable]] above for more info.
**(not possible under msvc 2005): start applications and klauncher without administration permissions or attach the debugger manually before the debugger catches unhandled exceptions or an user-defined breakpoint (DebugBreak()).
*You may want to inspect kioslave sources [http://lxr.kde.org/source/KDE/kdelibs/kinit/kioslave.cpp] for more informations.

== Checking dependency of shared libraries ==
Dependency Walker is a free utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. [[Projects/KDE_on_Windows/Tools#Dependency_Walker|more...]]

= MS Visual Studio hints =

== Using MS Visual Studio environment for just debugging ==

Let's assume you're using command line tools (typically CMake) and want to use MS Visual Studio environment for just debugging. You don't need to create msvc project for your KDE application to be able to start debugging.

* compile and working executable version of your appliation (compiled in debug mode)
* run msvc environment
* execute ''File->Open Project/Solution''
* pick your exe file in the file window
* you can set command line arguments as usual, by pick ''Project->...Properties'' command and enter all of them it in ''Command Arguments'' field
* if you have libraries placed in other directories than your application's .exe file, and you want to step into these libraries' source code while debugging, pick ''Project->...Properties'' command and enter paths to these directories in ''Symbol Path'' field
* hit F5 to run the application start the application or F10 to start step by step
* all debugging functions like setting breakpoints will be available, so you can open source code in the integrated editor and press F9 where needed
* you can even edit your source code but to compile it, do it with your external, command line tools. You cannot compile the application in the msvc environment because you have not defined a project file
* before compiling your application, stop debugging session to unlock binaries; no need to close msvc window
* after compilation you can start debugging again
* on exit you will be asked to save .sln file (so-called ''solution file'') with your debugging session -- do it and you will be able just to click the .sln file to start your debugging again
* it's recommended to save the .sln file in the same directory where the .exe file sits
*hints on reopening the debugging session:
**Next time you will run msvc environment, you can see name of your application's .sln file in ''File->Recent Projects'' submenu - you can click it to load your debugging session.
**On command line you can type "cd path-to-your-sln-file; <yourfilename>.sln".
**You can also use "vcexpress /debugexe <myapplication> <args>".

== Attaching to running application ==

If you have your application is already running, you can attach to it and then start debugging.

* run msvc environment
* execute ''Debug->processes''
* select your from the processes list and click "Attach..."
* msvc environment will load your .sln file if it exists in the same directory as the .exe file, so your breakpoints set in previous session will be active again
* your program will stop on any breakpoint you have set

== One-step attaching to running application ==
*You can create a macro that automates the task. See [http://blogs.msdn.com/jimgries/archive/2005/11/30/498264.aspx].
*MSVC 2008 or later can always attach to the running process (if exists) when you execute "Start Debugging" command (F5). Just set the "Attach" option to "Yes" in the "Project->[yourapp] Properties" window.

== Memory Values ==
If you are using the debug heap, memory is initialized and cleared with special values. Most interesting values are:
* 0xCDCDCDCD - Allocated in heap, but not initialized
* 0xDDDDDDDD - Released heap memory.
* 0xFDFDFDFD - "NoMansLand" fences automatically placed at boundary of heap memory. Should never be overwritten. If you do overwrite one, you're probably walking off the end of an array.
* 0xCCCCCCCC - Allocated on stack, but not initialized
See also: [http://www.samblackburn.com/wfc/technotes/WTN006.htm]

==How to Not Step Into Functions in the Debugger==
You'll probably want to avoind stepping into lower-level functions like QString constructors or operators while debugging step-by-step. Here's the detailed (unofficial) [http://blogs.msdn.com/andypennell/archive/2004/02/06/69004.aspx instruction] for various msvc versions.

==Enable automatic expanding of Qt data structures==
From the msvc docs: "While debugging, Data Tips and items in the Watch and Variable windows are automatically expanded to show their most important elements. The expansion follows the format given by the rules in this file. You can add rules for your types or change the predefined rules." ([http://www.thedatafarm.com/blog/content/binary/datatips2.jpg example screen])

MSVC 2005: To add support for expanding Qt data structures like QString of QRect, edit {msvc_installation_directory}\Common7\Packages\Debugger\autoexp.dat file and paste [[/Automatic expanding of Qt data structures|definitions]] after [AutoExpand] line.
==WINDOWS and CONSOLE subsystems==
CONSOLE subsystem is the one that displays console window (used for standard output and error streams) in addition to application's windows. WINDOWS subsystem redirects standard output and error streams to system debugging subsystem that can be displayed if needed in [[Projects/KDE_on_Windows/Tools#DebugView|DebugView]] or debuggers like msvc or [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg]].
Hint: To remove CONSOLE subsystem from already built .exe file, type <code>editbin /subsystem:windows file.exe</code>
Note: Qt's qmake syntax supports ''console'' and ''windows'' parameters of the ''CONFIG'' variable, so CONSOLE subsystem can be enabled by specifying <tt>CONFIG += console</tt> in the .pro file, windows subsystem can be enabled with <tt>CONFIG += windows</tt>.

==Deployment==
Running a VC++2005 SP1 app on another computer: manifest files are needed. See [http://www.codeproject.com/KB/cpp/vcredists_x86.aspx] and [http://blogs.msdn.com/nikolad/archive/2005/09/02/460368.aspx].

===Note on debug builds===
The hints above are for release builds (or ReleaseWithDebugInfo). Moving Debug versions of binaries to other computers is only allowed (and technicallu possible) if you have Express Edition installed there, as there is no redistributable package for Debug versions provided and even the license disallows distribution of any debug binaries (even your own).

= MinGW debugging hints =

There are gdb binaries you can directly run after unpacking them, e.g. from
[http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=20507 mingw's gdb downloads on sourceforge].

To get a backtrace for a crash you can reproduce: Start the gdb binary with the full path to the executable on the command line, for example like
<code>..\gdb\gdb.exe c:\programme\kontact\bin\kontact.exe</code>. When getting
the command prompt use the run command with the arguments for your application, e.g <code>run --nofork</code>. Now wait until your applications starts and go on reproducing the crash. Once you encounter the crash, gdb will be in control
in the command line again. <code>bt</code> will get you the backtrace.

Instead of running gdb from the beginning, you can also attach to a running process. Use the regular "task-manager" to see which process. Enable the process id columns so you can see the number. Now you can start gdb (still give it the path to the application executable if you can) and use the <code>attach</code> command with the process id you want to attach to from the
gdb prompt. Gdb will stop the process it attached to, so you can say <code>continue</code> and then try to produce the crash.

* Dr. Mingw - Just in Time Debugger [http://jrfonseca.planetaclix.pt/projects/gnu-win32/software/drmingw/]
* Debugging Qt programs on Windows [http://lists.trolltech.com/qt-interest/2005-08/thread01124-0.html]

'''''WARNING''''': If you are having crashes when starting applications via gdb beware of certain applications (mostly anti-virus software) that could cause problems like "Embassy Trust Suite", for example. See this [http://www.cygwin.com/ml/cygwin/2007-06/msg00405.html post].

[[Category:MS Windows]]

Development/Tutorials/Debugging/Debugging on MS Windows

2009-08-22T11:00:24Z

Jstaniek: /* Using MS Visual Studio environment for just debugging */

=General Hints=
==Debugging with WinDbg==
WinDbg, distributed as a part of ''Debugging Tools for Windows'', is a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps. It uses the Microsoft Visual Studio debug symbol formats for source-level debugging. [[Projects/KDE_on_Windows/Tools#WinDbg|more...]]

==Debugging with DebugView==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool, coming from SysInternals (currently acquired by Microsoft). [[Projects/KDE_on_Windows/Tools#DebugView|more...]]

==Debugging kioslaves==
kioslaves on windows are started by klauncher (or kio) as separate kioslave processes. The kioslave executable then loads the related kioslave dll dynamically.

=== Using KDE_SLAVE_DEBUG_WAIT variable ===
To debug kioslaves:
#Set the KDE_SLAVE_DEBUG_WAIT environment variable in a current cmd.exe shell to the name of the kioslave's protocol (the first parameter of KIO::SlaveBase() constructor), e.g.<pre>set KDE_SLAVE_DEBUG_WAIT=file</pre>
#Terminate <tt>klauncher</tt> process so it can be restarted.
#Any application you want to debug at kioslave level have to be executed within the scope of the current environment (cmd.exe), what also means that if you want to use development environment, you have to do that in the environment as well, e.g. for MSVC Express, by typing <tt>vcexpress</tt>.

If the kioslave is requested the next time, a debugger will be started and attached to the kioslave process immediatly before the kioslave's kdemain() function.

On mingw platform gdb is launched and connected to the kioslave process. On msvc platforms the currently installed just-in-time debugger is used. This may be msvc's IDE or the [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg debugger]]. The latter could be set as jit-debugger by running 'windbg -I' command (capital -I like ICE, see [http://msdn2.microsoft.com/en-us/library/cc266343.aspx]).

=== Using KDE_SLAVE_DEBUG_POPUP variable ===
Alternatively, you can set <tt>KDE_SLAVE_DEBUG_POPUP</tt> variable instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. This will display a native message box so developer you can attach the debugger to the KIO slave process and click OK. No DebugBreak() is invoked. Just click OK without attaching to continue using the KIO slave without debugging.

=== Notes ===
*You can set, say, the variable to 'file' for the kio_file slave, '''but''' set it to 'smtps' for the kio_smtp is you want to debug smtp protocol secured with SSL.
*(Vista only): ''kioslave.exe has stopped working'' message dialog can appear instead of offer for starting the debugger. Reason: Just-In-Time (JIT) Debugging of an elevated process will fail ([http://msdn2.microsoft.com/en-us/vstudio/aa964140.aspx#question20a msdn link]) apparently for security reasons. Either:
**Use <tt>KDE_SLAVE_DEBUG_POPUP</tt> instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. See the [[#Using_KDE_SLAVE_DEBUG_POPUP_variable|Using KDE_SLAVE_DEBUG_POPUP variable]] above for more info.
**(not possible under msvc 2005): start applications and klauncher without administration permissions or attach the debugger manually before the debugger catches unhandled exceptions or an user-defined breakpoint (DebugBreak()).
*You may want to inspect kioslave sources [http://lxr.kde.org/source/KDE/kdelibs/kinit/kioslave.cpp] for more informations.

== Checking dependency of shared libraries ==
Dependency Walker is a free utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. [[Projects/KDE_on_Windows/Tools#Dependency_Walker|more...]]

= MS Visual Studio hints =

== Using MS Visual Studio environment for just debugging ==

Let's assume you're using command line tools (typically CMake) and want to use MS Visual Studio environment for just debugging. You don't need to create msvc project for your KDE application to be able to start debugging.

* compile and working executable version of your appliation (compiled in debug mode)
* run msvc environment
* execute ''File->Open Project/Solution''
* pick your exe file in the file window
* you can set command line arguments as usual, by pick ''Project->...Properties'' command and enter all of them it in ''Command Arguments'' field
* if you have libraries placed in other directories than your application's .exe file, and you want to step into these libraries' source code while debugging, pick ''Project->...Properties'' command and enter paths to these directories in ''Symbol Path'' field
* hit F5 to run the application start the application or F10 to start step by step
* all debugging functions like setting breakpoints will be available, so you can open source code in the integrated editor and press F9 where needed
* you can even edit your source code but to compile it, do it with your external, command line tools. You cannot compile the application in the msvc environment because you have not defined a project file
* before compiling your application, stop debugging session to unlock binaries; no need to close msvc window
* after compilation you can start debugging again
* on exit you will be asked to save .sln file (so-called ''solution file'') with your debugging session -- do it and you will be able just to click the .sln file to start your debugging again
* it's recommended to save the .sln file in the same directory where the .exe file sits
*hints on reopening the debugging session:
**Next time you will run msvc environment, you can see name of your application's .sln file in ''File->Recent Projects'' submenu - you can click it to load your debugging session.
**On command line you can type "cd path-to-your-sln-file; <yourfilename>.sln".
**You can also use "vcexpress /debugexe <myapplication> <args>".

== Attaching to running application ==

If you have your application is already running, you can attach to it and then start debugging.

* run msvc environment
* execute ''Debug->processes''
* select your from the processes list and click "Attach..."
* msvc environment will load your .sln file if it exists in the same directory as the .exe file, so your breakpoints set in previous session will be active again
* your program will stop on any breakpoint you have set

== One-step attaching to running application ==
*You can create a macro that automates the task. See [http://blogs.msdn.com/jimgries/archive/2005/11/30/498264.aspx].
*MSVC 2008 or later can always attach to the running process (if exists). Just set the "Attach" option to "Yes" in the "Project->[yourapp] Properties" window.

== Memory Values ==
If you are using the debug heap, memory is initialized and cleared with special values. Most interesting values are:
* 0xCDCDCDCD - Allocated in heap, but not initialized
* 0xDDDDDDDD - Released heap memory.
* 0xFDFDFDFD - "NoMansLand" fences automatically placed at boundary of heap memory. Should never be overwritten. If you do overwrite one, you're probably walking off the end of an array.
* 0xCCCCCCCC - Allocated on stack, but not initialized
See also: [http://www.samblackburn.com/wfc/technotes/WTN006.htm]

==How to Not Step Into Functions in the Debugger==
You'll probably want to avoind stepping into lower-level functions like QString constructors or operators while debugging step-by-step. Here's the detailed (unofficial) [http://blogs.msdn.com/andypennell/archive/2004/02/06/69004.aspx instruction] for various msvc versions.

==Enable automatic expanding of Qt data structures==
From the msvc docs: "While debugging, Data Tips and items in the Watch and Variable windows are automatically expanded to show their most important elements. The expansion follows the format given by the rules in this file. You can add rules for your types or change the predefined rules." ([http://www.thedatafarm.com/blog/content/binary/datatips2.jpg example screen])

MSVC 2005: To add support for expanding Qt data structures like QString of QRect, edit {msvc_installation_directory}\Common7\Packages\Debugger\autoexp.dat file and paste [[/Automatic expanding of Qt data structures|definitions]] after [AutoExpand] line.
==WINDOWS and CONSOLE subsystems==
CONSOLE subsystem is the one that displays console window (used for standard output and error streams) in addition to application's windows. WINDOWS subsystem redirects standard output and error streams to system debugging subsystem that can be displayed if needed in [[Projects/KDE_on_Windows/Tools#DebugView|DebugView]] or debuggers like msvc or [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg]].
Hint: To remove CONSOLE subsystem from already built .exe file, type <code>editbin /subsystem:windows file.exe</code>
Note: Qt's qmake syntax supports ''console'' and ''windows'' parameters of the ''CONFIG'' variable, so CONSOLE subsystem can be enabled by specifying <tt>CONFIG += console</tt> in the .pro file, windows subsystem can be enabled with <tt>CONFIG += windows</tt>.

==Deployment==
Running a VC++2005 SP1 app on another computer: manifest files are needed. See [http://www.codeproject.com/KB/cpp/vcredists_x86.aspx] and [http://blogs.msdn.com/nikolad/archive/2005/09/02/460368.aspx].

===Note on debug builds===
The hints above are for release builds (or ReleaseWithDebugInfo). Moving Debug versions of binaries to other computers is only allowed (and technicallu possible) if you have Express Edition installed there, as there is no redistributable package for Debug versions provided and even the license disallows distribution of any debug binaries (even your own).

= MinGW debugging hints =

There are gdb binaries you can directly run after unpacking them, e.g. from
[http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=20507 mingw's gdb downloads on sourceforge].

To get a backtrace for a crash you can reproduce: Start the gdb binary with the full path to the executable on the command line, for example like
<code>..\gdb\gdb.exe c:\programme\kontact\bin\kontact.exe</code>. When getting
the command prompt use the run command with the arguments for your application, e.g <code>run --nofork</code>. Now wait until your applications starts and go on reproducing the crash. Once you encounter the crash, gdb will be in control
in the command line again. <code>bt</code> will get you the backtrace.

Instead of running gdb from the beginning, you can also attach to a running process. Use the regular "task-manager" to see which process. Enable the process id columns so you can see the number. Now you can start gdb (still give it the path to the application executable if you can) and use the <code>attach</code> command with the process id you want to attach to from the
gdb prompt. Gdb will stop the process it attached to, so you can say <code>continue</code> and then try to produce the crash.

* Dr. Mingw - Just in Time Debugger [http://jrfonseca.planetaclix.pt/projects/gnu-win32/software/drmingw/]
* Debugging Qt programs on Windows [http://lists.trolltech.com/qt-interest/2005-08/thread01124-0.html]

'''''WARNING''''': If you are having crashes when starting applications via gdb beware of certain applications (mostly anti-virus software) that could cause problems like "Embassy Trust Suite", for example. See this [http://www.cygwin.com/ml/cygwin/2007-06/msg00405.html post].

[[Category:MS Windows]]

Development/Tutorials/Debugging/Debugging on MS Windows

2009-08-22T10:59:57Z

Jstaniek: /* One-step attaching to running application */

=General Hints=
==Debugging with WinDbg==
WinDbg, distributed as a part of ''Debugging Tools for Windows'', is a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps. It uses the Microsoft Visual Studio debug symbol formats for source-level debugging. [[Projects/KDE_on_Windows/Tools#WinDbg|more...]]

==Debugging with DebugView==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool, coming from SysInternals (currently acquired by Microsoft). [[Projects/KDE_on_Windows/Tools#DebugView|more...]]

==Debugging kioslaves==
kioslaves on windows are started by klauncher (or kio) as separate kioslave processes. The kioslave executable then loads the related kioslave dll dynamically.

=== Using KDE_SLAVE_DEBUG_WAIT variable ===
To debug kioslaves:
#Set the KDE_SLAVE_DEBUG_WAIT environment variable in a current cmd.exe shell to the name of the kioslave's protocol (the first parameter of KIO::SlaveBase() constructor), e.g.<pre>set KDE_SLAVE_DEBUG_WAIT=file</pre>
#Terminate <tt>klauncher</tt> process so it can be restarted.
#Any application you want to debug at kioslave level have to be executed within the scope of the current environment (cmd.exe), what also means that if you want to use development environment, you have to do that in the environment as well, e.g. for MSVC Express, by typing <tt>vcexpress</tt>.

If the kioslave is requested the next time, a debugger will be started and attached to the kioslave process immediatly before the kioslave's kdemain() function.

On mingw platform gdb is launched and connected to the kioslave process. On msvc platforms the currently installed just-in-time debugger is used. This may be msvc's IDE or the [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg debugger]]. The latter could be set as jit-debugger by running 'windbg -I' command (capital -I like ICE, see [http://msdn2.microsoft.com/en-us/library/cc266343.aspx]).

=== Using KDE_SLAVE_DEBUG_POPUP variable ===
Alternatively, you can set <tt>KDE_SLAVE_DEBUG_POPUP</tt> variable instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. This will display a native message box so developer you can attach the debugger to the KIO slave process and click OK. No DebugBreak() is invoked. Just click OK without attaching to continue using the KIO slave without debugging.

=== Notes ===
*You can set, say, the variable to 'file' for the kio_file slave, '''but''' set it to 'smtps' for the kio_smtp is you want to debug smtp protocol secured with SSL.
*(Vista only): ''kioslave.exe has stopped working'' message dialog can appear instead of offer for starting the debugger. Reason: Just-In-Time (JIT) Debugging of an elevated process will fail ([http://msdn2.microsoft.com/en-us/vstudio/aa964140.aspx#question20a msdn link]) apparently for security reasons. Either:
**Use <tt>KDE_SLAVE_DEBUG_POPUP</tt> instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. See the [[#Using_KDE_SLAVE_DEBUG_POPUP_variable|Using KDE_SLAVE_DEBUG_POPUP variable]] above for more info.
**(not possible under msvc 2005): start applications and klauncher without administration permissions or attach the debugger manually before the debugger catches unhandled exceptions or an user-defined breakpoint (DebugBreak()).
*You may want to inspect kioslave sources [http://lxr.kde.org/source/KDE/kdelibs/kinit/kioslave.cpp] for more informations.

== Checking dependency of shared libraries ==
Dependency Walker is a free utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. [[Projects/KDE_on_Windows/Tools#Dependency_Walker|more...]]

= MS Visual Studio hints =

== Using MS Visual Studio environment for just debugging ==

Let's assume you're using command line tools (typically CMake) and want to use MS Visual Studio environment for just debugging. You don't need to create msvc project for your KDE application to be able to start debugging.

* compile and working executable version of your appliation (compiled in debug mode)
* run msvc environment
* execute ''File->Open Project/Solution''
* pick your exe file in the file window
* you can set command line arguments as usual, by pick ''Project->...Properties'' command and enter all of them it in ''Command Arguments'' field
* if you have libraries placed in other directories than your application's .exe file, and you want to step into these libraries' source code while debugging, pick ''Project->...Properties'' command and enter paths to these directories in ''Symbol Path'' field
* hit F5 to run the application start the application or F10 to start step by step
* all debugging functions like setting breakpoints will be available, so you can open source code in the integrated editor and press F9 where needed
* you can even edit your source code but to compile it, do it with your external, command line tools. You cannot compile the application in the msvc environment because you have not defined a project file
* before compiling your application, stop debugging session to unlock binaries; no need to close msvc window
* after compilation you can start debugging again
* on exit you will be asked to save .sln file (so-called ''solution file'') with your debugging session -- do it and you will be able just to click the .sln file to start your debugging again
* it's recommended to save the .sln file in the same directory where the .exe file sits
*hints on reopening the debugging session:
**Next time you will run msvc environment, you can see name of your application's .sln file in ''File->Recent Projects'' submenu - you can click it to load your debugging session.
**On command line you can type "cd path-to-your-sln-file; <yourfilename>.sln" to execute.
**You can also use "vcexpress /debugexe <myapplication> <args>".

== Attaching to running application ==

If you have your application is already running, you can attach to it and then start debugging.

* run msvc environment
* execute ''Debug->processes''
* select your from the processes list and click "Attach..."
* msvc environment will load your .sln file if it exists in the same directory as the .exe file, so your breakpoints set in previous session will be active again
* your program will stop on any breakpoint you have set

== One-step attaching to running application ==
*You can create a macro that automates the task. See [http://blogs.msdn.com/jimgries/archive/2005/11/30/498264.aspx].
*MSVC 2008 or later can always attach to the running process (if exists). Just set the "Attach" option to "Yes" in the "Project->[yourapp] Properties" window.

== Memory Values ==
If you are using the debug heap, memory is initialized and cleared with special values. Most interesting values are:
* 0xCDCDCDCD - Allocated in heap, but not initialized
* 0xDDDDDDDD - Released heap memory.
* 0xFDFDFDFD - "NoMansLand" fences automatically placed at boundary of heap memory. Should never be overwritten. If you do overwrite one, you're probably walking off the end of an array.
* 0xCCCCCCCC - Allocated on stack, but not initialized
See also: [http://www.samblackburn.com/wfc/technotes/WTN006.htm]

==How to Not Step Into Functions in the Debugger==
You'll probably want to avoind stepping into lower-level functions like QString constructors or operators while debugging step-by-step. Here's the detailed (unofficial) [http://blogs.msdn.com/andypennell/archive/2004/02/06/69004.aspx instruction] for various msvc versions.

==Enable automatic expanding of Qt data structures==
From the msvc docs: "While debugging, Data Tips and items in the Watch and Variable windows are automatically expanded to show their most important elements. The expansion follows the format given by the rules in this file. You can add rules for your types or change the predefined rules." ([http://www.thedatafarm.com/blog/content/binary/datatips2.jpg example screen])

MSVC 2005: To add support for expanding Qt data structures like QString of QRect, edit {msvc_installation_directory}\Common7\Packages\Debugger\autoexp.dat file and paste [[/Automatic expanding of Qt data structures|definitions]] after [AutoExpand] line.
==WINDOWS and CONSOLE subsystems==
CONSOLE subsystem is the one that displays console window (used for standard output and error streams) in addition to application's windows. WINDOWS subsystem redirects standard output and error streams to system debugging subsystem that can be displayed if needed in [[Projects/KDE_on_Windows/Tools#DebugView|DebugView]] or debuggers like msvc or [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg]].
Hint: To remove CONSOLE subsystem from already built .exe file, type <code>editbin /subsystem:windows file.exe</code>
Note: Qt's qmake syntax supports ''console'' and ''windows'' parameters of the ''CONFIG'' variable, so CONSOLE subsystem can be enabled by specifying <tt>CONFIG += console</tt> in the .pro file, windows subsystem can be enabled with <tt>CONFIG += windows</tt>.

==Deployment==
Running a VC++2005 SP1 app on another computer: manifest files are needed. See [http://www.codeproject.com/KB/cpp/vcredists_x86.aspx] and [http://blogs.msdn.com/nikolad/archive/2005/09/02/460368.aspx].

===Note on debug builds===
The hints above are for release builds (or ReleaseWithDebugInfo). Moving Debug versions of binaries to other computers is only allowed (and technicallu possible) if you have Express Edition installed there, as there is no redistributable package for Debug versions provided and even the license disallows distribution of any debug binaries (even your own).

= MinGW debugging hints =

There are gdb binaries you can directly run after unpacking them, e.g. from
[http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=20507 mingw's gdb downloads on sourceforge].

To get a backtrace for a crash you can reproduce: Start the gdb binary with the full path to the executable on the command line, for example like
<code>..\gdb\gdb.exe c:\programme\kontact\bin\kontact.exe</code>. When getting
the command prompt use the run command with the arguments for your application, e.g <code>run --nofork</code>. Now wait until your applications starts and go on reproducing the crash. Once you encounter the crash, gdb will be in control
in the command line again. <code>bt</code> will get you the backtrace.

Instead of running gdb from the beginning, you can also attach to a running process. Use the regular "task-manager" to see which process. Enable the process id columns so you can see the number. Now you can start gdb (still give it the path to the application executable if you can) and use the <code>attach</code> command with the process id you want to attach to from the
gdb prompt. Gdb will stop the process it attached to, so you can say <code>continue</code> and then try to produce the crash.

* Dr. Mingw - Just in Time Debugger [http://jrfonseca.planetaclix.pt/projects/gnu-win32/software/drmingw/]
* Debugging Qt programs on Windows [http://lists.trolltech.com/qt-interest/2005-08/thread01124-0.html]

'''''WARNING''''': If you are having crashes when starting applications via gdb beware of certain applications (mostly anti-virus software) that could cause problems like "Embassy Trust Suite", for example. See this [http://www.cygwin.com/ml/cygwin/2007-06/msg00405.html post].

[[Category:MS Windows]]

Development/Tutorials/Debugging/Debugging on MS Windows

2009-08-22T10:55:36Z

Jstaniek: /* Using MS Visual Studio environment for just debugging */

=General Hints=
==Debugging with WinDbg==
WinDbg, distributed as a part of ''Debugging Tools for Windows'', is a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps. It uses the Microsoft Visual Studio debug symbol formats for source-level debugging. [[Projects/KDE_on_Windows/Tools#WinDbg|more...]]

==Debugging with DebugView==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool, coming from SysInternals (currently acquired by Microsoft). [[Projects/KDE_on_Windows/Tools#DebugView|more...]]

==Debugging kioslaves==
kioslaves on windows are started by klauncher (or kio) as separate kioslave processes. The kioslave executable then loads the related kioslave dll dynamically.

=== Using KDE_SLAVE_DEBUG_WAIT variable ===
To debug kioslaves:
#Set the KDE_SLAVE_DEBUG_WAIT environment variable in a current cmd.exe shell to the name of the kioslave's protocol (the first parameter of KIO::SlaveBase() constructor), e.g.<pre>set KDE_SLAVE_DEBUG_WAIT=file</pre>
#Terminate <tt>klauncher</tt> process so it can be restarted.
#Any application you want to debug at kioslave level have to be executed within the scope of the current environment (cmd.exe), what also means that if you want to use development environment, you have to do that in the environment as well, e.g. for MSVC Express, by typing <tt>vcexpress</tt>.

If the kioslave is requested the next time, a debugger will be started and attached to the kioslave process immediatly before the kioslave's kdemain() function.

On mingw platform gdb is launched and connected to the kioslave process. On msvc platforms the currently installed just-in-time debugger is used. This may be msvc's IDE or the [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg debugger]]. The latter could be set as jit-debugger by running 'windbg -I' command (capital -I like ICE, see [http://msdn2.microsoft.com/en-us/library/cc266343.aspx]).

=== Using KDE_SLAVE_DEBUG_POPUP variable ===
Alternatively, you can set <tt>KDE_SLAVE_DEBUG_POPUP</tt> variable instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. This will display a native message box so developer you can attach the debugger to the KIO slave process and click OK. No DebugBreak() is invoked. Just click OK without attaching to continue using the KIO slave without debugging.

=== Notes ===
*You can set, say, the variable to 'file' for the kio_file slave, '''but''' set it to 'smtps' for the kio_smtp is you want to debug smtp protocol secured with SSL.
*(Vista only): ''kioslave.exe has stopped working'' message dialog can appear instead of offer for starting the debugger. Reason: Just-In-Time (JIT) Debugging of an elevated process will fail ([http://msdn2.microsoft.com/en-us/vstudio/aa964140.aspx#question20a msdn link]) apparently for security reasons. Either:
**Use <tt>KDE_SLAVE_DEBUG_POPUP</tt> instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. See the [[#Using_KDE_SLAVE_DEBUG_POPUP_variable|Using KDE_SLAVE_DEBUG_POPUP variable]] above for more info.
**(not possible under msvc 2005): start applications and klauncher without administration permissions or attach the debugger manually before the debugger catches unhandled exceptions or an user-defined breakpoint (DebugBreak()).
*You may want to inspect kioslave sources [http://lxr.kde.org/source/KDE/kdelibs/kinit/kioslave.cpp] for more informations.

== Checking dependency of shared libraries ==
Dependency Walker is a free utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. [[Projects/KDE_on_Windows/Tools#Dependency_Walker|more...]]

= MS Visual Studio hints =

== Using MS Visual Studio environment for just debugging ==

Let's assume you're using command line tools (typically CMake) and want to use MS Visual Studio environment for just debugging. You don't need to create msvc project for your KDE application to be able to start debugging.

* compile and working executable version of your appliation (compiled in debug mode)
* run msvc environment
* execute ''File->Open Project/Solution''
* pick your exe file in the file window
* you can set command line arguments as usual, by pick ''Project->...Properties'' command and enter all of them it in ''Command Arguments'' field
* if you have libraries placed in other directories than your application's .exe file, and you want to step into these libraries' source code while debugging, pick ''Project->...Properties'' command and enter paths to these directories in ''Symbol Path'' field
* hit F5 to run the application start the application or F10 to start step by step
* all debugging functions like setting breakpoints will be available, so you can open source code in the integrated editor and press F9 where needed
* you can even edit your source code but to compile it, do it with your external, command line tools. You cannot compile the application in the msvc environment because you have not defined a project file
* before compiling your application, stop debugging session to unlock binaries; no need to close msvc window
* after compilation you can start debugging again
* on exit you will be asked to save .sln file (so-called ''solution file'') with your debugging session -- do it and you will be able just to click the .sln file to start your debugging again
* it's recommended to save the .sln file in the same directory where the .exe file sits
*hints on reopening the debugging session:
**Next time you will run msvc environment, you can see name of your application's .sln file in ''File->Recent Projects'' submenu - you can click it to load your debugging session.
**On command line you can type "cd path-to-your-sln-file; <yourfilename>.sln" to execute.
**You can also use "vcexpress /debugexe <myapplication> <args>".

== Attaching to running application ==

If you have your application is already running, you can attach to it and then start debugging.

* run msvc environment
* execute ''Debug->processes''
* select your from the processes list and click "Attach..."
* msvc environment will load your .sln file if it exists in the same directory as the .exe file, so your breakpoints set in previous session will be active again
* your program will stop on any breakpoint you have set

== One-step attaching to running application ==
You can create a macro that automates the task. See [http://blogs.msdn.com/jimgries/archive/2005/11/30/498264.aspx].

== Memory Values ==
If you are using the debug heap, memory is initialized and cleared with special values. Most interesting values are:
* 0xCDCDCDCD - Allocated in heap, but not initialized
* 0xDDDDDDDD - Released heap memory.
* 0xFDFDFDFD - "NoMansLand" fences automatically placed at boundary of heap memory. Should never be overwritten. If you do overwrite one, you're probably walking off the end of an array.
* 0xCCCCCCCC - Allocated on stack, but not initialized
See also: [http://www.samblackburn.com/wfc/technotes/WTN006.htm]

==How to Not Step Into Functions in the Debugger==
You'll probably want to avoind stepping into lower-level functions like QString constructors or operators while debugging step-by-step. Here's the detailed (unofficial) [http://blogs.msdn.com/andypennell/archive/2004/02/06/69004.aspx instruction] for various msvc versions.

==Enable automatic expanding of Qt data structures==
From the msvc docs: "While debugging, Data Tips and items in the Watch and Variable windows are automatically expanded to show their most important elements. The expansion follows the format given by the rules in this file. You can add rules for your types or change the predefined rules." ([http://www.thedatafarm.com/blog/content/binary/datatips2.jpg example screen])

MSVC 2005: To add support for expanding Qt data structures like QString of QRect, edit {msvc_installation_directory}\Common7\Packages\Debugger\autoexp.dat file and paste [[/Automatic expanding of Qt data structures|definitions]] after [AutoExpand] line.
==WINDOWS and CONSOLE subsystems==
CONSOLE subsystem is the one that displays console window (used for standard output and error streams) in addition to application's windows. WINDOWS subsystem redirects standard output and error streams to system debugging subsystem that can be displayed if needed in [[Projects/KDE_on_Windows/Tools#DebugView|DebugView]] or debuggers like msvc or [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg]].
Hint: To remove CONSOLE subsystem from already built .exe file, type <code>editbin /subsystem:windows file.exe</code>
Note: Qt's qmake syntax supports ''console'' and ''windows'' parameters of the ''CONFIG'' variable, so CONSOLE subsystem can be enabled by specifying <tt>CONFIG += console</tt> in the .pro file, windows subsystem can be enabled with <tt>CONFIG += windows</tt>.

==Deployment==
Running a VC++2005 SP1 app on another computer: manifest files are needed. See [http://www.codeproject.com/KB/cpp/vcredists_x86.aspx] and [http://blogs.msdn.com/nikolad/archive/2005/09/02/460368.aspx].

===Note on debug builds===
The hints above are for release builds (or ReleaseWithDebugInfo). Moving Debug versions of binaries to other computers is only allowed (and technicallu possible) if you have Express Edition installed there, as there is no redistributable package for Debug versions provided and even the license disallows distribution of any debug binaries (even your own).

= MinGW debugging hints =

There are gdb binaries you can directly run after unpacking them, e.g. from
[http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=20507 mingw's gdb downloads on sourceforge].

To get a backtrace for a crash you can reproduce: Start the gdb binary with the full path to the executable on the command line, for example like
<code>..\gdb\gdb.exe c:\programme\kontact\bin\kontact.exe</code>. When getting
the command prompt use the run command with the arguments for your application, e.g <code>run --nofork</code>. Now wait until your applications starts and go on reproducing the crash. Once you encounter the crash, gdb will be in control
in the command line again. <code>bt</code> will get you the backtrace.

Instead of running gdb from the beginning, you can also attach to a running process. Use the regular "task-manager" to see which process. Enable the process id columns so you can see the number. Now you can start gdb (still give it the path to the application executable if you can) and use the <code>attach</code> command with the process id you want to attach to from the
gdb prompt. Gdb will stop the process it attached to, so you can say <code>continue</code> and then try to produce the crash.

* Dr. Mingw - Just in Time Debugger [http://jrfonseca.planetaclix.pt/projects/gnu-win32/software/drmingw/]
* Debugging Qt programs on Windows [http://lists.trolltech.com/qt-interest/2005-08/thread01124-0.html]

'''''WARNING''''': If you are having crashes when starting applications via gdb beware of certain applications (mostly anti-virus software) that could cause problems like "Embassy Trust Suite", for example. See this [http://www.cygwin.com/ml/cygwin/2007-06/msg00405.html post].

[[Category:MS Windows]]

Development/Tutorials/Debugging/Debugging on MS Windows

2009-08-22T10:36:15Z

Jstaniek: /* Using MS Visual Studio environment for just debugging */

=General Hints=
==Debugging with WinDbg==
WinDbg, distributed as a part of ''Debugging Tools for Windows'', is a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps. It uses the Microsoft Visual Studio debug symbol formats for source-level debugging. [[Projects/KDE_on_Windows/Tools#WinDbg|more...]]

==Debugging with DebugView==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool, coming from SysInternals (currently acquired by Microsoft). [[Projects/KDE_on_Windows/Tools#DebugView|more...]]

==Debugging kioslaves==
kioslaves on windows are started by klauncher (or kio) as separate kioslave processes. The kioslave executable then loads the related kioslave dll dynamically.

=== Using KDE_SLAVE_DEBUG_WAIT variable ===
To debug kioslaves:
#Set the KDE_SLAVE_DEBUG_WAIT environment variable in a current cmd.exe shell to the name of the kioslave's protocol (the first parameter of KIO::SlaveBase() constructor), e.g.<pre>set KDE_SLAVE_DEBUG_WAIT=file</pre>
#Terminate <tt>klauncher</tt> process so it can be restarted.
#Any application you want to debug at kioslave level have to be executed within the scope of the current environment (cmd.exe), what also means that if you want to use development environment, you have to do that in the environment as well, e.g. for MSVC Express, by typing <tt>vcexpress</tt>.

If the kioslave is requested the next time, a debugger will be started and attached to the kioslave process immediatly before the kioslave's kdemain() function.

On mingw platform gdb is launched and connected to the kioslave process. On msvc platforms the currently installed just-in-time debugger is used. This may be msvc's IDE or the [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg debugger]]. The latter could be set as jit-debugger by running 'windbg -I' command (capital -I like ICE, see [http://msdn2.microsoft.com/en-us/library/cc266343.aspx]).

=== Using KDE_SLAVE_DEBUG_POPUP variable ===
Alternatively, you can set <tt>KDE_SLAVE_DEBUG_POPUP</tt> variable instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. This will display a native message box so developer you can attach the debugger to the KIO slave process and click OK. No DebugBreak() is invoked. Just click OK without attaching to continue using the KIO slave without debugging.

=== Notes ===
*You can set, say, the variable to 'file' for the kio_file slave, '''but''' set it to 'smtps' for the kio_smtp is you want to debug smtp protocol secured with SSL.
*(Vista only): ''kioslave.exe has stopped working'' message dialog can appear instead of offer for starting the debugger. Reason: Just-In-Time (JIT) Debugging of an elevated process will fail ([http://msdn2.microsoft.com/en-us/vstudio/aa964140.aspx#question20a msdn link]) apparently for security reasons. Either:
**Use <tt>KDE_SLAVE_DEBUG_POPUP</tt> instead of <tt>KDE_SLAVE_DEBUG_WAIT</tt>. See the [[#Using_KDE_SLAVE_DEBUG_POPUP_variable|Using KDE_SLAVE_DEBUG_POPUP variable]] above for more info.
**(not possible under msvc 2005): start applications and klauncher without administration permissions or attach the debugger manually before the debugger catches unhandled exceptions or an user-defined breakpoint (DebugBreak()).
*You may want to inspect kioslave sources [http://lxr.kde.org/source/KDE/kdelibs/kinit/kioslave.cpp] for more informations.

== Checking dependency of shared libraries ==
Dependency Walker is a free utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. [[Projects/KDE_on_Windows/Tools#Dependency_Walker|more...]]

= MS Visual Studio hints =

== Using MS Visual Studio environment for just debugging ==

Let's assume you're using command line tools (typically CMake) and want to use MS Visual Studio environment for just debugging. You don't need to create msvc project for your KDE application to be able to start debugging.

* compile and working executable version of your appliation (compiled in debug mode)
* run msvc environment
* execute ''File->Open Project/Solution''
* pick your exe file in the file window
* you can set command line arguments as usual, by pick ''Project->...Properties'' command and enter all of them it in ''Command Arguments'' field
* if you have libraries placed in other directories than your application's .exe file, and you want to step into these libraries' source code while debugging, pick ''Project->...Properties'' command and enter paths to these directories in ''Symbol Path'' field
* hit F5 to run the application start the application or F10 to start step by step
* all debugging functions like setting breakpoints will be available, so you can open source code in the integrated editor and press F9 where needed
* you can even edit your source code but to compile it, do it with your external, command line tools. You cannot compile the application in the msvc environment because you have not defined a project file
* before compiling your application, stop debugging session to unlock binaries; no need to close msvc window
* after compilation you can start debugging again
* on exit you will be asked to save .sln file (so-called ''solution file'') with your debugging session -- do it and you will be able just to click the .sln file to start your debugging again
* it's recommended to save the .sln file in the .exe file directory
* next time you will run msvc environment, you can see name of your application's .sln file in ''File->Recent Projects'' submenu - you can click it to load your debugging session

== Attaching to running application ==

If you have your application is already running, you can attach to it and then start debugging.

* run msvc environment
* execute ''Debug->processes''
* select your from the processes list and click "Attach..."
* msvc environment will load your .sln file if it exists in the same directory as the .exe file, so your breakpoints set in previous session will be active again
* your program will stop on any breakpoint you have set

== One-step attaching to running application ==
You can create a macro that automates the task. See [http://blogs.msdn.com/jimgries/archive/2005/11/30/498264.aspx].

== Memory Values ==
If you are using the debug heap, memory is initialized and cleared with special values. Most interesting values are:
* 0xCDCDCDCD - Allocated in heap, but not initialized
* 0xDDDDDDDD - Released heap memory.
* 0xFDFDFDFD - "NoMansLand" fences automatically placed at boundary of heap memory. Should never be overwritten. If you do overwrite one, you're probably walking off the end of an array.
* 0xCCCCCCCC - Allocated on stack, but not initialized
See also: [http://www.samblackburn.com/wfc/technotes/WTN006.htm]

==How to Not Step Into Functions in the Debugger==
You'll probably want to avoind stepping into lower-level functions like QString constructors or operators while debugging step-by-step. Here's the detailed (unofficial) [http://blogs.msdn.com/andypennell/archive/2004/02/06/69004.aspx instruction] for various msvc versions.

==Enable automatic expanding of Qt data structures==
From the msvc docs: "While debugging, Data Tips and items in the Watch and Variable windows are automatically expanded to show their most important elements. The expansion follows the format given by the rules in this file. You can add rules for your types or change the predefined rules." ([http://www.thedatafarm.com/blog/content/binary/datatips2.jpg example screen])

MSVC 2005: To add support for expanding Qt data structures like QString of QRect, edit {msvc_installation_directory}\Common7\Packages\Debugger\autoexp.dat file and paste [[/Automatic expanding of Qt data structures|definitions]] after [AutoExpand] line.
==WINDOWS and CONSOLE subsystems==
CONSOLE subsystem is the one that displays console window (used for standard output and error streams) in addition to application's windows. WINDOWS subsystem redirects standard output and error streams to system debugging subsystem that can be displayed if needed in [[Projects/KDE_on_Windows/Tools#DebugView|DebugView]] or debuggers like msvc or [[Projects/KDE_on_Windows/Tools#WinDbg|WinDbg]].
Hint: To remove CONSOLE subsystem from already built .exe file, type <code>editbin /subsystem:windows file.exe</code>
Note: Qt's qmake syntax supports ''console'' and ''windows'' parameters of the ''CONFIG'' variable, so CONSOLE subsystem can be enabled by specifying <tt>CONFIG += console</tt> in the .pro file, windows subsystem can be enabled with <tt>CONFIG += windows</tt>.

==Deployment==
Running a VC++2005 SP1 app on another computer: manifest files are needed. See [http://www.codeproject.com/KB/cpp/vcredists_x86.aspx] and [http://blogs.msdn.com/nikolad/archive/2005/09/02/460368.aspx].

===Note on debug builds===
The hints above are for release builds (or ReleaseWithDebugInfo). Moving Debug versions of binaries to other computers is only allowed (and technicallu possible) if you have Express Edition installed there, as there is no redistributable package for Debug versions provided and even the license disallows distribution of any debug binaries (even your own).

= MinGW debugging hints =

There are gdb binaries you can directly run after unpacking them, e.g. from
[http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=20507 mingw's gdb downloads on sourceforge].

To get a backtrace for a crash you can reproduce: Start the gdb binary with the full path to the executable on the command line, for example like
<code>..\gdb\gdb.exe c:\programme\kontact\bin\kontact.exe</code>. When getting
the command prompt use the run command with the arguments for your application, e.g <code>run --nofork</code>. Now wait until your applications starts and go on reproducing the crash. Once you encounter the crash, gdb will be in control
in the command line again. <code>bt</code> will get you the backtrace.

Instead of running gdb from the beginning, you can also attach to a running process. Use the regular "task-manager" to see which process. Enable the process id columns so you can see the number. Now you can start gdb (still give it the path to the application executable if you can) and use the <code>attach</code> command with the process id you want to attach to from the
gdb prompt. Gdb will stop the process it attached to, so you can say <code>continue</code> and then try to produce the crash.

* Dr. Mingw - Just in Time Debugger [http://jrfonseca.planetaclix.pt/projects/gnu-win32/software/drmingw/]
* Debugging Qt programs on Windows [http://lists.trolltech.com/qt-interest/2005-08/thread01124-0.html]

'''''WARNING''''': If you are having crashes when starting applications via gdb beware of certain applications (mostly anti-virus software) that could cause problems like "Embassy Trust Suite", for example. See this [http://www.cygwin.com/ml/cygwin/2007-06/msg00405.html post].

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-22T10:06:10Z

Jstaniek: /* The Compiler */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
** [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
** [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]
{{Note|It is recommended to install Visual studio into a path not containing spaces. To do this, change the installation path from the proposed ..\Program Files\ to something like c:\vc9.}}

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvarsall.bat</tt> to set your environment variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK. It is installed into %PROGRAMFILES%\Microsoft SDKs\Windows.
Only version 6.0a is installed by the Visual Studio 2008 Express installer, while 6.1 is required to compile KDE components. So also download and install [http://www.microsoft.com/downloads/details.aspx?FamilyID=e6e1c3df-a74f-4207-8586-711ebe331cdc&displaylang=en version 6.1, i.e. Windows SDK for Windows Server 2008] by hand. See also the [http://msdn.microsoft.com/en-us/windowsserver/dd146047.aspx Which SDK is Right for Me?] document.

=== Improve Integration with the Visual Studio Environment ===
You can improve:
*Debugger support for Qt datatypes using autoexp.dat
*IntelliSense behaviour by adding Qt include directories
For details read http://eecs.vanderbilt.edu/research/hmtl/wiki/pmwiki.php?n=Knowledge.Qt

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T22:09:28Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
** [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
** [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]
{{Note|It is recommended to install Visual studio into a path not containing spaces. To do this, change the installation path from the proposed ..\Program Files\ to something like c:\vc9.}}

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvarsall.bat</tt> to set your environment variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK. It is installed into %PROGRAMFILES%\Microsoft SDKs\Windows.
Only version 6.0a is installed by the Visual Studio 2008 Express installer, while 6.1 is required to compile KDE components. So also download and install [http://www.microsoft.com/downloads/details.aspx?FamilyID=e6e1c3df-a74f-4207-8586-711ebe331cdc&displaylang=en version 6.1, i.e. Windows SDK for Windows Server 2008] by hand. See also the [http://msdn.microsoft.com/en-us/windowsserver/dd146047.aspx Which SDK is Right for Me?] document.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T21:57:48Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
** [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
** [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]
{{Note|It is recommended to install Visual studio into a path not containing spaces. To do this, change the installation path from the proposed ..\Program Files\ to something like c:\vc9.}}

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvarsall.bat</tt> to set your environment variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK. It is installed into %PROGRAMFILES%\Microsoft SDKs\Windows.
Only version 6.0a is installed by the Visual Studio 2008 Express installer, while 6.1 is required to compile KDE components. So also download and install [http://www.microsoft.com/downloads/details.aspx?FamilyID=e6e1c3df-a74f-4207-8586-711ebe331cdc&displaylang=en version 6.1, i.e. Windows SDK for Windows Server 2008] by hand.

See also the [http://msdn.microsoft.com/en-us/windowsserver/dd146047.aspx Which SDK is Right for Me?] document.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T21:53:14Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
** [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
** [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]
{{Note|It is recommended to install Visual studio into a path not containing spaces. To do this, change the installation path from the proposed ..\Program Files\ to something like c:\vc9.}}

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvarsall.bat</tt> to set your environment variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK. It is installed into %PROGRAMFILES%\Microsoft SDKs\Windows\.
&Only version 6.0a is installed by the Visual Studio 2008 Express installer, while 6.1 is required to compile KDE components. So also download and install [http://www.microsoft.com/downloads/details.aspx?FamilyID=e6e1c3df-a74f-4207-8586-711ebe331cdc&displaylang=en version 6.1, i.e. Windows SDK for Windows Server 2008] by hand.

See also the [http://msdn.microsoft.com/en-us/windowsserver/dd146047.aspx Which SDK is Right for Me?] document.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T21:41:02Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
** [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
** [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]
{{Note|It is recommended to install Visual studio into a path not containing spaces. To do this, change the installation path from the proposed ..\Program Files\ to something like c:\vc9.}}

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvarsall.bat</tt> to set your environment variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK that are also needed to compile KDE components. It is installed into %PROGRAMFILES%\Microsoft SDKs\Windows\. Note that apparently version 6.0a is installed on vista, while 6.1 is required. So to upgrade, download [http://www.microsoft.com/downloads/details.aspx?FamilyID=e6e1c3df-a74f-4207-8586-711ebe331cdc&displaylang=en 6.1] by hand.

See also the [http://msdn.microsoft.com/en-us/windowsserver/dd146047.aspx Which SDK is Right for Me?] document.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T21:31:23Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
** [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
** [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]
{{Note|It is recommended to install Visual studio into a path not containing spaces. To do this, change the installation path from the proposed ..\Program Files\ to something like c:\vc9.}}

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvarsall.bat</tt> to set your environment variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK that are also needed to compile KDE components. It is installed into %PROGRAMFILES%\Microsoft SDKs\Windows\. Note that apparently version 6.0a is installed on vista, while 6.1 is required. So to upgrade, download [http://www.microsoft.com/downloads/details.aspx?FamilyID=e6e1c3df-a74f-4207-8586-711ebe331cdc&displaylang=en 6.1] by hand.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T21:14:46Z

Jstaniek: /* Visual Studio 2008 SP1 */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
** [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
** [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]
{{Note|It is recommended to install Visual studio into a path not containing spaces. To do this, change the installation path from the proposed ..\Program Files\ to something like c:\vc9.}}

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvarsall.bat</tt> to set your environment variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK, that are also needed to compile KDE components.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T21:14:01Z

Jstaniek: /* The Compiler */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
** [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
** [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]
{{Note|It is recommended to install Visual studio into a path not containing spaces. To do this, change the installation path from the proposed ..\Program Files\ to something like c:\vc9.}}

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvars32.bat</tt> to set your variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK, that are also needed to compile KDE components.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T19:53:04Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
* [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
* [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvars32.bat</tt> to set your variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install (downloader) at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. It takes about 130 MB of download, assuming no MS SQL Server is selected.

The installer also downloads the Windows SDK, that are also needed to compile KDE components.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T19:28:00Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
* [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
* [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvars32.bat</tt> to set your variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the Web Install at [http://www.microsoft.com/express/download/ http://www.microsoft.com/express/download]. This takes about 130 MB of download, assuming no MS SQL Server is selected.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T19:27:38Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
* [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
* [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvars32.bat</tt> to set your variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the [http://www.microsoft.com/express/download/ Web Install at http://www.microsoft.com/express/download]. This takes about 130 MB of download, assuming no MS SQL Server is selected.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T19:27:09Z

Jstaniek: /* The Compiler */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
*First, uninstall previous version of Visual Studio, e.g. 2005 or 2003 if you have one. Do this to avoid problems.
*Now, you can use either:
* [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
* [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvars32.bat</tt> to set your variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the [http://www.microsoft.com/express/download/ Web Install]. This takes about 130 MB of download, assuming no MS SQL Server is selected.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T19:24:21Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
You can use either:
* [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
* [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvars32.bat</tt> to set your variables.

====Visual Studio 2008 SP1 Express Edition====
Install it using the [http://www.microsoft.com/express/download/ Web Install]. This takes about 130 MB of download, assuming no MS SQL Server is selected.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T19:24:08Z

Jstaniek: /* Visual Studio 2008 SP1 Express Edition */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
You can use either:
* [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
* [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvars32.bat</tt> to set your variables.

====Visual Studio 2008 SP1 Express Edition====
Install is using the [http://www.microsoft.com/express/download/ Web Install]. This takes about 130 MB of download, assuming no MS SQL Server is selected.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T19:23:53Z

Jstaniek: /* Visual Studio 2008 SP1 */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
You can use either:
* [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
* [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run <tt>vcvars32.bat</tt> to set your variables.

====Visual Studio 2008 SP1 Express Edition====
Install is using the
*[http://www.microsoft.com/express/download/ Web Install]. This takes about 130 MB of download, assuming no MS SQL Server is selected.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Getting Started/Build/Windows/MS Visual Studio

2009-08-11T19:17:07Z

Jstaniek: /* The Compiler */

{{improve|''This page is outdated - please don't use it anymore unless you know exactly what you do. Use [[Getting_Started/Build/KDE4/Windows/emerge|emerge]] instead''}}
{{KDE4}}
{{improve|''This page has been moved out of [http://kdelibs.com/wiki/index.php/Building_KDElibs_4_using_MS_Visual_Studio kdelibs.com] wiki page.''}}
== Basic Tools ==
=== Kdewin-Installer ===
This is a program that lets you easily install all the requirements for building kdelibs. It also has a list of tools in its list that are helpful and needed, like the mingw compiler suite, subversion clients, debugging tools and so on.

The kdewin-installer is available in a GUI and console-only form from
[http://download.cegit.de/kde-windows/installer/ the kdewin-installer download page].

=== The Compiler ===
You can use either:
* [[#Visual Studio 2008 SP1|(commercial) Visual Studio 2008 SP1]], or
* [[#Visual Studio 2008 SP1 Express Edition|free (as in beer) Visual Studio 2008 SP1 Express Edition]]

{{warning|Visual Studio 2005 SP1 or free (as in beer) Express 2005 are no longer supported. Moreover the Express version is not available at microsoft.com.}}

====Visual Studio 2008 SP1====
There is not much to do - installer of the commercial version sets up the environment. Just do not forget to run vcvars32.bat to set your variables.

====Visual Studio 2008 SP1 Express Edition====
Install is using the
*[http://www.microsoft.com/express/download/ Web Install]. This takes about 130 MB of download, assuming no MS SQL Server is selected.

=== CMake ===
[http://www.cmake.org CMake] is the make tool used by KDE.
You can get the most recent binaries from [http://www.cmake.org/HTML/Download.html here]. Use the Win32 Installer or the zip archive. Make sure you use at least cmake 2.4.5

On Windows 2000, it's recommended to install cmake in a path without spaces to avoid troubles.

== Compile and Install additional libraries ==
These libraries have to be installed:

=== D-Bus for Windows ===
This library can be downloaded and installed with the installer (use the package name dbus-msvc) or you can [[Getting_Started/Build/KDE4/Windows/Building DBus|compile]] it by yourself.

=== Qt 4 ===
This Framework can be downloaded with the installer, or you can [[Getting_Started/Build/KDE4/Windows/Building Qt 4|build it on your own]].

=== KDESupport Libraries ===
There are several libraries which will be required for building kdelibs. [[Getting Started/Build/KDE4/Windows/Building KDESupport Libraries|You may want to compile them yourself]] or simply download them using the KDEWin-Installer. You will need:
*kdewin32 (compiled with msvc)
*strigi
*soprano
*qca2
*qimageblitz

=== Environment Settings ===
To set up a build environment, follow the steps over [[Getting Started/Build/KDE4/Windows/Environment|here]]. '''If you have Cygwin installed, please be sure to remove Cygwin's /bin out of your path.'''

== Build KDElibs ==
Check out the sources and make another build directory at the same level as kdelibs:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd ..
mkdir kdelibs-build
cd kdelibs-build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
Build KDE libraries with:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdelibs
nmake
nmake install
</pre>
or use the IDE:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdelibs
</pre>
(<strike>use -G "Visual Studio 7 .NET 2003" for the older compiler</strike>)

In the latter case <tt>kdelibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdelibs.sln
devenv /build Release /project INSTALL kdelibs.sln

The devenv command is not available in the Express Edition.

If you use makefiles and also want to build the test programs add the option <tt>-DKDE4_BUILD_TESTS=1</tt> to the <tt>cmake</tt> command. This is not necessary for the IDE projects.

== Troubles? ==
*to enable the release build (for example if you get libcmt.lib vs msvcrt.lib conflict on linking stage) add <tt>-DCMAKE_BUILD_TYPE=Release</tt> to the <tt>cmake</tt> command
*when kdewin32 is not found, try adding the cmake parameter (with YOUR path)<tt>-DGNUWIN32_DIR=c:/gnuwin32</tt>
*don't use a cygwin or mingw shell, you will get errors because these shells use UNIX path names
*you could restart the configure process by deleting CMakeCache.txt
*you could test for only one library by deleting the assignment in CMakeCache.txt
*ask for more help on [https://mail.kde.org/mailman/listinfo/kde-buildsystem kde-buildsystem@kde.org] mailing list
*whenever you update your checkout DON'T forget to rebuild '''AND''' reinstall kdewin32.lib

== Going further: kdepimlibs ==
'''kdepimlibs''' are needed by kdebase or other modules like koffice.
=== Requirements ===
kdepimlibs require:
*[http://boost.org/ boost libraries]. Download the tarball. As boost is consisted of headers only, unpack the tarball and copy <tt>boost</tt> subdirectory to <tt>%KDEDIR%\include</tt>. Then add use <tt>set BOOST_ROOT=%KDEDIR%\include</tt> (you may want to add it to your <tt>environment.bat</tt> file as well).
*[http://www.gpg4win.org/ gpgme] libraries, needed to provide GNU Privacy Guard support in KDE PIM applications
*(really optional for now) [http://www.openldap.org OpenLDAP]: LDAP (Lightweight Directory Access Protocol) libraries Needed to provide LDAP functionality in KDE
*(really optional for now) [http://asg.web.cmu.edu/sasl/sasl-library.html cyrus-sasl]: Cyrus SASL API needed to support authentication of logins

=== Build ===
Check out the sources, make another build directory and build:
<pre>
cd {KDE_SOURCE_DIR}\trunk\KDE
svn up kdepimlibs
mkdir kdepimlibs-build
cd kdelibs-build
cmake -DCMAKE_INSTALL_PREFIX=%KDEDIRS% -DCMAKE_BUILD_TYPE=Debug\
-G"NMake Makefiles" ..\kdepimlibs
nmake
nmake install
</pre>
or use Visual Studio:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Debug\
-G "Visual Studio 8 2005" ..\kdepimlibs
</pre>
(use -G "Visual Studio 7 .NET 2003" for the older compiler)

In the latter case <tt>kdepimlibs.sln</tt> solution file will be created. Build and '''install''' the Debug and Release builds with the IDE. '''Tip:''' to do this from command line, type:

devenv /build Debug /project INSTALL kdepimlibs.sln
devenv /build Release /project INSTALL kdepimlibs.sln

The devenv command is not available in the Express Edition.

== Going further: kofficelibs ==
''(work in progress, to be moved to KOffice wiki)''

'''kofficelibs''' are needed for apps like KWord or Kexi.
=== Requirements ===
kofficelibs require:
*[http://www.littlecms.com Little cms] library. Download the newest lcms-1.??.zip from [http://www.littlecms.com/downloads.htm] and uncompress. To build it with msvc, go to <tt>Projects</tt> subdir and choose a subdir for your compiler (i.e. Vc7 or Vc2005).
*#Then you will see <tt>lcms.sln</tt> solution file - you can click it to open in the msvc IDE. But first, you need to fix some paths in the project files. You probably have <tt>%KDEDIR%\lib\jpeg.lib</tt>, not libjpeg.lib, so edit <tt>tifficc.vcproj</tt>, <tt>tiffdiff.vcproj</tt> and <tt>jpegicc.vcproj</tt> and change libjpeg.lib to jpeg.lib in <tt>AdditionalDependencies</tt> variable. Then add full path to your <tt>%KDEDIR%\include</tt> directory (where tiffio.h resides) in AdditionalIncludeDirectories variable, (note: do it by expanding KDEDIR environment variable, i.e the result should be like: <pre>AdditionalIncludeDirectories="..\..\include;f:\kde4\include"</pre> Then add <tt>AdditionalLibraryDirectories="c:\your\path\to\kde\lib"</tt> line just after every two occurences of <tt>AdditionalIncludeDirectories=</tt>. All the changes are presented in [[Getting_Started/Build/KDE4/Windows/Littlecms.patch|this pseudo-patch]] (change f:\ paths to your KDEDIR location!).
*#You probbaly want to skip building Python wrapper, so click on Build->Configuration Manager menu command and check off "Build" in "Python" line.
*#Select "Build Solution" menu command. After successful build, you should notice:<tt>Build: 9 succeeded, 0 failed, 1 skipped</tt>
*#To also build Release versions of the binaries, in the ''Configuration Manager'', change active configuration to ''Release'' and repeat steps 1-3.
*# Copy the compiled binaries. From your <tt>lcms-1.??\Lib\Ms</tt> copy <tt>*.lib</tt> files to <tt>%KDEDIR%\lib</tt>. From <tt>lcms-1.??\bin</tt> copy <tt>*.dll</tt> and <tt>*.exe</tt> files to <tt>%KDEDIR%\bin</tt>.
*#Copy lcms headers: from <tt>lcms-1.??\include</tt> copy <tt>*.h</tt> to <tt>%KDEDIR%\include</tt>.
*#Later when you will run cmake for kofficelibs, you get message like <tt>-- Found lcms version 1.16, F:/kde4/lib/lcms.lib</tt>.

== Building app modules using prebuilt kdelibs ==
Install all devel packages using kdewin-installer as usual, + msvc2005. Then:
<pre>
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdesdk
mkdir kdesdk\build
cd kdesdk\build
</pre>
Now you have to add some paths to your PATH environment variable simliar to this:
<pre>
set PATH=%QTDIR%\bin;%PATH%;%INSTALL_PATH%\lib;
</pre>
You may need to setup msvc environment:
<pre>
call "C:\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86
</pre>
Build command:
<pre>
cmake -DCMAKE_INSTALL_PREFIX=%INSTALL_PATH% -DCMAKE_BUILD_TYPE=Release -G"NMake Makefiles" ..
nmake
nmake install
</pre>

==Useful links==
*[[Getting_Started/Build/KDE4/Windows/3rd-party_libraries|List of libraries that are needed to build KDE on windows]] (most of these are already installed by the kde-installer) .

[[Category:MS Windows]]

Development/Tutorials/Kross/Introduction

2009-03-07T17:45:51Z

Jstaniek: /* The Interpreter plugins */

==Introduction==
The [http://kross.dipe.org Kross] scripting framework provides full [http://www.python.org/ Python], [http://www.ruby-lang.org/ Ruby] and [http://xmelegance.org/kjsembed KDE JavaScript] scripting support. The goal was
to limit the work needed on applications to have them fully scriptable and to provide a modular way to transparently integrate additional interpreters and in that way extend your application with a new scripting-backend without any new line of code and even without any recompile. To achieve this internally Qt's introspection-functionality like signals, slots, properties, enums, QVariant, QObject, QMetaObject, QMetaType, etc. are used to deal with functionality at runtime.

===What Kross is===
Kross is a modular scripting framework that eases embedding of scripting interpreters like Python, Ruby and JavaScript transparently into native applications to bridge the static and dynamic worlds together.

Scripting interpreters are plugins that are loaded dynamically on demand at runtime by the Kross framework. The application that uses Kross to provide scripting functionality to the user does not need to know anything about the interpreter, itself or any other backend-details. All the application needs to know is that there exists scripting code that should be executed. Kross will then take care of it.

===What Kross is not===
Kross does not implement its own scripting language, rather, it provides access to already existing solutions. Kross does not implement a complete Toolkit-binding, rather, it provides access to already existing solutions like PyQt/PyKDE or TkInter for Python or Korundum/QtRuby for Ruby. Kross does not auto-generate code, it is not needed to maintain any configuration files, and it does not come with yet another bindings-API. All it does is to connect things transparently together and to offer optional access to already existing technologies.

===Reuse and choice are the goals===
There exists a wide range of solutions to deal with scripting. Programming languages like Python have enjoyed years of evolution and a large community around them with 3rd-party modules for nearly everything. The same goes for a lot of other languages where there sometimes exists a special function that is only available to a particular language, and where each language comes with its own way of doing things. Each user may have their own preference for what scripting language they like to use, and over time, may have acquired skills in some specific areas.

Rather than limiting users to only one specific language with its own way of doing things, Kross offers a flexible way of supporting multiple programming languages without additional code and maintenance work, at the application level. Kross allows the user to choose what they like and know the most, and it minimizes the entry-barrier to get his things done and to be able to contribute to one's own solutions significantly.

===Supported interpreters===
As of today Python, Ruby and JavaScript are supported. While all of them are passing the unittests, current state is, that Python is the most complete one followed by Ruby which is near the same state and finally JavaScript which needs some more tweaks to be as rock-stable as the other both implementations.

Work on progress are krossjava (thanks to google for supporting this plugin within the Google Summer of Code 2007) that implements support for the Java Virtual Machine and krossfalcon that implements support for The Falcon Programming Language.

For sure any interpreter-plugin you may like to implement is very welcome. At the end the open source world is about choices :)

===Advantage of Kross over other solutions===
* '''Scripting interpreter independent.''' Kross does not implement an interpreter, it provides access to already existing interpreters. You don't limit your users to a particular scripting language, each user is free to decide which scripting language is best suited.
* '''Real embedding.''' Rather then communicating with scripting backends e.g. over stdin/stdout or D-Bus Kross does come with plugins that really embed the interpreters and deal with them on the native C/C++ code level to gain optimal performance and flexibility.
* '''Kross is fast.''' Kross had a bit of luck to be adopted by Krita so early since one of the top-priorities Krita had on a scripting backend was performance. During the years we managed to increase the speed to a level where it's hard to see a difference to native in C/C++ written code.
* '''Kross is platform-independent.''' From the beginning Kross was designed with platform-independence in mind. This is the result of the origins of Kross - it started as Kexi plugin, and Kexi itself runs at least on Linux, Windows and Mac since it's early days.
* '''Kross is stable and well proven.''' Before Kross finally landed in kdelibs it was in use in KOffice for 3 major releases and was thus "tested" by a wide range of users worldwide.
* '''A lot of documentation, scripts and applications are using Kross already today.''' The latter guarantees that Kross offers the solution for many scenarios.
* '''Kross can be easily extended with a new scripting interpreter.''' There are no changes needed to the applications. So, whatever hype we are able to see in the next few years, we are ready to fullfit the possible user-requests for them without much pain.
* '''Kross benefits from applications.''' The synergy-effect if multiple applications are sharing the same interpreter plugin implementations ensures that bugs are discovered and fixed as soon as possible. Also each app is able to profit if someone writes for example a plugin for the LUA-interpreter each app is able to use the new backend without any recompile.
* '''Kross reuses existing technologies as much as possible.''' There is no need for code-generation at compile time and no new "bindings API" is introduced since we are reusing the Qt Meta-Object System. You are able to throw in a QObject and a script is able to connect with the signals, call slots as there are functions, access enumerations, get/set properties or pass QObject/QWidget instances around as there are classes.
* '''The interpreter backend is very flexible.''' Each interpreter's plugin is able to decide on its own how to implement the bridging functionality. If you like for example to have it more "pythonic" by using the decorators introduced in Python 2.4, you are free to implement it and each app that uses Kross will profit by beeing able to use such decorators from now on.
* '''Kross will stay backward-compatible.''' Kross is part of kdelibs and thus follows strict policies to provide backward-compatibility at least during the lifetime of KDE4.

==The Interpreter plugins==

Kross offers a ''plugin interface'' to integrate interpreter backends like Python, Ruby and KDE-Javascript. They are loaded on demand at runtime. Neither the application nor Kross needs to know any details about the backends. This clear separation between the application and scripting details enables at the one hand, to deal with scripting at an abstract level without being bound to only one backend, and at the other hand makes it easy to integrate scripting into an already existing application.

Each interpreter plugin needs to implement two abstract classes;
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/interpreter.h?view=markup Kross::Interpreter] class is a singleton controlled by the [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/manager.h?view=markup Kross::Manager] and could be used to setup the interpreter or do other things to share functionality between instances of the Script class.
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/script.h?view=markup Kross::Script] class handles exactly one script instance. An application is able to deal with multiple scripts at the same time where each of them has it's own instance of the Kross::Script class controlled by an instance of the more abstract [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/action.h?view=markup Kross::Action] class.

===Python===

The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/ Python plugin] implements access to the [http://www.python.org/ Python] scripting language.

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/unittest.py?view=markup unittest.py] Python script file implements unittests for common functionality. For the unittests kross does use a special test-application that got compiled if cmake -DKDE4_BUILD_TESTS=1 was used for kdelibs. You are able to run the unittest with
<pre>
cd kdelibs/kross/test
./krosstest unittest.py
</pre>

Other scripts are...
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/testkross.py?view=markup testkross.py] Python script file demonstrates how to use Kross to execute some JavaScript code within a python script.
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/testguitk.py?view=markup testguitk.py] Python script file that creates and displays a modal dialog using the TkInter GUI-toolkit.
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/testguiqt.py?view=markup testguiqt.py] Python script file shows how to use PyQt while the [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/testguiform.py?view=markup testguiform.py] uses the Kross Form module.

The krosspython plugin consists of...
* The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythoninterpreter.h?view=markup Kross::PythonInterpreter] class implements [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/interpreter.h?view=markup Kross::Interpreter] for the Python interpreter backend and implements the createScript factory method to create [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonscript.h?view=markup Kross::PythonScript] instances.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonscript.h?view=markup Kross::PythonScript] class implements [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/script.h?view=markup Kross::Script] for the Python backend to provide the functionality to execute Python code within a script-container.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonmodule.h?view=markup Kross::PythonModule] class is the __main__ Python environment used as global object namespace. This module is shared between the different [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonscript.h?view=markup Kross::PythonScript] instances which run in there own module namespace. The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonmodule.h?view=markup Kross::PythonModule] also spends access to the the whole Kross functionality and manages all the @a Kross::PythonExtension modules.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonextension.h?view=markup Kross::PythonExtension] class implements a Py::Object to wrap a QObject instance into the world of Python.
* Within [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonvariant.h?view=markup Kross::PythonVariant] the Kross::PythonType helper class is used to cast between QVariant and Py::Object values while the Kross::PythonMetaTypeFactory helper class is used as factory within [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonextension.h?view=markup Kross::PythonExtension] to translate an argument into a Kross::MetaType needed for QGenericArgument's data pointer.

===Ruby===

The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/ Ruby plugin] implements access to the [http://www.ruby-lang.org/ Ruby] scripting language.

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/unittest.rb?view=markup unittest.rb] Ruby script file implements unittests for common functionality. For the unittests kross does use a special test-application that got compiled if cmake -DKDE4_BUILD_TESTS=1 was used for kdelibs. You are able to run the unittest with
<pre>
cd kdelibs/kross/test
./krosstest unittest.rb
</pre>

The krossruby plugin consists of...
* The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyinterpreter.h?view=markup Kross::RubyInterpreter] class implements [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/interpreter.h?view=markup Kross::Interpreter] for the Ruby interpreter backend and provides with the createScript a factory method to create [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyscript.h?view=markup Kross::RubyScript] instances.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyscript.h?view=markup Kross::RubyScript] class implements [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/script.h?view=markup Kross::Script] for the Ruby backend to provide the functionality to execute Ruby code within a script-container.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubymodule.h?view=markup Kross::RubyModule] class is the __main__ Ruby environment used as global object namespace. This module is shared between the different [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyscript.h?view=markup Kross::RubyScript] instances which run in there own module namespace. The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubymodule.h?view=markup Kross::RubyModule] also spends access to the the whole Kross functionality and manages all the @a Kross::RubyExtension modules.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyextension.h?view=markup Kross::RubyExtension] class implements a Ruby VALUE object to wrap a QObject instance into the world of Ruby.
* Within [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyvariant.h?view=markup Kross::RubyVariant] the Kross::RubyType helper class is used to cast between QVariant and Ruby VALUE values while the Kross::RubyMetaTypeFactory helper class is used as factory within [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyextension.h?view=markup Kross::RubyExtension] to translate an argument into a Kross::MetaType needed for QGenericArgument's data pointer.

===JavaScript===

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/kjs KDE JavaScript plugin] uses the in kdelibs4 included Kjs and KjsEmbed4 frameworks to provide access to the JavaScript language.

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/unittest.js?view=markup unittest.js] KDE-JavaScript script file implements unittests for common functionality. For the unittests kross does use a special test-application that got compiled if cmake -DKDE4_BUILD_TESTS=1 was used for kdelibs. You are able to run the unittest with
<pre>
cd kdelibs/kross/test
./krosstest unittest.js
</pre>

For details about KDE-JavaScript see...
* [http://websvn.kde.org/trunk/KDE/kdelibs/kjs/README?view=markup Kjs readme]
* [http://websvn.kde.org/trunk/KDE/kdelibs/kjs/ Kjs svn]
* [http://xmelegance.org/kjsembed KjsEmbed home]
* [https://mail.kde.org/mailman/listinfo/kjsembed KjsEmbed mailinglist]
* [http://websvn.kde.org/trunk/KDE/kdelibs/kjsembed/ KjsEmbed svn]

===Java===

The [[Projects/Summer_of_Code/2007/Projects/KrossJava|Google Summer of Code 2007]] did provide us the [http://websvn.kde.org/trunk/KDE/kdebindings/java/krossjava/ krossjava] backend for Java :-)

===Falcon===

The [http://websvn.kde.org/trunk/playground/bindings/krossfalcon/ krossfalcon] plugin does implement access to [http://www.falconpl.org The Falcon Programming Language].

==The Module plugins==

Modules are plugins loaded on demand at runtime to provide additional functionality. They only provide a factory to create and return a QObject instance that is then exposed to the scripting backend.

Since Qt's introspection functionality is used, we are able to throw in just {{qt|QObject}}'s and have them act as classes/objects within a scripting backend. Slots are membermethods while properties and enumerations are membervariables. If your application also likes to offer [http://hal.freedesktop.org/wiki/Software/dbus D-Bus] support it may be an idea to reuse the {{qt|QDBusAbstractAdaptor}} implementations your application has also for scripting, like for example [[Development/Tutorials/KSpread_Scripting|KSpread]] did.

Let's take a look at the following code that implements the MyObject class which inherits from QObject;
<code cppqt>
class MyObject : public QObject {
Q_OBJECT
Q_PROPERTY(QString name READ name WRITE setName)
public:
MyObject(QObject* parent = 0) : QObject(parent) {}
virtual ~MyObject() {}
QString name() const { return objectName(); }
void setName(const QString& name) {
return setObjectName(name);
}
public slots:
QObject* create(const QString& name,
QObject* parent=0) {
MyObject* obj = new MyObject(parent);
obj->setObjectName(name);
return obj;
}
QObject* parent() const { return QObject::parent(); }
void setParent(QObject* parent) {
QObject::setParent(parent);
emit parentChanged();
}
signals:
void parentChanged();
};

extern "C" {
KDE_EXPORT QObject* krossmodule() {
return new MyObject();
}
}
</code>
At the bottom the krossmodule() function will be called by Kross and returns an instance of MyObject that is then exposed to the scripting backend.

Then we just need to have our myobject.h and myobject.cpp files, filled with the content above, defined in the CMakeLists.txt file. The library needs to be named "krossmodule..." where the "..." is then the name the module is accessible as. For our example we use "krossmodulemyobjectmod" and therefore we are able to access the module if installed as "myobjectmod". The example does not depend on Kross, so you may like to replace ${KROSS_INCLUDES} with whatever else your module depends on.
<pre>
include_directories(${CMAKE_SOURCE_DIR}
${KROSS_INCLUDES})
set(krossmodulemyobjectmod_PART_SRCS
myobject.cpp)
kde4_add_plugin(krossmodulemyobjectmod
${krossmodulemyobjectmod_PART_SRCS})
target_link_libraries(krossmodulemyobjectmod
${KDE4_KDECORE_LIBS} ${KDE4_KROSSCORE_LIBS})
install(TARGETS krossmodulemyobjectmod
DESTINATION ${PLUGIN_INSTALL_DIR})
</pre>

The following Python sample code accesses then the module at runtime and uses the QObject, calls it's slots and properties and connects a signal with a python function (e.g. save as file named "myobjecttest.py" and execute with "kross ./myobjecttest.py");

<code python>
#!/usr/bin/env kross
import Kross
m = Kross.module("myobjectmod")
m.name = "MyObjectModuleName"
obj1 = m.create("OtherObjectName")
def myCallbackFunc(args):
print "The parent of obj1 changed"
obj1.connect("parentChanged()",myCallbackFunc)
obj1.setParent(m)
print "%s %s" % (obj1.name,obj1.parent().name)
</code>

==Manager, GuiClient, Action==

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/manager.h?view=markup Kross::Manager] class is a singleton that provides access to the interpreters, to actions and to the modules. The Kross::Manager is available within scripting code as module named "Kross". Following Python script uses the Kross module to create a new Kross::Action instance, fills it with JavaScript code and executes that JavaScript code.

<code python>
#!/usr/bin/env kross
import Kross
a = Kross.action("MyKjsScript")
a.setInterpreter("javascript")
a.setCode("println(\"Hello world from Kjs\");")
a.trigger()
</code>

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/guiclient.h?view=markup Kross::GuiClient] class implements KXMLGUIClient to provide GUI functionality, handling of XML configuration files on a more abstract level and offers some predefined actions that could be optionally used in your application.

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/action.h?view=markup Kross::Action] class offers an abstract container to deal with scripts like a single standalone scriptfile. Each action holds a reference to the by the matching [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/interpreter.h?view=markup Kross::Interpreter] instance created by [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/script.h?view=markup Kross::Script] instance. Following Python script accesses the Kross module and the self variable which is our Kross::Action instance that provides the context for the running Python script.

<code python>
#!/usr/bin/env kross
import Kross
print "objectName=%s" % Kross.objectName()
print "interpreters=%s" % Kross.interpreters()
print "objectName=%s" % self.objectName()
print "text=%s" % self.text
print "enabled=%s" % self.enabled
print "currentPath=%s" % self.currentPath()
print "interpreter=%s" % self.interpreter()
print "description=%s" % self.description()
print "code=%s" % self.code()
</code>

==D-Bus and Kross==

With the [http://doc.trolltech.com/4.2/qtdbus.html QtDBus module] Qt provides a library that a Qt/KDE application is able to use to make Inter-Process Communication using the [http://dbus.freedesktop.org D-BUS protocol].

The QtDBus module uses the Qt Signals and Slots mechanism. Applications that like to provide parts of their functionality to the D-Bus world are able to do so by implementing classes that inherit from the {{qt|QDBusAbstractAdaptor}} class.

Kross is able to reuse such by an application provided bindings. So, once your application supports D-Bus, Kross is able to reuse those already existing code and offers transparent access to the scripting-backends to them. How does this differ from e.g. the python-dbus package? Well, first method-calls don't go through the dbus-socket and then it's not dbus-related at all except, that we are able to reuse what your application offers anyway: a clean interface to the outside world. But that's not all, we are not limited to what's possible with D-Bus. We are also able to exchange instance-pointers to QObject or QWidget instances.

For an example you may like to take a look at how it was done in the KSpread [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/ScriptingModule.cpp?view=markup ScriptingModule] class.

Development/Tutorials/Kross/Introduction

2009-03-07T17:29:18Z

Jstaniek: /* What Kross is */ grammar

==Introduction==
The [http://kross.dipe.org Kross] scripting framework provides full [http://www.python.org/ Python], [http://www.ruby-lang.org/ Ruby] and [http://xmelegance.org/kjsembed KDE JavaScript] scripting support. The goal was
to limit the work needed on applications to have them fully scriptable and to provide a modular way to transparently integrate additional interpreters and in that way extend your application with a new scripting-backend without any new line of code and even without any recompile. To achieve this internally Qt's introspection-functionality like signals, slots, properties, enums, QVariant, QObject, QMetaObject, QMetaType, etc. are used to deal with functionality at runtime.

===What Kross is===
Kross is a modular scripting framework that eases embedding of scripting interpreters like Python, Ruby and JavaScript transparently into native applications to bridge the static and dynamic worlds together.

Scripting interpreters are plugins that are loaded dynamically on demand at runtime by the Kross framework. The application that uses Kross to provide scripting functionality to the user does not need to know anything about the interpreter, itself or any other backend-details. All the application needs to know is that there exists scripting code that should be executed. Kross will then take care of it.

===What Kross is not===
Kross does not implement its own scripting language, rather, it provides access to already existing solutions. Kross does not implement a complete Toolkit-binding, rather, it provides access to already existing solutions like PyQt/PyKDE or TkInter for Python or Korundum/QtRuby for Ruby. Kross does not auto-generate code, it is not needed to maintain any configuration files, and it does not come with yet another bindings-API. All it does is to connect things transparently together and to offer optional access to already existing technologies.

===Reuse and choice are the goals===
There exists a wide range of solutions to deal with scripting. Programming languages like Python have enjoyed years of evolution and a large community around them with 3rd-party modules for nearly everything. The same goes for a lot of other languages where there sometimes exists a special function that is only available to a particular language, and where each language comes with its own way of doing things. Each user may have their own preference for what scripting language they like to use, and over time, may have acquired skills in some specific areas.

Rather than limiting users to only one specific language with its own way of doing things, Kross offers a flexible way of supporting multiple programming languages without additional code and maintenance work, at the application level. Kross allows the user to choose what they like and know the most, and it minimizes the entry-barrier to get his things done and to be able to contribute to one's own solutions significantly.

===Supported interpreters===
As of today Python, Ruby and JavaScript are supported. While all of them are passing the unittests, current state is, that Python is the most complete one followed by Ruby which is near the same state and finally JavaScript which needs some more tweaks to be as rock-stable as the other both implementations.

Work on progress are krossjava (thanks to google for supporting this plugin within the Google Summer of Code 2007) that implements support for the Java Virtual Machine and krossfalcon that implements support for The Falcon Programming Language.

For sure any interpreter-plugin you may like to implement is very welcome. At the end the open source world is about choices :)

===Advantage of Kross over other solutions===
* '''Scripting interpreter independent.''' Kross does not implement an interpreter, it provides access to already existing interpreters. You don't limit your users to a particular scripting language, each user is free to decide which scripting language is best suited.
* '''Real embedding.''' Rather then communicating with scripting backends e.g. over stdin/stdout or D-Bus Kross does come with plugins that really embed the interpreters and deal with them on the native C/C++ code level to gain optimal performance and flexibility.
* '''Kross is fast.''' Kross had a bit of luck to be adopted by Krita so early since one of the top-priorities Krita had on a scripting backend was performance. During the years we managed to increase the speed to a level where it's hard to see a difference to native in C/C++ written code.
* '''Kross is platform-independent.''' From the beginning Kross was designed with platform-independence in mind. This is the result of the origins of Kross - it started as Kexi plugin, and Kexi itself runs at least on Linux, Windows and Mac since it's early days.
* '''Kross is stable and well proven.''' Before Kross finally landed in kdelibs it was in use in KOffice for 3 major releases and was thus "tested" by a wide range of users worldwide.
* '''A lot of documentation, scripts and applications are using Kross already today.''' The latter guarantees that Kross offers the solution for many scenarios.
* '''Kross can be easily extended with a new scripting interpreter.''' There are no changes needed to the applications. So, whatever hype we are able to see in the next few years, we are ready to fullfit the possible user-requests for them without much pain.
* '''Kross benefits from applications.''' The synergy-effect if multiple applications are sharing the same interpreter plugin implementations ensures that bugs are discovered and fixed as soon as possible. Also each app is able to profit if someone writes for example a plugin for the LUA-interpreter each app is able to use the new backend without any recompile.
* '''Kross reuses existing technologies as much as possible.''' There is no need for code-generation at compile time and no new "bindings API" is introduced since we are reusing the Qt Meta-Object System. You are able to throw in a QObject and a script is able to connect with the signals, call slots as there are functions, access enumerations, get/set properties or pass QObject/QWidget instances around as there are classes.
* '''The interpreter backend is very flexible.''' Each interpreter's plugin is able to decide on its own how to implement the bridging functionality. If you like for example to have it more "pythonic" by using the decorators introduced in Python 2.4, you are free to implement it and each app that uses Kross will profit by beeing able to use such decorators from now on.
* '''Kross will stay backward-compatible.''' Kross is part of kdelibs and thus follows strict policies to provide backward-compatibility at least during the lifetime of KDE4.

==The Interpreter plugins==

Kross offers a plugin-interface to integrate interpreter backends like Python, Ruby and KDE-Javascript. They are loaded on demand at runtime. Neither the application nor Kross needs to know any details about the backends. This clear separation between the application and scripting details enables at the one hand, to deal with scripting at an abstract level without being bound to only one backend, and at the other hand makes it easy to integrate scripting into an already existing application.

Each interpreter plugin needs to implement two abstract classes;
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/interpreter.h?view=markup Kross::Interpreter] class is a singleton controlled by the [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/manager.h?view=markup Kross::Manager] and could be used to setup the interpreter or do other things to share functionality between instances of the Script class.
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/script.h?view=markup Kross::Script] class handles exactly one script instance. An application is able to deal with multiple scripts at the same time where each of them has it's own instance of the Kross::Script class controlled by an instance of the more abstract [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/action.h?view=markup Kross::Action] class.

===Python===

The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/ Python plugin] implements access to the [http://www.python.org/ Python] scripting language.

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/unittest.py?view=markup unittest.py] Python script file implements unittests for common functionality. For the unittests kross does use a special test-application that got compiled if cmake -DKDE4_BUILD_TESTS=1 was used for kdelibs. You are able to run the unittest with
<pre>
cd kdelibs/kross/test
./krosstest unittest.py
</pre>

Other scripts are...
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/testkross.py?view=markup testkross.py] Python script file demonstrates how to use Kross to execute some JavaScript code within a python script.
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/testguitk.py?view=markup testguitk.py] Python script file that creates and displays a modal dialog using the TkInter GUI-toolkit.
* The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/testguiqt.py?view=markup testguiqt.py] Python script file shows how to use PyQt while the [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/testguiform.py?view=markup testguiform.py] uses the Kross Form module.

The krosspython plugin consists of...
* The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythoninterpreter.h?view=markup Kross::PythonInterpreter] class implements [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/interpreter.h?view=markup Kross::Interpreter] for the Python interpreter backend and implements the createScript factory method to create [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonscript.h?view=markup Kross::PythonScript] instances.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonscript.h?view=markup Kross::PythonScript] class implements [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/script.h?view=markup Kross::Script] for the Python backend to provide the functionality to execute Python code within a script-container.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonmodule.h?view=markup Kross::PythonModule] class is the __main__ Python environment used as global object namespace. This module is shared between the different [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonscript.h?view=markup Kross::PythonScript] instances which run in there own module namespace. The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonmodule.h?view=markup Kross::PythonModule] also spends access to the the whole Kross functionality and manages all the @a Kross::PythonExtension modules.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonextension.h?view=markup Kross::PythonExtension] class implements a Py::Object to wrap a QObject instance into the world of Python.
* Within [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonvariant.h?view=markup Kross::PythonVariant] the Kross::PythonType helper class is used to cast between QVariant and Py::Object values while the Kross::PythonMetaTypeFactory helper class is used as factory within [http://websvn.kde.org/trunk/KDE/kdebindings/python/krosspython/pythonextension.h?view=markup Kross::PythonExtension] to translate an argument into a Kross::MetaType needed for QGenericArgument's data pointer.

===Ruby===

The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/ Ruby plugin] implements access to the [http://www.ruby-lang.org/ Ruby] scripting language.

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/unittest.rb?view=markup unittest.rb] Ruby script file implements unittests for common functionality. For the unittests kross does use a special test-application that got compiled if cmake -DKDE4_BUILD_TESTS=1 was used for kdelibs. You are able to run the unittest with
<pre>
cd kdelibs/kross/test
./krosstest unittest.rb
</pre>

The krossruby plugin consists of...
* The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyinterpreter.h?view=markup Kross::RubyInterpreter] class implements [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/interpreter.h?view=markup Kross::Interpreter] for the Ruby interpreter backend and provides with the createScript a factory method to create [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyscript.h?view=markup Kross::RubyScript] instances.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyscript.h?view=markup Kross::RubyScript] class implements [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/script.h?view=markup Kross::Script] for the Ruby backend to provide the functionality to execute Ruby code within a script-container.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubymodule.h?view=markup Kross::RubyModule] class is the __main__ Ruby environment used as global object namespace. This module is shared between the different [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyscript.h?view=markup Kross::RubyScript] instances which run in there own module namespace. The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubymodule.h?view=markup Kross::RubyModule] also spends access to the the whole Kross functionality and manages all the @a Kross::RubyExtension modules.
* The [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyextension.h?view=markup Kross::RubyExtension] class implements a Ruby VALUE object to wrap a QObject instance into the world of Ruby.
* Within [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyvariant.h?view=markup Kross::RubyVariant] the Kross::RubyType helper class is used to cast between QVariant and Ruby VALUE values while the Kross::RubyMetaTypeFactory helper class is used as factory within [http://websvn.kde.org/trunk/KDE/kdebindings/ruby/krossruby/rubyextension.h?view=markup Kross::RubyExtension] to translate an argument into a Kross::MetaType needed for QGenericArgument's data pointer.

===JavaScript===

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/kjs KDE JavaScript plugin] uses the in kdelibs4 included Kjs and KjsEmbed4 frameworks to provide access to the JavaScript language.

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/test/unittest.js?view=markup unittest.js] KDE-JavaScript script file implements unittests for common functionality. For the unittests kross does use a special test-application that got compiled if cmake -DKDE4_BUILD_TESTS=1 was used for kdelibs. You are able to run the unittest with
<pre>
cd kdelibs/kross/test
./krosstest unittest.js
</pre>

For details about KDE-JavaScript see...
* [http://websvn.kde.org/trunk/KDE/kdelibs/kjs/README?view=markup Kjs readme]
* [http://websvn.kde.org/trunk/KDE/kdelibs/kjs/ Kjs svn]
* [http://xmelegance.org/kjsembed KjsEmbed home]
* [https://mail.kde.org/mailman/listinfo/kjsembed KjsEmbed mailinglist]
* [http://websvn.kde.org/trunk/KDE/kdelibs/kjsembed/ KjsEmbed svn]

===Java===

The [[Projects/Summer_of_Code/2007/Projects/KrossJava|Google Summer of Code 2007]] did provide us the [http://websvn.kde.org/trunk/KDE/kdebindings/java/krossjava/ krossjava] backend for Java :-)

===Falcon===

The [http://websvn.kde.org/trunk/playground/bindings/krossfalcon/ krossfalcon] plugin does implement access to [http://www.falconpl.org The Falcon Programming Language].

==The Module plugins==

Modules are plugins loaded on demand at runtime to provide additional functionality. They only provide a factory to create and return a QObject instance that is then exposed to the scripting backend.

Since Qt's introspection functionality is used, we are able to throw in just {{qt|QObject}}'s and have them act as classes/objects within a scripting backend. Slots are membermethods while properties and enumerations are membervariables. If your application also likes to offer [http://hal.freedesktop.org/wiki/Software/dbus D-Bus] support it may be an idea to reuse the {{qt|QDBusAbstractAdaptor}} implementations your application has also for scripting, like for example [[Development/Tutorials/KSpread_Scripting|KSpread]] did.

Let's take a look at the following code that implements the MyObject class which inherits from QObject;
<code cppqt>
class MyObject : public QObject {
Q_OBJECT
Q_PROPERTY(QString name READ name WRITE setName)
public:
MyObject(QObject* parent = 0) : QObject(parent) {}
virtual ~MyObject() {}
QString name() const { return objectName(); }
void setName(const QString& name) {
return setObjectName(name);
}
public slots:
QObject* create(const QString& name,
QObject* parent=0) {
MyObject* obj = new MyObject(parent);
obj->setObjectName(name);
return obj;
}
QObject* parent() const { return QObject::parent(); }
void setParent(QObject* parent) {
QObject::setParent(parent);
emit parentChanged();
}
signals:
void parentChanged();
};

extern "C" {
KDE_EXPORT QObject* krossmodule() {
return new MyObject();
}
}
</code>
At the bottom the krossmodule() function will be called by Kross and returns an instance of MyObject that is then exposed to the scripting backend.

Then we just need to have our myobject.h and myobject.cpp files, filled with the content above, defined in the CMakeLists.txt file. The library needs to be named "krossmodule..." where the "..." is then the name the module is accessible as. For our example we use "krossmodulemyobjectmod" and therefore we are able to access the module if installed as "myobjectmod". The example does not depend on Kross, so you may like to replace ${KROSS_INCLUDES} with whatever else your module depends on.
<pre>
include_directories(${CMAKE_SOURCE_DIR}
${KROSS_INCLUDES})
set(krossmodulemyobjectmod_PART_SRCS
myobject.cpp)
kde4_add_plugin(krossmodulemyobjectmod
${krossmodulemyobjectmod_PART_SRCS})
target_link_libraries(krossmodulemyobjectmod
${KDE4_KDECORE_LIBS} ${KDE4_KROSSCORE_LIBS})
install(TARGETS krossmodulemyobjectmod
DESTINATION ${PLUGIN_INSTALL_DIR})
</pre>

The following Python sample code accesses then the module at runtime and uses the QObject, calls it's slots and properties and connects a signal with a python function (e.g. save as file named "myobjecttest.py" and execute with "kross ./myobjecttest.py");

<code python>
#!/usr/bin/env kross
import Kross
m = Kross.module("myobjectmod")
m.name = "MyObjectModuleName"
obj1 = m.create("OtherObjectName")
def myCallbackFunc(args):
print "The parent of obj1 changed"
obj1.connect("parentChanged()",myCallbackFunc)
obj1.setParent(m)
print "%s %s" % (obj1.name,obj1.parent().name)
</code>

==Manager, GuiClient, Action==

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/manager.h?view=markup Kross::Manager] class is a singleton that provides access to the interpreters, to actions and to the modules. The Kross::Manager is available within scripting code as module named "Kross". Following Python script uses the Kross module to create a new Kross::Action instance, fills it with JavaScript code and executes that JavaScript code.

<code python>
#!/usr/bin/env kross
import Kross
a = Kross.action("MyKjsScript")
a.setInterpreter("javascript")
a.setCode("println(\"Hello world from Kjs\");")
a.trigger()
</code>

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/guiclient.h?view=markup Kross::GuiClient] class implements KXMLGUIClient to provide GUI functionality, handling of XML configuration files on a more abstract level and offers some predefined actions that could be optionally used in your application.

The [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/action.h?view=markup Kross::Action] class offers an abstract container to deal with scripts like a single standalone scriptfile. Each action holds a reference to the by the matching [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/interpreter.h?view=markup Kross::Interpreter] instance created by [http://websvn.kde.org/trunk/KDE/kdelibs/kross/core/script.h?view=markup Kross::Script] instance. Following Python script accesses the Kross module and the self variable which is our Kross::Action instance that provides the context for the running Python script.

<code python>
#!/usr/bin/env kross
import Kross
print "objectName=%s" % Kross.objectName()
print "interpreters=%s" % Kross.interpreters()
print "objectName=%s" % self.objectName()
print "text=%s" % self.text
print "enabled=%s" % self.enabled
print "currentPath=%s" % self.currentPath()
print "interpreter=%s" % self.interpreter()
print "description=%s" % self.description()
print "code=%s" % self.code()
</code>

==D-Bus and Kross==

With the [http://doc.trolltech.com/4.2/qtdbus.html QtDBus module] Qt provides a library that a Qt/KDE application is able to use to make Inter-Process Communication using the [http://dbus.freedesktop.org D-BUS protocol].

The QtDBus module uses the Qt Signals and Slots mechanism. Applications that like to provide parts of their functionality to the D-Bus world are able to do so by implementing classes that inherit from the {{qt|QDBusAbstractAdaptor}} class.

Kross is able to reuse such by an application provided bindings. So, once your application supports D-Bus, Kross is able to reuse those already existing code and offers transparent access to the scripting-backends to them. How does this differ from e.g. the python-dbus package? Well, first method-calls don't go through the dbus-socket and then it's not dbus-related at all except, that we are able to reuse what your application offers anyway: a clean interface to the outside world. But that's not all, we are not limited to what's possible with D-Bus. We are also able to exchange instance-pointers to QObject or QWidget instances.

For an example you may like to take a look at how it was done in the KSpread [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/ScriptingModule.cpp?view=markup ScriptingModule] class.

Development/Tutorials/KWord Scripting

2009-03-07T17:23:12Z

Jstaniek: /* Intro */

==Intro==

KWord uses [[Development/Languages/Kross|Kross]] to provide scripting with [http://www.python.org/ Python], [http://www.ruby-lang.org/ Ruby] and [http://xmelegance.org/kjsembed KDE JavaScript].

===The Scripting Plugin===

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/ KWord Scripting Plugin] implements a plugin to dynamic access the scripting functionality from within KWord.

* The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/KWScriptingPart.h?view=markup KWScriptingPart] class implements a KPart component to integrate scripting as plugin into KWord.
* The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/Module.h?view=markup Scripting::Module] class enables access to the KWord functionality from within the scripting backends.
* The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/FrameSet.h?view=markup FrameSet] and [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/Frame.h?view=markup Frame] classes are holding the content that is displayed on screen.
* The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/TextDocument.h?view=markup TextDocument] class represents a QTextDocument within the Scribe text-engine KWord uses to enable editing of text content. The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/TextCursor.h?view=markup TextCursor] implements a control structure for the successive traversal of content within such a TextDocument .

===Scripting Handbook===

The [http://kross.dipe.org/dox/kword.html KWord Scripting Handbook] ([http://kross.dipe.org/dox/kword.pdf PDF]) contains a full reference of the functionality accessible from within the scripting backends.

The Handbook is generated from the sourcecode using doxygen and KWord's [[Development/Tutorials/KWord_Scripting#Import_combined_Doxygen_XML_File|Import Doxygen XML File]] python script.

==Samples==

=== Load and save documents ===

Following Python script demonstrates how to load and save files;
<code python>
import KWord
KWord.document().openURL("/home/myuser/myDoc.odt")
KWord.document().saveAs("/home/myuser/myDocCopy.odt")
KWord.document().saveAs("/home/myuser/myDocAsText.txt")
</code>

All slots and signals within the [http://websvn.kde.org/trunk/koffice/libs/kofficecore/KoDocumentAdaptor.h?view=markup KoDocumentAdaptor] are accessible as KWord.document().

=== Import and export content ===

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_importfile.py?view=markup sample_importfile.py] Python script implements import of content from a text or html file.

<code python>
import KWord
doc = KWord.mainFrameSet().document()
f = open("/home/myuser/mytextfile.txt", "r")
doc.setText( ' '.join(f.readlines()) )
#doc.setHtml( ' '.join(f.readlines()) )
f.close()
</code>

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_exportfile.py?view=markup sample_exportfile.py] Python script implements export of content to a text or html file.

<code python>
import KWord
doc = KWord.mainFrameSet().document()
f = open("/home/myuser/mytextfile.txt", "w")
f.write( doc.toText() )
#f.write( doc.toHtml() )
f.close()
</code>

=== Framesets, Frames and Shapes ===

The following python script adds a polygon shape and then prints the name and the ID of each shape.
<code python>
import KWord
KWord.addFrame("mypoly", "KoRegularPolygonShape")
for i in range( KWord.frameCount() ):
f = KWord.frame(i)
print "%s %s" % (f.frameSet().name(),f.shapeId())
</code>

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_insertshape.py?view=markup sample_insertshape.py] Python script implements inserting of a shape into the document.

<code python>
import KWord
textshape = KWord.addTextFrame("MyTextShape")
textshape.document().setText("Some text")
</code>

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_allshapes.py?view=markup sample_allshapes.py] Python script just adds all shapes into the document.

<code python>
import KWord
for shapeId in KWord.shapeKeys():
frame = KWord.addFrame("myshape", shapeId)
if frame:
frame.setTextRunAround(frame.RunThrough)
frame.setPosition(200, 50)
frame.resize(160, 80)
</code>

=== Text content ===

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_text.py?view=markup sample_text.py] Python script demonstrates usage of the text engine.

The following python sample adds some text at the end of the main framesets document.
<code python>
import KWord
doc = KWord.mainFrameSet().document()
cursor = doc.rootFrame().lastCursorPosition()
cursor.insertHtml("Some text")
</code>

This python sample adds some text and sets the page header and the page footer.
<code python>
import KWord
doc = KWord.mainFrameSet().document()
doc.lastCursor().insertHtml("Even more Hello World")
KWord.firstPageHeaderFrameSet().document().setText("Header")
KWord.firstPageFooterFrameSet().document().setText("Footer")
</code>

Python sample that prints the url and some metainformations of the document.
<code python>
import KWord
print KWord.document().url()
print KWord.document().documentInfoTitle()
print KWord.document().documentInfoAuthorName()
</code>

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_lists_html.py?view=markup sample_lists_html.py] Python script demonstrates how to create lists with HTML.

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_lists_cursor.py?view=markup sample_lists_cursor.py] Python script demonstrates how to create lists with a cursor.

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_tables.py?view=markup sample_tables.py] Python script demonstrates how to deal with tables.

=== KoStore and XML ===

The following python sample does demonstrate how to print the element-names of all xml-files that are within the KWord KoStore backend (see [http://websvn.kde.org/trunk/koffice/libs/kokross/KoScriptingOdf.h?view=markup KoScriptingOdf.h]) for our current document.

<code python>
import KWord
store = KWord.store()
reader = store.open("META-INF/manifest.xml")
if not reader:
raise "Failed to read the mainfest"
paths = []
for i in range( reader.count() ):
if reader.type(i) == "text/xml":
paths.append( reader.path(i) )
for p in paths:
reader = store.open(p)
if not reader:
raise "Failed to read %s" % p
def onElement():
print reader.name()
reader.connect("onElement()", onElement)
reader.start()
</code>

=== Variables ===

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_variables.py?view=markup sample_variables.py] Python script demonstrates how to handle variables.

<code python>
import KWord
doc = KWord.mainFrameSet().document()
for v in doc.variableNames():
print "name=%s value=%s" % (v, doc.variableValue(v))
</code>

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/variable_readfile.py?view=markup variable_readfile.py] Python script to read a variable from a file.

=== KWord ===

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_cursor.rb?view=markup sample_cursor.rb] Ruby script demonstrates how to control the cursor.

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_actions.py?view=markup sample_actions.py] Python script demonstrates usage of actions.

<code python>
import KWord
KWord.shell().slotFileNew()
KWord.mainWindow().setCaption("My Caption")
</code>

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_toolactions.py?view=markup sample_toolactions.py] Python script demonstrates how to trigger actions the current tool provides.

<code python>
import KWord
tool = KWord.tool()
for n in tool.actionNames():
print "%s: %s" % (n, tool.actionText(n))
tool.triggerAction(n)
</code>

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/sample_progressbar.py?view=markup sample_progressbar.py] Python script demonstrates how to use the progressbar.

<code python>
import KWord
for i in range(1,101):
KWord.shell().slotProgress(i)
KWord.shell().slotProgress(-1)
</code>

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/onlinehelp.py?view=markup onlinehelp.py] Python script uses the KHTML Part to display the KWord Scripting online help.

<code python>
import Kross
forms = Kross.module("forms")
dialog = forms.createDialog("KHTML Part")
page = dialog.addPage("", "")
url = "http://wiki.koffice.org"
part = forms.loadPart(page, "libkhtmlpart", url)
dialog.exec_loop()
</code>

== Scripts ==

=== Import from a Text or HTML File ===

The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/importfile.py?view=markup importfile.py] allows to import content from text- or html-files.

=== Import combined Doxygen XML File ===

The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/importdoxyxml.py?view=markup importdoxyxml.py] implements import of combined doxygen XML files into KWord.

As example this got used to generate the KSpread Scripting API-Reference. This is done by running doxygen with the [http://websvn.kde.org/trunk/koffice/kspread/plugins/scripting/docs/ KSpread doxygen file].

We are able to produce from within the commandline the handbook like demonstrated bellow;
cd kspread/plugins/scripting/docs
doxygen kspreadscripting.doxyfile
cd xml
xsltproc combine.xslt index.xml | importdoxyxml.py kspread.html

You are also able to just generate a combined doxygen XML file with;
cd kspread/plugins/scripting/docs
doxygen kspreadscripting.doxyfile
cd xml
xsltproc combine.xslt index.xml > ~/mydoxygen.xml

Such a combined doxygen XML file can then be imported into our running KWord instance by running "Import Doxygen XML File" python script from the Tools/Scripts-menu.

=== Import File with OpenOffice.org UNO ===

The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/ooimport.py?view=markup ooimport.py] uses the PyUNO module to access OpenOffice.org and import content from any by OpenOffice.org supported fileformat.
For this an optional hidden OpenOffice.org instance need to be started. Then the script connects as client to this OpenOffice.org server instance and controls it. If the script got executed and the connecting to the server failed, then it will startup such a hidden OpenOffice.org server instance and shuts it down again once the work is done.

If the script got executed from within KWord (e.g. by using the "Tools=>Script Manager") the following dialog is displayed. The user chooses the file he likes to import and may also able to change settings related to how the connection to OpenOffice.org should be established. Then a progressdialog will be displayed while in the background we try to connect with OpenOffice.org and let it load the file and pass the content back to KWord.

[[Image:kwordscriptingooimport.jpg]]

That way KWord is able to optional use the OpenOffice.org import-filters to import content from file formats like;

OpenDocument Text (*.odt), OpenDocument Text Template (*.ott), OpenOffice.org 1.0 Text Document (*.sxw), OpenOffice.org 1.0 Text Document Template (*.stw), Microsoft Word 95/97/2000/XP (*.doc), Microsoft Word 95/97/2000/XP Template (*.dot), Microsoft Word 2003 XML (*.xml), Rich Text Format (*.rtf), Text (*.txt), HTML Document (*.html *.htm), DocBook (*.xml), StarWriter 1.0 - 5.0 (*.sdw), StarWriter 3.0 - 5.0 Templates (*.vor), WordPerfect Document (*.wpd), Lotus WordPro Document (*.lwp), Ichitaro 8/9/10/11 (*.jtd), Ichitaro 8/9/10/11 Template (*.jtt), Hangul WP 97 (*.hwp), WPS 2000/Office 1.0 (*.wps), etc.

=== Export to a Text or HTML File ===

The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/exportfile.py?view=markup exportfile.py] allows to export content to text- or html-files.

=== XML Viewer ===

The python script [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/xmlviewer.py?view=markup xmlviewer.py] to view the ISO OpenDocumentText XML representation of the current document displayed in KWord.

The XML Viewer does also allow to open the XML of the current document with an external application like KWrite or KXMLEditor. The "Compare..." button enables to compare the current XML with the XML of another ODT file.

[[Image:kwordxmlviewer.jpg]]

=== Document Structure Viewer ===

The [http://websvn.kde.org/trunk/koffice/kword/plugins/scripting/scripts/doctree.rb?view=markup doctree.rb] QtRuby script implement a document structur viewer.

The viewer displays the framesets, frames, documents and there objects as tree where each node may provide additional functionality like a collection of properties, text or styles.

[[Image:kwordscriptingdoctree.jpg]]

User:Jstaniek

2008-10-01T14:50:47Z

Jstaniek:

Kexi developer & maintainer, KDElibs/win32 founder

*[http://kexi-project.org/pjs.html About me]
*[http://www.kdedevelopers.org/blog/104 My blog]
*[http://www.linkedin.com/in/jstaniek LinkedIn profile]
*e-mail: staniek at kde dot org

== Interesting places in this wiki ==
*[http://techbase.kde.org/index.php?title=Special%3AAllpages&from=&namespace=10 Template list]

Talk:Projects/KDE on Windows

2008-09-24T15:19:14Z

Jstaniek: /* KOffice 2.0 Beta 1 */

==TODO==
[[User:Jstaniek|jstaniek]] 19:52, 11 January 2008 (CET):
Move these docs to the TechBase if relevant:
*http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32
*(important) http://wiki.kde.org/tiki-index.php?page=KDElibs%2Fwin32+Porting+Guidelines
*http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32+Notes
*Mention http://www.progressive-comp.com/?t=114629615300001&r=1&w=2
*Mention this history http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32+Changelog
*Update kdelibs.com pages; mark more pages as outdated
*Remove the wiki.kde.org pages afterwards leaving only link to the techbase.

== Musik/Sound Issues ==

Getting mp3-support in KDE for Windows is major PITA at the moment, so this section needs defintly improvement to be end-user ready.

The first step would be get a hold of all codecs and check which are the best and fit best in our purpose.

After we found the best solution the next step would be to integrate this into the installer. The codecs could be installed automaticly or the user could be given choice and also educate him of legal conseqences.

==Announcements==
<pre>

<item>
<title>
Release of Amarok Beta 1 Nerrivik for Windows
</title>
<date>
July 29th, 2008
</date>
<fullstory>
After joint efforts, the KDE on Windows Team is glad to announce availability of the first Beta release
of Amarok.
Note that the quality of this software differs from its Linux counterpart
and might only reach Alpha level so far. Nevertheless, users are invited to file related bug reports using the <a href="http://bugs.kde.org">KDE Bugzilla</a> web site.
The official release notes were published the Amarok Team at <a href="http://amarok.kde.org/en/releases/2.0/beta/1">amarok.kde.org</a>.
Windows binaries are available via the <a href="http://techbase.kde.org/Projects/KDE_on_Windows/Installation#KDE_Installer_for_Windows">KDE Installer</a>.
 
(<a href="mailto:ps_ml[AT]gmx[DOT]de">KDE on Windows Team</a>)
</fullstory>
</item>

</pre>

===KOffice 2.0 Beta 1===
<pre>

Announcement: Release of KOffice 2.0 Beta 1 for Windows

Along with other platforms, the KDE on Windows Team has released
the first beta version of KOffice 2.0 running on MS Windows.

As stated in the <a href="http://www.koffice.org/announcements/announce-2.0beta1.php">announcement</a>,
the goal of this release is to prepare a basically usable 2.0
version thanks to feedback from both users and developers
on the new user interface and underlying infrastructure.
Therefore, Windows users are also invited to join the community.

Note that the quality of Windows version of this software differs from its Linux counterpart.
A number of components might only reach Alpha level so far or might be currently unavailable on Windows.

The official release notes from the KOffice Team are published
at <a href="http://www.koffice.org/releases/2.0beta1-release.php">www.koffice.org</a>.
Windows executables for the new KOffice are available directly via the
<a href="http://techbase.kde.org/Projects/KDE_on_Windows/Installation#KDE_Installer_for_Windows">KDE Installer</a>.

 
(<a href="mailto:kde-windows[AT]kde[DOT]org">KDE on Windows Team</a>)

</pre>

Talk:Projects/KDE on Windows

2008-09-24T08:15:31Z

Jstaniek: /* KOffice 2.0 Beta 1 */

==TODO==
[[User:Jstaniek|jstaniek]] 19:52, 11 January 2008 (CET):
Move these docs to the TechBase if relevant:
*http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32
*(important) http://wiki.kde.org/tiki-index.php?page=KDElibs%2Fwin32+Porting+Guidelines
*http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32+Notes
*Mention http://www.progressive-comp.com/?t=114629615300001&r=1&w=2
*Mention this history http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32+Changelog
*Update kdelibs.com pages; mark more pages as outdated
*Remove the wiki.kde.org pages afterwards leaving only link to the techbase.

== Musik/Sound Issues ==

Getting mp3-support in KDE for Windows is major PITA at the moment, so this section needs defintly improvement to be end-user ready.

The first step would be get a hold of all codecs and check which are the best and fit best in our purpose.

After we found the best solution the next step would be to integrate this into the installer. The codecs could be installed automaticly or the user could be given choice and also educate him of legal conseqences.

==Announcements==
<pre>

<item>
<title>
Release of Amarok Beta 1 Nerrivik for Windows
</title>
<date>
July 29th, 2008
</date>
<fullstory>
After joint efforts, the KDE on Windows Team is glad to announce availability of the first Beta release
of Amarok.
Note that the quality of this software differs from its Linux counterpart
and might only reach Alpha level so far. Nevertheless, users are invited to file related bug reports using the <a href="http://bugs.kde.org">KDE Bugzilla</a> web site.
The official release notes were published the Amarok Team at <a href="http://amarok.kde.org/en/releases/2.0/beta/1">amarok.kde.org</a>.
Windows binaries are available via the <a href="http://techbase.kde.org/Projects/KDE_on_Windows/Installation#KDE_Installer_for_Windows">KDE Installer</a>.
 
(<a href="mailto:ps_ml[AT]gmx[DOT]de">KDE on Windows Team</a>)
</fullstory>
</item>

</pre>

===KOffice 2.0 Beta 1===
<pre>

Announcement: Release of KOffice 2.0 Beta 1 for Windows

Along with other platforms, the KDE on Windows Team has released
the first beta version of KOffice 2.0 running on MS Windows.

As stated in the <a href="http://www.koffice.org/announcements/announce-2.0beta1.php">announcement</a>,
the goal of this release is to prepare a basically usable 2.0
version thanks to feedback from both users and developers
on the new user interface and underlying infrastructure.
Therefore, Windows users are also invited to join the community.

The official release notes from the KOffice Team are published
at <a href="http://www.koffice.org/releases/2.0beta1-release.php">www.koffice.org</a>.
Windows executables for the new KOffice are available directly via the
<a href="http://techbase.kde.org/Projects/KDE_on_Windows/Installation#KDE_Installer_for_Windows">KDE Installer</a>.

 
(<a href="mailto:kde-windows[AT]kde[DOT]org">KDE on Windows Team</a>)

</pre>

Talk:Projects/KDE on Windows

2008-09-24T08:15:18Z

Jstaniek: /* KOffice 2.0 Beta 1 */

==TODO==
[[User:Jstaniek|jstaniek]] 19:52, 11 January 2008 (CET):
Move these docs to the TechBase if relevant:
*http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32
*(important) http://wiki.kde.org/tiki-index.php?page=KDElibs%2Fwin32+Porting+Guidelines
*http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32+Notes
*Mention http://www.progressive-comp.com/?t=114629615300001&r=1&w=2
*Mention this history http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32+Changelog
*Update kdelibs.com pages; mark more pages as outdated
*Remove the wiki.kde.org pages afterwards leaving only link to the techbase.

== Musik/Sound Issues ==

Getting mp3-support in KDE for Windows is major PITA at the moment, so this section needs defintly improvement to be end-user ready.

The first step would be get a hold of all codecs and check which are the best and fit best in our purpose.

After we found the best solution the next step would be to integrate this into the installer. The codecs could be installed automaticly or the user could be given choice and also educate him of legal conseqences.

==Announcements==
<pre>

<item>
<title>
Release of Amarok Beta 1 Nerrivik for Windows
</title>
<date>
July 29th, 2008
</date>
<fullstory>
After joint efforts, the KDE on Windows Team is glad to announce availability of the first Beta release
of Amarok.
Note that the quality of this software differs from its Linux counterpart
and might only reach Alpha level so far. Nevertheless, users are invited to file related bug reports using the <a href="http://bugs.kde.org">KDE Bugzilla</a> web site.
The official release notes were published the Amarok Team at <a href="http://amarok.kde.org/en/releases/2.0/beta/1">amarok.kde.org</a>.
Windows binaries are available via the <a href="http://techbase.kde.org/Projects/KDE_on_Windows/Installation#KDE_Installer_for_Windows">KDE Installer</a>.
 
(<a href="mailto:ps_ml[AT]gmx[DOT]de">KDE on Windows Team</a>)
</fullstory>
</item>

</pre>

===KOffice 2.0 Beta 1===
<pre>

Announcement: Release of KOffice 2.0 Beta 1 for Windows

Along with other platforms, the KDE on Windows Team has released
the first beta version of KOffice 2.0 running on MS Windows.

As stated in the <a href="http://www.koffice.org/announcements/announce-2.0beta1.php">announcement</a>,
the goal of this release is to prepare a basically usable 2.0
version thanks to feedback from both users and developers
on the new user interface and underlying infrastructure.
Therefore, Windows users are also invited to join the community.

The official release notes from the KOffice Team are published
at <a href="http://www.koffice.org/releases/2.0beta1-release.php">www.koffice.org</a>.
Windows executables for the new KOffice are available directly via the <a href="http://techbase.kde.org/Projects/KDE_on_Windows/Installation#KDE_Installer_for_Windows">KDE Installer</a>.

 
(<a href="mailto:kde-windows[AT]kde[DOT]org">KDE on Windows Team</a>)

</pre>

Talk:Projects/KDE on Windows

2008-09-24T08:14:34Z

Jstaniek: /* Announcements */

==TODO==
[[User:Jstaniek|jstaniek]] 19:52, 11 January 2008 (CET):
Move these docs to the TechBase if relevant:
*http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32
*(important) http://wiki.kde.org/tiki-index.php?page=KDElibs%2Fwin32+Porting+Guidelines
*http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32+Notes
*Mention http://www.progressive-comp.com/?t=114629615300001&r=1&w=2
*Mention this history http://wiki.kde.org/tiki-index.php?page=KDElibs+for+win32+Changelog
*Update kdelibs.com pages; mark more pages as outdated
*Remove the wiki.kde.org pages afterwards leaving only link to the techbase.

== Musik/Sound Issues ==

Getting mp3-support in KDE for Windows is major PITA at the moment, so this section needs defintly improvement to be end-user ready.

The first step would be get a hold of all codecs and check which are the best and fit best in our purpose.

After we found the best solution the next step would be to integrate this into the installer. The codecs could be installed automaticly or the user could be given choice and also educate him of legal conseqences.

==Announcements==
<pre>

<item>
<title>
Release of Amarok Beta 1 Nerrivik for Windows
</title>
<date>
July 29th, 2008
</date>
<fullstory>
After joint efforts, the KDE on Windows Team is glad to announce availability of the first Beta release
of Amarok.
Note that the quality of this software differs from its Linux counterpart
and might only reach Alpha level so far. Nevertheless, users are invited to file related bug reports using the <a href="http://bugs.kde.org">KDE Bugzilla</a> web site.
The official release notes were published the Amarok Team at <a href="http://amarok.kde.org/en/releases/2.0/beta/1">amarok.kde.org</a>.
Windows binaries are available via the <a href="http://techbase.kde.org/Projects/KDE_on_Windows/Installation#KDE_Installer_for_Windows">KDE Installer</a>.
 
(<a href="mailto:ps_ml[AT]gmx[DOT]de">KDE on Windows Team</a>)
</fullstory>
</item>

</pre>

===KOffice 2.0 Beta 1===
<pre>

Announcement: Release of KOffice 2.0 Beta 1 for Windows

Along with other platforms, the KDE on Windows Team has released the first beta version of KOffice 2.0 running on MS Windows.

As stated in the <a href="http://www.koffice.org/announcements/announce-2.0beta1.php">announcement</a>, the goal of this release is to prepare a basically usable 2.0 version thanks to feedback from both users and developers on the new user interface and underlying infrastructure. Therefore, Windows users are also invited to join the community.

The official release notes from the KOffice Team are published at <a href="http://www.koffice.org/releases/2.0beta1-release.php">www.koffice.org</a>. Windows executables for the new KOffice are available directly via the <a href="http://techbase.kde.org/Projects/KDE_on_Windows/Installation#KDE_Installer_for_Windows">KDE Installer</a>.

 
(<a href="mailto:kde-windows[AT]kde[DOT]org">KDE on Windows Team</a>)

</pre>

Windows

2008-09-24T08:13:40Z

Jstaniek: Redirecting to Projects/KDE on Windows

#REDIRECT [[Projects/KDE_on_Windows]]

User:Jstaniek

2008-09-12T18:23:10Z

Jstaniek:

Kexi developer & maintainer, KDElibs/win32 founder

* [http://kexi-project.org/pjs.html About me]
* [http://www.kdedevelopers.org/blog/104 My blog]
* e-mail: staniek at kde dot org

== Interesting places in this wiki ==
*[http://techbase.kde.org/index.php?title=Special%3AAllpages&from=&namespace=10 Template list]

Projects/KDE on Windows/Tools

2008-09-07T22:12:01Z

Jstaniek: /* More System Diagnostics Tools */

Required or recommended tools for development and using KDE libraries and applications under MS Windows.

__TOC__

== Process Explorer ==
''"Ever wondered which program has a particular file or directory open? Now you can find out. Process Explorer shows you information about which handles and DLLs processes have opened or loaded."'' (freeware, for all Windows versions) [http://technet.microsoft.com/en-us/sysinternals/bb896653.aspx more]
[[Image:ProcessExplorer.jpg|thumb|center|Process Explorer]]

== Console 2 ==
''"Console is a Windows console window (cmd.exe) enhancement, useful for using when you depend on this shell, e.g. with msvc. Console features include: multiple tabs, text editor-like text selection, different background types, alpha and color-key transparency, configurable font, different window styles."'' (GPL, for Windows 2000 or newer) [http://sourceforge.net/projects/console more]
[[Image:ConsoleWindowsTool.png|thumb|center|Console window]]

== Debugging Tools for Windows ==
You can use programs from ''Debugging Tools for Windows'' package to debug drivers, applications, and services on systems with Windows NT kernel. (freeware) [http://www.microsoft.com/whdc/devtools/debugging/default.mspx more]

Among [http://msdn2.microsoft.com/en-us/library/cc267862.aspx others], ''Debugging Tools for Windows'' do contain:

=== WinDbg ===
WinDbg (windbg.exe), a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps (postmortem debugging).

Form [http://www.microsoft.com/whdc/devtools/debugging/debugstart.mspx]: ''"WinDbg provides source-level debugging through a graphical user interface and a text-based interface. WinDbg uses the Microsoft Visual Studio debug symbol formats for source-level debugging. It can access any public function's names and variables exposed by modules that were compiled with Codeview (.pdb) symbol files.
WinDbg can view source code, set breakpoints, view variables (including C++ objects), stack traces, and memory. It includes a command window to issue a wide variety of commands not available through the drop-down menus. [..] It also allows you to remotely debug user-mode code."'',

To change the postmortem debugger to WinDbg, run windbg -I. (The I must be capitalized.)

Resources related to WinDbg:
* [http://msdn2.microsoft.com/en-us/library/cc266343.aspx Enabling Postmortem Debugging]
* [http://software.rkuster.com/windbg/WinDBG_A_to_Z.pdf WinDbg. From A to Z!   ] - Theory and examples (56 pages, 580 Kb)
* [http://software.rkuster.com/windbg/printcmd.htm Common WinDbg Commands (Thematically Grouped)]
* [http://www.networkworld.com/news/2005/041105-windows-crash.html Tutorial on solving system crashes using WinDbg]

=== Documentation ===
*"Debugging Tools for Windows" documentation (debugger.chm) (see [http://msdn2.microsoft.com/en-us/library/cc267445.aspx online version]),

=== CDB ===
*CDB (cdb.exe), a user-mode debugger with a console interface,

=== Logger ===
Logger (logger.exe and logexts.dll), a tool and a plugin DLL that record the function calls and other actions of a program,

=== LogViewer ===
LogViewer (logviewer.exe), a tool that displays the logs created by Logger,

=== GFlags ===
*GFlags (Global Flags Editor, gflags.exe), a tool used to control registry keys and other settings

=== The Breakin tool ===
*The Breakin tool (breakin.exe), a tool used to cause a user-mode break to occur in a process,

=== The Kill tool ===
*The Kill tool (kill.exe), a tool used to terminate a process,

=== UMDH ===
*UMDH (User-Mode Dump Heap utility, umdh.exe), a tool used to analyze heap allocations

== DebugView ==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool. The tool offers searching in logs, filtering them using wildcards and saving them to file. (freeware) [http://www.microsoft.com/technet/sysinternals/utilities/debugview.mspx more]
[[Image:DebugViewWindows.png|thumb|center|DebugView window]]

== Dependency Walker ==
A tool for checking dependency of shared libraries. This utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. (freeware) [http://www.dependencywalker.com/ more]
[[Image:DependencyWalkerWindows.png|thumb|center|Dependency Walker window]]

== Process Monitor ==
Process Monitor is an advanced monitoring tool for Windows that shows real-time file system, Registry and process/thread activity. Use it to discover what process is using given files (very useful knowledge since Windows can block these files). [http://technet.microsoft.com/de-de/sysinternals/bb896645(en-us).aspx more]

=== Handle ===
Command line program used to find out which program has a particular file or directory open. Handle is a utility that displays information about open handles for any process in the system. [http://technet.microsoft.com/en-us/sysinternals/bb896655.aspx more]

== AutoRuns ==
AutoRuns provides very comprehensive knowledge of auto-starting locations, shows what programs are configured to run during system bootup or login, and shows the entries in the order Windows processes them. These programs include ones in your startup folder, Run, RunOnce, and other Registry keys. [http://technet.microsoft.com/en-us/sysinternals/bb963902.aspx more]

== More System Diagnostics Tools ==
*[http://technet.microsoft.com/en-us/sysinternals/default.aspx Windows Sysinternals: File and Disk Utilities, Networking Utilities, Process Utilities, Security Utilities, System Information, Miscellaneous Utilities]
*[http://msdn2.microsoft.com/en-us/library/aa139733.aspx Debugging and Error Handling, Performance Monitoring, Performance Tools Kit, Error Reporting, Windows Events]

Projects/KDE on Windows/Tools

2008-09-07T22:11:19Z

Jstaniek: /* More Diagnostics Tools */

Required or recommended tools for development and using KDE libraries and applications under MS Windows.

__TOC__

== Process Explorer ==
''"Ever wondered which program has a particular file or directory open? Now you can find out. Process Explorer shows you information about which handles and DLLs processes have opened or loaded."'' (freeware, for all Windows versions) [http://technet.microsoft.com/en-us/sysinternals/bb896653.aspx more]
[[Image:ProcessExplorer.jpg|thumb|center|Process Explorer]]

== Console 2 ==
''"Console is a Windows console window (cmd.exe) enhancement, useful for using when you depend on this shell, e.g. with msvc. Console features include: multiple tabs, text editor-like text selection, different background types, alpha and color-key transparency, configurable font, different window styles."'' (GPL, for Windows 2000 or newer) [http://sourceforge.net/projects/console more]
[[Image:ConsoleWindowsTool.png|thumb|center|Console window]]

== Debugging Tools for Windows ==
You can use programs from ''Debugging Tools for Windows'' package to debug drivers, applications, and services on systems with Windows NT kernel. (freeware) [http://www.microsoft.com/whdc/devtools/debugging/default.mspx more]

Among [http://msdn2.microsoft.com/en-us/library/cc267862.aspx others], ''Debugging Tools for Windows'' do contain:

=== WinDbg ===
WinDbg (windbg.exe), a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps (postmortem debugging).

Form [http://www.microsoft.com/whdc/devtools/debugging/debugstart.mspx]: ''"WinDbg provides source-level debugging through a graphical user interface and a text-based interface. WinDbg uses the Microsoft Visual Studio debug symbol formats for source-level debugging. It can access any public function's names and variables exposed by modules that were compiled with Codeview (.pdb) symbol files.
WinDbg can view source code, set breakpoints, view variables (including C++ objects), stack traces, and memory. It includes a command window to issue a wide variety of commands not available through the drop-down menus. [..] It also allows you to remotely debug user-mode code."'',

To change the postmortem debugger to WinDbg, run windbg -I. (The I must be capitalized.)

Resources related to WinDbg:
* [http://msdn2.microsoft.com/en-us/library/cc266343.aspx Enabling Postmortem Debugging]
* [http://software.rkuster.com/windbg/WinDBG_A_to_Z.pdf WinDbg. From A to Z!   ] - Theory and examples (56 pages, 580 Kb)
* [http://software.rkuster.com/windbg/printcmd.htm Common WinDbg Commands (Thematically Grouped)]
* [http://www.networkworld.com/news/2005/041105-windows-crash.html Tutorial on solving system crashes using WinDbg]

=== Documentation ===
*"Debugging Tools for Windows" documentation (debugger.chm) (see [http://msdn2.microsoft.com/en-us/library/cc267445.aspx online version]),

=== CDB ===
*CDB (cdb.exe), a user-mode debugger with a console interface,

=== Logger ===
Logger (logger.exe and logexts.dll), a tool and a plugin DLL that record the function calls and other actions of a program,

=== LogViewer ===
LogViewer (logviewer.exe), a tool that displays the logs created by Logger,

=== GFlags ===
*GFlags (Global Flags Editor, gflags.exe), a tool used to control registry keys and other settings

=== The Breakin tool ===
*The Breakin tool (breakin.exe), a tool used to cause a user-mode break to occur in a process,

=== The Kill tool ===
*The Kill tool (kill.exe), a tool used to terminate a process,

=== UMDH ===
*UMDH (User-Mode Dump Heap utility, umdh.exe), a tool used to analyze heap allocations

== DebugView ==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool. The tool offers searching in logs, filtering them using wildcards and saving them to file. (freeware) [http://www.microsoft.com/technet/sysinternals/utilities/debugview.mspx more]
[[Image:DebugViewWindows.png|thumb|center|DebugView window]]

== Dependency Walker ==
A tool for checking dependency of shared libraries. This utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. (freeware) [http://www.dependencywalker.com/ more]
[[Image:DependencyWalkerWindows.png|thumb|center|Dependency Walker window]]

== Process Monitor ==
Process Monitor is an advanced monitoring tool for Windows that shows real-time file system, Registry and process/thread activity. Use it to discover what process is using given files (very useful knowledge since Windows can block these files). [http://technet.microsoft.com/de-de/sysinternals/bb896645(en-us).aspx more]

=== Handle ===
Command line program used to find out which program has a particular file or directory open. Handle is a utility that displays information about open handles for any process in the system. [http://technet.microsoft.com/en-us/sysinternals/bb896655.aspx more]

== AutoRuns ==
AutoRuns provides very comprehensive knowledge of auto-starting locations, shows what programs are configured to run during system bootup or login, and shows the entries in the order Windows processes them. These programs include ones in your startup folder, Run, RunOnce, and other Registry keys. [http://technet.microsoft.com/en-us/sysinternals/bb963902.aspx more]

== More System Diagnostics Tools ==
*[http://technet.microsoft.com/en-us/sysinternals/default.aspx File and Disk Utilities, Networking Utilities, Process Utilities, Security Utilities, System Information, Miscellaneous Utilities]
*[http://msdn2.microsoft.com/en-us/library/aa139733.aspx Debugging and Error Handling, Performance Monitoring, Performance Tools Kit, Error Reporting, Windows Events]

Projects/KDE on Windows/Tools

2008-09-07T22:08:23Z

Jstaniek: /* Process Monitor */

Required or recommended tools for development and using KDE libraries and applications under MS Windows.

__TOC__

== Process Explorer ==
''"Ever wondered which program has a particular file or directory open? Now you can find out. Process Explorer shows you information about which handles and DLLs processes have opened or loaded."'' (freeware, for all Windows versions) [http://technet.microsoft.com/en-us/sysinternals/bb896653.aspx more]
[[Image:ProcessExplorer.jpg|thumb|center|Process Explorer]]

== Console 2 ==
''"Console is a Windows console window (cmd.exe) enhancement, useful for using when you depend on this shell, e.g. with msvc. Console features include: multiple tabs, text editor-like text selection, different background types, alpha and color-key transparency, configurable font, different window styles."'' (GPL, for Windows 2000 or newer) [http://sourceforge.net/projects/console more]
[[Image:ConsoleWindowsTool.png|thumb|center|Console window]]

== Debugging Tools for Windows ==
You can use programs from ''Debugging Tools for Windows'' package to debug drivers, applications, and services on systems with Windows NT kernel. (freeware) [http://www.microsoft.com/whdc/devtools/debugging/default.mspx more]

Among [http://msdn2.microsoft.com/en-us/library/cc267862.aspx others], ''Debugging Tools for Windows'' do contain:

=== WinDbg ===
WinDbg (windbg.exe), a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps (postmortem debugging).

Form [http://www.microsoft.com/whdc/devtools/debugging/debugstart.mspx]: ''"WinDbg provides source-level debugging through a graphical user interface and a text-based interface. WinDbg uses the Microsoft Visual Studio debug symbol formats for source-level debugging. It can access any public function's names and variables exposed by modules that were compiled with Codeview (.pdb) symbol files.
WinDbg can view source code, set breakpoints, view variables (including C++ objects), stack traces, and memory. It includes a command window to issue a wide variety of commands not available through the drop-down menus. [..] It also allows you to remotely debug user-mode code."'',

To change the postmortem debugger to WinDbg, run windbg -I. (The I must be capitalized.)

Resources related to WinDbg:
* [http://msdn2.microsoft.com/en-us/library/cc266343.aspx Enabling Postmortem Debugging]
* [http://software.rkuster.com/windbg/WinDBG_A_to_Z.pdf WinDbg. From A to Z!   ] - Theory and examples (56 pages, 580 Kb)
* [http://software.rkuster.com/windbg/printcmd.htm Common WinDbg Commands (Thematically Grouped)]
* [http://www.networkworld.com/news/2005/041105-windows-crash.html Tutorial on solving system crashes using WinDbg]

=== Documentation ===
*"Debugging Tools for Windows" documentation (debugger.chm) (see [http://msdn2.microsoft.com/en-us/library/cc267445.aspx online version]),

=== CDB ===
*CDB (cdb.exe), a user-mode debugger with a console interface,

=== Logger ===
Logger (logger.exe and logexts.dll), a tool and a plugin DLL that record the function calls and other actions of a program,

=== LogViewer ===
LogViewer (logviewer.exe), a tool that displays the logs created by Logger,

=== GFlags ===
*GFlags (Global Flags Editor, gflags.exe), a tool used to control registry keys and other settings

=== The Breakin tool ===
*The Breakin tool (breakin.exe), a tool used to cause a user-mode break to occur in a process,

=== The Kill tool ===
*The Kill tool (kill.exe), a tool used to terminate a process,

=== UMDH ===
*UMDH (User-Mode Dump Heap utility, umdh.exe), a tool used to analyze heap allocations

== DebugView ==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool. The tool offers searching in logs, filtering them using wildcards and saving them to file. (freeware) [http://www.microsoft.com/technet/sysinternals/utilities/debugview.mspx more]
[[Image:DebugViewWindows.png|thumb|center|DebugView window]]

== Dependency Walker ==
A tool for checking dependency of shared libraries. This utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. (freeware) [http://www.dependencywalker.com/ more]
[[Image:DependencyWalkerWindows.png|thumb|center|Dependency Walker window]]

== Process Monitor ==
Process Monitor is an advanced monitoring tool for Windows that shows real-time file system, Registry and process/thread activity. Use it to discover what process is using given files (very useful knowledge since Windows can block these files). [http://technet.microsoft.com/de-de/sysinternals/bb896645(en-us).aspx more]

=== Handle ===
Command line program used to find out which program has a particular file or directory open. Handle is a utility that displays information about open handles for any process in the system. [http://technet.microsoft.com/en-us/sysinternals/bb896655.aspx more]

== AutoRuns ==
AutoRuns provides very comprehensive knowledge of auto-starting locations, shows what programs are configured to run during system bootup or login, and shows the entries in the order Windows processes them. These programs include ones in your startup folder, Run, RunOnce, and other Registry keys. [http://technet.microsoft.com/en-us/sysinternals/bb963902.aspx more]

== More Diagnostics Tools ==
[http://msdn2.microsoft.com/en-us/library/aa139733.aspx Debugging and Error Handling, Performance Monitoring, Performance Tools Kit, Error Reporting, Windows Events] (MSDN).

Projects/KDE on Windows/Tools

2008-09-07T22:02:32Z

Jstaniek: autoruns

Required or recommended tools for development and using KDE libraries and applications under MS Windows.

__TOC__

== Process Explorer ==
''"Ever wondered which program has a particular file or directory open? Now you can find out. Process Explorer shows you information about which handles and DLLs processes have opened or loaded."'' (freeware, for all Windows versions) [http://technet.microsoft.com/en-us/sysinternals/bb896653.aspx more]
[[Image:ProcessExplorer.jpg|thumb|center|Process Explorer]]

== Console 2 ==
''"Console is a Windows console window (cmd.exe) enhancement, useful for using when you depend on this shell, e.g. with msvc. Console features include: multiple tabs, text editor-like text selection, different background types, alpha and color-key transparency, configurable font, different window styles."'' (GPL, for Windows 2000 or newer) [http://sourceforge.net/projects/console more]
[[Image:ConsoleWindowsTool.png|thumb|center|Console window]]

== Debugging Tools for Windows ==
You can use programs from ''Debugging Tools for Windows'' package to debug drivers, applications, and services on systems with Windows NT kernel. (freeware) [http://www.microsoft.com/whdc/devtools/debugging/default.mspx more]

Among [http://msdn2.microsoft.com/en-us/library/cc267862.aspx others], ''Debugging Tools for Windows'' do contain:

=== WinDbg ===
WinDbg (windbg.exe), a user-mode and kernel-mode debugger with a graphical interface. It can also be used to debug user-mode crash dumps (postmortem debugging).

Form [http://www.microsoft.com/whdc/devtools/debugging/debugstart.mspx]: ''"WinDbg provides source-level debugging through a graphical user interface and a text-based interface. WinDbg uses the Microsoft Visual Studio debug symbol formats for source-level debugging. It can access any public function's names and variables exposed by modules that were compiled with Codeview (.pdb) symbol files.
WinDbg can view source code, set breakpoints, view variables (including C++ objects), stack traces, and memory. It includes a command window to issue a wide variety of commands not available through the drop-down menus. [..] It also allows you to remotely debug user-mode code."'',

To change the postmortem debugger to WinDbg, run windbg -I. (The I must be capitalized.)

Resources related to WinDbg:
* [http://msdn2.microsoft.com/en-us/library/cc266343.aspx Enabling Postmortem Debugging]
* [http://software.rkuster.com/windbg/WinDBG_A_to_Z.pdf WinDbg. From A to Z!   ] - Theory and examples (56 pages, 580 Kb)
* [http://software.rkuster.com/windbg/printcmd.htm Common WinDbg Commands (Thematically Grouped)]
* [http://www.networkworld.com/news/2005/041105-windows-crash.html Tutorial on solving system crashes using WinDbg]

=== Documentation ===
*"Debugging Tools for Windows" documentation (debugger.chm) (see [http://msdn2.microsoft.com/en-us/library/cc267445.aspx online version]),

=== CDB ===
*CDB (cdb.exe), a user-mode debugger with a console interface,

=== Logger ===
Logger (logger.exe and logexts.dll), a tool and a plugin DLL that record the function calls and other actions of a program,

=== LogViewer ===
LogViewer (logviewer.exe), a tool that displays the logs created by Logger,

=== GFlags ===
*GFlags (Global Flags Editor, gflags.exe), a tool used to control registry keys and other settings

=== The Breakin tool ===
*The Breakin tool (breakin.exe), a tool used to cause a user-mode break to occur in a process,

=== The Kill tool ===
*The Kill tool (kill.exe), a tool used to terminate a process,

=== UMDH ===
*UMDH (User-Mode Dump Heap utility, umdh.exe), a tool used to analyze heap allocations

== DebugView ==
Debug messages (logs) generated by kDebug() and kWarning() are not visible on MS Windows unless application is compiled in so-called CONSOLE subsystem. To show these messages also in WINDOWS subsystem, you can use DebugView tool. The tool offers searching in logs, filtering them using wildcards and saving them to file. (freeware) [http://www.microsoft.com/technet/sysinternals/utilities/debugview.mspx more]
[[Image:DebugViewWindows.png|thumb|center|DebugView window]]

== Dependency Walker ==
A tool for checking dependency of shared libraries. This utility that scans any 32-bit or 64-bit Windows module (exe, dll, ocx, sys, etc.) and builds a hierarchical tree diagram of all dependent modules. (freeware) [http://www.dependencywalker.com/ more]
[[Image:DependencyWalkerWindows.png|thumb|center|Dependency Walker window]]

== Process Monitor ==
Process Monitor is an advanced monitoring tool for Windows that shows real-time file system, Registry and process/thread activity.
[http://technet.microsoft.com/de-de/sysinternals/bb896645(en-us).aspx more]

== AutoRuns ==
AutoRuns provides very comprehensive knowledge of auto-starting locations, shows what programs are configured to run during system bootup or login, and shows the entries in the order Windows processes them. These programs include ones in your startup folder, Run, RunOnce, and other Registry keys. [http://technet.microsoft.com/en-us/sysinternals/bb963902.aspx more]

== More Diagnostics Tools ==
[http://msdn2.microsoft.com/en-us/library/aa139733.aspx Debugging and Error Handling, Performance Monitoring, Performance Tools Kit, Error Reporting, Windows Events] (MSDN).

Talk:Projects/KDE on Windows

2008-08-22T12:52:32Z

Jstaniek:

Talk:Projects/KDE on Windows

2008-08-22T12:52:07Z

Jstaniek:

Talk:Projects/KDE on Windows

2008-08-22T12:50:31Z

Jstaniek: /* Announcements */

2008-07-01T13:22:52Z

Jstaniek: /* The Checklist */

This page covers topics related to the MS Windows port of the KDE PIM suite.

{{Note|This page is work in progress started by [[User:Jstaniek|jstaniek]].}}

==Building==
Build base KDE libraries for Windows with required dependencies, preferable using ''emerge'' tool (because it tracks dependencies for you):
#install ''emerge'' and its dependencies as described [[Getting_Started/Build/KDE4/Windows/emerge|here]]
#either [[#Build_SASL_by_hand|build SASL by hand]] or [[#Download_SASL_for_mingw_and_msvc|download precompiled version for mingw and msvc]], and install it (if you skip this step you will not have SSL/TLS support in your apps)
#unpack gpgme-1.1.4-3-lib.zip and gpgme-1.1.4-3-bin.zip from http://www.winkde.org/pub/kde/ports/win32/repository/win32libs/ to your KDEDIR
#from the cmd.exe command line, enter <pre>emerge kdepimlibs</pre> - that will also build ''qt'', ''kdesupport'' (part of it), ''soprano'', ''strigi'', ''kdelibs'', ''kdebase''
#enter <pre>emerge libassuan</pre> - this is an optional dependency of ''kdepim''
#finally, enter <pre>emerge kdepim</pre>

Notes:
*Temporary fix for [http://bugs.kde.org/show_bug.cgi?id=160881 Bug 160881: PGP encryption of mails results in empty MIME-part] in kdepim can be enabled if you add -DKLEO_SYNCHRONOUS_API_HOTFIX:BOOL=ON to your cmake call.

== Problem points ==
=== The Checklist ===
{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Feature !! Description !! Contact
{{FeatureDone|[[#Maildir_implementation_in_KMail|Maildir implementation]]|make maildir standard work with Windows filesystems |jstaniek}}
{{FeatureDone|[[#Folder_Indices|Folder Indices]]|so called "mmap mode"|jstaniek}}
{{FeatureDone|[[#SASL support|SASL support]]|security|KDE PIM Team}}
{{FeatureInProgress|[[#Registry_settings_for_default_apps_and_services|Registry settings for default apps and services]]|Integration: Setting KMail as default e-mail client, KOrganizer as defaule windows calendaring app, etc. See [[#KDE-related_notes|the notes]].|jstaniek}}
{{FeatureDone|[[#Drag.26drop_support|Drag&Drop support]]|Integration: D&D files onto the message composer|jstaniek}}
{{FeatureInProgress|[[#Copy.26paste_support|Copy&Paste support]]|Integration|jstaniek}}
{{FeatureDone|[http://intevation.de/roundup/kolab/issue2646 Use the standard Windows filedialogs]|Integration|jstaniek}}
{{FeatureDone|[[#Crashes_in_KDED|Fixes for Start Menu entries]]|Integration: avoid crashes and conflicts of kwinstartmenu KDED plugin with Start Menu entries added by hand in 3rd-party installers|jstaniek}}
{{FeatureInProgress|[[#.22Locked.22_dbus-daemon|"Locked" dbus-daemon]]; see also [[#Alternative_solution|Alternative solution]]|Unique KDE applications lock DBUS daemon on crash|KDE PIM Team}}
{{FeatureDone|Usability: activate previous instances of unique apps|When another instance of unique appliaction is started, activate previous instance. This is what users expect. Moreover, if standalone application is running, e.g. KMail, and user clicked on "e-mail" component of Kontact, window of the standalone application is activated.|jstaniek}}
|}

=== Maildir implementation in KMail ===
The implementation based strictly on the original maildir specification in kmail does not work on Windows' file system, since it uses the ":" (forbidden on windows) character in file names. It also relies (as does maildir in general) on the atomicity of making a hardlink and then unlinking the original, to implement an atomic move. The implementation used by akonadi (kdepim/maildir) relies on QFile in that regard, but it's unclear if rename is atomic on all platforms.
*[[User:Jstaniek|jstaniek]] 12:50, 7 January 2008 (CET): Hard/soft links could be handled on Windows by altering the source code so that the "link" file is a text file itself and contains the target path. If we need atomic renames, '''Windows apparently lacks them''', I have found a pre-Vista [http://blogs.msdn.com/adioltean/archive/2005/12/28/507866.aspx blog] which contains description on how to perform them in a messy but honest way (look at the very last "Write process (on Foo.txt)" version). There's also a way to recover from application/system crash during the pseudo-atomic operations (see the very last "Recovery from a crash during write" checklist).
*[[User:Jstaniek|jstaniek]] 12:42, 24 January 2008 (CET): We will most probably benefit from ''maildir'' suport on Windows as Thunderbird (ver. <3) apparently lacks support for this storage, despite [https://bugzilla.mozilla.org/show_bug.cgi?id=58308 many wishes] and [http://wiki.mozilla.org/Thunderbird/Feature_Brainstorming#Storage_folder plans].
*[[User:Jstaniek|jstaniek]] 12:42, 24 January 2008 (CET): regarding replacing ":" character on windows:
** We cannot use ":" in any way ([http://en.wikipedia.org/wiki/Maildir#Windows_software Wikipedia note]), so we have to rename it to something other:
*** The proposed replace character is "!". Not "-" (see [https://bugzilla.mozilla.org/show_bug.cgi?id=58308#c77 this] for explanation).
*** We may want to add support for user-defined character, to allow reuse maildirs of apps like mutt (which uses "-"), but it should be clearly noted in the handbook that the setting is only for integration with existing maildirs.
*** '''The rename makes the implementation incompatible''' with the [http://cr.yp.to/proto/maildir.html specification] (which is informal anyway and says nothing about the replacement character).
** '''The ability of sharing a single maildir''' structure on dual boot machines (e.g., using the [http://www.fs-driver.org/ IFS Ext2 driver] or [http://ext2fsd.sourceforge.net/projects/projects.htm#ext2fsd Ext2fsd: way less crashy than IFS Ext2 (no blue screen of the death) and actively maintained]) is affected by the problem with ":" character.
*** '''Windows FS layer''' apparently returns "file not found" error for files having the ":" character on a linux filesystem. So if there is a need for storing the maildir at linux side, ":" should be renamed even if Linux itself does work with ":".
*** Conversely, '''if the maildir has to be stored at windows side''', ":" characters have to be renamed, do Linux build of KMail (and KDE-PIM in general) should support this rename too in order to access the storage.

===Folder Indices===
There are issues with locking index files for KMail folders and mmap()/munmap() operations on Windows. Therefore, SQLite-based indices are in development. [[Projects/PIM/MS Windows/SQLite Folder Indices|More info...]]

===Integration into the Windows Explorer & Desktop===
{{Note|[[User:Jstaniek|jstaniek]] 22:01, 14 January 2008 (CET): [http://tortoisesvn.tigris.org/ TortoiseSVN] is GPLed SVN client which is nicely integrated with Windows Explorer. Perhaps we can use its source code as a reference...}}

====Registry settings for default apps and services====
'''Introduction:''' We can detect whether KMail is the default e-mail client. If set as default, KMail should act as a default mailer, and thus be invoked automatically for actions like RMB "Send To -> E-mail Recipient". This shall be also reused by others for KOrganizer and Konqueror. The solution is relatively simple modifications to the Windows Registry. See [http://members.toast.net/4pf/Protocol.html Mozilla's solution].

First, we can use HKLM node for system-global settings or HKCU node for current-user-only settings. If the attempt to set the value in HKLM fails, usually because of unsufficient permissions, HKCU should be used. As expected, HKCU overrides HKLM settings. See [http://support.microsoft.com/kb/297878 KB297878]. Below we'll use HKCU.

*HKCU\Software\Clients\StartMenuInternet key is used to specify default web browser; could be set to Konqueror
*HKCU\Software\Clients\StartMenuInternet\app.exe\shell\open\command key is used for "Internet" start menu shortcut, can be set to Konqueror. Note from the KB - <tt>"The command might open the browser on the users home page, for example. However, it might launch some other introductory user interface that the ISV feels is appropriate."</tt> So this is not the same as 'default browser' setting.

*HKCU\Software\Clients\Mail\Appname - registered email client, there can be more entries within the 'Mail' node. Adding KMail here makes it available for users to select as a default browser using 'Set Default Programs' system window.
*HKCU\Software\Clients\Mail - default email client, 'Windows Mail' by default; could be set to KMail.

*HKCU\Software\Clients\Calendar\Appname - registered calendar application, there can be more entries within the 'Calendar' node. See the note for HKCU\Software\Clients\Mail\Appname.
*HKCU\Software\Clients\Calendar - default calendar application, 'Windows Calendar' on Vista; could be set to KOrganizer.

*HKCU\Software\Clients\Contacts\Appname - registered contacts client, there can be more entries within the 'Contacts' node. See the note for HKCU\Software\Clients\Mail\Appname.
*HKCU\Software\Clients\Contacts - default contacts application, 'Address Book' by default; could be set to KAddressBook.

*HKCU\Software\Clients\News\Appname - registered newsgroup client, there can be more entries within the 'News' node. See the note for HKCU\Software\Clients\Mail\Appname.
*HKCU\Software\Clients\News - default newsgroup application, 'Windows Mail' by default; could be set to KNode.

From the KB: <tt>After updating the registry keys, the application broadcasts the WM_SETTINGCHANGE message with wParam = 0 and lParam pointing to the null-terminated string "Software\Clients\StartMenuInternet" to notify the operating system that the default client has changed.</tt>

=====Using MAPI=====
HKLM\Software\Clients\AppName\DllPath points to a dll implementing [http://en.wikipedia.org/wiki/MAPI MAPI] interface. Internet Explorer uses Windows Messaging by default to invoke a mailer on a mailto: link. Only if the MAPI install is misconfigured will it resort to directly accessing the mailto association key.[http://members.toast.net/4pf/Protocol.html]
Example implementation of MAPI services is Thundebird's mozMapi32.dll (the key is usualle equal to C:\Program Files\Mozilla Thunderbird\mozMapi32.dll).

=====KDE-related notes=====
*KDElibs execute default web browser or email client for protocols like http(s): and <nowiki>mailto:</nowiki> via {{Qt|QDesktopServices}}::openUrl(), which in turn uses ShellExecute(). openUrl() is widely used in Qt e.g. for hyperlinks in text boxes and label widgets.
*A general rule of KDE/win: not to duplicate registry settings in any rc file and use default applications if possible, to avoid changing behaviour expected by users.
*[[User:Jstaniek|jstaniek]] 12:06, 18 June 2008 (CEST): Before LinuxTag I've performed some tests of setting default clients, and looks like it's is not possible to set onlt writing registry entries. Some API calls may be needed, especially because locked at least one registry key is locked for writing during the session.

====Drag&drop support====
Support drag&drop from/to composer and from received mails into the file system (Windows Explorer and the Desktop)
====Copy&paste support====
Support pasting files copied (in Windows Explorer or the Desktop) as attachments.
===Profile migration===
*[http://kb.mozillazine.org/Profile_folder Mozilla profile directories]
===SASL support===
{{Note|SASL should be available '''before''' building kdepimlibs. When you build kdepimlibs, it should display message like "SASL Found" during configure stage.}}
====Build SASL by hand====
[http://asg.web.cmu.edu/sasl/ Cyrus SASL] is used on Windows for SSL/TLS, so we use the same source code plus wrapper functions that are a part of the Cyrus distribution (the result is a native Windows library, do not confuse with Cygwin!).

Two Mozilla's [http://wiki.mozilla.org/LDAP_C_SDK_SASL_Windows patches] have to be applied for msvc.

Cyrus SASL functionality is based on plugins. For KDEpimlibs we have set the paths for plugins and configuration to KDEROOT/lib/sasl2/ and KDEROOT/share/config/sasl2/, respectively. The configuration capatibilities are apparently not used for now. ([[User:Jstaniek|jstaniek]] February 3 2008)

The following parts of KDEpimlibs depend on sasl2: kldap, kioslave/{sieve|imap4|smtp|pop3}.

'''Limitations:''' Currently all plugins but KerberosV4 (kerberos4.c) and PASSDSS (passdss.c) can be built on Windows. ([http://www.sendmail.org/~ca/email/cyrus2/windows.html more info])

'''See also:'''
*[http://negotiateauth.mozdev.org/ Negotiateauth] Mozilla plugin and [http://sourceforge.net/projects/modauthkerb/ Mod_auth_kerb] Apache module for Kerberos support.
*[http://mailman.mit.edu/pipermail/kerberos/2004-April/005152.html this] [http://mailman.mit.edu/pipermail/kerberos/2004-April/005155.html thread]
<nowiki>Insert non-formatted text here</nowiki>

====Download SASL for mingw and msvc====
Download SASL library and plugins for mingw and msvc. Here's link, this time uploaded to the wiki (TODO move it to the kde windows server): http://kexi-project.org/download/cyrus-sasl2-2008-04.zip. The archive provides directory structure, so you'll know where to unpack these files.

===Hot fixes to apply===
Please apply these fixes in order to avoid crashes in related KDE componenets.
====Crashes in korgac====
Update: this step is not needed since r806657.

<strike>KOrganizer's reminder daemon (korgac) crashes on Windows because of recent commit. A quick fix is to go to kdelibs/ source directory and type:

<tt>svn up -r 795533 kdeui/util/ksystemtrayicon.cpp</tt>

Then compile and install the kdelibs.</strike>

====Crashes in KDED====
We sometimes need to disable creation and automatic maintenance of the KDE menu entry in the Start Menu. To do this, we can add these lines to the $KDEROOT/share/config/kwinstartmenurc file on deployment:

<code>
[General]
Enabled=false
</code>

Tip: just download the file: [https://www.intevation.de/roundup/kolab/file799/kwinstartmenurc kwinstartmenurc] and save it to the $KDEROOT/share/config/ directory.

===="Locked" dbus-daemon====
History:
*[[User:Jstaniek|jstaniek]] 18:12, 27 May 2008 (CEST): initial version for enterprise4 branch; emerge package: kdepim-branch
*[[User:Jstaniek|jstaniek]] 19:03, 28 May 2008 (CEST): update for David's commit r813498 "Ported Kontact::UniqueAppHandler to DBUS"

Introduction: upon application crash (for whatever reason), dbus-daemon (happens on Windows only) does not unregister unused service(s). Subsequent execution of the same application causes ''KUniqueApplication: Can't setup D-Bus service. Probably already running'' error and immediate exit with no visible feedback.

Reported as http://intevation.de/roundup/kolab/issue2639

Past workaround: manual killing dbus-daemon.

Rationale for the new workaround: make KDEPIM more suitable for demonstrating, without executing cryptic commands.

Workaround: If registering dbus service for KUniqueApplication (e.g. "org.kde.kmail") failed, do not exit immediately but instead:
# look if there's a process with the same name (e.g. kmail) running, if so exit with no action
# if there's no process with the same name, kill dbus-daemon (first, using SIGTERM, then SIGKILL), then restart the application with exactly the same arguments and the same current working directory.

Recipe: apply [http://www.intevation.de/roundup/kolab/file806/kuniqueapplication.patch kuniqueapplication.patch] in kdelibs and rebuild and install kdeui; this will make KUniqueApplication::start() return with false value instead of exiting().
=====Alternative solution=====
*[[User:Jstaniek|jstaniek]] 19:45, 24 June 2008 (CEST) '''patched windbus allowing to release unused service resources after client's crash''':
**in progress, testing
**changes commited to kdelibs-branch and kdepim-branch (reverts the ''"Locked" dbus-daemon'' workaround)
**windbus patch: to be published

===Other TODOs===
*KMFolderTree::cleanupConfigFile() removes kmailrc sections for nonexisting folders but the changes are not writen back ([[User:Jstaniek|jstaniek]] 11:07, 14 May 2008 (CEST))

== Notes ==
* '''The branches/work/kdab-post-4.0 branch''' ([http://websvn.kde.org/branches/work/kdab-post-4.0/kdepim/ kdepimlibs], [http://websvn.kde.org/branches/work/kdab-post-4.0/kdepim/ kdepim] modules) '''have been closed and merged into [http://websvn.kde.org/trunk/KDE/ trunk]'''. <strike>KDE PIM for Windows development happens in trunk again now.</strike>
* KDE PIM for Windows development happens in branches/kdepim/enterprise4 now.

== Links ==
* [[Projects/KDE_on_Windows|The KDE on Windows]] Project
* [[Projects/KDE on Windows/Missing features of kdelibs|Missing features of kdelibs on Windows]] - KDE PIM may depend on them

== External Links ==
*Find out how others have managed to port their software to Windows:
**[http://cs.senecac.on.ca/~david.humphrey/writing/firefox-win32-build.html Building Firefox on Windows using msvc]
**[http://wiki.mozilla.org/LDAP_C_SDK_SASL_Windows Building Cyrus SASL on Windows]

[[Category:PIM]]
[[Category:MS Windows]]

File:Igta.png

2008-06-27T22:30:17Z

Jstaniek:

Projects/KDE on Windows/Issues

2008-06-26T15:35:58Z

Jstaniek: /* Killing KDE Processes */

* [[/emerge|''emerge'' tool]]
* [[/kdewin-installer|kdewin-installer]]
* [[/MSVC|Using MSVC compiler and editor]]

__TOC__
==Disabling automatic generation of Start Menu entries==
KDE on Windows provides a (kded) plugin for automatic generation of Start Menu entries for KDE applications. If for whatever reason you want to disable it:
#edit (or create if it does not exist) kde4/share/config/kwinstartmenurc file (not that it has no name extension)
#place the following two lines in it:
<code>
[General]
Enabled=false
</code>

You may need to stop (or kill) all the KDE processes in order to use the new setting. It is planned to add appropriate setting on the forthcoming KDE's "Integration" system settings page.

==File Locking - WerFault.exe==
[http://www.whatsrunning.net/whatsrunning/QueryProcessID.aspx?Process=15663 WerFault.exe] is a process handling ''Windows Problem Reporting'' feature. Sometimes it may drive you crazy because it can lock your files, while you (or a KDE app) want to rename or remove. For me this was the case with files of KMail's MailDir storage.

If you're developer, you'll most obviously encounter many crashes with your developed applications. On any crash, annoying popup appears and says "This program has stopped responding" they it says something about Windows will try to find a solution and fix it. Of course '''this is a joke''', so it is good to disable ''Windows Problem Reporting''. On Vista: open the Control Panel, open the Problem Reports & Solutions applet, wnder the Advanced option you can disable problem reporting. For XP or Windows 2003, read [http://www.windowsnetworking.com/articles_tutorials/Disable-Error-Reporting-Windows-XP-Server-2003.html here].

==Killing KDE Processes==
While it is easy to close applications as these have windows and have close buttons, there are (quite frequent) cases when you have to kill invisible "system" KDE processes. The two most important reasons are:
*you want to (re)compile a library or application but you would not be able to install it because Windows locks write access to the binaries that are running
*you need to restart dbus-daemon process in order to disconnect connections made by KUniqueApplication's; this is because of Windows-specific problem with not terminating them after the application stops working and/or gets killed itself

You can use <tt>taskkill</tt> command, which has quite complicated arguments. So you can define a <tt>kdekill</tt> command. Paste the following lines to a file like {KDEDIR}/bin/kdekill.bat:

<code>
@echo off
taskkill /T /F /fi "imagename eq klauncher*"
taskkill /T /fi "imagename eq dbus-daemon*"
taskkill /T /fi "imagename eq kde*"
taskkill /T /fi "imagename eq kded*"
taskkill /T /fi "imagename eq kioslave*"
taskkill /T /fi "imagename eq knotify*"
taskkill /T /fi "imagename eq korgac*"
taskkill /fi "imagename eq kded*"
taskkill /T /F /fi "imagename eq kded*"
</code>

Then you can just type <tt>kdekill</tt>, to get result like:
<pre>
SUCCESS: Sent termination signal to process with PID 832, child of PID 2372.
SUCCESS: Sent termination signal to process with PID 2692, child of PID 2580.
SUCCESS: Sent termination signal to process with PID 2684, child of PID 480.
SUCCESS: Sent termination signal to process with PID 480, child of PID 2580.
SUCCESS: Sent termination signal to process with PID 2692, child of PID 2580.
</pre>

Feel free to extend it for your specific needs.

Note 1: klauncher sometimes refuses to terminate...

Note 2: we hope to address the above issues with KUniqueApplication and dbus-daemon in a cleaner and more automated way...

==Ideas==
* Look at http://emergedesktop.org/ for integration ideas.

[[Category:MS Windows]]

Projects/PIM/MS Windows

2008-06-24T17:49:56Z

Jstaniek: /* The Checklist */

This page covers topics related to the MS Windows port of the KDE PIM suite.

{{Note|This page is work in progress started by [[User:Jstaniek|jstaniek]].}}

==Building==
Build base KDE libraries for Windows with required dependencies, preferable using ''emerge'' tool (because it tracks dependencies for you):
#install ''emerge'' and its dependencies as described [[Getting_Started/Build/KDE4/Windows/emerge|here]]
#either [[#Build_SASL_by_hand|build SASL by hand]] or [[#Download_SASL_for_mingw_and_msvc|download precompiled version for mingw and msvc]], and install it (if you skip this step you will not have SSL/TLS support in your apps)
#unpack gpgme-1.1.4-3-lib.zip and gpgme-1.1.4-3-bin.zip from http://www.winkde.org/pub/kde/ports/win32/repository/win32libs/ to your KDEDIR
#from the cmd.exe command line, enter <pre>emerge kdepimlibs</pre> - that will also build ''qt'', ''kdesupport'' (part of it), ''soprano'', ''strigi'', ''kdelibs'', ''kdebase''
#enter <pre>emerge libassuan</pre> - this is an optional dependency of ''kdepim''
#finally, enter <pre>emerge kdepim</pre>

Notes:
*Temporary fix for [http://bugs.kde.org/show_bug.cgi?id=160881 Bug 160881: PGP encryption of mails results in empty MIME-part] in kdepim can be enabled if you add -DKLEO_SYNCHRONOUS_API_HOTFIX:BOOL=ON to your cmake call.

== Problem points ==
=== The Checklist ===
{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Feature !! Description !! Contact
{{FeatureDone|[[#Maildir_implementation_in_KMail|Maildir implementation]]|make maildir standard work with Windows filesystems |jstaniek}}
{{FeatureDone|[[#Folder_Indices|Folder Indices]]|so called "mmap mode"|jstaniek}}
{{FeatureDone|[[#SASL support|SASL support]]|security|KDE PIM Team}}
{{FeatureInProgress|[[#Registry_settings_for_default_apps_and_services|Registry settings for default apps and services]]|Integration: Setting KMail as default e-mail client, KOrganizer as defaule windows calendaring app, etc. See [[#KDE-related_notes|the notes]].|jstaniek}}
{{FeatureDone|[[#Drag.26drop_support|Drag&Drop support]]|Integration: D&D files onto the message composer|jstaniek}}
{{FeatureInProgress|[[#Copy.26paste_support|Copy&Paste support]]|Integration|jstaniek}}
{{FeatureDone|[http://intevation.de/roundup/kolab/issue2646 Use the standard Windows filedialogs]|Integration|jstaniek}}
{{FeatureDone|[[#Crashes_in_KDED|Fixes for Start Menu entries]]|Integration: avoid crashes and conflicts of kwinstartmenu KDED plugin with Start Menu entries added by hand in 3rd-party installers|jstaniek}}
{{FeatureInProgress|[[#.22Locked.22_dbus-daemon|"Locked" dbus-daemon]]; see also [[#Alternative_solution|Alternative solution]]|Unique KDE applications lock DBUS daemon on crash|KDE PIM Team}}
|}

=== Maildir implementation in KMail ===
The implementation based strictly on the original maildir specification in kmail does not work on Windows' file system, since it uses the ":" (forbidden on windows) character in file names. It also relies (as does maildir in general) on the atomicity of making a hardlink and then unlinking the original, to implement an atomic move. The implementation used by akonadi (kdepim/maildir) relies on QFile in that regard, but it's unclear if rename is atomic on all platforms.
*[[User:Jstaniek|jstaniek]] 12:50, 7 January 2008 (CET): Hard/soft links could be handled on Windows by altering the source code so that the "link" file is a text file itself and contains the target path. If we need atomic renames, '''Windows apparently lacks them''', I have found a pre-Vista [http://blogs.msdn.com/adioltean/archive/2005/12/28/507866.aspx blog] which contains description on how to perform them in a messy but honest way (look at the very last "Write process (on Foo.txt)" version). There's also a way to recover from application/system crash during the pseudo-atomic operations (see the very last "Recovery from a crash during write" checklist).
*[[User:Jstaniek|jstaniek]] 12:42, 24 January 2008 (CET): We will most probably benefit from ''maildir'' suport on Windows as Thunderbird (ver. <3) apparently lacks support for this storage, despite [https://bugzilla.mozilla.org/show_bug.cgi?id=58308 many wishes] and [http://wiki.mozilla.org/Thunderbird/Feature_Brainstorming#Storage_folder plans].
*[[User:Jstaniek|jstaniek]] 12:42, 24 January 2008 (CET): regarding replacing ":" character on windows:
** We cannot use ":" in any way ([http://en.wikipedia.org/wiki/Maildir#Windows_software Wikipedia note]), so we have to rename it to something other:
*** The proposed replace character is "!". Not "-" (see [https://bugzilla.mozilla.org/show_bug.cgi?id=58308#c77 this] for explanation).
*** We may want to add support for user-defined character, to allow reuse maildirs of apps like mutt (which uses "-"), but it should be clearly noted in the handbook that the setting is only for integration with existing maildirs.
*** '''The rename makes the implementation incompatible''' with the [http://cr.yp.to/proto/maildir.html specification] (which is informal anyway and says nothing about the replacement character).
** '''The ability of sharing a single maildir''' structure on dual boot machines (e.g., using the [http://www.fs-driver.org/ IFS Ext2 driver] or [http://ext2fsd.sourceforge.net/projects/projects.htm#ext2fsd Ext2fsd: way less crashy than IFS Ext2 (no blue screen of the death) and actively maintained]) is affected by the problem with ":" character.
*** '''Windows FS layer''' apparently returns "file not found" error for files having the ":" character on a linux filesystem. So if there is a need for storing the maildir at linux side, ":" should be renamed even if Linux itself does work with ":".
*** Conversely, '''if the maildir has to be stored at windows side''', ":" characters have to be renamed, do Linux build of KMail (and KDE-PIM in general) should support this rename too in order to access the storage.

===Folder Indices===
There are issues with locking index files for KMail folders and mmap()/munmap() operations on Windows. Therefore, SQLite-based indices are in development. [[Projects/PIM/MS Windows/SQLite Folder Indices|More info...]]

===Integration into the Windows Explorer & Desktop===
{{Note|[[User:Jstaniek|jstaniek]] 22:01, 14 January 2008 (CET): [http://tortoisesvn.tigris.org/ TortoiseSVN] is GPLed SVN client which is nicely integrated with Windows Explorer. Perhaps we can use its source code as a reference...}}

====Registry settings for default apps and services====
'''Introduction:''' We can detect whether KMail is the default e-mail client. If set as default, KMail should act as a default mailer, and thus be invoked automatically for actions like RMB "Send To -> E-mail Recipient". This shall be also reused by others for KOrganizer and Konqueror. The solution is relatively simple modifications to the Windows Registry. See [http://members.toast.net/4pf/Protocol.html Mozilla's solution].

First, we can use HKLM node for system-global settings or HKCU node for current-user-only settings. If the attempt to set the value in HKLM fails, usually because of unsufficient permissions, HKCU should be used. As expected, HKCU overrides HKLM settings. See [http://support.microsoft.com/kb/297878 KB297878]. Below we'll use HKCU.

*HKCU\Software\Clients\StartMenuInternet key is used to specify default web browser; could be set to Konqueror
*HKCU\Software\Clients\StartMenuInternet\app.exe\shell\open\command key is used for "Internet" start menu shortcut, can be set to Konqueror. Note from the KB - <tt>"The command might open the browser on the users home page, for example. However, it might launch some other introductory user interface that the ISV feels is appropriate."</tt> So this is not the same as 'default browser' setting.

*HKCU\Software\Clients\Mail\Appname - registered email client, there can be more entries within the 'Mail' node. Adding KMail here makes it available for users to select as a default browser using 'Set Default Programs' system window.
*HKCU\Software\Clients\Mail - default email client, 'Windows Mail' by default; could be set to KMail.

*HKCU\Software\Clients\Calendar\Appname - registered calendar application, there can be more entries within the 'Calendar' node. See the note for HKCU\Software\Clients\Mail\Appname.
*HKCU\Software\Clients\Calendar - default calendar application, 'Windows Calendar' on Vista; could be set to KOrganizer.

*HKCU\Software\Clients\Contacts\Appname - registered contacts client, there can be more entries within the 'Contacts' node. See the note for HKCU\Software\Clients\Mail\Appname.
*HKCU\Software\Clients\Contacts - default contacts application, 'Address Book' by default; could be set to KAddressBook.

*HKCU\Software\Clients\News\Appname - registered newsgroup client, there can be more entries within the 'News' node. See the note for HKCU\Software\Clients\Mail\Appname.
*HKCU\Software\Clients\News - default newsgroup application, 'Windows Mail' by default; could be set to KNode.

From the KB: <tt>After updating the registry keys, the application broadcasts the WM_SETTINGCHANGE message with wParam = 0 and lParam pointing to the null-terminated string "Software\Clients\StartMenuInternet" to notify the operating system that the default client has changed.</tt>

=====Using MAPI=====
HKLM\Software\Clients\AppName\DllPath points to a dll implementing [http://en.wikipedia.org/wiki/MAPI MAPI] interface. Internet Explorer uses Windows Messaging by default to invoke a mailer on a mailto: link. Only if the MAPI install is misconfigured will it resort to directly accessing the mailto association key.[http://members.toast.net/4pf/Protocol.html]
Example implementation of MAPI services is Thundebird's mozMapi32.dll (the key is usualle equal to C:\Program Files\Mozilla Thunderbird\mozMapi32.dll).

=====KDE-related notes=====
*KDElibs execute default web browser or email client for protocols like http(s): and <nowiki>mailto:</nowiki> via {{Qt|QDesktopServices}}::openUrl(), which in turn uses ShellExecute(). openUrl() is widely used in Qt e.g. for hyperlinks in text boxes and label widgets.
*A general rule of KDE/win: not to duplicate registry settings in any rc file and use default applications if possible, to avoid changing behaviour expected by users.
*[[User:Jstaniek|jstaniek]] 12:06, 18 June 2008 (CEST): Before LinuxTag I've performed some tests of setting default clients, and looks like it's is not possible to set onlt writing registry entries. Some API calls may be needed, especially because locked at least one registry key is locked for writing during the session.

====Drag&drop support====
Support drag&drop from/to composer and from received mails into the file system (Windows Explorer and the Desktop)
====Copy&paste support====
Support pasting files copied (in Windows Explorer or the Desktop) as attachments.
===Profile migration===
*[http://kb.mozillazine.org/Profile_folder Mozilla profile directories]
===SASL support===
{{Note|SASL should be available '''before''' building kdepimlibs. When you build kdepimlibs, it should display message like "SASL Found" during configure stage.}}
====Build SASL by hand====
[http://asg.web.cmu.edu/sasl/ Cyrus SASL] is used on Windows for SSL/TLS, so we use the same source code plus wrapper functions that are a part of the Cyrus distribution (the result is a native Windows library, do not confuse with Cygwin!).

Two Mozilla's [http://wiki.mozilla.org/LDAP_C_SDK_SASL_Windows patches] have to be applied for msvc.

Cyrus SASL functionality is based on plugins. For KDEpimlibs we have set the paths for plugins and configuration to KDEROOT/lib/sasl2/ and KDEROOT/share/config/sasl2/, respectively. The configuration capatibilities are apparently not used for now. ([[User:Jstaniek|jstaniek]] February 3 2008)

The following parts of KDEpimlibs depend on sasl2: kldap, kioslave/{sieve|imap4|smtp|pop3}.

'''Limitations:''' Currently all plugins but KerberosV4 (kerberos4.c) and PASSDSS (passdss.c) can be built on Windows. ([http://www.sendmail.org/~ca/email/cyrus2/windows.html more info])

'''See also:'''
*[http://negotiateauth.mozdev.org/ Negotiateauth] Mozilla plugin and [http://sourceforge.net/projects/modauthkerb/ Mod_auth_kerb] Apache module for Kerberos support.
*[http://mailman.mit.edu/pipermail/kerberos/2004-April/005152.html this] [http://mailman.mit.edu/pipermail/kerberos/2004-April/005155.html thread]
<nowiki>Insert non-formatted text here</nowiki>

====Download SASL for mingw and msvc====
Download SASL library and plugins for mingw and msvc. Here's link, this time uploaded to the wiki (TODO move it to the kde windows server): http://kexi-project.org/download/cyrus-sasl2-2008-04.zip. The archive provides directory structure, so you'll know where to unpack these files.

===Hot fixes to apply===
Please apply these fixes in order to avoid crashes in related KDE componenets.
====Crashes in korgac====
Update: this step is not needed since r806657.

<strike>KOrganizer's reminder daemon (korgac) crashes on Windows because of recent commit. A quick fix is to go to kdelibs/ source directory and type:

<tt>svn up -r 795533 kdeui/util/ksystemtrayicon.cpp</tt>

Then compile and install the kdelibs.</strike>

====Crashes in KDED====
We sometimes need to disable creation and automatic maintenance of the KDE menu entry in the Start Menu. To do this, we can add these lines to the $KDEROOT/share/config/kwinstartmenurc file on deployment:

<code>
[General]
Enabled=false
</code>

Tip: just download the file: [https://www.intevation.de/roundup/kolab/file799/kwinstartmenurc kwinstartmenurc] and save it to the $KDEROOT/share/config/ directory.

===="Locked" dbus-daemon====
History:
*[[User:Jstaniek|jstaniek]] 18:12, 27 May 2008 (CEST): initial version for enterprise4 branch; emerge package: kdepim-branch
*[[User:Jstaniek|jstaniek]] 19:03, 28 May 2008 (CEST): update for David's commit r813498 "Ported Kontact::UniqueAppHandler to DBUS"

Introduction: upon application crash (for whatever reason), dbus-daemon (happens on Windows only) does not unregister unused service(s). Subsequent execution of the same application causes ''KUniqueApplication: Can't setup D-Bus service. Probably already running'' error and immediate exit with no visible feedback.

Reported as http://intevation.de/roundup/kolab/issue2639

Past workaround: manual killing dbus-daemon.

Rationale for the new workaround: make KDEPIM more suitable for demonstrating, without executing cryptic commands.

Workaround: If registering dbus service for KUniqueApplication (e.g. "org.kde.kmail") failed, do not exit immediately but instead:
# look if there's a process with the same name (e.g. kmail) running, if so exit with no action
# if there's no process with the same name, kill dbus-daemon (first, using SIGTERM, then SIGKILL), then restart the application with exactly the same arguments and the same current working directory.

Recipe: apply [http://www.intevation.de/roundup/kolab/file806/kuniqueapplication.patch kuniqueapplication.patch] in kdelibs and rebuild and install kdeui; this will make KUniqueApplication::start() return with false value instead of exiting().
=====Alternative solution=====
*[[User:Jstaniek|jstaniek]] 19:45, 24 June 2008 (CEST) '''patched windbus allowing to release unused service resources after client's crash''':
**in progress, testing
**changes commited to kdelibs-branch and kdepim-branch (reverts the ''"Locked" dbus-daemon'' workaround)
**windbus patch: to be published

===Other TODOs===
*KMFolderTree::cleanupConfigFile() removes kmailrc sections for nonexisting folders but the changes are not writen back ([[User:Jstaniek|jstaniek]] 11:07, 14 May 2008 (CEST))

== Notes ==
* '''The branches/work/kdab-post-4.0 branch''' ([http://websvn.kde.org/branches/work/kdab-post-4.0/kdepim/ kdepimlibs], [http://websvn.kde.org/branches/work/kdab-post-4.0/kdepim/ kdepim] modules) '''have been closed and merged into [http://websvn.kde.org/trunk/KDE/ trunk]'''. <strike>KDE PIM for Windows development happens in trunk again now.</strike>
* KDE PIM for Windows development happens in branches/kdepim/enterprise4 now.

== Links ==
* [[Projects/KDE_on_Windows|The KDE on Windows]] Project
* [[Projects/KDE on Windows/Missing features of kdelibs|Missing features of kdelibs on Windows]] - KDE PIM may depend on them

== External Links ==
*Find out how others have managed to port their software to Windows:
**[http://cs.senecac.on.ca/~david.humphrey/writing/firefox-win32-build.html Building Firefox on Windows using msvc]
**[http://wiki.mozilla.org/LDAP_C_SDK_SASL_Windows Building Cyrus SASL on Windows]

[[Category:PIM]]
[[Category:MS Windows]]

Projects/PIM/MS Windows

2008-06-24T17:48:48Z

Jstaniek: /* "Locked" dbus-daemon */

This page covers topics related to the MS Windows port of the KDE PIM suite.

{{Note|This page is work in progress started by [[User:Jstaniek|jstaniek]].}}

==Building==
Build base KDE libraries for Windows with required dependencies, preferable using ''emerge'' tool (because it tracks dependencies for you):
#install ''emerge'' and its dependencies as described [[Getting_Started/Build/KDE4/Windows/emerge|here]]
#either [[#Build_SASL_by_hand|build SASL by hand]] or [[#Download_SASL_for_mingw_and_msvc|download precompiled version for mingw and msvc]], and install it (if you skip this step you will not have SSL/TLS support in your apps)
#unpack gpgme-1.1.4-3-lib.zip and gpgme-1.1.4-3-bin.zip from http://www.winkde.org/pub/kde/ports/win32/repository/win32libs/ to your KDEDIR
#from the cmd.exe command line, enter <pre>emerge kdepimlibs</pre> - that will also build ''qt'', ''kdesupport'' (part of it), ''soprano'', ''strigi'', ''kdelibs'', ''kdebase''
#enter <pre>emerge libassuan</pre> - this is an optional dependency of ''kdepim''
#finally, enter <pre>emerge kdepim</pre>

Notes:
*Temporary fix for [http://bugs.kde.org/show_bug.cgi?id=160881 Bug 160881: PGP encryption of mails results in empty MIME-part] in kdepim can be enabled if you add -DKLEO_SYNCHRONOUS_API_HOTFIX:BOOL=ON to your cmake call.

== Problem points ==
=== The Checklist ===
{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width: 100%;"
|- style="background: #ececec; white-space:nowrap;"
! Status !! Feature !! Description !! Contact
{{FeatureDone|[[#Maildir_implementation_in_KMail|Maildir implementation]]|make maildir standard work with Windows filesystems |jstaniek}}
{{FeatureDone|[[#Folder_Indices|Folder Indices]]|so called "mmap mode"|jstaniek}}
{{FeatureDone|[[#SASL support|SASL support]]|security|KDE PIM Team}}
{{FeatureInProgress|[[#Registry_settings_for_default_apps_and_services|Registry settings for default apps and services]]|Integration: Setting KMail as default e-mail client, KOrganizer as defaule windows calendaring app, etc. See [[#KDE-related_notes|the notes]].|jstaniek}}
{{FeatureDone|[[#Drag.26drop_support|Drag&Drop support]]|Integration: D&D files onto the message composer|jstaniek}}
{{FeatureInProgress|[[#Copy.26paste_support|Copy&Paste support]]|Integration|jstaniek}}
{{FeatureDone|[http://intevation.de/roundup/kolab/issue2646 Use the standard Windows filedialogs]|Integration|jstaniek}}
{{FeatureDone|[[#Crashes_in_KDED|Fixes for Start Menu entries]]|Integration: avoid crashes and conflicts of kwinstartmenu KDED plugin with Start Menu entries added by hand in 3rd-party installers|jstaniek}}
{{FeatureInProgress|[[#.22Locked.22_dbus-daemon|"Locked" dbus-daemon]]|Unique KDE applications lock DBUS daemon on crash|KDE PIM Team}}
|}

=== Maildir implementation in KMail ===
The implementation based strictly on the original maildir specification in kmail does not work on Windows' file system, since it uses the ":" (forbidden on windows) character in file names. It also relies (as does maildir in general) on the atomicity of making a hardlink and then unlinking the original, to implement an atomic move. The implementation used by akonadi (kdepim/maildir) relies on QFile in that regard, but it's unclear if rename is atomic on all platforms.
*[[User:Jstaniek|jstaniek]] 12:50, 7 January 2008 (CET): Hard/soft links could be handled on Windows by altering the source code so that the "link" file is a text file itself and contains the target path. If we need atomic renames, '''Windows apparently lacks them''', I have found a pre-Vista [http://blogs.msdn.com/adioltean/archive/2005/12/28/507866.aspx blog] which contains description on how to perform them in a messy but honest way (look at the very last "Write process (on Foo.txt)" version). There's also a way to recover from application/system crash during the pseudo-atomic operations (see the very last "Recovery from a crash during write" checklist).
*[[User:Jstaniek|jstaniek]] 12:42, 24 January 2008 (CET): We will most probably benefit from ''maildir'' suport on Windows as Thunderbird (ver. <3) apparently lacks support for this storage, despite [https://bugzilla.mozilla.org/show_bug.cgi?id=58308 many wishes] and [http://wiki.mozilla.org/Thunderbird/Feature_Brainstorming#Storage_folder plans].
*[[User:Jstaniek|jstaniek]] 12:42, 24 January 2008 (CET): regarding replacing ":" character on windows:
** We cannot use ":" in any way ([http://en.wikipedia.org/wiki/Maildir#Windows_software Wikipedia note]), so we have to rename it to something other:
*** The proposed replace character is "!". Not "-" (see [https://bugzilla.mozilla.org/show_bug.cgi?id=58308#c77 this] for explanation).
*** We may want to add support for user-defined character, to allow reuse maildirs of apps like mutt (which uses "-"), but it should be clearly noted in the handbook that the setting is only for integration with existing maildirs.
*** '''The rename makes the implementation incompatible''' with the [http://cr.yp.to/proto/maildir.html specification] (which is informal anyway and says nothing about the replacement character).
** '''The ability of sharing a single maildir''' structure on dual boot machines (e.g., using the [http://www.fs-driver.org/ IFS Ext2 driver] or [http://ext2fsd.sourceforge.net/projects/projects.htm#ext2fsd Ext2fsd: way less crashy than IFS Ext2 (no blue screen of the death) and actively maintained]) is affected by the problem with ":" character.
*** '''Windows FS layer''' apparently returns "file not found" error for files having the ":" character on a linux filesystem. So if there is a need for storing the maildir at linux side, ":" should be renamed even if Linux itself does work with ":".
*** Conversely, '''if the maildir has to be stored at windows side''', ":" characters have to be renamed, do Linux build of KMail (and KDE-PIM in general) should support this rename too in order to access the storage.

===Folder Indices===
There are issues with locking index files for KMail folders and mmap()/munmap() operations on Windows. Therefore, SQLite-based indices are in development. [[Projects/PIM/MS Windows/SQLite Folder Indices|More info...]]

===Integration into the Windows Explorer & Desktop===
{{Note|[[User:Jstaniek|jstaniek]] 22:01, 14 January 2008 (CET): [http://tortoisesvn.tigris.org/ TortoiseSVN] is GPLed SVN client which is nicely integrated with Windows Explorer. Perhaps we can use its source code as a reference...}}

====Registry settings for default apps and services====
'''Introduction:''' We can detect whether KMail is the default e-mail client. If set as default, KMail should act as a default mailer, and thus be invoked automatically for actions like RMB "Send To -> E-mail Recipient". This shall be also reused by others for KOrganizer and Konqueror. The solution is relatively simple modifications to the Windows Registry. See [http://members.toast.net/4pf/Protocol.html Mozilla's solution].

First, we can use HKLM node for system-global settings or HKCU node for current-user-only settings. If the attempt to set the value in HKLM fails, usually because of unsufficient permissions, HKCU should be used. As expected, HKCU overrides HKLM settings. See [http://support.microsoft.com/kb/297878 KB297878]. Below we'll use HKCU.

*HKCU\Software\Clients\StartMenuInternet key is used to specify default web browser; could be set to Konqueror
*HKCU\Software\Clients\StartMenuInternet\app.exe\shell\open\command key is used for "Internet" start menu shortcut, can be set to Konqueror. Note from the KB - <tt>"The command might open the browser on the users home page, for example. However, it might launch some other introductory user interface that the ISV feels is appropriate."</tt> So this is not the same as 'default browser' setting.

*HKCU\Software\Clients\Mail\Appname - registered email client, there can be more entries within the 'Mail' node. Adding KMail here makes it available for users to select as a default browser using 'Set Default Programs' system window.
*HKCU\Software\Clients\Mail - default email client, 'Windows Mail' by default; could be set to KMail.

*HKCU\Software\Clients\Calendar\Appname - registered calendar application, there can be more entries within the 'Calendar' node. See the note for HKCU\Software\Clients\Mail\Appname.
*HKCU\Software\Clients\Calendar - default calendar application, 'Windows Calendar' on Vista; could be set to KOrganizer.

*HKCU\Software\Clients\Contacts\Appname - registered contacts client, there can be more entries within the 'Contacts' node. See the note for HKCU\Software\Clients\Mail\Appname.
*HKCU\Software\Clients\Contacts - default contacts application, 'Address Book' by default; could be set to KAddressBook.

*HKCU\Software\Clients\News\Appname - registered newsgroup client, there can be more entries within the 'News' node. See the note for HKCU\Software\Clients\Mail\Appname.
*HKCU\Software\Clients\News - default newsgroup application, 'Windows Mail' by default; could be set to KNode.

From the KB: <tt>After updating the registry keys, the application broadcasts the WM_SETTINGCHANGE message with wParam = 0 and lParam pointing to the null-terminated string "Software\Clients\StartMenuInternet" to notify the operating system that the default client has changed.</tt>

=====Using MAPI=====
HKLM\Software\Clients\AppName\DllPath points to a dll implementing [http://en.wikipedia.org/wiki/MAPI MAPI] interface. Internet Explorer uses Windows Messaging by default to invoke a mailer on a mailto: link. Only if the MAPI install is misconfigured will it resort to directly accessing the mailto association key.[http://members.toast.net/4pf/Protocol.html]
Example implementation of MAPI services is Thundebird's mozMapi32.dll (the key is usualle equal to C:\Program Files\Mozilla Thunderbird\mozMapi32.dll).

=====KDE-related notes=====
*KDElibs execute default web browser or email client for protocols like http(s): and <nowiki>mailto:</nowiki> via {{Qt|QDesktopServices}}::openUrl(), which in turn uses ShellExecute(). openUrl() is widely used in Qt e.g. for hyperlinks in text boxes and label widgets.
*A general rule of KDE/win: not to duplicate registry settings in any rc file and use default applications if possible, to avoid changing behaviour expected by users.
*[[User:Jstaniek|jstaniek]] 12:06, 18 June 2008 (CEST): Before LinuxTag I've performed some tests of setting default clients, and looks like it's is not possible to set onlt writing registry entries. Some API calls may be needed, especially because locked at least one registry key is locked for writing during the session.

====Drag&drop support====
Support drag&drop from/to composer and from received mails into the file system (Windows Explorer and the Desktop)
====Copy&paste support====
Support pasting files copied (in Windows Explorer or the Desktop) as attachments.
===Profile migration===
*[http://kb.mozillazine.org/Profile_folder Mozilla profile directories]
===SASL support===
{{Note|SASL should be available '''before''' building kdepimlibs. When you build kdepimlibs, it should display message like "SASL Found" during configure stage.}}
====Build SASL by hand====
[http://asg.web.cmu.edu/sasl/ Cyrus SASL] is used on Windows for SSL/TLS, so we use the same source code plus wrapper functions that are a part of the Cyrus distribution (the result is a native Windows library, do not confuse with Cygwin!).

Two Mozilla's [http://wiki.mozilla.org/LDAP_C_SDK_SASL_Windows patches] have to be applied for msvc.

Cyrus SASL functionality is based on plugins. For KDEpimlibs we have set the paths for plugins and configuration to KDEROOT/lib/sasl2/ and KDEROOT/share/config/sasl2/, respectively. The configuration capatibilities are apparently not used for now. ([[User:Jstaniek|jstaniek]] February 3 2008)

The following parts of KDEpimlibs depend on sasl2: kldap, kioslave/{sieve|imap4|smtp|pop3}.

'''Limitations:''' Currently all plugins but KerberosV4 (kerberos4.c) and PASSDSS (passdss.c) can be built on Windows. ([http://www.sendmail.org/~ca/email/cyrus2/windows.html more info])

'''See also:'''
*[http://negotiateauth.mozdev.org/ Negotiateauth] Mozilla plugin and [http://sourceforge.net/projects/modauthkerb/ Mod_auth_kerb] Apache module for Kerberos support.
*[http://mailman.mit.edu/pipermail/kerberos/2004-April/005152.html this] [http://mailman.mit.edu/pipermail/kerberos/2004-April/005155.html thread]
<nowiki>Insert non-formatted text here</nowiki>

====Download SASL for mingw and msvc====
Download SASL library and plugins for mingw and msvc. Here's link, this time uploaded to the wiki (TODO move it to the kde windows server): http://kexi-project.org/download/cyrus-sasl2-2008-04.zip. The archive provides directory structure, so you'll know where to unpack these files.

===Hot fixes to apply===
Please apply these fixes in order to avoid crashes in related KDE componenets.
====Crashes in korgac====
Update: this step is not needed since r806657.

<strike>KOrganizer's reminder daemon (korgac) crashes on Windows because of recent commit. A quick fix is to go to kdelibs/ source directory and type:

<tt>svn up -r 795533 kdeui/util/ksystemtrayicon.cpp</tt>

Then compile and install the kdelibs.</strike>

====Crashes in KDED====
We sometimes need to disable creation and automatic maintenance of the KDE menu entry in the Start Menu. To do this, we can add these lines to the $KDEROOT/share/config/kwinstartmenurc file on deployment:

<code>
[General]
Enabled=false
</code>

Tip: just download the file: [https://www.intevation.de/roundup/kolab/file799/kwinstartmenurc kwinstartmenurc] and save it to the $KDEROOT/share/config/ directory.

===="Locked" dbus-daemon====
History:
*[[User:Jstaniek|jstaniek]] 18:12, 27 May 2008 (CEST): initial version for enterprise4 branch; emerge package: kdepim-branch
*[[User:Jstaniek|jstaniek]] 19:03, 28 May 2008 (CEST): update for David's commit r813498 "Ported Kontact::UniqueAppHandler to DBUS"

Introduction: upon application crash (for whatever reason), dbus-daemon (happens on Windows only) does not unregister unused service(s). Subsequent execution of the same application causes ''KUniqueApplication: Can't setup D-Bus service. Probably already running'' error and immediate exit with no visible feedback.

Reported as http://intevation.de/roundup/kolab/issue2639

Past workaround: manual killing dbus-daemon.

Rationale for the new workaround: make KDEPIM more suitable for demonstrating, without executing cryptic commands.

Workaround: If registering dbus service for KUniqueApplication (e.g. "org.kde.kmail") failed, do not exit immediately but instead:
# look if there's a process with the same name (e.g. kmail) running, if so exit with no action
# if there's no process with the same name, kill dbus-daemon (first, using SIGTERM, then SIGKILL), then restart the application with exactly the same arguments and the same current working directory.

Recipe: apply [http://www.intevation.de/roundup/kolab/file806/kuniqueapplication.patch kuniqueapplication.patch] in kdelibs and rebuild and install kdeui; this will make KUniqueApplication::start() return with false value instead of exiting().
=====Alternative solution=====
*[[User:Jstaniek|jstaniek]] 19:45, 24 June 2008 (CEST) '''patched windbus allowing to release unused service resources after client's crash''':
**in progress, testing
**changes commited to kdelibs-branch and kdepim-branch (reverts the ''"Locked" dbus-daemon'' workaround)
**windbus patch: to be published

===Other TODOs===
*KMFolderTree::cleanupConfigFile() removes kmailrc sections for nonexisting folders but the changes are not writen back ([[User:Jstaniek|jstaniek]] 11:07, 14 May 2008 (CEST))

== Notes ==
* '''The branches/work/kdab-post-4.0 branch''' ([http://websvn.kde.org/branches/work/kdab-post-4.0/kdepim/ kdepimlibs], [http://websvn.kde.org/branches/work/kdab-post-4.0/kdepim/ kdepim] modules) '''have been closed and merged into [http://websvn.kde.org/trunk/KDE/ trunk]'''. <strike>KDE PIM for Windows development happens in trunk again now.</strike>
* KDE PIM for Windows development happens in branches/kdepim/enterprise4 now.

== Links ==
* [[Projects/KDE_on_Windows|The KDE on Windows]] Project
* [[Projects/KDE on Windows/Missing features of kdelibs|Missing features of kdelibs on Windows]] - KDE PIM may depend on them

== External Links ==
*Find out how others have managed to port their software to Windows:
**[http://cs.senecac.on.ca/~david.humphrey/writing/firefox-win32-build.html Building Firefox on Windows using msvc]
**[http://wiki.mozilla.org/LDAP_C_SDK_SASL_Windows Building Cyrus SASL on Windows]

[[Category:PIM]]
[[Category:MS Windows]]