//! Baseline interface of Tasks in Zed: all tasks in Zed are intended to use those for implementing their own logic.#![deny(missing_docs)] pub mod static_source;mod task_template;mod vscode_format; use collections::{HashMap, HashSet};use gpui::ModelContext;use serde::Serialize;use std::any::Any;use std::borrow::Cow;use std::path::PathBuf; pub use task_template::{RevealStrategy, TaskTemplate, TaskTemplates};pub use vscode_format::VsCodeTaskFile; /// Task identifier, unique within the application./// Based on it, task reruns and terminal tabs are managed.#[derive(Debug, Clone, PartialEq, Eq, Hash)]pub struct TaskId(pub String); /// Contains all information needed by Zed to spawn a new terminal tab for the given task.#[derive(Debug, Clone, PartialEq, Eq)]pub struct SpawnInTerminal {    /// Id of the task to use when determining task tab affinity.    pub id: TaskId,    /// Full unshortened form of `label` field.    pub full_label: String,    /// Human readable name of the terminal tab.    pub label: String,    /// Executable command to spawn.    pub command: String,    /// Arguments to the command, potentially unsubstituted,    /// to let the shell that spawns the command to do the substitution, if needed.    pub args: Vec<String>,    /// A human-readable label, containing command and all of its arguments, joined and substituted.    pub command_label: String,    /// Current working directory to spawn the command into.    pub cwd: Option<PathBuf>,    /// Env overrides for the command, will be appended to the terminal's environment from the settings.    pub env: HashMap<String, String>,    /// Whether to use a new terminal tab or reuse the existing one to spawn the process.    pub use_new_terminal: bool,    /// Whether to allow multiple instances of the same task to be run, or rather wait for the existing ones to finish.    pub allow_concurrent_runs: bool,    /// What to do with the terminal pane and tab, after the command was started.    pub reveal: RevealStrategy,} /// A final form of the [`TaskTemplate`], that got resolved with a particualar [`TaskContext`] and now is ready to spawn the actual task.#[derive(Clone, Debug, PartialEq, Eq)]pub struct ResolvedTask {    /// A way to distinguish tasks produced by the same template, but different contexts.    /// NOTE: Resolved tasks may have the same labels, commands and do the same things,    /// but still may have different ids if the context was different during the resolution.    /// Since the template has `env` field, for a generic task that may be a bash command,    /// so it's impossible to determine the id equality without more context in a generic case.    pub id: TaskId,    /// A template the task got resolved from.    original_task: TaskTemplate,    /// Full, unshortened label of the task after all resolutions are made.    pub resolved_label: String,    /// Variables that were substituted during the task template resolution.    substituted_variables: HashSet<VariableName>,    /// Further actions that need to take place after the resolved task is spawned,    /// with all task variables resolved.    pub resolved: Option<SpawnInTerminal>,} impl ResolvedTask {    /// A task template before the resolution.    pub fn original_task(&self) -> &TaskTemplate {        &self.original_task    }     /// Variables that were substituted during the task template resolution.    pub fn substituted_variables(&self) -> &HashSet<VariableName> {        &self.substituted_variables    }     /// A human-readable label to display in the UI.    pub fn display_label(&self) -> &str {        self.resolved            .as_ref()            .map(|resolved| resolved.label.as_str())            .unwrap_or_else(|| self.resolved_label.as_str())    }} /// Variables, available for use in [`TaskContext`] when a Zed's [`TaskTemplate`] gets resolved into a [`ResolvedTask`].#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize)]pub enum VariableName {    /// An absolute path of the currently opened file.    File,    /// An absolute path of the currently opened worktree, that contains the file.    WorktreeRoot,    /// A symbol text, that contains latest cursor/selection position.    Symbol,    /// A row with the latest cursor/selection position.    Row,    /// A column with the latest cursor/selection position.    Column,    /// Text from the latest selection.    SelectedText,    /// Custom variable, provided by the plugin or other external source.    /// Will be printed with `ZED_` prefix to avoid potential conflicts with other variables.    Custom(Cow<'static, str>),} impl VariableName {    /// Generates a `$VARIABLE`-like string value to be used in templates.    /// Custom variables are wrapped in `${}` to avoid substitution issues with whitespaces.    pub fn template_value(&self) -> String {        if matches!(self, Self::Custom(_)) {            format!("${{{self}}}")        } else {            format!("${self}")        }    }} /// A prefix that all [`VariableName`] variants are prefixed with when used in environment variables and similar template contexts.pub const ZED_VARIABLE_NAME_PREFIX: &str = "ZED_"; impl std::fmt::Display for VariableName {    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {        match self {            Self::File => write!(f, "{ZED_VARIABLE_NAME_PREFIX}FILE"),            Self::WorktreeRoot => write!(f, "{ZED_VARIABLE_NAME_PREFIX}WORKTREE_ROOT"),            Self::Symbol => write!(f, "{ZED_VARIABLE_NAME_PREFIX}SYMBOL"),            Self::Row => write!(f, "{ZED_VARIABLE_NAME_PREFIX}ROW"),            Self::Column => write!(f, "{ZED_VARIABLE_NAME_PREFIX}COLUMN"),            Self::SelectedText => write!(f, "{ZED_VARIABLE_NAME_PREFIX}SELECTED_TEXT"),            Self::Custom(s) => write!(f, "{ZED_VARIABLE_NAME_PREFIX}CUSTOM_{s}"),        }    }} /// Container for predefined environment variables that describe state of Zed at the time the task was spawned.#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize)]pub struct TaskVariables(HashMap<VariableName, String>); impl TaskVariables {    /// Inserts another variable into the container, overwriting the existing one if it already exists — in this case, the old value is returned.    pub fn insert(&mut self, variable: VariableName, value: String) -> Option<String> {        self.0.insert(variable, value)    }     /// Extends the container with another one, overwriting the existing variables on collision.    pub fn extend(&mut self, other: Self) {        self.0.extend(other.0);    }} impl FromIterator<(VariableName, String)> for TaskVariables {    fn from_iter<T: IntoIterator<Item = (VariableName, String)>>(iter: T) -> Self {        Self(HashMap::from_iter(iter))    }} /// Keeps track of the file associated with a task and context of tasks execution (i.e. current file or current function)./// Keeps all Zed-related state inside, used to produce a resolved task out of its template.#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize)]pub struct TaskContext {    /// A path to a directory in which the task should be executed.    pub cwd: Option<PathBuf>,    /// Additional environment variables associated with a given task.    pub task_variables: TaskVariables,} /// [`Source`] produces tasks that can be scheduled.////// Implementations of this trait could be e.g. [`StaticSource`] that parses tasks from a .json files and provides process templates to be spawned;/// another one could be a language server providing lenses with tests or build server listing all targets for a given project.pub trait TaskSource: Any {    /// A way to erase the type of the source, processing and storing them generically.    fn as_any(&mut self) -> &mut dyn Any;    /// Collects all tasks available for scheduling.    fn tasks_to_schedule(&mut self, cx: &mut ModelContext<Box<dyn TaskSource>>) -> TaskTemplates;}