Installer database files.Source files (.wxs and .wxi) are compiled, producing object files (.wixobj). These objects files are then consumed by the linker, which produces Windows Installer database files (.msi or .msm). This is analogous to theC++ model of compiling source code to object files, then linking to produce executables.There are more advanced file types that are supported in WiX. The details of these file types are listed in theList of file typestopic.
Windows Installer XML Files - .wxs & .wixobj
A .wxs file is the extension used by all source files in the Windows Installer XML system. These .wxs files are analogous to .cpp files for C++ or .cs files for C#. The .wxs files are preprocessed and then compiled intoWiX object files, which use the extension .wixobj. When all of the source files have been compiled into object files, the linker is used to collect the object files together and create a Windows Installer database. Moredetails on the compiler and linker are provided later in this topic.
Structure of .wxs files
All .wxs files are well-formed XML documents that contain a single root element named <Wix/>. The rest of the source file may or may not adhere to the WiX schema before preprocessing. However, after beingreprocessed all source files must conform to the WiX schema or they will fail to compile.The root <Wix> element can contain at most one of the following two elements as children: <Product>, <Module>. However, there can be an unbounded number <Fragment> elements as children of the root <Wix>element. When a source file is compiled into an object file, each instance of these elements creates a new section in the object file. Therefore, these three elements are often referred to as section elements.It is important to note, that there can be only one <Product> or <Module> section element per source file because they are compiled into special sections called entry sections. Entry sections are used as starting points inthe linking process. Sections, entry sections, and the entire linking process are described in greater detail later in this document.The children of the section elements define the contents of the Windows Installer database. You’ll recognize <Property> elements that map to entries in the Property table and a hierarchy of <Directory> elements thatbuild up the Directory table. Most elements contain an “Id” attribute that will act as the primary key for the resulting row in the Windows Installer database. In most cases, the “Id” attribute also defines a symbol whenthe source file is compiled into an object file.
Symbols and references
Every symbol in an object file is composed of the element name plus the unique identifier from the “Id” attribute. Symbols are important because they can be referenced by other sections from any source file. Forexample, a <Directory> structure can be defined in a <Fragment> in one source file and a <Component> can be defined under a different source file’s <Fragment>. By making the <DirectoryRef> element a parent of the <Component> an explicit reference is created that references the symbol defined by a <Directory> in the first source file. The linker is then responsible for stitching the symbol and the reference together in a singleWindows Installer database. In some cases, implicit references are generated by the compiler while processing a source file. These implicit references behave identically to explicit references.In addition to the simple references described above, WiX supports specific complex references. Complex references are used in cases where the linker must generate extra information to link the symbol and referencetogether. The perfect example of a complex reference is in the Windows Installer’s Feature/Component relationship. When a <Component> is referenced explicitly by a <Feature> through a <ComponentRef> element,the linker must take the <Feature>’s symbol and the <Component>’s symbol and add an entry to the FeatureComponents table.This Feature/Component relationship is even more complex because certain elements in a <Component>, for example <Shortcut>, have references back to the primary Feature associated with the Component. Thesereferences from a child element of a <Component> are called reverse references or sometimes feature backlinks. Processing complex references and reverse references is probably the most difficult work the linker hasto do.
Structure of the .wixobj file
A .wixobj file is created by the compiler for each source file compiled. The .wixobj file is an XML document that follows the objects.xsd schema defined in the WiX project. As stated above the .wixobj file containsone or more sections that, in turn, contain symbols and references to other symbols.While the symbols and references are arguably the most important pieces of data in the .wixobj file, they are rarely the bulk of the information. Instead, most .wixobj files are composed of <table>, <row> and <field>elements that provide the raw data to be placed in the Windows Installer database. In many cases, the linker will not only process the symbols and references but also use and update the raw data from the .wixobj file. Itis interesting to note that the object file schema, objects.xsd, uses camel casing where the source file schema, wix.xsd, uses Pascal casing. This was a conscious choice to indicate that the object files are not intended tobe edited by the user. In fact, all schemas that define data to be processed only by the WiX tools use camel casing.
List of file types
The following list describes the supported file types in WiX:
Include Files (.wxi)
A .wxi file is analogous to .h files for C++. The root element of this file is <Include/>. Everything under the root element will be inserted when this file is included in another source or include file.
Localization Files (.wxl)
A .wxl file contains a set of strings used for localizing a product into a specified culture. The root element of this file is <WixLocalization/>. The culture is specified by setting the Culture attribute on the<WixLocalization/> element.
.wxiInclude FileA .wxi file is analogous to .h files for C++. The root element of this file is <Include>. Everything under the root element will be inserted inline when this file is includedin another source or include file..wxlLocalization FileA .wxl file contains a set of strings used for localizing a product into a specified culture. The root element of this file is <WixLocalization>. The culture is specified bysetting the Culture attribute on the <WixLocalization> element..wxsSource File A .wxs file as analogous to a .cpp file for C++. The Root element of this file is <Wix>..wixobjObject FileA .wixobj file is created by the compiler for each source file compiled. The .wixobj file contains one or more sections that, in turn, contain symbols and references toother symbols..wixout XML Output File A .wixout file is created by the linker which represents the result of linking a set of object files. The .wixout is an XML representation of the final output..wixlib WiX Library File A .wixlib file is a library of setup functionality that can be easily shared across different WiX-based packages by including it when linking the setup package..wixpdb Debug File A .wixpdb file is created by the linker for each final output. It contains the debugging information..wixmsp XML Patch File A .wixmsp file is the XML output generated by linking object files in a patch build..wixmst Transform File A .wixmst file is an XML representation of the difference between a pair of final outputs or XML outputs..msi Windows Installer InstallationPackageAn installation package file (.msi) is the basic unit of installation for the Windows Installer. For more information on .msi files, see theWindows Installerdocumentation..msm Windows Installer MergeModuleA merge module file (.msm) is used to share setup logic across different .msi packages. A merge module can be created by one development team, then merged intoanother development team's .msi package. For more information on .msm files, see theWindows Installer documentation..mst Windows Installer Transform A transform file (.mst) is used to apply changes to an .msi file. For more information on .mst files, see theWindows Installer documentation..pcpWindows Installer PatchCreation Process FileA patch creation properties file (.pcp) is used as an input to the patch building tools provided in the Windows Installer SDK. For more information on .pcp files, see theWindows Installer documentation.