HAMLIB SDK Version 3 Evolving the JT-ware Software Developer's Kit (JTSDK)

General Guide for Building Software

Introduction

Note: This page has been deprecated in favour of x86 and x64 build notes.

This kit maintains two environments:

• A PowerShell based environment that supports a powerful and flexible scripting language that can script the build of software. This environment also sets up a powerful set of environment variables that makes accessing tools (such as Hamlib) simpler.
• A MSYS2 based environment that basically mimics Linux environments with GNU compilers and tools. WIthin this environment there are anumber of sub-environments:
• A plain MSYS2 environment, designed to be used with the Qt-supplied compilers - launched with mingw64 from within the PowerShell environment. Note:  the bare-bones msys2 environment is no longer recommended for building software yet is recommended for kit maintenance. 
• GNU-Compiler-accessible environments, lauched under the PowerShell environment with one of the following commands:
• mingw64 - an environment designed for 64-bit software compilation with the GCC compiler suite.
• mingw32 - an environment designed for 32-bit software compilation with the GCC compiler suite.
• ucrtw64 - an environment designed for 64-bit software compilation under the Universal C Runtime. It should ideally work and behave as if the code was compiled with MS Visual Studio 2022. This environ is not supported.
• clang64 - an environment designed for 64-bit software compilation The clang executable is actually a small driver which controls the overall execution of other tools such as the compiler, assembler and linker. It must at the moment be used with with the GCC compiler suite. This environ is not supported.

Only the mingw64 will be actively discussed on this site (although techniques for 32-bit builds within a 64-bit environment are provided under the JTSDK-3.2.0-stream)

Note that this document provides many generalisations to simplify discussion. Please research each tool fully beofer use. 

The following site may be a good place to start your learning exercise add C:\JTSDK64-Tools\tools to any paths shown in this video):

• Install MSYS2 and MinGW-w64 (2024) and build C/C++ files on Windows

Using the PowerShell Environment

As stated above this highly scriptable environment basically provides a raft of environment variables that aid in accessing many of the libraries needed to build Hamlib and JT-ware.

The environment is quite complex and is far too complex in reality to dicuss here. It should be dissected as follows:

• Examine the environment with the following PowerShell command:
• dir env:

Examine the PowerShell commandlets found in:

• c:\JTSDK64-Tools\tools\scripts

The most important script to examine is jtbuild.ps1 should you feel that you have a need to use this environment to automate build processes.

Using the MSYS2 Environment

MSYS2 is software distribution and a building platform for Windows. It provides a Unix-like environment, a command-line interface and a software repository making it easier to install, use, build and port software on Windows. That means Bash, Autotools, Make, Git, GCC, GDB..., all easily installable through pacman, a fully-featured package manager (ref: https://www.msys2.org/wiki/MSYS2-introduction/).

Red the descriptions at https://www.msys2.org/wiki/MSYS2-introduction/ carefully before proceding further.

The pacman package manager

Libraries and tools are added via the pacman package manager.

The example below demonstrates how to add packages within the MSYS2 environment:

• Execute the following command inside the JTSDK-Tools environment:
• msys2
• Execute the following commands (as an example) inside the MSYS2 environment:
• pacman -S msys2-runtime-devel mingw-w64-cross-binutils (see https://groups.io/g/JTSDK/topic/knowledgebase_ioctl_h/85578130 )

The MSYS2 environment with the Qt-supplied Compilers

The JTSDK requires that the Qt-SDK and its mingw81 or mingw112 support be deployed.

This mingwXX support tools provide the GNU compilers and access to the rich Qt-compiler library sets

To access this environment perform the following steps inside the JTSDK64-Tools environment:

• Type: menu
• Select the following options from the menu:
• Select Option 1 Set MSYS2 path to find Qt compilers

This should now provide access to an environment (with cmake provided) where software can be built.

The mingw64 environment

This is now the recommended environment for developing any software within the JTSDK.

This provides a stand-alone set of GNU compilers. All relies on the libraries and tools delivered to the MSYS2 base environment.

This in itself can be somewhat tricky; some tools are delivered ONLY for the mingw64 environment; others are for the base MSYS2 environment.

Sometimes we need to "break rules" and set software configuration and build options so that they search both the mingw64 and MSYS2 directory source paths.

To access this environment:

• from the JTSDK64-Tools environment type: mingw64
• Add any necessary libraries using the pacman -S command.

This should now provide access to an environment where software can be built according to the Linux build instructions.

Other environments: mingw32, clang64 and ucrt64

The aim is to make as many scripts and utilities as possible compatible with a mingw32 environment or for scripts to require minimal adjustmen/patches to compile x86 software,  

Work on this task will be ongoing. It is possible that future kits may disable these environments.    

The clang64 and ucrt64 environments will not be covered or supported by the JTSDK. See:

• https://www.msys2.org/wiki/MSYS2-introduction/

References

• https://www.msys2.org/docs/environments/
• https://clang.llvm.org/docs/CommandGuide/clang.html