File: CMAKE_DL_LIBS.rst

package info (click to toggle)
cmake 4.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 152,336 kB
  • sloc: ansic: 403,896; cpp: 303,920; sh: 4,105; python: 3,583; yacc: 3,106; lex: 1,279; f90: 538; asm: 471; lisp: 375; cs: 270; java: 266; fortran: 239; objc: 215; perl: 213; xml: 198; makefile: 111; javascript: 83; pascal: 63; tcl: 55; php: 25; ruby: 22
file content (49 lines) | stat: -rw-r--r-- 1,230 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
CMAKE_DL_LIBS
-------------

This variable contains a name of the dynamic loading library, or a list of
system libraries needed to use the ``dlopen()`` and ``dlclose()`` functions.

Few examples of the values this variable is set to:

``dl``
  On most Unix-like systems.

``-lld``
  On AIX, prior to CMake 4.2.

``dld``
  On HP-UX.

""
  Empty string value or not set on systems that have ``dl*()`` functions
  either in the default library that is implicitly linked (e.g., BSD-like
  systems, Haiku, macOS, SunOS, etc.), or on systems that don't provide these
  functions (e.g., Windows).

Examples
^^^^^^^^

Example: Linking Dynamic Loading Library
""""""""""""""""""""""""""""""""""""""""

Using this variable in a project that uses dynamic loading functionality:

.. code-block:: cmake

  target_link_libraries(example PRIVATE ${CMAKE_DL_LIBS})

Example: Checking Symbols
"""""""""""""""""""""""""

Checking for symbols with the dynamic loading library linked during the check:

.. code-block:: cmake

  include(CheckSymbolExists)
  include(CMakePushCheckState)

  cmake_push_check_state(RESET)
    set(CMAKE_REQUIRED_LIBRARIES ${CMAKE_DL_LIBS})
    check_symbol_exists(dlopen "dlfcn.h" HAVE_DLOPEN)
  cmake_pop_check_state()