Wine Developer's Guide

Authors

Uwe Bonnes; Jonathan Buzzard; Zoran Dzelajlija; Klaas van Gend; Francois Gouget; Jon Griffiths; Albert den Haan; Mike Hearn; André Hentschel; Ove Kaaven; Tony Lambregts; Marcus Meissner; Gerard Patel; Dimitrie Paun; Michele Petrovski; Eric Pouech; Douglas Ridgway; John Sheets; Lionel Ulmer; Ulrich Weigand; Morten Welinder

Table of Contents

I. Developing Wine

1. Debugging Wine

1. Introduction
2. WineDbg modes of invocation
3. Using the Wine Debugger
4. Useful memory addresses
5. Configuration
6. WineDbg Expressions and Variables
7. WineDbg Command Reference
8. Other debuggers

2. Debug Logging

1. Debugging classes
2. Debugging channels
3. Are we debugging?
4. Helper functions
5. Controlling the debugging output
6. A Few Notes on Style

3. Other Debugging Techniques

1. Understanding undocumented APIs
2. How to do regression testing using Git
3. Which code has been tested?

4. Coding Practice

1. Patch Format
2. Some notes about style
3. Quality Assurance
4. Porting Wine to new Platforms
5. Adding New Languages

5. Writing Conformance Tests

1. Introduction
2. What to test for?
3. Running the tests in Wine
4. Cross-compiling the tests with MinGW-w64
5. Buiding and running the tests on Windows
6. Inside a Test
7. Writing good error messages
8. Handling platform issues

6. Documenting Wine

1. An Overview Of Wine Documentation
2. Writing Wine API Documentation

II. Wine Architecture

7. Overview

1. Wine Overview
2. Standard Windows Architectures
3. Wine architecture

8. Kernel modules

1. The Wine initialization process
2. Detailed memory management
3. Multi-processing in Wine
4. Multi-threading in Wine
5. Structured Exception Handling
6. File management
7. NTDLL module
8. KERNEL32 Module

9. Windowing system

1. USER32 Module
2. X Windows System interface

10. COM in Wine

1. Writing COM Components for Wine
2. A brief introduction to DCOM in Wine

11. Wine and OpenGL

1. What is needed to have OpenGL support in Wine
2. How it all works
3. Known problems

12. Outline of DirectDraw Architecture

1. DirectDraw inheritance tree
2. DirectDrawSurface inheritance tree
3. Interface Thunks
4. Logical Object Layout
5. Creating Objects

13. Wine and Multimedia

1. Overview
2. Multimedia architecture
3. Low level layers
4. Mid level drivers (MCI)
5. High level layers
6. MS ACM DLLs
7. MS Video DLLs
8. Multimedia configuration

List of Tables

1-1. WineDbg misc commands

1-2. WineDbg flow control commands

1-3. WineDbg break & watch points

1-4. WineDbg stack manipulation

1-5. WineDbg directory & source file manipulation

1-6. WineDbg list command examples

1-7. WineDbg displays

1-8. WineDbg disassembly

1-9. WineDbg memory management

1-10. WineDbg Win32 objects management

1-11. WineDbg debug channels management

1-12. WineDbg debug channels management

1-13. Debuggers comparison

7-1. Wine executables

7-2. Memory layout (Windows and Wine)

8-1. DOS, Win32 and NT paths equivalences

8-2. File systems' properties

8-3. Mapping of Windows device names into Unix device names

8-4. Function consoles implementation comparison

8-5. Console registry settings

13-1. Wine MCI drivers

13-2. Wine ACM drivers

13-3. Wine VIDC drivers

13-4. Wine multimedia configuration scheme