tools/winebuild/README

   1                         Spec file format
   2                         ----------------
   3
   4 name    NAME
   5 type    win16|win32
   6 [file   WINFILENAME]
   7 [mode   dll|cuiexe|guiexe|cuiexe_unicode|guiexe_unicode]
   8 [heap   SIZE]
   9 [stack  SIZE]
  10 [init   FUNCTION]
  11 [import [IMP_FLAGS] DLL]
  12 [rsrc   RESFILE]
  13 [debug_channels ([CHANNEL [CHANNEL...]])]
  14 [ignore ([SYMBOL [SYMBOL...]])]
  15
  16 ORDINAL FUNCTYPE [FLAGS] EXPORTNAME([ARGTYPE [ARGTYPE [...]]]) HANDLERNAME
  17
  18 ORDINAL variable [FLAGS] EXPORTNAME (DATA [DATA [DATA [...]]])
  19
  20 ORDINAL stub [FLAGS] EXPORTNAME
  21
  22 ORDINAL equate [FLAGS] EXPORTNAME DATA
  23
  24 ORDINAL extern [FLAGS] EXPORTNAME SYMBOLNAME
  25
  26 ORDINAL forward [FLAGS] EXPORTNAME SYMBOLNAME
  27
  28 # COMMENT_TEXT
  29
  30 --------------------
  31 General:
  32 ========
  33
  34     "name" and "type" fields are mandatory.  Specific ordinal
  35 declarations are optional, but the default handler will print an error
  36 message.
  37
  38 "mode" specifies whether it is the spec file for a dll or the main exe.
  39 This is only valid for Win32 spec files.
  40
  41 "heap" is the size of the module local heap (only valid for Win16
  42 modules); default is no local heap.
  43
  44 "stack" is the stack size for Win32 exe modules, in kilobytes; default
  45 size is 1024 (1Mb stack).
  46
  47 "file" gives the name of the Windows file that is replaced by the
  48 builtin. <name>.DLL is assumed if none is given. (This is important
  49 for kernel, which lives in the Windows file KRNL386.EXE).
  50
  51 "init" specifies a function which will be called when this dll
  52 is loaded. This is only valid for Win32 modules.
  53
  54 "import" names a module that this one depends on (only for Win32
  55 modules at the present). The import declaration can be present several
  56 times.
  57
  58 "IMP_FLAGS" is a series of optional flags, preceded by a '-'
  59 character. The supported flags are:
  60 "-delay":       the module this module depends upon will be loaded
  61                 when the first API will be called (and not while this
  62                 module is loaded)
  63
  64 "rsrc" specifies the path of the compiled resource file.
  65
  66 "debug_channels" specifies the list of debug channels used by the dll.
  67
  68 "ignore" specifies a list of symbols that should be ignored when
  69 resolving undefined symbols against the imported libraries.
  70
  71 "ORDINAL" specified the ordinal number corresponding to the entry
  72 point, or "@" for automatic ordinal allocation (Win32 only).
  73
  74 "FLAGS" is a series of optional flags, preceded by a '-' character.
  75 The supported flags are:
  76   "-noimport": the entry point is not made available for importing
  77                from winelib applications (Win32 only).
  78   "-norelay":  the entry point is not displayed in relay debugging
  79                traces (Win32 only).
  80   "-ret64":    the function returns a 64-bit value (Win32 only).
  81   "-i386":     the entry point is only available on i386 platforms.
  82
  83 Lines whose first character is a '#' will be ignored as comments.
  84
  85
  86 Variable ordinals:
  87 ==================
  88
  89     This type defines data storage as 32-bit words at the ordinal specified.
  90 "EXPORTNAME" will be the name available for dynamic linking.  "DATA"
  91 can be a decimal number or a hex number preceeded by "0x".  The
  92 following example defines the variable "VariableA" at ordinal 2 and
  93 containing 4 ints:
  94
  95         2 variable VariableA(-1 0xff 0 0)
  96
  97 Function ordinals:
  98 ==================
  99
 100     This type defines a function entry point.  The prototype defined by
 101 "EXPORTNAME ([ARGTYPE [ARGTYPE [...]]])" specifies the name available for
 102 dynamic linking and the format of the arguments. "@" can be used
 103 instead of "EXPORTNAME" for ordinal-only exports.
 104
 105 "FUNCTYPE" should be one of:
 106 - "pascal16" for a Win16 function returning a 16-bit value
 107 - "pascal" for a Win16 function returning a 32-bit value
 108 - "register" for a function using CPU register to pass arguments
 109 - "interrupt" for a Win16 interrupt handler routine
 110 - "stdcall" for a normal Win32 function
 111 - "cdecl" for a Win32 function using the C calling convention
 112 - "varargs" for a Win32 function taking a variable number of arguments
 113
 114 "ARGTYPE" should be one of:
 115 - "word"   (16-bit unsigned value)
 116 - "s_word" (16-bit signed word)
 117 - "long"   (32-bit value)
 118 - "double" (64-bit value)
 119 - "ptr"    (linear pointer)
 120 - "str"    (linear pointer to a null-terminated ASCII string)
 121 - "wstr"   (linear pointer to a null-terminated Unicode string)
 122 - "segptr" (segmented pointer)
 123 - "segstr" (segmented pointer to a null-terminated ASCII string)
 124
 125 Only "ptr", "str", "wstr", "long" and "double" are valid for Win32 functions.
 126
 127 "HANDLERNAME" is the name of the actual Wine function that will
 128 process the request in 32-bit mode.
 129
 130     This first example defines an entry point for the CreateWindow()
 131 call (the ordinal 100 is just an example):
 132
 133         100 pascal CreateWindow(ptr ptr long s_word s_word s_word s_word
 134                                 word word word ptr)
 135                    WIN_CreateWindow
 136
 137    This second example defines an entry point for the GetFocus()
 138 call (the ordinal 100 is just an example):
 139
 140         100 pascal GetFocus() WIN_GetFocus()
 141
 142 To declare a function using a variable number of arguments in Win16,
 143 specify the function as taking no arguments. The arguments are then
 144 available with CURRENT_STACK16->args. In Win32, specify the function
 145 as 'varargs' and declare it with a '...' parameter in the C file.  See
 146 the wsprintf* functions in user.spec and user32.spec for an example.
 147
 148 Stub ordinals:
 149 ==============
 150
 151     This type defines a stub function. It makes the name and ordinal
 152 available for dynamic linking, but will terminate execution with an
 153 error message if the function is ever called.
 154
 155 Equate ordinals:
 156 ================
 157
 158     This type defines an ordinal as an absolute value.
 159 "EXPORTNAME" will be the name available for dynamic linking.
 160 "DATA" can be a decimal number or a hex number preceeded by "0x".
 161
 162 Extern ordinals:
 163 ================
 164
 165     This type defines an entry that simply maps to a Wine symbol
 166 (variable or function); "EXPORTNAME" will point to the symbol
 167 "SYMBOLNAME" that must be defined in C code. This type only works with
 168 Win32.
 169
 170 Forwarded ordinals:
 171 ===================
 172
 173     This type defines an entry that is forwarded to another entry
 174 point (kind of a symbolic link). "EXPORTNAME" will forward to the
 175 entry point "SYMBOLNAME" that must be of the form "DLL.Function". This
 176 type only works with Win32.
 177