GSOC2014WindowsPort

GSOC 2014: Windows Port

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

Work items

Identify POSIX-specific functionality

Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

Minimal GCC/MinGW build

In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

Documentation

Documentation on how to build OLA on Windows can be found on the wiki and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

Unit tests

After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

Network-based plugins

Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

Example programs

Since the example programs use libola, they serve as a first test of the port's usability for client programs.

Installer

In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

MSVC support

Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

olad service

The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

Python interface

For this item, the Python binding will be enabled on Windows as well.

Device plugins

Depending on hardware availability, plugins for various I/O devices will be ported.

Testing and CI

In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

I18N issues

Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

Status

Item	Status	Comments
POSIX Functionality	In progress
Minimal build	In progress	Current configure options: ./configure --disable-doxygen-doc --disable-examples --disable-http --disable-libftdi --disable-libusb --disable-osc --disable-root-check --disable-slp --disable-artnet --disable-dmx4linux --disable-dummy --disable-e131 --disable-espnet --disable-ftdidmx --disable-karate --disable-kinet --disable-milinst --disable-opendmx --disable-osc --disable-pathport --disable-renard --disable-sandnet --disable-shownet --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx The minimal build completes, but runtime functionality is not there yet. See also "Unit tests" below
Documentation	In progress
Unit tests	In progress	Unit tests up to (but not including) common/web pass
Network-based plugins	pending
Example programs	pending
Installer	pending
MSVC support	optional / after GSOC
olad service	optional / after GSOC
Python interface	optional / after GSOC
Device plugins	optional / after GSOC
Testing and CI	optional / after GSOC
I18N issues	optional / after GSOC