widl(1) - f32

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       --sysroot=dir
47              Prefix the standard include paths with dir.
48
49       --nostdinc
50              Do not search  standard  include  paths  like  /usr/include  and
51              /usr/local/include.
52
53       Header options:
54
55       -h     Generate header files. The default output filename is infile.h.
56
57       --oldnames
58              Use old naming conventions.
59
60       Type library options:
61
62       -t     Generate   a  type  library.  The  default  output  filename  is
63              infile.tlb.  If the output file name  ends  in  .res,  a  binary
64              resource file containing the type library is generated instead.
65
66       UUID file options:
67
68       -u     Generate a UUID file. The default output filename is infile_i.c.
69
70       Proxy/stub generation options:
71
72       -c     Generate  a  client  stub  file.  The default output filename is
73              infile_c.c.
74
75       -Os    Generate inline stubs.
76
77       -Oi    Generate old-style interpreted stubs.
78
79       -Oif, -Oic, -Oicf
80              Generate new-style fully interpreted stubs.
81
82       -p     Generate a proxy. The default output filename is infile_p.c.
83
84       --prefix-all=prefix
85              Prefix to put on the name of both client and server stubs.
86
87       --prefix-client=prefix
88              Prefix to put on the name of client stubs.
89
90       --prefix-server=prefix
91              Prefix to put on the name of server stubs.
92
93       -s     Generate a server stub file.  The  default  output  filename  is
94              infile_s.c.
95
96       --winrt
97              Enable Windows Runtime mode.
98
99       --ns_prefix
100              Prefix namespaces with ABI namespace.
101
102       Registration script options:
103
104       -r     Generate  a  registration script. The default output filename is
105              infile_r.rgs. If the output file name ends  in  .res,  a  binary
106              resource file containing the script is generated instead.
107
108       Dlldata file options:
109
110       --dlldata-only name1 [name2...]
111              Regenerate  the  dlldata  file  from scratch using the specified
112              proxy names. The default output filename is dlldata.c.
113
114       Preprocessor options:
115
116       -I path
117              Add a header search directory to path. Multiple search  directo‐
118              ries are allowed.
119
120       -D id[=val]
121              Define preprocessor macro id with value val.
122
123       -E     Preprocess only.
124
125       -N     Do not preprocess input.
126
127       Debug options:
128
129       -W     Enable pedantic warnings.
130
131       -d n   Set debug level to the non negative integer n.  If prefixed with
132              0x, it will be interpreted as an hexadecimal  number.   For  the
133              meaning of values, see the DEBUG section.
134
135       Miscellaneous options:
136
137       -app_config
138              Ignored, present for midl compatibility.
139
140       --acf=file
141              Use specified application configuration file.
142
143       --local-stubs=file
144              Generate  empty  stubs  for  call_as/local  methods in an object
145              interface and write them to file.
146

DEBUG

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

BUGS

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

AUTHORS

160       widl was originally written by Ove Kåven.  It has been improved by  Rob
161       Shearman,  Dan Hipschman, and others.  For a complete list, see the git
162       commit logs.  This man page was originally written  by  Hannu  Valtonen
163       and then updated by Dan Hipschman.
164

AVAILABILITY

166       widl  is  part  of  the  Wine  distribution, which is available through
167       WineHQ, the Wine development headquarters ⟨https://www.winehq.org/⟩.
168