Projects/KDE on Windows/Porting Guidelines - Revision history

Jstaniek: /* Templates */

2011-11-25T20:24:26Z

‎Templates

Jstaniek: /* Application icons */

2011-11-25T20:10:38Z

‎Application icons

Neverendingo: Text replace - "`" to ""`


2011-06-29T19:59:44Z
Text replace - "<code c>" to "<syntaxhighlight lang="c">"

				
				
				
				
			
			← Older revision
			Revision as of 19:59, 29 June 2011
			
Line 33:
Line 33:
    
  Use   Use
− <code c> + <syntaxhighlight lang="c">
     #ifdef Q_WS_X11      #ifdef Q_WS_X11
     ....      ....
Line 41:
Line 41:
    
  Use   Use
− <code c> + <syntaxhighlight lang="c">
     #ifdef Q_OS_UNIX      #ifdef Q_OS_UNIX
     ....      ....
Line 49:
Line 49:
    
  Use   Use
− <code c> + <syntaxhighlight lang="c">
     #ifdef Q_WS_WIN      #ifdef Q_WS_WIN
     ....      ....
Line 58:
Line 58:
  ===C code===   ===C code===
  Note that qglobal.h is C++-only, so instead use   Note that qglobal.h is C++-only, so instead use
− <code c> + <syntaxhighlight lang="c">
     #ifdef _WIN32      #ifdef _WIN32
     ....      ....
Line 107:
Line 107:
  ===Common header file===   ===Common header file===
  Unless there is are any header file from kdelibs included in your header file, you need to add:   Unless there is are any header file from kdelibs included in your header file, you need to add:
− <code c> + <syntaxhighlight lang="c">
    #include <kdemacros.h>       #include <kdemacros.h>  
  </syntaxhighlight>   </syntaxhighlight>
  or   or
− <code c> + <syntaxhighlight lang="c">
    #include <kdecore_export.h>       #include <kdecore_export.h>  
  </syntaxhighlight>   </syntaxhighlight>



Neverendingo: /* Absolute directory checking */
2011-06-29T19:59:12Z
‎Absolute directory checking

				
				
				
				
			
			← Older revision
			Revision as of 19:59, 29 June 2011
			
Line 11:
Line 11:
  Look for '/' and "/" and change every single code like:   Look for '/' and "/" and change every single code like:
    
− <code c> + <syntaxhighlight lang="c">
     if (path[0]=='/')      if (path[0]=='/')
  </syntaxhighlight>   </syntaxhighlight>



Neverendingo: Text replace - "" to ""

2011-06-29T19:54:04Z
Text replace - "<code cppqt>" to "<syntaxhighlight lang="cpp-qt">"

				
				
				
				
			
			← Older revision
			Revision as of 19:54, 29 June 2011
			
Line 16:
Line 16:
  or:   or:
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
     if (path.startsWith('/'))      if (path.startsWith('/'))
  </syntaxhighlight>   </syntaxhighlight>
  with:   with:
    
− <code cppqt> + <syntaxhighlight lang="cpp-qt">
     if (!QDir::isRelativePath(path))      if (!QDir::isRelativePath(path))
  </syntaxhighlight>   </syntaxhighlight>



Neverendingo: Text replace - "" to ""

2011-06-29T19:48:48Z
Text replace - "<code bash>" to "<syntaxhighlight lang="bash">"

				
				
				
				
			
			← Older revision
			Revision as of 19:48, 29 June 2011
			
Line 238:
Line 238:
  ... but compiler complains about too many arguments passed to K_EXPORT_COMPONENT_FACTORY. To avoid this, you can use __typedef__:   ... but compiler complains about too many arguments passed to K_EXPORT_COMPONENT_FACTORY. To avoid this, you can use __typedef__:
    
− <code bash> + <syntaxhighlight lang="bash">
  typedef KRES::PluginFactory<ResourceExchange,ResourceExchangeConfig>  MyFactory;   typedef KRES::PluginFactory<ResourceExchange,ResourceExchangeConfig>  MyFactory;
  K_EXPORT_COMPONENT_FACTORY(resourcecalendarexchange, MyFactory)   K_EXPORT_COMPONENT_FACTORY(resourcecalendarexchange, MyFactory)



Neverendingo: Text replace - "" to ""
2011-06-29T19:42:27Z
Text replace - "</code>" to "</syntaxhighlight>"

				
				
				
				
			
			← Older revision
			Revision as of 19:42, 29 June 2011
			
Line 13:
Line 13:
  <code c>   <code c>
     if (path[0]=='/')      if (path[0]=='/')
− </code> + </syntaxhighlight>
  or:   or:
    
  <code cppqt>   <code cppqt>
     if (path.startsWith('/'))      if (path.startsWith('/'))
− </code> + </syntaxhighlight>
  with:   with:
    
  <code cppqt>   <code cppqt>
     if (!QDir::isRelativePath(path))      if (!QDir::isRelativePath(path))
− </code> + </syntaxhighlight>
  (or "QDir::isRelativePath(path)" if there was used path[[0]!='/').   (or "QDir::isRelativePath(path)" if there was used path[[0]!='/').
    
Line 37:
Line 37:
     ....      ....
  #endif   #endif
− </code> + </syntaxhighlight>
  for any C++ code that looks like X11-only.   for any C++ code that looks like X11-only.
    
Line 45:
Line 45:
     ....      ....
  #endif   #endif
− </code> + </syntaxhighlight>
  for any C++ code that looks like UNIX-only, for example uses UNIX-specific OS features.   for any C++ code that looks like UNIX-only, for example uses UNIX-specific OS features.
    
Line 53:
Line 53:
     ....      ....
  #endif   #endif
− </code> + </syntaxhighlight>
  for any C++ code that is MSWindows-only.   for any C++ code that is MSWindows-only.
    
Line 62:
Line 62:
     ....      ....
  #endif   #endif
− </code> + </syntaxhighlight>
    
  for any C code that is MSWindows-only (regardless to compiler type).   for any C code that is MSWindows-only (regardless to compiler type).
Line 73:
Line 73:
     ....//msvc code      ....//msvc code
  #endif   #endif
− </code> + </syntaxhighlight>
    
  ====MS Visual C++ - Qt code====   ====MS Visual C++ - Qt code====
Line 80:
Line 80:
     ....//msvc code      ....//msvc code
  #endif   #endif
− </code> + </syntaxhighlight>
    
  ====Borland C++ - Qt-independent code (especially, C code)====   ====Borland C++ - Qt-independent code (especially, C code)====
Line 87:
Line 87:
     ....//borland code      ....//borland code
  #endif   #endif
− </code> + </syntaxhighlight>
    
  ====Borland C++ - Qt code====   ====Borland C++ - Qt code====
Line 94:
Line 94:
     ....//borland code      ....//borland code
  #endif   #endif
− </code> + </syntaxhighlight>
    
  ===General notes===   ===General notes===
Line 109:
Line 109:
  <code c>   <code c>
    #include <kdemacros.h>       #include <kdemacros.h>  
− </code> + </syntaxhighlight>
  or   or
  <code c>   <code c>
    #include <kdecore_export.h>       #include <kdecore_export.h>  
− </code> + </syntaxhighlight>
  at the beginning of your header file to have some necessary system-independent macros defined.   at the beginning of your header file to have some necessary system-independent macros defined.
    
Line 128:
Line 128:
  ...   ...
  };   };
− </code> + </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.     '''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.  
Line 137:
Line 137:
  #define KDE_NO_EXPORT __attribute__ ((visibility("hidden")))   #define KDE_NO_EXPORT __attribute__ ((visibility("hidden")))
  #define KDE_EXPORT __attribute__ ((visibility("default")))   #define KDE_EXPORT __attribute__ ((visibility("default")))
− </code> + </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).   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).
Line 149:
Line 149:
         set_target_properties(${_target_NAME} PROPERTIES DEFINE_SYMBOL ${_symbol})          set_target_properties(${_target_NAME} PROPERTIES DEFINE_SYMBOL ${_symbol})
  endif (WIN32)     endif (WIN32)  
− </code> + </syntaxhighlight>
    
  ===Exporting global functions===   ===Exporting global functions===
Line 159:
Line 159:
    KDEFOO_EXPORT int publicFunction();     KDEFOO_EXPORT int publicFunction();
  }   }
− </code> + </syntaxhighlight>
    
  ===What not to export?===   ===What not to export?===
Line 169:
Line 169:
  template <class T>   template <class T>
  class KGenericFactoryBase   class KGenericFactoryBase
− </code> + </syntaxhighlight>
    
    
Line 183:
Line 183:
  ...   ...
  };   };
− </code> + </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):   ..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):
Line 191:
Line 191:
  #  define KABC_EXPORT_DEPRECATED KDE_DEPRECATED KABC_EXPORT   #  define KABC_EXPORT_DEPRECATED KDE_DEPRECATED KABC_EXPORT
  # endif   # endif
− </code> + </syntaxhighlight>
    
  So, we have following example of deprecated class:   So, we have following example of deprecated class:
Line 199:
Line 199:
  ...   ...
  };   };
− </code> + </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.   .. 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.
Line 212:
Line 212:
  <syntaxhighlight lang="cpp">   <syntaxhighlight lang="cpp">
    extern "C" {void *init_libname() { return new factory; } };     extern "C" {void *init_libname() { return new factory; } };
− </code> + </syntaxhighlight>
  ...because the former way is more portable (contains proper export macro, which ensures visiblility of "init_libname" symbol).   ...because the former way is more portable (contains proper export macro, which ensures visiblility of "init_libname" symbol).
    
Line 220:
Line 220:
       GenericFactory<InsertFilePlugin>( "ktexteditor_insertfile" ) )          GenericFactory<InsertFilePlugin>( "ktexteditor_insertfile" ) )  
  K_EXPORT_COMPONENT_FACTORY( libkatepart, KateFactoryPublic )   K_EXPORT_COMPONENT_FACTORY( libkatepart, KateFactoryPublic )
− </code> + </syntaxhighlight>
    
  ===More complex case===   ===More complex case===
Line 234:
Line 234:
     }      }
  }   }
− </code> + </syntaxhighlight>
    
  ... but compiler complains about too many arguments passed to K_EXPORT_COMPONENT_FACTORY. To avoid this, you can use __typedef__:   ... but compiler complains about too many arguments passed to K_EXPORT_COMPONENT_FACTORY. To avoid this, you can use __typedef__:
Line 241:
Line 241:
  typedef KRES::PluginFactory<ResourceExchange,ResourceExchangeConfig>  MyFactory;   typedef KRES::PluginFactory<ResourceExchange,ResourceExchangeConfig>  MyFactory;
  K_EXPORT_COMPONENT_FACTORY(resourcecalendarexchange, MyFactory)   K_EXPORT_COMPONENT_FACTORY(resourcecalendarexchange, MyFactory)
− </code> + </syntaxhighlight>
    
  The same trick can be used if the constructor of the factory takes multiple arguments.   The same trick can be used if the constructor of the factory takes multiple arguments.



Neverendingo: Text replace - "" to ""

2011-06-29T19:38:55Z
Text replace - "<code cpp>" to "<syntaxhighlight lang="cpp">"

				
				
				
				
			
			← Older revision
			Revision as of 19:38, 29 June 2011
			
Line 69:
Line 69:
    
  ====MS Visual C++ - Qt-independent code (especially, C code)====   ====MS Visual C++ - Qt-independent code (especially, C code)====
− <code cpp> + <syntaxhighlight lang="cpp">
     #ifdef _MSC_VER      #ifdef _MSC_VER
     ....//msvc code      ....//msvc code
Line 76:
Line 76:
    
  ====MS Visual C++ - Qt code====   ====MS Visual C++ - Qt code====
− <code cpp> + <syntaxhighlight lang="cpp">
     #ifdef Q_CC_MSVC      #ifdef Q_CC_MSVC
     ....//msvc code      ....//msvc code
Line 83:
Line 83:
    
  ====Borland C++ - Qt-independent code (especially, C code)====   ====Borland C++ - Qt-independent code (especially, C code)====
− <code cpp> + <syntaxhighlight lang="cpp">
     #ifdef __BORLANDC__      #ifdef __BORLANDC__
     ....//borland code      ....//borland code
Line 90:
Line 90:
    
  ====Borland C++ - Qt code====   ====Borland C++ - Qt code====
− <code cpp> + <syntaxhighlight lang="cpp">
     #ifdef Q_CC_BOR      #ifdef Q_CC_BOR
     ....//borland code      ....//borland code
Line 124:
Line 124:
  Example:   Example:
    
− <code cpp> + <syntaxhighlight lang="cpp">
  class KDEFOO_EXPORT FooClass {   class KDEFOO_EXPORT FooClass {
  ...   ...
Line 134:
Line 134:
  '''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:   '''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:
    
− <code cpp> + <syntaxhighlight lang="cpp">
  #define KDE_NO_EXPORT __attribute__ ((visibility("hidden")))   #define KDE_NO_EXPORT __attribute__ ((visibility("hidden")))
  #define KDE_EXPORT __attribute__ ((visibility("default")))   #define KDE_EXPORT __attribute__ ((visibility("default")))
Line 142:
Line 142:
    
  '''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:   '''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:
− <code cpp> + <syntaxhighlight lang="cpp">
      if (WIN32)       if (WIN32)
         # for shared libraries/plugins a -DMAKE_target_LIB is required          # for shared libraries/plugins a -DMAKE_target_LIB is required
Line 155:
Line 155:
    
  Example:   Example:
− <code cpp> + <syntaxhighlight lang="cpp">
  namespace Foo {   namespace Foo {
    KDEFOO_EXPORT int publicFunction();     KDEFOO_EXPORT int publicFunction();
Line 166:
Line 166:
  * template classes, e.g.:   * template classes, e.g.:
    
− <code cpp> + <syntaxhighlight lang="cpp">
  template <class T>   template <class T>
  class KGenericFactoryBase   class KGenericFactoryBase
Line 179:
Line 179:
  Before porting KDElibs to win32, I realized that deprecated classes already use KDE_DEPRECATED macro. We're unable to add another macro like this:   Before porting KDElibs to win32, I realized that deprecated classes already use KDE_DEPRECATED macro. We're unable to add another macro like this:
    
− <code cpp> + <syntaxhighlight lang="cpp">
  class KDEFOO_EXPORT KDE_DEPRECATED FooClass { //< - bad for moc!   class KDEFOO_EXPORT KDE_DEPRECATED FooClass { //< - bad for moc!
  ...   ...
Line 187:
Line 187:
  ..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):   ..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):
    
− <code cpp> + <syntaxhighlight lang="cpp">
  # ifndef KABC_EXPORT_DEPRECATED   # ifndef KABC_EXPORT_DEPRECATED
  #  define KABC_EXPORT_DEPRECATED KDE_DEPRECATED KABC_EXPORT   #  define KABC_EXPORT_DEPRECATED KDE_DEPRECATED KABC_EXPORT
Line 195:
Line 195:
  So, we have following example of deprecated class:   So, we have following example of deprecated class:
    
− <code cpp> + <syntaxhighlight lang="cpp">
  class KABC_EXPORT_DEPRECATED FooClass { //<- ok for moc   class KABC_EXPORT_DEPRECATED FooClass { //<- ok for moc
  ...   ...
Line 210:
Line 210:
    
  Use K_EXPORT_COMPONENT_FACTORY( libname, factory ), defined in klibloader.h, instead of hardcoding:   Use K_EXPORT_COMPONENT_FACTORY( libname, factory ), defined in klibloader.h, instead of hardcoding:
− <code cpp> + <syntaxhighlight lang="cpp">
    extern "C" {void *init_libname() { return new factory; } };     extern "C" {void *init_libname() { return new factory; } };
  </code>   </code>
Line 216:
Line 216:
    
  Examples:     Examples:  
− <code cpp> + <syntaxhighlight lang="cpp">
  K_EXPORT_COMPONENT_FACTORY( ktexteditor_insertfile,   K_EXPORT_COMPONENT_FACTORY( ktexteditor_insertfile,
       GenericFactory<InsertFilePlugin>( "ktexteditor_insertfile" ) )          GenericFactory<InsertFilePlugin>( "ktexteditor_insertfile" ) )  
Line 226:
Line 226:
  Sometimes you need to declare a factory which defined as a template with multiple arguments, eg.:   Sometimes you need to declare a factory which defined as a template with multiple arguments, eg.:
    
− <code cpp> + <syntaxhighlight lang="cpp">
  extern "C"   extern "C"
  {   {



Spider-mario: Actually, _WIN32 *is* defined on 64-bits Windows. Source: http://msdn.microsoft.com/en-us/library/b0084kay(VS.80).aspx
2010-11-06T19:59:39Z
Actually, _WIN32 *is* defined on 64-bits Windows. Source: http://msdn.microsoft.com/en-us/library/b0084kay(VS.80).aspx

				
				
				
				
			
			← Older revision
			Revision as of 19:59, 6 November 2010
			
Line 59:
Line 59:
  Note that qglobal.h is C++-only, so instead use   Note that qglobal.h is C++-only, so instead use
  <code c>   <code c>
−    #ifdef _WINDOWS +    #ifdef _WIN32
     ....      ....
  #endif   #endif
  </code>   </code>
    
− for any C code that is MSWindows-only (regardless to compiler type). In fact, you could use built-in _WIN32 but it's not defined on incoming 64bit MS Windows platform (_WIN64 is used there). So, there's a global rule for kdelibs/win32 defined globally in your build system (you don't need to include any file for this). + 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?===   === Rare cases: How to check in Windows-only code which compiler is used?===



SaroEngels: /* General notes */
2009-07-15T23:09:24Z
‎General notes

				
				
				
				
			
			← Older revision
			Revision as of 23:09, 15 July 2009
			
Line 99:
Line 99:
  In many places using #ifdef Q_OS_UNIX / #else / #endif is more readable than separate #ifdefs.   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 in kde's bugzilla, so that those can be fixed later. + '''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===   ===Related links===

@@ Line 247: / Line 247: @@
 ==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:
@@ Line 262: / Line 263: @@
 </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...]]

@@ Line 244: / Line 244: @@
 The same trick can be used if the constructor of the factory takes multiple arguments.
 ==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 - Revision history

Jstaniek: /* Templates */

Jstaniek: /* Application icons */

Neverendingo: Text replace - "`" to ""`

Neverendingo: /* Absolute directory checking */

Neverendingo: Text replace - "`" to ""`

Neverendingo: Text replace - "`" to ""`

`Neverendingo: Text replace - "`" to ""

Neverendingo: Text replace - "`" to ""`

Spider-mario: Actually, _WIN32 is defined on 64-bits Windows. Source: http://msdn.microsoft.com/en-us/library/b0084kay(VS.80).aspx

SaroEngels: /* General notes */