widl(1) - f29

1WIDL(1)                     Wine Developers Manual                     WIDL(1)
2
3
4

NAME

6       widl - Wine Interface Definition Language (IDL) compiler
7

SYNOPSIS

9       widl [options] IDL_file
10       widl [options] --dlldata-only name1 [name2...]
11

DESCRIPTION

13       When  no  options are used the program will generate a header file, and
14       possibly client and server stubs, proxy and dlldata files,  a  typelib,
15       and  a UUID file, depending on the contents of the IDL file.  If any of
16       the options -c, -h, -p, -s, -t, -u or --local-stubs is given, widl will
17       only generate the requested files, and no others.  When run with --dll‐
18       data-only, widl will only generate a dlldata file, and it will  contain
19       a  list of the names passed as arguments.  Usually the way this file is
20       updated is that each time widl is run, it reads  any  existing  dlldata
21       file,  and if necessary regenerates it with the same list of names, but
22       with the present proxy file included.
23
24       When run without any arguments, widl will print a help message.
25

OPTIONS

27       General options:
28
29       -V     Print version number and exit.
30
31       -o, --output=name
32              Set the name of the output file. When generating multiple output
33              files,  this sets only the base name of the file; the respective
34              output files are then named name.h, name_p.c, etc.   If  a  full
35              file  name with extension is specified, only that file is gener‐
36              ated.
37
38       -b, --target=cpu-manufacturer[-kernel]-os
39              Set the target architecture  when  cross-compiling.  The  target
40              specification  is in the standard autoconf format as returned by
41              config.sub.
42
43       -m32, -m64, --win32, --win64
44              Force the target architecture to 32-bit or 64-bit.
45
46       Header options:
47
48       -h     Generate header files. The default output filename is infile.h.
49
50       --oldnames
51              Use old naming conventions.
52
53       Type library options:
54
55       -t     Generate  a  type  library.  The  default  output  filename   is
56              infile.tlb.   If  the  output  file  name ends in .res, a binary
57              resource file containing the type library is generated instead.
58
59       UUID file options:
60
61       -u     Generate a UUID file. The default output filename is infile_i.c.
62
63       Proxy/stub generation options:
64
65       -c     Generate a client stub file.  The  default  output  filename  is
66              infile_c.c.
67
68       -Os    Generate inline stubs.
69
70       -Oi    Generate old-style interpreted stubs.
71
72       -Oif, -Oic, -Oicf
73              Generate new-style fully interpreted stubs.
74
75       -p     Generate a proxy. The default output filename is infile_p.c.
76
77       --prefix-all=prefix
78              Prefix to put on the name of both client and server stubs.
79
80       --prefix-client=prefix
81              Prefix to put on the name of client stubs.
82
83       --prefix-server=prefix
84              Prefix to put on the name of server stubs.
85
86       -s     Generate  a  server  stub  file.  The default output filename is
87              infile_s.c.
88
89       --winrt
90              Enable Windows Runtime mode.
91
92       --ns_prefix
93              Prefix namespaces with ABI namespace.
94
95       Registration script options:
96
97       -r     Generate a registration script. The default output  filename  is
98              infile_r.rgs.  If  the  output  file name ends in .res, a binary
99              resource file containing the script is generated instead.
100
101       Dlldata file options:
102
103       --dlldata-only name1 [name2...]
104              Regenerate the dlldata file from  scratch  using  the  specified
105              proxy names. The default output filename is dlldata.c.
106
107       Preprocessor options:
108
109       -I path
110              Add  a header search directory to path. Multiple search directo‐
111              ries are allowed.
112
113       -D id[=val]
114              Define preprocessor macro id with value val.
115
116       -E     Preprocess only.
117
118       -N     Do not preprocess input.
119
120       Debug options:
121
122       -W     Enable pedantic warnings.
123
124       -d n   Set debug level to the non negative integer n.  If prefixed with
125              0x,  it  will  be interpreted as an hexadecimal number.  For the
126              meaning of values, see the DEBUG section.
127
128       Miscellaneous options:
129
130       -app_config
131              Ignored, present for midl compatibility.
132
133       --acf=file
134              Use specified application configuration file.
135
136       --local-stubs=file
137              Generate empty stubs for  call_as/local  methods  in  an  object
138              interface and write them to file.
139

DEBUG

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

BUGS

150       Bugs can be reported on the Wine bug tracker ⟨https://bugs.winehq.org⟩.
151

AUTHORS

153       widl  was originally written by Ove Kåven.  It has been improved by Rob
154       Shearman, Dan Hipschman, and others.  For a complete list, see the  git
155       commit  logs.   This  man page was originally written by Hannu Valtonen
156       and then updated by Dan Hipschman.
157

AVAILABILITY

159       widl is part of the  Wine  distribution,  which  is  available  through
160       WineHQ, the Wine development headquarters ⟨https://www.winehq.org/⟩.
161