WIDL

Section: Wine Developers Manual (1)
Updated: October 2007
Index Return to Main Contents
 

NAME

widl - Wine Interface Definition Language (IDL) compiler  

SYNOPSIS

widl [options] infile.idl
widl [options] --dlldata-only name1 [name2 ...]  

DESCRIPTION

When no options are used the program will generate a header file, and possibly client and server stubs, proxy and dlldata files, a typelib, and a UUID file, depending on the contents of the IDL file. If any of the options -c, -h, -p, -s, -t, -u, or --local-stubs are given, widl will only generate the requested files, and no others. When run with --dlldata-only, widl will only generate a dlldata file, and it will contain a list of the names passed as arguments. Usually the way this file is updated is that each time widl is run, it reads any existing dlldata file, and if necessary regenerates it with the same list of names, but with the present proxy file included.

When run without any arguments, widl will print a help message.

 

OPTIONS

General options:

-V
Print version number and exit.

Header options:

-h
Generate header files.
-H file
Name of header file to generate. The default header filename is infile.h.
--oldnames
Use old naming conventions.

Type library options:

-t
Generate a type library.
-T file
Define the name of the type library to be generated. The default filename is infile.tlb.

UUID file options:

-u
Generate a UUID file.
-U file
Define the name of the UUID file to be generated. The default filename is infile_i.c.

Proxy/stub generation options:

-c
Generate client stub.
-C file
Name of client stub file (default is infile_c.c)
-p
Generate proxy.
-P file
Name of proxy file (default is infile_p.c)
--prefix-all=prefix
Prefix to put on the name of both client and server stubs.
--prefix-client=prefix
Prefix to put on the name of client stubs.
--prefix-server=prefix
Prefix to put on the name of server stubs.
-s
Generate server stub.
-S file
Name of server stub file (default is infile_s.c)

Dlldata file options:

--dlldata=file
Name of the dlldata file (default is dlldata.c)

Preprocessor options:

-I path
Add a header search directory to path. Multiple search directories are allowed.
-D id[=val]
Define preprocessor macro id with value val.
-E
Preprocess only.
-N
Do not preprocess input.

Debug options:

-W
Enable pedantic warnings.
-d n
Set debug level to the non negative integer n. If prefixed with 0x, it will be interpreted as an hexadecimal number. For the meaning of values, see the Debug section.

Miscellaneous options:

--local-stubs=file
Generate empty stubs for call_as/local methods in an object interface and write them to file.

 

Debug

Debug level n is a bitmask with the following meaning:
    * 0x01 Tell which resource is parsed (verbose mode)
    * 0x02 Dump internal structures
    * 0x04 Create a parser trace (yydebug=1)
    * 0x08 Preprocessor messages
    * 0x10 Preprocessor lex messages
    * 0x20 Preprocessor yacc trace  

BUGS

widl is incomplete. Please file bug reports for this application at http://bugs.winehq.org.  

AUTHORS

widl was originally written by Ove Kaaven. It has been improved by Rob Shearman, Dan Hipschman, and others. For a complete list, see the git commit logs. This man page was originally written by Hannu Valtonen and then updated by Dan Hipschman.  

SEE ALSO

The Winelib User Guide
The Wine Developers Guide


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
Debug
BUGS
AUTHORS
SEE ALSO

linux.jgfs.net manual pages