fyrox-build-tools 1.0.1

// Copyright (c) 2019-present Dmitry Stepanov and Fyrox Engine contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

use fyrox_core::{reflect::prelude::*, type_traits::prelude::*};
use serde::{Deserialize, Serialize};
use std::collections::VecDeque;
use std::fmt::{Display, Formatter};

pub mod build;
pub mod export;

#[derive(Deserialize, Serialize, PartialEq, Clone, Debug, Default, Reflect, TypeUuidProvider)]
#[type_uuid(id = "55e7651e-8840-4c81-aa93-3f01348855e6")]
pub struct EnvironmentVariable {
    pub name: String,
    pub value: String,
}

#[derive(Deserialize, Serialize, PartialEq, Clone, Debug, Default, Reflect, TypeUuidProvider)]
#[type_uuid(id = "67b93136-17fe-4776-b5f0-f4a9ef3d8972")]
pub struct CommandDescriptor {
    pub command: String,
    pub args: Vec<String>,
    pub environment_variables: Vec<EnvironmentVariable>,
    #[serde(skip_serializing_if = "std::ops::Not::not")]
    #[serde(default)]
    pub skip_passthrough_marker: bool,
}

impl CommandDescriptor {
    pub fn make_command(&self) -> std::process::Command {
        let mut command = std::process::Command::new(&self.command);

        command.args(self.args.iter()).envs(
            self.environment_variables
                .iter()
                .map(|v| (&v.name, &v.value)),
        );

        command
    }
}

impl Display for CommandDescriptor {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        for var in self.environment_variables.iter() {
            write!(f, "{}=\"{}\" ", var.name, var.value)?;
        }

        write!(f, "{}", self.command)?;

        for arg in self.args.iter() {
            write!(f, " {arg}")?;
        }

        Ok(())
    }
}

#[derive(Deserialize, Serialize, PartialEq, Clone, Debug, Default, Reflect, TypeUuidProvider)]
#[type_uuid(id = "1a9443df-bf75-42fb-93d3-860a0249168a")]
pub struct BuildProfile {
    pub name: String,
    /// A set of commands that will be used to build your game.
    pub build_commands: Vec<CommandDescriptor>,
    /// A set of commands that will be used to run your game. This set of commands will be executed
    /// right after build commands (if the build was successful).
    pub run_command: CommandDescriptor,
}

impl BuildProfile {
    fn add_arg(&mut self, arg: &str) {
        for command in self
            .build_commands
            .iter_mut()
            .chain([&mut self.run_command])
        {
            command.args.push(arg.to_string());
        }
    }

    pub fn build_and_run_queue(&self) -> VecDeque<CommandDescriptor> {
        let mut queue = self.build_commands.iter().cloned().collect::<VecDeque<_>>();
        queue.push_back(self.run_command.clone());
        queue
    }

    pub fn debug() -> Self {
        BuildProfile {
            name: "Debug".to_string(),
            build_commands: vec![CommandDescriptor {
                command: "cargo".to_string(),
                args: vec![
                    "build".to_string(),
                    "--package".to_string(),
                    "executor".to_string(),
                ],
                skip_passthrough_marker: false,
                environment_variables: vec![],
            }],
            run_command: CommandDescriptor {
                command: "cargo".to_string(),
                args: vec![
                    "run".to_string(),
                    "--package".to_string(),
                    "executor".to_string(),
                ],
                skip_passthrough_marker: false,
                environment_variables: vec![],
            },
        }
    }

    pub fn release() -> Self {
        let mut release = Self::debug();
        release.name = "Release".to_string();
        release.add_arg("--release");
        release
    }

    pub fn debug_hot_reloading() -> Self {
        BuildProfile {
            name: "Debug (HR)".to_string(),
            build_commands: vec![
                Self::build_game(), // Build the executor.
                CommandDescriptor {
                    command: "cargo".to_string(),
                    args: vec![
                        "build".to_string(),
                        "--package".to_string(),
                        "executor".to_string(),
                        "--no-default-features".to_string(),
                        "--features".to_string(),
                        "dylib".to_string(),
                        "--profile".to_string(),
                        "dev-hot-reload".to_string(),
                    ],
                    skip_passthrough_marker: false,
                    environment_variables: vec![EnvironmentVariable {
                        name: "RUSTFLAGS".to_string(),
                        value: "-C prefer-dynamic=yes".to_string(),
                    }],
                },
            ],
            // Run only executor, it will load the game plugin DLL.
            run_command: Self::run_hot_reload("executor"),
        }
    }

    pub fn release_hot_reloading() -> Self {
        let mut release_hot_reloading = Self::release();
        release_hot_reloading.name = "Release (HR)".to_string();
        release_hot_reloading.add_arg("--release");
        release_hot_reloading
    }

    fn build_game() -> CommandDescriptor {
        // Build the game plugin DLL first.
        CommandDescriptor {
            command: "cargo".to_string(),
            args: vec![
                "build".to_string(),
                "--package".to_string(),
                "game_dylib".to_string(),
                "--no-default-features".to_string(),
                "--features".to_string(),
                "dylib-engine".to_string(),
                "--profile".to_string(),
                "dev-hot-reload".to_string(),
            ],
            skip_passthrough_marker: false,
            environment_variables: vec![EnvironmentVariable {
                name: "RUSTFLAGS".to_string(),
                value: "-C prefer-dynamic=yes".to_string(),
            }],
        }
    }

    fn run_hot_reload(package_name: &str) -> CommandDescriptor {
        CommandDescriptor {
            command: "cargo".to_string(),
            args: vec![
                "run".to_string(),
                "--package".to_string(),
                package_name.to_string(),
                "--no-default-features".to_string(),
                "--features".to_string(),
                "dylib".to_string(),
                "--profile".to_string(),
                "dev-hot-reload".to_string(),
            ],
            skip_passthrough_marker: false,
            environment_variables: vec![EnvironmentVariable {
                name: "RUSTFLAGS".to_string(),
                value: "-C prefer-dynamic=yes".to_string(),
            }],
        }
    }

    pub fn debug_editor_hot_reloading() -> Self {
        BuildProfile {
            name: "Debug Editor (HR)".to_string(),
            build_commands: vec![Self::build_game()],
            run_command: Self::run_hot_reload("editor"),
        }
    }

    pub fn release_editor_hot_reloading() -> Self {
        let mut release_hot_reloading = Self::debug_editor_hot_reloading();
        release_hot_reloading.name = "Release Editor (HR)".to_string();
        release_hot_reloading.add_arg("--release");
        release_hot_reloading
    }

    pub fn debug_editor() -> Self {
        BuildProfile {
            name: "Debug Editor".to_string(),
            build_commands: vec![CommandDescriptor {
                command: "cargo".to_string(),
                args: vec![
                    "build".to_string(),
                    "--package".to_string(),
                    "editor".to_string(),
                ],
                skip_passthrough_marker: false,
                environment_variables: vec![],
            }],
            run_command: CommandDescriptor {
                command: "cargo".to_string(),
                args: vec![
                    "run".to_string(),
                    "--package".to_string(),
                    "editor".to_string(),
                ],
                skip_passthrough_marker: false,
                environment_variables: vec![],
            },
        }
    }

    pub fn release_editor() -> Self {
        let mut release = Self::debug_editor();
        release.name = "Release Editor".to_string();
        release.add_arg("--release");
        release
    }

    //run --package editor --no-default-features --features dylib --profile dev-hot-reload
}