Porting to TDE - Revision history

Blu256: Fix typo, move TODO into Widget styles section

2023-05-01T09:08:10Z

Fix typo, move TODO into Widget styles section

2022-07-21T10:34:47Z

Widget styles porting: Added example commit

2022-03-29T17:49:10Z

Software: Adjusted path

2022-03-29T17:48:05Z

Autoconf: added warning

2022-03-29T17:41:07Z

Software: Additional steps for git commits

2022-03-29T17:33:55Z

Build system: Added instructions for temporarily using admin submodule for autoconf

2022-02-16T17:28:04Z

Removed section Window decorations

2022-02-16T17:27:26Z

Build system: added porting notes

2022-02-16T17:18:58Z

Widget styles: moved warning box

2022-02-16T17:18:15Z

Software: added porting steps

@@ Line 1: / Line 1: @@
-{{TODO}}
 This page is intended to provide generic instructions for porting old KDE3 software to the Trinity libraries.
@@ Line 43: / Line 41: @@
 </syntaxhighlight>
-. Replace all <code><ntq*.h></code> headers with <code><tq*.h></code> ones in order to use the TQt-TDE interface (simply remove the <tt>t</tt> letter). This can be done with a small script:
+. Replace all <code><ntq*.h></code> headers with <code><tq*.h></code> ones in order to use the TQt-TDE interface (simply remove the <tt>n</tt> letter from the front of the header's filename). This can be automated with a small script:
 <syntaxhighlight lang="shell">
@@ Line 67: / Line 65: @@
 == Widget styles ==
+{{TODO}}
 {{WarningBox|text=The '''TQt API docs''' do not currently seem to reflect the API changes described here.}}

@@ Line 76: / Line 76: @@
 * <tt>SH_UnderlineAccelerator</tt> has been extended with a new style hint, <tt>SH_HideUnderlineAcceleratorWhenAltUp</tt>.
-Porting an existing style to the new API is relatively straightforward; simply update the function definitions in the existing style with the new definition prototypes and cast the passed pointer to TQWidget or TQObject where appropriate.
+Porting an existing style to the new API is relatively straightforward; simply update the function definitions in the existing style with the new definition prototypes and cast the passed pointer to TQWidget or TQObject where appropriate. You can see this in practice if you look into the relevant commits of already ported widget styles. See [https://mirror.git.trinitydesktop.org/gitea/TDE/tde-style-ia-ora/commit/d4a24866b531801cace227c1d09fda763cbca8ac this commit of tde-style-ia-ora] for example.
 [[Category:Developers]]

@@ Line 40: / Line 40: @@
 . Run the Qt3→TQt conversion script.
 <syntaxhighlight lang="shell-session">
-$ scripts/conversions/qt3-tqt3/convert_existing_qt3_app_to_tqt3
+$ ../scripts/conversions/qt3-tqt3/convert_existing_qt3_app_to_tqt3
 </syntaxhighlight>
@@ Line 57: / Line 57: @@
 . Run the KDE3→TDE conversion script.
 <syntaxhighlight lang="shell-session">
-$ scripts/conversions/kde-tde/convert_existing_kde3_app_to_tde
+$ ../scripts/conversions/kde-tde/convert_existing_kde3_app_to_tde
 </syntaxhighlight>

@@ Line 19: / Line 19: @@
 $ git submodule add https://mirror.git.trinitydesktop.org/gitea/TDE/tde-common-admin admin
 </syntaxhighlight>
+If you do this before actually porting the software, make sure the porting scripts do not overwrite anything in the <tt>admin</tt> directory where the submodule resides: you might get strange errors like <tt>configure</tt> being unable to locate TQt.
 When you've got things building you '''should''' port the software to CMake.

@@ Line 34: / Line 34: @@
 . Switch into the directory containing the source code.
+. Create an initial commit with the original form of the source code.
-. Run the Qt3→TQt conversion script.
+. Run the Qt3→TQt conversion script.
 <syntaxhighlight lang="shell-session">
 $ scripts/conversions/qt3-tqt3/convert_existing_qt3_app_to_tqt3
 </syntaxhighlight>
 . Replace all <code><ntq*.h></code> headers with <code><tq*.h></code> ones in order to use the TQt-TDE interface (simply remove the <tt>t</tt> letter). This can be done with a small script:
 <syntaxhighlight lang="shell">
@@ Line 49: / Line 51: @@
 </syntaxhighlight>
-. Run the KDE3→TDE conversion script.
+. Commit your changes labeled "Qt3→TQt conversion" or similarly.
+. Run the KDE3→TDE conversion script.
 <syntaxhighlight lang="shell-session">
 $ scripts/conversions/kde-tde/convert_existing_kde3_app_to_tde
 </syntaxhighlight>
+. Commit your changes labeled "KDE3→TDE conversion" or similarly.
-. Try to build. If this fails take note of the errors and fix them.
+. Try to build. If this fails take note of the errors and fix them. Don't forget to commit your changes describing what you fixed.
-For Qt3-only apps follow steps 1 to 3.
+For Qt3-only apps follow steps 1 to 5.
 == Widget styles ==

@@ Line 10: / Line 10: @@
 More specific notes can be found in other Wiki articles, depending on what you are trying to port.
+=== Autoconf ===
+While porting you might want to keep the existing build system (until you figure out how everything works). To do this, remove the bundled <tt>admin</tt> directory and then clone  the <tt>tde-common-admin</tt> submodule in the place of the removed directory:
+<syntaxhighlight lang="shell-session">
+$ git rm -r admin
+$ git submodule add https://mirror.git.trinitydesktop.org/gitea/TDE/tde-common-admin admin
+</syntaxhighlight>
+When you've got things building you '''should''' port the software to CMake.
 == Software ==

@@ Line 5: / Line 5: @@
 == Build system ==
+Trinity software uses CMake with [https://mirror.git.trinitydesktop.org/gitea/TDE/tde-common-cmake custom macros]. Since R14.0.11 these macros are automatically installed as part of Trinity, so you don't need to worry about including them as a submodule anymore.
+The best way to get a hang of how it all works is to take a look at how CMake is used in an existing project. For simplicity take a standalone app package as an example (e.g. [https://mirror.git.trinitydesktop.org/gitea/TDE/mathemagics/ Mathemagics]). Note the files named <tt>CMakeLists.txt</tt>, <tt>CMakeL10n.txt</tt>, <tt>ConfigureChecks.cmake</tt> and <tt>config.h.cmake</tt> and how they configure, build and link the software.
+More specific notes can be found in other Wiki articles, depending on what you are trying to port.
 == Software ==

@@ Line 43: / Line 43: @@
 == Widget styles ==
+{{WarningBox|text=The '''TQt API docs''' do not currently seem to reflect the API changes described here.}}
 The TQt Style API has [https://mirror.git.trinitydesktop.org/gitea/TDE/tqt3/src/branch/master/changes-3.5 undergone] [https://mirror.git.trinitydesktop.org/cgit/qt3/commit/?id=0008bc5bcd95694b38b0d0322aac2ea6fdb21298 some important changes], so porting a widget style to TDE will entail a little more than just running scripts.
@@ Line 52: / Line 53: @@
 Porting an existing style to the new API is relatively straightforward; simply update the function definitions in the existing style with the new definition prototypes and cast the passed pointer to TQWidget or TQObject where appropriate.
-{{WarningBox|text=The '''TQt API docs''' do not currently seem to reflect these changes.}}
 == Window decorations ==