{"id":109825,"date":"2024-05-31T07:00:00","date_gmt":"2024-05-31T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=109825"},"modified":"2024-06-02T07:23:16","modified_gmt":"2024-06-02T14:23:16","slug":"20240531-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20240531-00\/?p=109825","title":{"rendered":"A graphical depiction of the steps in building a C++ executable, with XAML and packaging"},"content":{"rendered":"

Last time, we generated a diagram showing how a C++ executable is built, augmented for classic Win32<\/a>. Let’s add in more stuff: XAML and packaging.<\/p>\n

 <\/p>\n

\u00a0<\/div>\n
\u00a0<\/div>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
.idl<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
\u2193<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
MIDL compiler<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193<\/td>\n		\u2198<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n.winmd<\/td>\n <\/td>\n.xaml<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u2193<\/td>\n\u2198<\/td>\n\u2193<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\nC++\/WinRT compiler<\/td>\n <\/td>\nXAML compiler<\/td>\n<\/tr>\n
 <\/td>\n\u2193<\/td>\n\u2199<\/td>\n\u2193<\/td>\n <\/td>\n<\/tr>\n
\n
\u00a0<\/div>\n
.h, .cpp<\/div>\n<\/td>\n
 <\/td>\n.xbf<\/td>\n <\/td>\n.resw<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2193<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n\u2198<\/td>\n\u2193<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
C++ compiler<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n <\/td>\nmakepri<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2193<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n <\/td>\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
.obj<\/div>\n<\/td>\n
 <\/td>\n.rc, .ico, .bmp<\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2199<\/div>\n<\/td>\n
\n
\u00a0<\/div>\n
\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193<\/div>\n<\/td>\n
 <\/td>\n\u2193<\/td>\n<\/td>\n<\/tr>\n
\n
\u00a0<\/div>\n
librarian<\/div>\n<\/td>\n
<\/td>\n <\/td>\nrc compiler<\/td>\n<\/td>\n<\/tr>\n
\n
\u00a0<\/div>\n
\u2193<\/div>\n<\/td>\n
<\/td>\n <\/td>\n\u2193<\/td>\n<\/td>\n<\/tr>\n
\n
\u00a0<\/div>\n
.lib<\/div>\n<\/td>\n
<\/td>\n <\/td>\n.res<\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2198<\/div>\n

<\/td>\n

\u2199<\/td>\n <\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
linker<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2193<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
.dll, .exe<\/div>\n<\/td>\n
 <\/td>\n.appxmanifest<\/td>\n <\/td>\n.pri<\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u2198<\/td>\n\u2193<\/td>\n\u2199<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n <\/td>\npackager<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n <\/td>\n\u2193<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n <\/td>\n.msi, .msix<\/td>\n <\/td>\n <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

We still see the core of the compiler and linker on the left hand side, happily consuming C++ source files (.h, .cpp) producing a module (.dll, .exe). We just added still more steps that either produce C++ source files from other sources, add additional content to the resulting module, or which package the resulting module.<\/p>\n

If there is an .idl file, it is processed by the MIDL compiler, which (depending on what kind of IDL file you provided) may produce a .winmd file, or C source files. If you’re processing .idl files for C++\/WinRT, then the thing your project uses is the .winmd file. If you’re processing .idl files for C++\/WRL, then the thing your project uses is the .h file. And if you want your interfaces to be marshallable, you will want the .c file that compiles the proxy stubs.<\/p>\n

If you have a .winmd file and are using C++\/WinRT, then the C++\/WinRT compiler studies the .winmd file and produces .h and .cpp files for your project to use. (C++\/WinRT-based projects use these header files instead of the MIDL ones.)<\/p>\n

If you have .xaml files, then XAML compiler generates C++ source code for those .xaml files, using the .winmd files to know how to generate binding code. It also generates .xbf files (which I correctly guessed stands for XAML binary format<\/a>) which are used at runtime to generate the elements you specified in your XAML markup. The C++ source files get compiled into your project, too.<\/p>\n

Now that we have generated all the C++ source files, we can go through the usual procss of compiling the C++ source files to object files, and possibly generate a .lib.<\/p>\n

If your code uses classic Win32 resources, the resource compiler takes the .rc file and any supporting files (like .ico and .bmp) and produces a .res file, as before.<\/p>\n

After all the .obj, .lib, and .res files have been produced, we feed them all to the linker, which produces the resulting module, a .dll or .exe.<\/p>\n

If applicable to your project, the makepri<\/tt> program takes a string resource description file .resw, as well as all of the .xbf files, and produces a .pri file, which is yet another binary format for resources.<\/p>\n

If your final product requires packaging, then all of the .dll files, .exe files, .pri files, and any other collateral are gathered together, along with your package’s .appxmanifest, and out comes an .msi file or .msix file.<\/p>\n

This is a very quick overview of the build flow, but now that you see how the pieces fit together, you will be better-equipped to diagnose build problems. For example, if you get a XAML compiler error, then the things to investigate are the .xaml and .winmd files in your project, since those are the pieces that the XAML compiler uses. There’s no point investigating the manifest file when trying to diagnose a XAML compiler error.<\/p>\n

Bonus chatter<\/b>: If your project is based on C++\/CX, then the build flow is different, since C++\/CX doesn’t use .idl files but rather generates the .winmd file from your C++ sources. The resulting diagram looks weird because there is a circular dependency!<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
 <\/td>\n <\/td>\n.winmd<\/td>\n <\/td>\n.xaml<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u2199\u2197<\/td>\n <\/td>\n\u2198<\/td>\n\u2193<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n\u2193\u2191<\/td>\n <\/td>\n <\/td>\nXAML compiler<\/td>\n<\/tr>\n
 <\/td>\n\u2193\u2191<\/td>\n <\/td>\n\u2199<\/td>\n\u2193<\/td>\n <\/td>\n<\/tr>\n
\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2193\u2191<\/div>\n<\/td>\n
\n
\u00a0<\/div>\n
.h, .cpp<\/div>\n<\/td>\n
 <\/td>\n.xbf<\/td>\n <\/td>\n.resw<\/td>\n<\/tr>\n
\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2198\u2196<\/div>\n<\/td>\n
\n
\u00a0<\/div>\n
\u2193<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n\u2198<\/td>\n\u2193<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
C++\/CX compiler<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n <\/td>\nmakepri<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2193<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n <\/td>\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
.obj<\/div>\n<\/td>\n
 <\/td>\n.rc, .ico, .bmp<\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2199<\/div>\n<\/td>\n
\n
\u00a0<\/div>\n
\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193
\n\u2193<\/div>\n<\/td>\n
 <\/td>\n\u2193<\/td>\n<\/td>\n<\/tr>\n
\n
\u00a0<\/div>\n
librarian<\/div>\n<\/td>\n
<\/td>\n <\/td>\nrc compiler<\/td>\n<\/td>\n<\/tr>\n
\n
\u00a0<\/div>\n
\u2193<\/div>\n<\/td>\n
<\/td>\n <\/td>\n\u2193<\/td>\n<\/td>\n<\/tr>\n
\n
\u00a0<\/div>\n
.lib<\/div>\n<\/td>\n
<\/td>\n <\/td>\n.res<\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2198<\/div>\n

<\/td>\n

\u2199<\/td>\n <\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
linker<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
\u2193<\/div>\n<\/td>\n
 <\/td>\n <\/td>\n<\/td>\n<\/tr>\n
\u00a0<\/td>\n\u00a0<\/td>\n\n
\u00a0<\/div>\n
.dll, .exe<\/div>\n<\/td>\n
 <\/td>\n.appxmanifest<\/td>\n <\/td>\n.pri<\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n\u2198<\/td>\n\u2193<\/td>\n\u2199<\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n <\/td>\npackager<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n <\/td>\n\u2193<\/td>\n <\/td>\n <\/td>\n<\/tr>\n
 <\/td>\n <\/td>\n <\/td>\n <\/td>\n.msi, .msix<\/td>\n <\/td>\n <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Instead of generating the .winmd from an .idl file, the .winmd is generated from the C++ sources, and the C++\/CX compiler also consumes the .winmd files when compiling the C++ sources. My understanding is that the C++\/CX compiler first makes a “metadata pass” where it parses the code only to identify the ref<\/code> classes and their members. It then generates a .winmd from that information, and then later, in the “real compilation” pass, all of the .winmd files are used to provide type information to the C++\/CX compiler a second time.<\/p>\n

In addition to introducing a weird circular dependency, this style of automatic .winmd generation limits you to the types of things that the automatic .winmd generator understands. The automatic .winmd generator doesn’t understand Windows Runtime versioning or contracts, for example, so you can’t use it to produce a v2 API that is backward compatible with the v1 API. Once you make a change, all of your clients have to switch to the v2 API; the v1 API doesn’t work any more. This is fine for monolithic programs, but it’s bad news if you’re trying to produce reusable components.<\/p>\n

\n