cmake_parser/doc/command/scripting/
return.rs

1use cmake_parser_derive::CMake;
2
3use crate::{
4    doc::command_scope::{CommandScope, ToCommandScope},
5    Token,
6};
7
8/// Return from a file, directory or function.
9///
10/// Reference: <https://cmake.org/cmake/help/v3.26/command/return.html>
11#[derive(CMake, Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
12#[cmake(pkg = "crate", positional)]
13pub struct Return<'t> {
14    #[cmake(transparent)]
15    pub propagate: Option<Vec<Token<'t>>>,
16}
17
18impl<'t> ToCommandScope for Return<'t> {
19    fn to_command_scope(&self) -> CommandScope {
20        CommandScope::Scripting
21    }
22}
23
24#[cfg(test)]
25mod tests {
26    use super::*;
27    use crate::doc::cmake_parse::tests::tokens_vec;
28    use crate::*;
29    use pretty_assertions::assert_eq;
30
31    #[test]
32    fn r#return() {
33        let src = include_bytes!("../../../../../fixture/commands/scripting/return");
34        let cmakelists = parse_cmakelists(src).unwrap();
35        let doc = Doc::from(cmakelists);
36        assert_eq!(
37            doc.to_commands_iter().collect::<Vec<_>>(),
38            vec![
39                Ok(Command::Return(Box::new(Return { propagate: None }))),
40                Ok(Command::Return(Box::new(Return {
41                    propagate: Some(tokens_vec([b"var1", b"var2"])),
42                }))),
43            ]
44        )
45    }
46}