[NTVDM]
[reactos.git] / cmake / CMakeMacros.cmake
1
2 # set_cpp
3 # Marks the current folder as containing C++ modules, additionally enabling
4 # specific C++ language features as specified (all of these default to off):
5 #
6 # WITH_RUNTIME
7 # Links with the C++ runtime. Enable this for modules which use new/delete or
8 # RTTI, but do not require STL. This is the right choice if you see undefined
9 # references to operator new/delete, vector constructor/destructor iterator,
10 # type_info::vtable, ...
11 # Note: this only affects linking, so cannot be used for static libraries.
12 # WITH_RTTI
13 # Enables run-time type information. Enable this if the module uses typeid or
14 # dynamic_cast. You will probably need to enable WITH_RUNTIME as well, if
15 # you're not already using STL.
16 # WITH_EXCEPTIONS
17 # Enables C++ exception handling. Enable this if the module uses try/catch or
18 # throw. You might also need this if you use a standard operator new (the one
19 # without nothrow).
20 # WITH_STL
21 # Enables standard C++ headers and links to the Standard Template Library.
22 # Use this for modules using anything from the std:: namespace, e.g. maps,
23 # strings, vectors, etc.
24 # Note: this affects both compiling (via include directories) and
25 # linking (by adding STL). Implies WITH_RUNTIME.
26 # FIXME: WITH_STL is currently also required for runtime headers such as
27 # <new> and <exception>. This is not a big issue because in stl-less
28 # environments you usually don't want those anyway; but we might want
29 # to have modules like this in the future.
30 #
31 # Examples:
32 # set_cpp()
33 # Enables the C++ language, but will cause errors if any runtime or standard
34 # library features are used. This should be the default for C++ in kernel
35 # mode or otherwise restricted environments.
36 # Note: this is required to get libgcc (for multiplication/division) linked
37 # in for C++ modules, and to set the correct language for precompiled
38 # header files, so it IS required even with no features specified.
39 # set_cpp(WITH_RUNTIME)
40 # Links with the C++ runtime, so that e.g. custom operator new implementations
41 # can be used in a restricted environment. This is also required for linking
42 # with libraries (such as ATL) which have RTTI enabled, even if the module in
43 # question does not use WITH_RTTI.
44 # set_cpp(WITH_RTTI WITH_EXCEPTIONS WITH_STL)
45 # The full package. This will adjust compiler and linker so that all C++
46 # features can be used.
47 macro(set_cpp)
48 cmake_parse_arguments(__cppopts "WITH_RUNTIME;WITH_RTTI;WITH_EXCEPTIONS;WITH_STL" "" "" ${ARGN})
49 if(__cppopts_UNPARSED_ARGUMENTS)
50 message(FATAL_ERROR "set_cpp: unparsed arguments ${__cppopts_UNPARSED_ARGUMENTS}")
51 endif()
52
53 if(__cppopts_WITH_RUNTIME)
54 set(CPP_USE_RT 1)
55 endif()
56 if(__cppopts_WITH_RTTI)
57 if(MSVC)
58 replace_compile_flags("/GR-" "/GR")
59 else()
60 replace_compile_flags_language("-fno-rtti" "-frtti" "CXX")
61 endif()
62 endif()
63 if(__cppopts_WITH_EXCEPTIONS)
64 if(MSVC)
65 replace_compile_flags("/EHs-c-" "/EHsc")
66 else()
67 replace_compile_flags_language("-fno-exceptions" "-fexceptions" "CXX")
68 endif()
69 endif()
70 if(__cppopts_WITH_STL)
71 set(CPP_USE_STL 1)
72 if(MSVC)
73 add_definitions(-DNATIVE_CPP_INCLUDE=${REACTOS_SOURCE_DIR}/include/c++)
74 include_directories(${REACTOS_SOURCE_DIR}/include/c++/stlport)
75 endif()
76 endif()
77
78 set(IS_CPP 1)
79 endmacro()
80
81 function(add_dependency_node _node)
82 if(GENERATE_DEPENDENCY_GRAPH)
83 get_target_property(_type ${_node} TYPE)
84 if(_type MATCHES SHARED_LIBRARY OR ${_node} MATCHES ntoskrnl)
85 file(APPEND ${REACTOS_BINARY_DIR}/dependencies.graphml " <node id=\"${_node}\"/>\n")
86 endif()
87 endif()
88 endfunction()
89
90 function(add_dependency_edge _source _target)
91 if(GENERATE_DEPENDENCY_GRAPH)
92 get_target_property(_type ${_source} TYPE)
93 if(_type MATCHES SHARED_LIBRARY)
94 file(APPEND ${REACTOS_BINARY_DIR}/dependencies.graphml " <edge source=\"${_source}\" target=\"${_target}\"/>\n")
95 endif()
96 endif()
97 endfunction()
98
99 function(add_dependency_header)
100 file(APPEND ${REACTOS_BINARY_DIR}/dependencies.graphml "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<graphml>\n <graph id=\"ReactOS dependencies\" edgedefault=\"directed\">\n")
101 endfunction()
102
103 function(add_dependency_footer)
104 add_dependency_node(ntdll)
105 file(APPEND ${REACTOS_BINARY_DIR}/dependencies.graphml " </graph>\n</graphml>\n")
106 endfunction()
107
108 function(add_message_headers _type)
109 if(${_type} STREQUAL UNICODE)
110 set(_flag "-U")
111 else()
112 set(_flag "-A")
113 endif()
114 foreach(_in_FILE ${ARGN})
115 get_filename_component(FILE ${_in_FILE} NAME_WE)
116 macro_mc(${_flag} ${FILE})
117 add_custom_command(
118 OUTPUT ${REACTOS_BINARY_DIR}/include/reactos/${FILE}.rc ${REACTOS_BINARY_DIR}/include/reactos/${FILE}.h
119 COMMAND ${COMMAND_MC} ${MC_FLAGS}
120 DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${FILE}.mc)
121 set_source_files_properties(
122 ${REACTOS_BINARY_DIR}/include/reactos/${FILE}.h ${REACTOS_BINARY_DIR}/include/reactos/${FILE}.rc
123 PROPERTIES GENERATED TRUE)
124 add_custom_target(${FILE} ALL DEPENDS ${REACTOS_BINARY_DIR}/include/reactos/${FILE}.h ${REACTOS_BINARY_DIR}/include/reactos/${FILE}.rc)
125 endforeach()
126 endfunction()
127
128 function(add_link)
129 cmake_parse_arguments(_LINK "MINIMIZE" "NAME;PATH;CMD_LINE_ARGS;ICON;GUID" "" ${ARGN})
130 if(NOT _LINK_NAME OR NOT _LINK_PATH)
131 message(FATAL_ERROR "You must provide name and path")
132 endif()
133
134 if(_LINK_CMD_LINE_ARGS)
135 set(_LINK_CMD_LINE_ARGS -c ${_LINK_CMD_LINE_ARGS})
136 endif()
137
138 if(_LINK_ICON)
139 set(_LINK_ICON -i ${_LINK_ICON})
140 endif()
141
142 if(_LINK_GUID)
143 set(_LINK_GUID -g ${_LINK_GUID})
144 endif()
145
146 if(_LINK_MINIMIZE)
147 set(_LINK_MINIMIZE "-m")
148 endif()
149
150 add_custom_command(
151 OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${_LINK_NAME}.lnk
152 COMMAND native-mkshelllink -o ${CMAKE_CURRENT_BINARY_DIR}/${_LINK_NAME}.lnk ${_LINK_CMD_LINE_ARGS} ${_LINK_ICON} ${_LINK_GUID} ${_LINK_MINIMIZE} ${_LINK_PATH}
153 DEPENDS native-mkshelllink)
154 set_source_files_properties(${CMAKE_CURRENT_BINARY_DIR}/${_LINK_NAME}.lnk PROPERTIES GENERATED TRUE)
155 endfunction()
156
157 macro(dir_to_num dir var)
158 if(${dir} STREQUAL reactos/system32)
159 set(${var} 1)
160 elseif(${dir} STREQUAL reactos/system32/drivers)
161 set(${var} 2)
162 elseif(${dir} STREQUAL reactos/Fonts)
163 set(${var} 3)
164 elseif(${dir} STREQUAL reactos)
165 set(${var} 4)
166 elseif(${dir} STREQUAL reactos/system32/drivers/etc)
167 set(${var} 5)
168 elseif(${dir} STREQUAL reactos/inf)
169 set(${var} 6)
170 elseif(${dir} STREQUAL reactos/bin)
171 set(${var} 7)
172 elseif(${dir} STREQUAL reactos/bin/data)
173 set(${var} 8)
174 elseif(${dir} STREQUAL reactos/media)
175 set(${var} 9)
176 elseif(${dir} STREQUAL reactos/Microsoft.NET)
177 set(${var} 10)
178 elseif(${dir} STREQUAL reactos/Microsoft.NET/Framework)
179 set(${var} 11)
180 elseif(${dir} STREQUAL reactos/Microsoft.NET/Framework/v1.0.3705)
181 set(${var} 12)
182 elseif(${dir} STREQUAL reactos/Microsoft.NET/Framework/v1.1.4322)
183 set(${var} 13)
184 elseif(${dir} STREQUAL reactos/Microsoft.NET/Framework/v2.0.50727)
185 set(${var} 14)
186 elseif(${dir} STREQUAL reactos/Resources)
187 set(${var} 15)
188 elseif(${dir} STREQUAL reactos/Resources/Themes)
189 set(${var} 16)
190 elseif(${dir} STREQUAL reactos/system32/wbem)
191 set(${var} 17)
192 else()
193 message(FATAL_ERROR "Wrong destination: ${dir}")
194 endif()
195 endmacro()
196
197 function(add_cd_file)
198 cmake_parse_arguments(_CD "NO_CAB" "DESTINATION;NAME_ON_CD;TARGET" "FILE;FOR" ${ARGN})
199 if(NOT (_CD_TARGET OR _CD_FILE))
200 message(FATAL_ERROR "You must provide a target or a file to install!")
201 endif()
202
203 if(NOT _CD_DESTINATION)
204 message(FATAL_ERROR "You must provide a destination")
205 elseif(${_CD_DESTINATION} STREQUAL root)
206 set(_CD_DESTINATION "")
207 endif()
208
209 if(NOT _CD_FOR)
210 message(FATAL_ERROR "You must provide a cd name (or "all" for all of them) to install the file on!")
211 endif()
212
213 #get file if we need to
214 if(NOT _CD_FILE)
215 get_target_property(_CD_FILE ${_CD_TARGET} LOCATION_${CMAKE_BUILD_TYPE})
216 endif()
217
218 #do we add it to all CDs?
219 if(_CD_FOR STREQUAL all)
220 set(_CD_FOR "bootcd;livecd;regtest")
221 endif()
222
223 #do we add it to bootcd?
224 list(FIND _CD_FOR bootcd __cd)
225 if(NOT __cd EQUAL -1)
226 #whether or not we should put it in reactos.cab or directly on cd
227 if(_CD_NO_CAB)
228 #directly on cd
229 foreach(item ${_CD_FILE})
230 if(_CD_NAME_ON_CD)
231 #rename it in the cd tree
232 set(__file ${_CD_NAME_ON_CD})
233 else()
234 get_filename_component(__file ${item} NAME)
235 endif()
236 set_property(GLOBAL APPEND PROPERTY BOOTCD_FILE_LIST "${_CD_DESTINATION}/${__file}=${item}")
237 endforeach()
238 if(_CD_TARGET)
239 #manage dependency
240 add_dependencies(bootcd ${_CD_TARGET})
241 endif()
242 else()
243 #add it in reactos.cab
244 dir_to_num(${_CD_DESTINATION} _num)
245 file(RELATIVE_PATH __relative_file ${REACTOS_SOURCE_DIR} ${_CD_FILE})
246 file(APPEND ${REACTOS_BINARY_DIR}/boot/bootdata/packages/reactos.dff.dyn "\"${__relative_file}\" ${_num}\n")
247 unset(__relative_file)
248 if(_CD_TARGET)
249 #manage dependency
250 add_dependencies(reactos_cab ${_CD_TARGET})
251 endif()
252 endif()
253 endif() #end bootcd
254
255 #do we add it to livecd?
256 list(FIND _CD_FOR livecd __cd)
257 if(NOT __cd EQUAL -1)
258 #manage dependency
259 if(_CD_TARGET)
260 add_dependencies(livecd ${_CD_TARGET})
261 endif()
262 foreach(item ${_CD_FILE})
263 if(_CD_NAME_ON_CD)
264 #rename it in the cd tree
265 set(__file ${_CD_NAME_ON_CD})
266 else()
267 get_filename_component(__file ${item} NAME)
268 endif()
269 set_property(GLOBAL APPEND PROPERTY LIVECD_FILE_LIST "${_CD_DESTINATION}/${__file}=${item}")
270 endforeach()
271 endif() #end livecd
272
273 #do we add it to regtest?
274 list(FIND _CD_FOR regtest __cd)
275 if(NOT __cd EQUAL -1)
276 #whether or not we should put it in reactos.cab or directly on cd
277 if(_CD_NO_CAB)
278 #directly on cd
279 foreach(item ${_CD_FILE})
280 if(_CD_NAME_ON_CD)
281 #rename it in the cd tree
282 set(__file ${_CD_NAME_ON_CD})
283 else()
284 get_filename_component(__file ${item} NAME)
285 endif()
286 set_property(GLOBAL APPEND PROPERTY BOOTCDREGTEST_FILE_LIST "${_CD_DESTINATION}/${__file}=${item}")
287 endforeach()
288 if(_CD_TARGET)
289 #manage dependency
290 add_dependencies(bootcdregtest ${_CD_TARGET})
291 endif()
292 else()
293 #add it in reactos.cab
294 #dir_to_num(${_CD_DESTINATION} _num)
295 #file(APPEND ${REACTOS_BINARY_DIR}/boot/bootdata/packages/reactos.dff.dyn "${_CD_FILE} ${_num}\n")
296 #if(_CD_TARGET)
297 # #manage dependency
298 # add_dependencies(reactos_cab ${_CD_TARGET})
299 #endif()
300 endif()
301 endif() #end bootcd
302 endfunction()
303
304 function(create_iso_lists)
305 get_property(_filelist GLOBAL PROPERTY BOOTCD_FILE_LIST)
306 string(REPLACE ";" "\n" _filelist "${_filelist}")
307 file(APPEND ${REACTOS_BINARY_DIR}/boot/bootcd.lst "${_filelist}")
308 unset(_filelist)
309
310 get_property(_filelist GLOBAL PROPERTY LIVECD_FILE_LIST)
311 string(REPLACE ";" "\n" _filelist "${_filelist}")
312 file(APPEND ${REACTOS_BINARY_DIR}/boot/livecd.lst "${_filelist}")
313 unset(_filelist)
314
315 get_property(_filelist GLOBAL PROPERTY BOOTCDREGTEST_FILE_LIST)
316 string(REPLACE ";" "\n" _filelist "${_filelist}")
317 file(APPEND ${REACTOS_BINARY_DIR}/boot/bootcdregtest.lst "${_filelist}")
318 unset(_filelist)
319 endfunction()
320
321 # Create module_clean targets
322 function(add_clean_target _target)
323 set(_clean_working_directory ${CMAKE_CURRENT_BINARY_DIR})
324 if(CMAKE_GENERATOR STREQUAL "Unix Makefiles" OR CMAKE_GENERATOR STREQUAL "MinGW Makefiles")
325 set(_clean_command make clean)
326 elseif(CMAKE_GENERATOR STREQUAL "NMake Makefiles")
327 set(_clean_command nmake /nologo clean)
328 elseif(CMAKE_GENERATOR STREQUAL "Ninja")
329 set(_clean_command ninja -t clean ${_target})
330 set(_clean_working_directory ${REACTOS_BINARY_DIR})
331 endif()
332 add_custom_target(${_target}_clean
333 COMMAND ${_clean_command}
334 WORKING_DIRECTORY ${_clean_working_directory}
335 COMMENT "Cleaning ${_target}")
336 endfunction()
337
338 if(NOT MSVC_IDE)
339 function(add_library name)
340 _add_library(${name} ${ARGN})
341 add_clean_target(${name})
342 endfunction()
343
344 function(add_executable name)
345 _add_executable(${name} ${ARGN})
346 add_clean_target(${name})
347 endfunction()
348 endif()
349
350 if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows")
351 macro(to_win_path _cmake_path _native_path)
352 string(REPLACE "/" "\\" ${_native_path} "${_cmake_path}")
353 endmacro()
354
355 # yeah the parameter mess sucks, but thats what works...
356 function(concatenate_files _file1 _target2 _output)
357 get_target_property(_file2 ${_target2} LOCATION)
358 to_win_path("${_file1}" _real_file1)
359 to_win_path("${_file2}" _real_file2)
360 to_win_path("${_output}" _real_output)
361 add_custom_command(
362 OUTPUT ${_output}
363 COMMAND cmd.exe /C "copy /Y /B ${_real_file1} + ${_real_file2} ${_real_output} > nul"
364 DEPENDS ${_file1}
365 DEPENDS ${_target2})
366 endfunction()
367 else()
368 macro(concatenate_files _file1 _target2 _output)
369 get_target_property(_file2 ${_target2} LOCATION)
370 add_custom_command(
371 OUTPUT ${_output}
372 COMMAND cat ${_file1} ${_file2} > ${_output}
373 DEPENDS ${_file1}
374 DEPENDS ${_target2})
375 endmacro()
376 endif()
377
378 function(add_importlibs _module)
379 add_dependency_node(${_module})
380 foreach(LIB ${ARGN})
381 if("${LIB}" MATCHES "msvcrt")
382 add_target_compile_definitions(${_module} _DLL __USE_CRTIMP)
383 target_link_libraries(${_module} msvcrtex)
384 endif()
385 target_link_libraries(${_module} lib${LIB})
386 add_dependencies(${_module} lib${LIB})
387 add_dependency_edge(${_module} ${LIB})
388 endforeach()
389 endfunction()
390
391 function(set_module_type MODULE TYPE)
392 cmake_parse_arguments(__module "UNICODE" "IMAGEBASE" "ENTRYPOINT" ${ARGN})
393
394 if(__module_UNPARSED_ARGUMENTS)
395 message(STATUS "set_module_type : unparsed arguments ${__module_UNPARSED_ARGUMENTS}, module : ${MODULE}")
396 endif()
397
398 # Set subsystem. Also take this as an occasion
399 # to error out if someone gave a non existing type
400 if((${TYPE} STREQUAL nativecui) OR (${TYPE} STREQUAL nativedll) OR (${TYPE} STREQUAL kernelmodedriver) OR (${TYPE} STREQUAL wdmdriver))
401 set(__subsystem native)
402 elseif(${TYPE} STREQUAL win32cui)
403 set(__subsystem console)
404 elseif(${TYPE} STREQUAL win32gui)
405 set(__subsystem windows)
406 elseif(NOT ((${TYPE} STREQUAL win32dll) OR (${TYPE} STREQUAL win32ocx)
407 OR (${TYPE} STREQUAL cpl) OR (${TYPE} STREQUAL module)))
408 message(FATAL_ERROR "Unknown type ${TYPE} for module ${MODULE}")
409 endif()
410
411 if(DEFINED __subsystem)
412 set_subsystem(${MODULE} ${__subsystem})
413 endif()
414
415 #set unicode definitions
416 if(__module_UNICODE)
417 add_target_compile_definitions(${MODULE} UNICODE _UNICODE)
418 endif()
419
420 # set entry point
421 if(__module_ENTRYPOINT OR (__module_ENTRYPOINT STREQUAL "0"))
422 list(GET __module_ENTRYPOINT 0 __entrypoint)
423 list(LENGTH __module_ENTRYPOINT __length)
424 if(${__length} EQUAL 2)
425 list(GET __module_ENTRYPOINT 1 __entrystack)
426 elseif(NOT ${__length} EQUAL 1)
427 message(FATAL_ERROR "Wrong arguments for ENTRYPOINT parameter of set_module_type : ${__module_ENTRYPOINT}")
428 endif()
429 unset(__length)
430 elseif(${TYPE} STREQUAL nativecui)
431 set(__entrypoint NtProcessStartup)
432 set(__entrystack 4)
433 elseif(${TYPE} STREQUAL win32cui)
434 if(__module_UNICODE)
435 set(__entrypoint wmainCRTStartup)
436 else()
437 set(__entrypoint mainCRTStartup)
438 endif()
439 elseif(${TYPE} STREQUAL win32gui)
440 if(__module_UNICODE)
441 set(__entrypoint wWinMainCRTStartup)
442 else()
443 set(__entrypoint WinMainCRTStartup)
444 endif()
445 elseif((${TYPE} STREQUAL win32dll) OR (${TYPE} STREQUAL win32ocx)
446 OR (${TYPE} STREQUAL cpl))
447 set(__entrypoint DllMainCRTStartup)
448 set(__entrystack 12)
449 elseif((${TYPE} STREQUAL kernelmodedriver) OR (${TYPE} STREQUAL wdmdriver))
450 set(__entrypoint DriverEntry)
451 set(__entrystack 8)
452 elseif(${TYPE} STREQUAL nativedll)
453 set(__entrypoint DllMain)
454 set(__entrystack 12)
455 elseif(${TYPE} STREQUAL module)
456 set(__entrypoint 0)
457 endif()
458
459 if(DEFINED __entrypoint)
460 if(DEFINED __entrystack)
461 set_entrypoint(${MODULE} ${__entrypoint} ${__entrystack})
462 else()
463 set_entrypoint(${MODULE} ${__entrypoint})
464 endif()
465 endif()
466
467 #set base address
468 if(__module_IMAGEBASE)
469 set_image_base(${MODULE} __module_IMAGEBASE)
470 elseif(${TYPE} STREQUAL win32dll)
471 if(DEFINED baseaddress_${MODULE})
472 set_image_base(${MODULE} ${baseaddress_${MODULE}})
473 else()
474 message(STATUS "${MODULE} has no base address")
475 endif()
476 elseif((${TYPE} STREQUAL kernelmodedriver) OR (${TYPE} STREQUAL wdmdriver))
477 set_image_base(${MODULE} 0x00010000)
478 endif()
479
480 # Now do some stuff which is specific to each type
481 if((${TYPE} STREQUAL kernelmodedriver) OR (${TYPE} STREQUAL wdmdriver))
482 add_dependencies(${MODULE} bugcodes)
483 set_target_properties(${MODULE} PROPERTIES SUFFIX ".sys")
484 endif()
485
486 if(${TYPE} STREQUAL win32ocx)
487 set_target_properties(${MODULE} PROPERTIES SUFFIX ".ocx")
488 endif()
489
490 if(${TYPE} STREQUAL cpl)
491 set_target_properties(${MODULE} PROPERTIES SUFFIX ".cpl")
492 endif()
493
494 # do compiler specific stuff
495 set_module_type_toolchain(${MODULE} ${TYPE})
496 endfunction()
497
498 function(preprocess_file __in __out)
499 set(__arg ${__in})
500 foreach(__def in ${ARGN})
501 list(APPEND __arg -D${__def})
502 endforeach()
503 if(MSVC)
504 add_custom_command(OUTPUT ${_out}
505 COMMAND ${CMAKE_C_COMPILER} /EP ${__arg}
506 DEPENDS ${__in})
507 else()
508 add_custom_command(OUTPUT ${_out}
509 COMMAND ${CMAKE_C_COMPILER} -E ${__arg}
510 DEPENDS ${__in})
511 endif()
512 endfunction()
513
514 function(get_includes OUTPUT_VAR)
515 get_directory_property(_includes INCLUDE_DIRECTORIES)
516 foreach(arg ${_includes})
517 list(APPEND __tmp_var -I${arg})
518 endforeach()
519 set(${OUTPUT_VAR} ${__tmp_var} PARENT_SCOPE)
520 endfunction()
521
522 function(get_defines OUTPUT_VAR)
523 get_directory_property(_defines COMPILE_DEFINITIONS)
524 foreach(arg ${_defines})
525 list(APPEND __tmp_var -D${arg})
526 endforeach()
527 set(${OUTPUT_VAR} ${__tmp_var} PARENT_SCOPE)
528 endfunction()
529
530 if(NOT MSVC AND (CMAKE_VERSION VERSION_GREATER 2.8.7))
531 function(add_object_library _target)
532 add_library(${_target} OBJECT ${ARGN})
533 endfunction()
534 else()
535 function(add_object_library _target)
536 add_library(${_target} ${ARGN})
537 endfunction()
538 endif()