cmake_parser/doc/command/project/
target_link_libraries.rs

1use cmake_parser_derive::CMake;
2
3use crate::{
4    doc::command_scope::{CommandScope, ToCommandScope},
5    Token,
6};
7
8/// Specify libraries or flags to use when linking a given target and/or its dependents.
9///
10/// Reference: <https://cmake.org/cmake/help/v3.26/command/target_link_libraries.html>
11#[derive(CMake, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
12#[cmake(pkg = "crate", untagged)]
13pub enum TargetLinkLibraries<'t> {
14    TargetAndOrDependents(TargetAndOrDependents<'t>),
15    TargetAndOrDependentsLegacy(TargetAndOrDependentsLegacy<'t>),
16    DependentsOnlyLegacy(DependentsOnlyLegacy<'t>),
17    TargetAndDependents(TargetAndDependents<'t>),
18}
19
20impl<'t> ToCommandScope for TargetLinkLibraries<'t> {
21    fn to_command_scope(&self) -> CommandScope {
22        CommandScope::Project
23    }
24}
25
26#[derive(CMake, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
27#[cmake(pkg = "crate")]
28pub struct TargetAndOrDependents<'t> {
29    #[cmake(positional)]
30    pub target: Token<'t>,
31    pub libraries: Vec<Library<'t>>,
32}
33
34#[derive(CMake, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
35#[cmake(pkg = "crate", transparent)]
36pub enum Library<'t> {
37    Interface(Vec<Token<'t>>),
38    Public(Vec<Token<'t>>),
39    Private(Vec<Token<'t>>),
40}
41
42#[derive(CMake, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
43#[cmake(pkg = "crate", positional)]
44pub struct TargetAndDependents<'t> {
45    pub target: Token<'t>,
46    pub libraries: Vec<Token<'t>>,
47}
48
49#[derive(CMake, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
50#[cmake(pkg = "crate")]
51pub struct TargetAndOrDependentsLegacy<'t> {
52    #[cmake(positional)]
53    pub target: Token<'t>,
54    pub libraries: Vec<LinkLibrary<'t>>,
55}
56
57#[derive(CMake, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
58#[cmake(pkg = "crate", transparent)]
59pub enum LinkLibrary<'t> {
60    LinkPublic(Vec<Token<'t>>),
61    LinkPrivate(Vec<Token<'t>>),
62}
63
64#[derive(CMake, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
65#[cmake(pkg = "crate")]
66pub struct DependentsOnlyLegacy<'t> {
67    #[cmake(positional)]
68    pub target: Token<'t>,
69    pub link_interface_libraries: Vec<Token<'t>>,
70}
71
72#[cfg(test)]
73mod tests {
74    use super::*;
75    use crate::doc::cmake_parse::tests::{token, tokens_vec};
76    use crate::*;
77    use pretty_assertions::assert_eq;
78
79    #[test]
80    fn target_link_libraries() {
81        let src = include_bytes!("../../../../../fixture/commands/project/target_link_libraries");
82        let cmakelists = parse_cmakelists(src).unwrap();
83        let doc = Doc::from(cmakelists);
84        assert_eq!(
85            doc.commands(),
86            Ok(vec![
87                Command::TargetLinkLibraries(Box::new(TargetLinkLibraries::TargetAndOrDependents(
88                    TargetAndOrDependents {
89                        target: token(b"LibXml2"),
90                        libraries: vec![Library::Private(tokens_vec([b"LibLZMA::LibLZMA"]))],
91                    }
92                ))),
93                Command::TargetLinkLibraries(Box::new(TargetLinkLibraries::TargetAndDependents(
94                    TargetAndDependents {
95                        target: token(b"LibXml2Mod"),
96                        libraries: tokens_vec([b"LibXml2", b"Python::Python"]),
97                    }
98                ))),
99                Command::TargetLinkLibraries(Box::new(
100                    TargetLinkLibraries::TargetAndOrDependentsLegacy(TargetAndOrDependentsLegacy {
101                        target: token(b"${PROJECT_NAME}"),
102                        libraries: vec![LinkLibrary::LinkPrivate(tokens_vec([
103                            b"GTest::GTest",
104                            b"GTest::Main",
105                        ]))],
106                    })
107                )),
108                Command::TargetLinkLibraries(Box::new(TargetLinkLibraries::DependentsOnlyLegacy(
109                    DependentsOnlyLegacy {
110                        target: token(b"${PROJECT_NAME}"),
111                        link_interface_libraries: tokens_vec([b"GTest::GTest", b"GTest::Main"]),
112                    }
113                ))),
114            ])
115        )
116    }
117}